diff options
40 files changed, 2908 insertions, 0 deletions
diff --git a/.buildpath b/.buildpath new file mode 100644 index 0000000..fc4b790 --- /dev/null +++ b/.buildpath @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?> +<buildpath> + <buildpathentry kind="src" path="appinfo"/> + <buildpathentry kind="src" path="templates"/> + <buildpathentry kind="src" path="tests"/> + <buildpathentry kind="con" path="org.eclipse.php.core.LANGUAGE"/> +</buildpath> diff --git a/.project b/.project new file mode 100644 index 0000000..473f121 --- /dev/null +++ b/.project @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>nextant</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.wst.common.project.facet.core.builder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.wst.validation.validationbuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.dltk.core.scriptbuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.php.core.PHPNature</nature> + <nature>org.eclipse.wst.common.project.facet.core.nature</nature> + </natures> +</projectDescription> diff --git a/.settings/org.eclipse.php.core.prefs b/.settings/org.eclipse.php.core.prefs new file mode 100644 index 0000000..0967dbf --- /dev/null +++ b/.settings/org.eclipse.php.core.prefs @@ -0,0 +1,4 @@ +eclipse.preferences.version=1 +include_path=0;/nextant +phpVersion=php7.0 +use_asp_tags_as_php=false diff --git a/.settings/org.eclipse.wst.common.project.facet.core.xml b/.settings/org.eclipse.wst.common.project.facet.core.xml new file mode 100644 index 0000000..0db35c5 --- /dev/null +++ b/.settings/org.eclipse.wst.common.project.facet.core.xml @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?> +<faceted-project> + <fixed facet="php.core.component"/> + <fixed facet="php.component"/> + <installed facet="php.core.component" version="1"/> + <installed facet="php.component" version="7"/> +</faceted-project> diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..20c66f6 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,58 @@ +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: + # enable a display for running JavaScript tests + - export DISPLAY=:99.0 + - sh -e /etc/init.d/xvfb start + - if [[ "$DB" == 'mysql' ]]; then sudo apt-get -y install mariadb-server; fi + - nvm install 5.9 + - npm install -g npm@latest + - make + - make appstore + # install core + - cd ../ + - git clone https://github.com/owncloud/core.git --recursive --depth 1 -b $CORE_BRANCH owncloud + - mv nextant owncloud/apps/ + +before_script: + - if [[ "$DB" == 'pgsql' ]]; then createuser -U travis -s oc_autotest; fi + - if [[ "$DB" == 'mysql' ]]; then mysql -u root -e 'create database oc_autotest;'; fi + - if [[ "$DB" == 'mysql' ]]; then mysql -u root -e "CREATE USER 'oc_autotest'@'localhost' IDENTIFIED BY '';"; fi + - if [[ "$DB" == 'mysql' ]]; then mysql -u root -e "grant all on oc_autotest.* to 'oc_autotest'@'localhost';"; fi + - 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 nextant + - php -S localhost:8080 & + - cd apps/nextant + +script: + - make test + +after_failure: + - cat ../../data/owncloud.log + +addons: + firefox: "latest"
\ No newline at end of file diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 0000000..ccde036 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,4 @@ +# Authors + +* Maxence Lange: <maxence@pontapreta.net> + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..919bef7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,6 @@ +owncloud-nextant (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 @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <http://www.gnu.org/licenses/>. + +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 +<http://www.gnu.org/licenses/>.
\ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ba128e4 --- /dev/null +++ b/Makefile @@ -0,0 +1,174 @@ +# This file is licensed under the Affero General Public License version 3 or +# later. See the COPYING file. +# @author Bernhard Posselt <dev@bernhard-posselt.com> +# @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/.*" \ + +# 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 --coverage-clover build/php-unit.clover + phpunit -c phpunit.integration.xml --coverage-clover build/php-unit.clover +endif
\ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..3c1f4d8 --- /dev/null +++ b/README.md @@ -0,0 +1,103 @@ + +# THIS IS ALPHA - DO NOT USE IN PRODUCTION ENVIRONMENT + + + + +# Nextant + +What it does right now: +- Extract text file (and only text file) _at creation_ to Solr server. +- Add an owner filter to solr documents so each user search in its own library. +- Solr documents are created and destroyed when the original file is uploaded/deleted. +- Use the Solr server when using the searchbox in the files App of your nextcloud. + +What it does right now and should not: +- display results behind an element so it can't be clicked. + +What it should do in the future: +- documents should be kept on the Solt while the original file is still in the trashbin. +- testing your setup from the administration page +- extract files with an ./occ command +- extract more format (docx, pdf, ...) +- link to the right file when searching +- have a better display and a better indexing of the results + + + +## Installation +# THIS IS ALPHA - DO NOT USE IN PRODUCTION ENVIRONMENT + +- Download the .zip, unzip and place this app in **nextcloud/apps/**, +- Build the app, +- Enable the app in the app list, +- Few setup in the administration page. + +(You will also need an apache Solr server running somewhere, with Solr-Cell plugins.) + +- install the solr on debian-like + + # apt-get install solr-tomcat7 + +- Verify the version you just installed (3.6.2 on Jessie) + + # apt-cache showpkg solr-tomcat7 + +- Download the plugins for your version, and finish the installation using this [documentation](https://wiki.debian.org/Solr) +- Edit the config file and add those line inside the <fields></fields> stuff: + + <field name="nextant_owner" type="text_general" indexed="true" stored="true"/> + <field name="nextant_deleted" type="boolean" indexed="true" stored="true"/> + <field name="nextant_shared" type="boolean" indexed="true" stored="true"/> + <field name="nextant_sharing" type="text_general" indexed="true" stored="true" multiValued="true"/> + + +## 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
\ No newline at end of file diff --git a/appinfo/app.php b/appinfo/app.php new file mode 100644 index 0000000..5a6584f --- /dev/null +++ b/appinfo/app.php @@ -0,0 +1,37 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\AppInfo; + +require_once __DIR__ . '/autoload.php'; + +$app = new \OCA\Nextant\AppInfo\Application(); +// $app->registerNavigation(); +$app->registerFilesHooks(); +$app->registerDatabase(); +$app->registerSettingsAdmin(); + +$app->registerSearchEngine(); diff --git a/appinfo/autoload.php b/appinfo/autoload.php new file mode 100644 index 0000000..a097949 --- /dev/null +++ b/appinfo/autoload.php @@ -0,0 +1,43 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\AppInfo; + +/** + * Additional autoloader registration, e.g. + * registering composer autoloaders + */ +$composerInstalled = false; +// $solariumInstalled = false; +$composerDir = __DIR__ . '/../vendor/'; +if (is_dir($composerDir) && file_exists($composerDir . 'autoload.php')) { + require_once $composerDir . 'autoload.php'; + $composerInstalled = true; +} + +//if (! $composerInstalled) { +// $app->getContainer ()->query ( 'MiscService' )->log ( 'You\'ll need to build this apps. Please check documentation', 2 ); +//}
\ No newline at end of file diff --git a/appinfo/database-disabled.xml b/appinfo/database-disabled.xml new file mode 100644 index 0000000..36f8c07 --- /dev/null +++ b/appinfo/database-disabled.xml @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="ISO-8859-1" ?> +<database> + <name>*dbname*</name> + <create>true</create> + <overwrite>false</overwrite> + <charset>utf8</charset> + + <table> + <name>*dbprefix*nextant_index</name> + <declaration> + <field> + <name>fileid</name> + <type>integer</type> + <default>0</default> + <notnull>true</notnull> + <length>4</length> + </field> + <field> + <name>clef</name> + <type>text</type> + <notnull>true</notnull> + <length>64</length> + </field> + <field> + <name>creation</name> + <type>timestamp</type> + <default></default> + <notnull>false</notnull> + </field> + <index> + <name>nextant_clef</name> + <unique>true</unique> + <field> + <name>fileid</name> + <name>clef</name> + </field> + </index> + </declaration> + </table> +</database>
\ No newline at end of file diff --git a/appinfo/info.xml b/appinfo/info.xml new file mode 100644 index 0000000..1a38265 --- /dev/null +++ b/appinfo/info.xml @@ -0,0 +1,21 @@ +<?xml version="1.0"?> +<info xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:noNamespaceSchemaLocation="https://apps.nextcloud.com/schema/apps/info.xsd"> + <id>nextant</id> + <name>Nextant</name> + <summary>Navigate through your cloud using Solr</summary> + <description>Navigate through your cloud using Solr</description> + <version>0.0.4</version> + <licence>agpl</licence> + <author mail="maxence@pontapreta.net">Maxence Lange</author> + <types> + <filesystem /> + </types> + <category>tools</category> + <category>files</category> + <dependencies> + <database>mysql</database> + <owncloud min-version="9.1" /> + <nextcloud min-version="10" max-version="11" /> + </dependencies> +</info>
\ No newline at end of file diff --git a/appinfo/register_command.php b/appinfo/register_command.php new file mode 100644 index 0000000..7f6ed7c --- /dev/null +++ b/appinfo/register_command.php @@ -0,0 +1,27 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +$application->add(new OCA\Nextant\Command\Scan()); diff --git a/appinfo/routes.php b/appinfo/routes.php new file mode 100644 index 0000000..f63b425 --- /dev/null +++ b/appinfo/routes.php @@ -0,0 +1,44 @@ +<?php +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +return [ + 'routes' => [ + [ + 'name' => 'settings#setSettings', + 'url' => 'ajax/settings/admin.php', + 'verb' => 'POST' + ] + ] +]; + +/* + * This route is now useless. It was used with navigate.js + SearchController + * We are now using SearchProvider. + */ +// [ +// 'name' => 'search#searchRequest', +// 'url' => 'ajax/search.php', +// 'verb' => 'POST' +// ] diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..3b22fd8 --- /dev/null +++ b/composer.json @@ -0,0 +1,5 @@ +{ + "require": { + "solarium/solarium": "^3.6" + } +} diff --git a/composer.lock b/composer.lock new file mode 100644 index 0000000..3e274e2 --- /dev/null +++ b/composer.lock @@ -0,0 +1,133 @@ +{ + "_readme": [ + "This file locks the dependencies of your project to a known state", + "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", + "This file is @generated automatically" + ], + "hash": "f8e24a9ec8a28407e6b5acac57611280", + "content-hash": "8c906bea3faefecaf662cc044d0f46dd", + "packages": [ + { + "name": "solarium/solarium", + "version": "3.6.0", + "source": { + "type": "git", + "url": "https://github.com/solariumphp/solarium.git", + "reference": "b945cbe4e8f96b639d82c4d1e2cae4ef3ab6fce5" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/solariumphp/solarium/zipball/b945cbe4e8f96b639d82c4d1e2cae4ef3ab6fce5", + "reference": "b945cbe4e8f96b639d82c4d1e2cae4ef3ab6fce5", + "shasum": "" + }, + "require": { + "php": ">=5.3.2", + "symfony/event-dispatcher": "~2.3|~3.0" + }, + "require-dev": { + "phpunit/phpunit": "~3.7", + "satooshi/php-coveralls": "~1.0", + "squizlabs/php_codesniffer": "~1.4", + "zendframework/zendframework1": "~1.12" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-develop": "3.3.x-dev" + } + }, + "autoload": { + "psr-0": { + "Solarium\\": "library/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "See GitHub contributors", + "homepage": "https://github.com/basdenooijer/solarium/contributors" + } + ], + "description": "PHP Solr client", + "homepage": "http://www.solarium-project.org", + "keywords": [ + "php", + "search", + "solr" + ], + "time": "2016-05-03 07:08:49" + }, + { + "name": "symfony/event-dispatcher", + "version": "v3.1.3", + "source": { + "type": "git", + "url": "https://github.com/symfony/event-dispatcher.git", + "reference": "c0c00c80b3a69132c4e55c3e7db32b4a387615e5" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/c0c00c80b3a69132c4e55c3e7db32b4a387615e5", + "reference": "c0c00c80b3a69132c4e55c3e7db32b4a387615e5", + "shasum": "" + }, + "require": { + "php": ">=5.5.9" + }, + "require-dev": { + "psr/log": "~1.0", + "symfony/config": "~2.8|~3.0", + "symfony/dependency-injection": "~2.8|~3.0", + "symfony/expression-language": "~2.8|~3.0", + "symfony/stopwatch": "~2.8|~3.0" + }, + "suggest": { + "symfony/dependency-injection": "", + "symfony/http-kernel": "" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.1-dev" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Component\\EventDispatcher\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony EventDispatcher Component", + "homepage": "https://symfony.com", + "time": "2016-07-19 10:45:57" + } + ], + "packages-dev": [], + "aliases": [], + "minimum-stability": "stable", + "stability-flags": [], + "prefer-stable": false, + "prefer-lowest": false, + "platform": [], + "platform-dev": [] +} diff --git a/img/app.svg b/img/app.svg new file mode 100644 index 0000000..4c8bb1b --- /dev/null +++ b/img/app.svg @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns="http://www.w3.org/2000/svg" height="32" width="32" version="1.1" xmlns:cc="http://creativecommons.org/ns#" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/"> + <g transform="translate(573.14 110.3)" fill-rule="evenodd"> + <path d="m-570.22-108.3c-0.50115 0-0.92082 0.41966-0.92082 0.92081v24.158c0 0.51739 0.40324 0.92073 0.92082 0.92073h26.158c0.51756 0 0.92081-0.40316 0.92081-0.92073l0.00069-14.154c0-0.5011-0.41966-0.92524-0.92081-0.92524h-21.079l-0.0007 11.005c0 0.48012-0.52409 0.97706-1.0042 0.97706-0.48012 0-0.99573-0.49694-0.99573-0.97706l0.0007-12.143c0-0.48012 0.40484-0.86215 0.88497-0.86215h4.5944l14.521 0.00052-0.0007-2.9516c0-0.56713-0.42551-1.0481-0.99245-1.0481h-13.007v-3.0791c0-0.50118-0.40586-0.92081-0.90701-0.92081z"/> + <path d="m-570.22-107.3c-0.50115 0-0.92082 0.41966-0.92082 0.92081v24.158c0 0.51739 0.40324 0.92073 0.92082 0.92073h26.158c0.51756 0 0.92081-0.40316 0.92081-0.92073l0.00069-14.154c0-0.5011-0.41966-0.92524-0.92081-0.92524h-21.079l-0.0007 11.005c0 0.48012-0.52409 0.97706-1.0042 0.97706-0.48012 0-0.99573-0.49694-0.99573-0.97706l0.0007-12.143c0-0.48012 0.40484-0.86214 0.88497-0.86214h4.5944l14.521 0.00052-0.0007-2.9516c0-0.56713-0.42551-1.0481-0.99245-1.0481h-13.007v-3.0791c0-0.50118-0.40586-0.92081-0.90701-0.92081z" fill="#fff"/> + </g> +</svg>
\ No newline at end of file diff --git a/js/navigate.js b/js/navigate.js new file mode 100644 index 0000000..479cb96 --- /dev/null +++ b/js/navigate.js @@ -0,0 +1,77 @@ +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ + +/******************************************************************************* + * This script is now Useless - It is not even loaded. + ******************************************************************************/ +$(document).ready( + function() { + + var nextantCurrentSearch = ''; + var nextant = { + init : function() { + console.log('nextant/init'); + $('#searchbox').bind('input', function() { + setTimeout(function() { + nextant.search($('#searchbox').val()); + }, 1000); + }); + }, + + search : function(string) { + + if (string == nextantCurrentSearch) + return; + nextantCurrentSearch = string; + + request = { + search : string + } + + console.log('nextant/search: ' + request.search); + nextant.searchRequest(request); + }, + + searchRequest : function(request) { + console.log('nextant/searchRequest: ' + request.search) + $.post(OC.filePath('nextant', 'ajax', 'search.php'), + request, nextant.searchResult); + }, + + searchResult : function(response) { + console.log('nextant/searchResult: ' + response.message + + ' size: ' + response.data.length); + + // OC.search.resultTypes.lucene = t('search_lucene', 'In'); + + // OC.search.customResults.lucene = function ($row, item){ + // $row.find('td.result .text').text(t('search_lucene', + // 'Score: {score}', {score: + // Math.round(item.score*100)/100})); + } + }; + + nextant.init(); + }); diff --git a/js/settings.admin.js b/js/settings.admin.js new file mode 100644 index 0000000..0164615 --- /dev/null +++ b/js/settings.admin.js @@ -0,0 +1,52 @@ +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +$(document).ready( + function() { + + var nextantSettings = { + save : function() { + $('#nextant_apply').attr('disabled', true); + var data = { + solr_url : $('#solr_url').val() + }; + + OC.msg.startAction('#nextant-admin-msg', t('nextant', + 'Saving...')); + $.post( + OC + .filePath('nextant', 'ajax/settings', + 'admin.php'), data, + nextantSettings.saved); + + }, + saved : function(response) { + $('#docs_apply').attr('disabled', false); + OC.msg.finishedAction('#nextant-admin-msg', response); + } + + }; + + $('#nextant_apply').on('click', nextantSettings.save); + }); diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php new file mode 100644 index 0000000..5d20274 --- /dev/null +++ b/lib/AppInfo/Application.php @@ -0,0 +1,215 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\AppInfo; + +use \OCA\Nextant\Controller\SettingsController; +use \OCA\Nextant\Db\IndexMapper; +use \OCA\Nextant\Events\FilesEvents; +use \OCA\Nextant\Hooks\FilesHooks; +use \OCA\Nextant\Provider\SearchProvider; +use \OCA\Nextant\Service\ConfigService; +use \OCA\Nextant\Service\MiscService; +use \OCA\Nextant\Service\FileService; +use \OCA\Nextant\Service\SolrService; +use OCP\AppFramework\App; +use OCP\Util; +use Solarium\Solarium; + +class Application extends App +{ + + private $registeredDatabase = false; + + /** + * + * @param array $params + */ + public function __construct(array $params = array()) + { + parent::__construct('nextant', $params); + $container = $this->getContainer(); + + /** + * Controllers + */ + $container->registerService('MiscService', function ($c) { + return new MiscService($c->query('Logger'), $c->query('AppName')); + }); + + $container->registerService('ConfigService', function ($c) { + return new ConfigService($c->query('AppName'), $c->query('CoreConfig')); + }); + + $container->registerService('FileService', function ($c) { + return new FileService($c->query('Root')); + }); + + $container->registerService('SolrService', function ($c) { + return new SolrService($c->query('SolariumClient'), $c->query('MiscService')); + }); + + $container->registerService('IndexMapper', function ($c) { + return new IndexMapper($c->query('ServerContainer') + ->getDb()); + }); + + $container->registerService('FilesEvents', function ($c) { + return new FilesEvents($c->query('UserId'), $c->query('FileService'), $c->query('SolrService'), $c->query('MiscService')); + }); + + // $container->query('IndexMapper')->insert(new IndexEntity(array(userid => 2, 'path' => '/toto', 'clef' => 'CLEFCLEF'))); + + // SearchController is now useless + // $container->registerService('SearchController', function ($c) { + // return new SearchController($c->query('AppName'), $c->query('Request'), $c->query('ConfigService'), $c->query('UserId'), $c->query('MiscService')); + // }); + + $container->registerService('SettingsController', function ($c) { + return new SettingsController($c->query('AppName'), $c->query('Request'), $c->query('ConfigService'), $c->query('UserId')); + }); + + /** + * Providers + */ + // Registering the SearchProvider as a Service seems useless. + // $container->registerService('SearchProvider', function ($c) { + // return new SearchProvider($c->query('MiscService')); + // }); + + /** + * Core + */ + $container->registerService('Logger', function ($c) { + return $c->query('ServerContainer') + ->getLogger(); + }); + $container->registerService('CoreConfig', function ($c) { + return $c->query('ServerContainer') + ->getConfig(); + }); + $container->registerService('UserId', function ($c) { + $user = $c->query('ServerContainer') + ->getUserSession() + ->getUser(); + return is_null($user) ? '' : $user->getUID(); + }); + + // \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data'); + // $container->query('MiscService')->log('root: ' . $root, 2); + $container->registerService('Root', function ($c) { + return \OC::$server->getSystemConfig() + ->getValue('datadirectory', \OC::$SERVERROOT . '/data'); + }); + } + + public function registerFilesHooks() + { + // not working: post_unshare + Util::connectHook('OC_Filesystem', 'post_create', '\OCA\Nextant\Hooks\FilesHooks', 'fileCreated'); + Util::connectHook('OC_Filesystem', 'post_update', '\OCA\Nextant\Hooks\FilesHooks', 'fileUpdated'); + // Util::connectHook('OC_Filesystem', 'post_rename', '\OCA\Nextant\Hooks\FilesHooks', 'fileRenamed'); + Util::connectHook('OC_Filesystem', 'post_delete', '\OCA\Nextant\Hooks\FilesHooks', 'fileDeleted'); + Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', '\OCA\Nextant\Hooks\FilesHooks', 'fileRestored'); + // Util::connectHook('OCP\Share', 'post_shared', '\OCA\Nextant\Hooks\FilesHooks', 'fileShared'); + // Util::connectHook('OCP\Share', 'post_unshare', '\OCA\Nextant\Hooks\FilesHooks', 'fileUnshared'); + // Util::connectHook('\OC\Files\Cache\Scanner', 'scan_file', '\OCA\Nextant\Hooks\FilesHooks', 'fileScanned'); + } + + public function registerDatabase() + { + if ($this->registeredDatabase) + return; + + $this->registeredDatabase = true; + } + + public function registerSearchEngine() + { + $this->registerDatabase(); + + // Script is now useless + // \OCP\Util::addScript('nextant', 'navigate'); + + // Old registration + // \OC::$server->getSearch()->registerProvider($this->getContainer()->query('SearchProvider'), array( + + // Because we don't register the SearchProvider, let's call it throw its direct path. + \OC::$server->getSearch()->registerProvider('OCA\Nextant\Provider\SearchProvider', array( + 'apps' => array( + 'files' + ) + )); + + $this->getContainer()->registerService('SolariumClient', function ($c) { + return new \Solarium\Client($c->query('ConfigService') + ->toSolarium()); + }); + + // Uncomment this to do a quick test on loading + // $this->testExtract(); + } + + public function registerSettingsAdmin() + { + \OCP\App::registerAdmin($this->getContainer()->query('AppName'), 'settings/admin'); + } + + // public function registerNavigation() + // { + // $appName = $this->getContainer()->getAppName(); + // $server = $this->getContainer()->getServer(); + + // $this->getContainer() + // ->query('MiscService') + // ->log('registerNavigation()', 2); + // $server->getNavigationManager()->add(array( + // 'id' => $appName, + // 'order' => 5, + // 'href' => $server->getURLGenerator() + // ->linkToRoute('nextant.page.index'), + // 'icon' => $server->getURLGenerator() + // ->imagePath($appName, 'app.svg'), + // 'name' => $server->getL10N($appName) + // ->t('Nextant') + // )); + // } + + /** + * This is alpha, and this is a simple test using the LICENSE file (because, why not) + */ + public function testExtract() + { + $this->getContainer() + ->query('SolrService') + ->setOwner($this->getContainer() + ->query('UserId')); + $this->getContainer() + ->query('SolrService') + ->extractSimpleTextFile(__DIR__ . '/../../LICENSE', '__test'); + } +} + diff --git a/lib/Command/Scan.php b/lib/Command/Scan.php new file mode 100644 index 0000000..382a8e4 --- /dev/null +++ b/lib/Command/Scan.php @@ -0,0 +1,52 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Command; + +use OC\Core\Command\Base; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; + +class Scan extends Base +{ + + public function __construct() + { + parent::__construct(); + } + + protected function configure() + { + $this->setName('nextant:scan')->setDescription('extract text files and generate solr documents'); + } + + protected function execute(InputInterface $input, OutputInterface $output) + { + $output->writeln("Scanning is not yet available"); + } +} diff --git a/lib/Controller/SearchController.php b/lib/Controller/SearchController.php new file mode 100644 index 0000000..898b438 --- /dev/null +++ b/lib/Controller/SearchController.php @@ -0,0 +1,70 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ + +/***** + * This Controller is now useless + ****/ +/* +namespace OCA\Nextant\Controller; + +use OCP\AppFramework\Controller; +use OCP\IRequest; +use \OCA\Nextant\Service\ConfigService; + +class SearchController extends Controller +{ + + private $appConfig; + + private $userId; + + private $miscService; + + public function __construct($appName, IRequest $request, AppConfig $appConfig, $userId, $miscService) + { + parent::__construct($appName, $request); + $this->userId = $userId; + $this->appConfig = $appConfig; + $this->miscService = $miscService; + } + + public function searchRequest($search) + { + $this->miscService->log('searchString() - ' . $search); + + $result = array(); + + $response = array( + 'status' => 'success', + 'message' => 'OK_OK', + 'data' => $result + ); + + return $response; + } +} +*/
\ No newline at end of file diff --git a/lib/Controller/SettingsController.php b/lib/Controller/SettingsController.php new file mode 100644 index 0000000..42d1324 --- /dev/null +++ b/lib/Controller/SettingsController.php @@ -0,0 +1,74 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Controller; + +use OCP\AppFramework\Controller; +use OCP\AppFramework\Http\TemplateResponse; +use OCP\IRequest; +use \OCA\Nextant\Service\ConfigService; + +class SettingsController extends Controller +{ + + private $appConfig; + + private $userId; + + public function __construct($appName, IRequest $request, ConfigService $appConfig, $userId) + { + parent::__construct($appName, $request); + $this->userId = $userId; + $this->appConfig = $appConfig; + } + + /** + * @NoCSRFRequired + */ + public function index() + { + $params = [ + 'solr_url' => $this->appConfig->getAppValue('solr_url') + ]; + return new TemplateResponse($this->appName, 'settings.admin', $params, 'blank'); + } + + public function setSettings($solr_url) + { + if (! is_null($solr_url)) { + $this->appConfig->setAppValue('solr_url', $solr_url); + } + + $response = array( + 'status' => 'success', + 'data' => array( + 'message' => 'Saved' + ) + ); + + return $response; + } +}
\ No newline at end of file diff --git a/lib/Db/Index.php b/lib/Db/Index.php new file mode 100644 index 0000000..6371fc6 --- /dev/null +++ b/lib/Db/Index.php @@ -0,0 +1,62 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +// namespace OCA\Nextant\Db; + +// +// We're not using a database yet. +// + +// use OCP\AppFramework\Db\Entity; + +// class Index extends Entity +// { + +// public $id; + +// // public $userid; + +// public $clef; + +// // public $path; + +// public $creation; + +// public function __construct(array $params = []) +// { +// $this->addType('id', 'integer'); + +// if (key_exists('id', $params)) +// $this->setId($params['id']); + +// if (key_exists('clef', $params)) +// $this->setClef($params['clef']); + +// if (key_exists('creation', $params)) +// $this->setCreation($params['creation']); +// } +// } + diff --git a/lib/Db/IndexMapper.php b/lib/Db/IndexMapper.php new file mode 100644 index 0000000..304e854 --- /dev/null +++ b/lib/Db/IndexMapper.php @@ -0,0 +1,60 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +// namespace OCA\Nextant\Db; + +// use OCP\IDBConnection; +// use OCP\AppFramework\Db\Mapper; + +// class IndexMapper extends Mapper +// { + +// const TABLENAME = 'nextant_index'; + +// public function __construct(IDBConnection $db) +// { +// parent::__construct($db, self::TABLENAME); +// } + +// public function find($id) +// { +// $sql = 'SELECT * FROM *PREFIX*' . self::TABLENAME . ' WHERE id = ?'; +// return $this->findEntity($sql, [ +// $id +// ]); +// } + +// public function findByKey($clef) +// { +// $sql = 'SELECT * FROM *PREFIX*' . self::TABLENAME . ' WHERE clef = ?'; +// return $this->findEntity($sql, [ +// $clef +// ]); +// } + + +// } + diff --git a/lib/Events/FilesEvents.php b/lib/Events/FilesEvents.php new file mode 100644 index 0000000..90f69e8 --- /dev/null +++ b/lib/Events/FilesEvents.php @@ -0,0 +1,141 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Events; + +use \OCA\Nextant\Service\FileService; +use \OCA\Nextant\Service\MiscService; +use Solarium\Solarium; + +class FilesEvents +{ + + private $fileService; + + private $solrService; + + private $miscService; + + public function __construct($userId, $fileService, $solrService, $miscService) + { + $this->userId = $userId; + $this->fileService = $fileService; + $this->solrService = $solrService; + $this->miscService = $miscService; + + $this->solrService->setOwner($this->userId); + } + + /** + * onFileCreate() + * + * @param string $path + */ + public function onFileCreate($path) + { + $absolutePath = $this->fileService->getRoot() . FileService::getAbsolutePath($path); + // $this->miscService->log('A file has been created: ' . $absolutePath . ' (' . FileService::getId($path) . ')', 2); + + $solrResult = $this->solrService->extractSimpleTextFile($absolutePath, FileService::getId($path)); + // $this->miscService->log('Solr Status: ' . $solrResult->getStatus() . ', Time: ' . $solrResult->getQueryTime(), 2); + } + + /** + * onFileUpdate() + * + * @param string $path + */ + public function onFileUpdate($path) + { + $absolutePath = $this->fileService->getRoot() . FileService::getAbsolutePath($path); + // $this->miscService->log('A file has been updated: ' . $absolutePath . ' (' . FileService::getId($path) . ')', 2); + + $solrResult = $this->solrService->extractSimpleTextFile($absolutePath, FileService::getId($path)); + // $this->miscService->log('Solr Status: ' . $solrResult['status'] . ', Time: ' . $solrResult['time'], 2); + } + + /** + * onFileRename() + * + * @param string $path + */ + public function onFileRename($source, $target) + { + // $this->miscService->log('A file has been renamed: ' . FileService::getId($target), 2); + } + + /** + * onFileDelete() + * + * @param string $path + */ + public function onFileDelete($path) + { + // $path incorrect + $this->miscService->log('A file has been deleted: ' . FileService::getId($path), 2); + } + + /** + * onFileRestore + * + * @param string $path + */ + public function onFileRestore($path) + { + $this->miscService->log('A file has been restored: ' . FileService::getId($path), 2); + } + + /** + * onFileShare + * + * @param string $path + */ + public function onFileShare($item, $file) + { + $this->miscService->log('A file has been shared: ' . $item . ', ' . $file, 2); + } + + /** + * onFileUnshare + * + * @param string $path + */ + public function onFileUnshare($path) + { + $this->miscService->log('A file has been unshared: ' . $path, 2); + } + + /** + * onFileScan + * + * @param string $path + */ + public function onFileScan($path) + { + $this->miscService->log('A file has been scanned: ' . $path, 2); + } +} + diff --git a/lib/Hooks/FilesHooks.php b/lib/Hooks/FilesHooks.php new file mode 100644 index 0000000..227b2dd --- /dev/null +++ b/lib/Hooks/FilesHooks.php @@ -0,0 +1,127 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Hooks; + + +/** + * init Files' Events + */ +class FilesHooks +{ + + /** + * retreive the FilesEvents' Controller + * + * @return FilesHooks + */ + static protected function getController() + { + $app = new \OCA\Nextant\AppInfo\Application(); + $app->registerSearchEngine(); + return $app->getContainer()->query('FilesEvents'); + } + + /** + * hook events: file is created + * + * @param array $params + * The hook params + */ + public static function fileCreated($params) + { + self::getController()->onFileCreate($params['path']); + } + + /** + * hook events: file is updated + * + * @param array $params + */ + public static function fileUpdated($params) + { + self::getController()->onFileUpdate($params['path']); + } + + /** + * hook events: file is renamed + * + * @param array $params + */ + public static function fileRenamed($params) + { + self::getController()->onFileRename($params['oldpath'], $params['newpath']); + } + + /** + * hook event: file is deleted + * + * @param array $params + */ + public static function fileDeleted($params) + { + self::getController()->onFileDelete($params['path']); + } + + /** + * hook event: file is restored + * + * @param array $params + */ + public static function fileRestored($params) + { + self::getController()->onFileRestore($params['filePath']); + } + + /** + * hook event: file is shared + * + * @param array $params + */ + public static function fileShared($params) + { + self::getController()->onFileShare($params['itemTarget'], $params['fileTarget']); + } + + /** + * hook event: file is unshared + * + * @param array $params + */ + public static function fileUnshared($params) + { + self::getController()->onFileUnshare($params['path']); + } + + /** + * hook event: file is scanned + */ + public static function fileScanned($params) + { + self::getController()->onFileScan($params['path']); + } +} + diff --git a/lib/Provider/SearchProvider.php b/lib/Provider/SearchProvider.php new file mode 100644 index 0000000..d0eba89 --- /dev/null +++ b/lib/Provider/SearchProvider.php @@ -0,0 +1,80 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Provider; + +use OCP\Search\Provider; + +class SearchProvider extends Provider +{ + + private $app; + + private $miscService; + + private $solrService; + + private $userId; + + public function __construct() + { + $app = new \OCA\Nextant\AppInfo\Application(); + $container = $app->getContainer(); + $app->registerSearchEngine(); + + $this->app = $app; + $this->miscService = $container->query('MiscService'); + $this->solrService = $container->query('SolrService'); + $this->userId = $container->query('UserId'); + $this->solrService->setOwner($this->userId); + } + + /** + * performs a search + * + * @param string $query + * @return array + * + */ + public function search($query) + { + $results = array(); + if ($query !== null) { + + $solrResult = $this->solrService->search($query); + foreach ($solrResult as $data) { + $results[] = array( + 'id' => $data['id'], + 'name' => 'NAME' . $data['id'], + 'link' => 'LINK' . $data['id'], + 'type' => 'text' + ); + } + } + + return $results; + } +}
\ No newline at end of file diff --git a/lib/Service/ConfigService.php b/lib/Service/ConfigService.php new file mode 100644 index 0000000..9e792dc --- /dev/null +++ b/lib/Service/ConfigService.php @@ -0,0 +1,92 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Service; + +use OCP\IConfig; + +class ConfigService +{ + + private $defaults = [ + 'solr_url' => 'http://127.0.0.1:8080/solr/' + ]; + + private $appName; + + private $config; + + public function __construct($appName, IConfig $config) + { + $this->appName = $appName; + $this->config = $config; + } + + /** + * Get a value by key + * + * @param string $key + * @return string + */ + public function getAppValue($key) + { + $defaultValue = null; + if (array_key_exists($key, $this->defaults)) + $defaultValue = $this->defaults[$key]; + return $this->config->getAppValue($this->appName, $key, $defaultValue); + } + + /** + * Set a value by key + * + * @param string $key + * @param string $value + * @return string + */ + public function setAppValue($key, $value) + { + return $this->config->setAppValue($this->appName, $key, $value); + } + + /** + * generate an array to pass config to Solarium + * + * @return array + */ + public function toSolarium() + { + $t = parse_url($this->getAppValue('solr_url')); + return array( + 'endpoint' => array( + 'localhost' => array( + 'host' => $t['host'], + 'port' => $t['port'], + 'path' => $t['path'] + ) + ) + ); + } +}
\ No newline at end of file diff --git a/lib/Service/FileService.php b/lib/Service/FileService.php new file mode 100644 index 0000000..9119704 --- /dev/null +++ b/lib/Service/FileService.php @@ -0,0 +1,74 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Service; + +use OC\Files\Filesystem; +use OC\Files\View; + +class FileService +{ + + private $root; + + public function __construct($root) + { + $this->root = $root; + } + + public function getRoot() + { + return $this->root; + } + + public static function getId($path) + { + $fileId = 0; + $info = Filesystem::getFileInfo($path); + if ($info !== false) + $fileId = (int) $info['fileid']; + return $fileId; + } + + public static function getPath($id, $absolute = false) + { + try { + $view = Filesystem::getView(); + if ($absolute) + return $view->getAbsolutePath($view->getPath($id)); + else + return $view->getPath($id); + } catch (NotFoundException $e) { + throw new NotFoundException('File with id ' . $id . ' not found'); + } + } + + public static function getAbsolutePath($path, $root = false) + { + $view = Filesystem::getView(); + return $view->getAbsolutePath($path); + } +}
\ No newline at end of file diff --git a/lib/Service/MiscService.php b/lib/Service/MiscService.php new file mode 100644 index 0000000..84bb1b3 --- /dev/null +++ b/lib/Service/MiscService.php @@ -0,0 +1,53 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Service; + +use OCP\ILogger; + +class MiscService +{ + + private $logger; + + private $appName; + + public function __construct(ILogger $logger, $appName) + { + $this->logger = $logger; + $this->appName = $appName; + } + + public function log($message, $level = 2) + { + $data = array( + 'app' => $this->appName, + 'level' => $level + ); + + $this->logger->log($level, $message, $data); + } +}
\ No newline at end of file diff --git a/lib/Service/SolrService.php b/lib/Service/SolrService.php new file mode 100644 index 0000000..f61a624 --- /dev/null +++ b/lib/Service/SolrService.php @@ -0,0 +1,105 @@ +<?php +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Service; + +// use Solarium\Solarium; +class SolrService +{ + + private $solariumClient; + + private $miscService; + + private $owner = ''; + + public function __construct($client, $miscService) + { + $this->solariumClient = $client; + $this->miscService = $miscService; + } + + public function setOwner($owner) + { + $this->owner = $owner; + } + + /** + * extract a simple text file. + * This function should only be use for testing. + * + * @param string $path + */ + public function extractSimpleTextFile($path, $docid) + { + if ($this->owner == '') + return; + + $client = $this->solariumClient; + + $query = $client->createExtract(); + $query->addFieldMapping('content', 'text'); + $query->setUprefix('attr_'); + $query->setFile($path); + $query->setCommit(true); + $query->setOmitHeader(false); + + // add document + $doc = $query->createDocument(); + $doc->id = $docid; + $doc->nextant_owner = $this->owner; + $query->setDocument($doc); + + return $client->extract($query); + } + + public function ping() + { + // We should ping and test the new setup + } + + public function search($string) + { + if ($this->owner == '') + return; + + $client = $this->solariumClient; + $query = $client->createSelect(); + $query->setQuery($string); + $query->createFilterQuery('owner')->setQuery('nextant_owner:' . $this->owner); + + $resultset = $client->select($query); + + $return = array(); + foreach ($resultset as $document) { + array_push($return, array( + 'id' => $document->id + )); + } + + return $return; + } +} +
\ No newline at end of file diff --git a/phpunit.integration.xml b/phpunit.integration.xml new file mode 100644 index 0000000..32cba8a --- /dev/null +++ b/phpunit.integration.xml @@ -0,0 +1,7 @@ +<phpunit bootstrap="tests/bootstrap.php" colors="true"> + <testsuites> + <testsuite name="integration"> + <directory>./tests/integration</directory> + </testsuite> + </testsuites> +</phpunit>
\ No newline at end of file diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..4eaab43 --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,7 @@ +<phpunit bootstrap="tests/bootstrap.php" colors="true"> + <testsuites> + <testsuite name="unit"> + <directory>./tests/unit</directory> + </testsuite> + </testsuites> +</phpunit>
\ No newline at end of file diff --git a/settings/admin.php b/settings/admin.php new file mode 100644 index 0000000..3da6ab0 --- /dev/null +++ b/settings/admin.php @@ -0,0 +1,34 @@ +<?php + +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +namespace OCA\Nextant\Settings; + +$app = new \OCA\Nextant\AppInfo\Application(); +$response = $app->getContainer() + ->query('\OCA\Nextant\Controller\SettingsController') + ->index(); + +return $response->render(); diff --git a/templates/settings.admin.php b/templates/settings.admin.php new file mode 100644 index 0000000..93df85e --- /dev/null +++ b/templates/settings.admin.php @@ -0,0 +1,38 @@ +<?php +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +script('nextant', 'settings.admin'); +?> +<div class="section" id="nextant"> + <h2><?php p($l->t('Nextant (Solr)')) ?></h2> + <label for="wopi_url"><?php p($l->t('Apache Solr server :')) ?></label> + <input type="text" name="solr_url" id="solr_url" + value="<?php p($_['solr_url'])?>" style="width: 300px;"> <br /> <em><?php p($l->t('URL:port/path of the Apache Solr server.')) ?></em> + <br /> + <button type="button" id="nextant_apply"><?php p($l->t('Apply')) ?></button> + <span id="nextant-admin-msg" class="msg"></span> +</div> + + diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..573a246 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,27 @@ +<?php +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +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..13822d6 --- /dev/null +++ b/tests/integration/AppTest.php @@ -0,0 +1,52 @@ +<?php +/** + * Nextcloud - nextant + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@pontapreta.net> + * @copyright Maxence Lange 2016 + * @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 <http://www.gnu.org/licenses/>. + * + */ +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('nextant'); + $this->container = $app->getContainer(); + } + + public function testAppInstalled() + { + $appManager = $this->container->query('OCP\App\IAppManager'); + $this->assertTrue($appManager->isInstalled('nextant')); + } +}
\ No newline at end of file |
