OSDN Git Service

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