first commit - first working version
This commit is contained in:
commit
f0d574d192
20 changed files with 1480 additions and 0 deletions
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
|
@ -0,0 +1,3 @@
|
|||
*.pyc
|
||||
dist/
|
||||
*egg-info/
|
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:
|
||||
|
||||
{project} Copyright (C) {year} {fullname}
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
4
MANIFEST.in
Normal file
4
MANIFEST.in
Normal file
|
@ -0,0 +1,4 @@
|
|||
include LICENSE
|
||||
include README.rst
|
||||
recursive-include anonsurvey/templatetags *
|
||||
recursive-include anonsurvey/templates *
|
125
README.rst
Normal file
125
README.rst
Normal file
|
@ -0,0 +1,125 @@
|
|||
==========
|
||||
Anonsurvey
|
||||
==========
|
||||
|
||||
Anonsurvey is a Django app to create Web-based anonymous surveys.
|
||||
|
||||
Quick start
|
||||
-----------
|
||||
|
||||
1. Add "anonsurvey" to your INSTALLED_APPS setting like this::
|
||||
|
||||
INSTALLED_APPS = (
|
||||
...
|
||||
'polls',
|
||||
)
|
||||
|
||||
Anonsurvey admin also depends on:
|
||||
'tinymce',
|
||||
'sorl.thumbnail',
|
||||
'mce_filebrowser',
|
||||
|
||||
2. Include the anonsurvey URLconf in your project urls.py like this::
|
||||
|
||||
url(r'^survey/', include('anonsurvey.urls')),
|
||||
|
||||
3. Run `python manage.py syncdb` to create the anonsurvey models.
|
||||
|
||||
4. Start the development server and visit http://127.0.0.1:8000/admin/
|
||||
to create a survey (you'll need the Admin app enabled).
|
||||
|
||||
5. Visit http://127.0.0.1:8000/survey/ to list surveys.
|
||||
|
||||
|
||||
Creating survey
|
||||
---------------
|
||||
First you enter survey main data:
|
||||
|
||||
* title
|
||||
* name (which is a slug initialy created from title)
|
||||
* introduction text
|
||||
* active state (False by default).
|
||||
|
||||
Then you can enter question. For each question you can enter the
|
||||
question group the question belongs to. Question group is optinal.
|
||||
Question data are:
|
||||
|
||||
* survey the question belongs to
|
||||
* optional question group
|
||||
* type of the question:
|
||||
- input - input type text
|
||||
- choice - input type radio group
|
||||
- multiple choice - input type checkboxes
|
||||
- choice with input - input type radio group with one radio
|
||||
input with type text
|
||||
- multiple choice with input - input type checkboxes with one
|
||||
checkbox with input type text
|
||||
* text of the question
|
||||
* requires answer
|
||||
* sort index - questions are sorted by this number ascending.
|
||||
|
||||
Question group contains of the survey it belongs to and question group
|
||||
text.
|
||||
|
||||
For each question you define answer or multiple offered answers.
|
||||
Answer data are:
|
||||
|
||||
* type - input or choice - it is relevant only for choice with
|
||||
input and multiple choice with input question types
|
||||
* text prefix - displayed before input field of input type answer
|
||||
* text - displayed for choice type of answer
|
||||
* text sufix - displayed after input field of input type answer
|
||||
* default value - for input type of answer
|
||||
* validation refex - for input type of answer
|
||||
* sort index - answers are sorted by this number ascending.
|
||||
|
||||
Depending on survey definition survey questions and offered answers are
|
||||
rendered differently.
|
||||
|
||||
First, survey title and intro text are displayed.
|
||||
Then questions are rendered in ordering depending on sort index value.
|
||||
If question belongs to question group then group's title is displayed.
|
||||
Then each quesiton for group is rendered inside that group.
|
||||
If question belongs to none group then its alone is rendered.
|
||||
For each question its text is displayed.
|
||||
Under the question answers are rendered in ordering defined by sort
|
||||
index value.
|
||||
If question type is input then input field is rendered.
|
||||
Before input field text prefix is displayed. After input field text
|
||||
sufix is displayed. If default value is defined that value is rendered
|
||||
inside input field.
|
||||
If question type is choice then offered answers are displayed as
|
||||
radio group. Each radio is one offered answer and its text is displayed.
|
||||
If question type is multiple choice then offered answers are displayed
|
||||
as checkbox. Each checkbox is one offered answer and its text is
|
||||
displayed.
|
||||
If quesiton type is choice with input or multiple choice with input
|
||||
then each answer is displayed as above for choice or multiple choice
|
||||
type of question. Here answer's answer type is relevant. If type is
|
||||
input then its radio or checkbox contains of input field which is
|
||||
rendered the same as for input type of question.
|
||||
|
||||
When submiting completed survey validations are performed:
|
||||
|
||||
* if question requires answer then answer must be suplied
|
||||
* if answer type is input and validation regex is supplied
|
||||
then answer value must match defined regex (note that
|
||||
regex is prefixed and sufixe with ^ and $ so that whole string
|
||||
match is checked).
|
||||
|
||||
Submitted answers data are:
|
||||
|
||||
* client_id - in the format <current_timestamp>@<remote_ip>
|
||||
(by this value you can group answers to one client that
|
||||
completed the survey)
|
||||
* datetime - current timestamp answer is saved
|
||||
* answer - foreign key to offered answer that is input/selected
|
||||
* text - input value for input type of offered answer.
|
||||
|
||||
Within package there are simplest templates you can use to make your
|
||||
own.
|
||||
For survey display
|
||||
{% include "anonsurvey/survey_form.thml" with survey=survey %} is used.
|
||||
This template provides a way for rendering the survey form depending
|
||||
on survey definition. You can use it as is or you can use it as a
|
||||
template for constructing yours.
|
0
anonsurvey/__init__.py
Normal file
0
anonsurvey/__init__.py
Normal file
74
anonsurvey/admin.py
Normal file
74
anonsurvey/admin.py
Normal file
|
@ -0,0 +1,74 @@
|
|||
from django.contrib import admin
|
||||
from anonsurvey.models import Survey, QuestionGroup, Question,\
|
||||
OfferedAnswer
|
||||
from django import forms
|
||||
from django.utils.translation import ugettext_lazy as _
|
||||
from django.core.exceptions import ValidationError
|
||||
|
||||
|
||||
class QuestionInline(admin.StackedInline):
|
||||
model = Question
|
||||
extra = 1
|
||||
|
||||
|
||||
class SurveyAdmin(admin.ModelAdmin):
|
||||
prepopulated_fields = {'name': ('title',)}
|
||||
fields = ('title', 'name', 'intro', 'active')
|
||||
list_display = ('name', 'title', 'active')
|
||||
search_fields = ('title', 'intro')
|
||||
list_filter = ('active',)
|
||||
inlines = [QuestionInline]
|
||||
|
||||
|
||||
class OfferedAnswerInlineFormSet(forms.models.BaseInlineFormSet):
|
||||
def clean(self):
|
||||
super(OfferedAnswerInlineFormSet, self).clean()
|
||||
|
||||
cnt = 0
|
||||
question = None
|
||||
for form in self.forms:
|
||||
if not hasattr(form, 'cleaned_data'):
|
||||
continue
|
||||
data = form.cleaned_data
|
||||
if 'answer_type' in data and data['answer_type'] == 'I':
|
||||
cnt += 1
|
||||
if not question:
|
||||
question = data['question']
|
||||
if question and question.question_type in ('CI', 'RI') and cnt > 1:
|
||||
raise ValidationError(_('Choice with input and multiple choice'
|
||||
' with input type of question cannot have'
|
||||
' more than one input type of answer'))
|
||||
|
||||
|
||||
class OfferedAnswerInline(admin.StackedInline):
|
||||
model = OfferedAnswer
|
||||
formset = OfferedAnswerInlineFormSet
|
||||
extra = 1
|
||||
|
||||
|
||||
class QuestionAdmin(admin.ModelAdmin):
|
||||
inlines = [OfferedAnswerInline]
|
||||
list_display = ('survey', 'question_group', 'text', )
|
||||
search_fields = ('text', 'offeredanswer__prefix',
|
||||
'offeredanswer__answer_type',
|
||||
'offeredanswer__text',
|
||||
'offeredanswer__sufix',)
|
||||
list_filter = ('question_type', 'requires_answer', )
|
||||
|
||||
|
||||
class QuestionGroupAdmin(admin.ModelAdmin):
|
||||
list_display = ('survey', 'text', )
|
||||
search_fields = ('text', )
|
||||
inlines = [QuestionInline]
|
||||
|
||||
|
||||
class OfferedAnswerAdmin(admin.ModelAdmin):
|
||||
list_display = ('question', 'prefix', 'text', 'sufix', 'sort_index')
|
||||
search_fields = ('question__text', 'prefix', 'text', 'sufix')
|
||||
list_filter = ('answer_type', 'question', 'question__survey')
|
||||
|
||||
|
||||
admin.site.register(Survey, SurveyAdmin)
|
||||
admin.site.register(QuestionGroup, QuestionGroupAdmin)
|
||||
admin.site.register(Question, QuestionAdmin)
|
||||
admin.site.register(OfferedAnswer, OfferedAnswerAdmin)
|
145
anonsurvey/models.py
Normal file
145
anonsurvey/models.py
Normal file
|
@ -0,0 +1,145 @@
|
|||
from django.db import models
|
||||
from tinymce.models import HTMLField
|
||||
from django.utils.translation import ugettext_lazy as _
|
||||
from django.core.validators import RegexValidator
|
||||
from anonsurvey.validators import validate_regex, validate_question_answers
|
||||
from collections import OrderedDict
|
||||
from django.core.exceptions import ValidationError
|
||||
|
||||
|
||||
class Survey(models.Model):
|
||||
name = models.SlugField(max_length=128, verbose_name=_('Name'))
|
||||
title = models.CharField(max_length=128, verbose_name=_('Title'))
|
||||
active = models.BooleanField(default=False, verbose_name=_('Active'))
|
||||
intro = HTMLField(blank=False, null=False, verbose_name=_('Intro text'))
|
||||
mod_datetime = models.DateTimeField(auto_now=True,
|
||||
verbose_name=_('Modification'
|
||||
' DateTime'))
|
||||
|
||||
def question_or_group(self):
|
||||
foo = OrderedDict()
|
||||
for q in self.question_set.all():
|
||||
if not q.question_group:
|
||||
foo[(q.id, None)] = [q]
|
||||
else:
|
||||
key = (q.question_group.id, q.question_group)
|
||||
if not key in foo:
|
||||
foo[key] = [q]
|
||||
else:
|
||||
foo[key].append(q)
|
||||
spam = []
|
||||
for key in foo.iterkeys():
|
||||
keyval = key[1]
|
||||
spam.append((keyval, foo[key]))
|
||||
return spam
|
||||
|
||||
def __unicode__(self):
|
||||
return '{}: {}'.format(self.name, self.title)
|
||||
|
||||
class Meta:
|
||||
ordering = ['mod_datetime']
|
||||
verbose_name = _('Survey')
|
||||
verbose_name_plural = _('Surveys')
|
||||
|
||||
|
||||
class QuestionGroup(models.Model):
|
||||
survey = models.ForeignKey(Survey, verbose_name=_('Survey'))
|
||||
text = models.CharField(max_length=256, verbose_name=_('Text'))
|
||||
|
||||
def __unicode__(self):
|
||||
return '{}: {}'.format(self.survey, self.text)
|
||||
|
||||
class Meta:
|
||||
verbose_name = _('Question Group')
|
||||
verbose_name_plural = _('Question Groups')
|
||||
|
||||
|
||||
class Question(models.Model):
|
||||
QTYPE_INPUT = 'I'
|
||||
QTYPE_RADIO = 'R'
|
||||
QTYOE_CHECKBOX = 'C'
|
||||
QTYPE_RADIO_INPUT = 'RI'
|
||||
QTYPE_CHECKBOX_INPUT = 'CI'
|
||||
QUESTION_TYPES = (
|
||||
(QTYPE_INPUT, _('input')),
|
||||
(QTYPE_RADIO, _('choice')),
|
||||
(QTYOE_CHECKBOX, _('multiple choice')),
|
||||
(QTYPE_RADIO_INPUT, _('choice with input')),
|
||||
(QTYPE_CHECKBOX_INPUT, _('multiple choice with input')),
|
||||
)
|
||||
|
||||
survey = models.ForeignKey(Survey, verbose_name=_('Survey'))
|
||||
question_group = models.ForeignKey(QuestionGroup, null=True, blank=True,
|
||||
verbose_name=_('Question Group'))
|
||||
question_type = models.CharField(max_length=2, choices=QUESTION_TYPES,
|
||||
default='I', verbose_name=_('Type'))
|
||||
text = models.CharField(max_length=256, verbose_name=_('Text'))
|
||||
requires_answer = models.BooleanField(default=True,
|
||||
verbose_name=_('Requires Answer'))
|
||||
sort_index = models.PositiveIntegerField(default=1,
|
||||
verbose_name=_('Sort By Asc'))
|
||||
|
||||
def __unicode__(self):
|
||||
return '{}: {}'.format(self.survey, self.text)
|
||||
|
||||
def clean(self):
|
||||
if (self.question_group and
|
||||
self.survey.id != self.question_group.survey.id):
|
||||
raise ValidationError(_('Question group should belong to'
|
||||
' the same survey as this question'))
|
||||
|
||||
class Meta:
|
||||
ordering = ['sort_index']
|
||||
verbose_name = _('Question')
|
||||
verbose_name_plural = _('Questions')
|
||||
|
||||
|
||||
class OfferedAnswer(models.Model):
|
||||
ATYPE_INPUT = 'I'
|
||||
ATYPE_CHOICE = 'C'
|
||||
ANSWER_TYPES = (
|
||||
(ATYPE_INPUT, 'input'),
|
||||
(ATYPE_CHOICE, 'choice'),
|
||||
)
|
||||
|
||||
question = models.ForeignKey(Question, verbose_name=_('Question'))
|
||||
answer_type = models.CharField(max_length=1, choices=ANSWER_TYPES,
|
||||
default='C', verbose_name=_('Type'))
|
||||
prefix = models.CharField(max_length=128, null=True, blank=True,
|
||||
verbose_name=_('Text Prefix'))
|
||||
text = models.CharField(max_length=128, null=True, blank=True,
|
||||
verbose_name=_('Text'))
|
||||
sufix = models.CharField(max_length=128, null=True, blank=True,
|
||||
verbose_name=_('Text Sufix'))
|
||||
# for choice if has value then answer is selected by default
|
||||
default = models.CharField(max_length=128, null=True, blank=True,
|
||||
verbose_name=_('Default Value'))
|
||||
validation_format = models.CharField(max_length=256, null=True, blank=True,
|
||||
verbose_name=_('Validation Regex'),
|
||||
validators=[validate_regex])
|
||||
sort_index = models.PositiveIntegerField(default=1,
|
||||
verbose_name=_('Sort By Asc'))
|
||||
|
||||
def __unicode__(self):
|
||||
return '{}: {}: {}: {}'.format(self.answer_type, self.prefix,
|
||||
self.text, self.sufix)
|
||||
|
||||
def clean(self):
|
||||
validate_question_answers(self.question, self)
|
||||
|
||||
class Meta:
|
||||
ordering = ['sort_index']
|
||||
verbose_name = _('Offered Answer')
|
||||
verbose_name_plural = _('Offered Answers')
|
||||
|
||||
|
||||
class Answer(models.Model):
|
||||
client_id = models.CharField(max_length=256, verbose_name=_('Client ID'))
|
||||
datetime = models.DateTimeField(auto_now=True,
|
||||
verbose_name=_('DateTime'))
|
||||
answer = models.ForeignKey(OfferedAnswer, verbose_name=_('Offered Answer'))
|
||||
# entered text for inputs
|
||||
text = models.CharField(max_length=256, verbose_name=_('Entered Text'))
|
||||
|
||||
def __unicode__(self):
|
||||
return '{}: {}: {}'.format(self.client_id, self.answer, self.text)
|
6
anonsurvey/templates/anonsurvey/survey.html
Normal file
6
anonsurvey/templates/anonsurvey/survey.html
Normal file
|
@ -0,0 +1,6 @@
|
|||
{% extends "anonsurvey/survey_base.html" %}
|
||||
{% load i18n %}
|
||||
|
||||
{% block content %}
|
||||
{% include "anonsurvey/survey_form.html" with survey=survey %}
|
||||
{% endblock %}
|
13
anonsurvey/templates/anonsurvey/survey_base.html
Normal file
13
anonsurvey/templates/anonsurvey/survey_base.html
Normal file
|
@ -0,0 +1,13 @@
|
|||
{% load i18n %}
|
||||
<html>
|
||||
<head>
|
||||
<title>{% block title %}{% trans 'Surveys' %}{% endblock %}</title>
|
||||
{% block head %}{% endblock %}
|
||||
</head>
|
||||
<body>
|
||||
{% block breadcrumbs %}
|
||||
{% endblock %}
|
||||
{% block content %}
|
||||
{% endblock %}
|
||||
{% block pagination %}{% endblock %}
|
||||
</body>
|
134
anonsurvey/templates/anonsurvey/survey_form.html
Normal file
134
anonsurvey/templates/anonsurvey/survey_form.html
Normal file
|
@ -0,0 +1,134 @@
|
|||
{% load i18n %}
|
||||
{% load anonsurvey_extras %}
|
||||
|
||||
<div>
|
||||
{% if survey %}
|
||||
<h3>{{ survey.title }}</h3>
|
||||
<p>{{ survey.intro|safe }}</p>
|
||||
{% if error_messages %}
|
||||
<p>
|
||||
<ul>
|
||||
{% for err in error_messages %}
|
||||
<li><strong>{{ err }}</strong></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</p>
|
||||
{% endif %}
|
||||
<form action="{% url 'survey_complete' survey.id %}" method="post">
|
||||
{% csrf_token%}
|
||||
<ol>
|
||||
{% for qg in survey.question_or_group %}
|
||||
{% if qg.0 %}
|
||||
<li>{{ qg.0.text }}<br><ol>
|
||||
{% endif %}
|
||||
{% for q in qg.1 %}
|
||||
<li>
|
||||
{% if q.requires_answer %}<strong>*</strong>{% endif %} {{ q.text }}<br>
|
||||
<ul>
|
||||
{% for a in q.offeredanswer_set.all %}
|
||||
<li>
|
||||
{% if q.question_type == 'I' %}
|
||||
{{ a.prefix }} <input type="text" name="q{{ q.id }}" id="q{{ q.id }}{{ forloop.counter }}"
|
||||
{% with value=last_post|dictget:q.id %}
|
||||
{% if value %}
|
||||
value="{{ value.0 }}"
|
||||
{% elif a.default %}
|
||||
value="{{ a.default }}"
|
||||
{% endif %}
|
||||
{% endwith %}
|
||||
/> {{ a.sufix }} {% if a.validation_format %}(format: {{ a.validation_format }}){% endif %}
|
||||
{% elif q.question_type == 'R' %}
|
||||
<input type="radio" name="q{{ q.id }}" id="q{{ q.id }}{{ forloop.counter }}" value="{{ a.id }}"
|
||||
{% with value=last_post|dictget:q.id %}
|
||||
{% if value %}
|
||||
{% if value.0|add:"0" == a.id %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% elif a.default %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% endwith %}
|
||||
/> {{ a.text }}
|
||||
{% elif q.question_type == 'C' %}
|
||||
<input type="checkbox" name="q{{ q.id }}" id="q{{ q.id }}{{ forloop.counter }}" value="{{ a.id }}"
|
||||
{% with value=last_post|dictget:q.id %}
|
||||
{% if value %}
|
||||
{% if value.0|add:"0" == a.id %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% elif a.default %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% endwith %}
|
||||
/> {{ a.text }}
|
||||
{% elif q.question_type == 'RI' %}
|
||||
<input type="radio" name="q{{ q.id }}" id="q{{ q.id }}{{ forloop.counter }}" value="{{ a.id }}"
|
||||
{% with value=last_post|dictget:q.id %}
|
||||
{% if value %}
|
||||
{% if value.0|add:"0" == a.id %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% elif a.default %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% endwith %}
|
||||
/>
|
||||
{% if a.answer_type == 'I' %}
|
||||
{{ a.prefix }} <input type="text" name="q{{ q.id }}_value" id="q{{ q.id }}{{ forloop.counter }}_value"
|
||||
{% with key=q.id|add:"_value" %}
|
||||
{% with value=last_post|dictget:key %}
|
||||
{% if value %}
|
||||
value="{{ value.0 }}"
|
||||
{% elif a.default %}
|
||||
value="{{ a.default }}"
|
||||
{% endif %}
|
||||
{% endwith %}
|
||||
{% endwith %}
|
||||
/> {{ a.sufix }} {% if a.validation_format %}(format: {{ a.validation_format }}){% endif %}
|
||||
{% else %}
|
||||
{{ a.text }}
|
||||
{% endif %}
|
||||
{% elif q.question_type == 'CI' %}
|
||||
<input type="checkbox" name="q{{ q.id }}" id="q{{ q.id }}{{ forloop.counter }}" value="{{ a.id }}"
|
||||
{% with value=last_post|dictget:q.id %}
|
||||
{% if value %}
|
||||
{% if a.id|asstr in value %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% elif a.default %}
|
||||
checked="checked"
|
||||
{% endif %}
|
||||
{% endwith %}
|
||||
/>
|
||||
{% if a.answer_type == 'I' %}
|
||||
{% with key=q.id|add:"_value" %}
|
||||
{% with value=last_post|dictget:key %}
|
||||
{{ a.prefix }} <input type="text" name="q{{ q.id }}_value" id="q{{ q.id }}{{ forloop.counter }}_value"
|
||||
{% if value %}
|
||||
value="{{ value.0 }}"
|
||||
{% elif a.default %}
|
||||
value="{{ a.default }}"
|
||||
{% endif %}
|
||||
/> {{ a.sufix }} {% if a.validation_format %}(format: {{ a.validation_format }}){% endif %}
|
||||
{% endwith %}
|
||||
{% endwith %}
|
||||
{% else %}
|
||||
{{ a.text }}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</li>
|
||||
{% endfor %}
|
||||
{% if qg.0 %}
|
||||
</li></ol>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ol>
|
||||
<input type="submit" name="submit" value="{% trans 'Send' %}"/>
|
||||
</form>
|
||||
{% else %}
|
||||
{% trans 'No survey' %}
|
||||
{% endif %}
|
||||
</div>
|
6
anonsurvey/templates/anonsurvey/survey_thanks.html
Normal file
6
anonsurvey/templates/anonsurvey/survey_thanks.html
Normal file
|
@ -0,0 +1,6 @@
|
|||
{% extends "anonsurvey/survey_base.html" %}
|
||||
{% load i18n %}
|
||||
|
||||
{% block content %}
|
||||
{% trans 'Thanks for completing survey' %}
|
||||
{% endblock %}
|
14
anonsurvey/templates/anonsurvey/surveys.html
Normal file
14
anonsurvey/templates/anonsurvey/surveys.html
Normal file
|
@ -0,0 +1,14 @@
|
|||
{% extends "anonsurvey/survey_base.html" %}
|
||||
{% load i18n %}
|
||||
|
||||
{% block content %}
|
||||
{% if surveys %}
|
||||
<ul>
|
||||
{% for s in surveys %}
|
||||
<li><a href="{% url 'survey' s.name %}">{{ s.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% else %}
|
||||
{% trans 'No surveys' %}
|
||||
{% endif %}
|
||||
{% endblock %}
|
0
anonsurvey/templatetags/__init__.py
Normal file
0
anonsurvey/templatetags/__init__.py
Normal file
18
anonsurvey/templatetags/anonsurvey_extras.py
Normal file
18
anonsurvey/templatetags/anonsurvey_extras.py
Normal file
|
@ -0,0 +1,18 @@
|
|||
from django import template
|
||||
|
||||
|
||||
def dictget(value, arg):
|
||||
if not isinstance(value, dict):
|
||||
foo = value
|
||||
else:
|
||||
foo = value.get(str(arg))
|
||||
return foo
|
||||
|
||||
|
||||
def asstr(value):
|
||||
return str(value)
|
||||
|
||||
|
||||
register = template.Library()
|
||||
register.filter('dictget', dictget)
|
||||
register.filter('asstr', asstr)
|
16
anonsurvey/tests.py
Normal file
16
anonsurvey/tests.py
Normal file
|
@ -0,0 +1,16 @@
|
|||
"""
|
||||
This file demonstrates writing tests using the unittest module. These will pass
|
||||
when you run "manage.py test".
|
||||
|
||||
Replace this with more appropriate tests for your application.
|
||||
"""
|
||||
|
||||
from django.test import TestCase
|
||||
|
||||
|
||||
class SimpleTest(TestCase):
|
||||
def test_basic_addition(self):
|
||||
"""
|
||||
Tests that 1 + 1 always equals 2.
|
||||
"""
|
||||
self.assertEqual(1 + 1, 2)
|
16
anonsurvey/urls.py
Normal file
16
anonsurvey/urls.py
Normal file
|
@ -0,0 +1,16 @@
|
|||
from django.conf.urls import patterns, url
|
||||
from anonsurvey import views
|
||||
from django.views.generic import TemplateView
|
||||
|
||||
|
||||
urlpatterns = patterns(
|
||||
'',
|
||||
url(r'^$', views.SurveysView.as_view(), name='surveys'),
|
||||
url(r'^survey_thanks/$',
|
||||
TemplateView.as_view(template_name='anonsurvey/survey_thanks.html'),
|
||||
name='survey_thanks'),
|
||||
url(r'^(?P<slug>[\w-]+)/form/$', views.SurveyView.as_view(),
|
||||
name='survey'),
|
||||
url(r'^(?P<pk>\d+)/complete/$', views.complete_survey,
|
||||
name="survey_complete"),
|
||||
)
|
23
anonsurvey/utils.py
Normal file
23
anonsurvey/utils.py
Normal file
|
@ -0,0 +1,23 @@
|
|||
PRIVATE_IPS_PREFIX = ('10.', '172.', '192.', )
|
||||
|
||||
def get_client_ip(request):
|
||||
"""get the client ip from the request
|
||||
"""
|
||||
remote_address = request.META.get('REMOTE_ADDR')
|
||||
# set the default value of the ip to be the REMOTE_ADDR if available
|
||||
# else None
|
||||
ip = remote_address
|
||||
# try to get the first non-proxy ip (not a private ip) from the
|
||||
# HTTP_X_FORWARDED_FOR
|
||||
x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR')
|
||||
if x_forwarded_for:
|
||||
proxies = x_forwarded_for.split(',')
|
||||
# remove the private ips from the beginning
|
||||
while (len(proxies) > 0 and
|
||||
proxies[0].startswith(PRIVATE_IPS_PREFIX)):
|
||||
proxies.pop(0)
|
||||
# take the first ip which is not a private one (of a proxy)
|
||||
if len(proxies) > 0:
|
||||
ip = proxies[0]
|
||||
|
||||
return ip
|
26
anonsurvey/validators.py
Normal file
26
anonsurvey/validators.py
Normal file
|
@ -0,0 +1,26 @@
|
|||
from django.core.exceptions import ValidationError
|
||||
from django.utils.translation import ugettext_lazy as _
|
||||
import re
|
||||
|
||||
|
||||
def validate_regex(value):
|
||||
try:
|
||||
re.compile(value)
|
||||
except re.error as err:
|
||||
raise ValidationError('"{}" is not a valid regex: {}'.format(value,
|
||||
err))
|
||||
|
||||
|
||||
def validate_question_answers(question, answer):
|
||||
if not question or not answer:
|
||||
return
|
||||
cnt = 0
|
||||
for answer in question.offeredanswer_set.all():
|
||||
if answer.answer_type == 'I':
|
||||
cnt += 1
|
||||
if answer.id is None and answer.answer_type == 'I':
|
||||
cnt += 1
|
||||
if question.question_type in ('CI', 'RI') and cnt > 1:
|
||||
raise ValidationError(_('Choice with input and multiple choice with'
|
||||
' input type of question cannot have more than'
|
||||
' one input type of answer'))
|
149
anonsurvey/views.py
Normal file
149
anonsurvey/views.py
Normal file
|
@ -0,0 +1,149 @@
|
|||
from anonsurvey.models import Survey, Question, QuestionGroup,\
|
||||
OfferedAnswer, Answer
|
||||
from django.views import generic
|
||||
from django.conf import settings
|
||||
from django.shortcuts import get_object_or_404, render_to_response
|
||||
from django.core.urlresolvers import reverse
|
||||
from django.http import HttpResponseRedirect, HttpResponse
|
||||
from django.template import RequestContext
|
||||
import re
|
||||
from django.utils.translation import ugettext_lazy as _
|
||||
import time
|
||||
from django.views.decorators.http import require_POST
|
||||
from anonsurvey import utils
|
||||
|
||||
|
||||
class SurveysView(generic.ListView):
|
||||
template_name = 'anonsurvey/surveys.html'
|
||||
context_object_name = 'surveys'
|
||||
paginate_by = settings.SURVEYS_PAGE_SIZE
|
||||
|
||||
def get_queryset(self):
|
||||
return Survey.objects.filter(active=True).order_by(
|
||||
'mod_datetime')
|
||||
|
||||
|
||||
class SurveyView(generic.DetailView):
|
||||
model = Survey
|
||||
slug_field = 'name'
|
||||
template_name = 'anonsurvey/survey.html'
|
||||
|
||||
def get_queryset(self):
|
||||
survey = super(SurveyView, self).get_queryset()
|
||||
return survey.filter(active=True)
|
||||
|
||||
|
||||
def value_matches(pattern, value):
|
||||
if not pattern:
|
||||
return True
|
||||
pattern = '^{}$'.format(pattern)
|
||||
return re.match(pattern, value)
|
||||
|
||||
|
||||
@require_POST
|
||||
def complete_survey(request, pk):
|
||||
survey = get_object_or_404(Survey, pk=pk)
|
||||
error_messages = []
|
||||
last_post = {}
|
||||
if not survey.active:
|
||||
error_messages.append(_('Survey is no longer active'))
|
||||
questions = []
|
||||
else:
|
||||
questions = survey.question_set.all()
|
||||
# build last_post data dict
|
||||
for key in request.POST:
|
||||
if key.startswith('q'):
|
||||
value = request.POST.getlist(key)
|
||||
key = key[1:]
|
||||
last_post[key] = value
|
||||
# generate unique client_id
|
||||
while True:
|
||||
client_id = str(time.time())
|
||||
existing_answers = Answer.objects.filter(client_id=client_id)
|
||||
if not existing_answers:
|
||||
break
|
||||
time.sleep(0.001)
|
||||
client_id = '{}@{}'.format(client_id, utils.get_client_ip(request))
|
||||
client_answers = []
|
||||
# parse, validate and collect answers
|
||||
# if survey is inactive questions is empty list (see above)
|
||||
for question in questions:
|
||||
post_name = 'q{}'.format(question.id)
|
||||
if post_name in request.POST:
|
||||
post_value = request.POST.getlist(post_name)
|
||||
# remove empty strings (can get for inputs)
|
||||
for x in post_value:
|
||||
if not x:
|
||||
post_value.remove(x)
|
||||
else:
|
||||
post_value = None
|
||||
if question.requires_answer and not post_value:
|
||||
error_messages.append(_('Question "{}" requires answer').format(
|
||||
question.text))
|
||||
else:
|
||||
if question.question_type in ('R', 'C', 'RI', 'CI'):
|
||||
for a_id in post_value:
|
||||
spam = get_object_or_404(OfferedAnswer, pk=int(a_id))
|
||||
# collect choice answers that are not input for RI and CI
|
||||
if ((question.question_type in ('RI', 'CI') and
|
||||
spam.answer_type != 'I') or
|
||||
(question.question_type in ('R', 'C'))):
|
||||
clanswer = Answer()
|
||||
clanswer.client_id = client_id
|
||||
clanswer.answer = spam
|
||||
client_answers.append(clanswer)
|
||||
if (question.question_type == 'RI' or
|
||||
question.question_type == 'CI'):
|
||||
answers = question.offeredanswer_set.filter(answer_type='I')
|
||||
alen = len(answers)
|
||||
if alen > 1:
|
||||
error_messages.append(_('Invalid form'))
|
||||
elif alen < 1:
|
||||
oanswer = None
|
||||
else:
|
||||
oanswer = answers[0]
|
||||
if oanswer and str(oanswer.id) in post_value:
|
||||
# get input value for choice input
|
||||
input_name = 'q{}_value'.format(question.id)
|
||||
if input_name in request.POST:
|
||||
post_value = request.POST[input_name]
|
||||
if not post_value:
|
||||
oanswer = None
|
||||
validate_input_value = False
|
||||
else:
|
||||
validate_input_value = True
|
||||
clanswer = Answer()
|
||||
clanswer.client_id = client_id
|
||||
clanswer.answer = oanswer
|
||||
clanswer.text = post_value
|
||||
client_answers.append(clanswer)
|
||||
else:
|
||||
validate_input_value = False
|
||||
elif question.question_type == 'I':
|
||||
validate_input_value = True
|
||||
oanswer = question.offeredanswer_set.all()[0]
|
||||
post_value = post_value[0]
|
||||
clanswer = Answer()
|
||||
clanswer.client_id = client_id
|
||||
clanswer.answer = oanswer
|
||||
clanswer.text = post_value
|
||||
client_answers.append(clanswer)
|
||||
else:
|
||||
validate_input_value = False
|
||||
if validate_input_value and oanswer:
|
||||
pattern = oanswer.validation_format
|
||||
if not value_matches(pattern, post_value):
|
||||
error_messages.append(
|
||||
_('Answer for question "{}" must be in '
|
||||
'format "{}"').format(question.text, pattern))
|
||||
if error_messages:
|
||||
resp_dict = {
|
||||
'survey': survey,
|
||||
'error_messages': error_messages,
|
||||
'last_post': last_post,
|
||||
}
|
||||
return render_to_response(SurveyView.template_name, resp_dict,
|
||||
context_instance=RequestContext(request))
|
||||
for clanswer in client_answers:
|
||||
clanswer.save()
|
||||
return HttpResponseRedirect(reverse('survey_thanks'))
|
34
setup.py
Normal file
34
setup.py
Normal file
|
@ -0,0 +1,34 @@
|
|||
import os
|
||||
from setuptools import setup
|
||||
|
||||
README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
|
||||
|
||||
# allow setup.py to be run from any path
|
||||
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
|
||||
|
||||
setup(
|
||||
name='django-anonsurvey',
|
||||
version='0.1',
|
||||
packages=['anonsurvey'],
|
||||
include_package_data=True,
|
||||
license='GPLv3', # example license
|
||||
description='A Django app to create Web-based anonymous surveys',
|
||||
long_description=README,
|
||||
install_requires=["django-tinymce", "Django-tinymce-filebrowser"],
|
||||
url='https://github.com/darko-poljak/django-anonsurvey',
|
||||
author='Darko Poljak',
|
||||
author_email='darko.poljak@gmail.com',
|
||||
classifiers=[
|
||||
'Environment :: Web Environment',
|
||||
'Framework :: Django',
|
||||
'Intended Audience :: Developers',
|
||||
'License :: OSI Approved :: GPLv3', # example license
|
||||
'Operating System :: OS Independent',
|
||||
'Programming Language :: Python',
|
||||
'Programming Language :: Python :: 2.6',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Programming Language :: Python :: 3.3',
|
||||
'Topic :: Internet :: WWW/HTTP',
|
||||
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
|
||||
],
|
||||
)
|
Loading…
Reference in a new issue