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

| Branch: | Tag: | Revision:

root/src/etc/inc/itemid.inc @ f75b0eb8

1	a4698195	unknown	<?php
2	b9e28d57	unknown	/*
3	ac24dc24	Renato Botelho	* itemid.inc
4			*
5			* part of pfSense (https://www.pfsense.org)
6	0b4c14a4	Steve Beaver	* Copyright (c) 2009-2019 Rubicon Communications, LLC (Netgate)
7	c5d81585	Renato Botelho	* Copyright (c) 2009 Janne Enberg <janne.enberg@lietu.net>
8	ac24dc24	Renato Botelho	* All rights reserved.
9			*
10	b12ea3fb	Renato Botelho	* Licensed under the Apache License, Version 2.0 (the "License");
11			* you may not use this file except in compliance with the License.
12			* You may obtain a copy of the License at
13	ac24dc24	Renato Botelho	*
14	b12ea3fb	Renato Botelho	* http://www.apache.org/licenses/LICENSE-2.0
15	ac24dc24	Renato Botelho	*
16	b12ea3fb	Renato Botelho	* Unless required by applicable law or agreed to in writing, software
17			* distributed under the License is distributed on an "AS IS" BASIS,
18			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19			* See the License for the specific language governing permissions and
20			* limitations under the License.
21	ac24dc24	Renato Botelho	*/
22	b9e28d57	unknown
23			/***f itemid/delete_id
24			* NAME
25	632a238f	Phil Davis	* delete_id - delete an item with ['associated-rule-id'] = $id from $array
26	b9e28d57	unknown	* INPUTS
27			* $id - int: The ID to delete
28			* $array - array to delete the item from
29			* RESULT
30			* boolean - true if item was found and deleted
31			******/
32	b37a2e8c	Phil Davis	function delete_id($id, &$array) {
33	7475d7b3	NOYB	global $config;
34
35	b37a2e8c	Phil Davis	if (!is_array($array)) {
36	9b16b834	Ermal Lu?i	return false;
37	b37a2e8c	Phil Davis	}
38	9b16b834	Ermal Lu?i
39	a4698195	unknown	// Search for the item in the array
40	75bb5037	Renato Botelho	$delete_index = get_id($id, $array);
41	a4698195	unknown
42			// If we found the item, unset it
43	75bb5037	Renato Botelho	if ($delete_index === false) {
44	a4698195	unknown	return false;
45			}
46
47	75bb5037	Renato Botelho	$if = $array[$delete_index]['interface'];
48			unset($array[$delete_index]);
49
50			// Update the separators
51	c6c398c6	jim-p	init_config_arr(array('filter', 'separator', strtolower($if)));
52	75bb5037	Renato Botelho	$a_separators = &$config['filter']['separator'][strtolower($if)];
53			// get rule index within interface
54			$ridx = ifridx($if, $delete_index);
55			$mvnrows = -1;
56			move_separators($a_separators, $ridx, $mvnrows);
57
58			return true;
59	a4698195	unknown	}
60
61	8aa2dd26	Renato Botelho	/***f itemid/toggle_id
62			* NAME
63	632a238f	Phil Davis	* toggle_id - enable/disable item with ['associated-rule-id'] = $id from $array
64	8aa2dd26	Renato Botelho	* INPUTS
65			* $id - int: The ID to delete
66			* $array - array to delete the item from
67			* $status - true to enable item and false to disable
68			* RESULT
69			* boolean - true if item was found and set
70			******/
71			function toggle_id($id, &$array, $status) {
72			global $config;
73
74			if (!is_array($array)) {
75			return false;
76			}
77
78			// Search for the item in the array
79			$toggle_index = get_id($id, $array);
80
81			// If we found the item, unset it
82			if ($toggle_index === false) {
83			return false;
84			}
85
86			if ($status) {
87			unset($array[$toggle_index]['disabled']);
88			} else {
89			$array[$toggle_index]['disabled'] = true;
90			}
91
92			return true;
93			}
94
95	473d0ff0	pierrepomes	/***f itemid/get_id
96			* NAME
97	9b16b834	Ermal Lu?i	* get_id - Get an item id with ['associated-rule-id'] = $id from $array
98	473d0ff0	pierrepomes	* INPUTS
99	21408bb4	Renato Botelho	* $id - string: The ID to get
100			* $array - array to get the item from
101	473d0ff0	pierrepomes	* RESULT
102	21408bb4	Renato Botelho	* mixed - The id, false if not found
103	473d0ff0	pierrepomes	******/
104	9f61bcc9	Renato Botelho	function get_id($id, $array) {
105	21408bb4	Renato Botelho	// Use $foo = get_id('id', array('id'=>'value'));
106	9b16b834	Ermal Lu?i
107	b37a2e8c	Phil Davis	if (!is_array($array)) {
108	9b16b834	Ermal Lu?i	return false;
109	b37a2e8c	Phil Davis	}
110	473d0ff0	pierrepomes
111			// Search for the item in the array
112	b37a2e8c	Phil Davis	foreach ($array as $key => $item) {
113	473d0ff0	pierrepomes	// If this item is the one we want to delete
114	75bb5037	Renato Botelho	if (isset($item['associated-rule-id']) &&
115			$item['associated-rule-id'] == $id) {
116	9b16b834	Ermal Lu?i	return $key;
117	b37a2e8c	Phil Davis	}
118	473d0ff0	pierrepomes	}
119
120	9b16b834	Ermal Lu?i	return false;
121	473d0ff0	pierrepomes	}
122
123	9b16b834	Ermal Lu?i	/***f itemid/get_unique_id
124	b9e28d57	unknown	* NAME
125	9b16b834	Ermal Lu?i	* get_unique_id - get a unique identifier
126	b9e28d57	unknown	* RESULT
127	9b16b834	Ermal Lu?i	* string - unique id
128	b9e28d57	unknown	******/
129	b37a2e8c	Phil Davis	function get_unique_id() {
130	9b16b834	Ermal Lu?i
131			return uniqid("nat_", true);
132	a4698195	unknown	}
133
134	6aa3723a	Renato Botelho	?>

Project

General

Profile

pfSense