3 * This file deals with UID generation.
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.
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.
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
22 use Wikimedia\Assert\Assert
;
23 use MediaWiki\MediaWikiServices
;
26 * Class for getting statistically unique IDs
31 /** @var UIDGenerator */
32 protected static $instance = null;
33 /** @var string Local file path */
34 protected $nodeIdFile;
35 /** @var string Node ID in binary (32 bits) */
37 /** @var string Node ID in binary (48 bits) */
40 /** @var string Local file path */
41 protected $lockFile88;
42 /** @var string Local file path */
43 protected $lockFile128;
44 /** @var string Local file path */
45 protected $lockFileUUID;
47 /** @var array Cached file handles */
48 protected $fileHandles = []; // cached file handles
50 const QUICK_RAND
= 1; // get randomness from fast and insecure sources
51 const QUICK_VOLATILE
= 2; // use an APC like in-memory counter if available
53 protected function __construct() {
54 $this->nodeIdFile
= wfTempDir() . '/mw-' . __CLASS__
. '-UID-nodeid';
56 if ( is_file( $this->nodeIdFile
) ) {
57 $nodeId = file_get_contents( $this->nodeIdFile
);
59 // Try to get some ID that uniquely identifies this machine (RFC 4122)...
60 if ( !preg_match( '/^[0-9a-f]{12}$/i', $nodeId ) ) {
61 Wikimedia\
suppressWarnings();
62 if ( wfIsWindows() ) {
63 // https://technet.microsoft.com/en-us/library/bb490913.aspx
64 $csv = trim( wfShellExec( 'getmac /NH /FO CSV' ) );
65 $line = substr( $csv, 0, strcspn( $csv, "\n" ) );
66 $info = str_getcsv( $line );
67 $nodeId = isset( $info[0] ) ?
str_replace( '-', '', $info[0] ) : '';
68 } elseif ( is_executable( '/sbin/ifconfig' ) ) { // Linux/BSD/Solaris/OS X
69 // See https://linux.die.net/man/8/ifconfig
71 preg_match( '/\s([0-9a-f]{2}(:[0-9a-f]{2}){5})\s/',
72 wfShellExec( '/sbin/ifconfig -a' ), $m );
73 $nodeId = isset( $m[1] ) ?
str_replace( ':', '', $m[1] ) : '';
75 Wikimedia\restoreWarnings
();
76 if ( !preg_match( '/^[0-9a-f]{12}$/i', $nodeId ) ) {
77 $nodeId = MWCryptRand
::generateHex( 12, true );
78 $nodeId[1] = dechex( hexdec( $nodeId[1] ) |
0x1 ); // set multicast bit
80 file_put_contents( $this->nodeIdFile
, $nodeId ); // cache
82 $this->nodeId32
= Wikimedia\base_convert
( substr( sha1( $nodeId ), 0, 8 ), 16, 2, 32 );
83 $this->nodeId48
= Wikimedia\base_convert
( $nodeId, 16, 2, 48 );
84 // If different processes run as different users, they may have different temp dirs.
85 // This is dealt with by initializing the clock sequence number and counters randomly.
86 $this->lockFile88
= wfTempDir() . '/mw-' . __CLASS__
. '-UID-88';
87 $this->lockFile128
= wfTempDir() . '/mw-' . __CLASS__
. '-UID-128';
88 $this->lockFileUUID
= wfTempDir() . '/mw-' . __CLASS__
. '-UUID-128';
92 * @todo move to MW-specific factory class and inject temp dir
93 * @return UIDGenerator
95 protected static function singleton() {
96 if ( self
::$instance === null ) {
97 self
::$instance = new self();
100 return self
::$instance;
104 * Get a statistically unique 88-bit unsigned integer ID string.
105 * The bits of the UID are prefixed with the time (down to the millisecond).
107 * These IDs are suitable as values for the shard key of distributed data.
108 * If a column uses these as values, it should be declared UNIQUE to handle collisions.
109 * New rows almost always have higher UIDs, which makes B-TREE updates on INSERT fast.
110 * They can also be stored "DECIMAL(27) UNSIGNED" or BINARY(11) in MySQL.
112 * UID generation is serialized on each server (as the node ID is for the whole machine).
114 * @param int $base Specifies a base other than 10
115 * @return string Number
116 * @throws RuntimeException
118 public static function newTimestampedUID88( $base = 10 ) {
119 Assert
::parameterType( 'integer', $base, '$base' );
120 Assert
::parameter( $base <= 36, '$base', 'must be <= 36' );
121 Assert
::parameter( $base >= 2, '$base', 'must be >= 2' );
123 $gen = self
::singleton();
124 $info = $gen->getTimeAndDelay( 'lockFile88', 1, 1024, 1024 );
125 $info['offsetCounter'] = $info['offsetCounter'] %
1024;
126 return Wikimedia\base_convert
( $gen->getTimestampedID88( $info ), 2, $base );
130 * @param array $info result of UIDGenerator::getTimeAndDelay(), or
131 * for sub classes, a seqencial array like (time, offsetCounter).
132 * @return string 88 bits
133 * @throws RuntimeException
135 protected function getTimestampedID88( array $info ) {
136 if ( isset( $info['time'] ) ) {
137 $time = $info['time'];
138 $counter = $info['offsetCounter'];
143 // Take the 46 LSBs of "milliseconds since epoch"
144 $id_bin = $this->millisecondsSinceEpochBinary( $time );
145 // Add a 10 bit counter resulting in 56 bits total
146 $id_bin .= str_pad( decbin( $counter ), 10, '0', STR_PAD_LEFT
);
147 // Add the 32 bit node ID resulting in 88 bits total
148 $id_bin .= $this->nodeId32
;
149 // Convert to a 1-27 digit integer string
150 if ( strlen( $id_bin ) !== 88 ) {
151 throw new RuntimeException( "Detected overflow for millisecond timestamp." );
158 * Get a statistically unique 128-bit unsigned integer ID string.
159 * The bits of the UID are prefixed with the time (down to the millisecond).
161 * These IDs are suitable as globally unique IDs, without any enforced uniqueness.
162 * New rows almost always have higher UIDs, which makes B-TREE updates on INSERT fast.
163 * They can also be stored as "DECIMAL(39) UNSIGNED" or BINARY(16) in MySQL.
165 * UID generation is serialized on each server (as the node ID is for the whole machine).
167 * @param int $base Specifies a base other than 10
168 * @return string Number
169 * @throws RuntimeException
171 public static function newTimestampedUID128( $base = 10 ) {
172 Assert
::parameterType( 'integer', $base, '$base' );
173 Assert
::parameter( $base <= 36, '$base', 'must be <= 36' );
174 Assert
::parameter( $base >= 2, '$base', 'must be >= 2' );
176 $gen = self
::singleton();
177 $info = $gen->getTimeAndDelay( 'lockFile128', 16384, 1048576, 1048576 );
178 $info['offsetCounter'] = $info['offsetCounter'] %
1048576;
180 return Wikimedia\base_convert
( $gen->getTimestampedID128( $info ), 2, $base );
184 * @param array $info The result of UIDGenerator::getTimeAndDelay(),
185 * for sub classes, a seqencial array like (time, offsetCounter, clkSeq).
186 * @return string 128 bits
187 * @throws RuntimeException
189 protected function getTimestampedID128( array $info ) {
190 if ( isset( $info['time'] ) ) {
191 $time = $info['time'];
192 $counter = $info['offsetCounter'];
193 $clkSeq = $info['clkSeq'];
199 // Take the 46 LSBs of "milliseconds since epoch"
200 $id_bin = $this->millisecondsSinceEpochBinary( $time );
201 // Add a 20 bit counter resulting in 66 bits total
202 $id_bin .= str_pad( decbin( $counter ), 20, '0', STR_PAD_LEFT
);
203 // Add a 14 bit clock sequence number resulting in 80 bits total
204 $id_bin .= str_pad( decbin( $clkSeq ), 14, '0', STR_PAD_LEFT
);
205 // Add the 48 bit node ID resulting in 128 bits total
206 $id_bin .= $this->nodeId48
;
207 // Convert to a 1-39 digit integer string
208 if ( strlen( $id_bin ) !== 128 ) {
209 throw new RuntimeException( "Detected overflow for millisecond timestamp." );
216 * Return an RFC4122 compliant v1 UUID
219 * @throws RuntimeException
222 public static function newUUIDv1() {
223 $gen = self
::singleton();
224 // There can be up to 10000 intervals for the same millisecond timestamp.
225 // [0,4999] counter + [0,5000] offset is in [0,9999] for the offset counter.
226 // Add this onto the timestamp to allow making up to 5000 IDs per second.
227 return $gen->getUUIDv1( $gen->getTimeAndDelay( 'lockFileUUID', 16384, 5000, 5001 ) );
231 * Return an RFC4122 compliant v1 UUID
233 * @return string 32 hex characters with no hyphens
234 * @throws RuntimeException
237 public static function newRawUUIDv1() {
238 return str_replace( '-', '', self
::newUUIDv1() );
242 * @param array $info Result of UIDGenerator::getTimeAndDelay()
243 * @return string 128 bits
245 protected function getUUIDv1( array $info ) {
246 $clkSeq_bin = Wikimedia\base_convert
( $info['clkSeq'], 10, 2, 14 );
247 $time_bin = $this->intervalsSinceGregorianBinary( $info['time'], $info['offsetCounter'] );
248 // Take the 32 bits of "time low"
249 $id_bin = substr( $time_bin, 28, 32 );
250 // Add 16 bits of "time mid" resulting in 48 bits total
251 $id_bin .= substr( $time_bin, 12, 16 );
252 // Add 4 bit version resulting in 52 bits total
254 // Add 12 bits of "time high" resulting in 64 bits total
255 $id_bin .= substr( $time_bin, 0, 12 );
256 // Add 2 bits of "variant" resulting in 66 bits total
258 // Add 6 bits of "clock seq high" resulting in 72 bits total
259 $id_bin .= substr( $clkSeq_bin, 0, 6 );
260 // Add 8 bits of "clock seq low" resulting in 80 bits total
261 $id_bin .= substr( $clkSeq_bin, 6, 8 );
262 // Add the 48 bit node ID resulting in 128 bits total
263 $id_bin .= $this->nodeId48
;
264 // Convert to a 32 char hex string with dashes
265 if ( strlen( $id_bin ) !== 128 ) {
266 throw new RuntimeException( "Detected overflow for millisecond timestamp." );
268 $hex = Wikimedia\base_convert
( $id_bin, 2, 16, 32 );
269 return sprintf( '%s-%s-%s-%s-%s',
270 // "time_low" (32 bits)
271 substr( $hex, 0, 8 ),
272 // "time_mid" (16 bits)
273 substr( $hex, 8, 4 ),
274 // "time_hi_and_version" (16 bits)
275 substr( $hex, 12, 4 ),
276 // "clk_seq_hi_res" (8 bits) and "clk_seq_low" (8 bits)
277 substr( $hex, 16, 4 ),
279 substr( $hex, 20, 12 )
284 * Return an RFC4122 compliant v4 UUID
286 * @param int $flags Bitfield (supports UIDGenerator::QUICK_RAND)
288 * @throws RuntimeException
290 public static function newUUIDv4( $flags = 0 ) {
291 $hex = ( $flags & self
::QUICK_RAND
)
292 ?
wfRandomString( 31 )
293 : MWCryptRand
::generateHex( 31 );
295 return sprintf( '%s-%s-%s-%s-%s',
296 // "time_low" (32 bits)
297 substr( $hex, 0, 8 ),
298 // "time_mid" (16 bits)
299 substr( $hex, 8, 4 ),
300 // "time_hi_and_version" (16 bits)
301 '4' . substr( $hex, 12, 3 ),
302 // "clk_seq_hi_res" (8 bits, variant is binary 10x) and "clk_seq_low" (8 bits)
303 dechex( 0x8 |
( hexdec( $hex[15] ) & 0x3 ) ) . $hex[16] . substr( $hex, 17, 2 ),
305 substr( $hex, 19, 12 )
310 * Return an RFC4122 compliant v4 UUID
312 * @param int $flags Bitfield (supports UIDGenerator::QUICK_RAND)
313 * @return string 32 hex characters with no hyphens
314 * @throws RuntimeException
316 public static function newRawUUIDv4( $flags = 0 ) {
317 return str_replace( '-', '', self
::newUUIDv4( $flags ) );
321 * Return an ID that is sequential *only* for this node and bucket
323 * These IDs are suitable for per-host sequence numbers, e.g. for some packet protocols.
324 * If UIDGenerator::QUICK_VOLATILE is used the counter might reset on server restart.
326 * @param string $bucket Arbitrary bucket name (should be ASCII)
327 * @param int $bits Bit size (<=48) of resulting numbers before wrap-around
328 * @param int $flags (supports UIDGenerator::QUICK_VOLATILE)
329 * @return float Integer value as float
332 public static function newSequentialPerNodeID( $bucket, $bits = 48, $flags = 0 ) {
333 return current( self
::newSequentialPerNodeIDs( $bucket, $bits, 1, $flags ) );
337 * Return IDs that are sequential *only* for this node and bucket
339 * @see UIDGenerator::newSequentialPerNodeID()
340 * @param string $bucket Arbitrary bucket name (should be ASCII)
341 * @param int $bits Bit size (16 to 48) of resulting numbers before wrap-around
342 * @param int $count Number of IDs to return
343 * @param int $flags (supports UIDGenerator::QUICK_VOLATILE)
344 * @return array Ordered list of float integer values
347 public static function newSequentialPerNodeIDs( $bucket, $bits, $count, $flags = 0 ) {
348 $gen = self
::singleton();
349 return $gen->getSequentialPerNodeIDs( $bucket, $bits, $count, $flags );
353 * Return IDs that are sequential *only* for this node and bucket
355 * @see UIDGenerator::newSequentialPerNodeID()
356 * @param string $bucket Arbitrary bucket name (should be ASCII)
357 * @param int $bits Bit size (16 to 48) of resulting numbers before wrap-around
358 * @param int $count Number of IDs to return
359 * @param int $flags (supports UIDGenerator::QUICK_VOLATILE)
360 * @return array Ordered list of float integer values
361 * @throws RuntimeException
363 protected function getSequentialPerNodeIDs( $bucket, $bits, $count, $flags ) {
365 return []; // nothing to do
367 if ( $bits < 16 ||
$bits > 48 ) {
368 throw new RuntimeException( "Requested bit size ($bits) is out of range." );
371 $counter = null; // post-increment persistent counter value
373 // Use APC/etc if requested, available, and not in CLI mode;
374 // Counter values would not survive across script instances in CLI mode.
376 if ( ( $flags & self
::QUICK_VOLATILE
) && !wfIsCLI() ) {
377 $cache = MediaWikiServices
::getInstance()->getLocalServerObjectCache();
380 $counter = $cache->incrWithInit( $bucket, $cache::TTL_INDEFINITE
, $count, $count );
381 if ( $counter === false ) {
382 throw new RuntimeException( 'Unable to set value to ' . get_class( $cache ) );
386 // Note: use of fmod() avoids "division by zero" on 32 bit machines
387 if ( $counter === null ) {
388 $path = wfTempDir() . '/mw-' . __CLASS__
. '-' . rawurlencode( $bucket ) . '-48';
389 // Get the UID lock file handle
390 if ( isset( $this->fileHandles
[$path] ) ) {
391 $handle = $this->fileHandles
[$path];
393 $handle = fopen( $path, 'cb+' );
394 $this->fileHandles
[$path] = $handle ?
: null; // cache
396 // Acquire the UID lock file
397 if ( $handle === false ) {
398 throw new RuntimeException( "Could not open '{$path}'." );
400 if ( !flock( $handle, LOCK_EX
) ) {
402 throw new RuntimeException( "Could not acquire '{$path}'." );
404 // Fetch the counter value and increment it...
406 $counter = floor( trim( fgets( $handle ) ) ) +
$count; // fetch as float
407 // Write back the new counter value
408 ftruncate( $handle, 0 );
410 fwrite( $handle, fmod( $counter, 2 ** 48 ) ); // warp-around as needed
412 // Release the UID lock file
413 flock( $handle, LOCK_UN
);
417 $divisor = 2 ** $bits;
418 $currentId = floor( $counter - $count ); // pre-increment counter value
419 for ( $i = 0; $i < $count; ++
$i ) {
420 $ids[] = fmod( ++
$currentId, $divisor );
427 * Get a (time,counter,clock sequence) where (time,counter) is higher
428 * than any previous (time,counter) value for the given clock sequence.
429 * This is useful for making UIDs sequential on a per-node bases.
431 * @param string $lockFile Name of a local lock file
432 * @param int $clockSeqSize The number of possible clock sequence values
433 * @param int $counterSize The number of possible counter values
434 * @param int $offsetSize The number of possible offset values
435 * @return array Array with the following keys:
436 * - array 'time': array of seconds int and milliseconds int.
440 * - int 'offsetCounter'.
441 * @throws RuntimeException
443 protected function getTimeAndDelay( $lockFile, $clockSeqSize, $counterSize, $offsetSize ) {
444 // Get the UID lock file handle
445 if ( isset( $this->fileHandles
[$lockFile] ) ) {
446 $handle = $this->fileHandles
[$lockFile];
448 $handle = fopen( $this->$lockFile, 'cb+' );
449 $this->fileHandles
[$lockFile] = $handle ?
: null; // cache
451 // Acquire the UID lock file
452 if ( $handle === false ) {
453 throw new RuntimeException( "Could not open '{$this->$lockFile}'." );
455 if ( !flock( $handle, LOCK_EX
) ) {
457 throw new RuntimeException( "Could not acquire '{$this->$lockFile}'." );
460 // The formatters that use this method expect a timestamp with millisecond
461 // precision and a counter upto a certain size. When more IDs than the counter
462 // size are generated during the same timestamp, an exception is thrown as we
463 // cannot increment further, because the formatted ID would not have enough
464 // bits to fit the counter.
466 // To orchestrate this between independant PHP processes on the same hosts,
467 // we must have a common sense of time so that we only have to maintain
468 // a single counter in a single lock file.
471 // Format of lock file contents:
472 // "<clk seq> <sec> <msec> <counter> <rand offset>"
473 $data = explode( ' ', fgets( $handle ) );
475 // Did the clock get moved back significantly?
476 $clockChanged = false;
478 if ( count( $data ) === 5 ) {
479 // The UID lock file was already initialized
480 $clkSeq = (int)$data[0] %
$clockSeqSize;
481 $prevTime = [ (int)$data[1], (int)$data[2] ];
482 // Counter for UIDs with the same timestamp,
484 $randOffset = (int)$data[4] %
$counterSize;
486 // If the system clock moved backwards by an NTP sync,
487 // or if the last writer process had its clock drift ahead,
488 // Try to catch up if the gap is small, so that we can keep a single
489 // monotonic logic file.
490 $time = $this->timeWaitUntil( $prevTime );
491 if ( $time === false ) {
492 // Timed out. Treat it as a new clock
493 $clockChanged = true;
494 $time = $this->millitime();
495 } elseif ( $time === $prevTime ) {
496 // Sanity check, only keep remainder if a previous writer wrote
497 // something here that we don't accept.
498 $counter = (int)$data[3] %
$counterSize;
499 // Bump the counter if the time has not changed yet
500 if ( ++
$counter >= $counterSize ) {
501 // More IDs generated with the same time than counterSize can accomodate
502 flock( $handle, LOCK_UN
);
503 throw new RuntimeException( "Counter overflow for timestamp value." );
507 // Initialize UID lock file information
508 $clkSeq = mt_rand( 0, $clockSeqSize - 1 );
509 $time = $this->millitime();
511 $randOffset = mt_rand( 0, $offsetSize - 1 );
513 // microtime() and gettimeofday() can drift from time() at least on Windows.
514 // The drift is immediate for processes running while the system clock changes.
515 // time() does not have this problem. See https://bugs.php.net/bug.php?id=42659.
516 $drift = time() - $time[0];
517 if ( abs( $drift ) >= 2 ) {
518 // We don't want processes using too high or low timestamps to avoid duplicate
519 // UIDs and clock sequence number churn. This process should just be restarted.
520 flock( $handle, LOCK_UN
); // abort
521 throw new RuntimeException( "Process clock is outdated or drifted ({$drift}s)." );
523 // If microtime() is synced and a clock change was detected, then the clock went back
524 if ( $clockChanged ) {
525 // Bump the clock sequence number and also randomize the extra offset,
526 // which is useful for UIDs that do not include the clock sequence number.
527 $clkSeq = ( $clkSeq +
1 ) %
$clockSeqSize;
528 $randOffset = mt_rand( 0, $offsetSize - 1 );
529 trigger_error( "Clock was set back; sequence number incremented." );
532 // Update and release the UID lock file
533 ftruncate( $handle, 0 );
535 fwrite( $handle, "{$clkSeq} {$time[0]} {$time[1]} {$counter} {$randOffset}" );
537 flock( $handle, LOCK_UN
);
541 'counter' => $counter,
543 'offset' => $randOffset,
544 'offsetCounter' => $counter +
$randOffset,
549 * Wait till the current timestamp reaches $time and return the current
550 * timestamp. This returns false if it would have to wait more than 10ms.
552 * @param array $time Result of UIDGenerator::millitime()
553 * @return array|bool UIDGenerator::millitime() result or false
555 protected function timeWaitUntil( array $time ) {
557 $ct = $this->millitime();
558 if ( $ct >= $time ) { // https://secure.php.net/manual/en/language.operators.comparison.php
559 return $ct; // current timestamp is higher than $time
561 } while ( ( ( $time[0] - $ct[0] ) * 1000 +
( $time[1] - $ct[1] ) ) <= 10 );
567 * @param array $time Result of UIDGenerator::millitime()
568 * @return string 46 LSBs of "milliseconds since epoch" in binary (rolls over in 4201)
569 * @throws RuntimeException
571 protected function millisecondsSinceEpochBinary( array $time ) {
572 list( $sec, $msec ) = $time;
573 $ts = 1000 * $sec +
$msec;
574 if ( $ts > 2 ** 52 ) {
575 throw new RuntimeException( __METHOD__
.
576 ': sorry, this function doesn\'t work after the year 144680' );
579 return substr( Wikimedia\base_convert
( $ts, 10, 2, 46 ), -46 );
583 * @param array $time Result of UIDGenerator::millitime()
584 * @param int $delta Number of intervals to add on to the timestamp
585 * @return string 60 bits of "100ns intervals since 15 October 1582" (rolls over in 3400)
586 * @throws RuntimeException
588 protected function intervalsSinceGregorianBinary( array $time, $delta = 0 ) {
589 list( $sec, $msec ) = $time;
590 $offset = '122192928000000000';
591 if ( PHP_INT_SIZE
>= 8 ) { // 64 bit integers
592 $ts = ( 1000 * $sec +
$msec ) * 10000 +
(int)$offset +
$delta;
593 $id_bin = str_pad( decbin( $ts %
( 2 ** 60 ) ), 60, '0', STR_PAD_LEFT
);
594 } elseif ( extension_loaded( 'gmp' ) ) {
595 $ts = gmp_add( gmp_mul( (string)$sec, '1000' ), (string)$msec ); // ms
596 $ts = gmp_add( gmp_mul( $ts, '10000' ), $offset ); // 100ns intervals
597 $ts = gmp_add( $ts, (string)$delta );
598 $ts = gmp_mod( $ts, gmp_pow( '2', '60' ) ); // wrap around
599 $id_bin = str_pad( gmp_strval( $ts, 2 ), 60, '0', STR_PAD_LEFT
);
600 } elseif ( extension_loaded( 'bcmath' ) ) {
601 $ts = bcadd( bcmul( $sec, 1000 ), $msec ); // ms
602 $ts = bcadd( bcmul( $ts, 10000 ), $offset ); // 100ns intervals
603 $ts = bcadd( $ts, $delta );
604 $ts = bcmod( $ts, bcpow( 2, 60 ) ); // wrap around
605 $id_bin = Wikimedia\base_convert
( $ts, 10, 2, 60 );
607 throw new RuntimeException( 'bcmath or gmp extension required for 32 bit machines.' );
613 * @return array (current time in seconds, milliseconds since then)
615 protected function millitime() {
616 list( $msec, $sec ) = explode( ' ', microtime() );
618 return [ (int)$sec, (int)( $msec * 1000 ) ];
622 * Delete all cache files that have been created.
624 * This is a cleanup method primarily meant to be used from unit tests to
625 * avoid poluting the local filesystem. If used outside of a unit test
626 * environment it should be used with caution as it may destroy state saved
629 * @see unitTestTearDown
631 * @codeCoverageIgnore
633 private function deleteCacheFiles() {
635 foreach ( $this->fileHandles
as $path => $handle ) {
636 if ( $handle !== null ) {
639 if ( is_file( $path ) ) {
642 unset( $this->fileHandles
[$path] );
644 if ( is_file( $this->nodeIdFile
) ) {
645 unlink( $this->nodeIdFile
);
650 * Cleanup resources when tearing down after a unit test.
652 * This is a cleanup method primarily meant to be used from unit tests to
653 * avoid poluting the local filesystem. If used outside of a unit test
654 * environment it should be used with caution as it may destroy state saved
657 * @internal For use by unit tests
658 * @see deleteCacheFiles
660 * @codeCoverageIgnore
662 public static function unitTestTearDown() {
664 $gen = self
::singleton();
665 $gen->deleteCacheFiles();
668 function __destruct() {
669 array_map( 'fclose', array_filter( $this->fileHandles
) );