<?php
-
/**
- * @file src/Core/Theme.php
+ * @copyright Copyright (C) 2010-2022, 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\BaseObject;
+use Friendica\DI;
use Friendica\Model\Profile;
use Friendica\Util\Strings;
-require_once 'boot.php';
-
/**
* Some functions to handle themes
*/
class Theme
{
- public static function getAllowedList()
+ public static function getAllowedList(): array
{
- $allowed_themes_str = Config::get('system', 'allowed_themes');
+ $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)) {
}
}
- return $allowed_themes;
+ return array_unique($allowed_themes);
}
public static function setAllowedList(array $allowed_themes)
{
- Config::set('system', 'allowed_themes', implode(',', $allowed_themes));
+ DI::config()->set('system', 'allowed_themes', implode(',', array_unique($allowed_themes)));
}
/**
- * @brief Parse theme comment in search of theme infos.
+ * Parse theme comment in search of theme infos.
*
* like
* \code
* @param string $theme the name of the theme
* @return array
*/
- public static function getInfo($theme)
+ public static function getInfo(string $theme): array
{
$theme = Strings::sanitizeFilePathItem($theme);
return $info;
}
- $a = \get_app();
- $stamp1 = microtime(true);
+ DI::profiler()->startRecording('file');
$theme_file = file_get_contents("view/theme/$theme/theme.php");
- $a->getProfiler()->saveTimestamp($stamp1, "file", System::callstack());
+ DI::profiler()->stopRecording();
$result = preg_match("|/\*.*\*/|msU", $theme_file, $matches);
$comment_lines = explode("\n", $matches[0]);
foreach ($comment_lines as $comment_line) {
$comment_line = trim($comment_line, "\t\n\r */");
- if ($comment_line != "") {
+ if (strpos($comment_line, ':') !== false) {
list($key, $value) = array_map("trim", explode(":", $comment_line, 2));
$key = strtolower($key);
if ($key == "author") {
}
/**
- * @brief Returns the theme's screenshot.
+ * Returns the theme's screenshot.
*
* The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].
*
* @return string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function getScreenshot($theme)
+ 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 System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext;
+ return DI::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext;
}
}
- return System::baseUrl() . '/images/blank.png';
+ return DI::baseUrl() . '/images/blank.png';
}
- public static function uninstall($theme)
+ /**
+ * 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);
if (function_exists($func)) {
$func();
}
+
+ Hook::delete(['file' => "view/theme/$theme/theme.php"]);
}
$allowed_themes = Theme::getAllowedList();
if ($key !== false) {
unset($allowed_themes[$key]);
Theme::setAllowedList($allowed_themes);
+ return true;
}
+ return false;
}
- public static function install($theme)
+ /**
+ * 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);
}
/**
- * @brief Get the full path to relevant theme files by filename
+ * 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.
+ * 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
- * @param string $root Full root path
* @return string Path to the file or empty string if the file isn't found
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \Exception
*/
- public static function getPathForFile($file, $root = '')
+ public static function getPathForFile(string $file): string
{
- $file = basename($file);
+ $a = DI::app();
+
+ $theme = $a->getCurrentTheme();
+
+ $parent = Strings::sanitizeFilePathItem($a->getThemeInfoValue('extends', $theme));
- // 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 = \get_app()->getCurrentTheme();
- $parent = Strings::sanitizeFilePathItem($parent);
- $ext = substr($file, strrpos($file, '.') + 1);
$paths = [
- "{$root}view/theme/$theme/$ext/$file",
- "{$root}view/theme/$parent/$ext/$file",
- "{$root}view/$ext/$file",
+ "view/theme/$theme/$file",
+ "view/theme/$parent/$file",
+ "view/$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;
+
+ foreach ($paths as $path) {
+ if (file_exists($path)) {
+ return $path;
}
}
+
return '';
}
/**
- * @brief Return relative path to theme stylesheet file
+ * 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($theme)
+ public static function getStylesheetPath(string $theme): string
{
$theme = Strings::sanitizeFilePathItem($theme);
return 'view/theme/' . $theme . '/style.css';
}
- $a = BaseObject::getApp();
+ $a = DI::app();
$query_params = [];
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;
+ }
}
projects / friendica.git / blobdiff