libraries/Theme.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * hold PMA_Theme class
   5  *
   6  * @package phpMyAdmin
   7  */
   8
   9 /**
  10  * handles theme
  11  *
  12  * @todo add the possibility to make a theme depend on another theme and by default on original
  13  * @todo make all components optional - get missing components from 'parent' theme
  14  * @todo make css optionally replacing 'parent' css or extending it (by appending at the end)
  15  * @todo add an optional global css file - which will be used for both frames
  16  *
  17  * @package phpMyAdmin
  18  */
  19 class PMA_Theme {
  20     /**
  21      * @var string theme version
  22      * @access  protected
  23      */
  24     var $version = '0.0.0.0';
  25
  26     /**
  27      * @var string theme name
  28      * @access  protected
  29      */
  30     var $name = '';
  31
  32     /**
  33      * @var string theme id
  34      * @access  protected
  35      */
  36     var $id = '';
  37
  38     /**
  39      * @var string theme path
  40      * @access  protected
  41      */
  42     var $path = '';
  43
  44     /**
  45      * @var string image path
  46      * @access  protected
  47      */
  48     var $img_path = '';
  49
  50     /**
  51      * @var array   valid css types
  52      * @access  protected
  53      */
  54     var $types = array('left', 'right', 'print');
  55
  56     /**
  57      * @var integer last modification time for info file
  58      * @access  protected
  59      */
  60     var $mtime_info = 0;
  61
  62     /**
  63      * needed because sometimes, the mtime for different themes
  64      * is identical
  65      * @var integer filesize for info file
  66      * @access  protected
  67      */
  68     var $filesize_info = 0;
  69
  70     /**
  71      * @access  public
  72      * @return  boolean     whether loading them info was successful or not
  73      */
  74     function loadInfo()
  75     {
  76         if (! file_exists($this->getPath() . '/info.inc.php')) {
  77             return false;
  78         }
  79
  80         if ($this->mtime_info === filemtime($this->getPath() . '/info.inc.php')) {
  81             return true;
  82         }
  83
  84         @include $this->getPath() . '/info.inc.php';
  85
  86         // was it set correctly?
  87         if (! isset($theme_name)) {
  88             return false;
  89         }
  90
  91         $this->mtime_info = filemtime($this->getPath() . '/info.inc.php');
  92         $this->filesize_info = filesize($this->getPath() . '/info.inc.php');
  93
  94         if (isset($theme_full_version)) {
  95             $this->setVersion($theme_full_version);
  96         } elseif (isset($theme_generation, $theme_version)) {
  97             $this->setVersion($theme_generation . '.' . $theme_version);
  98         }
  99         $this->setName($theme_name);
 100
 101         return true;
 102     }
 103
 104     /**
 105      * returns theme object loaded from given folder
 106      * or false if theme is invalid
 107      *
 108      * @static
 109      * @access  public
 110      * @param string  $folder path to theme
 111      * @return  object  PMA_Theme
 112      */
 113     static public function load($folder)
 114     {
 115         $theme = new PMA_Theme();
 116
 117         $theme->setPath($folder);
 118
 119         if (! $theme->loadInfo()) {
 120             return false;
 121         }
 122
 123         $theme->checkImgPath();
 124
 125         return $theme;
 126     }
 127
 128     /**
 129      * checks image path for existance - if not found use img from original theme
 130      *
 131      * @access  public
 132      */
 133     function checkImgPath()
 134     {
 135         if (is_dir($this->getPath() . '/img/')) {
 136             $this->setImgPath($this->getPath() . '/img/');
 137             return true;
 138         } elseif (is_dir($GLOBALS['cfg']['ThemePath'] . '/original/img/')) {
 139             $this->setImgPath($GLOBALS['cfg']['ThemePath'] . '/original/img/');
 140             return true;
 141         } else {
 142             trigger_error(
 143                 sprintf(__('No valid image path for theme %s found!'), $this->getName()),
 144                 E_USER_ERROR);
 145             return false;
 146         }
 147     }
 148
 149     /**
 150      * returns path to theme
 151      *
 152      * @access  public
 153      * @return  string  $path   path to theme
 154      */
 155     function getPath()
 156     {
 157         return $this->path;
 158     }
 159
 160     /**
 161      * returns layout file
 162      *
 163      * @access  public
 164      * @return  string  layout file
 165      */
 166     function getLayoutFile()
 167     {
 168         return $this->getPath() . '/layout.inc.php';
 169     }
 170
 171     /**
 172      * set path to theme
 173      *
 174      * @access  public
 175      * @param string  $path   path to theme
 176      */
 177     function setPath($path)
 178     {
 179         $this->path = trim($path);
 180     }
 181
 182     /**
 183      * sets version
 184      *
 185      * @access  public
 186      * @param string new version
 187      */
 188     function setVersion($version)
 189     {
 190         $this->version = trim($version);
 191     }
 192
 193     /**
 194      * returns version
 195      *
 196      * @access  public
 197      * @return  string  version
 198      */
 199     function getVersion()
 200     {
 201         return $this->version;
 202     }
 203
 204     /**
 205      * checks theme version agaisnt $version
 206      * returns true if theme version is equal or higher to $version
 207      *
 208      * @access  public
 209      * @param string  $version    version to compare to
 210      * @return  boolean
 211      */
 212     function checkVersion($version)
 213     {
 214         return version_compare($this->getVersion(), $version, 'lt');
 215     }
 216
 217     /**
 218      * sets name
 219      *
 220      * @access  public
 221      * @param string  $name   new name
 222      */
 223     function setName($name)
 224     {
 225         $this->name = trim($name);
 226     }
 227
 228     /**
 229      * returns name
 230      *
 231      * @access  public
 232      * @return  string name
 233      */
 234     function getName()
 235     {
 236         return $this->name;
 237     }
 238
 239     /**
 240      * sets id
 241      *
 242      * @access  public
 243      * @param string  $id   new id
 244      */
 245     function setId($id)
 246     {
 247         $this->id = trim($id);
 248     }
 249
 250     /**
 251      * returns id
 252      *
 253      * @access  public
 254      * @return  string  id
 255      */
 256     function getId()
 257     {
 258         return $this->id;
 259     }
 260
 261     /**
 262      * @access  public
 263      * @param string  path to images for this theme
 264      */
 265     function setImgPath($path)
 266     {
 267         $this->img_path = $path;
 268     }
 269
 270     /**
 271      * @access  public
 272      * @return  string image path for this theme
 273      */
 274     function getImgPath()
 275     {
 276         return $this->img_path;
 277     }
 278
 279     /**
 280      * load css (send to stdout, normally the browser)
 281      *
 282      * @access  public
 283      * @param string  $type   left, right or print
 284      */
 285     function loadCss(&$type)
 286     {
 287         if (empty($type) || ! in_array($type, $this->types)) {
 288             $type = 'left';
 289         }
 290
 291         if ($type == 'right') {
 292             echo PMA_SQP_buildCssData();
 293         }
 294
 295         $_css_file = $this->getPath()
 296                    . '/css/theme_' . $type . '.css.php';
 297
 298         if (! file_exists($_css_file)) {
 299             return false;
 300         }
 301
 302         if ($GLOBALS['text_dir'] === 'ltr') {
 303             $right = 'right';
 304             $left = 'left';
 305         } else {
 306             $right = 'left';
 307             $left = 'right';
 308         }
 309
 310         include $_css_file;
 311         return true;
 312     }
 313
 314     /**
 315      * prints out the preview for this theme
 316      *
 317      * @access  public
 318      */
 319     function printPreview()
 320     {
 321         echo '<div class="theme_preview">';
 322         echo '<h2>' . htmlspecialchars($this->getName())
 323             .' (' . htmlspecialchars($this->getVersion()) . ')</h2>'
 324             .'<p>'
 325             .'<a target="_top" href="index.php'
 326             .PMA_generate_common_url(array('set_theme' => $this->getId())) . '"'
 327             .' onclick="takeThis(\'' . addslashes($this->getId()) . '\');'
 328             .' return false;">';
 329         if (@file_exists($this->getPath() . '/screen.png')) {
 330             // if screen exists then output
 331
 332             echo '<img src="' . $this->getPath() . '/screen.png" border="1"'
 333                 .' alt="' . htmlspecialchars($this->getName()) . '"'
 334                 .' title="' . htmlspecialchars($this->getName()) . '" /><br />';
 335         } else {
 336             echo __('No preview available.');
 337         }
 338
 339         echo '[ <strong>' . __('take it') . '</strong> ]</a>'
 340             .'</p>'
 341             .'</div>';
 342     }
 343 }
 344 ?>