+/*
+ * Copyright (C) 2007-2012 Mathieu Baudier
+ *
+ * Licensed 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.argeo.eclipse.ui.specific;
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
+import java.net.URL;
-import javax.servlet.http.HttpServletResponse;
-
-import org.apache.commons.io.FileUtils;
-import org.apache.commons.io.IOUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
-import org.argeo.ArgeoException;
import org.eclipse.rwt.RWT;
-
+import org.eclipse.rwt.service.IServiceHandler;
+import org.eclipse.rwt.service.IServiceManager;
+import org.eclipse.ui.PlatformUI;
+
+/**
+ * RAP SPECIFIC handler to enable the opening of a download dialog box triggered
+ * by whatever action in the UI
+ *
+ * Manages the registration of the effective DownloadServiceHandler at
+ * instantiation time.
+ *
+ * Manages the process of forwarding the request to the handler at runtime to
+ * open the dialog box
+ *
+ */
public class FileHandler {
+ public final static String FORCED_DOWNLOAD_URL_BASE_PROPERTY = "argeo.rap.specific.forcedDownloadUrlBase";
- private static Log log = LogFactory.getLog(FileHandler.class);
+ private final static Log log = LogFactory.getLog(FileHandler.class);
- public FileHandler() {
+ public FileHandler(FileProvider provider) {
+ // Instantiate and register the DownloadServicHandler.
+ IServiceManager manager = RWT.getServiceManager();
+ IServiceHandler handler = new DownloadServiceHandler(provider);
+ manager.registerServiceHandler("downloadServiceHandler", handler);
}
- public void openFile(String fileName, InputStream is) {
+ public void openFile(String fileName, String fileId) {
- // // Which file to download?
- // String fileName = RWT.getRequest().getParameter( "filename" );
- // // Get the file content
- // byte[] download = MyDataStore.getByteArrayData( fileName );
- // // Send the file in the response
- // HttpServletResponse response = RWT.getResponse();
- // response.setContentType( "application/octet-stream" );
- // response.setContentLength( download.length );
- // String contentDisposition = "attachment; filename=\"" + fileName +
- // "\"";
- // response.setHeader( "Content-Disposition", contentDisposition );
- // try {
- // response.getOutputStream().write( download );
- // } catch( IOException e1 ) {
- // e1.printStackTrace();
- // }
- //
- //
+ // See RAP FAQ:
+ // http://wiki.eclipse.org/RAP/FAQ#How_to_provide_download_link.3F
+ // And forum discussion :
+ // http://www.eclipse.org/forums/index.php?t=msg&th=205487&start=0&S=43d85dacc88b505402420592109c7240
try {
-
- // / workaround : create a tmp file.
- String prefix = "", suffix = "";
- if (fileName != null) {
- int ind = fileName.lastIndexOf('.');
- if (ind > 0) {
- prefix = fileName.substring(0, ind);
- suffix = fileName.substring(ind);
- }
- }
-
- File tmpFile = createTmpFile(prefix, suffix, is);
-
- // Send the file in the response
- HttpServletResponse response = RWT.getResponse();
- byte[] ba = null;
- ba = FileUtils.readFileToByteArray(tmpFile);
-
- response.setContentLength(ba.length);
-
- // String contentDisposition = "attachment; filename=\"" + fileName
- // + "\"";
- String contentDisposition = "attachment; filename=\"" + fileName
- + "\"";
- response.setContentType("application/force-download");
- response.setHeader("Content-Disposition", contentDisposition);
- response.setHeader("Content-Transfer-Encoding", "binary");
- response.setHeader("Pragma", "no-cache");
- response.setHeader("Cache-Control", "no-cache, must-revalidate");
-
- // must-revalidate");
-
- if (log.isDebugEnabled()) {
- log.debug("Header Set ");
- }
-
- // header("Content-Type: application/force-download; name=\"".$localName."\"");
- // 852 header("Content-Transfer-Encoding: binary");
- // 853 if($gzip){
- // 854 header("Content-Encoding: gzip");
- // 855 // If gzip, recompute data size!
- // 856 $gzippedData =
- // ($data?gzencode($filePathOrData,9):gzencode(file_get_contents($filePathOrData),
- // 9));
- // 857 $size = strlen($gzippedData);
- // 858 }
- // 859 header("Content-Length: ".$size);
- // 860 if ($isFile && ($size != 0)) header("Content-Range: bytes 0-"
- // . ($size - 1) . "/" . $size . ";");
- // 861
- // header("Content-Disposition: attachment; filename=\"".$localName."\"");
- // 862 header("Expires: 0");
- // 863 header("Cache-Control: no-cache, must-revalidate");
- // 864 header("Pragma: no-cache");
-
- // IOUtils.copy(is, response.getOutputStream());
- response.getOutputStream().write(ba);
- // Error.show("In Open File for RAP.");
- } catch (IOException ioe) {
-
- throw new ArgeoException("Cannot copy input stream from file "
- + fileName + " to HttpServletResponse", ioe);
+ if (log.isTraceEnabled())
+ log.trace("URL : " + createFullDownloadUrl(fileName, fileId));
+
+ URL url = new URL(createFullDownloadUrl(fileName, fileId));
+ PlatformUI.getWorkbench().getBrowserSupport()
+ .createBrowser("DownloadDialog").openURL(url);
+ } catch (Exception e) {
+ e.printStackTrace();
}
+ // These lines are useless in the current use case but might be
+ // necessary with new browsers. Stored here for memo
+ // response.setContentType("application/force-download");
+ // response.setHeader("Content-Disposition", contentDisposition);
+ // response.setHeader("Content-Transfer-Encoding", "binary");
+ // response.setHeader("Pragma", "no-cache");
+ // response.setHeader("Cache-Control", "no-cache, must-revalidate");
}
- private File createTmpFile(String prefix, String suffix, InputStream is) {
- File tmpFile = null;
- OutputStream os = null;
- try {
- tmpFile = File.createTempFile(prefix, suffix);
- os = new FileOutputStream(tmpFile);
- IOUtils.copy(is, os);
- } catch (IOException e) {
- throw new ArgeoException("Cannot open file " + prefix + "."
- + suffix, e);
- } finally {
- IOUtils.closeQuietly(os);
- }
- return tmpFile;
+ private String createFullDownloadUrl(String fileName, String fileId) {
+ StringBuilder url = new StringBuilder();
+ // in case RAP is proxied we need to specify the actual base URL
+ // TODO find a cleaner way
+ String forcedDownloadUrlBase = System
+ .getProperty(FORCED_DOWNLOAD_URL_BASE_PROPERTY);
+ if (forcedDownloadUrlBase != null)
+ url.append(forcedDownloadUrlBase);
+ else
+ url.append(RWT.getRequest().getRequestURL());
+ url.append(createParamUrl(fileName, fileId));
+ return url.toString();
}
+ private String createParamUrl(String filename, String fileId) {
+ StringBuilder url = new StringBuilder();
+ url.append("?");
+ url.append(IServiceHandler.REQUEST_PARAM);
+ url.append("=downloadServiceHandler");
+ url.append("&filename=");
+ url.append(filename);
+ url.append("&fileid=");
+ url.append(fileId);
+ String encodedURL = RWT.getResponse().encodeURL(url.toString());
+ return encodedURL;
+ }
}
projects / lgpl / argeo-commons.git / blobdiff