Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
74.58% covered (warning)
74.58%
44 / 59
41.67% covered (danger)
41.67%
5 / 12
 CRAP
0.00% covered (danger)
0.00%
0 / 1
FauxResponse
75.86% covered (warning)
75.86%
44 / 58
41.67% covered (danger)
41.67%
5 / 12
 30.44
0.00% covered (danger)
0.00%
0 / 1
 header
63.64% covered (warning)
63.64%
7 / 11
0.00% covered (danger)
0.00%
0 / 1
 7.73
 statusHeader
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 headersSent
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 getHeader
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
 1
 getStatusCode
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getCookieConfig
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
 6
 setCookieConfig
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
 setCookie
90.62% covered (success)
90.62%
29 / 32
0.00% covered (danger)
0.00%
0 / 1
 5.02
 getCookie
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
 2
 getCookieData
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getCookies
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 hasCookies
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
 2
1<?php
2
3/**
4 * Classes used to send headers and cookies back to the user
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
20 *
21 * @file
22 */
23
24namespace MediaWiki\Request;
25
26use MediaWiki\Config\Config;
27use MediaWiki\MainConfigNames;
28use MediaWiki\MediaWikiServices;
29
30/**
31 * @ingroup HTTP
32 */
33class FauxResponse extends WebResponse {
34    private $headers;
35    private $cookies = [];
36    private $code;
37
38    /** @var ?Config */
39    private $cookieConfig = null;
40
41    /**
42     * Stores a HTTP header
43     * @param string $string Header to output
44     * @param bool $replace Replace current similar header
45     * @param null|int $http_response_code Forces the HTTP response code to the specified value.
46     */
47    public function header( $string, $replace = true, $http_response_code = null ) {
48        if ( $this->disableForPostSend ) {
49            return;
50        }
51
52        if ( str_starts_with( $string, 'HTTP/' ) ) {
53            $parts = explode( ' ', $string, 3 );
54            $this->code = intval( $parts[1] );
55        } else {
56            [ $key, $val ] = array_map( 'trim', explode( ":", $string, 2 ) );
57
58            $key = strtoupper( $key );
59
60            if ( $replace || !isset( $this->headers[$key] ) ) {
61                $this->headers[$key] = $val;
62            }
63        }
64
65        if ( $http_response_code ) {
66            $this->code = intval( $http_response_code );
67        }
68    }
69
70    /**
71     * @since 1.26
72     * @param int $code Status code
73     */
74    public function statusHeader( $code ) {
75        $this->code = intval( $code );
76    }
77
78    public function headersSent() {
79        return false;
80    }
81
82    /**
83     * @param string $key The name of the header to get (case insensitive).
84     * @return string|null The header value (if set); null otherwise.
85     */
86    public function getHeader( $key ) {
87        $key = strtoupper( $key );
88
89        return $this->headers[$key] ?? null;
90    }
91
92    /**
93     * Get the HTTP response code, null if not set
94     *
95     * @return int|null
96     */
97    public function getStatusCode() {
98        return $this->code;
99    }
100
101    /**
102     * @return Config
103     */
104    private function getCookieConfig(): Config {
105        if ( !$this->cookieConfig ) {
106            $this->cookieConfig = MediaWikiServices::getInstance()->getMainConfig();
107        }
108        return $this->cookieConfig;
109    }
110
111    /**
112     * @param Config $cookieConfig
113     */
114    public function setCookieConfig( Config $cookieConfig ): void {
115        $this->cookieConfig = $cookieConfig;
116    }
117
118    /**
119     * @param string $name The name of the cookie.
120     * @param string $value The value to be stored in the cookie.
121     * @param int|null $expire Ignored in this faux subclass.
122     * @param array $options Ignored in this faux subclass.
123     */
124    public function setCookie( $name, $value, $expire = 0, $options = [] ) {
125        if ( $this->disableForPostSend ) {
126            return;
127        }
128
129        $cookieConfig = $this->getCookieConfig();
130        $cookiePath = $cookieConfig->get( MainConfigNames::CookiePath );
131        $cookiePrefix = $cookieConfig->get( MainConfigNames::CookiePrefix );
132        $cookieDomain = $cookieConfig->get( MainConfigNames::CookieDomain );
133        $cookieSecure = $cookieConfig->get( MainConfigNames::CookieSecure );
134        $cookieExpiration = $cookieConfig->get( MainConfigNames::CookieExpiration );
135        $cookieHttpOnly = $cookieConfig->get( MainConfigNames::CookieHttpOnly );
136        $options = array_filter( $options, static function ( $a ) {
137            return $a !== null;
138        } ) + [
139            'prefix' => $cookiePrefix,
140            'domain' => $cookieDomain,
141            'path' => $cookiePath,
142            'secure' => $cookieSecure,
143            'httpOnly' => $cookieHttpOnly,
144            'raw' => false,
145        ];
146
147        if ( $expire === null ) {
148            $expire = 0; // Session cookie
149        } elseif ( $expire == 0 && $cookieExpiration != 0 ) {
150            $expire = time() + $cookieExpiration;
151        }
152
153        $this->cookies[$options['prefix'] . $name] = [
154            'value' => (string)$value,
155            'expire' => (int)$expire,
156            'path' => (string)$options['path'],
157            'domain' => (string)$options['domain'],
158            'secure' => (bool)$options['secure'],
159            'httpOnly' => (bool)$options['httpOnly'],
160            'raw' => (bool)$options['raw'],
161        ];
162    }
163
164    /**
165     * @param string $name
166     * @return string|null
167     */
168    public function getCookie( $name ) {
169        if ( isset( $this->cookies[$name] ) ) {
170            return $this->cookies[$name]['value'];
171        }
172        return null;
173    }
174
175    /**
176     * @param string $name
177     * @return array|null
178     */
179    public function getCookieData( $name ) {
180        return $this->cookies[$name] ?? null;
181    }
182
183    /**
184     * @return array[]
185     */
186    public function getCookies() {
187        return $this->cookies;
188    }
189
190    /**
191     * @inheritDoc
192     */
193    public function hasCookies() {
194        return count( $this->cookies ) > 0;
195    }
196
197}
198
199/** @deprecated class alias since 1.40 */
200class_alias( FauxResponse::class, 'FauxResponse' );