Updated years from 2004 to 2005 + all function indexes. NO actual code changes done!
[Packages/TYPO3.CMS.git] / typo3 / sysext / sv / class.tx_sv_authbase.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2005 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 * Service base class for 'User authentication'.
29 *
30 * @author René Fritz <r.fritz@colorcube.de>
31 */
32
33 require_once(PATH_t3lib.'class.t3lib_svbase.php');
34
35 class tx_sv_authbase extends t3lib_svbase {
36
37 var $pObj; // Parent object
38
39 var $mode; // Subtype of the service which is used to call the service.
40
41 var $login=array(); // Submitted login form data
42 var $info=array(); // Various data
43
44 var $db_user=array(); // User db table definition
45 var $db_groups=array(); // Usergroups db table definition
46
47 var $writeAttemptLog = 0; // If the writelog() functions is called if a login-attempt has be tried without success
48
49 /**
50 * init service
51 *
52 * @param string Subtype of the service which is used to call the service.
53 * @param array Submitted login form data
54 * @param array Information array. Holds submitted form data etc.
55 * @param object Parent object
56 * @return void
57 */
58 function initAuth($mode, $loginData, $info, &$pObj) {
59
60 $this->pObj = &$pObj;
61
62 $this->mode = $mode;
63 $this->login = $loginData;
64 $this->info = $info;
65
66 $this->db_user = $this->getServiceOption('db_user', $info['db_user'], FALSE);
67 $this->db_groups = $this->getServiceOption('db_groups', $info['db_groups'], FALSE);
68
69 $this->writeAttemptLog = $this->pObj->writeAttemptLog;
70 $this->writeDevLog = $this->pObj->writeDevLog;
71 }
72
73 /**
74 * Writes to log database table in pObj
75 *
76 * @param integer $type: denotes which module that has submitted the entry. This is the current list: 1=tce_db; 2=tce_file; 3=system (eg. sys_history save); 4=modules; 254=Personal settings changed; 255=login / out action: 1=login, 2=logout, 3=failed login (+ errorcode 3), 4=failure_warning_email sent
77 * @param integer $action: denotes which specific operation that wrote the entry (eg. 'delete', 'upload', 'update' and so on...). Specific for each $type. Also used to trigger update of the interface. (see the log-module for the meaning of each number !!)
78 * @param integer $error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
79 * @param integer $details_nr: The message number. Specific for each $type and $action. in the future this will make it possible to translate errormessages to other languages
80 * @param string $details: Default text that follows the message
81 * @param array $data: Data that follows the log. Might be used to carry special information. If an array the first 5 entries (0-4) will be sprintf'ed the details-text...
82 * @param string $tablename: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
83 * @param integer $recuid: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
84 * @param integer $recpid: Special field used by tce_main.php. These ($tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.)
85 * @return void
86 * @see t3lib_userauthgroup::writelog()
87 */
88 function writelog($type,$action,$error,$details_nr,$details,$data,$tablename='',$recuid='',$recpid='') {
89 if($this->pObj->writeAttemptLog) {
90 $this->pObj->writelog($type,$action,$error,$details_nr,$details,$data,$tablename,$recuid,$recpid);
91 }
92 }
93
94 }
95
96
97 ?>