xref: /plugin/struct/action/ajax.php (revision 748e747f37aa44250ee32847b5fc3ff1e47f0835)
1914921fbSAndreas Gohr<?php
2d6d97f60SAnna Dabrowska
3914921fbSAndreas Gohr/**
4914921fbSAndreas Gohr * DokuWiki Plugin struct (Action Component)
5914921fbSAndreas Gohr *
6914921fbSAndreas Gohr * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
7914921fbSAndreas Gohr * @author  Andreas Gohr, Michael Große <dokuwiki@cosmocode.de>
8914921fbSAndreas Gohr */
9914921fbSAndreas Gohr
10ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\Schema;
11ba766201SAndreas Gohruse dokuwiki\plugin\struct\meta\StructException;
12914921fbSAndreas Gohr
13d6d97f60SAnna Dabrowskaclass action_plugin_struct_ajax extends DokuWiki_Action_Plugin
14d6d97f60SAnna Dabrowska{
15914921fbSAndreas Gohr
16914921fbSAndreas Gohr    /**
17914921fbSAndreas Gohr     * Registers a callback function for a given event
18914921fbSAndreas Gohr     *
19914921fbSAndreas Gohr     * @param Doku_Event_Handler $controller DokuWiki's event controller object
20914921fbSAndreas Gohr     * @return void
21914921fbSAndreas Gohr     */
22d6d97f60SAnna Dabrowska    public function register(Doku_Event_Handler $controller)
23d6d97f60SAnna Dabrowska    {
24*748e747fSAnna Dabrowska        $controller->register_hook('AJAX_CALL_UNKNOWN', 'BEFORE', $this, 'handleAjax');
25914921fbSAndreas Gohr    }
26914921fbSAndreas Gohr
27914921fbSAndreas Gohr    /**
28914921fbSAndreas Gohr     * Pass Ajax call to a type
29914921fbSAndreas Gohr     *
30914921fbSAndreas Gohr     * @param Doku_Event $event event object by reference
31914921fbSAndreas Gohr     * @param mixed $param [the parameters passed as fifth argument to register_hook() when this
32914921fbSAndreas Gohr     *                           handler was registered]
33914921fbSAndreas Gohr     */
34*748e747fSAnna Dabrowska    public function handleAjax(Doku_Event $event, $param)
35d6d97f60SAnna Dabrowska    {
36914921fbSAndreas Gohr        if ($event->data != 'plugin_struct') return;
37914921fbSAndreas Gohr        $event->preventDefault();
38914921fbSAndreas Gohr        $event->stopPropagation();
399dfe4ab9SAndreas Gohr        global $conf;
40914921fbSAndreas Gohr
41914921fbSAndreas Gohr        header('Content-Type: application/json');
42914921fbSAndreas Gohr        try {
43914921fbSAndreas Gohr            $result = $this->executeTypeAjax();
44914921fbSAndreas Gohr        } catch (StructException $e) {
45914921fbSAndreas Gohr            $result = array(
469dfe4ab9SAndreas Gohr                'error' => $e->getMessage() . ' ' . basename($e->getFile()) . ':' . $e->getLine()
47914921fbSAndreas Gohr            );
489dfe4ab9SAndreas Gohr            if ($conf['allowdebug']) {
499dfe4ab9SAndreas Gohr                $result['stacktrace'] = $e->getTraceAsString();
509dfe4ab9SAndreas Gohr            }
51914921fbSAndreas Gohr            http_status(500);
52914921fbSAndreas Gohr        }
53914921fbSAndreas Gohr
54d6d97f60SAnna Dabrowska        $json = new JSON();
55914921fbSAndreas Gohr        echo $json->encode($result);
56914921fbSAndreas Gohr    }
57914921fbSAndreas Gohr
58914921fbSAndreas Gohr    /**
59914921fbSAndreas Gohr     * Check the input variables and run the AJAX call
60914921fbSAndreas Gohr     *
61914921fbSAndreas Gohr     * @throws StructException
62914921fbSAndreas Gohr     * @return mixed
63914921fbSAndreas Gohr     */
64d6d97f60SAnna Dabrowska    protected function executeTypeAjax()
65d6d97f60SAnna Dabrowska    {
66914921fbSAndreas Gohr        global $INPUT;
67914921fbSAndreas Gohr
68914921fbSAndreas Gohr        $col = $INPUT->str('column');
69914921fbSAndreas Gohr        if (blank($col)) throw new StructException('No column provided');
70914921fbSAndreas Gohr        list($schema, $colname) = explode('.', $col, 2);
71914921fbSAndreas Gohr        if (blank($schema) || blank($colname)) throw new StructException('Column format is wrong');
72914921fbSAndreas Gohr
73914921fbSAndreas Gohr        $schema = new Schema($schema);
74914921fbSAndreas Gohr        if (!$schema->getId()) throw new StructException('Unknown Schema');
75914921fbSAndreas Gohr
76914921fbSAndreas Gohr        $column = $schema->findColumn($colname);
77914921fbSAndreas Gohr        if ($column === false) throw new StructException('Column not found');
78914921fbSAndreas Gohr
79914921fbSAndreas Gohr        return $column->getType()->handleAjax();
80914921fbSAndreas Gohr    }
81914921fbSAndreas Gohr}
82