Fixed: FS#996 - SOAP: Problems with (custom) mailfilters.

tbrehm

2010-02-10 6dc3004bbb23b230d14a5017f81f0559396be3e2

Fixed: FS#996 - SOAP: Problems with (custom) mailfilters.

 interface/lib/classes/remoting.inc.php

@@ -40,6 +40,9 @@
    private $session_timeout = 600;
    
    private $server;
    public $oldDataRecord;
    public $dataRecord;
    public $id;
    
    /*
    These variables shall stay global. 
@@ -232,33 +235,39 @@
    
    public function mail_user_filter_add($session_id, $client_id, $params)
    {
        global $app;
        if (!$this->checkPerm($session_id, 'mail_user_filter_add')){
            $this->server->fault('permission_denied','You do not have the permissions to access this function.');
            return false;
        }
        $affected_rows = $this->insertQuery('../mail/form/mail_user_filter.tform.php', $client_id, $params);
        $app->plugin->raiseEvent('mail:mail_user_filter:on_after_insert',$this);
        return $affected_rows;
    }

    public function mail_user_filter_update($session_id, $client_id, $primary_id, $params)
    {
        global $app;
        if (!$this->checkPerm($session_id, 'mail_user_filter_update'))
        {
            $this->server->fault('permission_denied','You do not have the permissions to access this function.');
            return false;
        }
        $affected_rows = $this->updateQuery('../mail/form/mail_user_filter.tform.php', $client_id, $primary_id, $params);
        $app->plugin->raiseEvent('mail:mail_user_filter:on_after_update',$this);
        return $affected_rows;
    }

    public function mail_user_filter_delete($session_id,$domain_id)
    {
        global $app;
        if (!$this->checkPerm($session_id, 'mail_user_filter_delete'))
        {
            $this->server->fault('permission_denied','You do not have the permissions to access this function.');
            return false;
        }
        $affected_rows = $this->deleteQuery('../mail/form/mail_user_filter.tform.php',$domain_id);
        $app->plugin->raiseEvent('mail:mail_user_filter:on_after_delete',$this);
        return $affected_rows;
    }

@@ -1945,7 +1954,9 @@
            
        }
        
		
        // set a few values for compatibility with tform actions, mostly used by plugins
        $this->id = $insert_id;
        $this->dataRecord = $params;
        
        
        return $insert_id;
@@ -1973,6 +1984,12 @@
        
        $old_rec = $app->remoting_lib->getDataRecord($primary_id);
        
        // set a few values for compatibility with tform actions, mostly used by plugins
        $this->oldDataRecord = $old_rec;
        $this->id = $primary_id;
        $this->dataRecord = $params;
		
		
        $app->db->query($sql);
        
        if($app->db->errorMessage != '') {

 interface/lib/plugins/mail_user_filter_plugin.inc.php

New file
@@ -0,0 +1,213 @@
<?php

/*
Copyright (c) 2010, 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 mail_user_filter_plugin {
	
    var $plugin_name = 'mail_user_filter_plugin';
    var $class_name = 'mail_user_filter_plugin';
	
    /*
         This function is called when the plugin is loaded
    */
	
    function onLoad() {
        global $app;
		
        /*
        Register for the events
        */
		
        $app->plugin->registerEvent('mail:mail_user_filter:on_after_insert','mail_user_filter_plugin','mail_user_filter_edit');
        $app->plugin->registerEvent('mail:mail_user_filter:on_after_update','mail_user_filter_plugin','mail_user_filter_edit');
		
		
    }
	
	
    /*
        function to create the mail filter rule and insert it into the custom rules 
        field when a new mail filter is added or modified.
    */
    function mail_user_filter_edit($event_name,$page_form) {
        global $app, $conf;
				
        $mailuser = $app->db->queryOneRecord("SELECT custom_mailfilter FROM mail_user WHERE mailuser_id = ".$page_form->dataRecord["mailuser_id"]);
        $skip = false;
        $lines = explode("\n",$mailuser['custom_mailfilter']);
        $out = '';
        $found = false;
		
        foreach($lines as $line) {
            $line = rtrim($line);
            if($line == '### BEGIN FILTER_ID:'.$page_form->id) {
                $skip = true;
                $found = true;
            }
            if($skip == false && $line != '') $out .= $line ."\n";
            if($line == '### END FILTER_ID:'.$page_form->id) {
                $out .= $this->mail_user_filter_get_rule($page_form);
                $skip = false;
            }
        }
		
        // We did not found our rule, so we add it now as first rule.
        if($found == false) {
            $new_rule = $this->mail_user_filter_get_rule($page_form);
            $out = $new_rule . $out;
        }
		
        $out = $app->db->quote($out);
        $app->db->datalogUpdate('mail_user', "custom_mailfilter = '$out'", 'mailuser_id', $page_form->dataRecord["mailuser_id"]);
		
		
    }
	
    /*
        private function to create the mail filter rules in maildrop or sieve format.
    */
    private function mail_user_filter_get_rule($page_form) {
		
        global $app,$conf;
		
        $app->uses("getconf");
        $mailuser_rec = $app->db->queryOneRecord("SELECT server_id FROM mail_user WHERE mailuser_id = ".intval($page_form->dataRecord["mailuser_id"]));
        $mail_config = $app->getconf->get_server_config(intval($mailuser_rec["server_id"]),'mail');
		
        if($mail_config['mail_filter_syntax'] == 'sieve') {
			
            // #######################################################
            // Filter in Sieve Syntax
            // #######################################################
			
            $content = '';
            $content .= '### BEGIN FILTER_ID:'.$page_form->id."\n";
			
            //$content .= 'require ["fileinto", "regex", "vacation"];'."\n";
			
            $content .= 'if header :regex    ["'.strtolower($page_form->dataRecord["source"]).'"] ["';
			
            $searchterm = preg_quote($page_form->dataRecord["searchterm"]);
			
            if($page_form->dataRecord["op"] == 'contains') {
                $content .= ".*".$searchterm;
            } elseif ($page_form->dataRecord["op"] == 'is') {
                $content .= $searchterm."$";
            } elseif ($page_form->dataRecord["op"] == 'begins') {
                $content .= " ".$searchterm."";
            } elseif ($page_form->dataRecord["op"] == 'ends') {
                $content .= ".*".$searchterm."$";
            }
			
            $content .= '"] {'."\n";
			
            if($page_form->dataRecord["action"] == 'move') {
                $content .= '    fileinto "'.$page_form->dataRecord["target"].'";' . "\n";
            } else {
                $content .= "    discard;\n";
            }
			
            $content .= "    stop;\n}\n";
			
            $content .= '### END FILTER_ID:'.$page_form->id."\n";
		
        } else {
		
            // #######################################################
            // Filter in Maildrop Syntax
            // #######################################################
            $content = '';
            $content .= '### BEGIN FILTER_ID:'.$page_form->id."\n";

            $TargetNoQuotes = $page_form->dataRecord["target"];
            $TargetQuotes = "\"$TargetNoQuotes\"";

            $TestChDirNoQuotes = '$DEFAULT/.'.$TargetNoQuotes;
            $TestChDirQuotes = "\"$TestChDirNoQuotes\"";

            $MailDirMakeNoQuotes = $TargetQuotes.' $DEFAULT';

            $EchoTargetFinal = $TargetNoQuotes;


            if($page_form->dataRecord["action"] == 'move') {

            $content .= "
`test -e ".$TestChDirQuotes." && exit 1 || exit 0`
if ( ".'$RETURNCODE'." != 1 )
{
    `maildirmake -f $MailDirMakeNoQuotes`
    `chmod -R 0700 ".$TestChDirQuotes."`
    `echo \"INBOX.$EchoTargetFinal\" >> ".'$DEFAULT'."/courierimapsubscribed`
}
";
            }

            $content .= "if (/^".$page_form->dataRecord["source"].":";

            $searchterm = preg_quote($page_form->dataRecord["searchterm"]);

            if($page_form->dataRecord["op"] == 'contains') {
                $content .= ".*".$searchterm."/:h)\n";
            } elseif ($page_form->dataRecord["op"] == 'is') {
                $content .= $searchterm."$/:h)\n";
            } elseif ($page_form->dataRecord["op"] == 'begins') {
                $content .= " ".$searchterm."/:h)\n";
            } elseif ($page_form->dataRecord["op"] == 'ends') {
                $content .= ".*".$searchterm."$/:h)\n";
            }

            $content .= "{\n";
            $content .= "exception {\n";

            if($page_form->dataRecord["action"] == 'move') {
                $content .= 'ID' . "$page_form->id" . 'EndFolder = "$DEFAULT/.' . $page_form->dataRecord['target'] . '/"' . "\n";
                $content .= "to ". '$ID' . "$page_form->id" . 'EndFolder' . "\n";
            } else {
                $content .= "to /dev/null\n";
            }

            $content .= "}\n";
            $content .= "}\n";
		
            //}
		
            $content .= '### END FILTER_ID:'.$page_form->id."\n";
		
        }
		
        return $content;
    }
	

} // end class



?>

 interface/web/mail/mail_user_filter_edit.php

@@ -68,18 +68,10 @@
        parent::onSubmit();
    }
    
    /*
    function onAfterInsert() {
        global $app, $conf;
        
        /*
        $mailuser = $app->db->queryOneRecord("SELECT sys_groupid, custom_mailfilter FROM mail_user WHERE mailuser_id = ".$this->dataRecord["mailuser_id"]);
        $rule_content = $mailuser['custom_mailfilter']."\n".$app->db->quote($this->getRule());
        $rule_content = $app->db->quote($rule_content);
        $app->db->datalogUpdate('mail_user', "custom_mailfilter = '$rule_content'", 'mailuser_id', $this->dataRecord["mailuser_id"]);
		
        // set permissions
        $app->db->query("UPDATE mail_user_filter SET sys_groupid = ".$mailuser['sys_groupid']." WHERE filter_id = ".$this->id);
        */
        $this->onAfterUpdate();
        
        $app->db->query("UPDATE mail_user_filter SET sys_groupid = ".$mailuser['sys_groupid']." WHERE filter_id = ".$this->id);
@@ -230,6 +222,7 @@
        
        return $content;
    }
    */
    
}