first commit
This commit is contained in:
commit
d4532a92b6
|
@ -0,0 +1,70 @@
|
|||
|
||||
# Created by https://www.toptal.com/developers/gitignore/api/emacs
|
||||
# Edit at https://www.toptal.com/developers/gitignore?templates=emacs
|
||||
|
||||
### Emacs ###
|
||||
# -*- mode: gitignore; -*-
|
||||
*~
|
||||
\#*\#
|
||||
/.emacs.desktop
|
||||
/.emacs.desktop.lock
|
||||
*.elc
|
||||
auto-save-list
|
||||
tramp
|
||||
.\#*
|
||||
|
||||
# Org-mode
|
||||
.org-id-locations
|
||||
*_archive
|
||||
|
||||
# flymake-mode
|
||||
*_flymake.*
|
||||
|
||||
# eshell files
|
||||
/eshell/history
|
||||
/eshell/lastdir
|
||||
|
||||
# elpa packages
|
||||
/elpa/
|
||||
|
||||
# reftex files
|
||||
*.rel
|
||||
|
||||
# AUCTeX auto folder
|
||||
/auto/
|
||||
|
||||
# cask packages
|
||||
.cask/
|
||||
dist/
|
||||
|
||||
# Flycheck
|
||||
flycheck_*.el
|
||||
|
||||
# server auth directory
|
||||
/server/
|
||||
|
||||
# projectiles files
|
||||
.projectile
|
||||
|
||||
# directory configuration
|
||||
.dir-locals.el
|
||||
|
||||
# network security
|
||||
/network-security.data
|
||||
|
||||
|
||||
# End of https://www.toptal.com/developers/gitignore/api/emacs
|
||||
|
||||
# Created by https://www.toptal.com/developers/gitignore/api/scheme
|
||||
# Edit at https://www.toptal.com/developers/gitignore?templates=scheme
|
||||
|
||||
### Scheme ###
|
||||
*.ss~
|
||||
*.ss#*
|
||||
.#*.ss
|
||||
|
||||
*.scm~
|
||||
*.scm#*
|
||||
.#*.scm
|
||||
|
||||
# End of https://www.toptal.com/developers/gitignore/api/scheme
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
|
||||
<http://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
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
@ -0,0 +1,74 @@
|
|||
# Synopsis
|
||||
|
||||
Lieferhund is a (the most?) hackable news-reading utility.
|
||||
|
||||
To use it, first make sure you have a configuration file in place - the default
|
||||
location is in `$HOME/.config/lieferhund/config.scm`. Then, the first step
|
||||
would be to pulling the news from the sources.
|
||||
|
||||
```
|
||||
lieferhund -x pull
|
||||
lieferhund -c $CONFIG_FILE -b $DB_FILE -x pull
|
||||
```
|
||||
|
||||
Next, one can invoke the `read` command (which is quite basic at this moment),
|
||||
to go through the news:
|
||||
|
||||
```
|
||||
lieferhund -x read
|
||||
```
|
||||
|
||||
# Supported protocols
|
||||
|
||||
Currently, only Atom feeds are supported, but IMAP, mailing list are on their way.
|
||||
|
||||
# Configuration hacking
|
||||
|
||||
An example configuration can be found in `/examples`.
|
||||
|
||||
One just needs to add entries.
|
||||
|
||||
The hackability comes into attention, when writing the `'post-hook` field in the
|
||||
configuration. A post hook is defined as:
|
||||
|
||||
- `#f` - no action, just add to the database
|
||||
- a lambda, which takes as argument, a list of the form `'((config-entry news-items) ...)`
|
||||
- an exp of the form `('process-each hook-fn)`, which applies the lambda with the signature
|
||||
`(lambda (config-entry item) ...)`, to each news item, in a sorted manner
|
||||
- an exp of the form `('process-each-channel hook-fn)`, which applies the lambda with
|
||||
the signature `(lambda (config-entry news-items) ...)`, to each channel and its
|
||||
entries
|
||||
- `('hook-gen make-hook args ...)` applies the hook generator, with the arguments specified
|
||||
(i.e: `(hook-gen make-send-mail-to "xxx@yyy.zzz")`)
|
||||
- `('hook-cons hooks ...)` which means that multiple hooks can be combined
|
||||
|
||||
There are already 2 hooks already implemented:
|
||||
|
||||
- `make-printer-hook` - takes no argument, prints each item
|
||||
- `make-each-script-hook` - takes two arguments - a string describing the
|
||||
command, and a list with strings which describe the content of the message,
|
||||
which is written to a temporary file and can be used in the command; to make
|
||||
the process useful, the following string interpolations are defined:
|
||||
`~~CONTENT~~` - the content file, `~~NAME~~` - config entry name, `~~TITLE~~` -
|
||||
item's title, `~~DATE~~` - item's date, `~~DESCRIPTION~~` - the item's description
|
||||
|
||||
# Treating your delivery doggo well
|
||||
|
||||
```
|
||||
lieferhund -x give-treat
|
||||
```
|
||||
|
||||
# TODOs
|
||||
|
||||
Below are some TODOs:
|
||||
|
||||
- make-each-pair-script-hook
|
||||
- make-ui-hook - it would nice to have a little UI - either term aware or not
|
||||
- add user-defined options (to be read by hooks, i.e: NNTP group)
|
||||
- add support for IMAP
|
||||
- write `lieferhuendchen` (the daemon - which obviously has more energy)
|
||||
- write `lieferkatze` (the web interface; it would be nice to
|
||||
wait for guile's to-ecmascript compiling)
|
||||
- add support for mailing lists
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
(configuration
|
||||
(post-hook
|
||||
(hook-cons
|
||||
(hook-gen make-printer-hook)
|
||||
(hook-gen
|
||||
make-each-script-hook
|
||||
"cat '~~CONTENT~~' > \"/tmp/mailtest/~~TITLE~~.~~DATE~~.txt\""
|
||||
'("Dear User,\n"
|
||||
"You are decent. Here are your news: \n\n"
|
||||
"Title: ~~TITLE~~\nDate: ~~DATE~~\n"
|
||||
"URL: ~~LINK~~\n\n"
|
||||
"~~DESCRIPTION~~"))))
|
||||
(store-size 250)
|
||||
(entry
|
||||
(name "guix ci")
|
||||
(url "http://ci.guix.gnu.org/events/rss/"))
|
||||
(entry
|
||||
(name "gentoo news")
|
||||
(url "https://planet.gentoo.org/universe/rss20.xml"))
|
||||
(entry
|
||||
(name "arch news")
|
||||
(url "https://archlinux.org/feeds/news/")))
|
|
@ -0,0 +1,127 @@
|
|||
#!/usr/bin/guile \
|
||||
-e main -s
|
||||
!#
|
||||
|
||||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
(use-modules (lieferhund config)
|
||||
(lieferhund db)
|
||||
(lieferhund processor)
|
||||
(lieferhund proto atom)
|
||||
(lieferhund hooks printer)
|
||||
(srfi srfi-19)
|
||||
(srfi srfi-98)
|
||||
(ice-9 match)
|
||||
(ice-9 getopt-long))
|
||||
|
||||
(define default-config-path (string-append
|
||||
(get-environment-variable "HOME")
|
||||
"/.config/lieferhund/config.scm"))
|
||||
(define default-db-path (string-append
|
||||
(get-environment-variable "HOME")
|
||||
"/.share/lieferhund/db.scm"))
|
||||
|
||||
(define new-database #t)
|
||||
|
||||
(false-if-exception (mkdir (dirname (dirname default-db-path))))
|
||||
(false-if-exception (mkdir (dirname default-db-path)))
|
||||
|
||||
(define (main args)
|
||||
(let* ((option-spec '((help (single-char #\h) (value #f))
|
||||
(command (single-char #\x) (value #t))
|
||||
(config-file (single-char #\c) (value #t))
|
||||
(db-file (single-char #\b) (value #t))))
|
||||
(options (getopt-long args option-spec))
|
||||
(help-wanted (option-ref options 'help #f))
|
||||
(command (option-ref options 'command #f))
|
||||
(config-file (option-ref options 'config-file
|
||||
default-config-path))
|
||||
(db-file (option-ref options 'config-file
|
||||
default-db-path)))
|
||||
(if (or help-wanted (equal? command #f))
|
||||
(begin
|
||||
(display "\
|
||||
lieferhund.scm (version 0.1)
|
||||
|
||||
Usage: ./lieferhund.scm -c <config file> -b <db file> -x <command>
|
||||
<config file> - path to the configuration file
|
||||
<db file> - path to the database file
|
||||
<command> - one of \"pull\",\"read\",\"give-treat\"
|
||||
")
|
||||
(exit 0)))
|
||||
(if (not (access? config-file R_OK))
|
||||
(begin
|
||||
(display "config file not found\n")
|
||||
(flush-all-ports)
|
||||
(exit 1)))
|
||||
(if (access? (dirname db-file) (logior R_OK W_OK))
|
||||
(if (file-exists? db-file)
|
||||
(if (access? db-file (logior R_OK W_OK))
|
||||
(set! new-database #f)
|
||||
(begin
|
||||
(display "unable to find/access db file\n")
|
||||
(flush-all-ports)
|
||||
(exit 1)))
|
||||
(set! new-database #t))
|
||||
(begin
|
||||
(display "unable to find/access db directory\n")
|
||||
(flush-all-ports)
|
||||
(exit 1)))
|
||||
(match command
|
||||
("pull"
|
||||
(let* ((conf (read-config-file config-file))
|
||||
(db (if new-database
|
||||
(make-channel-database
|
||||
(database-tables-list->database-tables '()))
|
||||
(read-database db-file)))
|
||||
(new-news-items
|
||||
(map-in-order
|
||||
(lambda (entry)
|
||||
(format #t "processing item \"~a\" (~a)\n"
|
||||
(config-entry-name entry)
|
||||
(config-entry-url entry))
|
||||
(let* ((news-response (request-feed (config-entry-url entry)))
|
||||
(news-entries (if (equal? news-response #f)
|
||||
#f
|
||||
(process-atom-feed-response
|
||||
news-response)))
|
||||
(new-items (if (equal? news-response #f)
|
||||
'()
|
||||
(database-insert-entries!
|
||||
db conf entry news-entries))))
|
||||
(if (equal? news-response #f)
|
||||
(format #t "failed to get response!\n")
|
||||
(format #t "new items: ~a\n" (length new-items)))
|
||||
`(,entry ,new-items)))
|
||||
(configuration-entries conf))))
|
||||
(save-database db-file db)
|
||||
(display "database saved\n")
|
||||
(process conf new-news-items)))
|
||||
("read"
|
||||
(let* ((conf (read-config-file config-file))
|
||||
(db (if new-database
|
||||
(begin
|
||||
(display "cannot read from an empty database\n")
|
||||
(exit 1))
|
||||
(read-database db-file)))
|
||||
(news-items (map
|
||||
(lambda (conf-entry)
|
||||
(let* ((entry-name (config-entry-name conf-entry))
|
||||
(entry-table (database-get db entry-name)))
|
||||
(if (equal? entry-table #f)
|
||||
(begin
|
||||
(format #t "could not find entry with name \"~a\"\n" entry-name)
|
||||
'())
|
||||
`(,conf-entry ,(channel-table-entries entry-table)))))
|
||||
(configuration-entries conf))))
|
||||
(process conf news-items (make-printer-hook))))
|
||||
("give-treat"
|
||||
(begin
|
||||
(display "woof woof\n")
|
||||
(exit 0)))
|
||||
(_
|
||||
(begin
|
||||
(display "unknown command\n")
|
||||
(exit 1))))))
|
|
@ -0,0 +1,74 @@
|
|||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
(define-module (lieferhund config)
|
||||
#:use-module (srfi srfi-9)
|
||||
#:use-module (ice-9 match)
|
||||
#:use-module (ice-9 pretty-print)
|
||||
|
||||
#:export (<configuration>
|
||||
make-configuration
|
||||
configuration-store-size
|
||||
configuration-entries
|
||||
configuration-post-hook
|
||||
|
||||
<configuration-entry>
|
||||
make-configuration-entry
|
||||
config-entry-name
|
||||
config-entry-url
|
||||
|
||||
parse-config-entry
|
||||
parse-config-file
|
||||
read-config-file
|
||||
save-config-file))
|
||||
|
||||
;;
|
||||
;; Configuration files
|
||||
;;
|
||||
|
||||
(define-record-type <configuration>
|
||||
(make-configuration store-size entries post-hook)
|
||||
configuration-file?
|
||||
(store-size configuration-store-size)
|
||||
(entries configuration-entries)
|
||||
(post-hook configuration-post-hook))
|
||||
|
||||
(define-record-type <configuration-entry>
|
||||
(make-configuration-entry name url)
|
||||
configuration-entry?
|
||||
(name config-entry-name)
|
||||
(url config-entry-url))
|
||||
|
||||
(define (parse-config-entry exp)
|
||||
(match exp
|
||||
(('entry ('name name)
|
||||
('url url))
|
||||
(make-configuration-entry name url))))
|
||||
|
||||
(define (parse-config-file exp)
|
||||
(apply
|
||||
make-configuration
|
||||
(match exp
|
||||
(('configuration ('post-hook post-hook) ('store-size store-size) entries ...)
|
||||
`(,store-size ,(map parse-config-entry entries) ,post-hook)))))
|
||||
|
||||
(define (read-config-file config-path)
|
||||
(parse-config-file
|
||||
(call-with-input-file config-path
|
||||
(lambda (config-file) (read config-file)))))
|
||||
|
||||
(define (save-config-file config-path config)
|
||||
(call-with-output-file config-path
|
||||
(lambda (config-file)
|
||||
(pretty-print
|
||||
`(configuration
|
||||
,@(map
|
||||
(lambda (ce)
|
||||
`(entry
|
||||
(url ,(config-entry-url ce))
|
||||
(name ,(config-entry-name ce))))
|
||||
(configuration-entries config))
|
||||
(store-size ,(configuration-store-size config))
|
||||
(post-hook ,(configuration-post-hook config)))
|
||||
config-file))))
|
|
@ -0,0 +1,198 @@
|
|||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
(define-module (lieferhund db)
|
||||
#:use-module (lieferhund config)
|
||||
#:use-module (lieferhund proto atom)
|
||||
#:use-module (srfi srfi-1)
|
||||
#:use-module (srfi srfi-9)
|
||||
#:use-module (srfi srfi-19)
|
||||
#:use-module (srfi srfi-69)
|
||||
#:use-module (ice-9 match)
|
||||
#:use-module (ice-9 pretty-print)
|
||||
#:use-module (ice-9 textual-ports)
|
||||
|
||||
#:export (db-date-format
|
||||
|
||||
<channel-table>
|
||||
make-channel-table
|
||||
channel-table-name
|
||||
channel-table-channel-url
|
||||
channel-table-last-updated
|
||||
channel-table-entries
|
||||
|
||||
<channel-database>
|
||||
make-channel-database
|
||||
database-tables
|
||||
|
||||
database-tables-list->database-tables
|
||||
database-tables->database-tables-list
|
||||
|
||||
read-database
|
||||
save-database
|
||||
|
||||
database-get
|
||||
database-has-table
|
||||
database-insert-entries!))
|
||||
|
||||
;;
|
||||
;; Constants
|
||||
;;
|
||||
|
||||
(define db-date-format "~d ~B ~Y ~H:~M:~S ~z")
|
||||
|
||||
;;
|
||||
;; Database records
|
||||
;;
|
||||
|
||||
(define-record-type <channel-table>
|
||||
(make-channel-table table-name channel-url last-updated entries)
|
||||
channel-table?
|
||||
(table-name channel-table-name)
|
||||
(channel-url channel-table-channel-url)
|
||||
(last-updated channel-table-last-updated)
|
||||
(entries channel-table-entries))
|
||||
|
||||
(define-record-type <channel-database>
|
||||
(make-channel-database tables)
|
||||
channel-database?
|
||||
(tables database-tables))
|
||||
|
||||
(define (parse-channel-entry exp)
|
||||
(match exp
|
||||
(('entry ('title title)
|
||||
('description description)
|
||||
('link link)
|
||||
('date date))
|
||||
(make-atom-feed-entry title description link date))))
|
||||
|
||||
(define (parse-database-table exp)
|
||||
(match exp
|
||||
(('table
|
||||
('channel-name channel-name)
|
||||
('channel-url channel-url)
|
||||
('last-updated last-updated)
|
||||
('entries entries))
|
||||
(make-channel-table
|
||||
channel-name channel-url (string->date last-updated db-date-format)
|
||||
(map parse-channel-entry entries)))))
|
||||
|
||||
(define (database-tables-list->database-tables tables-list)
|
||||
(let ((tables (make-hash-table)))
|
||||
(for-each
|
||||
(lambda (table)
|
||||
(hash-table-set! tables (channel-table-name table) table))
|
||||
tables-list)
|
||||
tables))
|
||||
|
||||
(define (database-tables->database-tables-list tables)
|
||||
(hash-table-fold
|
||||
tables
|
||||
(lambda (k v p)
|
||||
(cons v p))
|
||||
'()))
|
||||
|
||||
(define (parse-database exp)
|
||||
(make-channel-database
|
||||
(match exp
|
||||
(('database tables ...)
|
||||
(database-tables-list->database-tables
|
||||
(map parse-database-table tables))))))
|
||||
|
||||
(define (read-database db-path)
|
||||
(parse-database
|
||||
(call-with-input-file db-path
|
||||
(lambda (db) (read db)))))
|
||||
|
||||
;; TODO: implement database locking, find, update, cleaning items...
|
||||
(define (save-database db-path db)
|
||||
(call-with-output-file db-path
|
||||
(lambda (db-p)
|
||||
(pretty-print
|
||||
`(database
|
||||
,@(map
|
||||
(lambda (dt)
|
||||
`(table
|
||||
(channel-name ,(channel-table-name dt))
|
||||
(channel-url ,(channel-table-channel-url dt))
|
||||
(last-updated ,(date->string (channel-table-last-updated dt)
|
||||
db-date-format))
|
||||
(entries
|
||||
,(map
|
||||
(lambda (e)
|
||||
`(entry
|
||||
(title ,(entry-title e))
|
||||
(description ,(entry-description e))
|
||||
(link ,(entry-link e))
|
||||
(date ,(entry-date e))))
|
||||
(channel-table-entries dt)))))
|
||||
(database-tables->database-tables-list (database-tables db))))
|
||||
db-p))))
|
||||
|
||||
;;
|
||||
;; Table operations
|
||||
;;
|
||||
|
||||
(define (table-cleanup table store-size)
|
||||
(let ((table-entries (channel-table-entries table)))
|
||||
(make-channel-table (channel-table-name table)
|
||||
(channel-table-channel-url table)
|
||||
(channel-table-last-updated table)
|
||||
(list-head table-entries
|
||||
(min store-size
|
||||
(length table-entries))))))
|
||||
|
||||
;; TODO: fix assumption that the table is populated
|
||||
(define (table-insert table entries store-size)
|
||||
(let* ((first-entry (car (channel-table-entries table)))
|
||||
(relevant-entries
|
||||
(take-while
|
||||
(lambda (e) (not (equal? e first-entry)))
|
||||
entries))
|
||||
(updated-channel-table
|
||||
(make-channel-table
|
||||
(channel-table-name table)
|
||||
(channel-table-channel-url table)
|
||||
(current-date)
|
||||
(append relevant-entries
|
||||
(channel-table-entries table))))
|
||||
(final-channel (table-cleanup updated-channel-table store-size)))
|
||||
`(,final-channel ,relevant-entries)))
|
||||
|
||||
;;
|
||||
;; Database operations
|
||||
;;
|
||||
|
||||
(define (database-get db table-name)
|
||||
(hash-table-ref/default (database-tables db) table-name #f))
|
||||
|
||||
(define (database-has-table db table-name)
|
||||
(hash-table-exists? (database-tables db) table-name))
|
||||
|
||||
;; (define (database-update db table-entry)
|
||||
;; (hash-table-set! (database-tables db)
|
||||
;; (channel-table-name table-entry)
|
||||
;; table-entry))
|
||||
|
||||
(define* (database-insert-entries! db config config-entry entries)
|
||||
(let* ((table-name (config-entry-name config-entry))
|
||||
(table-url (config-entry-url config-entry))
|
||||
(store-size (configuration-store-size config))
|
||||
(insert-entries-result
|
||||
(if (database-has-table db table-name)
|
||||
(table-insert (database-get db table-name)
|
||||
entries store-size)
|
||||
`(,(make-channel-table
|
||||
table-name table-url (current-date)
|
||||
(list-head entries
|
||||
(min store-size
|
||||
(length entries))))
|
||||
,entries)))
|
||||
(new-entries (cadr insert-entries-result))
|
||||
(final-table (car insert-entries-result)))
|
||||
(hash-table-set!
|
||||
(database-tables db)
|
||||
table-name
|
||||
final-table)
|
||||
new-entries))
|
|
@ -0,0 +1,15 @@
|
|||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
(define-module (lieferhund hooks printer)
|
||||
#:use-module (lieferhund processor)
|
||||
#:export (make-printer-hook))
|
||||
|
||||
(define (make-printer-hook)
|
||||
`(process-each
|
||||
(lambda (config-entry news-item)
|
||||
(format #t "[~a] ~a (~a)\n"
|
||||
(config-entry-name config-entry)
|
||||
(entry-title news-item)
|
||||
(entry-link news-item)))))
|
|
@ -0,0 +1,93 @@
|
|||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
(define-module (lieferhund hooks script)
|
||||
#:use-module (lieferhund processor)
|
||||
#:use-module (lieferhund config)
|
||||
#:use-module (lieferhund util)
|
||||
#:use-module (srfi srfi-1)
|
||||
#:use-module (ice-9 match)
|
||||
#:use-module (ice-9 string-fun)
|
||||
|
||||
#:use-module (lieferhund proto atom)
|
||||
|
||||
#:export (string-interpolator-0
|
||||
string-interpolator-1
|
||||
|
||||
make-each-script-hook))
|
||||
|
||||
;;
|
||||
;; String interpolation functions
|
||||
;;
|
||||
|
||||
(define (string-interpolator-escaper s)
|
||||
(let* ((replacement-list
|
||||
'(("\"" "\\\""))))
|
||||
(fold
|
||||
(match-lambda*
|
||||
(((int-orig int-repl) sx)
|
||||
(string-replace-substring sx int-orig int-repl)))
|
||||
s
|
||||
replacement-list)))
|
||||
|
||||
(define (string-interpolator-0 s config-entry news-item content-file)
|
||||
(let* ((name (config-entry-name config-entry))
|
||||
(item-title (string-interpolator-escaper
|
||||
(entry-title news-item)))
|
||||
(item-date (entry-date news-item))
|
||||
(item-link (entry-link news-item))
|
||||
(item-desc (entry-description news-item))
|
||||
|
||||
(replacement-list
|
||||
`(("~~NAME~~" ,name)
|
||||
("~~TITLE~~" ,item-title)
|
||||
("~~DATE~~" ,item-date)
|
||||
("~~LINK~~" ,item-link)
|
||||
("~~DESCRIPTION~~" ,item-desc)
|
||||
("~~CONTENT~~" ,content-file))))
|
||||
(fold
|
||||
(match-lambda*
|
||||
(((int-orig int-repl) sx)
|
||||
(string-replace-substring sx int-orig int-repl)))
|
||||
s
|
||||
replacement-list)))
|
||||
|
||||
(define (string-interpolator-1 exp config-entry news-item)
|
||||
(fold
|
||||
(lambda (pres rets)
|
||||
(string-append
|
||||
rets
|
||||
(string-interpolator-0 pres config-entry news-item "")))
|
||||
""
|
||||
exp))
|
||||
|
||||
;;
|
||||
;; script-cmd-fmt format example:
|
||||
;; cat '~~CONTENT~~' | sendmail
|
||||
;;
|
||||
;; content-fmt:
|
||||
;; '("From: xxx@yyy.zzz\n"
|
||||
;; "To: mmm@nnn.ppp\n"
|
||||
;; "Subject: ~~DATE~~ -- ~~TITLE~~\n"
|
||||
;; "Hello this is me and I want to inform "
|
||||
;; "you about ~~TITLE~~, from ~~NAME~~, which can be "
|
||||
;; "found at ~~LINK~~. The contents can be found below:\n"
|
||||
;; "~~DESCRIPTION~~")
|
||||
;;
|
||||
|
||||
(define (make-each-script-hook script-cmd-fmt content-fmt)
|
||||
`(process-each
|
||||
(lambda (config-entry news-item)
|
||||
(let* ((content (string-interpolator-1
|
||||
',content-fmt
|
||||
config-entry news-item)))
|
||||
(call-with-temporary-output-file
|
||||
(lambda (content-file content-port)
|
||||
(let ((cmd (string-interpolator-0
|
||||
,script-cmd-fmt
|
||||
config-entry
|
||||
news-item
|
||||
content-file)))
|
||||
(put-string content-port content)
|
||||
(system cmd))))))))
|
|
@ -0,0 +1,97 @@
|
|||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
(define-module (lieferhund processor)
|
||||
#:use-module (lieferhund config)
|
||||
#:use-module ((lieferhund db) :prefix db:)
|
||||
#:use-module (srfi srfi-1)
|
||||
#:use-module (srfi srfi-19)
|
||||
#:use-module (rnrs sorting)
|
||||
#:use-module (ice-9 match)
|
||||
|
||||
#:use-module (lieferhund proto atom)
|
||||
|
||||
#:export (preprocess-flatten
|
||||
preprocess-sort
|
||||
|
||||
process))
|
||||
|
||||
(define (flatten l)
|
||||
(fold
|
||||
(lambda (c e) (append e c))
|
||||
'() l))
|
||||
|
||||
(define (fn-apply fn)
|
||||
(use-modules (lieferhund util)
|
||||
(lieferhund hooks printer)
|
||||
(lieferhund hooks script)
|
||||
|
||||
(ice-9 textual-ports))
|
||||
(lambda args
|
||||
(eval `(,fn ,@args)
|
||||
(interaction-environment))))
|
||||
|
||||
(define (preprocess-sort pe-items)
|
||||
(list-sort
|
||||
(lambda (item0-pair item1-pair)
|
||||
(let* ((item0 (cadr item0-pair))
|
||||
(item1 (cadr item1-pair))
|
||||
|
||||
(date-str-item0 (entry-date item0))
|
||||
(date-str-item1 (entry-date item1))
|
||||
|
||||
(date-item0 (string->date date-str-item0
|
||||
db:db-date-format))
|
||||
(date-item1 (string->date date-str-item1
|
||||
db:db-date-format))
|
||||
|
||||
(time-item0 (date->time-tai date-item0))
|
||||
(time-item1 (date->time-tai date-item1)))
|
||||
(time<? time-item0 time-item1)))
|
||||
pe-items))
|
||||
|
||||
(define (preprocess-flatten pair-entries)
|
||||
(flatten
|
||||
(map
|
||||
(lambda (channel-entry)
|
||||
(match channel-entry
|
||||
((config-entry items)
|
||||
(map
|
||||
(lambda (item)
|
||||
`(,config-entry ,item))
|
||||
items))))
|
||||
pair-entries)))
|
||||
|
||||
(define* (process conf pair-entries #:optional post-hook-override)
|
||||
(let ((post-hook (if (equal? post-hook-override #f)
|
||||
(configuration-post-hook conf)
|
||||
post-hook-override)))
|
||||
(match post-hook
|
||||
;; No post-hook action
|
||||
(#f '())
|
||||
;; Generic hooks
|
||||
(('hook-gen hook-gen hook-args ...)
|
||||
(process
|
||||
conf pair-entries
|
||||
(apply (fn-apply hook-gen) hook-args)))
|
||||
;; Combined hooks
|
||||
(('hook-cons hook-exps ...)
|
||||
(map
|
||||
(lambda (hook-exp)
|
||||
(process conf pair-entries hook-exp))
|
||||
hook-exps))
|
||||
;; Process the news items one-by-one (lambda (conf-entry news-item) ...)
|
||||
(('process-each fn)
|
||||
(for-each
|
||||
(lambda (entry)
|
||||
(apply (fn-apply fn) entry))
|
||||
(preprocess-sort (preprocess-flatten pair-entries))))
|
||||
;; Process the news items by channel (lambda (conf-entry multiple-news-items) ...)
|
||||
(('process-each-channel fn)
|
||||
(for-each
|
||||
(lambda (entry)
|
||||
(apply (fn-apply fn) entry))
|
||||
pair-entries))
|
||||
;; Process the entries as a whole (lambda (pair-entries) ...)
|
||||
(fn ((fn-apply fn) pair-entries)))))
|
|
@ -0,0 +1,138 @@
|
|||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
(define-module (lieferhund proto atom)
|
||||
#:use-module ((lieferhund db) :prefix db:)
|
||||
#:use-module (web client)
|
||||
#:use-module (web response)
|
||||
#:use-module (sxml simple)
|
||||
#:use-module (sxml match)
|
||||
#:use-module ((sxml xpath) :prefix xpath:)
|
||||
#:use-module (srfi srfi-9)
|
||||
#:use-module (srfi srfi-19)
|
||||
#:use-module (ice-9 textual-ports)
|
||||
#:use-module (ice-9 match)
|
||||
|
||||
#:export (<atom-feed-entry>
|
||||
make-atom-feed-entry
|
||||
entry-title
|
||||
entry-description
|
||||
entry-link
|
||||
entry-date
|
||||
|
||||
request-feed
|
||||
|
||||
process-atom-feed-response))
|
||||
|
||||
;;
|
||||
;; Date format
|
||||
;;
|
||||
|
||||
(define atom-date-format "~a, ~d ~b ~Y ~H:~M:~S ~z")
|
||||
|
||||
;;
|
||||
;; Atom feed retrieval function
|
||||
;;
|
||||
|
||||
(define (request-feed uri)
|
||||
(let* ((raw-response (http-get uri #:decode-body? #f #:streaming? #t))
|
||||
(response-code (response-code raw-response))
|
||||
(response-content-type
|
||||
(symbol->string
|
||||
(car (response-content-type raw-response)))))
|
||||
(if (and
|
||||
(= response-code 200)
|
||||
(or (string-suffix? "/xml" response-content-type)
|
||||
(string-suffix? "/rss+xml" response-content-type)))
|
||||
(xml->sxml
|
||||
(get-string-all (response-body-port raw-response #:decode? #f)))
|
||||
#f)))
|
||||
|
||||
;;
|
||||
;; Atom feed entry
|
||||
;;
|
||||
|
||||
(define-record-type <atom-feed-entry>
|
||||
(make-atom-feed-entry title description link date)
|
||||
atom-feed-entry?
|
||||
(title entry-title)
|
||||
(description entry-description)
|
||||
(link entry-link)
|
||||
(date entry-date))
|
||||
|
||||
|
||||
;;
|
||||
;; Atom feed specific methods
|
||||
;;
|
||||
|
||||
(define (atom-feed-rss tree)
|
||||
(let ((tree-rss (filter (lambda (t)
|
||||
(and (list? t)
|
||||
(eq? 'rss (car t))))
|
||||
tree)))
|
||||
(match tree-rss
|
||||
('() #f)
|
||||
(_ (car tree-rss)))))
|
||||
|
||||
(define (atom-feed-channel tree)
|
||||
(let ((tree-channel
|
||||
(filter (lambda (t)
|
||||
(and (list? t)
|
||||
(eq? 'channel (car t))))
|
||||
tree)))
|
||||
(match tree-channel
|
||||
('() #f)
|
||||
(_ (car tree-channel)))))
|
||||
|
||||
(define (get-title tree)
|
||||
(let ((tree-channel-title
|
||||
(filter (lambda (t)
|
||||
(and (list? t)
|
||||
(eq? 'title (car t))))
|
||||
tree)))
|
||||
(match tree-channel-title
|
||||
('() #f)
|
||||
(_ (cadar tree-channel-title)))))
|
||||
|
||||
(define (get-items tree)
|
||||
(filter (lambda (t)
|
||||
(and (list? t)
|
||||
(eq? 'item (car t))))
|
||||
tree))
|
||||
|
||||
(define (get-entry-value entry-value)
|
||||
(match entry-value
|
||||
('() #f)
|
||||
(_ (sxml-match
|
||||
(car entry-value)
|
||||
((title ,f-title) f-title)
|
||||
((link ,f-link) f-link)
|
||||
((description ,f-description) f-description)
|
||||
((pubDate ,f-pub-date) f-pub-date)
|
||||
(,otherwise #f)))))
|
||||
|
||||
(define (parse-atom-feed-entry tree)
|
||||
;; (use-modules (sxml xpath:sxpath))
|
||||
(let* ((title (get-entry-value ((xpath:sxpath '(title)) tree)))
|
||||
(link (get-entry-value ((xpath:sxpath '(link)) tree)))
|
||||
(description (get-entry-value ((xpath:sxpath '(description)) tree)))
|
||||
(pub-date (date->string
|
||||
(string->date
|
||||
(get-entry-value ((xpath:sxpath '(pubDate)) tree))
|
||||
atom-date-format)
|
||||
db:db-date-format)))
|
||||
(make-atom-feed-entry
|
||||
title (string-trim-both description) link pub-date)))
|
||||
|
||||
;;
|
||||
;; Final processor that returns atom feed entries
|
||||
;;
|
||||
|
||||
(define (process-atom-feed-response response)
|
||||
(let* ((rss (atom-feed-rss response))
|
||||
(channel (and=> rss atom-feed-channel))
|
||||
(channel-title (and=> channel get-title))
|
||||
(channel-items (and=> channel get-items)))
|
||||
(map (lambda (i) (parse-atom-feed-entry i))
|
||||
channel-items)))
|
|
@ -0,0 +1,24 @@
|
|||
;;
|
||||
;; Copyright © 2021 kitzman <kitzman @ disroot . org>
|
||||
;;
|
||||
|
||||
|
||||
(define-module (lieferhund util)
|
||||
#:export (call-with-temporary-output-file))
|
||||
|
||||
;;
|
||||
;; Util functions (copyright guix?)
|
||||
;;
|
||||
|
||||
(define (call-with-temporary-output-file proc)
|
||||
(let* ((directory (or (getenv "TMPDIR") "/tmp"))
|
||||
(template (string-append directory "/lieferhund.XXXXXX"))
|
||||
(out (mkstemp! template)))
|
||||
(dynamic-wind
|
||||
(lambda ()
|
||||
#t)
|
||||
(lambda ()
|
||||
(proc template out))
|
||||
(lambda ()
|
||||
(false-if-exception (close out))
|
||||
(false-if-exception (delete-file template))))))
|
Loading…
Reference in New Issue