privacy_image_cache/privacy_image_cache.php

   1 <?php
   2
   3 /**
   4  * Name: Privacy Image Cache
   5  * Version: 0.1
   6  * Author: Tobias Hößl <https://github.com/CatoTH/>
   7  */
   8
   9 define("PRIVACY_IMAGE_CACHE_DEFAULT_TIME", 86400); // 1 Day
  10
  11 require_once('include/security.php');
  12
  13 function privacy_image_cache_install() {
  14     register_hook('prepare_body', 'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_prepare_body_hook');
  15  //   register_hook('bbcode',       'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_bbcode_hook');
  16     register_hook('display_item', 'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_display_item_hook');
  17     register_hook('ping_xmlize',  'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_ping_xmlize_hook');
  18     register_hook('cron',         'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_cron');
  19 }
  20
  21
  22 function privacy_image_cache_uninstall() {
  23     unregister_hook('prepare_body', 'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_prepare_body_hook');
  24     unregister_hook('bbcode',       'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_bbcode_hook');
  25     unregister_hook('display_item', 'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_display_item_hook');
  26     unregister_hook('ping_xmlize',  'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_ping_xmlize_hook');
  27     unregister_hook('cron',         'addon/privacy_image_cache/privacy_image_cache.php', 'privacy_image_cache_cron');
  28 }
  29
  30
  31 function privacy_image_cache_module() {}
  32
  33 function privacy_image_cache_init() {
  34         global $a, $_SERVER;
  35
  36         if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
  37                 header('HTTP/1.1 304 Not Modified');
  38                 header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
  39                 header('Etag: '.$_SERVER['HTTP_IF_NONE_MATCH']);
  40                 header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
  41                 header("Cache-Control: max-age=31536000");
  42                 if(function_exists('header_remove')) {
  43                         header_remove('Last-Modified');
  44                         header_remove('Expires');
  45                         header_remove('Cache-Control');
  46                 }
  47                 exit;
  48         }
  49
  50         //if ($a->config["system"]["db_log"] != "")
  51         //      $stamp1 = microtime(true);
  52
  53         if(function_exists('header_remove')) {
  54                 header_remove('Pragma');
  55                 header_remove('pragma');
  56         }
  57
  58         $thumb = false;
  59
  60         // Look for filename in the arguments
  61         if (isset($a->argv[1]) OR isset($a->argv[2])) {
  62                 if (isset($a->argv[2]))
  63                         $url = $a->argv[2];
  64                 else
  65                         $url = $a->argv[1];
  66
  67                 $pos = strrpos($url, "==.");
  68                 if ($pos)
  69                         $url = substr($url, 0, $pos+2);
  70
  71                 $url = base64_decode(strtr($url, '-_', '+/'), true);
  72                 if ($url)
  73                         $_REQUEST['url'] = $url;
  74
  75                 $thumb = (isset($a->argv[3]) and ($a->argv[3] == "thumb"));
  76         }
  77
  78         $urlhash = 'pic:' . sha1($_REQUEST['url']);
  79         // Double encoded url - happens with Diaspora
  80         $urlhash2 = 'pic:' . sha1(urldecode($_REQUEST['url']));
  81
  82         $cachefile = get_cachefile(hash("md5", $_REQUEST['url']));
  83         if ($cachefile != '') {
  84                 if (file_exists($cachefile)) {
  85                         $img_str = file_get_contents($cachefile);
  86
  87                         $mime = image_type_to_mime_type(exif_imagetype($cachefile));
  88
  89                         header("Content-type: $mime");
  90                         header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
  91                         header('Etag: "'.md5($img_str).'"');
  92                         header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
  93                         header("Cache-Control: max-age=31536000");
  94
  95                         echo $img_str;
  96
  97                         //if ($a->config["system"]["db_log"] != "") {
  98                         //      $stamp2 = microtime(true);
  99                         //      $duration = round($stamp2-$stamp1, 3);
 100                         //      if ($duration > $a->config["system"]["db_loglimit"])
 101                         //              @file_put_contents($a->config["system"]["db_log"], $duration."\t".strlen($img_str)."\t".$_REQUEST['url']."\n", FILE_APPEND);
 102                         //}
 103
 104                         killme();
 105                 }
 106         }
 107
 108         require_once("Photo.php");
 109
 110         $valid = true;
 111
 112         $r = q("SELECT * FROM `photo` WHERE `resource-id` in ('%s', '%s') LIMIT 1", $urlhash, $urlhash2);
 113         if (count($r)) {
 114                 $img_str = $r[0]['data'];
 115                 $mime = $r[0]["desc"];
 116                 if ($mime == "") $mime = "image/jpeg";
 117
 118         } else {
 119                 // It shouldn't happen but it does - spaces in URL
 120                 $_REQUEST['url'] = str_replace(" ", "+", $_REQUEST['url']);
 121
 122                 // if the picture seems to be from another picture cache then take the original source
 123                 $queryvar = privacy_image_cache_parse_query($_REQUEST['url']);
 124                 if ($queryvar['url'] != "")
 125                         $_REQUEST['url'] = urldecode($queryvar['url']);
 126
 127                 // if fetching facebook pictures don't fetch the thumbnail but the big one
 128                 if (strpos($_REQUEST['url'], ".fbcdn.net/") and (substr($_REQUEST['url'], -6) == "_s.jpg"))
 129                         $_REQUEST['url'] = substr($_REQUEST['url'], 0, -6)."_n.jpg";
 130
 131                 $img_str = fetch_url($_REQUEST['url'],true);
 132
 133                 $tempfile = tempnam(get_config("system","temppath"), "cache");
 134                 file_put_contents($tempfile, $img_str);
 135                 $mime = image_type_to_mime_type(exif_imagetype($tempfile));
 136                 unlink($tempfile);
 137
 138                 // If there is an error then return a blank image
 139                 if ((substr($a->get_curl_code(), 0, 1) == "4") or (!$img_str)) {
 140                         $img_str = file_get_contents("images/blank.png");
 141                         $mime = "image/png";
 142                         $cachefile = ""; // Clear the cachefile so that the dummy isn't stored
 143                         $valid = false;
 144                         $img = new Photo($img_str);
 145                         if($img->is_valid()) {
 146                                 $img->scaleImage(1);
 147                                 $img_str = $img->imageString();
 148                         }
 149                 //} else if (substr($img_str, 0, 6) == "GIF89a") {
 150                 } else if ($mime != "image/jpeg") {
 151                         $image = @imagecreatefromstring($img_str);
 152
 153                         if($image === FALSE) die();
 154
 155                         q("INSERT INTO `photo`
 156                         ( `uid`, `contact-id`, `guid`, `resource-id`, `created`, `edited`, `filename`, `album`, `height`, `width`, `desc`, `data`, `scale`, `profile`, `allow_cid`, `allow_gid`, `deny_cid`, `deny_gid` )
 157                         VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', '%s', %d, %d, '%s', '%s', '%s', '%s' )",
 158                                 0, 0, get_guid(), dbesc($urlhash),
 159                                 dbesc(datetime_convert()),
 160                                 dbesc(datetime_convert()),
 161                                 dbesc(basename(dbesc($_REQUEST["url"]))),
 162                                 dbesc(''),
 163                                 intval(imagesy($image)),
 164                                 intval(imagesx($image)),
 165                                 $mime,
 166                                 dbesc($img_str),
 167                                 100,
 168                                 intval(0),
 169                                 dbesc(''), dbesc(''), dbesc(''), dbesc('')
 170                         );
 171
 172                 } else {
 173                         $img = new Photo($img_str);
 174                         if($img->is_valid()) {
 175                                 $img->store(0, 0, $urlhash, $_REQUEST['url'], '', 100);
 176                                 if ($thumb)
 177                                         $img->scaleImage(200); // Test
 178                                 $img_str = $img->imageString();
 179                         }
 180                         $mime = "image/jpeg";
 181                 }
 182         }
 183
 184
 185         // If there is a real existing directory then put the cache file there
 186         // advantage: real file access is really fast
 187         // Otherwise write in cachefile
 188         if ($valid AND is_dir($_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache"))
 189                 file_put_contents($_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache/".privacy_image_cache_cachename($_REQUEST['url'], true), $img_str);
 190         elseif ($cachefile != '')
 191                 file_put_contents($cachefile, $img_str);
 192
 193         header("Content-type: $mime");
 194
 195         // Only output the cache headers when the file is valid
 196         if ($valid) {
 197                 header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
 198                 header('Etag: "'.md5($img_str).'"');
 199                 header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
 200                 header("Cache-Control: max-age=31536000");
 201         }
 202
 203         echo $img_str;
 204
 205         //if ($a->config["system"]["db_log"] != "") {
 206         //      $stamp2 = microtime(true);
 207         //      $duration = round($stamp2-$stamp1, 3);
 208         //      if ($duration > $a->config["system"]["db_loglimit"])
 209         //              @file_put_contents($a->config["system"]["db_log"], $duration."\t".strlen($img_str)."\t".$_REQUEST['url']."\n", FILE_APPEND);
 210         //}
 211
 212         killme();
 213 }
 214
 215 function privacy_image_cache_cachename($url, $writemode = false) {
 216         global $_SERVER;
 217
 218         $basepath = $_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache";
 219
 220         $path = substr(hash("md5", $url), 0, 2);
 221
 222         if (is_dir($basepath) and $writemode)
 223                 if (!is_dir($basepath."/".$path)) {
 224                         mkdir($basepath."/".$path);
 225                         chmod($basepath."/".$path, 0777);
 226                 }
 227
 228         $path .= "/".strtr(base64_encode($url), '+/', '-_');
 229
 230         return($path);
 231 }
 232
 233 /**
 234  * @param $url string
 235  * @return boolean
 236  */
 237 function privacy_image_cache_is_local_image($url) {
 238         if ($url[0] == '/') return true;
 239
 240         if (strtolower(substr($url, 0, 5)) == "data:") return true;
 241
 242         // Check if the cached path would be longer than 255 characters - apache doesn't like it
 243         if (is_dir($_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache")) {
 244                 $cachedurl = get_app()->get_baseurl()."/privacy_image_cache/". privacy_image_cache_cachename($url);
 245                 if (strlen($url) > 255)
 246                         return true;
 247         }
 248
 249         // links normalised - bug #431
 250         $baseurl = normalise_link(get_app()->get_baseurl());
 251         $url = normalise_link($url);
 252         return (substr($url, 0, strlen($baseurl)) == $baseurl);
 253 }
 254
 255 /**
 256  * @param array $matches
 257  * @return string
 258  */
 259 function privacy_image_cache_img_cb($matches) {
 260         // following line changed per bug #431
 261         if (privacy_image_cache_is_local_image($matches[2]))
 262                 return $matches[1] . $matches[2] . $matches[3];
 263
 264         //return $matches[1] . get_app()->get_baseurl() . "/privacy_image_cache/?url=" . addslashes(rawurlencode(htmlspecialchars_decode($matches[2]))) . $matches[3];
 265
 266         return $matches[1].get_app()->get_baseurl()."/privacy_image_cache/". privacy_image_cache_cachename(htmlspecialchars_decode($matches[2])).$matches[3];
 267 }
 268
 269 /**
 270  * @param App $a
 271  * @param string $o
 272  */
 273 function privacy_image_cache_prepare_body_hook(&$a, &$o) {
 274         $o["html"] = preg_replace_callback("/(<img [^>]*src *= *[\"'])([^\"']+)([\"'][^>]*>)/siU", "privacy_image_cache_img_cb", $o["html"]);
 275 }
 276
 277 /**
 278  * @param App $a
 279  * @param string $o
 280  * Function disabled because the plugin moved
 281  */
 282 function privacy_image_cache_bbcode_hook(&$a, &$o) {
 283         //$o = preg_replace_callback("/(<img [^>]*src *= *[\"'])([^\"']+)([\"'][^>]*>)/siU", "privacy_image_cache_img_cb", $o);
 284 }
 285
 286
 287 /**
 288  * @param App $a
 289  * @param string $o
 290  */
 291 function privacy_image_cache_display_item_hook(&$a, &$o) {
 292     if (isset($o["output"])) {
 293         if (isset($o["output"]["thumb"]) && !privacy_image_cache_is_local_image($o["output"]["thumb"]))
 294             $o["output"]["thumb"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["output"]["thumb"]);
 295             //$o["output"]["thumb"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["output"]["thumb"])));
 296         if (isset($o["output"]["author-avatar"]) && !privacy_image_cache_is_local_image($o["output"]["author-avatar"]))
 297             $o["output"]["author-avatar"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["output"]["author-avatar"]);
 298             //$o["output"]["author-avatar"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["output"]["author-avatar"])));
 299         if (isset($o["output"]["owner-avatar"]) && !privacy_image_cache_is_local_image($o["output"]["owner-avatar"]))
 300             $o["output"]["owner-avatar"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["output"]["owner-avatar"]);
 301             //$o["output"]["owner-avatar"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["output"]["owner-avatar"])));
 302     }
 303 }
 304
 305
 306 /**
 307  * @param App $a
 308  * @param string $o
 309  */
 310 function privacy_image_cache_ping_xmlize_hook(&$a, &$o) {
 311     if ($o["photo"] != "" && !privacy_image_cache_is_local_image($o["photo"]))
 312         $o["photo"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["photo"]);
 313         //$o["photo"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["photo"])));
 314 }
 315
 316
 317 /**
 318  * @param App $a
 319  * @param null|object $b
 320  */
 321 function privacy_image_cache_cron(&$a = null, &$b = null) {
 322     $cachetime = get_config('privacy_image_cache','cache_time');
 323     if (!$cachetime) $cachetime = PRIVACY_IMAGE_CACHE_DEFAULT_TIME;
 324
 325     $last = get_config('pi_cache','last_delete');
 326     $time = time();
 327     if ($time < ($last + 3600)) return;
 328
 329     logger("Purging old Cache of the Privacy Image Cache", LOGGER_DEBUG);
 330     q('DELETE FROM `photo` WHERE `uid` = 0 AND `resource-id` LIKE "pic:%%" AND `created` < NOW() - INTERVAL %d SECOND', $cachetime);
 331
 332     clear_cache($a->get_basepath(), $a->get_basepath()."/privacy_image_cache");
 333
 334     set_config('pi_cache', 'last_delete', $time);
 335 }
 336
 337 /**
 338  * @param App $a
 339  * @param null|object $o
 340  */
 341 function privacy_image_cache_plugin_admin(&$a, &$o){
 342
 343
 344     $o = '<input type="hidden" name="form_security_token" value="' . get_form_security_token("picsave") . '">';
 345
 346     $cachetime = get_config('privacy_image_cache','cache_time');
 347     if (!$cachetime) $cachetime = PRIVACY_IMAGE_CACHE_DEFAULT_TIME;
 348     $cachetime_h = Ceil($cachetime / 3600);
 349
 350     $o .= '<label for="pic_cachetime">' . t('Lifetime of the cache (in hours)') . '</label>
 351         <input id="pic_cachetime" name="cachetime" type="text" value="' . escape_tags($cachetime_h) . '"><br style="clear: both;">';
 352
 353     $o .= '<input type="submit" name="save" value="' . t('Save') . '">';
 354
 355     $o .= '<h4>' . t('Cache Statistics') . '</h4>';
 356
 357     $num = q('SELECT COUNT(*) num, SUM(LENGTH(data)) size FROM `photo` WHERE `uid`=0 AND `contact-id`=0 AND `resource-id` LIKE "pic:%%"');
 358     $o .= '<label for="statictics_num">' . t('Number of items') . '</label><input style="color: gray;" id="statistics_num" disabled value="' . escape_tags($num[0]['num']) . '"><br style="clear: both;">';
 359     $size = Ceil($num[0]['size'] / (1024 * 1024));
 360     $o .= '<label for="statictics_size">' . t('Size of the cache') . '</label><input style="color: gray;" id="statistics_size" disabled value="' . $size . ' MB"><br style="clear: both;">';
 361
 362     $o .= '<input type="submit" name="delete_all" value="' . t('Delete the whole cache') . '">';
 363 }
 364
 365
 366 /**
 367  * @param App $a
 368  * @param null|object $o
 369  */
 370 function privacy_image_cache_plugin_admin_post(&$a = null, &$o = null){
 371     check_form_security_token_redirectOnErr('/admin/plugins/privacy_image_cache', 'picsave');
 372
 373     if (isset($_REQUEST['save'])) {
 374         $cachetime_h = IntVal($_REQUEST['cachetime']);
 375         if ($cachetime_h < 1) $cachetime_h = 1;
 376         set_config('privacy_image_cache','cache_time', $cachetime_h * 3600);
 377     }
 378     if (isset($_REQUEST['delete_all'])) {
 379         q('DELETE FROM `photo` WHERE `uid` = 0 AND `resource-id` LIKE "pic:%%"');
 380     }
 381 }
 382
 383 function privacy_image_cache_parse_query($var) {
 384         /**
 385          *  Use this function to parse out the query array element from
 386          *  the output of parse_url().
 387         */
 388         $var  = parse_url($var, PHP_URL_QUERY);
 389         $var  = html_entity_decode($var);
 390         $var  = explode('&', $var);
 391         $arr  = array();
 392
 393         foreach($var as $val) {
 394                 $x          = explode('=', $val);
 395                 $arr[$x[0]] = $x[1];
 396         }
 397
 398         unset($val, $x, $var);
 399         return $arr;
 400 }