From c24458a9f047ba68f0ef8ff4307562df6c4f3611 Mon Sep 17 00:00:00 2001
From: Brion Vibber <brion@pobox.com>
Date: Thu, 2 Sep 2010 14:11:52 -0700
Subject: Ticket #2638: allow themes to specify a base theme to load with
 'include' setting in a theme.ini file

---
 lib/theme.php | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

(limited to 'lib/theme.php')

diff --git a/lib/theme.php b/lib/theme.php
index a9d0cbc84..992fce870 100644
--- a/lib/theme.php
+++ b/lib/theme.php
@@ -54,6 +54,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
 
 class Theme
 {
+    var $name = null;
     var $dir  = null;
     var $path = null;
 
@@ -70,6 +71,10 @@ class Theme
         if (empty($name)) {
             $name = common_config('site', 'theme');
         }
+        if (!self::validName($name)) {
+            throw new ServerException("Invalid theme name.");
+        }
+        $this->name = $name;
 
         // Check to see if it's in the local dir
 
@@ -177,6 +182,58 @@ class Theme
         return $this->path.'/'.$relative;
     }
 
+    /**
+     * Fetch a list of other themes whose CSS needs to be pulled in before
+     * this theme's, based on following the theme.ini 'include' settings.
+     * (May be empty if this theme has no include dependencies.)
+     *
+     * @return array of strings with theme names
+     */
+    function getDeps()
+    {
+        $chain = $this->doGetDeps(array($this->name));
+        array_pop($chain); // Drop us back off
+        return $chain;
+    }
+
+    protected function doGetDeps($chain)
+    {
+        $data = $this->getMetadata();
+        if (!empty($data['include'])) {
+            $include = $data['include'];
+
+            // Protect against cycles!
+            if (!in_array($include, $chain)) {
+                try {
+                    $theme = new Theme($include);
+                    array_unshift($chain, $include);
+                    return $theme->doGetDeps($chain);
+                } catch (Exception $e) {
+                    common_log(LOG_ERR,
+                            "Exception while fetching theme dependencies " .
+                            "for $this->name: " . $e->getMessage());
+                }
+            }
+        }
+        return $chain;
+    }
+
+    /**
+     * Pull data from the theme's theme.ini file.
+     * @fixme calling getFile will fall back to default theme, this may be unsafe.
+     * 
+     * @return associative array of strings
+     */
+    function getMetadata()
+    {
+        $iniFile = $this->getFile('theme.ini');
+        if (file_exists($iniFile)) {
+            return parse_ini_file($iniFile);
+        } else {
+            return array();
+        }
+    }
+
     /**
      * Gets the full path of a file in a theme dir based on its relative name
      *
@@ -285,4 +342,9 @@ class Theme
 
         return $instroot;
     }
+
+    static function validName($name)
+    {
+        return preg_match('/^[a-z0-9][a-z0-9_-]*$/i', $name);
+    }
 }
-- 
cgit v1.2.3-54-g00ecf