/
string_api.php
791 lines (671 loc) · 27.5 KB
/
string_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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
<?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/>.
/**
* @package CoreAPI
* @subpackage StringProcessingAPI
* @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
*/
$t_core_dir = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
/**
* requires bug_api
*/
require_once( $t_core_dir . 'bug_api.php' );
/**
* requires user_pref_api
*/
require_once( $t_core_dir . 'user_pref_api.php' );
$g_cache_html_valid_tags = '';
$g_cache_html_valid_tags_single_line = '';
/**
* Return a string with all alphabetical characters converted to lowercase,
* using an appropriate multibyte implementation as available to system.
* @param string Input string
* @return string Lower cased string
*/
if ( function_exists( 'mb_strtolower' ) ) {
function string_lower( $p_string ) {
return mb_strtolower( $p_string );
}
} else {
function string_lower( $p_string ) {
return strtolower( $p_string );
}
}
# ## --------------------
# Preserve spaces at beginning of lines.
# Lines must be separated by \n rather than <br />
function string_preserve_spaces_at_bol( $p_string ) {
$lines = explode( "\n", $p_string );
$line_count = count( $lines );
for( $i = 0;$i < $line_count;$i++ ) {
$count = 0;
$prefix = '';
$t_char = substr( $lines[$i], $count, 1 );
$spaces = 0;
while(( $t_char == ' ' ) || ( $t_char == "\t" ) ) {
if( $t_char == ' ' ) {
$spaces++;
} else {
$spaces += 4;
}
// 1 tab = 4 spaces, can be configurable.
$count++;
$t_char = substr( $lines[$i], $count, 1 );
}
for( $j = 0;$j < $spaces;$j++ ) {
$prefix .= ' ';
}
$lines[$i] = $prefix . substr( $lines[$i], $count );
}
return implode( "\n", $lines );
}
# --------------------
# Prepare a string to be printed without being broken into multiple lines
function string_no_break( $p_string ) {
if( strpos( $p_string, ' ' ) !== false ) {
return '<span class="nowrap">' . $p_string . "</span>";
} else {
return $p_string;
}
}
# --------------------
# Similar to nl2br, but fixes up a problem where new lines are doubled between
# <pre> tags.
# additionally, wrap the text an $p_wrap character intervals if the config is set
function string_nl2br( $p_string, $p_wrap = 100 ) {
$output = '';
$pieces = preg_split( '/(<pre[^>]*>.*?<\/pre>)/is', $p_string, -1, PREG_SPLIT_DELIM_CAPTURE );
if( isset( $pieces[1] ) ) {
foreach( $pieces as $piece ) {
if( preg_match( '/(<pre[^>]*>.*?<\/pre>)/is', $piece ) ) {
$piece = preg_replace( "/<br[^>]*?>/", "", $piece );
# @@@ thraxisp - this may want to be replaced by html_entity_decode (or equivalent)
# if other encoded characters are a problem
$piece = preg_replace( "/ /", " ", $piece );
if( ON == config_get( 'wrap_in_preformatted_text' ) ) {
$output .= preg_replace( '/([^\n]{' . $p_wrap . '})(?!<\/pre>)/', "$1\n", $piece );
} else {
$output .= $piece;
}
} else {
$output .= nl2br( $piece );
}
}
return $output;
} else {
return nl2br( $p_string );
}
}
# --------------------
# Prepare a multiple line string for display to HTML
function string_display( $p_string ) {
$t_data = event_signal( 'EVENT_DISPLAY_TEXT', $p_string, true );
return $t_data;
}
# --------------------
# Prepare a single line string for display to HTML
function string_display_line( $p_string ) {
$t_data = event_signal( 'EVENT_DISPLAY_TEXT', $p_string, false );
return $t_data;
}
# --------------------
# Prepare a string for display to HTML and add href anchors for URLs, emails,
# bug references, and cvs references
function string_display_links( $p_string ) {
$t_data = event_signal( 'EVENT_DISPLAY_FORMATTED', $p_string, true );
return $t_data;
}
# --------------------
# Prepare a single line string for display to HTML and add href anchors for
# URLs, emails, bug references, and cvs references
function string_display_line_links( $p_string ) {
$t_data = event_signal( 'EVENT_DISPLAY_FORMATTED', $p_string, false );
return $t_data;
}
# --------------------
# Prepare a string for display in rss
function string_rss_links( $p_string ) {
# rss can not start with which spaces will be replaced into by string_display().
$t_string = trim( $p_string );
$t_string = event_signal( 'EVENT_DISPLAY_RSS', $t_string );
# another escaping to escape the special characters created by the generated links
return string_html_specialchars( $t_string );
}
# --------------------
# Prepare a string for plain text display in email
function string_email( $p_string ) {
$p_string = string_strip_hrefs( $p_string );
return $p_string;
}
# --------------------
# Prepare a string for plain text display in email and add URLs for bug
# links and cvs links
function string_email_links( $p_string ) {
return event_signal( 'EVENT_DISPLAY_EMAIL', $p_string );
}
# --------------------
# Process a string for display in a textarea box
function string_textarea( $p_string ) {
$p_string = string_html_specialchars( $p_string );
return $p_string;
}
# --------------------
# Process a string for display in a text box
function string_attribute( $p_string ) {
$p_string = string_html_specialchars( $p_string );
return $p_string;
}
# --------------------
# Process a string for inclusion in a URL as a GET parameter
function string_url( $p_string ) {
$p_string = rawurlencode( $p_string );
return $p_string;
}
# --------------------
# validate the url as part of this site before continuing
# see tests/test_string_sanitize_url.php for test cases
function string_sanitize_url( $p_url, $p_return_absolute = false ) {
$t_url = strip_tags( urldecode( $p_url ) );
$t_path = rtrim( config_get( 'path' ), '/' );
$t_short_path = rtrim( config_get( 'short_path' ), '/' );
$t_pattern = '(?:/*(?P<script>[^\?#]*))(?:\?(?P<query>[^#]*))?(?:#(?P<anchor>[^#]*))?';
# Break the given URL into pieces for path, script, query, and anchor
$t_type = 0;
if ( preg_match( "@^(?P<path>$t_path)$t_pattern\$@", $t_url, $t_matches ) ) {
$t_type = 1;
} else if ( preg_match( "@^(?P<path>$t_short_path)$t_pattern\$@", $t_url, $t_matches ) ) {
$t_type = 2;
} else if ( preg_match( "@^(?P<path>)$t_pattern\$@", $t_url, $t_matches ) ) {
$t_type = 3;
}
# Check for URL's pointing to other domains
if ( 0 == $t_type || empty( $t_matches['script'] ) ||
3 == $t_type && preg_match( '@(?:[^:]*)?://@', $t_url ) > 0 ) {
return ( $p_return_absolute ? $t_path . '/' : '' ) . 'index.php';
}
# Start extracting regex matches
$t_script = $t_matches['script'];
$t_script_path = $t_matches['path'];
# Clean/encode query params
$t_query = '';
if ( isset( $t_matches['query'] ) ) {
$t_pairs = array();
parse_str( html_entity_decode( $t_matches['query'] ), $t_pairs );
$t_clean_pairs = array();
foreach( $t_pairs as $t_key => $t_value ) {
$t_clean_pairs[] = rawurlencode( $t_key ) . '=' . rawurlencode( $t_value );
}
$t_query = '?' . join( '&', $t_clean_pairs );
}
# encode link anchor
$t_anchor = '';
if ( isset( $t_matches['anchor'] ) ) {
$t_anchor = '#' . rawurlencode( $t_matches['anchor'] );
}
# Return an appropriate re-combined URL string
if ( $p_return_absolute ) {
return $t_path . '/' . $t_script . $t_query . $t_anchor;
} else {
return ( !empty( $t_script_path ) ? $t_script_path . '/' : '' ) . $t_script . $t_query . $t_anchor;
}
}
# --------------------
# process the $p_string and convert filenames in the format
# cvs:filename.ext or cvs:filename.ext:n.nn to a html link
# if $p_include_anchor is true, include an <a href="..."> tag,
# otherwise, just insert the URL as text
function string_process_cvs_link( $p_string, $p_include_anchor = true ) {
$t_cvs_web = config_get( 'cvs_web' );
if( $p_include_anchor ) {
$t_replace_with = '[CVS] <a href="' . $t_cvs_web . '\\1?rev=\\4" target="_new">\\1</a>\\5';
} else {
$t_replace_with = '[CVS] ' . $t_cvs_web . '\\1?rev=\\4\\5';
}
return preg_replace( '/cvs:([^\.\s:,\?!<]+(\.[^\.\s:,\?!<]+)*)(:)?(\d\.[\d\.]+)?([\W\s])?/i', $t_replace_with, $p_string );
}
# --------------------
# Process $p_string, looking for bug ID references and creating bug view
# links for them.
#
# Returns the processed string.
#
# If $p_include_anchor is true, include the href tag, otherwise just insert
# the URL
#
# The bug tag ('#' by default) must be at the beginning of the string or
# preceeded by a character that is not a letter, a number or an underscore
#
# if $p_include_anchor = false, $p_fqdn is ignored and assumed to true.
$string_process_bug_link_callback = array();
function string_process_bug_link( $p_string, $p_include_anchor = true, $p_detail_info = true, $p_fqdn = false ) {
global $string_process_bug_link_callback;
$t_tag = config_get( 'bug_link_tag' );
# bail if the link tag is blank
if( '' == $t_tag || $p_string == '' ) {
return $p_string;
}
if( !isset( $string_process_bug_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn] ) ) {
if( $p_include_anchor ) {
$string_process_bug_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn] = create_function( '$p_array', '
if ( bug_exists( (int)$p_array[2] ) && access_has_bug_level( VIEWER, (int)$p_array[2] ) ) {
return $p_array[1] . string_get_bug_view_link( (int)$p_array[2], null, ' . ( $p_detail_info ? 'true' : 'false' ) . ', ' . ( $p_fqdn ? 'true' : 'false' ) . ');
} else {
return $p_array[0];
}
' );
} else {
$string_process_bug_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn] = create_function( '$p_array', '
# We might as well create the link here even if the bug
# doesnt exist. In the case above we dont want to do
# the summary lookup on a non-existant bug. But here, we
# can create the link and by the time it is clicked on, the
# bug may exist.
return $p_array[1] . string_get_bug_view_url_with_fqdn( (int)$p_array[2], null );
' );
}
}
$p_string = preg_replace_callback( '/(^|[^\w&])' . preg_quote( $t_tag, '/' ) . '(\d+)\b/', $string_process_bug_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn], $p_string );
return $p_string;
}
# --------------------
# Process $p_string, looking for bugnote ID references and creating bug view
# links for them.
#
# Returns the processed string.
#
# If $p_include_anchor is true, include the href tag, otherwise just insert
# the URL
#
# The bugnote tag ('~' by default) must be at the beginning of the string or
# preceeded by a character that is not a letter, a number or an underscore
#
# if $p_include_anchor = false, $p_fqdn is ignored and assumed to true.
$string_process_bugnote_link_callback = array();
function string_process_bugnote_link( $p_string, $p_include_anchor = true, $p_detail_info = true, $p_fqdn = false ) {
global $string_process_bugnote_link_callback;
$t_tag = config_get( 'bugnote_link_tag' );
# bail if the link tag is blank
if( '' == $t_tag || $p_string == '' ) {
return $p_string;
}
if( !isset( $string_process_bugnote_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn] ) ) {
if( $p_include_anchor ) {
$string_process_bugnote_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn] = create_function( '$p_array', '
if ( bugnote_exists( (int)$p_array[2] ) ) {
$t_bug_id = bugnote_get_field( (int)$p_array[2], \'bug_id\' );
$g_project_override = bug_get_field( $t_bug_id, \'project_id\' );
if ( bug_exists( $t_bug_id ) && ( access_compare_level( user_get_access_level( auth_get_current_user_id(), bug_get_field( $t_bug_id, \'project_id\' ) ), config_get( \'private_bugnote_threshold\' ) ) || ( bugnote_get_field( (int)$p_array[2], \'reporter_id\' ) == auth_get_current_user_id() ) || bugnote_get_field( (int)$p_array[2], \'view_state\' ) == VS_PUBLIC ) ) {
$g_project_override = null;
return $p_array[1] . string_get_bugnote_view_link( $t_bug_id, (int)$p_array[2], null, ' . ( $p_detail_info ? 'true' : 'false' ) . ', ' . ( $p_fqdn ? 'true' : 'false' ) . ' );
} else {
$g_project_override = null;
return $p_array[0];
}
} else {
return $p_array[0];
}
' );
} else {
$string_process_bugnote_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn] = create_function( '$p_array', '
# We might as well create the link here even if the bug
# doesnt exist. In the case above we dont want to do
# the summary lookup on a non-existant bug. But here, we
# can create the link and by the time it is clicked on, the
# bug may exist.
$t_bug_id = bugnote_get_field( (int)$p_array[2], \'bug_id\' );
if ( bug_exists( $t_bug_id ) ) {
return $p_array[1] . string_get_bugnote_view_url_with_fqdn( $t_bug_id, (int)$p_array[2], null );
} else {
return $p_array[0];
}
' );
}
}
$p_string = preg_replace_callback( '/(^|[^\w])' . preg_quote( $t_tag, '/' ) . '(\d+)\b/', $string_process_bugnote_link_callback[$p_include_anchor][$p_detail_info][$p_fqdn], $p_string );
return $p_string;
}
# ===================================
# Tag Processing
# ===================================
# --------------------
# Detect URLs and email addresses in the string and replace them with href anchors
function string_insert_hrefs( $p_string ) {
static $s_url_regex = null;
if( !config_get( 'html_make_links' ) ) {
return $p_string;
}
$t_change_quotes = false;
if( ini_get_bool( 'magic_quotes_sybase' ) ) {
$t_change_quotes = true;
ini_set( 'magic_quotes_sybase', false );
}
# Find any URL in a string and replace it by a clickable link
if ( is_null( $s_url_regex ) ) {
# %2A notation in url's
$t_url_hex = '%[[:digit:]A-Fa-f]{2}';
# valid set of characters that may occur in url scheme. Note: - should be first (A-F != -AF).
$t_url_valid_chars = '-_.,!~*\';\/?%^\\\\:@&={\|}+$#[:alnum:]\pL';
$t_url_chars = "(?:${t_url_hex}|[${t_url_valid_chars}\(\)\[\]])";
$t_url_chars2 = "(?:${t_url_hex}|[${t_url_valid_chars}])";
$t_url_chars_in_brackets = "(?:${t_url_hex}|[${t_url_valid_chars}\(\)])";
$t_url_chars_in_parens = "(?:${t_url_hex}|[${t_url_valid_chars}\[\]])";
$t_url_part1 = "${t_url_chars}";
$t_url_part2 = "(?:\(${t_url_chars_in_parens}*\)|\[${t_url_chars_in_brackets}*\]|${t_url_chars2})";
$s_url_regex = "/(([[:alpha:]][-+.[:alnum:]]*):\/\/(${t_url_part1}*?${t_url_part2}+))/sue";
}
$p_string = preg_replace( $s_url_regex, "'<a href=\"'.rtrim('\\1','.').'\">\\1</a> [<a href=\"'.rtrim('\\1','.').'\" target=\"_blank\">^</a>]'", $p_string );
if( $t_change_quotes ) {
ini_set( 'magic_quotes_sybase', true );
}
$p_string = preg_replace( '/\s' . email_regex_simple() . '\s/i', '<a href="mailto:\0">\0</a>', $p_string );
return $p_string;
}
# --------------------
# Detect href anchors in the string and replace them with URLs and email addresses
function string_strip_hrefs( $p_string ) {
# First grab mailto: hrefs. We don't care whether the URL is actually
# correct - just that it's inside an href attribute.
$p_string = preg_replace( '/<a\s[^\>]*href="mailto:([^\"]+)"[^\>]*>[^\<]*<\/a>/si', '\1', $p_string );
# Then grab any other href
$p_string = preg_replace( '/<a\s[^\>]*href="([^\"]+)"[^\>]*>[^\<]*<\/a>/si', '\1', $p_string );
return $p_string;
}
# --------------------
# This function looks for text with htmlentities
# like <b> and converts is into corresponding
# html <b> based on the configuration presets
function string_restore_valid_html_tags( $p_string, $p_multiline = true ) {
global $g_cache_html_valid_tags_single_line, $g_cache_html_valid_tags;
$tags = '';
if( is_blank(( $p_multiline ? $g_cache_html_valid_tags : $g_cache_html_valid_tags_single_line ) ) ) {
$t_html_valid_tags = config_get( $p_multiline ? 'html_valid_tags' : 'html_valid_tags_single_line' );
if( OFF === $t_html_valid_tags || is_blank( $t_html_valid_tags ) ) {
return $p_string;
}
$tags = explode( ',', $t_html_valid_tags );
foreach( $tags as $key => $value ) {
if( !is_blank( $value ) ) {
$tags[$key] = trim( $value );
}
}
$tags = implode( '|', $tags );
if( $p_multiline ) {
$g_cache_html_valid_tags = $tags;
} else {
$g_cache_html_valid_tags_single_line = $tags;
}
} else {
$tags = ( $p_multiline ? $g_cache_html_valid_tags : $g_cache_html_valid_tags_single_line );
}
$p_string = eregi_replace( '<(' . $tags . ')[[:space:]]*>', '<\\1>', $p_string );
$p_string = eregi_replace( '<\/(' . $tags . ')[[:space:]]*>', '</\\1>', $p_string );
$p_string = eregi_replace( '<(' . $tags . ')[[:space:]]*\/>', '<\\1 />', $p_string );
return $p_string;
}
# ===================================
# Advanced/Simple page selection
# ===================================
# --------------------
# return the name of a bug page for the user
# account for the user preference and site override
#
# $p_action should be something like 'view', 'update', or 'report'
# If $p_user_id is null or not specified, use the current user
function string_get_bug_page( $p_action, $p_user_id = null ) {
if( null === $p_user_id ) {
if( auth_is_user_authenticated() ) {
$p_user_id = auth_get_current_user_id();
}
}
$g_show_action = config_get( 'show_' . $p_action );
switch( $g_show_action ) {
case BOTH:
if(( null !== $p_user_id ) && ( ON == user_pref_get_pref( $p_user_id, 'advanced_' . $p_action ) ) ) {
return 'bug_' . $p_action . '_advanced_page.php';
} else {
return 'bug_' . $p_action . '_page.php';
}
case SIMPLE_ONLY:
return 'bug_' . $p_action . '_page.php';
case ADVANCED_ONLY:
return 'bug_' . $p_action . '_advanced_page.php';
}
}
# --------------------
# return an href anchor that links to a bug VIEW page for the given bug
# account for the user preference and site override
function string_get_bug_view_link( $p_bug_id, $p_user_id = null, $p_detail_info = true, $p_fqdn = false ) {
if( bug_exists( $p_bug_id ) ) {
$t_link = '<a href="';
if( $p_fqdn ) {
$t_link .= config_get_global( 'path' );
} else {
$t_link .= config_get_global( 'short_path' );
}
$t_link .= string_get_bug_view_url( $p_bug_id, $p_user_id ) . '"';
if( $p_detail_info ) {
$t_summary = string_attribute( bug_get_field( $p_bug_id, 'summary' ) );
$t_status = string_attribute( get_enum_element( 'status', bug_get_field( $p_bug_id, 'status' ) ) );
$t_link .= ' title="[' . $t_status . '] ' . $t_summary . '"';
$t_resolved = bug_get_field( $p_bug_id, 'status' ) >= config_get( 'bug_resolved_status_threshold' );
if( $t_resolved ) {
$t_link .= ' class="resolved"';
}
}
$t_link .= '>' . bug_format_id( $p_bug_id ) . '</a>';
} else {
$t_link = bug_format_id( $p_bug_id );
}
return $t_link;
}
# --------------------
# return an href anchor that links to a bug VIEW page for the given bug
# account for the user preference and site override
function string_get_bugnote_view_link( $p_bug_id, $p_bugnote_id, $p_user_id = null, $p_detail_info = true, $p_fqdn = false ) {
$t_bug_id = (int)$p_bug_id;
if( bug_exists( $t_bug_id ) && bugnote_exists( $p_bugnote_id ) ) {
$t_link = '<a href="';
if( $p_fqdn ) {
$t_link .= config_get_global( 'path' );
} else {
$t_link .= config_get_global( 'short_path' );
}
$t_link .= string_get_bugnote_view_url( $p_bug_id, $p_bugnote_id, $p_user_id ) . '"';
if( $p_detail_info ) {
$t_reporter = string_attribute( user_get_name( bugnote_get_field( $p_bugnote_id, 'reporter_id' ) ) );
$t_update_date = string_attribute( date( config_get( 'normal_date_format' ), ( db_unixtimestamp( bugnote_get_field( $p_bugnote_id, 'last_modified' ) ) ) ) );
$t_link .= ' title="' . bug_format_id( $t_bug_id ) . ': [' . $t_update_date . '] ' . $t_reporter . '"';
}
$t_link .= '>' . bug_format_id( $t_bug_id ) . ':' . bugnote_format_id( $p_bugnote_id ) . '</a>';
} else {
$t_link = bugnote_format_id( $t_bug_id ) . ':' . bugnote_format_id( $p_bugnote_id );
}
return $t_link;
}
# --------------------
# return the name and GET parameters of a bug VIEW page for the given bug
# account for the user preference and site override
function string_get_bug_view_url( $p_bug_id, $p_user_id = null ) {
return 'view.php?id=' . $p_bug_id;
}
# --------------------
# return the name and GET parameters of a bug VIEW page for the given bug
# account for the user preference and site override
function string_get_bugnote_view_url( $p_bug_id, $p_bugnote_id, $p_user_id = null ) {
return 'view.php?id=' . $p_bug_id . '#c' . $p_bugnote_id;
}
# --------------------
# return the name and GET parameters of a bug VIEW page for the given bug
# account for the user preference and site override
# The returned url includes the fully qualified domain, hence it is suitable to be included
# in emails.
function string_get_bugnote_view_url_with_fqdn( $p_bug_id, $p_bugnote_id, $p_user_id = null ) {
return config_get( 'path' ) . string_get_bug_view_url( $p_bug_id, $p_user_id ) . '#c' . $p_bugnote_id;
}
# --------------------
# return the name and GET parameters of a bug VIEW page for the given bug
# account for the user preference and site override
# The returned url includes the fully qualified domain, hence it is suitable to be included
# in emails.
function string_get_bug_view_url_with_fqdn( $p_bug_id, $p_user_id = null ) {
return config_get( 'path' ) . string_get_bug_view_url( $p_bug_id, $p_user_id );
}
# --------------------
# return the name of a bug VIEW page for the user
# account for the user preference and site override
function string_get_bug_view_page( $p_user_id = null ) {
return string_get_bug_page( 'view', $p_user_id );
}
# --------------------
# return an href anchor that links to a bug UPDATE page for the given bug
# account for the user preference and site override
function string_get_bug_update_link( $p_bug_id, $p_user_id = null ) {
$t_summary = string_attribute( bug_get_field( $p_bug_id, 'summary' ) );
return '<a href="' . helper_mantis_url( string_get_bug_update_url( $p_bug_id, $p_user_id ) ) . '" title="' . $t_summary . '">' . bug_format_id( $p_bug_id ) . '</a>';
}
# --------------------
# return the name and GET parameters of a bug UPDATE page for the given bug
# account for the user preference and site override
function string_get_bug_update_url( $p_bug_id, $p_user_id = null ) {
return string_get_bug_update_page( $p_user_id ) . '?bug_id=' . $p_bug_id;
}
# --------------------
# return the name of a bug UPDATE page for the user
# account for the user preference and site override
function string_get_bug_update_page( $p_user_id = null ) {
return string_get_bug_page( 'update', $p_user_id );
}
# --------------------
# return an href anchor that links to a bug REPORT page for the given bug
# account for the user preference and site override
function string_get_bug_report_link( $p_user_id = null ) {
return '<a href="' . helper_mantis_url( string_get_bug_report_url( $p_user_id ) ) . '">' . lang_get( 'report_bug_link' ) . '</a>';
}
# --------------------
# return the name and GET parameters of a bug REPORT page for the given bug
# account for the user preference and site override
function string_get_bug_report_url( $p_user_id = null ) {
return string_get_bug_report_page( $p_user_id );
}
# --------------------
# return the name of a bug REPORT page for the user
# account for the user preference and site override
function string_get_bug_report_page( $p_user_id = null ) {
return string_get_bug_page( 'report', $p_user_id );
}
# --------------------
# return the complete url link to checkin using the confirm_hash
function string_get_confirm_hash_url( $p_user_id, $p_confirm_hash ) {
$t_path = config_get( 'path' );
return $t_path . "verify.php?id=" . string_url( $p_user_id ) . "&confirm_hash=" . string_url( $p_confirm_hash );
}
# --------------------
# Return a string with the $p_character pattern repeated N times.
# $p_character - pattern to repeat
# $p_repeats - number of times to repeat.
function string_repeat_char( $p_character, $p_repeats ) {
return str_pad( '', $p_repeats, $p_character );
}
# --------------------
# Format date for display
function string_format_complete_date( $p_date ) {
return date( config_get( 'complete_date_format' ), $p_date );
}
# --------------------
# Shorten a string for display on a dropdown to prevent the page rendering too wide
# ref issues #4630, #5072, #5131
function string_shorten( $p_string, $p_max = null ) {
if( $p_max === null ) {
$t_max = config_get( 'max_dropdown_length' );
} else {
$t_max = (int) $p_max;
}
if( ( $t_max > 0 ) && ( strlen( $p_string ) > $t_max ) ) {
$t_pattern = '/([\s|.|,|\-|_|\/|\?]+)/';
$t_bits = preg_split( $t_pattern, $p_string, -1, PREG_SPLIT_DELIM_CAPTURE );
$t_string = '';
$t_last = $t_bits[count( $t_bits ) - 1];
$t_last_len = strlen( $t_last );
foreach( $t_bits as $t_bit ) {
if(( strlen( $t_string ) + strlen( $t_bit ) + $t_last_len + 3 <= $t_max ) || ( strpos( $t_bit, '.,-/?' ) > 0 ) ) {
$t_string .= $t_bit;
} else {
break;
}
}
$t_string .= '...' . $t_last;
return $t_string;
} else {
return $p_string;
}
}
# --------------------
# Normalize a string by removing leading, trailing and excessive internal spaces
# note a space is used as the pattern instead of '\s' to make it work with UTF-8 strings
function string_normalize( $p_string ) {
return preg_replace( '/ +/', ' ', trim( $p_string ) );
}
# --------------------
# remap a field name to a string name (for sort filter)
function string_get_field_name( $p_string ) {
$t_map = array(
'last_updated' => 'last_update',
'id' => 'email_bug',
);
$t_string = $p_string;
if( isset( $t_map[$p_string] ) ) {
$t_string = $t_map[$p_string];
}
return lang_get_defaulted( $t_string );
}
# --------------------
# Calls htmlentities on the specified string, passing along
# the current charset.
function string_html_entities( $p_string ) {
return htmlentities( $p_string, ENT_COMPAT, 'utf-8' );
}
# --------------------
# Calls htmlspecialchars on the specified string, passing along
# the current charset, if the current PHP version supports it.
function string_html_specialchars( $p_string ) {
# achumakov: @ added to avoid warning output in unsupported codepages
# e.g. 8859-2, windows-1257, Korean, which are treated as 8859-1.
# This is VERY important for Eastern European, Baltic and Korean languages
return preg_replace( "/&(#[0-9]+|[a-z]+);/i", "&$1;", @htmlspecialchars( $p_string, ENT_COMPAT, 'utf-8' ) );
}
# --------------------
# Prepares a string to be used as part of header().
function string_prepare_header( $p_string ) {
$t_string = $p_string;
$t_truncate_pos = strpos( $p_string, "\n" );
if( $t_truncate_pos !== false ) {
$t_string = substr( $t_string, 0, $t_truncate_pos );
}
$t_truncate_pos = strpos( $p_string, "\r" );
if( $t_truncate_pos !== false ) {
$t_string = substr( $t_string, 0, $t_truncate_pos );
}
return $t_string;
}
# --------------------
# Checks the supplied string for scripting characters, if it contains any, then return true, otherwise return false.
function string_contains_scripting_chars( $p_string ) {
if(( strstr( $p_string, '<' ) !== false ) || ( strstr( $p_string, '>' ) !== false ) ) {
return true;
}
return false;
}