CRM/Report/BAO/ReportInstance.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2017
  32  */
  33 class CRM_Report_BAO_ReportInstance extends CRM_Report_DAO_ReportInstance {
  34
  35   /**
  36    * Takes an associative array and creates an instance object.
  37    *
  38    * the function extract all the params it needs to initialize the create a
  39    * instance object. the params array could contain additional unused name/value
  40    * pairs
  41    *
  42    * @param array $params
  43    *   (reference ) an assoc array of name/value pairs.
  44    *
  45    * @return CRM_Report_DAO_ReportInstance
  46    */
  47   public static function add(&$params) {
  48     $instance = new CRM_Report_DAO_ReportInstance();
  49     if (empty($params)) {
  50       return NULL;
  51     }
  52
  53     $instanceID = CRM_Utils_Array::value('id', $params, CRM_Utils_Array::value('instance_id', $params));
  54
  55     // convert roles array to string
  56     if (isset($params['grouprole']) && is_array($params['grouprole'])) {
  57       $grouprole_array = array();
  58       foreach ($params['grouprole'] as $key => $value) {
  59         $grouprole_array[$value] = $value;
  60       }
  61       $params['grouprole'] = implode(CRM_Core_DAO::VALUE_SEPARATOR,
  62         array_keys($grouprole_array)
  63       );
  64     }
  65
  66     if (!$instanceID || !isset($params['id'])) {
  67       $params['is_reserved'] = CRM_Utils_Array::value('is_reserved', $params, FALSE);
  68       $params['domain_id'] = CRM_Utils_Array::value('domain_id', $params, CRM_Core_Config::domainID());
  69       // CRM-17256 set created_id on report creation.
  70       $params['created_id'] = isset($params['created_id']) ? $params['created_id'] : CRM_Core_Session::getLoggedInContactID();
  71     }
  72
  73     if ($instanceID) {
  74       CRM_Utils_Hook::pre('edit', 'ReportInstance', $instanceID, $params);
  75     }
  76     else {
  77       CRM_Utils_Hook::pre('create', 'ReportInstance', NULL, $params);
  78     }
  79
  80     $instance = new CRM_Report_DAO_ReportInstance();
  81     $instance->copyValues($params);
  82
  83     if (CRM_Core_Config::singleton()->userFramework == 'Joomla') {
  84       $instance->permission = 'null';
  85     }
  86
  87     // explicitly set to null if params value is empty
  88     if (!$instanceID && empty($params['grouprole'])) {
  89       $instance->grouprole = 'null';
  90     }
  91
  92     if ($instanceID) {
  93       $instance->id = $instanceID;
  94     }
  95
  96     if (!$instanceID) {
  97       if ($reportID = CRM_Utils_Array::value('report_id', $params)) {
  98         $instance->report_id = $reportID;
  99       }
 100       elseif ($instanceID) {
 101         $instance->report_id = CRM_Report_Utils_Report::getValueFromUrl($instanceID);
 102       }
 103       else {
 104         // just take it from current url
 105         $instance->report_id = CRM_Report_Utils_Report::getValueFromUrl();
 106       }
 107     }
 108
 109     $instance->save();
 110
 111     if ($instanceID) {
 112       CRM_Utils_Hook::pre('edit', 'ReportInstance', $instance->id, $instance);
 113     }
 114     else {
 115       CRM_Utils_Hook::pre('create', 'ReportInstance', $instance->id, $instance);
 116     }
 117     return $instance;
 118   }
 119
 120   /**
 121    * Create instance.
 122    *
 123    * takes an associative array and creates a instance object and does any related work like permissioning, adding to dashboard etc.
 124    *
 125    * This function is invoked from within the web form layer and also from the api layer
 126    *
 127    * @param array $params
 128    *   (reference ) an assoc array of name/value pairs.
 129    *
 130    * @return CRM_Report_BAO_ReportInstance
 131    */
 132   public static function &create(&$params) {
 133     if (isset($params['report_header'])) {
 134       $params['header'] = CRM_Utils_Array::value('report_header', $params);
 135     }
 136     if (isset($params['report_footer'])) {
 137       $params['footer'] = CRM_Utils_Array::value('report_footer', $params);
 138     }
 139
 140     // build navigation parameters
 141     if (!empty($params['is_navigation'])) {
 142       if (!array_key_exists('navigation', $params)) {
 143         $params['navigation'] = array();
 144       }
 145       $navigationParams =& $params['navigation'];
 146
 147       $navigationParams['permission'] = array();
 148       $navigationParams['label'] = $params['title'];
 149       $navigationParams['name'] = $params['title'];
 150
 151       $navigationParams['current_parent_id'] = CRM_Utils_Array::value('parent_id', $navigationParams);
 152       $navigationParams['parent_id'] = CRM_Utils_Array::value('parent_id', $params);
 153       $navigationParams['is_active'] = 1;
 154
 155       if ($permission = CRM_Utils_Array::value('permission', $params)) {
 156         $navigationParams['permission'][] = $permission;
 157       }
 158
 159       // unset the navigation related elements, not used in report form values
 160       unset($params['parent_id']);
 161       unset($params['is_navigation']);
 162     }
 163
 164     $viewMode = !empty($params['view_mode']) ? $params['view_mode'] : FALSE;
 165     if ($viewMode) {
 166       // Do not save to the DB - it's saved in the url.
 167       unset($params['view_mode']);
 168     }
 169
 170     // add to dashboard
 171     $dashletParams = array();
 172     if (!empty($params['addToDashboard'])) {
 173       $dashletParams = array(
 174         'label' => $params['title'],
 175         'is_active' => 1,
 176       );
 177       if ($permission = CRM_Utils_Array::value('permission', $params)) {
 178         $dashletParams['permission'][] = $permission;
 179       }
 180     }
 181
 182     $transaction = new CRM_Core_Transaction();
 183
 184     $instance = self::add($params);
 185     if (is_a($instance, 'CRM_Core_Error')) {
 186       $transaction->rollback();
 187       return $instance;
 188     }
 189
 190     // add / update navigation as required
 191     if (!empty($navigationParams)) {
 192       if (empty($params['id']) && empty($params['instance_id']) && !empty($navigationParams['id'])) {
 193         unset($navigationParams['id']);
 194       }
 195       $navigationParams['url'] = "civicrm/report/instance/{$instance->id}" . ($viewMode == 'view' ? '?reset=1&force=1' : '?reset=1&output=criteria');
 196       $navigation = CRM_Core_BAO_Navigation::add($navigationParams);
 197
 198       if (!empty($navigationParams['is_active'])) {
 199         //set the navigation id in report instance table
 200         CRM_Core_DAO::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id, 'navigation_id', $navigation->id);
 201       }
 202       else {
 203         // has been removed from the navigation bar
 204         CRM_Core_DAO::setFieldValue('CRM_Report_DAO_ReportInstance', $instance->id, 'navigation_id', 'NULL');
 205       }
 206       //reset navigation
 207       CRM_Core_BAO_Navigation::resetNavigation();
 208     }
 209
 210     // add to dashlet
 211     if (!empty($dashletParams)) {
 212       $section = 2;
 213       $chart = $limitResult = '';
 214       if (!empty($params['charts'])) {
 215         $section = 1;
 216         $chart = "&charts=" . $params['charts'];
 217       }
 218       if (!empty($params['row_count']) && CRM_Utils_Rule::positiveInteger($params['row_count'])) {
 219         $limitResult = '&rowCount=' . $params['row_count'];
 220       }
 221       if (!empty($params['cache_minutes']) && CRM_Utils_Rule::positiveInteger($params['cache_minutes'])) {
 222         $dashletParams['cache_minutes'] = $params['cache_minutes'];
 223       }
 224       $dashletParams['name'] = "report/{$instance->id}";
 225       $dashletParams['url'] = "civicrm/report/instance/{$instance->id}?reset=1&section={$section}{$chart}&context=dashlet" . $limitResult;
 226       $dashletParams['fullscreen_url'] = "civicrm/report/instance/{$instance->id}?reset=1&section={$section}{$chart}&context=dashletFullscreen" . $limitResult;
 227       $dashletParams['instanceURL'] = "civicrm/report/instance/{$instance->id}";
 228       CRM_Core_BAO_Dashboard::addDashlet($dashletParams);
 229     }
 230     $transaction->commit();
 231
 232     return $instance;
 233   }
 234
 235   /**
 236    * Delete the instance of the Report.
 237    *
 238    * @param int $id
 239    *
 240    * @return mixed
 241    *   $results no of deleted Instance on success, false otherwise
 242    */
 243   public static function del($id = NULL) {
 244     $navId = CRM_Core_DAO::getFieldValue('CRM_Report_DAO_ReportInstance', $id, 'navigation_id', 'id');
 245     $dao = new CRM_Report_DAO_ReportInstance();
 246     $dao->id = $id;
 247     $result = $dao->delete();
 248
 249     // Delete navigation if exists.
 250     if ($navId) {
 251       CRM_Core_BAO_Navigation::processDelete($navId);
 252       CRM_Core_BAO_Navigation::resetNavigation();
 253     }
 254     return $result;
 255   }
 256
 257   /**
 258    * Retrieve instance.
 259    *
 260    * @param array $params
 261    * @param array $defaults
 262    *
 263    * @return CRM_Report_DAO_ReportInstance|null
 264    */
 265   public static function retrieve($params, &$defaults) {
 266     $instance = new CRM_Report_DAO_ReportInstance();
 267     $instance->copyValues($params);
 268
 269     if ($instance->find(TRUE)) {
 270       CRM_Core_DAO::storeValues($instance, $defaults);
 271       $instance->free();
 272       return $instance;
 273     }
 274     return NULL;
 275   }
 276
 277   /**
 278    * Check if report is private.
 279    *
 280    * @param int $instance_id
 281    *
 282    * @return bool
 283    */
 284   public static function reportIsPrivate($instance_id) {
 285     $owner_id = CRM_Core_DAO::getFieldValue('CRM_Report_DAO_ReportInstance', $instance_id, 'owner_id', 'id');
 286     if ($owner_id) {
 287       return TRUE;
 288     }
 289     return FALSE;
 290   }
 291
 292   /**
 293    * Check if the logged in user is the owner.
 294    *
 295    * @param int $instance_id
 296    *
 297    * @return TRUE if contact owns the report, FALSE if not
 298    */
 299   public static function contactIsOwner($instance_id) {
 300     $session = CRM_Core_Session::singleton();
 301     $contact_id = $session->get('userID');
 302     $owner_id = CRM_Core_DAO::getFieldValue('CRM_Report_DAO_ReportInstance', $instance_id, 'owner_id', 'id');
 303     if ($contact_id === $owner_id) {
 304       return TRUE;
 305     }
 306     return FALSE;
 307   }
 308
 309   /**
 310    * Check if the logged in contact can administer the report.
 311    *
 312    * @param int $instance_id
 313    *
 314    * @return bool
 315    *   True if contact can edit the private report, FALSE if not.
 316    */
 317   public static function contactCanAdministerReport($instance_id) {
 318     if (self::reportIsPrivate($instance_id)) {
 319       if (self::contactIsOwner($instance_id) || CRM_Core_Permission::check('access all private reports')) {
 320         return TRUE;
 321       }
 322     }
 323     elseif (CRM_Core_Permission::check('administer Reports')) {
 324       return TRUE;
 325     }
 326     return FALSE;
 327   }
 328
 329   /**
 330    * Delete a report instance wrapped in handling for the form layer.
 331    *
 332    * @param int $instanceId
 333    * @param string $bounceTo
 334    *   Url to redirect the browser to on fail.
 335    * @param string $successRedirect
 336    */
 337   public static function doFormDelete($instanceId, $bounceTo = 'civicrm/report/list?reset=1', $successRedirect = NULL) {
 338     if (!CRM_Core_Permission::check('administer Reports')) {
 339       $statusMessage = ts('You do not have permission to Delete Report.');
 340       CRM_Core_Error::statusBounce($statusMessage, $bounceTo);
 341     }
 342
 343     CRM_Report_BAO_ReportInstance::del($instanceId);
 344
 345     CRM_Core_Session::setStatus(ts('Selected report has been deleted.'), ts('Deleted'), 'success');
 346     if ($successRedirect) {
 347       CRM_Utils_System::redirect(CRM_Utils_System::url($successRedirect));
 348     }
 349   }
 350
 351   /**
 352    * Get the metadata of actions available for this entity.
 353    *
 354    * The thinking here is to describe the various actions on the BAO and then functions
 355    * can add a mix of actions from different BAO as appropriate. The crm.SearchForm.js code
 356    * transforms the 'confirm_mesage' into a message that needs to be confirmed.
 357    * confirm_refresh_fields need to be reviewed & potentially updated at the confirm stage.
 358    *
 359    * Ideas not yet implemented:
 360    *  - supports_modal task can be loaded in a popup, theoretically worked, not attempted.
 361    *  - class and or icon - per option icons or classes (I added these in addTaskMenu::addTaskMenu
 362    *    but I didn't have the right classes). ie adding  'class' => 'crm-i fa-print' to print / class looked
 363    *    wrong, but at the php level it worked https://github.com/civicrm/civicrm-core/pull/8529#issuecomment-227639091
 364    *  - general script-add.
 365    */
 366   public static function getActionMetadata() {
 367     $actions = array(
 368       'report_instance.save' => array('title' => ts('Save')),
 369       'report_instance.copy' => array(
 370         'title' => ts('Save a Copy'),
 371         'data' => array(
 372           'is_confirm' => TRUE,
 373           'confirm_title' => ts('Save a copy...'),
 374           'confirm_refresh_fields' => json_encode(array(
 375             'title' => array('selector' => '.crm-report-instanceForm-form-block-title', 'prepend' => ts('(Copy) ')),
 376             'description' => array('selector' => '.crm-report-instanceForm-form-block-description', 'prepend' => ''),
 377             'parent_id' => array('selector' => '.crm-report-instanceForm-form-block-parent_id', 'prepend' => ''),
 378           )),
 379         ),
 380       ),
 381       'report_instance.print' => array('title' => ts('Print Report')),
 382       'report_instance.pdf' => array('title' => ts('Print to PDF')),
 383       'report_instance.csv' => array('title' => ts('Export as CSV')),
 384     );
 385     if (CRM_Core_Permission::check('administer Reports')) {
 386       $actions['report_instance.delete'] = array(
 387         'title' => ts('Delete report'),
 388         'data' => array(
 389           'is_confirm' => TRUE,
 390           'confirm_message' => ts('Are you sure you want delete this report? This action cannot be undone.'),
 391         ),
 392       );
 393     }
 394     return $actions;
 395   }
 396
 397 }