MediaWiki  REL1_31
DatabaseDomain.php
Go to the documentation of this file.
1 <?php
21 namespace Wikimedia\Rdbms;
22 
23 use InvalidArgumentException;
24 
30  private $database;
32  private $schema;
34  private $prefix;
35 
38 
44  public function __construct( $database, $schema, $prefix ) {
45  if ( $database !== null && ( !is_string( $database ) || !strlen( $database ) ) ) {
46  throw new InvalidArgumentException( "Database must be null or a non-empty string." );
47  }
48  $this->database = $database;
49  if ( $schema !== null && ( !is_string( $schema ) || !strlen( $schema ) ) ) {
50  throw new InvalidArgumentException( "Schema must be null or a non-empty string." );
51  }
52  $this->schema = $schema;
53  if ( !is_string( $prefix ) ) {
54  throw new InvalidArgumentException( "Prefix must be a string." );
55  }
56  $this->prefix = $prefix;
57  }
58 
63  public static function newFromId( $domain ) {
64  if ( $domain instanceof self ) {
65  return $domain;
66  }
67 
68  $parts = array_map( [ __CLASS__, 'decode' ], explode( '-', $domain ) );
69 
70  $schema = null;
71  $prefix = '';
72 
73  if ( count( $parts ) == 1 ) {
74  $database = $parts[0];
75  } elseif ( count( $parts ) == 2 ) {
76  list( $database, $prefix ) = $parts;
77  } elseif ( count( $parts ) == 3 ) {
78  list( $database, $schema, $prefix ) = $parts;
79  } else {
80  throw new InvalidArgumentException( "Domain has too few or too many parts." );
81  }
82 
83  if ( $database === '' ) {
84  $database = null;
85  }
86 
87  if ( $schema === '' ) {
88  $schema = null;
89  }
90 
91  return new self( $database, $schema, $prefix );
92  }
93 
97  public static function newUnspecified() {
98  return new self( null, null, '' );
99  }
100 
105  public function equals( $other ) {
106  if ( $other instanceof self ) {
107  return (
108  $this->database === $other->database &&
109  $this->schema === $other->schema &&
110  $this->prefix === $other->prefix
111  );
112  }
113 
114  return ( $this->getId() === $other );
115  }
116 
131  public function isCompatible( $other ) {
132  if ( $this->isUnspecified() ) {
133  return true; // even the prefix doesn't matter
134  }
135 
136  $other = ( $other instanceof self ) ? $other : self::newFromId( $other );
137 
138  return (
139  ( $this->database === $other->database || $this->database === null ) &&
140  ( $this->schema === $other->schema || $this->schema === null ) &&
141  $this->prefix === $other->prefix
142  );
143  }
144 
149  public function isUnspecified() {
150  return (
151  $this->database === null && $this->schema === null && $this->prefix === ''
152  );
153  }
154 
158  public function getDatabase() {
159  return $this->database;
160  }
161 
165  public function getSchema() {
166  return $this->schema;
167  }
168 
172  public function getTablePrefix() {
173  return $this->prefix;
174  }
175 
179  public function getId() {
180  if ( $this->equivalentString === null ) {
181  $this->equivalentString = $this->convertToString();
182  }
183 
185  }
186 
190  private function convertToString() {
191  $parts = [ $this->database ];
192  if ( $this->schema !== null ) {
193  $parts[] = $this->schema;
194  }
195  if ( $this->prefix != '' || $this->schema !== null ) {
196  // If there is a schema, then we need the prefix to disambiguate.
197  // For engines like Postgres that use schemas, this awkwardness is hopefully
198  // avoided since it is easy to have one DB per server (to avoid having many users)
199  // and use schema/prefix to have wiki farms. For example, a domain schemes could be
200  // wiki-<project>-<language>, e.g. "wiki-fitness-es"/"wiki-sports-fr"/"wiki-news-en".
201  $parts[] = $this->prefix;
202  }
203 
204  return implode( '-', array_map( [ __CLASS__, 'encode' ], $parts ) );
205  }
206 
207  private static function encode( $decoded ) {
208  $encoded = '';
209 
210  $length = strlen( $decoded );
211  for ( $i = 0; $i < $length; ++$i ) {
212  $char = $decoded[$i];
213  if ( $char === '-' ) {
214  $encoded .= '?h';
215  } elseif ( $char === '?' ) {
216  $encoded .= '??';
217  } else {
218  $encoded .= $char;
219  }
220  }
221 
222  return $encoded;
223  }
224 
225  private static function decode( $encoded ) {
226  $decoded = '';
227 
228  $length = strlen( $encoded );
229  for ( $i = 0; $i < $length; ++$i ) {
230  $char = $encoded[$i];
231  if ( $char === '?' ) {
232  $nextChar = isset( $encoded[$i + 1] ) ? $encoded[$i + 1] : null;
233  if ( $nextChar === 'h' ) {
234  $decoded .= '-';
235  ++$i;
236  } elseif ( $nextChar === '?' ) {
237  $decoded .= '?';
238  ++$i;
239  } else {
240  $decoded .= $char;
241  }
242  } else {
243  $decoded .= $char;
244  }
245  }
246 
247  return $decoded;
248  }
249 
253  function __toString() {
254  return $this->getId();
255  }
256 }
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Wikimedia\Rdbms\DatabaseDomain\getId
getId()
Definition: DatabaseDomain.php:179
Wikimedia\Rdbms\DatabaseDomain\newFromId
static newFromId( $domain)
Definition: DatabaseDomain.php:63
Wikimedia\Rdbms\DatabaseDomain\__construct
__construct( $database, $schema, $prefix)
Definition: DatabaseDomain.php:44
Wikimedia\Rdbms\DatabaseDomain\getTablePrefix
getTablePrefix()
Definition: DatabaseDomain.php:172
Wikimedia\Rdbms\DatabaseDomain\$equivalentString
string $equivalentString
Cache of convertToString()
Definition: DatabaseDomain.php:37
Wikimedia\Rdbms
Definition: ChronologyProtector.php:24
Wikimedia\Rdbms\DatabaseDomain\$prefix
string $prefix
Definition: DatabaseDomain.php:34
database
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the database
Definition: design.txt:13
Wikimedia\Rdbms\DatabaseDomain\getDatabase
getDatabase()
Definition: DatabaseDomain.php:158
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Wikimedia\Rdbms\DatabaseDomain\newUnspecified
static newUnspecified()
Definition: DatabaseDomain.php:97
Wikimedia\Rdbms\DatabaseDomain\encode
static encode( $decoded)
Definition: DatabaseDomain.php:207
Wikimedia\Rdbms\DatabaseDomain\__toString
__toString()
Definition: DatabaseDomain.php:253
Wikimedia\Rdbms\DatabaseDomain\isUnspecified
isUnspecified()
Definition: DatabaseDomain.php:149
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
Wikimedia\Rdbms\DatabaseDomain\$database
string null $database
Definition: DatabaseDomain.php:30
Wikimedia\Rdbms\DatabaseDomain\getSchema
getSchema()
Definition: DatabaseDomain.php:165
Wikimedia\Rdbms\DatabaseDomain\$schema
string null $schema
Definition: DatabaseDomain.php:32
Wikimedia\Rdbms\DatabaseDomain\decode
static decode( $encoded)
Definition: DatabaseDomain.php:225
Wikimedia\Rdbms\DatabaseDomain\convertToString
convertToString()
Definition: DatabaseDomain.php:190
Wikimedia\Rdbms\DatabaseDomain
Class to handle database/prefix specification for IDatabase domains.
Definition: DatabaseDomain.php:28
Wikimedia\Rdbms\DatabaseDomain\isCompatible
isCompatible( $other)
Check whether the domain $other meets the specifications of this domain.
Definition: DatabaseDomain.php:131
Wikimedia\Rdbms\DatabaseDomain\equals
equals( $other)
Definition: DatabaseDomain.php:105