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                 $skin = new SKIN($skinid);
  81                 $file = $this->getIncludeFileName($filename);
  82                 if (!$skin->isValid && !file_exists($file)) {
  83                         return;
  84                 }
  85                 $parts = explode('|', $filename, 2);
  86                 if ($skin->getContent($parts[0])) {
  87                         $contents = $skin->getContent($parts[0]);
  88                 } else {
  89                         $filename = $this->getIncludeFileName($filename);
  90                         if (!file_exists($filename)) return '';
  91
  92                         $fsize = filesize($filename);
  93
  94                         // nothing to include
  95                         if ($fsize <= 0) return;
  96
  97                         $this->level = $this->level + 1;
  98
  99                         // read file
 100                         $fd = fopen ($filename, 'r');
 101                         $contents = fread ($fd, $fsize);
 102                         fclose ($fd);
 103                 }
 104
 105                 // parse file contents
 106                 $this->parser->parse($contents);
 107
 108                 $this->level = $this->level - 1;
 109         }
 110
 111         /**
 112          * Returns the correct location of the file to be included, according to
 113          * parser properties
 114          *
 115          * IF IncludeMode = 'skindir' => use skindir
 116          */
 117         function getIncludeFileName($filename) {
 118                 // leave absolute filenames and http urls as they are
 119                 if (
 120                                 (substr($filename,0,1) == '/')
 121                         ||      (substr($filename,0,7) == 'http://')
 122                         ||      (substr($filename,0,6) == 'ftp://')
 123                         )
 124                         return $filename;
 125
 126                 $filename = PARSER::getProperty('IncludePrefix') . $filename;
 127                 if (PARSER::getProperty('IncludeMode') == 'skindir') {
 128                         global $DIR_SKINS;
 129                         return $DIR_SKINS . $filename;
 130                 } else {
 131                         return $filename;
 132                 }
 133         }
 134
 135         /**
 136          * Inserts an url relative to the skindir (useful when doing import/export)
 137          *
 138          * e.g. <skinfile(default/myfile.sth)>
 139          */
 140         function parse_skinfile($filename) {
 141                 global $CONF;
 142
 143                 echo $CONF['SkinsURL'] . PARSER::getProperty('IncludePrefix') . $filename;
 144         }
 145
 146         /**
 147          * Sets a property for the parser
 148          */
 149         function parse_set($property, $value) {
 150                 PARSER::setProperty($property, $value);
 151         }
 152
 153         /**
 154          * Helper function: add if condition
 155          */
 156         function _addIfCondition($condition) {
 157
 158                 array_push($this->if_conditions,$condition);
 159
 160                 $this->_updateTopIfCondition();
 161
 162                 ob_start();
 163         }
 164
 165         function _updateTopIfCondition() {
 166                 if (sizeof($this->if_conditions) == 0)
 167                         $this->if_currentlevel = 1;
 168                 else
 169                         $this->if_currentlevel = $this->if_conditions[sizeof($this->if_conditions) - 1];
 170         }
 171
 172         /**
 173          * Helper function for elseif / elseifnot
 174          */
 175         function _addIfExecute() {
 176                 array_push($this->if_execute, 0);
 177         }
 178
 179         /**
 180          * Helper function for elseif / elseifnot
 181          * @param string condition to be fullfilled
 182          */
 183         function _updateIfExecute($condition) {
 184                 $index = sizeof($this->if_execute) - 1;
 185                 $this->if_execute[$index] = $this->if_execute[$index] || $condition;
 186         }
 187
 188         /**
 189          * returns the currently top if condition
 190          */
 191         function _getTopIfCondition() {
 192                 return $this->if_currentlevel;
 193         }
 194
 195         /**
 196          * Sets the search terms to be highlighted
 197          *
 198          * @param $highlight
 199          *              A series of search terms
 200          */
 201         function setHighlight($highlight) {
 202                 $this->strHighlight = $highlight;
 203                 if ($highlight) {
 204                         $this->aHighlight = parseHighlight($highlight);
 205                 }
 206         }
 207
 208         /**
 209          * Applies the highlight to the given piece of text
 210          *
 211          * @param &$data
 212          *              Data that needs to be highlighted
 213          * @see setHighlight
 214          */
 215         function highlight(&$data) {
 216                 if ($this->aHighlight)
 217                         return highlight($data,$this->aHighlight,$this->template['SEARCH_HIGHLIGHT']);
 218                 else
 219                         return $data;
 220         }
 221
 222         /**
 223          * Parses <%if%> statements
 224          */
 225         function parse_if() {
 226                 $this->_addIfExecute();
 227
 228                 $args = func_get_args();
 229                 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 230                 $this->_addIfCondition($condition);
 231         }
 232
 233         /**
 234          * Parses <%else%> statements
 235          */
 236         function parse_else() {
 237                 if (sizeof($this->if_conditions) == 0) return;
 238                 array_pop($this->if_conditions);
 239                 if ($this->if_currentlevel) {
 240                         ob_end_flush();
 241                         $this->_updateIfExecute(1);
 242                         $this->_addIfCondition(0);
 243                 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
 244                         ob_end_clean();
 245                         $this->_addIfCondition(0);
 246                 } else {
 247                         ob_end_clean();
 248                         $this->_addIfCondition(1);
 249                 }
 250         }
 251
 252         /**
 253          * Parses <%elseif%> statements
 254          */
 255         function parse_elseif() {
 256                 if (sizeof($this->if_conditions) == 0) return;
 257                 array_pop($this->if_conditions);
 258                 if ($this->if_currentlevel) {
 259                         ob_end_flush();
 260                         $this->_updateIfExecute(1);
 261                         $this->_addIfCondition(0);
 262                 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
 263                         ob_end_clean();
 264                         $this->_addIfCondition(0);
 265                 } else {
 266                         ob_end_clean();
 267                         $args = func_get_args();
 268                         $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 269                         $this->_addIfCondition($condition);
 270                 }
 271         }
 272
 273         /**
 274          * Parses <%ifnot%> statements
 275          */
 276         function parse_ifnot() {
 277                 $this->_addIfExecute();
 278
 279                 $args = func_get_args();
 280                 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 281                 $this->_addIfCondition(!$condition);
 282         }
 283
 284         /**
 285          * Parses <%elseifnot%> statements
 286          */
 287         function parse_elseifnot() {
 288                 if (sizeof($this->if_conditions) == 0) return;
 289                 array_pop($this->if_conditions);
 290                 if ($this->if_currentlevel) {
 291                         ob_end_flush();
 292                         $this->_updateIfExecute(1);
 293                         $this->_addIfCondition(0);
 294                 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
 295                         ob_end_clean();
 296                         $this->_addIfCondition(0);
 297                 } else {
 298                         ob_end_clean();
 299                         $args = func_get_args();
 300                         $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
 301                         $this->_addIfCondition(!$condition);
 302                 }
 303         }
 304
 305         /**
 306          * Ends a conditional if-block
 307          * see e.g. ifcat (BLOG), ifblogsetting (PAGEFACTORY)
 308          */
 309         function parse_endif() {
 310                 // we can only close what has been opened
 311                 if (sizeof($this->if_conditions) == 0) return;
 312
 313                 if ($this->if_currentlevel) {
 314                         ob_end_flush();
 315                 } else {
 316                         ob_end_clean();
 317                 }
 318                 array_pop($this->if_conditions);
 319                 array_pop($this->if_execute);
 320
 321                 $this->_updateTopIfCondition();
 322         }
 323 }
 324 ?>