include/SugarTheme/SugarTheme.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 /*********************************************************************************
  40
  41  * Description:  Contains a variety of utility functions used to display UI
  42  * components such as form headers and footers.  Intended to be modified on a per
  43  * theme basis.
  44  ********************************************************************************/
  45
  46 if(!defined('JSMIN_AS_LIB'))
  47     define('JSMIN_AS_LIB', true);
  48
  49 require_once("include/SugarTheme/cssmin.php");
  50 require_once("jssource/jsmin.php");
  51 require_once('include/utils/sugar_file_utils.php');
  52
  53 /**
  54  * Class that provides tools for working with a theme.
  55  * @api
  56  */
  57 class SugarTheme
  58 {
  59     /**
  60      * Theme name
  61      *
  62      * @var string
  63      */
  64     protected $name;
  65
  66     /**
  67      * Theme description
  68      *
  69      * @var string
  70      */
  71     protected $description;
  72
  73     /**
  74      * Defines which parent files to not include
  75      *
  76      * @var string
  77      */
  78     protected $ignoreParentFiles = array();
  79
  80     /**
  81      * Defines which parent files to not include
  82      *
  83      * @var string
  84      */
  85     public $directionality = 'ltr';
  86     /**
  87      * Theme directory name
  88      *
  89      * @var string
  90      */
  91     protected $dirName;
  92
  93     /**
  94      * Parent theme name
  95      *
  96      * @var string
  97      */
  98     protected $parentTheme;
  99
 100     /**
 101      * Colors sets provided by the theme
 102      *
 103      * @deprecated only here for BC during upgrades
 104      * @var array
 105      */
 106     protected $colors = array();
 107
 108     /**
 109      * Font sets provided by the theme
 110      *
 111      * @deprecated only here for BC during upgrades
 112      * @var array
 113      */
 114     protected $fonts  = array();
 115
 116     /**
 117      * Maximum sugar version this theme is for; defaults to 5.5.1 as all the themes without this
 118      * parameter as assumed to work thru 5.5.1
 119      *
 120      * @var int
 121      */
 122     protected $version = '5.5.1';
 123
 124     /**
 125      * Colors used in bar charts
 126      *
 127      * @var array
 128      */
 129     protected $barChartColors = array(
 130         "docBorder"             => "0xffffff",
 131         "docBg1"                => "0xffffff",
 132         "docBg2"                => "0xffffff",
 133         "xText"                 => "0x33485c",
 134         "yText"                 => "0x33485c",
 135         "title"                 => "0x333333",
 136         "misc"                  => "0x999999",
 137         "altBorder"             => "0xffffff",
 138         "altBg"                 => "0xffffff",
 139         "altText"               => "0x666666",
 140         "graphBorder"           => "0xcccccc",
 141         "graphBg1"              => "0xf6f6f6",
 142         "graphBg2"              => "0xf6f6f6",
 143         "graphLines"            => "0xcccccc",
 144         "graphText"             => "0x333333",
 145         "graphTextShadow"       => "0xf9f9f9",
 146         "barBorder"             => "0xeeeeee",
 147         "barBorderHilite"       => "0x333333",
 148         "legendBorder"          => "0xffffff",
 149         "legendBg1"             => "0xffffff",
 150         "legendBg2"             => "0xffffff",
 151         "legendText"            => "0x444444",
 152         "legendColorKeyBorder"  => "0x777777",
 153         "scrollBar"             => "0xcccccc",
 154         "scrollBarBorder"       => "0xeeeeee",
 155         "scrollBarTrack"        => "0xeeeeee",
 156         "scrollBarTrackBorder"  => "0xcccccc",
 157         );
 158
 159     /**
 160      * Colors used in pie charts
 161      *
 162      * @var array
 163      */
 164     protected $pieChartColors = array(
 165         "docBorder"             => "0xffffff",
 166         "docBg1"                => "0xffffff",
 167         "docBg2"                => "0xffffff",
 168         "title"                 => "0x333333",
 169         "subtitle"              => "0x666666",
 170         "misc"                  => "0x999999",
 171         "altBorder"             => "0xffffff",
 172         "altBg"                 => "0xffffff",
 173         "altText"               => "0x666666",
 174         "graphText"             => "0x33485c",
 175         "graphTextShadow"       => "0xf9f9f9",
 176         "pieBorder"             => "0xffffff",
 177         "pieBorderHilite"       => "0x333333",
 178         "legendBorder"          => "0xffffff",
 179         "legendBg1"             => "0xffffff",
 180         "legendBg2"             => "0xffffff",
 181         "legendText"            => "0x444444",
 182         "legendColorKeyBorder"  => "0x777777",
 183         "scrollBar"             => "0xdfdfdf",
 184         "scrollBarBorder"       => "0xfafafa",
 185         "scrollBarTrack"        => "0xeeeeee",
 186         "scrollBarTrackBorder"  => "0xcccccc",
 187         );
 188
 189     /**
 190      * Does this theme support group tabs
 191      *
 192      * @var bool
 193      */
 194     public $group_tabs;
 195
 196
 197     /**
 198      * Cache built of all css files locations
 199      *
 200      * @var array
 201      */
 202     private $_cssCache = array();
 203
 204     /**
 205      * Cache built of all image files locations
 206      *
 207      * @var array
 208      */
 209     private $_imageCache = array();
 210
 211     /**
 212      * Cache built of all javascript files locations
 213      *
 214      * @var array
 215      */
 216     private $_jsCache = array();
 217
 218     /**
 219      * Cache built of all template files locations
 220      *
 221      * @var array
 222      */
 223     private $_templateCache = array();
 224
 225         /**
 226          * Cache built of sprite meta data
 227          *
 228          * @var array
 229          */
 230         private $_spriteCache = array();
 231
 232     /**
 233      * Size of the caches after the are initialized in the constructor
 234      *
 235      * @var array
 236      */
 237     private $_initialCacheSize = array(
 238         'cssCache'      => 0,
 239         'imageCache'    => 0,
 240         'jsCache'       => 0,
 241         'templateCache' => 0,
 242                 'spriteCache'   => 0,
 243         );
 244
 245     /**
 246      * Controls whether or not to clear the cache on destroy; defaults to false
 247      */
 248     private $_clearCacheOnDestroy = false;
 249
 250     private $imageExtensions = array(
 251             'gif',
 252             'png',
 253             'jpg',
 254             'tif',
 255             'bmp',
 256     );
 257
 258     /**
 259      * Constructor
 260      *
 261      * Sets the theme properties from the defaults passed to it, and loads the file path cache from an external cache
 262      *
 263      * @param  $defaults string defaults for the current theme
 264      */
 265     public function __construct(
 266         $defaults
 267         )
 268     {
 269         // apply parent theme's properties first
 270         if ( isset($defaults['parentTheme']) ) {
 271             $themedef = array();
 272             include("themes/{$defaults['parentTheme']}/themedef.php");
 273             foreach ( $themedef as $key => $value ) {
 274                 if ( property_exists(__CLASS__,$key) ) {
 275                     // For all arrays ( except colors and fonts ) you can just specify the items
 276                     // to change instead of all of the values
 277                     if ( is_array($this->$key) && !in_array($key,array('colors','fonts')) )
 278                         $this->$key = array_merge($this->$key,$value);
 279                     else
 280                         $this->$key = $value;
 281                 }
 282             }
 283         }
 284         foreach ( $defaults as $key => $value ) {
 285             if ( property_exists(__CLASS__,$key) ) {
 286                 // For all arrays ( except colors and fonts ) you can just specify the items
 287                 // to change instead of all of the values
 288                 if ( is_array($this->$key) && !in_array($key,array('colors','fonts')) )
 289                     $this->$key = array_merge($this->$key,$value);
 290                 else
 291                     $this->$key = $value;
 292             }
 293         }
 294         if ( !inDeveloperMode() ) {
 295             if ( sugar_is_file($cachedfile = sugar_cached($this->getFilePath().'/pathCache.php'))) {
 296                 $caches = unserialize(file_get_contents($cachedfile));
 297                 if ( isset($caches['jsCache']) )
 298                     $this->_jsCache       = $caches['jsCache'];
 299                 if ( isset($caches['cssCache']) )
 300                     $this->_cssCache      = $caches['cssCache'];
 301                 if ( isset($caches['imageCache']) )
 302                     $this->_imageCache    = $caches['imageCache'];
 303                 if ( isset($caches['templateCache']) )
 304                     $this->_templateCache = $caches['templateCache'];
 305             }
 306             $cachedfile = sugar_cached($this->getFilePath().'/spriteCache.php');
 307                         if(!empty($GLOBALS['sugar_config']['use_sprites']) && sugar_is_file($cachedfile)) {
 308                                 $this->_spriteCache = unserialize(sugar_file_get_contents($cachedfile));
 309                         }
 310         }
 311         $this->_initialCacheSize = array(
 312             'jsCache'       => count($this->_jsCache),
 313             'cssCache'      => count($this->_cssCache),
 314             'imageCache'    => count($this->_imageCache),
 315             'templateCache' => count($this->_templateCache),
 316                         'spriteCache'   => count($this->_spriteCache),
 317             );
 318     }
 319
 320     /**
 321          * This is needed to prevent unserialize vulnerability
 322      */
 323     public function __wakeup()
 324     {
 325         // clean all properties
 326         foreach(get_object_vars($this) as $k => $v) {
 327             $this->$k = null;
 328         }
 329         throw new Exception("Not a serializable object");
 330     }
 331
 332     /**
 333      * Destructor
 334      * Here we'll write out the internal file path caches to an external cache of some sort.
 335      */
 336     public function __destruct()
 337     {
 338         // Bug 28309 - Set the current directory to one which we expect it to be (i.e. the root directory of the install
 339         set_include_path(realpath(dirname(__FILE__) . '/../..') . PATH_SEPARATOR . get_include_path());
 340         chdir(dirname(__FILE__) . '/../..'); // destruct can be called late, and chdir could change
 341         $cachedir = sugar_cached($this->getFilePath());
 342         sugar_mkdir($cachedir, 0775, true);
 343         // clear out the cache on destroy if we are asked to
 344         if ( $this->_clearCacheOnDestroy ) {
 345
 346             if (is_file("$cachedir/pathCache.php"))
 347                 unlink("$cachedir/pathCache.php");
 348                         if (is_file("$cachedir/spriteCache.php"))
 349                                 unlink("$cachedir/spriteCache.php");
 350
 351         }
 352         elseif ( !inDeveloperMode() ) {
 353             // only update the caches if they have been changed in this request
 354             if ( count($this->_jsCache) != $this->_initialCacheSize['jsCache']
 355                     || count($this->_cssCache) != $this->_initialCacheSize['cssCache']
 356                     || count($this->_imageCache) != $this->_initialCacheSize['imageCache']
 357                     || count($this->_templateCache) != $this->_initialCacheSize['templateCache']
 358                 ) {
 359                 sugar_file_put_contents(
 360                     "$cachedir/pathCache.php",
 361                     serialize(
 362                         array(
 363                             'jsCache'       => $this->_jsCache,
 364                             'cssCache'      => $this->_cssCache,
 365                             'imageCache'    => $this->_imageCache,
 366                             'templateCache' => $this->_templateCache,
 367                             )
 368                         )
 369                     );
 370
 371             }
 372                         if ( count($this->_spriteCache) != $this->_initialCacheSize['spriteCache']) {
 373                                 sugar_file_put_contents(
 374                                         "$cachedir/spriteCache.php",
 375                                         serialize($this->_spriteCache)
 376                                 );
 377                         }
 378         }
 379     }
 380
 381     /**
 382      * Specifies what is returned when the object is cast to a string, in this case it will be the
 383      * theme directory name.
 384      *
 385      * @return string theme directory name
 386      */
 387     public function __toString()
 388     {
 389         return $this->dirName;
 390     }
 391
 392     /**
 393      * Generic public accessor method for all the properties of the theme ( which are kept protected )
 394      *
 395      * @return string
 396      */
 397     public function __get(
 398         $key
 399         )
 400     {
 401         if ( isset($this->$key) )
 402             return $this->$key;
 403     }
 404
 405     public function __isset($key){
 406         return isset($this->$key);
 407
 408     }
 409
 410     public function clearJSCache()
 411     {
 412         $this->_jsCache = array();
 413     }
 414
 415     /**
 416      * Clears out the caches used for this themes
 417      */
 418     public function clearCache()
 419     {
 420         $this->_clearCacheOnDestroy = true;
 421     }
 422
 423     /**
 424      * Return array of all valid fields that can be specified in the themedef.php file
 425      *
 426      * @return array
 427      */
 428     public static function getThemeDefFields()
 429     {
 430         return array(
 431             'name',
 432             'description',
 433             'directionality',
 434             'dirName',
 435             'parentTheme',
 436             'version',
 437             'colors',
 438             'fonts',
 439             'barChartColors',
 440             'pieChartColors',
 441             'group_tabs',
 442             'ignoreParentFiles',
 443             );
 444     }
 445
 446     /**
 447      * Returns the file path of the current theme
 448      *
 449      * @return string
 450      */
 451     public function getFilePath()
 452     {
 453         return 'themes/'.$this->dirName;
 454     }
 455
 456     /**
 457      * Returns the image path of the current theme
 458      *
 459      * @return string
 460      */
 461     public function getImagePath()
 462     {
 463         return $this->getFilePath().'/images';
 464     }
 465
 466     /**
 467      * Returns the css path of the current theme
 468      *
 469      * @return string
 470      */
 471     public function getCSSPath()
 472     {
 473         return $this->getFilePath().'/css';
 474     }
 475
 476     /**
 477      * Returns the javascript path of the current theme
 478      *
 479      * @return string
 480      */
 481     public function getJSPath()
 482     {
 483         return $this->getFilePath().'/js';
 484     }
 485
 486     /**
 487      * Returns the tpl path of the current theme
 488      *
 489      * @return string
 490      */
 491     public function getTemplatePath()
 492     {
 493         return $this->getFilePath().'/tpls';
 494     }
 495
 496     /**
 497      * Returns the file path of the theme defaults
 498      *
 499      * @return string
 500      */
 501     public final function getDefaultFilePath()
 502     {
 503         return 'themes/default';
 504     }
 505
 506     /**
 507      * Returns the image path of the theme defaults
 508      *
 509      * @return string
 510      */
 511     public final function getDefaultImagePath()
 512     {
 513         return $this->getDefaultFilePath().'/images';
 514     }
 515
 516     /**
 517      * Returns the css path of the theme defaults
 518      *
 519      * @return string
 520      */
 521     public final function getDefaultCSSPath()
 522     {
 523         return $this->getDefaultFilePath().'/css';
 524     }
 525
 526     /**
 527      * Returns the template path of the theme defaults
 528      *
 529      * @return string
 530      */
 531     public final function getDefaultTemplatePath()
 532     {
 533         return $this->getDefaultFilePath().'/tpls';
 534     }
 535
 536     /**
 537      * Returns the javascript path of the theme defaults
 538      *
 539      * @return string
 540      */
 541     public final function getDefaultJSPath()
 542     {
 543         return $this->getDefaultFilePath().'/js';
 544     }
 545
 546     /**
 547      * Returns CSS for the current theme.
 548      *
 549      * @param  $color string optional, specifies the css color file to use if the theme supports it; defaults to cookie value or theme default
 550      * @param  $font  string optional, specifies the css font file to use if the theme supports it; defaults to cookie value or theme default
 551      * @return string HTML code
 552      */
 553     public function getCSS(
 554         $color = null,
 555         $font = null
 556         )
 557     {
 558         // include style.css file
 559         $html = '<link rel="stylesheet" type="text/css" href="'.$this->getCSSURL('yui.css').'" />';
 560         $html .= '<link rel="stylesheet" type="text/css" href="include/javascript/jquery/themes/base/jquery.ui.all.css" />';
 561         $html .= '<link rel="stylesheet" type="text/css" href="'.$this->getCSSURL('deprecated.css').'" />';
 562         $html .= '<link rel="stylesheet" type="text/css" href="'.$this->getCSSURL('style.css').'" />';
 563
 564                 // sprites
 565                 if(!empty($GLOBALS['sugar_config']['use_sprites']) && $GLOBALS['sugar_config']['use_sprites']) {
 566
 567                         // system wide sprites
 568                         if(file_exists("cache/sprites/default/sprites.css"))
 569                                 $html .= '<link rel="stylesheet" type="text/css" href="cache/sprites/default/sprites.css" />';
 570
 571                         // theme specific sprites
 572                         if(file_exists("cache/sprites/{$this->dirName}/sprites.css"))
 573                                 $html .= '<link rel="stylesheet" type="text/css" href="cache/sprites/'.$this->dirName.'/sprites.css" />';
 574
 575                         // parent sprites
 576                         if($this->parentTheme && $parent = SugarThemeRegistry::get($this->parentTheme)) {
 577                                 if(file_exists("cache/sprites/{$parent->dirName}/sprites.css"))
 578                                         $html .= '<link rel="stylesheet" type="text/css" href="cache/sprites/'.$parent->dirName.'/sprites.css" />';
 579                         }
 580
 581                         // repeatable sprites
 582                         if(file_exists("cache/sprites/Repeatable/sprites.css"))
 583                                 $html .= '<link rel="stylesheet" type="text/css" href="cache/sprites/Repeatable/sprites.css" />';
 584                 }
 585
 586         // for BC during upgrade
 587         if ( !empty($this->colors) ) {
 588             if ( isset($_SESSION['authenticated_user_theme_color']) && in_array($_SESSION['authenticated_user_theme_color'], $this->colors))
 589                 $color = $_SESSION['authenticated_user_theme_color'];
 590             else
 591                 $color = $this->colors[0];
 592             $html .= '<link rel="stylesheet" type="text/css" href="'.$this->getCSSURL('colors.'.$color.'.css').'" id="current_color_style" />';
 593         }
 594
 595         if ( !empty($this->fonts) ) {
 596             if ( isset($_SESSION['authenticated_user_theme_font']) && in_array($_SESSION['authenticated_user_theme_font'], $this->fonts))
 597                 $font = $_SESSION['authenticated_user_theme_font'];
 598             else
 599                 $font = $this->fonts[0];
 600             $html .= '<link rel="stylesheet" type="text/css" href="'.$this->getCSSURL('fonts.'.$font.'.css').'" id="current_font_style" />';
 601         }
 602
 603         return $html;
 604     }
 605
 606     /**
 607      * Returns javascript for the current theme
 608      *
 609      * @return string HTML code
 610      */
 611     public function getJS()
 612     {
 613         $styleJS = $this->getJSURL('style.js');
 614         return <<<EOHTML
 615 <script type="text/javascript" src="$styleJS"></script>
 616 EOHTML;
 617     }
 618
 619     /**
 620      * Returns the path for the tpl file in the current theme. If not found in the current theme, will revert
 621      * to looking in the base theme.
 622      *
 623      * @param  string $templateName tpl file name
 624      * @return string path of tpl file to include
 625      */
 626     public function getTemplate(
 627         $templateName
 628         )
 629     {
 630         if ( isset($this->_templateCache[$templateName]) )
 631             return $this->_templateCache[$templateName];
 632
 633         $templatePath = '';
 634         if (sugar_is_file('custom/'.$this->getTemplatePath().'/'.$templateName))
 635             $templatePath = 'custom/'.$this->getTemplatePath().'/'.$templateName;
 636         elseif (sugar_is_file($this->getTemplatePath().'/'.$templateName))
 637             $templatePath = $this->getTemplatePath().'/'.$templateName;
 638         elseif (isset($this->parentTheme)
 639                 && SugarThemeRegistry::get($this->parentTheme) instanceOf SugarTheme
 640                 && ($filename = SugarThemeRegistry::get($this->parentTheme)->getTemplate($templateName)) != '')
 641             $templatePath = $filename;
 642         elseif (sugar_is_file('custom/'.$this->getDefaultTemplatePath().'/'.$templateName))
 643             $templatePath = 'custom/'.$this->getDefaultTemplatePath().'/'.$templateName;
 644         elseif (sugar_is_file($this->getDefaultTemplatePath().'/'.$templateName))
 645             $templatePath = $this->getDefaultTemplatePath().'/'.$templateName;
 646         else {
 647             $GLOBALS['log']->warn("Template $templateName not found");
 648             return false;
 649         }
 650
 651         $this->_imageCache[$templateName] = $templatePath;
 652
 653         return $templatePath;
 654     }
 655
 656     /**
 657      * Returns an image tag for the given image.
 658      *
 659      * @param  string $image image name
 660      * @param  string $other_attributes optional, other attributes to add to the image tag, not cached
 661          * @param  string $width optional, defaults to the actual image's width
 662          * @param  string $height optional, defaults to the actual image's height
 663          * @param  string $ext optional, image extension (TODO can we deprecate this one ?)
 664      * @param  string $alt optional, only used when image contains something useful, i.e. "Sally's profile pic"
 665      * @return string HTML image tag or sprite
 666      */
 667     public function getImage(
 668         $imageName,
 669         $other_attributes = '',
 670                 $width = null,
 671                 $height = null,
 672                 $ext = null,
 673         $alt = ''
 674     )
 675     {
 676
 677         static $cached_results = array();
 678
 679                 // trap deprecated use of image extension
 680                 if(is_null($ext)) {
 681                         $imageNameExp = explode('.',$imageName);
 682                         if(count($imageNameExp) == 1)
 683                                 $imageName .= '.gif';
 684                 } else {
 685                         $imageName .= $ext;
 686                 }
 687
 688                 // trap alt attributes in other_attributes
 689                 if(preg_match('/alt=["\']([^\'"]+)["\']/i', $other_attributes))
 690                         $GLOBALS['log']->debug("Sprites: alt attribute detected for $imageName");
 691                 // sprite handler, makes use of own caching mechanism
 692                 if(!empty($GLOBALS['sugar_config']['use_sprites']) && $GLOBALS['sugar_config']['use_sprites']) {
 693                         // get sprite metadata
 694                         if($sp = $this->getSpriteMeta($imageName)) {
 695                                 // requested size should match
 696                                 if( (!is_null($width) && $sp['width'] == $width) || (is_null($width)) &&
 697                                         (!is_null($height) && $sp['height'] == $height) || (is_null($height)) )
 698                                 {
 699                                         if($sprite = $this->getSprite($sp['class'], $other_attributes, $alt))
 700                                                 return $sprite;
 701                                 }
 702                         }
 703                 }
 704
 705                 // img caching
 706                 if(empty($cached_results[$imageName])) {
 707                         $imageURL = $this->getImageURL($imageName,false);
 708                         if ( empty($imageURL) )
 709                                 return false;
 710                 $cached_results[$imageName] = '<img src="'.getJSPath($imageURL).'" ';
 711                 }
 712
 713                 $attr_width = (is_null($width)) ? "" : "width=\"$width\"";
 714                 $attr_height = (is_null($height)) ? "" : "height=\"$height\"";
 715                 return $cached_results[$imageName] . " $attr_width $attr_height $other_attributes alt=\"$alt\" />";
 716     }
 717
 718         /**
 719          * Returns sprite meta data
 720          *
 721          * @param  string $imageName Image filename including extension
 722          * @return array  Sprite meta data
 723          */
 724         public function getSpriteMeta($imageName) {
 725
 726                 // return from cache
 727             if(isset($this->_spriteCache[$imageName]))
 728                         return $this->_spriteCache[$imageName];
 729
 730                         // sprite keys are base on imageURL
 731                 $imageURL = $this->getImageURL($imageName,false);
 732                 if(empty($imageURL)) {
 733                         $this->_spriteCache[$imageName] = false;
 734                         return false;
 735                 }
 736
 737                 // load meta data, includes default images
 738                 require_once("include/SugarTheme/SugarSprites.php");
 739                 $meta = SugarSprites::getInstance();
 740                 // add current theme dir
 741                 $meta->loadSpriteMeta($this->dirName);
 742                 // add parent theme dir
 743                 if($this->parentTheme && $parent = SugarThemeRegistry::get($this->parentTheme)) {
 744                         $meta->loadSpriteMeta($parent->dirName);
 745                 }
 746
 747                 // add to cache
 748                 if(isset($meta->sprites[$imageURL])) {
 749                         $this->_spriteCache[$imageName] = $meta->sprites[$imageURL];
 750                         // add imageURL to cache
 751                         //$this->_spriteCache[$imageName]['imageURL'] = $imageURL;
 752                 } else {
 753                         $this->_spriteCache[$imageName] = false;
 754                         $GLOBALS['log']->debug("Sprites: miss for $imageURL");
 755                 }
 756                 return $this->_spriteCache[$imageName];
 757         }
 758
 759         /**
 760          * Returns sprite HTML span tag
 761          *
 762          * @param  string class The md5 id used in the CSS sprites class
 763          * @param  string attr  optional, list of additional html attributes
 764          * @param  string title optional, the title (equivalent to alt on img)
 765          * @return string HTML span tag
 766          */
 767         public function getSprite($class, $attr, $title) {
 768
 769                 // handle multiple class tags
 770                 $class_regex = '/class=["\']([^\'"]+)["\']/i';
 771                 preg_match($class_regex, $attr, $match);
 772                 if(isset($match[1])) {
 773                         $attr = preg_replace($class_regex, 'class="spr_'.$class.' ${1}"', $attr);
 774
 775                 // single class
 776                 } else {
 777                         $attr .= ' class="spr_'.$class.'"';
 778                 }
 779
 780                 if($title)
 781                         $attr .= ' title="'.$title.'"';
 782
 783                 // use </span> instead of /> to prevent weird UI results
 784                 $GLOBALS['log']->debug("Sprites: generated sprite -> $attr");
 785                 return "<span {$attr}></span>";
 786         }
 787
 788         /**
 789          * Returns a link HTML tag with or without an embedded image
 790          */
 791     public function getLink(
 792                 $url,
 793                 $title,
 794                 $other_attributes = '',
 795         $img_name = '',
 796         $img_other_attributes = '',
 797                 $img_width = null,
 798                 $img_height = null,
 799                 $img_alt = '',
 800                 $img_placement = 'imageonly'
 801     )
 802     {
 803
 804                 if($img_name) {
 805                         $img = $this->getImage($img_name, $img_other_attributes, $img_width, $img_height, null, $img_alt);
 806                         if($img == false) {
 807                                 $GLOBALS['log']->debug('Sprites: unknown image getLink');
 808                                 $img = 'unknown';
 809                         }
 810                         switch($img_placement) {
 811                                 case 'left':    $inner_html = $img."<span class='title'>".$title."</span>"; break;
 812                                 case 'right':   $inner_html = "<span class='title'>".$title."</span>".$img; break;
 813                                 default:                $inner_html = $img; break;
 814                         }
 815                 } else {
 816                         $inner_html = $title;
 817                 }
 818
 819                 return '<a href="'.$url.'" title="'.$title.'" '.$other_attributes.'>'.$inner_html.'</a>';
 820
 821         }
 822
 823     /**
 824      * Returns the URL for an image in the current theme. If not found in the current theme, will revert
 825      * to looking in the base theme.
 826      * @param  string $imageName image file name
 827      * @param  bool   $addJSPath call getJSPath() with the results to add some unique image tracking support
 828      * @return string path to image
 829      */
 830     public function getImageURL(
 831         $imageName,
 832         $addJSPath = true
 833         ){
 834         if ( isset($this->_imageCache[$imageName]) ) {
 835             if ( $addJSPath )
 836                 return getJSPath($this->_imageCache[$imageName]);
 837             else
 838                 return $this->_imageCache[$imageName];
 839         }
 840         $imagePath = '';
 841         if (($filename = $this->_getImageFileName('custom/'.$this->getImagePath().'/'.$imageName)) != '')
 842             $imagePath = $filename;
 843         elseif (($filename = $this->_getImageFileName($this->getImagePath().'/'.$imageName)) != '')
 844             $imagePath = $filename;
 845         elseif (isset($this->parentTheme)
 846                 && SugarThemeRegistry::get($this->parentTheme) instanceOf SugarTheme
 847                 && ($filename = SugarThemeRegistry::get($this->parentTheme)->getImageURL($imageName,false)) != '')
 848             $imagePath = $filename;
 849         elseif (($filename = $this->_getImageFileName('custom/'.$this->getDefaultImagePath().'/'.$imageName)) != '')
 850             $imagePath = $filename;
 851         elseif (($filename = $this->_getImageFileName($this->getDefaultImagePath().'/'.$imageName)) != '')
 852             $imagePath = $filename;
 853                 elseif (($filename = $this->_getImageFileName('include/images/'.$imageName)) != '')
 854                         $imagePath = $filename;
 855         else {
 856             $GLOBALS['log']->warn("Image $imageName not found");
 857             return false;
 858         }
 859
 860         $this->_imageCache[$imageName] = $imagePath;
 861
 862         if ( $addJSPath )
 863             return getJSPath($imagePath);
 864
 865         return $imagePath;
 866     }
 867
 868     /**
 869      * Checks for an image using all of the accepted image extensions
 870      *
 871      * @param  string $imageName image file name
 872      * @return string path to image
 873      */
 874     protected function _getImageFileName(
 875         $imageName
 876         )
 877     {
 878         // return now if the extension matches that of which we are looking for
 879         if ( sugar_is_file($imageName) )
 880             return $imageName;
 881         $pathParts = pathinfo($imageName);
 882         foreach ( $this->imageExtensions as $extension )
 883             if ( isset($pathParts['extension']) )
 884                 if ( ( $extension != $pathParts['extension'] )
 885                         && sugar_is_file($pathParts['dirname'].'/'.$pathParts['filename'].'.'.$extension) )
 886                     return $pathParts['dirname'].'/'.$pathParts['filename'].'.'.$extension;
 887
 888         return '';
 889     }
 890
 891     /**
 892      * Returns the URL for the css file in the current theme. If not found in the current theme, will revert
 893      * to looking in the base theme.
 894      *
 895      * @param  string $cssFileName css file name
 896      * @param  bool   $returnURL if true, returns URL with unique image mark, otherwise returns path to the file
 897      * @return string path of css file to include
 898      */
 899     public function getCSSURL($cssFileName, $returnURL = true)
 900     {
 901         if ( isset($this->_cssCache[$cssFileName]) && sugar_is_file(sugar_cached($this->_cssCache[$cssFileName])) ) {
 902             if ( $returnURL )
 903                 return getJSPath("cache/".$this->_cssCache[$cssFileName]);
 904             else
 905                 return sugar_cached($this->_cssCache[$cssFileName]);
 906         }
 907
 908         $cssFileContents = '';
 909         $defaultFileName = $this->getDefaultCSSPath().'/'.$cssFileName;
 910         $fullFileName = $this->getCSSPath().'/'.$cssFileName;
 911         if (isset($this->parentTheme)
 912                 && SugarThemeRegistry::get($this->parentTheme) instanceOf SugarTheme
 913                 && ($filename = SugarThemeRegistry::get($this->parentTheme)->getCSSURL($cssFileName,false)) != '')
 914             $cssFileContents .= file_get_contents($filename);
 915         else {
 916             if (sugar_is_file($defaultFileName))
 917                 $cssFileContents .= file_get_contents($defaultFileName);
 918             if (sugar_is_file('custom/'.$defaultFileName))
 919                 $cssFileContents .= file_get_contents('custom/'.$defaultFileName);
 920         }
 921         if (sugar_is_file($fullFileName)) {
 922             $cssFileContents .= file_get_contents($fullFileName);
 923         }
 924         if (sugar_is_file('custom/'.$fullFileName)) {
 925             $cssFileContents .= file_get_contents('custom/'.$fullFileName);
 926         }
 927         if (empty($cssFileContents)) {
 928             $GLOBALS['log']->warn("CSS File $cssFileName not found");
 929             return false;
 930         }
 931
 932         // fix any image references that may be defined in css files
 933         $cssFileContents = str_ireplace("entryPoint=getImage&",
 934             "entryPoint=getImage&themeName={$this->dirName}&",
 935             $cssFileContents);
 936
 937         // create the cached file location
 938         $cssFilePath = create_cache_directory($fullFileName);
 939
 940         // if this is the style.css file, prepend the base.css and calendar-win2k-cold-1.css
 941         // files before the theme styles
 942         if ( $cssFileName == 'style.css' && !isset($this->parentTheme) ) {
 943             if ( inDeveloperMode() )
 944                 $cssFileContents = file_get_contents('include/javascript/yui/build/base/base.css') . $cssFileContents;
 945             else
 946                 $cssFileContents = file_get_contents('include/javascript/yui/build/base/base-min.css') . $cssFileContents;
 947         }
 948
 949         // minify the css
 950         if ( !inDeveloperMode() && !sugar_is_file($cssFilePath) ) {
 951             $cssFileContents = cssmin::minify($cssFileContents);
 952         }
 953
 954         // now write the css to cache
 955         sugar_file_put_contents($cssFilePath,$cssFileContents);
 956
 957         $this->_cssCache[$cssFileName] = $fullFileName;
 958
 959         if ( $returnURL )
 960             return getJSPath("cache/".$fullFileName);
 961
 962         return sugar_cached($fullFileName);
 963     }
 964
 965     /**
 966      * Returns the URL for an image in the current theme. If not found in the current theme, will revert
 967      * to looking in the base theme.
 968      *
 969      * @param  string $jsFileName js file name
 970      * @param  bool   $returnURL if true, returns URL with unique image mark, otherwise returns path to the file
 971      * @return string path to js file
 972      */
 973     public function getJSURL($jsFileName, $returnURL = true)
 974     {
 975         if ( isset($this->_jsCache[$jsFileName]) && sugar_is_file(sugar_cached($this->_jsCache[$jsFileName])) ) {
 976             if ( $returnURL )
 977                 return getJSPath("cache/".$this->_jsCache[$jsFileName]);
 978             else
 979                 return sugar_cached($this->_jsCache[$jsFileName]);
 980         }
 981
 982         $jsFileContents = '';
 983         $fullFileName = $this->getJSPath().'/'.$jsFileName;
 984         $defaultFileName = $this->getDefaultJSPath().'/'.$jsFileName;
 985         if (isset($this->parentTheme)
 986                 && SugarThemeRegistry::get($this->parentTheme) instanceOf SugarTheme
 987                 && ($filename = SugarThemeRegistry::get($this->parentTheme)->getJSURL($jsFileName,false)) != ''    && !in_array($jsFileName,$this->ignoreParentFiles)) {
 988            $jsFileContents .= file_get_contents($filename);
 989        } else {
 990             if (sugar_is_file($defaultFileName))
 991                 $jsFileContents .= file_get_contents($defaultFileName);
 992             if (sugar_is_file('custom/'.$defaultFileName))
 993                 $jsFileContents .= file_get_contents('custom/'.$defaultFileName);
 994         }
 995         if (sugar_is_file($fullFileName))
 996             $jsFileContents .= file_get_contents($fullFileName);
 997         if (sugar_is_file('custom/'.$fullFileName))
 998             $jsFileContents .= file_get_contents('custom/'.$fullFileName);
 999         if (empty($jsFileContents)) {
1000             $GLOBALS['log']->warn("Javascript File $jsFileName not found");
1001             return false;
1002         }
1003
1004         // create the cached file location
1005         $jsFilePath = create_cache_directory($fullFileName);
1006
1007         // minify the js
1008         if ( !inDeveloperMode()&& !sugar_is_file(str_replace('.js','-min.js',$jsFilePath)) ) {
1009             $jsFileContents = SugarMin::minify($jsFileContents);
1010             $jsFilePath = str_replace('.js','-min.js',$jsFilePath);
1011             $fullFileName = str_replace('.js','-min.js',$fullFileName);
1012         }
1013
1014         // now write the js to cache
1015         sugar_file_put_contents($jsFilePath,$jsFileContents);
1016
1017         $this->_jsCache[$jsFileName] = $fullFileName;
1018
1019         if ( $returnURL )
1020             return getJSPath("cache/".$fullFileName);
1021
1022         return sugar_cached($fullFileName);
1023     }
1024
1025     /**
1026      * Returns an array of all of the images available for the current theme
1027      *
1028      * @return array
1029      */
1030     public function getAllImages()
1031     {
1032         // first, lets get all the paths of where to look
1033         $pathsToSearch = array($this->getImagePath());
1034         $theme = $this;
1035         while (isset($theme->parentTheme) && SugarThemeRegistry::get($theme->parentTheme) instanceOf SugarTheme ) {
1036             $theme = SugarThemeRegistry::get($theme->parentTheme);
1037             $pathsToSearch[] = $theme->getImagePath();
1038         }
1039         $pathsToSearch[] = $this->getDefaultImagePath();
1040
1041         // now build the array
1042         $imageArray = array();
1043         foreach ( $pathsToSearch as $path )
1044         {
1045             if (!sugar_is_dir($path)) $path = "custom/$path";
1046             if (sugar_is_dir($path) && is_readable($path) && $dir = opendir($path)) {
1047                 while (($file = readdir($dir)) !== false) {
1048                     if ($file == ".."
1049                             || $file == "."
1050                             || $file == ".svn"
1051                             || $file == "CVS"
1052                             || $file == "Attic"
1053                             )
1054                         continue;
1055                     if ( !isset($imageArray[$file]) )
1056                         $imageArray[$file] = $this->getImageURL($file,false);
1057                 }
1058                 closedir($dir);
1059             }
1060         }
1061
1062         ksort($imageArray);
1063
1064         return $imageArray;
1065     }
1066
1067 }
1068
1069 /**
1070  * Registry for all the current classes in the system
1071  */
1072 class SugarThemeRegistry
1073 {
1074     /**
1075      * Array of all themes and thier object
1076      *
1077      * @var array
1078      */
1079     private static $_themes = array();
1080
1081     /**
1082      * Name of the current theme; corresponds to an index key in SugarThemeRegistry::$_themes
1083      *
1084      * @var string
1085      */
1086     private static $_currentTheme;
1087
1088     /**
1089      * Disable the constructor since this will be a singleton
1090      */
1091     private function __construct() {}
1092
1093     /**
1094      * Adds a new theme to the registry
1095      *
1096      * @param $themedef array
1097      */
1098     public static function add(
1099         array $themedef
1100         )
1101     {
1102         // make sure the we know the sugar version
1103         if ( !isset($GLOBALS['sugar_version']) ) {
1104             include('sugar_version.php');
1105             $GLOBALS['sugar_version'] = $sugar_version;
1106         }
1107
1108         // Assume theme is designed for 5.5.x if not specified otherwise
1109         if ( !isset($themedef['version']) )
1110             $themedef['version']['regex_matches'] = array('5\.5\.*');
1111
1112         // Check to see if theme is valid for this version of Sugar; return false if not
1113         $version_ok = false;
1114         if( isset($themedef['version']['exact_matches']) ){
1115             $matches_empty = false;
1116             foreach( $themedef['version']['exact_matches'] as $match ){
1117                 if( $match == $GLOBALS['sugar_version'] ){
1118                     $version_ok = true;
1119                 }
1120             }
1121         }
1122         if( !$version_ok && isset($themedef['version']['regex_matches']) ){
1123             $matches_empty = false;
1124             foreach( $themedef['version']['regex_matches'] as $match ){
1125                 if( preg_match( "/$match/", $GLOBALS['sugar_version'] ) ){
1126                     $version_ok = true;
1127                 }
1128             }
1129         }
1130         if ( !$version_ok )
1131             return false;
1132
1133         $theme = new SugarTheme($themedef);
1134         self::$_themes[$theme->dirName] = $theme;
1135     }
1136
1137     /**
1138      * Removes a new theme from the registry
1139      *
1140      * @param $themeName string
1141      */
1142     public static function remove(
1143         $themeName
1144         )
1145     {
1146         if ( self::exists($themeName) )
1147             unset(self::$_themes[$themeName]);
1148     }
1149
1150     /**
1151      * Returns a theme object in the registry specified by the given $themeName
1152      *
1153      * @param $themeName string
1154      */
1155     public static function get(
1156         $themeName
1157         )
1158     {
1159         if ( isset(self::$_themes[$themeName]) )
1160             return self::$_themes[$themeName];
1161     }
1162
1163     /**
1164      * Returns the current theme object
1165      *
1166      * @return SugarTheme object
1167      */
1168     public static function current()
1169     {
1170         if ( !isset(self::$_currentTheme) )
1171             self::buildRegistry();
1172
1173         return self::$_themes[self::$_currentTheme];
1174     }
1175
1176     /**
1177      * Returns the default theme object
1178      *
1179      * @return SugarTheme object
1180      */
1181     public static function getDefault()
1182     {
1183         if ( !isset(self::$_currentTheme) )
1184             self::buildRegistry();
1185
1186         if ( isset($GLOBALS['sugar_config']['default_theme']) && self::exists($GLOBALS['sugar_config']['default_theme']) ) {
1187             return self::get($GLOBALS['sugar_config']['default_theme']);
1188         }
1189
1190         return self::get(array_pop(array_keys(self::availableThemes())));
1191     }
1192
1193     /**
1194      * Returns true if a theme object specified by the given $themeName exists in the registry
1195      *
1196      * @param  $themeName string
1197      * @return bool
1198      */
1199     public static function exists(
1200         $themeName
1201         )
1202     {
1203         return (self::get($themeName) !== null);
1204     }
1205
1206     /**
1207      * Sets the given $themeName to be the current theme
1208      *
1209      * @param  $themeName string
1210      */
1211     public static function set(
1212         $themeName
1213         )
1214     {
1215         if ( !self::exists($themeName) )
1216             return false;
1217
1218         self::$_currentTheme = $themeName;
1219
1220         // set some of the expected globals
1221         $GLOBALS['barChartColors'] = self::current()->barChartColors;
1222         $GLOBALS['pieChartColors'] = self::current()->pieChartColors;
1223         return true;
1224     }
1225
1226     /**
1227      * Builds the theme registry
1228      */
1229     public static function buildRegistry()
1230     {
1231         self::$_themes = array();
1232         $dirs = array("themes/","custom/themes/");
1233
1234         // check for a default themedef file
1235         $themedefDefault = array();
1236         if ( sugar_is_file("custom/themes/default/themedef.php") ) {
1237             $themedef = array();
1238             require("custom/themes/default/themedef.php");
1239             $themedefDefault = $themedef;
1240         }
1241
1242         foreach ($dirs as $dirPath ) {
1243             if (sugar_is_dir('./'.$dirPath) && is_readable('./'.$dirPath) && $dir = opendir('./'.$dirPath)) {
1244                 while (($file = readdir($dir)) !== false) {
1245                     if ($file == ".."
1246                             || $file == "."
1247                             || $file == ".svn"
1248                             || $file == "CVS"
1249                             || $file == "Attic"
1250                             || $file == "default"
1251                             || !sugar_is_dir("./$dirPath".$file)
1252                             || !sugar_is_file("./{$dirPath}{$file}/themedef.php")
1253                             )
1254                         continue;
1255                     $themedef = array();
1256                     require("./{$dirPath}{$file}/themedef.php");
1257                     $themedef = array_merge($themedef,$themedefDefault);
1258                     $themedef['dirName'] = $file;
1259                     // check for theme already existing in the registry
1260                     // if so, then it will override the current one
1261                     if ( self::exists($themedef['dirName']) ) {
1262                         $existingTheme = self::get($themedef['dirName']);
1263                         foreach ( SugarTheme::getThemeDefFields() as $field )
1264                             if ( !isset($themedef[$field]) )
1265                                 $themedef[$field] = $existingTheme->$field;
1266                         self::remove($themedef['dirName']);
1267                     }
1268                     if ( isset($themedef['name']) ) {
1269                         self::add($themedef);
1270                     }
1271                 }
1272                 closedir($dir);
1273             }
1274         }
1275         // default to setting the default theme as the current theme
1276         if ( !isset($GLOBALS['sugar_config']['default_theme']) || !self::set($GLOBALS['sugar_config']['default_theme']) ) {
1277             if ( count(self::availableThemes()) == 0 )
1278             {
1279                 sugar_die('No valid themes are found on this instance');
1280             } else {
1281                 self::set(self::getDefaultThemeKey());
1282             }
1283         }
1284     }
1285
1286
1287     /**
1288      * getDefaultThemeKey
1289      *
1290      * This function returns the default theme key.  It takes into account string casing issues that may arise
1291      * from upgrades.  It attempts to look for the Sugar theme and if not found, defaults to return the name of the last theme
1292      * in the array of available themes loaded.
1293      *
1294      * @return $defaultThemeKey String value of the default theme key to use
1295      */
1296     private static function getDefaultThemeKey()
1297     {
1298         $availableThemes = self::availableThemes();
1299         foreach($availableThemes as $key=>$theme)
1300         {
1301             if(strtolower($key) == 'sugar')
1302             {
1303                 return $key;
1304             }
1305         }
1306
1307         return array_pop(array_keys($availableThemes));
1308     }
1309
1310
1311     /**
1312      * Returns an array of available themes. Designed to be absorbed into get_select_options_with_id()
1313      *
1314      * @return array
1315      */
1316     public static function availableThemes()
1317     {
1318         $themelist = array();
1319         $disabledThemes = array();
1320         if ( isset($GLOBALS['sugar_config']['disabled_themes']) )
1321             $disabledThemes = explode(',',$GLOBALS['sugar_config']['disabled_themes']);
1322
1323         foreach ( self::$_themes as $themename => $themeobject ) {
1324             if ( in_array($themename,$disabledThemes) )
1325                 continue;
1326             $themelist[$themeobject->dirName] = $themeobject->name;
1327         }
1328         asort($themelist, SORT_STRING);
1329         return $themelist;
1330     }
1331
1332     /**
1333      * Returns an array of un-available themes. Designed used with the theme selector in the admin panel
1334      *
1335      * @return array
1336      */
1337     public static function unAvailableThemes()
1338     {
1339         $themelist = array();
1340         $disabledThemes = array();
1341         if ( isset($GLOBALS['sugar_config']['disabled_themes']) )
1342             $disabledThemes = explode(',',$GLOBALS['sugar_config']['disabled_themes']);
1343
1344         foreach ( self::$_themes as $themename => $themeobject ) {
1345             if ( in_array($themename,$disabledThemes) )
1346                 $themelist[$themeobject->dirName] = $themeobject->name;
1347         }
1348
1349         return $themelist;
1350     }
1351
1352     /**
1353      * Returns an array of all themes found in the current installation
1354      *
1355      * @return array
1356      */
1357     public static function allThemes()
1358     {
1359         $themelist = array();
1360
1361         foreach ( self::$_themes as $themename => $themeobject )
1362             $themelist[$themeobject->dirName] = $themeobject->name;
1363
1364         return $themelist;
1365     }
1366
1367     /**
1368      * Clears out the cached path locations for all themes
1369      */
1370     public static function clearAllCaches()
1371     {
1372         foreach ( self::$_themes as $themeobject ) {
1373             $themeobject->clearCache();
1374         }
1375     }
1376 }