CRM/Report/Form/Instance.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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  * Class CRM_Report_Form_Instance
  30  */
  31 class CRM_Report_Form_Instance {
  32
  33   /**
  34    * Build form.
  35    *
  36    * @param CRM_Core_Form $form
  37    */
  38   public static function buildForm(&$form) {
  39     // We should not build form elements in dashlet mode.
  40     if ($form->_section) {
  41       return;
  42     }
  43
  44     // Check role based permission.
  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
  53     $attributes = CRM_Core_DAO::getAttribute('CRM_Report_DAO_ReportInstance');
  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     );
  84
  85     $form->add('number',
  86       'row_count',
  87       ts('Limit Dashboard Results'),
  88       array('class' => 'four', 'min' => 1)
  89     );
  90
  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,
 104       array('onclick' => "return showHideByValue('is_navigation','','navigation_menu','table-row','radio',false);")
 105     );
 106
 107     $form->addElement('select', 'view_mode', ts('Configure link to...'), array(
 108       'view' => ts('View Results'),
 109       'criteria' => ts('Show Criteria'),
 110     ));
 111
 112     $form->addElement('checkbox', 'addToDashboard', ts('Available for Dashboard?'));
 113     $form->add('number', 'cache_minutes', ts('Cache dashlet for'), array('class' => 'four', 'min' => 1));
 114     $form->addElement('checkbox', 'add_to_my_reports', ts('Add to My Reports?'), NULL);
 115
 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'),
 128         array('0' => ts('Everyone (includes anonymous)')) + CRM_Core_Permission::basicPermissions()
 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         }
 137         $grouprole = &$form->addElement('advmultiselect',
 138           'grouprole',
 139           ts('ACL Group/Role'),
 140           $user_roles,
 141           array(
 142             'size' => 5,
 143             'style' => 'width:240px',
 144             'class' => 'advmultiselect',
 145           )
 146         );
 147         $grouprole->setButtonAttributes('add', array('value' => ts('Add >>')));
 148         $grouprole->setButtonAttributes('remove', array('value' => ts('<< Remove')));
 149       }
 150     }
 151
 152     // navigation field
 153     $parentMenu = CRM_Core_BAO_Navigation::getNavigationList();
 154
 155     $form->add('select', 'parent_id', ts('Parent Menu'), array('' => ts('- select -')) + $parentMenu);
 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);
 160       if (count($instanceList) > 1) {
 161         $form->add('select', 'drilldown_id', $drillLabel, array('' => ts('- select -')) + $instanceList);
 162       }
 163       break;
 164     }
 165
 166     $form->addButtons(array(
 167         array(
 168           'type' => 'submit',
 169           'name' => ts('Save Report'),
 170           'isDefault' => TRUE,
 171         ),
 172         array(
 173           'type' => 'cancel',
 174           'name' => ts('Cancel'),
 175         ),
 176       )
 177     );
 178
 179     $form->addFormRule(array('CRM_Report_Form_Instance', 'formRule'), $form);
 180   }
 181
 182   /**
 183    * Add form rules.
 184    *
 185    * @param array $fields
 186    * @param array $errors
 187    * @param CRM_Report_Form_Instance $self
 188    *
 189    * @return array|bool
 190    */
 191   public static function formRule($fields, $errors, $self) {
 192     // Validate both the "next" and "save" buttons for creating/updating a report.
 193     $nextButton = $self->controller->getButtonName();
 194     $saveButton = str_replace('_next', '_save', $nextButton);
 195     $clickedButton = $self->getVar('_instanceButtonName');
 196
 197     $errors = array();
 198     if ($clickedButton == $nextButton || $clickedButton == $saveButton) {
 199       if (empty($fields['title'])) {
 200         $errors['title'] = ts('Title is a required field.');
 201         $self->assign('instanceFormError', TRUE);
 202       }
 203     }
 204
 205     return empty($errors) ? TRUE : $errors;
 206   }
 207
 208   /**
 209    * Set default values.
 210    *
 211    * @param CRM_Core_Form $form
 212    * @param array $defaults
 213    */
 214   public static function setDefaultValues(&$form, &$defaults) {
 215     // we should not build form elements in dashlet mode.
 216     if ($form->_section) {
 217       return;
 218     }
 219
 220     $instanceID = $form->getVar('_id');
 221     $navigationDefaults = array();
 222
 223     if (!isset($defaults['permission'])) {
 224       $defaults['permission'] = 'access CiviReport';
 225     }
 226
 227     $userFrameworkResourceURL = CRM_Core_Config::singleton()->userFrameworkResourceURL;
 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
 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' />
 238     <style type=\"text/css\">@import url({$userFrameworkResourceURL}css/print.css);</style>
 239     {$htmlHeader}
 240   </head>
 241   <body><div id=\"crm-container\">";
 242
 243     $defaults['report_footer'] = $report_footer = "<p><img src=\"{$userFrameworkResourceURL}i/powered_by.png\" /></p></div></body>
 244 </html>
 245 ";
 246
 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
 262     if (empty($defaults['cache_minutes'])) {
 263       $defaults['cache_minutes'] = '60';
 264     }
 265
 266     if ($instanceID) {
 267       // this is already retrieved via Form.php
 268       $defaults['description'] = CRM_Utils_Array::value('description', $defaults);
 269       if (!empty($defaults['header'])) {
 270         $defaults['report_header'] = $defaults['header'];
 271       }
 272       if (!empty($defaults['footer'])) {
 273         $defaults['report_footer'] = $defaults['footer'];
 274       }
 275
 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
 282       if (!empty($defaults['navigation_id'])) {
 283         // Get the default navigation parent id.
 284         $params = array('id' => $defaults['navigation_id']);
 285         CRM_Core_BAO_Navigation::retrieve($params, $navigationDefaults);
 286         $defaults['is_navigation'] = 1;
 287         $defaults['parent_id'] = CRM_Utils_Array::value('parent_id', $navigationDefaults);
 288         if (!empty($navigationDefaults['is_active'])) {
 289           $form->assign('is_navigation', TRUE);
 290         }
 291         // A saved view mode will over-ride any url assumptions.
 292         if (strpos($navigationDefaults['url'], 'output=criteria')) {
 293           $defaults['view_mode'] = 'criteria';
 294         }
 295
 296         if (!empty($navigationDefaults['id'])) {
 297           $form->_navigation['id'] = $navigationDefaults['id'];
 298           $form->_navigation['parent_id'] = !empty($navigationDefaults['parent_id']) ?
 299           $navigationDefaults['parent_id'] : NULL;
 300         }
 301       }
 302
 303       if (!empty($defaults['grouprole'])) {
 304         foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $defaults['grouprole']) as $value) {
 305           $groupRoles[] = $value;
 306         }
 307         $defaults['grouprole'] = $groupRoles;
 308       }
 309     }
 310     elseif (property_exists($form, '_description')) {
 311       $defaults['description'] = $form->_description;
 312     }
 313   }
 314
 315   /**
 316    * Post process function.
 317    *
 318    * @param CRM_Core_Form $form
 319    * @param bool $redirect
 320    */
 321   public static function postProcess(&$form, $redirect = TRUE) {
 322     $params = $form->getVar('_params');
 323     $instanceID = $form->getVar('_id');
 324
 325     if ($isNew = $form->getVar('_createNew')) {
 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);
 329       // Unset $instanceID so a new copy would be created.
 330       $instanceID = NULL;
 331     }
 332     $params['instance_id'] = $instanceID;
 333     if (!empty($params['is_navigation'])) {
 334       $params['navigation'] = $form->_navigation;
 335     }
 336     elseif ($instanceID) {
 337       // Delete navigation if exists.
 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     }
 344
 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
 349     $unsetFields = array(
 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',
 361       'task',
 362     );
 363     foreach ($unsetFields as $field) {
 364       unset($formValues[$field]);
 365     }
 366     $view_mode = $formValues['view_mode'];
 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'])) {
 371       $params['owner_id'] = CRM_Core_Session::getLoggedInContactID();
 372     }
 373     else {
 374       $params['owner_id'] = 'null';
 375     }
 376     unset($formValues['add_to_my_reports']);
 377
 378     // pass form_values as string
 379     $params['form_values'] = serialize($formValues);
 380
 381     $instance = CRM_Report_BAO_ReportInstance::create($params);
 382     $form->set('id', $instance->id);
 383
 384     if ($instanceID && !$isNew) {
 385       // updating existing instance
 386       $statusMsg = ts('"%1" report has been updated.', array(1 => $instance->title));
 387     }
 388     elseif ($form->getVar('_id') && $isNew) {
 389       $statusMsg = ts('Your report has been successfully copied as "%1". You are currently viewing the new copy.', array(1 => $instance->title));
 390     }
 391     else {
 392       $statusMsg = ts('"%1" report has been successfully created. You are currently viewing the new report instance.', array(1 => $instance->title));
 393     }
 394     CRM_Core_Session::setStatus($statusMsg);
 395
 396     if ($redirect) {
 397       $urlParams = array('reset' => 1);
 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));
 405     }
 406   }
 407
 408 }