pmcf 1.52.6 → 1.53.0

package/bin/pmcf-package

@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+
+import {
+  FileContentProvider,
+  createPublishingDetails,
+  ARCH
+} from "npm-pkgbuild";
+import { prepare } from "../src/cmd.mjs";
+
+const { root, args, options } = await prepare();
+
+const objectName = args[0];
+const object = await root.load(objectName);
+
+console.log(object);
+const publishingDetails = createPublishingDetails(["somewhere"]);
+
+const { properties } = await object.preparePackage(options.output);
+
+properties.version = "0.0.0";
+
+console.log(properties);
+
+const sources = [options.output].map(base =>
+  new FileContentProvider({
+    base
+  })[Symbol.asyncIterator]()
+);
+
+const output = new ARCH(properties);
+
+const fileName = await output.create(sources, [], {}, publishingDetails, {
+  destination: "dist",
+  verbose: true
+});
+
+console.log(fileName);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmcf",
-  "version": "1.52.6",
+  "version": "1.53.0",
   "publishConfig": {
     "access": "public"
   },
@@ -22,10 +22,8 @@
   ],
   "license": "0BSD",
   "bin": {
-    "pmcf-host-defs": "./bin/pmcf-host-defs",
+    "pmcf-package": "./bin/pmcf-package",
     "pmcf-info": "./bin/pmcf-info",
-    "pmcf-location-defs": "./bin/pmcf-location-defs",
-    "pmcf-named-defs": "./bin/pmcf-named-defs",
     "pmcf-network": "./bin/pmcf-network"
   },
   "scripts": {
@@ -44,7 +42,7 @@
     "pacc": "^3.3.0"
   },
   "devDependencies": {
-    "@types/node": "^22.13.5",
+    "@types/node": "^22.13.8",
     "ava": "^6.2.0",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",

package/src/base.mjs

@@ -284,6 +284,19 @@ export class Base {
       : this.owner.fullName;
   }
 
+  get packageName() {
+    return `${this.constructor.typeDefinition.name}-${this.name}`;
+  }
+
+  async preparePackage(stagingDir) {
+    return {
+      properties: {
+        name: this.packageName,
+        description: `${this.constructor.typeDefinition.name} definitions for ${this.fullName}`
+      }
+    };
+  }
+
   expand(object) {
     switch (typeof object) {
       case "string":

package/src/dns.mjs

@@ -1,3 +1,6 @@
+import { join } from "node:path";
+import { createHmac } from "node:crypto";
+import { writeLines, isIPv6Address, normalizeIPAddress } from "./utils.mjs";
 import { Base } from "./base.mjs";
 import { addType } from "./types.mjs";
 
@@ -46,6 +49,8 @@ export class DNSService extends Base {
     }
     super(owner, data);
     this.read(data, DNSServiceTypeDefinition);
+
+    owner.addObject(this);
   }
 
   get soaUpdates() {
@@ -97,4 +102,216 @@ export class DNSService extends Base {
       LLMNR: "no"
     };
   }
+
+  async preparePackage(stagingDir) {
+    const { properties } = await super.preparePackage(stagingDir);
+
+    await generateNamedDefs(this, stagingDir);
+
+    properties.depends = ["mf-named"];
+    properties.replaces = ["mf-named-zones"];
+
+    return { properties };
+  }
+}
+
+function fullName(name) {
+  return name.endsWith(".") ? name : name + ".";
+}
+
+async function generateNamedDefs(dns, targetDir) {
+  const ttl = dns.recordTTL;
+  const updates = [Math.ceil(Date.now() / 1000), ...dns.soaUpdates].join(" ");
+
+  for (const domain of dns.domains) {
+    const zones = [];
+    const records = new Set();
+
+    const nameserver = (await dns.owner.findService({ type: "dns" }))?.owner;
+    const rname = dns.administratorEmail.replace(/@/, ".");
+
+    let maxKeyLength;
+
+    const createRecord = (key, type, ...values) => {
+      values = values.map(v =>
+        typeof v === "number" ? String(v).padStart(3) : v
+      );
+
+      return {
+        key,
+        toString: () =>
+          `${key.padEnd(maxKeyLength, " ")} ${ttl} IN ${type.padEnd(
+            5,
+            " "
+          )} ${values.join(" ")}`
+      };
+    };
+
+    for await (const mail of dns.owner.findServices({ type: "smtp" })) {
+      records.add(
+        createRecord("@", "MX", mail.priority, fullName(mail.owner.domainName))
+      );
+    }
+
+    console.log(dns.owner.fullName, domain, nameserver?.hostName, rname);
+    const reverseZones = new Map();
+
+    const SOARecord = createRecord(
+      "@",
+      "SOA",
+      fullName(nameserver?.domainName),
+      fullName(rname),
+      `(${updates})`
+    );
+
+    const NSRecord = createRecord("@", "NS", fullName(nameserver?.rawAddress));
+
+    const catalogZone = {
+      id: `catalog.${domain}`,
+      file: `catalog.${domain}.zone`,
+      records: new Set([
+        SOARecord,
+        NSRecord,
+        createRecord(fullName(`version.${domain}`), "TXT", '"2"')
+      ])
+    };
+
+    const zone = {
+      id: domain,
+      file: `${domain}.zone`,
+      records: new Set([SOARecord, NSRecord, ...records])
+    };
+    zones.push(zone);
+
+    const hosts = new Set();
+    const addresses = new Set();
+
+    for await (const {
+      address,
+      subnet,
+      networkInterface
+    } of dns.owner.networkAddresses()) {
+      const host = networkInterface.host;
+
+      if (!addresses.has(address)) {
+        addresses.add(address);
+
+        zone.records.add(
+          createRecord(
+            fullName(host.domainName),
+            isIPv6Address(address) ? "AAAA" : "A",
+            normalizeIPAddress(address)
+          )
+        );
+
+        if (subnet) {
+          let reverseZone = reverseZones.get(subnet.address);
+
+          if (!reverseZone) {
+            const reverseArpa = reverseArpaAddress(subnet.prefix);
+            reverseZone = {
+              id: reverseArpa,
+              file: `${reverseArpa}.zone`,
+              records: new Set([SOARecord, NSRecord])
+            };
+            zones.push(reverseZone);
+            reverseZones.set(subnet.address, reverseZone);
+          }
+          reverseZone.records.add(
+            createRecord(
+              fullName(reverseArpaAddress(address)),
+              "PTR",
+              fullName(host.domainName)
+            )
+          );
+        }
+      }
+
+      if (!hosts.has(host)) {
+        hosts.add(host);
+        for (const service of host.findServices()) {
+          if (service.master && service.alias) {
+            zone.records.add(
+              createRecord(service.alias, "CNAME", fullName(host.domainName))
+            );
+          }
+
+          if (dns.hasSVRRecords && service.srvPrefix) {
+            zone.records.add(
+              createRecord(
+                fullName(`${service.srvPrefix}.${host.domainName}`),
+                "SRV",
+                service.priority,
+                service.weight,
+                service.port,
+                fullName(host.domainName)
+              )
+            );
+          }
+        }
+      }
+    }
+
+    const zoneConfig = [];
+
+    if (dns.hasCatalog) {
+      zones.push(catalogZone);
+    }
+
+    for (const zone of zones) {
+      if (zone !== catalogZone) {
+        const hash = createHmac("md5", zone.id).digest("hex");
+        catalogZone.records.add(
+          createRecord(`${hash}.zones.${domain}.`, "PTR", `${zone.id}.`)
+        );
+      }
+
+      zoneConfig.push(`zone \"${zone.id}\" {`);
+      zoneConfig.push(`  type master;`);
+      zoneConfig.push(`  file \"${zone.file}\";`);
+
+      zoneConfig.push(
+        `  allow-update { ${
+          dns.allowedUpdates.length ? dns.allowedUpdates.join(";") : "none"
+        }; };`
+      );
+      zoneConfig.push(`  notify ${dns.notify ? "yes" : "no"};`);
+      zoneConfig.push(`};`);
+      zoneConfig.push("");
+
+      maxKeyLength = 0;
+      for (const r of zone.records) {
+        if (r.key.length > maxKeyLength) {
+          maxKeyLength = r.key.length;
+        }
+      }
+
+      writeLines(join(targetDir, "var/lib/named"), zone.file, zone.records);
+    }
+
+    writeLines(
+      join(targetDir, "etc/named.d/zones"),
+      `${domain}.zone.conf`,
+      zoneConfig
+    );
+  }
+}
+
+export function reverseAddress(address) {
+  if (isIPv6Address(address)) {
+    return normalizeIPAddress(address)
+      .replaceAll(":", "")
+      .split("")
+      .reverse()
+      .join(".");
+  }
+
+  return address.split(".").reverse().join(".");
+}
+
+export function reverseArpaAddress(address) {
+  return (
+    reverseAddress(address) +
+    (isIPv6Address(address) ? ".ip6.arpa" : ".in-addr.arpa")
+  );
 }

package/src/host.mjs

@@ -11,6 +11,12 @@ import {
   hasWellKnownSubnet
 } from "./utils.mjs";
 import { addType } from "./types.mjs";
+import {
+  generateNetworkDefs,
+  generateMachineInfo,
+  copySshKeys,
+  generateKnownHosts
+} from "./host-utils.mjs";
 
 const HostTypeDefinition = {
   name: "host",
@@ -318,6 +324,24 @@ export class Host extends Base {
   async publicKey(type = "ed25519") {
     return readFile(join(this.directory, `ssh_host_${type}_key.pub`), "utf8");
   }
+
+  async preparePackage(stagingDir) {
+    const { properties } = await super.preparePackage(stagingDir);
+    await generateNetworkDefs(this, stagingDir);
+    await generateMachineInfo(this, stagingDir);
+    await copySshKeys(this, stagingDir);
+    await generateKnownHosts(
+      this.owner.hosts(),
+      join(stagingDir, "root", ".ssh")
+    );
+
+    properties.provides = [...this.provides];
+    properties.depends = [this.location.packageName, ...this.depends];
+    properties.replaces = [`mf-${this.hostName}`, ...this.replaces];
+    properties.backup = "root/.ssh/known_hosts";
+
+    return { properties };
+  }
 }
 
 const NetworkInterfaceTypeDefinition = {

package/src/location.mjs

@@ -1,5 +1,8 @@
+import { mkdir, copyFile } from "node:fs/promises";
+import { join } from "node:path";
 import { Owner } from "./owner.mjs";
 import { addType } from "./types.mjs";
+import { writeLines, sectionLines } from "./utils.mjs";
 
 const LocationTypeDefinition = {
   name: "location",
@@ -30,7 +33,6 @@ export class Location extends Owner {
     return this;
   }
 
-
   locationNamed(name) {
     if (this.isNamed(name)) {
       return this;
@@ -42,4 +44,52 @@ export class Location extends Owner {
   get network() {
     return [...this.typeList("network")][0] || super.network;
   }
+
+  async preparePackage(stagingDir) {
+    const { properties } = await super.preparePackage(stagingDir);
+
+    await writeLines(
+      join(stagingDir, "etc/systemd/resolved.conf.d"),
+      `${this.name}.conf`,
+      sectionLines("Resolve", await this.dns.resolvedConfig())
+    );
+
+    await writeLines(
+      join(stagingDir, "etc/systemd/journald.conf.d"),
+      `${this.name}.conf`,
+      sectionLines("Journal", {
+        Compress: "yes",
+        SystemMaxUse: "500M",
+        SyncIntervalSec: "15m"
+      })
+    );
+
+    await writeLines(
+      join(stagingDir, "etc/systemd/timesyncd.conf.d"),
+      `${this.name}.conf`,
+      sectionLines("Time", {
+        NTP: this.ntp.servers.join(" "),
+        PollIntervalMinSec: 60,
+        SaveIntervalSec: 3600
+      })
+    );
+
+    const locationDir = join(stagingDir, "etc", "location");
+
+    await mkdir(locationDir, { recursive: true });
+
+    await copyFile(
+      join(this.directory, "location.json"),
+      join(locationDir, "location.json")
+    );
+
+    properties.provides = [
+      "location",
+      "mf-location",
+      `mf-location-${this.name}`
+    ];
+    properties.replaces = [`mf-location-${this.name}`];
+
+    return { properties };
+  }
 }

package/src/owner.mjs

@@ -75,6 +75,18 @@ export class Owner extends Base {
         return object;
       }
     }
+
+    // TODO cascade
+    const parts = name.split(/\//);
+
+    if (parts.length >= 2) {
+      const last = parts.pop();
+
+      const next = this.named(parts.join("/"));
+      if (next) {
+        return next.named(last);
+      }
+    }
   }
 
   typeNamed(typeName, name) {

package/types/base.d.mts

@@ -59,6 +59,13 @@ export class Base {
     set directory(directory: any);
     get directory(): any;
     get fullName(): any;
+    get packageName(): string;
+    preparePackage(stagingDir: any): Promise<{
+        properties: {
+            name: string;
+            description: string;
+        };
+    }>;
     expand(object: any): any;
     finalize(action: any): void;
     execFinalize(): void;

package/types/dns.d.mts

@@ -1,3 +1,5 @@
+export function reverseAddress(address: any): any;
+export function reverseArpaAddress(address: any): string;
 export class DNSService extends Base {
     static get typeDefinition(): {
         name: string;

package/bin/pmcf-host-defs

@@ -1,31 +0,0 @@
-#!/usr/bin/env node
-
-import { join } from "node:path";
-import { types } from "pmcf";
-import { prepare } from "../src/cmd.mjs";
-import {
-  generateNetworkDefs,
-  generateMachineInfo,
-  copySshKeys,
-  generateKnownHosts
-} from "../src/host-utils.mjs";
-
-const { root, args, options } = await prepare();
-
-const hostName = args[0];
-
-const host = await root.load(hostName, { type: types.host });
-
-await generateNetworkDefs(host, options.output);
-await generateMachineInfo(host, options.output);
-await copySshKeys(host, options.output);
-await generateKnownHosts(
-  host.owner.hosts(),
-  join(options.output, "root", ".ssh")
-);
-
-console.log("provides", "host", ...host.provides);
-console.log("depends", `location-${host.location.name}`, ...host.depends);
-console.log("replaces", `mf-${host.hostName}`, ...host.replaces);
-console.log("description", `host definitions for ${host.domainName}`);
-console.log("backup", "root/.ssh/known_hosts");

package/bin/pmcf-location-defs

@@ -1,59 +0,0 @@
-#!/usr/bin/env node
-
-import { mkdir, copyFile } from "node:fs/promises";
-import { join } from "node:path";
-import { types } from "pmcf";
-import { writeLines, sectionLines } from "../src/utils.mjs";
-import { prepare } from "../src/cmd.mjs";
-
-const { root, args, options } = await prepare();
-
-const location = await root.load(args[0], { type: types.location });
-
-await generateLocationDefs(location, options.output);
-
-console.log(
-  "provides",
-  "location",
-  "mf-location",
-  `mf-location-${location.name}`
-);
-console.log("replaces", `mf-location-${location.name}`);
-console.log("description", `location definitions for ${location.name}`);
-
-async function generateLocationDefs(location, dir) {
-  await writeLines(
-    join(dir, "etc/systemd/resolved.conf.d"),
-    `${location.name}.conf`,
-    sectionLines("Resolve", await location.dns.resolvedConfig())
-  );
-
-  await writeLines(
-    join(dir, "etc/systemd/journald.conf.d"),
-    `${location.name}.conf`,
-    sectionLines("Journal", {
-      Compress: "yes",
-      SystemMaxUse: "500M",
-      SyncIntervalSec: "15m"
-    })
-  );
-
-  await writeLines(
-    join(dir, "etc/systemd/timesyncd.conf.d"),
-    `${location.name}.conf`,
-    sectionLines("Time", {
-      NTP: location.ntp.servers.join(" "),
-      PollIntervalMinSec: 60,
-      SaveIntervalSec: 3600
-    })
-  );
-
-  const locationDir = join(dir, "etc", "location");
-
-  await mkdir(locationDir, { recursive: true });
-
-  await copyFile(
-    join(location.directory, "location.json"),
-    join(locationDir, "location.json")
-  );
-}

package/bin/pmcf-named-defs

@@ -1,222 +0,0 @@
-#!/usr/bin/env node
-
-import { join } from "node:path";
-import { createHmac } from "node:crypto";
-import {
-  writeLines,
-  isIPv6Address,
-  normalizeIPAddress
-} from "../src/utils.mjs";
-import { prepare } from "../src/cmd.mjs";
-
-const { root, args, options } = await prepare();
-
-const owner = await root.load(args[0]);
-
-await generateNamedDefs(owner, options.output);
-
-console.log("depends", "mf-named");
-console.log("replaces", "mf-named-zones");
-console.log("description", `named defintions for ${owner.name}`);
-
-function fullName(name) {
-  return name.endsWith(".") ? name : name + ".";
-}
-
-async function generateNamedDefs(owner, targetDir) {
-  const dns = owner.dns;
-  const ttl = dns.recordTTL;
-  const updates = [Math.ceil(Date.now() / 1000), ...dns.soaUpdates].join(" ");
-
-  for (const domain of dns.domains) {
-    const zones = [];
-    const records = new Set();
-
-    const nameserver = (await owner.findService({ type: "dns" }))?.owner;
-    const rname = dns.administratorEmail.replace(/@/, ".");
-
-    let maxKeyLength;
-
-    const createRecord = (key, type, ...values) => {
-      values = values.map(v =>
-        typeof v === "number" ? String(v).padStart(3) : v
-      );
-
-      return {
-        key,
-        toString: () =>
-          `${key.padEnd(maxKeyLength, " ")} ${ttl} IN ${type.padEnd(
-            5,
-            " "
-          )} ${values.join(" ")}`
-      };
-    };
-
-    for await (const mail of owner.findServices({ type: "smtp" })) {
-      records.add(
-        createRecord("@", "MX", mail.priority, fullName(mail.owner.domainName))
-      );
-    }
-
-    console.log(owner.fullName, domain, nameserver?.hostName, rname);
-    const reverseZones = new Map();
-
-    const SOARecord = createRecord(
-      "@",
-      "SOA",
-      fullName(nameserver?.domainName),
-      fullName(rname),
-      `(${updates})`
-    );
-
-    const NSRecord = createRecord("@", "NS", fullName(nameserver?.rawAddress));
-
-    const catalogZone = {
-      id: `catalog.${domain}`,
-      file: `catalog.${domain}.zone`,
-      records: new Set([
-        SOARecord,
-        NSRecord,
-        createRecord(fullName(`version.${domain}`), "TXT", '"2"')
-      ])
-    };
-
-    const zone = {
-      id: domain,
-      file: `${domain}.zone`,
-      records: new Set([SOARecord, NSRecord, ...records])
-    };
-    zones.push(zone);
-
-    const hosts = new Set();
-    const addresses = new Set();
-
-    for await (const {
-      address,
-      subnet,
-      networkInterface
-    } of owner.networkAddresses()) {
-      const host = networkInterface.host;
-
-      if (!addresses.has(address)) {
-        addresses.add(address);
-
-        zone.records.add(
-          createRecord(
-            fullName(host.domainName),
-            isIPv6Address(address) ? "AAAA" : "A",
-            normalizeIPAddress(address)
-          )
-        );
-
-        if (subnet) {
-          let reverseZone = reverseZones.get(subnet.address);
-
-          if (!reverseZone) {
-            const reverseArpa = reverseArpaAddress(subnet.prefix);
-            reverseZone = {
-              id: reverseArpa,
-              file: `${reverseArpa}.zone`,
-              records: new Set([SOARecord, NSRecord])
-            };
-            zones.push(reverseZone);
-            reverseZones.set(subnet.address, reverseZone);
-          }
-          reverseZone.records.add(
-            createRecord(
-              fullName(reverseArpaAddress(address)),
-              "PTR",
-              fullName(host.domainName)
-            )
-          );
-        }
-      }
-
-      if (!hosts.has(host)) {
-        hosts.add(host);
-        for (const service of host.findServices()) {
-          if (service.master && service.alias) {
-            zone.records.add(
-              createRecord(service.alias, "CNAME", fullName(host.domainName))
-            );
-          }
-
-          if (dns.hasSVRRecords && service.srvPrefix) {
-            zone.records.add(
-              createRecord(
-                fullName(`${service.srvPrefix}.${host.domainName}`),
-                "SRV",
-                service.priority,
-                service.weight,
-                service.port,
-                fullName(host.domainName)
-              )
-            );
-          }
-        }
-      }
-    }
-
-    const zoneConfig = [];
-
-    if (dns.hasCatalog) {
-      zones.push(catalogZone);
-    }
-
-    for (const zone of zones) {
-      if (zone !== catalogZone) {
-        const hash = createHmac("md5", zone.id).digest("hex");
-        catalogZone.records.add(
-          createRecord(`${hash}.zones.${domain}.`, "PTR", `${zone.id}.`)
-        );
-      }
-
-      zoneConfig.push(`zone \"${zone.id}\" {`);
-      zoneConfig.push(`  type master;`);
-      zoneConfig.push(`  file \"${zone.file}\";`);
-
-      zoneConfig.push(
-        `  allow-update { ${
-          dns.allowedUpdates.length ? dns.allowedUpdates.join(";") : "none"
-        }; };`
-      );
-      zoneConfig.push(`  notify ${dns.notify ? "yes" : "no"};`);
-      zoneConfig.push(`};`);
-      zoneConfig.push("");
-
-      maxKeyLength = 0;
-      for (const r of zone.records) {
-        if (r.key.length > maxKeyLength) {
-          maxKeyLength = r.key.length;
-        }
-      }
-
-      writeLines(join(targetDir, "var/lib/named"), zone.file, zone.records);
-    }
-
-    writeLines(
-      join(targetDir, "etc/named.d/zones"),
-      `${domain}.zone.conf`,
-      zoneConfig
-    );
-  }
-}
-
-export function reverseAddress(address) {
-  if (isIPv6Address(address)) {
-    return normalizeIPAddress(address)
-      .replaceAll(":", "")
-      .split("")
-      .reverse()
-      .join(".");
-  }
-
-  return address.split(".").reverse().join(".");
-}
-
-export function reverseArpaAddress(address) {
-  return (
-    reverseAddress(address) +
-    (isIPv6Address(address) ? ".ip6.arpa" : ".in-addr.arpa")
-  );
-}