diff options
Diffstat (limited to 'inc/search.php')
| -rw-r--r-- | inc/search.php | 301 |
1 files changed, 301 insertions, 0 deletions
diff --git a/inc/search.php b/inc/search.php new file mode 100644 index 000000000..bb941a3f3 --- /dev/null +++ b/inc/search.php @@ -0,0 +1,301 @@ +<? + +require_once("inc/common.php"); + +/** + * This function recurses into a given base directory + * and calls the supplied function for each file and directory + */ +function search(&$data,$base,$func,$opts,$dir='',$lvl=1){ + $dirs = array(); + $files = 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; + } + closedir($dh); + sort($files); + sort($dirs); + + //give directories to userfunction then recurse + foreach($dirs as $dir){ + if ($func($data,$base,$dir,'d',$lvl,$opts)){ + search($data,$base,$func,$opts,$dir,$lvl+1); + } + } + //now handle the files + foreach($files as $file){ + $func($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: + * + * &$data - Reference to the result data structure + * $base - Base usually $conf['datadir'] + * $file - current file or directory relative to $base + * $type - Type either 'd' for directory or 'f' for file + * $lvl - Current recursion depht + * $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 as this would break + * the recursion (You can have an nonreadable dir over a readable + * one deeper nested) + */ + +/** + * This function build the browsable index of pages + * + * $opts['ns'] is the current namespace + */ +function search_index(&$data,$base,$file,$type,$lvl,$opts){ + $return = true; + + if($type == 'd' && !preg_match('#^'.$file.'(/|$)#','/'.$opts['ns'])){ + //add but don't recurse + $return = false; + }elseif($type == 'f' && !preg_match('#\.txt$#',$file)){ + //don't add + return false; + } + + //check ACL + $id = pathID($file); + if($type=='f' && auth_quickaclcheck($id) < AUTH_READ){ + return false; + } + + $data[]=array( 'id' => $id, + 'type' => $type, + 'level' => $lvl ); + return $return; +} + +/** + * This function lists all namespaces + */ +function search_namespaces(&$data,$base,$file,$type,$lvl,$opts){ + if($type == 'f') return true; //nothing to do on files + + $id = pathID($file); + $data[]=array( 'id' => $id, + 'type' => $type, + 'level' => $lvl ); + return true; +} + +/** + * This function lists all mediafiles in a namespace + */ +function search_media(&$data,$base,$file,$type,$lvl,$opts){ + //we do nothing with directories + if($type == 'd') return false; + + $info = array(); + $info['id'] = pathID($file); + + //check ACL for namespace (we have no ACL for mediafiles) + if(auth_quickaclcheck(getNS($info['id']).':*') < AUTH_READ){ + return false; + } + + $info['file'] = basename($file); + $info['size'] = filesize($base.'/'.$file); + if(preg_match("/\.(jpe?g|gif|png)$/",$file)){ + $info['isimg'] = true; + $info['info'] = getimagesize($base.'/'.$file); + }else{ + $info['isimg'] = false; + } + $data[] = $info; + + return false; +} + +/** + * This function just lists documents (for RSS namespace export) + */ +function search_list(&$data,$base,$file,$type,$lvl,$opts){ + //we do nothing with directories + if($type == 'd') return false; + if(preg_match('#\.txt$#',$file)){ + //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 + */ +function search_pagename(&$data,$base,$file,$type,$lvl,$opts){ + //we do nothing with directories + if($type == 'd') return true; + //only search txt files + if(!preg_match('#\.txt$#',$file)) return true; + + //simple stringmatching + if(strpos($file,$opts['query']) !== false){ + //check ACL + $id = pathID($file); + if(auth_quickaclcheck($id) < AUTH_READ){ + return false; + } + $data[]['id'] = $id; + } + + return true; +} + +/** + * Search for backlinks to a given page + * + * $opts['ns'] namespace of the page + * $opts['name'] name of the page without namespace + */ +function search_backlinks(&$data,$base,$file,$type,$lvl,$opts){ + //we do nothing with directories + if($type == 'd') return true;; + //only search txt files + if(!preg_match('#\.txt$#',$file)) return true;; + + //get text + $text = io_readfile($base.'/'.$file); + + //absolute search id + $sid = cleanID($opts['ns'].':'.$opts['name']); + + //construct current namespace + $cid = pathID($file); + $cns = getNS($cid); + + //check ACL + if(auth_quickaclcheck($cid) < AUTH_READ){ + return false; + } + + //match all links + //FIXME may be incorrect because of code blocks + // CamelCase isn't supported, too + preg_match_all('#\[\[(.+?)\]\]#si',$text,$matches,PREG_SET_ORDER); + foreach($matches as $match){ + //get ID from link and discard most non wikilinks + list($mid) = split('\|',$match[1],2); + if(preg_match("#^(https?|telnet|gopher|file|wais|ftp|ed2k|irc)://#",$mid)) continue; + if(preg_match("#\w+>#",$mid)) continue; + $mns = getNS($mid); + //namespace starting with "." - prepend current namespace + if(strpos($mns,'.')===0){ + $mid = $cns.":".substr($mid,1); + } + if($mns===false){ + //no namespace in link? add current + $mid = "$cns:$mid"; + } + $mid = cleanID($mid); + + if ($mid == $sid){ + $data[]['id'] = $cid; + break; + } + } +} + +/** + * Fulltextsearch + * + * $opts['query'] is the search query + */ +function search_fulltext(&$data,$base,$file,$type,$lvl,$opts){ + //we do nothing with directories + if($type == 'd') return true;; + //only search txt files + if(!preg_match('#\.txt$#',$file)) return true;; + + //check ACL + $id = pathID($file); + if(auth_quickaclcheck($id) < AUTH_READ){ + return false; + } + + //get text + $text = io_readfile($base.'/'.$file); + + //create regexp from queries + $qpreg = preg_split('/\s+/',preg_quote($opts['query'],'#')); + $qpreg = '('.join('|',$qpreg).')'; + + //do the fulltext search + $matches = array(); + if($cnt = preg_match_all('#'.$qpreg.'#si',$text,$matches)){ + //this is not the best way for snippet generation but the fastest I could find + //split query and only use the first token + $q = preg_split('/\s+/',$opts['query'],2); + $q = $q[0]; + $p = strpos(strtolower($text),$q); + $f = $p - 100; + $l = strlen($q) + 200; + if($f < 0) $f = 0; + $snippet = '<span class="search_sep"> ... </span>'. + htmlspecialchars(substr($text,$f,$l)). + '<span class="search_sep"> ... </span>'; + $snippet = preg_replace('#'.$qpreg.'#si','<span class="search_hit">\\1</span>',$snippet); + + $data[] = array( + 'id' => $id, + 'count' => $cnt, + 'snippet' => $snippet, + ); + } + + return true; +} + +/** + * Callback sort function for use with usort to sort the data + * structure created by search_fulltext. Sorts descending by count + */ +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 + */ +function pathID($path){ + $id = str_replace('/',':',$path); + $id = preg_replace('#\.txt$#','',$id); + $id = preg_replace('#^:+#','',$id); + $id = preg_replace('#:+$#','',$id); + return $id; +} + +?> |