1: <?php
  2: /**
  3:  * The IMP_Ui_Mailbox:: class is designed to provide a place to store common
  4:  * code shared among IMP's various UI views for the mailbox page.
  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   Michael Slusarz <slusarz@horde.org>
 12:  * @category Horde
 13:  * @license  http://www.horde.org/licenses/gpl GPL
 14:  * @package  IMP
 15:  */
 16: class IMP_Ui_Mailbox
 17: {
 18:      const DATE_FORCE = 1;
 19:      const DATE_FULL = 2;
 20: 
 21:     /**
 22:      * The current mailbox.
 23:      *
 24:      * @var IMP_Mailbox
 25:      */
 26:     private $_mailbox;
 27: 
 28:     /**
 29:      * Cached data.
 30:      *
 31:      * @var array
 32:      */
 33:     private $_cache = array();
 34: 
 35:     /**
 36:      * Constructor.
 37:      *
 38:      * @param IMP_Mailbox $mailbox  The current mailbox.
 39:      */
 40:     public function __construct($mailbox = null)
 41:     {
 42:         $this->_mailbox = $mailbox;
 43:     }
 44: 
 45:     /**
 46:      * Get From address information for display on mailbox page.
 47:      *
 48:      * @param Horde_Imap_Client_Data_Envelope $ob  An envelope object.
 49:      * @param array $options                       Additional options:
 50:      *   - fullfrom: (boolean) If true, returns 'fullfrom' information.
 51:      *               DEFAULT: false
 52:      *   - specialchars: (string) If set, run 'from' return through
 53:      *                   htmlspecialchars() using the given charset.
 54:      *
 55:      * @return array  An array of information:
 56:      * <pre>
 57:      * 'error' - (boolean) True on error.
 58:      * 'from' - (string) The personal part of the From address.
 59:      * 'fullfrom' - (string) The full From address.
 60:      * 'to' - (boolean) True if this is who the message was sent to.
 61:      * </pre>
 62:      */
 63:     public function getFrom($ob, $options = array())
 64:     {
 65:         $ret = array('error' => false, 'to' => false);
 66: 
 67:         if (empty($ob->from)) {
 68:             $ret['from'] = $ret['fullfrom'] = _("Invalid Address");
 69:             $ret['error'] = true;
 70:             return $ret;
 71:         }
 72: 
 73:         if (!isset($this->_cache['drafts_sm_folder'])) {
 74:             $this->_cache['drafts_sm_folder'] = $this->_mailbox->special_outgoing;
 75:         }
 76: 
 77:         $from = Horde_Mime_Address::getAddressesFromObject($ob->from, array('charset' => 'UTF-8'));
 78:         $from = reset($from);
 79: 
 80:         if (!empty($from) && !isset($from['inner'])) {
 81:             $from = (isset($from['addresses']) && count($from['addresses']))
 82:                 ? $from['addresses'][0]
 83:                 : null;
 84:         }
 85: 
 86:         if (empty($from)) {
 87:             $ret['from'] = _("Invalid Address");
 88:             $ret['error'] = true;
 89:         } else {
 90:             if ($GLOBALS['injector']->getInstance('IMP_Identity')->hasAddress($from['inner'])) {
 91:                 /* This message was sent by one of the user's identity
 92:                  * addresses - show To: information instead. */
 93:                 if (empty($ob->to)) {
 94:                     $ret['from'] = _("Undisclosed Recipients");
 95:                     $ret['error'] = true;
 96:                 } else {
 97:                     $to = Horde_Mime_Address::getAddressesFromObject($ob->to, array('charset' => 'UTF-8'));
 98:                     $first_to = reset($to);
 99:                     if (empty($first_to)) {
100:                         $ret['from'] = _("Undisclosed Recipients");
101:                         $ret['error'] = true;
102:                     } else {
103:                         $ret['from'] = empty($first_to['personal'])
104:                             ? $first_to['inner']
105:                             : $first_to['personal'];
106:                         if (!empty($options['fullfrom'])) {
107:                             $ret['fullfrom'] = $first_to['display'];
108:                         }
109:                     }
110:                 }
111:                 if (!$this->_cache['drafts_sm_folder']) {
112:                     $ret['from'] = _("To") . ': ' . $ret['from'];
113:                 }
114:                 $ret['to'] = true;
115:             } else {
116:                 $ret['from'] = empty($from['personal'])
117:                     ? $from['inner']
118:                     : $from['personal'];
119:                 if ($this->_cache['drafts_sm_folder']) {
120:                     $ret['from'] = _("From") . ': ' . $ret['from'];
121:                 }
122:                 if (!empty($options['fullfrom'])) {
123:                     $ret['fullfrom'] = $from['display'];
124:                 }
125:             }
126:         }
127: 
128:         if (!empty($options['fullfrom']) && !isset($ret['fullfrom'])) {
129:             $ret['fullfrom'] = $ret['from'];
130:         }
131: 
132:         if (!empty($ret['from']) && !empty($options['specialchars'])) {
133:             $res = @htmlspecialchars($ret['from'], ENT_QUOTES, $options['specialchars']);
134:             if (empty($res)) {
135:                 $res = @htmlspecialchars($ret['from']);
136:             }
137:             $ret['from'] = $res;
138:         }
139: 
140:         return $ret;
141:     }
142: 
143:     /**
144:      * Get size display information.
145:      *
146:      * @param integer $size  The size of the message, in bytes.
147:      *
148:      * @return string  A formatted size string.
149:      */
150:     public function getSize($size)
151:     {
152:         return ($size >= 1048576)
153:             ? sprintf(_("%s MB"), IMP::numberFormat($size / 1048576, 1))
154:             : sprintf(_("%s KB"), IMP::numberFormat($size / 1024, 0));
155:     }
156: 
157:     /**
158:      * Formats the date header.
159:      *
160:      * @param mixed $date      The date object. Either a DateTime object or a
161:      *                         date string.
162:      * @param integer $format  Mask of formatting options:
163:      *   - IMP_Ui_Mailbox::DATE_FORCE - Force use of date formatting, instead
164:      *                                  of time formatting, for all dates.
165:      *   - IMP_Ui_Mailbox::DATE_FULL - Use full representation of date,
166:      *                                 including time information.
167:      *
168:      * @return string  The formatted date header.
169:      */
170:     public function getDate($date, $format = 0)
171:     {
172:         if (!is_object($date)) {
173:             $date = new Horde_Imap_Client_DateTime($date);
174:         }
175: 
176:         if (!($format & self::DATE_FORCE) &&
177:             !isset($this->_cache['today_start'])) {
178:             $this->_cache['today_start'] = new DateTime('today');
179:             $this->_cache['today_end'] = new DateTime('today + 1 day');
180:         }
181: 
182:         $udate = null;
183:         if (!$date->error()) {
184:             try {
185:                 $udate = $date->format('U');
186:             } catch (Exception $e) {}
187:         }
188: 
189:         if (is_null($udate)) {
190:             return _("Unknown Date");
191:         }
192: 
193:         if (($format & self::DATE_FORCE) ||
194:             ($udate < $this->_cache['today_start']->format('U')) ||
195:             ($udate > $this->_cache['today_end']->format('U'))) {
196:             /* Not today, use the date. */
197:             if ($format & self::DATE_FULL) {
198:                 return strftime($GLOBALS['prefs']->getValue('date_format'), $udate) .
199:                     ' [' . strftime($GLOBALS['prefs']->getValue('time_format'), $udate) . ']';
200:             }
201: 
202:             return strftime($GLOBALS['prefs']->getValue('date_format_mini'), $udate);
203:         }
204: 
205:         /* Else, it's today, use the time. */
206:         return strftime($GLOBALS['prefs']->getValue('time_format'), $udate);
207:     }
208: 
209:     /**
210:      * Formats the subject header.
211:      *
212:      * @param string $subject     The MIME encoded subject header.
213:      * @param string $htmlspaces  HTML-ize spaces?
214:      *
215:      * @return string  The formatted subject header.
216:      */
217:     public function getSubject($subject, $htmlspaces = false)
218:     {
219:         $subject = Horde_Mime::decode($subject, 'UTF-8');
220:         if (empty($subject)) {
221:             return _("[No Subject]");
222:         }
223: 
224:         $new_subject = $subject = IMP::filterText(preg_replace("/\s+/", ' ', $subject));
225: 
226:         if ($htmlspaces) {
227:             $new_subject = $GLOBALS['injector']->getInstance('Horde_Core_Factory_TextFilter')->filter($subject, 'space2html', array('encode' => true));
228:             if (empty($new_subject)) {
229:                 $new_subject = htmlspecialchars($subject);
230:             }
231:         }
232: 
233:         return empty($new_subject) ? $subject : $new_subject;
234:     }
235: 
236: }
237: