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
201
202
|
#!/usr/bin/php -q
<?php
if ($argc > 3 || in_array($argv[1], array('--help', '-help', '-h', '-?'))) {
?>
Find entity usage in phpdoc xml files and
list used and unused entities.
Usage:
<?=$argv[0]?> [<entity-file>] [<language-code>]
<entity-file> must be a file name (with relative
path from the phpdoc root) to a file containing
<!ENTITY...> definitions. Defaults to entities/global.ent.
<language-code> must be a valid language code used in the repository, or
'all' for all languages. Defaults to en.
The script will generate an entity_usage.txt
file, containing the entities defined in the
<entity-file>.
Written by Gabor Hojtsy <goba@php.net>, 2001-09-22
<?php
exit;
}
// CONFIG SECTION
$docdir = "../"; // Main directory of the PHP documentation (one dir up in cvs)
/*********************************************************************/
/* Nothing to modify below this line */
/*********************************************************************/
// Long runtime
set_time_limit(0);
// Array to collect the entities
$defined_entities = array();
// Default values
$langcodes = array("en");
$filename = "entities/global.ent";
// Parameter value copying
if ($argc == 3) {
$langcodes = array($argv[2]);
if ($argv[2] === 'all') {
$langcodes = array("ar", "cs", "de", "en", "es", "fr",
"hk", "hu", "it", "ja", "kr", "nl",
"pl", "pt_BR", "ru", "tr", "tw");
}
}
if ($argc >= 2) {
$filename = $argv[1];
}
/*********************************************************************/
/* Here starts the functions part */
/*********************************************************************/
// Extract the entity names from the file
function extract_entity_definitions ($filename, &$entities)
{
// Read in the file, or die
$file_array = file ($filename);
if (!$file_array) { die ("Cannot open entity file ($filename)."); }
// The whole file in a string
$file_string = preg_replace("/[\r\n]/", "", join ("", $file_array));
// Find entity names
preg_match_all("/<!ENTITY\s+(.*)\s+/U", $file_string, $entities_found);
$entities_found = $entities_found[1];
// Convert to hash
foreach ($entities_found as $entity_name) {
$entities[$entity_name] = array();
}
// Return with a useful regexp part
return "&(" . join("|", $entities_found) . ");";
} // extract_entity_definitions() function end
// Checks a diretory of phpdoc XML files
function check_dir($dir, &$defined_entities, $entity_regexp)
{
// Collect files and diretcories in these arrays
$directories = array();
$files = array();
// Open and traverse the directory
$handle = @opendir($dir);
while ($file = @readdir($handle)) {
// Collect directories and XML files
if ($file != 'CVS' && $file != '.' &&
$file != '..' && is_dir($dir.$file)) {
$directories[] = $file;
}
elseif (strstr($file, ".xml")) {
$files[] = $file;
}
}
@closedir($handle);
// Sort files and directories
sort($directories);
sort($files);
// Files first...
foreach ($files as $file) {
check_file($dir.$file, $defined_entities, $entity_regexp);
}
// than the subdirs
foreach ($directories as $file) {
check_dir($dir.$file."/", $defined_entities, $entity_regexp);
}
} // check_dir() function end
function check_file ($filename, &$defined_entities, $entity_regexp)
{
// Read in file contents
$contents = preg_replace("/[\r\n]/", "", join("", file($filename)));
// Find all entity usage in this file
preg_match_all("/$entity_regexp/U", $contents, $entities_found);
// No entities found
if (count($entities_found[1]) == 0) { return; }
// New occurances found, so increase the number
foreach ($entities_found[1] as $entity_name) {
if (isset($defined_entities[$entity_name])) { $defined_entities[$entity_name][] = $filename; }
}
} // check_file() function end
/*********************************************************************/
/* Here starts the program */
/*********************************************************************/
// Get entity definitions
$entity_regexp = extract_entity_definitions($docdir . $filename, $defined_entities);
// Chechking all languages
foreach ($langcodes as $langcode) {
// Check for directory validity
if (!@is_dir($docdir . $langcode)) {
print("The $langcode language code is not valid\n");
continue;
} else {
$tested_trees[] = $langcode;
}
// If directory is OK, start with the header
echo "Searching in $docdir$langcode ...\n";
// Check the requested directory
check_dir("$docdir$langcode/", $defined_entities, $entity_regexp);
}
echo "Generating entity_usage.txt ...\n";
$fp = fopen("entity_usage.txt", "w");
fwrite($fp, "ENTITY USAGE STATISCTICS
=========================================================
In this file you can find entity usage stats compiled
from the entity file: $filename. The entity usage
was tested in the following tree[s] at phpdoc:\n" .
join(", ", $tested_trees) . ".
You may find many unused entities here. Please do
not delete the entities, unless you make sure, no
translation makes use of the entity. The purpouse
of this statistics is to reduce the number of unused
entities in phpdoc. Here comes the numbers and file
names:
=========================================================
");
foreach ($defined_entities as $entity_name => $files) {
$num = count($files);
if ($num == 0) { $prep = "++ "; } else { $prep = " "; }
fwrite($fp, $prep . sprintf("%-30s %d", $entity_name, count($files)). "\n");
}
fclose($fp);
echo "Done!\n";
?>
|
