CRM/Report/Form/Instance.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   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       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * Class CRM_Report_Form_Instance
  14  */
  15 class CRM_Report_Form_Instance {
  16
  17   /**
  18    * Build form.
  19    *
  20    * @param CRM_Core_Form $form
  21    */
  22   public static function buildForm(&$form) {
  23     // We should not build form elements in dashlet mode.
  24     if ($form->_section) {
  25       return;
  26     }
  27
  28     // Check role based permission.
  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
  37     $attributes = CRM_Core_DAO::getAttribute('CRM_Report_DAO_ReportInstance');
  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     );
  68
  69     $form->add('number',
  70       'row_count',
  71       ts('Limit Dashboard Results'),
  72       ['class' => 'four', 'min' => 1]
  73     );
  74
  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,
  88       ['onclick' => "return showHideByValue('is_navigation','','navigation_menu','table-row','radio',false);"]
  89     );
  90
  91     $form->addElement('select', 'view_mode', ts('Configure link to...'), [
  92       'view' => ts('View Results'),
  93       'criteria' => ts('Show Criteria'),
  94     ]);
  95
  96     $form->addElement('checkbox', 'addToDashboard', ts('Available for Dashboard?'));
  97     $form->add('number', 'cache_minutes', ts('Cache dashlet for'), ['class' => 'four', 'min' => 1]);
  98     $form->addElement('checkbox', 'add_to_my_reports', ts('Add to My Reports?'), NULL);
  99
 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     $form->addElement('select',
 106       'permission',
 107       ts('Permission'),
 108       ['0' => ts('Everyone (includes anonymous)')] + CRM_Core_Permission::basicPermissions()
 109     );
 110
 111     // prepare user_roles to save as names not as ids
 112     if ($user_roles = CRM_Core_Config::singleton()->userSystem->getRoleNames()) {
 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')]);
 125     }
 126
 127     // navigation field
 128     $parentMenu = CRM_Core_BAO_Navigation::getNavigationList();
 129
 130     $form->add('select', 'parent_id', ts('Parent Menu'), ['' => ts('- select -')] + $parentMenu);
 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);
 135       if (count($instanceList) > 1) {
 136         $form->add('select', 'drilldown_id', $drillLabel, ['' => ts('- select -')] + $instanceList);
 137       }
 138       break;
 139     }
 140
 141     $form->addButtons([
 142         [
 143           'type' => 'submit',
 144           'name' => ts('Save Report'),
 145           'isDefault' => TRUE,
 146         ],
 147         [
 148           'type' => 'cancel',
 149           'name' => ts('Cancel'),
 150         ],
 151     ]);
 152
 153     $form->addFormRule(['CRM_Report_Form_Instance', 'formRule'], $form);
 154   }
 155
 156   /**
 157    * Add form rules.
 158    *
 159    * @param array $fields
 160    * @param array $errors
 161    * @param CRM_Report_Form_Instance $self
 162    *
 163    * @return array|bool
 164    */
 165   public static function formRule($fields, $errors, $self) {
 166     // Validate both the "next" and "save" buttons for creating/updating a report.
 167     $nextButton = $self->controller->getButtonName();
 168     $saveButton = str_replace('_next', '_save', $nextButton);
 169     $clickedButton = $self->getVar('_instanceButtonName');
 170
 171     $errors = [];
 172     if ($clickedButton == $nextButton || $clickedButton == $saveButton) {
 173       if (empty($fields['title'])) {
 174         $errors['title'] = ts('Title is a required field.');
 175         $self->assign('instanceFormError', TRUE);
 176       }
 177     }
 178
 179     return empty($errors) ? TRUE : $errors;
 180   }
 181
 182   /**
 183    * Set default values.
 184    *
 185    * @param CRM_Core_Form $form
 186    * @param array $defaults
 187    */
 188   public static function setDefaultValues(&$form, &$defaults) {
 189     // we should not build form elements in dashlet mode.
 190     if ($form->_section) {
 191       return;
 192     }
 193
 194     $instanceID = $form->getVar('_id');
 195     $navigationDefaults = [];
 196
 197     if (!isset($defaults['permission'])) {
 198       $defaults['permission'] = 'access CiviReport';
 199     }
 200
 201     $userFrameworkResourceURL = CRM_Core_Config::singleton()->userFrameworkResourceURL;
 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
 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' />
 212     <style type=\"text/css\">@import url({$userFrameworkResourceURL}css/print.css);</style>
 213     {$htmlHeader}
 214   </head>
 215   <body><div id=\"crm-container\">";
 216
 217     $defaults['report_footer'] = $report_footer = "<p><img src=\"{$userFrameworkResourceURL}i/powered_by.png\" /></p></div></body>
 218 </html>
 219 ";
 220
 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
 236     if (empty($defaults['cache_minutes'])) {
 237       $defaults['cache_minutes'] = '60';
 238     }
 239
 240     if ($instanceID) {
 241       // this is already retrieved via Form.php
 242       $defaults['description'] = $defaults['description'] ?? NULL;
 243       if (!empty($defaults['header'])) {
 244         $defaults['report_header'] = $defaults['header'];
 245       }
 246       if (!empty($defaults['footer'])) {
 247         $defaults['report_footer'] = $defaults['footer'];
 248       }
 249
 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
 256       if (!empty($defaults['navigation_id'])) {
 257         // Get the default navigation parent id.
 258         $params = ['id' => $defaults['navigation_id']];
 259         CRM_Core_BAO_Navigation::retrieve($params, $navigationDefaults);
 260         $defaults['is_navigation'] = 1;
 261         $defaults['parent_id'] = $navigationDefaults['parent_id'] ?? NULL;
 262         if (!empty($navigationDefaults['is_active'])) {
 263           $form->assign('is_navigation', TRUE);
 264         }
 265         // A saved view mode will over-ride any url assumptions.
 266         if (strpos($navigationDefaults['url'], 'output=criteria')) {
 267           $defaults['view_mode'] = 'criteria';
 268         }
 269
 270         if (!empty($navigationDefaults['id'])) {
 271           $form->_navigation['id'] = $navigationDefaults['id'];
 272           $form->_navigation['parent_id'] = !empty($navigationDefaults['parent_id']) ?
 273           $navigationDefaults['parent_id'] : NULL;
 274         }
 275       }
 276
 277       if (!empty($defaults['grouprole'])) {
 278         foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $defaults['grouprole']) as $value) {
 279           $groupRoles[] = $value;
 280         }
 281         $defaults['grouprole'] = $groupRoles;
 282       }
 283     }
 284     elseif (property_exists($form, '_description')) {
 285       $defaults['description'] = $form->_description;
 286     }
 287   }
 288
 289   /**
 290    * Post process function.
 291    *
 292    * @param CRM_Core_Form $form
 293    * @param bool $redirect
 294    */
 295   public static function postProcess(&$form, $redirect = TRUE) {
 296     $params = $form->getVar('_params');
 297     $instanceID = $form->getVar('_id');
 298
 299     if ($isNew = $form->getVar('_createNew')) {
 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);
 303       // Unset $instanceID so a new copy would be created.
 304       $instanceID = NULL;
 305     }
 306     $params['instance_id'] = $instanceID;
 307     if (!empty($params['is_navigation'])) {
 308       $params['navigation'] = $form->_navigation;
 309     }
 310     elseif ($instanceID) {
 311       // Delete navigation if exists.
 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     }
 318
 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
 323     $unsetFields = [
 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',
 335       'task',
 336     ];
 337     foreach ($unsetFields as $field) {
 338       unset($formValues[$field]);
 339     }
 340     $view_mode = $formValues['view_mode'];
 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'])) {
 345       $params['owner_id'] = CRM_Core_Session::getLoggedInContactID();
 346     }
 347     else {
 348       $params['owner_id'] = 'null';
 349     }
 350     unset($formValues['add_to_my_reports']);
 351
 352     // pass form_values as string
 353     $params['form_values'] = serialize($formValues);
 354
 355     $instance = CRM_Report_BAO_ReportInstance::create($params);
 356     $form->set('id', $instance->id);
 357
 358     if ($instanceID && !$isNew) {
 359       // updating existing instance
 360       $statusMsg = ts('"%1" report has been updated.', [1 => $instance->title]);
 361     }
 362     elseif ($form->getVar('_id') && $isNew) {
 363       $statusMsg = ts('Your report has been successfully copied as "%1". You are currently viewing the new copy.', [1 => $instance->title]);
 364     }
 365     else {
 366       $statusMsg = ts('"%1" report has been successfully created. You are currently viewing the new report instance.', [1 => $instance->title]);
 367     }
 368     CRM_Core_Session::setStatus($statusMsg);
 369
 370     if ($redirect) {
 371       $urlParams = ['reset' => 1];
 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));
 379     }
 380   }
 381
 382 }