commit
054feab897
138 changed files with 263043 additions and 0 deletions
@ -0,0 +1 @@ |
|||
out |
|||
@ -0,0 +1,661 @@ |
|||
GNU AFFERO GENERAL PUBLIC LICENSE |
|||
Version 3, 19 November 2007 |
|||
|
|||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
|||
Everyone is permitted to copy and distribute verbatim copies |
|||
of this license document, but changing it is not allowed. |
|||
|
|||
Preamble |
|||
|
|||
The GNU Affero General Public License is a free, copyleft license for |
|||
software and other kinds of works, specifically designed to ensure |
|||
cooperation with the community in the case of network server software. |
|||
|
|||
The licenses for most software and other practical works are designed |
|||
to take away your freedom to share and change the works. By contrast, |
|||
our General Public Licenses are 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. |
|||
|
|||
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. |
|||
|
|||
Developers that use our General Public Licenses protect your rights |
|||
with two steps: (1) assert copyright on the software, and (2) offer |
|||
you this License which gives you legal permission to copy, distribute |
|||
and/or modify the software. |
|||
|
|||
A secondary benefit of defending all users' freedom is that |
|||
improvements made in alternate versions of the program, if they |
|||
receive widespread use, become available for other developers to |
|||
incorporate. Many developers of free software are heartened and |
|||
encouraged by the resulting cooperation. However, in the case of |
|||
software used on network servers, this result may fail to come about. |
|||
The GNU General Public License permits making a modified version and |
|||
letting the public access it on a server without ever releasing its |
|||
source code to the public. |
|||
|
|||
The GNU Affero General Public License is designed specifically to |
|||
ensure that, in such cases, the modified source code becomes available |
|||
to the community. It requires the operator of a network server to |
|||
provide the source code of the modified version running there to the |
|||
users of that server. Therefore, public use of a modified version, on |
|||
a publicly accessible server, gives the public access to the source |
|||
code of the modified version. |
|||
|
|||
An older license, called the Affero General Public License and |
|||
published by Affero, was designed to accomplish similar goals. This is |
|||
a different license, not a version of the Affero GPL, but Affero has |
|||
released a new version of the Affero GPL which permits relicensing under |
|||
this license. |
|||
|
|||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. |
|||
|
|||
Notwithstanding any other provision of this License, if you modify the |
|||
Program, your modified version must prominently offer all users |
|||
interacting with it remotely through a computer network (if your version |
|||
supports such interaction) an opportunity to receive the Corresponding |
|||
Source of your version by providing access to the Corresponding Source |
|||
from a network server at no charge, through some standard or customary |
|||
means of facilitating copying of software. This Corresponding Source |
|||
shall include the Corresponding Source for any work covered by version 3 |
|||
of the GNU General Public License that is incorporated pursuant to the |
|||
following paragraph. |
|||
|
|||
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 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 work with which it is combined will remain governed by version |
|||
3 of the GNU General Public License. |
|||
|
|||
14. Revised Versions of this License. |
|||
|
|||
The Free Software Foundation may publish revised and/or new versions of |
|||
the GNU Affero 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 Affero 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 Affero 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 Affero 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. |
|||
|
|||
A URL Shortener called Link. |
|||
Copyright (C) 2021 i@fsh.ee |
|||
|
|||
This program is free software: you can redistribute it and/or modify |
|||
it under the terms of the GNU Affero 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 Affero General Public License for more details. |
|||
|
|||
You should have received a copy of the GNU Affero General Public License |
|||
along with this program. If not, see <https://www.gnu.org/licenses/>. |
|||
|
|||
Also add information on how to contact you by electronic and paper mail. |
|||
|
|||
If your software can interact with users remotely through a computer |
|||
network, you should also make sure that it provides a way for users to |
|||
get its source. For example, if your program is a web application, its |
|||
interface could display a "Source" link that leads users to an archive |
|||
of the code. There are many ways you could offer source, and different |
|||
solutions will be better for different programs; see section 13 for the |
|||
specific requirements. |
|||
|
|||
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 AGPL, see |
|||
<https://www.gnu.org/licenses/>. |
|||
@ -0,0 +1 @@ |
|||
https://fsh.ee/ |
|||
@ -0,0 +1,8 @@ |
|||
module git.fsh.ee/i/link |
|||
|
|||
go 1.16 |
|||
|
|||
require ( |
|||
gorm.io/driver/sqlite v1.1.4 |
|||
gorm.io/gorm v1.21.9 |
|||
) |
|||
@ -0,0 +1,12 @@ |
|||
github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E= |
|||
github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc= |
|||
github.com/jinzhu/now v1.1.1/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8= |
|||
github.com/jinzhu/now v1.1.2 h1:eVKgfIdy9b6zbWBMgFpfDPoAMifwSZagU9HmEU6zgiI= |
|||
github.com/jinzhu/now v1.1.2/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8= |
|||
github.com/mattn/go-sqlite3 v1.14.5 h1:1IdxlwTNazvbKJQSxoJ5/9ECbEeaTTyeU7sEAZ5KKTQ= |
|||
github.com/mattn/go-sqlite3 v1.14.5/go.mod h1:WVKg1VTActs4Qso6iwGbiFih2UIHo0ENGwNd0Lj+XmI= |
|||
gorm.io/driver/sqlite v1.1.4 h1:PDzwYE+sI6De2+mxAneV9Xs11+ZyKV6oxD3wDGkaNvM= |
|||
gorm.io/driver/sqlite v1.1.4/go.mod h1:mJCeTFr7+crvS+TRnWc5Z3UvwxUN1BGBLMrf5LA9DYw= |
|||
gorm.io/gorm v1.20.7/go.mod h1:0HFTzE/SqkGTzK6TlDPPQbAYCluiVvhzoA1+aVyzenw= |
|||
gorm.io/gorm v1.21.9 h1:INieZtn4P2Pw6xPJ8MzT0G4WUOsHq3RhfuDF1M6GW0E= |
|||
gorm.io/gorm v1.21.9/go.mod h1:F+OptMscr0P2F2qU97WT1WimdH9GaQPoDW7AYd5i2Y0= |
|||
@ -0,0 +1,81 @@ |
|||
<!DOCTYPE html> |
|||
<html lang=en> |
|||
<head> |
|||
<title>A Minimal, SQLite-Backed URL Shortener</title> |
|||
<meta charset='utf-8'> |
|||
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'> |
|||
<meta http-equiv='Content-Type' content='text/html; charset=utf-8'> |
|||
<meta name='viewport' content='width=device-width, initial-scale=1'> |
|||
<meta content='A minimal, SQLite backed URL shortener. Made with Go, Vim, and FreeBSD.' name='description'> |
|||
</head> |
|||
<body style='font-family: monospace; max-width: 80ch;'> |
|||
|
|||
<header> |
|||
A Minimal, SQLite-Backed URL Shortener |
|||
</header> |
|||
|
|||
<style> |
|||
@media (max-width: 1000px) { |
|||
pre code { |
|||
display: block; |
|||
max-width: 100%%; |
|||
overflow-x: auto; |
|||
-webkit-overflow-scrolling: touch; |
|||
padding: 0 5px 5px 0; |
|||
} |
|||
} |
|||
</style> |
|||
|
|||
<pre><code>| Examples: |
|||
| |
|||
| 1. Create a short link to https://duckduckgo.com |
|||
| $ curl -d https://duckduckgo.com %s |
|||
| %s/502fb5543c36014f |
|||
| |
|||
| 2. Deleting a short link |
|||
| $ TMP=$(mktemp) |
|||
| $ # temp file will store header |
|||
| $ LINK=$(curl -sS %s -d https://duckduckgo.com -D $TMP) |
|||
| $ # the link has been successfully created |
|||
| $ DEL=$(cat $TMP | grep -i delete-with | awk '{print$2}'| tr -d '\r') |
|||
| $ # deletion key is stored in 'X-Delete-With' header. |
|||
| $ curl $LINK |
|||
| <a href="https://duckduckgo.com">Permanent Redirect</a>. |
|||
| $ # the link is working as expected |
|||
| $ curl $LINK -X DELETE -d $DEL |
|||
| $ curl $LINK |
|||
| record not found |
|||
| $ # the link has been successfully deleted.</code></pre> |
|||
|
|||
<p> |
|||
Please note: this is an example deployment. If you attempt to create a short |
|||
link here you will receive a 401 Unauthorized. If you like the examples above |
|||
and want to use this URL shortener you should self-host an instance. It's easy |
|||
to do (one of the design goals). Below are instructions detailing how. |
|||
<p> |
|||
|
|||
<pre><code>| How to self-host: |
|||
| |
|||
| 1. Install dependencies: |
|||
| a. The Go programming language: |
|||
| <a href='https://golang.org/doc/install'>https://golang.org/doc/install</a> |
|||
| b. Git version control. |
|||
| <a href='https://git-scm.com/book/en/v2/Getting-Started-Installing-Git'>https://git-scm.com/book/en/v2/Getting-Started-Installing-Git</a> |
|||
| |
|||
| * On FreeBSD this would be: |
|||
| $ pkg install -y go git |
|||
| |
|||
| 2. Fetch, complile, and execute the source code: |
|||
| $ env GO111MODULE=off go get git.fsh.ee/i/link |
|||
| $ env GO111MODULE=off go run git.fsh.ee/i/link -url https://your.domain.com -port 8080 -db /path/to/sqlite/file -seed secret |
|||
| |
|||
| * The server is now running on localhost at port 8080. |
|||
| * If the SQLite database at this filepath does not exist it will be created. |
|||
| * All logging will be printed to standard error and standard output.</code></pre> |
|||
|
|||
<footer style='white-space: pre;'>Source code: <a href='https://fsh.ee/src'>fsh.ee/src</a> |
|||
License: AGPL v3 |
|||
Copy: 2021 i@fsh.ee |
|||
Made with: Go, Vim, and FreeBSD |
|||
Unrelated blog: <a href='https://etc.fsh.ee/'>etc.fsh.ee</a> |
|||
</footer> |
|||
@ -0,0 +1,253 @@ |
|||
// A URL Shortener called Link.
|
|||
// Copyright (C) 2021 i@fsh.ee
|
|||
//
|
|||
// This program is free software: you can redistribute it and/or modify
|
|||
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
|||
//
|
|||
// You should have received a copy of the GNU Affero General Public License
|
|||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|||
package main |
|||
|
|||
import ( |
|||
"crypto/md5" |
|||
_ "embed" |
|||
"errors" |
|||
"flag" |
|||
"fmt" |
|||
"hash/maphash" |
|||
"io/ioutil" |
|||
"log" |
|||
"net/http" |
|||
"net/url" |
|||
"os" |
|||
"strconv" |
|||
"strings" |
|||
"time" |
|||
|
|||
"gorm.io/driver/sqlite" |
|||
"gorm.io/gorm" |
|||
"gorm.io/gorm/logger" |
|||
) |
|||
|
|||
//go:embed index.html
|
|||
var indexTemplate string |
|||
|
|||
type DB struct { |
|||
*gorm.DB |
|||
log *log.Logger |
|||
hashSeed string |
|||
} |
|||
|
|||
func NewDB(l *log.Logger, dbFilePath, hashSeed string) (DB, error) { |
|||
_, err := os.Stat(dbFilePath) |
|||
if os.IsNotExist(err) { |
|||
err := ioutil.WriteFile(dbFilePath, []byte{}, 0600) |
|||
if err != nil { |
|||
return DB{}, err |
|||
} |
|||
} |
|||
db, err := gorm.Open(sqlite.Open(dbFilePath), &gorm.Config{ |
|||
NowFunc: func() time.Time { return time.Now().UTC() }, |
|||
Logger: logger.Default.LogMode(logger.Silent), |
|||
}) |
|||
if err != nil { |
|||
return DB{}, err |
|||
} |
|||
return DB{db, l, hashSeed}, db.AutoMigrate(&Link{}) |
|||
} |
|||
|
|||
type Link struct { |
|||
gorm.Model |
|||
Big string |
|||
Smol string `gorm:"unique"` |
|||
Del string `gorm:"unique"` |
|||
} |
|||
|
|||
func (db DB) getHashShortLink(s fmt.Stringer) string { |
|||
h := maphash.Hash{} |
|||
h.WriteString(s.String()) |
|||
return strings.TrimSpace(strings.TrimLeft(fmt.Sprintf("%#x\n", h.Sum64()), "0x")) |
|||
} |
|||
|
|||
func (db DB) getHashDeleteKey(s fmt.Stringer) string { |
|||
return strings.TrimSpace(fmt.Sprintf("%x", md5.Sum([]byte(db.hashSeed+s.String()+strconv.FormatInt(time.Now().Unix(), 10))))) |
|||
} |
|||
|
|||
func (db DB) NewLink(u *url.URL) (Link, error) { |
|||
return db.NewLinkWithShortLink(u, db.getHashShortLink(u)) |
|||
} |
|||
|
|||
func (db DB) NewLinkWithShortLink(u *url.URL, hash string) (Link, error) { |
|||
var ( |
|||
link = Link{Big: u.String(), Smol: hash, Del: db.getHashDeleteKey(u)} |
|||
err = db.Create(&link).Error |
|||
) |
|||
// TODO: If error due to unique issue should attempt to retry a few times.
|
|||
if err != nil { |
|||
db.log.Println(err) |
|||
return Link{}, err |
|||
} |
|||
return link, nil |
|||
} |
|||
|
|||
func (db DB) GetLink(smol string) (l Link, e error) { |
|||
res := db.Where(&Link{Smol: smol}).First(&l) |
|||
return l, res.Error |
|||
} |
|||
|
|||
func (db DB) DelLink(smol, del string) error { |
|||
link, err := db.GetLink(smol) |
|||
if err != nil { |
|||
return err |
|||
} |
|||
res := db.Where(&Link{Del: del}).Delete(&link) |
|||
if res.RowsAffected < 1 { |
|||
return gorm.ErrRecordNotFound |
|||
} |
|||
return res.Error |
|||
} |
|||
|
|||
type controller struct { |
|||
log *log.Logger |
|||
db DB |
|||
url string |
|||
} |
|||
|
|||
func NewController(logger *log.Logger, db DB, url string) controller { |
|||
return controller{logger, db, strings.TrimRight(url, "/")} |
|||
} |
|||
|
|||
func (c controller) Err(rw http.ResponseWriter, r *http.Request, err error) { |
|||
if errors.Is(err, gorm.ErrRecordNotFound) { |
|||
rw.WriteHeader(http.StatusNotFound) |
|||
rw.Write([]byte(err.Error())) |
|||
return |
|||
} |
|||
c.log.Println(err) |
|||
rw.WriteHeader(http.StatusInternalServerError) |
|||
rw.Write([]byte(err.Error())) |
|||
} |
|||
|
|||
func (c controller) ServeHTTP(rw http.ResponseWriter, r *http.Request) { |
|||
switch r.Method { |
|||
|
|||
case http.MethodGet: |
|||
switch strings.TrimRight(r.URL.Path, "/") { |
|||
|
|||
case "": |
|||
rw.Header().Add("Content-Type", "text/html") |
|||
rw.Write([]byte(fmt.Sprintf(indexTemplate, c.url, c.url, c.url))) |
|||
return |
|||
|
|||
case "/favicon.ico": |
|||
http.NotFound(rw, r) |
|||
return |
|||
|
|||
default: |
|||
link, err := c.db.GetLink(strings.TrimLeft(r.URL.Path, "/")) |
|||
if err != nil { |
|||
c.Err(rw, r, err) |
|||
return |
|||
} |
|||
http.Redirect(rw, r, link.Big, http.StatusPermanentRedirect) |
|||
return |
|||
|
|||
} |
|||
|
|||
case http.MethodPost: |
|||
b, err := ioutil.ReadAll(r.Body) |
|||
if err != nil { |
|||
c.Err(rw, r, err) |
|||
return |
|||
} |
|||
u, err := url.Parse(string(b)) |
|||
if err != nil { |
|||
c.Err(rw, r, err) |
|||
return |
|||
} |
|||
if u.Scheme != "http" && u.Scheme != "https" { |
|||
rw.WriteHeader(http.StatusBadRequest) |
|||
rw.Write([]byte("URL must contain scheme. E.G. missing `http://` or `https://`.")) |
|||
return |
|||
} |
|||
var ( |
|||
link Link |
|||
h = strings.Trim(r.URL.Path, "/") |
|||
) |
|||
if h != "" { |
|||
link, err = c.db.NewLinkWithShortLink(u, h) |
|||
|
|||
} else { |
|||
link, err = c.db.NewLink(u) |
|||
} |
|||
if err != nil { |
|||
c.Err(rw, r, err) |
|||
return |
|||
} |
|||
rw.Header().Set("X-Delete-With", link.Del) |
|||
rw.WriteHeader(http.StatusFound) |
|||
rw.Write([]byte(fmt.Sprintf("%s/%s", c.url, link.Smol))) |
|||
return |
|||
|
|||
case http.MethodDelete: |
|||
b, err := ioutil.ReadAll(r.Body) |
|||
if err != nil { |
|||
c.Err(rw, r, err) |
|||
return |
|||
} |
|||
if len(b) < 1 { |
|||
rw.WriteHeader(http.StatusBadRequest) |
|||
rw.Write([]byte("Must include deletion key in DELETE body.")) |
|||
return |
|||
} |
|||
var ( |
|||
smol = strings.TrimSpace(strings.TrimLeft(r.URL.Path, "/")) |
|||
del = strings.TrimSpace(string(b)) |
|||
) |
|||
if err := c.db.DelLink(smol, del); err != nil { |
|||
c.Err(rw, r, err) |
|||
return |
|||
} |
|||
rw.WriteHeader(http.StatusNoContent) |
|||
return |
|||
|
|||
} |
|||
|
|||
http.NotFound(rw, r) |
|||
} |
|||
|
|||
func main() { |
|||
var ( |
|||
logPrefix = "link: " |
|||
startupLogger = log.New(os.Stdout, logPrefix, 0) |
|||
applicationLogger = log.New(ioutil.Discard, logPrefix, 0) |
|||
v = flag.Bool("v", false, "verbose logging") |
|||
port = flag.Uint("port", 8080, "port to listen on") |
|||
dbFilePath = flag.String("db", "", "sqlite database filepath: required") |
|||
url = flag.String("url", "", "service url: required") |
|||
hashSeed = flag.String("seed", "", "hash seed: required") |
|||
) |
|||
flag.Parse() |
|||
if *dbFilePath == "" || *url == "" || *hashSeed == "" { |
|||
flag.Usage() |
|||
return |
|||
} |
|||
if *v { |
|||
applicationLogger = log.New(os.Stdout, logPrefix, 0) |
|||
} |
|||
db, err := NewDB(applicationLogger, *dbFilePath, *hashSeed) |
|||
if err != nil { |
|||
startupLogger.Fatal(err) |
|||
return |
|||
} |
|||
http.Handle("/", NewController(applicationLogger, db, *url)) |
|||
startupLogger.Println("listening on port", *port) |
|||
startupLogger.Fatal(http.ListenAndServe(fmt.Sprintf(":%d", *port), nil)) |
|||
} |
|||
@ -0,0 +1,28 @@ |
|||
BIN=out |
|||
CC=go1.16 |
|||
|
|||
all: setup vendor gen build |
|||
|
|||
setup: |
|||
@env GOOD=off go get golang.org/dl/go1.16 |
|||
@env GOOD=off $(CC) download |
|||
|
|||
vendor: go.mod go.sum |
|||
@$(CC) mod tidy |
|||
@$(CC) mod vendor |
|||
|
|||
build: |
|||
@$(CC) build -ldflags='-s -w' -o $(BIN) |
|||
|
|||
gen: |
|||
@$(CC) generate ./... |
|||
|
|||
test: |
|||
@env $(ENV) $(CC) test ./... -cover -count 1 |
|||
|
|||
run: gen build |
|||
@clear |
|||
@env $(ENV) ./$(BIN) -v -url https://dev.fsh.ee -port 8080 -db /tmp/link_test_db_1.sql -seed secret |
|||
|
|||
dev: |
|||
@find . -type f | grep -E '(.*)\.(go|html)' | entr -cr make run |
|||
@ -0,0 +1,21 @@ |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2015 - Jinzhu |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy |
|||
of this software and associated documentation files (the "Software"), to deal |
|||
in the Software without restriction, including without limitation the rights |
|||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|||
copies of the Software, and to permit persons to whom the Software is |
|||
furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in all |
|||
copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|||
SOFTWARE. |
|||
@ -0,0 +1,55 @@ |
|||
# Inflection |
|||
|
|||
Inflection pluralizes and singularizes English nouns |
|||
|
|||
[](https://app.wercker.com/project/byKey/f8c7432b097d1f4ce636879670be0930) |
|||
|
|||
## Basic Usage |
|||
|
|||
```go |
|||
inflection.Plural("person") => "people" |
|||
inflection.Plural("Person") => "People" |
|||
inflection.Plural("PERSON") => "PEOPLE" |
|||
inflection.Plural("bus") => "buses" |
|||
inflection.Plural("BUS") => "BUSES" |
|||
inflection.Plural("Bus") => "Buses" |
|||
|
|||
inflection.Singular("people") => "person" |
|||
inflection.Singular("People") => "Person" |
|||
inflection.Singular("PEOPLE") => "PERSON" |
|||
inflection.Singular("buses") => "bus" |
|||
inflection.Singular("BUSES") => "BUS" |
|||
inflection.Singular("Buses") => "Bus" |
|||
|
|||
inflection.Plural("FancyPerson") => "FancyPeople" |
|||
inflection.Singular("FancyPeople") => "FancyPerson" |
|||
``` |
|||
|
|||
## Register Rules |
|||
|
|||
Standard rules are from Rails's ActiveSupport (https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflections.rb) |
|||
|
|||
If you want to register more rules, follow: |
|||
|
|||
``` |
|||
inflection.AddUncountable("fish") |
|||
inflection.AddIrregular("person", "people") |
|||
inflection.AddPlural("(bu)s$", "${1}ses") # "bus" => "buses" / "BUS" => "BUSES" / "Bus" => "Buses" |
|||
inflection.AddSingular("(bus)(es)?$", "${1}") # "buses" => "bus" / "Buses" => "Bus" / "BUSES" => "BUS" |
|||
``` |
|||
|
|||
## Contributing |
|||
|
|||
You can help to make the project better, check out [http://gorm.io/contribute.html](http://gorm.io/contribute.html) for things you can do. |
|||
|
|||
## Author |
|||
|
|||
**jinzhu** |
|||
|
|||
* <http://github.com/jinzhu> |
|||
* <wosmvp@gmail.com> |
|||
* <http://twitter.com/zhangjinzhu> |
|||
|
|||
## License |
|||
|
|||
Released under the [MIT License](http://www.opensource.org/licenses/MIT). |
|||
@ -0,0 +1 @@ |
|||
module github.com/jinzhu/inflection |
|||
@ -0,0 +1,273 @@ |
|||
/* |
|||
Package inflection pluralizes and singularizes English nouns. |
|||
|
|||
inflection.Plural("person") => "people" |
|||
inflection.Plural("Person") => "People" |
|||
inflection.Plural("PERSON") => "PEOPLE" |
|||
|
|||
inflection.Singular("people") => "person" |
|||
inflection.Singular("People") => "Person" |
|||
inflection.Singular("PEOPLE") => "PERSON" |
|||
|
|||
inflection.Plural("FancyPerson") => "FancydPeople" |
|||
inflection.Singular("FancyPeople") => "FancydPerson" |
|||
|
|||
Standard rules are from Rails's ActiveSupport (https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflections.rb)
|
|||
|
|||
If you want to register more rules, follow: |
|||
|
|||
inflection.AddUncountable("fish") |
|||
inflection.AddIrregular("person", "people") |
|||
inflection.AddPlural("(bu)s$", "${1}ses") # "bus" => "buses" / "BUS" => "BUSES" / "Bus" => "Buses" |
|||
inflection.AddSingular("(bus)(es)?$", "${1}") # "buses" => "bus" / "Buses" => "Bus" / "BUSES" => "BUS" |
|||
*/ |
|||
package inflection |
|||
|
|||
import ( |
|||
"regexp" |
|||
"strings" |
|||
) |
|||
|
|||
type inflection struct { |
|||
regexp *regexp.Regexp |
|||
replace string |
|||
} |
|||
|
|||
// Regular is a regexp find replace inflection
|
|||
type Regular struct { |
|||
find string |
|||
replace string |
|||
} |
|||
|
|||
// Irregular is a hard replace inflection,
|
|||
// containing both singular and plural forms
|
|||
type Irregular struct { |
|||
singular string |
|||
plural string |
|||
} |
|||
|
|||
// RegularSlice is a slice of Regular inflections
|
|||
type RegularSlice []Regular |
|||
|
|||
// IrregularSlice is a slice of Irregular inflections
|
|||
type IrregularSlice []Irregular |
|||
|
|||
var pluralInflections = RegularSlice{ |
|||
{"([a-z])$", "${1}s"}, |
|||
{"s$", "s"}, |
|||
{"^(ax|test)is$", "${1}es"}, |
|||
{"(octop|vir)us$", "${1}i"}, |
|||
{"(octop|vir)i$", "${1}i"}, |
|||
{"(alias|status)$", "${1}es"}, |
|||
{"(bu)s$", "${1}ses"}, |
|||
{"(buffal|tomat)o$", "${1}oes"}, |
|||
{"([ti])um$", "${1}a"}, |
|||
{"([ti])a$", "${1}a"}, |
|||
{"sis$", "ses"}, |
|||
{"(?:([^f])fe|([lr])f)$", "${1}${2}ves"}, |
|||
{"(hive)$", "${1}s"}, |
|||
{"([^aeiouy]|qu)y$", "${1}ies"}, |
|||
{"(x|ch|ss|sh)$", "${1}es"}, |
|||
{"(matr|vert|ind)(?:ix|ex)$", "${1}ices"}, |
|||
{"^(m|l)ouse$", "${1}ice"}, |
|||
{"^(m|l)ice$", "${1}ice"}, |
|||
{"^(ox)$", "${1}en"}, |
|||
{"^(oxen)$", "${1}"}, |
|||
{"(quiz)$", "${1}zes"}, |
|||
} |
|||
|
|||
var singularInflections = RegularSlice{ |
|||
{"s$", ""}, |
|||
{"(ss)$", "${1}"}, |
|||
{"(n)ews$", "${1}ews"}, |
|||
{"([ti])a$", "${1}um"}, |
|||
{"((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)(sis|ses)$", "${1}sis"}, |
|||
{"(^analy)(sis|ses)$", "${1}sis"}, |
|||
{"([^f])ves$", "${1}fe"}, |
|||
{"(hive)s$", "${1}"}, |
|||
{"(tive)s$", "${1}"}, |
|||
{"([lr])ves$", "${1}f"}, |
|||
{"([^aeiouy]|qu)ies$", "${1}y"}, |
|||
{"(s)eries$", "${1}eries"}, |
|||
{"(m)ovies$", "${1}ovie"}, |
|||
{"(c)ookies$", "${1}ookie"}, |
|||
{"(x|ch|ss|sh)es$", "${1}"}, |
|||
{"^(m|l)ice$", "${1}ouse"}, |
|||
{"(bus)(es)?$", "${1}"}, |
|||
{"(o)es$", "${1}"}, |
|||
{"(shoe)s$", "${1}"}, |
|||
{"(cris|test)(is|es)$", "${1}is"}, |
|||
{"^(a)x[ie]s$", "${1}xis"}, |
|||
{"(octop|vir)(us|i)$", "${1}us"}, |
|||
{"(alias|status)(es)?$", "${1}"}, |
|||
{"^(ox)en", "${1}"}, |
|||
{"(vert|ind)ices$", "${1}ex"}, |
|||
{"(matr)ices$", "${1}ix"}, |
|||
{"(quiz)zes$", "${1}"}, |
|||
{"(database)s$", "${1}"}, |
|||
} |
|||
|
|||
var irregularInflections = IrregularSlice{ |
|||
{"person", "people"}, |
|||
{"man", "men"}, |
|||
{"child", "children"}, |
|||
{"sex", "sexes"}, |
|||
{"move", "moves"}, |
|||
{"mombie", "mombies"}, |
|||
} |
|||
|
|||
var uncountableInflections = []string{"equipment", "information", "rice", "money", "species", "series", "fish", "sheep", "jeans", "police"} |
|||
|
|||
var compiledPluralMaps []inflection |
|||
var compiledSingularMaps []inflection |
|||
|
|||
func compile() { |
|||
compiledPluralMaps = []inflection{} |
|||
compiledSingularMaps = []inflection{} |
|||
for _, uncountable := range uncountableInflections { |
|||
inf := inflection{ |
|||
regexp: regexp.MustCompile("^(?i)(" + uncountable + ")$"), |
|||
replace: "${1}", |
|||
} |
|||
compiledPluralMaps = append(compiledPluralMaps, inf) |
|||
compiledSingularMaps = append(compiledSingularMaps, inf) |
|||
} |
|||
|
|||
for _, value := range irregularInflections { |
|||
infs := []inflection{ |
|||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.singular) + "$"), replace: strings.ToUpper(value.plural)}, |
|||
inflection{regexp: regexp.MustCompile(strings.Title(value.singular) + "$"), replace: strings.Title(value.plural)}, |
|||
inflection{regexp: regexp.MustCompile(value.singular + "$"), replace: value.plural}, |
|||
} |
|||
compiledPluralMaps = append(compiledPluralMaps, infs...) |
|||
} |
|||
|
|||
for _, value := range irregularInflections { |
|||
infs := []inflection{ |
|||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.plural) + "$"), replace: strings.ToUpper(value.singular)}, |
|||
inflection{regexp: regexp.MustCompile(strings.Title(value.plural) + "$"), replace: strings.Title(value.singular)}, |
|||
inflection{regexp: regexp.MustCompile(value.plural + "$"), replace: value.singular}, |
|||
} |
|||
compiledSingularMaps = append(compiledSingularMaps, infs...) |
|||
} |
|||
|
|||
for i := len(pluralInflections) - 1; i >= 0; i-- { |
|||
value := pluralInflections[i] |
|||
infs := []inflection{ |
|||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.find)), replace: strings.ToUpper(value.replace)}, |
|||
inflection{regexp: regexp.MustCompile(value.find), replace: value.replace}, |
|||
inflection{regexp: regexp.MustCompile("(?i)" + value.find), replace: value.replace}, |
|||
} |
|||
compiledPluralMaps = append(compiledPluralMaps, infs...) |
|||
} |
|||
|
|||
for i := len(singularInflections) - 1; i >= 0; i-- { |
|||
value := singularInflections[i] |
|||
infs := []inflection{ |
|||
inflection{regexp: regexp.MustCompile(strings.ToUpper(value.find)), replace: strings.ToUpper(value.replace)}, |
|||
inflection{regexp: regexp.MustCompile(value.find), replace: value.replace}, |
|||
inflection{regexp: regexp.MustCompile("(?i)" + value.find), replace: value.replace}, |
|||
} |
|||
compiledSingularMaps = append(compiledSingularMaps, infs...) |
|||
} |
|||
} |
|||
|
|||
func init() { |
|||
compile() |
|||
} |
|||
|
|||
// AddPlural adds a plural inflection
|
|||
func AddPlural(find, replace string) { |
|||
pluralInflections = append(pluralInflections, Regular{find, replace}) |
|||
compile() |
|||
} |
|||
|
|||
// AddSingular adds a singular inflection
|
|||
func AddSingular(find, replace string) { |
|||
singularInflections = append(singularInflections, Regular{find, replace}) |
|||
compile() |
|||
} |
|||
|
|||
// AddIrregular adds an irregular inflection
|
|||
func AddIrregular(singular, plural string) { |
|||
irregularInflections = append(irregularInflections, Irregular{singular, plural}) |
|||
compile() |
|||
} |
|||
|
|||
// AddUncountable adds an uncountable inflection
|
|||
func AddUncountable(values ...string) { |
|||
uncountableInflections = append(uncountableInflections, values...) |
|||
compile() |
|||
} |
|||
|
|||
// GetPlural retrieves the plural inflection values
|
|||
func GetPlural() RegularSlice { |
|||
plurals := make(RegularSlice, len(pluralInflections)) |
|||
copy(plurals, pluralInflections) |
|||
return plurals |
|||
} |
|||
|
|||
// GetSingular retrieves the singular inflection values
|
|||
func GetSingular() RegularSlice { |
|||
singulars := make(RegularSlice, len(singularInflections)) |
|||
copy(singulars, singularInflections) |
|||
return singulars |
|||
} |
|||
|
|||
// GetIrregular retrieves the irregular inflection values
|
|||
func GetIrregular() IrregularSlice { |
|||
irregular := make(IrregularSlice, len(irregularInflections)) |
|||
copy(irregular, irregularInflections) |
|||
return irregular |
|||
} |
|||
|
|||
// GetUncountable retrieves the uncountable inflection values
|
|||
func GetUncountable() []string { |
|||
uncountables := make([]string, len(uncountableInflections)) |
|||
copy(uncountables, uncountableInflections) |
|||
return uncountables |
|||
} |
|||
|
|||
// SetPlural sets the plural inflections slice
|
|||
func SetPlural(inflections RegularSlice) { |
|||
pluralInflections = inflections |
|||
compile() |
|||
} |
|||
|
|||
// SetSingular sets the singular inflections slice
|
|||
func SetSingular(inflections RegularSlice) { |
|||
singularInflections = inflections |
|||
compile() |
|||
} |
|||
|
|||
// SetIrregular sets the irregular inflections slice
|
|||
func SetIrregular(inflections IrregularSlice) { |
|||
irregularInflections = inflections |
|||
compile() |
|||
} |
|||
|
|||
// SetUncountable sets the uncountable inflections slice
|
|||
func SetUncountable(inflections []string) { |
|||
uncountableInflections = inflections |
|||
compile() |
|||
} |
|||
|
|||
// Plural converts a word to its plural form
|
|||
func Plural(str string) string { |
|||
for _, inflection := range compiledPluralMaps { |
|||
if inflection.regexp.MatchString(str) { |
|||
return inflection.regexp.ReplaceAllString(str, inflection.replace) |
|||
} |
|||
} |
|||
return str |
|||
} |
|||
|
|||
// Singular converts a word to its singular form
|
|||
func Singular(str string) string { |
|||
for _, inflection := range compiledSingularMaps { |
|||
if inflection.regexp.MatchString(str) { |
|||
return inflection.regexp.ReplaceAllString(str, inflection.replace) |
|||
} |
|||
} |
|||
return str |
|||
} |
|||
@ -0,0 +1,23 @@ |
|||
box: golang |
|||
|
|||
build: |
|||
steps: |
|||
- setup-go-workspace |
|||
|
|||
# Gets the dependencies |
|||
- script: |
|||
name: go get |
|||
code: | |
|||
go get |
|||
|
|||
# Build the project |
|||
- script: |
|||
name: go build |
|||
code: | |
|||
go build ./... |
|||
|
|||
# Test the project |
|||
- script: |
|||
name: go test |
|||
code: | |
|||
go test ./... |
|||
@ -0,0 +1,3 @@ |
|||
guard 'gotest' do |
|||
watch(%r{\.go$}) |
|||
end |
|||
@ -0,0 +1,21 @@ |
|||
The MIT License (MIT) |
|||
|
|||
Copyright (c) 2013-NOW Jinzhu <wosmvp@gmail.com> |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy |
|||
of this software and associated documentation files (the "Software"), to deal |
|||
in the Software without restriction, including without limitation the rights |
|||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|||
copies of the Software, and to permit persons to whom the Software is |
|||
furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in |
|||
all copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
|||
THE SOFTWARE. |
|||
@ -0,0 +1,131 @@ |
|||
## Now |
|||
|
|||
Now is a time toolkit for golang |
|||
|
|||
[](https://app.wercker.com/project/byKey/a350da4eae6cb28a35687ba41afb565a) |
|||
|
|||
## Install |
|||
|
|||
``` |
|||
go get -u github.com/jinzhu/now |
|||
``` |
|||
|
|||
## Usage |
|||
|
|||
Calculating time based on current time |
|||
|
|||
```go |
|||
import "github.com/jinzhu/now" |
|||
|
|||
time.Now() // 2013-11-18 17:51:49.123456789 Mon |
|||
|
|||
now.BeginningOfMinute() // 2013-11-18 17:51:00 Mon |
|||
now.BeginningOfHour() // 2013-11-18 17:00:00 Mon |
|||
now.BeginningOfDay() // 2013-11-18 00:00:00 Mon |
|||
now.BeginningOfWeek() // 2013-11-17 00:00:00 Sun |
|||
now.BeginningOfMonth() // 2013-11-01 00:00:00 Fri |
|||
now.BeginningOfQuarter() // 2013-10-01 00:00:00 Tue |
|||
now.BeginningOfYear() // 2013-01-01 00:00:00 Tue |
|||
|
|||
now.EndOfMinute() // 2013-11-18 17:51:59.999999999 Mon |
|||
now.EndOfHour() // 2013-11-18 17:59:59.999999999 Mon |
|||
now.EndOfDay() // 2013-11-18 23:59:59.999999999 Mon |
|||
now.EndOfWeek() // 2013-11-23 23:59:59.999999999 Sat |
|||
now.EndOfMonth() // 2013-11-30 23:59:59.999999999 Sat |
|||
now.EndOfQuarter() // 2013-12-31 23:59:59.999999999 Tue |
|||
now.EndOfYear() // 2013-12-31 23:59:59.999999999 Tue |
|||
|
|||
now.WeekStartDay = time.Monday // Set Monday as first day, default is Sunday |
|||
now.EndOfWeek() // 2013-11-24 23:59:59.999999999 Sun |
|||
``` |
|||
|
|||
Calculating time based on another time |
|||
|
|||
```go |
|||
t := time.Date(2013, 02, 18, 17, 51, 49, 123456789, time.Now().Location()) |
|||
now.With(t).EndOfMonth() // 2013-02-28 23:59:59.999999999 Thu |
|||
``` |
|||
|
|||
Calculating time based on configuration |
|||
|
|||
```go |
|||
location, err := time.LoadLocation("Asia/Shanghai") |
|||
|
|||
myConfig := &now.Config{ |
|||
WeekStartDay: time.Monday, |
|||
TimeLocation: location, |
|||
TimeFormats: []string{"2006-01-02 15:04:05"}, |
|||
} |
|||
|
|||
t := time.Date(2013, 11, 18, 17, 51, 49, 123456789, time.Now().Location()) // // 2013-11-18 17:51:49.123456789 Mon |
|||
myConfig.With(t).BeginningOfWeek() // 2013-11-18 00:00:00 Mon |
|||
|
|||
myConfig.Parse("2002-10-12 22:14:01") // 2002-10-12 22:14:01 |
|||
myConfig.Parse("2002-10-12 22:14") // returns error 'can't parse string as time: 2002-10-12 22:14' |
|||
``` |
|||
|
|||
### Monday/Sunday |
|||
|
|||
Don't be bothered with the `WeekStartDay` setting, you can use `Monday`, `Sunday` |
|||
|
|||
```go |
|||
now.Monday() // 2013-11-18 00:00:00 Mon |
|||
now.Sunday() // 2013-11-24 00:00:00 Sun (Next Sunday) |
|||
now.EndOfSunday() // 2013-11-24 23:59:59.999999999 Sun (End of next Sunday) |
|||
|
|||
t := time.Date(2013, 11, 24, 17, 51, 49, 123456789, time.Now().Location()) // 2013-11-24 17:51:49.123456789 Sun |
|||
now.With(t).Monday() // 2013-11-18 00:00:00 Sun (Last Monday if today is Sunday) |
|||
now.With(t).Sunday() // 2013-11-24 00:00:00 Sun (Beginning Of Today if today is Sunday) |
|||
now.With(t).EndOfSunday() // 2013-11-24 23:59:59.999999999 Sun (End of Today if today is Sunday) |
|||
``` |
|||
|
|||
### Parse String to Time |
|||
|
|||
```go |
|||
time.Now() // 2013-11-18 17:51:49.123456789 Mon |
|||
|
|||
// Parse(string) (time.Time, error) |
|||
t, err := now.Parse("2017") // 2017-01-01 00:00:00, nil |
|||
t, err := now.Parse("2017-10") // 2017-10-01 00:00:00, nil |
|||
t, err := now.Parse("2017-10-13") // 2017-10-13 00:00:00, nil |
|||
t, err := now.Parse("1999-12-12 12") // 1999-12-12 12:00:00, nil |
|||
t, err := now.Parse("1999-12-12 12:20") // 1999-12-12 12:20:00, nil |
|||
t, err := now.Parse("1999-12-12 12:20:21") // 1999-12-12 12:20:00, nil |
|||
t, err := now.Parse("10-13") // 2013-10-13 00:00:00, nil |
|||
t, err := now.Parse("12:20") // 2013-11-18 12:20:00, nil |
|||
t, err := now.Parse("12:20:13") // 2013-11-18 12:20:13, nil |
|||
t, err := now.Parse("14") // 2013-11-18 14:00:00, nil |
|||
t, err := now.Parse("99:99") // 2013-11-18 12:20:00, Can't parse string as time: 99:99 |
|||
|
|||
// MustParse must parse string to time or it will panic |
|||
now.MustParse("2013-01-13") // 2013-01-13 00:00:00 |
|||
now.MustParse("02-17") // 2013-02-17 00:00:00 |
|||
now.MustParse("2-17") // 2013-02-17 00:00:00 |
|||
now.MustParse("8") // 2013-11-18 08:00:00 |
|||
now.MustParse("2002-10-12 22:14") // 2002-10-12 22:14:00 |
|||
now.MustParse("99:99") // panic: Can't parse string as time: 99:99 |
|||
``` |
|||
|
|||
Extend `now` to support more formats is quite easy, just update `now.TimeFormats` with other time layouts, e.g: |
|||
|
|||
```go |
|||
now.TimeFormats = append(now.TimeFormats, "02 Jan 2006 15:04") |
|||
``` |
|||
|
|||
Please send me pull requests if you want a format to be supported officially |
|||
|
|||
## Contributing |
|||
|
|||
You can help to make the project better, check out [http://gorm.io/contribute.html](http://gorm.io/contribute.html) for things you can do. |
|||
|
|||
# Author |
|||
|
|||
**jinzhu** |
|||
|
|||
* <http://github.com/jinzhu> |
|||
* <wosmvp@gmail.com> |
|||
* <http://twitter.com/zhangjinzhu> |
|||
|
|||
## License |
|||
|
|||
Released under the [MIT License](http://www.opensource.org/licenses/MIT). |
|||
@ -0,0 +1,3 @@ |
|||
module github.com/jinzhu/now |
|||
|
|||
go 1.12 |
|||
@ -0,0 +1,194 @@ |
|||
// Package now is a time toolkit for golang.
|
|||
//
|
|||
// More details README here: https://github.com/jinzhu/now
|
|||
//
|
|||
// import "github.com/jinzhu/now"
|
|||
//
|
|||
// now.BeginningOfMinute() // 2013-11-18 17:51:00 Mon
|
|||
// now.BeginningOfDay() // 2013-11-18 00:00:00 Mon
|
|||
// now.EndOfDay() // 2013-11-18 23:59:59.999999999 Mon
|
|||
package now |
|||
|
|||
import "time" |
|||
|
|||
// WeekStartDay set week start day, default is sunday
|
|||
var WeekStartDay = time.Sunday |
|||
|
|||
// TimeFormats default time formats will be parsed as
|
|||
var TimeFormats = []string{ |
|||
"2006", "2006-1", "2006-1-2", "2006-1-2 15", "2006-1-2 15:4", "2006-1-2 15:4:5", "1-2", |
|||
"15:4:5", "15:4", "15", |
|||
"15:4:5 Jan 2, 2006 MST", "2006-01-02 15:04:05.999999999 -0700 MST", "2006-01-02T15:04:05-07:00", |
|||
"2006.1.2", "2006.1.2 15:04:05", "2006.01.02", "2006.01.02 15:04:05", "2006.01.02 15:04:05.999999999", |
|||
"1/2/2006", "1/2/2006 15:4:5", "2006/01/02", "2006/01/02 15:04:05", |
|||
time.ANSIC, time.UnixDate, time.RubyDate, time.RFC822, time.RFC822Z, time.RFC850, |
|||
time.RFC1123, time.RFC1123Z, time.RFC3339, time.RFC3339Nano, |
|||
time.Kitchen, time.Stamp, time.StampMilli, time.StampMicro, time.StampNano, |
|||
} |
|||
|
|||
// Config configuration for now package
|
|||
type Config struct { |
|||
WeekStartDay time.Weekday |
|||
TimeLocation *time.Location |
|||
TimeFormats []string |
|||
} |
|||
|
|||
// DefaultConfig default config
|
|||
var DefaultConfig *Config |
|||
|
|||
// New initialize Now based on configuration
|
|||
func (config *Config) With(t time.Time) *Now { |
|||
return &Now{Time: t, Config: config} |
|||
} |
|||
|
|||
// Parse parse string to time based on configuration
|
|||
func (config *Config) Parse(strs ...string) (time.Time, error) { |
|||
if config.TimeLocation == nil { |
|||
return config.With(time.Now()).Parse(strs...) |
|||
} else { |
|||
return config.With(time.Now().In(config.TimeLocation)).Parse(strs...) |
|||
} |
|||
} |
|||
|
|||
// MustParse must parse string to time or will panic
|
|||
func (config *Config) MustParse(strs ...string) time.Time { |
|||
if config.TimeLocation == nil { |
|||
return config.With(time.Now()).MustParse(strs...) |
|||
} else { |
|||
return config.With(time.Now().In(config.TimeLocation)).MustParse(strs...) |
|||
} |
|||
} |
|||
|
|||
// Now now struct
|
|||
type | |||