シータントエンタープライズ株式会社 Web/アプリ/ゲーム/ECサイト開発

Ceatant Official Blog

Category Archives: tech

Google OpenID 2.0終了につきOpenID Connectに移行した時のメモ

Posted on by Posted in tech

Google Developers Blog: Reminder to migrate to OAuth 2.0 or OpenID Connect
http://googledevelopers.blogspot.jp/2015/03/reminder-to-migrate-to-oauth-20-or.html
GoogleのOpenID 2.0がサポート終了します。OpenID Connectへの移行期限は2015/4/20です。 | 事務局ブログ | OpenID ファウンデーション・ジャパン
http://www.openid.or.jp/blog/2015/04/google.html

弊社が担当しているサービスにもGoogleのOpenIDを認証に使っていたものがあり、移行作業を行いました。その際のメモを記しておきます。

システム概要
・BtoCのWebサービス
・CakePHP2.x使用
・OpenIDによるGoogleログイン、TwitterとFacebookのOAuth認証によるログイン機能あり

OpenIDのログインは、LightOpenIDというライブラリで実装していました。
lightopenid – Lightweight OpenID library. – Google Project Hosting
http://code.google.com/p/lightopenid/
コンパクトで使いやすかったのですが、OpenID終了につき今後はメンテしませんとのこと。
調べてみてわかったのですが、OpenID Connectというのは技術的にはOpenIDの後継ではなくOAuth2.0と同じもので、OAuthのライブラリがそのまま使えるということのようです。

上記システムではTwitterやFacebookのOAuth認証が実装されており、Opauthというライブラリを使用していました。これがそのまま使えそうです。
Opauth – Multi-provider authentication framework for PHP
http://opauth.org/

OpauthはCakePHPのプラグイン化もされていて、これを使って実装していました。
uzyn/cakephp-opauth ・ GitHub
https://github.com/uzyn/cakephp-opauth

Opauthには各サービス用のストラテジーと呼ばれるパッケージがあり、Googleの場合は以下を入れることで対応できます。
opauth/google ・ GitHub
https://github.com/opauth/google

今回やることとしては、上記のプラグイン達を使い、GoogleのOAuth認証を実装して、呼び出す際scopeパラメータにopenidを追加することで、OpenIDのユーザーIDを取得するという事のようです。
詳しくは公式のドキュメントに書かれています。
Migrating from OpenID 2.0 to OpenID Connect – Google Identity Platform – Google Developers
https://developers.google.com/identity/protocols/OpenID2Migration

通常、公式ドキュメントは実装するにあたって必要十分であり見るべきなのですが、必要以上の情報が含まれていて冗長であることも多いです。
なので時間が限られている時には、どなたかが実際に実装された時のメモを見てやったりします。今回もそういうのを探してみた所、以下の記事が参考になりました。
Google アカウントの認証を OpenID から OpenID Connect に移行する方法 – WebOS Goodies
http://webos-goodies.jp/archives/how_to_migrate_from_openid_to_openid_connect.html

作業の流れとしては以下のように進めていきました。
Google Developers Consoleにログインしてプロジェクトを作成。
https://console.developers.google.com/project
↓
適当なプロジェクト名とプロジェクトIDを入力。どちらも日本語は使えません。プロジェクトIDは自分で入力するか自動生成が可能。
↓
プロジェクトを作るとしばらくして画面が切り替わるので、APIと認証 → 認証情報 → 新しいクライアントIDを作成。
↓
ウェブアプリケーション（デフォルト）を選択し、同意画面を設定を押して必要事項を入力。
↓
サイトのURLとログイン後のリダイレクトURLを入力。これでOAuthに必要なクライアントIDとクライアントシークレットが生成されます。

ここからPHPソースの作業。
クライアントIDとクライアントシークレットをopauthに渡すようにします。

Configure::write('Opauth.Strategy.Google', array(
  'client_id' => 'YOUR CLIENT ID',
  'client_secret' => 'YOUR CLIENT SECRET'
));

次にログインさせるURLをOpenID時のものからOpauthを呼び出すように変更します。今回の例では以下のようになりました。
/openid_login?url=https://www.google.com/accounts/o8/id
という感じだったのが
/opauth/google
のように変更。

次はscopeにopenidを追加する作業ですが、今回は手っ取り早くGoogleStrategy.phpを書き換えました。
元は
'scope' => 'https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email'
だったのを
'scope' => 'openid profile email'
に変更。openidの他に元々あったprofile、emailもアカウント情報の取得のために必要です。
h という書き方だとGoogle+を有効にしていないユーザーが認証できなくなるらしいので、下の書き方にしました。

次に、パラメータにopenid.realmを追加します。が、ここで.と_を間違えたり://を%3A%2F%2Fと書いてはいけなかったりでしばらくはまりました。正解の書き方は
'openid.realm' => 'http://' . env( 'HTTP_HOST' )
でした。単に http://ドメイン で良いのですね。
ここは実際にアクセスするドメインと一致しないとログイン時エラーになります。クライアントIDを登録したドメインとも一致しないといけません。ちなみにエラー表示は親切ですぐ原因がわかるようになっていました。

ここまでやるとコールバック時にid_tokenが返ってくるようになりました。それを.（ピリオド）で分解してbase64_decodeすると
https://www.google.coc/accounts/o8/id?id=AItObwzwQrXIZrW8y_a7lSJzKXJFtgA0QHzXgTx
のような形でOpenIDのIDが取得できます。id=以降の文字列がこれまでのDBに保存されていたIDと同じなのでこれで照合・新IDに置換などしてやればいいことになります。

ちなみに、デコードするのにGoogleの関数を使うと有効性の検証も行ってくれるみたいですが手間の都合で今回はパスし、素のbase64_decodeを使いました。
google/google-api-php-client – GitHub
https://github.com/google/google-api-php-client
後日、これでも入れて試してみたいと思います。

今の所は以上の対応でOKですが、上記の方法でOpenIDのIDが取得できる機能も2017年に終了するそうです。なのでOpenIDでログインしていたユーザーは、それまでにサービスにログインする必要がありますね。

WordPress子テーマを作成し任意のphpをカスタマイズする方法

Posted on by Posted in tech

WordPressテーマをカスタマイズする際のメモです。

既存テーマのカスタマイズは子テーマを作成して行うと、元ファイルを一切いじらずに済み、テーマのバージョン更新時に変更が上書きされる心配などがなくなります。

子テーマの作成方法は簡単で、wp-content/themes以下に子テーマ用のフォルダを作成し、カスタマイズ用のstyle.cssを入れるだけです。これでテーマの一覧に子テーマが追加され選べるようになります。

子テーマのstyle.cssの中身はこんな感じになります。

/*
Theme Name:     twentyten_child
Template:       twentyten
*/

@import url('../twentyten/style.css');

/* 以下、カスタマイズ内容を書く */
コメント内の「Theme Name」「Template」は必須で、それぞれ子テーマ名・親テーマのフォルダ名を指定します。挙動上、子テーマのstyle.cssは親テーマのstyle.cssを上書きするので、@importで親テーマのstyle.cssをインポートすることで継承を行い、その後にカスタマイズしたい要素の記述をしていくのが良いようです。

style.cssのカスタマイズは以上です。他のテンプレートファイル(php)も基本的に同様で、子テーマに同名ファイルがあればそちらで上書きされた挙動をします。例えば子テーマフォルダにheader.phpやfooter.phpがあると、それらがヘッダやフッタに反映されます。ただしfunctions.phpだけは特別で、これは同名ファイルで上書きされず、子テーマのfunctions.php → 親テーマのfunctions.phpの順に両方読み込まれます。ここが本日の重要なポイントです。

さて、テーマによってはサブフォルダを持ちその中に独自のphpファイルが置かれている場合があります。これらも子テーマ側に同名のフォルダとファイルを置いておけば上書きされるのでしょうか。結論から言うと、多分されません。それらはテーマのphpファイルからインクルードされて使われますが、その際に大抵親フォルダのパスが記述されているからです。

それではそれらの中身をちょっとカスタマイズして置き換えたい場合はどうするのがベストでしょうか。長くなりましたが、これが本日の本題です。

この場合、基本的にやることは「親テーマの関数を無効化（remove）」し、「子テーマの関数を有効化（add）する」という対処になります。整理すると以下のような感じです。

  1. 変更したい親テーマの関数を子テーマのfunctions.phpにコピペする。
  2. コピペした関数の中身と関数名を変更し、別の関数とする。
  3. 親テーマの関数をremoveする。
  4. 子テーマの新関数をaddする。
例として、親テーマのphp内にtheme_layouts()関数が記述されており、この関数をカスタマイズしたいとしましょう。

まずはこの関数を丸ごと子テーマのfunctions.phpの下の方にでもコピペします。そして関数名を変更します。ここではtheme_layouts_child()とでもしておきましょう。そして中身を書き換えます。ちょっとしたカスタマイズなら大抵1行～数行程度の変更になるでしょう。大幅に書き換える場合は、バグの発生に注意しましょう。

次に親関数のremoveですが、子functions.phpは親functions.phpの直前に実行されるため、子functions.phpの実行時点では親の関数をremoveすることができません。そこで「親テーマの関数のremoveを行う関数を定義」し、「WordPressのinit時にremove関数が実行されるよう登録」することで目的を果たします。

テーマ用関数は大抵、宣言の前後にadd_actionの記述があり、これによって呼び出しが登録されているので、remove_actionを使ってadd_actionと逆のことを行います。例えばtheme_layouts()関数が以下のようにadd_actionされていたとします。
add_action('header','theme_layouts',3);
この場合、theme_layouts()をremoveするコードは以下のようになります。
// 親テーマの関数をremoveする関数
function remove_parent_theme_actions() {
    remove_action('header','theme_layouts',3);
}

// 上記の関数をWordPressのinitに登録
add_action('init','remove_parent_theme_actions');
remove_action()の引数は、親テーマのadd_action時と同じにしてください。3番目の引数は優先度で、add_action時に省略されている場合もあります。省略されていない場合は同じ値をremove_action時に指定します。

次に最初に作った子テーマの関数をaddします。これもadd_actionによって同じように行います。
add_action('header','theme_layouts_child', 3);
まとめると、子テーマのfunctions.phpは以下のようになります。
// 親テーマの関数をremoveする関数
function remove_parent_theme_actions() {
    remove_action('header','theme_layouts',3);
}

// 上記の関数をWordPressのinitに登録
add_action('init','remove_parent_theme_actions');

// カスタマイズした関数を有効化する
add_action('header','theme_layouts_child', 3);

// カスタマイズした関数
function theme_layoutsa_child(){
  // 関数の中身
}
以上の方法で、親テーマのファイルに一切手を加えることなく、theme_layouts()の挙動をtheme_layoutsa_child()で定義された内容に変えることができます。書き換える関数が複数あっても、やり方は同じです。

参考：
子テーマ – WordPress Codex 日本語版
http://wpdocs.sourceforge.jp/子テーマ

EC-CUBEでダウンロードしたcsvの電話番号から0が消える

Posted on by Posted in tech

EC-CUBEカスタマイズ案件を担当した時のメモ。

顧客一覧などを管理画面からcsvダウンロードしてExcelで開くと、電話番号や郵便番号の頭の0が表示されません。03-0123-0001が3-123-1のようになります。

これはEC-CUBEが悪いのではなくExcelの仕様のようです。csvファイルをテキストエディタで確認すると普通に0が入っていますが、Excelで開くと表示されません。

Excelでも0を表示するように開く方法はあり、普通に開くのではなく「データ」→「外部データの取り込み」→「データの取り込み」からファイルを指定し「テキストファイルウィザード」の3ページ目で電話番号のカラムを「文字列」に指定して開くと意図通りに表示されます。が、やってみるとわかりますが非常に面倒臭く、毎回このようにして開くのは大変です。

そこで対応策を調べて、EC-CUBE側をカスタマイズすることで対策しました。データをダブルクォーテーションで囲み、前にイコールをつけるとExcelが文字列として開いてくれるようです。具体的には、csv内の該当部分のデータが以下のようになります。

……,=”03″,=”0123″,=”0001″,……


EC-CUBE側の変更点は、SC_Helper_CSV.phpのsfArrayToCsv()関数です。終盤に、以下のように追加しました。

if (preg_match("/^0[0-9]+$/", $field )){
	$field = '=' . $enclosure . $field . $enclosure;
}
実際は別条件も足したりしていてちょっと違いますが、だいたいこんな感じです。

誰かの参考になれば幸いです。

CakePHPでupdateAllを使うとmodifiedを自動で更新してくれない

Posted on by Posted in tech

CakePHP（1.3系）で開発を行った時のメモです。小ネタです。

CakePHPのモデルにはupdateAllという関数があり、これを使うと1個もしくは複数のレコードを効率良くupdateできます。（これを知る前はいちいちfindしてsaveしてました。）

以下のような感じで使えます。

$this->updateAll( 
	array( 'project_id' => "'" . $projectId . "'" ), 
	array( 'user_id' => $userId )
);
user_idが一致したレコードのproject_idを更新する例です。データが文字列の場合は自分でクォートする必要があるので気をつけましょう。

ところが運用してみて数時間後、updateされたレコードのmodifiedカラムが更新されないことに気付きました。「？」と思ってぐぐってみると、そういう仕様のようです。

#910 updateAll does not update modified field – CakePHP – cakephp
http://cakephp.lighthouseapp.com/projects/42648/tickets/910-updateall-does-not-update-modified-field

updateAllは単純にupdate文を指定通りに発行するだけのようですね。そうと知って早速以下のように対処しました。
$this->updateAll( 
	array( 
		'project_id' => "'" . $projectId . "'", 
		'modified' => "'" . date('Y-m-d H:i:s') . "'"
	), 
	array( 'user_id' => $userId )
);
これでmodifiedカラムに更新日時が入るようになりました。

ちなみにupdateAllは渡されたデータでそのままupdate文を発行するので、事前にサニタイズ等を施した安全なデータを渡すようにしましょう。さもないとSQLインジェクションなどができてしまう可能性があります。

ある日突然Sambaでシンボリックリンクフォルダが辿れなくなった

Posted on by Posted in tech

社内ファイルサーバーで、突然複数のフォルダにアクセスできなくなる事態が起こりましたので解決策のメモ。

アクセスできなくなったフォルダは全て、サーバー側でシンボリックリンクで参照しているフォルダでした。おそらくSambaが自動アップデートされて、仕様が変わってしまったのでしょう。

解決策はぐぐると割とすぐに見つかりました。
/etc/samba/smb.confの[global]セクションに以下を追加しました。

unix extensions = no
wide links = yes

これでSambaを再起動すると、無事アクセスできるようになりました。
以下を参考にしました。ありがとうございます。

Sambaのアクセスできないフォルダへの対処法。（Symbolic link問題、Samba脆弱性対策） – ブックマクロ開発に
http://d.hatena.ne.jp/takuya_1st/20100509/1273424397