Add -sidebar option

to fix issue #147
gturri · May 5, 2023 · d768e3e · d768e3e
1 parent 0825c16
commit d768e3e
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 11 deletions.
diff --git a/_tests/src/test/java/nspages/Test_nsPath.java b/_tests/src/test/java/nspages/Test_nsPath.java
@@ -20,6 +20,22 @@ public void explicitDefaultPath(){
 		assertSameLinks(currentNsLinks());
 	}
 
+	@Test
+	// This test does not really represent an actual use case since this
+	// option is meant to be used in a sidebar (where the current ns is not
+	// the same as the one of the page where the nspages plugin is used)
+	// but this still makes sure that this case is not obviously broken
+	public void sidebarOptionUsesCurrentNamespace(){
+		generatePage("autrens:start", "<nspages -sidebar>");
+		assertSameLinks(currentNsLinks());
+	}
+
+	@Test
+	public void sidebarOptionDoesNotAcceptAnExplicitNs(){
+		generatePage("autrens:start", "<nspages -sidebar some_name>");
+		assertThat(getDriver().getPageSource(), JUnitMatchers.containsString("With the -sidebar option you cannot specify a namespace"));
+	}
+
 	@Test
 	public void unsafePath(){
 		generatePage("autrens:start", "<nspages ..:..>");

diff --git a/lang/en/lang.php b/lang/en/lang.php
@@ -14,3 +14,4 @@
 $lang['continued']             = ' cont.';
 $lang['nopages']               = 'No pages in this namespace.';
 $lang['nosubns']               = 'No subnamespaces.';
+$lang['sidebarOrNs']           = 'With the -sidebar option you cannot specify a namespace. Found: ';
diff --git a/lang/fr/lang.php b/lang/fr/lang.php
@@ -14,3 +14,4 @@
 $lang['continued']             = ' (suite)';
 $lang['nopages']               = 'Pas de pages dans cette catégorie.';
 $lang['nosubns']               = 'Pas de sous-catégories.';
+$lang['sidebarOrNs']           = 'Avec l\'option -sidebar il n\'est pas possible de spécifier de catégorie. Trouvé: ';
diff --git a/namespaceFinder.php b/namespaceFinder.php
@@ -16,10 +16,9 @@ function __construct($path){
         $this->sanitizeNs();
     }
 
-    private function computeWantedNs($path){
+    private function computeWantedNs($wantedNS){
         global $ID;
         $result = '';
-        $wantedNS = trim($path);
         if($wantedNS == '') {
             $wantedNS = $this->getCurrentNamespace();
         }
@@ -76,6 +75,10 @@ function isNsSafe(){
     }
 
     function getWantedDirectory(){
-        return utf8_encodeFN(str_replace(':', '/', $this->wantedNs));
+        return $this->namespaceToDirectory($this->wantedNs);
+    }
+
+    static function namespaceToDirectory($ns){
+        return utf8_encodeFN(str_replace(':', '/', $ns));
     }
 }
diff --git a/printers/printer.php b/printers/printer.php
@@ -52,9 +52,17 @@ function printTOC($tab, $type, $text, $hideno){
     abstract function _print($tab, $type);
 
     function printUnusableNamespace($wantedNS){
-         $this->renderer->section_open(1);
-         $this->renderer->cdata($this->plugin->getLang('doesntexist').$wantedNS);
-         $this->renderer->section_close();
+        $this->printError($this->plugin->getLang('doesntexist').$wantedNS);
+    }
+
+    function printErrorSidebarDoestAcceptNamespace($wantedNS){
+        $this->printError($this->plugin->getLang('sidebarOrNs').$wantedNS);
+    }
+
+    private function printError($errorMessage){
+        $this->renderer->section_open(1);
+        $this->renderer->cdata($errorMessage);
+        $this->renderer->section_close();
     }
 
     private function _printHeader(&$tab, $type, $text, $hideno) {

diff --git a/syntax.php b/syntax.php
@@ -68,6 +68,7 @@ function handle($match, $state, $pos, Doku_Handler $handler) {
         optionParser::checkOption($match, "(modification)?Dates?OnPictures?", $return['modificationDateOnPictures'], true);
         optionParser::checkOption($match, "displayModificationDates?", $return["displayModificationDate"], true);
         optionParser::checkOption($match, "includeItemsInTOC", $return["includeItemsInTOC"], true);
+        optionParser::checkOption($match, "sidebar", $return["sidebar"], true);
         optionParser::checkRecurse($match, $return['maxDepth']);
         optionParser::checkNbColumns($match, $return['nbCol']);
         optionParser::checkSimpleStringArgument($match, $return['textPages'], $this, 'textPages');
@@ -91,10 +92,16 @@ function handle($match, $state, $pos, Doku_Handler $handler) {
         optionParser::checkSimpleStringArgument($match, $return['defaultPicture'], $this, 'defaultPicture');
 
         //Now, only the wanted namespace remains in $match
-        $nsFinder = new namespaceFinder($match);
-        $return['wantedNS'] = $nsFinder->getWantedNs();
-        $return['safe'] = $nsFinder->isNsSafe();
-        $return['wantedDir'] = $nsFinder->getWantedDirectory();
+        $match = trim($match);
+        if ($return["sidebar"]) {
+            // Don't bother resolving or sanitizing now: it will be done at render-time in this mode
+            $return['wantedNS'] = $match;
+        } else {
+            $nsFinder = new namespaceFinder($match);
+            $return['wantedNS'] = $nsFinder->getWantedNs();
+            $return['safe'] = $nsFinder->isNsSafe();
+            $return['wantedDir'] = $nsFinder->getWantedDirectory();
+        }
 
         return $return;
     }
@@ -119,7 +126,7 @@ private function _getDefaultOptions(){
             'modificationDateOnPictures' => false,
             'displayModificationDate' => false,
             'sortByCreationDate' => false, 'defaultPicture' => null, 'tree' => false,
-            'includeItemsInTOC' => false
+            'includeItemsInTOC' => false, 'sidebar' => false,
         );
     }
 
@@ -137,6 +144,24 @@ function render($mode, Doku_Renderer $renderer, $data) {
         $this->_denullifyPictureOptions($data);
         $printer = $this->_selectPrinter($mode, $renderer, $data);
 
+        if ($data['sidebar']) {
+            if ($data['wantedNS'] !== '') {
+                $printer->printErrorSidebarDoestAcceptNamespace($data['wantedNS']);
+                return TRUE;
+            }
+            if ($mode === "metadata") {
+                // In this case $INFO is null so there is not much we can do,
+                // but anyway in "sidebar" mode we're not really going to generate metadata of the current page
+                // so it rather makes sense to exiting without printing anything.
+                return TRUE;
+            }
+            global $INFO;
+            $data['wantedNS'] = $INFO['namespace'];
+            $data['safe'] = true;
+            $data['wantedDir'] = namespaceFinder::namespaceToDirectory($data['wantedNS']);
+        }
+
+
         if( ! $this->_isNamespaceUsable($data)){
             $printer->printUnusableNamespace($data['wantedNS']);
             return TRUE;