wikiparser-node 0.7.0-m → 0.7.0

package/src/link/file.js

@@ -1,8 +1,9 @@
 'use strict';
 
-const {explode} = require('../../util/string'),
+const {explode, noWrap} = require('../../util/string'),
 	{generateForChild} = require('../../util/lint'),
 	Parser = require('../..'),
+	Title = require('../../lib/title'),
 	LinkToken = require('.'),
 	ImageParameterToken = require('../imageParameter');
 
@@ -17,16 +18,64 @@ const frame = new Set(['manualthumb', 'frameless', 'framed', 'thumbnail']),
 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,
+		);
 	}
 
 	/**
@@ -92,7 +141,9 @@ class FileToken extends LinkToken {
 	 * @complexity `n`
 	 */
 	getArgs(key) {
-		return this.getAllArgs().filter(({name}) => key === name);
+		return typeof key === 'string'
+			? this.getAllArgs().filter(({name}) => key === name)
+			: this.typeError('getArgs', 'String');
 	}
 
 	/**
@@ -103,6 +154,9 @@ class FileToken extends LinkToken {
 	 */
 	#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;
 	}
 
@@ -120,6 +174,109 @@ class FileToken extends LinkToken {
 	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

@@ -1,6 +1,9 @@
 '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');
@@ -9,13 +12,23 @@ const {generateForSelf} = require('../../util/lint'),
  * 图片
  * @classdesc `{childNodes: [AtomToken, ...ImageParameterToken]}`
  */
-class GalleryImageToken extends FileToken {
+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 = []) {
@@ -30,15 +43,39 @@ class GalleryImageToken extends FileToken {
 		}
 		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 */
@@ -57,6 +94,27 @@ class GalleryImageToken extends FileToken {
 		}
 		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;

package/src/link/index.js

@@ -1,7 +1,10 @@
 'use strict';
 
 const {generateForChild} = require('../../util/lint'),
+	{noWrap} = require('../../util/string'),
+	{undo} = require('../../util/debug'),
 	Parser = require('../..'),
+	Title = require('../../lib/title'),
 	AstText = require('../../lib/text'),
 	Token = require('..'),
 	AtomToken = require('../atom');
@@ -17,36 +20,127 @@ class LinkToken extends Token {
 	#fragment = '';
 	#encoded = false;
 
+	/** 完整链接，和FileToken保持一致 */
+	get link() {
+		return String(this.#getTitle());
+	}
+
+	set link(link) {
+		this.setTarget(link);
+	}
+
+	/** 是否链接到自身 */
+	get selfLink() {
+		return !this.#getTitle().title;
+	}
+
+	set selfLink(selfLink) {
+		if (selfLink === true) {
+			this.asSelfLink();
+		}
+	}
+
+	/** fragment */
+	get fragment() {
+		return this.#getTitle().fragment;
+	}
+
+	set fragment(fragment) {
+		this.setFragment(fragment);
+	}
+
+	/** interwiki */
+	get interwiki() {
+		return this.#getTitle().interwiki;
+	}
+
+	set interwiki(interwiki) {
+		if (typeof interwiki !== 'string') {
+			this.typeError('set interwiki', 'String');
+		}
+		const {prefix, main, fragment} = this.#getTitle(),
+			link = `${interwiki}:${prefix}${main}${fragment && '#'}${fragment}`;
+		if (interwiki && !this.isInterwiki(link)) {
+			throw new RangeError(`${interwiki} 不是合法的跨维基前缀!`);
+		}
+		this.setTarget(link);
+	}
+
+	/** 链接显示文字 */
+	get innerText() {
+		if (this.type === 'link') {
+			return this.length > 1
+				? this.lastChild.text()
+				: this.firstChild.text().replace(/^\s*:/u, '');
+		}
+		return undefined;
+	}
+
 	/**
 	 * @param {string} link 链接标题
 	 * @param {string|undefined} linkText 链接显示文字
+	 * @param {Title} title 链接标题对象
 	 * @param {accum} accum
 	 * @param {string} delimiter `|`
 	 */
 	constructor(link, linkText, title, config = Parser.getConfig(), accum = [], delimiter = '|') {
 		super(undefined, config, true, accum, {
+			AtomToken: 0, Token: 1,
 		});
 		this.insertAt(new AtomToken(link, 'link-target', config, accum, {
+			'Stage-2': ':', '!ExtToken': '', '!HeadingToken': '',
 		}));
 		if (linkText !== undefined) {
 			const inner = new Token(linkText, config, true, accum, {
+				'Stage-5': ':', ConverterToken: ':',
 			});
 			inner.type = 'link-text';
 			this.insertAt(inner.setAttribute('stage', Parser.MAX_STAGE - 1));
 		}
 		this.#delimiter = delimiter;
+		this.getAttribute('protectChildren')(0);
 	}
 
 	/**
 	 * @override
+	 * @throws `Error` 非法的内链目标
+	 * @throws `Error` 不可更改命名空间
 	 */
 	afterBuild() {
 		const titleObj = this.normalizeTitle(this.firstChild.text(), 0, false, true, true);
+		this.setAttribute('name', titleObj.title);
 		this.#fragment = titleObj.fragment;
 		this.#encoded = titleObj.encoded;
 		if (this.#delimiter?.includes('\0')) {
 			this.#delimiter = this.getAttribute('buildFromStr')(this.#delimiter, 'string');
 		}
+		const /** @type {AstListener} */ linkListener = (e, data) => {
+			const {prevTarget} = e;
+			if (prevTarget?.type === 'link-target') {
+				const name = prevTarget.text(),
+					{title, interwiki, ns, valid, fragment, encoded} = this.normalizeTitle(name, 0, false, true, true);
+				if (!valid) {
+					undo(e, data);
+					throw new Error(`非法的内链目标：${name}`);
+				} else if (this.type === 'category' && (interwiki || ns !== 14)
+					|| this.type === 'file' && (interwiki || ns !== 6)
+				) {
+					undo(e, data);
+					throw new Error(`${this.type === 'file' ? '文件' : '分类'}链接不可更改命名空间：${name}`);
+				} else if (this.type === 'link' && !interwiki && (ns === 6 || ns === 14) && name.trim()[0] !== ':') {
+					const /** @type {{firstChild: AstText}} */ {firstChild} = prevTarget;
+					if (firstChild.type === 'text') {
+						firstChild.insertData(0, ':');
+					} else {
+						prevTarget.prepend(':');
+					}
+				}
+				this.setAttribute('name', title);
+				this.#fragment = fragment;
+				this.#encoded = encoded;
+			}
+		};
+		this.addEventListener(['remove', 'insert', 'replace', 'text'], linkListener);
 	}
 
 	/**
@@ -65,10 +159,11 @@ class LinkToken extends Token {
 
 	/**
 	 * @override
+	 * @param {string} selector
 	 */
 	toString(selector) {
 		const str = super.toString(selector, this.#delimiter);
-		return this.#bracket ? `[[${str}]]` : str;
+		return this.#bracket && !(selector && this.matches(selector)) ? `[[${str}]]` : str;
 	}
 
 	/** @override */
@@ -87,6 +182,11 @@ class LinkToken extends Token {
 		return this.#delimiter.length;
 	}
 
+	/** @override */
+	print() {
+		return super.print(this.#bracket ? {pre: '[[', post: ']]', sep: this.#delimiter} : {sep: this.#delimiter});
+	}
+
 	/**
 	 * @override
 	 * @param {number} start 起始位置
@@ -110,6 +210,174 @@ class LinkToken extends Token {
 		}
 		return errors;
 	}
+
+	/** 生成Title对象 */
+	#getTitle() {
+		return this.normalizeTitle(this.firstChild.text(), 0, false, true, true);
+	}
+
+	/**
+	 * @override
+	 * @this {LinkToken & {constructor: typeof LinkToken}}
+	 */
+	cloneNode() {
+		const [link, ...linkText] = this.cloneChildNodes();
+		return Parser.run(() => {
+			const token = new this.constructor('', undefined, this.#getTitle(), this.getAttribute('config'));
+			token.firstChild.safeReplaceWith(link);
+			token.append(...linkText);
+			token.afterBuild();
+			return token;
+		});
+	}
+
+	/**
+	 * 设置链接目标
+	 * @param {string} link 链接目标
+	 * @throws `SyntaxError` 非法的链接目标
+	 */
+	setTarget(link) {
+		link = String(link);
+		if (this.type === 'link' && !/^\s*[:#]/u.test(link)) {
+			link = `:${link}`;
+		}
+		const root = Parser.parse(`[[${link}]]`, this.getAttribute('include'), 6, this.getAttribute('config')),
+			{length, firstChild: wikiLink} = root,
+			{type, firstChild, length: linkLength} = wikiLink;
+		if (length !== 1 || type !== this.type || linkLength !== 1) {
+			const msgs = {link: '内链', file: '文件链接', category: '分类'};
+			throw new SyntaxError(`非法的${msgs[this.type]}目标：${link}`);
+		}
+		wikiLink.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
+	}
+
+	/**
+	 * 设置跨语言链接
+	 * @param {string} lang 语言前缀
+	 * @param {string} link 页面标题
+	 * @throws `SyntaxError` 非法的跨语言链接
+	 */
+	setLangLink(lang, link) {
+		if (typeof lang !== 'string') {
+			this.typeError('setLangLink', 'String');
+		}
+		link = String(link).trim();
+		const [char] = link;
+		if (char === '#') {
+			throw new SyntaxError('跨语言链接不能仅为fragment！');
+		} else if (char === ':') {
+			link = link.slice(1);
+		}
+		const root = Parser.parse(`[[${lang}:${link}]]`, this.getAttribute('include'), 6, this.getAttribute('config')),
+			/** @type {Token & {firstChild: LinkToken}} */ {length, firstChild: wikiLink} = root,
+			{type, length: linkLength, interwiki, firstChild} = wikiLink;
+		if (length !== 1 || type !== 'link' || linkLength !== 1 || interwiki !== lang.toLowerCase()) {
+			throw new SyntaxError(`非法的跨语言链接目标：${lang}:${link}`);
+		}
+		wikiLink.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
+	}
+
+	/**
+	 * 设置fragment
+	 * @param {string} fragment fragment
+	 * @param {boolean} page 是否是其他页面
+	 * @throws `SyntaxError` 非法的fragment
+	 */
+	#setFragment(fragment, page = true) {
+		fragment = String(fragment).replace(/[<>[\]#|=]/gu, p => encodeURIComponent(p));
+		const include = this.getAttribute('include'),
+			config = this.getAttribute('config'),
+			root = Parser.parse(`[[${page ? `:${this.name}` : ''}#${fragment}]]`, include, 6, config),
+			{length, firstChild: wikiLink} = root,
+			{type, length: linkLength, firstChild} = wikiLink;
+		if (length !== 1 || type !== 'link' || linkLength !== 1) {
+			throw new SyntaxError(`非法的 fragment：${fragment}`);
+		} else if (page) {
+			Parser.warn(`${this.constructor.name}.setFragment 方法会同时规范化页面名！`);
+		}
+		wikiLink.destroy(true);
+		this.firstChild.safeReplaceWith(firstChild);
+	}
+
+	/**
+	 * 设置fragment
+	 * @param {string} fragment fragment
+	 */
+	setFragment(fragment) {
+		this.#setFragment(fragment);
+	}
+
+	/**
+	 * 修改为到自身的链接
+	 * @param {string} fragment fragment
+	 * @throws `RangeError` 空fragment
+	 */
+	asSelfLink(fragment = this.fragment) {
+		fragment = String(fragment);
+		if (!fragment.trim()) {
+			throw new RangeError(`${this.constructor.name}.asSelfLink 方法必须指定非空的 fragment！`);
+		}
+		this.#setFragment(fragment, false);
+	}
+
+	/**
+	 * 设置链接显示文字
+	 * @param {string} linkText 链接显示文字
+	 * @throws `SyntaxError` 非法的链接显示文字
+	 */
+	setLinkText(linkText = '') {
+		linkText = String(linkText);
+		let lastChild;
+		const config = this.getAttribute('config');
+		if (linkText) {
+			const root = Parser.parse(`[[${
+					this.type === 'category' ? 'Category:' : ''
+				}L|${linkText}]]`, this.getAttribute('include'), 6, config),
+				{length, firstChild: wikiLink} = root;
+			if (length !== 1 || wikiLink.type !== this.type || wikiLink.length !== 2) {
+				throw new SyntaxError(`非法的${this.type === 'link' ? '内链文字' : '分类关键字'}：${noWrap(linkText)}`);
+			}
+			({lastChild} = wikiLink);
+		} else {
+			lastChild = Parser.run(() => new Token('', config));
+			lastChild.setAttribute('stage', 7).type = 'link-text';
+		}
+		if (this.length === 1) {
+			this.insertAt(lastChild);
+		} else {
+			this.lastChild.safeReplaceWith(lastChild);
+		}
+	}
+
+	/**
+	 * 自动生成管道符后的链接文字
+	 * @throws `Error` 带有"#"或"%"时不可用
+	 */
+	pipeTrick() {
+		const linkText = this.firstChild.text();
+		if (linkText.includes('#') || linkText.includes('%')) {
+			throw new Error('Pipe trick 不能用于带有"#"或"%"的场合！');
+		}
+		const m1 = /^:?(?:[ \w\x80-\xFF-]+:)?([^(]+)\(.+\)$/u.exec(linkText);
+		if (m1) {
+			this.setLinkText(m1[1].trim());
+			return;
+		}
+		const m2 = /^:?(?:[ \w\x80-\xFF-]+:)?([^（]+)（.+）$/u.exec(linkText);
+		if (m2) {
+			this.setLinkText(m2[1].trim());
+			return;
+		}
+		const m3 = /^:?(?:[ \w\x80-\xFF-]+:)?(.+?)(?:(?<!\()\(.+\))?(?:, |，|، )./u.exec(linkText);
+		if (m3) {
+			this.setLinkText(m3[1].trim());
+			return;
+		}
+		this.setLinkText(linkText);
+	}
 }
 
+Parser.classes.LinkToken = __filename;
 module.exports = LinkToken;