Pukiwiki設定入門

医者の場合、内科が心臓外科手術ができなくても、
脳外科医が耳鼻科の診察ができなくても、誰も不思議には思わない。
個々に専門分野があると認知されているからだ。

車でも、エンジンの設計している技術者が、ギアチェンジの部分や
内装のデザインができなくても文句は言われない。

だが、コンピューターの場合は、全体で1つの分野と思われている。
ネットワークもデータベースも普通の人から見れば、
同じコンピューターというわけだ。

その上、コンピューターの場合、表面的な知識やソフトの操作だけでも、
ある程度の事ができてしまう事に大きな問題がある。
そのため「俺でもできるから、君はできて当然」という発想が生まれる。

だが、IT担当者は、表面的な知識だけでの操作や運用が許されない
トラブルが発生すると、対処しなければならないからだ。

トラブルの対処を行うには、動作の仕組みなどを知る必要があり、
それには、ある程度のレベルを超えなければならない。
だが、ある程度のレベルを超えて、踏み込んだ場合、必要とされる知識が
一気に増える。しかも専門性も高くなり、学習に時間がかかる。
そのため、専門知識の習得に追われっぱなしのIT担当者とは裏腹に
普通の人から見れば「積極性がない」と映る。

ホームページビルダーは初心者がホームページを作成する分には
HTML言語を覚える必要がないため、手軽な面がある。

だが、手軽さが厄介な問題を引き起こす事がある。
HTML言語を知らなくても作成できる反面、
生成されるHTMLソースを意識しないで作成するために
厄介な問題を引き起こす。ここが大きな落し穴となる。

例えば、画面を分割させる表示を行う時、フレームで分けるのか
それともテーブルや<div>のタグを使うのかを意識しない場合、
どんなソースかが中身を見てみないと、わからない。
そのため、別の人が変更を行う際、全体像を把握するために
HTMLを解読しないといけないのだ。これは大きな問題だ。

吐き出されるHTMLのタグは、ゴチャゴチャして非常に読みずらい上
CSSやJavaScriptなども埋め込まれる場合もあるため、
それらの知識がないとソースが読めない場合もあり、
解読するのに立ちふさがる厄介な問題だ。

特に「どこでも配置モード」で作成された場合は、
<div>タグだらけの発狂しそうなHTMLのソースになる。

個人で利用する分には良いかもしれないが、
複数人でメンテナンスを行うには不向きなのだ。

特に、ホームページビルダーの様々な機能を使ったホームページの場合、
吐き出されるHTLMソースを見ると、おぞましい状態になっている。
とても読む気が起こらない・・・

PHPおよびMySQLが利用可能なサーバであれば、
約 5 分でインストールでき、直ちに当サイトのような
ユーザ登録型コミュニティサイトを立ち上げることが可能です。

消したい部分を赤と青で囲んでみた。

// SKIN_DEFAULT_DISABLE_TOPICPATH
//   1 = Show reload URL
//   0 = Show topicpath
if (! defined('SKIN_DEFAULT_DISABLE_TOPICPATH'))
        define('SKIN_DEFAULT_DISABLE_TOPICPATH', 1); // 1, 0

// Show / Hide navigation bar UI at your choice
// NOTE: This is not stop their functionalities!
if (! defined('PKWK_SKIN_SHOW_NAVBAR'))
        define('PKWK_SKIN_SHOW_NAVBAR', 0); // 1, 0

// Show / Hide toolbar UI at your choice
// NOTE: This is not stop their functionalities!
if (! defined('PKWK_SKIN_SHOW_TOOLBAR'))
        define('PKWK_SKIN_SHOW_TOOLBAR', 0); // 1, 0

青い部分が上の図のnavigatorの部分を表示させるかどうかの設定。
赤い部分が上の図のtoolbarの部分を表示させるかどうかの設定

初期設定では定数を「1」に設定しているのだが、
ともに定数を「0」に設定してしまえば、表示されなくなる。

<div id="footer">
 Site admin: <a href="<?php echo $modifierlink ?>"><?php echo $modifier ?></a><p />
 <?php echo S_COPYRIGHT ?>.
 Powered by PHP <?php echo PHP_VERSION ?>. HTML convert time: <?php echo $taketime ?> sec.
</div>

// SKIN_DEFAULT_DISABLE_TOPICPATH
//   1 = Show reload URL
//   0 = Show topicpath
if (! defined('SKIN_DEFAULT_DISABLE_TOPICPATH'))
        define('SKIN_DEFAULT_DISABLE_TOPICPATH', 0); // 1, 0

初期設定では定数を「1」に設定しているのだが、
定数を「0」に設定してしまえば、表示されなくなる。

<?php if ($notes != '') { ?>
<div id="note"><?php echo $notes ?></div>
<?php } ?>

<?php if ($attaches != '') { ?>
<div id="attach">
<?php echo $hr ?>
<?php echo $attaches ?>
</div>
<?php } ?>

<?php echo $hr ?>

<?php if ($lastmodified != '') { ?>
<div id="lastmodified">Last-modified: <?php echo $lastmodified ?></div>
<?php } ?>

<?php if ($related != '') { ?>
<div id="related">Link: <?php echo $related ?></div>
<?php } ?>

/////////////////////////////////////////////////
require(LIB_DIR . 'pukiwiki.php');

/////////////////////////////////////////////////
require(LIB_DIR . 'pukiwiki-kanri.php');

// 初期化: 設定ファイルの読み込み
require(LIB_DIR . 'init.php');

// 初期化: 設定ファイルの読み込み
require(LIB_DIR . 'init-kanri.php');

// Require INI_FILE

define('INI_FILE',  DATA_HOME . 'pukiwiki.ini.php');

// Require INI_FILE

define('INI_FILE',  DATA_HOME . 'pukiwiki-kanri.ini.php');

// Loose default: Including something Mozilla
array('pattern'=>'#^([a-zA-z0-9 ]+)/([0-9\.]+)\b#',     'profile'=>'default'),

array('pattern'=>'#^#', 'profile'=>'default'),  // Sentinel

// Loose default-kanri: Including something Mozilla
array('pattern'=>'#^([a-zA-z0-9 ]+)/([0-9\.]+)\b#',     'profile'=>'default-kanri'),

array('pattern'=>'#^#', 'profile'=>'default-kanri'),    // Sentinel

// Skin file

if (defined('TDIARY_THEME')) {
        define('SKIN_FILE', DATA_HOME . SKIN_DIR . 'tdiary.skin.php');
} else {
        define('SKIN_FILE', DATA_HOME . SKIN_DIR . 'pukiwiki.skin.php');
}

// Skin file

if (defined('TDIARY_THEME')) {
        define('SKIN_FILE', DATA_HOME . SKIN_DIR . 'tdiary.skin.php');
} else {
        define('SKIN_FILE', DATA_HOME . SKIN_DIR . 'pukiwiki-kanri.skin.php');
}

<Hn>タグは「見出し」のタグだという。
初期設定では<H1>が一番大きく、<H6>が一番小さな文字の
見出しの表示になる。
このタグの前後は改行が入るため、文章の中で一部分だけ
文字の大きさを変えるのには向いていない。
そのため<FONT>タグを使うのが無難。

さて、CSSを使えば、<H1>タグの設定が行えるため、
<H1>より<H2>、<H2>よりも<H3>の方が
大きな文字の見出しにする事も可能だ。

h1 {
   font-size:100%;
   }

h2 {
   font-size:150%;
   }

h3 {
   font-size:200%;
   }

<HTML><HEAD><TITLE>CSSの実験</TITLE></HEAD>
<META http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" media="screen,tv" HREF="style.css">
<BODY BGCOLOR="WHITE">

<H1>ああ</H1>

<H2>いい</H2>

<H3>うう</H3>

</BODY></HTML>

h1 {
   font-size:100%;
   }

h2 {
   font-size:150%;
   }

h3 {
   font-size:200%;
   }

文字の周囲の余白で、margin(マージン)という物がある。
この余白部分の色や余白の厚みをCSSを使って指定する事ができる。

そもそも、マージン(Margin)とは一体何なのか。
英語をそのまま使うから意味がわかりにくいし
覚えにくくする要因にもなる。
そこで、英英辞典で調べると marginの意味は次の通りだった。
the blank space round the written or printed matter or page

つまり「文章などが書かれた部分を囲んだ周囲の余白」という意味だ。

ITの技術が日本初だと、言葉の問題で技術の理解を阻害される事はないが
発祥の地が英語圏の場合、言葉の壁があるため、この問題が付きまとう。

まぁ、和製英語で混乱するよりも、英語圏の人が名付けた方が
マシだと思う場合もあるのだが・・・

余白(Margin)は、上・下・右・左に分割する事ができる。
これにより上の余白部分は青で、右の余白部分は緑という指定ができる。
もちろん、上の余白と、下の余白とでは厚みの指定を別にする事が可能だ。

<HTML><HEAD><TITLE>CSSの実験</TITLE></HEAD>
<META http-equiv="Content-Style-Type" content="text/css">
<link rel="stylesheet" media="screen,tv" HREF="style2.css">
<BODY BGCOLOR="WHITE">

<H1>ああ</H1>

<H2>いい</H2>

<H3>うう</H3>

<H4>ええ</H4>

<H5>おお</H5>

</BODY></HTML>

h1 { 
   font-size:150%;
   border-top:10px solid ORANGE;
   }

h2 {
   font-size:150%;
   border-left:10px solid BLUE;
   }

h3 {
   font-size:150%;
   border-bottom:10px solid RED;
   }

h4 {
   font-size:150%;
   border-right:10px solid GREEN;
   }

h5 {
   font-size:150%;
   border-top:10px solid ORANGE;
   border-left:10px solid BLUE;
   border-right:10px solid RED;
   border-bottom:10px solid GREEN;
   }

頭にヘッダー部分が来て、その下の部分はメニューの表示部分と
コンテンツの表示部分がやってくる。

メニューの表示部分とコンテンツの表示部分だが、
<table>タグを使って、分けている。フレームではないし、
<div>タグだけを使って場所を指定しているわけではない。

<?php if (arg_check('read') && exist_plugin_convert('menu')) { ?>
<table border="0" style="width:100%">
 <tr>
  <td class="menubar">
   <div id="menubar"><?php echo do_plugin_convert('menu') ?></div>
  </td>
  <td valign="top">
   <div id="body"><?php echo $body ?></div>
  </td>
 </tr>
</table>
<?php } else { ?>
<div id="body"><?php echo $body ?></div>
<?php } ?>

// | title1 | title2 | title3 |
// | cell1  | cell2  | cell3  |
// | cell4  | cell5  | cell6  |
class Table extends Element
{
        var $type;
        var $types;
        var $col; // number of column

        function Table($out)
        {

(以下省略)

// Face marks, Japanese style
'\s(\(\^\^\))'  => ' <img alt="$1" src="' . IMAGE_DIR . 'face/smile.png" />',
'\s(\(\^-\^)'   => ' <img alt="$1" src="' . IMAGE_DIR . 'face/bigsmile.png" />',
'\s(\(\.\.;)'   => ' <img alt="$1" src="' . IMAGE_DIR . 'face/oh.png" />',
'\s(\(\^_-\))'  => ' <img alt="$1" src="' . IMAGE_DIR . 'face/wink.png" />',
'\s(\(--;)'     => ' <img alt="$1" src="' . IMAGE_DIR . 'face/sad.png" />',
'\s(\(\^\^;)'   => ' <img alt="$1" src="' . IMAGE_DIR . 'face/worried.png" />',
'\s(\(\^\^;\))' => ' <img alt="$1" src="' . IMAGE_DIR . 'face/worried.png" />',

PostgreSQL + PHP で検索システムを構築する際に、
PostgreSQLに関連するPHPの関数で、返り値がオブジェクトの物がある。

pg_fetch_object()関数だ。
引数に、SQLの実行結果のIDと、SQLの実行結果で取り出したいレコードの行番号。
返り値に、取り出したいレコード行のデータが入ったオブジェクトが入る。

以下のような形で使われる。

// PostgreSQLに接続する
$connect = pg_connect("host=HOSTNAME port=5432 dbname=DBNAME 
                       user=ID password=PASSWORD");

// SQL文を $sql変数に覚えさせる
$sql = "SELECT * FROM table";

// SQLの実行結果のIDを返す
$execid = pg_exec($connect,$sql);

// 実行結果のレコードから4番目のレコードを取り出し、
// $qrecオブジェクトに入れる
// レコードは0番目から始まるため、数字が1ずれるので注意が必要！
$qrec = pg_fetch_object($execid,3);

//  オブジェクト $qrec に入ったデータを取り出す
$name    = $qrec->name ;
$address = $qrec->address ;
$tel     = $qrec->tel ;

私が幼稚園か小学校低学年の頃にテレビで放送されていた。
バームクーヘンのような、輪切りにされたマンモスの肉が
美味しそうに思えたりした。

アニメでは、人が大声で叫ぶと声が石化して飛んでいく。
そのため、主人公のゴンが石化した声に乗って遠くへ移動したりする。

貨幣は5円玉、50円玉のように真中に穴の空いた丸い石で、
貨幣価値は石の大きさで決まるため、高価な物を手に入れるため
大きな石を転がす部分も覚えている。

25年くらい前の記憶だが、結構、覚えていたりするぐらい
印象のあるアニメだった。

// Output
catbody($title, $page, $body);
exit;

<div id="header">
 <a href="<?php echo $link['top'] ?>"><img id="logo" 
 src="<?php echo IMAGE_DIR . $image['logo'] ?>" width="80" 
 height="80" alt="[PukiWiki]" title="[PukiWiki]" /></a>

 <h1 class="title"><?php echo $page ?></h1>

<?php if (arg_check('read') && exist_plugin_convert('menu')) { ?>
<table border="0" style="width:100%">
 <tr>
  <td class="menubar">
   <div id="menubar"><?php echo do_plugin_convert('menu') ?></div>
;
  </td>
  <td valign="top">
   <div id="body"><?php echo $body ?></div>
  </td>
 </tr>
</table>
<?php } else { ?>
<div id="body"><?php echo $body ?></div>
<?php } ?>

この時点では、lib/pukiwiki.phpのソースを理解したわけでないため
当てずっぽで、この部分に目をつけたのだった。
だが、珍しく私の勘が当たり、正しい所に目をつけたのだった (^^;;

get_source()は、lib/file.phpの中で定義された関数で
convert_html()は、lib/convert_html.phpの中で定義された関数だ。

function get_source($page = NULL, $lock = TRUE)
{
        $array = array();

        if (is_page($page)) {
                $path  = get_filename($page);

                if ($lock) {
                        $fp = @fopen($path, 'r');
                        if ($fp == FALSE) return $array;
                        flock($fp, LOCK_SH);
                }

                // Removing line-feeds: Because file() doesn't remove them.
                $array = str_replace("\r", '', file($path));

                if ($lock) {
                        flock($fp, LOCK_UN);
                        @fclose($fp);
                }
        }

        return $array;
}

初め、このソースを見て「あれ?」と思いました。

function get_source($page = NULL, $lock = TRUE)
の部分ですが、$page = NULL と  $lock = TRUE があります。
なんで、こんな記述をするのかと思い、調べてみましたら、
次の意味がある事を知りました。

この関数を呼び出す時に  get_source() という事で
引数を記述しなかった場合、関数の中では仮引数の値が決まりません。
そこで、デフォルト値として、$page = NULL と  $lock = TRUE と設定し、
get_source("aaa",FALSE) とすれば、関数の中の仮引数は
それぞれ、$page = "aaa" 、 $lock = FALSE の値になります。
 
関数に引数を代入しない場合と、代入する場合の2つに備えた
設定というわけです。

get_source()の中では上の図のような処理が行われている。

仮引数 $page (ページ名)を、get_filename()の中に代入しています。
get_filename()の中では、ページ名から該当のファイル名を割り出します

そして、割り出されたファイル名から file()関数を使って、
ファイルの中身を、1行、1行、配列の中に格納していきます。

その配列はget_source()の返り値になります。

suga@wiki[~/src/pukiwiki-1.4.6/wiki]% ls
3A52656E616D654C6F67.txt
3A636F6E666967.txt
3A636F6E6669672F5061676552656164696E67.txt
3A636F6E6669672F5061676552656164696E672F64696374.txt
3A636F6E6669672F706C7567696E.txt
3A636F6E6669672F706C7567696E2F6174746163682F6D696D652D74797065.txt
3A636F6E6669672F706C7567696E2F726566657265722F636F6E666967.txt
3A636F6E6669672F706C7567696E2F747261636B6572.txt
3A636F6E6669672F706C7567696E2F747261636B65722F64656661756C74.txt
3A636F6E6669672F706C7567696E2F747261636B65722F64656661756C742F666F726D.txt

function convert_html($lines)
{
        global $vars, $digest;
        static $contents_id = 0;

        // Set digest
        $digest = md5(join('', get_source($vars['page'])));

        if (! is_array($lines)) $lines = explode("\n", $lines);

        $body = & new Body(++$contents_id);
        $body->parse($lines);

        return $body->toString();
}

$body->parse($lines); は、配列に格納されているファイルの中身の
データを処理する部分だ。
これは、Pukiwiki独自のタグを解析して、HTMLのタグに変換している。

そして、最終的な処理を $body->toString(); で行っている。

        function parse(& $lines)
        {
                $this->last = & $this;
                $matches = array();

                while (! empty($lines)) {
                        $line = array_shift($lines);

		(処理部分なのだが、省略)
                }
        }

上の図のように、array_shift()関数は、配列の先頭要素にあった
「アジ」を変数 $line にコピーした後、元の配列の要素を消して
残りの要素が1つ前にズレた形の配列になる。

array_shift()関数によって、$lines 配列の中に格納されていた
コンテンツのデータが、1行づつ取り出され $line の変数に格納される。
そして、$lineのデータが処理される。

$lines配列の要素がある限り、すなわちコンテンツが最終行に来るまで
処理のループが走るというわけだ。

<Directory "/usr/local/apache/htdocs/kanri">

    Options Indexes FollowSymLinks ExecCGI
    AllowOverride None

    Order deny,allow
    deny  from all
    Allow from 許可するネットワークアドレス/サブネットマスク

</Directory>

/////////////////////////////////////////////////
// Directory definition
// (Ended with a slash like '../path/to/pkwk/', or '')
define('DATA_HOME',     '');
define('LIB_DIR',       'lib/');
define('KANRI_GAMEN',0);

/////////////////////////////////////////////////
// Directory definition
// (Ended with a slash like '../path/to/pkwk/', or '')
define('DATA_HOME',     '../');
define('LIB_DIR',       '../lib/');
define('KANRI_GAMEN',1);

// Skin file

if (defined('TDIARY_THEME')) {
        define('SKIN_FILE', DATA_HOME . SKIN_DIR . 'tdiary.skin.php');
} else {
        define('SKIN_FILE', DATA_HOME . SKIN_DIR . 'pukiwiki.skin.php');
}

// Skin file

if ( KANRI_GAMEN == 1 ) {
        define('SKIN_FILE', DATA_HOME . 'kanri/' . 'pukiwiki.skin.php');
} else {
        define('SKIN_FILE', DATA_HOME . SKIN_DIR . 'pukiwiki.skin.php');
}

// Static image files
define('IMAGE_DIR', 'image/');

// Static image files
if ( KANRI_GAMEN == 1 )
   {
   define('IMAGE_DIR', '../image/');
   }
else
   {
   define('IMAGE_DIR', 'image/');
   }

 <link rel="stylesheet" type="text/css" media="screen" 
 href="skin/pukiwiki.css.php?charset=<?php echo $css_charset ?>" 
 charset="<?php echo $css_charset ?>" />

 <link rel="stylesheet" type="text/css" media="print"  
 href="skin/pukiwiki.css.php?charset=<?php echo $css_charset ?>
 &media=print" charset="<?php echo $css_charset ?>" />

 <link rel="stylesheet" type="text/css" media="screen" 
 href="../skin/pukiwiki.css.php?charset=<?php echo $css_charset ?>"
 charset="<?php echo $css_charset ?>" />

 <link rel="stylesheet" type="text/css" media="print"  
 href="../skin/pukiwiki.css.php?charset=<?php echo $css_charset ?>
 &media=print" charset="<?php echo $css_charset ?>" />

(注意)
見やすくするため、実際のソースと違い、区切りの良い所で
改行をいれています。

上の編集画面は管理者用の画面です。
そこで、URLで閲覧用の画面に、編集画面が開くための
クエリーを付けてみる事にした。

閲覧画面なのだが、コンテンツの編集できる状態になった。

/////////////////////////////////////////////////
// Main

$retvars = array();
$is_cmd = FALSE;

//  セキュリティー処理

if ( isset($vars['cmd'])) {
   if ( KANRI_GAMEN == 0 && $vars['cmd'] == 'edit' )
      {
      unset($vars['cmd']);
      }
}

if ( isset($vars['plugin'])) {
   if ( KANRI_GAMEN == 0 && $vars['plugin'] == 'attach' )
      {
      unset($vars['plugin']);
      }
}

//  処理おしまい

クエリーの部分でファイルのアップロードは「plugin=attach」があるため
単純に、URLの尻尾にあるクエリー部分の変数をなくしてしまえば
問題が解決できると考えた。

あと、編集はクエリー部分に「cmd=edit」があるため
単純に「cmd」で送られた変数をなくせば良いと思った。

URLを操作されても編集画面などが出てこないようになった。

/////////////////////////////////////////////////
// Main

$retvars = array();
$is_cmd = FALSE;

//  セキュリティー処理

if ( KANRI_GAMEN == 0 )
   {
   if ( isset($vars['plugin']))
      {
      //  ダウンロード以外は排除
      if ( $vars['plugin'] != 'attach' )
         {
         unset($vars['plugin']);
         }

      // ダウンロード以外は排除
      if ( $vars['plugin'] == 'attach' &&  ! isset($var['openfile']) )
         {
         unset($vars['plugin']);
         }
       }
}

//  処理おしまい

送られたクエリーのうち「plugin=attach」と「openfile=ファイル名」に
該当する物は、そのままにして、他の「plugin=XXXX」になる物を無効にした。

/////////////////////////////////////////////////
// Main

$retvars = array();
$is_cmd = FALSE;

//  セキュリティー処理

if ( KANRI_GAMEN == 0 )
   {
   if ( isset($vars['cmd']) ) 
      {
      unset($vars['cmd']);
      }

   if ( isset($vars['plugin']))
      {
      //  ダウンロード以外は排除
      if ( $vars['plugin'] != 'attach' )
         {
         unset($vars['plugin']);
         }

      // ダウンロード以外は排除
      if ( $vars['plugin'] == 'attach' &&  ! isset($var['openfile']) )
         {
         unset($vars['plugin']);
         }
       }
}

//  処理おしまい

$retvars = array();
$is_cmd = FALSE;
if (isset($vars['cmd'])) {
        $is_cmd  = TRUE;
        $plugin = & $vars['cmd'];
} else if (isset($vars['plugin'])) {
        $plugin = & $vars['plugin'];
} else {
        $plugin = '';
}
if ($plugin != '') {
        if (exist_plugin_action($plugin)) {
                // Found and exec
                $retvars = do_plugin_action($plugin);
                if ($retvars === FALSE) exit; // Done

                if ($is_cmd) {
                        $base = isset($vars['page'])  ? $vars['page']  : '';
                } else {
                        $base = isset($vars['refer']) ? $vars['refer'] : '';
                }
        } else {
                // Not found
                $msg = 'plugin=' . htmlspecialchars($plugin) .
                        ' is not implemented.';
                $retvars = array('msg'=>$msg,'body'=>$msg);
                $base    = & $defaultpage;
        }
}

赤い部分は、$var['cmd']を無効にしているため FALSE になり
条件文を満たさない。

青い部分は、$var['plugin']を無効にしているため FALSE になり
条件文を満たさない。

そのためピンクの部分にあるように、$plugin 変数の値は、何も入らない。 

オレンジ色の部分だが、$plugin 変数の値は何もないので FALSEになり
elseの部分が動く。

elseの部分の、緑色の部分がページ名の指定にあたるのだが、
$defaultpage の変数には、トップページ名が入っている。
つまり、トップページを表示させるという意味だ。

/////////////////////////////////////////////////
// 外部からくる変数のチェック

// Prohibit $_GET attack
foreach (array('msg', 'pass') as $key) {
        if (isset($_GET[$key])) die_message('Sorry, already reserved: ' . $key . '=');
}

// Expire risk
unset($HTTP_GET_VARS, $HTTP_POST_VARS); //, 'SERVER', 'ENV', 'SESSION', ...
unset($_REQUEST);       // Considered harmful

// 閲覧画面で不要なクエりーを排除！

if ( KANRI_GAMEN == 0 ) {

    if ( $_GET['plugin'] != 'attach' )
       {
       unset($_GET['plugin']);
       } 

    if ( $_GET['plugin'] == 'attach' && ! isset($_GET['openfile']) )
       {
       unset($_GET['plugin']);
       }
    }

//  処理おしまい

送られたクエリーのうち「plugin=attach」と「openfile=ファイル名」に
該当する物は、そのままにして、他の「plugin=XXXX」になる物を無効にした。

編集などができなくなるようにする処理は省いてみた。

<img src="http://pukiwiki.xxxx.co.jp/index.php?
plugin=ref&amp;page=FrontPage&amp;src=top.png" 
alt="top.png" title="top.png" width="400" height="348" />

見やすいように改行をいれています。

/////////////////////////////////////////////////
// 外部からくる変数のチェック

// Prohibit $_GET attack
foreach (array('msg', 'pass') as $key) {
        if (isset($_GET[$key])) die_message('Sorry, already reserved: ' . $key . '=');
}

// Expire risk
unset($HTTP_GET_VARS, $HTTP_POST_VARS); //, 'SERVER', 'ENV', 'SESSION', ...
unset($_REQUEST);       // Considered harmful

// 閲覧画面で不要なクエりーを排除！

if ( KANRI_GAMEN == 0 ) {

  //  編集や凍結に関するクエリーは排除
  if ( isset($_GET['cmd']) )
       unset($_GET['cmd']);

    //  添付ファイルのダウンロードと、画像表示以外は排除
    if ( $_GET['plugin'] != 'attach' && $_GET['plugin'] != 'ref' )
       {
       unset($_GET['plugin']);
       }

     // ファイルのアップロードは排除
    if ( $_GET['plugin'] == 'attach' && isset($_GET['pcmd']) ) 
       {
       unset($_GET['pcmd']);
       unset($_GET['plugin']);
       }
    }

//  処理おしまい

<div id="body">
<form action="http://pukiwiki.xxx.co.jp/index.php" method="post">
<div><input type="hidden" name="encode_hint" value="ぷ" /></div>
<div class="edit_form">
<select name="template_page">
<option value="">-- 雛形とするページ --</option>
<option value="BracketName">BracketName</option>
<option value="FrontPage">FrontPage</option>
(途中省略)
<option value="last">lasr</option>
</select>
<input type="submit" name="template" value="読込" accesskey="r" />
<br />
<input type="hidden" name="cmd"    value="edit" />
<input type="hidden" name="page"   value="FrontPage" />
<input type="hidden" name="digest" value="fb76413017bc84e930dc7e5d14f5db1e" />
<textarea name="msg" rows="20" cols="80">CENTER:&ref(top.png,nolink);

</textarea>
<br />
<input type="submit" name="preview" value="プレビュー" accesskey="p" />
<input type="submit" name="write"   value="ページの更新" accesskey="s" />
<input type="checkbox" name="notimestamp" id="_edit_form_notimestamp" value="true" />
<label for="_edit_form_notimestamp">
<span class="small">タイムスタンプを変更しない</span></label> 
<input type="submit" name="cancel"  value="キャンセル" accesskey="c" />
<textarea name="original" rows="1" cols="1" style="display:none">

</textarea>
</div>
</form>

<HTML><HEAD><TITLE>上書き実験</TITLE></HEAD>
<BODY>

<div><form action="(攻撃先のURL)/index.php" method="post">
<div><input type="hidden" name="encode_hint" value="ぷ" /></div>
<div>
<select name="template_page">
<option value="">-- 雛形とするページ --</option>
<option value="BracketName">BracketName</option>
<option value="FrontPage">FrontPage</option>
<option value="InterWikiName">InterWikiName</option>
<option value="InterWikiSandBox">InterWikiSandBox</option>
<option value="InterWikiテクニカル">InterWikiテクニカル</option>
<option value="MenuBar">MenuBar</option>
<option value="PHP">PHP</option>
</select>
<input type="submit" name="template" value="読込" accesskey="r" />
<br />
<input type="hidden" name="cmd"    value="edit" />
<input type="hidden" name="page"   value="FrontPage" />
<input type="hidden" name="digest" value="fb76413017bc84e930dc7e5d14f5db1e" />
<textarea name="msg" rows="20" cols="80">

</textarea>
<br />
<input type="submit" name="preview" value="プレビュー" accesskey="p" />
<input type="submit" name="write"   value="ページの更新" accesskey="s" />
<input type="checkbox" name="notimestamp" value="true" />
<label for="_edit_form_notimestamp"><span>タイムスタンプを変更しない</span></label> 
<input type="submit" name="cancel"  value="キャンセル" accesskey="c" />
<textarea name="original" rows="1" cols="1" style="display:none">

</textarea>
</div>
</form>

</BODY></HTML>

この場合、攻撃先の閲覧画面にアクセスして、トップ画面の書き換えを
意図するコードになっている。

/////////////////////////////////////////////////
// 外部からくる変数のチェック

// Prohibit $_GET attack
foreach (array('msg', 'pass') as $key) {
        if (isset($_GET[$key])) die_message('Sorry, already reserved: ' . $key . '=');
}

// Expire risk
unset($HTTP_GET_VARS, $HTTP_POST_VARS); //, 'SERVER', 'ENV', 'SESSION', ...
unset($_REQUEST);       // Considered harmful

// 閲覧画面で不要なクエりーを排除！

if ( KANRI_GAMEN == 0 ) {

  // POSTでやってくる場合は排除
  unset($_POST);

  //  編集や凍結に関するクエリーは排除
  if ( isset($_GET['cmd']) )
       unset($_GET['cmd']);

    //  添付ファイルのダウンロードと、画像表示以外は排除
    if ( $_GET['plugin'] != 'attach' && $_GET['plugin'] != 'ref' )
       {
       unset($_GET['plugin']);
       }

     // ファイルのアップロードは排除
    if ( $_GET['plugin'] == 'attach' && isset($_GET['pcmd']) ) 
       {
       unset($_GET['pcmd']);
       unset($_GET['plugin']);
       }
    }

//  処理おしまい

/////////////////////////////////////////////////
// Main

$retvars = array();
$is_cmd = FALSE;
if (isset($vars['cmd'])) {
        $is_cmd  = TRUE;
        $plugin = & $vars['cmd'];
} else if (isset($vars['plugin'])) {
        $plugin = & $vars['plugin'];
} else {
        $plugin = '';
}
if ($plugin != '') {
        if (exist_plugin_action($plugin)) {
                // Found and exec
                $retvars = do_plugin_action($plugin);
                if ($retvars === FALSE) exit; // Done

                if ($is_cmd) {
                        $base = isset($vars['page'])  ? $vars['page']  : '';
                } else {
                        $base = isset($vars['refer']) ? $vars['refer'] : '';
                }
        } else {
                // Not found
                $msg = 'plugin=' . htmlspecialchars($plugin) .
                        ' is not implemented.';
                $retvars = array('msg'=>$msg,'body'=>$msg);
                $base    = & $defaultpage;
        }
}

プラグインが動いていないという思い込むから、赤い部分はFALSEになり
条件文は満たさないと思った。

そのため $pluginの値だが、青い部分にあるように、文字列の値が
入らいないと考えていた。

そして、ピンクの部分だが、これも青い部分で文字列の値が入っていない事から
FALSEになると思い、緑の部分のelse部分が動くと思っていた。

/////////////////////////////////////////////////
// Main

$retvars = array();
$is_cmd = FALSE;
if (isset($vars['cmd'])) {
        $is_cmd  = TRUE;
        $plugin = & $vars['cmd'];
} else if (isset($vars['plugin'])) {
        $plugin = & $vars['plugin'];
} else {
        $plugin = '';
}

die("$plugin");

/////////////////////////////////////////////////
// QUERY_STRINGを取得

// cmdもpluginも指定されていない場合は、QUERY_STRINGを
// ページ名かInterWikiNameであるとみなす
$arg = '';
if (isset($_SERVER['QUERY_STRING']) && $_SERVER['QUERY_STRING']) {
        $arg = & $_SERVER['QUERY_STRING'];
} else if (isset($_SERVER['argv']) && ! empty($_SERVER['argv'])) {
        $arg = & $_SERVER['argv'][0];
}
if (PKWK_QUERY_STRING_MAX && strlen($arg) > PKWK_QUERY_STRING_MAX) {
        // Something nasty attack?
        pkwk_common_headers();
        sleep(1);       // Fake processing, and/or process other threads
        echo('Query string too long');
        exit;
}
$arg = input_filter($arg); // \0 除去

赤い部分はクエリーの中身を全て $arg変数にいれている。
青い部分も、同じような感じだ。

この違い、実は、私はよくわかっていません。
実験で確かめて見た結果、同じ結果が出たぐらいしか、わかりません (--;;

ただ言えるのは、クエリーの中身を全て $arg変数に格納したいようだ。

/////////////////////////////////////////////////
// QUERY_STRINGを分解してコード変換し、$_GET に上書き

// URI を urlencode せずに入力した場合に対処する
$matches = array();
foreach (explode('&', $arg) as $key_and_value) {
        if (preg_match('/^([^=]+)=(.+)/', $key_and_value, $matches) &&
            mb_detect_encoding($matches[2]) != 'ASCII') {
                $_GET[$matches[1]] = $matches[2];
        }
}
unset($matches);

クエリーを「&」を区切りにして分解する処理だ。
編集画面のプラグインなどの場合、以下のURLになっている。

http://********/index.php?cmd=edit&page=FrontPage

上の例でいくと、赤い部分は中身が「cmd=edit」、「page=FrontPage」の
配列を作る事を意味する。
foreach文は配列に対しての繰り返しなので、分解してできた物を
順番に処理していくのだ。

青い部分だが、配列の中身を正規表現で抽出するのだ。
「=」の前の部分は、$matches[1]に格納され、「=」の後ろは$matches[2]に
格納されるのだ。
上の例の「page=FrontPage」の場合だと、$matches[1]に「page」が格納され
$matches[2]には「FrontPage」が格納される。

そしてピンクの部分は$_GET[]配列に書き込んでいるのだ。
キーやキーの中身に重複があったとしても上書きという形になる。

ページ名の部分は、とりあえず $_GET['page']=ページ名で保管される。

/////////////////////////////////////////////////
// GET, POST, COOKIE

$get    = & $_GET;
$post   = & $_POST;
$cookie = & $_COOKIE;

// GET + POST = $vars
if (empty($_POST)) {
        $vars = & $_GET;  // Major pattern: Read-only access via GET
} else if (empty($_GET)) {
        $vars = & $_POST; // Minor pattern: Write access via POST etc.
} else {
        $vars = array_merge($_GET, $_POST); // Considered reliable than $_REQUEST
}

説明する必要もないと思いますが、POST型でデータが送られていない場合は
GET型で送られたデータの$get配列が、そのまま $var配列へコピーされる。

GET型でデータが送られていない場合は、POST型で送られた
データの$post配列が、そのまま $var配列へコピーされる。

POST型、GET型の両方のデータが存在する場合は、2つとも
$var配列へコピーされる。

つまり(2)で出てきた、$_GET['page']=ページ名 で上書きされた部分が、
$var['page']=ページ名 でコピーされている事を意味するのだ。

// 整形: page, strip_bracket()
if (isset($vars['page'])) {
        $get['page'] = $post['page'] = $vars['page']  = strip_bracket($vars['page']);
} else {
        $get['page'] = $post['page'] = $vars['page'] = '';
}

赤い部分だが、クエリに cmdやpluginが含まれる場合は TRUE になる。
青い部分はstrip_bracket()関数を使って、ページ名が格納された
$vars['page']の中にある「[」と「]」とを取り除く関数だ。
このstrip_bracket()関数は lib/func.phpで定義されている。
その返り値は、3つの変数 $get['page']、$post['page']、$vars['page'] 
に代入される。

反対に、クエリに cmdやpluginが含まれない場合は、ピンクの部分のように
$get['page']、$post['page']、$vars['page']の3つの変数は、
文字列の値を入れないようにしている。

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

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

        if ($arg == '') $arg = $defaultpage;
        $arg = rawurldecode($arg);
        $arg = strip_bracket($arg);
        $arg = input_filter($arg);
        $get['page'] = $post['page'] = $vars['page'] = $arg;
}

赤い部分はクエリー内で、cmdもpluginも指定されていない場合 TRUEになる。

さて、クエリーの中がページ名だけの場合や、あと、私が先ほど行った
セキュリティー対策で、クエリー内のcmdもpluginの指定を
はたき落とした場合、この条件が満たされる。

青い部分は、cmdもpluginの指定を行う。ここでは「 read 」をいれる。
ページの表示の場合、readプラグインを動かすためなのだ。

緑の部分は、ページ名の指定がない場合、$arg変数に、
トップページのページ名が入った $defaultpage が代入される。

ピンクの部分は、ページ名の変数が入った $arg の値を
$get['page']、$post['page']、$vars['page']の3つの変数に代入する。

function plugin_read_action()
{
        global $vars, $_title_invalidwn, $_msg_invalidiwn;

        $page = isset($vars['page']) ? $vars['page'] : '';

        if (is_page($page)) {
                // ページを表示
                check_readable($page, true, true);
                header_lastmod($page);
                return array('msg'=>'', 'body'=>'');

        } else if (! PKWK_SAFE_MODE && is_interwiki($page)) {
                return do_plugin_action('interwiki'); // InterWikiNameを処理

        } else if (is_pagename($page)) {
                $vars['cmd'] = 'edit';
                return do_plugin_action('edit'); // 存在しないので、編集フォームを表示

        } else {
                // 無効なページ名
                return array(
                        'msg'=>$_title_invalidwn,
                        'body'=>str_replace('$1', htmlspecialchars($page),
                                str_replace('$2', 'WikiName', $_msg_invalidiwn))
                );
        }
}

赤い部分の is_page()関数だが、これはページ名に該当するファイルが
実際に存在するするかどうかのチェックする関数だ。
lib/func.php で定義されている関数だ。

青い部分に注目する。特にコメント文に反応した。
「存在しないので、編集フォームを表示」と書いている。
指定したページ名が存在しない場合、編集フォームを表示させるという意味だ。 

上の図ではクエリーが「cmd=search」となっている。
何もソースを触っていないPukiwikiだと「cmd」の部分で、
プラグインの呼び出しと反応して、searchプラグインを表示させる。

だが、私がセキュリティー処理を行ったために、閲覧画面から
cmdを含むクエリーを送っても、cmdが叩き落とされる。
この時点で、クエリーの中に cmdやpluginを含まないという形になる。

しかし、ページ名の抽出で、クエリーの中に cmdやpluginを含まない部分の
処理が働くため、ページ名として「cmd=search」と認識される。
そして、readプラグインが動くようにセットされる。

さて、「cmd=search」というページ名で認識されるのだが、
「cmd=search」ページ名に該当するファイルは存在しないために
readプラグインが編集画面を出すという仕組みだ。

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

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

        if ($arg == '') $arg = $defaultpage;
        $arg = rawurldecode($arg);
        $arg = strip_bracket($arg);
        $arg = input_filter($arg);

        if ( ! is_page($arg) && KANRI_GAMEN == 0 ) $arg = $defaultpage;


        $get['page'] = $post['page'] = $vars['page'] = $arg;
}

赤い部分を追加した。
追加した部分とは、指定したページ名に該当するファイルがない場合で、
しかも閲覧画面の場合、ページ名を格納する変数に、トップページの値を
入れるようにする処理だ。

is_page()関数とは、lib/func.phpで定義された関数で、
ページ名に該当するファイルが存在するかどうかを確認する関数だ。

[suga@server wiki]$ more 7465737470616765.txt          
#freeze
** テストページだよ！ [#xdc5ef01]

見栄えはどうかなぁ？
[suga@server wiki]$ 

赤い部分が凍結しているかどうかの目印だ。

/////////////////////////////////////////////////
// Security settings

// PKWK_READONLY - Prohibits editing and maintain via WWW
//   NOTE: Counter-related functions will work now (counter, attach count, etc)
if (! defined('PKWK_READONLY'))
        define('PKWK_READONLY', 1); // 0 or 1

青い部分で、「1」としてしまえば、コンテンツは全て編集不可になる。
ただし、編集したい場合は、ここの部分を「0」にする必要があるので
手間かもしれない。

function plugin_edit_action()
{
        global $vars, $_title_edit, $load_template_func;

        if (PKWK_READONLY) die_message('PKWK_READONLY prohibits editing');

(以下、省略)
}

赤い部分がチェックの部分です。編集不可にした場合、PKWK_READONLYの値は
「1」のため、この条件文では TRUE になる。
そのため、die_message()関数が働き、ここで処理がストップするわけだ。

ちなみに、die_message()関数は、lib/func.php で定義されている関数で、
メッセージを表示して、処理をストップさせる働きをする。

Aさんが編集のため、編集画面を呼び出す。
この時、コンテンツを読み込む形になる。

Bさんは、Aさんが編集している事を知らずに、同じコンテンツを編集するため
編集画面を呼び出す。この時も、コンテンツを読み込む形になる。
Bさんが先に編集し終わった場合、編集した内容を反映させるため、
コンテンツを更新させる。

その後、もし、Aさんが編集した内容を反映させる場合、
Bさんが更新した内容を上書きしてしまうため、
Bさんが編集した部分は無視され、Aさんが編集した物だけが
更新されてしまうという問題が出てくる。

<div id="body">
<form action="http://pukiwiki.xxx.co.jp/index.php" method="post">
<div><input type="hidden" name="encode_hint" value="ぷ" /></div>
<div class="edit_form">
<select name="template_page">
<option value="">-- 雛形とするページ --</option>
<option value="BracketName">BracketName</option>
<option value="FrontPage">FrontPage</option>
(途中省略)
<option value="last">lasr</option>
</select>
<input type="submit" name="template" value="読込" accesskey="r" />
<br />
<input type="hidden" name="cmd"    value="edit" />
<input type="hidden" name="page"   value="FrontPage" />
<input type="hidden" name="digest" value="fb76413017bc84e930dc7e5d14f5db1e" />
<textarea name="msg" rows="20" cols="80">

</textarea>
<br />
<input type="submit" name="preview" value="プレビュー" accesskey="p" />
<input type="submit" name="write"   value="ページの更新" accesskey="s" />
<input type="checkbox" name="notimestamp" id="_edit_form_notimestamp" value="true" />
<label for="_edit_form_notimestamp">
<span class="small">タイムスタンプを変更しない</span></label> 
<input type="submit" name="cancel"  value="キャンセル" accesskey="c" />
<textarea name="original" rows="1" cols="1" style="display:none">

</textarea>
</div>
</form>

赤い部分は digest変数の値として「fb76413017bc84e930dc7e5d14f5db1e」を
サーバーに送る仕掛けになっている。

この digest変数。最初、見た時は、何かのかわからなかったのだが、
何か意味があると思ったが、その時点では調べなかった。

だが、その後、Pukiwikiのソースを呼んでいたら、$digest変数を見つけた。
どんな値があるのか調べると、コンテンツの内容をMD5ハッシュ関数に入れた
結果の値だ。

つまり上の赤い部分の値は、コンテンツの編集前の内容を
MD5のハッシュ関数に入れた結果の値になる。

function edit_form($page, $postdata, $digest = FALSE, $b_template = TRUE)
{
        global $script, $vars, $rows, $cols, $hr, $function_freeze;
        global $_btn_addtop, $_btn_preview, $_btn_repreview, $_btn_update, $_btn_cancel,
                $_msg_help, $_btn_notchangetimestamp;
        global $whatsnew, $_btn_template, $_btn_load, $non_list, $load_template_func;
        global $notimeupdate;

        // Newly generate $digest or not
        if ($digest === FALSE) $digest = md5(join('', get_source($page)));

(以下、省略)

赤い部分が $digestの値を作成する部分。
これが編集直前のコンテンツの内容を表す値になる。

編集直前にコンテンツをMD5ハッシュ関数で加工した値を取得。
$digest変数に格納する。

そして、コンテンツの更新直前に、更新前のコンテンツを
MD5のハッシュ関数で加工し、それを $digestに格納した物とを比較する。
一致すれば、編集中に、コンテンツを触った人がいない事を意味するので
そのままコンテンツの内容は更新される。

この場合、更新直前の、コンテンツの内容と、$digestの値が一致しない。
誰かが触っていた事になる。

不一致を知らせる画面が出てくる。
その上で、このまま更新して良いかをきいている。

// Write, add, or insert new comment
function plugin_edit_write()
{
        global $vars, $trackback;

(途中、省略)

        $oldpagesrc = join('', get_source($page));
        $oldpagemd5 = md5($oldpagesrc);

        if (! isset($vars['digest']) || $vars['digest'] != $oldpagemd5) {

(以下、省略)

青い部分は、更新直前のコンテンツのデータを取り込んで、
MD5ハッシュ関数に入れる。その値を $oldpagemd5 に入れる。

赤い部分の $vars['digest'] だが、変数画面からクエリーで
送られた $digest 変数の値で、編集直前のコンテンツのデータを
MD5ハッシュ関数に入れて出てきた値だ。

赤い部分が、編集直前のコンテンツと、更新直前のコンテンツとの間で
データの中身に差異があるかどうかのチェックを行う部分だ。

|りんご|みかん|
|100円|200円|

&br;

,ざるそば,300円
,きしめん,400円

// , title1 , title2 , title3
// , cell1  , cell2  , cell3
// , cell4  , cell5  , cell6
class YTable extends Element
{
        var $col;

        function YTable($_value)
        {
                parent::Element();

                $align = $value = $matches = array();
                foreach($_value as $val) {
                        if (preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches)) {
                                $align[] =($matches[1] != '') ?
                                        ((isset($matches[3]) && $matches[3] != '') ?
                                                ' style="text-align:center"' :
                                                ' style="text-align:right"'
                                        ) : '';
                                $value[] = $matches[2];
                        } else {
                                $align[] = '';
                                $value[] = $val;
                        }
                }
                $this->col = count($value);
                $colspan = array();
                foreach ($value as $val)
                        $colspan[] = ($val == '==') ? 0 : 1;
                $str = '';
                $count = count($value);
                for ($i = 0; $i < $count; $i++) {
                        if ($colspan[$i]) {
                                while ($i + $colspan[$i] < $count && $value[$i + $colspan[$i]] == '==')
                                        $colspan[$i]++;
                                $colspan[$i] = ($colspan[$i] > 1) ? ' colspan="' . $colspan[$i] . '"' : '';
                                $str .= '<td class="style_td"' . $align[$i] . $colspan[$i] . '>' . make_link($value[$i]) . '</td>';
                        }
                }
                $this->elements[] = $str;
        }

        function canContain(& $obj)
        {
                return is_a($obj, 'YTable') && ($obj->col == $this->col);
        }

        function & insert(& $obj)
        {
                $this->elements[] = $obj->elements[0];
                return $this;
        }

        function toString()
        {
                $rows = '';
                foreach ($this->elements as $str)
                        $rows .= "\n" . '<tr class="style_tr">' . $str . '</tr>' . "\n";
                $rows = $this->wrap($rows, 'table', ' class="style_table" cellspacing="1" border="0"');
                return $this->wrap($rows, 'div', ' class="ie5"');
        }
}

.style_td {
        padding:5px;
        margin:1px;
        color:inherit;
        background-color:#EEF5FF;
}

.style_td_kam {
        padding:5px;
        margin:1px;
        color:inherit;
        background-color:WHITE;
}

$str .= '<td class="style_td"' . $align[$i] . $colspan[$i] . '>' . make_link($value[$i]) . '</td>';

$str .= '<td class="style_td_kam"' . $align[$i] . $colspan[$i] . '>' . make_link($value[$i]) . '</td>';

// , title1 , title2 , title3
// , cell1  , cell2  , cell3
// , cell4  , cell5  , cell6
class YTable extends Element
{
        var $col;

(途中省略)

        function toString()
        {
                $rows = '';
                foreach ($this->elements as $str)
                        $rows .= "\n" . '<tr class="style_tr">' . $str . '</tr>' . "\n";
                $rows = $this->wrap($rows, 'table', ' class="style_table" cellspacing="1" border="0"');
                return $this->wrap($rows, 'div', ' class="ie5"');
        }
}

.style_table {
        padding:0px;
        border:0px;
        margin:auto;
        text-align:left;
        color:inherit;
        background-color:#ccd5dd;
}

.style_table_kam {
        padding:0px;
        border:0px;
        margin:auto;
        text-align:left;
        color:BLACK;
        background-color:WHITE;
}

// , title1 , title2 , title3
// , cell1  , cell2  , cell3
// , cell4  , cell5  , cell6
class YTable extends Element
{
        var $col;

(途中省略)

        function toString()
        {
                $rows = '';
                foreach ($this->elements as $str)
                        $rows .= "\n" . '<tr class="style_tr">' . $str . '</tr>' . "\n";
                $rows = $this->wrap($rows, 'table', ' class="style_table_kam" cellspacing="1" border="0"');
                return $this->wrap($rows, 'div', ' class="ie5"');
        }
}

<div class="ie5"><table class="style_table" cellspacing="1" border="0">
<tbody><tr><td class="style_td">a</td><td class="style_td">b</td></tr>
<tr><td class="style_td">g</td><td class="style_td">f</td></tr></tbody>

テーブルの外は<div>のタグで囲まれているため、
<div class="ie5">の設定を見てみる必要がある。

// , title1 , title2 , title3
// , cell1  , cell2  , cell3
// , cell4  , cell5  , cell6
class YTable extends Element
{
        var $col;

(途中省略)

        function toString()
        {
                $rows = '';
                foreach ($this->elements as $str)
                        $rows .= "\n" . '<tr class="style_tr">' . $str . '</tr>' . "\n";
                $rows = $this->wrap($rows, 'table', ' class="style_table_kam" cellspacing="1" border="0"');
                return $this->wrap($rows, 'div', 'class="ie5_kam"');
        }
}

// _ title1 _ title2 _ title3
// _ cell1  _ cell2  _ cell3
// _ cell4  _ cell5  _ cell6
class ZTable extends Element
{
        var $col;

        function ZTable($_value)
        {
                parent::Element();

                $align = $value = $matches = array();
                foreach($_value as $val) {
                        if (preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches)) {
                                $align[] =($matches[1] != '') ?
                                        ((isset($matches[3]) && $matches[3] != '') ?
                                                ' style="text-align:center"' :
                                                ' style="text-align:right"'
                                        ) : '';
                                $value[] = $matches[2];
                        } else {
                                $align[] = '';
                                $value[] = $val;
                        }
                }
                $this->col = count($value);
                $colspan = array();
                foreach ($value as $val)
                        $colspan[] = ($val == '==') ? 0 : 1;
                $str = '';
                $count = count($value);
                for ($i = 0; $i < $count; $i++) {
                        if ($colspan[$i]) {
                                while ($i + $colspan[$i] < $count && $value[$i + $colspan[$i]] == '==')
                                        $colspan[$i]++;
                                $colspan[$i] = ($colspan[$i] > 1) ? ' colspan="' . $colspan[$i] . '"' : '';
                                $str .= '<td class="style_td_kam2"' . $align[$i] . $colspan[$i] . '>' . make_link($value[$i]) . '</td>';
                        }
                }
                $this->elements[] = $str;
        }

        function canContain(& $obj)
        {
                return is_a($obj, 'ZTable') && ($obj->col == $this->col);
        }

        function & insert(& $obj)
        {
                $this->elements[] = $obj->elements[0];
                return $this;
        }

        function toString()
        {
                $rows = '';
                foreach ($this->elements as $str)
                        $rows .= "\n" . '<tr class="style_tr">' . $str . '</tr>' . "\n";
                $rows = $this->wrap($rows, 'table', ' class="style_table_kam2" cellspacing="1" border="0"');
                return $this->wrap($rows, 'div', ' class="ie5_kam2"');
        }
}

// "_" - separated table
function & Factory_ZTable(& $root, $text)
{
        if ($text == '_') {
                return Factory_Inline($text);
        } else {
                return new ZTable(csv_explode('_', substr($text, 1)));
        }
}

var $factories = array(
        ':' => 'DList',
        '|' => 'Table',
        ',' => 'YTable',
        '_' => 'ZTable',
        '#' => 'Div');

.style_table_kam2 {
        padding:0px;
        border:0px;
        margin:auto;
        text-align:left;
        color:BLACK;
        background-color:BLACK;
}

.style_td_kam2 {
        padding:5px;
        margin:1px;
        color:inherit;
        background-color:WHITE;
        font-size:70%;
}

,小野真弓,私のラブラブな人
,岡村孝子,大好きな歌手
,青木裕子,大好きなTBSの女子アナ

        function parse(& $lines)
        {
                $this->last = & $this;
                $matches = array();

                while (! empty($lines)) {
                        $line = array_shift($lines);

		(処理部分なのだが、省略)
                }
        }

class YTable extends Element
{
        var $col;

        function YTable($_value)
        {
                parent::Element();

                $align = $value = $matches = array();
                foreach($_value as $val) {
                        if (preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches)) {
                                $align[] =($matches[1] != '') ?
                                        ((isset($matches[3]) && $matches[3] != '') ?
                                                ' style="text-align:center"' :
                                                ' style="text-align:right"'
                                        ) : '';
                                $value[] = $matches[2];
                        } else {
                                $align[] = '';
                                $value[] = $val;
                        }
                }

<HTML><HEAD><TITLE>test</TITLE></HEAD>
<BODY>

<?php

$matches = array();

$val = ", A, B ,C,";

preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches);

print_r($matches);

?>

</BODY></HTML>

Array ( [0] => , A, B ,C, [1] => [2] => , A, B ,C, ) 

var $factories = array(
        ':' => 'DList',
        '|' => 'Table',
        ',' => 'YTable',
        '#' => 'Div');

(コンテンツのデータを1行ごとの文字列にして取り出す)

while (! empty($lines)) {
         $line = array_shift($lines);

(コンテンツの文字列の1文字目の文字を取り出す)

// The first character
$head = $line{0};

(1文字目が「,」の場合の処理)

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

1文字目が「,」だと、「,」テーブルの処理という場合分けが行われ、
$this->last  = & $this->last->add($factoryname($this, $line)); に進む。

ここでの$factoryname($this, $line) は、Factory_YTable($this, $line) だ。

// ブロック要素
class Element
{
        var $parent;   // 親要素
        var $last;     // 次に要素を挿入する先
        var $elements; // 要素の配列

(1文字目が「,」の場合の処理)

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

function & add(& $obj)
{
     if ($this->canContain($obj)) {
                return $this->insert($obj);
        } else {
               return $this->parent->add($obj);
        }
}

$lastには、現在、処理中のテーブルなどの処理するオブジェクトが
代入されている。

最初のクラスはBodyだが、「,」テーブルや、「|」などが出てくる度に
各クラスの$parent と、$lastは、前後に処理するクラスと連結されると
考えた。

これはC言語で言うデータ構造の考え方を、そっくり当てはめた物だった。

(1文字目が「,」の場合の処理)

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

// Comma-separated table
function & Factory_YTable(& $root, $text)
{
        if ($text == ',') {
                return Factory_Inline($text);
        } else {
                return new YTable(csv_explode(',', substr($text, 1)));
        }
}

この処理を見ると、コンテンツのデータので、1文字だけの行で
しかもその1文字が「,」の場合、テーブルではないという事で処理され、
残りのケースはテーブルとして処理される。

// Explode Comma-Separated Values to an array
function csv_explode($separator, $string)
{
        $retval = $matches = array();

        $_separator = preg_quote($separator, '/');
        if (! preg_match_all('/("[^"]*(?:""[^"]*)*"|[^' . $_separator . ']*)' .
            $_separator . '/', $string . $separator, $matches))
                return array();

        foreach ($matches[1] as $str) {
                $len = strlen($str);
                if ($len > 1 && $str{0} == '"' && $str{$len - 1} == '"')
                        $str = str_replace('""', '"', substr($str, 1, -1));
                $retval[] = $str;
        }
        return $retval;
}

<HTML><HEAD><TITLE>test2</TITLE></HEAD>
<BODY>

<?php

// Explode Comma-Separated Values to an array                                                                        
function csv_explode($separator, $string)
{
  $retval = $matches = array();

  $_separator = preg_quote($separator, '/');
  if (! preg_match_all('/("[^"]*(?:""[^"]*)*"|[^' . $_separator . ']*)' .
                       $_separator . '/', $string . $separator, $matches))
    return array();

  foreach ($matches[1] as $str) {
    $len = strlen($str);
    if ($len > 1 && $str{0} == '"' && $str{$len - 1} == '"')
      $str = str_replace('""', '"', substr($str, 1, -1));
    $retval[] = $str;
  }
  return $retval;
}


$moji = "A,B,C" ;
$output = array();

$output = csv_explode(',',$moji);

print_r($output);

?>

</BODY></HTML>

Array ( [0] => A [1] => B [2] => C ) 

// Comma-separated table
function & Factory_YTable(& $root, $text)
{
        if ($text == ',') {
                return Factory_Inline($text);
        } else {
                return new YTable(csv_explode(',', substr($text, 1)));
        }
}

青い部分は「,」で区切られた文字列を分解して、配列した物を引数に、
YTableのオブジェクトを作成している。

class YTable extends Element
{
        var $col;

        function YTable($_value)
        {
                parent::Element();

                $align = $value = $matches = array();
                foreach($_value as $val) {
                        if (preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches)) {
                                $align[] =($matches[1] != '') ?
                                        ((isset($matches[3]) && $matches[3] != '') ?
                                                ' style="text-align:center"' :
                                                ' style="text-align:right"'
                                        ) : '';
                                $value[] = $matches[2];
                        } else {
                                $align[] = '';
                                $value[] = $val;
                        }
                }

(以下省略)

赤い部分は仮引数で、「,」区切りの文字列を分解して配列にした物だ。
青い部分は、送られてきた配列を、一つづつ取り出し処理するための部分。
ピンクの部分は、左寄せか、中央寄せか、右寄せかを判定させる正規表現。

<HTML><HEAD><TITLE>test3</TITLE></HEAD>
<BODY>

<?php

$matches = array();

$valarr = array(' A',' B ','C');

foreach($valarr as $val) {

   preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches);

   print_r($matches);
   print "<BR>\n" ;
   }
?>

</BODY></HTML>

赤の「A」は右寄せのため、文字の左側に空白を入れた。
青の「B」は真中寄せのため、文字の両側の空白を入れた。
ピンクの「C」は左寄せなので、空白は入れていない。

matches[0]には正規表現の対象の文字列が入る。
なので、ここは全て表示される。

matche[1]は文字の左側に空白があった場合に空白文字が入る。

matche[2]は、左側、もしくは右側にある空白部分を排除した
文字列が入る。もちろん、両側に空白文字がない場合も、
この部分には文字列が入ってくる。

matche[3]は文字の右側に空白があった場合に空白文字が入る。

Array ( [0] => A [1] => [2] => A ) 
Array ( [0] => B [1] => [2] => B [3] => ) 
Array ( [0] => C [1] => [2] => C ) 

<HTML><HEAD><TITLE>test3</TITLE></HEAD>
<BODY>

<?php

$matches = array();

$valarr = array(' A',' B ','C');

foreach($valarr as $val) {

   preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches);

   // 右側に空白文字を入れた場合、matches[1] に 'BLANK' を代入
   if ( $matches[1] != '' ) $matches[1] = 'BLANK' ;

   print_r($matches);
   print "<BR>\n" ;
   }
?>

</BODY></HTML>

赤の「A」は右寄せのため、文字の左側に空白を入れた。
青の「B」は真中寄せのため、文字の両側の空白を入れた。
ピンクの「C」は左寄せなので、空白は入れていない。

茶色の部分は、右寄せ、及び、真中寄せをした時に
$matches[1]の空白文字を「BLANK」に変換する処理。

Array ( [0] => A [1] => BLANK [2] => A ) 
Array ( [0] => B [1] => BLANK [2] => B [3] => ) 
Array ( [0] => C [1] => [2] => C ) 

class YTable extends Element
{
        var $col;

        function YTable($_value)
        {
                parent::Element();

                $align = $value = $matches = array();
                foreach($_value as $val) {
                        if (preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches)) {
                                $align[] =($matches[1] != '') ?
                                        ((isset($matches[3]) && $matches[3] != '') ?
                                                ' style="text-align:center"' :
                                                ' style="text-align:right"'
                                        ) : '';
                                $value[] = $matches[2];
                        } else {
                                $align[] = '';
                                $value[] = $val;
                        }
                }

(以下省略)

右寄せ、真中寄せ、左寄せの処理が見える。

赤い部分は右寄せ、もしくは、真中寄せの場合を意味する。
そして、青い部分は、真中寄せの場合を意味する。

場合分けした後、<TD>タグの中につける属性の指定を行う。
真中寄せなら「style="text-align:center"」で
右寄せなら「style="text-align:right"」だ。

class YTable extends Element
{
        var $col;

        function YTable($_value)
        {
                parent::Element();

                $align = $value = $matches = array();
                foreach($_value as $val) {
                        if (preg_match('/^(\s+)?(.+?)(\s+)?$/', $val, $matches)) {
                                $align[] =($matches[1] != '') ?
                                        ((isset($matches[3]) && $matches[3] != '') ?
                                                ' style="text-align:center"' :
                                                ' style="text-align:right"'
                                        ) : '';
                                $value[] = $matches[2];
                        } else {
                                $align[] = '';
                                $value[] = $val;
                        }
                }
                $this->col = count($value);
                $colspan = array();
                foreach ($value as $val)
                        $colspan[] = ($val == '==') ? 0 : 1;
                $str = '';
                $count = count($value);
                for ($i = 0; $i < $count; $i++) {
                        if ($colspan[$i]) {
                                while ($i + $colspan[$i] < $count && $value[$i + $colspan[$i]] == '==')
                                        $colspan[$i]++;
                                $colspan[$i] = ($colspan[$i] > 1) ? ' colspan="' . $colspan[$i] . '"' : '';
                                $str .= '<td class="style_td"' . $align[$i] . $colspan[$i] . '>' . make_link($value[$i]) . '</td>';
                        }
                }
                $this->elements[] = $str;
        }

赤い部分は、このテーブルが何列かを記録する部分。
この時は気づかなかったが、後で、この記録がテーブルの表示において
重要な意味を持つ。

青い部分は、抜き出した文字列に<TD>タグをつけている部分。
タグの要素なども、ここでつけている。
「$str .= 追加部分」という記述なので、全て処理した文字列を
ダンゴのように連結させている。
いわば「<TD>A</TD> <TD>B</TD> <TD>C</TD>」のように。

ちなみに青い部分の中にある make_link()関数は、&color()などの
インライン型のプラグイン処理などに使われる関数です。
この部分を解読した時点では、make_link()関数までは解読していませんでし
ここで取り上げると話がややこしくなるので、後述しています。


ピンクの部分は、このオブジェクトに処理済みの文字列、すなわち、
<TD>タグ付きの文字列のタンゴを保管させている。
この部分は、$this->element[]と配列の形になっている。
文字列の保管なので、別に配列にする必要がなさそうに思えるのだが、
配列にしているのには理由があるからだ。
それは後述しています。

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add(データ処理済みの、YTableのオブジェクト);
        continue;
        }
}

        function parse(& $lines)
        {
                $this->last = & $this;

(以下、省略)

function & add(& $obj)
{
        if ($this->canContain($obj)) {
                return $this->insert($obj);
        } else {
                return $this->parent->add($obj);
        }
}

この関数の仮引数の「 $obj 」だが、ここでは「,」テーブルの処理なので
YTableクラスで定義され、コンテンツの1行分の処理を行ったデータが入った
オブジェクトの事だ。

もっと、わかりやすく書けば、現在、コンテンツの処理を行っている
オブジェクトだ。

function canContain($obj)
{
        return TRUE;
}

function & add(& $obj)
{
        if ($this->canContain($obj)) {
                return $this->insert($obj);
        } else {
                return $this->parent->add($obj);
        }
}

function & insert(& $obj)
{
        if (is_a($obj, 'Inline')) $obj = & $obj->toPara();
        return parent::insert($obj);
}

この話での $obj は、YTableクラスのオブジェクトになるため、
is_a($obj, 'Inline' の結果は、FALSE になる。

そして、return parent::insert($obj); が実行される。

function & insert(& $obj)
{
        $obj->setParent($this);
        $this->elements[] = & $obj;

        return $this->last = & $obj->last;
}

赤い部分は、現在、処理中のオブジェクト(YTableクラス)の中の
setParent()関数に、自分自身のオブジェクト(Bodyクラス)を代入している。
その結果、処理中のオブジェクト(YTableクラス)の変数 $parent は
Bodyクラスのオブジェクトが入る。

青い部分は、Bodyクラスの $elements[]配列の中に、現在、処理中の
YTableのオブジェクトを代入する。

ピンクの部分は、Bodyクラスの $last変数に、YTableのオブジェクトを代入する。

Bodyクラスの中の配列 $elements[] だが、処理したオブジェクトを
格納するためにある。

1行づつコンテンツデータが処理されるたびに、$elements[]配列の中に
個々のオブジェクトが格納される。

これは後で説明するが、ブラウザにコンテンツを表示させる際に、
個々に処理したオブジェクトに格納されているコンテンツデータを
出力させるため、配列にオブジェクトを保管させているのだ。

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add(2行目のデータ処理のオブジェクト);
        continue;
        }
}

function & add(& $obj)
{
        if ($this->canContain($obj)) {
                return $this->insert($obj);
        } else {
                return $this->parent->add($obj);
        }
}

function canContain(& $obj)
{
        return is_a($obj, 'YTable') && ($obj->col == $this->col);
}

赤い部分と青い部分を同時に満たせば、TRUEを返し、それ以外だとFALSEを返す

まずは、赤い部分を見てみる。
ここでの $obj は処理直後のオブジェクトで、$this は一つ前の処理の
オブジェクトを指す。
処理直後のオブジェクトのクラス名と、1つ前に処理したオブジェクトの
クラス名が同じかどうかのチェックを行う。
この場合、2回連続、YTableクラスのオブジェクトの処理の話なので、
赤い部分の条件は満たされる。

青い部分を見てみる。
YTableクラス内の変数 $col は、何列のテーブルかを記録している変数だ。
なので、処理直後のオブジェクトに格納されているテーブルの列の数と
1つ前の処理されたオブジェクトに格納されているテーブルの列の数とを
比較している。もし、同じ数であれば、青い部分の条件は満たされる。

実は、ここに1つの処理と、処理直後のテーブルとが同じ物か
別物なのかの区別をしているのだ！

function & add(& $obj)
{
        if ($this->canContain($obj)) {
                return $this->insert($obj);
        } else {
                return $this->parent->add($obj);
        }
}

function & insert(& $obj)
{
        $this->elements[] = $obj->elements[0];

        return $this;
}

赤い部分は、1つ前に処理したオブジェクトの中に格納された
処理済みのコンテンツのデータが入った配列だ。

青い部分は、処理直後のオブジェクトに格納された
処理済みコンテンツのデータだ。
文字列なので配列の先頭に格納されているのでelement[0]となる。

なんとここで、1つ前に処理されたオブジェクトの中にある
処理済みコンテンツ用の配列の中に、追加という形で、
処理直後の処理済みコンテンツのデータが入れられる。
図にすると以下のようになる。

そして、最後のピンクの部分 return $this; だが、
1つ前に処理したオブジェクトを返り値にしている。

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & 1つ前に処理したオブジェクト
        continue;
        }
}

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add($factoryname($this, $line));
        continue;
        }
}

// Other Character
if (isset($this->factories[$head])) {
        $factoryname = 'Factory_' . $this->factories[$head];
        $this->last  = & $this->last->add(データ処理済みの、Headingのオブジェクト);
        continue;
        }
}

function & add(& $obj)
{
        if ($this->canContain($obj)) {
                return $this->insert($obj);
        } else {
                return $this->parent->add($obj);
        }
}

function & add(& $obj)
{
        if ($this->canContain($obj)) {
                return $this->insert($obj);
        } else {
                return $this->parent->add($obj);
        }
}

function & insert(& $obj)
{
        if (is_a($obj, 'Inline')) $obj = & $obj->toPara();
        return parent::insert($obj);
}

この話での $obj は、Headingクラスのオブジェクトになるため、
is_a($obj, 'Inline' の結果は、FALSE になる。

そして、return parent::insert($obj); が実行される。

function & insert(& $obj)
{
        $obj->setParent($this);
        $this->elements[] = & $obj;

        return $this->last = & $obj->last;
}

赤い部分は、現在、処理されたばかりのHeadingクラスのオブジェクトの中の
setParent()関数に、自分自身のオブジェクト(Bodyクラス)を代入している。
その結果、処理されたばかりのオブジェクトの変数 $parent は
Bodyクラスのオブジェクトが入る。

青い部分は、Bodyクラスの $elements[]配列の中に、現在、処理されたばかりの
Headingクラスのオブジェクトを代入する。

ピンクの部分は、Bodyクラスの $last変数に、処理されたばかりの
Headingクラスのオブジェクトを代入する。

** おしらせ

<h3 id="content_1_0">お知らせ  <a class="anchor_super" 
id="wbf317c3" href="http://***********/index.php?FrontPage#wbf317c3" 
title="wbf317c3">&dagger;</a></h3>

(注意)
本当は1行で吐き出される部分なのですが、見やすいように意図的に
改行を入れました

// Heading
if ($head == '*') {
        $this->insert(new Heading($this, $line));
        continue;
}

// * Heading1
// ** Heading2
// *** Heading3
class Heading extends Element
{
        var $level;
        var $id;
        var $msg_top;

        function Heading(& $root, $text)
        {
                parent::Element();

                $this->level = min(3, strspn($text, '*'));
                list($text, $this->msg_top, $this->id) = $root->getAnchor($text, $this->level);
                $this->insert(Factory_Inline($text));
                $this->level++; // h2,h3,h4
        }

        function & insert(& $obj)
        {
                parent::insert($obj);
                return $this->last = & $this;
        }

        function canContain(& $obj)
        {
                return FALSE;
        }

        function toString()
        {
                return $this->msg_top .  $this->wrap(parent::toString(),
                        'h' . $this->level, ' id="' . $this->id . '"');
        }
}

// * Heading1
// ** Heading2
// *** Heading3
class Heading extends Element
{
        var $level;
        var $id;
        var $msg_top;

        function Heading(& $root, $text)
        {
                parent::Element();

                $this->level = min(3, strspn($text, '*'));
                list($text, $this->msg_top, $this->id) = $root->getAnchor($text, $this->level);
                $this->insert(Factory_Inline($text));
                $this->level++; // h2,h3,h4
        }

(以下、省略)

赤い部分は、先頭から何文字「*」が続いているのかチェックして、
その数を $level 変数に代入している。
「*」が4文字以上続く場合は、$level には「3」が代入される。

青い部分だが、getAnchor();関数の返り値は、3つの要素を持った配列だが、
配列に入った値を $text , $msg_top , $id の変数に振り分けている部分だ。

ピンクの部分だが、行の中に、インライン型のプラグインなどが
含まれている場合の処理が行われるのだが、この時点では
パンドラの箱を開ける気がなかったので、封印しようと思った。
しかし、あとで解読するハメになり、インライン型のプラグインの
処理などが記述されている事をする。詳しくは後述しています。

function getAnchor($text, $level)
{
        global $top, $_symbol_anchor;

(以下省略)

$_msg_content_back_to_top = '<div class="jumpmenu">
<a href="#navigator">&uarr;</a></div>';

(注意)
実際には、1行で書かれているのですが、読みやすくするため
意図的に改行をいれました。

'<div class="jumpmenu"><a href="#navigator">&uarr;</a></div>';

function getAnchor($text, $level)
{
        global $top, $_symbol_anchor;

        // Heading id (auto-generated)
        $autoid = 'content_' . $this->id . '_' . $this->count;
        $this->count++;

        // Heading id (specified by users)
        $id = make_heading($text, FALSE); // Cut fixed-anchor from $text
        if ($id == '') {
                // Not specified
                $id     = & $autoid;
                $anchor = '';
         } else {
                $anchor = ' &aname(' . $id . ',super,full){' . $_symbol_anchor . '};';
         }

         $text = ' ' . $text;

         // Add 'page contents' link to its heading
         $this->contents_last = & $this->contents_last->add(new Contents_UList($text, $level, $id));

         // Add heding
         return array($text . $anchor, $this->count > 1 ? "\n" . $top : '', $autoid);
}

仮引数の $text は、処理する行のデータ。
$levelは行の先頭から「*」が何個あるのかの数字だ。
ただし、3つ以上「*」場合は、3の値になっている。 

赤い部分は、先頭から「*」の個数の値に、1を足している。
つまり、この値は「2〜4」の間を指す。

あとでわかる話だが、「*」の個数に1を足した値を n とすると、
その見出しのタグは<Hn>にする設定になっている。
つまり、「*」なら<H2>タグ、「**」なら<H3>タグ、
「***」なら<H4>タグを使っている事になる。

** おしらせ

** お知らせ [#wbf317c3]

function make_heading(& $str, $strip = TRUE)
{
        global $NotePattern;

        // Cut fixed-heading anchors
        $id = '';
        $matches = array();
        if (preg_match('/^(\*{0,3})(.*?)\[#([A-Za-z][\w-]+)\](.*?)$/m', $str, $matches)) {
                $str = $matches[2] . $matches[4];
                $id  = & $matches[3];
        } else {
                $str = preg_replace('/^\*{0,3}/', '', $str);
        }

        // Cut footnotes and tags
        if ($strip === TRUE)
                $str = strip_htmltag(make_link(preg_replace($NotePattern, '', $str)));

        return $id;
}

赤い部分だが、仮引数の部分に & が入っている。
これは、この関数内での変数 $str が処理された場合、その処理が
呼び出し元の変数にも受け継がれる事を意味する。
この変数 $str は処理したい行のデータなので、この関数で処理されたデータは
呼び出し元でも、処理された状態で使われる事になる。

青い部分だが、正規表現だ。
行の見出しのタグ「*」と、表示させたい部分と、nameの属性部分と、
その後ろの部分(表示させたい部分)を取り出す。
それぞれ matches[1],matches[2],matches[3],matches[4]に格納される。

ピンクの部分は、変数 $str の値を、表示させたい部分だけにする処理。

オレンジの部分は、$idの変数に、name属性の値を代入させる部分。

function getAnchor($text, $level)
{
        global $top, $_symbol_anchor;

        // Heading id (auto-generated)
        $autoid = 'content_' . $this->id . '_' . $this->count;
        $this->count++;

        // Heading id (specified by users)
        $id = make_heading($text, FALSE); // Cut fixed-anchor from $text
        if ($id == '') {
                // Not specified
                $id     = & $autoid;
                $anchor = '';
         } else {
                $anchor = ' &aname(' . $id . ',super,full){' . $_symbol_anchor . '};';
         }

         $text = ' ' . $text;

         // Add 'page contents' link to its heading
         $this->contents_last = & $this->contents_last->add(new Contents_UList($text, $level, $id));

         // Add heding
         return array($text . $anchor, $this->count > 1 ? "\n" . $top : '', $autoid);
}

青い部分は、$anchorの変数に、&aname()のプラグインの記述を代入している。
&aname()のプラグインは、<A>タグの nameの属性を
ひっつけるためのものだ。
Pukiwikiには、見出しに<A>タグの nameの属性の印をつけて
他の場所から、その部分へ直接、飛べるような仕掛けがある。
その仕掛けを行う部分だ。


そして、この関数の呼び出し元へ渡す返り値を見てみる。
ピンクの部分だが、見出し上で、表示したい文字列と &aname() プラグインを
ひっつけた値を返している。

赤い部分だが、この $count は同じページ上で、何番目の見出しを表す。
この変数の値が「1」であれば、見出しの右上に「↑」を載せないため
ヌル文字を返し、2以上であれば、$top の変数を返す。

// * Heading1
// ** Heading2
// *** Heading3
class Heading extends Element
{
        var $level;
        var $id;
        var $msg_top;

        function Heading(& $root, $text)
        {
                parent::Element();

                $this->level = min(3, strspn($text, '*'));
                list($text, $this->msg_top, $this->id) = $root->getAnchor($text, $this->level);
                $this->insert(Factory_Inline($text));
                $this->level++; // h2,h3,h4
        }

(以下、省略)

ピンクの部分は、インライン型プラグインなどの処理が行われる。
$text は &aname() プラグインを含むので、ここでプラグインの処理が
行われるのだ。

function toString()
{
        return $this->msg_top .  $this->wrap(parent::toString(),
               'h' . $this->level, ' id="' . $this->id . '"');
}

function toString()
{
        return $this->wrap(parent::toString(),
               'h' . $this->level, ' id="' . $this->id . '"');
}

// &aname;
function plugin_aname_inline()
{
        $convert = FALSE;

        if (func_num_args() < 2)
                return plugin_aname_usage($convert);

        $args = func_get_args(); // ONE or more
        $body = strip_htmltag(array_pop($args), FALSE); // Strip anchor tags only
        array_push($args, $body);

        return plugin_aname_tag($args, $convert);
}

return '<a class="' . $class . '"' . $attr_id . $href . $title . '>' .
        $body . '</a>';

<h3 id="content_1_0">お知らせ  <a class="anchor_super" 
id="wbf317c3" href="http://***********/index.php?FrontPage#wbf317c3" 
title="wbf317c3">&dagger;</a></h3>

(注意)
実際には、1行で書かれているのですが、読みやすくするため
意図的に改行をいれました。

return '<a class="' . $class . '"' . $attr_id . $href . $title . '></a>';

<A>タグで、はさむ物を消したのだ。
これによって、剣は消えると考えた。

ブロック型プラグインという。行頭に使う。
行頭でこのプラグインを指定しないと、
プラグインとして認識してくれない。

インライン型プラグインという。
文章の中なら、どこでも指定できるので便利

&ref(picpic.gif,nolink,around);　

画像の周囲に文字を表示 &br;
うまくいくかなぁ &br;

#ref(picpic.gif,nolink,around);　

画像の周囲に文字を表示 &br;
うまくいくかなぁ &br;

#clear

<div class="img_margin" style="text-align:left">
<img src="http://**********/kanri/index.php?plugin=ref&amp;
page=FrontPage&amp;src=pic.gif" alt="pic.gif" title="pic.gif" 
width="144" height="110" /></div>

<p><img src="http://**********/kanri/index.php?
plugin=ref&amp;page=FrontPage&amp;src=pic.gif" alt="pic.gif" 
title="pic.gif" width="144" height="110" />　</p>

// Body
class Body extends Element
{
        var $id;
        var $count = 0;
        var $contents;
        var $contents_last;
        var $classes = array(
                '-' => 'UList',
                '+' => 'OList',
                '>' => 'BQuote',
                '<' => 'BQuote');
        var $factories = array(
                ':' => 'DList',
                '|' => 'Table',
                ',' => 'YTable',
                '#' => 'Div');

(途中省略)

                        // Other Character
                        if (isset($this->factories[$head])) {
                                $factoryname = 'Factory_' . $this->factories[$head];
                                $this->last  = & $this->last->add($factoryname($this, $line));
                                continue;
                        }

(途中省略)

function & Factory_Div(& $root, $text)
{
        $matches = array();

        // Seems block plugin?
        if (PKWKEXP_DISABLE_MULTILINE_PLUGIN_HACK) {
                // Usual code
                if (preg_match('/^\#([^\(]+)(?:\((.*)\))?/', $text, $matches) &&
                    exist_plugin_convert($matches[1])) {
                        return new Div($matches);
                }
        } else {
                // Hack code
                if(preg_match('/^#([^\(\{]+)(?:\(([^\r]*)\))?(\{*)/', $text, $matches) &&
                   exist_plugin_convert($matches[1])) {
                        $len  = strlen($matches[3]);
                        $body = array();
                        if ($len == 0) {
                                return new Div($matches); // Seems legacy block plugin
                        } else if (preg_match('/\{{' . $len . '}\s*\r(.*)\r\}{' . $len . '}/', $text, $body)) { 
                                $matches[2] .= "\r" . $body[1] . "\r";
                                return new Div($matches); // Seems multiline-enabled block plugin
                        }
                }
        }

        return new Paragraph($text);
}

赤い部分は初期設定では「1」の定数だ。
この定義は pukiwiki.ini.php のソースの中にある。

青い部分は正規表現で、プラグインの種類とパラメータを取り出す。
#ref(test.gif,nolink); なら「ref」の文字をmatche[1]に代入し、
matches[2]には「nolink」が代入されるように、matches[2]以降は
パラメーターの値が入る。

ピンクの部分は、その種類のプラグインが実際に存在するかどうかの確認だ。

青い部分の正規表現で抽出可能で、かつピンクの部分が満たされれば
オレンジの部分が働く。

オレンジの部分は Divクラスの初期化の際、青い部分の正規表現で
取得したプラグインの種類やパラメータが入ったmeches[]配列が送られる。
Divクラスでの初期化を行った時にできたオブジェクトが、
そのまま、この関数の返り値になる。

// Block plugin: #something (started with '#')
class Div extends Element
{
        var $name;
        var $param;

        function Div($out)
        {
                parent::Element();
                list(, $this->name, $this->param) = array_pad($out, 3, '');
        }

        function canContain(& $obj)
        {
                return FALSE;
        }

        function toString()
        {
                // Call #plugin
                return do_plugin_convert($this->name, $this->param);
        }
}

この青い部分だが、配列の要素を3つにする仕掛けになっている。
まぁ、このクラスが受け取った $outの配列は、要素数が3つなので、
どうもこの部分は意味がわかりにくいが、まぁ、万が一、
配列の要素が4つや5つだったとしても、最終的な確認という意味で
3つにする部分という解釈なのかもしれない。

赤い部分だが、配列を個々の変数に割り振る部分だ。
配列 $out だが、$out[0]は、プラグイン全体なので、無視。
$out[1]はプラグイン名が入っている。この値を $name に代入。
$out[2]は、パラメーターが入っている。この値を $paramに代入。

// Block plugin: #something (started with '#')
class Div extends Element
{
        var $name;
        var $param;

        function Div($out)
        {
                parent::Element();
                list(, $this->name, $this->param) = array_pad($out, 3, '');
        }

        function canContain(& $obj)
        {
                return FALSE;
        }

        function toString()
        {
                // Call #plugin
                return do_plugin_convert($this->name, $this->param);
        }
}

まさに青い部分だ。
$this->name と、$this->paramは Divクラスの初期化の際に
それぞれプラグイン名と、パラメータの値として保管されている。

そして、do_plugin_convert()関数を呼び出す。

// Default
$this->last = & $this->last->add(Factory_Inline($line));

function & Factory_Inline($text)
{
        if (substr($text, 0, 1) == '~') {
                // 行頭 '~' 。パラグラフ開始
                return new Paragraph(' ' . substr($text, 1));
        } else {
                return new Inline($text);
        }
}

青い部分は、処理する行の行頭が「~」かどうかを調べる。
もし、「~」の場合、プラグインなども処理されずに、
入力された通りの内容が表示される。

それ以外の場合は、ピンクの部分。Inlineクラスが初期化され、
そのオブジェクトを、この関数の返り値にしている。

// インライン要素
class Inline extends Element
{
        function Inline($text)
        {
                parent::Element();
                $this->elements[] = trim((substr($text, 0, 1) == "\n") ?
                        $text : make_link($text));
        }

処理する行の行頭が「\n」という改行文字なら、青い部分にありますように
そのままにしておき、その値を $this->elements[] の配列の中に入ります。

そうでない場合はピンクの部分の make_link()関数が動きます。
その返り値が $this->elements[] の配列の中に入ります。

function make_link($string, $page = '')
{
        global $vars;
        static $converter;

        if (! isset($converter)) $converter = new InlineConverter();

        $clone = $converter->get_clone($converter);

        return $clone->convert($string, ($page != '') ? $page : $vars['page']);
}

赤い部分は $converter の中身がセットされているかどうかのチェックで
セットされていない場合は、青い部分が動く。

青い部分は、変数 $converterをInlineConverterクラスのオブジェクトにして
そのオブジェクトを初期化する。

class InlineConverter
{
        var $converters; // as array()
        var $pattern;
        var $pos;
        var $result;


(途中、省略)


function InlineConverter($converters = NULL, $excludes = NULL)
{
        if ($converters === NULL) {
                $converters = array(
                        'plugin',        // Inline plugins
                        'note',          // Footnotes
                        'url',           // URLs
                        'url_interwiki', // URLs (interwiki definition)
                        'mailto',        // mailto: URL schemes
                        'interwikiname', // InterWikiNames
                        'autolink',      // AutoLinks
                        'bracketname',   // BracketNames
                        'wikiname',      // WikiNames
                        'autolink_a',    // AutoLinks(alphabet)
                );
        }

        if ($excludes !== NULL)
                $converters = array_diff($converters, $excludes);

        $this->converters = $patterns = array();
        $start = 1;

        foreach ($converters as $name) {
                $classname = 'Link_' . $name;
                $converter = new $classname($start);
                $pattern   = $converter->get_pattern();
                if ($pattern === FALSE) continue;

                $patterns[] = '(' . "\n" . $pattern . "\n" . ')';
                $this->converters[$start] = $converter;
                $start += $converter->get_count();
                ++$start;
        }
        $this->pattern = join('|', $patterns);
}

このクラスの初期化で、赤い部分はプラグインやURLなどの抽出を行うための
パターンを作成するための準備だ。各パターン別に配列に入れる。

青い部分は、各抽出パターンごとに該当する正規表現を取り出し
配列 $patterns[] に、その正規表現を入れていく。

ピンクの部分は、各抽出パターンに正規表現を「|」で連結した文字列にして
それをInlineConverterクラスの中の $pattern 変数の値にする。

foreach ($converters as $name) {
        $classname = 'Link_' . $name;
        $converter = new $classname($start);
        $pattern   = $converter->get_pattern();
        if ($pattern === FALSE) continue;

        $patterns[] = '(' . "\n" . $pattern . "\n" . ')';
        $this->converters[$start] = $converter;
        $start += $converter->get_count();
        ++$start;
}

赤い部分は、各抽出パターンに関する情報が入ったクラス名を作成。
青い部分は、各抽出パターンに関する情報が入ったオブジェクトを作る。
ピンクの部分は、各抽出パターンの正規表現を、変数 $patternの値にしている。

        function get_pattern()
        {
                $this->pattern = <<<EOD
&
(      # (1) plain
 (\w+) # (2) plugin name
 (?:
  \(
   ((?:(?!\)[;{]).)*) # (3) parameter
  \)
 )?
)
EOD;
                return <<<EOD
{$this->pattern}
(?:
 \{
  ((?:(?R)|(?!};).)*) # (4) body
 \}
)?
;
EOD;
        }

上のソースを見ると、ヒアドキュメントで書かれている。
青い部分だが、ご丁寧に正規表現で取り出す項目が説明されている。

赤い部分は、表示させたいテキスト部分を抜き取る部分だ。

画像関係のプラグインの場合だと、 &ref(pic.gif,nolink); のように
テキスト部分は不要なため、赤い部分がある理由が見えてこないが、
&color(色){文章} のように、文字列に色をつけるプラグインや
&size(大きさ){文章}のように、文字の大きさを変更する
プラグインの場合だと、body、即ち、文章の部分が必要になる。
その文章を抜き取る部分を意味するのだ。

foreach ($converters as $name) {
        $classname = 'Link_' . $name;
        $converter = new $classname($start);
        $pattern   = $converter->get_pattern();
        if ($pattern === FALSE) continue;

        $patterns[] = '(' . "\n" . $pattern . "\n" . ')';
        $this->converters[$start] = $converter;
        $start += $converter->get_count();
        ++$start;
}

赤い部分は、個々の抽出パターンに該当する正規表現を
配列 $patterns[] の中にいれて行く。

青い部分だが、配列 $converters[] に、各抽出パターンのデータが入った
オブジェクトを入れていくのだ。

class InlineConverter
{
        var $converters; // as array()
        var $pattern;
        var $pos;
        var $result;


(途中、省略)


function InlineConverter($converters = NULL, $excludes = NULL)
{

(途中、省略)

        $this->pattern = join('|', $patterns);
}

ピンクの部分は、各抽出パターンに正規表現を「|」で連結した文字列にして
それをInlineConverterクラスの中の $pattern 変数の値にする。

「|」は、いくつかの正規表現のパターンのうち、いずれかが
マッチするための物だ。条件文に出てくる「or」に近い。

function make_link($string, $page = '')
{
        global $vars;
        static $converter;

        if (! isset($converter)) $converter = new InlineConverter();

        $clone = $converter->get_clone($converter);

        return $clone->convert($string, ($page != '') ? $page : $vars['page']);
}

この赤い部分だが、変数 $clone に、自分自身のオブジェクト($converter)を
指すための部分だ。

青い部分は、いよいよクライマックスの、プラグイン等を抽出して
変換を行う部分だ。

function convert($string, $page)
{
        $this->page   = $page;
        $this->result = array();

        $string = preg_replace_callback('/' . $this->pattern . '/x',
                array(& $this, 'replace'), $string);

        $arr = explode("\x08", make_line_rules(htmlspecialchars($string)));
        $retval = '';
        while (! empty($arr)) {
                $retval .= array_shift($arr) . array_shift($this->result);
        }
        return $retval;
}

この赤い部分だが、$string の変数に入った文字列、つまり処理する行の中から
プラグインなどのパターンを抽出して変換を行う部分なのだ。

さて、preg_replace_callback()関数なのだが、使い方は
preg_replace_callback(正規表現, コールバック関数, 文字列)となる。

コールバック関数は、ユーザーが定義した関数という意味だ。
ただし、なぜユーザー定義関数と言わずに、コールバック関数と呼ぶのかは
調べてみましたが、わかりませんでした。

preg_replace_callback()関数だが、処理前の文字列(ここでは $string)を
正規表現でパターンを抽出して、抽出した物を、コールバック関数へ送り、
その返り値を preg_replace_callback() の返り値にしている。

さて、コールバック関数の部分だが、 array(& $this, 'replace')と
配列変数の記述をしている。配列と関連がありそうなのだが、
実は、同じクラス内で定義した関数を呼び出すためのテクニックにすぎない。
これに何か意味があるのだろうかと、色々、調べたのだが、
結局、調べた時間(1時間くらい)が無駄になってしまった  (--;;

function replace($arr)
{
        $obj = $this->get_converter($arr);

        $this->result[] = ($obj !== NULL && $obj->set($arr, $this->page) !== FALSE) ?
        $obj->toString() : make_line_rules(htmlspecialchars($arr[0]));

        return "\x08"; // Add a mark into latest processed part
}

赤い部分は get_converter()を呼び出しています。
この関数は、

function & get_converter(& $arr)
{
        foreach (array_keys($this->converters) as $start) {
                if ($arr[$start] == $arr[0])
                        return $this->converters[$start];
        }
        return NULL;
}

赤い部分を見てみる。
配列 $converters[] はプラグインやURLなどの抽出パターンが入った
オブジェクトを指すための配列だ。
さきほど、説明した通り、キーの数字は、パラメーター数分の間隔を空けている。

そして、値の入った配列のキーの値だけを取り出し、繰り返し処理を行う。
$startはキーの値が入る。

青い部分だが、arr[0]とarr[$start]の一致だが、これはピンクの部分にある
プラグインやURLのうち、該当する処理を行うオブジェクトを取り出すための
条件式になるのだが、どうも理解できない。

function & get_converter(& $arr)
{
        foreach (array_keys($this->converters) as $start) {
                if ($arr[$start] == $arr[0])
		        {
			print_r($arr);
                        return $this->converters[$start];
			}
        }
        return NULL;
}

$arr配列は、処理する行の中から、プラグインやURLなどの正規表現の処理で
取り出された部分が入っている。
赤い部分は、その配列の中身を見てみる部分だ。

Array ( [0] => [[あああ>http://www.kek.jp]] [1] => [2] => [3] => 
[4] => [5] => [6] => [7] => [8] => [[あああ>http://www.kek.jp]] 
[9] => [[あああ> [10] => あああ [11] => http://www.kek.jp )

Array ( [0] => &ref(picpic.gif,nolink); [1] => &ref(picpic.gif,nolink);
[2] => ref(picpic.gif,nolink) [3] => ref [4] => picpic.gif,nolink ) 

[[ URL ]] の場合は、0番目と8番目の中身が一致する。
プラグインの場合は、0番目と1番目の中身が一致する。

実は、この0番目以外の、もう一つの同じ部分に秘密がある
これは、さきほど説明しましたプラグインやURLなどの処理方法が入った
オブジェクトを指す配列 $converters だが、このキーの部分と
上の $arrの0番目のキーの中身と一致するキーの番号は同じ数字なのだ。

図にすると以下のようになる。

という事で、 $arr[0] と一致するキーを探すのは重要な上、
$arr配列を生成する時の正規表現には、そういう秘密があったのだ。

function replace($arr)
{
        $obj = $this->get_converter($arr);

        $this->result[] = ($obj !== NULL && $obj->set($arr, $this->page) !== FALSE) ?
        $obj->toString() : make_line_rules(htmlspecialchars($arr[0]));

        return "\x08"; // Add a mark into latest processed part
}

赤い部分は、該当のオブジェクトの取得を意味する。

そして、青い部分を見てみる。
これは各パターンごとに処理したデータの入ったオブジェクト、
すなわち、赤い部分で取得したオブジェクトのtoString() 関数を指す。
これはデータの出力時に使われる。

しかも、プラグインの場合のtoString()関数には、2重プラグインの
対応もできるようにしている。

例えば、 &color(red){ &size(24){ テストだよ！ }; }; の場合だ。

「テストだよ！」の大きさを24にして、その後、文字を赤くする。
これは一番外側のプラグインを処理する時、中のプラグインは
まだ処理されていない。 toString()関数の中では、一つ中にある
プラグインを抽出して処理するため、もう一度、make_link()関数を
呼び出しているのだ！  再帰関数のような感じだ。

図にすると次のようになる。

それ以外の場合は、make_line_rules()関数を使って、
文字列の処理を行う。一体、この関数は何なのか。
この時点では調べませんでした。というよりも、頭の中が混乱していて
とても追っかける気が起こりませんでした。

先に種明かしをしますと、これはユーザー定義ルールを拾い出し
それを処理する関数なのだ。
Pukiwikiでのデフォルト設定としての、ユーザー定義ルールがある。
それは COLOR(red){赤いぜ！} のように、プラグインとは違った使い方でも、
同じような働きをするルールだ。
この、make_line_rules()関数について詳しくは後述しています。

function convert($string, $page)
{
        $this->page   = $page;
        $this->result = array();

        $string = preg_replace_callback('/' . $this->pattern . '/x',
                array(& $this, 'replace'), $string);

        $arr = explode("\x08", make_line_rules(htmlspecialchars($string)));
        $retval = '';
        while (! empty($arr)) {
                $retval .= array_shift($arr) . array_shift($this->result);
        }
        return $retval;
}

赤い部分で、いくつかの正規表現にマッチさせた物をreplace関数に送る。
その結果が「 \x08 」という物がreplace関数から返され、
正規表現で一致した部分は「 \x08 」に置き換わる。
「 \x08 」は単に目印のために使っているだけで、特に、この文字には
意味はない。

青い部分は、まずは $string 変数をhtmlspecialchars()関数で処理する。
ちなみに、htmlspecialchars()関数は、「 > 」や「 " 」などを
「 > 」や「 " 」に変換する関数だ。
タグなどを構成する文字に間違えられそうな物を
ブラウザで問題なく表示できるような文字に変換するための関数だ。
掲示板などで入力された文字列で、HTMLのタグが含まれている場合に
タグの無効化に使われる定番の関数だ。 

さて、make_line_rules()関数は、さきほども紹介しました関数で
ユーザー定義ルールを処理する関数だ。詳しくは後述しています。

そして、さきほど赤い部分で、パターンにマッチした正規表現を抜き取り
「 \x08 」の文字を入れたが、この文字を区切りとして、
$stringの文字列は、配列 $arr[] に格納されていく。

function convert($string, $page)
{
        $this->page   = $page;
        $this->result = array();

        $string = preg_replace_callback('/' . $this->pattern . '/x',
                array(& $this, 'replace'), $string);

        $arr = explode("\x08", make_line_rules(htmlspecialchars($string)));
        $retval = '';
        while (! empty($arr)) {
                $retval .= array_shift($arr) . array_shift($this->result);
        }
        return $retval;
}

赤いソースの部分の役目を図にしてみる。
「 画像は &ref(pic.gif);でリンクは[[ここ>http://example.com]]だよ 」
の文章を例にして、処理の内容を見ていく。

赤いソースの部分で、プラグインなどに関する部分とを分離して
文章の部分に、プラグインがあった場所に目印を付けて $string に返す。
そして、抽出されたプラグインやリンクなどは、個々の処理に該当する
オブジェクトに代入さて、そのオブジェクトを指す部分を保管するのに
$result[]配列が使われる。

青いソースの部分は、加工した文章を配列にする部分だ。

function convert($string, $page)
{
        $this->page   = $page;
        $this->result = array();

        $string = preg_replace_callback('/' . $this->pattern . '/x',
                array(& $this, 'replace'), $string);

        $arr = explode("\x08", make_line_rules(htmlspecialchars($string)));
        $retval = '';
        while (! empty($arr)) {
                $retval .= array_shift($arr) . array_shift($this->result);
        }
        return $retval;
}

ピンクのソースの部分が、一度、切り離したプラグインやリンクの部分を
HTMLのソースに加工して元に戻す部分だ。
図にすると以下のようになる。

// User-defined rules (convert without replacing source)
function make_line_rules($str)
{
        global $line_rules;
        static $pattern, $replace;

        if (! isset($pattern)) {
                $pattern = array_map(create_function('$a',
                        'return \'/\' . $a . \'/\';'), array_keys($line_rules));
                $replace = array_values($line_rules);
                unset($line_rules);
        }

        return preg_replace($pattern, $replace, $str);
}

ここでグローバル変数の $line_rules配列が何なのか気になった。
このグローバル変数がポイントになる。

/////////////////////////////////////////////////
// ユーザ定義ルール
//
//  正規表現で記述してください。?(){}-*./+\$^|など
//  は \? のようにクォートしてください。
//  前後に必ず / を含めてください。行頭指定は ^ を頭に。
//  行末指定は $ を後ろに。
//
/////////////////////////////////////////////////
// ユーザ定義ルール(コンバート時に置換)
$line_rules = array(
        'COLOR\(([^\(\)]*)\){([^}]*)}'  => '<span style="color:$1">$2</span>',
        'SIZE\(([^\(\)]*)\){([^}]*)}'   => '<span style="font-size:$1px">$2</span>',
        'COLOR\(([^\(\)]*)\):((?:(?!COLOR\([^\)]+\)\:).)*)'     => '<span style="color:$1">$2</span>',
        'SIZE\(([^\(\)]*)\):((?:(?!SIZE\([^\)]+\)\:).)*)'       => '<span class="size$1">$2</span>',
        '%%%(?!%)((?:(?!%%%).)*)%%%'    => '<ins>$1</ins>',
        '%%(?!%)((?:(?!%%).)*)%%'       => '<del>$1</del>',
        "'''(?!')((?:(?!''').)*)'''"    => '<em>$1</em>',
        "''(?!')((?:(?!'').)*)''"       => '<strong>$1</strong>',
);

これを見て、なるほどと思った。
ここの部分で、ユーザーが独自に簡単な正規表現のルールを作って
独自の関数っぽいものを作る事ができる。
まぁ、これは正規表現を使った置き換えなので、関数とは言えないので
「関数っぽい物」という表現にしましたが。

文字の強調で、強調した文字列を「''」で囲んで '' 強調！！ ''とするのだが、
この時、初めて、ユーザー定義ルールだったのを知った。

// User-defined rules (convert without replacing source)
function make_line_rules($str)
{
        global $line_rules;
        static $pattern, $replace;

        if (! isset($pattern)) {
                $pattern = array_map(create_function('$a',
                        'return \'/\' . $a . \'/\';'), array_keys($line_rules));
                $replace = array_values($line_rules);
                unset($line_rules);
        }

        return preg_replace($pattern, $replace, $str);
}

赤い部分と青い部分を見てみるのだが、その前に、array_map()関数の
意味がわからないと、この部分がわからなくなる。

arrary_map()関数とは、2つ以上の引数を持つ関数なのだが、
ここでは2つとしておく。
この関数は、 arrary_map(コールバック関数,配列) という形で使う。
この関数は、引数の配列の中身を1つづつ、コールバック関数に送って処理し、
処理した生成物を、別の配列に1つづつ入れていくのだ。

青い部分だが、$line_rules 配列のキーを取り出し、コールバック関数に送る。
赤い部分のコールバック関数だが、送られてきた物を、ここでは
$a という変数に格納し、'/.$a./'
という感じで
両端を「 '」と「/」で囲む処理を行う。
その結果を $pattern の配列に送り込むのだ。

すなわち、正規表現のパターンとして使える形に加工する部分だ。

そして、茶色の部分だが、これは$line_rules 配列を、array_values()関数で
キーを「0」、「1」、「2」に置き換える役目を果たす。

これで変換するための準備は完了だ。

あとは return 部分で、正規表現でパターンを抽出して、置き換え作業を行い
置き換えた物を返り値にしているのだ。

/////////////////////////////////////////////////
// Main

$retvars = array();
$is_cmd = FALSE;
if (isset($vars['cmd'])) {
        $is_cmd  = TRUE;
        $plugin = & $vars['cmd'];
} else if (isset($vars['plugin'])) {
        $plugin = & $vars['plugin'];
} else {
        $plugin = '';
}
if ($plugin != '') {
        if (exist_plugin_action($plugin)) {
                // Found and exec
                $retvars = do_plugin_action($plugin);
                if ($retvars === FALSE) exit; // Done

                if ($is_cmd) {
                        $base = isset($vars['page'])  ? $vars['page']  : '';
                } else {
                        $base = isset($vars['refer']) ? $vars['refer'] : '';
                }
        } else {
                // Not found
                $msg = 'plugin=' . htmlspecialchars($plugin) .
                        ' is not implemented.';
                $retvars = array('msg'=>$msg,'body'=>$msg);
                $base    = & $defaultpage;
        }
}

赤い部分は、$var['cmd']の値があるかどうかのチェックだ。
編集画面を呼び出す時、クエリーでcmdの値を送っているので、
この部分は必然的に TRUE になり、条件式が満たされる。

青い部分は $plugin 変数に、cmdの値を代入している。
編集画面の場合、cmd値は「edit」 なのだ。

ピンクの部分だが、 $pluginの値は空ではないので、TRUE になり
条件式を満たす。

/////////////////////////////////////////////////
// Main()

$retvars = array();

(途中省略)

if ($plugin != '') {
        if (exist_plugin_action($plugin)) {
                // Found and exec
                $retvars = do_plugin_action($plugin);
                if ($retvars === FALSE) exit; // Done

                if ($is_cmd) {
                        $base = isset($vars['page'])  ? $vars['page']  : '';
                } else {
                        $base = isset($vars['refer']) ? $vars['refer'] : '';
                }
        } else {
                // Not found
                $msg = 'plugin=' . htmlspecialchars($plugin) .
                        ' is not implemented.';
                $retvars = array('msg'=>$msg,'body'=>$msg);
                $base    = & $defaultpage;
        }
}

ピンクの条件式を満たすのは説明しました。

青い部分ですが、編集のためのプラグインが存在するかどうか確認し
該当のプラグインが存在すれば、TRUEの値を返す部分。

赤い部分は、該当のプラグインを動かす部分。
この do_plugin_action($plugin) 関数の返り値は配列だ。
返り値を格納する $retvals 変数が配列だからだ。

この $retvals 配列は2つのキーを持つ。
1つは「 msg 」というキーで、もう1つは「 body 」というキーだ。

// Call API 'action' of the plugin
function do_plugin_action($name)
{
        if (! exist_plugin_action($name)) return array();

        if(do_plugin_init($name) === FALSE)
                die_message('Plugin init failed: ' . $name);

        $retvar = call_user_func('plugin_' . $name . '_action');

        // Insert a hidden field, supports idenrtifying text enconding
        if (PKWK_ENCODING_HINT != '')
                $retvar =  preg_replace('/(<form[^>]*>)/', '$1' . "\n" .
                        '<div><input type="hidden" name="encode_hint" value="' .
                        PKWK_ENCODING_HINT . '" /></div>', $retvar);

        return $retvar;
}

赤い部分が該当のプラグインを呼び出す所だ。
青い部分は、赤い部分で得た返り値を、そのままオウム返しのように
do_plugin_action()関数の返り値としているのだ。

function plugin_edit_action()
{
        global $vars, $_title_edit, $load_template_func;

        if (PKWK_READONLY) die_message('PKWK_READONLY prohibits editing');

        $page = isset($vars['page']) ? $vars['page'] : '';

        check_editable($page, true, true);

        if (isset($vars['preview']) || ($load_template_func amp;amp; isset($vars['template']))) {
                return plugin_edit_preview();
        } else if (isset($vars['write'])) {
                return plugin_edit_write();
        } else if (isset($vars['cancel'])) {
                return plugin_edit_cancel();
        }

        $postdata = @join('', get_source($page));
        if ($postdata == '') $postdata = auto_template($page);

        return array('msg'=>$_title_edit, 'body'=>edit_form($page, $postdata));
}

赤い部分を見てみる。
返り値の配列でキーがmsgの部分には、変数 $_title_edit の値が入る。
変数 $_title_edit はグロバール変数だ。
ja.lng.phpのソースの中で代入されている。

$_title_edit       = '$1 の編集';

$1の部分は、lib/pukiwiki.phpの中で加工処理のために「$1」にしている。


青い部分は、配列のキーが body の場合の値だ。
edit_form($page, $postdata) の値が入る。
edit_form()関数は lib/html.phpで定義されている関数で、
編集したいページのコンテンツを呼び出し、編集画面の中で表示させるための
HTMLソースを吐き出させる関数だ。

つまり、配列のキーが body の場合、編集画面のHTMLのソースが
格納されるというわけだ。

/////////////////////////////////////////////////
// Main()

$retvars = array();

(途中省略)

if ($plugin != '') {
        if (exist_plugin_action($plugin)) {
                // Found and exec
                $retvars = do_plugin_action($plugin);
                if ($retvars === FALSE) exit; // Done

                if ($is_cmd) {
                        $base = isset($vars['page'])  ? $vars['page']  : '';
                } else {
                        $base = isset($vars['refer']) ? $vars['refer'] : '';
                }
        } else {
                // Not found
                $msg = 'plugin=' . htmlspecialchars($plugin) .
                        ' is not implemented.';
                $retvars = array('msg'=>$msg,'body'=>$msg);
                $base    = & $defaultpage;
        }
}

$title = htmlspecialchars(strip_bracket($base));
$page  = make_search($base);
if (isset($retvars['msg']) && $retvars['msg'] != '') {
        $title = str_replace('$1', $title, $retvars['msg']);
        $page  = str_replace('$1', $page,  $retvars['msg']);
}

赤い部分の do_plugin_action()の返り値は、配列 $retvarsに格納される。
編集画面の呼び出しの場合、キーがmsgの部分には「$1 の編集」の文字列が入り
キーがbodyの部分には、編集画面のHTMLソースが入る

さて、配列 $retvarsのキーがmsgの部分に格納されている文字列は
「$1 の編集」になっている。(編集画面を呼び出す時のみだが)
$1にしている理由だが、答えは青い部分とピンクの部分にある。
それぞれ $1 を置き換えているのだ。つまり置き換える場所の目印だったのだ。

なので、編集画面の場合、<TITLE>のタグの中には「(ページ名)の編集」と
いう文字列が入り、それが表示される仕組みになっている。

/////////////////////////////////////////////////
// Main()

$retvars = array();

(途中省略)

$title = htmlspecialchars(strip_bracket($base));
$page  = make_search($base);
if (isset($retvars['msg']) && $retvars['msg'] != '') {
        $title = str_replace('$1', $title, $retvars['msg']);
        $page  = str_replace('$1', $page,  $retvars['msg']);
}

if (isset($retvars['body']) && $retvars['body'] != '') {
        $body = & $retvars['body'];
} else {
        if ($base == '' || ! is_page($base)) {
                $base  = & $defaultpage;
                $title = htmlspecialchars(strip_bracket($base));
                $page  = make_search($base);
        }

        $vars['cmd']  = 'read';
        $vars['page'] = & $base;

        $body  = convert_html(get_source($base));

        if ($trackback) $body .= tb_get_rdf($base); // Add TrackBack-Ping URI
        if ($referer) ref_save($base);
}

// Output
catbody($title, $page, $body);
exit;

そして赤い部分の条件文で、条件を満たすため、青い部分に移る。
青い部分は、プラグイン処理などで生成したHTMLソースを格納している
$retvars['body'] を、$body 変数に代入している。

$body変数とは、skin/pukiwiki.skin.php のソース内で、
ブラウザに出力する際に使う変数だ。

そしてピンクは出力のための関数だ。

<?php if (arg_check('read') && exist_plugin_convert('menu')) { ?>
<table border="0" style="width:100%">
 <tr>
  <td class="menubar">
   <div id="menubar"><?php echo do_plugin_convert('menu') ?></div>
  </td>
  <td valign="top">
   <div id="body"><?php echo $body ?></div>
  </td>
 </tr>
</table>
<?php } else { ?>
<div id="body"><?php echo $body ?></div>
<?php } ?>

赤い部分は、メニュー画面の出力のプラグインの有無を調べている部分。
青い部分は、メニュー画面の HTMLソースを吐き出す部分。

赤い部分だが、読み込んだメニューのコンテンツデータの$menutextを
convert_html()関数で加工している。

convert_html()関数とは、既に説明しましたが、コンテンツの中の
プラグインやユーザー定義ルールなどをHTMLに変換する関数だ。

これを見れば、コンテンツ表示画面と何ら変わらない事がわかる。