From 9317a1c054675bbef7e11f21c5280f635d7ba90c Mon Sep 17 00:00:00 2001 From: fabrixxm Date: Wed, 21 Nov 2018 15:10:47 +0100 Subject: [PATCH] Address code standards issues --- .gitignore | 2 +- src/Model/Photo.php | 10 ++++--- src/Model/Storage/Filesystem.php | 26 ++++++++++-------- src/Model/Storage/IStorage.php | 6 ++-- src/Model/Storage/SystemResource.php | 12 +++++--- src/Module/Photo.php | 41 ++++++++++++++-------------- 6 files changed, 53 insertions(+), 44 deletions(-) diff --git a/.gitignore b/.gitignore index 345fe69cd9..0d18ab0bdc 100644 --- a/.gitignore +++ b/.gitignore @@ -73,4 +73,4 @@ venv/ .htaccess #ignore filesystem storage default path -/storage \ No newline at end of file +/storage diff --git a/src/Model/Photo.php b/src/Model/Photo.php index 3200c7f6ee..e8f77f8d23 100644 --- a/src/Model/Photo.php +++ b/src/Model/Photo.php @@ -62,7 +62,7 @@ class Photo extends BaseObject } return DBA::selectFirst("photo", $fields, $condition, $params); - } + } /** * @brief Get a single photo given resource id and scale @@ -79,7 +79,9 @@ class Photo extends BaseObject public static function getPhoto($resourceid, $scale = 0) { $r = self::selectFirst(["uid"], ["resource-id" => $resourceid]); - if ($r===false) return false; + if ($r === false) { + return false; + } $sql_acl = Security::getPermissionsSQLByUserId($r["uid"]); @@ -122,7 +124,7 @@ class Photo extends BaseObject if ($photo["backend-class"] == "") { // legacy data storage in "data" column $i = self::selectFirst(["data"], ["id"=>$photo["id"]]); - if ($i===false) { + if ($i === false) { return null; } $data = $i["data"]; @@ -207,7 +209,7 @@ class Photo extends BaseObject $data = ""; $backend_ref = ""; $backend_class = Config::get("storage", "class", ""); - if ($backend_class==="") { + if ($backend_class === "") { $data = $Image->asString(); } else { $backend_ref = $backend_class::put($Image->asString()); diff --git a/src/Model/Storage/Filesystem.php b/src/Model/Storage/Filesystem.php index 600d93f18b..de3e88be08 100644 --- a/src/Model/Storage/Filesystem.php +++ b/src/Model/Storage/Filesystem.php @@ -24,7 +24,7 @@ use Friendica\Util\Strings; class Filesystem implements IStorage { // Default base folder - const DEFAULT_BASE_FOLDER="storage"; + const DEFAULT_BASE_FOLDER = "storage"; private static function getBasePath() { @@ -39,28 +39,26 @@ class Filesystem implements IStorage private static function pathForRef($ref) { $base = self::getBasePath(); - $fold1 = substr($ref,0,2); - $fold2 = substr($ref,2,2); - $file = substr($ref,4); + $fold1 = substr($ref, 0, 2); + $fold2 = substr($ref, 2, 2); + $file = substr($ref, 4); return "{$base}/{$fold1}/{$fold2}/{$file}"; } - /* - - } - */ public static function get($ref) { $file = self::pathForRef($ref); - if (!is_file($file)) return ""; + if (!is_file($file)) { + return ""; + } return file_get_contents($file); } - public static function put($data, $ref = null) + public static function put($data, $ref = "") { - if (is_null($ref)) { + if ($ref === "") { $ref = Strings::getRandomHex(); } @@ -87,7 +85,11 @@ class Filesystem implements IStorage public static function delete($ref) { $file = self::pathForRef($ref); + // return true if file doesn't exists. we want to delete it: success with zero work! + if (!is_file($file)) { + return true; + } return unlink($file); } -} \ No newline at end of file +} diff --git a/src/Model/Storage/IStorage.php b/src/Model/Storage/IStorage.php index d9d2ddf7e2..93298050d5 100644 --- a/src/Model/Storage/IStorage.php +++ b/src/Model/Storage/IStorage.php @@ -19,12 +19,12 @@ interface IStorage public static function get($ref); /** - * @brief Put data in backend as $ref. If $ref is null a new reference is created. + * @brief Put data in backend as $ref. If $ref is not defiend a new reference is created. * @param string $data Data to save * @param string $ref Data referece. Optional. * @return string Saved data referece */ - public static function put($data, $ref = null); + public static function put($data, $ref = ""); /** * @brief Remove data from backend @@ -32,4 +32,4 @@ interface IStorage * @return boolean True on success */ public static function delete($ref); -} \ No newline at end of file +} diff --git a/src/Model/Storage/SystemResource.php b/src/Model/Storage/SystemResource.php index 822ff1cb9e..b54aabf6a4 100644 --- a/src/Model/Storage/SystemResource.php +++ b/src/Model/Storage/SystemResource.php @@ -15,18 +15,22 @@ namespace Friendica\Model\Storage; class SystemResource implements IStorage { // Valid folders to look for resources - const VALID_FOLDERS = [ "images" ]; + const VALID_FOLDERS = ["images"]; public static function get($filename) { $folder = dirname($filename); - if (!in_array($folder, self::VALID_FOLDERS)) return ""; - if (!file_exists($filename)) return ""; + if (!in_array($folder, self::VALID_FOLDERS)) { + return ""; + } + if (!file_exists($filename)) { + return ""; + } return file_get_contents($filename); } - public static function put($data, $filename=null) + public static function put($data, $filename="") { throw new \BadMethodCallException(); } diff --git a/src/Module/Photo.php b/src/Module/Photo.php index 5bc931dae6..8ce0c2674e 100644 --- a/src/Module/Photo.php +++ b/src/Module/Photo.php @@ -7,6 +7,7 @@ namespace Friendica\Module; use Friendica\BaseModule; use Friendica\Core\Logger; +use Friendica\Core\System; use Friendica\Model\Photo as MPhoto; use Friendica\Object\Image; use Friendica\Util\Security; @@ -30,22 +31,21 @@ class Photo extends BaseModule { $a = self::getApp(); if ($a->argc <= 1 || $a->argc > 4) { - throw new BadRequestException(); - killme(); + System::httpExit(400, "Bad Request"); } - if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) { - header('HTTP/1.1 304 Not Modified'); + 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"); - if (!empty($_SERVER['HTTP_IF_NONE_MATCH'])) { - header('Etag: ' . $_SERVER['HTTP_IF_NONE_MATCH']); + if (!empty($_SERVER["HTTP_IF_NONE_MATCH"])) { + 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'); + if (function_exists("header_remove")) { + header_remove("Last-Modified"); + header_remove("Expires"); + header_remove("Cache-Control"); } exit; } @@ -64,7 +64,7 @@ class Photo extends BaseModule case 2: $photoid = self::stripExtension($a->argv[1]); $scale = 0; - if (substr($photoid, -2, 1) == '-') { + if (substr($photoid, -2, 1) == "-") { $scale = intval(substr($photoid, -1, 1)); $photoid = substr($photoid, 0, -2); } @@ -73,6 +73,7 @@ class Photo extends BaseModule } if ($photo===false) { + // not using System::httpExit() because we don't want html here. header($_SERVER["SERVER_PROTOCOL"] . " 404 Not Found" , true, 404); killme(); } @@ -82,8 +83,8 @@ class Photo extends BaseModule $img = MPhoto::getImageForPhoto($photo); if (is_null($img) || !$img->isValid()) { - Logger::log("Invalid photo with id {$photo['id']}."); - throw new InternalServerErrorException(); + Logger::log("Invalid photo with id {$photo["id"]}."); + System::httpExit(500, "Internal Server Error"); } @@ -93,9 +94,9 @@ class Photo extends BaseModule } - if (function_exists('header_remove')) { - header_remove('Pragma'); - header_remove('pragma'); + if (function_exists("header_remove")) { + header_remove("Pragma"); + header_remove("pragma"); } header("Content-type: " . $img->getType()); @@ -106,14 +107,14 @@ class Photo extends BaseModule // and subsequently have permission to see it header("Cache-Control: no-store, no-cache, must-revalidate"); } else { + $md5 = md5($img->asString()); header("Last-Modified: " . gmdate("D, d M Y H:i:s", time()) . " GMT"); - header('Etag: "' . md5($img->asString()) . '"'); + header("Etag: \"{$md5}\""); header("Expires: " . gmdate("D, d M Y H:i:s", time() + (31536000)) . " GMT"); header("Cache-Control: max-age=31536000"); } - echo $img->asString(); @@ -124,7 +125,7 @@ class Photo extends BaseModule { $name = str_replace([".jpg", ".png", ".gif"], ["", "", ""], $name); foreach (Image::supportedTypes() AS $m => $e) { - $name = str_replace('.' . $e, '', $name); + $name = str_replace("." . $e, "", $name); } return $name; } @@ -155,4 +156,4 @@ class Photo extends BaseModule return $photo; } -} \ No newline at end of file +}