xref: /plugin/publish/helper.php (revision c2a737a8daf7edb8b8fbe7733272111d9b6e519c) 
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($id = null) {
92        global $REV;
93        if (isset($REV) && !empty($REV)) {
94            return $REV;
95        }
96        $meta = $this->getMeta($id);
97        if (isset($meta['last_change']['date'])) {
98            return $meta['last_change']['date'];
99        }
100        return $meta['date']['modified'];
101    }
102
103    function getApprovals($id = null) {
104        $meta = $this->getMeta($id);
105        if (!isset($meta['approval'])) {
106            return array();
107        }
108        $approvals = $meta['approval'];
109        return $approvals;
110    }
111
112    function getMeta($id = null) {
113        global $ID;
114        if ($id === null || $ID === $id) {
115            global $INFO;
116            $meta = $INFO['meta'];
117            $id = $ID;
118        } else {
119            $meta = p_get_metadata($id);
120        }
121
122        $this->checkApprovalFormat($meta, $id);
123
124        return $meta;
125    }
126
127    function checkApprovalFormat($meta, $id) {
128        if (isset($meta['approval_version']) && $meta['approval_version'] >= 2) {
129            return;
130        }
131
132        if (!$this->hasApprovals($meta)) {
133            return;
134        }
135
136        $approvals = $meta['approval'];
137        foreach (array_keys($approvals) as $approvedId) {
138            $keys = array_keys($approvals[$approvedId]);
139
140            if (is_array($approvals[$approvedId][$keys[0]])) {
141                continue; // current format
142            }
143
144            $newEntry = $approvals[$approvedId];
145            if (count($newEntry) !== 3) {
146                //continue; // some messed up format...
147            }
148            $newEntry[] = intval($approvedId); // revision is the time of page edit
149
150            $approvals[$approvedId] = array();
151            $approvals[$approvedId][$newEntry[0]] = $newEntry;
152        }
153        p_set_metadata($id, array('approval' => $approvals), true, true);
154        p_set_metadata($id, array('approval_version' => 2), true, true);
155    }
156
157    function hasApprovals($meta) {
158        return isset($meta['approval']) && !empty($meta['approval']);
159    }
160
161    function getApprovalsOnRevision($revision) {
162        $approvals = $this->getApprovals();
163
164        if (isset($approvals[$revision])) {
165            return $approvals[$revision];
166        }
167        return array();
168    }
169
170    function getSortedApprovedRevisions() {
171        if ($this->sortedApprovedRevisions === null) {
172            $approvals = $this->getApprovals();
173            krsort($approvals);
174            $this->sortedApprovedRevisions = $approvals;
175        }
176        return $this->sortedApprovedRevisions;
177    }
178
179    function isRevisionApproved($revision, $id = null) {
180        $approvals = $this->getApprovals($id);
181        if (!isset($approvals[$revision])) {
182            return false;
183        }
184        return (count($approvals[$revision]) >= $this->getConf('number_of_approved'));
185    }
186
187    function isCurrentRevisionApproved($id = null) {
188        return $this->isRevisionApproved($this->getRevision($id), $id);
189    }
190
191    function getLatestApprovedRevision() {
192        $approvals = $this->getSortedApprovedRevisions();
193        foreach ($approvals as $revision => $ignored) {
194            if ($this->isRevisionApproved($revision)) {
195                return $revision;
196            }
197        }
198        return 0;
199    }
200
201    function getLastestRevision() {
202        global $INFO;
203        return $INFO['meta']['date']['modified'];
204    }
205
206    function getApprovalDate() {
207        if (!$this->isCurrentRevisionApproved()) {
208            return -1;
209        }
210
211        $approvals = $this->getApprovalsOnRevision($this->getRevision());
212        uasort($approvals, array(&$this, 'cmpApprovals'));
213        $keys = array_keys($approvals);
214        return $approvals[$keys[$this->getConf('number_of_approved') -1]][3];
215
216    }
217
218    function cmpApprovals($left, $right) {
219        if ($left[3] == $right[3]) {
220            return 0;
221        }
222        return ($left[3] < $right[3]) ? -1 : 1;
223    }
224
225    function getApprovers() {
226        $approvers = $this->getApprovalsOnRevision($this->getRevision());
227        if (count($approvers) === 0) {
228            return;
229        }
230
231        $result = array();
232        foreach ($approvers as $approver) {
233            $result[] = editorinfo($this->getApproverName($approver));
234        }
235        return $result;
236    }
237
238    function getApproverName($approver) {
239        if ($approver[1]) {
240            return $approver[1];
241        }
242        if ($approver[2]) {
243            return $approver[2];
244        }
245        return $approver[0];
246    }
247
248    function getPreviousApprovedRevision() {
249        $currentRevision = $this->getRevision();
250        $approvals = $this->getSortedApprovedRevisions();
251        foreach ($approvals as $revision => $ignored) {
252            if ($revision >= $currentRevision) {
253                continue;
254            }
255            if ($this->isRevisionApproved($revision)) {
256                return $revision;
257            }
258        }
259        return 0;
260    }
261
262    function isHidden() {
263        global $ID;
264
265        if (!$this->getConf('hide drafts')) {
266            return false;
267        }
268
269        if ($this->getLatestApprovedRevision()) {
270            return false;
271        }
272
273        $allowedGroups = array_filter(explode(' ', trim($this->getConf('author groups'))));
274        if (empty($allowedGroups)) {
275            return auth_quickaclcheck($ID) < AUTH_EDIT;
276        }
277
278        if (!$_SERVER['REMOTE_USER']) {
279            return true;
280        }
281
282        global $USERINFO;
283        foreach ($allowedGroups as $allowedGroup) {
284            $allowedGroup = trim($allowedGroup);
285            if (in_array($allowedGroup, $USERINFO['grps'])) {
286                return false;
287            }
288        }
289        return true;
290    }
291}
292