utf8/nucleus/libs/BaseActions.php

   1 <?php
   2 /*
   3  * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)
   4  * Copyright (C) 2002-2009 The Nucleus Group
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  * (see nucleus/documentation/index.html#license for more info)
  11  */
  12 /**
  13  * This class contains parse actions that are available in all ACTION classes
  14  * e.g. include, phpinclude, parsedinclude, skinfile, ...
  15  *
  16  * It should never be used on it's own
  17  *
  18  * @license http://nucleuscms.org/license.txt GNU General Public License
  19  * @copyright Copyright (C) 2002-2009 The Nucleus Group
  20  * @version $Id$
  21  * @version $NucleusJP: BaseActions.php,v 1.2 2006/07/20 08:01:52 kimitake Exp $
  22  */
  23
  24 class BaseActions {
  25
  26         // depth level for includes (max. level is 3)
  27         var $level;
  28
  29         // array of evaluated conditions (true/false). The element at the end is the one for the most nested
  30         // if block.
  31         var $if_conditions;
  32
  33         // in the "elseif" / "elseifnot" sequences, if one of the conditions become "true" remained conditions should not
  34         // be tested. this variable (actually a stack) holds this information.
  35         var $if_execute;
  36
  37         // at all times, can be evaluated to either true if the current block needs to be displayed. This
  38         // variable is used to decide to skip skinvars in parts that will never be outputted.
  39         var $if_currentlevel;
  40
  41         // contains a search string with keywords that need to be highlighted. These get parsed into $aHighlight
  42         var $strHighlight;
  43
  44         // array of keywords that need to be highlighted in search results (see the highlight()
  45         // and parseHighlight() methods)
  46         var $aHighlight;
  47
  48         // reference to the parser object that is using this object as actions-handler
  49         var $parser;
  50
  51         function BaseActions() {
  52                 $this->level = 0;
  53
  54                 // if nesting level
  55                 $this->if_conditions = array(); // array on which condition values are pushed/popped
  56                 $this->if_execute = array();    // array on which condition values are pushed/popped
  57                 $this->if_currentlevel = 1;             // 1 = current level is displayed; 0 = current level not displayed
  58
  59                 // highlights
  60                 $this->strHighlight = '';                       // full highlight
  61                 $this->aHighlight = array();            // parsed highlight
  62
  63         }
  64
  65         // include file (no parsing of php)
  66         function parse_include($filename) {
  67                 @readfile($this->getIncludeFileName($filename));
  68         }
  69
  70         // php-include file
  71         function parse_phpinclude($filename) {
  72                 includephp($this->getIncludeFileName($filename));
  73         }
  74
  75         // parsed include
  76         function parse_parsedinclude($filename) {
  77                 // check current level
  78                 if ($this->level > 3) return;   // max. depth reached (avoid endless loop)
  79                 global $skinid;
  80                 if (!$skinid) {
  81                         global $manager, $blogid;
  82                         if (!$blogid) {
  83                                 global $CONF;
  84                                 $blogid = $CONF['DefaultBlog'];
  85                         }
  86                         $blog   = &$manager->getBlog($blogid);
  87                         $skinid =  $blog->getDefaultSkin();
  88                 }
  89                 $skin = new SKIN($skinid);
  90                 $file = $this->getIncludeFileName($filename);
  91                 if (!$skin->isValid && !file_exists($file)) {
  92                         return;
  93                 }
  94                 $parts = explode('|', $filename, 2);
  95                 if ($skin->getContent($parts[0])) {
  96                         $contents = $skin->getContent($parts[0]);
  97                 } else {
  98                         $filename = $this->getIncludeFileName($filename);
  99                         if (!file_exists($filename)) return '';
 100
 101                         $fsize = filesize($filename);
 102
 103                         // nothing to include
 104                         if ($fsize <= 0) return;
 105
 106                         $this->level = $this->level + 1;
 107
 108                         // read file
 109                         $fd = fopen ($filename, 'r');
 110                         $contents = fread ($fd, $fsize);
 111                         fclose ($fd);
 112                 }
 113
 114                 // parse file contents
 115                 $this->parser->parse($contents);
 116
 117                 $this->level = $this->level - 1;
 118         }
 119
 120         /**
 121          * Returns the correct location of the file to be included, according to
 122          * parser properties
 123          *
 124          * IF IncludeMode = 'skindir' => use skindir
 125          */
 126         function getIncludeFileName($filename) {
 127                 // leave absolute filenames and http urls as they are
 128                 if (
 129                                 (substr($filename,0,1) == '/')
 130                         ||      (substr($filename,0,7) == 'http://')
 131                         ||      (substr($filename,0,6) == 'ftp://')
 132                         )
 133                         return $filename;
 134
 135                 $filename = PARSER::getProperty('IncludePrefix') . $filename;
 136                 if (PARSER::getProperty('IncludeMode') == 'skindir') {
 137                         global $DIR_SKINS;
 138                         return $DIR_SKINS . $filename;
 139                 } else {
 140                         return $filename;
 141                 }
 142         }
 143
 144         /**
 145          * Inserts an url relative to the skindir (useful when doing import/export)
 146          *
 147          * e.g. <skinfile(default/myfile.sth)>
 148          */
 149         function parse_skinfile($filename) {
 150                 global $CONF;
 151
 152                 echo $CONF['SkinsURL'] . PARSER::getProperty('IncludePrefix') . $filename;
 153         }
 154
 155         /**
 156          * Sets a property for the parser
 157          */
 158         function parse_set($property, $value) {
 159                 PARSER::setProperty($property, $value);
 160         }
 161
 162         /**
 163          * Helper function: add if condition
 164          */
 165         function _addIfCondition($condition) {
 166
 167                 array_push($this->if_conditions,$condition);
 168
 169                 $this->_updateTopIfCondition();
 170
 171                 ob_start();
 172         }
 173
 174         function _updateTopIfCondition() {
 175                 if (sizeof($this->if_conditions) == 0)
 176                         $this->if_currentlevel = 1;
 177                 else
 178                         $this->if_currentlevel = $this->if_conditions[sizeof($this->if_conditions) - 1];
 179         }
 180
 181         /**
 182          * Helper function for elseif / elseifnot
 183          */
 184         function _addIfExecute() {
 185                 array_push($this->if_execute, 0);
 186         }
 187
 188         /**
 189          * Helper function for elseif / elseifnot
 190          * @param string condition to be fullfilled
 191          */
 192         function _updateIfExecute($condition) {
 193                 $index = sizeof($this->if_execute) - 1;
 194                 $this->if_execute[$index] = $this->if_execute[$index] || $condition;
 195         }
 196
 197         /**
 198          * returns the currently top if condition
 199          */
 200         function _getTopIfCondition() {
 201                 return $this->if_currentlevel;
 202         }
 203
 204         /**
 205          * Sets the search terms to be highlighted
 206          *
 207          * @param $highlight
 208          *              A series of search terms
 209          */
 210         function setHighlight($highlight) {
 211                 $this->strHighlight = $highlight;
 212                 if ($highlight) {
 213                         $this->aHighlight = parseHighlight($highlight);
 214                 }
 215         }
 216
 217         /**
 218          * Applies the highlight to the given piece of text
 219          *
 220          * @param &$data
 221          *              Data that needs to be highlighted
 222          * @see setHighlight
 223          */
 224         function highlight(&$data) {
 225                 if ($this->aHighlight)
 226                         return highlight($data,$this->aHighlight,$this->template['SEARCH_HIGHLIGHT']);
 227                 else
 228                         return $data;
 229         }
 230
 231         /**
 232          * Parses <%if%> statements
 233          */
 234         function parse_if() {
 235                 $this->_addIfExecute();
 236
 237                 $args = func_get_args();
 238                 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 239                 $this->_addIfCondition($condition);
 240         }
 241
 242         /**
 243          * Parses <%else%> statements
 244          */
 245         function parse_else() {
 246                 if (sizeof($this->if_conditions) == 0) return;
 247                 array_pop($this->if_conditions);
 248                 if ($this->if_currentlevel) {
 249                         ob_end_flush();
 250                         $this->_updateIfExecute(1);
 251                         $this->_addIfCondition(0);
 252                 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
 253                         ob_end_clean();
 254                         $this->_addIfCondition(0);
 255                 } else {
 256                         ob_end_clean();
 257                         $this->_addIfCondition(1);
 258                 }
 259         }
 260
 261         /**
 262          * Parses <%elseif%> statements
 263          */
 264         function parse_elseif() {
 265                 if (sizeof($this->if_conditions) == 0) return;
 266                 array_pop($this->if_conditions);
 267                 if ($this->if_currentlevel) {
 268                         ob_end_flush();
 269                         $this->_updateIfExecute(1);
 270                         $this->_addIfCondition(0);
 271                 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
 272                         ob_end_clean();
 273                         $this->_addIfCondition(0);
 274                 } else {
 275                         ob_end_clean();
 276                         $args = func_get_args();
 277                         $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 278                         $this->_addIfCondition($condition);
 279                 }
 280         }
 281
 282         /**
 283          * Parses <%ifnot%> statements
 284          */
 285         function parse_ifnot() {
 286                 $this->_addIfExecute();
 287
 288                 $args = func_get_args();
 289                 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 290                 $this->_addIfCondition(!$condition);
 291         }
 292
 293         /**
 294          * Parses <%elseifnot%> statements
 295          */
 296         function parse_elseifnot() {
 297                 if (sizeof($this->if_conditions) == 0) return;
 298                 array_pop($this->if_conditions);
 299                 if ($this->if_currentlevel) {
 300                         ob_end_flush();
 301                         $this->_updateIfExecute(1);
 302                         $this->_addIfCondition(0);
 303                 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
 304                         ob_end_clean();
 305                         $this->_addIfCondition(0);
 306                 } else {
 307                         ob_end_clean();
 308                         $args = func_get_args();
 309                         $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 310                         $this->_addIfCondition(!$condition);
 311                 }
 312         }
 313
 314         /**
 315          * Ends a conditional if-block
 316          * see e.g. ifcat (BLOG), ifblogsetting (PAGEFACTORY)
 317          */
 318         function parse_endif() {
 319                 // we can only close what has been opened
 320                 if (sizeof($this->if_conditions) == 0) return;
 321
 322                 if ($this->if_currentlevel) {
 323                         ob_end_flush();
 324                 } else {
 325                         ob_end_clean();
 326                 }
 327                 array_pop($this->if_conditions);
 328                 array_pop($this->if_execute);
 329
 330                 $this->_updateTopIfCondition();
 331         }
 332 }
 333 ?>