[ini]
This commit is contained in:
commit
859d3247d4
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
/build/
|
||||||
|
/temp/
|
||||||
|
/.geany
|
||||||
25
data/localization/deu.json
Normal file
25
data/localization/deu.json
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
{
|
||||||
|
"meta": {
|
||||||
|
"identifier": "deu",
|
||||||
|
"name": "Deutsch"
|
||||||
|
},
|
||||||
|
"tree": {
|
||||||
|
"core.event.event": "Termin",
|
||||||
|
"core.event.events": "Termine",
|
||||||
|
"core.event.title.long": "Titel",
|
||||||
|
"core.event.title.short": "was",
|
||||||
|
"core.event.time.long": "Datum und Uhrzeit",
|
||||||
|
"core.event.time.short": "wann",
|
||||||
|
"core.event.location.long": "Ort",
|
||||||
|
"core.event.location.short": "wo",
|
||||||
|
"core.reminder.reminder": "Erinnerung",
|
||||||
|
"args.action.description": "auszuführende Aktion",
|
||||||
|
"args.conf_path.description": "Pfad zur Konfigurations-Datei",
|
||||||
|
"args.conf_schema.description": "nur das Konfigurations-Schema ausgeben",
|
||||||
|
"args.conf_expose.description": "die vervollständigte Konfiguration ausgeben",
|
||||||
|
"args.single_run.description": "nur einen Durchlauf ausführen",
|
||||||
|
"args.dry_run.description": "das Senden von Benachrichtigungen überspringen",
|
||||||
|
"args.help.description": "nur die Hilfe-Seite anzeigen",
|
||||||
|
"help.description": "sendet Erinnerungen zu anstehenden Terminen"
|
||||||
|
}
|
||||||
|
}
|
||||||
25
data/localization/eng.json
Normal file
25
data/localization/eng.json
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
{
|
||||||
|
"meta": {
|
||||||
|
"identifier": "eng",
|
||||||
|
"name": "English"
|
||||||
|
},
|
||||||
|
"tree": {
|
||||||
|
"core.event.event": "event",
|
||||||
|
"core.event.events": "events",
|
||||||
|
"core.event.title.long": "title",
|
||||||
|
"core.event.title.short": "what",
|
||||||
|
"core.event.time.long": "date and time",
|
||||||
|
"core.event.time.short": "when",
|
||||||
|
"core.event.location.long": "location",
|
||||||
|
"core.event.location.short": "where",
|
||||||
|
"core.reminder.reminder": "reminder",
|
||||||
|
"args.action.description": "what to do",
|
||||||
|
"args.conf_path.description": "path to configuration file",
|
||||||
|
"args.conf_schema.description": "only print the configuration schema",
|
||||||
|
"args.conf_expose.description": "whether to expose the full configuration",
|
||||||
|
"args.single_run.description": "whether to only execute one iteration at run",
|
||||||
|
"args.dry_run.description": "whether to skip the sending of reminders (logs will be written)",
|
||||||
|
"args.help.description": "only print the help page",
|
||||||
|
"help.description": "sends reminders about upcoming events"
|
||||||
|
}
|
||||||
|
}
|
||||||
218
data/test/reminder_check.testdata.json
Normal file
218
data/test/reminder_check.testdata.json
Normal file
|
|
@ -0,0 +1,218 @@
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "reminder_check.dueness-1",
|
||||||
|
"input": {
|
||||||
|
"reminder": {
|
||||||
|
"frequency": "daily",
|
||||||
|
"offset": 16,
|
||||||
|
"from": 24,
|
||||||
|
"to": 48
|
||||||
|
},
|
||||||
|
"events": [
|
||||||
|
],
|
||||||
|
"datetime": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 27
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 15,
|
||||||
|
"minute": 30,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"interval": 1
|
||||||
|
},
|
||||||
|
"output": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "reminder_check.dueness-2",
|
||||||
|
"input": {
|
||||||
|
"reminder": {
|
||||||
|
"frequency": "daily",
|
||||||
|
"offset": 16,
|
||||||
|
"from": 24,
|
||||||
|
"to": 48
|
||||||
|
},
|
||||||
|
"events": [
|
||||||
|
],
|
||||||
|
"datetime": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 27
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 16,
|
||||||
|
"minute": 30,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"interval": 1
|
||||||
|
},
|
||||||
|
"output": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "reminder_check.dueness-3",
|
||||||
|
"input": {
|
||||||
|
"reminder": {
|
||||||
|
"frequency": "daily",
|
||||||
|
"offset": 16,
|
||||||
|
"from": 24,
|
||||||
|
"to": 48
|
||||||
|
},
|
||||||
|
"events": [
|
||||||
|
],
|
||||||
|
"datetime": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 27
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 17,
|
||||||
|
"minute": 30,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"interval": 1
|
||||||
|
},
|
||||||
|
"output": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "reminder_check.events-1",
|
||||||
|
"input": {
|
||||||
|
"reminder": {
|
||||||
|
"frequency": "daily",
|
||||||
|
"offset": 16,
|
||||||
|
"from": 24,
|
||||||
|
"to": 48
|
||||||
|
},
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"title": "e1",
|
||||||
|
"begin": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 27
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 12,
|
||||||
|
"minute": 0,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"datetime": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 27
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 16,
|
||||||
|
"minute": 30,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"interval": 1
|
||||||
|
},
|
||||||
|
"output": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "reminder_check.events-2",
|
||||||
|
"input": {
|
||||||
|
"reminder": {
|
||||||
|
"frequency": "daily",
|
||||||
|
"offset": 16,
|
||||||
|
"from": 24,
|
||||||
|
"to": 48
|
||||||
|
},
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"title": "e1",
|
||||||
|
"begin": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 28
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 12,
|
||||||
|
"minute": 0,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"datetime": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 27
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 16,
|
||||||
|
"minute": 30,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"interval": 1
|
||||||
|
},
|
||||||
|
"output": ["e1"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "reminder_check.events-3",
|
||||||
|
"input": {
|
||||||
|
"reminder": {
|
||||||
|
"frequency": "daily",
|
||||||
|
"offset": 16,
|
||||||
|
"from": 24,
|
||||||
|
"to": 48
|
||||||
|
},
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"title": "e1",
|
||||||
|
"begin": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 29
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 12,
|
||||||
|
"minute": 0,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"datetime": {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": {
|
||||||
|
"year": 2025,
|
||||||
|
"month": 6,
|
||||||
|
"day": 27
|
||||||
|
},
|
||||||
|
"time": {
|
||||||
|
"hour": 16,
|
||||||
|
"minute": 30,
|
||||||
|
"second": 0
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"interval": 1
|
||||||
|
},
|
||||||
|
"output": []
|
||||||
|
}
|
||||||
|
]
|
||||||
39
ivaldi.json
Normal file
39
ivaldi.json
Normal file
|
|
@ -0,0 +1,39 @@
|
||||||
|
{
|
||||||
|
"name": "munin",
|
||||||
|
"libs": [
|
||||||
|
{
|
||||||
|
"kind": "plankton",
|
||||||
|
"data": {
|
||||||
|
"modules": [
|
||||||
|
"pit",
|
||||||
|
"http",
|
||||||
|
"ical",
|
||||||
|
"string",
|
||||||
|
"email",
|
||||||
|
"telegram",
|
||||||
|
"url",
|
||||||
|
"json",
|
||||||
|
"file",
|
||||||
|
"conf",
|
||||||
|
"log",
|
||||||
|
"translate",
|
||||||
|
"args"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sources": [
|
||||||
|
"helpers/test.ts",
|
||||||
|
"types.ts",
|
||||||
|
"sources/ics_feed.ts",
|
||||||
|
"sources/_functions.ts",
|
||||||
|
"targets/telegram_bot.ts",
|
||||||
|
"targets/email.ts",
|
||||||
|
"targets/_functions.ts",
|
||||||
|
"conf.ts",
|
||||||
|
"logic.ts",
|
||||||
|
"test.ts",
|
||||||
|
"main.ts"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
3016
libs/plankton/plankton.d.ts
vendored
Normal file
3016
libs/plankton/plankton.d.ts
vendored
Normal file
File diff suppressed because it is too large
Load diff
9205
libs/plankton/plankton.js
Normal file
9205
libs/plankton/plankton.js
Normal file
File diff suppressed because it is too large
Load diff
674
licence.txt
Normal file
674
licence.txt
Normal file
|
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
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/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
29
misc/conf-example.mnn.json
Normal file
29
misc/conf-example.mnn.json
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
{
|
||||||
|
"version": "7",
|
||||||
|
"content": {
|
||||||
|
"sources": [
|
||||||
|
{
|
||||||
|
"kind": "ics_feed",
|
||||||
|
"data": {
|
||||||
|
"url": "https://www.kayaposoft.com/enrico/ics/v2.0?country=nor&fromDate=01-01-2025&toDate=31-12-2026®ion=&holidayType=public_holiday&lang=no"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"targets": [
|
||||||
|
{
|
||||||
|
"kind": "telegram_bot",
|
||||||
|
"data": {
|
||||||
|
"bot_token": "1592673480:ABCDe0-1FghijkLMNOpqRsTU1Vwx_TnEJqo",
|
||||||
|
"chat_id": 123456789,
|
||||||
|
"reminders": [
|
||||||
|
{
|
||||||
|
"frequency": "hourly",
|
||||||
|
"from": 0,
|
||||||
|
"to": 168
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
BIN
misc/screenshot-1.png
Normal file
BIN
misc/screenshot-1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
30
readme.md
Normal file
30
readme.md
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
# munin
|
||||||
|
|
||||||
|
sendet Termin-Erinnerungen anhand von Kalender-Daten
|
||||||
|
|
||||||
|
|
||||||
|
## Erstellung
|
||||||
|
|
||||||
|
### Erfordernisse
|
||||||
|
|
||||||
|
- GNU Make
|
||||||
|
- TypeScript Compiler
|
||||||
|
|
||||||
|
|
||||||
|
### Anweisungen
|
||||||
|
|
||||||
|
- `tools/build`
|
||||||
|
|
||||||
|
|
||||||
|
## Verwendung
|
||||||
|
|
||||||
|
### Erfordernisse
|
||||||
|
|
||||||
|
- NodeJS
|
||||||
|
|
||||||
|
|
||||||
|
### Anweisungen
|
||||||
|
|
||||||
|
siehe `munin -h`
|
||||||
|
|
||||||
|
|
||||||
552
source/conf.ts
Normal file
552
source/conf.ts
Normal file
|
|
@ -0,0 +1,552 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.conf
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
type type_reminder_raw = {
|
||||||
|
frequency : (
|
||||||
|
"hourly"
|
||||||
|
|
|
||||||
|
"daily"
|
||||||
|
|
|
||||||
|
"weekly"
|
||||||
|
|
|
||||||
|
"monthly"
|
||||||
|
);
|
||||||
|
offset : int;
|
||||||
|
from : int;
|
||||||
|
to : int;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo rename to "type_conf"
|
||||||
|
*/
|
||||||
|
type type_conf_v7 = {
|
||||||
|
sources : Array<
|
||||||
|
(
|
||||||
|
{
|
||||||
|
kind : "ics_feed";
|
||||||
|
data : {
|
||||||
|
url : string;
|
||||||
|
filtration : {
|
||||||
|
category_whitelist : (null | Array<string>);
|
||||||
|
category_blacklist : (null | Array<string>);
|
||||||
|
title_whitelist : (null | Array<string>);
|
||||||
|
title_blacklist : (null | Array<string>);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
>;
|
||||||
|
targets : Array<
|
||||||
|
(
|
||||||
|
{
|
||||||
|
kind : "email";
|
||||||
|
data : {
|
||||||
|
smtp_host : string;
|
||||||
|
smtp_port : int;
|
||||||
|
smtp_username : string;
|
||||||
|
smtp_password : string;
|
||||||
|
sender : string;
|
||||||
|
receivers : Array<string>;
|
||||||
|
hide_tags : boolean;
|
||||||
|
reminders : Array<type_reminder_raw>;
|
||||||
|
language : string;
|
||||||
|
strings : {
|
||||||
|
notification_head : string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
|
{
|
||||||
|
kind : "telegram_bot";
|
||||||
|
data : {
|
||||||
|
bot_token : string;
|
||||||
|
chat_id : int;
|
||||||
|
hide_tags : boolean;
|
||||||
|
reminders : Array<type_reminder_raw>;
|
||||||
|
language : string;
|
||||||
|
strings : {
|
||||||
|
notification_head : string;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
>;
|
||||||
|
settings : {
|
||||||
|
interval : float;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
const current_version : string = "7";
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo remove
|
||||||
|
*/
|
||||||
|
export type type_conf = type_conf_v7;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function schema_source_ics_feed(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"kind": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["ics_feed"]
|
||||||
|
},
|
||||||
|
"data": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"url": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"filtration": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"category_whitelist": {
|
||||||
|
"nullable": true,
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"default": null,
|
||||||
|
},
|
||||||
|
"category_blacklist": {
|
||||||
|
"nullable": true,
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"default": null,
|
||||||
|
},
|
||||||
|
"title_whitelist": {
|
||||||
|
"nullable": true,
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"default": null,
|
||||||
|
},
|
||||||
|
"title_blacklist": {
|
||||||
|
"nullable": true,
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"default": null,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
],
|
||||||
|
"default": {}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"url",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"kind",
|
||||||
|
"data",
|
||||||
|
]
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function schema_sources(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"nullable": false,
|
||||||
|
"anyOf": [
|
||||||
|
schema_source_ics_feed(),
|
||||||
|
],
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function schema_reminder(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"frequency": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"enum": [
|
||||||
|
"hourly",
|
||||||
|
"daily",
|
||||||
|
"weekly",
|
||||||
|
"monthly",
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"offset": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "integer",
|
||||||
|
"default": 0
|
||||||
|
},
|
||||||
|
"from": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"to": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"frequency",
|
||||||
|
"from",
|
||||||
|
"to",
|
||||||
|
]
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function default_reminder(
|
||||||
|
) : any
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
"frequency": "hourly",
|
||||||
|
"from": 24,
|
||||||
|
"to": 25
|
||||||
|
}
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function schema_target_email(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"kind": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["email"]
|
||||||
|
},
|
||||||
|
"data": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"smtp_host": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"smtp_port": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "integer",
|
||||||
|
},
|
||||||
|
"smtp_username": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"smtp_password": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"sender": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"default": "munin"
|
||||||
|
},
|
||||||
|
"receivers": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"hide_tags": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false,
|
||||||
|
},
|
||||||
|
"reminders": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "array",
|
||||||
|
"items": schema_reminder(),
|
||||||
|
"default": default_reminder(),
|
||||||
|
},
|
||||||
|
"language": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"default": "deu"
|
||||||
|
},
|
||||||
|
"strings": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"notification_head": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"default": "[{{core}}] {{extra}}"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
],
|
||||||
|
"default": {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"smtp_host",
|
||||||
|
"smtp_port",
|
||||||
|
"smtp_username",
|
||||||
|
"smtp_password",
|
||||||
|
"receivers",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"kind",
|
||||||
|
"data",
|
||||||
|
]
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function schema_target_telegram_bot(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"kind": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["telegram_bot"]
|
||||||
|
},
|
||||||
|
"data": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"bot_token": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
},
|
||||||
|
"chat_id": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "integer",
|
||||||
|
},
|
||||||
|
"hide_tags": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false,
|
||||||
|
},
|
||||||
|
"reminders": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "array",
|
||||||
|
"items": schema_reminder(),
|
||||||
|
"default": default_reminder(),
|
||||||
|
},
|
||||||
|
"language": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"default": "deu"
|
||||||
|
},
|
||||||
|
"strings": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"notification_head": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"default": "[{{core}}] {{extra}}"
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
],
|
||||||
|
"default": {},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"bot_token",
|
||||||
|
"chat_id",
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"kind",
|
||||||
|
"data",
|
||||||
|
]
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function schema_targets(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"nullable": false,
|
||||||
|
"anyOf": [
|
||||||
|
schema_target_email(),
|
||||||
|
schema_target_telegram_bot(),
|
||||||
|
]
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function schema_settings(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"interval": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "number",
|
||||||
|
"default": 1.0
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
],
|
||||||
|
"default": {
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function schema(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"sources": schema_sources(),
|
||||||
|
"targets": schema_targets(),
|
||||||
|
"settings": schema_settings(),
|
||||||
|
},
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"sources",
|
||||||
|
"targets",
|
||||||
|
],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function schema_extended(
|
||||||
|
) : lib_plankton.conf.type_schema
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"version": {
|
||||||
|
"nullable": false,
|
||||||
|
"type": "string",
|
||||||
|
"enum": [current_version],
|
||||||
|
},
|
||||||
|
"content": _munin.conf.schema(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export async function load(
|
||||||
|
path : string
|
||||||
|
) : Promise<type_conf>
|
||||||
|
{
|
||||||
|
const conf_raw : {version : string; content : any} = await lib_plankton.conf.load_versioned(
|
||||||
|
path,
|
||||||
|
schema,
|
||||||
|
{
|
||||||
|
"v7": null,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
if (conf_raw.version !== current_version)
|
||||||
|
{
|
||||||
|
throw (new Error("conf expected in version '" + current_version + "'"));
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
return (conf_raw.content as type_conf_v6);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
124
source/helpers/test.ts
Normal file
124
source/helpers/test.ts
Normal file
|
|
@ -0,0 +1,124 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.helpers.test
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo outsource
|
||||||
|
*/
|
||||||
|
type type_testcase_raw<type_input, type_output> = {
|
||||||
|
active ?: boolean;
|
||||||
|
name ?: string;
|
||||||
|
input : type_input;
|
||||||
|
output : type_output;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo outsource
|
||||||
|
*/
|
||||||
|
export type type_testcase<type_input, type_output> = {
|
||||||
|
name : string;
|
||||||
|
input : type_input;
|
||||||
|
output : type_output;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo outsource
|
||||||
|
*/
|
||||||
|
export async function get_data<type_input, type_output>(
|
||||||
|
path : string,
|
||||||
|
{
|
||||||
|
"default_active": default_active = true,
|
||||||
|
} : {
|
||||||
|
default_active ?: boolean;
|
||||||
|
} = {
|
||||||
|
}
|
||||||
|
) : Promise<Array<type_testcase<type_input, type_output>>>
|
||||||
|
{
|
||||||
|
const content : string = await lib_plankton.file.read(path);
|
||||||
|
const testcases_raw : Array<type_testcase_raw<type_input, type_output>> = (
|
||||||
|
lib_plankton.json.decode(content) as Array<type_testcase_raw<type_input, type_output>>
|
||||||
|
);
|
||||||
|
const testcases : Array<type_testcase<type_input, type_output>> = (
|
||||||
|
testcases_raw
|
||||||
|
.filter(
|
||||||
|
testcase_raw => (testcase_raw.active ?? default_active),
|
||||||
|
)
|
||||||
|
.map(
|
||||||
|
(testcase_raw, index) => ({
|
||||||
|
"name": (
|
||||||
|
testcase_raw.name
|
||||||
|
??
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
"{{path}} | #{{index}}",
|
||||||
|
{
|
||||||
|
"path": path,
|
||||||
|
"index": (index + 1).toFixed(0),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
),
|
||||||
|
"input": testcase_raw.input,
|
||||||
|
"output": testcase_raw.output,
|
||||||
|
})
|
||||||
|
)
|
||||||
|
);
|
||||||
|
return testcases;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo outsource
|
||||||
|
*/
|
||||||
|
export function start(
|
||||||
|
name : string
|
||||||
|
) : void
|
||||||
|
{
|
||||||
|
lib_plankton.log._info(
|
||||||
|
"test.run",
|
||||||
|
{
|
||||||
|
"details": {
|
||||||
|
"name": name,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo outsource
|
||||||
|
*/
|
||||||
|
export function fail(
|
||||||
|
name : string
|
||||||
|
) : void
|
||||||
|
{
|
||||||
|
lib_plankton.log._error(
|
||||||
|
"test.failed",
|
||||||
|
{
|
||||||
|
"details": {
|
||||||
|
"name": name,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
265
source/logic.ts
Normal file
265
source/logic.ts
Normal file
|
|
@ -0,0 +1,265 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.logic
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function frequency_decode(
|
||||||
|
frequency_encoded : string
|
||||||
|
) : _munin.enum_frequency
|
||||||
|
{
|
||||||
|
switch (frequency_encoded)
|
||||||
|
{
|
||||||
|
case "hourly": return _munin.enum_frequency.hourly;
|
||||||
|
case "daily": return _munin.enum_frequency.daily;
|
||||||
|
case "weekly": return _munin.enum_frequency.weekly;
|
||||||
|
case "monthly": return _munin.enum_frequency.monthly;
|
||||||
|
default: {throw new Error("unhandled");}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function frequency_anchor(
|
||||||
|
frequency : _munin.enum_frequency,
|
||||||
|
{
|
||||||
|
"pit": pit = lib_plankton.pit.now(),
|
||||||
|
} : {
|
||||||
|
pit ?: lib_plankton.pit.type_pit,
|
||||||
|
} = {
|
||||||
|
}
|
||||||
|
) : lib_plankton.pit.type_pit
|
||||||
|
{
|
||||||
|
switch (frequency)
|
||||||
|
{
|
||||||
|
case _munin.enum_frequency.hourly: return lib_plankton.pit.trunc_hour(pit);
|
||||||
|
case _munin.enum_frequency.daily: return lib_plankton.pit.trunc_day(pit);
|
||||||
|
case _munin.enum_frequency.weekly: return lib_plankton.pit.trunc_week(pit);
|
||||||
|
case _munin.enum_frequency.monthly: return lib_plankton.pit.trunc_month(pit);
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
throw (new Error("unhandled frequency: " + frequency));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function reminder_check(
|
||||||
|
reminder : type_reminder,
|
||||||
|
events_all : Array<_munin.type_event>,
|
||||||
|
{
|
||||||
|
"pit": pit = lib_plankton.pit.now(),
|
||||||
|
"interval": interval = 1,
|
||||||
|
}
|
||||||
|
: {
|
||||||
|
pit ?: lib_plankton.pit.type_pit;
|
||||||
|
interval ?: int;
|
||||||
|
}
|
||||||
|
= {
|
||||||
|
}
|
||||||
|
) : (null | Array<_munin.type_event>)
|
||||||
|
{
|
||||||
|
const anchor : lib_plankton.pit.type_pit = frequency_anchor(
|
||||||
|
reminder.frequency,
|
||||||
|
{"pit": pit}
|
||||||
|
);
|
||||||
|
const dueness_window_from : lib_plankton.pit.type_pit = lib_plankton.pit.shift_hour(
|
||||||
|
anchor,
|
||||||
|
(reminder.offset + 0)
|
||||||
|
);
|
||||||
|
const dueness_window_to : lib_plankton.pit.type_pit = lib_plankton.pit.shift_hour(
|
||||||
|
anchor,
|
||||||
|
(reminder.offset + interval)
|
||||||
|
);
|
||||||
|
const due : boolean = lib_plankton.pit.is_between(
|
||||||
|
pit,
|
||||||
|
dueness_window_from,
|
||||||
|
dueness_window_to
|
||||||
|
);
|
||||||
|
if (! due)
|
||||||
|
{
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
const events_window_from : lib_plankton.pit.type_pit = lib_plankton.pit.shift_hour(
|
||||||
|
anchor,
|
||||||
|
reminder.from
|
||||||
|
);
|
||||||
|
const events_window_to : lib_plankton.pit.type_pit = lib_plankton.pit.shift_hour(
|
||||||
|
anchor,
|
||||||
|
reminder.to
|
||||||
|
);
|
||||||
|
const events : Array<_munin.type_event> = (
|
||||||
|
events_all
|
||||||
|
.filter(
|
||||||
|
(event) => lib_plankton.pit.is_between(
|
||||||
|
lib_plankton.pit.from_datetime(event.begin),
|
||||||
|
events_window_from,
|
||||||
|
events_window_to
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
return events;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
async function run_iteration(
|
||||||
|
conf : _munin.conf.type_conf,
|
||||||
|
sources : Array<_munin.type_source>,
|
||||||
|
targets : Array<_munin.type_target>,
|
||||||
|
{
|
||||||
|
"dry_run": dry_run = false,
|
||||||
|
}
|
||||||
|
: {
|
||||||
|
dry_run ?: boolean;
|
||||||
|
}
|
||||||
|
= {
|
||||||
|
}
|
||||||
|
) : Promise<void>
|
||||||
|
{
|
||||||
|
const now : lib_plankton.pit.type_pit = lib_plankton.pit.now();
|
||||||
|
const events_all : Array<_munin.type_event> = (
|
||||||
|
(await Promise.all(sources.map(source => source.fetch())))
|
||||||
|
.reduce((x, y) => x.concat(y), [])
|
||||||
|
);
|
||||||
|
for (const target of targets)
|
||||||
|
{
|
||||||
|
for (const reminder of target.reminders)
|
||||||
|
{
|
||||||
|
const events : Array<_munin.type_event> = reminder_check(
|
||||||
|
reminder,
|
||||||
|
events_all,
|
||||||
|
{
|
||||||
|
"pit": now,
|
||||||
|
"interval": conf.settings.interval,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
if (events === null)
|
||||||
|
{
|
||||||
|
lib_plankton.log._info(
|
||||||
|
"munin.run_iteration.reminder_not_due",
|
||||||
|
{
|
||||||
|
"details": {
|
||||||
|
"reminder": reminder,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
if (events.length <= 0)
|
||||||
|
{
|
||||||
|
lib_plankton.log._info(
|
||||||
|
"munin.run_iteration.no_matching_events",
|
||||||
|
{
|
||||||
|
"details": {
|
||||||
|
"reminder": reminder,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
lib_plankton.log._info(
|
||||||
|
"munin.run_iteration.remind",
|
||||||
|
{
|
||||||
|
"details": {
|
||||||
|
"reminder": reminder,
|
||||||
|
"events": events,
|
||||||
|
"target": target.show(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
if (dry_run)
|
||||||
|
{
|
||||||
|
// do nothing
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
try
|
||||||
|
{
|
||||||
|
await target.send(events);
|
||||||
|
}
|
||||||
|
catch (error)
|
||||||
|
{
|
||||||
|
lib_plankton.log.error(
|
||||||
|
"munin.remind.error",
|
||||||
|
{
|
||||||
|
"details": {
|
||||||
|
"message": String(error),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export async function run(
|
||||||
|
conf : _munin.conf.type_conf,
|
||||||
|
{
|
||||||
|
"single_run": single_run = false,
|
||||||
|
"dry_run": dry_run = false,
|
||||||
|
} : {
|
||||||
|
single_run ?: boolean;
|
||||||
|
dry_run ?: boolean;
|
||||||
|
} = {
|
||||||
|
}
|
||||||
|
) : Promise<void>
|
||||||
|
{
|
||||||
|
const sources : Array<_munin.type_source> = conf.sources.map(
|
||||||
|
source_raw => _munin.sources.factory(source_raw)
|
||||||
|
);
|
||||||
|
const targets : Array<_munin.type_target> = conf.targets.map(
|
||||||
|
target_raw => _munin.targets.factory(target_raw)
|
||||||
|
);
|
||||||
|
lib_plankton.log._info(
|
||||||
|
"munin.run.start",
|
||||||
|
{
|
||||||
|
"details": {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
if (single_run) {
|
||||||
|
await run_iteration(conf, sources, targets, {"dry_run": dry_run});
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
while (true) {
|
||||||
|
await run_iteration(conf, sources, targets, {"dry_run": dry_run});
|
||||||
|
await lib_plankton.call.sleep(conf.settings.interval * 60 * 60);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
256
source/main.ts
Normal file
256
source/main.ts
Normal file
|
|
@ -0,0 +1,256 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export async function main(
|
||||||
|
args_raw : Array<string>
|
||||||
|
): Promise<void>
|
||||||
|
{
|
||||||
|
// init
|
||||||
|
const language_codes : Array<string> = [
|
||||||
|
"deu",
|
||||||
|
"eng",
|
||||||
|
];
|
||||||
|
const packages = await Promise.all<lib_plankton.translate.type_package>(
|
||||||
|
language_codes
|
||||||
|
.map<Promise<lib_plankton.translate.type_package>>(
|
||||||
|
code => (
|
||||||
|
Promise.resolve<string>(code)
|
||||||
|
.then<string>(code => Promise.resolve(lib_plankton.string.coin("data/localization/{{code}}.json", {"code": code})))
|
||||||
|
.then<string>(path => lib_plankton.file.read(path))
|
||||||
|
.then<lib_plankton.translate.type_package>(content => Promise.resolve(lib_plankton.json.decode(content)))
|
||||||
|
)
|
||||||
|
)
|
||||||
|
);
|
||||||
|
await lib_plankton.translate.initialize(
|
||||||
|
{
|
||||||
|
"verbosity": 1,
|
||||||
|
"packages": packages,
|
||||||
|
"order": language_codes,
|
||||||
|
"autopromote": false,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// args
|
||||||
|
const arg_handler : lib_plankton.args.class_handler = new lib_plankton.args.class_handler(
|
||||||
|
{
|
||||||
|
"action": lib_plankton.args.class_argument.positional({
|
||||||
|
"index": 0,
|
||||||
|
"type": lib_plankton.args.enum_type.string,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": "run",
|
||||||
|
"info": lib_plankton.string.coin(
|
||||||
|
"{{core}} : test | run",
|
||||||
|
{
|
||||||
|
"core": lib_plankton.translate.get("args.action.description"),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"name": "action",
|
||||||
|
}),
|
||||||
|
"conf_path": lib_plankton.args.class_argument.volatile({
|
||||||
|
"indicators_long": ["conf-path"],
|
||||||
|
"indicators_short": ["c"],
|
||||||
|
"type": lib_plankton.args.enum_type.string,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": "munin.json",
|
||||||
|
"info": lib_plankton.translate.get("args.conf_path.description"),
|
||||||
|
"name": "conf-path",
|
||||||
|
}),
|
||||||
|
"conf_schema": lib_plankton.args.class_argument.volatile({
|
||||||
|
"indicators_long": ["conf-schema"],
|
||||||
|
"indicators_short": ["s"],
|
||||||
|
"type": lib_plankton.args.enum_type.boolean,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": false,
|
||||||
|
"info": lib_plankton.translate.get("args.conf_schema.description"),
|
||||||
|
"name": "conf-schema",
|
||||||
|
}),
|
||||||
|
"conf_expose": lib_plankton.args.class_argument.volatile({
|
||||||
|
"indicators_long": ["conf-expose"],
|
||||||
|
"indicators_short": ["e"],
|
||||||
|
"type": lib_plankton.args.enum_type.boolean,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": false,
|
||||||
|
"info": lib_plankton.translate.get("args.conf_expose.description"),
|
||||||
|
"name": "conf-expose",
|
||||||
|
}),
|
||||||
|
"single_run": lib_plankton.args.class_argument.volatile({
|
||||||
|
"indicators_long": ["single-run"],
|
||||||
|
"indicators_short": ["x"],
|
||||||
|
"type": lib_plankton.args.enum_type.boolean,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": false,
|
||||||
|
"info": lib_plankton.translate.get("args.single_run.description"),
|
||||||
|
"name": "single-run",
|
||||||
|
}),
|
||||||
|
"verbosity": lib_plankton.args.class_argument.volatile({
|
||||||
|
"indicators_long": ["verbosity"],
|
||||||
|
"indicators_short": ["v"],
|
||||||
|
"type": lib_plankton.args.enum_type.string,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": "notice",
|
||||||
|
"info": "error | warning | notice | info | debug",
|
||||||
|
"name": "verbosity",
|
||||||
|
}),
|
||||||
|
"dry_run": lib_plankton.args.class_argument.volatile({
|
||||||
|
"indicators_long": ["dry-run"],
|
||||||
|
"indicators_short": ["q"],
|
||||||
|
"type": lib_plankton.args.enum_type.boolean,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": false,
|
||||||
|
"info": lib_plankton.translate.get("args.dry_run.description"),
|
||||||
|
"name": "dry-run",
|
||||||
|
}),
|
||||||
|
"help": lib_plankton.args.class_argument.volatile({
|
||||||
|
"indicators_long": ["help"],
|
||||||
|
"indicators_short": ["h"],
|
||||||
|
"type": lib_plankton.args.enum_type.boolean,
|
||||||
|
"mode": lib_plankton.args.enum_mode.replace,
|
||||||
|
"default": false,
|
||||||
|
"info": lib_plankton.translate.get("args.help.description"),
|
||||||
|
"name": "help",
|
||||||
|
}),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
const args : Record<string, any> = arg_handler.read(
|
||||||
|
lib_plankton.args.enum_environment.cli,
|
||||||
|
args_raw.join(" ")
|
||||||
|
);
|
||||||
|
|
||||||
|
if (args.help)
|
||||||
|
{
|
||||||
|
process.stdout.write(
|
||||||
|
arg_handler.generate_help(
|
||||||
|
{
|
||||||
|
"programname": "munin",
|
||||||
|
"description": lib_plankton.translate.get("help.description"),
|
||||||
|
"executable": "node build/munin",
|
||||||
|
}
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
if (args.conf_schema)
|
||||||
|
{
|
||||||
|
process.stdout.write(
|
||||||
|
lib_plankton.json.encode(
|
||||||
|
_munin.conf.schema_extended(),
|
||||||
|
{
|
||||||
|
"formatted": true,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
+
|
||||||
|
"\n"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
switch (args.action)
|
||||||
|
{
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
throw (new Error("unhandled action: " + args.action));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case "test":
|
||||||
|
{
|
||||||
|
_munin.test.all();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case "run":
|
||||||
|
{
|
||||||
|
// init
|
||||||
|
const conf : _munin.conf.type_conf = await _munin.conf.load(args.conf_path);
|
||||||
|
lib_plankton.log.set_main_logger(
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"kind": "filtered",
|
||||||
|
"data": {
|
||||||
|
"core": {
|
||||||
|
"kind": "std",
|
||||||
|
"data": {
|
||||||
|
"target": "stdout",
|
||||||
|
"format": {
|
||||||
|
"kind": "jsonl",
|
||||||
|
"data": {
|
||||||
|
"structured": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"predicate": [
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"item": {
|
||||||
|
"kind": "level",
|
||||||
|
"data": {
|
||||||
|
"threshold": args.verbosity,
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
]
|
||||||
|
],
|
||||||
|
}
|
||||||
|
},
|
||||||
|
]
|
||||||
|
);
|
||||||
|
|
||||||
|
// exec
|
||||||
|
if (args.conf_expose) {
|
||||||
|
process.stdout.write(
|
||||||
|
lib_plankton.json.encode(
|
||||||
|
conf,
|
||||||
|
{
|
||||||
|
"formatted": true,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
+
|
||||||
|
"\n"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
_munin.logic.run(
|
||||||
|
conf,
|
||||||
|
{
|
||||||
|
"single_run": args.single_run,
|
||||||
|
"dry_run": args.dry_run,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return Promise.resolve<void>(undefined);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_munin.main(process.argv.slice(2))
|
||||||
|
.then(() => {})
|
||||||
|
.catch((reason) => {process.stderr.write(String(reason) + "\n");})
|
||||||
|
;
|
||||||
|
|
||||||
48
source/sources/_functions.ts
Normal file
48
source/sources/_functions.ts
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.sources
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function factory(
|
||||||
|
description : {
|
||||||
|
kind : string,
|
||||||
|
data : any
|
||||||
|
}
|
||||||
|
) : _munin.type_source
|
||||||
|
{
|
||||||
|
switch (description.kind) {
|
||||||
|
default: {
|
||||||
|
throw (new Error("unhandled source kind: " + description.kind));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case "ics_feed": {
|
||||||
|
return _munin.sources.ics_feed.implementation_source(
|
||||||
|
description.data as _munin.sources.ics_feed.type_parameters
|
||||||
|
);
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
152
source/sources/ics_feed.ts
Normal file
152
source/sources/ics_feed.ts
Normal file
|
|
@ -0,0 +1,152 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.sources.ics_feed
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export type type_parameters = {
|
||||||
|
url : string;
|
||||||
|
filtration : {
|
||||||
|
category_whitelist : (null | Array<string>);
|
||||||
|
category_blacklist : (null | Array<string>);
|
||||||
|
title_whitelist : (null | Array<string>);
|
||||||
|
title_blacklist : (null | Array<string>);
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
async function fetch(
|
||||||
|
parameters : type_parameters
|
||||||
|
) : Promise<Array<_munin.type_event>>
|
||||||
|
{
|
||||||
|
const url : lib_plankton.url.type_url = lib_plankton.url.decode(parameters.url);
|
||||||
|
const http_request : lib_plankton.http.type_request = {
|
||||||
|
"scheme": (url.scheme as ("http" | "https")),
|
||||||
|
"host": url.host,
|
||||||
|
"path": url.path,
|
||||||
|
"version": "HTTP/2",
|
||||||
|
"method": lib_plankton.http.enum_method.get,
|
||||||
|
"query": ("?" + url.query),
|
||||||
|
"headers": {},
|
||||||
|
"body": null,
|
||||||
|
};
|
||||||
|
const http_response : lib_plankton.http.type_response = await lib_plankton.http.call(http_request);
|
||||||
|
const ics : string = http_response.body.toString();
|
||||||
|
const vcalendar : lib_plankton.ical.type_vcalendar = lib_plankton.ical.ics_decode(ics);
|
||||||
|
const events : Array<_munin.type_event> = (
|
||||||
|
vcalendar.vevents
|
||||||
|
.filter(
|
||||||
|
vevent => (
|
||||||
|
// category whitelist
|
||||||
|
(
|
||||||
|
(parameters.filtration.category_whitelist === null)
|
||||||
|
||
|
||||||
|
vevent.categories.some(
|
||||||
|
category => (
|
||||||
|
parameters.filtration.category_whitelist
|
||||||
|
.map(category_ => category_.toLowerCase())
|
||||||
|
.includes(category.toLowerCase())
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
&&
|
||||||
|
// category blacklist
|
||||||
|
(
|
||||||
|
(parameters.filtration.category_blacklist === null)
|
||||||
|
||
|
||||||
|
vevent.categories.every (
|
||||||
|
category => ! (
|
||||||
|
parameters.filtration.category_blacklist
|
||||||
|
.map(category_ => category_.toLowerCase())
|
||||||
|
.includes(category.toLowerCase())
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
&&
|
||||||
|
// title whitelist
|
||||||
|
(
|
||||||
|
(parameters.filtration.title_whitelist === null)
|
||||||
|
||
|
||||||
|
parameters.filtration.title_whitelist.some(
|
||||||
|
title => (
|
||||||
|
vevent.summary.toLowerCase()
|
||||||
|
.includes(title.toLowerCase())
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
&&
|
||||||
|
// title blacklist
|
||||||
|
(
|
||||||
|
(parameters.filtration.title_blacklist === null)
|
||||||
|
||
|
||||||
|
parameters.filtration.title_blacklist.every(
|
||||||
|
title => ! (
|
||||||
|
vevent.summary.toLowerCase()
|
||||||
|
.includes(title.toLowerCase())
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.map(
|
||||||
|
vevent => {
|
||||||
|
const begin : lib_plankton.pit.type_datetime = {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": vevent.dtstart.value.date,
|
||||||
|
"time": vevent.dtstart.value.time,
|
||||||
|
};
|
||||||
|
const end : lib_plankton.pit.type_datetime = {
|
||||||
|
"timezone_shift": 0,
|
||||||
|
"date": vevent.dtend.value.date,
|
||||||
|
"time": vevent.dtend.value.time,
|
||||||
|
};
|
||||||
|
const event : _munin.type_event = {
|
||||||
|
"title": vevent.summary,
|
||||||
|
"begin": begin,
|
||||||
|
"end": end,
|
||||||
|
"description": (vevent.description ?? null),
|
||||||
|
"location": (vevent.location ?? null),
|
||||||
|
"tags": vevent.categories,
|
||||||
|
};
|
||||||
|
return event;
|
||||||
|
}
|
||||||
|
)
|
||||||
|
);
|
||||||
|
return events;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function implementation_source(
|
||||||
|
parameters : type_parameters
|
||||||
|
) : _munin.type_source
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"fetch": () => fetch(parameters),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
54
source/targets/_functions.ts
Normal file
54
source/targets/_functions.ts
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.targets
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function factory(
|
||||||
|
description : {
|
||||||
|
kind : string,
|
||||||
|
data : any
|
||||||
|
}
|
||||||
|
) : _munin.type_target
|
||||||
|
{
|
||||||
|
switch (description.kind) {
|
||||||
|
default: {
|
||||||
|
throw (new Error("unhandled target kind: " + description.kind));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case "email": {
|
||||||
|
return _munin.targets.email.implementation_target(
|
||||||
|
description.data as _munin.targets.email.type_parameters
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case "telegram_bot": {
|
||||||
|
return _munin.targets.telegram_bot.implementation_target(
|
||||||
|
description.data as _munin.targets.telegram_bot.type_parameters
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
218
source/targets/email.ts
Normal file
218
source/targets/email.ts
Normal file
|
|
@ -0,0 +1,218 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.targets.email
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export type type_parameters = {
|
||||||
|
smtp_host : string;
|
||||||
|
smtp_port : int;
|
||||||
|
smtp_username : string;
|
||||||
|
smtp_password : string;
|
||||||
|
sender : string;
|
||||||
|
receivers : Array<string>;
|
||||||
|
hide_tags : boolean;
|
||||||
|
reminders : Array<_munin.type_reminder>;
|
||||||
|
language : string;
|
||||||
|
strings : {
|
||||||
|
notification_head : string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function get_translation(
|
||||||
|
parameters : type_parameters,
|
||||||
|
path : string
|
||||||
|
) : string
|
||||||
|
{
|
||||||
|
return lib_plankton.translate.get_new(
|
||||||
|
path,
|
||||||
|
{
|
||||||
|
"preferred_language": parameters.language,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function summarize_event(
|
||||||
|
parameters : type_parameters,
|
||||||
|
event : _munin.type_event
|
||||||
|
) : string
|
||||||
|
{
|
||||||
|
return lib_plankton.string.coin(
|
||||||
|
"[{{head}}] {{date}} : {{macro_tags}}{{title}}",
|
||||||
|
{
|
||||||
|
"head": lib_plankton.string.coin(
|
||||||
|
"{{event}}-{{reminder}}",
|
||||||
|
{
|
||||||
|
"event": get_translation(parameters, "core.event.event").toLowerCase(),
|
||||||
|
"reminder": get_translation(parameters, "core.reminder.reminder").toLowerCase(),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"date": lib_plankton.pit.date_format(
|
||||||
|
event.begin.date
|
||||||
|
),
|
||||||
|
"macro_tags": (
|
||||||
|
(event.tags === null)
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
(event.tags.map(tag => ("{" + tag + "}")).join(" ") + " ")
|
||||||
|
),
|
||||||
|
"title": event.title,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function render_event(
|
||||||
|
parameters : type_parameters,
|
||||||
|
event : _munin.type_event
|
||||||
|
) : string
|
||||||
|
{
|
||||||
|
return lib_plankton.string.coin(
|
||||||
|
"{{title_label}} | {{macro_tags}}{{title_value}}\n{{time_label}} | {{time_value}}{{macro_location}}{{macro_description}}",
|
||||||
|
{
|
||||||
|
"title_label": get_translation(parameters, "core.event.title.short").toUpperCase(),
|
||||||
|
"macro_tags": (
|
||||||
|
(parameters.hide_tags || (event.tags === null))
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
(event.tags.map(tag => ("{" + tag + "}")).join(" ") + " ")
|
||||||
|
),
|
||||||
|
"title_value": event.title,
|
||||||
|
"time_label": get_translation(parameters, "core.event.time.short").toUpperCase(),
|
||||||
|
"time_value": lib_plankton.pit.timespan_format(
|
||||||
|
event.begin,
|
||||||
|
event.end,
|
||||||
|
{
|
||||||
|
"adjust_to_ce": true,
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"macro_location": (
|
||||||
|
(event.location === null)
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
"\n{{location_label}} | {{location_value}}",
|
||||||
|
{
|
||||||
|
"location_label": get_translation(parameters, "core.event.location.short").toUpperCase(),
|
||||||
|
"location_value": event.location,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
),
|
||||||
|
"macro_description": (
|
||||||
|
(event.description === null)
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
"\n\n{{description_value}}",
|
||||||
|
{
|
||||||
|
"description_value": event.description,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
async function send(
|
||||||
|
parameters : type_parameters,
|
||||||
|
events : Array<_munin.type_event>
|
||||||
|
) : Promise<void>
|
||||||
|
{
|
||||||
|
await lib_plankton.email.send(
|
||||||
|
{
|
||||||
|
"host": parameters.smtp_host,
|
||||||
|
"port": parameters.smtp_port,
|
||||||
|
"username": parameters.smtp_username,
|
||||||
|
"password": parameters.smtp_password,
|
||||||
|
},
|
||||||
|
parameters.sender,
|
||||||
|
parameters.receivers,
|
||||||
|
(
|
||||||
|
(events.length === 1)
|
||||||
|
?
|
||||||
|
summarize_event(parameters, events[0])
|
||||||
|
:
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
parameters.strings.notification_head,
|
||||||
|
{
|
||||||
|
"core": lib_plankton.string.coin(
|
||||||
|
"{{event}}-{{reminder}}",
|
||||||
|
{
|
||||||
|
"event": get_translation(parameters, "core.event.event").toLowerCase(),
|
||||||
|
"reminder": get_translation(parameters, "core.reminder.reminder").toLowerCase(),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"extra": lib_plankton.string.coin(
|
||||||
|
"{{count}} {{events}}",
|
||||||
|
{
|
||||||
|
"count": events.length.toFixed(0),
|
||||||
|
"events": get_translation(parameters, "core.event.events"),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
),
|
||||||
|
(
|
||||||
|
events
|
||||||
|
.map(event => render_event(parameters, event))
|
||||||
|
.join("\n\n--------\n\n")
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function implementation_target(
|
||||||
|
parameters : type_parameters
|
||||||
|
) : _munin.type_target
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"reminders": parameters.reminders,
|
||||||
|
"show": () => lib_plankton.string.coin(
|
||||||
|
"email:{{receivers}}",
|
||||||
|
{
|
||||||
|
"receivers": parameters.receivers.join(","),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"send": (events) => send(parameters, events),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
182
source/targets/telegram_bot.ts
Normal file
182
source/targets/telegram_bot.ts
Normal file
|
|
@ -0,0 +1,182 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.targets.telegram_bot
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export type type_parameters = {
|
||||||
|
bot_token : string;
|
||||||
|
chat_id : int;
|
||||||
|
hide_tags : boolean;
|
||||||
|
reminders : Array<_munin.type_reminder>;
|
||||||
|
language : string;
|
||||||
|
strings : {
|
||||||
|
notification_head : string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function get_translation(
|
||||||
|
parameters : type_parameters,
|
||||||
|
path : string
|
||||||
|
) : string
|
||||||
|
{
|
||||||
|
return lib_plankton.translate.get_new(
|
||||||
|
path,
|
||||||
|
{
|
||||||
|
"preferred_language": parameters.language,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
function render_event(
|
||||||
|
parameters : type_parameters,
|
||||||
|
event : _munin.type_event
|
||||||
|
) : string
|
||||||
|
{
|
||||||
|
return lib_plankton.string.coin(
|
||||||
|
"{{title_label}} | {{macro_tags}}{{title_value}}\n{{time_label}} | {{time_value}}{{macro_location}}{{macro_description}}",
|
||||||
|
{
|
||||||
|
"macro_tags": (
|
||||||
|
(parameters.hide_tags || (event.tags === null))
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
(event.tags.map(tag => ("{" + tag + "}")).join(" ") + " ")
|
||||||
|
),
|
||||||
|
"title_label": get_translation(parameters, "core.event.title.short").toUpperCase(),
|
||||||
|
"title_value": event.title,
|
||||||
|
"time_label": get_translation(parameters, "core.event.time.short").toUpperCase(),
|
||||||
|
"time_value": lib_plankton.pit.timespan_format(
|
||||||
|
event.begin,
|
||||||
|
event.end,
|
||||||
|
{
|
||||||
|
"adjust_to_ce": true,
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"macro_location": (
|
||||||
|
(event.location === null)
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
"\n{{location_label}} | {{location_value}}",
|
||||||
|
{
|
||||||
|
"location_label": get_translation(parameters, "core.event.location.short").toUpperCase(),
|
||||||
|
"location_value": event.location,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
),
|
||||||
|
"macro_description": (
|
||||||
|
(event.description === null)
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
"\n\n{{description_value}}",
|
||||||
|
{
|
||||||
|
"description_value": event.description,
|
||||||
|
}
|
||||||
|
)
|
||||||
|
),
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
async function send(
|
||||||
|
parameters : type_parameters,
|
||||||
|
events : Array<_munin.type_event>
|
||||||
|
) : Promise<void>
|
||||||
|
{
|
||||||
|
await lib_plankton.telegram.bot_call_send_message(
|
||||||
|
parameters.bot_token,
|
||||||
|
parameters.chat_id,
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
"*{{head}}*\n\n{{body}}",
|
||||||
|
{
|
||||||
|
"head": lib_plankton.string.coin(
|
||||||
|
parameters.strings.notification_head,
|
||||||
|
{
|
||||||
|
"core": lib_plankton.string.coin(
|
||||||
|
"{{label_event}}-{{label_reminder}}",
|
||||||
|
{
|
||||||
|
"label_event": lib_plankton.string.capitalize(get_translation(parameters, "core.event.event")),
|
||||||
|
"label_reminder": lib_plankton.string.capitalize(get_translation(parameters, "core.reminder.reminder")),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"extra": (
|
||||||
|
(events.length <= 1)
|
||||||
|
?
|
||||||
|
""
|
||||||
|
:
|
||||||
|
lib_plankton.string.coin(
|
||||||
|
" ({{count}} {{events}})",
|
||||||
|
{
|
||||||
|
"count": events.length.toFixed(0),
|
||||||
|
"events": get_translation(parameters, "core.event.events"),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"body": (
|
||||||
|
events
|
||||||
|
.map(event => render_event(parameters, event))
|
||||||
|
.join("\n\n--------\n\n")
|
||||||
|
),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
{
|
||||||
|
"parse_mode": "Markdown",
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export function implementation_target(
|
||||||
|
parameters : type_parameters
|
||||||
|
) : _munin.type_target
|
||||||
|
{
|
||||||
|
return {
|
||||||
|
"reminders": parameters.reminders,
|
||||||
|
"show": () => lib_plankton.string.coin(
|
||||||
|
"telegram:{{chat_id}}",
|
||||||
|
{
|
||||||
|
"chat_id": parameters.chat_id.toFixed(0),
|
||||||
|
}
|
||||||
|
),
|
||||||
|
"send": (events) => send(parameters, events),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
139
source/test.ts
Normal file
139
source/test.ts
Normal file
|
|
@ -0,0 +1,139 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin.test
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo outsource?
|
||||||
|
*/
|
||||||
|
function lists_equal<type_element>(
|
||||||
|
list1 : Array<type_element>,
|
||||||
|
list2 : Array<type_element>
|
||||||
|
) : boolean
|
||||||
|
{
|
||||||
|
return (
|
||||||
|
(list1.length === list2.length)
|
||||||
|
&&
|
||||||
|
list1.every(
|
||||||
|
(element, index) => (element === list2[index])
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
async function reminder_check(
|
||||||
|
) : Promise<void>
|
||||||
|
{
|
||||||
|
type type_input = {
|
||||||
|
reminder : {
|
||||||
|
frequency : string;
|
||||||
|
offset : int;
|
||||||
|
from : int;
|
||||||
|
to : int;
|
||||||
|
};
|
||||||
|
events : Array<
|
||||||
|
{
|
||||||
|
title : string;
|
||||||
|
begin : lib_plankton.pit.type_datetime;
|
||||||
|
}
|
||||||
|
>;
|
||||||
|
datetime : lib_plankton.pit.type_datetime;
|
||||||
|
interval : int;
|
||||||
|
};
|
||||||
|
type type_output = (null | Array<string>);
|
||||||
|
const testcases : Array<
|
||||||
|
_munin.helpers.test.type_testcase<
|
||||||
|
type_input,
|
||||||
|
type_output
|
||||||
|
>
|
||||||
|
> = await _munin.helpers.test.get_data<type_input, type_output>(
|
||||||
|
"data/test/reminder_check.testdata.json",
|
||||||
|
{
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
for (const testcase of testcases)
|
||||||
|
{
|
||||||
|
_munin.helpers.test.start(testcase.name);
|
||||||
|
|
||||||
|
// execution
|
||||||
|
const result : (null | Array<_munin.type_event>) = _munin.logic.reminder_check(
|
||||||
|
{
|
||||||
|
"frequency": _munin.logic.frequency_decode(testcase.input.reminder.frequency),
|
||||||
|
"offset": testcase.input.reminder.offset,
|
||||||
|
"from": testcase.input.reminder.from,
|
||||||
|
"to": testcase.input.reminder.to,
|
||||||
|
},
|
||||||
|
testcase.input.events.map(
|
||||||
|
event_raw => ({
|
||||||
|
"title": event_raw.title,
|
||||||
|
"begin": event_raw.begin,
|
||||||
|
"end": null,
|
||||||
|
"description": null,
|
||||||
|
"location": null,
|
||||||
|
"tags": null,
|
||||||
|
})
|
||||||
|
),
|
||||||
|
{
|
||||||
|
"pit": lib_plankton.pit.from_datetime(testcase.input.datetime),
|
||||||
|
"interval": testcase.input.interval,
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// assertions
|
||||||
|
if (
|
||||||
|
(
|
||||||
|
(testcase.output === null)
|
||||||
|
&&
|
||||||
|
(result === null)
|
||||||
|
)
|
||||||
|
||
|
||||||
|
(
|
||||||
|
(testcase.output !== null)
|
||||||
|
&&
|
||||||
|
lists_equal<string>(
|
||||||
|
result.map(event => event.title),
|
||||||
|
testcase.output
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
{
|
||||||
|
// success
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
_munin.helpers.test.fail(testcase.name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export async function all(
|
||||||
|
) : Promise<void>
|
||||||
|
{
|
||||||
|
await reminder_check();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
82
source/types.ts
Normal file
82
source/types.ts
Normal file
|
|
@ -0,0 +1,82 @@
|
||||||
|
/*
|
||||||
|
This file is part of »munin«.
|
||||||
|
|
||||||
|
Copyright 2025 kcf <fenris@folksprak.org>
|
||||||
|
|
||||||
|
»munin« is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
»munin« 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 Lesser General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with »munin«. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
namespace _munin
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export enum enum_frequency {
|
||||||
|
hourly = "hourly",
|
||||||
|
daily = "daily",
|
||||||
|
weekly = "weekly",
|
||||||
|
monthly = "monthly",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export type type_event = {
|
||||||
|
title : string;
|
||||||
|
begin : lib_plankton.pit.type_datetime,
|
||||||
|
end : (null | lib_plankton.pit.type_datetime),
|
||||||
|
description : (null | string);
|
||||||
|
location : (null | string);
|
||||||
|
tags : (null | Array<string>);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export type type_source = {
|
||||||
|
fetch : (
|
||||||
|
(
|
||||||
|
)
|
||||||
|
=>
|
||||||
|
Promise<Array<type_event>>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @todo rename
|
||||||
|
*/
|
||||||
|
export type type_reminder = {
|
||||||
|
frequency : enum_frequency;
|
||||||
|
offset : int;
|
||||||
|
from : int;
|
||||||
|
to : int;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
*/
|
||||||
|
export type type_target = {
|
||||||
|
reminders : Array<type_reminder>;
|
||||||
|
show : (() => string);
|
||||||
|
send : (
|
||||||
|
(events : Array<type_event>)
|
||||||
|
=>
|
||||||
|
Promise<void>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
19
todo.md
Normal file
19
todo.md
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
# ToDo
|
||||||
|
|
||||||
|
## Quellen
|
||||||
|
|
||||||
|
- CalDAV (*würg*)
|
||||||
|
- zeitbild
|
||||||
|
|
||||||
|
|
||||||
|
## Ziele
|
||||||
|
|
||||||
|
- E-Mail
|
||||||
|
- Matrix
|
||||||
|
|
||||||
|
|
||||||
|
## Funktionen
|
||||||
|
|
||||||
|
- Erinnerungen bündeln
|
||||||
|
- Erinnerungen zu bestimmten Tageszeiten senden
|
||||||
|
|
||||||
13
tools/build
Executable file
13
tools/build
Executable file
|
|
@ -0,0 +1,13 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
## core
|
||||||
|
tools/ivaldi build
|
||||||
|
|
||||||
|
## data
|
||||||
|
mkdir -p build/data
|
||||||
|
cp -r -u -v data/* build/data/
|
||||||
|
|
||||||
|
## node modules
|
||||||
|
node_modules=""
|
||||||
|
node_modules="${node_modules} nodemailer"
|
||||||
|
cd build && npm install ${node_modules} ; cd -
|
||||||
4
tools/clear
Executable file
4
tools/clear
Executable file
|
|
@ -0,0 +1,4 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
tools/ivaldi clear $@
|
||||||
|
|
||||||
4
tools/deploy
Executable file
4
tools/deploy
Executable file
|
|
@ -0,0 +1,4 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
tools/ivaldi deploy $@
|
||||||
|
|
||||||
5461
tools/ivaldi
Executable file
5461
tools/ivaldi
Executable file
File diff suppressed because it is too large
Load diff
4
tools/update-ivaldi
Executable file
4
tools/update-ivaldi
Executable file
|
|
@ -0,0 +1,4 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
cp -u -v ../ivaldi/build/ivaldi tools/ivaldi
|
||||||
|
|
||||||
4
tools/update-libs
Executable file
4
tools/update-libs
Executable file
|
|
@ -0,0 +1,4 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
tools/ivaldi fetch $@
|
||||||
|
|
||||||
Loading…
Reference in a new issue