|
1
|
<?php
|
|
2
|
/*
|
|
3
|
* itemid.inc
|
|
4
|
*
|
|
5
|
* part of pfSense (https://www.pfsense.org)
|
|
6
|
* Copyright (c) 2009-2016 Rubicon Communications, LLC (Netgate)
|
|
7
|
* Copyright (c) 2009 Janne Enberg <janne.enberg@lietu.net>
|
|
8
|
* All rights reserved.
|
|
9
|
*
|
|
10
|
* Redistribution and use in source and binary forms, with or without
|
|
11
|
* modification, are permitted provided that the following conditions are met:
|
|
12
|
*
|
|
13
|
* 1. Redistributions of source code must retain the above copyright notice,
|
|
14
|
* this list of conditions and the following disclaimer.
|
|
15
|
*
|
|
16
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
17
|
* notice, this list of conditions and the following disclaimer in
|
|
18
|
* the documentation and/or other materials provided with the
|
|
19
|
* distribution.
|
|
20
|
*
|
|
21
|
* 3. All advertising materials mentioning features or use of this software
|
|
22
|
* must display the following acknowledgment:
|
|
23
|
* "This product includes software developed by the pfSense Project
|
|
24
|
* for use in the pfSense® software distribution. (http://www.pfsense.org/).
|
|
25
|
*
|
|
26
|
* 4. The names "pfSense" and "pfSense Project" must not be used to
|
|
27
|
* endorse or promote products derived from this software without
|
|
28
|
* prior written permission. For written permission, please contact
|
|
29
|
* coreteam@pfsense.org.
|
|
30
|
*
|
|
31
|
* 5. Products derived from this software may not be called "pfSense"
|
|
32
|
* nor may "pfSense" appear in their names without prior written
|
|
33
|
* permission of the Electric Sheep Fencing, LLC.
|
|
34
|
*
|
|
35
|
* 6. Redistributions of any form whatsoever must retain the following
|
|
36
|
* acknowledgment:
|
|
37
|
*
|
|
38
|
* "This product includes software developed by the pfSense Project
|
|
39
|
* for use in the pfSense software distribution (http://www.pfsense.org/).
|
|
40
|
*
|
|
41
|
* THIS SOFTWARE IS PROVIDED BY THE pfSense PROJECT ``AS IS'' AND ANY
|
|
42
|
* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
43
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
44
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE pfSense PROJECT OR
|
|
45
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
46
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
47
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
48
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
49
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
50
|
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
51
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
|
|
52
|
* OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
53
|
*/
|
|
54
|
|
|
55
|
/****f* itemid/delete_id
|
|
56
|
* NAME
|
|
57
|
* delete_id - delete an item with ['associated-rule-id'] = $id from $array
|
|
58
|
* INPUTS
|
|
59
|
* $id - int: The ID to delete
|
|
60
|
* $array - array to delete the item from
|
|
61
|
* RESULT
|
|
62
|
* boolean - true if item was found and deleted
|
|
63
|
******/
|
|
64
|
function delete_id($id, &$array) {
|
|
65
|
global $config;
|
|
66
|
|
|
67
|
if (!is_array($array)) {
|
|
68
|
return false;
|
|
69
|
}
|
|
70
|
|
|
71
|
// Search for the item in the array
|
|
72
|
$delete_index = get_id($id, $array);
|
|
73
|
|
|
74
|
// If we found the item, unset it
|
|
75
|
if ($delete_index === false) {
|
|
76
|
return false;
|
|
77
|
}
|
|
78
|
|
|
79
|
$if = $array[$delete_index]['interface'];
|
|
80
|
unset($array[$delete_index]);
|
|
81
|
|
|
82
|
// Update the separators
|
|
83
|
$a_separators = &$config['filter']['separator'][strtolower($if)];
|
|
84
|
// get rule index within interface
|
|
85
|
$ridx = ifridx($if, $delete_index);
|
|
86
|
$mvnrows = -1;
|
|
87
|
move_separators($a_separators, $ridx, $mvnrows);
|
|
88
|
|
|
89
|
return true;
|
|
90
|
}
|
|
91
|
|
|
92
|
/****f* itemid/toggle_id
|
|
93
|
* NAME
|
|
94
|
* toggle_id - enable/disable item with ['associated-rule-id'] = $id from $array
|
|
95
|
* INPUTS
|
|
96
|
* $id - int: The ID to delete
|
|
97
|
* $array - array to delete the item from
|
|
98
|
* $status - true to enable item and false to disable
|
|
99
|
* RESULT
|
|
100
|
* boolean - true if item was found and set
|
|
101
|
******/
|
|
102
|
function toggle_id($id, &$array, $status) {
|
|
103
|
global $config;
|
|
104
|
|
|
105
|
if (!is_array($array)) {
|
|
106
|
return false;
|
|
107
|
}
|
|
108
|
|
|
109
|
// Search for the item in the array
|
|
110
|
$toggle_index = get_id($id, $array);
|
|
111
|
|
|
112
|
// If we found the item, unset it
|
|
113
|
if ($toggle_index === false) {
|
|
114
|
return false;
|
|
115
|
}
|
|
116
|
|
|
117
|
if ($status) {
|
|
118
|
unset($array[$toggle_index]['disabled']);
|
|
119
|
} else {
|
|
120
|
$array[$toggle_index]['disabled'] = true;
|
|
121
|
}
|
|
122
|
|
|
123
|
return true;
|
|
124
|
}
|
|
125
|
|
|
126
|
/****f* itemid/get_id
|
|
127
|
* NAME
|
|
128
|
* get_id - Get an item id with ['associated-rule-id'] = $id from $array
|
|
129
|
* INPUTS
|
|
130
|
* $id - string: The ID to get
|
|
131
|
* $array - array to get the item from
|
|
132
|
* RESULT
|
|
133
|
* mixed - The id, false if not found
|
|
134
|
******/
|
|
135
|
function get_id($id, $array) {
|
|
136
|
// Use $foo = get_id('id', array('id'=>'value'));
|
|
137
|
|
|
138
|
if (!is_array($array)) {
|
|
139
|
return false;
|
|
140
|
}
|
|
141
|
|
|
142
|
// Search for the item in the array
|
|
143
|
foreach ($array as $key => $item) {
|
|
144
|
// If this item is the one we want to delete
|
|
145
|
if (isset($item['associated-rule-id']) &&
|
|
146
|
$item['associated-rule-id'] == $id) {
|
|
147
|
return $key;
|
|
148
|
}
|
|
149
|
}
|
|
150
|
|
|
151
|
return false;
|
|
152
|
}
|
|
153
|
|
|
154
|
/****f* itemid/get_unique_id
|
|
155
|
* NAME
|
|
156
|
* get_unique_id - get a unique identifier
|
|
157
|
* RESULT
|
|
158
|
* string - unique id
|
|
159
|
******/
|
|
160
|
function get_unique_id() {
|
|
161
|
|
|
162
|
return uniqid("nat_", true);
|
|
163
|
}
|
|
164
|
|
|
165
|
?>
|