xref: /dokuwiki/inc/Ui/MediaDiff.php (revision a6dd7f90b05946780c0a4f2f1696eba6f944bece) 
1<?php
2
3namespace dokuwiki\Ui;
4
5use dokuwiki\ChangeLog\MediaChangeLog;
6use dokuwiki\Extension\Event;
7use dokuwiki\Form\Form;
8
9/**
10 * DokuWiki MediaDiff Interface
11 *
12 * @package dokuwiki\Ui
13 */
14class MediaDiff extends Diff
15{
16    /**
17     * MediaDiff Ui constructor
18     *
19     * @param string $id  media id
20     */
21    public function __construct($id)
22    {
23        $this->id = $id;
24        $this->item = 'media';
25
26        // init preference
27        $this->preference['fromAjax'] = false; // see doluwiki\Ajax::callMediadiff()
28        $this->preference['showIntro'] = false;
29        $this->preference['difftype'] = 'both';  // media diff view type: both, opacity or portions
30
31        $this->setChangeLog();
32    }
33
34    /** @inheritdoc */
35    protected function setChangeLog()
36    {
37        $this->changelog = new MediaChangeLog($this->id);
38    }
39
40    /** @inheritdoc */
41    protected function preProcess()
42    {
43        parent::preProcess();
44        if (!isset($this->oldRev, $this->newRev)) {
45            // no revision was given, compare previous to current
46            $revs = $this->changelog->getRevisions(0, 1);
47            $this->oldRev = file_exists(mediaFN($this->id, $revs[0])) ? $revs[0] : '';
48            $this->newRev = '';
49        }
50    }
51
52    /**
53     * Shows difference between two revisions of media
54     *
55     * @author Kate Arzamastseva <pshns@ukr.net>
56     */
57    public function show()
58    {
59        global $conf;
60
61        $ns = getNS($this->id);
62        $auth = auth_quickaclcheck("$ns:*");
63
64        if ($auth < AUTH_READ || !$this->id || !$conf['mediarevisions']) return '';
65
66       // determine left and right revision
67        if (!isset($this->oldRev, $this->newRev)) $this->preProcess();
68        [$oldRev, $newRev] = [$this->oldRev, $this->newRev];
69
70        // prepare event data
71        // NOTE: MEDIA_DIFF event does not found in DokuWiki Event List?
72        $data = array();
73        $data[0] = $this->id;
74        $data[1] = $oldRev;
75        $data[2] = $newRev;
76        $data[3] = $ns;
77        $data[4] = $auth; // permission level
78        $data[5] = $this->preference['fromAjax'];
79
80        // trigger event
81        Event::createAndTrigger('MEDIA_DIFF', $data, null, false);
82
83        if (is_array($data) && count($data) === 6) {
84            $this->id = $data[0];
85            $oldRev = $data[1];
86            $newRev = $data[2];
87            $ns     = $data[3];
88            $auth   = $data[4];
89            $this->preference['fromAjax'] = $data[5];
90        } else {
91            return '';
92        }
93
94        $oldRevMeta = new \JpegMeta(mediaFN($this->id, $oldRev));
95        $newRevMeta = new \JpegMeta(mediaFN($this->id, $newRev));
96
97        $is_img = preg_match('/\.(jpe?g|gif|png)$/', $this->id);
98        if ($is_img) {
99            // get image width and height for the mediamanager preview panel
100            $oldRevSize = media_image_preview_size($this->id, $oldRev, $oldRevMeta);
101            $newRevSize = media_image_preview_size($this->id, $newRev, $newRevMeta);
102            // re-check image, ensure minimum image width for showImageDiff()
103            $is_img = ($oldRevSize && $newRevSize && ($oldRevSize[0] >= 30 || $newRevSize[0] >= 30));
104        }
105
106        // determine requested diff view type
107        if (!$is_img) {
108            $this->preference['difftype'] = 'both';
109        }
110
111        // display intro
112        if ($this->preference['showIntro']) echo p_locale_xhtml('diff');
113
114        // print form to choose diff view type
115        if ($is_img && !$this->preference['fromAjax']) {
116            $this->showDiffViewSelector();
117            echo '<div id="mediamanager__diff" >';
118        }
119
120        switch ($this->preference['difftype']) {
121            case 'opacity':
122            case 'portions':
123                $this->showImageDiff($oldRev, $newRev, $oldRevSize, $newRevSize, $difftype);
124                break;
125            case 'both':
126            default:
127                $this->showFileDiff($oldRev, $newRev, $oldRevMeta, $newRevMeta, $auth);
128                break;
129        }
130
131        if ($is_img && !$this->preference['fromAjax']) {
132            echo '</div>';
133        }
134    }
135
136    /**
137     * Print form to choose diff view type
138     * the dropdown is to be added through JavaScript, see lib/scripts/media.js
139     */
140    protected function showDiffViewSelector()
141    {
142        echo '<div class="diffoptions group">';
143
144        $form = new Form([
145            'id' => 'mediamanager__form_diffview',
146            'action' => media_managerURL([], '&'),
147            'method' => 'get',
148            'class' => 'diffView',
149        ]);
150        $form->addTagOpen('div')->addClass('no');
151        $form->setHiddenField('sectok', null);
152        $form->setHiddenField('mediado', 'diff');
153        $form->setHiddenField('rev2[0]', $this->oldRev ?: 'current');
154        $form->setHiddenField('rev2[1]', $this->newRev ?: 'current');
155        $form->addTagClose('div');
156        echo $form->toHTML();
157
158        echo '</div>'; // .diffoptions
159    }
160
161    /**
162     * Prints two images side by side
163     * and slider
164     *
165     * @author Kate Arzamastseva <pshns@ukr.net>
166     *
167     * @param string|int $oldRev revision timestamp, or empty string
168     * @param string|int $newRev revision timestamp, or empty string
169     * @param array  $oldRevSize  array with width and height
170     * @param array  $newRevSize  array with width and height
171     * @param string $type    diff view type: opacity or portions
172     */
173    protected function showImageDiff($oldRev, $newRev, $oldRevSize, $newRevSize, $type = null)
174    {
175        if (!isset($type)) {
176            $type = $this->preference['difftype'];
177        }
178
179        // adjust image width, right side (newer) has priority
180        if ($oldRevSize != $newRevSize) {
181            if ($newRevSize[0] > $oldRevSize[0]) {
182                $oldRevSize = $newRevSize;
183            }
184        }
185
186        $oldRevSrc = ml($this->id, ['rev' => $oldRev, 'h' => $oldRevSize[1], 'w' => $oldRevSize[0]]);
187        $newRevSrc = ml($this->id, ['rev' => $newRev, 'h' => $oldRevSize[1], 'w' => $oldRevSize[0]]);
188
189        // slider
190        echo '<div class="slider" style="max-width: '.($oldRevSize[0]-20).'px;" ></div>';
191
192        // two images in divs
193        echo '<div class="imageDiff '.$type.'">';
194        echo '<div class="image1" style="max-width: '.$oldRevSize[0].'px;">';
195        echo '<img src="'.$oldRevSrc.'" alt="" />';
196        echo '</div>';
197        echo '<div class="image2" style="max-width: '.$oldRevSize[0].'px;">';
198        echo '<img src="'.$newRevSrc.'" alt="" />';
199        echo '</div>';
200        echo '</div>';
201    }
202
203    /**
204     * Shows difference between two revisions of media file
205     *
206     * @author Kate Arzamastseva <pshns@ukr.net>
207     *
208     * @param string|int $oldRev revision timestamp, or empty string
209     * @param string|int $newRev revision timestamp, or empty string
210     * @param JpegMeta $oldRevMeta
211     * @param JpegMeta $newRevMeta
212     * @param int $auth permission level
213     */
214    protected function showFileDiff($oldRev, $newRev, $oldRevMeta, $newRevMeta, $auth)
215    {
216        global $lang;
217
218        // revison info of older file (left side)
219        $oldRevInfo = $this->getExtendedRevisionInfo($oldRev);
220        // revison info of newer file (right side)
221        $newRevInfo = $this->getExtendedRevisionInfo($newRev);
222
223        // display diff view table
224        echo '<div class="table">';
225        echo '<table>';
226        echo '<tr>';
227        echo '<th>'. $this->revisionTitle($oldRevInfo) .'</th>';
228        echo '<th>'. $this->revisionTitle($newRevInfo) .'</th>';
229        echo '</tr>';
230
231        echo '<tr class="image">';
232        echo '<td>';
233        media_preview($this->id, $auth, $oldRev, $oldRevMeta); // $auth not used in media_preview()?
234        echo '</td>';
235
236        echo '<td>';
237        media_preview($this->id, $auth, $newRev, $newRevMeta);
238        echo '</td>';
239        echo '</tr>';
240
241        echo '<tr class="actions">';
242        echo '<td>';
243        media_preview_buttons($this->id, $auth, $oldRev); // $auth used in media_preview_buttons()
244        echo '</td>';
245
246        echo '<td>';
247        media_preview_buttons($this->id, $auth, $newRev);
248        echo '</td>';
249        echo '</tr>';
250
251        $l_tags = media_file_tags($oldRevMeta);
252        $r_tags = media_file_tags($newRevMeta);
253        // FIXME r_tags-only stuff
254        foreach ($l_tags as $key => $l_tag) {
255            if ($l_tag['value'] != $r_tags[$key]['value']) {
256                $r_tags[$key]['highlighted'] = true;
257                $l_tags[$key]['highlighted'] = true;
258            } elseif (!$l_tag['value'] || !$r_tags[$key]['value']) {
259                unset($r_tags[$key]);
260                unset($l_tags[$key]);
261            }
262        }
263
264        echo '<tr>';
265        foreach (array($l_tags, $r_tags) as $tags) {
266            echo '<td>';
267
268            echo '<dl class="img_tags">';
269            foreach ($tags as $tag) {
270                $value = cleanText($tag['value']);
271                if (!$value) $value = '-';
272                echo '<dt>'.$lang[$tag['tag'][1]].'</dt>';
273                echo '<dd>';
274                if ($tag['highlighted']) echo '<strong>';
275                if ($tag['tag'][2] == 'date') {
276                    echo dformat($value);
277                } else {
278                    echo hsc($value);
279                }
280                if ($tag['highlighted']) echo '</strong>';
281                echo '</dd>';
282            }
283            echo '</dl>';
284
285            echo '</td>';
286        }
287        echo '</tr>';
288
289        echo '</table>';
290        echo '</div>';
291    }
292
293    /**
294     * Revision Title for MediaDiff table headline
295     *
296     * @param array $info  Revision info structure of a media file
297     * @return string
298     */
299    protected function revisionTitle(array $info)
300    {
301        global $lang, $INFO;
302
303        if (isset($info['date'])) {
304            $rev = $info['date'];
305            $title = '<bdi><a class="wikilink1" href="'.ml($this->id, ['rev' => $rev]).'">'
306                   . dformat($rev).'</a></bdi>';
307        } else {
308            $rev = false;
309            $title = '&mdash;';
310        }
311        if (isset($info['current']) || ($rev && $rev == $INFO['currentrev'])) {
312            $title .= '&nbsp;('.$lang['current'].')';
313        }
314
315        // append separator
316        $title .= ($this->preference['difftype'] === 'inline') ? ' ' : '<br />';
317
318        // supplement
319        if (isset($info['date'])) {
320            $objRevInfo = (new MediaRevisions($this->id))->getObjRevInfo($info);
321            $title .= $objRevInfo->editSummary().' '.$objRevInfo->editor();
322        }
323        return $title;
324    }
325
326}
327