Merge pull request #11 from massix/feat/validate-alias-name

Validate aliases names

Author: massix

README.md

@@ -99,12 +99,12 @@ The configuration file is loaded when Gleeter starts. Gleeter looks for the conf
     *   `max_cols`: Specifies the maximum number of columns to use for displaying the comic.
     *   `max_lines`: Specifies the maximum number of lines to use for displaying the comic.
 
-*   **`[[alias]]`**: This section defines aliases for accessing comics. You can define multiple aliases.
-    *   `name`: The name of the alias.
+*   `[[alias]]`**: This section defines aliases for accessing comics. You can define multiple aliases.
+    *   `name`: The name of the alias. Alias names **must not** be empty and **must not** contain any of the following characters: `!`, `;`, `$`, `:`, `\`, `"`, `'`, `(`, `)`, space, tab, newline, or carriage return. Leading and trailing whitespaces will be automatically removed.
     *   `type`: The type of alias. Valid values are `"id"`, `"random"`, and `"latest"`.
     *   `id`: (Only required for `"id"` aliases) The comic ID to associate with the alias.
 
-The `src/gleeter/config.gleam` file defines the structure of the configuration data and how it is parsed from the TOML file.
+The [config.gleam](src/gleeter/config.gleam) file defines the structure of the configuration data and how it is parsed from the TOML file.
 
 To modify Gleeter's behavior, simply edit the configuration file and restart the application.
 

flake.nix

@@ -10,7 +10,7 @@
         pkgs = import nixpkgs { inherit system; };
         inherit (pkgs) mkShell;
         gleamPackagesHash = "sha256-DIY9OA3ZigaVC2gxvwgCrF8rjNIraSy7mVqudp62x4M=";
-        version = "1.3.2";
+        version = "1.3.3";
         pname = "gleeter";
         src = ./.;
         gleam-helper = pkgs.callPackage ./nix/gleam-helper.nix { };
@@ -24,7 +24,7 @@
             sqlite
           ];
         };
-        overlays = _: _: { gleeter = self.packages.${system}.gleeter; };
+        overlays = _: _: { inherit (self.packages.${system}) gleeter; };
         packages = {
           gleeter = gleam-helper.buildGleamPackage {
             inherit pname version src gleamPackagesHash;

src/gleeter/config.gleam

@@ -3,6 +3,7 @@ import gleam/dict
 import gleam/list
 import gleam/option
 import gleam/result
+import gleam/string
 import simplifile
 import tom
 
@@ -63,19 +64,60 @@ fn or_empty(
   }
 }
 
+type NameString {
+  Invalid
+  Valid(String)
+}
+
+const forbidden_chars: List(String) = [
+  "!", ";", "$", ":", "\\", "\"", "'", "(", ")", " ", "\t", "\n", "\r",
+]
+
+fn validate_name(in: Result(String, a)) -> NameString {
+  let with_valid = fn(in: NameString, next: fn(String) -> NameString) -> NameString {
+    case in {
+      Invalid -> Invalid
+      Valid(s) -> next(s)
+    }
+  }
+
+  let check_trim = fn(in: NameString) -> NameString {
+    use s <- with_valid(in)
+    case string.trim(s) {
+      "" -> Invalid
+      s -> Valid(s)
+    }
+  }
+
+  let check_special = fn(in: NameString) -> NameString {
+    use s <- with_valid(in)
+    case string.to_graphemes(s) |> list.any(list.contains(forbidden_chars, _)) {
+      True -> Invalid
+      False -> Valid(s)
+    }
+  }
+
+  case in {
+    Ok(s) -> {
+      Valid(s) |> check_trim |> check_special
+    }
+    Error(_) -> Invalid
+  }
+}
+
 fn parse_alias(in: dict.Dict(String, tom.Toml)) -> option.Option(Alias) {
-  let name = tom.get_string(in, ["name"]) |> option.from_result
+  let name = tom.get_string(in, ["name"]) |> validate_name
   let alias_type = tom.get_string(in, ["type"]) |> option.from_result
   let comic_id = tom.get_int(in, ["id"]) |> option.from_result
 
   case name, alias_type, comic_id {
-    option.Some(name), option.Some("id"), option.Some(comic_id) -> {
+    Valid(name), option.Some("id"), option.Some(comic_id) -> {
       IdAlias(name, comic_id) |> option.Some
     }
-    option.Some(name), option.Some("latest"), _ -> {
+    Valid(name), option.Some("latest"), _ -> {
       LatestAlias(name) |> option.Some
     }
-    option.Some(name), option.Some("random"), _ -> {
+    Valid(name), option.Some("random"), _ -> {
       RandomAlias(name) |> option.Some
     }
     _, _, _ -> option.None

src/gleeter/version.gleam

@@ -1,4 +1,4 @@
-pub const gleeter_version: String = "1.3.2"
+pub const gleeter_version: String = "1.3.3"
 
 pub const github_url: String = "https://github.com/massix/gleeter"
 

test/gleeter/config_test.gleam

@@ -29,6 +29,7 @@ pub fn config_tests() -> test_tree.TestTree {
       |> expect.to_equal(
         Configuration(Some(38), Some(80), Some(23), [
           IdAlias("bobbytables", 987),
+          IdAlias("trimmed_alias", 987),
           RandomAlias("rnd"),
           LatestAlias("l"),
         ]),

test_data/config.toml

@@ -9,6 +9,32 @@ name = "bobbytables"
 type = "id"
 id = 987
 
+[[alias]]
+name = "" # Empty name
+type = "id"
+id = 123
+
+[[alias]]
+name = "  trimmed_alias "
+type = "id"
+id = 987
+
+[[alias]]
+name = "     with spaces    "
+type = "random"
+
+[[alias]]
+name = "with!special"
+type = "latest"
+
+[[alias]]
+name = "with;special"
+type = "latest"
+
+[[alias]]
+name = "with(special"
+type = "random"
+
 [[alias]]
 name = "rnd"
 type = "random"