penguins-eggs 25.10.23 → 25.10.26

package/dist/classes/cli-autologin.js

@@ -0,0 +1,252 @@
+/**
+ * ./src/lib/cli-autologin.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import chalk from 'chalk';
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+import shx from 'shelljs';
+// libraries
+import { exec } from '../lib/utils.js';
+import Pacman from './pacman.js';
+import Utils from './utils.js';
+const startMessage = 'eggs-start-message';
+const stopMessage = 'eggs-stop-message';
+/*
+ * Comando per avviare ubiquity:
+ * sudo --preserve-env DBUS_SESSION_BUS_ADDRESS, XDG_RUNTIME sh -c 'calamares'
+ */
+/**
+ * CliAutologin
+ */
+export default class CliAutologin {
+    /**
+     * add
+     * @param distro
+     * @param version
+     * @param user
+     * @param userPasswd
+     * @param rootPasswd
+     * @param chroot
+     */
+    async add(distro, version, user, userPasswd, rootPasswd, chroot = '/') {
+        if (Utils.isSystemd()) {
+            /**
+             * systemd
+             */
+            Utils.warning("systemd: creating CLI autologin");
+            const fileOverride = `${chroot}/etc/systemd/system/getty@.service.d/override.conf`;
+            const dirOverride = path.dirname(fileOverride);
+            if (fs.existsSync(dirOverride)) {
+                shx.exec(`rm ${dirOverride} -rf`);
+            }
+            // ecludo Opensuse ha un'altro sistema
+            if (distro !== 'Opensuse') {
+                shx.exec(`mkdir ${dirOverride}`);
+                let content = '';
+                content += '[Service]' + '\n';
+                content += 'ExecStart=' + '\n';
+                content += 'ExecStart=-/sbin/agetty --noclear --autologin ' + user + ' %I $TERM' + '\n';
+                fs.writeFileSync(fileOverride, content);
+            }
+            shx.exec(`chmod +x ${fileOverride}`);
+            await this.addIssue(distro, version, user, userPasswd, rootPasswd, chroot);
+            await this.addMotd(distro, version, user, userPasswd, rootPasswd, chroot);
+        }
+        else if (Utils.isOpenRc()) {
+            /**
+             * openrc
+             */
+            Utils.warning("openrc: creating CLI autologin");
+            const inittab = chroot + '/etc/inittab';
+            let content = '';
+            const search = `tty1::respawn:/sbin/getty 38400 tty1`;
+            const replace = `tty1::respawn:/sbin/getty -L 38400 tty1 -n -l /bin/autologin`;
+            const lines = fs.readFileSync(inittab, 'utf8').split('\n');
+            for (let i = 0; i < lines.length; i++) {
+                if (lines[i].includes(search)) {
+                    lines[i] = replace;
+                }
+                content += lines[i] + '\n';
+            }
+            console.log(`Writing ${inittab}`);
+            fs.writeFileSync(inittab, content, 'utf-8');
+            const autologin = chroot + '/bin/autologin';
+            content = '#!/bin/sh' + '\n';
+            content += `/bin/login -f ${user}` + '\n';
+            fs.writeFileSync(autologin, content, 'utf-8');
+            execSync(`chmod +x ${autologin}`);
+            await this.addIssue(distro, version, user, userPasswd, rootPasswd, chroot);
+            await this.addMotd(distro, version, user, userPasswd, rootPasswd, chroot);
+        }
+        else if (Utils.isSysvinit()) {
+            /**
+             * sysvinit
+             */
+            Utils.warning("sysvinit: creating CLI autologin");
+            const inittab = chroot + '/etc/inittab';
+            const search = '1:2345:respawn:/sbin/getty';
+            const replace = `1:2345:respawn:/sbin/getty --autologin ${user} 38400 tty1`;
+            let content = '';
+            const lines = fs.readFileSync(inittab, 'utf8').split('\n');
+            for (let i = 0; i < lines.length; i++) {
+                if (lines[i].includes(search)) {
+                    lines[i] = replace;
+                }
+                content += lines[i] + '\n';
+            }
+            console.log(`Writing ${inittab}`);
+            fs.writeFileSync(inittab, content, 'utf-8');
+            await this.addMotd(distro, version, user, userPasswd, rootPasswd, chroot);
+            await this.addIssue(distro, version, user, userPasswd, rootPasswd, chroot);
+        }
+    }
+    /**
+     *
+     * @param distro
+     * @param version
+     * @param user
+     * @param userPasswd
+     * @param rootPasswd
+     * @param chroot
+     */
+    async addIssue(distro, version, user, userPasswd, rootPasswd, chroot = '/') {
+        const fileIssue = `${chroot}/etc/issue`;
+        if (fs.existsSync(fileIssue)) {
+            if (!fs.lstatSync(fileIssue).isSymbolicLink()) {
+                this.msgRemove(fileIssue);
+                let content = fs.readFileSync(fileIssue, 'utf8');
+                content += startMessage + '\n';
+                content += `This is a ${distro}/${version} system created by Penguins' eggs.\n`;
+                content += 'You can login with user: ' + chalk.bold(user) + ' and password: ' + chalk.bold(userPasswd) + ', root password: ' + chalk.bold(rootPasswd) + '\n';
+                content += stopMessage + '\n';
+                fs.writeFileSync(fileIssue, content);
+            }
+        }
+    }
+    /**
+     *
+     * @param distro
+     * @param version
+     * @param user
+     * @param userPasswd
+     * @param rootPasswd
+     * @param chroot
+     */
+    async addMotd(distro, version, user, userPasswd, rootPasswd, chroot = '/') {
+        const fileMotd = `${chroot}/etc/motd`;
+        let installer = 'sudo eggs install';
+        if (Pacman.calamaresExists()) {
+            if (Pacman.packageIsInstalled('plasma-desktop')) {
+                installer = 'startplasma-wayland to run GUI and launch calamares';
+            }
+            else if (Pacman.packageIsInstalled('xfce4')) {
+                installer = 'startxfce4 to run GUI and launch calamares installer';
+            }
+        }
+        if (!fs.existsSync(fileMotd)) {
+            await exec(`touch ${fileMotd}`);
+        }
+        this.msgRemove(fileMotd);
+        let eggsMotd = fs.readFileSync(fileMotd, 'utf8');
+        eggsMotd += startMessage + '\n';
+        eggsMotd += Utils.flag() + '\n';
+        eggsMotd += 'You are logged as: ' + chalk.bold(user) + ' your password is: ' + chalk.bold(userPasswd) + ', root password: ' + chalk.bold(rootPasswd) + '\n\n';
+        eggsMotd += 'install              : ' + chalk.bold(installer) + '\n';
+        eggsMotd += ' --unattended        : ' + chalk.bold('sudo eggs install --unattended') + '\n';
+        eggsMotd += ' --chroot            : ' + chalk.bold('sudo eggs install --chroot') + '\n';
+        eggsMotd += ' --help              : ' + chalk.bold('sudo eggs install --help') + '\n';
+        eggsMotd += '\n';
+        eggsMotd += stopMessage + '\n';
+        fs.writeFileSync(fileMotd, eggsMotd);
+    }
+    /**
+     * remove
+     * @param chroot
+     */
+    async remove(chroot = '/') {
+        if (Utils.isSystemd()) {
+            /**
+             * Systemd
+             */
+            const fileOverride = `${chroot}/etc/systemd/system/getty@.service.d/override.conf`;
+            const dirOverride = path.dirname(fileOverride);
+            if (fs.existsSync(dirOverride)) {
+                shx.exec(`rm ${dirOverride} -rf`);
+            }
+            this.msgRemove(`${chroot}/etc/motd`);
+            this.msgRemove(`${chroot}/etc/issue`);
+        }
+        else if (Utils.isOpenRc()) {
+            /**
+             * openrc
+             */
+            const inittab = chroot + '/etc/inittab';
+            const search = 'autologin';
+            const replace = `tty1::respawn:/sbin/getty 38400 tty1`;
+            let content = '';
+            const lines = fs.readFileSync(inittab, 'utf8').split('\n');
+            for (let i = 0; i < lines.length; i++) {
+                if (lines[i].includes(search)) {
+                    lines[i] = replace;
+                }
+                content += lines[i] + '\n';
+            }
+            fs.writeFileSync(inittab, content, 'utf-8');
+            this.msgRemove(`${chroot}/etc/motd`);
+            this.msgRemove(`${chroot}/etc/issue`);
+            const autologin = `${chroot}/bin/autologin`;
+            execSync(`rm -f ${autologin}`);
+        }
+        else if (Utils.isSysvinit()) {
+            /**
+             * sysvinit
+             */
+            const inittab = chroot + '/etc/inittab';
+            const search = '--autologin';
+            const replace = '1:2345:respawn:/sbin/getty 38400 tty1         ';
+            let content = '';
+            const lines = fs.readFileSync(inittab, 'utf8').split('\n');
+            for (let i = 0; i < lines.length; i++) {
+                if (lines[i].includes(search)) {
+                    lines[i] = replace;
+                }
+                content += lines[i] + '\n';
+            }
+            // motd
+            fs.writeFileSync(inittab, content, 'utf-8');
+            this.msgRemove(`${chroot}/etc/motd`);
+            // issue
+            this.msgRemove(`${chroot}/etc/issue`);
+        } // to add: openrc and runit for Devuan
+    }
+    /**
+     *
+     * @param path
+     */
+    async msgRemove(path) {
+        if (fs.existsSync(path)) {
+            if (!fs.lstatSync(path).isSymbolicLink()) {
+                const rows = fs.readFileSync(path, 'utf8').split('\n');
+                let cleaned = '';
+                let remove = false;
+                for (const row of rows) {
+                    if (row.includes(startMessage)) {
+                        remove = true;
+                    }
+                    if (!remove && row !== '') {
+                        cleaned += row + '\n';
+                    }
+                    if (row.includes(stopMessage)) {
+                        remove = false;
+                    }
+                }
+                fs.writeFileSync(path, cleaned, 'utf-8');
+            }
+        }
+    }
+}

package/dist/classes/compressors.d.ts

@@ -0,0 +1,54 @@
+/**
+ * ./src/classes/compressors.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+export default class Compressors {
+    dest: string;
+    isEnabled: {
+        error: boolean;
+        gzip: boolean;
+        lz4: boolean;
+        lzma: boolean;
+        lzo: boolean;
+        xz: boolean;
+        zstd: boolean;
+    };
+    source: string;
+    /**
+     * fast compression
+     * @returns
+     */
+    fast(): string;
+    /**
+     * max
+     * @returns
+     */
+    max(): string;
+    pendrive(level?: string): string;
+    /**
+     * populate
+     */
+    populate(): Promise<void>;
+    /**
+     * standard
+     * @returns
+     */
+    standard(): string;
+    /**
+     * check mksquashfs exists
+     * @param compressor
+     * @returns
+     */
+    private check;
+    /**
+     * prepareCheck
+     */
+    private prepareCheck;
+    /**
+     * removeCheck
+     */
+    private removeCheck;
+}

package/dist/classes/compressors.js

@@ -0,0 +1,109 @@
+/**
+ * ./src/classes/compressors.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import shx from 'shelljs';
+export default class Compressors {
+    dest = '/tmp/eggs-mksquash-dest';
+    isEnabled = {
+        error: false,
+        gzip: true,
+        lz4: false,
+        lzma: false,
+        lzo: false,
+        xz: false,
+        zstd: false
+    };
+    source = '/tmp/eggs-mksquash-test';
+    /**
+     * fast compression
+     * @returns
+     */
+    fast() {
+        let comp = 'gzip';
+        if (this.isEnabled.zstd) {
+            comp = 'zstd -b 1M -Xcompression-level 3';
+        }
+        else if (this.isEnabled.lz4) {
+            comp = 'lz4';
+        }
+        return comp;
+    }
+    /**
+     * max
+     * @returns
+     */
+    max() {
+        let filter = 'x86';
+        if (process.arch === 'arm64') {
+            filter = 'arm';
+        }
+        const options = '-b 1M -no-duplicates -no-recovery -always-use-fragments';
+        if (process.arch === 'ia32') {
+            // options = '-b 1M'
+        }
+        const comp = `xz -Xbcj ${filter} ${options}`;
+        return comp;
+    }
+    pendrive(level = '15') {
+        let comp = 'gzip';
+        if (this.isEnabled.zstd) {
+            comp = `zstd -b 1M -Xcompression-level ${level}`;
+        }
+        else if (this.isEnabled.lz4) {
+            comp = 'lz4';
+        }
+        return comp;
+    }
+    /**
+     * populate
+     */
+    async populate() {
+        await this.prepareCheck();
+        this.isEnabled.error = await this.check('error');
+        this.isEnabled.lzma = await this.check('lzma');
+        this.isEnabled.lzo = await this.check('lzo');
+        this.isEnabled.lz4 = await this.check('lz4');
+        this.isEnabled.xz = await this.check('xz');
+        this.isEnabled.zstd = await this.check('zstd');
+        await this.removeCheck();
+    }
+    /**
+     * standard
+     * @returns
+     */
+    standard() {
+        const comp = 'xz -b 1M';
+        return comp;
+    }
+    /**
+     * check mksquashfs exists
+     * @param compressor
+     * @returns
+     */
+    async check(compressor) {
+        let result = false;
+        const { stderr } = shx.exec('mksquashfs ' + this.source + ' ' + this.dest + ' -comp ' + compressor + ' -no-xattrs -ef ' + this.dest, { silent: true });
+        if (stderr === '') {
+            result = true;
+        }
+        return result;
+    }
+    /**
+     * prepareCheck
+     */
+    async prepareCheck() {
+        shx.exec('rm -rf ' + this.source, { silent: true });
+        shx.exec('mkdir ' + this.source, { silent: true });
+    }
+    /**
+     * removeCheck
+     */
+    async removeCheck() {
+        shx.exec('rm -rf ' + this.source, { silent: true });
+        shx.exec('rm -f  ' + this.dest, { silent: true });
+    }
+}

package/dist/classes/daddy.d.ts

@@ -0,0 +1,26 @@
+/**
+ * ./src/classes/daddy.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import Settings from '../classes/settings.js';
+import { IEggsConfig } from '../interfaces/i-eggs-config.js';
+export default class Daddy {
+    settings: Settings;
+    /**
+     * editConfif
+     * @param c
+     * @returns
+     */
+    editConfig(c: IEggsConfig): Promise<string>;
+    /**
+     *
+     * @param reset
+     * @param isCustom
+     * @param fileCustom
+     * @param verbose
+     */
+    helpMe(reset?: boolean, isCustom?: boolean, fileCustom?: string, verbose?: boolean): Promise<void>;
+}

package/dist/classes/daddy.js

@@ -0,0 +1,175 @@
+/**
+ * ./src/classes/daddy.ts
+ * penguins-eggs v.25.7.x / ecmascript 2020
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import chalk from 'chalk';
+import inquirer from 'inquirer';
+import yaml from 'js-yaml';
+import fs from 'node:fs';
+// _dirname
+import path from 'node:path';
+import { exec } from '../lib/utils.js';
+// We need to remove .js extension from import
+import Pacman from '../classes/pacman.js';
+import Settings from '../classes/settings.js';
+import Utils from '../classes/utils.js';
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+export default class Daddy {
+    settings = {};
+    /**
+     * editConfif
+     * @param c
+     * @returns
+     */
+    async editConfig(c) {
+        // Utils.titles('dad')
+        console.log(chalk.cyan('Edit and save Live system parameters'));
+        console.log();
+        let compressionOpt = 0;
+        if (c.compression === 'xz') {
+            compressionOpt = 1;
+        }
+        else if (c.compression === 'xz -Xbcj x86') {
+            compressionOpt = 2;
+        }
+        if (c.snapshot_prefix === '') {
+            c.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId);
+        }
+        return new Promise((resolve) => {
+            const questions = [
+                {
+                    default: c.snapshot_prefix,
+                    message: 'LiveCD iso prefix: ',
+                    name: 'snapshot_prefix',
+                    type: 'input'
+                },
+                {
+                    default: c.snapshot_basename,
+                    message: 'LiveCD iso basename: ',
+                    name: 'snapshot_basename',
+                    type: 'input'
+                },
+                {
+                    default: c.user_opt,
+                    message: 'LiveCD user:',
+                    name: 'user_opt',
+                    type: 'input'
+                },
+                {
+                    default: c.user_opt_passwd,
+                    message: 'LiveCD user password: ',
+                    name: 'user_opt_passwd',
+                    type: 'input'
+                },
+                {
+                    default: c.root_passwd,
+                    message: 'LiveCD root password: ',
+                    name: 'root_passwd',
+                    type: 'input'
+                },
+                {
+                    choices: ['fast', 'max'],
+                    default: compressionOpt,
+                    message: 'LiveCD compression: ',
+                    name: 'compression',
+                    type: 'list'
+                }
+            ];
+            inquirer.prompt(questions).then((options) => {
+                resolve(JSON.stringify(options));
+            });
+        });
+    }
+    /**
+     *
+     * @param reset
+     * @param isCustom
+     * @param fileCustom
+     * @param verbose
+     */
+    async helpMe(reset = false, isCustom = false, fileCustom = '', verbose = false) {
+        if (isCustom) {
+            console.log('using custom file:', fileCustom);
+        }
+        // Controllo configurazione
+        if (!Pacman.configurationCheck()) {
+            console.log('- creating configuration dir...');
+            await Pacman.configurationInstall(verbose);
+        }
+        // Templates
+        if (!Pacman.distroTemplateCheck()) {
+            console.log('- distro template install...');
+            await Pacman.distroTemplateInstall(verbose);
+        }
+        //Calamares 
+        if (!Pacman.calamaresExists() &&
+            Pacman.isInstalledGui() &&
+            Pacman.isCalamaresAvailable()) {
+            console.log('- this is a GUI system, calamares is available, but NOT installed');
+        }
+        // show and edit configuration
+        this.settings = new Settings();
+        let config = {};
+        let jsonConf = '';
+        if (await this.settings.load()) {
+            config = this.settings.config;
+            config.compression = 'fast';
+            if (reset || isCustom) {
+                if (config.snapshot_prefix === '') {
+                    let fstype = ((await exec(`findmnt -n -o FSTYPE /`, { capture: true })).data.trim());
+                    if (fstype !== 'ext4') {
+                        fstype += '-';
+                    }
+                    else {
+                        fstype = '';
+                    }
+                    config.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId) + fstype;
+                }
+                jsonConf = JSON.stringify(config);
+            }
+            else {
+                jsonConf = await this.editConfig(config);
+            }
+            // Custom configuration
+            if (isCustom) {
+                const conf = fs.readFileSync(fileCustom, 'utf8');
+                const confCustom = yaml.load(conf);
+                config.snapshot_basename = confCustom.snapshot_basename;
+                config.snapshot_prefix = confCustom.snapshot_prefix;
+                config.user_opt = confCustom.user_opt;
+                config.user_opt_passwd = confCustom.user_opt_passwd;
+                config.root_passwd = confCustom.root_passwd;
+                config.theme = confCustom.theme;
+                jsonConf = JSON.stringify(config);
+            }
+            // Save new configuration
+            const confNew = JSON.parse(jsonConf);
+            config.snapshot_basename = confNew.snapshot_basename;
+            config.snapshot_prefix = confNew.snapshot_prefix;
+            config.user_opt = confNew.user_opt;
+            config.user_opt_passwd = confNew.user_opt_passwd;
+            config.root_passwd = confNew.root_passwd;
+            config.theme = confNew.theme;
+            await this.settings.save(config);
+        }
+        console.log();
+        console.log(chalk.cyan('Your configuration was saved on: /etc/penguins-eggs.d'));
+        console.log();
+        console.log(chalk.cyan(`You can create a clean ISO with: `) + chalk.white(`sudo eggs produce`));
+        console.log(chalk.cyan(`or a full personal clone: `) + chalk.white(`sudo eggs produce --clone`));
+        console.log();
+        console.log(chalk.cyan(`If you don't have enough space to remaster, you can mount`));
+        console.log(chalk.cyan(`some remote or local space. Follow the samples:`));
+        console.log(chalk.cyan(`- first, create an hidden mountpoint under the nest:`));
+        console.log(chalk.white(`sudo mkdir /home/eggs/.mnt -p`));
+        console.log(chalk.cyan(`- then, mount remote space:`));
+        console.log(chalk.white(`sudo sshfs -o allow_other root@192.168.1.2:/zfs/iso /home/eggs/.mnt`));
+        console.log(chalk.cyan('- or, mount a local partition:'));
+        console.log(chalk.white(`sudo mount /dev/sdx1 /home/eggs/.mnt`));
+        console.log();
+        console.log(chalk.cyan('More help? ') + chalk.white('eggs mom'));
+    }
+}

package/dist/classes/distro.d.ts

@@ -0,0 +1,32 @@
+/**
+ * penguins-eggs
+ * class: distro.ts
+ * author: Piero Proietti
+ * email: piero.proietti@gmail.com
+ * license: MIT
+ */
+import { IDistro } from '../interfaces/index.js';
+/**
+ * Classe
+ */
+declare class Distro implements IDistro {
+    bugReportUrl: string;
+    codenameId: string;
+    distroUniqueId: string;
+    distroId: string;
+    distroLike: string;
+    familyId: string;
+    homeUrl: string;
+    isCalamaresAvailable: boolean;
+    liveMediumPath: string;
+    releaseId: string;
+    squashfs: string;
+    supportUrl: string;
+    syslinuxPath: string;
+    usrLibPath: string;
+    /**
+     * Costruttore
+     */
+    constructor();
+}
+export default Distro;