espe/backend
0
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

Compare commits

base: espe:1ad4f447934c79b52f3769258118ce0a1a49b284
Branches Tags
espe:main
espe:task-193-temp
espe:task-193
..
compare: espe:d4fdebceca6b287897f61eeba6d46ac69540c9cc
Branches Tags
espe:task-193-temp
espe:task-193
espe:main

No commits in common. "1ad4f447934c79b52f3769258118ce0a1a49b284" and "d4fdebceca6b287897f61eeba6d46ac69540c9cc" have entirely different histories.
1ad4f44793 ... d4fdebceca

10 changed files with 90 additions and 372 deletions
Show stats Expand all files Collapse all files

4
misc/conf.example.json
View file

@ -26,7 +26,7 @@
"database": {
"kind": "sqlite",
"data": {
"path": "../espe.sqlite"
"path": "data.sqlite"
}
},
"email_sending": {
@ -67,7 +67,7 @@
"salt": null
},
"connections": {
"frontend_url_base": "http://localhost:8888",
"frontend_url_base": null,
"login_url": null
}
},

179
source/api/actions/invite_create.ts
View file

@ -24,19 +24,16 @@ namespace _espe.api
{
lib_plankton.rest_http.register<
{
data : {
membership_number_changeable : boolean;
membership_number_value : (null | string);
name_changeable : boolean;
name_value : string;
email_address_changeable : boolean;
email_address_value : (null | string);
groups_changeable : boolean;
groups_value : Array<string>;
expiry : (null | int);
};
notification_target_url_template ?: (null | string);
send_immediatly : boolean;
membership_number_changeable : boolean;
membership_number_value : (null | string);
name_changeable : boolean;
name_value : string;
email_address_changeable : boolean;
email_address_value : (null | string);
groups_changeable : boolean;
groups_value : Array<string>;
expiry ?: (null | int);
// notification_target_url_template ?: (null | string);
},
(
string
@ -60,87 +57,73 @@ namespace _espe.api
"nullable": false,
"additionalProperties": false,
"properties": {
"data": {
"membership_number_changeable": {
"type": "boolean",
"nullable": false,
"type": "object",
"additionalProperties": false,
"properties": {
"expiry": {
"nullable": true,
"type": "intiger",
"description": "Ablaufzeitpunkt"
},
"membership_number_changeable": {
"type": "boolean",
"nullable": false,
"description": "Mitgliedsnummer | änderbar"
},
"membership_number_value": {
"type": "string",
"nullable": true,
"description": "Mitgliedsnummer | Wert"
},
"name_changeable": {
"type": "boolean",
"nullable": false,
"description": "Name | änderbar"
},
"name_value": {
"type": "string",
"nullable": true,
"description": "Name | Wert"
},
"email_address_changeable": {
"type": "boolean",
"nullable": false,
"description": "E-Mail-Adresse | änderbar"
},
"email_address_value": {
"type": "string",
"nullable": true,
"description": "E-Mail-Adresse | Wert"
},
"groups_integer": {
"type": "integer",
"nullable": true,
"description": "Gruppen | Modus"
},
"groups_value": {
"nullable": false,
"type": "array",
"items": {
"type": "string",
"nullable": false,
},
"description": "Gruppen | Wert"
},
},
"required": [
"membership_number_changeable",
"membership_number_value",
"name_changeable",
"name_value",
"email_address_changeable",
"email_address_value",
"groups_changeable",
"groups_value",
"expiry",
]
"description": "Mitgliedsnummer | änderbar"
},
"membership_number_value": {
"type": "string",
"nullable": true,
"description": "Mitgliedsnummer | Wert"
},
"name_changeable": {
"type": "boolean",
"nullable": false,
"description": "Name | änderbar"
},
"name_value": {
"type": "string",
"nullable": true,
"description": "Name | Wert"
},
"email_address_changeable": {
"type": "boolean",
"nullable": false,
"description": "E-Mail-Adresse | änderbar"
},
"email_address_value": {
"type": "string",
"nullable": true,
"description": "E-Mail-Adresse | Wert"
},
"groups_integer": {
"type": "integer",
"nullable": true,
"description": "Gruppen | Modus"
},
"groups_value": {
"nullable": false,
"type": "array",
"items": {
"type": "string",
"nullable": false,
},
"description": "Gruppen | Wert"
},
"expiry": {
"nullable": true,
"type": "intiger",
"description": "Ablaufzeitpunkt"
},
/*
"notification_target_url_template": {
"type": "string",
"nullable": true,
"description": "Platz-Halter: key"
},
"send_immediatly": {
"nullable": false,
"type": "boolean",
"description": "Einladungs-Link direkt an angegebene E-Mail-Adresse versenden"
"description": "Platz-Halter: id"
},
*/
},
"required": [
"data",
"send_immediatly",
"membership_number_changeable",
"membership_number_value",
"name_changeable",
"name_value",
"email_address_changeable",
"email_address_value",
"groups_changeable",
"groups_value",
"expiry",
]
}),
"output_schema": () => ({
@ -172,9 +155,9 @@ namespace _espe.api
(! _espe.conf.get().settings.misc.facultative_membership_number)
&&
(
(input.data.membership_number_value === null)
(input.membership_number_value === null)
||
(input.data.membership_number_value === "")
(input.membership_number_value === "")
)
) {
return Promise.resolve({
@ -185,19 +168,17 @@ namespace _espe.api
else {
const invite_info : {id : _espe.type.invite_id; key : _espe.type.invite_key;} = await _espe.service.invite.create(
{
"membership_number_changeable": input.data.membership_number_changeable,
"membership_number_value": input.data.membership_number_value,
"name_changeable": input.data.name_changeable,
"name_value": input.data.name_value,
"email_address_changeable": input.data.email_address_changeable,
"email_address_value": input.data.email_address_value,
"groups_changeable": input.data.groups_changeable,
"groups_value": input.data.groups_value,
"membership_number_changeable": input.membership_number_changeable,
"membership_number_value": input.membership_number_value,
"name_changeable": input.name_changeable,
"name_value": input.name_value,
"email_address_changeable": input.email_address_changeable,
"email_address_value": input.email_address_value,
"groups_changeable": input.groups_changeable,
"groups_value": input.groups_value,
},
{
"expiry": input.data.expiry,
"notification_target_url_template": input.notification_target_url_template,
"send_immediatly": input.send_immediatly,
"expiry": input.expiry,
}
);
return Promise.resolve({

160
source/api/actions/invite_read.ts
View file

@ -1,160 +0,0 @@
/*
Espe | Ein schlichtes Werkzeug zur Mitglieder-Verwaltung | Backend
Copyright (C) 2024 Christian Fraß
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see
<https://www.gnu.org/licenses/>.
*/
namespace _espe.api
{
/**
*/
export function register_invite_read(
rest_subject : lib_plankton.rest_http.type_rest
) : void
{
lib_plankton.rest_http.register<
int,
(
string
|
{
key : string;
expiry : (null | int);
membership_number_changeable : boolean;
membership_number_value : (null | string);
name_changeable : boolean;
name_value : string;
email_address_changeable : boolean;
email_address_value : (null | string);
groups_changeable : boolean;
groups_value : Array<string>;
}
)
>(
rest_subject,
lib_plankton.http.enum_method.get,
_espe.api.full_path("/invite/read"),
{
/**
* @todo translation
*/
"description": () => "gibt die Daten einer Einladung anhand ihrer ID aus",
"query_parameters": () => [
{
"name": "id",
"required": true,
"description": "id",
}
],
"output_schema": () => ({
"type": "object",
"nullable": false,
"additionalProperties": false,
"properties": {
"expiry": {
"nullable": true,
"type": "integer",
"description": "Ablaufzeitpunkt"
},
"membership_number_changeable": {
"type": "boolean",
"nullable": false,
"description": "Mitgliedsnummer | änderbar"
},
"membership_number_value": {
"type": "string",
"nullable": true,
"description": "Mitgliedsnummer | Wert"
},
"name_changeable": {
"type": "boolean",
"nullable": false,
"description": "Name | änderbar"
},
"name_value": {
"type": "string",
"nullable": true,
"description": "Name | Wert"
},
"email_address_changeable": {
"type": "boolean",
"nullable": false,
"description": "E-Mail-Adresse | änderbar"
},
"email_address_value": {
"type": "string",
"nullable": true,
"description": "E-Mail-Adresse | Wert"
},
"groups_changeable": {
"type": "boolean",
"nullable": false,
"description": "Gruppen | änderbar"
},
"groups_value": {
"nullable": false,
"type": "array",
"items": {
"type": "string",
"nullable": false,
},
"description": "Gruppen | Wert"
},
},
"required": [
"expiry",
"membership_number_mode",
"membership_number_value",
"name_mode",
"name_value",
"email_address_mode",
"email_address_value",
"groups_mode",
"groups_value",
]
}),
"restriction": () => restriction_logged_in,
"execution": () => ({"query_parameters": query_parameters, "input": input}) => {
const invite_id : _espe.type.invite_id = parseInt(query_parameters["id"]);
return (
_espe.service.invite.get_by_id(invite_id)
.then(
(invite_object) => Promise.resolve({
"status_code": 200,
"data": {
"key": invite_object.key,
"expiry": invite_object.expiry,
"membership_number_changeable": invite_object.membership_number_changeable,
"membership_number_value": invite_object.membership_number_value,
"name_changeable": invite_object.name_changeable,
"name_value": invite_object.name_value,
"email_address_changeable": invite_object.email_address_changeable,
"email_address_value": invite_object.email_address_value,
"groups_changeable": invite_object.groups_changeable,
"groups_value": invite_object.groups_value,
}
})
)
.catch(
(error) => Promise.resolve({
"status_code": 404,
"data": "not found"
})
)
);
}
}
);
}
}

1
source/api/functions.ts
View file

@ -62,7 +62,6 @@ namespace _espe.api
// invite
{
_espe.api.register_invite_list(rest_subject);
_espe.api.register_invite_read(rest_subject);
_espe.api.register_invite_create(rest_subject);
_espe.api.register_invite_examine(rest_subject);
_espe.api.register_invite_accept(rest_subject);

2
source/data/localization/deu.loc.json
View file

@ -14,8 +14,6 @@
"email.password_change.initialization.body": "Hi, {{name}}\n\nDie Funktion zum Ändern deines Passwortes wurde aufgerufen. Wenn du dein Passwort ändern willst, rufe folgenden Link auf:\n\n{{url}}\n",
"email.password_change.execution.subject": "Passwort-Änderung abgeschlossen",
"email.password_change.execution.body": "Hi, {{name}}\n\nDein Passwort wurde soeben geändert.\n",
"email.invitation.subject": "Einladung",
"email.invitation.body": "{{url}}",
"help.args.action.description": "auszuführende Aktion; Auswahl",
"help.args.action.options.serve": "Server starten",
"help.args.action.options.api_doc": "API-Dokumentation gemäß OpenAPI-Spezifikation auf Standard-Ausgabe schreiben",

2
source/data/localization/eng.loc.json
View file

@ -14,8 +14,6 @@
"email.password_change.initialization.body": "Hi, {{name}}\n\nThe function for changing your password has been triggered. If you want to change your password, open the folloling link:\n\n{{url}}",
"email.password_change.execution.subject": "Password change concluded",
"email.password_change.execution.body": "Hi, {{name}}\n\nYour password has just been changed.\n",
"email.invitation.subject": "invitation",
"email.invitation.body": "{{url}}",
"help.args.action.description": "action to executo; options",
"help.args.action.options.serve": "start server",
"help.args.action.options.api_doc": "write API documentation according to OpenAPI specification to stdout",

2
source/helpers.ts
View file

@ -22,7 +22,7 @@ namespace _espe.helpers
value : boolean
) : int
{
return (value ? 1 : 0);
return (value ? 0 : 1);
}

87
source/services/invite.ts
View file

@ -72,12 +72,8 @@ namespace _espe.service.invite
},
{
"expiry": expiry = -1,
"notification_target_url_template": notification_target_url_template = null,
"send_immediatly": send_immediatly = true,
} : {
expiry ?: (null | int);
notification_target_url_template ?: (null | string);
send_immediatly ?: boolean;
} = {
}
) : Promise<{id : _espe.type.invite_id; key : _espe.type.invite_key}>
@ -118,75 +114,6 @@ namespace _espe.service.invite
"groups_value": groups_value,
};
const invite_id : _espe.type.invite_id = await _espe.repository.invite.create(invite_object);
// send link
{
if (! send_immediatly)
{
// do nothing
}
else
{
if (
! (
(
(email_address_value !== null)
&&
(email_address_value !== "")
)
&&
(notification_target_url_template !== null)
)
)
{
lib_plankton.log._warning(
"espe.service.invite.create.email.condition_unmet",
{
"details": {
"provided_address": email_address_value,
"notification_target_url_template": notification_target_url_template,
},
}
);
}
else
{
const url : (null | string) = _espe.helpers.frontend_url_get(
notification_target_url_template,
{
"key": invite_key,
}
);
try {
await _espe.helpers.email_send(
[email_address_value],
lib_plankton.translate.get(
"email.invitation.subject",
{
}
),
lib_plankton.translate.get(
"email.invitation.body",
{
"url": (url ?? "?"),
}
),
);
}
catch (error)
{
lib_plankton.log._error(
"espe.service.invite.create.email.could_not_be_sent",
{
"details": {
"provided_address": email_address_value,
"error": String(error),
},
}
);
}
}
}
}
return {
"id": invite_id,
"key": invite_key,
@ -196,17 +123,7 @@ namespace _espe.service.invite
/**
*/
export function get_by_id(
id : _espe.type.invite_id
) : Promise<_espe.type.invite_object>
{
return _espe.repository.invite.read(id)
}
/**
*/
function get_by_key(
function get(
key : _espe.type.invite_key
) : Promise<_espe.type.invite_object>
{
@ -227,7 +144,7 @@ namespace _espe.service.invite
{
let invite_object : (null | _espe.type.invite_object);
try {
invite_object = await get_by_key(key);
invite_object = await get(key);
}
catch (error) {
invite_object = null;

24
tools/build
View file

@ -15,21 +15,12 @@
import sys as _sys
import os as _os
import shutil as _shutil
import argparse as _argparse
def main():
## args
argument_parser = _argparse.ArgumentParser()
argument_parser.add_argument(
"-o",
"--output-directory",
type = str,
default = "/tmp/espe",
metavar = "<output-directory>",
help = "output directory",
)
argument_parser.add_argument(
"-t",
"--tests",
@ -38,12 +29,12 @@ def main():
help = "whether to also build the test routines",
)
argument_parser.add_argument(
"-c",
"--conf-path",
"-o",
"--output-directory",
type = str,
default = "",
metavar = "<conf-path>",
help = "path to conf file to be put",
default = "/tmp/espe",
metavar = "<output-directory>",
help = "output directory",
)
args = argument_parser.parse_args()
@ -59,11 +50,6 @@ def main():
" ".join(targets),
)
)
if (args.conf_path != ""):
_shutil.copyfile(
args.conf_path,
_os.path.join(args.output_directory, "conf.json")
)
_sys.stdout.write("%s\n" % args.output_directory)

1
tools/makefile
View file

@ -72,7 +72,6 @@ ${dir_temp}/espe-core.js ${dir_temp}/espe-core.d.ts: \
${dir_source}/api/actions/member_password_change_initialize.ts \
${dir_source}/api/actions/member_password_change_execute.ts \
${dir_source}/api/actions/invite_list.ts \
${dir_source}/api/actions/invite_read.ts \
${dir_source}/api/actions/invite_create.ts \
${dir_source}/api/actions/invite_examine.ts \
${dir_source}/api/actions/invite_accept.ts \