/
html_api.php
1933 lines (1678 loc) · 62.4 KB
/
html_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
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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/>.
/**
* HTML API
*
* These functions control the HTML output of each page.
*
* This is the call order of these functions, should you need to figure out
* which to modify or which to leave out:
*
* html_page_top
* html_page_top1
* html_begin
* html_head_begin
* html_content_type
* (Additional META tags: {@see $g_meta_include_file} and {@see robots_meta config})
* html_title
* html_css
* html_rss_link
* html_head_javascript
* (html_meta_redirect)
* html_page_top2
* html_page_top2a
* html_head_end
* html_body_begin
* html_top_banner
* html_login_info
* (print_project_menu_bar)
* print_menu
*
* ...Page content here...
*
* html_page_bottom
* html_page_bottom1
* (print_menu)
* html_page_bottom1a
* html_bottom_banner
* html_footer
* html_body_end
* html_end
*
* @package CoreAPI
* @subpackage HTMLAPI
* @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 authentication_api.php
* @uses bug_api.php
* @uses config_api.php
* @uses constant_inc.php
* @uses current_user_api.php
* @uses database_api.php
* @uses error_api.php
* @uses event_api.php
* @uses file_api.php
* @uses filter_api.php
* @uses filter_constants_inc.php
* @uses form_api.php
* @uses helper_api.php
* @uses lang_api.php
* @uses news_api.php
* @uses php_api.php
* @uses print_api.php
* @uses project_api.php
* @uses rss_api.php
* @uses string_api.php
* @uses user_api.php
* @uses utility_api.php
*/
require_api( 'access_api.php' );
require_api( 'authentication_api.php' );
require_api( 'bug_api.php' );
require_api( 'config_api.php' );
require_api( 'constant_inc.php' );
require_api( 'current_user_api.php' );
require_api( 'database_api.php' );
require_api( 'error_api.php' );
require_api( 'event_api.php' );
require_api( 'file_api.php' );
require_api( 'filter_api.php' );
require_api( 'filter_constants_inc.php' );
require_api( 'form_api.php' );
require_api( 'helper_api.php' );
require_api( 'lang_api.php' );
require_api( 'news_api.php' );
require_api( 'php_api.php' );
require_api( 'print_api.php' );
require_api( 'project_api.php' );
require_api( 'rss_api.php' );
require_api( 'string_api.php' );
require_api( 'user_api.php' );
require_api( 'utility_api.php' );
$g_rss_feed_url = null;
$g_robots_meta = '';
# flag for error handler to skip header menus
$g_error_send_page_header = true;
$g_stylesheets_included = array();
$g_scripts_included = array();
/**
* Sets the url for the rss link associated with the current page.
* null: means no feed (default).
* @param string $p_rss_feed_url RSS feed URL.
* @return void
*/
function html_set_rss_link( $p_rss_feed_url ) {
if( OFF != config_get( 'rss_enabled' ) ) {
global $g_rss_feed_url;
$g_rss_feed_url = $p_rss_feed_url;
}
}
/**
* This method must be called before the html_page_top* methods. It marks the page as not
* for indexing.
* @return void
*/
function html_robots_noindex() {
global $g_robots_meta;
$g_robots_meta = 'noindex,follow';
}
/**
* Prints the link that allows auto-detection of the associated feed.
* @return void
*/
function html_rss_link() {
global $g_rss_feed_url;
if( $g_rss_feed_url !== null ) {
echo '<link rel="alternate" type="application/rss+xml" title="RSS" href="' . string_attribute( $g_rss_feed_url ) . '" />' . "\n";
}
}
/**
* Prints a <script> tag to include a JavaScript file.
* @param string $p_filename Name of JavaScript file (with extension) to include.
* @return void
*/
function html_javascript_link( $p_filename ) {
echo "\t", '<script type="text/javascript" src="', helper_mantis_url( 'js/' . $p_filename ), '"></script>' . "\n";
}
/**
* Defines the top of a HTML page
* @param string $p_page_title Html page title.
* @param string $p_redirect_url URL to redirect to if necessary.
* @return void
*/
function html_page_top( $p_page_title = null, $p_redirect_url = null ) {
html_page_top1( $p_page_title );
if( $p_redirect_url !== null ) {
html_meta_redirect( $p_redirect_url );
}
html_page_top2();
}
/**
* Print the part of the page that comes before meta redirect tags should be inserted
* @param string $p_page_title Page title.
* @return void
*/
function html_page_top1( $p_page_title = null ) {
html_begin();
html_head_begin();
html_content_type();
$t_meta = config_get_global( 'meta_include_file' );
if( !is_blank( $t_meta ) ) {
include( $t_meta );
}
global $g_robots_meta;
if( !is_blank( $g_robots_meta ) ) {
echo "\t", '<meta name="robots" content="', $g_robots_meta, '" />', "\n";
}
html_title( $p_page_title );
html_css();
html_rss_link();
$t_favicon_image = config_get( 'favicon_image' );
if( !is_blank( $t_favicon_image ) ) {
echo "\t", '<link rel="shortcut icon" href="', helper_mantis_url( $t_favicon_image ), '" type="image/x-icon" />', "\n";
}
# Advertise the availability of the browser search plug-ins.
echo "\t", '<link rel="search" type="application/opensearchdescription+xml" title="MantisBT: Text Search" href="' . string_sanitize_url( 'browser_search_plugin.php?type=text', true ) . '" />' . "\n";
echo "\t", '<link rel="search" type="application/opensearchdescription+xml" title="MantisBT: Issue Id" href="' . string_sanitize_url( 'browser_search_plugin.php?type=id', true ) . '" />' . "\n";
html_head_javascript();
}
/**
* Print the part of the page that comes after meta tags, but before the actual page content
* @return void
*/
function html_page_top2() {
html_page_top2a();
if( !db_is_connected() ) {
return;
}
if( auth_is_user_authenticated() ) {
html_login_info();
if( ON == config_get( 'show_project_menu_bar' ) ) {
print_project_menu_bar();
echo '<br />';
}
}
print_menu();
echo '<div id="content">', "\n";
event_signal( 'EVENT_LAYOUT_CONTENT_BEGIN' );
}
/**
* Print the part of the page that comes after meta tags and before the
* actual page content, but without login info or menus. This is used
* directly during the login process and other times when the user may
* not be authenticated
* @return void
*/
function html_page_top2a() {
global $g_error_send_page_header;
html_head_end();
html_body_begin();
$g_error_send_page_header = false;
html_top_banner();
}
/**
* Print the part of the page that comes below the page content
* $p_file should always be the __FILE__ variable. This is passed to show source
* @param string $p_file Should always be the __FILE__ variable. This is passed to show source.
* @return void
*/
function html_page_bottom( $p_file = null ) {
html_page_bottom1( $p_file );
}
/**
* Print the part of the page that comes below the page content
* $p_file should always be the __FILE__ variable. This is passed to show source
* @param string $p_file Should always be the __FILE__ variable. This is passed to show source.
* @return void
*/
function html_page_bottom1( $p_file = null ) {
if( !db_is_connected() ) {
return;
}
event_signal( 'EVENT_LAYOUT_CONTENT_END' );
echo '</div>', "\n";
if( config_get( 'show_footer_menu' ) ) {
echo '<br />';
print_menu();
}
html_page_bottom1a( $p_file );
}
/**
* Print the part of the page that comes below the page content but leave off
* the menu. This is used during the login process and other times when the
* user may not be authenticated.
* @param string $p_file Should always be the __FILE__ variable.
* @return void
*/
function html_page_bottom1a( $p_file = null ) {
if( null === $p_file ) {
$p_file = basename( $_SERVER['SCRIPT_NAME'] );
}
error_print_delayed();
html_bottom_banner();
html_footer();
html_body_end();
html_end();
}
/**
* (1) Print the document type and the opening <html> tag
* @return void
*/
function html_begin() {
echo '<!DOCTYPE html>', "\n";
echo '<html>', "\n";
}
/**
* (2) Begin the <head> section
* @return void
*/
function html_head_begin() {
echo '<head>', "\n";
}
/**
* (3) Print the content-type
* @return void
*/
function html_content_type() {
echo "\t", '<meta http-equiv="Content-type" content="text/html; charset=utf-8" />', "\n";
}
/**
* (4) Print the window title
* @param string $p_page_title Window title.
* @return void
*/
function html_title( $p_page_title = null ) {
$t_page_title = string_html_specialchars( $p_page_title );
$t_title = string_html_specialchars( config_get( 'window_title' ) );
echo "\t", '<title>';
if( empty( $t_page_title ) ) {
echo $t_title;
} else {
if( empty( $t_title ) ) {
echo $t_page_title;
} else {
echo $t_page_title . ' - ' . $t_title;
}
}
echo '</title>', "\n";
}
/**
* Require a CSS file to be in html page headers
* @param string $p_stylesheet_path Path to CSS style sheet.
* @return void
*/
function require_css( $p_stylesheet_path ) {
global $g_stylesheets_included;
$g_stylesheets_included[$p_stylesheet_path] = $p_stylesheet_path;
}
/**
* (5) Print the link to include the CSS file
* @return void
*/
function html_css() {
global $g_stylesheets_included;
html_css_link( config_get( 'css_include_file' ) );
if ( config_get_global( 'cdn_enabled' ) == ON ) {
echo '<link rel="stylesheet" href="https://ajax.googleapis.com/ajax/libs/jqueryui/' . JQUERY_UI_VERSION . '/themes/smoothness/jquery-ui.css">' . "\n";
} else {
html_css_link( 'jquery-ui-' . JQUERY_UI_VERSION . '.min.css' );
}
html_css_link( 'common_config.php' );
# Add right-to-left css if needed
if( lang_get( 'directionality' ) == 'rtl' ) {
html_css_link( config_get( 'css_rtl_include_file' ) );
}
foreach( $g_stylesheets_included as $t_stylesheet_path ) {
html_css_link( $t_stylesheet_path );
}
}
/**
* Prints a CSS link
* @param string $p_filename Filename.
* @return void
*/
function html_css_link( $p_filename ) {
echo "\t", '<link rel="stylesheet" type="text/css" href="', string_sanitize_url( helper_mantis_url( 'css/' . $p_filename ), true ), '" />' . "\n";
}
/**
* (6) Print an HTML meta tag to redirect to another page
* This function is optional and may be called by pages that need a redirect.
* $p_time is the number of seconds to wait before redirecting.
* If we have handled any errors on this page return false and don't redirect.
*
* @param string $p_url The page to redirect: has to be a relative path.
* @param integer $p_time Seconds to wait for before redirecting.
* @param boolean $p_sanitize Apply string_sanitize_url to passed URL.
* @return boolean
*/
function html_meta_redirect( $p_url, $p_time = null, $p_sanitize = true ) {
if( ON == config_get_global( 'stop_on_errors' ) && error_handled() ) {
return false;
}
if( null === $p_time ) {
$p_time = current_user_get_pref( 'redirect_delay' );
}
$t_url = config_get( 'path' );
if( $p_sanitize ) {
$t_url .= string_sanitize_url( $p_url );
} else {
$t_url .= $p_url;
}
$t_url = htmlspecialchars( $t_url );
echo "\t" . '<meta http-equiv="Refresh" content="' . $p_time . ';URL=' . $t_url . '" />' . "\n";
return true;
}
/**
* Require a javascript file to be in html page headers
* @param string $p_script_path Path to javascript file.
* @return void
*/
function require_js( $p_script_path ) {
global $g_scripts_included;
$g_scripts_included[$p_script_path] = $p_script_path;
}
/**
* (6a) Javascript...
* @return void
*/
function html_head_javascript() {
global $g_scripts_included;
echo "\t" . '<script type="text/javascript" src="' . helper_mantis_url( 'javascript_config.php' ) . '"></script>' . "\n";
echo "\t" . '<script type="text/javascript" src="' . helper_mantis_url( 'javascript_translations.php' ) . '"></script>' . "\n";
if ( config_get_global( 'cdn_enabled' ) == ON ) {
echo "\t" . '<script src="https://ajax.googleapis.com/ajax/libs/jquery/' . JQUERY_VERSION . '/jquery.min.js"></script>' . "\n";
echo "\t" . '<script src="https://ajax.googleapis.com/ajax/libs/jqueryui/' . JQUERY_UI_VERSION . '/jquery-ui.min.js"></script>' . "\n";
} else {
html_javascript_link( 'jquery-' . JQUERY_VERSION . '.min.js' );
html_javascript_link( 'jquery-ui-' . JQUERY_UI_VERSION . '.min.js' );
}
html_javascript_link( 'common.js' );
foreach ( $g_scripts_included as $t_script_path ) {
html_javascript_link( $t_script_path );
}
}
/**
* (7) End the <head> section
* @return void
*/
function html_head_end() {
event_signal( 'EVENT_LAYOUT_RESOURCES' );
echo '</head>', "\n";
}
/**
* (8) Begin the <body> section
* @return void
*/
function html_body_begin() {
$t_centered_page = is_page_name( 'login_page' ) || is_page_name( 'signup_page' ) || is_page_name( 'signup' ) || is_page_name( 'lost_pwd_page' );
echo '<body>', "\n";
if( $t_centered_page ) {
echo '<div id="mantis" class="centered_page">', "\n";
} else {
echo '<div id="mantis">', "\n";
}
event_signal( 'EVENT_LAYOUT_BODY_BEGIN' );
}
/**
* (9) Print a user-defined banner at the top of the page if there is one.
* @return void
*/
function html_top_banner() {
$t_page = config_get( 'top_include_page' );
$t_logo_image = config_get( 'logo_image' );
$t_logo_url = config_get( 'logo_url' );
if( is_blank( $t_logo_image ) ) {
$t_show_logo = false;
} else {
$t_show_logo = true;
if( is_blank( $t_logo_url ) ) {
$t_show_url = false;
} else {
$t_show_url = true;
}
}
if( !is_blank( $t_page ) && file_exists( $t_page ) && !is_dir( $t_page ) ) {
include( $t_page );
} else if( $t_show_logo ) {
echo '<div id="banner">';
if( $t_show_url ) {
echo '<a id="logo-link" href="', config_get( 'logo_url' ), '">';
}
$t_alternate_text = string_html_specialchars( config_get( 'window_title' ) );
echo '<img id="logo-image" alt="', $t_alternate_text, '" src="' . helper_mantis_url( $t_logo_image ) . '" />';
if( $t_show_url ) {
echo '</a>';
}
echo '</div>';
}
event_signal( 'EVENT_LAYOUT_PAGE_HEADER' );
}
/**
* (10) Print the user's account information
* Also print the select box where users can switch projects
* @return void
*/
function html_login_info() {
$t_username = current_user_get_field( 'username' );
$t_access_level = get_enum_element( 'access_levels', current_user_get_access_level() );
$t_now = date( config_get( 'complete_date_format' ) );
$t_realname = current_user_get_field( 'realname' );
echo '<div class="info-bar">' . "\n";
# Login information
echo '<div id="login-info">' . "\n";
if( current_user_is_anonymous() ) {
$t_return_page = $_SERVER['SCRIPT_NAME'];
if( isset( $_SERVER['QUERY_STRING'] ) ) {
$t_return_page .= '?' . $_SERVER['QUERY_STRING'];
}
$t_return_page = string_url( $t_return_page );
echo "\t" . '<span id="logged-anon-label">' . lang_get( 'anonymous' ) . '</span>' . "\n";
echo "\t" . '<span id="login-link"><a href="' . helper_mantis_url( 'login_page.php?return=' . $t_return_page ) . '">' . lang_get( 'login_link' ) . '</a></span>' . "\n";
if( config_get_global( 'allow_signup' ) == ON ) {
echo "\t" . '<span id="signup-link"><a href="' . helper_mantis_url( 'signup_page.php' ) . '">' . lang_get( 'signup_link' ) . '</a></span>' . "\n";
}
} else {
echo "\t" . '<span id="logged-in-label">' . lang_get( 'logged_in_as' ) . '</span>' . "\n";
echo "\t" . '<span id="logged-in-user">' . string_html_specialchars( $t_username ) . '</span>' . "\n";
echo "\t" . '<span id="logged-in">';
echo !is_blank( $t_realname ) ? "\t" . '<span id="logged-in-realname">' . string_html_specialchars( $t_realname ) . '</span>' . "\n" : '';
echo "\t" . '<span id="logged-in-accesslevel" class="' . $t_access_level . '">' . $t_access_level . '</span>' . "\n";
echo "\t" . '</span>' . "\n";
}
echo '</div>' . "\n";
# RSS feed
if( OFF != config_get( 'rss_enabled' ) ) {
echo '<div id="rss-feed">' . "\n";
# Link to RSS issues feed for the selected project, including authentication details.
echo "\t" . '<a href="' . htmlspecialchars( rss_get_issues_feed_url() ) . '">' . "\n";
echo "\t" . '<img src="' . helper_mantis_url( 'images/rss.png' ) . '" alt="' . lang_get( 'rss' ) . '" title="' . lang_get( 'rss' ) . '" />' . "\n";
echo "\t" . '</a>' . "\n";
echo '</div>' . "\n";
}
# Project Selector (hidden if only one project visisble to user)
$t_show_project_selector = true;
$t_project_ids = current_user_get_accessible_projects();
if( count( $t_project_ids ) == 1 ) {
$t_project_id = (int)$t_project_ids[0];
if( count( current_user_get_accessible_subprojects( $t_project_id ) ) == 0 ) {
$t_show_project_selector = false;
}
}
if( $t_show_project_selector ) {
echo '<div id="project-selector-div">';
echo '<form method="post" id="form-set-project" action="' . helper_mantis_url( 'set_project.php' ) . '">';
echo '<fieldset id="project-selector">';
# CSRF protection not required here - form does not result in modifications
echo '<label for="form-set-project-id">' . lang_get( 'email_project' ) . '</label>';
echo '<select id="form-set-project-id" name="project_id">';
print_project_option_list( join( ';', helper_get_current_project_trace() ), true, null, true );
echo '</select> ';
echo '<input type="submit" class="button" value="' . lang_get( 'switch' ) . '" />';
echo '</fieldset>';
echo '</form>';
echo '</div>';
} else {
# User has only one project, set it as both current and default
if( ALL_PROJECTS == helper_get_current_project() ) {
helper_set_current_project( $t_project_id );
if( !current_user_is_protected() ) {
current_user_set_default_project( $t_project_id );
}
# Force reload of current page, except if we got here after
# creating the first project
$t_redirect_url = str_replace( config_get( 'short_path' ), '', $_SERVER['REQUEST_URI'] );
if( 'manage_proj_create.php' != $t_redirect_url ) {
html_meta_redirect( $t_redirect_url, 0, false );
}
}
}
# Current time
echo '<div id="current-time">' . $t_now . '</div>';
echo '</div>' . "\n";
}
/**
* (11) Print a user-defined banner at the bottom of the page if there is one.
* @return void
*/
function html_bottom_banner() {
$t_page = config_get( 'bottom_include_page' );
if( !is_blank( $t_page ) && file_exists( $t_page ) && !is_dir( $t_page ) ) {
include( $t_page );
}
}
/**
* A function that outputs that an operation was successful and provides a redirect link.
* @param string $p_redirect_url The url to redirect to.
* @param string $p_message Message to display to the user.
* @return void
*/
function html_operation_successful( $p_redirect_url, $p_message = '' ) {
echo '<div class="success-msg">';
if( !is_blank( $p_message ) ) {
echo $p_message . '<br />';
}
echo lang_get( 'operation_successful' ).'<br />';
print_bracket_link( $p_redirect_url, lang_get( 'proceed' ) );
echo '</div>';
}
/**
* Checks if the current page load was triggered by auto-refresh or real activity
* @return bool true: auto-refresh, false: triggered by user.
*/
function html_is_auto_refresh() {
return gpc_get_bool( 'refresh' );
}
/**
* (13) Print the page footer information
* @return void
*/
function html_footer() {
global $g_queries_array, $g_request_time;
# If a user is logged in, update their last visit time.
# We do this at the end of the page so that:
# 1) we can display the user's last visit time on a page before updating it
# 2) we don't invalidate the user cache immediately after fetching it
# 3) don't do this on the password verification or update page, as it causes the
# verification comparison to fail
# 4) don't do that on pages that auto-refresh (View Issues page).
if( auth_is_user_authenticated() &&
!current_user_is_anonymous() &&
!( is_page_name( 'verify.php' ) || is_page_name( 'account_update.php' ) ) &&
!html_is_auto_refresh() ) {
$t_user_id = auth_get_current_user_id();
user_update_last_visit( $t_user_id );
}
echo '<div id="footer">' . "\n";
echo '<hr />' . "\n";
# We don't have a button anymore, so for now we will only show the resized
# version of the logo when not on login page.
if( !is_page_name( 'login_page' ) ) {
echo "\t" . '<div id="powered-by-mantisbt-logo">' . "\n";
$t_mantisbt_logo_url = helper_mantis_url( 'images/mantis_logo.png' );
echo "\t\t" . '<a href="http://www.mantisbt.org"
title="Mantis Bug Tracker: a free and open source web based bug tracking system.">
<img src="' . $t_mantisbt_logo_url . '" width="102" height="35"
alt="Powered by Mantis Bug Tracker: a free and open source web based bug tracking system." />
</a>' . "\n";
echo "\t" . '</div>' . "\n";
}
# Show MantisBT version and copyright statement
$t_version_suffix = '';
$t_copyright_years = ' 2000 - ' . date( 'Y' );
if( config_get( 'show_version' ) == ON ) {
$t_version_suffix = ' ' . htmlentities( MANTIS_VERSION . config_get_global( 'version_suffix' ) );
}
echo '<address id="mantisbt-copyright">' . "\n";
echo '<address id="version">Powered by <a href="http://www.mantisbt.org" title="bug tracking software">MantisBT ' . $t_version_suffix . "</a></address>\n";
echo 'Copyright ©' . $t_copyright_years . ' MantisBT Team';
# Show optional user-specified custom copyright statement
$t_copyright_statement = config_get( 'copyright_statement' );
if( $t_copyright_statement ) {
echo "\t" . '<address id="user-copyright">' . $t_copyright_statement . '</address>' . "\n";
}
echo '</address>' . "\n";
# Show contact information
if( !is_page_name( 'login_page' ) ) {
$t_webmaster_email = config_get( 'webmaster_email' );
if( !is_blank( $t_webmaster_email ) ) {
$t_webmaster_contact_information = sprintf( lang_get( 'webmaster_contact_information' ), string_html_specialchars( $t_webmaster_email ) );
echo "\t" . '<address id="webmaster-contact-information">' . $t_webmaster_contact_information . '</address>' . "\n";
}
}
event_signal( 'EVENT_LAYOUT_PAGE_FOOTER' );
# Print horizontal rule if any debugging statistics follow
if( config_get( 'show_timer' ) || config_get( 'show_memory_usage' ) || config_get( 'show_queries_count' ) ) {
echo "\t" . '<hr />' . "\n";
}
# Print the page execution time
if( config_get( 'show_timer' ) ) {
$t_page_execution_time = sprintf( lang_get( 'page_execution_time' ), number_format( microtime( true ) - $g_request_time, 4 ) );
echo "\t" . '<p id="page-execution-time">' . $t_page_execution_time . '</p>' . "\n";
}
# Print the page memory usage
if( config_get( 'show_memory_usage' ) ) {
$t_page_memory_usage = sprintf( lang_get( 'memory_usage_in_kb' ), number_format( memory_get_peak_usage() / 1024 ) );
echo "\t" . '<p id="page-memory-usage">' . $t_page_memory_usage . '</p>' . "\n";
}
# Determine number of unique queries executed
if( config_get( 'show_queries_count' ) ) {
$t_total_queries_count = count( $g_queries_array );
$t_unique_queries_count = 0;
$t_total_query_execution_time = 0;
$t_unique_queries = array();
for( $i = 0; $i < $t_total_queries_count; $i++ ) {
if( !in_array( $g_queries_array[$i][0], $t_unique_queries ) ) {
$t_unique_queries_count++;
$g_queries_array[$i][3] = false;
array_push( $t_unique_queries, $g_queries_array[$i][0] );
} else {
$g_queries_array[$i][3] = true;
}
$t_total_query_execution_time += $g_queries_array[$i][1];
}
$t_total_queries_executed = sprintf( lang_get( 'total_queries_executed' ), $t_total_queries_count );
echo "\t" . '<p id="total-queries-count">' . $t_total_queries_executed . '</p>' . "\n";
if( config_get_global( 'db_log_queries' ) ) {
$t_unique_queries_executed = sprintf( lang_get( 'unique_queries_executed' ), $t_unique_queries_count );
echo "\t" . '<p id="unique-queries-count">' . $t_unique_queries_executed . '</p>' . "\n";
}
$t_total_query_time = sprintf( lang_get( 'total_query_execution_time' ), $t_total_query_execution_time );
echo "\t" . '<p id="total-query-execution-time">' . $t_total_query_time . '</p>' . "\n";
}
# Print table of log events
log_print_to_page();
echo '</div>' . "\n";
}
/**
* (14) End the <body> section
* @return void
*/
function html_body_end() {
# Should code need to be added to this function in the future, it should be
# placed *above* this event, which needs to be the last thing to occur
# before the actual body ends (see #20084)
event_signal( 'EVENT_LAYOUT_BODY_END' );
echo '</div>', "\n";
echo '</body>', "\n";
}
/**
* (15) Print the closing <html> tag
* @return void
*/
function html_end() {
echo '</html>', "\n";
if( function_exists( 'fastcgi_finish_request' ) ) {
fastcgi_finish_request();
}
}
/**
* Prepare an array of additional menu options from a configuration variable
* @param string $p_config Configuration variable name.
* @return array
*/
function prepare_custom_menu_options( $p_config ) {
$t_custom_menu_options = config_get( $p_config );
$t_options = array();
foreach( $t_custom_menu_options as $t_custom_option ) {
$t_access_level = $t_custom_option[1];
if( access_has_project_level( $t_access_level ) ) {
$t_caption = string_html_specialchars( lang_get_defaulted( $t_custom_option[0] ) );
$t_link = string_attribute( $t_custom_option[2] );
$t_options[] = '<a href="' . $t_link . '">' . $t_caption . '</a>';
}
}
return $t_options;
}
/**
* Print the main menu
* @return void
*/
function print_menu() {
if( auth_is_user_authenticated() ) {
$t_protected = current_user_get_field( 'protected' );
$t_current_project = helper_get_current_project();
$t_menu_options = array();
# Main Page
if( config_get( 'news_enabled' ) == ON ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'main_page.php' ) . '">' . lang_get( 'main_link' ) . '</a>';
}
# Plugin / Event added options
$t_event_menu_options = event_signal( 'EVENT_MENU_MAIN_FRONT' );
foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) {
foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) {
if( is_array( $t_callback_menu_options ) ) {
$t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options );
} else {
if( !is_null( $t_callback_menu_options ) ) {
$t_menu_options[] = $t_callback_menu_options;
}
}
}
}
# My View
$t_menu_options[] = '<a href="' . helper_mantis_url( 'my_view_page.php">' ) . lang_get( 'my_view_link' ) . '</a>';
# View Bugs
$t_menu_options[] = '<a href="' . helper_mantis_url( 'view_all_bug_page.php">' ) . lang_get( 'view_bugs_link' ) . '</a>';
# Report Bugs
if( access_has_project_level( config_get( 'report_bug_threshold' ) ) ) {
$t_menu_options[] = string_get_bug_report_link();
}
# Changelog Page
if( access_has_project_level( config_get( 'view_changelog_threshold' ) ) ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'changelog_page.php">' ) . lang_get( 'changelog_link' ) . '</a>';
}
# Roadmap Page
if( access_has_project_level( config_get( 'roadmap_view_threshold' ) ) ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'roadmap_page.php">' ) . lang_get( 'roadmap_link' ) . '</a>';
}
# Summary Page
if( access_has_project_level( config_get( 'view_summary_threshold' ) ) ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'summary_page.php">' ) . lang_get( 'summary_link' ) . '</a>';
}
# Project Documentation Page
if( ON == config_get( 'enable_project_documentation' ) ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'proj_doc_page.php">' ) . lang_get( 'docs_link' ) . '</a>';
}
# Project Wiki
if( config_get_global( 'wiki_enable' ) == ON ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'wiki.php?type=project&id=' ) . $t_current_project . '">' . lang_get( 'wiki' ) . '</a>';
}
# Plugin / Event added options
$t_event_menu_options = event_signal( 'EVENT_MENU_MAIN' );
foreach( $t_event_menu_options as $t_plugin => $t_plugin_menu_options ) {
foreach( $t_plugin_menu_options as $t_callback => $t_callback_menu_options ) {
if( is_array( $t_callback_menu_options ) ) {
$t_menu_options = array_merge( $t_menu_options, $t_callback_menu_options );
} else {
if( !is_null( $t_callback_menu_options ) ) {
$t_menu_options[] = $t_callback_menu_options;
}
}
}
}
# Manage Users (admins) or Manage Project (managers) or Manage Custom Fields
if( access_has_global_level( config_get( 'manage_site_threshold' ) ) ) {
$t_link = helper_mantis_url( 'manage_overview_page.php' );
$t_menu_options[] = '<a class="manage-menu-link" href="' . $t_link . '">' . lang_get( 'manage_link' ) . '</a>';
} else {
$t_show_access = min( config_get( 'manage_user_threshold' ), config_get( 'manage_project_threshold' ), config_get( 'manage_custom_fields_threshold' ) );
if( access_has_global_level( $t_show_access ) || access_has_any_project( $t_show_access ) ) {
$t_current_project = helper_get_current_project();
if( access_has_global_level( config_get( 'manage_user_threshold' ) ) ) {
$t_link = helper_mantis_url( 'manage_user_page.php' );
} else {
if( access_has_project_level( config_get( 'manage_project_threshold' ), $t_current_project ) && ( $t_current_project <> ALL_PROJECTS ) ) {
$t_link = helper_mantis_url( 'manage_proj_edit_page.php?project_id=' ) . $t_current_project;
} else {
$t_link = helper_mantis_url( 'manage_proj_page.php' );
}
}
$t_menu_options[] = '<a href="' . $t_link . '">' . lang_get( 'manage_link' ) . '</a>';
}
}
# News Page
if( news_is_enabled() && access_has_project_level( config_get( 'manage_news_threshold' ) ) ) {
# Admin can edit news for All Projects (site-wide)
if( ALL_PROJECTS != helper_get_current_project() || current_user_is_administrator() ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'news_menu_page.php">' ) . lang_get( 'edit_news_link' ) . '</a>';
} else {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'login_select_proj_page.php">' ) . lang_get( 'edit_news_link' ) . '</a>';
}
}
# Account Page (only show accounts that are NOT protected)
if( OFF == $t_protected ) {
$t_menu_options[] = '<a class="account-menu-link" href="' . helper_mantis_url( 'account_page.php">' ) . lang_get( 'account_link' ) . '</a>';
}
# Add custom options
$t_custom_options = prepare_custom_menu_options( 'main_menu_custom_options' );
$t_menu_options = array_merge( $t_menu_options, $t_custom_options );
# Time Tracking / Billing
if( config_get( 'time_tracking_enabled' ) && access_has_project_level( config_get( 'time_tracking_reporting_threshold' ) ) ) {
$t_menu_options[] = '<a href="' . helper_mantis_url( 'billing_page.php">' ) . lang_get( 'time_tracking_billing_link' ) . '</a>';
}
# Logout (no if anonymously logged in)
if( !current_user_is_anonymous() ) {
$t_menu_options[] = '<a id="logout-link" href="' . helper_mantis_url( 'logout_page.php">' ) . lang_get( 'logout_link' ) . '</a>';
}
# Display main menu
echo "\n" . '<div class="main-menu">'. "\n";
# Menu items
echo '<ul id="menu-items">' . "\n";
echo "\t" . '<li>' . implode( $t_menu_options, '</li>' . "\n\t" . '<li>' ) . '</li>' . "\n";
echo '</ul>' . "\n";
# Bug Jump form
echo '<div id="bug-jump" >';
echo '<form method="post" class="bug-jump-form" action="' . helper_mantis_url( 'jump_to_bug.php' ) . '">';
echo '<fieldset class="bug-jump">';
# CSRF protection not required here - form does not result in modifications
echo '<input type="hidden" name="bug_label" value="' . lang_get( 'issue_id' ) . '" />';
echo '<input type="text" name="bug_id" size="8" /> ';
echo '<input type="submit" value="' . lang_get( 'jump' ) . '" /> ';
echo '</fieldset>';
echo '</form>';
echo '</div>' . "\n";
echo '</div>' . "\n";
}
}
/**
* Print the menu bar with a list of projects to which the user has access
* @return void
*/
function print_project_menu_bar() {
$t_project_ids = current_user_get_accessible_projects();
echo '<table class="width100" cellspacing="0">';
echo '<tr>';
echo '<td class="menu">';
echo '<a href="' . helper_mantis_url( 'set_project.php?project_id=' . ALL_PROJECTS ) . '">' . lang_get( 'all_projects' ) . '</a>';
foreach( $t_project_ids as $t_id ) {
echo ' | <a href="' . helper_mantis_url( 'set_project.php?project_id=' . $t_id ) . '">' . string_html_specialchars( project_get_field( $t_id, 'name' ) ) . '</a>';
print_subproject_menu_bar( $t_id, $t_id . ';' );
}
echo '</td>';
echo '</tr>';