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