Files
AvianVisitors/avian/api/recording.php
T
Twarner491 d3241f92cf Pre-share fixes from final review pass
Blockers
- http://birdnet.local/avian/ now serves the collage (added avian/index.html
  redirect to frontend/; previously the symlink target had no top-level
  index, so users saw a directory listing of api/ assets/ forwarding/
  frontend/ scripts/).
- Gemini model bumped from gemini-2.5-flash-image-preview (deprecated
  2026-01-15) to the stable gemini-2.5-flash-image. Pregen was non-
  functional out of the box.
- avian-mqtt.service: dropped %h (which expands to /root for system-mode
  units regardless of User=). Use WorkingDirectory=~ which DOES respect
  User=, plus a relative ExecStart.
- birdnet-api.php case 'lifelist' now aliases COUNT(*) AS n (was 'total'),
  matching what apt.js reads for atlas card counts. Atlas previously
  always displayed 0.

Bugs
- Retry-After parsing handles HTTP-date format without crashing.
- apt.js no longer fetches firstseen/timeseries (declared in state but
  never consumed). Two wasted round-trips per page load removed.
- update_birdnet.sh defaults branch=avian-visitors so the (opt-in)
  Sunday auto-update cron doesn't reset HEAD to upstream main and
  delete the avian/ overlay.
- recording.php: removed dead $BIRDS_JSON_CANDIDATES.

Polish
- Pregen --sleep default raised 4→6s (more headroom under free-tier RPM).
- en-dash in README BOM (~$35–80) replaced with hyphen for style match.
- Slop sweep across user-facing docs: no em-dashes, no en-dashes, no
  AI-slop word hits (robust/comprehensive/seamless/etc.).
2026-05-28 11:11:20 -07:00

171 lines
6.2 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;
}
// ---- 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);