xref: /plugin/publish/helper.php (revision 1794c5facebc8ae31437fc55d2d73a19fef4f734) 
1<?php
2/**
3 * DokuWiki Plugin publish (Helper Component)
4 *
5 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
6 * @author  Jarrod Lowe <dokuwiki@rrod.net>
7 * @author  Andreas Gohr <gohr@cosmocode.de>
8 */
9
10// must be run within Dokuwiki
11if (!defined('DOKU_INC')) die();
12
13class helper_plugin_publish extends DokuWiki_Plugin {
14
15    private $sortedApprovedRevisions = null;
16
17    // FIXME find out what this is supposed to do and how it can be done better
18    function in_namespace($valid, $check) {
19        // PHP apparantly does not have closures -
20        // so we will parse $valid ourselves. Wasteful.
21        $valid = preg_split('/\s+/', $valid);
22        //if(count($valid) == 0) { return true; }//whole wiki matches
23        if((count($valid)==1) and ($valid[0]=="")) { return true; }//whole wiki matches
24        $check = trim($check, ':');
25        $check = explode(':', $check);
26
27        // Check against all possible namespaces
28        foreach($valid as $v) {
29            $v = explode(':', $v);
30            $n = 0;
31            $c = count($v);
32            $matching = 1;
33
34            // Check each element, untill all elements of $v satisfied
35            while($n < $c) {
36                if($v[$n] != $check[$n]) {
37                    // not a match
38                    $matching = 0;
39                    break;
40                }
41                $n += 1;
42            }
43            if($matching == 1) { return true; } // a match
44        }
45        return false;
46    }
47
48    // FIXME find out what this is supposed to do and how it can be done better
49    function in_sub_namespace($valid, $check) {
50        // is check a dir which contains any valid?
51        // PHP apparantly does not have closures -
52        // so we will parse $valid ourselves. Wasteful.
53        $valid = preg_split('/\s+/', $valid);
54        //if(count($valid) == 0) { return true; }//whole wiki matches
55        if((count($valid)==1) and ($valid[0]=="")) { return true; }//whole wiki matches
56        $check = trim($check, ':');
57        $check = explode(':', $check);
58
59        // Check against all possible namespaces
60        foreach($valid as $v) {
61            $v = explode(':', $v);
62            $n = 0;
63            $c = count($check); //this is what is different from above!
64            $matching = 1;
65
66            // Check each element, untill all elements of $v satisfied
67            while($n < $c) {
68                if($v[$n] != $check[$n]) {
69                    // not a match
70                    $matching = 0;
71                    break;
72                }
73                $n += 1;
74            }
75            if($matching == 1) { return true; } // a match
76        }
77        return false;
78    }
79
80    function canApprove() {
81        global $INFO;
82        global $ID;
83
84        if (!$this->in_namespace($this->getConf('apr_namespaces'), $ID)) {
85            return false;
86        }
87
88        return ($INFO['perm'] >= AUTH_DELETE);
89    }
90
91    function getRevision() {
92        global $INFO;
93        if (!$INFO['rev']) {
94            return $INFO['lastmod'];
95        }
96        return $INFO['rev'];
97    }
98
99    function getApprovals() {
100        global $INFO;
101        if (!isset($INFO['meta']['approval'])) {
102            return array();
103        }
104        $approvals = $INFO['meta']['approval'];
105        return $approvals;
106    }
107
108    function getApprovalsOnRevision($revision) {
109        $approvals = $this->getApprovals();
110
111        if (isset($approvals[$revision])) {
112            return $approvals[$revision];
113        }
114        return array();
115    }
116
117    function getSortedApprovedRevisions() {
118        if ($this->sortedApprovedRevisions === null) {
119            $approvals = $this->getApprovals();
120            krsort($approvals);
121            $this->sortedApprovedRevisions = $approvals;
122        }
123        return $this->sortedApprovedRevisions;
124    }
125
126    function isRevisionApproved($revision) {
127        $approvals = $this->getApprovals();
128        if (!isset($approvals[$revision])) {
129            return false;
130        }
131        return (count($approvals[$revision]) >= $this->getConf('number_of_approved'));
132    }
133
134    function isCurrentRevisionApproved() {
135        return $this->isRevisionApproved($this->getRevision());
136    }
137
138    function getLatestApprovedRevision() {
139        $approvals = $this->getSortedApprovedRevisions();
140        foreach ($approvals as $revision => $ignored) {
141            if ($this->isRevisionApproved($revision)) {
142                return $revision;
143            }
144        }
145        return 0;
146    }
147
148    function getLastestRevision() {
149        global $INFO;
150        return $INFO['meta']['date']['modified'];
151    }
152
153    function getApprovalDate() {
154        if (!$this->isCurrentRevisionApproved()) {
155            return -1;
156        }
157
158        $approvals = $this->getApprovalsOnRevision($this->getRevision());
159        uasort($approvals, array(&$this, 'cmpApprovals'));
160        $keys = array_keys($approvals);
161        return $approvals[$keys[$this->getConf('number_of_approved') -1]][3];
162
163    }
164
165    function cmpApprovals($left, $right) {
166        if ($left[3] == $right[3]) {
167            return 0;
168        }
169        return ($left[3] < $right[3]) ? -1 : 1;
170    }
171
172    function getApprovers() {
173        $approvers = $this->getApprovalsOnRevision($this->getRevision());
174        $result = array();
175        foreach ($approvers as $approver) {
176            $result[] = editorinfo($this->getApproverName($approver));
177        }
178        return $result;
179    }
180
181    function getApproverName($approver) {
182        if ($approver[1]) {
183            return $approver[1];
184        }
185        if ($approver[2]) {
186            return $approver[2];
187        }
188        return $approver[0];
189    }
190
191    function getPreviousApprovedRevision() {
192        $currentRevision = $this->getRevision();
193        $approvals = $this->getSortedApprovedRevisions();
194        foreach ($approvals as $revision => $ignored) {
195            if ($revision >= $currentRevision) {
196                continue;
197            }
198            if ($this->isRevisionApproved($revision)) {
199                return $revision;
200            }
201        }
202        return 0;
203    }
204
205}
206