Editing conflict handling with Notification, Merge and create Copy options

controllers/PageController.php

@@ -15,21 +15,25 @@
 use humhub\modules\wiki\permissions\CreatePage;
 use humhub\modules\wiki\permissions\EditPages;
 use humhub\modules\wiki\permissions\ViewHistory;
+use humhub\modules\user\models\User;
 use Throwable;
 use Yii;
 use yii\base\Exception;
 use yii\base\InvalidConfigException;
 use yii\db\StaleObjectException;
 use yii\web\HttpException;
 use yii\web\Response;
+use DateTime;
 
 /**
  * PageController
  *
  * @author luke
  */
 class PageController extends BaseController
-{
+{   
+    public const TTL = 300;
+
     /**
      * @return $this|Response
      * @throws Exception
@@ -211,6 +215,7 @@ public function actionEdit($id = null, $title = null, $categoryId = null)
             ]);
         }
 
+        $form->page->updateIsEditing();
         return $this->renderSidebarContent('edit', $params);
     }
 
@@ -335,7 +340,7 @@ public function actionDelete(int $id)
         }
 
         $page->delete();
-
+        $page->doneEditing();
         return $this->redirect($this->contentContainer->createUrl('index'));
     }
 
@@ -439,5 +444,160 @@ protected function getAccessRules()
         ];
     }
 
+    /**
+     * @param int $id
+     * @return $this|Response
+     * @throws HttpException
+     */
+    public function actionMerge(int $id) 
+    {
+        $dateTime = new DateTime();
+        $userIdentity = Yii::$app->user->identity->username;
+
+        $page = $this->getWikiPage($id);
+        if (!$page) {
+            throw new HttpException(404, 'Wiki page not found!');
+        }
+
+        $form = (new PageEditForm(['container' => $this->contentContainer]))->forPage($id);
+        if (!$form->load(Yii::$app->request->post())) {
+            throw new HttpException(404);
+        }
+
+        $submittedRevision = new WikiPageRevision();
+        $submittedRevision->revision = time();
+        $submittedRevision->content = $form->revision->content;
+        $submittedRevision->isCurrentlyEditing = true;
+
+        $mergedRevision = $page->createRevision();
+        $changedContentSepeartor = '**conflicting changes of '. $userIdentity .' from '. $dateTime->format('Y-m-d H:i:s').'**';
+        $mergedRevision->content = $page->latestRevision->content.'<br><br>'.$changedContentSepeartor.'<br>'.$submittedRevision->content;
+        $mergedRevision->save();
 
+        $page->doneEditing();
+
+        return $this->redirect(Url::toWiki($page));
+    }
+
+    /**
+     * @param int $id
+     * @return $this|Response
+     * @throws HttpException
+     */
+    public function actionCreateCopy(int $id) 
+    {
+        $userIdentity = Yii::$app->user->identity->username;
+        $dateTime = new DateTime();
+
+        $page = $this->getWikiPage($id);
+        if (!$page) {
+            throw new HttpException(404, 'Wiki page not found!');
+        }
+
+        $parentId = $page->parent_page_id;
+
+        $form = (new PageEditForm(['container' => $this->contentContainer]))->forPage($id);
+        if (!$form->load(Yii::$app->request->post())) {
+            throw new HttpException(404);
+        }
+
+        $childPage = new WikiPage();
+        $childPage->title = $page->title.' conflicting copy of '. $userIdentity .' from '. $dateTime->format('Y-m-d H:i:s');
+        $childPage->parent_page_id = $parentId;
+        $childPage->content->contentcontainer_id= $page->content->contentcontainer_id;
+
+        if (!$childPage->save()) {
+            throw new HttpException(500, 'Failed to create the child page!');
+        }
+
+        if (!$childPage->id) {
+            throw new HttpException('Child page ID is not available after saving.');
+        }
+
+        $revision = new WikiPageRevision();
+        $revision->content = $form->revision->content;
+        $revision->wiki_page_id = $childPage->id;
+        $revision->revision = 1;
+        $revision->user_id = Yii::$app->user->id;
+
+        if (!$revision->save()) {
+            throw new HttpException('Failed to add content to the child page.');
+        }
+
+        $page->doneEditing();
+
+        return $this->redirect(Url::toWiki($page));
+    }
+
+    /**
+     * @param int $id
+     * @return $this|Response
+     * @throws HttpException
+     */
+    public function actionEditingStatus(int $id)
+    {
+        $page = $this->getWikiPage($id);
+        if (!$page) {
+            throw new HttpException(404, 'Wiki page not found!');
+        }
+
+        $user = User::find()->where(['username' => $page->is_currently_editing])->one();
+        if($user) {
+            $firstName = $user->profile->firstname;
+            $lastName = $user->profile->lastname;
+            $fullName = $firstName.' '.$lastName.' ('.$page->is_currently_editing.')';
+        }
+        else { $fullName = ''; }
+
+        return $this->asJson([
+            'success' => true,
+            'isEditing' => $page->isEditing(),
+            'body' => $fullName .' '. Yii::t('WikiModule.base', 'is already editing.<br> Editing it would cause conflict. Do you really want to continue?'),
+        ]);
+    }
+
+    /**
+     * @return $this|Response
+     */
+    public function actionEditingTimerUpdate(int $id = null)
+    {   
+        $conflictingEditing = false;
+        $page = $this->getWikiPage($id);
+        if (!$page) {
+            return $this->asJson([
+                'sucess' => false,
+            ]);
+        }
+
+        $user = Yii::$app->user->identity->username;
+
+        $editingUser = User::find()->where(['username' => $page->is_currently_editing])->one();
+        if($editingUser) {
+            $firstName = $editingUser->profile->firstname;
+            $lastName = $editingUser->profile->lastname;
+            $fullName = $firstName.' '.$lastName.' ('.$page->is_currently_editing.')';
+        }
+        else { $fullName = ''; }
+
+        if ($page->is_currently_editing == NULL) {
+            $page->updateIsEditing();
+        }
+
+        if ($page->is_currently_editing == $user) {
+            $page->updateEditingTime();
+        }
+        elseif (time() - $page->editing_started_at < self::TTL) {
+            $conflictingEditing = true;
+        }
+
+        return $this->asJson([
+            'success' => true,
+            'conflictingEditing' => $conflictingEditing,
+            'url' => Url::toWiki($page),
+            'header' => Yii::t('WikiModule.base', 'Confirm Edit'),
+            'body' => $fullName .' '. Yii::t('WikiModule.base', 'is already editing.<br> Editing it would cause conflict. Do you really want to continue?'),
+            'confirmText' => Yii::t('WikiModule.base', 'Cancel'),
+            'cancelText' => Yii::t('WikiModule.base', 'Continue'),
+        ]);
+    }
 }

helpers/Url.php

@@ -31,6 +31,10 @@ class Url extends \yii\helpers\Url
     public const ROUTE_WIKI_DIFF_EDITING = '/wiki/page/diff-editing';
     public const ROUTE_WIKI_REVERT = '/wiki/page/revert';
     public const ROUTE_EXTRACT_TITLES = '/wiki/page/headlines';
+    public const ROUTE_WIKI_MERGE = '/wiki/page/merge';
+    public const ROUTE_WIKI_CREATE_COPY = '/wiki/page/create-copy';
+    public const ROUTE_WIKI_EDITING_STATUS = '/wiki/page/editing-status';
+    public const ROUTE_WIKI_EDITING_TIMER_UPDATE = '/wiki/page/editing-timer-update';
 
     public static function toHome(ContentContainerActiveRecord $container)
     {
@@ -129,4 +133,24 @@ public static function toWikiEntry(WikiPage $page)
         return static::to([static::ROUTE_WIKI_ENTRY, 'id' => $page->id, 'container' => $page->content->container]);
     }
 
+    public static function toWikiMerge(WikiPage $page)
+    {
+        return static::to([static::ROUTE_WIKI_MERGE, 'id' => $page->id, 'container' => $page->content->container]);
+    }
+
+    public static function toWikiCreateCopy(WikiPage $page)
+    {
+        return static::to([static::ROUTE_WIKI_CREATE_COPY, 'id' => $page->id, 'container' => $page->content->container]);
+    }
+
+    public static function toWikiEditingStatus(WikiPage $page)
+    {
+        return static::to([static::ROUTE_WIKI_EDITING_STATUS, 'id' => $page->id, 'container' => $page->content->container]);
+    }
+
+    public static function toWikiEditingTimerUpdate(WikiPage $page)
+    {
+        return static::to([static::ROUTE_WIKI_EDITING_TIMER_UPDATE, 'id' => $page->id, 'container' => $page->content->container]);
+    }
+
 }

messages/de/base.php

@@ -3,7 +3,7 @@
 return [
     '({n,plural,=1{+1 subpage}other{+{count} subpages}})' => '({n,plural,=1{+1 Unterseite}other{+{count} Unterseiten}})',
     '<strong>Confirm</strong> page reverting' => 'Seite rückgängig machen <strong>bestätigen</strong>',
-    '<strong>Warning!</strong><br><br>Another user has updated this page since you have started editing it. Please confirm that you want to overwrite those changes.<br>:linkToCompare' => '<strong>Warnung!</strong><br><br>Ein anderer Benutzer hat diese Seite gespeichert, seit mit der Bearbeitung begonnen wurde. Sollen diese Änderungen überschreiben werden?<br>:linkToCompare',
+    '<strong>Warning!</strong><br><br>Another user has updated this page since you have started editing it. Please confirm that you want to overwrite those changes.<br>:linkToCompare' => '<strong>Warnung!</strong><br><br>Ein anderer Benutzer bearbeitet gerade diese Seite. Durch eine parallele Bearbeitung kann es zu Konflikten oder Datenverlust kommen. Möchten Sie trotzdem fortfahren?<br>:linkZuVergleichen',
     '<strong>Wiki</strong> link' => '<strong>Wiki</strong>-Verweis',
     '<strong>Wiki</strong> module configuration' => '<strong>Wiki</strong> Modulkonfiguration',
     'Add Page' => 'Seite hinzufügen',
@@ -86,4 +86,10 @@
     'Hide Navigation Entries of this module globally by default' => '',
     'Hide Navigation Entry' => '',
     'No wiki pages found.' => '',
+    'Merge' => 'Zusammenführen',
+    'Create Copy' => 'Kopie erstellen',
+    '<strong>Confirm Page Edit</strong>' => '<strong>Seite wird gerade bearbeitet</strong>',
+    'Continue' => 'Weiter',
+    'Confirm Edit' => 'Bearbeitung bestätigen',
+    'is already editing.<br> Editing it would cause conflict. Do you really want to continue?' => 'bearbeitet diese Seite.<br> Durch die Bearbeitung kommt es zu einem Dateikonflikt. Trotzdem fortfahren?',
 ];

migrations/m250203_094213_is_currently_editing.php

@@ -0,0 +1,26 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Class m250203_094213_is_currently_editing
+ */
+class m250203_094213_is_currently_editing extends Migration
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function safeUp()
+    {
+        $this->addColumn('wiki_page', 'is_currently_editing', $this->string(50)->null());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function safeDown()
+    {   
+        $this->dropColumn('wiki_page', 'is_currently_editing');
+
+    }
+}

migrations/m250219_192950_editing_started_at.php

@@ -0,0 +1,26 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Class m250219_192950_editing_started_at
+ */
+class m250219_192950_editing_started_at extends Migration
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function safeUp()
+    {
+        $this->addColumn('wiki_page', 'editing_started_at', $this->integer()->null());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function safeDown()
+    {
+        $this->dropColumn('wiki_page', 'editing_started_at');
+    }
+
+}

models/WikiPage.php

@@ -28,6 +28,8 @@
  * @property int $sort_order
  * @property int $is_container_menu
  * @property int $container_menu_order
+ * @property string|null $is_currently_editing
+ * @property int|null $editing_started_at
  *
  * @property-read WikiPage|null $categoryPage
  * @property-read WikiPageRevision $latestRevision
@@ -42,6 +44,7 @@ class WikiPage extends ContentActiveRecord implements Searchable
     public const SCENARIO_EDIT = 'edit';
     public const CACHE_CHILDREN_COUNT_KEY = 'wikiChildrenCount_%s';
     public $moduleId = 'wiki';
+    public const TTL = 300;
     /**
      * @inheritdoc
      */
@@ -540,4 +543,48 @@ public function getIsCategory(): bool
 
         return $this->_isCategory;
     }
+
+    /**
+     * Function to check if any other user is currently editing the page
+     * 
+     * @return bool
+     */
+    public function isEditing() {
+        $user = Yii::$app->user->identity->username;
+
+        if ($this->is_currently_editing == NULL || $this->is_currently_editing == $user) {
+            return false;
+        }
+
+        if (time() - $this->editing_started_at > self::TTL) {
+            $this->doneEditing();
+            return false;
+        }
+
+        return true;
+    }
+
+    /** 
+     * Function to update the Attribute value to the new user in the edit page 
+     */
+    public function updateIsEditing() {
+        $user = Yii::$app->user->identity->username;
+        if ($this->is_currently_editing == NULL) {
+            $this->updateAttributes(['is_currently_editing' => $user, 'editing_started_at' => time()]);
+        }
+    }
+
+    /** 
+     * Function to make the editing attributes null to show that no user is currently editing the page.
+     */
+    public function doneEditing() {
+        $this->updateAttributes(['is_currently_editing' => new Expression('NULL'), 'editing_started_at' => new Expression('NULL')]);
+    }
+
+    /** 
+     *  Function to update the time stamp i.e editing_started_at 
+     */
+    public function updateEditingTime() {
+        $this->updateAttributes(['editing_started_at' => time()]);
+    }
 }

models/forms/PageEditForm.php

@@ -241,6 +241,8 @@ public function save()
             $this->page->content->hidden = $this->hidden;
         }
 
+        $this->page->doneEditing();
+
         return WikiPage::getDb()->transaction(function ($db) {
             if ($this->page->save()) {
                 $this->revision->wiki_page_id = $this->page->id;