includes/DistributionRepository.php

   1 <?php
   2
   3 /**
   4  * File holding the DistributionRepository class.
   5  *
   6  * @file DistributionRepository.php
   7  * @ingroup Deployment
   8  *
   9  * @author Jeroen De Dauw
  10  */
  11
  12 if ( !defined( 'MEDIAWIKI' ) ) {
  13         die( 'Not an entry point.' );
  14 }
  15
  16 /**
  17  * Repository class for interaction with repositories provided by
  18  * the Distirbution extension and the MediaWiki API.
  19  *
  20  * @since 1.17
  21  *
  22  * @ingroup Deployment
  23  *
  24  * @author Jeroen De Dauw
  25  */
  26 class DistributionRepository extends PackageRepository {
  27
  28         /**
  29          * Constructor.
  30          *
  31          * @param $location String: path to the api of the MediaWiki install providing the repository.
  32          *
  33          * @since 1.17
  34          */
  35         public function __construct( $location ) {
  36                 parent::__construct( $location );
  37         }
  38
  39         /**
  40          * @see PackageRepository::findExtenions
  41          *
  42          * @since 1.17
  43          *
  44          * @param $filterType String
  45          * @param $filterValue String
  46          *
  47          * @return array
  48          */
  49         public function findExtenions( $filterType, $filterValue ) {
  50                 global $wgRepositoryPackageStates;
  51
  52                 $filterType = urlencode( $filterType );
  53                 $filterValue = urlencode( $filterValue );
  54                 $states = urlencode( implode( '|', $wgRepositoryPackageStates ) );
  55
  56                 $response = Http::get(
  57                         "$this->location?format=json&action=query&list=extensions&dstfilter=$filterType&dstvalue=$filterValue&dststate=$states",
  58                         'default',
  59                         array( 'sslVerifyHost' => true, 'sslVerifyCert' => true )
  60                 );
  61
  62                 $extensions = array();
  63
  64                 if ( $response !== false ) {
  65                         $response = FormatJson::decode( $response );
  66
  67                         if ( property_exists( $response, 'query' ) && property_exists( $response->query, 'extensions' ) ) {
  68                                 $extensions = $response->query->extensions;
  69                         }
  70                 }
  71
  72                 return $extensions;
  73         }
  74
  75         /**
  76          * @see PackageRepository::extensionHasUpdate
  77          *
  78          * @since 1.17
  79          */
  80         public function extensionHasUpdate( $extensionName, $currentVersion ) {
  81                 global $wgRepositoryPackageStates;
  82
  83                 $extensionName = urlencode( $extensionName );
  84                 $currentVersion = urlencode( $currentVersion );
  85                 $states = urlencode( implode( '|', $wgRepositoryPackageStates ) );
  86
  87                 $response = Http::get(
  88                         "$this->location?format=json&action=updates&extensions=$extensionName;$currentVersion&state=$states",
  89                         'default',
  90                         array( 'sslVerifyHost' => true, 'sslVerifyCert' => true )
  91                 );
  92
  93                 if ( $response === false ) {
  94                         return false;
  95                 }
  96
  97                 $response = FormatJson::decode( $response );
  98
  99                 if ( property_exists( $response, 'extensions' ) && property_exists( $response->extensions, $extensionName ) ) {
 100                         return $response->extensions->$extensionName;
 101                 }
 102
 103                 return false;
 104         }
 105
 106         /**
 107          * @see PackageRepository::coreHasUpdate
 108          *
 109          * @since 1.17
 110          */
 111         public function coreHasUpdate( $currentVersion ) {
 112                 global $wgRepositoryPackageStates;
 113
 114                 $currentVersion = urlencode( $currentVersion );
 115                 $states = urlencode( implode( '|', $wgRepositoryPackageStates ) );
 116
 117                 $response = Http::get(
 118                         "$this->location?format=json&action=updates&mediawiki=$currentVersion&state=$states",
 119                         'default',
 120                         array( 'sslVerifyHost' => true, 'sslVerifyCert' => true )
 121                 );
 122
 123                 if ( $response === false ) {
 124                         return false;
 125                 }
 126
 127                 $response = FormatJson::decode( $response );
 128
 129                 if ( property_exists( $response, 'mediawiki' ) ) {
 130                         return $response->mediawiki;
 131                 }
 132
 133                 return false;
 134         }
 135
 136         /**
 137          * @see PackageRepository::coreHasUpdate
 138          *
 139          * @since 1.17
 140          */
 141         public function getLatestCoreVersion() {
 142                 global $wgRepositoryPackageStates;
 143
 144                 $states = urlencode( implode( '|', $wgRepositoryPackageStates ) );
 145
 146                 // TODO: use $states
 147
 148                 $response = Http::get(
 149                         "$this->location?format=json&action=mwreleases",
 150                         'default',
 151                         array( 'sslVerifyHost' => true, 'sslVerifyCert' => true )
 152                 );
 153
 154                 if ( $response === false ) {
 155                         return false;
 156                 }
 157
 158                 $response = FormatJson::decode( $response );
 159
 160                 $current = false;
 161
 162                 if ( property_exists( $response, 'mwreleases' ) ) {
 163                         foreach ( $response->mwreleases as $release ) {
 164                                 if ( property_exists( $release, 'current' ) && property_exists( $release, 'version') ) {
 165                                         $current = $release->version;
 166                                 }
 167                         }
 168                 }
 169
 170                 return $current;
 171         }
 172
 173         /**
 174          * @see PackageRepository::installationHasUpdates
 175          *
 176          * @since 1.17
 177          */
 178         public function installationHasUpdates( $coreVersion, array $extensions ) {
 179                 global $wgRepositoryPackageStates;
 180
 181                 $coreVersion = urlencode( $coreVersion );
 182                 $states = urlencode( implode( '|', $wgRepositoryPackageStates ) );
 183
 184                 $extensionParams = array();
 185
 186                 if ( count( $extensions ) > 0 ) {
 187                         foreach ( $extensions as $extensionName => $extensionVersion ) {
 188                                 $extensionParams[] = urlencode( $extensionName ) . ';' . urlencode( $extensionVersion );
 189                         }
 190
 191                         $extensionParams = '&extensions=' . urlencode( implode( '|', $extensionParams ) );
 192                 }
 193
 194                 $response = Http::get(
 195                         "$this->location?format=json&action=updates&mediawiki=$coreVersion{$extensionParams}&state=$states",
 196                         'default',
 197                         array( 'sslVerifyHost' => true, 'sslVerifyCert' => true )
 198                 );
 199
 200                 if ( $response === false ) {
 201                         return false;
 202                 }
 203
 204                 $response = FormatJson::decode( $response );
 205
 206                 $updates = array();
 207
 208                 if ( property_exists( $response, 'mediawiki' ) ) {
 209                         $updates['MediaWiki'] = $response->mediawiki;
 210                 }
 211
 212                 if ( property_exists( $response, 'extensions' ) ) {
 213                         foreach ( $extensions as $extensionName => $extensionVersion ) {
 214                                 if ( property_exists( $response->extensions, $extensionName ) ) {
 215                                         $updates[$extensionName] = $response->extensions->$extensionName;
 216                                 }
 217                         }
 218                 }
 219
 220                 return count( $updates ) > 0 ? $updates : false;
 221         }
 222
 223 }