MediaWiki  master
BlockListPagerTest.php
Go to the documentation of this file.
1 <?php
2 
8 
14 
22  public function testFormatValue( $name, $expected = null, $row = null ) {
23  $this->setMwGlobals( [
24  'wgEnablePartialBlocks' => false,
25  ] );
26  // Set the time to now so it does not get off during the test.
27  MWTimestamp::setFakeTime( MWTimestamp::time() );
28 
29  $value = $name === 'ipb_timestamp' ? MWTimestamp::time() : '';
30  $expected = $expected ?? MWTimestamp::getInstance()->format( 'H:i, j F Y' );
31 
32  $row = $row ?: new stdClass;
33  $pager = new BlockListPager( new SpecialPage(), [] );
34  $wrappedPager = TestingAccessWrapper::newFromObject( $pager );
35  $wrappedPager->mCurrentRow = $row;
36 
37  $formatted = $pager->formatValue( $name, $value );
38  $this->assertEquals( $expected, $formatted );
39 
40  // Reset the time.
41  MWTimestamp::setFakeTime( false );
42  }
43 
47  public function formatValueEmptyProvider() {
48  return [
49  [
50  'test',
51  'Unable to format test',
52  ],
53  [
54  'ipb_timestamp',
55  ],
56  [
57  'ipb_expiry',
58  'infinite<br />0 minutes left',
59  ],
60  ];
61  }
62 
66  public function formatValueDefaultProvider() {
67  $row = (object)[
68  'ipb_user' => 0,
69  'ipb_address' => '127.0.0.1',
70  'ipb_by_text' => 'Admin',
71  'ipb_create_account' => 1,
72  'ipb_auto' => 0,
73  'ipb_anon_only' => 0,
74  'ipb_create_account' => 1,
75  'ipb_enable_autoblock' => 1,
76  'ipb_deleted' => 0,
77  'ipb_block_email' => 0,
78  'ipb_allow_usertalk' => 0,
79  'ipb_sitewide' => 1,
80  ];
81 
82  return [
83  [
84  'test',
85  'Unable to format test',
86  $row,
87  ],
88  [
89  'ipb_timestamp',
90  null,
91  $row,
92  ],
93  [
94  'ipb_expiry',
95  'infinite<br />0 minutes left',
96  $row,
97  ],
98  [
99  'ipb_by',
100  $row->ipb_by_text,
101  $row,
102  ],
103  [
104  'ipb_params',
105  '<ul><li>account creation disabled</li><li>cannot edit own talk page</li></ul>',
106  $row,
107  ]
108  ];
109  }
110 
115  public function testFormatValueRestrictions() {
116  $this->setMwGlobals( [
117  'wgArticlePath' => '/wiki/$1',
118  'wgScript' => '/w/index.php',
119  ] );
120 
121  $pager = new BlockListPager( new SpecialPage(), [] );
122 
123  $row = (object)[
124  'ipb_id' => 0,
125  'ipb_user' => 0,
126  'ipb_anon_only' => 0,
127  'ipb_enable_autoblock' => 0,
128  'ipb_create_account' => 0,
129  'ipb_block_email' => 0,
130  'ipb_allow_usertalk' => 1,
131  'ipb_sitewide' => 0,
132  ];
133  $wrappedPager = TestingAccessWrapper::newFromObject( $pager );
134  $wrappedPager->mCurrentRow = $row;
135 
136  $pageName = 'Victor Frankenstein';
137  $page = $this->insertPage( $pageName );
138  $title = $page['title'];
139  $pageId = $page['id'];
140 
141  $restrictions = [
142  ( new PageRestriction( 0, $pageId ) )->setTitle( $title ),
143  new NamespaceRestriction( 0, NS_MAIN ),
144  // Deleted page.
145  new PageRestriction( 0, 999999 ),
146  ];
147 
148  $wrappedPager = TestingAccessWrapper::newFromObject( $pager );
149  $wrappedPager->restrictions = $restrictions;
150 
151  $formatted = $pager->formatValue( 'ipb_params', '' );
152  $this->assertEquals( '<ul><li>'
153  // FIXME: Expectation value should not be dynamic
154  // and must not depend on a localisation message.
155  // TODO: Mock the message or consider using qqx.
156  . wfMessage( 'blocklist-editing' )->text()
157  . '<ul><li>'
158  . wfMessage( 'blocklist-editing-page' )->text()
159  . '<ul><li>'
160  . '<a href="/wiki/Victor_Frankenstein" title="'
161  . $pageName
162  . '">'
163  . $pageName
164  . '</a></li></ul></li><li>'
165  . wfMessage( 'blocklist-editing-ns' )->text()
166  . '<ul><li>'
167  . '<a href="/w/index.php?title=Special:AllPages&amp;namespace=0" title="'
168  . 'Special:AllPages'
169  . '">'
170  . wfMessage( 'blanknamespace' )->text()
171  . '</a></li></ul></li></ul></li></ul>',
172  $formatted
173  );
174  }
175 
179  public function testPreprocessResults() {
180  // Test the Link Cache.
181  $linkCache = MediaWikiServices::getInstance()->getLinkCache();
182  $wrappedlinkCache = TestingAccessWrapper::newFromObject( $linkCache );
183 
184  $links = [
185  'User:127.0.0.1',
186  'User_talk:127.0.0.1',
187  'User:Admin',
188  'User_talk:Admin',
189  ];
190 
191  foreach ( $links as $link ) {
192  $this->assertNull( $wrappedlinkCache->badLinks->get( $link ) );
193  }
194 
195  $row = (object)[
196  'ipb_address' => '127.0.0.1',
197  'by_user_name' => 'Admin',
198  'ipb_sitewide' => 1,
199  'ipb_timestamp' => $this->db->timestamp( wfTimestamp( TS_MW ) ),
200  ];
201  $pager = new BlockListPager( new SpecialPage(), [] );
202  $pager->preprocessResults( [ $row ] );
203 
204  foreach ( $links as $link ) {
205  $this->assertSame( 1, $wrappedlinkCache->badLinks->get( $link ) );
206  }
207 
208  // Test Sitewide Blocks.
209  $row = (object)[
210  'ipb_address' => '127.0.0.1',
211  'by_user_name' => 'Admin',
212  'ipb_sitewide' => 1,
213  ];
214  $pager = new BlockListPager( new SpecialPage(), [] );
215  $pager->preprocessResults( [ $row ] );
216 
217  $this->assertObjectNotHasAttribute( 'ipb_restrictions', $row );
218 
219  $pageName = 'Victor Frankenstein';
220  $page = $this->getExistingTestPage( 'Victor Frankenstein' );
221  $title = $page->getTitle();
222 
223  $target = '127.0.0.1';
224 
225  // Test Partial Blocks Blocks.
226  $block = new DatabaseBlock( [
227  'address' => $target,
228  'by' => $this->getTestSysop()->getUser()->getId(),
229  'reason' => 'Parce que',
230  'expiry' => $this->db->getInfinity(),
231  'sitewide' => false,
232  ] );
233  $block->setRestrictions( [
234  new PageRestriction( 0, $page->getId() ),
235  ] );
236  $block->insert();
237 
238  $result = $this->db->select( 'ipblocks', [ '*' ], [ 'ipb_id' => $block->getId() ] );
239 
240  $pager = new BlockListPager( new SpecialPage(), [] );
241  $pager->preprocessResults( $result );
242 
243  $wrappedPager = TestingAccessWrapper::newFromObject( $pager );
244 
245  $restrictions = $wrappedPager->restrictions;
246  $this->assertInternalType( 'array', $restrictions );
247 
248  $restriction = $restrictions[0];
249  $this->assertEquals( $page->getId(), $restriction->getValue() );
250  $this->assertEquals( $page->getId(), $restriction->getTitle()->getArticleID() );
251  $this->assertEquals( $title->getDBKey(), $restriction->getTitle()->getDBKey() );
252  $this->assertEquals( $title->getNamespace(), $restriction->getTitle()->getNamespace() );
253 
254  // Delete the block and the restrictions.
255  $block->delete();
256  }
257 }
const NS_MAIN
Definition: Defines.php:60
formatValueDefaultProvider()
Test the default row values.
testPreprocessResults()
::preprocessResults
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
testFormatValueRestrictions()
::formatValue ::getRestrictionListHTML
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
$value
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 MediaWikiServices
Definition: injection.txt:23
formatValueEmptyProvider()
Test empty values.
A DatabaseBlock (unlike a SystemBlock) is stored in the database, may give rise to autoblocks and may...
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
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3051
static getInstance( $ts=false)
Get a timestamp instance in GMT.
Definition: MWTimestamp.php:39
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static getTestSysop()
Convenience method for getting an immutable admin test user.
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
insertPage( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
Insert a new page.
setRestrictions(array $restrictions)
Set Restrictions.
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
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
Database BlockListPager.
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown...
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
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
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getExistingTestPage( $title=null)
Returns a WikiPage representing an existing page.
testFormatValue( $name, $expected=null, $row=null)
::formatValue formatValueEmptyProvider formatValueDefaultProvider