[FEATURE] Add wincache as a cache backend
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_scbase.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains the parent class for 'ScriptClasses' in backend modules.
29 *
30 * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
31 *
32 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
33 */
34
35 /**
36 * EXAMPLE PROTOTYPE
37 *
38 * As for examples there are lots of them if you search for classes which extends 't3lib_SCbase'.
39 * However you can see a prototype example of how a module might use this class in an index.php file typically hosting a backend module.
40 * NOTICE: This example only outlines the basic structure of how this class is used. You should consult the documentation and other real-world examples for some actual things to do when building modules.
41 *
42 * // TYPICAL 'HEADER' OF A BACKEND MODULE:
43 * unset($MCONF);
44 * require ('conf.php');
45 * require ($BACK_PATH.'init.php');
46 * require ($BACK_PATH.'template.php');
47 * $GLOBALS['LANG']->includeLLFile('EXT:prototype/locallang.php');
48 * $GLOBALS['BE_USER']->modAccess($MCONF,1);
49 *
50 * // SC_mod_prototype EXTENDS THE CLASS t3lib_SCbase with a main() and printContent() function:
51 * class SC_mod_prototype extends t3lib_SCbase {
52 * // MAIN FUNCTION - HERE YOU CREATE THE MODULE CONTENT IN $this->content
53 * function main() {
54 * // TYPICALLY THE INTERNAL VAR, $this->doc is instantiated like this:
55 * $this->doc = t3lib_div::makeInstance('mediumDoc');
56 * // TYPICALLY THE INTERNAL VAR, $this->backPath is set like this:
57 * $this->backPath = $this->doc->backPath = $GLOBALS['BACK_PATH'];
58 * // ... AND OF COURSE A LOT OF OTHER THINGS GOES ON - LIKE PUTTING CONTENT INTO $this->content
59 * $this->content='';
60 * }
61 * // PRINT CONTENT - DONE AS THE LAST THING
62 * function printContent() {
63 * echo $this->content;
64 * }
65 * }
66 *
67 * // MAKE INSTANCE OF THE SCRIPT CLASS AND CALL init()
68 * $SOBE = t3lib_div::makeInstance('SC_mod_prototype');
69 * $SOBE->init();
70 *
71 * // AFTER INIT THE INTERNAL ARRAY ->include_once MAY HOLD FILENAMES TO INCLUDE
72 * foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
73 *
74 * // THEN WE WILL CHECK IF THERE IS A 'SUBMODULE' REGISTERED TO BE INITIALIZED AS WELL:
75 * $SOBE->checkExtObj();
76 *
77 * // THEN WE CALL THE main() METHOD AND THIS SHOULD SPARK THE CREATION OF THE MODULE OUTPUT.
78 * $SOBE->main();
79 * // FINALLY THE printContent() FUNCTION WILL OUTPUT THE ACCUMULATED CONTENT
80 * $SOBE->printContent();
81 */
82
83 /**
84 * Parent class for 'ScriptClasses' in backend modules.
85 * See example comment above.
86 *
87 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
88 * @package TYPO3
89 * @subpackage t3lib
90 * @see t3lib_extobjbase
91 */
92 class t3lib_SCbase {
93
94 /**
95 * Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.
96 * @see init()
97 */
98 var $MCONF = array();
99
100 /**
101 * The integer value of the GET/POST var, 'id'. Used for submodules to the 'Web' module (page id)
102 * @see init()
103 */
104 var $id;
105
106 /**
107 * The value of GET/POST var, 'CMD'
108 * @see init()
109 */
110 var $CMD;
111
112 /**
113 * A WHERE clause for selection records from the pages table based on read-permissions of the current backend user.
114 * @see init()
115 */
116 var $perms_clause;
117
118 /**
119 * The module menu items array. Each key represents a key for which values can range between the items in the array of that key.
120 * @see init()
121 */
122 var $MOD_MENU = array(
123 'function' => array()
124 );
125
126 /**
127 * Current settings for the keys of the MOD_MENU array
128 * @see $MOD_MENU
129 */
130 var $MOD_SETTINGS = array();
131
132 /**
133 * Module TSconfig based on PAGE TSconfig / USER TSconfig
134 * @see menuConfig()
135 */
136 var $modTSconfig;
137
138 /**
139 * If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in.
140 * Can be set from extension classes of this class before the init() function is called.
141 *
142 * @see menuConfig(), t3lib_BEfunc::getModuleData()
143 */
144 var $modMenu_type = '';
145
146 /**
147 * dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus.
148 * Can be set from extension classes of this class before the init() function is called.
149 *
150 * @see menuConfig(), t3lib_BEfunc::getModuleData()
151 */
152 var $modMenu_dontValidateList = '';
153
154 /**
155 * List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)
156 * Can be set from extension classes of this class before the init() function is called.
157 *
158 * @see menuConfig(), t3lib_BEfunc::getModuleData()
159 */
160 var $modMenu_setDefaultList = '';
161
162 /**
163 * Contains module configuration parts from TBE_MODULES_EXT if found
164 *
165 * @see handleExternalFunctionValue()
166 */
167 var $extClassConf;
168
169 /**
170 * Contains absolute paths to class files to include from the global scope. This is done in the module index.php files after calling the init() function
171 *
172 * @see handleExternalFunctionValue()
173 */
174 var $include_once = array();
175
176 /**
177 * Generally used for accumulating the output content of backend modules
178 */
179 var $content = '';
180
181 /**
182 * Generally used to hold an instance of the 'template' class from typo3/template.php
183 *
184 * @var template
185 */
186 var $doc;
187
188 /**
189 * May contain an instance of a 'Function menu module' which connects to this backend module.
190 *
191 * @see checkExtObj()
192 */
193 var $extObj;
194
195 /**
196 * Initializes the backend module by setting internal variables, initializing the menu.
197 *
198 * @return void
199 * @see menuConfig()
200 */
201 function init() {
202 // Name might be set from outside
203 if (!$this->MCONF['name']) {
204 $this->MCONF = $GLOBALS['MCONF'];
205 }
206 $this->id = intval(t3lib_div::_GP('id'));
207 $this->CMD = t3lib_div::_GP('CMD');
208 $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
209 $this->menuConfig();
210 $this->handleExternalFunctionValue();
211 }
212
213 /**
214 * Initializes the internal MOD_MENU array setting and unsetting items based on various conditions. It also merges in external menu items from the global array TBE_MODULES_EXT (see mergeExternalItems())
215 * Then MOD_SETTINGS array is cleaned up (see t3lib_BEfunc::getModuleData()) so it contains only valid values. It's also updated with any SET[] values submitted.
216 * Also loads the modTSconfig internal variable.
217 *
218 * @return void
219 * @see init(), $MOD_MENU, $MOD_SETTINGS, t3lib_BEfunc::getModuleData(), mergeExternalItems()
220 */
221 function menuConfig() {
222 // Page/be_user TSconfig settings and blinding of menu-items
223 $this->modTSconfig = t3lib_BEfunc::getModTSconfig($this->id, 'mod.' . $this->MCONF['name']);
224 $this->MOD_MENU['function'] = $this->mergeExternalItems($this->MCONF['name'], 'function', $this->MOD_MENU['function']);
225 $this->MOD_MENU['function'] = t3lib_BEfunc::unsetMenuItems($this->modTSconfig['properties'], $this->MOD_MENU['function'], 'menu.function');
226
227 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData(
228 $this->MOD_MENU,
229 t3lib_div::_GP('SET'),
230 $this->MCONF['name'],
231 $this->modMenu_type,
232 $this->modMenu_dontValidateList,
233 $this->modMenu_setDefaultList
234 );
235 }
236
237 /**
238 * Merges menu items from global array $TBE_MODULES_EXT
239 *
240 * @param string $modName Module name for which to find value
241 * @param string $menuKey Menu key, eg. 'function' for the function menu.
242 * @param array $menuArr The part of a MOD_MENU array to work on.
243 * @return array Modified array part.
244 * @access private
245 * @see t3lib_extMgm::insertModuleFunction(), menuConfig()
246 */
247 function mergeExternalItems($modName, $menuKey, $menuArr) {
248 $mergeArray = $GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
249 if (is_array($mergeArray)) {
250 foreach ($mergeArray as $k => $v) {
251 if ((string) $v['ws'] === '' ||
252 ($GLOBALS['BE_USER']->workspace === 0 && t3lib_div::inList($v['ws'], 'online')) ||
253 ($GLOBALS['BE_USER']->workspace === -1 && t3lib_div::inList($v['ws'], 'offline')) ||
254 ($GLOBALS['BE_USER']->workspace > 0 && t3lib_div::inList($v['ws'], 'custom'))) {
255 $menuArr[$k] = $GLOBALS['LANG']->sL($v['title']);
256 }
257 }
258 }
259 return $menuArr;
260 }
261
262 /**
263 * Loads $this->extClassConf with the configuration for the CURRENT function of the menu.
264 * If for this array the key 'path' is set then that is expected to be an absolute path to a file which should be included - so it is set in the internal array $this->include_once
265 *
266 * @param string $MM_key The key to MOD_MENU for which to fetch configuration. 'function' is default since it is first and foremost used to get information per "extension object" (I think that is what its called)
267 * @param string $MS_value The value-key to fetch from the config array. If NULL (default) MOD_SETTINGS[$MM_key] will be used. This is usefull if you want to force another function than the one defined in MOD_SETTINGS[function]. Call this in init() function of your Script Class: handleExternalFunctionValue('function', $forcedSubModKey)
268 * @return void
269 * @see getExternalItemConfig(), $include_once, init()
270 */
271 function handleExternalFunctionValue($MM_key = 'function', $MS_value = NULL) {
272 $MS_value = is_null($MS_value) ? $this->MOD_SETTINGS[$MM_key] : $MS_value;
273 $this->extClassConf = $this->getExternalItemConfig($this->MCONF['name'], $MM_key, $MS_value);
274 if (is_array($this->extClassConf) && $this->extClassConf['path']) {
275 $this->include_once[] = $this->extClassConf['path'];
276 }
277 }
278
279 /**
280 * Returns configuration values from the global variable $TBE_MODULES_EXT for the module given.
281 * For example if the module is named "web_info" and the "function" key ($menuKey) of MOD_SETTINGS is "stat" ($value) then you will have the values of $TBE_MODULES_EXT['webinfo']['MOD_MENU']['function']['stat'] returned.
282 *
283 * @param string $modName Module name
284 * @param string $menuKey Menu key, eg. "function" for the function menu. See $this->MOD_MENU
285 * @param string $value Optionally the value-key to fetch from the array that would otherwise have been returned if this value was not set. Look source...
286 * @return mixed The value from the TBE_MODULES_EXT array.
287 * @see handleExternalFunctionValue()
288 */
289 function getExternalItemConfig($modName, $menuKey, $value = '') {
290 return strcmp($value, '') ? $GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey][$value] : $GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];
291 }
292
293 /**
294 * Creates an instance of the class found in $this->extClassConf['name'] in $this->extObj if any (this should hold three keys, "name", "path" and "title" if a "Function menu module" tries to connect...)
295 * This value in extClassConf might be set by an extension (in a ext_tables/ext_localconf file) which thus "connects" to a module.
296 * The array $this->extClassConf is set in handleExternalFunctionValue() based on the value of MOD_SETTINGS[function]
297 * (Should be) called from global scope right after inclusion of files from the ->include_once array.
298 * If an instance is created it is initiated with $this passed as value and $this->extClassConf as second argument. Further the $this->MOD_SETTING is cleaned up again after calling the init function.
299 *
300 * @return void
301 * @see handleExternalFunctionValue(), t3lib_extMgm::insertModuleFunction(), $extObj
302 */
303 function checkExtObj() {
304 if (is_array($this->extClassConf) && $this->extClassConf['name']) {
305 $this->extObj = t3lib_div::makeInstance($this->extClassConf['name']);
306 $this->extObj->init($this, $this->extClassConf);
307 // Re-write:
308 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData(
309 $this->MOD_MENU,
310 t3lib_div::_GP('SET'),
311 $this->MCONF['name'],
312 $this->modMenu_type,
313 $this->modMenu_dontValidateList,
314 $this->modMenu_setDefaultList
315 );
316 }
317 }
318
319 /**
320 * Calls the checkExtObj function in sub module if present.
321 *
322 * @return void
323 */
324 function checkSubExtObj() {
325 if (is_object($this->extObj)) {
326 $this->extObj->checkExtObj();
327 }
328 }
329
330 /**
331 * Calls the 'header' function inside the "Function menu module" if present.
332 * A header function might be needed to add JavaScript or other stuff in the head. This can't be done in the main function because the head is already written.
333 * example call in the header function:
334 * $this->pObj->doc->JScode = $this->pObj->doc->wrapScriptTags(' ...
335 *
336 * @return void
337 */
338 function extObjHeader() {
339 if (is_callable(array($this->extObj, 'head'))) {
340 $this->extObj->head();
341 }
342 }
343
344 /**
345 * Calls the 'main' function inside the "Function menu module" if present
346 *
347 * @return void
348 */
349 function extObjContent() {
350 $this->extObj->pObj = $this;
351
352 if (is_callable(array($this->extObj, 'main'))) {
353 $this->content .= $this->extObj->main();
354 }
355 }
356 }
357
358 ?>