1: <?php
  2: /**
  3:  * Copyright 2010-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 2010-2014 Horde LLC
 10:  * @license   http://www.horde.org/licenses/gpl GPL
 11:  * @package   IMP
 12:  */
 13: 
 14: /**
 15:  * Defines the AJAX interface for IMP.
 16:  *
 17:  * Global tasks:
 18:  *   - msgload: (string) BUID of a message to load in the background (mailbox
 19:  *              is located in 'mailbox' parameter).
 20:  *   - poll: (string) The list of mailboxes to process (JSON encoded
 21:  *           array; mailboxes are base64url encoded). If an empty array, polls
 22:  *           all mailboxes.
 23:  *
 24:  * Global parameters (in viewport parameter):
 25:  *   - force: (integer) If set, always return viewport information if changed.
 26:  *
 27:  * @author    Michael Slusarz <slusarz@horde.org>
 28:  * @category  Horde
 29:  * @copyright 2010-2014 Horde LLC
 30:  * @license   http://www.horde.org/licenses/gpl GPL
 31:  * @package   IMP
 32:  */
 33: class IMP_Ajax_Application extends Horde_Core_Ajax_Application
 34: {
 35:     /**
 36:      * The IMP_Indices_Mailbox object based on form data.
 37:      *
 38:      * @var IMP_Indices_Mailbox
 39:      */
 40:     public $indices;
 41: 
 42:     /**
 43:      * Queue object.
 44:      *
 45:      * @var IMP_Ajax_Queue
 46:      */
 47:     public $queue;
 48: 
 49:     /**
 50:      */
 51:     protected function _init()
 52:     {
 53:         global $injector, $registry;
 54: 
 55:         $this->queue = $injector->getInstance('IMP_Ajax_Queue');
 56: 
 57:         switch ($registry->getView()) {
 58:         case $registry::VIEW_BASIC:
 59:             $this->addHandler('IMP_Ajax_Application_Handler_Mboxtoggle');
 60:             $this->addHandler('IMP_Ajax_Application_Handler_Passphrase');
 61:             $this->addHandler('IMP_Ajax_Application_Handler_Search');
 62:             if ($injector->getInstance('IMP_Factory_Imap')->create()->access(IMP_Imap::ACCESS_REMOTE)) {
 63:                 $this->addHandler('IMP_Ajax_Application_Handler_RemotePrefs');
 64:             }
 65:             break;
 66: 
 67:         case $registry::VIEW_DYNAMIC:
 68:             $this->addHandler('IMP_Ajax_Application_Handler_Common');
 69:             $this->addHandler('IMP_Ajax_Application_Handler_ComposeAttach');
 70:             $this->addHandler('IMP_Ajax_Application_Handler_Draft');
 71:             $this->addHandler('IMP_Ajax_Application_Handler_Dynamic');
 72:             $this->addHandler('IMP_Ajax_Application_Handler_Mboxtoggle');
 73:             $this->addHandler('IMP_Ajax_Application_Handler_Passphrase');
 74:             $this->addHandler('IMP_Ajax_Application_Handler_Search');
 75:             if ($injector->getInstance('IMP_Factory_Imap')->create()->access(IMP_Imap::ACCESS_REMOTE)) {
 76:                 $this->addHandler('IMP_Ajax_Application_Handler_Remote');
 77:                 $this->addHandler('IMP_Ajax_Application_Handler_RemotePrefs');
 78:             }
 79:             break;
 80: 
 81:         case $registry::VIEW_SMARTMOBILE:
 82:             $this->addHandler('IMP_Ajax_Application_Handler_Common');
 83:             $this->addHandler('IMP_Ajax_Application_Handler_ComposeAttach');
 84:             $this->addHandler('IMP_Ajax_Application_Handler_Draft')->disabled = array(
 85:                 'autoSaveDraft',
 86:                 'saveTemplate'
 87:             );
 88:             $this->addHandler('IMP_Ajax_Application_Handler_Smartmobile');
 89:             break;
 90:         }
 91: 
 92:         $this->addHandler('IMP_Ajax_Application_Handler_ImageUnblock');
 93:         $this->addHandler('Horde_Core_Ajax_Application_Handler_Imple');
 94:         $this->addHandler('Horde_Core_Ajax_Application_Handler_Prefs');
 95: 
 96:         /* Copy 'view' paramter to 'mailbox', because this is what
 97:          * IMP_Indices_Mailbox expects. */
 98:         if (isset($this->_vars->view)) {
 99:             $this->_vars->mailbox = $this->_vars->view;
100:         }
101: 
102:         $this->indices = new IMP_Indices_Mailbox($this->_vars);
103: 
104:         /* Make sure the viewport entry is initialized. */
105:         $vp = isset($this->_vars->viewport)
106:             ? json_decode($this->_vars->viewport)
107:             : new stdClass;
108:         $this->_vars->viewport = new Horde_Support_ObjectStub($vp);
109: 
110:         /* GLOBAL TASKS */
111: 
112:         /* Check for global msgload task. */
113:         if (isset($this->_vars->msgload)) {
114:             $this->queue->message($this->indices->mailbox->fromBuids(array($this->_vars->msgload)), true, true);
115:         }
116: 
117:         /* Check for global poll task. */
118:         if (isset($this->_vars->poll)) {
119:             $poll = json_decode($this->_vars->poll);
120:             $this->queue->poll(
121:                 empty($poll)
122:                     ? $injector->getInstance('IMP_Ftree')->poll->getPollList()
123:                     : IMP_Mailbox::formFrom($poll),
124:                 true
125:             );
126:         }
127:     }
128: 
129:     /**
130:      */
131:     public function send()
132:     {
133:         $this->getTasks();
134:         parent::send();
135:     }
136: 
137:     /**
138:      * Get the list of tasks.
139:      *
140:      * @return array  Task list.
141:      */
142:     public function getTasks()
143:     {
144:         $this->queue->add($this);
145: 
146:         /* Convert viewport to output format. */
147:         $name = 'imp:viewport';
148:         if (isset($this->tasks->$name)) {
149:             $this->tasks->$name = $this->tasks->$name->toObject();
150:         }
151: 
152:         return $this->tasks;
153:     }
154: 
155:     /* Shared code between handlers. */
156: 
157:     /**
158:      * Initialize the objects needed to compose.
159:      *
160:      * @return object  Object with the following properties:
161:      *   - ajax: IMP_Ajax_Application_Compose object
162:      *   - compose: IMP_Compose object
163:      *   - contents: IMP_Contents object
164:      */
165:     public function initCompose()
166:     {
167:         global $injector;
168: 
169:         $ob = new stdClass;
170: 
171:         $ob->compose = $injector->getInstance('IMP_Factory_Compose')->create($this->_vars->imp_compose);
172:         $ob->ajax = new IMP_Ajax_Application_Compose($ob->compose, $this->_vars->type);
173: 
174:         if (!($ob->contents = $ob->compose->getContentsOb()) &&
175:             count($this->indices)) {
176:             $ob->contents = $injector->getInstance('IMP_Factory_Contents')->create($this->indices);
177:         }
178: 
179:         $this->queue->compose($ob->compose);
180: 
181:         return $ob;
182:     }
183: 
184:     /**
185:      * Check the UID validity of the mailbox.
186:      *
187:      * See the list of variables needed for viewPortData().
188:      */
189:     public function checkUidvalidity()
190:     {
191:         try {
192:             $this->indices->mailbox->uidvalid;
193:         } catch (IMP_Exception $e) {
194:             $this->addTask('viewport', $this->viewPortData(true));
195:         }
196:     }
197: 
198:     /**
199:      * Generate the information necessary for a ViewPort request from/to the
200:      * browser.
201:      *
202:      * Variables used (contained in 'viewport' object):
203:      *   - applyfilter
204:      *   - cache
205:      *   - cacheid
206:      *   - delhide
207:      *   - initial
208:      *   - qsearch
209:      *   - qsearchfield
210:      *   - qsearchfilter
211:      *   - qsearchflag
212:      *   - qsearchflagnot
213:      *   - qsearchmbox
214:      *   - rangeslice
215:      *   - sortby
216:      *   - sortdir
217:      *
218:      * @param boolean $change  True if cache information has changed.
219:      *
220:      * @return IMP_Ajax_Application_Viewport  Viewport data object.
221:      */
222:     public function viewPortData($change)
223:     {
224:         $args = array(
225:             'change' => $change,
226:             'mbox' => strval($this->indices->mailbox)
227:         );
228: 
229:         $params = array(
230:             'applyfilter', 'cache', 'cacheid', 'delhide', 'initial', 'qsearch',
231:             'qsearchfield', 'qsearchfilter', 'qsearchflag', 'qsearchflagnot',
232:             'qsearchmbox', 'rangeslice', 'sortby', 'sortdir'
233:         );
234: 
235:         $vp = $this->_vars->viewport;
236: 
237:         foreach ($params as $val) {
238:             $args[$val] = $vp->$val;
239:         }
240: 
241:         if ($vp->search || $args['initial']) {
242:             $args += array(
243:                 'after' => intval($vp->after),
244:                 'before' => intval($vp->before)
245:             );
246:         }
247: 
248:         if ($vp->search) {
249:             $search = json_decode($vp->search);
250:             $args += array(
251:                 'search_buid' => isset($search->buid) ? $search->buid : null,
252:                 'search_unseen' => isset($search->unseen) ? $search->unseen : null
253:             );
254:         } else {
255:             list($slice_start, $slice_end) = explode(':', $vp->slice, 2);
256:             $args += array(
257:                 'slice_start' => intval($slice_start),
258:                 'slice_end' => intval($slice_end)
259:             );
260:         }
261: 
262:         return $GLOBALS['injector']->getInstance('IMP_Ajax_Application_ListMessages')->listMessages($args);
263:     }
264: 
265:     /**
266:      * Determine if the cache information has changed.
267:      *
268:      * Variables used:
269:      *   - cacheid: (string) The browser (ViewPort) cache identifier.
270:      *   - forceUpdate: (integer) If 1, forces an update.
271:      *
272:      * @param boolean $rw  Open mailbox as READ+WRITE?
273:      *
274:      * @return boolean  True if the server state differs from the browser
275:      *                  state.
276:      */
277:     public function changed($rw = null)
278:     {
279:         /* Forced viewport return. */
280:         if ($this->_vars->viewport->force) {
281:             return true;
282:         }
283: 
284:         /* Only update search mailboxes on forced refreshes. */
285:         if ($this->indices->mailbox->search) {
286:             return !empty($this->_vars->forceUpdate);
287:         }
288: 
289:         if (!$this->_vars->viewport->cacheid) {
290:             return false;
291:         }
292: 
293:         /* We know we are going to be dealing with this mailbox, so select it
294:          * on the IMAP server (saves some STATUS calls). */
295:         if (!is_null($rw)) {
296:             try {
297:                 $this->indices->mailbox->imp_imap->openMailbox($this->indices->mailbox, $rw ? Horde_Imap_Client::OPEN_READWRITE : Horde_Imap_Client::OPEN_AUTO);
298:             } catch (IMP_Imap_Exception $e) {
299:                 $e->notify();
300:                 return null;
301:             }
302:         }
303: 
304:         return ($this->indices->mailbox->cacheid_date != $this->_vars->viewport->cacheid);
305:     }
306: 
307:     /**
308:      * Setup environment for compose actions.
309:      *
310:      * Variables used:
311:      *   - bcc: (string) Bcc address to use.
312:      *   - bcc_ac: (string) Bcc address to use (autocompleter JSON data).
313:      *   - cc: (string) Cc address to use.
314:      *   - cc_ac: (string) Cc address to use (autocompleter JSON data).
315:      *   - composeCache: (string) The IMP_Compose cache identifier.
316:      *   - from: (string) From address to use.
317:      *   - from_ac: (string) From address to use (autocompleter JSON data).
318:      *   - identity: (integer) The identity to use
319:      *   - redirect_to: (string) To address to use (for redirect).
320:      *   - redirect_to_ac: (string) To address to use (for redirect)
321:      *                     (autocompleter JSON data).
322:      *   - to: (string) To address to use.
323:      *   - to_ac: (string) To address to use (autocompleter JSON data).
324:      *
325:      * @param string $action  AJAX action.
326:      *
327:      * @return array  An array with the following values:
328:      *   - (object) AJAX base return object (with action and success
329:      *     parameters defined).
330:      *   - (IMP_Compose) The IMP_Compose object for the message.
331:      *   - (array) The list of headers for the object.
332:      *   - (Horde_Prefs_Identity) The identity used for the composition.
333:      *
334:      * @throws Horde_Exception
335:      */
336:     public function composeSetup($action)
337:     {
338:         global $injector, $prefs;
339: 
340:         /* Set up identity. */
341:         $identity = $injector->getInstance('IMP_Identity');
342:         if (isset($this->_vars->identity) &&
343:             !$prefs->isLocked('default_identity')) {
344:             $identity->setDefault($this->_vars->identity);
345:         }
346: 
347:         $addr = $this->getAddrFields();
348: 
349:         $headers = array(
350:             /* Set up the From address based on the identity. */
351:             'from' => strval($identity->getFromLine(null, $this->_vars->from)),
352:             'to' => implode(',', $addr['to']['addr']),
353:             'cc' => implode(',', $addr['cc']['addr']),
354:             'bcc' => implode(',', $addr['bcc']['addr']),
355:             'redirect_to' => implode(',', $addr['redirect_to']['addr']),
356:             'subject' => $this->_vars->subject
357:         );
358: 
359:         $imp_compose = $injector->getInstance('IMP_Factory_Compose')->create($this->_vars->composeCache);
360: 
361:         $result = new stdClass;
362:         $result->action = $action;
363:         $result->success = 1;
364: 
365:         return array($result, $imp_compose, $headers, $identity);
366:     }
367: 
368:     /**
369:      * Return address field data from the browser form.
370:      *
371:      * @return array  Keys are header names, values are arrays with two keys:
372:      *   - addr: (array) List of addresses.
373:      *   - map: (boolean) If true, addr keys are autocomplete IDs.
374:      */
375:     public function getAddrFields()
376:     {
377:         $out = array();
378: 
379:         foreach (array('to', 'cc', 'bcc', 'redirect_to') as $val) {
380:             $data = $this->_vars->get($val);
381:             $data_ac = $this->_vars->get($val . '_ac');
382:             $tmp = array(
383:                 'addr' => array(),
384:                 'map' => false
385:             );
386: 
387:             if (strlen($data)) {
388:                 if (strlen($data_ac)) {
389:                     $tmp['map'] = true;
390:                     foreach (json_decode($data_ac, true) as $val2) {
391:                         $tmp['addr'][$val2[1]] = $val2[0];
392:                     }
393:                 } else {
394:                     $tmp['addr'][] = $data;
395:                 }
396:             }
397: 
398:             $out[$val] = $tmp;
399:         }
400: 
401:         return $out;
402:     }
403: 
404:     /**
405:      * Processes delete message requests.
406:      * See the list of variables needed for viewPortData().
407:      *
408:      * @param IMP_Indices $indices  An indices object.
409:      * @param boolean $changed      If true, add full ViewPort information.
410:      * @param boolean $force        If true, forces addition of disappear
411:      *                              information.
412:      */
413:     public function deleteMsgs(IMP_Indices $indices, $changed, $force = false)
414:     {
415:         /* Check if we need to update thread information. */
416:         if (!$changed) {
417:             $changed = ($this->indices->mailbox->getSort()->sortby == Horde_Imap_Client::SORT_THREAD);
418:         }
419: 
420:         if ($changed) {
421:             $this->addTask('viewport', $this->viewPortData(true));
422:         } elseif (($indices instanceof IMP_Indices_Mailbox) &&
423:                   ($force || $this->indices->mailbox->hideDeletedMsgs(true))) {
424:             $vp = new IMP_Ajax_Application_Viewport($this->indices->mailbox);
425:             $vp->disappear = $indices->buids[strval($this->indices->mailbox)];
426:             $this->addTask('viewport', $vp);
427:         }
428: 
429:         $this->queue->poll(array_keys($indices->indices()));
430:     }
431: 
432: }
433: