【Movable Typeでも複雑な処理を一元管理！】1/3複雑な処理をスッキリ整理！　グローバル・モディファイアプラグイン｜BLOG｜株式会社エムハンド

CMSのテンプレートに同じ処理が何度も出てくる場合、皆さんはどうしていますか？
「コピー＆ペースト」？
確かに同じ処理を行うことができますね。
でもCMSは一つの「システム」です。
「システム」が入っている以上、「システム」にやらせたいとは思いませんか？
まずはMovable Typeについて、以下のようなケースを考えてみましょう。

このリンク、かっこ悪いけど……

Movable Typeでは本来、カテゴリ、月別などのアーカイブテンプレートや個別テンプレートとその元となる記事は出力されるURLを基準にブログが指定されるべきです。
しかし、特にPowerCMSのカスタムオブジェクトなどでは、データの関連性や会員専用エリアなどの都合でURLとは違うブログに所属させたほうが都合がいい場合があります。
そのような事情でアーカイブテンプレートなどをブログURLの下ではないディレクトリに出力した場合でも、同じドメイン内であれば<$MTCategoryArchiveLink$>などでURLを出力したリンクそのままで遷移する事ができます。
しかし、出力されたHTMLのソースをみてみると……

<a href="http://www.exsample.com/dir0/news/../../dir1/cat/index.php">リンク</a>

1	<a href="http://www.exsample.com/dir0/news/../../dir1/cat/index.php">リンク</a>

上のディレクトリを表す「../」がそのまま出力されています。
何らかのシステムで出力されているのがバレバレじゃないですか！？
……ページの内容で分かることも多いのでこの程度であれば放置することもありますが、せっかくなのできれいに整形しましょう。

<$MTCategoryArchiveLink setvar="url"$>
<a href="<$MTGetVar name="url" replace="/dir0/news/../../","/"$>">リンク</a>

1 2	<$MTCategoryArchiveLink setvar="url"$> <a href="<$MTGetVar name="url" replace="/dir0/news/../../","/"$>">リンク</a>

2回だけ上に出ていてそのディレクトリ名もはっきりしているのでこれぐらいで収まりますが、あまりスッキリしませんね。メンテナンス性も悪いです。
こういうときはプラグインでグローバルモディファイアにしてしまいましょう！

プラグインは、作れる。

「プラグインなんて難しい。自分にできるわけがない」とお考えの方も多いでしょう。
しかし今回のような、グローバルモディファイアのプラグイン自体はすごく簡単です。
今回のプラグインは公式の開発者向けガイドと同じような表記だと以下のようなファイル構成になります。テスト関係は割愛しています。

$MT_DIR/

|__ plugins/

    |__ RealPath/

        |__ config.yaml

        |__ lib/

            |＿ RealPath/

                |__ L10N.pm

                |＿ L10N/

                |   |＿ en_us.pm

                |   |＿ ja.pm

                |＿ Tags.pm

「$MT_DIR/」はMTをインストールしたディレクトリです。この直下に「plugins/」ディレクトリがあります。
この下に「RealPath/」ディレクトリ以下を作成します。
実際にプラグインの処理を行うPerlモジュール（PHPやjavascriptのクラスにあたるもの）の設置場所は「RealPath/lib/」以下になります。
複雑なプラグインではこの下に「MT/App/RealPath/」などができる場合もありますが、今回はすべて「RealPath/」配下のモジュールになります。

config.yaml

YAMLは構造化データをシンプルに記述するテキストデータ形式です。
プラグインの基本情報を記述します。

id: RealPath
key: RealPath
name: <__trans phrase="_PLUGIN_NAME">
version: 1.0
description: <__trans phrase="_PLUGIN_DESCRIPTION">
author_name: <__trans phrase="_PLUGIN_AUTHOR">
author_link: https://www.m-hand.co.jp/
l10n_class: RealPath::L10N
tags:
    modifier:
        realpath: $RealPath::RealPath::Tags::_real_path

id: RealPath

key: RealPath

name: <__trans phrase="_PLUGIN_NAME">

version: 1.0

description: <__trans phrase="_PLUGIN_DESCRIPTION">

author_name: <__trans phrase="_PLUGIN_AUTHOR">

author_link: https://www.m-hand.co.jp/

l10n_class: RealPath::L10N

tags:

modifier:

realpath: $RealPath::RealPath::Tags::_real_path

07行目まではMTが他のプラグインと区別する名前や、管理画面などで表示する内容になります。
「<__trans phrase=”なんとか”>」は、08行目で指定しているPerlモジュールによってMTの設定言語により変換される、多言語対応になっています。
09行目では、ここから下のインデントでタグに関する処理があることを意味しています。
10行目では、ここから下のインデントで、グローバルモディファイアを追加することを意味しています。

11行目がこのプラグインの動作を決定しています。
「:」の左側「realpath」がMTMLタグに記述するモディファイアを指定しています。
右側の「$RealPath::RealPath::Tags::_real_path」は「realpath」でこの「RealPath」プラグイン内の「RealPath::Tags」モジュール内の「_real_path」関数を実行することを意味しています。

実際に組んでみよう！

まず、お約束で「config.yaml」08行目で指定している以下のPerlモジュールを追加します。

L10N.pm

package RealPath::L10N;

use strict;

use base 'MT::Plugin::L10N';

1;

package RealPath::L10N;

use strict;

use base 'MT::Plugin::L10N';

l10nは「localization(l＜10文字＞n)」の略です。

package RealPath::L10N;

1	package RealPath::L10N;

このファイルは「RealPath::L10N」モジュールです、という宣言です。「RealPath」はそのプラグインのディレクトリ名になります。
※直接実行しないので（できても何も起こらないはずですが）cgiファイルにあるような「#!/usr/bin/perl -w」といった行は記載しません。

use strict;

3	use strict;

ルールどおりに書かないとエラーを出力します、というおまじないです。
といっても昔のPerlが自由すぎたのであり、よほど古いコードでない限りこのルールに外れたPerlは無いはずです。
※Perlは「昔のコード」を実行できるようにするためにこの命令を追加しましたが、javascriptは逆に「古いブラウザ」でも実行できるように「文字列」として記述するようにしました。

use base 'MT::Plugin::L10N';

5	use base 'MT::Plugin::L10N';

このモジュールは「MT::Plugin::L10N」モジュールを継承しています。
必要な機能は「MT::Plugin::L10N」モジュールに全て実装してあります。
プラグインにその機能を取り込むのがこのモジュールの役割になります。

1;

「ファイルが正常に終わりました」というおまじないです。
Perlにはtrue(真),false(偽)は概念としてはありますが、値として定義されていません。数値の1または0を使用します。もっとも、Perlは１つの変数で文字列と数値の両方を保持するので、文字列でも問題はないはずです。

en_us.pm

英語に翻訳するモジュールです。
少しずつ意味を理解していきましょう。

package RealPath::L10N::en_us;

use strict;

use base 'RealPath::L10N';

our %Lexicon = (
    '_PLUGIN_NAME' => 'Realpath Plugin.',
    '_PLUGIN_DESCRIPTION' => 'remove dotted current/parent path global modifier',
    '_PLUGIN_AUTHOR' => 'M-HAND, Inc.',
);

1;

package RealPath::L10N::en_us;

use strict;

use base 'RealPath::L10N';

our %Lexicon = (

'_PLUGIN_NAME' => 'Realpath Plugin.',

'_PLUGIN_DESCRIPTION' => 'remove dotted current/parent path global modifier',

'_PLUGIN_AUTHOR' => 'M-HAND, Inc.',

);

use base 'RealPath::L10N';

5	use base 'RealPath::L10N';

「RealPath::L10N」モジュールを継承しています。
その「RealPath::L10N」モジュールが「MT::Plugin::L10N」モジュールを継承しているところと同じです。

our %Lexicon = (
    '元の文字列' => '翻訳文字列',
　・
　・
);

our %Lexicon = (

'元の文字列' => '翻訳文字列',

　・

);

perlで「%」で始まるものはハッシュ、他の言語でいう連想配列になります（実はPHP5までの「array()」は全て連想配列です）。
ハッシュ「%Lexicon」に実際に翻訳するデータを追加します。
変数を最初に使う前に「our」をつけることでグローバル変数であることを宣言します。
多言語化する場合でも基本は英語なので、このファイルでは1行も書かないようにプラグインを作ることも可能です。
しかし、config.yamlをスッキリさせるためにこのプラグインのように作られているものが多いです。

ja.pm

日本語に翻訳するモジュールです。

package RealPath::L10N::ja;

use strict;

use base 'RealPath::L10N::en_us';
use utf8;

our　%Lexicon = (
    '_PLUGIN_NAME' => 'realpathプラグイン',
    '_PLUGIN_DESCRIPTION' => 'ピリオドによるパスを変換する グローバル・モディファイア',
    '_PLUGIN_AUTHOR' => '株式会社エムハンド',
);

1;

package RealPath::L10N::ja;

use strict;

use base 'RealPath::L10N::en_us';

use utf8;

our　%Lexicon = (

'_PLUGIN_NAME' => 'realpathプラグイン',

'_PLUGIN_DESCRIPTION' => 'ピリオドによるパスを変換するグローバル・モディファイア',

'_PLUGIN_AUTHOR' => '株式会社エムハンド',

);

use base 'RealPath::L10N::en_us';

5	use base 'RealPath::L10N::en_us';

3回目なのでもう分かりましたよね？
「RealPath::L10N::en_us」モジュールを継承しています。
後は英語が日本語になっている以外はen_us.pmと同じです。

use utf8;

use utf8;

UTF-8でソースファイル（コメント以外）を記述するときのおまじないです。
このモジュールだけ全角文字を使用していることに気づきましたか？
HTML側にかかわらず、PerlモジュールはUTF-8で記述してください。
そして多言語化することで、多言語化モジュール以外の文字コードを気にする必要がなくなるのです。

Tags.pm

package RealPath::Tags;

use strict;

sub _real_path {
    my ($str, $arg, $ctx) = @_;
    return $str if $arg != 1;

    $str =~ s!/([^/]+/..|(?R))/!/!g;
    $str =~ s!/(./)+!/!g;
    $str =~ s!([^:])/+!\1/!g;

    return $str;
}

1;

package RealPath::Tags;

use strict;

sub _real_path {

my ($str, $arg, $ctx) = @_;

return $str if $arg != 1;

$str =~ s!/([^/]+/..|(?R))/!/!g;

$str =~ s!/(./)+!/!g;

$str =~ s!([^:])/+!\1/!g;

return $str;

}

sub _real_path {
　・
　・
　・
　・
　・
　・
　・
    return $str;
}

sub _real_path {

　・

return $str;

}

関数（サブルーチン）になります。引数はここでは宣言できません。
Perlは予約語が比較的短いのも特徴の一つです。
戻り値を渡す「return」はPHPやjavascriptと同じです。

    my ($str, $arg, $ctx) = @_;

6	my ($str, $arg, $ctx) = @_;

「my」をつけることでローカル変数の宣言になっています。
「use strict;」がない時代には、ローカル変数かグローバル変数かの区別をつけられず、大変なことになりました。
宣言する変数を「()」でくくると「リストコンテキスト」になります。
右側の配列の各値をそれぞれの変数で受け取る事ができます。
「@」から始まる変数が配列になります。Perlでは引数は「@_」に引数が設定されています。

    return $str if $arg != 1;

7	return $str if $arg != 1;

本当はそこまでしなくてもいいのですが、念のため「realpath=”1″」が1以外の時には処理をしないことにします。

ここから下で実際の処理を行っています。

    $str =~ s!/([^/]+/..|(?R))/!/!g;
    $str =~ s!/(./)+!/!g;
    $str =~ s!([^:])/+!\1/!g;

$str =~ s!/([^/]+/..|(?R))/!/!g;

$str =~ s!/(./)+!/!g;

$str =~ s!([^:])/+!\1/!g;

わかりにくいですが、少しじっくり見ていきましょう。

=~

パターンマッチ演算子。Perlの強力な検索／置換関数を使用するための演算子です。
Perlを理解するうえでもっとも重要な概念ともいえるでしょう。
といっても今はPHPでもPCREが使えますので、ほぼ同じ動作をするPHPと比較してみると分かりやすいかもしれません。
今回使用しているのは置換関数だけですが、この右側には実質3種類の関数を書くことができます。

m//

正規表現検索です。この関数がきたときは、代入ではなく比較を行います。
正規表現で検索する文字列に「/」がある場合など、「/」以外の記号で囲むこともできます。
括弧の場合は「m()」のように開き括弧と対応する閉じ括弧を使用します。
「/」が使用できる場合は「m」は省略できます。

php

(boolean)preg_match($pattern, $str);

1	(boolean)preg_match($pattern, $str);

perl

$str =~ /$pattern/;

1	$str =~ /$pattern/;

s///

正規表現による置換です。
こちらも「/」以外の記号を利用することもできます。
括弧の場合は「s()()」のような表記になります。

php

$str = preg_replace($pattern, $replacement, $str);

1	$str = preg_replace($pattern, $replacement, $str);

perl

$str =~ s/$pattern/$replacement/;

1	$str =~ s/$pattern/$replacement/;

tr///

文字単位の置換です。

php

$str = strtr($str, $from, $to);

1	$str = strtr($str, $from, $to);

perl

$str =~ tr/$from/$to/;

1	$str =~ tr/$from/$to/;

y///

「tr///」と同じです。

$str =~ y/$from/$to/;

1	$str =~ y/$from/$to/;

※４つとも、記号を置き換えた場合でも正規表現は「’」「”」でくくって文字列にしてはいけません。

今回は正規表現で3回置換して、その文字列を返しています。
今回の「正規表現」の内容はPCREでも同様なので確認してみてください。
今のディレクトリをあらわす「./」や、「//」と2つ並んで残った場合も処理しているので上のテンプレートより多くなっています。

やっぱりむずかしいですか？
難しいのはMTプラグインじゃなくて、「正規表現」つまり「やろうとしている事」じゃないですか？
自分で作ろうとしている場合、「やろうとしている事」は自分が一番分かっているので、あとはPerlで記述できるかどうかだけです。

ではこのプラグインが入った環境で先ほどのテンプレートを書き換えてみましょう！

<a href="<$MTCategoryArchiveLink realpath="1"$>">リンク</a>

1	<a href="<$MTCategoryArchiveLink realpath="1"$>">リンク</a>

はい、モディファイア一つで同じ処理が行えるようになりました。
しかもプラグインさえコピーすればどのMovable Typeでも使えます！
今回のものは実用性は低いかも知れませんが……

※実はPerlには「Cwd」モジュールに「realpath()」関数があります。
これは同モジュールの「abs_path()」関数の別名ですが、上記と同じような処理になります。
しかも最初から入っている標準モジュールなので、確実、安全に使うことができます。

package RealPath::Tags;
use strict;
use Cwd qw/realpath/;

sub _real_path {
    my ($str, $arg, $ctx) = @_;
    return $str if $arg != 1;

    return realpath($str);
}

1;

package RealPath::Tags;

use strict;

use Cwd qw/realpath/;

sub _real_path {

my ($str, $arg, $ctx) = @_;

return $str if $arg != 1;

return realpath($str);

}

PHPにもある？
実は違います。
今回もPHPで書き直すときに違いが生じないように、正規表現で対応しました。その話はまた改めて。

2015.02.05追記
_PLUGIN_NAME,_PLUGIN_DESCRIPTIONがおかしかったのでこっそり修正。

【Movable Typeでも複雑な処理を一元管理！】1/3
複雑な処理をスッキリ整理！　グローバル・モディファイアプラグイン

このリンク、かっこ悪いけど……

プラグインは、作れる。

config.yaml

実際に組んでみよう！

L10N.pm

en_us.pm

ja.pm

Tags.pm

=~

m//

php

perl

s///

php

perl

tr///

php

perl

y///

monthly ranking

今さら聞けない！ UI（ユーザーインターフェース）とは？

【Illustrator】地図の作成などに便利なアピアランス機能

WEBデザインで押さえるべき配色（ベース、メイン、アクセント）の基本「3つのカラー」

WEBサイト作成で覚えておくべき英語表現厳選30＋NG表現2パターン