org.apache.juneau.microservice.resources.DirectoryResource Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.microservice.resources;
import static org.apache.juneau.common.internal.IOUtils.*;
import static org.apache.juneau.common.internal.StringUtils.*;
import static org.apache.juneau.internal.CollectionUtils.*;
import java.io.*;
import java.util.*;
import org.apache.juneau.annotation.*;
import org.apache.juneau.config.*;
import org.apache.juneau.dto.*;
import org.apache.juneau.html.annotation.*;
import org.apache.juneau.http.annotation.*;
import org.apache.juneau.http.response.*;
import org.apache.juneau.rest.*;
import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.rest.beans.*;
import org.apache.juneau.rest.servlet.*;
/**
* REST resource that allows access to a file system directory.
*
*
* The root directory is specified in one of two ways:
*
* -
* Specifying the location via a
DirectoryResource.rootDir property.
* -
* Overriding the {@link #getRootDir()} method.
*
*
*
* Read/write access control is handled through the following properties:
*
* -
*
DirectoryResource.allowViews - If true , allows view and download access to files.
* -
*
DirectoryResource.allowUploads - If true , allows files to be created or overwritten.
* -
*
DirectoryResource.allowDeletes - If true , allows files to be deleted.
*
*
* See Also:
*
* @serial exclude
*/
@Rest(
title="File System Explorer",
messages="nls/DirectoryResource",
allowedMethodParams="*"
)
@HtmlDocConfig(
navlinks={
"up: request:/..",
"api: servlet:/api"
}
)
@HtmlConfig(uriAnchorText="PROPERTY_NAME")
@SuppressWarnings("javadoc")
public class DirectoryResource extends BasicRestServlet {
private static final long serialVersionUID = 1L;
//-------------------------------------------------------------------------------------------------------------------
// Configurable properties
//-------------------------------------------------------------------------------------------------------------------
private static final String PREFIX = "DirectoryResource.";
/**
* Root directory.
*/
public static final String DIRECTORY_RESOURCE_rootDir = PREFIX + "rootDir.s";
/**
* Allow view and downloads on files.
*/
public static final String DIRECTORY_RESOURCE_allowViews = PREFIX + "allowViews.b";
/**
* Allow deletes on files.
*/
public static final String DIRECTORY_RESOURCE_allowDeletes = PREFIX + "allowDeletes.b";
/**
* Allow uploads on files.
*/
public static final String DIRECTORY_RESOURCE_allowUploads = PREFIX + "allowUploads.b";
//-------------------------------------------------------------------------------------------------------------------
// Instance
//-------------------------------------------------------------------------------------------------------------------
private final File rootDir; // The root directory
// Properties enabled through servlet init parameters
final boolean allowDeletes, allowUploads, allowViews;
public DirectoryResource(Config c) throws Exception {
rootDir = new File(c.get(DIRECTORY_RESOURCE_rootDir).orElse("."));
allowViews = c.get(DIRECTORY_RESOURCE_allowViews).asBoolean().orElse(false);
allowDeletes = c.get(DIRECTORY_RESOURCE_allowDeletes).asBoolean().orElse(false);
allowUploads = c.get(DIRECTORY_RESOURCE_allowUploads).asBoolean().orElse(false);
}
@RestGet(
path="/*",
summary="View information on file or directory",
description="Returns information about the specified file or directory."
)
@HtmlDocConfig(
nav={"Folder: $RA{fullPath}
"}
)
public FileResource getFile(RestRequest req, @Path("/*") String path) throws NotFound, Exception {
File dir = getFile(path);
req.setAttribute("fullPath", dir.getAbsolutePath());
return new FileResource(dir, path, true);
}
@RestOp(
method="VIEW",
path="/*",
summary="View contents of file",
description="View the contents of a file.\nContent-Type is set to 'text/plain'."
)
public FileContents viewFile(RestResponse res, @Path("/*") String path) throws NotFound, MethodNotAllowed {
if (! allowViews)
throw new MethodNotAllowed("VIEW not enabled");
res.setContentType("text/plain");
try {
return new FileContents(getFile(path));
} catch (FileNotFoundException e) {
throw new NotFound("File not found");
}
}
@RestOp(
method="DOWNLOAD",
path="/*",
summary="Download file",
description="Download the contents of a file.\nContent-Type is set to 'application/octet-stream'."
)
public FileContents downloadFile(RestResponse res, @Path("/*") String path) throws NotFound, MethodNotAllowed {
if (! allowViews)
throw new MethodNotAllowed("DOWNLOAD not enabled");
res.setContentType("application/octet-stream");
try {
return new FileContents(getFile(path));
} catch (FileNotFoundException e) {
throw new NotFound("File not found");
}
}
@RestDelete(
path="/*",
summary="Delete file",
description="Delete a file on the file system."
)
public RedirectToRoot deleteFile(@Path("/*") String path) throws MethodNotAllowed {
deleteFile(getFile(path));
return new RedirectToRoot();
}
@RestPut(
path="/*",
summary="Add or replace file",
description="Add or overwrite a file on the file system."
)
public RedirectToRoot updateFile(
@Content @Schema(type="string",format="binary") InputStream is,
@Path("/*") String path
) throws InternalServerError {
if (! allowUploads)
throw new MethodNotAllowed("PUT not enabled");
File f = getFile(path);
try (OutputStream os = new BufferedOutputStream(new FileOutputStream(f))) {
pipe(is, os);
} catch (IOException e) {
throw new InternalServerError(e);
}
return new RedirectToRoot();
}
//-----------------------------------------------------------------------------------------------------------------
// Helper beans
//-----------------------------------------------------------------------------------------------------------------
@Response @Schema(type="string",format="binary",description="Contents of file")
static class FileContents extends FileInputStream {
public FileContents(File file) throws FileNotFoundException {
super(file);
}
}
@Response @Schema(description="Redirect to root page on success")
static class RedirectToRoot extends SeeOtherRoot {}
@Response @Schema(description="File action")
public static class Action extends LinkString {
public Action(String name, String uri, Object...uriArgs) {
super(name, uri, uriArgs);
}
}
@Response @Schema(description="File or directory details")
@Bean(properties="type,name,size,lastModified,actions,files")
public class FileResource {
private final File f;
private final String path;
private final String uri;
private final boolean includeChildren;
public FileResource(File f, String path, boolean includeChildren) {
this.f = f;
this.path = path;
this.uri = "servlet:/"+(path == null ? "" : path);
this.includeChildren = includeChildren;
}
public String getType() {
return (f.isDirectory() ? "dir" : "file");
}
public LinkString getName() {
return new LinkString(f.getName(), uri);
}
public long getSize() {
return f.isDirectory() ? f.listFiles().length : f.length();
}
public Date getLastModified() {
return new Date(f.lastModified());
}
@Html(format=HtmlFormat.HTML_CDC)
public List getActions() throws Exception {
List l = list();
if (allowViews && f.canRead() && ! f.isDirectory()) {
l.add(new Action("view", uri + "?method=VIEW"));
l.add(new Action("download", uri + "?method=DOWNLOAD"));
}
if (allowDeletes && f.canWrite() && ! f.isDirectory())
l.add(new Action("delete", uri + "?method=DELETE"));
return l;
}
public Set getFiles() {
if (f.isFile() || ! includeChildren)
return null;
Set s = new TreeSet<>(new FileResourceComparator());
for (File fc : f.listFiles())
s.add(new FileResource(fc, (path != null ? (path + '/') : "") + urlEncode(fc.getName()), false));
return s;
}
}
static final class FileResourceComparator implements Comparator, Serializable {
private static final long serialVersionUID = 1L;
@Override /* Comparator */
public int compare(FileResource o1, FileResource o2) {
int c = o1.getType().compareTo(o2.getType());
return c != 0 ? c : o1.getName().compareTo(o2.getName());
}
}
//-----------------------------------------------------------------------------------------------------------------
// Helper methods
//-----------------------------------------------------------------------------------------------------------------
/**
* Returns the root directory.
*
* @return The root directory.
*/
protected File getRootDir() {
return rootDir;
}
private File getFile(String path) throws NotFound {
if (path == null)
return rootDir;
File f = new File(rootDir.getAbsolutePath() + '/' + path);
if (f.exists())
return f;
throw new NotFound("File not found.");
}
private void deleteFile(File f) {
if (! allowDeletes)
throw new MethodNotAllowed("DELETE not enabled");
if (f.isDirectory()) {
File[] files = f.listFiles();
if (files != null) {
for (File fc : files)
deleteFile(fc);
}
}
if (! f.delete())
throw new Forbidden("Could not delete file {0}", f.getAbsolutePath()) ;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy