includes/collation/CollationFactory.php

   1 <?php
   2
   3 /**
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  * http://www.gnu.org/copyleft/gpl.html
  18  *
  19  * @file
  20  */
  21
  22 namespace MediaWiki\Collation;
  23
  24 use Collation;
  25 use InvalidArgumentException;
  26 use MediaWiki\Config\ServiceOptions;
  27 use MediaWiki\HookContainer\HookContainer;
  28 use MediaWiki\HookContainer\HookRunner;
  29 use MediaWiki\MainConfigNames;
  30 use Wikimedia\ObjectFactory\ObjectFactory;
  31
  32 /**
  33  * Common factory to construct collation classes.
  34  *
  35  * @since 1.37
  36  */
  37 class CollationFactory {
  38         /**
  39          * @internal For use by ServiceWiring
  40          */
  41         public const CONSTRUCTOR_OPTIONS = [
  42                 MainConfigNames::CategoryCollation,
  43         ];
  44
  45         private const CORE_COLLATIONS = [
  46                 'uppercase' => [
  47                         'class' => \UppercaseCollation::class,
  48                         'services' => [
  49                                 'LanguageFactory',
  50                         ]
  51                 ],
  52                 'numeric' => [
  53                         'class' => \NumericUppercaseCollation::class,
  54                         'services' => [
  55                                 'LanguageFactory',
  56                                 'ContentLanguage',
  57                         ]
  58                 ],
  59                 'identity' => [
  60                         'class' => \IdentityCollation::class,
  61                         'services' => [
  62                                 'ContentLanguage',
  63                         ]
  64                 ],
  65                 'uca-default' => [
  66                         'class' => \IcuCollation::class,
  67                         'services' => [
  68                                 'LanguageFactory',
  69                         ],
  70                         'args' => [
  71                                 'root',
  72                         ]
  73                 ],
  74                 'uca-default-u-kn' => [
  75                         'class' => \IcuCollation::class,
  76                         'services' => [
  77                                 'LanguageFactory',
  78                         ],
  79                         'args' => [
  80                                 'root-u-kn',
  81                         ]
  82                 ],
  83                 'xx-uca-ckb' => [
  84                         'class' => \CollationCkb::class,
  85                         'services' => [
  86                                 'LanguageFactory',
  87                         ]
  88                 ],
  89                 'uppercase-ab' => [
  90                         'class' => \AbkhazUppercaseCollation::class,
  91                         'services' => [
  92                                 'LanguageFactory',
  93                         ]
  94                 ],
  95                 'uppercase-ba' => [
  96                         'class' => \BashkirUppercaseCollation::class,
  97                         'services' => [
  98                                 'LanguageFactory',
  99                         ]
 100                 ],
 101         ];
 102
 103         /** @var ServiceOptions */
 104         private $options;
 105
 106         /** @var ObjectFactory */
 107         private $objectFactory;
 108
 109         /** @var HookRunner */
 110         private $hookRunner;
 111
 112         /**
 113          * @param ServiceOptions $options
 114          * @param ObjectFactory $objectFactory
 115          * @param HookContainer $hookContainer
 116          */
 117         public function __construct(
 118                 ServiceOptions $options,
 119                 ObjectFactory $objectFactory,
 120                 HookContainer $hookContainer
 121         ) {
 122                 $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
 123                 $this->options = $options;
 124                 $this->objectFactory = $objectFactory;
 125                 $this->hookRunner = new HookRunner( $hookContainer );
 126         }
 127
 128         public function getCategoryCollation(): Collation {
 129                 return $this->makeCollation( $this->getDefaultCollationName() );
 130         }
 131
 132         public function getDefaultCollationName(): string {
 133                 return $this->options->get( MainConfigNames::CategoryCollation );
 134         }
 135
 136         public function makeCollation( string $collationName ): Collation {
 137                 if ( isset( self::CORE_COLLATIONS[$collationName] ) ) {
 138                         return $this->instantiateCollation( self::CORE_COLLATIONS[$collationName] );
 139                 }
 140
 141                 if ( preg_match( '/^uca-([A-Za-z@=-]+)$/', $collationName, $match ) ) {
 142                         return $this->instantiateCollation( [
 143                                 'class' => \IcuCollation::class,
 144                                 'services' => [
 145                                         'LanguageFactory',
 146                                 ],
 147                                 'args' => [
 148                                         $match[1],
 149                                 ]
 150                         ] );
 151                 } elseif ( preg_match( '/^remote-uca-([A-Za-z@=-]+)$/', $collationName, $match ) ) {
 152                         return $this->instantiateCollation( [
 153                                 'class' => \RemoteIcuCollation::class,
 154                                 'services' => [
 155                                         'ShellboxClientFactory'
 156                                 ],
 157                                 'args' => [
 158                                         $match[1]
 159                                 ]
 160                         ] );
 161                 }
 162
 163                 // Provide a mechanism for extensions to hook in.
 164                 $collationObject = null;
 165                 $this->hookRunner->onCollation__factory( $collationName, $collationObject );
 166
 167                 if ( !$collationObject instanceof Collation ) {
 168                         throw new InvalidArgumentException( __METHOD__ . ": unknown collation type \"$collationName\"" );
 169                 }
 170
 171                 return $collationObject;
 172         }
 173
 174         /**
 175          * @param array $spec
 176          * @return Collation
 177          */
 178         private function instantiateCollation( $spec ): Collation {
 179                 return $this->objectFactory->createObject(
 180                         $spec,
 181                         [
 182                                 'assertClass' => Collation::class
 183                         ]
 184                 );
 185         }
 186
 187 }