dokuwiki\Ajax

Complexity

Total Complexity

65

Size/Duplication

Total Lines	429
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	3
C	call_qsearch()	0	40	8
B	call_suggestions()	0	30	4
B	call_lock()	0	34	5
A	call_draftdel()	0	11	3
A	call_medians()	0	17	2
A	call_medialist()	0	12	3
B	call_mediadetails()	0	15	6
A	call_mediadiff()	0	10	2
C	call_mediaupload()	0	49	10
A	call_index()	0	17	2
D	call_linkwiz()	0	103	17

<?php

namespace dokuwiki;

/**
 * Manage all builtin AJAX calls
 *
 * @todo The calls should be refactored out to their own proper classes
 * @package dokuwiki
 */
class Ajax {

    /**
     * Execute the given call
     *
     * @param string $call name of the ajax call
     */
    public function __construct($call) {
        $callfn = 'call_' . $call;
        if(method_exists($this, $callfn)) {
            $this->$callfn();
        } else {
            $evt = new \Doku_Event('AJAX_CALL_UNKNOWN', $call);
            if($evt->advise_before()) {
                print "AJAX call '" . hsc($call) . "' unknown!\n";
            } else {
                $evt->advise_after();
                unset($evt);
            }
        }
    }

    /**
     * Searches for matching pagenames
     *
     * @author Andreas Gohr <andi@splitbrain.org>
     */
    protected function call_qsearch() {
        global $lang;
        global $INPUT;

        $maxnumbersuggestions = 50;

        $query = $INPUT->post->str('q');
        if(empty($query)) $query = $INPUT->get->str('q');
        if(empty($query)) return;

        $query = urldecode($query);

        $data = ft_pageLookup($query, true, useHeading('navigation'));

        if(!count($data)) return;

        print '<strong>' . $lang['quickhits'] . '</strong>';
        print '<ul>';
        $counter = 0;
        foreach($data as $id => $title) {
            if(useHeading('navigation')) {
                $name = $title;
            } else {
                $ns = getNS($id);
                if($ns) {

The expression $ns of type string|false is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

                    $name = noNS($id) . ' (' . $ns . ')';
                } else {
                    $name = $id;
                }
            }
            echo '<li>' . html_wikilink(':' . $id, $name) . '</li>';

            $counter++;
            if($counter > $maxnumbersuggestions) {
                echo '<li>...</li>';
                break;
            }
        }
        print '</ul>';
    }

    /**
     * Support OpenSearch suggestions
     *
     * @link   http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.0
     * @author Mike Frysinger <vapier@gentoo.org>
     */
    protected function call_suggestions() {
        global $INPUT;

        $query = cleanID($INPUT->post->str('q'));
        if(empty($query)) $query = cleanID($INPUT->get->str('q'));
        if(empty($query)) return;

        $data = ft_pageLookup($query);
        if(!count($data)) return;
        $data = array_keys($data);

        // limit results to 15 hits
        $data = array_slice($data, 0, 15);
        $data = array_map('trim', $data);
        $data = array_map('noNS', $data);
        $data = array_unique($data);
        sort($data);

        /* now construct a json */
        $suggestions = array(
            $query,  // the original query
            $data,   // some suggestions
            array(), // no description
            array()  // no urls
        );
        $json = new \JSON();

        header('Content-Type: application/x-suggestions+json');
        print $json->encode($suggestions);
    }

    /**
     * Refresh a page lock and save draft
     *
     * Andreas Gohr <andi@splitbrain.org>
     */
    protected function call_lock() {
        global $ID;
        global $INFO;
        global $INPUT;

        $ID = cleanID($INPUT->post->str('id'));
        if(empty($ID)) return;

        $INFO = pageinfo();

        $response = [
            'errors' => [],
            'lock' => '0',
            'draft' => '',
        ];
        if(!$INFO['writable']) {
            $response['errors'][] = 'Permission to write this page has been denied.';
            echo json_encode($response);
            return;
        }

        if(!checklock($ID)) {
            lock($ID);
            $response['lock'] = '1';
        }

        $draft = new Draft($ID, $INFO['client']);
        if ($draft->saveDraft()) {
            $response['draft'] = $draft->getDraftMessage();
        } else {
            $response['errors'] = array_merge($response['errors'], $draft->getErrors());
        }
        echo json_encode($response);
    }

    /**
     * Delete a draft
     *
     * @author Andreas Gohr <andi@splitbrain.org>
     */
    protected function call_draftdel() {
        global $INPUT;
        $id = cleanID($INPUT->str('id'));
        if(empty($id)) return;

        $client = $_SERVER['REMOTE_USER'];
        if(!$client) $client = clientIP(true);

        $cname = getCacheName($client . $id, '.draft');
        @unlink($cname);
    }

    /**
     * Return subnamespaces for the Mediamanager
     *
     * @author Andreas Gohr <andi@splitbrain.org>
     */
    protected function call_medians() {
        global $conf;
        global $INPUT;

        // wanted namespace
        $ns = cleanID($INPUT->post->str('ns'));
        $dir = utf8_encodeFN(str_replace(':', '/', $ns));

        $lvl = count(explode(':', $ns));

        $data = array();
        search($data, $conf['mediadir'], 'search_index', array('nofiles' => true), $dir);
        foreach(array_keys($data) as $item) {
            $data[$item]['level'] = $lvl + 1;
        }
        echo html_buildlist($data, 'idx', 'media_nstree_item', 'media_nstree_li');
    }

    /**
     * Return list of files for the Mediamanager
     *
     * @author Andreas Gohr <andi@splitbrain.org>
     */
    protected function call_medialist() {
        global $NS;
        global $INPUT;

        $NS = cleanID($INPUT->post->str('ns'));
        $sort = $INPUT->post->bool('recent') ? 'date' : 'natural';
        if($INPUT->post->str('do') == 'media') {
            tpl_mediaFileList();
        } else {
            tpl_mediaContent(true, $sort);
        }
    }

    /**
     * Return the content of the right column
     * (image details) for the Mediamanager
     *
     * @author Kate Arzamastseva <pshns@ukr.net>
     */
    protected function call_mediadetails() {
        global $IMG, $JUMPTO, $REV, $fullscreen, $INPUT;
        $fullscreen = true;
        require_once(DOKU_INC . 'lib/exe/mediamanager.php');

        $image = '';
        if($INPUT->has('image')) $image = cleanID($INPUT->str('image'));
        if(isset($IMG)) $image = $IMG;
        if(isset($JUMPTO)) $image = $JUMPTO;
        $rev = false;
        if(isset($REV) && !$JUMPTO) $rev = $REV;

        html_msgarea();
        tpl_mediaFileDetails($image, $rev);
    }

    /**
     * Returns image diff representation for mediamanager
     *
     * @author Kate Arzamastseva <pshns@ukr.net>
     */
    protected function call_mediadiff() {
        global $NS;
        global $INPUT;

        $image = '';
        if($INPUT->has('image')) $image = cleanID($INPUT->str('image'));
        $NS = getNS($image);
        $auth = auth_quickaclcheck("$NS:*");
        media_diff($image, $NS, $auth, true);

It seems like $NS defined by getNS($image) on line 247 can also be of type false; however, media_diff() does only seem to accept string, did you maybe forget to handle an error condition?

    }

    /**
     * Manages file uploads
     *
     * @author Kate Arzamastseva <pshns@ukr.net>
     */
    protected function call_mediaupload() {
        global $NS, $MSG, $INPUT;

        $id = '';
        if($_FILES['qqfile']['tmp_name']) {
            $id = $INPUT->post->str('mediaid', $_FILES['qqfile']['name']);
        } elseif($INPUT->get->has('qqfile')) {
            $id = $INPUT->get->str('qqfile');
        }

        $id = cleanID($id);

        $NS = $INPUT->str('ns');
        $ns = $NS . ':' . getNS($id);

        $AUTH = auth_quickaclcheck("$ns:*");
        if($AUTH >= AUTH_UPLOAD) {
            io_createNamespace("$ns:xxx", 'media');
        }

        if($_FILES['qqfile']['error']) unset($_FILES['qqfile']);

        $res = false;
        if($_FILES['qqfile']['tmp_name']) $res = media_upload($NS, $AUTH, $_FILES['qqfile']);
        if($INPUT->get->has('qqfile')) $res = media_upload_xhr($NS, $AUTH);

        if($res) {

The expression $res of type false|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== false instead.

            $result = array(
                'success' => true,
                'link' => media_managerURL(array('ns' => $ns, 'image' => $NS . ':' . $id), '&'),
                'id' => $NS . ':' . $id,
                'ns' => $NS
            );
        } else {
            $error = '';
            if(isset($MSG)) {
                foreach($MSG as $msg) {
                    $error .= $msg['msg'];
                }
            }
            $result = array(
                'error' => $error,
                'ns' => $NS
            );
        }
        $json = new \JSON;
        header('Content-Type: application/json');
        echo $json->encode($result);
    }

    /**
     * Return sub index for index view
     *
     * @author Andreas Gohr <andi@splitbrain.org>
     */
    protected function call_index() {
        global $conf;
        global $INPUT;

        // wanted namespace
        $ns = cleanID($INPUT->post->str('idx'));
        $dir = utf8_encodeFN(str_replace(':', '/', $ns));

        $lvl = count(explode(':', $ns));

        $data = array();
        search($data, $conf['datadir'], 'search_index', array('ns' => $ns), $dir);
        foreach(array_keys($data) as $item) {
            $data[$item]['level'] = $lvl + 1;
        }
        echo html_buildlist($data, 'idx', 'html_list_index', 'html_li_index');
    }

    /**
     * List matching namespaces and pages for the link wizard
     *
     * @author Andreas Gohr <gohr@cosmocode.de>
     */
    protected function call_linkwiz() {
        global $conf;
        global $lang;
        global $INPUT;

        $q = ltrim(trim($INPUT->post->str('q')), ':');
        $id = noNS($q);
        $ns = getNS($q);

        $ns = cleanID($ns);

It seems like $ns can also be of type false; however, cleanID() does only seem to accept string, did you maybe forget to handle an error condition?

        $id = cleanID($id);

        $nsd = utf8_encodeFN(str_replace(':', '/', $ns));

        $data = array();
        if($q && !$ns) {

            // use index to lookup matching pages
            $pages = ft_pageLookup($id, true);

            // result contains matches in pages and namespaces
            // we now extract the matching namespaces to show
            // them seperately
            $dirs = array();

            foreach($pages as $pid => $title) {
                if(strpos(noNS($pid), $id) === false) {
                    // match was in the namespace
                    $dirs[getNS($pid)] = 1; // assoc array avoids dupes
                } else {
                    // it is a matching page, add it to the result
                    $data[] = array(
                        'id' => $pid,
                        'title' => $title,
                        'type' => 'f',
                    );
                }
                unset($pages[$pid]);
            }
            foreach($dirs as $dir => $junk) {
                $data[] = array(
                    'id' => $dir,
                    'type' => 'd',
                );
            }

        } else {

            $opts = array(
                'depth' => 1,
                'listfiles' => true,
                'listdirs' => true,
                'pagesonly' => true,
                'firsthead' => true,
                'sneakyacl' => $conf['sneaky_index'],
            );
            if($id) $opts['filematch'] = '^.*\/' . $id;
            if($id) $opts['dirmatch'] = '^.*\/' . $id;
            search($data, $conf['datadir'], 'search_universal', $opts, $nsd);

            // add back to upper
            if($ns) {
                array_unshift(
                    $data, array(
                             'id' => getNS($ns),
                             'type' => 'u',
                         )
                );
            }
        }

        // fixme sort results in a useful way ?

        if(!count($data)) {
            echo $lang['nothingfound'];
            exit;
        }

        // output the found data
        $even = 1;
        foreach($data as $item) {
            $even *= -1; //zebra

            if(($item['type'] == 'd' || $item['type'] == 'u') && $item['id']) $item['id'] .= ':';
            $link = wl($item['id']);

            echo '<div class="' . (($even > 0) ? 'even' : 'odd') . ' type_' . $item['type'] . '">';

            if($item['type'] == 'u') {
                $name = $lang['upperns'];
            } else {
                $name = hsc($item['id']);
            }

            echo '<a href="' . $link . '" title="' . hsc($item['id']) . '" class="wikilink1">' . $name . '</a>';

            if(!blank($item['title'])) {
                echo '<span>' . hsc($item['title']) . '</span>';
            }
            echo '</div>';
        }

    }

}