-
Notifications
You must be signed in to change notification settings - Fork 0
/
Template.php
executable file
·395 lines (355 loc) · 12 KB
/
Template.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
<?php
/**
* Magento Enterprise Edition
*
* NOTICE OF LICENSE
*
* This source file is subject to the Magento Enterprise Edition License
* that is bundled with this package in the file LICENSE_EE.txt.
* It is also available through the world-wide-web at this URL:
* http://www.magentocommerce.com/license/enterprise-edition
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magentocommerce.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magentocommerce.com for more information.
*
* @category Mage
* @package Mage_Newsletter
* @copyright Copyright (c) 2014 Magento Inc. (http://www.magentocommerce.com)
* @license http://www.magentocommerce.com/license/enterprise-edition
*/
/**
* Template model
*
* @method Mage_Newsletter_Model_Resource_Template _getResource()
* @method Mage_Newsletter_Model_Resource_Template getResource()
* @method string getTemplateCode()
* @method Mage_Newsletter_Model_Template setTemplateCode(string $value)
* @method Mage_Newsletter_Model_Template setTemplateText(string $value)
* @method Mage_Newsletter_Model_Template setTemplateTextPreprocessed(string $value)
* @method string getTemplateStyles()
* @method Mage_Newsletter_Model_Template setTemplateStyles(string $value)
* @method int getTemplateType()
* @method Mage_Newsletter_Model_Template setTemplateType(int $value)
* @method string getTemplateSubject()
* @method Mage_Newsletter_Model_Template setTemplateSubject(string $value)
* @method string getTemplateSenderName()
* @method Mage_Newsletter_Model_Template setTemplateSenderName(string $value)
* @method string getTemplateSenderEmail()
* @method Mage_Newsletter_Model_Template setTemplateSenderEmail(string $value)
* @method int getTemplateActual()
* @method Mage_Newsletter_Model_Template setTemplateActual(int $value)
* @method string getAddedAt()
* @method Mage_Newsletter_Model_Template setAddedAt(string $value)
* @method string getModifiedAt()
* @method Mage_Newsletter_Model_Template setModifiedAt(string $value)
*
* @category Mage
* @package Mage_Newsletter
* @author Magento Core Team <core@magentocommerce.com>
*/
class Mage_Newsletter_Model_Template extends Mage_Core_Model_Template
{
/**
* Template Text Preprocessed flag
*
* @var bool
*/
protected $_preprocessFlag = false;
/**
* Mail object
*
* @var Zend_Mail
*/
protected $_mail;
/**
* Initialize resource model
*
*/
protected function _construct()
{
$this->_init('newsletter/template');
}
/**
* Validate Newsletter template
*
* @throws Mage_Core_Exception
* @return bool
*/
public function validate()
{
$validators = array(
'template_code' => array(Zend_Filter_Input::ALLOW_EMPTY => false),
'template_type' => 'Int',
'template_sender_email' => 'EmailAddress',
'template_sender_name' => array(Zend_Filter_Input::ALLOW_EMPTY => false)
);
$data = array();
foreach (array_keys($validators) as $validateField) {
$data[$validateField] = $this->getDataUsingMethod($validateField);
}
$validateInput = new Zend_Filter_Input(array(), $validators, $data);
if (!$validateInput->isValid()) {
$errorMessages = array();
foreach ($validateInput->getMessages() as $messages) {
if (is_array($messages)) {
foreach ($messages as $message) {
$errorMessages[] = $message;
}
}
else {
$errorMessages[] = $messages;
}
}
Mage::throwException(join("\n", $errorMessages));
}
}
/**
* Processing object before save data
*
* @return Mage_Newsletter_Model_Template
*/
protected function _beforeSave()
{
$this->validate();
return parent::_beforeSave();
}
/**
* Load template by code
*
* @param string $templateCode
* @return Mage_Newsletter_Model_Template
*/
public function loadByCode($templateCode)
{
$this->_getResource()->loadByCode($this, $templateCode);
return $this;
}
/**
* Return true if this template can be used for sending queue as main template
*
* @return boolean
* @deprecated since 1.4.0.1
*/
public function isValidForSend()
{
return !Mage::getStoreConfigFlag('system/smtp/disable')
&& $this->getTemplateSenderName()
&& $this->getTemplateSenderEmail()
&& $this->getTemplateSubject();
}
/**
* Getter for template type
*
* @return int|string
*/
public function getType(){
return $this->getTemplateType();
}
/**
* Check is Preprocessed
*
* @return bool
*/
public function isPreprocessed()
{
return strlen($this->getTemplateTextPreprocessed()) > 0;
}
/**
* Check Template Text Preprocessed
*
* @return bool
*/
public function getTemplateTextPreprocessed()
{
if ($this->_preprocessFlag) {
$this->setTemplateTextPreprocessed($this->getProcessedTemplate());
}
return $this->getData('template_text_preprocessed');
}
/**
* Retrieve processed template
*
* @param array $variables
* @param bool $usePreprocess
* @return string
*/
public function getProcessedTemplate(array $variables = array(), $usePreprocess = false)
{
/* @var $processor Mage_Newsletter_Model_Template_Filter */
$processor = Mage::helper('newsletter')->getTemplateProcessor();
if (!$this->_preprocessFlag) {
$variables['this'] = $this;
}
if (Mage::app()->isSingleStoreMode()) {
$processor->setStoreId(Mage::app()->getStore());
} else {
$processor->setStoreId(Mage::app()->getRequest()->getParam('store_id'));
}
$processor
->setIncludeProcessor(array($this, 'getInclude'))
->setVariables($variables);
if ($usePreprocess && $this->isPreprocessed()) {
return $processor->filter($this->getPreparedTemplateText(true));
}
return $processor->filter($this->getPreparedTemplateText());
}
/**
* Makes additional text preparations for HTML templates
*
* @param bool $usePreprocess Use Preprocessed text or original text
* @return string
*/
public function getPreparedTemplateText($usePreprocess = false)
{
$text = $usePreprocess ? $this->getTemplateTextPreprocessed() : $this->getTemplateText();
if ($this->_preprocessFlag || $this->isPlain() || !$this->getTemplateStyles()) {
return $text;
}
// wrap styles into style tag
$html = "<style type=\"text/css\">\n%s\n</style>\n%s";
return sprintf($html, $this->getTemplateStyles(), $text);
}
/**
* Retrieve included template
*
* @param string $templateCode
* @param array $variables
* @return string
*/
public function getInclude($templateCode, array $variables)
{
return Mage::getModel('newsletter/template')
->loadByCode($templateCode)
->getProcessedTemplate($variables);
}
/**
* Retrieve mail object instance
*
* @return Zend_Mail
* @deprecated since 1.4.0.1
*/
public function getMail()
{
if (is_null($this->_mail)) {
$this->_mail = new Zend_Mail('utf-8');
}
return $this->_mail;
}
/**
* Send mail to subscriber
*
* @param Mage_Newsletter_Model_Subscriber|string $subscriber subscriber Model or E-mail
* @param array $variables template variables
* @param string|null $name receiver name (if subscriber model not specified)
* @param Mage_Newsletter_Model_Queue|null $queue queue model, used for problems reporting.
* @return boolean
* @deprecated since 1.4.0.1
**/
public function send($subscriber, array $variables = array(), $name=null, Mage_Newsletter_Model_Queue $queue=null)
{
if (!$this->isValidForSend()) {
return false;
}
$email = '';
if ($subscriber instanceof Mage_Newsletter_Model_Subscriber) {
$email = $subscriber->getSubscriberEmail();
if (is_null($name) && ($subscriber->hasCustomerFirstname() || $subscriber->hasCustomerLastname()) ) {
$name = $subscriber->getCustomerFirstname() . ' ' . $subscriber->getCustomerLastname();
}
}
else {
$email = (string) $subscriber;
}
if (Mage::getStoreConfigFlag(Mage_Core_Model_Email_Template::XML_PATH_SENDING_SET_RETURN_PATH)) {
$this->getMail()->setReturnPath($this->getTemplateSenderEmail());
}
ini_set('SMTP', Mage::getStoreConfig('system/smtp/host'));
ini_set('smtp_port', Mage::getStoreConfig('system/smtp/port'));
$mail = $this->getMail();
$mail->addTo($email, $name);
$text = $this->getProcessedTemplate($variables, true);
if ($this->isPlain()) {
$mail->setBodyText($text);
}
else {
$mail->setBodyHTML($text);
}
$mail->setSubject($this->getProcessedTemplateSubject($variables));
$mail->setFrom($this->getTemplateSenderEmail(), $this->getTemplateSenderName());
try {
$mail->send();
$this->_mail = null;
if (!is_null($queue)) {
$subscriber->received($queue);
}
}
catch (Exception $e) {
if ($subscriber instanceof Mage_Newsletter_Model_Subscriber) {
// If letter sent for subscriber, we create a problem report entry
$problem = Mage::getModel('newsletter/problem');
$problem->addSubscriberData($subscriber);
if (!is_null($queue)) {
$problem->addQueueData($queue);
}
$problem->addErrorData($e);
$problem->save();
if (!is_null($queue)) {
$subscriber->received($queue);
}
} else {
// Otherwise throw error to upper level
throw $e;
}
return false;
}
return true;
}
/**
* Prepare Process (with save)
*
* @return Mage_Newsletter_Model_Template
* @deprecated since 1.4.0.1
*/
public function preprocess()
{
$this->_preprocessFlag = true;
$this->save();
$this->_preprocessFlag = false;
return $this;
}
/**
* Retrieve processed template subject
*
* @param array $variables
* @return string
*/
public function getProcessedTemplateSubject(array $variables)
{
$processor = new Varien_Filter_Template();
if (!$this->_preprocessFlag) {
$variables['this'] = $this;
}
$processor->setVariables($variables);
return $processor->filter($this->getTemplateSubject());
}
/**
* Retrieve template text wrapper
*
* @return string
*/
public function getTemplateText()
{
if (!$this->getData('template_text') && !$this->getId()) {
$this->setData('template_text',
Mage::helper('newsletter')->__('Follow this link to unsubscribe <!-- This tag is for unsubscribe link --><a href="{{var subscriber.getUnsubscriptionLink()}}">{{var subscriber.getUnsubscriptionLink()}}</a>')
);
}
return $this->getData('template_text');
}
}