Component」カテゴリーアーカイブ

PHP 二重送信防止処理(サーバー側)

サーバ側での二重送信防止

前にも二重送信防止のことを書きました。
jQueryでの二重送信防止

前の二重送信の防止はjQueryで制御していました。

つまり、クライアント側で送信防止をしていたのです。

でももしかすると、javascriptが有効になっていない場合だってあるかもしれません。

そんなときに、Enterキーを

ケンシロウ並に連打!!!されたら、ひとたまりもありません。

不必要なデータがたくさん登録されてしまいます。。。

そんなときは、サーバ側で防止するしかありません。

サーバー側での二重送信防止のイメージ

二重送信防止

流れは以下の感じです。

  • 最初にランダムなトークン(適当な文字列)を生成
  • sessionとhtmlのhidden属性に保存する
  • 送信したいデータとともに、hidden属性に設定したトークンをPOSTする
  • POSTされてきたトークンとsessionに保存していたトークンとを比較
  • 同じであれば登録しsessionのトークン情報を破棄、違っていれば、エラー処理

二重送信防止

CakePHPで実装

app/controllers/main_controller.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
function doublesubmit(){
    if(!empty($this->data)){
        // Tokenの比較
        if($this->Session->read('dstoken') == $this->data['Example']['dstoken']){
            unset($this->data['Example']['dstoken']);
            $this->Session->delete('dstoken');
            if($this->Example->save($this->data)){
                $this->flash('おーけーです', array('controller'=>'main', 'action' => 'doublesubmit') ,5);
            }else{
                $this->flash('えぬじーです', array('controller'=>'main', 'action' => 'doublesubmit'), 5);
            }
        }else{
            $this->flash('すでに送信済みです', array('controller'=>'main', 'action' => 'doublesubmit'), 5);
        }
    }
 
    // Tokenの発行&Sessionに保持
    $dstoken = $this->_rand(12); //ランダムな文字列を生成する関数用意
    $this->Session->write('dstoken', $dstoken);
    $this->data['Example']['dstoken'] = $dstoken;
}

app/views/main/doublesubmit.ctp

1
2
3
4
5
6
7
8
9
<h1>二重送信防止</h1>
<?php
    echo $form->create('Example', array('url' => array('controller' => 'main', 'action' => 'doublesubmit')));
    echo $form->input('title', array('type' => 'text'));
    echo $form->input('place', array('type' => 'text'));
    echo $form->input('dstoken', array('type' => 'hidden'));
    echo $form->submit('送信');
    echo $form->end();
?>

ランダムな文字列の生成は下記のサイトのコードを使用させてもらいました。

てくめも

コンポーネント化?

CakePHPだとSecurityComponentを使えばいいという情報を見つけたが、
せっかくなので自分でコンポーネント化してみることにした。

※まだ動作確認はあまりしていません。。。
app/controllers/components/prevent_double_submit.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?php
/************************************************
 * PreventDoubleSubmitComponent
 *      二重送信を防止する
 * Usage
 * Controller:
 *      $conponentsに追加。$doublesubmitsにオプションの設定をする。
 * View:
 *      $this->Form->input('Token.token', array('type' => 'hidden'));を追記する。
 *
 ************************************************/
class PreventDoubleSubmitComponent extends Object{
 
    public $controller = null;
    public $components = array(
        'Session',
    );
    /**
     * @var
     * model:string     モデル名
     * token:string     view側のhidden属性に設定するfield名
     * auto:bool        自動でtokenの設定&二重送信のチェックをする(true)かどうか
     * url:array        デフォルトは現在のアクセスパス
     * message:string   setFlashに設定する文字列
     */
    public $option = array(
        'model' => 'Token',
        'token' => 'token',
        'auto' => true,
        'url' => array(),
        'message' => null,
        'token_length' => 10,
    );
 
    //===============================================
    // コールバックメソッド
    //===============================================
    function initialize(&$controller){
        $this->controller = &$controller;
        if(isset($this->controller->doublesubmits)){
            $this->option = am($this->option, $this->controller->doublesubmits);
        }
    }
 
    function startup(&$controller){
        if(!empty($this->controller->data)){
            extract($this->option);
            if($this->option['auto']){
                if($this->isDoubleSubmit()){
                    if(!empty($message)){
                        $this->Session->setFlash($message);
                    }
                    $u  = array(
                        'controller' => $this->controller->params['controller'],
                        'action' => $this->controller->params['action'],
                        $this->controller->params['pass'],
                    );
                    if(!empty($url)){
                        $u = am($u, $url);
                    }
                    unset($this->controller->data);
                    $this->controller->redirect($u);
                }else{
                    $this->Session->delete($token);
                    unset($this->controller->data[$model][$token]);
                }
            }
        }
    }
    function beforeRender(&$controller){
        if($this->option['auto']){
            $this->setToken();
        }
    }
 
    //===============================================
    // メソッド
    //===============================================
    /**
     * トークンを生成しセットする
     * @return
     */
    function setToken(){
        extract($this->option);
        $t = $this->rand($token_length);
        $this->Session->write($token, $t);
        $this->controller->data[$model][$token] = $t;
    }
 
    /**
     * 二重送信のチェック
     * @return bool
     */
    function isDoubleSubmit(){
        $ret = false;
        extract($this->option);
        if(isset($this->controller->data[$model][$token])){
            if($this->Session->read($token) != $this->controller->data[$model][$token]){
                $ret = true;
            }
        }
        return $ret;
    }
 
    /**
     * ランダムな文字列を生成する
     * @param object $length [optional]
     * @return string ランダムな文字列
     */
    function rand($length = 8){
        $char = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_";
        mt_srand();
        $ret = "";
        for($i = 0; $i < $length; $i++){
            $ret .= $char{mt_rand(0, strlen($char) - 1)};
        }
        return $ret;
    }
}
?>

【追記 start 2011/04/26】==================================
2重送信のアクセスがときどきあるので、
PreventWSubmitComponentを更新してみました。
修正したものはこちらです。

※CakePHP2.xではセキュリティコンポーネントを使って2重送信の防止ができるのでそちらを利用したほうがいいかもしれません。
【追記 end 2011/04/26】==================================

CakePHP Twitter連携 OAuthConsumerを使ってみた

完成イメージ

Twitterへの投稿を 

    $this->Twitter->tweet(“つぶやくぞ”); 

という具合に実行できるようにする。 

準備

Basic認証での投稿はできなくなるらしいので、OAuth認証によるツイートが出来るようにする。 

すでにOAuth認証による投稿ができるクラスとComponentを作っている人がいるので、それを利用する。 

参考にしたサイトではClassを使っていたので、ここではComponentを使ってみる。 

また、ここで作成するものは、ACCESS TOKENを直接WEBページから取得するので、個人的な利用の場合のみ使用可能。 

OAuthConsumerComponetをダウンロード
http://code.42dh.com/oauth/ 

参考にしたサイト: http://www.zontheworld.com/blog/archives/119 

概要

  1. Twitterのアカウントから必要な情報を取得する。
  2. DLしたOAuthConsumerComponentの設定。
  3. TwitterComponentの作成。
  4. ツイート!

Twitterの設定

アプリの登録

ツイッターにログインし 

http://twitter.com/apps 

にアクセス。参考サイトと同様にして、アプリの登録を済ませる。 

必要情報の取得 (TOKEN)

Consumer Key & Consumer Secret

登録したアプリケーションの詳細から取得。 

Access Token & Access Token Secret

http://dev.twitter.com/apps/にアクセス。 

登録したアプリの詳細をみる。 

My Access Tokenをクリック。 

CakePHP の処理

OAuthConsumerComponentの設定

DLしたものを展開して、 

controllers/componetsを自分のcontrollers/componetsに配置。 

vendors/OAuthを app/vendorsに配置。
 

1
2
3
4
5
// 取得したToken等をapp/config/bootstrap.phpに追記
define('TWITTER_CONSUMER_KEY', '**************');
define('TWITTER_CONSUMER_SECRET', '**************');
define('TWITTER_ACCESS_TOKEN', '**************');
define('TWITTER_ACCESS_TOKEN_SECRET', '**************');

 

1
2
3
4
5
6
// app/controllers/components/oauth_consumers/twitter_consumer.php
class TwitterConsumer extends AbstractConsumer {
    public function __construct() {
        parent::__construct(TWITTER_CONSUMER_KEY, TWITTER_CONSUMER_SECRET);
    }
}

 TwitterComponentの作成

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// app/components/twitter.php
<?php
class TwitterComponent extends Object { 
 // Oauth認証を使うためのコンポーネント
 public $components = array('OauthConsumer'); 
 
 /**
  * ツイートする
  * @param string $tweet ツイートする内容
  * @return
  */
 function tweet($tweet){
  $tw = $this->OauthConsumer->post(
    'Twitter',
    TWITTER_ACCESS_TOKEN,
    TWITTER_ACCESS_TOKEN_SECRET,
    array('status' => $tweet)
   );
  return $tw;
 }
}
?>

TwitterComponentの使い方

1
2
3
4
5
6
7
8
9
class HogeController extends AppController{
    public $name = 'Hoge';
    public $components = array('Twitter');
 
    function example(){
        $message = "hogedehogesuru";
        $this->Twitter->tweet($message);
    }
}