1: <?php
  2: /**
  3:  * Copyright 2002-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 2002-2014 Horde LLC
 10:  * @license   http://www.horde.org/licenses/gpl GPL
 11:  * @package   IMP
 12:  */
 13: 
 14: /**
 15:  * Renderer for multipart/report data referring to mail system administrative
 16:  * messages (RFC 3464).
 17:  *
 18:  * @author    Michael Slusarz <slusarz@horde.org>
 19:  * @category  Horde
 20:  * @copyright 2002-2014 Horde LLC
 21:  * @license   http://www.horde.org/licenses/gpl GPL
 22:  * @package   IMP
 23:  */
 24: class IMP_Mime_Viewer_Status extends Horde_Mime_Viewer_Base
 25: {
 26:     /**
 27:      * This driver's display capabilities.
 28:      *
 29:      * @var array
 30:      */
 31:     protected $_capability = array(
 32:         'full' => false,
 33:         'info' => true,
 34:         'inline' => true,
 35:         'raw' => false
 36:     );
 37: 
 38:     /**
 39:      * Metadata for the current viewer/data.
 40:      *
 41:      * @var array
 42:      */
 43:     protected $_metadata = array(
 44:         'compressed' => false,
 45:         'embedded' => false,
 46:         'forceinline' => true
 47:     );
 48: 
 49:     /**
 50:      * Return the rendered inline version of the Horde_Mime_Part object.
 51:      *
 52:      * @return array  See parent::render().
 53:      */
 54:     protected function _renderInline()
 55:     {
 56:         return $this->_renderInfo();
 57:     }
 58: 
 59:     /**
 60:      * Return the rendered information about the Horde_Mime_Part object.
 61:      *
 62:      * @return array  See parent::render().
 63:      */
 64:     protected function _renderInfo()
 65:     {
 66:         $parts = array_keys($this->_mimepart->contentTypeMap());
 67: 
 68:         /* RFC 3464 [2]: There are three parts to a delivery status
 69:          * multipart/report message:
 70:          *   (1) Human readable message
 71:          *   (2) Machine parsable body part (message/delivery-status)
 72:          *   (3) Returned message (optional)
 73:          *
 74:          * Information on the message status is found in the 'Action' field
 75:          * located in part #2 (RFC 3464 [2.3.3]). It can be either 'failed',
 76:          * 'delayed', 'delivered', 'relayed', or 'expanded'. */
 77: 
 78:         if (count($parts) < 2) {
 79:             return array();
 80:         }
 81: 
 82:         reset($parts);
 83:         $part1_id = next($parts);
 84: 
 85:         $id_ob = new Horde_Mime_Id($part1_id);
 86:         $part2_id = $id_ob->id = $id_ob->idArithmetic($id_ob::ID_NEXT);
 87:         $part3_id = $id_ob->idArithmetic($id_ob::ID_NEXT);
 88: 
 89:         /* Get the action first - it appears in the second part. */
 90:         $action = null;
 91:         $part2 = $this->getConfigParam('imp_contents')->getMIMEPart($part2_id);
 92: 
 93:         foreach (explode("\n", $part2->getContents()) as $line) {
 94:             if (stristr($line, 'Action:') !== false) {
 95:                 $action = strtolower(trim(substr($line, strpos($line, ':') + 1)));
 96:                 if (strpos($action, ' ') !== false) {
 97:                     $action = substr($action, 0, strpos($action, ' '));
 98:                 }
 99:                 break;
100:             }
101:         }
102: 
103:         if (is_null($action)) {
104:             return array();
105:         }
106: 
107:         /* Get the correct text strings for the action type. */
108:         switch ($action) {
109:         case 'failed':
110:         case 'delayed':
111:             $status = new IMP_Mime_Status(array(
112:                 _("ERROR: Your message could not be delivered."),
113:                 sprintf(_("Technical error details can be viewed %s."), $this->getConfigParam('imp_contents')->linkViewJS($part2, 'view_attach', _("HERE"), array('jstext' => _("Technical details"), 'params' => array('ctype' => 'text/plain', 'mode' => IMP_Contents::RENDER_FULL))))
114:             ));
115:             $status->action(IMP_Mime_Status::ERROR);
116:             $msg_link = _("The text of the returned message can be viewed %s.");
117:             $msg_link_status = _("The text of the returned message");
118:             break;
119: 
120:         case 'delivered':
121:         case 'expanded':
122:         case 'relayed':
123:             $status = new IMP_Mime_Status(array(
124:                 _("Your message was successfully delivered."),
125:                 sprintf(_("Technical message details can be viewed %s."), $this->getConfigParam('imp_contents')->linkViewJS($part2, 'view_attach', _("HERE"), array('jstext' => _("Technical details"), 'params' => array('ctype' => 'text/x-simple', 'mode' => IMP_Contents::RENDER_FULL))))
126:             ));
127:             $status->action(IMP_Mime_Status::SUCCESS);
128:             $msg_link = _("The text of the message can be viewed %s.");
129:             $msg_link_status = _("The text of the message");
130:             break;
131: 
132:         default:
133:             return array();
134:         }
135: 
136:         /* Display a link to the returned message, if it exists. */
137:         $part3 = $this->getConfigParam('imp_contents')->getMIMEPart($part3_id);
138:         if ($part3) {
139:             $status->addText(sprintf($msg_link, $this->getConfigParam('imp_contents')->linkViewJS($part3, 'view_attach', _("HERE"), array('jstext' => $msg_link_status, 'params' => array('ctype' => 'message/rfc822')))));
140:         }
141: 
142:         $ret = array_fill_keys(array_diff($parts, array($part1_id)), null);
143: 
144:         $ret[$this->_mimepart->getMimeId()] = array(
145:             'data' => '',
146:             'status' => $status,
147:             'type' => 'text/html; charset=' . $this->getConfigParam('charset'),
148:             'wrap' => 'mimePartWrap'
149:         );
150: 
151:         return $ret;
152:     }
153: 
154: }
155: