diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ 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.
+
+
+ Copyright (C)
+
+ 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 .
+
+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:
+
+ Copyright (C)
+ 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
+.
+
+ 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
+.
diff --git a/COPYING.LESSER b/COPYING.LESSER
new file mode 100644
index 0000000..fc8a5de
--- /dev/null
+++ b/COPYING.LESSER
@@ -0,0 +1,165 @@
+ GNU LESSER GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+ This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+ 0. Additional Definitions.
+
+ As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+ "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+ An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+ A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+ The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+ The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+ 1. Exception to Section 3 of the GNU GPL.
+
+ You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+ 2. Conveying Modified Versions.
+
+ If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+ a) under this License, provided that you make a good faith effort to
+ ensure that, in the event an Application does not supply the
+ function or data, the facility still operates, and performs
+ whatever part of its purpose remains meaningful, or
+
+ b) under the GNU GPL, with none of the additional permissions of
+ this License applicable to that copy.
+
+ 3. Object Code Incorporating Material from Library Header Files.
+
+ The object code form of an Application may incorporate material from
+a header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+ a) Give prominent notice with each copy of the object code that the
+ Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the object code with a copy of the GNU GPL and this license
+ document.
+
+ 4. Combined Works.
+
+ You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+ a) Give prominent notice with each copy of the Combined Work that
+ the Library is used in it and that the Library and its use are
+ covered by this License.
+
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
+ document.
+
+ c) For a Combined Work that displays copyright notices during
+ execution, include the copyright notice for the Library among
+ these notices, as well as a reference directing the user to the
+ copies of the GNU GPL and this license document.
+
+ d) Do one of the following:
+
+ 0) Convey the Minimal Corresponding Source under the terms of this
+ License, and the Corresponding Application Code in a form
+ suitable for, and under terms that permit, the user to
+ recombine or relink the Application with a modified version of
+ the Linked Version to produce a modified Combined Work, in the
+ manner specified by section 6 of the GNU GPL for conveying
+ Corresponding Source.
+
+ 1) Use a suitable shared library mechanism for linking with the
+ Library. A suitable mechanism is one that (a) uses at run time
+ a copy of the Library already present on the user's computer
+ system, and (b) will operate properly with a modified version
+ of the Library that is interface-compatible with the Linked
+ Version.
+
+ e) Provide Installation Information, but only if you would otherwise
+ be required to provide such information under section 6 of the
+ GNU GPL, and only to the extent that such information is
+ necessary to install and execute a modified version of the
+ Combined Work produced by recombining or relinking the
+ Application with a modified version of the Linked Version. (If
+ you use option 4d0, the Installation Information must accompany
+ the Minimal Corresponding Source and Corresponding Application
+ Code. If you use option 4d1, you must provide the Installation
+ Information in the manner specified by section 6 of the GNU GPL
+ for conveying Corresponding Source.)
+
+ 5. Combined Libraries.
+
+ You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+ a) Accompany the combined library with a copy of the same work based
+ on the Library, uncombined with any other library facilities,
+ conveyed under the terms of this License.
+
+ b) Give prominent notice with the combined library that part of it
+ is a work based on the Library, and explaining where to find the
+ accompanying uncombined form of the same work.
+
+ 6. Revised Versions of the GNU Lesser General Public License.
+
+ The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser 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
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+ If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/Pickles.php b/Pickles.php
index 0b76cf1..cbc4184 100755
--- a/Pickles.php
+++ b/Pickles.php
@@ -17,17 +17,19 @@
/**
* @todo Allow users to override the timezone from their configuration file.
*/
+// Sets the timezone to avoid Smarty warnings
if (ini_get('date.timezone') == '') {
- date_default_timezone_set('America/New_York');
+ ini_set('date.timezone', 'America/New_York');
}
-/**
- * @todo Change the TEMP_PATH to be named more accordingly (Smarty-centric)
- * and ditch sys_get_temp_dir() and point to a directory inside the
- * PICKLES path.
- */
-define('PICKLES_PATH', (phpversion() < 5.3 ? dirname(__FILE__) : __DIR__) . '/');
-define('TEMP_PATH', sys_get_temp_dir() . '/pickles/smarty/' . $_SERVER['SERVER_NAME'] . '/');
+// Establishes our paths
+define('SITE_PATH', getcwd() . '/');
+define('PICKLES_PATH', dirname(__FILE__) . '/');
+define('TEMP_PATH', PICKLES_PATH . 'tmp/');
+define('SMARTY_PATH', TEMP_PATH . 'smarty/' . $_SERVER['SERVER_NAME'] . '/');
+
+// Loads the appropriately named configuration file
+Config::load(SITE_PATH . '../config.xml');
/**
* Magic function to automatically load classes
@@ -39,15 +41,24 @@ define('TEMP_PATH', sys_get_temp_dir() . '/pickles/smarty/' . $_SERVER['SERVE
* @return boolean Return value of require_once() or false (default)
*/
function __autoload($class) {
- $class_file = PICKLES_PATH . 'classes/' . str_replace('_', '/', $class) . '.php';
- $model_file = PICKLES_PATH . 'models/' . str_replace('_', '/', $class) . '.php';
+ $filename = str_replace('_', '/', $class) . '.php';
+ $class_file = PICKLES_PATH . 'classes/' . $filename;
+ $model_file = PICKLES_PATH . 'models/' . $filename;
+
+ // Loads the class file
if (file_exists($class_file)) {
return require_once $class_file;
}
+ // Loads the shared model
else if (file_exists($model_file)) {
return require_once $model_file;
}
+ // Loads Smarty
+ else if ($class == 'Smarty') {
+ return require_once 'contrib/smarty/libs/Smarty.class.php';
+ }
+ // Loads nothing
else {
return false;
}
diff --git a/classes/Config.php b/classes/Config.php
index 11e0437..aee4de3 100755
--- a/classes/Config.php
+++ b/classes/Config.php
@@ -1,27 +1,49 @@
.
*
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
* @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
- * @todo Add the ability to load in multiple configuration files.
+ */
+
+/**
+ * Config Class
+ *
+ * Handles loading a configuration file and parsing the data for
+ * any public nodes that need to be made available to the viewer.
+ *
+ * @usage $config = Config::getInstance();
+ *$config->node; // Returns SimpleXML object
*/
class Config extends Singleton {
/**
* Private instance of the Config class
*/
- private static $instance;
+ private static $_instance;
/**
- * Private collection of data to be loaded by the viewer
+ * Private collection of public config data
*/
- private $viewer_data;
+ private $_public;
/**
* Private constructor
@@ -31,19 +53,19 @@ class Config extends Singleton {
/**
* Gets an instance of the configuration object
*
- * Determines if a Config object has already been instantiated, if so it
- * will use it. If not, it will create one.
+ * Determines if a Config object has already been instantiated,
+ * if so it will use it. If not, it will create one.
*
* @return An instace of the Config class
*/
public static function getInstance() {
$class = __CLASS__;
- if (!self::$instance instanceof $class) {
- self::$instance = new $class();
+ if (!self::$_instance instanceof $class) {
+ self::$_instance = new $class();
}
- return self::$instance;
+ return self::$_instance;
}
/**
@@ -52,57 +74,109 @@ class Config extends Singleton {
* Handles the potential loading of the configuration file and
* sanitizing the boolean strings into actual boolean values.
*
- * @param string $file File name of the config file to be loaded
- * @return boolean Based on the success or failure of the file load
- * @todo Either get rid of or make better use of the Error object
+ * @param string $file Filename of the XML file to be loaded
+ * @return boolean Success of the load process
+ * @todo Add the ability to load in multiple configuration files.
*/
- public function load($file) {
+ public static function load($file) {
+ $config = Config::getInstance();
+
if (file_exists($file)) {
- $this->file = $file;
-
/**
- * @todo LIBXML_NOCDATA is 5.1+ and I want PICKLES to be 5.0+
- * compatible. Potential fix is to read the file in as
- * a string, and if it has CDATA, throw an internal
- * warning.
+ * @todo LIBXML_NOCDATA is 5.1+ and I want PICKLES to
+ * be 5.0+ compatible. Potential fix is to read
+ * the file in as a string, and if it has CDATA,
+ * throw an internal warning.
*/
- $this->data = simplexml_load_file($file, 'SimpleXMLElement', LIBXML_NOCDATA);
+ $data = simplexml_load_file($file, 'SimpleXMLElement', LIBXML_NOCDATA);
// Loops through the top level nodes to find public nodes
- $variables = get_object_vars($this->data);
+ $variables = get_object_vars($data);
if (is_array($variables)) {
foreach ($variables as $key => $value) {
if (is_object($value) && isset($value->attributes()->public) && $value->attributes()->public == true) {
- $this->viewer_data[$key] = $value;
+ $config->_public[$key] = $value;
}
+
+ $config->$key = $value;
}
}
return true;
}
- else {
- Error::addError('Unable to load the configuration file');
- return false;
+ }
+
+ /**
+ * Gets the authentication value
+ *
+ * @return boolean The model's authentication setting or false
+ */
+ public function getAuthentication() {
+ if (isset($this->models->authentication) && $this->models->authentication == 'true') {
+ return true;
}
+
+ return false;
}
/**
- * Alias for $config->models->default
+ * Alias for $config->models->default with string cast
*
* @return Returns the default model set or null
- * @todo Need to add a PICKLES fallback model just in case
*/
public function getDefaultModel() {
- if (isset($this->data->models->default)) {
- return (string)$this->data->models->default;
+ if (isset($this->models->default)) {
+ return (string)$this->models->default;
+ }
+
+ return 'home';
+ }
+
+ /**
+ * Gets active status of the site
+ *
+ * @return boolean The site's disabled setting or false
+ */
+ public function getDisabled() {
+ if (isset($this->models->disabled) && $this->models->disabled == 'true') {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Alias for $config->_public
+ *
+ * @return Returns the variable value or null if no variable.
+ */
+ public function getPublicData() {
+ if (isset($this->_public)) {
+ return $this->_public;
}
return null;
}
- /**
+ /**
+ * Gets the session value
*
+ * @return boolean The model's session setting or false
+ */
+ public function getSession() {
+ if (isset($this->models->session) && $this->models->session == 'true') {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Gets the shared model
+ *
+ * @param string $requested_model The model being requested
+ * @return string The name of the shared model or null
*/
public function getSharedModel($requested_model) {
@@ -113,8 +187,8 @@ class Config extends Singleton {
$additional = '/' . $additional;
}
- if (isset($this->data->models->shared->model)) {
- foreach ($this->data->models->shared->model as $shared_model) {
+ if (isset($this->models->shared->model)) {
+ foreach ($this->models->shared->model as $shared_model) {
if (isset($shared_model->alias)) {
if ($requested_model == $shared_model->alias) {
return (string)$shared_model->name . $additional;
@@ -128,33 +202,20 @@ class Config extends Singleton {
}
}
- return null;
+ return 'home';
}
- /**
- * Alias for $config->viewer_data
+ /**
+ * Gets the viewer value
*
- * @return Returns either the variable value or null if no variable.
+ * @return boolean The model's viewer setting or false
*/
- public function getViewerData() {
- if (isset($this->viewer_data)) {
- return $this->viewer_data;
+ public function getViewer() {
+ if (isset($this->models->viewer) && $this->models->viewer == 'true') {
+ return true;
}
- return null;
- }
-
- public function __get($node) {
- if (isset($this->data->$node) && $this->data->$node != '') {
- if (in_array($this->data->$node, array('true', 'false'))) {
- return (bool)$this->data->$node;
- }
- else if (is_object($this->data->$node)) {
- return $this->data->$node;
- }
- }
-
- return null;
+ return false;
}
}
diff --git a/classes/Controller.php b/classes/Controller.php
index 0b891d5..7e24495 100755
--- a/classes/Controller.php
+++ b/classes/Controller.php
@@ -1,64 +1,77 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * Controller Class
*
* The heavy lifter of PICKLES, makes the calls to get the session and
- * configuration loaded. Loads models, serves up user authentication when the
- * model asks for it, and loads the viewer that the model has requested. Default
- * values are present to make things easier on the user.
+ * configuration loaded. Loads models, serves up user authentication when
+ * the model asks for it, and loads the viewer that the model has requested.
+ * Default values are present to make things easier on the user.
*
- * @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
- * @usage new Controller(); or new Controller('/path/to/config.xml');
- * @todo Possibly remove the conditionals for the CLI view
+ * @usage new Controller();
*/
class Controller extends Object {
- /**
- * Private objects
- */
- private $model = null;
- private $viewer = null;
-
- /*
- protected $config = null;
- private $controller = null;
- */
-
/**
* Constructor
*
* To make life a bit easier when using PICKLES, the Controller logic is
* executed automatically via use of a constructor.
- *
- * @params string $file File name of the configuration file to be loaded
- * @params string $controller Type of controller to create (Web or CLI)
- * @todo Need to internally document the process better
*/
- public function __construct($file = '../config.xml', $controller = 'Web') {
+ public function __construct() {
parent::__construct();
// Load the config for the site passed in
$config = Config::getInstance();
- $config->load($file);
// Generate a generic "site down" message
- if ($config->disabled === true) {
+ if ($config->getDisabled()) {
exit("
{$_SERVER['SERVER_NAME']} is currently down for maintenance
");
}
// Grab the passed in model or use the default
$model_name = isset($_REQUEST['model']) ? str_replace('-', '_', $_REQUEST['model']) : $config->getDefaultModel();
+ /**
+ * @todo Maybe the logout shouldn't be an internal thing, what if the
+ * user wanted to call the logout page something else? or better
+ * yet, they want to next it, like /users/logout?
+ */
if ($model_name == 'logout') {
- Security::logout();
+ Security::logout();
}
else {
- // Load the model
+ // Loads the requested model's information
$model_file = '../models/' . $model_name . '.php';
+ /**
+ * @todo Rename "section" to something like "current" or "selected"
+ * @todo Figure out WTF "event" is being used for
+ */
if (strpos($model_name, '/') === false) {
$class = $model_name;
$section = $model_name;
@@ -69,75 +82,70 @@ class Controller extends Object {
list($section, $event) = split('/', $model_name);
}
+ // Establishes the shared model information
$shared_model_name = $config->getSharedModel($model_name);
$shared_model_file = PICKLES_PATH . 'models/' . $shared_model_name . '.php';
+ // Tries to load the site level model
if (file_exists($model_file)) {
require_once $model_file;
if (class_exists($class)) {
- $this->model = new $class;
+ $model = new $class;
}
}
+ // Tries to load the shared model
else if (file_exists($shared_model_file) && $shared_model_name != false) {
if (strpos($shared_model_name, '/') === false) {
$class = $shared_model_name;
- //$section = $shared_model_name;
- //$event = null;
}
else {
$class = str_replace('/', '_', $shared_model_name);
- //list($section, $event) = split('/', $shared_model_name);
}
if (class_exists($class)) {
- $this->model = new $class;
+ $model = new $class;
}
}
+ // Loads the stock model
else {
- $this->model = new Model();
+ $model = new Model();
}
- if ($this->model != null) {
- // Start the session if it's not started already
- if ($this->model->getSession() === true) {
+ // Checks if we loaded a model file and no class was present
+ if ($model != null) {
+
+ // Potentially starts the session if it's not started already
+ if ($model->getSession() === true) {
if (ini_get('session.auto_start') == 0) {
session_start();
}
}
- if ($this->model->getAuthentication() === true && $controller != 'CLI') {
+ // Potentially requests use authentication
+ if ($model->getAuthentication() === true) {
Security::authenticate();
}
- $this->model->set('name', $model_name);
- $this->model->set('shared_name', $shared_model_name);
- $this->model->set('section', $section);
-
- // Execute the model's logic
- if (method_exists($this->model, '__default')) {
- $this->model->__default();
+ // Potentially executes the model's logic
+ if (method_exists($model, '__default')) {
+ $model->__default();
}
- // Load the viewer
- $this->viewer = Viewer::factory($this->model);
- $this->viewer->display();
+ // Creates a new viewer object
+ $viewer = Viewer::factory($model->getViewer());
+
+ // Sets the viewers properties
+ $viewer->model_name = $model_name;
+ $viewer->shared_name = $shared_model_name;
+ $viewer->section = $section;
+ $viewer->data = $model->getData();
+
+ // Runs the requested viewer's display function
+ $viewer->display();
}
}
}
-
- /*
-
- if ((isset($_REQUEST['section']) && $_REQUEST['section'] == 'admin')) {
- }
-
- // Check if we're accessing an admin sub section and load the logic script
- if (isset($_REQUEST['section']) && $_REQUEST['section'] != 'admin' && $is_admin) {
- if ($_REQUEST['section'] == 'admin.logout') {
- Session::logout();
- }
-
- */
}
?>
diff --git a/classes/DB.php b/classes/DB.php
index 2c9e2c5..7f55b69 100755
--- a/classes/DB.php
+++ b/classes/DB.php
@@ -1,15 +1,37 @@
db). Because the
- * database object can execute raw SQL, there should be no limitations.
+ * PICKLES is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation, either version 3 of
+ * the License, or (at your option) any later version.
+ *
+ * PICKLES 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with PICKLES. If not, see
+ * .
*
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
* @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
+ */
+
+/**
+ * Database Abstraction Layer for MySQL
+ *
+ * All database usage inside PICKLES-based sites should be done
+ * via the database object that is a part of every model ($this->db).
+ * Because the database object can execute raw SQL, there should be
+ * no limitations.
+ *
* @todo Internally document the functions better.
* @todo Potentially switch to PDO to be able to easily accomodate
* different database types.
diff --git a/classes/Error.php b/classes/Error.php
index 0725ba7..b730dd7 100755
--- a/classes/Error.php
+++ b/classes/Error.php
@@ -1,5 +1,29 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
/**
* Error handling class
*
@@ -9,9 +33,6 @@
* add logic to appropriately report the errors, perhaps as a variable in the
* model data array.
*
- * @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
* @todo Internally document the functions better.
* @todo Convert the class to extend Singleton.
* @todo Quite possibly revamp the class entirely as it is still left over
diff --git a/classes/ImageUtils.php b/classes/ImageUtils.php
index 5217405..6d7c6f0 100755
--- a/classes/ImageUtils.php
+++ b/classes/ImageUtils.php
@@ -1,5 +1,29 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
/**
* Incomplete collection of image manipulation utilities
*
@@ -11,10 +35,7 @@
* processing, it seems there's an ImageMagick module that can utilized, that may
* end up being the route that is taken. Until then, this class is useless shit.
*
- * @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
- * @todo Make the class usable.
+ * @todo Make the class usable.
*/
class ImageUtils {
diff --git a/classes/Mail.php b/classes/Mail.php
index f84e383..9c378d1 100755
--- a/classes/Mail.php
+++ b/classes/Mail.php
@@ -1,5 +1,29 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
/**
* Small collection of mail utilities
*
@@ -7,15 +31,12 @@
* I have built PICKLES based around my own needs, this has been the only
* function I have felt the need to add.
*
- * @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
- * @todo Just so it doesn't seem so bare, I need to come up and implement a
- * few more mail functions.
- * @todo Still thinking about making this an instantiated object instead of
- * a static class. Perhaps I should add a mail (rename it to mailer
- * maybe) object to each model so it's ready to be loaded, and if it
- * is loaded, then go ahead and automatically send it?!? Loves it.
+ * @todo Just so it doesn't seem so bare, I need to come up and implement a
+ * few more mail functions.
+ * @todo Still thinking about making this an instantiated object instead of
+ * a static class. Perhaps I should add a mail (rename it to mailer
+ * maybe) object to each model so it's ready to be loaded, and if it
+ * is loaded, then go ahead and automatically send it?!? Loves it.
*/
class Mail {
diff --git a/classes/Model.php b/classes/Model.php
index 193d9ed..695d2a9 100644
--- a/classes/Model.php
+++ b/classes/Model.php
@@ -1,15 +1,36 @@
.
*
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
* @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
+ */
+
+/**
+ * Model Class
+ *
+ * Every model in PICKLES at both the core and site levels need to extend
+ * this class. It handles the getting of common model variables (auth, data
+ * and view) as well as making sure that every model has a database object
+ * available.
*/
class Model extends Object {
@@ -18,6 +39,11 @@ class Model extends Object {
*/
protected $data = array();
+ /**
+ * Config object
+ */
+ protected $config = null;
+
/**
* Database object
*/
@@ -35,60 +61,65 @@ class Model extends Object {
/**
* Constructor
*
- * Handles calling the parent constructor and sets up the model's internal
- * database object
+ * Handles calling the parent constructor and sets up the model's
+ * internal config and database object
*/
public function __construct() {
parent::__construct();
- $this->db = DB::getInstance();
+ $this->config = Config::getInstance();
+ $this->db = DB::getInstance();
}
/**
* Gets the authenticate value
*
- * @todo Add in configuration level override
- * @return boolean Whether or not the model requires user authentication to use
+ * Order of precedence: Model, Config, Guess (guess is always false)
+ *
+ * @return boolean Whether or not the model requires user authentication
*/
public function getAuthentication() {
- // Order of precedence: Model, Config, Guess
- if ($this->authentication == null) {
- return false;
- }
- else {
+ if ($this->authentication != null) {
return $this->authentication;
}
+ else if (is_bool($this->config->getAuthentication())) {
+ return $this->config->getAuthentication();
+ }
+
+ return false;
}
/**
* Gets the session value
*
- * @todo Add in configuration level override
+ * Order of precedence: Auth On, Model, Config, Guess (guess is always false)
+ *
* @return boolean Whether or not the session needs to be started
*/
public function getSession() {
- // Order of precedence: Auth On, Model, Config, Guess
if ($this->authentication === true) {
return true;
}
- else {
- if ($this->session == null) {
- return false;
- }
- else {
- return $this->session;
- }
+ else if ($this->session != null) {
+ return $this->session;
}
+ else if (is_bool($this->config->getSession())) {
+ return $this->config->getSession();
+ }
+
+ return false;
}
/**
* Gets the requested Viewer
*
- * @todo Add in configuration level override
+ * Order of precedence: Model, Config, Guess (guess is always Smarty)
+ *
* @return string The viewer that the model has requested to be used
+ * @todo Guess shouldn't be Smarty, it should be the dummy PHP template.
+ * @todo Use the config override value to help determine.
*/
public function getViewer() {
- // Order of precedence: Model, Config, Guess
if ($this->viewer == null) {
return isset($argv) ? 'CLI' : 'Smarty';
}
@@ -110,6 +141,10 @@ class Model extends Object {
return null;
}
+ public function __set($variable, $value) {
+ $this->data[$variable] = $value;
+ }
+
/**
* Destructor
*
@@ -122,11 +157,12 @@ class Model extends Object {
/**
* Default function
*
- * This function is overloaded by the model. The __default() function is
- * where any code that needs to be executed at run time needs to be placed.
- * It's not in the constructor as the model needs to be instantiated first
- * so that the authorization requirements can be checked without running
- * code it's potentially not supposed to have run.
+ * This function is overloaded by the model. The __default() function
+ * is where any code that needs to be executed at run time needs to be
+ * placed. It's not in the constructor as the model needs to be
+ * instantiated first so that the authorization requirements can be
+ * checked without running code it's potentially not supposed to have
+ * been executed.
*/
public function __default() { }
}
diff --git a/classes/Object.php b/classes/Object.php
index 856e0c4..a0ffcb6 100644
--- a/classes/Object.php
+++ b/classes/Object.php
@@ -1,16 +1,37 @@
.
*
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
* @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
+ */
+
+/**
+ * Object Class
+ *
+ * Every non-Singleton-based class needs to extend this class.
+ * Any models will extend the Model class which entends the Object
+ * class already. This class handles getting an instance of the
+ * Config object so that it's available. Also provides a getter
+ * and setter for variables.
*/
class Object {
@@ -33,44 +54,6 @@ class Object {
*/
public function __destruct() { }
- /*
- // @todo maybe later
- public function __get($variable) {
- if (!isset($this->data[$variable])) {
- $this->data[$variable] = null;
- }
-
- return $this->data[$variable];
- }
- */
-
- /**
- * Gets a variable
- *
- * @return Returns either the variable value or false if no variable.
- * @todo Returning false could be misleading, especially if you're
- * expecting a boolean value to begin with. Perhaps an error should
- * be thrown?
- */
- /*
- public function get($variable, $array_element = null) {
- if (isset($this->$variable)) {
- if (isset($array_element)) {
- $array = $this->$variable;
-
- if (isset($array[$array_element])) {
- return $array[$array_element];
- }
- }
- else {
- return $this->$variable;
- }
- }
-
- return false;
- }
- */
-
public function __get($variable) {
if (isset($this->$variable)) {
return $this->$variable;
@@ -84,6 +67,7 @@ class Object {
*
* @param string $variable Name of the variable to be set
* @param mixed $value Value to be assigned to the passed variable
+ * @todo Not sure we need this at all, grep to check if it's being used.
*/
public function set($variable, $value) {
$this->$variable = $value;
diff --git a/classes/Security.php b/classes/Security.php
index 21353ba..a6e2ef8 100644
--- a/classes/Security.php
+++ b/classes/Security.php
@@ -1,32 +1,54 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * Security Class
*
* Handles authenticating a user via an Apache login box.
*
- * @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
- * @todo Make the SQL less specific, right now you have to use a table
- * named users, and use the email as the username. I will need to
- * move this to the configuration and allow the user to specify which
- * table to authenticate against, and what column names to use for the
- * username and password.
+ * @todo Make the SQL less specific, right now you have to use a table
+ * named users, and use the email as the username. I will need
+ * to move this to the configuration and allow the user to
+ * specify which table to authenticate against, and what column
+ * names to use for the username and password.
*/
class Security extends Object {
/**
* Authenticates the user
*
- * Checks for the authentication variables to be passed in the $_SERVER super
- * global and attempts to authenticate the user against MySQL. If the user
- * cannot successfully they will be presented with a 401 Unauthorized page.
+ * Checks for the authentication variables to be passed in the $_SERVER
+ * super global and attempts to authenticate the user against MySQL. If
+ * the user cannot successfully they will be presented with a 401
+ * Unauthorized page.
*
- * @todo I'm sure someone will find the access denied message offensive, so
- * this will need to be made more generic. May also want to add in the
- * ability for someone to add a custom message and/or landing page in
- * the configuration as well.
+ * @todo I'm sure someone will find the access denied message offensive,
+ * so this will need to be made more generic. May also want to
+ * add in the ability for someone to add a custom message and/or
+ * landing page in the configuration as well.
*/
static function authenticate() {
$db = DB::getInstance();
diff --git a/classes/Singleton.php b/classes/Singleton.php
index a982f9c..55d9e91 100644
--- a/classes/Singleton.php
+++ b/classes/Singleton.php
@@ -1,16 +1,36 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * Singleton Class
*
* This is the file that you include on the page you're instantiating the
* controller from (typically index.php). The path to the PICKLES code base
* is established as well as the path that Smarty will use to store the
* compiled pages.
- *
- * @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
*/
class Singleton {
diff --git a/classes/Viewer.php b/classes/Viewer.php
index fcb28a4..b57bc75 100644
--- a/classes/Viewer.php
+++ b/classes/Viewer.php
@@ -1,14 +1,34 @@
.
*
- * @package PICKLES
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * Viewer Class
+ *
+ * Uses the factory design pattern to create a new Viewer object
+ * based on what viewer the model says it wants to use.
*/
class Viewer {
@@ -22,15 +42,15 @@ class Viewer {
*
* Creates an instance of the Viewer type that the model requests.
*
- * @param object $model The model to be displayed
+ * @param string $tye The type of viewer to produce
* @return object An instance of the viewer, loaded with the passed model
* @todo Create constants to correspond with each viewer type so it's
* potentially easier to reference from the model (since the
* constants would each be uppercase instead of mixedcase.
*/
- public static function factory(Model $model) {
- $class = 'Viewer_' . $model->getViewer();
- return new $class($model);
+ public static function factory($type) {
+ $class = 'Viewer_' . $type;
+ return new $class();
}
}
diff --git a/classes/Viewer/Common.php b/classes/Viewer/Common.php
index 7894bab..475cc64 100644
--- a/classes/Viewer/Common.php
+++ b/classes/Viewer/Common.php
@@ -1,33 +1,62 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * Common Viewer Class
*
* This is the class that each viewer class should be extending from.
- *
- * @package PICKLES
- * @subpackage Viewer
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
*/
abstract class Viewer_Common extends Object {
- /**
- * Protected model object
- */
- protected $model = null;
-
/**
* Constructor
*
* Runs the parent's constructor and adds the model to the object.
*
* @param object $model Object for the model we're loading
- * @todo Need better validation of the passed model.
*/
- public function __construct(Model $model) {
+ public function __construct() {
parent::__construct();
- $this->model = $model;
+
+ /**
+ * @todo This may need to be flipped on only for Smarty and PHP templates
+ */
+ // Obliterates any passed in PHPSESSID (thanks Google)
+ if (stripos($_SERVER['REQUEST_URI'], '?PHPSESSID=') !== false) {
+ list($request_uri, $phpsessid) = split('\?PHPSESSID=', $_SERVER['REQUEST_URI'], 2);
+ header('HTTP/1.1 301 Moved Permanently');
+ header('Location: ' . $request_uri);
+ exit();
+ }
+
+ // XHTML compliancy stuff
+ ini_set('arg_separator.output', '&');
+ ini_set('url_rewriter.tags', 'a=href,area=href,frame=src,input=src,fieldset=');
+
+ header('Content-type: text/html; charset=UTF-8');
}
/**
diff --git a/classes/Viewer/Debug.php b/classes/Viewer/Debug.php
index f34f1a8..039d146 100644
--- a/classes/Viewer/Debug.php
+++ b/classes/Viewer/Debug.php
@@ -1,14 +1,33 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * Debugging Viewer
*
* Displays debugging information on the screen.
- *
- * @package PICKLES
- * @subpackage Viewer
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
*/
class Viewer_Debug extends Viewer_Common {
diff --git a/classes/Viewer/JSON.php b/classes/Viewer/JSON.php
index 7a508f8..447191e 100644
--- a/classes/Viewer/JSON.php
+++ b/classes/Viewer/JSON.php
@@ -1,15 +1,38 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * JSON Viewer
+ *
+ * Displays data in JavaScript Object Notation. Requires PHP 5 >= 5.2.0 or
+ * PECL json 1.2.0 or 1.2.1
*
- * @package PICKLES
- * @subpackage Viewer
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
* @link http://json.org/
+ * @link http://us.php.net/json_encode
+ * @link http://pecl.php.net/package/json
*/
class Viewer_JSON extends Viewer_Common {
@@ -17,12 +40,10 @@ class Viewer_JSON extends Viewer_Common {
* Displays the data in JSON format
*/
public function display() {
- header('Content-type: application/json; charset=utf-8');
-
if (!function_exists('json_encode')) {
echo '{ "type" : "error", "message" : "json_encode() not found" }';
} else {
- echo json_encode($this->model->getData());
+ echo json_encode($this->data);
}
}
}
diff --git a/classes/Viewer/PHP.php b/classes/Viewer/PHP.php
new file mode 100644
index 0000000..27393fe
--- /dev/null
+++ b/classes/Viewer/PHP.php
@@ -0,0 +1,86 @@
+.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * PHP Viewer
+ *
+ * Displays the associated PHP templates for the Model. This is for all you
+ * folks that would prefer not to user the Smarty templating engine. Your
+ * PHP templates are just PHP code, plain and simple.
+ */
+class Viewer_PHP extends Viewer_Common {
+
+ /**
+ * Displays the Smarty generated pages
+ */
+ public function display() {
+
+ $smarty->template_dir = '../templates/';
+
+ /**
+ * @todo Resurrect my buffer clean up code
+ */
+ $smarty->load_filter('output','trimwhitespace');
+
+ // Pass all of our controller values to Smarty
+ $smarty->assign('section', $this->model->section);
+ $smarty->assign('model', $this->model->name);
+ $smarty->assign('template', $template);
+
+ // Loads the data from the config
+ $data = $this->config->getViewerData();
+
+ if (isset($data) && is_array($data)) {
+ $smarty->assign('config', $data);
+ }
+
+ // Loads the data from the model
+ $data = $this->model->getData();
+
+ if (isset($data) && is_array($data)) {
+ foreach ($data as $variable => $value) {
+ $smarty->assign($variable, $value);
+ }
+ }
+
+ // Load it up!
+ header('Content-type: text/html; charset=UTF-8');
+
+ // If the index.tpl file is present, load it, else load the template directly
+ /**
+ * @todo Should there be additional logic to allow the model or the
+ * template to determine whether or not the index should be loaded?
+ */
+ if ($smarty->template_exists('index.tpl')) {
+ $smarty->display('index.tpl');
+ }
+ else {
+ $smarty->display($template);
+ }
+ }
+}
+
+?>
diff --git a/classes/Viewer/RSS.php b/classes/Viewer/RSS.php
index ff996ed..83cdd8c 100644
--- a/classes/Viewer/RSS.php
+++ b/classes/Viewer/RSS.php
@@ -1,19 +1,39 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * RSS Viewer
*
* Displays data in RSS version 2.0 format.
*
- * @package PICKLES
- * @subpackage Viewer
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
- * @link http://cyber.law.harvard.edu/rss/rss.html
- * @todo Need to add support for RSS v1.0 as well as ATOM feeds. This may
- * result in my abstracting out these classes a bit more (Probably a
- * Feed viewer that would take a parameter to determine which type of
- * of feed to use).
+ * @link http://cyber.law.harvard.edu/rss/rss.html
+ * @todo Need to add support for RSS v1.0 as well as ATOM feeds. This may
+ * result in my abstracting out these classes a bit more (Probably a
+ * Feed viewer that would take a parameter to determine which type of
+ * of feed to use).
*/
class Viewer_RSS extends Viewer_Common {
diff --git a/classes/Viewer/Smarty.php b/classes/Viewer/Smarty.php
index 32748c7..528f05f 100644
--- a/classes/Viewer/Smarty.php
+++ b/classes/Viewer/Smarty.php
@@ -1,14 +1,34 @@
.
+ *
+ * @author Joshua John Sherman
+ * @copyright Copyright 2007, 2008 Joshua John Sherman
+ * @link http://phpwithpickles.org
+ * @license http://www.gnu.org/copyleft/lesser.html
+ * @package PICKLES
+ */
+
+/**
+ * Smarty Viewer
*
* Displays the associated Smarty templates for the Model.
*
- * @package PICKLES
- * @subpackage Viewer
- * @author Joshua Sherman
- * @copyright 2007-2008 Joshua Sherman
* @link http://smarty.net/
*/
class Viewer_Smarty extends Viewer_Common {
@@ -18,33 +38,13 @@ class Viewer_Smarty extends Viewer_Common {
*/
public function display() {
- // Obliterates any passed in PHPSESSID (thanks Google)
- if (stripos($_SERVER['REQUEST_URI'], '?PHPSESSID=') !== false) {
- list($request_uri, $phpsessid) = split('\?PHPSESSID=', $_SERVER['REQUEST_URI'], 2);
- header('HTTP/1.1 301 Moved Permanently');
- header('Location: ' . $request_uri);
- exit();
- }
-
- // XHTML compliancy stuff
- ini_set('arg_separator.output', '&');
- ini_set('url_rewriter.tags', 'a=href,area=href,frame=src,input=src,fieldset=');
-
- /**
- * @todo Create a wrapper so that we can auto load this
- */
- require_once 'contrib/smarty/libs/Smarty.class.php';
-
$smarty = new Smarty();
- /**
- * @todo Perhaps the templates directory would be better suited as a
- * config variable?
- */
- $smarty->template_dir = '../templates/';
+ // Establishes our paths
+ $smarty->template_dir = SITE_PATH . '../templates/';
- $cache_dir = TEMP_PATH . 'cache';
- $compile_dir = TEMP_PATH . 'compile';
+ $cache_dir = SMARTY_PATH . 'cache';
+ $compile_dir = SMARTY_PATH . 'compile';
if (!file_exists($cache_dir)) { mkdir($cache_dir, 0777, true); }
if (!file_exists($compile_dir)) { mkdir($compile_dir, 0777, true); }
@@ -52,9 +52,10 @@ class Viewer_Smarty extends Viewer_Common {
$smarty->cache_dir = $cache_dir ;
$smarty->compile_dir = $compile_dir;
+ // Loads the trim whitespace filter
$smarty->load_filter('output','trimwhitespace');
- // Include custom Smarty functions
+ // Includes the PICKLES custom Smarty functions
$directory = PICKLES_PATH . 'smarty/functions/';
if (is_dir($directory)) {
@@ -70,11 +71,9 @@ class Viewer_Smarty extends Viewer_Common {
}
}
- /**
- * @todo Maybe the template path should be part of the configuration?
- */
- $template = '../templates/' . $this->model->name . '.tpl';
- $shared_template = getcwd() . '/templates/' . $this->model->shared_name . '.tpl';
+ // Establishes the template names
+ $template = SITE_PATH . '../templates/' . $this->model_name . '.tpl';
+ $shared_template = PICKLES_PATH . 'templates/' . $this->shared_name . '.tpl';
/**
* @todo There's a bug with the store home page since it's a redirect
@@ -86,22 +85,20 @@ class Viewer_Smarty extends Viewer_Common {
}
// Pass all of our controller values to Smarty
- $smarty->assign('section', $this->model->section);
- $smarty->assign('model', $this->model->name);
+ $smarty->assign('section', $this->section);
+ $smarty->assign('model', $this->model_name);
$smarty->assign('template', $template);
// Loads the data from the config
- $data = $this->config->getViewerData();
+ $data = $this->config->getPublicData();
if (isset($data) && is_array($data)) {
$smarty->assign('config', $data);
}
- // Loads the data from the model
- $data = $this->model->getData();
-
- if (isset($data) && is_array($data)) {
- foreach ($data as $variable => $value) {
+ // Loads the model's data
+ if (isset($this->data) && is_array($this->data)) {
+ foreach ($this->data as $variable => $value) {
$smarty->assign($variable, $value);
}
}
@@ -122,9 +119,6 @@ class Viewer_Smarty extends Viewer_Common {
}
*/
- // Load it up!
- header('Content-type: text/html; charset=UTF-8');
-
// If the index.tpl file is present, load it, else load the template directly
/**
* @todo Should there be additional logic to allow the model or the
diff --git a/models/home.php b/models/home.php
new file mode 100644
index 0000000..00d04b0
--- /dev/null
+++ b/models/home.php
@@ -0,0 +1,8 @@
+\n\t\n\t\tlocalhost\n\t\t\n\t\t\n\t\t\n\t\n\t\n\t\thome\n\t\t\n\t\t\tHome\n\t\t\tAbout\n\t\t\tContact\n\t\t\n\t\n");
+
+ // public/.htaccess
+ file_put_contents($path . 'public/.htaccess', "# Alias the static libraries\n#Alias /static/ {$pickles_path}static/\n\n# Set the PHP include path\nphp_value include_path \".:{$pickles_path}\"\n\n# Prevent session IDs from appearing\nphp_value session.use_only_cookies 1\nphp_value session.use_trans_sid 0\n\n# Sets up the mod_rewrite engine\nRewriteEngine on\n\n# Sets the base path (document root)\nRewriteBase /\n\n# Strips the trailing slash\nRewriteRule ^(.+)/$ $1 [R]\n\n# Redirects /section/action to index.php?section=&action=\nRewriteRule ^([a-z-]+)$ index.php?model=$1 [NC,QSA]\nRewriteRule ^([a-z-]+)/([a-z-]+)$ index.php?model=$1/$2 [NC,QSA]\n\n# Set up the error documents\nErrorDocument 400 /\nErrorDocument 401 /\nErrorDocument 403 /\nErrorDocument 404 /\nErrorDocument 500 /\n\n# Blocks access to .htaccess\n\n\torder allow,deny\n\tdeny from all\n");
+
+ // public/index.php
+ file_put_contents($path . 'public/index.php', "");
+
+ // models/home.php
+ file_put_contents($path . 'models/home.php', "db->getField('SELECT ...');\n\t\t// \$this->db->getRow('SELECT ...');\n\t\t// \$this->db->getArray('SELECT ...');\n\n\t\t\$this->data['message'] = \"You have successfully set up a site with PICKLES!\";\n\t}\n}\n\n?>");
+
+ // templates/index.tpl
+ file_put_contents($path . 'templates/index.tpl', "\n\t\n\t\tCongratulations\n\t\n\t\n\t\t{include file=\"\$template\"}\n\t\n");
+
+ // templates/home.tpl
+ file_put_contents($path . 'templates/home.tpl', "
Congratulations!
\n
{\$message}
");
+}
+
+?>
diff --git a/smarty/templates/ajax.tpl b/smarty/templates/ajax.tpl
deleted file mode 100644
index 0ba68e9..0000000
--- a/smarty/templates/ajax.tpl
+++ /dev/null
@@ -1 +0,0 @@
-{$type}|{$message}
diff --git a/static/contrib/fckeditor b/static/contrib/fckeditor
new file mode 120000
index 0000000..348f8cb
--- /dev/null
+++ b/static/contrib/fckeditor
@@ -0,0 +1 @@
+fckeditor-2.6.3/
\ No newline at end of file
diff --git a/static/fckeditor/_documentation.html b/static/contrib/fckeditor-2.6.3/_documentation.html
similarity index 86%
rename from static/fckeditor/_documentation.html
rename to static/contrib/fckeditor-2.6.3/_documentation.html
index ec28555..2bfcc25 100644
--- a/static/fckeditor/_documentation.html
+++ b/static/contrib/fckeditor-2.6.3/_documentation.html
@@ -1,7 +1,7 @@
+
+
+ FCKeditor - Adobe AIR Sample
+
+
+
+
+
+
+
+
+ FCKeditor - Adobe AIR Sample
+
+
+ This sample loads FCKeditor with full features enabled.
+
+
+
+
+
diff --git a/static/contrib/fckeditor-2.6.3/_samples/adobeair/sample01_cert.pfx b/static/contrib/fckeditor-2.6.3/_samples/adobeair/sample01_cert.pfx
new file mode 100755
index 0000000..ba81d1e
Binary files /dev/null and b/static/contrib/fckeditor-2.6.3/_samples/adobeair/sample01_cert.pfx differ
diff --git a/static/contrib/fckeditor-2.6.3/_samples/afp/fck.afpa b/static/contrib/fckeditor-2.6.3/_samples/afp/fck.afpa
new file mode 100755
index 0000000..99d0306
--- /dev/null
+++ b/static/contrib/fckeditor-2.6.3/_samples/afp/fck.afpa
@@ -0,0 +1 @@
+
diff --git a/static/fckeditor/_samples/afp/fck.afpa.code b/static/contrib/fckeditor-2.6.3/_samples/afp/fck.afpa.code
old mode 100644
new mode 100755
similarity index 95%
rename from static/fckeditor/_samples/afp/fck.afpa.code
rename to static/contrib/fckeditor-2.6.3/_samples/afp/fck.afpa.code
index 401ee90..f101541
--- a/static/fckeditor/_samples/afp/fck.afpa.code
+++ b/static/contrib/fckeditor-2.6.3/_samples/afp/fck.afpa.code
@@ -1,5 +1,5 @@
* FCKeditor - The text editor for Internet - http://www.fckeditor.net
- * Copyright (C) 2003-2007 Frederico Caldeira Knabben
+ * Copyright (C) 2003-2008 Frederico Caldeira Knabben
*
* == BEGIN LICENSE ==
*
@@ -163,4 +163,3 @@
RETURN (tcString)
ENDDEFINE
-
diff --git a/static/fckeditor/_samples/afp/sample01.afp b/static/contrib/fckeditor-2.6.3/_samples/afp/sample01.afp
old mode 100644
new mode 100755
similarity index 88%
rename from static/fckeditor/_samples/afp/sample01.afp
rename to static/contrib/fckeditor-2.6.3/_samples/afp/sample01.afp
index 6b770b3..2450e0d
--- a/static/fckeditor/_samples/afp/sample01.afp
+++ b/static/contrib/fckeditor-2.6.3/_samples/afp/sample01.afp
@@ -1,6 +1,6 @@
<%
* FCKeditor - The text editor for Internet - http://www.fckeditor.net
- * Copyright (C) 2003-2007 Frederico Caldeira Knabben
+ * Copyright (C) 2003-2008 Frederico Caldeira Knabben
*
* == BEGIN LICENSE ==
*
@@ -38,7 +38,7 @@
sBasePath="../../../fckeditor/" && Change this to your local path
- lcText=[This is some sample text. You are using ]
+ lcText=[
This is some sample text. You are using ]
lcText=lcText+[FCKeditor.]
oFCKeditor = CREATEOBJECT("FCKeditor")
diff --git a/static/fckeditor/_samples/afp/sample02.afp b/static/contrib/fckeditor-2.6.3/_samples/afp/sample02.afp
old mode 100644
new mode 100755
similarity index 92%
rename from static/fckeditor/_samples/afp/sample02.afp
rename to static/contrib/fckeditor-2.6.3/_samples/afp/sample02.afp
index cbf8dc8..e1baf72
--- a/static/fckeditor/_samples/afp/sample02.afp
+++ b/static/contrib/fckeditor-2.6.3/_samples/afp/sample02.afp
@@ -1,6 +1,6 @@
<%
* FCKeditor - The text editor for Internet - http://www.fckeditor.net
- * Copyright (C) 2003-2007 Frederico Caldeira Knabben
+ * Copyright (C) 2003-2008 Frederico Caldeira Knabben
*
* == BEGIN LICENSE ==
*
@@ -17,7 +17,7 @@
* http://www.mozilla.org/MPL/MPL-1.1.html
*
* == END LICENSE ==
- *
+ *
* This page is a basic Sample for FCKeditor integration in the AFP script language (www.afpages.de)
*
%>
@@ -97,7 +97,7 @@
oFCKeditor.aconfig[2,2]=lcLanguage
ENDIF
- lcText=[This is some sample text. You are using ]
+ lcText=[
This is some sample text. You are using ]
lcText=lcText+[FCKeditor.]
oFCKeditor.BasePath = sBasePath
diff --git a/static/fckeditor/_samples/afp/sample03.afp b/static/contrib/fckeditor-2.6.3/_samples/afp/sample03.afp
old mode 100644
new mode 100755
similarity index 91%
rename from static/fckeditor/_samples/afp/sample03.afp
rename to static/contrib/fckeditor-2.6.3/_samples/afp/sample03.afp
index 3d7fd17..a219e74
--- a/static/fckeditor/_samples/afp/sample03.afp
+++ b/static/contrib/fckeditor-2.6.3/_samples/afp/sample03.afp
@@ -1,6 +1,6 @@
<%
* FCKeditor - The text editor for Internet - http://www.fckeditor.net
- * Copyright (C) 2003-2007 Frederico Caldeira Knabben
+ * Copyright (C) 2003-2008 Frederico Caldeira Knabben
*
* == BEGIN LICENSE ==
*
@@ -75,7 +75,7 @@
oFCKeditor.ToolbarSet=lcToolbar
ENDIF
- lcText=[This is some sample text. You are using ]
+ lcText=[
This is some sample text. You are using ]
lcText=lcText+[FCKeditor.]
oFCKeditor.BasePath = sBasePath
diff --git a/static/fckeditor/_samples/afp/sample04.afp b/static/contrib/fckeditor-2.6.3/_samples/afp/sample04.afp
old mode 100644
new mode 100755
similarity index 92%
rename from static/fckeditor/_samples/afp/sample04.afp
rename to static/contrib/fckeditor-2.6.3/_samples/afp/sample04.afp
index fb878b8..a9d62d7
--- a/static/fckeditor/_samples/afp/sample04.afp
+++ b/static/contrib/fckeditor-2.6.3/_samples/afp/sample04.afp
@@ -1,6 +1,6 @@
<%
* FCKeditor - The text editor for Internet - http://www.fckeditor.net
- * Copyright (C) 2003-2007 Frederico Caldeira Knabben
+ * Copyright (C) 2003-2008 Frederico Caldeira Knabben
*
* == BEGIN LICENSE ==
*
@@ -82,7 +82,7 @@
oFCKeditor.aconfig[1,2]="/fckeditor/editor/skins/"+lcSkin+"/" && <-- Change this to your local path
ENDIF
- lcText=[This is some sample text. You are using ]
+ lcText=[
This is some sample text. You are using ]
lcText=lcText+[FCKeditor.]
oFCKeditor.BasePath = sBasePath
diff --git a/static/fckeditor/_samples/afp/sampleposteddata.afp b/static/contrib/fckeditor-2.6.3/_samples/afp/sampleposteddata.afp
old mode 100644
new mode 100755
similarity index 76%
rename from static/fckeditor/_samples/afp/sampleposteddata.afp
rename to static/contrib/fckeditor-2.6.3/_samples/afp/sampleposteddata.afp
index c3464f6..d1ab578
--- a/static/fckeditor/_samples/afp/sampleposteddata.afp
+++ b/static/contrib/fckeditor-2.6.3/_samples/afp/sampleposteddata.afp
@@ -1,6 +1,6 @@
<%
* FCKeditor - The text editor for Internet - http://www.fckeditor.net
- * Copyright (C) 2003-2007 Frederico Caldeira Knabben
+ * Copyright (C) 2003-2008 Frederico Caldeira Knabben
*
* == BEGIN LICENSE ==
*
@@ -27,17 +27,20 @@
]
ENDIF
NEXT
%>
diff --git a/static/fckeditor/_samples/asp/sample01.asp b/static/contrib/fckeditor-2.6.3/_samples/asp/sample01.asp
old mode 100644
new mode 100755
similarity index 88%
rename from static/fckeditor/_samples/asp/sample01.asp
rename to static/contrib/fckeditor-2.6.3/_samples/asp/sample01.asp
index e3026bc..533e91c
--- a/static/fckeditor/_samples/asp/sample01.asp
+++ b/static/contrib/fckeditor-2.6.3/_samples/asp/sample01.asp
@@ -2,7 +2,7 @@
<% Option Explicit %>
+
+
+
+
+
+ FCKeditor - Sample
+
+
+
+
+
+
FCKeditor - ColdFusion - Sample 1
+
+This sample displays a normal HTML form with a FCKeditor with full features enabled.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/static/contrib/fckeditor-2.6.3/_samples/cfm/sample01_mx.cfm b/static/contrib/fckeditor-2.6.3/_samples/cfm/sample01_mx.cfm
new file mode 100755
index 0000000..4828741
--- /dev/null
+++ b/static/contrib/fckeditor-2.6.3/_samples/cfm/sample01_mx.cfm
@@ -0,0 +1,67 @@
+
+
+
+
+
+
+
+ FCKeditor - Sample
+
+
+
+
+
+
FCKeditor - ColdFusion Component (CFC) - Sample 1
+
+This sample displays a normal HTML form with a FCKeditor with full features enabled.
+
+
+
+
+
+ This sample works only with a ColdFusion MX server and higher, because it uses some advantages of this version.
+
+
+
+
+ // Calculate basepath for FCKeditor. It's in the folder right above _samples
+ basePath = Left( cgi.script_name, FindNoCase( '_samples', cgi.script_name ) - 1 ) ;
+
+ fckEditor = createObject( "component", "#basePath#fckeditor" ) ;
+ fckEditor.instanceName = "myEditor" ;
+ fckEditor.value = '
This is some sample text. You are using FCKeditor.
+This sample shows the editor in all its available languages.
+
+
+
+ This sample works only with a ColdFusion MX server and higher, because it uses some advantages of this version.
+
+
+
+
+ This sample shows how to change the editor toolbar.
+
+
+
+ This sample works only with a ColdFusion MX server and higher, because it uses some advantages of this version.
+
+
+
+
+ This sample shows how to change the editor skin.
+
+
+
+ This sample works only with a ColdFusion MX server and higher, because it uses some advantages of this version.
+
+
+
+