-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathApiBase.php
1623 lines (1445 loc) · 60.6 KB
/
ApiBase.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
/**
*
*
* Created on Sep 5, 2006
*
* Copyright © 2006, 2010 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use Wikia\Logger\WikiaLogger;
/**
* This abstract class implements many basic API functions, and is the base of
* all API classes.
* The class functions are divided into several areas of functionality:
*
* Module parameters: Derived classes can define getAllowedParams() to specify
* which parameters to expect, how to parse and validate them.
*
* Profiling: various methods to allow keeping tabs on various tasks and their
* time costs
*
* Self-documentation: code to allow the API to document its own state
*
* @ingroup API
*/
abstract class ApiBase extends ContextSource {
// These constants allow modules to specify exactly how to treat incoming parameters.
const PARAM_DFLT = 0; // Default value of the parameter
const PARAM_ISMULTI = 1; // Boolean, do we accept more than one item for this parameter (e.g.: titles)?
const PARAM_TYPE = 2; // Can be either a string type (e.g.: 'integer') or an array of allowed values
const PARAM_MAX = 3; // Max value allowed for a parameter. Only applies if TYPE='integer'
const PARAM_MAX2 = 4; // Max value allowed for a parameter for bots and sysops. Only applies if TYPE='integer'
const PARAM_MIN = 5; // Lowest value allowed for a parameter. Only applies if TYPE='integer'
const PARAM_ALLOW_DUPLICATES = 6; // Boolean, do we allow the same value to be set more than once when ISMULTI=true
const PARAM_DEPRECATED = 7; // Boolean, is the parameter deprecated (will show a warning)
const PARAM_REQUIRED = 8; // Boolean, is the parameter required?
const PARAM_RANGE_ENFORCE = 9; // Boolean, if MIN/MAX are set, enforce (die) these? Only applies if TYPE='integer' Use with extreme caution
const LIMIT_BIG1 = 500; // Fast query, std user limit
const LIMIT_BIG2 = 5000; // Fast query, bot/sysop limit
const LIMIT_SML1 = 50; // Slow query, std user limit
const LIMIT_SML2 = 500; // Slow query, bot/sysop limit
private $mMainModule, $mModuleName, $mModulePrefix;
private $mParamCache = array();
// Wikia Change - BEGIN
/**
* @var array List of parameters being added to log context.
*/
protected $mLogContextVariables = ['action', 'prop'];
// Wikia Change - END
/**
* Constructor
* @param $mainModule ApiMain object
* @param $moduleName string Name of this module
* @param $modulePrefix string Prefix to use for parameter names
*/
public function __construct( $mainModule, $moduleName, $modulePrefix = '' ) {
$this->mMainModule = $mainModule;
$this->mModuleName = $moduleName;
$this->mModulePrefix = $modulePrefix;
if ( !$this->isMain() ) {
$this->setContext( $mainModule->getContext() );
}
}
/*****************************************************************************
* ABSTRACT METHODS *
*****************************************************************************/
/**
* Evaluates the parameters, performs the requested query, and sets up
* the result. Concrete implementations of ApiBase must override this
* method to provide whatever functionality their module offers.
* Implementations must not produce any output on their own and are not
* expected to handle any errors.
*
* The execute() method will be invoked directly by ApiMain immediately
* before the result of the module is output. Aside from the
* constructor, implementations should assume that no other methods
* will be called externally on the module before the result is
* processed.
*
* The result data should be stored in the ApiResult object available
* through getResult().
*/
public abstract function execute();
/**
* Returns a string that identifies the version of the extending class.
* Typically includes the class name, the svn revision, timestamp, and
* last author. Usually done with SVN's Id keyword
* @return string
*/
public abstract function getVersion();
/**
* Get the name of the module being executed by this instance
* @return string
*/
public function getModuleName() {
return $this->mModuleName;
}
/**
* Get parameter prefix (usually two letters or an empty string).
* @return string
*/
public function getModulePrefix() {
return $this->mModulePrefix;
}
/**
* Get the name of the module as shown in the profiler log
*
* @param $db DatabaseBase
*
* @return string
*/
public function getModuleProfileName( $db = false ) {
if ( $db ) {
return 'API:' . $this->mModuleName . '-DB';
} else {
return 'API:' . $this->mModuleName;
}
}
/**
* Get the main module
* @return ApiMain object
*/
public function getMain() {
return $this->mMainModule;
}
/**
* Returns true if this module is the main module ($this === $this->mMainModule),
* false otherwise.
* @return bool
*/
public function isMain() {
return $this === $this->mMainModule;
}
/**
* Get the result object
* @return ApiResult
*/
public function getResult() {
// Main module has getResult() method overriden
// Safety - avoid infinite loop:
if ( $this->isMain() ) {
ApiBase::dieDebug( __METHOD__, 'base method was called on main module. ' );
}
return $this->getMain()->getResult();
}
/**
* Get the result data array (read-only)
* @return array
*/
public function getResultData() {
return $this->getResult()->getData();
}
/**
* Create a new RequestContext object to use e.g. for calls to other parts
* the software.
* The object will have the WebRequest and the User object set to the ones
* used in this instance.
*
* @deprecated since 1.19 use getContext to get the current context
* @return DerivativeContext
*/
public function createContext() {
wfDeprecated( __METHOD__, '1.19' );
return new DerivativeContext( $this->getContext() );
}
/**
* Set warning section for this module. Users should monitor this
* section to notice any changes in API. Multiple calls to this
* function will result in the warning messages being separated by
* newlines
* @param $warning string Warning message
*/
public function setWarning( $warning ) {
$result = $this->getResult();
$data = $result->getData();
if ( isset( $data['warnings'][$this->getModuleName()] ) ) {
// Don't add duplicate warnings
$warn_regex = preg_quote( $warning, '/' );
if ( preg_match( "/{$warn_regex}(\\n|$)/", $data['warnings'][$this->getModuleName()]['*'] ) ) {
return;
}
$oldwarning = $data['warnings'][$this->getModuleName()]['*'];
// If there is a warning already, append it to the existing one
$warning = "$oldwarning\n$warning";
$result->unsetValue( 'warnings', $this->getModuleName() );
}
$msg = array();
ApiResult::setContent( $msg, $warning );
$result->disableSizeCheck();
$result->addValue( 'warnings', $this->getModuleName(), $msg );
$result->enableSizeCheck();
}
/**
* If the module may only be used with a certain format module,
* it should override this method to return an instance of that formatter.
* A value of null means the default format will be used.
* @return mixed instance of a derived class of ApiFormatBase, or null
*/
public function getCustomPrinter() {
return null;
}
/**
* Generates help message for this module, or false if there is no description
* @return mixed string or false
*/
public function makeHelpMsg() {
static $lnPrfx = "\n ";
$msg = $this->getFinalDescription();
if ( $msg !== false ) {
if ( !is_array( $msg ) ) {
$msg = array(
$msg
);
}
$msg = $lnPrfx . implode( $lnPrfx, $msg ) . "\n";
if ( $this->isReadMode() ) {
$msg .= "\nThis module requires read rights";
}
if ( $this->isWriteMode() ) {
$msg .= "\nThis module requires write rights";
}
if ( $this->mustBePosted() ) {
$msg .= "\nThis module only accepts POST requests";
}
if ( $this->isReadMode() || $this->isWriteMode() ||
$this->mustBePosted() ) {
$msg .= "\n";
}
// Parameters
$paramsMsg = $this->makeHelpMsgParameters();
if ( $paramsMsg !== false ) {
$msg .= "Parameters:\n$paramsMsg";
}
$examples = $this->getExamples();
if ( $examples !== false && $examples !== '' ) {
if ( !is_array( $examples ) ) {
$examples = array(
$examples
);
}
$msg .= "Example" . ( count( $examples ) > 1 ? 's' : '' ) . ":\n";
foreach( $examples as $k => $v ) {
if ( is_numeric( $k ) ) {
$msg .= " $v\n";
} else {
$v .= ":";
if ( is_array( $v ) ) {
$msgExample = implode( "\n", array_map( array( $this, 'indentExampleText' ), $v ) );
} else {
$msgExample = " $v";
}
$msg .= wordwrap( $msgExample, 100, "\n" ) . "\n $k\n";
}
}
}
$msg .= $this->makeHelpArrayToString( $lnPrfx, "Help page", $this->getHelpUrls() );
if ( $this->getMain()->getShowVersions() ) {
$versions = $this->getVersion();
$pattern = '/(\$.*) ([0-9a-z_]+\.php) (.*\$)/i';
$callback = array( $this, 'makeHelpMsg_callback' );
if ( is_array( $versions ) ) {
foreach ( $versions as &$v ) {
$v = preg_replace_callback( $pattern, $callback, $v );
}
$versions = implode( "\n ", $versions );
} else {
$versions = preg_replace_callback( $pattern, $callback, $versions );
}
$msg .= "Version:\n $versions\n";
}
}
return $msg;
}
/**
* @param $item string
* @return string
*/
private function indentExampleText( $item ) {
return " " . $item;
}
/**
* @param $prefix string Text to split output items
* @param $title string What is being output
* @param $input string|array
* @return string
*/
protected function makeHelpArrayToString( $prefix, $title, $input ) {
if ( $input === false ) {
return '';
}
if ( !is_array( $input ) ) {
$input = array(
$input
);
}
if ( count( $input ) > 0 ) {
$msg = $title . ( count( $input ) > 1 ? 's' : '' ) . ":\n ";
$msg .= implode( $prefix, $input ) . "\n";
return $msg;
}
return '';
}
/**
* Generates the parameter descriptions for this module, to be displayed in the
* module's help.
* @return string or false
*/
public function makeHelpMsgParameters() {
$params = $this->getFinalParams();
if ( $params ) {
$paramsDescription = $this->getFinalParamDescription();
$msg = '';
$paramPrefix = "\n" . str_repeat( ' ', 24 );
$descWordwrap = "\n" . str_repeat( ' ', 28 );
foreach ( $params as $paramName => $paramSettings ) {
$desc = isset( $paramsDescription[$paramName] ) ? $paramsDescription[$paramName] : '';
if ( is_array( $desc ) ) {
$desc = implode( $paramPrefix, $desc );
}
if ( !is_array( $paramSettings ) ) {
$paramSettings = array(
self::PARAM_DFLT => $paramSettings,
);
}
$deprecated = isset( $paramSettings[self::PARAM_DEPRECATED] ) ?
$paramSettings[self::PARAM_DEPRECATED] : false;
if ( $deprecated ) {
$desc = "DEPRECATED! $desc";
}
$required = isset( $paramSettings[self::PARAM_REQUIRED] ) ?
$paramSettings[self::PARAM_REQUIRED] : false;
if ( $required ) {
$desc .= $paramPrefix . "This parameter is required";
}
$type = isset( $paramSettings[self::PARAM_TYPE] ) ? $paramSettings[self::PARAM_TYPE] : null;
if ( isset( $type ) ) {
if ( isset( $paramSettings[self::PARAM_ISMULTI] ) && $paramSettings[self::PARAM_ISMULTI] ) {
$prompt = 'Values (separate with \'|\'): ';
} else {
$prompt = 'One value: ';
}
if ( is_array( $type ) ) {
$choices = array();
$nothingPrompt = false;
foreach ( $type as $t ) {
if ( $t === '' ) {
$nothingPrompt = 'Can be empty, or ';
} else {
$choices[] = $t;
}
}
$desc .= $paramPrefix . $nothingPrompt . $prompt;
$choicesstring = implode( ', ', $choices );
$desc .= wordwrap( $choicesstring, 100, $descWordwrap );
} else {
switch ( $type ) {
case 'namespace':
// Special handling because namespaces are type-limited, yet they are not given
$desc .= $paramPrefix . $prompt;
$desc .= wordwrap( implode( ', ', MWNamespace::getValidNamespaces() ),
100, $descWordwrap );
break;
case 'limit':
$desc .= $paramPrefix . "No more than {$paramSettings[self :: PARAM_MAX]}";
if ( isset( $paramSettings[self::PARAM_MAX2] ) ) {
$desc .= " ({$paramSettings[self::PARAM_MAX2]} for bots)";
}
$desc .= ' allowed';
break;
case 'integer':
$hasMin = isset( $paramSettings[self::PARAM_MIN] );
$hasMax = isset( $paramSettings[self::PARAM_MAX] );
if ( $hasMin || $hasMax ) {
if ( !$hasMax ) {
$intRangeStr = "The value must be no less than {$paramSettings[self::PARAM_MIN]}";
} elseif ( !$hasMin ) {
$intRangeStr = "The value must be no more than {$paramSettings[self::PARAM_MAX]}";
} else {
$intRangeStr = "The value must be between {$paramSettings[self::PARAM_MIN]} and {$paramSettings[self::PARAM_MAX]}";
}
$desc .= $paramPrefix . $intRangeStr;
}
break;
}
if ( isset( $paramSettings[self::PARAM_ISMULTI] ) ) {
$isArray = is_array( $paramSettings[self::PARAM_TYPE] );
if ( !$isArray
|| $isArray && count( $paramSettings[self::PARAM_TYPE] ) > self::LIMIT_SML1 ) {
$desc .= $paramPrefix . "Maximum number of values " .
self::LIMIT_SML1 . " (" . self::LIMIT_SML2 . " for bots)";
}
}
}
}
$default = is_array( $paramSettings )
? ( isset( $paramSettings[self::PARAM_DFLT] ) ? $paramSettings[self::PARAM_DFLT] : null )
: $paramSettings;
if ( !is_null( $default ) && $default !== false ) {
$desc .= $paramPrefix . "Default: $default";
}
$msg .= sprintf( " %-19s - %s\n", $this->encodeParamName( $paramName ), $desc );
}
return $msg;
} else {
return false;
}
}
/**
* Callback for preg_replace_callback() call in makeHelpMsg().
* Replaces a source file name with a link to ViewVC
*
* @param $matches array
* @return string
*/
public function makeHelpMsg_callback( $matches ) {
global $wgAutoloadClasses, $wgAutoloadLocalClasses;
$file = '';
if ( isset( $wgAutoloadLocalClasses[get_class( $this )] ) ) {
$file = $wgAutoloadLocalClasses[get_class( $this )];
} elseif ( isset( $wgAutoloadClasses[get_class( $this )] ) ) {
$file = $wgAutoloadClasses[get_class( $this )];
}
// Do some guesswork here
$path = strstr( $file, 'includes/api/' );
if ( $path === false ) {
$path = strstr( $file, 'extensions/' );
} else {
$path = 'phase3/' . $path;
}
// Get the filename from $matches[2] instead of $file
// If they're not the same file, they're assumed to be in the
// same directory
// This is necessary to make stuff like ApiMain::getVersion()
// returning the version string for ApiBase work
if ( $path ) {
return "{$matches[0]}\n https://svn.wikimedia.org/" .
"viewvc/mediawiki/trunk/" . dirname( $path ) .
"/{$matches[2]}";
}
return $matches[0];
}
/**
* Returns the description string for this module
* @return mixed string or array of strings
*/
protected function getDescription() {
return false;
}
/**
* Returns usage examples for this module. Return false if no examples are available.
* @return false|string|array
*/
public function getExamples() {
return false;
}
/**
* Returns an array of allowed parameters (parameter name) => (default
* value) or (parameter name) => (array with PARAM_* constants as keys)
* Don't call this function directly: use getFinalParams() to allow
* hooks to modify parameters as needed.
* @return array or false
*/
protected function getAllowedParams() {
return false;
}
/**
* Returns an array of parameter descriptions.
* Don't call this functon directly: use getFinalParamDescription() to
* allow hooks to modify descriptions as needed.
* @return array or false
*/
protected function getParamDescription() {
return false;
}
/**
* Get final list of parameters, after hooks have had a chance to
* tweak it as needed.
*
* @return array or false
*/
public function getFinalParams() {
$params = $this->getAllowedParams();
Hooks::run( 'APIGetAllowedParams', [ $this, &$params ] );
return $params;
}
/**
* Get final parameter descriptions, after hooks have had a chance to tweak it as
* needed.
*
* @return array
*/
public function getFinalParamDescription() {
$desc = $this->getParamDescription();
Hooks::run( 'APIGetParamDescription', [ $this, &$desc ] );
return $desc;
}
/**
* Get final module description, after hooks have had a chance to tweak it as
* needed.
*
* @return array
*/
public function getFinalDescription() {
$desc = $this->getDescription();
Hooks::run( 'APIGetDescription', [ $this, &$desc ] );
return $desc;
}
/**
* This method mangles parameter name based on the prefix supplied to the constructor.
* Override this method to change parameter name during runtime
* @param $paramName string Parameter name
* @return string Prefixed parameter name
*/
public function encodeParamName( $paramName ) {
return $this->mModulePrefix . $paramName;
}
/**
* Using getAllowedParams(), this function makes an array of the values
* provided by the user, with key being the name of the variable, and
* value - validated value from user or default. limits will not be
* parsed if $parseLimit is set to false; use this when the max
* limit is not definitive yet, e.g. when getting revisions.
* @param $parseLimit Boolean: true by default
* @return array
*/
public function extractRequestParams( $parseLimit = true ) {
// Cache parameters, for performance and to avoid bug 24564.
if ( !isset( $this->mParamCache[$parseLimit] ) ) {
$params = $this->getFinalParams();
$results = array();
if ( $params ) { // getFinalParams() can return false
foreach ( $params as $paramName => $paramSettings ) {
$results[$paramName] = $this->getParameterFromSettings(
$paramName, $paramSettings, $parseLimit );
}
}
$this->mParamCache[$parseLimit] = $results;
}
return $this->mParamCache[$parseLimit];
}
/**
* Get a value for the given parameter
* @param $paramName string Parameter name
* @param $parseLimit bool see extractRequestParams()
* @return mixed Parameter value
*/
protected function getParameter( $paramName, $parseLimit = true ) {
$params = $this->getFinalParams();
$paramSettings = $params[$paramName];
return $this->getParameterFromSettings( $paramName, $paramSettings, $parseLimit );
}
/**
* Die if none or more than one of a certain set of parameters is set and not false.
* @param $params array of parameter names
*/
public function requireOnlyOneParameter( $params ) {
$required = func_get_args();
array_shift( $required );
$intersection = array_intersect( array_keys( array_filter( $params,
array( $this, "parameterNotEmpty" ) ) ), $required );
if ( count( $intersection ) > 1 ) {
$this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
} elseif ( count( $intersection ) == 0 ) {
$this->dieUsage( 'One of the parameters ' . implode( ', ', $required ) . ' is required', 'missingparam' );
}
}
/**
* Generates the possible errors requireOnlyOneParameter() can die with
*
* @param $params array
* @return array
*/
public function getRequireOnlyOneParameterErrorMessages( $params ) {
$p = $this->getModulePrefix();
$params = implode( ", {$p}", $params );
return array(
array( 'code' => "{$p}missingparam", 'info' => "One of the parameters {$p}{$params} is required" ),
array( 'code' => "{$p}invalidparammix", 'info' => "The parameters {$p}{$params} can not be used together" )
);
}
/**
* Die if more than one of a certain set of parameters is set and not false.
*
* @param $params array
*/
public function requireMaxOneParameter( $params ) {
$required = func_get_args();
array_shift( $required );
$intersection = array_intersect( array_keys( array_filter( $params,
array( $this, "parameterNotEmpty" ) ) ), $required );
if ( count( $intersection ) > 1 ) {
$this->dieUsage( 'The parameters ' . implode( ', ', $intersection ) . ' can not be used together', 'invalidparammix' );
}
}
/**
* Generates the possible error requireMaxOneParameter() can die with
*
* @param $params array
* @return array
*/
public function getRequireMaxOneParameterErrorMessages( $params ) {
$p = $this->getModulePrefix();
$params = implode( ", {$p}", $params );
return array(
array( 'code' => "{$p}invalidparammix", 'info' => "The parameters {$p}{$params} can not be used together" )
);
}
/**
* Callback function used in requireOnlyOneParameter to check whether reequired parameters are set
*
* @param $x object Parameter to check is not null/false
* @return bool
*/
private function parameterNotEmpty( $x ) {
return !is_null( $x ) && $x !== false;
}
/**
* @deprecated since 1.17 use MWNamespace::getValidNamespaces()
*
* @return array
*/
public static function getValidNamespaces() {
wfDeprecated( __METHOD__, '1.17' );
return MWNamespace::getValidNamespaces();
}
/**
* Return true if we're to watch the page, false if not, null if no change.
* @param $watchlist String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
* @param $titleObj Title the page under consideration
* @param $userOption String The user option to consider when $watchlist=preferences.
* If not set will magically default to either watchdefault or watchcreations
* @return bool
*/
protected function getWatchlistValue ( $watchlist, $titleObj, $userOption = null ) {
$userWatching = $titleObj->userIsWatching();
switch ( $watchlist ) {
case 'watch':
return true;
case 'unwatch':
return false;
case 'preferences':
# If the user is already watching, don't bother checking
if ( $userWatching ) {
return true;
}
# If no user option was passed, use watchdefault or watchcreation
if ( is_null( $userOption ) ) {
$userOption = $titleObj->exists()
? 'watchdefault' : 'watchcreations';
}
# Watch the article based on the user preference
return (bool)$this->getUser()->getGlobalPreference( $userOption );
case 'nochange':
return $userWatching;
default:
return $userWatching;
}
}
/**
* Set a watch (or unwatch) based the based on a watchlist parameter.
* @param $watch String Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
* @param $titleObj Title the article's title to change
* @param $userOption String The user option to consider when $watch=preferences
*/
protected function setWatch( $watch, $titleObj, $userOption = null ) {
$value = $this->getWatchlistValue( $watch, $titleObj, $userOption );
if ( $value === null ) {
return;
}
$user = $this->getUser();
if ( $value ) {
WatchAction::doWatch( $titleObj, $user );
} else {
WatchAction::doUnwatch( $titleObj, $user );
}
}
/**
* Using the settings determine the value for the given parameter
*
* @param $paramName String: parameter name
* @param $paramSettings Mixed: default value or an array of settings
* using PARAM_* constants.
* @param $parseLimit Boolean: parse limit?
* @return mixed Parameter value
*/
protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) {
// Some classes may decide to change parameter names
$encParamName = $this->encodeParamName( $paramName );
if ( !is_array( $paramSettings ) ) {
$default = $paramSettings;
$multi = false;
$type = gettype( $paramSettings );
$dupes = false;
$deprecated = false;
$required = false;
} else {
$default = isset( $paramSettings[self::PARAM_DFLT] ) ? $paramSettings[self::PARAM_DFLT] : null;
$multi = isset( $paramSettings[self::PARAM_ISMULTI] ) ? $paramSettings[self::PARAM_ISMULTI] : false;
$type = isset( $paramSettings[self::PARAM_TYPE] ) ? $paramSettings[self::PARAM_TYPE] : null;
$dupes = isset( $paramSettings[self::PARAM_ALLOW_DUPLICATES] ) ? $paramSettings[self::PARAM_ALLOW_DUPLICATES] : false;
$deprecated = isset( $paramSettings[self::PARAM_DEPRECATED] ) ? $paramSettings[self::PARAM_DEPRECATED] : false;
$required = isset( $paramSettings[self::PARAM_REQUIRED] ) ? $paramSettings[self::PARAM_REQUIRED] : false;
// When type is not given, and no choices, the type is the same as $default
if ( !isset( $type ) ) {
if ( isset( $default ) ) {
$type = gettype( $default );
} else {
$type = 'NULL'; // allow everything
}
}
}
if ( $type == 'boolean' ) {
if ( isset( $default ) && $default !== false ) {
// Having a default value of anything other than 'false' is pointless
ApiBase::dieDebug( __METHOD__, "Boolean param $encParamName's default is set to '$default'" );
}
$value = $this->getRequest()->getCheck( $encParamName );
} else {
$value = $this->getRequest()->getVal( $encParamName, $default );
if ( isset( $value ) && $type == 'namespace' ) {
$type = MWNamespace::getValidNamespaces();
}
}
if ( isset( $value ) && ( $multi || is_array( $type ) ) ) {
$value = $this->parseMultiValue( $encParamName, $value, $multi, is_array( $type ) ? $type : null );
}
// More validation only when choices were not given
// choices were validated in parseMultiValue()
if ( isset( $value ) ) {
if ( !is_array( $type ) ) {
switch ( $type ) {
case 'NULL': // nothing to do
break;
case 'string':
if ( $required && $value === '' ) {
$this->dieUsageMsg( array( 'missingparam', $paramName ) );
}
break;
case 'integer': // Force everything using intval() and optionally validate limits
$min = isset ( $paramSettings[self::PARAM_MIN] ) ? $paramSettings[self::PARAM_MIN] : null;
$max = isset ( $paramSettings[self::PARAM_MAX] ) ? $paramSettings[self::PARAM_MAX] : null;
$enforceLimits = isset ( $paramSettings[self::PARAM_RANGE_ENFORCE] )
? $paramSettings[self::PARAM_RANGE_ENFORCE] : false;
if ( is_array( $value ) ) {
$value = array_map( 'intval', $value );
if ( !is_null( $min ) || !is_null( $max ) ) {
foreach ( $value as &$v ) {
$this->validateLimit( $paramName, $v, $min, $max, null, $enforceLimits );
}
}
} else {
$value = intval( $value );
if ( !is_null( $min ) || !is_null( $max ) ) {
$this->validateLimit( $paramName, $value, $min, $max, null, $enforceLimits );
}
}
break;
case 'limit':
if ( !$parseLimit ) {
// Don't do any validation whatsoever
break;
}
if ( !isset( $paramSettings[self::PARAM_MAX] ) || !isset( $paramSettings[self::PARAM_MAX2] ) ) {
ApiBase::dieDebug( __METHOD__, "MAX1 or MAX2 are not defined for the limit $encParamName" );
}
if ( $multi ) {
ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
}
$min = isset( $paramSettings[self::PARAM_MIN] ) ? $paramSettings[self::PARAM_MIN] : 0;
if ( $value == 'max' ) {
$value = $this->getMain()->canApiHighLimits() ? $paramSettings[self::PARAM_MAX2] : $paramSettings[self::PARAM_MAX];
$this->getResult()->setParsedLimit( $this->getModuleName(), $value );
} else {
$value = intval( $value );
$this->validateLimit( $paramName, $value, $min, $paramSettings[self::PARAM_MAX], $paramSettings[self::PARAM_MAX2] );
}
break;
case 'boolean':
if ( $multi ) {
ApiBase::dieDebug( __METHOD__, "Multi-values not supported for $encParamName" );
}
break;
case 'timestamp':
if ( is_array( $value ) ) {
foreach ( $value as $key => $val ) {
$value[$key] = $this->validateTimestamp( $val, $encParamName );
}
} else {
$value = $this->validateTimestamp( $value, $encParamName );
}
break;
case 'user':
if ( !is_array( $value ) ) {
$value = array( $value );
}
foreach ( $value as $key => $val ) {
$title = Title::makeTitleSafe( NS_USER, $val );
if ( is_null( $title ) ) {
$this->dieUsage( "Invalid value for user parameter $encParamName", "baduser_{$encParamName}" );
}
$value[$key] = $title->getText();
}
if ( !$multi ) {
$value = $value[0];
}
break;
default:
ApiBase::dieDebug( __METHOD__, "Param $encParamName's type is unknown - $type" );
}
}
// Throw out duplicates if requested
if ( is_array( $value ) && !$dupes ) {
$value = array_unique( $value );
}
// Set a warning if a deprecated parameter has been passed
if ( $deprecated && $value !== false ) {
$this->setWarning( "The $encParamName parameter has been deprecated." );
}
} elseif ( $required ) {
$this->dieUsageMsg( array( 'missingparam', $paramName ) );
}
return $value;
}
/**
* Return an array of values that were given in a 'a|b|c' notation,
* after it optionally validates them against the list allowed values.
*
* @param $valueName string The name of the parameter (for error
* reporting)
* @param $value mixed The value being parsed
* @param $allowMultiple bool Can $value contain more than one value
* separated by '|'?
* @param $allowedValues mixed An array of values to check against. If
* null, all values are accepted.
* @return mixed (allowMultiple ? an_array_of_values : a_single_value)
*/
protected function parseMultiValue( $valueName, $value, $allowMultiple, $allowedValues ) {
if ( trim( $value ) === '' && $allowMultiple ) {
return array();
}
// This is a bit awkward, but we want to avoid calling canApiHighLimits() because it unstubs $wgUser
$valuesList = explode( '|', $value, self::LIMIT_SML2 + 1 );
$sizeLimit = count( $valuesList ) > self::LIMIT_SML1 && $this->mMainModule->canApiHighLimits() ?
self::LIMIT_SML2 : self::LIMIT_SML1;
if ( self::truncateArray( $valuesList, $sizeLimit ) ) {
$this->setWarning( "Too many values supplied for parameter '$valueName': the limit is $sizeLimit" );
}
if ( !$allowMultiple && count( $valuesList ) != 1 ) {
// Bug 33482 - Allow entries with | in them for non-multiple values
if ( in_array( $value, $allowedValues ) ) {
return $value;
}
$possibleValues = is_array( $allowedValues ) ? "of '" . implode( "', '", $allowedValues ) . "'" : '';
$this->dieUsage( "Only one $possibleValues is allowed for parameter '$valueName'", "multival_$valueName" );
}
if ( is_array( $allowedValues ) ) {
// Check for unknown values
$unknown = array_diff( $valuesList, $allowedValues );
if ( count( $unknown ) ) {
if ( $allowMultiple ) {
$s = count( $unknown ) > 1 ? 's' : '';
$vals = implode( ", ", $unknown );
$this->setWarning( "Unrecognized value$s for parameter '$valueName': $vals" );
} else {
$this->dieUsage( "Unrecognized value for parameter '$valueName': {$valuesList[0]}", "unknown_$valueName" );
}
}
// Now throw them out
$valuesList = array_intersect( $valuesList, $allowedValues );
}