frederik
483 lines
17 KiB
PHP
483 lines
17 KiB
PHP
<?php
|
|
|
|
define('__ROOT__', dirname(dirname(__FILE__)));
|
|
|
|
if (session_status() !== PHP_SESSION_ACTIVE)
|
|
session_start();
|
|
|
|
function ensure_db_ok($sql_stmt) {
|
|
if ($sql_stmt == False) {
|
|
echo "Database is busy";
|
|
header("refresh:1;");
|
|
exit;
|
|
}
|
|
}
|
|
|
|
function set_timezone() {
|
|
if (!isset($_SESSION['my_timezone'])) {
|
|
$_SESSION['my_timezone'] = trim(shell_exec('timedatectl show --value --property=Timezone'));
|
|
}
|
|
date_default_timezone_set($_SESSION['my_timezone']);
|
|
}
|
|
|
|
function get_config($force_reload = false) {
|
|
$mtime = stat('/etc/birdnet/birdnet.conf')["mtime"];
|
|
if (isset($_SESSION['my_config_version']) && $_SESSION['my_config_version'] !== $mtime) {
|
|
$force_reload = true;
|
|
}
|
|
if (!isset($_SESSION['my_config']) || $force_reload) {
|
|
$source = preg_replace("~^#+.*$~m", "", file_get_contents('/etc/birdnet/birdnet.conf'));
|
|
$my_config = parse_ini_string($source);
|
|
if ($my_config) {
|
|
$_SESSION['my_config'] = $my_config;
|
|
} else {
|
|
syslog(LOG_ERR, "Cannot parse config");
|
|
}
|
|
$_SESSION['my_config_version'] = $mtime;
|
|
}
|
|
return $_SESSION['my_config'];
|
|
}
|
|
|
|
function get_user() {
|
|
$config = get_config();
|
|
$user = $config['BIRDNET_USER'];
|
|
return $user;
|
|
}
|
|
|
|
function get_home() {
|
|
$home = '/home/' . get_user();
|
|
return $home;
|
|
}
|
|
|
|
function get_sitename() {
|
|
$config = get_config();
|
|
|
|
if ($config["SITE_NAME"] == "") {
|
|
$site_name = "BirdNET-Pi";
|
|
} else {
|
|
$site_name = $config['SITE_NAME'];
|
|
}
|
|
return $site_name;
|
|
}
|
|
|
|
function get_service_mount_name() {
|
|
$home = get_home();
|
|
$service_mount = trim(shell_exec("systemd-escape -p --suffix=mount " . $home . "/BirdSongs/StreamData"));
|
|
return $service_mount;
|
|
}
|
|
|
|
function is_authenticated() {
|
|
$ret = false;
|
|
if (isset($_SERVER['PHP_AUTH_USER'])) {
|
|
$config = get_config();
|
|
$ret = ($_SERVER['PHP_AUTH_PW'] == $config['CADDY_PWD'] && $_SERVER['PHP_AUTH_USER'] == 'birdnet');
|
|
}
|
|
return $ret;
|
|
}
|
|
|
|
function ensure_authenticated($error_message = 'You cannot edit the settings for this installation') {
|
|
if (!is_authenticated()) {
|
|
header('WWW-Authenticate: Basic realm="My Realm"');
|
|
header('HTTP/1.0 401 Unauthorized');
|
|
echo '<table><tr><td>' . $error_message . '</td></tr></table>';
|
|
exit;
|
|
}
|
|
}
|
|
|
|
function debug_log($message) {
|
|
if (is_bool($message)) {
|
|
$message = $message ? 'true' : 'false';
|
|
}
|
|
error_log($message . "\n", 3, $_SERVER['DOCUMENT_ROOT'] . "/debug_log.log");
|
|
}
|
|
|
|
function get_com_en_name($sci_name) {
|
|
if (!isset($_labels_flickr)) {
|
|
$_labels_flickr = file(get_home() . "/BirdNET-Pi/model/labels_flickr.txt");
|
|
}
|
|
$engname = null;
|
|
foreach ($_labels_flickr as $label) {
|
|
if (trim(explode("_", $label)[0]) === $sci_name) {
|
|
$engname = trim(explode("_", $label)[1]);
|
|
break;
|
|
}
|
|
}
|
|
return $engname;
|
|
}
|
|
|
|
function get_sci_name($com_name) {
|
|
if (!isset($_labels)) {
|
|
$_labels = file(get_home() . "/BirdNET-Pi/model/labels.txt");
|
|
}
|
|
$sciname = null;
|
|
foreach ($_labels as $label) {
|
|
if (trim(explode("_", $label)[1]) === $com_name) {
|
|
$sciname = trim(explode("_", $label)[0]);
|
|
break;
|
|
}
|
|
}
|
|
return $sciname;
|
|
}
|
|
|
|
function get_label($record, $sort_by, $date=null) {
|
|
$name = $record["Com_Name"];
|
|
if ($sort_by == "confidence") {
|
|
$ret = $name . ' (' . round($record['MaxConfidence'] * 100) . '%)';
|
|
} elseif ($sort_by == "occurrences") {
|
|
$valuescount = $record['Count'];
|
|
if ($valuescount >= 1000) {
|
|
$ret = $name . ' (' . round($valuescount / 1000, 1) . 'k)';
|
|
} else {
|
|
$ret = $name . ' (' . $valuescount . ')';
|
|
}
|
|
} elseif (($sort_by == "date") && !isset($date)) {
|
|
$ret = $name . ' (' . $record['Date'] . ')';
|
|
} elseif (($sort_by == "date") && isset($date)) {
|
|
$ret = $name . ' (' . $record['Time'] . ')';
|
|
} else {
|
|
$ret = $name;
|
|
}
|
|
return $ret;
|
|
}
|
|
|
|
function fetch_species_array($sort_by, $date=null) {
|
|
if (!isset($_db)) {
|
|
$_db = new SQLite3('./scripts/birds.db', SQLITE3_OPEN_READONLY);
|
|
$_db->busyTimeout(1000);
|
|
}
|
|
$where = (isset($date)) ? "WHERE Date == \"$date\"" : "";
|
|
if ($sort_by === "occurrences") {
|
|
$statement = $_db->prepare("SELECT Date, Time, File_Name, Com_Name, Sci_Name, COUNT(*) as Count, MAX(Confidence) as MaxConfidence FROM detections $where GROUP BY Sci_Name ORDER BY COUNT(*) DESC");
|
|
} elseif ($sort_by === "confidence") {
|
|
$statement = $_db->prepare("SELECT Date, Time, File_Name, Com_Name, Sci_Name, COUNT(*) as Count, MAX(Confidence) as MaxConfidence FROM detections $where GROUP BY Sci_Name ORDER BY MAX(Confidence) DESC");
|
|
} elseif ($sort_by === "date") {
|
|
$statement = $_db->prepare("SELECT Date, Time, File_Name, Com_Name, Sci_Name, COUNT(*) as Count, MAX(Confidence) as MaxConfidence FROM detections $where GROUP BY Sci_Name ORDER BY MIN(Date) DESC, Time DESC");
|
|
} else {
|
|
$statement = $_db->prepare("SELECT Date, Time, File_Name, Com_Name, Sci_Name, COUNT(*) as Count, MAX(Confidence) as MaxConfidence FROM detections $where GROUP BY Sci_Name ORDER BY Com_Name ASC");
|
|
}
|
|
ensure_db_ok($statement);
|
|
$result = $statement->execute();
|
|
return $result;
|
|
}
|
|
|
|
function fetch_best_detection($com_name) {
|
|
if (!isset($_db)) {
|
|
$_db = new SQLite3('./scripts/birds.db', SQLITE3_OPEN_READONLY);
|
|
$_db->busyTimeout(1000);
|
|
}
|
|
$statement = $_db->prepare("SELECT Com_Name, Sci_Name, COUNT(*), MAX(Confidence), File_Name, Date, Time from detections WHERE Com_Name = \"$com_name\"");
|
|
ensure_db_ok($statement);
|
|
$result = $statement->execute();
|
|
return $result;
|
|
}
|
|
|
|
function fetch_all_detections($sci_name, $sort_by, $date=null) {
|
|
if (!isset($_db)) {
|
|
$_db = new SQLite3('./scripts/birds.db', SQLITE3_OPEN_READONLY);
|
|
$_db->busyTimeout(1000);
|
|
}
|
|
$filter = (isset($date)) ? "AND Date == \"$date\"" : "";
|
|
if ($sort_by === "occurrences") {
|
|
$statement = $_db->prepare("SELECT * FROM detections WHERE Sci_Name == \"$sci_name\" $filter ORDER BY COUNT(*) DESC");
|
|
} elseif ($sort_by === "confidence") {
|
|
$statement = $_db->prepare("SELECT * FROM detections WHERE Sci_Name == \"$sci_name\" $filter ORDER BY Confidence DESC");
|
|
} else {
|
|
$order = (isset($date)) ? "Time DESC" : "Date DESC, Time DESC";
|
|
$statement = $_db->prepare("SELECT * FROM detections where Sci_Name == \"$sci_name\" $filter ORDER BY $order");
|
|
}
|
|
ensure_db_ok($statement);
|
|
$result = $statement->execute();
|
|
return $result;
|
|
}
|
|
|
|
|
|
class ImageProvider {
|
|
|
|
protected $db = null;
|
|
protected $db_path = null;
|
|
protected $db_reset = false;
|
|
protected $context = null;
|
|
|
|
public function __construct() {
|
|
$this->set_db();
|
|
$opts = ['http' => ['header' => "User-Agent: BirdNET-Pi"]];
|
|
$this->context = stream_context_create($opts);
|
|
}
|
|
|
|
public function get_image($sci_name) {
|
|
$image = $this->get_image_from_db($sci_name);
|
|
if ($image !== false) {
|
|
$now = new DateTime();
|
|
$datetime = DateTime::createFromFormat("Y-m-d", $image['date_created']);
|
|
$interval = $now->diff($datetime);
|
|
$expire_days = rand(15, 25);
|
|
if ($interval->days > $expire_days) {
|
|
$image = false;
|
|
}
|
|
}
|
|
if ($image === false) {
|
|
$this->get_from_source($sci_name);
|
|
$image = $this->get_image_from_db($sci_name);
|
|
}
|
|
return $image;
|
|
}
|
|
|
|
public function is_reset() {
|
|
return $this->db_reset;
|
|
}
|
|
|
|
protected function get_json($url) {
|
|
return json_decode(file_get_contents($url, false, $this->context), true);
|
|
}
|
|
|
|
protected function set_db() {
|
|
try {
|
|
if ($this->db === null) {
|
|
$db = new SQLite3($this->db_path, SQLITE3_OPEN_READWRITE);
|
|
$this->db = $db;
|
|
}
|
|
} catch (Exception $ex) {
|
|
$this->create_tables();
|
|
}
|
|
$this->db->busyTimeout(1000);
|
|
}
|
|
|
|
protected function create_tables() {
|
|
$tbl_def = "CREATE TABLE images (sci_name VARCHAR(63) NOT NULL PRIMARY KEY, com_en_name VARCHAR(63) NOT NULL, image_url TEXT NOT NULL, title TEXT NOT NULL, id TEXT NOT NULL UNIQUE, author_url TEXT NOT NULL, license_url TEXT NOT NULL, date_created DATE)";
|
|
$db = new SQLite3($this->db_path);
|
|
$db->exec($tbl_def);
|
|
$db->exec('CREATE TABLE source (ID INTEGER PRIMARY KEY, email VARCHAR(63), uid VARCHAR(63), date_created DATE)');
|
|
$this->db_reset = true;
|
|
$this->db = $db;
|
|
}
|
|
|
|
protected function delete_image_from_db($sci_name) {
|
|
$statement0 = $this->db->prepare('DELETE FROM images WHERE sci_name == :sci_name');
|
|
$statement0->bindValue(':sci_name', $sci_name);
|
|
$statement0->execute();
|
|
}
|
|
|
|
protected function get_image_from_db($sci_name) {
|
|
$statement0 = $this->db->prepare('SELECT sci_name, com_en_name, image_url, title, id, author_url, license_url, date_created FROM images WHERE sci_name == :sci_name');
|
|
$statement0->bindValue(':sci_name', $sci_name);
|
|
$result = $statement0->execute();
|
|
$row = $result->fetchArray(SQLITE3_ASSOC);
|
|
return $row;
|
|
}
|
|
|
|
protected function set_image_in_db($sci_name, $com_en_name, $image_url, $title, $id, $author_url, $license_url) {
|
|
$statement0 = $this->db->prepare("INSERT OR REPLACE INTO images VALUES (:sci_name, :com_en_name, :image_url, :title, :id, :author_url, :license_url, DATE(\"now\"))");
|
|
$statement0->bindValue(':sci_name', $sci_name);
|
|
$statement0->bindValue(':com_en_name', $com_en_name);
|
|
$statement0->bindValue(':image_url', $image_url);
|
|
$statement0->bindValue(':title', $title);
|
|
$statement0->bindValue(':id', $id);
|
|
$statement0->bindValue(':author_url', $author_url);
|
|
$statement0->bindValue(':license_url', $license_url);
|
|
$statement0->execute();
|
|
}
|
|
}
|
|
|
|
class Flickr extends ImageProvider {
|
|
|
|
protected $db_path = __ROOT__ . '/scripts/flickr.db';
|
|
|
|
private $flickr_api_key = null;
|
|
private $args = "&license=2%2C3%2C4%2C5%2C6%2C9&orientation=square,portrait";
|
|
private $blacklisted_ids = [];
|
|
private $licenses_urls = [];
|
|
private $flickr_email = null;
|
|
private $comnameprefix = "%20bird";
|
|
|
|
public function __construct() {
|
|
$this->set_db();
|
|
|
|
$blacklisted = get_home() . "/BirdNET-Pi/scripts/blacklisted_images.txt";
|
|
if (file_exists($blacklisted)) {
|
|
$blacklisted_file = file($blacklisted);
|
|
if ($blacklisted_file) {
|
|
$this->blacklisted_ids = array_map('trim', $blacklisted_file);
|
|
}
|
|
}
|
|
$this->flickr_api_key = get_config()["FLICKR_API_KEY"];
|
|
$this->flickr_email = get_config()["FLICKR_FILTER_EMAIL"];
|
|
$source = $this->get_uid_from_db();
|
|
if ($source['email'] !== $this->flickr_email) {
|
|
// reset the DB
|
|
$this->db->exec("DROP TABLE images;");
|
|
$this->create_tables();
|
|
if (!empty($this->flickr_email)) {
|
|
$source = $this->get_uid_from_db();
|
|
if ($source['email'] !== $this->flickr_email) {
|
|
$this->get_uid_from_flickr();
|
|
$source = $this->get_uid_from_db();
|
|
}
|
|
} else {
|
|
$this->set_uid_in_db("");
|
|
}
|
|
}
|
|
if (!empty($this->flickr_email)) {
|
|
$this->args = "&user_id=" . $source['uid'];
|
|
$this->comnameprefix = "";
|
|
}
|
|
}
|
|
|
|
public function get_image($sci_name) {
|
|
$image = parent::get_image_from_db($sci_name);
|
|
if ($image !== false && in_array($image['id'], $this->blacklisted_ids)) {
|
|
$image = false;
|
|
$this->delete_image_from_db($sci_name);
|
|
}
|
|
if ($image === false) {
|
|
$this->get_from_source($sci_name);
|
|
$image = $this->get_image_from_db($sci_name);
|
|
}
|
|
if ($image === false)
|
|
return false;
|
|
// external link to photo
|
|
$photos_url = str_replace('/people/', '/photos/', $image['author_url'] . '/' . $image['id']);
|
|
$image['photos_url'] = $photos_url;
|
|
return $image;
|
|
}
|
|
|
|
private function get_from_source($sci_name) {
|
|
$engname = get_com_en_name($sci_name);
|
|
|
|
$flickrjson = json_decode(file_get_contents("https://www.flickr.com/services/rest/?method=flickr.photos.search&api_key=" . $this->flickr_api_key . "&text=" . str_replace(" ", "%20", $engname) . $this->comnameprefix . "&sort=relevance" . $this->args . "&per_page=5&media=photos&format=json&nojsoncallback=1"), true)["photos"]["photo"];
|
|
// could be null!!
|
|
// Find the first photo that is not blacklisted or is not the specific blacklisted id
|
|
$photo = null;
|
|
foreach ($flickrjson as $flickrphoto) {
|
|
if ($flickrphoto["id"] !== "4892923285" && !in_array($flickrphoto["id"], $this->blacklisted_ids)) {
|
|
$photo = $flickrphoto;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ($photo === null)
|
|
return;
|
|
|
|
$license_response = $this->get_json("https://api.flickr.com/services/rest/?method=flickr.photos.getInfo&api_key=" . $this->flickr_api_key . "&photo_id=" . $photo["id"] . "&format=json&nojsoncallback=1");
|
|
$license_id = $license_response["photo"]["license"];
|
|
$license_url = $this->get_license_url($license_id);
|
|
|
|
$authorlink = "https://flickr.com/people/" . $photo["owner"];
|
|
$imageurl = 'https://farm' . $photo["farm"] . '.static.flickr.com/' . $photo["server"] . '/' . $photo["id"] . '_' . $photo["secret"] . '.jpg';
|
|
|
|
$this->set_image_in_db($sci_name, $engname, $imageurl, $photo["title"], $photo["id"], $authorlink, $license_url);
|
|
}
|
|
|
|
private function get_license_url($id) {
|
|
if (empty($this->licenses_urls)) {
|
|
$licenses_url = "https://api.flickr.com/services/rest/?method=flickr.photos.licenses.getInfo&api_key=" . $this->flickr_api_key . "&format=json&nojsoncallback=1";
|
|
$licenses_response = $this->get_json($licenses_url);
|
|
$licenses_data = $licenses_response["licenses"]["license"];
|
|
foreach ($licenses_data as $license) {
|
|
$license_id = $license["id"];
|
|
$license_url = $license["url"];
|
|
$this->licenses_urls[$license_id] = $license_url;
|
|
}
|
|
}
|
|
return $this->licenses_urls[$id];
|
|
}
|
|
|
|
public function get_uid_from_db() {
|
|
$statement0 = $this->db->prepare('SELECT email, uid, date_created FROM source');
|
|
$result = $statement0->execute();
|
|
$row = $result->fetchArray(SQLITE3_ASSOC);
|
|
return $row;
|
|
}
|
|
|
|
private function set_uid_in_db($uid) {
|
|
$statement0 = $this->db->prepare("INSERT OR REPLACE INTO source VALUES (1, :email, :uid, DATE(\"now\"))");
|
|
$statement0->bindValue(':email', $this->flickr_email);
|
|
$statement0->bindValue(':uid', $uid);
|
|
$result = $statement0->execute();
|
|
$row = $result->fetchArray(SQLITE3_ASSOC);
|
|
return $row;
|
|
}
|
|
|
|
private function get_uid_from_flickr() {
|
|
$uid = json_decode(file_get_contents("https://www.flickr.com/services/rest/?method=flickr.people.findByEmail&api_key=" . $this->flickr_api_key . "&find_email=" . $this->flickr_email . "&format=json&nojsoncallback=1"), true)["user"]["nsid"];
|
|
$this->set_uid_in_db($uid);
|
|
}
|
|
}
|
|
|
|
class Wikipedia extends ImageProvider {
|
|
|
|
protected $db_path = __ROOT__ . '/scripts/wikipedia.db';
|
|
|
|
protected function get_from_source($sci_name) {
|
|
$title = str_replace(' ', '_', $sci_name);
|
|
$data = $this->get_json("https://en.wikipedia.org/api/rest_v1/page/summary/$title");
|
|
if ($data == false or !isset($data['originalimage']))
|
|
return;
|
|
|
|
$image_name = substr($data['originalimage']['source'], strrpos($data['originalimage']['source'], '/') + 1);
|
|
$metadata = $this->get_json("https://commons.wikimedia.org/w/api.php?action=query&titles=Image:$image_name&prop=imageinfo&iiprop=extmetadata&format=json");
|
|
if ($metadata == false or !isset($metadata['query']['pages']))
|
|
return;
|
|
|
|
foreach ($metadata['query']['pages'] as $page) {
|
|
$details = $page['imageinfo']['0']['extmetadata'];
|
|
$author = $details['Artist']['value'];
|
|
$matches = [];
|
|
if (preg_match('/href="(http\S*)"/', $author, $matches)) {
|
|
$author_url = $matches[1];
|
|
} else {
|
|
$author_url = "https://en.wikipedia.org/wiki/File:$image_name";
|
|
}
|
|
|
|
$license_url = $details['LicenseUrl']['value'];
|
|
}
|
|
|
|
$engname = get_com_en_name($sci_name);
|
|
$image_url = $data['originalimage']['source'];
|
|
$title = $data['title'];
|
|
|
|
// $sci_name, $com_en_name, $image_url, $title, $id, $author_url, $license_url
|
|
$this->set_image_in_db($sci_name, $engname, $image_url, $title, $sci_name, $author_url, $license_url);
|
|
}
|
|
|
|
public function get_image($sci_name) {
|
|
$image = parent::get_image($sci_name);
|
|
if ($image === false)
|
|
return false;
|
|
$image_name = substr($image['image_url'], strrpos($image['image_url'], '/') + 1);
|
|
// external link to photo
|
|
$photos_url = "https://en.wikipedia.org/wiki/File:$image_name";
|
|
$image['photos_url'] = $photos_url;
|
|
return $image;
|
|
}
|
|
}
|
|
|
|
function get_info_url($sciname){
|
|
$engname = get_com_en_name($sciname);
|
|
$config = get_config();
|
|
if ($config['INFO_SITE'] === 'EBIRD'){
|
|
require 'scripts/ebird.php';
|
|
$ebird = $ebirds[$sciname];
|
|
$language = $config['DATABASE_LANG'];
|
|
$url = "https://ebird.org/species/$ebird?siteLanguage=$language";
|
|
$url_title = "eBirds";
|
|
} else {
|
|
$engname_url = str_replace("'", '', str_replace(' ', '_', $engname));
|
|
$url = "https://allaboutbirds.org/guide/$engname_url";
|
|
$url_title = "All About Birds";
|
|
}
|
|
$ret = array(
|
|
'URL' => $url,
|
|
'TITLE' => $url_title
|
|
);
|
|
return $ret;
|
|
}
|
|
|
|
function get_color_scheme(){
|
|
$config = get_config();
|
|
if (strtolower($config['COLOR_SCHEME']) === 'dark'){
|
|
return 'static/dark-style.css';
|
|
} else {
|
|
return 'style.css';
|
|
}
|
|
}
|