pax_global_header 0000666 0000000 0000000 00000000064 14140552775 0014524 g ustar 00root root 0000000 0000000 52 comment=0a0539e3c8677872a5be1e36345a75b800ff11fa
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/ 0000775 0000000 0000000 00000000000 14140552775 0020776 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/.gitignore 0000664 0000000 0000000 00000000066 14140552775 0022770 0 ustar 00root root 0000000 0000000 target/**
nbactions.xml
nb-configuration.xml
/target/
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/.gitlab-ci.yml 0000664 0000000 0000000 00000003070 14140552775 0023432 0 ustar 00root root 0000000 0000000 stages:
- build
- generate-test-env
- test
- dockerize
variables:
# to avoid "fatal: git fetch-pack: expected shallow list"
GIT_STRATEGY: clone
build:
stage: build
tags:
- docker
only:
refs:
- master
script:
- mvn clean package -DskipTests -DfinalName=vospace
artifacts:
paths:
- target/vospace.jar
expire_in: 7 days
pre_test:
stage: generate-test-env
tags:
- shell
script:
- docker login -u "${CI_REGISTRY_USER}" -p "${CI_REGISTRY_PASSWORD}" "${CI_REGISTRY}"
- docker build -t "${CI_REGISTRY_IMAGE}/vospace-test-env" -f src/test/resources/testing-Dockerfile .
- docker push "${CI_REGISTRY_IMAGE}/vospace-test-env"
only:
refs:
- master
changes:
- src/test/resources/testing-Dockerfile
test:
stage: test
tags:
- docker
image: "${CI_REGISTRY_IMAGE}/vospace-test-env"
variables:
FILE_CATALOG_REPO_URL: "https://gitlab-ci-token:${CI_JOB_TOKEN}@www.ict.inaf.it/gitlab/vospace/vospace-file-catalog.git"
script:
- git clone ${FILE_CATALOG_REPO_URL}
- mvn clean test -Dinit_database_scripts_path=../../vospace-file-catalog
- awk -F"," '{ instructions += $4 + $5; covered += $5 } END { print "coverage=" 100*covered/instructions }' target/site/jacoco/jacoco.csv
coverage: '/coverage=\d+\.\d+/'
only:
- master
dockerize:
stage: dockerize
tags:
- shell
only:
refs:
- master
script:
- docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
- docker build -t $CI_REGISTRY_IMAGE .
- docker push $CI_REGISTRY_IMAGE
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/Dockerfile 0000664 0000000 0000000 00000000316 14140552775 0022770 0 ustar 00root root 0000000 0000000 FROM openjdk:14-jdk-alpine
ARG JAR_FILE=target/vospace.jar
COPY ${JAR_FILE} vospace.jar
RUN apk add socat
ADD docker-entrypoint.sh /
RUN chmod +x /docker-entrypoint.sh
ENTRYPOINT ["/docker-entrypoint.sh"]
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/LICENSE 0000664 0000000 0000000 00000104515 14140552775 0022011 0 ustar 00root root 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is 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. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
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.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
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 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. Use with the GNU Affero General Public License.
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 Affero 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 special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU 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 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 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 General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
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 GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/README.md 0000664 0000000 0000000 00000003544 14140552775 0022263 0 ustar 00root root 0000000 0000000 # VOSpace REST service
**⚠ Work in progress! ⚠**
## Developer notes
### DAO testing
This VOSpace implementation shares the database with the [VOSpace Transfer Service application](https://www.ict.inaf.it/gitlab/vospace/vospace-transfer-service). The structure of the database is defined in a [separate repository](https://www.ict.inaf.it/gitlab/vospace/vospace-file-catalog). To avoid duplicating database definitions, DAO test classes load the database directly from the files of that repository. We assume that when running the tests the git repository exists and it is located in the same parent folder containing this repository.
To reconfigure the path of that repository edit the property `init_database_scripts_path` in test.properties.
### Loading fake users in MockMvc
Test classes annotated with `@SpringBootTest` and `@AutoConfigureMockMvc` can be used to test REST controllers. Theoretically it should be possible configure a fake principal to each test request using the following notation:
```java
mockMvc.perform(post("/endpoint").principal(myFakeUser));
```
However it seems that the method is ignored if the principal is set using a custom servlet filter, like in our case (see `TokenFilter` registration defined in `VospaceApplication` class).
To bypass the problem a fake `TokenFilter` has been defined in `TokenFilterConfig` test class. This filter returns some fake users based on the received fake token. If you need additional test users just add them in the `getFakeUser()` method.
To use the fake filter add the following annotations to the test class:
```java
@ContextConfiguration(classes = {TokenFilterConfig.class})
@TestPropertySource(properties = "spring.main.allow-bean-definition-overriding=true")
```
Then add the fake token to the test request:
```java
mockMvc.perform(post("/endpoint").header("Authorization", "Bearer user1_token"));
```
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/database/ 0000775 0000000 0000000 00000000000 14140552775 0022542 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/database/Dockerfile 0000664 0000000 0000000 00000000414 14140552775 0024533 0 ustar 00root root 0000000 0000000 FROM library/postgres:11
#ENV POSTGRES_USER vospaceusr
#ENV POSTGRES_PASSWORD Peper0ne
ENV POSTGRES_DB vospacedb
ENV POSTGRES_HOST_AUTH_METHOD=trust
COPY src/main/resources/db_init.sql /docker-entrypoint-initdb.d/
COPY database/user.sql /docker-entrypoint-initdb.d/
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/database/docker-env 0000664 0000000 0000000 00000000112 14140552775 0024514 0 ustar 00root root 0000000 0000000 POSTGRES_USER=vospaceusr
POSTGRES_PASSWORD=Peper0ne
POSTGRES_DB=vospacedb
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/database/user.sql 0000664 0000000 0000000 00000000355 14140552775 0024244 0 ustar 00root root 0000000 0000000 CREATE ROLE vospaceusr WITH LOGIN PASSWORD 'Peper0ne';
GRANT USAGE ON SCHEMA public TO vospaceusr;
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO vospaceusr;
GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA public TO vospaceusr;
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/docker-entrypoint.sh 0000775 0000000 0000000 00000000250 14140552775 0025012 0 ustar 00root root 0000000 0000000 #!/bin/sh
if [ ! -z "$FILE_SERVICE_PORT" ]; then
socat TCP-LISTEN:$FILE_SERVICE_PORT,fork TCP:vospace_file_service:$FILE_SERVICE_PORT &
fi
java -jar /vospace.jar
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/pom.xml 0000664 0000000 0000000 00000006074 14140552775 0022322 0 ustar 00root root 0000000 0000000
4.0.0it.inaf.ia2vospace-parent0.0.2-SNAPSHOTit.inaf.oatsvospace-rest0.0.2-SNAPSHOTvospace-restVOSpace REST service../../../vospace-file-catalog${project.artifactId}-${project.version}it.inaf.ia2vospace-parent-classes0.0.2-SNAPSHOTredis.clientsjedis${finalName}src/test/resourcestruetest.propertiessrc/test/resourcesfalse**/*test.propertiesorg.springframework.bootspring-boot-maven-pluginorg.jacocojacoco-maven-pluginprepare-agentreporttestreportia2-snapshotsIA2 snapshot repositoryhttp://repo.ia2.inaf.it/maven/repository/snapshots
vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/ 0000775 0000000 0000000 00000000000 14140552775 0021565 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/ 0000775 0000000 0000000 00000000000 14140552775 0022511 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/ 0000775 0000000 0000000 00000000000 14140552775 0023432 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/ 0000775 0000000 0000000 00000000000 14140552775 0024046 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/ 0000775 0000000 0000000 00000000000 14140552775 0024763 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/ 0000775 0000000 0000000 00000000000 14140552775 0025731 5 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace/ 0000775 0000000 0000000 00000000000 14140552775 0027371 5 ustar 00root root 0000000 0000000 AbstractNodeService.java 0000664 0000000 0000000 00000003130 14140552775 0034044 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.oats.vospace.exception.InternalFaultException;
import it.inaf.oats.vospace.exception.NodeBusyException;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import it.inaf.oats.vospace.persistence.NodeDAO;
import it.inaf.oats.vospace.persistence.NodeDAO.ShortNodeDescriptor;
import javax.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
public abstract class AbstractNodeService {
@Autowired
protected NodeDAO nodeDao;
@Value("${vospace-authority}")
protected String authority;
protected void validatePath(String path) {
if (path.equals("/")) {
throw new IllegalArgumentException("Cannot move root node or to root node");
}
}
protected void validateDestinationContainer(ShortNodeDescriptor snd, String destinationVosPath) {
if (snd.isBusy()) {
throw new NodeBusyException(destinationVosPath);
}
if (snd.isPermissionDenied()) {
throw new PermissionDeniedException(destinationVosPath);
}
if (!snd.isWritable()) {
throw new InternalFaultException("Destination is not writable: " + destinationVosPath);
}
if (!snd.isContainer()) {
throw new InternalFaultException("Existing destination is not a container: " + destinationVosPath);
}
}
}
AsyncTransferService.java 0000664 0000000 0000000 00000005133 14140552775 0034262 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import com.fasterxml.jackson.databind.ObjectMapper;
import it.inaf.oats.vospace.exception.InternalFaultException;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import net.ivoa.xml.uws.v1.JobSummary;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
@Service
public class AsyncTransferService {
private static final Logger LOG = LoggerFactory.getLogger(AsyncTransferService.class);
private static final ObjectMapper MAPPER = new ObjectMapper();
private final JedisPool jedisPool;
public AsyncTransferService(@Value("${spring.redis.host}") String redisHost, @Value("${spring.redis.port}") int redisPort) {
// To avoid receiving a JedisConnectionException when redis server is
// restarted a JedisPool with proper configuration is used.
JedisPoolConfig poolConfig = new JedisPoolConfig();
poolConfig.setTestOnBorrow(true); // sends a ping request when asking for the resource
poolConfig.setTestWhileIdle(true); // sends periodic pings to idle resources in the pool
jedisPool = new JedisPool(poolConfig, redisHost, redisPort);
}
public JobSummary startJob(JobSummary job) {
try (Jedis jedis = jedisPool.getResource()) {
String requestId = job.getJobId();
Map data = new HashMap<>();
data.put("req_id", requestId);
data.put("job", job);
String message = MAPPER.writeValueAsString(data);
jedis.lpush("start_job_queue", message);
List popData = jedis.brpop(30, requestId);
String result = null;
for (String value : popData) {
// first result is requestId, second is JSON payload
if (!requestId.equals(value)) {
result = value;
}
}
if (result == null) {
throw new IllegalStateException("Job data not found in redis");
}
LOG.trace("Transfer service answered:\n{}", result);
return MAPPER.readValue(result, JobSummary.class);
} catch (IOException ex) {
throw new InternalFaultException(ex);
}
}
}
BaseNodeController.java 0000664 0000000 0000000 00000005167 14140552775 0033712 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import it.inaf.oats.vospace.exception.InvalidArgumentException;
import it.inaf.oats.vospace.exception.InvalidURIException;
import javax.servlet.http.HttpServletRequest;
import net.ivoa.xml.vospace.v2.LinkNode;
import net.ivoa.xml.vospace.v2.Node;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import static org.springframework.web.servlet.function.RequestPredicates.path;
public abstract class BaseNodeController {
@Autowired
private HttpServletRequest servletRequest;
@Value("${vospace-authority}")
protected String authority;
protected String getPath() {
String requestURL = servletRequest.getRequestURL().toString();
try {
return NodeUtils.getPathFromRequestURLString(requestURL);
} catch (IllegalArgumentException ex) {
throw new InvalidURIException(ex);
}
}
protected String getParentPath(String path) {
return NodeUtils.getParentPath(path);
}
protected void validateAndCheckPayloadURIConsistence(Node node) {
// Get Node path (and validates it too)
String decodedURIPathFromNode = URIUtils.returnVosPathFromNodeURI(node.getUri(), this.authority);
// Check if payload URI is consistent with http request
String requestPath = this.getPath();
if (!decodedURIPathFromNode.equals(this.getPath())) {
throw new InvalidURIException(decodedURIPathFromNode, requestPath);
}
}
protected void validateLinkNode(LinkNode linkNode) {
String target = linkNode.getTarget();
// I validate it here to add context easily
if (target == null) {
throw new InvalidArgumentException("LinkNode in payload has no target element specified");
}
if (URIUtils.isURIInternal(target)) {
URIUtils.returnVosPathFromNodeURI(linkNode.getTarget(), authority);
} else {
// TODO: Let's discuss if we need to combine this validation with
// protocol endpoints management (URIService, ProtocolType)
// Let's start with http and https only for now
if (!(target.toLowerCase().startsWith("http://")
|| target.toLowerCase().startsWith("https://"))) {
throw new InvalidArgumentException("LinkNode target malformed or unsupported protocol: " + target);
}
}
}
}
CapabilitiesController.java 0000664 0000000 0000000 00000004304 14140552775 0034613 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import java.io.IOException;
import java.io.InputStream;
import java.util.Scanner;
import javax.servlet.http.HttpServletRequest;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.util.UriComponentsBuilder;
@RestController
public class CapabilitiesController {
@Autowired
private HttpServletRequest request;
@GetMapping(value = "/capabilities", produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE})
public String getCapabilities() throws IOException {
String xml = loadCapabilitiesXmlTemplate();
return xml.replace("{{ base_url }}", getBaseUrl());
}
private String loadCapabilitiesXmlTemplate() throws IOException {
try ( InputStream in = CapabilitiesController.class.getClassLoader().getResourceAsStream("capabilities.xml")) {
Scanner s = new Scanner(in).useDelimiter("\\A");
return s.hasNext() ? s.next() : "";
}
}
/**
* Generate base URL considering also proxied requests.
*/
private String getBaseUrl() {
String forwaredProtocol = request.getHeader("X-Forwarded-Proto");
String scheme = forwaredProtocol != null ? forwaredProtocol : request.getScheme();
String forwardedHost = request.getHeader("X-Forwarded-Host");
if (forwardedHost != null && forwardedHost.contains(",")) {
// X-Forwarded-Host can be a list of comma separated values
forwardedHost = forwardedHost.split(",")[0];
}
String host = forwardedHost != null ? forwardedHost : request.getServerName();
UriComponentsBuilder builder = UriComponentsBuilder.newInstance()
.scheme(scheme).host(host).path(request.getContextPath());
if (forwardedHost == null) {
builder.port(request.getServerPort());
}
return builder.toUriString();
}
}
CopyService.java 0000664 0000000 0000000 00000011600 14140552775 0032406 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import it.inaf.oats.vospace.exception.DuplicateNodeException;
import it.inaf.oats.vospace.exception.NodeBusyException;
import it.inaf.oats.vospace.exception.NodeNotFoundException;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import it.inaf.oats.vospace.persistence.NodeDAO.ShortNodeDescriptor;
import java.util.List;
import java.util.Optional;
import net.ivoa.xml.vospace.v2.Transfer;
import org.springframework.dao.CannotSerializeTransactionException;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import org.springframework.transaction.annotation.Isolation;
import org.springframework.transaction.annotation.Transactional;
@Service
@EnableTransactionManagement
public class CopyService extends AbstractNodeService {
@Transactional(rollbackFor = {Exception.class}, isolation = Isolation.REPEATABLE_READ)
public List processCopyNodes(Transfer transfer, String jobId, User user) {
// Get Source Vos Path
String sourcePath = URIUtils.returnVosPathFromNodeURI(transfer.getTarget(), authority);
// Get Destination Vos Path (it's in transfer direction)
String destinationPath = URIUtils.returnVosPathFromNodeURI(transfer.getDirection(), authority);
// Destination source to be returned, null if no copy was performed
String destinationCopyRoot = null;
this.validatePath(sourcePath);
this.validatePath(destinationPath);
if (sourcePath.equals(destinationPath)) {
throw new IllegalArgumentException("Cannot copy node to itself");
}
// Check if destination is subpath of source
// Linux-like: "cannot copy to a subdirectory of itself"
if (destinationPath.startsWith(sourcePath + "/")) {
throw new IllegalArgumentException("Cannot copy node to a subdirectory of its own path");
}
// Check if destination equals parent path of source
if (NodeUtils.getParentPath(sourcePath).equals(destinationPath)) {
throw new IllegalArgumentException("Cannot duplicate node at same path without renaming it");
}
try {
// check source branch for read and lock it
this.checkBranchForReadAndLock(sourcePath, jobId, user);
// Check destination
Optional destShortNodeDescriptor
= nodeDao.getShortNodeDescriptor(destinationPath, user.getName(), user.getGroups());
if (destShortNodeDescriptor.isPresent()) {
this.validateDestinationContainer(destShortNodeDescriptor.get(), destinationPath);
destinationCopyRoot = destinationPath + "/" + NodeUtils.getNodeName(sourcePath);
} else {
// Check if parent exists
String destinationParentPath = NodeUtils.getParentPath(destinationPath);
Optional destShortNodeDescriptorParent
= nodeDao.getShortNodeDescriptor(destinationParentPath, user.getName(), user.getGroups());
if (destShortNodeDescriptorParent.isPresent()) {
this.validateDestinationContainer(destShortNodeDescriptorParent.get(), destinationParentPath);
destinationCopyRoot = destinationPath;
} else {
throw new UnsupportedOperationException("Creation of destination upon copy not supported");
}
}
nodeDao.copyBranch(
sourcePath,
destinationCopyRoot);
} catch (CannotSerializeTransactionException ex) {
// Concurrent transactions attempted to modify this set of nodes
throw new NodeBusyException(sourcePath);
} catch (DuplicateKeyException ex) {
throw new DuplicateNodeException(destinationCopyRoot);
}
return List.of(sourcePath, destinationCopyRoot);
}
private void checkBranchForReadAndLock(String sourcePath, String jobId, User user) {
// Get source node
Optional sourceIdOpt = nodeDao.getNodeId(sourcePath);
long sourceId = sourceIdOpt.orElseThrow(() -> new NodeNotFoundException(sourcePath));
if (nodeDao.isBranchBusy(sourceId)) {
throw new NodeBusyException(sourcePath);
}
if (!nodeDao.isBranchReadable(sourceId, user.getName(), user.getGroups())) {
throw new PermissionDeniedException(sourcePath);
}
nodeDao.setBranchJobId(sourceId, jobId);
}
}
CreateNodeController.java 0000664 0000000 0000000 00000003313 14140552775 0034232 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import net.ivoa.xml.vospace.v2.LinkNode;
import net.ivoa.xml.vospace.v2.Node;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PutMapping;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@RestController
public class CreateNodeController extends BaseNodeController {
private static final Logger LOG = LoggerFactory.getLogger(CreateNodeController.class);
@Autowired
private CreateNodeService createNodeService;
@PutMapping(value = {"/nodes", "/nodes/**"},
consumes = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE},
produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public Node createNode(@RequestBody Node node, User principal) {
String path = getPath();
LOG.debug("createNodeController called for node with URI {} and PATH {}", node.getUri(), path);
this.validateAndCheckPayloadURIConsistence(node);
// validate format of input node
this.validateInputNode(node);
return createNodeService.createNode(node, path, principal);
}
private void validateInputNode(Node node) {
if (node instanceof LinkNode) {
this.validateLinkNode((LinkNode) node);
}
}
}
CreateNodeService.java 0000664 0000000 0000000 00000011247 14140552775 0033514 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.NodeProperties;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import it.inaf.oats.vospace.exception.ContainerNotFoundException;
import it.inaf.oats.vospace.exception.DuplicateNodeException;
import it.inaf.oats.vospace.exception.LinkFoundException;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import it.inaf.oats.vospace.persistence.NodeDAO;
import net.ivoa.xml.vospace.v2.Node;
import net.ivoa.xml.vospace.v2.Property;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@Service
@EnableTransactionManagement
public class CreateNodeService {
@Autowired
private NodeDAO nodeDao;
private static final Logger LOG = LoggerFactory.getLogger(CreateNodeService.class);
public Node createNode(Node node, String path, User principal) {
LOG.debug("createNodeService called for node with URI {} and PATH {}", node.getUri(), path);
// Check if another node is already present at specified path
// This checks if the user is trying to insert the root node at "/" too
if (nodeDao.listNode(path).isPresent()) {
throw new DuplicateNodeException(path);
}
// Retrieve parent node
Node parentNode = nodeDao.listNode(getParentPath(path))
.orElseThrow(() -> new ContainerNotFoundException(getParentPath(path)));
// Check if parent node is not a Container node and in case throw
// appropriate exception
if (!parentNode.getType().equals("vos:ContainerNode")) {
if (parentNode.getType().equals("vos:LinkNode")) {
throw new LinkFoundException(getParentPath(path));
} else {
throw new ContainerNotFoundException(getParentPath(path));
}
}
if (!NodeUtils.checkIfWritable(parentNode, principal.getName(), principal.getGroups())) {
throw PermissionDeniedException.forPath(path);
}
// Check if node creator property is set. If not set it according to
// token. In case of creator mistmatch between node and token throw
// exception
String creator = NodeProperties.getNodePropertyByURI(
node, NodeProperties.CREATOR_URI);
if (creator == null) {
Property creatorProperty = new Property();
creatorProperty.setUri(NodeProperties.CREATOR_URI);
creatorProperty.setValue(principal.getName());
node.getProperties().add(creatorProperty);
} else {
if (!creator.equals(principal.getName())) // maybe a more specific exception would be more appropriate?
{
throw PermissionDeniedException.forPath(path);
}
}
// If payload has no read groups specified, inherit from parent node
String payloadReadGroups = NodeProperties.getNodePropertyByURI(
node, NodeProperties.GROUP_READ_URI);
if (payloadReadGroups == null) {
String parentNodeReadGroups = NodeProperties.getNodePropertyByURI(
parentNode, NodeProperties.GROUP_READ_URI);
if (parentNodeReadGroups != null) {
Property readGroups = new Property();
readGroups.setUri(NodeProperties.GROUP_READ_URI);
readGroups.setValue(parentNodeReadGroups);
node.getProperties().add(readGroups);
}
}
// If payload has no write groups specified, inherit from parent node
String payloadWriteGroups = NodeProperties.getNodePropertyByURI(
node, NodeProperties.GROUP_WRITE_URI);
if (payloadWriteGroups == null) {
String parentNodeWriteGroups = NodeProperties.getNodePropertyByURI(
parentNode, NodeProperties.GROUP_WRITE_URI);
if (parentNodeWriteGroups != null) {
Property writeGroups = new Property();
writeGroups.setUri(NodeProperties.GROUP_WRITE_URI);
writeGroups.setValue(parentNodeWriteGroups);
node.getProperties().add(writeGroups);
}
}
nodeDao.createNode(node);
return node;
}
private String getParentPath(String path) {
return NodeUtils.getParentPath(path);
}
}
DeleteNodeController.java 0000664 0000000 0000000 00000007034 14140552775 0034235 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import it.inaf.oats.vospace.exception.LinkFoundException;
import it.inaf.oats.vospace.exception.NodeNotFoundException;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import it.inaf.oats.vospace.persistence.NodeDAO;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import net.ivoa.xml.vospace.v2.Node;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class DeleteNodeController extends BaseNodeController {
private static final Logger LOG = LoggerFactory.getLogger(DeleteNodeController.class);
@Autowired
private NodeDAO nodeDAO;
@DeleteMapping(value = {"/nodes", "/nodes/**"},
produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity deleteNode(HttpServletRequest request, User principal) {
String path = getPath();
LOG.debug("deleteNode called for path {}", path);
// Check if the node is present,
// if the node does not exist the service SHALL throw a HTTP 404 status code
// including a NodeNotFound fault in the entity-body
// If note present, got it
Node toBeDeletedNode = nodeDAO.listNode(path)
.orElseThrow(() -> new NodeNotFoundException(path));
// If a parent node in the URI path is a LinkNode, the service SHALL throw
// a HTTP 400 status code including a LinkFound fault in the entity-body.
// For example, given the URI path /a/b/c, the service must throw a HTTP 400
// status code including a LinkFound fault in the entity-body if either /a
// or /a/b are LinkNodes.
List pathComponents = NodeUtils.subPathComponents(path);
if (pathComponents.isEmpty()) {
// Manage root node
throw PermissionDeniedException.forPath("/");
} else {
// Manage all precursors in full path
for (int i = 0; i < pathComponents.size(); i++) {
String tmpPath = pathComponents.get(i);
Node mynode = nodeDAO.listNode(tmpPath)
.orElseThrow(() -> new NodeNotFoundException(tmpPath));
if (mynode.getType().equals("vos:LinkNode") && i < pathComponents.size()-1) // a LinkNode leaf can be deleted
throw new LinkFoundException(tmpPath);
}
}
if (!NodeUtils.checkIfWritable(toBeDeletedNode, principal.getName(), principal.getGroups())) {
throw PermissionDeniedException.forPath(path);
}
try {
nodeDAO.deleteNode(path);
return ResponseEntity.ok("Node deleted");
} catch(Exception ex) {
return new ResponseEntity<>(ex.getMessage(), HttpStatus.BAD_REQUEST);
}
}
}
ErrorController.java 0000664 0000000 0000000 00000001164 14140552775 0033314 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.oats.vospace.exception.DefaultErrorController;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.error.ErrorAttributes;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ErrorController extends DefaultErrorController {
@Autowired
public ErrorController(ErrorAttributes errorAttributes) {
super(errorAttributes);
}
}
FileServiceClient.java 0000664 0000000 0000000 00000014573 14140552775 0033526 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import com.fasterxml.jackson.databind.ObjectMapper;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.Views;
import it.inaf.oats.vospace.exception.InvalidArgumentException;
import it.inaf.oats.vospace.parent.exchange.ArchiveEntryDescriptor;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
import javax.servlet.http.HttpServletRequest;
import net.ivoa.xml.vospace.v2.Transfer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;
import static org.springframework.web.servlet.mvc.method.RequestMappingInfo.paths;
@Component
public class FileServiceClient {
private static final ObjectMapper MAPPER = new ObjectMapper();
@Value("${vospace-authority}")
private String authority;
@Value("${file-service-url}")
private String fileServiceUrl;
@Autowired
private RestTemplate restTemplate;
@Autowired
private HttpServletRequest request;
@Autowired
private LinkService linkService;
public String startArchiveJob(Transfer transfer, String jobId) {
String target = transfer.getTarget().substring("vos://".length() + authority.length());
String viewUri = transfer.getView().getUri();
// Generate list of paths using view include parameters
List vosPaths = transfer.getView().getParam().stream()
.map(p -> {
if (p.getUri().equals(viewUri + "/include")) {
if (p.getValue().contains("../")) {
throw new InvalidArgumentException("Relative paths are not supported");
}
return target + "/" + p.getValue();
} else {
throw new InvalidArgumentException("Unsupported view parameter: " + p.getUri());
}
})
.collect(Collectors.toList());
if (vosPaths.isEmpty()) {
// Add target path
vosPaths.add(target);
}
// OK generate descriptors
// follow links to links in vosPaths
List entryDescriptors = linkService.followLinksForArchiveService(vosPaths);
ArchiveRequest archiveRequest = new ArchiveRequest();
archiveRequest.setJobId(jobId);
archiveRequest.setEntryDescriptors(entryDescriptors);
archiveRequest.setType(archiveTypeFromViewUri(transfer.getView().getUri()));
String url = fileServiceUrl + "/archive";
String token = ((User) request.getUserPrincipal()).getAccessToken();
return restTemplate.execute(url, HttpMethod.POST, req -> {
HttpHeaders headers = req.getHeaders();
if (token != null) {
headers.setBearerAuth(token);
}
headers.setContentType(MediaType.APPLICATION_JSON);
try (OutputStream os = req.getBody()) {
MAPPER.writeValue(os, archiveRequest);
}
}, res -> {
return res.getHeaders().getLocation().toString();
}, new Object[]{});
}
public void startFileCopyJob(String sourceVosPath,
String destiantionVosPath, String jobId, User user) {
CopyRequest copyRequest = new CopyRequest();
copyRequest.setJobId(jobId);
copyRequest.setSourceRootVosPath(sourceVosPath);
copyRequest.setDestinationRootVosPath(destiantionVosPath);
String url = fileServiceUrl + "/copy";
String token = user.getAccessToken();
restTemplate.execute(url, HttpMethod.POST, req -> {
HttpHeaders headers = req.getHeaders();
if (token != null) {
headers.setBearerAuth(token);
}
headers.setContentType(MediaType.APPLICATION_JSON);
try (OutputStream os = req.getBody()) {
MAPPER.writeValue(os, copyRequest);
}
}, res -> {
return null;
}, new Object[]{});
}
public static class CopyRequest {
private String jobId;
private String sourceRootVosPath;
private String destinationRootVosPath;
public String getJobId() {
return jobId;
}
public void setJobId(String jobId) {
this.jobId = jobId;
}
public String getSourceRootVosPath() {
return sourceRootVosPath;
}
public void setSourceRootVosPath(String sourceRootVosPath) {
this.sourceRootVosPath = sourceRootVosPath;
}
public String getDestinationRootVosPath() {
return destinationRootVosPath;
}
public void setDestinationRootVosPath(String destinationRootVosPath) {
this.destinationRootVosPath = destinationRootVosPath;
}
}
public static class ArchiveRequest {
private String type;
private String jobId;
private List entryDescriptors;
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public String getJobId() {
return jobId;
}
public void setJobId(String jobId) {
this.jobId = jobId;
}
public List getEntryDescriptors() {
return entryDescriptors;
}
public void setEntryDescriptors(List entryDescriptors) {
this.entryDescriptors = entryDescriptors;
}
}
private static String archiveTypeFromViewUri(String viewUri) {
switch (viewUri) {
case Views.TAR_VIEW_URI:
return "TAR";
case Views.ZIP_VIEW_URI:
return "ZIP";
default:
throw new IllegalArgumentException("Archive type not defined for " + viewUri);
}
}
}
JobService.java 0000664 0000000 0000000 00000026471 14140552775 0032222 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.Views;
import it.inaf.oats.vospace.exception.InternalFaultException;
import it.inaf.oats.vospace.persistence.JobDAO;
import net.ivoa.xml.uws.v1.ExecutionPhase;
import net.ivoa.xml.uws.v1.JobSummary;
import net.ivoa.xml.vospace.v2.Protocol;
import net.ivoa.xml.vospace.v2.Transfer;
import it.inaf.oats.vospace.exception.ErrorSummaryFactory;
import it.inaf.oats.vospace.exception.InvalidArgumentException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import it.inaf.oats.vospace.exception.VoSpaceErrorSummarizableException;
import it.inaf.oats.vospace.persistence.NodeDAO;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Function;
import javax.servlet.http.HttpServletRequest;
import net.ivoa.xml.uws.v1.ResultReference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@Service
public class JobService {
private static final Logger LOG = LoggerFactory.getLogger(JobService.class);
@Autowired
private JobDAO jobDAO;
@Autowired
private UriService uriService;
@Autowired
private MoveService moveService;
@Autowired
private CopyService copyService;
@Autowired
private AsyncTransferService asyncTransfService;
@Autowired
private HttpServletRequest servletRequest;
@Autowired
private FileServiceClient fileServiceClient;
@Autowired
private NodeDAO nodeDao;
public enum JobDirection {
pullToVoSpace,
pullFromVoSpace,
pushToVoSpace,
pushFromVoSpace,
moveNode,
copyNode;
public static JobDirection getJobDirectionEnumFromTransfer(Transfer transfer) {
String direction = transfer.getDirection();
switch (direction) {
case "pullToVoSpace":
case "pullFromVoSpace":
case "pushToVoSpace":
case "pushFromVoSpace":
return JobDirection.valueOf(direction);
default:
if (transfer.isKeepBytes()) {
return JobDirection.copyNode;
} else {
return JobDirection.moveNode;
}
}
}
}
public void setJobPhase(JobSummary job, String phase) {
LOG.trace("Job " + job.getJobId() + " phase set to " + phase);
// TODO: check allowed job phase transitions
switch (phase) {
case "RUN":
startJob(job);
break;
case "ABORT":
throw new UnsupportedOperationException("Not implemented yet");
default:
throw new IllegalArgumentException("Invalid phase parameter: " + phase);
}
}
private void startJob(JobSummary jobSummary) {
handleJobErrors(jobSummary, job -> {
Transfer transfer = uriService.getTransfer(job);
ExecutionPhase phase;
if (isAsyncRecall(transfer)) {
// Async recall from tape jobs are queued. They will be started by VOSpace transfer service
phase = ExecutionPhase.QUEUED;
} else {
phase = ExecutionPhase.EXECUTING;
}
job.setPhase(phase);
jobDAO.updateJob(job, null);
Transfer negotiatedTransfer = null;
switch (getJobDirection(transfer)) {
case pullToVoSpace:
negotiatedTransfer = handlePullToVoSpace(job, transfer);
break;
case pullFromVoSpace:
case pushToVoSpace:
negotiatedTransfer = uriService.getNegotiatedTransfer(job, transfer);
setJobResults(job, transfer);
break;
case moveNode:
handleMoveNode(job, transfer);
break;
case copyNode:
handleCopyNode(job, transfer);
break;
default:
throw new UnsupportedOperationException("Not implemented yet");
}
// Note: ExecutionPhase can't be set to COMPLETED here because all
// the previous job are asynchronous. Each job has to set its
// completion independently. Only jobs started from the /synctrans
// endpoints are completed immediately (see createSyncJobResult() method)
return negotiatedTransfer;
});
}
private Transfer handlePullToVoSpace(JobSummary job, Transfer transfer) {
if (isAsyncRecall(transfer)) {
asyncTransfService.startJob(job);
return transfer;
}
for (Protocol protocol : transfer.getProtocols()) {
switch (protocol.getUri()) {
case "ivo://ivoa.net/vospace/core#httpget":
String nodeUri = transfer.getTarget();
String contentUri = protocol.getEndpoint();
uriService.setNodeRemoteLocation(nodeUri, contentUri);
Transfer negotiatedTransfer = uriService.getNegotiatedTransfer(job, transfer);
setJobResults(job, transfer);
// Special case: import of a node from a portal file server
// doesn't imply file transfer, so it can be set to completed
job.setPhase(ExecutionPhase.COMPLETED);
return negotiatedTransfer;
default:
throw new InvalidArgumentException("Unsupported pullToVoSpace protocol: " + protocol.getUri());
}
}
throw new InvalidArgumentException("Transfer contains no protocols");
}
private boolean isAsyncRecall(Transfer transfer) {
return transfer.getView() != null
&& Views.ASYNC_RECALL_VIEW_URI.equals(transfer.getView().getUri());
}
private void handleMoveNode(JobSummary jobSummary, Transfer transfer) {
// User data must be extracted before starting the new thread
// to avoid the "No thread-bound request found" exception
User user = (User) servletRequest.getUserPrincipal();
CompletableFuture.runAsync(() -> {
handleJobErrors(jobSummary, job -> {
moveService.processMoveJob(transfer, user);
job.setPhase(ExecutionPhase.COMPLETED);
return null;
});
});
}
private void handleCopyNode(JobSummary jobSummary, Transfer transfer) {
// User data must be extracted before starting the new thread
// to avoid the "No thread-bound request found" exception
User user = (User) servletRequest.getUserPrincipal();
CompletableFuture.runAsync(() -> {
handleJobErrors(jobSummary, job -> {
String jobId = jobSummary.getJobId();
// Index 0: source 1: destination
List sourceAndDestination = copyService.processCopyNodes(transfer, jobId, user);
// Call file service and command copy
try{
fileServiceClient.startFileCopyJob(sourceAndDestination.get(0), sourceAndDestination.get(1), jobId, user);
} catch (Exception e) {
// We decided not to purge metadata in case of failure
// just release busy nodes setting job_id = null
nodeDao.releaseBusyNodesByJobId(jobId);
throw e;
}
return null;
});
});
}
private void handleJobErrors(JobSummary job, Function jobConsumer) {
Transfer negotiatedTransfer = null;
try {
negotiatedTransfer = jobConsumer.apply(job);
} catch (VoSpaceErrorSummarizableException e) {
job.setPhase(ExecutionPhase.ERROR);
job.setErrorSummary(ErrorSummaryFactory.newErrorSummary(e));
} catch (Exception e) {
job.setPhase(ExecutionPhase.ERROR);
job.setErrorSummary(ErrorSummaryFactory.newErrorSummary(
new InternalFaultException(e)));
} finally {
jobDAO.updateJob(job, negotiatedTransfer);
}
}
private JobDirection getJobDirection(Transfer transfer) {
return JobDirection.getJobDirectionEnumFromTransfer(transfer);
}
/**
* Synchronous transfer endpoint creates a job that is immediately set to
* COMPLETED or to ERROR in case some fault occurred.
*
* In case of ERROR, Protocols are stripped from job representation in
* compliance with specifications
*
*/
public Optional createSyncJobResult(JobSummary job) {
Transfer negotiatedTransfer = null;
VoSpaceErrorSummarizableException exception = null;
try {
Transfer transfer = uriService.getTransfer(job);
negotiatedTransfer = uriService.getNegotiatedTransfer(job, transfer);
setJobResults(job, transfer);
job.setPhase(ExecutionPhase.COMPLETED);
// Need to catch other exceptions too to avoid inconsistent job status
} catch (VoSpaceErrorSummarizableException e) {
job.setPhase(ExecutionPhase.ERROR);
stripProtocols(job, negotiatedTransfer);
job.setErrorSummary(ErrorSummaryFactory.newErrorSummary(e));
exception = e;
} catch (Exception e) {
job.setPhase(ExecutionPhase.ERROR);
stripProtocols(job, negotiatedTransfer);
exception = new InternalFaultException(e);
job.setErrorSummary(ErrorSummaryFactory.newErrorSummary(exception));
} finally {
jobDAO.createJob(job, negotiatedTransfer);
}
return Optional.ofNullable(exception);
}
private void stripProtocols(JobSummary job, Transfer negotiatedTransfer) {
uriService.getTransfer(job).getProtocols().clear();
if (negotiatedTransfer != null) {
negotiatedTransfer.getProtocols().clear();
}
}
private void setJobResults(JobSummary jobSummary, Transfer transfer) {
String baseUrl = servletRequest.getRequestURL().substring(0,
servletRequest.getRequestURL().indexOf(servletRequest.getContextPath()));
String href = baseUrl + servletRequest.getContextPath()
+ "/transfers/" + jobSummary.getJobId() + "/results/transferDetails";
ResultReference transferDetailsRef = new ResultReference();
transferDetailsRef.setId("transferDetails");
transferDetailsRef.setHref(href);
jobSummary.getResults().add(transferDetailsRef);
switch (getJobDirection(transfer)) {
case pullFromVoSpace:
case pushToVoSpace:
ResultReference dataNodeRef = new ResultReference();
dataNodeRef.setId("dataNode");
dataNodeRef.setHref(transfer.getTarget());
jobSummary.getResults().add(dataNodeRef);
break;
}
}
}
LinkService.java 0000664 0000000 0000000 00000007374 14140552775 0032406 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import it.inaf.oats.vospace.exception.InternalFaultException;
import it.inaf.oats.vospace.parent.exchange.ArchiveEntryDescriptor;
import it.inaf.oats.vospace.persistence.NodeDAO;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import net.ivoa.xml.vospace.v2.LinkNode;
import net.ivoa.xml.vospace.v2.Node;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
@Service
public class LinkService {
@Value("${vospace-authority}")
private String authority;
@Value("${link-max-depth}")
private int linkMaxDepth;
@Autowired
private NodeDAO nodeDao;
// Returns a new list = the list in argument with paths of links to links are substituted with
// their actual destination vos path. Only links to external resources
// (http:// ... ) should remain
public List followLinksForArchiveService(List vosPaths) {
List linkNodesInPaths = nodeDao.returnLinkNodesInList(vosPaths);
// No links no change
if(linkNodesInPaths.isEmpty())
return vosPaths.stream().map(p -> new ArchiveEntryDescriptor(p))
.collect(Collectors.toList());
List linkVosPaths = linkNodesInPaths.stream()
.map(ln -> NodeUtils.getVosPath(ln)).collect(Collectors.toList());
// Safe copy of argument
List resultVosPaths = new ArrayList<>(vosPaths);
resultVosPaths.removeAll(linkVosPaths);
// Generate descriptors from non link vospaths
List resultDescriptors =
resultVosPaths.stream().map(p -> new ArchiveEntryDescriptor(p))
.collect(Collectors.toList());
// Add descriptors from links
resultDescriptors.addAll(
linkNodesInPaths.stream().map(p -> getLinkNodeArchiveEntryDescriptor(p))
.collect(Collectors.toList())
);
return resultDescriptors;
}
private ArchiveEntryDescriptor getLinkNodeArchiveEntryDescriptor(LinkNode node){
String vosPath = NodeUtils.getVosPath(node);
String targetNodeVosPath = NodeUtils.getVosPath(this.followLink(node));
return new ArchiveEntryDescriptor(vosPath, targetNodeVosPath);
}
public Node followLink(LinkNode linkNode) {
return this.followLinkRecursive(linkNode, 0);
}
private Node followLinkRecursive(LinkNode linkNode, int depth) {
if (depth >= linkMaxDepth) {
throw new InternalFaultException("Max link depth reached at link node: "
+ NodeUtils.getVosPath(linkNode));
}
String linkTarget = linkNode.getTarget();
if (URIUtils.isURIInternal(linkTarget)) {
String targetPath = URIUtils.returnVosPathFromNodeURI(linkTarget, authority);
Optional targetNodeOpt = nodeDao.listNode(targetPath);
Node targetNode = targetNodeOpt.orElseThrow(() -> new InternalFaultException("Broken Link to target: " + targetPath));
if (targetNode instanceof LinkNode) {
return this.followLinkRecursive(linkNode, ++depth);
} else {
return targetNode;
}
} else {
return linkNode;
}
}
}
ListNodeController.java 0000664 0000000 0000000 00000004741 14140552775 0033750 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.oats.vospace.exception.NodeNotFoundException;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.http.ResponseEntity;
import net.ivoa.xml.vospace.v2.Node;
import net.ivoa.xml.vospace.v2.ContainerNode;
import it.inaf.oats.vospace.persistence.NodeDAO;
import javax.servlet.http.HttpServletRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.MediaType;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import java.util.Optional;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import java.util.stream.Collectors;
import java.util.List;
@RestController
public class ListNodeController extends BaseNodeController {
private static final Logger LOG = LoggerFactory.getLogger(ListNodeController.class);
@Autowired
private NodeDAO nodeDAO;
@GetMapping(value = {"/nodes", "/nodes/**"},
produces = {MediaType.APPLICATION_XML_VALUE, MediaType.APPLICATION_JSON_VALUE, MediaType.TEXT_XML_VALUE})
public ResponseEntity listNode(HttpServletRequest request, User principal) {
String path = getPath();
LOG.debug("listNode called for path {}", path);
Optional optNode = nodeDAO.listNode(path);
if (optNode.isEmpty()) {
throw new NodeNotFoundException(path);
} else {
if (!NodeUtils.checkIfReadable(
optNode.get(), principal.getName(), principal.getGroups())) {
throw PermissionDeniedException.forPath(path);
}
}
Node node = optNode.get();
if (node instanceof ContainerNode) {
ContainerNode cnd = (ContainerNode) node;
List children
= cnd.getNodes().stream().filter(
(n) -> NodeUtils.checkIfReadable(
n, principal.getName(),
principal.getGroups()))
.collect(Collectors.toList());
cnd.setNodes(children);
optNode = Optional.of(cnd);
}
return ResponseEntity.ok(optNode.get());
}
}
MoveService.java 0000664 0000000 0000000 00000012612 14140552775 0032406 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import it.inaf.oats.vospace.exception.DuplicateNodeException;
import it.inaf.oats.vospace.exception.InternalFaultException;
import it.inaf.oats.vospace.exception.NodeBusyException;
import it.inaf.oats.vospace.exception.NodeNotFoundException;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import it.inaf.oats.vospace.persistence.NodeDAO.ShortNodeDescriptor;
import java.util.Optional;
import net.ivoa.xml.vospace.v2.Transfer;
import org.springframework.dao.CannotSerializeTransactionException;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.EnableTransactionManagement;
import org.springframework.transaction.annotation.Isolation;
import org.springframework.transaction.annotation.Transactional;
@Service
@EnableTransactionManagement
public class MoveService extends AbstractNodeService {
/**
* Perform modeNode operation. User is passed as parameter because this method
* is run in a separate thread and original HttpServletRequest is not available
* anymore ("No thread-bound request found" would happen).
*/
@Transactional(rollbackFor = { Exception.class }, isolation = Isolation.REPEATABLE_READ)
public void processMoveJob(Transfer transfer, User user) {
// Get Source Vos Path
String sourcePath = URIUtils.returnVosPathFromNodeURI(transfer.getTarget(), authority);
// Get Destination Vos Path (it's in transfer direction)
String destinationPath = URIUtils.returnVosPathFromNodeURI(transfer.getDirection(), authority);
// Generic common validation for move process job paths
this.validatePath(sourcePath);
this.validatePath(destinationPath);
if (sourcePath.equals(destinationPath)) {
throw new IllegalArgumentException("Cannot move node to itself");
}
// Check if destination is subpath of source
// Linux-like: "cannot move to a subdirectory of itself"
if(destinationPath.startsWith(sourcePath+"/")) {
throw new IllegalArgumentException("Cannot move node to a subdirectory of its own path");
}
// Check if destination equals parent path of source
if(NodeUtils.getParentPath(sourcePath).equals(destinationPath)){
return;
}
try {
// Get source node
Optional sourceIdOpt = nodeDao.getNodeId(sourcePath);
long sourceId = sourceIdOpt.orElseThrow(() -> new NodeNotFoundException(sourcePath));
if (nodeDao.isBranchBusy(sourceId)) {
throw new NodeBusyException(sourcePath);
}
if (!nodeDao.isBranchWritable(sourceId, user.getName(), user.getGroups())) {
throw PermissionDeniedException.forPath(sourcePath);
}
Optional destShortNodeDescriptor
= nodeDao.getShortNodeDescriptor(destinationPath, user.getName(), user.getGroups());
String destinationNodeLtreePath = null;
if (destShortNodeDescriptor.isPresent()) {
// When the destination is an existing ContainerNode, the source SHALL be placed under it (i.e., within the container)
ShortNodeDescriptor snd = destShortNodeDescriptor.get();
if(snd.isBusy()) throw new NodeBusyException(destinationPath);
if(snd.isPermissionDenied()) throw PermissionDeniedException.forPath(destinationPath);
if(!snd.isWritable()) throw new InternalFaultException("Destination is not writable: "+ destinationPath);
if(!snd.isContainer()) throw new InternalFaultException("Existing destination is not a container: " + destinationPath);
destinationNodeLtreePath = snd.getDestinationNodeLtreePath();
} else {
// Compare source and destination paths parents and see if it's just a rename
if (NodeUtils.getParentPath(sourcePath)
.equals(NodeUtils.getParentPath(destinationPath))) {
nodeDao.renameNode(sourceId, NodeUtils.getLastPathElement(destinationPath));
} else {
throw new UnsupportedOperationException("Creation of destination upon move not supported");
// TODO (if we want this): modify the return type of createDestination to obtain an ltree path
// parentDestLtree = this.createDestination(NodeUtils.getParentPath(destinationPath), user);
}
}
if (destinationNodeLtreePath != null) {
nodeDao.moveNodeBranch(sourceId, destinationNodeLtreePath);
}
} catch (CannotSerializeTransactionException ex) {
// Concurrent transactions attempted to modify this set of nodes
throw new NodeBusyException(sourcePath);
} catch (DuplicateKeyException ex) {
throw new DuplicateNodeException(destinationPath);
}
}
}
SetNodeController.java 0000664 0000000 0000000 00000015212 14140552775 0033563 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import it.inaf.oats.vospace.exception.NodeNotFoundException;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import it.inaf.oats.vospace.persistence.NodeDAO;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import net.ivoa.xml.vospace.v2.DataNode;
import net.ivoa.xml.vospace.v2.LinkNode;
import net.ivoa.xml.vospace.v2.Node;
import net.ivoa.xml.vospace.v2.View;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SetNodeController extends BaseNodeController {
private static final Logger LOG = LoggerFactory.getLogger(SetNodeController.class);
@Autowired
private NodeDAO nodeDao;
@PostMapping(value = {"/nodes", "/nodes/**"},
consumes = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE},
produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity setNode(@RequestBody Node node, User principal, HttpServletRequest request,
@RequestParam(value = "recursive", required = false, defaultValue = "false") boolean recursive) {
String path = getPath();
LOG.debug("setNode called for path {}", path);
// Validate and check payload node URI consistence with request
this.validateAndCheckPayloadURIConsistence(node);
//The service SHALL throw a HTTP 404 status code including a NodeNotFound
//fault in the entity-body if the target Node does not exist
Node toBeModifiedNode = nodeDao.listNode(path)
.orElseThrow(() -> new NodeNotFoundException(path));
// The service SHALL throw a HTTP 403 status code including a PermissionDenied fault
// in the entity-body if the user does not have permissions to perform the operation
if (!NodeUtils.checkIfWritable(toBeModifiedNode, principal.getName(), principal.getGroups())) {
throw PermissionDeniedException.forPath(path);
}
// The service SHALL throw a HTTP 403 status code including a PermissionDenied fault
// in the entity-body if the request attempts to modify a read-only Property.
// This method cannot be used to modify the Node type.
String storedNodeType = toBeModifiedNode.getType();
String newNodeType = node.getType();
if (!storedNodeType.equals(newNodeType)) {
LOG.debug("setNode trying to modify type. Stored ", storedNodeType + ", requested " + newNodeType);
throw PermissionDeniedException.forPath(path);
}
// This method cannot be used to modify the accepts or provides list of Views for the Node.
// Only DataNodes has Views (see VOSpace Data Model)
// Also if input node is LinkNode, target must be validated as internal URI
if (node instanceof DataNode) {
checkViews((DataNode) node, (DataNode) toBeModifiedNode);
} else if(node instanceof LinkNode) {
this.validateLinkNode((LinkNode) node);
}
//The service SHOULD throw a HTTP 500 status code including an InternalFault fault
// in the entity-body if the operation fails
// Done in NodeDAO
// to be fixed
// A HTTP 200 status code and a Node representation in the entity-body The full
// expanded record for the node SHALL be returned, including any xsi:type
// specific extensions.
return ResponseEntity.ok(nodeDao.setNode(node, recursive));
}
private void checkViews(DataNode requestedDataNode, DataNode savedDataNode) {
checkAcceptsView(requestedDataNode, savedDataNode);
checkProvidesView(requestedDataNode, savedDataNode);
}
private void checkAcceptsView(DataNode requestedDataNode, DataNode savedDataNode) {
List requestedAcceptedViews = requestedDataNode.getAccepts();
List savedAcceptedViews = savedDataNode.getAccepts();
// If views are present it is necessary to perform the check, otherwise
// it means that the user is not going to change them
if (!requestedAcceptedViews.isEmpty() && !checkIfViewsAreEquals(requestedAcceptedViews, savedAcceptedViews)) {
LOG.debug("setNode trying to modify accepted Views.");
throw new PermissionDeniedException("Trying to modify accepted views");
}
}
private void checkProvidesView(DataNode requestedDataNode, DataNode savedDataNode) {
List requestedProvidedViews = requestedDataNode.getProvides();
List savedProvidedViews = savedDataNode.getProvides();
// If views are present it is necessary to perform the check, otherwise
// it means that the user is not going to change them
if (!requestedProvidedViews.isEmpty() && !checkIfViewsAreEquals(requestedProvidedViews, savedProvidedViews)) {
LOG.debug("setNode trying to modify provided Views.");
throw new PermissionDeniedException("Trying to modify provided views");
}
}
private boolean checkIfViewsAreEquals(List viewsA, List viewsB) {
boolean viewsAreEqual = true;
if ((viewsA == null || viewsA.isEmpty())
&& (viewsB == null || viewsB.isEmpty())) {
return true;
}
if ((viewsA == null || viewsA.isEmpty())
|| (viewsB == null || viewsB.isEmpty())) {
return false;
}
if (viewsA.size() != viewsB.size()) {
return false;
}
for (int i = 0; i < viewsA.size(); i++) {
String viewUriA = viewsA.get(i).getUri();
boolean found = false;
for (int j = 0; j < viewsB.size(); j++) {
String viewUriB = viewsB.get(i).getUri();
if (viewUriA.compareTo(viewUriB) == 0) {
found = true;
}
}
if (found == false) {
viewsAreEqual = false;
break;
}
}
return viewsAreEqual;
}
}
TransferController.java 0000664 0000000 0000000 00000022155 14140552775 0034012 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.data.User;
import it.inaf.oats.vospace.persistence.JobDAO;
import java.util.Optional;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import net.ivoa.xml.uws.v1.ExecutionPhase;
import net.ivoa.xml.uws.v1.JobSummary;
import net.ivoa.xml.uws.v1.Jobs;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.format.annotation.DateTimeFormat;
import java.time.LocalDateTime;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import net.ivoa.xml.uws.v1.ErrorSummary;
import net.ivoa.xml.vospace.v2.Protocol;
import net.ivoa.xml.vospace.v2.Transfer;
@RestController
public class TransferController {
@Autowired
private JobDAO jobDAO;
@Autowired
private HttpServletRequest request;
@Autowired
private JobService jobService;
@PostMapping(value = "/transfers",
consumes = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE},
produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity> postAsyncTransfer(@RequestBody Transfer transfer,
@RequestParam(value = "PHASE", required = false) Optional phase, User principal) {
JobSummary jobSummary = newJobSummary(transfer, principal);
jobDAO.createJob(jobSummary, null);
if (phase.isPresent()) {
jobService.setJobPhase(jobSummary, phase.get());
}
return getJobRedirect(jobSummary.getJobId());
}
@PostMapping(value = "/synctrans",
consumes = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE},
produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity> postSyncTransfer(@RequestBody Transfer transfer, User principal) {
JobSummary jobSummary = newJobSummary(transfer, principal);
jobService.createSyncJobResult(jobSummary);
HttpHeaders headers = new HttpHeaders();
headers.set("Location", request.getContextPath() + "/transfers/" + jobSummary.getJobId() + "/results/transferDetails");
return new ResponseEntity<>(headers, HttpStatus.SEE_OTHER);
}
@GetMapping("/synctrans")
public ResponseEntity> syncTransferUrlParamsMode(@RequestParam("TARGET") String target,
@RequestParam("DIRECTION") String direction, @RequestParam("PROTOCOL") String protocolUris, User principal) {
Transfer transfer = new Transfer();
transfer.setTarget(target);
transfer.setDirection(direction);
// CADC client sends multiple protocol parameters and Spring join them using a comma separator.
// Some values seems to be duplicated, so a set is used to avoid the duplication
for (String protocolUri : new HashSet<>(Arrays.asList(protocolUris.split(",")))) {
Protocol protocol = new Protocol();
protocol.setUri(protocolUri);
transfer.getProtocols().add(protocol);
}
JobSummary jobSummary = newJobSummary(transfer, principal);
jobService.createSyncJobResult(jobSummary).ifPresent(ex -> {
// If an error occurs with the synchronous convenience mode where the preferred endpoint
// is immediately returned as a redirect, the error information is returned directly in
// the response body with the associated HTTP status code.
throw ex;
});
// Behaves as if REQUEST=redirect was set, for compatibility with CADC client
String endpoint = transfer.getProtocols().get(0).getEndpoint();
HttpHeaders headers = new HttpHeaders();
headers.set("Location", endpoint);
return new ResponseEntity<>(headers, HttpStatus.SEE_OTHER);
}
@GetMapping(value = "/transfers/{jobId}", produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity getJob(@PathVariable("jobId") String jobId) {
return jobDAO.getJob(jobId).map(j -> ResponseEntity.ok(j)).orElse(ResponseEntity.notFound().build());
}
@GetMapping(value = "/transfers/{jobId}/error", produces = {MediaType.TEXT_PLAIN_VALUE})
public ResponseEntity getJobError(@PathVariable("jobId") String jobId) {
return jobDAO.getJob(jobId).map(j -> {
if (j.getPhase().equals(ExecutionPhase.ERROR)) {
ErrorSummary e = j.getErrorSummary();
if (e.isHasDetail()) {
return ResponseEntity.ok(e.getDetailMessage());
} else {
return ResponseEntity.ok("No error details available");
}
} else {
return ResponseEntity.ok("Job is not in ERROR phase");
}
}).orElse(ResponseEntity.notFound().build());
}
@PostMapping(value = "/transfers/{jobId}/phase")
public ResponseEntity> setJobPhase(@PathVariable("jobId") String jobId, @RequestParam("PHASE") String phase, User principal) {
return jobDAO.getJob(jobId).map(job -> {
if (!job.getOwnerId().equals(principal.getName())) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
}
jobService.setJobPhase(job, phase);
return getJobRedirect(job.getJobId());
}).orElse(ResponseEntity.notFound().build());
}
@GetMapping(value = "/transfers/{jobId}/results/transferDetails", produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity> getTransferDetails(@PathVariable("jobId") String jobId, User principal) {
return jobDAO.getJob(jobId).map(job -> {
if (!job.getOwnerId().equals(principal.getName())) {
return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
}
return ResponseEntity.ok(jobDAO.getTransferDetails(jobId));
}).orElse(ResponseEntity.notFound().build());
}
@GetMapping(value = "/transfers/{jobId}/phase", produces = MediaType.TEXT_PLAIN_VALUE)
public ResponseEntity> getTransferJobPhase(@PathVariable("jobId") String jobId, User principal) {
// TODO: error handling
return ResponseEntity.ok(jobDAO.getJob(jobId).get().getPhase().toString());
}
@GetMapping(value = "/transfers", produces = {MediaType.APPLICATION_XML_VALUE, MediaType.TEXT_XML_VALUE, MediaType.APPLICATION_JSON_VALUE})
public ResponseEntity> getTransfers(
@RequestParam(value = "PHASE", required = false) Optional> phase,
@RequestParam(value = "AFTER", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) Optional after,
@RequestParam(value = "LAST", required = false) Optional last,
@RequestParam(value = "VIEW", required = false) Optional> views,
@RequestParam(value = "direction", required = false) Optional> direction,
User principal) {
if (last.isPresent()) {
if (last.get() <= 0) {
return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
}
}
String userId = principal.getName();
List phaseList = phase.orElse(List.of());
List directionList = direction.orElse(List.of());
List viewsList = views.orElse(List.of());
Jobs jobs = jobDAO.getJobs(userId, phaseList, directionList, viewsList, after, last);
return ResponseEntity.ok(jobs);
}
private JobSummary newJobSummary(Transfer transfer, User principal) {
String jobId = UUID.randomUUID().toString().replace("-", "");
JobSummary jobSummary = new JobSummary();
jobSummary.setJobId(jobId);
jobSummary.setOwnerId(principal.getName());
jobSummary.setPhase(ExecutionPhase.PENDING);
JobSummary.JobInfo jobInfo = new JobSummary.JobInfo();
jobInfo.getAny().add(transfer);
jobSummary.setJobInfo(jobInfo);
return jobSummary;
}
private ResponseEntity> getJobRedirect(String jobId) {
HttpHeaders headers = new HttpHeaders();
headers.set("Location", request.getContextPath() + "/transfers/" + jobId);
return new ResponseEntity<>(headers, HttpStatus.SEE_OTHER);
}
}
URIUtils.java 0000664 0000000 0000000 00000006520 14140552775 0031640 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.oats.vospace.exception.InternalFaultException;
import it.inaf.oats.vospace.exception.InvalidURIException;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.regex.Pattern;
import net.ivoa.xml.vospace.v2.Node;
public class URIUtils {
// It's different from the one in NodeUtils!
// Slashes are treated separately
private static final Pattern FORBIDDEN_CHARS = Pattern.compile("[\\x00\\x08\\x0B\\x0C\\x0E-\\x1F" + Pattern.quote("<>?\":\\|'`*") + "]");
private static final String SCHEME = "vos";
public static boolean isURIInternal(String URI) {
if(URI == null)
throw new IllegalArgumentException("URI can't be null");
return URI.toLowerCase().startsWith(SCHEME);
}
public static String returnURIFromVosPath(String vosPath, String authority) {
String result = null;
try {
URI uri = new URI(
SCHEME,
authority,
vosPath,
null,
null
);
result = uri.toASCIIString();
} catch (URISyntaxException e) {
throw new InternalFaultException("unable to percent encode URI from authority and path: "
+ authority + " , " + vosPath);
}
return result;
}
public static String returnVosPathFromNodeURI(Node myNode, String authority) {
return returnVosPathFromNodeURI(myNode.getUri(), authority);
}
// This method validates the URI too
public static String returnVosPathFromNodeURI(String nodeURI, String authority) {
String resultPath = null;
try {
if(nodeURI == null)
throw new IllegalArgumentException("URI string is null");
URI uri = new URI(nodeURI);
// Check scheme
if (!uri.isAbsolute()
|| uri.isOpaque()
|| !uri.getRawSchemeSpecificPart().startsWith("//")
|| !uri.getScheme().equalsIgnoreCase(SCHEME)) {
throw new InvalidURIException(nodeURI);
}
// Check authority
if (!uri.getAuthority().replace("~", "!").equals(authority)) {
throw new InvalidURIException(nodeURI);
}
// Check path
String rawPath = uri.getRawPath();
// Check if raw Path is null or contains percent encoded slashes or multiple
// separators
if (rawPath == null
|| rawPath.contains("//")
|| rawPath.contains("%2F")
|| rawPath.contains("%2f")) {
throw new InvalidURIException(nodeURI);
}
resultPath = uri.getPath();
if (resultPath.isBlank()
|| FORBIDDEN_CHARS.matcher(resultPath).find()
|| (!resultPath.equals("/") && resultPath.endsWith("/"))) {
throw new InvalidURIException(nodeURI);
}
} catch (URISyntaxException e) {
throw new InvalidURIException(nodeURI);
}
return resultPath;
}
}
UriService.java 0000664 0000000 0000000 00000031613 14140552775 0032241 0 ustar 00root root 0000000 0000000 vospace-rest-0a0539e3c8677872a5be1e36345a75b800ff11fa/src/main/java/it/inaf/oats/vospace /*
* This file is part of vospace-rest
* Copyright (C) 2021 Istituto Nazionale di Astrofisica
* SPDX-License-Identifier: GPL-3.0-or-later
*/
package it.inaf.oats.vospace;
import it.inaf.ia2.aa.ServletRapClient;
import it.inaf.ia2.aa.data.User;
import it.inaf.ia2.rap.client.call.TokenExchangeRequest;
import it.inaf.oats.vospace.JobService.JobDirection;
import it.inaf.oats.vospace.datamodel.NodeProperties;
import it.inaf.oats.vospace.datamodel.NodeUtils;
import static it.inaf.oats.vospace.datamodel.NodeUtils.urlEncodePath;
import it.inaf.oats.vospace.datamodel.Views;
import it.inaf.oats.vospace.exception.InternalFaultException;
import it.inaf.oats.vospace.exception.InvalidArgumentException;
import it.inaf.oats.vospace.exception.NodeNotFoundException;
import it.inaf.oats.vospace.exception.PermissionDeniedException;
import it.inaf.oats.vospace.exception.ProtocolNotSupportedException;
import it.inaf.oats.vospace.exception.NodeBusyException;
import it.inaf.oats.vospace.parent.persistence.LinkedServiceDAO;
import it.inaf.oats.vospace.persistence.LocationDAO;
import it.inaf.oats.vospace.persistence.NodeDAO;
import it.inaf.oats.vospace.persistence.model.Location;
import it.inaf.oats.vospace.persistence.model.LocationType;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Collectors;
import javax.servlet.http.HttpServletRequest;
import net.ivoa.xml.uws.v1.JobSummary;
import net.ivoa.xml.vospace.v2.DataNode;
import net.ivoa.xml.vospace.v2.LinkNode;
import net.ivoa.xml.vospace.v2.Node;
import net.ivoa.xml.vospace.v2.Protocol;
import net.ivoa.xml.vospace.v2.Transfer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service;
@Service
public class UriService {
@Value("${vospace-authority}")
private String authority;
@Value("${file-service-url}")
private String fileServiceUrl;
@Autowired
private NodeDAO nodeDao;
@Autowired
private LinkService linkService;
@Autowired
private LocationDAO locationDAO;
@Autowired
private LinkedServiceDAO linkedServiceDAO;
@Autowired
private HttpServletRequest servletRequest;
@Autowired
private ServletRapClient rapClient;
@Autowired
private CreateNodeService createNodeService;
@Autowired
private FileServiceClient fileServiceClient;
/**
* For a given job, returns a new transfer object containing only valid
* protocols (protocol negotiation) and sets proper endpoints on them.
*/
public Transfer getNegotiatedTransfer(JobSummary job, Transfer transfer) {
// Original transfer object shouldn't be modified, so a new transfer object is created
Transfer negotiatedTransfer = new Transfer();
negotiatedTransfer.setTarget(transfer.getTarget());
negotiatedTransfer.setDirection(transfer.getDirection());
// according to examples found in specification view is not copied
if (transfer.getProtocols().isEmpty()) {
// At least one protocol is expected from client
throw new InvalidArgumentException("Transfer contains no protocols");
}
JobService.JobDirection jobDirection
= JobDirection.getJobDirectionEnumFromTransfer(transfer);
List validProtocolTypes = new ArrayList<>();
switch (jobDirection) {
case pullFromVoSpace:
validProtocolTypes.add(ProtocolType.HTTPSGET);
case pullToVoSpace:
validProtocolTypes.add(ProtocolType.HTTPGET);
break;
case pushToVoSpace:
validProtocolTypes.add(ProtocolType.HTTPPUT);
break;
default:
throw new InternalFaultException("Unsupported job direction specified");
}
List validProtocols
= transfer.getProtocols().stream()
// discard invalid protocols by uri String
.filter(protocol
-> validProtocolTypes.stream().map(pt
-> {
return pt.getUri();
})
.collect(Collectors.toList())
.contains(protocol.getUri()))
.map(p -> {
// set endpoints
String endpoint = getEndpoint(job, transfer);
ProtocolType pt
= ProtocolType.getProtocolTypeFromURI(p.getUri());
if (pt.isEndpointCompliant(endpoint)) {
Protocol protocol = new Protocol();
protocol.setUri(p.getUri());
protocol.setEndpoint(endpoint);
return protocol;
} else {
return null;
}
}).filter(Objects::nonNull)
.collect(Collectors.toList());
if (validProtocols.isEmpty()) {
Protocol protocol = transfer.getProtocols().get(0);
throw new ProtocolNotSupportedException(protocol.getUri());
}
negotiatedTransfer.getProtocols().addAll(validProtocols);
return negotiatedTransfer;
}
private Node getEndpointNode(String relativePath,
JobService.JobDirection jobType,
User user) {
Optional optNode = nodeDao.listNode(relativePath);
if (optNode.isPresent()) {
Node node = optNode.get();
if (jobType.equals(JobService.JobDirection.pullFromVoSpace)) {
if (node instanceof LinkNode) {
if (!NodeUtils.checkIfReadable(node, user.getName(), user.getGroups())) {
throw PermissionDeniedException.forPath(relativePath);
}
node = linkService.followLink((LinkNode) node);
}
}
return node;
} else {
switch (jobType) {
case pullFromVoSpace:
throw new NodeNotFoundException(relativePath);
case pushToVoSpace:
case pullToVoSpace:
DataNode newNode = new DataNode();
newNode.setUri(URIUtils.returnURIFromVosPath(relativePath, authority));
return createNodeService.createNode(newNode, relativePath, user);
default:
throw new InternalFaultException("No supported job direction specified");
}
}
}
private String getEndpoint(JobSummary job, Transfer transfer) {
String relativePath = URIUtils.returnVosPathFromNodeURI(transfer.getTarget(), authority);
User user = (User) servletRequest.getUserPrincipal();
String creator = user.getName();
List groups = user.getGroups();
// Check privileges write or read according to job type
JobService.JobDirection jobType
= JobDirection.getJobDirectionEnumFromTransfer(transfer);
Node node = this.getEndpointNode(relativePath, jobType, user);
switch (jobType) {
case pushToVoSpace:
case pullToVoSpace:
if (!NodeUtils.checkIfWritable(node, creator, groups)) {
throw PermissionDeniedException.forPath(relativePath);
}
break;
case pullFromVoSpace:
// Refresh relative path: it can differ in case of links followed
relativePath = NodeUtils.getVosPath(node);
if (!NodeUtils.checkIfReadable(node, creator, groups)) {
throw PermissionDeniedException.forPath(relativePath);
}
break;
default:
throw new InternalFaultException("No supported job direction specified");
}
if (NodeUtils.getIsBusy(node)) {
throw new NodeBusyException(relativePath);
}
if (isArchiveView(transfer)) {
return fileServiceClient.startArchiveJob(transfer, job.getJobId());
}
boolean isLinkNode = node instanceof LinkNode;
String endpoint;
if (isLinkNode) {
endpoint = ((LinkNode) node).getTarget();
String linkTarget = ((LinkNode) node).getTarget();
if (linkedServiceDAO.isLinkedServiceUrl(linkTarget)) {
endpoint += "?token=" + getEndpointToken(linkTarget);
}
} else {
Location location = locationDAO.getNodeLocation(relativePath).orElse(null);
if (location != null && location.getType() == LocationType.PORTAL) {
String fileName = nodeDao.getNodeOsName(relativePath);
endpoint = "http://" + location.getSource().getHostname() + location.getSource().getBaseUrl();
if (!endpoint.endsWith("/")) {
endpoint += "/";
}
endpoint += fileName;
} else {
endpoint = fileServiceUrl + urlEncodePath(relativePath);
}
endpoint += "?jobId=" + job.getJobId();
if (!"true".equals(NodeProperties.getNodePropertyByURI(node, NodeProperties.PUBLIC_READ_URI))) {
endpoint += "&token=" + getEndpointToken(fileServiceUrl + relativePath);
}
}
return endpoint;
}
private boolean isArchiveView(Transfer transfer) {
if (transfer.getView() == null) {
return false;
}
String viewUri = transfer.getView().getUri();
return Views.TAR_VIEW_URI.equals(viewUri)
|| Views.ZIP_VIEW_URI.equals(viewUri);
}
private String getEndpointToken(String endpoint) {
String token = ((User) servletRequest.getUserPrincipal()).getAccessToken();
if (token == null) {
throw new PermissionDeniedException("Token is null");
}
TokenExchangeRequest exchangeRequest = new TokenExchangeRequest()
.setSubjectToken(token)
.setResource(endpoint);
// TODO: add audience and scope
return rapClient.exchangeToken(exchangeRequest, servletRequest);
}
public void setNodeRemoteLocation(String nodeUri, String contentUri) {
URL url;
try {
url = new URL(contentUri);
} catch (MalformedURLException ex) {
throw new InternalFaultException(ex);
}
Location location = locationDAO.findPortalLocation(url.getHost()).orElseThrow(()
-> new InternalFaultException("No registered location found for host " + url.getHost()));
String vosPath = URIUtils.returnVosPathFromNodeURI(nodeUri, authority);
String fileName = url.getPath().substring(url.getPath().lastIndexOf("/") + 1);
nodeDao.setNodeLocation(vosPath, location.getId(), fileName);
}
public Transfer getTransfer(JobSummary job) {
List