/
html_api.php
1309 lines (1161 loc) · 40.5 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.
*
*
* @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
* @uses layout_api.php
* @uses api_token_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' );
require_api( 'layout_api.php' );
require_api( 'api_token_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 marks the page as not for indexing by search engines
* @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";
}
/**
* Prints a <script> tag to include a JavaScript file.
* @param string $p_url fully qualified domain name for the cdn js file
* @param string $p_hash resource hash to perform subresource integrity check
* @return void
*/
function html_javascript_cdn_link( $p_url, $p_hash = '' ) {
$t_integrity = '';
if( $p_hash !== '' ) {
$t_integrity = 'integrity="' . $p_hash . '" ';
}
echo "\t", '<script type="text/javascript" src="', $p_url, '" ', $t_integrity, 'crossorigin="anonymous"></script>', "\n";
}
/**
* Print the document type and the opening <html> tag
* @return void
*/
function html_begin() {
echo '<!DOCTYPE html>', "\n";
echo '<html>', "\n";
}
/**
* Begin the <head> section
* @return void
*/
function html_head_begin() {
echo '<head>', "\n";
}
/**
* Print the content-type
* @return void
*/
function html_content_type() {
echo "\t", '<meta http-equiv="Content-type" content="text/html; charset=utf-8" />', "\n";
}
/**
* 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;
}
/**
* Print the link to include the CSS file
* @return void
*/
function html_css() {
global $g_stylesheets_included;
html_css_link( config_get_global( 'css_include_file' ) );
# Add right-to-left css if needed
if( lang_get( 'directionality' ) == 'rtl' ) {
html_css_link( config_get_global( 'css_rtl_include_file' ) );
}
foreach( $g_stylesheets_included as $t_stylesheet_path ) {
# status_config.php is a special css file, dynamically generated.
# Add a hash to the query string to differentiate content based on its
# relevant properties. This allows a browser to cache them separately and force
# a reload when the content may differ.
if( $t_stylesheet_path == 'status_config.php' ) {
$t_stylesheet_path = helper_url_combine(
helper_mantis_url( 'css/status_config.php' ),
'cache_key=' . helper_generate_cache_key( array( 'user' ) )
);
}
html_css_link( $t_stylesheet_path );
}
# dropzone css
if ( config_get_global( 'cdn_enabled' ) == ON ) {
html_css_cdn_link( 'https://cdnjs.cloudflare.com/ajax/libs/dropzone/' . DROPZONE_VERSION . '/min/dropzone.min.css' );
} else {
html_css_link( 'dropzone-' . DROPZONE_VERSION . '.min.css' );
}
}
/**
* Prints a CSS link
* @param string $p_filename Filename.
* @return void
*/
function html_css_link( $p_filename ) {
# If no path is specified, look for CSS files in default directory
if( $p_filename == basename( $p_filename ) ) {
$p_filename = 'css/' . $p_filename;
}
echo "\t", '<link rel="stylesheet" type="text/css" href="', string_sanitize_url( helper_mantis_url( $p_filename ), true ), '" />', "\n";
}
/**
* Prints a CSS link for CDN
* @param string $p_url fully qualified domain name to the js file name
* @param string $p_hash resource hash to perform subresource integrity check
* @return void
*/
function html_css_cdn_link( $p_url, $p_hash = '' ) {
$t_integrity = '';
if( $p_hash !== '' ) {
$t_integrity = 'integrity="' . $p_hash . '" ';
}
echo "\t", '<link rel="stylesheet" type="text/css" href="', $p_url, '" ', $t_integrity, ' crossorigin="anonymous" />', "\n";
}
/**
* 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_global( '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;
}
/**
* Javascript...
* @return void
*/
function html_head_javascript() {
global $g_scripts_included;
# Add a hash to the query string to differentiate content based on its
# relevant properties. This allows a browser to cache them separately and force
# a reload when the content may differ.
$t_javascript_translations = helper_url_combine(
helper_mantis_url( 'javascript_translations.php' ),
'cache_key=' . helper_generate_cache_key( array( 'lang' ) )
);
$t_javascript_config = helper_url_combine(
helper_mantis_url( 'javascript_config.php' ),
'cache_key=' . helper_generate_cache_key( array( 'user' ) )
);
echo "\t" . '<script type="text/javascript" src="' . $t_javascript_config . '"></script>' . "\n";
echo "\t" . '<script type="text/javascript" src="' . $t_javascript_translations . '"></script>' . "\n";
if ( config_get_global( 'cdn_enabled' ) == ON ) {
# JQuery
html_javascript_cdn_link( 'https://ajax.googleapis.com/ajax/libs/jquery/' . JQUERY_VERSION . '/jquery.min.js', JQUERY_HASH );
# Dropzone
html_javascript_cdn_link( 'https://cdnjs.cloudflare.com/ajax/libs/dropzone/' . DROPZONE_VERSION . '/min/dropzone.min.js', DROPZONE_HASH );
} else {
# JQuery
html_javascript_link( 'jquery-' . JQUERY_VERSION . '.min.js' );
# Dropzone
html_javascript_link( 'dropzone-' . DROPZONE_VERSION . '.min.js' );
}
html_javascript_link( 'common.js' );
foreach ( $g_scripts_included as $t_script_path ) {
html_javascript_link( $t_script_path );
}
}
/**
* End the <head> section
* @return void
*/
function html_head_end() {
echo '</head>', "\n";
}
/**
* Prints the logo with an URL link.
* @param string $p_logo Path to the logo image. If not specified, will get it
* from $g_logo_image
* @return void
*/
function html_print_logo( $p_logo = null ) {
if( !$p_logo ) {
$p_logo = config_get( 'logo_image' );
}
if( !is_blank( $p_logo ) ) {
$t_logo_url = config_get_global( 'logo_url' );
$t_show_url = !is_blank( $t_logo_url );
if( $t_show_url ) {
echo '<a id="logo-link" href="', config_get_global( 'logo_url' ), '">';
}
$t_alternate_text = string_html_specialchars( config_get( 'window_title' ) );
echo '<img id="logo-image" alt="', $t_alternate_text, '" style="max-height: 80px;" src="' . helper_mantis_url( $p_logo ) . '" />';
if( $t_show_url ) {
echo '</a>';
}
}
}
/**
* 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_global( 'top_include_page' );
$t_logo_image = config_get( 'logo_image' );
if( !is_blank( $t_page ) && file_exists( $t_page ) && !is_dir( $t_page ) ) {
include( $t_page );
} else if( !is_blank( $t_logo_image ) ) {
echo '<div id="banner">';
html_print_logo( $t_logo_image );
echo '</div>';
}
event_signal( 'EVENT_LAYOUT_PAGE_HEADER' );
}
/**
* Outputs a message to confirm an operation's result.
* @param array $p_buttons Array of (URL, label) pairs used to generate
* the buttons; if label is null or unspecified,
* the default 'proceed' text will be displayed;
* If the array is empty or not provided, no
* buttons will be printed.
* @param string $p_message Message to display to the user. If none is
* provided, a default message will be printed
* @param integer $p_type One of the constants CONFIRMATION_TYPE_SUCCESS,
* CONFIRMATION_TYPE_WARNING, CONFIRMATION_TYPE_FAILURE
* @return void
*/
function html_operation_confirmation( array $p_buttons = null, $p_message = '', $p_type = CONFIRMATION_TYPE_SUCCESS ) {
switch( $p_type ) {
case CONFIRMATION_TYPE_FAILURE:
$t_alert_css = 'alert-danger';
$t_message = 'operation_failed';
break;
case CONFIRMATION_TYPE_WARNING:
$t_alert_css = 'alert-warning';
$t_message = 'operation_warnings';
break;
case CONFIRMATION_TYPE_SUCCESS:
default:
$t_alert_css = 'alert-success';
$t_message = 'operation_successful';
break;
}
echo '<div class="container-fluid">';
echo '<div class="col-md-12 col-xs-12">';
echo '<div class="space-0"></div>';
echo '<div class="alert ' . $t_alert_css . ' center">';
# Print message
if( is_blank( $p_message ) ) {
$t_message = lang_get( $t_message );
} else {
$t_message = $p_message;
}
echo '<p class="bold bigger-110">' . $t_message . '</p>';
# Print buttons
if( !empty( $p_buttons ) ) {
echo '<br />';
echo '<div class="btn-group">';
foreach( $p_buttons as $t_button ) {
$t_url = string_sanitize_url( $t_button[0] );
$t_label = isset( $t_button[1] ) ? $t_button[1] : lang_get( 'proceed' );
print_link_button( $t_url, $t_label );
}
echo '</div>';
}
echo '</div></div></div>', PHP_EOL;
}
/**
* Outputs an operation successful message with a single 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 = '' ) {
html_operation_confirmation( array( array( $p_redirect_url ) ), $p_message );
}
/**
* Outputs a warning message with a single 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_warning( $p_redirect_url, $p_message = '' ) {
html_operation_confirmation(
array( array( $p_redirect_url ) ),
$p_message,
CONFIRMATION_TYPE_WARNING
);
}
/**
* Outputs an error message with a single 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_failure( $p_redirect_url, $p_message = '' ) {
html_operation_confirmation(
array( array( $p_redirect_url ) ),
$p_message,
CONFIRMATION_TYPE_FAILURE
);
}
/**
* 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 '</body>', "\n";
}
/**
* Print the closing <html> tag
* @return void
*/
function html_end() {
echo '</html>', "\n";
if( function_exists( 'fastcgi_finish_request' ) ) {
fastcgi_finish_request();
}
}
/**
* Print the menu bar with a list of projects to which the user has access
*
* @see $g_show_project_menu_bar
*
* @return void
*/
function print_project_menu_bar() {
$t_project_ids = current_user_get_accessible_projects();
$t_current_project_id = helper_get_current_project();
$t_button_classes = 'btn btn-xs btn-white btn-info';
echo '<div class="col-md-12 col-xs-12">' . "\n";
echo '<div class="btn-group">' . "\n";
echo project_link_for_menu(
ALL_PROJECTS,
$t_current_project_id == ALL_PROJECTS,
$t_button_classes
);
echo "\n";
foreach( $t_project_ids as $t_id ) {
echo project_link_for_menu(
$t_id,
$t_current_project_id == $t_id,
$t_button_classes
);
echo "\n";
print_subproject_menu_bar( $t_current_project_id, $t_id, array( $t_id ) );
}
echo '</div>' . "\n";
echo '<div class="space-4"></div>' . "\n";
echo '</div>' . "\n";
}
/**
* Print the menu bar with a list of subprojects to which the user has access
*
* @param integer $p_current_project_id Selected project id.
* @param integer $p_parent_project_id Parent project id.
* @param array $p_parents Parent project identifiers.
*
* @return void
*/
function print_subproject_menu_bar( $p_current_project_id, $p_parent_project_id, array $p_parents = array() ) {
$t_subprojects = current_user_get_accessible_subprojects( $p_parent_project_id );
foreach( $t_subprojects as $t_subproject_id ) {
echo project_link_for_menu(
$t_subproject_id,
$t_subproject_id == $p_current_project_id,
'btn btn-xs btn-white btn-info',
$p_parents,
icon_get( 'fa-angle-double-right', 'ace-icon' )
);
echo "\n";
# Recursive call to render this subproject's subprojects
print_subproject_menu_bar(
$p_current_project_id,
$t_subproject_id,
array_merge( $p_parents, array( $t_subproject_id) )
);
}
}
/**
* Print a generic menu (tabs).
*
* @param array $p_menu_items List of menu items
* @param string $p_current_page Current page's file name to highlight active tab
* @param string $p_event Optional event to signal,
*/
function print_menu( array $p_menu_items, $p_current_page = '', $p_event = null ) {
echo '<ul class="nav nav-tabs padding-18">' . "\n";
foreach( $p_menu_items as $t_item ) {
$t_active = $p_current_page && strpos( $t_item['url'], $p_current_page ) !== false ? 'active' : '';
echo '<li class="' . $t_active . '">';
if( $t_item['label'] == '' ) {
echo '<a href="'. lang_get_defaulted( $t_item['url'] ) .'">';
print_icon( 'fa-info-circle', 'blue ace-icon' );
echo '</a>';
} else {
echo '<a href="'. helper_mantis_url( $t_item['url'] ) .'">' . lang_get_defaulted( $t_item['label'] ) . '</a>';
}
echo '</li>' . "\n";
}
# Plugins menu items - these are html hyperlinks (<a> tags)
foreach( plugin_menu_items( $p_event ) as $t_item ) {
$t_active = $p_current_page && strpos( $t_item, $p_current_page ) !== false
? 'active'
: '';
echo '<li class="' . $t_active . '">', $t_item, '</li>', "\n";
}
echo '</ul>' . "\n";
}
/**
* Print a generic submenu (buttons group).
*
* @param array $p_menu_items List of menu items
* @param string $p_current_page Current page's file name to highlight active tab
* @param string $p_event Optional event to signal,
*/
function print_submenu( array $p_menu_items, $p_current_page = '', $p_event = null ) {
# Plugin / Event added options
$t_plugin_menu_items = plugin_menu_items( $p_event );
if( $p_menu_items || $t_plugin_menu_items ) {
echo '<div class="space-10"></div>';
echo '<div class="col-md-12 col-xs-12 center">';
echo '<div class="btn-group">', "\n";
$t_btn_template = '<a class="btn btn-sm btn-primary btn-white %s" href="%s">%s%s</a>' . "\n";
foreach( $p_menu_items as $t_item ) {
if( is_array( $t_item ) ) {
$t_active = $p_current_page && strpos( $t_item['url'], $p_current_page ) !== false
? 'active' : '';
$t_icon = array_key_exists( 'icon', $t_item )
? icon_get( $t_item['icon'] ) . ' '
: '';
printf( $t_btn_template,
$t_active,
$t_item['url'],
$t_icon,
lang_get_defaulted( $t_item['label'] )
);
} else {
# Cooked link
echo $t_item;
}
}
# Plugins menu items - these are html hyperlinks (<a> tags)
# The plugin is responsible for setting the 'active' class as appropriate
foreach( plugin_menu_items( $p_event ) as $t_item ) {
echo $t_item;
}
echo '</div></div>', "\n";
}
}
/**
* Print the Summary page's submenu.
* The submenu is only printed if there is at least one plugin-defined link, in
* which case a 'Synthesis' button is added for the summary page itself.
* @param string $p_current_page Current page's file name to highlight active menu item
* @return void
*/
function print_summary_submenu( $p_current_page = '' ) {
# Plugin / Event added options
$t_menu_items = plugin_menu_items( 'EVENT_SUBMENU_SUMMARY' );
if( $t_menu_items ) {
$t_filter_param = filter_get_temporary_key_param( summary_get_filter() );
$t_synthesis['summary_page.php'] = array(
'url' => helper_url_combine( helper_mantis_url( 'summary_page.php' ), $t_filter_param ),
'icon' => 'fa-table',
'label' => 'synthesis',
);
if( $p_current_page == '' ) {
$p_current_page = 'summary_page.php';
}
print_submenu( array_merge( $t_synthesis, $t_menu_items ), $p_current_page );
}
}
/**
* Print the menu for the manage section
*
* @param string $p_page Specifies the current page name so it's link can be disabled.
* @return void
*/
function print_manage_menu( $p_page = '' ) {
$t_pages = array();
if( access_has_global_level( config_get( 'manage_site_threshold' ) ) ) {
$t_pages['manage_overview_page.php'] = array( 'url' => 'manage_overview_page.php', 'label' => '' );
}
if( access_has_global_level( config_get( 'manage_user_threshold' ) ) ) {
$t_pages['manage_user_page.php'] = array( 'url' => 'manage_user_page.php', 'label' => 'manage_users_link' );
}
if( access_has_project_level( config_get( 'manage_project_threshold' ) ) ) {
$t_pages['manage_proj_page.php'] = array( 'url' => 'manage_proj_page.php', 'label' => 'manage_projects_link' );
}
if( access_has_global_level( config_get( 'tag_edit_threshold' ) ) ) {
$t_pages['manage_tags_page.php'] = array( 'url' => 'manage_tags_page.php', 'label' => 'manage_tags_link' );
}
if( access_has_global_level( config_get( 'manage_custom_fields_threshold' ) ) ) {
$t_pages['manage_custom_field_page.php'] = array( 'url' => 'manage_custom_field_page.php', 'label' => 'manage_custom_field_link' );
}
if( config_get( 'enable_profiles' ) == ON && access_has_global_level( config_get( 'manage_global_profile_threshold' ) ) ) {
$t_pages['manage_prof_menu_page.php'] = array( 'url' => 'manage_prof_menu_page.php', 'label' => 'manage_global_profiles_link' );
}
if( access_has_global_level( config_get( 'manage_plugin_threshold' ) ) ) {
$t_pages['manage_plugin_page.php'] = array( 'url' => 'manage_plugin_page.php', 'label' => 'manage_plugin_link' );
}
if( access_has_project_level( config_get( 'manage_configuration_threshold' ) ) ) {
$t_pages['adm_permissions_report.php'] = array(
'url' => 'adm_permissions_report.php',
'label' => 'manage_config_link'
);
}
print_menu( $t_pages, $p_page, 'EVENT_MENU_MANAGE' );
}
/**
* Print the menu for the manage configuration section
* @param string $p_page Specifies the current page name so it's link can be disabled.
* @return void
*/
function print_manage_config_menu( $p_page = '' ) {
if( !access_has_project_level( config_get( 'manage_configuration_threshold' ) ) ) {
return;
}
$t_pages = array();
$t_pages['adm_permissions_report.php'] = array( 'url' => 'adm_permissions_report.php',
'label' => 'permissions_summary_report' );
if( access_has_global_level( config_get( 'view_configuration_threshold' ) ) ) {
$t_pages['adm_config_report.php'] = array( 'url' => 'adm_config_report.php',
'label' => 'configuration_report' );
}
$t_pages['manage_config_work_threshold_page.php'] = array( 'url' => 'manage_config_work_threshold_page.php',
'label' => 'manage_threshold_config' );
$t_pages['manage_config_workflow_page.php'] = array( 'url' => 'manage_config_workflow_page.php',
'label' => 'manage_workflow_config' );
if( config_get( 'relationship_graph_enable' ) ) {
$t_pages['manage_config_workflow_graph_page.php'] = array( 'url' => 'manage_config_workflow_graph_page.php',
'label' => 'manage_workflow_graph' );
}
if( config_get( 'enable_email_notification' ) == ON ) {
$t_pages['manage_config_email_page.php'] = array( 'url' => 'manage_config_email_page.php',
'label' => 'manage_email_config' );
}
$t_pages['manage_config_columns_page.php'] = array( 'url' => 'manage_config_columns_page.php',
'label' => 'manage_columns_config' );
# Plugin / Event added options
$t_event_menu_options = event_signal( 'EVENT_MENU_MANAGE_CONFIG' );
$t_menu_options = array();
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;
}
}
}
}
echo '<div class="space-10"></div>' . "\n";
echo '<div class="center">' . "\n";
echo '<div class="btn-toolbar inline">' . "\n";
echo '<div class="btn-group">' . "\n";
foreach ( $t_pages as $t_page ) {
$t_active = $t_page['url'] == $p_page ? 'active' : '';
echo '<a class="btn btn-sm btn-white btn-primary ' . $t_active . '" href="'. helper_mantis_url( $t_page['url'] ) .'">' . "\n";
echo lang_get_defaulted( $t_page['label'] );
echo '</a>' . "\n";
}
foreach ( $t_menu_options as $t_menu_item ) {
echo $t_menu_item;
}
echo '</div>' . "\n";
echo '</div>' . "\n";
echo '</div>' . "\n";
}
/**
* Print the menu for the account section
* @param string $p_page Specifies the current page name so it's link can be disabled.
* @return void
*/
function print_account_menu( $p_page = '' ) {
$t_pages['account_page.php'] = array( 'url'=>'account_page.php', 'label'=>'account_link' );
$t_pages['account_prefs_page.php'] = array( 'url'=>'account_prefs_page.php', 'label'=>'change_preferences_link' );
$t_pages['account_manage_columns_page.php'] = array( 'url'=>'account_manage_columns_page.php', 'label'=>'manage_columns_config' );
if( config_get( 'enable_profiles' ) == ON && access_has_project_level( config_get( 'add_profile_threshold' ) ) ) {
$t_pages['account_prof_menu_page.php'] = array( 'url'=>'account_prof_menu_page.php', 'label'=>'manage_profiles_link' );
}
if( config_get( 'enable_sponsorship' ) == ON && access_has_project_level( config_get( 'view_sponsorship_total_threshold' ) ) && !current_user_is_anonymous() ) {
$t_pages['account_sponsor_page.php'] = array( 'url'=>'account_sponsor_page.php', 'label'=>'my_sponsorship' );
}
if( api_token_can_create() ) {
$t_pages['api_tokens_page.php'] = array( 'url' => 'api_tokens_page.php', 'label' => 'api_tokens_link' );
}
print_menu( $t_pages, $p_page, 'EVENT_MENU_ACCOUNT' );
}
/**
* Print the menu for the documentation section
* @param string $p_page Specifies the current page name so it's link can be disabled.
* @return void
*/
function print_doc_menu( $p_page = '' ) {
# User Documentation
$t_doc_url = config_get_global( 'manual_url' );
if( is_null( parse_url( $t_doc_url, PHP_URL_SCHEME ) ) ) {
# URL has no scheme, so it is relative to MantisBT root
if( is_blank( $t_doc_url ) ||
!file_exists( config_get_global( 'absolute_path' ) . $t_doc_url )
) {
# Local documentation not available, use online docs
$t_doc_url = 'http://www.mantisbt.org/documentation.php';
} else {
$t_doc_url = helper_mantis_url( $t_doc_url );
}
}
$t_pages[$t_doc_url] = array(
'url' => $t_doc_url,
'label' => 'user_documentation'
);
# Project Documentation
$t_pages['proj_doc_page.php'] = array(
'url' => 'proj_doc_page.php',
'label' => 'project_documentation'
);
# Add File
if( file_allow_project_upload() ) {
$t_pages['proj_doc_add_page.php'] = array(
'url' => 'proj_doc_add_page.php',
'label' => 'add_file'
);
}
print_menu( $t_pages, $p_page );
}
/**
* Print the menu for the summary section.
* @param string $p_page Specifies the current page name so it's link can be disabled.
* @param array $p_filter Filter array, the one in use for summary pages.
* @return void
*/
function print_summary_menu( $p_page = '', array $p_filter = null ) {
$t_link = 'summary_page.php';
$t_filter_param = $p_filter ? filter_get_temporary_key_param( $p_filter ) : null;
if( $t_filter_param ) {
$t_link = helper_url_combine( $t_link, $t_filter_param );
}
$t_pages['summary_page.php'] = array(
'url' => $t_link,
'label' => 'summary_link',
);
print_menu( $t_pages, $p_page, 'EVENT_MENU_SUMMARY' );
summary_print_filter_info( $p_filter );
}
/**
* Print the admin tab bar.
* @param string $p_page Specifies the current page name so it is set as active.
* @return void
*/
function print_admin_menu_bar( $p_page ) {
# Build array with admin menu items, add Upgrade tab if necessary
$t_menu_items['index.php'] = icon_get( 'fa-info-circle', 'blue ace-icon' );
# At the beginning of admin checks, the DB is not yet loaded so we can't
# check the schema to inform user that an upgrade is needed
if( $p_page == 'check/index.php' ) {
# Relative URL up one level to ensure valid links on Admin Checks page
$t_path = '../';
} else {
global $g_upgrade;
include_once( 'schema.php' );
if( count( $g_upgrade ) - 1 != config_get( 'database_version', -1, ALL_USERS, ALL_PROJECTS ) ) {
$t_menu_items['install.php'] = 'Upgrade your installation';
}
$t_path = '';
}
$t_menu_items += array(
'check/index.php' => 'Check Installation',
'system_utils.php' => 'System Utilities',
'test_langs.php' => 'Test Lang',
'email_queue.php' => 'Email Queue',
);
echo '<div class="space-10"></div>' . "\n";
echo '<ul class="nav nav-tabs padding-18">' . "\n";
foreach( $t_menu_items as $t_menu_page => $t_description ) {
$t_class_active = $t_menu_page == $p_page ? ' class="active"' : '';
$t_class_green = $t_menu_page == 'install.php' ? 'class="bold green" ' : '';
echo "\t<li$t_class_active>";
echo "<a " . $t_class_green
. 'href="' . $t_path . $t_menu_page . '">'
. $t_description . "</a>";
echo '</li>' . "\n";
}
echo '</ul>' . "\n";
}
/**
* Print an html button inside a form
* @param string $p_action Form Action.
* @param string $p_button_text Button Text.
* @param array $p_fields An array of hidden fields to include on the form.
* @param string $p_method Form submit method - default post.
* @return void
*/
function html_button( $p_action, $p_button_text, array $p_fields = array(), $p_method = 'post' ) {
$t_form_name = explode( '.php', $p_action, 2 );
$p_action = urlencode( $p_action );
$p_button_text = string_attribute( $p_button_text );
if( strtolower( $p_method ) == 'get' ) {
$t_method = 'get';
} else {
$t_method = 'post';
}
echo '<form method="' . $t_method . '" action="' . $p_action . '" class="form-inline">' . "\n";
echo "\t" . '<fieldset>';
# Add a CSRF token only when the form is being sent via the POST method
if( $t_method == 'post' ) {
echo form_security_field( $t_form_name[0] );
}
foreach( $p_fields as $t_key => $t_val ) {
$t_key = string_attribute( $t_key );
$t_val = string_attribute( $t_val );
echo "\t\t" . '<input type="hidden" name="' . $t_key . '" value="' . $t_val . '" />' . "\n";
}
echo "\t\t" . '<input type="submit" class="btn btn-primary btn-sm btn-white btn-round" value="' . $p_button_text . '" />' . "\n";
echo "\t" . '</fieldset>';
echo '</form>' . "\n";
}
/**
* Get the foreground color CSS class for the given status, user and project.
* @see html_get_status_css_bg() for background color
*
* @param integer $p_status An enumeration value.
* @param integer $p_user A valid user identifier.
* @param integer $p_project A valid project identifier.