Fixed bug #10597: Admin panel is not available anymore when extension fe_edit is...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_tsfebeuserauth.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 Kasper Skaarhoj (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 * Class for TYPO3 backend user authentication in the TSFE frontend
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 103: class t3lib_tsfeBeUserAuth extends t3lib_beUserAuth
42 * 129: function extInitFeAdmin()
43 * 154: function extPrintFeAdminDialog()
44 *
45 * SECTION: Creating sections of the Admin Panel
46 * 250: function extGetCategory_preview($out='')
47 * 283: function extGetCategory_cache($out='')
48 * 321: function extGetCategory_publish($out='')
49 * 356: function extGetCategory_edit($out='')
50 * 400: function extGetCategory_tsdebug($out='')
51 * 433: function extGetCategory_info($out='')
52 *
53 * SECTION: Admin Panel Layout Helper functions
54 * 506: function extGetHead($pre)
55 * 526: function extItemLink($pre,$str)
56 * 542: function extGetItem($pre,$element)
57 * 559: function extFw($str)
58 * 568: function ext_makeToolBar()
59 *
60 * SECTION: TSFE BE user Access Functions
61 * 637: function checkBackendAccessSettingsFromInitPhp()
62 * 682: function extPageReadAccess($pageRec)
63 * 693: function extAdmModuleEnabled($key)
64 * 709: function extSaveFeAdminConfig()
65 * 741: function extGetFeAdminValue($pre,$val='')
66 * 783: function extIsAdmMenuOpen($pre)
67 *
68 * SECTION: TSFE BE user Access Functions
69 * 818: function extGetTreeList($id,$depth,$begin=0,$perms_clause)
70 * 849: function extGetNumberOfCachedPages($page_id)
71 *
72 * SECTION: Localization handling
73 * 888: function extGetLL($key)
74 *
75 * SECTION: Frontend Editing
76 * 932: function extIsEditAction()
77 * 954: function extIsFormShown()
78 * 970: function extEditAction()
79 *
80 * TOTAL FUNCTIONS: 25
81 * (This index is automatically created/updated by the extension "extdeveval")
82 *
83 */
84
85
86
87
88
89
90
91
92
93
94
95 /**
96 * TYPO3 backend user authentication in the TSFE frontend.
97 * This includes mainly functions related to the Admin Panel
98 *
99 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
100 * @package TYPO3
101 * @subpackage t3lib
102 */
103 class t3lib_tsfeBeUserAuth extends t3lib_beUserAuth {
104 /**
105 * Form field with login name.
106 *
107 * @var string
108 */
109 public $formfield_uname = '';
110
111 /**
112 * Form field with password.
113 *
114 * @var string
115 */
116 public $formfield_uident = '';
117
118 /**
119 * Form field with a unique value which is used to encrypt the password and username.
120 *
121 * @var string
122 */
123 public $formfield_chalvalue = '';
124
125 /**
126 * Sets the level of security. *'normal' = clear-text. 'challenged' = hashed password/username.
127 * from form in $formfield_uident. 'superchallenged' = hashed password hashed again with username.
128 *
129 * @var string
130 */
131 public $security_level = '';
132
133 /**
134 * Decides if the writelog() function is called at login and logout.
135 *
136 * @var boolean
137 */
138 public $writeStdLog = false;
139
140 /**
141 * If the writelog() functions is called if a login-attempt has be tried without success.
142 *
143 * @var boolean
144 */
145 public $writeAttemptLog = false;
146
147 /**
148 * This is the name of the include-file containing the login form. If not set, login CAN be anonymous. If set login IS needed.
149 *
150 * @var string
151 */
152 public $auth_include = '';
153
154 /**
155 * Array of page related information (uid, title, depth).
156 *
157 * @var array
158 */
159 public $extPageInTreeInfo = array();
160
161 /**
162 * General flag which is set if the adminpanel should be displayed at all.
163 *
164 * @var boolean
165 */
166 public $extAdmEnabled = false;
167
168 /**
169 * Instance of the admin panel
170 *
171 * @var tslib_AdminPanel
172 */
173 public $adminPanel = null;
174
175 /**
176 * Class for frontend editing.
177 *
178 * @var t3lib_frontendedit
179 */
180 public $frontendEdit = null;
181
182 /**
183 * Initializes the admin panel.
184 *
185 * @return void
186 */
187 public function initializeAdminPanel() {
188 $this->extAdminConfig = $this->getTSConfigProp('admPanel');
189
190 if (isset($this->extAdminConfig['enable.'])) {
191 foreach($this->extAdminConfig['enable.'] as $key => $value) {
192 if ($value) {
193 $GLOBALS['TSFE']->includeTCA();
194
195 $this->adminPanel = t3lib_div::makeInstance('tslib_AdminPanel');
196 $this->extAdmEnabled = true;
197
198 break;
199 }
200 }
201 }
202 }
203
204 /**
205 * Initializes frontend editing.
206 *
207 * @return void
208 */
209 public function initializeFrontendEdit() {
210 if (isset($this->extAdminConfig['enable.']) && t3lib_extMgm::isLoaded('fe_edit')) {
211 foreach($this->extAdminConfig['enable.'] as $key => $value) {
212 if ($value) {
213 if ($GLOBALS['TSFE'] instanceof tslib_fe) {
214 // Grab the Page TSConfig property that determines which controller to use.
215 $pageTSConfig = $GLOBALS['TSFE']->getPagesTSconfig();
216 $controllerKey = isset($pageTSConfig['TSFE.']['frontendEditingController']) ? $pageTSConfig['TSFE.']['frontendEditingController'] : 'default';
217 } else {
218 $controllerKey = 'default';
219 }
220
221 $controllerClass = $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tsfebeuserauth.php']['frontendEditingController'][$controllerKey];
222 if ($controllerClass) {
223 $this->frontendEdit = t3lib_div::getUserObj($controllerClass, false);
224 }
225
226 break;
227 }
228 }
229 }
230 }
231
232 /**
233 * Determines whether frontend editing is currently active.
234 *
235 * @return boolean Wheter frontend editing is active
236 */
237 public function isFrontendEditingActive() {
238 return ($this->extAdmEnabled
239 && ($this->adminPanel->isAdminModuleEnabled('edit') && $this->adminPanel->isAdminModuleOpen('edit')
240 || $GLOBALS['TSFE']->displayEditIcons == 1)
241 );
242 }
243
244 /**
245 * Delegates to the appropriate view and renders the admin panel content.
246 *
247 * @return string.
248 */
249 public function displayAdminPanel() {
250 if (!$this->extAdminConfig['hide'] && $GLOBALS['TSFE']->config['config']['admPanel']) {
251 $content = $this->adminPanel->display();
252 }
253
254 return $content;
255 }
256
257 /*****************************************************
258 *
259 * TSFE BE user Access Functions
260 *
261 ****************************************************/
262
263 /**
264 * Implementing the access checks that the typo3/init.php script does before a user is ever logged in.
265 * Used in the frontend.
266 *
267 * @return boolean Returns true if access is OK
268 * @see typo3/init.php, t3lib_beuserauth::backendCheckLogin()
269 */
270 public function checkBackendAccessSettingsFromInitPhp() {
271 global $TYPO3_CONF_VARS;
272
273 // **********************
274 // Check Hardcoded lock on BE:
275 // **********************
276 if ($TYPO3_CONF_VARS['BE']['adminOnly'] < 0) {
277 return false;
278 }
279
280 // **********************
281 // Check IP
282 // **********************
283 if (trim($TYPO3_CONF_VARS['BE']['IPmaskList'])) {
284 if (!t3lib_div::cmpIP(t3lib_div::getIndpEnv('REMOTE_ADDR'), $TYPO3_CONF_VARS['BE']['IPmaskList'])) {
285 return false;
286 }
287 }
288
289
290 // **********************
291 // Check SSL (https)
292 // **********************
293 if (intval($TYPO3_CONF_VARS['BE']['lockSSL']) && $TYPO3_CONF_VARS['BE']['lockSSL'] != 3) {
294 if (!t3lib_div::getIndpEnv('TYPO3_SSL')) {
295 return false;
296 }
297 }
298
299 // Finally a check from t3lib_beuserauth::backendCheckLogin()
300 if (!$TYPO3_CONF_VARS['BE']['adminOnly'] || $this->isAdmin()) {
301 return true;
302 } else {
303 return false;
304 }
305 }
306
307
308 /**
309 * Evaluates if the Backend User has read access to the input page record.
310 * The evaluation is based on both read-permission and whether the page is found in one of the users webmounts. Only if both conditions are true will the function return true.
311 * Read access means that previewing is allowed etc.
312 * Used in index_ts.php
313 *
314 * @param array The page record to evaluate for
315 * @return boolean True if read access
316 */
317 public function extPageReadAccess($pageRec) {
318 return $this->isInWebMount($pageRec['uid']) && $this->doesUserHaveAccess($pageRec, 1);
319 }
320
321 /*****************************************************
322 *
323 * TSFE BE user Access Functions
324 *
325 ****************************************************/
326
327 /**
328 * Generates a list of Page-uid's from $id. List does not include $id itself
329 * The only pages excluded from the list are deleted pages.
330 *
331 * @param integer Start page id
332 * @param integer Depth to traverse down the page tree.
333 * @param integer $begin is an optional integer that determines at which level in the tree to start collecting uid's. Zero means 'start right away', 1 = 'next level and out'
334 * @param string Perms clause
335 * @return string Returns the list with a comma in the end (if any pages selected!)
336 */
337 public function extGetTreeList($id, $depth, $begin=0, $perms_clause) {
338 $depth=intval($depth);
339 $begin=intval($begin);
340 $id=intval($id);
341 $theList='';
342
343 if ($id && $depth > 0) {
344 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
345 'uid,title',
346 'pages',
347 'pid=' . $id . ' AND doktype IN (' . $GLOBALS['TYPO3_CONF_VARS']['FE']['content_doktypes'] . ') AND deleted=0 AND ' . $perms_clause
348 );
349 while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
350 if ($begin <= 0) {
351 $theList .= $row['uid'].',';
352 $this->extPageInTreeInfo[] = array($row['uid'], htmlspecialchars($row['title'],$depth));
353 }
354 if ($depth > 1) {
355 $theList .= $this->extGetTreeList($row['uid'], $depth-1, $begin-1, $perms_clause);
356 }
357 }
358 }
359 return $theList;
360 }
361
362 /**
363 * Returns the number of cached pages for a page id.
364 *
365 * @param integer The page id.
366 * @return integer The number of pages for this page in the table "cache_pages"
367 */
368 public function extGetNumberOfCachedPages($pageId) {
369 $pageCache = $GLOBALS['typo3CacheManager']->getCache('cache_pages');
370 $pageCacheEntries = $pageCache->getByTag('pageId_' . (int) $pageId);
371
372 return count($pageCacheEntries);
373 }
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395 /*****************************************************
396 *
397 * Localization handling
398 *
399 ****************************************************/
400
401 /**
402 * Returns the label for key, $key. If a translation for the language set in $this->uc['lang'] is found that is returned, otherwise the default value.
403 * IF the global variable $LOCAL_LANG is NOT an array (yet) then this function loads the global $LOCAL_LANG array with the content of "sysext/lang/locallang_tsfe.php" so that the values therein can be used for labels in the Admin Panel
404 *
405 * @param string Key for a label in the $LOCAL_LANG array of "sysext/lang/locallang_tsfe.php"
406 * @return string The value for the $key
407 */
408 public function extGetLL($key) {
409 global $LOCAL_LANG;
410 if (!is_array($LOCAL_LANG)) {
411 $GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_tsfe.php');
412 #include('./'.TYPO3_mainDir.'sysext/lang/locallang_tsfe.php');
413 if (!is_array($LOCAL_LANG)) {
414 $LOCAL_LANG = array();
415 }
416 }
417
418 $labelStr = htmlspecialchars($GLOBALS['LANG']->getLL($key)); // Label string in the default backend output charset.
419
420 // Convert to utf-8, then to entities:
421 if ($GLOBALS['LANG']->charSet != 'utf-8') {
422 $labelStr = $GLOBALS['LANG']->csConvObj->utf8_encode($labelStr, $GLOBALS['LANG']->charSet);
423 }
424 $labelStr = $GLOBALS['LANG']->csConvObj->utf8_to_entities($labelStr);
425
426 // Return the result:
427 return $labelStr;
428 }
429
430 }
431
432
433 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsfebeuserauth.php']) {
434 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_tsfebeuserauth.php']);
435 }
436
437 ?>