Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 4.3 | | |
5 | +--------------------------------------------------------------------+ | |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * | |
38 | */ | |
39 | class CRM_Mailing_Form_Schedule extends CRM_Core_Form { | |
40 | ||
41 | /** | |
42 | * Function to set variables up before form is built | |
43 | * | |
44 | * @return void | |
45 | * @access public | |
46 | */ | |
47 | public function preProcess() { | |
48 | if (CRM_Mailing_Info::workflowEnabled() && | |
49 | !CRM_Core_Permission::check('schedule mailings') | |
50 | ) { | |
51 | $url = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'reset=1&scheduled=false'); | |
52 | CRM_Utils_System::redirect($url); | |
53 | } | |
54 | ||
55 | //when user come from search context. | |
56 | $ssID = $this->get('ssID'); | |
57 | $this->assign('ssid',$ssID); | |
58 | $this->_searchBasedMailing = CRM_Contact_Form_Search::isSearchContext($this->get('context')); | |
59 | if(CRM_Contact_Form_Search::isSearchContext($this->get('context')) && !$ssID){ | |
60 | $params = array(); | |
61 | $result = CRM_Core_BAO_PrevNextCache::getSelectedContacts(); | |
62 | $this->assign("value", $result); | |
63 | } | |
64 | $this->_mailingID = $this->get('mailing_id'); | |
65 | $this->_scheduleFormOnly = FALSE; | |
66 | if (!$this->_mailingID) { | |
67 | $this->_mailingID = CRM_Utils_Request::retrieve('mid', 'Integer', $this, TRUE); | |
68 | $this->_scheduleFormOnly = TRUE; | |
69 | } | |
70 | } | |
71 | /** | |
72 | * This function sets the default values for the form. | |
73 | * | |
74 | * @access public | |
75 | * | |
76 | * @return None | |
77 | */ | |
78 | function setDefaultValues() { | |
79 | $defaults = array(); | |
80 | if ($this->_scheduleFormOnly) { | |
81 | $count = CRM_Mailing_BAO_Recipients::mailingSize($this->_mailingID); | |
82 | } | |
83 | else { | |
84 | $count = $this->get('count'); | |
85 | } | |
86 | $this->assign('count', $count); | |
87 | $defaults['now'] = 1; | |
88 | return $defaults; | |
89 | } | |
90 | ||
91 | /** | |
92 | * Build the form for the last step of the mailing wizard | |
93 | * | |
94 | * @param | |
95 | * | |
96 | * @return void | |
97 | * @access public | |
98 | */ | |
99 | public function buildQuickform() { | |
100 | $this->addDateTime('start_date', ts('Schedule Mailing'), FALSE, array('formatType' => 'mailing')); | |
101 | ||
102 | $this->addElement('checkbox', 'now', ts('Send Immediately')); | |
103 | ||
104 | $this->addFormRule(array('CRM_Mailing_Form_Schedule', 'formRule'), $this); | |
105 | ||
106 | if ($this->_scheduleFormOnly) { | |
107 | $title = ts('Schedule Mailing') . ' - ' . CRM_Core_DAO::getFieldValue('CRM_Mailing_DAO_Mailing', | |
108 | $this->_mailingID, | |
109 | 'name' | |
110 | ); | |
111 | CRM_Utils_System::setTitle($title); | |
112 | $buttons = array( | |
113 | array('type' => 'next', | |
114 | 'name' => ts('Submit Mailing'), | |
115 | 'spacing' => ' ', | |
116 | 'isDefault' => TRUE, | |
117 | ), | |
118 | array( | |
119 | 'type' => 'cancel', | |
120 | 'name' => ts('Cancel'), | |
121 | ), | |
122 | ); | |
123 | } | |
124 | else { | |
125 | //FIXME : currently we are hiding save an continue later when | |
126 | //search base mailing, we should handle it when we fix CRM-3876 | |
127 | if ($this->_searchBasedMailing) { | |
128 | $buttons = array( | |
129 | array('type' => 'back', | |
130 | 'name' => ts('<< Previous'), | |
131 | ), | |
132 | array( | |
133 | 'type' => 'next', | |
134 | 'name' => ts('Submit Mailing'), | |
135 | 'spacing' => ' ', | |
136 | 'isDefault' => TRUE, | |
137 | ), | |
138 | ); | |
139 | } | |
140 | else { | |
141 | $buttons = array( | |
142 | array('type' => 'back', | |
143 | 'name' => ts('<< Previous'), | |
144 | ), | |
145 | array( | |
146 | 'type' => 'next', | |
147 | 'name' => ts('Submit Mailing'), | |
148 | 'spacing' => ' ', | |
149 | 'isDefault' => TRUE, | |
150 | 'js' => array('onclick' => "return submitOnce(this,'" . $this->_name . "','" . ts('Processing') . "');"), | |
151 | ), | |
152 | array( | |
153 | 'type' => 'cancel', | |
154 | 'name' => ts('Continue Later'), | |
155 | ), | |
156 | ); | |
157 | } | |
158 | } | |
159 | $this->addButtons($buttons); | |
160 | ||
161 | if (CRM_Mailing_Info::workflowEnabled() && | |
162 | $this->_scheduleFormOnly | |
163 | ) { | |
164 | // add the preview elements | |
165 | $preview = array(); | |
166 | $preview['type'] = CRM_Core_DAO::getFieldValue('CRM_Mailing_DAO_Mailing', $this->_mailingID, 'body_html') ? 'html' : 'text'; | |
167 | $preview['subject'] = CRM_Core_DAO::getFieldValue('CRM_Mailing_DAO_Mailing', | |
168 | $this->_mailingID, | |
169 | 'subject' | |
170 | ); | |
171 | $preview['viewURL'] = CRM_Utils_System::url('civicrm/mailing/view', "reset=1&id={$this->_mailingID}"); | |
172 | ||
173 | $preview['attachment'] = CRM_Core_BAO_File::attachmentInfo('civicrm_mailing', $this->_mailingID); | |
174 | ||
175 | $this->assign_by_ref('preview', $preview); | |
176 | } | |
177 | } | |
178 | ||
179 | /** | |
180 | * Form rule to validate the date selector and/or if we should deliver | |
181 | * immediately. | |
182 | * | |
183 | * Warning: if you make changes here, be sure to also make them in | |
184 | * Retry.php | |
185 | * | |
186 | * @param array $params The form values | |
187 | * | |
188 | * @return boolean True if either we deliver immediately, or the | |
189 | * date is properly set. | |
190 | * @static | |
191 | */ | |
192 | public static function formRule($params, $files, $self) { | |
193 | if (!empty($params['_qf_Schedule_submit'])) { | |
194 | //when user perform mailing from search context | |
195 | //redirect it to search result CRM-3711. | |
196 | $ssID = $self->get('ssID'); | |
197 | if ($ssID && $self->_searchBasedMailing) { | |
198 | if ($self->_action == CRM_Core_Action::BASIC) { | |
199 | $fragment = 'search'; | |
200 | } | |
201 | elseif ($self->_action == CRM_Core_Action::PROFILE) { | |
202 | $fragment = 'search/builder'; | |
203 | } | |
204 | elseif ($self->_action == CRM_Core_Action::ADVANCED) { | |
205 | $fragment = 'search/advanced'; | |
206 | } | |
207 | else { | |
208 | $fragment = 'search/custom'; | |
209 | } | |
210 | ||
211 | $draftURL = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1'); | |
212 | $status = ts("Your mailing has been saved. You can continue later by clicking the 'Continue' action to resume working on it.<br />From <a href='%1'>Draft and Unscheduled Mailings</a>.", array(1 => $draftURL)); | |
213 | CRM_Core_Session::setStatus($status, ts('Mailing Saved'), 'success'); | |
214 | ||
215 | //replace user context to search. | |
216 | $context = $self->get('context'); | |
217 | if (!CRM_Contact_Form_Search::isSearchContext($context)) { | |
218 | $context = 'search'; | |
219 | } | |
220 | ||
221 | $urlParams = "force=1&reset=1&ssID={$ssID}&context={$context}"; | |
222 | $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this); | |
223 | if (CRM_Utils_Rule::qfKey($qfKey)) { | |
224 | $urlParams .= "&qfKey=$qfKey"; | |
225 | } | |
226 | $url = CRM_Utils_System::url('civicrm/contact/' . $fragment, "force=1&reset=1&ssID={$ssID}"); | |
227 | } | |
228 | else { | |
229 | $status = ts("Click the 'Continue' action to resume working on it."); | |
230 | $url = CRM_Utils_System::url('civicrm/mailing/browse/unscheduled', 'scheduled=false&reset=1'); | |
231 | } | |
232 | CRM_Core_Session::setStatus($status, ts('Mailing Saved'), 'success'); | |
233 | CRM_Utils_System::redirect($url); | |
234 | } | |
235 | if (isset($params['now']) || CRM_Utils_Array::value('_qf_Schedule_back', $params) == '<< Previous') { | |
236 | return TRUE; | |
237 | } | |
238 | ||
239 | if (CRM_Utils_Date::format(CRM_Utils_Date::processDate($params['start_date'], | |
240 | $params['start_date_time'] | |
241 | )) < CRM_Utils_Date::format(date('YmdHi00'))) { | |
242 | return array( | |
243 | 'start_date' => | |
244 | ts('Start date cannot be earlier than the current time.'), | |
245 | ); | |
246 | } | |
247 | return TRUE; | |
248 | } | |
249 | ||
250 | /** | |
251 | * Process the posted form values. Create and schedule a mailing. | |
252 | * | |
253 | * @param | |
254 | * | |
255 | * @return void | |
256 | * @access public | |
257 | */ | |
258 | public function postProcess() { | |
259 | $params = array(); | |
260 | ||
261 | $params['mailing_id'] = $ids['mailing_id'] = $this->_mailingID; | |
262 | ||
263 | if (empty($params['mailing_id'])) { | |
264 | CRM_Core_Error::fatal(ts('Could not find a mailing id')); | |
265 | } | |
266 | ||
267 | foreach (array('now', 'start_date', 'start_date_time') as $parameter) { | |
268 | $params[$parameter] = $this->controller->exportValue($this->_name, $parameter); | |
269 | } | |
270 | ||
271 | ||
272 | // Previously, we checked if $mailing->is_template, and did *not* | |
273 | // schedule if it was set. Discussed with Lobo, removed that check | |
274 | // as it appeared to prevent mails being scheduled if they were | |
275 | // saved as a template, and this wasn't the documented behaviour. | |
276 | // $saveTemplate = $this->controller->exportValue('saveTemplate'); | |
6a488035 TO |
277 | if ($params['now']) { |
278 | $params['scheduled_date'] = date('YmdHis'); | |
279 | } | |
280 | else { | |
281 | $params['scheduled_date'] = CRM_Utils_Date::processDate($params['start_date'] . ' ' . $params['start_date_time']); | |
282 | } | |
283 | ||
284 | $session = CRM_Core_Session::singleton(); | |
285 | // set the scheduled_id | |
286 | $params['scheduled_id'] = $session->get('userID'); | |
287 | $params['scheduled_date'] = date('YmdHis'); | |
6a488035 TO |
288 | |
289 | // set approval details if workflow is not enabled | |
290 | if (!CRM_Mailing_Info::workflowEnabled()) { | |
291 | $params['approver_id'] = $session->get('userID'); | |
292 | $params['approval_date'] = date('YmdHis'); | |
293 | $params['approval_status_id'] = 1; | |
294 | } | |
295 | else { | |
296 | // reset them in case this mailing was rejected | |
297 | $mailing->approver_id = 'null'; | |
298 | $mailing->approval_date = 'null'; | |
299 | $mailing->approval_status_id = 'null'; | |
300 | } | |
301 | ||
302 | if ($params['now']) { | |
303 | $params['scheduled_date'] = date('YmdHis'); | |
304 | } | |
305 | else { | |
306 | $params['scheduled_date'] = CRM_Utils_Date::processDate($params['start_date'] . ' ' . $params['start_date_time']); | |
307 | } | |
308 | ||
309 | /* Build the mailing object */ | |
310 | CRM_Mailing_BAO_Mailing::create($params, $ids); | |
311 | ||
312 | //when user perform mailing from search context | |
313 | //redirect it to search result CRM-3711. | |
314 | $ssID = $this->get('ssID'); | |
315 | if ($ssID && $this->_searchBasedMailing && !CRM_Mailing_Info::workflowEnabled()) { | |
316 | if ($this->_action == CRM_Core_Action::BASIC) { | |
317 | $fragment = 'search'; | |
318 | } | |
319 | elseif ($this->_action == CRM_Core_Action::PROFILE) { | |
320 | $fragment = 'search/builder'; | |
321 | } | |
322 | elseif ($this->_action == CRM_Core_Action::ADVANCED) { | |
323 | $fragment = 'search/advanced'; | |
324 | } | |
325 | else { | |
326 | $fragment = 'search/custom'; | |
327 | } | |
328 | $context = $this->get('context'); | |
329 | if (!CRM_Contact_Form_Search::isSearchContext($context)) { | |
330 | $context = 'search'; | |
331 | } | |
332 | $urlParams = "force=1&reset=1&ssID={$ssID}&context={$context}"; | |
333 | $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this); | |
334 | if (CRM_Utils_Rule::qfKey($qfKey)) { | |
335 | $urlParams .= "&qfKey=$qfKey"; | |
336 | } | |
337 | ||
338 | $url = CRM_Utils_System::url('civicrm/contact/' . $fragment, $urlParams); | |
339 | return $this->controller->setDestination($url); | |
340 | } | |
341 | ||
342 | $session = CRM_Core_Session::singleton(); | |
343 | $session->pushUserContext(CRM_Utils_System::url('civicrm/mailing/browse/scheduled', | |
344 | 'reset=1&scheduled=true' | |
345 | )); | |
346 | } | |
347 | ||
348 | /** | |
349 | * Display Name of the form | |
350 | * | |
351 | * @access public | |
352 | * | |
353 | * @return string | |
354 | */ | |
355 | public function getTitle() { | |
356 | return ts('Schedule or Send'); | |
357 | } | |
358 | } | |
359 |