4 * Name: Privacy Image Cache
6 * Author: Tobias Hößl <https://github.com/CatoTH/>
9 define("PRIVACY_IMAGE_CACHE_DEFAULT_TIME", 86400); // 1 Day
11 require_once('include/security.php');
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');
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');
31 function privacy_image_cache_module() {}
33 function privacy_image_cache_init() {
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');
50 //if ($a->config["system"]["db_log"] != "")
51 // $stamp1 = microtime(true);
53 if(function_exists('header_remove')) {
54 header_remove('Pragma');
55 header_remove('pragma');
60 // Look for filename in the arguments
61 if (isset($a->argv[1]) OR isset($a->argv[2])) {
62 if (isset($a->argv[2]))
67 $pos = strrpos($url, "==.");
69 $url = substr($url, 0, $pos+2);
71 $url = base64_decode(strtr($url, '-_', '+/'), true);
73 $_REQUEST['url'] = $url;
75 $thumb = (isset($a->argv[3]) and ($a->argv[3] == "thumb"));
78 $urlhash = 'pic:' . sha1($_REQUEST['url']);
79 // Double encoded url - happens with Diaspora
80 $urlhash2 = 'pic:' . sha1(urldecode($_REQUEST['url']));
82 $cachefile = get_cachefile(hash("md5", $_REQUEST['url']));
83 if ($cachefile != '') {
84 if (file_exists($cachefile)) {
85 $img_str = file_get_contents($cachefile);
87 $mime = image_type_to_mime_type(exif_imagetype($cachefile));
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");
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);
108 require_once("Photo.php");
112 $r = q("SELECT * FROM `photo` WHERE `resource-id` in ('%s', '%s') LIMIT 1", $urlhash, $urlhash2);
114 $img_str = $r[0]['data'];
115 $mime = $r[0]["desc"];
116 if ($mime == "") $mime = "image/jpeg";
119 // It shouldn't happen but it does - spaces in URL
120 $_REQUEST['url'] = str_replace(" ", "+", $_REQUEST['url']);
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']);
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";
132 $img_str = fetch_url($_REQUEST['url'],true, $redirects, 10);
134 $tempfile = tempnam(get_config("system","temppath"), "cache");
135 file_put_contents($tempfile, $img_str);
136 $mime = image_type_to_mime_type(exif_imagetype($tempfile));
139 // If there is an error then return a blank image
140 if ((substr($a->get_curl_code(), 0, 1) == "4") or (!$img_str)) {
141 $img_str = file_get_contents("images/blank.png");
143 $cachefile = ""; // Clear the cachefile so that the dummy isn't stored
145 $img = new Photo($img_str, "image/png");
146 if($img->is_valid()) {
147 $img->scaleImage(10);
148 $img_str = $img->imageString();
150 //} else if (substr($img_str, 0, 6) == "GIF89a") {
151 } else if ($mime != "image/jpeg") {
152 $image = @imagecreatefromstring($img_str);
154 if($image === FALSE) die();
156 q("INSERT INTO `photo`
157 ( `uid`, `contact-id`, `guid`, `resource-id`, `created`, `edited`, `filename`, `album`, `height`, `width`, `desc`, `data`, `scale`, `profile`, `allow_cid`, `allow_gid`, `deny_cid`, `deny_gid` )
158 VALUES ( %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', '%s', %d, %d, '%s', '%s', '%s', '%s' )",
159 0, 0, get_guid(), dbesc($urlhash),
160 dbesc(datetime_convert()),
161 dbesc(datetime_convert()),
162 dbesc(basename(dbesc($_REQUEST["url"]))),
164 intval(imagesy($image)),
165 intval(imagesx($image)),
170 dbesc(''), dbesc(''), dbesc(''), dbesc('')
174 $img = new Photo($img_str);
175 if($img->is_valid()) {
176 $img->store(0, 0, $urlhash, $_REQUEST['url'], '', 100);
178 $img->scaleImage(200); // Test
179 $img_str = $img->imageString();
181 $mime = "image/jpeg";
186 // If there is a real existing directory then put the cache file there
187 // advantage: real file access is really fast
188 // Otherwise write in cachefile
189 if ($valid AND is_dir($_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache"))
190 file_put_contents($_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache/".privacy_image_cache_cachename($_REQUEST['url'], true), $img_str);
191 elseif ($cachefile != '')
192 file_put_contents($cachefile, $img_str);
194 header("Content-type: $mime");
196 // Only output the cache headers when the file is valid
198 header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
199 header('Etag: "'.md5($img_str).'"');
200 header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
201 header("Cache-Control: max-age=31536000");
206 //if ($a->config["system"]["db_log"] != "") {
207 // $stamp2 = microtime(true);
208 // $duration = round($stamp2-$stamp1, 3);
209 // if ($duration > $a->config["system"]["db_loglimit"])
210 // @file_put_contents($a->config["system"]["db_log"], $duration."\t".strlen($img_str)."\t".$_REQUEST['url']."\n", FILE_APPEND);
216 function privacy_image_cache_cachename($url, $writemode = false) {
219 $basepath = $_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache";
221 $path = substr(hash("md5", $url), 0, 2);
223 if (is_dir($basepath) and $writemode)
224 if (!is_dir($basepath."/".$path)) {
225 mkdir($basepath."/".$path);
226 chmod($basepath."/".$path, 0777);
229 $path .= "/".strtr(base64_encode($url), '+/', '-_');
238 function privacy_image_cache_is_local_image($url) {
239 if ($url[0] == '/') return true;
241 if (strtolower(substr($url, 0, 5)) == "data:") return true;
243 // Check if the cached path would be longer than 255 characters - apache doesn't like it
244 if (is_dir($_SERVER["DOCUMENT_ROOT"]."/privacy_image_cache")) {
245 $cachedurl = get_app()->get_baseurl()."/privacy_image_cache/". privacy_image_cache_cachename($url);
246 if (strlen($url) > 255)
250 // links normalised - bug #431
251 $baseurl = normalise_link(get_app()->get_baseurl());
252 $url = normalise_link($url);
253 return (substr($url, 0, strlen($baseurl)) == $baseurl);
257 * @param array $matches
260 function privacy_image_cache_img_cb($matches) {
261 // following line changed per bug #431
262 if (privacy_image_cache_is_local_image($matches[2]))
263 return $matches[1] . $matches[2] . $matches[3];
265 //return $matches[1] . get_app()->get_baseurl() . "/privacy_image_cache/?url=" . addslashes(rawurlencode(htmlspecialchars_decode($matches[2]))) . $matches[3];
267 return $matches[1].get_app()->get_baseurl()."/privacy_image_cache/". privacy_image_cache_cachename(htmlspecialchars_decode($matches[2])).$matches[3];
274 function privacy_image_cache_prepare_body_hook(&$a, &$o) {
275 $o["html"] = preg_replace_callback("/(<img [^>]*src *= *[\"'])([^\"']+)([\"'][^>]*>)/siU", "privacy_image_cache_img_cb", $o["html"]);
281 * Function disabled because the plugin moved
283 function privacy_image_cache_bbcode_hook(&$a, &$o) {
284 //$o = preg_replace_callback("/(<img [^>]*src *= *[\"'])([^\"']+)([\"'][^>]*>)/siU", "privacy_image_cache_img_cb", $o);
292 function privacy_image_cache_display_item_hook(&$a, &$o) {
293 if (isset($o["output"])) {
294 if (isset($o["output"]["thumb"]) && !privacy_image_cache_is_local_image($o["output"]["thumb"]))
295 $o["output"]["thumb"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["output"]["thumb"]);
296 //$o["output"]["thumb"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["output"]["thumb"])));
297 if (isset($o["output"]["author-avatar"]) && !privacy_image_cache_is_local_image($o["output"]["author-avatar"]))
298 $o["output"]["author-avatar"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["output"]["author-avatar"]);
299 //$o["output"]["author-avatar"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["output"]["author-avatar"])));
300 if (isset($o["output"]["owner-avatar"]) && !privacy_image_cache_is_local_image($o["output"]["owner-avatar"]))
301 $o["output"]["owner-avatar"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["output"]["owner-avatar"]);
302 //$o["output"]["owner-avatar"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["output"]["owner-avatar"])));
311 function privacy_image_cache_ping_xmlize_hook(&$a, &$o) {
312 if ($o["photo"] != "" && !privacy_image_cache_is_local_image($o["photo"]))
313 $o["photo"] = $a->get_baseurl() . "/privacy_image_cache/".privacy_image_cache_cachename($o["photo"]);
314 //$o["photo"] = $a->get_baseurl() . "/privacy_image_cache/?url=" . escape_tags(addslashes(rawurlencode($o["photo"])));
320 * @param null|object $b
322 function privacy_image_cache_cron(&$a = null, &$b = null) {
323 $cachetime = get_config('privacy_image_cache','cache_time');
324 if (!$cachetime) $cachetime = PRIVACY_IMAGE_CACHE_DEFAULT_TIME;
326 $last = get_config('pi_cache','last_delete');
328 if ($time < ($last + 3600)) return;
330 logger("Purging old Cache of the Privacy Image Cache", LOGGER_DEBUG);
331 q('DELETE FROM `photo` WHERE `uid` = 0 AND `resource-id` LIKE "pic:%%" AND `created` < NOW() - INTERVAL %d SECOND', $cachetime);
333 clear_cache($a->get_basepath(), $a->get_basepath()."/privacy_image_cache");
335 set_config('pi_cache', 'last_delete', $time);
340 * @param null|object $o
342 function privacy_image_cache_plugin_admin(&$a, &$o){
345 $o = '<input type="hidden" name="form_security_token" value="' . get_form_security_token("picsave") . '">';
347 $cachetime = get_config('privacy_image_cache','cache_time');
348 if (!$cachetime) $cachetime = PRIVACY_IMAGE_CACHE_DEFAULT_TIME;
349 $cachetime_h = Ceil($cachetime / 3600);
351 $o .= '<label for="pic_cachetime">' . t('Lifetime of the cache (in hours)') . '</label>
352 <input id="pic_cachetime" name="cachetime" type="text" value="' . escape_tags($cachetime_h) . '"><br style="clear: both;">';
354 $o .= '<input type="submit" name="save" value="' . t('Save') . '">';
356 $o .= '<h4>' . t('Cache Statistics') . '</h4>';
358 $num = q('SELECT COUNT(*) num, SUM(LENGTH(data)) size FROM `photo` WHERE `uid`=0 AND `contact-id`=0 AND `resource-id` LIKE "pic:%%"');
359 $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;">';
360 $size = Ceil($num[0]['size'] / (1024 * 1024));
361 $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;">';
363 $o .= '<input type="submit" name="delete_all" value="' . t('Delete the whole cache') . '">';
369 * @param null|object $o
371 function privacy_image_cache_plugin_admin_post(&$a = null, &$o = null){
372 check_form_security_token_redirectOnErr('/admin/plugins/privacy_image_cache', 'picsave');
374 if (isset($_REQUEST['save'])) {
375 $cachetime_h = IntVal($_REQUEST['cachetime']);
376 if ($cachetime_h < 1) $cachetime_h = 1;
377 set_config('privacy_image_cache','cache_time', $cachetime_h * 3600);
379 if (isset($_REQUEST['delete_all'])) {
380 q('DELETE FROM `photo` WHERE `uid` = 0 AND `resource-id` LIKE "pic:%%"');
384 function privacy_image_cache_parse_query($var) {
386 * Use this function to parse out the query array element from
387 * the output of parse_url().
389 $var = parse_url($var, PHP_URL_QUERY);
390 $var = html_entity_decode($var);
391 $var = explode('&', $var);
394 foreach($var as $val) {
395 $x = explode('=', $val);
399 unset($val, $x, $var);