1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_XmlConnect
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: /**
 28:  * XmlConnect Queue model
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_Xmlconnect
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: class Mage_XmlConnect_Model_Queue extends Mage_Core_Model_Template
 35: {
 36:     /**
 37:      * Status in queue identifier
 38:      */
 39:     const STATUS_IN_QUEUE   = 0;
 40: 
 41:     /**
 42:      * Status cenceled identifier
 43:      */
 44:     const STATUS_CANCELED   = 1;
 45: 
 46:     /**
 47:      * Status completed identifier
 48:      */
 49:     const STATUS_COMPLETED  = 2;
 50: 
 51:     /**
 52:      * Status deleted identifier
 53:      */
 54:     const STATUS_DELETED    = 3;
 55: 
 56:     /**
 57:      * Airmail message type
 58:      */
 59:     const MESSAGE_TYPE_AIRMAIL  = 'airmail';
 60: 
 61:     /**
 62:      * Push notification message type
 63:      */
 64:     const MESSAGE_TYPE_PUSH     = 'push';
 65: 
 66:     /**
 67:      * Notification type config path
 68:      */
 69:     const XML_PATH_NOTIFICATION_TYPE = 'xmlconnect/devices/%s/notification_type';
 70: 
 71:     /**
 72:      * Count of message in queue for cron
 73:      * config path
 74:      */
 75:     const XML_PATH_CRON_MESSAGES_COUNT = 'xmlconnect/mobile_application/cron_send_messages_count';
 76: 
 77:     /**
 78:      * Current application type
 79:      *
 80:      * @var null|string
 81:      */
 82:     protected $_appType = null;
 83: 
 84:     /**
 85:      * Initialize queue message
 86:      *
 87:      * @return null
 88:      */
 89:     protected function _construct()
 90:     {
 91:         $this->_init('xmlconnect/queue');
 92:     }
 93: 
 94:     /**
 95:      * Load object data
 96:      *
 97:      * @param int $id
 98:      * @param string $field
 99:      * @return Mage_XmlConnect_Model_Queue
100:      */
101:     public function load($id, $field = null)
102:     {
103:         parent::load($id, $field);
104: 
105:         if ($this->getTemplateId()) {
106:             $this->setName(Mage::getModel('xmlconnect/template')->load($this->getTemplateId())->getName());
107:         }
108:         return $this;
109:     }
110: 
111:     /**
112:      * Get template type
113:      *
114:      * @return int
115:      */
116:     public function getType()
117:     {
118:         return self::TYPE_HTML;
119:     }
120: 
121:     /**
122:      * Getter for application type
123:      * @return string
124:      */
125:     public function getApplicationType()
126:     {
127:         if (empty($this->_appType) && $this->getAppCode()) {
128:             $app = Mage::getModel('xmlconnect/application')->loadByCode($this->getAppCode());
129:             $this->_appType = $app->getId() ? $app->getType() : null;
130:         }
131: 
132:         return $this->_appType;
133:     }
134: 
135:     /**
136:      * Getter for application name
137:      *
138:      * @return string
139:      */
140:     public function getAppName()
141:     {
142:         if ($this->getApplicationName()) {
143:             return $this->getApplicationName();
144:         } else {
145:             return Mage::helper('xmlconnect')->getApplicationName($this->getAppCode());
146:         }
147:     }
148: 
149:     /**
150:      * Getter for template name
151:      *
152:      * @return string
153:      */
154:     public function getTplName()
155:     {
156:         if ($this->getTemplateName()) {
157:             return $this->getTemplateName();
158:         } else {
159:             return Mage::helper('xmlconnect')->getTemplateName($this->getTemplateId());
160:         }
161:     }
162: 
163:     /**
164:      * Retrieve processed template
165:      *
166:      * @param array $variables
167:      * @return string
168:      */
169:     public function getProcessedTemplate(array $variables = array())
170:     {
171:         /* @var $processor Mage_Widget_Model_Template_Filter */
172:         $processor = Mage::getModel('widget/template_filter');
173: 
174:         $variables['this'] = $this;
175: 
176:         if (Mage::app()->isSingleStoreMode()) {
177:             $processor->setStoreId(Mage::app()->getStore());
178:         } else {
179:             $processor->setStoreId(1);
180:         }
181: 
182:         $htmlDescription = <<<EOT
183: <div style="font-size: 0.8em; text-decoration: underline; margin-top: 1.5em; line-height: 2em;">%s:</div>
184: EOT;
185: 
186:         switch ($this->getData('type')) {
187:             case Mage_XmlConnect_Model_Queue::MESSAGE_TYPE_AIRMAIL:
188:                 $html  = sprintf($htmlDescription, Mage::helper('xmlconnect')->__('Push title'))
189:                     . $this->getPushTitle()
190:                     . sprintf($htmlDescription, Mage::helper('xmlconnect')->__('Message title'))
191:                     . $this->getMessageTitle()
192:                     . sprintf($htmlDescription, Mage::helper('xmlconnect')->__('Message content'))
193:                     . $processor->filter($this->getContent());
194:                 break;
195:             case Mage_XmlConnect_Model_Queue::MESSAGE_TYPE_PUSH:
196:             default:
197:                 $html  = sprintf($htmlDescription, Mage::helper('xmlconnect')->__('Push title'))
198:                     . $this->getPushTitle();
199:                 break;
200:         }
201:         return $html;
202:     }
203: 
204:     /**
205:      * Reset all model data
206:      *
207:      * @return Mage_XmlConnect_Model_Queue
208:      */
209:     public function reset()
210:     {
211:         $this->setData(array());
212:         $this->setOrigData();
213: 
214:         return $this;
215:     }
216: 
217: 
218:     /**
219:      * Get JSON-encoded params for broadcast AirMail
220:      *  Format of JSON data:
221:      *  {
222:      *      "push": {
223:      *          "aps": {
224:      *              "alert": "New message!"
225:      *          }
226:      *      },
227:      *      "title": "Message title",
228:      *      "message": "Your full message here.",
229:      *      "extra": {
230:      *          "some_key": "some_value"
231:      *      }
232:      *  }
233:      *
234:      * @return string
235:      */
236:     public function getAirmailBroadcastParams()
237:     {
238:         $notificationType = Mage::getStoreConfig(
239:             sprintf(Mage_XmlConnect_Model_Queue::XML_PATH_NOTIFICATION_TYPE, $this->getApplicationType())
240:         );
241: 
242:         $payload = array(
243:             'push' => array($notificationType => array('alert' => $this->getPushTitle())),
244:             'title' => $this->getMessageTitle(),
245:             'message' => $this->getContent(),
246:         );
247:         return Mage::helper('core')->jsonEncode($payload);
248:     }
249: 
250:     /**
251:      * Get JSON-encoded params for broadcast Push Notification
252:      *  Format of JSON data:
253:      *  {
254:      *      "aps": {
255:      *           "badge": 15,
256:      *           "alert": "Hello from Urban Airship!",
257:      *           "sound": "cat.caf"
258:      *      },
259:      *      "exclude_tokens": [
260:      *          "device token you want to skip",
261:      *          "another device token you want to skip"
262:      *      ]
263:      *  }
264:      *
265:      * @return string
266:      */
267:     public function getPushBroadcastParams()
268:     {
269:         $notificationType = Mage::getStoreConfig(
270:             sprintf(Mage_XmlConnect_Model_Queue::XML_PATH_NOTIFICATION_TYPE, $this->getApplicationType())
271:         );
272: 
273:         $payload = array(
274:             $notificationType => array(
275: //                'badge' => 'auto',
276:                 'alert' => $this->getPushTitle(),
277:                 'sound' => 'default'
278:             )
279:         );
280:         return Mage::helper('core')->jsonEncode($payload);
281:     }
282: 
283:     /**
284:      * Save object data
285:      *
286:      * @return Mage_Core_Model_Abstract
287:      */
288:     public function save()
289:     {
290:         if (!$this->getIsSent() && $this->getStatus() == self::STATUS_IN_QUEUE) {
291:             try {
292:                 Mage::dispatchEvent('before_save_message_queue', array('queueMessage' => $this));
293:             } catch (Exception $e) {
294:                 Mage::logException($e);
295:             }
296:         }
297:         return parent::save();
298:     }
299: }
300: