MediaWiki  master
MediaWiki\Storage\SqlBlobStore Class Reference

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

Inheritance diagram for MediaWiki\Storage\SqlBlobStore:
Collaboration diagram for MediaWiki\Storage\SqlBlobStore:

Public Member Functions

 __construct (ILoadBalancer $dbLoadBalancer, ExternalStoreAccess $extStoreAccess, WANObjectCache $cache, $dbDomain=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...
 
 getBlobBatch ( $blobAddresses, $queryFlags=0)
 A batched version of BlobStore::getBlob. 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)
 Set the legacy encoding to assume for blobs that do not have the utf-8 flag set. More...
 
 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_NONE = -1
 Constants for object loading bitfield flags (higher => higher QoS) More...
 
- 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 IMAGE_HINT = 'img_name'
 Hint key for an image name. 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

 fetchBlobs ( $blobAddresses, $queryFlags)
 MCR migration note: this corresponded 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
 
string bool $dbDomain
 DB domain ID of a wiki or false for the local one. More...
 
ILoadBalancer $dbLoadBalancer
 
ExternalStoreAccess $extStoreAccess
 
bool string $legacyEncoding = false
 
bool $useExternalStore = false
 

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 the old Revision class (which was later removed in 1.37).

Definition at line 52 of file SqlBlobStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Storage\SqlBlobStore::__construct ( ILoadBalancer  $dbLoadBalancer,
ExternalStoreAccess  $extStoreAccess,
WANObjectCache  $cache,
  $dbDomain = false 
)
Parameters
ILoadBalancer$dbLoadBalancerA load balancer for acquiring database connections
ExternalStoreAccess$extStoreAccessAccess layer for external storage
WANObjectCache$cacheA cache manager for caching blobs. This can be the local wiki's default instance even if $dbDomain refers to a different wiki, since makeGlobalKey() is used to construct a key that allows cached blobs from the same database to be re-used between wikis. For example, wiki A and wiki B will use the same cache keys for blobs fetched from wiki C, regardless of the wiki-specific default key space.
bool | string$dbDomainThe ID of the target wiki database. Use false for the local wiki.

Definition at line 108 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$cache, MediaWiki\Storage\SqlBlobStore\$dbDomain, MediaWiki\Storage\SqlBlobStore\$dbLoadBalancer, and MediaWiki\Storage\SqlBlobStore\$extStoreAccess.

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 replaced Revision::compressRevisionText

Note
direct use is deprecated!
Todo:
make this private, there should be no need to use this method outside this class.
Parameters
string&$blob
Returns
string

Definition at line 541 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 replaced 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$blobBlob in compressed/encoded form.
array$blobFlagsCompression 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 581 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 replaced 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$rawThe 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[]$flagsBlob 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$cacheKeyA 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 489 of file SqlBlobStore.php.

References $blob, MediaWiki\Storage\SqlBlobStore\decompressData(), MediaWiki\Storage\SqlBlobStore\getCacheKey(), MediaWiki\Storage\SqlBlobStore\getCacheTTL(), and MediaWiki\Storage\SqlBlobStore\TEXT_CACHE_GROUP.

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

◆ fetchBlobs()

MediaWiki\Storage\SqlBlobStore::fetchBlobs (   $blobAddresses,
  $queryFlags 
)
private

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

Parameters
string[]$blobAddresses
int$queryFlags
Exceptions
BlobAccessException
Returns
array [ $result, $errors ] A map of blob addresses to successfully fetched blobs or false if fetch failed, plus and array of errors

Definition at line 344 of file SqlBlobStore.php.

References $blob, MediaWiki\Storage\SqlBlobStore\expandBlob(), MediaWiki\Storage\SqlBlobStore\getDBConnection(), DBAccessObjectUtils\getDBOptions(), DBAccessObjectUtils\hasFlags(), MediaWiki\Storage\SqlBlobStore\splitBlobAddress(), and wfDebug().

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

◆ 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 replaced Revision::loadText

Parameters
string$blobAddress
int$queryFlags
Exceptions
BlobAccessException
Returns
string

Implements MediaWiki\Storage\BlobStore.

Definition at line 278 of file SqlBlobStore.php.

References $blob, MediaWiki\Storage\SqlBlobStore\fetchBlobs(), MediaWiki\Storage\SqlBlobStore\getCacheKey(), MediaWiki\Storage\SqlBlobStore\getCacheTTL(), and MediaWiki\Storage\SqlBlobStore\TEXT_CACHE_GROUP.

◆ getBlobBatch()

MediaWiki\Storage\SqlBlobStore::getBlobBatch (   $blobAddresses,
  $queryFlags = 0 
)

A batched version of BlobStore::getBlob.

Parameters
string[]$blobAddressesAn array of blob addresses.
int$queryFlagsSee IDBAccessObject.
Exceptions
BlobAccessException
Returns
StatusValue A status with a map of blobAddress => binary blob data or null if fetching the blob has failed. Fetch failures errors are the warnings in the status object.
Since
1.34

Implements MediaWiki\Storage\BlobStore.

Definition at line 314 of file SqlBlobStore.php.

References $blob, MediaWiki\Storage\SqlBlobStore\fetchBlobs(), and StatusValue\newGood().

◆ getCacheExpiry()

MediaWiki\Storage\SqlBlobStore::getCacheExpiry ( )
Returns
int time for which blobs can be cached, in seconds

Definition at line 123 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, wiki A and wiki B will use the same cache keys for blobs fetched from wiki C.

Parameters
string$blobAddress
Returns
string

Definition at line 462 of file SqlBlobStore.php.

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 replaced Revision::getCacheTTL

Returns
int

Definition at line 639 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$cache, and WANObjectCache\getQoS().

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 139 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$compressBlobs.

◆ getDBConnection()

MediaWiki\Storage\SqlBlobStore::getDBConnection (   $index)
private
Parameters
int$indexA database index, like DB_PRIMARY or DB_REPLICA
Returns
IDatabase

Definition at line 209 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\getDBLoadBalancer().

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

◆ getDBLoadBalancer()

MediaWiki\Storage\SqlBlobStore::getDBLoadBalancer ( )
private

◆ 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 154 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$legacyEncoding.

◆ getLegacyEncodingConversionLang()

MediaWiki\Storage\SqlBlobStore::getLegacyEncodingConversionLang ( )
Deprecated:
since 1.34 No longer needed
Returns
null

Definition at line 162 of file SqlBlobStore.php.

References wfDeprecated().

◆ 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 672 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\splitBlobAddress().

◆ getUseExternalStore()

MediaWiki\Storage\SqlBlobStore::getUseExternalStore ( )
Returns
bool Whether to use the ExternalStore mechanism for storing blobs.

Definition at line 184 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 727 of file SqlBlobStore.php.

References 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.

Access: internal
Note
This method should not be used by regular application logic. It is public so maintenance scripts can use it for bulk operations on the text table.
Parameters
int$id
Returns
string

Definition at line 701 of file SqlBlobStore.php.

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

◆ setCacheExpiry()

MediaWiki\Storage\SqlBlobStore::setCacheExpiry (   $cacheExpiry)
Parameters
int$cacheExpirytime for which blobs can be cached, in seconds

Definition at line 130 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$cacheExpiry.

◆ setCompressBlobs()

MediaWiki\Storage\SqlBlobStore::setCompressBlobs (   $compressBlobs)
Parameters
bool$compressBlobswhether blobs should be compressed for storage

Definition at line 146 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$compressBlobs.

◆ setLegacyEncoding()

MediaWiki\Storage\SqlBlobStore::setLegacyEncoding (   $legacyEncoding)

Set the legacy encoding to assume for blobs that do not have the utf-8 flag set.

Note
The second parameter, Language $language, was removed in 1.34.
Parameters
string$legacyEncodingThe legacy encoding to assume for blobs that are not marked as utf8.

Definition at line 175 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\$legacyEncoding.

◆ setUseExternalStore()

MediaWiki\Storage\SqlBlobStore::setUseExternalStore (   $useExternalStore)
Parameters
bool$useExternalStoreWhether to use the ExternalStore mechanism for storing blobs.

Definition at line 191 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 715 of file SqlBlobStore.php.

References wfCgiToArray().

Referenced by MediaWiki\Storage\SqlBlobStore\fetchBlobs(), 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$hintsAn 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 224 of file SqlBlobStore.php.

References MediaWiki\Storage\SqlBlobStore\compressData(), DB_PRIMARY, MediaWiki\Storage\SqlBlobStore\getDBConnection(), and MediaWiki\Storage\SqlBlobStore\makeAddressFromTextId().

Member Data Documentation

◆ $cache

WANObjectCache MediaWiki\Storage\SqlBlobStore::$cache
private

◆ $cacheExpiry

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

◆ $compressBlobs

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

◆ $dbDomain

string bool MediaWiki\Storage\SqlBlobStore::$dbDomain
private

DB domain ID of a wiki or false for the local one.

Definition at line 75 of file SqlBlobStore.php.

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

◆ $dbLoadBalancer

ILoadBalancer MediaWiki\Storage\SqlBlobStore::$dbLoadBalancer
private

◆ $extStoreAccess

ExternalStoreAccess MediaWiki\Storage\SqlBlobStore::$extStoreAccess
private

Definition at line 65 of file SqlBlobStore.php.

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

◆ $legacyEncoding

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

◆ $useExternalStore

bool MediaWiki\Storage\SqlBlobStore::$useExternalStore = false
private

◆ TEXT_CACHE_GROUP

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

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