1: <?php
  2: /**
  3:  * Copyright 2012-2014 Horde LLC (http://www.horde.org/)
  4:  *
  5:  * See the enclosed file COPYING for license information (GPL). If you
  6:  * did not receive this file, see http://www.horde.org/licenses/gpl.
  7:  *
  8:  * @category  Horde
  9:  * @copyright 2012-2014 Horde LLC
 10:  * @license   http://www.horde.org/licenses/gpl GPL
 11:  * @package   IMP
 12:  */
 13: 
 14: /**
 15:  * Shared code for handling special mailboxes preferences.
 16:  *
 17:  * @author    Michael Slusarz <slusarz@horde.org>
 18:  * @category  Horde
 19:  * @copyright 2012-2014 Horde LLC
 20:  * @license   http://www.horde.org/licenses/gpl GPL
 21:  * @package   IMP
 22:  */
 23: class IMP_Prefs_Special_SpecialMboxes
 24: {
 25:     const PREF_DEFAULT = "default\0";
 26:     const PREF_NO_MBOX = "nombox\0";
 27:     const PREF_SPECIALUSE = "specialuse\0";
 28: 
 29:     /**
 30:      * Cached mailbox list.
 31:      *
 32:      * @var array
 33:      */
 34:     protected $_cache = null;
 35: 
 36:     /**
 37:      * Update special mailbox preferences.
 38:      *
 39:      * @param string $pref             The pref name to update.
 40:      * @param IMP_Mailbox $form        The form data.
 41:      * @param string $new              The new mailbox name.
 42:      * @param string $type             Special use attribute (RFC 6154).
 43:      * @param Horde_Core_Prefs_Ui $ui  The UI object.
 44:      *
 45:      * @return boolean  True if preferences were updated.
 46:      */
 47:     protected function _updateSpecialMboxes($pref, $form, $new, $type,
 48:                                             Horde_Core_Prefs_Ui $ui)
 49:     {
 50:         global $injector, $prefs;
 51: 
 52:         $imp_imap = $injector->getInstance('IMP_Factory_Imap')->create();
 53: 
 54:         if (!$imp_imap->access(IMP_Imap::ACCESS_FOLDERS) ||
 55:             $prefs->isLocked($pref)) {
 56:             return false;
 57:         }
 58: 
 59:         $cache = $injector->getInstance('IMP_Mailbox_SessionCache');
 60:         if ($mbox_ob = IMP_Mailbox::getPref($pref)) {
 61:             $cache->expire(
 62:                 array(
 63:                     IMP_Mailbox_SessionCache::CACHE_DISPLAY,
 64:                     IMP_Mailbox_SessionCache::CACHE_LABEL,
 65:                     IMP_Mailbox_SessionCache::CACHE_SPECIALMBOXES
 66:                 ),
 67:                 $mbox_ob
 68:             );
 69:         }
 70: 
 71:         if ($form == self::PREF_NO_MBOX) {
 72:             return $prefs->setValue($pref, '');
 73:         }
 74: 
 75:         if (strpos($form, self::PREF_SPECIALUSE) === 0) {
 76:             $mbox = IMP_Mailbox::get(substr($form, strlen(self::PREF_SPECIALUSE)));
 77:         } elseif (!empty($new)) {
 78:             $mbox = IMP_Mailbox::get($new)->namespace_append;
 79: 
 80:             $opts = is_null($type)
 81:                 ? array()
 82:                 : array('special_use' => array($type));
 83: 
 84:             if (!$mbox->create($opts)) {
 85:                 $mbox = null;
 86:             }
 87:         } else {
 88:             $mbox = $form;
 89:         }
 90: 
 91:         if (!$mbox) {
 92:             return false;
 93:         }
 94: 
 95:         $cache->expire(
 96:             array(
 97:                 IMP_Mailbox_SessionCache::CACHE_DISPLAY,
 98:                 IMP_Mailbox_SessionCache::CACHE_LABEL
 99:             ),
100:             $mbox
101:         );
102: 
103:         return $prefs->setValue($pref, $mbox->pref_to);
104:     }
105: 
106:     /**
107:      * Get the list of special use mailboxes of a certain type.
108:      *
109:      * @param string $use  The special-use flag.
110:      *
111:      * @return string  HTML code.
112:      */
113:     protected function _getSpecialUse($use)
114:     {
115:         global $injector;
116: 
117:         if (is_null($this->_cache)) {
118:             $this->_cache = $injector->getInstance('IMP_Factory_Imap')->create()->listMailboxes('*', Horde_Imap_Client::MBOX_ALL, array(
119:                 'attributes' => true,
120:                 'special_use' => true,
121:                 'sort' => true
122:             ));
123:         }
124: 
125:         $special_use = array();
126:         /* $val['attributes'] is normalized to lowercase. */
127:         $use = Horde_String::lower($use);
128: 
129:         foreach ($this->_cache as $val) {
130:             if (in_array($use, $val['attributes'])) {
131:                 $mbox_ob = IMP_Mailbox::get($val['mailbox']);
132:                 $special_use[] = array(
133:                     'l' => $mbox_ob->label,
134:                     'v' => IMP_Mailbox::formTo(self::PREF_SPECIALUSE . $mbox_ob)
135:                 );
136:             }
137:         }
138: 
139:         if (empty($special_use)) {
140:             return '';
141:         }
142: 
143:         $view = new Horde_View(array(
144:             'templatePath' => IMP_TEMPLATES . '/prefs'
145:         ));
146:         $view->addHelper('Text');
147: 
148:         $view->special_use = $special_use;
149: 
150:         return $view->render('specialuse');
151:     }
152: 
153: }
154: