Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
4e580cdf | 29 | * Class CRM_Report_Form_Instance |
6a488035 TO |
30 | */ |
31 | class CRM_Report_Form_Instance { | |
32 | ||
74cf4551 | 33 | /** |
4e580cdf EM |
34 | * Build form. |
35 | * | |
c490a46a | 36 | * @param CRM_Core_Form $form |
74cf4551 | 37 | */ |
00be9182 | 38 | public static function buildForm(&$form) { |
4e580cdf | 39 | // We should not build form elements in dashlet mode. |
6a488035 TO |
40 | if ($form->_section) { |
41 | return; | |
42 | } | |
43 | ||
4e580cdf | 44 | // Check role based permission. |
6a488035 TO |
45 | $instanceID = $form->getVar('_id'); |
46 | if ($instanceID && !CRM_Report_Utils_Report::isInstanceGroupRoleAllowed($instanceID)) { | |
47 | $url = CRM_Utils_System::url('civicrm/report/list', 'reset=1'); | |
48 | CRM_Core_Error::statusBounce(ts('You do not have permission to access this report.'), | |
49 | $url | |
50 | ); | |
51 | } | |
52 | ||
0b25329b | 53 | $attributes = CRM_Core_DAO::getAttribute('CRM_Report_DAO_ReportInstance'); |
6a488035 TO |
54 | |
55 | $form->add('text', | |
56 | 'title', | |
57 | ts('Report Title'), | |
58 | $attributes['title'] | |
59 | ); | |
60 | ||
61 | $form->add('text', | |
62 | 'description', | |
63 | ts('Report Description'), | |
64 | $attributes['description'] | |
65 | ); | |
66 | ||
67 | $form->add('text', | |
68 | 'email_subject', | |
69 | ts('Subject'), | |
70 | $attributes['email_subject'] | |
71 | ); | |
72 | ||
73 | $form->add('text', | |
74 | 'email_to', | |
75 | ts('To'), | |
76 | $attributes['email_to'] | |
77 | ); | |
78 | ||
79 | $form->add('text', | |
80 | 'email_cc', | |
81 | ts('CC'), | |
82 | $attributes['email_subject'] | |
83 | ); | |
74cf4551 | 84 | |
a8f56d71 | 85 | $form->add('number', |
dbb4a0f9 PN |
86 | 'row_count', |
87 | ts('Limit Dashboard Results'), | |
be2fb01f | 88 | ['class' => 'four', 'min' => 1] |
dbb4a0f9 | 89 | ); |
74cf4551 | 90 | |
6a488035 TO |
91 | $form->add('textarea', |
92 | 'report_header', | |
93 | ts('Report Header'), | |
94 | $attributes['header'] | |
95 | ); | |
96 | ||
97 | $form->add('textarea', | |
98 | 'report_footer', | |
99 | ts('Report Footer'), | |
100 | $attributes['footer'] | |
101 | ); | |
102 | ||
103 | $form->addElement('checkbox', 'is_navigation', ts('Include Report in Navigation Menu?'), NULL, | |
be2fb01f | 104 | ['onclick' => "return showHideByValue('is_navigation','','navigation_menu','table-row','radio',false);"] |
6a488035 TO |
105 | ); |
106 | ||
be2fb01f | 107 | $form->addElement('select', 'view_mode', ts('Configure link to...'), [ |
e6e7e540 | 108 | 'view' => ts('View Results'), |
109 | 'criteria' => ts('Show Criteria'), | |
be2fb01f | 110 | ]); |
e6e7e540 | 111 | |
a8f56d71 | 112 | $form->addElement('checkbox', 'addToDashboard', ts('Available for Dashboard?')); |
be2fb01f | 113 | $form->add('number', 'cache_minutes', ts('Cache dashlet for'), ['class' => 'four', 'min' => 1]); |
0f8c6e58 | 114 | $form->addElement('checkbox', 'add_to_my_reports', ts('Add to My Reports?'), NULL); |
115 | ||
6a488035 TO |
116 | $form->addElement('checkbox', 'is_reserved', ts('Reserved Report?')); |
117 | if (!CRM_Core_Permission::check('administer reserved reports')) { | |
118 | $form->freeze('is_reserved'); | |
119 | } | |
120 | ||
121 | $config = CRM_Core_Config::singleton(); | |
122 | if ($config->userFramework != 'Joomla' || | |
123 | $config->userFramework != 'WordPress' | |
124 | ) { | |
125 | $form->addElement('select', | |
126 | 'permission', | |
127 | ts('Permission'), | |
be2fb01f | 128 | ['0' => ts('Everyone (includes anonymous)')] + CRM_Core_Permission::basicPermissions() |
6a488035 TO |
129 | ); |
130 | ||
131 | // prepare user_roles to save as names not as ids | |
132 | if (function_exists('user_roles')) { | |
133 | $user_roles_array = user_roles(); | |
134 | foreach ($user_roles_array as $key => $value) { | |
135 | $user_roles[$value] = $value; | |
136 | } | |
1c6954cb | 137 | $grouprole = &$form->addElement('advmultiselect', |
6a488035 TO |
138 | 'grouprole', |
139 | ts('ACL Group/Role'), | |
140 | $user_roles, | |
be2fb01f | 141 | [ |
6a488035 TO |
142 | 'size' => 5, |
143 | 'style' => 'width:240px', | |
144 | 'class' => 'advmultiselect', | |
be2fb01f | 145 | ] |
6a488035 | 146 | ); |
be2fb01f CW |
147 | $grouprole->setButtonAttributes('add', ['value' => ts('Add >>')]); |
148 | $grouprole->setButtonAttributes('remove', ['value' => ts('<< Remove')]); | |
6a488035 TO |
149 | } |
150 | } | |
151 | ||
152 | // navigation field | |
153 | $parentMenu = CRM_Core_BAO_Navigation::getNavigationList(); | |
154 | ||
be2fb01f | 155 | $form->add('select', 'parent_id', ts('Parent Menu'), ['' => ts('- select -')] + $parentMenu); |
6a488035 TO |
156 | |
157 | // For now we only providing drilldown for one primary detail report only. In future this could be multiple reports | |
158 | foreach ($form->_drilldownReport as $reportUrl => $drillLabel) { | |
159 | $instanceList = CRM_Report_Utils_Report::getInstanceList($reportUrl); | |
84178120 | 160 | if (count($instanceList) > 1) { |
be2fb01f | 161 | $form->add('select', 'drilldown_id', $drillLabel, ['' => ts('- select -')] + $instanceList); |
84178120 | 162 | } |
6a488035 TO |
163 | break; |
164 | } | |
165 | ||
be2fb01f CW |
166 | $form->addButtons([ |
167 | [ | |
6a488035 TO |
168 | 'type' => 'submit', |
169 | 'name' => ts('Save Report'), | |
170 | 'isDefault' => TRUE, | |
be2fb01f CW |
171 | ], |
172 | [ | |
6a488035 TO |
173 | 'type' => 'cancel', |
174 | 'name' => ts('Cancel'), | |
be2fb01f CW |
175 | ], |
176 | ] | |
6a488035 TO |
177 | ); |
178 | ||
be2fb01f | 179 | $form->addFormRule(['CRM_Report_Form_Instance', 'formRule'], $form); |
6a488035 TO |
180 | } |
181 | ||
74cf4551 | 182 | /** |
4e580cdf EM |
183 | * Add form rules. |
184 | * | |
185 | * @param array $fields | |
186 | * @param array $errors | |
187 | * @param CRM_Report_Form_Instance $self | |
74cf4551 EM |
188 | * |
189 | * @return array|bool | |
190 | */ | |
00be9182 | 191 | public static function formRule($fields, $errors, $self) { |
4e580cdf | 192 | // Validate both the "next" and "save" buttons for creating/updating a report. |
c9cf6554 CW |
193 | $nextButton = $self->controller->getButtonName(); |
194 | $saveButton = str_replace('_next', '_save', $nextButton); | |
195 | $clickedButton = $self->getVar('_instanceButtonName'); | |
6a488035 | 196 | |
be2fb01f | 197 | $errors = []; |
c9cf6554 | 198 | if ($clickedButton == $nextButton || $clickedButton == $saveButton) { |
6a488035 | 199 | if (empty($fields['title'])) { |
161f6a74 | 200 | $errors['title'] = ts('Title is a required field.'); |
6a488035 TO |
201 | $self->assign('instanceFormError', TRUE); |
202 | } | |
203 | } | |
204 | ||
205 | return empty($errors) ? TRUE : $errors; | |
206 | } | |
207 | ||
74cf4551 | 208 | /** |
4e580cdf EM |
209 | * Set default values. |
210 | * | |
c490a46a | 211 | * @param CRM_Core_Form $form |
4e580cdf | 212 | * @param array $defaults |
74cf4551 | 213 | */ |
00be9182 | 214 | public static function setDefaultValues(&$form, &$defaults) { |
4e580cdf | 215 | // we should not build form elements in dashlet mode. |
6a488035 TO |
216 | if ($form->_section) { |
217 | return; | |
218 | } | |
219 | ||
220 | $instanceID = $form->getVar('_id'); | |
be2fb01f | 221 | $navigationDefaults = []; |
6a488035 | 222 | |
9b873358 | 223 | if (!isset($defaults['permission'])) { |
f420456d | 224 | $defaults['permission'] = 'access CiviReport'; |
6a488035 TO |
225 | } |
226 | ||
1a7356e7 | 227 | $userFrameworkResourceURL = CRM_Core_Config::singleton()->userFrameworkResourceURL; |
78b06a37 AH |
228 | |
229 | // Add a special region for the default HTML header of printed reports. It | |
230 | // won't affect reports with customized headers, just ones with the default. | |
231 | $printHeaderRegion = CRM_Core_Region::instance('default-report-header', FALSE); | |
232 | $htmlHeader = ($printHeaderRegion) ? $printHeaderRegion->render('', FALSE) : ''; | |
233 | ||
6a488035 TO |
234 | $defaults['report_header'] = $report_header = "<html> |
235 | <head> | |
236 | <title>CiviCRM Report</title> | |
237 | <meta http-equiv='Content-Type' content='text/html; charset=utf-8' /> | |
1a7356e7 | 238 | <style type=\"text/css\">@import url({$userFrameworkResourceURL}css/print.css);</style> |
78b06a37 | 239 | {$htmlHeader} |
6a488035 TO |
240 | </head> |
241 | <body><div id=\"crm-container\">"; | |
242 | ||
1a7356e7 | 243 | $defaults['report_footer'] = $report_footer = "<p><img src=\"{$userFrameworkResourceURL}i/powered_by.png\" /></p></div></body> |
6a488035 TO |
244 | </html> |
245 | "; | |
246 | ||
e6e7e540 | 247 | // CRM-17225 view_mode currently supports 'view' or 'criteria'. |
248 | // Prior to 4.7 'view' meant reset=1 in the url & if not set | |
249 | // then show criteria. | |
250 | // From 4.7 we will pro-actively set 'force=1' but still respect the old behaviour. | |
251 | // we may look to add pdf, print_view, csv & various charts as these could simply | |
252 | // be added to the url allowing us to conceptualise 'view right now' vs saved view | |
253 | // & using a multiselect (option value?) could help here. | |
254 | // Note that accessing reports without reset=1 in the url turns out to be | |
255 | // dangerous as it seems to carry actions like 'delete' from one report to another. | |
256 | $defaults['view_mode'] = 'view'; | |
257 | $output = CRM_Utils_Request::retrieve('output', 'String'); | |
258 | if ($output == 'criteria') { | |
259 | $defaults['view_mode'] = 'criteria'; | |
260 | } | |
261 | ||
a8f56d71 CW |
262 | if (empty($defaults['cache_minutes'])) { |
263 | $defaults['cache_minutes'] = '60'; | |
264 | } | |
265 | ||
6a488035 TO |
266 | if ($instanceID) { |
267 | // this is already retrieved via Form.php | |
268 | $defaults['description'] = CRM_Utils_Array::value('description', $defaults); | |
0642ec63 AH |
269 | if (!empty($defaults['header'])) { |
270 | $defaults['report_header'] = $defaults['header']; | |
271 | } | |
272 | if (!empty($defaults['footer'])) { | |
273 | $defaults['report_footer'] = $defaults['footer']; | |
274 | } | |
6a488035 | 275 | |
0f8c6e58 | 276 | // CRM-17310 private reports option. |
277 | $defaults['add_to_my_reports'] = 0; | |
278 | if (CRM_Utils_Array::value('owner_id', $defaults) != NULL) { | |
279 | $defaults['add_to_my_reports'] = 1; | |
280 | } | |
281 | ||
a7488080 | 282 | if (!empty($defaults['navigation_id'])) { |
734d3871 | 283 | // Get the default navigation parent id. |
be2fb01f | 284 | $params = ['id' => $defaults['navigation_id']]; |
6a488035 TO |
285 | CRM_Core_BAO_Navigation::retrieve($params, $navigationDefaults); |
286 | $defaults['is_navigation'] = 1; | |
287 | $defaults['parent_id'] = CRM_Utils_Array::value('parent_id', $navigationDefaults); | |
a7488080 | 288 | if (!empty($navigationDefaults['is_active'])) { |
6a488035 TO |
289 | $form->assign('is_navigation', TRUE); |
290 | } | |
e6e7e540 | 291 | // A saved view mode will over-ride any url assumptions. |
292 | if (strpos($navigationDefaults['url'], 'output=criteria')) { | |
293 | $defaults['view_mode'] = 'criteria'; | |
294 | } | |
6a488035 | 295 | |
a7488080 | 296 | if (!empty($navigationDefaults['id'])) { |
6a488035 | 297 | $form->_navigation['id'] = $navigationDefaults['id']; |
734d3871 EM |
298 | $form->_navigation['parent_id'] = !empty($navigationDefaults['parent_id']) ? |
299 | $navigationDefaults['parent_id'] : NULL; | |
6a488035 TO |
300 | } |
301 | } | |
302 | ||
a7488080 | 303 | if (!empty($defaults['grouprole'])) { |
6a488035 | 304 | foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $defaults['grouprole']) as $value) { |
4e580cdf | 305 | $groupRoles[] = $value; |
6a488035 | 306 | } |
4e580cdf | 307 | $defaults['grouprole'] = $groupRoles; |
6a488035 TO |
308 | } |
309 | } | |
4c9b6178 | 310 | elseif (property_exists($form, '_description')) { |
6a488035 TO |
311 | $defaults['description'] = $form->_description; |
312 | } | |
313 | } | |
314 | ||
74cf4551 | 315 | /** |
4e580cdf EM |
316 | * Post process function. |
317 | * | |
c490a46a | 318 | * @param CRM_Core_Form $form |
74cf4551 EM |
319 | * @param bool $redirect |
320 | */ | |
00be9182 | 321 | public static function postProcess(&$form, $redirect = TRUE) { |
81583117 | 322 | $params = $form->getVar('_params'); |
6a488035 | 323 | $instanceID = $form->getVar('_id'); |
f813f78e | 324 | |
6ea7a229 | 325 | if ($isNew = $form->getVar('_createNew')) { |
e41b14ce DS |
326 | // set the report_id since base template is going to be same, and we going to unset $instanceID |
327 | // which will make it difficult later on, to compute report_id | |
328 | $params['report_id'] = CRM_Report_Utils_Report::getValueFromUrl($instanceID); | |
4e580cdf EM |
329 | // Unset $instanceID so a new copy would be created. |
330 | $instanceID = NULL; | |
6a488035 | 331 | } |
6ea7a229 | 332 | $params['instance_id'] = $instanceID; |
a7488080 | 333 | if (!empty($params['is_navigation'])) { |
6ea7a229 | 334 | $params['navigation'] = $form->_navigation; |
6a488035 | 335 | } |
9b873358 | 336 | elseif ($instanceID) { |
4e580cdf | 337 | // Delete navigation if exists. |
81583117 BS |
338 | $navId = CRM_Core_DAO::getFieldValue('CRM_Report_DAO_ReportInstance', $instanceID, 'navigation_id', 'id'); |
339 | if ($navId) { | |
340 | CRM_Core_BAO_Navigation::processDelete($navId); | |
341 | CRM_Core_BAO_Navigation::resetNavigation(); | |
342 | } | |
343 | } | |
6a488035 | 344 | |
c5958fbe DS |
345 | // make a copy of params |
346 | $formValues = $params; | |
347 | ||
348 | // unset params from $formValues that doesn't match with DB columns of instance tables, and also not required in form-values for sure | |
be2fb01f | 349 | $unsetFields = [ |
353ffa53 TO |
350 | 'title', |
351 | 'to_emails', | |
352 | 'cc_emails', | |
353 | 'header', | |
354 | 'footer', | |
355 | 'qfKey', | |
356 | 'id', | |
357 | '_qf_default', | |
358 | 'report_header', | |
359 | 'report_footer', | |
360 | 'grouprole', | |
87ecd5b7 | 361 | 'task', |
be2fb01f | 362 | ]; |
c5958fbe DS |
363 | foreach ($unsetFields as $field) { |
364 | unset($formValues[$field]); | |
365 | } | |
e6e7e540 | 366 | $view_mode = $formValues['view_mode']; |
0f8c6e58 | 367 | |
368 | // CRM-17310 my reports functionality - we should set owner if the checkbox is 1, | |
369 | // it seems to be not set at all if unchecked. | |
370 | if (!empty($formValues['add_to_my_reports'])) { | |
3bdcd4ec | 371 | $params['owner_id'] = CRM_Core_Session::getLoggedInContactID(); |
0f8c6e58 | 372 | } |
373 | else { | |
374 | $params['owner_id'] = 'null'; | |
375 | } | |
376 | unset($formValues['add_to_my_reports']); | |
377 | ||
c5958fbe DS |
378 | // pass form_values as string |
379 | $params['form_values'] = serialize($formValues); | |
380 | ||
0b25329b | 381 | $instance = CRM_Report_BAO_ReportInstance::create($params); |
6ea7a229 | 382 | $form->set('id', $instance->id); |
6a488035 TO |
383 | |
384 | if ($instanceID && !$isNew) { | |
385 | // updating existing instance | |
be2fb01f | 386 | $statusMsg = ts('"%1" report has been updated.', [1 => $instance->title]); |
0db6c3e1 TO |
387 | } |
388 | elseif ($form->getVar('_id') && $isNew) { | |
be2fb01f | 389 | $statusMsg = ts('Your report has been successfully copied as "%1". You are currently viewing the new copy.', [1 => $instance->title]); |
0db6c3e1 TO |
390 | } |
391 | else { | |
be2fb01f | 392 | $statusMsg = ts('"%1" report has been successfully created. You are currently viewing the new report instance.', [1 => $instance->title]); |
6a488035 | 393 | } |
6a488035 TO |
394 | CRM_Core_Session::setStatus($statusMsg); |
395 | ||
481a74f4 | 396 | if ($redirect) { |
be2fb01f | 397 | $urlParams = ['reset' => 1]; |
e6e7e540 | 398 | if ($view_mode == 'view') { |
399 | $urlParams['force'] = 1; | |
400 | } | |
401 | else { | |
402 | $urlParams['output'] = 'criteria'; | |
403 | } | |
404 | CRM_Utils_System::redirect(CRM_Utils_System::url("civicrm/report/instance/{$instance->id}", $urlParams)); | |
6a488035 TO |
405 | } |
406 | } | |
96025800 | 407 | |
6a488035 | 408 | } |