nucleus/libs/SKIN.php

   1 <?php\r
   2 /*\r
   3  * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)\r
   4  * Copyright (C) 2002-2009 The Nucleus Group\r
   5  *\r
   6  * This program is free software; you can redistribute it and/or\r
   7  * modify it under the terms of the GNU General Public License\r
   8  * as published by the Free Software Foundation; either version 2\r
   9  * of the License, or (at your option) any later version.\r
  10  * (see nucleus/documentation/index.html#license for more info)\r
  11  */\r
  12 /**\r
  13  * Class representing a skin\r
  14  *\r
  15  * @license http://nucleuscms.org/license.txt GNU General Public License\r
  16  * @copyright Copyright (C) 2002-2009 The Nucleus Group\r
  17  * @version $Id: SKIN.php 1784 2012-04-22 04:28:30Z sakamocchi $
  18  */\r
  19 \r
  20 if ( !function_exists('requestVar') ) \r
  21 {\r
  22         exit;\r
  23 }\r
  24 \r
  25 class Skin\r
  26 {\r
  27         // after creating a SKIN object, evaluates to true when the skin exists\r
  28         private $valid;\r
  29         \r
  30         // skin characteristics. Use the getXXX methods rather than accessing directly\r
  31         private $id;\r
  32         private $description;\r
  33         private $contentType;\r
  34         private $includeMode;           // either 'normal' or 'skindir'\r
  35         private $includePrefix;\r
  36         private $name;\r
  37         \r
  38         /* action class */\r
  39         private $action_class;\r
  40         private $event_identifier;\r
  41         \r
  42         /**\r
  43          * Skin::__construct()\r
  44          * Constructor for a new SKIN object\r
  45          * \r
  46          * @param       integer $id                                     id of the skin\r
  47          * @param       string  $action_class           name of class extended from BaseActions\r
  48          * @param       string  $event_identifier       event identifier. for example, InitAdminSkinParse if AdminSkin is used\r
  49          * @return      void\r
  50          */\r
  51         public function __construct($id, $action_class='Actions', $event_identifier='Skin')\r
  52         {\r
  53                 global $DIR_LIBS;\r
  54                 \r
  55                 $this->id = (integer) $id;\r
  56                 \r
  57                 /*\r
  58                  * NOTE: include needed action class\r
  59                  */\r
  60                 if ( $action_class != 'Actions' )\r
  61                 {\r
  62                         if ( !class_exists($action_class, FALSE)\r
  63                           && (!file_exists("{$DIR_LIBS}{$action_class}.php")\r
  64                            || !include("{$DIR_LIBS}{$action_class}.php")) )\r
  65                         {\r
  66                                 return;\r
  67                         }\r
  68                 }\r
  69                 else\r
  70                 {\r
  71                         if ( !class_exists('Actions', FALSE)\r
  72                           && (!file_exists("{$DIR_LIBS}ACTIONS.php")\r
  73                            || !include("{$DIR_LIBS}ACTIONS.php")) )\r
  74                         {\r
  75                                 return;\r
  76                         }\r
  77                 }\r
  78                 \r
  79                 $this->action_class = $action_class;\r
  80                 $this->event_identifier = $event_identifier;\r
  81                 \r
  82                 // read skin name/description/content type\r
  83                 $query = "SELECT * FROM %s WHERE sdnumber=%d;";\r
  84                 $query = sprintf($query, sql_table('skin_desc'), $this->id);\r
  85                 $res = sql_query($query);\r
  86                 $obj = sql_fetch_object($res);\r
  87                 \r
  88                 $this->valid = (sql_num_rows($res) > 0);\r
  89                 if ( !$this->valid )\r
  90                 {\r
  91                         return;\r
  92                 }\r
  93                 \r
  94                 $this->name = $obj->sdname;\r
  95                 $this->description = $obj->sddesc;\r
  96                 $this->contentType = $obj->sdtype;\r
  97                 $this->includeMode = $obj->sdincmode;\r
  98                 $this->includePrefix = $obj->sdincpref;\r
  99                 \r
 100                 return;\r
 101         }\r
 102         \r
 103         /**\r
 104          * Skin::getID()\r
 105          * Get SKIN id\r
 106          * \r
 107          * @param       void\r
 108          * @return      integer id for this skin instance\r
 109          */\r
 110         public function getID()\r
 111         {\r
 112                 return (integer) $this->id;\r
 113         }\r
 114         \r
 115         /**\r
 116          * Skin::isValid()\r
 117          * \r
 118          * @param       void\r
 119          * @return      boolean\r
 120          */\r
 121         public function isValid()\r
 122         {\r
 123                 return (boolean) $this->valid;\r
 124         }\r
 125         \r
 126         /**\r
 127          * Skin::getName()\r
 128          * Get SKIN name\r
 129          * \r
 130          * @param       void\r
 131          * @return      string  name of this skin instance\r
 132          */\r
 133         public function getName()\r
 134         {\r
 135                 return (string) $this->name;\r
 136         }\r
 137         \r
 138         /**\r
 139          * Skin::getDescription()\r
 140          * Get SKIN description\r
 141          * \r
 142          * @param       void\r
 143          * @return      string  description of this skin instance\r
 144          */\r
 145         public function getDescription()\r
 146         {\r
 147                 return (string) $this->description;\r
 148         }\r
 149         \r
 150         /**\r
 151          * Skin::getContentType()\r
 152          * Get SKIN content type\r
 153          * e.g. text/xml, text/html, application/atom+xml\r
 154          * \r
 155          * @param       void\r
 156          * @return      string  name of this skin instance\r
 157          */\r
 158         public function getContentType()\r
 159         {\r
 160                 return (string) $this->contentType;\r
 161         }\r
 162         \r
 163         /**\r
 164          * Skin::getIncludeMode()\r
 165          * Get include mode of the SKIN\r
 166          * \r
 167          * Returns either 'normal' or 'skindir':\r
 168          * 'normal': if a all data of the skin can be found in the databse\r
 169          * 'skindir': if the skin has data in the it's skin driectory\r
 170          * \r
 171          * @param       void\r
 172          * @return      string  normal/skindir\r
 173          */\r
 174         public function getIncludeMode()\r
 175         {\r
 176                 return (string) $this->includeMode;\r
 177         }\r
 178         \r
 179         /**\r
 180          * Skin::getIncludePrefix()\r
 181          * Get include prefix of the SKIN\r
 182          * \r
 183          * Get name of the subdirectory (with trailing slash) where\r
 184          * the files of the current skin can be found (e.g. 'default/')\r
 185          * \r
 186          * @param       void\r
 187          * @return      string  include prefix of this skin instance\r
 188          */\r
 189         public function getIncludePrefix()\r
 190         {\r
 191                 return (string) $this->includePrefix;\r
 192         }\r
 193         \r
 194         /**\r
 195          * Skin::exists()\r
 196          * Checks if a skin with a given shortname exists\r
 197          * \r
 198          * @static\r
 199          * @param       string  $name   Skin short name\r
 200          * @return      integer number of skins with the given ID\r
 201          */\r
 202         static public function exists($name)\r
 203         {\r
 204                 $query = "SELECT COUNT(*) AS result FROM %s WHERE sdname='%s';";\r
 205                 $query = sprintf($query, sql_table('skin_desc'), sql_real_escape_string($name));\r
 206                 return (quickQuery($query) > 0);\r
 207         }\r
 208         \r
 209         /**\r
 210          * Skin::existsID()\r
 211          * Checks if a skin with a given ID exists\r
 212          * \r
 213          * @static\r
 214          * @param       string  $id     Skin ID\r
 215          * @return      integer number of skins with the given ID\r
 216          */\r
 217         static public function existsID($id)\r
 218         {\r
 219                 $query = "SELECT COUNT(*) AS result FROM %s WHERE sdnumber=%d;";\r
 220                 $query = sprintf($query, sql_table('skin_desc'), (integer) $id);\r
 221                 return (quickQuery($query) > 0);\r
 222         }\r
 223         \r
 224         /**\r
 225          * Skin::createFromName()\r
 226          * Returns a skin given its shortname\r
 227          * \r
 228          * @static\r
 229          * @param       string  $name   Skin shortname\r
 230          * @return      object instance of Skin class\r
 231          */\r
 232         static public function createFromName($name)\r
 233         {\r
 234                 return new SKIN(SKIN::getIdFromName($name));\r
 235         }\r
 236         \r
 237         /**\r
 238          * Skin::getIdFromName()\r
 239          * Returns a skin ID given its shortname\r
 240          * \r
 241          * @static\r
 242          * @param       string  $name   Skin shortname\r
 243          * @return      integer Skin ID\r
 244          */\r
 245         static public function getIdFromName($name)\r
 246         {\r
 247                 $query = "SELECT sdnumber FROM %s WHERE sdname='%s';";\r
 248                 $query = sprintf($query, sql_table('skin_desc'), sql_real_escape_string($name));\r
 249                 $res = sql_query($query);\r
 250                 $obj = sql_fetch_object($res);\r
 251                 return $obj->sdnumber;\r
 252         }\r
 253         \r
 254         /**\r
 255          * Skin::getNameFromId()\r
 256          * Returns a skin shortname given its ID\r
 257          * \r
 258          * @static\r
 259          * @param       string  $name\r
 260          * @return      string  Skin short name\r
 261          */\r
 262         static public function getNameFromId($id)\r
 263         {\r
 264                 $query = "SELECT sdname AS result FROM %s WHERE sdnumber=%d;";\r
 265                 $query = sprintf($query, sql_table('skin_desc'), (integer) $id);\r
 266                 return quickQuery($query);\r
 267         }\r
 268         \r
 269         /**\r
 270          * SKIN::createNew()\r
 271          * Creates a new skin, with the given characteristics.\r
 272          *\r
 273          * @static\r
 274          * @param       String  $name   value for nucleus_skin.sdname\r
 275          * @param       String  $desc   value for nucleus_skin.sddesc\r
 276          * @param       String  $type   value for nucleus_skin.sdtype\r
 277          * @param       String  $includeMode    value for nucleus_skin.sdinclude\r
 278          * @param       String  $includePrefix  value for nucleus_skin.sdincpref\r
 279          * @return      Integer ID for just inserted record\r
 280          */\r
 281         public function createNew($name, $desc, $type = 'text/html', $includeMode = 'normal', $includePrefix = '')\r
 282         {\r
 283                 global $manager;\r
 284                 \r
 285                 $manager->notify(\r
 286                         'PreAddSkin',\r
 287                         array(\r
 288                                 'name' => &$name,\r
 289                                 'description' => &$desc,\r
 290                                 'type' => &$type,\r
 291                                 'includeMode' => &$includeMode,\r
 292                                 'includePrefix' => &$includePrefix\r
 293                         )\r
 294                 );\r
 295                 \r
 296                 $query = "INSERT INTO %s (sdname, sddesc, sdtype, sdincmode, sdincpref) VALUES ('%s', '%s', '%s', '%s', '%s');";\r
 297                 $sdname         = sql_real_escape_string($name);\r
 298                 $sddesc         = sql_real_escape_string($desc);\r
 299                 $sdtype         = sql_real_escape_string($type);\r
 300                 $sdincmode      = sql_real_escape_string($includeMode);\r
 301                 $sdincpref      = sql_real_escape_string($includePrefix);\r
 302                 $query = sprintf($query, sql_table('skin_desc'), $sdname, $sddesc, $sdtype, $sdincmode, $sdincpref);\r
 303                 sql_query($query);\r
 304                 $newid = sql_insert_id();\r
 305                 \r
 306                 $manager->notify(\r
 307                         'PostAddSkin',\r
 308                         array(\r
 309                                 'skinid'                => $newid,\r
 310                                 'name'                  => $name,\r
 311                                 'description'   => $desc,\r
 312                                 'type'                  => $type,\r
 313                                 'includeMode'   => $includeMode,\r
 314                                 'includePrefix' => $includePrefix\r
 315                         )\r
 316                 );\r
 317                 return $newid;\r
 318         }\r
 319         \r
 320         /**\r
 321          * Skin::parse()\r
 322          * Parse a SKIN\r
 323          * \r
 324          * @param       string  $type\r
 325          * @param       string  $path   path to file if using fileparser\r
 326          * @return      void\r
 327          */\r
 328         public function parse($type, $path='')\r
 329         {\r
 330                 global $currentSkinName, $manager, $CONF, $DIR_NUCLEUS;\r
 331                 \r
 332                 $manager->notify("Init{$this->event_identifier}Parse", array('skin' => &$this, 'type' => $type));\r
 333                 \r
 334                 // set output type\r
 335                 sendContentType($this->getContentType(), 'skin');\r
 336                 \r
 337                 // set skin name as global var (so plugins can access it)\r
 338                 $currentSkinName = $this->getName();\r
 339                 \r
 340                 $contents = FALSE;\r
 341                 if ( $type != 'fileparse' )\r
 342                 {\r
 343                         $contents = $this->getContent($type);\r
 344                 }\r
 345                 else if ( $path !== ''  && i18n::strpos(realpath($path), realpath("$DIR_NUCLEUS/../")) == 0 )\r
 346                 {\r
 347                         $contents = $this->getFileContent($path);\r
 348                 }\r
 349                 \r
 350                 if ( !$contents )\r
 351                 {\r
 352                         // use base skin if this skin does not have contents\r
 353                         $defskin = new SKIN($CONF['BaseSkin']);\r
 354                         $contents = $defskin->getContent($type);\r
 355                         if ( !$contents )\r
 356                         {\r
 357                                 echo _ERROR_SKIN;\r
 358                                 return;\r
 359                         }\r
 360                 }\r
 361                 \r
 362                 $manager->notify("Pre{$this->event_identifier}Parse", array('skin' => &$this, 'type' => $type, 'contents' => &$contents));\r
 363                 \r
 364                 // set IncludeMode properties of parser\r
 365                 Parser::setProperty('IncludeMode', $this->getIncludeMode());\r
 366                 Parser::setProperty('IncludePrefix', $this->getIncludePrefix());\r
 367                 \r
 368                 $action_class = $this->action_class;\r
 369                 $handler = new $action_class($type);\r
 370                 \r
 371                 $actions = $handler->getDefinedActions($type);\r
 372                 $parser = new Parser($actions, $handler);\r
 373                 \r
 374                 $handler->setParser($parser);\r
 375                 $handler->setSkin($this);\r
 376                 $parser->parse($contents);\r
 377                 \r
 378                 $manager->notify("Post{$this->event_identifier}Parse", array('skin' => &$this, 'type' => $type));\r
 379                 return;\r
 380         }\r
 381         \r
 382         /**\r
 383          * Skin::getContent()\r
 384          * Get content of the skin part from the database\r
 385          * \r
 386          * @param       string  $type   type of the skin (e.g. index, item, search ...)\r
 387          * @return      string  content of scontent\r
 388          */\r
 389         public function getContent($type)\r
 390         {\r
 391                 $query = "SELECT scontent FROM %s WHERE sdesc=%d and stype='%s';";\r
 392                 $query = sprintf($query, sql_table('skin'), (integer) $this->id, sql_real_escape_string($type));\r
 393                 $res = sql_query($query);\r
 394                 \r
 395                 if ( sql_num_rows($res) == 0 )\r
 396                 {\r
 397                         return FALSE;\r
 398                 }\r
 399                 return sql_result($res, 0, 0);\r
 400         }\r
 401         \r
 402         /**\r
 403          * Skin::getFileContent()\r
 404          * \r
 405          * @param       string  $fullpath       fullpath to the file to parse\r
 406          * @return      mixed   file contents or FALSE\r
 407          */\r
 408         public function getFileContent($fullpath)\r
 409         {\r
 410                 $fsize = filesize($fullpath);\r
 411                 if ( $fsize <= 0 )\r
 412                 {\r
 413                         return;\r
 414                 }\r
 415                 \r
 416                 $fd = fopen ($fullpath, 'r');\r
 417                 if ( $fd === FALSE )\r
 418                 {\r
 419                         return FALSE;\r
 420                 }\r
 421                 \r
 422                 $contents = fread ($fd, $fsize);\r
 423                 if ( $contents === FALSE )\r
 424                 {\r
 425                         return FALSE;\r
 426                 }\r
 427                 \r
 428                 fclose ($fd);\r
 429                 return $contents;\r
 430         }\r
 431         \r
 432         /**\r
 433          * SKIN::update()\r
 434          * Updates the contents for one part of the skin in the database\r
 435          * \r
 436          * @param       string  $type type of the skin part (e.g. index, item, search ...) \r
 437          * @param       string  $content new content for this skin part\r
 438          * @return      void\r
 439          * \r
 440          */\r
 441         public function update($type, $content)\r
 442         {\r
 443                 global $manager;\r
 444                 \r
 445                 $query = "SELECT sdesc FROM %s WHERE stype='%s' and sdesc=%d;";\r
 446                 $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $this->id);\r
 447                 $res = sql_query($query);\r
 448                 \r
 449                 $skintypeexists = sql_fetch_object($res);\r
 450                 $skintypevalue = ($content == true);\r
 451                 \r
 452                 if( $skintypevalue && $skintypeexists )\r
 453                 {\r
 454                         $data = array(\r
 455                                 'skinid'        =>  $this->id,\r
 456                                 'type'          =>  $type,\r
 457                                 'content'       => &$content\r
 458                         );\r
 459                         \r
 460                         // PreUpdateSkinPart event\r
 461                         $manager->notify("PreUpdate{{$this->event_identifier}}Part", $data);\r
 462                 }\r
 463                 else if( $skintypevalue && !$skintypeexists )\r
 464                 {\r
 465                         $data = array(\r
 466                                 'skinid' => $this->id,\r
 467                                 'type' => $type,\r
 468                                 'content' => &$content\r
 469                         );\r
 470                         \r
 471                         $manager->notify("PreAdd{$this->event_identifier}Part", $data);\r
 472                 }\r
 473                 else if( !$skintypevalue && $skintypeexists )\r
 474                 {\r
 475                         $data = array(\r
 476                                 'skinid' => $this->id,\r
 477                                 'type' => $type\r
 478                         );\r
 479                         \r
 480                         $manager->notify("PreDelete{$this->event_identifier}Part", $data);\r
 481                 }\r
 482                 \r
 483                 // delete old thingie\r
 484                 $query = "DELETE FROM %s WHERE stype='%s' and sdesc=%d";\r
 485                 $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $this->id);\r
 486                 sql_query($query);\r
 487                 \r
 488                 // write new thingie\r
 489                 if ( $content )\r
 490                 {\r
 491                         $query = "INSERT INTO %s (scontent, stype, sdesc) VALUE ('%s', '%s', %d)";\r
 492                         $query = sprintf($query, sql_table('skin'), sql_real_escape_string($content), sql_real_escape_string($type), (integer) $this->id);\r
 493                         sql_query($query);\r
 494                 }\r
 495                 \r
 496                 if( $skintypevalue && $skintypeexists )\r
 497                 {\r
 498                         $data = array(\r
 499                                 'skinid'        => $this->id,\r
 500                                 'type'          => $type,\r
 501                                 'content'       => &$content\r
 502                         );\r
 503                         \r
 504                         // PostUpdateSkinPart event\r
 505                         $manager->notify("PostUpdate{$this->event_identifier}Part", $data);\r
 506                 }\r
 507                 else if( $skintypevalue && (!$skintypeexists) )\r
 508                 {\r
 509                         $data = array(\r
 510                                 'skinid'        => $this->id,\r
 511                                 'type'          => $type,\r
 512                                 'content'       => &$content\r
 513                         );\r
 514                         \r
 515                         // PostAddSkinPart event\r
 516                         $manager->notify("PostAdd{$this->event_identifier}Part", $data);\r
 517                 }\r
 518                 else if( (!$skintypevalue) && $skintypeexists )\r
 519                 {\r
 520                         $data = array(\r
 521                                 'skinid'        => $this->id,\r
 522                                 'type'          => $type\r
 523                         );\r
 524                         \r
 525                         $manager->notify("PostDelete{$this->event_identifier}Part", $data);\r
 526                 }\r
 527                 return;\r
 528         }\r
 529         \r
 530         /**\r
 531          * Skin::deleteAllParts()\r
 532          * Deletes all skin parts from the database\r
 533          * \r
 534          * @param       void\r
 535          * @return      void\r
 536          */\r
 537         public function deleteAllParts()\r
 538         {\r
 539                 $query = "DELETE FROM %s WHERE sdesc=%d;";\r
 540                 $query = sprintf($query, sql_table('skin'), (integer) $this->id);\r
 541                 sql_query($query);\r
 542         }\r
 543         \r
 544         /**\r
 545          * Skin::updateGeneralInfo()\r
 546          * Updates the general information about the skin\r
 547          * \r
 548          * @param       string  $name                   name of the skin\r
 549          * @param       string  $desc                   description of the skin\r
 550          * @param       string  $type                   type of the skin\r
 551          * @param       string  $includeMode    include mode of the skin\r
 552          * @param       string  $includePrefix  include prefix of the skin\r
 553          * @return      void\r
 554          */\r
 555         public function updateGeneralInfo($name, $desc, $type = 'text/html', $includeMode = 'normal', $includePrefix = '')\r
 556         {\r
 557                 $name                   = sql_real_escape_string($name);\r
 558                 $desc                   = sql_real_escape_string($desc);\r
 559                 $type                   = sql_real_escape_string($type);\r
 560                 $includeMode    = sql_real_escape_string($includeMode);\r
 561                 $includePrefix  = sql_real_escape_string($includePrefix);\r
 562                 \r
 563                 $query ="UPDATE %s SET sdname='%s', sddesc='%s', sdtype='%s', sdincmode='%s', sdincpref='%s' WHERE sdnumber=%d";\r
 564                 $query = sprintf($query, sql_table('skin_desc'), $name, $desc, $type, $includeMode, $includePrefix, (integer) $this->id);\r
 565                 \r
 566                 sql_query($query);\r
 567                 return;\r
 568         }\r
 569         \r
 570         /**\r
 571          * Skin::getDefaultTypes()
 572          * \r
 573          * @param       string  void
 574          * @return      array   default skin types
 575          */\r
 576         public function getDefaultTypes()
 577         {\r
 578                 return call_user_func(array($this->action_class, 'getDefaultSkinTypes'));
 579         }\r
 580         \r
 581         /**\r
 582          * Skin::getAvailableTypes()
 583          * \r
 584          * @param       string  void\r
 585          * @return      array   registered skin types
 586          */\r
 587         public function getAvailableTypes()
 588         {\r
 589                 $default_skintypes = $this->getDefaultTypes();
 590                 $query = "SELECT stype FROM %s WHERE sdesc=%d;";
 591                 $query = sprintf($query, sql_table('skin'), (integer) $this->id);
 592
 593                 /* NOTE: force to put default types in the beginning */
 594                 $in_default = array();
 595                 $no_default = array();
 596
 597                 $res = sql_query($query);
 598                 while ( $row = sql_fetch_array($res) )
 599                 {
 600                         if ( !array_key_exists($row['stype'], $default_skintypes) )
 601                         {
 602                                 $no_default[$row['stype']] = FALSE;
 603         }\r
 604                         else
 605                         {
 606                                 $in_default[$row['stype']] = $default_skintypes[$row['stype']];
 607                         }
 608                 }
 609
 610                 return array_merge($in_default, $no_default);
 611         }
 612
 613         /**
 614          * Skin::getAllowedActionsForType()
 615          * Get the allowed actions for a skin type
 616          * returns an array with the allowed actions
 617          *
 618          * @param       string  $type   type of the skin
 619          * @return      array   allowed action types
 620          */
 621         public function getAllowedActionsForType($type)
 622         {
 623                 return call_user_func(array($this->action_class, 'getDefinedActions'), $type);
 624         }
 625
 626 }\r