From: Alex Sadleir Date: Sat, 10 May 2014 08:42:45 +0000 Subject: beginnings of autoupdate X-Git-Url: http://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=2a6c3e0f54df7f60e1d2e8b37226569f919016ae --- beginnings of autoupdate --- --- /dev/null +++ b/.idea/.name @@ -1,1 +1,1 @@ - +ckanext-datagovau --- /dev/null +++ b/.idea/compiler.xml @@ -1,1 +1,24 @@ + + + + + + --- /dev/null +++ b/.idea/encodings.xml @@ -1,1 +1,6 @@ + + + + + --- /dev/null +++ b/.idea/misc.xml @@ -1,1 +1,9 @@ + + + + + + + + --- /dev/null +++ b/.idea/modules.xml @@ -1,1 +1,10 @@ + + + + + + + + + --- /dev/null +++ b/.idea/other.xml @@ -1,1 +1,8 @@ + + + + + + --- /dev/null +++ b/.idea/scopes/scope_settings.xml @@ -1,1 +1,5 @@ - + + + + --- /dev/null +++ b/.idea/testrunner.xml @@ -1,1 +1,9 @@ + + + + + + --- /dev/null +++ b/.idea/vcs.xml @@ -1,1 +1,8 @@ + + + + + + + --- /dev/null +++ b/.idea/workspace.xml @@ -1,1 +1,881 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + localhost + 5050 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + No facets are configured + + + + + + + + + + + + + + + + + + + + + + ckanext-datagovau + + + + + + + + + + + + + + + + + + + + + + + --- /dev/null +++ b/LICENSE @@ -1,1 +1,686 @@ - +License ++++++++ + +CKAN - Data Catalogue Software +Copyright (C) 2007 Open Knowledge Foundation + +CKAN extensions/plugins +Copyright (C) 2013 Link Digital + +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 . + + + + 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 +. + --- a/README.rst +++ b/README.rst @@ -1,66 +1,26 @@ -This CKAN Extension demonstrates some common patterns for customising a CKAN instance. +This CKAN Extension customises a CKAN instance for the hosting of data.gov.au. It comprises: -* A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when - loaded, overrides various settings in the core ``ini``-file to provide: +* A custom Package edit form that defaults to cc-by licence +* Replaces links with http/https protocol independent versions +* Provides HTML to users to embed data previews on their own website +* A cut down licenses.json file - * A path to local customisations of the core templates and stylesheets - * A "stream filter" that replaces arbitrary strings in rendered templates - * A "route" to override and extend the default behaviour of a core CKAN page - -* A custom Pylons controller for overriding some core CKAN behaviour - -* A custom Package edit form - -* A custom Group edit form - -* A plugin that allows for custom forms to be used for datasets based on - their "type". - -* A custom User registration and edition form - -* Some simple template customisations +This extension is complemented by ckanext-agls for AGLS metadata, ckanext-googleanalytics for Google Analytics tracking of API usage and ckanext-dga-stats for the customised site statistics page. Installation ============ To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``):: - pip install -e git+https://github.com/okfn/ckanext-example#egg=ckanext-example + pip install -e git+https://github.com/okfn/ckanext-datagovau#egg=ckanext-datagovau -Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. +Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file. + +To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json`` +or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file +and set ``licenses_group_url = file://%(here)s/licenses.json`` -Orientation -=========== -* Examine the source code, starting with ``ckanext/example/plugin.py`` - -* To understand the nuts and bolts of this file, which is a CKAN - *Extension*, read in conjunction with the "Extension - documentation": http://docs.ckan.org/en/latest/plugins.html - -* One thing the extension does is set the values of - ``extra_public_paths`` and ``extra_template_paths`` in the CKAN - config, which are "documented - here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths - -* These are set to point at directories within - ``ckanext/example/theme/`` (in this package). Here we: - * override the home page HTML ``ckanext/example/theme/templates/home/index.html`` - * provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option - * customise the navigation and header of the main template in the file ``layout.html``. - - The latter file is a great place to make global theme alterations. - It uses the _layout template_ pattern "described in the Genshi - documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate. - This allows you to use Xpath selectors to override snippets of HTML - globally. - -* The custom package edit form at ``package_form.py`` follows a deprecated - way to make a form (using FormAlchemy). This part of the Example Theme needs - updating. In the meantime, follow the instructions at: - http://readthedocs.org/docs/ckan/en/latest/forms.html - - --- /dev/null +++ b/admin/autoupdate.py @@ -1,1 +1,47 @@ +import requests +import ckanapi +# copy (select id,url,format,extras from resource where extras like '%"autoupdate": "active"%') TO STDOUT WITH CSV; +# f759e4b6-723c-4863-8a26-1529d689cad8,http://data.gov.au/geoserver/geelong-roofprints-kml/wms?request=GetCapabilities,wms,"{""autoupdate"": ""active""}" +import fileinput +import csv +def updateresource(id): + url = 'http://data.disclosurelo.gs' + api_key = '' + db_credentials = '' + print id + ckan = ckanapi.RemoteCKAN('http://data.disclosurelo.gs') + #ckan = ckanapi.RemoteCKAN('http://demo.ckan.org') + resource = ckan.action.resource_show(id=id) + print resource + url = resource['url'] + #last_modified= 'Mon, 24 Feb 2014 01:48:29 GMT' + #etag='"1393206509.38-638"' + headers={} + if 'etag' in resource: + headers['If-None-Match'] = resource['etag'] + if 'file_last_modified' in resource: + headers["If-Modified-Since"] = resource['file_last_modified'] + r = requests.head(url, headers=headers) + if r.status_code == 304: + print 'not modified' + return + else: + print r.status_code + print r.headers + if 'last-modified' in r.headers: + resource['file_last_modified'] = r.headers['last-modified'] + if 'etag' in r.headers: + resource['etag'] = r.headers['etag'] + #save updated resource + if 'format' == 'shp': + print "geoingest!" + else: + ckan.action.datapusher_submit(resource_id=id) +# result = ckan.action.resource_update(id,resource) + + +for line in fileinput.input(): + row = csv.reader(line) + updateresource(line.replace("\n","")) + --- /dev/null +++ b/admin/data.gov.au @@ -1,1 +1,101 @@ + + ServerAdmin webmaster@localhost + ServerName data.gov.au + ServerAlias www.data.gov.au, opendata.linkdigital.com.au + + + #allow access to local static content eg. logos + Alias /index.html /var/www/index.html + Alias /logos /var/www/logos + Alias /tools /var/www/tools.shtml + Alias /opendata /var/www/opendata.shtml + Alias /opengov /var/www/opengov.shtml + + DocumentRoot /var/www + + + ExpiresActive On + ExpiresDefault "access plus 1 week" + + +AddType application/octet-stream .woff + + SetEnvIf Origin "^http(s)?://(.+\.)?(data.gov.au)$" origin_is=$0 + Header set Access-Control-Allow-Origin %{origin_is}e env=origin_is + + + + Options FollowSymLinks + AllowOverride None + + + + Options -Indexes -FollowSymLinks -MultiViews +Includes + AllowOverride None + + Order allow,deny + allow from all + + AddType text/html .shtml + AddOutputFilter INCLUDES .shtml + + + ErrorLog ${APACHE_LOG_DIR}/error.log + + # Possible values include: debug, info, notice, warn, error, crit, alert, emerg. + LogLevel warn + + CustomLog ${APACHE_LOG_DIR}/access.log varnishcombined + RewriteEngine On + + RewriteMap lc int:tolower + +# RewriteRule ^/apps/antenna-mate/?$ http://antennamate.com/ [PT] +# RewriteRule ^/apps/postcode-finder/?$ http://www.aus-emaps.com/postcode_finder.php [PT] +# RewriteRule ^/apps/the-australian-cost-of-living-heatmap/?$ http://www.creditcardcompare.com.au/tools/cost-of-living-heatmap/ [PT] + RewriteRule ^/catalogues/?$ /organization [PT] + RewriteRule ^/dataset/“cycling-in-new-south-wales-what-the-data-tells-us”-and-related-data/? /dataset/2809cycling-in-new-south-wales-what-the-data-tells-us2809-and-related-data [PT] + RewriteRule ^/dataset/apvma-pubcris-dataset-for-registered-agricultural-and-veterinary-chemical-products-and-approved-actives/? /dataset/apvma-pubcris-dataset-for-registered-agricultural-and-veterinary-chemical-products-and-approved-acti [PT] + RewriteRule ^/dataset_category/business/?$ /group/business [PT] + RewriteRule ^/dataset_category/community/?$ /group/community [PT] + RewriteRule ^/dataset_category/geography/?$ /group/geography [PT] + RewriteRule ^/dataset_category/government/?$ /group/government [PT] + RewriteRule ^/dataset_category/health/?$ /group/health [PT] + RewriteRule ^/dataset_category/?$ /group [PT] + RewriteRule ^/feed/?$ /feeds/dataset.atom [PT] + RewriteRule ^/jurisdiction/australian-capital-territory/?$ /dataset?q=act [PT] + RewriteRule ^/jurisdiction/new-south-wales/?$ /dataset?q=new+south+wales [PT] + RewriteRule ^/jurisdiction/queensland/?$ /dataset?q=queensland [PT] + RewriteRule ^/jurisdiction/south-australia/?$ /dataset?q=south+australia [PT] + RewriteRule ^/jurisdiction/victoria/?$ /dataset?q=victoria [PT] + RewriteRule ^/jurisdiction/western-australia/?$ /dataset?q=western+australia [PT] + RewriteRule ^/jurisdiction/?$ /dataset [PT] + +# RewriteCond %{QUERY_STRING} ^category=([a-z]+) +# RewriteRule ^/data/?$ /group/${lc:%1}? [PT] + +# RewriteCond %{QUERY_STRING} ^format=Shapefile +# RewriteRule ^/data/?$ /dataset?res_format=shp [PT] + + RewriteRule ^/data/?$ /dataset? [PT] + + RewriteCond %{QUERY_STRING} ^s=(.*) + RewriteRule ^/ /dataset?q=%1 [PT] + + + FilterDeclare OPENDATA + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $text/ + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $/javascript + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $/json + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $/xml + FilterChain OPENDATA + Substitute "s#//opendata.linkdigital.com.au#//data.gov.au#" + + WSGIScriptAlias / /var/lib/ckan/dga/pyenv/bin/dga.py + WSGIPassAuthorization On + + ErrorLog /var/log/apache2/ckandga.error.log + CustomLog /var/log/apache2/ckandga.custom.log combined + + --- /dev/null +++ b/admin/default.vcl @@ -1,1 +1,266 @@ - +# This is a basic VCL configuration file for varnish. See the vcl(7) +# man page for details on VCL syntax and semantics. +# +# Default backend definition. Set this to point to your content +# server. +# +backend default { + .host = "127.0.0.1"; + .port = "8080"; +} +backend geoserver { + .host = "172.31.18.207"; + .port = "8983"; +} + +sub vcl_fetch { + set beresp.grace = 1h; + unset beresp.http.Server; + # These status codes should always pass through and never cache. + if ( beresp.status >= 500 ) { + set beresp.ttl = 0s; + } + if (beresp.http.content-type ~ "(text|javascript|json|xml|html)") { + set beresp.do_gzip = true; + } + # CKAN cache headers are used by Varnish cache, but should not be propagated to + # the Internet. Tell browsers and proxies not to cache. This means Varnish always + # gets the responsibility to server the right content at all times. + if (beresp.http.Cache-Control ~ "max-age") { + unset beresp.http.set-cookie; + set beresp.http.Cache-Control = "no-cache"; + } + + # Encourage assets to be cached by proxies and browsers + # JS and CSS may be gzipped depending on headers + # see https://developers.google.com/speed/docs/best-practices/caching + if (req.url ~ "\.(css|js)") { + set beresp.http.Vary = "Accept-Encoding"; + } + + # Encourage assets to be cached by proxies and browsers for 1 day + if (req.url ~ "\.(png|gif|jpg|swf|css|js)") { + unset beresp.http.set-cookie; + set beresp.http.Cache-Control = "public, max-age=86400"; + set beresp.ttl = 1d; + } + + # Encourage CKAN vendor assets (which are versioned) to be cached by + # by proxies and browsers for 1 year + if (req.url ~ "^/scripts/vendor/") { + unset beresp.http.set-cookie; + set beresp.http.Cache-Control = "public, max-age=31536000"; + set beresp.ttl = 12m; + } +} +sub vcl_recv { + if (req.http.user-agent ~ "Ezooms" || req.http.user-agent ~ "Ahrefs") { + error 403; + } +if (req.url ~ "^/geoserver/") { + set req.backend = geoserver; + } else { + set req.backend = default; + #redirect secure traffic to https + if ( (req.http.Cookie ~ "auth_tkt" || req.http.Cookie ~ "ckan" || req.url ~ "user/(reset|login)") && req.http.X-Forwarded-Proto !~ "(?i)https") { + set req.http.x-Redir-Url = "https://data.gov.au" + req.url; + error 753 req.http.x-Redir-Url; + } + # remove locale links + if (req.url ~ "/((?!js)..|.._..|sr_Latn)/") { + set req.http.x-Redir-Url = regsub(req.url, "/((?!js)..|.._..|sr_Latn)/", "/"); + error 751 req.http.x-Redir-Url; + } + # rewrite broken resources + if (req.url ~ "leaflet") { + set req.url = regsub(req.url, "fanstatic/ckanext-spatial/:version:2013-09-13T02:32:17.87/:bundle:js/vendor/leaflet/images", "js/vendor/leaflet/images"); + } + # remove old hostnames + if (req.http.host ~ "data.australia.gov.au") { + set req.http.x-Redir-Url = "http://data.gov.au" + req.url; + error 751 req.http.x-Redir-Url; + } + + if (req.url ~ "^/_tracking") { + // exclude web spiders from statistics + if (req.http.user-agent ~ "Googlebot" || req.http.user-agent ~ "baidu" || req.http.user-agent ~ "bing") { + error 200; + } else { + return (pass); + } + } + if (req.url ~ "\.(png|gif|jpg|jpeg|swf|css|js|woff|eot)$") { + //Varnish to deliver content from cache even if the request othervise indicates that the request should be passed + return(lookup); + } +} + // Remove has_js and Google Analytics cookies. Evan added sharethis cookies + set req.http.Cookie = regsuball(req.http.Cookie, "(^|;\s*)(__[a-z]+|has_js|cookie-agreed-en|_csoot|_csuid|_chartbeat2)=[^;]*", ""); + + // Remove a ";" prefix, if present. + set req.http.Cookie = regsub(req.http.Cookie, "^;\s*", ""); + // Remove empty cookies. + if (req.http.Cookie ~ "^\s*$") { + unset req.http.Cookie; + } + + remove req.http.X-Forwarded-For; + set req.http.X-Forwarded-For = req.http.X-Real-IP; +} +sub vcl_hash { + # http://serverfault.com/questions/112531/ignoring-get-parameters-in-varnish-vcl + set req.url = regsub(req.url, "(?:(.com|.au))/((?!js)..|.._..|sr_Latn)/", "/"); + hash_data(req.url); + if (req.http.host) { + hash_data(req.http.host); + } else { + hash_data(server.ip); + } + if (req.http.Cookie) { + hash_data(req.http.Cookie); +} +} +sub vcl_deliver { + if (!resp.http.Vary) { + set resp.http.Vary = "Accept-Encoding"; + } else if (resp.http.Vary !~ "(?i)Accept-Encoding") { + set resp.http.Vary = resp.http.Vary + ",Accept-Encoding"; + } + remove resp.http.X-Varnish; + remove resp.http.Via; + remove resp.http.Age; + remove resp.http.X-Powered-By; +if (req.url ~ "^/geoserver/") { + set resp.http.Access-Control-Allow-Origin = "*"; + set resp.http.Access-Control-Allow-Methods = "GET, POST, PUT, DELETE"; + set resp.http.Access-Control-Allow-Headers = "Origin, X-Requested-With, Content-Type, Accept"; +} +} +sub vcl_error { + remove obj.http.Server; + if (obj.status == 751) { + set obj.http.Location = obj.response; + set obj.status = 301; + return (deliver); + } + if (obj.status == 753) { + set obj.http.Location = obj.response; + set obj.status = 301; + return (deliver); + } +} +# +# Below is a commented-out copy of the default VCL logic. If you +# redefine any of these subroutines, the built-in logic will be +# appended to your code. +# sub vcl_recv { +# if (req.restarts == 0) { +# if (req.http.x-forwarded-for) { +# set req.http.X-Forwarded-For = +# req.http.X-Forwarded-For + ", " + client.ip; +# } else { +# set req.http.X-Forwarded-For = client.ip; +# } +# } +# if (req.request != "GET" && +# req.request != "HEAD" && +# req.request != "PUT" && +# req.request != "POST" && +# req.request != "TRACE" && +# req.request != "OPTIONS" && +# req.request != "DELETE") { +# /* Non-RFC2616 or CONNECT which is weird. */ +# return (pipe); +# } +# if (req.request != "GET" && req.request != "HEAD") { +# /* We only deal with GET and HEAD by default */ +# return (pass); +# } +# if (req.http.Authorization || req.http.Cookie) { +# /* Not cacheable by default */ +# return (pass); +# } +# return (lookup); +# } +# +# sub vcl_pipe { +# # Note that only the first request to the backend will have +# # X-Forwarded-For set. If you use X-Forwarded-For and want to +# # have it set for all requests, make sure to have: +# # set bereq.http.connection = "close"; +# # here. It is not set by default as it might break some broken web +# # applications, like IIS with NTLM authentication. +# return (pipe); +# } +# +# sub vcl_pass { +# return (pass); +# } +# +# sub vcl_hash { +# hash_data(req.url); +# if (req.http.host) { +# hash_data(req.http.host); +# } else { +# hash_data(server.ip); +# } +# return (hash); +# } +# +# sub vcl_hit { +# return (deliver); +# } +# +# sub vcl_miss { +# return (fetch); +# } +# +# sub vcl_fetch { +# if (beresp.ttl <= 0s || +# beresp.http.Set-Cookie || +# beresp.http.Vary == "*") { +# /* +# * Mark as "Hit-For-Pass" for the next 2 minutes +# */ +# set beresp.ttl = 120 s; +# return (hit_for_pass); +# } +# return (deliver); +# } +# +# sub vcl_deliver { +# return (deliver); +# } +# +# sub vcl_error { +# set obj.http.Content-Type = "text/html; charset=utf-8"; +# set obj.http.Retry-After = "5"; +# synthetic {" +# +# +# +# +# "} + obj.status + " " + obj.response + {" +# +# +#

Error "} + obj.status + " " + obj.response + {"

"} + obj.response + {"

Guru Meditation:

XID: "} + req.xid + {"

Varnish cache server

+# +# +# "}; +# return (deliver); +# } +# +# sub vcl_init { +# return (ok); +# } +# +# sub vcl_fini { +# return (ok); +# } + --- /dev/null +++ b/admin/deflate.conf @@ -1,1 +1,12 @@ + + AddOutputFilterByType DEFLATE text/html application/xhtml+xml text/plain text/xml text/css application/json text/javascript application/javascript application/x-javascript + BrowserMatch ^Mozilla/4 gzip-only-text/html + BrowserMatch ^Mozilla/4\.0[678] no-gzip + BrowserMatch \bMSIE !no-gzip !gzip-only-text/htm + # Don't compress images + SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary + + # DeflateCompressionLevel 9 + + --- /dev/null +++ b/admin/development.ini @@ -1,1 +1,365 @@ - +# +# ckan - Pylons configuration +# +# The %(here)s variable will be replaced with the parent directory of this file +# +[DEFAULT] + +# Change debug to true when doing CKAN development, it enables Pylons' +# interactive debugging tool, makes Fanstatic serve unminified JS and CSS +# files, and enables CKAN templates' debugging features. +# +# WARNING: *THIS SETTING MUST BE SET TO FALSE ON A PRODUCTION ENVIRONMENT* +# Debug mode will enable the interactive debugging tool, allowing ANYONE to +# execute malicious code after an exception is raised. +debug = False + +email_to = ddg@alert.links.com.au +error_email_from = data.gov@finance.gov.au + +# The SMTP server to connect to when sending emails to users, with optional +# port (default: 25). For example: lavabit.com, or smtp.gmail.com:587. To +# connect to a local sendmail process enter 'localhost'. +#smtp.server = localhost +smtp.server = smtp.gmail.com:587 + +# Whether or not to use STARTTLS when connecting to the SMTP server. +#smtp.starttls = False +smtp.starttls = True + +# The username and password to use to authenticate with the SMTP server. +# Optional, if these are left commented-out then CKAN will try to send email +# to the SMTP server without logging in first. +#smtp.user = your_username@gmail.com +#smtp.password = your_password +smtp.user = datagovau@gmail.com +smtp.password = *** +googleanalytics.id = *** +# The email address that emails sent by CKAN to users should appear to come +# from. Optional (default: None, note that the SMTP server may insert its own +# from address). +smtp.mail_from = data.gov@finance.gov.au + +[server:main] +use = egg:Paste#http +host = 0.0.0.0 +port = 5000 + +[app:main] +use = egg:ckan +ckan.tracking_enabled = true +full_stack = true +cache_dir = %(here)s/data +beaker.session.key = ckan +beaker.session.secret = *** +app_instance_uuid = *** +# Auth + +ckan.auth.anon_create_dataset = false +ckan.auth.create_unowned_dataset = false +ckan.auth.create_dataset_if_not_in_organization = false +ckan.auth.user_create_organizations = false +ckan.auth.user_delete_organizations = true +ckan.auth.user_create_groups = false +ckan.auth.user_delete_groups = true +ckan.auth.create_user_via_api = true + +# List the names of CKAN extensions to activate. +# Note: This line is required to be here for packaging, even if it is empty. +# Note: Add ``pdf_preview`` to enable the resource preview for PDFs +# Add the ``resource_proxy`` plugin to enable resorce proxying and get around the same origin policy +# Add ``datastore`` to enable the CKAN DataStore extension +ckan.plugins = qa disqus stats json_preview recline_preview datastore datastorer googleanalytics resource_proxy wms_preview kml_preview geojson_preview datagovau + +disqus.name = datagovau + +# If you'd like to fine-tune the individual locations of the cache data dirs +# for the Cache data, or the Session saves, un-comment the desired settings +# here: +#beaker.cache.data_dir = %(here)s/data/cache +#beaker.session.data_dir = %(here)s/data/sessions + +# Specify the database for SQLAlchemy to use: +# * Postgres is currently required for a production CKAN deployment +# * Sqlite (memory or file) can be used as a quick alternative for testing +#sqlalchemy.url = postgresql://ckanuser:pass@localhost/ckantest +sqlalchemy.url = *** +#sqlalchemy.url = sqlite:/// +#sqlalchemy.url = sqlite:///%(here)s/somedb.db + +# Un-comment and specify the URLs for the DataStore database. +# * Postgres is required +#ckan.datastore.write_url = postgresql://ckanuser:pass@localhost/datastore +#ckan.datastore.read_url = postgresql://readonlyuser:pass@localhost/datastore +ckan.datastore.write_url = *** +ckan.datastore.read_url = *** + +# repoze.who config +who.config_file = %(here)s/who.ini +who.log_level = warning +who.log_file = %(cache_dir)s/who_log.ini + +# Location of RDF versions of datasets +#rdf_packages = http://semantic.ckan.net/record/ + +# Location of licenses group (defaults to cached local version of ckan group) +#licenses_group_url = http://licenses.opendefinition.org/licenses/groups/ckan.json +licenses_group_url = file://%(here)s/licenses.json + +# Dataset form to use +package_form = standard + +# Hide certain extras fields from dataset read form: +# package_hide_extras = for_search_index_only + +# API configuration +#apikey_header_name = X-CKAN-API-Key + +## extra places to look for templates and public files (comma separated lists) +## any templates/files found will override correspondingly named ones in +## ckan/templates/ and ckan/public +## (e.g. to override main layout template layout.html or add extra css files) +# extra_template_paths = %(here)s/my-templates +# extra_public_paths = %(here)s/my-public + +# Dataset form integration +#package_edit_return_url = http://another.frontend/dataset/ +#package_new_return_url = http://another.frontend/dataset/ + + +# Turn on messaging with carrot, default to false +#ckan.async_notifier = true +# Messaging module used by carrot: +# * pyamqplib - AMQP (e.g. for RabbitMQ) +# * queue - native Python Queue (debugging and tests only) +#carrot_messaging_library = pyamqplib + +## Perform search just using database (rather than use e.g. solr). +## In this setup search is crude and limited .e.g no full-text search, no faceting ... +## However, very useful for getting up and running quickly with CKAN +# ckan.simple_search = 1 + +## Title of site (using in several places including templates and tag +ckan.site_title = data.gov.au + +## Logo image to use on the home page +ckan.site_logo = /base/images/ckan-logo.png + +## Site tagline / description (used on front page) +ckan.site_description = Australian Government Open Data Catalogue + +## Used in creating some absolute urls (such as rss feeds, css files) and +## dump filenames +ckan.site_url = http://data.gov.au + +## Favicon (default is the CKAN software favicon) +ckan.favicon = /images/icons/ckan.ico + +## The gravatar default to use. This can be any of the pre-defined strings +## as defined on http://en.gravatar.com/site/implement/images/ (e.g. "identicon" +## or "mm"). Or it can be a url, e.g. "http://example.com/images/avatar.jpg" +ckan.gravatar_default = identicon + +## Solr support +solr_url = http://solr.data.gov.au:8983/solr + +## Automatic indexing. Make all changes immediately available via the search +## after editing or creating a dataset. Default is true. If for some reason +## you need the indexing to occur asynchronously, set this option to 0. +# ckan.search.automatic_indexing = 1 + +## An 'id' for the site (using, for example, when creating entries in a common search index) +## If not specified derived from the site_url +ckan.site_id = data.gov.au + +## API url to use (e.g. in AJAX callbacks) +## Enable if the API is at a different domain +# ckan.api_url = http://www.ckan.net + +## html content to be inserted just before </head> tag (e.g. extra stylesheet) +## NB: can use html e.g. <strong>blah</strong> +## NB: can have multiline strings just indent following lines +# ckan.template_head_end = <link rel="stylesheet" href="http://mysite.org/css/custom.css" type="text/css"> + +## html content to be inserted just before </body> tag (e.g. google analytics code) +## NB: can use html e.g. <strong>blah</strong> +## NB: can have multiline strings just indent following lines +# ckan.template_footer_end = + +# These three settings (ckan.log_dir, ckan.dump_dir and ckan.backup_dir) are +# all used in cron jobs, not in CKAN itself. CKAN logging is configured +# in the logging configuration below +# Directory for logs (produced by cron scripts associated with ckan) +ckan.log_dir = %(here)s/log +# Directory for JSON/CSV dumps (must match setting in apache config) +ckan.dump_dir = %(here)s/dump +# Directory for SQL database backups +ckan.backup_dir = %(here)s/backup + +# Default authorizations for new domain objects +#ckan.default_roles.Package = {"visitor": ["reader"], "logged_in": ["reader"]} +#ckan.default_roles.Group = {"visitor": ["reader"], "logged_in": ["reader"]} +#ckan.default_roles.System = {"visitor": ["reader"], "logged_in": ["editor"]} +#ckan.default_roles.AuthorizationGroup = {"visitor": ["reader"], "logged_in": ["reader"]} + +## Ckan public and private recaptcha keys [localhost] +#ckan.recaptcha.publickey = 6LcL-94SAAAAAKCHKLIgCYNJczalehF4a3GHlPyR +#ckan.recaptcha.privatekey = 6LcL-94SAAAAADCsq995yBsNl7lHEgJ3Ukqf4Ykq + +# Locale/languages +ckan.locale_default = en_GB +ckan.locales_offered = en_GB +# Languages are grouped by percentage of strings in CKAN 1.8 translated +# (those with 100% first, then those with >=80%, then >=50%, then <50%) and +# within these groups roughly sorted by number of worldwide native speakers +# according to Wikipedia. +ckan.locale_order = en_GB pt_BR ja it cs_CZ ca es fr el sv sr sr@latin no sk fi ru de pl nl bg ko_KR hu sa sl lv +ckan.locales_filtered_out = en + +## Atom Feeds +# +# Settings for customising the metadata provided in +# atom feeds. +# +# These settings are used to generate the <id> tags for both feeds +# and entries. The unique <id>s are created following the method +# outlined in http://www.taguri.org/ ie - they generate tagURIs, as specified +# in http://tools.ietf.org/html/rfc4151#section-2.1 : +# +# <id>tag:thedatahub.org,2012:/feeds/group/933f3857-79fd-4beb-a835-c0349e31ce76</id> +# +# Each component has the corresponding settings: +# +# "thedatahub.org" is ckan.feeds.authority_name +# "2012" is ckan.feeds.date +# + +# Leave blank to use the ckan.site_url config value, otherwise set to a +# domain or email address that you own. e.g. thedatahub.org or +# admin@thedatahub.org +ckan.feeds.authority_name = + +# Pick a date of the form "yyyy[-mm[-dd]]" during which the above domain was +# owned by you. +ckan.feeds.date = 2012 + +# If not set, then the value in `ckan.site_id` is used. +ckan.feeds.author_name = + +# If not set, then the value in `ckan.site_url` is used. +ckan.feeds.author_link = + +## File Store +# +# CKAN allows users to upload files directly to file storage either on the local +# file system or to online ‘cloud’ storage like Amazon S3 or Google Storage. +# +# If you are using local file storage, remember to set ckan.site_url. +# +# To enable cloud storage (Google or S3), first run: pip install boto +# +# @see http://docs.ckan.org/en/latest/filestore.html + +# 'Bucket' to use for file storage +ckan.storage.bucket = ckandga + +# To enable local file storage: +ofs.impl = pairtree +ofs.storage_dir = /srv/ckan/dga + +# To enable Google cloud storage: +#ofs.impl = google +#ofs.gs_access_key_id = +#ofs.gs_secret_access_key = + +# To enable S3 cloud storage: +#ofs.impl = s3 +#ofs.aws_access_key_id = .... +#ofs.aws_secret_access_key = .... + + +## Previews +# +# Set the file types that should be previewed inline (e.g. images) or directly in an iframe. + +ckan.preview.direct = png jpg gif +ckan.preview.loadable = html htm rdf+xml owl+xml xml n3 n-triples turtle plain atom csv tsv rss txt json + + +# Activity Streams +# +# Default maximum number of activities to show in an activity stream. +# ckan.activity_list_limit = 31 + + +# Activity Streams Email Notifications +# +# Uncomment this line to enable activity streams email notifications. +# You also need to setup a cron job to send the emails, see the documentation. +#ckan.activity_streams_email_notifications = True + +# Email notifications for events older than this time delta will not be sent. +# Accepted formats: '2 days', '14 days', '4:35:00' (hours, minutes, seconds), +# '7 days, 3:23:34', etc. +# ckan.email_notifications_since = 2 days + +ckan.cache_expires = 2592000 +#ckan.page_cache_enabled = True +ckan.static_max_age = 2592000 +ckan.cache_enabled = True +# DEBUGGING + +# ckan.debug_supress_header This option can be set to suppress the debug +# information showing the controller and action recieving the request being +# shown in the header. Note: This info only shows if debug is set to true. +ckan.debug_supress_header = false + +## =================================== +## Extensions + +## Config option to enable the (1 day) cache for stats +## Default (if not defined) is True as stats computations are intensive +# ckanext.stats.cache_enabled = True + +# Logging configuration +[loggers] +keys = root, ckan, ckanext + +[handlers] +keys = console, file + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console, file + +[logger_ckan] +level = ERROR +handlers = console, file +qualname = ckan +propagate = 0 + +[logger_ckanext] +level = WARNING +handlers = console, file +qualname = ckanext +propagate = 0 + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[handler_file] +class = logging.handlers.RotatingFileHandler +formatter = generic +level = NOTSET +#args = ("ckan.log", "a", 20000000, 9) +args = ("/var/log/ckan/dga/ckan.log", "a", 20000000, 9) + +[formatter_generic] +format = %(asctime)s %(levelname)-5.5s [%(name)s] %(message)s + --- /dev/null +++ b/admin/reset.sh @@ -1,1 +1,17 @@ +paster --plugin=ckan db clean --config=development.ini +echo "drop extension postgis cascade;" | psql -d ckantest +paster --plugin=ckan db clean --config=development.ini +#to initiate for first time instead of load from dump +#paster --plugin=ckan db init --config=development.in +#paster --plugin=ckan user add maxious password=snmc email=maxious@gmail.com +#paster --plugin=ckan sysadmin add maxious +#paster --plugin=ckan db dump dump.db + +#paster --plugin=ckan db load --config=development.ini dump.db +paster --plugin=ckan db load --config=development.ini dump.harvest.db +echo "create extension postgis;" | psql -d ckantest +#sleep 2 +paster --plugin=ckan search-index rebuild --config=development.ini +#rm -r /tmp/pairtree_* + --- /dev/null +++ b/ckanext-datagovau.iml @@ -1,1 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<module type="PYTHON_MODULE" version="4"> + <component name="NewModuleRootManager" inherit-compiler-output="true"> + <exclude-output /> + <content url="file://$MODULE_DIR$"> + <sourceFolder url="file://$MODULE_DIR$" isTestSource="false" /> + </content> + <orderEntry type="inheritedJdk" /> + <orderEntry type="sourceFolder" forTests="false" /> + </component> +</module> + --- /dev/null +++ b/ckanext/datagovau/__init__.py --- /dev/null +++ b/ckanext/datagovau/plugin.py @@ -1,1 +1,49 @@ +import logging +import ckan.plugins as plugins +import ckan.lib as lib +import ckan.lib.dictization.model_dictize as model_dictize +import ckan.plugins.toolkit as tk +import ckan.model as model +from pylons import config + +from sqlalchemy import orm +import ckan.model + +# get user created datasets and those they have edited +def get_user_datasets(user_dict): + created_datasets_list = user_dict['datasets'] + active_datasets_list = [x['data']['package'] for x in + lib.helpers.get_action('user_activity_list',{'id':user_dict['id']}) if x['data'].get('package')] + raw_list = created_datasets_list + active_datasets_list + filtered_dict = {} + for dataset in raw_list: + if dataset['id'] not in filtered_dict.keys(): + filtered_dict[dataset['id']] = dataset + return filtered_dict.values() + +class DataGovAuPlugin(plugins.SingletonPlugin, + tk.DefaultDatasetForm): + '''An example IDatasetForm CKAN plugin. + + Uses a tag vocabulary to add a custom metadata field to datasets. + + ''' + plugins.implements(plugins.IConfigurer, inherit=False) + plugins.implements(plugins.ITemplateHelpers, inherit=False) + + def update_config(self, config): + # Add this plugin's templates dir to CKAN's extra_template_paths, so + # that CKAN will use this plugin's custom templates. + # here = os.path.dirname(__file__) + # rootdir = os.path.dirname(os.path.dirname(here)) + + tk.add_template_directory(config, 'templates') + tk.add_public_directory(config, 'theme/public') + tk.add_resource('theme/public', 'ckanext-datagovau') + # config['licenses_group_url'] = 'http://%(ckan.site_url)/licenses.json' + + def get_helpers(self): + return {'get_user_datasets': get_user_datasets} + + --- /dev/null +++ b/ckanext/datagovau/templates/base.html @@ -1,1 +1,7 @@ +{% ckan_extends %} + {% block meta %} + {{ super() }} +<meta name="google-site-verification" content="B8scmW2_LMm4IW_ogXK9lojznO57GBpYlWrFjfGz3X8" /> + {% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/dataviewer/base.html @@ -1,1 +1,11 @@ +{% ckan_extends %} +{% block scripts %} + {{ super() }} + <script> + preload_resource.url = preload_resource.url.replace("https:","").replace("http:",""); + preload_resource.original_url = preload_resource.original_url.replace("https:","").replace("http:",""); + </script> +{% endblock %} + + --- /dev/null +++ b/ckanext/datagovau/templates/dataviewer/snippets/data_preview.html @@ -1,1 +1,32 @@ +<div class="module-content ckanext-datapreview"> + {% if embed %} + {# images can be embedded directly #} + <img src="{{ resource_url }}"></img> + {% else %} + <div class="data-viewer-error js-hide"> + <p class="text-error"> + <i class="icon-info-sign"></i> + {{ _('This resource can not be previewed at the moment.') }} + <a href="#" data-toggle="collapse" data-target="#data-view-error"> + {{ _('Click here for more information.') }} + </a> + </p> + <p id="data-view-error" class="collapse"></p> + <p> + <a href="{{ raw_resource_url }}" class="btn btn-large resource-url-analytics" target="_blank"> + <i class="icon-large icon-download"></i> + {{ _('Download resource') }} + </a> + </p> + </div> + <iframe src="{{ resource_url }}" frameborder="0" width="100%" data-module="data-viewer"> + <p>{{ _('Your browser does not support iframes.') }}</p> + </iframe> + {% endif %} +</div> +<div class="embedhint" style="padding-left: 15px;"> +<h4>Embed this visualisation in your own website...</h4> +Copy the HTML in the box below and you can display this visualisation on your own website.<br/> +<textarea style="width:97%"><iframe src="{{ resource_url }}" frameborder="0" width="100%" height="600px"></iframe></textarea> +</div> --- /dev/null +++ b/ckanext/datagovau/templates/header.html @@ -1,1 +1,18 @@ +{% ckan_extends %} +{% block header_site_navigation %} + <nav class="section navigation"> + <ul class="nav nav-pills"> + {% block header_site_navigation_tabs %} + {{ h.build_nav_main( + ('search', _('Datasets')), + ('organizations_index', _('Organizations')), + ('about', _('About')) + ) }} + <li><a href="//data.gov.au/stats">Site Statistics</a></li> + <li><a href="https://datagovau.ideascale.com/">Feedback/Request Data</a></li> + {% endblock %} + </ul> + </nav> +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/home/index.html @@ -1,1 +1,62 @@ +{% ckan_extends %} + {% block home_search %} +<div class="hero-secondary-inner"> +<script type="text/javascript" src="http://www.google.com/jsapi"> +</script> +<script type="text/javascript"> +google.load("feeds", "1") //Load Google Ajax Feed API (version 1) +</script> + + <div id="feeddiv"> +</div> +</div> + + + +<script type="text/javascript"> + +var feedcontainer=document.getElementById("feeddiv") +var feedurl="http://www.finance.gov.au/taxonomy/term/1274/feed" +var feedlimit=4 +var rssoutput="<div class='module module-shallow module-narrow module-dark info box' style='color:black'><h2>Latest data.gov.au News</h2><i class='ckan-icon ckan-icon-feed'></i><a href='http://www.finance.gov.au/taxonomy/term/1274/feed/'> Subscribe to the blog </a></div>" + + +function rssfeedsetup(){ +var feedpointer=new google.feeds.Feed(feedurl) //Google Feed API method +feedpointer.setNumEntries(feedlimit) //Google Feed API method +feedpointer.load(displayfeed) //Google Feed API method +} + +function displayfeed(result){ +if (!result.error){ +var thefeeds=result.feed.entries +for (var i=0; i<thefeeds.length; i++) { +rssoutput+="<div class='module module-shallow module-narrow module-dark info box'><h3><a href='" + thefeeds[i].link + "'>" + thefeeds[i].title + "</a></h3>" +rssoutput+= " <font color='black'>Posted on " + new Date(thefeeds[i].publishedDate).toDateString() + "</font></div>" +} +rssoutput+="" +feedcontainer.innerHTML=rssoutput +} +else +alert("Error fetching feeds!") +} + +window.onload=function(){ +rssfeedsetup() +} + +</script> + + <form class="module-content search-form" method="get" action="{% url_for controller='package', action='search' %}"> + <h3 class="heading">{{ _("Search Your Data") }}</h3> + <div class="search-input control-group search-giant"> + <input type="text" class="search" name="q" value="{{ c.q }}" autocomplete="off" placeholder="{{ _('eg. Gold Prices') }}" /> + <button type="submit"> + <i class="icon-search"></i> + <span>{{ _('Search') }}</span> + </button> + </div> + </form> + {% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/home/snippets/search.html @@ -1,1 +1,70 @@ +<div class="hero-secondary-inner"> +<script type="text/javascript" src="http://www.google.com/jsapi"> +</script> +<script type="text/javascript"> +google.load("feeds", "1") //Load Google Ajax Feed API (version 1) +</script> + + <div id="feeddiv"> +</div> +</div> + + + +<script type="text/javascript"> + +var feedcontainer=document.getElementById("feeddiv") +var feedurl="http://www.finance.gov.au/taxonomy/term/1274/feed" +var feedlimit=4 +var rssoutput="<div class='module module-shallow module-narrow module-dark info box' style='color:black'><h2>Latest data.gov.au News</h2><i class='ckan-icon ckan-icon-feed'></i><a href='http://www.finance.gov.au/taxonomy/term/1274/feed/'> Subscribe to the blog </a></div>" + + +function rssfeedsetup(){ +var feedpointer=new google.feeds.Feed(feedurl) //Google Feed API method +feedpointer.setNumEntries(feedlimit) //Google Feed API method +feedpointer.load(displayfeed) //Google Feed API method +} + +function displayfeed(result){ +if (!result.error){ +var thefeeds=result.feed.entries +for (var i=0; i<thefeeds.length; i++) { +rssoutput+="<div class='module module-shallow module-narrow module-dark info box'><h3><a href='" + thefeeds[i].link + "'>" + thefeeds[i].title + "</a></h3>" +rssoutput+= " <font color='black'>Posted on " + new Date(thefeeds[i].publishedDate).toDateString() + "</font></div>" +} +rssoutput+="" +feedcontainer.innerHTML=rssoutput +} +else +alert("Error fetching feeds!") +} + +window.onload=function(){ +rssfeedsetup() +} + +</script> + +{% set tags = h.get_facet_items_dict('tags', limit=3) %} +{% set placeholder = _('eg. Gold Prices') %} + +<div class="module module-search module-narrow module-shallow box"> + <form class="module-content search-form" method="get" action="{% url_for controller='package', action='search' %}"> + <h3 class="heading">{{ _("Search Your Data") }}</h3> + <div class="search-input control-group search-giant"> + <input type="text" class="search" name="q" value="" autocomplete="off" placeholder="{{ placeholder }}" /> + <button type="submit"> + <i class="icon-search"></i> + <span>{{ _('Search') }}</span> + </button> + </div> + </form> + <div class="tags"> + <h3>{{ _('Popular Tags') }}</h3> + {% for tag in tags %} + <a class="tag" href="{% url_for controller='package', action='search', tags=tag.name %}">{{ h.truncate(tag.display_name, 22) }}</a> + {% endfor %} + </div> +</div> + --- /dev/null +++ b/ckanext/datagovau/templates/package/read.html @@ -1,1 +1,18 @@ +{% ckan_extends %} +{% block primary_content_inner %} +{{ super() }} +<div class="module-content"> + {{ h.disqus_comments() }} +</div> +{% endblock %} +{% block secondary_content %} + {{ super() }} + + {% set dataset_extent = h.get_pkg_dict_extra(c.pkg_dict, 'spatial', '') %} + {% if dataset_extent %} + {% snippet "spatial/snippets/dataset_map_sidebar.html", extent=dataset_extent %} + {% endif %} + +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/search.html @@ -1,1 +1,7 @@ +{% ckan_extends %} +{% block secondary_content %} +{{ super() }} + {% snippet "spatial/snippets/spatial_query.html", default_extent="[[-11, 114], [-42, 154]]" %} +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/snippets/package_basic_fields.html @@ -1,1 +1,26 @@ +{% ckan_extends %} + +{% block package_basic_fields_license %} +<div class="control-group"> + {% set error = errors.license_id %} + <label class="control-label" for="field-license">{{ _("License") }}</label> + <div class="controls"> + <select id="field-license" name="license_id" data-module="autocomplete"> + {% for license_desc, license_id in licenses|sort if license_desc %} + {# Make cc-by the default value for data.gov.au #} + <option value="{{ license_id }}" {% if data.get('license_id', 'cc-by') == license_id %}selected="selected"{% endif %}>{{ license_desc }}</option> + {% endfor %} + </select> + {% if error %}<span class="error-block">{{ error }}</span>{% endif %} + <span class="info-block info-inline"> + <i class="icon-info-sign"></i> + {% trans %} + License definitions and additional information can be found + at <a href="http://opendefinition.org/licenses/">opendefinition.org</a> + {% endtrans %} + </span> + </div> +</div> +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/snippets/package_metadata_fields.html @@ -1,1 +1,30 @@ +{% ckan_extends %} +{# Remove 'free extras' from the package form. If you're using +convert_to/from_extras() as we are with our 'custom_text' field below then +you need to remove free extras from the form, or editing your custom field +won't work. #} +{% block custom_fields %} +{% endblock %} + +{# https://github.com/okfn/ckan/blob/master/ckan/templates/macros/form.html documents the macros for fields #} + +{% block dataset_fields %} +{% if data.groups %} +<div class="control-group"> + <label class="control-label">Groups/Themes</label> + <div class="controls"> + {% for group in data.groups %} + <label class="checkbox" for="field-group-{{ loop.index0 }}"> + <input id="field-group-{{ loop.index0 }}" type="checkbox" name="groups__{{ loop.index0 }}__id" value="{{ group.id }}" checked="checked" /> + {{ group.title }} + </label> + {% endfor %} + </div> +</div> +{% endif %} +{% set group_name = 'groups__%s__id' % data.groups|length %} +{% set group_attrs = {'data-module': 'autocomplete', 'data-module-source': '/api/2/util/group/autocomplete?q=?', 'data-module-key': 'id', 'data-module-label': 'title'} %} +{{ form.input(group_name, label=_('Add Group/Theme'), id="field-group", value=data[group_name], classes=['control-medium'], attrs=group_attrs) }} +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/snippets/resource_form.html @@ -1,1 +1,43 @@ +{% ckan_extends %} + {% block basic_fields_url %} + {% set is_upload = (data.url_type == 'upload') %} + {% set field_url='url' %} + {% set field_upload='upload' %} + {% set field_clear='clear_upload' %} + {% set is_upload_enabled=h.uploads_enabled() %} + {% set is_url=data.url and not is_upload %} + {% set upload_label=_('File') %} + {% set url_label=_('URL') %} + + {% set placeholder = placeholder if placeholder else _('http://example.com/my-image.jpg') %} + {% set url_label = url_label or _('Image URL') %} + {% set upload_label = upload_label or _('Image') %} + + {% if is_upload_enabled %} + <div class="image-upload" data-module="image-upload" data-module-is_url="{{ 'true' if is_url else 'false' }}" data-module-is_upload="{{ 'true' if is_upload else 'false' }}" + data-module-field_url="{{ field_url }}" data-module-field_upload="{{ field_upload }}" data-module-field_clear="{{ field_clear }}" data-module-upload_label="{{ upload_label }}"> + {% endif %} + + {% call form.input(field_url, label=url_label, id='field-image-url', placeholder=placeholder, value=data.get(field_url), error=errors.get(field_url), classes=['control-full']) %} +<span id="autoupdate_form"> + {% call form.select('autoupdate', label=_('Generate API from this Link'), options= [{'value': 'active', 'text': 'Active'}, {'value': 'inactive', 'text': 'Inactive'}], selected='Active', error=errors.autoupdate) %} +<br/> +Where a file is compatible with either CKAN or GeoServer we will attempt to make a functional end-point for this resource. The link provided above will also be checked for a new version based on the update frequency as set at the dataset level. +</span> +{% endcall %} +{% endcall %} + + {% if is_upload_enabled %} + {{ form.input(field_upload, label=upload_label, id='field-image-upload', type='file', placeholder='', value='', error='', classes=['control-full']) }} + {% if is_upload %} + {{form.checkbox(field_clear, label=_('Clear Upload'), id='field-clear-upload', value='true', error='', classes=['control-full']) }} + {% endif %} + {% endif %} + + {% if is_upload_enabled %}</div>{% endif %} + + + {% endblock %} + + --- /dev/null +++ b/ckanext/datagovau/templates/user/dashboard_datasets.html @@ -1,1 +1,16 @@ +{% ckan_extends %} +{% block primary_content_inner %} + <h2 class="page-heading">{{ _('My Datasets') }}</h2> + {% if h.get_user_datasets(c.user_dict) %} + {% snippet 'snippets/package_list.html', packages=h.get_user_datasets(c.user_dict) %} + {% else %} + <p class="empty"> + You haven\'t created/edited any datasets. + {% if h.check_access('package_create') %} + {% link_for _('Create one now?'), controller='package', action='new' %} + {% endif %} + </p> + {% endif %} +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/user/read.html @@ -1,1 +1,29 @@ +{% ckan_extends %} + +{% block primary_content_inner %} + <h2 class="hide-heading"> + {% block page_heading %}{{ _('Datasets') }}{% endblock %} + </h2> + {% block package_list %} + {% if h.get_user_datasets(c.user_dict) %} + {% snippet 'snippets/package_list.html', packages=h.get_user_datasets(c.user_dict) %} + {% else %} + + {% if c.is_myself %} + <p class="empty"> + {{ _('You haven\'t created any datasets.') }} + {% if h.check_access('package_create') %} + {% link_for _('Create one now?'), controller='package', action='new' %} + {% endif %} + </p> + {% else %} + <p class="empty"> + {{ _('User hasn\'t created any datasets.') }} + </p> + {% endif %} + {% endif %} + {% endblock %} +{% endblock %} + + --- /dev/null +++ b/ckanext/datagovau/theme/public/licenses.json @@ -1,1 +1,30 @@ +[ + { + "domain_content": true, + "domain_data": false, + "domain_software": false, + "family": "", + "id": "other-open", + "is_generic": true, + "is_okd_compliant": true, + "is_osi_compliant": false, + "maintainer": "", + "status": "active", + "title": "Other (Open)", + "url": "" + }, + { + "domain_content": true, + "domain_data": false, + "domain_software": false, + "family": "", + "id": "cc-by", + "is_okd_compliant": true, + "is_osi_compliant": false, + "maintainer": "", + "status": "active", + "title": "Creative Commons Attribution 3.0 Australia", + "url": "http://creativecommons.org/licenses/by/3.0/au/" + } +] --- a/ckanext/example/__init__.py +++ /dev/null @@ -1,2 +1,1 @@ -# package --- a/ckanext/example/controller.py +++ /dev/null @@ -1,53 +1,1 @@ -import sys -from ckan.lib.base import request -from ckan.lib.base import c, g, h -from ckan.lib.base import model -from ckan.lib.base import render -from ckan.lib.base import _ -from ckan.lib.navl.validators import not_empty - -from ckan.controllers.user import UserController - - -class CustomUserController(UserController): - """This controller is an example to show how you might extend or - override core CKAN behaviour from an extension package. - - It overrides 2 method hooks which the base class uses to create the - validation schema for the creation and editing of a user; to require - that a fullname is given. - """ - - new_user_form = 'user/register.html' - - def _add_requires_full_name_to_schema(self, schema): - """ - Helper function that modifies the fullname validation on an existing schema - """ - schema['fullname'] = [not_empty, unicode] - - def _new_form_to_db_schema(self): - """ - Defines a custom schema that requires a full name to be supplied - - This method is a hook that the base class calls for the validation - schema to use when creating a new user. - """ - schema = super(CustomUserController, self)._new_form_to_db_schema() - self._add_requires_full_name_to_schema(schema) - return schema - - def _edit_form_to_db_schema(self): - """ - Defines a custom schema that requires a full name cannot be removed - when editing the user. - - This method is a hook that the base class calls for the validation - schema to use when editing an exiting user. - """ - schema = super(CustomUserController, self)._edit_form_to_db_schema() - self._add_requires_full_name_to_schema(schema) - return schema - - --- a/ckanext/example/forms.py +++ /dev/null @@ -1,244 +1,1 @@ -import os, logging -from ckan.authz import Authorizer -import ckan.logic.action.create as create -import ckan.logic.action.update as update -import ckan.logic.action.get as get -from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras,\ - convert_from_extras, convert_to_tags, convert_from_tags -from ckan.logic import NotFound, NotAuthorized, ValidationError -from ckan.logic import tuplize_dict, clean_dict, parse_params -import ckan.logic.schema as default_schema -from ckan.logic.schema import package_form_schema, group_form_schema -import ckan.logic.validators as val -from ckan.model import vocabulary -from ckan.lib.base import BaseController, render, c, model, abort, request -from ckan.lib.base import redirect, _, config, h -from ckan.lib.package_saver import PackageSaver -from ckan.lib.field_types import DateType, DateConvertError -from ckan.lib.navl.dictization_functions import Invalid -from ckan.lib.navl.dictization_functions import validate, missing -from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten -from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer, IConfigurable -from ckan.plugins import implements, SingletonPlugin -from ckan.lib.navl.validators import (ignore_missing, - not_empty, - empty, - ignore, - keep_extras, - ) - -log = logging.getLogger(__name__) - -class ExampleGroupForm(SingletonPlugin): - """This plugin demonstrates how a class packaged as a CKAN - extension might extend CKAN behaviour by providing custom forms - based on the type of a Group. - - In this case, we implement two extension interfaces to provide custom - forms for specific types of group. - - - ``IConfigurer`` allows us to override configuration normally - found in the ``ini``-file. Here we use it to specify where the - form templates can be found. - - - ``IGroupForm`` allows us to provide a custom form for a dataset - based on the 'type' that may be set for a group. Where the - 'type' matches one of the values in group_types then this - class will be used. - """ - implements(IGroupForm, inherit=True) - implements(IConfigurer, inherit=True) - - def update_config(self, config): - """ - This IConfigurer implementation causes CKAN to look in the - ```templates``` directory when looking for the group_form() - """ - here = os.path.dirname(__file__) - rootdir = os.path.dirname(os.path.dirname(here)) - template_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', 'templates') - config['extra_template_paths'] = ','.join([template_dir, - config.get('extra_template_paths', '')]) - - def group_form(self): - """ - Returns a string representing the location of the template to be - rendered. e.g. "forms/group_form.html". - """ - return 'forms/group_form.html' - - def group_types(self): - """ - Returns an iterable of group type strings. - - If a request involving a group of one of those types is made, then - this plugin instance will be delegated to. - - There must only be one plugin registered to each group type. Any - attempts to register more than one plugin instance to a given group - type will raise an exception at startup. - """ - return ["testgroup"] - - def is_fallback(self): - """ - Returns true iff this provides the fallback behaviour, when no other - plugin instance matches a group's type. - - As this is not the fallback controller we should return False. If - we were wanting to act as the fallback, we'd return True - """ - return False - - def form_to_db_schema(self): - """ - Returns the schema for mapping group data from a form to a format - suitable for the database. - """ - return group_form_schema() - - def db_to_form_schema(self): - """ - Returns the schema for mapping group data from the database into a - format suitable for the form (optional) - """ - return {} - - def check_data_dict(self, data_dict): - """ - Check if the return data is correct. - - raise a DataError if not. - """ - - def setup_template_variables(self, context, data_dict): - """ - Add variables to c just prior to the template being rendered. - """ - - -class ExampleDatasetForm(SingletonPlugin): - """This plugin demonstrates how a theme packaged as a CKAN - extension might extend CKAN behaviour. - - In this case, we implement three extension interfaces: - - - ``IConfigurer`` allows us to override configuration normally - found in the ``ini``-file. Here we use it to specify where the - form templates can be found. - - ``IDatasetForm`` allows us to provide a custom form for a dataset - based on the type_name that may be set for a package. Where the - type_name matches one of the values in package_types then this - class will be used. - """ - implements(IDatasetForm, inherit=True) - implements(IConfigurer, inherit=True) - implements(IConfigurable) - - def update_config(self, config): - """ - This IConfigurer implementation causes CKAN to look in the - ```templates``` directory when looking for the package_form() - """ - here = os.path.dirname(__file__) - rootdir = os.path.dirname(os.path.dirname(here)) - template_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', 'templates') - config['extra_template_paths'] = ','.join([template_dir, - config.get('extra_template_paths', '')]) - - def configure(self, config): - """ - Adds our new vocabulary to the database if it doesn't - already exist. - """ - self.vocab_name = u'example_vocab' - v = vocabulary.get(self.vocab_name) - if not v: - log.info("Adding vocab %s" % self.vocab_name) - vocab = model.Vocabulary(self.vocab_name) - model.Session.add(vocab) - model.Session.commit() - - def package_form(self): - """ - Returns a string representing the location of the template to be - rendered. e.g. "package/new_package_form.html". - """ - return 'forms/dataset_form.html' - - def is_fallback(self): - """ - Returns true iff this provides the fallback behaviour, when no other - plugin instance matches a package's type. - - As this is not the fallback controller we should return False. If - we were wanting to act as the fallback, we'd return True - """ - return True - - def package_types(self): - """ - Returns an iterable of package type strings. - - If a request involving a package of one of those types is made, then - this plugin instance will be delegated to. - - There must only be one plugin registered to each package type. Any - attempts to register more than one plugin instance to a given package - type will raise an exception at startup. - """ - return ["example_dataset_form"] - - def setup_template_variables(self, context, data_dict=None): - """ - Adds variables to c just prior to the template being rendered that can - then be used within the form - """ - c.licences = [('', '')] + model.Package.get_license_options() - c.publishers = [('Example publisher', 'Example publisher 2')] - c.is_sysadmin = Authorizer().is_sysadmin(c.user) - c.resource_columns = model.Resource.get_columns() - - ## This is messy as auths take domain object not data_dict - pkg = context.get('package') or c.pkg - if pkg: - c.auth_for_change_state = Authorizer().am_authorized( - c, model.Action.CHANGE_STATE, pkg) - - def form_to_db_schema(self): - """ - Returns the schema for mapping package data from a form to a format - suitable for the database. - """ - schema = package_form_schema() - schema.update({ - 'published_by': [not_empty, unicode, convert_to_extras], - 'vocab_tag_string': [ignore_missing, convert_to_tags(self.vocab_name)], - }) - return schema - - def db_to_form_schema(self): - """ - Returns the schema for mapping package data from the database into a - format suitable for the form (optional) - """ - schema = package_form_schema() - schema.update({ - 'tags': { - '__extras': [keep_extras] - }, - 'vocab_tag_string': [convert_from_tags(self.vocab_name), ignore_missing], - 'published_by': [convert_from_extras, ignore_missing], - }) - return schema - - def check_data_dict(self, data_dict): - """ - Check if the return data is correct and raises a DataError if not. - """ - return - - --- a/ckanext/example/package_form.py +++ /dev/null @@ -1,40 +1,1 @@ -from sqlalchemy.util import OrderedDict -from pylons.i18n import _ -from ckan.forms import common -from ckan.forms import package - - -# Setup the fieldset -def build_example_form(is_admin=False, - user_editable_groups=None, - **kwargs): - """Customise the core CKAN dataset editing form by adding a new - field "temporal coverage", and changing the layout of the core - fields. - """ - # Restrict fields - builder = package.build_package_form( - user_editable_groups=user_editable_groups) - - # Extra fields - builder.add_field(common.DateRangeExtraField('temporal_coverage')) - - # Layout - field_groups = OrderedDict([ - (_('Customised Basic information'), ['title', 'name', 'url', - 'notes', 'tags']), - (_('Details'), ['author', 'author_email', 'groups', - 'maintainer', 'maintainer_email', - 'license_id', 'temporal_coverage' ]), - (_('Resources'), ['resources']), - ]) - builder.set_displayed_fields(field_groups) - return builder - - -def get_example_fieldset(is_admin=False, user_editable_groups=None, **kwargs): - return build_example_form(is_admin=is_admin, - user_editable_groups=user_editable_groups, - **kwargs).get_fieldset() - --- a/ckanext/example/plugin.py +++ /dev/null @@ -1,102 +1,1 @@ -import os -from logging import getLogger -from genshi.filters.transform import Transformer - -from ckan.plugins import implements, SingletonPlugin -from ckan.plugins import IConfigurer -from ckan.plugins import IGenshiStreamFilter -from ckan.plugins import IRoutes - -log = getLogger(__name__) - - -class ExamplePlugin(SingletonPlugin): - """This plugin demonstrates how a theme packaged as a CKAN - extension might extend CKAN behaviour. - - In this case, we implement three extension interfaces: - - - ``IConfigurer`` allows us to override configuration normally - found in the ``ini``-file. Here we use it to specify the site - title, and to tell CKAN to look in this package for templates - and resources that customise the core look and feel. - - - ``IGenshiStreamFilter`` allows us to filter and transform the - HTML stream just before it is rendered. In this case we use - it to rename "frob" to "foobar" - - - ``IRoutes`` allows us to add new URLs, or override existing - URLs. In this example we use it to override the default - ``/register`` behaviour with a custom controller - """ - implements(IConfigurer, inherit=True) - implements(IGenshiStreamFilter, inherit=True) - implements(IRoutes, inherit=True) - - def update_config(self, config): - """This IConfigurer implementation causes CKAN to look in the - ```public``` and ```templates``` directories present in this - package for any customisations. - - It also shows how to set the site title here (rather than in - the main site .ini file), and causes CKAN to use the - customised package form defined in ``package_form.py`` in this - directory. - """ - here = os.path.dirname(__file__) - rootdir = os.path.dirname(os.path.dirname(here)) - our_public_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', 'public') - template_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', - 'templates') - # set our local template and resource overrides - config['extra_public_paths'] = ','.join([our_public_dir, - config.get('extra_public_paths', '')]) - config['extra_template_paths'] = ','.join([template_dir, - config.get('extra_template_paths', '')]) - # add in the extra.css - config['ckan.template_head_end'] = config.get('ckan.template_head_end', '') +\ - '<link rel="stylesheet" href="/css/extra.css" type="text/css"> ' - # set the title - config['ckan.site_title'] = "Example CKAN theme" - # set the customised package form (see ``setup.py`` for entry point) - config['package_form'] = "example_form" - - def filter(self, stream): - """Conform to IGenshiStreamFilter interface. - - This example filter renames 'frob' to 'foobar' (this string is - found in the custom ``home/index.html`` template provided as - part of the package). - """ - stream = stream | Transformer('//p[@id="examplething"]/text()')\ - .substitute(r'frob', r'foobar') - return stream - - def before_map(self, map): - """This IRoutes implementation overrides the standard - ``/user/register`` behaviour with a custom controller. You - might instead use it to provide a completely new page, for - example. - - Note that we have also provided a custom register form - template at ``theme/templates/user/register.html``. - """ - # Hook in our custom user controller at the points of creation - # and edition. - map.connect('/user/register', - controller='ckanext.example.controller:CustomUserController', - action='register') - map.connect('/user/edit', - controller='ckanext.example.controller:CustomUserController', - action='edit') - map.connect('/user/edit/{id:.*}', - controller='ckanext.example.controller:CustomUserController', - action='edit') - - map.connect('/package/new', controller='package_formalchemy', action='new') - map.connect('/package/edit/{id}', controller='package_formalchemy', action='edit') - return map - --- a/ckanext/example/theme/public/css/extra.css +++ /dev/null @@ -1,5 +1,1 @@ -body { - background-color: pink; -} - --- a/ckanext/example/theme/templates/forms/dataset_form.html +++ /dev/null @@ -1,251 +1,1 @@ -<form id="dataset-edit" method="post" - py:attrs="{'class':'has-errors'} if errors else {}" - xmlns:i18n="http://genshi.edgewall.org/i18n" - xmlns:py="http://genshi.edgewall.org/" - xmlns:xi="http://www.w3.org/2001/XInclude"> - -<div class="error-explanation" py:if="error_summary"> -<h2>Errors in form</h2> -<p>The form contains invalid entries:</p> -<ul> - <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)} - <py:if test="key=='Resources'"> - <ul> - <py:for each="idx, errordict in enumerate(errors.get('resources', []))"> - <li py:if="errordict"> - Resource ${idx}: - <ul> - <li py:for="thiskey, thiserror in errordict.items()">${thiskey}: <py:for each="errorinfo in thiserror">${errorinfo}; </py:for></li> - </ul> - </li> - </py:for> - </ul> - </py:if> - </li> -</ul> -</div> - -<fieldset id="basic-information"> - <dl> - <dt class="title-label"><label class="field_opt" for="title">Title</label></dt> - <dd class="title-field"> - <input id="title" - class="js-title" - name="title" type="text" - value="${data.get('title', '')}" - placeholder="${_('A short descriptive title for the dataset')}" - /> - </dd> - <dd class="title-instructions field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> - - <dt class="name-label"><label class="field_req" for="name">Url</label></dt> - <dd class="name-field"> - <span class="js-url-text url-text">${url(controller='package', action='index')+'/'}<span class="js-url-viewmode js-url-suffix"> </span><a href="#" style="display: none;" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span> - <input style="display: none;" id="name" maxlength="100" name="name" type="text" class="url-input js-url-editmode js-url-input" value="${data.get('name', '')}" /> - <p class="js-url-is-valid"> </p> - </dd> - <dd style="display: none;" class="js-url-editmode name-instructions basic">2+ characters, lowercase, using only 'a-z0-9' and '-_'</dd> - <dd class="js-url-editmode name-instructions field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> - - <dt class="homepage-label"><label class="field_opt" for="url">Home Page</label></dt> - <dd class="homepage-field"><input id="url" name="url" type="text" value="${data.get('url', '')}"/></dd> - <dd class="homepage-instructions instructions basic">The URL for the web page describing the data (not the data itself).</dd> - <dd class="homepage-instructions hints">e.g. http://www.example.com/growth-figures.html</dd> - <dd class="homepage-instructions field_error" py:if="errors.get('url', '')">${errors.get('url', '')}</dd> - - <dt class="license-label"><label class="field_opt" for="license_id">License</label></dt> - <dd class="license-field"> - <select id="license_id" name="license_id"> - <py:for each="licence_desc, licence_id in c.licences"> - <option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', '') == licence_id else None}" >${licence_desc}</option> - </py:for> - </select> - </dd> - <dd class="license-instructions instructions basic">The licence under which the dataset is released.</dd> - - <dt class="description-label"><label class="field_opt" for="notes">Description</label></dt> - <dd class="description-field"><div class="markdown-editor"> - <ul class="button-row"> - <li><button class="pretty-button js-markdown-edit depressed">Edit</button></li> - <li><button class="pretty-button js-markdown-preview">Preview</button></li> - </ul> - <textarea class="markdown-input" name="notes" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('notes','')}</textarea> - <div class="markdown-preview" style="display: none;"></div> - <span class="hints">You can use <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown formatting</a> here.</span> -  - </div></dd> - </dl> -</fieldset> - -<fieldset id="resources"> - <div class="instructions basic"><h3>Resources: the files and APIs associated with this dataset</h3></div> - <table class="resource-table-edit"> - <thead> - <tr> - <th class="field_req resource-url">Resource</th> - <th class="resource-delete-link"></th> - </tr> - </thead> - <tbody class="js-resource-editor"> - </tbody> - </table> - - - <div class="resource-add"> - <ul class="button-row"> - <li><h4>Add a resource:</h4></li> - <li><button class="pretty-button js-link-file">Link to a file</button></li> - <li><button class="pretty-button js-link-api">Link to an API</button></li> - <li class="js-upload-file ckan-logged-in" style="display: none;"><button class="pretty-button js-upload-file">Upload a file</button></li> - </ul> - </div> -</fieldset> - -<fieldset id="groups"> - <h3>Groups</h3> - <dl> - <py:for each="num, group in enumerate(data.get('groups', []))"> - <?python - authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']] - authorized_group = authorized_group[0] if authorized_group else None - ?> - - <dt py:if="'id' in group"> - <input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" /> - <input type="hidden" name="groups__${num}__name" value="${group.get('name', authorized_group['name'] if authorized_group else '')}" /> - </dt> - <dd py:if="'id' in group"><label for="groups__${num}__checked">${group.get('name', authorized_group['name'] if authorized_group else '')}</label></dd> - </py:for> - - <dt>Group</dt> - <dd py:if="c.groups_available"> - <select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id"> - <option selected="selected" value="">(None)</option> - <py:for each="group in c.groups_available"> - <option value="${group['id']}" >${group['name']}</option> - </py:for> - </select> - </dd> - <dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd> - </dl> - <h3>Tags</h3> - <dl> - <dt class="tags-label"><label class="field_opt" for="tags">Tags</label></dt> - <dd class="tags-field"> - <input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text" - value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', [])])}" /> - </dd> - <dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.okfn.org/ckan/doc/faq#TagConventions">this wiki page</a>.</dd> - <dd class="tags-instructions hints">e.g. pollution, rivers, water quality</dd> - <dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd> - </dl> - <h3>Tags with Vocabulary</h3> - <dl> - <dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt> - <dd class="tags-field"> - <input class="long autocomplete-tag" id="vocab_tag_string" name="vocab_tag_string" size="60" type="text" - value="${data.get('vocab_tag_string') or ', '.join([tag['name'] for tag in data.get('vocab_tags', [])])}" /> - </dd> - <dd class="tags-instructions instructions basic" i18n:msg="">Similar to standard CKAN tags, but these use a fixed vocabulary.</dd> - <dd class="tags-instructions field_error" py:if="errors.get('vocab_tag_string', '')">${errors.get('vocab_tag_string', '')}</dd> - </dl> -</fieldset> -<fieldset id='further-information'> - <dl> - <dt><label class="field_opt" for="author">Author</label></dt> - <dd><input id="author" name="author" type="text" value="${data.get('author', '')}" /></dd> - <dd class="instructions basic">The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.</dd> - - <dt><label class="field_opt" for="author_email">Author email</label></dt> - <dd><input id="author_email" name="author_email" type="text" value="${data.get('author_email', '')}" /></dd> - - <dt><label class="field_opt" for="maintainer">Maintainer</label></dt> - <dd><input id="maintainer" name="maintainer" type="text" value="${data.get('maintainer', '')}" /></dd> - <dd class="instructions basic">If there is another important contact person (in addition to the person in the Author field) then provide details here.</dd> - - <dt><label class="field_opt" for="maintainer_email">Maintainer email</label></dt> - <dd><input id="maintainer_email" name="maintainer_email" type="text" value="${data.get('maintainer_email', '')}" /></dd> - - <dt><label class="field_opt" for="version">Version</label></dt> - <dd><input id="version" maxlength="100" name="version" type="text" value="${data.get('version', '')}" /></dd> - <dd class="instructions basic">A number representing the version (if applicable)</dd> - <dd class="hints">e.g. 1.2.0</dd> - - <dt py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt> - <dd py:if="c.is_sysadmin or c.auth_for_change_state"> - <select id="state" name="state" > - <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option> - <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option> - </select> - </dd> - - </dl> -</fieldset> - -<fieldset id='extras'> - <dl> - <dt><label class="field_req" for="published_by">Published by *</label></dt> - <dd> - <select id="published_by" name="published_by"> - <py:for each="published_name, published_desc in c.publishers"> - <option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_by', '') == published_name else None}" > - ${published_desc} - </option> - </py:for> - </select> - </dd> - <dd class="instructions basic">The organisation credited with or associated with the publication of this data.</dd> - - <py:with vars="extras = data.get('extras', [])"> - <py:for each="num, extra in enumerate(data.get('extras', []))"> - <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt> - <dd> - <input id="extras__${num}__key" name="extras__${num}__key" type="hidden" value="${extra.get('key')}" /> - <input id="extras__${num}__value" name="extras__${num}__value" type="text" value="${extra.get('value')}" /> - <input type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input> - </dd> - </py:for> - - <py:for each="num in range(len(extras), len(extras) + 4)"> - <dt><label for="extras__${num}__key">New key</label></dt> - <dd> - <input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" /> - with value - <input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" /> - </dd> - </py:for> - </py:with> - </dl> -</fieldset> - -<label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)</label> -<textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', '')}</textarea> - -<div class="ckan-logged-in" style="display: none;"> - <p>Author: ${c.author}</p> -</div> -<div class="ckan-logged-out"> - <label>Author: ${c.author}</label> - <p i18n:msg="" class="hints"> - Since you have not signed in this will just be your IP address. - <a href="${h.url_for(controller='user', action='login', id=None)}" target="_blank">Click here to sign in</a> before saving (opens in new window). - </p> -</div> - -<div class="form-submit"> - <input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" /> - <py:if test="c.pkg"> - <input id="cancel" class="pretty-button href-action" name="cancel" type="reset" value="${_('Cancel')}" action="${h.url_for(controller='package', action='read', id=c.pkg.name)}" /> - </py:if> - <p i18n:msg="" class="hints"> - <strong>Important:</strong> By submitting content, you agree to release your contributions under the <a href="http://opendatacommons.org/licenses/odbl/1.0/">Open Database License</a>. Please <strong>refrain</strong> from editing this page if you are <strong>not</strong> happy to do this. - </p> - <div class="clear"></div> -</div> - -</form> - --- a/ckanext/example/theme/templates/forms/group_form.html +++ /dev/null @@ -1,102 +1,1 @@ -<form id="group-edit" action="" method="post" - py:attrs="{'class':'has-errors'} if errors else {}" - xmlns:i18n="http://genshi.edgewall.org/i18n" - xmlns:py="http://genshi.edgewall.org/" - xmlns:xi="http://www.w3.org/2001/XInclude"> -<div class="error-explanation" py:if="error_summary"> -<h2>Errors in form</h2> -<p>The form contains invalid entries:</p> -<ul> - <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}</li> -</ul> -</div> - -<fieldset id="basic-information"> - <dl> - <dt><label class="field_opt" for="name">The Title</label></dt> - <dd><input class="js-title" id="title" name="title" type="text" value="${data.get('title', '')}"/></dd> - - <dt><label class="field_opt" for="title">Url</label></dt> - <dd class="name-field"> - <span class="js-url-text url-text">${g.site_url+h.url_for(controller='group', action='index')+'/'}<span class="js-url-viewmode js-url-suffix"> </span><a style="display: none;" href="#" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span> - <input style="display: none;" id="name" maxlength="100" name="name" type="text" class="url-input js-url-editmode js-url-input" value="${data.get('name', '')}" /> - <p class="js-url-is-valid"> </p> - </dd> - <dd style="display: none;" class="js-url-editmode instructions basic">2+ chars, lowercase, using only 'a-z0-9' and '-_'</dd> - <dd class="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> - - <dt class="description-label"><label class="field_opt" for="title">Description</label></dt> - <dd class="description-field"><div class="markdown-editor"> - <ul class="button-row"> - <li><button class="pretty-button js-markdown-edit depressed">Edit</button></li> - <li><button class="pretty-button js-markdown-preview">Preview</button></li> - </ul> - <textarea class="markdown-input" name="description" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('description','')}</textarea> - <div class="markdown-preview" style="display: none;"></div> - <span class="hints">You can use <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown formatting</a> here.</span> - </div></dd> - - - <dt class="state-label" py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt> - <dd class="state-field" py:if="c.is_sysadmin or c.auth_for_change_state"> - <select id="state" name="state" > - <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option> - <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option> - </select> - </dd> - </dl> -</fieldset> - -<fieldset id="extras"> - <h3>Extras</h3> - <dl> - <py:with vars="extras = data.get('extras', [])"> - <py:for each="num, extra in enumerate(data.get('extras', []))"> - <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt> - <dd> - <input id="extras__${num}__key" name="extras__${num}__key" type="hidden" value="${extra.get('key')}" /> - <input id="extras__${num}__value" name="extras__${num}__value" type="text" value="${extra.get('value')}" /> - <input type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input> - </dd> - </py:for> - - <py:for each="num in range(len(extras), len(extras) + 4)"> - <dt><label for="extras__${num}__key">New key</label></dt> - <dd> - <input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" /> - with value - <input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" /> - </dd> - </py:for> - </py:with> - </dl> -</fieldset> - -<fieldset id="datasets"> - <h3>Datasets</h3> - <dl py:if="data.get('packages')"> - <py:for each="num, package in enumerate(data.get('packages'))"> - <dt><input checked="checked" id="datasets__${num}__name" name="packages__${num}__name" type="checkbox" value="${package['name']}"/></dt> - <dd> - <label for="packages__${num}__name">${package['name']}</label> - </dd> - </py:for> - </dl> - <p py:if="not data.get('packages')">There are no datasets currently in this group.</p> - - <h3>Add datasets</h3> - <dl> - <dt><label class="field_opt" for="packages__${len(data.get('packages', []))}__name">Dataset</label></dt> - <dd><input class="autocomplete-dataset" id="datasets__${len(data.get('packages', []))}__name" name="packages__${len(data.get('packages', []))}__name" type="text" /></dd> - </dl> -</fieldset> - -<div class="form-submit"> - <input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" /> - <py:if test="c.group"> - <input id="cancel" class="pretty-button href-action" name="cancel" type="reset" value="${_('Cancel')}" action="${h.url_for(controller='group', action='read', id=c.group.name)}" /> - </py:if> -</div> -</form> - --- a/ckanext/example/theme/templates/home/index.html +++ /dev/null @@ -1,30 +1,1 @@ -<html xmlns:py="http://genshi.edgewall.org/" - xmlns:i18n="http://genshi.edgewall.org/i18n" - xmlns:xi="http://www.w3.org/2001/XInclude" - py:strip=""> - <py:def function="page_title">Home</py:def> - - <py:def function="optional_head"> - <style type="text/css"> - #examplething { - background-color: yellow; - padding: 10px; - } - </style> - </py:def> - - <div py:match="content"> - <h2>Welcome to Example Theme!</h2> - <p> - This page left intentionally ugly - </p> - <p id="examplething"> - Here is the frob - </p> - ${select("*")} - </div> - - <xi:include href="layout.html" /> -</html> - --- a/ckanext/example/theme/templates/layout.html +++ /dev/null @@ -1,31 +1,1 @@ -<html xmlns="http://www.w3.org/1999/xhtml" - xmlns:py="http://genshi.edgewall.org/" - xmlns:xi="http://www.w3.org/2001/XInclude" - xmlns:doap="http://usefulinc.com/ns/doap" - xmlns:foaf="http://xmlns.com/foaf/0.1/" - py:strip="" - > - - <py:match path="//div[@class='menu']"> - <div class="menu"> - ${h.nav_link(c, _('Home'), controller='home', action='index')} - ${h.nav_link(c, _('Data'), controller='package', action='index')} - ${h.nav_link(c, _('New dataset'), controller='package', action='new')} - ${h.nav_link(c, _('New group'), controller='group', action='new')} - </div> - </py:match> - - - <py:match path="//div[@id='top-bar']/div[@class='search-form']"> - <div class="search-form"> - <form action="${url(controller='package', action='search')}" method="GET"> - <input type="search" class="search" name="q" value="" autocomplete="off" results="5" placeholder="What are you looking for?" id="bigsearch" /> - <input type="submit" class="searchbutton" value="search" /> - </form> - </div> - </py:match> - - <xi:include href="layout_base.html" /> -</html> - --- a/ckanext/example/theme/templates/user/register.html +++ /dev/null @@ -1,50 +1,1 @@ -<form id="user-edit" action="" method="post" - py:attrs="{'class':'has-errors'} if errors else {}" - xmlns:i18n="http://genshi.edgewall.org/i18n" - xmlns:py="http://genshi.edgewall.org/" - xmlns:xi="http://www.w3.org/2001/XInclude"> -<div class="error-explanation" py:if="error_summary"> -<h2>Errors in form</h2> -<p>The form contains invalid entries:</p> -<ul> - <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}</li> -</ul> -</div> - - <dl> - <dt><label class="field_opt" for="name">Login:</label></dt> - <dd><input type="text" name="name" value="${data.get('name','')}" /></dd> - <dd class="instructions basic">3+ chars, using only 'a-z0-9' and '-_'</dd> - <dd class="field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> - - <dt><label class="field_opt" for="fullname">Full name:</label></dt> - <dd><input type="text" name="fullname" value="${data.get('fullname','')}" /></dd> - <dd class="field_error" py:if="errors.get('fullname', '')">${errors.get('fullname', '')}</dd> - - <dt><label class="field_opt" for="email">E-Mail</label></dt> - <dd><input type="text" name="email" value="${data.get('email','')}" /></dd> - - <dt><label class="field_opt" for="password1">Password:</label></dt> - <dd><input type="password" name="password1" value="" /></dd> - <dd class="field_error" py:if="errors.get('password1', '')">${errors.get('password1', '')}</dd> - - <dt><label class="field_opt" for="password2">Password (repeat):</label></dt> - <dd><input type="password" name="password2" value="" /></dd> - - <dd py:if="g.recaptcha_publickey"> - <script type="text/javascript" - src="http://www.google.com/recaptcha/api/challenge?k=${g.recaptcha_publickey}"> - </script> - <noscript> - <iframe src="http://www.google.com/recaptcha/api/noscript?k=${g.recaptcha_publickey}" - height="300" width="500" frameborder="0"></iframe><br/> - <textarea name="recaptcha_challenge_field" rows="3" cols="40"> </textarea> - <input type="hidden" name="recaptcha_response_field" value="manual_challenge" /> - </noscript> - </dd> - - </dl> - <input id="save" name="save" type="submit" class="pretty-button primary" value="Register now »" /> -</form> - --- a/rename.sh +++ /dev/null @@ -1,14 +1,1 @@ -if [ $# -ne 1 ]; then - echo "Usage: `basename $0` {NewExtensionName}" - exit 65 -fi -NEWNAME=$1 -NEWNAME_LOWER="`echo $NEWNAME | awk '{print tolower($0)}'`" -echo $NEWNAME_LOWER -mv ckanext/example ckanext/$NEWNAME_LOWER -grep -rl Example * | grep -v `basename $0` | xargs perl -pi -e "s/Example/$NEWNAME/g" -grep -rl example * | grep -v `basename $0` | xargs perl -pi -e "s/example/$NEWNAME_LOWER/g" -cd .. -mv ckanext-example ckanext-$NEWNAME_LOWER - --- a/setup.py +++ b/setup.py @@ -1,34 +1,27 @@ from setuptools import setup, find_packages -version = '0.2' +version = '0.1' setup( - name='ckanext-example', + name='ckanext-datagovau', version=version, - description='Example extension for customising CKAN', + description='Extension for customising CKAN for data.gov.au', long_description='', classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers keywords='', - author='Seb Bacon', - author_email='seb.bacon@gmail.com', + author='Alex Sadleir', + author_email='alex.sadleir@linkdigital.com.au', url='', license='', packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), - namespace_packages=['ckanext', 'ckanext.example'], + namespace_packages=['ckanext', 'ckanext.datagovau'], include_package_data=True, zip_safe=False, - install_requires=[ - # -*- Extra requirements: -*- - ], + install_requires=[], entry_points=\ """ [ckan.plugins] - example=ckanext.example.plugin:ExamplePlugin - example_datasetform=ckanext.example.forms:ExampleDatasetForm - example_groupform=ckanext.example.forms:ExampleGroupForm - - [ckan.forms] - example_form = ckanext.example.package_form:get_example_fieldset + datagovau=ckanext.datagovau.plugin:DataGovAuPlugin """, )