modules.inc.php 10.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
<?php

/*
Copyright (c) 2007 - 2009, Till Brehm, projektfarm Gmbh
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name of ISPConfig nor the names of its contributors
      may be used to endorse or promote products derived from this software without
      specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

class modules {
32

33 34 35
	var $notification_hooks = array();
	var $current_datalog_id = 0;
	var $debug = false;
36

37 38 39 40 41
	/*
	 This function is called to load the modules from the mods-enabled or the mods-core folder
	*/
	function loadModules($type) {
		global $app, $conf;
42

43 44 45
		$subPath = 'mods-enabled';
		if ($type == 'core') $subPath = 'mods-core';

46
		$modules_dir = $conf['rootpath'].$conf['fs_div'].$subPath.$conf['fs_div'];
47 48 49
		if (is_dir($modules_dir)) {
			if ($dh = opendir($modules_dir)) {
				while (($file = readdir($dh)) !== false) {
50 51 52 53
					if($file != '.' && $file != '..' && substr($file, -8, 8) == '.inc.php') {
						$module_name = substr($file, 0, -8);
						include_once $modules_dir.$file;
						if($this->debug) $app->log('Loading Module: '.$module_name, LOGLEVEL_DEBUG);
54 55 56 57 58 59
						$app->loaded_modules[$module_name] = new $module_name;
						$app->loaded_modules[$module_name]->onLoad();
					}
				}
			}
		} else {
60
			$app->log('Modules directory missing: '.$modules_dir, LOGLEVEL_ERROR);
61
		}
62

63
	}
64

65 66 67 68
	/*
	 This function is called by the modules to register for a specific
	 table change notification
	*/
69 70

	function registerTableHook($table_name, $module_name, $function_name) {
71 72
		global $app;
		$this->notification_hooks[$table_name][] = array('module' => $module_name, 'function' => $function_name);
73
		if($this->debug) $app->log("Registered TableHook '$table_name' in module '$module_name' for processing function '$function_name'", LOGLEVEL_DEBUG);
74
	}
75

76 77 78 79 80
	/*
	 This function goes through all new records in the
	 sys_datalog table and and calls the function in the
	 modules that hooked on to the table change.
	*/
81

82
	function processDatalog() {
83 84
		global $app, $conf;

85
		//* If its a multiserver setup
86
		if($app->db->dbHost != $app->dbmaster->dbHost || ($app->db->dbHost == $app->dbmaster->dbHost && $app->db->dbName != $app->dbmaster->dbName)) {
87
			if($conf['mirror_server_id'] > 0) {
88
				$sql = "SELECT * FROM sys_datalog WHERE datalog_id > ? AND (server_id = ? OR server_id = ? OR server_id = 0) ORDER BY datalog_id LIMIT 0,1000";
89
			} else {
90
				$sql = "SELECT * FROM sys_datalog WHERE datalog_id > ? AND (server_id = ? OR server_id = 0) ORDER BY datalog_id LIMIT 0,1000";
91
			}
92

93
			$records = $app->dbmaster->queryAllRecords($sql, $conf['last_datalog_id'], $conf['server_id'], $conf['mirror_server_id']);
94
			foreach($records as $d) {
95

96
				//** encode data to utf-8 and unserialize it
97 98
				if(!$data = unserialize(stripslashes($d['data']))) {
					$data = unserialize($d['data']);
99 100
				}
				//** Decode data back to locale
101
				/*
102 103 104 105 106 107
				foreach($data['old'] as $key => $val) {
					$data['old'][$key] = utf8_decode($val);
				}
				foreach($data['new'] as $key => $val) {
					$data['new'][$key] = utf8_decode($val);
				}
108
				*/
109

110
				$replication_error = false;
111
				$data['mirrored'] = false;
112

113
				$this->current_datalog_id = $d['datalog_id'];
114

115
				/*
116
				* If we are in a mirror setup, rewrite the server_id of records that originally
117 118
				* belonged to the mirrored server to the local server_id
				*/
119

120
				if($conf['mirror_server_id'] > 0 && $d['dbtable'] != 'server') {
121 122 123 124 125 126 127 128
					if(isset($data['new']['server_id']) && $data['new']['server_id'] == $conf['mirror_server_id']) {
						$data['new']['server_id'] = $conf['server_id'];
						$data['mirrored'] = true;
					}
					if(isset($data['old']['server_id']) && $data['old']['server_id'] == $conf['mirror_server_id']) {
						$data['old']['server_id'] = $conf['server_id'];
						$data['mirrored'] = true;
					}
129
				}
130

131
				if(count($data['new']) > 0) {
132
					if($d['action'] == 'i' || $d['action'] == 'u') {
133
						$idx = explode(':', $d['dbidx']);
134 135
						$tmp_sql1 = '';
						$tmp_sql2 = '';
136 137
						$f_params = array($d['dbtable']);
						$params = array();
138
						foreach($data['new'] as $fieldname => $val) {
139 140 141 142
							$tmp_sql1 .= "??,";
							$tmp_sql2 .= "?,";
							$f_params[] = $fieldname;
							$params[] = $val;
143
						}
Marius Cramer's avatar
Marius Cramer committed
144
						$params = array_merge($f_params, $params);
145 146
						unset($f_params);
						
147 148
						$tmp_sql1 = substr($tmp_sql1, 0, -1);
						$tmp_sql2 = substr($tmp_sql2, 0, -1);
149 150
						//$tmp_sql1 .= "$idx[0]";
						//$tmp_sql2 .= "$idx[1]";
151
						$sql = "REPLACE INTO ?? ($tmp_sql1) VALUES ($tmp_sql2)";
152 153
						$app->db->errorNumber = 0;
						$app->db->errorMessage = '';
154
						$app->db->query($sql, true, $params);
155 156
						if($app->db->errorNumber > 0) {
							$replication_error = true;
157
							$app->log("Replication failed. Error: (" . $d['dbtable'] . ") in MySQL server: (".$app->db->dbHost.") " . $app->db->errorMessage . " # SQL: " . $sql, LOGLEVEL_ERROR);
158
						}
159 160 161 162
						$log = $app->db->_build_query_string($sql, true, $params);
						$app->log('Replicated from master: '.$log, LOGLEVEL_DEBUG);
						unset($params);
						unset($log);
163
					}
164
					
165
					if($d['action'] == 'd') {
166
						$idx = explode(':', $d['dbidx']);
167 168 169
						$sql = "DELETE FROM ?? ";
						$sql .= " WHERE ?? = ?";
						$app->db->query($sql, $d['dbtable'], $idx[0], $idx[1]);
170 171
						if($app->db->errorNumber > 0) {
							$replication_error = true;
172
							$app->log("Replication failed. Error: (" . $d[dbtable] . ") " . $app->db->errorMessage . " # SQL: " . $sql, LOGLEVEL_ERROR);
173
						}
174 175 176
						$log = $app->db->_build_query_string($sql, $d['dbtable'], $idx[0], $idx[1]);
						$app->log('Replicated from master: '.$log, LOGLEVEL_DEBUG);
						unset($log);
177
					}
178 179


180
					if($replication_error == false) {
181
						if(is_array($data['old']) || is_array($data['new'])) {
182
							$app->db->query("UPDATE server SET updated = ? WHERE server_id = ?", $d["datalog_id"], $conf['server_id']);
183
							$this->raiseTableHook($d['dbtable'], $d['action'], $data);
184
						} else {
185
							$app->log('Data array was empty for datalog_id '.$d['datalog_id'], LOGLEVEL_WARN);
186
						}
187
						$app->dbmaster->query("UPDATE server SET updated = ? WHERE server_id = ?", $d["datalog_id"], $conf['server_id']);
188
						$app->log('Processed datalog_id '.$d['datalog_id'], LOGLEVEL_DEBUG);
189
					} else {
190
						$app->log('Error in Replication, changes were not processed.', LOGLEVEL_ERROR);
191 192 193 194 195 196 197
						/*
						 * If there is any error in processing the datalog we can't continue, because
						 * we do not know if the newer actions require this (old) one.
						 */
						return;
					}
				} else {
198
					$app->log('Datalog does not contain any changes for this record '.$d['datalog_id'], LOGLEVEL_DEBUG);
199 200
				}
			}
201 202

			//* if we have a single server setup
203
		} else {
204 205
			$sql = "SELECT * FROM sys_datalog WHERE datalog_id > ? AND (server_id = ? OR server_id = 0) ORDER BY datalog_id LIMIT 0,1000";
			$records = $app->db->queryAllRecords($sql, $conf['last_datalog_id'], $conf['server_id']);
206
			foreach($records as $d) {
207

208
				//** encode data to utf-8 to be able to unserialize it and then unserialize it
209 210
				if(!$data = unserialize(stripslashes($d['data']))) {
					$data = unserialize($d['data']);
211
				}
212

213 214
				//* Data on a single server is never mirrored
				$data['mirrored'] = false;
215

216
				$this->current_datalog_id = $d['datalog_id'];
217
				if(is_array($data['old']) || is_array($data['new'])) {
218
					$this->raiseTableHook($d['dbtable'], $d['action'], $data);
219
				} else {
220
					$app->log('Data array was empty for datalog_id '.$d['datalog_id'], LOGLEVEL_WARN);
221
				}
222
				$app->db->query("UPDATE server SET updated = ? WHERE server_id = ?", $d['datalog_id'], $conf['server_id']);
223
				$app->log('Processed datalog_id '.$d['datalog_id'], LOGLEVEL_DEBUG);
224 225
			}
		}
226
	}
227

228
	function processActions() {
229 230
		global $app, $conf;

231 232
		//* get the server_id of the local server
		$server_id = intval($conf["server_id"]);
233 234 235

		include_once SCRIPT_PATH."/lib/remote_action.inc.php";

236 237
		//* SQL query to get all pending actions
		$sql = "SELECT action_id, action_type, action_param " .
238
			"FROM sys_remoteaction " .
239 240
			"WHERE server_id = ? ".
			" AND  action_id > ? ".
241 242
			"ORDER BY action_id";

243
		$actions = $app->dbmaster->queryAllRecords($sql, $server_id, $maxid_remote_action);
244

245 246
		if(is_array($actions)) {
			foreach($actions as $action) {
247

248
				//* Raise the action
249 250
				$state = $app->plugins->raiseAction($action['action_type'], $action['action_param']);

251 252
				//* Update the action state
				$sql = "UPDATE sys_remoteaction " .
253 254 255
					"SET action_state = ? " .
					"WHERE action_id = ?";
				$app->dbmaster->query($sql, $state, $action['action_id']);
256 257 258 259 260 261 262 263 264 265

				/*
				* Then save the maxid for the next time...
				*/
				$fp = fopen(ISPC_LIB_PATH."/remote_action.inc.php", 'wb');
				$content = '<?php' . "\n" . '$maxid_remote_action = ' . $action['action_id'] . ';' . "\n?>";
				fwrite($fp, $content);
				fclose($fp);
			}
		}
266 267 268



269
	}
270 271

	function raiseTableHook($table_name, $action, $data) {
272
		global $app;
273

274 275
		// Get the hooks for this table
		$hooks = (isset($this->notification_hooks[$table_name]))?$this->notification_hooks[$table_name]:'';
276 277
		if($this->debug) $app->log("Raised TableHook for table: '$table_name'", LOGLEVEL_DEBUG);

278 279
		if(is_array($hooks)) {
			foreach($hooks as $hook) {
280 281
				$module_name = $hook['module'];
				$function_name = $hook['function'];
282
				// Call the processing function of the module
283
				if($this->debug) $app->log("Call function '$function_name' in module '$module_name' raised by TableHook '$table_name'.", LOGLEVEL_DEBUG);
284
				// call_user_method($function_name,$app->loaded_modules[$module_name],$table_name,$action,$data);
285
				call_user_func(array($app->loaded_modules[$module_name], $function_name), $table_name, $action, $data);
286 287 288 289 290 291 292
				unset($module_name);
				unset($function_name);
			}
		}
		unset($hook);
		unset($hooks);
	}
293

294 295
}

296
?>