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      * @uses    PMA_Theme::getPath()
  73      * @uses    PMA_Theme::$mtime_info
  74      * @uses    PMA_Theme::setVersion()
  75      * @uses    PMA_Theme::setName()
  76      * @uses    filemtime()
  77      * @uses    filesize()
  78      * @uses    file_exists()
  79      * @return  boolean     whether loading them info was successful or not
  80      */
  81     function loadInfo()
  82     {
  83         if (! file_exists($this->getPath() . '/info.inc.php')) {
  84             return false;
  85         }
  86
  87         if ($this->mtime_info === filemtime($this->getPath() . '/info.inc.php')) {
  88             return true;
  89         }
  90
  91         @include $this->getPath() . '/info.inc.php';
  92
  93         // was it set correctly?
  94         if (! isset($theme_name)) {
  95             return false;
  96         }
  97
  98         $this->mtime_info = filemtime($this->getPath() . '/info.inc.php');
  99         $this->filesize_info = filesize($this->getPath() . '/info.inc.php');
 100
 101         if (isset($theme_full_version)) {
 102             $this->setVersion($theme_full_version);
 103         } elseif (isset($theme_generation, $theme_version)) {
 104             $this->setVersion($theme_generation . '.' . $theme_version);
 105         }
 106         $this->setName($theme_name);
 107
 108         return true;
 109     }
 110
 111     /**
 112      * returns theme object loaded from given folder
 113      * or false if theme is invalid
 114      *
 115      * @static
 116      * @access  public
 117      * @uses    PMA_Theme
 118      * @uses    PMA_Theme::setPath()
 119      * @uses    PMA_Theme::loadInfo()
 120      * @uses    PMA_Theme::checkImgPath()
 121      * @param   string  $folder path to theme
 122      * @return  object  PMA_Theme
 123      */
 124     static public function load($folder)
 125     {
 126         $theme = new PMA_Theme();
 127
 128         $theme->setPath($folder);
 129
 130         if (! $theme->loadInfo()) {
 131             return false;
 132         }
 133
 134         $theme->checkImgPath();
 135
 136         return $theme;
 137     }
 138
 139     /**
 140      * checks image path for existance - if not found use img from original theme
 141      *
 142      * @access  public
 143      * @uses    PMA_Theme::getPath()
 144      * @uses    PMA_Theme::setImgPath()
 145      * @uses    PMA_Theme::getName()
 146      * @uses    $GLOBALS['cfg']['ThemePath']
 147      * @uses    is_dir()
 148      * @uses    sprintf()
 149      */
 150     function checkImgPath()
 151     {
 152         if (is_dir($this->getPath() . '/img/')) {
 153             $this->setImgPath($this->getPath() . '/img/');
 154             return true;
 155         } elseif (is_dir($GLOBALS['cfg']['ThemePath'] . '/original/img/')) {
 156             $this->setImgPath($GLOBALS['cfg']['ThemePath'] . '/original/img/');
 157             return true;
 158         } else {
 159             trigger_error(
 160                 sprintf(__('No valid image path for theme %s found!'), $this->getName()),
 161                 E_USER_ERROR);
 162             return false;
 163         }
 164     }
 165
 166     /**
 167      * returns path to theme
 168      *
 169      * @access  public
 170      * @uses    PMA_Theme::$path    as return value
 171      * @return  string  $path   path to theme
 172      */
 173     function getPath()
 174     {
 175         return $this->path;
 176     }
 177
 178     /**
 179      * returns layout file
 180      *
 181      * @access  public
 182      * @uses    PMA_Theme::getPath()
 183      * @return  string  layout file
 184      */
 185     function getLayoutFile()
 186     {
 187         return $this->getPath() . '/layout.inc.php';
 188     }
 189
 190     /**
 191      * set path to theme
 192      *
 193      * @access  public
 194      * @uses    PMA_Theme::$path    to set it
 195      * @param   string  $path   path to theme
 196      */
 197     function setPath($path)
 198     {
 199         $this->path = trim($path);
 200     }
 201
 202     /**
 203      * sets version
 204      *
 205      * @access  public
 206      * @uses    PMA_Theme::$version
 207      * @param   string new version
 208      */
 209     function setVersion($version)
 210     {
 211         $this->version = trim($version);
 212     }
 213
 214     /**
 215      * returns version
 216      *
 217      * @access  public
 218      * @uses    PMA_Theme::$version
 219      * @return  string  version
 220      */
 221     function getVersion()
 222     {
 223         return $this->version;
 224     }
 225
 226     /**
 227      * checks theme version agaisnt $version
 228      * returns true if theme version is equal or higher to $version
 229      *
 230      * @access  public
 231      * @uses    version_compare()
 232      * @uses    PMA_Theme::getVersion()
 233      * @param   string  $version    version to compare to
 234      * @return  boolean
 235      */
 236     function checkVersion($version)
 237     {
 238         return version_compare($this->getVersion(), $version, 'lt');
 239     }
 240
 241     /**
 242      * sets name
 243      *
 244      * @access  public
 245      * @uses    PMA_Theme::$name to set it
 246      * @uses    trim()
 247      * @param   string  $name   new name
 248      */
 249     function setName($name)
 250     {
 251         $this->name = trim($name);
 252     }
 253
 254     /**
 255      * returns name
 256      *
 257      * @access  public
 258      * @uses    PMA_Theme::$name    as return value
 259      * @return  string name
 260      */
 261     function getName()
 262     {
 263         return $this->name;
 264     }
 265
 266     /**
 267      * sets id
 268      *
 269      * @access  public
 270      * @uses    PMA_Theme::$id to set it
 271      * @param   string  $id   new id
 272      */
 273     function setId($id)
 274     {
 275         $this->id = trim($id);
 276     }
 277
 278     /**
 279      * returns id
 280      *
 281      * @access  public
 282      * @uses    PMA_Theme::$id as return value
 283      * @return  string  id
 284      */
 285     function getId()
 286     {
 287         return $this->id;
 288     }
 289
 290     /**
 291      * @access  public
 292      * @uses    PMA_Theme::$img_path to set it
 293      * @param   string  path to images for this theme
 294      */
 295     function setImgPath($path)
 296     {
 297         $this->img_path = $path;
 298     }
 299
 300     /**
 301      * @access  public
 302      * @uses    PMA_Theme::$img_path as retunr value
 303      * @return  string image path for this theme
 304      */
 305     function getImgPath()
 306     {
 307         return $this->img_path;
 308     }
 309
 310     /**
 311      * load css (send to stdout, normally the browser)
 312      *
 313      * @access  public
 314      * @uses    PMA_Theme::getPath()
 315      * @uses    PMA_Theme::$types
 316      * @uses    PMA_SQP_buildCssData()
 317      * @uses    file_exists()
 318      * @uses    in_array()
 319      * @param   string  $type   left, right or print
 320      */
 321     function loadCss(&$type)
 322     {
 323         if (empty($type) || ! in_array($type, $this->types)) {
 324             $type = 'left';
 325         }
 326
 327         if ($type == 'right') {
 328             echo PMA_SQP_buildCssData();
 329         }
 330
 331         $_css_file = $this->getPath()
 332                    . '/css/theme_' . $type . '.css.php';
 333
 334         if (! file_exists($_css_file)) {
 335             return false;
 336         }
 337
 338         if ($GLOBALS['text_dir'] === 'ltr') {
 339             $right = 'right';
 340             $left = 'left';
 341         } else {
 342             $right = 'left';
 343             $left = 'right';
 344         }
 345
 346         include $_css_file;
 347         return true;
 348     }
 349
 350     /**
 351      * prints out the preview for this theme
 352      *
 353      * @access  public
 354      * @uses    PMA_Theme::getName()
 355      * @uses    PMA_Theme::getVersion()
 356      * @uses    PMA_Theme::getId()
 357      * @uses    PMA_Theme::getPath()
 358      * @uses    PMA_generate_common_url()
 359      * @uses    addslashes()
 360      * @uses    file_exists()
 361      * @uses    htmlspecialchars()
 362      */
 363     function printPreview()
 364     {
 365         echo '<div class="theme_preview">';
 366         echo '<h2>' . htmlspecialchars($this->getName())
 367             .' (' . htmlspecialchars($this->getVersion()) . ')</h2>'
 368             .'<p>'
 369             .'<a target="_top" href="index.php'
 370             .PMA_generate_common_url(array('set_theme' => $this->getId())) . '"'
 371             .' onclick="takeThis(\'' . addslashes($this->getId()) . '\');'
 372             .' return false;">';
 373         if (@file_exists($this->getPath() . '/screen.png')) {
 374             // if screen exists then output
 375
 376             echo '<img src="' . $this->getPath() . '/screen.png" border="1"'
 377                 .' alt="' . htmlspecialchars($this->getName()) . '"'
 378                 .' title="' . htmlspecialchars($this->getName()) . '" /><br />';
 379         } else {
 380             echo __('No preview available.');
 381         }
 382
 383         echo '[ <strong>' . __('take it') . '</strong> ]</a>'
 384             .'</p>'
 385             .'</div>';
 386     }
 387 }
 388 ?>