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