3 * StatusNet, the distributed open-source microblogging tool
5 * Utilities for theme files and paths
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.
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.
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/>.
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/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
36 * Class for querying and manipulating a theme
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.
42 * Note that the 'local' directory can be overridden as $config['local']['path']
43 * and $config['local']['dir'] etc.
45 * This used to be a couple of functions, but for various reasons it's nice
46 * to have a class instead.
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/
64 * Determines the proper directory and path for this theme.
66 * @param string $name Name of the theme; defaults to config value
69 function __construct($name=null)
72 $name = common_config('site', 'theme');
74 if (!self::validName($name)) {
75 throw new ServerException("Invalid theme name.");
79 // Check to see if it's in the local dir
81 $localroot = self::localRoot();
83 $fulldir = $localroot.'/'.$name;
85 if (file_exists($fulldir) && is_dir($fulldir)) {
86 $this->dir = $fulldir;
87 $this->path = $this->relativeThemePath('local', 'local', 'theme/' . $name);
91 // Check to see if it's in the distribution dir
93 $instroot = self::installRoot();
95 $fulldir = $instroot.'/'.$name;
97 if (file_exists($fulldir) && is_dir($fulldir)) {
99 $this->dir = $fulldir;
100 $this->path = $this->relativeThemePath('theme', 'theme', $name);
105 * Build a full URL to the given theme's base directory, possibly
106 * using an offsite theme server path.
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
114 * @todo consolidate code with that for other customizable paths
117 protected function relativeThemePath($group, $fallbackSubdir, $name)
119 $path = common_config($group, 'path');
122 $path = common_config('site', 'path') . '/';
123 if ($fallbackSubdir) {
124 $path .= $fallbackSubdir . '/';
128 if ($path[strlen($path)-1] != '/') {
132 if ($path[0] != '/') {
136 $server = common_config($group, 'server');
138 if (empty($server)) {
139 $server = common_config('site', 'server');
142 $ssl = common_config($group, 'ssl');
144 if (is_null($ssl)) { // null -> guess
145 if (common_config('site', 'ssl') == 'always' &&
146 !common_config($group, 'server')) {
153 $protocol = ($ssl) ? 'https' : 'http';
155 $path = $protocol . '://'.$server.$path.$name;
160 * Gets the full local filename of a file in this theme.
162 * @param string $relative relative name, like 'logo.png'
164 * @return string full pathname, like /var/www/mublog/theme/default/logo.png
167 function getFile($relative)
169 return $this->dir.'/'.$relative;
173 * Gets the full HTTP url of a file in this theme
175 * @param string $relative relative name, like 'logo.png'
177 * @return string full URL, like 'http://example.com/theme/default/logo.png'
180 function getPath($relative)
182 return $this->path.'/'.$relative;
186 * Fetch a list of other themes whose CSS needs to be pulled in before
187 * this theme's, based on following the theme.ini 'include' settings.
188 * (May be empty if this theme has no include dependencies.)
190 * @return array of strings with theme names
194 $chain = $this->doGetDeps(array($this->name));
195 array_pop($chain); // Drop us back off
199 protected function doGetDeps($chain)
201 $data = $this->getMetadata();
202 if (!empty($data['include'])) {
203 $include = $data['include'];
205 // Protect against cycles!
206 if (!in_array($include, $chain)) {
208 $theme = new Theme($include);
209 array_unshift($chain, $include);
210 return $theme->doGetDeps($chain);
211 } catch (Exception $e) {
213 "Exception while fetching theme dependencies " .
214 "for $this->name: " . $e->getMessage());
222 * Pull data from the theme's theme.ini file.
223 * @fixme calling getFile will fall back to default theme, this may be unsafe.
225 * @return associative array of strings
227 function getMetadata()
229 $iniFile = $this->getFile('theme.ini');
230 if (file_exists($iniFile)) {
231 return parse_ini_file($iniFile);
238 * Gets the full path of a file in a theme dir based on its relative name
240 * @param string $relative relative path within the theme directory
241 * @param string $name name of the theme; defaults to current theme
243 * @return string File path to the theme file
246 static function file($relative, $name=null)
248 $theme = new Theme($name);
249 return $theme->getFile($relative);
253 * Gets the full URL of a file in a theme dir based on its relative name
255 * @param string $relative relative path within the theme directory
256 * @param string $name name of the theme; defaults to current theme
258 * @return string URL of the file
261 static function path($relative, $name=null)
263 $theme = new Theme($name);
264 return $theme->getPath($relative);
268 * list available theme names
270 * @return array list of available theme names
273 static function listAvailable()
275 $local = self::subdirsOf(self::localRoot());
276 $install = self::subdirsOf(self::installRoot());
278 $i = array_search('base', $install);
282 return array_merge($local, $install);
286 * Utility for getting subdirs of a directory
288 * @param string $dir full path to directory to check
290 * @return array relative filenames of subdirs, or empty array
293 protected static function subdirsOf($dir)
298 if ($dh = opendir($dir)) {
299 while (($filename = readdir($dh)) !== false) {
300 if ($filename != '..' && $filename !== '.' &&
301 is_dir($dir.'/'.$filename)) {
302 $subdirs[] = $filename;
313 * Local root dir for themes
315 * @return string local root dir for themes
318 protected static function localRoot()
320 $basedir = common_config('local', 'dir');
322 if (empty($basedir)) {
323 $basedir = INSTALLDIR . '/local';
326 return $basedir . '/theme';
330 * Root dir for themes that are shipped with StatusNet
332 * @return string root dir for StatusNet themes
335 protected static function installRoot()
337 $instroot = common_config('theme', 'dir');
339 if (empty($instroot)) {
340 $instroot = INSTALLDIR.'/theme';
346 static function validName($name)
348 return preg_match('/^[a-z0-9][a-z0-9_-]*$/i', $name);