Menu
▾
▴
[SM-CVS] CVS: squirrelmail/plugins/spamcop functions.php,NONE,1.1 README,1.4,1.5 index.php,1.8,1.9 options.php,1.32,1.33 setup.php,1.26,1.27 spamcop.php,1.34,1.35
|
From: Tomas K. <to...@us...> - 2005-07-14 14:55:08
|
Update of /cvsroot/squirrelmail/squirrelmail/plugins/spamcop In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv20624 Modified Files: README index.php options.php setup.php spamcop.php Added Files: functions.php Log Message: reduced setup.php size. added checks for disabled plugin in spamcop.php. listed used hooks and pref keys in README --- NEW FILE --- <?php /** * SpamCop plugin - functions * * @copyright (c) 1999-2005 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id: functions.php,v 1.1 2005/07/14 14:54:56 tokul Exp $ * @package plugins * @subpackage spamcop */ /* sqgetGlobalVar(), getPref(), setPref(), sqimap functions are used */ /** * Disable Quick Reporting by default * @global boolean $spamcop_quick_report * @since 1.4.3 and 1.5.0 */ global $spamcop_quick_report; $spamcop_quick_report = false; /** * Loads spamcop settings and validates some of values (make '' into 'default', etc.) * * Internal function used to reduce size of setup.php * @since 1.5.1 * @access private */ function spamcop_load_function() { global $username, $data_dir, $spamcop_enabled, $spamcop_delete, $spamcop_save, $spamcop_method, $spamcop_id, $spamcop_quick_report, $spamcop_type; $spamcop_enabled = getPref($data_dir, $username, 'spamcop_enabled'); $spamcop_delete = getPref($data_dir, $username, 'spamcop_delete'); $spamcop_save = getPref($data_dir, $username, 'spamcop_save',true); $spamcop_method = getPref($data_dir, $username, 'spamcop_method'); $spamcop_type = getPref($data_dir, $username, 'spamcop_type'); $spamcop_id = getPref($data_dir, $username, 'spamcop_id'); if ($spamcop_method == '') { // Default to web_form. It is faster. $spamcop_method = 'web_form'; setPref($data_dir, $username, 'spamcop_method', $spamcop_method); } if (! $spamcop_quick_report && $spamcop_method=='quick_email') { $spamcop_method = 'web_form'; setPref($data_dir, $username, 'spamcop_method', $spamcop_method); } if ($spamcop_type == '') { $spamcop_type = 'free'; setPref($data_dir, $username, 'spamcop_type', $spamcop_type); } if ($spamcop_id == '') $spamcop_enabled = 0; } /** * Add spamcop link to read_body (internal function) * @since 1.5.1 * @access private */ function spamcop_show_link_function() { global $spamcop_enabled, $spamcop_method, $spamcop_quick_report,$javascript_on; if (! $spamcop_enabled) return; /* GLOBALS */ sqgetGlobalVar('passed_id', $passed_id, SQ_FORM); sqgetGlobalVar('passed_ent_id',$passed_ent_id,SQ_FORM); sqgetGlobalVar('mailbox', $mailbox, SQ_FORM); if ( sqgetGlobalVar('startMessage', $startMessage, SQ_FORM) ) { $startMessage = (int)$startMessage; } /* END GLOBALS */ // catch unset passed_ent_id if (! sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM) ) { $passed_ent_id = 0; } echo "<br />\n"; /* Catch situation when user uses quick_email and does not update preferences. User gets web_form link. If prefs are set to quick_email format - they will be updated after clicking the link */ if (! $spamcop_quick_report && $spamcop_method=='quick_email') { $spamcop_method = 'web_form'; } // Javascript is used only in web based reporting // don't insert javascript if javascript is disabled if ($spamcop_method == 'web_form' && $javascript_on) { ?><script language="javascript" type="text/javascript"> document.write('<a href="../plugins/spamcop/spamcop.php?passed_id=<?php echo urlencode($passed_id); ?>&js_web=1&mailbox=<?php echo urlencode($mailbox); ?>&passed_ent_id=<?php echo urlencode($passed_ent_id); ?>" target="_blank">'); document.write("<?php echo _("Report as Spam"); ?>"); document.write("</a>"); </script><?php } else { ?><a href="../plugins/spamcop/spamcop.php?passed_id=<?php echo urlencode($passed_id); ?>&mailbox=<?php echo urlencode($mailbox); ?>&startMessage=<?php echo urlencode($startMessage); ?>&passed_ent_id=<?php echo urlencode($passed_ent_id); ?>"> <?php echo _("Report as Spam"); ?></a> <?php } } /** * Add spamcop option block (internal function) * @since 1.5.1 * @access private */ function spamcop_options_function() { global $optpage_blocks; $optpage_blocks[] = array( 'name' => _("SpamCop - Spam Reporting"), 'url' => '../plugins/spamcop/options.php', 'desc' => _("Help fight the battle against unsolicited email. SpamCop reads the spam email and determines the correct addresses to send complaints to. Quite fast, really smart, and easy to use."), 'js' => false ); } /** * Process messages that are submitted by email. * * Delete spam if user wants to delete it. Don't save submitted emails. * Implement overrides that fix compose.php behavior. * @since 1.5.1 * @access private */ function spamcop_while_sending_function() { global $mailbox, $spamcop_delete, $spamcop_save, $spamcop_is_composing, $auto_expunge, $username, $key, $imapServerAddress, $imapPort; if (sqgetGlobalVar('spamcop_is_composing' , $spamcop_is_composing)) { // delete spam message if ($spamcop_delete) { $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0); sqimap_mailbox_select($imapConnection, $mailbox); sqimap_msgs_list_delete($imapConnection, $mailbox, array($spamcop_is_composing)); if ($auto_expunge) sqimap_mailbox_expunge($imapConnection, $mailbox, true); } if (! $spamcop_save) { // disable use of send folder. // Temporally override in order to disable saving of 'reply anyway' messages. global $default_move_to_sent; $default_move_to_sent=false; } // change default email composition setting. Plugin always operates in right frame. // make sure that compose.php redirects to right page. Temporally override. global $compose_new_win; $compose_new_win = false; } } /** * Internal spamcop plugin function. * * It is used to display similar action links. * @access private */ function spamcop_enable_disable($option,$disable_action,$enable_action) { if ($option) { $ret= _("Enabled") . " (<a href=\"options.php?action=$disable_action\">" . _("Disable it") . "</a>)\n"; } else { $ret = _("Disabled") . " (<a href=\"options.php?action=$enable_action\">" . _("Enable it") . "</a>)\n"; } return $ret; } /** * Stores message in attachment directory, when email based reports are used * @access private */ function getMessage_RFC822_Attachment($message, $composeMessage, $passed_id, $passed_ent_id='', $imapConnection) { global $attachment_dir, $username; $hashed_attachment_dir = getHashedDir($username, $attachment_dir); if (!$passed_ent_id) { $body_a = sqimap_run_command($imapConnection, 'FETCH '.$passed_id.' RFC822', TRUE, $response, $readmessage, TRUE); } else { $body_a = sqimap_run_command($imapConnection, 'FETCH '.$passed_id.' BODY['.$passed_ent_id.']', TRUE, $response, $readmessage,TRUE); $message = $message->parent; } if ($response == 'OK') { array_shift($body_a); $body = implode('', $body_a) . "\r\n"; $localfilename = GenerateRandomString(32, 'FILE', 7); $full_localfilename = "$hashed_attachment_dir/$localfilename"; $fp = fopen( $full_localfilename, 'w'); fwrite ($fp, $body); fclose($fp); /* dirty relative dir fix */ if (substr($attachment_dir,0,3) == '../') { $attachment_dir = substr($attachment_dir,3); $hashed_attachment_dir = getHashedDir($username, $attachment_dir); } $full_localfilename = "$hashed_attachment_dir/$localfilename"; $composeMessage->initAttachment('message/rfc822','email.txt', $full_localfilename); } return $composeMessage; } ?> Index: README =================================================================== RCS file: /cvsroot/squirrelmail/squirrelmail/plugins/spamcop/README,v retrieving revision 1.4 retrieving revision 1.5 diff -u -w -r1.4 -r1.5 --- README 28 Feb 2005 10:45:56 -0000 1.4 +++ README 14 Jul 2005 14:54:56 -0000 1.5 @@ -26,9 +26,6 @@ forwarder to sign up for SpamCop and get the required information for the plugin. -This plugin is also an example of how to use the identity hooks. Just open -up setup.php and read the comments. - Installation ============ @@ -36,3 +33,19 @@ Go back to the main directory, run configure and add the plugin. +API +=== + +SquirrelMail hooks used by plugin: +* loading_prefs +* optpage_register_block +* read_body_header_right +* compose_send + +Plugin preference keys: +* spamcop_enabled +* spamcop_delete +* spamcop_save +* spamcop_method +* spamcop_type +* spamcop_id Index: index.php =================================================================== RCS file: /cvsroot/squirrelmail/squirrelmail/plugins/spamcop/index.php,v retrieving revision 1.8 retrieving revision 1.9 diff -u -w -r1.8 -r1.9 --- index.php 27 Feb 2005 23:36:08 -0000 1.8 +++ index.php 14 Jul 2005 14:54:57 -0000 1.9 @@ -11,7 +11,6 @@ * @subpackage spamcop */ - header("Location:../../src/login.php\n\n"); +header("Location:../../index.php\n\n"); exit(); - ?> \ No newline at end of file Index: options.php =================================================================== RCS file: /cvsroot/squirrelmail/squirrelmail/plugins/spamcop/options.php,v retrieving revision 1.32 retrieving revision 1.33 diff -u -w -r1.32 -r1.33 --- options.php 13 Jul 2005 13:50:51 -0000 1.32 +++ options.php 14 Jul 2005 14:54:57 -0000 1.33 @@ -12,25 +12,16 @@ /** @ignore */ define('SM_PATH','../../'); +/* SquirrelMail functions */ require_once(SM_PATH . 'include/validate.php'); - -/** - * Internal spamcop plugin function. - * - * It is used to display similar action links. - * @access private - */ -function spamcop_enable_disable($option,$disable_action,$enable_action) { - if ($option) { - $ret= _("Enabled") . " (<a href=\"options.php?action=$disable_action\">" . _("Disable it") . "</a>)\n"; - } else { - $ret = _("Disabled") . " (<a href=\"options.php?action=$enable_action\">" . _("Enable it") . "</a>)\n"; - } - return $ret; -} +/* plugin functions */ +include_once(SM_PATH . 'plugins/spamcop/functions.php'); displayPageHeader($color, 'None'); +/** is spamcop plugin disabled */ +// option changes do nothing, if read_body_header_right hook is not active. + /* globals */ sqgetGlobalVar('action', $action); sqgetGlobalVar('meth', $meth); @@ -82,7 +73,7 @@ } global $spamcop_enabled, $spamcop_delete, $spamcop_save, $spamcop_quick_report; -spamcop_load(); +spamcop_load_function(); ?> <br /> Index: setup.php =================================================================== RCS file: /cvsroot/squirrelmail/squirrelmail/plugins/spamcop/setup.php,v retrieving revision 1.26 retrieving revision 1.27 diff -u -w -r1.26 -r1.27 --- setup.php 13 Jul 2005 13:50:51 -0000 1.26 +++ setup.php 14 Jul 2005 14:54:57 -0000 1.27 @@ -9,10 +9,6 @@ * @subpackage spamcop */ -/** Disable Quick Reporting by default */ -global $spamcop_quick_report; -$spamcop_quick_report = false; - /** * Initialize the plugin * @access private @@ -30,36 +26,13 @@ 'spamcop_while_sending'; } - /** * Loads spamcop settings and validates some of values (make '' into 'default', etc.) * @access private */ function spamcop_load() { - global $username, $data_dir, $spamcop_enabled, $spamcop_delete, $spamcop_save, - $spamcop_method, $spamcop_id, $spamcop_quick_report, $spamcop_type; - - $spamcop_enabled = getPref($data_dir, $username, 'spamcop_enabled'); - $spamcop_delete = getPref($data_dir, $username, 'spamcop_delete'); - $spamcop_save = getPref($data_dir, $username, 'spamcop_save',true); - $spamcop_method = getPref($data_dir, $username, 'spamcop_method'); - $spamcop_type = getPref($data_dir, $username, 'spamcop_type'); - $spamcop_id = getPref($data_dir, $username, 'spamcop_id'); - if ($spamcop_method == '') { - // Default to web_form. It is faster. - $spamcop_method = 'web_form'; - setPref($data_dir, $username, 'spamcop_method', $spamcop_method); - } - if (! $spamcop_quick_report && $spamcop_method=='quick_email') { - $spamcop_method = 'web_form'; - setPref($data_dir, $username, 'spamcop_method', $spamcop_method); - } - if ($spamcop_type == '') { - $spamcop_type = 'free'; - setPref($data_dir, $username, 'spamcop_type', $spamcop_type); - } - if ($spamcop_id == '') - $spamcop_enabled = 0; + include_once(SM_PATH . 'plugins/spamcop/functions.php'); + spamcop_load_function(); } @@ -68,49 +41,8 @@ * @access private */ function spamcop_show_link() { - global $spamcop_enabled, $spamcop_method, $spamcop_quick_report,$javascript_on; - - if (! $spamcop_enabled) - return; - - /* GLOBALS */ - sqgetGlobalVar('passed_id', $passed_id, SQ_FORM); - sqgetGlobalVar('passed_ent_id',$passed_ent_id,SQ_FORM); - sqgetGlobalVar('mailbox', $mailbox, SQ_FORM); - if ( sqgetGlobalVar('startMessage', $startMessage, SQ_FORM) ) { - $startMessage = (int)$startMessage; - } - /* END GLOBALS */ - - // catch unset passed_ent_id - if (! sqgetGlobalVar('passed_ent_id', $passed_ent_id, SQ_FORM) ) { - $passed_ent_id = 0; - } - - echo "<br />\n"; - - /* - Catch situation when user uses quick_email and does not update - preferences. User gets web_form link. If prefs are set to - quick_email format - they will be updated after clicking the link - */ - if (! $spamcop_quick_report && $spamcop_method=='quick_email') { - $spamcop_method = 'web_form'; - } - - // Javascript is used only in web based reporting - // don't insert javascript if javascript is disabled - if ($spamcop_method == 'web_form' && $javascript_on) { -?><script language="javascript" type="text/javascript"> -document.write('<a href="../plugins/spamcop/spamcop.php?passed_id=<?php echo urlencode($passed_id); ?>&js_web=1&mailbox=<?php echo urlencode($mailbox); ?>&passed_ent_id=<?php echo urlencode($passed_ent_id); ?>" target="_blank">'); -document.write("<?php echo _("Report as Spam"); ?>"); -document.write("</a>"); -</script><?php - } else { -?><a href="../plugins/spamcop/spamcop.php?passed_id=<?php echo urlencode($passed_id); ?>&mailbox=<?php echo urlencode($mailbox); ?>&startMessage=<?php echo urlencode($startMessage); ?>&passed_ent_id=<?php echo urlencode($passed_ent_id); ?>"> -<?php echo _("Report as Spam"); ?></a> -<?php - } + include_once(SM_PATH . 'plugins/spamcop/functions.php'); + spamcop_show_link_function(); } /** @@ -118,45 +50,17 @@ * @access private */ function spamcop_options() { - global $optpage_blocks; - - $optpage_blocks[] = array( - 'name' => _("SpamCop - Spam Reporting"), - 'url' => '../plugins/spamcop/options.php', - 'desc' => _("Help fight the battle against unsolicited email. SpamCop reads the spam email and determines the correct addresses to send complaints to. Quite fast, really smart, and easy to use."), - 'js' => false - ); + include_once(SM_PATH . 'plugins/spamcop/functions.php'); + spamcop_options_function(); } /** - * When we send the email, we optionally trash it then too + * Process messages submitted by email * @access private */ function spamcop_while_sending() { - global $mailbox, $spamcop_delete, $spamcop_save, $spamcop_is_composing, $auto_expunge, - $username, $key, $imapServerAddress, $imapPort; - - if (sqgetGlobalVar('spamcop_is_composing' , $spamcop_is_composing)) { - // delete spam message - if ($spamcop_delete) { - $imapConnection = sqimap_login($username, $key, $imapServerAddress, - $imapPort, 0); - sqimap_mailbox_select($imapConnection, $mailbox); - sqimap_msgs_list_delete($imapConnection, $mailbox, array($spamcop_is_composing)); - if ($auto_expunge) - sqimap_mailbox_expunge($imapConnection, $mailbox, true); - } - if (! $spamcop_save) { - // disable use of send folder. - // Temporally override in order to disable saving of 'reply anyway' messages. - global $default_move_to_sent; - $default_move_to_sent=false; - } - // change default email composition setting. Plugin always operates in right frame. - // make sure that compose.php redirects to right page. Temporally override. - global $compose_new_win; - $compose_new_win = false; - } + include_once(SM_PATH . 'plugins/spamcop/functions.php'); + spamcop_while_sending_function(); } ?> \ No newline at end of file Index: spamcop.php =================================================================== RCS file: /cvsroot/squirrelmail/squirrelmail/plugins/spamcop/spamcop.php,v retrieving revision 1.34 retrieving revision 1.35 diff -u -w -r1.34 -r1.35 --- spamcop.php 27 Feb 2005 23:36:08 -0000 1.34 +++ spamcop.php 14 Jul 2005 14:54:57 -0000 1.35 @@ -14,51 +14,10 @@ /* SquirrelMail required files. */ require_once(SM_PATH . 'include/validate.php'); -require_once(SM_PATH . 'functions/imap.php'); - -/** - * Stores message in attachment directory, when email based reports are used - * @access private - */ -function getMessage_RFC822_Attachment($message, $composeMessage, $passed_id, - $passed_ent_id='', $imapConnection) { - global $attachment_dir, $username; - - $hashed_attachment_dir = getHashedDir($username, $attachment_dir); - if (!$passed_ent_id) { - $body_a = sqimap_run_command($imapConnection, - 'FETCH '.$passed_id.' RFC822', - TRUE, $response, $readmessage, - TRUE); - } else { - $body_a = sqimap_run_command($imapConnection, - 'FETCH '.$passed_id.' BODY['.$passed_ent_id.']', - TRUE, $response, $readmessage,TRUE); - $message = $message->parent; - } - if ($response == 'OK') { - array_shift($body_a); - $body = implode('', $body_a) . "\r\n"; - - $localfilename = GenerateRandomString(32, 'FILE', 7); - $full_localfilename = "$hashed_attachment_dir/$localfilename"; - $fp = fopen( $full_localfilename, 'w'); - fwrite ($fp, $body); - fclose($fp); - - /* dirty relative dir fix */ - if (substr($attachment_dir,0,3) == '../') { - $attachment_dir = substr($attachment_dir,3); - $hashed_attachment_dir = getHashedDir($username, $attachment_dir); - } - $full_localfilename = "$hashed_attachment_dir/$localfilename"; - - $composeMessage->initAttachment('message/rfc822','email.txt', - $full_localfilename); - } - return $composeMessage; -} - +include_once(SM_PATH . 'functions/display_messages.php'); +include_once(SM_PATH . 'functions/imap.php'); +/* plugin functions */ +include_once(SM_PATH . 'plugins/spamcop/functions.php'); /* GLOBALS */ @@ -97,6 +56,13 @@ displayPageHeader($color,$mailbox); } +/** is spamcop plugin disabled */ +if (! is_plugin_enabled('spamcop')) { + error_box(_("Plugin is disabled."),$color); + echo "\n</body></html>\n"; + exit(); +} + $imap_stream = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0); sqimap_mailbox_select($imap_stream, $mailbox); |