/
profile_api.php
303 lines (242 loc) · 9.24 KB
/
profile_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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
<?php
# Mantis - a php based bugtracking system
# Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
# Copyright (C) 2002 - 2007 Mantis Team - mantisbt-dev@lists.sourceforge.net
# Mantis 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.
#
# Mantis 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 Mantis. If not, see <http://www.gnu.org/licenses/>.
# --------------------------------------------------------
# $Id: profile_api.php,v 1.18.2.1 2007-10-13 22:35:39 giallu Exp $
# --------------------------------------------------------
### Profile API ###
#===================================
# Boolean queries and ensures
#===================================
#===================================
# Creation / Deletion / Updating
#===================================
# --------------------
# Create a new profile for the user, return the ID of the new profile
function profile_create( $p_user_id, $p_platform, $p_os, $p_os_build, $p_description ) {
$c_user_id = db_prepare_int( $p_user_id );
$c_platform = db_prepare_string( $p_platform );
$c_os = db_prepare_string( $p_os );
$c_os_build = db_prepare_string( $p_os_build );
$c_description = db_prepare_string( $p_description );
if ( ALL_USERS != $p_user_id ) {
user_ensure_unprotected( $p_user_id );
}
# platform cannot be blank
if ( is_blank( $c_platform ) ) {
error_parameters( lang_get( 'platform' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
# os cannot be blank
if ( is_blank( $c_os ) ) {
error_parameters( lang_get( 'operating_system' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
# os_build cannot be blank
if ( is_blank( $c_os_build ) ) {
error_parameters( lang_get( 'version' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
# Add profile
$query = "INSERT INTO $t_user_profile_table
( user_id, platform, os, os_build, description )
VALUES
( '$c_user_id', '$c_platform', '$c_os', '$c_os_build', '$c_description' )";
db_query( $query );
return db_insert_id($t_user_profile_table);
}
# --------------------
# Delete a profile for the user
#
# Note that although profile IDs are currently globally unique, the existing
# code included the user_id in the query and I have chosen to keep that for
# this API as it hides the details of id implementation from users of the API
function profile_delete( $p_user_id, $p_profile_id ) {
$c_user_id = db_prepare_int( $p_user_id );
$c_profile_id = db_prepare_int( $p_profile_id );
if ( ALL_USERS != $p_user_id ) {
user_ensure_unprotected( $p_user_id );
}
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
# Delete the profile
$query = "DELETE FROM $t_user_profile_table
WHERE id='$c_profile_id' AND user_id='$c_user_id'";
db_query( $query );
# db_query() errors on failure so:
return true;
}
# --------------------
# Update a profile for the user
function profile_update( $p_user_id, $p_profile_id, $p_platform, $p_os, $p_os_build, $p_description ) {
$c_user_id = db_prepare_int( $p_user_id );
$c_profile_id = db_prepare_int( $p_profile_id );
$c_platform = db_prepare_string( $p_platform );
$c_os = db_prepare_string( $p_os );
$c_os_build = db_prepare_string( $p_os_build );
$c_description = db_prepare_string( $p_description );
if ( ALL_USERS != $p_user_id ) {
user_ensure_unprotected( $p_user_id );
}
# platform cannot be blank
if ( is_blank( $c_platform ) ) {
error_parameters( lang_get( 'platform' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
# os cannot be blank
if ( is_blank( $c_os ) ) {
error_parameters( lang_get( 'operating_system' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
# os_build cannot be blank
if ( is_blank( $c_os_build ) ) {
error_parameters( lang_get( 'version' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
# Add item
$query = "UPDATE $t_user_profile_table
SET platform='$c_platform',
os='$c_os',
os_build='$c_os_build',
description='$c_description'
WHERE id='$c_profile_id' AND user_id='$c_user_id'";
$result = db_query( $query );
# db_query() errors on failure so:
return true;
}
#===================================
# Data Access
#===================================
# --------------------
# Return a profile row from the database
function profile_get_row( $p_user_id, $p_profile_id ) {
$c_user_id = db_prepare_int( $p_user_id );
$c_profile_id = db_prepare_int( $p_profile_id );
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
$query = "SELECT *
FROM $t_user_profile_table
WHERE id='$c_profile_id' AND user_id='$c_user_id'";
$result = db_query( $query );
return db_fetch_array( $result );
}
# --------------------
# Return a profile row from the database
function profile_get_row_direct( $p_profile_id ) {
$c_profile_id = db_prepare_int( $p_profile_id );
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
$query = "SELECT *
FROM $t_user_profile_table
WHERE id='$c_profile_id'";
$result = db_query( $query );
return db_fetch_array( $result );
}
# --------------------
# Return an array containing all rows for a given user
function profile_get_all_rows( $p_user_id ) {
$c_user_id = db_prepare_int( $p_user_id );
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
$query = "SELECT *
FROM $t_user_profile_table
WHERE user_id='$c_user_id'
ORDER BY platform, os, os_build";
$result = db_query( $query );
$t_rows = array();
$t_row_count = db_num_rows( $result );
for ( $i=0 ; $i < $t_row_count ; $i++ ) {
array_push( $t_rows, db_fetch_array( $result ) );
}
return $t_rows;
}
# --------------------
# Return an array containing all profiles for a given user,
# including global profiles
function profile_get_all_for_user( $p_user_id ) {
if ( ALL_USERS == $p_user_id ) {
return profile_get_all_rows( ALL_USERS );
} else {
$t_profiles_array = array_merge( profile_get_all_rows( ALL_USERS ),
profile_get_all_rows( $p_user_id ) );
asort( $t_profiles_array );
return $t_profiles_array;
}
}
# --------------------
# Return an array of strings containing unique values for the specified field based
# on private and public profiles accessible to the specified user.
function profile_get_field_all_for_user( $p_field, $p_user_id = null ) {
$c_user_id = ( $p_user_id === null ) ? auth_get_current_user_id() : db_prepare_int( $p_user_id );
$c_field = db_prepare_string( $p_field );
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
$query = "SELECT DISTINCT $c_field
FROM $t_user_profile_table
WHERE ( user_id='$c_user_id' ) OR ( user_id = '0' )
ORDER BY $c_field";
$result = db_query( $query );
$t_rows = array();
$t_row_count = db_num_rows( $result );
for ( $i=0 ; $i < $t_row_count ; $i++ ) {
$t_row = db_fetch_array( $result );
array_push( $t_rows, $t_row[$c_field] );
}
return $t_rows;
}
# --------------------
# Return an array containing all profiles used in a given project
function profile_get_all_for_project( $p_project_id ) {
$t_project_where = helper_project_specific_where( $p_project_id );
$t_bug_table = config_get( 'mantis_bug_table' );
$t_user_profile_table = config_get( 'mantis_user_profile_table' );
# using up.* causes an SQL error on MS SQL since up.description is of type text
$query = "SELECT DISTINCT(up.id), up.user_id, up.platform, up.os, up.os_build
FROM $t_user_profile_table up, $t_bug_table b
WHERE $t_project_where
AND up.id = b.profile_id";
$result = db_query( $query );
$t_rows = array();
$t_row_count = db_num_rows( $result );
for ( $i=0 ; $i < $t_row_count ; $i++ ) {
array_push( $t_rows, db_fetch_array( $result ) );
}
return $t_rows;
}
# --------------------
# Return an array containing all global profiles
function profile_get_global() {
return profile_get_all_rows( ALL_USERS );
}
# --------------------
# Returns the default profile
function profile_get_default( $p_user_id ) {
$c_user_id = db_prepare_int( $p_user_id );
$t_mantis_user_pref_table = config_get( 'mantis_user_pref_table' );
$query = "SELECT default_profile
FROM $t_mantis_user_pref_table
WHERE user_id='$c_user_id'";
$result = db_query( $query );
$t_default_profile = db_result( $result, 0, 0 );
return $t_default_profile;
}
# --------------------
# Returns whether the specified profile is global
function profile_is_global( $p_profile_id ) {
$t_row = profile_get_row( ALL_USERS, $p_profile_id );
return ( $t_row !== false );
}
#===================================
# Data Modification
#===================================
?>