src/Core/Theme.php

   1 <?php
   2
   3 /**
   4  * @file src/Core/Theme.php
   5  */
   6
   7 namespace Friendica\Core;
   8
   9 use Friendica\Core\Logger;
  10 use Friendica\Core\System;
  11
  12 require_once 'boot.php';
  13
  14 /**
  15  * Some functions to handle themes
  16  */
  17 class Theme
  18 {
  19         /**
  20          * @brief Parse theme comment in search of theme infos.
  21          *
  22          * like
  23          * \code
  24          * ..* Name: My Theme
  25          *   * Description: My Cool Theme
  26          * . * Version: 1.2.3
  27          *   * Author: John <profile url>
  28          *   * Maintainer: Jane <profile url>
  29          *   *
  30          * \endcode
  31          * @param string $theme the name of the theme
  32          * @return array
  33          */
  34         public static function getInfo($theme)
  35         {
  36                 $info = [
  37                         'name' => $theme,
  38                         'description' => "",
  39                         'author' => [],
  40                         'maintainer' => [],
  41                         'version' => "",
  42                         'credits' => "",
  43                         'experimental' => file_exists("view/theme/$theme/experimental"),
  44                         'unsupported' => file_exists("view/theme/$theme/unsupported")
  45                 ];
  46
  47                 if (!is_file("view/theme/$theme/theme.php")) {
  48                         return $info;
  49                 }
  50
  51                 $a = get_app();
  52                 $stamp1 = microtime(true);
  53                 $theme_file = file_get_contents("view/theme/$theme/theme.php");
  54                 $a->saveTimestamp($stamp1, "file");
  55
  56                 $result = preg_match("|/\*.*\*/|msU", $theme_file, $matches);
  57
  58                 if ($result) {
  59                         $comment_lines = explode("\n", $matches[0]);
  60                         foreach ($comment_lines as $comment_line) {
  61                                 $comment_line = trim($comment_line, "\t\n\r */");
  62                                 if ($comment_line != "") {
  63                                         list($key, $value) = array_map("trim", explode(":", $comment_line, 2));
  64                                         $key = strtolower($key);
  65                                         if ($key == "author") {
  66                                                 $result = preg_match("|([^<]+)<([^>]+)>|", $value, $matches);
  67                                                 if ($result) {
  68                                                         $info['author'][] = ['name' => $matches[1], 'link' => $matches[2]];
  69                                                 } else {
  70                                                         $info['author'][] = ['name' => $value];
  71                                                 }
  72                                         } elseif ($key == "maintainer") {
  73                                                 $result = preg_match("|([^<]+)<([^>]+)>|", $value, $matches);
  74                                                 if ($result) {
  75                                                         $info['maintainer'][] = ['name' => $matches[1], 'link' => $matches[2]];
  76                                                 } else {
  77                                                         $info['maintainer'][] = ['name' => $value];
  78                                                 }
  79                                         } elseif (array_key_exists($key, $info)) {
  80                                                 $info[$key] = $value;
  81                                         }
  82                                 }
  83                         }
  84                 }
  85                 return $info;
  86         }
  87
  88         /**
  89          * @brief Returns the theme's screenshot.
  90          *
  91          * The screenshot is expected as view/theme/$theme/screenshot.[png|jpg].
  92          *
  93          * @param sring $theme The name of the theme
  94          * @return string
  95          */
  96         public static function getScreenshot($theme)
  97         {
  98                 $exts = ['.png', '.jpg'];
  99                 foreach ($exts as $ext) {
 100                         if (file_exists('view/theme/' . $theme . '/screenshot' . $ext)) {
 101                                 return(System::baseUrl() . '/view/theme/' . $theme . '/screenshot' . $ext);
 102                         }
 103                 }
 104                 return(System::baseUrl() . '/images/blank.png');
 105         }
 106
 107         // install and uninstall theme
 108         public static function uninstall($theme)
 109         {
 110                 Logger::log("Addons: uninstalling theme " . $theme);
 111
 112                 include_once "view/theme/$theme/theme.php";
 113                 if (function_exists("{$theme}_uninstall")) {
 114                         $func = "{$theme}_uninstall";
 115                         $func();
 116                 }
 117         }
 118
 119         public static function install($theme)
 120         {
 121                 // silently fail if theme was removed
 122
 123                 if (!file_exists("view/theme/$theme/theme.php")) {
 124                         return false;
 125                 }
 126
 127                 Logger::log("Addons: installing theme $theme");
 128
 129                 include_once "view/theme/$theme/theme.php";
 130
 131                 if (function_exists("{$theme}_install")) {
 132                         $func = "{$theme}_install";
 133                         $func();
 134                         return true;
 135                 } else {
 136                         Logger::log("Addons: FAILED installing theme $theme");
 137                         return false;
 138                 }
 139         }
 140
 141         /**
 142          * @brief Get the full path to relevant theme files by filename
 143          *
 144          * This function search in the theme directory (and if not present in global theme directory)
 145          * if there is a directory with the file extension and  for a file with the given
 146          * filename.
 147          *
 148          * @param string $file Filename
 149          * @param string $root Full root path
 150          * @return string Path to the file or empty string if the file isn't found
 151          */
 152         public static function getPathForFile($file, $root = '')
 153         {
 154                 $file = basename($file);
 155
 156                 // Make sure $root ends with a slash / if it's not blank
 157                 if ($root !== '' && $root[strlen($root) - 1] !== '/') {
 158                         $root = $root . '/';
 159                 }
 160                 $theme_info = get_app()->theme_info;
 161                 if (is_array($theme_info) && array_key_exists('extends', $theme_info)) {
 162                         $parent = $theme_info['extends'];
 163                 } else {
 164                         $parent = 'NOPATH';
 165                 }
 166                 $theme = get_app()->getCurrentTheme();
 167                 $thname = $theme;
 168                 $ext = substr($file, strrpos($file, '.') + 1);
 169                 $paths = [
 170                         "{$root}view/theme/$thname/$ext/$file",
 171                         "{$root}view/theme/$parent/$ext/$file",
 172                         "{$root}view/$ext/$file",
 173                 ];
 174                 foreach ($paths as $p) {
 175                         // strpos() is faster than strstr when checking if one string is in another (http://php.net/manual/en/function.strstr.php)
 176                         if (strpos($p, 'NOPATH') !== false) {
 177                                 continue;
 178                         } elseif (file_exists($p)) {
 179                                 return $p;
 180                         }
 181                 }
 182                 return '';
 183         }
 184
 185         /**
 186          * @brief Return relative path to theme stylesheet file
 187          *
 188          * Provide a sane default if nothing is chosen or the specified theme does not exist.
 189          *
 190          * @param string $theme Theme name
 191          *
 192          * @return string
 193          */
 194         public static function getStylesheetPath($theme)
 195         {
 196                 $a = get_app();
 197
 198                 $opts = (($a->profile_uid) ? '?f=&puid=' . $a->profile_uid : '');
 199                 if (file_exists('view/theme/' . $theme . '/style.php')) {
 200                         return 'view/theme/' . $theme . '/style.pcss' . $opts;
 201                 }
 202
 203                 return 'view/theme/' . $theme . '/style.css';
 204         }
 205 }