MediaWiki  1.29.2
WebInstallerName.php
Go to the documentation of this file.
1 <?php
22 class WebInstallerName extends WebInstallerPage {
23 
27  public function execute() {
28  $r = $this->parent->request;
29  if ( $r->wasPosted() ) {
30  if ( $this->submit() ) {
31  return 'continue';
32  }
33  }
34 
35  $this->startForm();
36 
37  // Encourage people to not name their site 'MediaWiki' by blanking the
38  // field. I think that was the intent with the original $GLOBALS['wgSitename']
39  // but these two always were the same so had the effect of making the
40  // installer forget $wgSitename when navigating back to this page.
41  if ( $this->getVar( 'wgSitename' ) == 'MediaWiki' ) {
42  $this->setVar( 'wgSitename', '' );
43  }
44 
45  // Set wgMetaNamespace to something valid before we show the form.
46  // $wgMetaNamespace defaults to $wgSiteName which is 'MediaWiki'
47  $metaNS = $this->getVar( 'wgMetaNamespace' );
48  $this->setVar(
49  'wgMetaNamespace',
50  wfMessage( 'config-ns-other-default' )->inContentLanguage()->text()
51  );
52 
53  $pingbackInfo = ( new Pingback() )->getSystemInfo();
54  // Database isn't available in config yet, so take it
55  // from the installer
56  $pingbackInfo['database'] = $this->getVar( 'wgDBtype' );
57 
58  $this->addHTML(
59  $this->parent->getTextBox( [
60  'var' => 'wgSitename',
61  'label' => 'config-site-name',
62  'help' => $this->parent->getHelpBox( 'config-site-name-help' )
63  ] ) .
64  // getRadioSet() builds a set of labeled radio buttons.
65  // For grep: The following messages are used as the item labels:
66  // config-ns-site-name, config-ns-generic, config-ns-other
67  $this->parent->getRadioSet( [
68  'var' => '_NamespaceType',
69  'label' => 'config-project-namespace',
70  'itemLabelPrefix' => 'config-ns-',
71  'values' => [ 'site-name', 'generic', 'other' ],
72  'commonAttribs' => [ 'class' => 'enableForOther',
73  'rel' => 'config_wgMetaNamespace' ],
74  'help' => $this->parent->getHelpBox( 'config-project-namespace-help' )
75  ] ) .
76  $this->parent->getTextBox( [
77  'var' => 'wgMetaNamespace',
78  'label' => '', // @todo Needs a label?
79  'attribs' => [ 'readonly' => 'readonly', 'class' => 'enabledByOther' ]
80  ] ) .
81  $this->getFieldsetStart( 'config-admin-box' ) .
82  $this->parent->getTextBox( [
83  'var' => '_AdminName',
84  'label' => 'config-admin-name',
85  'help' => $this->parent->getHelpBox( 'config-admin-help' )
86  ] ) .
87  $this->parent->getPasswordBox( [
88  'var' => '_AdminPassword',
89  'label' => 'config-admin-password',
90  ] ) .
91  $this->parent->getPasswordBox( [
92  'var' => '_AdminPasswordConfirm',
93  'label' => 'config-admin-password-confirm'
94  ] ) .
95  $this->parent->getTextBox( [
96  'var' => '_AdminEmail',
97  'attribs' => [
98  'dir' => 'ltr',
99  ],
100  'label' => 'config-admin-email',
101  'help' => $this->parent->getHelpBox( 'config-admin-email-help' )
102  ] ) .
103  $this->parent->getCheckBox( [
104  'var' => '_Subscribe',
105  'label' => 'config-subscribe',
106  'help' => $this->parent->getHelpBox( 'config-subscribe-help' )
107  ] ) .
108  $this->parent->getCheckBox( [
109  'var' => 'wgPingback',
110  'label' => 'config-pingback',
111  'help' => $this->parent->getHelpBox(
112  'config-pingback-help',
113  FormatJson::encode( $pingbackInfo, true )
114  ),
115  'value' => true,
116  ] ) .
117  $this->getFieldsetEnd() .
118  $this->parent->getInfoBox( wfMessage( 'config-almost-done' )->text() ) .
119  // getRadioSet() builds a set of labeled radio buttons.
120  // For grep: The following messages are used as the item labels:
121  // config-optional-continue, config-optional-skip
122  $this->parent->getRadioSet( [
123  'var' => '_SkipOptional',
124  'itemLabelPrefix' => 'config-optional-',
125  'values' => [ 'continue', 'skip' ]
126  ] )
127  );
128 
129  // Restore the default value
130  $this->setVar( 'wgMetaNamespace', $metaNS );
131 
132  $this->endForm();
133 
134  return 'output';
135  }
136 
140  public function submit() {
141  global $wgPasswordPolicy;
142 
143  $retVal = true;
144  $this->parent->setVarsFromRequest( [ 'wgSitename', '_NamespaceType',
145  '_AdminName', '_AdminPassword', '_AdminPasswordConfirm', '_AdminEmail',
146  '_Subscribe', '_SkipOptional', 'wgMetaNamespace', 'wgPingback' ] );
147 
148  // Validate site name
149  if ( strval( $this->getVar( 'wgSitename' ) ) === '' ) {
150  $this->parent->showError( 'config-site-name-blank' );
151  $retVal = false;
152  }
153 
154  // Fetch namespace
155  $nsType = $this->getVar( '_NamespaceType' );
156  if ( $nsType == 'site-name' ) {
157  $name = $this->getVar( 'wgSitename' );
158  // Sanitize for namespace
159  // This algorithm should match the JS one in WebInstallerOutput.php
160  $name = preg_replace( '/[\[\]\{\}|#<>%+? ]/', '_', $name );
161  $name = str_replace( '&', '&amp;', $name );
162  $name = preg_replace( '/__+/', '_', $name );
163  $name = ucfirst( trim( $name, '_' ) );
164  } elseif ( $nsType == 'generic' ) {
165  $name = wfMessage( 'config-ns-generic' )->text();
166  } else { // other
167  $name = $this->getVar( 'wgMetaNamespace' );
168  }
169 
170  // Validate namespace
171  if ( strpos( $name, ':' ) !== false ) {
172  $good = false;
173  } else {
174  // Title-style validation
176  if ( !$title ) {
177  $good = $nsType == 'site-name';
178  } else {
179  $name = $title->getDBkey();
180  $good = true;
181  }
182  }
183  if ( !$good ) {
184  $this->parent->showError( 'config-ns-invalid', $name );
185  $retVal = false;
186  }
187 
188  // Make sure it won't conflict with any existing namespaces
190  $nsIndex = $wgContLang->getNsIndex( $name );
191  if ( $nsIndex !== false && $nsIndex !== NS_PROJECT ) {
192  $this->parent->showError( 'config-ns-conflict', $name );
193  $retVal = false;
194  }
195 
196  $this->setVar( 'wgMetaNamespace', $name );
197 
198  // Validate username for creation
199  $name = $this->getVar( '_AdminName' );
200  if ( strval( $name ) === '' ) {
201  $this->parent->showError( 'config-admin-name-blank' );
202  $cname = $name;
203  $retVal = false;
204  } else {
205  $cname = User::getCanonicalName( $name, 'creatable' );
206  if ( $cname === false ) {
207  $this->parent->showError( 'config-admin-name-invalid', $name );
208  $retVal = false;
209  } else {
210  $this->setVar( '_AdminName', $cname );
211  }
212  }
213 
214  // Validate password
215  $msg = false;
216  $pwd = $this->getVar( '_AdminPassword' );
217  $user = User::newFromName( $cname );
218  if ( $user ) {
219  $upp = new UserPasswordPolicy(
220  $wgPasswordPolicy['policies'],
221  $wgPasswordPolicy['checks']
222  );
223  $status = $upp->checkUserPasswordForGroups(
224  $user,
225  $pwd,
226  [ 'bureaucrat', 'sysop' ] // per Installer::createSysop()
227  );
228  $valid = $status->isGood() ? true : $status->getMessage();
229  } else {
230  $valid = 'config-admin-name-invalid';
231  }
232  if ( strval( $pwd ) === '' ) {
233  // Provide a more specific and helpful message if password field is left blank
234  $msg = 'config-admin-password-blank';
235  } elseif ( $pwd !== $this->getVar( '_AdminPasswordConfirm' ) ) {
236  $msg = 'config-admin-password-mismatch';
237  } elseif ( $valid !== true ) {
238  $msg = $valid;
239  }
240  if ( $msg !== false ) {
241  call_user_func( [ $this->parent, 'showError' ], $msg );
242  $this->setVar( '_AdminPassword', '' );
243  $this->setVar( '_AdminPasswordConfirm', '' );
244  $retVal = false;
245  }
246 
247  // Validate e-mail if provided
248  $email = $this->getVar( '_AdminEmail' );
249  if ( $email && !Sanitizer::validateEmail( $email ) ) {
250  $this->parent->showError( 'config-admin-error-bademail' );
251  $retVal = false;
252  }
253  // If they asked to subscribe to mediawiki-announce but didn't give
254  // an e-mail, show an error. T31332
255  if ( !$email && $this->getVar( '_Subscribe' ) ) {
256  $this->parent->showError( 'config-subscribe-noemail' );
257  $retVal = false;
258  }
259 
260  return $retVal;
261  }
262 
263 }
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:556
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
php
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
FormatJson\encode
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
NS_PROJECT
const NS_PROJECT
Definition: Defines.php:66
Pingback
Send information about this MediaWiki instance to MediaWiki.org.
Definition: Pingback.php:31
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
UserPasswordPolicy
Check if a user's password complies with any password policies that apply to that user,...
Definition: UserPasswordPolicy.php:28
WebInstallerName
Definition: WebInstallerName.php:22
WebInstallerName\submit
submit()
Definition: WebInstallerName.php:140
User\getCanonicalName
static getCanonicalName( $name, $validate='valid')
Given unvalidated user input, return a canonical username, or false if the username is invalid.
Definition: User.php:1076
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1956
wfMessage
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 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
WebInstallerName\execute
execute()
Definition: WebInstallerName.php:27
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:56