337 lines
8.5 KiB
PHP
337 lines
8.5 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2021, 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;
|
|
|
|
require_once 'boot.php';
|
|
|
|
/**
|
|
* Some functions to handle themes
|
|
*/
|
|
class Theme
|
|
{
|
|
public static function getAllowedList()
|
|
{
|
|
$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($theme)
|
|
{
|
|
$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($theme)
|
|
{
|
|
$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';
|
|
}
|
|
|
|
public static function uninstall($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);
|
|
}
|
|
}
|
|
|
|
public static function install($theme)
|
|
{
|
|
$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($file)
|
|
{
|
|
$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($theme)
|
|
{
|
|
$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 $theme
|
|
* @return string|null
|
|
*/
|
|
public static function getConfigFile($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
|
|
* @param int|null $uid Current logged-in user id
|
|
* @return string|null
|
|
*/
|
|
public static function getBackgroundColor(string $theme, $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;
|
|
}
|
|
}
|