/
project_api.php
650 lines (509 loc) · 19.1 KB
/
project_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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
<?php
# Mantis - a php based bugtracking system
# Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
# Copyright (C) 2002 - 2004 Mantis Team - mantisbt-dev@lists.sourceforge.net
# This program is distributed under the terms and conditions of the GPL
# See the README and LICENSE files for details
# --------------------------------------------------------
# $Id: project_api.php,v 1.61 2004-09-27 12:45:15 vboctor Exp $
# --------------------------------------------------------
$t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR;
require_once( $t_core_dir . 'category_api.php' );
require_once( $t_core_dir . 'version_api.php' );
require_once( $t_core_dir . 'bug_api.php' );
require_once( $t_core_dir . 'file_api.php' );
require_once( $t_core_dir . 'news_api.php' );
### Project API ###
#===================================
# Caching
#===================================
#########################################
# SECURITY NOTE: cache globals are initialized here to prevent them
# being spoofed if register_globals is turned on
$g_cache_project = array();
$g_cache_project_missing = array();
$g_cache_project_all = false;
# --------------------
# Cache a project row if necessary and return the cached copy
# If the second parameter is true (default), trigger an error
# if the project can't be found. If the second parameter is
# false, return false if the project can't be found.
function project_cache_row( $p_project_id, $p_trigger_errors=true ) {
global $g_cache_project, $g_cache_project_missing;
$c_project_id = db_prepare_int( $p_project_id );
if ( isset ( $g_cache_project[(int)$p_project_id] ) ) {
return $g_cache_project[(int)$p_project_id];
} else if ( isset( $g_cache_project_missing[(int)$p_project_id] ) ) {
return false;
}
$t_project_table = config_get( 'mantis_project_table' );
$query = "SELECT *
FROM $t_project_table
WHERE id='$c_project_id'";
$result = db_query( $query );
if ( 0 == db_num_rows( $result ) ) {
$g_cache_project_missing[(int)$p_project_id] = true;
if ( $p_trigger_errors ) {
trigger_error( ERROR_PROJECT_NOT_FOUND, ERROR );
} else {
return false;
}
}
$row = db_fetch_array( $result );
$g_cache_project[(int)$p_project_id] = $row;
return $row;
}
# --------------------
# Cache all project rows and return an array of them
function project_cache_all() {
global $g_cache_project, $g_cache_project_all;
if ( !$g_cache_project_all ) {
$t_project_table = config_get( 'mantis_project_table' );
$query = "SELECT *
FROM $t_project_table";
$result = db_query( $query );
$count = db_num_rows( $result );
for ( $i = 0 ; $i < $count ; $i++ ) {
$row = db_fetch_array( $result );
$g_cache_project[(int)$row['id']] = $row;
}
$g_cache_project_all = true;
}
return $g_cache_project;
}
# --------------------
# Clear the project cache (or just the given id if specified)
function project_clear_cache( $p_project_id = null ) {
global $g_cache_project, $g_cache_project_missing, $g_cache_project_all;
if ( null === $p_project_id ) {
$g_cache_project = array();
$g_cache_project_missing = array();
$g_cache_project_all = false;
} else {
unset( $g_cache_project[(int)$p_project_id] );
unset( $g_cache_project_missing[(int)$p_project_id] );
$g_cache_project_all = false;
}
return true;
}
#===================================
# Boolean queries and ensures
#===================================
# --------------------
# check to see if project exists by id
# return true if it does, false otherwise
function project_exists( $p_project_id ) {
# we're making use of the caching function here. If we
# succeed in caching the project then it exists and is
# now cached for use by later function calls. If we can't
# cache it we return false.
if ( false == project_cache_row( $p_project_id, false ) ) {
return false;
} else {
return true;
}
}
# --------------------
# check to see if project exists by id
# if it doesn't exist then error
# otherwise let execution continue undisturbed
function project_ensure_exists( $p_project_id ) {
if ( !project_exists( $p_project_id ) ) {
trigger_error( ERROR_PROJECT_NOT_FOUND, ERROR );
}
}
# --------------------
# check to see if project exists by name
function project_is_name_unique( $p_name ) {
$c_name = db_prepare_string( $p_name );
$t_project_table = config_get( 'mantis_project_table' );
$query ="SELECT COUNT(*)
FROM $t_project_table
WHERE name='$c_name'";
$result = db_query( $query );
if ( 0 == db_result( $result ) ) {
return true;
} else {
return false;
}
}
# --------------------
# check to see if project exists by id
# if it doesn't exist then error
# otherwise let execution continue undisturbed
function project_ensure_name_unique( $p_name ) {
if ( !project_is_name_unique( $p_name ) ) {
trigger_error( ERROR_PROJECT_NAME_NOT_UNIQUE, ERROR );
}
}
# --------------------
# check to see if the user/project combo already exists
# returns true is duplicate is found, otherwise false
function project_includes_user( $p_project_id, $p_user_id ) {
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$c_project_id = db_prepare_int( $p_project_id );
$c_user_id = db_prepare_int( $p_user_id );
$query = "SELECT COUNT(*)
FROM $t_project_user_list_table
WHERE project_id='$c_project_id' AND
user_id='$c_user_id'";
$result = db_query( $query );
if ( 0 == db_result( $result ) ) {
return false;
} else {
return true;
}
}
#===================================
# Creation / Deletion / Updating
#===================================
# --------------------
# Create a new project
function project_create( $p_name, $p_description, $p_status, $p_view_state = VS_PUBLIC, $p_file_path = '', $p_enabled = true ) {
# Make sure file path has trailing slash
$p_file_path = terminate_directory_path( $p_file_path );
$c_name = db_prepare_string( $p_name );
$c_description = db_prepare_string( $p_description );
$c_status = db_prepare_int( $p_status );
$c_view_state = db_prepare_int( $p_view_state );
$c_file_path = db_prepare_string( $p_file_path );
$c_enabled = db_prepare_bool( $p_enabled );
if ( is_blank( $p_name ) ) {
trigger_error( ERROR_PROJECT_NAME_INVALID, ERROR );
}
project_ensure_name_unique( $p_name );
if ( !is_blank( $p_file_path ) ) {
file_ensure_valid_upload_path( $p_file_path );
}
$t_project_table = config_get( 'mantis_project_table' );
$query = "INSERT INTO $t_project_table
( name, status, enabled, view_state, file_path, description )
VALUES
( '$c_name', '$c_status', '$c_enabled', '$c_view_state', '$c_file_path', '$c_description' )";
db_query( $query );
# return the id of the new project
return db_insert_id($t_project_table);
}
# --------------------
# Delete a project
function project_delete( $p_project_id ) {
$t_email_notifications = config_get( 'enable_email_notification' );
config_set( 'enable_email_notification', OFF );
$c_project_id = db_prepare_int( $p_project_id );
$t_project_table = config_get( 'mantis_project_table' );
# Delete the bugs
bug_delete_all( $p_project_id );
# Delete associations with custom field definitions.
custom_field_unlink_all( $p_project_id );
# Delete the project categories
category_remove_all( $p_project_id );
# Delete the project versions
version_remove_all( $p_project_id );
# Delete the project files
project_delete_all_files( $p_project_id );
# Delete the records assigning users to this project
project_remove_all_users( $p_project_id );
# Delete all news entries associated with the project being deleted
news_delete_all( $p_project_id );
# Delete the project entry
$query = "DELETE FROM $t_project_table
WHERE id='$c_project_id'";
db_query( $query );
config_set( 'enable_email_notification', $t_email_notifications );
project_clear_cache( $p_project_id );
# db_query() errors on failure so:
return true;
}
# --------------------
# Update a project
function project_update( $p_project_id, $p_name, $p_description, $p_status, $p_view_state, $p_file_path, $p_enabled ) {
# Make sure file path has trailing slash
$p_file_path = terminate_directory_path( $p_file_path );
$c_project_id = db_prepare_int( $p_project_id );
$c_name = db_prepare_string( $p_name );
$c_description = db_prepare_string( $p_description );
$c_status = db_prepare_int( $p_status );
$c_view_state = db_prepare_int( $p_view_state );
$c_file_path = db_prepare_string( $p_file_path );
$c_enabled = db_prepare_bool( $p_enabled );
if ( is_blank( $p_name ) ) {
trigger_error( ERROR_PROJECT_NAME_INVALID, ERROR );
}
$t_old_name = project_get_field( $p_project_id, 'name' );
if ( strcasecmp( $p_name, $t_old_name ) != 0 ) {
project_ensure_name_unique( $p_name );
}
if ( !is_blank( $p_file_path ) ) {
file_ensure_valid_upload_path( $p_file_path );
}
$t_project_table = config_get( 'mantis_project_table' );
$query = "UPDATE $t_project_table
SET name='$c_name',
status='$c_status',
enabled='$c_enabled',
view_state='$c_view_state',
file_path='$c_file_path',
description='$c_description'
WHERE id='$c_project_id'";
db_query( $query );
project_clear_cache( $p_project_id );
# db_query errors on failure so:
return true;
}
#===================================
# Data Access
#===================================
# --------------------
# Get the id of the project with the specified name
function project_get_id_by_name( $p_project_name ) {
$c_project_name = db_prepare_string( $p_project_name );
$t_project_table = config_get( 'mantis_project_table' );
$query = "SELECT id FROM $t_project_table WHERE name = '$c_project_name'";
$t_result = db_query( $query, 1 );
if ( db_num_rows( $t_result ) == 0 ) {
return 0;
} else {
return db_result( $t_result );
}
}
# --------------------
# Return the row describing the given project
function project_get_row( $p_project_id ) {
return project_cache_row( $p_project_id );
}
# --------------------
# Return all rows describing all projects
function project_get_all_rows() {
return project_cache_all();
}
# --------------------
# Return the specified field of the specified project
function project_get_field( $p_project_id, $p_field_name ) {
$row = project_get_row( $p_project_id );
if ( isset( $row[$p_field_name] ) ) {
return $row[$p_field_name];
} else {
error_parameters( $p_field_name );
trigger_error( ERROR_DB_FIELD_NOT_FOUND, WARNING );
return '';
}
}
# --------------------
# Return the name of the project
# Handles ALL_PROJECTS by returning the internationalized string for All Projects
function project_get_name( $p_project_id ) {
if ( ALL_PROJECTS == $p_project_id ) {
return lang_get( 'all_projects' );
} else {
return project_get_field( $p_project_id, 'name' );
}
}
# --------------------
# Return the user's local (overridden) access level on the project or false
# if the user is not listed on the project
function project_get_local_user_access_level( $p_project_id, $p_user_id ) {
$c_project_id = db_prepare_int( $p_project_id );
$c_user_id = db_prepare_int( $p_user_id );
if ( ALL_PROJECTS == $c_project_id ) {
return false;
}
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$query = "SELECT access_level
FROM $t_project_user_list_table
WHERE user_id='$c_user_id' AND project_id='$c_project_id'";
$result = db_query( $query );
if ( db_num_rows( $result ) > 0 ) {
return db_result( $result );
} else {
return false;
}
}
# --------------------
# return the descriptor holding all the info from the project user list
# for the specified project
function project_get_local_user_rows( $p_project_id ) {
$c_project_id = db_prepare_int( $p_project_id );
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$query = "SELECT *
FROM $t_project_user_list_table
WHERE project_id='$c_project_id'";
$result = db_query( $query );
$t_user_rows = array();
$t_row_count = db_num_rows( $result );
for ( $i=0 ; $i < $t_row_count ; $i++ ) {
array_push( $t_user_rows, db_fetch_array( $result ) );
}
return $t_user_rows;
}
# --------------------
# Return an array of info about users who have access to the the given project
# For each user we have 'id', 'username', and 'access_level' (overall access level)
# If the second parameter is given, return only users with an access level
# higher than the given value.
# if the first parameter is given as 'ALL_PROJECTS', return the global access level (without
# any reference to the specific project
function project_get_all_user_rows( $p_project_id = ALL_PROJECTS, $p_access_level = ANYBODY ) {
$c_project_id = db_prepare_int( $p_project_id );
# Optimization when access_level is NOBODY
if ( NOBODY == $p_access_level ) {
return array();
}
$t_user_table = config_get( 'mantis_user_table' );
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$t_on = ON;
$t_access_level = $p_access_level;
if( $c_project_id != ALL_PROJECTS ) {
if ( VS_PRIVATE == project_get_field( $p_project_id, 'view_state' ) ) {
# @@@ we need to get this logic out somewhere else.
# I was getting access_min from the project but apparently we got
# rid of that in 0.17.2. The user docs claim developers and higher
# get into private projects but the code seems to only allow administrators in
$t_access_level = max( $t_access_level, config_get( 'private_project_threshold' ) );
}
}
$t_access_clause = '';
if ( $t_access_level > 0 ) {
$t_access_clause = ' AND access_level >= ' . $t_access_level;
}
$t_users = array();
$query = "SELECT id, username, realname, access_level
FROM $t_user_table
WHERE enabled = $t_on
$t_access_clause
ORDER BY realname, username";
$result = db_query( $query );
$t_row_count = db_num_rows( $result );
for ( $i=0 ; $i < $t_row_count ; $i++ ) {
$row = db_fetch_array( $result );
$t_users[$row['id']] = $row;
}
if( $c_project_id != ALL_PROJECTS ) {
# Get the project overrides
$query = "SELECT u.id, u.username, u.realname, l.access_level
FROM $t_project_user_list_table l, $t_user_table u
WHERE l.user_id = u.id
AND u.enabled = $t_on
AND l.project_id = $c_project_id
ORDER BY u.realname, u.username";
$result = db_query( $query );
$t_row_count = db_num_rows( $result );
for ( $i=0 ; $i < $t_row_count ; $i++ ) {
$row = db_fetch_array( $result );
if ( $row['access_level'] >= $p_access_level ) {
$t_users[$row['id']] = $row;
} else {
# If user's overridden level is lower than required, so remove
# them from the list if they were previously there
unset( $t_users[$row['id']] );
}
}
}
return array_values($t_users);
}
#===================================
# Data Modification
#===================================
# --------------------
# add user with the specified access level to a project
function project_add_user( $p_project_id, $p_user_id, $p_access_level ) {
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$c_project_id = db_prepare_int( $p_project_id );
$c_user_id = db_prepare_int( $p_user_id );
$c_access_level = db_prepare_int( $p_access_level );
if ( DEFAULT_ACCESS_LEVEL == $p_access_level ) {
# Default access level for this user
$c_access_level = db_prepare_int( user_get_access_level ( $p_user_id ) );
}
$query = "INSERT
INTO $t_project_user_list_table
( project_id, user_id, access_level )
VALUES
( '$c_project_id', '$c_user_id', '$c_access_level')";
db_query( $query );
# db_query errors on failure so:
return true;
}
# --------------------
# update entry
# must make sure entry exists beforehand
function project_update_user_access( $p_project_id, $p_user_id, $p_access_level ) {
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$c_project_id = db_prepare_int( $p_project_id );
$c_user_id = db_prepare_int( $p_user_id );
$c_access_level = db_prepare_int( $p_access_level );
$query = "UPDATE $t_project_user_list_table
SET access_level='$c_access_level'
WHERE project_id='$c_project_id' AND
user_id='$c_user_id'";
db_query( $query );
# db_query errors on failure so:
return true;
}
# --------------------
# update or add the entry as appropriate
# This function involves one more db query than project_update_user_acces()
# or project_add_user()
function project_set_user_access( $p_project_id, $p_user_id, $p_access_level ) {
if ( project_includes_user( $p_project_id, $p_user_id ) ) {
return project_update_user_access( $p_project_id, $p_user_id, $p_access_level );
} else {
return project_add_user( $p_project_id, $p_user_id, $p_access_level );
}
}
# --------------------
# remove user from project
function project_remove_user( $p_project_id, $p_user_id ) {
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$c_project_id = db_prepare_int( $p_project_id );
$c_user_id = db_prepare_int( $p_user_id );
$query = "DELETE FROM $t_project_user_list_table
WHERE project_id='$c_project_id' AND
user_id='$c_user_id'";
db_query( $query );
# db_query errors on failure so:
return true;
}
# --------------------
# delete all users from the project user list for a given project
# this is useful when deleting or closing a project
function project_remove_all_users( $p_project_id ) {
$t_project_user_list_table = config_get( 'mantis_project_user_list_table' );
$c_project_id = db_prepare_int( $p_project_id );
$query = "DELETE FROM $t_project_user_list_table
WHERE project_id='$c_project_id'";
db_query( $query );
# db_query errors on failure so:
return true;
}
# --------------------
# Copy all users and their permissions from the source project to the
# destination project
function project_copy_users( $p_destination_id, $p_source_id ) {
# Copy all users from current project over to another project
$rows = project_get_local_user_rows( $p_source_id );
for ( $i = 0 ; $i < sizeof( $rows ) ; $i++ ) {
extract( $rows[$i], EXTR_PREFIX_ALL, 'v' );
# if there is no duplicate then add a new entry
# otherwise just update the access level for the existing entry
if ( project_includes_user( $p_destination_id, $v_user_id ) ) {
project_update_user_access( $p_destination_id, $v_user_id, $v_access_level );
} else {
project_add_user( $p_destination_id, $v_user_id, $v_access_level );
}
}
}
# --------------------
# Delete all files associated with a project
function project_delete_all_files( $p_project_id ) {
file_delete_project_files( $p_project_id );
}
#===================================
# Other
#===================================
# --------------------
# Pads the project id with the appropriate number of zeros.
function project_format_id( $p_project_id ) {
$t_padding = config_get( 'display_project_padding' );
return( str_pad( $p_project_id, $t_padding, '0', STR_PAD_LEFT ) );
}
?>