Images.php
[Pman.Core] / Images.php
1 <?php
2 /**
3  * Deal with image delivery and HTML replacement of image links in body text.
4  *
5  * $str = Pman_Core_Images::replaceImg($str); // < use with HTML
6  *
7  * or
8  *
9  * Deliver image /file etc..
10  * 
11  * Use Cases:
12  * 
13  * args: ontable request
14  *      ontable (req) tablename.
15  *      filename
16  *      (other table args)
17  *      as (serve as a type) = eg. ?as=audio/mpeg 
18  * 
19  * args: generic
20  *     as :(serve as a type) = eg. mimetype.
21  * 
22  * Images/{ID}/fullname.xxxx
23  * 
24  * (valid thumbs 200, 400)...?
25  * Images/Thumb/200/{ID}/fullname.xxxx
26  * Images/Download/{ID}/fullname.xxxx
27  *
28  *
29  *
30  * 
31  * Used to be in Base... now in core..
32  *
33  * 
34  * view permission should be required on the underlying object...
35  * 
36  */
37 require_once  'Pman.php';
38 class Pman_Core_Images extends Pman
39 {
40     
41     // tables that do not need authentication checks before serving.
42     var $public_image_tables = array();
43     
44     var  $sizes = array(
45                 '100', 
46                 '100x100', 
47                 '150', 
48                 '150x150', 
49                 '200', 
50                 '200x0',
51                 '200x200',  
52                 '400x0',
53                 '300x100',
54                 '500'
55             );
56     function getAuth()
57     {
58         parent::getAuth(); // load company!
59         //return true;
60         $au = $this->getAuthUser();
61         
62         if (!$au) {
63             $this->authUser = false;
64             return true;//die("Access denied");
65         }
66         
67         $this->authUser = $au;
68         
69         return true;
70     }
71     var $thumb = false;
72     var $as_mimetype = false;
73     var $method = 'inline';
74     var $page = false;
75     
76     function get($s, $opts=array()) // determin what to serve!!!!
77     {
78         // for testing only.
79         //if (!empty($_GET['_post'])) {
80         //   return $this->post();
81         //}
82         
83         $this->as_mimetype = empty($_REQUEST['as']) ? '' : $_REQUEST['as'];
84         
85         $this->page = empty($_REQUEST['page']) ? false : (int) $_REQUEST['page'];
86         
87         $bits= explode('/', $s);
88         $id = 0;
89 //        var_dump($bits);die('in');
90         // without id as first part...
91         if (!empty($bits[0]) && $bits[0] == 'Thumb') {
92             $this->thumb = true;
93             $this->as_mimetype = 'image/jpeg';
94             $this->size = empty($bits[1]) ? '0x0' : $bits[1];
95             $id = empty($bits[2]) ? 0 :   $bits[2];
96             
97         } else if (!empty($bits[0]) && $bits[0] == 'Download') {
98             $this->method = 'attachment';
99             $id = empty($bits[1]) ? 0 :   $bits[1];
100             
101         } else  if (!empty($bits[1]) && $bits[1] == 'Thumb') { // with id as first part.
102             $this->thumb = true;
103             $this->as_mimetype = 'image/jpeg';
104             $this->size = empty($bits[2]) ? '0x0' : $bits[2];
105             $id = empty($bits[3]) ? 0 :   $bits[3];
106             
107         } else if (!empty($bits[0]) && $bits[0] == 'events') {
108             if (!$this->authUser) {
109                 $this->imgErr("no-authentication-events",$s);
110             }
111             $this->downloadEvent($bits);
112             $this->imgErr("unknown file",$s);
113             
114             
115         } else {
116         
117             $id = empty($bits[0]) ? 0 :  $bits[0];
118         }
119         
120         if (strpos($id,':') > 0) {  // id format  tablename:id:-imgtype
121             
122             if (!$this->authUser) {
123                 $this->imgErr("not-authenticated-using-colon-format",$s);
124                 
125             }
126             
127             $onbits = explode(':', $id);
128             if ((count($onbits) < 2)   || empty($onbits[1]) || !is_numeric($onbits[1]) || !strlen($onbits[0])) {
129                 $this->imgErr("bad-url",$s);
130                 
131             }
132             //DB_DataObject::debugLevel(1);
133             $img = DB_DataObject::factory('Images');
134             $img->ontable = $onbits[0];
135             $img->onid = $onbits[1];
136             if (empty($_REQUEST['anytype'])) {
137                 $img->whereAdd("mimetype like 'image/%'");
138             }
139             $img->orderBy('title ASC'); /// spurious ordering... (curretnly used by shipping project)
140             if (isset($onbits[2])) {
141                 $img->imgtype = $onbits[2];
142             }
143             $img->limit(1);
144             if (!$img->find(true)) {
145                 $this->imgErr("no images for that item: " . htmlspecialchars($id),$s);
146                 
147             }
148             
149             $id = $img->id;
150             
151             
152         }
153         $id = (int) $id;
154         
155         // depreciated - should use ontable:onid:type here...
156         if (!empty($_REQUEST['ontable'])) {
157             
158             if (!$this->authUser) {
159                 die("authentication required");
160             }
161             
162             //DB_DataObjecT::debugLevel(1);
163             $img = DB_DataObject::factory('Images');
164             $img->setFrom($_REQUEST);
165            
166             
167             
168             $img->limit(1);
169             if (!$img->find(true)) {
170                 $this->imgErr("No file exists",$s);
171             } 
172             $id = $img->id;
173             
174         }
175         
176         
177        
178         $img = DB_DataObjecT::factory('Images');
179          
180         if (!$id || !$img->get($id)) {
181              $this->imgErr("image has been removed or deleted.",$s);
182         }
183         
184         if (!$this->authUser && !in_array($img->ontable,$this->public_image_tables)) {
185            
186             if ($img->ontable != 'core_company') {
187                 $this->imgErr("not-authenticated {$img->ontable}",$s);
188             }
189             if ($img->imgtype != 'LOGO') {
190                 $this->imgErr("not-logo",$s);
191             }
192             $comp  = $img->object();
193             if ($comp->comptype != 'OWNER') {
194                 $this->imgErr("not-owner-company",$s);
195             }
196             return $this->serve($img);
197         
198             
199         }
200         
201         
202         if(!$this->hasPermission($img)){
203             $this->imgErr("access to this image/file has been denied.",$s);
204             
205         }
206         
207         $this->serve($img);
208         exit;
209     }
210     
211     function imgErr($reason,$path) {
212         header('Location: ' . $this->rootURL . '/Pman/templates/images/file-broken.png?reason=' .
213             urlencode($reason) .'&path='.urlencode($path));
214         exit;
215     }
216     
217     function hasPermission($img) 
218     {
219         return true;
220     }
221     
222     function post($v)
223     {
224         
225         if (!$this->authUser) {
226             $this->jerr("image conversion only allowed by registered users");
227         }
228         // converts a posted string (eg.svg)
229         // into another type..
230         if (empty($_REQUEST['as'])) {
231            $this->jerr("missing target type");
232         }
233         if (empty($_REQUEST['mimetype'])) {
234             $this->jerr("missing mimetype");
235         }
236         if (empty($_REQUEST['data'])) {
237             $this->jerr("missing data");
238         }
239         
240         
241         $this->as_mimetype = $_REQUEST['as'];
242         $this->mimetype = $_REQUEST['mimetype'];
243         require_once 'File/MimeType.php';
244         $y = new File_MimeType();
245         $src_ext = $y->toExt( $this->mimetype );
246         
247         
248         $tmp = $this->tempName($src_ext);
249         file_put_contents($tmp, $_REQUEST['data']);
250         
251         require_once 'File/Convert.php';
252         $cv = new File_Convert($tmp, $this->mimetype);
253         
254         $fn = $cv->convert(
255                 $this->as_mimetype ,
256                 empty($_REQUEST['width']) ? 0 : $_REQUEST['width'],
257                 empty($_REQUEST['height']) ? 0 : $_REQUEST['height']
258         );
259         if (!empty($_REQUEST['as_data'])) {
260             $this->jok(base64_encode(file_get_contents($fn)));
261         }
262         
263         $cv->serve('attachment');
264         exit;
265         
266         
267         
268     }
269     
270     
271  
272     function serve($img)
273     {
274         $this->sessionState(0); // turn off session... - locking...
275         
276         require_once 'File/Convert.php';
277         if (!file_exists($img->getStoreName())) {
278 //            print_r($img);exit;
279             header('Location: ' . $this->rootURL . '/Pman/templates/images/file-broken.png?reason=' .
280                 urlencode("Original file was missing : " . $img->getStoreName()));
281     
282         }
283 //        print_r($img);exit;
284         $x = $img->toFileConvert();
285         if (empty($this->as_mimetype) || $img->mimetype == 'image/gif') {
286             $this->as_mimetype  = $img->mimetype;
287         }
288         if (!$this->thumb) {
289             $x->convert( $this->as_mimetype);
290             $x->serve($this->method);
291             exit;
292         }
293         //echo "SKALING?  $this->size";
294         // acutally if we generated the image, then we do not need to validate the size..
295         
296         // if the mimetype is not converted..
297         // then the filename should be original.{size}.jpeg
298         $fn = $img->getStoreName() . '.'. $this->size . '.jpeg'; // thumbs are currenly all jpeg.!???
299         
300         if($img->mimetype == 'image/gif'){
301             $fn = $img->getStoreName() . '.'. $this->size . '.gif';
302         }
303         
304         if (!file_exists($fn)) {
305             $fn = $img->getStoreName()  . '.'. $this->size . '.'. $img->fileExt();
306             // if it's an image, convert into the same type for thumbnail..
307             if (preg_match('#^image/#', $img->mimetype)) {
308                $this->as_mimetype = $img->mimetype;
309             }
310         }
311         
312         if (!file_exists($fn)) {    
313             $this->validateSize();
314         }
315         
316         if(!empty($this->page) && !is_nan($this->page * 1)){
317             $x->convert( $this->as_mimetype, $this->size, 0, $this->page);
318         } else {
319             $x->convert( $this->as_mimetype, $this->size);
320         }
321         
322         $x->serve();
323         exit;
324         
325         
326         
327         
328     }
329     function validateSize()
330     {
331         if (($this->authUser && !empty($this->authUser->company_id) && $this->authUser->company()->comptype=='OWNER')
332             || $_SERVER['SERVER_ADDR'] == $_SERVER['REMOTE_ADDR']) {
333             return true;
334         }
335         
336         
337         $ff = HTML_FlexyFramework::get();
338         
339         $sizes= $this->sizes;
340         
341         $cfg = isset($ff->Pman_Images) ? $ff->Pman_Images :
342                 (isset($ff->Pman_Core_Images) ? $ff->Pman_Core_Images : array());
343         
344         if (!empty($cfg['sizes'])) {
345             $sizes = array_merge($sizes , $cfg['sizes']);
346         }
347         
348         $project = $ff->project;
349         
350         require_once $ff->project . '.php';
351         
352         $project = str_replace('/', '_', $project);
353          
354         $pr_obj = new $project;
355          
356        // var_dump($pr_obj->Pman_Core_Images_Size);
357         if(isset($pr_obj->Pman_Core_Images_Size)){
358             $sizes = $pr_obj->Pman_Core_Images_Size;
359             
360             
361         }
362         
363         if (!in_array($this->size, $sizes)) {
364             die("invalid scale - ".$this->size);
365         }
366     }
367     /**
368      * replace image urls
369      *
370      * The idea of this code was to replace urls for images when you have an admin
371      * and a distribution page. with different urls.
372      *
373      * it may be usefull later if things like embedded images in emails. but
374      * I think it's proably better not to use this.
375      *
376      * The key problem being how to determine if we are replacing 'our' images or some external one..
377      * 
378      *
379      */
380     
381     
382     static function replaceImageURLS($html)
383     {
384         
385         $ff = HTML_FlexyFramework::get();
386         if (!isset($ff->Pman_Images['public_baseURL'])) {
387             return $html;
388         }
389         //var_dump($ff->Pman_Images['public_baseURL']);
390         $baseURL = $ff->Pman_Images['public_baseURL'];
391         
392         preg_match_all('/<img\s+[^>]+>/i',$html, $result); 
393         //print_r($result);
394         $matches = array_unique($result[0]);
395         foreach($matches as $img) {
396             $imatch = array();
397             preg_match_all('/(width|height|src)="([^"]*)"/i',$img, $imatch);
398             // build a keymap
399             $attr =  array();
400             
401             foreach($imatch[1] as $i=>$key) {
402                 $attr[$key] = $imatch[2][$i];
403             }
404             // does it contain baseURL??? --- well what about relative paths...
405             //print_R($attr);
406             
407             if (empty($attr['src'])) {
408                 continue;
409             }
410             if (0 !== strpos($attr['src'], $baseURL)) {
411                 // it starts with our 'new' baseURL?
412                 $html = self::replaceImgUrl($html, $baseURL, $img, $attr,  'src' );
413                 continue;
414             }
415             if (false !== strpos($attr['src'], '//') && false === strpos($attr['src'], $baseURL)) {
416                 // contains an absolute path.. that is probably not us...
417                 continue;
418             }
419             // what about mailto or data... - just ignore?? for images...
420             
421             $html = self::replaceImgUrl($html, $baseURL, $img, $attr,  'src' );
422             
423         }
424         
425         
426         $result = array();
427         preg_match_all('/<a\s+[^>]+>/i',$html, $result); 
428
429         $matches = array_unique($result[0]);
430         foreach($matches as $img) {
431             $imatch = array();
432             preg_match_all('/(href)="([^"]*)"/i',$img, $imatch);
433             // build a keymap
434             $attr =  array();
435             
436             foreach($imatch[1] as $i=>$key) {
437                 $attr[$key] = $imatch[2][$i];
438             }
439             if (!isset($attr['href']) || 0 !== strpos($attr['href'], $baseURL)) { 
440                 continue;
441             }
442             $html = self::replaceImgUrl($html, $baseURL, $img, $attr, 'href' );
443         }
444         
445         return $html;
446     }
447     static function replaceImgUrl($html, $baseURL, $tag, $attr, $attr_name) 
448     {
449         
450         //print_R($attr);
451         // see if it's an image url..
452         // Images/{ID}/fullname.xxxx
453         // Images/Thumb/200/{ID}/fullname.xxxx
454         // Images/Download/{ID}/fullname.xxxx
455         
456         $attr_url = $attr[$attr_name];
457         $umatch  = false;
458         if(!preg_match('#/(Images|Images/Thumb/[a-z0-9]+|Images/Download)/([0-9]+)/(.*)$#', $attr_url, $umatch))  {
459             return $html;
460         }
461         
462         $id = $umatch[2];
463         $hash = '';
464         if (!empty($umatch[3]) && strpos($umatch[3],'#')) {
465             $hash = '#'. array_pop(explode('#',$umatch[3]));
466         }
467         
468         
469         $img = DB_DataObject::factory('Images');
470         if (!$img->get($id)) {
471             return $html;
472         }
473         $type = explode('/', $umatch[1]);
474         $thumbsize = -1;
475          
476         if (count($type) > 2 && $type[1] == 'Thumb') {
477             $thumbsize = $type[2];
478             $provider = '/Images/Thumb';
479         } else {
480             $provider = '/'.$umatch[1];
481         }
482         
483         if (!empty($attr['width']) || !empty($attr['height']) )
484         {
485             // no support for %...
486             $thumbsize =
487                 (empty($attr['width']) ? '0' : $attr['width'] * 1) .
488                 'x' .
489                 (empty($attr['height']) ? '0' : $attr['height'] * 1);
490              $provider = '/Images/Thumb';
491             
492         }
493         
494         if ($thumbsize !== -1) {
495             // change in size..
496             // need to regenerate it..
497             
498             $type = array('Images', 'Thumb', $thumbsize);
499                 
500             $fc = $img->toFileConvert();
501             // make sure it's available..
502             $fc->convert($img->mimetype, $thumbsize);
503             
504             
505         } else {
506             $provider = $provider == 'Images/Thumb' ? 'Images' : $provider; 
507         }
508         
509         
510         // finally replace the original TAG with the new version..
511         
512         $new_tag = str_replace(
513             $attr_name. '="'. $attr_url . '"',
514             $attr_name .'="'. htmlspecialchars($img->URL($thumbsize, $provider, $baseURL)) . $hash .'"',
515             $tag
516         );
517         
518         
519         return str_replace($tag, $new_tag, $html);
520          
521     }
522     
523     function downloadEvent($bits)
524     {
525         $popts = PEAR::getStaticProperty('Pman','options');
526         $ev = DB_DAtaObject::Factory('events');
527         if (!$ev->get($bits[1])) {
528             die("could not find event id");
529         }
530         // technically same user only.. -- normally www-data..
531         if (function_exists('posix_getpwuid')) {
532             $uinfo = posix_getpwuid( posix_getuid () ); 
533             $user = $uinfo['name'];
534         } else {
535             $user = getenv('USERNAME'); // windows.
536         }
537         $ff = HTML_FlexyFramework::get();
538         $file = $ff->Pman['event_log_dir']. '/'. $user. date('/Y/m/d/',strtotime($ev->event_when)). $ev->id . ".json";
539         $filesJ = json_decode(file_get_contents($file));
540
541         //print_r($filesJ);
542
543         foreach($filesJ->FILES as $k=>$f){
544             if ($f->tmp_name != $bits[2]) {
545                 continue;
546             }
547
548             $src = $ff->Pman['event_log_dir']. '/'. $user. date('/Y/m/d/', strtotime($ev->event_when)).  $f->tmp_name ;
549             if (!file_exists($src)) {
550                 die("file was not saved");
551             }
552             header ('Content-Type: ' . $f->type);
553
554             header("Content-Disposition: attachment; filename=\"".basename($f->name)."\";" );
555             @ob_clean();
556             flush();
557             readfile($src);
558             exit;
559         }
560     }
561     
562 }