Issue #3195515 by szantog, introfini, mlncn: Port D7 diff module integration to D8/9

modules/user_revision_diff/src/Controller/UserRevisionController.php

+<?php
+
+namespace Drupal\user_revision_diff\Controller;
+
+use Drupal\diff\Controller\PluginRevisionController;
+use Drupal\user\UserInterface;
+
+/**
+ * Returns responses for User Revision routes.
+ */
+class UserRevisionController extends PluginRevisionController {
+
+  /**
+   * Returns a form for revision overview page.
+   *
+   * @param \Drupal\user\UserInterface $user
+   *   The user whose revisions are inspected.
+   *
+   * @return array
+   *   Render array containing the revisions table for $user.
+   *@todo This might be changed to a view when the issue at this link is
+   *   resolved: https://drupal.org/node/1863906
+   *
+   */
+  public function revisionOverview(UserInterface $user) {
+    return $this->formBuilder()->getForm('Drupal\user_revision_diff\Form\RevisionOverviewForm', $user);
+  }
+
+  /**
+   * Returns a table which shows the differences between two user revisions.
+   *
+   * @param \Drupal\User\UserInterface $user
+   *   The user whose revisions are compared.
+   * @param int $left_revision
+   *   Vid of the user revision from the left.
+   * @param int $right_revision
+   *   Vid of the user revision from the right.
+   * @param string $filter
+   *   If $filter == 'raw' raw text is compared (including html tags)
+   *   If $filter == 'raw-plain' markdown function is applied to the text before comparison.
+   *
+   * @return array
+   *   Table showing the diff between the two user revisions.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   */
+  public function compareUserRevisions(UserInterface $user, $left_revision, $right_revision, $filter) {
+    $storage = $this->entityTypeManager()->getStorage('user');
+    $route_match = \Drupal::routeMatch();
+    $left_revision = $storage->loadRevision($left_revision);
+    $right_revision = $storage->loadRevision($right_revision);
+    $build = $this->compareEntityRevisions($route_match, $left_revision, $right_revision, $filter);
+    return $build;
+  }
+
+}

modules/user_revision_diff/src/Form/RevisionOverviewForm.php

+<?php
+
+namespace Drupal\user_revision_diff\Form;
+
+use Drupal\Component\Utility\Xss;
+use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Language\LanguageManagerInterface;
+use Drupal\Core\Link;
+use Drupal\diff\DiffEntityComparison;
+use Drupal\diff\DiffLayoutManager;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Drupal\Core\Form\FormBase;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\Datetime\DateFormatter;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Url;
+use Drupal\Core\Render\RendererInterface;
+
+/**
+ * Provides a form for revision overview page.
+ */
+class RevisionOverviewForm extends FormBase {
+
+  /**
+   * The entity type manager.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * The current user service.
+   *
+   * @var \Drupal\Core\Session\AccountInterface
+   */
+  protected $currentUser;
+
+  /**
+   * The date service.
+   *
+   * @var \Drupal\Core\Datetime\DateFormatter
+   */
+  protected $date;
+
+  /**
+   * The renderer service.
+   *
+   * @var \Drupal\Core\Render\RendererInterface
+   */
+  protected $renderer;
+
+  /**
+   * The language manager.
+   *
+   * @var \Drupal\Core\Language\LanguageManagerInterface
+   */
+  protected $languageManager;
+
+  /**
+   * Wrapper object for simple configuration from diff.settings.yml.
+   *
+   * @var \Drupal\Core\Config\ImmutableConfig
+   */
+  protected $config;
+
+  /**
+   * The field diff layout plugin manager service.
+   *
+   * @var \Drupal\diff\DiffLayoutManager
+   */
+  protected $diffLayoutManager;
+
+  /**
+   * The diff entity comparison service.
+   *
+   * @var \Drupal\diff\DiffEntityComparison
+   */
+  protected $entityComparison;
+
+  /**
+   * Constructs a RevisionOverviewForm object.
+   *
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity type manager.
+   * @param \Drupal\Core\Session\AccountInterface $current_user
+   *   The current user.
+   * @param \Drupal\Core\Datetime\DateFormatter $date
+   *   The date service.
+   * @param \Drupal\Core\Render\RendererInterface $renderer
+   *   The renderer service.
+   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
+   *   The language manager.
+   * @param \Drupal\diff\DiffLayoutManager $diff_layout_manager
+   *   The diff layout service.
+   * @param \Drupal\diff\DiffEntityComparison $entity_comparison
+   *   The diff entity comparison service.
+   */
+  public function __construct(EntityTypeManagerInterface $entity_type_manager, AccountInterface $current_user, DateFormatter $date, RendererInterface $renderer, LanguageManagerInterface $language_manager, DiffLayoutManager $diff_layout_manager, DiffEntityComparison $entity_comparison) {
+    $this->entityTypeManager = $entity_type_manager;
+    $this->currentUser = $current_user;
+    $this->date = $date;
+    $this->renderer = $renderer;
+    $this->languageManager = $language_manager;
+    $this->config = $this->config('diff.settings');
+    $this->diffLayoutManager = $diff_layout_manager;
+    $this->entityComparison = $entity_comparison;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('entity_type.manager'),
+      $container->get('current_user'),
+      $container->get('date.formatter'),
+      $container->get('renderer'),
+      $container->get('language_manager'),
+      $container->get('plugin.manager.diff.layout'),
+      $container->get('diff.entity_comparison')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    return 'user_revision_overview_form';
+  }
+
+  /**
+   * {@inheritdoc}
+   *
+   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   */
+  public function buildForm(array $form, FormStateInterface $form_state, $user = NULL) {
+    $account = $this->currentUser;
+    /** @var \Drupal\user\UserInterace $user */
+    $langcode = $user->language()->getId();
+    $langname = $user->language()->getName();
+    $languages = $user->getTranslationLanguages();
+    $has_translations = (count($languages) > 1);
+    $userStorage = $this->entityTypeManager->getStorage('user');
+
+    $pagerLimit = $this->config->get('general_settings.revision_pager_limit');
+
+    $query = $this->entityTypeManager->getStorage('user')->getQuery()
+      ->condition($user->getEntityType()->getKey('id'), $user->id())
+      ->pager($pagerLimit)
+      ->allRevisions()
+      ->sort($user->getEntityType()->getKey('revision'), 'DESC')
+      // Access to the content has already been verified. Disable query-level
+      // access checking so that revisions for unpublished content still
+      //appear.
+      ->accessCheck(FALSE)
+      ->execute();
+    $vids = array_keys($query);
+
+    $revision_count = count($vids);
+
+    $build['#title'] = $has_translations ? $this->t('@langname revisions for %title', [
+      '@langname' => $langname,
+      '%title' => $user->label(),
+    ]) : $this->t('Revisions for %title', [
+      '%title' => $user->label(),
+    ]);
+    $build['uid'] = array(
+      '#type' => 'hidden',
+      '#value' => $user->id(),
+    );
+
+    $table_header = [];
+    $table_header['revision'] = $this->t('Revision');
+
+    // Allow comparisons only if there are 2 or more revisions.
+    if ($revision_count > 1) {
+      $table_header += array(
+        'select_column_one' => '',
+        'select_column_two' => '',
+      );
+    }
+    $table_header['operations'] = $this->t('Operations');
+
+    $rev_revert_perm = $account->hasPermission("revert own user revisions") ||
+      $account->hasPermission('revert all user revisions') ||
+      $account->hasPermission('administer users');
+    $rev_delete_perm = $account->hasPermission("delete own user revisions") ||
+      $account->hasPermission('delete all user revisions') ||
+      $account->hasPermission('administer users');
+    $revert_permission = $rev_revert_perm && $user->access('update');
+    $delete_permission = $rev_delete_perm && $user->access('delete');
+
+    // Contains the table listing the revisions.
+    $build['user_revisions_table'] = array(
+      '#type' => 'table',
+      '#header' => $table_header,
+      '#attributes' => array('class' => array('diff-revisions')),
+    );
+
+    $build['user_revisions_table']['#attached']['library'][] = 'diff/diff.general';
+    $build['user_revisions_table']['#attached']['drupalSettings']['diffRevisionRadios'] = $this->config->get('general_settings.radio_behavior');
+
+    $default_revision = $user->getRevisionId();
+    // Add rows to the table.
+    foreach ($vids as $key => $vid) {
+      $previous_revision = NULL;
+      if (isset($vids[$key + 1])) {
+        $previous_revision = $userStorage->loadRevision($vids[$key + 1]);
+      }
+      /** @var \Drupal\user\Entity\User $revision */
+      if ($revision = $userStorage->loadRevision($vid)) {
+        if ($revision->hasTranslation($langcode) && $revision->getTranslation($langcode)->isRevisionTranslationAffected()) {
+          $username = array(
+            '#theme' => 'username',
+            '#account' => $revision->revision_uid->entity,
+          );
+
+          $revision_date = $this->date->format($revision->revision_timestamp->value, 'short');
+          // Use revision link to link to revisions that are not active.
+          if ($vid != $default_revision) {
+            $link = Link::fromTextAndUrl($revision_date, new Url('entity.user.revision', ['user' => $user->id(), 'user_revision' => $vid]));
+          }
+          else {
+            $link = $user->toLink($revision_date);
+          }
+
+          if ($vid == $default_revision) {
+            $row = [
+              'revision' => $this->buildRevision($link, $username, $revision, $previous_revision),
+            ];
+
+            // Allow comparisons only if there are 2 or more revisions.
+            if ($revision_count > 1) {
+              $row += [
+                'select_column_one' => $this->buildSelectColumn('radios_left', $vid, FALSE),
+                'select_column_two' => $this->buildSelectColumn('radios_right', $vid, $vid),
+              ];
+            }
+            $row['operations'] = array(
+              '#prefix' => '<em>',
+              '#markup' => $this->t('Current revision'),
+              '#suffix' => '</em>',
+              '#attributes' => array(
+                'class' => array('revision-current'),
+              ),
+            );
+            $row['#attributes'] = [
+              'class' => ['revision-current'],
+            ];
+          }
+          else {
+            $route_params = array(
+              'user' => $user->id(),
+              'user_revision' => $vid,
+              'langcode' => $langcode,
+            );
+            $links = array();
+            if ($revert_permission) {
+              $links['revert'] = [
+                'title' => $vid < $user->getRevisionId() ? $this->t('Revert') : $this->t('Set as current revision'),
+                'url' => $has_translations ?
+                  Url::fromRoute('user.revision_revert_translation_confirm', ['user' => $user->id(), 'user_revision' => $vid, 'langcode' => $langcode]) :
+                  Url::fromRoute('user.revision_revert_confirm', ['user' => $user->id(), 'user_revision' => $vid]),
+              ];
+            }
+            if ($delete_permission) {
+              $links['delete'] = array(
+                'title' => $this->t('Delete'),
+                'url' => Url::fromRoute('user.revision_delete_confirm', $route_params),
+              );
+            }
+
+            // Here we don't have to deal with 'only one revision' case because
+            // if there's only one revision it will also be the default one,
+            // entering on the first branch of this if else statement.
+            $row = [
+              'revision' => $this->buildRevision($link, $username, $revision, $previous_revision),
+              'select_column_one' => $this->buildSelectColumn('radios_left', $vid,
+                isset($vids[1]) ? $vids[1] : FALSE),
+              'select_column_two' => $this->buildSelectColumn('radios_right', $vid, FALSE),
+              'operations' => [
+                '#type' => 'operations',
+                '#links' => $links,
+              ],
+            ];
+          }
+          // Add the row to the table.
+          $build['user_revisions_table'][] = $row;
+        }
+      }
+    }
+
+    // Allow comparisons only if there are 2 or more revisions.
+    if ($revision_count > 1) {
+      $build['submit'] = array(
+        '#type' => 'submit',
+        '#button_type' => 'primary',
+        '#value' => $this->t('Compare selected revisions'),
+        '#attributes' => array(
+          'class' => array(
+            'diff-button',
+          ),
+        ),
+      );
+    }
+    $build['pager'] = array(
+      '#type' => 'pager',
+    );
+    $build['#attached']['library'][] = 'node/drupal.node.admin';
+    return $build;
+  }
+
+  /**
+   * Set column attributes and return config array.
+   *
+   * @param string $name
+   *   Name attribute.
+   * @param string $return_val
+   *   Return value attribute.
+   * @param string $default_val
+   *   Default value attribute.
+   *
+   * @return array
+   *   Configuration array.
+   */
+  protected function buildSelectColumn($name, $return_val, $default_val) {
+    return [
+      '#type' => 'radio',
+      '#title_display' => 'invisible',
+      '#name' => $name,
+      '#return_value' => $return_val,
+      '#default_value' => $default_val,
+    ];
+  }
+
+  /**
+   * Set and return configuration for revision.
+   *
+   * @param \Drupal\Core\Link $link
+   *   Link attribute.
+   * @param string $username
+   *   Username attribute.
+   * @param \Drupal\Core\Entity\ContentEntityInterface $revision
+   *   Revision parameter for getRevisionDescription function.
+   * @param \Drupal\Core\Entity\ContentEntityInterface $previous_revision
+   *   (optional) Previous revision for getRevisionDescription function.
+   *   Defaults to NULL.
+   *
+   * @return array
+   *   Configuration for revision.
+   */
+  protected function buildRevision(Link $link, $username, ContentEntityInterface $revision, ContentEntityInterface $previous_revision = NULL) {
+    return [
+      '#type' => 'inline_template',
+      '#template' => '{% trans %}{{ date }} by {{ username }}{% endtrans %}{% if message %}<p class="revision-log">{{ message }}</p>{% endif %}',
+      '#context' => [
+        'date' => $link->toString(),
+        'username' => $this->renderer->renderPlain($username),
+        'message' => [
+          '#markup' => $revision->revision_log->value,
+          '#allowed_tags' => Xss::getAdminTagList(),
+        ],
+      ],
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validateForm(array &$form, FormStateInterface $form_state) {
+    $input = $form_state->getUserInput();
+
+    if (count($form_state->getValue('user_revisions_table')) <= 1) {
+      $form_state->setErrorByName('user_revisions_table', $this->t('Multiple revisions are needed for comparison.'));
+    }
+    elseif (!isset($input['radios_left']) || !isset($input['radios_right'])) {
+      $form_state->setErrorByName('user_revisions_table', $this->t('Select two revisions to compare.'));
+    }
+    elseif ($input['radios_left'] == $input['radios_right']) {
+      // @todo Radio-boxes selection resets if there are errors.
+      $form_state->setErrorByName('user_revisions_table', $this->t('Select different revisions to compare.'));
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    $input = $form_state->getUserInput();
+    $vid_left = $input['radios_left'];
+    $vid_right = $input['radios_right'];
+    $uid = $input['uid'];
+
+    // Always place the older revision on the left side of the comparison
+    // and the newer revision on the right side (however revisions can be
+    // compared both ways if we manually change the order of the parameters).
+    if ($vid_left > $vid_right) {
+      $aux = $vid_left;
+      $vid_left = $vid_right;
+      $vid_right = $aux;
+    }
+
+    // Builds the redirect Url.
+    $redirect_url = Url::fromRoute(
+      'entity.user.revisions_diff',
+      array(
+        'user' => $uid,
+        'left_revision' => $vid_left,
+        'right_revision' => $vid_right,
+        'filter' => $this->diffLayoutManager->getDefaultLayout(),
+      )
+    );
+    $form_state->setRedirectUrl($redirect_url);
+  }
+
+}

modules/user_revision_diff/src/Routing/RouteSubscriber.php

+<?php
+
+namespace Drupal\user_revision_diff\Routing;
+
+use Drupal\Core\Routing\RouteSubscriberBase;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * Listens to the dynamic route events.
+ */
+class RouteSubscriber extends RouteSubscriberBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function alterRoutes(RouteCollection $collection) {
+    // Replace the content from entity.user.version_history route with content
+    // generated by revisionOverview method from UserRevisionController class.
+    $route = $collection->get('entity.user.version_history');
+    if ($route) {
+      $route->addDefaults(
+        array(
+          '_controller' => '\Drupal\user_revision_diff\Controller\UserRevisionController::revisionOverview',
+        )
+      );
+    }
+  }
+
+}

modules/user_revision_diff/user_revision_diff.info.yml

+name: User Revisions Diff
+type: module
+description: Show differences between user revisions.
+package: MMS
+core: 8.x
+core_version_requirement: ^8 || ^9
+dependencies:
+  - user_revision
+  - diff

modules/user_revision_diff/user_revision_diff.routing.yml

+entity.user.revisions_diff:
+  path: '/user/{user}/revisions/view/{left_revision}/{right_revision}/{filter}'
+  defaults:
+    _controller: '\Drupal\user_revision_diff\Controller\UserRevisionController::compareUserRevisions'
+    _title: Diff General Settings
+  requirements:
+    _access_user_revision: 'view'
+  options:
+    _admin_route: TRUE

modules/user_revision_diff/user_revision_diff.services.yml

+services:
+  user_revision_diff.route_subscriber:
+    class: Drupal\user_revision_diff\Routing\RouteSubscriber
+    tags:
+      - { name: event_subscriber }