From: Ian Jackson Date: Fri, 14 Aug 2009 19:17:55 +0000 (+0100) Subject: Merge branch 'stable-3.x' X-Git-Tag: 3.4~189 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-test.git;a=commitdiff_plain;h=efc8497c2414dfded724d7181e11df53b947e387;hp=89ac616c0df890ff63e6b7db5ae2a3c084e2f2c1 Merge branch 'stable-3.x' --- diff --git a/.gitignore b/.gitignore index 5796988..a058839 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ yarrg/yarrg yarrg/_*.* yarrg/OCEAN-*.db yarrg/Writer.lock +yarrg/DATA diff --git a/COPYING b/COPYING index 4432540..508a35e 100644 --- a/COPYING +++ b/COPYING @@ -1,3 +1,22 @@ +This licence applies to the general purpose ypp-sc-tools, the +YARRG client code and code shared with the YARRG website. + +It DOES NOT apply to: + + * The code for YARRG website, which is also Free Software + but covered by the Affero GPL - see COPYING.WEBSITE. + + * master-info.txt, ocean-*.txt, which contain information about the + Yohoho Puzzle Pirates world. Insofar as this information is + Copyright by Three Rings (the company behind Puzzle Pirates) + I believe that our usage is Fair Dealing. + + * The market data presented through the website. This is + a collection of facts and not subject to copyright. + +See the individual files' copyright notices for details. + + GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 diff --git a/COPYING.WEBSITE b/COPYING.WEBSITE new file mode 100644 index 0000000..4c0dff4 --- /dev/null +++ b/COPYING.WEBSITE @@ -0,0 +1,667 @@ +This licence applies to the YARRG website, whose files can be found in: + yarrg/CommodsWeb.pm + yarrg/web/ +See the individual files' copyright notices for details. + + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/yarrg/Commods.pm b/yarrg/Commods.pm index b90e6d7..0f7ebd6 100644 --- a/yarrg/Commods.pm +++ b/yarrg/Commods.pm @@ -41,7 +41,8 @@ BEGIN { &pipethrough_prep &pipethrough_run &pipethrough_run_along &pipethrough_run_finish &pipethrough_run_gzip - &cgipostform &yarrgpostform &cgi_get_caller); + &cgipostform &yarrgpostform &cgi_get_caller + &set_ctype_utf8); %EXPORT_TAGS = ( ); @EXPORT_OK = qw(); @@ -356,4 +357,8 @@ sub cgi_get_caller () { return $caller; } +sub set_ctype_utf8 () { + setlocale(LC_CTYPE, "en.UTF-8"); +} + 1; diff --git a/yarrg/CommodsDatabase.pm b/yarrg/CommodsDatabase.pm index 6f2f627..79744ce 100644 --- a/yarrg/CommodsDatabase.pm +++ b/yarrg/CommodsDatabase.pm @@ -44,18 +44,39 @@ BEGIN { $VERSION = 1.00; @ISA = qw(Exporter); @EXPORT = qw(&db_setocean &db_writer &db_connect $dbh - &db_filename &db_doall &db_onconflict); + &db_filename &db_doall &db_onconflict + &dbr_filename &dbr_connect); %EXPORT_TAGS = ( ); @EXPORT_OK = qw(); } +sub dbr_filename ($$) { + my ($datadir,$oceanname) = @_; + return "$datadir/OCEAN-$oceanname.db"; +} +sub dbr_connect ($$) { + my ($datadir,$ocean) = @_; + return connect_core(dbr_filename($datadir,$ocean)); +} + +sub connect_core ($) { + my ($fn)= @_; + my $h= DBI->connect("dbi:SQLite:$fn",'','', + { AutoCommit=>0, + RaiseError=>1, ShowErrorStatement=>1, + unicode=>1 }) + or die "$fn $DBI::errstr ?"; + return $h; + # default timeout is 30s which is plenty +} + our $dbfn; our $dbh; sub db_setocean ($) { my ($oceanname) = @_; - $dbfn= "OCEAN-$oceanname.db"; + $dbfn= dbr_filename('.',$oceanname); } sub db_filename () { return $dbfn; @@ -89,12 +110,7 @@ sub db_writer () { } sub db_connect () { - $dbh= DBI->connect("dbi:SQLite:$dbfn",'','', - { AutoCommit=>0, - RaiseError=>1, ShowErrorStatement=>1, - unicode=>1 }) - or die "$dbfn $DBI::errstr ?"; - # default timeout is 30s which is plenty + $dbh= connect_core($dbfn); } sub db_doall ($) { diff --git a/yarrg/CommodsWeb.pm b/yarrg/CommodsWeb.pm new file mode 100644 index 0000000..5f85511 --- /dev/null +++ b/yarrg/CommodsWeb.pm @@ -0,0 +1,113 @@ +# This is part of the YARRG website. YARRG is a tool and website +# for assisting players of Yohoho Puzzle Pirates. +# +# Copyright (C) 2009 Ian Jackson +# Copyright (C) 2009 Clare Boothby +# +# YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). +# The YARRG website is covered by the GNU Affero GPL v3 or later, which +# basically means that every installation of the website will let you +# download the source. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and +# are used without permission. This program is not endorsed or +# sponsored by Three Rings. + + +# This Perl module is used by the Mason scripts in yarrg/web/. +# We look for a symlink DATA to the actual data to use, so that +# the data uploader and website displayer can use different code. + +package CommodsWeb; + +use strict; +use warnings; + +use DBI; +use POSIX; +use JSON; + +use Commods; +use CommodsDatabase; + +our $self_url; +our $base_url; + +BEGIN { + use Exporter (); + our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS); + $VERSION = 1.00; + @ISA = qw(Exporter); + @EXPORT = qw(&dbw_connect &ocean_list $sourcebasedir + &to_json &to_json_protecttags + &set_ctype_utf8); + %EXPORT_TAGS = ( ); + + @EXPORT_OK = qw(); +} + +our $datadir='.'; +our $sourcebasedir; + +for my $dir (@INC) { + if ($dir =~ m/\.perl-lib$/) { + $sourcebasedir= "$dir/.."; + if (stat "$dir/DATA") { + $datadir= "$dir/DATA"; + } elsif ($!==&ENOENT) { + $datadir= "$dir"; + } else { + die "stat $dir/DATA $!"; + } + last; + } +} +defined $sourcebasedir or + die "no source base dir in @INC"; + +my @ocean_list; + +sub ocean_list () { + if (!@ocean_list) { + my $fn= "$datadir/master-info.txt"; + my $f= new IO::File $fn or die $!; + my @r; + while (<$f>) { + next unless m/^ocean\s+(\S.*\S)\s*$/; + push @r, $1; + } + $f->error and die $!; + close $fn; + @ocean_list= @r; + } + return @ocean_list; +} + +sub dbw_connect ($) { + my ($ocean) = @_; + die "unknown ocean $ocean ?" + unless grep { $_ eq $ocean } ocean_list(); + return dbr_connect($datadir, $ocean); +} + +sub to_json_protecttags ($) { + my ($v) = @_; + my $j= to_json($v); + $j =~ s,/,\\/,g; + return $j; +} + +1; diff --git a/yarrg/README b/yarrg/README index f3ff5f6..ac0240e 100644 --- a/yarrg/README +++ b/yarrg/README @@ -148,8 +148,8 @@ GUI. See README.privacy for full details. -Authorship and copyright ------------------------- +Disclaimers, authorship and copyright +------------------------------------- The PCTB server is a project of Joel Lord and various others. @@ -157,32 +157,43 @@ The YARRG server was inspired by PCTB and is a project of the crew Special Circumstances (on the Midnight Ocean) and of the Sinister Greenend Organisation. +PCTB and YARRG are both completely unofficial and Three Rings, the +operators of Yohoho Puzzle Pirates, have nothing to do with either of +them. Please refer queries to us, not to Three Rings. If you want to +reuse the code here to do substantially novel things, you should ask +Three Rings for permission (for example, by petitioning an Ocean +Master). + This yarrg screenscraper and upload client was written entirely from -scratch by me, Ian Jackson, with assistance from Stephen Early. It is -part of ypp-sc-tools, a set of third-party tools for assisting players -of Yohoho Puzzle Pirates. +scratch by me, Ian Jackson, with assistance from Stephen Early and +Clare Boothby. It is part of ypp-sc-tools, a set of third-party tools +for assisting players of Yohoho Puzzle Pirates. -ypp-sc-tools is +ypp-sc-tools and YARRG are Copyright (C) 2009 Ian Jackson Copyright (C) 2009 Stephen Early +Copyright (C) 2009 Clare Boothby¬ 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. +it under the terms of + (a) for the website code, the GNU Affero General Public License and + (b) for the rest of the code, GNU General Public License +as published by the Free Software Foundation, either version 3 of +each applicable 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 . +You should have received a copy of the GNU General Public License and +GNU Affero General Public License along with this program. If not, +see . Yohoho and Puzzle Pirates are probably trademarks of Three Rings and -are used without permission. This program is not endorsed or -sponsored by Three Rings. +are used without permission. Once again, this program is not endorsed +or sponsored by Three Rings. The character and UI images copied from the YPP client, and submitted diff --git a/yarrg/commod-email-processor b/yarrg/commod-email-processor index 0c16cd1..b395aa8 100755 --- a/yarrg/commod-email-processor +++ b/yarrg/commod-email-processor @@ -39,7 +39,7 @@ BEGIN { use Commods; use CommodsDatabase; -setlocale(LC_CTYPE, "en_GB.UTF-8"); +set_ctype_utf8(); my $parser= new MIME::Parser; our $entity; diff --git a/yarrg/commod-update-receiver b/yarrg/commod-update-receiver index 3ae1a62..4ae267d 100755 --- a/yarrg/commod-update-receiver +++ b/yarrg/commod-update-receiver @@ -35,7 +35,7 @@ $CGI::POST_MAX= 3*1024*1024; use CGI qw/:standard -private_tempfiles/; -setlocale(LC_CTYPE, "en_GB.UTF-8"); +set_ctype_utf8(); our $now= time; defined $now or die $!; diff --git a/yarrg/web/.perl-lib b/yarrg/web/.perl-lib new file mode 120000 index 0000000..a96aa0e --- /dev/null +++ b/yarrg/web/.perl-lib @@ -0,0 +1 @@ +.. \ No newline at end of file diff --git a/yarrg/web/autohandler b/yarrg/web/autohandler new file mode 100644 index 0000000..b0d7d98 --- /dev/null +++ b/yarrg/web/autohandler @@ -0,0 +1,22 @@ + + + +% $m->call_next; + +<%init> +use CommodsWeb; +set_ctype_utf8(); +$r->content_type('text/html; charset=UTF-8'); + diff --git a/yarrg/web/check b/yarrg/web/check new file mode 100755 index 0000000..56a1be1 --- /dev/null +++ b/yarrg/web/check @@ -0,0 +1,7 @@ +Stuff +
+@INC = <% join ':', @INC |h %>
+% foreach my $e (sort keys %ENV) {
+<% $e |h%>=<% $ENV{$e} |h%>
+% }
+
diff --git a/yarrg/web/copyrightdate b/yarrg/web/copyrightdate
new file mode 100644
index 0000000..26b7264
--- /dev/null
+++ b/yarrg/web/copyrightdate
@@ -0,0 +1 @@
+Copyright 2009 Ian Jackson, Steve Early, Clare Boothby
\ No newline at end of file
diff --git a/yarrg/web/dataage b/yarrg/web/dataage
new file mode 100644
index 0000000..851e5d8
--- /dev/null
+++ b/yarrg/web/dataage
@@ -0,0 +1,130 @@
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson 
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as
+ published by the Free Software Foundation, either version 3 of the
+ License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program.  If not, see .
+
+ Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+ are used without permission.  This program is not endorsed or
+ sponsored by Three Rings.
+
+
+ This Mason component generates the core of the `data age' query.
+
+
+
+<%once>
+my $meta_prettyprint_age= sub {
+    my ($age,$floor,$plus) = @_;
+    return <('$age','floor','.').'
+  };
+' or die "$@";
+
+
+
+<%perl>
+
+my $now= time;
+
+my $row;
+my $sth= $dbh->prepare("SELECT archipelago, islandid, islandname, timestamp
+				FROM uploads NATURAL JOIN islands
+				ORDER BY archipelago, islandid");
+$sth->execute();
+
+
+
+<&| script &>
+  da_pageload= Date.now();
+
+
+
+
+
+% my %da_ages;
+% $da_ages{'daid_loaded'}= 0;
+% while ($row=$sth->fetchrow_hashref) {
+%	my $elid= "daid_$row->{'islandid'}";
+%	my $age= $now - $row->{'timestamp'};
+%	$da_ages{$elid}= $age;
+
+% }
+
Archipelago +Island +Age +
<% $row->{'archipelago'} |h + %> <% $row->{'islandname'} |h + %> <% $prettyprint_age->($age) %>
+ +

+Time since this page loaded: +(not known; times above not updating) + +

+% foreach my $a (keys %ARGS) { + +% } + +
+ +<&| script &> + da_ages= <% to_json_protecttags(\%da_ages) %>; + + function da_Refresh() { + var now= Date.now(); + debug('updating now='+now); + for (var elid in da_ages) { + var el= document.getElementById(elid); + var oldage= da_ages[elid]; + var age= oldage + (now - da_pageload) / 1000; + var newhtml= <% $meta_prettyprint_age->('age','Math.floor','+') %> +% if ($ARGS{debug}) { + if (elid == 'daid_loaded') + debug('element elid='+elid+' oldage='+oldage+' age='+age+': '+newhtml); +% } + el.innerHTML= newhtml; + } + } + + window.onload= da_Refresh; + window.setInterval(da_Refresh, 10000); + + +<%init> +use POSIX; +use CommodsWeb; +my $dbh= dbw_connect('Midnight'); + diff --git a/yarrg/web/docs b/yarrg/web/docs new file mode 100755 index 0000000..0ea31cf --- /dev/null +++ b/yarrg/web/docs @@ -0,0 +1,138 @@ +<%doc> + + This is part of the YARRG website. YARRG is a tool and website + for assisting players of Yohoho Puzzle Pirates. + + Copyright (C) 2009 Ian Jackson + Copyright (C) 2009 Clare Boothby + + YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). + The YARRG website is covered by the GNU Affero GPL v3 or later, which + basically means that every installation of the website will let you + download the source. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + are used without permission. This program is not endorsed or + sponsored by Three Rings. + + + This Mason component generates the documentation. + + + +YARRG (Yet Another Revenue Research Gatherer) + + +

Introduction to YARRG

+ +YARRG (Yet Another Revenue Research Gatherer) is a third-party tool +for helping find profitable trades and trade routes in Yohoho Puzzle +Pirates. It was inspired by +PCTB. + +

+ +The system has two main parts: this website which maintains a +searchable database of commodity prices, and an upload client, which +screenscrapes the commodity data from the Puzzle Pirates game client +and uploads it to the database. + +

Market prices database

+ +The lookup page gives access to the uploaded data. + +

Uploading from Linux

+ +The YARRG upload client uploads both to YARRG and to the +PCTB testing server. + +

+ +The current official version of YARRG for use as an upload +client can browsed here: + http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/ +See particularly the +YARRG README. + +

+To install the client, install the `git' version control system +and the other dependencies listed in the `Installation requirements' +section of the README and then run: +

+git-clone http://www.chiark.greenend.org.uk/~ijackson/ypp-sc-tools/master/.git ypp-sc-tools
+cd ypp-sc-tools
+cd yarrg
+make
+
+this will download the code into the directory ypp-sc-tools, +and build the software. + +

+ +When new versions of the upload client are released, you can: +

+cd .../ypp-sc-tools
+git-pull
+cd yarrg
+make
+
+to fetch the new version. + +

Uploading from Windows

+ +There is not currently an upload client for Windows which feeds data +into YARRG. It would probably be straightforward to modify the +Windows PCTB v5 upload client to upload to YARRG as well. The +mechanism and format for uploading is documented in +README.devel. + +

YARRG development, contribution and troubleshooting

+ +

Free Software (aka Open Source)

+ +YARRG is Free Software - you may share and modify it. See the +licences for details. + +

+ +Not only the client but also the webserver code is Free. The website +code can be found in the same tree as above, in the web +directory. + +

+ +But in case we have made changes but not yet pushed them +(perhaps because we haven't done a release), and to make it easy for +anyone else who runs a copy of the website to provide everyone with +the source for their version, the website code itself lets you download +an up-to-date tarball of its +actually-running source code. + +

+ +If you would like to run a (perhaps modified) copy of the YARRG +website it would be very easy for us to make our system send you +copies of updates submitted by users of the official YARRG client, in +the format expected by the code you'll be running. Please just ask +us. + +

Contacting the YARRG developers

+ +Email Ian Jackson ijackson (at) chiark.greenend.org.uk. Or talk to +any Fleet Officer or above of the crew Special Circumstances on the +Midnight Ocean. + +<& footer, isdocs => 1 &> diff --git a/yarrg/web/footer b/yarrg/web/footer new file mode 100644 index 0000000..8af45ad --- /dev/null +++ b/yarrg/web/footer @@ -0,0 +1,62 @@ +<%doc> + + This is part of the YARRG website. YARRG is a tool and website + for assisting players of Yohoho Puzzle Pirates. + + Copyright (C) 2009 Ian Jackson + Copyright (C) 2009 Clare Boothby + + YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). + The YARRG website is covered by the GNU Affero GPL v3 or later, which + basically means that every installation of the website will let you + download the source. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + are used without permission. This program is not endorsed or + sponsored by Three Rings. + + + This Mason component is simply the page footer. + + + +<%args> +$isdocs => 0 + +
+
+YARRG is Yet Another Revenue Research Gatherer, a project of the +crew Special Circumstances on the Midnight Ocean +and of the Sinister Greenend Organisation. +

+ +YARRG is Free Software. +You may share and modify the code and the +website, according to the terms of the GNU General Public Licence and +the GNU Affero General Public Licence respectively (v3 or later). +% if (!$isdocs) { +Please see the YARRG documentation webpage for +details of how to obtain the client and server code and full details +of the licences. +% } + +

+YARRG is <& copyrightdate &>. +Yohoho and Puzzle Pirates are trademarks of Three Rings and are used +without permission. YARRG is not endorsed or sponsored by Three +Rings. + +

diff --git a/yarrg/web/lookup b/yarrg/web/lookup new file mode 100755 index 0000000..931594a --- /dev/null +++ b/yarrg/web/lookup @@ -0,0 +1,418 @@ +<%doc> + + This is part of the YARRG website. YARRG is a tool and website + for assisting players of Yohoho Puzzle Pirates. + + Copyright (C) 2009 Ian Jackson + Copyright (C) 2009 Clare Boothby + + YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). + The YARRG website is covered by the GNU Affero GPL v3 or later, which + basically means that every installation of the website will let you + download the source. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + are used without permission. This program is not endorsed or + sponsored by Three Rings. + + + This Mason component generates the main `lookup' page, including + all the entry boxes etc. for every query. + + + +<%perl> +my %a; +my %ahtml; +my @vars; + +# for output: +my @archipelagoes; +my @islandids; +my %islandid2; + +#---------- "mode" argument parsing and mode menu at top of page ---------- + +# for debugging, invoke as +# http://www.chiark.greenend.org.uk/ucgi/~clareb/mason/pirates/pirate-route?debug=1 + +@vars= ({ Name => 'Ocean', + Before => 'Ocean: ', + CmpCanon => sub { ucfirst lc $_[0] }, + Values => [ ocean_list() ] + }, { Name => 'Dropdowns', + Before => 'Interface: ', + CmpCanon => sub { !!$_[0] }, + Values => [ [ 0, 'Type in names' ], + [ 4, 'Select from menus' ] ] + }, { Name => 'Query', + Before => 'Query: ', + Values => [ [ 'route', 'Trades for route' ], + [ 'age', 'Data age' ] ] + }); + +foreach my $var (@vars) { + my $name= $var->{Name}; + my $lname= lc $name; + $var->{Before}= '' unless exists $var->{Before}; + $var->{CmpCanon}= sub { $_[0]; } unless exists $var->{CmpCanon}; + foreach my $val (@{ $var->{Values} }) { + next if ref $val; + $val= [ $val, encode_entities($val) ]; + } + if (exists $ARGS{$lname}) { + $a{$name}= $ARGS{$lname}; + my @html= grep { $_->[0] eq $a{$name} } @{ $var->{Values} }; + $ahtml{$name}= @html==1 ? $html[0][1] : '???'; + } else { + $a{$name}= $var->{Values}[0][0]; + $ahtml{$name}= $var->{Values}[0][1]; + } +} + + +<% ucfirst $ahtml{Query} %> - YARRG + +YARRG - + Yet Another Revenue Research Gatherer +| +documentation +

+<%perl> + +my %baseqf; +foreach my $var (@vars) { + my $lname= lc $var->{Name}; + next unless exists $ARGS{$lname}; + $baseqf{$lname}= $ARGS{$lname}; +} + +my %queryqf; +foreach my $var (keys %ARGS) { + next unless $var =~ + m/^(?:routestring|islandid\d|archipelago\d|debug)$/; + my $val= $ARGS{$var}; + next if $val eq 'none'; + $queryqf{$var}= $val; +} + +my $quri= sub { + my $uri= URI->new('lookup'); + $uri->query_form(@_); + $uri->path_query(); +}; + +foreach my $var (@vars) { + my $name= $var->{Name}; + my $lname= lc $var->{Name}; + my $delim= $var->{Before}; + my $canon= &{$var->{CmpCanon}}($a{$name}); + my $cvalix= 0; + foreach my $valr (@{ $var->{Values} }) { + print $delim; $delim= "\n|\n"; + my ($value,$html) = @$valr; + my $iscurrent= &{$var->{CmpCanon}}($value) eq $canon; + my $after; + if ($iscurrent) { + print ''; + $after= ''; + } else { + my %qf= (%baseqf,%queryqf); + delete $qf{$lname}; + $qf{$lname}= $value if $cvalix; + + +<%perl> + $after= ''; + } + print $html, $after; + $cvalix++; + } + print "

\n\n"; +} + +#---------- initial checks, startup, main entry form ---------- + +dbw_connect($a{Ocean}); + + +<%args> +$debug => 0 +$routestring => '' + + +


+ +%########### query `route' ########## +% if ($a{Query} eq 'route') { + +

Specify route

+
+ +%#---------- textbox, user enters route as string ---------- +% if (!$a{Dropdowns}) { + +Enter route (islands, or archipelagoes, separated by |s or commas; + abbreviations are OK):
+ +<&| script &> +tr_uri= "routetextstring?format=json&type=text/xml" + + "&ocean=<% uri_escape($a{Ocean}) %>"; + +tr_timeout=false; +tr_request=false; +tr_done=''; +tr_needed=''; +function tr_Later(){ + window.clearTimeout(tr_timeout); + tr_timeout = window.setTimeout(tr_Needed, 500); +} +function tr_Needed(){ + window.clearTimeout(tr_timeout); + tr_element= document.getElementById('routestring'); + tr_needed= tr_element.value; + tr_Request(); +} +function tr_Request(){ + if (tr_request || tr_needed==tr_done) return; + tr_done= tr_needed; + tr_request= new XMLHttpRequest(); + uri= tr_uri+'&string='+encodeURIComponent(tr_needed); + tr_request.open('GET', uri); + tr_request.onreadystatechange= tr_Ready; + tr_request.send(null); +} +function tr_Ready() { + if (tr_request.readyState != 4) return; + if (tr_request.status == 200) { + response= tr_request.responseText; + eval('results='+response); + toedit= document.getElementById('routeresults'); + toedit.innerHTML= results.show; + } + tr_request= false; + tr_Request(); +} +window.onload= tr_Needed; + + +
+
 

+ +% } else { #---------- dropdowns, user selects from menus ---------- + +<%perl> +my ($sth,$row);; +my @archlistdata; +my %islandlistdata; +$islandlistdata{'none'}= [ [ "none", "Select island..." ] ]; + +my $optionlistmap= sub { + my ($optlist, $selected) = @_; + my $out=''; + foreach my $entry (@$optlist) { + $out.= sprintf('', + encode_entities($entry->[0]), + defined $selected && $entry->[0] eq $selected + ? 'selected' : '', + encode_entities($entry->[1])); + } + return $out; +}; + +my $dbh= dbw_connect($a{Ocean}); + +$sth= $dbh->prepare("SELECT DISTINCT archipelago FROM islands + ORDER BY archipelago;"); +$sth->execute(); + +while ($row=$sth->fetchrow_arrayref) { + my ($arch)= @$row; + push @archlistdata, [ $arch, $arch ]; + $islandlistdata{$arch}= [ [ "none", "Whole arch" ] ]; +} + +$sth= $dbh->prepare("SELECT islandid,islandname,archipelago + FROM islands + ORDER BY islandname;"); +$sth->execute(); + +while ($row=$sth->fetchrow_arrayref) { + my $arch= $row->[2]; + push @{ $islandlistdata{'none'} }, [ @$row ]; + push @{ $islandlistdata{$arch} }, [ @$row ]; + $islandid2{$row->[0]}= { Name => $row->[1], Arch => $arch }; +} + +my %resetislandlistdata; +foreach my $arch (keys %islandlistdata) { + $resetislandlistdata{$arch}= + $optionlistmap->($islandlistdata{$arch}, ''); +} + + + + + +<&| script &> +ms_lists= <% to_json_protecttags(\%resetislandlistdata) %>; +function ms_Setarch(dd) { + debug('ms_SetArch '+dd+' arch='+arch); + var arch= document.getElementsByName('archipelago'+dd).item(0).value; + var got= ms_lists[arch]; + if (got == undefined) return; // unknown arch ? hrm + debug('ms_SetArch '+dd+' arch='+arch+' got ok'); + var select= document.getElementsByName('islandid'+dd).item(0); + select.innerHTML= got; + debug('ms_SetArch '+dd+' arch='+arch+' innerHTML set'); +} + + + + + +% for my $dd (0..$a{Dropdowns}-1) { + +% } + + + +% for my $dd (0..$a{Dropdowns}-1) { +% my $arch= $ARGS{"archipelago$dd"}; +% $arch= 'none' if !defined $arch; + +% } + + +
+
+
+ +% } #---------- end of dropdowns, now common middle of page code ---------- + + +
+ +<%perl> +#========== result computations ========== + +my $results_head; +$results_head= sub { + print "

Results

\n"; + $results_head= sub { }; +}; + +#---------- result computation - textstring ---------- +if (!$a{Dropdowns}) { + if (length $routestring) { + $results_head->(); + my $rsr= $m->comp('routetextstring', + ocean => $a{Ocean}, + string => $routestring, + format => 'return' + ); + if (length $rsr->{Error}) { + print encode_entities($rsr->{Error}); + } else { + foreach my $entry (@{ $rsr->{Results} }) { + push @archipelagoes, + defined $entry->[1] ? undef : $entry->[0]; + push @islandids, $entry->[1]; + } + } + } + +} else { #---------- results - dropdowns ---------- + +my $argorundef= sub { + my ($dd,$base) = @_; + my $thing= $ARGS{"${base}${dd}"}; + $thing= undef if defined $thing and $thing eq 'none'; + return $thing; +}; + +for my $dd (0..$a{Dropdowns}-1) { + my $arch= $argorundef->($dd,'archipelago'); + my $island= $argorundef->($dd,'islandid'); + next unless defined $arch or defined $island; + if (defined $island and defined $arch) { + my $ii= $islandid2{$island}; + my $iarch= $ii->{Arch}; + if ($iarch ne $arch) { + $results_head->(); + + Specified archipelago <% $arch %> but + island <% $ii->{Name} %> + which is in <% $iarch %>; using the island.
+<%perl> + } + $arch= undef; + } + push @archipelagoes, $arch; + push @islandids, $island; +} + +}#---------- result processing, common stuff + + +% if (@islandids) { +% $results_head->(); + +<& routetrade, islandids => \@islandids, archipelagoes => \@archipelagoes &> + +% } + +% } elsif ($a{Query} eq 'age') { +% ########### query `age' ########## + +

Market data age

+<& dataage, %baseqf, %queryqf &> + +% } ########## end of `age' query ########## + +%#---------- debugging and epilogue ---------- + +% if ($debug) { +

+

+Debug log:
+
+% } + +<&| script &> +function debug (m) { +% if ($debug) { + var node= document.getElementById('debug_log'); + node.innerHTML += "\n" + m + "\n"; +% } +} + + +<& footer &> + +<%init> +use CommodsWeb; +use HTML::Entities; +use URI::Escape; + + diff --git a/yarrg/web/pirate-island b/yarrg/web/pirate-island new file mode 100755 index 0000000..67b4cfb --- /dev/null +++ b/yarrg/web/pirate-island @@ -0,0 +1,22 @@ +Select island +
+ +
+ +<%init> +use CommodsWeb; +db_setocean('Midnight'); +db_connect(); + diff --git a/yarrg/web/pirates b/yarrg/web/pirates new file mode 100755 index 0000000..6a3c478 --- /dev/null +++ b/yarrg/web/pirates @@ -0,0 +1,58 @@ + + +test pirate page + + + +Select island +
+ +
+ +my $sth=$dbh->prepare( + "SELECT a.commodname,b.price,c.price,d.stallname,e.islandname + FROM commods as a + JOIN buy as b on a.commodid=b.commodid + JOIN buy as c on a.commodid=c.commodid + JOIN stalls as d on d.stallid=b.stallid + JOIN islands as e on e.islandid=d.islandid + WHERE a.commodname like 'Wood' + "); + +$sth->execute(); + + + +% my @row; +% while (@row=$sth->fetchrow_array) { + +% foreach my $cell (@row) { + +% } + +% } +
+<% $cell %> +
+ + + + +<%init> +use CommodsWeb; +my $dbh= dbw_connect('Midnight'); + diff --git a/yarrg/web/routetextstring b/yarrg/web/routetextstring new file mode 100755 index 0000000..9107780 --- /dev/null +++ b/yarrg/web/routetextstring @@ -0,0 +1,124 @@ +<%doc> + + This is part of the YARRG website. YARRG is a tool and website + for assisting players of Yohoho Puzzle Pirates. + + Copyright (C) 2009 Ian Jackson + Copyright (C) 2009 Clare Boothby + + YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). + The YARRG website is covered by the GNU Affero GPL v3 or later, which + basically means that every installation of the website will let you + download the source. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + are used without permission. This program is not endorsed or + sponsored by Three Rings. + + + This Mason component parses textual strings giving lists of islands + and archipelagoes, ie textual route strings. + + + + +<%flags> +inherit => undef + + +<%args> +$ocean +$format +$ctype => undef +$string + + +<%perl> + +# typical url for this script: +# http://www.chiark.greenend.org.uk/ucgi/~clareb/mason/pirates/routetextstring?format=json&ocean=Midnight&string=d + + +use CommodsWeb; +use HTML::Entities; +use JSON; +use Data::Dumper; + +my $dbh= dbw_connect($ocean); + +my $sth= $dbh->prepare("SELECT archipelago,islandid,islandname + FROM islands WHERE islandname LIKE ? + UNION ALL SELECT DISTINCT archipelago,NULL,archipelago + FROM islands WHERE archipelago LIKE ?"); + +my (@results, $canontext); +my ($output, $output_wrong); + +if ($format =~ /json/) { + $r->content_type($ctype or $format); + $output= sub { print to_json({ + success => 1, + show => length $canontext ? encode_entities($canontext) + : ' ', + })}; + $output_wrong= sub { print to_json({ + success => 0, + show => $_[0], + })}; +} +if ($format =~ /return/) { + $output= sub { return { Error => '', Results => \@results }; }; + $output_wrong= sub { return { Error => $_[0] }; }; +} +if ($format =~ /dump/) { + $r->content_type('text/plain'); + $output_wrong= sub { print Dumper(\@_); }; + $output= sub { print Dumper(\@results, $canontext); }; +} + +foreach my $each (split m#[/|,]#, $string) { + $each =~ s/^\s*//; $each =~ s/\s*$//; $each =~ s/\s+/ /g; + next if !length $each; + my $err= sub { + my $msg= sprintf $_[0], encode_entities($each); + $output_wrong->($msg); + }; + my %m; + my $results; + foreach my $pat ("$each\%", "\%$each\%") { + $sth->execute($pat,$pat); + $results= $sth->fetchall_arrayref(); + last if @$results==1; + map { $m{ $_->[2] }=1 } @$results; + $results= undef; + } + if (!$results) { + if (!%m) { + return $err->('no island or arch matches "%s"'); + } elsif (%m > 5) { + return $err->(' '); + } else { + return $err->('ambiguous island or arch "%s",'. + ' could be '.join(', ', sort keys %m)); + } + } + push @results, $results->[0]; +} + +$canontext= join ' | ', map { $_->[2] } @results; +return $output->(); + + diff --git a/yarrg/web/routetrade b/yarrg/web/routetrade new file mode 100644 index 0000000..4475d27 --- /dev/null +++ b/yarrg/web/routetrade @@ -0,0 +1,26 @@ +<%args> +@islandids +@archipelagoes + + +%# So, add code to do right thing here: + +
+Route is as follows:
+
+% foreach my $i (0..$#islandids) {
+%   my $islandid= $islandids[$i];
+%   my $archipelago= $archipelagoes[$i];
+%   $islandid= '' unless defined $islandid;
+%   $archipelago= '' unless defined $archipelago;
+%
+  islandid=<% $islandid |h %>  archipelago=<% $archipelago |h %>
+%
+% }
+
+
+ +<%init> +use CommodsWeb; +my $dbh= dbw_connect('Midnight'); + diff --git a/yarrg/web/script b/yarrg/web/script new file mode 100644 index 0000000..b8e7d03 --- /dev/null +++ b/yarrg/web/script @@ -0,0 +1,49 @@ +<%doc> + + This is part of the YARRG website. YARRG is a tool and website + for assisting players of Yohoho Puzzle Pirates. + + Copyright (C) 2009 Ian Jackson + Copyright (C) 2009 Clare Boothby + + YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). + The YARRG website is covered by the GNU Affero GPL v3 or later, which + basically means that every installation of the website will let you + download the source. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + are used without permission. This program is not endorsed or + sponsored by Three Rings. + + + This Mason component wraps Javascript which is to be embedded in HTML + pages to deal with some of the bizarre quoting problems and behaviours + in Javascript +<%init> +my $ct= $m->content; + +die "bad script content $&" + if $ct =~ m,\<\/|--\>,; + diff --git a/yarrg/web/source.tar.gz b/yarrg/web/source.tar.gz new file mode 100755 index 0000000..8825da4 --- /dev/null +++ b/yarrg/web/source.tar.gz @@ -0,0 +1,73 @@ +<%doc> + + This is part of the YARRG website. YARRG is a tool and website + for assisting players of Yohoho Puzzle Pirates. + + Copyright (C) 2009 Ian Jackson + Copyright (C) 2009 Clare Boothby + + YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later). + The YARRG website is covered by the GNU Affero GPL v3 or later, which + basically means that every installation of the website will let you + download the source. + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + + Yohoho and Puzzle Pirates are probably trademarks of Three Rings and + are used without permission. This program is not endorsed or + sponsored by Three Rings. + + + This Mason component allows visitors to the YARRG website to download + the YARRG website's source code. + + +<%flags> +inherit => undef +<%perl> +use IO::Pipe; +use CommodsWeb; + +$r->content_type('application/octet-stream'); +$m->flush_buffer(); + +$ENV{'YPPSC_YARRG_SRCBASE'}= $sourcebasedir; +my $pipe= new IO::Pipe or die $!; +my $pid= fork(); defined $pid or die $!; +if (!$pid) { + $pipe->writer(); + exec '/bin/sh','-c',' + cd -P "$YPPSC_YARRG_SRCBASE" + ( + git-ls-files -z; + git-ls-files -z --others --exclude-from=.gitignore; + if test -d .git; then find .git -print0; fi + ) | cpio -Hustar -o --quiet -0 -R 1000:1000 | gzip + '; + die $!; +} +$pipe->reader(); + +my ($d, $l); +while ($l= read $pipe, $d, 65536) { + print $d; + $m->flush_buffer(); +} +waitpid $pid,0; +defined $l or die "read pipe $!"; +$pipe->error and die "pipe error $!"; +close $pipe; +# deliberately ignore errors + +