/src/etc/inc/itemid.inc - Annotate - pfSense - pfSense bugtracker

| Branch: | Tag: | Revision:

root/src/etc/inc/itemid.inc @ 2a080336

1	a4698195	unknown	<?php
2	b9e28d57	unknown	/*
3	8acd654a	Renato Botelho	* itemid.inc
4			*
5			* part of pfSense (https://www.pfsense.org)
6	2a2396a6	Renato Botelho	* Copyright (c) 2009-2016 Rubicon Communications, LLC (Netgate)
7	aaec5634	Renato Botelho	* Copyright (c) 2009 Janne Enberg <janne.enberg@lietu.net>
8	8acd654a	Renato Botelho	* 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	b9e28d57	unknown
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	b37a2e8c	Phil Davis	function delete_id($id, &$array) {
65	4de9a6fa	NOYB	global $config;
66
67	a4698195	unknown	// Index to delete
68			$delete_index = NULL;
69
70	b37a2e8c	Phil Davis	if (!is_array($array)) {
71	9b16b834	Ermal Lu?i	return false;
72	b37a2e8c	Phil Davis	}
73	9b16b834	Ermal Lu?i
74	a4698195	unknown	// Search for the item in the array
75	b37a2e8c	Phil Davis	foreach ($array as $key => $item) {
76	a4698195	unknown	// If this item is the one we want to delete
77	086cf944	Phil Davis	if (isset($item['associated-rule-id']) && $item['associated-rule-id'] == $id) {
78	a4698195	unknown	$delete_index = $key;
79	4de9a6fa	NOYB	$if = $item['interface'];
80	a4698195	unknown	break;
81			}
82			}
83
84			// If we found the item, unset it
85	086cf944	Phil Davis	if ($delete_index !== NULL) {
86	a4698195	unknown	unset($array[$delete_index]);
87	4de9a6fa	NOYB
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	a4698195	unknown	return true;
95			} else {
96			return false;
97			}
98
99			}
100
101	473d0ff0	pierrepomes	/***f itemid/get_id
102			* NAME
103	9b16b834	Ermal Lu?i	* get_id - Get an item id with ['associated-rule-id'] = $id from $array
104	473d0ff0	pierrepomes	* INPUTS
105	9b16b834	Ermal Lu?i	* $id - string: The ID to get
106	473d0ff0	pierrepomes	* $array - array to get the item from
107			* RESULT
108	9b16b834	Ermal Lu?i	* mixed - The id, NULL if not found
109	473d0ff0	pierrepomes	******/
110	2a080336	Renato Botelho	function get_id($id, $array) {
111	473d0ff0	pierrepomes	// Use $foo = &get_id('id', array('id'=>'value'));
112	9b16b834	Ermal Lu?i
113	b37a2e8c	Phil Davis	if (!is_array($array)) {
114	9b16b834	Ermal Lu?i	return false;
115	b37a2e8c	Phil Davis	}
116	473d0ff0	pierrepomes
117			// Search for the item in the array
118	b37a2e8c	Phil Davis	foreach ($array as $key => $item) {
119	473d0ff0	pierrepomes	// If this item is the one we want to delete
120	086cf944	Phil Davis	if (isset($item['associated-rule-id']) && $item['associated-rule-id'] == $id) {
121	9b16b834	Ermal Lu?i	return $key;
122	b37a2e8c	Phil Davis	}
123	473d0ff0	pierrepomes	}
124
125	9b16b834	Ermal Lu?i	return false;
126	473d0ff0	pierrepomes	}
127
128	9b16b834	Ermal Lu?i	/***f itemid/get_unique_id
129	b9e28d57	unknown	* NAME
130	9b16b834	Ermal Lu?i	* get_unique_id - get a unique identifier
131	b9e28d57	unknown	* RESULT
132	9b16b834	Ermal Lu?i	* string - unique id
133	b9e28d57	unknown	******/
134	b37a2e8c	Phil Davis	function get_unique_id() {
135	9b16b834	Ermal Lu?i
136			return uniqid("nat_", true);
137	a4698195	unknown	}
138
139	6aa3723a	Renato Botelho	?>

Project

General

Profile

pfSense