tblyler/hoarder
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Project is now in Go

Browse source
This commit is contained in:
Tony Blyler 2014-12-23 17:38:01 -05:00
parent 6e94efb517
commit a32e222ce6
9 changed files with 1088 additions and 1133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

877
LICENSE
View file

@ -1,622 +1,281 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Version 2, June 1991
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
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
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) 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.
this service 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.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
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.
gratis or for a fee, you must give the recipients all the rights that
you have. 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.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
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.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
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.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
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
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
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
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
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.
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
13. Use with the GNU Affero General Public License.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
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.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
14. Revised Versions of this License.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest 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
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the 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.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this 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.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
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.
NO WARRANTY
15. Disclaimer of Warranty.
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
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.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE 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.
END OF TERMS AND CONDITIONS
@ -628,15 +287,15 @@ 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
convey 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}
{description}
Copyright (C) {year} {fullname}
This program is free software: you can redistribute it and/or modify
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
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
@ -644,31 +303,37 @@ the "copyright" line and a pointer to where the full notice is found.
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/>.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
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:
If the program is interactive, 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'.
Gnomovision version 69, Copyright (C) year name of author
Gnomovision 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".
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
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/>.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
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>.
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
{signature of Ty Coon}, 1 April 1989
Ty Coon, President of Vice
This 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.

7
README.md
View file

@ -3,12 +3,7 @@ Hoarder
Requirements
------------
- Python 2
- PIP (to install dependencies)
Go
Install
-------
1. Clone the repository
2. Run `pip install -r requirements.txt`
3. Make a config file, `hoarder.conf` based off, `hoarder.conf.ex` to suit your needs
4. Run `python hoarder.py` with Python 2

29
hoarder.conf.ex Normal file
View file

@ -0,0 +1,29 @@
// Configuration for Hoarder
// All fields and values are necessary
// Username for XMLRPC
xml_user: "testuser"
// Password for XMLRPC
xml_pass: "supersecure"
// Address to XMLRPC
xml_address: "https://mysweetaddress:443/xmlrpc"
// Amount of download threads per file
threads: "4"
// Username for logging into the ssh server
ssh_user: "testsshuser"
// Password for the logging into the ssh server
ssh_pass: "bestpasswordever"
// Server address for the ssh server
ssh_server: "sshserveraddress"
// Port for the ssh server
ssh_port: "22"
// Location to temporarily download files
temp_download_dir: "/home/user/tmp_download/"
// Location to move downloaded files from temp_download_dir to
local_download_dir: "/home/user/Downloads/"
// Locaiton to watch for .torrent files
local_torrent_dir: "/home/user/torrent_files/"
// Remote location on the SSH server to download torrent data from
remote_download_dir: "/home/user/files/"
// Remote location on the SSH server to upload .torrent files to
remote_torrent_dir: "/home/user/watch/"

257
hoarder.go Normal file
View file

@ -0,0 +1,257 @@
// Watch a torrent directory, poll rtorrent, and download completed torrents over SFTP.
package main
import (
"errors"
"github.com/adampresley/sigint"
"io/ioutil"
"log"
"os"
"path/filepath"
"strings"
"time"
)
// Load information from a given config file config_path
func loadConfig(config_path string) (map[string]string, error) {
file, err := os.Open(config_path)
if err != nil {
log.Println("Failed to open configuration file " + config_path)
return nil, err
}
data, err := ioutil.ReadAll(file)
if err != nil {
log.Println("Failed to read configuration file " + config_path)
return nil, err
}
config := make(map[string]string)
lines := strings.Split(string(data), "\n")
for _, line := range lines {
line = strings.TrimSpace(line)
// Ignore comments
if len(line) <= 2 || line[:2] == "//" {
continue
}
// Ignore malformed lines
sep_position := strings.Index(line, ": \"")
if sep_position == -1 {
continue
}
config[line[:sep_position]] = line[sep_position + 3:len(line) - 1]
}
return config, nil
}
// Checker routine to see if torrents are completed
func checker(config map[string]string, checker_chan <- chan map[string]string, com chan <- error) error {
for {
torrent_info := <-checker_chan
log.Println("Started checking " + torrent_info["torrent_path"])
torrent, err := NewTorrent(config["xml_user"], config["xml_pass"], config["xml_address"], torrent_info["torrent_path"])
if err != nil {
log.Println("Failed to initialize torrent for " + torrent_info["torrent_path"] + ": " + err.Error())
continue
}
syncer, err := NewSync(config["threads"], config["ssh_user"], config["ssh_pass"], config["ssh_server"], config["ssh_port"])
if err != nil {
log.Println("Failed to create a new sync: " + err.Error())
com <- err
return err
}
destination_torrent := filepath.Join(config["remote_torrent_dir"], filepath.Base(torrent.path))
exists, err := syncer.Exists(destination_torrent)
if err != nil {
log.Println("Failed to see if " + torrent_info["torrent_path"] + " already exists on the server: " + err.Error())
com <- err
return err
}
if !exists {
err = syncer.SendFiles(map[string]string{torrent.path: destination_torrent})
if err != nil {
log.Println("Failed to send " + torrent.path + " to the server: " + err.Error())
com <- err
return err
}
// continue because rtorrent more than likely will not finish the torrent by the next call
continue
}
completed, err := torrent.GetTorrentComplete()
if err != nil {
log.Println("Failed to see if " + torrent.path + " is completed: " + err.Error())
com <- err
return err
}
name, err := torrent.GetTorrentName()
if err != nil {
com <- err
return err
}
if completed {
log.Println(name + " is completed, starting download now")
remote_download_path := filepath.Join(config["remote_download_dir"], name)
exists, err := syncer.Exists(remote_download_path)
if err != nil {
log.Println("Failed to see if " + remote_download_path + " exists: " + err.Error())
com <- err
return err
}
// file/dir to downlaod does not exist!
if !exists {
err = errors.New(remote_download_path + " does not exist on remote server")
com <- err
return err
}
completed_destination := filepath.Join(config["local_download_dir"], name)
_, err = os.Stat(completed_destination)
if err == nil {
err = errors.New(completed_destination + " already exists, not downloading")
continue
} else if !os.IsNotExist(err) {
log.Println("Failed to stat: " + completed_destination + ": " + err.Error())
com <- err
return err
}
err = syncer.GetPath(remote_download_path, config["temp_download_dir"])
if err != nil {
log.Println("Failed to download " + remote_download_path + ": " + err.Error())
com <- err
return err
}
log.Println("Successfully downloaded " + name)
temp_destination := filepath.Join(config["temp_download_dir"], name)
err = os.Rename(temp_destination, completed_destination)
if err != nil {
log.Println("Failed to move " + temp_destination + " to " + completed_destination + ": " + err.Error())
com <- err
return err
}
err = os.Remove(torrent.path)
if err != nil && !os.IsNotExist(err) {
log.Println("Failed to remove " + torrent.path + ": " + err.Error())
com <- err
return err
}
} else {
log.Println(name + " is not completed, waiting for it to finish")
}
}
com <- nil
return nil
}
// Scanner routine to see if there are new torrent_files
func scanner(config map[string]string, checker_chan chan <- map[string]string, com chan <- error) error {
watch_dirs := map[string]string{config["local_torrent_dir"]: config["local_download_dir"]}
dir_contents, err := ioutil.ReadDir(config["local_torrent_dir"])
if err != nil {
com <- err
return err
}
for _, file := range dir_contents {
if file.IsDir() {
watch_dirs[filepath.Join(config["local_torrent_dir"], file.Name())] = filepath.Join(config["local_download_dir"], file.Name())
}
}
for {
for watch_dir, download_dir := range watch_dirs {
torrent_files, err := ioutil.ReadDir(watch_dir)
if err != nil {
com <- err
return err
}
for _, torrent_file := range torrent_files {
if torrent_file.IsDir() {
// skip because we don't do more than one level of watching
continue
}
checker_chan <- map[string]string{
"torrent_path": filepath.Join(watch_dir, torrent_file.Name()),
"local_download_dir": download_dir,
}
}
}
time.Sleep(time.Second * 30)
}
com <- nil
return nil
}
func main() {
sigint.ListenForSIGINT(func() {
log.Println("Quiting")
os.Exit(1)
})
log.Println("Reading configuration file")
config, err := loadConfig("hoarder.conf")
if err != nil {
log.Println(err)
os.Exit(1)
}
log.Println("Successfully read configuration file")
checker_chan := make(chan map[string]string, 50)
if err != nil {
log.Println(err)
os.Exit(1)
}
log.Println("Starting the scanner routine")
scanner_com := make(chan error)
go scanner(config, checker_chan, scanner_com)
log.Println("Starting the checker routine")
checker_com := make(chan error)
go checker(config, checker_chan, checker_com)
for {
select {
case err := <-scanner_com:
if err != nil {
log.Println("Scanner failed: " + err.Error())
os.Exit(1)
}
case err := <-checker_com:
if err != nil {
log.Println("Checker failed: " + err.Error())
os.Exit(1)
}
}
time.Sleep(time.Second * 5)
}
}

2
requirements.txt
View file

@ -1,2 +0,0 @@
python-daemon==1.6
BitTorrent-bencode==5.0.8.1

134
rtorrent.go Normal file
View file

@ -0,0 +1,134 @@
// Communicates with rtorrent's XMLRPC interface, and can gather info regarding a .torrent file.
package main
import (
"bytes"
"crypto/sha1"
"encoding/hex"
"errors"
"io"
"io/ioutil"
"net/http"
"os"
"regexp"
"strings"
bencode "github.com/jackpal/bencode-go"
)
// Keeps track of a torrent file's and rtorrent's XMLRPC information.
type Torrent struct {
path string
hash string
xml_user string
xml_pass string
xml_address string
}
// Create a new Torrent instance while computing its hash.
func NewTorrent(xml_user string, xml_pass string, xml_address string, file_path string) (*Torrent, error) {
hash, err := getTorrentHash(file_path)
if err != nil {
return nil, err
}
return &Torrent{file_path, hash, xml_user, xml_pass, xml_address}, nil
}
// Compute the torrent hash for a given torrent file path returning an all caps sha1 hash as a string.
func getTorrentHash(file_path string) (string, error) {
file, err := os.Open(file_path)
if err != nil {
return "", err
}
defer file.Close()
data, err := bencode.Decode(file)
if err != nil {
return "", err
}
decoded, ok := data.(map[string]interface{})
if !ok {
return "", errors.New("unable to convert data to map")
}
var encoded bytes.Buffer
bencode.Marshal(&encoded, decoded["info"])
encoded_string := encoded.String()
hash := sha1.New()
io.WriteString(hash, encoded_string)
hash_string := strings.ToUpper(hex.EncodeToString(hash.Sum(nil)))
return hash_string, nil
}
// Send a command and its argument to the rtorrent XMLRPC and get the response.
func (t Torrent) xmlRpcSend (command string, arg string) (string, error) {
// This is hacky XML to send to the server
buf := []byte("<?xml version='1.0'?>\n" +
"<methodCall>\n" +
"<methodName>" + command + "</methodName>\n" +
"<params>\n" +
"<param>\n" +
"<value><string>" + arg + "</string></value>\n" +
"</param>\n" +
"</params>\n" +
"</methodCall>\n")
buffer := bytes.NewBuffer(buf)
request, err := http.NewRequest("POST", t.xml_address, buffer)
if err != nil {
return "", err
}
// Set the basic HTTP auth if we have a user or password
if t.xml_user != "" || t.xml_pass != "" {
request.SetBasicAuth(t.xml_user, t.xml_pass)
}
client := &http.Client{}
resp, err := client.Do(request)
if err != nil {
return "", err
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return "", err
}
re, err := regexp.Compile("<value><.*>(.*)</.*></value>")
if err != nil {
return "", err
}
values := re.FindAllStringSubmatch(string(body), -1)
if len(values) != 1 {
return "", nil
}
return values[0][1], nil
}
// Get the torrent's name from rtorrent.
func (t Torrent) GetTorrentName() (string, error) {
return t.xmlRpcSend("d.get_name", t.hash)
}
// Get the completion status of the torrent from rtorrent.
func (t Torrent) GetTorrentComplete() (bool, error) {
complete, err := t.xmlRpcSend("d.get_complete", t.hash)
if err != nil {
return false, err
}
return complete == "1", nil
}

22
src/hoarder.conf.ex
View file

@ -1,22 +0,0 @@
{
"torrent_files": "Path to torrent files that are uploaded",
"local_download_dir": "Path to download torrent data to",
"xmlrpc": {
"transport": "https",
"user": "username for xmlrpc goes here",
"password": "password for xmlrpc goes here",
"host": "host for xmlrpc goes here",
"port": "443",
"path": "path for xmlrpc goes here"
},
"torrent_download": {
"download_dir": "location that the remote server downloads torrent data to",
"watch_dir": "location that the remote server watches for new torrent files",
"user": "SSH username for remote server",
"host": "SSH host for remote server",
"port": "22",
"children": "2"
}
}

496
src/hoarder.py
View file

@ -1,496 +0,0 @@
import bencode
import hashlib
import json
import logging
import os
import pipes
import subprocess
import time
import xmlrpclib
"""
Interfaces with an rtorrent XML RPC server
"""
class rtorrentRPC:
"""
Constructor
protocol string used to define the transport protocol for XMLRPC (http, https, etc)
user string used to define the username for XMLRPC
password string used to define the password for XMLRPC
host string used to define the host for XMLRPC
port string/int used to define the port to use for XMLRPC
path string used to define the path for XMLRPC
"""
def __init__(self, protocol, user, password, host, port, path):
# generates the string used for connection
self.connectString = "%s://%s:%s@%s:%s/%s" % (str(protocol), str(user), str(password), str(host), str(port), str(path))
# try to connect to the XMLRPC server
if not self.connect():
logging.warning('Indefinitely retrying to reconnect to "%s"' % self.connectString)
while not self.reconnect():
pass
"""
Determines if we are connected to the XMLRPC server
return bool true if we are connected, false if not
"""
def connected(self):
try:
self.connection.system.client_version()
return True
except:
return False
"""
Try to conect to a server with multiple attempts
attempts int the amount of times to attempt to connect to the XMLRPC server
wait int the amount of seconds to wait between connection attempts
return bool true if we connected, false if not
"""
def reconnect(self, attempts=5, wait=5):
i = 0
while i < attempts:
logging.warning('Attempting to connect to "%s" attempt %d/%d' % (self.connectString, i + 1, attempts))
if self.connect():
return True
time.sleep(wait)
i += 1
return False
"""
Connect to the XMLRPC server
return bool true if we connected, false if not
"""
def connect(self):
try:
self.connection = xmlrpclib.ServerProxy(self.connectString)
logging.info('Successfully connected to "%s"' % self.connectString)
return self.connected()
except:
logging.warning('Failed to connect to "%s"' % self.connectString)
return False
"""
Determines if a given torrent hash is completed or not
hash string torrent hash to check on
return bool true if it is complete, false if not, null if we have a connection issue
"""
def torrentComplete(self, hash):
try:
return self.connection.d.get_complete(hash) == 1
except xmlrpclib.Fault:
logging.warning('"%s" hash does not exist' % hash)
return False
except:
logging.warning('Lost connection to "%s"' % self.connectString)
# attempt to reconnect and run the query again
if self.reconnect():
return self.torrentComplete(hash)
return None
"""
Gets the torrent name for the given torrent hash
hash string torrent hash to check on
return string the name of the torrent hash, false if it does not exist, null if we have a connection issue
"""
def torrentName(self, hash):
try:
return self.connection.d.get_name(hash)
except xmlrpclib.Fault:
logging.warning('"%s" hash does not exist' % hash)
return False
except:
logging.warning('Lost connection to "%s"' % self.connectString)
# attempt to reconnect and run the query again
if self.reconnect():
return self.torrentName(hash)
return None
"""
Scans a directory for torrents and checks their completion status on the XMLRPC server
"""
class fileScan(rtorrentRPC):
"""
Constructor
baseDir the location of the torrent files
protocol string used to define the transport protocol for XMLRPC (http, https, etc)
user string used to define the username for XMLRPC
password string used to define the password for XMLRPC
host string used to define the host for XMLRPC
port string/int used to define the port to use for XMLRPC
path string used to define the path for XMLRPC
"""
def __init__(self, baseDir, protocol, user, password, host, port, path):
# call our parent's constructor
rtorrentRPC.__init__(self, protocol, user, password, host, port, path)
# list of completed torrents [{'file': path, 'name': torrent_name}]
self.completed = []
# make sure we have a trailing slash
self.baseDir = baseDir
if self.baseDir[-1] != '/':
self.baseDir += '/'
"""
Gets a list of completed torrents from the self.baseDir path.
return True on success, None on connection issues
"""
def updateCompleted(self):
try:
logging.info('Scanning for torrent files')
for root, dirs, files in os.walk(self.baseDir, followlinks=True):
for file in files:
path = root + file
hash = self.hashInfo(path)
if not hash:
logging.info('Skipping "%s", not a torrent file' % path)
else:
logging.debug('Hash for "%s" is "%s"' % (path, hash))
skip = False
for queued in self.completed:
if queued['file'] == path:
skip = True
break
if skip:
logging.debug('"%s" is already queued' % path)
continue
isCompleted = self.torrentComplete(hash)
if isCompleted == None:
return None
name = self.torrentName(hash)
if name == None:
return None
if isCompleted:
if name != False:
logging.info('"%s" is completed, adding to download list' % name)
self.completed.append({'file': path, 'name': name})
else:
logging.info('Skipping "%s", not finished downloading' % name)
except:
return None
return True
"""
Get the torrent hash for a given filePath
filePath string the path to a torrent file to hash
return string the torrent hash of the file, false if there is an error parsing
"""
@staticmethod
def hashInfo(filePath):
try:
return hashlib.sha1(bencode.bencode(bencode.bdecode(open(filePath, 'rb').read())['info'])).hexdigest().upper()
except:
return False
"""
Used for pushing torrent files to the server and pulling the actual data
"""
class puller:
"""
Constructor
files list output from fileScan.completed
username string the username used to connect to the remote server
host string the location for the remote server
port string/int the port used to connect to the remote server
baseDir string the path the data is stored at remotely
localDir string the path to download the data to
torrentDir string the path where the local torrent files are located
watchDir string the path where the remote server stores torrent files
children int the amount of children to use for downloading
"""
def __init__(self, files, username, host, port, baseDir, localDir, torrentDir, watchDir, children=2):
# the last time we pushed torrent files to the server
self.lastPush = -1
self.files = files
self.processes = []
self.children = children
self.username = str(username)
self.host = str(host)
self.port = str(port)
self.baseDir = str(baseDir)
# make sure all directories have a trailing slash
if self.baseDir[-1] != '/':
self.baseDir += '/'
self.localDir = str(localDir)
if self.localDir[-1] != '/':
self.localDir += '/'
self.torrentDir = str(torrentDir)
if self.torrentDir[-1] != '/':
self.torrentDir += '/'
self.watchDir = watchDir
if self.watchDir[-1] != '/':
self.watchDir += '/'
"""
Get the amount of torrents still in the queue for downloading
return int the number of torrents waiting to be downloaded
"""
def queuedItems(self):
return len(self.files)
"""
Get the number of torrents being downloaded right now
return int the number of torrents being downloaded now
"""
def runningItems(self):
return len(self.processes)
"""
Gets the amount of children that are free to download
return int the number of children available to download
"""
def freeChildren(self):
return self.children - self.runningItems()
"""
Spawns download children if allowed
return bool true on download start, false on failure
"""
def pull(self):
if self.queuedItems() == 0 or self.freeChildren() <= 0:
return False
file = self.files.pop(0)
# make sure this file isn't already being processed
for process in self.processes:
if process['info'] == file:
return False
command = 'rsync --inplace --partial --port=%s -rq %s@%s:%s %s' % (self.port, self.username, self.host, pipes.quote(pipes.quote(self.baseDir + file['name'])), pipes.quote(self.localDir + '.temp/'))
logging.info('Starting download for "%s"' % file['name'])
logging.debug('command: "%s"' % command)
try:
process = subprocess.Popen(command, shell=True)
self.processes.append({'process': process, 'info': file})
return True
except Exception as e:
logging.error('Failed to start download for "%s" with error "%s"' % (file['name'], e))
return False
"""
Pushes torrent files to the remote server
return bool true on success, false on failure, none on error
"""
def push(self):
now = time.time()
# only push in 5 minute intervals
if now - self.lastPush < 300:
return True
else:
self.lastPush = now
command = 'rsync --inplace --partial --port=%s -hrq %s %s@%s:%s' % (self.port, pipes.quote(self.torrentDir), self.username, self.host, pipes.quote(pipes.quote(self.watchDir)))
logging.info('Syncing torrent files')
logging.debug('command: "%s"' % command)
try:
if subprocess.call(command, shell=True) == 0:
logging.info('Successfully synced torrent files')
return True
else:
logging.warning('Failed to sync torrent files')
return False
except Exception as e:
logging.error('Failed to sync torrents with error "%s"' % e)
return None
"""
Cleanup processes that have finished
return bool true if all children are finished, false otherwise
"""
def clean(self):
i = 0
length = len(self.processes)
while i < length:
if self.processes[i]['process'].poll() != None:
if self.processes[i]['process'].returncode == 0:
logging.info('Successfully downloaded "%s"' % self.processes[i]['info']['name'])
os.renames(self.localDir + '.temp/' + self.processes[i]['info']['name'], self.localDir + self.processes[i]['info']['name'])
os.unlink(self.processes[i]['info']['file'])
else:
logging.warning('Failed to download "%s"' % self.processes[i]['info']['name'])
self.processes.pop(i)
i -= 1
length -= 1
i += 1
return length == 0
"""
Starts up fileScan and puller instances through given config file
"""
class loader:
"""
Constructor
configFile string the location for the config file
"""
def __init__(self, configFile):
self.configFile = configFile
self.data = None
"""
Loads the configuration file into memory and parses it as JSON
return bool true on success, false otherwise
"""
def loadFile(self):
try:
data = open(self.configFile, 'rb').read()
self.data = json.loads(data)
if 'torrent_files' not in self.data:
logging.error('Missing torrent_files setting')
return False
if 'xmlrpc' not in self.data:
logging.error('Missing xmlrpc setting')
return False
if 'torrent_download' not in self.data:
logging.error('Missing torrent_download setting')
return False
if 'local_download_dir' not in self.data:
logging.error('Missing local_download_dir setting')
return False
if 'transport' not in self.data['xmlrpc']:
logging.error('Missing transport setting in xmlrpc')
return False
if 'user' not in self.data['xmlrpc']:
logging.error('Missing user setting in xmlrpc')
return False
if 'password' not in self.data['xmlrpc']:
logging.error('Missing password setting in xmlrpc')
return False
if 'host' not in self.data['xmlrpc']:
logging.error('Missing host setting in xmlrpc')
return False
if 'port' not in self.data['xmlrpc']:
logging.error('Missing port setting in xmlrpc')
return False
if 'path' not in self.data['xmlrpc']:
logging.error('Missing path setting in xmlrpc')
return False
if 'user' not in self.data['torrent_download']:
logging.error('Missing user setting in torrent_download')
return False
if 'host' not in self.data['torrent_download']:
logging.error('Missing host setting in torrent_download')
return False
if 'port' not in self.data['torrent_download']:
logging.error('Missing port setting in torrent_download')
return False
if 'download_dir' not in self.data['torrent_download']:
logging.error('Missing download_dir setting in torrent_download')
return False
if 'watch_dir' not in self.data['torrent_download']:
logging.error('Missing watch_dir setting in torrent_download')
return False
if 'children' in self.data['torrent_download']:
self.data['torrent_download']['children'] = int(self.data['torrent_download']['children'])
else:
logging.warning('Missing children setting in torrent_download, setting default to 2')
self.data['torrent_download']['children'] = 2
logging.info('Successfully loaded config from "%s"' % self.configFile)
return True
except:
logging.error('Failed to load configuration from "%s"' % self.configFile)
return False
"""
Initialize a fileScanner and puller class based off the configuration file
return {'puller': puller(), 'scanner': fileScanner()}, False on error
"""
def load(self):
if self.data == None and not self.loadFile():
return False
try:
fileScanner = fileScan(baseDir=self.data['torrent_files'], protocol=self.data['xmlrpc']['transport'], user=self.data['xmlrpc']['user'], password=self.data['xmlrpc']['password'], host=self.data['xmlrpc']['host'], port=self.data['xmlrpc']['port'], path=self.data['xmlrpc']['path'])
if fileScanner.updateCompleted() == None:
logging.warning('Nothing to parse due to connection issues')
return False
else:
pull = puller(files=fileScanner.completed, username=self.data['torrent_download']['user'], host=self.data['torrent_download']['host'], port=self.data['torrent_download']['port'], baseDir=self.data['torrent_download']['download_dir'], localDir=self.data['local_download_dir'], torrentDir=self.data['torrent_files'], watchDir=self.data['torrent_download']['watch_dir'], children=self.data['torrent_download']['children'])
return {'puller': pull, 'scanner': fileScanner}
except:
return False
if __name__ == '__main__':
import argparse
logging.basicConfig(level=logging.INFO, format='[%(asctime)s] %(message)s')
logger = logging.getLogger(__name__)
parser = argparse.ArgumentParser(description='Download torrents that are completed')
parser.add_argument( '-c', '--config', dest='config_file', metavar='CONFIG_FILE', nargs=1, help='Location of config file formatted in JSON. Default: ./hoarder.conf')
args = parser.parse_args()
if args.config_file == None:
config_file = './hoarder.conf'
else:
config_file = args.config_file
if not os.path.isfile(config_file):
logging.error('Cannot find config file "%s"' % config_file)
exit(1)
load = loader(config_file)
while True:
parsing = load.load()
lastParse = time.time()
if not parsing:
logging.error('Failed to start the parse, fetch and upload process')
exit(1)
while True:
parsing['puller'].push()
parsing['puller'].pull()
if parsing['puller'].clean():
break
if parsing['puller'].queuedItems() == 0 and parsing['puller'].freeChildren() > 0 and time.time() - lastParse > 300:
parsing['scanner'].updateCompleted()
lastParse = time.time()
time.sleep(1)
time.sleep(300)

395
sync.go Normal file
View file

@ -0,0 +1,395 @@
// Send and receive files via SFTP using multiple download streams concurrently (for downloads).
package main
import (
"errors"
"github.com/pkg/sftp"
"golang.org/x/crypto/ssh"
"io"
"log"
"os"
"path/filepath"
"strconv"
)
// Keeps track of the connection information.
type Sync struct {
sshClient *ssh.Client
sftpClients []*sftp.Client
sftpClientCount int
}
// Create a new Sync object, connect to the SSH server, and create sftp clients
func NewSync(threads string, user string, pass string, server string, port string) (*Sync, error) {
// convert the threads input to an int
client_count, err := strconv.Atoi(threads)
if err != nil {
return nil, err
}
if client_count < 1 {
return nil, errors.New("Must have a thread count >= 1")
}
ssh_client, err := newSSHClient(user, pass, server, port)
if err != nil {
return nil, err
}
// initialize a total of client_count sftp clients
sftp_clients := make([]*sftp.Client, client_count)
for i := 0; i < client_count; i++ {
sftp_client, err := sftp.NewClient(ssh_client)
if err != nil {
return nil, err
}
sftp_clients[i] = sftp_client
}
return &Sync{ssh_client, sftp_clients, client_count}, nil
}
// Create a new SSH client instance and confirm that we can make sessions
func newSSHClient(user string, pass string, server string, port string) (*ssh.Client, error) {
ssh_config := &ssh.ClientConfig{
User: user,
Auth: []ssh.AuthMethod{
ssh.Password(pass),
},
}
ssh_client, err := ssh.Dial("tcp", server + ":" + port, ssh_config)
if err != nil {
return ssh_client, err
}
session, err := ssh_client.NewSession()
if err != nil {
return ssh_client, err
}
defer session.Close()
return ssh_client, err
}
// Send a list of files in the format of {"source_path": "destination"} to the SSH server.
// This does not handle directories.
func (s Sync) SendFiles(files map[string]string) error {
return SendFiles(s.sftpClients[0], files)
}
// Send a list of files in the format of {"source_path": "destination"} to the SSH server.
// This does not handle directories.
func SendFiles(sftp_client *sftp.Client, files map[string]string) error {
for source_file, destination_file := range files {
// 512KB buffer for reading/sending data
data := make([]byte, 524288)
// Open file that we will be sending
source_data, err := os.Open(source_file)
if err != nil {
log.Println("SendFiles: Failed to open source file " + source_file)
return err
}
// Get the info of the file that we will be sending
source_stat, err := source_data.Stat()
if err != nil {
log.Println("SendFiles: Failed to stat source file " + source_file)
return err
}
// Extract the size of the file that we will be sending
source_size := source_stat.Size()
// Create the destination file for the source file we're sending
new_file, err := sftp_client.Create(destination_file)
if err != nil {
log.Println("SendFiles: Failed to create destination file " + destination_file)
return err
}
// Track our position in reading/writing the file
var current_position int64 = 0
for current_position < source_size {
// If the next iteration will be greater than the file size, reduce to the data size
if current_position + int64(len(data)) > source_size {
data = make([]byte, source_size - current_position)
}
// Read data from the source file
read, err := source_data.Read(data)
if err != nil {
// If it's the end of the file and we didn't read anything, break
if err == io.EOF {
if read == 0 {
break
}
} else {
return err
}
}
// Write the data from the source file to the destination file
_, err = new_file.Write(data)
if err != nil {
return err
}
// Update the current position in the file
current_position += int64(read)
}
// close the source file
err = source_data.Close()
if err != nil {
return err
}
// close the destination file
err = new_file.Close()
if err != nil {
return err
}
}
return nil
}
// Get a file from the source_file path to be stored in destination_file path
func (s Sync) GetFile(source_file string, destination_file string) error {
// Store channels for all the concurrent download parts
channels := make([]chan error, s.sftpClientCount)
// Make channels for all the concurrent downloads
for i := 0; i < s.sftpClientCount; i++ {
channels[i] = make(chan error)
}
// Start the concurrent downloads
for i := 0; i < s.sftpClientCount; i++ {
go GetFile(s.sftpClients[i], source_file, destination_file, i + 1, s.sftpClientCount, channels[i])
}
// Block until all downloads are completed or one errors
for _, channel := range channels {
err := <- channel
if err != nil {
return err
}
}
return nil
}
// Get a file from the source_file path to be stored in destination_file path.
// worker_number and work_total are not zero indexed, but 1 indexed
func GetFile(sftp_client *sftp.Client, source_file string, destination_file string, worker_number int, worker_total int, com chan <- error) error {
// Open source_data for reading
source_data, err := sftp_client.OpenFile(source_file, os.O_RDONLY)
if err != nil {
com <- err
return err
}
// Get info for source_data
stat, err := source_data.Stat()
if err != nil {
com <- err
return err
}
// Extract the size of source_data
stat_size := stat.Size()
// Calculate which byte to start reading data from
var start int64
if worker_number == 1 {
start = 0
} else {
start = (stat_size * int64(worker_number - 1)) / int64(worker_total)
}
// Calculate which byte to stop reading data from
var stop int64
if worker_number == worker_total {
stop = stat_size
} else {
stop = (stat_size * int64(worker_number)) / int64(worker_total)
}
// Create the new file for writing
new_file, err := os.OpenFile(destination_file, os.O_WRONLY | os.O_CREATE, 0777)
if err != nil {
com <- err
return err
}
// Seek to the computed start point
offset, err := source_data.Seek(start, 0)
if err != nil {
com <- err
return err
}
// Seeking messed up real bad
if offset != start {
err = errors.New("Returned incorrect offset for source " + source_file)
com <- err
return err
}
// Seek to the computed start point
offset, err = new_file.Seek(start, 0)
if err != nil {
com <- err
return err
}
// Seeking messed up real bad
if offset != start {
err = errors.New("Return incorrect offset for destination " + destination_file)
com <- err
return err
}
// 512KB chunks
var data_size int64 = 524288
// Change the size if the chunk is larger than the file
chunk_difference := stop - start
if chunk_difference < data_size {
data_size = chunk_difference
}
// Initialize the buffer for reading/writing
data := make([]byte, data_size)
for current_size := start; current_size < stop; current_size += data_size {
// Adjust the size of the buffer if the next iteration will be greater than what has yet to be read
if current_size + data_size > stop {
data_size = stop - current_size
data = make([]byte, data_size)
}
// Read the chunk
read, err := source_data.Read(data)
if err != nil {
// Exit the loop if we're at the end of the file and no data was read
if err == io.EOF {
if read == 0 {
break
}
} else {
com <- err
return err
}
}
// Write the chunk
_, err = new_file.Write(data)
if err != nil {
com <- err
return err
}
}
// Close out the files
err = source_data.Close()
if err != nil {
com <- err
return err
}
err = new_file.Close()
if err != nil {
com <- err
return err
}
com <- nil
return nil
}
// Get a given directory or file defined by source_path and save it to destination_path
func (s Sync) GetPath(source_path string, destination_path string) error {
// Get all the dirs and files underneath source_path
dirs, files, err := s.getChildren(source_path)
// Remove the trailing slash if it exists
if source_path[len(source_path) - 1] == '/' {
source_path = source_path[:len(source_path) - 1]
}
// Get the parent path of source_path
source_base := filepath.Dir(source_path)
source_base_len := len(source_base)
// Make all the directories in destination_path
for _, dir := range dirs {
dir = filepath.Join(destination_path, filepath.FromSlash(dir[source_base_len:]))
err = os.MkdirAll(dir, 0777)
if err != nil {
return err
}
}
// Get all the files and place them in destination_path
for _, file := range files {
new_file := filepath.Join(destination_path, filepath.FromSlash(file[source_base_len:]))
err = s.GetFile(file, new_file)
if err != nil {
return err
}
}
return nil
}
// Get the directories and files underneath a given sftp root path
func (s Sync) getChildren(root string) ([]string, []string, error) {
// Used to walk through the path
walker := s.sftpClients[0].Walk(root)
// Keep track of the directories
dirs := make([]string, 0)
// Keep track of the files
files := make([]string, 0)
// Walk through the files and directories
for walker.Step() {
err := walker.Err()
if err != nil {
return nil, nil, err
}
stat := walker.Stat()
if stat.IsDir() {
dirs = append(dirs, walker.Path())
} else {
files = append(files, walker.Path())
}
}
err := walker.Err()
if err != nil {
return nil, nil, err
}
return dirs, files, nil
}
// Determine if a directory, file, or link exists
func (s Sync) Exists(path string) (bool, error) {
_, err := s.sftpClients[0].Lstat(path)
if err != nil {
if err.Error() == "sftp: \"No such file\" (SSH_FX_NO_SUCH_FILE)" {
return false, nil
}
return false, err
}
return true, nil
}