generated from ztimson/template
Compare commits
5
Commits
0.3.3
..
fee24e97cd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fee24e97cd | ||
|
|
50c4b2ac21 | ||
|
|
499d83c9be | ||
|
|
0f8637f913 | ||
|
|
57cb9c8bd1 |
+46
-14
@@ -2,8 +2,10 @@ import fs from 'node:fs';
|
|||||||
import os from 'node:os';
|
import os from 'node:os';
|
||||||
import path from 'node:path';
|
import path from 'node:path';
|
||||||
import https from 'node:https';
|
import https from 'node:https';
|
||||||
import {execFileSync} from 'node:child_process';
|
|
||||||
import {fileURLToPath} from 'node:url';
|
import {fileURLToPath} from 'node:url';
|
||||||
|
import {createWriteStream} from 'node:fs';
|
||||||
|
import AdmZip from 'adm-zip';
|
||||||
|
import * as tar from 'tar';
|
||||||
|
|
||||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||||
|
|
||||||
@@ -11,9 +13,8 @@ const VERSION = '3.8.1';
|
|||||||
const BASE_URL = 'https://download.kiwix.org/release/kiwix-tools';
|
const BASE_URL = 'https://download.kiwix.org/release/kiwix-tools';
|
||||||
const PLATFORM_MAP = {linux: 'linux', darwin: 'macos', win32: 'win'};
|
const PLATFORM_MAP = {linux: 'linux', darwin: 'macos', win32: 'win'};
|
||||||
|
|
||||||
const BIN_DIR = path.join(__dirname, '..', 'bin'); // project root/bin
|
const BIN_DIR = path.join(__dirname, '..', 'bin');
|
||||||
|
|
||||||
/** Download a file, following redirects. */
|
|
||||||
function download(url, dest) {
|
function download(url, dest) {
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
const file = fs.createWriteStream(dest);
|
const file = fs.createWriteStream(dest);
|
||||||
@@ -31,7 +32,6 @@ function download(url, dest) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Recursively chmod all files under a directory. */
|
|
||||||
function chmodRecursive(dir, mode) {
|
function chmodRecursive(dir, mode) {
|
||||||
for (const entry of fs.readdirSync(dir, {withFileTypes: true})) {
|
for (const entry of fs.readdirSync(dir, {withFileTypes: true})) {
|
||||||
const full = path.join(dir, entry.name);
|
const full = path.join(dir, entry.name);
|
||||||
@@ -56,20 +56,52 @@ async function downloadAndExtract() {
|
|||||||
await fs.promises.mkdir(BIN_DIR, {recursive: true});
|
await fs.promises.mkdir(BIN_DIR, {recursive: true});
|
||||||
|
|
||||||
console.log('Extracting...');
|
console.log('Extracting...');
|
||||||
execFileSync('tar', ['-xf', archivePath, '-C', BIN_DIR]); // bsdtar handles zip too
|
|
||||||
|
|
||||||
// Archives (tar.gz) may wrap contents in a subdirectory - flatten it into BIN_DIR
|
// Use npm-installable libraries for extraction
|
||||||
const wrapperDir = (await fs.promises.readdir(BIN_DIR, {withFileTypes: true}))
|
if (archiveName.endsWith('.zip')) {
|
||||||
.find(e => e.isDirectory() && e.name.startsWith('kiwix-tools_'));
|
const zip = new AdmZip(archivePath);
|
||||||
if (wrapperDir) {
|
const zipName = zip.getZipName(); // e.g. "kiwix-tools_linux-x86_64-3.8.1"
|
||||||
const wrapperPath = path.join(BIN_DIR, wrapperDir.name);
|
const extractDir = path.join(BIN_DIR, zipName);
|
||||||
for (const entry of await fs.promises.readdir(wrapperPath)) {
|
|
||||||
await fs.promises.rename(path.join(wrapperPath, entry), path.join(BIN_DIR, entry));
|
await zip.extractAllToAsync(extractDir, true);
|
||||||
|
|
||||||
|
// Flatten the extracted directory into BIN_DIR
|
||||||
|
if (fs.existsSync(extractDir)) {
|
||||||
|
for (const entry of await fs.promises.readdir(extractDir)) {
|
||||||
|
const src = path.join(extractDir, entry);
|
||||||
|
const dest = path.join(BIN_DIR, entry);
|
||||||
|
await fs.promises.rename(src, dest);
|
||||||
|
}
|
||||||
|
await fs.promises.rmdir(extractDir);
|
||||||
}
|
}
|
||||||
await fs.promises.rmdir(wrapperPath);
|
} else if (archiveName.endsWith('.tar.gz')) {
|
||||||
|
// Extract to a temp dir first to check for subdirectory wrapper
|
||||||
|
const extractDir = path.join(tmpDir, 'extracted');
|
||||||
|
await fs.promises.mkdir(extractDir, {recursive: true});
|
||||||
|
|
||||||
|
await tar.extract({
|
||||||
|
file: archivePath,
|
||||||
|
cwd: extractDir,
|
||||||
|
silent: false
|
||||||
|
});
|
||||||
|
|
||||||
|
const list = await fs.promises.readdir(extractDir, {withFileTypes: true});
|
||||||
|
const wrapper = list.find(e => e.isDirectory() && e.name.startsWith('kiwix-tools_'));
|
||||||
|
const finalDir = wrapper ? path.join(extractDir, wrapper.name) : extractDir;
|
||||||
|
|
||||||
|
// Flatten into BIN_DIR
|
||||||
|
for (const entry of await fs.promises.readdir(finalDir)) {
|
||||||
|
const src = path.join(finalDir, entry);
|
||||||
|
const dest = path.join(BIN_DIR, entry);
|
||||||
|
await fs.promises.rename(src, dest);
|
||||||
|
}
|
||||||
|
|
||||||
|
await fs.promises.rmdir(finalDir);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (process.platform !== 'win32') chmodRecursive(BIN_DIR, 0o755);
|
if (process.platform !== 'win32') {
|
||||||
|
chmodRecursive(BIN_DIR, 0o755);
|
||||||
|
}
|
||||||
|
|
||||||
await fs.promises.rm(tmpDir, {recursive: true, force: true});
|
await fs.promises.rm(tmpDir, {recursive: true, force: true});
|
||||||
console.log('Installed to:', BIN_DIR);
|
console.log('Installed to:', BIN_DIR);
|
||||||
|
|||||||
+4
-2
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@ztimson/zim-utils",
|
"name": "@ztimson/zim-utils",
|
||||||
"version": "0.3.3",
|
"version": "0.3.5",
|
||||||
"description": "Native, dependency-light ZIM archive reader/searcher and Kiwix catalog downloader for Node.js",
|
"description": "Native, dependency-light ZIM archive reader/searcher and Kiwix catalog downloader for Node.js",
|
||||||
"author": "Zak Timson",
|
"author": "Zak Timson",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
@@ -17,6 +17,8 @@
|
|||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@ztimson/utils": "^0.30.8",
|
"@ztimson/utils": "^0.30.8",
|
||||||
"lzma1": "^0.3.0",
|
"lzma1": "^0.3.0",
|
||||||
"zstd-codec": "^0.1.5"
|
"tar": "^7.4.3",
|
||||||
|
"zstd-codec": "^0.1.5",
|
||||||
|
"adm-zip": "^0.5.16"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
+4
-3
@@ -79,9 +79,10 @@ export class ZimManager {
|
|||||||
|
|
||||||
async delete(nameOrFile) {
|
async delete(nameOrFile) {
|
||||||
const local = await this.list();
|
const local = await this.list();
|
||||||
const match = local.find(l => l.name === nameOrFile || l.file === nameOrFile);
|
const match = local.find(l => l.name === nameOrFile || l.href === nameOrFile);
|
||||||
if (!match) throw new Error(`ZIM not found locally: ${nameOrFile}`);
|
if (!match) throw new Error(`ZIM not found locally: ${nameOrFile}`);
|
||||||
await fs.promises.rm(path.join(this.#dir, match.file), {force: true});
|
const file = match.href + (match.href.endsWith('.zim') ? '' : '.zim');
|
||||||
|
await fs.promises.rm(path.join(this.#dir, file), {force: true});
|
||||||
const server = await this.#ensureServer();
|
const server = await this.#ensureServer();
|
||||||
await server.reload();
|
await server.reload();
|
||||||
return {file: match.file, status: 'deleted'};
|
return {file: match.file, status: 'deleted'};
|
||||||
@@ -89,9 +90,9 @@ export class ZimManager {
|
|||||||
|
|
||||||
/** Downloads/updates a single ZIM by direct href, matching against any existing local copy by name. */
|
/** Downloads/updates a single ZIM by direct href, matching against any existing local copy by name. */
|
||||||
async download(href, {force = false} = {}) {
|
async download(href, {force = false} = {}) {
|
||||||
await fs.promises.mkdir(this.#dir, {recursive: true});
|
|
||||||
const {url: finalUrl} = await this.#resolveUrl(href);
|
const {url: finalUrl} = await this.#resolveUrl(href);
|
||||||
const filename = path.basename(new URL(finalUrl).pathname).replace(/\.meta4$/i, '');
|
const filename = path.basename(new URL(finalUrl).pathname).replace(/\.meta4$/i, '');
|
||||||
|
await fs.promises.mkdir(this.#dir, {recursive: true});
|
||||||
const name = filename.replace(/\.zim$/i, '').replace(/_\d{4}-\d{2}(?:_\d+)?$/, '');
|
const name = filename.replace(/\.zim$/i, '').replace(/_\d{4}-\d{2}(?:_\d+)?$/, '');
|
||||||
|
|
||||||
const local = await this.list();
|
const local = await this.list();
|
||||||
|
|||||||
+19
-3
@@ -27,6 +27,8 @@ function findFreePort() {
|
|||||||
|
|
||||||
/** Owns a kiwix-serve process's full lifecycle: library.xml, start/stop/reload, content + search access. */
|
/** Owns a kiwix-serve process's full lifecycle: library.xml, start/stop/reload, content + search access. */
|
||||||
export class KiwixServer {
|
export class KiwixServer {
|
||||||
|
static #empty = '<?xml version="1.0" encoding="UTF-8" ?>\n<library version="20110515"></library>\n';
|
||||||
|
|
||||||
#dir;
|
#dir;
|
||||||
#host;
|
#host;
|
||||||
#port;
|
#port;
|
||||||
@@ -49,6 +51,12 @@ export class KiwixServer {
|
|||||||
this.#binDir = binDir;
|
this.#binDir = binDir;
|
||||||
this.#libraryPath = path.join(dir, 'library.xml');
|
this.#libraryPath = path.join(dir, 'library.xml');
|
||||||
this.#remote = url ? url.replace(/\/$/, '') : null;
|
this.#remote = url ? url.replace(/\/$/, '') : null;
|
||||||
|
if (!this.#remote) this.#ensureLocalStore();
|
||||||
|
}
|
||||||
|
|
||||||
|
#ensureLocalStore() {
|
||||||
|
fs.mkdirSync(this.#dir, {recursive: true});
|
||||||
|
if (!fs.existsSync(this.#libraryPath)) fs.writeFileSync(this.#libraryPath, KiwixServer.#empty);
|
||||||
}
|
}
|
||||||
|
|
||||||
#assertRunning() {
|
#assertRunning() {
|
||||||
@@ -61,15 +69,22 @@ export class KiwixServer {
|
|||||||
|
|
||||||
/** Reads library.xml from disk if we own the server, or over HTTP if attached to a remote one. */
|
/** Reads library.xml from disk if we own the server, or over HTTP if attached to a remote one. */
|
||||||
async #fetchLibraryXml() {
|
async #fetchLibraryXml() {
|
||||||
if (this.#remote) return (await fetch(`${this.#remote}/library.xml`).catch(() => null))?.text?.() ?? '';
|
if (!this.#remote) return fs.promises.readFile(this.#libraryPath, 'utf8').catch(() => '');
|
||||||
return fs.promises.readFile(this.#libraryPath, 'utf8').catch(() => '');
|
try {
|
||||||
|
const res = await fetch(`${this.#remote}/library.xml`);
|
||||||
|
return res.ok ? await res.text() : '';
|
||||||
|
} catch {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Rebuilds library.xml from scratch by scanning `dir` for .zim files - no-op if attached to a remote server. */
|
/** Rebuilds library.xml from scratch by scanning `dir` for .zim files - no-op if attached to a remote server. */
|
||||||
async #rebuildLibrary() {
|
async #rebuildLibrary() {
|
||||||
if (this.#remote) return;
|
if (this.#remote) return;
|
||||||
await fs.promises.rm(this.#libraryPath, {force: true});
|
await fs.promises.rm(this.#libraryPath, {force: true});
|
||||||
for (const f of await this.#zimFiles()) await execFileAsync(this.#bin('kiwix-manage'), [this.#libraryPath, 'add', path.join(this.#dir, f)]);
|
const files = await this.#zimFiles();
|
||||||
|
if (!files.length) return fs.promises.writeFile(this.#libraryPath, KiwixServer.#empty);
|
||||||
|
for (const f of files) await execFileAsync(this.#bin('kiwix-manage'), [this.#libraryPath, 'add', path.join(this.#dir, f)]);
|
||||||
}
|
}
|
||||||
|
|
||||||
async #waitUntilReady() {
|
async #waitUntilReady() {
|
||||||
@@ -133,6 +148,7 @@ export class KiwixServer {
|
|||||||
async list() {
|
async list() {
|
||||||
this.#assertRunning();
|
this.#assertRunning();
|
||||||
const xml = await this.#fetchLibraryXml();
|
const xml = await this.#fetchLibraryXml();
|
||||||
|
if (!xml) return [];
|
||||||
const entries = fromXml(xml);
|
const entries = fromXml(xml);
|
||||||
return (entries?.library?.book || []).map(e => {
|
return (entries?.library?.book || []).map(e => {
|
||||||
const tags = e.tags.split(';');
|
const tags = e.tags.split(';');
|
||||||
|
|||||||
Reference in New Issue
Block a user