Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
51.11% covered (warning)
51.11%
23 / 45
37.50% covered (danger)
37.50%
3 / 8
CRAP
0.00% covered (danger)
0.00%
0 / 1
MemcachedBagOStuff
52.27% covered (warning)
52.27%
23 / 44
37.50% covered (danger)
37.50%
3 / 8
63.49
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
1
 makeKeyInternal
100.00% covered (success)
100.00%
16 / 16
100.00% covered (success)
100.00%
1 / 1
5
 requireConvertGenericKey
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 validateKeyEncoding
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
 validateKeyAndPrependRoute
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 stripRouteFromKey
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 fixExpiry
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 doIncrWithInit
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 doIncrWithInitAsync
n/a
0 / 0
n/a
0 / 0
0
 doIncrWithInitSync
n/a
0 / 0
n/a
0 / 0
0
1<?php
2/**
3 * Base class for memcached clients.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Cache
22 */
23
24namespace Wikimedia\ObjectCache;
25
26use Exception;
27use InvalidArgumentException;
28use RuntimeException;
29
30/**
31 * Base class for memcached clients.
32 *
33 * @ingroup Cache
34 */
35abstract class MemcachedBagOStuff extends MediumSpecificBagOStuff {
36    /** @var string Routing prefix appended to keys during operations */
37    protected $routingPrefix;
38
39    /**
40     * @param array $params Additional parameters include:
41     *   - routingPrefix: a routing prefix of the form "<datacenter>/<cluster>/" used to convey
42     *      the location/strategy to use for handling keys accessed from this instance. The prefix
43     *      is prepended to keys during cache operations. The memcached proxy must preserve these
44     *      prefixes in any responses that include requested keys (e.g. get/gets). The proxy is
45     *      also assumed to strip the routing prefix from the stored key name, which allows for
46     *      unprefixed access. This can be used with mcrouter. [optional]
47     */
48    public function __construct( array $params ) {
49        $params['segmentationSize'] ??= 917_504; // < 1MiB
50        parent::__construct( $params );
51
52        $this->routingPrefix = $params['routingPrefix'] ?? '';
53
54        // ...and does not use special disk-cache plugins
55        $this->attrMap[self::ATTR_DURABILITY] = self::QOS_DURABILITY_SERVICE;
56    }
57
58    /**
59     * Format a cache key.
60     *
61     * @since 1.27
62     * @see BagOStuff::makeKeyInternal
63     *
64     * @param string $keyspace
65     * @param string[]|int[] $components
66     *
67     * @return string
68     */
69    protected function makeKeyInternal( $keyspace, $components ) {
70        // Memcached keys have a maximum length of 255 characters. From that,
71        // subtract the number of characters we need for the keyspace and for
72        // the separator character needed for each argument. To handle some
73        // custom prefixes used by thing like WANObjectCache, limit to 205.
74        $charsLeft = 205 - strlen( $keyspace ) - count( $components );
75
76        foreach ( $components as &$component ) {
77            $component = strtr( $component, ' ', '_' );
78
79            // Make sure %, #, and non-ASCII chars are escaped
80            $component = preg_replace_callback(
81                '/[^\x21-\x22\x24\x26-\x39\x3b-\x7e]+/',
82                static function ( $m ) {
83                    return rawurlencode( $m[0] );
84                },
85                $component
86            );
87
88            // 33 = 32 characters for the MD5 + 1 for the '#' prefix.
89            if ( $charsLeft > 33 && strlen( $component ) > $charsLeft ) {
90                $component = '#' . md5( $component );
91            }
92
93            $charsLeft -= strlen( $component );
94        }
95
96        if ( $charsLeft < 0 ) {
97            return $keyspace . ':BagOStuff-long-key:##' . md5( implode( ':', $components ) );
98        }
99
100        return $keyspace . ':' . implode( ':', $components );
101    }
102
103    protected function requireConvertGenericKey(): bool {
104        return true;
105    }
106
107    /**
108     * Ensure that a key is safe to use (contains no control characters and no
109     * characters above the ASCII range.)
110     *
111     * @param string $key
112     *
113     * @return string
114     * @throws Exception
115     */
116    public function validateKeyEncoding( $key ) {
117        if ( preg_match( '/[^\x21-\x7e]+/', $key ) ) {
118            throw new InvalidArgumentException( "Key contains invalid characters: $key" );
119        }
120
121        return $key;
122    }
123
124    /**
125     * @param string $key
126     *
127     * @return string
128     */
129    protected function validateKeyAndPrependRoute( $key ) {
130        $this->validateKeyEncoding( $key );
131
132        if ( $this->routingPrefix === '' ) {
133            return $key;
134        }
135
136        if ( $key[0] === '/' ) {
137            throw new RuntimeException( "Key '$key' already contains a route." );
138        }
139
140        return $this->routingPrefix . $key;
141    }
142
143    /**
144     * @param string $key
145     *
146     * @return string
147     */
148    protected function stripRouteFromKey( $key ) {
149        if ( $this->routingPrefix === '' ) {
150            return $key;
151        }
152
153        if ( str_starts_with( $key, $this->routingPrefix ) ) {
154            return substr( $key, strlen( $this->routingPrefix ) );
155        }
156
157        return $key;
158    }
159
160    /**
161     * @param int|float $exptime
162     *
163     * @return int
164     */
165    protected function fixExpiry( $exptime ) {
166        if ( $exptime < 0 ) {
167            // The PECL driver does not seem to like negative relative values
168            $expiresAt = $this->getCurrentTime() + $exptime;
169        } elseif ( $this->isRelativeExpiration( $exptime ) ) {
170            // TTLs higher than 30 days will be detected as absolute TTLs
171            // (UNIX timestamps), and will result in the cache entry being
172            // discarded immediately because the expiry is in the past.
173            // Clamp expires >30d at 30d, unless they're >=1e9 in which
174            // case they are likely to really be absolute (1e9 = 2011-09-09)
175            $expiresAt = min( $exptime, self::TTL_MONTH );
176        } else {
177            $expiresAt = $exptime;
178        }
179
180        return (int)$expiresAt;
181    }
182
183    protected function doIncrWithInit( $key, $exptime, $step, $init, $flags ) {
184        if ( $flags & self::WRITE_BACKGROUND ) {
185            return $this->doIncrWithInitAsync( $key, $exptime, $step, $init );
186        } else {
187            return $this->doIncrWithInitSync( $key, $exptime, $step, $init );
188        }
189    }
190
191    /**
192     * @param string $key
193     * @param int $exptime
194     * @param int $step
195     * @param int $init
196     *
197     * @return bool True on success, false on failure
198     */
199    abstract protected function doIncrWithInitAsync( $key, $exptime, $step, $init );
200
201    /**
202     * @param string $key
203     * @param int $exptime
204     * @param int $step
205     * @param int $init
206     *
207     * @return int|bool New value or false on failure
208     */
209    abstract protected function doIncrWithInitSync( $key, $exptime, $step, $init );
210}
211
212/** @deprecated class alias since 1.43 */
213class_alias( MemcachedBagOStuff::class, 'MemcachedBagOStuff' );