mqtt2matter 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/LICENSE +202 -0
- package/NOTICE +23 -0
- package/README.md +164 -2
- package/dist/app.d.ts +34 -0
- package/dist/app.js +157 -0
- package/dist/app.js.map +1 -0
- package/dist/commands/import-z2m.d.ts +20 -0
- package/dist/commands/import-z2m.js +173 -0
- package/dist/commands/import-z2m.js.map +1 -0
- package/dist/commands/install.d.ts +41 -0
- package/dist/commands/install.js +250 -0
- package/dist/commands/install.js.map +1 -0
- package/dist/commands/update.d.ts +14 -0
- package/dist/commands/update.js +109 -0
- package/dist/commands/update.js.map +1 -0
- package/dist/config/index.d.ts +2 -0
- package/dist/config/index.js +3 -0
- package/dist/config/index.js.map +1 -0
- package/dist/config/load.d.ts +57 -0
- package/dist/config/load.js +137 -0
- package/dist/config/load.js.map +1 -0
- package/dist/config/schema.d.ts +496 -0
- package/dist/config/schema.js +115 -0
- package/dist/config/schema.js.map +1 -0
- package/dist/engine/payload.d.ts +88 -0
- package/dist/engine/payload.js +510 -0
- package/dist/engine/payload.js.map +1 -0
- package/dist/engine/runtime.d.ts +79 -0
- package/dist/engine/runtime.js +433 -0
- package/dist/engine/runtime.js.map +1 -0
- package/dist/engine/template.d.ts +20 -0
- package/dist/engine/template.js +247 -0
- package/dist/engine/template.js.map +1 -0
- package/dist/engine/units.d.ts +9 -0
- package/dist/engine/units.js +42 -0
- package/dist/engine/units.js.map +1 -0
- package/dist/families/climate.d.ts +11 -0
- package/dist/families/climate.js +68 -0
- package/dist/families/climate.js.map +1 -0
- package/dist/families/color.d.ts +30 -0
- package/dist/families/color.js +152 -0
- package/dist/families/color.js.map +1 -0
- package/dist/families/cover.d.ts +17 -0
- package/dist/families/cover.js +308 -0
- package/dist/families/cover.js.map +1 -0
- package/dist/families/fan.d.ts +16 -0
- package/dist/families/fan.js +152 -0
- package/dist/families/fan.js.map +1 -0
- package/dist/families/index.d.ts +31 -0
- package/dist/families/index.js +158 -0
- package/dist/families/index.js.map +1 -0
- package/dist/families/light.d.ts +36 -0
- package/dist/families/light.js +258 -0
- package/dist/families/light.js.map +1 -0
- package/dist/families/lock.d.ts +10 -0
- package/dist/families/lock.js +31 -0
- package/dist/families/lock.js.map +1 -0
- package/dist/families/on-off.d.ts +7 -0
- package/dist/families/on-off.js +56 -0
- package/dist/families/on-off.js.map +1 -0
- package/dist/families/power-source.d.ts +12 -0
- package/dist/families/power-source.js +55 -0
- package/dist/families/power-source.js.map +1 -0
- package/dist/families/registry.d.ts +40 -0
- package/dist/families/registry.js +72 -0
- package/dist/families/registry.js.map +1 -0
- package/dist/families/switch.d.ts +19 -0
- package/dist/families/switch.js +94 -0
- package/dist/families/switch.js.map +1 -0
- package/dist/importers/actions.d.ts +19 -0
- package/dist/importers/actions.js +98 -0
- package/dist/importers/actions.js.map +1 -0
- package/dist/importers/ha/areas.d.ts +6 -0
- package/dist/importers/ha/areas.js +279 -0
- package/dist/importers/ha/areas.js.map +1 -0
- package/dist/importers/ha/generate.d.ts +51 -0
- package/dist/importers/ha/generate.js +1373 -0
- package/dist/importers/ha/generate.js.map +1 -0
- package/dist/importers/ha/index.d.ts +6 -0
- package/dist/importers/ha/index.js +7 -0
- package/dist/importers/ha/index.js.map +1 -0
- package/dist/importers/ha/source.d.ts +36 -0
- package/dist/importers/ha/source.js +95 -0
- package/dist/importers/ha/source.js.map +1 -0
- package/dist/importers/ha/sync.d.ts +29 -0
- package/dist/importers/ha/sync.js +132 -0
- package/dist/importers/ha/sync.js.map +1 -0
- package/dist/importers/ha/templates.d.ts +18 -0
- package/dist/importers/ha/templates.js +285 -0
- package/dist/importers/ha/templates.js.map +1 -0
- package/dist/importers/ha/types.d.ts +78 -0
- package/dist/importers/ha/types.js +479 -0
- package/dist/importers/ha/types.js.map +1 -0
- package/dist/importers/index.d.ts +5 -0
- package/dist/importers/index.js +8 -0
- package/dist/importers/index.js.map +1 -0
- package/dist/importers/patch.d.ts +50 -0
- package/dist/importers/patch.js +224 -0
- package/dist/importers/patch.js.map +1 -0
- package/dist/importers/sync.d.ts +112 -0
- package/dist/importers/sync.js +220 -0
- package/dist/importers/sync.js.map +1 -0
- package/dist/importers/twins.d.ts +10 -0
- package/dist/importers/twins.js +34 -0
- package/dist/importers/twins.js.map +1 -0
- package/dist/importers/z2m/generate.d.ts +81 -0
- package/dist/importers/z2m/generate.js +1164 -0
- package/dist/importers/z2m/generate.js.map +1 -0
- package/dist/importers/z2m/index.d.ts +5 -0
- package/dist/importers/z2m/index.js +6 -0
- package/dist/importers/z2m/index.js.map +1 -0
- package/dist/importers/z2m/source.d.ts +18 -0
- package/dist/importers/z2m/source.js +46 -0
- package/dist/importers/z2m/source.js.map +1 -0
- package/dist/importers/z2m/sync.d.ts +29 -0
- package/dist/importers/z2m/sync.js +92 -0
- package/dist/importers/z2m/sync.js.map +1 -0
- package/dist/importers/z2m/types.d.ts +72 -0
- package/dist/importers/z2m/types.js +46 -0
- package/dist/importers/z2m/types.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -0
- package/dist/log.d.ts +17 -0
- package/dist/log.js +54 -0
- package/dist/log.js.map +1 -0
- package/dist/main.d.ts +2 -0
- package/dist/main.js +202 -0
- package/dist/main.js.map +1 -0
- package/dist/matter/bridge.d.ts +113 -0
- package/dist/matter/bridge.js +467 -0
- package/dist/matter/bridge.js.map +1 -0
- package/dist/matter/check.d.ts +11 -0
- package/dist/matter/check.js +116 -0
- package/dist/matter/check.js.map +1 -0
- package/dist/matter/cluster-defaults.d.ts +6 -0
- package/dist/matter/cluster-defaults.js +63 -0
- package/dist/matter/cluster-defaults.js.map +1 -0
- package/dist/matter/commissioning.d.ts +21 -0
- package/dist/matter/commissioning.js +88 -0
- package/dist/matter/commissioning.js.map +1 -0
- package/dist/matter/device-types.d.ts +44 -0
- package/dist/matter/device-types.js +230 -0
- package/dist/matter/device-types.js.map +1 -0
- package/dist/matter/ids.d.ts +31 -0
- package/dist/matter/ids.js +83 -0
- package/dist/matter/ids.js.map +1 -0
- package/dist/matter/index.d.ts +7 -0
- package/dist/matter/index.js +8 -0
- package/dist/matter/index.js.map +1 -0
- package/dist/matter/node-manager.d.ts +39 -0
- package/dist/matter/node-manager.js +161 -0
- package/dist/matter/node-manager.js.map +1 -0
- package/dist/matter/shards.d.ts +26 -0
- package/dist/matter/shards.js +93 -0
- package/dist/matter/shards.js.map +1 -0
- package/dist/model/attribute.d.ts +18 -0
- package/dist/model/attribute.js +28 -0
- package/dist/model/attribute.js.map +1 -0
- package/dist/model/catalog.d.ts +79 -0
- package/dist/model/catalog.js +220 -0
- package/dist/model/catalog.js.map +1 -0
- package/dist/model/index.d.ts +7 -0
- package/dist/model/index.js +8 -0
- package/dist/model/index.js.map +1 -0
- package/dist/model/migrate.d.ts +4 -0
- package/dist/model/migrate.js +39 -0
- package/dist/model/migrate.js.map +1 -0
- package/dist/model/options.d.ts +102 -0
- package/dist/model/options.js +88 -0
- package/dist/model/options.js.map +1 -0
- package/dist/model/presets.d.ts +37 -0
- package/dist/model/presets.js +105 -0
- package/dist/model/presets.js.map +1 -0
- package/dist/model/schema.d.ts +1747 -0
- package/dist/model/schema.js +240 -0
- package/dist/model/schema.js.map +1 -0
- package/dist/model/validate.d.ts +21 -0
- package/dist/model/validate.js +478 -0
- package/dist/model/validate.js.map +1 -0
- package/dist/mqtt/client.d.ts +38 -0
- package/dist/mqtt/client.js +94 -0
- package/dist/mqtt/client.js.map +1 -0
- package/dist/mqtt/index.d.ts +2 -0
- package/dist/mqtt/index.js +3 -0
- package/dist/mqtt/index.js.map +1 -0
- package/dist/mqtt/topic-cache.d.ts +20 -0
- package/dist/mqtt/topic-cache.js +58 -0
- package/dist/mqtt/topic-cache.js.map +1 -0
- package/dist/server/auth.d.ts +59 -0
- package/dist/server/auth.js +185 -0
- package/dist/server/auth.js.map +1 -0
- package/dist/server/catalog.d.ts +52 -0
- package/dist/server/catalog.js +96 -0
- package/dist/server/catalog.js.map +1 -0
- package/dist/server/compact.d.ts +3 -0
- package/dist/server/compact.js +105 -0
- package/dist/server/compact.js.map +1 -0
- package/dist/server/config-store.d.ts +36 -0
- package/dist/server/config-store.js +155 -0
- package/dist/server/config-store.js.map +1 -0
- package/dist/server/events.d.ts +50 -0
- package/dist/server/events.js +71 -0
- package/dist/server/events.js.map +1 -0
- package/dist/server/http.d.ts +27 -0
- package/dist/server/http.js +168 -0
- package/dist/server/http.js.map +1 -0
- package/dist/server/importers.d.ts +40 -0
- package/dist/server/importers.js +75 -0
- package/dist/server/importers.js.map +1 -0
- package/dist/server/index.d.ts +6 -0
- package/dist/server/index.js +8 -0
- package/dist/server/index.js.map +1 -0
- package/dist/server/log-buffer.d.ts +22 -0
- package/dist/server/log-buffer.js +55 -0
- package/dist/server/log-buffer.js.map +1 -0
- package/dist/server/presets.d.ts +17 -0
- package/dist/server/presets.js +55 -0
- package/dist/server/presets.js.map +1 -0
- package/dist/server/preview.d.ts +19 -0
- package/dist/server/preview.js +121 -0
- package/dist/server/preview.js.map +1 -0
- package/dist/server/server.d.ts +107 -0
- package/dist/server/server.js +810 -0
- package/dist/server/server.js.map +1 -0
- package/dist/server/update.d.ts +60 -0
- package/dist/server/update.js +191 -0
- package/dist/server/update.js.map +1 -0
- package/docs/api.md +128 -0
- package/docs/architecture.md +121 -0
- package/docs/config.md +409 -0
- package/docs/importers.md +241 -0
- package/example/mqtt2matter.json +276 -0
- package/package.json +90 -4
- package/presets/tasmota/relay.json +28 -0
- package/ui/dist/assets/index-BDtT6bdH.js +10 -0
- package/ui/dist/assets/index-CHiG-aoU.css +1 -0
- package/ui/dist/index.html +18 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { z2m } from '../importers/index.ts';
|
|
2
|
+
import { type Logger } from '../log.ts';
|
|
3
|
+
export interface ImportZ2mArgs {
|
|
4
|
+
configPath?: string | undefined;
|
|
5
|
+
baseTopic: string;
|
|
6
|
+
dryRun: boolean;
|
|
7
|
+
groups: boolean;
|
|
8
|
+
/** seconds to wait for the retained bridge topics */
|
|
9
|
+
timeout: number;
|
|
10
|
+
}
|
|
11
|
+
export declare function parseImportArgs(argv: readonly string[]): ImportZ2mArgs;
|
|
12
|
+
/** one line per device, the way the report reads on a terminal */
|
|
13
|
+
export declare function formatReport(report: readonly z2m.SyncEntry[]): string[];
|
|
14
|
+
export interface ImportIo {
|
|
15
|
+
out(line: string): void;
|
|
16
|
+
log?: Logger;
|
|
17
|
+
env?: Record<string, string | undefined>;
|
|
18
|
+
}
|
|
19
|
+
/** run the import; returns the process exit code */
|
|
20
|
+
export declare function importZ2m(args: ImportZ2mArgs, io: ImportIo): Promise<number>;
|
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
/* `mqtt2matter --import-z2m [config.json] [--base-topic zigbee2mqtt] [--dry-run] [--no-groups]
|
|
2
|
+
[--timeout 15]`: connect to the broker of the configuration, read the retained `bridge/devices` and
|
|
3
|
+
`bridge/groups`, adopt every supported device that is not in the file yet, re-sync the ones that are
|
|
4
|
+
(the user's edits carried over, conflicts listed), mark the ones zigbee2mqtt no longer describes as
|
|
5
|
+
orphaned, write the file back and report. The normal start afterwards logs the pairing code. */
|
|
6
|
+
import { writeFile } from 'node:fs/promises';
|
|
7
|
+
import { applyEnv, ConfigError, loadConfig, parseConfig } from "../config/index.js";
|
|
8
|
+
import { z2m } from "../importers/index.js";
|
|
9
|
+
import { describeError, silentLogger } from "../log.js";
|
|
10
|
+
import { DevicesSchema, validateDevices } from "../model/index.js";
|
|
11
|
+
import { MqttClient } from "../mqtt/index.js";
|
|
12
|
+
export function parseImportArgs(argv) {
|
|
13
|
+
const args = { baseTopic: z2m.DEFAULT_BASE_TOPIC, dryRun: false, groups: true, timeout: 15 };
|
|
14
|
+
for (let i = 0; i < argv.length; i++) {
|
|
15
|
+
const arg = argv[i] ?? '';
|
|
16
|
+
if (arg === '--base-topic') {
|
|
17
|
+
args.baseTopic = argv[++i] ?? args.baseTopic;
|
|
18
|
+
}
|
|
19
|
+
else if (arg.startsWith('--base-topic=')) {
|
|
20
|
+
args.baseTopic = arg.slice('--base-topic='.length);
|
|
21
|
+
}
|
|
22
|
+
else if (arg === '--dry-run') {
|
|
23
|
+
args.dryRun = true;
|
|
24
|
+
}
|
|
25
|
+
else if (arg === '--no-groups') {
|
|
26
|
+
args.groups = false;
|
|
27
|
+
}
|
|
28
|
+
else if (arg === '--timeout') {
|
|
29
|
+
args.timeout = Number(argv[++i] ?? args.timeout);
|
|
30
|
+
}
|
|
31
|
+
else if (arg.startsWith('--timeout=')) {
|
|
32
|
+
args.timeout = Number(arg.slice('--timeout='.length));
|
|
33
|
+
}
|
|
34
|
+
else if (arg.startsWith('--')) {
|
|
35
|
+
throw new ConfigError(`unknown option ${arg}`);
|
|
36
|
+
}
|
|
37
|
+
else {
|
|
38
|
+
args.configPath = arg;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
if (!Number.isFinite(args.timeout) || args.timeout <= 0) {
|
|
42
|
+
throw new ConfigError('--timeout needs a number of seconds');
|
|
43
|
+
}
|
|
44
|
+
return args;
|
|
45
|
+
}
|
|
46
|
+
function isRecord(value) {
|
|
47
|
+
return typeof value === 'object' && value !== null && !Array.isArray(value);
|
|
48
|
+
}
|
|
49
|
+
const MARK = {
|
|
50
|
+
new: '+',
|
|
51
|
+
updated: '~',
|
|
52
|
+
restored: '~',
|
|
53
|
+
unchanged: '=',
|
|
54
|
+
orphaned: '-',
|
|
55
|
+
invalid: '!',
|
|
56
|
+
unsupported: '?',
|
|
57
|
+
covered: '*',
|
|
58
|
+
};
|
|
59
|
+
/** one line per device, the way the report reads on a terminal */
|
|
60
|
+
export function formatReport(report) {
|
|
61
|
+
const lines = [];
|
|
62
|
+
for (const entry of report) {
|
|
63
|
+
const types = entry.device?.endpoints.map((e) => `${e.id ?? 'main'}: ${e.deviceTypes.join('+')}`).join(', ');
|
|
64
|
+
const detail = entry.status === 'unsupported' || entry.status === 'invalid'
|
|
65
|
+
? entry.notes.join('; ')
|
|
66
|
+
: entry.status === 'covered'
|
|
67
|
+
? `the same device as ${entry.covered ?? '?'}: not adopted (the UI can replace it)`
|
|
68
|
+
: (types ?? '');
|
|
69
|
+
lines.push(`${MARK[entry.status]} ${entry.status.padEnd(11)} ${entry.key} ${entry.name} ${detail}`);
|
|
70
|
+
for (const conflict of entry.conflicts) {
|
|
71
|
+
lines.push(` conflict ${conflict.path}: ${conflict.reason} (edit ${JSON.stringify(conflict.user)}, importer ${JSON.stringify(conflict.now)})`);
|
|
72
|
+
}
|
|
73
|
+
if (entry.unmapped.length > 0 && entry.status !== 'unchanged') {
|
|
74
|
+
lines.push(` not mapped: ${entry.unmapped.join(', ')}`);
|
|
75
|
+
}
|
|
76
|
+
if (entry.status === 'invalid') {
|
|
77
|
+
for (const note of entry.notes) {
|
|
78
|
+
lines.push(` ${note}`);
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
return lines;
|
|
83
|
+
}
|
|
84
|
+
/** run the import; returns the process exit code */
|
|
85
|
+
export async function importZ2m(args, io) {
|
|
86
|
+
const env = io.env ?? process.env;
|
|
87
|
+
const log = io.log ?? silentLogger;
|
|
88
|
+
const { config, path, raw } = await loadConfig({
|
|
89
|
+
...(args.configPath === undefined ? {} : { path: args.configPath }),
|
|
90
|
+
env,
|
|
91
|
+
});
|
|
92
|
+
const existing = DevicesSchema.safeParse(raw.devices ?? {});
|
|
93
|
+
if (!existing.success) {
|
|
94
|
+
throw new ConfigError(`${path}: the devices do not validate; fix the file first`);
|
|
95
|
+
}
|
|
96
|
+
const devices = (isRecord(raw.devices) ? raw.devices : {});
|
|
97
|
+
const source = new z2m.Z2mSource(args.baseTopic);
|
|
98
|
+
const mqtt = new MqttClient({
|
|
99
|
+
url: config.mqtt.url,
|
|
100
|
+
username: config.mqtt.username,
|
|
101
|
+
password: config.mqtt.password,
|
|
102
|
+
clientId: config.mqtt.clientId,
|
|
103
|
+
connectTimeout: args.timeout * 1000,
|
|
104
|
+
}, log.child('mqtt'));
|
|
105
|
+
io.out(`connecting to ${config.mqtt.url}, reading ${source.devicesTopic}${args.groups ? ` and ${source.groupsTopic}` : ''}`);
|
|
106
|
+
let error;
|
|
107
|
+
mqtt.on('message', (topic, payload) => {
|
|
108
|
+
try {
|
|
109
|
+
source.handle(topic, payload);
|
|
110
|
+
}
|
|
111
|
+
catch (e) {
|
|
112
|
+
error = e;
|
|
113
|
+
}
|
|
114
|
+
});
|
|
115
|
+
try {
|
|
116
|
+
await mqtt.connect();
|
|
117
|
+
await mqtt.subscribe(source.devicesTopic);
|
|
118
|
+
if (args.groups) {
|
|
119
|
+
await mqtt.subscribe(source.groupsTopic);
|
|
120
|
+
}
|
|
121
|
+
const deadline = Date.now() + args.timeout * 1000;
|
|
122
|
+
while (source.devices === undefined && error === undefined && Date.now() < deadline) {
|
|
123
|
+
await new Promise((resolve) => setTimeout(resolve, 50));
|
|
124
|
+
}
|
|
125
|
+
if (error !== undefined) {
|
|
126
|
+
throw error instanceof Error ? error : new Error(describeError(error));
|
|
127
|
+
}
|
|
128
|
+
if (source.devices === undefined) {
|
|
129
|
+
throw new ConfigError(`no retained ${source.devicesTopic} within ${args.timeout} s — is zigbee2mqtt on this broker, and is its base topic "${args.baseTopic}"?`);
|
|
130
|
+
}
|
|
131
|
+
// the groups come right after the devices; give them a moment
|
|
132
|
+
const groupsDeadline = Date.now() + 2000;
|
|
133
|
+
while (args.groups && source.groups === undefined && Date.now() < groupsDeadline) {
|
|
134
|
+
await new Promise((resolve) => setTimeout(resolve, 50));
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
finally {
|
|
138
|
+
await mqtt.close();
|
|
139
|
+
}
|
|
140
|
+
if (!args.groups) {
|
|
141
|
+
source.groups = undefined;
|
|
142
|
+
}
|
|
143
|
+
const discovery = source.discover();
|
|
144
|
+
const { devices: adopted, report } = z2m.adopt(devices, discovery);
|
|
145
|
+
for (const line of formatReport(report)) {
|
|
146
|
+
io.out(line);
|
|
147
|
+
}
|
|
148
|
+
const count = (status) => report.filter((e) => e.status === status).length;
|
|
149
|
+
io.out(`${count('new')} new, ${count('updated') + count('restored')} updated, ${count('unchanged')} unchanged, ${count('orphaned')} orphaned, ${count('invalid')} invalid, ${count('unsupported')} unsupported`);
|
|
150
|
+
const nextRaw = { ...raw, devices: adopted };
|
|
151
|
+
const next = parseConfig(applyEnv(nextRaw, env));
|
|
152
|
+
let errors = 0;
|
|
153
|
+
for (const [key, result] of validateDevices(next.devices)) {
|
|
154
|
+
for (const issue of result.issues) {
|
|
155
|
+
io.out(`${issue.level.toUpperCase()} ${key} ${issue.path}: ${issue.message}`);
|
|
156
|
+
if (issue.level === 'error') {
|
|
157
|
+
errors++;
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
if (args.dryRun) {
|
|
162
|
+
io.out(`dry run: ${path} not written`);
|
|
163
|
+
}
|
|
164
|
+
else {
|
|
165
|
+
await writeFile(path, `${JSON.stringify(nextRaw, null, 2)}\n`, 'utf8');
|
|
166
|
+
io.out(`written ${path}: ${Object.keys(adopted).length} devices`);
|
|
167
|
+
}
|
|
168
|
+
if (errors > 0) {
|
|
169
|
+
io.out(`${errors} device(s) have errors and will not be built; edit them or run --check`);
|
|
170
|
+
}
|
|
171
|
+
return 0;
|
|
172
|
+
}
|
|
173
|
+
//# sourceMappingURL=import-z2m.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"import-z2m.js","sourceRoot":"","sources":["../../src/commands/import-z2m.ts"],"names":[],"mappings":"AAAA;;;;kGAIkG;AAElG,OAAO,EAAC,SAAS,EAAC,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAC,GAAG,EAAC,MAAM,uBAAuB,CAAC;AAC1C,OAAO,EAAC,aAAa,EAAe,YAAY,EAAC,MAAM,WAAW,CAAC;AACnE,OAAO,EAAC,aAAa,EAAqB,eAAe,EAAC,MAAM,mBAAmB,CAAC;AACpF,OAAO,EAAC,UAAU,EAAC,MAAM,kBAAkB,CAAC;AAW5C,MAAM,UAAU,eAAe,CAAC,IAAuB;IACnD,MAAM,IAAI,GAAkB,EAAC,SAAS,EAAE,GAAG,CAAC,kBAAkB,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAC,CAAC;IAC1G,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,GAAG,KAAK,cAAc,EAAE,CAAC;YACzB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC;QACjD,CAAC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC;aAAM,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACvB,CAAC;aAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACxB,CAAC;aAAM,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1D,CAAC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,WAAW,CAAC,kBAAkB,GAAG,EAAE,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QAC1B,CAAC;IACL,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,WAAW,CAAC,qCAAqC,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,IAAI,GAAmC;IACzC,GAAG,EAAE,GAAG;IACR,OAAO,EAAE,GAAG;IACZ,QAAQ,EAAE,GAAG;IACb,SAAS,EAAE,GAAG;IACd,QAAQ,EAAE,GAAG;IACb,OAAO,EAAE,GAAG;IACZ,WAAW,EAAE,GAAG;IAChB,OAAO,EAAE,GAAG;CACf,CAAC;AAEF,kEAAkE;AAClE,MAAM,UAAU,YAAY,CAAC,MAAgC;IACzD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,MAAM,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7G,MAAM,MAAM,GACR,KAAK,CAAC,MAAM,KAAK,aAAa,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YACxD,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;YACxB,CAAC,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS;gBAC1B,CAAC,CAAC,sBAAsB,KAAK,CAAC,OAAO,IAAI,GAAG,uCAAuC;gBACnF,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC,CAAC;QACtG,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACrC,KAAK,CAAC,IAAI,CACN,gBAAgB,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,UAAU,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CACxI,CAAC;QACN,CAAC;QACD,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YAC5D,KAAK,CAAC,IAAI,CAAC,mBAAmB,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAQD,oDAAoD;AACpD,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAmB,EAAE,EAAY;IAC7D,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IAClC,MAAM,GAAG,GAAG,EAAE,CAAC,GAAG,IAAI,YAAY,CAAC;IACnC,MAAM,EAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAC,GAAG,MAAM,UAAU,CAAC;QACzC,GAAG,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAC,CAAC;QACjE,GAAG;KACN,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAC5D,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,WAAW,CAAC,GAAG,IAAI,mDAAmD,CAAC,CAAC;IACtF,CAAC;IACD,MAAM,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAiB,CAAC;IAE3E,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,IAAI,UAAU,CACvB;QACI,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QACpB,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ;QAC9B,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ;QAC9B,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ;QAC9B,cAAc,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI;KACtC,EACD,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CACpB,CAAC;IACF,EAAE,CAAC,GAAG,CACF,iBAAiB,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CACvH,CAAC;IACF,IAAI,KAAc,CAAC;IACnB,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;QAClC,IAAI,CAAC;YACD,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAClC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,KAAK,GAAG,CAAC,CAAC;QACd,CAAC;IACL,CAAC,CAAC,CAAC;IACH,IAAI,CAAC;QACD,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAC1C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACd,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAClD,OAAO,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;YAClF,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,WAAW,CACjB,eAAe,MAAM,CAAC,YAAY,WAAW,IAAI,CAAC,OAAO,8DAA8D,IAAI,CAAC,SAAS,IAAI,CAC5I,CAAC;QACN,CAAC;QACD,8DAA8D;QAC9D,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,EAAE,CAAC;YAC/E,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;YAAS,CAAC;QACP,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC;IAC9B,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;IACpC,MAAM,EAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAC,GAAG,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACjE,KAAK,MAAM,IAAI,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,MAAsB,EAAU,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IACnG,EAAE,CAAC,GAAG,CACF,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,KAAK,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,aAAa,KAAK,CAAC,WAAW,CAAC,eAAe,KAAK,CAAC,UAAU,CAAC,cAAc,KAAK,CAAC,SAAS,CAAC,aAAa,KAAK,CAAC,aAAa,CAAC,cAAc,CAC3M,CAAC;IACF,MAAM,OAAO,GAAG,EAAC,GAAG,GAAG,EAAE,OAAO,EAAE,OAAO,EAAC,CAAC;IAC3C,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;IACjD,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACxD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAChC,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,GAAG,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9E,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC1B,MAAM,EAAE,CAAC;YACb,CAAC;QACL,CAAC;IACL,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,EAAE,CAAC,GAAG,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;IAC3C,CAAC;SAAM,CAAC;QACJ,MAAM,SAAS,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvE,EAAE,CAAC,GAAG,CAAC,WAAW,IAAI,KAAK,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACb,EAAE,CAAC,GAAG,CAAC,GAAG,MAAM,wEAAwE,CAAC,CAAC;IAC9F,CAAC;IACD,OAAO,CAAC,CAAC;AACb,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
export declare const SERVICE = "mqtt2matter";
|
|
2
|
+
export declare const UNIT_PATH = "/etc/systemd/system/mqtt2matter.service";
|
|
3
|
+
export declare const CONFIG_DIR = "/etc/mqtt2matter";
|
|
4
|
+
export declare const CONFIG_FILE = "/etc/mqtt2matter/mqtt2matter.json";
|
|
5
|
+
export declare const STATE_DIR = "/var/lib/mqtt2matter";
|
|
6
|
+
export declare const UPDATE_DIR = "/var/lib/mqtt2matter/update";
|
|
7
|
+
export declare const UPDATE_PATH_UNIT = "/etc/systemd/system/mqtt2matter-update.path";
|
|
8
|
+
export declare const UPDATE_SERVICE_UNIT = "/etc/systemd/system/mqtt2matter-update.service";
|
|
9
|
+
/** the exit code of a restart from the UI: the unit restarts the service on it (RestartForceExitStatus) and counts
|
|
10
|
+
it as a clean stop (SuccessExitStatus) */
|
|
11
|
+
export declare const RESTART_EXIT_CODE = 75;
|
|
12
|
+
export interface InstallArgs {
|
|
13
|
+
uninstall: boolean;
|
|
14
|
+
dryRun: boolean;
|
|
15
|
+
/** the broker written into a new configuration file */
|
|
16
|
+
mqttUrl?: string | undefined;
|
|
17
|
+
}
|
|
18
|
+
export declare function parseInstallArgs(argv: readonly string[]): InstallArgs;
|
|
19
|
+
/** what the installer needs from the host; the CLI passes the real ones, the tests fakes */
|
|
20
|
+
export interface InstallHost {
|
|
21
|
+
/** prepended to every path written or read: '' on a real host, a temporary directory in the tests */
|
|
22
|
+
root: string;
|
|
23
|
+
/** the node binary and the package's main.js, as the unit starts them */
|
|
24
|
+
execStart: string;
|
|
25
|
+
/** run a command; throws when it fails */
|
|
26
|
+
exec(command: string, args: readonly string[]): void;
|
|
27
|
+
/** whether a command succeeds */
|
|
28
|
+
succeeds(command: string, args: readonly string[]): boolean;
|
|
29
|
+
/** why this host cannot install a service (not Linux, not root, no systemd), or undefined */
|
|
30
|
+
unsuitable(): string | undefined;
|
|
31
|
+
out(line: string): void;
|
|
32
|
+
}
|
|
33
|
+
export declare function unitFile(execStart: string): string;
|
|
34
|
+
export declare function updatePathUnit(): string;
|
|
35
|
+
/** the root oneshot: installs the requested version with npm and restarts the service */
|
|
36
|
+
export declare function updateServiceUnit(execStart: string): string;
|
|
37
|
+
/** a new configuration file: the broker and the storage; everything else is the schema's default */
|
|
38
|
+
export declare function initialConfig(mqttUrl: string | undefined): string;
|
|
39
|
+
export declare function runInstall(args: InstallArgs, host: InstallHost): Promise<void>;
|
|
40
|
+
/** this host, as `sudo mqtt2matter --install` finds it */
|
|
41
|
+
export declare function systemHost(out: (line: string) => void): InstallHost;
|
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
/* `mqtt2matter --install [--mqtt-url <url>] [--dry-run]` and `mqtt2matter --uninstall`: run mqtt2matter as the
|
|
2
|
+
systemd service `mqtt2matter.service`.
|
|
3
|
+
|
|
4
|
+
/etc/systemd/system/mqtt2matter.service the unit, rewritten on every --install (ExecStart follows node)
|
|
5
|
+
/etc/systemd/system/mqtt2matter-update.path, mqtt2matter-update.service
|
|
6
|
+
the update from the UI: the path unit sees the request the service
|
|
7
|
+
writes into /var/lib/mqtt2matter/update and starts the root oneshot
|
|
8
|
+
`mqtt2matter --apply-update` (commands/update.ts)
|
|
9
|
+
/etc/mqtt2matter/mqtt2matter.json the configuration; created once, never overwritten — the UI edits it,
|
|
10
|
+
so the directory belongs to the service user
|
|
11
|
+
/var/lib/mqtt2matter/ matter.js storage (fabrics, endpoint numbers) and the shard map
|
|
12
|
+
system user mqtt2matter the unit runs as it
|
|
13
|
+
|
|
14
|
+
One process serves every bridge, so there is one unit, not one per instance. Uninstalling keeps the
|
|
15
|
+
configuration and the storage: the fabrics in it are what the controllers paired with. */
|
|
16
|
+
import { execFileSync } from 'node:child_process';
|
|
17
|
+
import { existsSync, realpathSync } from 'node:fs';
|
|
18
|
+
import { chmod, mkdir, rm, stat, writeFile } from 'node:fs/promises';
|
|
19
|
+
import { join } from 'node:path';
|
|
20
|
+
import { ConfigError } from "../config/index.js";
|
|
21
|
+
export const SERVICE = 'mqtt2matter';
|
|
22
|
+
export const UNIT_PATH = `/etc/systemd/system/${SERVICE}.service`;
|
|
23
|
+
export const CONFIG_DIR = `/etc/${SERVICE}`;
|
|
24
|
+
export const CONFIG_FILE = `${CONFIG_DIR}/${SERVICE}.json`;
|
|
25
|
+
export const STATE_DIR = `/var/lib/${SERVICE}`;
|
|
26
|
+
export const UPDATE_DIR = `${STATE_DIR}/update`;
|
|
27
|
+
export const UPDATE_PATH_UNIT = `/etc/systemd/system/${SERVICE}-update.path`;
|
|
28
|
+
export const UPDATE_SERVICE_UNIT = `/etc/systemd/system/${SERVICE}-update.service`;
|
|
29
|
+
/** the exit code of a restart from the UI: the unit restarts the service on it (RestartForceExitStatus) and counts
|
|
30
|
+
it as a clean stop (SuccessExitStatus) */
|
|
31
|
+
export const RESTART_EXIT_CODE = 75;
|
|
32
|
+
export function parseInstallArgs(argv) {
|
|
33
|
+
const args = { uninstall: false, dryRun: false };
|
|
34
|
+
for (let i = 0; i < argv.length; i++) {
|
|
35
|
+
const arg = argv[i] ?? '';
|
|
36
|
+
if (arg === '--install') {
|
|
37
|
+
continue;
|
|
38
|
+
}
|
|
39
|
+
else if (arg === '--uninstall') {
|
|
40
|
+
args.uninstall = true;
|
|
41
|
+
}
|
|
42
|
+
else if (arg === '--dry-run') {
|
|
43
|
+
args.dryRun = true;
|
|
44
|
+
}
|
|
45
|
+
else if (arg === '--mqtt-url') {
|
|
46
|
+
args.mqttUrl = argv[++i];
|
|
47
|
+
if (args.mqttUrl === undefined || args.mqttUrl === '') {
|
|
48
|
+
throw new ConfigError('--mqtt-url needs a URL');
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
else if (arg.startsWith('--mqtt-url=')) {
|
|
52
|
+
args.mqttUrl = arg.slice('--mqtt-url='.length);
|
|
53
|
+
}
|
|
54
|
+
else {
|
|
55
|
+
throw new ConfigError(`unknown option ${arg}`);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
return args;
|
|
59
|
+
}
|
|
60
|
+
export function unitFile(execStart) {
|
|
61
|
+
return `[Unit]
|
|
62
|
+
Description=mqtt2matter: MQTT to Matter bridge
|
|
63
|
+
Documentation=https://github.com/hobbyquaker/mqtt2matter#readme
|
|
64
|
+
After=network-online.target
|
|
65
|
+
Wants=network-online.target
|
|
66
|
+
|
|
67
|
+
[Service]
|
|
68
|
+
Type=simple
|
|
69
|
+
User=${SERVICE}
|
|
70
|
+
Group=${SERVICE}
|
|
71
|
+
Environment=MQTT2MATTER_CONFIG=${CONFIG_FILE}
|
|
72
|
+
# the UI's restart and update: an exit with ${RESTART_EXIT_CODE} comes back; the update goes through ${SERVICE}-update.path
|
|
73
|
+
Environment=MQTT2MATTER_SUPERVISOR=systemd
|
|
74
|
+
Environment=MQTT2MATTER_UPDATE_DIR=${UPDATE_DIR}
|
|
75
|
+
WorkingDirectory=${STATE_DIR}
|
|
76
|
+
ExecStart=${execStart}
|
|
77
|
+
Restart=on-failure
|
|
78
|
+
RestartForceExitStatus=${RESTART_EXIT_CODE}
|
|
79
|
+
# …and is a clean stop, not a failure, in the journal (the forced restart happens all the same)
|
|
80
|
+
SuccessExitStatus=${RESTART_EXIT_CODE}
|
|
81
|
+
RestartSec=5
|
|
82
|
+
TimeoutStopSec=30
|
|
83
|
+
SyslogIdentifier=${SERVICE}
|
|
84
|
+
StateDirectory=${SERVICE}
|
|
85
|
+
StateDirectoryMode=0750
|
|
86
|
+
# the UI writes the configuration back
|
|
87
|
+
ReadWritePaths=${CONFIG_DIR}
|
|
88
|
+
NoNewPrivileges=true
|
|
89
|
+
ProtectSystem=full
|
|
90
|
+
ProtectHome=true
|
|
91
|
+
PrivateTmp=true
|
|
92
|
+
|
|
93
|
+
[Install]
|
|
94
|
+
WantedBy=multi-user.target
|
|
95
|
+
`;
|
|
96
|
+
}
|
|
97
|
+
export function updatePathUnit() {
|
|
98
|
+
return `[Unit]
|
|
99
|
+
Description=mqtt2matter: an update requested from the UI
|
|
100
|
+
|
|
101
|
+
[Path]
|
|
102
|
+
PathExists=${UPDATE_DIR}/request
|
|
103
|
+
Unit=${SERVICE}-update.service
|
|
104
|
+
|
|
105
|
+
[Install]
|
|
106
|
+
WantedBy=multi-user.target
|
|
107
|
+
`;
|
|
108
|
+
}
|
|
109
|
+
/** the root oneshot: installs the requested version with npm and restarts the service */
|
|
110
|
+
export function updateServiceUnit(execStart) {
|
|
111
|
+
return `[Unit]
|
|
112
|
+
Description=mqtt2matter: install the version requested from the UI, then restart mqtt2matter
|
|
113
|
+
|
|
114
|
+
[Service]
|
|
115
|
+
Type=oneshot
|
|
116
|
+
# npm keeps its cache under HOME, which systemd does not set for a system service
|
|
117
|
+
Environment=HOME=/root
|
|
118
|
+
ExecStart=${execStart} --apply-update
|
|
119
|
+
TimeoutStartSec=900
|
|
120
|
+
SyslogIdentifier=${SERVICE}-update
|
|
121
|
+
`;
|
|
122
|
+
}
|
|
123
|
+
/** a new configuration file: the broker and the storage; everything else is the schema's default */
|
|
124
|
+
export function initialConfig(mqttUrl) {
|
|
125
|
+
return `${JSON.stringify({ mqtt: { url: mqttUrl ?? 'mqtt://localhost:1883' }, storage: STATE_DIR, devices: {} }, null, 2)}\n`;
|
|
126
|
+
}
|
|
127
|
+
async function exists(path) {
|
|
128
|
+
try {
|
|
129
|
+
await stat(path);
|
|
130
|
+
return true;
|
|
131
|
+
}
|
|
132
|
+
catch {
|
|
133
|
+
return false;
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
async function install(args, host) {
|
|
137
|
+
const at = (path) => join(host.root, path);
|
|
138
|
+
const unit = unitFile(host.execStart);
|
|
139
|
+
const configExists = await exists(at(CONFIG_FILE));
|
|
140
|
+
if (args.dryRun) {
|
|
141
|
+
host.out(`would write ${UNIT_PATH}:\n\n${unit}`);
|
|
142
|
+
host.out(configExists ? `would keep ${CONFIG_FILE}` : `would create ${CONFIG_FILE}:\n${initialConfig(args.mqttUrl)}`);
|
|
143
|
+
host.out(`would write ${UPDATE_PATH_UNIT}:\n\n${updatePathUnit()}`);
|
|
144
|
+
host.out(`would write ${UPDATE_SERVICE_UNIT}:\n\n${updateServiceUnit(host.execStart)}`);
|
|
145
|
+
host.out(`would create the system user ${SERVICE}, ${STATE_DIR}, ${UPDATE_DIR}, enable ${SERVICE}-update.path, and enable and start ${SERVICE}.service`);
|
|
146
|
+
return;
|
|
147
|
+
}
|
|
148
|
+
const reason = host.unsuitable();
|
|
149
|
+
if (reason !== undefined) {
|
|
150
|
+
throw new ConfigError(`--install: ${reason}`);
|
|
151
|
+
}
|
|
152
|
+
if (!host.succeeds('id', ['-u', SERVICE])) {
|
|
153
|
+
host.out(`creating the system user ${SERVICE}`);
|
|
154
|
+
host.exec('useradd', [
|
|
155
|
+
'--system',
|
|
156
|
+
'--no-create-home',
|
|
157
|
+
'--home-dir',
|
|
158
|
+
STATE_DIR,
|
|
159
|
+
'--shell',
|
|
160
|
+
'/usr/sbin/nologin',
|
|
161
|
+
SERVICE,
|
|
162
|
+
]);
|
|
163
|
+
}
|
|
164
|
+
await mkdir(at(STATE_DIR), { recursive: true, mode: 0o750 });
|
|
165
|
+
await mkdir(at(UPDATE_DIR), { recursive: true, mode: 0o750 });
|
|
166
|
+
await mkdir(at(CONFIG_DIR), { recursive: true, mode: 0o750 });
|
|
167
|
+
if (configExists) {
|
|
168
|
+
host.out(`kept ${CONFIG_FILE}`);
|
|
169
|
+
if (args.mqttUrl !== undefined) {
|
|
170
|
+
host.out(`--mqtt-url ignored: ${CONFIG_FILE} exists; change the broker in the UI or in the file`);
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
else {
|
|
174
|
+
await writeFile(at(CONFIG_FILE), initialConfig(args.mqttUrl), { mode: 0o640 });
|
|
175
|
+
host.out(`wrote ${CONFIG_FILE}`);
|
|
176
|
+
}
|
|
177
|
+
// the configuration holds the broker's credentials: the service user's alone
|
|
178
|
+
host.exec('chown', ['-R', `${SERVICE}:${SERVICE}`, at(CONFIG_DIR), at(STATE_DIR)]);
|
|
179
|
+
await chmod(at(CONFIG_FILE), 0o640);
|
|
180
|
+
await mkdir(join(host.root, '/etc/systemd/system'), { recursive: true });
|
|
181
|
+
await writeFile(at(UNIT_PATH), unit, { mode: 0o644 });
|
|
182
|
+
host.out(`wrote ${UNIT_PATH} (ExecStart=${host.execStart})`);
|
|
183
|
+
await writeFile(at(UPDATE_PATH_UNIT), updatePathUnit(), { mode: 0o644 });
|
|
184
|
+
await writeFile(at(UPDATE_SERVICE_UNIT), updateServiceUnit(host.execStart), { mode: 0o644 });
|
|
185
|
+
host.out(`wrote ${UPDATE_PATH_UNIT} and ${UPDATE_SERVICE_UNIT} (the update from the UI)`);
|
|
186
|
+
host.exec('systemctl', ['daemon-reload']);
|
|
187
|
+
host.exec('systemctl', ['enable', '--now', `${SERVICE}-update.path`]);
|
|
188
|
+
host.exec('systemctl', ['enable', `${SERVICE}.service`]);
|
|
189
|
+
// restart rather than start: a reinstall has to bring a running service onto the new unit
|
|
190
|
+
host.exec('systemctl', ['restart', `${SERVICE}.service`]);
|
|
191
|
+
host.out(`${SERVICE}.service enabled and started`);
|
|
192
|
+
host.out(`the pairing code and QR: journalctl -u ${SERVICE} -f; the UI: http://<this host>:8282`);
|
|
193
|
+
}
|
|
194
|
+
async function uninstall(args, host) {
|
|
195
|
+
if (args.dryRun) {
|
|
196
|
+
host.out(`would stop and disable ${SERVICE}.service and ${SERVICE}-update.path and remove their units; ${CONFIG_DIR} and ${STATE_DIR} stay`);
|
|
197
|
+
return;
|
|
198
|
+
}
|
|
199
|
+
const reason = host.unsuitable();
|
|
200
|
+
if (reason !== undefined) {
|
|
201
|
+
throw new ConfigError(`--uninstall: ${reason}`);
|
|
202
|
+
}
|
|
203
|
+
if (!host.succeeds('systemctl', ['disable', '--now', `${SERVICE}.service`])) {
|
|
204
|
+
host.out(`${SERVICE}.service was not enabled`);
|
|
205
|
+
}
|
|
206
|
+
host.succeeds('systemctl', ['disable', '--now', `${SERVICE}-update.path`]);
|
|
207
|
+
for (const path of [UNIT_PATH, UPDATE_PATH_UNIT, UPDATE_SERVICE_UNIT]) {
|
|
208
|
+
await rm(join(host.root, path), { force: true });
|
|
209
|
+
}
|
|
210
|
+
host.exec('systemctl', ['daemon-reload']);
|
|
211
|
+
host.out(`removed ${UNIT_PATH}, ${UPDATE_PATH_UNIT}, ${UPDATE_SERVICE_UNIT}`);
|
|
212
|
+
// the storage holds the fabrics: removing it unpairs the bridge from every controller
|
|
213
|
+
host.out(`kept ${CONFIG_DIR} and ${STATE_DIR} (the pairings); delete them by hand when they are no longer needed`);
|
|
214
|
+
}
|
|
215
|
+
export async function runInstall(args, host) {
|
|
216
|
+
await (args.uninstall ? uninstall(args, host) : install(args, host));
|
|
217
|
+
}
|
|
218
|
+
/** this host, as `sudo mqtt2matter --install` finds it */
|
|
219
|
+
export function systemHost(out) {
|
|
220
|
+
return {
|
|
221
|
+
root: '',
|
|
222
|
+
execStart: `${process.execPath} ${realpathSync(process.argv[1] ?? '')}`,
|
|
223
|
+
exec: (command, args) => {
|
|
224
|
+
execFileSync(command, args, { stdio: ['ignore', 'inherit', 'inherit'] });
|
|
225
|
+
},
|
|
226
|
+
succeeds: (command, args) => {
|
|
227
|
+
try {
|
|
228
|
+
execFileSync(command, args, { stdio: 'ignore' });
|
|
229
|
+
return true;
|
|
230
|
+
}
|
|
231
|
+
catch {
|
|
232
|
+
return false;
|
|
233
|
+
}
|
|
234
|
+
},
|
|
235
|
+
unsuitable: () => {
|
|
236
|
+
if (process.platform !== 'linux') {
|
|
237
|
+
return 'needs Linux with systemd';
|
|
238
|
+
}
|
|
239
|
+
if (process.getuid?.() !== 0) {
|
|
240
|
+
return 'needs root: sudo mqtt2matter --install';
|
|
241
|
+
}
|
|
242
|
+
if (!existsSync('/run/systemd/system')) {
|
|
243
|
+
return 'systemd is not running on this host';
|
|
244
|
+
}
|
|
245
|
+
return undefined;
|
|
246
|
+
},
|
|
247
|
+
out,
|
|
248
|
+
};
|
|
249
|
+
}
|
|
250
|
+
//# sourceMappingURL=install.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"install.js","sourceRoot":"","sources":["../../src/commands/install.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;4FAc4F;AAE5F,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAC,UAAU,EAAE,YAAY,EAAC,MAAM,SAAS,CAAC;AACjD,OAAO,EAAC,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAC,MAAM,kBAAkB,CAAC;AACnE,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAE/B,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAC;AACrC,MAAM,CAAC,MAAM,SAAS,GAAG,uBAAuB,OAAO,UAAU,CAAC;AAClE,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,OAAO,EAAE,CAAC;AAC5C,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,UAAU,IAAI,OAAO,OAAO,CAAC;AAC3D,MAAM,CAAC,MAAM,SAAS,GAAG,YAAY,OAAO,EAAE,CAAC;AAC/C,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,SAAS,SAAS,CAAC;AAChD,MAAM,CAAC,MAAM,gBAAgB,GAAG,uBAAuB,OAAO,cAAc,CAAC;AAC7E,MAAM,CAAC,MAAM,mBAAmB,GAAG,uBAAuB,OAAO,iBAAiB,CAAC;AACnF;6CAC6C;AAC7C,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AASpC,MAAM,UAAU,gBAAgB,CAAC,IAAuB;IACpD,MAAM,IAAI,GAAgB,EAAC,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAC,CAAC;IAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1B,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;YACtB,SAAS;QACb,CAAC;aAAM,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAC1B,CAAC;aAAM,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACvB,CAAC;aAAM,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,KAAK,EAAE,EAAE,CAAC;gBACpD,MAAM,IAAI,WAAW,CAAC,wBAAwB,CAAC,CAAC;YACpD,CAAC;QACL,CAAC;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,WAAW,CAAC,kBAAkB,GAAG,EAAE,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC;AAiBD,MAAM,UAAU,QAAQ,CAAC,SAAiB;IACtC,OAAO;;;;;;;;OAQJ,OAAO;QACN,OAAO;iCACkB,WAAW;8CACE,iBAAiB,wCAAwC,OAAO;;qCAEzE,UAAU;mBAC5B,SAAS;YAChB,SAAS;;yBAEI,iBAAiB;;oBAEtB,iBAAiB;;;mBAGlB,OAAO;iBACT,OAAO;;;iBAGP,UAAU;;;;;;;;CAQ1B,CAAC;AACF,CAAC;AAED,MAAM,UAAU,cAAc;IAC1B,OAAO;;;;aAIE,UAAU;OAChB,OAAO;;;;CAIb,CAAC;AACF,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,iBAAiB,CAAC,SAAiB;IAC/C,OAAO;;;;;;;YAOC,SAAS;;mBAEF,OAAO;CACzB,CAAC;AACF,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,aAAa,CAAC,OAA2B;IACrD,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAC,IAAI,EAAE,EAAC,GAAG,EAAE,OAAO,IAAI,uBAAuB,EAAC,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAC9H,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAC9B,IAAI,CAAC;QACD,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,IAAiB,EAAE,IAAiB;IACvD,MAAM,EAAE,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACtC,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IACnD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,CAAC,eAAe,SAAS,QAAQ,IAAI,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,GAAG,CACJ,YAAY,CAAC,CAAC,CAAC,cAAc,WAAW,EAAE,CAAC,CAAC,CAAC,gBAAgB,WAAW,MAAM,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAC9G,CAAC;QACF,IAAI,CAAC,GAAG,CAAC,eAAe,gBAAgB,QAAQ,cAAc,EAAE,EAAE,CAAC,CAAC;QACpE,IAAI,CAAC,GAAG,CAAC,eAAe,mBAAmB,QAAQ,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACxF,IAAI,CAAC,GAAG,CACJ,gCAAgC,OAAO,KAAK,SAAS,KAAK,UAAU,YAAY,OAAO,sCAAsC,OAAO,UAAU,CACjJ,CAAC;QACF,OAAO;IACX,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IACjC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,WAAW,CAAC,cAAc,MAAM,EAAE,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACjB,UAAU;YACV,kBAAkB;YAClB,YAAY;YACZ,SAAS;YACT,SAAS;YACT,mBAAmB;YACnB,OAAO;SACV,CAAC,CAAC;IACP,CAAC;IACD,MAAM,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;IAC3D,MAAM,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;IAC5D,MAAM,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;IAC5D,IAAI,YAAY,EAAE,CAAC;QACf,IAAI,CAAC,GAAG,CAAC,QAAQ,WAAW,EAAE,CAAC,CAAC;QAChC,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,uBAAuB,WAAW,qDAAqD,CAAC,CAAC;QACtG,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,MAAM,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,GAAG,CAAC,SAAS,WAAW,EAAE,CAAC,CAAC;IACrC,CAAC;IACD,6EAA6E;IAC7E,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,OAAO,IAAI,OAAO,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IACnF,MAAM,KAAK,CAAC,EAAE,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,CAAC;IACpC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,qBAAqB,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IACvE,MAAM,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;IACpD,IAAI,CAAC,GAAG,CAAC,SAAS,SAAS,eAAe,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IAC7D,MAAM,SAAS,CAAC,EAAE,CAAC,gBAAgB,CAAC,EAAE,cAAc,EAAE,EAAE,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;IACvE,MAAM,SAAS,CAAC,EAAE,CAAC,mBAAmB,CAAC,EAAE,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;IAC3F,IAAI,CAAC,GAAG,CAAC,SAAS,gBAAgB,QAAQ,mBAAmB,2BAA2B,CAAC,CAAC;IAC1F,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1C,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,cAAc,CAAC,CAAC,CAAC;IACtE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,GAAG,OAAO,UAAU,CAAC,CAAC,CAAC;IACzD,0FAA0F;IAC1F,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,GAAG,OAAO,UAAU,CAAC,CAAC,CAAC;IAC1D,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,8BAA8B,CAAC,CAAC;IACnD,IAAI,CAAC,GAAG,CAAC,0CAA0C,OAAO,sCAAsC,CAAC,CAAC;AACtG,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,IAAiB,EAAE,IAAiB;IACzD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,CACJ,0BAA0B,OAAO,gBAAgB,OAAO,wCAAwC,UAAU,QAAQ,SAAS,OAAO,CACrI,CAAC;QACF,OAAO;IACX,CAAC;IACD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IACjC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,WAAW,CAAC,gBAAgB,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,UAAU,CAAC,CAAC,EAAE,CAAC;QAC1E,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,0BAA0B,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,cAAc,CAAC,CAAC,CAAC;IAC3E,KAAK,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,gBAAgB,EAAE,mBAAmB,CAAC,EAAE,CAAC;QACpE,MAAM,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1C,IAAI,CAAC,GAAG,CAAC,WAAW,SAAS,KAAK,gBAAgB,KAAK,mBAAmB,EAAE,CAAC,CAAC;IAC9E,sFAAsF;IACtF,IAAI,CAAC,GAAG,CAAC,QAAQ,UAAU,QAAQ,SAAS,qEAAqE,CAAC,CAAC;AACvH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,IAAiB,EAAE,IAAiB;IACjE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,UAAU,CAAC,GAA2B;IAClD,OAAO;QACH,IAAI,EAAE,EAAE;QACR,SAAS,EAAE,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE;QACvE,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;YACpB,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,EAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,EAAC,CAAC,CAAC;QAC3E,CAAC;QACD,QAAQ,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;YACxB,IAAI,CAAC;gBACD,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;gBAC/C,OAAO,IAAI,CAAC;YAChB,CAAC;YAAC,MAAM,CAAC;gBACL,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QACD,UAAU,EAAE,GAAG,EAAE;YACb,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;gBAC/B,OAAO,0BAA0B,CAAC;YACtC,CAAC;YACD,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC3B,OAAO,wCAAwC,CAAC;YACpD,CAAC;YACD,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,EAAE,CAAC;gBACrC,OAAO,qCAAqC,CAAC;YACjD,CAAC;YACD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,GAAG;KACN,CAAC;AACN,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export declare const UPDATE_REQUEST = "request";
|
|
2
|
+
export declare const UPDATE_LOG = "update.log";
|
|
3
|
+
export declare const PACKAGE = "mqtt2matter";
|
|
4
|
+
export declare const VERSION_PATTERN: RegExp;
|
|
5
|
+
export interface UpdateHost {
|
|
6
|
+
/** run the installer; resolves with its exit code; its output goes to `log` */
|
|
7
|
+
install(version: string, log: (text: string) => void): Promise<number>;
|
|
8
|
+
/** restart the service onto the new version */
|
|
9
|
+
restart(): void;
|
|
10
|
+
}
|
|
11
|
+
/** take the request, install the version, restart; the exit code for systemd */
|
|
12
|
+
export declare function applyUpdate(dir: string, host: UpdateHost): Promise<number>;
|
|
13
|
+
/** the real host: npm next to this node, systemctl */
|
|
14
|
+
export declare function systemUpdateHost(npm: string): UpdateHost;
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
/* `mqtt2matter --apply-update`: the root side of the update from the UI.
|
|
2
|
+
|
|
3
|
+
The service runs as an unprivileged user and cannot write the global npm prefix (/usr/local/lib). So the UI's
|
|
4
|
+
"Update" only writes the wanted version into a request file in the service's state directory; a systemd path
|
|
5
|
+
unit that `--install` sets up (`mqtt2matter-update.path`, PathExists=) starts `mqtt2matter-update.service`, a
|
|
6
|
+
root oneshot that runs this command: it takes the request, installs exactly `mqtt2matter@<version>` from the
|
|
7
|
+
registry with npm, logs into the same directory for the UI, and restarts mqtt2matter.service. No sudo rule, no
|
|
8
|
+
polkit: the only thing the service user can ask for is a version string of the one package.
|
|
9
|
+
|
|
10
|
+
The directory belongs to the service user, so nothing in it is trusted: the request is opened without following
|
|
11
|
+
a symlink and must be a short regular file with a version in it; the log is created anew (O_EXCL), never written
|
|
12
|
+
through a link. */
|
|
13
|
+
import { execFileSync, spawn } from 'node:child_process';
|
|
14
|
+
import { constants } from 'node:fs';
|
|
15
|
+
import { open, unlink } from 'node:fs/promises';
|
|
16
|
+
import { join } from 'node:path';
|
|
17
|
+
export const UPDATE_REQUEST = 'request';
|
|
18
|
+
export const UPDATE_LOG = 'update.log';
|
|
19
|
+
export const PACKAGE = 'mqtt2matter';
|
|
20
|
+
export const VERSION_PATTERN = /^\d{1,6}\.\d{1,6}\.\d{1,6}(?:-[0-9A-Za-z.-]{1,40})?$/;
|
|
21
|
+
/** the request's version, or an error; the request is gone afterwards either way */
|
|
22
|
+
async function takeRequest(dir) {
|
|
23
|
+
const path = join(dir, UPDATE_REQUEST);
|
|
24
|
+
let handle;
|
|
25
|
+
try {
|
|
26
|
+
handle = await open(path, constants.O_RDONLY | constants.O_NOFOLLOW);
|
|
27
|
+
}
|
|
28
|
+
catch (error) {
|
|
29
|
+
await unlink(path).catch(() => undefined);
|
|
30
|
+
throw new Error(`no readable request (${error.code ?? 'error'})`, { cause: error });
|
|
31
|
+
}
|
|
32
|
+
try {
|
|
33
|
+
const info = await handle.stat();
|
|
34
|
+
if (!info.isFile() || info.size > 64) {
|
|
35
|
+
throw new Error('the request is not a short regular file');
|
|
36
|
+
}
|
|
37
|
+
return (await handle.readFile('utf8')).trim();
|
|
38
|
+
}
|
|
39
|
+
finally {
|
|
40
|
+
await handle.close();
|
|
41
|
+
await unlink(path).catch(() => undefined);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
/** take the request, install the version, restart; the exit code for systemd */
|
|
45
|
+
export async function applyUpdate(dir, host) {
|
|
46
|
+
const logPath = join(dir, UPDATE_LOG);
|
|
47
|
+
await unlink(logPath).catch(() => undefined);
|
|
48
|
+
// O_EXCL: a link planted after the unlink makes this fail instead of writing through it
|
|
49
|
+
const log = await open(logPath, constants.O_WRONLY | constants.O_CREAT | constants.O_EXCL, 0o644);
|
|
50
|
+
let pending = Promise.resolve();
|
|
51
|
+
const write = (text) => {
|
|
52
|
+
pending = pending.then(() => log.write(text.endsWith('\n') ? text : `${text}\n`));
|
|
53
|
+
};
|
|
54
|
+
try {
|
|
55
|
+
let version;
|
|
56
|
+
try {
|
|
57
|
+
version = await takeRequest(dir);
|
|
58
|
+
}
|
|
59
|
+
catch (error) {
|
|
60
|
+
write(`refused: ${error.message}`);
|
|
61
|
+
return 1;
|
|
62
|
+
}
|
|
63
|
+
if (!VERSION_PATTERN.test(version)) {
|
|
64
|
+
write('refused: the request holds no version');
|
|
65
|
+
return 1;
|
|
66
|
+
}
|
|
67
|
+
write(`installing ${PACKAGE}@${version}`);
|
|
68
|
+
const code = await host.install(version, write);
|
|
69
|
+
if (code !== 0) {
|
|
70
|
+
write(`failed: npm exited with ${code}; ${PACKAGE} keeps running the old version`);
|
|
71
|
+
return 1;
|
|
72
|
+
}
|
|
73
|
+
write(`installed ${PACKAGE}@${version}; restarting`);
|
|
74
|
+
host.restart();
|
|
75
|
+
return 0;
|
|
76
|
+
}
|
|
77
|
+
finally {
|
|
78
|
+
await pending.catch(() => undefined);
|
|
79
|
+
await log.close();
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
/** the real host: npm next to this node, systemctl */
|
|
83
|
+
export function systemUpdateHost(npm) {
|
|
84
|
+
return {
|
|
85
|
+
install: (version, log) => new Promise((resolve) => {
|
|
86
|
+
const child = spawn(npm, ['install', '--global', '--no-audit', '--no-fund', `${PACKAGE}@${version}`], {
|
|
87
|
+
stdio: ['ignore', 'pipe', 'pipe'],
|
|
88
|
+
});
|
|
89
|
+
child.stdout.on('data', (chunk) => {
|
|
90
|
+
log(chunk.toString('utf8'));
|
|
91
|
+
});
|
|
92
|
+
child.stderr.on('data', (chunk) => {
|
|
93
|
+
log(chunk.toString('utf8'));
|
|
94
|
+
});
|
|
95
|
+
child.on('error', (error) => {
|
|
96
|
+
log(`npm: ${error.message}`);
|
|
97
|
+
resolve(127);
|
|
98
|
+
});
|
|
99
|
+
child.on('close', (code) => {
|
|
100
|
+
resolve(code ?? 1);
|
|
101
|
+
});
|
|
102
|
+
}),
|
|
103
|
+
restart: () => {
|
|
104
|
+
// --no-block: queue the restart and return; this oneshot must not wait for the service it restarts
|
|
105
|
+
execFileSync('systemctl', ['--no-block', 'restart', `${PACKAGE}.service`], { stdio: 'ignore' });
|
|
106
|
+
},
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
//# sourceMappingURL=update.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"update.js","sourceRoot":"","sources":["../../src/commands/update.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;qBAWqB;AAErB,OAAO,EAAC,YAAY,EAAE,KAAK,EAAC,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAC,SAAS,EAAC,MAAM,SAAS,CAAC;AAClC,OAAO,EAAC,IAAI,EAAE,MAAM,EAAC,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAE/B,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAC;AACxC,MAAM,CAAC,MAAM,UAAU,GAAG,YAAY,CAAC;AACvC,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAAC;AAErC,MAAM,CAAC,MAAM,eAAe,GAAG,sDAAsD,CAAC;AAStF,oFAAoF;AACpF,KAAK,UAAU,WAAW,CAAC,GAAW;IAClC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACvC,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACD,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IACzE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,wBAAyB,KAA+B,CAAC,IAAI,IAAI,OAAO,GAAG,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAC;IACjH,CAAC;IACD,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAClD,CAAC;YAAS,CAAC;QACP,MAAM,MAAM,CAAC,KAAK,EAAE,CAAC;QACrB,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC9C,CAAC;AACL,CAAC;AAED,gFAAgF;AAChF,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,GAAW,EAAE,IAAgB;IAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;IACtC,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC7C,wFAAwF;IACxF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClG,IAAI,OAAO,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAClD,MAAM,KAAK,GAAG,CAAC,IAAY,EAAQ,EAAE;QACjC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC;IACtF,CAAC,CAAC;IACF,IAAI,CAAC;QACD,IAAI,OAAe,CAAC;QACpB,IAAI,CAAC;YACD,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,KAAK,CAAC,YAAa,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC;QACb,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,uCAAuC,CAAC,CAAC;YAC/C,OAAO,CAAC,CAAC;QACb,CAAC;QACD,KAAK,CAAC,cAAc,OAAO,IAAI,OAAO,EAAE,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAChD,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;YACb,KAAK,CAAC,2BAA2B,IAAI,KAAK,OAAO,gCAAgC,CAAC,CAAC;YACnF,OAAO,CAAC,CAAC;QACb,CAAC;QACD,KAAK,CAAC,aAAa,OAAO,IAAI,OAAO,cAAc,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,CAAC,CAAC;IACb,CAAC;YAAS,CAAC;QACP,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrC,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;AACL,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,gBAAgB,CAAC,GAAW;IACxC,OAAO;QACH,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,CACtB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YACpB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,OAAO,IAAI,OAAO,EAAE,CAAC,EAAE;gBAClG,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;aACpC,CAAC,CAAC;YACH,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACtC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;gBACtC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxB,GAAG,CAAC,QAAQ,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC7B,OAAO,CAAC,GAAG,CAAC,CAAC;YACjB,CAAC,CAAC,CAAC;YACH,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;gBACvB,OAAO,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC;QACN,OAAO,EAAE,GAAG,EAAE;YACV,mGAAmG;YACnG,YAAY,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,GAAG,OAAO,UAAU,CAAC,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAC,CAAC,CAAC;QAClG,CAAC;KACJ,CAAC;AACN,CAAC"}
|