Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

arv: refactor AIV report generation #2060

Merged
merged 3 commits into from
Nov 22, 2024
Merged

arv: refactor AIV report generation #2060

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f5d47fa
extract aiv report creation to methods
TollensWP Nov 22, 2024
5fe01d0
fix lint error
TollensWP Nov 22, 2024
30e1eab
use more concise method name
TollensWP Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 74 additions & 56 deletions modules/twinklearv.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,72 +473,28 @@ Twinkle.arv.callback.changeCategory = function (e) {
Twinkle.arv.callback.evaluate = function(e) {
var form = e.target;
var reason = '';
var input = Morebits.quickForm.getInputData(form);

var comment = '';
if (form.reason) {
comment = form.reason.value;
}
var uid = form.uid.value;

var types;
switch (form.category.value) {

switch (input.category) {

// Report user for vandalism
case 'aiv':
/* falls through */
default:
types = form.getChecked('arvtype');
if (!types.length && comment === '') {
reason = Twinkle.arv.callback.getAivReasonOnlyWikitext(input);

if (reason === null) {
alert('You must specify some reason');
return;
}

types = types.map(function(v) {
switch (v) {
case 'final':
return 'vandalism after final warning';
case 'postblock':
return 'vandalism after recent release of block';
case 'vandalonly':
return 'actions evidently indicate a vandalism-only account';
case 'promoonly':
return 'account is being used only for promotional purposes';
case 'spambot':
return 'account is evidently a spambot or a compromised account';
default:
return 'unknown reason';
}
}).join('; ');

if (form.page.value !== '') {
// Allow links to redirects, files, and categories
reason = 'On {{No redirect|:' + form.page.value + '}}';
if (form.badid.value !== '') {
reason += ' ({{diff|' + form.page.value + '|' + form.badid.value + '|' + form.goodid.value + '|diff}})';
}
reason += ':';
}

if (types) {
reason += ' ' + types;
}

if (comment !== '') {
var reasonEndsInPunctuationOrBlank = /([.?!;:]|^)$/.test(reason);
reason += reasonEndsInPunctuationOrBlank ? '' : '.';
var reasonIsBlank = reason === '';
reason += reasonIsBlank ? '' : ' ';
reason += comment;
}

reason = reason.trim();
var reasonEndsInPunctuation = /[.?!;]$/.test(reason);
if (!reasonEndsInPunctuation) {
reason += '.';
}

reason += ' ~~~~';
reason = reason.replace(/\r?\n/g, '\n*:'); // indent newlines

Morebits.simpleWindow.setButtonsEnabled(false);
Morebits.status.init(form);

Expand All @@ -554,7 +510,7 @@ Twinkle.arv.callback.evaluate = function(e) {
var $aivLink = '<a target="_blank" href="/wiki/WP:AIV">WP:AIV</a>';

// check if user has already been reported
if (new RegExp('\\{\\{\\s*(?:(?:[Ii][Pp])?[Vv]andal|[Uu]serlinks)\\s*\\|\\s*(?:1=)?\\s*' + Morebits.string.escapeRegExp(uid) + '\\s*\\}\\}').test(text)) {
if (new RegExp('\\{\\{\\s*(?:(?:[Ii][Pp])?[Vv]andal|[Uu]serlinks)\\s*\\|\\s*(?:1=)?\\s*' + Morebits.string.escapeRegExp(input.uid) + '\\s*\\}\\}').test(text)) {
aivPage.getStatusElement().error('Report already present, will not add a new one');
Morebits.status.printUserText(reason, 'The comments you typed are provided below, in case you wish to manually post them under the existing report for this user at ' + $aivLink + ':');
return;
Expand All @@ -566,8 +522,8 @@ Twinkle.arv.callback.evaluate = function(e) {
var tb2Text = tb2Page.getPageText();
var tb2statelem = tb2Page.getStatusElement();

if (new RegExp('\\{\\{\\s*(?:(?:[Ii][Pp])?[Vv]andal|[Uu]serlinks)\\s*\\|\\s*(?:1=)?\\s*' + Morebits.string.escapeRegExp(uid) + '\\s*\\}\\}').test(tb2Text)) {
if (confirm('The user ' + uid + ' has already been reported by a bot. Do you wish to make the report anyway?')) {
if (new RegExp('\\{\\{\\s*(?:(?:[Ii][Pp])?[Vv]andal|[Uu]serlinks)\\s*\\|\\s*(?:1=)?\\s*' + Morebits.string.escapeRegExp(input.uid) + '\\s*\\}\\}').test(tb2Text)) {
if (confirm('The user ' + input.uid + ' has already been reported by a bot. Do you wish to make the report anyway?')) {
tb2statelem.info('Proceeded despite bot report');
} else {
tb2statelem.error('Report from a bot is already present, stopping');
Expand All @@ -579,9 +535,9 @@ Twinkle.arv.callback.evaluate = function(e) {
}

aivPage.getStatusElement().status('Adding new report...');
aivPage.setEditSummary('Reporting [[Special:Contributions/' + uid + '|' + uid + ']].');
aivPage.setEditSummary('Reporting [[Special:Contributions/' + input.uid + '|' + input.uid + ']].');
aivPage.setChangeTags(Twinkle.changeTags);
aivPage.setAppendText('\n*{{vandal|' + (/=/.test(uid) ? '1=' : '') + uid + '}} &ndash; ' + reason);
aivPage.setAppendText(Twinkle.arv.callback.buildAivReport(input));
aivPage.append();
});
});
Expand Down Expand Up @@ -812,6 +768,68 @@ Twinkle.arv.callback.evaluate = function(e) {
}
};

Twinkle.arv.callback.getAivReasonOnlyWikitext = function(input) {
TollensWP marked this conversation as resolved.
Show resolved Hide resolved
var text = '';
var type = input.arvtype;

if (!type.length && input.reason === '') {
return null;
}

type = type.map(function(v) {
switch (v) {
case 'final':
return 'vandalism after final warning';
case 'postblock':
return 'vandalism after recent release of block';
case 'vandalonly':
return 'actions evidently indicate a vandalism-only account';
case 'promoonly':
return 'account is being used only for promotional purposes';
case 'spambot':
return 'account is evidently a spambot or a compromised account';
default:
return 'unknown reason';
}
}).join('; ');

if (input.page !== '') {
// Allow links to redirects, files, and categories
text = 'On {{No redirect|:' + input.page + '}}';
if (input.badid !== '') {
text += ' ({{diff|' + input.page + '|' + input.badid + '|' + input.goodid + '|diff}})';
}
text += ':';
}

if (type) {
text += ' ' + type;
}

if (input.reason !== '') {
var textEndsInPunctuationOrBlank = /([.?!;:]|^)$/.test(text);
text += textEndsInPunctuationOrBlank ? '' : '.';
var textIsBlank = text === '';
text += textIsBlank ? '' : ' ';
text += input.reason;
}

text = text.trim();
var textEndsInPunctuation = /[.?!;]$/.test(text);
if (!textEndsInPunctuation) {
text += '.';
}

text += ' ~~~~';
text = text.replace(/\r?\n/g, '\n*:'); // indent newlines

return text;
};

Twinkle.arv.callback.buildAivReport = function(input) {
return '\n*{{vandal|' + (/=/.test(input.uid) ? '1=' : '') + input.uid + '}} &ndash; ' + Twinkle.arv.callback.getAivReasonOnlyWikitext(input);
};

Twinkle.arv.processSock = function(params) {
Morebits.wiki.addCheckpoint(); // prevent notification events from causing an erronous "action completed"

Expand Down
Loading