3 * Nucleus: PHP/MySQL Weblog CMS (http://nucleuscms.org/)
4 * Copyright (C) 2002-2007 The Nucleus Group
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)
13 * This class contains parse actions that are available in all ACTION classes
14 * e.g. include, phpinclude, parsedinclude, skinfile, ...
16 * It should never be used on it's own
18 * @license http://nucleuscms.org/license.txt GNU General Public License
19 * @copyright Copyright (C) 2002-2007 The Nucleus Group
20 * @version $Id: BaseActions.php,v 1.3 2007-02-04 06:28:46 kimitake Exp $
21 * @version $NucleusJP: BaseActions.php,v 1.2 2006/07/20 08:01:52 kimitake Exp $
26 // depth level for includes (max. level is 3)
29 // array of evaluated conditions (true/false). The element at the end is the one for the most nested
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.
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.
41 // contains a search string with keywords that need to be highlighted. These get parsed into $aHighlight
44 // array of keywords that need to be highlighted in search results (see the highlight()
45 // and parseHighlight() methods)
48 // reference to the parser object that is using this object as actions-handler
51 function BaseActions() {
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
60 $this->strHighlight = ''; // full highlight
61 $this->aHighlight = array(); // parsed highlight
65 // include file (no parsing of php)
66 function parse_include($filename) {
67 @readfile($this->getIncludeFileName($filename));
71 function parse_phpinclude($filename) {
72 includephp($this->getIncludeFileName($filename));
76 function parse_parsedinclude($filename) {
77 // check current level
78 if ($this->level > 3) return; // max. depth reached (avoid endless loop)
79 $filename = $this->getIncludeFileName($filename);
80 if (!file_exists($filename)) return '';
82 $fsize = filesize($filename);
88 $this->level = $this->level + 1;
91 $fd = fopen ($filename, 'r');
92 $contents = fread ($fd, $fsize);
95 // parse file contents
96 $this->parser->parse($contents);
98 $this->level = $this->level - 1;
102 * Returns the correct location of the file to be included, according to
105 * IF IncludeMode = 'skindir' => use skindir
107 function getIncludeFileName($filename) {
108 // leave absolute filenames and http urls as they are
110 (substr($filename,0,1) == '/')
111 || (substr($filename,0,7) == 'http://')
112 || (substr($filename,0,6) == 'ftp://')
116 $filename = PARSER::getProperty('IncludePrefix') . $filename;
117 if (PARSER::getProperty('IncludeMode') == 'skindir') {
119 return $DIR_SKINS . $filename;
126 * Inserts an url relative to the skindir (useful when doing import/export)
128 * e.g. <skinfile(default/myfile.sth)>
130 function parse_skinfile($filename) {
133 echo $CONF['SkinsURL'] . PARSER::getProperty('IncludePrefix') . $filename;
137 * Sets a property for the parser
139 function parse_set($property, $value) {
140 PARSER::setProperty($property, $value);
144 * Helper function: add if condition
146 function _addIfCondition($condition) {
148 array_push($this->if_conditions,$condition);
150 $this->_updateTopIfCondition();
155 function _updateTopIfCondition() {
156 if (sizeof($this->if_conditions) == 0)
157 $this->if_currentlevel = 1;
159 $this->if_currentlevel = $this->if_conditions[sizeof($this->if_conditions) - 1];
163 * Helper function for elseif / elseifnot
165 function _addIfExecute() {
166 array_push($this->if_execute, 0);
170 * Helper function for elseif / elseifnot
171 * @param string condition to be fullfilled
173 function _updateIfExecute($condition) {
174 $index = sizeof($this->if_execute) - 1;
175 $this->if_execute[$index] = $this->if_execute[$index] || $condition;
179 * returns the currently top if condition
181 function _getTopIfCondition() {
182 return $this->if_currentlevel;
186 * Sets the search terms to be highlighted
189 * A series of search terms
191 function setHighlight($highlight) {
192 $this->strHighlight = $highlight;
194 $this->aHighlight = parseHighlight($highlight);
199 * Applies the highlight to the given piece of text
202 * Data that needs to be highlighted
205 function highlight(&$data) {
206 if ($this->aHighlight)
207 return highlight($data,$this->aHighlight,$this->template['SEARCH_HIGHLIGHT']);
213 * Parses <%if%> statements
215 function parse_if() {
216 $this->_addIfExecute();
218 $args = func_get_args();
219 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
220 $this->_addIfCondition($condition);
224 * Parses <%else%> statements
226 function parse_else() {
227 if (sizeof($this->if_conditions) == 0) return;
228 array_pop($this->if_conditions);
229 if ($this->if_currentlevel) {
231 $this->_updateIfExecute(1);
232 $this->_addIfCondition(0);
233 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
235 $this->_addIfCondition(0);
238 $this->_addIfCondition(1);
243 * Parses <%elseif%> statements
245 function parse_elseif() {
246 if (sizeof($this->if_conditions) == 0) return;
247 array_pop($this->if_conditions);
248 if ($this->if_currentlevel) {
250 $this->_updateIfExecute(1);
251 $this->_addIfCondition(0);
252 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
254 $this->_addIfCondition(0);
257 $args = func_get_args();
258 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
259 $this->_addIfCondition($condition);
264 * Parses <%ifnot%> statements
266 function parse_ifnot() {
267 $this->_addIfExecute();
269 $args = func_get_args();
270 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
271 $this->_addIfCondition(!$condition);
275 * Parses <%elseifnot%> statements
277 function parse_elseifnot() {
278 if (sizeof($this->if_conditions) == 0) return;
279 array_pop($this->if_conditions);
280 if ($this->if_currentlevel) {
282 $this->_updateIfExecute(1);
283 $this->_addIfCondition(0);
284 } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
286 $this->_addIfCondition(0);
289 $args = func_get_args();
290 $condition = call_user_func_array(array(&$this,'checkCondition'), $args);
291 $this->_addIfCondition(!$condition);
296 * Ends a conditional if-block
297 * see e.g. ifcat (BLOG), ifblogsetting (PAGEFACTORY)
299 function parse_endif() {
300 // we can only close what has been opened
301 if (sizeof($this->if_conditions) == 0) return;
303 if ($this->if_currentlevel) {
308 array_pop($this->if_conditions);
309 array_pop($this->if_execute);
311 $this->_updateTopIfCondition();