EC-CUBE3をさくらのレンタルサーバにインストールした時にhtmlを付けさせない方法

EC-CUBE3 PHP

過去の記事ではURLに/htmlを付けさせない方法を書いてきました。

EC-CUBE3のURL設定について - AmidaikeBlog

EC-CUBE3のURL設定について2 - AmidaikeBlog

レンタルサーバでEC-CUBE3でのURL設定の仕方について - AmidaikeBlog

レンタルサーバでEC-CUBE3のURLにhtmlを付けさせない方法 - AmidaikeBlog

今回はさくらのレンタルサーバに特化してしまいますが、以下の通りにすればhtmlを無くす事ができます。

クイックインストールを使うのでEC-CUBE3をアップロードをしてインストールされる方は勝手が異なりますのでご注意ください。

今回の方法では、初期ドメイン(sakura.ne.jp)でインストールした後に独自ドメインを割り当てる方法となります。

1.クイックインストール時に初期ドメイン(xxxxxx.sakura.ne.jp)でインストールを行います。その際、ec-cubeをインストールするディレクトリを指定してください。

2.クイックインストールが完了しましたら、独自ドメインの指定ディレクトリを先ほどec-cubeをインストールしたディレクトリに設定します。

3.EC-CUBEをインストールしたディレクトリの配下にある/htmlディレクトリの.htaccessを以下のように変更を行います。

RewriteBase /html

4.さらに、EC-CUBEをインストールしたディレクトリ直下と/app配下の.htaccessを以下の様に修正します。

<FilesMatch "^composer|^autoload|^cli-config|^COPYING|\.(ht|ini|lock|dist|git|sh)$">
     order allow,deny
     deny from all
</FilesMatch>

<Files ~ "index.php|index_dev.php">
     order deny,allow
     allow from all
</Files>

<IfModule mod_rewrite.c>
     RewriteEngine On
     RewriteBase /html/

     RewriteRule ^user_data/(.*)$ /html/user_data/$1 [QSA,L]

     RewriteCond %{REQUEST_FILENAME} !-f
     RewriteCond %{REQUEST_FILENAME} !^(.*)\.(gif|png|jpg|css|ico|js)$ [NC]
     RewriteRule ^(.*)$ index.php [QSA,L]

</IfModule>

5.http://独自ドメイン/htmlでEC-CUBEのインストーラーが 表示されますので通常のインストールを行ってください。

6.インストールが完了すれば、 app/config/eccube/にファイルが作成されますので、 ファイルマネージャーなどを利用してapp/config/eccube/path.ymlの以下の部分を修正します。

root_urlpath　: /html/
↓
root_urlpath :

7.以上の設定で、htmlをなくしてサイトが表示されます。

8.新規ページを作成する場合、以下のカスタマイズを行う必要がありますので必要な方は修正をしてください。

html/index.php
のif文の内容を下記の該当する部分のように変更してください。

// インストールされてなければインストーラにリダイレクト
if ($app['config']['eccube_install']) {
    $app->initialize();
    $app->initializePlugin();

    $front = $app['controllers_factory'];
    // 強制SSL
    if ($app['config']['force_ssl'] == \Eccube\Common\Constant::ENABLED) {
        $front->requireHttps();
    }

    $front->match('/{route}', '\Eccube\Controller\UserDataController::index')->assert('route', '([0-9a-zA-Z_\-]+\/?)+(?<!\/)')->bind('user_data');
    $app->mount('', $front);

    if ($app['config']['http_cache']['enabled']) {
        $app['http_cache']->run();
    } else {
        $app->run();
    }
} else {
    $location = str_replace('index.php', 'install.php', $_SERVER['SCRIPT_NAME']);
    header('Location:'.$location);
    exit;
}

src/Eccube/ControllerProvider/FrontControllerProvider.php の

// user定義
$c->match('/'.$app['config']['user_data_route'].'/{route}', '\Eccube\Controller\UserDataController::index')->assert('route', '([0-9a-zA-Z_\-]+\/?)+(?<!\/)')->bind('user_data');

を

// user定義
// $c->match('/'.$app['config']['user_data_route'].'/{route}', '\Eccube\Controller\UserDataController::index')->assert('route', '([0-9a-zA-Z_\-]+\/?)+(?<!\/)')->bind('user_data');

とコメントアウトしてください。

今回はさくらのレンタルサーバを対象に記述しましたが、他のレンタルサーバでも同様に動くかもしれませんので是非お試しください。

【 2016/09/29 追記】

EC-CUBE3.0.11よりhtmlを削除する機能が提供されました。

amidaike.hatenablog.com

EC-CUBE3のプラグインのフックポイントについて

EC-CUBE3 PHP

EC-CUBE Advent Calendar 2015 4日目の記事です。

4日目はEC-CUBE3でブラグインを実行する際に定義されているフックポイントについてです。

皆さんEC-CUBE3のプラグインを作っていますか?

プラグインの開発に慣れていくに従って段々と疑問に思ってくるのがフックポイントについてです。

勉強会などを行うときに必ず聞かれる内容として 「各フックポイントの実行タイミングが良く分からない」と尋ねられます。

今回は簡単に各フックポイントについてまとめました。

フックポイントを説明する前に先ずはSymfony2では標準で

  • kernel.request
  • kernel.controller
  • kernel.view
  • kernel.response
  • kernel.exception

というイベントが存在しています。

詳しくはこちら。 The HttpKernel Component (The Symfony Components)

EC-CUBE3ではSymfony2のイベント

  • kernel.request
  • kernel.response
  • kernel.terminate

の各イベントに対して処理を挟み込めるフックポイントが用意されています。

詳しくはこちら。ミドルウェア (Middlewares) | Japan Symfony Group

EC-CUBE3で用意されているフックポイントについて *1

Middleware

  • アプリケーション全体の処理の前後・特定のページの処理の前後に 処理を介入させることができます。
  • 全てのControllerに対して介入が可能です。

FilterResponseEvent

  • Responseが返却される描画される直前のHTTP HeaderやBodyを 書き換えることができます。
  • HTMLだけでなく、JSONで返却したいなどの変更も可能です。

今までの説明だけではさっぱり分からないと思いますので、実際に動作をさせてみましょう。

今回はプラグインの作成方法について説明は割愛しますが、 こういうプラグインを作って用意されているフックポイントの実行タイミングを確認してみました。

  • config.yml
name: フックポイント確認プラグイン
code: HookPoint
version: 1.0.0
event: HookPointEvent
  • event.yml
eccube.event.app.before:
  - [onAppBefore, NORMAL]
eccube.event.app.after:
  - [onAppAfter, NORMAL]
eccube.event.controller.homepage.before:
  - [onControllerBefore, NORMAL]
eccube.event.controller.homepage.after:
  - [onControllerAfter, NORMAL]
eccube.event.controller.homepage.finish:
  - [onControllerFinish, NORMAL]
eccube.event.render.homepage.before:
  - [onRenderBefore, NORMAL]
  • HookPointEvent.php
<?php
namespace Plugin\HookPoint;

use Symfony\Component\HttpKernel\Event\FilterResponseEvent;

class HookPointEvent
{

    /** @var  \Eccube\Application $app */
    private $app;

    public function __construct($app)
    {
        $this->app = $app;
    }

    public function onAppBefore()
    {
        error_log("onAppBefore");
    }

    public function onAppAfter()
    {
        error_log("onAppAfter");
    }

    public function onControllerBefore()
    {
        error_log("onControllerBefore");
    }

    public function onControllerAfter()
    {
        error_log("onControllerAfter");
    }

    public function onControllerFinish()
    {
        error_log("onControllerFinish");
    }

    public function onRenderBefore(FilterResponseEvent $event)
    {
        error_log("onRenderBefore");
    }
}
  • TopController.php
use Eccube\Application;

class TopController
{

    public function index(Application $app)
    {
        error_log('TopController::index')
        return $app->render('index.twig');
    }
}
  • ApplicationTrait.php(一部抜粋)
public function render($view, array $parameters = array(), Response $response = null)
{
    $twig = $this['twig'];

    if ($response instanceof StreamedResponse) {
        $response->setCallback(function () use ($twig, $view, $parameters) {
            $twig->display($view, $parameters);
        });
    } else {
        if (null === $response) {
            $response = new Response();
        }
        $response->setContent($twig->render($view, $parameters));
    }

    error_log("twig render");

    return $response;
}

これらを実行すると以下が出力されます。(実際にはもう少し出力されますが)

 onAppBefore
 onControllerBefore
 TopController::index
 twig render
 onControllerAfter
 onRenderBefore
 onAppAfter
 onControllerFinish

最初に実行されるのが

eccube.event.app.before

であとは大体想定通りと思いますが、意外だったのが

onControllerFinish

です。onAppAfterより後に実行されるのは想定外でしたが、この順番で実行されていきます。

では、それぞれのフックポイントのイベントについては何を記述すれば良いかというと、

フックポイント 処理の内容など Symfony2に対応するイベント
onAppBefore アプリケーション共通の前処理を記述 kernel.request (EARLY_EVENT)
onAppAfter アプリケーション共通の後処理を記述 kernel.request (LATE_EVENT)
onControllerBefore Controllerが実行される前に行う処理を記述 kernel.request
onControllerAfter Controllerが実行された後に行う処理を記述 kernel.response
onControllerFinish Controllerが最後まで実行された後に行う処理を記述 kernel.terminate
onRenderBefore Viewに対して項目の追加などを行う処理を記述 kernel.response

になります。

プラグインを作成していて画面の拡張や処理の拡張をする場合、どのイベントに対して記述すれば分からないときはこちらの表を参考にしてください。

この記事がフックポイントについての理解について手助けになれば幸いです。

EC-CUBEプラグインアワードの締め切りも近いので是非ご応募お待ちしております。 www.ec-cube.net

5日目は@tuyop1です。

*1:プラグイン仕様書から抜粋

EC-CUBE3.0.5以降でPostgres9の環境だと正常に動作しない時の対処方法

EC-CUBE3 PHP

EC-CUBE3.0.5からsessionの保存方法としてDB(dtb_session)を使うことになりました。

ただ、MySQLだと正常に動作しますが、 Postgres9だと環境によっては正常に動作しない時があります。 →MacのHomebrewでインストールしたPostgres9など

原因はSymfony2の問題であり、まだSymfony2側では対応されておりません。

NativeSessionStorage->loadSession() empty $_SESSION with PdoSessionHandler and pgsql · Issue #14569 · symfony/symfony · GitHub

回避方法としては以下のSQLを実行すると動作されるようになります。

ALTER DATABASE データベース名 SET bytea_output = 'escape';

Postgres9以降で動作しないよーという方はぜひお試しください。

EC-CUBE3でMailgunを使ったメール送信方法

EC-CUBE3 PHP

以前にEC-CUBE3からGmailを使ったメール送信方法を書きました。

amidaike.hatenablog.com

今回はMailgunを使ったメール送信方法について説明します。

www.mailgun.com

Mailgunの説明は今回割愛しますが Mailgunの管理画面にあるDomain Informationの Default SMTP Login と Default Password を設定することで簡単に送信できます。

app/config/eccube/mail.yml を

mail:
    transport: smtp
    host: smtp.mailgun.org
    port: 25
    username: Mailgunで設定されているDefault SMTP Login
    password: Mailgunで設定されているDefault Password
    encryption: null
    auth_mode: null
    charset_iso_2022_jp: false

以上を設定するだけでメール送信が可能となります。

Mailgunは月10,000通までは無料なので、 クラウドやVPSでEC-CUBEの環境は出来たけどメールサーバまで作るのはしんどいという方にはお手軽に扱えるサービスです。

今回はSMTPを使ってメール送信の仕方を説明しましたが、 MailgunはAPIが提供されており本来であれば色々とできますので、 もっと色々と細かいことをしたい方はプラグインを作成してみてはいかがでしょうか。

EC-CUBE2とEC-CUBE3のテーブル比較

EC-CUBE3 PHP

EC-CUBE3のテーブルについてEC-CUBE2からどのテーブルが無くなったりしているのか把握していなかったので、簡単に比較表を作成してまとめてみました。

こんな感じです。

2系テーブル 論理テーブル名 3系テーブル
dtb_api_account APIアカウント ×
dtb_api_config API設定 ×
dtb_baseinfo 店基本情報 dtb_base_info
dtb_best_products おすすめ商品情報 ×
dtb_bkup バックアップ ×
dtb_bloc ブロック情報 dtb_block
dtb_blocposition ブロック記事情報 dtb_block_position
dtb_category カテゴリ情報 dtb_category
dtb_category_count カテゴリ商品数情報 dtb_category_count
dtb_category_total_count カテゴリ商品合計数情報 dtb_category_total_count
dtb_class 規格情報 dtb_class_name
dtb_classcategory 規格分類情報 dtb_class_category
dtb_csv CSV情報 dtb_csv
dtb_csv_sql CSV詳細設定SQL情報 ×
dtb_customer 顧客情報 dtb_customer
dtb_customer_favorite_products お気に入り商品情報 dtb_customer_favorite_product
dtb_deliv 配送業者情報 dtb_delivery
dtb_delivfee 送料情報 dtb_delivery_fee
dtb_delivtime 配送時間情報 dtb_delivery_time
dtb_holiday 休日情報 ×
dtb_index_list インデックス一覧 ×
dtb_kiyaku 規約情報 dtb_help
dtb_mail_history 受注メール送信履歴 dtb_mail_history
dtb_mailmaga_template メルマガテンプレート情報 ×
dtb_mailtemplate メールテンプレート情報 dtb_mail_template
dtb_maker メーカー ×
dtb_maker_count メーカーカウント ×
dtb_member 管理者情報 dtb_member
dtb_mobile_ext_session_id モバイルセッション情報 ×
dtb_module モジュール情報 ×
dtb_module_update_log モジュール更新ログ情報 ×
dtb_news 新着情報 dtb_news
dtb_order 受注情報 dtb_order
dtb_order_detail 受注詳細情報 dtb_order_detail
dtb_order_temp 受注一時情報 ×
dtb_other_deliv その他の配送先情報 dtb_customer_address
dtb_ownersstore_settings オーナーズストア設定 ×
dtb_pagelayout ページレイアウト情報 dtb_page_layout
dtb_payment 支払方法情報 dtb_payment
dtb_payment_options 支払選択肢情報 dtb_payment_option
dtb_plugin プラグイン情報 dtb_plugin
dtb_plugin_hookpoint プラグインフックポイント ×
dtb_products 商品情報 dtb_product
dtb_product_categories 商品カテゴリ関連 dtb_product_category
dtb_product_class 商品規格情報 dtb_product_class
dtb_product_status 商品ステータス情報 ×
dtb_recommend_products 関連商品情報 ×
dtb_review レビュー除法 ×
dtb_send_customer 顧客メール送信履歴 ×
dtb_send_history メール送信履歴 ×
dtb_session セッション情報 dtb_session
dtb_shipment_item 配送商品情報 dtb_shipment_item
dtb_shipping お届け先情報 dtb_shipping
dtb_tax_rule 消費税ルール dtb_tax_rule
dtb_templates テンプレート情報 dtb_template
dtb_update モジュール更新情報 ×
mtb_allowed_tag 許可タグ ×
mtb_auth_excludes 管理画面認証除外 ×
mtb_authority 管理者マスタ mtb_authority
mtb_constants 定数マスタ ×
mtb_country 国マスタ mtb_country
mtb_customer_order_status 顧客表示用受注ステータス mtb_cusotmer_order_status
mtb_customer_status 顧客ステータス mtb_customer_status
mtb_db データベース種別 mtb_db
mtb_delivery_date 商品発送日 dtb_delivery_date
mtb_device_type 端末種別 mtb_device_type
mtb_disable_logout ログアウト無効ページ ×
mtb_disp 公開フラグ mtb_disp
mtb_job 職業マスタ mtb_job
mtb_magazine_type メルマガ種別 ×
mtb_mail_magazine_type メールマガジン種別 ×
mtb_mail_template メールテンプレート ×
mtb_mail_tpl_path メールテンプレートパス ×
mtb_mail_type メール種別 ×
mtb_mobile_domain モバイルドメイン名 ×
mtb_order_status 受注状態 mtb_order_status
mtb_order_status_color 受注ステータス色 mtb_order_status_color
mtb_ownersstoer_err オーナーズストアエラー種別 ×
mtb_page_max ページ最大表示数 mtb_page_max
mtb_permission 管理画面アクセス権限 ×
mtb_pref 都道府県マスタ mtb_pref
mtb_product_list_max 商品一覧最大表示数 mtb_product_list_max
mtb_product_status_color 商品ステータス色 ×
mtb_product_type 商品種別マスタ mtb_product_type
mtb_recommend おすすめレベル ×
mtb_reminder パスワード質問マスタ ×
mtb_review_deny_url レビュー拒否URL ×
mtb_sex 性別マスタ mtb_sex
mtb_status 商品ステータス ×
mtb_status_image ステータス画像 ×
mtb_target ブロックターゲット ×
mtb_taxrule 課税規則マスタ mtb_taxrule
mtb_wday 曜日 ×
mtb_work 管理者稼働状態 mtb_work
mtb_zip 郵便番号 mtb_zip

こうしてまとめてみると、結構テーブルが無くなっていますね。 機能自体がなくなっているものもあるため、致し方ありませんが。 2系から3系へ頑張って移行されようとしている方はこちらを参考に頑張ってください。

レンタルサーバでEC-CUBE3のURLにhtmlを付けさせない方法

EC-CUBE3 PHP

以前にEC-CUBE3をレンタルサーバにインストールする際のURLの設定の仕方について以下の記事を書きました。

amidaike.hatenablog.com

通常ec-cubeをそのままインストールすると http://hogehoge.com/html/ とhtmlがurlについてしまいます。

その回避方法として上記記事を作成したのですが、 この記事内ではファイルを移動したりと結構面倒なことをしていたため、 .htaccessを使って対処できないかなと思い、 .htaccessを以下のようにごにょごにょと対応してみました。

ec-cube直下の.htaccessに現状

order allow,deny
deny from all

と記述されている内容を

<FilesMatch "^composer|^autoload|^cli-config|^COPYING|\.(ht|ini|lock|dist|git|sh)$">
    order allow,deny
    deny from all
</FilesMatch>

<Files ~ "index.php|index_dev.php">
    order deny,allow
    allow from all
</Files>

<IfModule mod_rewrite.c>
    Options +FollowSymlinks
    RewriteEngine On
    RewriteBase /html/

    RewriteRule ^user_data/(.*)$ /html/user_data/$1 [QSA,L]

    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !^(.*)\.(gif|png|jpg|css|ico|js)$ [NC]
    RewriteRule ^(.*)$ index.php [QSA,L]

</IfModule>

に変更します。 その後、

app/config/eccube/path.yml

にあるroot_urlpath を

root_urlpath:

に修正すればhtmlがなくてもhttp://hogehoge.comだけでアクセス出来るようになります。

これで問題なく動作できるかどうか試していただけると助かります。 こちらはApache2.4未満の方を対象にしていますので、Apache2.4以上またはApache以外をお使いの方は別途対応できればと思います。

ただしこちらの対処だけではまだ不充分であり、 srcディレクトリやtestディレクトリvendorディレクトリなどの直下に対して、 appディレクトリ直下に置いてある.htaccessと同じものを置いて制限をかける必要があります。

【追記】
さくらサーバだとOptions +FollowSymlinksが使えないため、Optionsの行を消して対応可能かどうか試して頂ければと思います。

プラグイン使用時に<html>タグが削除される及び文字化けが発生する問題

EC-CUBE3 PHP

現在公開されているEC-CUBE3向けのプラグインではプラグイン対象ページだと

<!doctype html>
<html lang="ja">
</html>

のタグが出力されない現象及び文字化けが発生しています。

原因は、 $crawler->html(); を使うとタグが出力されない及び文字化けが発生します。

対処方法として、

public function Hoge(・・・・)
{
・・・・
    $crawler = new Crawler($response->getContent());
    $html = $this->getHtml($crawler);
・・・
}

/**
 * 解析用HTMLを取得
 *
 * @param Crawler $crawler
 * @return string
 */
private function getHtml(Crawler $crawler)
{
    $html = '';
    foreach ($crawler as $domElement) {
        $domElement->ownerDocument->formatOutput = true;
        $html .= $domElement->ownerDocument->saveHTML();
    }
    return html_entity_decode($html, ENT_NOQUOTES, 'UTF-8');
}

というようにgetHtmlを自作してdomElementを1行ずつ取得することで文字化けは直ります。

また、$crawler->filterも同様に文字化けが発生しますので、

$oldElement = $crawler->filter('#main');
$oldHtml = $oldElement->html();
$oldHtml = html_entity_decode($oldHtml, ENT_NOQUOTES, 'UTF-8');

とすることでこちらも対応可能です。

本来であれば本体側で組み込んで欲しい機能ですね。