allow matching regex in custom mail filter

Author: jnorell

interface/lib/plugins/mail_user_filter_plugin.inc.php

@@ -162,23 +162,48 @@ private function mail_user_filter_get_rule($page_form) {
 
 				$content .= 'if header :regex    ["'.strtolower($page_form->dataRecord["source"]).'"] ["';
 
-				$searchterm = preg_quote($page_form->dataRecord["searchterm"]);
-				$searchterm = str_replace(
-					array(
-						'"',
-						'\\[',
-						'\\]'
-					),
-					array(
-						'\\"',
-						'\\\\[',
-						'\\\\]'
-					), $searchterm);
+				# special chars in sieve regex must be escaped with double-backslash
+				if($page_form->dataRecord["op"] == 'regex') {
+					# if providing a regex, special chars must already be quoted as intended;
+					# we will simply try to check for an obviously unquoted double-quote and handle that.
+					$patterns = array( '/([^\\\\]{2})"/', '/([^\\\\])\\\\"/' );
+					$replace  = array( '${1}\\\\\\\\"', '${1}\\\\\\\\"' );
+					$searchterm = preg_replace( $patterns, $replace, $page_form->dataRecord["searchterm"] );
+				} else {
+					$sieve_regex_escape = array(
+						'\\' => '\\\\\\',
+						'+' => '\\\\+',
+						'*' => '\\\\*',
+						'?' => '\\\\?',
+						'[' => '\\\\[',
+						'^' => '\\\\^',
+						']' => '\\\\]',
+						'$' => '\\\\$',
+						'(' => '\\\\(',
+						')' => '\\\\)',
+						'{' => '\\\\{',
+						'}' => '\\\\}',
+						'|' => '\\\\|',
+						'.' => '\\\\.',
+						# these (from preg_quote) should not be needed
+						#'=' => '\\\\=',
+						#'!' => '\\\\!',
+						#'<' => '\\\\<',
+						#'>' => '\\\\>',
+						#':' => '\\\\:',
+						#'-' => '\\\\-',
+						#'#' => '\\\\#',
+						);
+					$searchterm = strtr( $page_form->dataRecord["searchterm"], $sieve_regex_escape );
+
+				}
 
 				if($page_form->dataRecord["op"] == 'contains') {
 					$content .= ".*".$searchterm;
 				} elseif ($page_form->dataRecord["op"] == 'is') {
 					$content .= "^".$searchterm."$";
+				} elseif ($page_form->dataRecord["op"] == 'regex') {
+					$content .= $searchterm;
 				} elseif ($page_form->dataRecord["op"] == 'begins') {
 					$content .= "^".$searchterm."";
 				} elseif ($page_form->dataRecord["op"] == 'ends') {

interface/web/mail/form/mail_user_filter.tform.php

@@ -94,8 +94,7 @@
 			'datatype' => 'VARCHAR',
 			'formtype' => 'SELECT',
 			'default' => '',
-			//'value'  => array('contains'=>'contains_txt','is' => 'Is','begins'=>'Begins with','ends'=>'Ends with')
-			'value'  => array('contains'=>'contains_txt', 'is' => 'is_txt', 'begins'=>'begins_with_txt', 'ends'=>'ends_with_txt', 'localpart' => 'localpart_txt', 'domain' => 'domain_txt')
+			'value'  => array('contains'=>'contains_txt', 'is'=>'is_txt', 'begins'=>'begins_with_txt', 'ends'=>'ends_with_txt', 'regex'=>'regex_txt', 'localpart'=>'localpart_txt', 'domain'=>'domain_txt')
 		),
 		'searchterm' => array (
 			'datatype' => 'VARCHAR',

interface/web/mail/lib/lang/ar_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Contains';
 $wb['is_txt'] = 'Is';
 $wb['begins_with_txt'] = 'Begins with';
 $wb['ends_with_txt'] = 'Ends with';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['delete_txt'] = 'Delete';
 $wb['move_stop_txt'] = 'Move to';
 $wb['header_txt'] = 'Header';

interface/web/mail/lib/lang/bg_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Описание';
 $wb['is_txt'] = 'е';
 $wb['begins_with_txt'] = 'Начало с';
 $wb['ends_with_txt'] = 'Край с';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['delete_txt'] = 'Изтрий';
 $wb['move_stop_txt'] = 'Move to';
 $wb['header_txt'] = 'Header';

interface/web/mail/lib/lang/br_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Contêm';
 $wb['is_txt'] = 'é';
 $wb['begins_with_txt'] = 'Iniciando com';
 $wb['ends_with_txt'] = 'Terminando com';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['move_stop_txt'] = 'Mover para';
 $wb['delete_txt'] = 'Remover';
 $wb['header_txt'] = 'Cabeçalho';

interface/web/mail/lib/lang/ca_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Contient';
 $wb['is_txt'] = 'Est';
 $wb['begins_with_txt'] = 'Commence par';
 $wb['ends_with_txt'] = 'Fini par';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['delete_txt'] = 'Supprimer';
 $wb['move_stop_txt'] = 'Move to';
 $wb['header_txt'] = 'Header';

interface/web/mail/lib/lang/cz_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Obsahuje';
 $wb['is_txt'] = 'Je';
 $wb['begins_with_txt'] = 'Začíná na';
 $wb['ends_with_txt'] = 'Končí na';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['delete_txt'] = 'Smazat';
 $wb['move_stop_txt'] = 'Přesunout';
 $wb['header_txt'] = 'Hlavička';

interface/web/mail/lib/lang/de_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Enthält';
 $wb['is_txt'] = 'Ist';
 $wb['begins_with_txt'] = 'Beginnt mit';
 $wb['ends_with_txt'] = 'Endet mit';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['move_stop_txt'] = 'Verschieben nach';
 $wb['delete_txt'] = 'Löschen';
 $wb['header_txt'] = 'Header';

interface/web/mail/lib/lang/dk_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Indeholder';
 $wb['is_txt'] = 'Er';
 $wb['begins_with_txt'] = 'Begynder med';
 $wb['ends_with_txt'] = 'Slutter med';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['move_stop_txt'] = 'Flyt til';
 $wb['delete_txt'] = 'Slet';
 $wb['header_txt'] = 'Hoved';

interface/web/mail/lib/lang/el_mail_user_filter.lng

@@ -16,6 +16,7 @@ $wb['contains_txt'] = 'Περιλαμβάνει';
 $wb['is_txt'] = 'είναι';
 $wb['begins_with_txt'] = 'Ξεκινά με';
 $wb['ends_with_txt'] = 'Τελειώνει σε';
+$wb['regex_txt'] = 'Matches Regex';
 $wb['delete_txt'] = 'Διαγραφή';
 $wb['move_stop_txt'] = 'Move to';
 $wb['header_txt'] = 'Header';