source: branches/2.5/i.php @ 30620

Last change on this file since 30620 was 23498, checked in by plg, 11 years ago

feature 2929: strip metadata on configurable threshold
File size: 16.8 KB
Line 
1<?php
2// +-----------------------------------------------------------------------+
3// | Piwigo - a PHP based photo gallery                                    |
4// +-----------------------------------------------------------------------+
5// | Copyright(C) 2008-2013 Piwigo Team                  http://piwigo.org |
6// +-----------------------------------------------------------------------+
7// | This program is free software; you can redistribute it and/or modify  |
8// | it under the terms of the GNU General Public License as published by  |
9// | the Free Software Foundation                                          |
10// |                                                                       |
11// | This program is distributed in the hope that it will be useful, but   |
12// | WITHOUT ANY WARRANTY; without even the implied warranty of            |
13// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      |
14// | General Public License for more details.                              |
15// |                                                                       |
16// | You should have received a copy of the GNU General Public License     |
17// | along with this program; if not, write to the Free Software           |
18// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
19// | USA.                                                                  |
20// +-----------------------------------------------------------------------+
21
22define('PHPWG_ROOT_PATH','./');
23
24// fast bootstrap - no db connection
25include(PHPWG_ROOT_PATH . 'include/config_default.inc.php');
26@include(PHPWG_ROOT_PATH. 'local/config/config.inc.php');
27
28defined('PWG_LOCAL_DIR') or define('PWG_LOCAL_DIR', 'local/');
29defined('PWG_DERIVATIVE_DIR') or define('PWG_DERIVATIVE_DIR', $conf['data_location'].'i/');
30
31@include(PHPWG_ROOT_PATH.PWG_LOCAL_DIR .'config/database.inc.php');
32
33
34function trigger_action() {}
35function get_extension( $filename )
36{
37  return substr( strrchr( $filename, '.' ), 1, strlen ( $filename ) );
38}
39
40function mkgetdir($dir)
41{
42  if ( !is_dir($dir) )
43  {
44    global $conf;
45    if (substr(PHP_OS, 0, 3) == 'WIN')
46    {
47      $dir = str_replace('/', DIRECTORY_SEPARATOR, $dir);
48    }
49    $umask = umask(0);
50    $mkd = @mkdir($dir, $conf['chmod_value'], true);
51    umask($umask);
52    if ($mkd==false)
53    {
54      return false;
55    }
56
57    $file = $dir.'/index.htm';
58    file_exists($file) or @file_put_contents( $file, 'Not allowed!' );
59  }
60  if ( !is_writable($dir) )
61  {
62    return false;
63  }
64  return true;
65}
66
67// end fast bootstrap
68
69function ilog()
70{
71  global $conf;
72  if (!$conf['enable_i_log']) return;
73
74  $line = date("c");
75  foreach( func_get_args() as $arg)
76  {
77    $line .= ' ';
78    if (is_array($arg))
79    {
80      $line .= implode(' ', $arg);
81    }
82    else
83    {
84      $line .= $arg;
85    }
86  }
87        $file=PHPWG_ROOT_PATH.$conf['data_location'].'tmp/i.log';
88  if (false == file_put_contents($file, $line."\n", FILE_APPEND))
89        {
90                mkgetdir(dirname($file));
91        }
92}
93
94function ierror($msg, $code)
95{
96  if ($code==301 || $code==302)
97  {
98    if (ob_get_length () !== FALSE)
99    {
100      ob_clean();
101    }
102    // default url is on html format
103    $url = html_entity_decode($msg);
104    header('Request-URI: '.$url);
105    header('Content-Location: '.$url);
106    header('Location: '.$url);
107    ilog('WARN', $code, $url, $_SERVER['REQUEST_URI']);
108    exit;
109  }
110  if ($code>=400)
111  {
112    $protocol = $_SERVER["SERVER_PROTOCOL"];
113    if ( ('HTTP/1.1' != $protocol) && ('HTTP/1.0' != $protocol) )
114      $protocol = 'HTTP/1.0';
115
116    header( "$protocol $code $msg", true, $code );
117  }
118  //todo improve
119  echo $msg;
120  ilog('ERROR', $code, $msg, $_SERVER['REQUEST_URI']);
121  exit;
122}
123
124function time_step( &$step )
125{
126  $tmp = $step;
127  $step = microtime(true);
128  return intval(1000*($step - $tmp));
129}
130
131function url_to_size($s)
132{
133  $pos = strpos($s, 'x');
134  if ($pos===false)
135  {
136    return array((int)$s, (int)$s);
137  }
138  return array((int)substr($s,0,$pos), (int)substr($s,$pos+1));
139}
140
141function parse_custom_params($tokens)
142{
143  if (count($tokens)<1)
144    ierror('Empty array while parsing Sizing', 400);
145
146  $crop = 0;
147  $min_size = null;
148
149  $token = array_shift($tokens);
150  if ($token[0]=='s')
151  {
152    $size = url_to_size( substr($token,1) );
153  }
154  elseif ($token[0]=='e')
155  {
156    $crop = 1;
157    $size = $min_size = url_to_size( substr($token,1) );
158  }
159  else
160  {
161    $size = url_to_size( $token );
162    if (count($tokens)<2)
163      ierror('Sizing arr', 400);
164
165    $token = array_shift($tokens);
166    $crop = char_to_fraction($token);
167
168    $token = array_shift($tokens);
169    $min_size = url_to_size( $token );
170  }
171  return new DerivativeParams( new SizingParams($size, $crop, $min_size) );
172}
173
174function parse_request()
175{
176  global $conf, $page;
177
178  if ( $conf['question_mark_in_urls']==false and
179       isset($_SERVER["PATH_INFO"]) and !empty($_SERVER["PATH_INFO"]) )
180  {
181    $req = $_SERVER["PATH_INFO"];
182    $req = str_replace('//', '/', $req);
183    $path_count = count( explode('/', $req) );
184    $page['root_path'] = PHPWG_ROOT_PATH.str_repeat('../', $path_count-1);
185  }
186  else
187  {
188    $req = $_SERVER["QUERY_STRING"];
189    if ($pos=strpos($req, '&'))
190    {
191      $req = substr($req, 0, $pos);
192    }
193    $req = rawurldecode($req);
194    /*foreach (array_keys($_GET) as $keynum => $key)
195    {
196      $req = $key;
197      break;
198    }*/
199    $page['root_path'] = PHPWG_ROOT_PATH;
200  }
201
202  $req = ltrim($req, '/');
203
204  foreach (preg_split('#/+#', $req) as $token)
205  {
206    preg_match($conf['sync_chars_regex'], $token) or ierror('Invalid chars in request', 400);
207  }
208
209  $page['derivative_path'] = PHPWG_ROOT_PATH.PWG_DERIVATIVE_DIR.$req;
210
211  $pos = strrpos($req, '.');
212  $pos!== false || ierror('Missing .', 400);
213  $ext = substr($req, $pos);
214  $page['derivative_ext'] = $ext;
215  $req = substr($req, 0, $pos);
216
217  $pos = strrpos($req, '-');
218  $pos!== false || ierror('Missing -', 400);
219  $deriv = substr($req, $pos+1);
220  $req = substr($req, 0, $pos);
221
222  $deriv = explode('_', $deriv);
223  foreach (ImageStdParams::get_defined_type_map() as $type => $params)
224  {
225    if ( derivative_to_url($type) == $deriv[0])
226    {
227      $page['derivative_type'] = $type;
228      $page['derivative_params'] = $params;
229      break;
230    }
231  }
232
233  if (!isset($page['derivative_type']))
234  {
235    if (derivative_to_url(IMG_CUSTOM) == $deriv[0])
236    {
237      $page['derivative_type'] = IMG_CUSTOM;
238    }
239    else
240    {
241      ierror('Unknown parsing type', 400);
242    }
243  }
244  array_shift($deriv);
245
246  if ($page['derivative_type'] == IMG_CUSTOM)
247  {
248    $params = $page['derivative_params'] = parse_custom_params($deriv);
249    ImageStdParams::apply_global($params);
250
251    if ($params->sizing->ideal_size[0] < 20 or $params->sizing->ideal_size[1] < 20)
252    {
253      ierror('Invalid size', 400);
254    }
255    if ($params->sizing->max_crop < 0 or $params->sizing->max_crop > 1)
256    {
257      ierror('Invalid crop', 400);
258    }
259    $greatest = ImageStdParams::get_by_type(IMG_XXLARGE);
260
261    $key = array();
262    $params->add_url_tokens($key);
263    $key = implode('_', $key);
264    if (!isset(ImageStdParams::$custom[$key]))
265    {
266      ierror('Size not allowed', 403);
267    }
268  }
269
270  if (is_file(PHPWG_ROOT_PATH.$req.$ext))
271  {
272    $req = './'.$req; // will be used to match #iamges.path
273  }
274  elseif (is_file(PHPWG_ROOT_PATH.'../'.$req.$ext))
275  {
276    $req = '../'.$req;
277  }
278
279  $page['src_location'] = $req.$ext;
280  $page['src_path'] = PHPWG_ROOT_PATH.$page['src_location'];
281  $page['src_url'] = $page['root_path'].$page['src_location'];
282}
283
284function try_switch_source(DerivativeParams $params, $original_mtime)
285{
286  global $page;
287  $original_size = null;
288  if (isset($page['original_size']))
289  {
290    $original_size = $page['original_size'];
291    if ($page['rotation_angle']==90 || $page['rotation_angle']==270)
292    {
293      $tmp = $original_size[0];
294      $original_size[0] = $original_size[1];
295      $original_size[1] = $tmp;
296    }
297  }
298
299  $use_watermark = $params->use_watermark;
300  if ($use_watermark)
301  {
302    if (!isset($original_size))
303      return false; // cannot really know if a watermark is required
304    $dsize = $params->compute_final_size($original_size);
305    $use_watermark = $params->will_watermark($dsize);
306  }
307
308  $candidates = array();
309  foreach(ImageStdParams::get_defined_type_map() as $candidate)
310  {
311    if ($candidate->type == $params->type)
312      continue;
313    if ($candidate->use_watermark != $use_watermark)
314      continue;
315    if ($candidate->max_width() < $params->max_width() || $candidate->max_height() < $params->max_height())
316      continue;
317    if ($params->sizing->max_crop==0)
318    {
319      if ($candidate->sizing->max_crop!=0)
320        continue;
321    }
322    else
323    {
324      if ($candidate->sizing->max_crop!=0)
325        continue; // this could be optimized
326      if (!isset($original_size))
327        continue;
328      $candidate_size = $candidate->compute_final_size($original_size);
329      if ($candidate_size[0] < $params->sizing->min_size[0] || $candidate_size[1] < $params->sizing->min_size[1] )
330        continue;
331    }
332    $candidates[] = $candidate;
333  }
334
335  foreach( array_reverse($candidates) as $candidate)
336  {
337    $candidate_path = $page['derivative_path'];
338    $candidate_path = str_replace( '-'.derivative_to_url($params->type), '-'.derivative_to_url($candidate->type), $candidate_path);
339    $candidate_mtime = @filemtime($candidate_path);
340    if ($candidate_mtime === false
341      || $candidate_mtime < $original_mtime
342      || $candidate_mtime < $candidate->last_mod_time)
343      continue;
344    $params->use_watermark = false;
345    $params->sharpen = min(1, $params->sharpen);
346    $page['src_path'] = $candidate_path;
347    $page['src_url'] = $page['root_path'] . substr($candidate_path, strlen(PHPWG_ROOT_PATH));
348    $page['rotation_angle'] = 0;
349                return true;
350  }
351        return false;
352}
353
354function send_derivative($expires)
355{
356  global $page;
357
358  if (isset($_GET['ajaxload']) and $_GET['ajaxload'] == 'true')
359  {
360    include_once(PHPWG_ROOT_PATH.'include/functions_cookie.inc.php');
361    include_once(PHPWG_ROOT_PATH.'include/functions_url.inc.php');
362
363    echo json_encode( array( 'url'=>embellish_url(get_absolute_root_url().$page['derivative_path']) ) );
364    return;
365  }
366  $fp = fopen($page['derivative_path'], 'rb');
367
368  $fstat = fstat($fp);
369  header('Last-Modified: '.gmdate('D, d M Y H:i:s', $fstat['mtime']).' GMT');
370  if ($expires!==false)
371  {
372    header('Expires: '.gmdate('D, d M Y H:i:s', $expires).' GMT');
373  }
374  header('Content-length: '.$fstat['size']);
375  header('Connection: close');
376
377  $ctype="application/octet-stream";
378  switch (strtolower($page['derivative_ext']))
379  {
380    case ".jpe": case ".jpeg": case ".jpg": $ctype="image/jpeg"; break;
381    case ".png": $ctype="image/png"; break;
382    case ".gif": $ctype="image/gif"; break;
383  }
384  header("Content-Type: $ctype");
385
386  fpassthru($fp);
387  fclose($fp);
388}
389
390$page=array();
391$begin = $step = microtime(true);
392$timing=array();
393foreach( explode(',','load,rotate,crop,scale,sharpen,watermark,save,send') as $k )
394{
395  $timing[$k] = '';
396}
397
398include_once(PHPWG_ROOT_PATH .'include/dblayer/functions_'.$conf['dblayer'].'.inc.php');
399include_once( PHPWG_ROOT_PATH .'/include/derivative_params.inc.php');
400include_once( PHPWG_ROOT_PATH .'/include/derivative_std_params.inc.php');
401
402try
403{
404  pwg_db_connect($conf['db_host'], $conf['db_user'],
405                 $conf['db_password'], $conf['db_base']);
406}
407catch (Exception $e)
408{
409  ilog("db error", $e->getMessage());
410}
411pwg_db_check_charset();
412
413list($conf['derivatives']) = pwg_db_fetch_row(pwg_query('SELECT value FROM '.$prefixeTable.'config WHERE param=\'derivatives\''));
414ImageStdParams::load_from_db();
415
416
417parse_request();
418//var_export($page);
419
420$params = $page['derivative_params'];
421
422$src_mtime = @filemtime($page['src_path']);
423if ($src_mtime === false)
424{
425  ierror('Source not found', 404);
426}
427
428$need_generate = false;
429$derivative_mtime = @filemtime($page['derivative_path']);
430if ($derivative_mtime === false or
431    $derivative_mtime < $src_mtime or
432    $derivative_mtime < $params->last_mod_time)
433{
434  $need_generate = true;
435}
436
437$expires=false;
438$now = time();
439if ( isset($_GET['b']) )
440{
441  $expires = $now + 100;
442  header("Cache-control: no-store, max-age=100");
443}
444elseif ( $now > (max($src_mtime, $params->last_mod_time) + 24*3600) )
445{// somehow arbitrary - if derivative params or src didn't change for the last 24 hours, we send an expire header for several days
446  $expires = $now + 10*24*3600;
447}
448
449if (!$need_generate)
450{
451  if ( isset( $_SERVER['HTTP_IF_MODIFIED_SINCE'] )
452    and strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) == $derivative_mtime)
453  {// send the last mod time of the file back
454    header('Last-Modified: '.gmdate('D, d M Y H:i:s', $derivative_mtime).' GMT', true, 304);
455    header('Expires: '.gmdate('D, d M Y H:i:s', time()+10*24*3600).' GMT', true, 304);
456    exit;
457  }
458  send_derivative($expires);
459  exit;
460}
461
462include_once(PHPWG_ROOT_PATH . 'admin/include/image.class.php');
463$page['coi'] = null;
464if (strpos($page['src_location'], '/pwg_representative/')===false
465    && strpos($page['src_location'], 'themes/')===false
466    && strpos($page['src_location'], 'plugins/')===false)
467{
468  try
469  {
470    $query = '
471SELECT *
472  FROM '.$prefixeTable.'images
473  WHERE path=\''.$page['src_location'].'\'
474;';
475
476    if ( ($row=pwg_db_fetch_assoc(pwg_query($query))) )
477    {
478      if (isset($row['width']))
479      {
480        $page['original_size'] = array($row['width'],$row['height']);
481      }
482      $page['coi'] = $row['coi'];
483
484      if (!isset($row['rotation']))
485      {
486        $page['rotation_angle'] = pwg_image::get_rotation_angle($page['src_path']);
487
488        single_update(
489          $prefixeTable.'images',
490          array('rotation' => pwg_image::get_rotation_code_from_angle($page['rotation_angle'])),
491          array('id' => $row['id'])
492          );
493      }
494      else
495      {
496        $page['rotation_angle'] = pwg_image::get_rotation_angle_from_code($row['rotation']);
497      }
498    }
499    if (!$row)
500    {
501      ierror('Db file path not found', 404);
502    }
503  }
504  catch (Exception $e)
505  {
506    ilog("db error", $e->getMessage());
507  }
508}
509else
510{
511  $page['rotation_angle'] = 0;
512}
513pwg_db_close();
514
515if (!try_switch_source($params, $src_mtime) && $params->type==IMG_CUSTOM)
516{
517        $sharpen = 0;
518        foreach (ImageStdParams::get_defined_type_map() as $std_params)
519        {
520                $sharpen += $std_params->sharpen;
521        }
522        $params->sharpen = round($sharpen / count(ImageStdParams::get_defined_type_map()) );
523}
524
525if (!mkgetdir(dirname($page['derivative_path'])))
526{
527  ierror("dir create error", 500);
528}
529
530ignore_user_abort(true);
531@set_time_limit(0);
532
533$image = new pwg_image($page['src_path']);
534$timing['load'] = time_step($step);
535
536$changes = 0;
537
538// rotate
539if (0 != $page['rotation_angle'])
540{
541  $image->rotate($page['rotation_angle']);
542  $changes++;
543  $timing['rotate'] = time_step($step);
544}
545
546// Crop & scale
547$o_size = $d_size = array($image->get_width(),$image->get_height());
548$params->sizing->compute($o_size , $page['coi'], $crop_rect, $scaled_size );
549if ($crop_rect)
550{
551  $changes++;
552  $image->crop( $crop_rect->width(), $crop_rect->height(), $crop_rect->l, $crop_rect->t);
553  $timing['crop'] = time_step($step);
554}
555
556if ($scaled_size)
557{
558  $changes++;
559  $image->resize( $scaled_size[0], $scaled_size[1] );
560  $d_size = $scaled_size;
561  $timing['scale'] = time_step($step);
562}
563
564if ($params->sharpen)
565{
566  $changes += $image->sharpen( $params->sharpen );
567  $timing['sharpen'] = time_step($step);
568}
569
570if ($params->will_watermark($d_size))
571{
572  $wm = ImageStdParams::get_watermark();
573  $wm_image = new pwg_image(PHPWG_ROOT_PATH.$wm->file);
574  $wm_size = array($wm_image->get_width(),$wm_image->get_height());
575  if ($d_size[0]<$wm_size[0] or $d_size[1]<$wm_size[1])
576  {
577    $wm_scaling_params = SizingParams::classic($d_size[0], $d_size[1]);
578    $wm_scaling_params->compute($wm_size, null, $tmp, $wm_scaled_size);
579    $wm_size = $wm_scaled_size;
580    $wm_image->resize( $wm_scaled_size[0], $wm_scaled_size[1] );
581  }
582  $x = round( ($wm->xpos/100)*($d_size[0]-$wm_size[0]) );
583  $y = round( ($wm->ypos/100)*($d_size[1]-$wm_size[1]) );
584  if ($image->compose($wm_image, $x, $y, $wm->opacity))
585  {
586    $changes++;
587    if ($wm->xrepeat)
588    {
589      // todo
590      $pad = $wm_size[0] + max(30, round($wm_size[0]/4));
591      for($i=-$wm->xrepeat; $i<=$wm->xrepeat; $i++)
592      {
593        if (!$i) continue;
594        $x2 = $x + $i * $pad;
595        if ($x2>=0 && $x2+$wm_size[0]<$d_size[0])
596          if (!$image->compose($wm_image, $x2, $y, $wm->opacity))
597            break;
598      }
599    }
600  }
601  $wm_image->destroy();
602  $timing['watermark'] = time_step($step);
603}
604
605// no change required - redirect to source
606if (!$changes)
607{
608  header("X-i: No change");
609  ierror( $page['src_url'], 301);
610}
611
612if ($d_size[0]*$d_size[1] < $conf['derivatives_strip_metadata_threshold'])
613{// strip metadata for small images
614  $image->strip();
615}
616
617$image->set_compression_quality( ImageStdParams::$quality );
618$image->write( $page['derivative_path'] );
619$image->destroy();
620@chmod($page['derivative_path'], 0644);
621$timing['save'] = time_step($step);
622
623send_derivative($expires);
624$timing['send'] = time_step($step);
625
626ilog('perf',
627  basename($page['src_path']), $o_size, $o_size[0]*$o_size[1],
628  basename($page['derivative_path']), $d_size, $d_size[0]*$d_size[1],
629  function_exists('memory_get_peak_usage') ? round( memory_get_peak_usage()/(1024*1024), 1) : '',
630  time_step($begin),
631  '|', $timing);
632?>
Note: See TracBrowser for help on using the repository browser.