Compare commits
10 Commits
e7c71570c7
...
0a8611065b
Author | SHA1 | Date | |
---|---|---|---|
|
0a8611065b | ||
|
dad86bc0f2 | ||
|
f18aec4ff5 | ||
|
068c8462d7 | ||
|
365b7a910a | ||
|
3827d5fa22 | ||
|
958ac80727 | ||
|
e2256271ad | ||
|
96c716d74b | ||
|
a9141fa394 |
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>.
|
22
Makefile
Normal file
22
Makefile
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
CFLAGS= -Ofast -I"include"
|
||||||
|
BIN=cts
|
||||||
|
|
||||||
|
all: main
|
||||||
|
|
||||||
|
main: main.o
|
||||||
|
gcc colors.o dbquery.o main.o -lsqlite3 -o $(BIN)
|
||||||
|
|
||||||
|
main.o: dbquery.o src/main.c
|
||||||
|
gcc -c src/main.c $(CFLAGS)
|
||||||
|
|
||||||
|
dbquery.o: colors.o src/dbquery.c
|
||||||
|
gcc -c src/dbquery.c $(CFLAGS)
|
||||||
|
|
||||||
|
colors.o: src/colors.c
|
||||||
|
gcc -c src/colors.c $(CFLAGS)
|
||||||
|
|
||||||
|
testcolor: src/colors.c src/tcolor.c
|
||||||
|
gcc src/colors.c src/tcolor.c -o tcolor -I"includes" -g
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm *.o *.log $(BIN)
|
32
README.md
Normal file
32
README.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
C CGI Xonotic DeFrag
|
||||||
|
-----------------
|
||||||
|
A CGI program written in C to display data related to Race CTS leaderboards of Xonotic servers.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
* SQLite3
|
||||||
|
|
||||||
|
## Web Server Queries
|
||||||
|
* `(none)`
|
||||||
|
- Query file: `queries/mranks.sql`
|
||||||
|
- Requests the maplist of the server and related data.
|
||||||
|
|
||||||
|
* `?map=[map name]`
|
||||||
|
- Query file: `queries/mleaderboard-ojoin.sql`
|
||||||
|
- Requests the leaderboard of the map.
|
||||||
|
|
||||||
|
* `?player=[clientid]`
|
||||||
|
- Query file: `queries/rplayers.sql`
|
||||||
|
- Requests a player's ranks for all maps leaderboards s/he is present on.
|
||||||
|
|
||||||
|
## Game Versions Used Under:
|
||||||
|
* Xonotic 0.8.1
|
||||||
|
* Xonotic 0.8.2
|
||||||
|
|
||||||
|
## Compilers
|
||||||
|
* MinGW, GCC 4.7.1
|
||||||
|
|
||||||
|
__________________
|
||||||
|
|
||||||
|
This program uses an sqlite3 database file created from `~/.xonotic/data/data/server.db`.
|
||||||
|
|
||||||
|
The database may be built using [xonotic-py-sqlite3-defrag2db](https://git.teknik.io/antares/xonotic-py-sqlite3-defrag2db).
|
176
doc/doc-colors.txt
Normal file
176
doc/doc-colors.txt
Normal file
@ -0,0 +1,176 @@
|
|||||||
|
|
||||||
|
colors.c / colors.h
|
||||||
|
|
||||||
|
To convert in-game player name colors to html display.
|
||||||
|
|
||||||
|
References used:
|
||||||
|
http://www.rapidtables.com/convert/color/hsl-to-rgb.htm
|
||||||
|
http://www.rapidtables.com/convert/color/rgb-to-hsl.htm
|
||||||
|
https://gitlab.com/xonotic/xonstat/blob/master/xonstat/util.py
|
||||||
|
|
||||||
|
Overview:
|
||||||
|
|
||||||
|
This component is slightly based on util.py of XonStats, but the only
|
||||||
|
functionality needed is coloring the player's names. Since C programming
|
||||||
|
language does not have standard libraries for color model conversions and
|
||||||
|
regex, some functionality had to be self written. The function of interest
|
||||||
|
is:
|
||||||
|
def html_colors(qstr='', limit=None):
|
||||||
|
|
||||||
|
This component uses purely C standard library.
|
||||||
|
|
||||||
|
Advanced string manipulations such as replace and concatenation are
|
||||||
|
avoided. Instead, strings are printed in parts across functions.
|
||||||
|
|
||||||
|
There is only one instance of dynamic memory allocation.
|
||||||
|
void print_plname(const char *)
|
||||||
|
It both allocates, near the start, and frees memory at the end.
|
||||||
|
|
||||||
|
darkplaces Player Names & Colors
|
||||||
|
Players can add color themes to their names. They're expressed either
|
||||||
|
decimal or hexidecimal.
|
||||||
|
|
||||||
|
The decimal format follows
|
||||||
|
A character '^' that is not displayed, followed by a single digit
|
||||||
|
between 0 and 9.
|
||||||
|
The hexidecimal format follows
|
||||||
|
A string '^x' that is not displayed, followed by 3 digits between
|
||||||
|
0 - 0xF.
|
||||||
|
|
||||||
|
Python Regex to C Translation
|
||||||
|
|
||||||
|
The snippets from the original python code:
|
||||||
|
|
||||||
|
_all_colors = re.compile(r'\^(\d|x[\dA-Fa-f]{3})')
|
||||||
|
_dec_colors = re.compile(r'\^(\d)')
|
||||||
|
_hex_colors = re.compile(r'\^x([\dA-Fa-f])([\dA-Fa-f])([\dA-Fa-f])')
|
||||||
|
|
||||||
|
_dec_spans = [
|
||||||
|
"<span style='color:rgb(128,128,128)'>",
|
||||||
|
"<span style='color:rgb(255,0,0)'>",
|
||||||
|
"<span style='color:rgb(51,255,0)'>",
|
||||||
|
"<span style='color:rgb(255,255,0)'>",
|
||||||
|
"<span style='color:rgb(51,102,255)'>",
|
||||||
|
"<span style='color:rgb(51,255,255)'>",
|
||||||
|
"<span style='color:rgb(255,51,102)'>",
|
||||||
|
"<span style='color:rgb(255,255,255)'>",
|
||||||
|
"<span style='color:rgb(153,153,153)'>",
|
||||||
|
"<span style='color:rgb(128,128,128)'>"
|
||||||
|
]
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
def html_colors(qstr='', limit=None):
|
||||||
|
...
|
||||||
|
html = _dec_colors.sub(lambda match: _dec_spans[int(match.group(1))],
|
||||||
|
qstr)
|
||||||
|
html = _hex_colors.sub(hex_repl, html)
|
||||||
|
...
|
||||||
|
|
||||||
|
html = _dec_colors.sub(lambda match: _dec_spans[int(match.group(1))], qstr)
|
||||||
|
The character following a '^' is treated as an index to the array
|
||||||
|
'_dec_spans'. The corresponding element in '_dec_spans' replaces the
|
||||||
|
character '^' and the following digit in the string 'qstr'.
|
||||||
|
|
||||||
|
html = _hex_colors.sub(hex_repl, html)
|
||||||
|
The output of function 'hex_repl' replaces matching strings in html-
|
||||||
|
'^x' followed by 3 hexadecimal digits. The function 'hex_repl' has more
|
||||||
|
to do with the algorithms of color model conversions than it has to do
|
||||||
|
with regex rules.
|
||||||
|
|
||||||
|
The control flow to output similar results to the regex substitutions is
|
||||||
|
in the function
|
||||||
|
static void b(char * const str);
|
||||||
|
Unlike the python counterparts, it segments the player name into tokens and
|
||||||
|
prints strings also other strings instead of the sequences not intended to
|
||||||
|
be displayed.
|
||||||
|
|
||||||
|
Function Walkthrough
|
||||||
|
Sorted by caller to callee.
|
||||||
|
|
||||||
|
void print_plname(const char *)
|
||||||
|
const char * parameter is the player's name. It is used as a basis for
|
||||||
|
the variable 'copy'. 'copy' will always be the shorter character string.
|
||||||
|
|
||||||
|
This is function is intended to be used by the client file.
|
||||||
|
|
||||||
|
This function unconditionally allocates memory (calloc) and frees it at
|
||||||
|
the end.
|
||||||
|
|
||||||
|
By itself, it only removes extraneous instances of the character '^'.
|
||||||
|
It then calls the function
|
||||||
|
static void b(char * const)
|
||||||
|
where actual output occurs.
|
||||||
|
|
||||||
|
static void b(char * const)
|
||||||
|
const char * parameter is the player's name. The data pointed at by the
|
||||||
|
pointer is altered by function 'strtok', but the pointer itself is
|
||||||
|
never changed. Abstractly, fragments of the player's name are treated
|
||||||
|
as a command to print specific strings.
|
||||||
|
|
||||||
|
This function iterates once through the player's name. 'strtok'
|
||||||
|
segments the player's name; sequences between and not including '^'s
|
||||||
|
are treated as substrings. The first character of the substring is
|
||||||
|
checked for a digit inclusively between 0 and 9 for a decimal color
|
||||||
|
code. Exclusively or, checked for an 'x' and a numerical sequence
|
||||||
|
afterwards for a hexidecimal color code. If the substring does not have
|
||||||
|
either, it is printed like an ordinary string.
|
||||||
|
|
||||||
|
This function may not be adequate when a player's name intentionally
|
||||||
|
contains '^'.
|
||||||
|
|
||||||
|
static void hexspan(const char *)
|
||||||
|
const char * parameter is ideally a sequence of 3 hexidecimal digits.
|
||||||
|
Actually it is the entire substring from the callee. The first 3
|
||||||
|
elements are of interest as 3 separate single digit numerical values
|
||||||
|
and are explicitly separated to prevent function 'strtol' from
|
||||||
|
interpreting them as multidigit numbers. These 3 elements are rgb
|
||||||
|
values from the game engine.
|
||||||
|
Xonotic represents RGB values as a sequence of three digits 0 - 0xF.
|
||||||
|
Before conversion is to be done, they must be multiplied by 0xF so the
|
||||||
|
full range of values for RGB, 0 - 255 can be represented.
|
||||||
|
|
||||||
|
This function prints the an html span tag.
|
||||||
|
|
||||||
|
This function will first convert rgb to hsl to check if the colors are
|
||||||
|
too dark for the web page, and if so brighten up the colors then
|
||||||
|
reconvert to rgb.
|
||||||
|
|
||||||
|
static void decspan(const int)
|
||||||
|
const int parameter is a digit, the range being [0, 9].
|
||||||
|
|
||||||
|
This function is straightforward. It will print an html tag
|
||||||
|
corresponding to the const int parameter.
|
||||||
|
|
||||||
|
void hsl2rgb(struct Rgb *, const struct Hls const *)
|
||||||
|
First parameter, 'struct Rgb *' is the result of the conversion. It
|
||||||
|
does not need to be initialized.
|
||||||
|
Second parameter, 'const struct Hls const *' is the values and color
|
||||||
|
model to convert from and because, it must be initialized.
|
||||||
|
|
||||||
|
The math referenced from:
|
||||||
|
http://www.rapidtables.com/convert/color/hsl-to-rgb.htm
|
||||||
|
The implemenation deviates at the last 3 lines of code where the
|
||||||
|
results are finalized and placed in the output. The webpage does not
|
||||||
|
mention that rounding up is necessary. However it is, otherwise the
|
||||||
|
nonzero rgb values for the following colors
|
||||||
|
Silver (0°,0%,75%)
|
||||||
|
Gray (0°,0%,50%)
|
||||||
|
Maroon (0°,100%,25%)
|
||||||
|
Olive (60°,100%,25%)
|
||||||
|
Green (120°,100%,25%)
|
||||||
|
Purple (300°,100%,25%)
|
||||||
|
Teal (180°,100%,25%)
|
||||||
|
Navy (240°,100%,25%)
|
||||||
|
will be off by one.
|
||||||
|
|
||||||
|
void rgb2hsl(struct Hls *, const struct Rgb const *)
|
||||||
|
First parameter, 'struct Hls *' is the result of the conversion. It
|
||||||
|
does not need to be initialized.
|
||||||
|
Second parameter, 'const struct Rgb const *' is the values and color
|
||||||
|
model to convert from and because, it must be initialized.
|
||||||
|
|
||||||
|
The math referenced from:
|
||||||
|
http://www.rapidtables.com/convert/color/rgb-to-hsl.htm
|
||||||
|
The implementation deviates when calculating hue, when Cmax is R'.
|
||||||
|
Instead of modulo, there is a summation by 6 when G' is less than B'.
|
150
doc/doc-dbquery.txt
Normal file
150
doc/doc-dbquery.txt
Normal file
@ -0,0 +1,150 @@
|
|||||||
|
|
||||||
|
dbquery.c / dbquery.h
|
||||||
|
|
||||||
|
Retrieve information from the database & displays it.
|
||||||
|
|
||||||
|
Overview
|
||||||
|
|
||||||
|
This component uses colors.c / colors.h.
|
||||||
|
|
||||||
|
Every function that allocates memory also frees it.
|
||||||
|
|
||||||
|
Advanced string manipulation such as concatenation is avoided. Instead
|
||||||
|
strings are printed in parts.
|
||||||
|
|
||||||
|
Exo File Dependencies
|
||||||
|
|
||||||
|
SQL commands are stored in an outside file (.sql) and executed. The
|
||||||
|
functions in this file are largely adaptable until
|
||||||
|
void qresult(void * const, const char *);
|
||||||
|
which prints the results of the query. This is specific to the query. All
|
||||||
|
functions in this file could be considered non-modular because the
|
||||||
|
specialized functions like 'qresult' are eventually called by the more
|
||||||
|
adaptable functions. This may later be solved by calling function pointers
|
||||||
|
to display table data, but currently many of the tables are similar enough
|
||||||
|
that one function to print all tables suffices.
|
||||||
|
|
||||||
|
Adding or Removing New Queries
|
||||||
|
|
||||||
|
To add new queries the program may handle the following functions need to
|
||||||
|
be adjusted.
|
||||||
|
|
||||||
|
inline void print_tblheader(const char *);
|
||||||
|
|
||||||
|
inline char *get_filename(const char *) ;
|
||||||
|
|
||||||
|
void qresult(void * const, const char *);
|
||||||
|
|
||||||
|
The file name of the query file should be added to the switch statement of
|
||||||
|
function 'get_filename'. The starting html tags and labels should also be
|
||||||
|
added to the switch statement of function 'print_tblheader'. For both
|
||||||
|
forementioned functions, the switch statement operates on a variable 'c'
|
||||||
|
which represents the first character of the query string. Currently, the
|
||||||
|
case is that the different queries, '?map=' and '?player=', begin with
|
||||||
|
different letters.
|
||||||
|
|
||||||
|
The function 'qresult'- extra formatting and corresponding conditions
|
||||||
|
should be added to the series of if/else-if statements. 'qresult's most
|
||||||
|
applicable conditionals are player names and formatted times- if a new
|
||||||
|
query will involve those, the conditionals should be added.
|
||||||
|
|
||||||
|
Function Walkthrough
|
||||||
|
Sorted by caller to callee.
|
||||||
|
|
||||||
|
void getquery(char * const);
|
||||||
|
Parameter 'char * const' is the query string retrieved from the
|
||||||
|
environment. NULL is an acceptable parameter. Only the first character
|
||||||
|
of the string pointed at by the pointer will be changed.
|
||||||
|
|
||||||
|
A file name is then retrieved from 'get_filename', depending on the
|
||||||
|
first character of the query string. Then the contents of the query
|
||||||
|
file is read in to be later to query the database.
|
||||||
|
|
||||||
|
Currently, this function determines the size of the file by using
|
||||||
|
'fseek' and 'ftell'. Often recommended against however:
|
||||||
|
1. The files to open are restricted to a specific set.
|
||||||
|
2. The files are plain text files.
|
||||||
|
3. The file sizes, in bytes, are very unlikely to exceed the
|
||||||
|
maximum value representable by integers.
|
||||||
|
|
||||||
|
'ftell' returns a long int. It can determine the file size of a ~2 GB
|
||||||
|
file.
|
||||||
|
|
||||||
|
int executequery(const char *, const char *);
|
||||||
|
Parameter #1 is the string containing the query for the database. NULL
|
||||||
|
is not acceptable. If a null value is given, the program will output
|
||||||
|
the following string to stderr:
|
||||||
|
Could not prepare SQL statement: not an error
|
||||||
|
|
||||||
|
(null)
|
||||||
|
Parameter #2 is the query string. NULL is acceptable.
|
||||||
|
|
||||||
|
This function opens and closes the connection to the database. Also
|
||||||
|
prepares and finalizes the sql statement. However itself, it does not
|
||||||
|
actually query the database.
|
||||||
|
|
||||||
|
void qresult(void * const, const char *);
|
||||||
|
Parameter #1 is the prepared sql statement.
|
||||||
|
Parameter #2 is the first character of the query string- in use to
|
||||||
|
identify the query.
|
||||||
|
|
||||||
|
This function both executes the query and displays the data.
|
||||||
|
The for loop iterates for each field of the row returned.
|
||||||
|
|
||||||
|
Conditionals explained:
|
||||||
|
|
||||||
|
The fields are hardcoded from the sql query files.
|
||||||
|
|
||||||
|
mranks.sql - (*c = QOVERVIEW)
|
||||||
|
select mapid, max(trank), min(tvalue), alias
|
||||||
|
i = 0 1 2 3
|
||||||
|
|
||||||
|
rplayers.sql - (*c = QRPLAYER)
|
||||||
|
select alias, mapid, idrank
|
||||||
|
i = 0 1 2
|
||||||
|
|
||||||
|
mleaderboard.sql - (*c = QMLEADERBOARD)
|
||||||
|
select trank, alias, tvalue
|
||||||
|
i = 0 1 2
|
||||||
|
|
||||||
|
if ((*c == QMLEADERBOARD && i == 1)
|
||||||
|
|| (*c == QOVERVIEW && i == 3)
|
||||||
|
|| (*c == QRPLAYER && i == 0))
|
||||||
|
If the field is for map leaderboards and column 1, or the overview
|
||||||
|
and column 3, or player ranks and column 0, then it is a player
|
||||||
|
name; which should have the in-game color codes translated to html.
|
||||||
|
|
||||||
|
if ((i == 0 && *c == QOVERVIEW) || (i == 1 && *c == QRPLAYER))
|
||||||
|
If the field is for overview and column 0 or is player ranks column
|
||||||
|
1, then it is a map name, and it should have html tags linking it
|
||||||
|
to the map leaderboards.
|
||||||
|
|
||||||
|
if (i == 2 && (*c == QMLEADERBOARD || *c == QOVERVIEW))
|
||||||
|
If the field is column 2 of either the overview or the map
|
||||||
|
leaderboards, then it is a time which should be formatted as such.
|
||||||
|
|
||||||
|
If none of the conditionals are met, then the field is printed as usual.
|
||||||
|
|
||||||
|
void print_time(const unsigned char *);
|
||||||
|
Parameter 'const unsigned char *' is the string that represents a
|
||||||
|
number- quantity of centiseconds.
|
||||||
|
|
||||||
|
The time as a string is converted to a number by 'strtoul'. Thus, the
|
||||||
|
maximum value that is returned by 'strtoul' given a string is
|
||||||
|
21,474,836.47 seconds. This is by far, more than enough for a game mode
|
||||||
|
focused on the lowest possible times.
|
||||||
|
|
||||||
|
This function performs the conversion and prints the value.
|
||||||
|
|
||||||
|
inline void print_tblheader(const char *);
|
||||||
|
Parameter 'const char *' is a pointer to a string. However, only the
|
||||||
|
first character is of interest because C can not switch on strings.
|
||||||
|
|
||||||
|
This function prints the starting tag of the html table.
|
||||||
|
|
||||||
|
inline char *get_filename(const char *) ;
|
||||||
|
Parameter 'const char *' is a pointer to a string. However, only the
|
||||||
|
first character is of interest because C can not switch on strings.
|
||||||
|
|
||||||
|
This function returns the file name of a sql query file.
|
||||||
|
|
18
makefile
18
makefile
@ -1,18 +0,0 @@
|
|||||||
CFLAGS= -Ofast
|
|
||||||
|
|
||||||
all: cts tcolor
|
|
||||||
|
|
||||||
cts: main.o
|
|
||||||
gcc colors.o sqlite3.o dbquery.o main.o -o cts
|
|
||||||
|
|
||||||
main.o: dbquery.o main.c
|
|
||||||
gcc -c main.c -I"includes" $(CFLAGS)
|
|
||||||
|
|
||||||
dbquery.o: colors.o includes/dbquery.c
|
|
||||||
gcc -c includes/dbquery.c $(CFLAGS)
|
|
||||||
|
|
||||||
colors.o: includes/colors.c
|
|
||||||
gcc -c includes/colors.c $(CFLAGS)
|
|
||||||
|
|
||||||
tcolor: includes/colors.c tcolor.c
|
|
||||||
gcc includes/colors.c tcolor.c -o tcolor -I"includes" -g
|
|
@ -1,8 +0,0 @@
|
|||||||
select trank, idvalue, tvalue
|
|
||||||
from Cts_times, Cts_ranks
|
|
||||||
where trank = idrank and Cts_times.mapid = Cts_ranks.mapid and Cts_times.mapid = ?
|
|
||||||
order by trank
|
|
||||||
|
|
||||||
-- get full leaderboard of the map
|
|
||||||
-- aliases are not included because
|
|
||||||
-- not ever player has a registered alias.
|
|
@ -1,7 +0,0 @@
|
|||||||
select idrank, idvalue, alias
|
|
||||||
from Cts_ranks, Id2alias
|
|
||||||
where idvalue = cryptokey and mapid = ?
|
|
||||||
order by idrank
|
|
||||||
|
|
||||||
-- get registered/aliased players who have played on
|
|
||||||
-- the specified map.
|
|
@ -68,10 +68,10 @@ static inline void print_tblheader(const char *c) {
|
|||||||
// 21,474,836.47 seconds
|
// 21,474,836.47 seconds
|
||||||
// someone would need to idle in-game for 248 days
|
// someone would need to idle in-game for 248 days
|
||||||
static void print_time(const unsigned char *strcs) {
|
static void print_time(const unsigned char *strcs) {
|
||||||
const unsigned int num = strtoul((const char*)strcs, NULL, 10);
|
const unsigned long num = strtoul((const char*)strcs, NULL, 10);
|
||||||
unsigned int s = num/100;
|
unsigned long s = num/100;
|
||||||
const unsigned int cs = num % 100;
|
const unsigned long cs = num % 100;
|
||||||
const unsigned int min = s/60;
|
const unsigned long min = s/60;
|
||||||
s = s % 60;
|
s = s % 60;
|
||||||
if (min > 0) {
|
if (min > 0) {
|
||||||
printf("<TD>%u:%.2u.%.2u</TD>", min, s, cs);
|
printf("<TD>%u:%.2u.%.2u</TD>", min, s, cs);
|
182
src/tcolor.c
Normal file
182
src/tcolor.c
Normal file
@ -0,0 +1,182 @@
|
|||||||
|
#include "colors.h"
|
||||||
|
#include <stdio.h>
|
||||||
|
#include <math.h>
|
||||||
|
#include <stdbool.h>
|
||||||
|
|
||||||
|
#define RGB_BLACK 0,0,0
|
||||||
|
#define RGB_WHITE 255,255,255
|
||||||
|
#define RGB_RED 255,0,0
|
||||||
|
#define RGB_LIME 0,255,0
|
||||||
|
#define RGB_BLUE 0,0,255
|
||||||
|
#define RGB_YELLOW 255,255,0
|
||||||
|
#define RGB_CYAN 0,255,255
|
||||||
|
#define RGB_MAGENTA 255,0,255
|
||||||
|
#define RGB_SILVER 192,192,192
|
||||||
|
#define RGB_GREY 128,128,128
|
||||||
|
#define RGB_MAROON 128,0,0
|
||||||
|
#define RGB_OLIVE 128,128,0
|
||||||
|
#define RGB_GREEN 0,128,0
|
||||||
|
#define RGB_PURPLE 128,0,128
|
||||||
|
#define RGB_TEAL 0,128,128
|
||||||
|
#define RGB_NAVY 0,0,128
|
||||||
|
|
||||||
|
#define HSL_BLACK 0,0.0f,0.0f
|
||||||
|
#define HSL_WHITE 0,0.0f,1.0f
|
||||||
|
#define HSL_RED 0,1.0f,0.5f
|
||||||
|
#define HSL_LIME 120,1.0f,0.5f
|
||||||
|
#define HSL_BLUE 240,1.0f,0.5f
|
||||||
|
#define HSL_YELLOW 60,1.0f,0.5f
|
||||||
|
#define HSL_CYAN 180,1.0f,0.5f
|
||||||
|
#define HSL_MAGENTA 300,1.0f,0.5f
|
||||||
|
#define HSL_SILVER 0,0.0f,0.75f
|
||||||
|
#define HSL_GREY 0,0.0f,0.50f
|
||||||
|
#define HSL_MAROON 0,1.0f,0.25f
|
||||||
|
#define HSL_OLIVE 60,1.0f,0.25f
|
||||||
|
#define HSL_GREEN 120,1.0f,0.25f
|
||||||
|
#define HSL_PURPLE 300,1.0f,0.25f
|
||||||
|
#define HSL_TEAL 180,1.0f,0.25f
|
||||||
|
#define HSL_NAVY 240,1.0f,0.25f
|
||||||
|
|
||||||
|
#define ERROR_TOLERANCE 0.01
|
||||||
|
|
||||||
|
#define CLR4BIT 16
|
||||||
|
|
||||||
|
bool trgb2hsl(const int r, const int g, const int b,
|
||||||
|
const int h, const float s, const float l) {
|
||||||
|
bool result = true;
|
||||||
|
struct Rgb x;
|
||||||
|
x.r = r;
|
||||||
|
x.g = g;
|
||||||
|
x.b = b;
|
||||||
|
struct Hls y;
|
||||||
|
rgb2hsl(&y, &x);
|
||||||
|
if (y.h == h && fabs(y.s - s) <= ERROR_TOLERANCE && fabs(y.l - l) <= ERROR_TOLERANCE) {
|
||||||
|
// printf("COLOR CONVERSION OK!\n");
|
||||||
|
;
|
||||||
|
} else {
|
||||||
|
printf("COLOR CONVERSION UNACCEPTABLE\n\texpected: %d %0.2f %0.2f\n", h, s, l);
|
||||||
|
result = false;
|
||||||
|
}
|
||||||
|
printf("\t%d %0.2f %0.2f\n", y.h, y.s, y.l);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_rgb2hsl(bool * const r) {
|
||||||
|
r[0] = trgb2hsl(RGB_BLACK, HSL_BLACK);
|
||||||
|
r[1] = trgb2hsl(RGB_WHITE, HSL_WHITE);
|
||||||
|
r[2] = trgb2hsl(RGB_RED, HSL_RED);
|
||||||
|
r[3] = trgb2hsl(RGB_LIME, HSL_LIME);
|
||||||
|
r[4] = trgb2hsl(RGB_BLUE, HSL_BLUE);
|
||||||
|
r[5] = trgb2hsl(RGB_YELLOW, HSL_YELLOW);
|
||||||
|
r[6] = trgb2hsl(RGB_CYAN, HSL_CYAN);
|
||||||
|
r[7] = trgb2hsl(RGB_MAGENTA, HSL_MAGENTA);
|
||||||
|
r[8] = trgb2hsl(RGB_SILVER, HSL_SILVER);
|
||||||
|
r[9] = trgb2hsl(RGB_GREY, HSL_GREY);
|
||||||
|
r[10] = trgb2hsl(RGB_MAROON, HSL_MAROON);
|
||||||
|
r[11] = trgb2hsl(RGB_OLIVE, HSL_OLIVE);
|
||||||
|
r[12] = trgb2hsl(RGB_GREEN, HSL_GREEN);
|
||||||
|
r[13] = trgb2hsl(RGB_PURPLE, HSL_PURPLE);
|
||||||
|
r[14] = trgb2hsl(RGB_TEAL, HSL_TEAL);
|
||||||
|
r[15] = trgb2hsl(RGB_NAVY, HSL_NAVY);
|
||||||
|
}
|
||||||
|
|
||||||
|
bool thls2rgb(int h, float s, float l, int r, int g, int b) {
|
||||||
|
bool result = true;
|
||||||
|
struct Hls x;
|
||||||
|
x.h = h;
|
||||||
|
x.s = s;
|
||||||
|
x.l = l;
|
||||||
|
struct Rgb y;
|
||||||
|
hsl2rgb(&y, &x);
|
||||||
|
if (y.r == r && y.g == g && y.b == b) {
|
||||||
|
;
|
||||||
|
} else {
|
||||||
|
printf("COLOR CONVERSION INEXACT\n\texpected: %d %d %d\n", r, g, b);
|
||||||
|
result = false;
|
||||||
|
}
|
||||||
|
printf("%d %d %d\n", y.r, y.g, y.b);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
void test_hsl2rgb(bool * const r) {
|
||||||
|
r[0] = thls2rgb(HSL_BLACK, RGB_BLACK);
|
||||||
|
r[1] = thls2rgb(HSL_WHITE, RGB_WHITE);
|
||||||
|
r[2] = thls2rgb(HSL_RED, RGB_RED);
|
||||||
|
r[3] = thls2rgb(HSL_LIME, RGB_LIME);
|
||||||
|
r[4] = thls2rgb(HSL_BLUE, RGB_BLUE);
|
||||||
|
r[5] = thls2rgb(HSL_YELLOW, RGB_YELLOW);
|
||||||
|
r[6] = thls2rgb(HSL_CYAN, RGB_CYAN);
|
||||||
|
r[7] = thls2rgb(HSL_MAGENTA, RGB_MAGENTA);
|
||||||
|
r[8] = thls2rgb(HSL_SILVER, RGB_SILVER);
|
||||||
|
r[9] = thls2rgb(HSL_GREY, RGB_GREY);
|
||||||
|
r[10] = thls2rgb(HSL_MAROON, RGB_MAROON);
|
||||||
|
r[11] = thls2rgb(HSL_OLIVE, RGB_OLIVE);
|
||||||
|
r[12] = thls2rgb(HSL_GREEN, RGB_GREEN);
|
||||||
|
r[13] = thls2rgb(HSL_PURPLE, RGB_PURPLE);
|
||||||
|
r[14] = thls2rgb(HSL_TEAL, RGB_TEAL);
|
||||||
|
r[15] = thls2rgb(HSL_NAVY, RGB_NAVY);
|
||||||
|
}
|
||||||
|
|
||||||
|
void test4bitcolors(void (*f)(bool * const)) {
|
||||||
|
const char *colors[CLR4BIT] = {
|
||||||
|
"BLACK",
|
||||||
|
"WHITE",
|
||||||
|
"RED",
|
||||||
|
"LIME",
|
||||||
|
"BLUE",
|
||||||
|
"YELLOW",
|
||||||
|
"CYAN",
|
||||||
|
"MAGENTA",
|
||||||
|
"SILVER",
|
||||||
|
"GREY",
|
||||||
|
"MAROON",
|
||||||
|
"OLIVE",
|
||||||
|
"GREEN",
|
||||||
|
"PURPLE",
|
||||||
|
"TEAL",
|
||||||
|
"NAVY"
|
||||||
|
};
|
||||||
|
bool results[CLR4BIT];
|
||||||
|
f(results);
|
||||||
|
unsigned int i;
|
||||||
|
for (i = 0; i < CLR4BIT; ++i) {
|
||||||
|
if (results[i]) {
|
||||||
|
printf("%s's OK\n", colors[i]);
|
||||||
|
} else {
|
||||||
|
printf("%s's INCORRECT\n", colors[i]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void dpconvert(int r, int g, int b) {
|
||||||
|
struct Rgb t;
|
||||||
|
t.r = r * 0xf;
|
||||||
|
t.g = g * 0xf;
|
||||||
|
t.b = b * 0xf;
|
||||||
|
struct Hls z;
|
||||||
|
rgb2hsl(&z, &t);
|
||||||
|
printf("%d %f %f\n", z.h, z.s, z.l);
|
||||||
|
if (z.l < 0.5) {
|
||||||
|
z.l = 0.5;
|
||||||
|
hsl2rgb(&t, &z);
|
||||||
|
printf("%d %d %d\n", t.r, t.g, t.b);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
/* print_plname("^xf00Unregistered Player^7");
|
||||||
|
print_plname("^9[^1S^9]^x469Kom^0ier^7");
|
||||||
|
print_plname("^9sjn^5|^9F^5e^9tus^7");
|
||||||
|
print_plname("^0[^7>>^0]^xaefdizzy^7");
|
||||||
|
print_plname("^x46^xasdf"); */
|
||||||
|
print_plname("^xB90Beemann^7");
|
||||||
|
printf("Testing hsl 2 rgb\n");
|
||||||
|
test4bitcolors(&test_hsl2rgb);
|
||||||
|
printf("Testing rgb 2 hsl\n");
|
||||||
|
test4bitcolors(&test_rgb2hsl);
|
||||||
|
dpconvert(4, 6, 9);
|
||||||
|
trgb2hsl(60, 90, 135, 216, 0.38f, 0.38f);
|
||||||
|
trgb2hsl(79, 118, 176, 216, 0.38f, 0.50f);
|
||||||
|
thls2rgb(216, 0.38f, 0.50f, 79, 118, 176);
|
||||||
|
}
|
||||||
|
|
Loading…
Reference in New Issue
Block a user