wikiploy 1.1.0 → 1.2.2

package/.vscode/launch.json

@@ -7,20 +7,20 @@
 		{
 			"type": "node",
 			"request": "launch",
-			"name": "Run current JS",
+			"name": "Deploy test.js",
 			"skipFiles": [
 				"<node_internals>/**"
 			],
-			"program": "${workspaceFolder}\\${file}"
+			"program": "${workspaceFolder}\\src\\Wiki_bot_test.js"
 		},
 		{
 			"type": "node",
 			"request": "launch",
-			"name": "Deploy test.js",
+			"name": "Run current JS",
 			"skipFiles": [
 				"<node_internals>/**"
 			],
-			"program": "${workspaceFolder}\\src\\Wiki_bot_test.js"
+			"program": "${workspaceFolder}\\${file}"
 		}
 	]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wikiploy",
-	"version": "1.1.0",
+	"version": "1.2.2",
 	"description": "User scripts and gadgets deployment for MediaWiki (Wikipedia).",
 	"main": "src/index.js",
 	"type": "module",

package/src/DeployConfig.js

@@ -6,14 +6,37 @@ export default class DeployConfig {
 	 * @param {DeployConfig} page Edit page (tab).
 	 */
 	constructor(options) {
+		/** Source page. */
 		this.src = options?.src;
+		/** Destination page. */
 		this.dst = options?.dst;
 		if (!this.dst) {
 			this.dst = `~/${this.src}`;
 		}
+		if (this.dst.indexOf('~')===0) {
+			this._dst = this.dst;
+		}
+		/** Wiki site (domain). */
+		this.site = options?.site;
+		if (!this.site || typeof this.site != 'string') {
+			this.site = '';
+		}
+	}
+
+	/** Does this config require a user. */
+	needsUser() {
+		return this._dst ? true : false;
+	}
+	/** Setup user. */
+	setUser(userName) {
+		if (this._dst) {
+			this.dst = this._dst.replace(/^~/, 'User:' + userName);
+			return true;
+		}
+		return false;
 	}
 
-	/** info */
+	/** info. */
 	info() {
 		return `deploy "${this.src}" to "${this.dst}"`;
 	}

package/src/WikiOps.js

@@ -99,11 +99,27 @@ export default class WikiOps {
 	}
 
 	/** Go to url (and wait for it). */
-	async goto(page, url) {
+	async goto(page, url, skipDisarm) {
 		let nav = page.waitForNavigation(); // init wait
 		await page.goto(url);
 		await nav; // wait for url
-		await this.disarmUnloadWarning(page);
+		if (!skipDisarm) {
+			await this.disarmUnloadWarning(page);
+		}
+	}
+
+	/** Read current MW user. */
+	async readUser(page) {
+		let user = await page.evaluate(() => {
+			return mw?.config?.get('wgUserName', '--');
+		});
+		if (!user) {
+			console.warn('problem reading user, too early?');
+		}
+		if (user === '--') {
+			user = false;
+		}
+		return user;
 	}
 
 	/** Change intput's value. */

package/src/Wiki_bot_test.js

@@ -10,12 +10,22 @@ const ployBot = new Wikiploy();
 	const configs = [];
 	configs.push(new DeployConfig({
 		src: 'assets/test.js',
-		dst: 'User:Nux/test-jsbot--test.js',
+		dst: '~/test-jsbot--test.js',
 	}));
 	configs.push(new DeployConfig({
 		src: 'assets/test.css',
-		dst: 'User:Nux/test-jsbot--test.css',
+		dst: '~/test-jsbot--test.css',
 	}));
+	// configs.push(new DeployConfig({
+	// 	src: 'assets/test.js',
+	// 	dst: '~/test-jsbot--test.js',
+	// 	site: 'en.wikipedia.org',
+	// }));
+	// configs.push(new DeployConfig({
+	// 	src: 'assets/test.css',
+	// 	dst: '~/test-jsbot--test.css',
+	// 	site: 'en.wikipedia.org',
+	// }));
 	await ployBot.deploy(configs);
 })().catch(err => {
 	console.error(err);

package/src/Wikiploy.js

@@ -2,6 +2,8 @@ import puppeteer, { Browser } from 'puppeteer'; // v13+
 
 import WikiOps from './WikiOps.js';
 import PageCache from './PageCache.js';
+// eslint-disable-next-line no-unused-vars
+import DeployConfig from './DeployConfig.js';
 
 import { promises as fs } from "fs";	// node v11+
 
@@ -26,12 +28,17 @@ export default class Wikiploy {
 		this.mock = false;
 		/** Wait before close [ms] (or you can set a breakpoint to check stuff). */
 		this.mockSleep = 0;
+		/** Default wiki site (domain). */
+		this.site = 'pl.wikipedia.org';
 
-		/** Browser connection. */
+		/** @private Browser connection. */
 		this._browser = false;
 
-		/** Bot helper. */
+		/** @private Bot helper. */
 		this._bot = new WikiOps(this.cache);
+
+		/** @private Users cache. */
+		this._users = {};
 	}
 
 	/**
@@ -42,7 +49,7 @@ export default class Wikiploy {
 		const bot = this._bot;
 		const browser = await this.init();
 		const page = await bot.openTab(browser);
-		console.log(JSON.stringify(configs));
+		// console.log(JSON.stringify(configs));
 		// main loop
 		for (const config of configs) {
 			await this.save(config, page);
@@ -60,14 +67,18 @@ export default class Wikiploy {
 	async save(config, page) {
 		console.log('[Wikiploy]', config.info());
 		const bot = this._bot;
+		// prepare user
+		if (config.needsUser()) {
+			await this.prepareUser(config, page);
+		}
 		// navigate
-		let url = this.editUrl(config.dst);
+		let url = this.editUrl(config.dst, config);
 		await bot.goto(page, url);
 		// insert the content of the file into the edit field
 		const contents = await fs.readFile(config.src, 'utf8');
 		await bot.fillEdit(page, contents);
 		// edit description
-		const summary = this.preapreSummary(config);
+		const summary = this.prepareSummary(config);
 		await bot.fillSummary(page, summary);
 
 		// save
@@ -79,27 +90,78 @@ export default class Wikiploy {
 		}
 	}
 
+	/**
+	 * Prepare user in config.
+	 * 
+	 * Note! Modifies the config.
+	 * 
+	 * @param {DeployConfig} config Config.
+	 * @param {Page} page
+	 * @private
+	 */
+	async prepareUser(config, page) {
+		const bot = this._bot;
+
+		let site = config.site;
+		// from cache
+		if (site in this._users) {
+			let changed = config.setUser(this._users[site]);
+			return changed;
+		}
+
+		// any page
+		let url = this.liteUrl(config);
+		await bot.goto(page, url, true);
+
+		// read
+		let userName = await bot.readUser(page);
+		if (!userName) {
+			throw 'Unable to read user name. Not authenticated?';
+		}
+
+		// save to cache
+		this._users[site] = userName;
+
+		// finalize
+		let changed = config.setUser(userName);
+		return changed;
+	}
 
 	/**
 	 * Prepare edit summary.
 	 * 
-	 * @param {String} pageTitle Title with namespace.
-	 * @returns {String} Full edit URL.
+	 * @param {DeployConfig} config Config.
+	 * @returns {String} Edit summary.
+	 * @private
+	 */
+	prepareSummary(config) {
+		return '#Wikiploy' + ` ${config.src}`;
+	}
+
+	/**
+	 * Prepare base URL.
+	 * 
+	 * @param {DeployConfig} config Configuration.
+	 * @returns {String} Base URL.
 	 * @private
 	 */
-	preapreSummary(config) {
-		return '[Wikiploy]' + ` ${config.src}`;
+	baseUrl(config) {
+		const site = config.site.length ? config.site : this.site;
+		const origin = `https://${site}`;
+		const baseUrl = `${origin}/w/index.php`;
+		return baseUrl;
 	}
 
 	/**
 	 * Prepare edit URL.
 	 * 
 	 * @param {String} pageTitle Title with namespace.
+	 * @param {DeployConfig} config Configuration.
 	 * @returns {String} Full edit URL.
 	 * @private
 	 */
-	editUrl(pageTitle) {
-		const baseUrl = `https://pl.wikipedia.org/w/index.php`;	// TODO: config/options
+	editUrl(pageTitle, config) {
+		const baseUrl = this.baseUrl(config);
 
 		// common params
 		// note that submit action is not affected by new wikicode editor
@@ -111,6 +173,25 @@ export default class Wikiploy {
 		return baseUrl + '?title=' + encodeURIComponent(pageTitle) + params;
 	}
 	
+	/**
+	 * Prepare URL of some lite page.
+	 * 
+	 * @param {DeployConfig} config Configuration.
+	 * @returns {String} URL within Wiki.
+	 * @private
+	 */
+	liteUrl(config) {
+		const baseUrl = this.baseUrl(config);
+
+		// common params
+		// note that submit action is not affected by new wikicode editor
+		let params = `
+			&useskin=monobook
+		`.replace(/\s+/g, '');
+
+		return baseUrl + '?title=User:Nux/blank.js' + params;
+	}
+
 	/**
 	 * Init browser connection.
 	 * 

package/test/DeployConfig.test.js

@@ -0,0 +1,78 @@
+/* global describe, it */
+import { assert } from 'chai';
+import DeployConfig from '../src/DeployConfig.js';
+
+describe('DeployConfig', function () {
+	
+	describe('init', function () {
+		it('should set src, dst', function () {
+			let config = {
+				src: 'test.src.js',
+				dst: 'User:Nux/test.dst.js',
+			};
+			let result = new DeployConfig(config);
+			console.log(result);
+			assert.equal(result.src, config.src);
+			assert.equal(result.dst, config.dst);
+			// console.log(new DeployConfig({
+			// 	src: 'test.js',
+			// }));
+		});
+		it('should default to home', function () {
+			let config = {
+				src: 'test.js',
+			};
+			let expected = '~/test.js';
+			let result = new DeployConfig(config);
+			console.log(result);
+			assert.equal(result.dst, expected);
+		});
+	});
+
+	describe('setUser', function () {
+		it('should set userName', function () {
+			let config = {
+				src: 'test.js',
+			};
+			let userName = 'Tester';
+			let expected = 'User:Tester/test.js';
+			let result = new DeployConfig(config);
+			result.setUser(userName);
+			console.log(result);
+			assert.equal(result.dst, expected);
+
+
+			result = new DeployConfig({
+				src: 'assets/test.js',
+				dst: '~/test-jsbot--test.js',
+			});
+			result.setUser(userName);
+			console.log(result);
+			assert.isTrue(result.dst.indexOf('~') < 0);
+		});
+		it('should change user', function () {
+			let config = {
+				src: 'test.js',
+			};
+			let userName1 = 'Tester1';
+			let userName2 = 'Tester2';
+			let expected = 'User:Tester2/test.js';
+			let result = new DeployConfig(config);
+			result.setUser(userName1);
+			console.log(result);
+			result.setUser(userName2);
+			console.log(result);
+			assert.equal(result.dst, expected);
+		});
+		it('should keep inner tilde', function () {
+			let config = {
+				src: 'test.js',
+				dst: 'Mediawiki/~test.js',
+			};
+			let userName = 'Tester';
+			let result = new DeployConfig(config);
+			result.setUser(userName);
+			assert.equal(result.dst, config.dst);
+		});
+	});
+});

package/src/test/DeployConfig.test.js

@@ -1,31 +0,0 @@
-/* global describe, it */
-import { assert } from 'chai';
-import DeployConfig from '../DeployConfig.js';
-
-describe('DeployConfig', function () {
-	
-	describe('init', function () {
-		it('should set src, dst', function () {
-			let config = {
-				src: 'test.src.js',
-				dst: 'User:Nux/test.dst.js',
-			};
-			let result = new DeployConfig(config);
-			console.log(result);
-			assert.equal(result.src, config.src);
-			assert.equal(result.dst, config.dst);
-			// console.log(new DeployConfig({
-			// 	src: 'test.js',
-			// }));
-		});
-		it('should default to home', function () {
-			let config = {
-				src: 'test.js',
-			};
-			let expected = '~/test.js';
-			let result = new DeployConfig(config);
-			console.log(result);
-			assert.equal(result.dst, expected);
-		});
-	});
-});