Initial commit

2026-08-05 22:03:11 +07:00 · 2013-07-27 18:33:20 +02:00
parent 41cb6dd9ae
commit 9b74bd8194
156 changed files with 72879 additions and 0 deletions
@@ -0,0 +1,54 @@
+package com.sismics.rest.exception;
+
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
+
+import org.codehaus.jettison.json.JSONException;
+import org.codehaus.jettison.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Jersey exception encapsulating an error from the client (BAD_REQUEST).
+ *
+ * @author jtremeaux
+ */
+public class ClientException extends WebApplicationException {
+    /**
+     * Serial UID.
+     */
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * Logger.
+     */
+    private static final Logger log = LoggerFactory.getLogger(ClientException.class);
+
+    /**
+     * Constructor of ClientException.
+     * 
+     * @param type Error type (e.g. AlreadyExistingEmail, ValidationError)
+     * @param message Human readable error message
+     * @param e Readable error message
+     * @throws JSONException
+     */
+    public ClientException(String type, String message, Exception e) throws JSONException {
+        this(type, message);
+        log.error(type + ": " + message, e);
+    }
+
+    /**
+     * Constructor of ClientException.
+     * 
+     * @param type Error type (e.g. AlreadyExistingEmail, ValidationError)
+     * @param message Human readable error message
+     * @throws JSONException
+     */
+    public ClientException(String type, String message) throws JSONException {
+        super(Response.status(Status.BAD_REQUEST).entity(new JSONObject()
+            .put("type", type)
+            .put("message", message)).build());
+    }
+}
@@ -0,0 +1,31 @@
+package com.sismics.rest.exception;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
+
+import org.codehaus.jettison.json.JSONException;
+import org.codehaus.jettison.json.JSONObject;
+
+/**
+ * Unauthorized access to the resource exception.
+ *
+ * @author jtremeaux
+ */
+public class ForbiddenClientException extends WebApplicationException {
+    /**
+     * Serial UID.
+     */
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * Constructor of ForbiddenClientException.
+     * 
+     * @throws JSONException
+     */
+    public ForbiddenClientException() throws JSONException {
+        super(Response.status(Status.FORBIDDEN).entity(new JSONObject()
+            .put("type", "ForbiddenError")
+            .put("message", "You don't have access to this resource")).build());
+    }
+}
@@ -0,0 +1,53 @@
+package com.sismics.rest.exception;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.Response.Status;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.codehaus.jettison.json.JSONException;
+import org.codehaus.jettison.json.JSONObject;
+
+/**
+ * Jersey exception encapsulating an error from the client (INTERNAL_SERVER_ERROR).
+ *
+ * @author jtremeaux
+ */
+public class ServerException extends WebApplicationException {
+    /**
+     * Serial UID.
+     */
+    private static final long serialVersionUID = 1L;
+
+    /**
+     * Logger.
+     */
+    private static final Logger log = LoggerFactory.getLogger(ServerException.class);
+
+    /**
+     * Constructor of ClientException.
+     * 
+     * @param type Error type (e.g. DatabaseError)
+     * @param message Human readable error message
+     * @param e Inner exception
+     * @throws JSONException
+     */
+    public ServerException(String type, String message, Exception e) throws JSONException {
+        this(type, message);
+        log.error(type + ": " + message, e);
+    }
+
+    /**
+     * Constructor of ClientException.
+     * 
+     * @param type Error type (e.g. DatabaseError)
+     * @param message Human readable error message
+     * @throws JSONException
+     */
+    public ServerException(String type, String message) throws JSONException {
+        super(Response.status(Status.INTERNAL_SERVER_ERROR).entity(new JSONObject()
+            .put("type", type)
+            .put("message", message)).build());
+    }
+}
@@ -0,0 +1,45 @@
+package com.sismics.rest.resource;
+
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+
+import org.codehaus.jettison.json.JSONException;
+import org.codehaus.jettison.json.JSONObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Generic exception mapper that transforms all unknown exception into ServerError.
+ *
+ * @author jtremeaux 
+ */
+@Provider
+public class GenericExceptionMapper implements ExceptionMapper<Exception> {
+    /**
+     * Logger.
+     */
+    private static final Logger log = LoggerFactory.getLogger(GenericExceptionMapper.class);
+
+    @Override
+    public Response toResponse(Exception e)  {
+        if (e instanceof WebApplicationException) {
+            return ((WebApplicationException) e).getResponse();
+        }
+        
+        log.error("Unknown error", e);
+        
+        JSONObject entity = new JSONObject();
+        try {
+            entity.put("type", "UnknownError");
+            entity.put("message", "Unknown server error");
+        } catch (JSONException e2) {
+            log.error("Error building response", e2);
+        }
+        
+        return Response.status(Response.Status.INTERNAL_SERVER_ERROR)
+                .entity(entity)
+                .build();
+    }
+}
@@ -0,0 +1,40 @@
+package com.sismics.rest.util;
+
+import org.codehaus.jettison.json.JSONArray;
+import org.codehaus.jettison.json.JSONException;
+import org.codehaus.jettison.json.JSONObject;
+
+/**
+ * JSON utilities.
+ * 
+ * @author jtremeaux
+ */
+public class JsonUtil {
+    
+    /**
+     * Fix of {@see JsonObject.append()}, which seems to create nested arrays.
+     * 
+     * @param o JSON Object
+     * @param key Key containing the array of null
+     * @param value Value to append
+     * @return Updated object
+     * @throws JSONException
+     */
+    public static JSONObject append(JSONObject o, String key, JSONObject value)  throws JSONException {
+        Object prevValue = o.opt(key);
+        if (prevValue == null) {
+            o.put(key, new JSONArray().put(value));
+        } else if (!(prevValue instanceof JSONArray)){
+            throw new JSONException("JSONObject[" + key + "] is not a JSONArray.");
+        } else {
+            JSONArray newArray = new JSONArray();
+            JSONArray oldArray = ((JSONArray) prevValue);
+            for (int i = 0; i < oldArray.length(); i++) {
+                newArray.put(oldArray.get(i));
+            }
+            newArray.put(value);
+            o.put(key, newArray);
+        }
+        return o;
+    }
+}
@@ -0,0 +1,214 @@
+package com.sismics.rest.util;
+
+import java.text.MessageFormat;
+import java.util.Date;
+import java.util.List;
+import java.util.regex.Pattern;
+
+import org.apache.commons.lang.StringUtils;
+import org.codehaus.jettison.json.JSONException;
+import org.joda.time.DateTime;
+
+import com.google.common.base.Strings;
+import com.sismics.docs.core.dao.file.theme.ThemeDao;
+import com.sismics.docs.core.dao.jpa.LocaleDao;
+import com.sismics.docs.core.model.jpa.Locale;
+import com.sismics.rest.exception.ClientException;
+
+/**
+ * Utility class to validate parameters.
+ *
+ * @author jtremeaux
+ */
+public class ValidationUtil {
+    private static Pattern EMAIL_PATTERN = Pattern.compile(".+@.+\\..+");
+    
+    private static Pattern HTTP_URL_PATTERN = Pattern.compile("https?://.+");
+    
+    private static Pattern ALPHANUMERIC_PATTERN = Pattern.compile("[a-zA-Z0-9_]+");
+    
+    /**
+     * Checks that the argument is not null.
+     * 
+     * @param s Object tu validate
+     * @param name Name of the parameter
+     * @throws JSONException
+     */
+    public static void validateRequired(Object s, String name) throws JSONException {
+        if (s == null) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must be set", name));
+        }
+    }
+    
+    /**
+     * Validate a string length.
+     * 
+     * @param s String to validate
+     * @param name Name of the parameter
+     * @param lengthMin Minimum length (or null)
+     * @param lengthMax Maximum length (or null)
+     * @param nullable True if the string can be empty or null
+     * @return String without white spaces
+     * @throws ClientException
+     */
+    public static String validateLength(String s, String name, Integer lengthMin, Integer lengthMax, boolean nullable) throws JSONException {
+        s = StringUtils.strip(s);
+        if (nullable && StringUtils.isEmpty(s)) {
+            return s;
+        }
+        if (s == null) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must be set", name));
+        }
+        if (lengthMin != null && s.length() < lengthMin) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must be more than {1} characters", name, lengthMin));
+        }
+        if (lengthMax != null && s.length() > lengthMax) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must be more than {1} characters", name, lengthMax));
+        }
+        return s;
+    }
+    
+    /**
+     * Validate a string length. The string mustn't be empty.
+     * 
+     * @param s String to validate
+     * @param name Name of the parameter
+     * @param lengthMin Minimum length (or null)
+     * @param lengthMax Maximum length (or null)
+     * @return String without white spaces
+     * @throws ClientException
+     */
+    public static String validateLength(String s, String name, Integer lengthMin, Integer lengthMax) throws JSONException {
+        return validateLength(s, name, lengthMin, lengthMax, false);
+    }
+    
+    /**
+     * Checks if the string is not null and is not only whitespaces.
+     * 
+     * @param s String to validate
+     * @param name Name of the parameter
+     * @return String without white spaces
+     * @throws JSONException
+     */
+    public static String validateStringNotBlank(String s, String name) throws JSONException {
+        return validateLength(s, name, 1, null, false);
+    }
+    
+    /**
+     * Checks if the string is an email.
+     * 
+     * @param s String to validate
+     * @param name Name of the parameter
+     * @throws JSONException
+     */
+    public static void validateEmail(String s, String name) throws JSONException {
+        if (!EMAIL_PATTERN.matcher(s).matches()) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must be an email", name));
+        }
+    }
+    
+    /**
+     * Validates that the provided string matches an URL with HTTP or HTTPS scheme.
+     * 
+     * @param s String to validate
+     * @param name Name of the parameter
+     * @return Stripped URL
+     * @throws JSONException
+     */
+    public static String validateHttpUrl(String s, String name) throws JSONException {
+        s = StringUtils.strip(s);
+        if (!HTTP_URL_PATTERN.matcher(s).matches()) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must be an HTTP(s) URL", name));
+        }
+        return s;
+    }
+    
+    /**
+     * Checks if the string uses only alphanumerical or underscore characters.
+     * 
+     * @param s String to validate
+     * @param name Name of the parameter
+     * @throws JSONException
+     */
+    public static void validateAlphanumeric(String s, String name) throws JSONException {
+        if (!ALPHANUMERIC_PATTERN.matcher(s).matches()) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must have only alphanumeric or underscore characters", name));
+        }
+    }
+    
+    /**
+     * Validates and parses a date.
+     * 
+     * @param s String to validate
+     * @param name Name of the parameter
+     * @param nullable True if the string can be empty or null
+     * @return Parsed date
+     * @throws JSONException
+     */
+    public static Date validateDate(String s, String name, boolean nullable) throws JSONException {
+        if (Strings.isNullOrEmpty(s)) {
+            if (!nullable) {
+                throw new ClientException("ValidationError", MessageFormat.format("{0} must be set", name));
+            } else {
+                return null;
+            }
+        }
+        try {
+            return new DateTime(Long.parseLong(s)).toDate();
+        } catch (NumberFormatException e) {
+            throw new ClientException("ValidationError", MessageFormat.format("{0} must be a date", name));
+        }
+    }
+
+    /**
+     * Validates a locale.
+     * 
+     * @param localeId String to validate
+     * @param name Name of the parameter
+     * @return String without white spaces
+     * @param nullable True if the string can be empty or null
+     * @throws ClientException
+     */
+    public static String validateLocale(String localeId, String name, boolean nullable) throws JSONException {
+        localeId = StringUtils.strip(localeId);
+        if (StringUtils.isEmpty(localeId)) {
+            if (!nullable) {
+                throw new ClientException("ValidationError", MessageFormat.format("{0} is required", name));
+            } else {
+                return null;
+            }
+        }
+        LocaleDao localeDao = new LocaleDao();
+        Locale locale = localeDao.getById(localeId);
+        if (locale == null) {
+            throw new ClientException("ValidationError", "Locale not found: " + localeId);
+        }
+        return localeId;
+    }
+
+    /**
+     * Validates a theme.
+     * 
+     * @param themeId ID of the theme to validate
+     * @param name Name of the parameter
+     * @return String without white spaces
+     * @param nullable True if the string can be empty or null
+     * @throws ClientException
+     */
+    public static String validateTheme(String themeId, String name, boolean nullable) throws JSONException {
+        themeId = StringUtils.strip(themeId);
+        if (StringUtils.isEmpty(themeId)) {
+            if (!nullable) {
+                throw new ClientException("ValidationError", MessageFormat.format("{0} is required", name));
+            } else {
+                return null;
+            }
+        }
+        ThemeDao themeDao = new ThemeDao();
+        List<String> themeList = themeDao.findAll();
+        if (!themeList.contains(themeId)) {
+            throw new ClientException("ValidationError", "Theme not found: " + themeId);
+        }
+        return themeId;
+    }
+}