2 /* vim: set expandtab sw=4 ts=4 sts=4: */
12 class PMA_Theme_Manager
15 * @var string path to theme folder
21 * @var array available themes
23 var $themes = array();
26 * @var string cookie name
28 var $cookie_name = 'pma_theme';
33 var $per_server = false;
36 * @var string name of active theme
38 var $active_theme = '';
41 * @var object PMA_Theme active theme
48 var $theme_default = 'original';
50 function __construct()
56 * sets path to folder containing the themes
58 * @param string $path path to themes folder
59 * @return boolean success
61 function setThemesPath($path)
63 if (! $this->_checkThemeFolder($path)) {
67 $this->_themes_path
= trim($path);
75 function getThemesPath()
77 return $this->_themes_path
;
81 * sets if there are different themes per server
83 * @param boolean $per_server
85 function setThemePerServer($per_server)
87 $this->per_server
= (bool) $per_server;
92 $this->themes
= array();
93 $this->theme_default
= 'original';
94 $this->active_theme
= '';
96 if (! $this->setThemesPath($GLOBALS['cfg']['ThemePath'])) {
100 $this->setThemePerServer($GLOBALS['cfg']['ThemePerServer']);
104 $this->theme
= new PMA_Theme
;
107 if (! $this->checkTheme($GLOBALS['cfg']['ThemeDefault'])) {
109 sprintf(__('Default theme %s not found!'),
110 htmlspecialchars($GLOBALS['cfg']['ThemeDefault'])),
112 $GLOBALS['cfg']['ThemeDefault'] = false;
115 $this->theme_default
= $GLOBALS['cfg']['ThemeDefault'];
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']);
125 $this->setActiveTheme('original');
130 function checkConfig()
132 if ($this->_themes_path
!= trim($GLOBALS['cfg']['ThemePath'])
133 ||
$this->theme_default
!= $GLOBALS['cfg']['ThemeDefault']) {
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
143 function setActiveTheme($theme = null)
145 if (! $this->checkTheme($theme)) {
147 sprintf(__('Theme %s not found!'), htmlspecialchars($theme)),
152 $this->active_theme
= $theme;
153 $this->theme
= $this->themes
[$theme];
156 //$this->setThemeCookie();
162 * @return string cookie name
164 function getThemeCookieName()
166 // Allow different theme per server
167 if (isset($GLOBALS['server']) && $this->per_server
) {
168 return $this->cookie_name
. '-' . $GLOBALS['server'];
170 return $this->cookie_name
;
175 * returns name of theme stored in the cookie
176 * @return string theme name from cookie
178 function getThemeCookie()
180 if (isset($_COOKIE[$this->getThemeCookieName()])) {
181 return $_COOKIE[$this->getThemeCookieName()];
188 * save theme in cookie
190 * @uses $GLOBALS['PMA_Config']->setCookie();
191 * @uses PMA_Theme_Manager::getThemeCookieName()
192 * @uses PMA_Theme_Manager::$theme
193 * @uses PMA_Theme_Manager::$theme_default
194 * @uses PMA_Theme::getId()
196 function setThemeCookie()
198 $GLOBALS['PMA_Config']->setCookie($this->getThemeCookieName(), $this->theme
->id
,
199 $this->theme_default
);
200 // force a change of a dummy session variable to avoid problems
201 // with the caching of phpmyadmin.css.php
202 $GLOBALS['PMA_Config']->set('theme-update', $this->theme
->id
);
208 * @param string $folder
211 /*private*/ function _checkThemeFolder($folder)
213 if (! is_dir($folder)) {
215 sprintf(__('Theme path not found for theme %s!'),
216 htmlspecialchars($folder)),
227 function loadThemes()
229 $this->themes
= array();
231 if ($handleThemes = opendir($this->getThemesPath())) {
232 // check for themes directory
233 while (false !== ($PMA_Theme = readdir($handleThemes))) {
234 // Skip non dirs, . and ..
235 if ($PMA_Theme == '.' ||
$PMA_Theme == '..' ||
! is_dir($this->getThemesPath() . '/' . $PMA_Theme)) {
238 if (array_key_exists($PMA_Theme, $this->themes
)) {
239 // this does nothing!
240 //$this->themes[$PMA_Theme] = $this->themes[$PMA_Theme];
243 $new_theme = PMA_Theme
::load($this->getThemesPath() . '/' . $PMA_Theme);
245 $new_theme->setId($PMA_Theme);
246 $this->themes
[$PMA_Theme] = $new_theme;
249 closedir($handleThemes);
252 'phpMyAdmin-ERROR: cannot open themes folder: ' . $this->getThemesPath(),
255 } // end check for themes directory
257 ksort($this->themes
);
262 * checks if given theme name is a known theme
264 * @param string $theme name fo theme to check for
266 function checkTheme($theme)
268 if (! array_key_exists($theme, $this->themes
)) {
276 * returns HTML selectbox, with or without form enclosed
278 * @param boolean $form whether enclosed by from tags or not
280 function getHtmlSelectBox($form = true)
285 $select_box .= '<form name="setTheme" method="post" action="index.php"'
286 .' target="_parent">';
287 $select_box .= PMA_generate_common_hidden_inputs();
290 $theme_selected = FALSE;
291 $theme_preview_path= './themes.php';
292 $theme_preview_href = '<a href="' . $theme_preview_path . '" target="themes" onclick="'
293 . "window.open('" . $theme_preview_path . "','themes','left=10,top=20,width=510,height=350,scrollbars=yes,status=yes,resizable=yes');"
295 $select_box .= $theme_preview_href . __('Theme / Style') . '</a>:' . "\n";
297 $select_box .= '<select name="set_theme" xml:lang="en" dir="ltr"'
298 .' onchange="this.form.submit();" >';
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"';
304 $select_box .= '>' . htmlspecialchars($each_theme->getName()) . '</option>';
306 $select_box .= '</select>';
309 $select_box .= '<noscript><input type="submit" value="' . __('Go') . '" /></noscript>';
310 $select_box .= '</form>';
317 * enables backward compatibility
321 $GLOBALS['theme'] = $this->theme
->getId();
322 $GLOBALS['pmaThemePath'] = $this->theme
->getPath();
323 $GLOBALS['pmaThemeImage'] = $this->theme
->getImgPath();
326 * load layout file if exists
328 if (@file_exists
($GLOBALS['pmaThemePath'] . 'layout.inc.php')) {
329 include $GLOBALS['pmaThemePath'] . 'layout.inc.php';
336 * prints out preview for every theme
338 * @uses $this->themes
339 * @uses PMA_Theme::printPreview()
341 function printPreviews()
343 foreach ($this->themes
as $each_theme) {
344 $each_theme->printPreview();
345 } // end 'open themes'
349 * returns PMA_Theme object for fall back theme
350 * @return object PMA_Theme
352 function getFallBackTheme()
354 if (isset($this->themes
['original'])) {
355 return $this->themes
['original'];
364 function printCss($type)
366 if ($this->theme
->loadCss($type)) {
370 // if loading css for this theme failed, try default theme css
371 $fallback_theme = $this->getFallBackTheme();
372 if ($fallback_theme && $fallback_theme->loadCss($type)) {