From: Hypolite Petovan <mrpetovan@gmail.com>
Date: Tue, 20 Dec 2016 20:23:08 +0000 (-0500)
Subject: proxy mod: Standards bearer
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=b2768d8f1cbba565f0efd7a7b007b9479648b353;p=friendica.git

proxy mod: Standards bearer

- Enforced PSR-2 standards
- Normalized concatenation formatting
- Normalized string delimiters
- Normalized condition operators
- Collapsed directly nested conditions
- Used dvm::is_result
- Added comments
---

diff --git a/mod/proxy.php b/mod/proxy.php
index 46d77726cc..736b44007f 100644
--- a/mod/proxy.php
+++ b/mod/proxy.php
@@ -1,20 +1,18 @@
 <?php
 // Based upon "Privacy Image Cache" by Tobias Hößl <https://github.com/CatoTH/>
 
-define("PROXY_DEFAULT_TIME", 86400); // 1 Day
+define('PROXY_DEFAULT_TIME', 86400); // 1 Day
 
-define("PROXY_SIZE_MICRO", "micro");
-define("PROXY_SIZE_THUMB", "thumb");
-define("PROXY_SIZE_SMALL", "small");
-define("PROXY_SIZE_MEDIUM", "medium");
-define("PROXY_SIZE_LARGE", "large");
+define('PROXY_SIZE_MICRO', 'micro');
+define('PROXY_SIZE_THUMB', 'thumb');
+define('PROXY_SIZE_SMALL', 'small');
+define('PROXY_SIZE_MEDIUM', 'medium');
+define('PROXY_SIZE_LARGE', 'large');
 
-require_once('include/security.php');
-require_once("include/Photo.php");
-
-function proxy_init() {
-	global $a, $_SERVER;
+require_once 'include/security.php';
+require_once 'include/Photo.php';
 
+function proxy_init(App $a) {
 	// Pictures are stored in one of the following ways:
 	// 1. If a folder "proxy" exists and is writeable, then use this for caching
 	// 2. If a cache path is defined, use this
@@ -24,11 +22,12 @@ function proxy_init() {
 
 	if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
 		header('HTTP/1.1 304 Not Modified');
-		header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
-		header('Etag: '.$_SERVER['HTTP_IF_NONE_MATCH']);
-		header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
-		header("Cache-Control: max-age=31536000");
-		if(function_exists('header_remove')) {
+		header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
+		header('Etag: ' . $_SERVER['HTTP_IF_NONE_MATCH']);
+		header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
+		header('Cache-Control: max-age=31536000');
+
+		if (function_exists('header_remove')) {
 			header_remove('Last-Modified');
 			header_remove('Expires');
 			header_remove('Cache-Control');
@@ -36,140 +35,149 @@ function proxy_init() {
 		exit;
 	}
 
-	if(function_exists('header_remove')) {
+	if (function_exists('header_remove')) {
 		header_remove('Pragma');
 		header_remove('pragma');
 	}
 
 	$thumb = false;
 	$size = 1024;
-	$sizetype = "";
+	$sizetype = '';
 	$basepath = $a->get_basepath();
 
 	// If the cache path isn't there, try to create it
-	if (!is_dir($basepath."/proxy"))
-		if (is_writable($basepath))
-			mkdir($basepath."/proxy");
+	if (!is_dir($basepath . '/proxy') AND is_writable($basepath)) {
+		mkdir($basepath . '/proxy');
+	}
 
 	// Checking if caching into a folder in the webroot is activated and working
-	$direct_cache = (is_dir($basepath."/proxy") AND is_writable($basepath."/proxy"));
+	$direct_cache = (is_dir($basepath . '/proxy') AND is_writable($basepath . '/proxy'));
 
 	// Look for filename in the arguments
-	if ((isset($a->argv[1]) OR isset($a->argv[2]) OR isset($a->argv[3])) AND !isset($_REQUEST["url"])) {
-		if (isset($a->argv[3]))
+	if ((isset($a->argv[1]) OR isset($a->argv[2]) OR isset($a->argv[3])) AND !isset($_REQUEST['url'])) {
+		if (isset($a->argv[3])) {
 			$url = $a->argv[3];
-		elseif (isset($a->argv[2]))
+		} elseif (isset($a->argv[2])) {
 			$url = $a->argv[2];
-		else
+		} else {
 			$url = $a->argv[1];
+		}
 
-		if (isset($a->argv[3]) and ($a->argv[3] == "thumb"))
+		if (isset($a->argv[3]) AND ($a->argv[3] == 'thumb')) {
 			$size = 200;
+		}
 
 		// thumb, small, medium and large.
-		if (substr($url, -6) == ":micro") {
+		if (substr($url, -6) == ':micro') {
 			$size = 48;
-			$sizetype = ":micro";
+			$sizetype = ':micro';
 			$url = substr($url, 0, -6);
-		} elseif (substr($url, -6) == ":thumb") {
+		} elseif (substr($url, -6) == ':thumb') {
 			$size = 80;
-			$sizetype = ":thumb";
+			$sizetype = ':thumb';
 			$url = substr($url, 0, -6);
-		} elseif (substr($url, -6) == ":small") {
+		} elseif (substr($url, -6) == ':small') {
 			$size = 175;
 			$url = substr($url, 0, -6);
-			$sizetype = ":small";
-		} elseif (substr($url, -7) == ":medium") {
+			$sizetype = ':small';
+		} elseif (substr($url, -7) == ':medium') {
 			$size = 600;
 			$url = substr($url, 0, -7);
-			$sizetype = ":medium";
-		} elseif (substr($url, -6) == ":large") {
+			$sizetype = ':medium';
+		} elseif (substr($url, -6) == ':large') {
 			$size = 1024;
 			$url = substr($url, 0, -6);
-			$sizetype = ":large";
+			$sizetype = ':large';
 		}
 
-		$pos = strrpos($url, "=.");
-		if ($pos)
-			$url = substr($url, 0, $pos+1);
+		$pos = strrpos($url, '=.');
+		if ($pos) {
+			$url = substr($url, 0, $pos + 1);
+		}
 
-		$url = str_replace(array(".jpg", ".jpeg", ".gif", ".png"), array("","","",""), $url);
+		$url = str_replace(array('.jpg', '.jpeg', '.gif', '.png'), array('','','',''), $url);
 
 		$url = base64_decode(strtr($url, '-_', '+/'), true);
 
-		if ($url)
+		if ($url) {
 			$_REQUEST['url'] = $url;
-	} else
+		}
+	} else {
 		$direct_cache = false;
+	}
 
 	if (!$direct_cache) {
 		$urlhash = 'pic:' . sha1($_REQUEST['url']);
 
-		$cachefile = get_cachefile(hash("md5", $_REQUEST['url']));
-		if ($cachefile != '') {
-			if (file_exists($cachefile)) {
-				$img_str = file_get_contents($cachefile);
-				$mime = image_type_to_mime_type(exif_imagetype($cachefile));
-
-				header("Content-type: $mime");
-				header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
-				header('Etag: "'.md5($img_str).'"');
-				header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
-				header("Cache-Control: max-age=31536000");
-
-				// reduce quality - if it isn't a GIF
-				if ($mime != "image/gif") {
-					$img = new Photo($img_str, $mime);
-					if($img->is_valid()) {
-						$img_str = $img->imageString();
-					}
+		$cachefile = get_cachefile(hash('md5', $_REQUEST['url']));
+		if ($cachefile != '' AND file_exists($cachefile)) {
+			$img_str = file_get_contents($cachefile);
+			$mime = image_type_to_mime_type(exif_imagetype($cachefile));
+
+			header('Content-type: ' . $mime);
+			header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
+			header('Etag: "' . md5($img_str) . '"');
+			header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
+			header('Cache-Control: max-age=31536000');
+
+			// reduce quality - if it isn't a GIF
+			if ($mime != 'image/gif') {
+				$img = new Photo($img_str, $mime);
+				if ($img->is_valid()) {
+					$img_str = $img->imageString();
 				}
-
-				echo $img_str;
-				killme();
 			}
+
+			echo $img_str;
+			killme();
 		}
-	} else
-		$cachefile = "";
+	} else {
+		$cachefile = '';
+	}
 
 	$valid = true;
 
-	if (!$direct_cache AND ($cachefile == "")) {
+	if (!$direct_cache AND ($cachefile == '')) {
 		$r = qu("SELECT * FROM `photo` WHERE `resource-id` = '%s' LIMIT 1", $urlhash);
-		if (count($r)) {
-        		$img_str = $r[0]['data'];
-			$mime = $r[0]["desc"];
-			if ($mime == "") $mime = "image/jpeg";
+		if (dbm::is_result($r)) {
+			$img_str = $r[0]['data'];
+			$mime = $r[0]['desc'];
+			if ($mime == '') {
+				$mime = 'image/jpeg';
+			}
 		}
-	} else
+	} else {
 		$r = array();
+	}
 
-	if (!count($r)) {
+	if (!dbm::is_result($r)) {
 		// It shouldn't happen but it does - spaces in URL
-		$_REQUEST['url'] = str_replace(" ", "+", $_REQUEST['url']);
+		$_REQUEST['url'] = str_replace(' ', '+', $_REQUEST['url']);
 		$redirects = 0;
-		$img_str = fetch_url($_REQUEST['url'],true, $redirects, 10);
+		$img_str = fetch_url($_REQUEST['url'], true, $redirects, 10);
 
-		$tempfile = tempnam(get_temppath(), "cache");
+		$tempfile = tempnam(get_temppath(), 'cache');
 		file_put_contents($tempfile, $img_str);
 		$mime = image_type_to_mime_type(exif_imagetype($tempfile));
 		unlink($tempfile);
 
 		// If there is an error then return a blank image
-		if ((substr($a->get_curl_code(), 0, 1) == "4") or (!$img_str)) {
-			$img_str = file_get_contents("images/blank.png");
-			$mime = "image/png";
-			$cachefile = ""; // Clear the cachefile so that the dummy isn't stored
+		if ((substr($a->get_curl_code(), 0, 1) == '4') OR (!$img_str)) {
+			$img_str = file_get_contents('images/blank.png');
+			$mime = 'image/png';
+			$cachefile = ''; // Clear the cachefile so that the dummy isn't stored
 			$valid = false;
-			$img = new Photo($img_str, "image/png");
-			if($img->is_valid()) {
+			$img = new Photo($img_str, 'image/png');
+			if ($img->is_valid()) {
 				$img->scaleImage(10);
 				$img_str = $img->imageString();
 			}
-		} else if (($mime != "image/jpeg") AND !$direct_cache AND ($cachefile == "")) {
+		} elseif ($mime != 'image/jpeg' AND !$direct_cache AND $cachefile == '') {
 			$image = @imagecreatefromstring($img_str);
 
-			if($image === FALSE) die();
+			if ($image === FALSE) {
+				die();
+			}
 
 			q("INSERT INTO `photo`
 			( `uid`, `contact-id`, `guid`, `resource-id`, `created`, `edited`, `filename`, `album`, `height`, `width`, `desc`, `data`, `scale`, `profile`, `allow_cid`, `allow_gid`, `deny_cid`, `deny_gid` )
@@ -177,7 +185,7 @@ function proxy_init() {
 				0, 0, get_guid(), dbesc($urlhash),
 				dbesc(datetime_convert()),
 				dbesc(datetime_convert()),
-				dbesc(basename(dbesc($_REQUEST["url"]))),
+				dbesc(basename(dbesc($_REQUEST['url']))),
 				dbesc(''),
 				intval(imagesy($image)),
 				intval(imagesx($image)),
@@ -190,9 +198,8 @@ function proxy_init() {
 
 		} else {
 			$img = new Photo($img_str, $mime);
-			if($img->is_valid()) {
-				if (!$direct_cache AND ($cachefile == ""))
-					$img->store(0, 0, $urlhash, $_REQUEST['url'], '', 100);
+			if ($img->is_valid() AND !$direct_cache AND ($cachefile == '')) {
+				$img->store(0, 0, $urlhash, $_REQUEST['url'], '', 100);
 			}
 		}
 	}
@@ -200,9 +207,9 @@ function proxy_init() {
 	$img_str_orig = $img_str;
 
 	// reduce quality - if it isn't a GIF
-	if ($mime != "image/gif") {
+	if ($mime != 'image/gif') {
 		$img = new Photo($img_str, $mime);
-		if($img->is_valid()) {
+		if ($img->is_valid()) {
 			$img->scaleImage($size);
 			$img_str = $img->imageString();
 		}
@@ -212,20 +219,22 @@ function proxy_init() {
 	// advantage: real file access is really fast
 	// Otherwise write in cachefile
 	if ($valid AND $direct_cache) {
-		file_put_contents($basepath."/proxy/".proxy_url($_REQUEST['url'], true), $img_str_orig);
-		if ($sizetype <> '')
-			file_put_contents($basepath."/proxy/".proxy_url($_REQUEST['url'], true).$sizetype, $img_str);
-	} elseif ($cachefile != '')
+		file_put_contents($basepath . '/proxy/' . proxy_url($_REQUEST['url'], true), $img_str_orig);
+		if ($sizetype != '') {
+			file_put_contents($basepath . '/proxy/' . proxy_url($_REQUEST['url'], true) . $sizetype, $img_str);
+		}
+	} elseif ($cachefile != '') {
 		file_put_contents($cachefile, $img_str_orig);
+	}
 
-	header("Content-type: $mime");
+	header('Content-type: ' . $mime);
 
 	// Only output the cache headers when the file is valid
 	if ($valid) {
-		header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT");
-		header('Etag: "'.md5($img_str).'"');
-		header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT");
-		header("Cache-Control: max-age=31536000");
+		header('Last-Modified: ' . gmdate('D, d M Y H:i:s', time()) . ' GMT');
+		header('Etag: "' . md5($img_str) . '"');
+		header('Expires: ' . gmdate('D, d M Y H:i:s', time() + (31536000)) . ' GMT');
+		header('Cache-Control: max-age=31536000');
 	}
 
 	echo $img_str;
@@ -272,11 +281,9 @@ function proxy_url($url, $writemode = false, $size = '') {
 	$shortpath = hash('md5', $url);
 	$longpath = substr($shortpath, 0, 2);
 
-	if (is_dir($basepath) and $writemode) {
-		if (!is_dir($basepath . '/' . $longpath)) {
-			mkdir($basepath . '/' . $longpath);
-			chmod($basepath . '/' . $longpath, 0777);
-		}
+	if (is_dir($basepath) AND $writemode AND !is_dir($basepath . '/' . $longpath)) {
+		mkdir($basepath . '/' . $longpath);
+		chmod($basepath . '/' . $longpath, 0777);
 	}
 
 	$longpath .= '/' . strtr(base64_encode($url), '+/', '-_');
@@ -314,9 +321,13 @@ function proxy_url($url, $writemode = false, $size = '') {
  * @return boolean
  */
 function proxy_is_local_image($url) {
-	if ($url[0] == '/') return true;
+	if ($url[0] == '/') {
+		return true;
+	}
 
-	if (strtolower(substr($url, 0, 5)) == "data:") return true;
+	if (strtolower(substr($url, 0, 5)) == 'data:') {
+		return true;
+	}
 
 	// links normalised - bug #431
 	$baseurl = normalise_link(get_app()->get_baseurl());
@@ -324,42 +335,45 @@ function proxy_is_local_image($url) {
 	return (substr($url, 0, strlen($baseurl)) == $baseurl);
 }
 
-function proxy_parse_query($var) {
-        /**
-         *  Use this function to parse out the query array element from
-         *  the output of parse_url().
-        */
-        $var  = parse_url($var, PHP_URL_QUERY);
-        $var  = html_entity_decode($var);
-        $var  = explode('&', $var);
-        $arr  = array();
-
-        foreach($var as $val) {
-                $x          = explode('=', $val);
-                $arr[$x[0]] = $x[1];
-        }
-
-        unset($val, $x, $var);
-        return $arr;
+/**
+ * @brief Return the array of query string parameters from a URL
+ *
+ * @param string $url
+ * @return array Associative array of query string parameters
+ */
+function proxy_parse_query($url) {
+	$query = parse_url($url, PHP_URL_QUERY);
+	$query = html_entity_decode($query);
+	$query_list = explode('&', $query);
+	$arr = array();
+
+	foreach ($query_list as $key_value) {
+		$key_value_list = explode('=', $key_value);
+		$arr[$key_value_list[0]] = $key_value_list[1];
+	}
+
+	unset($url, $query_list, $url);
+	return $arr;
 }
 
 function proxy_img_cb($matches) {
-
 	// if the picture seems to be from another picture cache then take the original source
 	$queryvar = proxy_parse_query($matches[2]);
-	if (($queryvar['url'] != "") AND (substr($queryvar['url'], 0, 4) == "http"))
+	if (($queryvar['url'] != '') AND (substr($queryvar['url'], 0, 4) == 'http')) {
 		$matches[2] = urldecode($queryvar['url']);
+	}
 
 	// following line changed per bug #431
-	if (proxy_is_local_image($matches[2]))
+	if (proxy_is_local_image($matches[2])) {
 		return $matches[1] . $matches[2] . $matches[3];
+	}
 
-	return $matches[1].proxy_url(htmlspecialchars_decode($matches[2])).$matches[3];
+	return $matches[1] . proxy_url(htmlspecialchars_decode($matches[2])) . $matches[3];
 }
 
 function proxy_parse_html($html) {
 	$a = get_app();
-	$html = str_replace(normalise_link($a->get_baseurl())."/", $a->get_baseurl()."/", $html);
+	$html = str_replace(normalise_link($a->get_baseurl()) . '/', $a->get_baseurl() . '/', $html);
 
-	return preg_replace_callback("/(<img [^>]*src *= *[\"'])([^\"']+)([\"'][^>]*>)/siU", "proxy_img_cb", $html);
+	return preg_replace_callback('/(<img [^>]*src *= *["\'])([^"\']+)(["\'][^>]*>)/siU', 'proxy_img_cb', $html);
 }