wikimedia/mediawiki-extensions-Cite
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Cite synced 2024-09-24 18:58:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Consistently name the variable for the content"

Browse source
This commit is contained in:
jenkins-bot 2019-11-05 10:21:17 +00:00 committed by Gerrit Code Review
parent 3a1a89c364 e3ef0e3a0d
commit fe596f7eb3
1 changed files with 50 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

100
includes/Cite.php
View file

@ -185,22 +185,22 @@ class Cite {
/** /**
* Callback function for <ref> * Callback function for <ref>
* *
* @param string|null $str Raw content of the <ref> tag. * @param string|null $text Raw content of the <ref> tag.
* @param string[] $argv Arguments * @param string[] $argv Arguments
* @param Parser $parser * @param Parser $parser
* @param PPFrame $frame * @param PPFrame $frame
* *
* @return string * @return string
*/ */
public function ref( $str, array $argv, Parser $parser, PPFrame $frame ) { public function ref( $text, array $argv, Parser $parser, PPFrame $frame ) {
if ( $this->mInCite ) { if ( $this->mInCite ) {
return htmlspecialchars( "<ref>$str</ref>" ); return htmlspecialchars( "<ref>$text</ref>" );
} }
$this->mCallCnt++; $this->mCallCnt++;
$this->mInCite = true; $this->mInCite = true;
$ret = $this->guardedRef( $str, $argv, $parser ); $ret = $this->guardedRef( $text, $argv, $parser );
$this->mInCite = false; $this->mInCite = false;
@ -218,7 +218,7 @@ class Cite {
} }
/** /**
* @param string|null $str Raw content of the <ref> tag. * @param string|null $text Raw content of the <ref> tag.
* @param string[] $argv Arguments * @param string[] $argv Arguments
* @param Parser $parser * @param Parser $parser
* *
@ -226,7 +226,7 @@ class Cite {
* @return string * @return string
*/ */
private function guardedRef( private function guardedRef(
$str, $text,
array $argv, array $argv,
Parser $parser Parser $parser
) { ) {
@ -235,8 +235,8 @@ class Cite {
# The key here is the "name" attribute. # The key here is the "name" attribute.
list( $key, $group, $follow, $dir ) = $this->refArg( $argv ); list( $key, $group, $follow, $dir ) = $this->refArg( $argv );
// empty string indicate invalid dir // empty string indicate invalid dir
if ( $dir === '' && $str !== '' ) { if ( $dir === '' && $text !== '' ) {
$str .= $this->plainError( 'cite_error_ref_invalid_dir', $argv['dir'] ); $text .= $this->plainError( 'cite_error_ref_invalid_dir', $argv['dir'] );
} }
# Split these into groups. # Split these into groups.
if ( $group === null ) { if ( $group === null ) {
@ -244,16 +244,16 @@ class Cite {
} }
if ( $this->mInReferences ) { if ( $this->mInReferences ) {
$this->inReferencesGuardedRef( $key, $str, $group, $parser ); $this->inReferencesGuardedRef( $key, $text, $group, $parser );
return ''; return '';
} }
if ( $str === '' ) { if ( $text === '' ) {
# <ref ...></ref>. This construct is invalid if # <ref ...></ref>. This construct is invalid if
# it's a contentful ref, but OK if it's a named duplicate and should # it's a contentful ref, but OK if it's a named duplicate and should
# be equivalent <ref ... />, for compatability with #tag. # be equivalent <ref ... />, for compatability with #tag.
if ( is_string( $key ) && $key !== '' ) { if ( is_string( $key ) && $key !== '' ) {
$str = null; $text = null;
} else { } else {
$this->mRefCallStack[] = false; $this->mRefCallStack[] = false;
return $this->error( 'cite_error_ref_no_input' ); return $this->error( 'cite_error_ref_no_input' );
@ -268,7 +268,7 @@ class Cite {
return $this->error( 'cite_error_ref_too_many_keys' ); return $this->error( 'cite_error_ref_too_many_keys' );
} }
if ( $str === null && $key === null ) { if ( $text === null && $key === null ) {
# Something like <ref />; this makes no sense. # Something like <ref />; this makes no sense.
$this->mRefCallStack[] = false; $this->mRefCallStack[] = false;
return $this->error( 'cite_error_ref_no_key' ); return $this->error( 'cite_error_ref_no_key' );
@ -286,7 +286,7 @@ class Cite {
if ( preg_match( if ( preg_match(
'/<ref\b[^<]*?>/', '/<ref\b[^<]*?>/',
preg_replace( '#<([^ ]+?).*?>.*?</\\1 *>|<!--.*?-->#', '', $str ) preg_replace( '#<([^ ]+?).*?>.*?</\\1 *>|<!--.*?-->#', '', $text )
) ) { ) ) {
# (bug T8199) This most likely implies that someone left off the # (bug T8199) This most likely implies that someone left off the
# closing </ref> tag, which will cause the entire article to be # closing </ref> tag, which will cause the entire article to be
@ -303,19 +303,19 @@ class Cite {
return $this->error( 'cite_error_included_ref' ); return $this->error( 'cite_error_included_ref' );
} }
if ( is_string( $key ) || is_string( $str ) ) { if ( is_string( $key ) || is_string( $text ) ) {
# We don't care about the content: if the key exists, the ref # We don't care about the content: if the key exists, the ref
# is presumptively valid. Either it stores a new ref, or re- # is presumptively valid. Either it stores a new ref, or re-
# fers to an existing one. If it refers to a nonexistent ref, # fers to an existing one. If it refers to a nonexistent ref,
# we'll figure that out later. Likewise it's definitely valid # we'll figure that out later. Likewise it's definitely valid
# if there's any content, regardless of key. # if there's any content, regardless of key.
return $this->stack( $str, $key, $group, $follow, $argv, $dir, $parser ); return $this->stack( $text, $key, $group, $follow, $argv, $dir, $parser );
} }
# Not clear how we could get here, but something is probably # Not clear how we could get here, but something is probably
# wrong with the types. Let's fail fast. # wrong with the types. Let's fail fast.
throw new Exception( 'Invalid $str and/or $key: ' . serialize( [ $str, $key ] ) ); throw new Exception( 'Invalid $text and/or $key: ' . serialize( [ $text, $key ] ) );
} }
/** /**
@ -325,11 +325,11 @@ class Cite {
* </references> * </references>
* *
* @param $key * @param $key
* @param $str * @param $text Content from the <ref> tag
* @param string $group * @param string $group
* @param Parser $parser * @param Parser $parser
*/ */
private function inReferencesGuardedRef( $key, $str, $group, Parser $parser ) { private function inReferencesGuardedRef( $key, $text, $group, Parser $parser ) {
$isSectionPreview = $parser->getOptions()->getIsSectionPreview(); $isSectionPreview = $parser->getOptions()->getIsSectionPreview();
if ( $group != $this->mReferencesGroup ) { if ( $group != $this->mReferencesGroup ) {
# <ref> and <references> have conflicting group attributes. # <ref> and <references> have conflicting group attributes.
@ -338,7 +338,7 @@ class Cite {
'cite_error_references_group_mismatch', 'cite_error_references_group_mismatch',
Sanitizer::safeEncodeAttribute( $group ) Sanitizer::safeEncodeAttribute( $group )
); );
} elseif ( $str !== '' ) { } elseif ( $text !== '' ) {
if ( !$isSectionPreview && !isset( $this->mRefs[$group] ) ) { if ( !$isSectionPreview && !isset( $this->mRefs[$group] ) ) {
# Called with group attribute not defined in text. # Called with group attribute not defined in text.
$this->mReferencesErrors[] = $this->mReferencesErrors[] =
@ -357,7 +357,7 @@ class Cite {
} else { } else {
if ( if (
isset( $this->mRefs[$group][$key]['text'] ) && isset( $this->mRefs[$group][$key]['text'] ) &&
$str !== $this->mRefs[$group][$key]['text'] $text !== $this->mRefs[$group][$key]['text']
) { ) {
// two refs with same key and different content // two refs with same key and different content
// add error message to the original ref // add error message to the original ref
@ -366,7 +366,7 @@ class Cite {
); );
} else { } else {
# Assign the text to corresponding ref # Assign the text to corresponding ref
$this->mRefs[$group][$key]['text'] = $str; $this->mRefs[$group][$key]['text'] = $text;
} }
} }
} else { } else {
@ -450,7 +450,7 @@ class Cite {
/** /**
* Populate $this->mRefs based on input and arguments to <ref> * Populate $this->mRefs based on input and arguments to <ref>
* *
* @param string|null $str Content from the <ref> tag * @param string|null $text Content from the <ref> tag
* @param string|null $key Argument to the <ref> tag as returned by $this->refArg() * @param string|null $key Argument to the <ref> tag as returned by $this->refArg()
* @param string $group * @param string $group
* @param string|null $follow * @param string|null $follow
@ -461,7 +461,7 @@ class Cite {
* @throws Exception * @throws Exception
* @return string * @return string
*/ */
private function stack( $str, $key, $group, $follow, array $call, $dir, Parser $parser ) { private function stack( $text, $key, $group, $follow, array $call, $dir, Parser $parser ) {
if ( !isset( $this->mRefs[$group] ) ) { if ( !isset( $this->mRefs[$group] ) ) {
$this->mRefs[$group] = []; $this->mRefs[$group] = [];
} }
@ -471,7 +471,7 @@ class Cite {
if ( $follow != null ) { if ( $follow != null ) {
if ( isset( $this->mRefs[$group][$follow] ) && is_array( $this->mRefs[$group][$follow] ) ) { if ( isset( $this->mRefs[$group][$follow] ) && is_array( $this->mRefs[$group][$follow] ) ) {
// add text to the note that is being followed // add text to the note that is being followed
$this->mRefs[$group][$follow]['text'] .= ' ' . $str; $this->mRefs[$group][$follow]['text'] .= ' ' . $text;
} else { } else {
// insert part of note at the beginning of the group // insert part of note at the beginning of the group
$groupsCount = count( $this->mRefs[$group] ); $groupsCount = count( $this->mRefs[$group] );
@ -482,13 +482,13 @@ class Cite {
} }
array_splice( $this->mRefs[$group], $k, 0, [ [ array_splice( $this->mRefs[$group], $k, 0, [ [
'count' => -1, 'count' => -1,
'text' => $str, 'text' => $text,
'key' => ++$this->mOutCnt, 'key' => ++$this->mOutCnt,
'follow' => $follow, 'follow' => $follow,
'dir' => $dir 'dir' => $dir
] ] ); ] ] );
array_splice( $this->mRefCallStack, $k, 0, array_splice( $this->mRefCallStack, $k, 0,
[ [ 'new', $call, $str, $key, $group, $this->mOutCnt ] ] ); [ [ 'new', $call, $text, $key, $group, $this->mOutCnt ] ] );
} }
// return an empty string : this is not a reference // return an empty string : this is not a reference
return ''; return '';
@ -497,11 +497,11 @@ class Cite {
if ( $key === null ) { if ( $key === null ) {
$this->mRefs[$group][] = [ $this->mRefs[$group][] = [
'count' => -1, 'count' => -1,
'text' => $str, 'text' => $text,
'key' => ++$this->mOutCnt, 'key' => ++$this->mOutCnt,
'dir' => $dir 'dir' => $dir
]; ];
$this->mRefCallStack[] = [ 'new', $call, $str, $key, $group, $this->mOutCnt ]; $this->mRefCallStack[] = [ 'new', $call, $text, $key, $group, $this->mOutCnt ];
return $this->linkRef( $group, $this->mOutCnt ); return $this->linkRef( $group, $this->mOutCnt );
} }
@ -512,13 +512,13 @@ class Cite {
// Valid key with first occurrence // Valid key with first occurrence
if ( !isset( $this->mRefs[$group][$key] ) || !is_array( $this->mRefs[$group][$key] ) ) { if ( !isset( $this->mRefs[$group][$key] ) || !is_array( $this->mRefs[$group][$key] ) ) {
$this->mRefs[$group][$key] = [ $this->mRefs[$group][$key] = [
'text' => $str, 'text' => $text,
'count' => 0, 'count' => 0,
'key' => ++$this->mOutCnt, 'key' => ++$this->mOutCnt,
'number' => ++$this->mGroupCnt[$group], 'number' => ++$this->mGroupCnt[$group],
'dir' => $dir 'dir' => $dir
]; ];
$this->mRefCallStack[] = [ 'new', $call, $str, $key, $group, $this->mOutCnt ]; $this->mRefCallStack[] = [ 'new', $call, $text, $key, $group, $this->mOutCnt ];
return $this->linkRef( return $this->linkRef(
$group, $group,
@ -530,17 +530,17 @@ class Cite {
} }
// Valid key that is already known // Valid key that is already known
if ( $this->mRefs[$group][$key]['text'] === null && $str !== '' ) { if ( $this->mRefs[$group][$key]['text'] === null && $text !== '' ) {
// If no text was set before, use this text // If no text was set before, use this text
$this->mRefs[$group][$key]['text'] = $str; $this->mRefs[$group][$key]['text'] = $text;
// Use the dir parameter only from the full definition of a named ref tag // Use the dir parameter only from the full definition of a named ref tag
$this->mRefs[$group][$key]['dir'] = $dir; $this->mRefs[$group][$key]['dir'] = $dir;
$this->mRefCallStack[] = [ 'assign', $call, $str, $key, $group, $this->mRefCallStack[] = [ 'assign', $call, $text, $key, $group,
$this->mRefs[$group][$key]['key'] ]; $this->mRefs[$group][$key]['key'] ];
} else { } else {
if ( $str != null && $str !== '' if ( $text != null && $text !== ''
// T205803 different strip markers might hide the same text // T205803 different strip markers might hide the same text
&& $parser->mStripState->unstripBoth( $str ) && $parser->mStripState->unstripBoth( $text )
!== $parser->mStripState->unstripBoth( $this->mRefs[$group][$key]['text'] ) !== $parser->mStripState->unstripBoth( $this->mRefs[$group][$key]['text'] )
) { ) {
// two refs with same key and different text // two refs with same key and different text
@ -549,7 +549,7 @@ class Cite {
'cite_error_references_duplicate_key', $key 'cite_error_references_duplicate_key', $key
); );
} }
$this->mRefCallStack[] = [ 'increment', $call, $str, $key, $group, $this->mRefCallStack[] = [ 'increment', $call, $text, $key, $group,
$this->mRefs[$group][$key]['key'] ]; $this->mRefs[$group][$key]['key'] ];
} }
return $this->linkRef( return $this->linkRef(
@ -627,23 +627,23 @@ class Cite {
/** /**
* Callback function for <references> * Callback function for <references>
* *
* @param string|null $str Raw content of the <references> tag. * @param string|null $text Raw content of the <references> tag.
* @param string[] $argv Arguments * @param string[] $argv Arguments
* @param Parser $parser * @param Parser $parser
* @param PPFrame $frame * @param PPFrame $frame
* *
* @return string * @return string
*/ */
public function references( $str, array $argv, Parser $parser, PPFrame $frame ) { public function references( $text, array $argv, Parser $parser, PPFrame $frame ) {
if ( $this->mInCite || $this->mInReferences ) { if ( $this->mInCite || $this->mInReferences ) {
if ( $str === null ) { if ( $text === null ) {
return htmlspecialchars( "<references/>" ); return htmlspecialchars( "<references/>" );
} }
return htmlspecialchars( "<references>$str</references>" ); return htmlspecialchars( "<references>$text</references>" );
} }
$this->mCallCnt++; $this->mCallCnt++;
$this->mInReferences = true; $this->mInReferences = true;
$ret = $this->guardedReferences( $str, $argv, $parser ); $ret = $this->guardedReferences( $text, $argv, $parser );
$this->mInReferences = false; $this->mInReferences = false;
$frame->setVolatile(); $frame->setVolatile();
return $ret; return $ret;
@ -652,14 +652,14 @@ class Cite {
/** /**
* Must only be called from references(). Use that to prevent recursion. * Must only be called from references(). Use that to prevent recursion.
* *
* @param string|null $str Raw content of the <references> tag. * @param string|null $text Raw content of the <references> tag.
* @param string[] $argv * @param string[] $argv
* @param Parser $parser * @param Parser $parser
* *
* @return string * @return string
*/ */
private function guardedReferences( private function guardedReferences(
$str, $text,
array $argv, array $argv,
Parser $parser Parser $parser
) { ) {
@ -670,7 +670,7 @@ class Cite {
$group = $argv['group'] ?? self::DEFAULT_GROUP; $group = $argv['group'] ?? self::DEFAULT_GROUP;
unset( $argv['group'] ); unset( $argv['group'] );
if ( strval( $str ) !== '' ) { if ( strval( $text ) !== '' ) {
$this->mReferencesGroup = $group; $this->mReferencesGroup = $group;
# Detect whether we were sent already rendered <ref>s. # Detect whether we were sent already rendered <ref>s.
@ -682,7 +682,7 @@ class Cite {
# that some unusual combination of #tag, <references> and # that some unusual combination of #tag, <references> and
# conditional parser functions could be created that would # conditional parser functions could be created that would
# lead to malformed references here. # lead to malformed references here.
$count = substr_count( $str, Parser::MARKER_PREFIX . "-ref-" ); $count = substr_count( $text, Parser::MARKER_PREFIX . "-ref-" );
$redoStack = []; $redoStack = [];
# Undo effects of calling <ref> while unaware of containing <references> # Undo effects of calling <ref> while unaware of containing <references>
@ -694,7 +694,7 @@ class Cite {
$call = array_pop( $this->mRefCallStack ); $call = array_pop( $this->mRefCallStack );
$redoStack[] = $call; $redoStack[] = $call;
if ( $call !== false ) { if ( $call !== false ) {
list( $type, $ref_argv, $ref_str, list( $type, $ref_argv, $ref_text,
$ref_key, $ref_group, $ref_index ) = $call; $ref_key, $ref_group, $ref_index ) = $call;
$this->rollbackRef( $type, $ref_key, $ref_group, $ref_index ); $this->rollbackRef( $type, $ref_key, $ref_group, $ref_index );
} }
@ -704,14 +704,14 @@ class Cite {
for ( $i = count( $redoStack ) - 1; $i >= 0; $i-- ) { for ( $i = count( $redoStack ) - 1; $i >= 0; $i-- ) {
$call = $redoStack[$i]; $call = $redoStack[$i];
if ( $call !== false ) { if ( $call !== false ) {
list( $type, $ref_argv, $ref_str, list( $type, $ref_argv, $ref_text,
$ref_key, $ref_group, $ref_index ) = $call; $ref_key, $ref_group, $ref_index ) = $call;
$this->guardedRef( $ref_str, $ref_argv, $parser ); $this->guardedRef( $ref_text, $ref_argv, $parser );
} }
} }
# Parse $str to process any unparsed <ref> tags. # Parse $text to process any unparsed <ref> tags.
$parser->recursiveTagParse( $str ); $parser->recursiveTagParse( $text );
# Reset call stack # Reset call stack
$this->mRefCallStack = []; $this->mRefCallStack = [];