Squash a bunch of commits together
This commit is contained in:
carbotaniuman
commit
6b106f52fc
107
.gitignore
vendored
Normal file
107
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,107 @@
|
||||||
|
|
||||||
|
# Created by https://www.gitignore.io/api/linux,macos,gradle,windows
|
||||||
|
# Edit at https://www.gitignore.io/?templates=linux,macos,gradle,windows
|
||||||
|
|
||||||
|
### Linux ###
|
||||||
|
*~
|
||||||
|
|
||||||
|
# temporary files which can be created if a process still has a handle open of a deleted file
|
||||||
|
.fuse_hidden*
|
||||||
|
|
||||||
|
# KDE directory preferences
|
||||||
|
.directory
|
||||||
|
|
||||||
|
# Linux trash folder which might appear on any partition or disk
|
||||||
|
.Trash-*
|
||||||
|
|
||||||
|
# .nfs files are created when an open file is removed but is still being accessed
|
||||||
|
.nfs*
|
||||||
|
|
||||||
|
### macOS ###
|
||||||
|
# General
|
||||||
|
.DS_Store
|
||||||
|
.AppleDouble
|
||||||
|
.LSOverride
|
||||||
|
|
||||||
|
# Icon must end with two \r
|
||||||
|
Icon
|
||||||
|
|
||||||
|
# Thumbnails
|
||||||
|
._*
|
||||||
|
|
||||||
|
# Files that might appear in the root of a volume
|
||||||
|
.DocumentRevisions-V100
|
||||||
|
.fseventsd
|
||||||
|
.Spotlight-V100
|
||||||
|
.TemporaryItems
|
||||||
|
.Trashes
|
||||||
|
.VolumeIcon.icns
|
||||||
|
.com.apple.timemachine.donotpresent
|
||||||
|
|
||||||
|
# Directories potentially created on remote AFP share
|
||||||
|
.AppleDB
|
||||||
|
.AppleDesktop
|
||||||
|
Network Trash Folder
|
||||||
|
Temporary Items
|
||||||
|
.apdisk
|
||||||
|
|
||||||
|
### Windows ###
|
||||||
|
# Windows thumbnail cache files
|
||||||
|
Thumbs.db
|
||||||
|
Thumbs.db:encryptable
|
||||||
|
ehthumbs.db
|
||||||
|
ehthumbs_vista.db
|
||||||
|
|
||||||
|
# Dump file
|
||||||
|
*.stackdump
|
||||||
|
|
||||||
|
# Folder config file
|
||||||
|
[Dd]esktop.ini
|
||||||
|
|
||||||
|
# Recycle Bin used on file shares
|
||||||
|
$RECYCLE.BIN/
|
||||||
|
|
||||||
|
# Windows Installer files
|
||||||
|
*.cab
|
||||||
|
*.msi
|
||||||
|
*.msix
|
||||||
|
*.msm
|
||||||
|
*.msp
|
||||||
|
|
||||||
|
# Windows shortcuts
|
||||||
|
*.lnk
|
||||||
|
|
||||||
|
### Gradle ###
|
||||||
|
.gradle
|
||||||
|
build/
|
||||||
|
|
||||||
|
# Ignore Gradle GUI config
|
||||||
|
gradle-app.setting
|
||||||
|
|
||||||
|
# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
|
||||||
|
!gradle-wrapper.jar
|
||||||
|
|
||||||
|
# Cache of project
|
||||||
|
.gradletasknamecache
|
||||||
|
|
||||||
|
# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
|
||||||
|
# gradle/wrapper/gradle-wrapper.properties
|
||||||
|
|
||||||
|
### Gradle Patch ###
|
||||||
|
**/build/
|
||||||
|
|
||||||
|
# End of https://www.gitignore.io/api/linux,macos,gradle,windows
|
||||||
|
|
||||||
|
.vscode/**
|
||||||
|
**/.idea/**
|
||||||
|
*.iml
|
||||||
|
|
||||||
|
.eclipse/**
|
||||||
|
.classpath/**
|
||||||
|
.settings/**
|
||||||
|
|
||||||
|
.nb-gradle/**
|
||||||
|
nbproject/**
|
||||||
|
|
||||||
|
log/**
|
||||||
|
cache/**
|
||||||
674
LICENSE
Normal file
674
LICENSE
Normal file
|
|
@ -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:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||||
35
README.md
Normal file
35
README.md
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Mangadex@Home
|
||||||
|
|
||||||
|
## To Build
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- The Java(TM) SE JDK, version 8 or greater
|
||||||
|
- ~500MB of free space
|
||||||
|
|
||||||
|
### Instructions
|
||||||
|
|
||||||
|
- Run `./gradlew build` in order to build the entire project
|
||||||
|
- Find the generated jars in `build/libs`, where the `-all` jar is fat-jar with all dependencies
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### V1.0
|
||||||
|
- [X] **implement [API calls](https://gitlab.com/mangadex/mangadex_at_home/-/wikis/backend)**
|
||||||
|
- [X] HTTPS
|
||||||
|
- [X] cache eviction (on max size)
|
||||||
|
- [X] cert refresh (when sent by API)
|
||||||
|
- [X] async server (for users and upstream)
|
||||||
|
- [X] streaming response (for users, upstream and in between)
|
||||||
|
- [X] logging files
|
||||||
|
- [X] config file
|
||||||
|
- [X] license GPL V3 (c) Mangadex.org
|
||||||
|
### V2.0
|
||||||
|
- [X] bandwidth limit
|
||||||
|
- [X] egress limit
|
||||||
|
- [X] max connections limit
|
||||||
|
- [X] graceful shutdown (finish in-flight requests)
|
||||||
|
- [X] cache encryption (encryption key = cache key)
|
||||||
|
### Stashed
|
||||||
|
- [ ] IPv6
|
||||||
|
- [ ] HTTP/2 and HTTP/3
|
||||||
1
architecture.drawio
Normal file
1
architecture.drawio
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
<mxfile host="Electron" modified="2020-06-02T01:45:48.396Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.0.3 Chrome/80.0.3987.163 Electron/8.2.1 Safari/537.36" etag="YbFghwnMSFGyhuGluChs" version="13.0.3" type="device"><diagram id="UM38FNnQUuN8YsT_Dwxj" name="Page-1">7Vxbc5s4GP01ntl9SAbE1Y+JnaTtNtlM0m7bvOwoIBtabFyQE7sP/e0rjGSDhDFgLiazLxkQQg5H57vqkwbKaLa6CeDCufVt5A2AZK8GyngAgGHq5G/UsI4bNFOKG6aBa8dN8q7h0f2FaCPrtnRtFKY6Yt/3sLtIN1r+fI4snGqDQeC/prtNfC/9qws4RULDowU9sfWLa2OHtuqaunvwDrlTh/20rA/jJzPIetNPCR1o+6+JJuVqoIwC38fx1Ww1Ql4EHgMmfu96z9PtfxagOS7ywqdff79/GI0+/DNb4jVcWmDxLzqjo7xAb0m/eDz2H0nLzRIG9gDoHhn78jkgV9Po6o8v6Dl0MfqTfhNeM6QCfzm3UfRbEun36pBOjwtoRU9fCTVIm4NnHrmTyeXE9byR7/nB5l3FhsicWKQ9xIH/AyWe6JaJnifkifi17F9HAUarRBP9+hvkzxAO1qQLfQoMI36FcnFLstfEzLI2JzGpOm2DlEzT7dA7uMkFRbwE+qAs+g/Iir4fSCMHLjAK+jgNqgS6mwZwu7iFy6dP3vUNnK7/unlyJOVMEVBENtEC9NYPsONP/Tn0rnatl2mcd30++v6CovsdYbymKg0usZ/GHq1c/DV6/Vyjd98ST8YrOvLmZs1u5uRz45eAxu6/JR/u3tvcsRf3TlvoLwML5VCUYoNhMEU4p58Z94uAyyVBgDyI3Ze0eq1dsBRBsIjeIg2PKCBErVdoNGTaapbQmOBZ0fW6dJeUEholQ2iA1qbuUgWIRSma2xeRDSZ3lgfD0LV6KQLM7zgkAkpBEUhMWdaMsbbCkkJ/4d53N6aBMkYxOcYAjgnxd9O3kn4DP5CUHggMuYFiYISBNqzafnZ1ommdE81oiWign0RTwblWD9VUhaOa2S7VTNEfI9Mp3cIQ99Jq8Hhu7zvzeGUR4ruLyJ+FloN6iLAhpWOKLLvcMsJDAeGrzz1G2FSUE0OYabcEwvdRsA+kO4Rf/eBHvSi3EpQZvJHv3L8EYmqivN3f2fBSJnznL4DiDsMRdl8qaPjlolFWO5bfGHIuplTR7uuAy8y0bPcZterxMY1KTmZbPmZhrg1Pi2tGOmtU2cc09QOkbZprYm7ireq1orkjRT0pqikcQ9TK4YzesVoTXcHqai3Bl10YfUCrySly7rhaf4qm7jRlO0xTVY5pRkWmGXygp7XLNGUoEqurFLpUjJuc6pQPcDMkCGJRUjbN166308xbcZr7cxS30OctUbywk1iOvOSz4DrRYRFxKdzPbRNwSaGhlE9hHeT1Jxfxf1Arb5n8dcVbo3niHmJkQWK3QdyiHmfDxNWUUsQ1TbMD4oqm/XN4bI5y7xxXX2NXxTRCu8kard40Qrk1p5b9bUaKw5J2Ul7QdhzKGZl3k4unEbgkVstekFYujUDV8ck7NLW4L6AgNdXTSjsossotboHK66jCUFtNeICfZS2YqqWVMBOovf+ZAvL6N2PBtHJ5kDxhAZWkxSglLjYMnY0dlTuQnaI5uxMTHiH/UVl0VI6gDQmOoaddP1k/IDhcpojr35DglKu8yRGcFlI6LUuKrPdTUk7CzNRGUHGN//0sqrMG0gP6uUQhFvlKpuEjfEZemqnQc6fziDiECCS4US6jQMS1oHdBH8xc245jchS6v+DzZryIQlTSyeDa5UAbZ5IqX7r4kGdbY05/ZZCs4s4KhaRzSTG5mTiOLHSUM+4NfzIJUSMzydRbnqqZkhBzsVdij4fR4CofM2tYlAzR5KOI+iosMormozKhRw++RCSXf4sFxa3XWeTPZ/F4nououg7nZTHEerPYy5xz0Tn2osfO9PpFYDmRQhN2LLy9yekMfr1AJqtpZSyk97KUMchAhV/Yqq/SXyRlXzhXOrl6agpBESORFPbqb63/2Hcn76Kpa13eTelwOt/MAGXrkNVvhHQBlduBKr0jTXe+fWSBa1H2gD34nhB7VNFanDJOJ6rhVFEGe4DiqTntqmije4AiV1LT+dYJVbS2PUCRr3DqHEVxO1kPUORWSLXOUeyXFV6l4Vinb7tD0egjilw+zugaRa3cBtG8hcRK5VjpBRHQ3YrIh+8vT7c/8ZU0XkPjSnW+Lu2nwpuXGRf/XxDZDVV2+VDnKsdkWgLZ7HKgWAl2cf9+0Iu1Fia5Nay1yAar9GJ8OY6HzS+uAHGZLE9v5Vbny4MKS7mc5mquOp/lifpWna8bnOJQq25wU7mQTG3uDIXME24ymNVmmXO1Ah3TTBXonEuycYCim7t7FLgEr0iH9axyv+i5DrWfoZPnOSTU08jzl/bEIxBkHE01vosOrhqAKAF8H/irdUdnU2UYE2HS9sdZnHPbagYqcxb2JqD4CejyaKNaMW91g38m5vXu0Cx3ekylbcSZeqO2eGE/L7uyzBq/h1etaJd1LuHc4NlGmSjWcbZRRXeuiutYjWdF9wafIM+47KVSdX+mrnDBbHM7gTNRFBNNx2g0UG4DWhU3sEaNBgoyrdNYQ9f5Q7QEihTmmjCUcFZCw2xjSjVZF7DxDj8vbIjFvGZrGYnCiYY00/aL1F6n5kw6rzUdwYaVNTa3tSYoMr+wxvxEiwfv1WKdWDb0YMi2Ly/VjtYwh3yGorLWMIfcLtaCOqNsjnTI7zUqubtWrnl3bSbzxZQqK3S8Rthy3oYCMw8pMEmSjixYZ2OB9Jyf8fn3KjqM3O7OTo+7706gV67+Aw==</diagram></mxfile>
|
||||||
BIN
architecture.png
Normal file
BIN
architecture.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 48 KiB |
BIN
architecture2.png
Normal file
BIN
architecture2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
52
build.gradle
Normal file
52
build.gradle
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
plugins {
|
||||||
|
id 'java'
|
||||||
|
id 'org.jetbrains.kotlin.jvm' version '1.3.72'
|
||||||
|
id 'application'
|
||||||
|
id 'com.github.johnrengelman.shadow' version '5.2.0'
|
||||||
|
id "com.diffplug.gradle.spotless" version "3.18.0"
|
||||||
|
}
|
||||||
|
|
||||||
|
group = 'com.mangadex'
|
||||||
|
version = '1.0.0-rc0'
|
||||||
|
mainClassName = 'mdnet.base.MangadexClient'
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
jcenter()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation group: 'com.konghq', name: 'unirest-java', version: '3.7.02'
|
||||||
|
|
||||||
|
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
|
||||||
|
|
||||||
|
implementation group: "org.http4k", name: "http4k-core", version: "$http_4k_version"
|
||||||
|
implementation group: "org.http4k", name: "http4k-server-netty", version: "$http_4k_version"
|
||||||
|
implementation group: "org.http4k", name: "http4k-client-apache", version: "$http_4k_version"
|
||||||
|
implementation group: 'commons-io', name: 'commons-io', version: '2.7'
|
||||||
|
|
||||||
|
implementation "ch.qos.logback:logback-classic:$logback_version"
|
||||||
|
}
|
||||||
|
|
||||||
|
java {
|
||||||
|
sourceCompatibility = JavaVersion.VERSION_1_8
|
||||||
|
targetCompatibility = JavaVersion.VERSION_1_8
|
||||||
|
}
|
||||||
|
|
||||||
|
spotless {
|
||||||
|
java {
|
||||||
|
eclipse()
|
||||||
|
removeUnusedImports()
|
||||||
|
trimTrailingWhitespace()
|
||||||
|
endWithNewline()
|
||||||
|
}
|
||||||
|
kotlin {
|
||||||
|
ktlint()
|
||||||
|
trimTrailingWhitespace()
|
||||||
|
endWithNewline()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
run {
|
||||||
|
args = ["dev/settings.json"]
|
||||||
|
}
|
||||||
7
dev/settings.json
Normal file
7
dev/settings.json
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
{
|
||||||
|
"client_secret": "7rc7p00md0n0xsvqnv4rv17fthvjjrzpdghak1yq45833zvdvnb0",
|
||||||
|
"max_cache_size_mib": 2048,
|
||||||
|
"client_port": 8080,
|
||||||
|
"max_burst_rate_kib_per_second": 100,
|
||||||
|
"max_bandwidth_mib_per_hour": 1
|
||||||
|
}
|
||||||
2
gradle.properties
Normal file
2
gradle.properties
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
http_4k_version=3.249.0
|
||||||
|
logback_version=1.2.1
|
||||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Normal file
Binary file not shown.
6
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
6
gradle/wrapper/gradle-wrapper.properties
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
#Wed May 27 21:24:59 CDT 2020
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip
|
||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
zipStorePath=wrapper/dists
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
172
gradlew
vendored
Normal file
172
gradlew
vendored
Normal file
|
|
@ -0,0 +1,172 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
##
|
||||||
|
## Gradle start up script for UN*X
|
||||||
|
##
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
PRG="$0"
|
||||||
|
# Need this for relative symlinks.
|
||||||
|
while [ -h "$PRG" ] ; do
|
||||||
|
ls=`ls -ld "$PRG"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
PRG="$link"
|
||||||
|
else
|
||||||
|
PRG=`dirname "$PRG"`"/$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
SAVED="`pwd`"
|
||||||
|
cd "`dirname \"$PRG\"`/" >/dev/null
|
||||||
|
APP_HOME="`pwd -P`"
|
||||||
|
cd "$SAVED" >/dev/null
|
||||||
|
|
||||||
|
APP_NAME="Gradle"
|
||||||
|
APP_BASE_NAME=`basename "$0"`
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m"'
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD="maximum"
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
}
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false').
|
||||||
|
cygwin=false
|
||||||
|
msys=false
|
||||||
|
darwin=false
|
||||||
|
nonstop=false
|
||||||
|
case "`uname`" in
|
||||||
|
CYGWIN* )
|
||||||
|
cygwin=true
|
||||||
|
;;
|
||||||
|
Darwin* )
|
||||||
|
darwin=true
|
||||||
|
;;
|
||||||
|
MINGW* )
|
||||||
|
msys=true
|
||||||
|
;;
|
||||||
|
NONSTOP* )
|
||||||
|
nonstop=true
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM.
|
||||||
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD="$JAVA_HOME/jre/sh/java"
|
||||||
|
else
|
||||||
|
JAVACMD="$JAVA_HOME/bin/java"
|
||||||
|
fi
|
||||||
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD="java"
|
||||||
|
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
|
||||||
|
MAX_FD_LIMIT=`ulimit -H -n`
|
||||||
|
if [ $? -eq 0 ] ; then
|
||||||
|
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
||||||
|
MAX_FD="$MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
ulimit -n $MAX_FD
|
||||||
|
if [ $? -ne 0 ] ; then
|
||||||
|
warn "Could not set maximum file descriptor limit: $MAX_FD"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Darwin, add options to specify how the application appears in the dock
|
||||||
|
if $darwin; then
|
||||||
|
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Cygwin, switch paths to Windows format before running java
|
||||||
|
if $cygwin ; then
|
||||||
|
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
|
||||||
|
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
|
||||||
|
JAVACMD=`cygpath --unix "$JAVACMD"`
|
||||||
|
|
||||||
|
# We build the pattern for arguments to be converted via cygpath
|
||||||
|
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
|
||||||
|
SEP=""
|
||||||
|
for dir in $ROOTDIRSRAW ; do
|
||||||
|
ROOTDIRS="$ROOTDIRS$SEP$dir"
|
||||||
|
SEP="|"
|
||||||
|
done
|
||||||
|
OURCYGPATTERN="(^($ROOTDIRS))"
|
||||||
|
# Add a user-defined pattern to the cygpath arguments
|
||||||
|
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
|
||||||
|
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
|
||||||
|
fi
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
i=0
|
||||||
|
for arg in "$@" ; do
|
||||||
|
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
|
||||||
|
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
|
||||||
|
|
||||||
|
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
|
||||||
|
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
|
||||||
|
else
|
||||||
|
eval `echo args$i`="\"$arg\""
|
||||||
|
fi
|
||||||
|
i=$((i+1))
|
||||||
|
done
|
||||||
|
case $i in
|
||||||
|
(0) set -- ;;
|
||||||
|
(1) set -- "$args0" ;;
|
||||||
|
(2) set -- "$args0" "$args1" ;;
|
||||||
|
(3) set -- "$args0" "$args1" "$args2" ;;
|
||||||
|
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
|
||||||
|
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
|
||||||
|
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
|
||||||
|
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
|
||||||
|
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
|
||||||
|
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Escape application args
|
||||||
|
save () {
|
||||||
|
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||||
|
echo " "
|
||||||
|
}
|
||||||
|
APP_ARGS=$(save "$@")
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
||||||
|
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
||||||
|
|
||||||
|
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
|
||||||
|
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
|
||||||
|
cd "$(dirname "$0")"
|
||||||
|
fi
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
||||||
84
gradlew.bat
vendored
Normal file
84
gradlew.bat
vendored
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
@if "%DEBUG%" == "" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%" == "" set DIRNAME=.
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m"
|
||||||
|
|
||||||
|
@rem Find java.exe
|
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
|
set JAVA_EXE=java.exe
|
||||||
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
|
if "%ERRORLEVEL%" == "0" goto init
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto init
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:init
|
||||||
|
@rem Get command-line arguments, handling Windows variants
|
||||||
|
|
||||||
|
if not "%OS%" == "Windows_NT" goto win9xME_args
|
||||||
|
|
||||||
|
:win9xME_args
|
||||||
|
@rem Slurp the command line arguments.
|
||||||
|
set CMD_LINE_ARGS=
|
||||||
|
set _SKIP=2
|
||||||
|
|
||||||
|
:win9xME_args_slurp
|
||||||
|
if "x%~1" == "x" goto execute
|
||||||
|
|
||||||
|
set CMD_LINE_ARGS=%*
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if "%ERRORLEVEL%"=="0" goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
||||||
|
exit /b 1
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
||||||
1
settings.gradle
Normal file
1
settings.gradle
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
rootProject.name = 'mangadex_at_home'
|
||||||
87
src/main/java/mdnet/base/CachingInputStream.java
Normal file
87
src/main/java/mdnet/base/CachingInputStream.java
Normal file
|
|
@ -0,0 +1,87 @@
|
||||||
|
/*
|
||||||
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
||||||
|
* contributor license agreements. See the NOTICE file distributed with
|
||||||
|
* this work for additional information regarding copyright ownership.
|
||||||
|
* The ASF licenses this file to You under the Apache License, Version 2.0
|
||||||
|
* (the "License"); you may not use this file except in compliance with
|
||||||
|
* the License. You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
package mdnet.base;
|
||||||
|
|
||||||
|
import org.apache.commons.io.IOUtils;
|
||||||
|
import org.apache.commons.io.input.ProxyInputStream;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
import java.util.concurrent.ExecutorService;
|
||||||
|
|
||||||
|
import static org.apache.commons.io.IOUtils.EOF;
|
||||||
|
|
||||||
|
public class CachingInputStream extends ProxyInputStream {
|
||||||
|
private final OutputStream cache;
|
||||||
|
private final ExecutorService executor;
|
||||||
|
private final Runnable onClose;
|
||||||
|
|
||||||
|
public CachingInputStream(InputStream response, ExecutorService executor, OutputStream cache, Runnable onClose) {
|
||||||
|
super(response);
|
||||||
|
this.executor = executor;
|
||||||
|
this.cache = cache;
|
||||||
|
this.onClose = onClose;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void close() throws IOException {
|
||||||
|
executor.submit(() -> {
|
||||||
|
try {
|
||||||
|
IOUtils.copy(in, cache);
|
||||||
|
} catch (IOException ignored) {
|
||||||
|
} finally {
|
||||||
|
try {
|
||||||
|
in.close();
|
||||||
|
} catch (IOException ignored) {
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
cache.close();
|
||||||
|
} catch (IOException ignored) {
|
||||||
|
}
|
||||||
|
onClose.run();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int read() throws IOException {
|
||||||
|
final int ch = super.read();
|
||||||
|
if (ch != EOF) {
|
||||||
|
cache.write(ch);
|
||||||
|
}
|
||||||
|
return ch;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int read(final byte[] bts, final int st, final int end) throws IOException {
|
||||||
|
final int n = super.read(bts, st, end);
|
||||||
|
if (n != EOF) {
|
||||||
|
cache.write(bts, st, n);
|
||||||
|
}
|
||||||
|
return n;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int read(final byte[] bts) throws IOException {
|
||||||
|
final int n = super.read(bts);
|
||||||
|
if (n != EOF) {
|
||||||
|
cache.write(bts, 0, n);
|
||||||
|
}
|
||||||
|
return n;
|
||||||
|
}
|
||||||
|
}
|
||||||
60
src/main/java/mdnet/base/ClientSettings.java
Normal file
60
src/main/java/mdnet/base/ClientSettings.java
Normal file
|
|
@ -0,0 +1,60 @@
|
||||||
|
package mdnet.base;
|
||||||
|
|
||||||
|
import com.google.gson.annotations.SerializedName;
|
||||||
|
|
||||||
|
import java.util.Objects;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
|
public final class ClientSettings {
|
||||||
|
@SerializedName("max_cache_size_mib")
|
||||||
|
private final long maxCacheSizeMib;
|
||||||
|
@SerializedName("max_bandwidth_mib_per_hour")
|
||||||
|
private final long maxBandwidthMibPerHour;
|
||||||
|
@SerializedName("max_burst_rate_kib_per_second")
|
||||||
|
private final long maxBurstRateKibPerSecond;
|
||||||
|
@SerializedName("client_port")
|
||||||
|
private final int clientPort;
|
||||||
|
@SerializedName("client_secret")
|
||||||
|
private final String clientSecret;
|
||||||
|
|
||||||
|
public ClientSettings(long maxCacheSizeMib, long maxBandwidthMibPerHour, long maxBurstRateKibPerSecond,
|
||||||
|
int clientPort, String clientSecret) {
|
||||||
|
this.maxCacheSizeMib = maxCacheSizeMib;
|
||||||
|
this.maxBandwidthMibPerHour = maxBandwidthMibPerHour;
|
||||||
|
this.maxBurstRateKibPerSecond = maxBurstRateKibPerSecond;
|
||||||
|
this.clientPort = clientPort;
|
||||||
|
this.clientSecret = Objects.requireNonNull(clientSecret);
|
||||||
|
}
|
||||||
|
|
||||||
|
public long getMaxCacheSizeMib() {
|
||||||
|
return maxCacheSizeMib;
|
||||||
|
}
|
||||||
|
|
||||||
|
public long getMaxBandwidthMibPerHour() {
|
||||||
|
return maxBandwidthMibPerHour;
|
||||||
|
}
|
||||||
|
|
||||||
|
public long getMaxBurstRateKibPerSecond() {
|
||||||
|
return maxBurstRateKibPerSecond;
|
||||||
|
}
|
||||||
|
|
||||||
|
public int getClientPort() {
|
||||||
|
return clientPort;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getClientSecret() {
|
||||||
|
return clientSecret;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "ClientSettings{" + "maxCacheSizeMib=" + maxCacheSizeMib + ", maxBandwidthMibPerHour="
|
||||||
|
+ maxBandwidthMibPerHour + ", maxBurstRateKibPerSecond=" + maxBurstRateKibPerSecond + ", clientPort="
|
||||||
|
+ clientPort + ", clientSecret='" + clientSecret + '\'' + '}';
|
||||||
|
}
|
||||||
|
|
||||||
|
public static boolean isSecretValid(String clientSecret) {
|
||||||
|
final int CLIENT_KEY_LENGTH = 52;
|
||||||
|
return Pattern.matches("^[a-zA-Z0-9]{" + CLIENT_KEY_LENGTH + "}$", clientSecret);
|
||||||
|
}
|
||||||
|
}
|
||||||
12
src/main/java/mdnet/base/Constants.java
Normal file
12
src/main/java/mdnet/base/Constants.java
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
package mdnet.base;
|
||||||
|
|
||||||
|
import java.time.Duration;
|
||||||
|
|
||||||
|
public class Constants {
|
||||||
|
public static final int CLIENT_BUILD = 1;
|
||||||
|
public static final String CLIENT_VERSION = "1.0";
|
||||||
|
public static final Duration MAX_AGE_CACHE = Duration.ofDays(14);
|
||||||
|
|
||||||
|
public static final int MAX_CONCURRENT_CONNECTIONS = 100;
|
||||||
|
public static final String OVERLOADED_MESSAGE = "This server is experiencing a surge in connections. Please try again later.";
|
||||||
|
}
|
||||||
203
src/main/java/mdnet/base/MangadexClient.java
Normal file
203
src/main/java/mdnet/base/MangadexClient.java
Normal file
|
|
@ -0,0 +1,203 @@
|
||||||
|
package mdnet.base;
|
||||||
|
|
||||||
|
import com.google.gson.Gson;
|
||||||
|
import mdnet.cache.DiskLruCache;
|
||||||
|
import org.http4k.server.Http4kServer;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.io.File;
|
||||||
|
import java.io.FileNotFoundException;
|
||||||
|
import java.io.FileReader;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.concurrent.Executors;
|
||||||
|
import java.util.concurrent.ScheduledExecutorService;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
import java.util.concurrent.atomic.AtomicInteger;
|
||||||
|
import java.util.concurrent.atomic.AtomicReference;
|
||||||
|
|
||||||
|
public class MangadexClient {
|
||||||
|
private final static Logger LOGGER = LoggerFactory.getLogger(MangadexClient.class);
|
||||||
|
|
||||||
|
// This lock protects the Http4kServer from concurrent restart attempts
|
||||||
|
private final Object shutdownLock = new Object();
|
||||||
|
private final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
|
||||||
|
private final ServerHandler serverHandler;
|
||||||
|
private final ClientSettings clientSettings;
|
||||||
|
private final AtomicReference<Statistics> statistics;
|
||||||
|
private ServerSettings serverSettings;
|
||||||
|
|
||||||
|
// if this is null, then the server has shutdown
|
||||||
|
private Http4kServer engine;
|
||||||
|
private DiskLruCache cache;
|
||||||
|
|
||||||
|
public MangadexClient(ClientSettings clientSettings) {
|
||||||
|
this.clientSettings = clientSettings;
|
||||||
|
this.serverHandler = new ServerHandler(clientSettings);
|
||||||
|
this.statistics = new AtomicReference<>();
|
||||||
|
|
||||||
|
try {
|
||||||
|
cache = DiskLruCache.open(new File("cache"), 1, 2,
|
||||||
|
clientSettings.getMaxCacheSizeMib() * 1024 * 1024 /* MiB to bytes */);
|
||||||
|
} catch (IOException e) {
|
||||||
|
MangadexClient.dieWithError(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// This function also does most of the program initialization.
|
||||||
|
public void runLoop() {
|
||||||
|
statistics.set(new Statistics());
|
||||||
|
loginAndStartServer();
|
||||||
|
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("MDNet initialization completed successfully. Starting normal operation.");
|
||||||
|
}
|
||||||
|
|
||||||
|
// we don't really care about the Atomic part here
|
||||||
|
AtomicInteger counter = new AtomicInteger();
|
||||||
|
// ping keep-alive every 45 seconds
|
||||||
|
executorService.scheduleAtFixedRate(() -> {
|
||||||
|
int num = counter.get();
|
||||||
|
if (num == 80) {
|
||||||
|
counter.set(0);
|
||||||
|
|
||||||
|
// if server is stopped due to egress limits, restart it
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Hourly update: refreshing statistics");
|
||||||
|
}
|
||||||
|
statistics.set(new Statistics());
|
||||||
|
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Restarting server stopped due to hourly bandwidth limit");
|
||||||
|
}
|
||||||
|
if (engine == null) {
|
||||||
|
loginAndStartServer();
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
counter.set(num + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (clientSettings.getMaxBandwidthMibPerHour() != 0 && clientSettings.getMaxBandwidthMibPerHour() * 1024
|
||||||
|
* 1024 /* MiB to bytes */ < statistics.get().getBytesSent().get()) {
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Shutting down server as hourly bandwidth limit reached");
|
||||||
|
}
|
||||||
|
|
||||||
|
synchronized (shutdownLock) {
|
||||||
|
logoutAndStopServer();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// if the server is offline then don't try and refresh certs
|
||||||
|
if (engine == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
ServerSettings n = serverHandler.pingControl(serverSettings);
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Server settings received: {}", n);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (n != null && (n.getTls() != null || !n.getImageServer().equals(serverSettings.getImageServer()))) {
|
||||||
|
// certificates or upstream url must have changed, restart webserver
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Doing internal restart of HTTP server to refresh certs/upstream URL");
|
||||||
|
}
|
||||||
|
|
||||||
|
synchronized (shutdownLock) {
|
||||||
|
logoutAndStopServer();
|
||||||
|
loginAndStartServer();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}, 45, 45, TimeUnit.SECONDS);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
private void loginAndStartServer() {
|
||||||
|
serverSettings = serverHandler.loginToControl();
|
||||||
|
if (serverSettings == null) {
|
||||||
|
MangadexClient.dieWithError("Failed to get a login response from server - check API secret for validity");
|
||||||
|
}
|
||||||
|
engine = ApplicationKt.getServer(cache, serverSettings, clientSettings, statistics);
|
||||||
|
engine.start();
|
||||||
|
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Internal HTTP server was successfully started");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void logoutAndStopServer() {
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Gracefully shutting down HTTP server");
|
||||||
|
}
|
||||||
|
serverHandler.logoutFromControl();
|
||||||
|
engine.stop();
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Internal HTTP server has gracefully shut down");
|
||||||
|
}
|
||||||
|
engine = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void shutdown() {
|
||||||
|
executorService.shutdown();
|
||||||
|
synchronized (shutdownLock) {
|
||||||
|
if (engine == null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
logoutAndStopServer();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void main(String[] args) {
|
||||||
|
System.out.println("Mangadex@Home Client " + Constants.CLIENT_VERSION + " (Build " + Constants.CLIENT_BUILD
|
||||||
|
+ ") initializing\n");
|
||||||
|
System.out.println("Copyright (c) 2020, Mangadex");
|
||||||
|
|
||||||
|
try {
|
||||||
|
String file = "settings.json";
|
||||||
|
if (args.length == 1) {
|
||||||
|
file = args[0];
|
||||||
|
} else if (args.length != 0) {
|
||||||
|
MangadexClient.dieWithError("Expected one argument: path to config file, or nothing");
|
||||||
|
}
|
||||||
|
|
||||||
|
ClientSettings settings = new Gson().fromJson(new FileReader(file), ClientSettings.class);
|
||||||
|
|
||||||
|
if (!ClientSettings.isSecretValid(settings.getClientSecret()))
|
||||||
|
MangadexClient.dieWithError("Config Error: API Secret is invalid, must be 52 alphanumeric characters");
|
||||||
|
|
||||||
|
if (settings.getClientPort() == 0) {
|
||||||
|
MangadexClient.dieWithError("Config Error: Invalid port number");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (settings.getMaxCacheSizeMib() < 1024) {
|
||||||
|
MangadexClient.dieWithError("Config Error: Invalid max cache size, must be >= 1024 MiB (1GiB)");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Client settings loaded: {}", settings);
|
||||||
|
}
|
||||||
|
|
||||||
|
MangadexClient client = new MangadexClient(settings);
|
||||||
|
Runtime.getRuntime().addShutdownHook(new Thread(client::shutdown));
|
||||||
|
client.runLoop();
|
||||||
|
} catch (FileNotFoundException e) {
|
||||||
|
MangadexClient.dieWithError(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void dieWithError(Throwable e) {
|
||||||
|
if (LOGGER.isErrorEnabled()) {
|
||||||
|
LOGGER.error("Critical Error", e);
|
||||||
|
}
|
||||||
|
System.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static void dieWithError(String error) {
|
||||||
|
if (LOGGER.isErrorEnabled()) {
|
||||||
|
LOGGER.error("Critical Error: " + error);
|
||||||
|
}
|
||||||
|
System.exit(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
79
src/main/java/mdnet/base/ServerHandler.java
Normal file
79
src/main/java/mdnet/base/ServerHandler.java
Normal file
|
|
@ -0,0 +1,79 @@
|
||||||
|
package mdnet.base;
|
||||||
|
|
||||||
|
import kong.unirest.HttpResponse;
|
||||||
|
import kong.unirest.Unirest;
|
||||||
|
import kong.unirest.json.JSONObject;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.util.HashMap;
|
||||||
|
|
||||||
|
public class ServerHandler {
|
||||||
|
private final static Logger LOGGER = LoggerFactory.getLogger(ServerHandler.class);
|
||||||
|
private static final String SERVER_ADDRESS = "https://mangadex-test.net/";
|
||||||
|
|
||||||
|
private final ClientSettings settings;
|
||||||
|
|
||||||
|
public ServerHandler(ClientSettings settings) {
|
||||||
|
this.settings = settings;
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean logoutFromControl() {
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Disconnecting from the control server");
|
||||||
|
}
|
||||||
|
|
||||||
|
HashMap<String, Object> params = new HashMap<>();
|
||||||
|
params.put("secret", settings.getClientSecret());
|
||||||
|
|
||||||
|
HttpResponse<?> json = Unirest.post(SERVER_ADDRESS + "stop").header("Content-Type", "application/json")
|
||||||
|
.body(new JSONObject(params)).asEmpty();
|
||||||
|
|
||||||
|
return json.isSuccess();
|
||||||
|
}
|
||||||
|
|
||||||
|
public ServerSettings loginToControl() {
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Connecting to the control server");
|
||||||
|
}
|
||||||
|
|
||||||
|
HashMap<String, Object> params = new HashMap<>();
|
||||||
|
params.put("secret", settings.getClientSecret());
|
||||||
|
params.put("port", settings.getClientPort());
|
||||||
|
params.put("disk_space", settings.getMaxCacheSizeMib() * 1024 * 1024 /* MiB to bytes */);
|
||||||
|
|
||||||
|
HttpResponse<ServerSettings> response = Unirest.post(SERVER_ADDRESS + "ping")
|
||||||
|
.header("Content-Type", "application/json").body(new JSONObject(params)).asObject(ServerSettings.class);
|
||||||
|
|
||||||
|
if (response.isSuccess()) {
|
||||||
|
return response.getBody();
|
||||||
|
} else {
|
||||||
|
// unirest deserializes errors into an object with all null fields instead of a
|
||||||
|
// null object
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public ServerSettings pingControl(ServerSettings old) {
|
||||||
|
if (LOGGER.isInfoEnabled()) {
|
||||||
|
LOGGER.info("Pinging the control server");
|
||||||
|
}
|
||||||
|
|
||||||
|
HashMap<String, Object> params = new HashMap<>();
|
||||||
|
params.put("secret", settings.getClientSecret());
|
||||||
|
params.put("port", settings.getClientPort());
|
||||||
|
params.put("disk_space", settings.getMaxCacheSizeMib() * 1024 * 1024 /* MiB to bytes */);
|
||||||
|
params.put("tls_created_at", old.getTls().getCreatedAt());
|
||||||
|
|
||||||
|
HttpResponse<ServerSettings> response = Unirest.post(SERVER_ADDRESS + "ping")
|
||||||
|
.header("Content-Type", "application/json").body(new JSONObject(params)).asObject(ServerSettings.class);
|
||||||
|
|
||||||
|
if (response.isSuccess()) {
|
||||||
|
return response.getBody();
|
||||||
|
} else {
|
||||||
|
// unirest deserializes errors into an object with all null fields instead of a
|
||||||
|
// null object
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
106
src/main/java/mdnet/base/ServerSettings.java
Normal file
106
src/main/java/mdnet/base/ServerSettings.java
Normal file
|
|
@ -0,0 +1,106 @@
|
||||||
|
package mdnet.base;
|
||||||
|
|
||||||
|
import com.google.gson.annotations.SerializedName;
|
||||||
|
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
public final class ServerSettings {
|
||||||
|
@SerializedName("image_server")
|
||||||
|
private final String imageServer;
|
||||||
|
private final TlsCert tls;
|
||||||
|
|
||||||
|
public ServerSettings(String imageServer, TlsCert tls) {
|
||||||
|
this.imageServer = Objects.requireNonNull(imageServer);
|
||||||
|
this.tls = tls;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getImageServer() {
|
||||||
|
return imageServer;
|
||||||
|
}
|
||||||
|
|
||||||
|
public TlsCert getTls() {
|
||||||
|
return tls;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "ServerSettings{" + "imageServer='" + imageServer + '\'' + ", tls=" + "<hidden>" + '}';
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean equals(Object o) {
|
||||||
|
if (this == o)
|
||||||
|
return true;
|
||||||
|
if (o == null || getClass() != o.getClass())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
ServerSettings that = (ServerSettings) o;
|
||||||
|
|
||||||
|
if (!imageServer.equals(that.imageServer))
|
||||||
|
return false;
|
||||||
|
return Objects.equals(tls, that.tls);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int hashCode() {
|
||||||
|
int result = imageServer.hashCode();
|
||||||
|
result = 31 * result + (tls != null ? tls.hashCode() : 0);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static final class TlsCert {
|
||||||
|
@SerializedName("created_at")
|
||||||
|
private final String createdAt;
|
||||||
|
@SerializedName("private_key")
|
||||||
|
private final String privateKey;
|
||||||
|
private final String certificate;
|
||||||
|
|
||||||
|
public TlsCert(String createdAt, String privateKey, String certificate) {
|
||||||
|
this.createdAt = Objects.requireNonNull(createdAt);
|
||||||
|
this.privateKey = Objects.requireNonNull(privateKey);
|
||||||
|
this.certificate = Objects.requireNonNull(certificate);
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getCreatedAt() {
|
||||||
|
return createdAt;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getPrivateKey() {
|
||||||
|
return privateKey;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getCertificate() {
|
||||||
|
return certificate;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "TlsCert{" + "createdAt='" + createdAt + '\'' + ", privateKey='" + privateKey + '\''
|
||||||
|
+ ", certificate='" + certificate + '\'' + '}';
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean equals(Object o) {
|
||||||
|
if (this == o)
|
||||||
|
return true;
|
||||||
|
if (o == null || getClass() != o.getClass())
|
||||||
|
return false;
|
||||||
|
|
||||||
|
TlsCert tlsCert = (TlsCert) o;
|
||||||
|
|
||||||
|
if (!createdAt.equals(tlsCert.createdAt))
|
||||||
|
return false;
|
||||||
|
if (!privateKey.equals(tlsCert.privateKey))
|
||||||
|
return false;
|
||||||
|
return certificate.equals(tlsCert.certificate);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int hashCode() {
|
||||||
|
int result = createdAt.hashCode();
|
||||||
|
result = 31 * result + privateKey.hashCode();
|
||||||
|
result = 31 * result + certificate.hashCode();
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
40
src/main/java/mdnet/base/Statistics.java
Normal file
40
src/main/java/mdnet/base/Statistics.java
Normal file
|
|
@ -0,0 +1,40 @@
|
||||||
|
package mdnet.base;
|
||||||
|
|
||||||
|
import java.util.concurrent.atomic.AtomicInteger;
|
||||||
|
import java.util.concurrent.atomic.AtomicLong;
|
||||||
|
|
||||||
|
public class Statistics {
|
||||||
|
private final AtomicInteger requestsServed;
|
||||||
|
private final AtomicInteger cacheHits;
|
||||||
|
private final AtomicInteger cacheMisses;
|
||||||
|
private final AtomicLong bytesSent;
|
||||||
|
|
||||||
|
public Statistics() {
|
||||||
|
requestsServed = new AtomicInteger();
|
||||||
|
cacheHits = new AtomicInteger();
|
||||||
|
cacheMisses = new AtomicInteger();
|
||||||
|
bytesSent = new AtomicLong();
|
||||||
|
}
|
||||||
|
|
||||||
|
public AtomicInteger getRequestsServed() {
|
||||||
|
return requestsServed;
|
||||||
|
}
|
||||||
|
|
||||||
|
public AtomicInteger getCacheHits() {
|
||||||
|
return cacheHits;
|
||||||
|
}
|
||||||
|
|
||||||
|
public AtomicInteger getCacheMisses() {
|
||||||
|
return cacheMisses;
|
||||||
|
}
|
||||||
|
|
||||||
|
public AtomicLong getBytesSent() {
|
||||||
|
return bytesSent;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
return "Statistics{" + "requestsServed=" + requestsServed + ", cacheHits=" + cacheHits + ", cacheMisses="
|
||||||
|
+ cacheMisses + ", bytesSent=" + bytesSent + '}';
|
||||||
|
}
|
||||||
|
}
|
||||||
949
src/main/java/mdnet/cache/DiskLruCache.java
vendored
Normal file
949
src/main/java/mdnet/cache/DiskLruCache.java
vendored
Normal file
|
|
@ -0,0 +1,949 @@
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2011 The Android Open Source Project
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package mdnet.cache;
|
||||||
|
|
||||||
|
import org.apache.commons.io.IOUtils;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
|
||||||
|
import java.io.BufferedWriter;
|
||||||
|
import java.io.Closeable;
|
||||||
|
import java.io.EOFException;
|
||||||
|
import java.io.File;
|
||||||
|
import java.io.FileInputStream;
|
||||||
|
import java.io.FileNotFoundException;
|
||||||
|
import java.io.FileOutputStream;
|
||||||
|
import java.io.FilterOutputStream;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
import java.io.OutputStreamWriter;
|
||||||
|
import java.io.Writer;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Iterator;
|
||||||
|
import java.util.LinkedHashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.concurrent.Callable;
|
||||||
|
import java.util.concurrent.LinkedBlockingQueue;
|
||||||
|
import java.util.concurrent.ThreadPoolExecutor;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
import java.util.regex.Matcher;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A cache that uses a bounded amount of space on a filesystem. Each cache entry
|
||||||
|
* has a string key and a fixed number of values. Each key must match the regex
|
||||||
|
* <strong>[a-z0-9_-]{1,120}</strong>. Values are byte sequences, accessible as
|
||||||
|
* streams or files. Each value must be between {@code 0} and
|
||||||
|
* {@code Integer.MAX_VALUE} bytes in length.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* The cache stores its data in a directory on the filesystem. This directory
|
||||||
|
* must be exclusive to the cache; the cache may delete or overwrite files from
|
||||||
|
* its directory. It is an error for multiple processes to use the same cache
|
||||||
|
* directory at the same time.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* This cache limits the number of bytes that it will store on the filesystem.
|
||||||
|
* When the number of stored bytes exceeds the limit, the cache will remove
|
||||||
|
* entries in the background until the limit is satisfied. The limit is not
|
||||||
|
* strict: the cache may temporarily exceed it while waiting for files to be
|
||||||
|
* deleted. The limit does not include filesystem overhead or the cache journal
|
||||||
|
* so space-sensitive applications should set a conservative limit.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* Clients call {@link #edit} to create or update the values of an entry. An
|
||||||
|
* entry may have only one editor at one time; if a value is not available to be
|
||||||
|
* edited then {@link #edit} will return null.
|
||||||
|
* <ul>
|
||||||
|
* <li>When an entry is being <strong>created</strong> it is necessary to supply
|
||||||
|
* a full set of values; the empty value should be used as a placeholder if
|
||||||
|
* necessary.
|
||||||
|
* <li>When an entry is being <strong>edited</strong>, it is not necessary to
|
||||||
|
* supply data for every value; values default to their previous value.
|
||||||
|
* </ul>
|
||||||
|
* Every {@link #edit} call must be matched by a call to {@link Editor#commit}
|
||||||
|
* or {@link Editor#abort}. Committing is atomic: a read observes the full set
|
||||||
|
* of values as they were before or after the commit, but never a mix of values.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* Clients call {@link #get} to read a snapshot of an entry. The read will
|
||||||
|
* observe the value at the time that {@link #get} was called. Updates and
|
||||||
|
* removals after the call do not impact ongoing reads.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* This class is tolerant of some I/O errors. If files are missing from the
|
||||||
|
* filesystem, the corresponding entries will be dropped from the cache. If an
|
||||||
|
* error occurs while writing a cache value, the edit will fail silently.
|
||||||
|
* Callers should handle other problems by catching {@code IOException} and
|
||||||
|
* responding appropriately.
|
||||||
|
*/
|
||||||
|
public final class DiskLruCache implements Closeable {
|
||||||
|
private final static Logger LOGGER = LoggerFactory.getLogger(DiskLruCache.class);
|
||||||
|
|
||||||
|
private static final String JOURNAL_FILE = "journal";
|
||||||
|
private static final String JOURNAL_FILE_TEMP = "journal.tmp";
|
||||||
|
private static final String JOURNAL_FILE_BACKUP = "journal.bkp";
|
||||||
|
|
||||||
|
private static final String MAGIC = "libcore.io.DiskLruCache";
|
||||||
|
private static final String VERSION_1 = "1";
|
||||||
|
private static final long ANY_SEQUENCE_NUMBER = -1;
|
||||||
|
private static final String STRING_KEY_PATTERN = "[a-z0-9_-]{1,120}";
|
||||||
|
public static final Pattern LEGAL_KEY_PATTERN = Pattern.compile(STRING_KEY_PATTERN);
|
||||||
|
private static final String CLEAN = "CLEAN";
|
||||||
|
private static final String DIRTY = "DIRTY";
|
||||||
|
private static final String REMOVE = "REMOVE";
|
||||||
|
private static final String READ = "READ";
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This cache uses a journal file named "journal". A typical journal file looks
|
||||||
|
* like this: libcore.io.DiskLruCache 1 100 2
|
||||||
|
*
|
||||||
|
* CLEAN 3400330d1dfc7f3f7f4b8d4d803dfcf6 832 21054 DIRTY
|
||||||
|
* 335c4c6028171cfddfbaae1a9c313c52 CLEAN 335c4c6028171cfddfbaae1a9c313c52 3934
|
||||||
|
* 2342 REMOVE 335c4c6028171cfddfbaae1a9c313c52 DIRTY
|
||||||
|
* 1ab96a171faeeee38496d8b330771a7a CLEAN 1ab96a171faeeee38496d8b330771a7a 1600
|
||||||
|
* 234 READ 335c4c6028171cfddfbaae1a9c313c52 READ
|
||||||
|
* 3400330d1dfc7f3f7f4b8d4d803dfcf6
|
||||||
|
*
|
||||||
|
* The first five lines of the journal form its header. They are the constant
|
||||||
|
* string "libcore.io.DiskLruCache", the disk cache's version, the application's
|
||||||
|
* version, the value count, and a blank line.
|
||||||
|
*
|
||||||
|
* Each of the subsequent lines in the file is a record of the state of a cache
|
||||||
|
* entry. Each line contains space-separated values: a state, a key, and
|
||||||
|
* optional state-specific values. o DIRTY lines track that an entry is actively
|
||||||
|
* being created or updated. Every successful DIRTY action should be followed by
|
||||||
|
* a CLEAN or REMOVE action. DIRTY lines without a matching CLEAN or REMOVE
|
||||||
|
* indicate that temporary files may need to be deleted. o CLEAN lines track a
|
||||||
|
* cache entry that has been successfully published and may be read. A publish
|
||||||
|
* line is followed by the lengths of each of its values. o READ lines track
|
||||||
|
* accesses for LRU. o REMOVE lines track entries that have been deleted.
|
||||||
|
*
|
||||||
|
* The journal file is appended to as cache operations occur. The journal may
|
||||||
|
* occasionally be compacted by dropping redundant lines. A temporary file named
|
||||||
|
* "journal.tmp" will be used during compaction; that file should be deleted if
|
||||||
|
* it exists when the cache is opened.
|
||||||
|
*/
|
||||||
|
|
||||||
|
private final File directory;
|
||||||
|
private final File journalFile;
|
||||||
|
private final File journalFileTmp;
|
||||||
|
private final File journalFileBackup;
|
||||||
|
private final int appVersion;
|
||||||
|
private long maxSize;
|
||||||
|
private final int valueCount;
|
||||||
|
private long size = 0;
|
||||||
|
private Writer journalWriter;
|
||||||
|
private final LinkedHashMap<String, Entry> lruEntries = new LinkedHashMap<>(0, 0.75f, true);
|
||||||
|
private int redundantOpCount;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* To differentiate between old and current snapshots, each entry is given a
|
||||||
|
* sequence number each time an edit is committed. A snapshot is stale if its
|
||||||
|
* sequence number is not equal to its entry's sequence number.
|
||||||
|
*/
|
||||||
|
private long nextSequenceNumber = 0;
|
||||||
|
|
||||||
|
/** This cache uses a single background thread to evict entries. */
|
||||||
|
final ThreadPoolExecutor executorService = new ThreadPoolExecutor(0, 1, 60L, TimeUnit.SECONDS,
|
||||||
|
new LinkedBlockingQueue<>());
|
||||||
|
private final Callable<Void> cleanupCallable = new Callable<Void>() {
|
||||||
|
public Void call() throws Exception {
|
||||||
|
synchronized (DiskLruCache.this) {
|
||||||
|
if (journalWriter == null) {
|
||||||
|
return null; // Closed.
|
||||||
|
}
|
||||||
|
trimToSize();
|
||||||
|
if (journalRebuildRequired()) {
|
||||||
|
rebuildJournal();
|
||||||
|
redundantOpCount = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
private DiskLruCache(File directory, int appVersion, int valueCount, long maxSize) {
|
||||||
|
this.directory = directory;
|
||||||
|
this.appVersion = appVersion;
|
||||||
|
this.journalFile = new File(directory, JOURNAL_FILE);
|
||||||
|
this.journalFileTmp = new File(directory, JOURNAL_FILE_TEMP);
|
||||||
|
this.journalFileBackup = new File(directory, JOURNAL_FILE_BACKUP);
|
||||||
|
this.valueCount = valueCount;
|
||||||
|
this.maxSize = maxSize;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Opens the cache in {@code directory}, creating a cache if none exists there.
|
||||||
|
*
|
||||||
|
* @param directory
|
||||||
|
* a writable directory
|
||||||
|
* @param valueCount
|
||||||
|
* the number of values per cache entry. Must be positive.
|
||||||
|
* @param maxSize
|
||||||
|
* the maximum number of bytes this cache should use to store
|
||||||
|
* @throws IOException
|
||||||
|
* if reading or writing the cache directory fails
|
||||||
|
*/
|
||||||
|
public static DiskLruCache open(File directory, int appVersion, int valueCount, long maxSize) throws IOException {
|
||||||
|
if (maxSize <= 0) {
|
||||||
|
throw new IllegalArgumentException("maxSize <= 0");
|
||||||
|
}
|
||||||
|
if (valueCount <= 0) {
|
||||||
|
throw new IllegalArgumentException("valueCount <= 0");
|
||||||
|
}
|
||||||
|
|
||||||
|
// If a bkp file exists, use it instead.
|
||||||
|
File backupFile = new File(directory, JOURNAL_FILE_BACKUP);
|
||||||
|
if (backupFile.exists()) {
|
||||||
|
File journalFile = new File(directory, JOURNAL_FILE);
|
||||||
|
// If journal file also exists just delete backup file.
|
||||||
|
if (journalFile.exists()) {
|
||||||
|
backupFile.delete();
|
||||||
|
} else {
|
||||||
|
renameTo(backupFile, journalFile, false);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Prefer to pick up where we left off.
|
||||||
|
DiskLruCache cache = new DiskLruCache(directory, appVersion, valueCount, maxSize);
|
||||||
|
if (cache.journalFile.exists()) {
|
||||||
|
try {
|
||||||
|
cache.readJournal();
|
||||||
|
cache.processJournal();
|
||||||
|
return cache;
|
||||||
|
} catch (IOException journalIsCorrupt) {
|
||||||
|
if (LOGGER.isWarnEnabled()) {
|
||||||
|
LOGGER.warn("DiskLruCache " + directory + " is corrupt - removing", journalIsCorrupt);
|
||||||
|
}
|
||||||
|
cache.delete();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create a new empty cache.
|
||||||
|
directory.mkdirs();
|
||||||
|
cache = new DiskLruCache(directory, appVersion, valueCount, maxSize);
|
||||||
|
cache.rebuildJournal();
|
||||||
|
return cache;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void readJournal() throws IOException {
|
||||||
|
StrictLineReader reader = new StrictLineReader(new FileInputStream(journalFile), StandardCharsets.UTF_8);
|
||||||
|
try {
|
||||||
|
String magic = reader.readLine();
|
||||||
|
String version = reader.readLine();
|
||||||
|
String appVersionString = reader.readLine();
|
||||||
|
String valueCountString = reader.readLine();
|
||||||
|
String blank = reader.readLine();
|
||||||
|
if (!MAGIC.equals(magic) || !VERSION_1.equals(version)
|
||||||
|
|| !Integer.toString(appVersion).equals(appVersionString)
|
||||||
|
|| !Integer.toString(valueCount).equals(valueCountString) || !"".equals(blank)) {
|
||||||
|
throw new IOException("unexpected journal header: [" + magic + ", " + version + ", " + valueCountString
|
||||||
|
+ ", " + blank + "]");
|
||||||
|
}
|
||||||
|
|
||||||
|
int lineCount = 0;
|
||||||
|
while (true) {
|
||||||
|
try {
|
||||||
|
readJournalLine(reader.readLine());
|
||||||
|
lineCount++;
|
||||||
|
} catch (EOFException endOfJournal) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
redundantOpCount = lineCount - lruEntries.size();
|
||||||
|
|
||||||
|
// If we ended on a truncated line, rebuild the journal before appending to it.
|
||||||
|
if (reader.hasUnterminatedLine()) {
|
||||||
|
rebuildJournal();
|
||||||
|
} else {
|
||||||
|
journalWriter = new BufferedWriter(
|
||||||
|
new OutputStreamWriter(new FileOutputStream(journalFile, true), StandardCharsets.UTF_8));
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
Util.closeQuietly(reader);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void readJournalLine(String line) throws IOException {
|
||||||
|
int firstSpace = line.indexOf(' ');
|
||||||
|
if (firstSpace == -1) {
|
||||||
|
throw new IOException("unexpected journal line: " + line);
|
||||||
|
}
|
||||||
|
|
||||||
|
int keyBegin = firstSpace + 1;
|
||||||
|
int secondSpace = line.indexOf(' ', keyBegin);
|
||||||
|
final String key;
|
||||||
|
if (secondSpace == -1) {
|
||||||
|
key = line.substring(keyBegin);
|
||||||
|
if (firstSpace == REMOVE.length() && line.startsWith(REMOVE)) {
|
||||||
|
lruEntries.remove(key);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
key = line.substring(keyBegin, secondSpace);
|
||||||
|
}
|
||||||
|
|
||||||
|
Entry entry = lruEntries.get(key);
|
||||||
|
if (entry == null) {
|
||||||
|
entry = new Entry(key);
|
||||||
|
lruEntries.put(key, entry);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (secondSpace != -1 && firstSpace == CLEAN.length() && line.startsWith(CLEAN)) {
|
||||||
|
String[] parts = line.substring(secondSpace + 1).split(" ");
|
||||||
|
entry.readable = true;
|
||||||
|
entry.currentEditor = null;
|
||||||
|
entry.setLengths(parts);
|
||||||
|
} else if (secondSpace == -1 && firstSpace == DIRTY.length() && line.startsWith(DIRTY)) {
|
||||||
|
entry.currentEditor = new Editor(entry);
|
||||||
|
} else if (secondSpace == -1 && firstSpace == READ.length() && line.startsWith(READ)) {
|
||||||
|
// This work was already done by calling lruEntries.get().
|
||||||
|
} else {
|
||||||
|
throw new IOException("unexpected journal line: " + line);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Computes the initial size and collects garbage as a part of opening the
|
||||||
|
* cache. Dirty entries are assumed to be inconsistent and will be deleted.
|
||||||
|
*/
|
||||||
|
private void processJournal() throws IOException {
|
||||||
|
deleteIfExists(journalFileTmp);
|
||||||
|
for (Iterator<Entry> i = lruEntries.values().iterator(); i.hasNext();) {
|
||||||
|
Entry entry = i.next();
|
||||||
|
if (entry.currentEditor == null) {
|
||||||
|
for (int t = 0; t < valueCount; t++) {
|
||||||
|
size += entry.lengths[t];
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
entry.currentEditor = null;
|
||||||
|
for (int t = 0; t < valueCount; t++) {
|
||||||
|
deleteIfExists(entry.getCleanFile(t));
|
||||||
|
deleteIfExists(entry.getDirtyFile(t));
|
||||||
|
}
|
||||||
|
i.remove();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new journal that omits redundant information. This replaces the
|
||||||
|
* current journal if it exists.
|
||||||
|
*/
|
||||||
|
private synchronized void rebuildJournal() throws IOException {
|
||||||
|
if (journalWriter != null) {
|
||||||
|
journalWriter.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
Writer writer = new BufferedWriter(
|
||||||
|
new OutputStreamWriter(new FileOutputStream(journalFileTmp), StandardCharsets.UTF_8));
|
||||||
|
try {
|
||||||
|
writer.write(MAGIC);
|
||||||
|
writer.write("\n");
|
||||||
|
writer.write(VERSION_1);
|
||||||
|
writer.write("\n");
|
||||||
|
writer.write(Integer.toString(appVersion));
|
||||||
|
writer.write("\n");
|
||||||
|
writer.write(Integer.toString(valueCount));
|
||||||
|
writer.write("\n");
|
||||||
|
writer.write("\n");
|
||||||
|
|
||||||
|
for (Entry entry : lruEntries.values()) {
|
||||||
|
if (entry.currentEditor != null) {
|
||||||
|
writer.write(DIRTY + ' ' + entry.key + '\n');
|
||||||
|
} else {
|
||||||
|
writer.write(CLEAN + ' ' + entry.key + entry.getLengths() + '\n');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
Util.closeQuietly(writer);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (journalFile.exists()) {
|
||||||
|
renameTo(journalFile, journalFileBackup, true);
|
||||||
|
}
|
||||||
|
renameTo(journalFileTmp, journalFile, false);
|
||||||
|
journalFileBackup.delete();
|
||||||
|
|
||||||
|
journalWriter = new BufferedWriter(
|
||||||
|
new OutputStreamWriter(new FileOutputStream(journalFile, true), StandardCharsets.UTF_8));
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void deleteIfExists(File file) throws IOException {
|
||||||
|
if (file.exists() && !file.delete()) {
|
||||||
|
throw new IOException();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static void renameTo(File from, File to, boolean deleteDestination) throws IOException {
|
||||||
|
if (deleteDestination) {
|
||||||
|
deleteIfExists(to);
|
||||||
|
}
|
||||||
|
if (!from.renameTo(to)) {
|
||||||
|
throw new IOException();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a snapshot of the entry named {@code key}, or null if it doesn't
|
||||||
|
* exist is not currently readable. If a value is returned, it is moved to the
|
||||||
|
* head of the LRU queue.
|
||||||
|
*/
|
||||||
|
public synchronized Snapshot get(String key) throws IOException {
|
||||||
|
checkNotClosed();
|
||||||
|
validateKey(key);
|
||||||
|
Entry entry = lruEntries.get(key);
|
||||||
|
if (entry == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!entry.readable) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Open all streams eagerly to guarantee that we see a single published
|
||||||
|
// snapshot. If we opened streams lazily then the streams could come
|
||||||
|
// from different edits.
|
||||||
|
InputStream[] ins = new InputStream[valueCount];
|
||||||
|
try {
|
||||||
|
for (int i = 0; i < valueCount; i++) {
|
||||||
|
ins[i] = new FileInputStream(entry.getCleanFile(i));
|
||||||
|
}
|
||||||
|
} catch (FileNotFoundException e) {
|
||||||
|
// A file must have been deleted manually!
|
||||||
|
for (int i = 0; i < valueCount; i++) {
|
||||||
|
if (ins[i] != null) {
|
||||||
|
Util.closeQuietly(ins[i]);
|
||||||
|
} else {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
redundantOpCount++;
|
||||||
|
journalWriter.append(READ + ' ').append(key).append(String.valueOf('\n'));
|
||||||
|
if (journalRebuildRequired()) {
|
||||||
|
executorService.submit(cleanupCallable);
|
||||||
|
}
|
||||||
|
|
||||||
|
return new Snapshot(key, entry.sequenceNumber, ins, entry.lengths);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an editor for the entry named {@code key}, or null if another edit is
|
||||||
|
* in progress.
|
||||||
|
*/
|
||||||
|
public Editor edit(String key) throws IOException {
|
||||||
|
return edit(key, ANY_SEQUENCE_NUMBER);
|
||||||
|
}
|
||||||
|
|
||||||
|
private synchronized Editor edit(String key, long expectedSequenceNumber) throws IOException {
|
||||||
|
checkNotClosed();
|
||||||
|
validateKey(key);
|
||||||
|
Entry entry = lruEntries.get(key);
|
||||||
|
if (expectedSequenceNumber != ANY_SEQUENCE_NUMBER
|
||||||
|
&& (entry == null || entry.sequenceNumber != expectedSequenceNumber)) {
|
||||||
|
return null; // Snapshot is stale.
|
||||||
|
}
|
||||||
|
if (entry == null) {
|
||||||
|
entry = new Entry(key);
|
||||||
|
lruEntries.put(key, entry);
|
||||||
|
} else if (entry.currentEditor != null) {
|
||||||
|
return null; // Another edit is in progress.
|
||||||
|
}
|
||||||
|
|
||||||
|
Editor editor = new Editor(entry);
|
||||||
|
entry.currentEditor = editor;
|
||||||
|
|
||||||
|
// Flush the journal before creating files to prevent file leaks.
|
||||||
|
journalWriter.write(DIRTY + ' ' + key + '\n');
|
||||||
|
journalWriter.flush();
|
||||||
|
return editor;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns the directory where this cache stores its data. */
|
||||||
|
public File getDirectory() {
|
||||||
|
return directory;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the maximum number of bytes that this cache should use to store its
|
||||||
|
* data.
|
||||||
|
*/
|
||||||
|
public synchronized long getMaxSize() {
|
||||||
|
return maxSize;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Changes the maximum number of bytes the cache can store and queues a job to
|
||||||
|
* trim the existing store, if necessary.
|
||||||
|
*/
|
||||||
|
public synchronized void setMaxSize(long maxSize) {
|
||||||
|
this.maxSize = maxSize;
|
||||||
|
executorService.submit(cleanupCallable);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the number of bytes currently being used to store the values in this
|
||||||
|
* cache. This may be greater than the max size if a background deletion is
|
||||||
|
* pending.
|
||||||
|
*/
|
||||||
|
public synchronized long size() {
|
||||||
|
return size;
|
||||||
|
}
|
||||||
|
|
||||||
|
private synchronized void completeEdit(Editor editor, boolean success) throws IOException {
|
||||||
|
Entry entry = editor.entry;
|
||||||
|
if (entry.currentEditor != editor) {
|
||||||
|
throw new IllegalStateException();
|
||||||
|
}
|
||||||
|
|
||||||
|
// If this edit is creating the entry for the first time, every index must have
|
||||||
|
// a value.
|
||||||
|
if (success && !entry.readable) {
|
||||||
|
for (int i = 0; i < valueCount; i++) {
|
||||||
|
if (!editor.written[i]) {
|
||||||
|
editor.abort();
|
||||||
|
throw new IllegalStateException("Newly created entry didn't create value for index " + i);
|
||||||
|
}
|
||||||
|
if (!entry.getDirtyFile(i).exists()) {
|
||||||
|
editor.abort();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (int i = 0; i < valueCount; i++) {
|
||||||
|
File dirty = entry.getDirtyFile(i);
|
||||||
|
if (success) {
|
||||||
|
if (dirty.exists()) {
|
||||||
|
File clean = entry.getCleanFile(i);
|
||||||
|
dirty.renameTo(clean);
|
||||||
|
long oldLength = entry.lengths[i];
|
||||||
|
long newLength = clean.length();
|
||||||
|
entry.lengths[i] = newLength;
|
||||||
|
size = size - oldLength + newLength;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
deleteIfExists(dirty);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
redundantOpCount++;
|
||||||
|
entry.currentEditor = null;
|
||||||
|
if (entry.readable | success) {
|
||||||
|
entry.readable = true;
|
||||||
|
journalWriter.write(CLEAN + ' ' + entry.key + entry.getLengths() + '\n');
|
||||||
|
if (success) {
|
||||||
|
entry.sequenceNumber = nextSequenceNumber++;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
lruEntries.remove(entry.key);
|
||||||
|
journalWriter.write(REMOVE + ' ' + entry.key + '\n');
|
||||||
|
}
|
||||||
|
journalWriter.flush();
|
||||||
|
|
||||||
|
if (size > maxSize || journalRebuildRequired()) {
|
||||||
|
executorService.submit(cleanupCallable);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* We only rebuild the journal when it will halve the size of the journal and
|
||||||
|
* eliminate at least 2000 ops.
|
||||||
|
*/
|
||||||
|
private boolean journalRebuildRequired() {
|
||||||
|
final int redundantOpCompactThreshold = 2000;
|
||||||
|
return redundantOpCount >= redundantOpCompactThreshold //
|
||||||
|
&& redundantOpCount >= lruEntries.size();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Drops the entry for {@code key} if it exists and can be removed. Entries
|
||||||
|
* actively being edited cannot be removed.
|
||||||
|
*
|
||||||
|
* @return true if an entry was removed.
|
||||||
|
*/
|
||||||
|
public synchronized boolean remove(String key) throws IOException {
|
||||||
|
checkNotClosed();
|
||||||
|
validateKey(key);
|
||||||
|
Entry entry = lruEntries.get(key);
|
||||||
|
if (entry == null || entry.currentEditor != null) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (int i = 0; i < valueCount; i++) {
|
||||||
|
File file = entry.getCleanFile(i);
|
||||||
|
if (file.exists() && !file.delete()) {
|
||||||
|
throw new IOException("failed to delete " + file);
|
||||||
|
}
|
||||||
|
size -= entry.lengths[i];
|
||||||
|
entry.lengths[i] = 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
redundantOpCount++;
|
||||||
|
journalWriter.append(REMOVE + ' ' + key + '\n');
|
||||||
|
lruEntries.remove(key);
|
||||||
|
|
||||||
|
if (journalRebuildRequired()) {
|
||||||
|
executorService.submit(cleanupCallable);
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns true if this cache has been closed. */
|
||||||
|
public synchronized boolean isClosed() {
|
||||||
|
return journalWriter == null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void checkNotClosed() {
|
||||||
|
if (journalWriter == null) {
|
||||||
|
throw new IllegalStateException("cache is closed");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Force buffered operations to the filesystem. */
|
||||||
|
public synchronized void flush() throws IOException {
|
||||||
|
checkNotClosed();
|
||||||
|
trimToSize();
|
||||||
|
journalWriter.flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Closes this cache. Stored values will remain on the filesystem. */
|
||||||
|
public synchronized void close() throws IOException {
|
||||||
|
if (journalWriter == null) {
|
||||||
|
return; // Already closed.
|
||||||
|
}
|
||||||
|
for (Entry entry : new ArrayList<>(lruEntries.values())) {
|
||||||
|
if (entry.currentEditor != null) {
|
||||||
|
entry.currentEditor.abort();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
trimToSize();
|
||||||
|
journalWriter.close();
|
||||||
|
journalWriter = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void trimToSize() throws IOException {
|
||||||
|
while (size > maxSize) {
|
||||||
|
Map.Entry<String, Entry> toEvict = lruEntries.entrySet().iterator().next();
|
||||||
|
remove(toEvict.getKey());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Closes the cache and deletes all of its stored values. This will delete all
|
||||||
|
* files in the cache directory including files that weren't created by the
|
||||||
|
* cache.
|
||||||
|
*/
|
||||||
|
public void delete() throws IOException {
|
||||||
|
close();
|
||||||
|
Util.deleteContents(directory);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void validateKey(String key) {
|
||||||
|
Matcher matcher = LEGAL_KEY_PATTERN.matcher(key);
|
||||||
|
if (!matcher.matches()) {
|
||||||
|
throw new IllegalArgumentException("keys must match regex " + STRING_KEY_PATTERN + ": \"" + key + "\"");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A snapshot of the values for an entry. */
|
||||||
|
public final class Snapshot implements Closeable {
|
||||||
|
private final String key;
|
||||||
|
private final long sequenceNumber;
|
||||||
|
private final InputStream[] ins;
|
||||||
|
private final long[] lengths;
|
||||||
|
|
||||||
|
private Snapshot(String key, long sequenceNumber, InputStream[] ins, long[] lengths) {
|
||||||
|
this.key = key;
|
||||||
|
this.sequenceNumber = sequenceNumber;
|
||||||
|
this.ins = ins;
|
||||||
|
this.lengths = lengths;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an editor for this snapshot's entry, or null if either the entry has
|
||||||
|
* changed since this snapshot was created or if another edit is in progress.
|
||||||
|
*/
|
||||||
|
public Editor edit() throws IOException {
|
||||||
|
return DiskLruCache.this.edit(key, sequenceNumber);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns the unbuffered stream with the value for {@code index}. */
|
||||||
|
public InputStream getInputStream(int index) {
|
||||||
|
return ins[index];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns the string value for {@code index}. */
|
||||||
|
public String getString(int index) throws IOException {
|
||||||
|
try (InputStream in = getInputStream(index)) {
|
||||||
|
return IOUtils.toString(in, StandardCharsets.UTF_8);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns the byte length of the value for {@code index}. */
|
||||||
|
public long getLength(int index) {
|
||||||
|
return lengths[index];
|
||||||
|
}
|
||||||
|
|
||||||
|
public void close() {
|
||||||
|
for (InputStream in : ins) {
|
||||||
|
Util.closeQuietly(in);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private static final OutputStream NULL_OUTPUT_STREAM = new OutputStream() {
|
||||||
|
@Override
|
||||||
|
public void write(int b) {
|
||||||
|
// Eat all writes silently. Nom nom.
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
/** Edits the values for an entry. */
|
||||||
|
public final class Editor {
|
||||||
|
private final Entry entry;
|
||||||
|
private final boolean[] written;
|
||||||
|
private boolean hasErrors;
|
||||||
|
private boolean committed;
|
||||||
|
|
||||||
|
private Editor(Entry entry) {
|
||||||
|
this.entry = entry;
|
||||||
|
this.written = (entry.readable) ? null : new boolean[valueCount];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an unbuffered input stream to read the last committed value, or null
|
||||||
|
* if no value has been committed.
|
||||||
|
*/
|
||||||
|
public InputStream newInputStream(int index) throws IOException {
|
||||||
|
synchronized (DiskLruCache.this) {
|
||||||
|
if (entry.currentEditor != this) {
|
||||||
|
throw new IllegalStateException();
|
||||||
|
}
|
||||||
|
if (!entry.readable) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
return new FileInputStream(entry.getCleanFile(index));
|
||||||
|
} catch (FileNotFoundException e) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the last committed value as a string, or null if no value has been
|
||||||
|
* committed.
|
||||||
|
*/
|
||||||
|
public String getString(int index) throws IOException {
|
||||||
|
InputStream in = newInputStream(index);
|
||||||
|
try {
|
||||||
|
return in != null ? IOUtils.toString(in, StandardCharsets.UTF_8) : null;
|
||||||
|
} finally {
|
||||||
|
Util.closeQuietly(in);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Write a string to the specified index.
|
||||||
|
*/
|
||||||
|
public void setString(int index, String value) throws IOException {
|
||||||
|
OutputStream out = newOutputStream(index);
|
||||||
|
try {
|
||||||
|
IOUtils.write(value, out, StandardCharsets.UTF_8);
|
||||||
|
} finally {
|
||||||
|
Util.closeQuietly(out);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a new unbuffered output stream to write the value at {@code index}.
|
||||||
|
* If the underlying output stream encounters errors when writing to the
|
||||||
|
* filesystem, this edit will be aborted when {@link #commit} is called. The
|
||||||
|
* returned output stream does not throw IOExceptions.
|
||||||
|
*/
|
||||||
|
public OutputStream newOutputStream(int index) {
|
||||||
|
if (index < 0 || index >= valueCount) {
|
||||||
|
throw new IllegalArgumentException("Expected index " + index + " to "
|
||||||
|
+ "be greater than 0 and less than the maximum value count " + "of " + valueCount);
|
||||||
|
}
|
||||||
|
synchronized (DiskLruCache.this) {
|
||||||
|
if (entry.currentEditor != this) {
|
||||||
|
throw new IllegalStateException();
|
||||||
|
}
|
||||||
|
if (!entry.readable) {
|
||||||
|
written[index] = true;
|
||||||
|
}
|
||||||
|
File dirtyFile = entry.getDirtyFile(index);
|
||||||
|
FileOutputStream outputStream;
|
||||||
|
try {
|
||||||
|
outputStream = new FileOutputStream(dirtyFile);
|
||||||
|
} catch (FileNotFoundException e) {
|
||||||
|
// Attempt to recreate the cache directory.
|
||||||
|
directory.mkdirs();
|
||||||
|
try {
|
||||||
|
outputStream = new FileOutputStream(dirtyFile);
|
||||||
|
} catch (FileNotFoundException e2) {
|
||||||
|
// We are unable to recover. Silently eat the writes.
|
||||||
|
return NULL_OUTPUT_STREAM;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return new FaultHidingOutputStream(outputStream);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Commits this edit so it is visible to readers. This releases the edit lock so
|
||||||
|
* another edit may be started on the same key.
|
||||||
|
*/
|
||||||
|
public void commit() throws IOException {
|
||||||
|
if (hasErrors) {
|
||||||
|
completeEdit(this, false);
|
||||||
|
remove(entry.key); // The previous entry is stale.
|
||||||
|
} else {
|
||||||
|
completeEdit(this, true);
|
||||||
|
}
|
||||||
|
committed = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Aborts this edit. This releases the edit lock so another edit may be started
|
||||||
|
* on the same key.
|
||||||
|
*/
|
||||||
|
public void abort() throws IOException {
|
||||||
|
completeEdit(this, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
public long getLength(int index) {
|
||||||
|
return entry.getDirtyFile(index).length();
|
||||||
|
}
|
||||||
|
|
||||||
|
public void abortUnlessCommitted() {
|
||||||
|
if (!committed) {
|
||||||
|
try {
|
||||||
|
abort();
|
||||||
|
} catch (IOException ignored) {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private class FaultHidingOutputStream extends FilterOutputStream {
|
||||||
|
private FaultHidingOutputStream(OutputStream out) {
|
||||||
|
super(out);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void write(int oneByte) {
|
||||||
|
try {
|
||||||
|
out.write(oneByte);
|
||||||
|
} catch (IOException e) {
|
||||||
|
hasErrors = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void write(byte[] buffer, int offset, int length) {
|
||||||
|
try {
|
||||||
|
out.write(buffer, offset, length);
|
||||||
|
} catch (IOException e) {
|
||||||
|
hasErrors = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void close() {
|
||||||
|
try {
|
||||||
|
out.close();
|
||||||
|
} catch (IOException e) {
|
||||||
|
hasErrors = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void flush() {
|
||||||
|
try {
|
||||||
|
out.flush();
|
||||||
|
} catch (IOException e) {
|
||||||
|
hasErrors = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private final class Entry {
|
||||||
|
private final String key;
|
||||||
|
|
||||||
|
/** Lengths of this entry's files. */
|
||||||
|
private final long[] lengths;
|
||||||
|
|
||||||
|
/** True if this entry has ever been published. */
|
||||||
|
private boolean readable;
|
||||||
|
|
||||||
|
/** The ongoing edit or null if this entry is not being edited. */
|
||||||
|
private Editor currentEditor;
|
||||||
|
|
||||||
|
/** The sequence number of the most recently committed edit to this entry. */
|
||||||
|
private long sequenceNumber;
|
||||||
|
|
||||||
|
private Entry(String key) {
|
||||||
|
this.key = key;
|
||||||
|
this.lengths = new long[valueCount];
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getLengths() {
|
||||||
|
StringBuilder result = new StringBuilder();
|
||||||
|
for (long size : lengths) {
|
||||||
|
result.append(' ').append(size);
|
||||||
|
}
|
||||||
|
return result.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Set lengths using decimal numbers like "10123". */
|
||||||
|
private void setLengths(String[] strings) throws IOException {
|
||||||
|
if (strings.length != valueCount) {
|
||||||
|
throw invalidLengths(strings);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
for (int i = 0; i < strings.length; i++) {
|
||||||
|
lengths[i] = Long.parseLong(strings[i]);
|
||||||
|
}
|
||||||
|
} catch (NumberFormatException e) {
|
||||||
|
throw invalidLengths(strings);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private IOException invalidLengths(String[] strings) throws IOException {
|
||||||
|
throw new IOException("unexpected journal line: " + java.util.Arrays.toString(strings));
|
||||||
|
}
|
||||||
|
|
||||||
|
public File getCleanFile(int i) {
|
||||||
|
return new File(directory, key + "." + i);
|
||||||
|
}
|
||||||
|
|
||||||
|
public File getDirtyFile(int i) {
|
||||||
|
return new File(directory, key + "." + i + ".tmp");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
216
src/main/java/mdnet/cache/StrictLineReader.java
vendored
Normal file
216
src/main/java/mdnet/cache/StrictLineReader.java
vendored
Normal file
|
|
@ -0,0 +1,216 @@
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2012 The Android Open Source Project
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package mdnet.cache;
|
||||||
|
|
||||||
|
import java.io.ByteArrayOutputStream;
|
||||||
|
import java.io.Closeable;
|
||||||
|
import java.io.EOFException;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.io.UnsupportedEncodingException;
|
||||||
|
import java.nio.charset.Charset;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Buffers input from an {@link InputStream} for reading lines.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* This class is used for buffered reading of lines. For purposes of this class,
|
||||||
|
* a line ends with "\n" or "\r\n". End of input is reported by throwing
|
||||||
|
* {@code EOFException}. Unterminated line at end of input is invalid and will
|
||||||
|
* be ignored, the caller may use {@code
|
||||||
|
* hasUnterminatedLine()} to detect it after catching the {@code EOFException}.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* This class is intended for reading input that strictly consists of lines,
|
||||||
|
* such as line-based cache entries or cache journal. Unlike the
|
||||||
|
* {@link java.io.BufferedReader} which in conjunction with
|
||||||
|
* {@link java.io.InputStreamReader} provides similar functionality, this class
|
||||||
|
* uses different end-of-input reporting and a more restrictive definition of a
|
||||||
|
* line.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* This class supports only charsets that encode '\r' and '\n' as a single byte
|
||||||
|
* with value 13 and 10, respectively, and the representation of no other
|
||||||
|
* character contains these values. We currently check in constructor that the
|
||||||
|
* charset is UTF-8.
|
||||||
|
*/
|
||||||
|
final class StrictLineReader implements Closeable {
|
||||||
|
private static final byte CR = (byte) '\r';
|
||||||
|
private static final byte LF = (byte) '\n';
|
||||||
|
|
||||||
|
private final InputStream in;
|
||||||
|
private final Charset charset;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Buffered data is stored in {@code buf}. As long as no exception occurs, 0 <=
|
||||||
|
* pos <= end and the data in the range [pos, end) is buffered for reading. At
|
||||||
|
* end of input, if there is an unterminated line, we set end == -1, otherwise
|
||||||
|
* end == pos. If the underlying {@code InputStream} throws an {@code
|
||||||
|
* IOException}, end may remain as either pos or -1.
|
||||||
|
*/
|
||||||
|
private byte[] buf;
|
||||||
|
private int pos;
|
||||||
|
private int end;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs a new {@code LineReader} with the specified charset and the
|
||||||
|
* default capacity.
|
||||||
|
*
|
||||||
|
* @param in
|
||||||
|
* the {@code InputStream} to read data from.
|
||||||
|
* @param charset
|
||||||
|
* the charset used to decode data. Only UTF-8 is supported.
|
||||||
|
* @throws NullPointerException
|
||||||
|
* if {@code in} or {@code charset} is null.
|
||||||
|
* @throws IllegalArgumentException
|
||||||
|
* if the specified charset is not supported.
|
||||||
|
*/
|
||||||
|
public StrictLineReader(InputStream in, Charset charset) {
|
||||||
|
this(in, 8192, charset);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs a new {@code LineReader} with the specified capacity and charset.
|
||||||
|
*
|
||||||
|
* @param in
|
||||||
|
* the {@code InputStream} to read data from.
|
||||||
|
* @param capacity
|
||||||
|
* the capacity of the buffer.
|
||||||
|
* @param charset
|
||||||
|
* the charset used to decode data. Only UTF-8 is supported.
|
||||||
|
* @throws NullPointerException
|
||||||
|
* if {@code in} or {@code charset} is null.
|
||||||
|
* @throws IllegalArgumentException
|
||||||
|
* if {@code capacity} is negative or zero or the specified charset
|
||||||
|
* is not supported.
|
||||||
|
*/
|
||||||
|
public StrictLineReader(InputStream in, int capacity, Charset charset) {
|
||||||
|
if (in == null || charset == null) {
|
||||||
|
throw new NullPointerException();
|
||||||
|
}
|
||||||
|
if (capacity < 0) {
|
||||||
|
throw new IllegalArgumentException("capacity <= 0");
|
||||||
|
}
|
||||||
|
if (!(charset.equals(StandardCharsets.UTF_8))) {
|
||||||
|
throw new IllegalArgumentException("Unsupported encoding");
|
||||||
|
}
|
||||||
|
|
||||||
|
this.in = in;
|
||||||
|
this.charset = charset;
|
||||||
|
buf = new byte[capacity];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Closes the reader by closing the underlying {@code InputStream} and marking
|
||||||
|
* this reader as closed.
|
||||||
|
*
|
||||||
|
* @throws IOException
|
||||||
|
* for errors when closing the underlying {@code InputStream}.
|
||||||
|
*/
|
||||||
|
public void close() throws IOException {
|
||||||
|
synchronized (in) {
|
||||||
|
if (buf != null) {
|
||||||
|
buf = null;
|
||||||
|
in.close();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reads the next line. A line ends with {@code "\n"} or {@code "\r\n"}, this
|
||||||
|
* end of line marker is not included in the result.
|
||||||
|
*
|
||||||
|
* @return the next line from the input.
|
||||||
|
* @throws IOException
|
||||||
|
* for underlying {@code InputStream} errors.
|
||||||
|
* @throws EOFException
|
||||||
|
* for the end of source stream.
|
||||||
|
*/
|
||||||
|
public String readLine() throws IOException {
|
||||||
|
synchronized (in) {
|
||||||
|
if (buf == null) {
|
||||||
|
throw new IOException("LineReader is closed");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Read more data if we are at the end of the buffered data.
|
||||||
|
// Though it's an error to read after an exception, we will let {@code
|
||||||
|
// fillBuf()}
|
||||||
|
// throw again if that happens; thus we need to handle end == -1 as well as end
|
||||||
|
// == pos.
|
||||||
|
if (pos >= end) {
|
||||||
|
fillBuf();
|
||||||
|
}
|
||||||
|
// Try to find LF in the buffered data and return the line if successful.
|
||||||
|
for (int i = pos; i != end; ++i) {
|
||||||
|
if (buf[i] == LF) {
|
||||||
|
int lineEnd = (i != pos && buf[i - 1] == CR) ? i - 1 : i;
|
||||||
|
String res = new String(buf, pos, lineEnd - pos, charset.name());
|
||||||
|
pos = i + 1;
|
||||||
|
return res;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Let's anticipate up to 80 characters on top of those already read.
|
||||||
|
ByteArrayOutputStream out = new ByteArrayOutputStream(end - pos + 80) {
|
||||||
|
@Override
|
||||||
|
public String toString() {
|
||||||
|
int length = (count > 0 && buf[count - 1] == CR) ? count - 1 : count;
|
||||||
|
try {
|
||||||
|
return new String(buf, 0, length, charset.name());
|
||||||
|
} catch (UnsupportedEncodingException e) {
|
||||||
|
throw new AssertionError(e); // Since we control the charset this will never happen.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
out.write(buf, pos, end - pos);
|
||||||
|
// Mark unterminated line in case fillBuf throws EOFException or IOException.
|
||||||
|
end = -1;
|
||||||
|
fillBuf();
|
||||||
|
// Try to find LF in the buffered data and return the line if successful.
|
||||||
|
for (int i = pos; i != end; ++i) {
|
||||||
|
if (buf[i] == LF) {
|
||||||
|
if (i != pos) {
|
||||||
|
out.write(buf, pos, i - pos);
|
||||||
|
}
|
||||||
|
pos = i + 1;
|
||||||
|
return out.toString();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean hasUnterminatedLine() {
|
||||||
|
return end == -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Reads new input data into the buffer. Call only with pos == end or end == -1,
|
||||||
|
* depending on the desired outcome if the function throws.
|
||||||
|
*/
|
||||||
|
private void fillBuf() throws IOException {
|
||||||
|
int result = in.read(buf, 0, buf.length);
|
||||||
|
if (result == -1) {
|
||||||
|
throw new EOFException();
|
||||||
|
}
|
||||||
|
pos = 0;
|
||||||
|
end = result;
|
||||||
|
}
|
||||||
|
}
|
||||||
57
src/main/java/mdnet/cache/Util.java
vendored
Normal file
57
src/main/java/mdnet/cache/Util.java
vendored
Normal file
|
|
@ -0,0 +1,57 @@
|
||||||
|
/*
|
||||||
|
* Copyright (C) 2010 The Android Open Source Project
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package mdnet.cache;
|
||||||
|
|
||||||
|
import java.io.Closeable;
|
||||||
|
import java.io.File;
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
/** Junk drawer of utility methods. */
|
||||||
|
final class Util {
|
||||||
|
private Util() {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Deletes the contents of {@code dir}. Throws an IOException if any file could
|
||||||
|
* not be deleted, or if {@code dir} is not a readable directory.
|
||||||
|
*/
|
||||||
|
static void deleteContents(File dir) throws IOException {
|
||||||
|
File[] files = dir.listFiles();
|
||||||
|
if (files == null) {
|
||||||
|
throw new IOException("not a readable directory: " + dir);
|
||||||
|
}
|
||||||
|
for (File file : files) {
|
||||||
|
if (file.isDirectory()) {
|
||||||
|
deleteContents(file);
|
||||||
|
}
|
||||||
|
if (!file.delete()) {
|
||||||
|
throw new IOException("failed to delete file: " + file);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static void closeQuietly(/* Auto */Closeable closeable) {
|
||||||
|
if (closeable != null) {
|
||||||
|
try {
|
||||||
|
closeable.close();
|
||||||
|
} catch (RuntimeException rethrown) {
|
||||||
|
throw rethrown;
|
||||||
|
} catch (Exception ignored) {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
184
src/main/kotlin/mdnet/base/Application.kt
Normal file
184
src/main/kotlin/mdnet/base/Application.kt
Normal file
|
|
@ -0,0 +1,184 @@
|
||||||
|
/* ktlint-disable no-wildcard-imports */
|
||||||
|
package mdnet.base
|
||||||
|
|
||||||
|
import mdnet.cache.DiskLruCache
|
||||||
|
import org.apache.http.client.config.CookieSpecs
|
||||||
|
import org.apache.http.client.config.RequestConfig
|
||||||
|
import org.apache.http.impl.client.HttpClients
|
||||||
|
import org.http4k.client.ApacheClient
|
||||||
|
import org.http4k.core.BodyMode
|
||||||
|
import org.http4k.core.Filter
|
||||||
|
import org.http4k.core.HttpHandler
|
||||||
|
import org.http4k.core.Method
|
||||||
|
import org.http4k.core.Request
|
||||||
|
import org.http4k.core.Response
|
||||||
|
import org.http4k.core.Status
|
||||||
|
import org.http4k.core.then
|
||||||
|
import org.http4k.filter.MaxAgeTtl
|
||||||
|
import org.http4k.filter.ServerFilters
|
||||||
|
import org.http4k.lens.Path
|
||||||
|
import org.http4k.routing.bind
|
||||||
|
import org.http4k.routing.routes
|
||||||
|
import org.http4k.server.Http4kServer
|
||||||
|
import org.http4k.server.asServer
|
||||||
|
import org.slf4j.LoggerFactory
|
||||||
|
import java.io.InputStream
|
||||||
|
import java.security.MessageDigest
|
||||||
|
import java.time.ZoneOffset
|
||||||
|
import java.time.ZonedDateTime
|
||||||
|
import java.time.format.DateTimeFormatter
|
||||||
|
import java.util.*
|
||||||
|
import java.util.concurrent.Executors
|
||||||
|
import java.util.concurrent.atomic.AtomicReference
|
||||||
|
import javax.crypto.Cipher
|
||||||
|
import javax.crypto.CipherInputStream
|
||||||
|
import javax.crypto.CipherOutputStream
|
||||||
|
import javax.crypto.spec.SecretKeySpec
|
||||||
|
|
||||||
|
private val LOGGER = LoggerFactory.getLogger("Application")
|
||||||
|
|
||||||
|
fun getServer(cache: DiskLruCache, serverSettings: ServerSettings, clientSettings: ClientSettings, statistics: AtomicReference<Statistics>): Http4kServer {
|
||||||
|
val executor = Executors.newCachedThreadPool()
|
||||||
|
|
||||||
|
val client = ApacheClient(responseBodyMode = BodyMode.Stream, client = HttpClients.custom()
|
||||||
|
.setDefaultRequestConfig(RequestConfig.custom()
|
||||||
|
.setCookieSpec(CookieSpecs.IGNORE_COOKIES)
|
||||||
|
.build())
|
||||||
|
.build())
|
||||||
|
|
||||||
|
val app = { request: Request ->
|
||||||
|
|
||||||
|
val chapterHash = Path.of("chapterHash")(request)
|
||||||
|
val fileName = Path.of("fileName")(request)
|
||||||
|
val cacheId = md5String("$chapterHash.$fileName")
|
||||||
|
|
||||||
|
statistics.get().requestsServed.incrementAndGet()
|
||||||
|
|
||||||
|
// Netty doesn't do Content-Length or Content-Type, so we have the pleasure of doing that ourselves
|
||||||
|
fun respond(input: InputStream, length: String, type: String): Response =
|
||||||
|
Response(Status.OK).header("Content-Length", length)
|
||||||
|
.header("Content-Type", type)
|
||||||
|
.header("X-Content-Type-Options", "nosniff")
|
||||||
|
.body(input, length.toLong())
|
||||||
|
|
||||||
|
val snapshot = cache.get(cacheId)
|
||||||
|
if (snapshot != null) {
|
||||||
|
statistics.get().cacheHits.incrementAndGet()
|
||||||
|
if (LOGGER.isTraceEnabled) {
|
||||||
|
LOGGER.trace("Request for $chapterHash/$fileName hit cache")
|
||||||
|
}
|
||||||
|
|
||||||
|
respond(CipherInputStream(snapshot.getInputStream(0), getRc4(cacheId)),
|
||||||
|
snapshot.getLength(0).toString(), snapshot.getString(1))
|
||||||
|
} else {
|
||||||
|
statistics.get().cacheMisses.incrementAndGet()
|
||||||
|
if (LOGGER.isTraceEnabled) {
|
||||||
|
LOGGER.trace("Request for $chapterHash/$fileName missed cache")
|
||||||
|
}
|
||||||
|
val mdResponse = client(Request(Method.GET, "${serverSettings.imageServer}${request.uri}"))
|
||||||
|
|
||||||
|
if (mdResponse.status != Status.OK) {
|
||||||
|
if (LOGGER.isTraceEnabled) {
|
||||||
|
LOGGER.trace("Request for $chapterHash/$fileName errored with status {}", mdResponse.status)
|
||||||
|
}
|
||||||
|
mdResponse.close()
|
||||||
|
Response(mdResponse.status)
|
||||||
|
} else {
|
||||||
|
val contentLength = mdResponse.header("Content-Length")!!
|
||||||
|
val contentType = mdResponse.header("Content-Type")!!
|
||||||
|
|
||||||
|
val editor = cache.edit(cacheId)
|
||||||
|
|
||||||
|
// A null editor means that this file is being written to
|
||||||
|
// concurrently so we skip the cache process
|
||||||
|
if (editor != null) {
|
||||||
|
if (LOGGER.isTraceEnabled) {
|
||||||
|
LOGGER.trace("Request for $chapterHash/$fileName is being cached and served")
|
||||||
|
}
|
||||||
|
editor.setString(1, contentType)
|
||||||
|
|
||||||
|
val tee = CachingInputStream(mdResponse.body.stream,
|
||||||
|
executor, CipherOutputStream(editor.newOutputStream(0), getRc4(cacheId))) {
|
||||||
|
// Note: if neither of the options get called/are in the log
|
||||||
|
// check that tee gets closed and for exceptions in this lambda
|
||||||
|
if (editor.getLength(0) == contentLength.toLong()) {
|
||||||
|
if (LOGGER.isTraceEnabled) {
|
||||||
|
LOGGER.trace("Cache download $chapterHash/$fileName committed")
|
||||||
|
}
|
||||||
|
|
||||||
|
editor.commit()
|
||||||
|
} else {
|
||||||
|
if (LOGGER.isTraceEnabled) {
|
||||||
|
LOGGER.trace("Cache download $chapterHash/$fileName aborted")
|
||||||
|
}
|
||||||
|
|
||||||
|
editor.abort()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
respond(tee, contentLength, contentType)
|
||||||
|
} else {
|
||||||
|
if (LOGGER.isTraceEnabled) {
|
||||||
|
LOGGER.trace("Request for $chapterHash/$fileName is being served")
|
||||||
|
}
|
||||||
|
|
||||||
|
respond(mdResponse.body.stream, contentLength, contentType)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return catchAllHideDetails()
|
||||||
|
.then(ServerFilters.CatchLensFailure)
|
||||||
|
.then(addCommonHeaders())
|
||||||
|
.then(
|
||||||
|
routes(
|
||||||
|
"/data/{chapterHash}/{fileName}" bind Method.GET to app
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.asServer(Netty(serverSettings.tls, clientSettings, statistics))
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun getRc4(key: String): Cipher {
|
||||||
|
val rc4 = Cipher.getInstance("RC4")
|
||||||
|
rc4.init(Cipher.ENCRYPT_MODE, SecretKeySpec(key.toByteArray(), "RC4"))
|
||||||
|
return rc4
|
||||||
|
}
|
||||||
|
|
||||||
|
private val HTTP_TIME_FORMATTER = DateTimeFormatter.ofPattern("EEE, dd MMM yyyy HH:mm:ss O", Locale.ENGLISH)
|
||||||
|
|
||||||
|
private fun addCommonHeaders(): Filter {
|
||||||
|
return Filter { next: HttpHandler ->
|
||||||
|
{ request: Request ->
|
||||||
|
val now = ZonedDateTime.now(ZoneOffset.UTC)
|
||||||
|
val response = next(request)
|
||||||
|
response.header("Date", HTTP_TIME_FORMATTER.format(now))
|
||||||
|
.header("Server", "Mangadex@Home Node")
|
||||||
|
.header("Cache-Control", listOf("public", MaxAgeTtl(Constants.MAX_AGE_CACHE).toHeaderValue()).joinToString(", "))
|
||||||
|
.header("Expires", HTTP_TIME_FORMATTER.format(now.plusSeconds(Constants.MAX_AGE_CACHE.seconds)))
|
||||||
|
.header("Cache-Control", "public, max-age=604800") // 1 week browser cache
|
||||||
|
.header("Timing-Allow-Origin", "https://mangadex.org")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun catchAllHideDetails(): Filter {
|
||||||
|
return Filter { next: HttpHandler ->
|
||||||
|
{ request: Request ->
|
||||||
|
try {
|
||||||
|
next(request)
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Response(Status.INTERNAL_SERVER_ERROR)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun md5String(stringToHash: String): String {
|
||||||
|
val digest = MessageDigest.getInstance("MD5")
|
||||||
|
|
||||||
|
val sb = StringBuilder()
|
||||||
|
for (b in digest.digest(stringToHash.toByteArray())) {
|
||||||
|
sb.append(String.format("%02x", b))
|
||||||
|
}
|
||||||
|
return sb.toString()
|
||||||
|
}
|
||||||
145
src/main/kotlin/mdnet/base/Keys.kt
Normal file
145
src/main/kotlin/mdnet/base/Keys.kt
Normal file
|
|
@ -0,0 +1,145 @@
|
||||||
|
//The code below is adapted from from https://github.com/Mastercard/client-encryption-java/blob/master/src/main/java/com/mastercard/developer/utils/EncryptionUtils.java
|
||||||
|
//
|
||||||
|
//Copyright (c) 2019 Mastercard
|
||||||
|
//
|
||||||
|
//Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
//of this software and associated documentation files (the "Software"), to deal
|
||||||
|
//in the Software without restriction, including without limitation the rights
|
||||||
|
//to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
//copies of the Software, and to permit persons to whom the Software is
|
||||||
|
//furnished to do so, subject to the following conditions:
|
||||||
|
//
|
||||||
|
//The above copyright notice and this permission notice shall be included in all
|
||||||
|
//copies or substantial portions of the Software.
|
||||||
|
//
|
||||||
|
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
//SOFTWARE.
|
||||||
|
package mdnet.base
|
||||||
|
|
||||||
|
import java.io.ByteArrayInputStream
|
||||||
|
import java.io.ByteArrayOutputStream
|
||||||
|
import java.io.InputStream
|
||||||
|
import java.security.KeyFactory
|
||||||
|
import java.security.PrivateKey
|
||||||
|
import java.security.cert.CertificateFactory
|
||||||
|
import java.security.cert.X509Certificate
|
||||||
|
import java.security.spec.InvalidKeySpecException
|
||||||
|
import java.security.spec.PKCS8EncodedKeySpec
|
||||||
|
|
||||||
|
private const val PKCS_1_PEM_HEADER = "-----BEGIN RSA PRIVATE KEY-----"
|
||||||
|
private const val PKCS_1_PEM_FOOTER = "-----END RSA PRIVATE KEY-----"
|
||||||
|
private const val PKCS_8_PEM_HEADER = "-----BEGIN PRIVATE KEY-----"
|
||||||
|
private const val PKCS_8_PEM_FOOTER = "-----END PRIVATE KEY-----"
|
||||||
|
|
||||||
|
fun getX509Cert(certificate: String): X509Certificate {
|
||||||
|
val targetStream: InputStream = ByteArrayInputStream(certificate.toByteArray())
|
||||||
|
return CertificateFactory.getInstance("X509").generateCertificate(targetStream) as X509Certificate
|
||||||
|
}
|
||||||
|
|
||||||
|
fun getPrivateKey(privateKey: String): PrivateKey {
|
||||||
|
return loadKey(privateKey)!!
|
||||||
|
}
|
||||||
|
|
||||||
|
fun loadKey(keyDataString: String): PrivateKey? {
|
||||||
|
if (keyDataString.contains(PKCS_1_PEM_HEADER)) {
|
||||||
|
// OpenSSL / PKCS#1 Base64 PEM encoded file
|
||||||
|
val fixedString = keyDataString.replace(PKCS_1_PEM_HEADER, "").replace(PKCS_1_PEM_FOOTER, "")
|
||||||
|
return readPkcs1PrivateKey(base64Decode(fixedString))
|
||||||
|
}
|
||||||
|
if (keyDataString.contains(PKCS_8_PEM_HEADER)) {
|
||||||
|
// PKCS#8 Base64 PEM encoded file
|
||||||
|
val fixedString = keyDataString.replace(PKCS_8_PEM_HEADER, "").replace(PKCS_8_PEM_FOOTER, "")
|
||||||
|
return readPkcs1PrivateKey(base64Decode(fixedString))
|
||||||
|
}
|
||||||
|
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun readPkcs8PrivateKey(pkcs8Bytes: ByteArray): PrivateKey? {
|
||||||
|
val keyFactory = KeyFactory.getInstance("RSA", "SunRsaSign")
|
||||||
|
val keySpec = PKCS8EncodedKeySpec(pkcs8Bytes)
|
||||||
|
return try {
|
||||||
|
keyFactory.generatePrivate(keySpec)
|
||||||
|
} catch (e: InvalidKeySpecException) {
|
||||||
|
throw IllegalArgumentException("Unexpected key format!", e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun readPkcs1PrivateKey(pkcs1Bytes: ByteArray): PrivateKey? {
|
||||||
|
// We can't use Java internal APIs to parse ASN.1 structures, so we build a PKCS#8 key Java can understand
|
||||||
|
val pkcs1Length = pkcs1Bytes.size
|
||||||
|
val totalLength = pkcs1Length + 22
|
||||||
|
val pkcs8Header = byteArrayOf(
|
||||||
|
0x30, 0x82.toByte(), (totalLength shr 8 and 0xff).toByte(), (totalLength and 0xff).toByte(), // Sequence + total length
|
||||||
|
0x2, 0x1, 0x0, // Integer (0)
|
||||||
|
0x30, 0xD, 0x6, 0x9, 0x2A, 0x86.toByte(), 0x48, 0x86.toByte(), 0xF7.toByte(), 0xD, 0x1, 0x1, 0x1, 0x5, 0x0, // Sequence: 1.2.840.113549.1.1.1, NULL
|
||||||
|
0x4, 0x82.toByte(), (pkcs1Length shr 8 and 0xff).toByte(), (pkcs1Length and 0xff).toByte() // Octet string + length
|
||||||
|
)
|
||||||
|
val pkcs8bytes = join(pkcs8Header, pkcs1Bytes)
|
||||||
|
return readPkcs8PrivateKey(pkcs8bytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun join(byteArray1: ByteArray, byteArray2: ByteArray): ByteArray {
|
||||||
|
val bytes = ByteArray(byteArray1.size + byteArray2.size)
|
||||||
|
System.arraycopy(byteArray1, 0, bytes, 0, byteArray1.size)
|
||||||
|
System.arraycopy(byteArray2, 0, bytes, byteArray1.size, byteArray2.size)
|
||||||
|
return bytes
|
||||||
|
}
|
||||||
|
|
||||||
|
private val b64ints = intArrayOf(
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63, 52, 53, 54,
|
||||||
|
55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1, -1, 0, 1, 2,
|
||||||
|
3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19,
|
||||||
|
20, 21, 22, 23, 24, 25, -1, -1, -1, -1, -1, -1, 26, 27, 28, 29, 30,
|
||||||
|
31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47,
|
||||||
|
48, 49, 50, 51, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||||
|
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1)
|
||||||
|
|
||||||
|
private fun base64Decode(value: String): ByteArray {
|
||||||
|
val valueBytes = value.toByteArray()
|
||||||
|
val outputStream = ByteArrayOutputStream()
|
||||||
|
var i = 0
|
||||||
|
while (i < valueBytes.size) {
|
||||||
|
var b: Int
|
||||||
|
b = if (b64ints[valueBytes[i].toInt()] != -1) {
|
||||||
|
b64ints[valueBytes[i].toInt()] and 0xFF shl 18
|
||||||
|
} else {
|
||||||
|
i++
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
var num = 0
|
||||||
|
if (i + 1 < valueBytes.size && b64ints[valueBytes[i + 1].toInt()] != -1) {
|
||||||
|
b = b or (b64ints[valueBytes[i + 1].toInt()] and 0xFF shl 12)
|
||||||
|
num++
|
||||||
|
}
|
||||||
|
if (i + 2 < valueBytes.size && b64ints[valueBytes[i + 2].toInt()] != -1) {
|
||||||
|
b = b or (b64ints[valueBytes[i + 2].toInt()] and 0xFF shl 6)
|
||||||
|
num++
|
||||||
|
}
|
||||||
|
if (i + 3 < valueBytes.size && b64ints[valueBytes[i + 3].toInt()] != -1) {
|
||||||
|
b = b or (b64ints[valueBytes[i + 3].toInt()] and 0xFF)
|
||||||
|
num++
|
||||||
|
}
|
||||||
|
while (num > 0) {
|
||||||
|
val c = b and 0xFF0000 shr 16
|
||||||
|
outputStream.write(c)
|
||||||
|
b = b shl 8
|
||||||
|
num--
|
||||||
|
}
|
||||||
|
i += 4
|
||||||
|
}
|
||||||
|
return outputStream.toByteArray()
|
||||||
|
}
|
||||||
126
src/main/kotlin/mdnet/base/Netty.kt
Normal file
126
src/main/kotlin/mdnet/base/Netty.kt
Normal file
|
|
@ -0,0 +1,126 @@
|
||||||
|
package mdnet.base
|
||||||
|
|
||||||
|
import io.netty.bootstrap.ServerBootstrap
|
||||||
|
import io.netty.buffer.Unpooled
|
||||||
|
import io.netty.channel.ChannelFactory
|
||||||
|
import io.netty.channel.ChannelFuture
|
||||||
|
import io.netty.channel.ChannelHandler.Sharable
|
||||||
|
import io.netty.channel.ChannelHandlerContext
|
||||||
|
import io.netty.channel.ChannelInboundHandlerAdapter
|
||||||
|
import io.netty.channel.ChannelInitializer
|
||||||
|
import io.netty.channel.ChannelOption
|
||||||
|
import io.netty.channel.ServerChannel
|
||||||
|
import io.netty.channel.nio.NioEventLoopGroup
|
||||||
|
import io.netty.channel.socket.SocketChannel
|
||||||
|
import io.netty.channel.socket.nio.NioServerSocketChannel
|
||||||
|
import io.netty.handler.codec.http.DefaultFullHttpResponse
|
||||||
|
import io.netty.handler.codec.http.HttpHeaderNames
|
||||||
|
import io.netty.handler.codec.http.HttpObjectAggregator
|
||||||
|
import io.netty.handler.codec.http.HttpResponseStatus
|
||||||
|
import io.netty.handler.codec.http.HttpServerCodec
|
||||||
|
import io.netty.handler.codec.http.HttpUtil
|
||||||
|
import io.netty.handler.codec.http.HttpVersion
|
||||||
|
import io.netty.handler.ssl.OptionalSslHandler
|
||||||
|
import io.netty.handler.ssl.SslContextBuilder
|
||||||
|
import io.netty.handler.ssl.SslHandler
|
||||||
|
import io.netty.handler.stream.ChunkedWriteHandler
|
||||||
|
import io.netty.handler.traffic.GlobalTrafficShapingHandler
|
||||||
|
import io.netty.handler.traffic.TrafficCounter
|
||||||
|
import org.http4k.core.HttpHandler
|
||||||
|
import org.http4k.server.Http4kChannelHandler
|
||||||
|
import org.http4k.server.Http4kServer
|
||||||
|
import org.http4k.server.ServerConfig
|
||||||
|
import java.net.InetSocketAddress
|
||||||
|
import java.nio.charset.StandardCharsets
|
||||||
|
import java.util.concurrent.TimeUnit
|
||||||
|
import java.util.concurrent.atomic.AtomicInteger
|
||||||
|
import java.util.concurrent.atomic.AtomicReference
|
||||||
|
|
||||||
|
@Sharable
|
||||||
|
class ConnectionCounter : ChannelInboundHandlerAdapter() {
|
||||||
|
private val connections = AtomicInteger()
|
||||||
|
|
||||||
|
override fun channelActive(ctx: ChannelHandlerContext) {
|
||||||
|
val sslHandler = ctx.pipeline()[SslHandler::class.java]
|
||||||
|
|
||||||
|
if (sslHandler != null) {
|
||||||
|
sslHandler.handshakeFuture().addListener {
|
||||||
|
handleConnection(ctx)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
handleConnection(ctx)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun handleConnection(ctx: ChannelHandlerContext) {
|
||||||
|
if (connections.incrementAndGet() <= Constants.MAX_CONCURRENT_CONNECTIONS) {
|
||||||
|
super.channelActive(ctx)
|
||||||
|
} else {
|
||||||
|
val response = Unpooled.copiedBuffer(Constants.OVERLOADED_MESSAGE, StandardCharsets.UTF_8)
|
||||||
|
val res =
|
||||||
|
DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.SERVICE_UNAVAILABLE, response)
|
||||||
|
res.headers().set(HttpHeaderNames.CONTENT_TYPE, "text/html; charset=UTF-8")
|
||||||
|
HttpUtil.setContentLength(res, response.readableBytes().toLong())
|
||||||
|
|
||||||
|
ctx.writeAndFlush(res)
|
||||||
|
ctx.close()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun channelInactive(ctx: ChannelHandlerContext) {
|
||||||
|
super.channelInactive(ctx)
|
||||||
|
connections.decrementAndGet()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class Netty(private val tls: ServerSettings.TlsCert, private val clientSettings: ClientSettings, private val stats: AtomicReference<Statistics>) : ServerConfig {
|
||||||
|
override fun toServer(httpHandler: HttpHandler): Http4kServer = object : Http4kServer {
|
||||||
|
private val masterGroup = NioEventLoopGroup()
|
||||||
|
private val workerGroup = NioEventLoopGroup()
|
||||||
|
private lateinit var closeFuture: ChannelFuture
|
||||||
|
private lateinit var address: InetSocketAddress
|
||||||
|
|
||||||
|
private val counter = ConnectionCounter()
|
||||||
|
private val burstLimiter = object : GlobalTrafficShapingHandler(
|
||||||
|
workerGroup, 1024 * clientSettings.maxBurstRateKibPerSecond, 0, 50) {
|
||||||
|
override fun doAccounting(counter: TrafficCounter) {
|
||||||
|
stats.get().bytesSent.getAndAdd(counter.cumulativeWrittenBytes())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun start(): Http4kServer = apply {
|
||||||
|
val sslContext = SslContextBuilder.forServer(getPrivateKey(tls.privateKey), getX509Cert(tls.certificate)).build()
|
||||||
|
|
||||||
|
val bootstrap = ServerBootstrap()
|
||||||
|
bootstrap.group(masterGroup, workerGroup)
|
||||||
|
.channelFactory(ChannelFactory<ServerChannel> { NioServerSocketChannel() })
|
||||||
|
.childHandler(object : ChannelInitializer<SocketChannel>() {
|
||||||
|
public override fun initChannel(ch: SocketChannel) {
|
||||||
|
|
||||||
|
ch.pipeline().addLast("ssl", OptionalSslHandler(sslContext))
|
||||||
|
|
||||||
|
ch.pipeline().addLast("codec", HttpServerCodec())
|
||||||
|
ch.pipeline().addLast("counter", counter)
|
||||||
|
ch.pipeline().addLast("aggregator", HttpObjectAggregator(65536))
|
||||||
|
ch.pipeline().addLast("burstLimiter", burstLimiter)
|
||||||
|
ch.pipeline().addLast("streamer", ChunkedWriteHandler())
|
||||||
|
ch.pipeline().addLast("handler", Http4kChannelHandler(httpHandler))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.option(ChannelOption.SO_BACKLOG, 1000)
|
||||||
|
.childOption(ChannelOption.SO_KEEPALIVE, true)
|
||||||
|
|
||||||
|
val channel = bootstrap.bind(clientSettings.clientPort).sync().channel()
|
||||||
|
address = channel.localAddress() as InetSocketAddress
|
||||||
|
closeFuture = channel.closeFuture()
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun stop() = apply {
|
||||||
|
masterGroup.shutdownGracefully(5, 15, TimeUnit.SECONDS).sync()
|
||||||
|
workerGroup.shutdownGracefully(5, 15, TimeUnit.SECONDS).sync()
|
||||||
|
closeFuture.sync()
|
||||||
|
}
|
||||||
|
|
||||||
|
override fun port(): Int = if (clientSettings.clientPort > 0) clientSettings.clientPort else address.port
|
||||||
|
}
|
||||||
|
}
|
||||||
31
src/main/resources/logback.xml
Normal file
31
src/main/resources/logback.xml
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
<configuration>
|
||||||
|
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
|
||||||
|
<file>log/latest.log</file>
|
||||||
|
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
|
||||||
|
<fileNamePattern>log/logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
|
||||||
|
<maxHistory>14</maxHistory>
|
||||||
|
<totalSizeCap>5MB</totalSizeCap>
|
||||||
|
</rollingPolicy>
|
||||||
|
|
||||||
|
<encoder>
|
||||||
|
<pattern>%d{YYYY-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
|
||||||
|
</encoder>
|
||||||
|
</appender>
|
||||||
|
|
||||||
|
<appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
|
||||||
|
<appender-ref ref="FILE" />
|
||||||
|
</appender>
|
||||||
|
|
||||||
|
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
|
||||||
|
<encoder>
|
||||||
|
<pattern>%d{YYYY-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
|
||||||
|
</encoder>
|
||||||
|
</appender>
|
||||||
|
|
||||||
|
<root level="TRACE">
|
||||||
|
<appender-ref ref="STDOUT"/>
|
||||||
|
<appender-ref ref="ASYNC"/>
|
||||||
|
</root>
|
||||||
|
|
||||||
|
<logger name="io.netty" level="INFO"/>
|
||||||
|
</configuration>
|
||||||
Loading…
Reference in a new issue