libraries/Theme.class.php

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