Compare commits
26 Commits
Author | SHA1 | Date |
---|---|---|
mike | 6c98d20626 | |
mike | 233affd26c | |
mike | 35244f2e51 | |
mike | 8a9fd906b4 | |
Mike | 519205f7c5 | |
Mike | 02d0e12bd6 | |
Mike | ed5c553293 | |
Mike | 2052c93cd7 | |
Mike | 2d2f27178e | |
Mike | 4f313473a6 | |
Mike | 4316909b1b | |
Mike | c64fae60c2 | |
Mike | dfa41ef856 | |
Mike | bc2cda49d5 | |
Mike | f3d14eaa51 | |
Mike | 59b2747b1b | |
Mike | f2c5914819 | |
Mike | 1344ac6ca6 | |
Mike | 47851761dc | |
Mike | a546d07bed | |
Mike | fe0c8f18f2 | |
Mike | a063a55d02 | |
Mike | f5986f068b | |
Mike | 41b8996b52 | |
Mike | 8fed1656b4 | |
Mike | b4ab492f96 |
|
@ -1,3 +1,4 @@
|
|||
|
||||
.idea
|
||||
tests
|
||||
|
||||
|
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
{one line to give the program's name and a brief idea of what it does.}
|
||||
Copyright (C) {year} {name of author}
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
{project} Copyright (C) {year} {fullname}
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
49
README.md
49
README.md
|
@ -10,7 +10,13 @@ This can be very useful to detect files which may have been *accidentally delete
|
|||
|
||||
* Python library *humanfriendly*
|
||||
|
||||
``` sudo pip3 install humanfriendly ```
|
||||
* ``` sudo pip3 install humanfriendly ```
|
||||
|
||||
* rsync
|
||||
|
||||
* ```sudo apt install rsync```
|
||||
* ```sudo yum install rsync```
|
||||
* etc
|
||||
|
||||
## How to Execute
|
||||
|
||||
|
@ -30,18 +36,55 @@ You must at minimum specify the source and the backup directories. Following is
|
|||
|
||||
Specifies the path to your source directory
|
||||
|
||||
### --source-remote-host < hostname or ip >
|
||||
|
||||
Specifies the remote host where your source directory resides
|
||||
|
||||
### --source-remote-user < username >
|
||||
|
||||
Specifies the user to connect as, when connecting to a remote host with *--source-remote-host*
|
||||
|
||||
### --backup-path < path >
|
||||
|
||||
Specifies the path to your backup directory
|
||||
|
||||
### --backup-remote-host < hostname or ip >
|
||||
|
||||
Specifies the remote host where your backup directory resides
|
||||
|
||||
### --backup-remote-user < username >
|
||||
|
||||
Specifies the user to connect as, when connecting to a remote host with *--backup-remote-host*
|
||||
|
||||
### --ssh-key < key path >
|
||||
|
||||
Specifies the SSH key to use, when connecting to remote hosts.
|
||||
|
||||
When omitted, and also connecting to a remote host, the default key for the current user will be used (probably).
|
||||
|
||||
### --use-rsync
|
||||
|
||||
Force this tool to use rsync for comparison. If not specified, directories and files will just be compared normally. In the future, the non-rsync mode might be removed.
|
||||
|
||||
### --rsync
|
||||
|
||||
Same as *--use-rsync*
|
||||
|
||||
### --no-clean
|
||||
|
||||
Don't make any attempt to clean the generated report of redundant entries. This might be useful if you think the report isn't accurate.
|
||||
|
||||
#### Example Call With Arguments
|
||||
|
||||
Here's an example of how you might invoke the script:
|
||||
Here's an example of how you might invoke the script with two local directories:
|
||||
|
||||
```python3 /path/to/backup-diff.py --source-path "/my/source/directory/path" --backup-path "/my/backups/main-backup" ```
|
||||
```
|
||||
python3 /path/to/backup-diff.py --source-path "/my/source/directory/path" --backup-path "/my/backups/main-backup"
|
||||
```
|
||||
|
||||
Here's an example of how you might compare a local directory with a remote backup:
|
||||
|
||||
```
|
||||
python3 /path/to/backup-diff.py --source-path "/my/local/source/directory/path" --backup-path "/path/on/remote/server/backups/main-backup" --backup-remote-host "example.com" --backup-remote-user "me123" --ssh-key "/path/to/my/ssh/key"
|
||||
```
|
||||
|
||||
|
|
496
backup-diff.py
496
backup-diff.py
|
@ -1,4 +1,4 @@
|
|||
#!/usr/env python3
|
||||
#!/usr/bin/env python3
|
||||
|
||||
"""
|
||||
|
||||
|
@ -18,6 +18,8 @@ import datetime
|
|||
import functools
|
||||
import humanfriendly
|
||||
import os
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
|
||||
|
@ -27,7 +29,14 @@ class BackupDiff:
|
|||
def __init__(self):
|
||||
|
||||
self.__source_path = None
|
||||
self.__source_ssh_host = None
|
||||
self.__source_ssh_user = None
|
||||
|
||||
self.__backup_path = None
|
||||
self.__backup_ssh_host = None
|
||||
self.__backup_ssh_user = None
|
||||
|
||||
self.__ssh_key = None
|
||||
|
||||
self.__source_path_items = None
|
||||
self.__backup_path_items = None
|
||||
|
@ -35,10 +44,12 @@ class BackupDiff:
|
|||
self.__difference_entries = None
|
||||
self.__do_clean_difference_entries = True
|
||||
|
||||
self.__force_rsync = False
|
||||
|
||||
def run(self):
|
||||
|
||||
self.consume_arguments()
|
||||
self.calculate_comparison_items()
|
||||
|
||||
self.calculate_difference_entries()
|
||||
|
||||
if self.__do_clean_difference_entries:
|
||||
|
@ -55,33 +66,78 @@ class BackupDiff:
|
|||
|
||||
def log(self, s, o=None):
|
||||
|
||||
now = self.current_time()
|
||||
|
||||
to_log = "[" + now + "][Mike's Backup Diff] " + str(s)
|
||||
to_log = self.make_log_prefix() + str(s)
|
||||
if o is not None:
|
||||
to_log += " " + str(o)
|
||||
|
||||
print(to_log)
|
||||
|
||||
def make_log_prefix(self):
|
||||
|
||||
now = self.current_time()
|
||||
|
||||
prefix = "[" + now + "][Mike's Backup Diff] "
|
||||
|
||||
return prefix
|
||||
|
||||
def consume_arguments(self):
|
||||
|
||||
for i in range(1, len(sys.argv)):
|
||||
i = 0
|
||||
while i + 1 < len(sys.argv):
|
||||
|
||||
i += 1
|
||||
|
||||
arg = sys.argv[i]
|
||||
# print("I:", i, "; arg:", arg)
|
||||
|
||||
if arg == "--source-path":
|
||||
i, one_path = self.consume_argument_companion(i)
|
||||
self.__source_path = os.path.abspath(one_path)
|
||||
self.log("Found source path argument:", self.__source_path)
|
||||
|
||||
elif arg == "--source-remote-host":
|
||||
i, host = self.consume_argument_companion(i)
|
||||
self.__source_ssh_host = host
|
||||
self.log("Will use source remote host: " + str(self.__source_ssh_host))
|
||||
|
||||
elif arg == "--source-remote-user":
|
||||
i, user = self.consume_argument_companion(i)
|
||||
self.__source_ssh_user = user
|
||||
self.log("Will use source remote user: " + str(self.__source_ssh_user))
|
||||
|
||||
elif arg == "--backup-path":
|
||||
i, one_path = self.consume_argument_companion(i)
|
||||
self.__backup_path = os.path.abspath(one_path)
|
||||
self.log("Found backup destination path argument:", self.__backup_path)
|
||||
|
||||
elif arg == "--backup-remote-host":
|
||||
i, host = self.consume_argument_companion(i)
|
||||
self.__backup_ssh_host = host
|
||||
self.log("Will use backup remote host: " + str(self.__backup_ssh_host))
|
||||
|
||||
elif arg == "--backup-remote-user":
|
||||
i, user = self.consume_argument_companion(i)
|
||||
self.__backup_ssh_user = user
|
||||
self.log("Will use backup remote user: " + str(self.__backup_ssh_user))
|
||||
|
||||
elif arg == "--ssh-key":
|
||||
i, key = self.consume_argument_companion(i)
|
||||
self.__ssh_key = key
|
||||
self.log("Will use ssh key: " + str(self.__ssh_key))
|
||||
|
||||
elif arg == "--use-rsync" or arg == "--rsync":
|
||||
self.__force_rsync = True
|
||||
self.log("Forcing comparison with rsync tool")
|
||||
|
||||
elif arg == "--no-clean":
|
||||
self.__do_clean_difference_entries = False
|
||||
self.log("Won't clean Difference entries")
|
||||
|
||||
else:
|
||||
self.log("The heck are you doing?")
|
||||
self.log("Unsupported argument: " + arg)
|
||||
self.log("i is: " + str(i))
|
||||
raise Exception("THE HECK")
|
||||
|
||||
@staticmethod
|
||||
def consume_argument_companion(arg_index):
|
||||
|
@ -90,7 +146,9 @@ class BackupDiff:
|
|||
if companion_index >= len(sys.argv):
|
||||
raise Exception("Expected argument after", sys.argv[arg_index])
|
||||
|
||||
return companion_index, sys.argv[companion_index]
|
||||
return_index = companion_index
|
||||
|
||||
return return_index, sys.argv[companion_index]
|
||||
|
||||
def calculate_comparison_items(self):
|
||||
|
||||
|
@ -104,13 +162,31 @@ class BackupDiff:
|
|||
if not os.path.isdir(self.__source_path):
|
||||
raise Exception("Source path isn't a valid directory")
|
||||
|
||||
self.log("Consuming source path: " + str(self.__source_path))
|
||||
|
||||
source_path_items = self.consume_dir(self.__source_path)
|
||||
source_path_items = self.strip_root_dir(self.__source_path, source_path_items)
|
||||
|
||||
self.log("Consumed source path items: " + str(len(source_path_items)))
|
||||
self.log("Done consuming source path items: " + str(len(source_path_items)))
|
||||
|
||||
self.__source_path_items = source_path_items
|
||||
|
||||
def should_use_rsync(self):
|
||||
|
||||
if self.__force_rsync:
|
||||
return True
|
||||
|
||||
if self.__source_ssh_host or self.__source_ssh_user:
|
||||
return True
|
||||
|
||||
if self.__backup_ssh_host or self.__backup_ssh_user:
|
||||
return True
|
||||
|
||||
if self.__ssh_key:
|
||||
return True
|
||||
|
||||
return False
|
||||
|
||||
def consume_backup_path(self):
|
||||
|
||||
if self.__backup_path is None:
|
||||
|
@ -118,10 +194,12 @@ class BackupDiff:
|
|||
if not os.path.isdir(self.__backup_path):
|
||||
raise Exception("Backup destination path isn't a valid directory")
|
||||
|
||||
self.log("Consuming backup path: " + str(self.__backup_path))
|
||||
|
||||
backup_path_items = self.consume_dir(self.__backup_path)
|
||||
backup_path_items = self.strip_root_dir(self.__backup_path, backup_path_items)
|
||||
|
||||
self.log("Consumed backup path items: " + str(len(backup_path_items)))
|
||||
self.log("Done consuming backup path items: " + str(len(backup_path_items)))
|
||||
|
||||
self.__backup_path_items = backup_path_items
|
||||
|
||||
|
@ -151,6 +229,248 @@ class BackupDiff:
|
|||
return paths
|
||||
|
||||
def calculate_difference_entries(self):
|
||||
|
||||
if self.should_use_rsync():
|
||||
self.calculate_difference_entries_with_rsync()
|
||||
else:
|
||||
self.calculate_difference_entries_directly()
|
||||
|
||||
def calculate_difference_entries_with_rsync(self):
|
||||
|
||||
entries = []
|
||||
|
||||
stdout_lines, stderr_lines, return_code = self.execute_rsync()
|
||||
|
||||
# print("STDOUT LINES:")
|
||||
# print(stdout_lines)
|
||||
|
||||
# print("STDERR LINES:")
|
||||
# print(stderr_lines)
|
||||
|
||||
#
|
||||
self.log("Calculating difference entries ...")
|
||||
|
||||
# Regex patterns
|
||||
pattern_regular = re.compile("""^(?P<line>(?P<flags>[^\s]{11})(?P<item>.*))$""")
|
||||
pattern_message = re.compile("""^(?P<line>\*(?P<message>[\w]+)(?P<item>.*))$""")
|
||||
|
||||
# Iterate over each stdout line
|
||||
for line in stdout_lines:
|
||||
|
||||
# Try to match regular expressions
|
||||
match_regular = pattern_regular.match(line)
|
||||
match_message = pattern_message.match(line)
|
||||
|
||||
# Regular line (Flags and Path)
|
||||
if match_regular:
|
||||
|
||||
flags = match_regular.group("flags")
|
||||
change_type_character = flags[0]
|
||||
item_type = flags[1]
|
||||
|
||||
# Determine which attributes are different
|
||||
attributes_part = flags[2:]
|
||||
different_checksum = "c" in attributes_part
|
||||
different_size = "s" in attributes_part
|
||||
different_modification_time = "t" in attributes_part
|
||||
different_permissions = "p" in attributes_part
|
||||
different_owner = "o" in attributes_part
|
||||
different_group = "g" in attributes_part
|
||||
different_acl = "a" in attributes_part
|
||||
different_extended_attributes = "x" in attributes_part
|
||||
#
|
||||
different_any_attribute = (
|
||||
different_checksum
|
||||
or different_size
|
||||
or different_modification_time
|
||||
or different_permissions
|
||||
or different_owner
|
||||
or different_group
|
||||
or different_acl
|
||||
or different_extended_attributes
|
||||
)
|
||||
|
||||
item = match_regular.group("item").strip()
|
||||
|
||||
entry = DifferenceEntry(item)
|
||||
|
||||
# File folder, whatever
|
||||
if item_type == "d":
|
||||
entry.set_is_dir()
|
||||
elif item_type == "f":
|
||||
entry.set_is_file()
|
||||
|
||||
# Different attributes
|
||||
# (before 'missing' stuff, because attribute syncs show up as xfers)
|
||||
if different_checksum:
|
||||
entry.set_is_different_checksum()
|
||||
elif different_size:
|
||||
entry.set_is_different_sizes()
|
||||
elif different_modification_time:
|
||||
entry.set_is_different_modification_times()
|
||||
elif different_permissions:
|
||||
entry.set_is_different_permissions()
|
||||
elif different_owner:
|
||||
entry.set_is_different_owner()
|
||||
elif different_group:
|
||||
entry.set_is_different_group()
|
||||
elif different_acl:
|
||||
entry.set_is_different_acl()
|
||||
elif different_extended_attributes:
|
||||
entry.set_is_different_extended_attributes()
|
||||
elif different_any_attribute:
|
||||
entry.set_is_different_attributes()
|
||||
|
||||
# Missing from backup
|
||||
elif change_type_character == "<":
|
||||
entry.set_is_missing_from_backup()
|
||||
# Missing from ... backup? (confusing symbolstuffs)
|
||||
elif change_type_character == ">":
|
||||
entry.set_is_missing_from_backup()
|
||||
|
||||
# Local change is occurring
|
||||
elif change_type_character == "c":
|
||||
entry.set_is_missing_from_backup()
|
||||
|
||||
# Item is a hard link
|
||||
elif change_type_character == "h":
|
||||
entry.set_is_unknown("Rsync says this is a hard link")
|
||||
|
||||
# "no change / transfer (could still be changing attributes)"
|
||||
elif change_type_character == ".":
|
||||
entry.set_is_unknown("Rsync says no change, but could be changing attributes")
|
||||
|
||||
#
|
||||
entries.append(entry)
|
||||
|
||||
# Message line
|
||||
elif match_message:
|
||||
|
||||
message = match_message.group("message").strip()
|
||||
item = match_message.group("item").strip()
|
||||
|
||||
entry = DifferenceEntry(item)
|
||||
|
||||
if message == "deleting":
|
||||
entry.set_is_missing_from_source()
|
||||
entry.set_is_dir(item[-1] == "/")
|
||||
entry.set_is_file(not item[-1] == "/")
|
||||
|
||||
else:
|
||||
self.log("IS UNKNOWN MESSAGE:" + message)
|
||||
entry.set_is_unknown("Unhandled message: " + message)
|
||||
|
||||
entries.append(entry)
|
||||
|
||||
# Unsupported type of line
|
||||
else:
|
||||
|
||||
#
|
||||
self.log("Don't know how to parse this line: " + line)
|
||||
|
||||
self.log("Finished calculating difference entries")
|
||||
|
||||
self.__difference_entries = entries
|
||||
|
||||
def execute_rsync(self):
|
||||
|
||||
#
|
||||
args = list()
|
||||
|
||||
# Rsync
|
||||
args.append("rsync")
|
||||
|
||||
# Dry run!!
|
||||
args.append("--dry-run")
|
||||
|
||||
# Produces the main output we'll parse
|
||||
args.append("--itemize-changes")
|
||||
|
||||
# Rsh command
|
||||
rsh_command = self.make_rsync_rsh_argument(self.__ssh_key)
|
||||
if rsh_command:
|
||||
args.append(rsh_command)
|
||||
|
||||
# Main sync flags
|
||||
args.append("--archive")
|
||||
args.append("--delete")
|
||||
|
||||
# Source path
|
||||
args.append(self.make_rsync_path(self.__source_ssh_host, self.__source_ssh_user, self.__source_path))
|
||||
|
||||
# Backup path
|
||||
args.append(self.make_rsync_path(self.__backup_ssh_host, self.__backup_ssh_user, self.__backup_path))
|
||||
|
||||
#
|
||||
self.log("Executing rsync")
|
||||
# self.log("Executing rsync with the following arguments:")
|
||||
# self.log(str(args))
|
||||
# self.log(" ".join(args))
|
||||
|
||||
# Start the subprocess
|
||||
process = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||
|
||||
# Live output of stdout
|
||||
print()
|
||||
stdout_lines = []
|
||||
for line in iter(process.stdout.readline, b''):
|
||||
line = line.decode().strip()
|
||||
stdout_lines.append(line)
|
||||
# print(line)
|
||||
self.print_progress_message("Captured " + str(len(stdout_lines)) + " lines from Rsync")
|
||||
|
||||
# Grab all the stderr lines
|
||||
stderr_lines = []
|
||||
for line in iter(process.stderr.readline, b''):
|
||||
line = line.decode().strip()
|
||||
stderr_lines.append(line)
|
||||
|
||||
# Make sure it's completely finished
|
||||
process.communicate()
|
||||
|
||||
self.log("Rsync has finished executing")
|
||||
|
||||
# Accept Success (0), and Partial Transfer Codes (23 and 24)
|
||||
if process.returncode not in [0, 23, 24]:
|
||||
raise Exception("Failed to execute Rsync; Exited with code " + str(process.returncode))
|
||||
|
||||
return stdout_lines, stderr_lines, process.returncode
|
||||
|
||||
@staticmethod
|
||||
def make_rsync_path(ssh_host, ssh_user, path):
|
||||
|
||||
rsync_path = ""
|
||||
|
||||
if (not ssh_host) and ssh_user:
|
||||
raise Exception("ssh_user provided (" + str(ssh_user) + ") without ssh_host")
|
||||
|
||||
if ssh_user:
|
||||
rsync_path += ssh_user + "@"
|
||||
|
||||
if ssh_host:
|
||||
rsync_path += ssh_host + ":" + path
|
||||
else:
|
||||
rsync_path += path
|
||||
|
||||
# Absolute path doesn't have trailing slash, which works well for rsync here
|
||||
rsync_path += "/"
|
||||
|
||||
return rsync_path
|
||||
|
||||
@staticmethod
|
||||
def make_rsync_rsh_argument(ssh_key):
|
||||
|
||||
if not ssh_key:
|
||||
return None
|
||||
|
||||
if not os.path.isfile(ssh_key):
|
||||
raise Exception("SSH key does not exist: " + str(ssh_key))
|
||||
|
||||
return "--rsh=ssh -i " + ssh_key
|
||||
|
||||
def calculate_difference_entries_directly(self):
|
||||
|
||||
self.calculate_comparison_items()
|
||||
|
||||
entries = []
|
||||
|
||||
|
@ -195,18 +515,25 @@ class BackupDiff:
|
|||
if entries is None:
|
||||
entries = self.__difference_entries
|
||||
|
||||
self.log("Cleaning difference entries")
|
||||
self.log("Cleaning " + str(len(entries)) + " difference entries")
|
||||
|
||||
# Build a temp list of all known difference entries
|
||||
# *that refer to a missing directory*
|
||||
temp_entries = []
|
||||
for entry in entries:
|
||||
temp_entries.append(entry)
|
||||
if entry.get_is_missing_from_source() or entry.get_is_missing_from_backup():
|
||||
if entry.get_is_dir():
|
||||
temp_entries.append(entry)
|
||||
# print("Temp entries count:", len(temp_entries))
|
||||
|
||||
# Loop through entries, attempting to clean for one at a time,
|
||||
# until no cleaning has been done
|
||||
print()
|
||||
clean_iterations = 0
|
||||
while True:
|
||||
|
||||
clean_iterations += 1
|
||||
|
||||
most_shallow_entry = None
|
||||
|
||||
# Locate the most shallow entry
|
||||
|
@ -227,11 +554,27 @@ class BackupDiff:
|
|||
|
||||
# Finish if we haven't found anything
|
||||
if not most_shallow_entry:
|
||||
self.print_progress_message(
|
||||
"Cleaning difference entries; "
|
||||
+ str(clean_iterations) + " iterations; "
|
||||
+ str(len(temp_entries)) + " in examination pool; "
|
||||
+ str(len(entries)) + " total"
|
||||
)
|
||||
break
|
||||
|
||||
# Remove this entry from the temp list, and clean with it as root
|
||||
temp_entries.remove(most_shallow_entry)
|
||||
self.clean_child_difference_entries(entries, most_shallow_entry)
|
||||
self.clean_child_difference_entries(temp_entries, most_shallow_entry)
|
||||
|
||||
self.log(
|
||||
"Cleaning difference entries; "
|
||||
+ str(clean_iterations) + " iterations; "
|
||||
+ str(len(temp_entries)) + " in examination pool; "
|
||||
+ str(len(entries)) + " total"
|
||||
)
|
||||
|
||||
self.__difference_entries = entries
|
||||
|
||||
def clean_child_difference_entries(self, entries: list, root_entry):
|
||||
|
||||
|
@ -242,12 +585,22 @@ class BackupDiff:
|
|||
# print(root_entry)
|
||||
|
||||
root_entry_item = root_entry.get_item()
|
||||
# print("Cleaning child entries for root entry")
|
||||
# print(root_entry)
|
||||
# print()
|
||||
# print()
|
||||
|
||||
entries_to_delete = []
|
||||
|
||||
# Check every other entry as a possible child of the root
|
||||
print("")
|
||||
child_iteration = 0
|
||||
for child_entry in entries:
|
||||
|
||||
child_iteration += 1
|
||||
|
||||
self.print_progress_message("Looking for child entry to clean " + str(child_iteration))
|
||||
|
||||
if child_entry != root_entry:
|
||||
|
||||
child_entry_item = child_entry.get_item()
|
||||
|
@ -263,9 +616,21 @@ class BackupDiff:
|
|||
# print("Deleting unneeded child entry:")
|
||||
# print("> Root:", root_entry_item)
|
||||
# print("> Child:", child_entry_item)
|
||||
# print()
|
||||
# print()
|
||||
|
||||
# Handle entries to delete
|
||||
print("")
|
||||
delete_iteration = 0
|
||||
for entry in entries_to_delete:
|
||||
|
||||
delete_iteration += 1
|
||||
|
||||
self.print_progress_message(
|
||||
"Deleting child entry "
|
||||
+ str(delete_iteration) + " / " + str(len(entries_to_delete))
|
||||
)
|
||||
|
||||
entries.remove(entry)
|
||||
|
||||
return len(entries_to_delete) > 0
|
||||
|
@ -439,6 +804,14 @@ class BackupDiff:
|
|||
"size_difference": {
|
||||
"label": "Items with different file sizes",
|
||||
"entries": []
|
||||
},
|
||||
"different_attributes": {
|
||||
"label": "Items with different attributes",
|
||||
"entries": []
|
||||
},
|
||||
"unknown": {
|
||||
"label": "Differences of an unknown type",
|
||||
"entries": []
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -476,6 +849,16 @@ class BackupDiff:
|
|||
for entry in self.__difference_entries:
|
||||
if entry.get_is_different_sizes():
|
||||
report["size_difference"]["entries"].append(entry)
|
||||
|
||||
# Different attributes
|
||||
for entry in self.__difference_entries:
|
||||
if entry.get_is_different_attributes():
|
||||
report["different_attributes"]["entries"].append(entry)
|
||||
|
||||
# Differences of an unknown nature
|
||||
for entry in self.__difference_entries:
|
||||
if entry.get_is_unknown():
|
||||
report["unknown"]["entries"].append(entry)
|
||||
|
||||
# Sort all entries
|
||||
for section_key in report:
|
||||
|
@ -483,12 +866,14 @@ class BackupDiff:
|
|||
|
||||
return report
|
||||
|
||||
@staticmethod
|
||||
def print_progress_message(s):
|
||||
def print_progress_message(self, s):
|
||||
|
||||
sys.stdout.write("\033[F") # back to previous line
|
||||
sys.stdout.write("\033[K") # clear line
|
||||
print(s)
|
||||
|
||||
to_print = self.make_log_prefix() + s
|
||||
|
||||
print(to_print)
|
||||
|
||||
@staticmethod
|
||||
def print_report_heading(s, hooded: bool=False):
|
||||
|
@ -511,10 +896,13 @@ class BackupDiff:
|
|||
"missing_from_both",
|
||||
"missing_from_source", "newer_source",
|
||||
"missing_from_backup", "newer_backup",
|
||||
"size_difference"
|
||||
"size_difference",
|
||||
"different_attributes",
|
||||
"unknown"
|
||||
]
|
||||
|
||||
#
|
||||
print()
|
||||
self.print_report_heading("Mike's Backup Diff Report", True)
|
||||
print("Source:", self.__source_path)
|
||||
print("Backup:", self.__backup_path)
|
||||
|
@ -524,6 +912,7 @@ class BackupDiff:
|
|||
for section_key in section_order:
|
||||
if len(report[section_key]["entries"]):
|
||||
found_anything = True
|
||||
print("")
|
||||
self.print_report_heading(report[section_key]["label"])
|
||||
for entry in report[section_key]["entries"]:
|
||||
|
||||
|
@ -534,12 +923,22 @@ class BackupDiff:
|
|||
else:
|
||||
prefix = ""
|
||||
|
||||
print(prefix + entry.get_item())
|
||||
message = entry.get_message()
|
||||
if message:
|
||||
suffix = " (" + message + ")"
|
||||
else:
|
||||
suffix = ""
|
||||
|
||||
print("")
|
||||
print(prefix + entry.get_item() + suffix)
|
||||
|
||||
# Lil debebuggin'
|
||||
for section_key in report:
|
||||
if section_key not in section_order:
|
||||
raise Exception("Report key " + section_key + " wasn't found in the section_order ... whoopsies")
|
||||
|
||||
if not found_anything:
|
||||
print("Everything seems to match")
|
||||
print()
|
||||
print("Everything seems to match !")
|
||||
|
||||
|
||||
#
|
||||
|
@ -560,6 +959,10 @@ class DifferenceEntry:
|
|||
self.CONST_TYPE_SOURCE_IS_NEWER = "source_is_newer"
|
||||
self.CONST_TYPE_BACKUP_IS_NEWER = "backup_is_newer"
|
||||
self.CONST_TYPE_DIFFERENT_SIZES = "different_sizes"
|
||||
self.CONST_TYPE_DIFFERENT_ATTRIBUTES = "different_attributes"
|
||||
self.CONST_TYPE_UNKNOWN = "unknown"
|
||||
|
||||
self.set_is_unknown("DEFAULT MESSAGE")
|
||||
|
||||
if item:
|
||||
self.set_item(item)
|
||||
|
@ -583,6 +986,12 @@ class DifferenceEntry:
|
|||
|
||||
return self.__item
|
||||
|
||||
def set_message(self, m):
|
||||
self.__message = m
|
||||
|
||||
def get_message(self):
|
||||
return self.__message
|
||||
|
||||
def set_is_dir(self, is_dir: bool=True):
|
||||
|
||||
if is_dir:
|
||||
|
@ -615,14 +1024,14 @@ class DifferenceEntry:
|
|||
def set_is_missing_from_source(self):
|
||||
|
||||
self.__type = self.CONST_TYPE_MISSING_IN_SOURCE
|
||||
self.__message = "Item is in backup but not in source"
|
||||
self.__message = None
|
||||
|
||||
def get_is_missing_from_source(self):
|
||||
return self.__type == self.CONST_TYPE_MISSING_IN_SOURCE
|
||||
|
||||
def set_is_missing_from_backup(self):
|
||||
self.__type = self.CONST_TYPE_MISSING_IN_BACKUP
|
||||
self.__message = "Item is in source but not in backup"
|
||||
self.__message = None
|
||||
|
||||
def get_is_missing_from_backup(self):
|
||||
return self.__type == self.CONST_TYPE_MISSING_IN_BACKUP
|
||||
|
@ -654,15 +1063,54 @@ class DifferenceEntry:
|
|||
def get_backup_is_newer(self):
|
||||
return self.__type == self.CONST_TYPE_BACKUP_IS_NEWER
|
||||
|
||||
def set_is_different_sizes(self, source_item_size, backup_item_size):
|
||||
def set_is_different_sizes(self, source_item_size=None, backup_item_size=None):
|
||||
self.__type = self.CONST_TYPE_DIFFERENT_SIZES
|
||||
self.__message = \
|
||||
"Source has a file size of " + str(source_item_size) \
|
||||
+ ", but backup has a file size of " + str(backup_item_size)
|
||||
|
||||
if source_item_size and backup_item_size:
|
||||
self.__message = \
|
||||
"Source has a file size of " + str(source_item_size) \
|
||||
+ ", but backup has a file size of " + str(backup_item_size)
|
||||
else:
|
||||
self.__message = None
|
||||
|
||||
def get_is_different_sizes(self):
|
||||
return self.__type == self.CONST_TYPE_DIFFERENT_SIZES
|
||||
|
||||
def set_is_different_attributes(self, message=None):
|
||||
self.__type = self.CONST_TYPE_DIFFERENT_ATTRIBUTES
|
||||
self.__message = message
|
||||
|
||||
def get_is_different_attributes(self):
|
||||
return self.__type == self.CONST_TYPE_DIFFERENT_ATTRIBUTES
|
||||
|
||||
def set_is_different_checksum(self):
|
||||
self.set_is_different_attributes("Different checksums")
|
||||
|
||||
def set_is_different_modification_times(self):
|
||||
self.set_is_different_attributes("Different modification times")
|
||||
|
||||
def set_is_different_permissions(self):
|
||||
self.set_is_different_attributes("Different permissions")
|
||||
|
||||
def set_is_different_owner(self):
|
||||
self.set_is_different_attributes("Different owners")
|
||||
|
||||
def set_is_different_group(self):
|
||||
self.set_is_different_attributes("Different groups")
|
||||
|
||||
def set_is_different_acl(self):
|
||||
self.set_is_different_attributes("Different ACLs")
|
||||
|
||||
def set_is_different_extended_attributes(self):
|
||||
self.set_is_different_attributes("Different extended attributes")
|
||||
|
||||
def set_is_unknown(self, message):
|
||||
self.__type = self.CONST_TYPE_UNKNOWN
|
||||
self.__message = message
|
||||
|
||||
def get_is_unknown(self):
|
||||
return self.__type == self.CONST_TYPE_UNKNOWN
|
||||
|
||||
@staticmethod
|
||||
def friendly_time_difference(stamp1, stamp2):
|
||||
delta = abs(stamp1 - stamp2)
|
||||
|
|
Loading…
Reference in New Issue