-
Notifications
You must be signed in to change notification settings - Fork 719
/
tokens_api.php
280 lines (232 loc) · 7.67 KB
/
tokens_api.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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<?php
# MantisBT - a php based bugtracking system
# MantisBT is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# MantisBT is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with MantisBT. If not, see <http://www.gnu.org/licenses/>.
/**
* This implements temporary storage of strings.
* DB schema: id, type, owner, timestamp, value
*
* @package CoreAPI
* @subpackage TokensAPI
* @copyright Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright (C) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*/
# Set up global for token_purge_expired_once()
$g_tokens_purged = false;
/**
* Check if a token exists.
* @param integer Token ID
* @return boolean True if token exists
*/
function token_exists( $p_token_id ) {
$c_token_id = db_prepare_int( $p_token_id );
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
$t_query = "SELECT id
FROM $t_tokens_table
WHERE id=" . db_param();
$t_result = db_query_bound( $t_query, Array( $c_token_id ), 1 );
return( 1 == db_num_rows( $t_result ) );
}
/**
* Make sure a token exists.
* @param integer Token ID
* @return boolean True if token exists
*/
function token_ensure_exists( $p_token_id ) {
if( !token_exists( $p_token_id ) ) {
trigger_error( ERROR_TOKEN_NOT_FOUND, ERROR );
}
return true;
}
# High-level CRUD Usage
/**
* Get a token's information
* @param integer Token type
* @param integer User ID
* @return array Token row
*/
function token_get( $p_type, $p_user_id = null ) {
token_purge_expired_once();
$c_type = db_prepare_int( $p_type );
$c_user_id = db_prepare_int( $p_user_id == null ? auth_get_current_user_id() : $p_user_id );
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
$t_query = "SELECT * FROM $t_tokens_table
WHERE type=" . db_param() . " AND owner=" . db_param();
$t_result = db_query_bound( $t_query, Array( $c_type, $c_user_id ) );
if( db_num_rows( $t_result ) > 0 ) {
return db_fetch_array( $t_result );
}
return null;
}
/**
* Get a token's value or null if not found
* @param integer Token type
* @param integer User ID (null for current user)
* @return array Token row
*/
function token_get_value( $p_type, $p_user_id = null ) {
$t_token = token_get( $p_type, $p_user_id );
if( null !== $t_token ) {
return $t_token['value'];
}
return null;
}
/**
* Create or update a token's value and expiration
* @param integer Token type
* @param string Token value
* @param integer Token expiration in seconds
* @param integer User ID
* @return integer Token ID
*/
function token_set( $p_type, $p_value, $p_expiry = TOKEN_EXPIRY, $p_user_id = null ) {
$t_token = token_get( $p_type, $p_user_id );
if( $t_token === null ) {
return token_create( $p_type, $p_value, $p_expiry, $p_user_id );
}
token_update( $t_token['id'], $p_value, $p_expiry );
return $t_token['id'];
}
/**
* Touch a token to update its expiration time.
* @param integer Token ID
* @param integer Token expiration in seconds
* @return always true
*/
function token_touch( $p_token_id, $p_expiry = TOKEN_EXPIRY ) {
token_ensure_exists( $p_token_id );
$c_token_id = db_prepare_int( $p_token_id );
$c_token_expiry = time() + $p_expiry;
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
$t_query = "UPDATE $t_tokens_table
SET expiry=" . db_param() . "
WHERE id=" . db_param();
db_query_bound( $t_query, Array( $c_token_expiry, $c_token_id ) );
return true;
}
/**
* Delete a token.
* @param integer Token type
* @param integer User ID or null for current logged in user.
* @return always true
*/
function token_delete( $p_type, $p_user_id = null ) {
$c_type = db_prepare_int( $p_type );
$c_user_id = db_prepare_int( $p_user_id == null ? auth_get_current_user_id() : $p_user_id );
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
$t_query = "DELETE FROM $t_tokens_table
WHERE type=" . db_param() . " AND owner=" . db_param();
db_query_bound( $t_query, Array( $c_type, $c_user_id ) );
return true;
}
/**
* Delete all tokens owned by a specified user.
* @param integer User ID or null for current logged in user.
* @return always true
*/
function token_delete_by_owner( $p_user_id = null ) {
if( $p_user_id == null ) {
$c_user_id = auth_get_current_user_id();
} else {
$c_user_id = db_prepare_int( $p_user_id );
}
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
# Remove
$t_query = "DELETE FROM $t_tokens_table
WHERE owner=" . db_param();
db_query_bound( $t_query, Array( $c_user_id ) );
return true;
}
# Low-level CRUD, not for general use
/**
* Create a token.
* @param integer Token type
* @param string Token value
* @param integer Token expiration in seconds
* @param integer User ID
* @return integer Token ID
*/
function token_create( $p_type, $p_value, $p_expiry = TOKEN_EXPIRY, $p_user_id = null ) {
$c_type = db_prepare_int( $p_type );
$c_timestamp = db_now();
$c_expiry = time() + $p_expiry;
$c_user_id = db_prepare_int( $p_user_id == null ? auth_get_current_user_id() : $p_user_id );
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
$t_query = "INSERT INTO $t_tokens_table
( type, value, timestamp, expiry, owner )
VALUES ( " . db_param() . ", " . db_param() . ", " . db_param() . " , " . db_param() . " , " . db_param() . " )";
db_query_bound( $t_query, Array( $c_type, $p_value, $c_timestamp, $c_expiry, $c_user_id ) );
return db_insert_id( $t_tokens_table );
}
/**
* Update a token
* @param integer Token ID
* @param string Token value
* @param integer Token expiration in seconds
* @return always true.
*/
function token_update( $p_token_id, $p_value, $p_expiry = TOKEN_EXPIRY ) {
token_ensure_exists( $p_token_id );
$c_token_id = db_prepare_int( $p_token_id );
$c_expiry = time() + $p_expiry;
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
$t_query = "UPDATE $t_tokens_table
SET value=" . db_param() . ", expiry=" . db_param() . "
WHERE id=" . db_param();
db_query_bound( $t_query, Array( $p_value, $c_expiry, $c_token_id ) );
return true;
}
/**
* Delete all tokens of a specified type.
* @param integer Token Type
* @return always true.
*/
function token_delete_by_type( $p_token_type ) {
$c_token_type = db_prepare_int( $p_token_type );
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
# Remove
$t_query = "DELETE FROM $t_tokens_table
WHERE type=" . db_param();
db_query_bound( $t_query, Array( $c_token_type ) );
return true;
}
/**
* Purge all expired tokens.
* @param integer Token type
* @return always true.
*/
function token_purge_expired( $p_token_type = null ) {
global $g_tokens_purged;
$t_tokens_table = db_get_table( 'mantis_tokens_table' );
$t_query = "DELETE FROM $t_tokens_table WHERE " . db_param() . " > expiry";
if( !is_null( $p_token_type ) ) {
$c_token_type = db_prepare_int( $p_token_type );
$t_query .= " AND type=" . db_param();
db_query_bound( $t_query, Array( db_now(), $c_token_type ) );
} else {
db_query_bound( $t_query, Array( db_now() ) );
}
$g_tokens_purged = true;
return true;
}
/**
* Purge all expired tokens only once per session.
* @param integer Token type
*/
function token_purge_expired_once( $p_token_type = null ) {
global $g_tokens_purged;
if( !$g_tokens_purged ) {
token_purge_expired();
}
}