ApiFormatPhp::execute()   C
last analyzed

Complexity

Conditions 7
Paths 8

Size

Total Lines 42
Code Lines 26

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 7
eloc 26
nc 8
nop 0
dl 0
loc 42
rs 6.7272
c 0
b 0
f 0
1
<?php
2
/**
3
 *
4
 *
5
 * Created on Oct 22, 2006
6
 *
7
 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
8
 *
9
 * This program is free software; you can redistribute it and/or modify
10
 * it under the terms of the GNU General Public License as published by
11
 * the Free Software Foundation; either version 2 of the License, or
12
 * (at your option) any later version.
13
 *
14
 * This program is distributed in the hope that it will be useful,
15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17
 * GNU General Public License for more details.
18
 *
19
 * You should have received a copy of the GNU General Public License along
20
 * with this program; if not, write to the Free Software Foundation, Inc.,
21
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22
 * http://www.gnu.org/copyleft/gpl.html
23
 *
24
 * @file
25
 */
26
27
/**
28
 * API Serialized PHP output formatter
29
 * @ingroup API
30
 */
31
class ApiFormatPhp extends ApiFormatBase {
32
33
	public function getMimeType() {
34
		return 'application/vnd.php.serialized';
35
	}
36
37
	public function execute() {
38
		$params = $this->extractRequestParams();
39
40
		switch ( $params['formatversion'] ) {
41
			case 1:
42
				$transforms = [
43
					'BC' => [],
44
					'Types' => [],
45
					'Strip' => 'all',
46
				];
47
				break;
48
49
			case 2:
50
			case 'latest':
51
				$transforms = [
52
					'Types' => [],
53
					'Strip' => 'all',
54
				];
55
				break;
56
57
			default:
58
				$this->dieUsage( __METHOD__ . ': Unknown value for \'formatversion\'', 'unknownformatversion' );
59
		}
60
		$text = serialize( $this->getResult()->getResultData( null, $transforms ) );
0 ignored issues
show
Bug introduced by
The variable $transforms does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
61
62
		// Bug 66776: wfMangleFlashPolicy() is needed to avoid a nasty bug in
63
		// Flash, but what it does isn't friendly for the API. There's nothing
64
		// we can do here that isn't actively broken in some manner, so let's
65
		// just be broken in a useful manner.
66
		if ( $this->getConfig()->get( 'MangleFlashPolicy' ) &&
67
			in_array( 'wfOutputHandler', ob_list_handlers(), true ) &&
68
			preg_match( '/\<\s*cross-domain-policy(?=\s|\>)/i', $text )
69
		) {
70
			$this->dieUsage(
71
				'This response cannot be represented using format=php. ' .
72
				'See https://phabricator.wikimedia.org/T68776',
73
				'internalerror'
74
			);
75
		}
76
77
		$this->printText( $text );
78
	}
79
80
	public function getAllowedParams() {
81
		$ret = parent::getAllowedParams() + [
82
			'formatversion' => [
83
				ApiBase::PARAM_TYPE => [ 1, 2, 'latest' ],
84
				ApiBase::PARAM_DFLT => 1,
85
				ApiBase::PARAM_HELP_MSG => 'apihelp-php-param-formatversion',
86
			],
87
		];
88
		return $ret;
89
	}
90
}
91