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 object 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(__('Default theme %s not found!'),
 110                     htmlspecialchars($GLOBALS['cfg']['ThemeDefault'])),
 111                 E_USER_ERROR);
 112             $GLOBALS['cfg']['ThemeDefault'] = false;
 113         }
 114
 115         $this->theme_default = $GLOBALS['cfg']['ThemeDefault'];
 116
 117         // check if user have a theme cookie
 118         if (! $this->getThemeCookie()
 119          || ! $this->setActiveTheme($this->getThemeCookie())) {
 120             // otherwise use default theme
 121             if ($GLOBALS['cfg']['ThemeDefault']) {
 122                 $this->setActiveTheme($GLOBALS['cfg']['ThemeDefault']);
 123             } else {
 124                 // or original theme
 125                 $this->setActiveTheme('original');
 126             }
 127         }
 128     }
 129
 130     function checkConfig()
 131     {
 132         if ($this->_themes_path != trim($GLOBALS['cfg']['ThemePath'])
 133          || $this->theme_default != $GLOBALS['cfg']['ThemeDefault']) {
 134             $this->init();
 135         } else {
 136             // at least the theme path needs to be checked every time for new
 137             // themes, as there is no other way at the moment to keep track of
 138             // new or removed themes
 139             $this->loadThemes();
 140         }
 141     }
 142
 143     function setActiveTheme($theme = null)
 144     {
 145         if (! $this->checkTheme($theme)) {
 146             trigger_error(
 147                 sprintf(__('Theme %s not found!'), htmlspecialchars($theme)),
 148                 E_USER_ERROR);
 149             return false;
 150         }
 151
 152         $this->active_theme = $theme;
 153         $this->theme = $this->themes[$theme];
 154
 155         // need to set later
 156         //$this->setThemeCookie();
 157
 158         return true;
 159     }
 160
 161     /**
 162      * @return  string  cookie name
 163      */
 164     function getThemeCookieName()
 165     {
 166         // Allow different theme per server
 167         if (isset($GLOBALS['server']) && $this->per_server) {
 168             return $this->cookie_name . '-' . $GLOBALS['server'];
 169         } else {
 170             return $this->cookie_name;
 171         }
 172     }
 173
 174     /**
 175      * returns name of theme stored in the cookie
 176      * @return  string  theme name from cookie
 177      */
 178     function getThemeCookie()
 179     {
 180         if (isset($_COOKIE[$this->getThemeCookieName()])) {
 181             return $_COOKIE[$this->getThemeCookieName()];
 182         }
 183
 184         return false;
 185     }
 186
 187     /**
 188      * save theme in cookie
 189      *
 190      */
 191     function setThemeCookie()
 192     {
 193         $GLOBALS['PMA_Config']->setCookie($this->getThemeCookieName(), $this->theme->id,
 194             $this->theme_default);
 195         // force a change of a dummy session variable to avoid problems
 196         // with the caching of phpmyadmin.css.php
 197         $GLOBALS['PMA_Config']->set('theme-update', $this->theme->id);
 198         return true;
 199     }
 200
 201     /**
 202      * @private
 203      * @param   string $folder
 204      * @return  boolean
 205      */
 206     /*private*/ function _checkThemeFolder($folder)
 207     {
 208         if (! is_dir($folder)) {
 209             trigger_error(
 210                 sprintf(__('Theme path not found for theme %s!'),
 211                     htmlspecialchars($folder)),
 212                 E_USER_ERROR);
 213             return false;
 214         }
 215
 216         return true;
 217     }
 218
 219     /**
 220      * read all themes
 221      */
 222     function loadThemes()
 223     {
 224         $this->themes = array();
 225
 226         if ($handleThemes = opendir($this->getThemesPath())) {
 227             // check for themes directory
 228             while (false !== ($PMA_Theme = readdir($handleThemes))) {
 229                 if (array_key_exists($PMA_Theme, $this->themes)) {
 230                     // this does nothing!
 231                     //$this->themes[$PMA_Theme] = $this->themes[$PMA_Theme];
 232                     continue;
 233                 }
 234                 $new_theme = PMA_Theme::load($this->getThemesPath() . '/' . $PMA_Theme);
 235                 if ($new_theme) {
 236                     $new_theme->setId($PMA_Theme);
 237                     $this->themes[$PMA_Theme] = $new_theme;
 238                 }
 239             } // end get themes
 240             closedir($handleThemes);
 241         } else {
 242             trigger_error(
 243                 'phpMyAdmin-ERROR: cannot open themes folder: ' . $this->getThemesPath(),
 244                 E_USER_WARNING);
 245             return false;
 246         } // end check for themes directory
 247
 248         ksort($this->themes);
 249         return true;
 250     }
 251
 252     /**
 253      * checks if given theme name is a known theme
 254      *
 255      * @param   string  $theme  name fo theme to check for
 256      */
 257     function checkTheme($theme)
 258     {
 259         if (! array_key_exists($theme, $this->themes)) {
 260             return false;
 261         }
 262
 263         return true;
 264     }
 265
 266     /**
 267      * returns HTML selectbox, with or without form enclosed
 268      *
 269      * @param   boolean $form   whether enclosed by from tags or not
 270      */
 271     function getHtmlSelectBox($form = true)
 272     {
 273         $select_box = '';
 274
 275         if ($form) {
 276             $select_box .= '<form name="setTheme" method="post" action="index.php"'
 277                 .' target="_parent">';
 278             $select_box .=  PMA_generate_common_hidden_inputs();
 279         }
 280
 281         $theme_selected = false;
 282         $theme_preview_path= './themes.php';
 283         $theme_preview_href = '<a href="' . $theme_preview_path . '" target="themes" onclick="'
 284                             . "window.open('" . $theme_preview_path . "','themes','left=10,top=20,width=510,height=350,scrollbars=yes,status=yes,resizable=yes');"
 285                             . '">';
 286         $select_box .=  $theme_preview_href . __('Theme') . '</a>:' . "\n";
 287
 288         $select_box .=  '<select name="set_theme" xml:lang="en" dir="ltr"'
 289             .' onchange="this.form.submit();" >';
 290         foreach ($this->themes as $each_theme_id => $each_theme) {
 291             $select_box .=  '<option value="' . $each_theme_id . '"';
 292             if ($this->active_theme === $each_theme_id) {
 293                 $select_box .=  ' selected="selected"';
 294             }
 295             $select_box .=  '>' . htmlspecialchars($each_theme->getName()) . '</option>';
 296         }
 297         $select_box .=  '</select>';
 298
 299         if ($form) {
 300             $select_box .=  '<noscript><input type="submit" value="' . __('Go') . '" /></noscript>';
 301             $select_box .=  '</form>';
 302         }
 303
 304         return $select_box;
 305     }
 306
 307     /**
 308      * enables backward compatibility
 309      */
 310     function makeBc()
 311     {
 312         $GLOBALS['theme']           = $this->theme->getId();
 313         $GLOBALS['pmaThemePath']    = $this->theme->getPath();
 314         $GLOBALS['pmaThemeImage']   = $this->theme->getImgPath();
 315
 316         /**
 317          * load layout file if exists
 318          */
 319         if (@file_exists($GLOBALS['pmaThemePath'] . 'layout.inc.php')) {
 320             include $GLOBALS['pmaThemePath'] . 'layout.inc.php';
 321         }
 322
 323
 324     }
 325
 326     /**
 327      * prints out preview for every theme
 328      *
 329      */
 330     function printPreviews()
 331     {
 332         foreach ($this->themes as $each_theme) {
 333             $each_theme->printPreview();
 334         } // end 'open themes'
 335     }
 336
 337     /**
 338      * returns PMA_Theme object for fall back theme
 339      * @return object   PMA_Theme
 340      */
 341     function getFallBackTheme()
 342     {
 343         if (isset($this->themes['original'])) {
 344             return $this->themes['original'];
 345         }
 346
 347         return false;
 348     }
 349
 350     /**
 351      * prints css data
 352      */
 353     function printCss($type)
 354     {
 355         if ($this->theme->loadCss($type)) {
 356             return true;
 357         }
 358
 359         // if loading css for this theme failed, try default theme css
 360         $fallback_theme = $this->getFallBackTheme();
 361         if ($fallback_theme && $fallback_theme->loadCss($type)) {
 362             return true;
 363         }
 364
 365         return false;
 366     }
 367 }
 368 ?>