Roundcube Community Forum
Third Party Contributions => Old Style Plug-Ins => Topic started by: rosali on February 02, 2008, 12:59:33 AM
-
Here is an AddOn which allows users to report mis-scored messages.
Reported messages will be copied to a spam/ham folder (also to remote folders via ftp).
After revision by the administrator just let run spamassassin sa-learn to train the bayes database of spamassassin.
For further instruction see the code ...
-Roland
<?php
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// RoundCube v0.1 - RC2
//
// AddOn: Report Spam/Ham - program/steps/mail/report_spam_ham.inc
// Purpose: Copies messages to specific folders $rcmail_config['report_spam_folder'] / $rcmail_config['report_ham_folder']
// or via FTP to remote folders $rcmail_config['report_spam_ftp_folder'] / $rcmail_config['report_ham_ftp_folder']
// Reported messages can be used to train a bayes database (f.e. spamassassin sa-learn)
//
// (c) [url]www.roland-liebl.de[/url]
//
// NO WARRANTY - USE AS IS AT YOUR OWN RISK
//
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// config/main.inc.php
//
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/*
//
// show "move to" selector on message list
$rcmail_config['move_to_select'] = TRUE;
//spam/ham report
$rcmail_config['report_spam_ham'] = TRUE;
$rcmail_config['report_spam_folder'] = "c:/sa/spam/";
$rcmail_config['report_ham_folder'] = "c:/sa/ham/";
$rcmail_config['report_spam_ham_ftp'] = TRUE; // if true, folders above will be ignored
$rcmail_config['ftp_server'] = "localhost";
$rcmail_config['ftp_port'] = 21;
$rcmail_config['ftp_passive_mode'] = TRUE;
$rcmail_config['ftp_user'] = "roundcube";
$rcmail_config['ftp_pass'] = "pass";
$rcmail_config['report_spam_ftp_folder'] = "spam/";
$rcmail_config['report_ham_ftp_folder'] = "ham/";
*/
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// program/include/main.inc
//
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/*
// add no-selection option
if ($type=='select' && $attrib['noselection'])
$out .= sprintf('<option value="0">%s</option>'."\n",
rcube_label('action') . "...");
// find me: report spam/ham, message flags, forward as attachment
if ($type=='select')
$out .= sprintf('<option value="-7">%s</option>'."\n",
rcube_label('forward_as_attachment'));
if($type == "select" && isset($CONFIG['report_spam_ham']) && $CONFIG['report_spam_ham'] === TRUE){
$out .= "<optgroup label=\"" . rcube_label("spam_actions") . "\">\r\n";
$out .= "<option value=-1>-- " . rcube_label("report_Spam") . " --</option>\r\n";
$out .= "<option value=-2>-- " . rcube_label("report_Legit") . " --</option>\r\n";
$out .= "</optgroup>\r\n";
}
// NOTICE: This is part of another AddOn message_flags
if($type == "select" && isset($CONFIG['message_flags']) && $CONFIG['message_flags'] === TRUE){
$out .= "<optgroup label=\"" . rcube_label("message_flags") . "\">\r\n";
$out .= "<option value=-3>-- " . rcube_label("mark_as_read") . " --</option>\r\n";
$out .= "<option value=-4>-- " . rcube_label("mark_as_unread") . " --</option>\r\n";
$out .= "<option value=-5>-- " . rcube_label("mark_as_flagged") . " --</option>\r\n";
$out .= "<option value=-6>-- " . rcube_label("mark_as_unflagged") . " --</option>\r\n";
$out .= "</optgroup>\r\n";
}
if(
$type == "select" &&
(isset($CONFIG['report_spam_ham']) && $CONFIG['report_spam_ham'] === TRUE ||
isset($CONFIG['message_flags']) && $CONFIG['message_flags'] === TRUE)
){
$out .= "<optgroup label=\"" . rcube_label("message_location") . "\">\r\n";
$out .= "<option value=0>" . rcube_label($attrib['noselection']) . "</option>\r\n";
}
// get mailbox list
$mbox_name = $IMAP->get_mailbox_name();
*/
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// index.php
//
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/*
if ($_action=='get')
include('program/steps/mail/get.inc');
// find me: report spam/ham
if ($_action=='moveto' && (trim($_POST['_target_mbox']) == -1 || trim($_POST['_target_mbox']) == -2))
include('program/steps/mail/report_spam_ham.inc');
*/
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// skins/default/templates/mail.html
//
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
/*
<roundcube:if condition="config:move_to_select == true" />
<roundcube:object name="mailboxlist" type="select" noSelection="moveto" maxlength="25" onchange="rcmail.command('moveto', this.options[this.selectedIndex].value)" class="mboxlist" />
<roundcube:endif />
*/
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// CODE starts here ...
//
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
if ($uid = get_input_value('_uid', RCUBE_INPUT_POST)){
$a_uid = explode(",",$uid);
$err_type = '';
if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -1){
$folder = $CONFIG['report_spam_folder'];
$ftp_folder = $CONFIG['report_spam_ftp_folder'];
}
else if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -2){
$folder = $CONFIG['report_ham_folder'];
$ftp_folder = $CONFIG['report_ham_ftp_folder'];
}
if(isset($CONFIG['report_spam_ham_ftp']) && $CONFIG['report_spam_ham_ftp'] === TRUE){
$conn_id = ftp_connect($CONFIG['ftp_server'], $CONFIG['ftp_port']);
$folder = $CONFIG['temp_dir'];
if(isset($CONFIG['ftp_passive_mode']) && $CONFIG['ftp_passive_mode'] === TRUE){
ftp_pasv ($conn_id , TRUE);
}
$login_result = ftp_login($conn_id, $CONFIG['ftp_user'], $CONFIG['ftp_pass']);
}
foreach($a_uid as $key => $uid){
if(isset($folder) && file_exists($folder)){
$file = str_makerand (16, 16, false, false, false) . ".eml";
while(file_exists($folder . $file)){
$file = str_makerand (16, 16, false, false, false) . ".eml";
}
$message = $IMAP->get_raw_body($uid);
if(!@file_put_contents($folder . $file ,$message)){
//failure
$err_type = 'error';
}
else{
if(isset($CONFIG['report_spam_ham_ftp']) && $CONFIG['report_spam_ham_ftp'] === TRUE){
if((!$conn_id) || (!$login_result)){
//failure
$err_type = 'error';
}
else{
//success
$ftp_file = $file;
while(ftp_size($conn_id, $ftp_folder.$ftp_file) > -1){
$ftp_file = str_makerand (16, 16, false, false, false) . ".eml";
}
$upload = ftp_put($conn_id, $ftp_folder.$ftp_file, $folder.$file, FTP_BINARY);
if(!$upload){
//failure
$err_type = 'error';
}
else{
//success
}
@unlink($folder.$ftp_file);
}
}
}
}
}
if($conn_id){
ftp_close($conn_id);
}
}
if($err_type == ""){
$message = rcube_label('message(s)_successfully_reported');
$err_type = 'confirmation';
}
else{
$message = rcube_label('there_was_an_error');
}
$OUTPUT->show_message($message, $err_type);
if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -1){
$_POST['_target_mbox'] = $CONFIG['junk_mbox'];
}
else if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -2){
$_POST['_target_mbox'] = "INBOX";
}
else{
$_POST['_target_mbox'] = $_POST['_mbox'];
}
?>
-
Please log your fix to bugtracker : http://trac.roundcube.net/newticket
-
I like this alot but I'm having trouble following your install file... what is the "code starts here..." supposed to be, and what am I supposed to do with the rest above that...? I'm lost,help please.
-
Create a new file: program/steps/mail/report_spam_ham.inc Paste everything in there. Then modify all files that are mentioned with the code segments below the file names.
-
YEP, follow luxerama's advice.
FYI, I will release a my RoundCube with a lot of additional AddOn's soon.
-Roland
-
Wouldnt it be great if you moved a message that it was automatically sent to either spam or ham based on move to spam or out of spam folder?
Is there a way in PHP to try if sa-learn command exists in eval or system mode?
program would be.
- test if config option is YES
- test if spamassasin installed
- test if sa-learn is available
- depending on move in or out marks as spam or ham
- pipe the email to sa-learn
-
Yes and No ... I like it to review things which are reported before adding it automatically.
I think your request could be done easily by a cron job or (WIN) scheduled task.
I come from Squirrelmail along with ArGoSoft backend and am in process to switch to RC/hMailServer. In my current setup I do it with a scheduled job.
-Roland
-
What about helping us develop the code below? that can later be added as plugin if they a hook is defined for it in the main program? Code is ment to be placed in the move_del.inc file (or later by hook) online 31, but I think that all the code is here to develop it stand-alone.
Please see all the todo;s below. Who can help?
# add to move_del.inv line 31
// ok: ['learn_spam'] is new config variable
// ok: For testing purposes add it to your main config file as
// $rcmail_config['learn_spam'] = TRUE;
if (isset($_CONFIG['junk_mbox']) && isset($_CONFIG['learn_spam']) &&
$_CONFIG['learn_spam'] === true)
{
// todo: Do I need to check other vars like SESSION to confirm current mbox?
$source = get_input_value('_mbox', RCUBE_INPUT_POST)
// todo: Do I need to take _mbox and $target mbox (already fetched in move_del) through checks?
// todo: Do I need to take _mbox and $target and formaat otherwise so they are comparable with config?
$b_type = NULL;
if ($target == $_CONFIG['junk_mbox'])
$s_type = 'spam';
else if ($source == $_CONFIG['junk_mbox'])
$s_type = 'ham';
$ret = system("which sa-learn", $retval);
// todo: Anymore checks to add?
if ($retval == 0 && file_exists($ret) && is_executable($ret) && !is_null($b_type))
{
// convert the list of uids to array
$a_uids = is_string($uids) ? explode(',', $uids) : (is_array($uids) ? $uids : NULL);
foreach ($a_uids as $uid)
{
// todo: Does this get the full e-mail, inlcuding headers?
// todo: The IMAP function is referenced, how to call correctly?
$src = $IMAP->get_raw_body($uid);
// todo: Can we fork this process? (Seeing we are looping)
// todo: How safe is this command and do we need to use escapeshellarg
// todo: Is this the way to feed the full message source to sa-learn?
$success = exec(escapeshellcmd(sprintf("sa-learn --%s %s", $s_type,$src)));
// todo: Do we need to log the feedback if log is yes?
}
} else {
// todo: Do we need to log the feedback if command not found and config set to YES?
}
}
-
If I understand your code structure right, you want to trigger mails to be learned as spam/ham if they are moved into spam folder ...
IMO you will mess your bayes DB.
In addition you plan to trigger to launch sa-learn every time a message is moved to junk folder ... ooouuucccchhhh ....
Is there a reason why you don't want to follow my approach just to copy the stuff into a specific folder to process it by some other stuff than the webmail suite?
-Roland
-
im unable to get this working.
i get a call to Fatal error: Call to a member function get_mailbox_name() on a non-object in /usr/local/web/roundcube/program/include/main.inc on line 1993
when i remove get_mailbox_name() from the file.. it does nothing except show the move to bar on every page.
-
Check this thread
http://www.roundcubeforum.net/showthread.php?t=2469
The plugin was coded for Release Canditate 2 ... it does not work with the stable releases.
-Roland
-
that only works for hm mail server... which is a free mail server for windows...
-
No, there are some plugins which work only along with hmailserver. hmailserver specific things are disabled if you use another MTA. So it works with all servers as default RoundCube does.
-Roland
-
Sorry to bump such an old thread. I just wanted to say I found this very useful, and also once you add this modification it's fairly simple to add Spam and Ham buttons to make the functionality more prominent.
skins/default/templates/mail.html
Find this:
<roundcube:button command="print" imageSel="/images/buttons/print_sel.png" imageAct="/images/buttons/print_act.png" imagePas="/images/buttons/print_pas.png" width="32" height="32" title="printmessage" />
Immediately after, add this:
program/js/app.js
Find this:
case 'checkmail':
this.check_for_recent();
break;
Immediately after, add this:
case 'spam':
this.move_messages('-1');
break;
case 'ham':
this.move_messages('-2');
break;
Find this:
else
{
this.enable_command('show', 'reply', 'reply-all', 'forward', 'print', selected);
this.enable_command('delete', 'moveto', 'mark', (list.selection.length > 0 ? true : false));
}
Immediately after, add this:
if (this.env.mailbox == this.env.junk_mailbox){
this.enable_command('spam', false);
this.enable_command('ham', (list.selection.length > 0 ? true : false));
} else {
this.enable_command('spam', (list.selection.length > 0 ? true : false));
this.enable_command('ham', false);
}
Here are the images I'm using for now:
http://mail.shroomery.org/skins/default/images/buttons/spam_sel.png
http://mail.shroomery.org/skins/default/images/buttons/spam_act.png
http://mail.shroomery.org/skins/default/images/buttons/spam_pas.png
http://mail.shroomery.org/skins/default/images/buttons/ham_sel.png
http://mail.shroomery.org/skins/default/images/buttons/ham_act.png
http://mail.shroomery.org/skins/default/images/buttons/ham_pas.png
Thanks again rosali for this great mod! :)
-
Hi Ythan,
I found some problems about this:
case 'spam':
this.move_messages('-1');
break;
case 'ham':
this.move_messages('-2');
break;
somehow it's strange to pass numbers to the function, I'm not sure if it will work for everyone, it should depend on how folders are configurated. At least in my case did not work, so I changed " '-1' " for "this.env.junk_mailbox". In the 'ham' case I haven't found the correct argument to pass.
Javi
-
No, it is correct. "-1" will copy message file to defined spam collecting folder (either by filesystem or by FTP) and it will move the message to users spam folder. "-2" moves message to inbox and will copy it to defined ham collecting folder.
NOTICE: This mod was designed for v1.0/1.1. I do not think it works with current v2 releases.
-Roland
-
Hi rosali,
yes it's correct, and it works!!!. It was my fault, I should have read all the thread. :$
I've modified the code because I didn't like the way it reported the spam/ham. Now if a mail was moved to spam/ham folder and then moved again to ham/spam, the first file created is deleted.
To do it, I need to name the file with an unique ID to have a reference, so I use the 'Message-ID' from the mail headers. I don't know if Message-ID is the same for every recipient when is sent to several ones or it changes, so I append the session user id to avoid duplicated file names.
function str_makerand ($minlength, $maxlength, $useupper, $usespecial, $usenumbers){
$key = '';
$charset = "abcdefghijklmnopqrstuvwxyz";
if ($useupper) $charset .= "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
if ($usenumbers) $charset .= "0123456789";
if ($usespecial) $charset .= "~@#$%^*()_+={}|]["; // Note: using all special characters this reads: "~!@#$%^&*()_+`-={}|\\]?[\":;'><,./";
if ($minlength > $maxlength) $length = mt_rand ($maxlength, $minlength);
else $length = mt_rand ($minlength, $maxlength);
for ($i=0; $i<$length; $i++) $key .= $charset[(mt_rand(0,(strlen($charset)-1)))];
return $key;
}
function create_file_name($message){
$temp = explode("\n",$message);
$str = '';
foreach ($temp as $lin){
if (eregi('message-id',$lin)){
$str = $lin;
break;
}
}
unset($temp);
$str = explode(':',$str);
$file = '';
if (sizeof($str)==2){ // Exepected 'Message-ID' format
$str = trim($str[1]);
$file = $str . '_' . $_SESSION['username'] . ".eml";
}
else{ // Line is not formed as expected, random string created
$file = str_makerand(20, 20, false, false, false) . ".eml";
}
return $file;
}
if ($uid = get_input_value('_uid', RCUBE_INPUT_POST)){
$a_uid = explode(",",$uid);
$folder = '';
$folder_del = '';
$file = '';
$err_type = '';
if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -1){
$folder = $CONFIG['report_spam_folder'];
$folder_del = $CONFIG['report_ham_folder'];
$ftp_folder = $CONFIG['report_spam_ftp_folder'];
}
else if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -2){
$folder = $CONFIG['report_ham_folder'];
$folder_del = $CONFIG['report_spam_folder'];
$ftp_folder = $CONFIG['report_ham_ftp_folder'];
}
if(isset($CONFIG['report_spam_ham_ftp']) && $CONFIG['report_spam_ham_ftp'] === TRUE){
$conn_id = ftp_connect($CONFIG['ftp_server'], $CONFIG['ftp_port']);
$folder = $CONFIG['temp_dir'];
if(isset($CONFIG['ftp_passive_mode']) && $CONFIG['ftp_passive_mode'] === TRUE){
ftp_pasv ($conn_id , TRUE);
}
$login_result = ftp_login($conn_id, $CONFIG['ftp_user'], $CONFIG['ftp_pass']);
}
foreach($a_uid as $key => $uid){
if(isset($folder) && file_exists($folder) && isset($folder_del) && file_exists($folder_del) ){
$message = $IMAP->get_raw_body($uid);
$file = create_file_name($message);
while(file_exists($folder . $file)){
$file = str_makerand (20, 20, false, true, false) . ".eml";
}
if(!@file_put_contents($folder . $file ,$message)){
//failure
$err_type = 'error';
}
else{
if(isset($CONFIG['report_spam_ham_ftp']) && $CONFIG['report_spam_ham_ftp'] === TRUE){
if((!$conn_id) || (!$login_result)){
//failure
$err_type = 'error';
}
else{
//success
$ftp_file = $file;
while(ftp_size($conn_id, $ftp_folder.$ftp_file) > -1){
$ftp_file = str_makerand (16, 16, false, false, false) . ".eml";
}
$upload = ftp_put($conn_id, $ftp_folder.$ftp_file, $folder.$file, FTP_BINARY);
if(!$upload){
//failure
$err_type = 'error';
}
else{
//success
}
@unlink($folder.$ftp_file);
}
}
}
}
// removes file if it exists in the other folder
if ( ($err_type == "") && !(isset($CONFIG['report_spam_ham_ftp']) && $CONFIG['report_spam_ham_ftp'] === TRUE)){
if (file_exists($folder_del . $file)){
unlink($folder_del . $file);
}
}
}
if($conn_id){
ftp_close($conn_id);
}
}
if($err_type == ""){
$message = rcube_label('message(s)_successfully_reported');
$err_type = 'confirmation';
}
else{
$message = rcube_label('there_was_an_error');
}
$OUTPUT->show_message($message, $err_type);
if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -1){
$_POST['_target_mbox'] = $CONFIG['junk_mbox'];
}
else if(get_input_value('_target_mbox', RCUBE_INPUT_POST) == -2){
$_POST['_target_mbox'] = "INBOX";
}
else{
$_POST['_target_mbox'] = $_POST['_mbox'];
}
* I'm not using ftp option so I've just implemented it for the folder case.
The report works when the message is moved using the options list or the buttons (by Ythan) but not when the mail is dragged with the cursor, it's something about javascript but I'm not very skilled at it.
Javi