4b436b7021
Previously, getProtocol() would return null for a protocol relative URL, but the database field sites_protocol does not allow null as a value. Changed getProtocol() to return an empty string instead. Change-Id: I7e22cc3c3d8dca17a28fc4627083d5d2cb253887
547 lines
10 KiB
PHP
547 lines
10 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Class representing a single site.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @file
|
|
* @ingroup Site
|
|
*
|
|
* @license GNU GPL v2+
|
|
* @author Jeroen De Dauw < jeroendedauw@gmail.com >
|
|
* @author Daniel Werner
|
|
*/
|
|
class SiteObject extends ORMRow implements Site {
|
|
|
|
const PATH_LINK = 'link';
|
|
|
|
/**
|
|
* Holds the local ids for this site.
|
|
* You can obtain them via @see getLocalIds
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @var array|false
|
|
*/
|
|
protected $localIds = false;
|
|
|
|
/**
|
|
* @see Site::getGlobalId
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getGlobalId() {
|
|
return $this->getField( 'global_key' );
|
|
}
|
|
|
|
/**
|
|
* @see Site::setGlobalId
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $globalId
|
|
*/
|
|
public function setGlobalId( $globalId ) {
|
|
$this->setField( 'global_key', $globalId );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getType
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getType() {
|
|
return $this->getField( 'type' );
|
|
}
|
|
|
|
/**
|
|
* @see Site::setType
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $type
|
|
*/
|
|
public function setType( $type ) {
|
|
$this->setField( 'type', $type );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getGroup
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getGroup() {
|
|
return $this->getField( 'group' );
|
|
}
|
|
|
|
/**
|
|
* @see Site::setGroup
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $group
|
|
*/
|
|
public function setGroup( $group ) {
|
|
$this->setField( 'group', $group );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getSource
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getSource() {
|
|
return $this->getField( 'source' );
|
|
}
|
|
|
|
/**
|
|
* @see Site::setSource
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $source
|
|
*/
|
|
public function setSource( $source ) {
|
|
$this->setField( 'source', $source );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getDomain
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public function getDomain() {
|
|
$path = $this->getLinkPath();
|
|
|
|
if ( $path === false ) {
|
|
return false;
|
|
}
|
|
|
|
return parse_url( $path, PHP_URL_HOST );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getProtocol
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public function getProtocol() {
|
|
$path = $this->getLinkPath();
|
|
|
|
if ( $path === false ) {
|
|
return '';
|
|
}
|
|
|
|
$protocol = parse_url( $path, PHP_URL_SCHEME );
|
|
|
|
if ( $protocol === false ) { // malformed URL
|
|
throw new MWException( "failed to parse URL $path" );
|
|
}
|
|
|
|
if ( $protocol === null ) { // no schema
|
|
$protocol = ''; // used for protocol relative URLs
|
|
}
|
|
|
|
return $protocol;
|
|
}
|
|
|
|
/**
|
|
* Sets the path used to construct links with.
|
|
* @see Site::setLinkPath
|
|
*
|
|
* @param string $fullUrl
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @throws MWException
|
|
*/
|
|
public function setLinkPath( $fullUrl ) {
|
|
$type = $this->getLinkPathType();
|
|
|
|
if ( $type === false ) {
|
|
throw new MWException( "This SiteObject does not support link paths." );
|
|
}
|
|
|
|
$this->setPath( $type, $fullUrl );
|
|
}
|
|
|
|
/**
|
|
* Returns the path path used to construct links with or false if there is no such path.
|
|
*
|
|
* @see Site::getLinkPath
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public function getLinkPath() {
|
|
$type = $this->getLinkPathType();
|
|
return $type === false ? false : $this->getPath( $type );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getLinkPathType
|
|
*
|
|
* Returns the main path type, that is the type of the path that should generally be used to construct links
|
|
* to the target site.
|
|
*
|
|
* This default implementation returns SiteObject::PATH_LINK as the default path type. Subclasses can override this
|
|
* to define a different default path type, or return false to disable site links.
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public function getLinkPathType() {
|
|
return self::PATH_LINK;
|
|
}
|
|
|
|
/**
|
|
* @see Site::getPageUrl
|
|
*
|
|
* This implementation returns a URL constructed using the path returned by getLinkPath().
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param bool|String $pageName
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public function getPageUrl( $pageName = false ) {
|
|
$url = $this->getLinkPath();
|
|
|
|
if ( $url === false ) {
|
|
return false;
|
|
}
|
|
|
|
if ( $pageName !== false ) {
|
|
$url = str_replace( '$1', rawurlencode( $pageName ), $url ) ;
|
|
}
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* Returns $pageName without changes.
|
|
* Subclasses may override this to apply some kind of normalization.
|
|
*
|
|
* @see Site::normalizePageName
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $pageName
|
|
*
|
|
* @return string
|
|
*/
|
|
public function normalizePageName( $pageName ) {
|
|
return $pageName;
|
|
}
|
|
|
|
/**
|
|
* Returns the value of a type specific field, or the value
|
|
* of the $default parameter in case it's not set.
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $fieldName
|
|
* @param mixed $default
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getExtraData( $fieldName, $default = null ) {
|
|
$data = $this->getField( 'data', array() );
|
|
return array_key_exists( $fieldName,$data ) ? $data[$fieldName] : $default;
|
|
}
|
|
|
|
/**
|
|
* Sets the value of a type specific field.
|
|
* @since 1.21
|
|
*
|
|
* @param string $fieldName
|
|
* @param mixed $value
|
|
*/
|
|
protected function setExtraData( $fieldName, $value = null ) {
|
|
$data = $this->getField( 'data', array() );
|
|
$data[$fieldName] = $value;
|
|
$this->setField( 'data', $data );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getLanguageCode
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public function getLanguageCode() {
|
|
return $this->getField( 'language', false );
|
|
}
|
|
|
|
/**
|
|
* @see Site::setLanguageCode
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $languageCode
|
|
*/
|
|
public function setLanguageCode( $languageCode ) {
|
|
$this->setField( 'language', $languageCode );
|
|
}
|
|
|
|
/**
|
|
* Returns the local identifiers of this site.
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $type
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getLocalIds( $type ) {
|
|
if ( $this->localIds === false ) {
|
|
$this->loadLocalIds();
|
|
}
|
|
|
|
return array_key_exists( $type, $this->localIds ) ? $this->localIds[$type] : array();
|
|
}
|
|
|
|
/**
|
|
* Loads the local ids for the site.
|
|
*
|
|
* @since 1.21
|
|
*/
|
|
protected function loadLocalIds() {
|
|
$dbr = wfGetDB( $this->getTable()->getReadDb() );
|
|
|
|
$ids = $dbr->select(
|
|
'site_identifiers',
|
|
array(
|
|
'si_type',
|
|
'si_key',
|
|
),
|
|
array(
|
|
'si_site' => $this->getId(),
|
|
),
|
|
__METHOD__
|
|
);
|
|
|
|
$this->localIds = array();
|
|
|
|
foreach ( $ids as $id ) {
|
|
$this->addLocalId( $id->si_type, $id->si_key );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds a local identifier.
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $type
|
|
* @param string $identifier
|
|
*/
|
|
public function addLocalId( $type, $identifier ) {
|
|
if ( $this->localIds === false ) {
|
|
$this->localIds = array();
|
|
}
|
|
|
|
if ( !array_key_exists( $type, $this->localIds ) ) {
|
|
$this->localIds[$type] = array();
|
|
}
|
|
|
|
if ( !in_array( $identifier, $this->localIds[$type] ) ) {
|
|
$this->localIds[$type][] = $identifier;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see Site::addInterwikiId
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $identifier
|
|
*/
|
|
public function addInterwikiId( $identifier ) {
|
|
$this->addLocalId( 'interwiki', $identifier );
|
|
}
|
|
|
|
/**
|
|
* @see Site::addNavigationId
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $identifier
|
|
*/
|
|
public function addNavigationId( $identifier ) {
|
|
$this->addLocalId( 'equivalent', $identifier );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getInterwikiIds
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return array of string
|
|
*/
|
|
public function getInterwikiIds() {
|
|
return $this->getLocalIds( 'interwiki' );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getNavigationIds
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return array of string
|
|
*/
|
|
public function getNavigationIds() {
|
|
return $this->getLocalIds( 'equivalent' );
|
|
}
|
|
|
|
/**
|
|
* @see Site::getInternalId
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getInternalId() {
|
|
return $this->getId();
|
|
}
|
|
|
|
/**
|
|
* @see ORMRow::save
|
|
* @see Site::save
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string|null $functionName
|
|
*
|
|
* @return boolean Success indicator
|
|
*/
|
|
public function save( $functionName = null ) {
|
|
$dbw = wfGetDB( DB_MASTER );
|
|
|
|
$trx = $dbw->trxLevel();
|
|
|
|
if ( $trx == 0 ) {
|
|
$dbw->begin( __METHOD__ );
|
|
}
|
|
|
|
$this->setField( 'protocol', $this->getProtocol() );
|
|
$this->setField( 'domain', strrev( $this->getDomain() ) . '.' );
|
|
|
|
$existedAlready = $this->hasIdField();
|
|
|
|
$success = parent::save( $functionName );
|
|
|
|
if ( $success && $existedAlready ) {
|
|
$dbw->delete(
|
|
'site_identifiers',
|
|
array( 'si_site' => $this->getId() ),
|
|
__METHOD__
|
|
);
|
|
}
|
|
|
|
if ( $success && $this->localIds !== false ) {
|
|
foreach ( $this->localIds as $type => $ids ) {
|
|
foreach ( $ids as $id ) {
|
|
$dbw->insert(
|
|
'site_identifiers',
|
|
array(
|
|
'si_site' => $this->getId(),
|
|
'si_type' => $type,
|
|
'si_key' => $id,
|
|
),
|
|
__METHOD__
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $trx == 0 ) {
|
|
$dbw->commit( __METHOD__ );
|
|
}
|
|
|
|
return $success;
|
|
}
|
|
|
|
/**
|
|
* @see Site::setPath
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $pathType
|
|
* @param string $fullUrl
|
|
*/
|
|
public function setPath( $pathType, $fullUrl ) {
|
|
$paths = $this->getExtraData( 'paths', array() );
|
|
$paths[$pathType] = $fullUrl;
|
|
$this->setExtraData( 'paths', $paths );
|
|
}
|
|
|
|
/**
|
|
* @see Sitres::getPath
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $pathType
|
|
*
|
|
* @return string|false
|
|
*/
|
|
public function getPath( $pathType ) {
|
|
$paths = $this->getExtraData( 'paths', array() );
|
|
return array_key_exists( $pathType, $paths ) ? $paths[$pathType] : false;
|
|
}
|
|
|
|
/**
|
|
* @see Sitres::getAll
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @return array of string
|
|
*/
|
|
public function getAllPaths() {
|
|
return $this->getExtraData( 'paths', array() );
|
|
}
|
|
|
|
/**
|
|
* @see Sitres::removePath
|
|
*
|
|
* @since 1.21
|
|
*
|
|
* @param string $pathType
|
|
*/
|
|
public function removePath( $pathType ) {
|
|
$paths = $this->getExtraData( 'paths', array() );
|
|
unset( $paths[$pathType] );
|
|
$this->setExtraData( 'paths', $paths );
|
|
}
|
|
|
|
}
|