wtrmln/modules/models/model_tempkeys.php

   1 <?php
   2 /********************************************************************
   3
   4   Watermelon CMS
   5
   6 Copyright 2008-2009 Radosław Pietruszewski
   7
   8 This program is free software; you can redistribute it and/or
   9 modify it under the terms of the GNU General Public License
  10 version 2 as published by the Free Software Foundation.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20
  21 ********************************************************************/
  22
  23 class Model_TempKeys extends Model
  24 {
  25    /*
  26     * public string[2] MakeKey(string $comment[, uint $time])
  27     *
  28     * tworzy losowy klucz z komentarzem $comment,
  29     * zapisuje go w bazie i zwraca użytkownikowi.
  30     * Taki klucz ma żywotność 5 minut, lub wygasa
  31     * $time + 5 minut, gdy $time jest podane
  32     *
  33     * zwraca: array(string $key, string $value)
  34     * przy czym $key jest to klucz zapisany w bazie
  35     * danych, a $value to wartość przypisana do tego klucza
  36     *
  37     * string $comment - komentarz do klucza
  38     * uint   $time    - timestamp żywotności klucza. gdy
  39     *                   podany, klucz wygaśnie 300 sekund
  40     *                   później niż $time
  41     *
  42     * przykład użycia:
  43     *
  44     * $this->TempKeys = $this->load->model('tempkeys');
  45     * list($key, $value) = $this->TempKeys->MakeKey('komentarz');
  46     */
  47
  48    public function MakeKey($comment, $time = null)
  49    {
  50       // generujemy losowy, ośmioznakowy klucz oraz wartość tego klucza
  51
  52       $key = substr(strHash(uniqid(mt_rand(), true)), 0, 8);
  53       $value = substr(strHash(uniqid(mt_rand(), true)), 0, 8);
  54       $comment = mysql_real_escape_string($comment);
  55
  56       // ustawiamy czas utworzenia
  57
  58       if($time === null)
  59       {
  60          $time = time();
  61       }
  62
  63       // zapisujemy klucz w bazie
  64
  65       $this->db->query("INSERT INTO `__temporary_keys` (`key`, `value`, `created`, `comment`) VALUES ('%1', '%2', '%3', '%4')", $key, $value, $time, $comment);
  66
  67       // usuwamy stare klucze
  68
  69       $this->DeleteOldKeys();
  70
  71       return array($key, $value);
  72    }
  73
  74    /*
  75     * public object GetKey(string $key)
  76     *
  77     * pobiera dane klucza tymczasowego o identyfikatorze $key
  78     * zwraca dane tego klucza, jeśli istnieje, lub false
  79     * gdy nie istnieje.
  80     */
  81
  82    public function GetKey($key)
  83    {
  84       $key = mysql_real_escape_string($key);
  85
  86       // pobieramy dane danego klucza
  87
  88       $keyData = $this->db->query("SELECT * FROM `__temporary_keys` WHERE `key` = '%1'", $key);
  89
  90       // jesli ten klucz nie istnieje
  91
  92       if($keyData->num_rows() == 0)
  93       {
  94          return false;
  95       }
  96
  97       // jeśli natomiast istnieje
  98
  99       return $keyData->to_obj();
 100    }
 101
 102    /*
 103     * public bool CheckKey(string $key, string $value, string $comment)
 104     *
 105     * sprawdza, czy klucz jest prawdziwy (czy istnieje, czy wartość się
 106     * zgadza z tą w bazie danych oraz czy komentarz się zgadza z tym w
 107     * bazie danych).
 108     *
 109     * zwraca true, jeśli klucz istnieje, false gdy jest fałszywy (nie
 110     * istnieje, wartość jest zła, lub komentarz jest zły)
 111     *
 112     * string $key     - klucz, którego prawdziwość ma zostać potwierdzona
 113     * string $value   - wartość, która ma zostać porównana z tą w bazie danych
 114     * string $comment - komentarz, który ma zostać porównany z tym w bazie danych
 115     *
 116     * przykład użycia:
 117     *
 118     * $this->TempKeys = $this->load->model('tempkeys');
 119     * if(!$this->TempKeys->CheckKey($key, $value, $comment))
 120     * {
 121     *    echo $this->load->view('error');
 122     *    return;
 123     * }
 124     */
 125
 126    public function CheckKey($key, $value, $comment)
 127    {
 128       // pobieramy dane
 129
 130       $data = $this->GetKey($key);
 131
 132       // sprawdzamy, czy takowy istnieje
 133
 134       if(!$data)
 135       {
 136          return false;
 137       }
 138
 139       // sprawdzamy czy wartości się zgadzają
 140
 141       if($value != $data->value)
 142       {
 143          return false;
 144       }
 145
 146       // sprawdzamy czy komentarze pasują do siebie
 147
 148       if($comment != $data->comment)
 149       {
 150          return false;
 151       }
 152
 153       // skoro wszystko się zgadza to usuwamy klucz
 154
 155       $this->DeleteKey($key);
 156
 157       return true;
 158    }
 159
 160    /*
 161     * public void DeleteKey(string $key)
 162     *
 163     * usuwa klucz tymczasowy o identyfikatorze $key
 164     */
 165
 166    public function DeleteKey($key)
 167    {
 168       $key = mysql_real_escape_string($key);
 169
 170       $this->db->query("DELETE FROM `__temporary_keys` WHERE `key` = '%1'", $key);
 171    }
 172
 173    /*
 174     * private void DeleteOldKeys()
 175     *
 176     * usuwa klucze, które zostały stworzone dawniej, niż 5 minut temu.
 177     * Ma to zapobiec nadmiernemu rozrastaniu się tabeli
 178     */
 179
 180    private function DeleteOldKeys()
 181    {
 182       $this->db->query("DELETE FROM `__temporary_keys` WHERE `created` < '%1'", time() - 300);
 183    }
 184 }
 185 ?>