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