Changeset 15078 for branches/feature-module-update/data/include/mobile.inc

Timestamp:

2007/07/20 15:58:59 (17 years ago)

Author:

nanasess

Message:

r15064 から svn cp
とりあえず暫定コミット.

• UTF-8 に変更
• slib.php, glib.php のクラス化
• LC_Page の抽象化（一部）

Location:

branches/feature-module-update

Files:

• . (copied) (copied from branches/rel) (1 prop)
• data (copied) (copied from branches/rel/data)
• data/include/mobile.inc (modified) (20 diffs)

branches/feature-module-update/data/include/mobile.inc

@@ -1 +1 @@
 <?php
 /**
- * ¥â¥Ð¥¤¥ë¥µ¥¤¥È¶¦Í­´Ø¿ô¥Õ¥¡¥¤¥ë
+ * モバイルサイト共有関数ファイル
  */
 
@@ -9 +9 @@
 
 /**
- * EC-CUBE ¤¬¥µ¥Ý¡¼¥È¤¹¤ë·ÈÂÓüËö¤«¤É¤¦¤«¤ò¥Á¥§¥Ã¥¯¤¹¤ë¡£
- * ÈóÂбþüËö¤Î¾ì¹ç¤Ï unsupported/index.php ¤Ø¥ê¥À¥¤¥ì¥¯¥È¤¹¤ë¡£
+ * EC-CUBE がサポートする携帯端末かどうかをチェックする。
+ * 非対応端末の場合は unsupported/index.php へリダイレクトする。
  *
  * @return void
@@ -22 +22 @@
 
 /**
- * ÆþÎϥǡ¼¥¿¤òÆâÉô¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤ËÊÑ´¹¤·¡¢³¨Ê¸»ú¤ò½üµî¤¹¤ë¡£
- *
- * @param string &$value ÆþÎϥǡ¼¥¿¤Ø¤Î»²¾È
+ * 入力データを内部エンコーディングに変換し、絵文字を除去する。
+ *
+ * @param string &$value 入力データへの参照
  * @return void
  */
 function lfMobileConvertInputValue(&$value) {
-    // Shift JIS ¤«¤éÆâÉô¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤ËÊÑ´¹¤¹¤ë¡£
-    // SoftBank °Ê³°¤Î³¨Ê¸»ú¤Ï³°»úÎΰè¤Ë´Þ¤Þ¤ì¤ë¤¿¤á¡¢¤³¤ÎÃʳ¬¤Ç½üµî¤µ¤ì¤ë¡£
+    // Shift JIS から内部エンコーディングに変換する。
+    // SoftBank 以外の絵文字は外字領域に含まれるため、この段階で除去される。
     $value = mb_convert_encoding($value, CHAR_CODE, 'SJIS');
 
-    // SoftBank ¤Î³¨Ê¸»ú¤ò½üµî¤¹¤ë¡£
+    // SoftBank の絵文字を除去する。
     $value = preg_replace('/\\x1b\\$[^\\x0f]*\\x0f/', '', $value);
 }
 
 /**
- * ¥â¥Ð¥¤¥ë¥µ¥¤¥ÈÍѤÎÆþÎϤνé´ü½èÍý¤ò¹Ô¤¦¡£
+ * モバイルサイト用の入力の初期処理を行う。
  *
  * @return void
@@ -48 +48 @@
 
 /**
- * dtb_mobile_ext_session_id ¥Æ¡¼¥Ö¥ë¤ò¸¡º÷¤·¤Æ¥»¥Ã¥·¥ç¥óID¤ò¼èÆÀ¤¹¤ë¡£
- *
- * @return string|null ¼èÆÀ¤·¤¿¥»¥Ã¥·¥ç¥óID¤òÊÖ¤¹¡£
- *                     ¼èÆÀ¤Ç¤­¤Ê¤«¤Ã¤¿¾ì¹ç¤Ï null ¤òÊÖ¤¹¡£
+ * dtb_mobile_ext_session_id テーブルを検索してセッションIDを取得する。
+ *
+ * @return string|null 取得したセッションIDを返す。
+ *                     取得できなかった場合は null を返す。
  */
 function lfMobileGetExtSessionId() {
@@ -75 +75 @@
 
 /**
- * ¥Ñ¥é¥á¡¼¥¿¡¼¤«¤éÍ­¸ú¤Ê¥»¥Ã¥·¥ç¥óID¤ò¼èÆÀ¤¹¤ë¡£
- *
- * @return string|false ¼èÆÀ¤·¤¿Í­¸ú¤Ê¥»¥Ã¥·¥ç¥óID¤òÊÖ¤¹¡£
- *                      ¼èÆÀ¤Ç¤­¤Ê¤«¤Ã¤¿¾ì¹ç¤Ï false ¤òÊÖ¤¹¡£
+ * パラメーターから有効なセッションIDを取得する。
+ *
+ * @return string|false 取得した有効なセッションIDを返す。
+ *                      取得できなかった場合は false を返す。
  */
 function lfMobileGetSessionId() {
-    // ¥Ñ¥é¥á¡¼¥¿¡¼¤«¤é¥»¥Ã¥·¥ç¥óID¤ò¼èÆÀ¤¹¤ë¡£
+    // パラメーターからセッションIDを取得する。
     $sessionId = @$_POST[session_name()];
     if (!isset($sessionId)) {
@@ -93 +93 @@
     }
 
-    // ¥»¥Ã¥·¥ç¥óID¤Î¥Õ¥©¡¼¥Þ¥Ã¥È¤ò¥Á¥§¥Ã¥¯¤¹¤ë¡£
+    // セッションIDのフォーマットをチェックする。
     if (preg_match('/^[0-9a-zA-Z,-]{32,}$/', $sessionId) < 1) {
         gfPrintLog("Invalid session id : sid=$sessionId");
@@ -99 +99 @@
     }
 
-    // ¥»¥Ã¥·¥ç¥óID¤Î¸ºß¤ò¥Á¥§¥Ã¥¯¤¹¤ë¡£
+    // セッションIDの存在をチェックする。
     if (sfSessRead($sessionId) === null) {
         gfPrintLog("Non-existent session id : sid=$sessionId");
@@ -109 +109 @@
 
 /**
- * ¥»¥Ã¥·¥ç¥ó¥Ç¡¼¥¿¤¬Í­¸ú¤«¤É¤¦¤«¤ò¥Á¥§¥Ã¥¯¤¹¤ë¡£
- *
- * @return boolean ¥»¥Ã¥·¥ç¥ó¥Ç¡¼¥¿¤¬Í­¸ú¤Ê¾ì¹ç¤Ï true¡¢Ìµ¸ú¤Ê¾ì¹ç¤Ï false ¤òÊÖ¤¹¡£
+ * セッションデータが有効かどうかをチェックする。
+ *
+ * @return boolean セッションデータが有効な場合は true、無効な場合は false を返す。
  */
 function lfMobileValidateSession() {
-    // ÇÛÎó mobile ¤¬ÅÐÏ¿¤µ¤ì¤Æ¤¤¤ë¤«¤É¤¦¤«¤ò¥Á¥§¥Ã¥¯¤¹¤ë¡£
+    // 配列 mobile が登録されているかどうかをチェックする。
     if (!is_array(@$_SESSION['mobile'])) {
         return false;
     }
 
-    // Í­¸ú´ü¸Â¤ò²á¤®¤Æ¤¤¤Ê¤¤¤«¤É¤¦¤«¤ò¥Á¥§¥Ã¥¯¤¹¤ë¡£
+    // 有効期限を過ぎていないかどうかをチェックする。
     if (intval(@$_SESSION['mobile']['expires']) < time()) {
         gfPrintLog("Session expired at " .
@@ -128 +128 @@
     }
 
-    // ·ÈÂÓüËö¤Îµ¡¼ï¤¬°ìÃפ¹¤ë¤«¤É¤¦¤«¤ò¥Á¥§¥Ã¥¯¤¹¤ë¡£
+    // 携帯端末の機種が一致するかどうかをチェックする。
     $model = GC_MobileUserAgent::getModel();
     if (@$_SESSION['mobile']['model'] != $model) {
@@ -141 +141 @@
 
 /**
- * ¥â¥Ð¥¤¥ë¥µ¥¤¥ÈÍѤΥ»¥Ã¥·¥ç¥ó´ØÏ¢¤Î½é´ü½èÍý¤ò¹Ô¤¦¡£
+ * モバイルサイト用のセッション関連の初期処理を行う。
  *
  * @return void
  */
 function lfMobileInitSession() {
-    // ¥»¥Ã¥·¥ç¥óID¤Î¼õ¤±ÅϤ·¤Ë¥¯¥Ã¥­¡¼¤ò»ÈÍѤ·¤Ê¤¤¡£
+    // セッションIDの受け渡しにクッキーを使用しない。
     ini_set('session.use_cookies', '0');
 
-    // ¥Ñ¥é¥á¡¼¥¿¡¼¤«¤éÍ­¸ú¤Ê¥»¥Ã¥·¥ç¥óID¤ò¼èÆÀ¤¹¤ë¡£
+    // パラメーターから有効なセッションIDを取得する。
     $sessionId = lfMobileGetSessionId();
 
     session_start();
 
-    // ¥»¥Ã¥·¥ç¥óID¤Þ¤¿¤Ï¥»¥Ã¥·¥ç¥ó¥Ç¡¼¥¿¤¬Ìµ¸ú¤Ê¾ì¹ç¤Ï¡¢¥»¥Ã¥·¥ç¥óID¤òºÆÀ¸À®
-    // ¤·¡¢¥»¥Ã¥·¥ç¥ó¥Ç¡¼¥¿¤ò½é´ü²½¤¹¤ë¡£
+    // セッションIDまたはセッションデータが無効な場合は、セッションIDを再生成
+    // し、セッションデータを初期化する。
     if ($sessionId === false || !lfMobileValidateSession()) {
         session_regenerate_id();
@@ -162 +162 @@
                                             'expires'  => time() + MOBILE_SESSION_LIFETIME));
 
-        // ¿·¤·¤¤¥»¥Ã¥·¥ç¥óID¤òÉղ䷤ƥê¥À¥¤¥ì¥¯¥È¤¹¤ë¡£
+        // 新しいセッションIDを付加してリダイレクトする。
         if ($_SERVER['REQUEST_METHOD'] == 'GET') {
-            // GET ¤Î¾ì¹ç¤ÏƱ¤¸¥Ú¡¼¥¸¤Ë¥ê¥À¥¤¥ì¥¯¥È¤¹¤ë¡£
+            // GET の場合は同じページにリダイレクトする。
             header('Location: ' . gfAddSessionId());
         } else {
-            // GET °Ê³°¤Î¾ì¹ç¤Ï¥È¥Ã¥×¥Ú¡¼¥¸¤Ø¥ê¥À¥¤¥ì¥¯¥È¤¹¤ë¡£
+            // GET 以外の場合はトップページへリダイレクトする。
             header('Location: ' . URL_SITE_TOP . '?' . SID);
         }
@@ -173 +173 @@
     }
 
-    // ·ÈÂÓüËöID¤ò¼èÆÀ¤Ç¤­¤¿¾ì¹ç¤Ï¥»¥Ã¥·¥ç¥ó¥Ç¡¼¥¿¤ËÊݸ¤¹¤ë¡£
+    // 携帯端末IDを取得できた場合はセッションデータに保存する。
     $phoneId = GC_MobileUserAgent::getId();
     if ($phoneId !== false) {
@@ -179 +179 @@
     }
 
-    // ¥»¥Ã¥·¥ç¥ó¤ÎÍ­¸ú´ü¸Â¤ò¹¹¿·¤¹¤ë¡£
+    // セッションの有効期限を更新する。
     $_SESSION['mobile']['expires'] = time() + MOBILE_SESSION_LIFETIME;
 }
 
 /**
- * ¥â¥Ð¥¤¥ë¥µ¥¤¥ÈÍѤνÐÎϤνé´ü½èÍý¤ò¹Ô¤¦¡£
- *
- * ½ÐÎϤÎή¤ì
+ * モバイルサイト用の出力の初期処理を行う。
+ *
+ * 出力の流れ
  * 1. Smarty
- * 2. ÆâÉô¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤«¤é Shift JIS ¤ËÊÑ´¹¤¹¤ë¡£
- * 3. Á´³Ñ¥«¥¿¥«¥Ê¤òȾ³Ñ¥«¥¿¥«¥Ê¤ËÊÑ´¹¤¹¤ë¡£
- * 4. ²èÁüÍѤΥ¿¥°¤òÄ´À°¤¹¤ë¡£
- * 5. ³¨Ê¸»ú¥¿¥°¤ò³¨Ê¸»ú¥³¡¼¥É¤ËÊÑ´¹¤¹¤ë¡£
- * 6. ½ÐÎÏ
+ * 2. 内部エンコーディングから Shift JIS に変換する。
+ * 3. 全角カタカナを半角カタカナに変換する。
+ * 4. 画像用のタグを調整する。
+ * 5. 絵文字タグを絵文字コードに変換する。
+ * 6. 出力
  *
  * @return void
  */
 function lfMobileInitOutput() {
-    // Smarty ÍѤΥǥ£¥ì¥¯¥È¥ê¡¼¤òºîÀ®¤¹¤ë¡£
+    // Smarty 用のディレクトリーを作成する。
     @mkdir(COMPILE_DIR);
 
-    // ½ÐÎÏÍѤΥ¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤ò Shift JIS ¤Ë¸ÇÄꤹ¤ë¡£
+    // 出力用のエンコーディングを Shift JIS に固定する。
     mb_http_output('SJIS-win');
 
-    // ³¨Ê¸»ú¥¿¥°¤ò³¨Ê¸»ú¥³¡¼¥É¤ËÊÑ´¹¤¹¤ë¡£
+    // 絵文字タグを絵文字コードに変換する。
     ob_start(array('GC_MobileEmoji', 'handler'));
 
-    // üËö¤Ë¹ç¤ï¤»¤Æ²èÁü¥µ¥¤¥º¤òÊÑ´¹¤¹¤ë¡£
+    // 端末に合わせて画像サイズを変換する。
     ob_start(array('GC_MobileImage', 'handler'));
 
-    // Á´³Ñ¥«¥¿¥«¥Ê¤òȾ³Ñ¥«¥¿¥«¥Ê¤ËÊÑ´¹¤¹¤ë¡£
+    // 全角カタカナを半角カタカナに変換する。
     ob_start(create_function('$buffer', 'return mb_convert_kana($buffer, "k", "SJIS-win");'));
 
-    // ÆâÉô¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤«¤é Shift JIS ¤ËÊÑ´¹¤¹¤ë¡£
+    // 内部エンコーディングから Shift JIS に変換する。
     ob_start('mb_output_handler');
 }
 
 /**
- * ¥â¥Ð¥¤¥ë¥µ¥¤¥ÈÍѤνé´ü½èÍý¤ò¹Ô¤¦¡£
+ * モバイルサイト用の初期処理を行う。
  *
  * @return void
@@ -233 +233 @@
 
 /**
- * LocationÅù¤Ç¥»¥Ã¥·¥ç¥óID¤òÉղ乤ëɬÍפ¬¤¢¤ëURL¤Ë¥»¥Ã¥·¥ç¥óID¤òÉղ乤롣
+ * Location等でセッションIDを付加する必要があるURLにセッションIDを付加する。
  *
  * @return String
@@ -244 +244 @@
 
 /**
- * ¶õ¥á¡¼¥ëÍѤΥȡ¼¥¯¥ó¤òÀ¸À®¤¹¤ë¡£
- *
- * @return string À¸À®¤·¤¿¥È¡¼¥¯¥ó¤òÊÖ¤¹¡£
+ * 空メール用のトークンを生成する。
+ *
+ * @return string 生成したトークンを返す。
  */
 function lfGenerateKaraMailToken() {
@@ -263 +263 @@
 
 /**
- * ¶õ¥á¡¼¥ë´ÉÍý¥Æ¡¼¥Ö¥ë¤Ë¿·µ¬¥¨¥ó¥È¥ê¡¼¤òÅÐÏ¿¤·¡¢¥È¡¼¥¯¥ó¤òÊÖ¤¹¡£
- *
- * @param string $next_url ¶õ¥á¡¼¥ë¼õ¤±ÉÕ¤±¸å¤ËÁ«°Ü¤µ¤»¤ë¥Ú¡¼¥¸ (¥â¥Ð¥¤¥ë¥µ¥¤¥È¥È¥Ã¥×¤«¤é¤ÎÁêÂÐURL)
- * @param string $session_id ¥»¥Ã¥·¥ç¥óID (¾Êά¤·¤¿¾ì¹ç¤Ï¸½ºß¤Î¥»¥Ã¥·¥ç¥óID)
- * @return string|false ¥È¡¼¥¯¥ó¤òÊÖ¤¹¡£¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç¤Ïfalse¤òÊÖ¤¹¡£
+ * 空メール管理テーブルに新規エントリーを登録し、トークンを返す。
+ *
+ * @param string $next_url 空メール受け付け後に遷移させるページ (モバイルサイトトップからの相対URL)
+ * @param string $session_id セッションID (省略した場合は現在のセッションID)
+ * @return string|false トークンを返す。エラーが発生した場合はfalseを返す。
  */
 function gfPrepareKaraMail($next_url, $session_id = null) {
@@ -306 +306 @@
 
 /**
- * ¶õ¥á¡¼¥ë¤«¤é¼èÆÀ¤·¤¿¥á¡¼¥ë¥¢¥É¥ì¥¹¤ò¶õ¥á¡¼¥ë´ÉÍý¥Æ¡¼¥Ö¥ë¤ËÅÐÏ¿¤¹¤ë¡£
- *
- * @param string $token ¥È¡¼¥¯¥ó
- * @param string $email ¥á¡¼¥ë¥¢¥É¥ì¥¹
- * @return boolean À®¸ù¤·¤¿¾ì¹ç¤Ïtrue¡¢¼ºÇÔ¤·¤¿¾ì¹ç¤Ïfalse¤òÊÖ¤¹¡£
+ * 空メールから取得したメールアドレスを空メール管理テーブルに登録する。
+ *
+ * @param string $token トークン
+ * @param string $email メールアドレス
+ * @return boolean 成功した場合はtrue、失敗した場合はfalseを返す。
  */
 function gfRegisterKaraMail($token, $email) {
@@ -334 +334 @@
 
 /**
- * ¶õ¥á¡¼¥ë´ÉÍý¥Æ¡¼¥Ö¥ë¤«¤é¥È¡¼¥¯¥ó¤¬°ìÃפ¹¤ë¹Ô¤òºï½ü¤·¡¢
- * ¼¡¤ËÁ«°Ü¤µ¤»¤ë¥Ú¡¼¥¸¤ÎURL¤òÊÖ¤¹¡£¡¡
- *
- * ¥á¡¼¥ë¥¢¥É¥ì¥¹¤Ï $_SESSION['mobile']['kara_mail_from'] ¤ËÅÐÏ¿¤µ¤ì¤ë¡£
- *
- * @param string $token ¥È¡¼¥¯¥ó
- * @return string|false URL¤òÊÖ¤¹¡£¥¨¥é¡¼¤¬È¯À¸¤·¤¿¾ì¹ç¤Ïfalse¤òÊÖ¤¹¡£
+ * 空メール管理テーブルからトークンが一致する行を削除し、
+ * 次に遷移させるページのURLを返す。　
+ *
+ * メールアドレスは $_SESSION['mobile']['kara_mail_from'] に登録される。
+ *
+ * @param string $token トークン
+ * @return string|false URLを返す。エラーが発生した場合はfalseを返す。
  */
 function gfFinishKaraMail($token) {
@@ -368 +368 @@
 
 /**
- * ³°Éô¥µ¥¤¥ÈÏ¢·ÈÍѤ˥»¥Ã¥·¥ç¥óID¤È¥Ñ¥é¥á¡¼¥¿¡¼¤ÎÁȤ߹ç¤ï¤»¤òÊݸ¤¹¤ë¡£
- *
- * @param string $param_key ¥Ñ¥é¥á¡¼¥¿¡¼Ì¾
- * @param string $param_value ¥Ñ¥é¥á¡¼¥¿¡¼ÃÍ
+ * 外部サイト連携用にセッションIDとパラメーターの組み合わせを保存する。
+ *
+ * @param string $param_key パラメーター名
+ * @param string $param_value パラメーター値
  * @param string $url URL
  * @return void
@@ -391 +391 @@
 
 /**
- * ¥á¡¼¥ë¥¢¥É¥ì¥¹¤¬·ÈÂӤΤâ¤Î¤«¤É¤¦¤«¤òȽÊ̤¹¤ë¡£
- *
- * @param string $address ¥á¡¼¥ë¥¢¥É¥ì¥¹
- * @return boolean ·ÈÂӤΥ᡼¥ë¥¢¥É¥ì¥¹¤Î¾ì¹ç¤Ïtrue¡¢¤½¤ì°Ê³°¤Î¾ì¹ç¤Ïfalse¤òÊÖ¤¹¡£
+ * メールアドレスが携帯のものかどうかを判別する。
+ *
+ * @param string $address メールアドレス
+ * @return boolean 携帯のメールアドレスの場合はtrue、それ以外の場合はfalseを返す。
  */
 function gfIsMobileMailAddress($address) {
-    // pdx.ne.jp(¥¦¥£¥ë¥³¥à)ÄɲÃ
+    // pdx.ne.jp(ウィルコム)追加
     $arrMobileMailDomains = array('docomo.ne.jp', 'ezweb.ne.jp', 'softbank.ne.jp', 'vodafone.ne.jp', 'pdx.ne.jp');