-
Notifications
You must be signed in to change notification settings - Fork 1
/
gacl_api.class.php
3899 lines (3234 loc) · 118 KB
/
gacl_api.class.php
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
<?php
/**
* phpGACL - Generic Access Control List
* Copyright (C) 2002,2003 Mike Benoit
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* For questions, help, comments, discussion, etc., please join the
* phpGACL mailing list. http://sourceforge.net/mail/?group_id=57103
*
* You may contact the author of phpGACL by e-mail at:
*
* The latest version of phpGACL can be obtained from:
* http://phpgacl.sourceforge.net/
*
* @package phpGACL
*
*/
/*
*
* For examples, see example.php or the Administration interface,
* as it makes use of nearly every API Call.
*
*/
/**
* gacl_api Extended API Class
*
* Class gacl_api should be used for applications that must interface directly with
* phpGACL's data structures, objects, and rules.
*
* @package phpGACL
* @author Mike Benoit <[email protected]>
*
*/
class gacl_api extends gacl {
/*
*
* Misc helper functions.
*
*/
/**
* showarray()
*
* Dump all contents of an array in HTML (kinda)
*
* @param array
*
*/
function showarray($array) {
echo "<br><pre>\n";
var_dump($array);
echo "</pre><br>\n";
}
/**
* count_all()
*
* Recursively counts elements in an array and sub-arrays.
*
* This is different from count($arg, COUNT_RECURSIVE)
* in PHP >= 4.2.0, which includes sub-arrays in the count.
*
* @return int The returned count is a count of all scalar elements found.
*
* @param array Array to count
*/
function count_all($arg = NULL) {
switch (TRUE) {
case is_scalar($arg):
case is_object($arg):
// single object
return 1;
case is_array($arg):
// call recursively for all elements of $arg
$count = 0;
foreach ($arg as $val) {
$count += $this->count_all($val);
}
return $count;
}
return FALSE;
}
/**
* get_version()
*
* Grabs phpGACL version from the database.
*
* @return string Version of phpGACL
*/
function get_version() {
$query = "select value from ".$this->_db_table_prefix."phpgacl where name = 'version'";
$version = $this->db->GetOne($query);
return $version;
}
/**
* get_schema_version()
*
* Grabs phpGACL schema version from the database.
*
* @return string Schema Version
*/
function get_schema_version() {
$query = "select value from ".$this->_db_table_prefix."phpgacl where name = 'schema_version'";
$version = $this->db->GetOne($query);
return $version;
}
/*
*
* ACL
*
*/
/**
* consolidated_edit_acl()
*
* Add's an ACL but checks to see if it can consolidate it with another one first.
*
* This ONLY works with ACO's and ARO's. Groups, and AXO are excluded.
* As well this function is designed for handling ACLs with return values,
* and consolidating on the return_value, in hopes of keeping the ACL count to a minimum.
*
* A return value of false must _always_ be handled outside this function.
* As this function will remove AROs from ACLs and return false, in most cases
* you will need to a create a completely new ACL on a false return.
*
* @return bool Special boolean return value. See note.
*
* @param string ACO Section Value
* @param string ACO Value
* @param string ARO Section Value
* @param string ARO Value
* @param string Return Value of ACL
*/
function consolidated_edit_acl($aco_section_value, $aco_value, $aro_section_value, $aro_value, $return_value) {
$this->debug_text("consolidated_edit_acl(): ACO Section Value: $aco_section_value ACO Value: $aco_value ARO Section Value: $aro_section_value ARO Value: $aro_value Return Value: $return_value");
$acl_ids = array();
if (empty($aco_section_value) ) {
$this->debug_text("consolidated_edit_acl(): ACO Section Value ($aco_section_value) is empty, this is required!");
return false;
}
if (empty($aco_value) ) {
$this->debug_text("consolidated_edit_acl(): ACO Value ($aco_value) is empty, this is required!");
return false;
}
if (empty($aro_section_value) ) {
$this->debug_text("consolidated_edit_acl(): ARO Section Value ($aro_section_value) is empty, this is required!");
return false;
}
if (empty($aro_value) ) {
$this->debug_text("consolidated_edit_acl(): ARO Value ($aro_value) is empty, this is required!");
return false;
}
if (empty($return_value) ) {
$this->debug_text("consolidated_edit_acl(): Return Value ($return_value) is empty, this is required!");
return false;
}
//See if a current ACL exists with the current objects, excluding return value
$current_acl_ids = $this->search_acl($aco_section_value, $aco_value, $aro_section_value, $aro_value, FALSE, FALSE, FALSE, FALSE, FALSE);
//showarray($current_acl_ids);
if (is_array($current_acl_ids)) {
$this->debug_text("add_consolidated_acl(): Found current ACL_IDs, counting ACOs");
foreach ($current_acl_ids as $current_acl_id) {
//Check to make sure these ACLs only have a single ACO mapped to them.
$current_acl_array = &$this->get_acl($current_acl_id);
//showarray($current_acl_array);
$this->debug_text("add_consolidated_acl(): Current Count: ".$this->count_all($current_acl_array['aco'])."");
if ( $this->count_all($current_acl_array['aco']) == 1) {
$this->debug_text("add_consolidated_acl(): ACL ID: $current_acl_id has 1 ACO.");
//Test to see if the return values match, if they do, no need removing or appending ARO. Just return true.
if ($current_acl_array['return_value'] == $return_value) {
$this->debug_text("add_consolidated_acl(): ACL ID: $current_acl_id has 1 ACO, and the same return value. No need to modify.");
return true;
}
$acl_ids[] = $current_acl_id;
}
}
}
//showarray($acl_ids);
$acl_ids_count = count($acl_ids);
//If acl_id's turns up more then one ACL, lets remove the ARO from all of them in hopes to
//eliminate any conflicts.
if (is_array($acl_ids) AND $acl_ids_count > 0) {
$this->debug_text("add_consolidated_acl(): Removing specified ARO from existing ACL.");
foreach ($acl_ids as $acl_id) {
//Remove ARO from current ACLs, so we don't create conflicting ACLs later on.
if (!$this->shift_acl($acl_id, array($aro_section_value => array($aro_value)) ) ) {
$this->debug_text("add_consolidated_acl(): Error removing specified ARO from ACL ID: $acl_id");
return false;
}
}
} else {
$this->debug_text("add_consolidated_acl(): Didn't find any current ACLs with a single ACO. ");
}
//unset($acl_ids);
$acl_ids = array();
unset($acl_ids_count);
//At this point there should be no conflicting ACLs, searching for an existing ACL with the new values.
$new_acl_ids = $this->search_acl($aco_section_value, $aco_value, FALSE, FALSE, NULL, NULL, NULL, NULL, $return_value);
$new_acl_count = count($new_acl_ids);
//showarray($new_acl_ids);
if (is_array($new_acl_ids)) {
$this->debug_text("add_consolidated_acl(): Found new ACL_IDs, counting ACOs");
foreach ($new_acl_ids as $new_acl_id) {
//Check to make sure these ACLs only have a single ACO mapped to them.
$new_acl_array = &$this->get_acl($new_acl_id);
//showarray($new_acl_array);
$this->debug_text("add_consolidated_acl(): New Count: ".$this->count_all($new_acl_array['aco'])."");
if ( $this->count_all($new_acl_array['aco']) == 1) {
$this->debug_text("add_consolidated_acl(): ACL ID: $new_acl_id has 1 ACO, append should be able to take place.");
$acl_ids[] = $new_acl_id;
}
}
}
//showarray($acl_ids);
$acl_ids_count = count($acl_ids);
if (is_array($acl_ids) AND $acl_ids_count == 1) {
$this->debug_text("add_consolidated_acl(): Appending specified ARO to existing ACL.");
$acl_id=$acl_ids[0];
if (!$this->append_acl($acl_id, array($aro_section_value => array($aro_value)) ) ) {
$this->debug_text("add_consolidated_acl(): Error appending specified ARO to ACL ID: $acl_id");
return false;
}
$this->debug_text("add_consolidated_acl(): Hot damn, ACL consolidated!");
return true;
} elseif($acl_ids_count > 1) {
$this->debug_text("add_consolidated_acl(): Found more then one ACL with a single ACO. Possible conflicting ACLs.");
return false;
} elseif ($acl_ids_count == 0) {
$this->debug_text("add_consolidated_acl(): No existing ACLs found, create a new one.");
if (!$this->add_acl( array( $aco_section_value => array($aco_value) ),
array( $aro_section_value => array($aro_value) ),
NULL,
NULL,
NULL,
TRUE,
TRUE,
$return_value,
NULL)
) {
$this->debug_text("add_consolidated_acl(): Error adding new ACL for ACO Section: $aco_section_value ACO Value: $aco_value Return Value: $return_value");
return false;
}
$this->debug_text("add_consolidated_acl(): ADD_ACL() successfull, returning True.");
return true;
}
$this->debug_text("add_consolidated_acl(): Returning false.");
return false;
}
/**
* search_acl()
*
* Searches for ACL's with specified objects mapped to them.
*
* NULL values are included in the search, if you want to ignore
* for instance aro_groups use FALSE instead of NULL.
*
* @return array containing ACL IDs if search is successful
*
* @param string ACO Section Value
* @param string ACO Value
* @param string ARO Section Value
* @param string ARO Value
* @param string ARO Group Name
* @param string AXO Section Value
* @param string AXO Value
* @param string AXO Group Name
* @param string Return Value
*/
function search_acl($aco_section_value=NULL, $aco_value=NULL, $aro_section_value=NULL, $aro_value=NULL, $aro_group_name=NULL, $axo_section_value=NULL, $axo_value=NULL, $axo_group_name=NULL, $return_value=NULL) {
$this->debug_text("search_acl(): aco_section_value: $aco_section_value aco_value: $aco_value, aro_section_value: $aro_section_value, aro_value: $aro_value, aro_group_name: $aro_group_name, axo_section_value: $axo_section_value, axo_value: $axo_value, axo_group_name: $axo_group_name, return_value: $return_value");
$query = '
SELECT a.id
FROM '. $this->_db_table_prefix .'acl a';
$where_query = array();
// ACO
if ($aco_section_value !== FALSE AND $aco_value !== FALSE) {
$query .= '
LEFT JOIN '. $this->_db_table_prefix .'aco_map ac ON a.id=ac.acl_id';
if ($aco_section_value == NULL AND $aco_value == NULL) {
$where_query[] = '(ac.section_value IS NULL AND ac.value IS NULL)';
} else {
$where_query[] = '(ac.section_value='. $this->db->quote($aco_section_value) .' AND ac.value='. $this->db->quote($aco_value) .')';
}
}
// ARO
if ($aro_section_value !== FALSE AND $aro_value !== FALSE) {
$query .= '
LEFT JOIN '. $this->_db_table_prefix .'aro_map ar ON a.id=ar.acl_id';
if ($aro_section_value == NULL AND $aro_value == NULL) {
$where_query[] = '(ar.section_value IS NULL AND ar.value IS NULL)';
} else {
$where_query[] = '(ar.section_value='. $this->db->quote($aro_section_value) .' AND ar.value='. $this->db->quote($aro_value) .')';
}
}
// AXO
if ($axo_section_value !== FALSE AND $axo_value !== FALSE) {
$query .= '
LEFT JOIN '. $this->_db_table_prefix .'axo_map ax ON a.id=ax.acl_id';
if ($axo_section_value == NULL AND $axo_value == NULL) {
$where_query[] = '(ax.section_value IS NULL AND ax.value IS NULL)';
} else {
$where_query[] = '(ax.section_value='. $this->db->quote($axo_section_value) .' AND ax.value='. $this->db->quote($axo_value) .')';
}
}
// ARO Group
if ($aro_group_name !== FALSE) {
$query .= '
LEFT JOIN '. $this->_db_table_prefix .'aro_groups_map arg ON a.id=arg.acl_id
LEFT JOIN '. $this->_db_table_prefix .'aro_groups rg ON arg.group_id=rg.id';
if ($aro_group_name == NULL) {
$where_query[] = '(rg.name IS NULL)';
} else {
$where_query[] = '(rg.name='. $this->db->quote($aro_group_name) .')';
}
}
// AXO Group
if ($axo_group_name !== FALSE) {
$query .= '
LEFT JOIN '. $this->_db_table_prefix .'axo_groups_map axg ON a.id=axg.acl_id
LEFT JOIN '. $this->_db_table_prefix .'axo_groups xg ON axg.group_id=xg.id';
if ($axo_group_name == NULL) {
$where_query[] = '(xg.name IS NULL)';
} else {
$where_query[] = '(xg.name='. $this->db->quote($axo_group_name) .')';
}
}
if ($return_value != FALSE) {
if ($return_value == NULL) {
$where_query[] = '(a.return_value IS NULL)';
} else {
$where_query[] = '(a.return_value='. $this->db->quote($return_value) .')';
}
}
if (count($where_query) > 0) {
$query .= '
WHERE '. implode (' AND ', $where_query);
}
return $this->db->GetCol($query);
}
/**
* append_acl()
*
* Appends objects on to a specific ACL.
*
* @return bool TRUE if successful, FALSE otherwise.
*
* @param int ACL ID #
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
*/
function append_acl($acl_id, $aro_array=NULL, $aro_group_ids=NULL, $axo_array=NULL, $axo_group_ids=NULL, $aco_array=NULL) {
$this->debug_text("append_acl(): ACL_ID: $acl_id");
$update = 0;
if (empty($acl_id)) {
$this->debug_text("append_acl(): No ACL_ID specified! ACL_ID: $acl_id");
return false;
}
//Grab ACL data.
$acl_array = &$this->get_acl($acl_id);
//Append each object type seperately.
if (is_array($aro_array) AND count($aro_array) > 0) {
$this->debug_text("append_acl(): Appending ARO's");
while (list($aro_section_value,$aro_value_array) = @each($aro_array)) {
foreach ($aro_value_array as $aro_value) {
if ( count($acl_array['aro'][$aro_section_value]) != 0 ) {
if (!in_array($aro_value, $acl_array['aro'][$aro_section_value])) {
$this->debug_text("append_acl(): ARO Section Value: $aro_section_value ARO VALUE: $aro_value");
$acl_array['aro'][$aro_section_value][] = $aro_value;
$update=1;
} else {
$this->debug_text("append_acl(): Duplicate ARO, ignoring... ");
}
} else { //Array is empty so add this aro value.
$acl_array['aro'][$aro_section_value][] = $aro_value;
$update = 1;
}
}
}
}
if (is_array($aro_group_ids) AND count($aro_group_ids) > 0) {
$this->debug_text("append_acl(): Appending ARO_GROUP_ID's");
while (list(,$aro_group_id) = @each($aro_group_ids)) {
if (!is_array($acl_array['aro_groups']) OR !in_array($aro_group_id, $acl_array['aro_groups'])) {
$this->debug_text("append_acl(): ARO Group ID: $aro_group_id");
$acl_array['aro_groups'][] = $aro_group_id;
$update = 1;
} else {
$this->debug_text("append_acl(): Duplicate ARO_Group_ID, ignoring... ");
}
}
}
if (is_array($axo_array) AND count($axo_array) > 0) {
$this->debug_text("append_acl(): Appending AXO's");
while (list($axo_section_value,$axo_value_array) = @each($axo_array)) {
foreach ($axo_value_array as $axo_value) {
if (!in_array($axo_value, $acl_array['axo'][$axo_section_value])) {
$this->debug_text("append_acl(): AXO Section Value: $axo_section_value AXO VALUE: $axo_value");
$acl_array['axo'][$axo_section_value][] = $axo_value;
$update = 1;
} else {
$this->debug_text("append_acl(): Duplicate AXO, ignoring... ");
}
}
}
}
if (is_array($axo_group_ids) AND count($axo_group_ids) > 0) {
$this->debug_text("append_acl(): Appending AXO_GROUP_ID's");
while (list(,$axo_group_id) = @each($axo_group_ids)) {
if (!is_array($acl_array['axo_groups']) OR !in_array($axo_group_id, $acl_array['axo_groups'])) {
$this->debug_text("append_acl(): AXO Group ID: $axo_group_id");
$acl_array['axo_groups'][] = $axo_group_id;
$update = 1;
} else {
$this->debug_text("append_acl(): Duplicate ARO_Group_ID, ignoring... ");
}
}
}
if (is_array($aco_array) AND count($aco_array) > 0) {
$this->debug_text("append_acl(): Appending ACO's");
while (list($aco_section_value,$aco_value_array) = @each($aco_array)) {
foreach ($aco_value_array as $aco_value) {
if (!in_array($aco_value, $acl_array['aco'][$aco_section_value])) {
$this->debug_text("append_acl(): ACO Section Value: $aco_section_value ACO VALUE: $aco_value");
$acl_array['aco'][$aco_section_value][] = $aco_value;
$update = 1;
} else {
$this->debug_text("append_acl(): Duplicate ACO, ignoring... ");
}
}
}
}
if ($update == 1) {
$this->debug_text("append_acl(): Update flag set, updating ACL.");
//function edit_acl($acl_id, $aco_array, $aro_array, $aro_group_ids=NULL, $axo_array=NULL, $axo_group_ids=NULL, $allow=1, $enabled=1, $return_value=NULL, $note=NULL) {
return $this->edit_acl($acl_id, $acl_array['aco'], $acl_array['aro'], $acl_array['aro_groups'], $acl_array['axo'], $acl_array['axo_groups'], $acl_array['allow'], $acl_array['enabled'], $acl_array['return_value'], $acl_array['note']);
}
//Return true if everything is duplicate and no ACL id updated.
$this->debug_text("append_acl(): Update flag not set, NOT updating ACL.");
return true;
}
/**
* shift_acl()
*
* Opposite of append_acl(). Removes objects from a specific ACL. (named after PHP's array_shift())
*
* @return bool TRUE if successful, FALSE otherwise.
*
* @param int ACL ID #
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
*/
function shift_acl($acl_id, $aro_array=NULL, $aro_group_ids=NULL, $axo_array=NULL, $axo_group_ids=NULL, $aco_array=NULL) {
$this->debug_text("shift_acl(): ACL_ID: $acl_id");
$update = 0;
if (empty($acl_id)) {
$this->debug_text("shift_acl(): No ACL_ID specified! ACL_ID: $acl_id");
return false;
}
//Grab ACL data.
$acl_array = &$this->get_acl($acl_id);
//showarray($acl_array);
//Remove each object type seperately.
if (is_array($aro_array) AND count($aro_array) > 0) {
$this->debug_text("shift_acl(): Removing ARO's");
while (list($aro_section_value,$aro_value_array) = @each($aro_array)) {
foreach ($aro_value_array as $aro_value) {
$this->debug_text("shift_acl(): ARO Section Value: $aro_section_value ARO VALUE: $aro_value");
//Only search if aro array contains data.
if ( count($acl_array['aro'][$aro_section_value]) != 0 ) {
$aro_key = array_search($aro_value, $acl_array['aro'][$aro_section_value]);
if ($aro_key !== FALSE) {
$this->debug_text("shift_acl(): Removing ARO. ($aro_key)");
unset($acl_array['aro'][$aro_section_value][$aro_key]);
$update = 1;
} else {
$this->debug_text("shift_acl(): ARO doesn't exist, can't remove it.");
}
}
}
}
}
if (is_array($aro_group_ids) AND count($aro_group_ids) > 0) {
$this->debug_text("shift_acl(): Removing ARO_GROUP_ID's");
while (list(,$aro_group_id) = @each($aro_group_ids)) {
$this->debug_text("shift_acl(): ARO Group ID: $aro_group_id");
$aro_group_key = array_search($aro_group_id, $acl_array['aro_groups']);
if ($aro_group_key !== FALSE) {
$this->debug_text("shift_acl(): Removing ARO Group. ($aro_group_key)");
unset($acl_array['aro_groups'][$aro_group_key]);
$update = 1;
} else {
$this->debug_text("shift_acl(): ARO Group doesn't exist, can't remove it.");
}
}
}
if (is_array($axo_array) AND count($axo_array) > 0) {
$this->debug_text("shift_acl(): Removing AXO's");
while (list($axo_section_value,$axo_value_array) = @each($axo_array)) {
foreach ($axo_value_array as $axo_value) {
$this->debug_text("shift_acl(): AXO Section Value: $axo_section_value AXO VALUE: $axo_value");
$axo_key = array_search($axo_value, $acl_array['axo'][$axo_section_value]);
if ($axo_key !== FALSE) {
$this->debug_text("shift_acl(): Removing AXO. ($axo_key)");
unset($acl_array['axo'][$axo_section_value][$axo_key]);
$update = 1;
} else {
$this->debug_text("shift_acl(): AXO doesn't exist, can't remove it.");
}
}
}
}
if (is_array($axo_group_ids) AND count($axo_group_ids) > 0) {
$this->debug_text("shift_acl(): Removing AXO_GROUP_ID's");
while (list(,$axo_group_id) = @each($axo_group_ids)) {
$this->debug_text("shift_acl(): AXO Group ID: $axo_group_id");
$axo_group_key = array_search($axo_group_id, $acl_array['axo_groups']);
if ($axo_group_key !== FALSE) {
$this->debug_text("shift_acl(): Removing AXO Group. ($axo_group_key)");
unset($acl_array['axo_groups'][$axo_group_key]);
$update = 1;
} else {
$this->debug_text("shift_acl(): AXO Group doesn't exist, can't remove it.");
}
}
}
if (is_array($aco_array) AND count($aco_array) > 0) {
$this->debug_text("shift_acl(): Removing ACO's");
while (list($aco_section_value,$aco_value_array) = @each($aco_array)) {
foreach ($aco_value_array as $aco_value) {
$this->debug_text("shift_acl(): ACO Section Value: $aco_section_value ACO VALUE: $aco_value");
$aco_key = array_search($aco_value, $acl_array['aco'][$aco_section_value]);
if ($aco_key !== FALSE) {
$this->debug_text("shift_acl(): Removing ACO. ($aco_key)");
unset($acl_array['aco'][$aco_section_value][$aco_key]);
$update = 1;
} else {
$this->debug_text("shift_acl(): ACO doesn't exist, can't remove it.");
}
}
}
}
if ($update == 1) {
//We know something was changed, so lets see if no ACO's or no ARO's are left assigned to this ACL, if so, delete the ACL completely.
//$this->showarray($acl_array);
$this->debug_text("shift_acl(): ACOs: ". $this->count_all($acl_array['aco']) ." AROs: ".$this->count_all($acl_array['aro'])."");
if ( $this->count_all($acl_array['aco']) == 0
OR ( $this->count_all($acl_array['aro']) == 0
AND ( $this->count_all($acl_array['axo']) == 0 OR $acl_array['axo'] == FALSE)
AND (count($acl_array['aro_groups']) == 0 OR $acl_array['aro_groups'] == FALSE)
AND (count($acl_array['axo_groups']) == 0 OR $acl_array['axo_groups'] == FALSE)
) ) {
$this->debug_text("shift_acl(): No ACOs or ( AROs AND AXOs AND ARO Groups AND AXO Groups) left assigned to this ACL (ID: $acl_id), deleting ACL.");
return $this->del_acl($acl_id);
}
$this->debug_text("shift_acl(): Update flag set, updating ACL.");
return $this->edit_acl($acl_id, $acl_array['aco'], $acl_array['aro'], $acl_array['aro_groups'], $acl_array['axo'], $acl_array['axo_groups'], $acl_array['allow'], $acl_array['enabled'], $acl_array['return_value'], $acl_array['note']);
}
//Return true if everything is duplicate and no ACL id updated.
$this->debug_text("shift_acl(): Update flag not set, NOT updating ACL.");
return true;
}
/**
* get_acl()
*
* Grabs ACL data.
*
* @return bool FALSE if not found, or Associative Array with the following items:
*
* - 'aco' => Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* - 'aro' => Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* - 'axo' => Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* - 'aro_groups' => Array of Group IDs
* - 'axo_groups' => Array of Group IDs
* - 'acl_id' => int ACL ID #
* - 'allow' => int Allow flag
* - 'enabled' => int Enabled flag
* - 'return_value' => string Return Value
* - 'note' => string Note
*
* @param int ACL ID #
*/
function get_acl($acl_id) {
$this->debug_text("get_acl(): ACL_ID: $acl_id");
if (empty($acl_id)) {
$this->debug_text("get_acl(): No ACL_ID specified! ACL_ID: $acl_id");
return false;
}
//Grab ACL information
$query = "select id, allow, enabled, return_value, note from ".$this->_db_table_prefix."acl where id = ".$acl_id."";
$acl_row = $this->db->GetRow($query);
// return false if not found
if (!$acl_row) {
$this->debug_text("get_acl(): No ACL found for that ID! ACL_ID: $acl_id");
return false;
}
list($retarr['acl_id'], $retarr['allow'], $retarr['enabled'], $retarr['return_value'], $retarr['note']) = $acl_row;
//Grab selected ACO's
$query = "select distinct a.section_value, a.value, c.name, b.name from ".$this->_db_table_prefix."aco_map a, ".$this->_db_table_prefix."aco b, ".$this->_db_table_prefix."aco_sections c
where ( a.section_value=b.section_value AND a.value = b.value) AND b.section_value=c.value AND a.acl_id = $acl_id";
$rs = $this->db->Execute($query);
$rows = $rs->GetRows();
$retarr['aco'] = array();
while (list(,$row) = @each($rows)) {
list($section_value, $value, $section, $aco) = $row;
$this->debug_text("Section Value: $section_value Value: $value Section: $section ACO: $aco");
$retarr['aco'][$section_value][] = $value;
}
//showarray($aco);
//Grab selected ARO's
$query = "select distinct a.section_value, a.value, c.name, b.name from ".$this->_db_table_prefix."aro_map a, ".$this->_db_table_prefix."aro b, ".$this->_db_table_prefix."aro_sections c
where ( a.section_value=b.section_value AND a.value = b.value) AND b.section_value=c.value AND a.acl_id = $acl_id";
$rs = $this->db->Execute($query);
$rows = $rs->GetRows();
$retarr['aro'] = array();
while (list(,$row) = @each($rows)) {
list($section_value, $value, $section, $aro) = $row;
$this->debug_text("Section Value: $section_value Value: $value Section: $section ARO: $aro");
$retarr['aro'][$section_value][] = $value;
}
//showarray($options_aro);
//Grab selected AXO's
$query = "select distinct a.section_value, a.value, c.name, b.name from ".$this->_db_table_prefix."axo_map a, ".$this->_db_table_prefix."axo b, ".$this->_db_table_prefix."axo_sections c
where ( a.section_value=b.section_value AND a.value = b.value) AND b.section_value=c.value AND a.acl_id = $acl_id";
$rs = $this->db->Execute($query);
$rows = $rs->GetRows();
$retarr['axo'] = array();
while (list(,$row) = @each($rows)) {
list($section_value, $value, $section, $axo) = $row;
$this->debug_text("Section Value: $section_value Value: $value Section: $section AXO: $axo");
$retarr['axo'][$section_value][] = $value;
}
//showarray($options_aro);
//Grab selected ARO groups.
$retarr['aro_groups'] = array();
$query = "select distinct group_id from ".$this->_db_table_prefix."aro_groups_map where acl_id = $acl_id";
$retarr['aro_groups'] = $this->db->GetCol($query);
//showarray($selected_groups);
//Grab selected AXO groups.
$retarr['axo_groups'] = array();
$query = "select distinct group_id from ".$this->_db_table_prefix."axo_groups_map where acl_id = $acl_id";
$retarr['axo_groups'] = $this->db->GetCol($query);
//showarray($selected_groups);
return $retarr;
}
/**
* is_conflicting_acl()
*
* Checks for conflicts when adding a specific ACL.
*
* @return bool Returns true if conflict is found.
*
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param array Array of ACL IDs to ignore from the result set.
*
*/
function is_conflicting_acl($aco_array, $aro_array, $aro_group_ids=NULL, $axo_array=NULL, $axo_group_ids=NULL, $ignore_acl_ids=NULL) {
//Check for potential conflicts. Ignore groups, as groups will almost always have "conflicting" ACLs.
//Thats part of inheritance.
if (!is_array($aco_array)) {
$this->debug_text('is_conflicting_acl(): Invalid ACO Array.');
return FALSE;
}
if (!is_array($aro_array)) {
$this->debug_text('is_conflicting_acl(): Invalid ARO Array.');
return FALSE;
}
$query = '
SELECT a.id
FROM '. $this->_db_table_prefix .'acl a
LEFT JOIN '. $this->_db_table_prefix .'aco_map ac ON ac.acl_id=a.id
LEFT JOIN '. $this->_db_table_prefix .'aro_map ar ON ar.acl_id=a.id
LEFT JOIN '. $this->_db_table_prefix .'axo_map ax ON ax.acl_id=a.id
LEFT JOIN '. $this->_db_table_prefix .'axo_groups_map axg ON axg.acl_id=a.id
LEFT JOIN '. $this->_db_table_prefix .'axo_groups xg ON xg.id=axg.group_id
';
//ACO
foreach ($aco_array as $aco_section_value => $aco_value_array) {
$this->debug_text("is_conflicting_acl(): ACO Section Value: $aco_section_value ACO VALUE: $aco_value_array");
//showarray($aco_array);
if (!is_array($aco_value_array)) {
$this->debug_text('is_conflicting_acl(): Invalid Format for ACO Array item. Skipping...');
continue;
// return TRUE;
}
//Move the below line in to the LEFT JOIN above for PostgreSQL sake.
//'ac1' => 'ac.acl_id=a.id',
$where_query = array(
'ac2' => '(ac.section_value='. $this->db->quote($aco_section_value) .' AND ac.value IN (\''. implode ('\',\'', $aco_value_array) .'\'))'
);
//ARO
foreach ($aro_array as $aro_section_value => $aro_value_array) {
$this->debug_text("is_conflicting_acl(): ARO Section Value: $aro_section_value ARO VALUE: $aro_value_array");
if (!is_array($aro_value_array))
{
$this->debug_text('is_conflicting_acl(): Invalid Format for ARO Array item. Skipping...');
continue;
// return TRUE;
}
$this->debug_text("is_conflicting_acl(): Search: ACO Section: $aco_section_value ACO Value: $aco_value_array ARO Section: $aro_section_value ARO Value: $aro_value_array");
//Move the below line in to the LEFT JOIN above for PostgreSQL sake.
//$where_query['ar1'] = 'ar.acl_id=a.id';
$where_query['ar2'] = '(ar.section_value='. $this->db->quote($aro_section_value) .' AND ar.value IN (\''. implode ('\',\'', $aro_value_array) .'\'))';
if (is_array($axo_array) AND count($axo_array) > 0) {
foreach ($axo_array as $axo_section_value => $axo_value_array) {
$this->debug_text("is_conflicting_acl(): AXO Section Value: $axo_section_value AXO VALUE: $axo_value_array");
if (!is_array($axo_value_array)) {
$this->debug_text('is_conflicting_acl(): Invalid Format for AXO Array item. Skipping...');
continue;
// return TRUE;
}
$this->debug_text("is_conflicting_acl(): Search: ACO Section: $aco_section_value ACO Value: $aco_value_array ARO Section: $aro_section_value ARO Value: $aro_value_array AXO Section: $axo_section_value AXO Value: $axo_value_array");
//$where_query['ax1'] = 'ax.acl_id=x.id';
$where_query['ax1'] = 'ax.acl_id=a.id';
$where_query['ax2'] = '(ax.section_value='. $this->db->quote($axo_section_value) .' AND ax.value IN (\''. implode ('\',\'', $axo_value_array) .'\'))';
$where = 'WHERE ' . implode(' AND ', $where_query);
$conflict_result = $this->db->GetCol($query . $where);
if (is_array($conflict_result) AND !empty($conflict_result)) {
// showarray($conflict_result);
if (is_array($ignore_acl_ids)) {
$conflict_result = array_diff($conflict_result, $ignore_acl_ids);
}
if (count($conflict_result) > 0) {
$conflicting_acls_str = implode(',', $conflict_result);
$this->debug_text("is_conflicting_acl(): Conflict FOUND!!! ACL_IDS: ($conflicting_acls_str)");
return TRUE;
}
}
}
} else {
$where_query['ax1'] = '(ax.section_value IS NULL AND ax.value IS NULL)';
$where_query['ax2'] = 'xg.name IS NULL';
$where = 'WHERE ' . implode(' AND ', $where_query);
$conflict_result = $this->db->GetCol($query . $where);
if (is_array($conflict_result) AND !empty($conflict_result)) {
// showarray($conflict_result);
if (is_array($ignore_acl_ids)) {
$conflict_result = array_diff($conflict_result, $ignore_acl_ids);
}
if (count($conflict_result) > 0) {
$conflicting_acls_str = implode(',', $conflict_result);
$this->debug_text("is_conflicting_acl(): Conflict FOUND!!! ACL_IDS: ($conflicting_acls_str)");
return TRUE;
}
}
}
}
}
$this->debug_text('is_conflicting_acl(): No conflicting ACL found.');
return FALSE;
}
/**
* add_acl()
*
* Add's an ACL. ACO_IDS, ARO_IDS, GROUP_IDS must all be arrays.
*
* @return bool Return ACL ID of new ACL if successful, FALSE otherewise.
*
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param array Associative array, item={Section Value}, key={Array of Object Values} i.e. ["<Section Value>" => ["<Value 1>", "<Value 2>", "<Value 3>"], ...]
* @param array Array of Group IDs
* @param int Allow flag
* @param int Enabled flag
* @param string Return Value
* @param string Note
* @param string ACL Section Value
* @param int ACL ID # Specific Request
*/
function add_acl($aco_array, $aro_array, $aro_group_ids=NULL, $axo_array=NULL, $axo_group_ids=NULL, $allow=1, $enabled=1, $return_value=NULL, $note=NULL, $section_value=NULL, $acl_id=FALSE ) {
$this->debug_text("add_acl():");
if (count($aco_array) == 0) {
$this->debug_text("Must select at least one Access Control Object");
return false;
}
if (count($aro_array) == 0 AND count($aro_group_ids) == 0) {
$this->debug_text("Must select at least one Access Request Object or Group");
return false;
}
if (empty($allow)) {
$allow=0;
}
if (empty($enabled)) {
$enabled=0;
}
if (!empty($section_value)
AND !$this->get_object_section_section_id(NULL, $section_value, 'ACL')) {
$this->debug_text("add_acl(): Section Value: $section_value DOES NOT exist in the database.");
return false;
}
//Unique the group arrays. Later one we unique ACO/ARO/AXO arrays.
if (is_array($aro_group_ids)) {
$aro_group_ids = array_unique($aro_group_ids);
}
if (is_array($axo_group_ids)) {
$axo_group_ids = array_unique($axo_group_ids);
}
//Check for conflicting ACLs.
if ($this->is_conflicting_acl($aco_array,$aro_array,$aro_group_ids,$axo_array,$axo_group_ids,array($acl_id))) {
$this->debug_text("add_acl(): Detected possible ACL conflict, not adding ACL!");
return false;
}
//Edit ACL if acl_id is set. This is simply if we're being called by edit_acl().
if ($this->get_acl($acl_id) == FALSE) {
if ( empty($section_value) ) {
$section_value='system';
if( !$this->get_object_section_section_id(NULL, $section_value, 'ACL') ) {
// Use the acl section with the lowest order value.
$acl_sections_table = $this->_db_table_prefix .'acl_sections';
$acl_section_order_value = $this->db->GetOne("SELECT min(order_value) from $acl_sections_table");
$query = "
SELECT value
FROM $acl_sections_table
WHERE order_value = $acl_section_order_value
";
$section_value = $this->db->GetOne($query);
if ( empty($section_value) ) {
$this->debug_text("add_acl(): No valid acl section found.");
return false;
} else {