beautified code for marius ;)

Florian Schaal

2014-08-08 d5712ba340a58c0f1dce3ea173f12fd06eec74d9

 server/plugins-available/mail_plugin_dkim.inc.php

@@ -87,6 +87,10 @@
            break;
         }
      }
      //* If we can use seperate config-files with amavis use 60-dkim
      if (substr_compare($amavis_configfile, '50-user', -7) === 0)
         $amavis_configfile = str_replace('50-user', '60-dkim', $amavis_configfile);

      return $amavis_configfile;
   }

@@ -98,22 +102,51 @@
    */
   function check_system($data) {
      global $app, $mail_config;

      $app->uses('getconf');
      $check=true;

      /* check for amavis-config */
      if ( $this->get_amavis_config() == '' || !is_writeable($this->get_amavis_config()) ) {
      $amavis_configfile = $this->get_amavis_config();

      //* When we can use 60-dkim for the dkim-keys create the file if it does not exists.
      if (substr_compare($amavis_configfile, '60-dkim', -7) === 0 && !file_exists($amavis_configfile))
         file_put_contents($amavis_configfile, '');

      if ( $amavis_configfile == '' || !is_writeable($amavis_configfile) ) {
         $app->log('Amavis-config not found or not writeable.', LOGLEVEL_ERROR);
         $check=false;
      }
      /* dir for dkim-keys writeable? */
      $mail_config = $app->getconf->get_server_config($conf['server_id'], 'mail');
      if (isset($mail_config['dkim_path']) && isset($data['new']['dkim_private']) && !empty($data['new']['dkim_private'])) {
      if (isset($mail_config['dkim_path']) && (!empty($mail_config['dkim_path'])) && isset($data['new']['dkim_private']) && !empty($data['new']['dkim_private'])) {

            if (!is_dir($mail_config['dkim_path'])) {
                $app->log('DKIM Path '.$mail_config['dkim_path'].' not found - (re)created.', LOGLEVEL_DEBUG);
            if($app->system->is_user('amavis')) { 
               $amavis_user='amavis'; 
            } elseif ($app->system->is_user('vscan')) { 
               $amavis_user='vscan'; 
            }
            else { 
               $amavis_user=''; 
            }
            if(!empty($amavis_user)) {
               mkdir($mail_config['dkim_path'], 0750, true);
               exec('chown '.$amavis_user.' /var/lib/amavis/dkim');
               unset($amavis_user);
            } else {
               mkdir($mail_config['dkim_path'], 0755, true);
            }
            }

         if (!is_writeable($mail_config['dkim_path'])) {
            $app->log('DKIM Path '.$mail_config['dkim_path'].' not found or not writeable.', LOGLEVEL_ERROR);
            $app->log('DKIM Path '.$mail_config['dkim_path'].' not writeable.', LOGLEVEL_ERROR);
            $check=false;
         }

      } else {
         $app->log('Unable to write DKIM settings; Check your config!', LOGLEVEL_ERROR);
         $app->log('Unable to write DKIM settings - no DKIM-Path defined', LOGLEVEL_ERROR);
         $check=false;
      }
      return $check;
@@ -154,13 +187,13 @@
         $app->log('Saved DKIM Private-key to '.$key_file.'.private', LOGLEVEL_DEBUG);
         $success=true;
         /* now we get the DKIM Public-key */
         exec('cat '.escapeshellarg($key_file.'.private').'|openssl rsa -pubout', $pubkey, $result);
         exec('cat '.escapeshellarg($key_file.'.private').'|openssl rsa -pubout 2> /dev/null', $pubkey, $result);
         $public_key='';
         foreach($pubkey as $values) $public_key=$public_key.$values."\n";
         /* save the DKIM Public-key in dkim-dir */
         if (!file_put_contents($key_file.'.public', $public_key) === false)
            $app->log('Saved DKIM Public to '.$key_domain.'.', LOGLEVEL_DEBUG);
         else $app->log('Unable to save DKIM Public to '.$key_domain.'.', LOGLEVEL_WARNING);
         else $app->log('Unable to save DKIM Public to '.$key_domain.'.', LOGLEVEL_DEBUG);
      }
      return $success;
   }
@@ -186,19 +219,39 @@
    * This function adds the entry to the amavisd-config
    * @param string $key_domain mail-domain
    */
   function add_to_amavis($key_domain) {
   function add_to_amavis($key_domain, $selector, $old_selector) {
      global $app, $mail_config;
      $amavis_config = file_get_contents($this->get_amavis_config());
      $key_value="dkim_key('".$key_domain."', 'default', '".$mail_config['dkim_path']."/".$key_domain.".private');\n";
      if(strpos($amavis_config, $key_value) === false) {
         $amavis_config = str_replace($key_value, '', $amavis_config);
         if (!file_put_contents($this->get_amavis_config(), $key_value, FILE_APPEND) === false) {
            $app->log('Adding DKIM Private-key to amavis-config.', LOGLEVEL_DEBUG);
            $this->restart_amavis();

      if (empty($selector)) $selector = 'default';
      $restart = false;
      $amavis_configfile = $this->get_amavis_config();

      $search_regex = "/(\n|\r)?dkim_key\(\'".$key_domain."\',\ \'(".$selector."|".$old_selector."){1}?\'.*/";

      //* If we are using seperate config-files with amavis remove existing keys from 50-user to avoid duplicate keys
      if (substr_compare($amavis_configfile, '60-dkim', -7) === 0) {
         $temp_configfile = str_replace('60-dkim', '50-user', $amavis_configfile);
         $temp_config = file_get_contents($temp_configfile);
         if (preg_match($search_regex, $temp_config)) {
            $temp_config = preg_replace($search_regex, '', $temp_config)."\n";
            file_put_contents($temp_configfile, $temp_config);
         }
      } else {
         $app->log('DKIM Private-key already in amavis-config.',LOGLEVEL_DEBUG);
         unset($temp_configfile);
         unset($temp_config);
      }

      $key_value="dkim_key('".$key_domain."', '".$selector."', '".$mail_config['dkim_path']."/".$key_domain.".private');\n";
      $amavis_config = file_get_contents($amavis_configfile);
      $amavis_config = preg_replace($search_regex, '', $amavis_config).$key_value;

      if (file_put_contents($amavis_configfile, $amavis_config)) {
         $app->log('Adding DKIM Private-key to amavis-config.', LOGLEVEL_DEBUG);
         $restart = true;
      } else {
         $app->log('Unable to add DKIM Private-key for '.$key_domain.' to amavis-config.', LOGLEVEL_ERROR);
      }

      return $restart;
   }

   /**
@@ -207,20 +260,34 @@
    */
   function remove_from_amavis($key_domain) {
      global $app;
      $amavis_config = file($this->get_amavis_config());
      $i=0;$found=false;
      foreach($amavis_config as $line) {
         if (preg_match("/^\bdkim_key\b.*\b".$key_domain."\b/", $line)) {
            unset($amavis_config[$i]);
            $found=true;
         }
         $i++;
      }
      if ($found) {
         file_put_contents($this->get_amavis_config(), $amavis_config);

      $restart = false;
      $amavis_configfile = $this->get_amavis_config();
      $amavis_config = file_get_contents($amavis_configfile);

      $search_regex = "/(\n|\r)?dkim_key.*".$key_domain.".*(\n|\r)?/";

      if (preg_match($search_regex, $amavis_config)) {
         $amavis_config = preg_replace($search_regex, '', $amavis_config);
         file_put_contents($amavis_configfile, $amavis_config);
         $app->log('Deleted the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_DEBUG);
         $this->restart_amavis();
      } else $app->log('Unable to delete the DKIM settings from amavis-config for '.$key_domain.'.', LOGLEVEL_ERROR);
         $restart = true;
      }

      //* If we are using seperate config-files with amavis remove existing keys from 50-user, too
      if (substr_compare($amavis_configfile, '60-dkim', -7) === 0) {
         $temp_configfile = str_replace('60-dkim', '50-user', $amavis_configfile);
         $temp_config = file_get_contents($temp_configfile);
         if (preg_match($search_regex, $temp_config)) {
            $temp_config = preg_replace($search_regex, '', $temp_config);
            file_put_contents($temp_configfile, $temp_config);
            $restart = true;
         }
         unset($temp_configfile);
         unset($temp_config);
      }

      return $restart;
   }

   /**
@@ -234,13 +301,14 @@
         if ( substr($mail_config['dkim_path'], strlen($mail_config['dkim_path'])-1) == '/' )
            $mail_config['dkim_path'] = substr($mail_config['dkim_path'], 0, strlen($mail_config['dkim_path'])-1);
         if ($this->write_dkim_key($mail_config['dkim_path']."/".$data['new']['domain'], $data['new']['dkim_private'], $data['new']['domain'])) {
            $this->add_to_amavis($data['new']['domain']);
            if ($this->add_to_amavis($data['new']['domain'], $data['new']['dkim_selector'], $data['old']['dkim_selector'] )) {
               $this->restart_amavis();
            } else {
               $this->remove_dkim_key($mail_config['dkim_path']."/".$data['new']['domain'], $data['new']['domain']);
            }
         } else {
            $app->log('Error saving the DKIM Private-key for '.$data['new']['domain'].' - DKIM is not enabled for the domain.', LOGLEVEL_ERROR);
         }
      }
      else {
         $app->log('DKIM for '.$data['new']['domain'].' not written to disk - domain is inactive', LOGLEVEL_DEBUG);
      }
   }

@@ -255,7 +323,8 @@
      if ( substr($mail_config['dkim_path'], strlen($mail_config['dkim_path'])-1) == '/' )
         $mail_config['dkim_path'] = substr($mail_config['dkim_path'], 0, strlen($mail_config['dkim_path'])-1);
      $this->remove_dkim_key($mail_config['dkim_path']."/".$_data['domain'], $_data['domain']);
      $this->remove_from_amavis($_data['domain']);
      if ($this->remove_from_amavis($_data['domain']))
         $this->restart_amavis();
   }

   /**
@@ -263,7 +332,8 @@
    * deletes dkim-keys
    */
   function domain_dkim_delete($event_name, $data) {
      if (isset($data['old']['dkim']) && $data['old']['dkim'] == 'y' && $data['old']['active'] == 'y') $this->remove_dkim($data['old']);	
      if (isset($data['old']['dkim']) && $data['old']['dkim'] == 'y' && $data['old']['active'] == 'y')
         $this->remove_dkim($data['old']);
   }

   /**
@@ -271,9 +341,8 @@
    * insert dkim-keys
    */
   function domain_dkim_insert($event_name, $data) {
      if (isset($data['new']['dkim']) && $data['new']['dkim']=='y' && $this->check_system($data)) {
      if (isset($data['new']['dkim']) && $data['new']['dkim']=='y' && $this->check_system($data))
         $this->add_dkim($data);
      }
   }

   /**
@@ -284,22 +353,13 @@
      global $app;
      if ($this->check_system($data)) {
         /* maildomain disabled */
         if ($data['new']['active'] == 'n' && $data['old']['active'] == 'y') {
         if ($data['new']['active'] == 'n' && $data['old']['active'] == 'y' && $data['new']['dkim']=='y') {
            $app->log('Maildomain '.$data['new']['domain'].' disabled - remove DKIM-settings', LOGLEVEL_DEBUG);
            if ($data['new']['dkim']=='y') {
               $this->remove_dkim($data['new']);
            }
            if ($data['old']['dkim']=='y') {
               $this->remove_dkim($data['old']);
            }
            $this->remove_dkim($data['new']);
         }

         /* maildomain re-enabled */
         if ($data['new']['active'] == 'y' && $data['old']['active'] == 'n') {
            if ($data['new']['dkim']=='y') {
               $this->add_dkim($data);
            }
         }
         if ($data['new']['active'] == 'y' && $data['old']['active'] == 'n' && $data['new']['dkim']=='y') 
            $this->add_dkim($data);

         /* maildomain active - only dkim changes */
         if ($data['new']['active'] == 'y' && $data['old']['active'] == 'y') {
@@ -311,8 +371,16 @@
            elseif ($data['new']['dkim'] != $data['old']['dkim'] && $data['new']['dkim'] == 'y') {
               $this->add_dkim($data);
            }
            /* new private-key or new domain-name */
            if ($data['new']['dkim_private'] != $data['old']['dkim_private'] || $data['new']['domain'] != $data['old']['domain']) {
            /* new private-key */
            if ($data['new']['dkim_private'] != $data['old']['dkim_private'] && $data['new']['dkim'] == 'y') {
               $this->add_dkim($data);
            }
            /* new selector */
            if ($data['new']['dkim_selector'] != $data['old']['dkim_selector'] && $data['new']['dkim'] == 'y') {
               $this->add_dkim($data);
            }
            /* new domain-name */
            if ($data['new']['domain'] != $data['old']['domain']) {
               $this->remove_dkim($data['old']);
               $this->add_dkim($data);
            }