lib/theme.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Utilities for theme files and paths
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Paths
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008-2009 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * Class for querying and manipulating a theme
  37  *
  38  * Themes are directories with some expected sub-directories and files
  39  * in them. They're found in either local/theme (for locally-installed themes)
  40  * or theme/ subdir of installation dir.
  41  *
  42  * Note that the 'local' directory can be overridden as $config['local']['path']
  43  * and $config['local']['dir'] etc.
  44  *
  45  * This used to be a couple of functions, but for various reasons it's nice
  46  * to have a class instead.
  47  *
  48  * @category Output
  49  * @package  StatusNet
  50  * @author   Evan Prodromou <evan@status.net>
  51  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  52  * @link     http://status.net/
  53  */
  54
  55 class Theme
  56 {
  57     var $name = null;
  58     var $dir  = null;
  59     var $path = null;
  60
  61     /**
  62      * Constructor
  63      *
  64      * Determines the proper directory and path for this theme.
  65      *
  66      * @param string $name Name of the theme; defaults to config value
  67      */
  68
  69     function __construct($name=null)
  70     {
  71         if (empty($name)) {
  72             $name = common_config('site', 'theme');
  73         }
  74         if (!self::validName($name)) {
  75             throw new ServerException("Invalid theme name.");
  76         }
  77         $this->name = $name;
  78
  79         // Check to see if it's in the local dir
  80
  81         $localroot = self::localRoot();
  82
  83         $fulldir = $localroot.'/'.$name;
  84
  85         if (file_exists($fulldir) && is_dir($fulldir)) {
  86             $this->dir  = $fulldir;
  87             $this->path = $this->relativeThemePath('local', 'local', 'theme/' . $name);
  88             return;
  89         }
  90
  91         // Check to see if it's in the distribution dir
  92
  93         $instroot = self::installRoot();
  94
  95         $fulldir = $instroot.'/'.$name;
  96
  97         if (file_exists($fulldir) && is_dir($fulldir)) {
  98
  99             $this->dir = $fulldir;
 100             $this->path = $this->relativeThemePath('theme', 'theme', $name);
 101         }
 102     }
 103
 104     /**
 105      * Build a full URL to the given theme's base directory, possibly
 106      * using an offsite theme server path.
 107      *
 108      * @param string $group configuration section name to pull paths from
 109      * @param string $fallbackSubdir default subdirectory under INSTALLDIR
 110      * @param string $name theme name
 111      *
 112      * @return string URL
 113      *
 114      * @todo consolidate code with that for other customizable paths
 115      */
 116
 117     protected function relativeThemePath($group, $fallbackSubdir, $name)
 118     {
 119         if (StatusNet::isHTTPS()) {
 120
 121             $sslserver = common_config($group, 'sslserver');
 122
 123             if (empty($sslserver)) {
 124                 $server = common_config('site', 'server');
 125                 $path   = common_config('site', 'path') . '/';
 126                 if ($fallbackSubdir) {
 127                     $path .= $fallbackSubdir . '/';
 128                 }
 129             } else {
 130                 $server = $sslserver;
 131                 $path   = common_config($group, 'sslpath');
 132                 if (empty($path)) {
 133                     $path = common_config($group, 'path');
 134                 }
 135             }
 136
 137             $protocol = 'https';
 138
 139         } else {
 140
 141             $path = common_config($group, 'path');
 142
 143             if (empty($path)) {
 144                 $path = common_config('site', 'path') . '/';
 145                 if ($fallbackSubdir) {
 146                     $path .= $fallbackSubdir . '/';
 147                 }
 148             }
 149
 150             $server = common_config($group, 'server');
 151
 152             if (empty($server)) {
 153                 $server = common_config('site', 'server');
 154             }
 155
 156             $protocol = 'http';
 157         }
 158
 159         if ($path[strlen($path)-1] != '/') {
 160             $path .= '/';
 161         }
 162
 163         if ($path[0] != '/') {
 164             $path = '/'.$path;
 165         }
 166
 167         return $protocol.'://'.$server.$path.$name;
 168     }
 169
 170     /**
 171      * Gets the full local filename of a file in this theme.
 172      *
 173      * @param string $relative relative name, like 'logo.png'
 174      *
 175      * @return string full pathname, like /var/www/mublog/theme/default/logo.png
 176      */
 177
 178     function getFile($relative)
 179     {
 180         return $this->dir.'/'.$relative;
 181     }
 182
 183     /**
 184      * Gets the full HTTP url of a file in this theme
 185      *
 186      * @param string $relative relative name, like 'logo.png'
 187      *
 188      * @return string full URL, like 'http://example.com/theme/default/logo.png'
 189      */
 190
 191     function getPath($relative)
 192     {
 193         return $this->path.'/'.$relative;
 194     }
 195
 196     /**
 197      * Fetch a list of other themes whose CSS needs to be pulled in before
 198      * this theme's, based on following the theme.ini 'include' settings.
 199      * (May be empty if this theme has no include dependencies.)
 200      *
 201      * @return array of strings with theme names
 202      */
 203     function getDeps()
 204     {
 205         $chain = $this->doGetDeps(array($this->name));
 206         array_pop($chain); // Drop us back off
 207         return $chain;
 208     }
 209
 210     protected function doGetDeps($chain)
 211     {
 212         $data = $this->getMetadata();
 213         if (!empty($data['include'])) {
 214             $include = $data['include'];
 215
 216             // Protect against cycles!
 217             if (!in_array($include, $chain)) {
 218                 try {
 219                     $theme = new Theme($include);
 220                     array_unshift($chain, $include);
 221                     return $theme->doGetDeps($chain);
 222                 } catch (Exception $e) {
 223                     common_log(LOG_ERR,
 224                             "Exception while fetching theme dependencies " .
 225                             "for $this->name: " . $e->getMessage());
 226                 }
 227             }
 228         }
 229         return $chain;
 230     }
 231
 232     /**
 233      * Pull data from the theme's theme.ini file.
 234      * @fixme calling getFile will fall back to default theme, this may be unsafe.
 235      *
 236      * @return associative array of strings
 237      */
 238     function getMetadata()
 239     {
 240         $iniFile = $this->getFile('theme.ini');
 241         if (file_exists($iniFile)) {
 242             return parse_ini_file($iniFile);
 243         } else {
 244             return array();
 245         }
 246     }
 247
 248     /**
 249      * Gets the full path of a file in a theme dir based on its relative name
 250      *
 251      * @param string $relative relative path within the theme directory
 252      * @param string $name     name of the theme; defaults to current theme
 253      *
 254      * @return string File path to the theme file
 255      */
 256
 257     static function file($relative, $name=null)
 258     {
 259         $theme = new Theme($name);
 260         return $theme->getFile($relative);
 261     }
 262
 263     /**
 264      * Gets the full URL of a file in a theme dir based on its relative name
 265      *
 266      * @param string $relative relative path within the theme directory
 267      * @param string $name     name of the theme; defaults to current theme
 268      *
 269      * @return string URL of the file
 270      */
 271
 272     static function path($relative, $name=null)
 273     {
 274         $theme = new Theme($name);
 275         return $theme->getPath($relative);
 276     }
 277
 278     /**
 279      * list available theme names
 280      *
 281      * @return array list of available theme names
 282      */
 283
 284     static function listAvailable()
 285     {
 286         $local   = self::subdirsOf(self::localRoot());
 287         $install = self::subdirsOf(self::installRoot());
 288
 289         $i = array_search('base', $install);
 290
 291         unset($install[$i]);
 292
 293         return array_merge($local, $install);
 294     }
 295
 296     /**
 297      * Utility for getting subdirs of a directory
 298      *
 299      * @param string $dir full path to directory to check
 300      *
 301      * @return array relative filenames of subdirs, or empty array
 302      */
 303
 304     protected static function subdirsOf($dir)
 305     {
 306         $subdirs = array();
 307
 308         if (is_dir($dir)) {
 309             if ($dh = opendir($dir)) {
 310                 while (($filename = readdir($dh)) !== false) {
 311                     if ($filename != '..' && $filename !== '.' &&
 312                         is_dir($dir.'/'.$filename)) {
 313                         $subdirs[] = $filename;
 314                     }
 315                 }
 316                 closedir($dh);
 317             }
 318         }
 319
 320         return $subdirs;
 321     }
 322
 323     /**
 324      * Local root dir for themes
 325      *
 326      * @return string local root dir for themes
 327      */
 328
 329     protected static function localRoot()
 330     {
 331         $basedir = common_config('local', 'dir');
 332
 333         if (empty($basedir)) {
 334             $basedir = INSTALLDIR . '/local';
 335         }
 336
 337         return $basedir . '/theme';
 338     }
 339
 340     /**
 341      * Root dir for themes that are shipped with StatusNet
 342      *
 343      * @return string root dir for StatusNet themes
 344      */
 345
 346     protected static function installRoot()
 347     {
 348         $instroot = common_config('theme', 'dir');
 349
 350         if (empty($instroot)) {
 351             $instroot = INSTALLDIR.'/theme';
 352         }
 353
 354         return $instroot;
 355     }
 356
 357     static function validName($name)
 358     {
 359         return preg_match('/^[a-z0-9][a-z0-9_-]*$/i', $name);
 360     }
 361 }