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/plugins-available/maildrop_plugin.inc.php | 240 ++++++++++++++++++++++++++++++------------------------------ 1 files changed, 120 insertions(+), 120 deletions(-) diff --git a/server/plugins-available/maildrop_plugin.inc.php b/server/plugins-available/maildrop_plugin.inc.php index 085a992..73bace8 100644 --- a/server/plugins-available/maildrop_plugin.inc.php +++ b/server/plugins-available/maildrop_plugin.inc.php @@ -29,70 +29,70 @@ */ class maildrop_plugin { - + var $plugin_name = 'maildrop_plugin'; var $class_name = 'maildrop_plugin'; - - + + var $mailfilter_config_dir = ''; - + //* This function is called during ispconfig installation to determine // if a symlink shall be created for this plugin. function onInstall() { global $conf; - + if($conf['services']['mail'] == true && isset($conf['courier']['installed']) && $conf['courier']['installed'] == true) { return true; } else { return false; } - + } - + /* This function is called when the plugin is loaded */ - + function onLoad() { global $app; - + /* Register for the events */ - - $app->plugins->registerEvent('mail_user_insert','maildrop_plugin','update'); - $app->plugins->registerEvent('mail_user_update','maildrop_plugin','update'); - $app->plugins->registerEvent('mail_user_delete','maildrop_plugin','delete'); - + + $app->plugins->registerEvent('mail_user_insert', 'maildrop_plugin', 'update'); + $app->plugins->registerEvent('mail_user_update', 'maildrop_plugin', 'update'); + $app->plugins->registerEvent('mail_user_delete', 'maildrop_plugin', 'delete'); + } - - - function update($event_name,$data) { + + + function update($event_name, $data) { global $app, $conf; - + // load the server configuration options $app->uses("getconf"); $mail_config = $app->getconf->get_server_config($conf["server_id"], 'mail'); - if(substr($mail_config["homedir_path"],-1) == '/') { - $mail_config["homedir_path"] = substr($mail_config["homedir_path"],0,-1); + if(substr($mail_config["homedir_path"], -1) == '/') { + $mail_config["homedir_path"] = substr($mail_config["homedir_path"], 0, -1); } $this->mailfilter_config_dir = $mail_config["homedir_path"].'/mailfilters'; - - + + // Check if the config directory exists. if(!is_dir($this->mailfilter_config_dir)) { - $app->log("Mailfilter config directory '".$this->mailfilter_config_dir."' does not exist. Creating it now.",LOGLEVEL_WARN); + $app->log("Mailfilter config directory '".$this->mailfilter_config_dir."' does not exist. Creating it now.", LOGLEVEL_WARN); mkdir($this->mailfilter_config_dir); chown($this->mailfilter_config_dir, 'vmail'); chmod($this->mailfilter_config_dir, 0770); } - + if(isset($data["new"]["email"])) { - $email_parts = explode("@",$data["new"]["email"]); + $email_parts = explode("@", $data["new"]["email"]); } else { - $email_parts = explode("@",$data["old"]["email"]); + $email_parts = explode("@", $data["old"]["email"]); } - + // make sure that the config directories exist if(!is_dir($this->mailfilter_config_dir.'/'.$email_parts[1])) { mkdir($this->mailfilter_config_dir.'/'.$email_parts[1]); @@ -104,154 +104,154 @@ chown($this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0], 'vmail'); chmod($this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0], 0770); } - + // Check if something has been changed regarding the autoresponders - if($data["old"]["autoresponder_text"] != $data["new"]["autoresponder_text"] - or $data["old"]["autoresponder"] != $data["new"]["autoresponder"] - or (isset($data["new"]["email"]) and $data["old"]["email"] != $data["new"]["email"]) - or $data["old"]["autoresponder_start_date"] != $data["new"]["autoresponder_start_date"] - or $data["old"]["autoresponder_end_date"] != $data["new"]["autoresponder_end_date"]) { - + if($data["old"]["autoresponder_text"] != $data["new"]["autoresponder_text"] + or $data["old"]["autoresponder"] != $data["new"]["autoresponder"] + or (isset($data["new"]["email"]) and $data["old"]["email"] != $data["new"]["email"]) + or $data["old"]["autoresponder_start_date"] != $data["new"]["autoresponder_start_date"] + or $data["old"]["autoresponder_end_date"] != $data["new"]["autoresponder_end_date"]) { + // We delete the old autoresponder, if it exists - $email_parts = explode("@",$data["old"]["email"]); + $email_parts = explode("@", $data["old"]["email"]); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lock'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lst'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lst.gdbm'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lst.lock'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.msg'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.autoresponder'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); - - + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); + + //Now we create the new autoresponder, if it is enabled if($data["new"]["autoresponder"] == 'y') { if(isset($data["new"]["email"])) { - $email_parts = explode("@",$data["new"]["email"]); + $email_parts = explode("@", $data["new"]["email"]); } else { - $email_parts = explode("@",$data["old"]["email"]); + $email_parts = explode("@", $data["old"]["email"]); } - + // Load the master template $tpl = file_get_contents($conf["rootpath"].'/conf/autoresponder.master'); - $tpl = str_replace('{vmail_mailbox_base}',$mail_config["homedir_path"],$tpl); - + $tpl = str_replace('{vmail_mailbox_base}', $mail_config["homedir_path"], $tpl); + if ($data["new"]["autoresponder_start_date"] != '0000-00-00 00:00:00') { // Dates have been set - $tpl = str_replace('{start_date}',strtotime($data["new"]["autoresponder_start_date"]),$tpl); - $tpl = str_replace('{end_date}',strtotime($data["new"]["autoresponder_end_date"]),$tpl); + $tpl = str_replace('{start_date}', strtotime($data["new"]["autoresponder_start_date"]), $tpl); + $tpl = str_replace('{end_date}', strtotime($data["new"]["autoresponder_end_date"]), $tpl); } else { - $tpl = str_replace('{start_date}',-7200,$tpl); - $tpl = str_replace('{end_date}',2147464800,$tpl); + $tpl = str_replace('{start_date}', -7200, $tpl); + $tpl = str_replace('{end_date}', 2147464800, $tpl); } - + // Write the config file. $config_file_path = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.autoresponder'; - file_put_contents($config_file_path,$tpl); - $app->log("Writing Autoresponder mailfilter file: $config_file_path",LOGLEVEL_DEBUG); + file_put_contents($config_file_path, $tpl); + $app->log("Writing Autoresponder mailfilter file: $config_file_path", LOGLEVEL_DEBUG); chmod($config_file_path, 0770); chown($config_file_path, 'vmail'); unset($tpl); unset($config_file_path); - + // Write the autoresponder message file $config_file_path = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.msg'; - file_put_contents($config_file_path,$data["new"]["autoresponder_text"]); + file_put_contents($config_file_path, $data["new"]["autoresponder_text"]); chmod($config_file_path, 0770); chown($config_file_path, 'vmail'); - $app->log("Writing Autoresponder message file: $config_file_path",LOGLEVEL_DEBUG); + $app->log("Writing Autoresponder message file: $config_file_path", LOGLEVEL_DEBUG); } } - + // Write the custom mailfilter script, if mailfilter recipe has changed if($data["old"]["custom_mailfilter"] != $data["new"]["custom_mailfilter"] or $data["old"]["move_junk"] != $data["new"]["move_junk"] or $data["old"]["cc"] != $data["new"]["cc"]) { - - $app->log("Mailfilter config has been changed",LOGLEVEL_DEBUG); - if(trim($data["new"]["custom_mailfilter"]) != '' - or $data["new"]["move_junk"] != 'n' - or $data["new"]["cc"] != '') { - - // Delete the old filter recipe - $email_parts = explode("@",$data["old"]["email"]); - $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.mailfilter'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); - - // write the new recipe - if(isset($data["new"]["email"])) { - $email_parts = explode("@",$data["new"]["email"]); - } else { - $email_parts = explode("@",$data["old"]["email"]); - } - $config_file_path = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.mailfilter'; - - $mailfilter_content = ''; - - if($data["new"]["cc"] != '') { - $mailfilter_content .= "cc \"!".$data["new"]["cc"]."\"\n"; - $app->log("Added CC address ".$data["new"]["cc"].' to mailfilter file.',LOGLEVEL_DEBUG); - } - - if($data["new"]["move_junk"] == 'y') { - $mailfilter_content .= file_get_contents($conf["rootpath"].'/conf/mailfilter_move_junk.master')."\n"; - } - $mailfilter_content .= $data["new"]["custom_mailfilter"]; - - // Replace windows linebreaks in mailfilter file - $mailfilter_content = str_replace("\r\n","\n",$mailfilter_content); - - file_put_contents($config_file_path,$mailfilter_content); - $app->log("Writing new custom Mailfiter".$config_file_path,LOGLEVEL_DEBUG); - chmod($config_file_path, 0770); - chown($config_file_path, 'vmail'); - unset($config_file_path); + + $app->log("Mailfilter config has been changed", LOGLEVEL_DEBUG); + if(trim($data["new"]["custom_mailfilter"]) != '' + or $data["new"]["move_junk"] != 'n' + or $data["new"]["cc"] != '') { + + // Delete the old filter recipe + $email_parts = explode("@", $data["old"]["email"]); + $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.mailfilter'; + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); + + // write the new recipe + if(isset($data["new"]["email"])) { + $email_parts = explode("@", $data["new"]["email"]); } else { - // Delete the mailfilter recipe - if(isset($data["old"]["email"])) { - $email_parts = explode("@",$data["old"]["email"]); - $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.mailfilter'; - if(is_file($file)) { - unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); - $app->log("Deleting custom Mailfiter".$file,LOGLEVEL_DEBUG); - } + $email_parts = explode("@", $data["old"]["email"]); + } + $config_file_path = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.mailfilter'; + + $mailfilter_content = ''; + + if($data["new"]["cc"] != '') { + $mailfilter_content .= "cc \"!".$data["new"]["cc"]."\"\n"; + $app->log("Added CC address ".$data["new"]["cc"].' to mailfilter file.', LOGLEVEL_DEBUG); + } + + if($data["new"]["move_junk"] == 'y') { + $mailfilter_content .= file_get_contents($conf["rootpath"].'/conf/mailfilter_move_junk.master')."\n"; + } + $mailfilter_content .= $data["new"]["custom_mailfilter"]; + + // Replace windows linebreaks in mailfilter file + $mailfilter_content = str_replace("\r\n", "\n", $mailfilter_content); + + file_put_contents($config_file_path, $mailfilter_content); + $app->log("Writing new custom Mailfiter".$config_file_path, LOGLEVEL_DEBUG); + chmod($config_file_path, 0770); + chown($config_file_path, 'vmail'); + unset($config_file_path); + } else { + // Delete the mailfilter recipe + if(isset($data["old"]["email"])) { + $email_parts = explode("@", $data["old"]["email"]); + $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.mailfilter'; + if(is_file($file)) { + unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); + $app->log("Deleting custom Mailfiter".$file, LOGLEVEL_DEBUG); } } + } } } - - function delete($event_name,$data) { + + function delete($event_name, $data) { global $app, $conf; - + // load the server configuration options $app->uses("getconf"); $mail_config = $app->getconf->get_server_config($conf["server_id"], 'mail'); $this->mailfilter_config_dir = $mail_config["homedir_path"].'/mailfilters'; - - $email_parts = explode("@",$data["old"]["email"]); + + $email_parts = explode("@", $data["old"]["email"]); $dir = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0]; if(is_dir($dir)) { $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lock'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lst'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.msg'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.autoresponder'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.mailfilter'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lst.gdbm'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); $file = $this->mailfilter_config_dir.'/'.$email_parts[1].'/'.$email_parts[0].'/.vacation.lst.lock'; - if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file",LOGLEVEL_WARN); - rmdir($dir) or $app->log("Unable to delete directory: $dir",LOGLEVEL_WARN); + if(is_file($file)) unlink($file) or $app->log("Unable to delete file: $file", LOGLEVEL_WARN); + rmdir($dir) or $app->log("Unable to delete directory: $dir", LOGLEVEL_WARN); } } - + } // end class -- Gitblit v1.9.1