falon / RBL

contrib/mailClassifier/function.php

Doc Comments +7 added lines

@@ -56,6 +56,10 @@ 
 	return $head;
 }
 
+/**
+ * @param null|string $prob
+ * @param null|string $conf
+ */
 function dspamLevel($prob, $conf) {
 /* Calculate DSPAM Level as the Spamassassin Plugin */
 	if (is_null($prob) or is_null($conf)) return '-';
@@ -63,6 +67,9 @@ 
 	return round(($t_prob + ($conf*100)) / 2);
 }
 
+/**
+ * @param string $classSpam
+ */
 function dspamType($classSpam) {
 	switch($classSpam) {
 		case 'HAM':

Braces +106 added lines, -72 removed lines

@@ -5,18 +5,21 @@ 
 	$open='{'.$cf['mailhost'].':143/imap/novalidate-cert/authuser='.$cf['authuser'].'}';
         $m_mail = imap_open($open, $username, $cf['authpassword'], OP_READONLY)
                 or syslog (LOG_EMERG, $cf['user'].': Error in IMAP connection to <'.$cf['mailhost'].'>: ' . imap_last_error());
-        if ( !$m_mail ) exit(254);
+        if ( !$m_mail ) {
+        	exit(254);
+        }
 
 
         syslog (LOG_INFO,$cf['user'].': Successfully connected to <'.$cf['mailhost'].'>; Listing folders of account <'.$username.'>...');
         //get all folder
 	$list = imap_list($m_mail, $open, "*");
 	imap_close($m_mail);
-	if (is_array($list))
-		foreach ($list as $mbox)
+	if (is_array($list)) {
+			foreach ($list as $mbox)
 			$return[] = explode($open,$mbox,2)[1];
-	else
-		syslog (LOG_INFO,$cf['user'] . ': imap_list failed: ' . imap_last_error() );
+	} else {
+			syslog (LOG_INFO,$cf['user'] . ': imap_list failed: ' . imap_last_error() );
+	}
 	return $return;
 }
 
@@ -24,7 +27,9 @@ 
 	$head=array();
 	$m_mail = imap_open('{'.$cf['mailhost'].':143/imap/novalidate-cert/authuser='.$cf['authuser'].'}'.$folder, $username,$cf['authpassword'], OP_READONLY)
         	or syslog (LOG_EMERG, $cf['user'].': Error in IMAP connection to <'.$cf['mailhost'].'>: ' . imap_last_error());
-	if ( !$m_mail ) exit(254);
+	if ( !$m_mail ) {
+		exit(254);
+	}
 		
 
 	syslog (LOG_INFO,$cf['user'].': Successfully connected to <'.$cf['mailhost'].">; Reading <$folder> messages of last ".$cf['oldestday'].' days on account <'.$username.'>...');
@@ -36,29 +41,36 @@ 
 	// Order results starting from newest message
 	if ( empty($m_search) ) {
 		syslog (LOG_INFO,$cf['user'].": No suitable mail found in <$folder> folder.");
-	        if ( $ierr = imap_errors() )
-	                foreach ( $ierr as $thiserr )
+	        if ( $ierr = imap_errors() ) {
+	        	                foreach ( $ierr as $thiserr )
 	                        syslog (LOG_ERR, $cf['user'].": IMAP Error: $thiserr");
-	        if ( $ierr = imap_alerts() )
-	                foreach ( $ierr as $thiserr )
+	        }
+	        if ( $ierr = imap_alerts() ) {
+	        	                foreach ( $ierr as $thiserr )
 	                        syslog (LOG_ALERT, $cf['user'].": IMAP Alert: $thiserr");
+	        }
 		imap_close( $m_mail );
 		return FALSE;
 	}
 	$nmes = count ($m_search);
 	syslog (LOG_INFO,$cf['user'].": Found $nmes mail in <$folder> folder.");
-	if ($nmes>0) rsort($m_search);
+	if ($nmes>0) {
+		rsort($m_search);
+	}
 
         // loop for each message
-	foreach ($m_search as $onem) 
-		$head[] = imap_fetchheader($m_mail, $onem );
+	foreach ($m_search as $onem) {
+			$head[] = imap_fetchheader($m_mail, $onem );
+	}
 	imap_close($m_mail);
 	return $head;
 }
 
 function dspamLevel($prob, $conf) {
 /* Calculate DSPAM Level as the Spamassassin Plugin */
-	if (is_null($prob) or is_null($conf)) return '-';
+	if (is_null($prob) or is_null($conf)) {
+		return '-';
+	}
 	$t_prob = abs((($prob - 0.5) * 2) * 100);
 	return round(($t_prob + ($conf*100)) / 2);
 }
@@ -123,7 +135,9 @@ 
 		}
         }
 	$received=NULL;
-	if ($k>1) $result['warn'][] = 'The trusted DMARC AR Headers are present more than once. Something wrong.';
+	if ($k>1) {
+		$result['warn'][] = 'The trusted DMARC AR Headers are present more than once. Something wrong.';
+	}
 
         if ( preg_match_all('/^Authentication\-Results:\s+(?<host>[\w\.]+);(?:\s+|\r\n\s+)spf=(?<spf>\w+)\s+smtp\.(?:mailfrom|helo)=(?<SPFfrom>[\w\.]+)/m',$header,$received) ) {
 		$k=0;
@@ -139,7 +153,9 @@ 
         	}
 	}
 	$received=NULL;
-	if ($k>1) $result['warn'][] = 'The trusted SPF AR Headers are present more than once. Something wrong.';
+	if ($k>1) {
+		$result['warn'][] = 'The trusted SPF AR Headers are present more than once. Something wrong.';
+	}
 
 	$k=0;
         if ( preg_match_all('/^Authentication\-Results:\s+(?<host>[\w\.]+);(?:\s+|\r\n\s+)dkim=(?<dkim>\w+)\s+[\w\s\(\)\-]+header\.d=(?<DKIMdom>[\w\.]+)/m',$header,$received) ) {
@@ -155,7 +171,9 @@ 
         	}
 	}
 	$received=NULL;
-	if ($k>1) $result['warn'][] = 'The trusted DKIM AR Headers are present more than once. Something wrong.';
+	if ($k>1) {
+		$result['warn'][] = 'The trusted DKIM AR Headers are present more than once. Something wrong.';
+	}
 
 	if ($dpl) { /* Use Spamassassin Plugin */
 		if ( preg_match_all('/^X\-Spam\-Status:\s(?P<spamstatus>\w+)\,(?:\s+|\r\n\s+)score=(?P<score>[\-\.\d]+)(?:\s+|\r\n\s+)tagged_above=\-{0,1}\d+(?:\s+|\r\n\s+)required=(?P<th>[\-\.\d]+)(?:\s+|\r\n\s+)tests=\[(?:.|\r\n\s+)*DSPAM_(?P<dtype>SPAM|HAM)_(?P<dlevel>\d\d)(?:.|\r\n\s+)*\]/m',$header,$received) ) {
@@ -165,57 +183,66 @@ 
 			$result['dspam']['type'] = dspamType($received['dtype'][0]);
 			$result['dspam']['level'] =$received['dlevel'][0];
         	}
-        	if (count($received[0])>1) $result['warn'][] = 'The Spamassassin Headers are present more than once. I consider only the last one.';
-	}
-	else { /* Parse apart all DSPAM Header and calculate a level */
+        	if (count($received[0])>1) {
+        		$result['warn'][] = 'The Spamassassin Headers are present more than once. I consider only the last one.';
+        	}
+	} else { /* Parse apart all DSPAM Header and calculate a level */
 		if ( preg_match_all('/^X\-Spam\-Status:\s(?P<spamstatus>\w+)\,(?:\s+|\r\n\s+)score=(?P<score>[\-\.\d]+)(?:\s+|\r\n\s+)tagged_above=\-{0,1}\d+(?:\s+|\r\n\s+)required=(?P<th>[\-\.\d]+)(?:\s+|\r\n\s+)tests=\[(?:.|\r\n\s+)*\]/m',$header,$received) ) {
                         $result['spam']['status']=$received['spamstatus'][0];
                         $result['spam']['score'] = $received['score'][0];
                         $result['spam']['th'] = $received['th'][0];
-			if (count($received[0])>1)
-				$result['warn'][]= 'The Spamassassin Headers are present more than once. I consider only the last one.';
+			if (count($received[0])>1) {
+							$result['warn'][]= 'The Spamassassin Headers are present more than once. I consider only the last one.';
+			}
 		}
-		if ( preg_match ('/\r\nX\-DSPAM\-Result:\s(?P<result>.*)\r\n/',$header,$received) != 1)
-	                $result['warn'] = 'DSPAM Result invalid, not present or present more than once.';
-	        else
-                	$result['dspam']['type']=$received['result'];
+		if ( preg_match ('/\r\nX\-DSPAM\-Result:\s(?P<result>.*)\r\n/',$header,$received) != 1) {
+			                $result['warn'] = 'DSPAM Result invalid, not present or present more than once.';
+		} else {
+	                        	$result['dspam']['type']=$received['result'];
+	        }
 		$prob = NULL;
 		$conf = NULL;
-                if ( preg_match ('/\r\nX\-DSPAM\-Probability:\s(?P<prob>.*)\r\n/',$header,$received) != 1)
-                        $result['warn'][] = 'DSPAM Probability invalid, not present or present more than once.';
-		else
-			$prob = $received['prob'];
-		if ( preg_match ('/\r\nX\-DSPAM\-Confidence:\s(?P<conf>.*)\r\n/',$header,$received) != 1)
-                        $result['warn'][] = 'DSPAM Confidence invalid, not present or present more than once.';
-		else
-			$conf = $received['conf'];
+                if ( preg_match ('/\r\nX\-DSPAM\-Probability:\s(?P<prob>.*)\r\n/',$header,$received) != 1) {
+                                        $result['warn'][] = 'DSPAM Probability invalid, not present or present more than once.';
+                } else {
+					$prob = $received['prob'];
+		}
+		if ( preg_match ('/\r\nX\-DSPAM\-Confidence:\s(?P<conf>.*)\r\n/',$header,$received) != 1) {
+		                        $result['warn'][] = 'DSPAM Confidence invalid, not present or present more than once.';
+		} else {
+					$conf = $received['conf'];
+		}
 		$result['dspam']['level'] = dspamLevel($prob,$conf);
 	}
 	$received=NULL;
-	if ( preg_match ('/\r\nFrom:\s(?P<from>.*)\r\n/',$header,$received) != 1)
-                $result['warn'][] = 'From header invalid or not present';
-        else
-                $result['from'] = $received['from'];
+	if ( preg_match ('/\r\nFrom:\s(?P<from>.*)\r\n/',$header,$received) != 1) {
+	                $result['warn'][] = 'From header invalid or not present';
+	} else {
+                        $result['from'] = $received['from'];
+        }
 
-        if ( preg_match ('/\r\nDate:\s(?P<date>.*)\r\n/',$header,$received) != 1)
-                $result['warn'][] = 'Date header invalid or not present';
-	else
-		$result['date'] = $received['date'];
+        if ( preg_match ('/\r\nDate:\s(?P<date>.*)\r\n/',$header,$received) != 1) {
+                        $result['warn'][] = 'Date header invalid or not present';
+        } else {
+			$result['date'] = $received['date'];
+	}
 
 	$received=NULL;
-        if ( preg_match ('/\r\nMessage\-I(?:D|d):\s(?P<mid>.*)\r\n/',$header,$received) != 1)
-                $result['warn'][] = 'Message-ID invalid, not present or present more than once.';
-	else
-		$result['messageid']=$received['mid'];
+        if ( preg_match ('/\r\nMessage\-I(?:D|d):\s(?P<mid>.*)\r\n/',$header,$received) != 1) {
+                        $result['warn'][] = 'Message-ID invalid, not present or present more than once.';
+        } else {
+			$result['messageid']=$received['mid'];
+	}
 
         $received=NULL;
 
         switch ($learn) {
 		case 'dspamc':
-        		if ( preg_match ('/\r\nX\-DSPAM\-Signature:\s(?P<sig>.*)\r\n/',$header,$received) != 1)
-				$result['warn'] = 'DSPAM Signature invalid, not present or present more than once.';
-			else
-				$result['dspam']['learn']=$received['sig'];			
+        		if ( preg_match ('/\r\nX\-DSPAM\-Signature:\s(?P<sig>.*)\r\n/',$header,$received) != 1) {
+        						$result['warn'] = 'DSPAM Signature invalid, not present or present more than once.';
+        		} else {
+							$result['dspam']['learn']=$received['sig'];
+			}
 			break;
 		case false:
 			break;
@@ -250,8 +277,9 @@ 
 	for ($i=0; $i<$cols; $i++) {
 		$key = $kcontent[$i];
 		if (is_array($content[$key])&&($hs = array_keys($content[$key]))) {
-			foreach ($hs as $h)
-				printf('<th>%s</th>',$h);
+			foreach ($hs as $h) {
+							printf('<th>%s</th>',$h);
+			}
 		}
 	}
 		
@@ -267,15 +295,16 @@ 
 
 function formatVal($val, $learn) {
 	foreach (array_keys($val) as $key) {
-		if (is_array($val["$key"]) and ($key!='warn'))
-			$val["$key"] = formatVal($val["$key"], $learn);
-		else {
+		if (is_array($val["$key"]) and ($key!='warn')) {
+					$val["$key"] = formatVal($val["$key"], $learn);
+		} else {
 			switch ($key) {
 				case 'warn':
-					if (empty($val["$key"]))
-						$val["$key"] = '-';
-					else 
-						$val["$key"] = sprintf('<div title="%s">Y</div>',implode($val["$key"],"\n"));
+					if (empty($val["$key"])) {
+											$val["$key"] = '-';
+					} else {
+											$val["$key"] = sprintf('<div title="%s">Y</div>',implode($val["$key"],"\n"));
+					}
 					break;
 				case 'learn':
 					$val["$key"] = formLearn($learn, $val);
@@ -297,9 +326,10 @@ 
 				$par['class'] = $class;
 				$val["$class"] = sprintf('dspamc --user dspam --deliver=summary --class=%s --source=error --signature=%s',
 							strtolower($class), $par['learn']);
-				if (($class != $par['type'])||($par['level']<99))
-					$return .= sprintf(file_get_contents('formLearnDSPAM.htm'),
+				if (($class != $par['type'])||($par['level']<99)) {
+									$return .= sprintf(file_get_contents('formLearnDSPAM.htm'),
 						$class,$class,$val["$class"],base64_encode(json_encode($par)),$class);
+				}
 			}
 		default:
 			return $return;
@@ -308,37 +338,41 @@ 
 
 function printTableRow($row, $learn, $init=true) {
 	$color = 'inherit';
-	if ($init) 
-		$row=formatVal($row,$learn);
+	if ($init) {
+			$row=formatVal($row,$learn);
+	}
 	foreach( $row as $key => $val) {
-		if (is_array($val))
-			printTableRow($val, $learn, false);
-		else {
+		if (is_array($val)) {
+					printTableRow($val, $learn, false);
+		} else {
 			/* DSPAM format */
-			if (isset($row['type']))
-				switch($row['type']) {
+			if (isset($row['type'])) {
+							switch($row['type']) {
 					case 'Innocent':
 					case 'HAM':
 						$color = 'rgba(0,255,0, %.1f)';
+			}
 						break;
 					case 'Spam':
 					case 'SPAM':
 						$color = 'rgba(255,0,0,%.1f)';
 			}
 			/* DMARC, DKIM, SPF format */
-			if (isset($row['result']))
-				switch($row['result']) {
+			if (isset($row['result'])) {
+							switch($row['result']) {
 					case 'pass':
 						$color = 'rgba(0,255,0, %.1f)';
+			}
 						break;
 					case 'fail':
 						$color = 'rgba(255,0,0,%.1f)';
 				}
 			/* Spamassassin format */
-			if (isset($row['status']))
-	                        switch($row['status']) {
+			if (isset($row['status'])) {
+				                        switch($row['status']) {
 					case 'No':
 						$color = 'rgba(0,255,0, %.1f)';
+			}
 						break;
 					case 'Yes':
 						$color = 'rgba(255,0,0,%.1f)';