MediaWiki  master
PostgresInstaller.php
Go to the documentation of this file.
1 <?php
27 
35 
36  protected $globalNames = [
37  'wgDBserver',
38  'wgDBport',
39  'wgDBname',
40  'wgDBuser',
41  'wgDBpassword',
42  'wgDBmwschema',
43  ];
44 
45  protected $internalDefaults = [
46  '_InstallUser' => 'postgres',
47  ];
48 
49  public static $minimumVersion = '9.2';
50  protected static $notMiniumumVerisonMessage = 'config-postgres-old';
51  public $maxRoleSearchDepth = 5;
52 
53  protected $pgConns = [];
54 
55  function getName() {
56  return 'postgres';
57  }
58 
59  public function isCompiled() {
60  return self::checkExtension( 'pgsql' );
61  }
62 
63  function getConnectForm() {
64  return $this->getTextBox(
65  'wgDBserver',
66  'config-db-host',
67  [],
68  $this->parent->getHelpBox( 'config-db-host-help' )
69  ) .
70  $this->getTextBox( 'wgDBport', 'config-db-port' ) .
71  Html::openElement( 'fieldset' ) .
72  Html::element( 'legend', [], wfMessage( 'config-db-wiki-settings' )->text() ) .
73  $this->getTextBox(
74  'wgDBname',
75  'config-db-name',
76  [],
77  $this->parent->getHelpBox( 'config-db-name-help' )
78  ) .
79  $this->getTextBox(
80  'wgDBmwschema',
81  'config-db-schema',
82  [],
83  $this->parent->getHelpBox( 'config-db-schema-help' )
84  ) .
85  Html::closeElement( 'fieldset' ) .
86  $this->getInstallUserBox();
87  }
88 
89  function submitConnectForm() {
90  // Get variables from the request
91  $newValues = $this->setVarsFromRequest( [
92  'wgDBserver',
93  'wgDBport',
94  'wgDBname',
95  'wgDBmwschema'
96  ] );
97 
98  // Validate them
100  if ( !strlen( $newValues['wgDBname'] ) ) {
101  $status->fatal( 'config-missing-db-name' );
102  } elseif ( !preg_match( '/^[a-zA-Z0-9_]+$/', $newValues['wgDBname'] ) ) {
103  $status->fatal( 'config-invalid-db-name', $newValues['wgDBname'] );
104  }
105  if ( !preg_match( '/^[a-zA-Z0-9_]*$/', $newValues['wgDBmwschema'] ) ) {
106  $status->fatal( 'config-invalid-schema', $newValues['wgDBmwschema'] );
107  }
108 
109  // Submit user box
110  if ( $status->isOK() ) {
111  $status->merge( $this->submitInstallUserBox() );
112  }
113  if ( !$status->isOK() ) {
114  return $status;
115  }
116 
117  $status = $this->getPgConnection( 'create-db' );
118  if ( !$status->isOK() ) {
119  return $status;
120  }
124  $conn = $status->value;
125 
126  // Check version
127  $version = $conn->getServerVersion();
128  $status = static::meetsMinimumRequirement( $version );
129  if ( !$status->isOK() ) {
130  return $status;
131  }
132 
133  $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
134  $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
135 
136  return Status::newGood();
137  }
138 
139  public function getConnection() {
140  $status = $this->getPgConnection( 'create-tables' );
141  if ( $status->isOK() ) {
142  $this->db = $status->value;
143  }
144 
145  return $status;
146  }
147 
148  public function openConnection() {
149  return $this->openPgConnection( 'create-tables' );
150  }
151 
160  protected function openConnectionWithParams( $user, $password, $dbName, $schema ) {
162  try {
163  $db = Database::factory( 'postgres', [
164  'host' => $this->getVar( 'wgDBserver' ),
165  'port' => $this->getVar( 'wgDBport' ),
166  'user' => $user,
167  'password' => $password,
168  'dbname' => $dbName,
169  'schema' => $schema,
170  'keywordTableMap' => [ 'user' => 'mwuser', 'text' => 'pagecontent' ],
171  ] );
172  $status->value = $db;
173  } catch ( DBConnectionError $e ) {
174  $status->fatal( 'config-connection-error', $e->getMessage() );
175  }
176 
177  return $status;
178  }
179 
185  protected function getPgConnection( $type ) {
186  if ( isset( $this->pgConns[$type] ) ) {
187  return Status::newGood( $this->pgConns[$type] );
188  }
189  $status = $this->openPgConnection( $type );
190 
191  if ( $status->isOK() ) {
195  $conn = $status->value;
196  $conn->clearFlag( DBO_TRX );
197  $conn->commit( __METHOD__ );
198  $this->pgConns[$type] = $conn;
199  }
200 
201  return $status;
202  }
203 
229  protected function openPgConnection( $type ) {
230  switch ( $type ) {
231  case 'create-db':
232  return $this->openConnectionToAnyDB(
233  $this->getVar( '_InstallUser' ),
234  $this->getVar( '_InstallPassword' ) );
235  case 'create-schema':
236  return $this->openConnectionWithParams(
237  $this->getVar( '_InstallUser' ),
238  $this->getVar( '_InstallPassword' ),
239  $this->getVar( 'wgDBname' ),
240  $this->getVar( 'wgDBmwschema' ) );
241  case 'create-tables':
242  $status = $this->openPgConnection( 'create-schema' );
243  if ( $status->isOK() ) {
247  $conn = $status->value;
248  $safeRole = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
249  $conn->query( "SET ROLE $safeRole" );
250  }
251 
252  return $status;
253  default:
254  throw new MWException( "Invalid special connection type: \"$type\"" );
255  }
256  }
257 
258  public function openConnectionToAnyDB( $user, $password ) {
259  $dbs = [
260  'template1',
261  'postgres',
262  ];
263  if ( !in_array( $this->getVar( 'wgDBname' ), $dbs ) ) {
264  array_unshift( $dbs, $this->getVar( 'wgDBname' ) );
265  }
266  $conn = false;
268  foreach ( $dbs as $db ) {
269  try {
270  $p = [
271  'host' => $this->getVar( 'wgDBserver' ),
272  'user' => $user,
273  'password' => $password,
274  'dbname' => $db
275  ];
276  $conn = Database::factory( 'postgres', $p );
277  } catch ( DBConnectionError $error ) {
278  $conn = false;
279  $status->fatal( 'config-pg-test-error', $db,
280  $error->getMessage() );
281  }
282  if ( $conn !== false ) {
283  break;
284  }
285  }
286  if ( $conn !== false ) {
287  return Status::newGood( $conn );
288  } else {
289  return $status;
290  }
291  }
292 
293  protected function getInstallUserPermissions() {
294  $status = $this->getPgConnection( 'create-db' );
295  if ( !$status->isOK() ) {
296  return false;
297  }
301  $conn = $status->value;
302  $superuser = $this->getVar( '_InstallUser' );
303 
304  $row = $conn->selectRow( '"pg_catalog"."pg_roles"', '*',
305  [ 'rolname' => $superuser ], __METHOD__ );
306 
307  return $row;
308  }
309 
310  protected function canCreateAccounts() {
311  $perms = $this->getInstallUserPermissions();
312  if ( !$perms ) {
313  return false;
314  }
315 
316  return $perms->rolsuper === 't' || $perms->rolcreaterole === 't';
317  }
318 
319  protected function isSuperUser() {
320  $perms = $this->getInstallUserPermissions();
321  if ( !$perms ) {
322  return false;
323  }
324 
325  return $perms->rolsuper === 't';
326  }
327 
328  public function getSettingsForm() {
329  if ( $this->canCreateAccounts() ) {
330  $noCreateMsg = false;
331  } else {
332  $noCreateMsg = 'config-db-web-no-create-privs';
333  }
334  $s = $this->getWebUserBox( $noCreateMsg );
335 
336  return $s;
337  }
338 
339  public function submitSettingsForm() {
340  $status = $this->submitWebUserBox();
341  if ( !$status->isOK() ) {
342  return $status;
343  }
344 
345  $same = $this->getVar( 'wgDBuser' ) === $this->getVar( '_InstallUser' );
346 
347  if ( $same ) {
348  $exists = true;
349  } else {
350  // Check if the web user exists
351  // Connect to the database with the install user
352  $status = $this->getPgConnection( 'create-db' );
353  if ( !$status->isOK() ) {
354  return $status;
355  }
356  $exists = $status->value->roleExists( $this->getVar( 'wgDBuser' ) );
357  }
358 
359  // Validate the create checkbox
360  if ( $this->canCreateAccounts() && !$same && !$exists ) {
361  $create = $this->getVar( '_CreateDBAccount' );
362  } else {
363  $this->setVar( '_CreateDBAccount', false );
364  $create = false;
365  }
366 
367  if ( !$create && !$exists ) {
368  if ( $this->canCreateAccounts() ) {
369  $msg = 'config-install-user-missing-create';
370  } else {
371  $msg = 'config-install-user-missing';
372  }
373 
374  return Status::newFatal( $msg, $this->getVar( 'wgDBuser' ) );
375  }
376 
377  if ( !$exists ) {
378  // No more checks to do
379  return Status::newGood();
380  }
381 
382  // Existing web account. Test the connection.
384  $this->getVar( 'wgDBuser' ),
385  $this->getVar( 'wgDBpassword' ) );
386  if ( !$status->isOK() ) {
387  return $status;
388  }
389 
390  // The web user is conventionally the table owner in PostgreSQL
391  // installations. Make sure the install user is able to create
392  // objects on behalf of the web user.
393  if ( $same || $this->canCreateObjectsForWebUser() ) {
394  return Status::newGood();
395  } else {
396  return Status::newFatal( 'config-pg-not-in-role' );
397  }
398  }
399 
405  protected function canCreateObjectsForWebUser() {
406  if ( $this->isSuperUser() ) {
407  return true;
408  }
409 
410  $status = $this->getPgConnection( 'create-db' );
411  if ( !$status->isOK() ) {
412  return false;
413  }
414  $conn = $status->value;
415  $installerId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
416  [ 'rolname' => $this->getVar( '_InstallUser' ) ], __METHOD__ );
417  $webId = $conn->selectField( '"pg_catalog"."pg_roles"', 'oid',
418  [ 'rolname' => $this->getVar( 'wgDBuser' ) ], __METHOD__ );
419 
420  return $this->isRoleMember( $conn, $installerId, $webId, $this->maxRoleSearchDepth );
421  }
422 
431  protected function isRoleMember( $conn, $targetMember, $group, $maxDepth ) {
432  if ( $targetMember === $group ) {
433  // A role is always a member of itself
434  return true;
435  }
436  // Get all members of the given group
437  $res = $conn->select( '"pg_catalog"."pg_auth_members"', [ 'member' ],
438  [ 'roleid' => $group ], __METHOD__ );
439  foreach ( $res as $row ) {
440  if ( $row->member == $targetMember ) {
441  // Found target member
442  return true;
443  }
444  // Recursively search each member of the group to see if the target
445  // is a member of it, up to the given maximum depth.
446  if ( $maxDepth > 0 &&
447  $this->isRoleMember( $conn, $targetMember, $row->member, $maxDepth - 1 )
448  ) {
449  // Found member of member
450  return true;
451  }
452  }
453 
454  return false;
455  }
456 
457  public function preInstall() {
458  $createDbAccount = [
459  'name' => 'user',
460  'callback' => [ $this, 'setupUser' ],
461  ];
462  $commitCB = [
463  'name' => 'pg-commit',
464  'callback' => [ $this, 'commitChanges' ],
465  ];
466  $plpgCB = [
467  'name' => 'pg-plpgsql',
468  'callback' => [ $this, 'setupPLpgSQL' ],
469  ];
470  $schemaCB = [
471  'name' => 'schema',
472  'callback' => [ $this, 'setupSchema' ]
473  ];
474 
475  if ( $this->getVar( '_CreateDBAccount' ) ) {
476  $this->parent->addInstallStep( $createDbAccount, 'database' );
477  }
478  $this->parent->addInstallStep( $commitCB, 'interwiki' );
479  $this->parent->addInstallStep( $plpgCB, 'database' );
480  $this->parent->addInstallStep( $schemaCB, 'database' );
481  }
482 
483  function setupDatabase() {
484  $status = $this->getPgConnection( 'create-db' );
485  if ( !$status->isOK() ) {
486  return $status;
487  }
488  $conn = $status->value;
489 
490  $dbName = $this->getVar( 'wgDBname' );
491 
492  $exists = $conn->selectField( '"pg_catalog"."pg_database"', '1',
493  [ 'datname' => $dbName ], __METHOD__ );
494  if ( !$exists ) {
495  $safedb = $conn->addIdentifierQuotes( $dbName );
496  $conn->query( "CREATE DATABASE $safedb", __METHOD__ );
497  }
498 
499  return Status::newGood();
500  }
501 
502  function setupSchema() {
503  // Get a connection to the target database
504  $status = $this->getPgConnection( 'create-schema' );
505  if ( !$status->isOK() ) {
506  return $status;
507  }
508  $conn = $status->value;
509 
510  // Create the schema if necessary
511  $schema = $this->getVar( 'wgDBmwschema' );
512  $safeschema = $conn->addIdentifierQuotes( $schema );
513  $safeuser = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
514  if ( !$conn->schemaExists( $schema ) ) {
515  try {
516  $conn->query( "CREATE SCHEMA $safeschema AUTHORIZATION $safeuser" );
517  } catch ( DBQueryError $e ) {
518  return Status::newFatal( 'config-install-pg-schema-failed',
519  $this->getVar( '_InstallUser' ), $schema );
520  }
521  }
522 
523  // Select the new schema in the current connection
524  $conn->determineCoreSchema( $schema );
525 
526  return Status::newGood();
527  }
528 
529  function commitChanges() {
530  $this->db->commit( __METHOD__ );
531 
532  return Status::newGood();
533  }
534 
535  function setupUser() {
536  if ( !$this->getVar( '_CreateDBAccount' ) ) {
537  return Status::newGood();
538  }
539 
540  $status = $this->getPgConnection( 'create-db' );
541  if ( !$status->isOK() ) {
542  return $status;
543  }
544  $conn = $status->value;
545 
546  $safeuser = $conn->addIdentifierQuotes( $this->getVar( 'wgDBuser' ) );
547  $safepass = $conn->addQuotes( $this->getVar( 'wgDBpassword' ) );
548 
549  // Check if the user already exists
550  $userExists = $conn->roleExists( $this->getVar( 'wgDBuser' ) );
551  if ( !$userExists ) {
552  // Create the user
553  try {
554  $sql = "CREATE ROLE $safeuser NOCREATEDB LOGIN PASSWORD $safepass";
555 
556  // If the install user is not a superuser, we need to make the install
557  // user a member of the new user's group, so that the install user will
558  // be able to create a schema and other objects on behalf of the new user.
559  if ( !$this->isSuperUser() ) {
560  $sql .= ' ROLE' . $conn->addIdentifierQuotes( $this->getVar( '_InstallUser' ) );
561  }
562 
563  $conn->query( $sql, __METHOD__ );
564  } catch ( DBQueryError $e ) {
565  return Status::newFatal( 'config-install-user-create-failed',
566  $this->getVar( 'wgDBuser' ), $e->getMessage() );
567  }
568  }
569 
570  return Status::newGood();
571  }
572 
573  function getLocalSettings() {
574  $port = $this->getVar( 'wgDBport' );
575  $schema = $this->getVar( 'wgDBmwschema' );
576 
577  return "# Postgres specific settings
578 \$wgDBport = \"{$port}\";
579 \$wgDBmwschema = \"{$schema}\";";
580  }
581 
582  public function preUpgrade() {
583  global $wgDBuser, $wgDBpassword;
584 
585  # Normal user and password are selected after this step, so for now
586  # just copy these two
587  $wgDBuser = $this->getVar( '_InstallUser' );
588  $wgDBpassword = $this->getVar( '_InstallPassword' );
589  }
590 
591  public function createTables() {
592  $schema = $this->getVar( 'wgDBmwschema' );
593 
594  $status = $this->getConnection();
595  if ( !$status->isOK() ) {
596  return $status;
597  }
598 
600  $conn = $status->value;
601 
602  if ( $conn->tableExists( 'archive' ) ) {
603  $status->warning( 'config-install-tables-exist' );
604  $this->enableLB();
605 
606  return $status;
607  }
608 
609  $conn->begin( __METHOD__ );
610 
611  if ( !$conn->schemaExists( $schema ) ) {
612  $status->fatal( 'config-install-pg-schema-not-exist' );
613 
614  return $status;
615  }
616  $error = $conn->sourceFile( $this->getSchemaPath( $conn ) );
617  if ( $error !== true ) {
618  $conn->reportQueryError( $error, 0, '', __METHOD__ );
619  $conn->rollback( __METHOD__ );
620  $status->fatal( 'config-install-tables-failed', $error );
621  } else {
622  $conn->commit( __METHOD__ );
623  }
624  // Resume normal operations
625  if ( $status->isOK() ) {
626  $this->enableLB();
627  }
628 
629  return $status;
630  }
631 
632  public function getGlobalDefaults() {
633  // The default $wgDBmwschema is null, which breaks Postgres and other DBMSes that require
634  // the use of a schema, so we need to set it here
635  return array_merge( parent::getGlobalDefaults(), [
636  'wgDBmwschema' => 'mediawiki',
637  ] );
638  }
639 
640  public function setupPLpgSQL() {
641  // Connect as the install user, since it owns the database and so is
642  // the user that needs to run "CREATE LANGUAGE"
643  $status = $this->getPgConnection( 'create-schema' );
644  if ( !$status->isOK() ) {
645  return $status;
646  }
650  $conn = $status->value;
651 
652  $exists = $conn->selectField( '"pg_catalog"."pg_language"', 1,
653  [ 'lanname' => 'plpgsql' ], __METHOD__ );
654  if ( $exists ) {
655  // Already exists, nothing to do
656  return Status::newGood();
657  }
658 
659  // plpgsql is not installed, but if we have a pg_pltemplate table, we
660  // should be able to create it
661  $exists = $conn->selectField(
662  [ '"pg_catalog"."pg_class"', '"pg_catalog"."pg_namespace"' ],
663  1,
664  [
665  'pg_namespace.oid=relnamespace',
666  'nspname' => 'pg_catalog',
667  'relname' => 'pg_pltemplate',
668  ],
669  __METHOD__ );
670  if ( $exists ) {
671  try {
672  $conn->query( 'CREATE LANGUAGE plpgsql' );
673  } catch ( DBQueryError $e ) {
674  return Status::newFatal( 'config-pg-no-plpgsql', $this->getVar( 'wgDBname' ) );
675  }
676  } else {
677  return Status::newFatal( 'config-pg-no-plpgsql', $this->getVar( 'wgDBname' ) );
678  }
679 
680  return Status::newGood();
681  }
682 }
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
$wgDBpassword
Database user&#39;s password.
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing &#39;/&#39;...
Definition: Html.php:252
openConnectionWithParams( $user, $password, $dbName, $schema)
Open a PG connection with given parameters.
$wgDBuser
Database username.
getTextBox( $var, $label, $attribs=[], $helpData="")
Get a labelled text box to configure a local variable.
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
openConnectionToAnyDB( $user, $password)
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
submitWebUserBox()
Submit the form from getWebUserBox().
openPgConnection( $type)
Get a connection of a specific PostgreSQL-specific type.
isRoleMember( $conn, $targetMember, $group, $maxDepth)
Recursive helper for canCreateObjectsForWebUser().
getSchemaPath( $db)
Return a path to the DBMS-specific schema file, otherwise default to tables.sql.
$res
Definition: database.txt:21
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:316
getWebUserBox( $noCreateMsg=false)
Get a standard web-user fieldset.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
submitInstallUserBox()
Submit a standard install user fieldset.
const DBO_TRX
Definition: defines.php:12
getInstallUserBox()
Get a standard install-user fieldset.
getVar( $var, $default=null)
Get a variable, taking local defaults into account.
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:35
getPgConnection( $type)
Get a special type of connection.
Database $db
The database connection.
setVar( $name, $value)
Convenience alias for $this->parent->setVar()
Class for setting up the MediaWiki database using Postgres.
Base class for DBMS-specific installation helper classes.
canCreateObjectsForWebUser()
Returns true if the install user is able to create objects owned by the web user, false otherwise...
setVarsFromRequest( $varNames)
Convenience function to set variables based on form data.
enableLB()
Set up LBFactory so that wfGetDB() etc.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473