4 * @file src/Core/Theme.php
7 namespace Friendica\Core;
9 use Friendica\Core\Logger;
10 use Friendica\Core\System;
13 * Some functions to handle themes
18 * @brief Parse theme comment in search of theme infos.
23 * * Description: My Cool Theme
25 * * Author: John <profile url>
26 * * Maintainer: Jane <profile url>
29 * @param string $theme the name of the theme
32 public static function getInfo($theme)
41 'experimental' => file_exists("view/theme/$theme/experimental"),
42 'unsupported' => file_exists("view/theme/$theme/unsupported")
45 if (!is_file("view/theme/$theme/theme.php")) {
50 $stamp1 = microtime(true);
51 $theme_file = file_get_contents("view/theme/$theme/theme.php");
52 $a->saveTimestamp($stamp1, "file");
54 $result = preg_match("|/\*.*\*/|msU", $theme_file, $matches);
57 $comment_lines = explode("\n", $matches[0]);
58 foreach ($comment_lines as $comment_line) {
59 $comment_line = trim($comment_line, "\t\n\r */");
60 if ($comment_line != "") {
61 list($key, $value) = array_map("trim", explode(":", $comment_line, 2));
62 $key = strtolower($key);
63 if ($key == "author") {
64 $result = preg_match("|([^<]+)<([^>]+)>|", $value, $matches);
66 $info['author'][] = ['name' => $matches[1], 'link' => $matches[2]];
68 $info['author'][] = ['name' => $value];
70 } elseif ($key == "maintainer") {
71 $result = preg_match("|([^<]+)<([^>]+)>|", $value, $matches);
73 $info['maintainer'][] = ['name' => $matches[1], 'link' => $matches[2]];
75 $info['maintainer'][] = ['name' => $value];
77 } elseif (array_key_exists($key, $info)) {
87 * @brief Returns the theme's screenshot.
89 * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].
91 * @param sring $theme The name of the theme
94 public static function getScreenshot($theme)
96 $exts = ['.png', '.jpg'];
97 foreach ($exts as $ext) {
98 if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {
99 return(System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext);
102 return(System::baseUrl() . '/images/blank.png');
105 // install and uninstall theme
106 public static function uninstall($theme)
108 Logger::log("Addons: uninstalling theme " . $theme);
110 include_once "view/theme/$theme/theme.php";
111 if (function_exists("{$theme}_uninstall")) {
112 $func = "{$theme}_uninstall";
117 public static function install($theme)
119 // silently fail if theme was removed
121 if (!file_exists("view/theme/$theme/theme.php")) {
125 Logger::log("Addons: installing theme $theme");
127 include_once "view/theme/$theme/theme.php";
129 if (function_exists("{$theme}_install")) {
130 $func = "{$theme}_install";
134 Logger::log("Addons: FAILED installing theme $theme");
140 * @brief Get the full path to relevant theme files by filename
142 * This function search in the theme directory (and if not present in global theme directory)
143 * if there is a directory with the file extension and for a file with the given
146 * @param string $file Filename
147 * @param string $root Full root path
148 * @return string Path to the file or empty string if the file isn't found
150 public static function getPathForFile($file, $root = '')
152 $file = basename($file);
154 // Make sure $root ends with a slash / if it's not blank
155 if ($root !== '' && $root[strlen($root) - 1] !== '/') {
158 $theme_info = get_app()->theme_info;
159 if (is_array($theme_info) && array_key_exists('extends', $theme_info)) {
160 $parent = $theme_info['extends'];
164 $theme = get_app()->getCurrentTheme();
166 $ext = substr($file, strrpos($file, '.') + 1);
168 "{$root}view/theme/$thname/$ext/$file",
169 "{$root}view/theme/$parent/$ext/$file",
170 "{$root}view/$ext/$file",
172 foreach ($paths as $p) {
173 // strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php)
174 if (strpos($p, 'NOPATH') !== false) {
176 } elseif (file_exists($p)) {
184 * @brief Return relative path to theme stylesheet file
186 * Provide a sane default if nothing is chosen or the specified theme does not exist.
188 * @param string $theme Theme name
192 public static function getStylesheetPath($theme)
196 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
197 if (file_exists('view/theme/' . $theme . '/style.php')) {
198 return 'view/theme/' . $theme . '/style.pcss' . $opts;
201 return 'view/theme/' . $theme . '/style.css';