wikiparser-node 0.8.1-m → 0.9.0

package/src/imageParameter.js

@@ -1,53 +1,124 @@
 'use strict';
 
-const {extUrlChar, extUrlCharFirst} = require('../util/string'),
+const {text, noWrap, print, extUrlChar, extUrlCharFirst} = require('../util/string'),
+	{generateForSelf} = require('../util/lint'),
+	Title = require('../lib/title'),
 	Parser = require('..'),
+	AstText = require('../lib/text'),
 	Token = require('.');
 
+const params = new Set(['alt', 'link', 'lang', 'page', 'caption']);
+
+/**
+ * 检查图片参数是否合法
+ * @template {string} T
+ * @param {T} key 参数名
+ * @param {string} value 参数值
+ * @returns {T extends 'link' ? string|Title : boolean}
+ */
+const validate = (key, value, config = Parser.getConfig(), halfParsed = false) => {
+	value = value.replace(/\0\d+t\x7F/gu, '').trim();
+	switch (key) {
+		case 'width':
+			return /^(?:\d+x?|\d*x\d+)$/u.test(value);
+		case 'link': {
+			if (!value) {
+				return '';
+			}
+			const regex = new RegExp(`(?:(?:${config.protocol}|//)${extUrlCharFirst}|\0\\d+m\x7F)${
+				extUrlChar
+			}(?=\0\\d+t\x7F|$)`, 'iu');
+			if (regex.test(value)) {
+				return value;
+			} else if (value.startsWith('[[') && value.endsWith(']]')) {
+				value = value.slice(2, -2);
+			}
+			const title = Parser.normalizeTitle(value, 0, false, config, halfParsed, true, true);
+			return title.valid && title;
+		}
+		case 'lang':
+			return config.variants.includes(value);
+		case 'alt':
+		case 'class':
+		case 'manualthumb':
+			return true;
+		default:
+			return !isNaN(value);
+	}
+};
+
 /**
  * 图片参数
  * @classdesc `{childNodes: ...(AstText|Token)}`
  */
 class ImageParameterToken extends Token {
-	/**
-	 * 检查图片参数是否合法
-	 * @template {string} T
-	 * @param {T} key 参数名
-	 * @param {string} value 参数值
-	 */
-	static #validate(key, value, config = Parser.getConfig(), halfParsed = false) {
-		value = value.replace(/\0\d+t\x7F/gu, '').trim();
-		switch (key) {
-			case 'width':
-				return /^\d*(?:x\d*)?$/u.test(value);
-			case 'link': {
-				if (!value) {
-					return true;
-				}
-				const regex = new RegExp(`(?:(?:${config.protocol}|//)${extUrlCharFirst}|\0\\d+m\x7F)${
-					extUrlChar
-				}(?=\0\\d+t\x7F|$)`, 'iu');
-				if (regex.test(value)) {
-					return true;
-				} else if (value.startsWith('[[') && value.endsWith(']]')) {
-					value = value.slice(2, -2);
-				}
-				const title = Parser.normalizeTitle(value, 0, false, config, halfParsed, true, true);
-				return title.valid;
+	type = 'image-parameter';
+	#syntax = '';
+
+	/** 图片链接 */
+	get link() {
+		return this.name === 'link' ? validate('link', super.text(), this.getAttribute('config')) : undefined;
+	}
+
+	set link(value) {
+		if (this.name === 'link') {
+			this.setValue(value);
+		}
+	}
+
+	/** getValue()的getter */
+	get value() {
+		return this.getValue();
+	}
+
+	set value(value) {
+		this.setValue(value);
+	}
+
+	/** 图片大小 */
+	get size() {
+		if (this.name === 'width') {
+			const /** @type {string} */ size = this.getValue().trim();
+			if (!size.includes('{{')) {
+				const [width, height = ''] = size.split('x');
+				return {width, height};
+			}
+			const /** @type {{childNodes: AstText[]}} */ token = Parser.parse(size, false, 2, this.getAttribute('config')),
+				i = token.childNodes.findIndex(({type, data}) => type === 'text' && data.includes('x')),
+				str = token.childNodes[i];
+			if (i === -1) {
+				return {width: size, height: ''};
 			}
-			case 'lang':
-				return config.variants.includes(value);
-			case 'alt':
-			case 'class':
-			case 'manualthumb':
-				return true;
-			default:
-				return !isNaN(value);
+			str.splitText(str.data.indexOf('x'));
+			str.nextSibling.splitText(1);
+			return {width: text(token.childNodes.slice(0, i + 1)), height: text(token.childNodes.slice(i + 2))};
 		}
+		return undefined;
 	}
 
-	type = 'image-parameter';
-	#syntax = '';
+	/** 图片宽度 */
+	get width() {
+		return this.size?.width;
+	}
+
+	set width(width) {
+		if (this.name === 'width') {
+			const {height} = this;
+			this.setValue(`${String(width || '')}${height && 'x'}${height}`);
+		}
+	}
+
+	/** 图片高度 */
+	get height() {
+		return this.size?.height;
+	}
+
+	set height(height) {
+		height = String(height || '');
+		if (this.name === 'width') {
+			this.setValue(`${this.width}${height && 'x'}${height}`);
+		}
+	}
 
 	/**
 	 * @param {string} str 图片参数
@@ -61,7 +132,7 @@ class ImageParameterToken extends Token {
 			),
 			param = regexes.find(([, key, regex]) => {
 				mt = regex.exec(str);
-				return mt && (mt.length !== 4 || ImageParameterToken.#validate(key, mt[2], config, true));
+				return mt && (mt.length !== 4 || validate(key, mt[2], config, true) !== false);
 			});
 		if (param) {
 			if (mt.length === 3) {
@@ -69,6 +140,7 @@ class ImageParameterToken extends Token {
 				this.#syntax = str;
 			} else {
 				super(mt[2], config, true, accum, {
+					'Stage-2': ':', '!HeadingToken': ':',
 				});
 				this.#syntax = `${mt[1]}${param[0]}${mt[3]}`;
 			}
@@ -79,6 +151,13 @@ class ImageParameterToken extends Token {
 		this.setAttribute('name', 'caption').setAttribute('stage', 7);
 	}
 
+	/** @override */
+	afterBuild() {
+		if (this.parentNode.type === 'gallery-image' && !params.has(this.name)) {
+			this.setAttribute('name', 'invalid');
+		}
+	}
+
 	/** @override */
 	isPlain() {
 		return this.name === 'caption';
@@ -86,9 +165,10 @@ class ImageParameterToken extends Token {
 
 	/**
 	 * @override
+	 * @param {string} selector
 	 */
 	toString(selector) {
-		return this.#syntax
+		return this.#syntax && !(selector && this.matches(selector))
 			? this.#syntax.replace('$1', super.toString(selector))
 			: super.toString(selector);
 	}
@@ -102,6 +182,120 @@ class ImageParameterToken extends Token {
 	getPadding() {
 		return Math.max(0, this.#syntax.indexOf('$1'));
 	}
+
+	/**
+	 * @override
+	 * @this {ImageParameterToken & {link: Title}}
+	 * @param {number} start 起始位置
+	 */
+	lint(start = this.getAbsoluteIndex()) {
+		const errors = super.lint(start);
+		if (this.name === 'invalid') {
+			errors.push(generateForSelf(this, {start}, 'invalid gallery image parameter'));
+		} else if (this.link?.encoded) {
+			errors.push(generateForSelf(this, {start}, 'unnecessary URL encoding in an internal link'));
+		}
+		return errors;
+	}
+
+	/** @override */
+	print() {
+		return this.#syntax
+			? `<span class="wpb-image-parameter">${
+				this.#syntax.replace('$1', `<span class="wpb-image-caption">${print(this.childNodes)}</span>`)
+			}</span>`
+			: super.print({class: 'image-caption'});
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes(),
+			config = this.getAttribute('config');
+		return Parser.run(() => {
+			const token = new ImageParameterToken(this.#syntax.replace('$1', ''), config);
+			token.replaceChildren(...cloned);
+			return token;
+		});
+	}
+
+	/**
+	 * @override
+	 * @template {string} T
+	 * @param {T} key 属性键
+	 * @returns {TokenAttribute<T>}
+	 */
+	getAttribute(key) {
+		return key === 'syntax' ? this.#syntax : super.getAttribute(key);
+	}
+
+	/**
+	 * @override
+	 * @param {PropertyKey} key 属性键
+	 */
+	hasAttribute(key) {
+		return key === 'syntax' || super.hasAttribute(key);
+	}
+
+	/** 是否是不可变参数 */
+	#isVoid() {
+		return this.#syntax && !this.#syntax.includes('$1');
+	}
+
+	/**
+	 * @override
+	 * @template {Token} T
+	 * @param {T} token 待插入的子节点
+	 * @param {number} i 插入位置
+	 * @complexity `n`
+	 * @throws `Error` 不接受自定义输入的图片参数
+	 */
+	insertAt(token, i = this.length) {
+		if (!Parser.running && this.#isVoid()) {
+			throw new Error(`图片参数 ${this.name} 不接受自定义输入！`);
+		}
+		return super.insertAt(token, i);
+	}
+
+	/**
+	 * 获取参数值
+	 * @complexity `n`
+	 */
+	getValue() {
+		return this.name === 'invalid' ? this.text() : this.#isVoid() || super.text();
+	}
+
+	/**
+	 * 设置参数值
+	 * @param {string|boolean} value 参数值
+	 * @complexity `n`
+	 * @throws	SyntaxError` 非法的参数值
+	 */
+	setValue(value) {
+		if (this.name === 'invalid') {
+			throw new Error('无效的图片参数！');
+		} else if (this.#isVoid()) {
+			if (typeof value !== 'boolean') {
+				this.typeError('setValue', 'Boolean');
+			} else if (value === false) {
+				this.remove();
+			}
+			return;
+		} else if (typeof value !== 'string') {
+			this.typeError('setValue', 'String');
+		}
+		const root = Parser.parse(`[[File:F|${
+				this.#syntax ? this.#syntax.replace('$1', value) : value
+			}]]`, this.getAttribute('include'), 6, this.getAttribute('config')),
+			{length, firstChild: file} = root,
+			{lastChild: imageParameter, type, name, length: fileLength} = file;
+		if (length !== 1 || type !== 'file' || name !== 'File:F' || fileLength !== 2
+			|| imageParameter.name !== this.name
+		) {
+			throw new SyntaxError(`非法的 ${this.name} 参数：${noWrap(value)}`);
+		}
+		this.replaceChildren(...imageParameter.childNodes);
+	}
 }
 
+Parser.classes.ImageParameterToken = __filename;
 module.exports = ImageParameterToken;

package/src/imagemap.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const {generateForSelf, generateForChild} = require('../util/lint'),
+	singleLine = require('../mixin/singleLine'),
 	Parser = require('..'),
 	Token = require('.'),
 	NoincludeToken = require('./nowiki/noinclude'),
@@ -23,6 +24,14 @@ class ImagemapToken extends Token {
 		return this.childNodes.find(({type}) => type === 'imagemap-image');
 	}
 
+	/**
+	 * 链接
+	 * @returns {ImagemapLinkToken[]}
+	 */
+	get links() {
+		return this.childNodes.filter(({type}) => type === 'imagemap-link');
+	}
+
 	/**
 	 * @param {string} inner 标签内部wikitext
 	 * @param {accum} accum
@@ -30,13 +39,14 @@ class ImagemapToken extends Token {
 	 */
 	constructor(inner, config = Parser.getConfig(), accum = []) {
 		super(undefined, config, true, accum, {
+			GalleryImageToken: ':', ImagemapLinkToken: ':', SingleLineNoincludeToken: ':', AstText: ':',
 		});
 		if (!inner) {
 			return;
 		}
 		const lines = inner.split('\n'),
 			protocols = new Set(config.protocol.split('|')),
-			SingleLineNoincludeToken = NoincludeToken,
+			SingleLineNoincludeToken = singleLine(NoincludeToken),
 			fallback = /** @param {string} line 一行文本 */ line => {
 				super.insertAt(new SingleLineNoincludeToken(line, config, accum));
 			};
@@ -51,13 +61,14 @@ class ImagemapToken extends Token {
 					title = this.normalizeTitle(file, 0, true);
 				if (title.valid && !title.interwiki && title.ns === 6) {
 					const token = new GalleryImageToken(
-						file, options.length > 0 ? options.join('|') : undefined, title, config, accum,
+						file, options.length > 0 ? options.join('|') : undefined, config, accum,
 					);
 					token.type = 'imagemap-image';
 					super.insertAt(token);
 					first = false;
 					continue;
 				} else {
+					Parser.error('<imagemap>标签内必须先包含一张合法图片！', line);
 					error = true;
 				}
 			} else if (line.trim().split(/[\t ]/u)[0] === 'desc') {
@@ -72,7 +83,7 @@ class ImagemapToken extends Token {
 					if (title.valid) {
 						super.insertAt(new ImagemapLinkToken(
 							line.slice(0, i),
-							[...mtIn.slice(1), title],
+							mtIn.slice(1),
 							substr.slice(substr.indexOf(']]') + 2),
 							config,
 							accum,
@@ -101,6 +112,7 @@ class ImagemapToken extends Token {
 
 	/**
 	 * @override
+	 * @param {string} selector
 	 */
 	toString(selector) {
 		return super.toString(selector, '\n');
@@ -116,11 +128,16 @@ class ImagemapToken extends Token {
 		return 1;
 	}
 
+	/** @override */
+	print() {
+		return super.print({sep: '\n'});
+	}
+
 	/**
 	 * @override
 	 * @param {number} start 起始位置
 	 */
-	lint(start = 0) {
+	lint(start = this.getAbsoluteIndex()) {
 		const errors = super.lint(start),
 			rect = {start, ...this.getRootNode().posFromIndex(start)};
 		if (this.image) {
@@ -128,13 +145,55 @@ class ImagemapToken extends Token {
 				...this.childNodes.filter(child => {
 					const str = String(child).trim();
 					return child.type === 'noinclude' && str && str[0] !== '#';
-				}).map(child => generateForChild(child, rect, '无效的<imagemap>链接')),
+				}).map(child => generateForChild(child, rect, 'invalid link in <imagemap>')),
 			);
 		} else {
-			errors.push(generateForSelf(this, rect, '缺少图片的<imagemap>'));
+			errors.push(generateForSelf(this, rect, '<imagemap> without an image'));
 		}
 		return errors;
 	}
+
+	/**
+	 * @override
+	 * @template {string|Token} T
+	 * @param {T} token 待插入的节点
+	 * @param {number} i 插入位置
+	 * @throws `Error` 当前缺少合法图片
+	 * @throws `RangeError` 已有一张合法图片
+	 */
+	insertAt(token, i = 0) {
+		const {image} = this;
+		if (!image && (token.type === 'imagemap-link' || token.type === 'text')) {
+			throw new Error('当前缺少一张合法图片！');
+		} else if (image && token.type === 'imagemap-image') {
+			throw new RangeError('已有一张合法图片！');
+		}
+		return super.insertAt(token, i);
+	}
+
+	/**
+	 * @override
+	 * @param {number} i 移除位置
+	 * @throws `Error` 禁止移除图片
+	 */
+	removeAt(i) {
+		const child = this.childNodes[i];
+		if (child.type === 'imagemap-image') {
+			throw new Error('禁止移除<imagemap>内的图片！');
+		}
+		return super.removeAt(i);
+	}
+
+	/** @override */
+	cloneNode() {
+		const cloned = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new ImagemapToken(undefined, this.getAttribute('config'));
+			token.append(...cloned);
+			return token;
+		});
+	}
 }
 
+Parser.classes.ImagemapToken = __filename;
 module.exports = ImagemapToken;

package/src/imagemapLink.js

@@ -1,6 +1,9 @@
 'use strict';
 
 const Title = require('../lib/title'),
+	fixedToken = require('../mixin/fixedToken'),
+	singleLine = require('../mixin/singleLine'),
+	Parser = require('..'),
 	Token = require('.'),
 	NoincludeToken = require('./nowiki/noinclude'),
 	LinkToken = require('./link'),
@@ -10,9 +13,17 @@ const Title = require('../lib/title'),
  * `<imagemap>`内的链接
  * @classdesc `{childNodes: [AstText, LinkToken|ExtLinkToken, NoincludeToken]}`
  */
-class ImagemapLinkToken extends Token {
+class ImagemapLinkToken extends fixedToken(singleLine(Token)) {
 	type = 'imagemap-link';
 
+	/**
+	 * 内外链接
+	 * @this {{childNodes: (LinkToken|ExtLinkToken)[]}}
+	 */
+	get link() {
+		return this.childNodes[1].link;
+	}
+
 	/**
 	 * @param {string} pre 链接前的文本
 	 * @param {[string, string, string|Title]} linkStuff 内外链接
@@ -20,10 +31,11 @@ class ImagemapLinkToken extends Token {
 	 * @param {accum} accum
 	 */
 	constructor(pre, linkStuff, post, config, accum) {
-		const SomeLinkToken = linkStuff[2] instanceof Title ? LinkToken : ExtLinkToken;
+		const SomeLinkToken = linkStuff.length === 2 ? LinkToken : ExtLinkToken;
 		super(undefined, config, true, accum);
 		this.append(pre, new SomeLinkToken(...linkStuff, config, accum), new NoincludeToken(post, config, accum));
 	}
 }
 
+Parser.classes.ImagemapLinkToken = __filename;
 module.exports = ImagemapLinkToken;