ttrss/classes/config.php

187 lines
7.1 KiB
PHP
Raw Normal View History

2021-02-22 18:49:09 +00:00
<?php
class Config {
2021-02-22 19:35:27 +00:00
private const _ENVVAR_PREFIX = "TTRSS_";
2021-02-22 18:49:09 +00:00
2021-02-23 13:58:48 +00:00
const T_BOOL = 1;
const T_STRING = 2;
const T_INT = 3;
2021-02-22 20:20:52 +00:00
// override defaults, defined below in _DEFAULTS[], via environment: DB_TYPE becomes TTRSS_DB_TYPE, etc
2021-02-22 18:49:09 +00:00
2021-02-22 19:35:27 +00:00
const DB_TYPE = "DB_TYPE";
const DB_HOST = "DB_HOST";
const DB_USER = "DB_USER";
const DB_NAME = "DB_NAME";
const DB_PASS = "DB_PASS";
const DB_PORT = "DB_PORT";
const MYSQL_CHARSET = "MYSQL_CHARSET";
const SELF_URL_PATH = "SELF_URL_PATH";
const SINGLE_USER_MODE = "SINGLE_USER_MODE";
const SIMPLE_UPDATE_MODE = "SIMPLE_UPDATE_MODE";
const PHP_EXECUTABLE = "PHP_EXECUTABLE";
const LOCK_DIRECTORY = "LOCK_DIRECTORY";
const CACHE_DIR = "CACHE_DIR";
const ICONS_DIR = "ICONS_DIR";
const ICONS_URL = "ICONS_URL";
const AUTH_AUTO_CREATE = "AUTH_AUTO_CREATE";
const AUTH_AUTO_LOGIN = "AUTH_AUTO_LOGIN";
const FORCE_ARTICLE_PURGE = "FORCE_ARTICLE_PURGE";
const SESSION_COOKIE_LIFETIME = "SESSION_COOKIE_LIFETIME";
const SMTP_FROM_NAME = "SMTP_FROM_NAME";
const SMTP_FROM_ADDRESS = "SMTP_FROM_ADDRESS";
const DIGEST_SUBJECT = "DIGEST_SUBJECT";
const CHECK_FOR_UPDATES = "CHECK_FOR_UPDATES";
const PLUGINS = "PLUGINS";
const LOG_DESTINATION = "LOG_DESTINATION";
const LOCAL_OVERRIDE_STYLESHEET = "LOCAL_OVERRIDE_STYLESHEET";
const DAEMON_MAX_CHILD_RUNTIME = "DAEMON_MAX_CHILD_RUNTIME";
const DAEMON_MAX_JOBS = "DAEMON_MAX_JOBS";
const FEED_FETCH_TIMEOUT = "FEED_FETCH_TIMEOUT";
const FEED_FETCH_NO_CACHE_TIMEOUT = "FEED_FETCH_NO_CACHE_TIMEOUT";
const FILE_FETCH_TIMEOUT = "FILE_FETCH_TIMEOUT";
const FILE_FETCH_CONNECT_TIMEOUT = "FILE_FETCH_CONNECT_TIMEOUT";
const DAEMON_UPDATE_LOGIN_LIMIT = "DAEMON_UPDATE_LOGIN_LIMIT";
const DAEMON_FEED_LIMIT = "DAEMON_FEED_LIMIT";
const DAEMON_SLEEP_INTERVAL = "DAEMON_SLEEP_INTERVAL";
const MAX_CACHE_FILE_SIZE = "MAX_CACHE_FILE_SIZE";
const MAX_DOWNLOAD_FILE_SIZE = "MAX_DOWNLOAD_FILE_SIZE";
const MAX_FAVICON_FILE_SIZE = "MAX_FAVICON_FILE_SIZE";
const CACHE_MAX_DAYS = "CACHE_MAX_DAYS";
const MAX_CONDITIONAL_INTERVAL = "MAX_CONDITIONAL_INTERVAL";
const DAEMON_UNSUCCESSFUL_DAYS_LIMIT = "DAEMON_UNSUCCESSFUL_DAYS_LIMIT";
const LOG_SENT_MAIL = "LOG_SENT_MAIL";
2021-02-23 06:01:27 +00:00
const HTTP_PROXY = "HTTP_PROXY";
const FORBID_PASSWORD_CHANGES = "FORBID_PASSWORD_CHANGES";
const SESSION_NAME = "SESSION_NAME";
2021-02-22 18:49:09 +00:00
2021-02-22 19:35:27 +00:00
private const _DEFAULTS = [
2021-02-23 13:58:48 +00:00
Config::DB_TYPE => [ "pgsql", Config::T_STRING ],
Config::DB_HOST => [ "db", Config::T_STRING ],
Config::DB_USER => [ "", Config::T_STRING ],
Config::DB_NAME => [ "", Config::T_STRING ],
Config::DB_PASS => [ "", Config::T_STRING ],
Config::DB_PORT => [ "5432", Config::T_STRING ],
Config::MYSQL_CHARSET => [ "UTF8", Config::T_STRING ],
Config::SELF_URL_PATH => [ "", Config::T_STRING ],
Config::SINGLE_USER_MODE => [ "", Config::T_BOOL ],
Config::SIMPLE_UPDATE_MODE => [ "", Config::T_BOOL ],
Config::PHP_EXECUTABLE => [ "/usr/bin/php", Config::T_STRING ],
Config::LOCK_DIRECTORY => [ "lock", Config::T_STRING ],
Config::CACHE_DIR => [ "cache", Config::T_STRING ],
Config::ICONS_DIR => [ "feed-icons", Config::T_STRING ],
Config::ICONS_URL => [ "feed-icons", Config::T_STRING ],
Config::AUTH_AUTO_CREATE => [ "true", Config::T_BOOL ],
Config::AUTH_AUTO_LOGIN => [ "true", Config::T_BOOL ],
Config::FORCE_ARTICLE_PURGE => [ 0, Config::T_INT ],
Config::SESSION_COOKIE_LIFETIME => [ 86400, Config::T_INT ],
Config::SMTP_FROM_NAME => [ "Tiny Tiny RSS", Config::T_STRING ],
Config::SMTP_FROM_ADDRESS => [ "noreply@localhost", Config::T_STRING ],
Config::DIGEST_SUBJECT => [ "[tt-rss] New headlines for last 24 hours",
Config::T_STRING ],
Config::CHECK_FOR_UPDATES => [ "true", Config::T_BOOL ],
Config::PLUGINS => [ "auth_internal", Config::T_STRING ],
Config::LOG_DESTINATION => [ "sql", Config::T_STRING ],
Config::LOCAL_OVERRIDE_STYLESHEET => [ "local-overrides.css",
Config::T_STRING ],
Config::DAEMON_MAX_CHILD_RUNTIME => [ 1800, Config::T_STRING ],
Config::DAEMON_MAX_JOBS => [ 2, Config::T_INT ],
Config::FEED_FETCH_TIMEOUT => [ 45, Config::T_INT ],
Config::FEED_FETCH_NO_CACHE_TIMEOUT => [ 15, Config::T_INT ],
Config::FILE_FETCH_TIMEOUT => [ 45, Config::T_INT ],
Config::FILE_FETCH_CONNECT_TIMEOUT => [ 15, Config::T_INT ],
Config::DAEMON_UPDATE_LOGIN_LIMIT => [ 30, Config::T_INT ],
Config::DAEMON_FEED_LIMIT => [ 500, Config::T_INT ],
Config::DAEMON_SLEEP_INTERVAL => [ 120, Config::T_INT ],
Config::MAX_CACHE_FILE_SIZE => [ 64*1024*1024, Config::T_INT ],
Config::MAX_DOWNLOAD_FILE_SIZE => [ 16*1024*1024, Config::T_INT ],
Config::MAX_FAVICON_FILE_SIZE => [ 1*1024*1024, Config::T_INT ],
Config::CACHE_MAX_DAYS => [ 7, Config::T_INT ],
Config::MAX_CONDITIONAL_INTERVAL => [ 3600*12, Config::T_INT ],
Config::DAEMON_UNSUCCESSFUL_DAYS_LIMIT => [ 30, Config::T_INT ],
Config::LOG_SENT_MAIL => [ "", Config::T_BOOL ],
Config::HTTP_PROXY => [ "", Config::T_STRING ],
Config::FORBID_PASSWORD_CHANGES => [ "", Config::T_BOOL ],
Config::SESSION_NAME => [ "ttrss_sid", Config::T_STRING ],
2021-02-22 19:35:27 +00:00
];
2021-02-22 18:49:09 +00:00
2021-02-22 19:35:27 +00:00
private static $instance;
2021-02-22 18:49:09 +00:00
2021-02-22 19:35:27 +00:00
private $params = [];
2021-02-25 18:42:05 +00:00
private $schema_version = null;
2021-02-22 19:35:27 +00:00
2021-02-25 18:42:05 +00:00
public static function get_instance() : Config {
2021-02-22 18:49:09 +00:00
if (self::$instance == null)
self::$instance = new self();
return self::$instance;
}
2021-02-25 12:49:30 +00:00
private function __clone() {
//
}
2021-02-22 19:35:27 +00:00
function __construct() {
$ref = new ReflectionClass(get_class($this));
2021-02-22 18:49:09 +00:00
2021-02-22 19:35:27 +00:00
foreach ($ref->getConstants() as $const => $cvalue) {
2021-02-23 13:58:48 +00:00
if (isset($this::_DEFAULTS[$const])) {
2021-02-22 19:35:27 +00:00
$override = getenv($this::_ENVVAR_PREFIX . $const);
2021-02-22 18:49:09 +00:00
2021-02-23 13:58:48 +00:00
list ($defval, $deftype) = $this::_DEFAULTS[$const];
2021-02-25 06:33:36 +00:00
$this->params[$cvalue] = [ self::cast_to(!empty($override) ? $override : $defval, $deftype), $deftype ];
2021-02-22 19:35:27 +00:00
}
}
}
2021-02-22 18:49:09 +00:00
2021-02-25 18:42:05 +00:00
static function get_schema_version(bool $nocache = false) {
return self::get_instance()->_schema_version($nocache);
}
function _schema_version(bool $nocache = false) {
if (empty($this->schema_version) || $nocache) {
$row = Db::pdo()->query("SELECT schema_version FROM ttrss_version")->fetch();
$this->schema_version = (int) $row["schema_version"];
}
return $this->schema_version;
}
2021-02-25 06:33:36 +00:00
static function cast_to(string $value, int $type_hint) {
2021-02-23 13:58:48 +00:00
switch ($type_hint) {
case self::T_BOOL:
return sql_bool_to_bool($value);
case self::T_INT:
return (int) $value;
default:
return $value;
}
}
2021-02-22 20:20:52 +00:00
private function _get(string $param) {
2021-02-23 13:58:48 +00:00
list ($value, $type_hint) = $this->params[$param];
return $this->cast_to($value, $type_hint);
2021-02-22 19:35:27 +00:00
}
2021-02-22 18:49:09 +00:00
2021-02-23 13:58:48 +00:00
private function _add(string $param, string $default, int $type_hint) {
2021-02-22 20:20:52 +00:00
$override = getenv($this::_ENVVAR_PREFIX . $param);
2021-02-25 06:33:36 +00:00
$this->params[$param] = [ self::cast_to(!empty($override) ? $override : $default, $type_hint), $type_hint ];
2021-02-22 20:20:52 +00:00
}
2021-02-23 13:58:48 +00:00
static function add(string $param, string $default, int $type_hint = Config::T_STRING) {
2021-02-22 20:20:52 +00:00
$instance = self::get_instance();
2021-02-23 13:58:48 +00:00
return $instance->_add($param, $default, $type_hint);
2021-02-22 20:20:52 +00:00
}
static function get(string $param) {
2021-02-22 19:35:27 +00:00
$instance = self::get_instance();
2021-02-22 18:49:09 +00:00
2021-02-22 19:35:27 +00:00
return $instance->_get($param);
}
2021-02-22 18:49:09 +00:00
2021-02-22 20:20:52 +00:00
}