web-base/Core/Configuration/Settings.class.php

<?php

/**
 * Do not change settings here, they are dynamically loaded from database.
 */

namespace Core\Configuration;

use Core\Driver\Logger\Logger;
use Core\Driver\SQL\Column\Column;
use Core\Driver\SQL\Condition\CondNot;
use Core\Driver\SQL\Condition\CondRegex;
use Core\Driver\SQL\Query\Insert;
use Core\Driver\SQL\SQL;
use Core\Objects\Captcha\CaptchaProvider;
use Core\Objects\Captcha\GoogleRecaptchaProvider;
use Core\Objects\Captcha\HCaptchaProvider;
use Core\Objects\ConnectionData;
use Core\Objects\Context;
use Core\Objects\DatabaseEntity\GpgKey;

class Settings {

  //
  private bool $installationComplete;

  // general settings
  private string $siteName;

  private string $contactMail;

  private ?GpgKey $contactGpgKey;

  private string $baseUrl;
  private array $trustedDomains;
  private bool $registrationAllowed;
  private array $allowedExtensions;
  private string $timeZone;

  // captcha
  private string $captchaProvider;
  private string $captchaSiteKey;
  private string $captchaSecretKey;

  // mail
  private bool $mailEnabled;
  private string $mailSender;
  private string $mailFooter;
  private bool $mailAsync;

  // rate limiting
  private bool $rateLimitingEnabled;
  private string $redisHost;
  private int $redisPort;
  private string $redisPassword;

  //
  private Logger $logger;

  public function __construct() {
    $this->logger = new Logger("Settings");
  }

  public static function getAll(?SQL $sql, ?string $pattern = null, bool $external = false): ?array {

    // We do not have a Settings table yet, we might still be in installation phase
    if (!$sql->tableExists("Settings")) {
      return null;
    }

    $query = $sql->select("name", "value")
      ->from("Settings");

    if ($pattern) {
      $query->where(new CondRegex(new Column("name"), $pattern));
    }

    if ($external) {
      $query->where(new CondNot("private"));
    }

    $res = $query->execute();
    if ($res !== false && $res !== null) {
      $settings = array();
      foreach($res as $row) {
        $settings[$row["name"]] = json_decode($row["value"], true);
      }
      return $settings;
    } else {
      return null;
    }
  }

  public static function get(?SQL $sql, string $key, mixed $defaultValue): mixed {
    $res = $sql->select("value") ->from("Settings")
      ->whereEq("name", $key)
      ->execute();

    if ($res === false || $res === null) {
      return null;
    } else {
      return (empty($res)) ? $defaultValue : json_decode($res[0]["value"], true);
    }
  }

  public function isInstalled(): bool {
    return $this->installationComplete;
  }

  public static function loadDefaults(?array $env = null): Settings {
    $protocol = getProtocol();
    $hostname = getCurrentHostName();
    $settings = new Settings();

    // General
    $settings->siteName = "WebBase";
    $settings->contactMail = "webmaster@$hostname";
    $settings->contactGpgKey = null;
    $settings->baseUrl = "$protocol://$hostname";
    $settings->trustedDomains = [$hostname];
    $settings->allowedExtensions = ['png', 'jpg', 'jpeg', 'gif', 'htm', 'html'];
    $settings->installationComplete = false;
    $settings->registrationAllowed = false;
    $settings->timeZone = date_default_timezone_get();

    // captcha
    $settings->captchaProvider = "disabled";
    $settings->captchaSiteKey = "";
    $settings->captchaSecretKey = "";

    // Mail
    $settings->mailEnabled = false;
    $settings->mailSender = "webmaster@localhost";
    $settings->mailFooter = "";
    $settings->mailAsync = false;

    // rate limiting
    $settings->redisPort = 6379;
    $settings->redisPassword = "";
    if (isDocker()) {
      $settings->rateLimitingEnabled = true;
      $settings->redisHost = "webbase-redis";
      if ($env && array_key_exists("REDIS_PASSWORD", $env)) {
        $settings->redisPassword = $env["REDIS_PASSWORD"];
      }
    } else {
      $settings->rateLimitingEnabled = false;
      $settings->redisHost = "";
    }

    return $settings;
  }

  public function loadFromDatabase(Context $context): bool {
    $sql = $context->getSQL();
    $this->logger = new Logger("Settings", $sql);
    $req = new \Core\API\Settings\Get($context);
    $success = $req->execute();

    if ($success) {
      $result = $req->getResult()["settings"];
      $this->siteName = $result["site_name"] ?? $this->siteName;
      $this->contactMail = $result["mail_contact"] ?? $this->contactMail;
      $this->baseUrl = $result["base_url"] ?? $this->baseUrl;
      $this->registrationAllowed = $result["user_registration_enabled"] ?? $this->registrationAllowed;
      $this->installationComplete = $result["installation_completed"] ?? $this->installationComplete;
      $this->timeZone = $result["time_zone"] ?? $this->timeZone;
      $this->captchaProvider = $result["captcha_provider"] ?? $this->captchaProvider;
      $this->captchaSiteKey = $result["captcha_site_key"] ?? $this->captchaSiteKey;
      $this->captchaSecretKey = $result["captcha_secret_key"] ?? $this->captchaSecretKey;
      $this->mailEnabled = $result["mail_enabled"] ?? $this->mailEnabled;
      $this->mailSender = $result["mail_from"] ?? $this->mailSender;
      $this->mailFooter = $result["mail_footer"] ?? $this->mailFooter;
      $this->mailAsync = $result["mail_async"] ?? $this->mailAsync;
      $this->allowedExtensions = $result["allowed_extensions"] ?? $this->allowedExtensions;
      $this->trustedDomains = $result["trusted_domains"] ?? $this->trustedDomains;
      $this->rateLimitingEnabled = $result["rate_limiting_enabled"] ?? $this->rateLimitingEnabled;
      $this->redisHost = $result["redis_host"] ?? $this->redisHost;
      $this->redisPort = $result["redis_port"] ?? $this->redisPort;
      $this->redisPassword = $result["redis_password"] ?? $this->redisPassword;
      date_default_timezone_set($this->timeZone);

      $this->contactGpgKey = $req->getContactGpgKey();
    }

    return false;
  }

  public function addRows(Insert $query): void {
    // ["name", "value", "private", "readonly"]
    $query->addRow("site_name", json_encode($this->siteName), false, false)
      ->addRow("mail_contact", json_encode($this->contactMail), false, false)
      ->addRow("mail_contact_gpg_key_id", json_encode($this->contactGpgKey?->getId()), false, true)
      ->addRow("base_url", json_encode($this->baseUrl), false, false)
      ->addRow("trusted_domains", json_encode($this->trustedDomains), false, false)
      ->addRow("user_registration_enabled", json_encode($this->registrationAllowed), false, false)
      ->addRow("installation_completed", json_encode($this->installationComplete), true, true)
      ->addRow("time_zone", json_encode($this->timeZone), false, false)
      ->addRow("captcha_provider", json_encode($this->captchaProvider), false, false)
      ->addRow("captcha_site_key", json_encode($this->captchaSiteKey), false, false)
      ->addRow("captcha_secret_key", json_encode($this->captchaSecretKey), true, false)
      ->addRow("allowed_extensions", json_encode($this->allowedExtensions), false, false)
      ->addRow("mail_host", '""', false, false)
      ->addRow("mail_port", '587', false, false)
      ->addRow("mail_username", '""', false, false)
      ->addRow("mail_password", '""', true, false)
      ->addRow("mail_from", '""', false, false)
      ->addRow("mail_footer", '""', false, false)
      ->addRow("mail_async", false, false, false)
      ->addRow("rate_limiting_enabled", true, false, false)
      ->addRow("redis_host", json_encode($this->redisHost), false, false)
      ->addRow("redis_port", json_encode($this->redisPort), false, false)
      ->addRow("redis_password", json_encode($this->redisPassword), true, false)
    ;
  }

  public function getSiteName(): string {
    return $this->siteName;
  }

  public function getContactMail(): string {
    return $this->contactMail;
  }

  public function getContactGPGKey(): ?GpgKey {
    return $this->contactGpgKey;
  }

  public function getTimeZone(): string {
    return $this->timeZone;
  }

  public function setTimeZone(string $tz) {
    $this->timeZone = $tz;
  }

  public function getBaseUrl(): string {
    return $this->baseUrl;
  }

  public function isCaptchaEnabled(): bool {
    return CaptchaProvider::isValid($this->captchaProvider);
  }

  public function getCaptchaProvider(): ?CaptchaProvider  {
    return match ($this->captchaProvider) {
      CaptchaProvider::RECAPTCHA => new GoogleRecaptchaProvider($this->captchaSiteKey, $this->captchaSecretKey),
      CaptchaProvider::HCAPTCHA => new HCaptchaProvider($this->captchaSiteKey, $this->captchaSecretKey),
      default => null,
    };
  }

  public function isRegistrationAllowed(): bool {
    return $this->registrationAllowed;
  }

  public function isMailEnabled(): bool {
    return $this->mailEnabled;
  }

  public function isMailAsync(): bool {
    return $this->mailAsync;
  }

  public function getMailSender(): string {
    return $this->mailSender;
  }

  public function isExtensionAllowed(string $ext): bool {
    return empty($this->allowedExtensions) || in_array(strtolower(trim($ext)), $this->allowedExtensions);
  }

  public function getDomain(): string {
    return parse_url($this->getBaseUrl(), PHP_URL_HOST);
  }

  public function getLogger(): Logger {
    return $this->logger;
  }

  public function isTrustedDomain(string $domain): bool {
    $domain = strtolower($domain);
    foreach ($this->trustedDomains as $trustedDomain) {
      $trustedDomain = trim(strtolower($trustedDomain));
      if ($trustedDomain === $domain) {
        return true;
      }


      // *.def.com <-> abc.def.com
      if (startsWith($trustedDomain, "*.") && endsWith($domain, substr($trustedDomain, 1))) {
        return true;
      }
    }

    return false;
  }

  public function getTrustedDomains(): array {
    return $this->trustedDomains;
  }

  public function isRateLimitingEnabled(): bool {
    return $this->rateLimitingEnabled;
  }

  public function getRedisConfiguration(): ConnectionData {
    return new ConnectionData(
      $this->redisHost,
      $this->redisPort,
      "",
      $this->redisPassword
    );
  }
}