modules.inc.php 8.06 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
32
33
<?php

/*
Copyright (c) 2007, 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 {
	
	var $notification_hooks = array();
34
35
	var $current_datalog_id = 0;
	var $debug = false;
36
37
	
	/*
38
	 This function is called to load the modules from the mods-enabled or the mods-core folder
39
	*/
40
	function loadModules($type) {
41
42
		global $app, $conf;
		
43
44
45
46
		$subPath = 'mods-enabled';
		if ($type == 'core') $subPath = 'mods-core';

		$modules_dir = $conf["rootpath"].$conf["fs_div"].$subPath.$conf["fs_div"];
47
		if (is_dir($modules_dir)) {
tbrehm's avatar
tbrehm committed
48
			if ($dh = opendir($modules_dir)) {
49
				while (($file = readdir($dh)) !== false) {
tbrehm's avatar
tbrehm committed
50
					if($file != '.' && $file != '..' && substr($file,-8,8) == '.inc.php') {
51
52
						$module_name = substr($file,0,-8);
						include_once($modules_dir.$file);
53
						if($this->debug) $app->log("Loading Module: $module_name",LOGLEVEL_DEBUG);
tbrehm's avatar
tbrehm committed
54
55
						$app->loaded_modules[$module_name] = new $module_name;
						$app->loaded_modules[$module_name]->onLoad();
56
57
58
59
60
61
					}
				}
			}
		} else {
			$app->log("Modules directory missing: $modules_dir",LOGLEVEL_ERROR);
		}
tbrehm's avatar
tbrehm committed
62
		
63
64
65
66
67
68
69
70
	}
	
	/*
	 This function is called by the modules to register for a specific
	 table change notification
	*/
	
	function registerTableHook($table_name,$module_name,$function_name) {
tbrehm's avatar
tbrehm committed
71
		global $app;
72
		$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
81
82
	}
	
	/*
	 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.
	*/
	
	function processDatalog() {
tbrehm's avatar
tbrehm committed
83
		global $app,$conf;
84
		
85
86
		//* If its a multiserver setup
		if($app->db->dbHost != $app->dbmaster->dbHost) {
87
			$sql = "SELECT * FROM sys_datalog WHERE datalog_id > ".$conf['last_datalog_id']." AND (server_id = ".$conf["server_id"]." OR server_id = 0) ORDER BY datalog_id";
88
89
90
			$records = $app->dbmaster->queryAllRecords($sql);
			foreach($records as $d) {
				
tbrehm's avatar
tbrehm committed
91
92
93
				if(!$data = unserialize(stripslashes($d["data"]))) {
					$data = unserialize($d["data"]);
				}
94
95
				$replication_error = false;
				
96
97
				$this->current_datalog_id = $d["datalog_id"];
				
tbrehm's avatar
tbrehm committed
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
				if(count($data['new']) > 0) {
					if($d["action"] == 'i' || $d["action"] == 'u') {
						$idx = explode(":",$d["dbidx"]);
						$tmp_sql1 = '';
						$tmp_sql2 = '';
						foreach($data['new'] as $fieldname => $val) {
							$tmp_sql1 .= "`$fieldname`,";
							$tmp_sql2 .= "'$val',";
						}
						$tmp_sql1 = substr($tmp_sql1,0,-1);
						$tmp_sql2 = substr($tmp_sql2,0,-1);
						//$tmp_sql1 .= "$idx[0]";
						//$tmp_sql2 .= "$idx[1]";
						$sql = "REPLACE INTO $d[dbtable] ($tmp_sql1) VALUES ($tmp_sql2)";
						$app->db->query($sql);
						if($app->db->errorNumber > 0) {
							$replication_error = true;
							$app->log("Replication failed. Error: (" . $d[dbtable] . ") " . $app->db->errorMessage . " # SQL: " . $sql,LOGLEVEL_ERROR);
						}
						$app->log("Replicated from master: ".$sql,LOGLEVEL_DEBUG);
118
					}
tbrehm's avatar
tbrehm committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
					/*
					if($d["action"] == 'u') {
						$sql = "UPDATE $d[dbtable] SET ";
						foreach($data['new'] as $fieldname => $val) {
							$sql .= "`$fieldname` = '$val',";
						}
						$sql = substr($sql,0,-1);
						$idx = explode(":",$d["dbidx"]);
						$sql .= " WHERE $idx[0] = $idx[1]";
						$app->db->query($sql);
						if($app->db->errorNumber > 0) {
							$replication_error = true;
							$app->log("Replication failed. Error: (" . $d[dbtable] . ") " . $app->db->errorMessage . " # SQL: " . $sql,LOGLEVEL_ERROR);
						}
						$app->log("Replicated from master: ".$sql,LOGLEVEL_DEBUG);
134
					}
tbrehm's avatar
tbrehm committed
135
136
137
138
139
140
141
142
143
144
145
					*/
					if($d["action"] == 'd') {
						$idx = explode(":",$d["dbidx"]);
						$sql = "DELETE FROM $d[dbtable] ";
						$sql .= " WHERE $idx[0] = $idx[1]";
						$app->db->query($sql);
						if($app->db->errorNumber > 0) {
							$replication_error = true;
							$app->log("Replication failed. Error: (" . $d[dbtable] . ") " . $app->db->errorMessage . " # SQL: " . $sql,LOGLEVEL_ERROR);
						}
						$app->log("Replicated from master: ".$sql,LOGLEVEL_DEBUG);
146
147
148
					}
				
				
tbrehm's avatar
tbrehm committed
149
150
151
152
153
154
155
156
157
158
159
160
161
162
					if($replication_error == false) {
						$this->raiseTableHook($d["dbtable"],$d["action"],$data);
						//$app->dbmaster->query("DELETE FROM sys_datalog WHERE datalog_id = ".$d["datalog_id"]);
						//$app->log("Deleting sys_datalog ID ".$d["datalog_id"],LOGLEVEL_DEBUG);
						$app->dbmaster->query("UPDATE server SET updated = ".$d["datalog_id"]." WHERE server_id = ".$conf["server_id"]);
						$app->log("Processed datalog_id ".$d["datalog_id"],LOGLEVEL_DEBUG);
					} else {
						$app->log("Error in Replication, changes were not processed.",LOGLEVEL_ERROR);
						/*
						 * 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;
					}
163
				} else {
tbrehm's avatar
tbrehm committed
164
					$app->log("Datalog does not conatin any changes for this record ".$d["datalog_id"],LOGLEVEL_DEBUG);
165
166
167
168
169
				}
			}
			
		//* if we have a single server setup
		} else {
170
			$sql = "SELECT * FROM sys_datalog WHERE datalog_id > ".$conf['last_datalog_id']." AND (server_id = ".$conf["server_id"]." OR server_id = 0) ORDER BY datalog_id";
171
			$records = $app->db->queryAllRecords($sql);
172
			foreach($records as $d) {
tbrehm's avatar
tbrehm committed
173
174
175
				if(!$data = unserialize(stripslashes($d["data"]))) {
					$data = unserialize($d["data"]);
				}
176
177
				$this->current_datalog_id = $d["datalog_id"];
				$this->raiseTableHook($d["dbtable"],$d["action"],$data);
tbrehm's avatar
tbrehm committed
178
179
				//$app->db->query("DELETE FROM sys_datalog WHERE datalog_id = ".$rec["datalog_id"]);
				//$app->log("Deleting sys_datalog ID ".$rec["datalog_id"],LOGLEVEL_DEBUG);
180
181
				$app->db->query("UPDATE server SET updated = ".$d["datalog_id"]." WHERE server_id = ".$conf["server_id"]);
				$app->log("Processed datalog_id ".$d["datalog_id"],LOGLEVEL_DEBUG);
182
			}
183
		}
184
185
186
187
188
		
		
		
		
		
189
190
191
192
193
194
	}
	
	function raiseTableHook($table_name,$action,$data) {
		global $app;
		
		// Get the hooks for this table
195
		$hooks = (isset($this->notification_hooks[$table_name]))?$this->notification_hooks[$table_name]:'';
196
		if($this->debug) $app->log("Raised TableHook for table: '$table_name'",LOGLEVEL_DEBUG);
197
198
199
200
201
202
		
		if(is_array($hooks)) {
			foreach($hooks as $hook) {
				$module_name = $hook["module"];
				$function_name = $hook["function"];
				// Claa the processing function of the module
203
				if($this->debug) $app->log("Call function '$function_name' in module '$module_name' raised by TableHook '$table_name'.",LOGLEVEL_DEBUG);
tbrehm's avatar
tbrehm committed
204
				call_user_method($function_name,$app->loaded_modules[$module_name],$table_name,$action,$data);
205
206
207
208
209
210
211
212
213
214
215
				unset($module_name);
				unset($function_name);
			}
		}
		unset($hook);
		unset($hooks);
	}
	
}

?>