xref: /plugin/tagging/helper.php (revision 40b94b1a49a528b6db3485e7197fc18d573e1f94) 
1<?php
2/**
3 * Tagging Plugin (hlper component)
4 *
5 * @license GPL 2
6 */
7class helper_plugin_tagging extends DokuWiki_Plugin {
8
9    /**
10     * Gives access to the database
11     *
12     * Initializes the SQLite helper and register the CLEANTAG function
13     *
14     * @return helper_plugin_sqlite|bool false if initialization fails
15     */
16    public function getDB() {
17        static $db = null;
18        if ($db !== null) {
19            return $db;
20        }
21
22        /** @var helper_plugin_sqlite $db */
23        $db = plugin_load('helper', 'sqlite');
24        if ($db === null) {
25            msg('The tagging plugin needs the sqlite plugin', -1);
26
27            return false;
28        }
29        $db->init('tagging', __DIR__ . '/db/');
30        $db->create_function('CLEANTAG', array($this, 'cleanTag'), 1);
31        $db->create_function('GROUP_SORT',
32            function ($group, $newDelimiter) {
33                $ex = array_filter(explode(',', $group));
34                sort($ex);
35
36                return implode($newDelimiter, $ex);
37            }, 2);
38        $db->create_function('GET_NS', 'getNS', 1);
39
40        return $db;
41    }
42
43    /**
44     * Return the user to use for accessing tags
45     *
46     * Handles the singleuser mode by returning 'auto' as user. Returnes false when no user is logged in.
47     *
48     * @return bool|string
49     */
50    public function getUser() {
51        if (!isset($_SERVER['REMOTE_USER'])) {
52            return false;
53        }
54        if ($this->getConf('singleusermode')) {
55            return 'auto';
56        }
57
58        return $_SERVER['REMOTE_USER'];
59    }
60
61    /**
62     * Canonicalizes the tag to its lower case nospace form
63     *
64     * @param $tag
65     *
66     * @return string
67     */
68    public function cleanTag($tag) {
69        $tag = str_replace(array(' ', '-', '_'), '', $tag);
70        $tag = utf8_strtolower($tag);
71
72        return $tag;
73    }
74
75    /**
76     * Canonicalizes the namespace, remove the first colon and add glob
77     *
78     * @param $namespace
79     *
80     * @return string
81     */
82    public function globNamespace($namespace) {
83        return cleanId($namespace) . '*';
84    }
85
86    /**
87     * Create or Update tags of a page
88     *
89     * Uses the translation plugin to store the language of a page (if available)
90     *
91     * @param string $id The page ID
92     * @param string $user
93     * @param array  $tags
94     *
95     * @return bool|SQLiteResult
96     */
97    public function replaceTags($id, $user, $tags) {
98        global $conf;
99        /** @var helper_plugin_translation $trans */
100        $trans = plugin_load('helper', 'translation');
101        if ($trans) {
102            $lang = $trans->realLC($trans->getLangPart($id));
103        } else {
104            $lang = $conf['lang'];
105        }
106
107        $db = $this->getDB();
108        $db->query('BEGIN TRANSACTION');
109        $queries = array(array('DELETE FROM taggings WHERE pid = ? AND tagger = ?', $id, $user));
110        foreach ($tags as $tag) {
111            $queries[] = array('INSERT INTO taggings (pid, tagger, tag, lang) VALUES(?, ?, ?, ?)', $id, $user, $tag, $lang);
112        }
113
114        foreach ($queries as $query) {
115            if (!call_user_func_array(array($db, 'query'), $query)) {
116                $db->query('ROLLBACK TRANSACTION');
117
118                return false;
119            }
120        }
121
122        return $db->query('COMMIT TRANSACTION');
123    }
124
125    /**
126     * Get a list of Tags or Pages matching search criteria
127     *
128     * @param array  $filter What to search for array('field' => 'searchterm')
129     * @param string $type   What field to return 'tag'|'pid'
130     * @param int    $limit  Limit to this many results, 0 for all
131     *
132     * @return array associative array in form of value => count
133     */
134    public function findItems($filter, $type, $limit = 0) {
135
136        global $INPUT;
137
138        /** @var helper_plugin_tagging_querybuilder $queryBuilder */
139        $queryBuilder = new \helper_plugin_tagging_querybuilder();
140
141        $queryBuilder->setField($type);
142        $queryBuilder->setLimit($limit);
143        $queryBuilder->setTags($this->getTags($filter));
144        if (isset($filter['ns'])) $queryBuilder->includeNS($filter['ns']);
145        if (isset($filter['notns'])) $queryBuilder->excludeNS($filter['notns']);
146        if (isset($filter['tagger'])) $queryBuilder->setTagger($filter['tagger']);
147        if (isset($filter['pid'])) $queryBuilder->setPid($filter['pid']);
148
149        return $this->queryDb($queryBuilder->getQuery());
150
151    }
152
153    /**
154     * Constructs the URL to search for a tag
155     *
156     * @param string $tag
157     * @param string $ns
158     *
159     * @return string
160     */
161    public function getTagSearchURL($tag, $ns = '') {
162        // wrap tag in quotes if non clean
163        $ctag = utf8_stripspecials($this->cleanTag($tag));
164        if ($ctag != utf8_strtolower($tag)) {
165            $tag = '"' . $tag . '"';
166        }
167
168        $ret = '?do=search&sf=1&id=' . rawurlencode($tag);
169        if ($ns) {
170            $ret .= rawurlencode(' @' . $ns);
171        }
172
173        return $ret;
174    }
175
176    /**
177     * Calculates the size levels for the given list of clouds
178     *
179     * Automatically determines sensible tresholds
180     *
181     * @param array $tags list of tags => count
182     * @param int   $levels
183     *
184     * @return mixed
185     */
186    public function cloudData($tags, $levels = 10) {
187        $min = min($tags);
188        $max = max($tags);
189
190        // calculate tresholds
191        $tresholds = array();
192        for ($i = 0; $i <= $levels; $i++) {
193            $tresholds[$i] = pow($max - $min + 1, $i / $levels) + $min - 1;
194        }
195
196        // assign weights
197        foreach ($tags as $tag => $cnt) {
198            foreach ($tresholds as $tresh => $val) {
199                if ($cnt <= $val) {
200                    $tags[$tag] = $tresh;
201                    break;
202                }
203                $tags[$tag] = $levels;
204            }
205        }
206
207        return $tags;
208    }
209
210    /**
211     * Display a tag cloud
212     *
213     * @param array    $tags   list of tags => count
214     * @param string   $type   'tag'
215     * @param Callable $func   The function to print the link (gets tag and ns)
216     * @param bool     $wrap   wrap cloud in UL tags?
217     * @param bool     $return returnn HTML instead of printing?
218     * @param string   $ns     Add this namespace to search links
219     *
220     * @return string
221     */
222    public function html_cloud($tags, $type, $func, $wrap = true, $return = false, $ns = '') {
223        global $INFO;
224
225        $hidden_str = $this->getConf('hiddenprefix');
226        $hidden_len = strlen($hidden_str);
227
228        $ret = '';
229        if ($wrap) {
230            $ret .= '<ul class="tagging_cloud clearfix">';
231        }
232        if (count($tags) === 0) {
233            // Produce valid XHTML (ul needs a child)
234            $this->setupLocale();
235            $ret .= '<li><div class="li">' . $this->lang['js']['no' . $type . 's'] . '</div></li>';
236        } else {
237            $tags = $this->cloudData($tags);
238            foreach ($tags as $val => $size) {
239                // skip hidden tags for users that can't edit
240                if ($type === 'tag' and
241                    $hidden_len and
242                    substr($val, 0, $hidden_len) == $hidden_str and
243                    !($this->getUser() && $INFO['writable'])
244                ) {
245                    continue;
246                }
247
248                $ret .= '<li class="t' . $size . '"><div class="li">';
249                $ret .= call_user_func($func, $val, $ns);
250                $ret .= '</div></li>';
251            }
252        }
253        if ($wrap) {
254            $ret .= '</ul>';
255        }
256        if ($return) {
257            return $ret;
258        }
259        echo $ret;
260
261        return '';
262    }
263
264    /**
265     * Get the link to a search for the given tag
266     *
267     * @param string $tag search for this tag
268     * @param string $ns  limit search to this namespace
269     *
270     * @return string
271     */
272    protected function linkToSearch($tag, $ns = '') {
273        return '<a href="' . hsc($this->getTagSearchURL($tag, $ns)) . '">' . $tag . '</a>';
274    }
275
276    /**
277     * Display the Tags for the current page and prepare the tag editing form
278     *
279     * @param bool $print Should the HTML be printed or returned?
280     *
281     * @return string
282     */
283    public function tpl_tags($print = true) {
284        global $INFO;
285        global $lang;
286
287        $filter = array('pid' => $INFO['id']);
288        if ($this->getConf('singleusermode')) {
289            $filter['tagger'] = 'auto';
290        }
291
292        $tags = $this->findItems($filter, 'tag');
293
294        $ret = '';
295
296        $ret .= '<div class="plugin_tagging_edit">';
297        $ret .= $this->html_cloud($tags, 'tag', array($this, 'linkToSearch'), true, true);
298
299        if ($this->getUser() && $INFO['writable']) {
300            $lang['btn_tagging_edit'] = $lang['btn_secedit'];
301            $ret .= '<div id="tagging__edit_buttons_group">';
302            $ret .= html_btn('tagging_edit', $INFO['id'], '', array());
303            if (auth_isadmin()) {
304                $ret .= '<label>' . $this->getLang('toggle admin mode') . '<input type="checkbox" id="tagging__edit_toggle_admin" /></label>';
305            }
306            $ret .= '</div>';
307            $form = new dokuwiki\Form\Form();
308            $form->id('tagging__edit');
309            $form->setHiddenField('tagging[id]', $INFO['id']);
310            $form->setHiddenField('call', 'plugin_tagging_save');
311            $tags = $this->findItems(array(
312                'pid'    => $INFO['id'],
313                'tagger' => $this->getUser(),
314            ), 'tag');
315            $form->addTextarea('tagging[tags]')->val(implode(', ', array_keys($tags)))->addClass('edit')->attr('rows', 4);
316            $form->addButton('', $lang['btn_save'])->id('tagging__edit_save');
317            $form->addButton('', $lang['btn_cancel'])->id('tagging__edit_cancel');
318            $ret .= $form->toHTML();
319        }
320        $ret .= '</div>';
321
322        if ($print) {
323            echo $ret;
324        }
325
326        return $ret;
327    }
328
329    /**
330     * @param string $namespace empty for entire wiki
331     *
332     * @param string $order_by
333     * @param bool $desc
334     * @param array $filters
335     * @return array
336     */
337    public function getAllTags($namespace = '', $order_by = 'tag', $desc = false, $filters = []) {
338        $order_fields = array('pid', 'tid', 'orig', 'taggers', 'ns', 'count');
339        if (!in_array($order_by, $order_fields)) {
340            msg('cannot sort by ' . $order_by . ' field does not exists', -1);
341            $order_by = 'tag';
342        }
343
344        list($having, $params) = $this->getFilterSql($filters);
345
346        $db = $this->getDb();
347
348        $query = 'SELECT    "pid",
349                            CLEANTAG("tag") AS "tid",
350                            GROUP_SORT(GROUP_CONCAT("tag"), \', \') AS "orig",
351                            GROUP_SORT(GROUP_CONCAT("tagger"), \', \') AS "taggers",
352                            GROUP_SORT(GROUP_CONCAT(GET_NS("pid")), \', \') AS "ns",
353                            COUNT(*) AS "count"
354                        FROM "taggings"
355                        WHERE "pid" GLOB ?
356                        GROUP BY "tid"';
357        $query .= $having;
358        $query .=      'ORDER BY ' . $order_by;
359        if ($desc) {
360            $query .= ' DESC';
361        }
362
363        array_unshift($params, $this->globNamespace($namespace));
364        $res = $db->query($query, $params);
365
366        return $db->res2arr($res);
367    }
368
369    /**
370     * Get all pages with tags and their tags
371     *
372     * @return array ['pid' => ['tag1','tag2','tag3']]
373     */
374    public function getAllTagsByPage() {
375        $query = '
376        SELECT pid, GROUP_CONCAT(tag) AS tags
377        FROM taggings
378        GROUP BY pid
379        ';
380        $db = $this->getDb();
381        $res = $db->query($query);
382        return array_map(
383            function ($i) {
384                return explode(',', $i);
385            },
386            array_column($db->res2arr($res), 'tags', 'pid')
387        );
388    }
389
390    /**
391     * Renames a tag
392     *
393     * @param string $formerTagName
394     * @param string $newTagName
395     */
396    public function renameTag($formerTagName, $newTagName) {
397
398        if (empty($formerTagName) || empty($newTagName)) {
399            msg($this->getLang("admin enter tag names"), -1);
400
401            return;
402        }
403
404        $db = $this->getDb();
405
406        $res = $db->query('SELECT pid FROM taggings WHERE CLEANTAG(tag) = ?', $this->cleanTag($formerTagName));
407        $check = $db->res2arr($res);
408
409        if (empty($check)) {
410            msg($this->getLang("admin tag does not exists"), -1);
411
412            return;
413        }
414
415        $res = $db->query("UPDATE taggings SET tag = ? WHERE CLEANTAG(tag) = ?", $newTagName, $this->cleanTag($formerTagName));
416        $db->res2arr($res);
417
418        msg($this->getLang("admin renamed"), 1);
419
420        return;
421    }
422
423    /**
424     * Rename or delete a tag for all users
425     *
426     * @param string $pid
427     * @param string $formerTagName
428     * @param string $newTagName
429     *
430     * @return array
431     */
432    public function modifyPageTag($pid, $formerTagName, $newTagName) {
433
434        $db = $this->getDb();
435
436        $res = $db->query('SELECT pid FROM taggings WHERE CLEANTAG(tag) = ? AND pid = ?', $this->cleanTag($formerTagName), $pid);
437        $check = $db->res2arr($res);
438
439        if (empty($check)) {
440            return array(true, $this->getLang('admin tag does not exists'));
441        }
442
443        if (empty($newTagName)) {
444            $res = $db->query('DELETE FROM taggings WHERE pid = ? AND CLEANTAG(tag) = ?', $pid, $this->cleanTag($formerTagName));
445        } else {
446            $res = $db->query('UPDATE taggings SET tag = ? WHERE pid = ? AND CLEANTAG(tag) = ?', $newTagName, $pid, $this->cleanTag($formerTagName));
447        }
448        $db->res2arr($res);
449
450        return array(false, $this->getLang('admin renamed'));
451    }
452
453    /**
454     * Deletes a tag
455     *
456     * @param array  $tags
457     * @param string $namespace current namespace context as in getAllTags()
458     */
459    public function deleteTags($tags, $namespace = '') {
460        if (empty($tags)) {
461            return;
462        }
463
464        $namespace = cleanId($namespace);
465
466        $db = $this->getDB();
467
468        $queryBody = 'FROM taggings WHERE pid GLOB ? AND (' .
469            implode(' OR ', array_fill(0, count($tags), 'CLEANTAG(tag) = ?')) . ')';
470        $args = array_map(array($this, 'cleanTag'), $tags);
471        array_unshift($args, $this->globNamespace($namespace));
472
473
474        $affectedPagesQuery= 'SELECT DISTINCT pid ' . $queryBody;
475        $resAffectedPages = $db->query($affectedPagesQuery, $args);
476        $numAffectedPages = count($resAffectedPages->fetchAll());
477
478        $deleteQuery = 'DELETE ' . $queryBody;
479        $db->query($deleteQuery, $args);
480
481        msg(sprintf($this->getLang("admin deleted"), count($tags), $numAffectedPages), 1);
482    }
483
484    /**
485     * Updates tags with a new page name
486     *
487     * @param string $oldName
488     * @param string $newName
489     */
490    public function renamePage($oldName, $newName) {
491        $db = $this->getDb();
492        $db->query('UPDATE taggings SET pid = ? WHERE pid = ?', $newName, $oldName);
493    }
494
495    /**
496     * Extracts tags from search query
497     *
498     * @param array $parsedQuery
499     * @return array
500     */
501    public function getTags($parsedQuery)
502    {
503        $tags = [];
504        if (isset($parsedQuery['phrases'][0])) {
505            $tags = $parsedQuery['phrases'];
506        } elseif (isset($parsedQuery['and'][0])) {
507            $tags = $parsedQuery['and'];
508        } elseif (isset($parsedQuery['tag'])) {
509            // handle autocomplete call
510            $tags[] = $parsedQuery['tag'];
511        }
512        return $tags;
513    }
514
515    /**
516     * Search for tagged pages
517     *
518     * @return array
519     */
520    public function searchPages()
521    {
522        global $INPUT;
523        global $QUERY;
524        $parsedQuery = ft_queryParser(new Doku_Indexer(), $QUERY);
525
526        /** @var helper_plugin_tagging_querybuilder $queryBuilder */
527        $queryBuilder = new \helper_plugin_tagging_querybuilder();
528
529        $queryBuilder->setField('pid');
530        $queryBuilder->setTags($this->getTags($parsedQuery));
531        $queryBuilder->setLogicalAnd($INPUT->str('taggings') === 'and');
532        if (isset($parsedQuery['ns'])) $queryBuilder->includeNS($parsedQuery['ns']);
533        if (isset($parsedQuery['notns'])) $queryBuilder->excludeNS($parsedQuery['notns']);
534        if (isset($parsedQuery['tagger'])) $queryBuilder->setTagger($parsedQuery['tagger']);
535        if (isset($parsedQuery['pid'])) $queryBuilder->setPid($parsedQuery['pid']);
536
537        return $this->queryDb($queryBuilder->getPages());
538    }
539
540    /**
541     * Executes the query and returns the results as array
542     *
543     * @param array $query
544     * @return array
545     */
546    protected function queryDb($query)
547    {
548        $db = $this->getDB();
549        if (!$db) {
550            return [];
551        }
552
553        $res = $db->query($query[0], $query[1]);
554        $res = $db->res2arr($res);
555
556        $ret = [];
557        foreach ($res as $row) {
558            $ret[$row['item']] = $row['cnt'];
559        }
560        return $ret;
561    }
562
563    /**
564     * Construct the HAVING part of the search query
565     *
566     * @param array $filters
567     * @return array
568     */
569    protected function getFilterSql($filters)
570    {
571        $having = '';
572        $parts = [];
573        $params = [];
574        $filters = array_filter($filters);
575        if (!empty($filters)) {
576            $having = ' HAVING ';
577            foreach ($filters as $filter => $value) {
578                $parts[] = " $filter LIKE ? ";
579                $params[] = "%$value%";
580            }
581            $having .= implode(' AND ', $parts);
582        }
583        return [$having, $params];
584    }
585}
586