-
Notifications
You must be signed in to change notification settings - Fork 36
/
Newsletter.php
executable file
·384 lines (338 loc) · 9.26 KB
/
Newsletter.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
<?php
/**
* Newsletter
*
* This is the main model for Newsletter Newsletters. There are a number of
* methods for getting the counts of all posts, active posts, pending
* posts etc. It extends {@see NewsletterAppModel} for some all round
* functionality. look at {@see NewsletterAppModel::afterSave} for an example
*
* @copyright Copyright (c) 2010 Carl Sutton ( dogmatic69 )
*
* @link http://www.infinitas-cms.org
* @package Infinitas.Newsletter.Model
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
* @since 0.5a
*
* @author Carl Sutton <dogmatic69@infinitas-cms.org>
*/
/**
* Newsletter
*
* @package Infinitas.Newsletter.Model
*
* @property NewsletterCampaign $NewsletterCampaign
* @property NewsletterTemplate $NewsletterTemplate
*/
class Newsletter extends NewsletterAppModel {
/**
* Custom prefix
*/
public $tablePrefix = 'newsletter_';
/**
* For generating lists due to not being convention of name|title
*/
public $displayField = 'subject';
/**
* Custom find methods
*
* @var array
*/
public $findMethods = array(
'toSend' => true,
'paginated' => true,
'preview' => true,
'deleteable' => true,
'email' => true
);
/**
* BelongsTo relations
*
* @var array
*/
public $belongsTo = array(
'NewsletterCampaign' => array(
'className' => 'Newsletter.NewsletterCampaign',
'foreignKey' => 'newsletter_campaign_id',
'counterCache' => 'newsletter_count',
),
'NewsletterTemplate' => array(
'className' => 'Newsletter.NewsletterTemplate',
'counterCache' => 'newsletter_count',
)
);
/**
* Constructor
*
* @param type $id
* @param type $table
* @param type $ds
*
* @return void
*/
public function __construct($id = false, $table = null, $ds = null) {
parent::__construct($id, $table, $ds);
$this->order = array(
$this->alias . '.slug' => 'asc'
);
$this->validate = array(
'newsletter_campaign_id' => array(
'notEmpty' => array(
'rule' => 'notEmpty',
'message' => __d('newsletter', 'Please select the campaign this email belongs to')
)
),
'newsletter_template_id' => array(
'notEmpty' => array(
'rule' => 'notEmpty',
'message' => __d('newsletter', 'Please select the template this email will use')
)
),
'from' => array(
'notEmpty' => array(
'rule' => 'notEmpty',
'message' => __d('newsletter', 'Please enter the from address')
),
'email' => array(
'rule' => array('email', true),
'message' => __d('newsletter', 'Please enter a valid email addres')
)
),
'reply_to' => array(
'notEmpty' => array(
'rule' => 'notEmpty',
'message' => __d('newsletter', 'Please enter the reply to email')
),
'email' => array(
'rule' => array('email', true),
'message' => __d('newsletter', 'Please enter a valid email addres')
)
),
'subject' => array(
'notEmpty' => array(
'rule' => 'notEmpty',
'message' => __d('newsletter', 'Please enter the subject of this newsletter')
)
),
'html' => array(
'notEmpty' => array(
'rule' => 'notEmpty',
'message' => __d('newsletter', 'Please enter the html version of your email')
)
),
'text' => array(
'notEmpty' => array(
'rule' => 'notEmpty',
'message' => __d('newsletter', 'Please enter the text version of your email')
)
)
);
}
/**
* General find
*
* @param string $state
* @param array $query
* @param array $results
*
* @return array
*/
protected function _findPaginated($state, array $query, array $results = array()) {
if ($state == 'before') {
$query['fields'] = array_merge((array)$query['fields'], array(
$this->alias . '.' . $this->primaryKey,
$this->alias . '.slug',
$this->alias . '.newsletter_campaign_id',
$this->alias . '.from',
$this->alias . '.reply_to',
$this->alias . '.subject',
$this->alias . '.active',
$this->alias . '.sent',
$this->alias . '.created',
$this->NewsletterCampaign->alias . '.' . $this->NewsletterCampaign->displayField
));
$query['joins'] = (array)$query['joins'];
$query['joins'][] = $this->autoJoinModel($this->NewsletterCampaign);
return $query;
}
return $results;
}
/**
* Find only active newsletters
*
* @param string $state
* @param array $query
* @param array $results
*
* @return array
*/
protected function _findActive($state, array $query, array $results = array()) {
if ($state == 'before') {
$query['fields'] = array_merge((array)$query['fields'], array(
$this->alias . '.id',
$this->alias . '.html',
$this->alias . '.text',
$this->alias . '.sends',
$this->NewsletterTemplate->fullFieldName('header'),
$this->NewsletterTemplate->fullFieldName('footer'),
));
$query['conditions'] = array_merge((array)$query['conditions'], array(
$this->alias . '.sent' => 0,
$this->alias . '.active' => 1,
));
$query['joins'] = (array)$query['joins'];
$query['joins'][] = $this->autoJoinModel($this->NewsletterTemplate);
return $query;
}
if (empty($results)) {
return array();
}
foreach ($results as &$result) {
$result['User'] = array();
}
return $results;
}
/**
* Find preview data
*
* @param string $state
* @param array $query
* @param array $results
*
* @return array
*
* @throws InvalidArgumentException
*/
protected function _findPreview($state, array $query, array $results = array()) {
if ($state == 'before') {
if (empty($query[0])) {
throw new InvalidArgumentException(__d('newsletter', 'Invalid newsletter selected'));
}
$query['fields'] = array_merge((array)$query['fields'], array(
$this->alias . '.' . $this->primaryKey,
$this->alias . '.html',
$this->NewsletterTemplate->fullFieldName('header'),
$this->NewsletterTemplate->fullFieldName('footer')
));
$query['conditions'] = array_merge((array)$query['conditions'], array(
$this->alias . '.' . $this->primaryKey => $query[0]
));
$query['joins'] = (array)$query['joins'];
$query['joins'][] = $this->autoJoinModel($this->NewsletterTemplate);
$query['limit'] = 1;
return $query;
}
if (empty($results[0])) {
return array();
}
return $results[0];
}
/**
* Get newsletters that can be deleted safely
*
* This method takes list of `ids` and returns a list of ids that can be safely removed.
*
* @param string $state
* @param array $query
* @param array $results
*
* @return array
*
* @throws InvalidArgumentException
*/
protected function _findDeleteable($state, array $query, array $results = array()) {
if ($state == 'before') {
if (empty($query['ids'])) {
throw new InvalidArgumentException(__d('newsletter', 'No newsletters selected'));
}
$query['fields'] = array(
$this->alias . '.' . $this->primaryKey,
);
$query['conditions'] = array_merge((array)$query['conditions'], array(
$this->alias . '.sent' => 0,
$this->alias . '.sends > ' => 0,
$this->alias . '.' . $this->primaryKey => $query['ids']
));
return $query;
}
$results = Hash::extract($results, '{n}.' . $this->alias . '.' . $this->primaryKey);
if (empty($results)) {
throw new CakeException(__d('newsletter', 'Nothing to delete'));
}
return $results;
}
protected function _findEmail($state, array $query, array $results = array()) {
if ($state == 'before') {
if (empty($query[0])) {
throw new CakeException(__d('newsletter', 'No email selected'));
}
$query['fields'] = array_merge((array)$query['fields'], array(
$this->alias . '.' . $this->primaryKey,
$this->alias . '.from',
$this->alias . '.reply_to',
$this->alias . '.subject',
$this->alias . '.html',
$this->alias . '.text',
$this->NewsletterTemplate->alias . '.header',
$this->NewsletterTemplate->alias . '.footer',
));
$query['conditions'] = array_merge((array)$query['conditions'], array(
$this->alias . '.slug' => $query[0]
));
$query['joins'] = (array)$query['joins'];
$query['joins'][] = $this->autoJoinModel($this->NewsletterTemplate);
$query['limit'] = 1;
return $query;
}
if (empty($results[0])) {
throw new CakeException(__d('newsletter', 'No email found'));
}
return $results[0];
}
/**
* toggle the send status
*
* @param string $id the newsletter id to toggle
*
* @return boolean
*
* @throws InvalidArgumentException
*/
public function toggleSend($id) {
$sent = $this->find('first', array(
'fields' => array(
$this->alias . '.' . $this->primaryKey,
$this->alias . '.sent',
$this->alias . '.active'
),
'conditions' => array(
$this->alias . '.' . $this->primaryKey => $id
)
));
if (empty($sent[$this->alias][$this->primaryKey])) {
throw new InvalidArgumentException(__d('newsletter', 'The newsletter was not found'));
}
if ($sent[$this->alias]['sent']) {
throw new InvalidArgumentException(__d('newsletter', 'The newsletter has already been sent'));
}
if (!$sent[$this->alias]['active']) {
$sent[$this->alias]['active'] = 1;
return $this->save($sent[$this->alias]);
}
throw new InvalidArgumentException(__d('newsletter', 'The newsletter is already being sent'));
}
/**
* Stop all current email sending
*
* @return array
*/
public function stopAllSending() {
return $this->updateAll(
array($this->alias . '.active = "0"'),
array(
$this->alias . '.active = "1"',
$this->alias . '.sent = "0"'
)
);
}
}