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