1: <?php
  2: /**
  3:  * Copyright 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 2014 Horde LLC
 10:  * @license   http://www.horde.org/licenses/gpl GPL
 11:  * @package   IMP
 12:  */
 13: 
 14: /**
 15:  * This object manages IMP_Mailbox cache data that is stored in the session.
 16:  *
 17:  * @author    Michael Slusarz <slusarz@horde.org>
 18:  * @category  Horde
 19:  * @copyright 2014 Horde LLC
 20:  * @license   http://www.horde.org/licenses/gpl GPL
 21:  * @package   IMP
 22:  *
 23:  * @property-read boolean $changed  Has the internal object storage changed?
 24:  */
 25: class IMP_Mailbox_SessionCache implements Serializable
 26: {
 27:     /** Changed constants. */
 28:     const CHANGED_NO = 0;
 29:     const CHANGED_YES = 1;
 30: 
 31:     /** Cache identifiers. */
 32:     const CACHE_ACL = 'a'; // (array) ACL rights
 33:     const CACHE_DISPLAY = 'd'; // (string) Display string
 34:     const CACHE_ICONS = 'i'; // (array) Icons array
 35:     const CACHE_LABEL = 'l'; // (string) Label string
 36:     const CACHE_UIDVALIDITY = 'v'; // (integer) UIDVALIDITY
 37: 
 38:     /** Cache identifiers - temporary data. */
 39:     const CACHE_EXISTS = 'e';
 40:     const CACHE_ICONHOOK = 'ic';
 41:     const CACHE_PREFTO = 'pt';
 42:     const CACHE_SPECIALMBOXES = 's';
 43: 
 44:     /**
 45:      * Cached data.
 46:      *
 47:      * @var array
 48:      */
 49:     protected $_cache = array();
 50: 
 51:     /**
 52:      * Has this object changed?
 53:      *
 54:      * @var integer
 55:      */
 56:     protected $_changed = self::CHANGED_NO;
 57: 
 58:     /**
 59:      * Temporary (access-only) cached data.
 60:      *
 61:      * @var array
 62:      */
 63:     protected $_temp = array();
 64: 
 65:     /**
 66:      */
 67:     public function __get($name)
 68:     {
 69:         switch ($name) {
 70:         case 'changed':
 71:             return $this->_changed;
 72:         }
 73:     }
 74: 
 75:     /**
 76:      * Get ACL data.
 77:      *
 78:      * @param string $mbox  Mailbox.
 79:      *
 80:      * @return mixed  A Horde_Imap_Client_Data_Acl object, null if no ACL
 81:      *                data, or false if not set.
 82:      */
 83:     public function getAcl($mbox)
 84:     {
 85:         if (!isset($this->_cache[$mbox]) ||
 86:             !array_key_exists(self::CACHE_ACL, $this->_cache[$mbox])) {
 87:             return false;
 88:         }
 89: 
 90:         return is_null($this->_cache[$mbox][self::CACHE_ACL])
 91:             ? null
 92:             : new Horde_Imap_Client_Data_Acl($this->_cache[$mbox][self::CACHE_ACL]);
 93:     }
 94: 
 95:     /**
 96:      * Set ACL data.
 97:      *
 98:      * @param string $mbox  Mailbox.
 99:      * @param mixed $acl    Horde_Imap_Client_Data_Acl object, or null.
100:      */
101:     public function setAcl($mbox, $acl)
102:     {
103:         /* Store string representation of ACL for a more compact
104:          * serialized format. */
105:         $this->_cache[$mbox][self::CACHE_ACL] = is_null($acl)
106:             ? $acl
107:             : strval($acl);
108:         $this->_changed = self::CHANGED_YES;
109:     }
110: 
111:     /**
112:      * Get the mailbox label.
113:      *
114:      * @param string $mbox  Mailbox.
115:      *
116:      * @return mixed  Mailbox label, or false if not set.
117:      */
118:     public function getLabel($mbox)
119:     {
120:         if (!isset($this->_cache[$mbox][self::CACHE_LABEL])) {
121:             return false;
122:         }
123: 
124:         return ($this->_cache[$mbox][self::CACHE_LABEL] === true)
125:             ? $this->_cache[$mbox][self::CACHE_DISPLAY]
126:             : $this->_cache[$mbox][self::CACHE_LABEL];
127:     }
128: 
129:     /**
130:      * Set the mailbox label.
131:      *
132:      * @param string $mbox   Mailbox.
133:      * @param string $label  Label.
134:      */
135:     public function setLabel($mbox, $label)
136:     {
137:         $this->_cache[$mbox][self::CACHE_LABEL] = (isset($this->_cache[$mbox][self::CACHE_DISPLAY]) && ($this->_cache[$mbox][self::CACHE_DISPLAY] == $label))
138:             ? true
139:             : $label;
140:         $this->_changed = self::CHANGED_YES;
141:     }
142: 
143:     /**
144:      * Preference storage name.
145:      *
146:      * @param string $mbox  Mailbox.
147:      *
148:      * @return mixed  Preference string, or false if not set.
149:      */
150:     public function getPrefTo($mbox)
151:     {
152:         return isset($this->_temp[$mbox][self::CACHE_PREFTO])
153:             ? $this->_temp[$mbox][self::CACHE_PREFTO]
154:             : false;
155:     }
156: 
157:     /**
158:      * Set the preference storage name.
159:      *
160:      * @param string $mbox     Mailbox.
161:      * @param string $pref_to  Preference storage name.
162:      */
163:     public function setPrefTo($mbox, $pref_to)
164:     {
165:         $this->_temp[$mbox][self::CACHE_PREFTO] = $pref_to;
166:         $this->_changed = self::CHANGED_YES;
167:     }
168: 
169:     /**
170:      * Get the UIDVALIDITY of the mailbox.
171:      *
172:      * @param string $mbox  Mailbox.
173:      *
174:      * @return mixed  UIDVALIDITY, or false if not set.
175:      */
176:     public function getUidvalidity($mbox)
177:     {
178:         return isset($this->_cache[$mbox][self::CACHE_UIDVALIDITY])
179:             ? $this->_cache[$mbox][self::CACHE_UIDVALIDITY]
180:             : false;
181:     }
182: 
183:     /**
184:      * Set the UIDVALIDITY of the mailbox.
185:      *
186:      * @param string $mbox       Mailbox.
187:      * @param integer $uidvalid  UIDVALIDITY.
188:      */
189:     public function setUidvalidity($mbox, $uidvalid)
190:     {
191:         $this->_cache[$mbox][self::CACHE_UIDVALIDITY] = $uidvalid;
192:         $this->_changed = self::CHANGED_YES;
193:     }
194: 
195:     /**
196:      * Get mailbox display label.
197:      *
198:      * @param string $mbox  Mailbox.
199:      *
200:      * @return mixed  Mailbox display label, or false if not set.
201:      */
202:     public function getDisplay($mbox)
203:     {
204:         return isset($this->_cache[$mbox][self::CACHE_DISPLAY])
205:             ? $this->_cache[$mbox][self::CACHE_DISPLAY]
206:             : false;
207:     }
208: 
209:     /**
210:      * Set mailbox display label.
211:      *
212:      * @param string $mbox     Mailbox.
213:      * @param string $display  Display label.
214:      */
215:     public function setDisplay($mbox, $display)
216:     {
217:         $this->_cache[$mbox][self::CACHE_DISPLAY] = $display;
218:         $this->_changed = self::CHANGED_YES;
219:     }
220: 
221:     /**
222:      * Get icon information.
223:      *
224:      * @param string $mbox  Mailbox.
225:      *
226:      * @return mixed  Icon information (array), or false if not set.
227:      */
228:     public function getIcons($mbox)
229:     {
230:         global $injector;
231: 
232:         if (isset($this->_cache[$mbox][self::CACHE_ICONS])) {
233:             return $this->_cache[$mbox][self::CACHE_ICONS];
234:         }
235: 
236:         if (!isset($this->_temp[self::CACHE_ICONHOOK])) {
237:             try {
238:                 $this->_temp[self::CACHE_ICONHOOK] = $injector->getInstance('Horde_Core_Hooks')->callHook('mbox_icons', 'imp');
239:             } catch (Horde_Exception_HookNotSet $e) {
240:                 $this->_temp[self::CACHE_ICONHOOK] = array();
241:             }
242:         }
243: 
244:         $icons = isset($this->_temp[self::CACHE_ICONHOOK][$mbox])
245:             ? $this->_temp[self::CACHE_ICONHOOK][$mbox]
246:             : false;
247: 
248:         $this->_cache[$mbox][self::CACHE_ICONS] = $icons;
249:         $this->_changed = self::CHANGED_YES;
250: 
251:         return $icons;
252:     }
253: 
254:     /**
255:      * Return the list of special mailboxes.
256:      *
257:      * @return array  A list of mailboxes, with the SPECIAL_* constants
258:      *                as keys and values containing the IMP_Mailbox objects or
259:      *                null if the mailbox doesn't exist (SPECIAL_SENT
260:      *                contains an array of objects).
261:      */
262:     public function getSpecialMailboxes()
263:     {
264:         global $injector, $prefs;
265: 
266:         if (!isset($this->_temp[self::CACHE_SPECIALMBOXES])) {
267:             $sm = array(
268:                 IMP_Mailbox::SPECIAL_COMPOSETEMPLATES => IMP_Mailbox::getPref(IMP_Mailbox::MBOX_TEMPLATES),
269:                 IMP_Mailbox::SPECIAL_DRAFTS => IMP_Mailbox::getPref(IMP_Mailbox::MBOX_DRAFTS),
270:                 IMP_Mailbox::SPECIAL_SENT => $injector->getInstance('IMP_Identity')->getAllSentmail(),
271:                 IMP_Mailbox::SPECIAL_SPAM => IMP_Mailbox::getPref(IMP_Mailbox::MBOX_SPAM),
272:                 IMP_Mailbox::SPECIAL_TRASH => $prefs->getValue('use_trash') ? IMP_Mailbox::getPref(IMP_Mailbox::MBOX_TRASH) : null,
273:                 IMP_Mailbox::SPECIAL_USER => array()
274:             );
275: 
276:             foreach ($injector->getInstance('IMP_Factory_Imap')->create()->config->user_special_mboxes as $key => $val) {
277:                 $ob = IMP_Mailbox::get($key);
278:                 $ob->display = $val;
279:                 $sm[IMP_Mailbox::SPECIAL_USER][strval($key)] = $ob;
280:             }
281: 
282:             $this->_temp[self::CACHE_SPECIALMBOXES] = $sm;
283:         }
284: 
285:         return $this->_temp[self::CACHE_SPECIALMBOXES];
286:     }
287: 
288:     /**
289:      * Return whether the mailbox exists.
290:      *
291:      * @param string $mbox  Mailbox.
292:      *
293:      * @return boolean  True if mailbox exists.
294:      */
295:     public function exists($mbox)
296:     {
297:         $s_mbox = strval($mbox);
298: 
299:         if (!isset($this->_temp[$s_mbox][self::CACHE_EXISTS])) {
300:             $mbox = IMP_Mailbox::get($mbox);
301: 
302:             if ($mbox->search) {
303:                 $exists = (($ob = $mbox->getSearchOb()) && $ob->enabled);
304:             } elseif ($elt = $mbox->tree_elt) {
305:                 $exists = !$elt->container;
306:             } else {
307:                 try {
308:                     $mbox_list = $mbox->imp_imap->listMailboxes(
309:                         $mbox->imap_mbox_ob,
310:                         null,
311:                         array('attributes' => true)
312:                     );
313:                     $exists = (isset($mbox_list[strval($mbox)]) &&
314:                                !in_array('\\noselect', $mbox_list[strval($mbox)]['attributes']));
315:                 } catch (IMP_Imap_Exception $e) {
316:                     $exists = false;
317:                 }
318:             }
319: 
320:             $this->_temp[$s_mbox][self::CACHE_EXISTS] = $exists;
321:         }
322: 
323:         return $this->_temp[$s_mbox][self::CACHE_EXISTS];
324:     }
325: 
326:     /**
327:      * Expire cache entries.
328:      *
329:      * @param mixed $entries     A CACHE_* constant (or array of constants).
330:      *                           If null, expires all mailbox-level cache
331:      *                           entries.
332:      * @param IMP_Mailbox $mbox  If set, only clear this mailbox's cache.
333:      */
334:     public function expire($entries, $mbox = null)
335:     {
336:         if (is_null($entries)) {
337:             $entries = array(
338:                 self::CACHE_ACL,
339:                 self::CACHE_DISPLAY,
340:                 self::CACHE_EXISTS,
341:                 self::CACHE_ICONS,
342:                 self::CACHE_LABEL,
343:                 self::CACHE_PREFTO,
344:                 self::CACHE_UIDVALIDITY
345:             );
346:         } elseif (!is_array($entries)) {
347:             $entries = array($entries);
348:         }
349: 
350:         if (in_array(self::CACHE_DISPLAY, $entries)) {
351:             $entries[] = self::CACHE_LABEL;
352:         }
353: 
354:         foreach ($entries as $val) {
355:             switch ($val) {
356:             case self::CACHE_ACL:
357:             case self::CACHE_DISPLAY:
358:             case self::CACHE_EXISTS:
359:             case self::CACHE_ICONS:
360:             case self::CACHE_LABEL:
361:             case self::CACHE_PREFTO:
362:             case self::CACHE_UIDVALIDITY:
363:                 if (!isset($mbox_list)) {
364:                     $mbox_list = $mbox
365:                         ? array(strval($mbox))
366:                         : array_merge(array_keys($this->_cache), array_keys($this->_temp));
367:                 }
368: 
369:                 foreach ($mbox_list as $val2) {
370:                     if (isset($this->_cache[$val2][$val])) {
371:                         $this->_changed = self::CHANGED_YES;
372:                     }
373:                     unset(
374:                         $this->_cache[$val2][$val],
375:                         $this->_temp[$val2][$val]
376:                     );
377:                 }
378:                 break;
379: 
380:             case self::CACHE_ICONHOOK:
381:             case self::CACHE_SPECIALMBOXES:
382:                 if (($c = isset($this->_cache[$val])) ||
383:                     isset($this->_temp[$val])) {
384:                     if ($c) {
385:                         $this->_changed = self::CHANGED_YES;
386:                     }
387:                     unset($this->_cache[$val], $this->_temp[$val]);
388:                 }
389:                 break;
390:             }
391:         }
392:     }
393: 
394:     /* Serializable methods. */
395: 
396:     /**
397:      */
398:     public function serialize()
399:     {
400:         return $GLOBALS['injector']->getInstance('Horde_Pack')->pack(
401:             $this->_cache,
402:             array(
403:                 'compression' => false,
404:                 'phpob' => false
405:             )
406:         );
407:     }
408: 
409:     /**
410:      */
411:     public function unserialize($data)
412:     {
413:         $this->_cache = $GLOBALS['injector']->getInstance('Horde_Pack')->unpack($data);
414:     }
415: 
416: }
417: