mediawiki-extensions-AbuseF.../modules/mode-abusefilter.js
Daimona Eaytoy 2a3b636a45 Run real-time validation of rules with an Ace worker
The worker itself is essentially a wrapper around the
abusefilterchecksyntax API.

NOTE: As written in code comments, basically the whole
worker-abusefilter.js script consists of boilerplate code. You can
verify this by diffing this file and 6cb8a9cae1/modules/ace/worker-json.js
This means that there are only ~60 lines of code to review in that file.

Bug: T187686
Change-Id: I8950fcd5917ba226dda80b47b2bb713e685fad36
2020-12-18 15:05:28 +00:00

151 lines
4.1 KiB
JavaScript

/* global ace */
ace.define( 'ace/mode/abusefilter_highlight_rules', [ 'require', 'exports', 'module', 'ace/lib/oop', 'ace/mode/text_highlight_rules' ], function ( require, exports ) {
'use strict';
var oop = require( 'ace/lib/oop' ),
TextHighlightRules = require( './text_highlight_rules' ).TextHighlightRules,
AFHighlightRules = function () {
var cfg = mw.config.get( 'aceConfig' ),
constants = ( 'true|false|null' ),
keywords = this.createKeywordMapper(
{
keyword: cfg.keywords,
'support.function': cfg.functions,
'constant.language': constants
},
// Null as default used in isKeywordOrVariable
null
),
variables = this.createKeywordMapper(
{
'variable.language': cfg.variables,
'invalid.deprecated': cfg.deprecated,
'invalid.illegal': cfg.disabled
},
'identifier',
true
),
isKeywordOrVariable = function ( value ) {
if ( keywords( value ) !== null ) {
return keywords( value );
} else {
return variables( value );
}
},
integer = '(?:(?:[1-9]\\d*)|(?:0))',
fraction = '(?:\\.\\d+)',
intPart = '(?:\\d+)',
pointFloat = '(?:(?:' + intPart + '?' + fraction + ')|(?:' + intPart + '\\.))',
floatNumber = '(?:' + pointFloat + ')',
singleQuoteString = '\'(?:[^\\\\]|\\\\.)*?\'',
doubleQuoteString = '"(?:[^\\\\]|\\\\.)*?"';
this.$rules = {
start: [ {
token: 'comment',
regex: '\\/\\*',
next: 'comment'
}, {
token: 'string',
regex: doubleQuoteString
}, {
token: 'string',
regex: singleQuoteString
}, {
token: 'constant.numeric',
regex: floatNumber
}, {
token: 'constant.numeric',
regex: integer + '\\b'
}, {
token: isKeywordOrVariable,
regex: '[a-zA-Z_][a-zA-Z0-9_]*\\b'
}, {
token: 'keyword.operator',
regex: cfg.operators
}, {
token: 'paren.lparen',
regex: '[\\[\\(]'
}, {
token: 'paren.rparen',
regex: '[\\]\\)]'
}, {
token: 'text',
regex: '\\s+|\\w+'
} ],
comment: [ {
token: 'comment',
regex: '\\*\\/',
next: 'start'
}, {
defaultToken: 'comment'
} ]
};
this.normalizeRules();
};
oop.inherits( AFHighlightRules, TextHighlightRules );
exports.AFHighlightRules = AFHighlightRules;
} );
ace.define( 'ace/mode/abusefilter', [ 'require', 'exports', 'module', 'ace/lib/oop', 'ace/mode/text', 'ace/mode/abusefilter_highlight_rules', 'ace/worker/worker_client' ], function ( require, exports ) {
'use strict';
var oop = require( 'ace/lib/oop' ),
TextMode = require( './text' ).Mode,
WorkerClient = require( 'ace/worker/worker_client' ).WorkerClient,
AFHighlightRules = require( './abusefilter_highlight_rules' ).AFHighlightRules,
MatchingBraceOutdent = require( './matching_brace_outdent' ).MatchingBraceOutdent,
Mode = function () {
this.HighlightRules = AFHighlightRules;
this.$behaviour = this.$defaultBehaviour;
this.$outdent = new MatchingBraceOutdent();
};
oop.inherits( Mode, TextMode );
( function () {
this.blockComment = {
start: '/*',
end: '*/'
};
this.getNextLineIndent = function ( state, line ) {
var indent = this.$getIndent( line );
return indent;
};
this.checkOutdent = function ( state, line, input ) {
return this.$outdent.checkOutdent( line, input );
};
this.autoOutdent = function ( state, doc, row ) {
this.$outdent.autoOutdent( doc, row );
};
this.createWorker = function ( session ) {
var extPath = mw.config.get( 'wgExtensionAssetsPath' ),
worker;
ace.config.set( 'workerPath', extPath + '/AbuseFilter/modules' );
worker = new WorkerClient( [ 'ace' ], 'ace/mode/abusefilter_worker', 'AbuseFilterWorker' );
worker.$worker.postMessage( {
apipath: mw.config.get( 'wgServer' ) + new mw.Api().defaults.ajax.url
} );
worker.attachToDocument( session.getDocument() );
worker.on( 'annotate', function ( results ) {
session.setAnnotations( results.data );
} );
worker.on( 'terminate', function () {
session.clearAnnotations();
} );
return worker;
};
} )
.call( Mode.prototype );
exports.Mode = Mode;
} );