aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/inc/Ui/MediaDiff.php
diff options
context:
space:
mode:
Diffstat (limited to 'inc/Ui/MediaDiff.php')
-rw-r--r--inc/Ui/MediaDiff.php339
1 files changed, 339 insertions, 0 deletions
diff --git a/inc/Ui/MediaDiff.php b/inc/Ui/MediaDiff.php
new file mode 100644
index 000000000..5ed46988e
--- /dev/null
+++ b/inc/Ui/MediaDiff.php
@@ -0,0 +1,339 @@
+<?php
+
+namespace dokuwiki\Ui;
+
+use dokuwiki\ChangeLog\MediaChangeLog;
+use dokuwiki\Ui\MediaRevisions;
+use dokuwiki\Extension\Event;
+use dokuwiki\Form\Form;
+use JpegMeta;
+
+/**
+ * DokuWiki MediaDiff Interface
+ *
+ * @package dokuwiki\Ui
+ */
+class MediaDiff extends Diff
+{
+ /* @var MediaChangeLog */
+ protected $changelog;
+
+ /**
+ * MediaDiff Ui constructor
+ *
+ * @param string $id media id
+ */
+ public function __construct($id)
+ {
+ if (!isset($id)) {
+ throw new \InvalidArgumentException('media id should not be empty!');
+ }
+ $this->item = 'media';
+
+ // init preference
+ $this->preference['fromAjax'] = false; // see doluwiki\Ajax::callMediadiff()
+ $this->preference['showIntro'] = false;
+ $this->preference['difftype'] = 'both'; // media diff view type: both, opacity or portions
+
+ parent::__construct($id);
+ }
+
+ /** @inheritdoc */
+ protected function setChangeLog()
+ {
+ $this->changelog = new MediaChangeLog($this->id);
+ }
+
+ /** @inheritdoc */
+ protected function itemFN($id, $rev = '')
+ {
+ return mediaFN($id, $rev);
+ }
+
+ /** @inheritdoc */
+ protected function preProcess()
+ {
+ parent::preProcess();
+ if (!isset($this->oldRev, $this->newRev)) {
+ // no revision was given, compare previous to current
+ $revs = $this->changelog->getRevisions(0, 1);
+ $this->oldRev = file_exists(mediaFN($this->id, $revs[0])) ? $revs[0] : '';
+ $this->newRev = '';
+ }
+ }
+
+ /**
+ * Shows difference between two revisions of media
+ *
+ * @author Kate Arzamastseva <pshns@ukr.net>
+ */
+ public function show()
+ {
+ global $conf;
+
+ $ns = getNS($this->id);
+ $auth = auth_quickaclcheck("$ns:*");
+
+ if ($auth < AUTH_READ || !$this->id || !$conf['mediarevisions']) return '';
+
+ // determine left and right revision
+ if (!isset($this->oldRev, $this->newRev)) $this->preProcess();
+ [$oldRev, $newRev] = [$this->oldRev, $this->newRev];
+
+ // prepare event data
+ // NOTE: MEDIA_DIFF event does not found in DokuWiki Event List?
+ $data = array();
+ $data[0] = $this->id;
+ $data[1] = $oldRev;
+ $data[2] = $newRev;
+ $data[3] = $ns;
+ $data[4] = $auth; // permission level
+ $data[5] = $this->preference['fromAjax'];
+
+ // trigger event
+ Event::createAndTrigger('MEDIA_DIFF', $data, null, false);
+
+ if (is_array($data) && count($data) === 6) {
+ $this->id = $data[0];
+ $oldRev = $data[1];
+ $newRev = $data[2];
+ $ns = $data[3];
+ $auth = $data[4];
+ $this->preference['fromAjax'] = $data[5];
+ } else {
+ return '';
+ }
+
+ $oldRevMeta = new JpegMeta(mediaFN($this->id, $oldRev));
+ $newRevMeta = new JpegMeta(mediaFN($this->id, $newRev));
+
+ $is_img = preg_match('/\.(jpe?g|gif|png)$/', $this->id);
+ if ($is_img) {
+ // get image width and height for the mediamanager preview panel
+ $oldRevSize = media_image_preview_size($this->id, $oldRev, $oldRevMeta);
+ $newRevSize = media_image_preview_size($this->id, $newRev, $newRevMeta);
+ // re-check image, ensure minimum image width for showImageDiff()
+ $is_img = ($oldRevSize && $newRevSize && ($oldRevSize[0] >= 30 || $newRevSize[0] >= 30));
+ }
+
+ // determine requested diff view type
+ if (!$is_img) {
+ $this->preference['difftype'] = 'both';
+ }
+
+ // display intro
+ if ($this->preference['showIntro']) echo p_locale_xhtml('diff');
+
+ // print form to choose diff view type
+ if ($is_img && !$this->preference['fromAjax']) {
+ $this->showDiffViewSelector();
+ echo '<div id="mediamanager__diff" >';
+ }
+
+ switch ($this->preference['difftype']) {
+ case 'opacity':
+ case 'portions':
+ $this->showImageDiff($oldRev, $newRev, $oldRevSize, $newRevSize);
+ break;
+ case 'both':
+ default:
+ $this->showFileDiff($oldRev, $newRev, $oldRevMeta, $newRevMeta, $auth);
+ break;
+ }
+
+ if ($is_img && !$this->preference['fromAjax']) {
+ echo '</div>';
+ }
+ }
+
+ /**
+ * Print form to choose diff view type
+ * the dropdown is to be added through JavaScript, see lib/scripts/media.js
+ */
+ protected function showDiffViewSelector()
+ {
+ echo '<div class="diffoptions group">';
+
+ $form = new Form([
+ 'id' => 'mediamanager__form_diffview',
+ 'action' => media_managerURL([], '&'),
+ 'method' => 'get',
+ 'class' => 'diffView',
+ ]);
+ $form->addTagOpen('div')->addClass('no');
+ $form->setHiddenField('sectok', null);
+ $form->setHiddenField('mediado', 'diff');
+ $form->setHiddenField('rev2[0]', $this->oldRev ?: 'current');
+ $form->setHiddenField('rev2[1]', $this->newRev ?: 'current');
+ $form->addTagClose('div');
+ echo $form->toHTML();
+
+ echo '</div>'; // .diffoptions
+ }
+
+ /**
+ * Prints two images side by side
+ * and slider
+ *
+ * @author Kate Arzamastseva <pshns@ukr.net>
+ *
+ * @param string|int $oldRev revision timestamp, or empty string
+ * @param string|int $newRev revision timestamp, or empty string
+ * @param array $oldRevSize array with width and height
+ * @param array $newRevSize array with width and height
+ * @param string $type diff view type: opacity or portions
+ */
+ protected function showImageDiff($oldRev, $newRev, $oldRevSize, $newRevSize, $type = null)
+ {
+ if (!isset($type)) {
+ $type = $this->preference['difftype'];
+ }
+
+ // adjust image width, right side (newer) has priority
+ if ($oldRevSize != $newRevSize) {
+ if ($newRevSize[0] > $oldRevSize[0]) {
+ $oldRevSize = $newRevSize;
+ }
+ }
+
+ $oldRevSrc = ml($this->id, ['rev' => $oldRev, 'h' => $oldRevSize[1], 'w' => $oldRevSize[0]]);
+ $newRevSrc = ml($this->id, ['rev' => $newRev, 'h' => $oldRevSize[1], 'w' => $oldRevSize[0]]);
+
+ // slider
+ echo '<div class="slider" style="max-width: '.($oldRevSize[0]-20).'px;" ></div>';
+
+ // two images in divs
+ echo '<div class="imageDiff '.$type.'">';
+ echo '<div class="image1" style="max-width: '.$oldRevSize[0].'px;">';
+ echo '<img src="'.$oldRevSrc.'" alt="" />';
+ echo '</div>';
+ echo '<div class="image2" style="max-width: '.$oldRevSize[0].'px;">';
+ echo '<img src="'.$newRevSrc.'" alt="" />';
+ echo '</div>';
+ echo '</div>';
+ }
+
+ /**
+ * Shows difference between two revisions of media file
+ *
+ * @author Kate Arzamastseva <pshns@ukr.net>
+ *
+ * @param string|int $oldRev revision timestamp, or empty string
+ * @param string|int $newRev revision timestamp, or empty string
+ * @param JpegMeta $oldRevMeta
+ * @param JpegMeta $newRevMeta
+ * @param int $auth permission level
+ */
+ protected function showFileDiff($oldRev, $newRev, $oldRevMeta, $newRevMeta, $auth)
+ {
+ global $lang;
+
+ // revison info of older file (left side)
+ $oldRevInfo = $this->getExtendedRevisionInfo($oldRev);
+ // revison info of newer file (right side)
+ $newRevInfo = $this->getExtendedRevisionInfo($newRev);
+
+ // display diff view table
+ echo '<div class="table">';
+ echo '<table>';
+ echo '<tr>';
+ echo '<th>'. $this->revisionTitle($oldRevInfo) .'</th>';
+ echo '<th>'. $this->revisionTitle($newRevInfo) .'</th>';
+ echo '</tr>';
+
+ echo '<tr class="image">';
+ echo '<td>';
+ media_preview($this->id, $auth, $oldRev, $oldRevMeta); // $auth not used in media_preview()?
+ echo '</td>';
+
+ echo '<td>';
+ media_preview($this->id, $auth, $newRev, $newRevMeta);
+ echo '</td>';
+ echo '</tr>';
+
+ echo '<tr class="actions">';
+ echo '<td>';
+ media_preview_buttons($this->id, $auth, $oldRev); // $auth used in media_preview_buttons()
+ echo '</td>';
+
+ echo '<td>';
+ media_preview_buttons($this->id, $auth, $newRev);
+ echo '</td>';
+ echo '</tr>';
+
+ $l_tags = media_file_tags($oldRevMeta);
+ $r_tags = media_file_tags($newRevMeta);
+ // FIXME r_tags-only stuff
+ foreach ($l_tags as $key => $l_tag) {
+ if ($l_tag['value'] != $r_tags[$key]['value']) {
+ $r_tags[$key]['highlighted'] = true;
+ $l_tags[$key]['highlighted'] = true;
+ } elseif (!$l_tag['value'] || !$r_tags[$key]['value']) {
+ unset($r_tags[$key]);
+ unset($l_tags[$key]);
+ }
+ }
+
+ echo '<tr>';
+ foreach (array($l_tags, $r_tags) as $tags) {
+ echo '<td>';
+
+ echo '<dl class="img_tags">';
+ foreach ($tags as $tag) {
+ $value = cleanText($tag['value']);
+ if (!$value) $value = '-';
+ echo '<dt>'.$lang[$tag['tag'][1]].'</dt>';
+ echo '<dd>';
+ if ($tag['highlighted']) echo '<strong>';
+ if ($tag['tag'][2] == 'date') {
+ echo dformat($value);
+ } else {
+ echo hsc($value);
+ }
+ if ($tag['highlighted']) echo '</strong>';
+ echo '</dd>';
+ }
+ echo '</dl>';
+
+ echo '</td>';
+ }
+ echo '</tr>';
+
+ echo '</table>';
+ echo '</div>';
+ }
+
+ /**
+ * Revision Title for MediaDiff table headline
+ *
+ * @param array $info Revision info structure of a media file
+ * @return string
+ */
+ protected function revisionTitle(array $info)
+ {
+ global $lang, $INFO;
+
+ if (isset($info['date'])) {
+ $rev = $info['date'];
+ $title = '<bdi><a class="wikilink1" href="'.ml($this->id, ['rev' => $rev]).'">'
+ . dformat($rev).'</a></bdi>';
+ } else {
+ $rev = false;
+ $title = '&mdash;';
+ }
+ if (isset($info['current']) || ($rev && $rev == $INFO['currentrev'])) {
+ $title .= '&nbsp;('.$lang['current'].')';
+ }
+
+ // append separator
+ $title .= ($this->preference['difftype'] === 'inline') ? ' ' : '<br />';
+
+ // supplement
+ if (isset($info['date'])) {
+ $objRevInfo = (new MediaRevisions($this->id))->getObjRevInfo($info);
+ $title .= $objRevInfo->editSummary().' '.$objRevInfo->editor();
+ }
+ return $title;
+ }
+
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-05-02 05:25:16 +0000