Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * This class if for search builder processing | |
38 | */ | |
39 | class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search { | |
40 | ||
41 | /** | |
42 | * number of columns in where | |
43 | * | |
44 | * @var int | |
45 | * @access public | |
46 | */ | |
47 | public $_columnCount; | |
48 | ||
49 | /** | |
50 | * number of blocks to be shown | |
51 | * | |
52 | * @var int | |
53 | * @access public | |
54 | */ | |
55 | public $_blockCount; | |
56 | ||
57 | /** | |
58 | * Function to actually build the form | |
59 | * | |
355ba699 | 60 | * @return void |
6a488035 TO |
61 | * @access public |
62 | */ | |
63 | public function preProcess() { | |
64 | $this->set('searchFormName', 'Builder'); | |
65 | ||
66 | $this->set('context', 'builder'); | |
67 | parent::preProcess(); | |
68 | ||
69 | // Get the block count | |
70 | $this->_blockCount = $this->get('blockCount'); | |
71 | // Initialize new form | |
72 | if (!$this->_blockCount) { | |
73 | $this->_blockCount = 4; | |
74 | $this->set('newBlock', 1); | |
75 | } | |
76 | ||
77 | //get the column count | |
78 | $this->_columnCount = $this->get('columnCount'); | |
79 | ||
80 | for ($i = 1; $i < $this->_blockCount; $i++) { | |
81 | if (empty($this->_columnCount[$i])) { | |
82 | $this->_columnCount[$i] = 5; | |
83 | } | |
84 | } | |
85 | ||
86 | $this->_loadedMappingId = $this->get('savedMapping'); | |
87 | ||
88 | if ($this->get('showSearchForm')) { | |
89 | $this->assign('showSearchForm', TRUE); | |
90 | } | |
91 | else { | |
92 | $this->assign('showSearchForm', FALSE); | |
93 | } | |
94 | } | |
95 | ||
96 | public function buildQuickForm() { | |
97 | $fields = self::fields(); | |
98 | // Get fields of type date | |
99 | // FIXME: This is a hack until our fields contain this meta-data | |
100 | $dateFields = array(); | |
101 | foreach ($fields as $name => $field) { | |
102 | if (strpos($name, '_date') || CRM_Utils_Array::value('data_type', $field) == 'Date') { | |
103 | $dateFields[] = $name; | |
104 | } | |
105 | } | |
106 | // Add javascript | |
107 | CRM_Core_Resources::singleton() | |
108 | ->addScriptFile('civicrm', 'templates/CRM/Contact/Form/Search/Builder.js') | |
109 | ->addSetting(array( | |
110 | 'searchBuilder' => array( | |
111 | // Index of newly added/expanded block (1-based index) | |
112 | 'newBlock' => $this->get('newBlock'), | |
113 | 'dateFields' => $dateFields, | |
114 | 'fieldOptions' => self::fieldOptions(), | |
115 | ), | |
116 | )); | |
117 | //get the saved search mapping id | |
118 | $mappingId = NULL; | |
119 | if ($this->_ssID) { | |
120 | $mappingId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_SavedSearch', $this->_ssID, 'mapping_id'); | |
121 | } | |
122 | ||
123 | CRM_Core_BAO_Mapping::buildMappingForm($this, 'Search Builder', $mappingId, $this->_columnCount, $this->_blockCount); | |
124 | ||
125 | parent::buildQuickForm(); | |
126 | } | |
127 | ||
128 | /** | |
129 | * Add local and global form rules | |
130 | * | |
131 | * @access protected | |
132 | * | |
133 | * @return void | |
134 | */ | |
135 | function addRules() { | |
136 | $this->addFormRule(array('CRM_Contact_Form_Search_Builder', 'formRule'), $this); | |
137 | } | |
138 | ||
139 | /** | |
140 | * global validation rules for the form | |
141 | * | |
fd31fa4c EM |
142 | * @param $values |
143 | * @param $files | |
144 | * @param $self | |
145 | * | |
146 | * @internal param array $fields posted values of the form | |
6a488035 TO |
147 | * |
148 | * @return array list of errors to be posted back to the form | |
149 | * @static | |
150 | * @access public | |
151 | */ | |
152 | static function formRule($values, $files, $self) { | |
8cc574cf | 153 | if (!empty($values['addMore']) || !empty($values['addBlock'])) { |
6a488035 TO |
154 | return TRUE; |
155 | } | |
156 | $fields = self::fields(); | |
157 | $fld = CRM_Core_BAO_Mapping::formattedFields($values, TRUE); | |
158 | ||
159 | $errorMsg = array(); | |
160 | foreach ($fld as $k => $v) { | |
161 | if (!$v[1]) { | |
162 | $errorMsg["operator[$v[3]][$v[4]]"] = ts("Please enter the operator."); | |
163 | } | |
164 | else { | |
165 | // CRM-10338 | |
166 | $v[2] = self::checkArrayKeyEmpty($v[2]); | |
167 | ||
168 | if (in_array($v[1], array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY')) && | |
169 | !empty($v[2])) { | |
170 | $errorMsg["value[$v[3]][$v[4]]"] = ts('Please clear your value if you want to use %1 operator.', array(1 => $v[1])); | |
171 | } | |
172 | elseif (($v[0] == 'group' || $v[0] == 'tag') && !empty($v[2])) { | |
173 | $grpId = array_keys($v[2]); | |
174 | if (!key($v[2])) { | |
175 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a value."); | |
176 | } | |
177 | ||
178 | if (count($grpId) > 1) { | |
179 | if ($v[1] != 'IN' && $v[1] != 'NOT IN') { | |
180 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a valid value."); | |
181 | } | |
182 | foreach ($grpId as $val) { | |
183 | $error = CRM_Utils_Type::validate($val, 'Integer', FALSE); | |
184 | if ($error != $val) { | |
185 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter valid value."); | |
186 | break; | |
187 | } | |
188 | } | |
189 | } | |
190 | else { | |
191 | $error = CRM_Utils_Type::validate($grpId[0], 'Integer', FALSE); | |
192 | if ($error != $grpId[0]) { | |
193 | $errorMsg["value[$v[3]][$v[4]]"] = ts('Please enter valid %1 id.', array(1 => $v[0])); | |
194 | } | |
195 | } | |
196 | } | |
197 | elseif (substr($v[0], 0, 7) === 'do_not_' or substr($v[0], 0, 3) === 'is_') { | |
198 | if (isset($v[2])) { | |
199 | $v2 = array($v[2]); | |
200 | if (!isset($v[2])) { | |
201 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a value."); | |
202 | } | |
203 | ||
204 | $error = CRM_Utils_Type::validate($v2[0], 'Integer', FALSE); | |
205 | if ($error != $v2[0]) { | |
206 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a valid value."); | |
207 | } | |
208 | } | |
209 | else { | |
210 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a value."); | |
211 | } | |
212 | } | |
213 | else { | |
214 | if (substr($v[0], 0, 7) == 'custom_') { | |
442df34b CW |
215 | // Get rid of appended location type id |
216 | list($fieldKey) = explode('-', $v[0]); | |
217 | $type = $fields[$fieldKey]['data_type']; | |
6a488035 TO |
218 | |
219 | // hack to handle custom data of type state and country | |
220 | if (in_array($type, array( | |
221 | 'Country', 'StateProvince'))) { | |
222 | $type = "Integer"; | |
223 | } | |
224 | } | |
225 | else { | |
226 | $fldName = $v[0]; | |
227 | // FIXME: no idea at this point what to do with this, | |
228 | // FIXME: but definitely needs fixing. | |
229 | if (substr($v[0], 0, 13) == 'contribution_') { | |
230 | $fldName = substr($v[0], 13); | |
231 | } | |
232 | ||
233 | $fldValue = CRM_Utils_Array::value($fldName, $fields); | |
234 | $fldType = CRM_Utils_Array::value('type', $fldValue); | |
235 | $type = CRM_Utils_Type::typeToString($fldType); | |
236 | // Check Empty values for Integer Or Boolean Or Date type For operators other than IS NULL and IS NOT NULL. | |
237 | if (!in_array($v[1], | |
238 | array('IS NULL', 'IS NOT NULL', 'IS EMPTY', 'IS NOT EMPTY'))) { | |
dbc6f6d6 | 239 | if ((($type == 'Int' || $type == 'Boolean') && !is_array($v[2]) && !trim($v[2])) && $v[2] != '0') { |
6a488035 TO |
240 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a value."); |
241 | } | |
242 | elseif ($type == 'Date' && !trim($v[2])) { | |
243 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a value."); | |
244 | } | |
245 | } | |
246 | } | |
247 | ||
248 | if ($type && empty($errorMsg)) { | |
249 | // check for valid format while using IN Operator | |
250 | if ($v[1] == 'IN') { | |
dbc6f6d6 | 251 | if (!is_array($v[2])) { |
252 | $inVal = trim($v[2]); | |
253 | //checking for format to avoid db errors | |
254 | if ($type == 'Int') { | |
255 | if (!preg_match('/^[(]([A-Za-z0-9\,]+)[)]$/', $inVal)) { | |
256 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter correct Data (in valid format)."); | |
257 | } | |
6a488035 | 258 | } |
dbc6f6d6 | 259 | else { |
260 | if (!(substr($inVal, 0, 1) == '(' && substr($inVal, -1, 1) == ')') && !preg_match('/^[(]([A-Za-z0-9åäöÅÄÖüÜœŒæÆøØ\,\s]+)[)]$/', $inVal)) { | |
261 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter correct Data (in valid format)."); | |
262 | } | |
6a488035 TO |
263 | } |
264 | } | |
265 | ||
266 | // Validate each value in parenthesis to avoid db errors | |
267 | if (empty($errorMsg)) { | |
268 | $parenValues = array(); | |
dbc6f6d6 | 269 | $parenValues = is_array($v[2]) ? $v[2] : explode(',', trim($inVal, "(..)")); |
6a488035 TO |
270 | foreach ($parenValues as $val) { |
271 | $val = trim($val); | |
272 | if (!$val && $val != '0') { | |
273 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter the values correctly."); | |
274 | } | |
275 | if (empty($errorMsg)) { | |
276 | $error = CRM_Utils_Type::validate($val, $type, FALSE); | |
277 | if ($error != $val) { | |
278 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a valid value."); | |
279 | } | |
280 | } | |
281 | } | |
282 | } | |
283 | } | |
284 | elseif (trim($v[2])) { | |
285 | //else check value for rest of the Operators | |
286 | $error = CRM_Utils_Type::validate($v[2], $type, FALSE); | |
287 | if ($error != $v[2]) { | |
288 | $errorMsg["value[$v[3]][$v[4]]"] = ts("Please enter a valid value."); | |
289 | } | |
290 | } | |
291 | } | |
292 | } | |
293 | } | |
294 | } | |
295 | ||
296 | if (!empty($errorMsg)) { | |
297 | $self->set('showSearchForm', TRUE); | |
298 | $self->assign('rows', NULL); | |
299 | return $errorMsg; | |
300 | } | |
301 | ||
302 | return TRUE; | |
303 | } | |
304 | ||
305 | public function normalizeFormValues() {} | |
306 | ||
86538308 EM |
307 | /** |
308 | * @param $formValues | |
309 | * | |
310 | * @return array | |
311 | */ | |
b9e573d4 | 312 | public function convertFormValues(&$formValues) { |
6a488035 TO |
313 | return CRM_Core_BAO_Mapping::formattedFields($formValues); |
314 | } | |
315 | ||
86538308 EM |
316 | /** |
317 | * @return array | |
318 | */ | |
6a488035 TO |
319 | public function &returnProperties() { |
320 | return CRM_Core_BAO_Mapping::returnProperties($this->_formValues); | |
321 | } | |
322 | ||
323 | /** | |
324 | * Process the uploaded file | |
325 | * | |
326 | * @return void | |
327 | * @access public | |
328 | */ | |
329 | public function postProcess() { | |
330 | $this->set('isAdvanced', '2'); | |
331 | $this->set('isSearchBuilder', '1'); | |
332 | $this->set('showSearchForm', FALSE); | |
333 | ||
334 | $params = $this->controller->exportValues($this->_name); | |
335 | if (!empty($params)) { | |
336 | // Add another block | |
337 | if (!empty($params['addBlock'])) { | |
338 | $this->set('newBlock', $this->_blockCount); | |
339 | $this->_blockCount += 3; | |
340 | $this->set('blockCount', $this->_blockCount); | |
341 | $this->set('showSearchForm', TRUE); | |
342 | return; | |
343 | } | |
344 | // Add another field | |
345 | $addMore = CRM_Utils_Array::value('addMore', $params); | |
346 | for ($x = 1; $x <= $this->_blockCount; $x++) { | |
347 | if (!empty($addMore[$x])) { | |
348 | $this->set('newBlock', $x); | |
349 | $this->_columnCount[$x] = $this->_columnCount[$x] + 5; | |
350 | $this->set('columnCount', $this->_columnCount); | |
351 | $this->set('showSearchForm', TRUE); | |
352 | return; | |
353 | } | |
354 | } | |
355 | $this->set('newBlock', NULL); | |
356 | $checkEmpty = NULL; | |
357 | foreach ($params['mapper'] as $key => $value) { | |
358 | foreach ($value as $k => $v) { | |
359 | if ($v[0]) { | |
360 | $checkEmpty++; | |
361 | } | |
362 | } | |
363 | } | |
364 | ||
365 | if (!$checkEmpty) { | |
366 | $this->set('newBlock', 1); | |
367 | CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contact/search/builder', '_qf_Builder_display=true')); | |
368 | } | |
369 | } | |
370 | ||
371 | // get user submitted values | |
372 | // get it from controller only if form has been submitted, else preProcess has set this | |
373 | if (!empty($_POST)) { | |
374 | $this->_formValues = $this->controller->exportValues($this->_name); | |
375 | ||
376 | // set the group if group is submitted | |
a7488080 | 377 | if (!empty($this->_formValues['uf_group_id'])) { |
6a488035 TO |
378 | $this->set('id', $this->_formValues['uf_group_id']); |
379 | } | |
380 | else { | |
381 | $this->set('id', ''); | |
382 | } | |
383 | } | |
384 | ||
385 | // we dont want to store the sortByCharacter in the formValue, it is more like | |
386 | // a filter on the result set | |
387 | // this filter is reset if we click on the search button | |
388 | if ($this->_sortByCharacter !== NULL && empty($_POST)) { | |
389 | if (strtolower($this->_sortByCharacter) == 'all') { | |
390 | $this->_formValues['sortByCharacter'] = NULL; | |
391 | } | |
392 | else { | |
393 | $this->_formValues['sortByCharacter'] = $this->_sortByCharacter; | |
394 | } | |
395 | } | |
e166ff79 CW |
396 | else { |
397 | $this->_sortByCharacter = NULL; | |
398 | } | |
6a488035 | 399 | |
b9e573d4 | 400 | $this->_params = $this->convertFormValues($this->_formValues); |
6a488035 TO |
401 | $this->_returnProperties = &$this->returnProperties(); |
402 | ||
403 | // CRM-10338 check if value is empty array | |
404 | foreach ($this->_params as $k => $v) { | |
405 | $this->_params[$k][2] = self::checkArrayKeyEmpty($v[2]); | |
406 | } | |
407 | ||
408 | parent::postProcess(); | |
409 | } | |
410 | ||
86538308 EM |
411 | /** |
412 | * @return array | |
413 | */ | |
6a488035 | 414 | static function fields() { |
e1ab2e91 | 415 | $fields = array_merge( |
6a488035 TO |
416 | CRM_Contact_BAO_Contact::exportableFields('All', FALSE, TRUE), |
417 | CRM_Core_Component::getQueryFields(), | |
eb1e3589 | 418 | CRM_Contact_BAO_Query_Hook::singleton()->getFields(), |
6a488035 TO |
419 | CRM_Activity_BAO_Activity::exportableFields() |
420 | ); | |
e1ab2e91 | 421 | return $fields; |
6a488035 TO |
422 | } |
423 | ||
424 | /** | |
425 | * CRM-9434 Hackish function to fetch fields with options. | |
426 | * FIXME: When our core fields contain reliable metadata this will be much simpler. | |
427 | * @return array: (string => string) key: field_name value: api entity name | |
428 | * Note: options are fetched via ajax using the api "getoptions" method | |
429 | */ | |
430 | static function fieldOptions() { | |
431 | // Hack to add options not retrieved by getfields | |
432 | // This list could go on and on, but it would be better to fix getfields | |
433 | $options = array( | |
e354351f | 434 | 'group' => 'group_contact', |
435 | 'tag' => 'entity_tag', | |
6a488035 TO |
436 | 'on_hold' => 'yesno', |
437 | 'is_bulkmail' => 'yesno', | |
6a488035 TO |
438 | 'payment_instrument' => 'contribution', |
439 | 'membership_status' => 'membership', | |
440 | 'membership_type' => 'membership', | |
e5d696ef | 441 | 'member_campaign_id' => 'membership', |
67744c4e CW |
442 | 'member_is_test' => 'yesno', |
443 | 'member_is_pay_later' => 'yesno', | |
444 | 'is_override' => 'yesno', | |
6a488035 | 445 | ); |
67744c4e | 446 | $entities = array('contact', 'address', 'activity', 'participant', 'pledge', 'member', 'contribution'); |
6a5f199e | 447 | CRM_Contact_BAO_Query_Hook::singleton()->alterSearchBuilderOptions($entities, $options); |
6a488035 | 448 | foreach ($entities as $entity) { |
67744c4e | 449 | $fields = civicrm_api3($entity, 'getfields'); |
6a488035 | 450 | foreach ($fields['values'] as $field => $info) { |
4b5ff63c | 451 | if (!empty($info['options']) || !empty($info['pseudoconstant']) || !empty($info['option_group_id'])) { |
6a488035 | 452 | $options[$field] = $entity; |
e61022d7 | 453 | // Hack for when search field doesn't match db field - e.g. "country" instead of "country_id" |
6a488035 TO |
454 | if (substr($field, -3) == '_id') { |
455 | $options[substr($field, 0, -3)] = $entity; | |
456 | } | |
457 | } | |
e61022d7 CW |
458 | elseif (!empty($info['data_type']) && in_array($info['data_type'], array('StateProvince', 'Country'))) { |
459 | $options[$field] = $entity; | |
460 | } | |
6a488035 TO |
461 | elseif (in_array(substr($field, 0, 3), array('is_', 'do_')) || CRM_Utils_Array::value('data_type', $info) == 'Boolean') { |
462 | $options[$field] = 'yesno'; | |
463 | if ($entity != 'contact') { | |
464 | $options[$entity . '_' . $field] = 'yesno'; | |
465 | } | |
466 | } | |
467 | elseif (strpos($field, '_is_')) { | |
468 | $options[$field] = 'yesno'; | |
469 | } | |
470 | } | |
471 | } | |
472 | return $options; | |
473 | } | |
474 | ||
475 | /** | |
476 | * CRM-10338 | |
477 | * tags and groups use array keys for selection list. | |
478 | * if using IS NULL/NOT NULL, an array with no array key is created | |
479 | * convert that to simple null so processing can proceed | |
480 | */ | |
481 | static function checkArrayKeyEmpty($val) { | |
482 | if (is_array($val)) { | |
483 | $v2empty = true; | |
484 | foreach ($val as $vk => $vv) { | |
485 | if (!empty($vk)) { | |
486 | $v2empty = false; | |
487 | } | |
488 | } | |
489 | if ($v2empty) { | |
490 | $val = null; | |
491 | } | |
492 | } | |
493 | return $val; | |
494 | } | |
495 | } | |
496 |