--- /dev/null
+*~
+*.orig
+*.log
+
+# Python garbage
+*.pyc
+.coverage
+pip-log.txt
+nosetests.xml
+build
+dist
+*.egg-info
+
+# Mac OS X garbage
+.DS_Store
+
+# Windows garbage
+thumbs.db
+
+# Eclipse
+.project
+.settings
+.pydevproject
+.tmp_*
+
+# Tags file
+TAGS
+
--- /dev/null
+ 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/>.
\ No newline at end of file
--- /dev/null
+include LICENSE
+include README.md
+recursive-include ssify/templates *.html
+recursive-include tests/templates *.html
--- /dev/null
+License
+-------
+
+ 
+
+ Copyright © 2014 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
+
+ For full list of contributors see AUTHORS section at the end.
+
+ 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/>.
+
+
+Dependencies
+============
+
+ * Python >= 2.7
+ * Django >= 1.6
+
+
+Installation
+============
+
+1. Add 'ssify' to INSTALLES_APPS.
+2. Add middleware classes:
+ * ssify.middleware.SsifyMiddleware on top,
+ * if using UpdateCacheMiddleware, add
+ ssify.middleware.PrepareForCacheMiddleware after it,
+ * ssify.middleware.LocaleMiddleware instead of stock LocaleMiddleware.
+3. Make sure you have 'django.core.context_processors.request' in your
+ TEMPLATE_CONTEXT_PROCESSORS.
+3. Define your caches in CACHES and SSIFY_INCLUDES_CACHES
+ for storing ssi includes.
+4. Configure your webserver to use SSI ('ssi=on' with Nginx).
+
+Usage
+=====
+
+1. Define your included urls using the @ssi_included decorator.
+2. Define your ssi variables using the @ssi_variable decorator.
+
+
+Authors
+=======
+
+* Radek Czajka <radekczajka@nowoczesnapolska.org.pl>
+
--- /dev/null
+#!/usr/bin/env python
+import sys
+import os
+from os.path import dirname, abspath
+from optparse import OptionParser
+
+from django.conf import settings, global_settings
+
+# For convenience configure settings if they are not pre-configured or if we
+# haven't been provided settings to use by environment variable.
+if not settings.configured and not os.environ.get('DJANGO_SETTINGS_MODULE'):
+ settings.configure(
+ CACHES={
+ 'default': {'BACKEND':
+ 'django.core.cache.backends.locmem.LocMemCache'},
+ 'ssify': {'BACKEND':
+ 'django.core.cache.backends.locmem.LocMemCache'},
+ },
+ DATABASES={
+ 'default': {
+ 'ENGINE': 'django.db.backends.sqlite3',
+ }
+ },
+ INSTALLED_APPS=[
+ 'django.contrib.auth',
+ 'django.contrib.contenttypes',
+ 'django.contrib.sessions',
+ 'django.contrib.sites',
+
+ 'ssify',
+ 'tests',
+ ],
+ MEDIA_URL='/media/',
+ MIDDLEWARE_CLASSES=[
+ 'ssify.middleware.SsiMiddleware',
+ 'django.middleware.cache.UpdateCacheMiddleware',
+ 'ssify.middleware.PrepareForCacheMiddleware',
+ 'django.middleware.common.CommonMiddleware',
+ 'django.middleware.cache.FetchFromCacheMiddleware',
+ ],
+ STATIC_URL='/static/',
+ ROOT_URLCONF='tests.urls',
+ SITE_ID=1,
+ SSIFY_DEBUG_VERBOSE=False,
+ TEMPLATE_CONTEXT_PROCESSORS=(
+ "django.core.context_processors.debug",
+ "django.core.context_processors.i18n",
+ "django.core.context_processors.tz",
+ "django.core.context_processors.request",
+ ),
+ )
+
+from django.test.simple import DjangoTestSuiteRunner
+
+
+def runtests(*test_args, **kwargs):
+ if 'south' in settings.INSTALLED_APPS:
+ from south.management.commands import patch_for_test_db_setup
+ patch_for_test_db_setup()
+
+ if not test_args:
+ test_args = ['tests']
+ parent = dirname(abspath(__file__))
+ sys.path.insert(0, parent)
+ test_runner = DjangoTestSuiteRunner(
+ verbosity=kwargs.get('verbosity', 1),
+ interactive=kwargs.get('interactive', False),
+ failfast=kwargs.get('failfast'))
+ failures = test_runner.run_tests(test_args)
+ sys.exit(failures)
+
+if __name__ == '__main__':
+ parser = OptionParser()
+ parser.add_option('--failfast', action='store_true',
+ default=False, dest='failfast')
+
+ (options, args) = parser.parse_args()
+
+ runtests(failfast=options.failfast, *args)
--- /dev/null
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+#
+from setuptools import setup, find_packages
+
+setup(
+ name='django-ssify',
+ version='0.1',
+ author='Radek Czajka',
+ author_email='radekczajka@nowoczesnapolska.org.pl',
+ url='',
+ packages=find_packages(exclude=['tests*']),
+ license='LICENSE',
+ description='Two-phased rendering using SSI.',
+ long_description=open('README.md').read(),
+ test_suite="runtests.runtests",
+ classifiers=[
+ "Development Status :: 3 - Alpha",
+ "Environment :: Web Environment",
+ "Framework :: Django",
+ "Intended Audience :: Developers",
+ "Intended Audience :: System Administrators",
+ "License :: OSI Approved :: GNU Affero General Public License v3",
+ "Programming Language :: Python",
+ "Topic :: Internet :: WWW/HTTP",
+ "Topic :: Software Development :: Code Generators",
+ ]
+)
--- /dev/null
+"""
+Implements two-phase rendering using SSI statements.
+
+Define reqest-dependent SSI variables to use as template tags
+with `ssi_variable` decorator.
+
+Define views to be cached and included as SSI include
+with `ssi_included` decorator.
+
+"""
+
+__version__ = '1.0'
+__date__ = '2014-08-26'
+__all__ = ('ssi_expect', 'SsiVariable', 'ssi_included', 'ssi_variable')
+
+from django.conf import settings
+from django.utils.functional import lazy
+
+SETTING = lazy(
+ lambda name, default: getattr(settings, name, default),
+ bool, int, list, tuple, unicode)
+
+INCLUDES_CACHES = SETTING('SSIFY_INCLUDES_CACHES', ('ssify',))
+DEBUG = SETTING('SSIFY_DEBUG', False)
+DEBUG_VERBOSE = SETTING('SSIFY_DEBUG_VERBOSE', True)
+
+
+from .variables import ssi_expect, SsiVariable
+from .decorators import ssi_included, ssi_variable
--- /dev/null
+import os
+from django.core.cache.backends.filebased import FileBasedCache
+
+
+class StaticFileBasedCache(FileBasedCache):
+ def __init__(self, *args, **kwargs):
+ super(StaticFileBasedCache, self).__init__(*args, **kwargs)
+ self._dir = os.path.abspath(self._dir)
+
+ def make_key(self, key, version=None):
+ assert version is None, \
+ 'StaticFileBasedCache does not support versioning.'
+ return key
+
+ def _key_to_file(self, key):
+ key = os.path.abspath(os.path.join(self._dir, key.lstrip('/')))
+ assert key.startswith(self._dir), 'Trying to save path outside root.'
+ if key.endswith('/'):
+ key += 'index.html'
+ return key
+
+ def get(self, key, default=None, version=None):
+ key = self.make_key(key, version=version)
+ self.validate_key(key)
+ fname = self._key_to_file(key)
+ try:
+ with open(fname, 'rb') as inf:
+ return inf.read()
+ except (IOError, OSError):
+ pass
+ return default
+
+ def set(self, key, value, timeout=None, version=None):
+ assert timeout is None, \
+ 'StaticFileBasedCache does not support timeouts.'
+ key = self.make_key(key, version=version)
+ self.validate_key(key)
+ fname = self._key_to_file(key)
+ dirname = os.path.dirname(fname)
+ try:
+ if not os.path.exists(dirname):
+ os.makedirs(dirname)
+ with open(fname, 'wb') as outf:
+ outf.write(value)
+ except (IOError, OSError):
+ pass
--- /dev/null
+import functools
+from inspect import getargspec
+import warnings
+from django.template.base import parse_bits
+from django.utils.translation import get_language, activate
+from .store import cache_include
+from . import exceptions
+from .variables import SsiVariable
+
+
+def ssi_included(view=None, use_lang=True, get_ssi_vars=None):
+ """
+ Marks a view to be used as a snippet to be included with SSI.
+
+ If use_lang is True (which is default), the URL pattern for such
+ a view must provide a keyword argument named 'lang' for language.
+ SSI included views don't use language or content negotiation, so
+ everything they need to know has to be included in the URL.
+
+ get_ssi_vars should be a callable which takes the view's arguments
+ and returns the names of SSI variables it uses.
+
+ """
+ def dec(view):
+ @functools.wraps(view)
+ def new_view(request, *args, **kwargs):
+ if use_lang:
+ try:
+ lang = kwargs.pop('lang')
+ except KeyError:
+ raise exceptions.NoLangFieldError(request)
+ current_lang = get_language()
+ activate(lang)
+ response = view(request, *args, **kwargs)
+ if use_lang:
+ activate(current_lang)
+ if response.status_code == 200:
+ request._cache_update_cache = False
+
+ def _check_included_vars(response):
+ used_vars = request.ssi_vars_needed
+ if get_ssi_vars:
+ # Remove the ssi vars that should be provided
+ # by the including view.
+ pass_vars = set(get_ssi_vars(*args, **kwargs))
+
+ for var in pass_vars:
+ if not isinstance(var, SsiVariable):
+ var = SsiVariable(*var)
+ try:
+ del used_vars[var.name]
+ except KeyError:
+ warnings.warn(
+ exceptions.UnusedSsiVarsWarning(
+ request, var))
+ if used_vars:
+ raise exceptions.UndeclaredSsiVarsError(
+ request, used_vars)
+ request.ssi_vars_needed = {}
+
+ # Don't use default django response caching for this view,
+ # just save the contents instead.
+ cache_include(request.path, response.content)
+
+ if hasattr(response, 'render') and callable(response.render):
+ response.add_post_render_callback(_check_included_vars)
+ else:
+ _check_included_vars(response)
+
+ return response
+
+ # Remember get_ssi_vars so that in can be computed from args/kwargs
+ # by including view.
+ new_view.get_ssi_vars = get_ssi_vars
+ return new_view
+ return dec(view) if view else dec
+
+
+def ssi_variable(register, vary=None, name=None):
+ # Cache control?
+ def dec(func):
+ # Find own path.
+ function_name = (name or
+ getattr(func, '_decorated_function', func).__name__)
+ lib_name = func.__module__.rsplit('.', 1)[-1]
+ tagpath = "%s.%s" % (lib_name, function_name)
+ # Make sure the function takes request parameter.
+ params, varargs, varkw, defaults = getargspec(func)
+ assert params and params[0] == 'request', '%s is decorated with '\
+ 'request_info_tag, so it must take `request` for '\
+ 'its first argument.' % (tagpath)
+
+ @register.tag(name=function_name)
+ def _ssi_var_tag(parser, token):
+ """
+ Creates a SSI variable reference for a request-dependent info.
+
+ Use as:
+ {% ri_tag args... %}
+ or:
+ {% ri_tag args... as variable %}
+ {{ variable.if }}
+ {{ variable }}, or
+ {% ssi_include 'some-snippet' variable %}
+ {{ variable.else }}
+ Default text
+ {{ variable.endif }}
+
+ """
+ bits = token.split_contents()[1:]
+
+ # Is it the 'as' form?
+ if len(bits) >= 2 and bits[-2] == 'as':
+ asvar = bits[-1]
+ bits = bits[:-2]
+ else:
+ asvar = None
+
+ # Parse the arguments like Django's generic tags do.
+ args, kwargs = parse_bits(parser, bits,
+ ['context'] + params[1:], varargs, varkw,
+ defaults, takes_context=True,
+ name=function_name)
+ return SsiVariableNode(tagpath, args, kwargs, vary, asvar)
+ _ssi_var_tag.get_value = func
+ #return _ssi_var_tag
+ return func
+
+ return dec
+
+
+from .variables import SsiVariableNode
--- /dev/null
+class SsifyError(BaseException):
+ pass
+
+
+class SsifyWarning(Warning):
+ pass
+
+
+class UndeclaredSsiVarsError(SsifyError):
+ def __init__(self, request, ssi_vars):
+ super(UndeclaredSsiVarsError, self).__init__(request, ssi_vars)
+
+ def __str__(self):
+ request = self.args[0]
+ view = request.resolver_match.func
+ return "The view '%s.%s' at '%s' is marked as `ssi_included`, "\
+ "but it uses ssi variables not declared in `get_ssi_vars` "\
+ "argument: %s. " % (
+ view.__module__, view.__name__, request.path,
+ repr(self.args[1]))
+
+
+class UnusedSsiVarsWarning(SsifyWarning):
+ def __init__(self, request, ssi_vars):
+ super(UnusedSsiVarsWarning, self).__init__(request, ssi_vars)
+
+ def __str__(self):
+ request = self.args[0]
+ view = request.resolver_match.func
+ return "The `ssi_included` view '%s.%s' at '%s' declares "\
+ "using SSI variables %s but it looks like they're not "\
+ "really used. " % (
+ view.__module__, view.__name__, request.path, self.args[1])
+
+
+class UndeclaredSsiRefError(SsifyError):
+ def __init__(self, request, var, ref_name):
+ super(UndeclaredSsiRefError, self).__init__(request, var, ref_name)
+
+ def __str__(self):
+ request = self.args[0]
+ view = request.resolver_match.func
+ return "Error while rendering ssi_included view '%s.%s' at '%s': "\
+ "SSI variable %s references variable %s, which doesn't match "\
+ "any variable declared in `get_ssi_vars`. " % (
+ view.__module__, view.__name__, request.path,
+ repr(self.args[1]), self.args[2])
+
+
+class NoLangFieldError(SsifyError):
+ def __init__(self, request):
+ super(NoLangFieldError, self).__init__(request)
+
+ def __str__(self):
+ request = self.args[0]
+ view = request.resolver_match.func
+ return "The view '%s.%s' at '%s' is marked as `ssi_included` "\
+ "with use_lang=True, but its URL match doesn't provide "\
+ "a 'lang' keyword argument for language. " % (
+ view.__module__, view.__name__, request.path)
+
+
+class SsiVarsDependencyCycleError(SsifyError):
+ def __init__(self, ssi_vars):
+ super(SsiVarsDependencyCycleError, self).__init__(ssi_vars)
+
+ def __str__(self):
+ return "Dependency cycle in SSI variables: %s." % self.args[0]
--- /dev/null
+# -*- coding: utf-8 -*-
+# This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+#
+from optparse import make_option
+from django.core.management.base import BaseCommand
+
+
+class Command(BaseCommand):
+ option_list = BaseCommand.option_list + (
+ )
+ help = 'Dumps configuration for NGINX.'
+
+ def handle(self, **options):
+ pass
--- /dev/null
+from django.conf import settings
+from django.utils.cache import patch_vary_headers
+from django.middleware import locale
+from .serializers import json_decode, json_encode
+from .variables import SsiVariable, provide_vars
+from . import DEBUG
+
+
+class PrepareForCacheMiddleware(object):
+ @staticmethod
+ def process_response(request, response):
+ if getattr(request, 'ssi_vars_needed', None):
+ vars_needed = {k: v.definition
+ for (k, v) in request.ssi_vars_needed.items()}
+ response['X-Ssi-Vars-Needed'] = json_encode(
+ vars_needed, sort_keys=True)
+ return response
+
+
+class SsiMiddleware(object):
+ def process_request(self, request):
+ request.ssi_vary = set()
+ #request.ssi_cache_control_after = set()
+
+ def process_view(self, request, view_func, view_args, view_kwargs):
+ request.ssi_vars_needed = {}
+
+ def _process_rendered_response(self, request, response):
+ # Prepend the SSI variables.
+ if hasattr(request, 'ssi_vars_needed'):
+ vars_needed = request.ssi_vars_needed
+ else:
+ vars_needed = json_decode(response.get('X-Ssi-Vars-Needed', '{}'))
+ vars_needed = {k: SsiVariable(*v)
+ for (k, v) in vars_needed.items()}
+
+ if vars_needed:
+ response.content = provide_vars(request, vars_needed) + \
+ response.content
+
+ # Add the Vary headers declared by all the SSI vars.
+ patch_vary_headers(response, sorted(request.ssi_vary))
+ # TODO: cache control?
+
+ # With a cached response, CsrfViewMiddleware.process_response
+ # was never called, so if we used the csrf token, we must do
+ # its job of setting the csrf token cookie on our own.
+ if (not getattr(request, 'csrf_processing_done', False)
+ and request.META.get("CSRF_COOKIE_USED", False)):
+ response.set_cookie(settings.CSRF_COOKIE_NAME,
+ request.META["CSRF_COOKIE"],
+ max_age=getattr(settings, 'CSRF_COOKIE_AGE',
+ 60 * 60 * 24 * 7 * 52),
+ domain=settings.CSRF_COOKIE_DOMAIN,
+ path=settings.CSRF_COOKIE_PATH,
+ secure=settings.CSRF_COOKIE_SECURE,
+ httponly=settings.CSRF_COOKIE_HTTPONLY
+ )
+ request.csrf_processing_done = True
+
+ def process_response(self, request, response):
+ if hasattr(response, 'render') and callable(response.render):
+ response.add_post_render_callback(
+ lambda r: self._process_rendered_response(request, r)
+ )
+ else:
+ self._process_rendered_response(request, response)
+
+ if DEBUG:
+ from .middleware_debug import DebugUnSsiMiddleware
+ response = DebugUnSsiMiddleware().process_response(
+ request, response)
+
+ return response
+
+
+class LocaleMiddleware(locale.LocaleMiddleware):
+ """
+ Version of the LocaleMiddleware for use together with the
+ SsiMiddleware if USE_I18N or USE_L10N is set.
+
+ Stock LocaleMiddleware looks for user language selection in
+ the session data and cookies, before it falls back to parsing
+ Accept-Language. The effect of accessing the session is adding
+ the `Vary: Cookie` header to the response. While this is correct
+ behaviour, it renders the cache system useless (see
+ https://code.djangoproject.com/ticket/13217).
+
+ This version of LocaleMiddleware doesn't mark the session
+ as accessed on every request, so SessionMiddleware doesn't add the
+ Vary: Cookie header (unless something else actually uses the session
+ in a meaningful way, of course). Instead, it tells SsiMiddleware
+ to add the Vary: Cookie header to the final response.
+
+ """
+ def process_request(self, request):
+ if hasattr(request, 'session'):
+ session_accessed_before = request.session.accessed
+ else:
+ session_accessed_before = None
+ super(LocaleMiddleware, self).process_request(request)
+ if session_accessed_before is False:
+ if (request.session.accessed and
+ (settings.USE_I18N or settings.USE_L10N)):
+ request.session.accessed = False
+ request.ssi_vary.add('Cookie')
--- /dev/null
+"""
+This module should only be used for debugging SSI statements.
+
+Using DebugUnSsiMiddleware in production defeats the purpose of using SSI
+in the first place, and is unsafe. You should use a proper webserver with SSI
+support as a proxy (i.e. Nginx with ssi=on).
+
+"""
+import re
+import urlparse
+from django.core.urlresolvers import resolve
+from ssify import DEBUG_VERBOSE
+
+
+SSI_SET = re.compile(r"<!--#set var='(?P<var>[^']+)' "
+ r"value='(?P<value>|\\\\|.*?[^\\](?:\\\\)*)'-->", re.S)
+SSI_ECHO = re.compile(r"<!--#echo var='(?P<var>[^']+)' encoding='none'-->")
+SSI_INCLUDE = re.compile(r"<!--#include (?:virtual|file)='(?P<path>[^']+)'-->")
+SSI_IF = re.compile(r"(?P<header><!--#if expr='(?P<expr>[^']*)'-->)"
+ r"(?P<value>.*?)(?:<!--#else-->(?P<else>.*?))?"
+ r"<!--#endif-->", re.S)
+ # TODO: escaped?
+SSI_VAR = re.compile(r"\$\{(?P<var>.+)\}") # TODO: escaped?
+
+
+class DebugUnSsiMiddleware(object):
+ """
+ Emulates a webserver with SSI support.
+
+ This middleware should only be used for debugging purposes.
+ SsiMiddleware will enable it automatically, if SSIFY_DEBUG setting
+ is set to True, so you don't normally need to include it in
+ MIDDLEWARE_CLASSES.
+
+ If SSIFY_DEBUG_VERBOSE setting is True, it will also leave some
+ information in HTML comments.
+
+ """
+ @staticmethod
+ def _process_rendered_response(request, response):
+ """Recursively process SSI statements in the response."""
+ def ssi_include(match):
+ """Replaces SSI include with contents rendered by relevant view."""
+ path = process_value(match.group('path'))
+ func, args, kwargs = resolve(path)
+ parsed = urlparse.urlparse(path)
+ request.META['PATH_INFO'] = request.path_info = \
+ request.path = parsed.path
+ request.META['QUERY_STRING'] = parsed.query
+ content = func(request, *args, **kwargs).content
+ content = process_content(content)
+ if DEBUG_VERBOSE:
+ return "".join((
+ match.group(0),
+ content,
+ match.group(0).replace('<!--#', '<!--#end-'),
+ ))
+ else:
+ return content
+
+ def ssi_set(match):
+ """Interprets SSI set statement."""
+ variables[match.group('var')] = match.group('value')
+ if DEBUG_VERBOSE:
+ return match.group(0)
+ else:
+ return ""
+
+ def ssi_echo(match):
+ """Interprets SSI echo, outputting the value of the variable."""
+ content = variables[match.group('var')]
+ if DEBUG_VERBOSE:
+ return "".join((
+ match.group(0),
+ content,
+ match.group(0).replace('<!--#', '<!--#end-'),
+ ))
+ else:
+ return content
+
+ def ssi_if(match):
+ """Interprets SSI if statement."""
+ expr = process_value(match.group('expr'))
+ if expr:
+ content = match.group('value')
+ else:
+ content = match.group('else')
+ if DEBUG_VERBOSE:
+ return "".join((
+ match.group('header'),
+ content,
+ match.group('header').replace('<!--#', '<!--#end-'),
+ ))
+ else:
+ return content
+
+ def ssi_var(match):
+ """Resolves ${var}-style variable reference."""
+ return variables[match.group('var')]
+
+ def process_value(content):
+ """Resolves any ${var}-style variable references in the content."""
+ return re.sub(SSI_VAR, ssi_var, content)
+
+ def process_content(content):
+ """Interprets SSI statements in the content."""
+ content = re.sub(SSI_SET, ssi_set, content)
+ content = re.sub(SSI_ECHO, ssi_echo, content)
+ content = re.sub(SSI_IF, ssi_if, content)
+ content = re.sub(SSI_INCLUDE, ssi_include, content)
+ return content
+
+ variables = {}
+ response.content = process_content(response.content)
+ response['Content-Length'] = len(response.content)
+
+ def process_response(self, request, response):
+ """Support for unrendered responses."""
+ if hasattr(response, 'render') and callable(response.render):
+ response.add_post_render_callback(
+ lambda r: self._process_rendered_response(request, r)
+ )
+ else:
+ self._process_rendered_response(request, response)
+ return response
--- /dev/null
+import json
+from .variables import SsiVariable, SsiExpect
+
+
+def _json_default(o):
+ if isinstance(o, SsiVariable):
+ return {'__var__': o.name}
+ if isinstance(o, SsiExpect):
+ return {'__expect__': o.name}
+ raise TypeError(o, 'not JSON serializable')
+
+
+def _json_obj_hook(obj):
+ if obj.keys() == ['__var__']:
+ return SsiVariable(name=obj['__var__'])
+ if obj.keys() == ['__expect__']:
+ return SsiExpect(obj['__expect__'])
+ return obj
+
+
+def json_encode(obj, **kwargs):
+ return json.JSONEncoder(
+ default=_json_default,
+ separators=(',', ':'),
+ **kwargs).encode(obj)
+
+
+def json_decode(data, **kwargs):
+ return json.loads(data, object_hook=_json_obj_hook, **kwargs)
--- /dev/null
+from django.utils.cache import get_cache
+from ssify import INCLUDES_CACHES
+
+
+includes_caches = [get_cache(c) for c in INCLUDES_CACHES]
+
+
+def cache_include(path, content):
+ for cache in includes_caches:
+ cache.set(path, content)
--- /dev/null
+{% load get_csrf_token from ssify %}<input type='hidden' name='csrfmiddlewaretoken' value='{% get_csrf_token %}' />
--- /dev/null
+# -*- coding: utf-8 -*-
+# This file is part of Wolnelektury, licensed under GNU Affero GPLv3 or later.
+# Copyright © Fundacja Nowoczesna Polska. See NOTICE for more information.
+#
+from __future__ import absolute_import
+from django.conf import settings
+from django.core.urlresolvers import NoReverseMatch, reverse, resolve
+from django.middleware.csrf import get_token, rotate_token, _sanitize_token
+from django import template
+from django.utils.translation import get_language
+from ssify.decorators import ssi_variable
+from ssify.variables import SsiVariable
+
+
+register = template.Library()
+
+
+@register.simple_tag(takes_context=True)
+def ssi_include(context, name_, **kwargs):
+ """
+ Inserts an SSI include statement for an URL.
+
+ Works similarly to {% url %}, but only use keyword arguments are
+ supported.
+
+ In addition to just outputting the SSI include statement, it
+ remembers any request-info the included piece declares as needed.
+
+ """
+ b_kwargs = {'lang': get_language()}
+ subst = {}
+ num = 0
+ for k, value in kwargs.items():
+ if isinstance(value, SsiVariable):
+ numstr = '%04d' % num
+ b_kwargs[k] = numstr
+ subst[numstr] = value
+ num += 1
+ else:
+ b_kwargs[k] = value
+
+ try:
+ url = reverse(name_, kwargs=b_kwargs)
+ except NoReverseMatch:
+ b_kwargs.pop('lang')
+ url = reverse(name_, kwargs=b_kwargs)
+ view = resolve(url).func
+
+ for numstr, orig in subst.items():
+ url = url.replace(numstr, orig.as_var())
+ request = context['request']
+
+ # Remember the SSI vars the included view says it needs.
+ get_ssi_vars = getattr(view, 'get_ssi_vars', None)
+ if get_ssi_vars:
+ pass_vars = get_ssi_vars(**kwargs)
+ for var in pass_vars:
+ if not isinstance(var, SsiVariable):
+ var = SsiVariable(*var)
+ request.ssi_vars_needed[var.name] = var
+
+ # Output the SSI include.
+ return "<!--#include file='%s'-->" % url
+
+
+@ssi_variable(register, vary=('Cookie',))
+def get_csrf_token(request):
+ """
+ As CsrfViewMiddleware.process_view is never for a cached response,
+ and we still need to provide a request-specific CSRF token as
+ request-info ssi variable, we must make sure here that the
+ CSRF token is in request.META['CSRF_COOKIE'].
+
+ """
+ token = get_token(request)
+ if token:
+ # CSRF token is already in place, just return it.
+ return token
+
+ # Mimicking CsrfViewMiddleware.process_view.
+ try:
+ token = _sanitize_token(request.COOKIES[settings.CSRF_COOKIE_NAME])
+ request.META['CSRF_COOKIE'] = token
+ except KeyError:
+ # Create new CSRF token.
+ rotate_token(request)
+ token = get_token(request)
+
+ return token
+
+
+@register.inclusion_tag('ssify/csrf_token.html', takes_context=True)
+def csrf_token(context):
+ return {'request': context['request']}
--- /dev/null
+"""
+Utilities for defining SSI variables.
+
+SSI variables are a way of providing values that need to be computed
+at request time to the prerendered templates.
+
+"""
+from hashlib import md5
+from django import template
+from django.utils.encoding import force_unicode
+from django.utils.functional import Promise
+from django.utils.safestring import mark_safe
+from .exceptions import SsiVarsDependencyCycleError, UndeclaredSsiRefError
+
+
+class SsiVariable(object):
+ """
+ Represents a variable computed by a template tag with given arguments.
+
+ Instance of this class is returned from any template tag created
+ with `decorators.ssi_variable` decorator. If renders as SSI echo
+ statement, but you can also use it as an argument to {% ssi_include %},
+ to other ssi_variable, or create SSI if statements by using
+ its `if`, `else`, `endif` properties.
+
+ Variable's name, as used in SSI statements, is a hash of its definition,
+ so the user never has to deal with it directly.
+
+ """
+ ret_types = 'bool', 'int', 'unicode'
+
+ def __init__(self, tagpath=None, args=None, kwargs=None, name=None):
+ self.tagpath = tagpath
+ self.args = list(args or [])
+ self.kwargs = kwargs or {}
+ self._name = name
+
+ @property
+ def name(self):
+ """Variable name is a hash of its definition."""
+ if self._name is None:
+ self._name = 'v' + md5(json_encode(self.definition)).hexdigest()
+ return self._name
+
+ def rehash(self):
+ """
+ Sometimes there's a need to reset the variable name.
+
+ Typically, this is the case after finding real values for
+ variables passed as arguments to {% ssi_include %}.
+ """
+ self._name = None
+ return self.name
+
+ @property
+ def definition(self):
+ """Variable is defined by path to template tag and its arguments."""
+ if self.kwargs:
+ return self.tagpath, self.args, self.kwargs
+ elif self.args:
+ return self.tagpath, self.args
+ else:
+ return self.tagpath,
+
+ def __repr__(self):
+ return "SsiVariable(%s: %s)" % (self.name, repr(self.definition))
+
+ def get_value(self, request):
+ """Computes the real value of the variable, using the request."""
+ taglib, tagname = self.tagpath.rsplit('.', 1)
+ return template.get_library(taglib).tags[tagname].get_value(
+ request, *self.args, **self.kwargs)
+
+ def __unicode__(self):
+ return mark_safe("<!--#echo var='%s' encoding='none'-->" % self.name)
+
+ def as_var(self):
+ """Returns the form that can be used in SSI include's URL."""
+ return '${%s}' % self.name
+
+# If-else-endif properties for use in templates.
+setattr(SsiVariable, 'if',
+ lambda self: mark_safe("<!--#if expr='${%s}'-->" % self.name))
+setattr(SsiVariable, 'else',
+ staticmethod(lambda: mark_safe("<!--#else-->")))
+setattr(SsiVariable, 'endif',
+ staticmethod(lambda: mark_safe('<!--#endif-->')))
+
+
+class SsiExpect(object):
+ """This class says: I want the real value of this variable here."""
+ def __init__(self, name):
+ self.name = name
+
+
+def ssi_expect(var, type_):
+ """
+ Helper function for defining get_ssi_vars on ssi_included views.
+
+ The view needs a way of calculating all the needed variables from
+ the view args. But the args are probably the wrong type
+ (typically, str instead of int) or even are SsiVariables, not
+ resolved until request time.
+
+ This function provides a way to expect a real value of the needed type.
+
+ """
+ if isinstance(var, SsiVariable):
+ return SsiExpect(var.name)
+ else:
+ return type_(var)
+
+
+class SsiVariableNode(template.Node):
+ """ Node for the SsiVariable tags. """
+ def __init__(self, tagpath, args, kwargs, vary=None, asvar=None):
+ self.tagpath = tagpath
+ self.args = args
+ self.kwargs = kwargs
+ self.vary = vary
+ self.asvar = asvar
+
+ def __repr__(self):
+ return "<SsiVariableNode>"
+
+ def render(self, context):
+ """Renders the tag as SSI echo or sets the context variable."""
+ resolved_args = [var.resolve(context) for var in self.args]
+ resolved_kwargs = dict((k, v.resolve(context))
+ for k, v in self.kwargs.items())
+ var = SsiVariable(self.tagpath, resolved_args, resolved_kwargs)
+
+ request = context['request']
+ request.ssi_vars_needed[var.name] = var
+ if self.vary:
+ request.ssi_vary.update(self.vary)
+
+ if self.asvar:
+ context.dicts[0][self.asvar] = var
+ return ''
+ else:
+ return var
+
+
+def ssi_set_statement(var, value):
+ """Generates an SSI set statement for a variable."""
+ if isinstance(value, Promise):
+ # Yes, this is quite brutal. But we need to know
+ # the real value now, we don't know the type,
+ # and we only want to evaluate the lazy function once.
+ value = value._proxy____cast()
+ if value is False or value is None:
+ value = ''
+ return "<!--#set var='%s' value='%s'-->" % (
+ var,
+ force_unicode(value).replace(u'\\', u'\\\\').replace(u"'", u"\\'"))
+
+
+def provide_vars(request, ssi_vars):
+ """
+ Provides all the SSI set statements for ssi_vars variables.
+
+ The main purpose of this function is to by called by SsifyMiddleware.
+ """
+ resolved = {}
+ queue = ssi_vars.items()
+ unresolved_streak = 0
+ while queue:
+ var_name, var = queue.pop(0)
+ hash_dirty = False
+ new_name = var_name
+
+ try:
+ for i, arg in enumerate(var.args):
+ if isinstance(arg, SsiExpect):
+ var.args[i] = resolved[arg.name]
+ hash_dirty = True
+ for k, arg in var.kwargs.items():
+ if isinstance(arg, SsiExpect):
+ var.args[k] = resolved[arg.name]
+ hash_dirty = True
+
+ if hash_dirty:
+ # Rehash after calculating the SsiExpects with real
+ # values, because that's what the included views expect.
+ new_name = var.rehash()
+
+ for i, arg in enumerate(var.args):
+ if isinstance(arg, SsiVariable):
+ var.args[i] = resolved[arg.name]
+ for k, arg in var.kwargs.items():
+ if isinstance(arg, SsiVariable):
+ var.args[k] = resolved[arg.name]
+
+ except KeyError:
+ queue.append((var_name, var))
+ unresolved_streak += 1
+ if unresolved_streak == len(queue):
+ if arg.name in ssi_vars:
+ raise SsiVarsDependencyCycleError(queue)
+ else:
+ raise UndeclaredSsiRefError(request, var, arg.name)
+ continue
+
+ resolved[new_name] = var.get_value(request)
+ unresolved_streak = 0
+
+ output = u"".join(ssi_set_statement(var, value)
+ for (var, value) in resolved.items()
+ ).encode('utf-8')
+ return output
+
+
+from .serializers import json_encode
--- /dev/null
+{% load ssify %}
+
+{% ssi_include 'random_quote' %}
\ No newline at end of file
--- /dev/null
+{% load test_tags %}{% random_number 1 %}
\ No newline at end of file
--- /dev/null
+{% load test_tags %}
+{% quote_len_odd number as odd %}
+{{ quote }}
+Line {{ number }} of {% number_of_quotes %}
+{{ odd.if }}Odd number of characters.
+{{ odd.else }}Even number of characters.
+{{ odd.endif }}
--- /dev/null
+{% load ssify test_tags %}
+{% number_of_quotes as qlen %}
+{% random_number qlen as number %}
+{% ssi_include 'quote' number=number %}
\ No newline at end of file
--- /dev/null
+from django import template
+from ssify import ssi_variable
+from tests.views import QUOTES
+
+register = template.Library()
+
+
+@ssi_variable(register)
+def random_number(request, limit):
+ # Guaranteed to be random as of XKCD#221
+ return min(limit - 1, 4)
+
+
+@ssi_variable(register)
+def number_of_quotes(request):
+ return len(QUOTES)
+
+
+@ssi_variable(register)
+def quote_len_odd(request, which):
+ return bool(len(QUOTES[which]) % 1)
--- /dev/null
+from django.test import Client, TestCase
+from django.test.utils import override_settings
+
+
+class SsifyTestCase(TestCase):
+ def setUp(self):
+ self.client = Client()
+
+ def test_zero(self):
+ self.assertEqual(
+ self.client.get('/number_zero').content,
+ "<!--#set var='ve023a08d2c2075118e25b5f4339438dc' value='0'-->"
+ "<!--#echo var='ve023a08d2c2075118e25b5f4339438dc' "
+ "encoding='none'-->"
+ )
+
+ def test_single_quote(self):
+ self.assertEqual(
+ self.client.get('/quote/3').content.strip(),
+ """Explicit is better than implicit.
+Line 3 of <!--#echo var='va50d914691ecf9b421c680d93ba1263e' encoding='none'-->
+<!--#if expr='${vddc386e120ab274a980ab67384391a1a}'-->Odd number of characters.
+<!--#else-->Even number of characters.
+<!--#endif-->"""
+ )
+
+ def test_random_quote(self):
+ self.assertEqual(
+ self.client.get('/').content.strip(),
+ "<!--#set var='vda0df841702ea993b36d101460264364' value='4'-->"
+ "<!--#set var='va50d914691ecf9b421c680d93ba1263e' value='22'-->"
+ "<!--#set var='vafe010f2e683908fee32c48d01bb2650' value=''-->"
+ "\n\n<!--#include file='/random_quote'-->"
+ )
+
+ # Do it again, this time from cache.
+ self.assertEqual(
+ self.client.get('/').content.strip(),
+ "<!--#set var='vda0df841702ea993b36d101460264364' value='4'-->"
+ "<!--#set var='va50d914691ecf9b421c680d93ba1263e' value='22'-->"
+ "<!--#set var='vafe010f2e683908fee32c48d01bb2650' value=''-->"
+ "\n\n<!--#include file='/random_quote'-->"
+ )
+ self.assertEqual(
+ self.client.get('/random_quote').content.strip(),
+ "<!--#include "
+ "file='/quote/${vda0df841702ea993b36d101460264364}'-->"
+ )
+
+ @override_settings(SSIFY_DEBUG=True)
+ def test_debug_render_random_quote(self):
+ """Renders the complete view using the DebugSsiMiddleware."""
+ response = self.client.get('/')
+ if hasattr(response, 'render') and callable(response.render):
+ response.render()
+ self.assertEqual(
+ response.content.strip(),
+ """Simple is better than complex.
+Line 4 of 22
+Even number of characters."""
+ )
--- /dev/null
+from django.conf.urls import patterns, url
+from django.views.generic import TemplateView
+
+
+urlpatterns = patterns(
+ 'tests.views',
+
+ url(r'^$',
+ TemplateView.as_view(template_name='tests/main.html')
+ ),
+ url(r'^number_zero$',
+ TemplateView.as_view(template_name='tests/number_zero.html')
+ ),
+ url(r'^random_quote$', 'random_quote', name='random_quote'),
+ url(r'^quote/(?P<number>.+)$', 'quote', name='quote'),
+)
--- /dev/null
+from django.shortcuts import render
+from ssify import ssi_included, ssi_expect, SsiVariable as V
+
+
+@ssi_included(use_lang=False, get_ssi_vars=lambda number: [
+ ('test_tags.number_of_quotes',),
+ ('test_tags.quote_len_odd', (ssi_expect(number, int),))
+])
+def quote(request, number):
+ number = int(number)
+ return render(request, 'tests/quote.html', {
+ 'number': number,
+ 'quote': QUOTES[number]
+ })
+
+
+@ssi_included(use_lang=False, get_ssi_vars=lambda: (
+ lambda number: [number] + quote.get_ssi_vars(number))(
+ number=V('test_tags.random_number', [V('test_tags.number_of_quotes')])
+ ))
+def random_quote(request):
+ """
+ This view is purposely overcomplicated to test interdependencies
+ between SSI variables and SSI includes.
+
+ It finds number of quotes and sets that in an SSI variable,
+ then uses that to set a random quote number in a second variable,
+ then sets a third saying if the length of the selected quote is odd.
+
+ """
+ return render(request, 'tests/random_quote.html')
+
+
+# Nothing interesting here.
+def _quotes():
+ import sys
+ import cStringIO
+ stdout_backup = sys.stdout
+ sys.stdout = cStringIO.StringIO()
+ import this
+ this_string = sys.stdout.getvalue()
+ sys.stdout.close()
+ sys.stdout = stdout_backup
+ return this_string.split('\n')
+
+QUOTES = _quotes()
fnp / django-ssify.git / commitdiff