commit 886605bc01c5218b0a286918061c972f5fe4ba85 Author: Matias De lellis Date: Fri May 20 09:46:46 2016 -0300 Initial release diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..15aabbf --- /dev/null +++ b/.travis.yml @@ -0,0 +1,53 @@ +sudo: required +dist: trusty +language: php +php: + - 5.6 + - 7 +env: + global: + - CORE_BRANCH=stable9 + matrix: + - DB=pgsql + +matrix: + allow_failures: + - env: DB=pgsql CORE_BRANCH=master + include: + - php: 5.6 + env: DB=sqlite + - php: 5.6 + env: DB=mysql + - php: 5.6 + env: DB=pgsql CORE_BRANCH=master + fast_finish: true + +before_install: + # install firefox and enable a display for running JavaScript tests + - export DISPLAY=:99.0 + - sh -e /etc/init.d/xvfb start + - sudo apt-get update + - sudo apt-get -y install python3-setuptools firefox mariadb-server + - sudo easy_install3 requests ocdev + - nvm install 5.9 + - npm install -g npm@latest + - make + # install core + - cd ../ + - ocdev setup core --dir owncloud --branch $CORE_BRANCH --no-history + - mv quicknotes owncloud/apps/ + +before_script: + - createuser -U travis -s oc_autotest + - mysql -u root -e 'create database oc_autotest;' + - mysql -u root -e "CREATE USER 'oc_autotest'@'localhost' IDENTIFIED BY '';" + - mysql -u root -e "grant all on oc_autotest.* to 'oc_autotest'@'localhost';" + - cd owncloud + - mkdir data + - ./occ maintenance:install --database-name oc_autotest --database-user oc_autotest --admin-user admin --admin-pass admin --database $DB --database-pass='' + - ./occ app:enable quicknotes + - ocdev server & + - cd apps/quicknotes + +script: + - make test \ No newline at end of file diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..19c4731 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,4 @@ +# Authors + +* Matias De lellis: + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..66a4145 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +owncloud-quicknotes (0.0.1) +* **Security**: Security description here +* **Backwards incompatible change**: Changes in the API +* **New dependency**: New dependencies such as a new ownCloud or PHP version +* **Bugfix**: Bugfix description +* **Enhancement**: New feature description \ No newline at end of file diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..2def0e8 --- /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 +. \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..25892ed --- /dev/null +++ b/Makefile @@ -0,0 +1,177 @@ +# This file is licensed under the Affero General Public License version 3 or +# later. See the COPYING file. +# @author Bernhard Posselt +# @copyright Bernhard Posselt 2012, 2014 + +# Generic Makefile for building and packaging an ownCloud 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: + make build + make test + 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)/*.log" \ + --exclude="../$(app_name)/js/*.log" \ + +# Builds the source package for the app store, ignores php and js tests +.PHONY: appstore +appstore: + make build + make test + 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/.*" \ + +# Command for running JS and PHP tests. Works for package.json files in the js/ +# and root directory. If phpunit is not installed systemwide, a copy is fetched +# from the internet +.PHONY: test +test: +ifneq (,$(wildcard $(CURDIR)/js/package.json)) + cd js && $(npm) run test +endif +ifneq (,$(wildcard $(CURDIR)/package.json)) + $(npm) run test +endif +ifeq (, $(shell which phpunit 2> /dev/null)) + @echo "No phpunit command available, downloading a copy from the web" + mkdir -p $(build_tools_directory) + curl -sSL https://phar.phpunit.de/phpunit.phar -o $(build_tools_directory)/phpunit.phar + php $(build_tools_directory)/phpunit.phar -c phpunit.xml + php $(build_tools_directory)/phpunit.phar -c phpunit.integration.xml +else + phpunit -c phpunit.xml + phpunit -c phpunit.integration.xml +endif \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..53e2aeb --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# Quick Notes +Place this app in **owncloud/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.owncloud.com/) then run: + + 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 \ No newline at end of file diff --git a/appinfo/app.php b/appinfo/app.php new file mode 100644 index 0000000..53c3622 --- /dev/null +++ b/appinfo/app.php @@ -0,0 +1,43 @@ + + * @copyright Matias De lellis 2016 + */ + +namespace OCA\QuickNotes\AppInfo; + +use OCP\AppFramework\App; + +require_once __DIR__ . '/autoload.php'; + +$app = new App('quicknotes'); +$container = $app->getContainer(); + +$container->query('OCP\INavigationManager')->add(function () use ($container) { + $urlGenerator = $container->query('OCP\IURLGenerator'); + $l10n = $container->query('OCP\IL10N'); + return [ + // the string under which your app will be referenced in owncloud + 'id' => 'quicknotes', + + // sorting weight for the navigation. The higher the number, the higher + // will it be listed in the navigation + 'order' => 10, + + // the route that will be shown on startup + 'href' => $urlGenerator->linkToRoute('quicknotes.page.index'), + + // the icon that will be shown in the navigation + // this file needs to exist in img/ + 'icon' => $urlGenerator->imagePath('quicknotes', 'app.svg'), + + // the title of your application. This will be used in the + // navigation or on the settings page of your app + 'name' => $l10n->t('Quick Notes'), + ]; +}); \ No newline at end of file diff --git a/appinfo/autoload.php b/appinfo/autoload.php new file mode 100644 index 0000000..f5f865b --- /dev/null +++ b/appinfo/autoload.php @@ -0,0 +1,19 @@ + + * @copyright Matias De lellis 2016 + */ + +namespace OCA\QuickNotes\AppInfo; + +use OCP\AppFramework\App; + +/** + * Additional autoloader registration, e.g. registering composer autoloaders + */ +// require_once __DIR__ . '/../vendor/autoload.php'; \ No newline at end of file diff --git a/appinfo/database.xml b/appinfo/database.xml new file mode 100644 index 0000000..4e2b92a --- /dev/null +++ b/appinfo/database.xml @@ -0,0 +1,84 @@ + + *dbname* + true + false + utf8 + + *dbprefix*quicknotes_notes + + + id + integer + true + true + true + true + 8 + + + user_id + text + 200 + + true + + + title + text + 200 + + true + + + content + clob + + true + + + color + text + + +
+ + *dbprefix*quicknotes_tasks + + + id + integer + true + true + true + true + 8 + + + note_id + integer + true + true + 8 + + + description + text + 200 + + true + + + done + boolean + false + true + + + ordering + integer + 0 + true + + +
+ \ No newline at end of file diff --git a/appinfo/info.xml b/appinfo/info.xml new file mode 100644 index 0000000..41002ef --- /dev/null +++ b/appinfo/info.xml @@ -0,0 +1,14 @@ + + + quicknotes + Quick Notes + Quick notes with text, check lists and pictures + AGPL + Matias De lellis + 0.0.2 + QuickNotes + tool + + + + \ No newline at end of file diff --git a/appinfo/routes.php b/appinfo/routes.php new file mode 100644 index 0000000..6062580 --- /dev/null +++ b/appinfo/routes.php @@ -0,0 +1,12 @@ + [ + 'note' => ['url' => '/notes'], + 'note_api' => ['url' => '/api/0.1/notes'] + ], + 'routes' => [ + ['name' => 'page#index', 'url' => '/', 'verb' => 'GET'], + ['name' => 'note_api#preflighted_cors', 'url' => '/api/0.1/{path}', + 'verb' => 'OPTIONS', 'requirements' => ['path' => '.+']] + ] +]; \ No newline at end of file diff --git a/controller/errors.php b/controller/errors.php new file mode 100644 index 0000000..00127af --- /dev/null +++ b/controller/errors.php @@ -0,0 +1,24 @@ + $e->getMessage()]; + return new DataResponse($message, Http::STATUS_NOT_FOUND); + } + } + +} \ No newline at end of file diff --git a/controller/notecontroller.php b/controller/notecontroller.php new file mode 100644 index 0000000..975168b --- /dev/null +++ b/controller/notecontroller.php @@ -0,0 +1,109 @@ + + * @copyright Matias De lellis 2016 + */ + +namespace OCA\QuickNotes\Controller; + +use OCP\IRequest; +use OCP\AppFramework\Http; +use OCP\AppFramework\Http\DataResponse; +use OCP\AppFramework\Controller; + +use OCA\QuickNotes\Db\Note; +use OCA\QuickNotes\Db\NoteMapper; +use OCA\QuickNotes\Db\TaskMapper; + +class NoteController extends Controller { + + private $mapper; + private $userId; + + public function __construct($AppName, IRequest $request, NoteMapper $mapper, $UserId) { + parent::__construct($AppName, $request); + $this->mapper = $mapper; + $this->userId = $UserId; + } + + /** + * @NoAdminRequired + */ + public function index() { + return new DataResponse($this->mapper->findAll($this->userId)); + } + + /** + * @NoAdminRequired + * + * @param int $id + */ + public function show($id) { + try { + return new DataResponse($this->mapper->find($id, $this->userId)); + } catch(Exception $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + } + + /** + * @NoAdminRequired + * + * @param string $title + * @param string $content + */ + public function create($title, $content, $color = "#F7EB96") { + $note = new Note(); + $note->setTitle($title); + $note->setContent($content); + $note->setColor($color); + $note->setUserId($this->userId); + return new DataResponse($this->mapper->insert($note)); + } + + /** + * @NoAdminRequired + * + * @param int $id + * @param string $title + * @param string $content + */ + public function update($id, $title, $content, $color = "#F7EB96") { + try { + $note = $this->mapper->find($id, $this->userId); + } catch(Exception $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + $note->setTitle($title); + $note->setContent($content); + $note->setColor($color); + return new DataResponse($this->mapper->update($note)); + } + + /** + * @NoAdminRequired + * + * @param int $id + */ + public function destroy($id) { + try { + $note = $this->mapper->find($id, $this->userId); + } catch(Exception $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + /*$taskmapper = new TaskMapper($this->mapper->db); + $tasks = $taskmapper->findAll($note); + foreach ($tasks as $task) { + $taskmapper->delete($task->id); + }*/ + $this->mapper->delete($note); + + return new DataResponse($note); + } + } \ No newline at end of file diff --git a/controller/pagecontroller.php b/controller/pagecontroller.php new file mode 100644 index 0000000..654fa60 --- /dev/null +++ b/controller/pagecontroller.php @@ -0,0 +1,45 @@ + + * @copyright Matias De lellis 2016 + */ + +namespace OCA\QuickNotes\Controller; + +use OCP\IRequest; +use OCP\AppFramework\Http\TemplateResponse; +use OCP\AppFramework\Http\DataResponse; +use OCP\AppFramework\Controller; + +class PageController extends Controller { + + + private $userId; + + public function __construct($AppName, IRequest $request, $UserId){ + parent::__construct($AppName, $request); + $this->userId = $UserId; + } + + /** + * 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() { + $params = ['user' => $this->userId]; + return new TemplateResponse('quicknotes', 'main', $params); // templates/main.php + } + + +} \ No newline at end of file diff --git a/css/style.css b/css/style.css new file mode 100644 index 0000000..f588d92 --- /dev/null +++ b/css/style.css @@ -0,0 +1,144 @@ +#app-content-wrapper { + height: 100%; +} + +.quicknote { + min-height: 150px; + width: 250px; + padding: 6px; + border-radius: 3px; + box-shadow: 0 4px 6px #c1c1c1; +} + +.quicknote:hover { + box-shadow: 0px 0px 6px #808080; +} + +.note-active { + z-index: 10; + height: 100%; + /*width: 100%;*/ +} + +.icon-delete-note { + float: right; + position: absolute; + right: 10px; + top: 6px; +} + +#div-content .save-button { + float: right; +} + +#div-content textarea { + border: 0; + overflow-y: auto; + /*resize: none;*/ + background: inherit; +} + +/* Grid Note */ + +#div-content .note-title { + height: 28px; + width: calc(100% - 20px); + font-size: 18px; + font-weight: bold; + text-overflow: ellipsis; + white-space: nowrap; + overflow: hidden; +} + +.noselect { + -webkit-touch-callout: none; /* iOS Safari */ + -webkit-user-select: none; /* Chrome/Safari/Opera */ + -khtml-user-select: none; /* Konqueror */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* Internet Explorer/Edge */ + user-select: none; /* Non-prefixed version, currently + not supported by any browser */ +} + +.note-toolbar { + float:left; +} + +.circle-toolbar { + display:inline-block; + width:20px; + height:20px; + min-width: 20px; + border-radius:10px; +} + +.ciclle-toolbar:hover { + color: #ccc; + text-decoration:none; + background:#333; +} + +/* Isotope Grid */ + +.notes-grid { + margin: 0 auto; + padding: 15px; +} +.note-grid-item { + margin-bottom: 10px; +} + +/* Modal Note */ + +/* The Modal (background) */ + +.modal-note { + position: fixed; /* Stay in place */ + z-index: 10000; /* Sit on top */ + padding-top: 100px; /* Location of the box */ + left: 0; + top: 0; + width: 100%; /* Full width */ + height: 100%; /* Full height */ + overflow: auto; /* Enable scroll if needed */ + background-color: rgb(0,0,0); /* Fallback color */ + background-color: rgba(0,0,0,0.4); /* Black w/ opacity */ +} + +.hide-delete-icon, +.hide-modal-note { + display: none; /* Hidden by default */ +} +.show-delete-icon, +.show-modal-note { + display: block; +} + +#content-editable { + min-height: 20px; +} +/* Modal Content */ + +.modal-content { + position: relative; + margin: auto; + width: 60%; + height: auto; + min-height: unset; + box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2),0 6px 20px 0 rgba(0,0,0,0.19); + -webkit-animation-name: animatetop; + -webkit-animation-duration: 0.4s; + animation-name: animatetop; + animation-duration: 0.4s +} + +/* Add Animation */ +@-webkit-keyframes animatetop { + from {top:-300px; opacity:0} + to {top:0; opacity:1} +} + +@keyframes animatetop { + from {top:-300px; opacity:0} + to {top:0; opacity:1} +} diff --git a/db/note.php b/db/note.php new file mode 100644 index 0000000..b09b5cc --- /dev/null +++ b/db/note.php @@ -0,0 +1,23 @@ + $this->id, + 'title' => $this->title, + 'content' => $this->content, + 'color' => $this->color + ]; + } +} \ No newline at end of file diff --git a/db/notemapper.php b/db/notemapper.php new file mode 100644 index 0000000..47032d1 --- /dev/null +++ b/db/notemapper.php @@ -0,0 +1,23 @@ +findEntity($sql, [$id, $userId]); + } + + public function findAll($userId) { + $sql = 'SELECT * FROM *PREFIX*quicknotes_notes WHERE user_id = ?'; + return $this->findEntities($sql, [$userId]); + } + +} \ No newline at end of file diff --git a/db/task.php b/db/task.php new file mode 100644 index 0000000..f087161 --- /dev/null +++ b/db/task.php @@ -0,0 +1,24 @@ + $this->id, + 'description' => $this->description, + 'done' => $this->done, + 'ordering' => $this->ordering, + 'noteId' => $this->noteId + ]; + } +} \ No newline at end of file diff --git a/db/taskmapper.php b/db/taskmapper.php new file mode 100644 index 0000000..ff2ea75 --- /dev/null +++ b/db/taskmapper.php @@ -0,0 +1,23 @@ +findEntity($sql, [$id, $noteId]); + } + + public function findAll($noteId) { + $sql = 'SELECT * FROM *PREFIX*quicknotes_tasks WHERE note_id = ?'; + return $this->findEntities($sql, [$noteId]); + } + +} \ No newline at end of file diff --git a/img/app.svg b/img/app.svg new file mode 100644 index 0000000..f929ca0 --- /dev/null +++ b/img/app.svg @@ -0,0 +1,138 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/js/script.js b/js/script.js new file mode 100644 index 0000000..ba5aad2 --- /dev/null +++ b/js/script.js @@ -0,0 +1,390 @@ +/** + * ownCloud - quicknotes + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Matias De lellis + * @copyright Matias De lellis 2016 + */ + +(function (OC, window, $, undefined) { +'use strict'; + +$(document).ready(function () { + +var translations = { + newNote: $('#new-note-string').text() +}; + +// this notes object holds all our notes +var Notes = function (baseUrl) { + this._baseUrl = baseUrl; + this._notes = []; + this._activeNote = undefined; +}; + +Notes.prototype = { + load: function (id) { + var self = this; + this._notes.forEach(function (note) { + if (note.id === id) { + note.active = true; + self._activeNote = note; + } else { + note.active = false; + } + }); + }, + getActive: function () { + return this._activeNote; + }, + unsetActive: function () { + this._activeNote = undefined; + this._notes.forEach(function (note) { + note.active = false; + }); + }, + removeActive: function () { + var index; + var deferred = $.Deferred(); + var id = this._activeNote.id; + this._notes.forEach(function (note, counter) { + if (note.id === id) { + index = counter; + } + }); + + if (index !== undefined) { + // delete cached active note if necessary + if (this._activeNote === this._notes[index]) { + delete this._activeNote; + } + + this._notes.splice(index, 1); + + $.ajax({ + url: this._baseUrl + '/' + id, + method: 'DELETE' + }).done(function () { + deferred.resolve(); + }).fail(function () { + deferred.reject(); + }); + } else { + deferred.reject(); + } + return deferred.promise(); + }, + create: function (note) { + var deferred = $.Deferred(); + var self = this; + $.ajax({ + url: this._baseUrl, + method: 'POST', + contentType: 'application/json', + data: JSON.stringify(note) + }).done(function (note) { + self._notes.push(note); + self._activeNote = note; + self.load(note.id); + deferred.resolve(); + }).fail(function () { + deferred.reject(); + }); + return deferred.promise(); + }, + getAll: function () { + return this._notes; + }, + getColors: function () { + var colors = []; + var Ccolors = []; + $.each(this._notes, function(index, value) { + if ($.inArray(value.color, colors) == -1) { + colors.push(value.color); + } + }); + $.each(colors, function(index, value) { + Ccolors.push({color: value}); + }); + return Ccolors; + }, + loadAll: function () { + var deferred = $.Deferred(); + var self = this; + $.get(this._baseUrl).done(function (notes) { + self._activeNote = undefined; + self._notes = notes.reverse(); + deferred.resolve(); + }).fail(function () { + deferred.reject(); + }); + return deferred.promise(); + }, + updateActive: function (title, content, color) { + var note = this.getActive(); + note.title = title; + note.content = content; + note.color = color; + + return $.ajax({ + url: this._baseUrl + '/' + note.id, + method: 'PUT', + contentType: 'application/json', + data: JSON.stringify(note) + }); + }, + updateId: function (id, title, content, color) { + this.load(id); + return this.updateActive(title, content, color); + } +}; + +// this will be the view that is used to update the html +var View = function (notes) { + this._notes = notes; +}; + +View.prototype = { + + showAll: function () { + //self._notes.unsetActive(); + $('.notes-grid').isotope({ filter: '*'}); + }, + editNote: function (id) { + var modal = $('#modal-note-editable'); + var modaltitle = $('#modal-note-editable #title-editable'); + var modalcontent = $('#modal-note-editable #content-editable'); + var modalnote = $("#modal-note-editable .quicknote"); + + var note = $('.notes-grid [data-id=' + id + ']').parent(); + + var title = note.find("#title-editable").html(); + var content = note.find("#content-editable").html(); + var color = note.children().css("background-color"); + + var modalid = modalnote.data('id'); + + if (id == modalid) + return; + + modalnote.data('id', id); + modaltitle.html(title); + modalcontent.html(content); + modalnote.css("background-color", color); + + modal.removeClass("hide-modal-note"); + modal.addClass("show-modal-note"); + modalcontent.focus(); + }, + cancelEdit: function () { + var modal = $('#modal-note-editable'); + var modaltitle = $('#modal-note-editable #title-editable'); + var modalcontent = $('#modal-note-editable #content-editable'); + var modalnote = $("#modal-note-editable .quicknote"); + + this._notes.unsetActive(); + this.showAll(); + + modal.removeClass("show-modal-note"); + modal.addClass("hide-modal-note"); + + modalnote.data('id', -1); + modaltitle.html(""); + modalcontent.html(""); + }, + renderContent: function () { + var source = $('#content-tpl').html(); + var template = Handlebars.compile(source); + var html = template({notes: this._notes.getAll()}); + + $('#div-content').html(html); + + // Init masonty grid to notes. + $('.notes-grid').isotope({ + itemSelector: '.note-grid-item', + layoutMode: 'masonry', + masonry: { + isFitWidth: true, + fitWidth: true, + gutter: 10, + } + }); + + // Handle click event to open note. + var modal = $('#modal-note-editable'); + var modaltitle = $('#modal-note-editable #title-editable'); + var modalcontent = $('#modal-note-editable #content-editable'); + var modalnote = $("#modal-note-editable .quicknote"); + + // Show delete icon on hover. + $(".quicknote").hover(function() { + $(this).find(".icon-delete").addClass( "show-delete-icon"); + }, function(){ + $(this).find(".icon-delete").removeClass("show-delete-icon"); + }); + + // Open notes when clicking them. + $(".quicknote").click(function (event) { + var modalnote = $("#modal-note-editable .quicknote"); + var modalid = modalnote.data('id'); + if (modalid > 0) return; + var id = parseInt($(this).data('id'), 10); + + self.editNote(id); + }); + + // Cancel with escape key + $(document).keyup(function(event) { + if (event.keyCode == 27) { + self.cancelEdit(); + } + }); + + // Remove note icon + var self = this; + $('#app-content .icon-delete-note').click(function (event) { + event.stopPropagation(); + var id = parseInt($(this).parent().data('id'), 10); + self._notes.load(id); + self._notes.removeActive().done(function () { + self.render(); + }).fail(function () { + alert('Could not delete note, not found'); + }); + + }); + + // Handle colors. + $('#app-content .circle-toolbar').click(function (event) { + event.stopPropagation(); + + var color = $(this).css("background-color"); + modalnote.css("background-color", color); + }); + + // handle cancel and saves note. + $('#app-content #cancel-button').click(function (event) { + self.cancelEdit(); + }); + + $('#app-content #save-button').click(function (event) { + event.stopPropagation(); + + var id = modalnote.data('id'); + var title = modaltitle.html(); + var content = modalcontent.html(); + var color = modalnote.css("background-color"); + + self._notes.updateId(id, title, content, color).done(function () { + self._notes.unsetActive(); + + modal.removeClass("show-modal-note"); + modal.addClass("hide-modal-note"); + + modalnote.data('id', -1); + modaltitle.html(""); + modalcontent.html(""); + + self.render(); + }).fail(function () { + alert('DOh!. Could not update note!.'); + }); + }); + }, + renderNavigation: function () { + var source = $('#navigation-tpl').html(); + var template = Handlebars.compile(source); + var html = template({colors: this._notes.getColors(), notes: this._notes.getAll()}); + + $('#app-navigation ul').html(html); + + // show all notes + $('#all-notes').click(function () { + self._notes.unsetActive(); + $('.notes-grid').isotope({ filter: '*'}); + }); + + // create a new note + var self = this; + $('#new-note').click(function () { + var note = { + title: translations.newNote, + content: '', + color: '#F7EB96' + }; + + self._notes.create(note).done(function() { + self.render(); + $('#div-content .text-note').focus(); + }).fail(function () { + alert('Could not create note'); + }); + }); + + // show app menu + $('#app-navigation .app-navigation-entry-utils-menu-button').click(function () { + var entry = $(this).closest('.note'); + entry.find('.app-navigation-entry-menu').toggleClass('open'); + }); + + // delete a note + $('#app-navigation .note .delete').click(function () { + var entry = $(this).closest('.note'); + entry.find('.app-navigation-entry-menu').removeClass('open'); + + self._notes.removeActive().done(function () { + self.render(); + }).fail(function () { + alert('Could not delete note, not found'); + }); + }); + + // load a note + $('#app-navigation .note > a').click(function () { + var id = parseInt($(this).parent().data('id'), 10); + $('.notes-grid').isotope({ filter: function() { + var itemId = parseInt($(this).children().data('id'), 10); + return id == itemId; + } }); + self.editNote(id); + +// self._notes.load(id); + }); + + // Handle colors. + $('#app-navigation .circle-toolbar').click(function (event) { + event.stopPropagation(); + + var color = $(this).css("background-color"); + if (color != 'transparent') { + $('.notes-grid').isotope({ filter: function() { + var itemColor = $(this).children().css("background-color"); + return color == itemColor; + }}); + } + else { + self.showAll(); + } + }); + + }, + render: function () { + this.renderNavigation(); + this.renderContent(); + } +}; + +var notes = new Notes(OC.generateUrl('/apps/quicknotes/notes')); +var view = new View(notes); +notes.loadAll().done(function () { + view.render(); +}).fail(function () { + alert('Could not load notes'); +}); + + +}); + +})(OC, window, jQuery); diff --git a/phpunit.integration.xml b/phpunit.integration.xml new file mode 100644 index 0000000..c899f23 --- /dev/null +++ b/phpunit.integration.xml @@ -0,0 +1,7 @@ + + + + ./tests/integration + + + \ No newline at end of file diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..959875b --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,7 @@ + + + + ./tests/unit + + + \ No newline at end of file diff --git a/service/noteservice.php b/service/noteservice.php new file mode 100644 index 0000000..44a64c6 --- /dev/null +++ b/service/noteservice.php @@ -0,0 +1,77 @@ +mapper = $mapper; + } + + public function findAll($userId) { + return $this->mapper->findAll($userId); + } + + private function handleException ($e) { + if ($e instanceof DoesNotExistException || + $e instanceof MultipleObjectsReturnedException) { + throw new NotFoundException($e->getMessage()); + } else { + throw $e; + } + } + + public function find($id, $userId) { + try { + return $this->mapper->find($id, $userId); + + // in order to be able to plug in different storage backends like files + // for instance it is a good idea to turn storage related exceptions + // into service related exceptions so controllers and service users + // have to deal with only one type of exception + } catch(Exception $e) { + $this->handleException($e); + } + } + + public function create($title, $content, $color = "#F7EB96", $userId) { + $note = new Note(); + $note->setTitle($title); + $note->setContent($content); + $note->setColor($color); + $note->setUserId($userId); + return $this->mapper->insert($note); + } + + public function update($id, $title, $content, $color = "#F7EB96", $userId) { + try { + $note = $this->mapper->find($id, $userId); + $note->setTitle($title); + $note->setContent($content); + $note->setColor($color) + return $this->mapper->update($note); + } catch(Exception $e) { + $this->handleException($e); + } + } + + public function delete($id, $userId) { + try { + $note = $this->mapper->find($id, $userId); + $this->mapper->delete($note); + return $note; + } catch(Exception $e) { + $this->handleException($e); + } + } +} diff --git a/service/notfoundexception.php b/service/notfoundexception.php new file mode 100644 index 0000000..56cbb6f --- /dev/null +++ b/service/notfoundexception.php @@ -0,0 +1,4 @@ + + +
+
+ inc('part.navigation')); ?> + inc('part.settings')); ?> +
+ +
+
+ inc('part.content')); ?> +
+
+
diff --git a/templates/part.content.php b/templates/part.content.php new file mode 100644 index 0000000..cb07a98 --- /dev/null +++ b/templates/part.content.php @@ -0,0 +1,16 @@ + +
diff --git a/templates/part.navigation.php b/templates/part.navigation.php new file mode 100644 index 0000000..b6bab6f --- /dev/null +++ b/templates/part.navigation.php @@ -0,0 +1,44 @@ + + + + + +
    \ No newline at end of file diff --git a/templates/part.note-modal-editable.php b/templates/part.note-modal-editable.php new file mode 100644 index 0000000..86a3fc5 --- /dev/null +++ b/templates/part.note-modal-editable.php @@ -0,0 +1,28 @@ + \ No newline at end of file diff --git a/templates/part.note.php b/templates/part.note.php new file mode 100644 index 0000000..9001641 --- /dev/null +++ b/templates/part.note.php @@ -0,0 +1,7 @@ +
    +
    +
    {{{ title }}}
    + +
    {{{ content }}}
    +
    +
    \ No newline at end of file diff --git a/templates/part.settings.php b/templates/part.settings.php new file mode 100644 index 0000000..7eebe65 --- /dev/null +++ b/templates/part.settings.php @@ -0,0 +1,9 @@ +
    +
    + +
    +
    +
    +
    \ No newline at end of file diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..ac0c56c --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,13 @@ + + * @copyright Matias De lellis 2016 + */ + +require_once __DIR__ . '/../../../tests/bootstrap.php'; +require_once __DIR__ . '/../appinfo/autoload.php'; \ No newline at end of file diff --git a/tests/integration/AppTest.php b/tests/integration/AppTest.php new file mode 100644 index 0000000..434c94a --- /dev/null +++ b/tests/integration/AppTest.php @@ -0,0 +1,36 @@ + + * @copyright Matias De lellis 2016 + */ + +use OCP\AppFramework\App; +use Test\TestCase; + + +/** + * This test shows how to make a small Integration Test. Query your class + * directly from the container, only pass in mocks if needed and run your tests + * against the database + */ +class AppTest extends TestCase { + + private $container; + + public function setUp() { + parent::setUp(); + $app = new App('quicknotes'); + $this->container = $app->getContainer(); + } + + public function testAppInstalled() { + $appManager = $this->container->query('OCP\App\IAppManager'); + $this->assertTrue($appManager->isInstalled('quicknotes')); + } + +} \ No newline at end of file diff --git a/tests/unit/controller/PageControllerTest.php b/tests/unit/controller/PageControllerTest.php new file mode 100644 index 0000000..c43037f --- /dev/null +++ b/tests/unit/controller/PageControllerTest.php @@ -0,0 +1,48 @@ + + * @copyright Matias De lellis 2016 + */ + +namespace OCA\QuickNotes\Controller; + +use PHPUnit_Framework_TestCase; + +use OCP\AppFramework\Http\TemplateResponse; + + +class PageControllerTest extends PHPUnit_Framework_TestCase { + + private $controller; + private $userId = 'john'; + + public function setUp() { + $request = $this->getMockBuilder('OCP\IRequest')->getMock(); + + $this->controller = new PageController( + 'quicknotes', $request, $this->userId + ); + } + + + public function testIndex() { + $result = $this->controller->index(); + + $this->assertEquals(['user' => 'john'], $result->getParams()); + $this->assertEquals('main', $result->getTemplateName()); + $this->assertTrue($result instanceof TemplateResponse); + } + + + public function testEcho() { + $result = $this->controller->doEcho('hi'); + $this->assertEquals(['echo' => 'hi'], $result->getData()); + } + + +} \ No newline at end of file