Initial commit
This commit is contained in:
Mikko Nieminen
commit
db4ea8f895
|
|
@ -0,0 +1,661 @@
|
|||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
include README.rst
|
||||
recursive-include ckanext/rating *.html *.json *.js *.less *.css *.mo
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
=============
|
||||
CKAN Rating extension
|
||||
=============
|
||||
|
||||
This is a simple rating extension for CKAN datasets (packages) and showcases. The extension adds a list of clickable stars to the side navigation
|
||||
in the dataset and showcacse templates similar to ckanext-qa. In showcase the stars are also displayed in the showcase listing, but are not clickable.
|
||||
|
||||
The stars can also be added to any desired view by adding the following code to the desired template::
|
||||
|
||||
{% snippet "rating/stars.html", package=<YOUR_PACKAGE> %}
|
||||
|
||||
The amount of ratings submitted can also be displayed with::
|
||||
|
||||
{{h.package_rating(None, {'package_id' : <YOUR_PACKAGE>.id} ).ratings_count}}
|
||||
|
||||
Rating is identified with client IP if the user is not authenticated. User ID is saved with the rating when authenticated.
|
||||
|
||||
|
||||
------------
|
||||
Requirements
|
||||
------------
|
||||
|
||||
This extension works with CKAN version 2.5 or later.
|
||||
|
||||
|
||||
------------
|
||||
Installation
|
||||
------------
|
||||
|
||||
To install ckanext-rating:
|
||||
|
||||
1. Activate your CKAN virtual environment, for example::
|
||||
|
||||
. /usr/lib/ckan/default/bin/activate
|
||||
|
||||
2. Install the ckanext-rating Python package into your virtual environment::
|
||||
|
||||
pip install ckanext-rating
|
||||
|
||||
3. Add ``rating`` to the ``ckan.plugins`` setting in your CKAN
|
||||
config file (by default the config file is located at
|
||||
``/etc/ckan/default/production.ini``).
|
||||
|
||||
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
|
||||
|
||||
sudo service apache2 reload
|
||||
|
||||
5. Initialize database tables used by Rating::
|
||||
|
||||
paster --plugin=ckanext-rating rating init --config=production.ini
|
||||
|
||||
6. If you want to use this extension for ckanext-showcase, install it into your environment by following the instructions at https://github.com/ckan/ckanext-showcase
|
||||
|
||||
|
||||
------------------------
|
||||
Development Installation
|
||||
------------------------
|
||||
|
||||
To install ckanext-rating for development, activate your CKAN virtualenv and
|
||||
do::
|
||||
|
||||
git clone https://github.com/6aika/ckanext-rating.git
|
||||
cd ckanext-rating
|
||||
python setup.py develop
|
||||
pip install -r dev-requirements.txt
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
echo "This is travis-build.bash..."
|
||||
|
||||
echo "Installing the packages that CKAN requires..."
|
||||
sudo apt-get update -qq
|
||||
sudo apt-get install postgresql-$PGVERSION solr-jetty libcommons-fileupload-java:amd64=1.2.2-1
|
||||
|
||||
echo "Installing CKAN and its Python dependencies..."
|
||||
git clone https://github.com/ckan/ckan
|
||||
cd ckan
|
||||
export latest_ckan_release_branch=`git branch --all | grep remotes/origin/release-v | sort -r | sed 's/remotes\/origin\///g' | head -n 1`
|
||||
echo "CKAN branch: $latest_ckan_release_branch"
|
||||
git checkout $latest_ckan_release_branch
|
||||
python setup.py develop
|
||||
pip install -r requirements.txt --allow-all-external
|
||||
pip install -r dev-requirements.txt --allow-all-external
|
||||
cd -
|
||||
|
||||
echo "Creating the PostgreSQL user and database..."
|
||||
sudo -u postgres psql -c "CREATE USER ckan_default WITH PASSWORD 'pass';"
|
||||
sudo -u postgres psql -c 'CREATE DATABASE ckan_test WITH OWNER ckan_default;'
|
||||
|
||||
echo "Initialising the database..."
|
||||
cd ckan
|
||||
paster db init -c test-core.ini
|
||||
cd -
|
||||
|
||||
echo "Installing ckanext-rating and its requirements..."
|
||||
python setup.py develop
|
||||
pip install -r dev-requirements.txt
|
||||
|
||||
echo "Moving test.ini into a subdir..."
|
||||
mkdir subdir
|
||||
mv test.ini subdir
|
||||
|
||||
echo "travis-build.bash is done."
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
#!/bin/sh -e
|
||||
|
||||
echo "NO_START=0\nJETTY_HOST=127.0.0.1\nJETTY_PORT=8983\nJAVA_HOME=$JAVA_HOME" | sudo tee /etc/default/jetty
|
||||
sudo cp ckan/ckan/config/solr/schema.xml /etc/solr/conf/schema.xml
|
||||
sudo service jetty restart
|
||||
nosetests --nologcapture --with-pylons=subdir/test.ini --with-coverage --cover-package=ckanext.rating --cover-inclusive --cover-erase --cover-tests
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
# this is a namespace package
|
||||
try:
|
||||
import pkg_resources
|
||||
pkg_resources.declare_namespace(__name__)
|
||||
except ImportError:
|
||||
import pkgutil
|
||||
__path__ = pkgutil.extend_path(__path__, __name__)
|
||||
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,38 @@
|
|||
from ckan.lib.cli import CkanCommand
|
||||
|
||||
class RatingCommand(CkanCommand):
|
||||
'''
|
||||
Send notification emails of datasets which have a reminder date set
|
||||
|
||||
Usage:
|
||||
|
||||
paster rating init
|
||||
- Initializes database tables used by rating
|
||||
'''
|
||||
|
||||
summary = __doc__.split('\n')[0]
|
||||
usage = __doc__
|
||||
min_args = 0
|
||||
max_args = 1
|
||||
|
||||
def command(self):
|
||||
"""
|
||||
Parse command line arguments and call appropriate method.
|
||||
"""
|
||||
if not self.args or self.args[0] in ['--help', '-h', 'help']:
|
||||
print RatingCommand.__doc__
|
||||
return
|
||||
|
||||
cmd = self.args[0]
|
||||
self._load_config()
|
||||
|
||||
if cmd == 'init':
|
||||
self.init_db()
|
||||
else:
|
||||
self.log.error('Command "%s" not recognized' % (cmd,))
|
||||
|
||||
|
||||
def init_db(self):
|
||||
import ckan.model as model
|
||||
from ckanext.rating.model import init_tables
|
||||
init_tables(model.meta.engine)
|
||||
Binary file not shown.
|
|
@ -0,0 +1,47 @@
|
|||
import ckan.plugins as p
|
||||
import ckan.model as model
|
||||
import ckan.logic as logic
|
||||
from ckan.logic import ValidationError
|
||||
from ckan.lib.base import h
|
||||
|
||||
c = p.toolkit.c
|
||||
flatten_to_string_key = logic.flatten_to_string_key
|
||||
|
||||
class RatingController(p.toolkit.BaseController):
|
||||
|
||||
def submit_package_rating(self, package, rating):
|
||||
p.toolkit.get_action('rating_package_create')(
|
||||
context = {'model': model,
|
||||
'user': c.user or c.author},
|
||||
data_dict={'package': package,
|
||||
'rating': rating}
|
||||
)
|
||||
h.redirect_to(str('/dataset/' + package))
|
||||
return p.toolkit.render('package/read.html')
|
||||
|
||||
def submit_showcase_rating(self, package, rating):
|
||||
p.toolkit.get_action('rating_package_create')(
|
||||
context = {'model': model,
|
||||
'user': c.user or c.author},
|
||||
data_dict={'package': package,
|
||||
'rating': rating}
|
||||
)
|
||||
h.redirect_to(str('/showcase/' + package))
|
||||
return p.toolkit.render('showcase/showcase_info.html')
|
||||
|
||||
def submit_ajax_package_rating(self, package, rating):
|
||||
try:
|
||||
p.toolkit.get_action('rating_package_create')(
|
||||
context = {'model': model,
|
||||
'user': c.user or c.author},
|
||||
data_dict={'package': package,
|
||||
'rating': rating}
|
||||
)
|
||||
except Exception, ex:
|
||||
errors = ex
|
||||
else:
|
||||
data['success'] = True
|
||||
|
||||
data = flatten_to_string_key({ 'data': data, 'errors': errors }),
|
||||
response.headers['Content-Type'] = 'application/json;charset=utf-8'
|
||||
return h.json.dumps(data)
|
||||
Binary file not shown.
|
|
@ -0,0 +1,67 @@
|
|||
import logging
|
||||
import json
|
||||
|
||||
from ckan.common import _
|
||||
from ckan.logic import ValidationError
|
||||
from ckan.plugins import toolkit
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
def rating_package_create(context, data_dict):
|
||||
'''Review a dataset (package).
|
||||
:param package: the name or id of the dataset to rate
|
||||
:type package: string
|
||||
:param rating: the rating to give to the dataset, an integer between 1 and 5
|
||||
:type rating: int
|
||||
'''
|
||||
model = context.get('model')
|
||||
user = context.get('user')
|
||||
|
||||
user = model.User.by_name(user)
|
||||
|
||||
from ckan.model import User
|
||||
if not isinstance(user, User):
|
||||
user = toolkit.request.environ.get('REMOTE_ADDR')
|
||||
|
||||
package_ref = data_dict.get('package')
|
||||
rating = data_dict.get('rating')
|
||||
error = None
|
||||
if not package_ref:
|
||||
error = _('You must supply a package id or name '
|
||||
'(parameter "package").')
|
||||
elif not rating:
|
||||
error = _('You must supply a rating (parameter "rating").')
|
||||
else:
|
||||
try:
|
||||
rating = float(rating)
|
||||
except ValueError:
|
||||
error = _('Rating must be an integer value.')
|
||||
else:
|
||||
package = model.Package.get(package_ref)
|
||||
if rating < model.MIN_RATING or rating > model.MAX_RATING:
|
||||
error = _('Rating must be between %i and %i.') \
|
||||
% (model.MIN_RATING, model.MAX_RATING)
|
||||
elif not package:
|
||||
error = _('Not found') + ': %r' % package_ref
|
||||
if error:
|
||||
raise ValidationError(error)
|
||||
|
||||
from ckanext.rating.model import Rating
|
||||
Rating.create_package_rating(package.id, rating, user)
|
||||
|
||||
return Rating.get_package_rating(package.id)
|
||||
|
||||
def rating_package_get(context, data_dict):
|
||||
package_id = data_dict.get('package_id')
|
||||
|
||||
error = None
|
||||
|
||||
if not package_id:
|
||||
error = _('You must supply a package id '
|
||||
'(parameter "package_id").')
|
||||
if error:
|
||||
raise ValidationError(error)
|
||||
|
||||
from ckanext.rating.model import Rating
|
||||
|
||||
return Rating.get_package_rating(package_id)
|
||||
Binary file not shown.
|
|
@ -0,0 +1,97 @@
|
|||
import uuid
|
||||
import datetime
|
||||
|
||||
from sqlalchemy import Column
|
||||
from sqlalchemy import types
|
||||
from sqlalchemy.ext.declarative import declarative_base
|
||||
from ckan.lib import dictization
|
||||
import ckan.model as model
|
||||
|
||||
log = __import__('logging').getLogger(__name__)
|
||||
|
||||
Base = declarative_base()
|
||||
|
||||
__all__ = ['MIN_RATING', 'MAX_RATING']
|
||||
|
||||
MIN_RATING = 1.0
|
||||
MAX_RATING = 5.0
|
||||
|
||||
def make_uuid():
|
||||
return unicode(uuid.uuid4())
|
||||
|
||||
class Rating(Base):
|
||||
|
||||
__tablename__ = 'review'
|
||||
|
||||
id = Column(types.UnicodeText, primary_key=True, default=make_uuid)
|
||||
package_id = Column(types.UnicodeText, nullable=True, index=True)
|
||||
rating = Column(types.Float, nullable=False)
|
||||
user_id = Column(types.UnicodeText, nullable=True, index=True)
|
||||
rater_ip = Column(types.UnicodeText) # Used for identification if user is not authenticated
|
||||
created = Column(types.DateTime, default=datetime.datetime.now)
|
||||
updated = Column(types.DateTime, default=datetime.datetime.now)
|
||||
|
||||
def as_dict(self):
|
||||
context = {'model': model}
|
||||
rating_dict = dictization.table_dictize(self, context)
|
||||
return rating_dict
|
||||
|
||||
@classmethod
|
||||
def create_package_rating(cls, package_id, rating, ip_or_user):
|
||||
|
||||
rating = round(rating, 2)
|
||||
existing_rating = cls.get_user_package_rating(ip_or_user, package_id)
|
||||
|
||||
if (existing_rating.first()):
|
||||
existing_rating.update({ 'rating': rating })
|
||||
model.repo.commit()
|
||||
log.info('Review updated for package')
|
||||
else:
|
||||
user_id = None
|
||||
from ckan.model import User
|
||||
|
||||
if isinstance(ip_or_user, User):
|
||||
user_id = ip_or_user.id
|
||||
ip_or_user = None
|
||||
|
||||
review = Rating(
|
||||
user_id = user_id,
|
||||
rater_ip = ip_or_user,
|
||||
package_id = package_id,
|
||||
rating = rating
|
||||
)
|
||||
|
||||
model.Session.add(review)
|
||||
model.repo.commit()
|
||||
log.info('Review added for package')
|
||||
|
||||
@classmethod
|
||||
def get_package_rating(cls, package_id):
|
||||
ratings = model.Session.query(cls) \
|
||||
.filter(cls.package_id == package_id) \
|
||||
.all()
|
||||
|
||||
average = sum(r.rating for r in ratings) / float(len(ratings)) if len(ratings) > 0 else 0
|
||||
return {
|
||||
'rating': round(average, 2),
|
||||
'ratings_count': len(ratings)
|
||||
}
|
||||
|
||||
@classmethod
|
||||
def get_user_package_rating(cls, ip_or_user, package_id):
|
||||
|
||||
user_id = None
|
||||
from ckan.model import User
|
||||
|
||||
if isinstance(ip_or_user, User):
|
||||
user_id = ip_or_user.id
|
||||
ip_or_user = None
|
||||
|
||||
rating = model.Session.query(cls) \
|
||||
.filter(cls.package_id == package_id, cls.user_id == user_id, cls.rater_ip == ip_or_user)
|
||||
|
||||
return rating
|
||||
|
||||
def init_tables(engine):
|
||||
Base.metadata.create_all(engine)
|
||||
log.info('Rating database tables are set-up')
|
||||
Binary file not shown.
|
|
@ -0,0 +1,46 @@
|
|||
import ckan.plugins as plugins
|
||||
import ckan.plugins.toolkit as toolkit
|
||||
from ckanext.rating.logic import action
|
||||
|
||||
class RatingPlugin(plugins.SingletonPlugin):
|
||||
plugins.implements(plugins.IConfigurer)
|
||||
plugins.implements(plugins.IActions)
|
||||
plugins.implements(plugins.ITemplateHelpers)
|
||||
plugins.implements(plugins.IRoutes, inherit=True)
|
||||
|
||||
# IConfigurer
|
||||
|
||||
def update_config(self, config_):
|
||||
toolkit.add_template_directory(config_, 'templates')
|
||||
toolkit.add_public_directory(config_, 'public')
|
||||
toolkit.add_resource('fanstatic', 'rating')
|
||||
|
||||
# IActions
|
||||
|
||||
def get_actions(self):
|
||||
return {
|
||||
'rating_package_create': action.rating_package_create,
|
||||
'rating_package_get': action.rating_package_get,
|
||||
'rating_showcase_create': action.rating_package_create,
|
||||
'rating_showcase_get': action.rating_package_get
|
||||
}
|
||||
|
||||
## ITemplateHelpers
|
||||
|
||||
def get_helpers(self):
|
||||
return {
|
||||
'package_rating': action.rating_package_get
|
||||
}
|
||||
|
||||
# IRoutes
|
||||
|
||||
def before_map(self, map):
|
||||
map.connect('/rating/dataset/:package/:rating',
|
||||
controller='ckanext.rating.controller:RatingController',
|
||||
action='submit_package_rating')
|
||||
|
||||
map.connect('/rating/showcase/:package/:rating',
|
||||
controller='ckanext.rating.controller:RatingController',
|
||||
action='submit_showcase_rating')
|
||||
|
||||
return map
|
||||
Binary file not shown.
|
|
@ -0,0 +1,46 @@
|
|||
{#
|
||||
Displays a sidebard module with information for given package
|
||||
|
||||
pkg - The package dict that owns the resources.
|
||||
|
||||
Example:
|
||||
|
||||
{% snippet "package/snippets/info.html", pkg=pkg %}
|
||||
|
||||
#}
|
||||
{% block package_info %}
|
||||
{% if pkg %}
|
||||
<section class="module module-narrow">
|
||||
<div class="module context-info">
|
||||
<div class="module-content">
|
||||
{% block package_info_inner %}
|
||||
{% block heading %}
|
||||
<h1 class="heading">{{ h.dataset_display_name(pkg) }}</h1>
|
||||
{% endblock %}
|
||||
{% block rating %}
|
||||
<p>
|
||||
{% snippet "rating/stars.html", package=pkg %}
|
||||
({{h.package_rating(None, {'package_id' : pkg.id} ).ratings_count}})
|
||||
</p>
|
||||
{% endblock %}
|
||||
{% block nums %}
|
||||
<div class="nums">
|
||||
<dl>
|
||||
<dt>{{ _('Followers') }}</dt>
|
||||
<dd>{{ h.SI_number_span(h.follow_count('dataset', pkg.id)) }}</dd>
|
||||
</dl>
|
||||
</div>
|
||||
{% endblock %}
|
||||
{% block follow_button %}
|
||||
{% if not hide_follow_button %}
|
||||
<div class="follow_button">
|
||||
{{ h.follow_button('dataset', pkg.name) }}
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{% endblock %}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
{#
|
||||
Renders a set of stars, which can be clicked to submit a rating
|
||||
|
||||
stars - The number of stars to be displayed.
|
||||
package - The package for which the rating belongs to
|
||||
|
||||
{% snippet "rating/stars.html", package=pkg %}
|
||||
|
||||
#}
|
||||
|
||||
{% set stars = h.package_rating(None, {'package_id' : package.id} ).rating %}
|
||||
<span class="star-rating{% if stars == 0 %} no-stars{% endif %}">
|
||||
<span class="star-rating-stars">
|
||||
{%- for index in range(stars|int) -%}
|
||||
<a class="icon icon-star rating_star" href="/rating/{{ package.type }}/{{ package.name }}/{{ index + 1 }}"></a>
|
||||
{%- endfor -%}
|
||||
{%- for index in range(stars|int, 5) -%}
|
||||
<a class="icon icon-star-empty rating_star" href="/rating/{{ package.type }}/{{ package.name }}/{{ index + 1 }}"></a>
|
||||
{%- endfor -%}
|
||||
</span>
|
||||
</span>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
{#
|
||||
Renders a set of stars
|
||||
|
||||
stars - The number of stars to be displayed.
|
||||
|
||||
{% snippet "rating/stars_inactive.html", stars=4 %}
|
||||
|
||||
#}
|
||||
|
||||
<span class="star-rating{% if stars == 0 %} no-stars{% endif %}">
|
||||
<span class="star-rating-stars">
|
||||
{%- for index in range(stars|int) -%}
|
||||
<span class="icon icon-star rating_star"></span>
|
||||
{%- endfor -%}
|
||||
{%- for index in range(stars|int, 5) -%}
|
||||
<span class="icon icon-star-empty rating_star"></span>
|
||||
{%- endfor -%}
|
||||
</span>
|
||||
</span>
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
{% ckan_extends %}
|
||||
|
||||
{% block package_info_inner %}
|
||||
{% block heading %}
|
||||
<h1 class="heading">{{ pkg.title or pkg.name }}</h1>
|
||||
{% endblock %}
|
||||
{% if pkg.author %}
|
||||
<span class="smallest">{{_('Submitted by')}}</span>
|
||||
<p>{{ pkg.author }}</p>
|
||||
{% endif %}
|
||||
{% block rating %}
|
||||
<p>
|
||||
{% snippet "rating/stars.html", package=pkg %}
|
||||
({{h.package_rating(None, {'package_id' : pkg.id} ).ratings_count}})
|
||||
</p>
|
||||
{% endblock %}
|
||||
{% if pkg.url %}
|
||||
<div class="info">
|
||||
<a class="btn btn-primary" href="{{ pkg.url }}" target="_blank">
|
||||
<i class="icon-external-link"></i> {{ _('Launch website') }}
|
||||
</a>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
{% ckan_extends %}
|
||||
|
||||
{% block item_inner %}
|
||||
{% block image %}
|
||||
<img src="{{ package.image_display_url or h.url_for_static('/base/images/placeholder-group.png') }}" alt="{{ package.name }}" class="media-image">
|
||||
{% endblock %}
|
||||
{% block title %}
|
||||
<h3 class="media-heading">{{ h.link_to(h.truncate(title, truncate_title), h.url_for(controller='ckanext.showcase.controller:ShowcaseController', action='read', id=package.name)) }}</h3>
|
||||
{% endblock %}
|
||||
{% block rating %}
|
||||
<p>
|
||||
{% snippet "rating/stars_inactive.html", stars=h.package_rating(None, {'package_id' : package.id} ).rating %}
|
||||
({{h.package_rating(None, {'package_id' : package.id} ).ratings_count}})
|
||||
</p>
|
||||
{% endblock %}
|
||||
{% block notes %}
|
||||
{% if notes %}
|
||||
<div>{{ notes|urlize }}</div>
|
||||
{% else %}
|
||||
<p class="empty">{{ _("This showcase has no description") }}</p>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{% block datasets %}
|
||||
{% if package.num_datasets %}
|
||||
<strong class="count">{{ ungettext('{num} Dataset', '{num} Datasets', package.num_datasets).format(num=package.num_datasets) }}</strong>
|
||||
{% elif package.num_datasets == 0 %}
|
||||
<span class="count">{{ _('0 Datasets') }}</span>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
{% block link %}
|
||||
<a href="{{ h.url_for(controller='ckanext.showcase.controller:ShowcaseController', action='read', id=package.name) }}" title="{{ _('View {showcase_title}').format(showcase_title=package.title) }}" class="media-view">
|
||||
<span>{{ _('View {showcase_title}').format(showcase_title=package.title) }}</span>
|
||||
</a>
|
||||
{% endblock %}
|
||||
{% if show_remove %}
|
||||
<form method="post"><input type="hidden" value="{{ package.id }}" name="remove_showcase_id" /><input value="{{ _('Remove') }}" type="submit" class="btn btn-danger btn-small media-edit" title="{{ _('Remove dataset from this showcase') }}"/></form>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
"""Tests for plugin.py."""
|
||||
import ckanext.rating.plugin as plugin
|
||||
|
||||
def test_plugin():
|
||||
pass
|
||||
|
|
@ -0,0 +1,181 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: ckanext-rating
|
||||
Version: 0.0.1
|
||||
Summary: A CKAN extension which enables users to rate different content
|
||||
Home-page: https://github.com/6aika/ckanext-rating
|
||||
Author: Mikko Nieminen
|
||||
Author-email: mikko.nieminen@gofore.com
|
||||
License: AGPL
|
||||
Description: .. You should enable this project on travis-ci.org and coveralls.io to make
|
||||
these badges work. The necessary Travis and Coverage config files have been
|
||||
generated for you.
|
||||
|
||||
.. image:: https://travis-ci.org/6aika/ckanext-rating.svg?branch=master
|
||||
:target: https://travis-ci.org/6aika/ckanext-rating
|
||||
|
||||
.. image:: https://coveralls.io/repos/6aika/ckanext-rating/badge.svg
|
||||
:target: https://coveralls.io/r/6aika/ckanext-rating
|
||||
|
||||
.. image:: https://pypip.in/download/ckanext-rating/badge.svg
|
||||
:target: https://pypi.python.org/pypi//ckanext-rating/
|
||||
:alt: Downloads
|
||||
|
||||
.. image:: https://pypip.in/version/ckanext-rating/badge.svg
|
||||
:target: https://pypi.python.org/pypi/ckanext-rating/
|
||||
:alt: Latest Version
|
||||
|
||||
.. image:: https://pypip.in/py_versions/ckanext-rating/badge.svg
|
||||
:target: https://pypi.python.org/pypi/ckanext-rating/
|
||||
:alt: Supported Python versions
|
||||
|
||||
.. image:: https://pypip.in/status/ckanext-rating/badge.svg
|
||||
:target: https://pypi.python.org/pypi/ckanext-rating/
|
||||
:alt: Development Status
|
||||
|
||||
.. image:: https://pypip.in/license/ckanext-rating/badge.svg
|
||||
:target: https://pypi.python.org/pypi/ckanext-rating/
|
||||
:alt: License
|
||||
|
||||
=============
|
||||
ckanext-rating
|
||||
=============
|
||||
|
||||
.. Put a description of your extension here:
|
||||
What does it do? What features does it have?
|
||||
Consider including some screenshots or embedding a video!
|
||||
|
||||
|
||||
------------
|
||||
Requirements
|
||||
------------
|
||||
|
||||
For example, you might want to mention here which versions of CKAN this
|
||||
extension works with.
|
||||
|
||||
|
||||
------------
|
||||
Installation
|
||||
------------
|
||||
|
||||
.. Add any additional install steps to the list below.
|
||||
For example installing any non-Python dependencies or adding any required
|
||||
config settings.
|
||||
|
||||
To install ckanext-rating:
|
||||
|
||||
1. Activate your CKAN virtual environment, for example::
|
||||
|
||||
. /usr/lib/ckan/default/bin/activate
|
||||
|
||||
2. Install the ckanext-rating Python package into your virtual environment::
|
||||
|
||||
pip install ckanext-rating
|
||||
|
||||
3. Add ``rating`` to the ``ckan.plugins`` setting in your CKAN
|
||||
config file (by default the config file is located at
|
||||
``/etc/ckan/default/production.ini``).
|
||||
|
||||
4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::
|
||||
|
||||
sudo service apache2 reload
|
||||
|
||||
|
||||
---------------
|
||||
Config Settings
|
||||
---------------
|
||||
|
||||
Document any optional config settings here. For example::
|
||||
|
||||
# The minimum number of hours to wait before re-checking a resource
|
||||
# (optional, default: 24).
|
||||
ckanext.rating.some_setting = some_default_value
|
||||
|
||||
|
||||
------------------------
|
||||
Development Installation
|
||||
------------------------
|
||||
|
||||
To install ckanext-rating for development, activate your CKAN virtualenv and
|
||||
do::
|
||||
|
||||
git clone https://github.com/6aika/ckanext-rating.git
|
||||
cd ckanext-rating
|
||||
python setup.py develop
|
||||
pip install -r dev-requirements.txt
|
||||
|
||||
|
||||
-----------------
|
||||
Running the Tests
|
||||
-----------------
|
||||
|
||||
To run the tests, do::
|
||||
|
||||
nosetests --nologcapture --with-pylons=test.ini
|
||||
|
||||
To run the tests and produce a coverage report, first make sure you have
|
||||
coverage installed in your virtualenv (``pip install coverage``) then run::
|
||||
|
||||
nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.rating --cover-inclusive --cover-erase --cover-tests
|
||||
|
||||
|
||||
---------------------------------
|
||||
Registering ckanext-rating on PyPI
|
||||
---------------------------------
|
||||
|
||||
ckanext-rating should be availabe on PyPI as
|
||||
https://pypi.python.org/pypi/ckanext-rating. If that link doesn't work, then
|
||||
you can register the project on PyPI for the first time by following these
|
||||
steps:
|
||||
|
||||
1. Create a source distribution of the project::
|
||||
|
||||
python setup.py sdist
|
||||
|
||||
2. Register the project::
|
||||
|
||||
python setup.py register
|
||||
|
||||
3. Upload the source distribution to PyPI::
|
||||
|
||||
python setup.py sdist upload
|
||||
|
||||
4. Tag the first release of the project on GitHub with the version number from
|
||||
the ``setup.py`` file. For example if the version number in ``setup.py`` is
|
||||
0.0.1 then do::
|
||||
|
||||
git tag 0.0.1
|
||||
git push --tags
|
||||
|
||||
|
||||
----------------------------------------
|
||||
Releasing a New Version of ckanext-rating
|
||||
----------------------------------------
|
||||
|
||||
ckanext-rating is availabe on PyPI as https://pypi.python.org/pypi/ckanext-rating.
|
||||
To publish a new version to PyPI follow these steps:
|
||||
|
||||
1. Update the version number in the ``setup.py`` file.
|
||||
See `PEP 440 <http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers>`_
|
||||
for how to choose version numbers.
|
||||
|
||||
2. Create a source distribution of the new version::
|
||||
|
||||
python setup.py sdist
|
||||
|
||||
3. Upload the source distribution to PyPI::
|
||||
|
||||
python setup.py sdist upload
|
||||
|
||||
4. Tag the new release of the project on GitHub with the version number from
|
||||
the ``setup.py`` file. For example if the version number in ``setup.py`` is
|
||||
0.0.2 then do::
|
||||
|
||||
git tag 0.0.2
|
||||
git push --tags
|
||||
|
||||
Keywords: CKAN rating
|
||||
Platform: UNKNOWN
|
||||
Classifier: Development Status :: 4 - Beta
|
||||
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
|
||||
Classifier: Programming Language :: Python :: 2.6
|
||||
Classifier: Programming Language :: Python :: 2.7
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
MANIFEST.in
|
||||
README.rst
|
||||
setup.cfg
|
||||
setup.py
|
||||
ckanext/__init__.py
|
||||
ckanext/rating/__init__.py
|
||||
ckanext/rating/commands.py
|
||||
ckanext/rating/model.py
|
||||
ckanext/rating/plugin.py
|
||||
ckanext/rating/logic/__init__.py
|
||||
ckanext/rating/logic/action.py
|
||||
ckanext/rating/templates/rating/stars.html
|
||||
ckanext/rating/templates/showcase/snippets/showcase_info.html
|
||||
ckanext/rating/tests/__init__.py
|
||||
ckanext/rating/tests/test_plugin.py
|
||||
ckanext_rating.egg-info/PKG-INFO
|
||||
ckanext_rating.egg-info/SOURCES.txt
|
||||
ckanext_rating.egg-info/dependency_links.txt
|
||||
ckanext_rating.egg-info/entry_points.txt
|
||||
ckanext_rating.egg-info/pbr.json
|
||||
ckanext_rating.egg-info/top_level.txt
|
||||
|
|
@ -0,0 +1 @@
|
|||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
[ckan.plugins]
|
||||
rating=ckanext.rating.plugin:RatingPlugin
|
||||
|
||||
[paste.paster_command]
|
||||
rating=ckanext.rating.commands:RatingCommand
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
{"is_release": false, "git_version": "f44fe83"}
|
||||
|
|
@ -0,0 +1 @@
|
|||
ckanext
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
[extract_messages]
|
||||
keywords = translate isPlural
|
||||
add_comments = TRANSLATORS:
|
||||
output_file = i18n/ckanext-rating.pot
|
||||
width = 80
|
||||
|
||||
[init_catalog]
|
||||
domain = ckanext-rating
|
||||
input_file = i18n/ckanext-rating.pot
|
||||
output_dir = i18n
|
||||
|
||||
[update_catalog]
|
||||
domain = ckanext-rating
|
||||
input_file = i18n/ckanext-rating.pot
|
||||
output_dir = i18n
|
||||
previous = true
|
||||
|
||||
[compile_catalog]
|
||||
domain = ckanext-rating
|
||||
directory = i18n
|
||||
statistics = true
|
||||
|
|
@ -0,0 +1,87 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
from setuptools import setup, find_packages # Always prefer setuptools over distutils
|
||||
from codecs import open # To use a consistent encoding
|
||||
from os import path
|
||||
|
||||
here = path.abspath(path.dirname(__file__))
|
||||
|
||||
# Get the long description from the relevant file
|
||||
with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
|
||||
long_description = f.read()
|
||||
|
||||
setup(
|
||||
name='''ckanext-rating''',
|
||||
|
||||
# Versions should comply with PEP440. For a discussion on single-sourcing
|
||||
# the version across setup.py and the project code, see
|
||||
# http://packaging.python.org/en/latest/tutorial.html#version
|
||||
version='0.0.1',
|
||||
|
||||
description='''A CKAN extension which enables users to rate different content''',
|
||||
long_description=long_description,
|
||||
|
||||
# The project's main homepage.
|
||||
url='https://github.com/6aika/ckanext-rating',
|
||||
|
||||
# Author details
|
||||
author='''Mikko Nieminen''',
|
||||
author_email='''mikko.nieminen@gofore.com''',
|
||||
|
||||
# Choose your license
|
||||
license='AGPL',
|
||||
|
||||
# See https://pypi.python.org/pypi?%3Aaction=list_classifiers
|
||||
classifiers=[
|
||||
# How mature is this project? Common values are
|
||||
# 3 - Alpha
|
||||
# 4 - Beta
|
||||
# 5 - Production/Stable
|
||||
'Development Status :: 4 - Beta',
|
||||
|
||||
# Pick your license as you wish (should match "license" above)
|
||||
'License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)',
|
||||
|
||||
# Specify the Python versions you support here. In particular, ensure
|
||||
# that you indicate whether you support Python 2, Python 3 or both.
|
||||
'Programming Language :: Python :: 2.6',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
],
|
||||
|
||||
|
||||
# What does your project relate to?
|
||||
keywords='''CKAN rating''',
|
||||
|
||||
# You can just specify the packages manually here if your project is
|
||||
# simple. Or you can use find_packages().
|
||||
packages=find_packages(exclude=['contrib', 'docs', 'tests*']),
|
||||
|
||||
# List run-time dependencies here. These will be installed by pip when your
|
||||
# project is installed. For an analysis of "install_requires" vs pip's
|
||||
# requirements files see:
|
||||
# https://packaging.python.org/en/latest/technical.html#install-requires-vs-requirements-files
|
||||
install_requires=[],
|
||||
|
||||
# If there are data files included in your packages that need to be
|
||||
# installed, specify them here. If using Python 2.6 or less, then these
|
||||
# have to be included in MANIFEST.in as well.
|
||||
include_package_data=True,
|
||||
package_data={
|
||||
},
|
||||
|
||||
# Although 'package_data' is the preferred approach, in some case you may
|
||||
# need to place data files outside of your packages.
|
||||
# see http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files
|
||||
# In this case, 'data_file' will be installed into '<sys.prefix>/my_data'
|
||||
data_files=[],
|
||||
|
||||
# To provide executable scripts, use entry points in preference to the
|
||||
# "scripts" keyword. Entry points provide cross-platform support and allow
|
||||
# pip to create the appropriate form of executable for the target platform.
|
||||
entry_points='''
|
||||
[ckan.plugins]
|
||||
rating=ckanext.rating.plugin:RatingPlugin
|
||||
|
||||
[paste.paster_command]
|
||||
rating=ckanext.rating.commands:RatingCommand
|
||||
'''
|
||||
)
|
||||
|
|
@ -0,0 +1,49 @@
|
|||
[DEFAULT]
|
||||
debug = false
|
||||
smtp_server = localhost
|
||||
error_email_from = paste@localhost
|
||||
|
||||
[server:main]
|
||||
use = egg:Paste#http
|
||||
host = 0.0.0.0
|
||||
port = 5000
|
||||
|
||||
[app:main]
|
||||
use = config:../ckan/test-core.ini
|
||||
|
||||
# Insert any custom config settings to be used when running your extension's
|
||||
# tests here.
|
||||
|
||||
|
||||
# Logging configuration
|
||||
[loggers]
|
||||
keys = root, ckan, sqlalchemy
|
||||
|
||||
[handlers]
|
||||
keys = console
|
||||
|
||||
[formatters]
|
||||
keys = generic
|
||||
|
||||
[logger_root]
|
||||
level = WARN
|
||||
handlers = console
|
||||
|
||||
[logger_ckan]
|
||||
qualname = ckan
|
||||
handlers =
|
||||
level = INFO
|
||||
|
||||
[logger_sqlalchemy]
|
||||
handlers =
|
||||
qualname = sqlalchemy.engine
|
||||
level = WARN
|
||||
|
||||
[handler_console]
|
||||
class = StreamHandler
|
||||
args = (sys.stdout,)
|
||||
level = NOTSET
|
||||
formatter = generic
|
||||
|
||||
[formatter_generic]
|
||||
format = %(asctime)s %(levelname)-5.5s [%(name)s] %(message)s
|
||||
Loading…
Reference in New Issue