\documentclass{article} \usepackage{fullpage} \usepackage{fancyhdr,lastpage} \usepackage{listings} %Enable lower sections \setcounter{secnumdepth}{5} \pagestyle{fancy} \fancyhf{} \rfoot{\scriptsize{Page \thepage\ of \pageref{LastPage}}} \renewcommand\headrulewidth{0pt} % Removes funny header line \begin{document} \begin{titlepage} \vspace*{\fill} \begin{center} \huge{{\bf Giga Creations Tools}}\\ {\bf 'GCTools'}\\ \vspace{18pt} Created by: J. 'Giga' Murphy $<$webmaster@gigacreations.net$>$\\ \vspace{12pt} README File\\ \vspace{12pt} Copyright \copyright\ Giga Creations 2010 - 2011\\ \vspace{12pt} http://www.gigacreations.net/ \end{center} \vspace*{\fill} \begin{center} Last Updated: October 27, 2011 \end{center} \end{titlepage} % Handle indentation properly. \setlength{\topmargin}{0in} \setlength{\headheight}{0in} \setlength{\headsep}{0in} \setlength{\textheight}{9in} \setlength{\textwidth}{6.5in} \setlength{\oddsidemargin}{0in} \setlength{\evensidemargin}{0in} \setlength{\parindent}{0.0in} \setlength{\parskip}{0.1in} \tableofcontents \newpage \section{About GCTools} \subsection{Purpose} GCTools was designed to help web developers create dynamic, feature-rich, applications quickly. It was not intended to be a Content Management System (CMS), a web forum, a photo gallery, a login system, or anything in particular. Instead, GCTools aimed to enable developers to create anything they wanted. This allowed GCTools to be extremely flexible, and streamlined. The developer only has to include those classes that he actually needs, not an entire library of functions that may, or may not, be needed. This is one of the reasons GCTools has been developed so extensively. The developers have put a lot of time into thinking about what it is that a developer may need, and how can we do it with the most simple implementation available. \subsection{History} The very first code of GCTools was written in early September, 2010. The initial idea was not to create a framework, but to develop a management system for an object-oriented design class at the University of Louisville. The initial code was fairly small, and only included a few classes. At the time, PHP had not really been developed with objects in mind. Most code was small scripts that was reminiscent of old C code. Although objects existed in PHP, they had not been utilized to a large extent. This was the aim of J. 'Giga' Murphy during his class... to show his class that PHP could be used as a viable object-oriented language for web development. Following the class, development came to a halt as other classes took priority. The code was commited to a private Git repository, and was largely forgotten about until late April, 2011. At this time development ramped up. Within a week more than 4 new classes were created, and much of the older code was optimized. GCTools also gained another developer, M. 'Beanyhead' Parker. Not only was a new developer added, but the project was released under the GPL v3 license, and pushed to a public GitHub repository for others to utilize. This also enabled people in the community to add to the project, and help to improve it. \subsection{Future of GCTools} The future of GCTools at this moment is unknown. Open-source developers are still needed to help contribute to the project, and the project is still lacking some major features. You may check on the status of GCTools at the project's website, http://www.gigacreations.net/ \newpage \subsection{GCTools Versioning Scheme} The version scheme for individual files uses 3 groups (Version: X.X.X). They are explained as follows: \begin{enumerate} \item First Group \begin{enumerate} \item This is the overall file version \item An integer greater than zero (0) indicates that everything in the file has been stabilized at one point. Please refer to the following groups for more information about this. \end{enumerate} \item Second Group \begin{enumerate} \item This indicates how many classes in the current file are stable. \item An integer of zero (0) means that no class is fully stable yet. \item An integer greater than zero (0) means that this many classes in the file are stable. \item This does not provide what classes are currently stable. Please refer to the change log for that information. \end{enumerate} \item Third Group \begin{enumerate} \item This is a revision number. \item It is not always updated (everyone forgets things sometimes), and thus shouldn't be relied upon. \item Basically, the higher the revision number, the greater likelihood that a particular class is almost stable. \end{enumerate} \end{enumerate} \subsection{Contributing to GCTools} Contributions to the code of GCTools are always welcome. This is why we have released the code under the GPL v3 license. If you haven't already, feel free to fork our project on the GitHub site. Additionally, if you'd like to become a long-term contributor to GCTools, please send us an e-mail at webmaster@gigacreations.net with some more information about you so we can add you as a contributor to the GitHub repository. \newpage \section{Installing GCTools} \subsection{Getting the files} There are multiple ways to obtain the GCTools files. Each way has it's own little path, and each has advantages/disadvantages. If you want a stable release, please make sure you read this section carefully. If you want the most bleeding-edge release that probably hasn't been tested, then you should follow the Git instructions. \subsubsection{From our Website} From time-to-time we will release a version of GCTools that we feel is stable. It will be found at our project page on http://www.gigacreations.net/gctools/. This page will provide you with a link to download any of our stable releases. If you have problems getting the release, please use the support, or contact, pages to report the issue. \subsubsection{From our GitHub Repository} The Git repository is the central location for all GCTools files. It is constantly being updated with new designs, bugfixes, refined features, etc. Our Git repository is on GitHub at http://github.com/giga1699/GCTools. From there you can download a zip archive of the current files, or get the address to pull the data using Git on your own system. If you wish for GCTools to be up-to-date, you should use Git on your system. It will allow you to pull the updated code with a single command. You must keep in mind that the code you pull from our Git repository may not be tested, and could break parts of GCTools that are already in place. \subsection{Enabling GCTools on your Web Server} There are numerous ways to utilize GCTools within your existing, or new, code. Our recommendation is to put the GCTools files in another directory on your web server that is not accessible from the internet. Then, go into your php.ini file, and add the path to GCTools into the default include path for PHP. When you do that, be sure to make the path to GCTools, and the files, readable by your web server user. They SHOULD NOT be writable by that user. \newpage \section{GCTools Files} \subsection{autoload.inc.php} \subsubsection{Class Variables} There are no class variables \subsubsection{Class Functions} The only function is the '\_\_autoload' function which is a ''magic'' PHP function that tries to include the right file based on what class you are trying to use. It has not been tested in GCTools, but was developed to try to assist new users in loading the proper files before using a class. \newpage \subsection{cache.inc.php} \subsubsection{Class Variables} \begin{enumerate} \item cacheDir: This defines the directory to store cached files. It must exist, and be writable. \end{enumerate} \subsubsection{Class Functions} \begin{enumerate} \item Cache(\$cacheDir) \begin{enumerate} \item \$cacheDir defines the directory to store cached files \item Pre/Post Conditions: \begin{enumerate} \item Precondition: The \$cacheDir should be defined. \item Postcondition: The cache class is initialized. \end{enumerate} \item This function initializes the Cache class. It ensures that the cache directory exists, and is writable. If the directory does not exist, or is not writable, an exception is thrown. \end{enumerate} \item getCacheDir() \begin{enumerate} \item Pre/Post Conditions: \begin{enumerate} \item Precondition: \$cacheDir should be set \item Postcondition: Returns the \$cacheDir, or FALSE otherwise \end{enumerate} \item This function provides the user with the location of the cache directory. \end{enumerate} \item setCacheDir(\$dir) \begin{enumerate} \item \$dir defines the new location of the directory to store cached files. \item Pre/Post Conditions: \begin{enumerate} \item Precondition: \$dir should be set, and a writable directory \item Postcondition: Return TRUE on success, and FALSE otherwise \end{enumerate} \item This function allows the user to change the location of the cache directory after the class has already been initialized. \end{enumerate} \item createCache(\$file) \begin{enumerate} \item \$file defines the path to the file to be cached \item Pre/Post Conditions: \begin{enumerate} \item Precondition: \$file should be a valid file \item Postcondition: Create a cache of the file and return TRUE on success, or FALSE on failure \end{enumerate} \item This function allows the user to create a cache of a file. \end{enumerate} \end{enumerate} \newpage \subsubsection{Class Example} \begin{lstlisting} <?php require_once('cache.inc.php'); try { $cache = new Cache('/path/to/my/cache/directory') } catch (Exception $e) { //There was some kind of error, so handle it } if (!$cache->createCache('/path/to/my/file')) { //There was an error creating the cache } //We're done. The cached file is /path/to/my/cache/directory/file.cache.html ?> \end{lstlisting} \newpage \subsection{computer.inc.php} \subsubsection{Class Variables} \begin{enumerate} \item id: Defines a unique ID for the computer system. \item name: Defines the computer's name (generally the DNS name). \item mac: Defines the computer's MAC address. \item ip: Defines the IPv4 address of the computer. \item ip6: Defines the IPv6 address of the computer (if needed). \item osType: Defines the type of operating system. \item osName: Defines the operating system's name. \item serial: Defines the serial number for the computer. \item location: Defines a location for the computer. \item make: Defines the make (manufacturer) of the computer. \item model: Defines the model of the computer. \item cpu: Defines CPU information. \item ram: Defines RAM information. \item hdd: Defines hard drive information. \item licensing: Defines licensing information. \item notes: Defines additional notes about the computer. \end{enumerate} \subsubsection{Class Functions} \begin{enumerate} \item Computer() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: None \item Postcondition: Sets up the Computer class variables for use \end{enumerate} \item This function is the class constructor. It sets up all the variables for use. \end{enumerate} \item getID() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: id should be definied \item Postcondition: Return the ID of the computer, or FALSE otherwise \end{enumerate} \item This function allows the user to get the unique ID of the computer. \end{enumerate} \item setID(\$newID) \begin{enumerate} \item \$newID: Defines a new unique ID for the computer. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: \$newID should be defined \item Postcondition: Set the ID \end{enumerate} \item This function allows the user to set the unique ID for the computer. \end{enumerate} \item getName() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: name should be defined \item Postcondition: Return the name of the computer, or FALSE otherwise. \end{enumerate} \item This function allows the user to get the name of the computer. \end{enumerate} \item setName(\$newName) \begin{enumerate} \item \$newName: Defines the new name for the computer. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: \$newName should be defined \item Postcondition: Set the new name of the computer. \end{enumerate} \item This function allows the user to set the name of the computer. \end{enumerate} \item getMac() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: mac should be defined \item Postcondition: Return the MAC address of the computer, or FALSE otherwise \end{enumerate} \item This function allows the user to get the MAC address of the computer. \end{enumerate} \item setMac(\$macAddress) \begin{enumerate} \item \$macAddress: Defines the MAC address of the computer. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: \$macAddress should be defined, and be a valid MAC address \item Postcondition: Set the MAC address of the computer. \end{enumerate} \item This function allows the user to set the MAC address of a computer. \end{enumerate} \item getIP() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: ip should be defined \item Postcondition: Return the IP address, or FALSE otherwise \end{enumerate} \item This function allows the user to get the IP address of a computer. \end{enumerate} \item setIP(\$ipAddr) \begin{enumerate} \item \$ipAddr: Defines the IPv4 IP address of the computer. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: \$ipAddr should be defined, and a valid IPv4 address \item Postcondition: Set the IPv4 address \end{enumerate} \item This function allows the user to set an IPv4 address for the computer. \end{enumerate} \end{enumerate} \newpage \subsubsection{Class Example} This class is still being constructed \newpage \subsection{database.inc.php} \subsubsection{Class Variables} \paragraph{Database Class} \begin{enumerate} \item dbType: defines the type of database that is being used. \item dbLoc: defines the location of the database. This can be an IP address, a hostname, a file location, etc. \item dbUser: defines the username used to connect to the database, if needed. \item dbPass: defines the password used to connect to the database, if needed. \item dbName: defines the name of the database to use. \item lastError: defines the text of the last error that occurred, if any. \end{enumerate} \paragraph{MySQL Class} \begin{enumerate} \item myCon: defines the MySQL connection \end{enumerate} \paragraph{MSSQL Class} \paragraph{PGSQL Class} \paragraph{SQLite Class} \subsubsection{Class Functions} \paragraph{Database Class} \begin{enumerate} \item (Protected) Database(\$loc, \$user, \$pass, \$name, \$type) \begin{enumerate} \item \$loc defines the location of the database. This may be an IP address, a hostname or a location on the server. \item \$user defines the username used to login to the database. \item \$pass defines the password used in conjunction to the username to log into the server. \item \$name defines the default database to begin working with. \item \$type defines the type of database you will be working with. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: The database location, username, password, name and type should be defined. \item Postcondition: The class will set-up the variables that will be used to connect to the database, and conduct queries. \end{enumerate} \item This sets up the class to perform database operations. \end{enumerate} \item hasError() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: None \item Postcondition: Returns TRUE if an error has occurred, and FALSE otherwise \end{enumerate} \item This function will enable the user to check if an error has occurred during a database operation. \end{enumerate} \item getLastError() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: An error should have occurred. \item Postcondition: Returns the error message the the database gave when the last error occurred. \end{enumerate} \item This function gets the last error message provided by the database. \end{enumerate} \item (protected) resetError() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: None. \item Postcondition: Any error is cleared from the class. \end{enumerate} \item This function is used internally by the class to clear any previous errors that occurred. \end{enumerate} \end{enumerate} \paragraph{MySQL Class} \begin{enumerate} \item 1. MySQL(\$loc, \$user, \$pass, \$name, \$errorCallback=NULL) \begin{enumerate} \item \$loc defines the location of the MySQL server. This can be either an IP address, or a hostname. \item \$user defines the username used to log into the MySQL server. \item \$pass defines the password used in conjunction with the username to log into the database. \item \$name defines the default database to use to perform database functions. \item \$errorCallback defines the callback function to send the error an additional way, if one occurs. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: The location of the SQL server, the username, the password and the database name is given. \item Postcondition: The MySQL server is connected to \end{enumerate} \item This function connects to a MySQL server to perform MySQL functions. It will attempt to load the MySQL libraries, if they are not already loaded. It will also initialize it's parent Database class so you can use all the functionality of the abstract Database class. \end{enumerate} \item (Private) connect() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: The MySQL class should be set up properly. \item Postcondition: The connection to the MySQL server is made, or errors or handled. \end{enumerate} \item This function is the one that actually makes the connection to the MySQL database. \end{enumerate} \item (Protected) throwError([\$specialError]) \begin{enumerate} \item \$specialError defines a unique error that MySQL may not handle by itself, or an error that occurs before a MySQL connection is established \item Pre/Post-conditions: \begin{enumerate} \item Precondition: An error should have occurred \item Postcondition: The error is created in the Database class with the proper information. \end{enumerate} \item This function is called internally when any error has occurred during MySQL operations. \end{enumerate} \item query(\$qString) \begin{enumerate} \item \$qString defines the SQL Query string to be executed. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: A query should be presented \item Postcondition: The class will attempt to execute the query, and handle any errors. \end{enumerate} \item {\bf SECURITY NOTE:} The user is responsible for handling any sort of SQL injection type attacks. This function DOES NOT handle this by itself. \item This function takes a SQL query, and tries to execute it on a MySQL database. It will also handle any errors that occur during the execution of the query. \end{enumerate} \item changeDB(\$dbName) \begin{enumerate} \item \$dbName defines the new database to use for queries. \item Pre/Post-conditions: \begin{enumerate} \item Precondition: A database name is given \item Postcondition: The class attempts to change the database to use for MySQL operations. Returns TRUE on success, and FALSE on failure. \end{enumerate} \item This function changes the database that is used to execute queries. \end{enumerate} \item escapeString(\$string) \begin{enumerate} \item \$string defines a string to escape using MySQL \item Pre/Post-conditions: \begin{enumerate} \item Precondition: A string should be given \item Postcondition: The string is escaped using the current MySQL connection. \end{enumerate} \item This function escapes a string to be safe in a MySQL query. \end{enumerate} \item connected() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: None \item Postcondition: Returns TRUE if the MySQL connection is active, and FALSE otherwise \end{enumerate} \item This function informs the user if the MySQL connection is still active, or not. \end{enumerate} \item reconnect() \begin{enumerate} \item Pre/Post-conditions: \begin{enumerate} \item Precondition: None \item Postcondition: Will close any current connection, and re-establish a connection to the MySQL server \end{enumerate} \item This function is used to reconnect to a MySQL server. It is used internally if the MySQL connection is lost, and can be used by the user to reconnect using the given credentials at initialization time. \end{enumerate} \item setErrorCallback(\$callback) \begin{enumerate} \item \$callback Defines a callback function that is called when a MySQL error occurs \item Pre/Post-conditions: \begin{enumerate} \item Precondition: \$callback should be defined \item Postcondition: Set the errorCallback. Returns TRUE on success, and FALSE otherwise. \end{enumerate} \item This function allows the user to set/change the error callback after the MySQL class has been initialized. \end{enumerate} \end{enumerate} \paragraph{MSSQL Class} This class is still under development, and has not been tested. \paragraph{PGSQL Class} This class is still under development, and has not been tested. \paragraph{SQLite Class} This class is still under development, and has not been tested. \newpage \subsubsection{Class Example} \begin{lstlisting} <?php require_once('database.inc.php'); require_once('error.inc.php'); $errorHandler = new Error('errorto@mydomain.com', 'errorfrom@somedomain.com'); $errorHandler->setErrorSubject('MySQL Error'); try { $mysql = new MySQL('hostname', 'username', 'password', \ 'database', array($errorHandler, 'sendError')); } catch (Exception $e) { //Something went wrong echo $mysql->getLastError(); } //Let's do a query $mysql->query("SELECT * FROM `users` WHERE `username`='" . \ $mysql->escapeString($username) . "'"); //Check if we're still connected if (!$mysql->connected()) $mysql->reconnect(); ?> \end{lstlisting} \newpage \subsection{error.inc.php} \subsubsection{Class Variables} \paragraph{\(abstract\) GCError Class} \begin{enumerate} \item errorFrom: Defines the e-mail address to display in the “From:” header when sending an error e-mail \item errorTo: Defines who error e-mails should be sent to \item errorSubject: Defines the subject for the e-mail when sending error e-mails \end{enumerate} \paragraph{GCErrorHandler Class} \begin{enumerate} \item errorHandlerSet: Defines if the GCErrorHandler has been set for errors. \item exceptionHandlerSet: Defines if the GCErrorHander has been set for exceptions. \end{enumerate} \subsubsection{Class Functions} \newpage \subsubsection{Class Example} \begin{lstlisting} <?php require_once("error.inc.php"); try { $error = new GCErrorHandler("to@errormessage.com", \ "from@errorsfrom.com"); } catch (Exception $e) { //Handle class init error here } $error->setErrorSubject("THERE WAS AN ERROR!"); $error->sendError("There was an error in a script. Please go take a look at it."); ?> \end{lstlisting} \newpage \section{Credits} \subsection{Code Contributors} \begin{enumerate} \item J. ''Giga'' Murphy \begin{enumerate} \item E-Mail: webmaster@gigacreations.net \item Website: http://www.gigacreations.net/ \end{enumerate} \item M. ''Beanyhead'' Parker \begin{enumerate} \item E-Mail: beanyhead@gmail.com \item Website: http://www.nomits.com/ \end{enumerate} \item N. Miles \item R. Rios \end{enumerate} \newpage \section{Change Log} This is still in the works \newpage \section{License} GCTools has been released under the GPL v3 license. \subsection{GPL v3} GPL v3 License GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. $<$http://fsf.org/$>$ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. 'This License' refers to version 3 of the GNU General Public License. 'Copyright' also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. 'The Program' refers to any copyrightable work licensed under this License. Each licensee is addressed as 'you'. 'Licensees' and 'recipients' may be individuals or organizations. To 'modify' a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a 'modified version' of the earlier work or a work 'based on' the earlier work. A 'covered work' means either the unmodified Program or a work based on the Program. To 'propagate' a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To 'convey' a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays 'Appropriate Legal Notices' to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The 'source code' for a work means the preferred form of the work for making modifications to it. 'Object code' means any non-source form of a work. A 'Standard Interface' means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The 'System Libraries' of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A 'Major Component', in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The 'Corresponding Source' for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to 'keep intact all notices'. c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an 'aggregate' if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A 'User Product' is either (1) a 'consumer product', which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, 'normally used' refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. 'Installation Information' for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. 'Additional permissions' are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered 'further restrictions' within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An 'entity transaction' is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A 'contributor' is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's 'contributor version'. A contributor's 'essential patent claims' are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, 'control' includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a 'patent license' is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To 'grant' such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. 'Knowingly relying' means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is 'discriminatory' if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License 'or any later version' applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM 'AS IS' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS \end{document}