1: <?php
 2: /**
 3:  * Login tasks module that purges old messages in the Spam folder.  Based on
 4:  * the purge_trash task, written by Michael Slusarz <slusarz@horde.org>.
 5:  *
 6:  * Copyright 2006-2012 Horde LLC (http://www.horde.org/)
 7:  *
 8:  * See the enclosed file COPYING for license information (GPL). If you
 9:  * did not receive this file, see http://www.horde.org/licenses/gpl.
10:  *
11:  * @author   Matt Selsky <selsky@columbia.edu>
12:  * @category Horde
13:  * @license  http://www.horde.org/licenses/gpl GPL
14:  * @package  IMP
15:  */
16: class IMP_LoginTasks_Task_PurgeSpam extends Horde_LoginTasks_Task
17: {
18:     /**
19:      * Constructor.
20:      */
21:     public function __construct()
22:     {
23:         if ($this->interval = $GLOBALS['prefs']->getValue('purge_spam_interval')) {
24:             if ($GLOBALS['prefs']->isLocked('purge_spam_interval')) {
25:                 $this->display = Horde_LoginTasks::DISPLAY_NONE;
26:             }
27:         } else {
28:             $this->active = false;
29:         }
30:     }
31: 
32:     /**
33:      * Purge old messages in the Spam folder.
34:      *
35:      * @return boolean  Whether any messages were purged from the Spam folder.
36:      */
37:     public function execute()
38:     {
39:         /* If there is no Spam folder set, or it doesn't exist, exit. */
40:         if (!($spam_folder = IMP_Mailbox::getPref('spam_folder')) ||
41:             !$spam_folder->exists) {
42:             return false;
43:         }
44: 
45:         /* Get the current UNIX timestamp minus the number of days
46:            specified in 'purge_spam_keep'.  If a message has a
47:            timestamp prior to this value, it will be deleted. */
48:         $del_time = new Horde_Date(time() - ($GLOBALS['prefs']->getValue('purge_spam_keep') * 86400));
49: 
50:         /* Get the list of messages older than 'purge_spam_keep' days. */
51:         $query = new Horde_Imap_Client_Search_Query();
52:         $query->dateSearch($del_time, Horde_Imap_Client_Search_Query::DATE_BEFORE);
53:         $msg_ids = $spam_folder->runSearchQuery($query);
54: 
55:         /* Go through the message list and delete the messages. */
56:         if ($GLOBALS['injector']->getInstance('IMP_Message')->delete($msg_ids, array('nuke' => true))) {
57:             $msgcount = count($msg_ids);
58:             $GLOBALS['notification']->push(sprintf(ngettext("Purging %d message from Spam folder.", "Purging %d messages from Spam folder.", $msgcount), $msgcount), 'horde.message');
59:             return true;
60:         }
61: 
62:         return false;
63:     }
64: 
65:     /**
66:      * Return information for the login task.
67:      *
68:      * @return string  Description of what the operation is going to do during
69:      *                 this login.
70:      */
71:     public function describe()
72:     {
73:         return sprintf(_("All messages in your \"%s\" folder older than %s days will be permanently deleted."),
74:                        IMP_Mailbox::getPref('spam_folder')->display_html,
75:                        $GLOBALS['prefs']->getValue('purge_spam_keep'));
76:     }
77: 
78: }
79: