File Source for SC_Helper

<?php
/*
* This file is part of EC-CUBE
*
* Copyright(c) 2000-2011 LOCKON CO.,LTD. All Rights Reserved.
*
* http://www.lockon.co.jp/
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
// {{{ requires
require_once CLASS_REALDIR . '../module/Net/URL.php';
require_once CLASS_REALDIR . 'SC_Query.php';
/**
* モバイルのヘルパークラス.
*
* @package Helper
* @author LOCKON CO.,LTD.
* @version $Id: SC_Helper_Mobile.php 21185 2011-08-11 10:37:10Z shutta $
*/
class SC_Helper_Mobile {
/**
* EC-CUBE がサポートする携帯端末かどうかをチェックする。
* 非対応端末の場合は /unsupported/ へリダイレクトする。
*
* @return void
*/
function lfMobileCheckCompatibility() {
if (!SC_MobileUserAgent_Ex::isSupported()) {
header('Location: ' . ROOT_URLPATH . 'unsupported/' . DIR_INDEX_PATH);
exit;
}
}
/**
* 入力データを内部エンコーディングに変換し、絵文字を除去する。
*
* @param string &$value 入力データへの参照
* @return void
*/
function lfMobileConvertInputValue(&$value) {
if (is_array($value)) {
foreach($value as $key => $val ){
$this->lfMobileConvertInputValue($value[$key]);
}
} else {
// Shift JIS から内部エンコーディングに変換する。
$value = mb_convert_encoding($value, CHAR_CODE, 'SJIS');
// SoftBank? 以外の絵文字は外字領域に含まれるため、この段階で除去される。
// SoftBank? の絵文字を除去する。
$value = preg_replace('/\\x1b\\$[^\\x0f]*\\x0f/', '', $value);
}
}
/**
* モバイルサイト用の入力の初期処理を行う。
*
* @return void
*/
function lfMobileInitInput() {
array_walk($_GET, array($this, 'lfMobileConvertInputValue'));
array_walk($_POST, array($this, 'lfMobileConvertInputValue'));
array_walk($_REQUEST, array($this, 'lfMobileConvertInputValue'));
}
/**
* dtb_mobile_ext_session_id テーブルを検索してセッションIDを取得する。
*
* @return string|null取得したセッションIDを返す。
* 取得できなかった場合は null を返す。
*/
function lfMobileGetExtSessionId() {
if (!preg_match('|^' . ROOT_URLPATH . '(.*)$|', $_SERVER['SCRIPT_NAME'], $matches)) {
return null;
}
$url = $matches[1];
$time = date('Y-m-d H:i:s', time() - MOBILE_SESSION_LIFETIME);
$objQuery = new SC_Query_Ex();
foreach ($_REQUEST as $key => $value) {
$session_id = $objQuery->get('session_id', 'dtb_mobile_ext_session_id',
'param_key = ? AND param_value = ? AND url = ? AND create_date >= ?',
array($key, $value, $url, $time));
if (isset($session_id)) {
return $session_id;
}
}
return null;
}
/**
* パラメーターから有効なセッションIDを取得する。
*
* @return string|false取得した有効なセッションIDを返す。
* 取得できなかった場合は false を返す。
*/
function lfMobileGetSessionId() {
// パラメーターからセッションIDを取得する。
$sessionId = @$_POST[session_name()];
if (!isset($sessionId)) {
$sessionId = @$_GET[session_name()];
}
if (!isset($sessionId)) {
$sessionId = $this->lfMobileGetExtSessionId();
}
if (!isset($sessionId)) {
return false;
}
// セッションIDの存在をチェックする。
$objSession = new SC_Helper_Session_Ex();
if ($objSession->sfSessRead($sessionId) === null) {
GC_Utils_Ex::gfPrintLog("Non-existent session id : sid=$sessionId");
return false;
}
return session_id($sessionId);
}
/**
* セッションデータが有効かどうかをチェックする。
*
* FIXME "@" でエラーを抑制するのは良くない
*
* @return boolean セッションデータが有効な場合は true、無効な場合は false を返す。
*/
function lfMobileValidateSession() {
// 配列 mobile が登録されているかどうかをチェックする。
if (!is_array(@$_SESSION['mobile'])) {
return false;
}
// 有効期限を過ぎていないかどうかをチェックする。
if (intval(@$_SESSION['mobile']['expires']) < time()) {
GC_Utils_Ex::gfPrintLog("Session expired at " .
date('Y/m/d H:i:s', @$_SESSION['mobile']['expires']) .
' : sid=' . session_id());
return false;
}
// 携帯端末の機種が一致するかどうかをチェックする。
$model = SC_MobileUserAgent_Ex::getModel();
if (@$_SESSION['mobile']['model'] != $model) {
GC_Utils_Ex::gfPrintLog("User agent model mismatch : " .
"\"$model\" != \"" . @$_SESSION['mobile']['model'] .
'" (expected), sid=' . session_id());
return false;
}
return true;
}
/**
* モバイルサイト用のセッション関連の初期処理を行う。
*
* @return void
*/
function lfMobileInitSession() {
// セッションIDの受け渡しにクッキーを使用しない。
ini_set('session.use_cookies', '0');
ini_set('session.use_only_cookies', '0');
// パラメーターから有効なセッションIDを取得する。
$sessionId = $this->lfMobileGetSessionId();
session_start();
// セッションIDまたはセッションデータが無効な場合は、セッションIDを再生成
// し、セッションデータを初期化する。
if ($sessionId === false || !$this->lfMobileValidateSession()) {
session_regenerate_id();
$_SESSION = array('mobile' => array('model' => SC_MobileUserAgent_Ex::getModel(),
'phone_id' => SC_MobileUserAgent_Ex::getId(),
'expires' => time() + MOBILE_SESSION_LIFETIME));
// 新しいセッションIDを付加してリダイレクトする。
if ($_SERVER['REQUEST_METHOD'] == 'GET') {
// GET の場合は同じページにリダイレクトする。
header('Location: ' . $this->gfAddSessionId());
} else {
// GET 以外の場合はトップページへリダイレクトする。
header('Location: ' . TOP_URLPATH . '?' . SID);
}
exit;
}
// 携帯端末IDを取得できた場合はセッションデータに保存する。
$phoneId = SC_MobileUserAgent_Ex::getId();
if ($phoneId !== false) {
$_SESSION['mobile']['phone_id'] = $phoneId;
}
// セッションの有効期限を更新する。
$_SESSION['mobile']['expires'] = time() + MOBILE_SESSION_LIFETIME;
}
/**
* モバイルサイト用の出力の初期処理を行う。
*
* 出力の流れ
* 1. Smarty
* 2. 内部エンコーディングから Shift JIS に変換する。
* 3. 全角カタカナを半角カタカナに変換する。
* 4. 画像用のタグを調整する。
* 5. 絵文字タグを絵文字コードに変換する。
* 6. 出力
*
* @return void
*/
function lfMobileInitOutput() {
// Smarty 用のディレクトリーを作成する。
@mkdir(COMPILE_REALDIR);
// 出力用のエンコーディングを Shift JIS に固定する。
mb_http_output('SJIS-win');
// 絵文字タグを絵文字コードに変換する。
ob_start(array('SC_MobileEmoji_Ex', 'handler'));
// 端末に合わせて画像サイズを変換する。
ob_start(array('SC_MobileImage_Ex', 'handler'));
// 全角カタカナを半角カタカナに変換する。
ob_start(create_function('$buffer', 'return mb_convert_kana($buffer, "k", "SJIS-win");'));
// 内部エンコーディングから Shift JIS に変換する。
ob_start('mb_output_handler');
}
/**
* モバイルサイト用の初期処理を行う。
*
* @return void
*/
function sfMobileInit() {
$this->lfMobileInitInput();
if (basename(dirname($_SERVER['SCRIPT_NAME'])) != 'unsupported') {
$this->lfMobileCheckCompatibility();
/**
* 共有SSL対応のため、SC_SessionFactory_UseRequest::initSession()へ移行
* また、他のセッション関連メソッドもSC_SessionFactory_UseRequestのインスタンスから呼び出すこと
*
* @see data/class/session/sessionfactory/SC_SessionFactory_UseRequest.php
*/
// $this->lfMobileInitSession();
}
$this->lfMobileInitOutput();
}
/**
* Location等でセッションIDを付加する必要があるURLにセッションIDを付加する。
*
* @return String
*/
function gfAddSessionId($url = null) {
$objURL = new Net_URL($url);
$objURL->addQueryString(session_name(), session_id());
return $objURL->getURL();
}
/**
* セッション ID を付加した配列を返す.
*
* @param array $array 元となる配列
* @param array セッション ID を追加した配列
*/
function sessionIdArray($array = array()) {
return array_merge($array, array(session_name() => session_id()));
}
/**
* 空メール用のトークンを生成する。
*
* @return string 生成したトークンを返す。
*/
function lfGenerateKaraMailToken() {
$token_chars = '0123456789abcdefghijklmnopqrstuvwxyz';
$token_chars_length = strlen($token_chars);
$token_length = 10;
$token = '';
while ($token_length > 0) {
$token .= $token_chars{mt_rand(0, $token_chars_length - 1)};
--$token_length;
}
return $token;
}
/**
* 空メール管理テーブルに新規エントリーを登録し、トークンを返す。
*
* @param string $next_url 空メール受け付け後に遷移させるページ (モバイルサイトトップからの相対URL)
* @param string $session_id セッションID (省略した場合は現在のセッションID)
* @return string|falseトークンを返す。エラーが発生した場合はfalseを返す。
*/
function gfPrepareKaraMail($next_url, $session_id = null) {
if (!isset($session_id)) {
$session_id = session_id();
}
$objQuery = new SC_Query_Ex();
// GC
$time = date('Y-m-d H:i:s', time() - MOBILE_SESSION_LIFETIME);
$objQuery->delete('dtb_mobile_kara_mail', 'email IS NULL AND create_date < ?', array($time));
$objQuery->delete('dtb_mobile_kara_mail', 'session_id = ?', array($session_id));
$arrValues = array('session_id' => $session_id,
'next_url' => $next_url);
$try = 10;
while ($try > 0) {
$arrValues['token'] = $token = $this->lfGenerateKaraMailToken();
$arrValues['kara_mail_id'] = $objQuery->nextVal('dtb_mobile_kara_mail_kara_mail_id');
$objQuery->insert('dtb_mobile_kara_mail', $arrValues);
$count = $objQuery->count('dtb_mobile_kara_mail', 'token = ?', array($token));
if ($count == 1) {
break;
}
$objQuery->delete('dtb_mobile_kara_mail', 'session_id = ?', array($session_id));
$token = false;
--$try;
}
return $token;
}
/**
* 空メールから取得したメールアドレスを空メール管理テーブルに登録する。
*
* @param string $token トークン
* @param string $email メールアドレス
* @return boolean 成功した場合はtrue、失敗した場合はfalseを返す。
*/
function gfRegisterKaraMail($token, $email) {
$objQuery = new SC_Query_Ex();
// GC
$time = date('Y-m-d H:i:s', time() - MOBILE_SESSION_LIFETIME);
$objQuery->delete('dtb_mobile_kara_mail',
'(email IS NULL AND create_date < ?) OR (email IS NOT NULL AND receive_date < ?)',
array($time, $time));
$kara_mail_id = $objQuery->get('kara_mail_id', 'dtb_mobile_kara_mail', 'token = ?', array($token));
if (!isset($kara_mail_id)) {
return false;
}
$arrValues = array('email' => $email);
$arrRawValues = array('receive_date' => 'CURRENT_TIMESTAMP');
$objQuery->update('dtb_mobile_kara_mail', $arrValues, 'kara_mail_id = ?', array($kara_mail_id), $arrRawValues);
return true;
}
/**
* 空メール管理テーブルからトークンが一致する行を削除し、
* 次に遷移させるページのURLを返す。　
*
* メールアドレスは $_SESSION['mobile']['kara_mail_from'] に登録される。
*
* @param string $token トークン
* @return string|falseURLを返す。エラーが発生した場合はfalseを返す。
*/
function gfFinishKaraMail($token) {
$objQuery = new SC_Query_Ex();
$arrRow = $objQuery->getRow(
'session_id, next_url, email'
,'dtb_mobile_kara_mail'
,'token = ? AND email IS NOT NULL AND receive_date >= ?'
,array($token, date('Y-m-d H:i:s', time() - MOBILE_SESSION_LIFETIME))
,DB_FETCHMODE_ORDERED
);
if (!isset($arrRow)) {
return false;
}
$objQuery->delete('dtb_mobile_kara_mail', 'token = ?', array($token));
list($session_id, $next_url, $email) = $arrRow;
$objURL = new Net_URL(HTTP_URL . $next_url);
$objURL->addQueryString(session_name(), $session_id);
$url = $objURL->getURL();
session_id($session_id);
session_start();
$_SESSION['mobile']['kara_mail_from'] = $email;
session_write_close();
return $url;
}
/**
* 外部サイト連携用にセッションIDとパラメーターの組み合わせを保存する。
*
* @param string $param_key パラメーター名
* @param string $param_value パラメーター値
* @param string $url URL
* @return void
*/
function sfMobileSetExtSessionId($param_key, $param_value, $url) {
$objQuery = new SC_Query_Ex();
// GC
$time = date('Y-m-d H:i:s', time() - MOBILE_SESSION_LIFETIME);
$objQuery->delete('dtb_mobile_ext_session_id', 'create_date < ?', array($time));
$arrValues = array('session_id' => session_id(),
'param_key' => $param_key,
'param_value' => $param_value,
'url' => $url);
$objQuery->insert('dtb_mobile_ext_session_id', $arrValues);
}
/**
* メールアドレスが携帯のものかどうかを判別する。
*
* @param string $address メールアドレス
* @return boolean 携帯のメールアドレスの場合はtrue、それ以外の場合はfalseを返す。
*/
function gfIsMobileMailAddress($address) {
$masterData = new SC_DB_MasterData_Ex();
$arrMobileMailDomains = $masterData->getMasterData("mtb_mobile_domain");
foreach ($arrMobileMailDomains as $domain) {
$domain = preg_quote($domain, '/');
if (preg_match("/@([^@]+\\.)?$domain\$/", $address)) {
return true;
}
}
return false;
}
}
?>

Source for file SC_Helper_Mobile.php