CakePHP Shells内でAuth Componentを使ってUserを追加

前回のブログでCakePHP Shellを作成しましたが、そのシェルの中でAuth Componentを利用する際にはまったので書いて見ます。

ご存知、Componentを読み込む場合はコントローラーのメンバ変数として

	var $components = array('Auth');

のように書くだけですが、Shellの場合はこうやってもComponentを読み込んでくれません。

Shellでコンポーネントを利用する場合は以下のように関数内で呼び出してやることで解決できました。

function main(){
    App::import('Component','Auth'); 
    $this->Auth = new AuthComponent(null); 

}

さて、なぜAuth ComponentをShell内で使いたかったかというと、自分の場合、Auth->password() 関数を利用してパスワードをハッシュさせた後、ユーザーを追加したかったからです。

以下、Shell内でのユーザー作成に使ったコードです。

$username = [NEW_USERNAME];
$password = $this->Auth->password([NEW_PASSWORD]);

$retData = $this->User->findByUsername($username);
if(empty($retData['User']) ){
    $data = array("User" => array(
                           "username" => $username,
                           "password" => $password,
                           )
                       );
    $this->User->save($data);
}

最後に、以下参考になったサイトです。

Cookbook 認証 - http://book.cakephp.org/ja/view/172/%E8%AA%8D%E8%A8%BC

CakePHP: Creating a Custom Shell for Adding Users for Use With AuthComponent - http://www.springenwerk.com/2008/07/cakephp-creating-custom-shell-for.html

by ktatsuki

CakePHP Shellsを使ってスクリプトをDreamhost上のCron Jobsで動かす方法

今回は、CakePHPを使って自作プログラムをCron Jobで動かす方法について書きます。 今回はサーバーにDreamhostを使ったのでDreamhostでCron Jobを動かす特有の方法も説明していきます。

まず、CakePHPでコマンドラインスクリプトを書く必要がありますが、CakePHPではShellという機能を使って簡単に実現することができます。

作成手順はCakePHPのリファレンス Cookbook (http://book.cakephp.org/#!/view/1106/The-CakePHP-Console) にある通りです。

まず最初にShellクラスを継承したクラスファイルを自分のAppフォルダの中 (CAKEPHP/myapp/vendors/shells/)の中に作成します。
自分はTwitter.phpというクラスファイルを作成、以下のようにつくりました。

class TwitterShell extends Shell {

  function main() {
      $this->out("TEST Task Run! n");

  }

}

これだけです。超シンプル！

では早速これをまずマニュアルで実行してみます。

SSHでDreamhostにログイン後、以下のようにコマンドを実行します。

/home/YOUR_ACCOUNT/DOMAIN.COM/cake/console/cake -app /home/YOUR_ACCOUNT/DOMAIN.COM/myapp/ twitter

ここで -appパラメータを使ってフルパスで自分のアプリケーションフォルダ（この場合myapp）をしてやらないと、CakePHPは常にappフォルダをみに行ってしまいます。

上手くいけば、

Welcome to CakePHP v1.3.7 Console
---------------------------------------------------------------
App : myapp
Path: /home/YOUR_ACCOUNT/DOMAIN.COM/myapp
---------------------------------------------------------------
TEST Task Run!

のように表示されます。

プログラムが正常に動くことを確認出来たので、次にDreamhostからCronjobに登録します。

Dreamhostのコントロールパネルにログイン後、「Goodies」の中の「Cron Jobs」を選択します。

「Add New Cron Job」ボタンをクリックしてCommand to runフィールドに先ほどの

/home/YOUR_ACCOUNT/DOMAIN.COM/cake/console/cake -app /home/YOUR_ACCOUNT/DOMAIN.COM/myapp/ twitter

を入力します。

最初は実行確認のために、Email output toフィールドにEmailを記入しておくことをお薦めします。

Cron Jobエントリーを保存して後は実行されるのを待つばかり、、、と思いきや、残念ながらDreamhostではさらにすこしばかり変更を加えてやらないと上手くスクリプトが走りません。

実際、問題は実行結果をEmailで受け取るとわかるのですが、

/home/YOUR_ACCOUNT/DOMAIN.COM/cake/console/cake: line 24: exec: php: not found

のようにエラーが帰ってきてしまいます。

これは/cake/console/cakeファイルがphpコマンドを実行できないというエラーなので、Dreamhost用にcakeファイルを以下のように書き換えてやる必要があります。

まず、一行目の

LIB=${0/%cake/}
APP='pwd'

の下に

TERM=linux
export TERM

を追加しておきます。これは必須ではないようですが、追加しておくことでサーバーメンテナンス等でエラーが起きたときに助けになるようです。

次に

exec php -q ${LIB}cake.php -working "${APP}" "$@"

のラインを

exec /usr/local/php5/bin/php -q ${LIB}cake.php -working "${APP}" "$@"

のように書き換えます。 これはphp5コマンドを明示的に呼び出しています。

以上で、Cron Jobのスクリプトが正常に実行されました。

余談ですが、DreamhostのCron Jobは最短で10分間隔でしか実行できないみたいです。 何個もCron Jobを登録したらもっと短い間隔で実行できるかもしれませんが、試してません。

これで、自分は今流行(？)のOAuthを使ったTwitter BOTの作成をしてみたのですが、それはまた次回のブログで説明するようにします。

最後に、

参考になったサイト

CakePHP Shells, and Cron Jobs -  http://www.utoxin.name/2009/07/cakephp-shells-and-cron-jobs/

Running a cakePHP shell script as cronjob on Dreamhost - http://www.pixelastic.com/blog/242:running-cakephp-shell-script-cronjob-dreamhost

Setting up cron jobs with Cake shells - http://planetcakephp.org/aggregator/items/4632-setting-up-cron-jobs-with-cake-shells

by ktatsuki