Morris Jobke
GitHub
commit
7025f16017
@ -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/>.
|
||||
@ -0,0 +1,2 @@
|
||||
# cloud_federation_api
|
||||
The cloud federation API allows to share information like files, contacts, calendars, incoming calls, etc accross Nextcloud instances
|
||||
@ -0,0 +1,22 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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/>.
|
||||
*
|
||||
*/
|
||||
|
||||
$app = new \OCA\CloudFederationAPI\AppInfo\Application();
|
||||
@ -0,0 +1,20 @@
|
||||
<?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>cloud_federation_api</id>
|
||||
<name>Cloud Federation API</name>
|
||||
<summary>Enable clouds to communicate with each other and exchange data</summary>
|
||||
<description>The Coud Federation API enabled various Nextcloud instances to communitcate with each other and to exchange data</description>
|
||||
<version>0.0.1</version>
|
||||
<licence>agpl</licence>
|
||||
<author>Bjoern Schiessle</author>
|
||||
<namespace>CloudFederationAPI</namespace>
|
||||
<types>
|
||||
<filesystem/>
|
||||
</types>
|
||||
<category>files</category>
|
||||
<bugs>https://github.com/nextcloud/cloud_federation/issues</bugs>
|
||||
<dependencies>
|
||||
<nextcloud min-version="14" max-version="14"/>
|
||||
</dependencies>
|
||||
</info>
|
||||
@ -0,0 +1,37 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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\CloudFederationAPI\AppInfo;
|
||||
|
||||
|
||||
use OCA\CloudFederationAPI\Capabilities;
|
||||
use OCP\AppFramework\App;
|
||||
|
||||
class Application extends App {
|
||||
|
||||
public function __construct() {
|
||||
parent::__construct('cloud_federation_api');
|
||||
|
||||
$container = $this->getContainer();
|
||||
$container->registerCapability(Capabilities::class);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,64 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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\CloudFederationAPI;
|
||||
|
||||
|
||||
use OCP\Capabilities\ICapability;
|
||||
use OCP\IURLGenerator;
|
||||
|
||||
class Capabilities implements ICapability {
|
||||
|
||||
/** @var IURLGenerator */
|
||||
private $urlGenerator;
|
||||
|
||||
public function __construct(IURLGenerator $urlGenerator) {
|
||||
$this->urlGenerator = $urlGenerator;
|
||||
}
|
||||
|
||||
/**
|
||||
* Function an app uses to return the capabilities
|
||||
*
|
||||
* @return array Array containing the apps capabilities
|
||||
* @since 8.2.0
|
||||
*/
|
||||
public function getCapabilities() {
|
||||
$url = $this->urlGenerator->linkToRouteAbsolute('cloud_federation_api.requesthandlercontroller.addShare');
|
||||
$capabilities = ['ocm' =>
|
||||
[
|
||||
'enabled' => true,
|
||||
'apiVersion' => '1.0-proposal1',
|
||||
'endPoint' => substr($url, 0, strrpos($url, '/')),
|
||||
'shareTypes' => [
|
||||
[
|
||||
'name' => 'file',
|
||||
'protocols' => [
|
||||
'webdav' => '/public.php/webdav/',
|
||||
]
|
||||
],
|
||||
]
|
||||
]
|
||||
];
|
||||
|
||||
return $capabilities;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,57 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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\CloudFederationAPI;
|
||||
use OCP\Federation\ICloudFederationProviderManager;
|
||||
use OCP\GlobalScale\IConfig as IGsConfig;
|
||||
use OCP\IConfig;
|
||||
|
||||
|
||||
/**
|
||||
* Class config
|
||||
*
|
||||
* handles all the config parameters
|
||||
*
|
||||
* @package OCA\CloudFederationAPI
|
||||
*/
|
||||
class Config {
|
||||
|
||||
/** @var ICloudFederationProviderManager */
|
||||
private $cloudFederationProviderManager;
|
||||
|
||||
public function __construct(ICloudFederationProviderManager $cloudFederationProviderManager) {
|
||||
$this->cloudFederationProviderManager = $cloudFederationProviderManager;
|
||||
}
|
||||
|
||||
/**
|
||||
* get a list of supported share types
|
||||
*
|
||||
* @param string $resourceType
|
||||
* @return array
|
||||
* @throws \OCP\Federation\Exceptions\ProviderDoesNotExistsException
|
||||
*/
|
||||
public function getSupportedShareTypes($resourceType) {
|
||||
$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
|
||||
return $provider->getSupportedShareTypes();
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,275 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @author Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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\CloudFederationAPI\Controller;
|
||||
|
||||
use OCA\CloudFederationAPI\Config;
|
||||
use OCP\AppFramework\Controller;
|
||||
use OCP\AppFramework\Http;
|
||||
use OCP\AppFramework\Http\JSONResponse;
|
||||
use OCP\Federation\Exceptions\ActionNotSupportedException;
|
||||
use OCP\Federation\Exceptions\AuthenticationFailedException;
|
||||
use OCP\Federation\Exceptions\BadRequestException;
|
||||
use OCP\Federation\Exceptions\ProviderCouldNotAddShareException;
|
||||
use OCP\Federation\ICloudFederationFactory;
|
||||
use OCP\Federation\ICloudFederationProviderManager;
|
||||
use OCP\Federation\Exceptions\ProviderDoesNotExistsException;
|
||||
use OCP\Federation\ICloudIdManager;
|
||||
use OCP\ILogger;
|
||||
use OCP\IRequest;
|
||||
use OCP\IURLGenerator;
|
||||
use OCP\IUserManager;
|
||||
use OCP\Share\Exceptions\ShareNotFound;
|
||||
|
||||
|
||||
/**
|
||||
* Class RequestHandlerController
|
||||
*
|
||||
* handle API between different Cloud instances
|
||||
*
|
||||
* @package OCA\CloudFederationAPI\Controller
|
||||
*/
|
||||
class RequestHandlerController extends Controller {
|
||||
|
||||
/** @var ILogger */
|
||||
private $logger;
|
||||
|
||||
/** @var IUserManager */
|
||||
private $userManager;
|
||||
|
||||
/** @var IURLGenerator */
|
||||
private $urlGenerator;
|
||||
|
||||
/** @var ICloudFederationProviderManager */
|
||||
private $cloudFederationProviderManager;
|
||||
|
||||
/** @var Config */
|
||||
private $config;
|
||||
|
||||
/** @var ICloudFederationFactory */
|
||||
private $factory;
|
||||
|
||||
/** @var ICloudIdManager */
|
||||
private $cloudIdManager;
|
||||
|
||||
public function __construct($appName,
|
||||
IRequest $request,
|
||||
ILogger $logger,
|
||||
IUserManager $userManager,
|
||||
IURLGenerator $urlGenerator,
|
||||
ICloudFederationProviderManager $cloudFederationProviderManager,
|
||||
Config $config,
|
||||
ICloudFederationFactory $factory,
|
||||
ICloudIdManager $cloudIdManager
|
||||
) {
|
||||
parent::__construct($appName, $request);
|
||||
|
||||
$this->logger = $logger;
|
||||
$this->userManager = $userManager;
|
||||
$this->urlGenerator = $urlGenerator;
|
||||
$this->cloudFederationProviderManager = $cloudFederationProviderManager;
|
||||
$this->config = $config;
|
||||
$this->factory = $factory;
|
||||
$this->cloudIdManager = $cloudIdManager;
|
||||
}
|
||||
|
||||
/**
|
||||
* add share
|
||||
*
|
||||
* @NoCSRFRequired
|
||||
* @PublicPage
|
||||
* @BruteForceProtection(action=receiveFederatedShare)
|
||||
*
|
||||
* @param string $shareWith
|
||||
* @param string $name resource name (e.g. document.odt)
|
||||
* @param string $description share description (optional)
|
||||
* @param string $providerId resource UID on the provider side
|
||||
* @param string $owner provider specific UID of the user who owns the resource
|
||||
* @param string $ownerDisplayName display name of the user who shared the item
|
||||
* @param string $sharedBy provider specific UID of the user who shared the resource
|
||||
* @param string $sharedByDisplayName display name of the user who shared the resource
|
||||
* @param array $protocol (e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]])
|
||||
* @param string $shareType ('group' or 'user' share)
|
||||
* @param $resourceType ('file', 'calendar',...)
|
||||
* @return Http\DataResponse|JSONResponse
|
||||
*
|
||||
* Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
|
||||
*/
|
||||
public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
|
||||
|
||||
// check if all required parameters are set
|
||||
if ($shareWith === null ||
|
||||
$name === null ||
|
||||
$providerId === null ||
|
||||
$owner === null ||
|
||||
$resourceType === null ||
|
||||
$shareType === null ||
|
||||
!is_array($protocol) ||
|
||||
!isset($protocol['name']) ||
|
||||
!isset ($protocol['options']) ||
|
||||
!is_array($protocol['options']) ||
|
||||
!isset($protocol['options']['sharedSecret'])
|
||||
) {
|
||||
return new JSONResponse(
|
||||
['message' => 'Missing arguments'],
|
||||
Http::STATUS_BAD_REQUEST
|
||||
);
|
||||
}
|
||||
|
||||
$cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
|
||||
$shareWithLocalId = $cloudId->getUser();
|
||||
$shareWith = $this->mapUid($shareWithLocalId);
|
||||
|
||||
if (!$this->userManager->userExists($shareWith)) {
|
||||
return new JSONResponse(
|
||||
['message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl()],
|
||||
Http::STATUS_BAD_REQUEST
|
||||
);
|
||||
}
|
||||
|
||||
// if no explicit display name is given, we use the uid as display name
|
||||
$ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
|
||||
$sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
|
||||
|
||||
// sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
|
||||
if ($sharedBy === null) {
|
||||
$sharedBy = $owner;
|
||||
$sharedByDisplayName = $ownerDisplayName;
|
||||
}
|
||||
|
||||
try {
|
||||
$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
|
||||
$share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, '', $shareType, $resourceType);
|
||||
$share->setProtocol($protocol);
|
||||
$id = $provider->shareReceived($share);
|
||||
} catch (ProviderDoesNotExistsException $e) {
|
||||
return new JSONResponse(
|
||||
['message' => $e->getMessage()],
|
||||
Http::STATUS_NOT_IMPLEMENTED
|
||||
);
|
||||
} catch (ProviderCouldNotAddShareException $e) {
|
||||
return new JSONResponse(
|
||||
['message' => $e->getMessage()],
|
||||
$e->getCode()
|
||||
);
|
||||
} catch (\Exception $e) {
|
||||
return new JSONResponse(
|
||||
['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
|
||||
Http::STATUS_BAD_REQUEST
|
||||
);
|
||||
}
|
||||
|
||||
$user = $this->userManager->get($shareWithLocalId);
|
||||
$recipientDisplayName = '';
|
||||
if($user) {
|
||||
$recipientDisplayName = $user->getDisplayName();
|
||||
}
|
||||
|
||||
return new JSONResponse(
|
||||
['recipientDisplayName' => $recipientDisplayName],
|
||||
Http::STATUS_CREATED);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* receive notification about existing share
|
||||
*
|
||||
* @NoCSRFRequired
|
||||
* @PublicPage
|
||||
* @BruteForceProtection(action=receiveFederatedShareNotification)
|
||||
*
|
||||
* @param string $notificationType (notification type, e.g. SHARE_ACCEPTED)
|
||||
* @param string $resourceType (calendar, file, contact,...)
|
||||
* @param string $providerId id of the share
|
||||
* @param array $notification the actual payload of the notification
|
||||
* @return JSONResponse
|
||||
*/
|
||||
public function receiveNotification($notificationType, $resourceType, $providerId, array $notification) {
|
||||
|
||||
// check if all required parameters are set
|
||||
if ($notificationType === null ||
|
||||
$resourceType === null ||
|
||||
$providerId === null ||
|
||||
!is_array($notification)
|
||||
) {
|
||||
return new JSONResponse(
|
||||
['message' => 'Missing arguments'],
|
||||
Http::STATUS_BAD_REQUEST
|
||||
);
|
||||
}
|
||||
|
||||
try {
|
||||
$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
|
||||
$result = $provider->notificationReceived($notificationType, $providerId, $notification);
|
||||
} catch (ProviderDoesNotExistsException $e) {
|
||||
return new JSONResponse(
|
||||
['message' => $e->getMessage()],
|
||||
Http::STATUS_BAD_REQUEST
|
||||
);
|
||||
} catch (ShareNotFound $e) {
|
||||
return new JSONResponse(
|
||||
['message' => $e->getMessage()],
|
||||
Http::STATUS_BAD_REQUEST
|
||||
);
|
||||
} catch (ActionNotSupportedException $e) {
|
||||
return new JSONResponse(
|
||||
['message' => $e->getMessage()],
|
||||
Http::STATUS_NOT_IMPLEMENTED
|
||||
);
|
||||
} catch (BadRequestException $e) {
|
||||
return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
|
||||
} catch (AuthenticationFailedException $e) {
|
||||
return new JSONResponse(["message" => "RESOURCE_NOT_FOUND"], Http::STATUS_FORBIDDEN);
|
||||
}
|
||||
catch (\Exception $e) {
|
||||
return new JSONResponse(
|
||||
['message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl()],
|
||||
Http::STATUS_BAD_REQUEST
|
||||
);
|
||||
}
|
||||
|
||||
return new JSONResponse($result,Http::STATUS_CREATED);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* map login name to internal LDAP UID if a LDAP backend is in use
|
||||
*
|
||||
* @param string $uid
|
||||
* @return string mixed
|
||||
*/
|
||||
private function mapUid($uid) {
|
||||
\OC::$server->getURLGenerator()->linkToDocs('key');
|
||||
// FIXME this should be a method in the user management instead
|
||||
$this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
|
||||
\OCP\Util::emitHook(
|
||||
'\OCA\Files_Sharing\API\Server2Server',
|
||||
'preLoginNameUsedAsUserName',
|
||||
array('uid' => &$uid)
|
||||
);
|
||||
$this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
|
||||
|
||||
return $uid;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,776 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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\FederatedFileSharing\OCM;
|
||||
|
||||
use OC\AppFramework\Http;
|
||||
use OC\Files\Filesystem;
|
||||
use OCA\Files_Sharing\Activity\Providers\RemoteShares;
|
||||
use OCA\FederatedFileSharing\AddressHandler;
|
||||
use OCA\FederatedFileSharing\FederatedShareProvider;
|
||||
use OCP\Activity\IManager as IActivityManager;
|
||||
use OCP\App\IAppManager;
|
||||
use OCP\Constants;
|
||||
use OCP\Federation\Exceptions\ActionNotSupportedException;
|
||||
use OCP\Federation\Exceptions\AuthenticationFailedException;
|
||||
use OCP\Federation\Exceptions\BadRequestException;
|
||||
use OCP\Federation\Exceptions\ProviderCouldNotAddShareException;
|
||||
use OCP\Federation\ICloudFederationFactory;
|
||||
use OCP\Federation\ICloudFederationProvider;
|
||||
use OCP\Federation\ICloudFederationProviderManager;
|
||||
use OCP\Federation\ICloudFederationShare;
|
||||
use OCP\Federation\ICloudIdManager;
|
||||
use OCP\Files\NotFoundException;
|
||||
use OCP\IDBConnection;
|
||||
use OCP\ILogger;
|
||||
use OCP\IURLGenerator;
|
||||
use OCP\IUserManager;
|
||||
use OCP\Notification\IManager as INotificationManager;
|
||||
use OCP\Share\Exceptions\ShareNotFound;
|
||||
use OCP\Share\IShare;
|
||||
use OCP\Util;
|
||||
|
||||
class CloudFederationProviderFiles implements ICloudFederationProvider {
|
||||
|
||||
/** @var IAppManager */
|
||||
private $appManager;
|
||||
|
||||
/** @var FederatedShareProvider */
|
||||
private $federatedShareProvider;
|
||||
|
||||
/** @var AddressHandler */
|
||||
private $addressHandler;
|
||||
|
||||
/** @var ILogger */
|
||||
private $logger;
|
||||
|
||||
/** @var IUserManager */
|
||||
private $userManager;
|
||||
|
||||
/** @var ICloudIdManager */
|
||||
private $cloudIdManager;
|
||||
|
||||
/** @var IActivityManager */
|
||||
private $activityManager;
|
||||
|
||||
/** @var INotificationManager */
|
||||
private $notificationManager;
|
||||
|
||||
/** @var IURLGenerator */
|
||||
private $urlGenerator;
|
||||
|
||||
/** @var ICloudFederationFactory */
|
||||
private $cloudFederationFactory;
|
||||
|
||||
/** @var ICloudFederationProviderManager */
|
||||
private $cloudFederationProviderManager;
|
||||
|
||||
/** @var IDBConnection */
|
||||
private $connection;
|
||||
|
||||
/**
|
||||
* CloudFederationProvider constructor.
|
||||
*
|
||||
* @param IAppManager $appManager
|
||||
* @param FederatedShareProvider $federatedShareProvider
|
||||
* @param AddressHandler $addressHandler
|
||||
* @param ILogger $logger
|
||||
* @param IUserManager $userManager
|
||||
* @param ICloudIdManager $cloudIdManager
|
||||
* @param IActivityManager $activityManager
|
||||
* @param INotificationManager $notificationManager
|
||||
* @param IURLGenerator $urlGenerator
|
||||
* @param ICloudFederationFactory $cloudFederationFactory
|
||||
* @param ICloudFederationProviderManager $cloudFederationProviderManager
|
||||
* @param IDBConnection $connection
|
||||
*/
|
||||
public function __construct(IAppManager $appManager,
|
||||
FederatedShareProvider $federatedShareProvider,
|
||||
AddressHandler $addressHandler,
|
||||
ILogger $logger,
|
||||
IUserManager $userManager,
|
||||
ICloudIdManager $cloudIdManager,
|
||||
IActivityManager $activityManager,
|
||||
INotificationManager $notificationManager,
|
||||
IURLGenerator $urlGenerator,
|
||||
ICloudFederationFactory $cloudFederationFactory,
|
||||
ICloudFederationProviderManager $cloudFederationProviderManager,
|
||||
IDBConnection $connection
|
||||
) {
|
||||
$this->appManager = $appManager;
|
||||
$this->federatedShareProvider = $federatedShareProvider;
|
||||
$this->addressHandler = $addressHandler;
|
||||
$this->logger = $logger;
|
||||
$this->userManager = $userManager;
|
||||
$this->cloudIdManager = $cloudIdManager;
|
||||
$this->activityManager = $activityManager;
|
||||
$this->notificationManager = $notificationManager;
|
||||
$this->urlGenerator = $urlGenerator;
|
||||
$this->cloudFederationFactory = $cloudFederationFactory;
|
||||
$this->cloudFederationProviderManager = $cloudFederationProviderManager;
|
||||
$this->connection = $connection;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @return string
|
||||
*/
|
||||
public function getShareType() {
|
||||
return 'file';
|
||||
}
|
||||
|
||||
/**
|
||||
* share received from another server
|
||||
*
|
||||
* @param ICloudFederationShare $share
|
||||
* @return string provider specific unique ID of the share
|
||||
*
|
||||
* @throws ProviderCouldNotAddShareException
|
||||
* @throws \OCP\AppFramework\QueryException
|
||||
* @throws \OC\HintException
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function shareReceived(ICloudFederationShare $share) {
|
||||
|
||||
if (!$this->isS2SEnabled(true)) {
|
||||
throw new ProviderCouldNotAddShareException('Server does not support federated cloud sharing', '', Http::STATUS_SERVICE_UNAVAILABLE);
|
||||
}
|
||||
|
||||
$protocol = $share->getProtocol();
|
||||
if ($protocol['name'] !== 'webdav') {
|
||||
throw new ProviderCouldNotAddShareException('Unsupported protocol for data exchange.', '', Http::STATUS_NOT_IMPLEMENTED);
|
||||
}
|
||||
|
||||
list($ownerUid, $remote) = $this->addressHandler->splitUserRemote($share->getOwner());
|
||||
// for backward compatibility make sure that the remote url stored in the
|
||||
// database ends with a trailing slash
|
||||
if (substr($remote, -1) !== '/') {
|
||||
$remote = $remote . '/';
|
||||
}
|
||||
|
||||
$token = $share->getShareSecret();
|
||||
$name = $share->getResourceName();
|
||||
$owner = $share->getOwnerDisplayName();
|
||||
$sharedBy = $share->getSharedByDisplayName();
|
||||
$shareWith = $share->getShareWith();
|
||||
$remoteId = $share->getProviderId();
|
||||
$sharedByFederatedId = $share->getSharedBy();
|
||||
$ownerFederatedId = $share->getOwner();
|
||||
|
||||
// if no explicit information about the person who created the share was send
|
||||
// we assume that the share comes from the owner
|
||||
if ($sharedByFederatedId === null) {
|
||||
$sharedBy = $owner;
|
||||
$sharedByFederatedId = $ownerFederatedId;
|
||||
}
|
||||
|
||||
if ($remote && $token && $name && $owner && $remoteId && $shareWith) {
|
||||
|
||||
if (!Util::isValidFileName($name)) {
|
||||
throw new ProviderCouldNotAddShareException('The mountpoint name contains invalid characters.', '', Http::STATUS_BAD_REQUEST);
|
||||
}
|
||||
|
||||
// FIXME this should be a method in the user management instead
|
||||
$this->logger->debug('shareWith before, ' . $shareWith, ['app' => 'files_sharing']);
|
||||
Util::emitHook(
|
||||
'\OCA\Files_Sharing\API\Server2Server',
|
||||
'preLoginNameUsedAsUserName',
|
||||
array('uid' => &$shareWith)
|
||||
);
|
||||
$this->logger->debug('shareWith after, ' . $shareWith, ['app' => 'files_sharing']);
|
||||
|
||||
if (!$this->userManager->userExists($shareWith)) {
|
||||
throw new ProviderCouldNotAddShareException('User does not exists', '',Http::STATUS_BAD_REQUEST);
|
||||
}
|
||||
|
||||
\OC_Util::setupFS($shareWith);
|
||||
|
||||
$externalManager = new \OCA\Files_Sharing\External\Manager(
|
||||
\OC::$server->getDatabaseConnection(),
|
||||
Filesystem::getMountManager(),
|
||||
Filesystem::getLoader(),
|
||||
\OC::$server->getHTTPClientService(),
|
||||
\OC::$server->getNotificationManager(),
|
||||
\OC::$server->query(\OCP\OCS\IDiscoveryService::class),
|
||||
\OC::$server->getCloudFederationProviderManager(),
|
||||
\OC::$server->getCloudFederationFactory(),
|
||||
$shareWith
|
||||
);
|
||||
|
||||
try {
|
||||
$externalManager->addShare($remote, $token, '', $name, $owner, false, $shareWith, $remoteId);
|
||||
$shareId = \OC::$server->getDatabaseConnection()->lastInsertId('*PREFIX*share_external');
|
||||
|
||||
$event = $this->activityManager->generateEvent();
|
||||
$event->setApp('files_sharing')
|
||||
->setType('remote_share')
|
||||
->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_RECEIVED, [$ownerFederatedId, trim($name, '/')])
|
||||
->setAffectedUser($shareWith)
|
||||
->setObject('remote_share', (int)$shareId, $name);
|
||||
\OC::$server->getActivityManager()->publish($event);
|
||||
|
||||
$notification = $this->notificationManager->createNotification();
|
||||
$notification->setApp('files_sharing')
|
||||
->setUser($shareWith)
|
||||
->setDateTime(new \DateTime())
|
||||
->setObject('remote_share', $shareId)
|
||||
->setSubject('remote_share', [$ownerFederatedId, $sharedByFederatedId, trim($name, '/')]);
|
||||
|
||||
$declineAction = $notification->createAction();
|
||||
$declineAction->setLabel('decline')
|
||||
->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'DELETE');
|
||||
$notification->addAction($declineAction);
|
||||
|
||||
$acceptAction = $notification->createAction();
|
||||
$acceptAction->setLabel('accept')
|
||||
->setLink($this->urlGenerator->getAbsoluteURL($this->urlGenerator->linkTo('', 'ocs/v2.php/apps/files_sharing/api/v1/remote_shares/pending/' . $shareId)), 'POST');
|
||||
$notification->addAction($acceptAction);
|
||||
|
||||
$this->notificationManager->notify($notification);
|
||||
|
||||
return $shareId;
|
||||
} catch (\Exception $e) {
|
||||
$this->logger->logException($e, [
|
||||
'message' => 'Server can not add remote share.',
|
||||
'level' => ILogger::ERROR,
|
||||
'app' => 'files_sharing'
|
||||
]);
|
||||
throw new ProviderCouldNotAddShareException('internal server error, was not able to add share from ' . $remote, '', HTTP::STATUS_INTERNAL_SERVER_ERROR);
|
||||
}
|
||||
}
|
||||
|
||||
throw new ProviderCouldNotAddShareException('server can not add remote share, missing parameter', '', HTTP::STATUS_BAD_REQUEST);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* notification received from another server
|
||||
*
|
||||
* @param string $notificationType (e.g. SHARE_ACCEPTED)
|
||||
* @param string $providerId id of the share
|
||||
* @param array $notification payload of the notification
|
||||
* @return array data send back to the sender
|
||||
*
|
||||
* @throws ActionNotSupportedException
|
||||
* @throws AuthenticationFailedException
|
||||
* @throws BadRequestException
|
||||
* @throws \OC\HintException
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function notificationReceived($notificationType, $providerId, array $notification) {
|
||||
|
||||
switch ($notificationType) {
|
||||
case 'SHARE_ACCEPTED':
|
||||
return $this->shareAccepted($providerId, $notification);
|
||||
case 'SHARE_DECLINED':
|
||||
return $this->shareDeclined($providerId, $notification);
|
||||
case 'SHARE_UNSHARED':
|
||||
return $this->unshare($providerId, $notification);
|
||||
case 'REQUEST_RESHARE':
|
||||
return $this->reshareRequested($providerId, $notification);
|
||||
case 'RESHARE_UNDO':
|
||||
return $this->undoReshare($providerId, $notification);
|
||||
case 'RESHARE_CHANGE_PERMISSION':
|
||||
return $this->updateResharePermissions($providerId, $notification);
|
||||
}
|
||||
|
||||
|
||||
throw new BadRequestException([$notificationType]);
|
||||
}
|
||||
|
||||
/**
|
||||
* process notification that the recipient accepted a share
|
||||
*
|
||||
* @param string $id
|
||||
* @param array $notification
|
||||
* @return array
|
||||
* @throws ActionNotSupportedException
|
||||
* @throws AuthenticationFailedException
|
||||
* @throws BadRequestException
|
||||
* @throws \OC\HintException
|
||||
*/
|
||||
private function shareAccepted($id, array $notification) {
|
||||
|
||||
if (!$this->isS2SEnabled()) {
|
||||
throw new ActionNotSupportedException('Server does not support federated cloud sharing');
|
||||
}
|
||||
|
||||
if (!isset($notification['sharedSecret'])) {
|
||||
throw new BadRequestException(['sharedSecret']);
|
||||
}
|
||||
|
||||
$token = $notification['sharedSecret'];
|
||||
|
||||
$share = $this->federatedShareProvider->getShareById($id);
|
||||
|
||||
$this->verifyShare($share, $token);
|
||||
$this->executeAcceptShare($share);
|
||||
if ($share->getShareOwner() !== $share->getSharedBy()) {
|
||||
list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy());
|
||||
$remoteId = $this->federatedShareProvider->getRemoteId($share);
|
||||
$notification = $this->cloudFederationFactory->getCloudFederationNotification();
|
||||
$notification->setMessage(
|
||||
'SHARE_ACCEPTED',
|
||||
'file',
|
||||
$remoteId,
|
||||
[
|
||||
'sharedSecret' => $token,
|
||||
'message' => 'Recipient accepted the re-share'
|
||||
]
|
||||
|
||||
);
|
||||
$this->cloudFederationProviderManager->sendNotification($remote, $notification);
|
||||
|
||||
}
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* @param IShare $share
|
||||
* @throws ShareNotFound
|
||||
*/
|
||||
protected function executeAcceptShare(IShare $share) {
|
||||
try {
|
||||
$fileId = (int)$share->getNode()->getId();
|
||||
list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId);
|
||||
} catch (\Exception $e) {
|
||||
throw new ShareNotFound();
|
||||
}
|
||||
|
||||
$event = $this->activityManager->generateEvent();
|
||||
$event->setApp('files_sharing')
|
||||
->setType('remote_share')
|
||||
->setAffectedUser($this->getCorrectUid($share))
|
||||
->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_ACCEPTED, [$share->getSharedWith(), [$fileId => $file]])
|
||||
->setObject('files', $fileId, $file)
|
||||
->setLink($link);
|
||||
$this->activityManager->publish($event);
|
||||
}
|
||||
|
||||
/**
|
||||
* process notification that the recipient declined a share
|
||||
*
|
||||
* @param string $id
|
||||
* @param array $notification
|
||||
* @return array
|
||||
* @throws ActionNotSupportedException
|
||||
* @throws AuthenticationFailedException
|
||||
* @throws BadRequestException
|
||||
* @throws ShareNotFound
|
||||
* @throws \OC\HintException
|
||||
*
|
||||
*/
|
||||
protected function shareDeclined($id, array $notification) {
|
||||
|
||||
if (!$this->isS2SEnabled()) {
|
||||
throw new ActionNotSupportedException('Server does not support federated cloud sharing');
|
||||
}
|
||||
|
||||
if (!isset($notification['sharedSecret'])) {
|
||||
throw new BadRequestException(['sharedSecret']);
|
||||
}
|
||||
|
||||
$token = $notification['sharedSecret'];
|
||||
|
||||
$share = $this->federatedShareProvider->getShareById($id);
|
||||
|
||||
$this->verifyShare($share, $token);
|
||||
|
||||
if ($share->getShareOwner() !== $share->getSharedBy()) {
|
||||
list(, $remote) = $this->addressHandler->splitUserRemote($share->getSharedBy());
|
||||
$remoteId = $this->federatedShareProvider->getRemoteId($share);
|
||||
$notification = $this->cloudFederationFactory->getCloudFederationNotification();
|
||||
$notification->setMessage(
|
||||
'SHARE_DECLINED',
|
||||
'file',
|
||||
$remoteId,
|
||||
[
|
||||
'sharedSecret' => $token,
|
||||
'message' => 'Recipient declined the re-share'
|
||||
]
|
||||
|
||||
);
|
||||
$this->cloudFederationProviderManager->sendNotification($remote, $notification);
|
||||
}
|
||||
|
||||
$this->executeDeclineShare($share);
|
||||
|
||||
return [];
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* delete declined share and create a activity
|
||||
*
|
||||
* @param IShare $share
|
||||
* @throws ShareNotFound
|
||||
*/
|
||||
protected function executeDeclineShare(IShare $share) {
|
||||
$this->federatedShareProvider->removeShareFromTable($share);
|
||||
|
||||
try {
|
||||
$fileId = (int)$share->getNode()->getId();
|
||||
list($file, $link) = $this->getFile($this->getCorrectUid($share), $fileId);
|
||||
} catch (\Exception $e) {
|
||||
throw new ShareNotFound();
|
||||
}
|
||||
|
||||
$event = $this->activityManager->generateEvent();
|
||||
$event->setApp('files_sharing')
|
||||
->setType('remote_share')
|
||||
->setAffectedUser($this->getCorrectUid($share))
|
||||
->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_DECLINED, [$share->getSharedWith(), [$fileId => $file]])
|
||||
->setObject('files', $fileId, $file)
|
||||
->setLink($link);
|
||||
$this->activityManager->publish($event);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* received the notification that the owner unshared a file from you
|
||||
*
|
||||
* @param string $id
|
||||
* @param array $notification
|
||||
* @return array
|
||||
* @throws AuthenticationFailedException
|
||||
* @throws BadRequestException
|
||||
*/
|
||||
private function undoReshare($id, array $notification) {
|
||||
if (!isset($notification['sharedSecret'])) {
|
||||
throw new BadRequestException(['sharedSecret']);
|
||||
}
|
||||
$token = $notification['sharedSecret'];
|
||||
|
||||
$share = $this->federatedShareProvider->getShareById($id);
|
||||
|
||||
$this->verifyShare($share, $token);
|
||||
$this->federatedShareProvider->removeShareFromTable($share);
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* unshare file from self
|
||||
*
|
||||
* @param string $id
|
||||
* @param array $notification
|
||||
* @return array
|
||||
* @throws ActionNotSupportedException
|
||||
* @throws BadRequestException
|
||||
*/
|
||||
private function unshare($id, array $notification) {
|
||||
|
||||
if (!$this->isS2SEnabled(true)) {
|
||||
throw new ActionNotSupportedException("incoming shares disabled!");
|
||||
}
|
||||
|
||||
if (!isset($notification['sharedSecret'])) {
|
||||
throw new BadRequestException(['sharedSecret']);
|
||||
}
|
||||
$token = $notification['sharedSecret'];
|
||||
|
||||
$qb = $this->connection->getQueryBuilder();
|
||||
$qb->select('*')
|
||||
->from('share_external')
|
||||
->where(
|
||||
$qb->expr()->andX(
|
||||
$qb->expr()->eq('remote_id', $qb->createNamedParameter($id)),
|
||||
$qb->expr()->eq('share_token', $qb->createNamedParameter($token))
|
||||
)
|
||||
);
|
||||
|
||||
$result = $qb->execute();
|
||||
$share = $result->fetch();
|
||||
$result->closeCursor();
|
||||
|
||||
if ($token && $id && !empty($share)) {
|
||||
|
||||
$remote = $this->cleanupRemote($share['remote']);
|
||||
|
||||
$owner = $this->cloudIdManager->getCloudId($share['owner'], $remote);
|
||||
$mountpoint = $share['mountpoint'];
|
||||
$user = $share['user'];
|
||||
|
||||
$qb = $this->connection->getQueryBuilder();
|
||||
$qb->delete('share_external')
|
||||
->where(
|
||||
$qb->expr()->andX(
|
||||
$qb->expr()->eq('remote_id', $qb->createNamedParameter($id)),
|
||||
$qb->expr()->eq('share_token', $qb->createNamedParameter($token))
|
||||
)
|
||||
);
|
||||
|
||||
$qb->execute();
|
||||
|
||||
if ($share['accepted']) {
|
||||
$path = trim($mountpoint, '/');
|
||||
} else {
|
||||
$path = trim($share['name'], '/');
|
||||
}
|
||||
|
||||
$notification = $this->notificationManager->createNotification();
|
||||
$notification->setApp('files_sharing')
|
||||
->setUser($share['user'])
|
||||
->setObject('remote_share', (int)$share['id']);
|
||||
$this->notificationManager->markProcessed($notification);
|
||||
|
||||
$event = $this->activityManager->generateEvent();
|
||||
$event->setApp('files_sharing')
|
||||
->setType('remote_share')
|
||||
->setSubject(RemoteShares::SUBJECT_REMOTE_SHARE_UNSHARED, [$owner->getId(), $path])
|
||||
->setAffectedUser($user)
|
||||
->setObject('remote_share', (int)$share['id'], $path);
|
||||
\OC::$server->getActivityManager()->publish($event);
|
||||
}
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
private function cleanupRemote($remote) {
|
||||
$remote = substr($remote, strpos($remote, '://') + 3);
|
||||
|
||||
return rtrim($remote, '/');
|
||||
}
|
||||
|
||||
/**
|
||||
* recipient of a share request to re-share the file with another user
|
||||
*
|
||||
* @param string $id
|
||||
* @param array $notification
|
||||
* @return array
|
||||
* @throws AuthenticationFailedException
|
||||
* @throws BadRequestException
|
||||
* @throws ProviderCouldNotAddShareException
|
||||
* @throws ShareNotFound
|
||||
*/
|
||||
protected function reshareRequested($id, array $notification) {
|
||||
|
||||
if (!isset($notification['sharedSecret'])) {
|
||||
throw new BadRequestException(['sharedSecret']);
|
||||
}
|
||||
$token = $notification['sharedSecret'];
|
||||
|
||||
if (!isset($notification['shareWith'])) {
|
||||
throw new BadRequestException(['shareWith']);
|
||||
}
|
||||
$shareWith = $notification['shareWith'];
|
||||
|
||||
if (!isset($notification['senderId'])) {
|
||||
throw new BadRequestException(['senderId']);
|
||||
}
|
||||
$senderId = $notification['senderId'];
|
||||
|
||||
$share = $this->federatedShareProvider->getShareById($id);
|
||||
// don't allow to share a file back to the owner
|
||||
try {
|
||||
list($user, $remote) = $this->addressHandler->splitUserRemote($shareWith);
|
||||
$owner = $share->getShareOwner();
|
||||
$currentServer = $this->addressHandler->generateRemoteURL();
|
||||
if ($this->addressHandler->compareAddresses($user, $remote, $owner, $currentServer)) {
|
||||
throw new ProviderCouldNotAddShareException('Resharing back to the owner is not allowed: ' . $id);
|
||||
}
|
||||
} catch (\Exception $e) {
|
||||
throw new ProviderCouldNotAddShareException($e->getMessage());
|
||||
}
|
||||
|
||||
$this->verifyShare($share, $token);
|
||||
|
||||
// check if re-sharing is allowed
|
||||
if ($share->getPermissions() & Constants::PERMISSION_SHARE) {
|
||||
// the recipient of the initial share is now the initiator for the re-share
|
||||
$share->setSharedBy($share->getSharedWith());
|
||||
$share->setSharedWith($shareWith);
|
||||
$result = $this->federatedShareProvider->create($share);
|
||||
$this->federatedShareProvider->storeRemoteId((int)$result->getId(), $senderId);
|
||||
return ['token' => $result->getToken(), 'providerId' => $result->getId()];
|
||||
} else {
|
||||
throw new ProviderCouldNotAddShareException('resharing not allowed for share: ' . $id);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* update permission of a re-share so that the share dialog shows the right
|
||||
* permission if the owner or the sender changes the permission
|
||||
*
|
||||
* @param string $id
|
||||
* @param array $notification
|
||||
* @return array
|
||||
* @throws AuthenticationFailedException
|
||||
* @throws BadRequestException
|
||||
*/
|
||||
protected function updateResharePermissions($id, array $notification) {
|
||||
|
||||
if (!isset($notification['sharedSecret'])) {
|
||||
throw new BadRequestException(['sharedSecret']);
|
||||
}
|
||||
$token = $notification['sharedSecret'];
|
||||
|
||||
if (!isset($notification['permission'])) {
|
||||
throw new BadRequestException(['permission']);
|
||||
}
|
||||
$ocmPermissions = $notification['permission'];
|
||||
|
||||
$share = $this->federatedShareProvider->getShareById($id);
|
||||
|
||||
$ncPermission = $this->ocmPermissions2ncPermissions($ocmPermissions);
|
||||
|
||||
$this->verifyShare($share, $token);
|
||||
$this->updatePermissionsInDatabase($share, $ncPermission);
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* translate OCM Permissions to Nextcloud permissions
|
||||
*
|
||||
* @param array $ocmPermissions
|
||||
* @return int
|
||||
* @throws BadRequestException
|
||||
*/
|
||||
protected function ocmPermissions2ncPermissions(array $ocmPermissions) {
|
||||
$ncPermissions = 0;
|
||||
foreach($ocmPermissions as $permission) {
|
||||
switch (strtolower($permission)) {
|
||||
case 'read':
|
||||
$ncPermissions += Constants::PERMISSION_READ;
|
||||
break;
|
||||
case 'write':
|
||||
$ncPermissions += Constants::PERMISSION_CREATE + Constants::PERMISSION_UPDATE;
|
||||
break;
|
||||
case 'share':
|
||||
$ncPermissions += Constants::PERMISSION_SHARE;
|
||||
break;
|
||||
default:
|
||||
throw new BadRequestException(['permission']);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return $ncPermissions;
|
||||
}
|
||||
|
||||
/**
|
||||
* update permissions in database
|
||||
*
|
||||
* @param IShare $share
|
||||
* @param int $permissions
|
||||
*/
|
||||
protected function updatePermissionsInDatabase(IShare $share, $permissions) {
|
||||
$query = $this->connection->getQueryBuilder();
|
||||
$query->update('share')
|
||||
->where($query->expr()->eq('id', $query->createNamedParameter($share->getId())))
|
||||
->set('permissions', $query->createNamedParameter($permissions))
|
||||
->execute();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* get file
|
||||
*
|
||||
* @param string $user
|
||||
* @param int $fileSource
|
||||
* @return array with internal path of the file and a absolute link to it
|
||||
*/
|
||||
private function getFile($user, $fileSource) {
|
||||
\OC_Util::setupFS($user);
|
||||
|
||||
try {
|
||||
$file = Filesystem::getPath($fileSource);
|
||||
} catch (NotFoundException $e) {
|
||||
$file = null;
|
||||
}
|
||||
$args = Filesystem::is_dir($file) ? array('dir' => $file) : array('dir' => dirname($file), 'scrollto' => $file);
|
||||
$link = Util::linkToAbsolute('files', 'index.php', $args);
|
||||
|
||||
return [$file, $link];
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* check if we are the initiator or the owner of a re-share and return the correct UID
|
||||
*
|
||||
* @param IShare $share
|
||||
* @return string
|
||||
*/
|
||||
protected function getCorrectUid(IShare $share) {
|
||||
if ($this->userManager->userExists($share->getShareOwner())) {
|
||||
return $share->getShareOwner();
|
||||
}
|
||||
|
||||
return $share->getSharedBy();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* check if we got the right share
|
||||
*
|
||||
* @param IShare $share
|
||||
* @param string $token
|
||||
* @return bool
|
||||
* @throws AuthenticationFailedException
|
||||
*/
|
||||
protected function verifyShare(IShare $share, $token) {
|
||||
if (
|
||||
$share->getShareType() === FederatedShareProvider::SHARE_TYPE_REMOTE &&
|
||||
$share->getToken() === $token
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
|
||||
throw new AuthenticationFailedException();
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* check if server-to-server sharing is enabled
|
||||
*
|
||||
* @param bool $incoming
|
||||
* @return bool
|
||||
*/
|
||||
private function isS2SEnabled($incoming = false) {
|
||||
|
||||
$result = $this->appManager->isEnabledForUser('files_sharing');
|
||||
|
||||
if ($incoming) {
|
||||
$result = $result && $this->federatedShareProvider->isIncomingServer2serverShareEnabled();
|
||||
} else {
|
||||
$result = $result && $this->federatedShareProvider->isOutgoingServer2serverShareEnabled();
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* get the supported share types, e.g. "user", "group", etc.
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getSupportedShareTypes() {
|
||||
return ['user'];
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,63 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OC\Federation;
|
||||
|
||||
use OCP\Federation\ICloudFederationFactory;
|
||||
use OCP\Federation\ICloudFederationNotification;
|
||||
use OCP\Federation\ICloudFederationShare;
|
||||
|
||||
class CloudFederationFactory implements ICloudFederationFactory {
|
||||
|
||||
/**
|
||||
* get a CloudFederationShare Object to prepare a share you want to send
|
||||
*
|
||||
* @param string $shareWith
|
||||
* @param string $name resource name (e.g. document.odt)
|
||||
* @param string $description share description (optional)
|
||||
* @param string $providerId resource UID on the provider side
|
||||
* @param string $owner provider specific UID of the user who owns the resource
|
||||
* @param string $ownerDisplayName display name of the user who shared the item
|
||||
* @param string $sharedBy provider specific UID of the user who shared the resource
|
||||
* @param string $sharedByDisplayName display name of the user who shared the resource
|
||||
* @param string $sharedSecret used to authenticate requests across servers
|
||||
* @param string $shareType ('group' or 'user' share)
|
||||
* @param $resourceType ('file', 'calendar',...)
|
||||
* @return ICloudFederationShare
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType) {
|
||||
return new CloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $shareType, $resourceType, $sharedSecret);
|
||||
}
|
||||
|
||||
/**
|
||||
* get a Cloud FederationNotification object to prepare a notification you
|
||||
* want to send
|
||||
*
|
||||
* @return ICloudFederationNotification
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getCloudFederationNotification() {
|
||||
return new CloudFederationNotification();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OC\Federation;
|
||||
|
||||
use OCP\Federation\ICloudFederationNotification;
|
||||
|
||||
/**
|
||||
* Class CloudFederationNotification
|
||||
*
|
||||
* @package OC\Federation
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
class CloudFederationNotification implements ICloudFederationNotification {
|
||||
|
||||
private $message = [];
|
||||
|
||||
/**
|
||||
* add a message to the notification
|
||||
*
|
||||
* @param string $notificationType (e.g. SHARE_ACCEPTED)
|
||||
* @param string $resourceType (e.g. file, calendar, contact,...)
|
||||
* @param string $providerId id of the share
|
||||
* @param array $notification payload of the notification
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setMessage($notificationType, $resourceType, $providerId, array $notification) {
|
||||
$this->message = [
|
||||
'notificationType' => $notificationType,
|
||||
'resourceType' => $resourceType,
|
||||
'providerId' => $providerId,
|
||||
'notification' => $notification,
|
||||
];
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* get message, ready to send out
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getMessage() {
|
||||
return $this->message;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,242 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OC\Federation;
|
||||
|
||||
use OC\AppFramework\Http;
|
||||
use OCP\App\IAppManager;
|
||||
use OCP\Federation\Exceptions\ProviderDoesNotExistsException;
|
||||
use OCP\Federation\ICloudFederationNotification;
|
||||
use OCP\Federation\ICloudFederationProvider;
|
||||
use OCP\Federation\ICloudFederationProviderManager;
|
||||
use OCP\Federation\ICloudFederationShare;
|
||||
use OCP\Federation\ICloudIdManager;
|
||||
use OCP\Http\Client\IClientService;
|
||||
use OCP\ILogger;
|
||||
|
||||
/**
|
||||
* Class Manager
|
||||
*
|
||||
* Manage Cloud Federation Providers
|
||||
*
|
||||
* @package OC\Federation
|
||||
*/
|
||||
class CloudFederationProviderManager implements ICloudFederationProviderManager {
|
||||
|
||||
/** @var array list of available cloud federation providers */
|
||||
private $cloudFederationProvider;
|
||||
|
||||
/** @var IAppManager */
|
||||
private $appManager;
|
||||
|
||||
/** @var IClientService */
|
||||
private $httpClientService;
|
||||
|
||||
/** @var ICloudIdManager */
|
||||
private $cloudIdManager;
|
||||
|
||||
/** @var ILogger */
|
||||
private $logger;
|
||||
|
||||
/** @var array cache OCM end-points */
|
||||
private $ocmEndPoints = [];
|
||||
|
||||
private $supportedAPIVersion = '1.0-proposal1';
|
||||
|
||||
/**
|
||||
* CloudFederationProviderManager constructor.
|
||||
*
|
||||
* @param IAppManager $appManager
|
||||
* @param IClientService $httpClientService
|
||||
* @param ICloudIdManager $cloudIdManager
|
||||
* @param ILogger $logger
|
||||
*/
|
||||
public function __construct(IAppManager $appManager,
|
||||
IClientService $httpClientService,
|
||||
ICloudIdManager $cloudIdManager,
|
||||
ILogger $logger) {
|
||||
$this->cloudFederationProvider= [];
|
||||
$this->appManager = $appManager;
|
||||
$this->httpClientService = $httpClientService;
|
||||
$this->cloudIdManager = $cloudIdManager;
|
||||
$this->logger = $logger;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Registers an callback function which must return an cloud federation provider
|
||||
*
|
||||
* @param string $resourceType which resource type does the provider handles
|
||||
* @param string $displayName user facing name of the federated share provider
|
||||
* @param callable $callback
|
||||
*/
|
||||
public function addCloudFederationProvider($resourceType, $displayName, callable $callback) {
|
||||
$this->cloudFederationProvider[$resourceType] = [
|
||||
'resourceType' => $resourceType,
|
||||
'displayName' => $displayName,
|
||||
'callback' => $callback,
|
||||
];
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* remove cloud federation provider
|
||||
*
|
||||
* @param string $providerId
|
||||
*/
|
||||
public function removeCloudFederationProvider($providerId) {
|
||||
unset($this->cloudFederationProvider[$providerId]);
|
||||
}
|
||||
|
||||
/**
|
||||
* get a list of all cloudFederationProviders
|
||||
*
|
||||
* @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
|
||||
*/
|
||||
public function getAllCloudFederationProviders() {
|
||||
return $this->cloudFederationProvider;
|
||||
}
|
||||
|
||||
/**
|
||||
* get a specific cloud federation provider
|
||||
*
|
||||
* @param string $resourceType
|
||||
* @return ICloudFederationProvider
|
||||
* @throws ProviderDoesNotExistsException
|
||||
*/
|
||||
public function getCloudFederationProvider($resourceType) {
|
||||
if (isset($this->cloudFederationProvider[$resourceType])) {
|
||||
return call_user_func($this->cloudFederationProvider[$resourceType]['callback']);
|
||||
} else {
|
||||
throw new ProviderDoesNotExistsException($resourceType);
|
||||
}
|
||||
}
|
||||
|
||||
public function sendShare(ICloudFederationShare $share) {
|
||||
$cloudID = $this->cloudIdManager->resolveCloudId($share->getShareWith());
|
||||
$ocmEndPoint = $this->getOCMEndPoint($cloudID->getRemote());
|
||||
|
||||
if (empty($ocmEndPoint)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$client = $this->httpClientService->newClient();
|
||||
try {
|
||||
$response = $client->post($ocmEndPoint . '/shares', [
|
||||
'body' => $share->getShare(),
|
||||
'timeout' => 10,
|
||||
'connect_timeout' => 10,
|
||||
]);
|
||||
|
||||
if ($response->getStatusCode() === Http::STATUS_CREATED) {
|
||||
$result = json_decode($response->getBody(), true);
|
||||
return (is_array($result)) ? $result : [];
|
||||
}
|
||||
|
||||
} catch (\Exception $e) {
|
||||
// if flat re-sharing is not supported by the remote server
|
||||
// we re-throw the exception and fall back to the old behaviour.
|
||||
// (flat re-shares has been introduced in Nextcloud 9.1)
|
||||
if ($e->getCode() === Http::STATUS_INTERNAL_SERVER_ERROR) {
|
||||
throw $e;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $url
|
||||
* @param ICloudFederationNotification $notification
|
||||
* @return mixed
|
||||
*/
|
||||
public function sendNotification($url, ICloudFederationNotification $notification) {
|
||||
$ocmEndPoint = $this->getOCMEndPoint($url);
|
||||
|
||||
if (empty($ocmEndPoint)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$client = $this->httpClientService->newClient();
|
||||
try {
|
||||
$response = $client->post($ocmEndPoint . '/notifications', [
|
||||
'body' => $notification->getMessage(),
|
||||
'timeout' => 10,
|
||||
'connect_timeout' => 10,
|
||||
]);
|
||||
if ($response->getStatusCode() === Http::STATUS_CREATED) {
|
||||
$result = json_decode($response->getBody(), true);
|
||||
return (is_array($result)) ? $result : [];
|
||||
}
|
||||
} catch (\Exception $e) {
|
||||
// log the error and return false
|
||||
$this->logger->error('error while sending notification for federated share: ' . $e->getMessage());
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* check if the new cloud federation API is ready to be used
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function isReady() {
|
||||
return $this->appManager->isEnabledForUser('cloud_federation_api');
|
||||
}
|
||||
/**
|
||||
* check if server supports the new OCM api and ask for the correct end-point
|
||||
*
|
||||
* @param string $url full base URL of the cloud server
|
||||
* @return string
|
||||
*/
|
||||
protected function getOCMEndPoint($url) {
|
||||
|
||||
if (isset($this->ocmEndPoints[$url])) {
|
||||
return $this->ocmEndPoints[$url];
|
||||
}
|
||||
|
||||
$client = $this->httpClientService->newClient();
|
||||
try {
|
||||
$response = $client->get($url . '/ocm-provider/', ['timeout' => 10, 'connect_timeout' => 10]);
|
||||
} catch (\Exception $e) {
|
||||
$this->ocmEndPoints[$url] = '';
|
||||
return '';
|
||||
}
|
||||
|
||||
$result = $response->getBody();
|
||||
$result = json_decode($result, true);
|
||||
|
||||
$supportedVersion = isset($result['apiVersion']) && $result['apiVersion'] === $this->supportedAPIVersion;
|
||||
|
||||
if (isset($result['endPoint']) && $supportedVersion) {
|
||||
$this->ocmEndPoints[$url] = $result['endPoint'];
|
||||
return $result['endPoint'];
|
||||
}
|
||||
|
||||
$this->ocmEndPoints[$url] = '';
|
||||
return '';
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
@ -0,0 +1,352 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OC\Federation;
|
||||
|
||||
use OCP\Federation\ICloudFederationShare;
|
||||
|
||||
class CloudFederationShare implements ICloudFederationShare {
|
||||
|
||||
private $share = [
|
||||
'shareWith' => '',
|
||||
'shareType' => '',
|
||||
'name' => '',
|
||||
'resourceType' => '',
|
||||
'description' => '',
|
||||
'providerId' => '',
|
||||
'owner' => '',
|
||||
'ownerDisplayName' => '',
|
||||
'sharedBy' => '',
|
||||
'sharedByDisplayName' => '',
|
||||
'protocol' => []
|
||||
];
|
||||
|
||||
/**
|
||||
* get a CloudFederationShare Object to prepare a share you want to send
|
||||
*
|
||||
* @param string $shareWith
|
||||
* @param string $name resource name (e.g. document.odt)
|
||||
* @param string $description share description (optional)
|
||||
* @param string $providerId resource UID on the provider side
|
||||
* @param string $owner provider specific UID of the user who owns the resource
|
||||
* @param string $ownerDisplayName display name of the user who shared the item
|
||||
* @param string $sharedBy provider specific UID of the user who shared the resource
|
||||
* @param string $sharedByDisplayName display name of the user who shared the resource
|
||||
* @param string $shareType ('group' or 'user' share)
|
||||
* @param string $resourceType ('file', 'calendar',...)
|
||||
* @param string $sharedSecret
|
||||
*/
|
||||
public function __construct($shareWith = '',
|
||||
$name = '',
|
||||
$description = '',
|
||||
$providerId = '',
|
||||
$owner = '',
|
||||
$ownerDisplayName = '',
|
||||
$sharedBy = '',
|
||||
$sharedByDisplayName = '',
|
||||
$shareType = '',
|
||||
$resourceType = '',
|
||||
$sharedSecret = ''
|
||||
) {
|
||||
$this->setShareWith($shareWith);
|
||||
$this->setResourceName($name);
|
||||
$this->setDescription($description);
|
||||
$this->setProviderId($providerId);
|
||||
$this->setOwner($owner);
|
||||
$this->setOwnerDisplayName($ownerDisplayName);
|
||||
$this->setSharedBy($sharedBy);
|
||||
$this->setSharedByDisplayName($sharedByDisplayName);
|
||||
$this->setProtocol([
|
||||
'name' => 'webdav',
|
||||
'options' => [
|
||||
'sharedSecret' => $sharedSecret,
|
||||
'permissions' => '{http://open-cloud-mesh.org/ns}share-permissions'
|
||||
]
|
||||
]);
|
||||
$this->setShareType($shareType);
|
||||
$this->setResourceType($resourceType);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* set uid of the recipient
|
||||
*
|
||||
* @param string $user
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setShareWith($user) {
|
||||
$this->share['shareWith'] = $user;
|
||||
}
|
||||
|
||||
/**
|
||||
* set resource name (e.g. document.odt)
|
||||
*
|
||||
* @param string $name
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setResourceName($name) {
|
||||
$this->share['name'] = $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* set resource type (e.g. file, calendar, contact,...)
|
||||
*
|
||||
* @param string $resourceType
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setResourceType($resourceType) {
|
||||
$this->share['resourceType'] = $resourceType;
|
||||
}
|
||||
|
||||
/**
|
||||
* set resource description (optional)
|
||||
*
|
||||
* @param string $description
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setDescription($description) {
|
||||
$this->share['description'] = $description;
|
||||
}
|
||||
|
||||
/**
|
||||
* set provider ID (e.g. file ID)
|
||||
*
|
||||
* @param string $providerId
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setProviderId($providerId) {
|
||||
$this->share['providerId'] = $providerId;
|
||||
}
|
||||
|
||||
/**
|
||||
* set owner UID
|
||||
*
|
||||
* @param string $owner
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setOwner($owner) {
|
||||
$this->share['owner'] = $owner;
|
||||
}
|
||||
|
||||
/**
|
||||
* set owner display name
|
||||
*
|
||||
* @param string $ownerDisplayName
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setOwnerDisplayName($ownerDisplayName) {
|
||||
$this->share['ownerDisplayName'] = $ownerDisplayName;
|
||||
}
|
||||
|
||||
/**
|
||||
* set UID of the user who sends the share
|
||||
*
|
||||
* @param string $sharedBy
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setSharedBy($sharedBy) {
|
||||
$this->share['sharedBy'] = $sharedBy;
|
||||
}
|
||||
|
||||
/**
|
||||
* set display name of the user who sends the share
|
||||
*
|
||||
* @param $sharedByDisplayName
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setSharedByDisplayName($sharedByDisplayName) {
|
||||
$this->share['sharedByDisplayName'] = $sharedByDisplayName;
|
||||
}
|
||||
|
||||
/**
|
||||
* set protocol specification
|
||||
*
|
||||
* @param array $protocol
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setProtocol(array $protocol) {
|
||||
$this->share['protocol'] = $protocol;
|
||||
}
|
||||
|
||||
/**
|
||||
* share type (group or user)
|
||||
*
|
||||
* @param string $shareType
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setShareType($shareType) {
|
||||
$this->share['shareType'] = $shareType;
|
||||
}
|
||||
|
||||
/**
|
||||
* get the whole share, ready to send out
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShare() {
|
||||
return $this->share;
|
||||
}
|
||||
|
||||
/**
|
||||
* get uid of the recipient
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShareWith() {
|
||||
return $this->share['shareWith'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get resource name (e.g. file, calendar, contact,...)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getResourceName() {
|
||||
return $this->share['name'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get resource type (e.g. file, calendar, contact,...)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getResourceType() {
|
||||
return $this->share['resourceType'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get resource description (optional)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getDescription() {
|
||||
return $this->share['description'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get provider ID (e.g. file ID)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getProviderId() {
|
||||
return $this->share['providerId'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get owner UID
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getOwner() {
|
||||
return $this->share['owner'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get owner display name
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getOwnerDisplayName() {
|
||||
return $this->share['ownerDisplayName'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get UID of the user who sends the share
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getSharedBy() {
|
||||
return $this->share['sharedBy'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get display name of the user who sends the share
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getSharedByDisplayName() {
|
||||
return $this->share['sharedByDisplayName'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get share type (group or user)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShareType() {
|
||||
return $this->share['shareType'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get share Secret
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShareSecret() {
|
||||
return $this->share['protocol']['options']['sharedSecret'];
|
||||
}
|
||||
|
||||
/**
|
||||
* get protocol specification
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getProtocol() {
|
||||
return $this->share['protocol'];
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,48 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation\Exceptions;
|
||||
|
||||
use OC\HintException;
|
||||
|
||||
/**
|
||||
* Class ActionNotSupportedException
|
||||
*
|
||||
* @package OCP\Federation\Exceptions
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
class ActionNotSupportedException extends HintException {
|
||||
|
||||
/**
|
||||
* ActionNotSupportedException constructor.
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
*/
|
||||
public function __construct($action) {
|
||||
$l = \OC::$server->getL10N('federation');
|
||||
$message = 'Action "' . $action . '" not supported or implemented.';
|
||||
$hint = $l->t('Action "%s" not supported or implemented.', [$action]);
|
||||
parent::__construct($message, $hint);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,48 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation\Exceptions;
|
||||
|
||||
use OC\HintException;
|
||||
|
||||
/**
|
||||
* Class AuthenticationFailedException
|
||||
*
|
||||
* @package OCP\Federation\Exceptions
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
class AuthenticationFailedException extends HintException {
|
||||
|
||||
/**
|
||||
* BadRequestException constructor.
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
*/
|
||||
public function __construct() {
|
||||
$l = \OC::$server->getL10N('federation');
|
||||
$message = 'Authentication failed, wrong token or provider ID given';
|
||||
$hint = $l->t('Authentication failed, wrong token or provider ID given');
|
||||
parent::__construct($message, $hint);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,77 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation\Exceptions;
|
||||
|
||||
use OC\HintException;
|
||||
|
||||
/**
|
||||
* Class BadRequestException
|
||||
*
|
||||
* @package OCP\Federation\Exceptions
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
class BadRequestException extends HintException {
|
||||
|
||||
private $parameterList;
|
||||
|
||||
/**
|
||||
* BadRequestException constructor.
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
* @param array $missingParameters
|
||||
*/
|
||||
public function __construct(array $missingParameters) {
|
||||
$l = \OC::$server->getL10N('federation');
|
||||
$this->parameterList = $missingParameters;
|
||||
$parameterList = implode(',', $missingParameters);
|
||||
$message = 'Parameters missing in order to complete the request. Missing Parameters: ' . $parameterList;
|
||||
$hint = $l->t('Parameters missing in order to complete the request. Missing Parameters: "%s"', [$parameterList]);
|
||||
parent::__construct($message, $hint);
|
||||
}
|
||||
|
||||
/**
|
||||
* get array with the return message as defined in the OCM API
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getReturnMessage() {
|
||||
$result = [
|
||||
'message' => 'RESOURCE_NOT_FOUND',
|
||||
'validationErrors' =>[
|
||||
]
|
||||
];
|
||||
|
||||
foreach ($this->parameterList as $missingParameter) {
|
||||
$result['validationErrors'] = [
|
||||
'name' => $missingParameter,
|
||||
'message' => 'NOT_FOUND'
|
||||
];
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,50 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation\Exceptions;
|
||||
|
||||
use OC\HintException;
|
||||
|
||||
/**
|
||||
* Class ProviderAlreadyExistsException
|
||||
*
|
||||
* @package OCP\Federation\Exceptions
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
class ProviderAlreadyExistsException extends HintException {
|
||||
|
||||
/**
|
||||
* ProviderAlreadyExistsException constructor.
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
* @param string $newProviderId cloud federation provider ID of the new provider
|
||||
* @param string $existingProviderName name of cloud federation provider which already use the same ID
|
||||
*/
|
||||
public function __construct($newProviderId, $existingProviderName) {
|
||||
$l = \OC::$server->getL10N('federation');
|
||||
$message = 'Id "' . $newProviderId . '" already used by cloud federation provider "' . $existingProviderName . '"';
|
||||
$hint = $l->t('Id "%s" already used by cloud federation provider "%s"', [$newProviderId, $existingProviderName]);
|
||||
parent::__construct($message, $hint);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,51 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation\Exceptions;
|
||||
|
||||
use OC\HintException;
|
||||
use OCP\AppFramework\Http;
|
||||
|
||||
/**
|
||||
* Class ProviderCouldNotAddShareException
|
||||
*
|
||||
* @package OCP\Federation\Exceptions
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
class ProviderCouldNotAddShareException extends HintException {
|
||||
|
||||
/**
|
||||
* ProviderCouldNotAddShareException constructor.
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
* @param string $message
|
||||
* @param string $hint
|
||||
* @param int $code
|
||||
* @param \Exception|null $previous
|
||||
*/
|
||||
public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) {
|
||||
parent::__construct($message, $hint, $code, $previous);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation\Exceptions;
|
||||
|
||||
use OC\HintException;
|
||||
|
||||
/**
|
||||
* Class ProviderDoesNotExistsException
|
||||
*
|
||||
* @package OCP\Federation\Exceptions
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
class ProviderDoesNotExistsException extends HintException {
|
||||
|
||||
/**
|
||||
* ProviderDoesNotExistsException constructor.
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
* @param string $providerId cloud federation provider ID
|
||||
*/
|
||||
public function __construct($providerId) {
|
||||
$l = \OC::$server->getL10N('federation');
|
||||
$message = 'Cloud Federation Provider with ID: "' . $providerId . '" does not exist.';
|
||||
$hint = $l->t('Cloud Federation Provider with ID: "%s" does not exist.', [$providerId]);
|
||||
parent::__construct($message, $hint);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,62 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation;
|
||||
|
||||
/**
|
||||
* Interface ICloudFederationFactory
|
||||
*
|
||||
* @package OCP\Federation
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
interface ICloudFederationFactory {
|
||||
|
||||
/**
|
||||
* get a CloudFederationShare Object to prepare a share you want to send
|
||||
*
|
||||
* @param string $shareWith
|
||||
* @param string $name resource name (e.g. document.odt)
|
||||
* @param string $description share description (optional)
|
||||
* @param string $providerId resource UID on the provider side
|
||||
* @param string $owner provider specific UID of the user who owns the resource
|
||||
* @param string $ownerDisplayName display name of the user who shared the item
|
||||
* @param string $sharedBy provider specific UID of the user who shared the resource
|
||||
* @param string $sharedByDisplayName display name of the user who shared the resource
|
||||
* @param string $sharedSecret used to authenticate requests across servers
|
||||
* @param string $shareType ('group' or 'user' share)
|
||||
* @param $resourceType ('file', 'calendar',...)
|
||||
* @return ICloudFederationShare
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $sharedSecret, $shareType, $resourceType);
|
||||
|
||||
/**
|
||||
* get a Cloud FederationNotification object to prepare a notification you
|
||||
* want to send
|
||||
*
|
||||
* @return ICloudFederationNotification
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getCloudFederationNotification();
|
||||
}
|
||||
@ -0,0 +1,53 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation;
|
||||
|
||||
/**
|
||||
* Interface ICloudFederationNotification
|
||||
*
|
||||
* @package OCP\Federation
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
interface ICloudFederationNotification {
|
||||
|
||||
/**
|
||||
* add a message to the notification
|
||||
*
|
||||
* @param string $notificationType (e.g. SHARE_ACCEPTED)
|
||||
* @param string $resourceType (e.g. file, calendar, contact,...)
|
||||
* @param $providerId id of the share
|
||||
* @param array $notification , payload of the notification
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setMessage($notificationType, $resourceType, $providerId, array $notification);
|
||||
|
||||
/**
|
||||
* get message, ready to send out
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getMessage();
|
||||
}
|
||||
@ -0,0 +1,89 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation;
|
||||
|
||||
use OCP\Federation\Exceptions\ActionNotSupportedException;
|
||||
use OCP\Federation\Exceptions\AuthenticationFailedException;
|
||||
use OCP\Federation\Exceptions\BadRequestException;
|
||||
use OCP\Federation\Exceptions\ProviderCouldNotAddShareException;
|
||||
use \OCP\Share\Exceptions\ShareNotFound;
|
||||
|
||||
/**
|
||||
* Interface ICloudFederationProvider
|
||||
*
|
||||
* Enable apps to create their own cloud federation provider
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
* @package OCP\Federation
|
||||
*/
|
||||
|
||||
interface ICloudFederationProvider {
|
||||
|
||||
/**
|
||||
* get the name of the share type, handled by this provider
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShareType();
|
||||
|
||||
/**
|
||||
* share received from another server
|
||||
*
|
||||
* @param ICloudFederationShare $share
|
||||
* @return string provider specific unique ID of the share
|
||||
*
|
||||
* @throws ProviderCouldNotAddShareException
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function shareReceived(ICloudFederationShare $share);
|
||||
|
||||
/**
|
||||
* notification received from another server
|
||||
*
|
||||
* @param string $notificationType (e.g SHARE_ACCEPTED)
|
||||
* @param string $providerId share ID
|
||||
* @param array $notification provider specific notification
|
||||
* @return array $data send back to sender
|
||||
*
|
||||
* @throws ShareNotFound
|
||||
* @throws ActionNotSupportedException
|
||||
* @throws BadRequestException
|
||||
* @throws AuthenticationFailedException
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function notificationReceived($notificationType, $providerId, array $notification);
|
||||
|
||||
/**
|
||||
* get the supported share types, e.g. "user", "group", etc.
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getSupportedShareTypes();
|
||||
|
||||
}
|
||||
@ -0,0 +1,107 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation;
|
||||
|
||||
/**
|
||||
* Class ICloudFederationProviderManager
|
||||
*
|
||||
* Manage cloud federation providers
|
||||
*
|
||||
* @since 14.0.0
|
||||
*
|
||||
* @package OCP\Federation
|
||||
*/
|
||||
interface ICloudFederationProviderManager {
|
||||
|
||||
/**
|
||||
* Registers an callback function which must return an cloud federation provider
|
||||
*
|
||||
* @param string $resourceType which resource type does the provider handles
|
||||
* @param string $displayName user facing name of the federated share provider
|
||||
* @param callable $callback
|
||||
* @throws Exceptions\ProviderAlreadyExistsException
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function addCloudFederationProvider($resourceType, $displayName, callable $callback);
|
||||
|
||||
/**
|
||||
* remove cloud federation provider
|
||||
*
|
||||
* @param string $resourceType
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function removeCloudFederationProvider($resourceType);
|
||||
|
||||
/**
|
||||
* get a list of all cloudFederationProviders
|
||||
*
|
||||
* @return array [resourceType => ['resourceType' => $resourceType, 'displayName' => $displayName, 'callback' => callback]]
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getAllCloudFederationProviders();
|
||||
|
||||
/**
|
||||
* get a specific cloud federation provider
|
||||
*
|
||||
* @param string $resourceType
|
||||
* @return ICloudFederationProvider
|
||||
* @throws Exceptions\ProviderDoesNotExistsException;
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getCloudFederationProvider($resourceType);
|
||||
|
||||
/**
|
||||
* send federated share
|
||||
*
|
||||
* @param ICloudFederationShare $share
|
||||
* @return mixed
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function sendShare(ICloudFederationShare $share);
|
||||
|
||||
/**
|
||||
* send notification about existing share
|
||||
*
|
||||
* @param string $url
|
||||
* @param ICloudFederationNotification $notification
|
||||
* @return mixed
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function sendNotification($url, ICloudFederationNotification $notification);
|
||||
|
||||
/**
|
||||
* check if the new cloud federation API is ready to be used
|
||||
*
|
||||
* @return bool
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function isReady();
|
||||
|
||||
|
||||
}
|
||||
@ -0,0 +1,250 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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 OCP\Federation;
|
||||
|
||||
/**
|
||||
* Interface ICloudFederationShare
|
||||
*
|
||||
* @package OCP\Federation
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
interface ICloudFederationShare {
|
||||
|
||||
/**
|
||||
* set uid of the recipient
|
||||
*
|
||||
* @param string $user
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setShareWith($user);
|
||||
|
||||
/**
|
||||
* set resource name (e.g. file, calendar, contact,...)
|
||||
*
|
||||
* @param string $name
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setResourceName($name);
|
||||
|
||||
/**
|
||||
* set resource type (e.g. file, calendar, contact,...)
|
||||
*
|
||||
* @param string $resourceType
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setResourceType($resourceType);
|
||||
|
||||
/**
|
||||
* set resource description (optional)
|
||||
*
|
||||
* @param string $description
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setDescription($description);
|
||||
|
||||
/**
|
||||
* set provider ID (e.g. file ID)
|
||||
*
|
||||
* @param string $providerId
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setProviderId($providerId);
|
||||
|
||||
/**
|
||||
* set owner UID
|
||||
*
|
||||
* @param string $owner
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setOwner($owner);
|
||||
|
||||
/**
|
||||
* set owner display name
|
||||
*
|
||||
* @param string $ownerDisplayName
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setOwnerDisplayName($ownerDisplayName);
|
||||
|
||||
/**
|
||||
* set UID of the user who sends the share
|
||||
*
|
||||
* @param string $sharedBy
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setSharedBy($sharedBy);
|
||||
|
||||
/**
|
||||
* set display name of the user who sends the share
|
||||
*
|
||||
* @param $sharedByDisplayName
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setSharedByDisplayName($sharedByDisplayName);
|
||||
|
||||
/**
|
||||
* set protocol specification
|
||||
*
|
||||
* @param array $protocol
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setProtocol(array $protocol);
|
||||
|
||||
/**
|
||||
* share type (group or user)
|
||||
*
|
||||
* @param string $shareType
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function setShareType($shareType);
|
||||
|
||||
/**
|
||||
* get the whole share, ready to send out
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShare();
|
||||
|
||||
/**
|
||||
* get uid of the recipient
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShareWith();
|
||||
|
||||
/**
|
||||
* get resource name (e.g. file, calendar, contact,...)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getResourceName();
|
||||
|
||||
/**
|
||||
* get resource type (e.g. file, calendar, contact,...)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getResourceType();
|
||||
|
||||
/**
|
||||
* get resource description (optional)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getDescription();
|
||||
|
||||
/**
|
||||
* get provider ID (e.g. file ID)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getProviderId();
|
||||
|
||||
/**
|
||||
* get owner UID
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getOwner();
|
||||
|
||||
/**
|
||||
* get owner display name
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getOwnerDisplayName();
|
||||
|
||||
/**
|
||||
* get UID of the user who sends the share
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getSharedBy();
|
||||
|
||||
/**
|
||||
* get display name of the user who sends the share
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getSharedByDisplayName();
|
||||
|
||||
/**
|
||||
* get share type (group or user)
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShareType();
|
||||
|
||||
/**
|
||||
* get share Secret
|
||||
*
|
||||
* @return string
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getShareSecret();
|
||||
|
||||
|
||||
/**
|
||||
* get protocol specification
|
||||
*
|
||||
* @return array
|
||||
*
|
||||
* @since 14.0.0
|
||||
*/
|
||||
public function getProtocol();
|
||||
|
||||
}
|
||||
@ -0,0 +1,39 @@
|
||||
<?php
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Bjoern Schiessle <bjoern@schiessle.org>
|
||||
*
|
||||
* @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__ . '/../lib/base.php';
|
||||
|
||||
header('Content-Type: application/json');
|
||||
|
||||
$server = \OC::$server;
|
||||
|
||||
$isEnabled = $server->getAppManager()->isEnabledForUser('cloud_federation_api');
|
||||
|
||||
if ($isEnabled) {
|
||||
$capabilities = new OCA\CloudFederationAPI\Capabilities($server->getURLGenerator());
|
||||
header('Content-Type: application/json');
|
||||
echo json_encode($capabilities->getCapabilities()['ocm']);
|
||||
} else {
|
||||
header($_SERVER["SERVER_PROTOCOL"]." 501 Not Implemented", true, 501);
|
||||
exit("501 Not Implemented");
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue