xref: /plugin/tagging/helper.php (revision 872edc7c1b32bb32232f134b139fef365b1e3ad1)
1f61105deSAdrian Lang<?php
2f61105deSAdrian Lang
3f61105deSAdrian Langif(!defined('DOKU_INC')) die();
4e4543b6dSAdrian Langclass helper_plugin_tagging extends DokuWiki_Plugin {
5f61105deSAdrian Lang
6f61105deSAdrian Lang    private function getDB() {
7f61105deSAdrian Lang        static $db;
8f61105deSAdrian Lang        if (!is_null($db)) {
9f61105deSAdrian Lang            return $db;
10f61105deSAdrian Lang        }
11f61105deSAdrian Lang
12f61105deSAdrian Lang        $db = plugin_load('helper', 'sqlite');
13f61105deSAdrian Lang        if (is_null($db)) {
14f61105deSAdrian Lang            msg('The tagging plugin needs the sqlite plugin', -1);
15f61105deSAdrian Lang            return false;
16f61105deSAdrian Lang        }
17f61105deSAdrian Lang        if($db->init('tagging',dirname(__FILE__).'/db/')){
18f61105deSAdrian Lang            return $db;
19f61105deSAdrian Lang        }
20f61105deSAdrian Lang        return false;
21f61105deSAdrian Lang    }
22f61105deSAdrian Lang
23f61105deSAdrian Lang    public function replaceTags($id, $user, $tags) {
24f61105deSAdrian Lang        $db = $this->getDB();
25f61105deSAdrian Lang        $db->query('BEGIN TRANSACTION');
26f61105deSAdrian Lang        $queries = array(array('DELETE FROM taggings WHERE pid = ? AND tagger = ?', $id, $user));
27f61105deSAdrian Lang        foreach ($tags as $tag) {
28f61105deSAdrian Lang            $queries[] = array('INSERT INTO taggings (pid, tagger, tag) VALUES(?, ?, ?)', $id, $user, $tag);
29f61105deSAdrian Lang        }
30f61105deSAdrian Lang
31f61105deSAdrian Lang        foreach ($queries as $query) {
32f61105deSAdrian Lang            if (!call_user_func_array(array($db, 'query'), $query)) {
33f61105deSAdrian Lang                $db->query('ROLLBACK TRANSACTION');
34f61105deSAdrian Lang                return false;
35f61105deSAdrian Lang            }
36f61105deSAdrian Lang        }
37f61105deSAdrian Lang        return $db->query('COMMIT TRANSACTION');
38f61105deSAdrian Lang    }
39f61105deSAdrian Lang
40f61105deSAdrian Lang    public function getTags($search, $return) {
41f61105deSAdrian Lang        $where = '1=1';
42f61105deSAdrian Lang        foreach($search as $k => $v) {
43b2073787SDominik Eckelmann            if ($k === 'tag') {
44b2073787SDominik Eckelmann                $k = 'UPPER(tag)';
45b2073787SDominik Eckelmann            }
46b2073787SDominik Eckelmann
47b2073787SDominik Eckelmann            if ($this->useLike($v)) {
48b2073787SDominik Eckelmann                $where .= " AND $k LIKE";
49f61105deSAdrian Lang            } else {
50b2073787SDominik Eckelmann                $where .= " AND $k =";
51b2073787SDominik Eckelmann            }
52b2073787SDominik Eckelmann
53b2073787SDominik Eckelmann            if ($k === 'UPPER(tag)') {
54b2073787SDominik Eckelmann                $where .= ' UPPER(?)';
55b2073787SDominik Eckelmann            } else {
56b2073787SDominik Eckelmann                $where .= ' ?';
57f61105deSAdrian Lang            }
58f61105deSAdrian Lang        }
59b2073787SDominik Eckelmann
60f61105deSAdrian Lang        $db = $this->getDB();
61f61105deSAdrian Lang        $res = $db->query('SELECT ' . $return . ', COUNT(*) ' .
620dbdc3fcSAdrian Lang                          'FROM taggings WHERE ' . $where . ' GROUP BY ' . $return .
630dbdc3fcSAdrian Lang                          ' ORDER BY tag',
64f61105deSAdrian Lang                          array_values($search));
65f61105deSAdrian Lang
66f61105deSAdrian Lang        $res = $db->res2arr($res);
67f61105deSAdrian Lang        $ret = array();
68f61105deSAdrian Lang        foreach ($res as $v) {
69f61105deSAdrian Lang            $ret[$v[$return]] = $v['COUNT(*)'];
70f61105deSAdrian Lang        }
71f61105deSAdrian Lang        return $ret;
72f61105deSAdrian Lang    }
73f61105deSAdrian Lang
74b2073787SDominik Eckelmann    private function useLike($v) {
75b2073787SDominik Eckelmann        return strpos($v, '%') === 0 || strrpos($v, '%') === strlen($v) - 1;
76b2073787SDominik Eckelmann    }
77b2073787SDominik Eckelmann
78f61105deSAdrian Lang    public function getTagSearchURL($tag) {
79f61105deSAdrian Lang        return '?do=search&id=' . $tag . '#' .
80f61105deSAdrian Lang               str_replace(' ', '_', strtolower($this->getLang('search_section_title')));
81f61105deSAdrian Lang    }
82f61105deSAdrian Lang
83f61105deSAdrian Lang    public function cloudData($tags, $levels = 10) {
84f61105deSAdrian Lang        $min = min($tags);
85f61105deSAdrian Lang        $max = max($tags);
86f61105deSAdrian Lang
87f61105deSAdrian Lang        // calculate tresholds
88f61105deSAdrian Lang        $tresholds = array();
89f61105deSAdrian Lang        for($i=0; $i<=$levels; $i++){
90f61105deSAdrian Lang            $tresholds[$i] = pow($max - $min + 1, $i/$levels) + $min - 1;
91f61105deSAdrian Lang        }
92f61105deSAdrian Lang
93f61105deSAdrian Lang        // assign weights
94f61105deSAdrian Lang        foreach($tags as $tag => $cnt){
95f61105deSAdrian Lang            foreach($tresholds as $tresh => $val){
96f61105deSAdrian Lang                if($cnt <= $val){
97f61105deSAdrian Lang                    $tags[$tag] = $tresh;
98f61105deSAdrian Lang                    break;
99f61105deSAdrian Lang                }
100f61105deSAdrian Lang                $tags[$tag] = $levels;
101f61105deSAdrian Lang            }
102f61105deSAdrian Lang        }
103f61105deSAdrian Lang        return $tags;
104f61105deSAdrian Lang    }
105f61105deSAdrian Lang
106f61105deSAdrian Lang    public function html_cloud($tags, $type, $func, $wrap = true, $return = false) {
107f61105deSAdrian Lang        $ret = '';
1080dbdc3fcSAdrian Lang        if ($wrap) $ret .= '<ul class="tagging_cloud clearfix">';
109f61105deSAdrian Lang        if (count($tags) === 0) {
110f61105deSAdrian Lang            // Produce valid XHTML (ul needs a child)
111f61105deSAdrian Lang            $this->setupLocale();
112f61105deSAdrian Lang            $ret .= '<li><div class="li">' . $this->lang['js']['no' . $type . 's'] . '</div></li>';
113f61105deSAdrian Lang        } else {
114f61105deSAdrian Lang            $tags = $this->cloudData($tags);
115f61105deSAdrian Lang            foreach ($tags as $val => $size) {
116f61105deSAdrian Lang                $ret .= '<li class="t' . $size . '"><div class="li">';
117f61105deSAdrian Lang                $ret .= call_user_func($func, $val);
118f61105deSAdrian Lang                $ret .= '</div></li>';
119f61105deSAdrian Lang            }
120f61105deSAdrian Lang        }
121f61105deSAdrian Lang        if ($wrap) $ret .= '</ul>';
122f61105deSAdrian Lang        if ($return) return $ret;
123f61105deSAdrian Lang        echo $ret;
124f61105deSAdrian Lang    }
125f61105deSAdrian Lang
126f61105deSAdrian Lang    private function linkToSearch($tag) {
127f61105deSAdrian Lang        return '<a href="' . hsc($this->getTagSearchURL($tag)) . '">' .
128f61105deSAdrian Lang               $tag . '</a>';
129f61105deSAdrian Lang    }
130f61105deSAdrian Lang
131f61105deSAdrian Lang    public function tpl_tags() {
132f61105deSAdrian Lang        global $ID;
133f61105deSAdrian Lang        global $INFO;
134f61105deSAdrian Lang        global $lang;
135f61105deSAdrian Lang        $tags = $this->getTags(array('pid' => $ID), 'tag');
136f61105deSAdrian Lang        $this->html_cloud($tags, 'tag', array($this, 'linkToSearch'));
137f61105deSAdrian Lang
138f61105deSAdrian Lang        if (isset($_SERVER['REMOTE_USER']) && $INFO['writable']) {
139f61105deSAdrian Lang            $lang['btn_tagging_edit'] = $lang['btn_secedit'];
140f61105deSAdrian Lang            echo html_btn('tagging_edit', $ID, '', array());
141f61105deSAdrian Lang            $form = new Doku_Form(array('id' => 'tagging_edit', 'style' => 'display: none;'));
142e4543b6dSAdrian Lang            $form->addHidden('tagging[id]', $ID);
143e4543b6dSAdrian Lang            $form->addElement(form_makeTextField('tagging[tags]', implode(', ', array_keys($this->getTags(array('pid' => $ID, 'tagger' => $_SERVER['REMOTE_USER']), 'tag')))));
144f61105deSAdrian Lang            $form->addElement(form_makeButton('submit', 'save', $lang['btn_save'], array('id' => 'tagging_edit_save')));
145f61105deSAdrian Lang            $form->addElement(form_makeButton('submit', 'cancel', $lang['btn_cancel'], array('id' => 'tagging_edit_cancel')));
146f61105deSAdrian Lang            $form->printForm();
147f61105deSAdrian Lang        }
148f61105deSAdrian Lang    }
149*872edc7cSRené Corinth
150*872edc7cSRené Corinth    public function getAllTags(){
151*872edc7cSRené Corinth
152*872edc7cSRené Corinth        $db = $this->getDb();
153*872edc7cSRené Corinth        $res = $db->query('SELECT pid, tag FROM taggings ORDER BY tag');
154*872edc7cSRené Corinth
155*872edc7cSRené Corinth        $tags_tmp = $db->res2arr($res);
156*872edc7cSRené Corinth        $tags = array();
157*872edc7cSRené Corinth        foreach ($tags_tmp as $tag) {
158*872edc7cSRené Corinth
159*872edc7cSRené Corinth            $tags[$tag['tag']]['pid'][] = $tag['pid'];
160*872edc7cSRené Corinth
161*872edc7cSRené Corinth            if (isset($tags[$tag['tag']]['count'])) {
162*872edc7cSRené Corinth                $tags[$tag['tag']]['count']++;
163*872edc7cSRené Corinth            } else {
164*872edc7cSRené Corinth                $tags[$tag['tag']]['count'] = 1;
165*872edc7cSRené Corinth            }
166*872edc7cSRené Corinth        }
167*872edc7cSRené Corinth        return $tags;
168*872edc7cSRené Corinth    }
169*872edc7cSRené Corinth
170*872edc7cSRené Corinth    public function renameTag($formerTagName, $newTagName) {
171*872edc7cSRené Corinth
172*872edc7cSRené Corinth        if(empty($formerTagName) || empty($newTagName)) {
173*872edc7cSRené Corinth            return "admin enter tag names";
174*872edc7cSRené Corinth        }
175*872edc7cSRené Corinth
176*872edc7cSRené Corinth        $db = $this->getDb();
177*872edc7cSRené Corinth
178*872edc7cSRené Corinth        $res = $db->query('SELECT pid FROM taggings WHERE tag="'. $formerTagName .'"');
179*872edc7cSRené Corinth        $check = $db->res2arr($res);
180*872edc7cSRené Corinth
181*872edc7cSRené Corinth        if (empty($check)) {
182*872edc7cSRené Corinth            return "admin tag does not exists";
183*872edc7cSRené Corinth        }
184*872edc7cSRené Corinth
185*872edc7cSRené Corinth        $res = $db->query("UPDATE taggings SET tag='".$newTagName."' WHERE tag='" . $formerTagName . "'");
186*872edc7cSRené Corinth        $db->res2arr($res);
187*872edc7cSRené Corinth
188*872edc7cSRené Corinth        return "admin saved";
189*872edc7cSRené Corinth    }
190*872edc7cSRené Corinth
191f61105deSAdrian Lang}