Compare commits
56 Commits
Author | SHA1 | Date |
---|---|---|
Michele Guerini Rocco | dd3bc74708 | |
Michele Guerini Rocco | 6bcaff8b3a | |
Michele Guerini Rocco | 2c5ec3e9f6 | |
Michele Guerini Rocco | d460c73bd0 | |
Michele Guerini Rocco | 2f926c6a71 | |
Michele Guerini Rocco | da107970fb | |
Michele Guerini Rocco | 7e1e95fa2a | |
Michele Guerini Rocco | 7fdfb25ce0 | |
Michele Guerini Rocco | 101f5c06af | |
Michele Guerini Rocco | 5108b035a4 | |
Michele Guerini Rocco | fc3b5ba642 | |
Michele Guerini Rocco | ade3c55ad2 | |
Michele Guerini Rocco | 12fc50b89e | |
Michele Guerini Rocco | f6f9ea1a17 | |
Michele Guerini Rocco | 7b262e01d0 | |
Michele Guerini Rocco | ff71b46e0c | |
Michele Guerini Rocco | 15f034806e | |
Michele Guerini Rocco | c6b9d4e6b3 | |
rnhmjoj | 648d5ea305 | |
rnhmjoj | 0d84d2d6b9 | |
rnhmjoj | f29cdcb3c2 | |
rnhmjoj | 56b0689b04 | |
rnhmjoj | 0e9c0f45e0 | |
rnhmjoj | a0bf4807a0 | |
Michele Guerini Rocco | 7c4da1cdd9 | |
rnhmjoj | ee8928aa57 | |
rnhmjoj | 62c572e887 | |
Michele Guerini Rocco | d43766e9b2 | |
rnhmjoj | 8aa30604cd | |
rnhmjoj | 44b28de95e | |
rnhmjoj | 6308071545 | |
rnhmjoj | 4040f8e1f7 | |
rnhmjoj | 0e4bb4024d | |
rnhmjoj | 0401ccd128 | |
rnhmjoj | 2f8adbefe9 | |
rnhmjoj | 4fde041902 | |
rnhmjoj | f5f40218d8 | |
rnhmjoj | 740bbacc4d | |
rnhmjoj | 868f80b5a1 | |
Michele Guerini Rocco | 9f0e3c902c | |
Michele Guerini Rocco | dc84ecf71a | |
rnhmjoj | 7b17934ea1 | |
rnhmjoj | 96b52fcdea | |
rnhmjoj | 19e71ff950 | |
rnhmjoj | b4d697a0dd | |
rnhmjoj | 284ce1c7f2 | |
rnhmjoj | 9ecf6b4098 | |
rnhmjoj | 0529012574 | |
rnhmjoj | 9857fca38e | |
rnhmjoj | 257e94f474 | |
rnhmjoj | ab9ef4e277 | |
rnhmjoj | cf13f66dea | |
rnhmjoj | 2d6220b593 | |
rnhmjoj | cd478b74fe | |
rnhmjoj | f6483b34ec | |
rnhmjoj | 0e73049009 |
|
@ -1,16 +1,3 @@
|
||||||
dist
|
dist
|
||||||
cabal-dev
|
result
|
||||||
*.o
|
default.nix
|
||||||
*.hi
|
|
||||||
*.chi
|
|
||||||
*.chs.h
|
|
||||||
*.dyn_o
|
|
||||||
*.dyn_hi
|
|
||||||
.virtualenv
|
|
||||||
.hpc
|
|
||||||
.hsenv
|
|
||||||
.cabal-sandbox/
|
|
||||||
cabal.sandbox.config
|
|
||||||
*.prof
|
|
||||||
*.aux
|
|
||||||
*.hp
|
|
||||||
|
|
677
LICENSE
677
LICENSE
|
@ -1,3 +1,674 @@
|
||||||
Dual licensed under the MIT and GPL licenses:
|
GNU GENERAL PUBLIC LICENSE
|
||||||
http://www.opensource.org/licenses/mit-license.php
|
Version 3, 29 June 2007
|
||||||
http://www.gnu.org/licenses/gpl.html
|
|
||||||
|
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>.
|
||||||
|
|
25
README.md
25
README.md
|
@ -4,6 +4,8 @@
|
||||||
Breve is a web application that provides a simple interface to
|
Breve is a web application that provides a simple interface to
|
||||||
shortening long urls creating links smaller and easier to remember.
|
shortening long urls creating links smaller and easier to remember.
|
||||||
|
|
||||||
|
You can find a running instance on [brve.bit](https://brve.bit)
|
||||||
|
|
||||||
It creates links in the form of "/emeaoinqua": easier to remember than
|
It creates links in the form of "/emeaoinqua": easier to remember than
|
||||||
alphanumeric strings like "/1Cqw8lHw" used by several services.
|
alphanumeric strings like "/1Cqw8lHw" used by several services.
|
||||||
|
|
||||||
|
@ -19,26 +21,39 @@ and start it with
|
||||||
|
|
||||||
$ breve
|
$ breve
|
||||||
|
|
||||||
The app will start serving on `http://localhost:3000`, listening on every active interface.
|
The app will start serving on `https://localhost:3000`, listening on every active interface.
|
||||||
|
|
||||||
## Configure
|
## Configure
|
||||||
|
|
||||||
You can change the options by editing the config file.
|
You can change the options by editing the config file.
|
||||||
When you start the app an empty one will be created in:
|
When you start the app an empty one will be created in:
|
||||||
`$XDG_CONFIG_HOME/breve` or `~/.config/breve` if unset.
|
`$XDG_CONFIG_HOME/breve`, `~/.config/breve` if unset,
|
||||||
|
or you can pass a path as the first argument of breve.
|
||||||
|
|
||||||
The default values are:
|
The default values are:
|
||||||
|
|
||||||
```ini
|
```ini
|
||||||
hostname = "localhost"
|
hostname = "localhost"
|
||||||
port = 3000
|
port = 3000
|
||||||
|
baseurl = "https://localhost:3000/"
|
||||||
urltable = "$XDG_CONFIG_HOME/breve"
|
urltable = "$XDG_CONFIG_HOME/breve"
|
||||||
|
tls {
|
||||||
|
cert = "/usr/share/tls/breve.crt"
|
||||||
|
key = "/usr/share/tls/breve.key"
|
||||||
|
chain = []
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
`urltable` is the location of breve url hashtable
|
`urltable` is the location of breve url hashtable
|
||||||
|
|
||||||
|
`chain` is a list of chain certificate files
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Dual licensed under the MIT and GPL licenses:
|
Copyright (C) 2019 Michele Guerini Rocco
|
||||||
http://www.opensource.org/licenses/mit-license.php
|
|
||||||
http://www.gnu.org/licenses/gpl.html
|
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/.
|
||||||
|
|
48
breve.cabal
48
breve.cabal
|
@ -1,39 +1,43 @@
|
||||||
name: breve
|
name: breve
|
||||||
version: 0.2.0.0
|
version: 0.5.0.0
|
||||||
synopsis: a url shortener
|
synopsis: a url shortener
|
||||||
description:
|
description:
|
||||||
|
|
||||||
Breve is a web application that provides a simple interface to
|
Breve is a web application that provides a simple interface to
|
||||||
shortening long urls creating links smaller and easier to remember.
|
shortening long urls creating links smaller and easier to remember.
|
||||||
|
|
||||||
homepage: https://github.com/rnhmjoj/breve
|
homepage: https://maxwell.ydns.eu/git/rnhmjoj/breve
|
||||||
license: MIT
|
license: GPL-3
|
||||||
license-file: LICENSE
|
license-file: LICENSE
|
||||||
author: Rnhmjoj
|
author: rnhmjoj
|
||||||
maintainer: micheleguerinirocco@me.com
|
maintainer: rnhmjoj@inventati.org
|
||||||
copyright: (C) Michele Guerini Rocco 2015
|
copyright: (C) Michele Guerini Rocco 2019
|
||||||
category: Web
|
category: Web
|
||||||
build-type: Simple
|
build-type: Simple
|
||||||
extra-source-files: README.md, LICENSE
|
extra-source-files: README.md, LICENSE
|
||||||
data-files: static/*.png, static/*.html, static/*.css,
|
data-files: static/*.png, static/*.css static/*.woff
|
||||||
views/*.html
|
|
||||||
cabal-version: >=1.10
|
cabal-version: >=1.10
|
||||||
|
|
||||||
source-repository head
|
source-repository head
|
||||||
type: git
|
type: git
|
||||||
location: https://github.com/rnhmjoj/breve
|
location: https://maxwell.ydns.eu/git/rnhmjoj/breve
|
||||||
|
|
||||||
executable breve
|
executable breve
|
||||||
main-is: Main.hs
|
main-is: Main.hs
|
||||||
hs-source-dirs: src
|
hs-source-dirs: src
|
||||||
default-language: Haskell2010
|
default-language: Haskell2010
|
||||||
other-modules: Application, Breve.Common,
|
other-modules: Application, Views, Breve.Settings,
|
||||||
Breve.Generator, Breve.UrlTable
|
Breve.Generator, Breve.UrlTable,
|
||||||
other-extensions: OverloadedStrings
|
Paths_breve
|
||||||
build-depends: base >=4.8 && <5.0,
|
default-extensions: OverloadedStrings
|
||||||
simple, wai, wai-extra, warp,
|
other-extensions: RecordWildCards, DeriveGeneric,
|
||||||
aeson, bytestring, binary,
|
DataKinds, KindSignatures, TypeOperators
|
||||||
transformers, mtl,
|
build-depends: base >=4.8 && <5.0,
|
||||||
hashtables, cryptohash, random,
|
warp, warp-tls, tls, blaze-html,
|
||||||
xdg-basedir, configurator, directory
|
servant-server, servant-rawm, servant-blaze,
|
||||||
ghc-options: -threaded -O2
|
wai, wai-extra, streaming-commons, http-api-data,
|
||||||
|
|
||||||
|
mtl, text, aeson, bytestring, binary,
|
||||||
|
hashtables, cryptohash, random,
|
||||||
|
configurator, directory
|
||||||
|
ghc-options: -threaded -O2 "-with-rtsopts=-N -qg"
|
||||||
|
|
|
@ -1,68 +1,205 @@
|
||||||
{-# LANGUAGE OverloadedStrings, RecordWildCards #-}
|
{-# LANGUAGE DataKinds #-}
|
||||||
|
{-# LANGUAGE KindSignatures #-}
|
||||||
|
{-# LANGUAGE TypeOperators #-}
|
||||||
|
{-# LANGUAGE DeriveGeneric #-}
|
||||||
|
|
||||||
|
{-|
|
||||||
|
This module contains the web application
|
||||||
|
and API implementation of Breve.
|
||||||
|
-}
|
||||||
module Application where
|
module Application where
|
||||||
|
|
||||||
import Breve.Common
|
-- Breve modules
|
||||||
|
import Breve.Generator
|
||||||
import Breve.UrlTable
|
import Breve.UrlTable
|
||||||
import Paths_breve (getDataFileName)
|
import Views
|
||||||
|
|
||||||
import Web.Frank
|
-- Misc
|
||||||
import Web.Simple
|
import Control.Monad.IO.Class (liftIO)
|
||||||
import Web.Simple.Static (serveStatic)
|
import Control.Monad.Reader (ReaderT, runReaderT, asks)
|
||||||
import Web.Simple.Templates (render)
|
import qualified Data.Text.IO as T
|
||||||
|
|
||||||
import Control.Monad.IO.Class (liftIO)
|
-- JSON conversion
|
||||||
import Text.Printf (printf)
|
import Data.Text (Text)
|
||||||
import Data.Aeson
|
import Data.Aeson (ToJSON)
|
||||||
import qualified Data.ByteString.Lazy.Char8 as BL
|
import GHC.Generics (Generic)
|
||||||
import qualified Data.ByteString.Char8 as BS
|
|
||||||
|
|
||||||
logStr = liftIO . putStrLn
|
-- HTML replies
|
||||||
|
import Text.Blaze.Html5 (Html)
|
||||||
|
import Text.Blaze.Html.Renderer.Utf8 (renderHtml)
|
||||||
|
|
||||||
app :: (Application -> IO ()) -> IO ()
|
-- API definition
|
||||||
app runner = do
|
import Servant
|
||||||
settings <- newAppSettings
|
import Servant.HTML.Blaze (HTML)
|
||||||
ServerSettings {..} <- newServerSettings
|
import Servant.RawM as R
|
||||||
table <- load urlTable
|
import Web.FormUrlEncoded (FromForm(..), parseUnique)
|
||||||
|
|
||||||
static <- getDataFileName "static/"
|
|
||||||
index <- getDataFileName "views/index.html"
|
|
||||||
done <- getDataFileName "views/done.html"
|
|
||||||
|
|
||||||
runner $ controllerApp settings $ do
|
-- * Types
|
||||||
get "/" (render index ())
|
|
||||||
|
|
||||||
get "/:file" $ do
|
-- | Custom handler type with a
|
||||||
file <- queryParam' "file"
|
-- reader environment
|
||||||
serveStatic (static ++ file)
|
type AppM = ReaderT AppEnv Handler
|
||||||
|
|
||||||
get "/:name" $ do
|
-- | The environment associated
|
||||||
name <- queryParam' "name"
|
-- to 'AppM'
|
||||||
url <- liftIO (extract table name)
|
data AppEnv = AppEnv
|
||||||
case url of
|
{ bindUrl :: Text
|
||||||
Just url -> do
|
, urlTable :: UrlTable
|
||||||
logStr (printf "Resolved %s -> %s" name url)
|
, staticDir :: FilePath
|
||||||
respond $ redirectTo (BS.pack url)
|
}
|
||||||
Nothing -> respond notFound
|
|
||||||
|
|
||||||
post "/" $ do
|
-- | API successful reply
|
||||||
form <- fst <$> parseForm
|
--
|
||||||
case lookup "url" form of
|
-- This is the reply returned by the JSON API
|
||||||
Nothing -> respond badRequest
|
-- handler when the url has been shortned
|
||||||
Just url' -> do
|
-- successfully.
|
||||||
let url = BS.unpack url'
|
data ApiReply = ApiReply
|
||||||
name <- liftIO (insert table url)
|
{ link :: Url -- ^ shortened url
|
||||||
logStr (printf "Registered %s -> %s " url name)
|
, name :: Name -- ^ just the name
|
||||||
render done $ object ["link" .= (bindUrl ++ name)]
|
, original :: Url -- ^ original url
|
||||||
|
} deriving Generic
|
||||||
|
|
||||||
post "/api" $ do
|
instance ToJSON ApiReply
|
||||||
form <- fst <$> parseForm
|
|
||||||
case lookup "url" form of
|
-- | This type is just a wrapper around a 'Text'
|
||||||
Nothing -> respond badRequest
|
-- value. It's used to create a 'FromForm' instance
|
||||||
Just url' -> do
|
-- for a 'Url'.
|
||||||
let url = BS.unpack url'
|
newtype UrlForm = UrlForm Text
|
||||||
name <- liftIO (insert table url)
|
|
||||||
logStr (printf "Registered %s -> %s " url name)
|
instance FromForm UrlForm where
|
||||||
let json = object [ "link" .= (bindUrl ++ name)
|
fromForm f = UrlForm <$> parseUnique "url" f
|
||||||
, "name" .= name
|
|
||||||
, "original" .= url ]
|
|
||||||
respond $ okHtml (encode json)
|
-- * Breve API
|
||||||
|
|
||||||
|
-- | API spec
|
||||||
|
--
|
||||||
|
-- Breve has two main components:
|
||||||
|
--
|
||||||
|
-- 1. the web app
|
||||||
|
-- 2. the JSON API itself
|
||||||
|
type Breve = API :<|> App
|
||||||
|
|
||||||
|
-- | Web app spec
|
||||||
|
--
|
||||||
|
-- +----------+------+----------------------+
|
||||||
|
-- | path | type | description |
|
||||||
|
-- +==========+======+======================+
|
||||||
|
-- | / | GET | homepage |
|
||||||
|
-- +----------+------+----------------------+
|
||||||
|
-- | / | POST | upload a new url |
|
||||||
|
-- +----------+------+----------------------+
|
||||||
|
-- | /static | GET | static assets |
|
||||||
|
-- +----------+------+----------------------+
|
||||||
|
-- | /:name | GET | resolves a short url |
|
||||||
|
-- +----------+------+----------------------+
|
||||||
|
type App =
|
||||||
|
Get '[HTML] Html
|
||||||
|
:<|> "static" :> RawM
|
||||||
|
:<|> Capture "name" Name :> Redirect
|
||||||
|
:<|> ReqBody '[FormUrlEncoded] UrlForm :> Post '[HTML] Html
|
||||||
|
|
||||||
|
-- | JSON API spec
|
||||||
|
--
|
||||||
|
-- +----------+------+----------------------+
|
||||||
|
-- | path | type | description |
|
||||||
|
-- +==========+======+======================+
|
||||||
|
-- | /api | POST | upload a new url |
|
||||||
|
-- +----------+------+----------------------+
|
||||||
|
type API =
|
||||||
|
"api" :> ReqBody '[FormUrlEncoded] UrlForm :> Post '[JSON] ApiReply
|
||||||
|
|
||||||
|
-- | Breve application
|
||||||
|
--
|
||||||
|
-- Notes:
|
||||||
|
--
|
||||||
|
-- * @api@ is an empty value that brings the type
|
||||||
|
-- 'Breve' to the 'serve' function. If Haskell were
|
||||||
|
-- depedently typed it would just be @serve Breve@
|
||||||
|
--
|
||||||
|
-- * hoistServer flattens the AppM monad stack
|
||||||
|
-- in the breveServer definition
|
||||||
|
breve :: AppEnv -> Application
|
||||||
|
breve env = serve api (hoistServer api nt breveServer)
|
||||||
|
where api = Proxy :: Proxy Breve
|
||||||
|
nt x = runReaderT x env
|
||||||
|
|
||||||
|
-- | Empty application
|
||||||
|
--
|
||||||
|
-- This app does *nothing* but it's useful nonetheless:
|
||||||
|
-- it will be used as a basis to run the 'forceSSL'
|
||||||
|
-- middleware.
|
||||||
|
emptyApp :: Application
|
||||||
|
emptyApp = serve (Proxy :: Proxy EmptyAPI) emptyServer
|
||||||
|
|
||||||
|
-- * Handlers
|
||||||
|
|
||||||
|
-- | Breve server
|
||||||
|
--
|
||||||
|
-- This is just an ordered collection of handlers
|
||||||
|
-- following the 'Breve' API spec.
|
||||||
|
--
|
||||||
|
-- Note: 'RawM' is required because Servant doesn't
|
||||||
|
-- allow the creation of a raw 'Application' from a
|
||||||
|
-- monadic value.
|
||||||
|
breveServer :: ServerT Breve AppM
|
||||||
|
breveServer = api :<|> app
|
||||||
|
where app = homepage
|
||||||
|
:<|> (R.serveDirectoryWebApp =<< asks staticDir)
|
||||||
|
:<|> resolver
|
||||||
|
:<|> uploader
|
||||||
|
|
||||||
|
-- | Serves the homepage
|
||||||
|
homepage :: AppM Html
|
||||||
|
homepage = pure index
|
||||||
|
|
||||||
|
-- | Resolves a 'Name' to the full 'Url'
|
||||||
|
resolver :: Name -> AppM Redirection
|
||||||
|
resolver name = do
|
||||||
|
table <- asks urlTable
|
||||||
|
url <- liftIO (extract table name)
|
||||||
|
case url of
|
||||||
|
Nothing ->
|
||||||
|
throwError $ err404 { errBody = renderHtml (message "404: not found") }
|
||||||
|
Just url -> do
|
||||||
|
logStr ("Resolved " <> name <> " -> " <> url)
|
||||||
|
pure (addHeader url NoContent)
|
||||||
|
|
||||||
|
|
||||||
|
-- | Takes a 'UrlForm' via POST
|
||||||
|
-- and prints the shortned one
|
||||||
|
uploader :: UrlForm -> AppM Html
|
||||||
|
uploader (UrlForm url) = do
|
||||||
|
table <- asks urlTable
|
||||||
|
bind <- asks bindUrl
|
||||||
|
name <- liftIO (insert table url)
|
||||||
|
logStr ("Registered " <> url <> " -> " <> name)
|
||||||
|
pure (done $ bind <> name)
|
||||||
|
|
||||||
|
-- | Takes a 'Url' via POST and returns
|
||||||
|
-- the shortned one in an 'ApiReply' as JSON.
|
||||||
|
api :: UrlForm -> AppM ApiReply
|
||||||
|
api (UrlForm url) = do
|
||||||
|
table <- asks urlTable
|
||||||
|
bind <- asks bindUrl
|
||||||
|
name <- liftIO (insert table url)
|
||||||
|
logStr ("Registered " <> url <> " -> " <> name)
|
||||||
|
pure $ ApiReply { link = (bind <> name)
|
||||||
|
, name = name
|
||||||
|
, original = url
|
||||||
|
}
|
||||||
|
|
||||||
|
-- * Misc
|
||||||
|
|
||||||
|
-- | Handy function to log to stdout
|
||||||
|
logStr :: Text -> AppM ()
|
||||||
|
logStr = liftIO . T.putStrLn . ("[breve] " <>)
|
||||||
|
|
||||||
|
-- | Verb that encodes an HTTP 302 redirection
|
||||||
|
type Redirect =
|
||||||
|
Verb 'GET 302 '[PlainText] Redirection
|
||||||
|
|
||||||
|
-- | Reply with Location redirect header
|
||||||
|
type Redirection =
|
||||||
|
Headers '[Header "Location" Text] NoContent
|
||||||
|
|
|
@ -1,63 +0,0 @@
|
||||||
{-# LANGUAGE MultiParamTypeClasses, OverloadedStrings #-}
|
|
||||||
module Breve.Common where
|
|
||||||
|
|
||||||
import Paths_breve (getDataFileName)
|
|
||||||
|
|
||||||
import Control.Monad.IO.Class (liftIO)
|
|
||||||
import Control.Monad (when)
|
|
||||||
import Text.Printf (printf)
|
|
||||||
import System.Environment (lookupEnv)
|
|
||||||
import System.Environment.XDG.BaseDir
|
|
||||||
import System.Directory (doesFileExist)
|
|
||||||
import Data.Configurator
|
|
||||||
|
|
||||||
import Web.Simple.Templates
|
|
||||||
import Network.Wai.Handler.Warp
|
|
||||||
|
|
||||||
data ServerSettings = ServerSettings
|
|
||||||
{ bindHostname :: String
|
|
||||||
, bindPort :: Int
|
|
||||||
, bindUrl :: String
|
|
||||||
, urlTable :: FilePath
|
|
||||||
, warpSettings :: Settings
|
|
||||||
}
|
|
||||||
|
|
||||||
data AppSettings = AppSettings {}
|
|
||||||
|
|
||||||
instance HasTemplates IO AppSettings where
|
|
||||||
defaultLayout = do
|
|
||||||
main <- liftIO (getDataFileName "static/main.html")
|
|
||||||
Just <$> getTemplate main
|
|
||||||
|
|
||||||
|
|
||||||
createEmptyIfMissing :: FilePath -> IO ()
|
|
||||||
createEmptyIfMissing file = do
|
|
||||||
exists <- doesFileExist file
|
|
||||||
when (not exists) (writeFile file "")
|
|
||||||
|
|
||||||
|
|
||||||
newAppSettings :: IO AppSettings
|
|
||||||
newAppSettings = return AppSettings
|
|
||||||
|
|
||||||
|
|
||||||
newServerSettings :: IO ServerSettings
|
|
||||||
newServerSettings = do
|
|
||||||
urlsPath <- getUserDataFile "breve" ""
|
|
||||||
configPath <- getUserConfigFile "breve" ""
|
|
||||||
|
|
||||||
config <- load [Required configPath]
|
|
||||||
host <- lookupDefault "localhost" config "hostname"
|
|
||||||
port <- lookupDefault 3000 config "port"
|
|
||||||
urls <- lookupDefault urlsPath config "urltable"
|
|
||||||
|
|
||||||
createEmptyIfMissing urls
|
|
||||||
|
|
||||||
return ServerSettings
|
|
||||||
{ bindHostname = host
|
|
||||||
, bindPort = port
|
|
||||||
, bindUrl = if port == 80
|
|
||||||
then printf "http://%s/" host
|
|
||||||
else printf "http://%s:%d/" host port
|
|
||||||
, urlTable = urls
|
|
||||||
, warpSettings = setPort port defaultSettings
|
|
||||||
}
|
|
|
@ -1,36 +1,48 @@
|
||||||
module Breve.Generator
|
{-|
|
||||||
( nameHash
|
This module implements the algorithm
|
||||||
, intHash
|
by which a URL is converted into a word.
|
||||||
, Name
|
-}
|
||||||
|
module Breve.Generator
|
||||||
|
( Name
|
||||||
, Url
|
, Url
|
||||||
|
, nameHash
|
||||||
|
, intHash
|
||||||
) where
|
) where
|
||||||
|
|
||||||
import Control.Monad.State
|
import Control.Monad.State
|
||||||
import System.Random
|
import System.Random
|
||||||
import Crypto.Hash.SHA256 (hash)
|
import Crypto.Hash.SHA256 (hash)
|
||||||
import Data.Binary (decode)
|
import Data.Binary (decode)
|
||||||
import Data.ByteString.Char8 (pack)
|
|
||||||
import Data.ByteString.Lazy (fromStrict)
|
import Data.ByteString.Lazy (fromStrict)
|
||||||
|
import Data.Text (Text, pack)
|
||||||
|
import Data.Text.Encoding (encodeUtf8)
|
||||||
|
|
||||||
type Name = String
|
-- | A phonetic word associated to a URL
|
||||||
type Url = String
|
type Name = Text
|
||||||
|
|
||||||
-- Choose a random element of a list
|
-- | Any kind of URL
|
||||||
|
type Url = Text
|
||||||
|
|
||||||
|
-- | Takes a random element of a list
|
||||||
choice :: [a] -> State StdGen a
|
choice :: [a] -> State StdGen a
|
||||||
choice xs = (xs !!) <$> randomSt (0, length xs - 1)
|
choice xs = (xs !!) <$> randomSt (0, length xs - 1)
|
||||||
where randomSt = state . randomR
|
where randomSt = state . randomR
|
||||||
|
|
||||||
-- Generate a random phonetic string
|
-- | Generates a random phonetic string
|
||||||
word :: State StdGen Name
|
word :: State StdGen Name
|
||||||
word = replicateM 10 letter where
|
word = pack <$> replicateM 10 letter where
|
||||||
vowels = "aeiou"
|
vowels = "aeiou"
|
||||||
consonants = "bcdfghjklmnpqrstvwxyz"
|
consonants = "bcdfghjklmnpqrstvwxyz"
|
||||||
letter = choice [vowels, consonants] >>= choice
|
letter = choice [vowels, consonants] >>= choice
|
||||||
|
|
||||||
-- SHA256 hash to seed a generator
|
-- | SHA256 hash to seed a generator
|
||||||
intHash :: Url -> Int
|
intHash :: Url -> Int
|
||||||
intHash = decode . fromStrict . hash . pack
|
intHash = decode . fromStrict . hash . encodeUtf8
|
||||||
|
|
||||||
-- Assing a unique name to the url
|
-- | Assigns a unique name to the given URL
|
||||||
|
--
|
||||||
|
-- The result is a computation based on a RNG
|
||||||
|
-- seeded by URL itself and is therefore
|
||||||
|
-- deterministic.
|
||||||
nameHash :: Url -> Name
|
nameHash :: Url -> Name
|
||||||
nameHash = evalState word . mkStdGen . intHash
|
nameHash = evalState word . mkStdGen . intHash
|
||||||
|
|
|
@ -0,0 +1,76 @@
|
||||||
|
{-|
|
||||||
|
This module defines the Breve configuration
|
||||||
|
parser and application settings.
|
||||||
|
-}
|
||||||
|
module Breve.Settings
|
||||||
|
( AppSettings(..)
|
||||||
|
, createEmptyIfMissing
|
||||||
|
, settings
|
||||||
|
) where
|
||||||
|
|
||||||
|
import Paths_breve (getDataFileName)
|
||||||
|
|
||||||
|
import Control.Monad (when)
|
||||||
|
import System.Environment (lookupEnv)
|
||||||
|
import System.Directory (doesFileExist, getXdgDirectory, XdgDirectory(..))
|
||||||
|
import Data.Text (Text, pack)
|
||||||
|
import Data.Configurator
|
||||||
|
import Data.Monoid
|
||||||
|
|
||||||
|
import Network.Wai.Handler.WarpTLS (TLSSettings (..), tlsSettingsChain)
|
||||||
|
import Network.TLS (Version (..))
|
||||||
|
import Network.TLS.Extra (ciphersuite_strong)
|
||||||
|
|
||||||
|
-- | Breve settings
|
||||||
|
data AppSettings = AppSettings
|
||||||
|
{ bindHost :: Text -- ^ the host to bind to
|
||||||
|
, bindPort :: Int -- ^ the port to bind to
|
||||||
|
, bindUrl :: Text -- ^ the url used to reach breve
|
||||||
|
, urlTable :: FilePath -- ^ path where to save the url table
|
||||||
|
, staticDir :: FilePath -- ^ path of the static assets
|
||||||
|
, tlsSettings :: TLSSettings -- ^ warp TLS settings
|
||||||
|
}
|
||||||
|
|
||||||
|
-- | Initialises a file if it doesn't exist
|
||||||
|
createEmptyIfMissing :: FilePath -> IO ()
|
||||||
|
createEmptyIfMissing file = do
|
||||||
|
exists <- doesFileExist file
|
||||||
|
when (not exists) (writeFile file "")
|
||||||
|
|
||||||
|
-- | Configuration file parser
|
||||||
|
settings :: Maybe FilePath -> IO AppSettings
|
||||||
|
settings path = do
|
||||||
|
configPath <- case path of
|
||||||
|
Just path -> return path
|
||||||
|
Nothing -> getXdgDirectory XdgConfig "breve"
|
||||||
|
|
||||||
|
urlsPath <- getXdgDirectory XdgData "breve"
|
||||||
|
|
||||||
|
config <- load [Required configPath]
|
||||||
|
host <- lookupDefault "localhost" config "hostname"
|
||||||
|
portnum <- lookupDefault 3000 config "port"
|
||||||
|
urls <- lookupDefault urlsPath config "urltable"
|
||||||
|
cert <- lookupDefault "/usr/share/tls/breve.crt" config "tls.cert"
|
||||||
|
key <- lookupDefault "/usr/share/tls/breve.key" config "tls.key"
|
||||||
|
chain <- lookupDefault [] config "tls.chain"
|
||||||
|
|
||||||
|
let
|
||||||
|
port = if portnum == 443 then "" else ":" <> pack (show portnum)
|
||||||
|
url = "https://" <> host <> port <> "/"
|
||||||
|
|
||||||
|
baseURL <- lookupDefault url config "baseurl"
|
||||||
|
static <- getDataFileName "static/"
|
||||||
|
|
||||||
|
createEmptyIfMissing urls
|
||||||
|
|
||||||
|
return AppSettings
|
||||||
|
{ bindHost = host
|
||||||
|
, bindPort = portnum
|
||||||
|
, bindUrl = baseURL
|
||||||
|
, urlTable = urls
|
||||||
|
, staticDir = static
|
||||||
|
, tlsSettings = (tlsSettingsChain cert chain key)
|
||||||
|
{ tlsAllowedVersions = [TLS12, TLS11]
|
||||||
|
, tlsCiphers = ciphersuite_strong
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,6 +1,11 @@
|
||||||
|
{-|
|
||||||
|
This modules defines the data structure used
|
||||||
|
to store the URLs in memory and on disk.
|
||||||
|
-}
|
||||||
module Breve.UrlTable
|
module Breve.UrlTable
|
||||||
( UrlTable
|
( UrlTable
|
||||||
, load
|
, load
|
||||||
|
, save
|
||||||
, insert
|
, insert
|
||||||
, extract
|
, extract
|
||||||
) where
|
) where
|
||||||
|
@ -12,16 +17,29 @@ import Control.Concurrent (forkIO, threadDelay)
|
||||||
import Text.Read (readMaybe)
|
import Text.Read (readMaybe)
|
||||||
import qualified Data.HashTable.IO as H
|
import qualified Data.HashTable.IO as H
|
||||||
|
|
||||||
|
-- | The hash table that stores URLs
|
||||||
type UrlTable = H.CuckooHashTable Name Url
|
type UrlTable = H.CuckooHashTable Name Url
|
||||||
|
|
||||||
-- Periodically write a url table to a file
|
-- | Periodically save a 'UrlTable' to a file
|
||||||
sync :: UrlTable -> FilePath -> IO ()
|
sync :: UrlTable -> FilePath -> IO ()
|
||||||
sync table file = forever $ do
|
sync table file = forever $ do
|
||||||
threadDelay (round 3.0e8)
|
threadDelay (round 3.0e8)
|
||||||
|
save table file
|
||||||
|
|
||||||
|
-- | Writes a 'UrlTable' to a file
|
||||||
|
--
|
||||||
|
-- The table is stored in a text file
|
||||||
|
-- as Haskell code for semplicity.
|
||||||
|
save :: UrlTable -> FilePath -> IO ()
|
||||||
|
save table file = do
|
||||||
content <- show <$> H.toList table
|
content <- show <$> H.toList table
|
||||||
writeFile file content
|
writeFile file content
|
||||||
|
putStrLn "\n[breve] url table synced."
|
||||||
|
|
||||||
-- Load a url table from a file
|
-- | Loads a URL table from a file
|
||||||
|
--
|
||||||
|
-- Once the file is loaded it will be synced
|
||||||
|
-- periodically (every 5min) on the disk.
|
||||||
load :: FilePath -> IO UrlTable
|
load :: FilePath -> IO UrlTable
|
||||||
load file = do
|
load file = do
|
||||||
content <- readFile file
|
content <- readFile file
|
||||||
|
@ -31,11 +49,11 @@ load file = do
|
||||||
forkIO (sync table file)
|
forkIO (sync table file)
|
||||||
return table
|
return table
|
||||||
|
|
||||||
-- Insert the url in a table and return the name
|
-- | Insert the URL in a table and return the name
|
||||||
insert :: UrlTable -> Url -> IO Name
|
insert :: UrlTable -> Url -> IO Name
|
||||||
insert table url = H.insert table new url >> return new
|
insert table url = H.insert table new url >> return new
|
||||||
where new = nameHash url
|
where new = nameHash url
|
||||||
|
|
||||||
-- Lookup a table for the associated url
|
-- | Lookup a table for the associated URL
|
||||||
extract :: UrlTable -> Name -> IO (Maybe Url)
|
extract :: UrlTable -> Name -> IO (Maybe Url)
|
||||||
extract = H.lookup
|
extract = H.lookup
|
||||||
|
|
79
src/Main.hs
79
src/Main.hs
|
@ -1,14 +1,75 @@
|
||||||
{-# LANGUAGE OverloadedStrings, RecordWildCards #-}
|
{-# LANGUAGE RecordWildCards #-}
|
||||||
|
|
||||||
import Application
|
{-|
|
||||||
import Breve.Common
|
This is the main module, which actually
|
||||||
|
run the Breve webserver.
|
||||||
|
-}
|
||||||
|
module Main where
|
||||||
|
|
||||||
import Control.Applicative
|
-- Breve modules
|
||||||
import Network.Wai.Handler.Warp
|
import Application (AppEnv(..), breve, emptyApp)
|
||||||
import Network.Wai.Middleware.RequestLogger
|
import Breve.Settings (AppSettings(..), settings)
|
||||||
|
import Breve.UrlTable
|
||||||
|
|
||||||
|
-- Data conversions
|
||||||
|
import Data.String (IsString(..))
|
||||||
|
import Data.Maybe (listToMaybe)
|
||||||
|
import Data.Text (unpack)
|
||||||
|
|
||||||
|
-- IO
|
||||||
|
import Data.Text.IO as T
|
||||||
|
import Control.Exception as E
|
||||||
|
import Control.Monad (when, void)
|
||||||
|
import Control.Concurrent (forkIO)
|
||||||
|
import System.Environment (getArgs)
|
||||||
|
|
||||||
|
-- Web server
|
||||||
|
import Servant (Application)
|
||||||
|
import Network.Wai.Handler.Warp (run, defaultSettings, setPort, setHost)
|
||||||
|
import Network.Wai.Handler.WarpTLS (runTLS)
|
||||||
|
|
||||||
|
-- Middlewares
|
||||||
|
import Network.Wai.Middleware.RequestLogger (logStdout)
|
||||||
|
import Network.Wai.Middleware.ForceSSL (forceSSL)
|
||||||
|
|
||||||
|
|
||||||
|
-- * Helpers
|
||||||
|
|
||||||
|
-- | Runs Breve on the Warp webserver
|
||||||
|
runApp :: AppSettings -> Application -> IO ()
|
||||||
|
runApp (AppSettings{..}) =
|
||||||
|
runTLS tlsSettings warpSettings
|
||||||
|
where
|
||||||
|
host = unpack bindHost
|
||||||
|
warpSettings = setPort bindPort $
|
||||||
|
setHost (fromString host) defaultSettings
|
||||||
|
|
||||||
|
-- | Main
|
||||||
|
--
|
||||||
|
-- Reads the configuration (given as the unique cli argument),
|
||||||
|
-- sets things accordingly and runs the webserver.
|
||||||
main :: IO ()
|
main :: IO ()
|
||||||
main = do
|
main = do
|
||||||
ServerSettings {..} <- newServerSettings
|
configPath <- fmap listToMaybe getArgs
|
||||||
putStrLn ("Serving on " ++ bindUrl)
|
config@(AppSettings{..}) <- settings configPath
|
||||||
app (runSettings warpSettings . logStdout)
|
table <- load urlTable
|
||||||
|
|
||||||
|
-- Redirect from HTTP to HTTPS when listening
|
||||||
|
-- on the standard port
|
||||||
|
when (bindPort == 443) $ void $
|
||||||
|
forkIO (run 80 $ forceSSL emptyApp)
|
||||||
|
|
||||||
|
-- Save the table just before exiting
|
||||||
|
let exit E.UserInterrupt = save table urlTable
|
||||||
|
exit e = throwIO e
|
||||||
|
|
||||||
|
-- Middlewares are functions (Application -> Application).
|
||||||
|
-- We use one here to add requests
|
||||||
|
let middlewares = logStdout
|
||||||
|
|
||||||
|
-- The environment needed while running
|
||||||
|
let env = AppEnv bindUrl table staticDir
|
||||||
|
|
||||||
|
handle exit $ do
|
||||||
|
T.putStrLn ("Serving on " <> bindUrl)
|
||||||
|
runApp config (middlewares $ breve env)
|
||||||
|
|
|
@ -0,0 +1,57 @@
|
||||||
|
{-|
|
||||||
|
This module contains the HTML pages used by the
|
||||||
|
web application. These are all obtained by filling
|
||||||
|
a single template with the page structure.
|
||||||
|
-}
|
||||||
|
module Views where
|
||||||
|
|
||||||
|
import Data.Text (Text)
|
||||||
|
import Text.Blaze.Html5 as H
|
||||||
|
import Text.Blaze.Html5.Attributes as A
|
||||||
|
|
||||||
|
-- | The homepage
|
||||||
|
index :: Html
|
||||||
|
index = template $ do
|
||||||
|
H.form ! method "POST" $ do
|
||||||
|
"your url:"
|
||||||
|
input ! type_ "text" ! name "url"
|
||||||
|
input ! type_ "submit" ! value "go"
|
||||||
|
|
||||||
|
-- | The page shown when a new url has been
|
||||||
|
-- submitted successfully. Takes the resulting
|
||||||
|
-- url as an argument.
|
||||||
|
done :: Text -> Html
|
||||||
|
done url = template $ do
|
||||||
|
"here's your new link: "
|
||||||
|
a ! href (toValue url) $ (toHtml url)
|
||||||
|
|
||||||
|
-- | Displays a text message in the page center
|
||||||
|
message :: Text -> Html
|
||||||
|
message = template . toHtml
|
||||||
|
|
||||||
|
-- | The main Breve template
|
||||||
|
--
|
||||||
|
-- Takes HTML code and embeds it in the
|
||||||
|
-- inner page container.
|
||||||
|
template :: Html -> Html
|
||||||
|
template fill =
|
||||||
|
docTypeHtml $ do
|
||||||
|
H.head $ do
|
||||||
|
H.title "breve: url shortener"
|
||||||
|
meta ! name "description" ! content "url shortener"
|
||||||
|
meta ! name "keywords" ! content "url, shortener"
|
||||||
|
meta ! name "author" ! content "Michele Guerini Rocco"
|
||||||
|
meta ! charset "utf-8"
|
||||||
|
link ! rel "stylesheet" ! href "/static/main.css" ! type_ "text/css"
|
||||||
|
link ! rel "apple-touch-icon" ! href "static/icon-big.png"
|
||||||
|
link ! rel "icon" ! type_ "image/png" ! href "/static/icon-medium.png" ! sizes "96x96"
|
||||||
|
link ! rel "icon" ! type_ "image/png" ! href "/static/icon-small.png" ! sizes "16x16"
|
||||||
|
body $ do
|
||||||
|
header $ do
|
||||||
|
h1 $ a ! href "/" $ "BREVE"
|
||||||
|
h2 "a url shortener"
|
||||||
|
H.div ! A.id "center" $ fill
|
||||||
|
footer $ do
|
||||||
|
"breve is "
|
||||||
|
a ! href "https://maxwell.ydns.eu/git/rnhmjoj/breve" $ "free software"
|
||||||
|
H.span "© rnhmjoj"
|
Binary file not shown.
Binary file not shown.
|
@ -1,5 +1,17 @@
|
||||||
@import url(http://fonts.googleapis.com/css?family=Inconsolata:400,700);
|
@import url('normalize.css');
|
||||||
@import url(https://cdn.rawgit.com/necolas/normalize.css/master/normalize.css);
|
|
||||||
|
@font-face {
|
||||||
|
font-family: Inconsolata;
|
||||||
|
src: local(Inconsolata),
|
||||||
|
url('inconsolata-regular.woff') format('woff');
|
||||||
|
}
|
||||||
|
|
||||||
|
@font-face {
|
||||||
|
font-family: Inconsolata;
|
||||||
|
font-weight: bold;
|
||||||
|
src: local(Inconsolata), local(Inconsolata Bold),
|
||||||
|
url('inconsolata-bold.woff') format('woff');
|
||||||
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
background-color: #181b20;
|
background-color: #181b20;
|
||||||
|
@ -47,6 +59,7 @@ input[type="text"] {
|
||||||
background: transparent;
|
background: transparent;
|
||||||
color: #776049;
|
color: #776049;
|
||||||
padding: 0 2px;
|
padding: 0 2px;
|
||||||
|
margin: 0 .5em;
|
||||||
}
|
}
|
||||||
|
|
||||||
input[type="submit"] {
|
input[type="submit"] {
|
||||||
|
@ -66,4 +79,4 @@ a:hover {
|
||||||
text-decoration: underline;
|
text-decoration: underline;
|
||||||
transition: color .5s ease;
|
transition: color .5s ease;
|
||||||
color: #775750;
|
color: #775750;
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
<title>breve: url shortener</title>
|
|
||||||
<meta name="description" content="url shortener">
|
|
||||||
<meta name="keywords" content="url, shortener">
|
|
||||||
<meta name="author" content="Michele Guerini Rocco">
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<link rel=stylesheet href="main.css" type="text/css">
|
|
||||||
<link rel="apple-touch-icon" href="icon-big.png">
|
|
||||||
<link rel="icon" type="image/png" href="/icon-medium.png" sizes="96x96">
|
|
||||||
<link rel="icon" type="image/png" href="/icon-small.png" sizes="16x16">
|
|
||||||
<script src="https://cdn.rawgit.com/LeaVerou/prefixfree/gh-pages/prefixfree.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<header>
|
|
||||||
<h1><a href="/">BREVE</a></h1>
|
|
||||||
<h2>a url shortener</h2>
|
|
||||||
</header>
|
|
||||||
<div id="center">$yield$</div>
|
|
||||||
<footer>
|
|
||||||
breve is open <a href="https://github.com/rnhmjoj/breve">source</a>
|
|
||||||
<span>© Rnhmjoj</span>
|
|
||||||
</footer>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
|
@ -0,0 +1,349 @@
|
||||||
|
/*! normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css */
|
||||||
|
|
||||||
|
/* Document
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Correct the line height in all browsers.
|
||||||
|
* 2. Prevent adjustments of font size after orientation changes in iOS.
|
||||||
|
*/
|
||||||
|
|
||||||
|
html {
|
||||||
|
line-height: 1.15; /* 1 */
|
||||||
|
-webkit-text-size-adjust: 100%; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Sections
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the margin in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Render the `main` element consistently in IE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
main {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Correct the font size and margin on `h1` elements within `section` and
|
||||||
|
* `article` contexts in Chrome, Firefox, and Safari.
|
||||||
|
*/
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 2em;
|
||||||
|
margin: 0.67em 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Grouping content
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Add the correct box sizing in Firefox.
|
||||||
|
* 2. Show the overflow in Edge and IE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
hr {
|
||||||
|
box-sizing: content-box; /* 1 */
|
||||||
|
height: 0; /* 1 */
|
||||||
|
overflow: visible; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Correct the inheritance and scaling of font size in all browsers.
|
||||||
|
* 2. Correct the odd `em` font sizing in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
pre {
|
||||||
|
font-family: monospace, monospace; /* 1 */
|
||||||
|
font-size: 1em; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Text-level semantics
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the gray background on active links in IE 10.
|
||||||
|
*/
|
||||||
|
|
||||||
|
a {
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Remove the bottom border in Chrome 57-
|
||||||
|
* 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.
|
||||||
|
*/
|
||||||
|
|
||||||
|
abbr[title] {
|
||||||
|
border-bottom: none; /* 1 */
|
||||||
|
text-decoration: underline; /* 2 */
|
||||||
|
text-decoration: underline dotted; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add the correct font weight in Chrome, Edge, and Safari.
|
||||||
|
*/
|
||||||
|
|
||||||
|
b,
|
||||||
|
strong {
|
||||||
|
font-weight: bolder;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Correct the inheritance and scaling of font size in all browsers.
|
||||||
|
* 2. Correct the odd `em` font sizing in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
code,
|
||||||
|
kbd,
|
||||||
|
samp {
|
||||||
|
font-family: monospace, monospace; /* 1 */
|
||||||
|
font-size: 1em; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add the correct font size in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
small {
|
||||||
|
font-size: 80%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Prevent `sub` and `sup` elements from affecting the line height in
|
||||||
|
* all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
sub,
|
||||||
|
sup {
|
||||||
|
font-size: 75%;
|
||||||
|
line-height: 0;
|
||||||
|
position: relative;
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
|
||||||
|
sub {
|
||||||
|
bottom: -0.25em;
|
||||||
|
}
|
||||||
|
|
||||||
|
sup {
|
||||||
|
top: -0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Embedded content
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the border on images inside links in IE 10.
|
||||||
|
*/
|
||||||
|
|
||||||
|
img {
|
||||||
|
border-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Forms
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Change the font styles in all browsers.
|
||||||
|
* 2. Remove the margin in Firefox and Safari.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button,
|
||||||
|
input,
|
||||||
|
optgroup,
|
||||||
|
select,
|
||||||
|
textarea {
|
||||||
|
font-family: inherit; /* 1 */
|
||||||
|
font-size: 100%; /* 1 */
|
||||||
|
line-height: 1.15; /* 1 */
|
||||||
|
margin: 0; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Show the overflow in IE.
|
||||||
|
* 1. Show the overflow in Edge.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button,
|
||||||
|
input { /* 1 */
|
||||||
|
overflow: visible;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the inheritance of text transform in Edge, Firefox, and IE.
|
||||||
|
* 1. Remove the inheritance of text transform in Firefox.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button,
|
||||||
|
select { /* 1 */
|
||||||
|
text-transform: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Correct the inability to style clickable types in iOS and Safari.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button,
|
||||||
|
[type="button"],
|
||||||
|
[type="reset"],
|
||||||
|
[type="submit"] {
|
||||||
|
-webkit-appearance: button;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the inner border and padding in Firefox.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button::-moz-focus-inner,
|
||||||
|
[type="button"]::-moz-focus-inner,
|
||||||
|
[type="reset"]::-moz-focus-inner,
|
||||||
|
[type="submit"]::-moz-focus-inner {
|
||||||
|
border-style: none;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Restore the focus styles unset by the previous rule.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button:-moz-focusring,
|
||||||
|
[type="button"]:-moz-focusring,
|
||||||
|
[type="reset"]:-moz-focusring,
|
||||||
|
[type="submit"]:-moz-focusring {
|
||||||
|
outline: 1px dotted ButtonText;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Correct the padding in Firefox.
|
||||||
|
*/
|
||||||
|
|
||||||
|
fieldset {
|
||||||
|
padding: 0.35em 0.75em 0.625em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Correct the text wrapping in Edge and IE.
|
||||||
|
* 2. Correct the color inheritance from `fieldset` elements in IE.
|
||||||
|
* 3. Remove the padding so developers are not caught out when they zero out
|
||||||
|
* `fieldset` elements in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
legend {
|
||||||
|
box-sizing: border-box; /* 1 */
|
||||||
|
color: inherit; /* 2 */
|
||||||
|
display: table; /* 1 */
|
||||||
|
max-width: 100%; /* 1 */
|
||||||
|
padding: 0; /* 3 */
|
||||||
|
white-space: normal; /* 1 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add the correct vertical alignment in Chrome, Firefox, and Opera.
|
||||||
|
*/
|
||||||
|
|
||||||
|
progress {
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the default vertical scrollbar in IE 10+.
|
||||||
|
*/
|
||||||
|
|
||||||
|
textarea {
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Add the correct box sizing in IE 10.
|
||||||
|
* 2. Remove the padding in IE 10.
|
||||||
|
*/
|
||||||
|
|
||||||
|
[type="checkbox"],
|
||||||
|
[type="radio"] {
|
||||||
|
box-sizing: border-box; /* 1 */
|
||||||
|
padding: 0; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Correct the cursor style of increment and decrement buttons in Chrome.
|
||||||
|
*/
|
||||||
|
|
||||||
|
[type="number"]::-webkit-inner-spin-button,
|
||||||
|
[type="number"]::-webkit-outer-spin-button {
|
||||||
|
height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Correct the odd appearance in Chrome and Safari.
|
||||||
|
* 2. Correct the outline style in Safari.
|
||||||
|
*/
|
||||||
|
|
||||||
|
[type="search"] {
|
||||||
|
-webkit-appearance: textfield; /* 1 */
|
||||||
|
outline-offset: -2px; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the inner padding in Chrome and Safari on macOS.
|
||||||
|
*/
|
||||||
|
|
||||||
|
[type="search"]::-webkit-search-decoration {
|
||||||
|
-webkit-appearance: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 1. Correct the inability to style clickable types in iOS and Safari.
|
||||||
|
* 2. Change font properties to `inherit` in Safari.
|
||||||
|
*/
|
||||||
|
|
||||||
|
::-webkit-file-upload-button {
|
||||||
|
-webkit-appearance: button; /* 1 */
|
||||||
|
font: inherit; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Interactive
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Add the correct display in Edge, IE 10+, and Firefox.
|
||||||
|
*/
|
||||||
|
|
||||||
|
details {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Add the correct display in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
summary {
|
||||||
|
display: list-item;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Misc
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add the correct display in IE 10+.
|
||||||
|
*/
|
||||||
|
|
||||||
|
template {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add the correct display in IE 10.
|
||||||
|
*/
|
||||||
|
|
||||||
|
[hidden] {
|
||||||
|
display: none;
|
||||||
|
}
|
|
@ -1 +0,0 @@
|
||||||
here's your new link: <a href="$link$">$link$</a>
|
|
|
@ -1,4 +0,0 @@
|
||||||
<form method="POST">
|
|
||||||
your url: <input type="text" name="url">
|
|
||||||
<input type="submit" value="go">
|
|
||||||
</form>
|
|
Loading…
Reference in New Issue