/
plugin_api.php
983 lines (830 loc) · 27.7 KB
/
plugin_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
<?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/>.
/**
* Plugin API
*
* Handles the initialisation, management, and execution of plugins.
*
* @package CoreAPI
* @subpackage PluginAPI
* @copyright Copyright 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright 2002 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*
* @uses access_api.php
* @uses config_api.php
* @uses constant_inc.php
* @uses database_api.php
* @uses error_api.php
* @uses event_api.php
* @uses helper_api.php
* @uses history_api.php
* @uses lang_api.php
*/
require_api( 'access_api.php' );
require_api( 'config_api.php' );
require_api( 'constant_inc.php' );
require_api( 'database_api.php' );
require_api( 'error_api.php' );
require_api( 'event_api.php' );
require_api( 'helper_api.php' );
require_api( 'history_api.php' );
require_api( 'lang_api.php' );
# Cache variables #####
$g_plugin_cache = array();
$g_plugin_cache_priority = array();
$g_plugin_cache_protected = array();
$g_plugin_current = array();
# Public API #####
/**
* Get the currently executing plugin's basename.
* @return string Plugin basename, or null if no current plugin
*/
function plugin_get_current() {
global $g_plugin_current;
return( isset( $g_plugin_current[0] ) ? $g_plugin_current[0] : null );
}
/**
* Add the current plugin to the stack
* @param string $p_base_name Plugin base name.
* @return void
*/
function plugin_push_current( $p_base_name ) {
global $g_plugin_current;
array_unshift( $g_plugin_current, $p_base_name );
}
/**
* Remove the current plugin from the stack
* @return string Plugin basename, or null if no current plugin
*/
function plugin_pop_current() {
global $g_plugin_current;
return( isset( $g_plugin_current[0] ) ? array_shift( $g_plugin_current ) : null );
}
/**
* Returns the list of force-installed plugins
* @see $g_plugins_force_installed
* @return array List of plugins (basename => priority)
*/
function plugin_get_force_installed() {
$t_forced_plugins = config_get_global( 'plugins_force_installed' );
# MantisCore pseudo-plugin is force-installed by definition, with priority 3
$t_forced_plugins['MantisCore'] = 3;
return $t_forced_plugins;
}
/**
* Returns an object representing the specified plugin
* Triggers an error if the plugin is not registered
* @param string|null $p_basename Plugin base name (defaults to current plugin).
* @return object Plugin Object
*/
function plugin_get( $p_basename = null ) {
global $g_plugin_cache;
if( is_null( $p_basename ) ) {
$t_current = plugin_get_current();
} else {
$t_current = $p_basename;
}
if( !plugin_is_registered( $t_current ) ) {
error_parameters( $t_current );
trigger_error( ERROR_PLUGIN_NOT_REGISTERED, ERROR );
}
return $g_plugin_cache[$t_current];
}
/**
* Get the URL to the plugin wrapper page.
* @param string $p_page Page name.
* @param boolean $p_redirect Return url for redirection.
* @param string $p_base_name Plugin base name (defaults to current plugin).
* @return string
*/
function plugin_page( $p_page, $p_redirect = false, $p_base_name = null ) {
if( is_null( $p_base_name ) ) {
$t_current = plugin_get_current();
} else {
$t_current = $p_base_name;
}
if( $p_redirect ) {
return 'plugin.php?page=' . $t_current . '/' . $p_page;
} else {
return helper_mantis_url( 'plugin.php?page=' . $t_current . '/' . $p_page );
}
}
/**
* Return a path to a plugin file.
* @param string $p_filename File name.
* @param string $p_base_name Plugin base name.
* @return mixed File path or false if FNF
*/
function plugin_file_path( $p_filename, $p_base_name ) {
$t_file_path = config_get( 'plugin_path' );
$t_file_path .= $p_base_name . DIRECTORY_SEPARATOR;
$t_file_path .= 'files' . DIRECTORY_SEPARATOR . $p_filename;
return( is_file( $t_file_path ) ? $t_file_path : false );
}
/**
* Get the URL to the plugin wrapper file page.
* @param string $p_file File name.
* @param boolean $p_redirect Return url for redirection.
* @param string $p_base_name Plugin base name (defaults to current plugin).
* @return string
*/
function plugin_file( $p_file, $p_redirect = false, $p_base_name = null ) {
if( is_null( $p_base_name ) ) {
$t_current = plugin_get_current();
} else {
$t_current = $p_base_name;
}
if( $p_redirect ) {
return 'plugin_file.php?file=' . $t_current . '/' . $p_file;
} else {
return helper_mantis_url( 'plugin_file.php?file=' . $t_current . '/' . $p_file );
}
}
/**
* Include the contents of a file as output.
* @param string $p_filename File name.
* @param string $p_basename Plugin basename.
* @return void
*/
function plugin_file_include( $p_filename, $p_basename = null ) {
global $g_plugin_mime_types;
if( is_null( $p_basename ) ) {
$t_current = plugin_get_current();
} else {
$t_current = $p_basename;
}
$t_file_path = plugin_file_path( $p_filename, $t_current );
if( false === $t_file_path ) {
error_parameters( $t_current, $p_filename );
trigger_error( ERROR_PLUGIN_FILE_NOT_FOUND, ERROR );
}
$t_content_type = '';
$t_finfo = finfo_get_if_available();
if( $t_finfo ) {
$t_file_info_type = $t_finfo->file( $t_file_path );
if( $t_file_info_type !== false ) {
$t_content_type = $t_file_info_type;
}
}
# allow overriding the content type for specific text and image extensions
# see bug #13193 for details
if( strpos( $t_content_type, 'text/' ) === 0 || strpos( $t_content_type, 'image/' ) === 0 ) {
$t_extension = pathinfo( $t_file_path, PATHINFO_EXTENSION );
if( $t_extension && array_key_exists( $t_extension, $g_plugin_mime_types ) ) {
$t_content_type = $g_plugin_mime_types[$t_extension];
}
}
if( $t_content_type ) {
header( 'Content-Type: ' . $t_content_type );
}
readfile( $t_file_path );
}
/**
* Given a base table name for a plugin, add appropriate prefix and suffix.
* Convenience for plugin schema definitions.
* @param string $p_name Table name.
* @param string $p_basename Plugin basename (defaults to current plugin).
* @return string Full table name
*/
function plugin_table( $p_name, $p_basename = null ) {
if( is_null( $p_basename ) ) {
$t_current = plugin_get_current();
} else {
$t_current = $p_basename;
}
# Determine plugin table prefix including trailing '_'
$t_prefix = trim( config_get_global( 'db_table_plugin_prefix' ) );
if( !empty( $t_prefix ) && '_' != substr( $t_prefix, -1 ) ) {
$t_prefix .= '_';
}
return db_get_table( $t_prefix . $t_current . '_' . $p_name );
}
/**
* Get a plugin configuration option.
* @param string $p_option Configuration option name.
* @param mixed $p_default Default option value.
* @param boolean $p_global Get global config variables only.
* @param integer $p_user A user identifier.
* @param integer $p_project A Project identifier.
* @return string
*/
function plugin_config_get( $p_option, $p_default = null, $p_global = false, $p_user = null, $p_project = null ) {
$t_basename = plugin_get_current();
$t_full_option = 'plugin_' . $t_basename . '_' . $p_option;
if( $p_global ) {
return config_get_global( $t_full_option, $p_default );
} else {
return config_get( $t_full_option, $p_default, $p_user, $p_project );
}
}
/**
* Set a plugin configuration option in the database.
* @param string $p_option Configuration option name.
* @param mixed $p_value Option value.
* @param integer $p_user A user identifier.
* @param integer $p_project A project identifier.
* @param integer $p_access Access threshold.
* @return void
*/
function plugin_config_set( $p_option, $p_value, $p_user = NO_USER, $p_project = ALL_PROJECTS, $p_access = DEFAULT_ACCESS_LEVEL ) {
if( $p_access == DEFAULT_ACCESS_LEVEL ) {
$p_access = config_get_global( 'admin_site_threshold' );
}
$t_basename = plugin_get_current();
$t_full_option = 'plugin_' . $t_basename . '_' . $p_option;
config_set( $t_full_option, $p_value, $p_user, $p_project, $p_access );
}
/**
* Delete a plugin configuration option from the database.
* @param string $p_option Configuration option name.
* @param integer $p_user A user identifier.
* @param integer $p_project A project identifier.
* @return void
*/
function plugin_config_delete( $p_option, $p_user = ALL_USERS, $p_project = ALL_PROJECTS ) {
$t_basename = plugin_get_current();
$t_full_option = 'plugin_' . $t_basename . '_' . $p_option;
config_delete( $t_full_option, $p_user, $p_project );
}
/**
* Set plugin default values to global values without overriding anything.
* @param array $p_options Array of configuration option name/value pairs.
* @return void
*/
function plugin_config_defaults( array $p_options ) {
if( !is_array( $p_options ) ) {
return;
}
$t_basename = plugin_get_current();
$t_option_base = 'plugin_' . $t_basename . '_';
foreach( $p_options as $t_option => $t_value ) {
$t_full_option = $t_option_base . $t_option;
config_set_global( $t_full_option, $t_value, false );
}
}
/**
* Get a language string for the plugin.
* Automatically prepends plugin_<basename> to the string requested.
* @param string $p_name Language string name.
* @param string $p_basename Plugin basename.
* @return string Language string
*/
function plugin_lang_get( $p_name, $p_basename = null ) {
if( !is_null( $p_basename ) ) {
plugin_push_current( $p_basename );
}
$t_basename = plugin_get_current();
$t_name = 'plugin_' . $t_basename . '_' . $p_name;
$t_string = lang_get( $t_name );
if( !is_null( $p_basename ) ) {
plugin_pop_current();
}
return $t_string;
}
/**
* log history event from plugin
* @param integer $p_bug_id A bug identifier.
* @param string $p_field_name A field name.
* @param string $p_old_value The old value.
* @param string $p_new_value The new value.
* @param integer $p_user_id A user identifier.
* @param string $p_basename The plugin basename (or current plugin if null).
* @return void
*/
function plugin_history_log( $p_bug_id, $p_field_name, $p_old_value, $p_new_value = '', $p_user_id = null, $p_basename = null ) {
if( is_null( $p_basename ) ) {
$t_basename = plugin_get_current();
} else {
$t_basename = $p_basename;
}
$t_field_name = $t_basename . '_' . $p_field_name;
history_log_event_direct( $p_bug_id, $t_field_name, $p_old_value, $p_new_value, $p_user_id, PLUGIN_HISTORY );
}
/**
* Trigger a plugin-specific error with the given name and type.
* @param string $p_error_name Error name.
* @param integer $p_error_type Error type.
* @param string $p_basename The plugin basename (or current plugin if null).
* @return void
*/
function plugin_error( $p_error_name, $p_error_type = ERROR, $p_basename = null ) {
if( is_null( $p_basename ) ) {
$t_basename = plugin_get_current();
} else {
$t_basename = $p_basename;
}
$t_error_code = "plugin_${t_basename}_${p_error_name}";
trigger_error( $t_error_code, $p_error_type );
}
/**
* Hook a plugin's callback function to an event.
* @param string $p_name Event name.
* @param string $p_callback Callback function.
* @return void
*/
function plugin_event_hook( $p_name, $p_callback ) {
$t_basename = plugin_get_current();
event_hook( $p_name, $p_callback, $t_basename );
}
/**
* Hook multiple plugin callbacks at once.
* @param array $p_hooks Array of event name/callback key/value pairs.
* @return void
*/
function plugin_event_hook_many( array $p_hooks ) {
if( !is_array( $p_hooks ) ) {
return;
}
$t_basename = plugin_get_current();
foreach( $p_hooks as $t_event => $t_callbacks ) {
if( !is_array( $t_callbacks ) ) {
event_hook( $t_event, $t_callbacks, $t_basename );
continue;
}
foreach( $t_callbacks as $t_callback ) {
event_hook( $t_event, $t_callback, $t_basename );
}
}
}
/**
* Allows a plugin to declare a 'child plugin' that
* can be loaded from the same parent directory.
* @param string $p_child Child plugin basename.
* @return mixed
*/
function plugin_child( $p_child ) {
$t_base_name = plugin_get_current();
$t_plugin = plugin_register( $t_base_name, false, $p_child );
if( !is_null( $t_plugin ) ) {
plugin_init( $p_child );
}
return $t_plugin;
}
/**
* Checks if a given plugin has been registered and initialized,
* and returns a boolean value representing the "loaded" state.
* @param string $p_base_name Plugin basename.
* @return boolean Plugin loaded
*/
function plugin_is_loaded( $p_base_name ) {
global $g_plugin_cache_init;
return ( isset( $g_plugin_cache_init[$p_base_name] ) && $g_plugin_cache_init[$p_base_name] );
}
/**
* Checks two versions for minimum or maximum version dependencies.
* @param string $p_version Version number to check.
* @param string $p_required Version number required.
* @param boolean $p_maximum Minimum (false) or maximum (true) version check.
* @return integer 1 if the version dependency succeeds, -1 if it fails
*/
function plugin_version_check( $p_version, $p_required, $p_maximum = false ) {
if( $p_maximum ) {
$t_operator = '<';
} else {
$t_operator = '>=';
}
$t_result = version_compare( $p_version, $p_required, $t_operator );
return $t_result ? 1 : -1;
}
/**
* Check a plugin dependency given a basename and required version.
* Versions are checked using PHP's library version_compare routine
* and allows both minimum and maximum version requirements.
* Returns 1 if plugin dependency is met, 0 if dependency not met,
* or -1 if dependency is the wrong version.
* @param string $p_base_name Plugin base name.
* @param string $p_required Required version.
* @param boolean $p_initialized Whether plugin is initialized.
* @return integer Plugin dependency status
*/
function plugin_dependency( $p_base_name, $p_required, $p_initialized = false ) {
global $g_plugin_cache, $g_plugin_cache_init;
# check for registered dependency
if( isset( $g_plugin_cache[$p_base_name] ) ) {
# require dependency initialized?
if( $p_initialized && !isset( $g_plugin_cache_init[$p_base_name] ) ) {
return 0;
}
$t_plugin_version = $g_plugin_cache[$p_base_name]->version;
$t_required_array = explode( ',', $p_required );
# Set maximum dependency for MantisCore if none is specified.
# This effectively disables plugins which have not been specifically
# designed for a new major Mantis release to force authors to review
# their code, adapt it if necessary, and release a new version of the
# plugin with updated dependencies.
if( $p_base_name == 'MantisCore' && strpos( $p_required, '<' ) === false ) {
$t_version_core = utf8_substr( $t_plugin_version, 0, strpos( $t_plugin_version, '.' ) );
$t_is_current_core_supported = false;
foreach( $t_required_array as $t_version_required ) {
$t_is_current_core_supported = $t_is_current_core_supported
|| version_compare( trim( $t_version_required ), $t_version_core, '>=' );
}
if( !$t_is_current_core_supported ) {
# Add current major version as maximum
$t_required_array[] = '<' . $t_version_core;
}
}
foreach( $t_required_array as $t_required ) {
$t_required = trim( $t_required );
$t_maximum = false;
# check for a less-than-or-equal version requirement
$t_ltpos = strpos( $t_required, '<=' );
if( $t_ltpos !== false ) {
$t_required = trim( utf8_substr( $t_required, $t_ltpos + 2 ) );
$t_maximum = true;
} else {
$t_ltpos = strpos( $t_required, '<' );
if( $t_ltpos !== false ) {
$t_required = trim( utf8_substr( $t_required, $t_ltpos + 1 ) );
$t_maximum = true;
}
}
$t_check = plugin_version_check( $t_plugin_version, $t_required, $t_maximum );
if( $t_check < 1 ) {
return $t_check;
}
}
return 1;
} else {
return 0;
}
}
/**
* Checks to see if a plugin is 'protected' from uninstall.
* @param string $p_base_name Plugin base name.
* @return boolean True if plugin is protected
*/
function plugin_protected( $p_base_name ) {
global $g_plugin_cache_protected;
return $g_plugin_cache_protected[$p_base_name];
}
/**
* Gets a plugin's priority.
* @param string $p_base_name Plugin base name.
* @return int Plugin priority
*/
function plugin_priority( $p_base_name ) {
global $g_plugin_cache_priority;
return $g_plugin_cache_priority[$p_base_name];
}
/**
* Determine if a given plugin is installed.
* @param string $p_basename Plugin basename.
* @return boolean True if plugin is installed
*/
function plugin_is_installed( $p_basename ) {
foreach( plugin_get_force_installed() as $t_basename => $t_priority ) {
if( $t_basename == $p_basename ) {
return true;
}
}
db_param_push();
$t_query = 'SELECT COUNT(*) FROM {plugin} WHERE basename=' . db_param();
$t_result = db_query( $t_query, array( $p_basename ) );
return( 0 < db_result( $t_result ) );
}
/**
* Install a plugin to the database.
* @param MantisPlugin $p_plugin Plugin basename.
* @return null
*/
function plugin_install( MantisPlugin $p_plugin ) {
if( plugin_is_installed( $p_plugin->basename ) ) {
error_parameters( $p_plugin->basename );
trigger_error( ERROR_PLUGIN_ALREADY_INSTALLED, WARNING );
return null;
}
plugin_push_current( $p_plugin->basename );
if( !$p_plugin->install() ) {
plugin_pop_current();
return null;
}
db_param_push();
$t_query = 'INSERT INTO {plugin} ( basename, enabled )
VALUES ( ' . db_param() . ', ' . db_param() . ' )';
db_query( $t_query, array( $p_plugin->basename, true ) );
if( false === ( plugin_config_get( 'schema', false ) ) ) {
plugin_config_set( 'schema', -1 );
}
plugin_upgrade( $p_plugin );
plugin_pop_current();
}
/**
* Determine if an installed plugin needs to upgrade its schema.
* @param MantisPlugin $p_plugin Plugin basename.
* @return boolean True if plugin needs schema upgrades.
*/
function plugin_needs_upgrade( MantisPlugin $p_plugin ) {
plugin_push_current( $p_plugin->name );
$t_plugin_schema = $p_plugin->schema();
plugin_pop_current();
if( is_null( $t_plugin_schema ) ) {
return false;
}
$t_config_option = 'plugin_' . $p_plugin->basename . '_schema';
$t_plugin_schema_version = config_get( $t_config_option, -1, ALL_USERS, ALL_PROJECTS );
return( $t_plugin_schema_version < count( $t_plugin_schema ) - 1 );
}
/**
* Upgrade an installed plugin's schema.
* @param MantisPlugin $p_plugin Plugin basename.
* @return boolean|null True if upgrade completed, null if problem
*/
function plugin_upgrade( MantisPlugin $p_plugin ) {
if( !plugin_is_installed( $p_plugin->basename ) ) {
return null;
}
require_api( 'install_helper_functions_api.php' );
plugin_push_current( $p_plugin->basename );
$t_schema_version = (int)plugin_config_get( 'schema', -1 );
$t_schema = $p_plugin->schema();
global $g_db;
$t_dict = NewDataDictionary( $g_db );
$i = $t_schema_version + 1;
while( $i < count( $t_schema ) ) {
if( !$p_plugin->upgrade( $i ) ) {
plugin_pop_current();
return false;
}
$t_target = $t_schema[$i][1][0];
if( $t_schema[$i][0] == 'InsertData' ) {
$t_sqlarray = array(
'INSERT INTO ' . $t_schema[$i][1][0] . $t_schema[$i][1][1],
);
} else if( $t_schema[$i][0] == 'UpdateSQL' ) {
$t_sqlarray = array(
'UPDATE ' . $t_schema[$i][1][0] . $t_schema[$i][1][1],
);
$t_target = $t_schema[$i][1];
} else if( $t_schema[$i][0] == 'UpdateFunction' ) {
$t_sqlarray = false;
if( isset( $t_schema[$i][2] ) ) {
$t_status = call_user_func( 'install_' . $t_schema[$i][1], $t_schema[$i][2] );
} else {
$t_status = call_user_func( 'install_' . $t_schema[$i][1] );
}
} else {
$t_sqlarray = call_user_func_array( array( $t_dict, $t_schema[$i][0] ), $t_schema[$i][1] );
}
if( $t_sqlarray ) {
$t_status = $t_dict->ExecuteSQLArray( $t_sqlarray );
}
if( 2 == $t_status ) {
plugin_config_set( 'schema', $i );
} else {
error_parameters( $i );
trigger_error( ERROR_PLUGIN_UPGRADE_FAILED, ERROR );
return null;
}
$i++;
}
plugin_pop_current();
return true;
}
/**
* Uninstall a plugin from the database.
* @param MantisPlugin $p_plugin Plugin basename.
* @return void
*/
function plugin_uninstall( MantisPlugin $p_plugin ) {
access_ensure_global_level( config_get_global( 'manage_plugin_threshold' ) );
if( !plugin_is_installed( $p_plugin->basename ) || plugin_protected( $p_plugin->basename ) ) {
return;
}
db_param_push();
$t_query = 'DELETE FROM {plugin} WHERE basename=' . db_param();
db_query( $t_query, array( $p_plugin->basename ) );
plugin_push_current( $p_plugin->basename );
$p_plugin->uninstall();
plugin_pop_current();
}
/**
* Search the plugins directory for plugins.
* @return array Plugin basename/info key/value pairs.
*/
function plugin_find_all() {
$t_plugin_path = config_get_global( 'plugin_path' );
$t_plugins = array(
'MantisCore' => new MantisCorePlugin( 'MantisCore' ),
);
if( $t_dir = opendir( $t_plugin_path ) ) {
while( ( $t_file = readdir( $t_dir ) ) !== false ) {
if( '.' == $t_file || '..' == $t_file ) {
continue;
}
if( is_dir( $t_plugin_path . $t_file ) ) {
$t_plugin = plugin_register( $t_file, true );
if( !is_null( $t_plugin ) ) {
$t_plugins[$t_file] = $t_plugin;
}
}
}
closedir( $t_dir );
}
return $t_plugins;
}
/**
* Load a plugin's core class file.
* @param string $p_basename Plugin basename.
* @param string $p_child Child filename.
* @return boolean
*/
function plugin_include( $p_basename, $p_child = null ) {
$t_path = config_get_global( 'plugin_path' ) . $p_basename . DIRECTORY_SEPARATOR;
if( is_null( $p_child ) ) {
$t_plugin_file = $t_path . $p_basename . '.php';
} else {
$t_plugin_file = $t_path . $p_child . '.php';
}
$t_included = false;
if( is_file( $t_plugin_file ) ) {
include_once( $t_plugin_file );
$t_included = true;
}
return $t_included;
}
/**
* Allows a plugin page to require a plugin-specific API
* @param string $p_file The API to be included.
* @param string $p_basename Plugin's basename (defaults to current plugin).
* @return void
*/
function plugin_require_api( $p_file, $p_basename = null ) {
if( is_null( $p_basename ) ) {
$t_current = plugin_get_current();
} else {
$t_current = $p_basename;
}
$t_path = config_get_global( 'plugin_path' ) . $t_current . '/';
require_once( $t_path . $p_file );
}
/**
* Determine if a given plugin is registered.
* @param string $p_basename Plugin basename.
* @return boolean True if plugin is registered
*/
function plugin_is_registered( $p_basename ) {
global $g_plugin_cache;
return isset( $g_plugin_cache[$p_basename] );
}
/**
* Register a plugin with MantisBT.
* The plugin class must already be loaded before calling.
* @param string $p_basename Plugin classname without 'Plugin' postfix.
* @param boolean $p_return Return.
* @param string $p_child Child filename.
* @return mixed
*/
function plugin_register( $p_basename, $p_return = false, $p_child = null ) {
global $g_plugin_cache;
$t_basename = is_null( $p_child ) ? $p_basename : $p_child;
if( !isset( $g_plugin_cache[$t_basename] ) ) {
$t_classname = $t_basename . 'Plugin';
# Include the plugin script if the class is not already declared.
if( !class_exists( $t_classname ) ) {
if( !plugin_include( $p_basename, $p_child ) ) {
return null;
}
}
# Make sure the class exists and that it's of the right type.
if( class_exists( $t_classname ) && is_subclass_of( $t_classname, 'MantisPlugin' ) ) {
plugin_push_current( is_null( $p_child ) ? $p_basename : $p_child );
$t_plugin = new $t_classname( is_null( $p_child ) ? $p_basename : $p_child );
plugin_pop_current();
# Final check on the class
if( is_null( $t_plugin->name ) || is_null( $t_plugin->version ) ) {
return null;
}
if( $p_return ) {
return $t_plugin;
} else {
$g_plugin_cache[$t_basename] = $t_plugin;
}
} else {
error_parameters( $t_basename, $t_classname );
trigger_error( ERROR_PLUGIN_CLASS_NOT_FOUND, ERROR );
}
}
return $g_plugin_cache[$t_basename];
}
/**
* Find and register all installed plugins.
* This includes the MantisCore pseudo-plugin.
* @return void
*/
function plugin_register_installed() {
global $g_plugin_cache_priority, $g_plugin_cache_protected;
# register plugins specified in the site configuration
foreach( plugin_get_force_installed() as $t_basename => $t_priority ) {
plugin_register( $t_basename );
$g_plugin_cache_priority[$t_basename] = $t_priority;
$g_plugin_cache_protected[$t_basename] = true;
}
# register plugins installed via the interface/database
db_param_push();
$t_query = 'SELECT basename, priority, protected FROM {plugin} WHERE enabled=' . db_param() . ' ORDER BY priority DESC';
$t_result = db_query( $t_query, array( true ) );
while( $t_row = db_fetch_array( $t_result ) ) {
$t_basename = $t_row['basename'];
if( !plugin_is_registered( $t_basename ) ) {
plugin_register( $t_basename );
$g_plugin_cache_priority[$t_basename] = (int)$t_row['priority'];
$g_plugin_cache_protected[$t_basename] = (bool)$t_row['protected'];
}
}
}
/**
* Initialize all installed plugins.
* Post-signals EVENT_PLUGIN_INIT.
* @return void
*/
function plugin_init_installed() {
if( OFF == config_get_global( 'plugins_enabled' ) || !db_table_exists( db_get_table( 'plugin' ) ) ) {
return;
}
global $g_plugin_cache, $g_plugin_current, $g_plugin_cache_priority, $g_plugin_cache_protected, $g_plugin_cache_init;
$g_plugin_cache = array();
$g_plugin_current = array();
$g_plugin_cache_init = array();
$g_plugin_cache_priority = array();
$g_plugin_cache_protected = array();
plugin_register_installed();
$t_plugins = array_keys( $g_plugin_cache );
do {
$t_continue = false;
$t_plugins_retry = array();
foreach( $t_plugins as $t_basename ) {
if( plugin_init( $t_basename ) ) {
$t_continue = true;
} else {
# Dependent plugin
$t_plugins_retry[] = $t_basename;
}
}
$t_plugins = $t_plugins_retry;
} while( $t_continue );
event_signal( 'EVENT_PLUGIN_INIT' );
}
/**
* Initialize a single plugin.
* @param string $p_basename Plugin basename.
* @return boolean True if plugin initialized, false otherwise.
*/
function plugin_init( $p_basename ) {
global $g_plugin_cache, $g_plugin_cache_init;
# handle dependent plugins
if( isset( $g_plugin_cache[$p_basename] ) ) {
$t_plugin = $g_plugin_cache[$p_basename];
# hard dependencies; return false if the dependency is not registered,
# does not meet the version requirement, or is not yet initialized.
if( is_array( $t_plugin->requires ) ) {
foreach( $t_plugin->requires as $t_required => $t_version ) {
if( plugin_dependency( $t_required, $t_version, true ) !== 1 ) {
return false;
}
}
}
# soft dependencies; only return false if the soft dependency is
# registered, but not yet initialized.
if( is_array( $t_plugin->uses ) ) {
foreach( $t_plugin->uses as $t_used => $t_version ) {
if( isset( $g_plugin_cache[$t_used] ) && !isset( $g_plugin_cache_init[$t_used] ) ) {
return false;
}
}
}
# if plugin schema needs an upgrade, do not initialize
if( plugin_needs_upgrade( $t_plugin ) ) {
return false;
}
plugin_push_current( $p_basename );
# load plugin error strings
global $g_lang_strings;
$t_lang = lang_get_current();
$t_plugin_errors = $t_plugin->errors();
foreach( $t_plugin_errors as $t_error_name => $t_error_string ) {
$t_error_code = "plugin_${p_basename}_${t_error_name}";
$g_lang_strings[$t_lang]['MANTIS_ERROR'][$t_error_code] = $t_error_string;
}
# finish initializing the plugin
$t_plugin->__init();
$g_plugin_cache_init[$p_basename] = true;
plugin_pop_current();
return true;
} else {
return false;
}
}