[init]
This commit is contained in:
commit
aac413f1a0
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
||||
*
|
674
LICENCE
Normal file
674
LICENCE
Normal file
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
110
mailman-downloader.sh
Executable file
110
mailman-downloader.sh
Executable file
@ -0,0 +1,110 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
# Specialized archive downloader for mailman v3.x
|
||||
#
|
||||
# Features
|
||||
#
|
||||
# * Download all gz and html and attachments
|
||||
# * Filter: skip_gz, skip_attachment, skip_list, skip_email
|
||||
# * Doesn't download twice a same file
|
||||
# * Stores files for a list in its own folder
|
||||
#
|
||||
# Usage
|
||||
#
|
||||
# * Install gawk and curl
|
||||
# * Run this script
|
||||
# * Answer questions
|
||||
# * Mailman URL: the "root" URL for the mailman software. No CGI page, no trailing slash
|
||||
# * List name: the list ID, i.e. what appears after xxx.cgi/{list_name} in mailman URL
|
||||
# * Admin password: the admin password for the list
|
||||
#
|
||||
# Flags and options
|
||||
#
|
||||
# You can pass flags and options by using the export command. For example
|
||||
# If you want to skip gz files and attachments
|
||||
# export skip_gz=1
|
||||
# If you want to provide the url, name, and password with no questions asked
|
||||
# export url=https://mailman.example.com
|
||||
# export name=list-example.com
|
||||
# export password=thisbemysecurepassword
|
||||
#
|
||||
# Notes
|
||||
#
|
||||
# * When gz is mentioned, they aren't actual compressed files... Beats me.
|
||||
# * This script could use parallel. It's quite long and tedious.
|
||||
#
|
||||
# @author alban
|
||||
# @since 2020-02-20
|
||||
|
||||
|
||||
# Helper function: cURL wrapper with cookies and target file management
|
||||
http(){
|
||||
local cookie="${1}";
|
||||
local url="${2}";
|
||||
local file="${3}";
|
||||
[[ -s "$file" ]] && return
|
||||
local dir=$(dirname $file)
|
||||
[[ ! -d "$dir" ]] && mkdir -p "$dir"
|
||||
curl -s -H "Cookie: $cookie" "$url" -o $file && echo $file
|
||||
}
|
||||
|
||||
# Helper function: exit + message
|
||||
panic(){echo "$@"; exit 1; }
|
||||
|
||||
# Some dependencies are mandatory
|
||||
which gawk &>/dev/null || panic "Please install gawk"
|
||||
which curl &>/dev/null || panic "Please install curl"
|
||||
|
||||
# Read user provided options
|
||||
[ -z "$url" ]] && read -p "Mailman URL (ex: https://list.example.com): " url
|
||||
[ -z "$nom" ]] && read -p "List name (ex: list-example.com): " nom
|
||||
[ -z "$password" ]] && read -p "Mot de passe admin: " password
|
||||
|
||||
# get the cookie
|
||||
cookie_file=$(mktemp)
|
||||
curl -D ${cookie_file} "${url}/admindb.cgi/$nom" -d admlogin=whatever -d adminpw=${password} -o /dev/null -s
|
||||
cookie=$(grep Set-Cookie ${cookie_file} |gawk "match(\$0, /Set-Cookie: ([^;]*);.*/, a) {print a[1]}" -)
|
||||
rm -f ${cookie_file}
|
||||
|
||||
# Get the main html
|
||||
response_file="$nom/index.html"
|
||||
http "$cookie" "${url}/private.cgi/${nom}" "$response_file" ""
|
||||
echo "export response_file='$response_file'"
|
||||
|
||||
# Download the GZ files and attachments
|
||||
prefix="${url}/private.cgi/${nom}"
|
||||
if [[ -z "$skip_gz" ]] ; then
|
||||
# href="2009-June.txt.gz">[ Text 2 KB Gzip<69>s]</a></td>
|
||||
gawk "match(\$0, /.*([0-9]{4}-.*txt.gz)/,a) {print a[1]}" "$response_file"| while read gz; do
|
||||
http "$cookie" "$url/private.cgi/${nom}/$gz" "$nom/$gz"
|
||||
|
||||
# Download attachments
|
||||
if [[ -z "$skip_attachment" ]] ; then
|
||||
# URL: <http://lists.domain.tld/private.cgi/list-domain.tld/attachments/20190503/225f91a0/attachment.html>
|
||||
cat "$nom/$gz" | gawk 'match($0, /URL: <(.*?)>/,a) {print a[1]}' | while read attachment_url ; do
|
||||
output_file="$nom/${attachment_url/$prefix/}"
|
||||
http "$cookie" "$attachment_url" "$output_file"
|
||||
done
|
||||
fi
|
||||
done
|
||||
fi
|
||||
|
||||
# Download the HTML Files, lists ordered by date / thread / etc. first
|
||||
if [[ -z "$skip_list" ]] ; then
|
||||
|
||||
# return a list of 2008-March/<type>.html
|
||||
gawk 'match($0, /href="(.*html)"/, a) {print a[1]}' "$response_file"|while read list_url; do
|
||||
list_dir=$(dirname $list_url)
|
||||
http "$cookie" "$url/private.cgi/$nom/$list_url" "$nom/$list_url"
|
||||
|
||||
# Download single emails
|
||||
if [[ -z "$skip_email" ]] ; then
|
||||
# <LI><A HREF="020532.html">[List] Regardez la lumière mes jolis
|
||||
cat "$nom/$list_url" | gawk 'match($0, /(href|HREF)="([0-9]+.html)"/,a) {print a[2]}' | while read email_url ; do
|
||||
output_file="$nom/${list_dir}/${email_url}"
|
||||
http "$cookie" "$url/private.cgi/$nom/$list_dir/$email_url" "$output_file"
|
||||
done
|
||||
fi
|
||||
done
|
||||
|
||||
fi
|
449
mailman-subscribers.py
Executable file
449
mailman-subscribers.py
Executable file
@ -0,0 +1,449 @@
|
||||
#!/usr/bin/env python
|
||||
# vi: set et sw=4 st=4:
|
||||
#
|
||||
# 2004-08-27 Jim Tittsler <jwt@starship.python.net>
|
||||
# 2004-10-03 jwt change authentication
|
||||
# 2004-10-04 jwt remove dependency on ClientCookie
|
||||
# 2004-10-07 jwt use getopt to retrieve host, list, password from command
|
||||
# 2004-10-10 jwt return to using ClientCookie
|
||||
# 2004-10-13 jwt add --fullnames option
|
||||
# 2005-02-15 jwt switch on RFC2965 cookie support when newer version
|
||||
# of ClientCookie is detected
|
||||
# 2005-02-16 jwt use Python 2.4's cookielib if it is available
|
||||
# 2005-02-27 jwt only visit the roster page for letters that exist
|
||||
# 2005-06-04 mas add --nomail option (Mark Sapiro <mark@msapiro.net>)
|
||||
# 2005-06-14 jwt handle chunks of email addresses starting [0-9]*
|
||||
# 2006-01-27 mas Retry urllib2.URLError exceptions in main loop.
|
||||
# Modify parser to get most of the member attributes on the
|
||||
# page (I don't get nomail reason because I haven't yet
|
||||
# figured out how, and I don't get the language option).
|
||||
# This provides a foundation for adding options to deal
|
||||
# with any of these attributes.
|
||||
# 2006-01-28 mas Add --regular and --digest options.
|
||||
# 2006-01-29 mas Get the nomail reason (I figured out how)
|
||||
# Add the --csv option intended to produce a file that can
|
||||
# be imported into a local spreadsheet. Mostly useful for
|
||||
# larger lists when multiple sublists are desired and where
|
||||
# multiple passes are expensive.
|
||||
# 2006-04-10 mas Add some error checking for invalid URL (hostname),
|
||||
# listname and password.
|
||||
# 2006-04-11 mas Correct test on find(). Success is '>= 0', not 'True'.
|
||||
# 2006-08-24 mas Catch more exceptions on invalid URLs.
|
||||
# Add some more explaination of hostname and when
|
||||
# member_url might need changing.
|
||||
# 2006-09-20 Ed Lally <elally@jersey.net>
|
||||
# 2006-09-20 ejl Add config variable for admin path (/mailman/admin/) for
|
||||
# sites that don't use default URLs.
|
||||
# 2006-09-21 mas Make Ed's change a command line option.
|
||||
# 2007-05-07 mas Acommodate possible urllib.quote()ed email addresses.
|
||||
# 2008-02-03 mas Clarify that script works with Membership list through
|
||||
# 2.1.10.
|
||||
# Fix broken --url_path option.
|
||||
# 2008-10-06 mas Works with 2.1.11.
|
||||
# Handle chunks starting with other than [0-9A-Z].
|
||||
# Print verbose output to stderr.
|
||||
# 2008-10-07 mas Added -U/--unhide option
|
||||
# 2008-10-09 mas Forgot to make the unhide '.' prints conditional on
|
||||
# verbose. Also, csv printed "on" for members changed to
|
||||
# unhidden. Fixed.
|
||||
# 2011-10-24 mas Added type to nomail selection.
|
||||
# 2012-10-20 mas Encode real name as iso-8859-1 to avoid Unicode error
|
||||
# with non-ascii.
|
||||
# 2012-11-14 jak Added support to use HTTPS (james@jameskinnaird.ca)
|
||||
# 2013-01-25 mas Revised the help for -u.
|
||||
# 2014-11-26 mas Tested with 2.1.18 and Python 2.7.
|
||||
# Updated for '401' status return for invalid password
|
||||
# in recent Mailman versions.
|
||||
# 2015-08-09 mas Changed the real name encoding to make more robust.
|
||||
# 2015-08-11 mas More changes for encodings.
|
||||
# 2015-12-04 mas Changed error message for bad login result page.
|
||||
# 2018-10-17 mas Doc changes - --unhide doesn't work with recent Mailman.
|
||||
#
|
||||
|
||||
"""List the email addresses subscribed to a mailing list, fetched from web.
|
||||
|
||||
Usage: %(PROGRAM)s [options] hostname listname password
|
||||
|
||||
Where:
|
||||
--output file
|
||||
-o file
|
||||
Write output to specified file instead of standard out.
|
||||
|
||||
--regular
|
||||
-r
|
||||
List only the regular (non-digest) members.
|
||||
|
||||
--digest={any|mime|plain}
|
||||
-d {any|mime|plain}
|
||||
List only the digest members. One of 'any', 'mime' or 'plain'
|
||||
is required.
|
||||
'any' lists all the digest members.
|
||||
'mime' lists only the mime digest members.
|
||||
'plain' lists only the plain digest members.
|
||||
|
||||
--fullnames
|
||||
-f
|
||||
Include the full names in the output.
|
||||
|
||||
--nomail={any|admin|bounce|user|unknown|enabled}
|
||||
-n {any|admin|bounce|user|unknown|enabled}
|
||||
List members based on their nomail status. One of 'any', 'admin',
|
||||
'bounce', 'user', 'unknown' or 'enabled' is required.
|
||||
'any' lists members with delivery disabled for any reason.
|
||||
'admin' lists members with delivery disabled by admin.
|
||||
'bounce' lists members with delivery disabled by bounce.
|
||||
'user' lists members with delivery disabled by the member.
|
||||
'unknown' lists members with delivery disabled by mailman 2.0
|
||||
'enabled' lists members with delivery enabled.
|
||||
|
||||
--csv
|
||||
-c
|
||||
This option overrides the above four selection options and lists
|
||||
all members, one per line, with comma separated, quoted values as
|
||||
follows:
|
||||
"full name" if available, else "","email address","mod",
|
||||
"hide","nomail" ("off" or "[A]" or "[B]" or "[U]" or "[?]"),
|
||||
"ack","not metoo","nodupes","digest","plain"
|
||||
analogous to the admin membership list (the values of the 'checkbox'
|
||||
fields are either "off" or "on"). A title line with the above names
|
||||
is listed before the member lines.
|
||||
|
||||
--url_path path
|
||||
-u path
|
||||
If the list admin pages are accessed at your site via a URL of form
|
||||
different from http://hostname/mailman/admin/listname, you need to
|
||||
specify the path portion of the URL that is between hostname and
|
||||
/listname with this option. For example, a URL such as
|
||||
http://hostname/admin.cgi/listname requires the option
|
||||
--url_path /admin.cgi
|
||||
or
|
||||
-u /admin.cgi
|
||||
and a URL like http://hostname/cgi-bin/mailman/admin/listname
|
||||
requires the option
|
||||
--url_path /cgi-bin/mailman/admin
|
||||
or
|
||||
-u /cgi-bin/mailman/admin
|
||||
Default value is /mailman/admin.
|
||||
|
||||
--unhide
|
||||
-U
|
||||
Set the 'hidden' flag off for all list members including those not
|
||||
selected for output. This will take a long time if there are a lot
|
||||
of hidden members. The -v option prints '.' after every 100 unhides.
|
||||
This option is only effective with Mailman versions up to 2.1.22
|
||||
because it doesn't account for CSRF checks introduced in 2.1.23.
|
||||
|
||||
--ssl
|
||||
-s
|
||||
Use https instead of http for accessing the list.
|
||||
|
||||
--verbose
|
||||
-v
|
||||
Include extra progress output.
|
||||
|
||||
--help
|
||||
-h
|
||||
Print this help message and exit
|
||||
|
||||
hostname is the name used in the URL of the list's web interface
|
||||
listname is the name of the mailing list
|
||||
password is the list's admin password
|
||||
|
||||
The list of subscribers is fetched from the web administrative
|
||||
interface. Using the bin/list_members program from a shell
|
||||
account is preferable, but not always available.
|
||||
|
||||
Tested with the Mailman 2.1.5 - 2.1.29 Membership list layout, but the
|
||||
--unhide option only works up to 2.1.22.
|
||||
|
||||
If Python 2.4's cookielib is available, use it. Otherwise require
|
||||
ClientCookie http://wwwsearch.sourceforge.net/ClientCookie/
|
||||
|
||||
This script runs on your workstation and requires that you have Python
|
||||
<http://www.python.org> installed. It works best with Python 2.4.x
|
||||
through Python 2.7.x. See mailman-subscribers3.py for a Python 3 version.
|
||||
"""
|
||||
|
||||
import sys
|
||||
import re
|
||||
import string
|
||||
import urllib
|
||||
import getopt
|
||||
import httplib
|
||||
import urllib2
|
||||
from time import sleep
|
||||
from HTMLParser import HTMLParser
|
||||
# if we have Python 2.4's cookielib, use it
|
||||
try:
|
||||
import cookielib
|
||||
policy = cookielib.DefaultCookiePolicy(rfc2965 = True)
|
||||
cookiejar = cookielib.CookieJar(policy)
|
||||
opener = urllib2.build_opener(urllib2.HTTPCookieProcessor(cookiejar)).open
|
||||
except ImportError:
|
||||
import ClientCookie
|
||||
# if this is a new ClientCookie, we need to turn on RFC2965 cookies
|
||||
cookiejar = ClientCookie.CookieJar()
|
||||
try:
|
||||
cookiejar.set_policy(ClientCookie.DefaultCookiePolicy(rfc2965 = True))
|
||||
# install an opener that uses this policy
|
||||
opener = ClientCookie.build_opener(
|
||||
ClientCookie.HTTPCookieProcessor(cookiejar))
|
||||
ClientCookie.install_opener(opener)
|
||||
except AttributeError:
|
||||
# must be an old ClientCookie, which already accepts RFC2965 cookies
|
||||
pass
|
||||
opener = ClientCookie.urlopen
|
||||
|
||||
PROGRAM = sys.argv[0]
|
||||
|
||||
try:
|
||||
True, False
|
||||
except NameError:
|
||||
True = 1
|
||||
False = 0
|
||||
|
||||
def usage(code, msg=''):
|
||||
if code:
|
||||
fd = sys.stderr
|
||||
else:
|
||||
fd = sys.stdout
|
||||
print >> fd, __doc__ % globals()
|
||||
if msg:
|
||||
print >> fd, msg
|
||||
sys.exit(code)
|
||||
|
||||
subscribers = {}
|
||||
vnames = ['_realname', '_mod', '_hide', '_nomail', '_ack', '_notmetoo',
|
||||
'_nodupes', '_digest', '_plain']
|
||||
maxchunk = 0
|
||||
letters = ['0']
|
||||
processed_letters = []
|
||||
gotnomail = False
|
||||
|
||||
class MailmanHTMLParser(HTMLParser):
|
||||
'''cheap way to find email addresses and pages with multiple
|
||||
chunks from Mailman 2.1.5 membership pages'''
|
||||
def handle_starttag(self, tag, attrs):
|
||||
global maxchunk, letters, gotnomail, subemail, url_path
|
||||
if tag == 'input':
|
||||
for vname in vnames:
|
||||
s = False
|
||||
for a,v in attrs:
|
||||
if a == 'name' and v.endswith(vname):
|
||||
subemail = v[:-len(vname)]
|
||||
s = True
|
||||
elif a == 'value':
|
||||
subval = v
|
||||
if s:
|
||||
if not subscribers.has_key(subemail):
|
||||
subscribers[subemail] = {}
|
||||
if vname == '_nomail' and subval == "on":
|
||||
gotnomail = True
|
||||
else:
|
||||
if not isinstance(subval, unicode):
|
||||
subval = subval.decode(page_cset, 'replace')
|
||||
subscribers[subemail][vname] = subval.encode(
|
||||
my_cset, 'replace')
|
||||
if tag == 'a':
|
||||
for a,v in attrs:
|
||||
if a == 'href' and v.find("%s/" % (url_path)) >= 0:
|
||||
m = re.search(r'chunk=(?P<chunkno>\d+)', v, re.I)
|
||||
if m:
|
||||
if int(m.group('chunkno')) > maxchunk:
|
||||
maxchunk = int(m.group('chunkno'))
|
||||
m = re.search(r'letter=(?P<letter>.)', v, re.I)
|
||||
if m:
|
||||
letter = m.group('letter')
|
||||
if letter not in letters + processed_letters:
|
||||
letters.append(letter)
|
||||
|
||||
def handle_data(self, data):
|
||||
global gotnomail, subemail
|
||||
if gotnomail:
|
||||
gotnomail = False
|
||||
subscribers[subemail]['_nomail'] = data
|
||||
|
||||
def main():
|
||||
global maxchunk, letters, url_path, my_cset, page_cset
|
||||
try:
|
||||
opts, args = getopt.getopt(sys.argv[1:], "ho:rd:fn:cu:Uvs",
|
||||
["help", "output=", "regular", "digest=", "fullnames",
|
||||
"nomail=", "csv", "url_path=", "unhide", "verbose",
|
||||
"ssl"])
|
||||
except:
|
||||
usage(2)
|
||||
fp = sys.stdout
|
||||
fullnames = False
|
||||
nomail = None
|
||||
verbose = False
|
||||
regular = False
|
||||
digest = None
|
||||
csv = False
|
||||
unhide = False
|
||||
protocol = 'http'
|
||||
url_path = '/mailman/admin'
|
||||
for o,a in opts:
|
||||
if o in ("-v", "--verbose"):
|
||||
verbose = True
|
||||
if o in ("-h", "--help"):
|
||||
usage(0)
|
||||
if o in ("-o", "--output"):
|
||||
fp = open(a, "wt")
|
||||
if o in ("-f", "--fullnames"):
|
||||
fullnames = True
|
||||
if o in ("-n", "--nomail"):
|
||||
nomail = a.lower()
|
||||
if o in ("-r", "--regular"):
|
||||
regular = True
|
||||
if o in ("-d", "--digest"):
|
||||
digest = a.lower()
|
||||
if o in ("-c", "--csv"):
|
||||
csv = True
|
||||
if o in ("-u", "--url_path"):
|
||||
url_path = a
|
||||
if o in ("-U", "--unhide"):
|
||||
unhide = True
|
||||
if o in ("-s", "--ssl"):
|
||||
protocol = 'https'
|
||||
if regular and digest:
|
||||
usage(2, "Both 'regular' and 'digest' will produce an empty list.")
|
||||
if digest not in [None, 'any', 'mime', 'plain']:
|
||||
usage(2, "Digest type %s unrecognized" % digest)
|
||||
if nomail not in [None, 'any', 'admin', 'bounce', 'user', 'unknown',
|
||||
'enabled']:
|
||||
usage(2, "Nomail type %s unrecognized" % nomail)
|
||||
if len(args) != 3:
|
||||
usage(2)
|
||||
|
||||
member_url = '%s://%s%s/%s/members' % (protocol, args[0], url_path,
|
||||
args[1])
|
||||
options_url = '%s://%s%s/%s' % (protocol, args[0],
|
||||
re.sub('admin', 'options', url_path),
|
||||
args[1])
|
||||
p = {'adminpw':args[2]}
|
||||
|
||||
def_cset = sys.getdefaultencoding()
|
||||
if def_cset.lower().endswith('ascii'):
|
||||
def_cset = 'iso-8859-1'
|
||||
my_cset = sys.stdout.encoding or def_cset
|
||||
|
||||
# login, picking up the cookie
|
||||
try:
|
||||
page = opener(member_url, urllib.urlencode(p))
|
||||
except (urllib2.URLError, httplib.InvalidURL), e:
|
||||
if isinstance(e, urllib2.HTTPError) and e.code == 401:
|
||||
usage(1, 'Invalid password.')
|
||||
else:
|
||||
usage(1, """Error accessing %s
|
||||
Supplied host or listname may be incorrect,
|
||||
or you may need to specify --url_path.
|
||||
""" % (member_url))
|
||||
|
||||
# Get the charset of the page, but use iso-8859-1 for ascii or None.
|
||||
page_cset = page.info().getparam('charset') or 'iso-8859-1'
|
||||
if page_cset.lower().endswith('ascii'):
|
||||
page_cset = 'iso-8859-1'
|
||||
|
||||
lines = page.read()
|
||||
page.close()
|
||||
p = {}
|
||||
# Try to recognize the returned page independent of the list language
|
||||
if re.search(r'INPUT\s+type="SUBMIT"\s+name="admlogin"', lines,
|
||||
re.M + re.I):
|
||||
# login page - invalid password
|
||||
usage(1,
|
||||
'Login invalid - possibly incorrect password or missing -s option.')
|
||||
if not re.search(r'<form\s+action=', lines, re.M + re.I):
|
||||
# no <form> tag - admin overview page
|
||||
usage(1, """Non-existent list: %s.
|
||||
If the provided list name is valid, the supplied host may be incorrect
|
||||
or you may need to specify --url_path.
|
||||
""" % args[1])
|
||||
|
||||
# loop through the letters, and all chunks of each
|
||||
while len(letters) > 0:
|
||||
letter = letters[0]
|
||||
letters = letters[1:]
|
||||
processed_letters.append(letter)
|
||||
chunk = 0
|
||||
maxchunk = 0
|
||||
while chunk <= maxchunk:
|
||||
if verbose:
|
||||
print >> sys.stderr, "%c(%d)" % (letter, chunk)
|
||||
while True:
|
||||
try:
|
||||
page = opener(member_url + "?letter=%s&chunk=%d" %
|
||||
(letter, chunk))
|
||||
lines = page.read()
|
||||
page.close()
|
||||
except urllib2.URLError:
|
||||
if verbose:
|
||||
print >> sys.stderr,\
|
||||
'Error encountered in accessing web page.',\
|
||||
'Retrying.'
|
||||
sleep(2)
|
||||
else:
|
||||
break
|
||||
|
||||
parser = MailmanHTMLParser()
|
||||
parser.feed(lines)
|
||||
parser.close()
|
||||
chunk += 1
|
||||
|
||||
subscriberlist = subscribers.items()
|
||||
subscriberlist.sort()
|
||||
|
||||
# print the subscribers list
|
||||
if csv:
|
||||
print >>fp, '"Full name","email address","mod","hide",\
|
||||
"nomail","ack","not metoo","nodupes","digest","plain"'
|
||||
|
||||
nunhide = 0
|
||||
for (email, d) in subscriberlist:
|
||||
if unhide and d['_hide'] == "on":
|
||||
params = urllib.urlencode({'conceal':0,
|
||||
'options-submit':1})
|
||||
u = opener("%s/%s" % (options_url, email), params)
|
||||
u.close()
|
||||
d['_hide'] = "off"
|
||||
nunhide += 1
|
||||
if verbose and nunhide % 100 == 0:
|
||||
print >>sys.stderr, '.',
|
||||
email = urllib.unquote(email)
|
||||
if csv:
|
||||
print >>fp,\
|
||||
'"%s","%s","%s","%s","%s","%s","%s","%s","%s","%s"'\
|
||||
% (d['_realname'], email, d['_mod'], d['_hide'],
|
||||
d['_nomail'], d['_ack'], d['_notmetoo'],
|
||||
d['_nodupes'], d['_digest'], d['_plain'])
|
||||
continue
|
||||
if nomail == 'enabled' and d['_nomail'] <> "off":
|
||||
continue
|
||||
if nomail == 'any' and d['_nomail'] == "off":
|
||||
continue
|
||||
if nomail == 'admin' and d['_nomail'] <> "[A]":
|
||||
continue
|
||||
if nomail == 'bounce' and d['_nomail'] <> "[B]":
|
||||
continue
|
||||
if nomail == 'user' and d['_nomail'] <> "[U]":
|
||||
continue
|
||||
if nomail == 'unknown' and d['_nomail'] <> "[?]":
|
||||
continue
|
||||
if regular and d['_digest'] == "on":
|
||||
continue
|
||||
if digest and d['_digest'] == "off":
|
||||
continue
|
||||
if digest == "mime" and d['_plain'] == "on":
|
||||
continue
|
||||
if digest == "plain" and d['_plain'] == "off":
|
||||
continue
|
||||
if not fullnames or d['_realname'] == "":
|
||||
print >>fp, email
|
||||
else:
|
||||
print >>fp, '%s <%s>' % (d['_realname'], email)
|
||||
|
||||
fp.close()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Reference in New Issue
Block a user