xref: /plugin/tagging/helper.php (revision a305ec34acaf63e01af2bd998614e2d50f1966ab)
1f61105deSAdrian Lang<?php
2aa627deeSAndreas Gohr/**
3aa627deeSAndreas Gohr * Tagging Plugin (hlper component)
4aa627deeSAndreas Gohr *
5aa627deeSAndreas Gohr * @license GPL 2
6aa627deeSAndreas Gohr */
7e4543b6dSAdrian Langclass helper_plugin_tagging extends DokuWiki_Plugin {
8f61105deSAdrian Lang
9289f50bdSAndreas Gohr    /**
10b12334e1SAndreas Gohr     * Gives access to the database
11b12334e1SAndreas Gohr     *
12b12334e1SAndreas Gohr     * Initializes the SQLite helper and register the CLEANTAG function
13b12334e1SAndreas Gohr     *
14b12334e1SAndreas Gohr     * @return helper_plugin_sqlite|bool false if initialization fails
15289f50bdSAndreas Gohr     */
16289f50bdSAndreas Gohr    public function getDB() {
17302a38efSAndreas Gohr        static $db = null;
18aa627deeSAndreas Gohr        if ($db !== null) {
19f61105deSAdrian Lang            return $db;
20f61105deSAdrian Lang        }
21f61105deSAdrian Lang
22302a38efSAndreas Gohr        /** @var helper_plugin_sqlite $db */
23f61105deSAdrian Lang        $db = plugin_load('helper', 'sqlite');
24aa627deeSAndreas Gohr        if ($db === null) {
25f61105deSAdrian Lang            msg('The tagging plugin needs the sqlite plugin', -1);
26ca455b8eSMichael Große
27f61105deSAdrian Lang            return false;
28f61105deSAdrian Lang        }
29aa627deeSAndreas Gohr        $db->init('tagging', __DIR__ . '/db/');
30302a38efSAndreas Gohr        $db->create_function('CLEANTAG', array($this, 'cleanTag'), 1);
317e05e623SSzymon Olewniczak        $db->create_function('GROUP_SORT',
327e05e623SSzymon Olewniczak            function ($group, $newDelimiter) {
3340b94b1aSAnna Dabrowska                $ex = array_filter(explode(',', $group));
347e05e623SSzymon Olewniczak                sort($ex);
35ca455b8eSMichael Große
367e05e623SSzymon Olewniczak                return implode($newDelimiter, $ex);
377e05e623SSzymon Olewniczak            }, 2);
3840b94b1aSAnna Dabrowska        $db->create_function('GET_NS', 'getNS', 1);
39ca455b8eSMichael Große
40f61105deSAdrian Lang        return $db;
41f61105deSAdrian Lang    }
42f61105deSAdrian Lang
43302a38efSAndreas Gohr    /**
442ace74f4SAndreas Gohr     * Return the user to use for accessing tags
452ace74f4SAndreas Gohr     *
462ace74f4SAndreas Gohr     * Handles the singleuser mode by returning 'auto' as user. Returnes false when no user is logged in.
472ace74f4SAndreas Gohr     *
482ace74f4SAndreas Gohr     * @return bool|string
492ace74f4SAndreas Gohr     */
502ace74f4SAndreas Gohr    public function getUser() {
510cfde7e9SMichael Große        if (!isset($_SERVER['REMOTE_USER'])) {
520cfde7e9SMichael Große            return false;
530cfde7e9SMichael Große        }
540cfde7e9SMichael Große        if ($this->getConf('singleusermode')) {
550cfde7e9SMichael Große            return 'auto';
560cfde7e9SMichael Große        }
57ca455b8eSMichael Große
582ace74f4SAndreas Gohr        return $_SERVER['REMOTE_USER'];
592ace74f4SAndreas Gohr    }
602ace74f4SAndreas Gohr
612ace74f4SAndreas Gohr    /**
62302a38efSAndreas Gohr     * Canonicalizes the tag to its lower case nospace form
63302a38efSAndreas Gohr     *
64302a38efSAndreas Gohr     * @param $tag
650cfde7e9SMichael Große     *
66302a38efSAndreas Gohr     * @return string
67302a38efSAndreas Gohr     */
68302a38efSAndreas Gohr    public function cleanTag($tag) {
69aa627deeSAndreas Gohr        $tag = str_replace(array(' ', '-', '_'), '', $tag);
70302a38efSAndreas Gohr        $tag = utf8_strtolower($tag);
71ca455b8eSMichael Große
72302a38efSAndreas Gohr        return $tag;
73302a38efSAndreas Gohr    }
74302a38efSAndreas Gohr
7556d82720SAndreas Gohr    /**
7631396860SSzymon Olewniczak     * Canonicalizes the namespace, remove the first colon and add glob
7731396860SSzymon Olewniczak     *
7831396860SSzymon Olewniczak     * @param $namespace
7931396860SSzymon Olewniczak     *
8031396860SSzymon Olewniczak     * @return string
8131396860SSzymon Olewniczak     */
8231396860SSzymon Olewniczak    public function globNamespace($namespace) {
83de379874SAnna Dabrowska        return cleanId($namespace) . '*';
8431396860SSzymon Olewniczak    }
8531396860SSzymon Olewniczak
8631396860SSzymon Olewniczak    /**
8756d82720SAndreas Gohr     * Create or Update tags of a page
8856d82720SAndreas Gohr     *
8956d82720SAndreas Gohr     * Uses the translation plugin to store the language of a page (if available)
9056d82720SAndreas Gohr     *
9156d82720SAndreas Gohr     * @param string $id The page ID
9256d82720SAndreas Gohr     * @param string $user
9356d82720SAndreas Gohr     * @param array  $tags
940cfde7e9SMichael Große     *
9556d82720SAndreas Gohr     * @return bool|SQLiteResult
9656d82720SAndreas Gohr     */
97f61105deSAdrian Lang    public function replaceTags($id, $user, $tags) {
9856d82720SAndreas Gohr        global $conf;
9956d82720SAndreas Gohr        /** @var helper_plugin_translation $trans */
10056d82720SAndreas Gohr        $trans = plugin_load('helper', 'translation');
10156d82720SAndreas Gohr        if ($trans) {
10256d82720SAndreas Gohr            $lang = $trans->realLC($trans->getLangPart($id));
10356d82720SAndreas Gohr        } else {
10456d82720SAndreas Gohr            $lang = $conf['lang'];
10556d82720SAndreas Gohr        }
10656d82720SAndreas Gohr
107f61105deSAdrian Lang        $db = $this->getDB();
108f61105deSAdrian Lang        $db->query('BEGIN TRANSACTION');
109f61105deSAdrian Lang        $queries = array(array('DELETE FROM taggings WHERE pid = ? AND tagger = ?', $id, $user));
110f61105deSAdrian Lang        foreach ($tags as $tag) {
11156d82720SAndreas Gohr            $queries[] = array('INSERT INTO taggings (pid, tagger, tag, lang) VALUES(?, ?, ?, ?)', $id, $user, $tag, $lang);
112f61105deSAdrian Lang        }
113f61105deSAdrian Lang
114f61105deSAdrian Lang        foreach ($queries as $query) {
115f61105deSAdrian Lang            if (!call_user_func_array(array($db, 'query'), $query)) {
116f61105deSAdrian Lang                $db->query('ROLLBACK TRANSACTION');
117ca455b8eSMichael Große
118f61105deSAdrian Lang                return false;
119f61105deSAdrian Lang            }
120f61105deSAdrian Lang        }
121ca455b8eSMichael Große
122f61105deSAdrian Lang        return $db->query('COMMIT TRANSACTION');
123f61105deSAdrian Lang    }
124f61105deSAdrian Lang
1250a518a11SAndreas Gohr    /**
126b12334e1SAndreas Gohr     * Get a list of Tags or Pages matching search criteria
1270a518a11SAndreas Gohr     *
128b12334e1SAndreas Gohr     * @param array  $filter What to search for array('field' => 'searchterm')
129b12334e1SAndreas Gohr     * @param string $type   What field to return 'tag'|'pid'
130077ff864SAndreas Gohr     * @param int    $limit  Limit to this many results, 0 for all
1310cfde7e9SMichael Große     *
1320a518a11SAndreas Gohr     * @return array associative array in form of value => count
1330a518a11SAndreas Gohr     */
134077ff864SAndreas Gohr    public function findItems($filter, $type, $limit = 0) {
135f61105deSAdrian Lang
1364a7da0a5SAnna Dabrowska        global $INPUT;
137b12334e1SAndreas Gohr
1384a7da0a5SAnna Dabrowska        /** @var helper_plugin_tagging_querybuilder $queryBuilder */
13965d49a60SAnna Dabrowska        $queryBuilder = new \helper_plugin_tagging_querybuilder();
1401b4b4fa9SAnna Dabrowska
1414a7da0a5SAnna Dabrowska        $queryBuilder->setField($type);
1424a7da0a5SAnna Dabrowska        $queryBuilder->setLimit($limit);
1434a7da0a5SAnna Dabrowska        $queryBuilder->setTags($this->getTags($filter));
1444a7da0a5SAnna Dabrowska        if (isset($filter['ns'])) $queryBuilder->includeNS($filter['ns']);
1454a7da0a5SAnna Dabrowska        if (isset($filter['notns'])) $queryBuilder->excludeNS($filter['notns']);
1464a7da0a5SAnna Dabrowska        if (isset($filter['tagger'])) $queryBuilder->setTagger($filter['tagger']);
1474a7da0a5SAnna Dabrowska        if (isset($filter['pid'])) $queryBuilder->setPid($filter['pid']);
148b12334e1SAndreas Gohr
1494a7da0a5SAnna Dabrowska        return $this->queryDb($queryBuilder->getQuery());
150ca455b8eSMichael Große
151f61105deSAdrian Lang    }
152f61105deSAdrian Lang
153b12334e1SAndreas Gohr    /**
154302a38efSAndreas Gohr     * Constructs the URL to search for a tag
155302a38efSAndreas Gohr     *
1565540f91dSAndreas Gohr     * @param string $tag
1575540f91dSAndreas Gohr     * @param string $ns
1580cfde7e9SMichael Große     *
159302a38efSAndreas Gohr     * @return string
160302a38efSAndreas Gohr     */
1615540f91dSAndreas Gohr    public function getTagSearchURL($tag, $ns = '') {
162bed9f360SAndreas Gohr        // wrap tag in quotes if non clean
1632cb25ec1SAndreas Gohr        $ctag = utf8_stripspecials($this->cleanTag($tag));
1640cfde7e9SMichael Große        if ($ctag != utf8_strtolower($tag)) {
1650cfde7e9SMichael Große            $tag = '"' . $tag . '"';
1660cfde7e9SMichael Große        }
167bed9f360SAndreas Gohr
168018370fcSsheesupport        $ret = '?do=search&sf=1&id=' . rawurlencode($tag);
1690cfde7e9SMichael Große        if ($ns) {
1700cfde7e9SMichael Große            $ret .= rawurlencode(' @' . $ns);
1710cfde7e9SMichael Große        }
1725540f91dSAndreas Gohr
1735540f91dSAndreas Gohr        return $ret;
174f61105deSAdrian Lang    }
175f61105deSAdrian Lang
1765540f91dSAndreas Gohr    /**
1775540f91dSAndreas Gohr     * Calculates the size levels for the given list of clouds
1785540f91dSAndreas Gohr     *
1795540f91dSAndreas Gohr     * Automatically determines sensible tresholds
1805540f91dSAndreas Gohr     *
1815540f91dSAndreas Gohr     * @param array $tags list of tags => count
1825540f91dSAndreas Gohr     * @param int   $levels
1830cfde7e9SMichael Große     *
1845540f91dSAndreas Gohr     * @return mixed
1855540f91dSAndreas Gohr     */
186f61105deSAdrian Lang    public function cloudData($tags, $levels = 10) {
187f61105deSAdrian Lang        $min = min($tags);
188f61105deSAdrian Lang        $max = max($tags);
189f61105deSAdrian Lang
190f61105deSAdrian Lang        // calculate tresholds
191f61105deSAdrian Lang        $tresholds = array();
192f61105deSAdrian Lang        for ($i = 0; $i <= $levels; $i++) {
193f61105deSAdrian Lang            $tresholds[$i] = pow($max - $min + 1, $i / $levels) + $min - 1;
194f61105deSAdrian Lang        }
195f61105deSAdrian Lang
196f61105deSAdrian Lang        // assign weights
197f61105deSAdrian Lang        foreach ($tags as $tag => $cnt) {
198f61105deSAdrian Lang            foreach ($tresholds as $tresh => $val) {
199f61105deSAdrian Lang                if ($cnt <= $val) {
200f61105deSAdrian Lang                    $tags[$tag] = $tresh;
201f61105deSAdrian Lang                    break;
202f61105deSAdrian Lang                }
203f61105deSAdrian Lang                $tags[$tag] = $levels;
204f61105deSAdrian Lang            }
205f61105deSAdrian Lang        }
206ca455b8eSMichael Große
207f61105deSAdrian Lang        return $tags;
208f61105deSAdrian Lang    }
209f61105deSAdrian Lang
2105540f91dSAndreas Gohr    /**
2115540f91dSAndreas Gohr     * Display a tag cloud
2125540f91dSAndreas Gohr     *
2135540f91dSAndreas Gohr     * @param array    $tags   list of tags => count
2145540f91dSAndreas Gohr     * @param string   $type   'tag'
2155540f91dSAndreas Gohr     * @param Callable $func   The function to print the link (gets tag and ns)
2165540f91dSAndreas Gohr     * @param bool     $wrap   wrap cloud in UL tags?
2175540f91dSAndreas Gohr     * @param bool     $return returnn HTML instead of printing?
2185540f91dSAndreas Gohr     * @param string   $ns     Add this namespace to search links
2190cfde7e9SMichael Große     *
2205540f91dSAndreas Gohr     * @return string
2215540f91dSAndreas Gohr     */
2225540f91dSAndreas Gohr    public function html_cloud($tags, $type, $func, $wrap = true, $return = false, $ns = '') {
223a66f6715SAndreas Gohr        global $INFO;
224a66f6715SAndreas Gohr
225a66f6715SAndreas Gohr        $hidden_str = $this->getConf('hiddenprefix');
226a66f6715SAndreas Gohr        $hidden_len = strlen($hidden_str);
227a66f6715SAndreas Gohr
228f61105deSAdrian Lang        $ret = '';
2290cfde7e9SMichael Große        if ($wrap) {
2300cfde7e9SMichael Große            $ret .= '<ul class="tagging_cloud clearfix">';
2310cfde7e9SMichael Große        }
232f61105deSAdrian Lang        if (count($tags) === 0) {
233f61105deSAdrian Lang            // Produce valid XHTML (ul needs a child)
234f61105deSAdrian Lang            $this->setupLocale();
235f61105deSAdrian Lang            $ret .= '<li><div class="li">' . $this->lang['js']['no' . $type . 's'] . '</div></li>';
236f61105deSAdrian Lang        } else {
237f61105deSAdrian Lang            $tags = $this->cloudData($tags);
238f61105deSAdrian Lang            foreach ($tags as $val => $size) {
239a66f6715SAndreas Gohr                // skip hidden tags for users that can't edit
240aa627deeSAndreas Gohr                if ($type === 'tag' and
241a66f6715SAndreas Gohr                    $hidden_len and
242a66f6715SAndreas Gohr                    substr($val, 0, $hidden_len) == $hidden_str and
243a66f6715SAndreas Gohr                    !($this->getUser() && $INFO['writable'])
244a66f6715SAndreas Gohr                ) {
245a66f6715SAndreas Gohr                    continue;
246a66f6715SAndreas Gohr                }
247a66f6715SAndreas Gohr
248f61105deSAdrian Lang                $ret .= '<li class="t' . $size . '"><div class="li">';
2495540f91dSAndreas Gohr                $ret .= call_user_func($func, $val, $ns);
250f61105deSAdrian Lang                $ret .= '</div></li>';
251f61105deSAdrian Lang            }
252f61105deSAdrian Lang        }
2530cfde7e9SMichael Große        if ($wrap) {
2540cfde7e9SMichael Große            $ret .= '</ul>';
2550cfde7e9SMichael Große        }
2560cfde7e9SMichael Große        if ($return) {
2570cfde7e9SMichael Große            return $ret;
2580cfde7e9SMichael Große        }
259f61105deSAdrian Lang        echo $ret;
260ca455b8eSMichael Große
2615540f91dSAndreas Gohr        return '';
262f61105deSAdrian Lang    }
263f61105deSAdrian Lang
2645540f91dSAndreas Gohr    /**
2655540f91dSAndreas Gohr     * Get the link to a search for the given tag
2665540f91dSAndreas Gohr     *
2675540f91dSAndreas Gohr     * @param string $tag search for this tag
2685540f91dSAndreas Gohr     * @param string $ns  limit search to this namespace
2690cfde7e9SMichael Große     *
2705540f91dSAndreas Gohr     * @return string
2715540f91dSAndreas Gohr     */
2725540f91dSAndreas Gohr    protected function linkToSearch($tag, $ns = '') {
2735540f91dSAndreas Gohr        return '<a href="' . hsc($this->getTagSearchURL($tag, $ns)) . '">' . $tag . '</a>';
274f61105deSAdrian Lang    }
275f61105deSAdrian Lang
276fb1d0583SAndreas Gohr    /**
277fb1d0583SAndreas Gohr     * Display the Tags for the current page and prepare the tag editing form
2783496cc8aSAndreas Gohr     *
2793496cc8aSAndreas Gohr     * @param bool $print Should the HTML be printed or returned?
2800cfde7e9SMichael Große     *
2813496cc8aSAndreas Gohr     * @return string
282fb1d0583SAndreas Gohr     */
2833496cc8aSAndreas Gohr    public function tpl_tags($print = true) {
284f61105deSAdrian Lang        global $INFO;
285f61105deSAdrian Lang        global $lang;
2863bf0e2f1SMichael Große
2873bf0e2f1SMichael Große        $filter = array('pid' => $INFO['id']);
2883bf0e2f1SMichael Große        if ($this->getConf('singleusermode')) {
2893bf0e2f1SMichael Große            $filter['tagger'] = 'auto';
2903bf0e2f1SMichael Große        }
2913bf0e2f1SMichael Große
2923bf0e2f1SMichael Große        $tags = $this->findItems($filter, 'tag');
2933496cc8aSAndreas Gohr
2943496cc8aSAndreas Gohr        $ret = '';
2953496cc8aSAndreas Gohr
2963496cc8aSAndreas Gohr        $ret .= '<div class="plugin_tagging_edit">';
2973496cc8aSAndreas Gohr        $ret .= $this->html_cloud($tags, 'tag', array($this, 'linkToSearch'), true, true);
298f61105deSAdrian Lang
2992ace74f4SAndreas Gohr        if ($this->getUser() && $INFO['writable']) {
300f61105deSAdrian Lang            $lang['btn_tagging_edit'] = $lang['btn_secedit'];
301e5b42768SSzymon Olewniczak            $ret .= '<div id="tagging__edit_buttons_group">';
3023496cc8aSAndreas Gohr            $ret .= html_btn('tagging_edit', $INFO['id'], '', array());
303dd52fd45SSzymon Olewniczak            if (auth_isadmin()) {
30426f61833SAnna Dabrowska                $ret .= '<label>'
30526f61833SAnna Dabrowska                    . $this->getLang('toggle admin mode')
30626f61833SAnna Dabrowska                    . '<input type="checkbox" id="tagging__edit_toggle_admin" /></label>';
307dd52fd45SSzymon Olewniczak            }
308e5b42768SSzymon Olewniczak            $ret .= '</div>';
3092819ffcdSSzymon Olewniczak            $form = new dokuwiki\Form\Form();
3102819ffcdSSzymon Olewniczak            $form->id('tagging__edit');
3112819ffcdSSzymon Olewniczak            $form->setHiddenField('tagging[id]', $INFO['id']);
3122819ffcdSSzymon Olewniczak            $form->setHiddenField('call', 'plugin_tagging_save');
3132819ffcdSSzymon Olewniczak            $tags = $this->findItems(array(
3142819ffcdSSzymon Olewniczak                'pid'    => $INFO['id'],
315ca455b8eSMichael Große                'tagger' => $this->getUser(),
3162819ffcdSSzymon Olewniczak            ), 'tag');
31726f61833SAnna Dabrowska            $form->addTextarea('tagging[tags]')
31826f61833SAnna Dabrowska                ->val(implode(', ', array_keys($tags)))
31926f61833SAnna Dabrowska                ->addClass('edit')
32026f61833SAnna Dabrowska                ->attr('rows', 4);
321cf52ec2dSSzymon Olewniczak            $form->addButton('', $lang['btn_save'])->id('tagging__edit_save');
322cf52ec2dSSzymon Olewniczak            $form->addButton('', $lang['btn_cancel'])->id('tagging__edit_cancel');
3232819ffcdSSzymon Olewniczak            $ret .= $form->toHTML();
324f61105deSAdrian Lang        }
3253496cc8aSAndreas Gohr        $ret .= '</div>';
3263496cc8aSAndreas Gohr
3270cfde7e9SMichael Große        if ($print) {
3280cfde7e9SMichael Große            echo $ret;
3290cfde7e9SMichael Große        }
330ca455b8eSMichael Große
3313496cc8aSAndreas Gohr        return $ret;
332f61105deSAdrian Lang    }
333872edc7cSRené Corinth
3348a1a3846SAndreas Gohr    /**
335a99b66c1SSzymon Olewniczak     * @param string $namespace empty for entire wiki
336a99b66c1SSzymon Olewniczak     *
33740b94b1aSAnna Dabrowska     * @param string $order_by
33840b94b1aSAnna Dabrowska     * @param bool $desc
33940b94b1aSAnna Dabrowska     * @param array $filters
3408a1a3846SAndreas Gohr     * @return array
3418a1a3846SAndreas Gohr     */
342f6568bcbSAnna Dabrowska    public function getAllTags($namespace = '', $order_by = 'tid', $desc = false, $filters = []) {
3437c96ae87SAnna Dabrowska        $order_fields = array('pid', 'tid', 'taggers', 'ns', 'count');
344f0084ee1SSzymon Olewniczak        if (!in_array($order_by, $order_fields)) {
345f0084ee1SSzymon Olewniczak            msg('cannot sort by ' . $order_by . ' field does not exists', -1);
346f0084ee1SSzymon Olewniczak            $order_by = 'tag';
347f0084ee1SSzymon Olewniczak        }
348872edc7cSRené Corinth
34940b94b1aSAnna Dabrowska        list($having, $params) = $this->getFilterSql($filters);
35040b94b1aSAnna Dabrowska
351a2246f69SAnna Dabrowska        $db = $this->getDB();
352872edc7cSRené Corinth
353f0084ee1SSzymon Olewniczak        $query = 'SELECT    "pid",
354ca455b8eSMichael Große                            CLEANTAG("tag") AS "tid",
355f0084ee1SSzymon Olewniczak                            GROUP_SORT(GROUP_CONCAT("tagger"), \', \') AS "taggers",
35640b94b1aSAnna Dabrowska                            GROUP_SORT(GROUP_CONCAT(GET_NS("pid")), \', \') AS "ns",
35789ed97adSAnna Dabrowska                            GROUP_SORT(GROUP_CONCAT("pid"), \', \') AS "pids",
358193a767dSSzymon Olewniczak                            COUNT(*) AS "count"
35957e45304SSzymon Olewniczak                        FROM "taggings"
3604227fca4SAnna Dabrowska                        WHERE "pid" GLOB ? AND GETACCESSLEVEL(pid) >= ' . AUTH_READ
3614227fca4SAnna Dabrowska                        . ' GROUP BY "tid"';
36240b94b1aSAnna Dabrowska        $query .= $having;
36340b94b1aSAnna Dabrowska        $query .=      'ORDER BY ' . $order_by;
364ca455b8eSMichael Große        if ($desc) {
365ca455b8eSMichael Große            $query .= ' DESC';
366ca455b8eSMichael Große        }
367cb469644SSzymon Olewniczak
36840b94b1aSAnna Dabrowska        array_unshift($params, $this->globNamespace($namespace));
36940b94b1aSAnna Dabrowska        $res = $db->query($query, $params);
370872edc7cSRené Corinth
3717e05e623SSzymon Olewniczak        return $db->res2arr($res);
372872edc7cSRené Corinth    }
373872edc7cSRené Corinth
3748a1a3846SAndreas Gohr    /**
37572431326SMichael Große     * Get all pages with tags and their tags
37672431326SMichael Große     *
377790ca788SAndreas Gohr     * @return array ['pid' => ['tag1','tag2','tag3']]
37872431326SMichael Große     */
37972431326SMichael Große    public function getAllTagsByPage() {
38072431326SMichael Große        $query = '
38172431326SMichael Große        SELECT pid, GROUP_CONCAT(tag) AS tags
38272431326SMichael Große        FROM taggings
38372431326SMichael Große        GROUP BY pid
38472431326SMichael Große        ';
38572431326SMichael Große        $db = $this->getDb();
38672431326SMichael Große        $res = $db->query($query);
387790ca788SAndreas Gohr        return array_map(
388790ca788SAndreas Gohr            function ($i) {
389790ca788SAndreas Gohr                return explode(',', $i);
390790ca788SAndreas Gohr            },
391790ca788SAndreas Gohr            array_column($db->res2arr($res), 'tags', 'pid')
392790ca788SAndreas Gohr        );
39372431326SMichael Große    }
39472431326SMichael Große
39572431326SMichael Große    /**
3968a1a3846SAndreas Gohr     * Renames a tag
3978a1a3846SAndreas Gohr     *
3988a1a3846SAndreas Gohr     * @param string $formerTagName
3994227fca4SAnna Dabrowska     * @param string $newTagNames
4008a1a3846SAndreas Gohr     */
4014227fca4SAnna Dabrowska    public function renameTag($formerTagName, $newTagNames) {
402872edc7cSRené Corinth
4034227fca4SAnna Dabrowska        if (empty($formerTagName) || empty($newTagNames)) {
4048a1a3846SAndreas Gohr            msg($this->getLang("admin enter tag names"), -1);
4058a1a3846SAndreas Gohr            return;
406872edc7cSRené Corinth        }
407872edc7cSRené Corinth
408870d77ddSAnna Dabrowska        $keepFormerTag = false;
409870d77ddSAnna Dabrowska
4104227fca4SAnna Dabrowska        // enable splitting tags on rename
411870d77ddSAnna Dabrowska        $newTagNames = array_map(function ($tag) {
412870d77ddSAnna Dabrowska            return $this->cleanTag($tag);
413870d77ddSAnna Dabrowska        }, explode(',', $newTagNames));
4144227fca4SAnna Dabrowska
4154227fca4SAnna Dabrowska        $db = $this->getDB();
416872edc7cSRené Corinth
4174227fca4SAnna Dabrowska        // non-admins can rename only their own tags
4184227fca4SAnna Dabrowska        if (!auth_isadmin()) {
4194227fca4SAnna Dabrowska            $queryTagger =' AND tagger = ?';
4204227fca4SAnna Dabrowska            $tagger = $this->getUser();
4214227fca4SAnna Dabrowska        } else {
4224227fca4SAnna Dabrowska            $queryTagger = '';
4234227fca4SAnna Dabrowska            $tagger = '';
4244227fca4SAnna Dabrowska        }
4254227fca4SAnna Dabrowska
4260ec63874SAnna Dabrowska        $insertQuery = 'INSERT INTO taggings ';
4270ec63874SAnna Dabrowska        $insertQuery .= 'SELECT pid, ?, tagger, lang FROM taggings';
4280ec63874SAnna Dabrowska        $where = ' WHERE CLEANTAG(tag) = ?';
4290ec63874SAnna Dabrowska        $where .= ' AND GETACCESSLEVEL(pid) >= ' . AUTH_EDIT;
4300ec63874SAnna Dabrowska        $where .= $queryTagger;
4310ec63874SAnna Dabrowska
4320ec63874SAnna Dabrowska        $db->query('BEGIN TRANSACTION');
4330ec63874SAnna Dabrowska
4340ec63874SAnna Dabrowska        // insert new tags first
4350ec63874SAnna Dabrowska        foreach ($newTagNames as $newTag) {
436870d77ddSAnna Dabrowska            if ($newTag === $this->cleanTag($formerTagName)) {
437870d77ddSAnna Dabrowska                $keepFormerTag = true;
438870d77ddSAnna Dabrowska                continue;
439870d77ddSAnna Dabrowska            }
440870d77ddSAnna Dabrowska            $params = [$newTag, $this->cleanTag($formerTagName)];
4414227fca4SAnna Dabrowska            if ($tagger) array_push($params, $tagger);
4420ec63874SAnna Dabrowska            $res = $db->query($insertQuery . $where, $params);
4430ec63874SAnna Dabrowska            if ($res === false) {
4440ec63874SAnna Dabrowska                $db->query('ROLLBACK TRANSACTION');
4450ec63874SAnna Dabrowska                return;
4464227fca4SAnna Dabrowska            }
4470ec63874SAnna Dabrowska            $db->res_close($res);
4480ec63874SAnna Dabrowska        }
4490ec63874SAnna Dabrowska
450870d77ddSAnna Dabrowska        // finally delete the renamed tags
451870d77ddSAnna Dabrowska        if (!$keepFormerTag) {
4520ec63874SAnna Dabrowska            $deleteQuery = 'DELETE FROM taggings';
4530ec63874SAnna Dabrowska            $params = [$this->cleanTag($formerTagName)];
4540ec63874SAnna Dabrowska            if ($tagger) array_push($params, $tagger);
4550ec63874SAnna Dabrowska            if ($db->query($deleteQuery . $where, $params) === false) {
4560ec63874SAnna Dabrowska                $db->query('ROLLBACK TRANSACTION');
4570ec63874SAnna Dabrowska                return;
4580ec63874SAnna Dabrowska            }
459870d77ddSAnna Dabrowska        }
4600ec63874SAnna Dabrowska
4610ec63874SAnna Dabrowska        $db->query('COMMIT TRANSACTION');
462872edc7cSRené Corinth
463fb1d0583SAndreas Gohr        msg($this->getLang("admin renamed"), 1);
464ca455b8eSMichael Große
4658a1a3846SAndreas Gohr        return;
466872edc7cSRené Corinth    }
467872edc7cSRené Corinth
4688f630140SSzymon Olewniczak    /**
469dd52fd45SSzymon Olewniczak     * Rename or delete a tag for all users
470dd52fd45SSzymon Olewniczak     *
471dd52fd45SSzymon Olewniczak     * @param string $pid
472dd52fd45SSzymon Olewniczak     * @param string $formerTagName
473dd52fd45SSzymon Olewniczak     * @param string $newTagName
474dd52fd45SSzymon Olewniczak     *
475dd52fd45SSzymon Olewniczak     * @return array
476dd52fd45SSzymon Olewniczak     */
477dd52fd45SSzymon Olewniczak    public function modifyPageTag($pid, $formerTagName, $newTagName) {
478dd52fd45SSzymon Olewniczak
479dd52fd45SSzymon Olewniczak        $db = $this->getDb();
480dd52fd45SSzymon Olewniczak
48126f61833SAnna Dabrowska        $res = $db->query(
48226f61833SAnna Dabrowska            'SELECT pid FROM taggings WHERE CLEANTAG(tag) = ? AND pid = ?',
48326f61833SAnna Dabrowska            $this->cleanTag($formerTagName),
48426f61833SAnna Dabrowska            $pid
48526f61833SAnna Dabrowska        );
486dd52fd45SSzymon Olewniczak        $check = $db->res2arr($res);
487dd52fd45SSzymon Olewniczak
488dd52fd45SSzymon Olewniczak        if (empty($check)) {
489dd52fd45SSzymon Olewniczak            return array(true, $this->getLang('admin tag does not exists'));
490dd52fd45SSzymon Olewniczak        }
491dd52fd45SSzymon Olewniczak
492dd52fd45SSzymon Olewniczak        if (empty($newTagName)) {
49326f61833SAnna Dabrowska            $res = $db->query(
49426f61833SAnna Dabrowska                'DELETE FROM taggings WHERE pid = ? AND CLEANTAG(tag) = ?',
49526f61833SAnna Dabrowska                $pid,
49626f61833SAnna Dabrowska                $this->cleanTag($formerTagName)
49726f61833SAnna Dabrowska            );
498dd52fd45SSzymon Olewniczak        } else {
49926f61833SAnna Dabrowska            $res = $db->query(
50026f61833SAnna Dabrowska                'UPDATE taggings SET tag = ? WHERE pid = ? AND CLEANTAG(tag) = ?',
50126f61833SAnna Dabrowska                $newTagName,
50226f61833SAnna Dabrowska                $pid,
50326f61833SAnna Dabrowska                $this->cleanTag($formerTagName)
50426f61833SAnna Dabrowska            );
505dd52fd45SSzymon Olewniczak        }
506dd52fd45SSzymon Olewniczak        $db->res2arr($res);
507dd52fd45SSzymon Olewniczak
508dd52fd45SSzymon Olewniczak        return array(false, $this->getLang('admin renamed'));
509dd52fd45SSzymon Olewniczak    }
510dd52fd45SSzymon Olewniczak
511dd52fd45SSzymon Olewniczak    /**
5128f630140SSzymon Olewniczak     * Deletes a tag
5138f630140SSzymon Olewniczak     *
5148f630140SSzymon Olewniczak     * @param array  $tags
51531396860SSzymon Olewniczak     * @param string $namespace current namespace context as in getAllTags()
5168f630140SSzymon Olewniczak     */
51731396860SSzymon Olewniczak    public function deleteTags($tags, $namespace = '') {
518ca455b8eSMichael Große        if (empty($tags)) {
519ca455b8eSMichael Große            return;
520ca455b8eSMichael Große        }
5218f630140SSzymon Olewniczak
52231396860SSzymon Olewniczak        $namespace = cleanId($namespace);
52331396860SSzymon Olewniczak
5241f5991a7SMichael Große        $db = $this->getDB();
5258f630140SSzymon Olewniczak
526de379874SAnna Dabrowska        $queryBody = 'FROM taggings WHERE pid GLOB ? AND (' .
52731396860SSzymon Olewniczak            implode(' OR ', array_fill(0, count($tags), 'CLEANTAG(tag) = ?')) . ')';
52831396860SSzymon Olewniczak        $args = array_map(array($this, 'cleanTag'), $tags);
52931396860SSzymon Olewniczak        array_unshift($args, $this->globNamespace($namespace));
5308f630140SSzymon Olewniczak
5314227fca4SAnna Dabrowska        // non-admins can delete only their own tags
5324227fca4SAnna Dabrowska        if (!auth_isadmin()) {
5334227fca4SAnna Dabrowska            $queryBody .= ' AND tagger = ?';
5344227fca4SAnna Dabrowska            array_push($args, $this->getUser());
5354227fca4SAnna Dabrowska        }
536ca455b8eSMichael Große
5371f5991a7SMichael Große        $affectedPagesQuery= 'SELECT DISTINCT pid ' . $queryBody;
5381f5991a7SMichael Große        $resAffectedPages = $db->query($affectedPagesQuery, $args);
5391f5991a7SMichael Große        $numAffectedPages = count($resAffectedPages->fetchAll());
5401f5991a7SMichael Große
5411f5991a7SMichael Große        $deleteQuery = 'DELETE ' . $queryBody;
5421f5991a7SMichael Große        $db->query($deleteQuery, $args);
5431f5991a7SMichael Große
5441f5991a7SMichael Große        msg(sprintf($this->getLang("admin deleted"), count($tags), $numAffectedPages), 1);
5458f630140SSzymon Olewniczak    }
546cd08599fSAnna Dabrowska
547cd08599fSAnna Dabrowska    /**
548cd08599fSAnna Dabrowska     * Updates tags with a new page name
549cd08599fSAnna Dabrowska     *
550cd08599fSAnna Dabrowska     * @param string $oldName
551cd08599fSAnna Dabrowska     * @param string $newName
552cd08599fSAnna Dabrowska     */
553cd08599fSAnna Dabrowska    public function renamePage($oldName, $newName) {
554f6568bcbSAnna Dabrowska        $db = $this->getDB();
555cd08599fSAnna Dabrowska        $db->query('UPDATE taggings SET pid = ? WHERE pid = ?', $newName, $oldName);
556cd08599fSAnna Dabrowska    }
557972f6adfSAnna Dabrowska
558972f6adfSAnna Dabrowska    /**
5591b4b4fa9SAnna Dabrowska     * Extracts tags from search query
5601b4b4fa9SAnna Dabrowska     *
5611b4b4fa9SAnna Dabrowska     * @param array $parsedQuery
5621b4b4fa9SAnna Dabrowska     * @return array
5631b4b4fa9SAnna Dabrowska     */
5641b4b4fa9SAnna Dabrowska    public function getTags($parsedQuery)
5651b4b4fa9SAnna Dabrowska    {
5661b4b4fa9SAnna Dabrowska        $tags = [];
5671b4b4fa9SAnna Dabrowska        if (isset($parsedQuery['phrases'][0])) {
5681b4b4fa9SAnna Dabrowska            $tags = $parsedQuery['phrases'];
5691b4b4fa9SAnna Dabrowska        } elseif (isset($parsedQuery['and'][0])) {
5701b4b4fa9SAnna Dabrowska            $tags = $parsedQuery['and'];
5711b4b4fa9SAnna Dabrowska        } elseif (isset($parsedQuery['tag'])) {
5721b4b4fa9SAnna Dabrowska            // handle autocomplete call
5731b4b4fa9SAnna Dabrowska            $tags[] = $parsedQuery['tag'];
5741b4b4fa9SAnna Dabrowska        }
5751b4b4fa9SAnna Dabrowska        return $tags;
5761b4b4fa9SAnna Dabrowska    }
5771b4b4fa9SAnna Dabrowska
5781b4b4fa9SAnna Dabrowska    /**
5794a7da0a5SAnna Dabrowska     * Search for tagged pages
580972f6adfSAnna Dabrowska     *
5814a7da0a5SAnna Dabrowska     * @return array
582972f6adfSAnna Dabrowska     */
5834a7da0a5SAnna Dabrowska    public function searchPages()
584972f6adfSAnna Dabrowska    {
5851b4b4fa9SAnna Dabrowska        global $INPUT;
5861b4b4fa9SAnna Dabrowska        global $QUERY;
5874a7da0a5SAnna Dabrowska        $parsedQuery = ft_queryParser(new Doku_Indexer(), $QUERY);
588972f6adfSAnna Dabrowska
5891b4b4fa9SAnna Dabrowska        /** @var helper_plugin_tagging_querybuilder $queryBuilder */
59065d49a60SAnna Dabrowska        $queryBuilder = new \helper_plugin_tagging_querybuilder();
591972f6adfSAnna Dabrowska
5924a7da0a5SAnna Dabrowska        $queryBuilder->setField('pid');
5934a7da0a5SAnna Dabrowska        $queryBuilder->setTags($this->getTags($parsedQuery));
5944a7da0a5SAnna Dabrowska        $queryBuilder->setLogicalAnd($INPUT->str('taggings') === 'and');
5954a7da0a5SAnna Dabrowska        if (isset($parsedQuery['ns'])) $queryBuilder->includeNS($parsedQuery['ns']);
5964a7da0a5SAnna Dabrowska        if (isset($parsedQuery['notns'])) $queryBuilder->excludeNS($parsedQuery['notns']);
5974a7da0a5SAnna Dabrowska        if (isset($parsedQuery['tagger'])) $queryBuilder->setTagger($parsedQuery['tagger']);
5984a7da0a5SAnna Dabrowska        if (isset($parsedQuery['pid'])) $queryBuilder->setPid($parsedQuery['pid']);
599972f6adfSAnna Dabrowska
6004a7da0a5SAnna Dabrowska        return $this->queryDb($queryBuilder->getPages());
601972f6adfSAnna Dabrowska    }
602972f6adfSAnna Dabrowska
6031b4b4fa9SAnna Dabrowska    /**
6044227fca4SAnna Dabrowska     * Syntax to allow users to manage tags on regular pages, respects ACLs
6054227fca4SAnna Dabrowska     * @param string $ns
6064227fca4SAnna Dabrowska     * @return string
6074227fca4SAnna Dabrowska     */
6084227fca4SAnna Dabrowska    public function manageTags($ns)
6094227fca4SAnna Dabrowska    {
6104227fca4SAnna Dabrowska        global $INPUT;
6114227fca4SAnna Dabrowska
612f6568bcbSAnna Dabrowska        $this->setDefaultSort();
6134227fca4SAnna Dabrowska
6144227fca4SAnna Dabrowska        // initially set namespace filter to what is defined in syntax
6154227fca4SAnna Dabrowska        if ($ns && !$INPUT->has('tagging__filters')) {
6164227fca4SAnna Dabrowska            $INPUT->set('tagging__filters', ['ns' => $ns]);
6174227fca4SAnna Dabrowska        }
6184227fca4SAnna Dabrowska
6194227fca4SAnna Dabrowska        return $this->html_table();
6204227fca4SAnna Dabrowska    }
6214227fca4SAnna Dabrowska
6224227fca4SAnna Dabrowska    /**
623a2246f69SAnna Dabrowska     * HTML list of tagged pages
624a2246f69SAnna Dabrowska     *
625a2246f69SAnna Dabrowska     * @param string $tid
626a2246f69SAnna Dabrowska     * @return string
627a2246f69SAnna Dabrowska     */
628a2246f69SAnna Dabrowska    public function getPagesHtml($tid)
629a2246f69SAnna Dabrowska    {
630a2246f69SAnna Dabrowska        $html = '';
631a2246f69SAnna Dabrowska
632a2246f69SAnna Dabrowska        $db = $this->getDB();
633a2246f69SAnna Dabrowska        $sql = 'SELECT pid from taggings where tag = CLEANTAG(?)';
634a2246f69SAnna Dabrowska        $res =  $db->query($sql, $tid);
635a2246f69SAnna Dabrowska        $pages = $db->res2arr($res);
636a2246f69SAnna Dabrowska
637a2246f69SAnna Dabrowska        if ($pages) {
638a2246f69SAnna Dabrowska            $html .= '<ul>';
639a2246f69SAnna Dabrowska            foreach ($pages as $page) {
640a2246f69SAnna Dabrowska                $pid = $page['pid'];
641a2246f69SAnna Dabrowska                $html .= '<li><a href="' . wl($pid) . '" target="_blank">' . $pid . '</li>';
642a2246f69SAnna Dabrowska            }
643a2246f69SAnna Dabrowska            $html .= '</ul>';
644a2246f69SAnna Dabrowska        }
645a2246f69SAnna Dabrowska
646a2246f69SAnna Dabrowska        return $html;
647a2246f69SAnna Dabrowska    }
648a2246f69SAnna Dabrowska
649a2246f69SAnna Dabrowska    /**
65089ed97adSAnna Dabrowska     * Display tag management table
65189ed97adSAnna Dabrowska     */
65289ed97adSAnna Dabrowska    public function html_table() {
65389ed97adSAnna Dabrowska        global $ID, $INPUT;
65489ed97adSAnna Dabrowska
65589ed97adSAnna Dabrowska        $headers = array(
65689ed97adSAnna Dabrowska            array('value' => $this->getLang('admin tag'), 'sort_by' => 'tid'),
65789ed97adSAnna Dabrowska            array('value' => $this->getLang('admin occurrence'), 'sort_by' => 'count'),
65889ed97adSAnna Dabrowska            array('value' => $this->getLang('admin namespaces'), 'sort_by' => 'ns'),
65989ed97adSAnna Dabrowska            array('value' => $this->getLang('admin taggers'), 'sort_by' => 'taggers'),
66089ed97adSAnna Dabrowska            array('value' => $this->getLang('admin actions'), 'sort_by' => false),
66189ed97adSAnna Dabrowska        );
66289ed97adSAnna Dabrowska
663f6568bcbSAnna Dabrowska        $sort = explode(',', $this->getParam('sort'));
66489ed97adSAnna Dabrowska        $order_by = $sort[0];
66589ed97adSAnna Dabrowska        $desc = false;
66689ed97adSAnna Dabrowska        if (isset($sort[1]) && $sort[1] === 'desc') {
66789ed97adSAnna Dabrowska            $desc = true;
66889ed97adSAnna Dabrowska        }
66989ed97adSAnna Dabrowska        $filters = $INPUT->arr('tagging__filters');
67089ed97adSAnna Dabrowska
67189ed97adSAnna Dabrowska        $tags = $this->getAllTags($INPUT->str('filter'), $order_by, $desc, $filters);
67289ed97adSAnna Dabrowska
673a2246f69SAnna Dabrowska        $form = new \dokuwiki\Form\Form();
674a2246f69SAnna Dabrowska        // required in admin mode
67589ed97adSAnna Dabrowska        $form->setHiddenField('page', 'tagging');
67689ed97adSAnna Dabrowska        $form->setHiddenField('id', $ID);
677f6568bcbSAnna Dabrowska        $form->setHiddenField('[tagging]sort', $this->getParam('sort'));
67889ed97adSAnna Dabrowska
67989ed97adSAnna Dabrowska        /**
68089ed97adSAnna Dabrowska         * Actions dialog
68189ed97adSAnna Dabrowska         */
68289ed97adSAnna Dabrowska        $form->addTagOpen('div')->id('tagging__action-dialog')->attr('style', "display:none;");
68389ed97adSAnna Dabrowska        $form->addTagClose('div');
68489ed97adSAnna Dabrowska
68589ed97adSAnna Dabrowska        /**
68689ed97adSAnna Dabrowska         * Tag pages dialog
68789ed97adSAnna Dabrowska         */
68889ed97adSAnna Dabrowska        $form->addTagOpen('div')->id('tagging__taggedpages-dialog')->attr('style', "display:none;");
68989ed97adSAnna Dabrowska        $form->addTagClose('div');
69089ed97adSAnna Dabrowska
69189ed97adSAnna Dabrowska        /**
69289ed97adSAnna Dabrowska         * Tag management table
69389ed97adSAnna Dabrowska         */
69489ed97adSAnna Dabrowska        $form->addTagOpen('table')->addClass('inline plugin_tagging');
69589ed97adSAnna Dabrowska
696*a305ec34SAnna Dabrowska        $form->addHTML(
697*a305ec34SAnna Dabrowska            '<colgroup>
698*a305ec34SAnna Dabrowska                <col></col>
699*a305ec34SAnna Dabrowska                <col class="narrow-col"></col>
700*a305ec34SAnna Dabrowska                <col class="wide-col"></col>
701*a305ec34SAnna Dabrowska                <col></col>
702*a305ec34SAnna Dabrowska                <col class="narrow-col"></col>
703*a305ec34SAnna Dabrowska            </colgroup>'
704*a305ec34SAnna Dabrowska        );
705*a305ec34SAnna Dabrowska
70689ed97adSAnna Dabrowska        /**
70789ed97adSAnna Dabrowska         * Table headers
70889ed97adSAnna Dabrowska         */
70989ed97adSAnna Dabrowska        $form->addTagOpen('tr');
71089ed97adSAnna Dabrowska        foreach ($headers as $header) {
71189ed97adSAnna Dabrowska            $form->addTagOpen('th');
71289ed97adSAnna Dabrowska            if ($header['sort_by'] !== false) {
71389ed97adSAnna Dabrowska                $param = $header['sort_by'];
71489ed97adSAnna Dabrowska                $icon = 'arrow-both';
71589ed97adSAnna Dabrowska                $title = $this->getLang('admin sort ascending');
71689ed97adSAnna Dabrowska                if ($header['sort_by'] === $order_by) {
71789ed97adSAnna Dabrowska                    if ($desc === false) {
71889ed97adSAnna Dabrowska                        $icon = 'arrow-up';
71989ed97adSAnna Dabrowska                        $title = $this->getLang('admin sort descending');
72089ed97adSAnna Dabrowska                        $param .= ',desc';
72189ed97adSAnna Dabrowska                    } else {
72289ed97adSAnna Dabrowska                        $icon = 'arrow-down';
72389ed97adSAnna Dabrowska                    }
72489ed97adSAnna Dabrowska                }
72526f61833SAnna Dabrowska                $form->addButtonHTML(
726f6568bcbSAnna Dabrowska                    "tagging[sort]",
72726f61833SAnna Dabrowska                    $header['value'] . ' ' . inlineSVG(__DIR__ . "/images/$icon.svg"))
72889ed97adSAnna Dabrowska                    ->addClass('plugin_tagging sort_button')
729f6568bcbSAnna Dabrowska                    ->attr('title', $title)
730f6568bcbSAnna Dabrowska                    ->val($param);
73189ed97adSAnna Dabrowska            } else {
73289ed97adSAnna Dabrowska                $form->addHTML($header['value']);
73389ed97adSAnna Dabrowska            }
73489ed97adSAnna Dabrowska            $form->addTagClose('th');
73589ed97adSAnna Dabrowska        }
73689ed97adSAnna Dabrowska        $form->addTagClose('tr');
73789ed97adSAnna Dabrowska
73889ed97adSAnna Dabrowska        /**
73989ed97adSAnna Dabrowska         * Table filters for all sortable columns
74089ed97adSAnna Dabrowska         */
74189ed97adSAnna Dabrowska        $form->addTagOpen('tr');
74289ed97adSAnna Dabrowska        foreach ($headers as $header) {
74389ed97adSAnna Dabrowska            $form->addTagOpen('th');
74489ed97adSAnna Dabrowska            if ($header['sort_by'] !== false) {
74589ed97adSAnna Dabrowska                $field = $header['sort_by'];
7467c96ae87SAnna Dabrowska                $input = $form->addTextInput("tagging__filters[$field]");
747*a305ec34SAnna Dabrowska                $input->addClass('full-col');
74889ed97adSAnna Dabrowska            }
74989ed97adSAnna Dabrowska            $form->addTagClose('th');
75089ed97adSAnna Dabrowska        }
75189ed97adSAnna Dabrowska        $form->addTagClose('tr');
75289ed97adSAnna Dabrowska
75389ed97adSAnna Dabrowska
75489ed97adSAnna Dabrowska        foreach ($tags as $taginfo) {
75589ed97adSAnna Dabrowska            $tagname = $taginfo['tid'];
75689ed97adSAnna Dabrowska            $taggers = $taginfo['taggers'];
75789ed97adSAnna Dabrowska            $ns = $taginfo['ns'];
75889ed97adSAnna Dabrowska            $pids = explode(',',$taginfo['pids']);
75989ed97adSAnna Dabrowska
76089ed97adSAnna Dabrowska            $form->addTagOpen('tr');
76126f61833SAnna Dabrowska            $form->addHTML('<td>');
762a2246f69SAnna Dabrowska            $form->addHTML('<a class="tagslist" href="#" data-tid="' . $taginfo['tid'] . '">');
76326f61833SAnna Dabrowska            $form->addHTML( hsc($tagname) . '</a>');
76426f61833SAnna Dabrowska            $form->addHTML('</td>');
76589ed97adSAnna Dabrowska            $form->addHTML('<td>' . $taginfo['count'] . '</td>');
76689ed97adSAnna Dabrowska            $form->addHTML('<td>' . hsc($ns) . '</td>');
76789ed97adSAnna Dabrowska            $form->addHTML('<td>' . hsc($taggers) . '</td>');
76889ed97adSAnna Dabrowska
76989ed97adSAnna Dabrowska            /**
77089ed97adSAnna Dabrowska             * action buttons
77189ed97adSAnna Dabrowska             */
77289ed97adSAnna Dabrowska            $form->addHTML('<td>');
77389ed97adSAnna Dabrowska
77489ed97adSAnna Dabrowska            // check ACLs
77589ed97adSAnna Dabrowska            $userEdit = false;
77689ed97adSAnna Dabrowska            /** @var \helper_plugin_sqlite $sqliteHelper */
77789ed97adSAnna Dabrowska            $sqliteHelper = plugin_load('helper', 'sqlite');
77889ed97adSAnna Dabrowska            foreach ($pids as $pid) {
77989ed97adSAnna Dabrowska                if ($sqliteHelper->_getAccessLevel($pid) >= AUTH_EDIT) {
78089ed97adSAnna Dabrowska                    $userEdit = true;
78189ed97adSAnna Dabrowska                    continue;
78289ed97adSAnna Dabrowska                }
78389ed97adSAnna Dabrowska            }
78489ed97adSAnna Dabrowska
78589ed97adSAnna Dabrowska            if ($userEdit) {
78626f61833SAnna Dabrowska                $form->addButtonHTML(
787f6568bcbSAnna Dabrowska                    'tagging[actions][rename][' . $taginfo['tid'] . ']',
78826f61833SAnna Dabrowska                    inlineSVG(__DIR__ . '/images/edit.svg'))
78926f61833SAnna Dabrowska                    ->addClass('plugin_tagging action_button')
79026f61833SAnna Dabrowska                    ->attr('data-action', 'rename')
79126f61833SAnna Dabrowska                    ->attr('data-tid', $taginfo['tid']);
79226f61833SAnna Dabrowska                $form->addButtonHTML(
793f6568bcbSAnna Dabrowska                    'tagging[actions][delete][' . $taginfo['tid'] . ']',
79426f61833SAnna Dabrowska                    inlineSVG(__DIR__ . '/images/delete.svg'))
79526f61833SAnna Dabrowska                    ->addClass('plugin_tagging action_button')
79626f61833SAnna Dabrowska                    ->attr('data-action', 'delete')
79726f61833SAnna Dabrowska                    ->attr('data-tid', $taginfo['tid']);
79889ed97adSAnna Dabrowska            }
79989ed97adSAnna Dabrowska
80089ed97adSAnna Dabrowska            $form->addHTML('</td>');
80189ed97adSAnna Dabrowska            $form->addTagClose('tr');
80289ed97adSAnna Dabrowska        }
80389ed97adSAnna Dabrowska
80489ed97adSAnna Dabrowska        $form->addTagClose('table');
8050b033188SAnna Dabrowska        return '<div class="table">' . $form->toHTML() . '</div>';
80689ed97adSAnna Dabrowska    }
80789ed97adSAnna Dabrowska
80889ed97adSAnna Dabrowska    /**
809f6568bcbSAnna Dabrowska     * Returns all tagging parameters from the query string
810f6568bcbSAnna Dabrowska     *
811f6568bcbSAnna Dabrowska     * @return mixed
812f6568bcbSAnna Dabrowska     */
813f6568bcbSAnna Dabrowska    public function getParams()
814f6568bcbSAnna Dabrowska    {
815f6568bcbSAnna Dabrowska        global $INPUT;
816f6568bcbSAnna Dabrowska        return $INPUT->param('tagging', []);
817f6568bcbSAnna Dabrowska    }
818f6568bcbSAnna Dabrowska
819f6568bcbSAnna Dabrowska    /**
820f6568bcbSAnna Dabrowska     * Get a tagging parameter, empty string if not set
821f6568bcbSAnna Dabrowska     *
822f6568bcbSAnna Dabrowska     * @param string $name
823f6568bcbSAnna Dabrowska     * @return mixed
824f6568bcbSAnna Dabrowska     */
825f6568bcbSAnna Dabrowska    public function getParam($name)
826f6568bcbSAnna Dabrowska    {
827f6568bcbSAnna Dabrowska        $params = $this->getParams();
828f6568bcbSAnna Dabrowska        if ($params) {
829f6568bcbSAnna Dabrowska            return $params[$name] ?: '';
830f6568bcbSAnna Dabrowska        }
831f6568bcbSAnna Dabrowska    }
832f6568bcbSAnna Dabrowska
833f6568bcbSAnna Dabrowska    /**
834f6568bcbSAnna Dabrowska     * Sets a tagging parameter
835f6568bcbSAnna Dabrowska     *
836f6568bcbSAnna Dabrowska     * @param string $name
837f6568bcbSAnna Dabrowska     * @param string|array $value
838f6568bcbSAnna Dabrowska     */
839f6568bcbSAnna Dabrowska    public function setParam($name, $value)
840f6568bcbSAnna Dabrowska    {
841f6568bcbSAnna Dabrowska        global $INPUT;
842f6568bcbSAnna Dabrowska        $params = $this->getParams();
843f6568bcbSAnna Dabrowska        $params = array_merge($params, [$name => $value]);
844f6568bcbSAnna Dabrowska        $INPUT->set('tagging', $params);
845f6568bcbSAnna Dabrowska    }
846f6568bcbSAnna Dabrowska
847f6568bcbSAnna Dabrowska    /**
848f6568bcbSAnna Dabrowska     * Default sorting by tag id
849f6568bcbSAnna Dabrowska     */
850f6568bcbSAnna Dabrowska    public function setDefaultSort()
851f6568bcbSAnna Dabrowska    {
852f6568bcbSAnna Dabrowska        if (!$this->getParam('sort')) {
853f6568bcbSAnna Dabrowska            $this->setParam('sort', 'tid');
854f6568bcbSAnna Dabrowska        }
855f6568bcbSAnna Dabrowska    }
856f6568bcbSAnna Dabrowska
857f6568bcbSAnna Dabrowska    /**
8584a7da0a5SAnna Dabrowska     * Executes the query and returns the results as array
8591b4b4fa9SAnna Dabrowska     *
86099122157SAnna Dabrowska     * @param array $query
8611b4b4fa9SAnna Dabrowska     * @return array
8621b4b4fa9SAnna Dabrowska     */
8634a7da0a5SAnna Dabrowska    protected function queryDb($query)
8641b4b4fa9SAnna Dabrowska    {
8654a7da0a5SAnna Dabrowska        $db = $this->getDB();
8664a7da0a5SAnna Dabrowska        if (!$db) {
8674a7da0a5SAnna Dabrowska            return [];
868972f6adfSAnna Dabrowska        }
8694a7da0a5SAnna Dabrowska
87099122157SAnna Dabrowska        $res = $db->query($query[0], $query[1]);
8714a7da0a5SAnna Dabrowska        $res = $db->res2arr($res);
8724a7da0a5SAnna Dabrowska
8734a7da0a5SAnna Dabrowska        $ret = [];
8744a7da0a5SAnna Dabrowska        foreach ($res as $row) {
8754a7da0a5SAnna Dabrowska            $ret[$row['item']] = $row['cnt'];
8764a7da0a5SAnna Dabrowska        }
8774a7da0a5SAnna Dabrowska        return $ret;
878972f6adfSAnna Dabrowska    }
87940b94b1aSAnna Dabrowska
88040b94b1aSAnna Dabrowska    /**
88140b94b1aSAnna Dabrowska     * Construct the HAVING part of the search query
88240b94b1aSAnna Dabrowska     *
88340b94b1aSAnna Dabrowska     * @param array $filters
88440b94b1aSAnna Dabrowska     * @return array
88540b94b1aSAnna Dabrowska     */
88640b94b1aSAnna Dabrowska    protected function getFilterSql($filters)
88740b94b1aSAnna Dabrowska    {
88840b94b1aSAnna Dabrowska        $having = '';
88940b94b1aSAnna Dabrowska        $parts = [];
89040b94b1aSAnna Dabrowska        $params = [];
89140b94b1aSAnna Dabrowska        $filters = array_filter($filters);
89240b94b1aSAnna Dabrowska        if (!empty($filters)) {
89340b94b1aSAnna Dabrowska            $having = ' HAVING ';
89440b94b1aSAnna Dabrowska            foreach ($filters as $filter => $value) {
89540b94b1aSAnna Dabrowska                $parts[] = " $filter LIKE ? ";
89640b94b1aSAnna Dabrowska                $params[] = "%$value%";
89740b94b1aSAnna Dabrowska            }
89840b94b1aSAnna Dabrowska            $having .= implode(' AND ', $parts);
89940b94b1aSAnna Dabrowska        }
90040b94b1aSAnna Dabrowska        return [$having, $params];
90140b94b1aSAnna Dabrowska    }
902cd08599fSAnna Dabrowska}
903