libraries/Theme_Manager.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  *
   5  * @package phpMyAdmin
   6  */
   7
   8 /**
   9  *
  10  * @package phpMyAdmin
  11  */
  12 class PMA_Theme_Manager
  13 {
  14     /**
  15      * @var string path to theme folder
  16      * @access protected
  17      */
  18     var $_themes_path;
  19
  20     /**
  21      * @var array available themes
  22      */
  23     var $themes = array();
  24
  25     /**
  26      * @var string  cookie name
  27      */
  28     var $cookie_name = 'pma_theme';
  29
  30     /**
  31      * @var boolean
  32      */
  33     var $per_server = false;
  34
  35     /**
  36      * @var string name of active theme
  37      */
  38     var $active_theme = '';
  39
  40     /**
  41      * @var PMA_Theme PMA_Theme active theme
  42      */
  43     var $theme = null;
  44
  45     /**
  46      * @var string
  47      */
  48     var $theme_default = 'original';
  49
  50     function __construct()
  51     {
  52         $this->init();
  53     }
  54
  55     /**
  56      * sets path to folder containing the themes
  57      *
  58      * @param string  $path   path to themes folder
  59      * @return  boolean success
  60      */
  61     function setThemesPath($path)
  62     {
  63         if (! $this->_checkThemeFolder($path)) {
  64             return false;
  65         }
  66
  67         $this->_themes_path = trim($path);
  68         return true;
  69     }
  70
  71     /**
  72      * @public
  73      * @return  string
  74      */
  75     function getThemesPath()
  76     {
  77         return $this->_themes_path;
  78     }
  79
  80     /**
  81      * sets if there are different themes per server
  82      *
  83      * @param boolean $per_server
  84      */
  85     function setThemePerServer($per_server)
  86     {
  87         $this->per_server  = (bool) $per_server;
  88     }
  89
  90     function init()
  91     {
  92         $this->themes = array();
  93         $this->theme_default = 'original';
  94         $this->active_theme = '';
  95
  96         if (! $this->setThemesPath($GLOBALS['cfg']['ThemePath'])) {
  97             return false;
  98         }
  99
 100         $this->setThemePerServer($GLOBALS['cfg']['ThemePerServer']);
 101
 102         $this->loadThemes();
 103
 104         $this->theme = new PMA_Theme;
 105
 106
 107         if (! $this->checkTheme($GLOBALS['cfg']['ThemeDefault'])) {
 108             trigger_error(
 109                 sprintf(
 110                     __('Default theme %s not found!'),
 111                     htmlspecialchars($GLOBALS['cfg']['ThemeDefault'])
 112                     ),
 113                 E_USER_ERROR
 114                 );
 115             $GLOBALS['cfg']['ThemeDefault'] = false;
 116         }
 117
 118         $this->theme_default = $GLOBALS['cfg']['ThemeDefault'];
 119
 120         // check if user have a theme cookie
 121         if (! $this->getThemeCookie()
 122          || ! $this->setActiveTheme($this->getThemeCookie())) {
 123             // otherwise use default theme
 124             if ($GLOBALS['cfg']['ThemeDefault']) {
 125                 $this->setActiveTheme($GLOBALS['cfg']['ThemeDefault']);
 126             } else {
 127                 // or original theme
 128                 $this->setActiveTheme('original');
 129             }
 130         }
 131     }
 132
 133     function checkConfig()
 134     {
 135         if ($this->_themes_path != trim($GLOBALS['cfg']['ThemePath'])
 136          || $this->theme_default != $GLOBALS['cfg']['ThemeDefault']) {
 137             $this->init();
 138         } else {
 139             // at least the theme path needs to be checked every time for new
 140             // themes, as there is no other way at the moment to keep track of
 141             // new or removed themes
 142             $this->loadThemes();
 143         }
 144     }
 145
 146     function setActiveTheme($theme = null)
 147     {
 148         if (! $this->checkTheme($theme)) {
 149             trigger_error(
 150                 sprintf(
 151                     __('Theme %s not found!'),
 152                     htmlspecialchars($theme)
 153                 ),
 154                 E_USER_ERROR);
 155             return false;
 156         }
 157
 158         $this->active_theme = $theme;
 159         $this->theme = $this->themes[$theme];
 160
 161         // need to set later
 162         //$this->setThemeCookie();
 163
 164         return true;
 165     }
 166
 167     /**
 168      * @return  string  cookie name
 169      */
 170     function getThemeCookieName()
 171     {
 172         // Allow different theme per server
 173         if (isset($GLOBALS['server']) && $this->per_server) {
 174             return $this->cookie_name . '-' . $GLOBALS['server'];
 175         } else {
 176             return $this->cookie_name;
 177         }
 178     }
 179
 180     /**
 181      * returns name of theme stored in the cookie
 182      * @return  string  theme name from cookie
 183      */
 184     function getThemeCookie()
 185     {
 186         if (isset($_COOKIE[$this->getThemeCookieName()])) {
 187             return $_COOKIE[$this->getThemeCookieName()];
 188         }
 189
 190         return false;
 191     }
 192
 193     /**
 194      * save theme in cookie
 195      *
 196      * @return bool true
 197      */
 198     function setThemeCookie()
 199     {
 200         $GLOBALS['PMA_Config']->setCookie($this->getThemeCookieName(), $this->theme->id,
 201             $this->theme_default);
 202         // force a change of a dummy session variable to avoid problems
 203         // with the caching of phpmyadmin.css.php
 204         $GLOBALS['PMA_Config']->set('theme-update', $this->theme->id);
 205         return true;
 206     }
 207
 208     /**
 209      * @private
 210      * @param string $folder
 211      * @return  boolean
 212      */
 213     private function _checkThemeFolder($folder)
 214     {
 215         if (! is_dir($folder)) {
 216             trigger_error(
 217                 sprintf(__('Theme path not found for theme %s!'),
 218                     htmlspecialchars($folder)),
 219                 E_USER_ERROR);
 220             return false;
 221         }
 222
 223         return true;
 224     }
 225
 226     /**
 227      * read all themes
 228      *
 229      * @return bool true
 230      */
 231     function loadThemes()
 232     {
 233         $this->themes = array();
 234
 235         if ($handleThemes = opendir($this->getThemesPath())) {
 236             // check for themes directory
 237             while (false !== ($PMA_Theme = readdir($handleThemes))) {
 238                 // Skip non dirs, . and ..
 239                 if ($PMA_Theme == '.' || $PMA_Theme == '..' || ! is_dir($this->getThemesPath() . '/' . $PMA_Theme)) {
 240                     continue;
 241                 }
 242                 if (array_key_exists($PMA_Theme, $this->themes)) {
 243                     continue;
 244                 }
 245                 $new_theme = PMA_Theme::load($this->getThemesPath() . '/' . $PMA_Theme);
 246                 if ($new_theme) {
 247                     $new_theme->setId($PMA_Theme);
 248                     $this->themes[$PMA_Theme] = $new_theme;
 249                 }
 250             } // end get themes
 251             closedir($handleThemes);
 252         } else {
 253             trigger_error(
 254                 'phpMyAdmin-ERROR: cannot open themes folder: ' . $this->getThemesPath(),
 255                 E_USER_WARNING);
 256             return false;
 257         } // end check for themes directory
 258
 259         ksort($this->themes);
 260         return true;
 261     }
 262
 263     /**
 264      * checks if given theme name is a known theme
 265      *
 266      * @param string  $theme  name fo theme to check for
 267      * @return bool
 268      */
 269     function checkTheme($theme)
 270     {
 271         if (! array_key_exists($theme, $this->themes)) {
 272             return false;
 273         }
 274
 275         return true;
 276     }
 277
 278     /**
 279      * returns HTML selectbox, with or without form enclosed
 280      *
 281      * @param boolean $form   whether enclosed by from tags or not
 282      * @return string
 283      */
 284     function getHtmlSelectBox($form = true)
 285     {
 286         $select_box = '';
 287
 288         if ($form) {
 289             $select_box .= '<form name="setTheme" method="post" action="index.php"'
 290                 .' target="_parent">';
 291             $select_box .=  PMA_generate_common_hidden_inputs();
 292         }
 293
 294         $theme_preview_path= './themes.php';
 295         $theme_preview_href = '<a href="' . $theme_preview_path . '" target="themes" class="themeselect">';
 296         $select_box .=  $theme_preview_href . __('Theme') . '</a>:' . "\n";
 297
 298         $select_box .=  '<select name="set_theme" xml:lang="en" dir="ltr" class="autosubmit">';
 299         foreach ($this->themes as $each_theme_id => $each_theme) {
 300             $select_box .=  '<option value="' . $each_theme_id . '"';
 301             if ($this->active_theme === $each_theme_id) {
 302                 $select_box .=  ' selected="selected"';
 303             }
 304             $select_box .=  '>' . htmlspecialchars($each_theme->getName()) . '</option>';
 305         }
 306         $select_box .=  '</select>';
 307
 308         if ($form) {
 309             $select_box .=  '<noscript><input type="submit" value="' . __('Go') . '" /></noscript>';
 310             $select_box .=  '</form>';
 311         }
 312
 313         return $select_box;
 314     }
 315
 316     /**
 317      * enables backward compatibility
 318      */
 319     function makeBc()
 320     {
 321         $GLOBALS['theme']           = $this->theme->getId();
 322         $GLOBALS['pmaThemePath']    = $this->theme->getPath();
 323         $GLOBALS['pmaThemeImage']   = $this->theme->getImgPath();
 324
 325         /**
 326          * load layout file if exists
 327          */
 328         if (file_exists($this->theme->getLayoutFile())) {
 329             include $this->theme->getLayoutFile();
 330         }
 331
 332
 333     }
 334
 335     /**
 336      * prints out preview for every theme
 337      *
 338      */
 339     function printPreviews()
 340     {
 341         foreach ($this->themes as $each_theme) {
 342             $each_theme->printPreview();
 343         } // end 'open themes'
 344     }
 345
 346     /**
 347      * returns PMA_Theme object for fall back theme
 348      * @return object   PMA_Theme
 349      */
 350     function getFallBackTheme()
 351     {
 352         if (isset($this->themes['original'])) {
 353             return $this->themes['original'];
 354         }
 355
 356         return false;
 357     }
 358
 359     /**
 360      * prints css data
 361      *
 362      * @param string $type
 363      * @return bool
 364      */
 365     function printCss($type)
 366     {
 367         if ($this->theme->loadCss($type)) {
 368             return true;
 369         }
 370
 371         // if loading css for this theme failed, try default theme css
 372         $fallback_theme = $this->getFallBackTheme();
 373         if ($fallback_theme && $fallback_theme->loadCss($type)) {
 374             return true;
 375         }
 376
 377         return false;
 378     }
 379 }
 380 ?>