OSDN Git Service

Merge branch 'skinnable-master' of git.sourceforge.jp:/gitroot/nucleus-jp/nucleus...
[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 1813 2012-05-02 14:41:57Z sakamocchi $\r
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                 // include skin locale file for <%text%> tag if useable\r
335                 $this->includeTranslation();\r
336                 \r
337                 // set output type\r
338                 sendContentType($this->getContentType(), 'skin');\r
339                 \r
340                 /* FIX: should be obsoleted */\r
341                 $currentSkinName = $this->getName();\r
342                 \r
343                 // retrieve contents\r
344                 $contents = FALSE;\r
345                 if ( $type != 'fileparse' )\r
346                 {\r
347                         $contents = $this->getContentFromDB($type);\r
348                 }\r
349                 else if ( $path !== ''  && i18n::strpos(realpath($path), realpath("$DIR_NUCLEUS/../")) == 0 )\r
350                 {\r
351                         $contents = $this->getContentFromFile($path);\r
352                 }\r
353                 // use base skin if this skin does not have contents\r
354                 if ( $contents === FALSE )\r
355                 {\r
356                         $defskin = new SKIN($CONF['BaseSkin']);\r
357                         $contents = $defskin->getContentFromDB($type);\r
358                         if ( !$contents )\r
359                         {\r
360                                 echo _ERROR_SKIN;\r
361                                 return;\r
362                         }\r
363                 }\r
364                 \r
365                 $manager->notify("Pre{$this->event_identifier}Parse", array('skin' => &$this, 'type' => $type, 'contents' => &$contents));\r
366                 \r
367                 // set IncludeMode properties of parser\r
368                 Parser::setProperty('IncludeMode', $this->getIncludeMode());\r
369                 Parser::setProperty('IncludePrefix', $this->getIncludePrefix());\r
370                 \r
371                 // call action handler\r
372                 $action_class = $this->action_class;\r
373                 $handler = new $action_class($type);\r
374                 \r
375                 // register action handler to parser\r
376                 $actions = $handler->getDefinedActions($type);\r
377                 $parser = new Parser($actions, $handler);\r
378                 \r
379                 $handler->setParser($parser);\r
380                 $handler->setSkin($this);\r
381                 $parser->parse($contents);\r
382                 \r
383                 $manager->notify("Post{$this->event_identifier}Parse", array('skin' => &$this, 'type' => $type));\r
384                 return;\r
385         }\r
386         \r
387         /**\r
388          * Skin::getContentFromDB()\r
389          * \r
390          * @param       string  $skintype       skin type\r
391          * @return      string  content for the skin type\r
392          */\r
393         public function getContentFromDB($skintype)\r
394         {\r
395                 $query = "SELECT scontent FROM %s WHERE sdesc=%d and stype='%s';";\r
396                 $query = sprintf($query, sql_table('skin'), (integer) $this->id, sql_real_escape_string($skintype));\r
397                 $res = sql_query($query);\r
398                 \r
399                 if ( sql_num_rows($res) == 0 )\r
400                 {\r
401                         return FALSE;\r
402                 }\r
403                 \r
404                 return sql_result($res, 0, 0);\r
405         }\r
406         \r
407         /**\r
408          * Skin::getContentFromFile()\r
409          * \r
410          * @param       string  $fullpath       fullpath to the file to parse\r
411          * @return      mixed   file contents or FALSE\r
412          */\r
413         public function getContentFromFile($fullpath)\r
414         {\r
415                 $fsize = filesize($fullpath);\r
416                 if ( $fsize <= 0 )\r
417                 {\r
418                         return;\r
419                 }\r
420                 \r
421                 $fd = fopen ($fullpath, 'r');\r
422                 if ( $fd === FALSE )\r
423                 {\r
424                         return FALSE;\r
425                 }\r
426                 \r
427                 $contents = fread ($fd, $fsize);\r
428                 if ( $contents === FALSE )\r
429                 {\r
430                         return FALSE;\r
431                 }\r
432                 \r
433                 fclose ($fd);\r
434                 return $contents;\r
435         }\r
436         \r
437         /**\r
438          * SKIN::update()\r
439          * Updates the contents for one part of the skin in the database\r
440          * \r
441          * @param       string  $type type of the skin part (e.g. index, item, search ...) \r
442          * @param       string  $content new content for this skin part\r
443          * @return      void\r
444          * \r
445          */\r
446         public function update($type, $content)\r
447         {\r
448                 global $manager;\r
449                 \r
450                 $query = "SELECT sdesc FROM %s WHERE stype='%s' and sdesc=%d;";\r
451                 $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $this->id);\r
452                 $res = sql_query($query);\r
453                 \r
454                 $skintypeexists = sql_fetch_object($res);\r
455                 $skintypevalue = ($content == true);\r
456                 \r
457                 if( $skintypevalue && $skintypeexists )\r
458                 {\r
459                         $data = array(\r
460                                 'skinid'        =>  $this->id,\r
461                                 'type'          =>  $type,\r
462                                 'content'       => &$content\r
463                         );\r
464                         \r
465                         // PreUpdateSkinPart event\r
466                         $manager->notify("PreUpdate{{$this->event_identifier}}Part", $data);\r
467                 }\r
468                 else if( $skintypevalue && !$skintypeexists )\r
469                 {\r
470                         $data = array(\r
471                                 'skinid' => $this->id,\r
472                                 'type' => $type,\r
473                                 'content' => &$content\r
474                         );\r
475                         \r
476                         $manager->notify("PreAdd{$this->event_identifier}Part", $data);\r
477                 }\r
478                 else if( !$skintypevalue && $skintypeexists )\r
479                 {\r
480                         $data = array(\r
481                                 'skinid' => $this->id,\r
482                                 'type' => $type\r
483                         );\r
484                         \r
485                         $manager->notify("PreDelete{$this->event_identifier}Part", $data);\r
486                 }\r
487                 \r
488                 // delete old thingie\r
489                 $query = "DELETE FROM %s WHERE stype='%s' and sdesc=%d";\r
490                 $query = sprintf($query, sql_table('skin'), sql_real_escape_string($type), (integer) $this->id);\r
491                 sql_query($query);\r
492                 \r
493                 // write new thingie\r
494                 if ( $content )\r
495                 {\r
496                         $query = "INSERT INTO %s (scontent, stype, sdesc) VALUE ('%s', '%s', %d)";\r
497                         $query = sprintf($query, sql_table('skin'), sql_real_escape_string($content), sql_real_escape_string($type), (integer) $this->id);\r
498                         sql_query($query);\r
499                 }\r
500                 \r
501                 if( $skintypevalue && $skintypeexists )\r
502                 {\r
503                         $data = array(\r
504                                 'skinid'        => $this->id,\r
505                                 'type'          => $type,\r
506                                 'content'       => &$content\r
507                         );\r
508                         \r
509                         // PostUpdateSkinPart event\r
510                         $manager->notify("PostUpdate{$this->event_identifier}Part", $data);\r
511                 }\r
512                 else if( $skintypevalue && (!$skintypeexists) )\r
513                 {\r
514                         $data = array(\r
515                                 'skinid'        => $this->id,\r
516                                 'type'          => $type,\r
517                                 'content'       => &$content\r
518                         );\r
519                         \r
520                         // PostAddSkinPart event\r
521                         $manager->notify("PostAdd{$this->event_identifier}Part", $data);\r
522                 }\r
523                 else if( (!$skintypevalue) && $skintypeexists )\r
524                 {\r
525                         $data = array(\r
526                                 'skinid'        => $this->id,\r
527                                 'type'          => $type\r
528                         );\r
529                         \r
530                         $manager->notify("PostDelete{$this->event_identifier}Part", $data);\r
531                 }\r
532                 return;\r
533         }\r
534         \r
535         /**\r
536          * Skin::deleteAllParts()\r
537          * Deletes all skin parts from the database\r
538          * \r
539          * @param       void\r
540          * @return      void\r
541          */\r
542         public function deleteAllParts()\r
543         {\r
544                 $query = "DELETE FROM %s WHERE sdesc=%d;";\r
545                 $query = sprintf($query, sql_table('skin'), (integer) $this->id);\r
546                 sql_query($query);\r
547         }\r
548         \r
549         /**\r
550          * Skin::updateGeneralInfo()\r
551          * Updates the general information about the skin\r
552          * \r
553          * @param       string  $name                   name of the skin\r
554          * @param       string  $desc                   description of the skin\r
555          * @param       string  $type                   type of the skin\r
556          * @param       string  $includeMode    include mode of the skin\r
557          * @param       string  $includePrefix  include prefix of the skin\r
558          * @return      void\r
559          */\r
560         public function updateGeneralInfo($name, $desc, $type = 'text/html', $includeMode = 'normal', $includePrefix = '')\r
561         {\r
562                 $name                   = sql_real_escape_string($name);\r
563                 $desc                   = sql_real_escape_string($desc);\r
564                 $type                   = sql_real_escape_string($type);\r
565                 $includeMode    = sql_real_escape_string($includeMode);\r
566                 $includePrefix  = sql_real_escape_string($includePrefix);\r
567                 \r
568                 $query ="UPDATE %s SET sdname='%s', sddesc='%s', sdtype='%s', sdincmode='%s', sdincpref='%s' WHERE sdnumber=%d";\r
569                 $query = sprintf($query, sql_table('skin_desc'), $name, $desc, $type, $includeMode, $includePrefix, (integer) $this->id);\r
570                 \r
571                 sql_query($query);\r
572                 return;\r
573         }\r
574         \r
575         /**\r
576          * Skin::includeTranslation()\r
577          * \r
578          * @param       void\r
579          * @return      void\r
580          */\r
581         private function includeTranslation()\r
582         {\r
583                 global $DIR_SKINS;\r
584                 \r
585                 $locale = i18n::get_current_locale() . '.' . i18n::get_current_charset();\r
586                 \r
587                 if( $this->includeMode == "normal" )\r
588                 {\r
589                         $filename = "./locales/{$locale}.php";\r
590                 }\r
591                 else if( $this->includeMode == "skindir" )\r
592                 {\r
593                         if ( $this->includePrefix == '' )\r
594                         {\r
595                                 $filename = "{$DIR_SKINS}locales/{$locale}.php";\r
596                         }\r
597                         else\r
598                         {\r
599                                 $filename = "{$DIR_SKINS}{$this->includePrefix}locales/{$locale}.php";\r
600                         }\r
601                 }\r
602                 else\r
603                 {\r
604                         return;\r
605                 }\r
606                 \r
607                 if ( !file_exists($filename) )\r
608                 {\r
609                         return;\r
610                 }\r
611                 \r
612                 include_once($filename);\r
613                 \r
614                 return;\r
615         }\r
616         \r
617         /**\r
618          * Skin::getDefaultTypes()\r
619          * \r
620          * @param       string  void\r
621          * @return      array   default skin types\r
622          */\r
623         public function getDefaultTypes()\r
624         {\r
625                 return call_user_func(array($this->action_class, 'getDefaultSkinTypes'));\r
626         }\r
627         \r
628         /**\r
629          * Skin::getAvailableTypes()\r
630          * \r
631          * @param       string  void\r
632          * @return      array   registered skin types\r
633          */\r
634         public function getAvailableTypes()\r
635         {\r
636                 $default_skintypes = $this->getDefaultTypes();\r
637                 $query = "SELECT stype FROM %s WHERE sdesc=%d;";\r
638                 $query = sprintf($query, sql_table('skin'), (integer) $this->id);\r
639                 \r
640                 /* NOTE: force to put default types in the beginning */\r
641                 $in_default = array();\r
642                 $no_default = array();\r
643                 \r
644                 $res = sql_query($query);\r
645                 while ( $row = sql_fetch_array($res) )\r
646                 {\r
647                         if ( !array_key_exists($row['stype'], $default_skintypes) )\r
648                         {\r
649                                 $no_default[$row['stype']] = FALSE;\r
650                         }\r
651                         else\r
652                         {\r
653                                 $in_default[$row['stype']] = $default_skintypes[$row['stype']];\r
654                         }\r
655                 }\r
656                 \r
657                 return array_merge($in_default, $no_default);\r
658         }\r
659         \r
660         /**\r
661          * Skin::getAllowedActionsForType()\r
662          * Get the allowed actions for a skin type\r
663          * returns an array with the allowed actions\r
664          * \r
665          * @param       string  $type   type of the skin\r
666          * @return      array   allowed action types\r
667          */\r
668         public function getAllowedActionsForType($type)\r
669         {\r
670                 return call_user_func(array($this->action_class, 'getDefinedActions'), $type);\r
671         }\r
672         \r
673 }\r