Files

cproudlock 534f179ee6 Make main the lean product a site receives

main was 16 days and 259 commits behind the line the product is actually built
on, at contract 0.30.0 against 0.35.0, with no per-PC credential code at all. It
was neither current nor curated - just stale. This brings it forward and, at the
same time, makes it mean something: main is what a receiving site installs, and
nothing else.

WHAT IT CARRIES. Twelve plugins - backups, computers, endpoints, guides,
knowledgebase, machines, network, notifications, printers, slides, tools,
warranty - plus applications, which is manifest-less core and always ships. The
only manifest dependency inside that set is endpoints on computers, and both are
in it, so the closure is self-contained.

WHAT IT DOES NOT. employees, geenforce, measuringtools, printedparts and usb
stay on the site line. So do the Windows installer tree, the VM rehearsal
helpers, the agent tooling config, one site's data loader, the internal audit
and findings records, and the planner spreadsheet. 1,135 tracked files against
1,438.

A REMOVAL THAT BREAKS THE APP IS NOT A REMOVAL, and two nearly shipped:

deploy/site-profile-universal.json still named all seventeen plugins. It is the
file docs/DEPLOY.md tells a site to provision from, so a fresh install would
have failed at `flask plugin apply-profile` with PluginError - the first thing a
receiving site does, broken by the branch meant to serve them. It now names the
twelve that exist, and its comment says the two must agree.

agent/ was never refreshed. Whoever populated this branch copied shopdb/,
plugins/, frontend/ and tests/ from the site line and left the agent tree at its
September state: 22 C# and PowerShell sources missing, including AgentCredentials,
EnrollmentService, AgentHttpFactory and the fleet-alert client, plus one file the
site line had deleted still present. The old tree is internally consistent, so it
compiles, and nothing in CI builds it - every gate was green over a server that
speaks enrollment and per-PC credentials to a bundled agent source that cannot.
Resynced whole.

DECISIONS THIS ENCODES, rather than defers:

- The plugin-authoring lab builds printedparts, whose manifest depends on
  employees, so it could not stay. The lab remains on the site line and main
  ships no build-along tutorial. That is a real loss for an adopting developer
  and is recorded here rather than discovered later.
- Recognition, Training and Recertification notifications are no longer seeded.
  Each splits one notification into a card per employee and renders a photo,
  which needs a plugin this branch does not bundle. Seeding them would offer an
  author a type that cannot resolve anybody. A site that installs employees gets
  them from that plugin's own seed.
- Windows/IIS is documented as the legacy path throughout, and the README leads
  with Docker, because that is what a receiving site gets.

The API description is regenerated for THIS branch - 347 paths and 483
operations, down from 415 and 573 - so the published contract describes what is
here rather than what the site line serves. docs/CONFIG.md lost the two
measuring-tool label keys the code no longer declares, which two lanes had
decided opposite ways.

Suite: 3124 passed, 6 skipped. Naming and style gates pass. The docs gates run
rather than skip, and every index line count is derived from the file it names.

2026-09-19 11:24:40 -04:00

5.9 KiB

Raw Blame History

Printer installer map and install endpoints

How the shop-floor fleet installs network printers from shopdb-flask, replacing the classic ASP apiprinters.asp / apipcdefaultprinter.asp / installprinter.asp contract. Shopfloor 2.0 PCs cannot run unsigned .bat maps, so a signed installer EXE (and the public web map page) drives installs from three endpoints in the printers plugin.

Server code: plugins/printers/api/asset_routes.py (printer_install_list, pc_default_printer, printer_install_batch)
Consumed by whatever lays software on a bay - a fleet configuration tool, an imaging task, or a scheduled task. ShopDB serves the data; it does not push the installer. Display kiosks do not get it: they print nothing.

All three endpoints are @jwt_required(optional=True): an anonymous fleet client works, and a logged-in browser (the public map page) works too.

1. The public map page

PrinterInstallerMap is a public (no-login) frontend page: the floor map with printer hotspots positioned at each printer's mapx / mapy. The user clicks the printers they want, and the page requests an install batch. The PC's default printer is preselected via pc-default.

2. `GET /api/printers/install-list`

Flat, unpaginated list of active NETWORK printers. A printer counts as network only if it has a hostname or a non-USB IP; USB-only printers are excluded.

Fields per row:

Field	Notes
`printerid`	Printer id (the token `install-batch` takes).
`name`	Asset name, else asset number.
`machinenumber`	The asset number.
`windowsname`	Standardized Windows printer name.
`sharename`	Share / CSF name.
`hostname`	Print-queue host.
`ipaddress`	Primary IP (falls back to any communication row).
`vendorname`	Direct vendor, else the model's vendor.
`modelnumber`	Model name.
`installpath`	Installer path for this printer (see install-batch).
`iscsf`	CSF flag.
`locationname`	Location name, if the asset has one.
`mapx` / `mapy`	Floor-map hotspot position, in the native pixels of `levelid`.
`levelid`	Which level (drawing) those pixels belong to. Null when unplaced.

?format=text returns a pipe-delimited line per printer, one printer per line, with a fixed field order so the Inno / Pascal installer does a split() instead of parsing JSON:

printerid|windowsname|vendorname|modelnumber|hostname|ipaddress|mapx|mapy|levelid

Any pipe or newline inside a value is neutralized to a space so the field count stays fixed. The web map uses the default JSON.

Fields 0-7 are frozen. The shipped installer reads them positionally (GetField(Line, 6) is mapx), so a new field goes on the END and nowhere else - inserting one shifts every later field and the installer keeps running while reading a model number as a coordinate. levelid is field 8 for that reason, and installers built before levels existed ignore it.

An installer that ignores levelid draws every printer on whichever single blueprint it ships, which is correct only while a site has one level. See ADR-017 and section 5.

3. `GET /api/printers/pc-default?machine=NNNN`

The PC's default printer, by machine (asset) number persisted at PXE enrollment. Parity with classic apipcdefaultprinter.asp: the installer preselects a PC's default-printer hotspot on the site-map wizard. The link is resolved through the defaultprinter asset relationship (PC asset -> printer asset), so it stays inside the contract surface (no cross-plugin model import).

Returns {printerid, windowsname}, or {} when the machine is unknown or has no active default printer set.

?format=text returns one pipe-delimited line (printerid|windowsname), or an EMPTY body when there is no default (so the installer's split yields nothing).

4. `GET /api/printers/install-batch?printerids=1,2,3`

Returns a self-deleting Windows .bat that installs the selected printers, grouped the same way classic installprinter.asp grouped them:

HP / Xerox: one universal PrinterInstaller.exe /PRINTER="a,b,c" call.
Printers with a .exe installpath: a PowerShell Invoke-WebRequest download (using the caller's Windows credentials, against the site base URL + the IIS-served /installers folder) followed by running it /SILENT.
No installpath, or a non-.exe payload (e.g. a .zip): listed as a manual install rather than run blindly.

printerids is required, comma-separated; non-numeric tokens are ignored. An empty / missing list is a validation error.

The install name preference is windowsname, else sharename, else the asset name / number.

5. The shipped installer predates levels (known gap)

The Pascal installer in the inno repo (PrinterInstallerMap) still assumes one drawing per site, in two places that must change together:

MAP_SOURCE_W = 3300 / MAP_SOURCE_H = 2550 are compiled-in constants, and every hotspot is scaled by them. They are the dimensions of ONE level.
A downsized copy of that level's blueprint is bundled into the installer (880x680), so the picture is fixed at build time.

Two consequences, neither of which the installer can detect:

It ignores field 8, so printers on any level are drawn on the bundled image. Coordinates from a different drawing land somewhere plausible and wrong.
When a level's blueprint is replaced with one of different dimensions, the constants and the bundled image are both stale and every hotspot shifts.

The API side is ready: GET /api/maplevels is deliberately unauthenticated so the installer can fetch level dimensions and blueprint URLs at runtime rather than compiling them in, which is what fixes both. Until the installer is rebuilt against it, treat its map as accurate for the default level only.

5.9 KiB Raw Blame History