Files
AvianVisitors/avian/api/recording.php
T
Twarner491 2ec45b9138 AvianVisitors hardening pass — install via fork's newinstaller
Restructures the install so users run ONE command. The fork's
newinstaller.sh clones this repo (instead of upstream Nachtzuster) and
runs BirdNET-Pi's installer. install_services.sh symlinks the avian/
overlay into the Caddy site root, so http://birdnet.local/avian/ comes
up after reboot with no Caddy config needed.

Reviewer-flagged fixes:

Frontend (avian/frontend/apt.js)
- Switch all API paths from /api/*.json (which didn't route) to relative
  action-based URLs (./api/birdnet-api.php?action=recent etc.).
- Fetch ./masks.json + ./dims.json relatively (were /avian/*.json).
- Replace every innerHTML user-content sink with createElement +
  textContent + setAttribute — species labels are user-editable in
  BirdNET-Pi, so untrusted.
- Add esc() helper for the few remaining innerHTML attribute contexts.
- fetchJson throws on non-200 (was silently parsing 404 HTML as JSON).
- Defensive null-check in loadMask if MASKS hasn't loaded.

Backend (avian/api/*.php)
- birdnet-api.php now derives DB_PATH from dirname(__DIR__, 3) so any
  BirdNET-Pi install user works (no hardcoded /home/birdnet).
- recording/spectrogram/cutout use getenv('HOME') for the same reason.
- cutout.php reworked as the canonical image resolver: bundled
  illustration → bundled cutout → cached rembg → fresh
  Wikipedia+rembg, with the binomial regex guard and atomic rename
  on cache write. Wikipedia URL host pinned to wikimedia.org /
  wikipedia.org to block SSRF.
- Stale 'X-BirdNET-Proxy-Token' auth claims removed everywhere.

Pregen (avian/scripts/pregen.py)
- Gemini key moved from URL query to x-goog-api-key header.
- Model bumped to gemini-2.5-flash-image-preview.
- Bounded retry on 429 + 5xx with Retry-After honoured.
- Default --sleep raised from 1s to 4s (under free-tier RPM).
- Unified parser handles |/_/comma in all three input modes.
- responseModalities now [TEXT, IMAGE] (was IMAGE-only).
- --poses validated against POSES keys.
- ASCII [ok]/[fail] markers (was ✓/✗ — Windows console crash).
- Surfaces finishReason + blockReason on safety blocks.

Prompt template
- 'Two placeholders' typo → three.
- 'warm paper' / 'transparent background' contradiction resolved.

Forwarding
- mqtt-bridge.py: paho-mqtt 2.x CallbackAPIVersion compat shim.
- avian-mqtt.service: dropped broken %i, set User=birdnet + %h path.
- forwarding/README.md uses the actual action-based URLs.

README
- One-line install via curl … newinstaller.sh.
- No more 'install BirdNET-Pi separately' step (our fork does it).
- License section uses absolute github.com links.
- bird.onethreenine.net replaces the not-yet-existent project writeup.
- docs/thumb.png replaced with the 24-bird Twitter capture.

Removed
- avian/caddy/ and avian/scripts/install.sh — no longer needed; the
  overlay symlink in install_services.sh handles everything.
2026-05-28 10:49:41 -07:00

176 lines
6.4 KiB
PHP

<?php
// AvianVisitors — serves the most-recent detection mp3 for a given
// scientific name. Called by the collage detail modal at
// /avian/api/recording.php?sci=<name>.
//
// BirdNET-Pi writes audio + spectrograms to
// $HOME/BirdSongs/Extracted/By_Date/YYYY-MM-DD/<Common_Name>/<base>.mp3
// (with a matching .png next to it). Common_Name is the SPACE-stripped
// English common name (e.g. "Anna's_Hummingbird"), NOT the scientific
// name. We resolve sci → common via birds.json under BirdNET-Pi/scripts/
// and walk the directory tree newest-first.
//
declare(strict_types=1);
$sci = trim((string)($_GET['sci'] ?? ''));
$file = trim((string)($_GET['file'] ?? ''));
if ($sci === '' && $file === '') {
http_response_code(400);
echo 'sci or file required';
exit;
}
// Reject any sci-name that isn't a clean Genus species[ subspecies[ tri]]
// pattern. resolve_common() below falls back to str_replace(' ', '_', $sci)
// when there's no birds.json match — without this guard, `?sci=../etc` would
// flow through unmodified into a filesystem path.
if ($sci !== '' && !preg_match('/^[A-Za-z]{2,40}(?:[ ][a-z]{2,40}){1,3}$/', $sci)) {
http_response_code(400);
echo 'invalid sci';
exit;
}
$BY_DATE = getenv('HOME') . '/BirdSongs/Extracted/By_Date';
// ---- Direct-by-file lookup ----
// Used by the atlas detail modal to play any past recording.
// Filename schema (BirdNET-Pi):
// <Common_Name>-<conf>-<YYYY-MM-DD>-birdnet-<HH-MM-SS>.mp3
// We pull the date out of the filename to locate the species
// directory under By_Date/. Whitelisted character set keeps this
// safe against path-traversal payloads.
if ($file !== '') {
if (!preg_match('/^[A-Za-z0-9_.:-]+\.mp3$/', $file)) {
http_response_code(400);
echo 'invalid file name';
exit;
}
// Extract the YYYY-MM-DD from the filename if present.
$date = null;
if (preg_match('/(\d{4}-\d{2}-\d{2})/', $file, $m)) $date = $m[1];
// The species directory is the prefix before the first dash-digit.
// Try a couple of strategies: explicit species_dir param, dir from file
// prefix, then a broader recursive search as fallback.
$candidates = [];
if ($date) {
// Look in that specific date dir across every species subdir.
$dayDir = "$BY_DATE/$date";
if (is_dir($dayDir)) {
foreach (scandir($dayDir) as $sub) {
if ($sub[0] === '.') continue;
$p = "$dayDir/$sub/$file";
if (is_file($p)) { $candidates[] = $p; break; }
}
}
}
if (!$candidates) {
// Fall back to scanning every date dir (slower).
if (is_dir($BY_DATE)) {
foreach (scandir($BY_DATE) as $d) {
if ($d[0] === '.') continue;
$dayDir = "$BY_DATE/$d";
if (!is_dir($dayDir)) continue;
foreach (scandir($dayDir) as $sub) {
if ($sub[0] === '.') continue;
$p = "$dayDir/$sub/$file";
if (is_file($p)) { $candidates[] = $p; break 2; }
}
}
}
}
if (!$candidates || filesize($candidates[0]) < 64) {
http_response_code(404);
echo 'recording not found';
exit;
}
$path = $candidates[0];
header('Content-Type: audio/mpeg');
header('Content-Length: ' . filesize($path));
header('Cache-Control: public, max-age=86400');
header('Accept-Ranges: bytes');
readfile($path);
exit;
}
$BIRDS_JSON_CANDIDATES = [
getenv('HOME') . '/BirdNET-Pi/scripts/birds.json',
getenv('HOME') . '/BirdNET-Pi/model/labels.txt',
];
// ---- Resolve scientific name → common name (with underscores) ----
function resolve_common(string $sci): ?string {
// Try birds.json first (preferred — has clean sci/com pairs).
foreach ([getenv('HOME') . '/BirdNET-Pi/scripts/birds.json'] as $f) {
if (is_readable($f)) {
$list = json_decode((string)file_get_contents($f), true);
if (is_array($list)) {
foreach ($list as $row) {
if (!is_array($row)) continue;
$rowSci = $row['sci'] ?? $row['scientific'] ?? $row['scientificName'] ?? '';
$rowCom = $row['com'] ?? $row['common'] ?? $row['commonName'] ?? '';
if (strcasecmp(trim((string)$rowSci), $sci) === 0 && $rowCom) {
return str_replace(' ', '_', (string)$rowCom);
}
}
}
}
}
// Fallback: labels.txt has "<sci>_<com>" or "<sci>, <com>" per line.
$labels = getenv('HOME') . '/BirdNET-Pi/model/labels.txt';
if (is_readable($labels)) {
foreach (file($labels, FILE_IGNORE_NEW_LINES) as $line) {
if (strpos($line, '_') !== false) {
[$s, $c] = explode('_', $line, 2);
if (strcasecmp(trim($s), $sci) === 0) {
return str_replace(' ', '_', trim($c));
}
}
}
}
return null;
}
$common = resolve_common($sci);
if ($common === null) {
// Last-ditch: try the scientific name itself, with spaces → underscores.
// (Some BirdNET dirs are keyed by sci name.)
$common = str_replace(' ', '_', $sci);
}
// ---- Find newest matching file ----
// Walk By_Date/* newest-first; inside each date dir, look for a
// subdirectory named exactly $common, return the newest .mp3 inside.
function newest_recording(string $rootDir, string $common): ?string {
if (!is_dir($rootDir)) return null;
$dates = scandir($rootDir, SCANDIR_SORT_DESCENDING);
if (!$dates) return null;
foreach ($dates as $date) {
if ($date[0] === '.') continue;
$speciesDir = "$rootDir/$date/$common";
if (!is_dir($speciesDir)) continue;
$files = scandir($speciesDir, SCANDIR_SORT_DESCENDING);
if (!$files) continue;
foreach ($files as $f) {
if (substr($f, -4) === '.mp3') {
return "$speciesDir/$f";
}
}
}
return null;
}
$path = newest_recording($BY_DATE, $common);
if ($path === null || !is_file($path) || filesize($path) < 64) {
http_response_code(404);
echo 'no recording for ' . htmlspecialchars($sci);
exit;
}
// ---- Serve ----
header('Content-Type: audio/mpeg');
header('Content-Length: ' . filesize($path));
header('Cache-Control: public, max-age=60');
header('Accept-Ranges: bytes');
readfile($path);