Cleaning up code to match coding guidelines

Marius Cramer

2013-11-14 b1a6a5a3991cec5cd08873b01376e45d0b247f18

 server/plugins-available/getmail_plugin.inc.php

@@ -29,84 +29,84 @@
*/

class getmail_plugin {
	

   var $plugin_name = 'getmail_plugin';
   var $class_name = 'getmail_plugin';
	

   var $getmail_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) {
         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_get_insert','getmail_plugin','insert');
      $app->plugins->registerEvent('mail_get_update','getmail_plugin','update');
      $app->plugins->registerEvent('mail_get_delete','getmail_plugin','delete');
		
		
		

      $app->plugins->registerEvent('mail_get_insert', 'getmail_plugin', 'insert');
      $app->plugins->registerEvent('mail_get_update', 'getmail_plugin', 'update');
      $app->plugins->registerEvent('mail_get_delete', 'getmail_plugin', 'delete');



   }
	
   function insert($event_name,$data) {

   function insert($event_name, $data) {
      global $app, $conf;
		
      $this->update($event_name,$data);
		

      $this->update($event_name, $data);

   }
	
   function update($event_name,$data) {

   function update($event_name, $data) {
      global $app, $conf;
		

      // load the server specific configuration options for getmail
      $app->uses("getconf");
      $getmail_config = $app->getconf->get_server_config($conf["server_id"], 'getmail');
      $this->getmail_config_dir = $getmail_config["getmail_config_dir"];
		

      // Check if the config directory exists.
      if(!is_dir($this->getmail_config_dir)) {
         $app->log("Getmail config directory '".$this->getmail_config_dir."' does not exist.",LOGLEVEL_ERROR);
         $app->log("Getmail config directory '".$this->getmail_config_dir."' does not exist.", LOGLEVEL_ERROR);
      } else {
			

         // Delete the config file first, if it exists
         $this->delete($event_name,$data);
			
         $this->delete($event_name, $data);

         // Get the new config file path
         $config_file_path = escapeshellcmd($this->getmail_config_dir.'/'.$this->_clean_path($data["new"]["source_server"]).'_'.$this->_clean_path($data["new"]["source_username"]).'.conf');
         if(stristr($config_file_path, "..") or stristr($config_file_path, "|") or stristr($config_file_path,";") or stristr($config_file_path,'$')) {
            $app->log("Possibly faked path for getmail config file: '$config_file_path'. File is not written.",LOGLEVEL_ERROR);
         if(stristr($config_file_path, "..") or stristr($config_file_path, "|") or stristr($config_file_path, ";") or stristr($config_file_path, '$')) {
            $app->log("Possibly faked path for getmail config file: '$config_file_path'. File is not written.", LOGLEVEL_ERROR);
            return false;
         }

			

         if($data["new"]["active"] == 'y') {
            // Open master template
            $tpl = file_get_contents($conf["rootpath"].'/conf/getmail.conf.master');
			

            // Shall emails be deleted after retrieval
            if($data["new"]["source_delete"] == 'y') {
               $tpl = str_replace('{DELETE}','true',$tpl);
               $tpl = str_replace('{DELETE}', 'true', $tpl);
            } else {
               $tpl = str_replace('{DELETE}','false',$tpl);
               $tpl = str_replace('{DELETE}', 'false', $tpl);
            }

            if($data["new"]["read_all"] == 'y') {
@@ -114,59 +114,59 @@
            } else {
               $tpl = str_replace('{READ_ALL}', 'false', $tpl);
            }
				

            // Set the data retriever
            if($data["new"]["type"] == 'pop3') {
               $tpl = str_replace('{TYPE}','SimplePOP3Retriever',$tpl);
               $tpl = str_replace('{TYPE}', 'SimplePOP3Retriever', $tpl);
            } elseif ($data["new"]["type"] == 'imap') {
               $tpl = str_replace('{TYPE}','SimpleIMAPRetriever',$tpl);
               $tpl = str_replace('{TYPE}', 'SimpleIMAPRetriever', $tpl);
            } elseif ($data["new"]["type"] == 'pop3ssl') {
               $tpl = str_replace('{TYPE}','SimplePOP3SSLRetriever',$tpl);
               $tpl = str_replace('{TYPE}', 'SimplePOP3SSLRetriever', $tpl);
            } elseif ($data["new"]["type"] == 'imapssl') {
               $tpl = str_replace('{TYPE}','SimpleIMAPSSLRetriever',$tpl);
               $tpl = str_replace('{TYPE}', 'SimpleIMAPSSLRetriever', $tpl);
            }
			

            // Set server, username, password and destination.
            $tpl = str_replace('{SERVER}',$data["new"]["source_server"],$tpl);
            $tpl = str_replace('{USERNAME}',$data["new"]["source_username"],$tpl);
            $tpl = str_replace('{PASSWORD}',$data["new"]["source_password"],$tpl);
            $tpl = str_replace('{DESTINATION}',$data["new"]["destination"],$tpl);
				
            $tpl = str_replace('{SERVER}', $data["new"]["source_server"], $tpl);
            $tpl = str_replace('{USERNAME}', $data["new"]["source_username"], $tpl);
            $tpl = str_replace('{PASSWORD}', $data["new"]["source_password"], $tpl);
            $tpl = str_replace('{DESTINATION}', $data["new"]["destination"], $tpl);

            // Write the config file.
            file_put_contents($config_file_path,$tpl);
            $app->log("Writing Getmail config file: $config_file_path",LOGLEVEL_DEBUG);
            file_put_contents($config_file_path, $tpl);
            $app->log("Writing Getmail config file: $config_file_path", LOGLEVEL_DEBUG);
            chmod($config_file_path, 0400);
            chown($config_file_path, 'getmail');
            unset($tpl);
            unset($config_file_path);
				

         } else {
            // If record is set to inactive, we will delete the file
            if(is_file($config_file_path)) unlink($config_file_path);
         }
      }
   }
	
   function delete($event_name,$data) {

   function delete($event_name, $data) {
      global $app, $conf;
		

      // load the server specific configuration options for getmail
      $app->uses("getconf");
      $getmail_config = $app->getconf->get_server_config($conf["server_id"], 'getmail');
      $this->getmail_config_dir = $getmail_config["getmail_config_dir"];
		

      $config_file_path = escapeshellcmd($this->getmail_config_dir.'/'.$this->_clean_path($data["old"]["source_server"]).'_'.$this->_clean_path($data["old"]["source_username"]).'.conf');
      if(stristr($config_file_path,"..") || stristr($config_file_path,"|") || stristr($config_file_path,";") || stristr($config_file_path,'$')) {
         $app->log("Possibly faked path for getmail config file: '$config_file_path'. File is not written.",LOGLEVEL_ERROR);
      if(stristr($config_file_path, "..") || stristr($config_file_path, "|") || stristr($config_file_path, ";") || stristr($config_file_path, '$')) {
         $app->log("Possibly faked path for getmail config file: '$config_file_path'. File is not written.", LOGLEVEL_ERROR);
         return false;
      }
      if(is_file($config_file_path)) unlink($config_file_path);
   }
	

   function _clean_path($input) {
      return preg_replace('/[^A-Za-z0-9\-_]/', '_', $input);
   }
	


} // end class