LANCARD.LAB｜ランカードコムのスタッフブログ

Roundcubeでフックを設置する方法を紹介します。

今回はsample_aプラグインにフックを設置し、それをsample_bから利用する例です。
sample_aは画面をもったプラグインでボタンをクリックしたら、フックを実行し
元の画面を再度表示するようにしています。

ソースは以下のようになります。
sample_a.php

rc = rcmail::get_instance();

//ローカライズ対応
$this->add_texts('localization/');

//タスクとしてsample_aを設定
$this->register_task('sample_a');

//タスクバーにボタンを追加
$this->add_button(array(
'command'    => 'sample_a',
'label'      => 'sample_a.sample',
), 'taskbar');

//sampleタスクの場合のみ、アクションのコールバックを登録
if($this->rc->task == 'sample_a'){
$this->register_action('index', array($this, 'action'));
$this->register_action('fook_test', array($this, 'action'));
}
}

public function action(){
if($this->rc->action === 'fook_test'){
$data = $this->rc->plugins->exec_hook('sample_hook', array('data_a' => 'hoge'));
error_log(print_r($data,true));
}
$this->rc->output->send('sample_a.index');
}
}
?>

index.html

sample_b.php

add_hook('sample_hook', array($this, 'set_data'));
}

public function set_data($args){
error_log(print_r($args,true));
$data['data_b'] = "foo";
return $data;
}
}
?>

①フックを設置するコードは以下の部分になります。

$data = $this->rc->plugins->exec_hook('sample_hook', array('data_a' => 'hoge'));

引数として配列を渡しています。

②フックを利用するコードは以下の部分になります。

function init(){
$this->add_hook('sample_hook', array($this, 'set_data'));
}

public function set_data($args){
error_log(print_r($args,true));
$data['data_b'] = "foo";
return $data;
}

このような配列が渡されてきます。
(
　　[data_a] => hoge
　　[abort] =>
)

渡された引数を処理して戻り値を返したりすることが出来ます。
戻り値はこのようになります。
(
　　[data_b] => foo
　　[data_a] => hoge
　　[abort] =>
)

exec_hookの定義が以下のようになっているため、戻り値が配列の場合は自動的に
渡された配列に足して返されます。

  public function exec_hook($hook, $args = array())
  {
    if (!is_array($args))
      $args = array('arg' => $args);

    $args += array('abort' => false);
    $this->active_hook = $hook;

    foreach ((array)$this->handlers[$hook] as $callback) {
      $ret = call_user_func($callback, $args);
      if ($ret && is_array($ret))
        $args = $ret + $args;

      if ($args['abort'])
        break;
    }

    $this->active_hook = false;
    return $args;
  }

Roundcubeでのユーザー情報の取得方法について紹介します。

①ユーザー情報
ユーザー情報の取得方法は以下のようになります。

$rc = rcmail::get_instance();
$user_data = $rc->user->data;
error_log(print_r($user_data,true));

このような情報が取得できます。

(
    [user_id] => 4
    [username] => foo
    [mail_host] => 192.168.15.117
    [alias] => 
    [created] => 2013-04-11 10:14:23
    [last_login] => 2013-05-17 07:45:24
    [language] => ja_JP
    [preferences] => a:5:{s:16:"message_sort_col";s:7:"subject";s:18:"message_sort_order";s:3:"ASC";s:8:"timezone";s:4:"auto";s:4:"skin";s:5:"larry";s:17:"message_threading";a:0:{}}
)

②識別情報
Roundcubeでは設定画面から識別情報を登録出来ます。

以下のようにして識別情報を取得出来ます。

$rc = rcmail::get_instance();
$identity = $rc->user->get_identity();
error_log(print_r($identity,true));

(
    [identity_id] => 4
    [user_id] => 4
    [changed] => 2013-05-17 12:28:06
    [del] => 0
    [standard] => 1
    [name] => テスト
    [organization] => bar
    [email] => foo@roundcube.com
    [reply-to] => hoge@roundcube.com
    [bcc] => test@roundcube.com
    [signature] => 署名
    [html_signature] => 0
)

③特定のユーザーの情報を取得する方法。

$rc = rcmail::get_instance();
$identity = $rc->user->get_identity();

上記のようにユーザー情報を取得する場合、ログインユーザーの情報を取得します。

その理由は、rcmailクラスの188行目が以下のようになっているからです。

    // create user object
    $this->set_user(new rcube_user($_SESSION['user_id']));

ということで、Roundcubeのuser_idがわかれば、rcube_userクラスをインスタンス化し
ユーザー情報やユーザーの識別情報を取得出来ます。

例えば、次のようになります。

$user_id = 4;
$user = new rcube_user($user_id);
$user_data = $user->data;
$user_identity = $user->get_identity();
error_log(print_r($user_data,true));
error_log(print_r($user_identity,true));

RoudcubeプラグインでAjaxする方法を紹介します。

サーバ側：

rc = rcmail::get_instance();

$this->add_texts('localization/');
$this->register_task('ajax_sample');

if($this->rc->task == 'ajax_sample'){
$this->register_action('index', array($this, 'action'));
$this->register_action('get_data', array($this, 'action'));
}else{
$this->add_button(array(
'command' => 'ajax_sample',
'label' => 'ajax_sample.title'
), 'taskbar');
}
}

public function action(){
//画面表示
if($this->rc->action === 'index'){

$this->include_script('ajax_sample.js');
$this->rc->output->send('ajax_sample.ajax_sample');

//ajax
}else if($this->rc->action === 'get_data'){

error_log(get_input_value('data', RCUBE_INPUT_POST));
$this->rc->output->command('plugin.get_data', array('data' => 'test'));

}
}

}

クライアント側：

var get_data_call_back = function(response){
console.log(response.data);
}

if (window.rcmail) {
rcmail.addEventListener('init', function() {
rcmail.addEventListener('plugin.get_data', get_data_call_back);
rcmail.enable_command('get_data', true);
});
}

rcube_webmail.prototype.get_data = function()
{
rcmail.http_post('get_data',{"data":'test'});
}

①コールバックの登録
　　クライアント側のrcmail.addEventListener(‘plugin.get_data’, get_data_call_back);の
　　第一引数と
　　サーバ側の$this->rc->output->command(‘plugin.get_data’, array(‘data’ => ‘test’));の
　　第一引数を
　　一致させる必要があります。

　　この際に’plugin.’という文字を前につける必要があります。
　　なぜなら/roundcuberoot/program/include/rcube_json_output.phpの
　　141行目が次のようになっています。

    public function command()
    {
        $cmd = func_get_args();

        if (strpos($cmd[0], 'plugin.') === 0)
          $this->callbacks[] = $cmd;
        else
          $this->commands[] = $cmd;
    }

　　ここでcallbacksに登録されないため

　　/roundcuberoot/program/js/app.src.jsの6041行目

    // execute callback functions of plugins
    if (response.callbacks && response.callbacks.length) {
      for (var i=0; i < response.callbacks.length; i++)
        this.triggerEvent(response.callbacks[i][0], response.callbacks[i][1]);
    }

　　この部分のコールバックとして実行されません。

②ポストするデータ
　　rcmail.http_post('get_data',{"data":'test'});の第二引数で指定します。

③サーバから返すデータ
　　$this->rc->output->command('plugin.get_data', array('data' => 'test'));の第二引数で指定します。

Roundcubeのボタンの使い方を紹介します。

①テンプレートへの設置方法は以下のようになります。

このように書いておくと、次のように出力されます。

②イベントをどう処理するか？

このように書きます。

if (window.rcmail) {
rcmail.addEventListener('init', function() {
rcmail.enable_command('get_data', true);
});
}

rcube_webmail.prototype.get_data = function()
{
console.log('get_data');
}

③rcmail.enable_command(‘get_data’, true);の
　最後の引数でそのボタンを有効にするか無効にするか指定します。
　　試しに２つのボタンを設置してみます。

デフォルトではどちらも無効になります。

次のようにjavascriptを記述します。

if (window.rcmail) {
rcmail.addEventListener('init', function() {
rcmail.enable_command('btn1', true);
rcmail.enable_command('btn2', false);
});
}
rcube_webmail.prototype.btn1 = function()
{
console.log('btn1');
}
rcube_webmail.prototype.btn2 = function()
{
console.log('btn2');
}

ボタンは２つとも見かけ上有効になります。
しかし、ボタン１をクリックするとコンソールに’btn1’が表示されますが、ボタン２をクリックしても何も起こりません。

④引数を渡すにはどうするか。

prop属性を指定します。
このように書くと

次のように出力してくれます。

　　rcmail.command(‘btn1′,’test’,this)この部分の第二引数にpropで指定した値が入ってきます。

　　javascript側では第一引数で取得します。

rcube_webmail.prototype.btn1 = function(value)
{
console.log(value);
}

上記のように記述するとコンソールに’test’と表示されます。

⑤複数の引数を指定出来るか。

ボタンのclick処理を出力するのは
/roundcuberoot/program/include/rcube_template.phpの978行目の以下のコードになります。

$attrib['onclick'] = sprintf(
"return %s.command('%s','%s',this)",
JS_OBJECT_NAME,
$command,
$attrib['prop']
);

上記のコードの通り、複数の引数を指定することは無理そうですね・・。

①プラグインは roundcuberoot/plugins配下に作成します。
　（既にたくさん入っているようです。）

②作成したディレクトリ名と同じ名前のphpファイルを作成します。

③②で作成したphpファイルと同じ名前のクラス名にします。
④作成したクラスはrcube_pluginクラスを継承しなければなりません。

⑤プラグインクラス(/roundcuberoot/program/include/rcube_plugin.php)の

　抽象メソッドであるinitメソッドをオーバーライドします。
abstract function init();

　initメソッドは必須になります。
　プラグインAPIクラス(/roundcuberoot/program/include/rcube_plugin_api.php)は、

　プラグインオブジェクトをインスタンス化し、initメソッドを呼び出します。

これで何にもしないプラグインは出来上がりです。
⑥でも、これだと出来たかどうかわからないのでタスクバーにボタンを追加します。
add_texts('localization/');
        
        $this->add_button(array(
                'command'    => 'sample',
                'label'      => 'sample.sample',
        ), 'taskbar');
    }
}

⑦ja_JP.incファイル

以下のように配置します。


⑧最後に/roundcuberoot/config/main.inc.phpに

　プラグインを登録します。
$rcmail_config['plugins'] = array('sample');

これでサンプルメニューのプラグインの出来上がりです。