$NSORID$ filter place holder. implements #712

This filter will return the current page unless when called on a
namespace start page where it will return the namespace instead.

Author: splitbrain

_test/SearchConfigTest.php

@@ -33,6 +33,40 @@ public function test_filtervars_simple()
         $this->assertEquals(date('Y-m-d'), $searchConfig->applyFilterVars('$DATE(now)$'));
     }
 
+    public function test_filtervars_nsorid()
+    {
+        global $INFO;
+
+
+        $searchConfig = new SearchConfig([]);
+
+        // normal page
+        $INFO['id'] = 'foo:bar:baz';
+        $this->assertEquals('foo:bar:baz', $searchConfig->applyFilterVars('$NSORID$'));
+
+        // start page: start in namespace
+        $INFO['id'] = 'foo:bar:start';
+        saveWikiText($INFO['id'], 'start page', 'start created');
+        $this->assertEquals('foo:bar', $searchConfig->applyFilterVars('$NSORID$'));
+        saveWikiText($INFO['id'], '', 'start page deleted');
+        clearstatcache();
+
+        // start page: same as namespace in namespace
+        $INFO['id'] = 'foo:bar:bar';
+        saveWikiText($INFO['id'], 'start page', 'start created');
+        $this->assertEquals('foo:bar', $searchConfig->applyFilterVars('$NSORID$'));
+        saveWikiText($INFO['id'], '', 'start page deleted');
+        clearstatcache();
+
+        // start page: same as namespace in above namespace
+        // incidally this is the same as a normal page
+        $INFO['id'] = 'foo:bar';
+        saveWikiText($INFO['id'], 'start page', 'start created');
+        $this->assertEquals('foo:bar', $searchConfig->applyFilterVars('$NSORID$'));
+        saveWikiText($INFO['id'], '', 'start page deleted');
+        clearstatcache();
+    }
+
     public function test_filtervars_struct()
     {
         global $INFO;

meta/SearchConfig.php

@@ -2,6 +2,8 @@
 
 namespace dokuwiki\plugin\struct\meta;
 
+use dokuwiki\File\PageResolver;
+
 /**
  * Class SearchConfig
  *
@@ -116,6 +118,7 @@ protected function applyFilterVars($filter)
         if (!isset($INFO['id'])) {
             $INFO['id'] = '';
         }
+        $ns = getNS($INFO['id']);
 
         // apply inexpensive filters first
         $filter = str_replace(
@@ -128,14 +131,30 @@ protected function applyFilterVars($filter)
             ],
             [
                 $INFO['id'],
-                getNS($INFO['id']),
+                $ns,
                 noNS($INFO['id']),
                 $INPUT->server->str('REMOTE_USER'),
                 date('Y-m-d')
             ],
             $filter
         );
 
+        // apply namespace or id placeholder #712
+        // returns the namespace for start pages, otherwise the ID
+        if (preg_match('/\$NSORID\$/', $filter)) {
+            $resolver = new PageResolver('');
+
+            $start = $resolver->resolveId($ns . ':');
+            if($start === $INFO['id']) {
+                // This is a start page, we return the namespace
+                $val = $ns;
+            } else {
+                // This is a normal page, we return the ID
+                $val = $INFO['id'];
+            }
+            $filter = str_replace('$NSORID$', $val, $filter);
+        }
+
         // apply struct column placeholder (we support only one!)
         // or apply date formula, given as strtotime
         if (preg_match('/^(.*?)(?:\$STRUCT\.(.*?)\$)(.*?)$/', $filter, $match)) {