MediaWiki  master
OracleInstaller.php
Go to the documentation of this file.
1 <?php
26 
34 
35  protected $globalNames = [
36  'wgDBserver',
37  'wgDBname',
38  'wgDBuser',
39  'wgDBpassword',
40  'wgDBprefix',
41  ];
42 
43  protected $internalDefaults = [
44  '_OracleDefTS' => 'USERS',
45  '_OracleTempTS' => 'TEMP',
46  '_InstallUser' => 'SYSTEM',
47  ];
48 
49  public static $minimumVersion = '9.0.1'; // 9iR1
50  protected static $notMinimumVerisonMessage = 'config-oracle-old';
51 
52  protected $connError = null;
53 
54  public function getName() {
55  return 'oracle';
56  }
57 
58  public function isCompiled() {
59  return self::checkExtension( 'oci8' );
60  }
61 
62  public function getConnectForm() {
63  if ( $this->getVar( 'wgDBserver' ) == 'localhost' ) {
64  $this->parent->setVar( 'wgDBserver', '' );
65  }
66 
67  return $this->getTextBox(
68  'wgDBserver',
69  'config-db-host-oracle',
70  [],
71  $this->parent->getHelpBox( 'config-db-host-oracle-help' )
72  ) .
73  Html::openElement( 'fieldset' ) .
74  Html::element( 'legend', [], wfMessage( 'config-db-wiki-settings' )->text() ) .
75  $this->getTextBox( 'wgDBprefix', 'config-db-prefix' ) .
76  $this->getTextBox( '_OracleDefTS', 'config-oracle-def-ts' ) .
77  $this->getTextBox(
78  '_OracleTempTS',
79  'config-oracle-temp-ts',
80  [],
81  $this->parent->getHelpBox( 'config-db-oracle-help' )
82  ) .
83  Html::closeElement( 'fieldset' ) .
84  $this->parent->getWarningBox( wfMessage( 'config-db-account-oracle-warn' )->text() ) .
85  $this->getInstallUserBox() .
86  $this->getWebUserBox();
87  }
88 
89  public function submitInstallUserBox() {
90  parent::submitInstallUserBox();
91  $this->parent->setVar( '_InstallDBname', $this->getVar( '_InstallUser' ) );
92 
93  return Status::newGood();
94  }
95 
96  public function submitConnectForm() {
97  // Get variables from the request
98  $newValues = $this->setVarsFromRequest( [
99  'wgDBserver',
100  'wgDBprefix',
101  'wgDBuser',
102  'wgDBpassword'
103  ] );
104  $this->parent->setVar( 'wgDBname', $this->getVar( 'wgDBuser' ) );
105 
106  // Validate them
108  if ( !strlen( $newValues['wgDBserver'] ) ) {
109  $status->fatal( 'config-missing-db-server-oracle' );
110  } elseif ( !self::checkConnectStringFormat( $newValues['wgDBserver'] ) ) {
111  $status->fatal( 'config-invalid-db-server-oracle', $newValues['wgDBserver'] );
112  }
113  if ( !preg_match( '/^[a-zA-Z0-9_]*$/', $newValues['wgDBprefix'] ) ) {
114  $status->fatal( 'config-invalid-schema', $newValues['wgDBprefix'] );
115  }
116  if ( !$status->isOK() ) {
117  return $status;
118  }
119 
120  // Submit user box
121  $status = $this->submitInstallUserBox();
122  if ( !$status->isOK() ) {
123  return $status;
124  }
125 
126  // Try to connect trough multiple scenarios
127  // Scenario 1: Install with a manually created account
128  $status = $this->getConnection();
129  if ( !$status->isOK() ) {
130  if ( $this->connError == 28009 ) {
131  // _InstallUser seems to be a SYSDBA
132  // Scenario 2: Create user with SYSDBA and install with new user
133  $status = $this->submitWebUserBox();
134  if ( !$status->isOK() ) {
135  return $status;
136  }
137  $status = $this->openSYSDBAConnection();
138  if ( !$status->isOK() ) {
139  return $status;
140  }
141  if ( !$this->getVar( '_CreateDBAccount' ) ) {
142  $status->fatal( 'config-db-sys-create-oracle' );
143  }
144  } else {
145  return $status;
146  }
147  } else {
148  // check for web user credentials
149  // Scenario 3: Install with a priviliged user but use a restricted user
150  $statusIS3 = $this->submitWebUserBox();
151  if ( !$statusIS3->isOK() ) {
152  return $statusIS3;
153  }
154  }
155 
159  $conn = $status->value;
160 
161  // Check version
162  $status->merge( static::meetsMinimumRequirement( $conn->getServerVersion() ) );
163 
164  return $status;
165  }
166 
167  public function openConnection() {
168  return $this->doOpenConnection();
169  }
170 
171  public function openSYSDBAConnection() {
173  }
174 
179  private function doOpenConnection( $flags = 0 ) {
181  try {
182  $db = Database::factory(
183  'oracle',
184  [
185  'host' => $this->getVar( 'wgDBserver' ),
186  'user' => $this->getVar( '_InstallUser' ),
187  'password' => $this->getVar( '_InstallPassword' ),
188  'dbname' => $this->getVar( '_InstallDBname' ),
189  'tablePrefix' => $this->getVar( 'wgDBprefix' ),
190  'flags' => $flags
191  ]
192  );
193  $status->value = $db;
194  } catch ( DBConnectionError $e ) {
195  $this->connError = $e->db->lastErrno();
196  $status->fatal( 'config-connection-error', $e->getMessage() );
197  }
198 
199  return $status;
200  }
201 
202  public function needsUpgrade() {
203  $tempDBname = $this->getVar( 'wgDBname' );
204  $this->parent->setVar( 'wgDBname', $this->getVar( 'wgDBuser' ) );
205  $retVal = parent::needsUpgrade();
206  $this->parent->setVar( 'wgDBname', $tempDBname );
207 
208  return $retVal;
209  }
210 
211  public function preInstall() {
212  # Add our user callback to installSteps, right before the tables are created.
213  $callback = [
214  'name' => 'user',
215  'callback' => [ $this, 'setupUser' ]
216  ];
217  $this->parent->addInstallStep( $callback, 'database' );
218  }
219 
220  public function setupDatabase() {
222 
223  return $status;
224  }
225 
226  public function setupUser() {
227  global $IP;
228 
229  if ( !$this->getVar( '_CreateDBAccount' ) ) {
230  return Status::newGood();
231  }
232 
233  // normaly only SYSDBA users can create accounts
234  $status = $this->openSYSDBAConnection();
235  if ( !$status->isOK() ) {
236  if ( $this->connError == 1031 ) {
237  // insufficient privileges (looks like a normal user)
238  $status = $this->openConnection();
239  if ( !$status->isOK() ) {
240  return $status;
241  }
242  } else {
243  return $status;
244  }
245  }
246 
247  $this->db = $status->value;
248  $this->setupSchemaVars();
249 
250  if ( !$this->db->selectDB( $this->getVar( 'wgDBuser' ) ) ) {
251  $this->db->setFlag( DBO_DDLMODE );
252  $error = $this->db->sourceFile( "$IP/maintenance/oracle/user.sql" );
253  if ( $error !== true || !$this->db->selectDB( $this->getVar( 'wgDBuser' ) ) ) {
254  $status->fatal( 'config-install-user-failed', $this->getVar( 'wgDBuser' ), $error );
255  }
256  } elseif ( $this->db->getFlag( DBO_SYSDBA ) ) {
257  $status->fatal( 'config-db-sys-user-exists-oracle', $this->getVar( 'wgDBuser' ) );
258  }
259 
260  if ( $status->isOK() ) {
261  // user created or already existing, switching back to a normal connection
262  // as the new user has all needed privileges to setup the rest of the schema
263  // i will be using that user as _InstallUser from this point on
264  $this->db->close();
265  $this->db = false;
266  $this->parent->setVar( '_InstallUser', $this->getVar( 'wgDBuser' ) );
267  $this->parent->setVar( '_InstallPassword', $this->getVar( 'wgDBpassword' ) );
268  $this->parent->setVar( '_InstallDBname', $this->getVar( 'wgDBuser' ) );
269  $status = $this->getConnection();
270  }
271 
272  return $status;
273  }
274 
279  public function createTables() {
280  $this->setupSchemaVars();
281  $this->db->setFlag( DBO_DDLMODE );
282  $this->parent->setVar( 'wgDBname', $this->getVar( 'wgDBuser' ) );
283  $status = parent::createTables();
284  $this->db->clearFlag( DBO_DDLMODE );
285 
286  $this->db->query( 'BEGIN fill_wiki_info; END;' );
287 
288  return $status;
289  }
290 
291  public function getSchemaVars() {
292  $varNames = [
293  # These variables are used by maintenance/oracle/user.sql
294  '_OracleDefTS',
295  '_OracleTempTS',
296  'wgDBuser',
297  'wgDBpassword',
298 
299  # These are used by tables.sql
300  'wgDBprefix',
301  ];
302  $vars = [];
303  foreach ( $varNames as $name ) {
304  $vars[$name] = $this->getVar( $name );
305  }
306 
307  return $vars;
308  }
309 
310  public function getLocalSettings() {
311  $prefix = $this->getVar( 'wgDBprefix' );
312 
313  return "# Oracle specific settings
314 \$wgDBprefix = \"{$prefix}\";
315 ";
316  }
317 
332  public static function checkConnectStringFormat( $connect_string ) {
333  // phpcs:disable Generic.Files.LineLength
334  // @todo Very long regular expression. Make more readable?
335  $isValid = preg_match( '/^[[:alpha:]][\w\-]*(?:\.[[:alpha:]][\w\-]*){0,2}$/', $connect_string ); // TNS name
336  $isValid |= preg_match( '/^(?:\/\/)?[\w\-\.]+(?::[\d]+)?(?:\/(?:[\w\-\.]+(?::(pooled|dedicated|shared))?)?(?:\/[\w\-\.]+)?)?$/', $connect_string ); // EZConnect
337  // phpcs:enable
338  return (bool)$isValid;
339  }
340 }
createTables()
Overload: after this action field info table has to be rebuilt.
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
$IP
Definition: WebStart.php:41
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Class for setting up the MediaWiki database using Oracle.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
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
doOpenConnection( $flags=0)
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
const DBO_DDLMODE
Definition: defines.php:16
getConnection()
Connect to the database using the administrative user/password currently defined in the session...
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().
setupSchemaVars()
Set appropriate schema variables in the current database connection.
const DBO_SYSDBA
Definition: defines.php:15
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:316
static $notMinimumVerisonMessage
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
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
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
Database $db
The database connection.
static checkConnectStringFormat( $connect_string)
Function checks the format of Oracle connect string The actual validity of the string is checked by a...
Base class for DBMS-specific installation helper classes.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
setVarsFromRequest( $varNames)
Convenience function to set variables based on form data.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
Definition: hooks.txt:2217