Project

General

Profile

Download (4.27 KB) Statistics
| Branch: | Tag: | Revision:
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 ['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
	// Index to delete
68
	$delete_index = NULL;
69

    
70
	if (!is_array($array)) {
71
		return false;
72
	}
73

    
74
	// Search for the item in the array
75
	foreach ($array as $key => $item) {
76
		// If this item is the one we want to delete
77
		if (isset($item['associated-rule-id']) && $item['associated-rule-id'] == $id) {
78
			$delete_index = $key;
79
			$if = $item['interface'];
80
			break;
81
		}
82
	}
83

    
84
	// If we found the item, unset it
85
	if ($delete_index !== NULL) {
86
		unset($array[$delete_index]);
87

    
88
		// Update the separators
89
		$a_separators = &$config['filter']['separator'][strtolower($if)];
90
		$ridx = ifridx($if, $delete_index);	// get rule index within interface
91
		$mvnrows = -1;
92
		move_separators($a_separators, $ridx, $mvnrows);
93

    
94
		return true;
95
	} else {
96
		return false;
97
	}
98

    
99
}
100

    
101
/****f* itemid/get_id
102
 * NAME
103
 *   get_id - Get an item id with ['associated-rule-id'] = $id from $array
104
 * INPUTS
105
 *   $id       - string: The ID to get
106
 *   $array    - array to get the item from
107
 * RESULT
108
 *   mixed   - The id, NULL if not found
109
 ******/
110
function get_id($id, $array) {
111
	// Use $foo = &get_id('id', array('id'=>'value'));
112

    
113
	if (!is_array($array)) {
114
		return false;
115
	}
116

    
117
	// Search for the item in the array
118
	foreach ($array as $key => $item) {
119
		// If this item is the one we want to delete
120
		if (isset($item['associated-rule-id']) && $item['associated-rule-id'] == $id) {
121
			return $key;
122
		}
123
	}
124

    
125
	return false;
126
}
127

    
128
/****f* itemid/get_unique_id
129
 * NAME
130
 *   get_unique_id - get a unique identifier
131
 * RESULT
132
 *   string     - unique id
133
 ******/
134
function get_unique_id() {
135

    
136
	return uniqid("nat_", true);
137
}
138

    
139
?>
(29-29/65)