Issues in search.php - Failed Issues - Inspection of "make use of the new media file classes" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — mediaitems ( 8f7d0e...4f33ba )

by Andreas

created 2021-01-05 20:41 UTC

inc/search.php (3 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * DokuWiki search functions
 *
 * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
 * @author     Andreas Gohr <[email protected]>
 */

use dokuwiki\Utf8\Sort;

/**
 * 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 <[email protected]>
 */
function search(&$data,$base,$func,$opts,$dir='',$lvl=1,$sort='natural'){
    $dirs   = array();
    $files  = array();
    $filepaths = array();

    // safeguard against runaways #1452
    if($base == '' || $base == '/') {
        throw new RuntimeException('No valid $base passed to search() - possible misconfiguration or bug');
    }

    //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 */ {
            Sort::asortFN($files);
        }
        Sort::asortFN($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 <[email protected]>
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
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 <[email protected]>
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
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 <[email protected]>
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
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
 *   $opts['depth']     recursion level, 0 for all
 *   $opts['showmsg']   shows message if invalid media id is used
 *   $opts['skipacl']   skip acl checking
 *   $opts['pattern']   check given pattern
 *   $opts['hash']      add hashes to result list
 *
 * @author  Andreas Gohr <[email protected]>
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
function search_media(&$data,$base,$file,$type,$lvl,$opts){

    //we do nothing with directories
    if($type == 'd') {
        if(empty($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(empty($opts['skipacl']) && $info['perm'] < AUTH_READ){
        return false;
    }

    //check pattern filter
    if(!empty($opts['pattern']) && !@preg_match($opts['pattern'], $info['id'])){
        return false;
    }

    $info['file']     = \dokuwiki\Utf8\PhpString::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(!empty($opts['hash'])){
        $info['hash'] = md5(io_readFile(mediaFN($info['id']),false));
    }

    $data[] = $info;

    return false;
}

/**
 * List all mediafiles in a namespace
 *   $opts['depth']     recursion level, 0 for all
 *   $opts['showmsg']   shows message if invalid media id is used
 *   $opts['skipacl']   skip acl checking
 *   $opts['pattern']   check given pattern
 *   $opts['hash']      add hashes to result list
 *
 * @todo This is a temporary copy of search_media returning a list of MediaFile intances
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
function search_mediafiles(&$data,$base,$file,$type,$lvl,$opts){

    //we do nothing with directories
    if($type == 'd') {
        if(empty($opts['depth'])) return true; // recurse forever
        $depth = substr_count($file,'/');
        if($depth >= $opts['depth']) return false; // depth reached
        return true;
    }

    $id   = pathID($file,true);
    if($id != cleanID($id)){
        if($opts['showmsg'])
            msg(hsc($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($id).':*');
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
    if(empty($opts['skipacl']) && $info['perm'] < AUTH_READ){
        return false;
    }

    //check pattern filter
    if(!empty($opts['pattern']) && !@preg_match($opts['pattern'], $id)){
        return false;
    }

    $data[] = new \dokuwiki\Media\MediaFile($id);
    return false;
}


/**
 * This function just lists documents (for RSS namespace export)
 *
 * @author  Andreas Gohr <[email protected]>
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
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 <[email protected]>
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
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 <[email protected]>
 *
 * @param array $data
 * @param string $base
 * @param string $file
 * @param string $type
 * @param integer $lvl
 * @param array $opts
 *
 * @return bool
 */
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 = array();
    $item['id']   = pathID($file);
    if(empty($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(!empty($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 <[email protected]>
 *
 * @param array $a
 * @param array $b
 *
 * @return int
 */
function sort_search_fulltext($a,$b){
    if($a['count'] > $b['count']){
        return -1;
    }elseif($a['count'] < $b['count']){
        return 1;
    }else{
        return Sort::strcmp($a['id'],$b['id']);
    }
}

/**
 * translates a document path to an ID
 *
 * @author  Andreas Gohr <[email protected]>
 * @todo    move to pageutils
 *
 * @param string $path
 * @param bool $keeptxt
 *
 * @return mixed|string
 */
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                       (default: 0)
 * keeptxt    bool    keep .txt extension for IDs                            (default: false)
 * listfiles  bool    include files in listing                               (default: false)
 * listdirs   bool    include namespaces in listing                          (default: false)
 * pagesonly  bool    restrict files to pages                                (default: false)
 * skipacl    bool    do not check for READ permission                       (default: false)
 * sneakyacl  bool    don't recurse into nonreadable dirs                    (default: false)
 * hash       bool    create MD5 hash for files                              (default: false)
 * meta       bool    return file metadata                                   (default: false)
 * filematch  string  match files against this regexp                        (default: '', so accept everything)
 * idmatch    string  match full ID against this regexp                      (default: '', so accept everything)
 * dirmatch   string  match directory against this regexp when adding        (default: '', so accept everything)
 * nsmatch    string  match namespace against this regexp when adding        (default: '', so accept everything)
 * recmatch   string  match directory against this regexp when recursing     (default: '', so accept everything)
 * showmsg    bool    warn about non-ID files                                (default: false)
 * showhidden bool    show hidden files(e.g. by hidepages config) too        (default: false)
 * firsthead  bool    return first heading for pages                         (default: false)
 *
 * @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 <[email protected]>
 */
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' || !empty($opts['keeptxt'])));
    if($item['id'] != cleanID($item['id'])){
        if(!empty($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(empty($opts['depth'])){
            $return = true; // recurse forever
        }else{
            $depth = substr_count($file,'/');
            if($depth >= $opts['depth']){
                $return = false; // depth reached
            }else{
                $return = true;
            }
        }

        if ($return) {
            $match = empty($opts['recmatch']) || preg_match('/'.$opts['recmatch'].'/',$file);
            if (!$match) {
                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;
        //neither list nor recurse forbidden items:
        if(empty($opts['skipacl']) && !empty($opts['sneakyacl']) && $item['perm'] < AUTH_READ) return false;
        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(!empty($opts['meta'])){
        $item['file']       = \dokuwiki\Utf8\PhpString::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(!empty($opts['hash'])) $item['hash'] = md5(io_readFile($base.'/'.$file,false));
        if(!empty($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 :


1			<?php
2			/**
3			* DokuWiki search functions
4			*
5			* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
6			* @author Andreas Gohr <[email protected]>
7			*/
8
9			use dokuwiki\Utf8\Sort;
10
11			/**
12			* Recurse directory
13			*
14			* This function recurses into a given base directory
15			* and calls the supplied function for each file and directory
16			*
17			* @param array &$data The results of the search are stored here
18			* @param string $base Where to start the search
19			* @param callback $func Callback (function name or array with object,method)
20			* @param array $opts option array will be given to the Callback
21			* @param string $dir Current directory beyond $base
22			* @param int $lvl Recursion Level
23			* @param mixed $sort 'natural' to use natural order sorting (default);
24			* 'date' to sort by filemtime; leave empty to skip sorting.
25			* @author Andreas Gohr <[email protected]>
26			*/
27			function search(&$data,$base,$func,$opts,$dir='',$lvl=1,$sort='natural'){
28			$dirs = array();
29			$files = array();
30			$filepaths = array();
31
32			// safeguard against runaways #1452
33			if($base == '' \|\| $base == '/') {
34			throw new RuntimeException('No valid $base passed to search() - possible misconfiguration or bug');
35			}
36
37			//read in directories and files
38			$dh = @opendir($base.'/'.$dir);
39			if(!$dh) return;
40			while(($file = readdir($dh)) !== false){
41			if(preg_match('/^[\._]/',$file)) continue; //skip hidden files and upper dirs
42			if(is_dir($base.'/'.$dir.'/'.$file)){
43			$dirs[] = $dir.'/'.$file;
44			continue;
45			}
46			$files[] = $dir.'/'.$file;
47			$filepaths[] = $base.'/'.$dir.'/'.$file;
48			}
49			closedir($dh);
50			if (!empty($sort)) {
51			if ($sort == 'date') {
52			@array_multisort(array_map('filemtime', $filepaths), SORT_NUMERIC, SORT_DESC, $files);
53			} else /* natural */ {
54			Sort::asortFN($files);
55			}
56			Sort::asortFN($dirs);
57			}
58
59			//give directories to userfunction then recurse
60			foreach($dirs as $dir){
61			if (call_user_func_array($func, array(&$data,$base,$dir,'d',$lvl,$opts))){
62			search($data,$base,$func,$opts,$dir,$lvl+1,$sort);
63			}
64			}
65			//now handle the files
66			foreach($files as $file){
67			call_user_func_array($func, array(&$data,$base,$file,'f',$lvl,$opts));
68			}
69			}
70
71			/**
72			* The following functions are userfunctions to use with the search
73			* function above. This function is called for every found file or
74			* directory. When a directory is given to the function it has to
75			* decide if this directory should be traversed (true) or not (false)
76			* The function has to accept the following parameters:
77			*
78			* array &$data - Reference to the result data structure
79			* string $base - Base usually $conf['datadir']
80			* string $file - current file or directory relative to $base
81			* string $type - Type either 'd' for directory or 'f' for file
82			* int $lvl - Current recursion depht
83			* array $opts - option array as given to search()
84			*
85			* return values for files are ignored
86			*
87			* All functions should check the ACL for document READ rights
88			* namespaces (directories) are NOT checked (when sneaky_index is 0) as this
89			* would break the recursion (You can have an nonreadable dir over a readable
90			* one deeper nested) also make sure to check the file type (for example
91			* in case of lockfiles).
92			*/
93
94			/**
95			* Searches for pages beginning with the given query
96			*
97			* @author Andreas Gohr <[email protected]>
98			*
99			* @param array $data
100			* @param string $base
101			* @param string $file
102			* @param string $type
103			* @param integer $lvl
104			* @param array $opts
105			*
106			* @return bool
107			*/
108			function search_qsearch(&$data,$base,$file,$type,$lvl,$opts){
109			$opts = array(
110			'idmatch' => '(^\|:)'.preg_quote($opts['query'],'/').'/',
111			'listfiles' => true,
112			'pagesonly' => true,
113			);
114			return search_universal($data,$base,$file,$type,$lvl,$opts);
115			}
116
117			/**
118			* Build the browsable index of pages
119			*
120			* $opts['ns'] is the currently viewed namespace
121			*
122			* @author Andreas Gohr <[email protected]>
123			*
124			* @param array $data
125			* @param string $base
126			* @param string $file
127			* @param string $type
128			* @param integer $lvl
129			* @param array $opts
130			*
131			* @return bool
132			*/
133			function search_index(&$data,$base,$file,$type,$lvl,$opts){
134			global $conf;
135			$opts = array(
136			'pagesonly' => true,
137			'listdirs' => true,
138			'listfiles' => empty($opts['nofiles']),
139			'sneakyacl' => $conf['sneaky_index'],
140			// Hacky, should rather use recmatch
141			'depth' => preg_match('#^'.preg_quote($file, '#').'(/\|$)#','/'.$opts['ns']) ? 0 : -1
142			);
143
144			return search_universal($data, $base, $file, $type, $lvl, $opts);
145			}
146
147			/**
148			* List all namespaces
149			*
150			* @author Andreas Gohr <[email protected]>
151			*
152			* @param array $data
153			* @param string $base
154			* @param string $file
155			* @param string $type
156			* @param integer $lvl
157			* @param array $opts
158			*
159			* @return bool
160			*/
161			function search_namespaces(&$data,$base,$file,$type,$lvl,$opts){
162			$opts = array(
163			'listdirs' => true,
164			);
165			return search_universal($data,$base,$file,$type,$lvl,$opts);
166			}
167
168			/**
169			* List all mediafiles in a namespace
170			* $opts['depth'] recursion level, 0 for all
171			* $opts['showmsg'] shows message if invalid media id is used
172			* $opts['skipacl'] skip acl checking
173			* $opts['pattern'] check given pattern
174			* $opts['hash'] add hashes to result list
175			*
176			* @author Andreas Gohr <[email protected]>
177			*
178			* @param array $data
179			* @param string $base
180			* @param string $file
181			* @param string $type
182			* @param integer $lvl
183			* @param array $opts
184			*
185			* @return bool
186			*/
187			function search_media(&$data,$base,$file,$type,$lvl,$opts){
188
189			//we do nothing with directories
190			if($type == 'd') {
191			if(empty($opts['depth'])) return true; // recurse forever
192			$depth = substr_count($file,'/');
193			if($depth >= $opts['depth']) return false; // depth reached
194			return true;
195			}
196
197			$info = array();
198			$info['id'] = pathID($file,true);
199			if($info['id'] != cleanID($info['id'])){
200			if($opts['showmsg'])
201			msg(hsc($info['id']).' is not a valid file name for DokuWiki - skipped',-1);
202			return false; // skip non-valid files
203			}
204
205			//check ACL for namespace (we have no ACL for mediafiles)
206			$info['perm'] = auth_quickaclcheck(getNS($info['id']).':*');
207			if(empty($opts['skipacl']) && $info['perm'] < AUTH_READ){
208			return false;
209			}
210
211			//check pattern filter
212			if(!empty($opts['pattern']) && !@preg_match($opts['pattern'], $info['id'])){
213			return false;
214			}
215
216			$info['file'] = \dokuwiki\Utf8\PhpString::basename($file);
217			$info['size'] = filesize($base.'/'.$file);
218			$info['mtime'] = filemtime($base.'/'.$file);
219			$info['writable'] = is_writable($base.'/'.$file);
220			if(preg_match("/\.(jpe?g\|gif\|png)$/",$file)){
221			$info['isimg'] = true;
222			$info['meta'] = new JpegMeta($base.'/'.$file);
223			}else{
224			$info['isimg'] = false;
225			}
226			if(!empty($opts['hash'])){
227			$info['hash'] = md5(io_readFile(mediaFN($info['id']),false));
228			}
229
230			$data[] = $info;
231
232			return false;
233			}
234
235			/**
236			* List all mediafiles in a namespace
237			* $opts['depth'] recursion level, 0 for all
238			* $opts['showmsg'] shows message if invalid media id is used
239			* $opts['skipacl'] skip acl checking
240			* $opts['pattern'] check given pattern
241			* $opts['hash'] add hashes to result list
242			*
243			* @todo This is a temporary copy of search_media returning a list of MediaFile intances
244			*
245			* @param array $data
246			* @param string $base
247			* @param string $file
248			* @param string $type
249			* @param integer $lvl
250			* @param array $opts
251			*
252			* @return bool
253			*/
254			function search_mediafiles(&$data,$base,$file,$type,$lvl,$opts){
255
256			//we do nothing with directories
257			if($type == 'd') {
258			if(empty($opts['depth'])) return true; // recurse forever
259			$depth = substr_count($file,'/');
260			if($depth >= $opts['depth']) return false; // depth reached
261			return true;
262			}
263
264			$id = pathID($file,true);
265			if($id != cleanID($id)){
266			if($opts['showmsg'])
267			msg(hsc($id).' is not a valid file name for DokuWiki - skipped',-1);
268			return false; // skip non-valid files
269			}
270
271			//check ACL for namespace (we have no ACL for mediafiles)
272			$info['perm'] = auth_quickaclcheck(getNS($id).':*');
			0 ignored issues – show Coding Style Comprehensibility introduced 2021-01-05 20:44 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$info` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$info = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
273			if(empty($opts['skipacl']) && $info['perm'] < AUTH_READ){
274			return false;
275			}
276
277			//check pattern filter
278			if(!empty($opts['pattern']) && !@preg_match($opts['pattern'], $id)){
279			return false;
280			}
281
282			$data[] = new \dokuwiki\Media\MediaFile($id);
283			return false;
284			}
285
286
287			/**
288			* This function just lists documents (for RSS namespace export)
289			*
290			* @author Andreas Gohr <[email protected]>
291			*
292			* @param array $data
293			* @param string $base
294			* @param string $file
295			* @param string $type
296			* @param integer $lvl
297			* @param array $opts
298			*
299			* @return bool
300			*/
301			function search_list(&$data,$base,$file,$type,$lvl,$opts){
302			//we do nothing with directories
303			if($type == 'd') return false;
304			//only search txt files
305			if(substr($file,-4) == '.txt'){
306			//check ACL
307			$id = pathID($file);
308			if(auth_quickaclcheck($id) < AUTH_READ){
309			return false;
310			}
311			$data[]['id'] = $id;
312			}
313			return false;
314			}
315
316			/**
317			* Quicksearch for searching matching pagenames
318			*
319			* $opts['query'] is the search query
320			*
321			* @author Andreas Gohr <[email protected]>
322			*
323			* @param array $data
324			* @param string $base
325			* @param string $file
326			* @param string $type
327			* @param integer $lvl
328			* @param array $opts
329			*
330			* @return bool
331			*/
332			function search_pagename(&$data,$base,$file,$type,$lvl,$opts){
			0 ignored issues – show Unused Code introduced 2021-01-05 20:44 UTC by Report Bug Copy Issue Report Show Similar Issues like this The parameter `$base` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
333			//we do nothing with directories
334			if($type == 'd') return true;
335			//only search txt files
336			if(substr($file,-4) != '.txt') return true;
337
338			//simple stringmatching
339			if (!empty($opts['query'])){
340			if(strpos($file,$opts['query']) !== false){
341			//check ACL
342			$id = pathID($file);
343			if(auth_quickaclcheck($id) < AUTH_READ){
344			return false;
345			}
346			$data[]['id'] = $id;
347			}
348			}
349			return true;
350			}
351
352			/**
353			* Just lists all documents
354			*
355			* $opts['depth'] recursion level, 0 for all
356			* $opts['hash'] do md5 sum of content?
357			* $opts['skipacl'] list everything regardless of ACL
358			*
359			* @author Andreas Gohr <[email protected]>
360			*
361			* @param array $data
362			* @param string $base
363			* @param string $file
364			* @param string $type
365			* @param integer $lvl
366			* @param array $opts
367			*
368			* @return bool
369			*/
370			function search_allpages(&$data,$base,$file,$type,$lvl,$opts){
			0 ignored issues – show Unused Code introduced 2021-01-05 20:44 UTC by Report Bug Copy Issue Report Show Similar Issues like this The parameter `$lvl` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
371			if(isset($opts['depth']) && $opts['depth']){
372			$parts = explode('/',ltrim($file,'/'));
373			if(($type == 'd' && count($parts) >= $opts['depth'])
374			\|\| ($type != 'd' && count($parts) > $opts['depth'])){
375			return false; // depth reached
376			}
377			}
378
379			//we do nothing with directories
380			if($type == 'd'){
381			return true;
382			}
383
384			//only search txt files
385			if(substr($file,-4) != '.txt') return true;
386
387			$item = array();
388			$item['id'] = pathID($file);
389			if(empty($opts['skipacl']) && auth_quickaclcheck($item['id']) < AUTH_READ){
390			return false;
391			}
392
393			$item['rev'] = filemtime($base.'/'.$file);
394			$item['mtime'] = $item['rev'];
395			$item['size'] = filesize($base.'/'.$file);
396			if(!empty($opts['hash'])){
397			$item['hash'] = md5(trim(rawWiki($item['id'])));
398			}
399
400			$data[] = $item;
401			return true;
402			}
403
404			/* ------------- helper functions below -------------- */
405
406			/**
407			* fulltext sort
408			*
409			* Callback sort function for use with usort to sort the data
410			* structure created by search_fulltext. Sorts descending by count
411			*
412			* @author Andreas Gohr <[email protected]>
413			*
414			* @param array $a
415			* @param array $b
416			*
417			* @return int
418			*/
419			function sort_search_fulltext($a,$b){
420			if($a['count'] > $b['count']){
421			return -1;
422			}elseif($a['count'] < $b['count']){
423			return 1;
424			}else{
425			return Sort::strcmp($a['id'],$b['id']);
426			}
427			}
428
429			/**
430			* translates a document path to an ID
431			*
432			* @author Andreas Gohr <[email protected]>
433			* @todo move to pageutils
434			*
435			* @param string $path
436			* @param bool $keeptxt
437			*
438			* @return mixed\|string
439			*/
440			function pathID($path,$keeptxt=false){
441			$id = utf8_decodeFN($path);
442			$id = str_replace('/',':',$id);
443			if(!$keeptxt) $id = preg_replace('#\.txt$#','',$id);
444			$id = trim($id, ':');
445			return $id;
446			}
447
448
449			/**
450			* This is a very universal callback for the search() function, replacing
451			* many of the former individual functions at the cost of a more complex
452			* setup.
453			*
454			* How the function behaves, depends on the options passed in the $opts
455			* array, where the following settings can be used.
456			*
457			* depth int recursion depth. 0 for unlimited (default: 0)
458			* keeptxt bool keep .txt extension for IDs (default: false)
459			* listfiles bool include files in listing (default: false)
460			* listdirs bool include namespaces in listing (default: false)
461			* pagesonly bool restrict files to pages (default: false)
462			* skipacl bool do not check for READ permission (default: false)
463			* sneakyacl bool don't recurse into nonreadable dirs (default: false)
464			* hash bool create MD5 hash for files (default: false)
465			* meta bool return file metadata (default: false)
466			* filematch string match files against this regexp (default: '', so accept everything)
467			* idmatch string match full ID against this regexp (default: '', so accept everything)
468			* dirmatch string match directory against this regexp when adding (default: '', so accept everything)
469			* nsmatch string match namespace against this regexp when adding (default: '', so accept everything)
470			* recmatch string match directory against this regexp when recursing (default: '', so accept everything)
471			* showmsg bool warn about non-ID files (default: false)
472			* showhidden bool show hidden files(e.g. by hidepages config) too (default: false)
473			* firsthead bool return first heading for pages (default: false)
474			*
475			* @param array &$data - Reference to the result data structure
476			* @param string $base - Base usually $conf['datadir']
477			* @param string $file - current file or directory relative to $base
478			* @param string $type - Type either 'd' for directory or 'f' for file
479			* @param int $lvl - Current recursion depht
480			* @param array $opts - option array as given to search()
481			* @return bool if this directory should be traversed (true) or not (false)
482			* return value is ignored for files
483			*
484			* @author Andreas Gohr <[email protected]>
485			*/
486			function search_universal(&$data,$base,$file,$type,$lvl,$opts){
487			$item = array();
488			$return = true;
489
490			// get ID and check if it is a valid one
491			$item['id'] = pathID($file,($type == 'd' \|\| !empty($opts['keeptxt'])));
492			if($item['id'] != cleanID($item['id'])){
493			if(!empty($opts['showmsg'])){
494			msg(hsc($item['id']).' is not a valid file name for DokuWiki - skipped',-1);
495			}
496			return false; // skip non-valid files
497			}
498			$item['ns'] = getNS($item['id']);
499
500			if($type == 'd') {
501			// decide if to recursion into this directory is wanted
502			if(empty($opts['depth'])){
503			$return = true; // recurse forever
504			}else{
505			$depth = substr_count($file,'/');
506			if($depth >= $opts['depth']){
507			$return = false; // depth reached
508			}else{
509			$return = true;
510			}
511			}
512
513			if ($return) {
514			$match = empty($opts['recmatch']) \|\| preg_match('/'.$opts['recmatch'].'/',$file);
515			if (!$match) {
516			return false; // doesn't match
517			}
518			}
519			}
520
521			// check ACL
522			if(empty($opts['skipacl'])){
523			if($type == 'd'){
524			$item['perm'] = auth_quickaclcheck($item['id'].':*');
525			}else{
526			$item['perm'] = auth_quickaclcheck($item['id']); //FIXME check namespace for media files
527			}
528			}else{
529			$item['perm'] = AUTH_DELETE;
530			}
531
532			// are we done here maybe?
533			if($type == 'd'){
534			if(empty($opts['listdirs'])) return $return;
535			//neither list nor recurse forbidden items:
536			if(empty($opts['skipacl']) && !empty($opts['sneakyacl']) && $item['perm'] < AUTH_READ) return false;
537			if(!empty($opts['dirmatch']) && !preg_match('/'.$opts['dirmatch'].'/',$file)) return $return;
538			if(!empty($opts['nsmatch']) && !preg_match('/'.$opts['nsmatch'].'/',$item['ns'])) return $return;
539			}else{
540			if(empty($opts['listfiles'])) return $return;
541			if(empty($opts['skipacl']) && $item['perm'] < AUTH_READ) return $return;
542			if(!empty($opts['pagesonly']) && (substr($file,-4) != '.txt')) return $return;
543			if(empty($opts['showhidden']) && isHiddenPage($item['id'])) return $return;
544			if(!empty($opts['filematch']) && !preg_match('/'.$opts['filematch'].'/',$file)) return $return;
545			if(!empty($opts['idmatch']) && !preg_match('/'.$opts['idmatch'].'/',$item['id'])) return $return;
546			}
547
548			// still here? prepare the item
549			$item['type'] = $type;
550			$item['level'] = $lvl;
551			$item['open'] = $return;
552
553			if(!empty($opts['meta'])){
554			$item['file'] = \dokuwiki\Utf8\PhpString::basename($file);
555			$item['size'] = filesize($base.'/'.$file);
556			$item['mtime'] = filemtime($base.'/'.$file);
557			$item['rev'] = $item['mtime'];
558			$item['writable'] = is_writable($base.'/'.$file);
559			$item['executable'] = is_executable($base.'/'.$file);
560			}
561
562			if($type == 'f'){
563			if(!empty($opts['hash'])) $item['hash'] = md5(io_readFile($base.'/'.$file,false));
564			if(!empty($opts['firsthead'])) $item['title'] = p_get_first_heading($item['id'],METADATA_DONT_RENDER);
565			}
566
567			// finally add the item
568			$data[] = $item;
569			return $return;
570			}
571
572			//Setup VIM: ex: et ts=4 :
573

splitbrain / dokuwiki

Push — mediaitems ( 8f7d0e...4f33ba )

inc/search.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like