Notifications: name the image, and tell a capture from a deploy

[mastacontrola]

The other half of FOGProject/fogproject#1202; the core half is FOGProject/fogproject#1205. Neither depends on the other landing first.

What changed upstream

Core now fires HOST_IMAGEUP_COMPLETE for a capture, HOST_IMAGE_COMPLETE for a deploy and HOST_IMAGE_FAIL when imaging did not finish — and it sends the image and the failure reason alongside the host name. Before that, two of those three names had no caller anywhere in FOG, so listeners registered for them had never run.

What these listeners did with it

Nothing, because they could not. Every one of the six registered HOST_IMAGEUP_COMPLETE or HOST_IMAGE_FAIL and then ignored which event had arrived:

public function onEvent($event, $data)
{
    self::$message = 'This host has finished imaging.';
    self::$shortdesc = 'Imaging Complete';
    parent::onEvent($event, $data);
}

So a finished capture said "This host has finished imaging", identically to a deploy, and a failure said "This host has failed to image" with no hint as to why.

	before	after
deploy	Host lab01 completed imaging.	Host lab01 finished deploying image Win11-Lab.
capture	Host lab01 completed imaging.	Host lab01 finished capturing image Win11-Lab.
failure	Host lab01 imaging failed.	Host lab01 failed imaging Win11-Lab: Failed to update host

Defensive about every added key

A plugin release is not tied to a FOG release, so all six have to keep working against a server whose core still sends nothing but HostName:

$image = (string) ($data['ImageName'] ?? '');
if ('' === $image) {
    $image = _('an unnamed image');
}

Reading a missing key directly would turn the notification into a PHP warning — in an event that only fires when something has already gone wrong. That is also why fog_min is untouched: these work on any 1.6, they just say more on a server that has taken #1205.

Translation

The image name is substituted outside _(), not inside it — a msgid that mixes literal text with a variable extracts nothing and never translates, silently and permanently. Positional specifiers (%1$s) so a translator can reorder the sentence.

The ntfy and pushbullet listeners compose the finished string themselves rather than handing their base class a bare literal, because the substitution has to happen after translation. The base's _() then finds no entry and passes it through unchanged.

Verification

tests/imaging-notification-detail.test.php — 42 checks across the six files, source-level for the same reason group-tab-permissions.test.php is: these classes extend the plugin's own Event base, which extends FOG's, so none of them loads without a booted FOG, a session and a database.

It pins the defensive reads, the capture/deploy split, the registrations, and the gettext shape — that last one because this repository has no gettext gate of its own; fogproject's only scans fogproject.

Mutation-verified:

drop the ImageName default    -> reads ImageName without a default
drop the capture branch       -> does not distinguish a capture from a deploy
interpolate inside _()        -> interpolates a variable inside a double-quoted _()
drop the Reason default       -> does not report why imaging failed

Full suite: 7 passed, 0 failed.

🤖 Generated with Claude Code

https://claude.ai/code/session_013mJVe4CpK3rRbi9H5GubXd