PukiWiki/自作プラグイン/Favicon

最終更新: 2009-04-12 (日) 19:40:43

favicon.inc.php †

サマリ	指定した URL の favicon をインライン表示する
リビジョン	1.4
対応バージョン	1.4.7
作者	revulo
ライセンス	MIT License

▲

目次 †

▲

概要 †

favicon を使って飾り付けをします。

URL を指定すると、そのページの favicon をインライン表示します
２回目からはキャッシュを利用して高速に動作します
Internet Explorer では favicon がうまく表示されないことがあるため、その対策をしてあります

このプラグインは、単独で使ってもあまり面白みがありません。当サイトでは、 PukiWiki/改造/内部・外部リンクを区別する - cubic9.com の記事を参考に、外部リンクの部分にそのサイトの favicon が表示されるようにしています。

▲

サンプル †

こんな風に表示することができます。

▲

動作環境 †

現在のバージョンでは、以下の制限があります。

proxy を経由している場合は動作しません
https プロトコルでの接続には、OpenSSL をサポートした PHP 4.3.0 以上が必要です

とりあえずこのような仕様にしてありますが、要望があれば対応することを考えます *1。

▲

インストール †

アーカイブファイルをダウンロードし、 PukiWiki をインストールしてあるディレクトリで展開します。

$ tar xvfz favicon-1.4.tar.gz

cache/favicon というディレクトリが作られるので、書き込み許可を与えて下さい。

$ chmod 777 cache/favicon

外部リンクの部分に favicon を表示させたい場合は、PukiWiki 本体にパッチをあてて下さい。

$ tar xvfz pukiwiki_favicon-20080803.tar.gz
$ patch -p0 < pukiwiki-1.4.7_favicon.diff

▲

使い方 †

書式は次のようになっています。

&favicon( URL [,テキスト] );

第１引数には、http:// で始まる URL を指定して下さい
第２引数を指定した場合は、そのテキストが favicon の後ろにリンクとして表示されます

▲

設定 †

▲

favicon.inc.php の設定 †

favicon.inc.php の先頭部分で以下の値を設定することで、動作をカスタマイズできます。

PLUGIN_FAVICON_API_URL: favicon を表示するのに用いる Web API の URL

PLUGIN_FAVICON_CSS: favicon に適用するスタイルシート

PLUGIN_FAVICON_DEFAULT_IMAGE: PKWK_DISABLE_INLINE_IMAGE_FROM_URI がセットされている場合に表示する画像ファイル

▲

favicon.php の設定 †

IEでfaviconをちゃんと出す - p0t の記事にあるように、 Internet Explorer では favicon を直接表示できないことがあるため、 favicon.php というスクリプトを一旦通して正常に表示されるようにします。また favicon.php 内部でデータをキャッシュして、高速に動作するようにしています。

設定を変更したい場合は、favicon.php の先頭にある以下の値を設定し直して下さい。

FAVICON_DEFAULT_IMAGE: 指定したページに favicon が存在しない場合に表示する画像ファイル

FAVICON_ERROR_IMAGE: 指定したページがエラーを返す場合に表示する画像ファイル

FAVICON_CACHE_DIR: データをキャッシュしておくディレクトリ

FAVICON_CACHE_TTL: favicon の URL をキャッシュしておく秒数

▲

ダウンロード †

favicon-1.4.tar.gz
- プラグイン本体
- Favicon API 用スクリプト
- 画像ファイル
- スタイルシート

pukiwiki_favicon-20080803.tar.gz
- 外部リンクの部分に favicon を表示させるパッチ
  - PukiWiki 1.4.7 用
  - PukiWiki Plus! 1.4.7plus-u2 用

▲

更新履歴 †

Version 1.4 (2009/04/12)
- レスポンスヘッダで送信する Content-Type を厳密に
- 暫定的に、BMP 形式の favicon は表示しないように修正 *2
- 定数名を PLUGIN_FAVICON_PROXY_URL から PLUGIN_FAVICON_API_URL に変更
- ライセンスを MIT ライセンスに変更

Version 1.3 (2008/08/03)
- HTML エスケープが二重に行われていたのを修正
- 不要な flock() を削除

Version 1.2 (2007/11/04)
- 画像の表示が別プロセスで行われるよう全面的に書き直し

Version 1.1 (2007/05/22)
- 読み込んだデータのファイルフォーマットを確認する処理を追加

Version 1.0 (2007/05/07)
- 初公開

▲