Only accept database connection by uri (#5254)

* Only accept database connection by uri

* lint

* fix docker configs

config/defaults.hjson

@@ -1,11 +1,7 @@
 {
   # settings related to the postgresql database
   database: {
-    # Configure the database by specifying a URI
+    # Configure the database by specifying URI pointing to a postgres instance
-    # 
-    # This is the preferred method to specify database connection details since
-    # it is the most flexible.
-    # Connection URI pointing to a postgres instance
     # 
     # This example uses peer authentication to obviate the need for creating,
     # configuring, and managing passwords.
@@ -14,25 +10,7 @@
     # PostgreSQL's documentation.
     # 
     # [0]: https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6
-    uri: "postgresql:///lemmy?user=lemmy&host=/var/run/postgresql"
+    connection: "postgres://lemmy:password@localhost:5432/lemmy"
-
-    # or
-
-    # Configure the database by specifying parts of a URI
-    # 
-    # Note that specifying the `uri` field should be preferred since it provides
-    # greater control over how the connection is made. This merely exists for
-    # backwards-compatibility.
-    # Username to connect to postgres
-    user: "string"
-    # Password to connect to postgres
-    password: "string"
-    # Host where postgres is running
-    host: "string"
-    # Port where postgres can be accessed
-    port: 123
-    # Name of the postgres database for lemmy
-    database: "string"
     # Maximum number of active sql connections
     pool_size: 30
   }

crates/utils/src/settings/mod.rs

@@ -3,13 +3,11 @@ use anyhow::{anyhow, Context};
 use deser_hjson::from_str;
 use regex::Regex;
 use std::{env, fs, io::Error, sync::LazyLock};
+use structs::{PictrsConfig, PictrsImageMode, Settings};
 use url::Url;
-use urlencoding::encode;
 
 pub mod structs;
 
-use structs::{DatabaseConnection, PictrsConfig, PictrsImageMode, Settings};
-
 const DEFAULT_CONFIG_FILE: &str = "config/config.hjson";
 
 #[allow(clippy::expect_used)]
@@ -51,20 +49,9 @@ impl Settings {
 
   pub fn get_database_url(&self) -> String {
     if let Ok(url) = env::var("LEMMY_DATABASE_URL") {
-      return url;
+      url
-    }
+    } else {
-    match &self.database.connection {
+      self.database.connection.clone()
-      DatabaseConnection::Uri { uri } => uri.clone(),
-      DatabaseConnection::Parts(parts) => {
-        format!(
-          "postgres://{}:{}@{}:{}/{}",
-          encode(&parts.user),
-          encode(&parts.password),
-          parts.host,
-          parts.port,
-          encode(&parts.database),
-        )
-      }
     }
   }
 

crates/utils/src/settings/structs.rs

@@ -132,64 +132,24 @@ pub enum PictrsImageMode {
 #[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
 #[serde(default)]
 pub struct DatabaseConfig {
-  #[serde(flatten, default)]
+  /// Configure the database by specifying URI pointing to a postgres instance
-  pub(crate) connection: DatabaseConnection,
+  ///
+  /// This example uses peer authentication to obviate the need for creating,
+  /// configuring, and managing passwords.
+  ///
+  /// For an explanation of how to use connection URIs, see [here][0] in
+  /// PostgreSQL's documentation.
+  ///
+  /// [0]: https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6
+  #[default("postgres://lemmy:password@localhost:5432/lemmy")]
+  #[doku(example = "postgresql:///lemmy?user=lemmy&host=/var/run/postgresql")]
+  pub(crate) connection: String,
 
   /// Maximum number of active sql connections
   #[default(30)]
   pub pool_size: usize,
 }
 
-#[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
-#[serde(untagged)]
-pub enum DatabaseConnection {
-  /// Configure the database by specifying a URI
-  ///
-  /// This is the preferred method to specify database connection details since
-  /// it is the most flexible.
-  Uri {
-    /// Connection URI pointing to a postgres instance
-    ///
-    /// This example uses peer authentication to obviate the need for creating,
-    /// configuring, and managing passwords.
-    ///
-    /// For an explanation of how to use connection URIs, see [here][0] in
-    /// PostgreSQL's documentation.
-    ///
-    /// [0]: https://www.postgresql.org/docs/current/libpq-connect.html#id-1.7.3.8.3.6
-    #[doku(example = "postgresql:///lemmy?user=lemmy&host=/var/run/postgresql")]
-    uri: String,
-  },
-
-  /// Configure the database by specifying parts of a URI
-  ///
-  /// Note that specifying the `uri` field should be preferred since it provides
-  /// greater control over how the connection is made. This merely exists for
-  /// backwards-compatibility.
-  #[default]
-  Parts(DatabaseConnectionParts),
-}
-
-#[derive(Debug, Deserialize, Serialize, Clone, SmartDefault, Document)]
-#[serde(default)]
-pub struct DatabaseConnectionParts {
-  /// Username to connect to postgres
-  #[default("lemmy")]
-  pub(super) user: String,
-  /// Password to connect to postgres
-  #[default("password")]
-  pub(super) password: String,
-  #[default("localhost")]
-  /// Host where postgres is running
-  pub(super) host: String,
-  /// Port where postgres can be accessed
-  #[default(5432)]
-  pub(super) port: i32,
-  /// Name of the postgres database for lemmy
-  #[default("lemmy")]
-  pub(super) database: String,
-}
-
 #[derive(Debug, Deserialize, Serialize, Clone, Document, SmartDefault)]
 #[serde(deny_unknown_fields)]
 pub struct EmailConfig {

docker/federation/lemmy_alpha.hjson

@@ -8,7 +8,7 @@
     site_name: lemmy-alpha
   }
   database: {
-    host: postgres_alpha
+    connection: "postgres://lemmy:password@postgres_alpha:5432/lemmy"
   }
   pictrs: {
     api_key: "my-pictrs-key"

docker/federation/lemmy_beta.hjson

@@ -8,7 +8,7 @@
     site_name: lemmy-beta
   }
   database: {
-    host: postgres_beta
+    connection: "postgres://lemmy:password@postgres_beta:5432/lemmy"
   }
   pictrs: {
     api_key: "my-pictrs-key"

docker/federation/lemmy_delta.hjson

@@ -8,6 +8,6 @@
     site_name: lemmy-delta
   }
   database: {
-    host: postgres_delta
+    connection: "postgres://lemmy:password@postgres_delta:5432/lemmy"
   }
 }

docker/federation/lemmy_epsilon.hjson

@@ -8,7 +8,7 @@
     site_name: lemmy-epsilon
   }
   database: {
-    host: postgres_epsilon
+    connection: "postgres://lemmy:password@postgres_epsilon:5432/lemmy"
   }
   pictrs: {
     api_key: "my-pictrs-key"

docker/federation/lemmy_gamma.hjson

@@ -8,7 +8,7 @@
     site_name: lemmy-gamma
   }
   database: {
-    host: postgres_gamma
+    connection: "postgres://lemmy:password@postgres_gamma:5432/lemmy"
   }
   pictrs: {
     api_key: "my-pictrs-key"

docker/lemmy.hjson

@@ -11,7 +11,7 @@
     site_name: "lemmy-dev"
   }
   database: {
-    host: postgres
+    connection: "postgres://lemmy:password@postgres:5432/lemmy"
   }
 
   hostname: "localhost"