From: Brian Flowers Date: Sat, 24 Apr 2021 03:00:43 +0000 (-0400) Subject: Initial commit X-Git-Url: http://git.slightlycyberpunk.com%2C%20git.slightlycyberpunk.com/git/?a=commitdiff_plain;h=226e63c9e55fd01aab9ac035c9fc5aa0413cf79e;p=nc-homepage.git Initial commit --- 226e63c9e55fd01aab9ac035c9fc5aa0413cf79e diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..dba13ed --- /dev/null +++ b/COPYING @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ada504f --- /dev/null +++ b/Makefile @@ -0,0 +1,157 @@ +# This file is licensed under the Affero General Public License version 3 or +# later. See the COPYING file. +# @author Bernhard Posselt +# @copyright Bernhard Posselt 2016 + +# Generic Makefile for building and packaging a Nextcloud app which uses npm and +# Composer. +# +# Dependencies: +# * make +# * which +# * curl: used if phpunit and composer are not installed to fetch them from the web +# * tar: for building the archive +# * npm: for building and testing everything JS +# +# If no composer.json is in the app root directory, the Composer step +# will be skipped. The same goes for the package.json which can be located in +# the app root or the js/ directory. +# +# The npm command by launches the npm build script: +# +# npm run build +# +# The npm test command launches the npm test script: +# +# npm run test +# +# The idea behind this is to be completely testing and build tool agnostic. All +# build tools and additional package managers should be installed locally in +# your project, since this won't pollute people's global namespace. +# +# The following npm scripts in your package.json install and update the bower +# and npm dependencies and use gulp as build system (notice how everything is +# run from the node_modules folder): +# +# "scripts": { +# "test": "node node_modules/gulp-cli/bin/gulp.js karma", +# "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update", +# "build": "node node_modules/gulp-cli/bin/gulp.js" +# }, + +app_name=$(notdir $(CURDIR)) +build_tools_directory=$(CURDIR)/build/tools +source_build_directory=$(CURDIR)/build/artifacts/source +source_package_name=$(source_build_directory)/$(app_name) +appstore_build_directory=$(CURDIR)/build/artifacts/appstore +appstore_package_name=$(appstore_build_directory)/$(app_name) +npm=$(shell which npm 2> /dev/null) +composer=$(shell which composer 2> /dev/null) + +all: build + +# Fetches the PHP and JS dependencies and compiles the JS. If no composer.json +# is present, the composer step is skipped, if no package.json or js/package.json +# is present, the npm step is skipped +.PHONY: build +build: +ifneq (,$(wildcard $(CURDIR)/composer.json)) + make composer +endif +ifneq (,$(wildcard $(CURDIR)/package.json)) + make npm +endif +ifneq (,$(wildcard $(CURDIR)/js/package.json)) + make npm +endif + +# Installs and updates the composer dependencies. If composer is not installed +# a copy is fetched from the web +.PHONY: composer +composer: +ifeq (, $(composer)) + @echo "No composer command available, downloading a copy from the web" + mkdir -p $(build_tools_directory) + curl -sS https://getcomposer.org/installer | php + mv composer.phar $(build_tools_directory) + php $(build_tools_directory)/composer.phar install --prefer-dist + php $(build_tools_directory)/composer.phar update --prefer-dist +else + composer install --prefer-dist + composer update --prefer-dist +endif + +# Installs npm dependencies +.PHONY: npm +npm: +ifeq (,$(wildcard $(CURDIR)/package.json)) + cd js && $(npm) run build +else + npm run build +endif + +# Removes the appstore build +.PHONY: clean +clean: + rm -rf ./build + +# Same as clean but also removes dependencies installed by composer, bower and +# npm +.PHONY: distclean +distclean: clean + rm -rf vendor + rm -rf node_modules + rm -rf js/vendor + rm -rf js/node_modules + +# Builds the source and appstore package +.PHONY: dist +dist: + make source + make appstore + +# Builds the source package +.PHONY: source +source: + rm -rf $(source_build_directory) + mkdir -p $(source_build_directory) + tar cvzf $(source_package_name).tar.gz ../$(app_name) \ + --exclude-vcs \ + --exclude="../$(app_name)/build" \ + --exclude="../$(app_name)/js/node_modules" \ + --exclude="../$(app_name)/node_modules" \ + --exclude="../$(app_name)/*.log" \ + --exclude="../$(app_name)/js/*.log" \ + +# Builds the source package for the app store, ignores php and js tests +.PHONY: appstore +appstore: + rm -rf $(appstore_build_directory) + mkdir -p $(appstore_build_directory) + tar cvzf $(appstore_package_name).tar.gz ../$(app_name) \ + --exclude-vcs \ + --exclude="../$(app_name)/build" \ + --exclude="../$(app_name)/tests" \ + --exclude="../$(app_name)/Makefile" \ + --exclude="../$(app_name)/*.log" \ + --exclude="../$(app_name)/phpunit*xml" \ + --exclude="../$(app_name)/composer.*" \ + --exclude="../$(app_name)/js/node_modules" \ + --exclude="../$(app_name)/js/tests" \ + --exclude="../$(app_name)/js/test" \ + --exclude="../$(app_name)/js/*.log" \ + --exclude="../$(app_name)/js/package.json" \ + --exclude="../$(app_name)/js/bower.json" \ + --exclude="../$(app_name)/js/karma.*" \ + --exclude="../$(app_name)/js/protractor.*" \ + --exclude="../$(app_name)/package.json" \ + --exclude="../$(app_name)/bower.json" \ + --exclude="../$(app_name)/karma.*" \ + --exclude="../$(app_name)/protractor\.*" \ + --exclude="../$(app_name)/.*" \ + --exclude="../$(app_name)/js/.*" \ + +.PHONY: test +test: composer + $(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.xml + $(CURDIR)/vendor/phpunit/phpunit/phpunit -c phpunit.integration.xml diff --git a/README.md b/README.md new file mode 100644 index 0000000..902f1f1 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# Homepage +Place this app in **nextcloud/apps/** + +## Building the app + +The app can be built by using the provided Makefile by running: + + make + +This requires the following things to be present: +* make +* which +* tar: for building the archive +* curl: used if phpunit and composer are not installed to fetch them from the web +* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder + +The make command will install or update Composer dependencies if a composer.json is present and also **npm run build** if a package.json is present in the **js/** folder. The npm **build** script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.: + +**package.json**: +```json +"scripts": { + "test": "node node_modules/gulp-cli/bin/gulp.js karma", + "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update", + "build": "node node_modules/gulp-cli/bin/gulp.js" +} +``` + + +## Publish to App Store + +First get an account for the [App Store](http://apps.nextcloud.com/) then run: + + make && make appstore + +The archive is located in build/artifacts/appstore and can then be uploaded to the App Store. + +## Running tests +You can use the provided Makefile to run all tests by using: + + make test + +This will run the PHP unit and integration tests and if a package.json is present in the **js/** folder will execute **npm run test** + +Of course you can also install [PHPUnit](http://phpunit.de/getting-started.html) and use the configurations directly: + + phpunit -c phpunit.xml + +or: + + phpunit -c phpunit.integration.xml + +for integration tests diff --git a/appinfo/app.php b/appinfo/app.php new file mode 100644 index 0000000..dcc258f --- /dev/null +++ b/appinfo/app.php @@ -0,0 +1,4 @@ + + + homepage + Homepage + Create simple homepages + + 0.0.29 + agpl + Brian Flowers + Homepage + workflow + http://git.slightlycyberpunk.com/ + + + + + + Homepage + homepage.page.index + + + + + OCA\Homepage\Settings\Section + OCA\Homepage\Settings\Admin + + diff --git a/appinfo/routes.php b/appinfo/routes.php new file mode 100644 index 0000000..0ac0341 --- /dev/null +++ b/appinfo/routes.php @@ -0,0 +1,18 @@ + OCA\Homepage\Controller\PageController->index() + * + * The controller class has to be registered in the application.php file since + * it's instantiated in there + */ +return [ + 'routes' => [ + ['name' => 'page#index', 'url' => '/', 'verb' => 'GET'], + ['name' => 'page#do_echo', 'url' => '/echo', 'verb' => 'POST'], + ['name' => 'page#updateLayout', 'url' => '/update', 'verb' => 'POST'], + ['name' => 'page#getTypes', 'url' => '/getTypes', 'verb' => 'GET'] +// ['name' => 'page#updateLayout', 'url' => '/update', 'verb' => 'GET'] + ] +]; diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..4b185c8 --- /dev/null +++ b/composer.json @@ -0,0 +1,15 @@ +{ + "name": "Homepage", + "description": "Create simple homepages", + "type": "project", + "license": "AGPL", + "authors": [ + { + "name": "Brian Flowers" + } + ], + "require": {}, + "require-dev": { + "phpunit/phpunit": "^5.4" + } +} diff --git a/css/admin.css b/css/admin.css new file mode 100644 index 0000000..a8cd71d --- /dev/null +++ b/css/admin.css @@ -0,0 +1,51 @@ +td.linksList, td.iframeOptions { + padding-left: 2em; + margin-left: 1em; + background-color: #00002020; + border-radius: 0.1em; + border: 1px solid #00002040; + +} + +td.linksList input { + width: 49%; +} + +td.linksList button { + display: block; + width: 100%; +} + +#saveButton.success { + background-color: #00FF0080; + transition: background-color 2s; +} + +#saveButton { + transition: background-color 2s; +} + +td.iframeOptions { + padding-left: 2em; +} + +td.iframeOptions input { + width: 75%; +} + +td.iframeOptions .height { + width: 23%; +} + +.delete { + border-radius: 0.1em; + +} + +.short { + width: 3em; +} + +.long { + width: 98%; +} diff --git a/css/style.css b/css/style.css new file mode 100644 index 0000000..35b291d --- /dev/null +++ b/css/style.css @@ -0,0 +1,118 @@ +#app { + width: 100%; +} + +/*h1 { + display: block; + width: 100%; + background-image: linear-gradient(#0000 0%, #CCC3 10%, #0005 30%, #0005 70%, #CCC3 90%, #0000 100%); + padding-left: 3%; + font-size: 2em; + height: 2em; + padding-top: 0.5em; + font-weight: bold; +}*/ + +h1 { + font-size: 3em; + font-weight: bold; + height: 2em; + padding: 0.5em; +} + +iframe { + width: 100%; +} + +#applist { +/*display: flex; +flex-flow: row wrap;*/ + position: absolute; + top: 4em; +/* border: 1px solid black; */ + width: 96%; + left: 2%; + padding: 0.5em; +} + + +.smbars { + padding: 0.5em; + display: inline-block; + border-radius: 0.1em; +} + +.smbars span { + vertical-align: top; + margin-left: 0.4em; + margin-top: 0.2em; + font-size: 1.2em; +} + +.smicons { + padding: 0.5em; + display: inline-block; + border-radius: 0.1em; +} + +.smicons span { + display: none; +} + +.lgbars { + padding: 1.5em; + display: inline-block; + border-radius: 0.1em; + border: 1px solid #777; +} + +.lgbars span { + vertical-align: top; + margin-left: 0.4em; + margin-top: 0.2em; + font-size: 1.2em; +} + +.lgicons { + padding: 1.5em; + display: inline-block; + border-radius: 0.1em; +} + +.lgicons span { + display: block; +} + +.fullw { + padding: 1.5em; + display: block; + border-radius: 0.1em; + width: 100%; + text-align: center; +} + +.fullw span { + vertical-align: top; + margin-left: 0.4em; + margin-top: 0.2em; + font-size: 1.2em; +} + +a.fullw , span.fullw{ + border: 1px solid #808080; +} + +.linksList { + font-weight: bold; +} + +#app-content-wrapper { + flex-flow: row wrap; +} + +#app-content-wrapper div { + min-width: 10em; + max-width: 100%; + /*border-right: 1px solid #808080;*/ + padding: 0.5em; +} diff --git a/img/app.svg b/img/app.svg new file mode 100644 index 0000000..96a1b9f --- /dev/null +++ b/img/app.svg @@ -0,0 +1,64 @@ + + + + + + image/svg+xml + + + + + + + + + + diff --git a/js/.admin.js.swp b/js/.admin.js.swp new file mode 100644 index 0000000..6775bad Binary files /dev/null and b/js/.admin.js.swp differ diff --git a/js/admin.js b/js/admin.js new file mode 100644 index 0000000..73b7186 --- /dev/null +++ b/js/admin.js @@ -0,0 +1,398 @@ + +//document.getElementById("requesttoken").value = oc_requesttoken; +//console.log(oc_requesttoken); + +var typeslist; +function typesTwo() { +/* $.ajax({ + method: "POST", + url: OC.generateUrl('/apps/homepage/getTypes'), + data: '', + success: function(data){console.log(data); typeslist=data;}, + failure: function(){alert("failure!");}, + dataType: "json", + contentType : "application/json" + });*/ + return $.ajax({ + method: "GET", + url: OC.generateUrl('/apps/homepage/getTypes'), + data: '', + dataType: "json", + contentType: "application/json", + async: false + }).responseText; +} + +function submit() { + console.log($('form#homepageLayoutForm').serialize()); + var dataArr = $('form#homepageLayoutForm').serializeArray(); + var dataObj = {}; + for(var i = 0; i < dataArr.length; i++) { + dataObj[dataArr[i].name] = dataArr[i].value; + } + dataObj['minWidth'] = document.getElementById("minWidth").value; + console.log(JSON.stringify(dataObj)); + document.getElementById("saveButton").innerHTML = "Saving..."; + + $.ajax({ + method: "POST", + url: OC.generateUrl('/apps/homepage/update'), + data: JSON.stringify({'data': dataObj}), //JSON.stringify({'data': $('form#homepageLayoutForm').serializeArray()}), + success: function(data){ + document.getElementById("saveButton").innerHTML = "Saved!"; + document.getElementById("saveButton").classList.add("success"); + setTimeout(function(){ + document.getElementById("saveButton").innerHTML = "Save"; + document.getElementById("saveButton").classList.remove("success"); + }, 5000); + console.log(data); + }, + failure: function(){alert("failure!");}, + dataType: "json", + contentType : "application/json" + }); +} + +function init() { + const state = JSON.parse(OCP.InitialState.loadState('Homepage', 'state')); + document.getElementById("descriptor").innerHTML = "Define the page using the table below. "+ + "The allowed types are: "; + var ul = document.createElement("ul"); + var types = getTypes(); + var typeKeys = Object.keys(types); + for(var i = 0; i < typeKeys.length; i++) { + var key = typeKeys[i]; + var li = document.createElement("li"); + li.innerHTML += ""+types[key].name+" -- "; + li.innerHTML += types[key].description; + ul.appendChild(li); + } + document.getElementById("descriptor").appendChild(ul); + document.getElementById("descriptor").innerHTML += "You can also define a minimum width. "+ + "This can be particularly useful for mobile browsers where percentages may make columns too narrow."; + for(var i = 0; i < state.count; i++) { + addBlock(state['type_'+i], state['title_'+i], state['mode_'+i], state['width_'+i]); + } + if(state.count == 0) { + addBlock(null, null, null, null); + } + document.getElementById("minWidth").value = state['minWidth']; + document.getElementById("addButton").onclick = function() { addBlock(null); }; + document.getElementById("saveButton").onclick = function() { submit(); }; +} + +function addBlock(type, name, mode, wdth) { + var count = parseInt(document.getElementById("count").value); + document.getElementById("count").value = count+1; + + var table = document.getElementById("homepageLayoutTable"); + var form = document.createElement("form"); + var row = document.createElement("tr"); + var cell = document.createElement("td"); + var typeSelect = document.createElement("select"); + typeSelect.setAttribute("name", "type_"+count); + typeSelect.onchange = typeChange; + var types = getTypes(); + var keys = Object.keys(types); + for(var i = 0; i < keys.length; i++) { + var obj = types[keys[i]]; + var option = document.createElement("option"); + option.value = obj.type; + option.innerHTML = obj.name; + typeSelect.appendChild(option); + } + typeSelect.value = type; + cell.appendChild(typeSelect); + row.appendChild(cell); + //form.appendChild(select); + + cell = document.createElement("td"); + var title = document.createElement("input"); + title.setAttribute("name", "title_"+count); + title.setAttribute("type", "text"); + title.classList.add("long"); + title.setAttribute("placeholder", "title"); + if( name !== null && typeof name !== 'undefined' ) { + title.value = name; + } + cell.appendChild(title); + row.appendChild(cell); + //form.appendChild(title); + + cell = document.createElement("td"); + var select = document.createElement("select"); + select.setAttribute("name", "mode_"+count); + select.setAttribute("id", "mode_"+count); + var modes = getModes("applist"); + var keys = Object.keys(modes); + for(var i = 0; i < keys.length; i++) { + var obj = modes[keys[i]]; + var option = document.createElement("option"); + option.value = obj.type; + option.innerHTML = obj.name; + select.appendChild(option); + } + select.value = mode; + cell.appendChild(select); + row.appendChild(cell); + //form.appendChild(select); + + cell = document.createElement("td"); + var width = document.createElement("input"); + width.setAttribute("name", "width_"+count); + width.setAttribute("type", "text"); + width.setAttribute("placeholder", "%"); + width.setAttribute("class", "short"); + if(wdth !== null && typeof wdth !== 'undefined' ) { + width.value = wdth; + } + cell.appendChild(width); + row.appendChild(cell); + + cell = document.createElement("td"); + var delbtn = document.createElement("button"); + delbtn.setAttribute("type", "button"); + delbtn.innerHTML = "X"; + delbtn.setAttribute("id", "delete_"+count); + delbtn.setAttribute("class", "delete"); + delbtn.onclick = deleteBlock; + cell.appendChild(delbtn); + row.appendChild(cell); + + table.appendChild(row); + typeSelect.onchange(); +} + +function getTypes() { +/* var retval = {}; + retval.applist = {type: "applist", name: "App List"}; + retval.links = {type: "links", name: "Link List"}; +// retval.text = {type: "text", name: "Plaintext content"}; + retval.iframe = {type: "iframe", name: "IFrame"}; + return retval;*/ + var json = $.ajax({ + method: "GET", + url: OC.generateUrl('/apps/homepage/getTypes'), + data: '', + dataType: "json", + contentType: "application/json", + async: false + }).responseText; + return JSON.parse(JSON.parse(json).types); +} + +function getModes(type) { + var retval = {}; + retval.smicons = {type: "smicons", name: "Small Icons"}; + retval.lgicons = {type: "lgicons", name: "Large Icons"}; + retval.smbars = {type: "smbars", name: "Small Bars"}; + retval.lgbars = {type: "lgbars", name: "Large Bars"}; + retval.fullw = {type: "fullw", name: "Full Width"}; + return retval; +} + +function typeChange() { + const state = JSON.parse(OCP.InitialState.loadState('Homepage', 'state')); + var count = this.getAttribute("name").split("_")[1]; + var icount = 0; + + // Reset any previously disable attributes or opened options rows + document.getElementById("mode_"+count).removeAttribute("disabled"); + var opts = document.getElementsByClassName("options_"+count); + for(var i = 0; i < opts.length; i++) { + opts[i].style.display = "none"; + } + + if(this.value == "links") { + if(document.getElementById("options_"+count+"_links") != null) { + document.getElementById("options_"+count+"_links").style.display = "table-row"; + return; + } + var linksRow = document.createElement("tr"); + var linksCell = document.createElement("td"); + linksCell.setAttribute("colspan", 5); + linksCell.setAttribute("class", "linksList"); + linksRow.classList.add("options_"+count); + linksRow.setAttribute("id", "options_"+count+"_links"); + linksRow.appendChild(linksCell); + var row = this.parentElement.parentElement; + if(row.nextSibling != null) { + row.parentElement.insertBefore(linksRow, row.nextSibling); + } else { + row.parentElement.appendChild(linksRow); + } + +console.log("count: "+count); +console.log(state); + var icount = 0; + for(var i = 0; i < state['count']; i++) { +console.log(i); +// icount++; + if(typeof state['links_'+count+'_title_'+i] == 'undefined' || (state["links_"+count+"_title_"+i] == "" && state["links_"+count+"_url_"+i] == "")) { +// icount--; + continue; + } +console.log("icnt: "+icount); + var title = document.createElement("input"); + title.setAttribute("type", "text"); + title.setAttribute("name", "links_"+count+"_title_"+icount); + title.setAttribute("value", state["links_"+count+"_title_"+i]); + linksCell.appendChild(title); + + var url = document.createElement("input"); + url.setAttribute("type", "text"); + url.setAttribute("name", "links_"+count+"_url_"+icount); + url.setAttribute("value", state["links_"+count+"_url_"+i]); + linksCell.appendChild(url); + + var br = document.createElement("br"); + linksCell.appendChild(br); + icount++; + } + + var title = document.createElement("input"); + title.setAttribute("type", "text"); + title.setAttribute("name", "links_"+count+"_title_"+icount); + title.setAttribute("placeholder", "Link Text"); + linksCell.appendChild(title); + + var url = document.createElement("input"); + url.setAttribute("type", "text"); + url.setAttribute("name", "links_"+count+"_url_"+icount); + url.setAttribute("placeholder", "URL"); + linksCell.appendChild(url); + + var add = document.createElement("button"); + add.innerHTML = "+"; + add.onclick = function() { addLink(linksCell); }; + add.setAttribute("type", "button"); + linksCell.appendChild(add); + } else if( this.value == "iframe" ) { + if(document.getElementById("options_"+count+"_iframe") != null) { + document.getElementById("options_"+count+"_iframe").style.display = "table-row"; + return; + } + document.getElementById("mode_"+count).setAttribute("disabled", true); + + var optionsRow = document.createElement("tr"); + var optionsCell = document.createElement("td"); + optionsCell.setAttribute("colspan", 5); + optionsCell.classList.add("iframeOptions"); + optionsRow.classList.add("options_"+count); + optionsRow.setAttribute("id", "options_"+count+"_iframe"); + + var url = document.createElement("input"); + url.setAttribute("type", "text"); + url.setAttribute("name", "url_"+count); + url.setAttribute("placeholder", "URL"); + if( state['url_'+count] != null) { + url.value = state['url_'+count]; + } + optionsCell.appendChild(url); + + var height = document.createElement("input"); + height.setAttribute("type", "text"); + height.setAttribute("name", "height_"+count); + height.classList.add("height"); + height.setAttribute("placeholder", "height"); + if( state['height_'+count] != null) { + height.value = state['height_'+count]; + } + optionsCell.appendChild(height); + +//console.log(row); + optionsRow.appendChild(optionsCell); + var row = this.parentElement.parentElement; +// row.parentElement.insertAfter(row, optionsRow); + row.parentElement.appendChild(optionsRow); +console.log(row); + } +} + +function deleteBlock() { + var count = document.getElementById("count").value; + var target = this.getAttribute("id").split("_")[1]; + + var row = document.getElementById("mode_"+target).parentElement.parentElement; + var next = row.nextSibling; +console.log(row); +console.log(next); + row.parentElement.removeChild(row); +console.log(next); + if(!next.contains(document.getElementById("mode_"+(target+1)))) { + var tmp = next.nextSibling; + next.parentElement.removeChild(next); + next = tmp; + } + + while( next != null ) { + var inputs = next.getElementsByTagName("input"); + var selects = next.getElementsByTagName("select"); + var buttons = next.getElementsByTagName("button"); + inputs = Array.from(inputs).concat(Array.from(selects)).concat(Array.from(buttons)); + for(var i = 0; i < next.classList; i++) { + var classArr = next.classList[i].split("_"); + if(classArr.length < 2) { continue; } + classArr[1] = parseInt(classArr[1])-1; + next.classList.remove(next.classList[i]); + next.classList.add(classArr.join("_")); + } + if(next.getAttribute("id") != null) { + var idArr = next.getAttribute("id").split("_"); + idArr[1] = parseInt(idArr[1])-1; + next.setAttribute("id", idArr.join("_")); + } + for(var i = 0; i < inputs.length; i++) { + if(inputs[i].name != null) { + var namearr = inputs[i].name.split("_"); + namearr[1] = parseInt(namearr[1])-1; + inputs[i].name = namearr.join("_"); + } + if(inputs[i].getAttribute("id") != null) { + var idarr = inputs[i].getAttribute("id").split("_"); + idarr[1] = parseInt(idarr[1])-1; + inputs[i].setAttribute("id", idarr.join("_")); + } + } + next = next.nextSibling; + } + + document.getElementsById("count").value = count-1; + return false; +} + +function addLink(linksCell) { + var btn = linksCell.getElementsByTagName("button")[0]; + var prev = btn.previousSibling; + var prevArr = prev.name.split("_"); + var count = prevArr[1]; + var icount = prevArr[3]; + + var br = document.createElement("br"); + linksCell.insertBefore(br, btn); + + var title = document.createElement("input"); + title.setAttribute("type", "text"); + title.setAttribute("name", "links_"+count+"_title_"+icount); + title.setAttribute("placeholder", "Link Text"); + prev.parentElement.insertBefore(title, btn); + + var url = document.createElement("input"); + url.setAttribute("type", "text"); + url.setAttribute("name", "links_"+count+"_url_"+icount); + url.setAttribute("placeholder", "URL"); + linksCell.insertBefore(url, btn); +} + +init(); + + + + + + + + + + + diff --git a/js/admin.js.save b/js/admin.js.save new file mode 100644 index 0000000..358aee1 --- /dev/null +++ b/js/admin.js.save @@ -0,0 +1,225 @@ + +//document.getElementById("requesttoken").value = oc_requesttoken; +//console.log(oc_requesttoken); + +function submit() { + console.log($('form#homepageLayoutForm').serialize()); + var dataArr = $('form#homepageLayoutForm').serializeArray(); + var dataObj = {}; + for(var i = 0; i < dataArr.length; i++) { + dataObj[dataArr[i].name] = dataArr[i].value; + } + console.log(JSON.stringify(dataObj)); + document.getElementById("saveButton").innerHTML = "Saving..."; + + $.ajax({ + method: "POST", + url: OC.generateUrl('/apps/homepage/update'), + data: JSON.stringify({'data': dataObj}), //JSON.stringify({'data': $('form#homepageLayoutForm').serializeArray()}), + success: function(data){ + document.getElementById("saveButton").innerHTML = "Saved!"; + document.getElementById("saveButton").classList.add("success"); + setTimeout(function(){ + document.getElementById("saveButton").innerHTML = "Save"; + document.getElementById("saveButton").classList.remove("success"); + }, 5000); + console.log(data); + }, + failure: function(){alert("failure!");}, + dataType: "json", + contentType : "application/json" + }); +} + +function init() { + const state = JSON.parse(OCP.InitialState.loadState('Homepage', 'state')); + for(var i = 0; i < state.count; i++) { + addBlock(state['type_'+i], state['title_'+i], state['mode_'+i], state['width_'+i]); + } + if(state.count == 0) { + addBlock(null, null, null, null); + } + document.getElementById("addButton").onclick = function() { addBlock(null); }; + document.getElementById("saveButton").onclick = function() { submit(); }; +} + +function addBlock(type, name, mode, wdth) { + var count = parseInt(document.getElementById("count").value); + document.getElementById("count").value = count+1; + + var table = document.getElementById("homepageLayoutTable"); + var form = document.createElement("form"); + var row = document.createElement("tr"); + var cell = document.createElement("td"); + var typeSelect = document.createElement("select"); + typeSelect.setAttribute("name", "type_"+count); + typeSelect.onchange = typeChange; + var types = getTypes(); + var keys = Object.keys(types); + for(var i = 0; i < keys.length; i++) { + var obj = types[keys[i]]; + var option = document.createElement("option"); + option.value = obj.type; + option.innerHTML = obj.name; + typeSelect.appendChild(option); + } + typeSelect.value = type; + cell.appendChild(typeSelect); + row.appendChild(cell); + //form.appendChild(select); + + cell = document.createElement("td"); + var title = document.createElement("input"); + title.setAttribute("name", "title_"+count); + title.setAttribute("type", "text"); + title.setAttribute("placeholder", "title"); + if( name !== null && typeof name !== 'undefined' ) { + title.value = name; + } + cell.appendChild(title); + row.appendChild(cell); + //form.appendChild(title); + + cell = document.createElement("td"); + var select = document.createElement("select"); + select.setAttribute("name", "mode_"+count); + var modes = getModes("applist"); + var keys = Object.keys(modes); + for(var i = 0; i < keys.length; i++) { + var obj = modes[keys[i]]; + var option = document.createElement("option"); + option.value = obj.type; + option.innerHTML = obj.name; + select.appendChild(option); + } + select.value = mode; + cell.appendChild(select); + row.appendChild(cell); + //form.appendChild(select); + + cell = document.createElement("td"); + var width = document.createElement("input"); + width.setAttribute("name", "width_"+count); + width.setAttribute("type", "text"); + width.setAttribute("placeholder", "%"); + if(wdth !== null && typeof wdth !== 'undefined' ) { + width.value = wdth; + } + cell.appendChild(width); + row.appendChild(cell); + + table.appendChild(row); + typeSelect.onchange(); +} + +function getTypes() { + var retval = {}; + retval.applist = {type: "applist", name: "App List"}; + retval.links = {type: "links", name: "Link List"}; + retval.text = {type: "text", name: "Plaintext content"}; + retval.iframe = {type: "iframe", name: "IFrame"}; + return retval; +} + +function getModes(type) { + var retval = {}; + retval.smicons = {type: "smicons", name: "Small Icons"}; + retval.lgicons = {type: "lgicons", name: "Large Icons"}; + retval.smbars = {type: "smbars", name: "Small Bars"}; + retval.lgbars = {type: "lgbars", name: "Large Bars"}; + retval.fullw = {type: "fullw", name: "Full Width"}; + return retval; +} + +function typeChange() { + const state = JSON.parse(OCP.InitialState.loadState('Homepage', 'state')); + var count = this.getAttribute("name").split("_")[1]; + + if(this.value == "links") { + var linksRow = document.createElement("tr"); + var linksCell = document.createElement("td"); + linksCell.setAttribute("colspan", 4); + linksCell.setAttribute("class", "linksList"); + var row = this.parentElement.parentElement; + if(row.nextSibling != null) { + row.parentElement.insertBefore(linksCell, row.nextSibl); + } else { + row.parentElement.appendChild(linksCell); + } + + for(var i = 0; typeof state["links_"+count+"_title_"+i] != 'undefined'; i++) { + icount = i; + var title = document.createElement("input"); + title.setAttribute("type", "text"); + title.setAttribute("name", "links_"+count+"_title_"+i); + //title.setAttribute("placeholder", "Link Text"); + title.setAttribute("value", state["links_"+count+"_title_"+i]); + linksCell.appendChild(title); + + var url = document.createElement("input"); + url.setAttribute("type", "text"); + url.setAttribute("name", "links_"+count+"_url_"+i); + //url.setAttribute("placeholder", "URL"); + url.setAttribute("value", state["links_"+count+"_url_"+i]); + linksCell.appendChild(url); + + var br = document.createElement("br"); + linksCell.appendChild(br); + } + icount=i; + + var title = document.createElement("input"); + title.setAttribute("type", "text"); + title.setAttribute("name", "links_"+count+"_title_"+icount); + title.setAttribute("placeholder", "Link Text"); + linksCell.appendChild(title); + + var url = document.createElement("input"); + url.setAttribute("type", "text"); + url.setAttribute("name", "links_"+count+"_url_"+icount); + url.setAttribute("placeholder", "URL"); + linksCell.appendChild(url); + + var add = document.createElement("button"); + add.innerHTML = "+"; + add.onclick = function() { addLink(linksCell); }; + add.setAttribute("type", "button"); + linksCell.appendChild(add); + } +} + +function addLink(linksCell) { + var btn = linksCell.getElementsByTagName("button")[0]; + var prev = btn.previousSibling; + var prevArr = prev.name.split("_"); + var count = prevArr[1]; + var icount = prevArr[3]; + + var br = document.createElement("br"); + linksCell.insertBefore(br, btn); + + var title = document.createElement("input"); + title.setAttribute("type", "text"); + title.setAttribute("name", "links_"+count+"_title_"+icount); + title.setAttribute("placeholder", "Link Text"); + prev.parentElement.insertBefore(title, btn); + + var url = document.createElement("input"); + url.setAttribute("type", "text"); + url.setAttribute("name", "links_"+count+"_url_"+icount); + url.setAttribute("placeholder", "URL"); + linksCell.insertBefore(url, btn); +} + +init(); + + + + + + + + + + + diff --git a/js/script.js b/js/script.js new file mode 100644 index 0000000..064f809 --- /dev/null +++ b/js/script.js @@ -0,0 +1,74 @@ +function populateApps(mode) { + var appElems = document.getElementById("appmenu").children; + var appDiv = document.createElement("div"); + for(var i = 0; i < appElems.length; i++) { + if(appElems[i].getAttribute("class") == "menutoggle") { + continue; + } + var appBox = document.createElement("button"); + appBox.innerHTML = appElems[i].innerHTML; + appBox.setAttribute("class", mode); + appDiv.appendChild(appBox); + } + return appDiv; +} + +function populateLinks(mode, count, state) { + var linkDiv = document.createElement("div"); + linkDiv.classList.add("linksList"); + for(var i = 0; typeof state['links_'+count+'_title_'+i] != 'undefined'; i++) { + if(state['links_'+count+'_title_'+i] == "" && state['links_'+count+'_url_'+i] == "") { + continue; + } + + if(state['links_'+count+'_url_'+i] !== "") { + var link = document.createElement("a"); + link.href = state['links_'+count+'_url_'+i]; + } else { + var link = document.createElement("span"); + } + link.innerHTML = ""+state['links_'+count+'_title_'+i]+""; + link.setAttribute("class", mode); + linkDiv.appendChild(link); + } + return linkDiv; +} + +function populateIframe(count, state) { + var iframeDiv = document.createElement("iframe"); + iframeDiv.setAttribute("src", state['url_'+count]); + iframeDiv.style.height = state['height_'+count]; + return iframeDiv; +} + +function init() { + const state = JSON.parse(OCP.InitialState.loadState('Homepage', 'state')); + for(var i = 0; i < state.count; i++) { + addBlock(state['type_'+i], state['title_'+i], state['mode_'+i], state['width_'+i], i, state); + } +} + +function addBlock(type, title, mode, width, count, state) { + var section = document.createElement("div"); + section.style.width = width+"%"; + section.style.minWidth = state['minWidth']; + var header = document.createElement("h1"); + header.innerHTML = title; + section.appendChild(header); + + switch(type) { + case 'applist': + section.appendChild(populateApps(mode)); + break; + case 'links': + section.appendChild(populateLinks(mode, count, state)); + break; + case 'iframe': + section.appendChild(populateIframe(count, state)) + break; + } + + document.getElementById("app-content-wrapper").appendChild(section); +} + +init(); diff --git a/lib/Controller/PageController.php b/lib/Controller/PageController.php new file mode 100644 index 0000000..8749d60 --- /dev/null +++ b/lib/Controller/PageController.php @@ -0,0 +1,85 @@ +userId = $UserId; + $this->config = $config; + $this->stateService = $initialStateService; + } + + /** + * CAUTION: the @Stuff turns off security checks; for this page no admin is + * required and no CSRF check. If you don't know what CSRF is, read + * it up in the docs or you might create a security hole. This is + * basically the only required method to add this exemption, don't + * add it to any other method if you don't exactly know what it does + * + * @NoAdminRequired + * @NoCSRFRequired + */ + public function index() { + if(class_exists('\\OCP\\AppFramework\\Http\\EmptyContentSecurityPolicy')) { + $manager = \OC::$server->getContentSecurityPolicyManager(); + $policy = new \OCP\AppFramework\Http\EmptyContentSecurityPolicy(); + $policy->addAllowedFrameDomain('\'self\''); + $manager->addDefaultPolicy($policy); + } + + $data = json_decode($this->config->getAppValue('data')); + $this->stateService->provideInitialState('Homepage', 'state', json_encode($data)); + return new TemplateResponse('homepage', 'index'); // templates/index.php + } + + public function updateLayout($data) { + $types = json_decode(str_replace(Array("\n", "\t"), "", $typesJSON)); + $old = $this->config->getAppValue("data"); + $this->config->setAppValue("data", json_encode($data)); + return array('status' => 'success', 'old' => json_decode($old), 'new' => $data); + } + + public function getTypes() { + return array('status' => 'success', 'types' => str_replace(array("\t", "\n"), "", $this->typesJSON)); + } +} diff --git a/lib/Service/ConfigService.php b/lib/Service/ConfigService.php new file mode 100644 index 0000000..e061ef0 --- /dev/null +++ b/lib/Service/ConfigService.php @@ -0,0 +1,26 @@ +config = $config; + $this->appName = $appName; + } + + public function getAppValue($key) { + return $this->config->getAppValue($this->appName, $key); + } + + public function setAppValue($key, $value) { + $this->config->setAppValue($this->appName, $key, $value); + } + +} + diff --git a/lib/Settings/Admin.php b/lib/Settings/Admin.php new file mode 100644 index 0000000..fd6948e --- /dev/null +++ b/lib/Settings/Admin.php @@ -0,0 +1,72 @@ + + * + * @author Joas Schilling + * + * @license GNU AGPL version 3 or any later version + * + * 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 . + * + */ + +namespace OCA\Homepage\Settings; + +use OCP\AppFramework\Http\TemplateResponse; +use OCP\IURLGenerator; +use OCP\Settings\ISettings; +use \OCA\Homepage\Service\ConfigService; +use OCP\IInitialStateService; + +class Admin implements ISettings { + + /** @var IURLGenerator */ + protected $url; + + private $appConfig; + private $stateservice; + + public function __construct(IURLGenerator $url, ConfigService $appConfig, IInitialStateService $initialStateService) { + $this->url = $url; + $this->appConfig = $appConfig; + $this->stateservice = $initialStateService; + } + + /** + * @return TemplateResponse + */ + public function getForm() { + $data = json_decode($this->appConfig->getAppValue('data')); + $this->stateservice->provideInitialState('Homepage', 'state', json_encode($data)); + return new TemplateResponse('homepage', 'settings', ["data" => $data], 'blank'); + } + + /** + * @return string the section ID, e.g. 'sharing' + */ + public function getSection() { + return 'homepage'; + } + + /** + * @return int whether the form should be rather on the top or bottom of + * the admin section. The forms are arranged in ascending order of the + * priority values. It is required to return a value between 0 and 100. + * + * E.g.: 70 + */ + public function getPriority() { + return 55; + } +} diff --git a/lib/Settings/Section.php b/lib/Settings/Section.php new file mode 100644 index 0000000..6df2081 --- /dev/null +++ b/lib/Settings/Section.php @@ -0,0 +1,89 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * 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 . + * + */ + +namespace OCA\Homepage\Settings; + +use OCP\IL10N; +use OCP\IURLGenerator; +use OCP\Settings\IIconSection; + +class Section implements IIconSection { + + /** @var IL10N */ + private $l; + + /** @var IURLGenerator */ + private $url; + + /** + * @param IURLGenerator $url + * @param IL10N $l + */ + public function __construct(IURLGenerator $url, IL10N $l) { + $this->url = $url; + $this->l = $l; + } + + /** + * returns the relative path to an 16*16 icon describing the section. + * e.g. '/core/img/places/files.svg' + * + * @returns string + * @since 12 + */ + public function getIcon() { + return $this->url->imagePath('homepage', 'app.svg'); + } + + /** + * returns the ID of the section. It is supposed to be a lower case string, + * e.g. 'ldap' + * + * @returns string + * @since 9.1 + */ + public function getID() { + return 'homepage'; + } + + /** + * returns the translated name as it should be displayed, e.g. 'LDAP / AD + * integration'. Use the L10N service to translate it. + * + * @return string + * @since 9.1 + */ + public function getName() { + return $this->l->t('Homepage'); + } + + /** + * @return int whether the form should be rather on the top or bottom of + * the settings navigation. The sections are arranged in ascending order of + * the priority values. It is required to return a value between 0 and 99. + * + * E.g.: 70 + * @since 9.1 + */ + public function getPriority() { + return 55; + } +} diff --git a/phpunit.integration.xml b/phpunit.integration.xml new file mode 100644 index 0000000..eae19f1 --- /dev/null +++ b/phpunit.integration.xml @@ -0,0 +1,7 @@ + + + + ./tests/Integration + + + diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..82c96d6 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,7 @@ + + + + ./tests/Unit + + + diff --git a/preview.png b/preview.png new file mode 100644 index 0000000..8624b3f Binary files /dev/null and b/preview.png differ diff --git a/templates/content/index.php b/templates/content/index.php new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/templates/content/index.php @@ -0,0 +1 @@ + diff --git a/templates/index.php b/templates/index.php new file mode 100644 index 0000000..b20bab1 --- /dev/null +++ b/templates/index.php @@ -0,0 +1,15 @@ + + +
+
+
+ inc('content/index')); ?> +
+
+
+ diff --git a/templates/navigation/index.php b/templates/navigation/index.php new file mode 100644 index 0000000..efa95c6 --- /dev/null +++ b/templates/navigation/index.php @@ -0,0 +1,10 @@ + diff --git a/templates/settings.php b/templates/settings.php new file mode 100644 index 0000000..b53a23f --- /dev/null +++ b/templates/settings.php @@ -0,0 +1,29 @@ + + +
+
+

t('Homepage'));?>

+

Define your shit in the table below

+ + + +
+ + + + + + + + +
Block TypeBlock TitleDisplay TypeWidth
+ +
+
+
diff --git a/tests/Integration/AppTest.php b/tests/Integration/AppTest.php new file mode 100644 index 0000000..70395f6 --- /dev/null +++ b/tests/Integration/AppTest.php @@ -0,0 +1,29 @@ +container = $app->getContainer(); + } + + public function testAppInstalled() { + $appManager = $this->container->query('OCP\App\IAppManager'); + $this->assertTrue($appManager->isInstalled('homepage')); + } + +} diff --git a/tests/Unit/Controller/PageControllerTest.php b/tests/Unit/Controller/PageControllerTest.php new file mode 100644 index 0000000..f8cde26 --- /dev/null +++ b/tests/Unit/Controller/PageControllerTest.php @@ -0,0 +1,31 @@ +getMockBuilder('OCP\IRequest')->getMock(); + + $this->controller = new PageController( + 'homepage', $request, $this->userId + ); + } + + public function testIndex() { + $result = $this->controller->index(); + + $this->assertEquals('index', $result->getTemplateName()); + $this->assertTrue($result instanceof TemplateResponse); + } + +} diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..dfb7ae5 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,19 @@ +addValidRoot(OC::$SERVERROOT . '/tests'); + +// Fix for "Autoload path not allowed: .../homepage/tests/testcase.php" +\OC_App::loadApp('homepage'); + +if(!class_exists('PHPUnit_Framework_TestCase')) { + require_once('PHPUnit/Autoload.php'); +} + +OC_Hook::clear();