携帯対応レンダラー [keyword/HypCommonPreLoad/KtaiRender] - xpWiki::Dev

Table of contents

携帯対応レンダラー

携帯対応レンダラー

HypCommonPreLoad に含まれる出力フィルターで、XOOPSを丸ごと携帯対応にすることができます。

この機能を利用するには、サーバーに HypCommonFunc をアップロード後、XOOPS に HypCommonPreLoad を導入し、HypCommonPreLoad の設定を行ってください。
簡単ログイン機能を使用するには、XOOPS_TRUST_PATH/cache ディレクトリに書き込み権限が必要です。
RSS 出力に対応。(HypCommonFunc Ver 20080626 以降)
各モジュールのテーマ下テンプレートに対応。(HypCommonFunc Ver 20080717 以降)
- 各モジュールのテーマ下テンプレートは、モバイルテンプハウスなどで入手できます。
携帯絵文字に対応しています。携帯三社とPCで絵文字の自動変換を行い、変換できない絵文字は画像で表示されます。(HypCommonFunc Ver 20080720 以降)
- 携帯絵文字パック: K-tai_emoji.zip を XOOPS_ROOT_PATH/images に忘れずアップロードしてください。
- 詳しくは、Blog:携帯絵文字に対応してみたやフォーラム:[HypCommonFunc] Ver 20080720 携帯絵文字に対応を参照してください。
以前のバージョンで必要であった、XOOPS_ROOT_PATH/class/hyp_common/redirect.php は、HypCommonFunc Ver. 20080910 以降で不要となりました。サーバー上の該当ファイルは不必要になりましたので、削除しても構いません。

注意事項: HypCommonFunc Ver 20080720 以降に含まれる SoftBankの絵文字を営利目的でホームページ、ソフトウェア、書籍等で利用される場合は、以下のアドレスから事前に連絡する必要があります。
http://creation.mb.softbank.jp/web/web_privacy.html

設定 (hyp_preload.conf.php)

"XOOPS_TRUST_PATH/class/hyp_common/preload/hyp_preload.conf.php" を編集して設定をします。該当ファイルがない場合は、同じディレクトリに含まれている "hyp_preload.conf.php.rename" をリネームしてください。

hyp_preload.conf.php 内の携帯対応レンダラー関連の設定項目 (HypCommoFunc Ver. 20090111)

// 各機能のメインスイッチ (On = 1, Off = 0)
$this->use_k_tai_render      = 0; // 携帯対応レンダラーを有効にする
 
/////////////////////////
// 携帯対応レンダー設定
 
// 携帯端末判定用 UA 正規表現
$this->k_tai_conf['ua_regex'] = '#(?:SoftBank|Vodafone|J-PHONE|DoCoMo|UP\.Browser|DDIPOCKET|WILLCOM)#';
 
// HTML再構築用タグ設定
$this->k_tai_conf['rebuilds'] = array(
    'headerlogo'     => array( 'above' => '<center>',
                              'below' => '</center>'),
    'headerbar'      => array( 'above' => '<hr>',
                              'below' => ''),
    'breadcrumbs'    => array( 'above' => '',
                              'below' => ''),
    'leftcolumn'     => array( 'above' => '<hr>',
                              'below' => ''),
    'centerCcolumn'  => array( 'above' => '<hr>',
                              'below' => ''),
    'centerLcolumn'  => array( 'above' => '',
                              'below' => ''),
    'centerRcolumn'  => array( 'above' => '',
                              'below' => ''),
    'content'        => array( 'above' => '<hr>',
                              'below' => ''),
    'rightcolumn'    => array( 'above' => '<hr>',
                              'below' => ''),
    'footerbar'      => array( 'above' => '',
                              'below' => ''),
    'easylogin'      => array( 'above' => '<div style="text-align:center;background-color:#DBBCA6;font-size:small">[ ',
                              'below' => ' ]</div>'),
    'redirectMessage'=> array( 'above' => '<marquee loop="3">',
                              'below' => '</marquee>'),
    'blockMenu'      => array( 'above' => '<div style="background-color:#E0EEEE;font-size:small">',
                              'below' => '</div>'),
    'blockContent'   => array( 'above' => '',
                              'below' => ''),
    'toMain'         => array( 'above' => '<hr /><div style="text-align:center">',
                              'below' => '</div>'),
    'subMenu'        => array( 'above' => '<div id="submenu" style="background-color:#ccccff"><h2 style="text-align:center">サブメニュー</h2></div>',
                              'below' => ''),
);
 
// 携帯用XOOPSテーマセット
$this->k_tai_conf['themeSet'] = 'ktai_default';
 
// 携帯用XOOPSテンプレートセット
$this->k_tai_conf['templateSet'] = '';
 
// 使用テンプレート
$this->k_tai_conf['template'] = 'default';
 
// <body> attributes
$this->k_tai_conf['bodyAttribute'] = '';
 
// 無効にするブロックの bid (Block Id) (無指定:フィルタリングしない)
$this->k_tai_conf['disabledBlockIds'] = array();
 
// 有効にするブロックの bid (Block Id) (無指定:フィルタリングしない)
$this->k_tai_conf['limitedBlockIds'] = array();
 
// 常に表示するブロックの bid (Block Id) (メインメニューなど)
$this->k_tai_conf['showBlockIds'] = array();
 
// インラインイメージのリサイズ最大ピクセル
$this->k_tai_conf['pictSizeMax'] = '200';
 
// インラインイメージを表示するホスト名(後方一致)
$this->k_tai_conf['showImgHosts'] = array('amazon.com', 'yimg.jp', 'yimg.com', 'ad.jp.ap.valuecommerce.com', 'ad.jp.ap.valuecommerce.com', 'ba.afl.rakuten.co.jp', 'assoc-amazon.jp', 'ad.linksynergy.com', 'google.com');
 
// 直接画像を表示するホスト名(後方一致)
$this->k_tai_conf['directImgHosts'] = array('google-analytics.com');
 
// リダイレクトスクリプトを経由しないホスト名(後方一致)
$this->k_tai_conf['directLinkHosts'] = array('amazon.co.jp', 'ck.jp.ap.valuecommerce.com', 'afl.rakuten.co.jp', 'maps.google.com');
 
// 外部リンク用リダイレクトスクリプト
$this->k_tai_conf['redirect'] = XOOPS_URL . '/class/hyp_common/gate.php?way=redirect&amp;_d=0&amp;_u=0&amp;_x=0&amp;l=';
 
// Easy login を有効にする
$this->k_tai_conf['easyLogin'] = 1;
// Easy login で IP アドレス帯域をチェックしない
$this->k_tai_conf['noCheckIpRange'] = 0;
 
// リンクメッセージ
$this->k_tai_conf['msg']['easylogin'] = '簡単ログイン';
$this->k_tai_conf['msg']['logout'] = 'ログアウト';
$this->k_tai_conf['msg']['easyloginSet'] = '簡単ログイン:設定';
$this->k_tai_conf['msg']['easyloginUnset'] = '簡単ログイン:解除';
$this->k_tai_conf['msg']['toMain'] = '本文を表示';
$this->k_tai_conf['msg']['mainMenu'] = 'メインメニュー';
$this->k_tai_conf['msg']['subMenu'] = 'サブメニュー';
 
// アイコン
$this->k_tai_conf['icon']['first']   = '';
$this->k_tai_conf['icon']['prev']    = '';
$this->k_tai_conf['icon']['next']    = '';
$this->k_tai_conf['icon']['last']    = '';
$this->k_tai_conf['icon']['extLink'] = '';
$this->k_tai_conf['icon']['hTag']    = '';
$this->k_tai_conf['icon']['RSS']     = '';
 
$this->k_tai_conf['icon']['toMain']  = '';
 
// style
$this->k_tai_conf['style']['highlight'] = 'background-color:#ffc0cb';
 
// Easy login: 設定 or 解除リンクを表示するURI(XOOPS_URL以降)とuidのGETキーと挿入位置
$this->k_tai_conf['easyLoginConfPath'] = '/userinfo.php';
$this->k_tai_conf['easyLoginConfuid'] = 'uid';
$this->k_tai_conf['easyLoginConfInsert'] = 'content';
 
// GET query keys
$this->k_tai_conf['getKeys']['page'] = '_p_';
$this->k_tai_conf['getKeys']['hash'] = '_h_';
$this->k_tai_conf['getKeys']['block'] = '_b_';
 
//// Google Adsense 設定
// config ファイルのパス
$this->k_tai_conf['googleAdsense']['config'] = '';
// 挿入場所 ('header', 'body', 'footer') の下、無指定時はページ最上部
$this->k_tai_conf['googleAdsense']['below'] = '';
 
// Google Analytics 設定
$this->k_tai_conf['googleAnalyticsId'] = '';
 
// 携帯対応レンダー設定 以上
/////////////////////////////

サイトごとの設定

$this->k_tai_conf の各設定は、サイトごとに行う必要がある場合がありますので、サイトごとの設定方法を説明します。

方法は、2種類あります。

各設定値のキー名に #[XOOPS_URL] を付加する方法

この方法では、XOOPS_TRUST_PATH 側 (XOOPS_TRUST_PATH/class/hyp_common/preload/hyp_preload.conf.php) で各サイトごとに設定できます。

例えば、$this->k_tai_conf['disabledBlockIds'] の設定を http://xoops.hypweb.net に対して行いたい場合は、

1	`$this->k_tai_conf['disabledBlockIds#http://xoops.hypweb.net'] = array(55, 63, 154, 67, 106, 34);`

のように設定します。(このサイトの設定例です)

※ trust側で設定する場合は、XOOPS_ROOT_PATH/class/hyp_common/hyp_preload.conf.php を設置してはいけません。

XOOPS_ROOT_PATH(html側)/class/hyp_common/hyp_preload.conf.php にて設定する方法

各サイトの XOOPS_ROOT_PATH/class/hyp_common に hyp_preload.conf.php に設置して設定を行います。

XOOPS_ROOT_PATH/class/hyp_common/hyp_preload.conf.php を設置すると、XOOPS_TRUST_PATH/class/hyp_common/preload/hyp_preload.conf.php は読み込まれなくなります。

ブロックのコントロール

ブロックは、サブメニューとしてタイトルを一覧表示するようになっています。

また、特定のブロックを常に表示したり、ブロックを無効にすることもできます。

特定のブロックを常に表示したい
特定のブロックを、メインコンテンツと共に常に表示することができます。

メインメニューやユーザーメニューは常に表示させておくと便利でしょう。

設定は、
```
// 常に表示するブロックの bid (Block Id) (メインメニューなど)
$this->k_tai_conf['showBlockIds'] = array();
```
で行います。
特定のブロックを無効にしたい
特定のブロックを無効にすることができます。

設定は、
```
// 非表示にするブロックの bid (Block Id)
$this->k_tai_conf['disabledBlockIds'] = array();
```
で行います。

ブロックの設定を行う場合は、その性格上、必ずサイトごとの設定で行う必要があります。

設定方法は、ブロックIDを配列で指定します。例えば、ブロックID 3, 5, 10 を非表示にしたい場合は、次のようになります。

// 非表示にするブロックの bid (Block Id)
$this->k_tai_conf['disabledBlockIds'] = array(3, 5, 10);

XOOPS 2.0.16a JP での注意事項: XOOPS 2.0.16a JP で運用している場合は、HypCommonFunc Ver. 20080916 以降に含まれる header.phpのハック版 ( core_addons/html_2.0.16aJP/header.php ) を忘れずに XOOPS_ROOT_PATH へアップロードする必要があります。

各モジュールの対応など

各モジュールのテンプレート内でも、Smarty変数の Smarty変数の $smarty.const.HYP_K_TAI_RENDER を使って、場合分けができます。

部分的に場合分けしてもいいですし、大胆に全体を

<{if $smarty.const.HYP_K_TAI_RENDER}>
携帯の場合のテンプレート
<{else}>
PCの場合のテンプレート
<{/if}>

とすることもできます。

d3forum

d3forum では、スパム対策のデフォルトフィルターで、ゲスト投稿時に JavaScript を利用してフィルタリングを行っていますが、このフィルターが有効になっていると、ゲストが携帯で投稿することができません。

そこで、携帯からのアクセスかを IP 帯域で判断して、携帯であると判断した場合は、フィルタリングを行わないフィルターを書いてみました。

D3forumAntispamDefault_ktai.class.php

このファイルを、XOOPS_TRUST_PATH/modules/d3forum/class にアップロードし、[ d3forum の管理画面 - 一般設定 - SPAM投稿チェック用クラス ] に「default_ktai」と指定してください。

mailbbs (写メールBBS)

Version 2.3.6 で、携帯対応レンダラーに対応しました。Ver 2.3.6 以降をお使いください。

最新バージョンをCVSからダウンロード

yomi (Yomiサーチ)

Version 0.89 にて、サイトバナーの表示に対応しました。

最新バージョンをCVSからダウンロード

テンプレートでよく使う絵文字 (i-mode 基準)

絵文字コード	意味	主な使用例
((i:f952))	ペン	投稿する
((i:f9be))	鉛筆	投稿数
((i:f955))	人型	投稿者
((i:f8c4))	家型	居住地・ホームページ
((i:f95e))	時計	投稿日時
((i:f982))	New	最終更新・最新投稿

制限について

サーバーの PHP が PHP 4.3.0 未満、又は PHP 5 未満で Web サーバーが Apache でない場合、header('Location: ...') でリダイレクトしているところでセッションが切れてしまいます。ログイン状態であっても、そこでログアウトしてしまうということです。

可能であれば、HTTP Header を検査して Location であれば、セッションID付きURLに書き換えることでセッションが切れないようになっていますが、未対応の環境下ではそれを行うことができないので、携帯対応レンダラー側で対処することはできません。

未対応の環境下サーバーで、リダイレクト時にセッションが切れないようにする方法は以下の2つの方法があります。

XOOPS の関数 redirect_header() を使用する
Location によるリダイレクト時に URL にセッションIDを追加する

例えば、

header('Location: ' . $url);

となっているところを次のように変更します。

1. redirect_header() 使用

if (defined('HYP_K_TAI_RENDER') && HYP_K_TAI_RENDER) {
    redirect_header('Location: ' . $url);
} else {
    header('Location: ' . $url);
}

2. セッションIDを追加

if (defined('HYP_K_TAI_RENDER') && HYP_K_TAI_RENDER) {
    $ktairender =& HypKTaiRender::getSingleton(); // リファレンス取得
    $url = $HypKTaiRender->getRealUrl($url);      // 相対URLなら絶対URLに変換 (要: Ver. 20090104 以降)
    $url = $ktairender->addSID($url, XOOPS_URL);  // セッションIDを付加
}
header('Location: ' . $url);

意見・要望

意見要望を書くところが、あちこち探したがよくわからなかったのでここにコメント欄を作ってみました。 -- 通りすがりさん 2008-08-17 (Sun) 10:16:25
携帯判定にWILLCOMと、e-mobileを是非入れて欲しい。 -- 通りすがりさん 2008-08-17 (Sun) 10:16:34
directLinkHosts に、Adsenseのgooglesyndication.comを入れて欲しい -- 通りすがりさん 2008-08-17 (Sun) 10:32:53
- WILLCOM と e-mobile の端末の多くは、PCサイトブラウザを搭載していてほとんどのユーザーは、それでアクセスしているので、携帯対応はかえってユーザーの不利益になるという認識なのですが、如何でしょうか。(このあたり、私は詳しくないので間違っているかもしれません。)
  Adsense対応に関しては、hyp_preload.conf.php にて設定していただければよいと思いますが、規定値に設定しておいたほうがよさそうなら加えておきます。 -- nao-pon 2008-08-17 (日) 21:38:06
e-mobileはよく分かりませんが、WILLCOMのPCサイトブラウザは、端末の能力が他社端末に比べ低く抑えられていることや通信回線の遅さから、依然として非力であり、まだ今1つ実用的とは言えない状態です。むしろドコモやauのPCサイトブラウザの方がよほど快適なくらいで…従いまして、軽いページに対する需要は十分あると思われます。1ユーザーとして、WILLCOMの携帯対応をデフォルトで行っていただけると、大変有り難いです。 -- 通りすがりさん 2008-09-20 (土) 23:49:44
- そのような事情があるのですね。仕様を調べた上で対応を検討しますね。 -- nao-pon 2008-09-21 (日) 21:06:49
- まずは、このサイトでWILLCOMのケータイモードを対象にしてみました。
  [携帯対応レンダラー] WILLCOM対応レポート募集中 - XOOPSマニアにレポートを頂けると助かります。 -- nao-pon 2008-09-23 (火) 10:58:50
お世話になります。 -- しょぼ 2008-10-18 (土) 20:51:47
初心者なので、初歩的なご質問をさせていただくことをご了承ください。　各設定を行って、無事に携帯でmobile版表示ができたのですが、メインメニューもブロックもコンテンツも表示されません。何が原因なのでしょうか？ご指導いただければ幸いです。　xoopsバージョンは2.0.16で上記の設定通り行ったつもりです。宜しくお願い致します。 -- しょぼ 2008-10-18 (土) 20:56:16
Hタグを任意で無効にできる機能があると・・・最高っす！ -- 通りすがりさん 2009-02-18 (水) 17:43:32

Attach file:

fusen.dat 317DL [Info]

D3forumAntispamDefault_ktai.class.php 304DL [Info]

theme.html 317DL [Info]

Page Info
Page Name :	keyword/HypCommonPreLoad/KtaiRender
Page aliases :	携帯レンダー, 携帯レンダラー, 携帯対応レンダー, 携帯対応レンダラー, keyword/携帯対応レンダー, keyword/携帯対応レンダラー
Page owner :	nao-pon
Can Read
Groups :	All visitors
Users :	All visitors
Can Edit
Groups :	All visitors
Users :	All visitors