chore: rework api endpoints

src/config.ini

@@ -19,19 +19,19 @@ wgdashboard_refresh_interval = 60000
 wgdashboard_peer_list_display = grid
 wgdashboard_sort = status
 wgdashboard_theme = dark
-wgdashboard_apikey = True
+wgdashboard_apikey = true
 wgdashboard_language = en-US
 log_level = DEBUG
 
 [account]
-username = dselen
+username = admin
-password = $2b$12$0dvZY7mNbEcjfJI09AqxbeKYhBwoNwBrD4OQNhlJ3HqXoAbZmhNFq
+password = $2b$12$1VN62Q7CS/BJcAahHAWsA.3CD6zPqWTmE/HN/AJqwP0zds2l25Fqe
-enable_totp = False
+enable_totp = false
-totp_verified = False
+totp_verified = false
-totp_key = ON75CRNI7MGTA33PTHTQEZVXB5JKCEYK
+totp_key = ZSI2Z4QHSGVAK6TFVMZXORFDWKHDN4TQ
 
 [other]
-welcome_session = False
+welcome_session = false
 
 [database]
 type = sqlite
@@ -46,19 +46,18 @@ port =
 encryption =
 username =
 email_password =
-authentication_required = True
+authentication_required = true
 send_from =
 email_template =
 
 [oidc]
-admin_enable = False
+admin_enable = false
-client_enable = False
+client_enable = false
 
 [clients]
-enable = True
+enable = true
-sign_up = True
+sign_up = true
 
 [wireguardconfiguration]
 autostart =
-peer_tracking = False
+peer_tracking = false
-

src/modules/routes/README.md

@@ -16,7 +16,8 @@
 
 | Endpoint                                    | Method                        | File                         |
 | ------------------------------------------- | ----------------------------- | ---------------------------- |
-| `/api/dashboard/locale`                     | `GET`                         | `routes.py`                  |
+| `/api/dashboard/locale`                     | `GET` & `PATCH`               | `routes.py`                  |
+| `/api/dashboard/locale/available`           | `GET`                         | `routes.py`                  | 
 | `/api/dashboard/version`                    | `GET`                         | `routes.py`                  |
 | `/api/dashboard/theme`                      | `GET`                         | `routes.py`                  |
 | `/api/dashboard/update`                     | `GET`                         | `routes.py`                  |
@@ -30,6 +31,6 @@
 
 | Endpoint                                    | Method                        | File                         |
 | ------------------------------------------- | ----------------------------- | ---------------------------- |
-| `/api/dashboard/Wireguard/Interface`        | `GET`                         | `routes.py`                  |
+| `/api/dashboard/wireguard/interfaces`       | `GET`                         | `routes.py`                  |
 
 ## Uninplemented routes:

src/modules/routes/locale.py

@@ -40,11 +40,26 @@ class localeman:
                 return json.load(lang_file)
         return None
 
-#    def update_language(self, lang_id):
+    def get_available_languages():
-#        path = os.path.join(self.locale_path, f"{lang_id}.json")
+        available_languages_path = "./static/locales/supported_locales.json"
-#
+
-#        if not os.path.isfile(path):
+        with open(os.path.join(available_languages_path), "r") as f:
-#            lang_id = "en"
+            language_data = json.load(f)
-#
+
-#        util.set_config(self.wgd_config, "Server", "dashboard_language", lang_id)
+        available_languages = sorted(language_data, key=lambda x: x['lang_name'])
-#        return self.get_language()
+
+        return available_languages
+
+    def update_language(self, lang_id) -> bool:
+        path = os.path.join(self.locale_path, f"{lang_id}.json")
+
+        if not os.path.isfile(path):
+            lang_id = "en"
+
+        config.update("SERVER", "wgdashboard_language", lang_id)
+        # Very important to also refresh the config in-memory
+        ok, flask.current_app.wgd_config = config.read()
+        if not ok:
+            log.error("failed to refresh the in-memory configuration")
+            return make_resp_obj(False, 'Internal error', {}, 500)
+        return self.get_language()

src/modules/routes/routes.py

@@ -23,10 +23,18 @@ from ..utilities.statistics import statistics
 routes = flask.Blueprint("routes", __name__)
 
 white_list = [
-    "/", "/client", "/static/", "/fileDownload",
+    "/",
-    "/api/authenticate", "/api/locale", "getDashboardConfiguration",
+    "/favicon.ico",
-    "getDashboardTheme", "getDashboardVersion", "sharePeer/get",
+    "/client",
-    "isTotpEnabled", "validateAuthentication", "favicon.ico",
+    "/static/",
+    "/api/auth",
+    "/api/auth/validate",
+    "/api/dashboard/locale",
+    "/api/dashboard/configuration",
+    "/api/dashboard/theme",
+    "/api/dashboard/version",
+    "/api/dashboard/totp",
+    "sharePeer/get",
 ]
 
 @routes.before_request
@@ -185,14 +193,35 @@ def api_validate_auth():
     return make_resp_obj()
 
 @routes.route('/api/dashboard/locale', methods=["GET"])
-def api_locale_handler():
+def api_retrieve_locale():
     locale_manager = localeman()
     locale_data = locale_manager.get_language()
 
     return make_resp_obj(True, "", locale_data, 200)
 
+@routes.route('/api/dashboard/locale', methods=["PATCH"])
+def api_locale_update():
+    req_data = flask.request.get_json()
+    if "lang_id" not in req_data.keys():
+        return make_resp_obj(False, "Please specify a language id: lang_id")
+
+    language_id = req_data.get("lang_id")
+
+    locale_manager = localeman
+    ok = locale_manager.update_language(language_id)
+    if not ok:
+        return make_resp_obj(False, "Failed to update the language id")
+    
+    locale_data = locale_manager.get_language()
+    return make_resp_obj(True, "", locale_data)
+
+@routes.route('/api/dashboard/locale/available', methods=["GET"])
+def api_retrieve_available_locales():
+    locale_manager = localeman()
+
+
 @routes.route('/api/dashboard/version', methods=["GET"])
-def api_retrieve_dashboard_version():
+def api_retrieve_version():
     ok, config_server = config.filter(flask.current_app.wgd_config, 'SERVER')
     if not ok:
         log.error("failed to filter the config in-memory")
@@ -201,7 +230,7 @@ def api_retrieve_dashboard_version():
     return make_resp_obj(True, "", config_server.get("version"))
 
 @routes.route('/api/dashboard/theme', methods=["GET"])
-def api_retrieve_dashboard_theme():
+def api_retrieve_theme():
     ok, config_server = config.filter(flask.current_app.wgd_config, 'SERVER')
     if not ok:
         log.error("failed to filter the config in-memory")
@@ -209,16 +238,16 @@ def api_retrieve_dashboard_theme():
 
     return make_resp_obj(True, "", config_server.get("wgdashboard_theme"), 200)
 
-@routes.route('/api/dashboard/update', methods=["GET"])
+@routes.route('/api/dashboard/updatestatus', methods=["GET"])
-def api_retrieve_dashboard_update():
+def api_retrieve_update_status():
     utilities.update_available()
     return make_resp_obj()
 
 @routes.route('/api/dashboard/configuration', methods=["GET"])
-def api_retrieve_dashboard_config():
+def api_retrieve_config():
     return make_resp_obj(data=flask.current_app.wgd_config)
 
-@routes.route('/api/dashboard/totpenabled')
+@routes.route('/api/dashboard/totp', methods=["GET"])
 def api_totp_status():
     ok, config_account = config.filter(flask.current_app.wgd_config, 'ACCOUNT')
     if not ok:
@@ -229,7 +258,7 @@ def api_totp_status():
     
     return make_resp_obj(True, "", data, 200)
 
-@routes.route('/api/getWireguardConfigurations')
+@routes.route('/api/dashboard/wireguard/interfaces', methods=["GET"])
 def api_retrieve_wireguard_configurations():
     ok, config_server = config.filter(flask.current_app.wgd_config, 'SERVER')
     if not ok:
@@ -248,7 +277,7 @@ def api_retrieve_wireguard_configurations():
     
     return make_resp_obj(True, 'Wireguard', {}, 200)
 
-@routes.route('/api/dashboard/statistics')
+@routes.route('/api/dashboard/statistics', methods=["GET"])
 def api_system_status():
     status = statistics()
     return make_resp_obj(True, "", status.to_json(), 200)

src/modules/routes/routes_welcome.py

@@ -57,7 +57,7 @@ def api_welcome_finish():
 
     return make_resp_obj()
 
-@routes_welcome.route('/api/welcome/totplink')
+@routes_welcome.route('/api/welcome/totplink', methods=["GET"])
 def api_welcome_get_totp():
     ok, config_account = config.filter(flask.current_app.wgd_config, 'ACCOUNT')
     if not ok:

src/modules/wireguard/wireguard.py

@@ -0,0 +1,5 @@
+#!/bin/env python3
+
+class wireguard():
+    def __init__():
+        print("triggered init")

src/modules/wireguard/wireguard_utils.py

@@ -1,2 +0,0 @@
-#!/bin/env python3
-

src/static/admin/src/App.vue

@@ -10,12 +10,12 @@ if (window.IS_WGDASHBOARD_DESKTOP){
 	store.IsElectronApp = true;
 	store.CrossServerConfiguration.Enable = true;
 	if (store.ActiveServerConfiguration){
-		fetchGet("/api/locale", {}, (res) => {
+		fetchGet("/api/dashboard/locale", {}, (res) => {
 			store.Locale = res.data
 		})
 	}
 }else{
-	fetchGet("/api/locale", {}, (res) => {
+	fetchGet("/api/dashboard/locale", {}, (res) => {
 		store.Locale = res.data
 	})
 }

src/static/admin/src/components/settingsComponent/dashboardLanguage.vue

@@ -16,22 +16,28 @@ export default {
 		}
 	},
 	mounted() {
-		fetchGet("/api/locale/available", {}, (res) => {
+		fetchGet("/api/dashboard/locale/available", {}, (res) => {
 			this.languages = res.data;
 		})
 	},
 	methods: {
 		changeLanguage(lang_id){
-			fetchPost("/api/locale/update", {
+			fetch("/api/dashboard/locale", {
-				lang_id: lang_id
+				method: "PATCH",
-			}, (res) => {
+				headers: {
+					"Content-Type": "application/json",
+				},
+				body: JSON.stringify({ lang_id: lang_id }),
+			})
+			.then(res => res.json())
+			.then(res => {
 				if (res.status){
 					this.store.Configuration.server.wgdashboard_language = lang_id;
-					this.store.Locale = res.data
+					this.store.Locale = res.data;
 				} else {
-					this.store.newMessage("Server", "WGDashboard language update failed", "danger")
+					this.store.newMessage("Server", "WGDashboard failed to update the language", "danger")
 				}
-			})
+			});
 		}
 	},
 	computed:{

src/static/admin/src/components/signInComponents/RemoteServer.vue

@@ -56,7 +56,7 @@ export default {
 			}
 		},
 		async connect(){
-			await fetch(`${this.server.host}/api/authenticate`, {
+			await fetch(`${this.server.host}/api/auth`, {
 				headers:  this.getHeaders,
 				body: JSON.stringify({
 					host: window.location.hostname

src/static/admin/src/models/WireguardConfigurations.js

@@ -11,7 +11,7 @@ export class WireguardConfigurations{
 	
 
 	async getConfigurations(){
-		await fetchGet("/api/getWireguardConfigurations", {}, (res) => {
+		await fetchGet("/api/dashboard/wireguard/interfaces", {}, (res) => {
 			if (res.status)  this.Configurations = res.data
 		});
 	}

src/static/admin/src/router/router.js

@@ -5,7 +5,7 @@ import {DashboardConfigurationStore} from "@/stores/DashboardConfigurationStore.
 
 const checkAuth = async () => {
 	let result = false
-	await fetchGet("/api/validateAuthentication", {}, (res) => {
+	await fetchGet("/api/auth/validate", {}, (res) => {
 		result = res.status
 	});
 	return result;

src/static/admin/src/stores/DashboardConfigurationStore.js

@@ -60,7 +60,7 @@ export const DashboardConfigurationStore = defineStore('DashboardConfigurationSt
 		async setActiveCrossServer(key){
 			this.ActiveServerConfiguration = key;
 			localStorage.setItem('ActiveCrossServerConfiguration', key)
-			await fetchGet("/api/locale", {}, (res) => {
+			await fetchGet("/api/dashboard/locale", {}, (res) => {
 				this.Locale = res.data
 			})
 		},

src/static/admin/src/stores/WireguardConfigurationsStore.js

@@ -101,7 +101,7 @@ export const WireguardConfigurationsStore = defineStore('WireguardConfigurations
     },
 	actions: {
 		async getConfigurations(){
-			await fetchGet("/api/getWireguardConfigurations", {}, (res) => {
+			await fetchGet("/api/dashboard/wireguard/interfaces", {}, (res) => {
 				if (res.status)  {
                     this.Configurations = res.data
                 }

src/static/admin/src/views/share.vue

@@ -16,7 +16,7 @@ export default {
 		const theme = ref("");
 		const peerConfiguration = ref(undefined);
 		const blob = ref(new Blob())
-		await fetchGet("/api/getDashboardTheme", {}, (res) => {
+		await fetchGet("/api/dashboard/theme", {}, (res) => {
 			theme.value = res.data
 		});
 		

src/static/admin/src/views/signin.vue

@@ -18,13 +18,13 @@ export default {
 		let version = undefined;
 		if (!store.IsElectronApp){
 			await Promise.all([
-				fetchGet("/api/getDashboardTheme", {}, (res) => {
+				fetchGet("/api/dashboard/theme", {}, (res) => {
 					theme = res.data
 				}),
-				fetchGet("/api/isTotpEnabled", {}, (res) => {
+				fetchGet("/api/dashboard/totp", {}, (res) => {
 					totpEnabled = res.data
 				}),
-				fetchGet("/api/getDashboardVersion", {}, (res) => {
+				fetchGet("/api/dashboard/version", {}, (res) => {
 					version = res.data
 				})
 			]);
@@ -60,7 +60,7 @@ export default {
 		async auth(){
 			if (this.formValid){
 				this.loading = true
-				await fetchPost("/api/authenticate", this.data, (response) => {
+				await fetchPost("/api/auth", this.data, (response) => {
 					if (response.status){
 						this.loginError = false;
 						this.$refs["signInBtn"].classList.add("signedIn")

src/static/client/src/router/router.js

@@ -64,7 +64,7 @@ router.beforeEach(async (to, from, next) => {
 		store.newNotification("Sign in session ended, please sign in again", "warning")
 	}else{
 		if (to.meta.auth){
-			const status = await axiosGet('/api/validateAuthentication')
+			const status = await axiosGet('/api/auth/validate')
 			if (status){
 				next()
 			}else{