1: <?php
  2: /**
  3:  * Login tasks module that renames sent-mail mailboxes every month.
  4:  *
  5:  * Copyright 2001-2012 Horde LLC (http://www.horde.org/)
  6:  *
  7:  * See the enclosed file COPYING for license information (GPL). If you
  8:  * did not receive this file, see http://www.horde.org/licenses/gpl.
  9:  *
 10:  * @author   Michael Slusarz <slusarz@horde.org>
 11:  * @category Horde
 12:  * @license  http://www.horde.org/licenses/gpl GPL
 13:  * @package  IMP
 14:  */
 15: class IMP_LoginTasks_Task_RenameSentmailMonthly extends Horde_LoginTasks_Task
 16: {
 17:     /**
 18:      * Constructor.
 19:      */
 20:     public function __construct()
 21:     {
 22:         $this->active = $GLOBALS['prefs']->getValue('rename_sentmail_monthly');
 23:         if ($this->active &&
 24:             $GLOBALS['prefs']->isLocked('rename_sentmail_monthly')) {
 25:             $this->display = Horde_LoginTasks::DISPLAY_NONE;
 26:         }
 27:     }
 28: 
 29:     /**
 30:      * Renames the old sent-mail mailboxes.
 31:      *
 32:      * Folder name: sent-mail-month-year
 33:      *   month = English:         3 letter abbreviation
 34:      *           Other Languages: Month value (01-12)
 35:      *   year  = 4 digit year
 36:      *
 37:      * The mailbox name needs to be in this specific format (as opposed to a
 38:      * user-defined one) to ensure that 'delete_sentmail_monthly' processing
 39:      * can accurately find all the old sent-mail mailboxes.
 40:      *
 41:      * @return boolean  Whether all sent-mail mailboxes were renamed.
 42:      */
 43:     public function execute()
 44:     {
 45:         global $injector, $notification;
 46: 
 47:         $date_format = (substr($GLOBALS['language'], 0, 2) == 'en')
 48:             ? 'M-Y'
 49:             : 'm-Y';
 50: 
 51:         $datetime = new DateTime();
 52:         $now = $datetime->format($date_format);
 53: 
 54:         $imp_imap = $injector->getInstance('IMP_Factory_Imap')->create();
 55: 
 56:         foreach ($this->_getSentmail() as $sent) {
 57:             /* Display a message to the user and rename the mailbox.
 58:              * Only do this if sent-mail mailbox currently exists. */
 59:             if ($sent->exists) {
 60:                 $notification->push(sprintf(_("%s mailbox being renamed at the start of the month."), $sent->display), 'horde.message');
 61: 
 62:                 $query = new Horde_Imap_Client_Fetch_Query();
 63:                 $query->imapDate();
 64:                 $query->uid();
 65: 
 66:                 $res = $imp_imap->fetch($sent, $query);
 67: 
 68:                 $msgs = array();
 69:                 foreach ($res as $val) {
 70:                     $date_string = $val->getImapDate()->format($date_format);
 71:                     if (!isset($msgs[$date_string])) {
 72:                         $msgs[$date_string] = $imp_imap->getIdsOb();
 73:                     }
 74:                     $msgs[$date_string]->add($val->getUid());
 75:                 }
 76: 
 77:                 unset($msgs[$now]);
 78:                 foreach ($msgs as $key => $val) {
 79:                     $new_mbox = IMP_Mailbox::get(strval($sent) . '-' . Horde_String::convertCharset(Horde_String::lower($key), 'UTF-8', 'UTF7-IMAP'));
 80: 
 81:                     $imp_imap->copy($sent, $new_mbox, array(
 82:                         'create' => true,
 83:                         'ids' => $val,
 84:                         'move' => true
 85:                     ));
 86:                 }
 87:             }
 88:         }
 89: 
 90:         return true;
 91:     }
 92: 
 93:     /**
 94:      * Returns information for the login task.
 95:      *
 96:      * @return string  Description of what the operation is going to do during
 97:      *                 this login.
 98:      */
 99:     public function describe()
100:     {
101:         $mbox_list = array();
102: 
103:         foreach ($this->_getSentmail() as $mbox) {
104:             $mbox_list[] = $mbox->display_html;
105:         }
106: 
107:         return sprintf(_("The current sent-mail mailbox(es) \"%s\" will be renamed."), implode(', ', $mbox_list));
108:     }
109: 
110:     /**
111:      * Returns the list of sent-mail mailboxes.
112:      *
113:      * @return array  All sent-mail mailboxes (IMP_Mailbox objects).
114:      */
115:     protected function _getSentmail()
116:     {
117:         return IMP_Mailbox::get($GLOBALS['injector']->getInstance('IMP_Identity')->getAllSentmailfolders());
118:     }
119: 
120: }
121: