1: <?php
  2: /**
  3:  * Copyright 1999-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 1999-2014 Horde LLC
 10:  * @license   http://www.horde.org/licenses/gpl GPL
 11:  * @package   IMP
 12:  */
 13: 
 14: /**
 15:  * IMP base class.
 16:  *
 17:  * @author    Chuck Hagenbuch <chuck@horde.org>
 18:  * @author    Jon Parise <jon@horde.org>
 19:  * @author    Michael Slusarz <slusarz@horde.org>
 20:  * @category  Horde
 21:  * @copyright 1999-2014 Horde LLC
 22:  * @license   http://www.horde.org/licenses/gpl GPL
 23:  * @package   IMP
 24:  */
 25: class IMP
 26: {
 27:     /* Encrypt constants. */
 28:     const ENCRYPT_NONE = 'encrypt_none';
 29: 
 30:     /* IMP Mailbox view constants. */
 31:     const MAILBOX_START_FIRSTUNSEEN = 1;
 32:     const MAILBOX_START_LASTUNSEEN = 2;
 33:     const MAILBOX_START_FIRSTPAGE = 3;
 34:     const MAILBOX_START_LASTPAGE = 4;
 35: 
 36:     /* Folder list actions. */
 37:     const NOTEPAD_EDIT = "notepad\0";
 38:     const TASKLIST_EDIT = "tasklist\0";
 39: 
 40:     /* Initial page constants. */
 41:     const INITIAL_FOLDERS = "initial\0folders";
 42: 
 43:     /* Sorting constants. */
 44:     const IMAP_SORT_DATE = 100;
 45: 
 46:     /**
 47:      * Filters a string, if requested.
 48:      *
 49:      * @param string $text  The text to filter.
 50:      *
 51:      * @return string  The filtered text (if requested).
 52:      */
 53:     public static function filterText($text)
 54:     {
 55:         global $injector, $prefs;
 56: 
 57:         if ($prefs->getValue('filtering') && strlen($text)) {
 58:             try {
 59:                 return $injector->getInstance('Horde_Core_Factory_TextFilter')->filter(
 60:                     $text,
 61:                     'words',
 62:                     $injector->getInstance('Horde_Core_Hooks')->callHook('msg_filter', 'imp')
 63:                 );
 64:             } catch (Horde_Exception_HookNotSet $e) {}
 65:         }
 66: 
 67:         return $text;
 68:     }
 69: 
 70:     /**
 71:      *
 72:      * @param integer $size  The byte size of data.
 73:      *
 74:      * @return string  A formatted size string.
 75:      */
 76:     public static function sizeFormat($size)
 77:     {
 78:         return ($size >= 1048576)
 79:             ? sprintf(_("%s MB"), self::numberFormat($size / 1048576, 1))
 80:             : sprintf(_("%s KB"), self::numberFormat($size / 1024, 0));
 81:     }
 82: 
 83:     /**
 84:      * Workaround broken number_format() prior to PHP 5.4.0.
 85:      *
 86:      * @param integer $number    Number to format.
 87:      * @param integer $decimals  Number of decimals to display.
 88:      *
 89:      * @return string  See number_format().
 90:      */
 91:     public static function numberFormat($number, $decimals)
 92:     {
 93:         $localeinfo = Horde_Nls::getLocaleInfo();
 94: 
 95:         return str_replace(
 96:             array('X', 'Y'),
 97:             array($localeinfo['decimal_point'], $localeinfo['thousands_sep']),
 98:             number_format($decimals ? $number : ceil($number), $decimals, 'X', 'Y')
 99:         );
100:     }
101: 
102:     /**
103:      * Wrapper around Horde_Mail_Rfc822#parseAddressList(). Ensures all
104:      * addresses have a default mail domain appended.
105:      *
106:      * @param mixed $in    The address string or an address list object.
107:      * @param array $opts  Options to override the default.
108:      *
109:      * @return Horde_Mail_Rfc822_List  See Horde_Mail_Rfc822#parseAddressList().
110:      *
111:      * @throws Horde_Mail_Exception
112:      */
113:     public static function parseAddressList($in, array $opts = array())
114:     {
115:         $md = $GLOBALS['injector']->getInstance('IMP_Factory_Imap')->create()->config->maildomain;
116: 
117:         if ($in instanceof Horde_Mail_Rfc822_List) {
118:             $res = clone $in;
119:             foreach ($res->raw_addresses as $val) {
120:                 if (is_null($val->host)) {
121:                     $val->host = $md;
122:                  }
123:             }
124:         } else {
125:             $rfc822 = $GLOBALS['injector']->getInstance('Horde_Mail_Rfc822');
126:             $res = $rfc822->parseAddressList($in, array_merge(array(
127:                 'default_domain' => $md,
128:                 'validate' => false
129:             ), $opts));
130:         }
131: 
132:         $res->setIteratorFilter(Horde_Mail_Rfc822_List::HIDE_GROUPS);
133: 
134:         return $res;
135:     }
136: 
137:     /**
138:      * Returns the initial page for IMP.
139:      *
140:      * @return object  Object with the following properties:
141:      *   - mbox (IMP_Mailbox)
142:      *   - url (Horde_Url)
143:      */
144:     public static function getInitialPage()
145:     {
146:         global $injector, $prefs, $registry;
147: 
148:         $init_url = $prefs->getValue('initial_page');
149:         if (!$init_url ||
150:             !$injector->getInstance('IMP_Factory_Imap')->create()->access(IMP_Imap::ACCESS_FOLDERS)) {
151:             $init_url = 'INBOX';
152:         }
153: 
154:         if ($init_url == IMP::INITIAL_FOLDERS) {
155:             $mbox = null;
156:         } else {
157:             $mbox = IMP_Mailbox::get($init_url);
158:             if (!$mbox->exists) {
159:                 $mbox = IMP_Mailbox::get('INBOX');
160:             }
161:         }
162: 
163:         $result = new stdClass;
164:         $result->mbox = $mbox;
165: 
166:         switch ($registry->getView()) {
167:         case Horde_Registry::VIEW_BASIC:
168:             $result->url = is_null($mbox)
169:                 ? IMP_Basic_Folders::url()
170:                 : $mbox->url('mailbox');
171:             break;
172: 
173:         case Horde_Registry::VIEW_DYNAMIC:
174:             $result->url = IMP_Dynamic_Mailbox::url(array(
175:                 'mailbox' => is_null($mbox) ? 'INBOX' : $mbox
176:             ));
177:             break;
178: 
179:         case Horde_Registry::VIEW_MINIMAL:
180:             $result->url = is_null($mbox)
181:                 ? IMP_Minimal_Folders::url()
182:                 : IMP_Minimal_Mailbox::url(array('mailbox' => $mbox));
183:             break;
184: 
185:         case Horde_Registry::VIEW_SMARTMOBILE:
186:             $result->url = is_null($mbox)
187:                 ? Horde::url('smartmobile.php', true)
188:                 : $mbox->url('mailbox');
189:             break;
190:         }
191: 
192:         return $result;
193:     }
194: 
195: }
196: