1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2014 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
class CApiService {
public static $userData;
/**
* The name of the table.
*
* @var string
*/
protected $tableName;
/**
* The alias of the table.
*
* @var string
*/
protected $tableAlias = 't';
/**
* The name of the field used as a private key.
*
* @var string
*/
protected $pk;
/**
* An array of field that can be used for sorting.
*
* @var array
*/
protected $sortColumns = array();
/**
* An array of allowed get() options that are supported by all APIs.
*
* @var array
*/
protected $globalGetOptions = array();
/**
* An array containing all of the allowed get() options for the current API.
*
* @var array
*/
protected $getOptions = array();
/**
* An array containing all of the error strings.
*
* @var array
*/
protected $errorMessages = array();
public function __construct() {
// set the PK of the table
$this->pk = $this->pk($this->tableName());
$this->globalGetOptions = array(
// filter
'filter' => null,
'search' => null,
'searchByAny' => null,
'startSearch' => null,
'excludeSearch' => null,
'searchWildcardsEnabled'=> null,
// output
'output' => API_OUTPUT_EXTEND,
'countOutput' => null,
'groupCount' => null,
'preservekeys' => null,
'limit' => null
);
$this->getOptions = $this->globalGetOptions;
}
/**
* Returns the name of the database table that contains the objects.
*
* @return string
*/
public function tableName() {
return $this->tableName;
}
/**
* Returns the alias of the database table that contains the objects.
*
* @return string
*/
protected function tableAlias() {
return $this->tableAlias;
}
/**
* Returns the table name with the table alias. If the $tableName and $tableAlias
* parameters are not given, the name and the alias of the current table will be used.
*
* @param string $tableName
* @param string $tableAlias
*
* @return string
*/
protected function tableId($tableName = null, $tableAlias = null) {
$tableName = $tableName ? $tableName : $this->tableName();
$tableAlias = $tableAlias ? $tableAlias : $this->tableAlias();
return $tableName.' '.$tableAlias;
}
/**
* Prepends the table alias to the given field name. If no $tableAlias is given,
* the alias of the current table will be used.
*
* @param string $fieldName
* @param string $tableAlias
*
* @return string
*/
protected function fieldId($fieldName, $tableAlias = null) {
$tableAlias = $tableAlias ? $tableAlias : $this->tableAlias();
return $tableAlias.'.'.$fieldName;
}
/**
* Returns the name of the field that's used as a private key. If the $tableName is not given,
* the PK field of the given table will be returned.
*
* @param string $tableName;
*
* @return string
*/
public function pk($tableName = null) {
if ($tableName) {
$schema = $this->getTableSchema($tableName);
if (strpos($schema['key'], ',') !== false) {
throw new Exception('Composite private keys are not supported in this API version.');
}
return $schema['key'];
}
return $this->pk;
}
/**
* Returns the name of the option that refers the PK column. If the $tableName parameter
* is not given, the Pk option of the current table will be returned.
*
* @param string $tableName
*
* @return string
*/
public function pkOption($tableName = null) {
return $this->pk($tableName).'s';
}
/**
* Returns an array that describes the schema of the database table. If no $tableName
* is given, the schema of the current table will be returned.
*
* @param $tableName;
*
* @return array
*/
protected function getTableSchema($tableName = null) {
$tableName = $tableName ? $tableName : $this->tableName();
return DB::getSchema($tableName);
}
/**
* Returns true if the table has the given field. If no $tableName is given,
* the current table will be used.
*
* @param string $fieldName
* @param string $tableName
*
* @return boolean
*/
protected function hasField($fieldName, $tableName = null) {
$schema = $this->getTableSchema($tableName);
return isset($schema['fields'][$fieldName]);
}
/**
* Returns a translated error message.
*
* @param $id
*
* @return string
*/
protected function getErrorMsg($id) {
return $this->errorMessages[$id];
}
/**
* Adds the given fields to the "output" option if it's not already present.
*
* @param string $output
* @param array $fields either a single field name, or an array of fields
*
* @return mixed
*/
protected function outputExtend($output, array $fields) {
if ($output === null) {
return $fields;
}
// if output is set to extend, it already contains that field; return it as is
elseif ($output === API_OUTPUT_EXTEND) {
return $output;
}
// if output is an array, add the additional fields
return array_keys(array_flip(array_merge($output, $fields)));
}
/**
* Returns true if the given field is requested in the output parameter.
*
* @param $field
* @param $output
*
* @return bool
*/
protected function outputIsRequested($field, $output) {
switch ($output) {
// if all fields are requested, just return true
case API_OUTPUT_EXTEND:
return true;
// return false if nothing or an object count is requested
case API_OUTPUT_COUNT:
case null:
return false;
// if an array of fields is passed, check if the field is present in the array
default:
return in_array($field, $output);
}
}
/**
* Unsets fields $field from the given objects if they are not requested in $output.
*
* @param array $objects
* @param array $fields
* @param string|array $output desired output
*
* @return array
*/
protected function unsetExtraFields(array $objects, array $fields, $output) {
// find the fields that have not been requested
$extraFields = array();
foreach ($fields as $field) {
if (!$this->outputIsRequested($field, $output)) {
$extraFields[] = $field;
}
}
// unset these fields
if ($extraFields) {
foreach ($objects as &$object) {
foreach ($extraFields as $field) {
unset($object[$field]);
}
}
unset($object);
}
return $objects;
}
/**
* Creates a relation map for the given objects.
*
* If the $table parameter is set, the relations will be loaded from a database table, otherwise the map will be
* built from two base object properties.
*
* @param array $objects a hash of base objects
* @param string $baseField the base object ID field
* @param string $foreignField the related objects ID field
* @param string $table table to load the relation from
*
* @return CRelationMap
*/
protected function createRelationMap(array $objects, $baseField, $foreignField, $table = null) {
$relationMap = new CRelationMap();
// create the map from a database table
if ($table) {
$res = DBselect(API::getApiService()->createSelectQuery($table, array(
'output' => array($baseField, $foreignField),
'filter' => array($baseField => array_keys($objects))
)));
while ($relation = DBfetch($res)) {
$relationMap->addRelation($relation[$baseField], $relation[$foreignField]);
}
}
// create a map from the base objects
else {
foreach ($objects as $object) {
$relationMap->addRelation($object[$baseField], $object[$foreignField]);
}
}
return $relationMap;
}
/**
* Constructs an SQL SELECT query for a specific table from the given API options, executes it and returns
* the result.
*
* TODO: add global 'countOutput' support
*
* @param string $tableName
* @param array $options
*
* @return array
*/
protected function select($tableName, array $options) {
$limit = isset($options['limit']) ? $options['limit'] : null;
$sql = $this->createSelectQuery($tableName, $options);
$objects = DBfetchArray(DBSelect($sql, $limit));
if (isset($options['preservekeys'])) {
$rs = array();
foreach ($objects as $object) {
$rs[$object[$this->pk($tableName)]] = $object;
}
return $rs;
}
else {
return $objects;
}
}
/**
* Creates an SQL SELECT query from the given options.
*
* @param string $tableName
* @param array $options
*
* @return array
*/
protected function createSelectQuery($tableName, array $options) {
$sqlParts = $this->createSelectQueryParts($tableName, $this->tableAlias(), $options);
return $this->createSelectQueryFromParts($sqlParts);
}
/**
* Builds an SQL parts array from the given options.
*
* @param string $tableName
* @param string $tableAlias
* @param array $options
*
* @return array The resulting SQL parts array
*/
protected function createSelectQueryParts($tableName, $tableAlias, array $options) {
// extend default options
$options = zbx_array_merge($this->globalGetOptions, $options);
$sqlParts = array(
'select' => array($this->fieldId($this->pk($tableName), $tableAlias)),
'from' => array($this->tableId($tableName, $tableAlias)),
'where' => array(),
'group' => array(),
'order' => array(),
'limit' => null
);
// add filter options
$sqlParts = $this->applyQueryFilterOptions($tableName, $tableAlias, $options, $sqlParts);
// add output options
$sqlParts = $this->applyQueryOutputOptions($tableName, $tableAlias, $options, $sqlParts);
// add sort options
$sqlParts = $this->applyQuerySortOptions($tableName, $tableAlias, $options, $sqlParts);
return $sqlParts;
}
/**
* Creates a SELECT SQL query from the given SQL parts array.
*
* @param array $sqlParts An SQL parts array
*
* @return string The resulting SQL query
*/
protected function createSelectQueryFromParts(array $sqlParts) {
// build query
$sqlSelect = implode(',', array_unique($sqlParts['select']));
$sqlFrom = implode(',', array_unique($sqlParts['from']));
$sqlWhere = empty($sqlParts['where']) ? '' : ' WHERE '.implode(' AND ', array_unique($sqlParts['where']));
$sqlGroup = empty($sqlParts['group']) ? '' : ' GROUP BY '.implode(',', array_unique($sqlParts['group']));
$sqlOrder = empty($sqlParts['order']) ? '' : ' ORDER BY '.implode(',', array_unique($sqlParts['order']));
return 'SELECT '.zbx_db_distinct($sqlParts).' '.$sqlSelect.
' FROM '.$sqlFrom.
$sqlWhere.
$sqlGroup.
$sqlOrder;
}
/**
* Modifies the SQL parts to implement all of the output related options.
*
* @param string $tableName
* @param string $tableAlias
* @param array $options
* @param array $sqlParts
*
* @return array The resulting SQL parts array
*/
protected function applyQueryOutputOptions($tableName, $tableAlias, array $options, array $sqlParts) {
$pkFieldId = $this->fieldId($this->pk($tableName), $tableAlias);
// count
if (isset($options['countOutput']) && !$this->requiresPostSqlFiltering($options)) {
$sqlParts['select'] = array('COUNT(DISTINCT '.$pkFieldId.') AS rowscount');
// select columns used by group count
if (isset($options['groupCount'])) {
foreach ($sqlParts['group'] as $fields) {
$sqlParts['select'][] = $fields;
}
}
}
// custom output
elseif (is_array($options['output'])) {
// the pk field must always be included for the API to work properly
$sqlParts['select'] = array($pkFieldId);
foreach ($options['output'] as $field) {
if ($this->hasField($field, $tableName)) {
$sqlParts['select'][] = $this->fieldId($field, $tableAlias);
}
}
$sqlParts['select'] = array_unique($sqlParts['select']);
}
// extended output
elseif ($options['output'] == API_OUTPUT_EXTEND) {
// TODO: API_OUTPUT_EXTEND must return ONLY the fields from the base table
$sqlParts = $this->addQuerySelect($this->fieldId('*', $tableAlias), $sqlParts);
}
return $sqlParts;
}
/**
* Modifies the SQL parts to implement all of the filter related options.
*
* @param string $tableName
* @param string $tableAlias
* @param array $options
* @param array $sqlParts
*
* @return array The resulting SQL parts array
*/
protected function applyQueryFilterOptions($tableName, $tableAlias, array $options, array $sqlParts) {
$pkOption = $this->pkOption($tableName);
$tableId = $this->tableId($tableName, $tableAlias);
// pks
if (isset($options[$pkOption])) {
zbx_value2array($options[$pkOption]);
$sqlParts['where'][] = dbConditionString($this->fieldId($this->pk($tableName), $tableAlias), $options[$pkOption]);
}
// filters
if (is_array($options['filter'])) {
$this->dbFilter($tableId, $options, $sqlParts);
}
// search
if (is_array($options['search'])) {
zbx_db_search($tableId, $options, $sqlParts);
}
return $sqlParts;
}
/**
* Modifies the SQL parts to implement all of the sorting related options.
* Sorting is currently only supported for CApiService::get() methods.
*
* @param string $tableName
* @param string $tableAlias
* @param array $options
* @param array $sqlParts
*
* @return array
*/
protected function applyQuerySortOptions($tableName, $tableAlias, array $options, array $sqlParts) {
if ($this->sortColumns && !zbx_empty($options['sortfield'])) {
$options['sortfield'] = is_array($options['sortfield'])
? array_unique($options['sortfield'])
: array($options['sortfield']);
foreach ($options['sortfield'] as $i => $sortfield) {
// validate sortfield
if (!str_in_array($sortfield, $this->sortColumns)) {
throw new APIException(ZBX_API_ERROR_INTERNAL, _s('Sorting by field "%1$s" not allowed.', $sortfield));
}
// add sort field to order
$sortorder = '';
if (is_array($options['sortorder'])) {
if (!empty($options['sortorder'][$i])) {
$sortorder = ($options['sortorder'][$i] == ZBX_SORT_DOWN) ? ' '.ZBX_SORT_DOWN : '';
}
}
else {
$sortorder = ($options['sortorder'] == ZBX_SORT_DOWN) ? ' '.ZBX_SORT_DOWN : '';
}
$sqlParts = $this->applyQuerySortField($sortfield, $sortorder, $tableAlias, $sqlParts);
}
}
return $sqlParts;
}
/**
* Adds a specific property from the 'sortfield' parameter to the $sqlParts array.
*
* @param string $sortfield
* @param string $sortorder
* @param string $alias
* @param array $sqlParts
*
* @return array
*/
protected function applyQuerySortField($sortfield, $sortorder, $alias, array $sqlParts) {
// add sort field to select if distinct is used
if (count($sqlParts['from']) > 1
&& !str_in_array($alias.'.'.$sortfield, $sqlParts['select'])
&& !str_in_array($alias.'.*', $sqlParts['select'])) {
$sqlParts['select'][$sortfield] = $alias.'.'.$sortfield;
}
$sqlParts['order'][$alias.'.'.$sortfield] = $alias.'.'.$sortfield.$sortorder;
return $sqlParts;
}
/**
* Adds the given field to the SELECT part of the $sqlParts array if it's not already present.
* If $sqlParts['select'] not present it is created and field appended.
*
* @param string $fieldId
* @param array $sqlParts
*
* @return array
*/
protected function addQuerySelect($fieldId, array $sqlParts) {
if (!isset($sqlParts['select'])) {
return array('select' => array($fieldId));
}
list($tableAlias, $field) = explode('.', $fieldId);
if (!in_array($fieldId, $sqlParts['select']) && !in_array($this->fieldId('*', $tableAlias), $sqlParts['select'])) {
// if we want to select all of the columns, other columns from this table can be removed
if ($field == '*') {
foreach ($sqlParts['select'] as $key => $selectFieldId) {
list($selectTableAlias,) = explode('.', $selectFieldId);
if ($selectTableAlias == $tableAlias) {
unset($sqlParts['select'][$key]);
}
}
}
$sqlParts['select'][] = $fieldId;
}
return $sqlParts;
}
/**
* Adds the given field to the ORDER BY part of the $sqlParts array.
*
* @param string $fieldId
* @param array $sqlParts
* @param string $sortorder sort direction, ZBX_SORT_UP or ZBX_SORT_DOWN
*
* @return array
*/
protected function addQueryOrder($fieldId, array $sqlParts, $sortorder = null) {
// some databases require the sortable column to be present in the SELECT part of the query
$sqlParts = $this->addQuerySelect($fieldId, $sqlParts);
$sqlParts['order'][$fieldId] = $fieldId.($sortorder ? ' '.$sortorder : '');
return $sqlParts;
}
/**
* Adds the related objects requested by "select*" options to the resulting object set.
*
* @param array $options
* @param array $result an object hash with PKs as keys
* @return array mixed
*/
protected function addRelatedObjects(array $options, array $result) {
// must be implemented in each API separately
return $result;
}
/**
* Deletes the object with the given IDs with respect to relative objects.
*
* The method must be extended to handle relative objects.
*
* @param array $ids
*/
protected function deleteByIds(array $ids) {
DB::delete($this->tableName(), array(
$this->pk() => $ids
));
}
/**
* Fetches the fields given in $fields from the database and extends the objects with the loaded data.
*
* @param string $tableName
* @param array $objects
* @param array $fields
*
* @return array
*/
protected function extendObjects($tableName, array $objects, array $fields) {
$dbObjects = API::getApiService()->select($tableName, array(
'output' => $fields,
$this->pkOption($tableName) => zbx_objectValues($objects, $this->pk($tableName)),
'preservekeys' => true
));
foreach ($objects as &$object) {
$pk = $object[$this->pk($tableName)];
if (isset($dbObjects[$pk])) {
check_db_fields($dbObjects[$pk], $object);
}
}
return $objects;
}
/**
* An extendObjects() wrapper for singular objects.
*
* @see extendObjects()
*
* @param string $tableName
* @param array $object
* @param array $fields
*
* @return mixed
*/
protected function extendObject($tableName, array $object, array $fields) {
$objects = $this->extendObjects($tableName, array($object), $fields);
return reset($objects);
}
/**
* For each object in $objects the method copies fields listed in $fields that are not present in the target
* object from from the source object.
*
* Matching objects in both arrays must have the same keys.
*
* @param array $objects
* @param array $sourceObjects
*
* @return array
*/
protected function extendFromObjects(array $objects, array $sourceObjects, array $fields) {
$fields = array_flip($fields);
foreach ($objects as $key => &$object) {
if (isset($sourceObjects[$key])) {
$object += array_intersect_key($sourceObjects[$key], $fields);
}
}
unset($object);
return $objects;
}
/**
* Checks that each object has a valid ID.
*
* @param array $objects
* @param $idField name of the field that contains the id
* @param $messageRequired error message if no ID is given
* @param $messageEmpty error message if the ID is empty
* @param $messageInvalid error message if the ID is invalid
*/
protected function checkObjectIds(array $objects, $idField, $messageRequired, $messageEmpty, $messageInvalid) {
$idValidator = new CIdValidator(array(
'messageEmpty' => $messageEmpty,
'messageInvalid' => $messageInvalid
));
foreach ($objects as $object) {
if (!isset($object[$idField])) {
self::exception(ZBX_API_ERROR_PARAMETERS, _params($messageRequired, array($idField)));
}
$this->checkValidator($object[$idField], $idValidator);
}
}
/**
* Checks if the object has any fields, that are not defined in the schema or in $additionalFields.
*
* @param string $tableName
* @param array $object
* @param string $error
* @param array $extraFields an array of field names, that are not present in the schema, but may be
* used in requests
*
* @throws APIException
*/
protected function checkUnsupportedFields($tableName, array $object, $error, array $extraFields = array()) {
$extraFields = array_flip($extraFields);
foreach ($object as $field => $value) {
if (!DB::hasField($tableName, $field) && !isset($extraFields[$field])) {
self::exception(ZBX_API_ERROR_PARAMETERS, $error);
}
}
}
/**
* Checks if an objects contains any of the given parameters.
*
* Example:
* checkNoParameters($item, array('templateid', 'state'), _('Cannot set "%1$s" for item "%2$s".'), $item['name']);
* If any of the parameters 'templateid' or 'state' are present in the object, it will be placed in "%1$s"
* and $item['name'] will be placed in "%2$s".
*
* @throws APIException if any of the parameters are present in the object
*
* @param array $object
* @param array $params array of parameters to check
* @param string $error
* @param string $objectName
*/
protected function checkNoParameters(array $object, array $params, $error, $objectName) {
foreach ($params as $param) {
if (array_key_exists($param, $object)) {
$error = _params($error, array($param, $objectName));
self::exception(ZBX_API_ERROR_PARAMETERS, $error);
}
}
}
/**
* Throws an API exception.
*
* @static
*
* @param int $code
* @param string $error
*/
protected static function exception($code = ZBX_API_ERROR_INTERNAL, $error = '') {
throw new APIException($code, $error);
}
/**
* Triggers a deprecated notice. Should be called when a deprecated parameter or method is used.
* The notice will not be displayed in the result returned by an API method.
*
* @param string $error error text
*/
protected function deprecated($error) {
trigger_error($error, E_USER_NOTICE);
}
/**
* Apply filter conditions to sql built query.
*
* @param string $table
* @param array $options
* @param array $sqlParts
*
* @return bool
*/
protected function dbFilter($table, $options, &$sqlParts) {
list($table, $tableShort) = explode(' ', $table);
$tableSchema = DB::getSchema($table);
$filter = array();
foreach ($options['filter'] as $field => $value) {
// skip missing fields and text fields (not supported by Oracle)
// skip empty values
if (!isset($tableSchema['fields'][$field]) || $tableSchema['fields'][$field]['type'] == DB::FIELD_TYPE_TEXT
|| zbx_empty($value)) {
continue;
}
zbx_value2array($value);
$fieldName = $this->fieldId($field, $tableShort);
$filter[$field] = DB::isNumericFieldType($tableSchema['fields'][$field]['type'])
? dbConditionInt($fieldName, $value)
: dbConditionString($fieldName, $value);
}
if ($filter) {
if (isset($sqlParts['where']['filter'])) {
$filter[] = $sqlParts['where']['filter'];
}
if (is_null($options['searchByAny']) || $options['searchByAny'] === false || count($filter) == 1) {
$sqlParts['where']['filter'] = implode(' AND ', $filter);
}
else {
$sqlParts['where']['filter'] = '('.implode(' OR ', $filter).')';
}
return true;
}
return false;
}
/**
* Converts a deprecated parameter to a new one in the $params array. If both parameter are used,
* the new parameter will override the deprecated one.
* If a deprecated parameter is used, a notice will be triggered in the frontend.
*
* @param array $params
* @param string $deprecatedParam
* @param string $newParam
*
* @return array
*/
protected function convertDeprecatedParam(array $params, $deprecatedParam, $newParam) {
if (isset($params[$deprecatedParam])) {
self::deprecated('Parameter "'.$deprecatedParam.'" is deprecated.');
// if the new parameter is not used, use the deprecated one instead
if (!isset($params[$newParam])) {
$params[$newParam] = $params[$deprecatedParam];
}
// unset the deprecated parameter
unset($params[$deprecatedParam]);
}
return $params;
}
/**
* Check if a set of parameters contains a deprecated parameter or a a parameter with a deprecated value.
* If $value is not set, the method will trigger a deprecated notice if $params contains the $paramName key.
* If $value is set, the method will trigger a notice if the value of the parameter is equal to the deprecated value
* or the parameter is an array and contains a deprecated value.
*
* @param array $params
* @param string $paramName
* @param string $value
*
* @return void
*/
protected function checkDeprecatedParam(array $params, $paramName, $value = null) {
if (isset($params[$paramName])) {
if ($value === null) {
self::deprecated('Parameter "'.$paramName.'" is deprecated.');
}
elseif (is_array($params[$paramName]) && in_array($value, $params[$paramName]) || $params[$paramName] == $value) {
self::deprecated('Value "'.$value.'" for parameter "'.$paramName.'" is deprecated.');
}
}
}
/**
* Runs the given validator and throws an exception if it fails.
*
* @param $value
* @param CValidator $validator
*/
protected function checkValidator($value, CValidator $validator) {
if (!$validator->validate($value)) {
self::exception(ZBX_API_ERROR_INTERNAL, $validator->getError());
}
}
/**
* Runs the given partial validator and throws an exception if it fails.
*
* @param array $array
* @param CPartialValidatorInterface $validator
* @param array $fullArray
*/
protected function checkPartialValidator(array $array, CPartialValidatorInterface $validator, $fullArray = array()) {
if (!$validator->validatePartial($array, $fullArray)) {
self::exception(ZBX_API_ERROR_INTERNAL, $validator->getError());
}
}
/**
* Adds a deprecated property to an array of resulting objects if it's requested in $output. The value for the
* deprecated property will be taken from the new one.
*
* @param array $objects
* @param string $deprecatedProperty
* @param string $newProperty
* @param string|array $output
*
* @return array
*/
protected function handleDeprecatedOutput(array $objects, $deprecatedProperty, $newProperty, $output) {
if ($this->outputIsRequested($deprecatedProperty, $output)) {
foreach ($objects as &$object) {
$object[$deprecatedProperty] = $object[$newProperty];
}
unset($object);
}
return $objects;
}
/**
* Fetch data from DB.
* If post SQL filtering is necessary, several queries will be executed. SQL limit is calculated so that minimum
* amount of queries would be executed and minimum amount of unnecessary data retrieved.
*
* @param string $query SQL query
* @param array $options API call parameters
*
* @return array
*/
protected function customFetch($query, array $options) {
if ($this->requiresPostSqlFiltering($options)) {
$offset = 0;
// we think that taking twice as necessary elements in first query is fair guess, this cast to int as well
$limit = $options['limit'] ? 2 * $options['limit'] : null;
// we use $minLimit for setting minimum limit twice as big for each consecutive query to not run in lots
// of queries for some cases
$minLimit = $limit;
$allElements = array();
do {
// fetch group of elements
$elements = DBfetchArray(DBselect($query, $limit, $offset));
// we have potentially more elements
$hasMore = ($limit && count($elements) === $limit);
$elements = $this->applyPostSqlFiltering($elements, $options);
// truncate element set after post SQL filtering, if enough elements or more retrieved via SQL query
if ($options['limit'] && count($allElements) + count($elements) >= $options['limit']) {
$allElements += array_slice($elements, 0, $options['limit'] - count($allElements), true);
break;
}
$allElements += $elements;
// calculate $limit and $offset for next query
if ($limit) {
$offset += $limit;
$minLimit *= 2;
// take care of division by zero
$elemCount = count($elements) ? count($elements) : 1;
// we take $limit as $minLimit or reasonable estimate to get all necessary data in two queries
// with high probability
$limit = max($minLimit, round($limit / $elemCount * ($options['limit'] - count($allElements)) * 2));
}
} while ($hasMore);
return $allElements;
}
else {
return DBfetchArray(DBselect($query, $options['limit']));
}
}
/**
* Checks if post SQL filtering necessary.
*
* @param array $options API call parameters
*
* @return bool true if filtering necessary false otherwise
*/
protected function requiresPostSqlFiltering(array $options) {
// must be implemented in each API separately
return false;
}
/**
* Removes elements which could not be removed within SQL query.
*
* @param array $elements list of elements on whom perform filtering
* @param array $options API call parameters
*
* @return array input array $elements with some elements removed
*/
protected function applyPostSqlFiltering(array $elements, array $options) {
// must be implemented in each API separately
return $elements;
}
}
|