xref: /dokuwiki/inc/Ajax.php (revision d4f83172d9533c4d84f450fe22ef630816b21d75)

<?php

namespace dokuwiki;

use dokuwiki\Extension\Event;
use dokuwiki\Ui\MediaDiff;
use dokuwiki\Ui\Index;
use dokuwiki\Ui;
use dokuwiki\Utf8\Sort;

/**
 * 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' . ucfirst($call);
        if (method_exists($this, $callfn)) {
            $this->$callfn();
        } else {
            $evt = new Event('AJAX_CALL_UNKNOWN', $call);
            if ($evt->advise_before()) {
                echo "AJAX call '" . hsc($call) . "' unknown!\n";
            } else {
                $evt->advise_after();
                unset($evt);
            }
        }
    }

    /**
     * Searches for matching pagenames
     *
     * @author Andreas Gohr <andi@splitbrain.org>
     */
    protected function callQsearch()
    {
        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 ($data === []) return;

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

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

    /**
     * Support OpenSearch suggestions
     *
     * @link   http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.0
     * @author Mike Frysinger <vapier@gentoo.org>
     */
    protected function callSuggestions()
    {
        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 ($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::sort($data);

        /* now construct a json */
        $suggestions = [
            $query, // the original query
            $data, // some suggestions
            [], // no description
            [], // no urls
        ];

        header('Content-Type: application/x-suggestions+json');
        echo json_encode($suggestions, JSON_THROW_ON_ERROR);
    }

    /**
     * Refresh a page lock and save draft
     *
     * Andreas Gohr <andi@splitbrain.org>
     */
    protected function callLock()
    {
        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, JSON_THROW_ON_ERROR);
    }

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

        $client = $INPUT->server->str('REMOTE_USER');
        if (!$client) $client = clientIP(true);

        $draft = new Draft($id, $client);
        if ($draft->isDraftAvailable() && checkSecurityToken()) {
            $draft->deleteDraft();
        }
    }

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

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

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

        $data = [];
        search($data, $conf['mediadir'], 'search_index', ['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 callMedialist()
    {
        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 callMediadetails()
    {
        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 callMediadiff()
    {
        global $INPUT;

        $image = '';
        if ($INPUT->has('image')) $image = cleanID($INPUT->str('image'));
        (new MediaDiff($image))->preference('fromAjax', true)->show();
    }

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

        $id = '';
        if (isset($_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 (isset($_FILES['qqfile']['error']) && $_FILES['qqfile']['error']) unset($_FILES['qqfile']);

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

        if ($res) {
            $result = [
                'success' => true,
                'link' => media_managerURL(['ns' => $ns, 'image' => $NS . ':' . $id], '&'),
                'id' => $NS . ':' . $id,
                'ns' => $NS
            ];
        } else {
            $error = '';
            if (isset($MSG)) {
                foreach ($MSG as $msg) {
                    $error .= $msg['msg'];
                }
            }
            $result = ['error' => $error, 'ns' => $NS];
        }

        header('Content-Type: application/json');
        echo json_encode($result, JSON_THROW_ON_ERROR);
    }

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

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

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

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

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

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

        $ns = cleanID($ns);

        $id = cleanID($id);

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

        $data = [];
        if ($q !== '' && $ns === '') {
            // use index to lookup matching pages
            $pages = ft_pageLookup($id, true);

            // If 'useheading' option is 'always' or 'content',
            // search page titles with original query as well.
            if ($conf['useheading'] == '1' || $conf['useheading'] == 'content') {
                $pages = array_merge($pages, ft_pageLookup($q, true, true));
                asort($pages, SORT_STRING);
            }

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

            foreach ($pages as $pid => $title) {
                if (strpos(getNS($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[] = ['id' => $pid, 'title' => $title, 'type' => 'f'];
                }
                unset($pages[$pid]);
            }
            foreach (array_keys($dirs) as $dir) {
                $data[] = ['id' => $dir, 'type' => 'd'];
            }
        } else {
            $opts = [
                '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,
                    ['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>';
        }
    }
}