Repository navigation
Expand file tree
/
Copy pathsearch.php
More file actions
429 lines (389 loc) · 13.8 KB
/
Copy pathsearch.php
File metadata and controls
429 lines (389 loc) · 13.8 KB
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
<?php
/**
* DokuWiki search functions
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Andreas Gohr <andi@splitbrain.org>
*/
if(!defined('DOKU_INC')) die('meh.');
/**
* Recurse directory
*
* This function recurses into a given base directory
* and calls the supplied function for each file and directory
*
* @param array &$data The results of the search are stored here
* @param string $base Where to start the search
* @param callback $func Callback (function name or array with object,method)
* @param array $opts option array will be given to the Callback
* @param string $dir Current directory beyond $base
* @param int $lvl Recursion Level
* @param mixed $sort 'natural' to use natural order sorting (default); 'date' to sort by filemtime; leave empty to skip sorting.
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search(&$data,$base,$func,$opts,$dir='',$lvl=1,$sort='natural'){
$dirs = array();
$files = array();
$filepaths = array();
//read in directories and files
$dh = @opendir($base.'/'.$dir);
if(!$dh) return;
while(($file = readdir($dh)) !== false){
if(preg_match('/^[\._]/',$file)) continue; //skip hidden files and upper dirs
if(is_dir($base.'/'.$dir.'/'.$file)){
$dirs[] = $dir.'/'.$file;
continue;
}
$files[] = $dir.'/'.$file;
$filepaths[] = $base.'/'.$dir.'/'.$file;
}
closedir($dh);
if (!empty($sort)) {
if ($sort == 'date') {
@array_multisort(array_map('filemtime', $filepaths), SORT_NUMERIC, SORT_DESC, $files);
} else /* natural */ {
natsort($files);
}
natsort($dirs);
}
//give directories to userfunction then recurse
foreach($dirs as $dir){
if (call_user_func_array($func, array(&$data,$base,$dir,'d',$lvl,$opts))){
search($data,$base,$func,$opts,$dir,$lvl+1,$sort);
}
}
//now handle the files
foreach($files as $file){
call_user_func_array($func, array(&$data,$base,$file,'f',$lvl,$opts));
}
}
/**
* The following functions are userfunctions to use with the search
* function above. This function is called for every found file or
* directory. When a directory is given to the function it has to
* decide if this directory should be traversed (true) or not (false)
* The function has to accept the following parameters:
*
* array &$data - Reference to the result data structure
* string $base - Base usually $conf['datadir']
* string $file - current file or directory relative to $base
* string $type - Type either 'd' for directory or 'f' for file
* int $lvl - Current recursion depht
* array $opts - option array as given to search()
*
* return values for files are ignored
*
* All functions should check the ACL for document READ rights
* namespaces (directories) are NOT checked (when sneaky_index is 0) as this
* would break the recursion (You can have an nonreadable dir over a readable
* one deeper nested) also make sure to check the file type (for example
* in case of lockfiles).
*/
/**
* Searches for pages beginning with the given query
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search_qsearch(&$data,$base,$file,$type,$lvl,$opts){
$opts = array(
'idmatch' => '(^|:)'.preg_quote($opts['query'],'/').'/',
'listfiles' => true,
'pagesonly' => true,
);
return search_universal($data,$base,$file,$type,$lvl,$opts);
}
/**
* Build the browsable index of pages
*
* $opts['ns'] is the currently viewed namespace
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search_index(&$data,$base,$file,$type,$lvl,$opts){
global $conf;
$opts = array(
'pagesonly' => true,
'listdirs' => true,
'listfiles' => empty($opts['nofiles']),
'sneakyacl' => $conf['sneaky_index'],
// Hacky, should rather use recmatch
'depth' => preg_match('#^'.preg_quote($file, '#').'(/|$)#','/'.$opts['ns']) ? 0 : -1
);
return search_universal($data, $base, $file, $type, $lvl, $opts);
}
/**
* List all namespaces
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search_namespaces(&$data,$base,$file,$type,$lvl,$opts){
$opts = array(
'listdirs' => true,
);
return search_universal($data,$base,$file,$type,$lvl,$opts);
}
/**
* List all mediafiles in a namespace
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search_media(&$data,$base,$file,$type,$lvl,$opts){
//we do nothing with directories
if($type == 'd') {
if(!$opts['depth']) return true; // recurse forever
$depth = substr_count($file,'/');
if($depth >= $opts['depth']) return false; // depth reached
return true;
}
$info = array();
$info['id'] = pathID($file,true);
if($info['id'] != cleanID($info['id'])){
if($opts['showmsg'])
msg(hsc($info['id']).' is not a valid file name for DokuWiki - skipped',-1);
return false; // skip non-valid files
}
//check ACL for namespace (we have no ACL for mediafiles)
$info['perm'] = auth_quickaclcheck(getNS($info['id']).':*');
if(!$opts['skipacl'] && $info['perm'] < AUTH_READ){
return false;
}
//check pattern filter
if($opts['pattern'] && !@preg_match($opts['pattern'], $info['id'])){
return false;
}
$info['file'] = utf8_basename($file);
$info['size'] = filesize($base.'/'.$file);
$info['mtime'] = filemtime($base.'/'.$file);
$info['writable'] = is_writable($base.'/'.$file);
if(preg_match("/\.(jpe?g|gif|png)$/",$file)){
$info['isimg'] = true;
$info['meta'] = new JpegMeta($base.'/'.$file);
}else{
$info['isimg'] = false;
}
if($opts['hash']){
$info['hash'] = md5(io_readFile(mediaFN($info['id']),false));
}
$data[] = $info;
return false;
}
/**
* This function just lists documents (for RSS namespace export)
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search_list(&$data,$base,$file,$type,$lvl,$opts){
//we do nothing with directories
if($type == 'd') return false;
//only search txt files
if(substr($file,-4) == '.txt'){
//check ACL
$id = pathID($file);
if(auth_quickaclcheck($id) < AUTH_READ){
return false;
}
$data[]['id'] = $id;
}
return false;
}
/**
* Quicksearch for searching matching pagenames
*
* $opts['query'] is the search query
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search_pagename(&$data,$base,$file,$type,$lvl,$opts){
//we do nothing with directories
if($type == 'd') return true;
//only search txt files
if(substr($file,-4) != '.txt') return true;
//simple stringmatching
if (!empty($opts['query'])){
if(strpos($file,$opts['query']) !== false){
//check ACL
$id = pathID($file);
if(auth_quickaclcheck($id) < AUTH_READ){
return false;
}
$data[]['id'] = $id;
}
}
return true;
}
/**
* Just lists all documents
*
* $opts['depth'] recursion level, 0 for all
* $opts['hash'] do md5 sum of content?
* $opts['skipacl'] list everything regardless of ACL
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function search_allpages(&$data,$base,$file,$type,$lvl,$opts){
if(isset($opts['depth']) && $opts['depth']){
$parts = explode('/',ltrim($file,'/'));
if(($type == 'd' && count($parts) >= $opts['depth'])
|| ($type != 'd' && count($parts) > $opts['depth'])){
return false; // depth reached
}
}
//we do nothing with directories
if($type == 'd'){
return true;
}
//only search txt files
if(substr($file,-4) != '.txt') return true;
$item['id'] = pathID($file);
if(!$opts['skipacl'] && auth_quickaclcheck($item['id']) < AUTH_READ){
return false;
}
$item['rev'] = filemtime($base.'/'.$file);
$item['mtime'] = $item['rev'];
$item['size'] = filesize($base.'/'.$file);
if($opts['hash']){
$item['hash'] = md5(trim(rawWiki($item['id'])));
}
$data[] = $item;
return true;
}
/* ------------- helper functions below -------------- */
/**
* fulltext sort
*
* Callback sort function for use with usort to sort the data
* structure created by search_fulltext. Sorts descending by count
*
* @author Andreas Gohr <andi@splitbrain.org>
*/
function sort_search_fulltext($a,$b){
if($a['count'] > $b['count']){
return -1;
}elseif($a['count'] < $b['count']){
return 1;
}else{
return strcmp($a['id'],$b['id']);
}
}
/**
* translates a document path to an ID
*
* @author Andreas Gohr <andi@splitbrain.org>
* @todo move to pageutils
*/
function pathID($path,$keeptxt=false){
$id = utf8_decodeFN($path);
$id = str_replace('/',':',$id);
if(!$keeptxt) $id = preg_replace('#\.txt$#','',$id);
$id = trim($id, ':');
return $id;
}
/**
* This is a very universal callback for the search() function, replacing
* many of the former individual functions at the cost of a more complex
* setup.
*
* How the function behaves, depends on the options passed in the $opts
* array, where the following settings can be used.
*
* depth int recursion depth. 0 for unlimited
* keeptxt bool keep .txt extension for IDs
* listfiles bool include files in listing
* listdirs bool include namespaces in listing
* pagesonly bool restrict files to pages
* skipacl bool do not check for READ permission
* sneakyacl bool don't recurse into nonreadable dirs
* hash bool create MD5 hash for files
* meta bool return file metadata
* filematch string match files against this regexp
* idmatch string match full ID against this regexp
* dirmatch string match directory against this regexp when adding
* nsmatch string match namespace against this regexp when adding
* recmatch string match directory against this regexp when recursing
* showmsg bool warn about non-ID files
* showhidden bool show hidden files too
* firsthead bool return first heading for pages
*
* @param array &$data - Reference to the result data structure
* @param string $base - Base usually $conf['datadir']
* @param string $file - current file or directory relative to $base
* @param string $type - Type either 'd' for directory or 'f' for file
* @param int $lvl - Current recursion depht
* @param array $opts - option array as given to search()
* @return bool if this directory should be traversed (true) or not (false)
* return value is ignored for files
*
* @author Andreas Gohr <gohr@cosmocode.de>
*/
function search_universal(&$data,$base,$file,$type,$lvl,$opts){
$item = array();
$return = true;
// get ID and check if it is a valid one
$item['id'] = pathID($file,($type == 'd' || $opts['keeptxt']));
if($item['id'] != cleanID($item['id'])){
if($opts['showmsg'])
msg(hsc($item['id']).' is not a valid file name for DokuWiki - skipped',-1);
return false; // skip non-valid files
}
$item['ns'] = getNS($item['id']);
if($type == 'd') {
// decide if to recursion into this directory is wanted
if(!$opts['depth']){
$return = true; // recurse forever
}else{
$depth = substr_count($file,'/');
if($depth >= $opts['depth']){
$return = false; // depth reached
}else{
$return = true;
}
}
if($return && !preg_match('/'.$opts['recmatch'].'/',$file)){
$return = false; // doesn't match
}
}
// check ACL
if(empty($opts['skipacl'])){
if($type == 'd'){
$item['perm'] = auth_quickaclcheck($item['id'].':*');
}else{
$item['perm'] = auth_quickaclcheck($item['id']); //FIXME check namespace for media files
}
}else{
$item['perm'] = AUTH_DELETE;
}
// are we done here maybe?
if($type == 'd'){
if(empty($opts['listdirs'])) return $return;
if(empty($opts['skipacl']) && !empty($opts['sneakyacl']) && $item['perm'] < AUTH_READ) return false; //neither list nor recurse
if(!empty($opts['dirmatch']) && !preg_match('/'.$opts['dirmatch'].'/',$file)) return $return;
if(!empty($opts['nsmatch']) && !preg_match('/'.$opts['nsmatch'].'/',$item['ns'])) return $return;
}else{
if(empty($opts['listfiles'])) return $return;
if(empty($opts['skipacl']) && $item['perm'] < AUTH_READ) return $return;
if(!empty($opts['pagesonly']) && (substr($file,-4) != '.txt')) return $return;
if(empty($opts['showhidden']) && isHiddenPage($item['id'])) return $return;
if(!empty($opts['filematch']) && !preg_match('/'.$opts['filematch'].'/',$file)) return $return;
if(!empty($opts['idmatch']) && !preg_match('/'.$opts['idmatch'].'/',$item['id'])) return $return;
}
// still here? prepare the item
$item['type'] = $type;
$item['level'] = $lvl;
$item['open'] = $return;
if($opts['meta']){
$item['file'] = utf8_basename($file);
$item['size'] = filesize($base.'/'.$file);
$item['mtime'] = filemtime($base.'/'.$file);
$item['rev'] = $item['mtime'];
$item['writable'] = is_writable($base.'/'.$file);
$item['executable'] = is_executable($base.'/'.$file);
}
if($type == 'f'){
if($opts['hash']) $item['hash'] = md5(io_readFile($base.'/'.$file,false));
if($opts['firsthead']) $item['title'] = p_get_first_heading($item['id'],METADATA_DONT_RENDER);
}
// finally add the item
$data[] = $item;
return $return;
}
//Setup VIM: ex: et ts=4 :