CRM/Report/Utils/Get.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.3                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2013                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2013
  33  * $Id$
  34  *
  35  */
  36 class CRM_Report_Utils_Get {
  37
  38   static function getTypedValue($name, $type) {
  39     $value = CRM_Utils_Array::value($name, $_GET);
  40     if ($value === NULL) {
  41       return NULL;
  42     }
  43     return CRM_Utils_Type::escape($value,
  44       CRM_Utils_Type::typeToString($type),
  45       FALSE
  46     );
  47   }
  48
  49   static function dateParam($fieldName, &$field, &$defaults) {
  50     // type = 12 (datetime) is not recognized by Utils_Type::escape() method,
  51     // and therefore the below hack
  52     $type = 4;
  53
  54     $from = self::getTypedValue("{$fieldName}_from", $type);
  55     $to = self::getTypedValue("{$fieldName}_to", $type);
  56
  57     $relative = CRM_Utils_Array::value("{$fieldName}_relative", $_GET);
  58     if ($relative) {
  59       list($from, $to) = CRM_Report_Form::getFromTo($relative, NULL, NULL);
  60       $from = substr($from, 0, 8);
  61       $to = substr($to, 0, 8);
  62     }
  63
  64     if (!($from || $to)) {
  65       return FALSE;
  66     }
  67
  68     if ($from !== NULL) {
  69       $dateFrom = CRM_Utils_Date::setDateDefaults($from);
  70       if ($dateFrom !== NULL &&
  71         !empty($dateFrom[0])
  72       ) {
  73         $defaults["{$fieldName}_from"] = $dateFrom[0];
  74       }
  75     }
  76
  77     if ($to !== NULL) {
  78       $dateTo = CRM_Utils_Date::setDateDefaults($to);
  79       if ($dateTo !== NULL &&
  80         !empty($dateTo[0])
  81       ) {
  82         $defaults["{$fieldName}_to"] = $dateTo[0];
  83       }
  84     }
  85   }
  86
  87   static function stringParam($fieldName, &$field, &$defaults) {
  88     $fieldOP = CRM_Utils_Array::value("{$fieldName}_op", $_GET, 'like');
  89
  90     switch ($fieldOP) {
  91       case 'has':
  92       case 'sw':
  93       case 'ew':
  94       case 'nhas':
  95       case 'like':
  96       case 'neq':
  97         $value = self::getTypedValue("{$fieldName}_value", CRM_Utils_Array::value('type', $field));
  98         if ($value !== NULL) {
  99           $defaults["{$fieldName}_value"] = $value;
 100           $defaults["{$fieldName}_op"] = $fieldOP;
 101         }
 102         break;
 103
 104       case 'nll':
 105       case 'nnll':
 106         $defaults["{$fieldName}_op"] = $fieldOP;
 107         break;
 108     }
 109   }
 110
 111   static function intParam($fieldName, &$field, &$defaults) {
 112     $fieldOP = CRM_Utils_Array::value("{$fieldName}_op", $_GET, 'eq');
 113
 114     switch ($fieldOP) {
 115       case 'lte':
 116       case 'gte':
 117       case 'eq':
 118       case 'lt':
 119       case 'gt':
 120       case 'neq':
 121         $value = self::getTypedValue("{$fieldName}_value", $field['type']);
 122         if ($value !== NULL) {
 123           $defaults["{$fieldName}_value"] = $value;
 124           $defaults["{$fieldName}_op"] = $fieldOP;
 125         }
 126         break;
 127
 128       case 'bw':
 129       case 'nbw':
 130         $minValue = self::getTypedValue("{$fieldName}_min", $field['type']);
 131         $maxValue = self::getTypedValue("{$fieldName}_max", $field['type']);
 132         if ($minValue !== NULL ||
 133           $maxValue !== NULL
 134         ) {
 135           if ($minValue !== NULL) {
 136             $defaults["{$fieldName}_min"] = $minValue;
 137           }
 138           if ($maxValue !== NULL) {
 139             $defaults["{$fieldName}_max"] = $maxValue;
 140           }
 141           $defaults["{$fieldName}_op"] = $fieldOP;
 142         }
 143         break;
 144
 145       case 'in':
 146       case 'notin':
 147         // send the type as string so that multiple values can also be retrieved from url.
 148         // for e.g url like - "memtype_in=in&memtype_value=1,2,3"
 149         $value = self::getTypedValue("{$fieldName}_value", CRM_Utils_Type::T_STRING);
 150         if (!preg_match('/^(\d+)(,\d+){0,14}$/', $value)) {
 151           // extra check. Also put a limit of 15 max values.
 152           $value = NULL;
 153         }
 154         if ($value !== NULL) {
 155           $defaults["{$fieldName}_value"] = explode(",", $value);
 156           $defaults["{$fieldName}_op"] = $fieldOP;
 157         }
 158         break;
 159     }
 160   }
 161
 162   static function processChart(&$defaults) {
 163     $chartType = CRM_Utils_Array::value("charts", $_GET);
 164     if (in_array($chartType, array(
 165       'barChart', 'pieChart'))) {
 166       $defaults["charts"] = $chartType;
 167     }
 168   }
 169
 170   static function processFilter(&$fieldGrp, &$defaults) {
 171     // process only filters for now
 172     foreach ($fieldGrp as $tableName => $fields) {
 173       foreach ($fields as $fieldName => $field) {
 174         switch (CRM_Utils_Array::value('type', $field)) {
 175           case CRM_Utils_Type::T_INT:
 176           case CRM_Utils_Type::T_MONEY:
 177             self::intParam($fieldName, $field, $defaults);
 178             break;
 179
 180           case CRM_Utils_Type::T_DATE:
 181           case CRM_Utils_Type::T_DATE | CRM_Utils_Type::T_TIME:
 182             self::dateParam($fieldName, $field, $defaults);
 183             break;
 184
 185           case CRM_Utils_Type::T_STRING:
 186           default:
 187             self::stringParam($fieldName, $field, $defaults);
 188             break;
 189         }
 190       }
 191     }
 192   }
 193
 194   //unset default filters
 195   static function unsetFilters(&$defaults) {
 196     static $unsetFlag = TRUE;
 197     if ($unsetFlag) {
 198       foreach ($defaults as $field_name => $field_value) {
 199         $newstr = substr($field_name, strrpos($field_name, '_'));
 200         if ($newstr == '_value' || $newstr == '_op' ||
 201           $newstr == '_min' || $newstr == '_max' ||
 202           $newstr == '_from' || $newstr == '_to' ||
 203           $newstr == '_relative'
 204         ) {
 205           unset($defaults[$field_name]);
 206         }
 207       }
 208       $unsetFlag = FALSE;
 209     }
 210   }
 211
 212   static function processGroupBy(&$fieldGrp, &$defaults) {
 213     // process only group_bys for now
 214     $flag = FALSE;
 215
 216     if (is_array($fieldGrp)) {
 217       foreach ($fieldGrp as $tableName => $fields) {
 218         if ($groupBys = CRM_Utils_Array::value("gby", $_GET)) {
 219           $groupBys = explode(' ', $groupBys);
 220           if (!empty($groupBys)) {
 221             if (!$flag) {
 222               unset($defaults['group_bys']);
 223               $flag = TRUE;
 224             }
 225             foreach ($groupBys as $gby) {
 226               if (array_key_exists($gby, $fields)) {
 227                 $defaults['group_bys'][$gby] = 1;
 228               }
 229             }
 230           }
 231         }
 232       }
 233     }
 234   }
 235
 236   static function processFields(&$reportFields, &$defaults) {
 237     //add filters from url
 238     if (is_array($reportFields)) {
 239       if ($urlFields = CRM_Utils_Array::value("fld", $_GET)) {
 240         $urlFields = explode(',', $urlFields);
 241       }
 242       if (CRM_Utils_Array::value("ufld", $_GET) == 1) {
 243         // unset all display columns
 244         $defaults['fields'] = array();
 245       }
 246       if (!empty($urlFields)) {
 247         foreach ($reportFields as $tableName => $fields) {
 248           foreach ($urlFields as $fld) {
 249             if (array_key_exists($fld, $fields)) {
 250               $defaults['fields'][$fld] = 1;
 251             }
 252           }
 253         }
 254       }
 255     }
 256   }
 257 }
 258