1 <?php
2 /*
3 * This code is part of GOsa (http://www.gosa-project.org)
4 * Copyright (C) 2003-2008 GONICUS GmbH
5 *
6 * ID: $$Id$$
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
23 /*! \brief The logging base class
24 \author Fabian Hickert <hickert@gonicus.de>
25 \version 2.6
26 \date 11.04.2007
28 This is the base class for the GOsa logging functionality.
29 All logging should lead to this class.
30 */
31 class log {
33 var $LOG_TO_MYSQL = FALSE;
34 var $LOG_TO_SYSLOG= FALSE;
35 var $config;
37 /*! \brief logging constructor
39 \param action One of these values (modify|create|remove|snapshot|copy)
40 \param objecttype represents the current edited objecttype, like users/user
41 \param object represents the current edited object dn
42 \param changes_array An array containing names of all touched attributes
43 \param result A status message, containing errors or success messages
45 \sa log()
46 */
47 function log($action,$objecttype,$object,$changes_array = array(),$result = "")
48 {
49 if(!is_array($changes_array)){
50 trigger_error("log(string,string,string,array(),bool). Forth parameter must be an array.");
51 $changes_array = array();
52 }
54 $entry = array();
55 if(!session::global_is_set('config')){
56 $entry['user']= "unkown";
57 }else{
59 $this->config = session::global_get('config');
60 $ui = get_userinfo();
61 $entry['user']= @$ui->dn;
62 }
64 /* Create string out of changes */
65 $changes ="";
66 foreach($changes_array as $str ){
67 $changes .= $str.",";
68 }
69 $changes = preg_replace("/,$/","",$changes );
71 /* Create data object */
72 $entry['timestamp'] = time();
73 $entry['action'] = $action;
74 $entry['objecttype']= $objecttype;
75 $entry['object'] = $object;
76 $entry['changes'] = $changes;
77 $entry['result'] = $result;
79 if(!isset($this->config) || ( $this->config->get_cfg_value("logging") == "" && empty($entry['user']))){
80 $entry['user'] = "unknown";
81 }
83 /* Check if all given values are valid */
84 $msgs = @log::check($entry);
85 if(count($msgs)){
86 foreach($msgs as $msg){
87 trigger_error("Logging failed, reason was: ".$msg);
88 msg_dialog::display(_("Internal error"), sprintf(_("Logging failed: %s"), $msg), ERROR_DIALOG);
89 }
91 }else{
93 if (isset ($this->config)){
94 if ($this->config->get_cfg_value("logging") == ""){
95 $this->log_into_syslog($entry);
96 }else{
98 /* Start logging for configured methods */
99 if(preg_match("/(^|,)syslog(,|$)/i",$this->config->get_cfg_value("logging"))){
100 $this->log_into_syslog($entry);
101 }
102 if(preg_match("/(^|,)mysql(,|$)/i",$this->config->get_cfg_value("logging"))){
103 $this->log_into_db($entry);
104 }
105 }
106 }
107 }
108 }
111 function check($entry = array())
112 {
113 $msgs = array();
115 if(!isset($entry['action']) || !in_array($entry['action'],array("modify","create","remove","copy","snapshot","view","security","debug"))){
116 $msgs[] = sprintf(_("Invalid option '%s' specified!"), $entry['action']);
117 }
119 if(!isset($entry['objecttype']) || empty($entry['objecttype'])){
120 $msgs[] = _("Specified objectType is empty or invalid!");
121 }
123 return($msgs);
124 }
127 /* This function is used to into the systems syslog */
128 function log_into_syslog($entry)
129 {
130 $str= "";
131 if (empty($entry['object']) && empty($entry['changes'])) {
132 $str = "(".$entry['action'].") ".$entry['objecttype'].": ".$entry['result'];
133 } else {
134 $str = "(".$entry['action'].") ".$entry['object']." of type ".$entry['objecttype']." ".$entry['changes'].": ".$entry['result'];
135 }
136 gosa_log($str);
137 }
140 function disable_mysql_log($server,$error)
141 {
142 global $config;
143 msg_dialog::display(_("Error"), $error, ERROR_DIALOG);
144 msg_dialog::display(_("MySQL error"),sprintf(_("Logging to MySQL database will be disabled for server '%s'!"),$server), INFO_DIALOG);
145 unset($config->data['SERVERS']['LOGGING'][$server]) ;
146 $this->config = $config;
147 }
150 /* Log into configured logging databses.*/
151 function log_into_db($entry)
152 {
153 if(isset($this->config->data['SERVERS']['LOGGING'])){
154 $servers = $this->config->data['SERVERS']['LOGGING'];
155 }else{
156 return(FALSE);
157 }
159 /* Log into each configured server
160 */
161 foreach($servers as $server_name => $server){
163 $error = "";
165 /* Connect to the database
166 */
167 ini_set("mysql.connect_timeout",5);
168 $con = @mysql_pconnect($server_name,$server['USER'],$server['PWD']);
169 if(!$con){
170 $error = msgPool::dbconnect(_("MySQL logging"),mysql_error());
171 $this->disable_mysql_log($server_name,$error);
172 continue;
173 }
175 /* Check if the database is available
176 */
177 $db = @mysql_select_db($server['DB'],$con);
178 if(!$db){
179 $error = msgPool::dbselect(_("MySQL logging"),mysql_error());
180 $this->disable_mysql_log($server_name,$error);
181 continue;
182 }
184 /* Check if our current location is already registerd
185 in this case get its id.
186 If it wasn't registered yet, create it.
187 */
188 $base = mysql_escape_string($this->config->current['BASE']);
189 $query= "SELECT id FROM gosa_locations WHERE location=\"".$base."\";";
190 $res = mysql_query($query);
191 if(!$res){
192 $error = msgPool::dbquery(_("MySQL logging"),mysql_error());
193 $this->disable_mysql_log($server_name,$error);
194 continue;
195 }
197 $location_id = -1;
198 while($attrs = mysql_fetch_assoc($res)){
199 $location_id = $attrs['id'];
200 break;
201 }
203 /* No location found that matches our location.
204 Create it.
205 */
206 if($location_id == -1){
207 $query = "INSERT INTO gosa_locations (location) VALUES ('".$base."');";
208 if(!mysql_query($query,$con)){
209 $error = msgPool::dbquery(_("MySQL logging"),mysql_error());
210 $this->disable_mysql_log($server_name,$error);
211 continue;
212 }
214 /* Try to detect the location again
215 */
216 $query= "SELECT id FROM gosa_locations WHERE location=\"".$base."\";";
217 $res = mysql_query($query);
218 $location_id = -1;
219 while($attrs = mysql_fetch_assoc($res)){
220 $location_id = $attrs['id'];
221 break;
222 }
223 if($location_id == -1){
224 $error = sprintf(_("Cannot add location to the database!")."<br><br>"._("Error").": %s",mysql_error($con));
225 $this->disable_mysql_log($server_name,$error);
226 continue;
227 }
228 }
230 /* Create mysql syntax */
231 $query ="INSERT INTO gosa_log
232 (timestamp,user,action,objecttype,object,changes,result,location_id)
233 VALUES
234 (
235 \"".mysql_escape_string($entry['timestamp'])."\",
236 \"".mysql_escape_string($entry['user'])."\",
237 \"".mysql_escape_string($entry['action'])."\",
238 \"".mysql_escape_string($entry['objecttype'])."\",
239 \"".mysql_escape_string($entry['object'])."\",
240 \"".mysql_escape_string($entry['changes'])."\",
241 \"".mysql_escape_string($entry['result'])."\",
242 \"".mysql_escape_string($location_id)."\"
243 );
244 ";
245 $res = mysql_query($query,$con);
246 if(!$res){
247 $error = dbquery(_("MySQL logging"), mysql_error());
248 $this->disable_mysql_log($server_name,$error);
249 continue;
250 }
251 if(is_resource($con)){
252 mysql_close($con);
253 }
254 }
255 }
256 }
258 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
259 ?>