feat(access-list): add optional note field to access list clients

backend/internal/access-list.js

@@ -55,6 +55,7 @@ const internalAccessList = {
 			await accessListClientModel.query().insert({
 				access_list_id: row.id,
 				address: client.address,
+				note: client.note || null,
 				directive: client.directive,
 			});
 		}
@@ -159,6 +160,7 @@ const internalAccessList = {
 					await accessListClientModel.query().insert({
 						access_list_id: data.id,
 						address: client.address,
+						note: client.note || null,
 						directive: client.directive,
 					});
 				}

backend/lib/utils.js

@@ -92,13 +92,20 @@ const getRenderEngine = () => {
 	});
 
 	/**
-	 * nginxAccessRule expects the object given to have 2 properties:
+	 * nginxAccessRule expects the object given to have 3 properties:
 	 *
 	 * directive  string
 	 * address    string
+	 * note		  string
 	 */
 	renderEngine.registerFilter("nginxAccessRule", (v) => {
 		if (typeof v.directive !== "undefined" && typeof v.address !== "undefined" && v.directive && v.address) {
+			const note = typeof v.note === "string" ? v.note.trim() : "";
+			if (note) {
+				// prevent newline / comment-breaking characters
+				const safe = note.replace(/[\r\n#;]/g, " ").trim();
+				return `${v.directive} ${v.address}; # ${safe}`;
+			}
 			return `${v.directive} ${v.address};`;
 		}
 		return "";

backend/migrations/20260220111310_access_list_client_note.js

@@ -0,0 +1,36 @@
+import { migrate as logger } from "../logger.js";
+
+const migrateName = "access_list_client_note";
+
+/**
+ * Migrate
+ *
+ * @see http://knexjs.org/#Schema
+ *
+ * @param   {Object}  knex
+ * @returns {Promise}
+ */
+const up = (knex) => {
+	logger.info(`[${migrateName}] Migrating Up...`);
+
+	return knex.schema
+		.table("access_list_client", (access_list) => {
+			access_list.string("note", 200).nullable();
+		})
+		.then(() => {
+			logger.info(`[${migrateName}] access_list_client Table altered`);
+		});
+};
+
+/**
+ * Undo Migrate
+ *
+ * @param   {Object}  knex
+ * @returns {Promise}
+ */
+const down = (_knex) => {
+	logger.warn(`[${migrateName}] You can't migrate down this one.`);
+	return Promise.resolve(true);
+};
+
+export { up, down };

backend/schema/common.json

@@ -156,6 +156,12 @@
 			],
 			"example": "192.168.0.11"
 		},
+		"note": {
+			"description": "Note",
+			"type": "string",
+			"example": "Home",
+			"maxLength": 200
+		},
 		"access_items": {
 			"type": "array",
 			"items": {
@@ -191,19 +197,24 @@
 					"address": {
 						"$ref": "#/properties/address"
 					},
+					"note": {
+						"$ref": "#/properties/note"
+					},
 					"directive": {
 						"$ref": "#/properties/directive"
 					}
 				},
 				"example": {
 					"directive": "allow",
-					"address": "192.168.0.0/24"
+					"address": "192.168.0.0/24",
+					"note": "Home"
 				}
 			},
 			"example": [
 				{
 					"directive": "allow",
-					"address": "192.168.0.0/24"
+					"address": "192.168.0.0/24",
+					"note": "Home"
 				}
 			]
 		},

backend/schema/paths/nginx/access-lists/listID/put.json

@@ -60,7 +60,8 @@
 					"clients": [
 						{
 							"directive": "allow",
-							"address": "192.168.0.0/24"
+							"address": "192.168.0.0/24",
+							"note": "note"
 						}
 					]
 				}

backend/schema/paths/nginx/access-lists/post.json

@@ -51,7 +51,8 @@
 					"clients": [
 						{
 							"directive": "allow",
-							"address": "192.168.0.0/24"
+							"address": "192.168.0.0/24",
+							"note": "note"
 						}
 					]
 				}
@@ -118,6 +119,7 @@
 										"modified_on": "2024-10-08T22:15:40.000Z",
 										"access_list_id": 1,
 										"address": "127.0.0.1",
+										"note": "note",
 										"directive": "allow",
 										"meta": {}
 									}

frontend/src/api/backend/models.ts

@@ -77,6 +77,7 @@ export type AccessListClient = {
 	modifiedOn?: string;
 	accessListId?: number;
 	address: string;
+	note?: string;
 	directive: "allow" | "deny";
 	meta?: Record<string, any>;
 };

frontend/src/components/Form/AccessClientFields.tsx

@@ -78,6 +78,16 @@ export function AccessClientFields({ initialValues, name = "clients" }: Props) {
 								onChange={(e) => handleChange(idx, "address", e.target.value)}
 								placeholder={intl.formatMessage({ id: "access-list.rule-source.placeholder" })}
 							/>
+							<input
+								name={`clients[${idx}].note`}
+								type="text"
+								maxLength={200}
+								className="form-control"
+								autoComplete="off"
+								value={client.note ?? ""}
+								onChange={(e) => handleChange(idx, "note", e.target.value)}
+								placeholder={intl.formatMessage({ id: "access-list.rule-source.placeholder-note" })}
+							/>
 						</div>
 					</div>
 					<div className="col-1">

frontend/src/locale/src/bg.json

@@ -26,6 +26,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 или 192.168.1.0/24 или 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Напр. „Дом“ или „Офис“"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Удовлетворяване на което и да е"
 	},

frontend/src/locale/src/cs.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 nebo 192.168.1.0/24 nebo 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Např. „Domov“ nebo „Kancelář“"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Splnit kterékoliv"
 	},

frontend/src/locale/src/de.json

@@ -23,6 +23,12 @@
 	"access-list.public.subtitle": {
 		"defaultMessage": "Keine Authentifizierung erforderlich"
 	},
+	"access-list.rule-source.placeholder": {
+		"defaultMessage": "192.168.1.100 oder 192.168.1.0/24 oder 2001:0db8::/32"
+	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Z. B. „Zuhause“ oder „Büro“"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Satisfy Any"
 	},

frontend/src/locale/src/en.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 or 192.168.1.0/24 or 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "E.g. \"Home\" or \"Office\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Satisfy Any"
 	},

frontend/src/locale/src/es.json

@@ -26,6 +26,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 o 192.168.1.0/24 o 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "P. ej., «Casa» u «Oficina»"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Satisfacer Cualquiera"
 	},

frontend/src/locale/src/fr.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 ou 192.168.1.0/24 ou 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Par ex. « Domicile » ou « Bureau »"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Valide n'importe quelle règle"
 	},

frontend/src/locale/src/ga.json

@@ -26,6 +26,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 nó 192.168.1.0/24 nó 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "M.sh. \"Baile\" nó \"Oifig\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Sásaigh Aon"
 	},

frontend/src/locale/src/hu.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 vagy 192.168.1.0/24 vagy 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Pl. „Otthon” vagy „Iroda”"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Bármely teljesítése"
 	},

frontend/src/locale/src/id.json

@@ -26,6 +26,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 atau 192.168.1.0/24 atau 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Mis. \"Rumah\" atau \"Kantor\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Penuhi Salah Satu"
 	},

frontend/src/locale/src/it.json

@@ -23,6 +23,12 @@
 	"access-list.public.subtitle": {
 		"defaultMessage": "Nessuna autenticazione base richiesta"
 	},
+	"access-list.rule-source.placeholder": {
+		"defaultMessage": "192.168.1.100 o 192.168.1.0/24 o 2001:0db8::/32"
+	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Es. \"Casa\" o \"Ufficio\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Soddisfa Qualsiasi"
 	},

frontend/src/locale/src/ja.json

@@ -23,6 +23,12 @@
 	"access-list.public.subtitle": {
 		"defaultMessage": "ベーシック認証を使用しません"
 	},
+	"access-list.rule-source.placeholder": {
+		"defaultMessage": "192.168.1.100 または 192.168.1.0/24 または 2001:0db8::/32"
+	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "例：「自宅」や「オフィス」"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "いずれかを満たす"
 	},

frontend/src/locale/src/ko.json

@@ -26,6 +26,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 / 192.168.1.0/24 / IPv6"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "예: \"집\" 또는 \"사무실\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "조건 중 하나라도 충족"
 	},

frontend/src/locale/src/nl.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 of 192.168.1.0/24 of 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Bijv. \"Thuis\" of \"Kantoor\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Voldoe aan elke"
 	},

frontend/src/locale/src/no.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 eller 192.168.1.0/24 eller 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "F.eks. \"Hjem\" eller \"Kontor\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Oppfyll en av kravene"
 	},

frontend/src/locale/src/pl.json

@@ -23,6 +23,12 @@
 	"access-list.public.subtitle": {
 		"defaultMessage": "Nie wymaga uwierzytelnienia podstawowego"
 	},
+	"access-list.rule-source.placeholder": {
+		"defaultMessage": "192.168.1.100 lub 192.168.1.0/24 lub 2001:0db8::/32"
+	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Np. „Dom” lub „Biuro”"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Spełnij dowolny warunek"
 	},

frontend/src/locale/src/pt.json

@@ -26,6 +26,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 ou 192.168.1.0/24 ou 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Por ex., \"Casa\" ou \"Escritório\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Satisfazer Qualquer"
 	},

frontend/src/locale/src/ru.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 или 192.168.1.0/24 или 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Напр. «Дом» или «Офис»"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Любое совпадение"
 	},

frontend/src/locale/src/sk.json

@@ -83,6 +83,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 alebo 192.168.1.0/24 alebo 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Napr. „Domov“ alebo „Kancelária“"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Splniť ktorékoľvek"
 	},

frontend/src/locale/src/tr.json

@@ -26,6 +26,9 @@
 	"access-list.rule-source.placeholder": {
 		"defaultMessage": "192.168.1.100 veya 192.168.1.0/24 veya 2001:0db8::/32"
 	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Örn. \"Ev\" veya \"Ofis\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Herhangi Birini Karşıla"
 	},

frontend/src/locale/src/vi.json

@@ -23,6 +23,12 @@
 	"access-list.public.subtitle": {
 		"defaultMessage": "Không cần xác thực cơ bản"
 	},
+	"access-list.rule-source.placeholder": {
+		"defaultMessage": "192.168.1.100 hoặc 192.168.1.0/24 hoặc 2001:0db8::/32"
+	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "Ví dụ: \"Nhà\" hoặc \"Văn phòng\""
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "Thỏa mãn điều kiện bất kỳ"
 	},

frontend/src/locale/src/zh.json

@@ -23,6 +23,12 @@
 	"access-list.public.subtitle": {
 		"defaultMessage": "无需基本认证"
 	},
+	"access-list.rule-source.placeholder": {
+		"defaultMessage": "192.168.1.100 或 192.168.1.0/24 或 2001:0db8::/32"
+	},
+	"access-list.rule-source.placeholder-note": {
+		"defaultMessage": "例如：“家庭”或“办公室”"
+	},
 	"access-list.satisfy-any": {
 		"defaultMessage": "满足任意条件"
 	},