Merge pull request #76 from funktechno/dev

lastlink · web-flow · commit 65ed95c0940f · 2024-07-19T17:26:57.000-04:00
0.3.4 reorder page support
diff --git a/Asset/Javascript/wiki.js b/Asset/Javascript/wiki.js
@@ -38,6 +38,62 @@ jQuery(document).ready(function () {
 
         // Don't do anything if dropping the same column we're dragging.
         if (dragSrcEl != this) {
+            
+            let targetRoute;
+            if(e.target.localName == "a"){
+                targetRoute = e.target.href
+            } else {
+                targetRoute = e.target.querySelector("a").href
+            }
+            let targetParams = new URL(targetRoute)
+            var targetProperties = {}
+            for (const [key, value] of targetParams.searchParams.entries()) {
+                targetProperties[key] = value
+            }
+            // console.log("targetProperties", targetProperties)
+            
+            var srcParams = new URL(dragSrcEl.querySelector("a").href)
+            var srcProperties = {}
+
+            for (const [key, value] of srcParams.searchParams.entries()) {
+                srcProperties[key] = value
+            }
+            // console.log("srcProperties", srcProperties)
+
+            let project_id = srcProperties["project_id"]
+
+            // console.log("project_id", project_id)
+
+            let request = {
+                "src_wiki_id": srcProperties["wiki_id"],
+                "target_wiki_id": targetProperties["wiki_id"]
+            }
+
+            console.log("request", request)
+
+            $.ajax({
+                cache: false,
+                url: $("#columns").data("reorder-url"),
+                contentType: "application/json",
+                type: "POST",
+                processData: false,
+                data: JSON.stringify(request),
+                success: function(data) {
+                    // self.refresh(data);
+                    // self.savingInProgress = false;
+                },
+                error: function() {
+                    // self.app.hideLoadingIcon();
+                    // self.savingInProgress = false;
+                },
+                statusCode: {
+                    403: function(data) {
+                        window.alert(data.responseJSON.message);
+                        document.location.reload(true);
+                    }
+                }
+            });
+
             // Set the source column's HTML to the HTML of the column we dropped on.
             //alert(this.outerHTML);
             //dragSrcEl.innerHTML = this.innerHTML;
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,12 @@
+Version 0.3.4
+Improvements:
+
+* ability to reorder wiki pages
+
+Bug fixes:
+
+* Fix https://github.com/funktechno/kanboard-plugin-wiki/issues/28
+
 Version 0.3.3
 Improvements:
 
diff --git a/Controller/WikiAjaxController.php b/Controller/WikiAjaxController.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Kanboard\Plugin\Wiki\Controller;
+
+use Exception;
+use Kanboard\Controller\BaseController;
+use Kanboard\Core\Controller\AccessForbiddenException;
+use Kanboard\Model\UserMetadataModel;
+
+/**
+ * Class WikiAjaxController
+ *
+ * @package Kanboard\Controller
+ * @author  lastlink
+ */
+class WikiAjaxController extends BaseController
+{
+    /**
+     * reorder for wikipages using src and target page moving src before target
+     */
+    public function reorder()
+    {
+        $this->checkReusableGETCSRFParam();
+        $project_id = $this->request->getIntegerParam('project_id');
+
+        if (! $project_id || ! $this->request->isAjax()) {
+            throw new AccessForbiddenException();
+        }
+
+        $values = $this->request->getJson();
+
+        if(!isset($values['src_wiki_id']) || !isset($values['target_wiki_id'])) {
+            throw new AccessForbiddenException();
+        }
+
+        // if (! $this->helper->projectRole->canMoveTask($project_id, $values['src_column_id'], $values['dst_column_id'])) {
+        //     throw new AccessForbiddenException(e("You don't have the permission to move this task"));
+        // }
+
+        try {
+            $result = $this->wiki->reorderPages($project_id, $values['src_wiki_id'], $values['target_wiki_id']);
+
+            if (!$result) {
+                $this->response->status(400);
+            } else {
+                $this->response->status(200);
+            }
+        } catch (Exception $e) {
+            $this->response->html('<div class="alert alert-error">'.$e->getMessage().'</div>');
+        }
+    }
+    
+}
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 plugin=Wiki
-version=0.3.3
+version=0.3.4
 all:
 	@ echo "Build archive for plugin ${plugin} version=${version}"
 	@ git archive HEAD --prefix=${plugin}/ --format=zip -o ${plugin}-${version}.zip
diff --git a/Model/Wiki.php b/Model/Wiki.php
@@ -98,6 +98,68 @@ public function getWikipages($project_id)
         // ->findOne();
     }
 
+    public function reorderPages($project_id, $src_wiki_id, $target_wiki_id){
+        // retrieve wiki pages
+        $wikiPages = $this->getWikipages($project_id);
+
+        // echo json_encode($wikiPages), true;
+
+        // echo "project_id: " . $project_id . " src_wiki_id: " . $src_wiki_id . " target_wiki_id: " . $target_wiki_id . "<br>";
+        // change order of each in for loop, move matching id to one before target
+        $orderColumn = 1;
+        $targetColumn = 1;
+        $oldSourceColumn = 1;
+        for ($i=0; $i < count($wikiPages); $i++) {
+            $oldOrderColumn = $wikiPages[$i]['ordercolumn'];
+            $id = $wikiPages[$i]['id'];
+            if($id == $target_wiki_id){
+                // add additional order column
+                $orderColumn++;
+                $targetColumn = $orderColumn;
+            }
+            // echo " id: " . $id . " oldOrderColumn: " . $oldOrderColumn . " orderColumn: " . $orderColumn . "<br>";
+
+            if ($id == $src_wiki_id) {
+                $oldSourceColumn = $oldOrderColumn;
+            } else {
+                if ($oldOrderColumn != $orderColumn) {
+                    // echo "updating ". $id ." column to ". $orderColumn . "<br>";
+                    $result = $this->savePagePosition($id, $orderColumn);
+                    if(!$result){
+                        return false;
+                    }
+                } 
+            }
+            $orderColumn++;
+        }
+
+        // update moved src
+        $targetColumn--;
+        // echo "oldSourceColumn: " . $oldSourceColumn . " targetColumn: " . $targetColumn . "<br>";
+        if($oldSourceColumn != $targetColumn){
+            // echo "updating src ". $src_wiki_id . " column to ". $targetColumn -1 . "<br>";
+            $result = $this->savePagePosition($src_wiki_id, $targetColumn);
+            if(!$result){
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    public function savePagePosition($wiki_id, $orderColumn) {
+        $result = $this->db->table(self::WIKITABLE)->eq('id', $wiki_id)->update(array(
+            'ordercolumn' => $orderColumn
+        ));
+
+        if (! $result) {
+            $this->db->cancelTransaction();
+            return false;
+        }
+
+        return true;
+    }
+
 
 
     /**
@@ -229,7 +291,7 @@ public function updatepage($paramvalues, $editions, $date = '')
         }
         
         $wikiEventJob = new WikiEventJob($this->container);
-        $wikiEventJob->executeWithId($paramvalues['id'], self::EVENT_DELETE);
+        $wikiEventJob->executeWithId($paramvalues['id'], self::EVENT_UPDATE);
         // $wikiEventJob = new WikiEventJob($this->container);
         // $wikiEventJob->execute($paramvalues['title'], $paramvalues['project_id'], $values, self::EVENT_UPDATE);
         $this->db->table(self::WIKITABLE)->eq('id', $paramvalues['id'])->update($values);
@@ -421,14 +483,6 @@ public function restoreEdition($wiki_id, $edition)
             ->eq('wikipage_id', $wiki_id)
             ->findOne(); // this may possibly not support joins
 
-        // $values = array(
-        //     'title' => $editionvalues['title'],
-        //     'current_edition' => $edition,
-        //     'content' => $editionvalues['title'],
-        //     'date_modification' => $date ?: date('Y-m-d'),
-        //     'modifier_id' => $this->userSession->getId(),
-        // );
-
         $values = [
             'title' => $editionvalues['title'],
             'current_edition' => $edition,
diff --git a/Plugin.php b/Plugin.php
@@ -11,6 +11,7 @@ class Plugin extends Base
     public function initialize()
     {
         $this->projectAccessMap->add('WikiController', '*', Role::PROJECT_MEMBER);
+        $this->projectAccessMap->add('WikiAjaxController', '*', Role::PROJECT_MEMBER);
         $this->applicationAccessMap->add('WikiController', array('readonly','detail_readonly'), Role::APP_PUBLIC);
         $this->projectAccessMap->add('WikiFileController', '*', Role::PROJECT_MEMBER);
         $this->projectAccessMap->add('WikiFileViewController', '*', Role::PROJECT_MEMBER);
@@ -68,6 +69,9 @@ public function onStartup()
     public function getClasses()
     {
         return array(
+            'Plugin\Wiki\Controller' => [
+                'WikiAjaxController'
+            ],
             'Plugin\Wiki\Model' => array(
                 'Wiki',
                 'WikiFile'
@@ -92,7 +96,7 @@ public function getPluginAuthor()
 
     public function getPluginVersion()
     {
-        return '0.3.3';
+        return '0.3.4';
     }
 
     public function getPluginHomepage()
diff --git a/README.md b/README.md
@@ -70,9 +70,9 @@ Note that you can only restore **saved** editions. So you if you have the global
 - [x] editions listing and restore
   - Related issues: [#9](https://github.com/kanboard/kanboard/issues/9)
 - [x] finish edit
-- [] ordering
-  - [] drop down to switch
-  - [] drag to move, require css magic
+- [x] ordering
+  - [x] drop down to switch
+  - [x] drag to move, require css magic
 - [] subpages and pagination
 - [x] fix wiki sidebar
   - use html template render properly to list wiki pages
diff --git a/Template/wiki/detail.php b/Template/wiki/detail.php
@@ -33,11 +33,11 @@
 </style>
 <div class="clearfix">
 <div class="sidebar column list">
-    <ul id="columns">
+    <ul id="columns" data-reorder-url="<?= $this->url->href('WikiAjaxController', 'reorder', array('plugin' => 'wiki', 'project_id' => $project['id'], 'csrf_token' => $this->app->getToken()->getReusableCSRFToken())) ?>">
         <?php if (!empty($wikipages)): ?>
         <?php foreach ($wikipages as $page): ?>
 
-        <li class="wikipage" <?php if (!$not_editable): ?>draggable="true"<?php endif ?>>
+        <li class="wikipage" data-project-id="<?=$project['id']?>" data-page-id="<?=$page['id']?>" <?php if (!$not_editable): ?>draggable="true"<?php endif ?>>
             <?php if (!$not_editable): ?>
                 <?=$this->url->link(t($page['title']), 'WikiController', 'detail', array('plugin' => 'wiki', 'project_id' => $project['id'], 'wiki_id' => $page['id']))?>
 
diff --git a/Test/Model/WikiPageTest.php b/Test/Model/WikiPageTest.php
@@ -23,11 +23,15 @@ protected function setUp(): void
 
         $plugin = new Loader($this->container);
         $plugin->scan();
+        
+        $authManager = new AuthenticationManager($this->container);
+        $authManager->register(new DatabaseAuth($this->container));
+
+        $_SESSION['user'] = array('id' => 1, 'username' => 'test', 'role' => 'app-admin');
     }
 
     public function testCreation()
     {
-        
         $projectModel = new ProjectModel($this->container);
 
         $this->assertEquals($projectModel->create(array('name' => 'UnitTest')), 1, 'Failed to create project');
@@ -36,8 +40,8 @@ public function testCreation()
 
         $wikimodel = new Wiki($this->container);
         // create wiki pages
-        $this->assertEquals($wikimodel->createpage($project['id'], "Security", "Some content", '2015-01-01'), 1, 'Failed to a create wiki page on project');
-        $this->assertEquals($wikimodel->createpage($project['id'], "Conventions", 'More content'), 2, 'Failed to an additional create wiki page on project');
+        $this->assertEquals(1, $wikimodel->createpage($project['id'], "Security", "Some content", '2015-01-01'), 'Failed to a create wiki page on project');
+        $this->assertEquals(2, $wikimodel->createpage($project['id'], "Conventions", 'More content'), 'Failed to an additional create wiki page on project');
 
         // grab editions for first wiki page
         $editions = $wikimodel->getEditions(1);
@@ -49,12 +53,6 @@ public function testCreation()
         ];
 
         // create wiki page edition
-        
-        $authManager = new AuthenticationManager($this->container);
-        $authManager->register(new DatabaseAuth($this->container));
-
-        $_SESSION['user'] = array('id' => 1, 'username' => 'test', 'role' => 'app-admin');
-
         $this->assertTrue($this->container['userSession']->isLogged(), 'Failed to login');
 
         $this->userSession = new UserSession($this->container);
@@ -68,4 +66,34 @@ public function testCreation()
         $this->assertEquals('Security', $editions[0]['title']);
         $this->assertEquals('Some content', $editions[0]['content']);
     }
+
+    public function testReOrder(){
+
+        $projectModel = new ProjectModel($this->container);
+
+        $this->assertEquals($projectModel->create(array('name' => 'reorder')), 1, 'Failed to create project');
+
+        $project = $projectModel->getById(1);
+
+        $wikimodel = new Wiki($this->container);
+
+        // create wiki pages
+        $this->assertEquals(1, $wikimodel->createpage($project['id'], "Home", "", '2015-01-01'), 1, 'Failed to a create wiki page home on project');
+        $this->assertEquals(2, $wikimodel->createpage($project['id'], "Page 2", ""), 'Failed to a create wiki page 2 on project');
+        $this->assertEquals(3, $wikimodel->createpage($project['id'], "Page 3", ""), 'Failed to a create wiki page 3 on project');
+        $this->assertEquals(4, $wikimodel->createpage($project['id'], "Page 4", ""), 'Failed to a create wiki page 4 on project');
+        $this->assertEquals(5, $wikimodel->createpage($project['id'], "Page 5", ""), 'Failed to a create wiki page 5 on project');
+
+        // reorder
+        $wikimodel->reorderPages($project['id'], 5, 3);
+        // expected by id
+        $expectedColumnOrders = [1,2,4,5,3];
+
+        $wikiPages = $wikimodel->getWikipages($project['id']);
+        $this->assertEquals(count($expectedColumnOrders), count($wikiPages), 'expected column order count doesn\'t match pages');
+
+        for ($i=0; $i < count($expectedColumnOrders); $i++) { 
+            $this->assertEquals($expectedColumnOrders[$wikiPages[$i]['id']-1], $wikiPages[$i]['ordercolumn'], 'Failed to reorder page id:'. $wikiPages[$i]['id']);
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ class Plugin extends Base`
`11`	`11`	`public function initialize()`
`12`	`12`	`{`
`13`	`13`	`$this->projectAccessMap->add('WikiController', '*', Role::PROJECT_MEMBER);`
	`14`	`+ $this->projectAccessMap->add('WikiAjaxController', '*', Role::PROJECT_MEMBER);`
`14`	`15`	`$this->applicationAccessMap->add('WikiController', array('readonly','detail_readonly'), Role::APP_PUBLIC);`
`15`	`16`	`$this->projectAccessMap->add('WikiFileController', '*', Role::PROJECT_MEMBER);`
`16`	`17`	`$this->projectAccessMap->add('WikiFileViewController', '*', Role::PROJECT_MEMBER);`
`@@ -68,6 +69,9 @@ public function onStartup()`
`68`	`69`	`public function getClasses()`
`69`	`70`	`{`
`70`	`71`	`return array(`
	`72`	`+ 'Plugin\Wiki\Controller' => [`
	`73`	`+ 'WikiAjaxController'`
	`74`	`+ ],`
`71`	`75`	`'Plugin\Wiki\Model' => array(`
`72`	`76`	`'Wiki',`
`73`	`77`	`'WikiFile'`
`@@ -92,7 +96,7 @@ public function getPluginAuthor()`
`92`	`96`
`93`	`97`	`public function getPluginVersion()`
`94`	`98`	`{`
`95`		`- return '0.3.3';`
	`99`	`+ return '0.3.4';`
`96`	`100`	`}`
`97`	`101`
`98`	`102`	`public function getPluginHomepage()`