split out large/important functions for testing

navigator-vue/src/functions/getDirEntryObjects.js

@@ -0,0 +1,128 @@
+import { useSpawn, errorString } from "@45drives/cockpit-helpers";
+
+/**
+* Callback for handling errors during parsing of `dir` output lines
+* 
+* @callback getDirEntryObjectsFailCallback
+* @param {String} message - what went wrong
+*/
+
+/**
+ * @callback ByteFormatter
+ * @param {Number} number - Total number of bytes to format
+ * @param {Number=} factor - either 1000 or 1024
+ * @param {Object=} options - options
+ * @returns {String|String[]}
+ */
+
+/**
+ * Object representing file system entry
+ * 
+ * @typedef {Object} DirectoryEntry
+ * @property {String} name - File/directory name
+ * @property {String} path - Full path to entry
+ * @property {Number} mode - File mode (number)
+ * @property {String} modeStr - Human readable file mode
+ * @property {Number} size - File size in bytes
+ * @property {String} sizeHuman - Human readable size
+ * @property {String} owner - File owner
+ * @property {String} group - File group
+ * @property {Date} ctime - Creation time
+ * @property {Date} mtime - Last Modified time
+ * @property {Date} atime - Last Accessed time
+ * @property {String} type - Type of inode returned by stat
+ * @property {Object} target - Object for symlink target
+ * @property {String} target.rawPath - Symlink target path directly grabbed from stat
+ * @property {String} target.path - Resolved symlink target path
+ * @property {Boolean} selected - Whether or not the user has selected this entry in the browser
+ */
+
+/**
+ * Get list of directory entry objects from list of directory entry names
+ * 
+ * @param {String[]} dirListing - List of entry names
+ * @param {String} cwd - Working directory to run stat in
+ * @param {getDirEntryObjectsFailCallback} failCallback - Callback function for handling errors, receives {String} message
+ * @param {ByteFormatter} byteFormatter - Function to format bytes
+ * @returns {Promise<DirectoryEntry[]>} Array of DirectoryEntry objects
+ */
+export default async function getDirEntryObjects(dirListing, cwd, failCallback, byteFormatter = cockpit.format_bytes) {
+	const US = '\x1F';
+	const RS = '\x1E';
+	const fields = [
+		'%n', // path
+		'%f', // mode (raw hex)
+		'%A', // modeStr
+		'%s', // size
+		'%U', // owner
+		'%G', // group
+		'%W', // ctime
+		'%Y', // mtime
+		'%X', // atime
+		'%F', // type
+		'%N', // quoted name with symlink
+	]
+	return dirListing.length
+		? parseRawEntryStats(
+			(
+				await useSpawn([
+					'stat',
+					`--printf=${fields.join(US)}${RS}`,
+					...dirListing
+				], { superuser: 'try', directory: cwd }
+				)
+					.promise()
+					.catch(state => state) // ignore errors
+			).stdout, cwd, failCallback, byteFormatter)
+		: [];
+}
+
+/**
+ * Parse raw output of `stat` call from {@link getDirEntryObjects()}
+ * 
+ * @param {String} raw - Raw output of `stat` call from {@link getDirEntryObjects()}
+ * @param {String} cwd - Path to working directory to run stat in
+ * @param {getDirEntryObjectsFailCallback} failCallback - Callback function for handling errors, receives {String} message
+ * @param {ByteFormatter} byteFormatter - Function to format bytes
+ * @returns {DirectoryEntry[]}
+ */
+function parseRawEntryStats(raw, cwd, failCallback, byteFormatter = cockpit.format_bytes) {
+	const US = '\x1F';
+	const RS = '\x1E';
+	return raw.split(RS)
+		.filter(record => record) // remove empty lines
+		.map(record => {
+			try {
+				let [name, mode, modeStr, size, owner, group, ctime, mtime, atime, type, symlinkStr] = record.split(US);
+				[size, ctime, mtime, atime] = [size, ctime, mtime, atime].map(num => parseInt(num));
+				[ctime, mtime, atime] = [ctime, mtime, atime].map(ts => ts ? new Date(ts * 1000) : null);
+				mode = parseInt(mode, 16);
+				const entry = {
+					name,
+					path: `${cwd}/${name}`.replace(/\/+/g, '/'),
+					mode,
+					modeStr,
+					size,
+					sizeHuman: byteFormatter(size, 1000).replace(/(?<!B)$/, ' B'),
+					owner,
+					group,
+					ctime,
+					mtime,
+					atime,
+					type,
+					target: {},
+					selected: false,
+				};
+				if (type === 'symbolic link') {
+					entry.target.rawPath = [
+						...symlinkStr.split(/\s*->\s*/)[1].trim().matchAll(/\$?'([^']+)'/g)
+					].map(group => JSON.parse(`"${group[1]}"`)).join('');
+					entry.target.path = entry.target.rawPath.replace(/^(?!\/)/, `${cwd}/`);
+				}
+				return entry;
+			} catch (error) {
+				failCallback(errorString(error) + `\ncaused by: ${record}`);
+				return null;
+			}
+		}).filter(entry => entry !== null)
+}

navigator-vue/src/functions/getDirListing.js

@@ -0,0 +1,52 @@
+import { useSpawn, errorString } from "@45drives/cockpit-helpers";
+
+/**
+ * Callback for handling errors during parsing of `dir` output lines
+ * 
+ * @callback getDirListingFailCallback
+ * @param {String} message - what went wrong
+ */
+
+/**
+ * Get list of directory entry names for given path
+ * 
+ * @param {String} path - Directory path to list
+ * @param {getDirListingFailCallback} failCallback - Callback function for handling errors, receives {String} message
+ * @returns {Promise<String[]>}
+ */
+export default async function getDirListing(path, failCallback) {
+	return parseRawDirListing(
+		(
+			await useSpawn([
+				'dir',
+				'--almost-all',
+				'--dereference-command-line-symlink-to-dir',
+				'--quoting-style=c',
+				'-1',
+				path
+			], { superuser: 'try' }).promise()
+		).stdout,
+		failCallback
+	);
+}
+
+/**
+ * Parse raw output of `dir` call from {@link getDirListing()}
+ * 
+ * @param {String} raw - Raw output of `dir` from {@link getDirListing()}
+ * @param {getDirListingFailCallback} failCallback - Callback function for handling errors, receives {String} message
+ * @returns {String[]}
+ */
+function parseRawDirListing(raw, failCallback) {
+	return raw.split('\n')
+		.filter(name => name)
+		.map(escaped => {
+			try {
+				return JSON.parse(escaped);
+			} catch (error) {
+				failCallback(`${errorString(error)}\ncaused by ${escaped}`);
+				return null;
+			}
+		})
+		.filter(entry => entry !== null);
+}