BugTrack/2213 Use relative path for internal link - get_base_uri()

Add URI type enum.

* PKWK_URI_RELATIVE : relative path (ex: ./, index.php )
* PKWK_URI_ROOT : Root relative path (ex: /wiki/)
* PKWK_URI_ABSOLUTE : Absolute URI (ex: http://example.com/wiki/)

We will use get_base_uri() to make internal link.

get_base_uri(): returns simple URL that indicates this script(PukiWiki)

For example for 'http://example.com/wiki/' site,

* `get_base_uri()` returns './'
* `get_base_uri(PKWK_URI_ROOT)` returns '/wiki/'
* `get_base_uri(PKWK_URI_ABSOLUTE)` returns 'http://example.com/wiki/'

get_page_uri($page) returns simple URL that indicates specific page.

For example,

* `get_page_uri('News')` returns './?News'
* `get_page_uri('News', PKWK_URI_ROOT)` returns '/wiki/?News'
* `get_page_uri('News', PKWK_URI_ABSOLUTE)` returns
  'https://example.com/wiki/?News'

diff --git a/lib/func.php b/lib/func.php
index aad74a5..4ac9eb3 100644 (file)
--- a/lib/func.php
+++ b/lib/func.php
@@ -8,6 +8,14 @@
 //
 // General functions
 
+// URI type enum
+/** Relative path. */
+define('PKWK_URI_RELATIVE', 0);
+/** Root relative URI. */
+define('PKWK_URI_ROOT', 1);
+/** Absolute URI. */
+define('PKWK_URI_ABSOLUTE', 2);
+
 function pkwk_log($message)
 {
        $log_filepath = 'log/error.log.php';
@@ -691,41 +699,99 @@ function get_autolink_pattern_sub(& $pages, $start, $end, $pos)
        return $result;
 }
 
-// Get absolute-URI of this script
-function get_script_uri($init_uri = '')
+/**
+ * Get propery URI of this script
+ *
+ * @param $uri_type relative or absolute option
+ *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
+ */
+function get_base_uri($uri_type = PKWK_URI_RELATIVE)
 {
-       global $script_directory_index;
-       static $script;
+       switch ($uri_type) {
+       case PKWK_URI_RELATIVE:
+               return pkwk_script_uri_base(PKWK_URI_RELATIVE);
+       case PKWK_URI_ROOT:
+               return pkwk_script_uri_base(PKWK_URI_ROOT);
+       case PKWK_URI_ABSOLUTE:
+               return pkwk_script_uri_base(PKWK_URI_ABSOLUTE);
+       default:
+               die_message('Invalid uri_type in get_base_uri()');
+       }
+}
 
-       if ($init_uri == '') {
-               // Get
-               if (isset($script)) return $script;
+/**
+ * Get URI of the page
+ *
+ * @param page page name
+ * @param $uri_type relative or absolute option
+ *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
+ */
+function get_page_uri($page, $uri_type = PKWK_URI_RELATIVE)
+{
+       return get_base_uri($uri_type) . '?' . pagename_urlencode($page);
+}
 
-               // Set automatically
-               $msg     = 'get_script_uri() failed: Please set $script at INI_FILE manually';
-               $script = guess_script_absolute_uri();
-               if (! is_url($script, TRUE) && php_sapi_name() == 'cgi')
-                       die_message($msg);
-               unset($msg);
+// Get absolute-URI of this script
+function get_script_uri()
+{
+       return get_base_uri(PKWK_URI_ABSOLUTE);
+}
 
-       } else {
-               // Set manually
-               if (isset($script)) die_message('$script: Already init');
-               if (! is_url($init_uri, TRUE)) die_message('$script: Invalid URI');
-               $script = $init_uri;
+/**
+ * Get or initialize Script URI
+ *
+ * @param $uri_type relative or absolute potion
+ *        PKWK_URI_RELATIVE, PKWK_URI_ROOT or PKWK_URI_ABSOLUTE
+ * @param $initialize true if you initialize URI
+ * @param $uri_set URI set manually
+ */
+function pkwk_script_uri_base($uri_type, $initialize, $uri_set)
+{
+       global $script_directory_index;
+       static $initialized = false;
+       static $uri_absolute, $uri_root, $uri_relative;
+       if (! $initialized) {
+               if (isset($initialize) && $initialize) {
+                       if (isset($uri_set)) {
+                               $uri_absolute = $uri_set;
+                       } else {
+                               $uri_absolute = guess_script_absolute_uri();
+                       }
+                       // Support $script_directory_index (cut 'index.php')
+                       if (isset($script_directory_index)) {
+                               $slash_index = '/' . $script_directory_index;
+                               $len = strlen($slash_index);
+                               if (substr($uri_absolute,  -1 * $len) === $slash_index) {
+                                       $uri_absolute = substr($uri_absolute, 0, strlen($uri_absolute) - $len + 1);
+                               }
+                       }
+                       $elements = parse_url($uri_absolute);
+                       $uri_root = $elements['path'];
+                       if (substr($uri_root, -1) === '/') {
+                               $uri_relative = './';
+                       } else {
+                               $pos = mb_strrpos($uri_root, '/');
+                               if ($pos >= 0) {
+                                       $uri_relative = substr($uri_root, $pos + 1);
+                               } else {
+                                       $uri_relative = $uri_root;
+                               }
+                       }
+                       $initialized = true;
+               } else {
+                       die_message('Script URI must be initialized in pkwk_script_uri_base()');
+               }
        }
-
-       // Cut filename or not
-       if (isset($script_directory_index)) {
-               if (! file_exists($script_directory_index))
-                       die_message('Directory index file not found: ' .
-                               htmlsc($script_directory_index));
-               $matches = array();
-               if (preg_match('#^(.+/)' . preg_quote($script_directory_index, '#') . '$#',
-                       $script, $matches)) $script = $matches[1];
+       switch ($uri_type) {
+       case PKWK_URI_RELATIVE:
+               return $uri_relative;
+       case PKWK_URI_ROOT:
+               return $uri_root;
+       case PKWK_URI_ABSOLUTE:
+               return $uri_absolute;
+       default:
+               die_message('Invalid uri_type in pkwk_script_uri_base()');
        }
-
-       return $script;
 }
 
 /**

diff --git a/lib/init.php b/lib/init.php
index bd7f540..e067b90 100644 (file)
--- a/lib/init.php
+++ b/lib/init.php
@@ -134,9 +134,11 @@ $weeklabels = $_msg_week;
 // INI_FILE: Init $script
 
 if (isset($script)) {
-       get_script_uri($script); // Init manually
+       // Init manually
+       pkwk_script_uri_base(PKWK_URI_ABSOLUTE, true, $script);
 } else {
-       $script = get_script_uri(); // Init automatically
+       // Init automatically
+       $script = pkwk_script_uri_base(PKWK_URI_ABSOLUTE, true);
 }
 
 // INI_FILE: Auth settings