jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/399705 )
Change subject: Move TitleBlacklistEntry to own file
......................................................................
Move TitleBlacklistEntry to own file
Makes MediaWiki.Files.OneClassPerFile.MultipleFound pass
Change-Id: I75e2a3a959b7d7bbad2dca68c9c62ea10e948fb4
---
M .phpcs.xml
M TitleBlacklist.list.php
A TitleBlacklistEntry.php
M extension.json
4 files changed, 294 insertions(+), 283 deletions(-)
Approvals:
Addshore: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.phpcs.xml b/.phpcs.xml
index 733a51b..9932fb4 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -4,7 +4,6 @@
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
- <exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
<exclude name="Squiz.Classes.ValidClassName.NotCamelCaps"/>
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment"/>
</rule>
diff --git a/TitleBlacklist.list.php b/TitleBlacklist.list.php
index 23674b8..ee902c5 100644
--- a/TitleBlacklist.list.php
+++ b/TitleBlacklist.list.php
@@ -340,284 +340,3 @@
( $action == 'new-account' && $user->isAllowed(
'tboverride-account' ) );
}
}
-
-/**
- * Represents a title blacklist entry
- */
-class TitleBlacklistEntry {
- /**
- * Raw line
- * @var string
- */
- private $mRaw;
-
- /**
- * Regular expression to match
- * @var string
- */
- private $mRegex;
-
- /**
- * Parameters for this entry
- * @var array
- */
- private $mParams;
-
- /**
- * Entry format version
- * @var string
- */
- private $mFormatVersion;
-
- /**
- * Source of this entry
- * @var string
- */
- private $mSource;
-
- /**
- * Construct a new TitleBlacklistEntry.
- *
- * @param string $regex Regular expression to match
- * @param array $params Parameters for this entry
- * @param string $raw Raw contents of this line
- */
- private function __construct( $regex, $params, $raw, $source ) {
- $this->mRaw = $raw;
- $this->mRegex = $regex;
- $this->mParams = $params;
- $this->mFormatVersion = TitleBlacklist::VERSION;
- $this->mSource = $source;
- }
-
- /**
- * Returns whether this entry is capable of filtering new accounts.
- */
- private function filtersNewAccounts() {
- global $wgTitleBlacklistUsernameSources;
-
- if ( $wgTitleBlacklistUsernameSources === '*' ) {
- return true;
- }
-
- if ( !$wgTitleBlacklistUsernameSources ) {
- return false;
- }
-
- if ( !is_array( $wgTitleBlacklistUsernameSources ) ) {
- throw new Exception(
- '$wgTitleBlacklistUsernameSources must be "*",
false or an array' );
- }
-
- return in_array( $this->mSource,
$wgTitleBlacklistUsernameSources, true );
- }
-
- /**
- * Check whether a user can perform the specified action on the
specified Title
- *
- * @param string $title Title to check
- * @param string $action Action to check
- * @return bool TRUE if the the regex matches the title, and is not
overridden
- * else false if it doesn't match (or was overridden)
- */
- public function matches( $title, $action ) {
- if ( $title == '' ) {
- return false;
- }
-
- if ( $action === 'new-account' && !$this->filtersNewAccounts()
) {
- return false;
- }
-
- if ( isset( $this->mParams['antispoof'] )
- && is_callable( 'AntiSpoof::checkUnicodeString' )
- ) {
- if ( $action === 'edit' ) {
- // Use process cache for frequently edited pages
- $cache = ObjectCache::getMainWANInstance();
- list( $ok, $norm ) = $cache->getWithSetCallback(
- $cache->makeKey( 'titleblacklist',
'normalized-unicode', md5( $title ) ),
- $cache::TTL_MONTH,
- function () use ( $title ) {
- return
AntiSpoof::checkUnicodeString( $title );
- },
- [ 'pcTTL' => $cache::TTL_PROC_LONG ]
- );
- } else {
- list( $ok, $norm ) =
AntiSpoof::checkUnicodeString( $title );
- }
-
- if ( $ok === "OK" ) {
- list( $ver, $title ) = explode( ':', $norm, 2 );
- } else {
- wfDebugLog( 'TitleBlacklist', 'AntiSpoof could
not normalize "' . $title . '".' );
- }
- }
-
- wfSuppressWarnings();
- $match = preg_match(
- "/^(?:{$this->mRegex})$/us" . ( isset(
$this->mParams['casesensitive'] ) ? '' : 'i' ),
- $title
- );
- wfRestoreWarnings();
-
- if ( $match ) {
- if ( isset( $this->mParams['moveonly'] ) && $action !=
'move' ) {
- return false;
- }
- if ( isset( $this->mParams['newaccountonly'] ) &&
$action != 'new-account' ) {
- return false;
- }
- if ( !isset( $this->mParams['noedit'] ) && $action ==
'edit' ) {
- return false;
- }
- if ( isset( $this->mParams['reupload'] ) && $action ==
'upload' ) {
- // Special:Upload also checks 'create'
permissions when not reuploading
- return false;
- }
- return true;
- }
-
- return false;
- }
-
- /**
- * Create a new TitleBlacklistEntry from a line of text
- *
- * @param string $line String containing a line of blacklist text
- * @param string $source
- * @return TitleBlacklistEntry|null
- */
- public static function newFromString( $line, $source ) {
- $raw = $line; // Keep line for raw data
- $options = [];
- // Strip comments
- $line = preg_replace( "/^\\s*([^#]*)\\s*((.*)?)$/", "\\1",
$line );
- $line = trim( $line );
- // A blank string causes problems later on
- if ( $line === '' ) {
- return null;
- }
- // Parse the rest of message
- $pockets = [];
- if ( !preg_match( '/^(.*?)(\s*<([^<>]*)>)?$/', $line, $pockets
) ) {
- return null;
- }
- $regex = trim( $pockets[1] );
- $regex = str_replace( '_', ' ', $regex ); // We'll be matching
against text form
- $opts_str = isset( $pockets[3] ) ? trim( $pockets[3] ) : '';
- // Parse opts
- $opts = preg_split( '/\s*\|\s*/', $opts_str );
- foreach ( $opts as $opt ) {
- $opt2 = strtolower( $opt );
- if ( $opt2 == 'autoconfirmed' ) {
- $options['autoconfirmed'] = true;
- }
- if ( $opt2 == 'moveonly' ) {
- $options['moveonly'] = true;
- }
- if ( $opt2 == 'newaccountonly' ) {
- $options['newaccountonly'] = true;
- }
- if ( $opt2 == 'noedit' ) {
- $options['noedit'] = true;
- }
- if ( $opt2 == 'casesensitive' ) {
- $options['casesensitive'] = true;
- }
- if ( $opt2 == 'reupload' ) {
- $options['reupload'] = true;
- }
- if ( preg_match( '/errmsg\s*=\s*(.+)/i', $opt, $matches
) ) {
- $options['errmsg'] = $matches[1];
- }
- if ( $opt2 == 'antispoof' ) {
- $options['antispoof'] = true;
- }
- }
- // Process magic words
- preg_match_all( '/{{\s*([a-z]+)\s*:\s*(.+?)\s*}}/', $regex,
$magicwords, PREG_SET_ORDER );
- foreach ( $magicwords as $mword ) {
- global $wgParser; // Functions we're calling
don't need, nevertheless let's use it
- switch ( strtolower( $mword[1] ) ) {
- case 'ns':
- $cpf_result = CoreParserFunctions::ns(
$wgParser, $mword[2] );
- if ( is_string( $cpf_result ) ) {
- // All result will have the
same value, so we can just use str_seplace()
- $regex = str_replace(
$mword[0], $cpf_result, $regex );
- }
- break;
- case 'int':
- $cpf_result = wfMessage( $mword[2]
)->inContentLanguage()->text();
- if ( is_string( $cpf_result ) ) {
- $regex = str_replace(
$mword[0], $cpf_result, $regex );
- }
- }
- }
- // Return result
- if ( $regex ) {
- return new TitleBlacklistEntry( $regex, $options, $raw,
$source );
- } else {
- return null;
- }
- }
-
- /**
- * @return string This entry's regular expression
- */
- public function getRegex() {
- return $this->mRegex;
- }
-
- /**
- * @return string This entry's raw line
- */
- public function getRaw() {
- return $this->mRaw;
- }
-
- /**
- * @return array This entry's parameters
- */
- public function getParams() {
- return $this->mParams;
- }
-
- /**
- * @return string Custom message for this entry
- */
- public function getCustomMessage() {
- return isset( $this->mParams['errmsg'] ) ?
$this->mParams['errmsg'] : null;
- }
-
- /**
- * @return string The format version
- */
- public function getFormatVersion() {
- return $this->mFormatVersion;
- }
-
- /**
- * Set the format version
- *
- * @param string $v New version to set
- */
- public function setFormatVersion( $v ) {
- $this->mFormatVersion = $v;
- }
-
- /**
- * Return the error message name for the blacklist entry.
- *
- * @param string $operation Operation name (as in
titleblacklist-forbidden message name)
- *
- * @return string The error message name
- */
- public function getErrorMessage( $operation ) {
- $message = $this->getCustomMessage();
- // For grep:
- // titleblacklist-forbidden-edit, titleblacklist-forbidden-move,
- // titleblacklist-forbidden-upload,
titleblacklist-forbidden-new-account
- return $message ? $message :
"titleblacklist-forbidden-{$operation}";
- }
-}
diff --git a/TitleBlacklistEntry.php b/TitleBlacklistEntry.php
new file mode 100644
index 0000000..ddc296a
--- /dev/null
+++ b/TitleBlacklistEntry.php
@@ -0,0 +1,293 @@
+<?php
+/**
+ * Title Blacklist class
+ * @author Victor Vasiliev
+ * @copyright © 2007-2010 Victor Vasiliev et al
+ * @license GNU General Public License 2.0 or later
+ * @file
+ */
+
+/**
+ * @ingroup Extensions
+ */
+
+/**
+ * Represents a title blacklist entry
+ */
+class TitleBlacklistEntry {
+ /**
+ * Raw line
+ * @var string
+ */
+ private $mRaw;
+
+ /**
+ * Regular expression to match
+ * @var string
+ */
+ private $mRegex;
+
+ /**
+ * Parameters for this entry
+ * @var array
+ */
+ private $mParams;
+
+ /**
+ * Entry format version
+ * @var string
+ */
+ private $mFormatVersion;
+
+ /**
+ * Source of this entry
+ * @var string
+ */
+ private $mSource;
+
+ /**
+ * Construct a new TitleBlacklistEntry.
+ *
+ * @param string $regex Regular expression to match
+ * @param array $params Parameters for this entry
+ * @param string $raw Raw contents of this line
+ */
+ private function __construct( $regex, $params, $raw, $source ) {
+ $this->mRaw = $raw;
+ $this->mRegex = $regex;
+ $this->mParams = $params;
+ $this->mFormatVersion = TitleBlacklist::VERSION;
+ $this->mSource = $source;
+ }
+
+ /**
+ * Returns whether this entry is capable of filtering new accounts.
+ */
+ private function filtersNewAccounts() {
+ global $wgTitleBlacklistUsernameSources;
+
+ if ( $wgTitleBlacklistUsernameSources === '*' ) {
+ return true;
+ }
+
+ if ( !$wgTitleBlacklistUsernameSources ) {
+ return false;
+ }
+
+ if ( !is_array( $wgTitleBlacklistUsernameSources ) ) {
+ throw new Exception(
+ '$wgTitleBlacklistUsernameSources must be "*",
false or an array' );
+ }
+
+ return in_array( $this->mSource,
$wgTitleBlacklistUsernameSources, true );
+ }
+
+ /**
+ * Check whether a user can perform the specified action on the
specified Title
+ *
+ * @param string $title Title to check
+ * @param string $action Action to check
+ * @return bool TRUE if the the regex matches the title, and is not
overridden
+ * else false if it doesn't match (or was overridden)
+ */
+ public function matches( $title, $action ) {
+ if ( $title == '' ) {
+ return false;
+ }
+
+ if ( $action === 'new-account' && !$this->filtersNewAccounts()
) {
+ return false;
+ }
+
+ if ( isset( $this->mParams['antispoof'] )
+ && is_callable( 'AntiSpoof::checkUnicodeString' )
+ ) {
+ if ( $action === 'edit' ) {
+ // Use process cache for frequently edited pages
+ $cache = ObjectCache::getMainWANInstance();
+ list( $ok, $norm ) = $cache->getWithSetCallback(
+ $cache->makeKey( 'titleblacklist',
'normalized-unicode', md5( $title ) ),
+ $cache::TTL_MONTH,
+ function () use ( $title ) {
+ return
AntiSpoof::checkUnicodeString( $title );
+ },
+ [ 'pcTTL' => $cache::TTL_PROC_LONG ]
+ );
+ } else {
+ list( $ok, $norm ) =
AntiSpoof::checkUnicodeString( $title );
+ }
+
+ if ( $ok === "OK" ) {
+ list( $ver, $title ) = explode( ':', $norm, 2 );
+ } else {
+ wfDebugLog( 'TitleBlacklist', 'AntiSpoof could
not normalize "' . $title . '".' );
+ }
+ }
+
+ wfSuppressWarnings();
+ $match = preg_match(
+ "/^(?:{$this->mRegex})$/us" . ( isset(
$this->mParams['casesensitive'] ) ? '' : 'i' ),
+ $title
+ );
+ wfRestoreWarnings();
+
+ if ( $match ) {
+ if ( isset( $this->mParams['moveonly'] ) && $action !=
'move' ) {
+ return false;
+ }
+ if ( isset( $this->mParams['newaccountonly'] ) &&
$action != 'new-account' ) {
+ return false;
+ }
+ if ( !isset( $this->mParams['noedit'] ) && $action ==
'edit' ) {
+ return false;
+ }
+ if ( isset( $this->mParams['reupload'] ) && $action ==
'upload' ) {
+ // Special:Upload also checks 'create'
permissions when not reuploading
+ return false;
+ }
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Create a new TitleBlacklistEntry from a line of text
+ *
+ * @param string $line String containing a line of blacklist text
+ * @param string $source
+ * @return TitleBlacklistEntry|null
+ */
+ public static function newFromString( $line, $source ) {
+ $raw = $line; // Keep line for raw data
+ $options = [];
+ // Strip comments
+ $line = preg_replace( "/^\\s*([^#]*)\\s*((.*)?)$/", "\\1",
$line );
+ $line = trim( $line );
+ // A blank string causes problems later on
+ if ( $line === '' ) {
+ return null;
+ }
+ // Parse the rest of message
+ $pockets = [];
+ if ( !preg_match( '/^(.*?)(\s*<([^<>]*)>)?$/', $line, $pockets
) ) {
+ return null;
+ }
+ $regex = trim( $pockets[1] );
+ $regex = str_replace( '_', ' ', $regex ); // We'll be matching
against text form
+ $opts_str = isset( $pockets[3] ) ? trim( $pockets[3] ) : '';
+ // Parse opts
+ $opts = preg_split( '/\s*\|\s*/', $opts_str );
+ foreach ( $opts as $opt ) {
+ $opt2 = strtolower( $opt );
+ if ( $opt2 == 'autoconfirmed' ) {
+ $options['autoconfirmed'] = true;
+ }
+ if ( $opt2 == 'moveonly' ) {
+ $options['moveonly'] = true;
+ }
+ if ( $opt2 == 'newaccountonly' ) {
+ $options['newaccountonly'] = true;
+ }
+ if ( $opt2 == 'noedit' ) {
+ $options['noedit'] = true;
+ }
+ if ( $opt2 == 'casesensitive' ) {
+ $options['casesensitive'] = true;
+ }
+ if ( $opt2 == 'reupload' ) {
+ $options['reupload'] = true;
+ }
+ if ( preg_match( '/errmsg\s*=\s*(.+)/i', $opt, $matches
) ) {
+ $options['errmsg'] = $matches[1];
+ }
+ if ( $opt2 == 'antispoof' ) {
+ $options['antispoof'] = true;
+ }
+ }
+ // Process magic words
+ preg_match_all( '/{{\s*([a-z]+)\s*:\s*(.+?)\s*}}/', $regex,
$magicwords, PREG_SET_ORDER );
+ foreach ( $magicwords as $mword ) {
+ global $wgParser; // Functions we're calling
don't need, nevertheless let's use it
+ switch ( strtolower( $mword[1] ) ) {
+ case 'ns':
+ $cpf_result = CoreParserFunctions::ns(
$wgParser, $mword[2] );
+ if ( is_string( $cpf_result ) ) {
+ // All result will have the
same value, so we can just use str_seplace()
+ $regex = str_replace(
$mword[0], $cpf_result, $regex );
+ }
+ break;
+ case 'int':
+ $cpf_result = wfMessage( $mword[2]
)->inContentLanguage()->text();
+ if ( is_string( $cpf_result ) ) {
+ $regex = str_replace(
$mword[0], $cpf_result, $regex );
+ }
+ }
+ }
+ // Return result
+ if ( $regex ) {
+ return new TitleBlacklistEntry( $regex, $options, $raw,
$source );
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * @return string This entry's regular expression
+ */
+ public function getRegex() {
+ return $this->mRegex;
+ }
+
+ /**
+ * @return string This entry's raw line
+ */
+ public function getRaw() {
+ return $this->mRaw;
+ }
+
+ /**
+ * @return array This entry's parameters
+ */
+ public function getParams() {
+ return $this->mParams;
+ }
+
+ /**
+ * @return string Custom message for this entry
+ */
+ public function getCustomMessage() {
+ return isset( $this->mParams['errmsg'] ) ?
$this->mParams['errmsg'] : null;
+ }
+
+ /**
+ * @return string The format version
+ */
+ public function getFormatVersion() {
+ return $this->mFormatVersion;
+ }
+
+ /**
+ * Set the format version
+ *
+ * @param string $v New version to set
+ */
+ public function setFormatVersion( $v ) {
+ $this->mFormatVersion = $v;
+ }
+
+ /**
+ * Return the error message name for the blacklist entry.
+ *
+ * @param string $operation Operation name (as in
titleblacklist-forbidden message name)
+ *
+ * @return string The error message name
+ */
+ public function getErrorMessage( $operation ) {
+ $message = $this->getCustomMessage();
+ // For grep:
+ // titleblacklist-forbidden-edit, titleblacklist-forbidden-move,
+ // titleblacklist-forbidden-upload,
titleblacklist-forbidden-new-account
+ return $message ? $message :
"titleblacklist-forbidden-{$operation}";
+ }
+}
diff --git a/extension.json b/extension.json
index 5319a26..79d4b2e 100644
--- a/extension.json
+++ b/extension.json
@@ -47,7 +47,7 @@
},
"AutoloadClasses": {
"TitleBlacklist": "TitleBlacklist.list.php",
- "TitleBlacklistEntry": "TitleBlacklist.list.php",
+ "TitleBlacklistEntry": "TitleBlacklistEntry.php",
"TitleBlacklistHooks": "TitleBlacklist.hooks.php",
"TitleBlacklistAuthenticationRequest":
"TitleBlacklistAuthenticationRequest.php",
"TitleBlacklistPreAuthenticationProvider":
"TitleBlacklistPreAuthenticationProvider.php",
--
To view, visit https://gerrit.wikimedia.org/r/399705
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I75e2a3a959b7d7bbad2dca68c9c62ea10e948fb4
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/TitleBlacklist
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
Gerrit-Reviewer: Addshore <[email protected]>
Gerrit-Reviewer: Jackmcbarn <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
