URLカスタマイズの仕組み

メッセージ

PukiWiki の定番のカスタマイズとして、ページURLを変えるものがある。これを本体書き換え無しで行うための仕組みを導入する。

URL (path, query 部分) の例

「階層1/名前」というページの場合

実動作サンプル

(1) 通常

(2) 末尾 (ページ名).html

pukiwiki.ini.php

// Page-URI mapping handler ( See https:// pukiwiki.osdn.jp/?PukiWiki/PageURI )
class HtmlSuffixPageURIHandler extends PukiWikiStandardPageURIHandler {
	function get_page_uri_virtual_query($page) {
		return '?' . pagename_urlencode($page) . '.html';
	}

	function get_page_from_query_string($query_string) {
		$param1st = preg_replace("#^([^&]*)&.*$#", "$1", $query_string);
		if ($param1st == '') {
			return null; // default page
		}
		if (strpos($param1st, '=') !== FALSE) {
			// Found '/?key=value' (NG chars)
			return FALSE; // Error page
		}
		$base = preg_replace('#\.html$#', '', $param1st);
		if ($param1st === $base) {
			return FALSE; // Error
		}
		$page = urldecode($base);
		$page2 = input_filter($page);
		if ($page !== $page2) {
			return FALSE; // Error page
		}
		return $page2;
	}
}
$page_uri_handler = new HtmlSuffixPageURIHandler();

(3) ページ名を path に見せる

ページ名の前に '?' がつかず、ページがそのままサーバー上のファイルのように見えるURL

pukiwiki.ini.php:

image ディレクトリ

define('IMAGE_DIR', '/_samples/3/image/');

トップページの絶対URL

$script = 'https:// pukiwiki.osdn.jp/_samples/3/';

パスのカスタマイズ ('?' をつけない)

各ページで相対パスでなくルート相対パスを利用するために pkwk_base_uri_type_stack_push(PKWK_URI_ROOT); を実行しておく。

// Page-URI mapping handler ( See https:// pukiwiki.osdn.jp/?PukiWiki/PageURI )
class VirtualPathPageURIHandler extends PukiWikiStandardPageURIHandler {
       function get_page_uri_virtual_query($page) {
               return pagename_urlencode($page);
       }
}
pkwk_base_uri_type_stack_push(PKWK_URI_ROOT);
$page_uri_handler = new VirtualPathPageURIHandler();

.htaccess

このカスタマイズはPHPだけでは実現できず、Webサーバー側でパスをクエリ文字列に変換する必要がある。 Apacheでの指定は以下のようになる。

RewriteEngine On
RewriteCond %{REQUEST_URI} !(^/_samples/3/$)
RewriteCond %{REQUEST_URI} !(^/_samples/3/image/)
RewriteCond %{REQUEST_URI} !(^/_samples/3/skin/)
RewriteCond %{REQUEST_FILENAME} !(\.php$)
RewriteRule ^(.+)$ /_samples/3/?$1

意味: path が /, /image/..., /skin/... 以外の場合は /?{path} というリクエストに変換する

/skin/pukiwiki.skin.php

スキンファイルもいくつか、参照ファイルをルート相対パスで指定する必要がある。 (ここでは一部のみ抜粋)

<link rel="stylesheet" type="text/css" href="/_samples/3/<?php echo SKIN_DIR ?>pukiwiki.css" />
<script type="text/javascript" src="/_samples/3/skin/main.js" defer></script>

(6) 短縮URLプラグイン (s.inc.php) による常時短縮URLのカスタマイズ

pukiwiki.ini.php:

// Page-URI mapping handler ( See https:// pukiwiki.osdn.jp/?PukiWiki/PageURI )
class ShortUrlPageURIHandler extends PukiWikiStandardPageURIHandler {
	function get_page_uri_virtual_query($page) {
		exist_plugin('s'); // Load s.inc.php
		$page_id = plugin_s_get_page_id($page);
		if ($page_id) {
			return '?&' . $page_id;
		}
		return '?' . pagename_urlencode($page);
	}

	function get_page_from_query_string($query_string) {
		exist_plugin('s'); // Load s.inc.php
		$m = array();
		if (preg_match('#^\&([0-9a-f]{10})$#', $query_string, $m)) {
			$page = plugin_s_get_page_from_page_id($m[1]);
			return $page;
		}
		return parent::get_page_from_query_string($query_string);
	}
}
$page_uri_handler = new ShortUrlPageURIHandler();

注意: ページURLを取得するのにファイル生成またはファイル存在チェックを伴うため、ページ数が数万となるような大規模サイトでは一覧などでパフォーマンスの低下が発生します。

(7) 短縮URLプラグイン (s.inc.php) によるリダイレクトのカスタマイズ

pukiwiki.ini.php:

// Page-URI mapping handler ( See https:// pukiwiki.osdn.jp/?PukiWiki/PageURI )
class ShortUrlRedirectPageURIHandler extends PukiWikiStandardPageURIHandler {
	function filter_raw_query_string($query_string) {
		$m = array();
		if (preg_match('#^\&([0-9a-f]{10})$#', $query_string, $m)) {
			return 'cmd=s&k=' . $m[1];
		}
		return $query_string;
	}
}
$page_uri_handler = new ShortUrlRedirectPageURIHandler();

URLカスタマイズの2パターン

表示に関わる

参照

対象

設計

クラス 
class PukiWikiStandardPageURIHandler {
  // QueryStringの変換
  function filter_raw_query_string($query_string);
  // ページ名からURIのページ表現部分を生成
  function get_page_uri_fragment($page);
  // クエリストリングからページ名を取得
  function get_page_from_query_string($query_string);
}

lib/init.php:397

// cmdもpluginも指定されていない場合は、QUERY_STRINGをページ名かInterWikiNameであるとみなす
if (! isset($vars['cmd']) && ! isset($vars['plugin'])) {

	$get['cmd']  = $post['cmd']  = $vars['cmd']  = 'read';

	$arg = preg_replace("#^([^&]*)&.*$#", "$1", $arg);
	if ($arg == '') $arg = $defaultpage;
	if (strpos($arg, '=') !== false) $arg = $defaultpage; // Found '/?key=value'
	$arg = urldecode($arg);
	$arg = strip_bracket($arg);
	$arg = input_filter($arg);
	$get['page'] = $post['page'] = $vars['page'] = $arg;
}

対応していないプラグインへの対応

各ページへのリンクURL取得手段として PukiWiki 1.5.2 から導入された get_page_uri($page) を利用していないプラグインはカスタムURL対応になりません。

ページURLに get_page_uri($page) を利用するよう書き換えてください。

カスタマイズ内容

(URL生成) 各ページのURL は get_base_uri() + 「ページを表すURL片」で表現される。 (例: "?FrontPage", "?BugTrack/2525") ページ名を引数にしてこの「ページを表すURL片」の生成する関数を登録できるようにする。

(ページの表示) 「ページを表すURL片」を受け取って、表示(または別のプラグインアクション)を行う関数を登録できるようにする。

既存ロジック不明なところ

make_link.php

クラス Link_interwikiname - function set()

		$url = get_interwiki_url($name, $this->param);
		$this->url = ($url === FALSE) ?
			get_base_uri() . '?' . pagename_urlencode('[[' . $name . ':' . $this->param . ']]') :
			htmlsc($url);

? に続けて [[ name : param ]] を設定しているがこの記述で read しようとするとエラーになる。どういう条件でここに入るのか不明




トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2022-01-10 (月) 18:40:46
Site admin: PukiWiki Development Team

PukiWiki 1.5.4+ © 2001-2021 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u12. HTML convert time: 0.338 sec.

OSDN