From 7fe908c50c8dbc5cc05f571dbe11d66141caacd4 Mon Sep 17 00:00:00 2001
From: Marius Cramer <m.cramer@pixcept.de>
Date: Thu, 14 Nov 2013 09:01:22 -0500
Subject: [PATCH] Cleaning up code to match coding guidelines
---
server/lib/classes/modules.inc.php | 283 ++++++++++++++++++++++++++++++++++++++++++++++++--------
1 files changed, 242 insertions(+), 41 deletions(-)
diff --git a/server/lib/classes/modules.inc.php b/server/lib/classes/modules.inc.php
index 12b871e..194bf4f 100644
--- a/server/lib/classes/modules.inc.php
+++ b/server/lib/classes/modules.inc.php
@@ -1,7 +1,7 @@
<?php
/*
-Copyright (c) 2007, Till Brehm, projektfarm Gmbh
+Copyright (c) 2007 - 2009, Till Brehm, projektfarm Gmbh
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
@@ -29,74 +29,275 @@
*/
class modules {
-
+
var $notification_hooks = array();
-
+ var $current_datalog_id = 0;
+ var $debug = false;
+
/*
- This function is called to load the modules from the mods-available folder
+ This function is called to load the modules from the mods-enabled or the mods-core folder
*/
-
- function loadModules() {
+ function loadModules($type) {
global $app, $conf;
-
- $modules_dir = $conf["rootpath"].$conf["fs_div"]."lib".$conf["fs_div"]."mods-enabled".$conf["fs_div"]
-
+
+ $subPath = 'mods-enabled';
+ if ($type == 'core') $subPath = 'mods-core';
+
+ $modules_dir = $conf['rootpath'].$conf['fs_div'].$subPath.$conf['fs_div'];
if (is_dir($modules_dir)) {
- if ($dh = opendir($dir)) {
+ if ($dh = opendir($modules_dir)) {
while (($file = readdir($dh)) !== false) {
- if($file != '.' && $file != '..') {
- $module_name = substr($file,0,-8);
- include_once($modules_dir.$file);
- $app->log("Loading Module: $module_name",LOGLEVEL_DEBUG);
- $app->modules[$module_name] = new $module_name;
- $app->modules[$module_name]->onLoad();
+ 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);
+ $app->loaded_modules[$module_name] = new $module_name;
+ $app->loaded_modules[$module_name]->onLoad();
}
}
}
} else {
- $app->log("Modules directory missing: $modules_dir",LOGLEVEL_ERROR);
+ $app->log('Modules directory missing: '.$modules_dir, LOGLEVEL_ERROR);
}
+
}
-
+
/*
This function is called by the modules to register for a specific
table change notification
*/
-
- function registerTableHook($table_name,$module_name,$function_name) {
+
+ function registerTableHook($table_name, $module_name, $function_name) {
+ global $app;
$this->notification_hooks[$table_name][] = array('module' => $module_name, 'function' => $function_name);
+ if($this->debug) $app->log("Registered TableHook '$table_name' in module '$module_name' for processing function '$function_name'", LOGLEVEL_DEBUG);
}
-
+
/*
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() {
- global $app;
-
- // TODO: process only new entries.
- $sql = "SELECT * FROM sys_datalog WHERE 1";
- $records = $app->db->queryAllRecords($sql);
- foreach($records as $rec) {
- $data = unserialize(stripslashes($rec["data"]));
- $this->raiseTableHook($rec["dbtable"],$rec["action"],$data);
+ global $app, $conf;
+
+ //* If its a multiserver setup
+ if($app->db->dbHost != $app->dbmaster->dbHost || ($app->db->dbHost == $app->dbmaster->dbHost && $app->db->dbName != $app->dbmaster->dbName)) {
+ if($conf['mirror_server_id'] > 0) {
+ $sql = "SELECT * FROM sys_datalog WHERE datalog_id > ".$conf['last_datalog_id']." AND (server_id = ".$conf['server_id']." OR server_id = ".$conf['mirror_server_id']." OR server_id = 0) ORDER BY datalog_id LIMIT 0,1000";
+ } else {
+ $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 LIMIT 0,1000";
+ }
+
+ $records = $app->dbmaster->queryAllRecords($sql);
+ foreach($records as $d) {
+
+ //** encode data to utf-8 and unserialize it
+ if(!$data = unserialize(stripslashes($d['data']))) {
+ $data = unserialize($d['data']);
+ }
+ //** Decode data back to locale
+ /*
+ foreach($data['old'] as $key => $val) {
+ $data['old'][$key] = utf8_decode($val);
+ }
+ foreach($data['new'] as $key => $val) {
+ $data['new'][$key] = utf8_decode($val);
+ }
+ */
+
+ $replication_error = false;
+ $data['mirrored'] = false;
+
+ $this->current_datalog_id = $d['datalog_id'];
+
+ /*
+ * If we are in a mirror setup, rewrite the server_id of records that originally
+ * belonged to the mirrored server to the local server_id
+ */
+
+ if($conf['mirror_server_id'] > 0 && $d['dbtable'] != 'server') {
+ 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;
+ }
+ }
+
+ 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 .= "'".$app->db->quote($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->errorNumber = 0;
+ $app->db->errorMessage = '';
+ $app->db->query($sql);
+ if($app->db->errorNumber > 0) {
+ $replication_error = true;
+ $app->log("Replication failed. Error: (" . $d['dbtable'] . ") in MySQL server: (".$app->db->dbHost.") " . $app->db->errorMessage . " # SQL: " . $sql, LOGLEVEL_ERROR);
+ }
+ $app->log('Replicated from master: '.$sql, LOGLEVEL_DEBUG);
+ }
+ /*
+ 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);
+ }
+ */
+ 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);
+ }
+
+
+ if($replication_error == false) {
+ if(is_array($data['old']) || is_array($data['new'])) {
+ $app->db->query("UPDATE server SET updated = ".$d["datalog_id"]." WHERE server_id = ".$conf['server_id']);
+ $this->raiseTableHook($d['dbtable'], $d['action'], $data);
+ } else {
+ $app->log('Data array was empty for datalog_id '.$d['datalog_id'], LOGLEVEL_WARN);
+ }
+ $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;
+ }
+ } else {
+ $app->log('Datalog does not contain any changes for this record '.$d['datalog_id'], LOGLEVEL_DEBUG);
+ }
+ }
+
+ //* if we have a single server setup
+ } else {
+ $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 LIMIT 0,1000";
+ $records = $app->db->queryAllRecords($sql);
+ foreach($records as $d) {
+
+ //** encode data to utf-8 to be able to unserialize it and then unserialize it
+ if(!$data = unserialize(stripslashes($d['data']))) {
+ $data = unserialize($d['data']);
+ }
+ //** decode data back to current locale
+ /*
+ foreach($data['old'] as $key => $val) {
+ $data['old'][$key] = utf8_decode($val);
+ }
+ foreach($data['new'] as $key => $val) {
+ $data['new'][$key] = utf8_decode($val);
+ }
+ */
+
+ //* Data on a single server is never mirrored
+ $data['mirrored'] = false;
+
+ $this->current_datalog_id = $d['datalog_id'];
+ if(is_array($data['old']) || is_array($data['new'])) {
+ $this->raiseTableHook($d['dbtable'], $d['action'], $data);
+ } else {
+ $app->log('Data array was empty for datalog_id '.$d['datalog_id'], LOGLEVEL_WARN);
+ }
+ //$app->db->query("DELETE FROM sys_datalog WHERE datalog_id = ".$rec["datalog_id"]);
+ //$app->log("Deleting sys_datalog ID ".$rec["datalog_id"],LOGLEVEL_DEBUG);
+ $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);
+ }
}
}
-
- function raiseTableHook($table_name,$action,$data) {
+
+ function processActions() {
+ global $app, $conf;
+
+ //* get the server_id of the local server
+ $server_id = intval($conf["server_id"]);
+
+ include_once SCRIPT_PATH."/lib/remote_action.inc.php";
+
+ //* SQL query to get all pending actions
+ $sql = "SELECT action_id, action_type, action_param " .
+ "FROM sys_remoteaction " .
+ "WHERE server_id = " . $server_id . " ".
+ " AND action_id > " . intval($maxid_remote_action) . " ".
+ "ORDER BY action_id";
+
+ $actions = $app->dbmaster->queryAllRecords($sql);
+
+ if(is_array($actions)) {
+ foreach($actions as $action) {
+
+ //* Raise the action
+ $state = $app->plugins->raiseAction($action['action_type'], $action['action_param']);
+
+ //* Update the action state
+ $sql = "UPDATE sys_remoteaction " .
+ "SET action_state = '" . $app->dbmaster->quote($state) . "' " .
+ "WHERE action_id = " . intval($action['action_id']);
+ $app->dbmaster->query($sql);
+
+ /*
+ * 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);
+ }
+ }
+
+
+
+ }
+
+ function raiseTableHook($table_name, $action, $data) {
global $app;
-
+
// Get the hooks for this table
- $hooks = $this->notification_hooks[$table_name];
-
+ $hooks = (isset($this->notification_hooks[$table_name]))?$this->notification_hooks[$table_name]:'';
+ if($this->debug) $app->log("Raised TableHook for table: '$table_name'", LOGLEVEL_DEBUG);
+
if(is_array($hooks)) {
foreach($hooks as $hook) {
- $module_name = $hook["module"];
- $function_name = $hook["function"];
- // Claa the processing function of the module
- call_user_method($function_name,$app->modules[$module_name],$table_name,$action,$data);
+ $module_name = $hook['module'];
+ $function_name = $hook['function'];
+ // Call the processing function of the module
+ if($this->debug) $app->log("Call function '$function_name' in module '$module_name' raised by TableHook '$table_name'.", LOGLEVEL_DEBUG);
+ // call_user_method($function_name,$app->loaded_modules[$module_name],$table_name,$action,$data);
+ call_user_func(array($app->loaded_modules[$module_name], $function_name), $table_name, $action, $data);
unset($module_name);
unset($function_name);
}
@@ -104,7 +305,7 @@
unset($hook);
unset($hooks);
}
-
+
}
-?>
\ No newline at end of file
+?>
--
Gitblit v1.9.1