/
prepare_api.php
154 lines (134 loc) · 5.22 KB
/
prepare_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
<?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/>.
/**
* Prepare API
*
* Handles preparation of strings prior to be printed or stored.
*
* @package CoreAPI
* @subpackage PrepareAPI
* @copyright Copyright 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright 2002 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*
* @uses access_api.php
* @uses config_api.php
* @uses constant_inc.php
* @uses string_api.php
* @uses user_api.php
* @uses version_api.php
*/
require_api( 'access_api.php' );
require_api( 'config_api.php' );
require_api( 'constant_inc.php' );
require_api( 'string_api.php' );
require_api( 'user_api.php' );
require_api( 'version_api.php' );
/**
* return the mailto: href string link
* @param string $p_email Email address to prepare.
* @param string $p_text Display text for the hyperlink.
* @return string
*/
function prepare_email_link( $p_email, $p_text ) {
if( !access_has_project_level( config_get( 'show_user_email_threshold' ) ) ) {
return string_display_line( $p_text );
}
# If we apply string_url() to the whole mailto: link then the @
# gets turned into a %40 and you can't right click in browsers to
# do Copy Email Address.
$t_mailto = string_attribute( 'mailto:' . $p_email );
$p_text = string_display_line( $p_text );
return '<a href="' . $t_mailto . '">' . $p_text . '</a>';
}
/**
* prepares the name of the user given the id. also makes it an email link.
* @param integer $p_user_id A valid user identifier.
* @return string
*/
function prepare_user_name( $p_user_id ) {
# Catch a user_id of NO_USER (like when a handler hasn't been assigned)
if( NO_USER == $p_user_id ) {
return '';
}
$t_username = user_get_name( $p_user_id );
$t_username = string_display_line( $t_username );
if( user_exists( $p_user_id ) && user_get_field( $p_user_id, 'enabled' ) ) {
return '<a class="user" href="' . string_sanitize_url( 'view_user_page.php?id=' . $p_user_id, true ) . '">' . $t_username . '</a>';
} else {
return '<del class="user">' . $t_username . '</del>';
}
}
/**
* A function that prepares the version string for outputting to the user on view / print issue pages.
* This function would add the version date, if appropriate.
*
* @param integer $p_project_id The project id.
* @param integer $p_version_id The version id. If false then this method will return an empty string.
* @return string The formatted version string.
*/
function prepare_version_string( $p_project_id, $p_version_id ) {
if( $p_version_id === false ) {
return '';
}
$t_version_text = version_full_name( $p_version_id, null, $p_project_id );
if( access_has_project_level( config_get( 'show_version_dates_threshold' ), $p_project_id ) ) {
$t_short_date_format = config_get( 'short_date_format' );
$t_version = version_get( $p_version_id );
$t_version_text .= ' (' . date( $t_short_date_format, $t_version->date_order ) . ')';
}
return $t_version_text;
}
/**
* Prepares avatar for raw outputting (only avatar image).
*
* @param Avatar $p_avatar An instance of class Avatar.
* @param string $p_class_prefix CSS class prefix to add to the avatar's surrounding div and to the img.
* The CSS classes to implement will be named [$p_class_prefix]-avatar_container-[$p_size] and
* [$p_class_prefix]-avatar-[$p_size].
* @param integer $p_size Image maximum size.
* @return the HTML string of the avatar.
*/
function prepare_raw_avatar( $p_avatar, $p_class_prefix, $p_size) {
if( $p_avatar === null ) {
return '';
}
$t_image = htmlspecialchars( $p_avatar->image );
$t_text = htmlspecialchars( $p_avatar->text );
$t_avatar_class = $p_class_prefix . '-avatar' . '-' . $p_size;
return '<img class="' . $t_avatar_class . '" src="' . $t_image . '" alt="' .
$t_text . '" />';
}
/**
* Prepares avatar for outputting.
*
* @param Avatar $p_avatar An instance of class Avatar.
* @param string $p_class_prefix CSS class prefix to add to the avatar's surrounding div and to the img.
* The CSS classes to implement will be named [$p_class_prefix]-avatar-container-[$p_size] and
* [$p_class_prefix]-avatar-[$p_size].
* @param integer $p_size Image maximum size.
* @return the HTML string of the avatar.
*/
function prepare_avatar( $p_avatar, $p_class_prefix, $p_size ) {
if( $p_avatar === null ) {
return '';
}
$t_link = htmlspecialchars( $p_avatar->link );
$t_container_class = $p_class_prefix . '-avatar-container' . '-' . $p_size;
return '<div class="' . $t_container_class . '">' .
'<a rel="nofollow" href="' . $t_link . '">' .
prepare_raw_avatar( $p_avatar, $p_class_prefix, $p_size ) .
'</a></div>';
}