00001 <?php
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034 class Mage_Newsletter_Model_Template extends Mage_Core_Model_Abstract
00035 {
00036
00037
00038
00039 const TYPE_TEXT = 1;
00040 const TYPE_HTML = 2;
00041
00042
00043
00044
00045
00046
00047 protected $_preprocessFlag = false;
00048
00049
00050
00051
00052
00053
00054 protected $_mail;
00055
00056
00057
00058
00059
00060 protected function _construct()
00061 {
00062 $this->_init('newsletter/template');
00063 }
00064
00065
00066
00067
00068
00069
00070
00071 public function validate()
00072 {
00073 $validators = array(
00074 'template_code' => array(Zend_Filter_Input::ALLOW_EMPTY => false),
00075 'template_type' => 'Alnum',
00076 'template_sender_email' => 'EmailAddress',
00077 'template_sender_name' => array(Zend_Filter_Input::ALLOW_EMPTY => false)
00078 );
00079 $data = array();
00080 foreach (array_keys($validators) as $validateField) {
00081 $data[$validateField] = $this->getDataUsingMethod($validateField);
00082 }
00083
00084 $validateInput = new Zend_Filter_Input(array(), $validators, $data);
00085 if (!$validateInput->isValid()) {
00086 $errorMessages = array();
00087 foreach ($validateInput->getMessages() as $messages) {
00088 if (is_array($messages)) {
00089 foreach ($messages as $message) {
00090 $errorMessages[] = $message;
00091 }
00092 }
00093 else {
00094 $errorMessages[] = $messages;
00095 }
00096 }
00097
00098 Mage::throwException(join("\n", $errorMessages));
00099 }
00100 }
00101
00102
00103
00104
00105
00106
00107 protected function _beforeSave()
00108 {
00109 $this->validate();
00110 $this->getTemplateTextPreprocessed();
00111 return parent::_beforeSave();
00112 }
00113
00114
00115
00116
00117
00118
00119
00120 public function loadByCode($templateCode)
00121 {
00122 $this->_getResource()->loadByCode($this, $templateCode);
00123 return $this;
00124 }
00125
00126
00127
00128
00129
00130
00131 public function isValidForSend()
00132 {
00133 return !Mage::getStoreConfigFlag('system/smtp/disable')
00134 && $this->getTemplateSenderName()
00135 && $this->getTemplateSenderEmail()
00136 && $this->getTemplateSubject();
00137 }
00138
00139
00140
00141
00142
00143
00144 public function isPlain()
00145 {
00146 return $this->getTemplateType() == self::TYPE_TEXT;
00147 }
00148
00149
00150
00151
00152
00153
00154 public function isPreprocessed()
00155 {
00156 return strlen($this->getTemplateTextPreprocessed()) > 0;
00157 }
00158
00159
00160
00161
00162
00163
00164 public function getTemplateTextPreprocessed()
00165 {
00166 if ($this->_preprocessFlag) {
00167 $this->setTemplateTextPreprocessed($this->getProcessedTemplate());
00168 }
00169
00170 return $this->getData('template_text_preprocessed');
00171 }
00172
00173
00174
00175
00176
00177
00178
00179
00180 public function getProcessedTemplate(array $variables = array(), $usePreprocess = false)
00181 {
00182 $processor = Mage::getModel('core/email_template_filter');
00183
00184 if (!$this->_preprocessFlag) {
00185 $variables['this'] = $this;
00186 }
00187
00188 $processor
00189 ->setIncludeProcessor(array($this, 'getInclude'))
00190 ->setVariables($variables);
00191
00192 if ($usePreprocess && $this->isPreprocessed()) {
00193 return $processor->filter($this->getTemplateTextPreprocessed());
00194 }
00195
00196 return $processor->filter($this->getTemplateText());
00197 }
00198
00199
00200
00201
00202
00203
00204
00205
00206 public function getInclude($templateCode, array $variables)
00207 {
00208 return Mage::getModel('newsletter/template')
00209 ->loadByCode($templateCode)
00210 ->getProcessedTemplate($variables);
00211 }
00212
00213
00214
00215
00216
00217
00218 public function getMail()
00219 {
00220 if (is_null($this->_mail)) {
00221 $this->_mail = new Zend_Mail('utf-8');
00222 }
00223 return $this->_mail;
00224 }
00225
00226
00227
00228
00229
00230
00231
00232
00233
00234
00235
00236 public function send($subscriber, array $variables = array(), $name=null, Mage_Newsletter_Model_Queue $queue=null)
00237 {
00238 if (!$this->isValidForSend()) {
00239 return false;
00240 }
00241
00242 $email = '';
00243 if ($subscriber instanceof Mage_Newsletter_Model_Subscriber) {
00244 $email = $subscriber->getSubscriberEmail();
00245 if (is_null($name) && ($subscriber->hasCustomerFirstname() || $subscriber->hasCustomerLastname()) ) {
00246 $name = $subscriber->getCustomerFirstname() . ' ' . $subscriber->getCustomerLastname();
00247 }
00248 }
00249 else {
00250 $email = (string) $subscriber;
00251 }
00252
00253 if (Mage::getStoreConfigFlag(Mage_Newsletter_Model_Subscriber::XML_PATH_SENDING_SET_RETURN_PATH)) {
00254 $this->getMail()->setReturnPath($this->getTemplateSenderEmail());
00255 }
00256
00257 ini_set('SMTP', Mage::getStoreConfig('system/smtp/host'));
00258 ini_set('smtp_port', Mage::getStoreConfig('system/smtp/port'));
00259
00260 $mail = $this->getMail();
00261 $mail->addTo($email, $name);
00262 $text = $this->getProcessedTemplate($variables, true);
00263
00264 if ($this->isPlain()) {
00265 $mail->setBodyText($text);
00266 }
00267 else {
00268 $mail->setBodyHTML($text);
00269 }
00270
00271 $mail->setSubject($this->getProcessedTemplateSubject($variables));
00272 $mail->setFrom($this->getTemplateSenderEmail(), $this->getTemplateSenderName());
00273
00274 try {
00275 $mail->send();
00276 $this->_mail = null;
00277 if (!is_null($queue)) {
00278 $subscriber->received($queue);
00279 }
00280 }
00281 catch (Exception $e) {
00282 if ($subscriber instanceof Mage_Newsletter_Model_Subscriber) {
00283
00284 $problem = Mage::getModel('newsletter/problem');
00285 $problem->addSubscriberData($subscriber);
00286 if (!is_null($queue)) {
00287 $problem->addQueueData($queue);
00288 }
00289 $problem->addErrorData($e);
00290 $problem->save();
00291
00292 if (!is_null($queue)) {
00293 $subscriber->received($queue);
00294 }
00295 } else {
00296
00297 throw $e;
00298 }
00299 return false;
00300 }
00301
00302 return true;
00303 }
00304
00305
00306
00307
00308
00309
00310 public function preprocess()
00311 {
00312 $this->_preprocessFlag = true;
00313 $this->save();
00314 $this->_preprocessFlag = false;
00315 return $this;
00316 }
00317
00318
00319
00320
00321
00322
00323
00324 public function getProcessedTemplateSubject(array $variables)
00325 {
00326 $processor = new Varien_Filter_Template();
00327
00328 if (!$this->_preprocessFlag) {
00329 $variables['this'] = $this;
00330 }
00331
00332 $processor->setVariables($variables);
00333 return $processor->filter($this->getTemplateSubject());
00334 }
00335
00336
00337
00338
00339
00340
00341 public function getTemplateText()
00342 {
00343 if (!$this->getData('template_text') && !$this->getId()) {
00344 $this->setData('template_text',
00345 Mage::helper('newsletter')->__('<!-- This tag is for unsubscribe link --> Follow this link to unsubscribe <a href="{{var subscriber.getUnsubscriptionLink()}}">{{var subscriber.getUnsubscriptionLink()}}</a>')
00346 );
00347 }
00348
00349 return $this->getData('template_text');
00350 }
00351 }