phpmyadmin/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 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * handles theme
  14  *
  15  * @todo add the possibility to make a theme depend on another theme
  16  * and by default on original
  17  * @todo make all components optional - get missing components from 'parent' theme
  18  *
  19  * @package PhpMyAdmin
  20  */
  21 class PMA_Theme
  22 {
  23     /**
  24      * @var string theme version
  25      * @access  protected
  26      */
  27     var $version = '0.0.0.0';
  28
  29     /**
  30      * @var string theme name
  31      * @access  protected
  32      */
  33     var $name = '';
  34
  35     /**
  36      * @var string theme id
  37      * @access  protected
  38      */
  39     var $id = '';
  40
  41     /**
  42      * @var string theme path
  43      * @access  protected
  44      */
  45     var $path = '';
  46
  47     /**
  48      * @var string image path
  49      * @access  protected
  50      */
  51     var $img_path = '';
  52
  53     /**
  54      * @var integer last modification time for info file
  55      * @access  protected
  56      */
  57     var $mtime_info = 0;
  58
  59     /**
  60      * needed because sometimes, the mtime for different themes
  61      * is identical
  62      * @var integer filesize for info file
  63      * @access  protected
  64      */
  65     var $filesize_info = 0;
  66
  67     /**
  68      * @var array List of css files to load
  69      * @access private
  70      */
  71     private $_cssFiles = array(
  72         'common',
  73         'enum_editor',
  74         'gis',
  75         'navigation',
  76         'pmd',
  77         'rte',
  78         'codemirror',
  79         'jqplot',
  80         'resizable-menu'
  81     );
  82
  83     /**
  84      * Loads theme information
  85      *
  86      * @return boolean whether loading them info was successful or not
  87      * @access  public
  88      */
  89     function loadInfo()
  90     {
  91         if (! file_exists($this->getPath() . '/info.inc.php')) {
  92             return false;
  93         }
  94
  95         if ($this->mtime_info === filemtime($this->getPath() . '/info.inc.php')) {
  96             return true;
  97         }
  98
  99         @include $this->getPath() . '/info.inc.php';
 100
 101         // was it set correctly?
 102         if (! isset($theme_name)) {
 103             return false;
 104         }
 105
 106         $this->mtime_info = filemtime($this->getPath() . '/info.inc.php');
 107         $this->filesize_info = filesize($this->getPath() . '/info.inc.php');
 108
 109         if (isset($theme_full_version)) {
 110             $this->setVersion($theme_full_version);
 111         } elseif (isset($theme_generation, $theme_version)) {
 112             $this->setVersion($theme_generation . '.' . $theme_version);
 113         }
 114         $this->setName($theme_name);
 115
 116         return true;
 117     }
 118
 119     /**
 120      * returns theme object loaded from given folder
 121      * or false if theme is invalid
 122      *
 123      * @param string $folder path to theme
 124      *
 125      * @return object PMA_Theme
 126      * @static
 127      * @access public
 128      */
 129     static public function load($folder)
 130     {
 131         $theme = new PMA_Theme();
 132
 133         $theme->setPath($folder);
 134
 135         if (! $theme->loadInfo()) {
 136             return false;
 137         }
 138
 139         $theme->checkImgPath();
 140
 141         return $theme;
 142     }
 143
 144     /**
 145      * checks image path for existance - if not found use img from fallback theme
 146      *
 147      * @access public
 148      * @return bool
 149      */
 150     public function checkImgPath()
 151     {
 152         // try current theme first
 153         if (is_dir($this->getPath() . '/img/')) {
 154             $this->setImgPath($this->getPath() . '/img/');
 155             return true;
 156         }
 157
 158         // try fallback theme
 159         $fallback = $GLOBALS['cfg']['ThemePath'] . '/'
 160             . PMA_Theme_Manager::FALLBACK_THEME
 161             . '/img/';
 162         if (is_dir($fallback)) {
 163             $this->setImgPath($fallback);
 164             return true;
 165         }
 166
 167         // we failed
 168         trigger_error(
 169             sprintf(
 170                 __('No valid image path for theme %s found!'),
 171                 $this->getName()
 172             ),
 173             E_USER_ERROR
 174         );
 175         return false;
 176     }
 177
 178     /**
 179      * returns path to theme
 180      *
 181      * @access public
 182      * @return string path to theme
 183      */
 184     public function getPath()
 185     {
 186         return $this->path;
 187     }
 188
 189     /**
 190      * returns layout file
 191      *
 192      * @access public
 193      * @return string layout file
 194      */
 195     public function getLayoutFile()
 196     {
 197         return $this->getPath() . '/layout.inc.php';
 198     }
 199
 200     /**
 201      * set path to theme
 202      *
 203      * @param string $path path to theme
 204      *
 205      * @return void
 206      * @access public
 207      */
 208     public function setPath($path)
 209     {
 210         $this->path = trim($path);
 211     }
 212
 213     /**
 214      * sets version
 215      *
 216      * @param string $version version to set
 217      *
 218      * @return void
 219      * @access public
 220      */
 221     public function setVersion($version)
 222     {
 223         $this->version = trim($version);
 224     }
 225
 226     /**
 227      * returns version
 228      *
 229      * @return string version
 230      * @access public
 231      */
 232     public function getVersion()
 233     {
 234         return $this->version;
 235     }
 236
 237     /**
 238      * checks theme version agaisnt $version
 239      * returns true if theme version is equal or higher to $version
 240      *
 241      * @param string $version version to compare to
 242      *
 243      * @return boolean true if theme version is equal or higher to $version
 244      * @access public
 245      */
 246     public function checkVersion($version)
 247     {
 248         return version_compare($this->getVersion(), $version, 'lt');
 249     }
 250
 251     /**
 252      * sets name
 253      *
 254      * @param string $name name to set
 255      *
 256      * @return void
 257      * @access public
 258      */
 259     public function setName($name)
 260     {
 261         $this->name = trim($name);
 262     }
 263
 264     /**
 265      * returns name
 266      *
 267      * @access  public
 268      * @return string name
 269      */
 270     public function getName()
 271     {
 272         return $this->name;
 273     }
 274
 275     /**
 276      * sets id
 277      *
 278      * @param string $id new id
 279      *
 280      * @return void
 281      * @access public
 282      */
 283     public function setId($id)
 284     {
 285         $this->id = trim($id);
 286     }
 287
 288     /**
 289      * returns id
 290      *
 291      * @return string id
 292      * @access public
 293      */
 294     public function getId()
 295     {
 296         return $this->id;
 297     }
 298
 299     /**
 300      * Sets path to images for the theme
 301      *
 302      * @param string $path path to images for this theme
 303      *
 304      * @return void
 305      * @access public
 306      */
 307     public function setImgPath($path)
 308     {
 309         $this->img_path = $path;
 310     }
 311
 312     /**
 313      * Returns the path to image for the theme.
 314      * If filename is given, it possibly fallbacks to fallback
 315      * theme for it if image does not exist.
 316      *
 317      * @param string $file file name for image
 318      *
 319      * @access public
 320      * @return string image path for this theme
 321      */
 322     public function getImgPath($file = null)
 323     {
 324         if (is_null($file)) {
 325             return $this->img_path;
 326         } else {
 327             if (is_readable($this->img_path . $file)) {
 328                 return $this->img_path . $file;
 329             } else {
 330                 return $GLOBALS['cfg']['ThemePath'] . '/'
 331                     . PMA_Theme_Manager::FALLBACK_THEME . '/img/' . $file;
 332             }
 333         }
 334     }
 335
 336     /**
 337      * Builds a CSS rule used for html formatted SQL queries
 338      *
 339      * @param string $classname The class name
 340      * @param string $property  The property name
 341      * @param string $value     The property value
 342      *
 343      * @return string  The CSS rule
 344      *
 345      * @access public
 346      *
 347      * @see    PMA_SQP_buildCssData()
 348      */
 349     public function buildSQPCssRule($classname, $property, $value)
 350     {
 351         $str     = '.' . $classname . ' {';
 352         if ($value != '') {
 353             $str .= $property . ': ' . $value . ';';
 354         }
 355         $str     .= '}' . "\n";
 356
 357         return $str;
 358     } // end of the "PMA_SQP_buildCssRule()" function
 359
 360
 361     /**
 362      * Builds CSS rules used for html formatted SQL queries
 363      *
 364      * @return string  The CSS rules set
 365      *
 366      * @access public
 367      *
 368      * @global array   The current PMA configuration
 369      *
 370      * @see    PMA_SQP_buildCssRule()
 371      */
 372     public function buildSQPCssData()
 373     {
 374         global $cfg;
 375
 376         $css_string     = '';
 377         foreach ($cfg['SQP']['fmtColor'] AS $key => $col) {
 378             $css_string .= $this->buildSQPCssRule('syntax_' . $key, 'color', $col);
 379         }
 380
 381         for ($i = 0; $i < 8; $i++) {
 382             $css_string .= $this->buildSQPCssRule(
 383                 'syntax_indent' . $i, 'margin-left',
 384                 ($i * $cfg['SQP']['fmtInd']) . $cfg['SQP']['fmtIndUnit']
 385             );
 386         }
 387
 388         return $css_string;
 389     } // end of the "PMA_SQP_buildCssData()" function
 390
 391     /**
 392      * load css (send to stdout, normally the browser)
 393      *
 394      * @return bool
 395      * @access  public
 396      */
 397     public function loadCss()
 398     {
 399         $success = true;
 400
 401         echo $this->buildSQPCssData();
 402
 403         if ($GLOBALS['text_dir'] === 'ltr') {
 404             $right = 'right';
 405             $left = 'left';
 406         } else {
 407             $right = 'left';
 408             $left = 'right';
 409         }
 410
 411         foreach ($this->_cssFiles as $file) {
 412             $path = $this->getPath() . "/css/$file.css.php";
 413             $fallback = "./themes/"
 414                 . PMA_Theme_Manager::FALLBACK_THEME .  "/css/$file.css.php";
 415
 416             if (is_readable($path)) {
 417                 echo "\n/* FILE: $file.css.php */\n";
 418                 include $path;
 419             } else if (is_readable($fallback)) {
 420                 echo "\n/* FILE: $file.css.php */\n";
 421                 include $fallback;
 422             } else {
 423                 $success = false;
 424             }
 425         }
 426
 427         include './themes/sprites.css.php';
 428
 429         return $success;
 430     }
 431
 432     /**
 433      * Renders the preview for this theme
 434      *
 435      * @return string
 436      * @access public
 437      */
 438     public function getPrintPreview()
 439     {
 440         $url_params = array('set_theme' => $this->getId());
 441         $url = 'index.php'. PMA_generate_common_url($url_params);
 442
 443         $retval  = '<div class="theme_preview">';
 444         $retval .= '<h2>';
 445         $retval .= htmlspecialchars($this->getName());
 446         $retval .= ' (' . htmlspecialchars($this->getVersion()) . ') ';
 447         $retval .= '</h2>';
 448         $retval .= '<p>';
 449         $retval .= '<a class="take_theme" ';
 450         $retval .= 'name="' . htmlspecialchars($this->getId()) . '" ';
 451         $retval .=  'href="' . $url . '">';
 452         if (@file_exists($this->getPath() . '/screen.png')) {
 453             // if screen exists then output
 454             $retval .= '<img src="' . $this->getPath() . '/screen.png" border="1"';
 455             $retval .= ' alt="' . htmlspecialchars($this->getName()) . '"';
 456             $retval .= ' title="' . htmlspecialchars($this->getName()) . '" />';
 457             $retval .= '<br />';
 458         } else {
 459             $retval .= __('No preview available.');
 460         }
 461         $retval .= '[ <strong>' . __('take it') . '</strong> ]';
 462         $retval .= '</a>';
 463         $retval .= '</p>';
 464         $retval .= '</div>';
 465         return $retval;
 466     }
 467
 468     /**
 469      * Remove filter for IE.
 470      *
 471      * @return string CSS code.
 472      */
 473     function getCssIEClearFilter()
 474     {
 475         return PMA_USR_BROWSER_AGENT == 'IE'
 476             && PMA_USR_BROWSER_VER >= 6
 477             && PMA_USR_BROWSER_VER <= 8
 478             ? 'filter: none'
 479             : '';
 480     }
 481
 482     /**
 483      * Gets currently configured font size.
 484      *
 485      * @return String with font size.
 486      */
 487     function getFontSize()
 488     {
 489         $fs = $GLOBALS['PMA_Config']->get('fontsize');
 490         if (!is_null($fs)) {
 491             return $fs;
 492         }
 493         if (isset($_COOKIE['pma_fontsize'])) {
 494             return $_COOKIE['pma_fontsize'];
 495         }
 496         return '82%';
 497     }
 498
 499     /**
 500      * Generates code for CSS gradient using various browser extensions.
 501      *
 502      * @param string $start_color Color of gradient start, hex value without #
 503      * @param string $end_color   Color of gradient end, hex value without #
 504      *
 505      * @return string CSS code.
 506      */
 507     function getCssGradient($start_color, $end_color)
 508     {
 509         $result = array();
 510         // Opera 9.5+, IE 9
 511         $result[] = 'background-image: url(./themes/svg_gradient.php?from='
 512             . $start_color . '&to=' . $end_color . ');';
 513         $result[] = 'background-size: 100% 100%;';
 514         // Safari 4-5, Chrome 1-9
 515         $result[] = 'background: '
 516             . '-webkit-gradient(linear, left top, left bottom, from(#'
 517             . $start_color . '), to(#' . $end_color . '));';
 518         // Safari 5.1, Chrome 10+
 519         $result[] = 'background: -webkit-linear-gradient(top, #'
 520             . $start_color . ', #' . $end_color . ');';
 521         // Firefox 3.6+
 522         $result[] = 'background: -moz-linear-gradient(top, #'
 523             . $start_color . ', #' . $end_color . ');';
 524         // IE 10
 525         $result[] = 'background: -ms-linear-gradient(top, #'
 526             . $start_color . ', #' . $end_color . ');';
 527         // Opera 11.10
 528         $result[] = 'background: -o-linear-gradient(top, #'
 529             . $start_color . ', #' . $end_color . ');';
 530         // IE 6-8
 531         if (PMA_USR_BROWSER_AGENT == 'IE'
 532             && PMA_USR_BROWSER_VER >= 6
 533             && PMA_USR_BROWSER_VER <= 8
 534         ) {
 535             $result[] = 'filter: '
 536                 . 'progid:DXImageTransform.Microsoft.gradient(startColorstr="#'
 537                 . $start_color . '", endColorstr="#' . $end_color . '");';
 538         }
 539         return implode("\n", $result);
 540     }
 541
 542     /**
 543      * Returns CSS styles for CodeMirror editor based on query formatter colors.
 544      *
 545      * @return string CSS code.
 546      */
 547     function getCssCodeMirror()
 548     {
 549         if (! $GLOBALS['cfg']['CodemirrorEnable']) {
 550             return '';
 551         }
 552
 553         $result[] = 'span.cm-keyword, span.cm-statement-verb {';
 554         $result[] = '    color: '
 555             . $GLOBALS['cfg']['SQP']['fmtColor']['alpha_reservedWord'] . ';';
 556         $result[] = '}';
 557         $result[] = 'span.cm-variable {';
 558         $result[] = '    color: '
 559             . $GLOBALS['cfg']['SQP']['fmtColor']['alpha_identifier'] . ';';
 560         $result[] = '}';
 561         $result[] = 'span.cm-comment {';
 562         $result[] = '    color: '
 563             . $GLOBALS['cfg']['SQP']['fmtColor']['comment'] . ';';
 564         $result[] = '}';
 565         $result[] = 'span.cm-mysql-string {';
 566         $result[] = '    color: '
 567             . $GLOBALS['cfg']['SQP']['fmtColor']['quote'] . ';';
 568         $result[] = '}';
 569         $result[] = 'span.cm-operator {';
 570         $result[] = '    color: '
 571             . $GLOBALS['cfg']['SQP']['fmtColor']['punct'] . ';';
 572         $result[] = '}';
 573         $result[] = 'span.cm-mysql-word {';
 574         $result[] = '    color: '
 575             . $GLOBALS['cfg']['SQP']['fmtColor']['alpha_identifier'] . ';';
 576         $result[] = '}';
 577         $result[] = 'span.cm-builtin {';
 578         $result[] = '    color: '
 579             . $GLOBALS['cfg']['SQP']['fmtColor']['alpha_functionName'] . ';';
 580         $result[] = '}';
 581         $result[] = 'span.cm-variable-2 {';
 582         $result[] = '    color: '
 583             . $GLOBALS['cfg']['SQP']['fmtColor']['alpha_columnType'] . ';';
 584         $result[] = '}';
 585         $result[] = 'span.cm-variable-3 {';
 586         $result[] = '    color: '
 587             . $GLOBALS['cfg']['SQP']['fmtColor']['alpha_columnAttrib'] . ';';
 588         $result[] = '}';
 589         $result[] = 'span.cm-separator {';
 590         $result[] = '    color: '
 591             . $GLOBALS['cfg']['SQP']['fmtColor']['punct'] . ';';
 592         $result[] = '}';
 593         $result[] = 'span.cm-number {';
 594         $result[] = '    color: '
 595             . $GLOBALS['cfg']['SQP']['fmtColor']['digit_integer'] . ';';
 596         $result[] = '}';
 597
 598         return implode("\n", $result);
 599     }
 600 }
 601 ?>