wikiparser-node 0.7.0-b → 0.7.0

package/src/link/category.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const Title = require('../../lib/title'),
+	Parser = require('../..'),
+	LinkToken = require('.');
+
+/**
+ * 分类
+ * @classdesc `{childNodes: [AtomToken, ?Token]}`
+ */
+class CategoryToken extends LinkToken {
+	type = 'category';
+
+	/** 分类排序关键字 */
+	get sortkey() {
+		return this.childNodes[1]?.text()?.replace(
+			/&#(\d+|x[\da-f]+);|\n/gu,
+			/** @param {string} p */
+			(_, p) => p ? String.fromCodePoint(p[0] === 'x' ? parseInt(p.slice(1), 16) : Number(p)) : '',
+		);
+	}
+
+	set sortkey(text) {
+		this.setSortkey(text);
+	}
+
+	/**
+	 * @param {string} link 分类名
+	 * @param {string|undefined} text 排序关键字
+	 * @param {Title} title 分类页面标题对象
+	 * @param {accum} accum
+	 * @param {string} delimiter `|`
+	 */
+	constructor(link, text, title, config = Parser.getConfig(), accum = [], delimiter = '|') {
+		super(link, text, title, config, accum, delimiter);
+		this.seal(['selfLink', 'interwiki', 'setLangLink', 'setFragment', 'asSelfLink', 'pipeTrick'], true);
+	}
+
+	/**
+	 * 设置排序关键字
+	 * @param {string} text 排序关键字
+	 */
+	setSortkey(text) {
+		this.setLinkText(text);
+	}
+}
+
+Parser.classes.CategoryToken = __filename;
+module.exports = CategoryToken;

package/src/link/file.js

@@ -0,0 +1,282 @@
+'use strict';
+
+const {explode, noWrap} = require('../../util/string'),
+	{generateForChild} = require('../../util/lint'),
+	Parser = require('../..'),
+	Title = require('../../lib/title'),
+	LinkToken = require('.'),
+	ImageParameterToken = require('../imageParameter');
+
+const frame = new Set(['manualthumb', 'frameless', 'framed', 'thumbnail']),
+	horizAlign = new Set(['left', 'right', 'center', 'none']),
+	vertAlign = new Set(['baseline', 'sub', 'super', 'top', 'text-top', 'middle', 'bottom', 'text-bottom']);
+
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+class FileToken extends LinkToken {
+	type = 'file';
+
+	/** 图片链接 */
+	get link() {
+		return this.getArg('link')?.link;
+	}
+
+	set link(value) {
+		this.setValue('link', value);
+	}
+
+	/** 图片大小 */
+	get size() {
+		return this.getArg('width')?.size;
+	}
+
+	/** 图片宽度 */
+	get width() {
+		return this.size?.width;
+	}
+
+	set width(width) {
+		const arg = this.getArg('width');
+		if (arg) {
+			arg.width = width;
+		} else {
+			this.setValue('width', width);
+		}
+	}
+
+	/** 图片高度 */
+	get height() {
+		return this.size?.height;
+	}
+
+	set height(height) {
+		const arg = this.getArg('width');
+		if (arg) {
+			arg.height = height;
+		} else {
+			this.setValue('width', `x${height}`);
+		}
+	}
+
+	/**
+	 * @param {string} link 文件名
+	 * @param {string|undefined} text 图片参数
+	 * @param {Title} title 文件标题对象
+	 * @param {accum} accum
+	 * @param {string} delimiter `|`
+	 * @complexity `n`
+	 */
+	constructor(link, text, title, config = Parser.getConfig(), accum = [], delimiter = '|') {
+		super(link, undefined, title, config, accum, delimiter);
+		this.setAttribute('acceptable', {AtomToken: 0, ImageParameterToken: '1:'});
+		this.append(...explode('-{', '}-', '|', text).map(part => new ImageParameterToken(part, config, accum)));
+		this.seal(
+			['selfLink', 'interwiki', 'setLangLink', 'setFragment', 'asSelfLink', 'setLinkText', 'pipeTrick'],
+			true,
+		);
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start),
+			args = this.getAllArgs(),
+			keys = [...new Set(args.map(({name}) => name))],
+			frameKeys = keys.filter(key => frame.has(key)),
+			horizAlignKeys = keys.filter(key => horizAlign.has(key)),
+			vertAlignKeys = keys.filter(key => vertAlign.has(key));
+		if (args.length === keys.length
+			&& frameKeys.length < 2 && horizAlignKeys.length < 2 && vertAlignKeys.length < 2
+		) {
+			return errors;
+		}
+		const rect = {start, ...this.getRootNode().posFromIndex(start)};
+		for (const key of keys) {
+			let relevantArgs = args.filter(({name}) => name === key);
+			if (key === 'caption') {
+				relevantArgs = [
+					...relevantArgs.slice(0, -1).filter(arg => arg.text()),
+					relevantArgs.at(-1),
+				];
+			}
+			if (relevantArgs.length > 1) {
+				errors.push(...relevantArgs.map(arg => generateForChild(arg, rect, `重复的图片${key}参数`)));
+			}
+		}
+		if (frameKeys.size > 1) {
+			errors.push(
+				...args.filter(({name}) => frame.has(name)).map(arg => generateForChild(arg, rect, '冲突的图片框架参数')),
+			);
+		}
+		if (horizAlignKeys.size > 1) {
+			errors.push(
+				...args.filter(({name}) => horizAlign.has(name))
+					.map(arg => generateForChild(arg, rect, '冲突的图片水平对齐参数')),
+			);
+		}
+		if (vertAlignKeys.size > 1) {
+			errors.push(
+				...args.filter(({name}) => vertAlign.has(name))
+					.map(arg => generateForChild(arg, rect, '冲突的图片垂直对齐参数')),
+			);
+		}
+		return errors;
+	}
+
+	/**
+	 * 获取所有图片参数节点
+	 * @returns {ImageParameterToken[]}
+	 */
+	getAllArgs() {
+		return this.childNodes.slice(1);
+	}
+
+	/**
+	 * 获取指定图片参数
+	 * @param {string} key 参数名
+	 * @complexity `n`
+	 */
+	getArgs(key) {
+		return typeof key === 'string'
+			? this.getAllArgs().filter(({name}) => key === name)
+			: this.typeError('getArgs', 'String');
+	}
+
+	/**
+	 * 获取特定类型的图片属性参数节点
+	 * @param {Set<string>} keys 接受的参数名
+	 * @param {type} type 类型名
+	 * @complexity `n`
+	 */
+	#getTypedArgs(keys, type) {
+		const args = this.getAllArgs().filter(({name}) => keys.has(name));
+		if (args.length > 1) {
+			Parser.warn(`图片 ${this.name} 带有 ${args.length} 个${type}参数，只有最后 1 个 ${args[0].name} 会生效！`);
+		}
+		return args;
+	}
+
+	/** 获取图片框架属性参数节点 */
+	getFrameArgs() {
+		return this.#getTypedArgs(frame, '框架');
+	}
+
+	/** 获取图片水平对齐参数节点 */
+	getHorizAlignArgs() {
+		return this.#getTypedArgs(horizAlign, '水平对齐');
+	}
+
+	/** 获取图片垂直对齐参数节点 */
+	getVertAlignArgs() {
+		return this.#getTypedArgs(vertAlign, '垂直对齐');
+	}
+
+	/**
+	 * 获取生效的指定图片参数
+	 * @param {string} key 参数名
+	 * @complexity `n`
+	 */
+	getArg(key) {
+		return this.getArgs(key).at(-1);
+	}
+
+	/**
+	 * 是否具有指定图片参数
+	 * @param {string} key 参数名
+	 * @complexity `n`
+	 */
+	hasArg(key) {
+		return this.getArgs(key).length > 0;
+	}
+
+	/**
+	 * 移除指定图片参数
+	 * @param {string} key 参数名
+	 * @complexity `n`
+	 */
+	removeArg(key) {
+		for (const token of this.getArgs(key)) {
+			this.removeChild(token);
+		}
+	}
+
+	/**
+	 * 获取图片参数名
+	 * @complexity `n`
+	 */
+	getKeys() {
+		return this.getAllArgs().map(({name}) => name);
+	}
+
+	/**
+	 * 获取指定的图片参数值
+	 * @param {string} key 参数名
+	 * @complexity `n`
+	 */
+	getValues(key) {
+		return this.getArgs(key).map(token => token.getValue());
+	}
+
+	/**
+	 * 获取生效的指定图片参数值
+	 * @param {string} key 参数名
+	 * @complexity `n`
+	 */
+	getValue(key) {
+		return this.getArg(key)?.getValue();
+	}
+
+	/**
+	 * 设置图片参数
+	 * @param {string} key 参数名
+	 * @param {string|boolean} value 参数值
+	 * @complexity `n`
+	 * @throws `RangeError` 未定义的图片参数
+	 * @throws `SyntaxError` 非法的参数
+	 */
+	setValue(key, value) {
+		if (typeof key !== 'string') {
+			this.typeError('setValue', 'String');
+		} else if (value === false) {
+			this.removeArg(key);
+			return;
+		}
+		const token = this.getArg(key);
+		value = value === true ? value : String(value);
+		if (token) {
+			token.setValue(value);
+			return;
+		}
+		let syntax = '';
+		const config = this.getAttribute('config');
+		if (key !== 'caption') {
+			syntax = Object.entries(config.img).find(([, name]) => name === key)?.[0];
+			if (!syntax) {
+				throw new RangeError(`未定义的图片参数： ${key}`);
+			}
+		}
+		if (value === true) {
+			if (syntax.includes('$1')) {
+				this.typeError('setValue', 'Boolean');
+			}
+			const newArg = Parser.run(() => new ImageParameterToken(syntax, config));
+			this.insertAt(newArg);
+			return;
+		}
+		const wikitext = `[[File:F|${syntax ? syntax.replace('$1', value) : value}]]`,
+			root = Parser.parse(wikitext, this.getAttribute('include'), 6, config),
+			{length, firstChild: file} = root,
+			{name, type, length: fileLength, lastChild: imageParameter} = file;
+		if (length !== 1 || type !== 'file' || name !== 'File:F' || fileLength !== 2 || imageParameter.name !== key) {
+			throw new SyntaxError(`非法的 ${key} 参数：${noWrap(value)}`);
+		}
+		this.insertAt(imageParameter);
+	}
+}
+
+Parser.classes.FileToken = __filename;
+module.exports = FileToken;

package/src/link/galleryImage.js

@@ -0,0 +1,120 @@
+'use strict';
+
+const {generateForSelf} = require('../../util/lint'),
+	{undo} = require('../../util/debug'),
+	singleLine = require('../../mixin/singleLine'),
+	Title = require('../../lib/title'),
+	Parser = require('../..'),
+	Token = require('..'),
+	FileToken = require('./file');
+
+/**
+ * 图片
+ * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
+ */
+class GalleryImageToken extends singleLine(FileToken) {
+	type = 'gallery-image';
+	#invalid = false;
+
+	/** 图片链接 */
+	get link() {
+		return this.type === 'imagemap-image' ? undefined : super.link;
+	}
+
+	set link(value) {
+		super.link = value;
+	}
+
+	/**
+	 * @param {string} link 图片文件名
+	 * @param {string|undefined} text 图片参数
+	 * @param {Title} title 图片文件标题对象
+	 * @param {accum} accum
+	 */
+	constructor(link, text, title, config = Parser.getConfig(), accum = []) {
+		let token;
+		if (text !== undefined) {
+			token = new Token(text, config, true, accum);
+			token.type = 'temp';
+			for (let n = 1; n < Parser.MAX_STAGE; n++) {
+				token.getAttribute('parseOnce')();
+			}
+			accum.splice(accum.indexOf(token), 1);
+		}
+		super(link, token?.toString(), title, config, accum);
+		this.setAttribute('bracket', false);
+		if (!Object.values(config.img).includes('width')) {
+			this.seal(['size', 'width', 'height'], true);
+		}
+	}
+
+	/**
+	 * @override
+	 * @throws `Error` 非法的内链目标
+	 * @throws `Error` 不可更改命名空间
+	 */
+	afterBuild() {
+		const initImagemap = this.type === 'imagemap-image',
+			titleObj = this.normalizeTitle(String(this.firstChild), initImagemap ? 0 : 6, true, !initImagemap);
+		this.setAttribute('name', titleObj.title);
+		this.#invalid = titleObj.interwiki || titleObj.ns !== 6; // 只用于gallery-image的首次解析
+		const /** @type {AstListener} */ linkListener = (e, data) => {
+			const {prevTarget} = e;
+			if (prevTarget?.type === 'link-target') {
+				const name = String(prevTarget),
+					imagemap = this.type === 'imagemap-image',
+					{title, interwiki, ns, valid} = this.normalizeTitle(name, imagemap ? 0 : 6, true, !imagemap);
+				if (!valid) {
+					undo(e, data);
+					throw new Error(`非法的图片文件名：${name}`);
+				} else if (interwiki || ns !== 6) {
+					undo(e, data);
+					throw new Error(`图片链接不可更改命名空间：${name}`);
+				}
+				this.setAttribute('name', title);
+				this.#invalid = false;
+			}
+		};
+		this.addEventListener(['remove', 'insert', 'replace', 'text'], linkListener);
+	}
+
+	/** @override */
+	getPadding() {
+		return 0;
+	}
+
+	/**
+	 * @override
+	 * @param {number} start 起始位置
+	 */
+	lint(start = 0) {
+		const errors = super.lint(start);
+		if (this.#invalid) {
+			errors.push(generateForSelf(this, {start}, '无效的图库图片'));
+		}
+		return errors;
+	}
+
+	/**
+	 * @override
+	 * @param {string} link 链接目标
+	 * @throws `SyntaxError` 非法的链接目标
+	 */
+	setTarget(link) {
+		link = String(link);
+		const include = this.getAttribute('include'),
+			config = this.getAttribute('config'),
+			root = Parser.parse(`<gallery>${link}</gallery>`, include, 1, config),
+			{length, firstChild: gallery} = root,
+			{type, lastChild: {length: galleryLength, firstChild: image}} = gallery;
+		if (length !== 1 || type !== 'ext' || galleryLength !== 1 || image.type !== 'gallery-image') {
+			throw new SyntaxError(`非法的图库文件名：${link}`);
+		}
+		const {firstChild} = image;
+		image.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
+	}
+}
+
+Parser.classes.GalleryImageToken = __filename;
+module.exports = GalleryImageToken;