From acbc733dce0ed4bcdbea6a0ce88da7a18e2dffa0 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sat, 28 Apr 2018 18:28:23 -0400 Subject: [PATCH] Fix formatting in Core\Theme --- src/Core/Theme.php | 312 ++++++++++++++++++++++----------------------- 1 file changed, 153 insertions(+), 159 deletions(-) diff --git a/src/Core/Theme.php b/src/Core/Theme.php index 9133eae187..16eb7939c5 100644 --- a/src/Core/Theme.php +++ b/src/Core/Theme.php @@ -1,7 +1,9 @@ - * * Maintainer: Jane - * * - * \endcode - * @param string $theme the name of the theme - * @return array - */ + /** + * @brief Parse theme comment in search of theme infos. + * + * like + * \code + * ..* Name: My Theme + * * Description: My Cool Theme + * . * Version: 1.2.3 + * * Author: John + * * Maintainer: Jane + * * + * \endcode + * @param string $theme the name of the theme + * @return array + */ + public static function getInfo($theme) + { + $info = [ + 'name' => $theme, + 'description' => "", + 'author' => [], + 'maintainer' => [], + 'version' => "", + 'credits' => "", + 'experimental' => file_exists("view/theme/$theme/experimental"), + 'unsupported' => file_exists("view/theme/$theme/unsupported") + ]; - public static function getInfo($theme) - { - $info=[ - 'name' => $theme, - 'description' => "", - 'author' => [], - 'maintainer' => [], - 'version' => "", - 'credits' => "", - 'experimental' => false, - 'unsupported' => false - ]; + if (!is_file("view/theme/$theme/theme.php")) { + return $info; + } - if (file_exists("view/theme/$theme/experimental")) - $info['experimental'] = true; - if (file_exists("view/theme/$theme/unsupported")) - $info['unsupported'] = true; + $a = get_app(); + $stamp1 = microtime(true); + $theme_file = file_get_contents("view/theme/$theme/theme.php"); + $a->save_timestamp($stamp1, "file"); - if (!is_file("view/theme/$theme/theme.php")) return $info; + $result = preg_match("|/\*.*\*/|msU", $theme_file, $matches); - $a = get_app(); - $stamp1 = microtime(true); - $f = file_get_contents("view/theme/$theme/theme.php"); - $a->save_timestamp($stamp1, "file"); + if ($result) { + $comment_lines = explode("\n", $matches[0]); + foreach ($comment_lines as $comment_line) { + $comment_line = trim($comment_line, "\t\n\r */"); + if ($comment_line != "") { + list($key, $value) = array_map("trim", explode(":", $comment_line, 2)); + $key = strtolower($key); + if ($key == "author") { + $result = preg_match("|([^<]+)<([^>]+)>|", $value, $matches); + if ($result) { + $info['author'][] = ['name' => $matches[1], 'link' => $matches[2]]; + } else { + $info['author'][] = ['name' => $value]; + } + } elseif ($key == "maintainer") { + $result = preg_match("|([^<]+)<([^>]+)>|", $value, $matches); + if ($result) { + $info['maintainer'][] = ['name' => $matches[1], 'link' => $matches[2]]; + } else { + $info['maintainer'][] = ['name' => $value]; + } + } elseif (array_key_exists($key, $info)) { + $info[$key] = $value; + } + } + } + } + return $info; + } - $r = preg_match("|/\*.*\*/|msU", $f, $m); + /** + * @brief Returns the theme's screenshot. + * + * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg]. + * + * @param sring $theme The name of the theme + * @return string + */ + public static function getScreenshot($theme) + { + $exts = ['.png', '.jpg']; + foreach ($exts as $ext) { + if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) { + return(System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext); + } + } + return(System::baseUrl() . '/images/blank.png'); + } - if ($r) { - $ll = explode("\n", $m[0]); - foreach ( $ll as $l ) { - $l = trim($l,"\t\n\r */"); - if ($l != "") { - list($k, $v) = array_map("trim", explode(":", $l, 2)); - $k= strtolower($k); - if ($k == "author") { + // install and uninstall theme + public static function uninstall($theme) + { + logger("Addons: uninstalling theme " . $theme); - $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m); - if ($r) { - $info['author'][] = ['name'=>$m[1], 'link'=>$m[2]]; - } else { - $info['author'][] = ['name'=>$v]; - } - } elseif ($k == "maintainer") { - $r=preg_match("|([^<]+)<([^>]+)>|", $v, $m); - if ($r) { - $info['maintainer'][] = ['name'=>$m[1], 'link'=>$m[2]]; - } else { - $info['maintainer'][] = ['name'=>$v]; - } - } else { - if (array_key_exists($k, $info)) { - $info[$k] = $v; - } - } - } - } - } - return $info; - } + include_once "view/theme/$theme/theme.php"; + if (function_exists("{$theme}_uninstall")) { + $func = "{$theme}_uninstall"; + $func(); + } + } - /** - * @brief Returns the theme's screenshot. - * - * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg]. - * - * @param sring $theme The name of the theme - * @return string - */ - public static function getScreenshot($theme) - { - $exts = ['.png','.jpg']; - foreach ($exts as $ext) { - if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) { - return(System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext); - } - } - return(System::baseUrl() . '/images/blank.png'); - } + public static function install($theme) + { + // silently fail if theme was removed - // install and uninstall theme - public static function uninstall($theme) - { - logger("Addons: uninstalling theme " . $theme); + if (!file_exists("view/theme/$theme/theme.php")) { + return false; + } - include_once("view/theme/$theme/theme.php"); - if (function_exists("{$theme}_uninstall")) { - $func = "{$theme}_uninstall"; - $func(); - } - } + logger("Addons: installing theme $theme"); - public static function install($theme) - { - // silently fail if theme was removed + include_once "view/theme/$theme/theme.php"; - if (! file_exists("view/theme/$theme/theme.php")) { - return false; - } + if (function_exists("{$theme}_install")) { + $func = "{$theme}_install"; + $func(); + return true; + } else { + logger("Addons: FAILED installing theme $theme"); + return false; + } + } - logger("Addons: installing theme $theme"); + /** + * @brief Get the full path to relevant theme files by filename + * + * This function search in the theme directory (and if not present in global theme directory) + * if there is a directory with the file extension and for a file with the given + * filename. + * + * @param string $file Filename + * @param string $root Full root path + * @return string Path to the file or empty string if the file isn't found + */ + public static function getPathForFile($file, $root = '') + { + $file = basename($file); - include_once("view/theme/$theme/theme.php"); - - if (function_exists("{$theme}_install")) { - $func = "{$theme}_install"; - $func(); - return true; - } else { - logger("Addons: FAILED installing theme $theme"); - return false; - } - - } - - /** - * @brief Get the full path to relevant theme files by filename - * - * This function search in the theme directory (and if not present in global theme directory) - * if there is a directory with the file extension and for a file with the given - * filename. - * - * @param string $file Filename - * @param string $root Full root path - * @return string Path to the file or empty string if the file isn't found - */ - public static function getPathForFile($file, $root = '') - { - $file = basename($file); - - // Make sure $root ends with a slash / if it's not blank - if ($root !== '' && $root[strlen($root)-1] !== '/') { - $root = $root . '/'; - } - $theme_info = get_app()->theme_info; - if (is_array($theme_info) && array_key_exists('extends',$theme_info)) { - $parent = $theme_info['extends']; - } else { - $parent = 'NOPATH'; - } - $theme = current_theme(); - $thname = $theme; - $ext = substr($file,strrpos($file,'.')+1); - $paths = [ - "{$root}view/theme/$thname/$ext/$file", - "{$root}view/theme/$parent/$ext/$file", - "{$root}view/$ext/$file", - ]; - foreach ($paths as $p) { - // strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php) - if (strpos($p,'NOPATH') !== false) { - continue; - } elseif (file_exists($p)) { - return $p; - } - } - return ''; - } + // Make sure $root ends with a slash / if it's not blank + if ($root !== '' && $root[strlen($root) - 1] !== '/') { + $root = $root . '/'; + } + $theme_info = get_app()->theme_info; + if (is_array($theme_info) && array_key_exists('extends', $theme_info)) { + $parent = $theme_info['extends']; + } else { + $parent = 'NOPATH'; + } + $theme = current_theme(); + $thname = $theme; + $ext = substr($file, strrpos($file, '.') + 1); + $paths = [ + "{$root}view/theme/$thname/$ext/$file", + "{$root}view/theme/$parent/$ext/$file", + "{$root}view/$ext/$file", + ]; + foreach ($paths as $p) { + // strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php) + if (strpos($p, 'NOPATH') !== false) { + continue; + } elseif (file_exists($p)) { + return $p; + } + } + return ''; + } }