f5e3f22ee6b32ad136164c6c13da08dbcedcdc0e
4 * Represents a single site.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
26 * @license GNU GPL v2+
27 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
29 class Site
implements Serializable
{
30 const TYPE_UNKNOWN
= 'unknown';
31 const TYPE_MEDIAWIKI
= 'mediawiki';
33 const GROUP_NONE
= 'none';
35 const ID_INTERWIKI
= 'interwiki';
36 const ID_EQUIVALENT
= 'equivalent';
38 const SOURCE_LOCAL
= 'local';
40 const PATH_LINK
= 'link';
43 * A version ID that identifies the serialization structure used by getSerializationData()
44 * and unserialize(). This is useful for constructing cache keys in cases where the cache relies
45 * on serialization for storing the SiteList.
47 * @var string A string uniquely identifying the version of the serialization structure.
49 const SERIAL_VERSION_ID
= '2013-01-23';
56 protected $globalId = null;
63 protected $type = self
::TYPE_UNKNOWN
;
70 protected $group = self
::GROUP_NONE
;
77 protected $source = self
::SOURCE_LOCAL
;
84 protected $languageCode = null;
87 * Holds the local ids for this site.
88 * local id type => [ ids for this type (strings) ]
94 protected $localIds = [];
101 protected $extraData = [];
108 protected $extraConfig = [];
115 protected $forward = false;
122 protected $internalId = null;
127 * @param string $type
129 public function __construct( $type = self
::TYPE_UNKNOWN
) {
134 * Returns the global site identifier (ie enwiktionary).
138 * @return string|null
140 public function getGlobalId() {
141 return $this->globalId
;
145 * Sets the global site identifier (ie enwiktionary).
149 * @param string|null $globalId
151 * @throws MWException
153 public function setGlobalId( $globalId ) {
154 if ( $globalId !== null && !is_string( $globalId ) ) {
155 throw new MWException( '$globalId needs to be string or null' );
158 $this->globalId
= $globalId;
162 * Returns the type of the site (ie mediawiki).
168 public function getType() {
173 * Gets the group of the site (ie wikipedia).
179 public function getGroup() {
184 * Sets the group of the site (ie wikipedia).
188 * @param string $group
190 * @throws MWException
192 public function setGroup( $group ) {
193 if ( !is_string( $group ) ) {
194 throw new MWException( '$group needs to be a string' );
197 $this->group
= $group;
201 * Returns the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').
207 public function getSource() {
208 return $this->source
;
212 * Sets the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').
216 * @param string $source
218 * @throws MWException
220 public function setSource( $source ) {
221 if ( !is_string( $source ) ) {
222 throw new MWException( '$source needs to be a string' );
225 $this->source
= $source;
229 * Gets if site.tld/path/key:pageTitle should forward users to the page on
230 * the actual site, where "key" is the local identifier.
236 public function shouldForward() {
237 return $this->forward
;
241 * Sets if site.tld/path/key:pageTitle should forward users to the page on
242 * the actual site, where "key" is the local identifier.
246 * @param bool $shouldForward
248 * @throws MWException
250 public function setForward( $shouldForward ) {
251 if ( !is_bool( $shouldForward ) ) {
252 throw new MWException( '$shouldForward needs to be a boolean' );
255 $this->forward
= $shouldForward;
259 * Returns the domain of the site, ie en.wikipedia.org
260 * Or false if it's not known.
264 * @return string|null
266 public function getDomain() {
267 $path = $this->getLinkPath();
269 if ( $path === null ) {
273 return parse_url( $path, PHP_URL_HOST
);
277 * Returns the protocol of the site.
281 * @throws MWException
284 public function getProtocol() {
285 $path = $this->getLinkPath();
287 if ( $path === null ) {
291 $protocol = parse_url( $path, PHP_URL_SCHEME
);
294 if ( $protocol === false ) {
295 throw new MWException( "failed to parse URL '$path'" );
299 if ( $protocol === null ) {
300 // Used for protocol relative URLs
308 * Sets the path used to construct links with.
309 * Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).
311 * @param string $fullUrl
315 * @throws MWException
317 public function setLinkPath( $fullUrl ) {
318 $type = $this->getLinkPathType();
320 if ( $type === null ) {
321 throw new MWException( "This Site does not support link paths." );
324 $this->setPath( $type, $fullUrl );
328 * Returns the path used to construct links with or false if there is no such path.
330 * Shall be equivalent to getPath( getLinkPathType() ).
332 * @return string|null
334 public function getLinkPath() {
335 $type = $this->getLinkPathType();
336 return $type === null ?
null : $this->getPath( $type );
340 * Returns the main path type, that is the type of the path that should
341 * generally be used to construct links to the target site.
343 * This default implementation returns Site::PATH_LINK as the default path
344 * type. Subclasses can override this to define a different default path
345 * type, or return false to disable site links.
349 * @return string|null
351 public function getLinkPathType() {
352 return self
::PATH_LINK
;
356 * Returns the full URL for the given page on the site.
357 * Or false if the needed information is not known.
359 * This generated URL is usually based upon the path returned by getLinkPath(),
360 * but this is not a requirement.
362 * This implementation returns a URL constructed using the path returned by getLinkPath().
366 * @param bool|string $pageName
368 * @return string|bool
370 public function getPageUrl( $pageName = false ) {
371 $url = $this->getLinkPath();
373 if ( $url === false ) {
377 if ( $pageName !== false ) {
378 $url = str_replace( '$1', rawurlencode( $pageName ), $url );
385 * Attempt to normalize the page name in some fashion.
386 * May return false to indicate various kinds of failure.
388 * This implementation returns $pageName without changes.
390 * @see Site::normalizePageName
394 * @param string $pageName
396 * @return string|false
398 public function normalizePageName( $pageName ) {
403 * Returns the type specific fields.
409 public function getExtraData() {
410 return $this->extraData
;
414 * Sets the type specific fields.
418 * @param array $extraData
420 public function setExtraData( array $extraData ) {
421 $this->extraData
= $extraData;
425 * Returns the type specific config.
431 public function getExtraConfig() {
432 return $this->extraConfig
;
436 * Sets the type specific config.
440 * @param array $extraConfig
442 public function setExtraConfig( array $extraConfig ) {
443 $this->extraConfig
= $extraConfig;
447 * Returns language code of the sites primary language.
448 * Or null if it's not known.
452 * @return string|null
454 public function getLanguageCode() {
455 return $this->languageCode
;
459 * Sets language code of the sites primary language.
463 * @param string $languageCode
465 public function setLanguageCode( $languageCode ) {
466 if ( !Language
::isValidCode( $languageCode ) ) {
467 throw new InvalidArgumentException( "$languageCode is not a valid language code." );
469 $this->languageCode
= $languageCode;
473 * Returns the set internal identifier for the site.
477 * @return string|null
479 public function getInternalId() {
480 return $this->internalId
;
484 * Sets the internal identifier for the site.
485 * This typically is a primary key in a db table.
489 * @param int|null $internalId
491 public function setInternalId( $internalId = null ) {
492 $this->internalId
= $internalId;
496 * Adds a local identifier.
500 * @param string $type
501 * @param string $identifier
503 public function addLocalId( $type, $identifier ) {
504 if ( $this->localIds
=== false ) {
505 $this->localIds
= [];
508 if ( !array_key_exists( $type, $this->localIds
) ) {
509 $this->localIds
[$type] = [];
512 if ( !in_array( $identifier, $this->localIds
[$type] ) ) {
513 $this->localIds
[$type][] = $identifier;
518 * Adds an interwiki id to the site.
522 * @param string $identifier
524 public function addInterwikiId( $identifier ) {
525 $this->addLocalId( self
::ID_INTERWIKI
, $identifier );
529 * Adds a navigation id to the site.
533 * @param string $identifier
535 public function addNavigationId( $identifier ) {
536 $this->addLocalId( self
::ID_EQUIVALENT
, $identifier );
540 * Returns the interwiki link identifiers that can be used for this site.
546 public function getInterwikiIds() {
547 return array_key_exists( self
::ID_INTERWIKI
, $this->localIds
)
548 ?
$this->localIds
[self
::ID_INTERWIKI
]
553 * Returns the equivalent link identifiers that can be used to make
554 * the site show up in interfaces such as the "language links" section.
560 public function getNavigationIds() {
561 return array_key_exists( self
::ID_EQUIVALENT
, $this->localIds
)
562 ?
$this->localIds
[self
::ID_EQUIVALENT
] :
567 * Returns all local ids
573 public function getLocalIds() {
574 return $this->localIds
;
578 * Sets the path used to construct links with.
579 * Shall be equivalent to setPath( getLinkPathType(), $fullUrl ).
583 * @param string $pathType
584 * @param string $fullUrl
586 * @throws MWException
588 public function setPath( $pathType, $fullUrl ) {
589 if ( !is_string( $fullUrl ) ) {
590 throw new MWException( '$fullUrl needs to be a string' );
593 if ( !array_key_exists( 'paths', $this->extraData
) ) {
594 $this->extraData
['paths'] = [];
597 $this->extraData
['paths'][$pathType] = $fullUrl;
601 * Returns the path of the provided type or false if there is no such path.
605 * @param string $pathType
607 * @return string|null
609 public function getPath( $pathType ) {
610 $paths = $this->getAllPaths();
611 return array_key_exists( $pathType, $paths ) ?
$paths[$pathType] : null;
615 * Returns the paths as associative array.
616 * The keys are path types, the values are the path urls.
622 public function getAllPaths() {
623 return array_key_exists( 'paths', $this->extraData
) ?
$this->extraData
['paths'] : [];
627 * Removes the path of the provided type if it's set.
631 * @param string $pathType
633 public function removePath( $pathType ) {
634 if ( array_key_exists( 'paths', $this->extraData
) ) {
635 unset( $this->extraData
['paths'][$pathType] );
642 * @param string $siteType
646 public static function newForType( $siteType ) {
649 if ( array_key_exists( $siteType, $wgSiteTypes ) ) {
650 return new $wgSiteTypes[$siteType]();
657 * @see Serializable::serialize
663 public function serialize() {
665 'globalid' => $this->globalId
,
666 'type' => $this->type
,
667 'group' => $this->group
,
668 'source' => $this->source
,
669 'language' => $this->languageCode
,
670 'localids' => $this->localIds
,
671 'config' => $this->extraConfig
,
672 'data' => $this->extraData
,
673 'forward' => $this->forward
,
674 'internalid' => $this->internalId
,
678 return serialize( $fields );
682 * @see Serializable::unserialize
686 * @param string $serialized
688 public function unserialize( $serialized ) {
689 $fields = unserialize( $serialized );
691 $this->__construct( $fields['type'] );
693 $this->setGlobalId( $fields['globalid'] );
694 $this->setGroup( $fields['group'] );
695 $this->setSource( $fields['source'] );
696 $this->setLanguageCode( $fields['language'] );
697 $this->localIds
= $fields['localids'];
698 $this->setExtraConfig( $fields['config'] );
699 $this->setExtraData( $fields['data'] );
700 $this->setForward( $fields['forward'] );
701 $this->setInternalId( $fields['internalid'] );