/*
* LinShare is an open source filesharing software, part of the LinPKI software
* suite, developed by Linagora.
*
* Copyright (C) 2015 LINAGORA
*
* This program is free software: you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option) any
* later version, provided you comply with the Additional Terms applicable for
* LinShare software by Linagora pursuant to Section 7 of the GNU Affero General
* Public License, subsections (b), (c), and (e), pursuant to which you must
* notably (i) retain the display of the “LinShare™” trademark/logo at the top
* of the interface window, the display of the “You are using the Open Source
* and free version of LinShare™, powered by Linagora © 2009–2015. Contribute to
* Linshare R&D by subscribing to an Enterprise offer!” infobox and in the
* e-mails sent with the Program, (ii) retain all hypertext links between
* LinShare and linshare.org, between linagora.com and Linagora, and (iii)
* refrain from infringing Linagora intellectual property rights over its
* trademarks and commercial brands. Other Additional Terms apply, see
* <http://www.linagora.com/licenses/> for more details.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License and
* its applicable Additional Terms for LinShare along with this program. If not,
* see <http://www.gnu.org/licenses/> for the GNU Affero General Public License
* version 3 and <http://www.linagora.com/licenses/> for the Additional Terms
* applicable to LinShare software.
*/
package org.linagora.linshare.webservice;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.util.Date;
import java.util.Properties;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response;
import org.apache.commons.lang.Validate;
import org.apache.cxf.helpers.IOUtils;
import org.apache.cxf.jaxrs.ext.multipart.MultipartBody;
import org.apache.cxf.message.Exchange;
import org.apache.cxf.message.Message;
import org.apache.cxf.phase.PhaseInterceptorChain;
import org.linagora.linshare.core.exception.BusinessErrorCode;
import org.linagora.linshare.core.exception.BusinessException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
*
* common utility methods for webservice implementation (rest, soap)
*/
public class WebserviceBase {
protected Logger logger = LoggerFactory.getLogger(this.getClass());
// SOAP
public static final String NAME_SPACE_NS = "http://org/linagora/linshare/webservice/";
/**
* 1mo
*/
public static final int ERROR_THRESHOLD_FOR_FILE_SIZE_DIFFERENCE = 1048576;
// REST
protected WebApplicationException giveRestException(int httpErrorCode,
String message) {
return giveRestException(httpErrorCode, message, null);
}
protected WebApplicationException giveRestException(int httpErrorCode,
String message, Throwable cause) {
if (cause == null) {
return new WebApplicationException(Response.status(httpErrorCode)
.entity(message).build());
} else {
return new WebApplicationException(cause, Response
.status(httpErrorCode).entity(message).build());
}
}
protected String getCoreVersion() {
Properties prop = new Properties();
try {
if (this.getClass().getResourceAsStream("/version.properties") != null) {
prop.load(this.getClass().getResourceAsStream(
"/version.properties"));
} else {
logger.debug("Impossible to load version.properties, Is this a dev environnement?");
}
} catch (IOException e) {
logger.debug("Impossible to load version.properties, Is this a dev environnement?");
logger.debug(e.toString());
}
if (prop.getProperty("Implementation-Version") != null) {
return prop.getProperty("Implementation-Version");
} else {
return "trunk";
}
}
protected File getTempFile(InputStream theFile, String discriminator, String fileName) {
if (discriminator == null) {
discriminator = "";
}
// Legacy code, we need to extract extension for the dirty unstable LinThumbnail Module.
// I hope some day we get rid of it !
String extension = null;
if (fileName != null) {
int splitIdx = fileName.lastIndexOf('.');
if (splitIdx > -1) {
extension = fileName.substring(splitIdx, fileName.length());
}
}
File tempFile = null;
try {
tempFile = File.createTempFile("linshare-" + discriminator + "-", extension);
tempFile.deleteOnExit();
IOUtils.transferTo(theFile, tempFile);
} catch (IOException e) {
logger.error(e.getMessage(), e);
throw new BusinessException(
BusinessErrorCode.FILE_INVALID_INPUT_TEMP_FILE,
"Can not generate temp file from input stream.");
}
return tempFile;
}
protected void deleteTempFile(File tempFile) {
if (tempFile != null) {
try {
if (tempFile.exists()) {
tempFile.delete();
}
} catch (Exception e) {
logger.warn("Can not delete temp file : "
+ tempFile.getAbsolutePath());
logger.debug(e.getMessage(), e);
}
}
}
protected Long getTransfertDuration() {
Long uploadStartTime = null;
Message currentMessage = PhaseInterceptorChain.getCurrentMessage();
Exchange exchange = currentMessage.getExchange();
if (exchange.containsKey("org.linagora.linshare.webservice.interceptor.start_time")) {
uploadStartTime = (Long) exchange.get("org.linagora.linshare.webservice.interceptor.start_time");
logger.debug("Upload start time : " + uploadStartTime);
}
Long transfertDuration = null;
if (uploadStartTime != null) {
Date endDate = new Date();
transfertDuration = endDate.getTime() - uploadStartTime;
if (logger.isDebugEnabled()) {
Date beginDate = new Date(uploadStartTime);
logger.debug("Upload was begining at : " + beginDate);
logger.debug("Upload was ending at : " + endDate);
}
logger.info("statistics:upload time:" + transfertDuration + "ms.");
}
return transfertDuration;
}
protected String getFileName(String givenFileName, MultipartBody body) {
String fileName;
if (givenFileName == null || givenFileName.isEmpty()) {
// parameter givenFileName is optional
// so need to search this information in the header of the
// attachment (with id file)
fileName = body.getAttachment("file").getContentDisposition()
.getParameter("filename");
} else {
fileName = givenFileName;
}
if (fileName == null) {
logger.error("There is no multi-part attachment named 'filename'.");
logger.error("There is no 'filename' header in multi-Part attachment named 'file'.");
Validate.notNull(fileName, "File name for file attachment is required.");
}
try {
byte[] bytes = fileName.getBytes("ISO-8859-1");
fileName = new String(bytes, "UTF-8");
} catch (UnsupportedEncodingException e1) {
logger.error("Can not encode file name " + e1.getMessage());
}
return fileName;
}
protected void checkSizeValidation(Long contentLength, Long fileSize,
long currSize) {
if (fileSize != null) {
if (!fileSize.equals(currSize)) {
String msg = String
.format("Invalid file size (check multipart parameter named 'filesize'), size found %1$d, expected %2$d.(diff=%3$d)",
currSize, fileSize, Math.abs(fileSize - currSize));
logger.error(msg);
throw new BusinessException(BusinessErrorCode.WEBSERVICE_BAD_REQUEST, msg);
}
} else {
// if file size is not supply, we could try an approximation ~1Mo
long diff = Math.abs(contentLength - currSize);
if (diff - ERROR_THRESHOLD_FOR_FILE_SIZE_DIFFERENCE > 0) {
String msg = String
.format("Weird file size, size found %1$d, request content length %2$d.(diff=%3$d)",
currSize, contentLength, diff);
logger.error(msg);
throw new BusinessException(BusinessErrorCode.WEBSERVICE_BAD_REQUEST, msg);
}
}
}
protected void checkSizeValidation(Long fileSize, long currSize) {
Validate.notNull(fileSize, "filesize must be set");
if (!fileSize.equals(currSize)) {
String msg = String.format(
"Invalid file size (check multipart parameter named 'filesize'), size found %1$d, expected %2$d.(diff=%3$d)",
currSize, fileSize, Math.abs(fileSize - currSize));
logger.error(msg);
throw new BusinessException(BusinessErrorCode.WEBSERVICE_BAD_REQUEST, msg);
}
}
}