X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FTheme.php;h=2f78dad4b5ec1b47f02ad26193a424dec042f78c;hb=5704a433f00887b35fe866af6b161b096b27f9d9;hp=9e7c6329822d70e8da7908edc368c46da20371c1;hpb=d07536e03298f8f9b2b62c7f18d4c835bb2b1f0b;p=friendica.git

diff --git a/src/Core/Theme.php b/src/Core/Theme.php
index 9e7c632982..2f78dad4b5 100644
--- a/src/Core/Theme.php
+++ b/src/Core/Theme.php
@@ -1,189 +1,347 @@
-<?php
-/**
- * @file src/Core/Theme.php
- */
-namespace Friendica\Core;
-
-use Friendica\Core\System;
-
-require_once 'boot.php';
-
-/**
- * Some functions to handle themes
- */
-class Theme
-{
-    /**
-     * @brief Parse theme comment in search of theme infos.
-     *
-     * like
-     * \code
-     * ..* Name: My Theme
-     *   * Description: My Cool Theme
-     * . * Version: 1.2.3
-     *   * Author: John <profile url>
-     *   * Maintainer: Jane <profile url>
-     *   *
-     * \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' => false,
-            'unsupported' => false
-        ];
-
-        if (file_exists("view/theme/$theme/experimental"))
-            $info['experimental'] = true;
-        if (file_exists("view/theme/$theme/unsupported"))
-            $info['unsupported'] = true;
-
-        if (!is_file("view/theme/$theme/theme.php")) return $info;
-
-        $a = get_app();
-        $stamp1 = microtime(true);
-        $f = file_get_contents("view/theme/$theme/theme.php");
-        $a->save_timestamp($stamp1, "file");
-
-        $r = preg_match("|/\*.*\*/|msU", $f, $m);
-
-        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") {
-
-                        $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;
-    }
-
-    /**
-     * @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');
-    }
-
-    // install and uninstall theme
-    public static function uninstall($theme)
-    {
-        logger("Addons: uninstalling theme " . $theme);
-
-        include_once("view/theme/$theme/theme.php");
-        if (function_exists("{$theme}_uninstall")) {
-            $func = "{$theme}_uninstall";
-            $func();
-        }
-    }
-
-    public static function install($theme)
-    {
-        // silently fail if theme was removed
-
-        if (! file_exists("view/theme/$theme/theme.php")) {
-            return false;
-        }
-
-        logger("Addons: installing theme $theme");
-
-        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 '';
-    }
-}
+<?php
+/**
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Core;
+
+use Friendica\DI;
+use Friendica\Model\Profile;
+use Friendica\Util\Strings;
+
+/**
+ * Some functions to handle themes
+ */
+class Theme
+{
+	public static function getAllowedList(): array
+	{
+		$allowed_themes_str = DI::config()->get('system', 'allowed_themes');
+		$allowed_themes_raw = explode(',', str_replace(' ', '', $allowed_themes_str));
+		$allowed_themes = [];
+		if (count($allowed_themes_raw)) {
+			foreach ($allowed_themes_raw as $theme) {
+				$theme = Strings::sanitizeFilePathItem(trim($theme));
+				if (strlen($theme) && is_dir("view/theme/$theme")) {
+					$allowed_themes[] = $theme;
+				}
+			}
+		}
+
+		return array_unique($allowed_themes);
+	}
+
+	public static function setAllowedList(array $allowed_themes)
+	{
+		DI::config()->set('system', 'allowed_themes', implode(',', array_unique($allowed_themes)));
+	}
+
+	/**
+	 * Parse theme comment in search of theme infos.
+	 *
+	 * like
+	 * \code
+	 * ..* Name: My Theme
+	 *   * Description: My Cool Theme
+	 * . * Version: 1.2.3
+	 *   * Author: John <profile url>
+	 *   * Maintainer: Jane <profile url>
+	 *   *
+	 * \endcode
+	 * @param string $theme the name of the theme
+	 * @return array
+	 */
+	public static function getInfo(string $theme): array
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		$info = [
+			'name' => $theme,
+			'description' => "",
+			'author' => [],
+			'maintainer' => [],
+			'version' => "",
+			'credits' => "",
+			'experimental' => file_exists("view/theme/$theme/experimental"),
+			'unsupported' => file_exists("view/theme/$theme/unsupported")
+		];
+
+		if (!is_file("view/theme/$theme/theme.php")) {
+			return $info;
+		}
+
+		DI::profiler()->startRecording('file');
+		$theme_file = file_get_contents("view/theme/$theme/theme.php");
+		DI::profiler()->stopRecording();
+
+		$result = preg_match("|/\*.*\*/|msU", $theme_file, $matches);
+
+		if ($result) {
+			$comment_lines = explode("\n", $matches[0]);
+			foreach ($comment_lines as $comment_line) {
+				$comment_line = trim($comment_line, "\t\n\r */");
+				if (strpos($comment_line, ':') !== false) {
+					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;
+	}
+
+	/**
+	 * Returns the theme's screenshot.
+	 *
+	 * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].
+	 *
+	 * @param string $theme The name of the theme
+	 * @return string
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+	 */
+	public static function getScreenshot(string $theme): string
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		$exts = ['.png', '.jpg'];
+		foreach ($exts as $ext) {
+			if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {
+				return DI::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext;
+			}
+		}
+		return DI::baseUrl() . '/images/blank.png';
+	}
+
+	/**
+	 * Uninstalls given theme name
+	 *
+	 * @param string $theme Name of theme
+	 * @return bool true on success
+	 */
+	public static function uninstall(string $theme)
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		// silently fail if theme was removed or if $theme is funky
+		if (file_exists("view/theme/$theme/theme.php")) {
+			include_once "view/theme/$theme/theme.php";
+
+			$func = "{$theme}_uninstall";
+			if (function_exists($func)) {
+				$func();
+			}
+
+			Hook::delete(['file' => "view/theme/$theme/theme.php"]);
+		}
+
+		$allowed_themes = Theme::getAllowedList();
+		$key = array_search($theme, $allowed_themes);
+		if ($key !== false) {
+			unset($allowed_themes[$key]);
+			Theme::setAllowedList($allowed_themes);
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Installs given theme name
+	 *
+	 * @param string $theme Name of theme
+	 * @return bool true on success
+	 */
+	public static function install(string $theme): bool
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		// silently fail if theme was removed or if $theme is funky
+		if (!file_exists("view/theme/$theme/theme.php")) {
+			return false;
+		}
+
+		try {
+			include_once "view/theme/$theme/theme.php";
+
+			$func = "{$theme}_install";
+			if (function_exists($func)) {
+				$func();
+			}
+
+			$allowed_themes = Theme::getAllowedList();
+			$allowed_themes[] = $theme;
+			Theme::setAllowedList($allowed_themes);
+
+			return true;
+		} catch (\Exception $e) {
+			Logger::error('Theme installation failed', ['theme' => $theme, 'error' => $e->getMessage()]);
+			return false;
+		}
+	}
+
+	/**
+	 * Get the full path to relevant theme files by filename
+	 *
+	 * This function searches in order in the current theme directory, in the current theme parent directory, and lastly
+	 * in the base view/ folder.
+	 *
+	 * @param string $file Filename
+	 * @return string Path to the file or empty string if the file isn't found
+	 * @throws \Exception
+	 */
+	public static function getPathForFile(string $file): string
+	{
+		$a = DI::app();
+
+		$theme = $a->getCurrentTheme();
+
+		$parent = Strings::sanitizeFilePathItem($a->getThemeInfoValue('extends', $theme));
+
+		$paths = [
+			"view/theme/$theme/$file",
+			"view/theme/$parent/$file",
+			"view/$file",
+		];
+
+		foreach ($paths as $path) {
+			if (file_exists($path)) {
+				return $path;
+			}
+		}
+
+		return '';
+	}
+
+	/**
+	 * Return relative path to theme stylesheet file
+	 *
+	 * Provide a sane default if nothing is chosen or the specified theme does not exist.
+	 *
+	 * @param string $theme Theme name
+	 * @return string
+	 */
+	public static function getStylesheetPath(string $theme): string
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		if (!file_exists('view/theme/' . $theme . '/style.php')) {
+			return 'view/theme/' . $theme . '/style.css';
+		}
+
+		$a = DI::app();
+
+		$query_params = [];
+
+		$puid = Profile::getThemeUid($a);
+		if ($puid) {
+			$query_params['puid'] = $puid;
+		}
+
+		return 'view/theme/' . $theme . '/style.pcss' . (!empty($query_params) ? '?' . http_build_query($query_params) : '');
+	}
+
+	/**
+	 * Returns the path of the provided theme
+	 *
+	 * @param string $theme Theme name
+	 * @return string|null
+	 */
+	public static function getConfigFile(string $theme)
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		$a = DI::app();
+		$base_theme = $a->getThemeInfoValue('extends') ?? '';
+
+		if (file_exists("view/theme/$theme/config.php")) {
+			return "view/theme/$theme/config.php";
+		}
+		if ($base_theme && file_exists("view/theme/$base_theme/config.php")) {
+			return "view/theme/$base_theme/config.php";
+		}
+		return null;
+	}
+
+	/**
+	 * Returns the background color of the provided theme if available.
+	 *
+	 * @param string   $theme Theme name
+	 * @param int|null $uid   Current logged-in user id
+	 * @return string|null
+	 */
+	public static function getBackgroundColor(string $theme, int $uid = null)
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		$return = null;
+
+		// silently fail if theme was removed or if $theme is funky
+		if (file_exists("view/theme/$theme/theme.php")) {
+			include_once "view/theme/$theme/theme.php";
+
+			$func = "{$theme}_get_background_color";
+			if (function_exists($func)) {
+				$return = $func($uid);
+			}
+		}
+
+		return $return;
+	}
+
+	/**
+	 * Returns the theme color of the provided theme if available.
+	 *
+	 * @param string   $theme
+	 * @param int|null $uid   Current logged-in user id
+	 * @return string|null
+	 */
+	public static function getThemeColor(string $theme, int $uid = null)
+	{
+		$theme = Strings::sanitizeFilePathItem($theme);
+
+		$return = null;
+
+		// silently fail if theme was removed or if $theme is funky
+		if (file_exists("view/theme/$theme/theme.php")) {
+			include_once "view/theme/$theme/theme.php";
+
+			$func = "{$theme}_get_theme_color";
+			if (function_exists($func)) {
+				$return = $func($uid);
+			}
+		}
+
+		return $return;
+	}
+}