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
|
<?php
/*
Copyright (C) 2008 Shrew Soft Inc
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
pfSense_MODULE: utils
*/
/*
* The meta data format used in pfSense is denoted using markers
* followed by the appropriate value or value pair. All markers
* are prefixed with a ##| sequence. The + suffix is used to
* denote the beginning of a tag block followed by the tag name.
* A - suffix is used to denote the end of a tag blaock. Values
* are denoted using the * suffix and can optionally be expressed
* as a key value pair. An example of a metadata tag block ...
*
* ###|+INFO
* ###|*BLAH
* ###|*TEXT=SOME TEXT
* ###|-INFO
*
* After calling read_file_metadata, the result array would
* contain the following information ...
*
* metadata['<filename>']['INFO']['BLAH'][0] == true
* metadata['<filename>']['INFO']['TEXT'][0] == "SOME TEXT"
*
* NOTE: All statements must be at the begining of a line and
* contiguous for a tag. The example shown above would not be
* processed due to the extra ' * ' comment chars.
*
*/
/*
* locate php files for a given path
*/
function list_phpfiles($path, & $found) {
if (!is_array($found))
$found = array();
$dir = opendir($path);
if (!$dir) {
echo "list_phpfiles: unable to examine path {$path}\n";
return;
}
while($fname = readdir($dir)) {
if($fname == "." || $fname == ".." || $fname[0] == '.')
continue;
if (fnmatch('*.php', $fname))
$found[] = $fname;
}
}
/*
* read embedded metadata from a file
*/
function read_file_metadata($fpath, & $metadata, $taglist = false) {
if (!is_array($metadata))
$metadata = array();
if ($taglist)
$taglist = explode(",", $taglist);
$fname = $fpath;
$slash = strrpos($fname,"/");
if ($slash)
$fname = substr($fname,$slash + 1);
$fdata = @file_get_contents($fpath);
if (!$fdata) {
echo "unable to read {$fpath}\n";
continue;
}
$offset = 0;
$tags = array();
while (true) {
$tagbeg_off = stripos($fdata, "##|+", $offset);
if ($tagbeg_off === false)
break;
$tagbeg_trm = stripos($fdata, "\n", $tagbeg_off);
if ($tagbeg_trm === false)
break;
$tagend_off = stripos($fdata, "##|-", $tagbeg_trm);
if ($tagend_off === false)
break;
$tagend_trm = stripos($fdata, "\n", $tagend_off);
if ($tagend_trm === false)
break;
$tagbeg_len = $tagbeg_trm - $tagbeg_off;
$tagend_len = $tagend_trm - $tagend_off;
$tagbeg = substr($fdata, $tagbeg_off + 4, $tagbeg_len - 4);
$tagend = substr($fdata, $tagend_off + 4, $tagend_len - 4);
if ($tagbeg != $tagend) {
echo "error: tag mismatch ( {$tagbeg} != {$tagend} ) in '$fpath'\n";
break;
}
$mdata_off = $tagbeg_trm + 1;
$mdata_trm = $tagend_off - 1;
$mdata_len = $mdata_trm - $mdata_off;
$mdata = substr($fdata, $mdata_off, $mdata_len);
if (!strlen($mdata)) {
echo "warning: tag {$tagbeg} has no data in '$fpath'\n";
break;
}
$offset = $tagend_trm + 1;
if (is_array($taglist))
if (!in_array($tagbeg,$taglist))
continue;
$vals = array();
$lines = explode("\n",$mdata);
foreach ($lines as $line) {
if (!strlen($line))
continue;
$valtag = stripos($line, "##|*");
if ($valtag === false || $valtag) {
echo "warning: tag {$tagbeg} has malformed data in '$fpath'\n";
continue;
}
$value = substr($line, 4, strlen($line) - 1);
$vlist = explode("=", $value);
unset($vname);
unset($vdata);
switch (count($vlist)) {
case 1:
$vname = $vlist[0];
$vdata = true;
break;
case 2:
$vname = $vlist[0];
$vdata = $vlist[1];
break;
}
if (!isset($vname) || !isset($vdata)) {
echo "warning: tag {$tagbeg} has invalid data in '$fpath'\n";
continue;
}
$vals[$vname][] = $vdata;
}
if (count($vals))
$tags[$tagbeg] = $vals;
}
if (count($tags))
$metadata[$fname] = $tags;
}
?>
|
