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                 if (is_string(common_config('site', 'sslserver')) &&
 125                     mb_strlen(common_config('site', 'sslserver')) > 0) {
 126                     $server = common_config('site', 'sslserver');
 127                 } else if (common_config('site', 'server')) {
 128                     $server = common_config('site', 'server');
 129                 }
 130                 $path   = common_config('site', 'path') . '/';
 131                 if ($fallbackSubdir) {
 132                     $path .= $fallbackSubdir . '/';
 133                 }
 134             } else {
 135                 $server = $sslserver;
 136                 $path   = common_config($group, 'sslpath');
 137                 if (empty($path)) {
 138                     $path = common_config($group, 'path');
 139                 }
 140             }
 141
 142             $protocol = 'https';
 143
 144         } else {
 145
 146             $path = common_config($group, 'path');
 147
 148             if (empty($path)) {
 149                 $path = common_config('site', 'path') . '/';
 150                 if ($fallbackSubdir) {
 151                     $path .= $fallbackSubdir . '/';
 152                 }
 153             }
 154
 155             $server = common_config($group, 'server');
 156
 157             if (empty($server)) {
 158                 $server = common_config('site', 'server');
 159             }
 160
 161             $protocol = 'http';
 162         }
 163
 164         if ($path[strlen($path)-1] != '/') {
 165             $path .= '/';
 166         }
 167
 168         if ($path[0] != '/') {
 169             $path = '/'.$path;
 170         }
 171
 172         return $protocol.'://'.$server.$path.$name;
 173     }
 174
 175     /**
 176      * Gets the full local filename of a file in this theme.
 177      *
 178      * @param string $relative relative name, like 'logo.png'
 179      *
 180      * @return string full pathname, like /var/www/mublog/theme/default/logo.png
 181      */
 182
 183     function getFile($relative)
 184     {
 185         return $this->dir.'/'.$relative;
 186     }
 187
 188     /**
 189      * Gets the full HTTP url of a file in this theme
 190      *
 191      * @param string $relative relative name, like 'logo.png'
 192      *
 193      * @return string full URL, like 'http://example.com/theme/default/logo.png'
 194      */
 195
 196     function getPath($relative)
 197     {
 198         return $this->path.'/'.$relative;
 199     }
 200
 201     /**
 202      * Fetch a list of other themes whose CSS needs to be pulled in before
 203      * this theme's, based on following the theme.ini 'include' settings.
 204      * (May be empty if this theme has no include dependencies.)
 205      *
 206      * @return array of strings with theme names
 207      */
 208     function getDeps()
 209     {
 210         $chain = $this->doGetDeps(array($this->name));
 211         array_pop($chain); // Drop us back off
 212         return $chain;
 213     }
 214
 215     protected function doGetDeps($chain)
 216     {
 217         $data = $this->getMetadata();
 218         if (!empty($data['include'])) {
 219             $include = $data['include'];
 220
 221             // Protect against cycles!
 222             if (!in_array($include, $chain)) {
 223                 try {
 224                     $theme = new Theme($include);
 225                     array_unshift($chain, $include);
 226                     return $theme->doGetDeps($chain);
 227                 } catch (Exception $e) {
 228                     common_log(LOG_ERR,
 229                             "Exception while fetching theme dependencies " .
 230                             "for $this->name: " . $e->getMessage());
 231                 }
 232             }
 233         }
 234         return $chain;
 235     }
 236
 237     /**
 238      * Pull data from the theme's theme.ini file.
 239      * @fixme calling getFile will fall back to default theme, this may be unsafe.
 240      *
 241      * @return associative array of strings
 242      */
 243     function getMetadata()
 244     {
 245         $iniFile = $this->getFile('theme.ini');
 246         if (file_exists($iniFile)) {
 247             return parse_ini_file($iniFile);
 248         } else {
 249             return array();
 250         }
 251     }
 252
 253     /**
 254      * Gets the full path of a file in a theme dir based on its relative name
 255      *
 256      * @param string $relative relative path within the theme directory
 257      * @param string $name     name of the theme; defaults to current theme
 258      *
 259      * @return string File path to the theme file
 260      */
 261
 262     static function file($relative, $name=null)
 263     {
 264         $theme = new Theme($name);
 265         return $theme->getFile($relative);
 266     }
 267
 268     /**
 269      * Gets the full URL of a file in a theme dir based on its relative name
 270      *
 271      * @param string $relative relative path within the theme directory
 272      * @param string $name     name of the theme; defaults to current theme
 273      *
 274      * @return string URL of the file
 275      */
 276
 277     static function path($relative, $name=null)
 278     {
 279         $theme = new Theme($name);
 280         return $theme->getPath($relative);
 281     }
 282
 283     /**
 284      * list available theme names
 285      *
 286      * @return array list of available theme names
 287      */
 288
 289     static function listAvailable()
 290     {
 291         $local   = self::subdirsOf(self::localRoot());
 292         $install = self::subdirsOf(self::installRoot());
 293
 294         $i = array_search('base', $install);
 295
 296         unset($install[$i]);
 297
 298         return array_merge($local, $install);
 299     }
 300
 301     /**
 302      * Utility for getting subdirs of a directory
 303      *
 304      * @param string $dir full path to directory to check
 305      *
 306      * @return array relative filenames of subdirs, or empty array
 307      */
 308
 309     protected static function subdirsOf($dir)
 310     {
 311         $subdirs = array();
 312
 313         if (is_dir($dir)) {
 314             if ($dh = opendir($dir)) {
 315                 while (($filename = readdir($dh)) !== false) {
 316                     if ($filename != '..' && $filename !== '.' &&
 317                         is_dir($dir.'/'.$filename)) {
 318                         $subdirs[] = $filename;
 319                     }
 320                 }
 321                 closedir($dh);
 322             }
 323         }
 324
 325         return $subdirs;
 326     }
 327
 328     /**
 329      * Local root dir for themes
 330      *
 331      * @return string local root dir for themes
 332      */
 333
 334     protected static function localRoot()
 335     {
 336         $basedir = common_config('local', 'dir');
 337
 338         if (empty($basedir)) {
 339             $basedir = INSTALLDIR . '/local';
 340         }
 341
 342         return $basedir . '/theme';
 343     }
 344
 345     /**
 346      * Root dir for themes that are shipped with StatusNet
 347      *
 348      * @return string root dir for StatusNet themes
 349      */
 350
 351     protected static function installRoot()
 352     {
 353         $instroot = common_config('theme', 'dir');
 354
 355         if (empty($instroot)) {
 356             $instroot = INSTALLDIR.'/theme';
 357         }
 358
 359         return $instroot;
 360     }
 361
 362     static function validName($name)
 363     {
 364         return preg_match('/^[a-z0-9][a-z0-9_-]*$/i', $name);
 365     }
 366 }