下のプリロードはGoogleAnalytics.class.phpというファイル名で保存します。トラッキングコードを所定の場所にコピペするだけです。Google Analytics以外に、HTMLのヘッダに貼りつけたいコードがある時にも、応用できると思います。

<?php

class GoogleAnalytics extends XCube_ActionFilter
{
	public function preBlockFilter()
	{
		$this->mRoot->mDelegateManager->add('XoopsTpl.New', array(&$this, 'hook'));
	}

	public function hook(&$xoopsTpl)
	{
		$trackingCode = <<< DOC_END
//トラッキングコードをここに貼付け。
DOC_END;

		$xoopsModuleHeader = $xoopsTpl->get_template_vars('xoops_module_header');
		$xoopsTpl->assign('xoops_module_header', $xoopsModuleHeader.$trackingCode);
	}
}

?>

DynamicThemeChangerはURLで指定したテーマに切り替えるプリロードです。テーマ配布サイトがテーマのプレビューを示すことを想定して作りました。プリロードをアップロードすることで、URLで?theme={テーマディレクトリ名}の形でテーマを指定すると、そのテーマに切り替わります。

WhiteoutRescueプリロードは、ホワイトデイに「真っ白」画面を出さないためのプリロードです。ホワイトデイに真っ白画面に出くわしたサイトオーナーがこのプリロードをアップロードします。そして、真っ白画面のページにアクセスすると、黒背景を基調としたデバッグページが現れます。サイトオーナーはそのデバッグ情報をたよりに真っ白画面を解消します。このように、真っ白画面を直すことで、厄払いの意味になり、その年のXOOPS運が大安になると言われています。

動作要件

• XOOPS Cube Legacy 2.x
• PHP 5.1 (5.2からかも)
• UTF-8環境(EUC-JPでも動くことは動く)

WhiteoutRescueプリロードの使い方

XOOPSオーナーに伝わるWhiteoutRescueプリロードの使い方は以下のようです。

1. WhiteoutRescue.class.phpを/preloadにアップロードする
2. 真っ白のページにアクセスする
3. 表示されたデバッグ情報をもとに問題を解決する
4. 使い終わったら、WhiteoutRescue.class.phpを削除する

なお、使い終わってもWhiteoutRescueプリロードを削除しないでいると、XOOPSのセキュリティやパフォーマンスが低下し、XOOPSが白い悪魔に取り憑かれるそうなので、必ず削除するようにしましょう。

WhiteoutRescueを使っても真っ白のままの場合、以下のことが考えられます。

• プリロード読み込み以前にXOOPSがこけてる
• PHPのパースエラー（セミコロンがダブルコロンだ、など）この場合はPHPのエラーログを参照
• サーバーの問題 (.htaccessの設定ミスなど)
• そもそもXOOPS Cube Legacyじゃない
• しかるべくして真っ白なページ

ライセンス

GNU GPL2ライセンスです。動作無保証です。あなたは、GPL2の条件をみたせばこのプログラムを改変・頒布することができます。

リポジトリ

[訂正 2010/03/12]

XOOPSオーナーの間で、3月14日が厄日などの記述がありましたが、実際にはそんな習慣はないそうです。教えてくれたwhite_devilさんありがとうございます。

I will introduce you how to develop preloads with Subversion. If you put your preloads under /preload directory, it is difficult to manage the versions of its. Because, Subversion treats not only your preload but also the other ones. In such a case, you can make subdirectories under /preload. This way helps you to increase your manageability.

配布することを考えれば、サブディレクトリにLicense.txtやReadme.txtを置くといいでしょう。そうしておくと、svn -exportでプリロードの配布パッケージが簡単に生成できます。

If you plan to distribute your preload, you may put License.txt or Readme.txt under the subdirectory. It is a smart way. You only have to command "svn -export" at the subdirectory when you distribute it.

ディレクトリの構成方法

/XOOPS_ROOT_PATH
	/preload
		/VersionedPreload.class.php (a)
		/VersionedPreload
			/.svn
			/VersionedPrelaod.class.php (b)
			/License.txt
			/Readme.txt

VersionedPreload.class.php (a)のソース

<?php

$file = basename(__FILE__);
$dir  = str_replace('.class.php', '', $file);

require $dir.'/'.$file;

?>

(a)はただ、requireするだけです。（プロキシと言ったラインだろうか。）このサンプルソースはどんなプリロードにもそのまま流用できます。なぜなら、ファイル名を動的に取得しているからです。/preloadディレクトリに(a)をひとつ作っておけば、新しくプリロードを作る度に、コピーして名前を変更するだけでいいので便利です。

The (a) only includes your preload. You can apply this sample to your any other preloads. Because, this sample get the file name dynamically. If you create the (a) once, you only have to copy and rename it, when you create a new preload. It is useful.

VersionedPreload.class.php (b)のソース

<?php
/**
 *
 * @package    Versioned Preload
 * @author     Foo Bar <http://example.com/>
 * @copyright  2010 Foo Bar
 * @license    http://www.gnu.org/licenses/gpl-2.0.html GNU GPL v2 or later
 *
 */

if ( !defined('XOOPS_ROOT_PATH') ) exit;

class VersionedPreload extends XCube_ActionFilter
{
	public function preBlockFilter()
	{
		$this->mRoot->mDelegateManager->add('Delegate.Name', array(__CLASS__, 'doSomething'));
	}

	public static funciton doSomething(&$param)
	{
		// Do something here.
	}
}
?>

(b)では、プリロードを作るときの普段どおりの書き方をするだけです。とくに変わったことをする必要もありません。

パスワードは定期的に変更するほうがより安全と言われています。PasswordLimitterは、XOOPSのユーザのパスワードに期限を設け、期限がすぎたユーザに対しては、ログイン時にパスワード変更を促すメッセージを表示します。

インストール方法

1. PasswordLimitter.class.phpを/preloadにアップロード
2. 管理アカウントで、http://あなたのXOOPS/misc.php?password_limitter=adminにアクセス
3. 「INSTALL」をクリックしてインストールを実行
4. その後、設定ページで期限日数を設定する

アンインストール方法

1. 管理アカウントで、http://あなたのXOOPS/misc.php?password_limitter=adminにアクセス
2. 「UNINSTALL」をクリックしてインストールを実行
3. PasswordLimitter.class.phpを/preloadから削除

変更点 1.0 => 1.2

• ユーザ新規登録時に有効期限がセットされないバグを修正。

1.1とばしてしまった…orz

開発情報

• リポジトリ

• この情報は古いです。新しい情報を御覧下さい。

パスワードは定期的に変更するほうがより安全と言われています。PasswordLimitterは、XOOPSのユーザのパスワードに期限を設け、期限がすぎたユーザに対しては、ログイン時にパスワード変更を促すメッセージを表示します。

インストール方法

1. PasswordLimitter.class.phpを/preloadにアップロード
2. 管理アカウントで、http://あなたのXOOPS/misc.php?password_limitter=adminにアクセス
3. 「INSTALL」をクリックしてインストールを実行
4. その後、設定ページで期限日数を設定する

アンインストール方法

1. 管理アカウントで、http://あなたのXOOPS/misc.php?password_limitter=adminにアクセス
2. 「UNINSTALL」をクリックしてインストールを実行
3. PasswordLimitter.class.phpを/preloadから削除

開発情報

• リポジトリ

SuinDebugプリロードは、たったひとつのファイルで、あなたのXOOPS Cube Legacyでのデバッグをよりスムースにするためのサイトプリロードです。

HD画質なので、フルスクリーンで見るのをおすすめします。

特徴

• サイト(開発環境)を汚さない

  SuinDebugは、たったひとつのファイルからなるサイトプリロードです。{stdout_buffer}をテーマに書くことでテーマが汚れるデメリットや、デバッグ関連のファイルをいくつもアップロードすることで、開発パッケージに余分なファイルがあふれるデメリット、デバッグ関連の情報をデータベースに保存することで、データベースに不必要な情報が紛れ込むデメリットが一切ありません。

• エラーで画面を汚さない

  SuinDebugは、PHPやMySQLなどのデバッグ情報をウェブページに直接出力しません。デバッグ情報などによる、レイアウト崩れ・ソースの汚損からま逃れることができます。

• ポップアップウィンドウを開かない

  SuinDebugを使えば、デバッグのためにこれ以上ポップアップウィンドウを開く必要はありません。デバッグ情報はJavaScriptによるモーダルウィンドウで表示されます。つまり、ひとつのウィンドで完結するので、ポップアップからくるストレスを軽減できます。

• それなりのインターフェイス

  エラーSQLやDelegateのハイライト機能など、視覚的な面が考慮されています。また、デバッグモードを切り替える必要なしに、SQL, Delegate, XoopsTpl, stdout_buffer, PHP Errorsを一様に閲覧することができます。

使い方

1. SuinDebugをダウンロードします。
2. それを解凍して、{XOOPS_ROOT}/preload/に保存します。
3. JavaScriptをONにした状態で、管理者アカウントでログインします。
4. 管理画面でPHPデバッグモードをONにします。
5. ウィンドウ上端から100pxくらいのところにカーソルを移動するとメニューが表示されます。

注意

SuinDebugを公開サイトにアップロードしないでください。あくまで、このプリロードは非公開の開発環境で使用することを想定しています。たとえば、VMwareやXAMPP・MAMPで構築されたローカル開発環境。なお、サイトを公開する場合は、SuinDebugを削除してください。

SuinDebug description

SuinDebug is a site preload. It will help your debugging when you develop modules in XOOPS Cube Legacy.

Features

• SuinDebug doesn't litter your XOOPS

  SuinDebug consists of only one site preload file. You never have to write {stdout_buffer} in your theme. You never have to upload too many files for debugging. You never have to add any information into your database. You only have to upload SuinDebug preload.

• SuinDebug doesn't litter your webpages with errors

  SuinDebug doesn't directory output debugging information into your webpages such as PHP or MySQL. So, it doesn't break webpage layout with debugginf information.

• SuinDebug never opens popup windows any more

  To show debugging informaiton, SuinDebug uses mordal window. So it never annoy you with popup windows.

• SuinDebug has good interface

  Without changing debugging mode, you can browse SQL, Delegate, XoopsTpl, stdout_buffer, PHP Errors at the same time in the same window.

How to Use

1. Please Download SuinDebug.
2. Please Upload it to {XOOPS_ROOT}/preload/
3. Please Turn on JavaScript and login as site admin.
4. Please Turn on PHP debugging mode in legacy module.
5. Please Move your pointer by near 100px from window top.

Notice

Please DO NOT upload SuinDebug to public website. SuinDebug should be used only in local developing envenment; for example, VMware, XAMMP, MAMP and so on. When you public your website, please remove SuinDebug.

]]> Fri, 12 Feb 2010 15:40:56 +0900 http://suin.asia/2010/02/12/suin_debug_preload XOOPS プリロード ダウンロード SuinDebug http://suin.asia/2010/01/25/preload_block カスタムブロックは、通常legacyモジュールやaltsysで作ることができます。ここでは、プリロードでカスタムブロックを作ることを紹介します。

その前に、ここで紹介するTipsは、管理画面でカスタムブロックを作るより、はるかに回りくどくPHPの知識が必要な点を注意しておきます。なので、特殊な機能や要件を必要としない限り、カスタムブロックは管理画面で作るべきです。

まず、XOOPS Cubeのプリロードでカスタムブロックを作るメリットはいくつかあります。

• ファイルとして配布できる
• ファイルなので、不要になれば削除するだけ
• PHPなどの複雑なロジックが書きやすい（通常のカスタムブロックでもPHPは使えます）

特にこの中でも、ファイルとして扱えるメリットは大きいです。たとえば、開発環境で一定の変数を出力したりとデバッグ用途にブロックをプリロードで実装します。あとは、公開するときにプリロードを削除するだけで、データベースを汚したりすることは一切ありません。管理画面で操作するブロックだと、ついつい消し忘れ・消し損ないなんてこともありますが、プリロードだとファイルを確実に削除すれば、消し損なうこともありません。

ダウンロード

次に、プリロードのソースを紹介します。16行目の$indexが、ブロックを表示する位置になります。l, r, cl, cc, crの順に、左・右・中央左・中央中・中央右を意味します。

18行目から22行目はブロックの表示に関する設定です。nameはブロック名で、アルファベット英数ですきな名前を指定します。titleはブロックの題目で、ブロックの上部に表示されます。contentはブロックの内容で、HTMLなどで書くことができます。weightはブロックの並び順で、数値が小さいほど上に、数値が多きほど下にブロックが表示されます。

<?php
/**
 * A simple description for this script
 *
 * PHP Version 5.2.4 or Upper version
 *
 * @package    PreloadBlock
 * @author     Hidehito NOZAWA aka Suin <http://suin.asia/>
 * @copyright  2009 Hidehito NOZAWA
 * @license    http://www.gnu.org/licenses/gpl-2.0.html GNU GPL v2.0
 *
 */

class PreloadBlock extends XCube_ActionFilter
{
	protected $index = 'l';
	protected $block = array(
		'id'      => -1,
		'name'    => 'preload_block',
		'title'   => 'プリロードブロック',
		'content' => '<i>ブロックの内容</i>',
		'weight'  => -1, // 並び順
	);
	protected $indexes = array(
		'l' => 0,
		'r' => 1,
		'cl' => 3,
		'cr' => 4,
		'cc' => 5
	);
	protected $blocks = array(
		'l' => 'xoops_lblocks',
		'r' => 'xoops_rblocks',
		'cl' => 'xoops_clblocks',
		'cr' => 'xoops_crblocks',
		'cc' => 'xoops_ccblocks'
	);

	public function postFilter()
	{
		if ( $this->mController->_mStrategy->mStatusFlag != LEGACY_CONTROLLER_STATE_PUBLIC )
		{
			return;
		}

		$this->mRoot->mDelegateManager->add('Legacy_RenderSystem.BeginRender', array(&$this, 'beginRender'));
		$this->mRoot->mContext->mAttributes['legacy_BlockShowFlags'][$this->indexes[$this->index]]  = true;
		$this->mRoot->mContext->mAttributes['legacy_BlockContents'][$this->indexes[$this->index]][] = $this->block;
	}

	protected function beginRender(&$tpl)
	{
		if ( !empty($tpl->_tpl_vars['isFileTheme']) )
		{
			uasort($tpl->_tpl_vars[$this->blocks[$this->index]], array(&$this, 'reOrder'));
		}
	}

	protected function reOrder($a, $b)
	{
		if ($a['weight'] == $b['weight'])
		{
			return 0;
		}
		return $a['weight'] > $b['weight'] ? 1 : -1;
	}
}

?>

なお、このプリロードはしゃのさんのnowプリロードを参考にさせていただきました。

]]> Mon, 25 Jan 2010 17:30:10 +0900 http://suin.asia/2010/01/25/preload_block XOOPS プリロード Tips http://suin.asia/2010/01/24/preload_for_search_module ダウンロード

ながらくメンテナンスしていないXOOPS検索モジュールですが、XOOPS Cube Legacyでも動作するようです。このモジュールは、/search.phpの検索機能(グローバルサーチという)を乗っ取り、より充実した検索機能を実現すべくXOOPS2向けに作られたモジュールです。search.phpを乗っ取るさい、XOOPS2ではsearch.phpを直接書き換える手続きが必要でした。一方、XOOPS Cube Legacyでは、preloadを置くだけで乗っ取りが完了します。XOOPS Cube LegacyでもXOOPS検索モジュールを使っている方はどうぞpreloadをダウンロードしてお使い下さい。

ちなみに、XOOPS Cubeのグローバルサーチを乗っ取りたい人は、このプリロードが参考になるかと思います。

<?php
/**
 *
 * @package    SearchModuleRedirecter
 * @author     Hidehito NOZAWA aka Suin <http://suin.asia/>
 * @copyright  2009 Hidehito NOZAWA
 * @license    http://www.gnu.org/licenses/gpl-2.0.html GNU GPL v2.0
 *
 */

if ( !defined('XOOPS_ROOT_PATH') ) exit;

class SearchModuleRedirecter extends XCube_ActionFilter
{
        var $searchDirname = 'search';

        function preBlockFilter()
        {
                $this->mRoot->mDelegateManager->add('Legacypage.Search.Access', array($this, 'redirect'), XCUBE_DELEGATE_PRIORITY_FIRST);
        }

        function redirect()
        {
                if ( file_exists(XOOPS_ROOT_PATH.'/modules/'.$this->searchDirname.'/index.php') )
                {
                        $moduleHandler =& xoops_gethandler('module');
                        $moduleObj =& $moduleHandler->getByDirname($this->searchDirname);
                        if ( $moduleObj->getVar('isactive') == 1 )
                        {
                                header('Location: '.XOOPS_URL.'/modules/'.$this->searchDirnam.'/index.php?'.$_SERVER['QUERY_STRING']);
                                die;
                        }
                }
        }
}

?>

]]> Sun, 24 Jan 2010 16:48:47 +0900 http://suin.asia/2010/01/24/preload_for_search_module ダウンロード プリロード XOOPS saerch