Service for storing and loading Content objects. More...

Inheritance diagram for MediaWiki\Storage\SqlBlobStore:

Collaboration diagram for MediaWiki\Storage\SqlBlobStore:

[legend]

Public Member Functions
	__construct (LoadBalancer $dbLoadBalancer, WANObjectCache $cache, $wikiId=false)

	compressData (&$blob)
	If $wgCompressRevisions is enabled, we will compress data. More...

	decompressData ( $blob, array $blobFlags)
	Re-converts revision text according to its flags. More...

	expandBlob ( $raw, $flags, $cacheKey=null)
	Expand a raw data blob according to the flags given. More...

	getBlob ( $blobAddress, $queryFlags=0)
	Retrieve a blob, given an address. More...

	getCacheExpiry ()

	getCompressBlobs ()

	getLegacyEncoding ()

	getLegacyEncodingConversionLang ()

	getTextIdFromAddress ( $address)
	Returns an ID corresponding to the old_id field in the text table, corresponding to the given $address. More...

	getUseExternalStore ()

	isReadOnly ()
	Check if the blob metadata or backing blob data store is read-only. More...

	setCacheExpiry ( $cacheExpiry)

	setCompressBlobs ( $compressBlobs)

	setLegacyEncoding ( $legacyEncoding, Language $language)

	setUseExternalStore ( $useExternalStore)

	storeBlob ( $data, $hints=[])
	Stores an arbitrary blob of data and returns an address that can be used with getBlob() to retrieve the same blob of data,. More...

Static Public Member Functions
static	makeAddressFromTextId ( $id)
	Returns an address referring to content stored in the text table row with the given ID. More...

static	splitBlobAddress ( $address)
	Splits a blob address into three parts: the schema, the ID, and parameters/flags. More...

Public Attributes
const	TEXT_CACHE_GROUP = 'revisiontext:10'

Public Attributes inherited from IDBAccessObject
const	READ_LOCKING = self::READ_LATEST \| 2
	Constants for object loading bitfield flags (higher => higher QoS) More...

const	READ_NONE = -1

Public Attributes inherited from MediaWiki\Storage\BlobStore
const	DESIGNATION_HINT = 'designation'
	Hint key for use with storeBlob, indicating the general role the block takes in the application. More...

const	FORMAT_HINT = 'cont_format'
	Hint key for use with storeBlob, indicating the serialization format used to create the blob, as a MIME type. More...

const	MODEL_HINT = 'cont_model'
	Hint key for use with storeBlob, indicating the model of the content encoded in the given blob. More...

const	PAGE_HINT = 'page_id'
	Hint key for use with storeBlob, indicating the page the blob is associated with. More...

const	PARENT_HINT = 'rev_parent_id'
	Hint key for use with storeBlob, indicating the parent revision of the revision the blob is associated with. More...

const	REVISION_HINT = 'rev_id'
	Hint key for use with storeBlob, indicating the revision the blob is associated with. More...

const	ROLE_HINT = 'role_name'
	Hint key for use with storeBlob, indicating the slot the blob is associated with. More...

const	SHA1_HINT = 'cont_sha1'
	Hint key for use with storeBlob, providing the SHA1 hash of the blob as passed to the method. More...

Private Member Functions
	fetchBlob ( $blobAddress, $queryFlags)
	MCR migration note: this corresponds to Revision::fetchText. More...

	getCacheKey ( $blobAddress)
	Get a cache key for a given Blob address. More...

	getCacheTTL ()
	Get the text cache TTL. More...

	getDBConnection ( $index)

	getDBLoadBalancer ()

Private Attributes
WANObjectCache	$cache

int	$cacheExpiry = 604800

bool	$compressBlobs = false

LoadBalancer	$dbLoadBalancer

bool string	$legacyEncoding = false

Language null	$legacyEncodingConversionLang = null

boolean	$useExternalStore = false

bool string	$wikiId
	Wiki ID. More...

Detailed Description

Service for storing and loading Content objects.

Since: 1.31

Note: This was written to act as a drop-in replacement for the corresponding static methods in Revision.

Definition at line 49 of file SqlBlobStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\SqlBlobStore::__construct	(	LoadBalancer	$dbLoadBalancer,
		WANObjectCache	$cache,
			$wikiId = `false`
	)

Parameters

LoadBalancer	$dbLoadBalancer	A load balancer for acquiring database connections
WANObjectCache	$cache	A cache manager for caching blobs. This can be the local wiki's default instance even if $wikiId refers to a different wiki, since makeGlobalKey() is used to constructed a key that allows cached blobs from the same database to be re-used between wikis. For example, enwiki and frwiki will use the same cache keys for blobs from the wikidatawiki database, regardless of the cache's default key space.
bool \| string	$wikiId	The ID of the target wiki database. Use false for the local wiki.

Definition at line 104 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$cache, MediaWiki\Storage\SqlBlobStore\$dbLoadBalancer, MediaWiki\Storage\SqlBlobStore\$wikiId, and cache.

Member Function Documentation

◆ compressData()

MediaWiki\Storage\SqlBlobStore::compressData ( & $blob )

If $wgCompressRevisions is enabled, we will compress data.

The input string is modified in place. Return value is the flags field: contains 'gzip' if the data is compressed, and 'utf-8' if we're saving in UTF-8 mode.

MCR migration note: this replaces Revision::compressRevisionText

Note: direct use is deprecated!

Todo:: make this private, there should be no need to use this method outside this class.

Parameters

mixed &$blob Reference to a text

Returns: string

Definition at line 449 of file SqlBlobStore.php.

References $blob, wfDebug(), and wfLogWarning().

Referenced by MediaWiki\Storage\SqlBlobStore\storeBlob().

◆ decompressData()

MediaWiki\Storage\SqlBlobStore::decompressData	(		$blob,
		array	$blobFlags
	)

Re-converts revision text according to its flags.

MCR migration note: this replaces Revision::decompressRevisionText

Note: direct use is deprecated, use getBlob() or SlotRecord::getContent() instead.

Todo:: make this private, there should be no need to use this method outside this class.

Parameters

string	$blob	Blob in compressed/encoded form.
array	$blobFlags	Compression flags, such as 'gzip'. Note that not including 'utf-8' in $blobFlags will cause the data to be decoded according to the legacy encoding specified via setLegacyEncoding.

Returns: string|bool Decompressed text, or false on failure

Definition at line 489 of file SqlBlobStore.php.

References $blob, unserialize(), and wfWarn().

Referenced by MediaWiki\Storage\SqlBlobStore\expandBlob().

◆ expandBlob()

MediaWiki\Storage\SqlBlobStore::expandBlob	(	$raw,
		$flags,
		$cacheKey = `null`
	)

Expand a raw data blob according to the flags given.

MCR migration note: this replaces Revision::getRevisionText

Note: direct use is deprecated, use getBlob() or SlotRecord::getContent() instead.

Todo:: make this private, there should be no need to use this method outside this class.

Parameters

string	$raw	The raw blob data, to be processed according to $flags. May be the blob itself, or the blob compressed, or just the address of the actual blob, depending on $flags.
string \| string[]	$flags	Blob flags, such as 'external' or 'gzip'. Note that not including 'utf-8' in $flags will cause the data to be decoded according to the legacy encoding specified via setLegacyEncoding.
string \| null	$cacheKey	A blob address for use in the cache key. If not given, caching is disabled.

Returns: false|string The expanded blob or false on failure

Definition at line 398 of file SqlBlobStore.php.

References $blob, cache, captcha-old\count, MediaWiki\Storage\SqlBlobStore\decompressData(), false, ExternalStore\fetchFromURL(), MediaWiki\Storage\SqlBlobStore\getCacheKey(), MediaWiki\Storage\SqlBlobStore\getCacheTTL(), MediaWiki\Storage\SqlBlobStore\TEXT_CACHE_GROUP, IExpiringStore\TTL_PROC_LONG, and use.

Referenced by MediaWiki\Storage\SqlBlobStore\fetchBlob().

◆ fetchBlob()

MediaWiki\Storage\SqlBlobStore::fetchBlob	(	$blobAddress,
		$queryFlags
	)

private

MCR migration note: this corresponds to Revision::fetchText.

Parameters

string	$blobAddress
int	$queryFlags

Exceptions

BlobAccessException

Returns: string|false

Definition at line 299 of file SqlBlobStore.php.

References $blob, $options, MediaWiki\Storage\SqlBlobStore\expandBlob(), MediaWiki\Storage\SqlBlobStore\getDBConnection(), DBAccessObjectUtils\getDBOptions(), DBAccessObjectUtils\hasFlags(), list, MediaWiki\Storage\SqlBlobStore\splitBlobAddress(), wfLogWarning(), and wfWarn().

Referenced by MediaWiki\Storage\SqlBlobStore\getBlob().

◆ getBlob()

MediaWiki\Storage\SqlBlobStore::getBlob	(	$blobAddress,
		$queryFlags = `0`
	)

Retrieve a blob, given an address.

Currently hardcoded to the 'text' table storage engine.

MCR migration note: this replaces Revision::loadText

Parameters

string	$blobAddress
int	$queryFlags

Exceptions

BlobAccessException

Returns: string

Implements MediaWiki\Storage\BlobStore.

Definition at line 269 of file SqlBlobStore.php.

References $blob, cache, MediaWiki\Storage\SqlBlobStore\fetchBlob(), MediaWiki\Storage\SqlBlobStore\getCacheKey(), MediaWiki\Storage\SqlBlobStore\getCacheTTL(), MediaWiki\Storage\SqlBlobStore\TEXT_CACHE_GROUP, IExpiringStore\TTL_PROC_LONG, and use.

◆ getCacheExpiry()

MediaWiki\Storage\SqlBlobStore::getCacheExpiry ( )

Returns: int time for which blobs can be cached, in seconds

Definition at line 117 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$cacheExpiry.

◆ getCacheKey()

MediaWiki\Storage\SqlBlobStore::getCacheKey ( $blobAddress )

private

Get a cache key for a given Blob address.

The cache key is constructed in a way that allows cached blobs from the same database to be re-used between wikis. For example, enwiki and frwiki will use the same cache keys for blobs from the wikidatawiki database.

Parameters

string $blobAddress

Returns: string

Definition at line 370 of file SqlBlobStore.php.

References cache.

Referenced by MediaWiki\Storage\SqlBlobStore\expandBlob(), and MediaWiki\Storage\SqlBlobStore\getBlob().

◆ getCacheTTL()

MediaWiki\Storage\SqlBlobStore::getCacheTTL ( )

private

Get the text cache TTL.

MCR migration note: this replaces Revision::getCacheTTL

Returns: int

Definition at line 541 of file SqlBlobStore.php.

References IExpiringStore\ATTR_EMULATION, cache, IExpiringStore\QOS_EMULATION_SQL, and WANObjectCache\TTL_UNCACHEABLE.

Referenced by MediaWiki\Storage\SqlBlobStore\expandBlob(), and MediaWiki\Storage\SqlBlobStore\getBlob().

◆ getCompressBlobs()

MediaWiki\Storage\SqlBlobStore::getCompressBlobs ( )

Returns: bool whether blobs should be compressed for storage

Definition at line 133 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$compressBlobs.

◆ getDBConnection()

MediaWiki\Storage\SqlBlobStore::getDBConnection ( $index )

private

Parameters

int $index A database index, like DB_MASTER or DB_REPLICA

Returns: IDatabase

Definition at line 200 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\getDBLoadBalancer().

Referenced by MediaWiki\Storage\SqlBlobStore\fetchBlob(), and MediaWiki\Storage\SqlBlobStore\storeBlob().

◆ getDBLoadBalancer()

MediaWiki\Storage\SqlBlobStore::getDBLoadBalancer ( )

private

Returns: LoadBalancer

Definition at line 191 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$dbLoadBalancer.

Referenced by MediaWiki\Storage\SqlBlobStore\getDBConnection(), and MediaWiki\Storage\SqlBlobStore\isReadOnly().

◆ getLegacyEncoding()

MediaWiki\Storage\SqlBlobStore::getLegacyEncoding ( )

Returns: false|string The legacy encoding to assume for blobs that are not marked as utf8. False means handling of legacy encoding is disabled, and utf8 assumed.

Definition at line 148 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$legacyEncoding.

◆ getLegacyEncodingConversionLang()

MediaWiki\Storage\SqlBlobStore::getLegacyEncodingConversionLang ( )

Returns: Language|null The locale to use when decoding from a legacy encoding, or null if handling of legacy encoding is disabled.

Definition at line 156 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$legacyEncodingConversionLang.

◆ getTextIdFromAddress()

MediaWiki\Storage\SqlBlobStore::getTextIdFromAddress ( $address )

Returns an ID corresponding to the old_id field in the text table, corresponding to the given $address.

Currently, $address must start with 'tt:' followed by a decimal integer representing the old_id; if $address does not start with 'tt:', null is returned. However, the implementation may change to insert rows into the text table on the fly. This implies that this method cannot be static.

Note: This method exists for use with the text table based storage schema. It should not be assumed that is will function with all future kinds of content addresses.

Deprecated:: since 1.31, so don't assume that all blob addresses refer to a row in the text table. This method should become private once the relevant refactoring in WikiPage is complete.

Parameters

string $address

Returns: int|null

Definition at line 574 of file SqlBlobStore.php.

References list, and MediaWiki\Storage\SqlBlobStore\splitBlobAddress().

◆ getUseExternalStore()

MediaWiki\Storage\SqlBlobStore::getUseExternalStore ( )

Returns: bool Whether to use the ExternalStore mechanism for storing blobs.

Definition at line 175 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$useExternalStore.

◆ isReadOnly()

MediaWiki\Storage\SqlBlobStore::isReadOnly ( )

Check if the blob metadata or backing blob data store is read-only.

Returns: bool

Implements MediaWiki\Storage\BlobStore.

Definition at line 628 of file SqlBlobStore.php.

References ExternalStore\defaultStoresAreReadOnly(), and MediaWiki\Storage\SqlBlobStore\getDBLoadBalancer().

◆ makeAddressFromTextId()

static MediaWiki\Storage\SqlBlobStore::makeAddressFromTextId ( $id )

static

Returns an address referring to content stored in the text table row with the given ID.

The address schema for blobs stored in the text table is "tt:" followed by an integer that corresponds to a value of the old_id field.

Deprecated:: since 1.31. This method should become private once the relevant refactoring in WikiPage is complete.

Parameters

int $id

Returns: string

Definition at line 602 of file SqlBlobStore.php.

Referenced by Revision\RevisionStore\emulateMainSlot_1_29(), MediaWiki\Storage\SqlBlobStore\storeBlob(), MediaWiki\Tests\Storage\SqlBlobStoreTest\testMakeAddressFromTextId(), and Revision\RevisionStore\updateRevisionTextId().

◆ setCacheExpiry()

MediaWiki\Storage\SqlBlobStore::setCacheExpiry ( $cacheExpiry )

Parameters

int $cacheExpiry time for which blobs can be cached, in seconds

Definition at line 124 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$cacheExpiry.

◆ setCompressBlobs()

MediaWiki\Storage\SqlBlobStore::setCompressBlobs ( $compressBlobs )

Parameters

bool $compressBlobs whether blobs should be compressed for storage

Definition at line 140 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$compressBlobs.

Referenced by MediaWiki\Tests\Storage\SqlBlobStoreTest\getBlobStore().

◆ setLegacyEncoding()

MediaWiki\Storage\SqlBlobStore::setLegacyEncoding	(		$legacyEncoding,
		Language	$language
	)

Parameters

string	$legacyEncoding	The legacy encoding to assume for blobs that are not marked as utf8.
Language	$language	The locale to use when decoding from a legacy encoding.

Definition at line 165 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$legacyEncoding.

◆ setUseExternalStore()

MediaWiki\Storage\SqlBlobStore::setUseExternalStore ( $useExternalStore )

Parameters

bool $useExternalStore Whether to use the ExternalStore mechanism for storing blobs.

Definition at line 182 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$useExternalStore.

◆ splitBlobAddress()

static MediaWiki\Storage\SqlBlobStore::splitBlobAddress ( $address )

static

Splits a blob address into three parts: the schema, the ID, and parameters/flags.

Since: 1.33

Parameters

string $address

Exceptions

InvalidArgumentException

Returns: array [ $schema, $id, $parameters ], with $parameters being an assoc array.

Definition at line 616 of file SqlBlobStore.php.

References wfCgiToArray().

Referenced by MediaWiki\Storage\SqlBlobStore\fetchBlob(), and MediaWiki\Storage\SqlBlobStore\getTextIdFromAddress().

◆ storeBlob()

MediaWiki\Storage\SqlBlobStore::storeBlob	(	$data,
		$hints = `[]`
	)

Stores an arbitrary blob of data and returns an address that can be used with getBlob() to retrieve the same blob of data,.

Parameters

string	$data
array	$hints	An array of hints.

Exceptions

BlobAccessException

Returns: string an address that can be used with getBlob() to retrieve the data.

Implements MediaWiki\Storage\BlobStore.

Definition at line 215 of file SqlBlobStore.php.

References $data, $e, MediaWiki\Storage\SqlBlobStore\compressData(), DB_MASTER, MediaWiki\Storage\SqlBlobStore\getDBConnection(), ExternalStore\insertToDefault(), and MediaWiki\Storage\SqlBlobStore\makeAddressFromTextId().

Member Data Documentation

◆ $cache

WANObjectCache MediaWiki\Storage\SqlBlobStore::$cache

private

Definition at line 62 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\__construct().

◆ $cacheExpiry

int MediaWiki\Storage\SqlBlobStore::$cacheExpiry = 604800

private

Definition at line 72 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\getCacheExpiry(), and MediaWiki\Storage\SqlBlobStore\setCacheExpiry().

◆ $compressBlobs

bool MediaWiki\Storage\SqlBlobStore::$compressBlobs = false

private

Definition at line 77 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\getCompressBlobs(), and MediaWiki\Storage\SqlBlobStore\setCompressBlobs().

◆ $dbLoadBalancer

LoadBalancer MediaWiki\Storage\SqlBlobStore::$dbLoadBalancer

private

Definition at line 57 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\__construct(), and MediaWiki\Storage\SqlBlobStore\getDBLoadBalancer().

◆ $legacyEncoding

bool string MediaWiki\Storage\SqlBlobStore::$legacyEncoding = false

private

Definition at line 82 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\getLegacyEncoding(), and MediaWiki\Storage\SqlBlobStore\setLegacyEncoding().

◆ $legacyEncodingConversionLang

Language null MediaWiki\Storage\SqlBlobStore::$legacyEncodingConversionLang = null

private

Definition at line 87 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\getLegacyEncodingConversionLang().

◆ $useExternalStore

boolean MediaWiki\Storage\SqlBlobStore::$useExternalStore = false

private

Definition at line 92 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\getUseExternalStore(), and MediaWiki\Storage\SqlBlobStore\setUseExternalStore().

◆ $wikiId

bool string MediaWiki\Storage\SqlBlobStore::$wikiId

private

Wiki ID.

Definition at line 67 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\__construct().

◆ TEXT_CACHE_GROUP

const MediaWiki\Storage\SqlBlobStore::TEXT_CACHE_GROUP = 'revisiontext:10'

Definition at line 52 of file SqlBlobStore.php.

Referenced by MediaWiki\Storage\SqlBlobStore\expandBlob(), and MediaWiki\Storage\SqlBlobStore\getBlob().

The documentation for this class was generated from the following file:

includes/Storage/SqlBlobStore.php

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ compressData()

◆ decompressData()

◆ expandBlob()

◆ fetchBlob()

◆ getBlob()

◆ getCacheExpiry()

◆ getCacheKey()

◆ getCacheTTL()

◆ getCompressBlobs()

◆ getDBConnection()

◆ getDBLoadBalancer()

◆ getLegacyEncoding()

◆ getLegacyEncodingConversionLang()

◆ getTextIdFromAddress()

◆ getUseExternalStore()

◆ isReadOnly()

◆ makeAddressFromTextId()

◆ setCacheExpiry()

◆ setCompressBlobs()

◆ setLegacyEncoding()

◆ setUseExternalStore()

◆ splitBlobAddress()

◆ storeBlob()

Member Data Documentation

◆ $cache

◆ $cacheExpiry

◆ $compressBlobs

◆ $dbLoadBalancer

◆ $legacyEncoding

◆ $legacyEncodingConversionLang

◆ $useExternalStore

◆ $wikiId

◆ TEXT_CACHE_GROUP