diff --git a/org/json/CDL.java b/org/json/CDL.java new file mode 100644 index 0000000..8520e86 --- /dev/null +++ b/org/json/CDL.java @@ -0,0 +1,279 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +/** + * This provides static methods to convert comma delimited text into a + * JSONArray, and to convert a JSONArray into comma delimited text. Comma + * delimited text is a very popular format for data interchange. It is + * understood by most database, spreadsheet, and organizer programs. + *

+ * Each row of text represents a row in a table or a data record. Each row + * ends with a NEWLINE character. Each row contains one or more values. + * Values are separated by commas. A value can contain any character except + * for comma, unless is is wrapped in single quotes or double quotes. + *

+ * The first row usually contains the names of the columns. + *

+ * A comma delimited list can be converted into a JSONArray of JSONObjects. + * The names for the elements in the JSONObjects can be taken from the names + * in the first row. + * @author JSON.org + * @version 2015-05-01 + */ +public class CDL { + + /** + * Get the next value. The value can be wrapped in quotes. The value can + * be empty. + * @param x A JSONTokener of the source text. + * @return The value string, or null if empty. + * @throws JSONException if the quoted string is badly formed. + */ + private static String getValue(JSONTokener x) throws JSONException { + char c; + char q; + StringBuffer sb; + do { + c = x.next(); + } while (c == ' ' || c == '\t'); + switch (c) { + case 0: + return null; + case '"': + case '\'': + q = c; + sb = new StringBuffer(); + for (;;) { + c = x.next(); + if (c == q) { + break; + } + if (c == 0 || c == '\n' || c == '\r') { + throw x.syntaxError("Missing close quote '" + q + "'."); + } + sb.append(c); + } + return sb.toString(); + case ',': + x.back(); + return ""; + default: + x.back(); + return x.nextTo(','); + } + } + + /** + * Produce a JSONArray of strings from a row of comma delimited values. + * @param x A JSONTokener of the source text. + * @return A JSONArray of strings. + * @throws JSONException + */ + public static JSONArray rowToJSONArray(JSONTokener x) throws JSONException { + JSONArray ja = new JSONArray(); + for (;;) { + String value = getValue(x); + char c = x.next(); + if (value == null || + (ja.length() == 0 && value.length() == 0 && c != ',')) { + return null; + } + ja.put(value); + for (;;) { + if (c == ',') { + break; + } + if (c != ' ') { + if (c == '\n' || c == '\r' || c == 0) { + return ja; + } + throw x.syntaxError("Bad character '" + c + "' (" + + (int)c + ")."); + } + c = x.next(); + } + } + } + + /** + * Produce a JSONObject from a row of comma delimited text, using a + * parallel JSONArray of strings to provides the names of the elements. + * @param names A JSONArray of names. This is commonly obtained from the + * first row of a comma delimited text file using the rowToJSONArray + * method. + * @param x A JSONTokener of the source text. + * @return A JSONObject combining the names and values. + * @throws JSONException + */ + public static JSONObject rowToJSONObject(JSONArray names, JSONTokener x) + throws JSONException { + JSONArray ja = rowToJSONArray(x); + return ja != null ? ja.toJSONObject(names) : null; + } + + /** + * Produce a comma delimited text row from a JSONArray. Values containing + * the comma character will be quoted. Troublesome characters may be + * removed. + * @param ja A JSONArray of strings. + * @return A string ending in NEWLINE. + */ + public static String rowToString(JSONArray ja) { + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < ja.length(); i += 1) { + if (i > 0) { + sb.append(','); + } + Object object = ja.opt(i); + if (object != null) { + String string = object.toString(); + if (string.length() > 0 && (string.indexOf(',') >= 0 || + string.indexOf('\n') >= 0 || string.indexOf('\r') >= 0 || + string.indexOf(0) >= 0 || string.charAt(0) == '"')) { + sb.append('"'); + int length = string.length(); + for (int j = 0; j < length; j += 1) { + char c = string.charAt(j); + if (c >= ' ' && c != '"') { + sb.append(c); + } + } + sb.append('"'); + } else { + sb.append(string); + } + } + } + sb.append('\n'); + return sb.toString(); + } + + /** + * Produce a JSONArray of JSONObjects from a comma delimited text string, + * using the first row as a source of names. + * @param string The comma delimited text. + * @return A JSONArray of JSONObjects. + * @throws JSONException + */ + public static JSONArray toJSONArray(String string) throws JSONException { + return toJSONArray(new JSONTokener(string)); + } + + /** + * Produce a JSONArray of JSONObjects from a comma delimited text string, + * using the first row as a source of names. + * @param x The JSONTokener containing the comma delimited text. + * @return A JSONArray of JSONObjects. + * @throws JSONException + */ + public static JSONArray toJSONArray(JSONTokener x) throws JSONException { + return toJSONArray(rowToJSONArray(x), x); + } + + /** + * Produce a JSONArray of JSONObjects from a comma delimited text string + * using a supplied JSONArray as the source of element names. + * @param names A JSONArray of strings. + * @param string The comma delimited text. + * @return A JSONArray of JSONObjects. + * @throws JSONException + */ + public static JSONArray toJSONArray(JSONArray names, String string) + throws JSONException { + return toJSONArray(names, new JSONTokener(string)); + } + + /** + * Produce a JSONArray of JSONObjects from a comma delimited text string + * using a supplied JSONArray as the source of element names. + * @param names A JSONArray of strings. + * @param x A JSONTokener of the source text. + * @return A JSONArray of JSONObjects. + * @throws JSONException + */ + public static JSONArray toJSONArray(JSONArray names, JSONTokener x) + throws JSONException { + if (names == null || names.length() == 0) { + return null; + } + JSONArray ja = new JSONArray(); + for (;;) { + JSONObject jo = rowToJSONObject(names, x); + if (jo == null) { + break; + } + ja.put(jo); + } + if (ja.length() == 0) { + return null; + } + return ja; + } + + + /** + * Produce a comma delimited text from a JSONArray of JSONObjects. The + * first row will be a list of names obtained by inspecting the first + * JSONObject. + * @param ja A JSONArray of JSONObjects. + * @return A comma delimited text. + * @throws JSONException + */ + public static String toString(JSONArray ja) throws JSONException { + JSONObject jo = ja.optJSONObject(0); + if (jo != null) { + JSONArray names = jo.names(); + if (names != null) { + return rowToString(names) + toString(names, ja); + } + } + return null; + } + + /** + * Produce a comma delimited text from a JSONArray of JSONObjects using + * a provided list of names. The list of names is not included in the + * output. + * @param names A JSONArray of strings. + * @param ja A JSONArray of JSONObjects. + * @return A comma delimited text. + * @throws JSONException + */ + public static String toString(JSONArray names, JSONArray ja) + throws JSONException { + if (names == null || names.length() == 0) { + return null; + } + StringBuffer sb = new StringBuffer(); + for (int i = 0; i < ja.length(); i += 1) { + JSONObject jo = ja.optJSONObject(i); + if (jo != null) { + sb.append(rowToString(jo.toJSONArray(names))); + } + } + return sb.toString(); + } +} diff --git a/org/json/Cookie.java b/org/json/Cookie.java new file mode 100644 index 0000000..1867dbd --- /dev/null +++ b/org/json/Cookie.java @@ -0,0 +1,169 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +/** + * Convert a web browser cookie specification to a JSONObject and back. + * JSON and Cookies are both notations for name/value pairs. + * @author JSON.org + * @version 2014-05-03 + */ +public class Cookie { + + /** + * Produce a copy of a string in which the characters '+', '%', '=', ';' + * and control characters are replaced with "%hh". This is a gentle form + * of URL encoding, attempting to cause as little distortion to the + * string as possible. The characters '=' and ';' are meta characters in + * cookies. By convention, they are escaped using the URL-encoding. This is + * only a convention, not a standard. Often, cookies are expected to have + * encoded values. We encode '=' and ';' because we must. We encode '%' and + * '+' because they are meta characters in URL encoding. + * @param string The source string. + * @return The escaped result. + */ + public static String escape(String string) { + char c; + String s = string.trim(); + int length = s.length(); + StringBuilder sb = new StringBuilder(length); + for (int i = 0; i < length; i += 1) { + c = s.charAt(i); + if (c < ' ' || c == '+' || c == '%' || c == '=' || c == ';') { + sb.append('%'); + sb.append(Character.forDigit((char)((c >>> 4) & 0x0f), 16)); + sb.append(Character.forDigit((char)(c & 0x0f), 16)); + } else { + sb.append(c); + } + } + return sb.toString(); + } + + + /** + * Convert a cookie specification string into a JSONObject. The string + * will contain a name value pair separated by '='. The name and the value + * will be unescaped, possibly converting '+' and '%' sequences. The + * cookie properties may follow, separated by ';', also represented as + * name=value (except the secure property, which does not have a value). + * The name will be stored under the key "name", and the value will be + * stored under the key "value". This method does not do checking or + * validation of the parameters. It only converts the cookie string into + * a JSONObject. + * @param string The cookie specification string. + * @return A JSONObject containing "name", "value", and possibly other + * members. + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException { + String name; + JSONObject jo = new JSONObject(); + Object value; + JSONTokener x = new JSONTokener(string); + jo.put("name", x.nextTo('=')); + x.next('='); + jo.put("value", x.nextTo(';')); + x.next(); + while (x.more()) { + name = unescape(x.nextTo("=;")); + if (x.next() != '=') { + if (name.equals("secure")) { + value = Boolean.TRUE; + } else { + throw x.syntaxError("Missing '=' in cookie parameter."); + } + } else { + value = unescape(x.nextTo(';')); + x.next(); + } + jo.put(name, value); + } + return jo; + } + + + /** + * Convert a JSONObject into a cookie specification string. The JSONObject + * must contain "name" and "value" members. + * If the JSONObject contains "expires", "domain", "path", or "secure" + * members, they will be appended to the cookie specification string. + * All other members are ignored. + * @param jo A JSONObject + * @return A cookie specification string + * @throws JSONException + */ + public static String toString(JSONObject jo) throws JSONException { + StringBuilder sb = new StringBuilder(); + + sb.append(escape(jo.getString("name"))); + sb.append("="); + sb.append(escape(jo.getString("value"))); + if (jo.has("expires")) { + sb.append(";expires="); + sb.append(jo.getString("expires")); + } + if (jo.has("domain")) { + sb.append(";domain="); + sb.append(escape(jo.getString("domain"))); + } + if (jo.has("path")) { + sb.append(";path="); + sb.append(escape(jo.getString("path"))); + } + if (jo.optBoolean("secure")) { + sb.append(";secure"); + } + return sb.toString(); + } + + /** + * Convert %hh sequences to single characters, and + * convert plus to space. + * @param string A string that may contain + * + (plus) and + * %hh sequences. + * @return The unescaped string. + */ + public static String unescape(String string) { + int length = string.length(); + StringBuilder sb = new StringBuilder(length); + for (int i = 0; i < length; ++i) { + char c = string.charAt(i); + if (c == '+') { + c = ' '; + } else if (c == '%' && i + 2 < length) { + int d = JSONTokener.dehexchar(string.charAt(i + 1)); + int e = JSONTokener.dehexchar(string.charAt(i + 2)); + if (d >= 0 && e >= 0) { + c = (char)(d * 16 + e); + i += 2; + } + } + sb.append(c); + } + return sb.toString(); + } +} diff --git a/org/json/CookieList.java b/org/json/CookieList.java new file mode 100644 index 0000000..b716fd7 --- /dev/null +++ b/org/json/CookieList.java @@ -0,0 +1,89 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +import java.util.Iterator; + +/** + * Convert a web browser cookie list string to a JSONObject and back. + * @author JSON.org + * @version 2014-05-03 + */ +public class CookieList { + + /** + * Convert a cookie list into a JSONObject. A cookie list is a sequence + * of name/value pairs. The names are separated from the values by '='. + * The pairs are separated by ';'. The names and the values + * will be unescaped, possibly converting '+' and '%' sequences. + * + * To add a cookie to a cooklist, + * cookielistJSONObject.put(cookieJSONObject.getString("name"), + * cookieJSONObject.getString("value")); + * @param string A cookie list string + * @return A JSONObject + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException { + JSONObject jo = new JSONObject(); + JSONTokener x = new JSONTokener(string); + while (x.more()) { + String name = Cookie.unescape(x.nextTo('=')); + x.next('='); + jo.put(name, Cookie.unescape(x.nextTo(';'))); + x.next(); + } + return jo; + } + + /** + * Convert a JSONObject into a cookie list. A cookie list is a sequence + * of name/value pairs. The names are separated from the values by '='. + * The pairs are separated by ';'. The characters '%', '+', '=', and ';' + * in the names and values are replaced by "%hh". + * @param jo A JSONObject + * @return A cookie list string + * @throws JSONException + */ + public static String toString(JSONObject jo) throws JSONException { + boolean b = false; + Iterator keys = jo.keys(); + String string; + StringBuilder sb = new StringBuilder(); + while (keys.hasNext()) { + string = keys.next(); + if (!jo.isNull(string)) { + if (b) { + sb.append(';'); + } + sb.append(Cookie.escape(string)); + sb.append("="); + sb.append(Cookie.escape(jo.getString(string))); + b = true; + } + } + return sb.toString(); + } +} diff --git a/org/json/HTTP.java b/org/json/HTTP.java new file mode 100644 index 0000000..bd1d6fb --- /dev/null +++ b/org/json/HTTP.java @@ -0,0 +1,163 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +import java.util.Iterator; + +/** + * Convert an HTTP header to a JSONObject and back. + * @author JSON.org + * @version 2014-05-03 + */ +public class HTTP { + + /** Carriage return/line feed. */ + public static final String CRLF = "\r\n"; + + /** + * Convert an HTTP header string into a JSONObject. It can be a request + * header or a response header. A request header will contain + * 

{
+     *    Method: "POST" (for example),
+     *    "Request-URI": "/" (for example),
+     *    "HTTP-Version": "HTTP/1.1" (for example)
+     * }
+ * A response header will contain + * 
{
+     *    "HTTP-Version": "HTTP/1.1" (for example),
+     *    "Status-Code": "200" (for example),
+     *    "Reason-Phrase": "OK" (for example)
+     * }
+ * In addition, the other parameters in the header will be captured, using + * the HTTP field names as JSON names, so that 
+     *    Date: Sun, 26 May 2002 18:06:04 GMT
+     *    Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
+     *    Cache-Control: no-cache
+ * become + * 
{...
+     *    Date: "Sun, 26 May 2002 18:06:04 GMT",
+     *    Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
+     *    "Cache-Control": "no-cache",
+     * ...}
+ * It does no further checking or conversion. It does not parse dates. + * It does not do '%' transforms on URLs. + * @param string An HTTP header string. + * @return A JSONObject containing the elements and attributes + * of the XML string. + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException { + JSONObject jo = new JSONObject(); + HTTPTokener x = new HTTPTokener(string); + String token; + + token = x.nextToken(); + if (token.toUpperCase().startsWith("HTTP")) { + +// Response + + jo.put("HTTP-Version", token); + jo.put("Status-Code", x.nextToken()); + jo.put("Reason-Phrase", x.nextTo('\0')); + x.next(); + + } else { + +// Request + + jo.put("Method", token); + jo.put("Request-URI", x.nextToken()); + jo.put("HTTP-Version", x.nextToken()); + } + +// Fields + + while (x.more()) { + String name = x.nextTo(':'); + x.next(':'); + jo.put(name, x.nextTo('\0')); + x.next(); + } + return jo; + } + + + /** + * Convert a JSONObject into an HTTP header. A request header must contain + * 
{
+     *    Method: "POST" (for example),
+     *    "Request-URI": "/" (for example),
+     *    "HTTP-Version": "HTTP/1.1" (for example)
+     * }
+ * A response header must contain + * 
{
+     *    "HTTP-Version": "HTTP/1.1" (for example),
+     *    "Status-Code": "200" (for example),
+     *    "Reason-Phrase": "OK" (for example)
+     * }
+ * Any other members of the JSONObject will be output as HTTP fields. + * The result will end with two CRLF pairs. + * @param jo A JSONObject + * @return An HTTP header string. + * @throws JSONException if the object does not contain enough + * information. + */ + public static String toString(JSONObject jo) throws JSONException { + Iterator keys = jo.keys(); + String string; + StringBuilder sb = new StringBuilder(); + if (jo.has("Status-Code") && jo.has("Reason-Phrase")) { + sb.append(jo.getString("HTTP-Version")); + sb.append(' '); + sb.append(jo.getString("Status-Code")); + sb.append(' '); + sb.append(jo.getString("Reason-Phrase")); + } else if (jo.has("Method") && jo.has("Request-URI")) { + sb.append(jo.getString("Method")); + sb.append(' '); + sb.append('"'); + sb.append(jo.getString("Request-URI")); + sb.append('"'); + sb.append(' '); + sb.append(jo.getString("HTTP-Version")); + } else { + throw new JSONException("Not enough material for an HTTP header."); + } + sb.append(CRLF); + while (keys.hasNext()) { + string = keys.next(); + if (!"HTTP-Version".equals(string) && !"Status-Code".equals(string) && + !"Reason-Phrase".equals(string) && !"Method".equals(string) && + !"Request-URI".equals(string) && !jo.isNull(string)) { + sb.append(string); + sb.append(": "); + sb.append(jo.getString(string)); + sb.append(CRLF); + } + } + sb.append(CRLF); + return sb.toString(); + } +} diff --git a/org/json/HTTPTokener.java b/org/json/HTTPTokener.java new file mode 100644 index 0000000..b2489b6 --- /dev/null +++ b/org/json/HTTPTokener.java @@ -0,0 +1,77 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +/** + * The HTTPTokener extends the JSONTokener to provide additional methods + * for the parsing of HTTP headers. + * @author JSON.org + * @version 2014-05-03 + */ +public class HTTPTokener extends JSONTokener { + + /** + * Construct an HTTPTokener from a string. + * @param string A source string. + */ + public HTTPTokener(String string) { + super(string); + } + + + /** + * Get the next token or string. This is used in parsing HTTP headers. + * @throws JSONException + * @return A String. + */ + public String nextToken() throws JSONException { + char c; + char q; + StringBuilder sb = new StringBuilder(); + do { + c = next(); + } while (Character.isWhitespace(c)); + if (c == '"' || c == '\'') { + q = c; + for (;;) { + c = next(); + if (c < ' ') { + throw syntaxError("Unterminated string."); + } + if (c == q) { + return sb.toString(); + } + sb.append(c); + } + } + for (;;) { + if (c == 0 || Character.isWhitespace(c)) { + return sb.toString(); + } + sb.append(c); + c = next(); + } + } +} diff --git a/org/json/JSONArray.java b/org/json/JSONArray.java new file mode 100644 index 0000000..3f05548 --- /dev/null +++ b/org/json/JSONArray.java @@ -0,0 +1,977 @@ +package org.json; + +/* + Copyright (c) 2002 JSON.org + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + The Software shall be used for Good, not Evil. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + */ + +import java.io.IOException; +import java.io.StringWriter; +import java.io.Writer; +import java.lang.reflect.Array; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Iterator; +import java.util.Map; + +/** + * A JSONArray is an ordered sequence of values. Its external text form is a + * string wrapped in square brackets with commas separating the values. The + * internal form is an object having get and opt + * methods for accessing the values by index, and put methods for + * adding or replacing values. The values can be any of these types: + * Boolean, JSONArray, JSONObject, + * Number, String, or the + * JSONObject.NULL object. + *

+ * The constructor can convert a JSON text into a Java object. The + * toString method converts to JSON text. + *

+ * A get method returns a value if one can be found, and throws an + * exception if one cannot be found. An opt method returns a + * default value instead of throwing an exception, and so is useful for + * obtaining optional values. + *

+ * The generic get() and opt() methods return an + * object which you can cast or query for type. There are also typed + * get and opt methods that do type checking and type + * coercion for you. + *

+ * The texts produced by the toString methods strictly conform to + * JSON syntax rules. The constructors are more forgiving in the texts they will + * accept: + *

+ * + * @author JSON.org + * @version 2014-05-03 + */ +public class JSONArray { + + /** + * The arrayList where the JSONArray's properties are kept. + */ + private final ArrayList myArrayList; + + /** + * Construct an empty JSONArray. + */ + public JSONArray() { + this.myArrayList = new ArrayList(); + } + + /** + * Construct a JSONArray from a JSONTokener. + * + * @param x + * A JSONTokener + * @throws JSONException + * If there is a syntax error. + */ + public JSONArray(JSONTokener x) throws JSONException { + this(); + if (x.nextClean() != '[') { + throw x.syntaxError("A JSONArray text must start with '['"); + } + if (x.nextClean() != ']') { + x.back(); + for (;;) { + if (x.nextClean() == ',') { + x.back(); + this.myArrayList.add(JSONObject.NULL); + } else { + x.back(); + this.myArrayList.add(x.nextValue()); + } + switch (x.nextClean()) { + case ',': + if (x.nextClean() == ']') { + return; + } + x.back(); + break; + case ']': + return; + default: + throw x.syntaxError("Expected a ',' or ']'"); + } + } + } + } + + /** + * Construct a JSONArray from a source JSON text. + * + * @param source + * A string that begins with [ (left + * bracket) and ends with ] + *  (right bracket). + * @throws JSONException + * If there is a syntax error. + */ + public JSONArray(String source) throws JSONException { + this(new JSONTokener(source)); + } + + /** + * Construct a JSONArray from a Collection. + * + * @param collection + * A Collection. + */ + public JSONArray(Collection collection) { + this.myArrayList = new ArrayList(); + if (collection != null) { + Iterator iter = collection.iterator(); + while (iter.hasNext()) { + this.myArrayList.add(JSONObject.wrap(iter.next())); + } + } + } + + /** + * Construct a JSONArray from an array + * + * @throws JSONException + * If not an array. + */ + public JSONArray(Object array) throws JSONException { + this(); + if (array.getClass().isArray()) { + int length = Array.getLength(array); + for (int i = 0; i < length; i += 1) { + this.put(JSONObject.wrap(Array.get(array, i))); + } + } else { + throw new JSONException( + "JSONArray initial value should be a string or collection or array."); + } + } + + /** + * Get the object value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return An object value. + * @throws JSONException + * If there is no value for the index. + */ + public Object get(int index) throws JSONException { + Object object = this.opt(index); + if (object == null) { + throw new JSONException("JSONArray[" + index + "] not found."); + } + return object; + } + + /** + * Get the boolean value associated with an index. The string values "true" + * and "false" are converted to boolean. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The truth. + * @throws JSONException + * If there is no value for the index or if the value is not + * convertible to boolean. + */ + public boolean getBoolean(int index) throws JSONException { + Object object = this.get(index); + if (object.equals(Boolean.FALSE) + || (object instanceof String && ((String) object) + .equalsIgnoreCase("false"))) { + return false; + } else if (object.equals(Boolean.TRUE) + || (object instanceof String && ((String) object) + .equalsIgnoreCase("true"))) { + return true; + } + throw new JSONException("JSONArray[" + index + "] is not a boolean."); + } + + /** + * Get the double value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value cannot be converted + * to a number. + */ + public double getDouble(int index) throws JSONException { + Object object = this.get(index); + try { + return object instanceof Number ? ((Number) object).doubleValue() + : Double.parseDouble((String) object); + } catch (Exception e) { + throw new JSONException("JSONArray[" + index + "] is not a number."); + } + } + + /** + * Get the int value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value is not a number. + */ + public int getInt(int index) throws JSONException { + Object object = this.get(index); + try { + return object instanceof Number ? ((Number) object).intValue() + : Integer.parseInt((String) object); + } catch (Exception e) { + throw new JSONException("JSONArray[" + index + "] is not a number."); + } + } + + /** + * Get the JSONArray associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A JSONArray value. + * @throws JSONException + * If there is no value for the index. or if the value is not a + * JSONArray + */ + public JSONArray getJSONArray(int index) throws JSONException { + Object object = this.get(index); + if (object instanceof JSONArray) { + return (JSONArray) object; + } + throw new JSONException("JSONArray[" + index + "] is not a JSONArray."); + } + + /** + * Get the JSONObject associated with an index. + * + * @param index + * subscript + * @return A JSONObject value. + * @throws JSONException + * If there is no value for the index or if the value is not a + * JSONObject + */ + public JSONObject getJSONObject(int index) throws JSONException { + Object object = this.get(index); + if (object instanceof JSONObject) { + return (JSONObject) object; + } + throw new JSONException("JSONArray[" + index + "] is not a JSONObject."); + } + + /** + * Get the long value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + * @throws JSONException + * If the key is not found or if the value cannot be converted + * to a number. + */ + public long getLong(int index) throws JSONException { + Object object = this.get(index); + try { + return object instanceof Number ? ((Number) object).longValue() + : Long.parseLong((String) object); + } catch (Exception e) { + throw new JSONException("JSONArray[" + index + "] is not a number."); + } + } + + /** + * Get the string associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A string value. + * @throws JSONException + * If there is no string value for the index. + */ + public String getString(int index) throws JSONException { + Object object = this.get(index); + if (object instanceof String) { + return (String) object; + } + throw new JSONException("JSONArray[" + index + "] not a string."); + } + + /** + * Determine if the value is null. + * + * @param index + * The index must be between 0 and length() - 1. + * @return true if the value at the index is null, or if there is no value. + */ + public boolean isNull(int index) { + return JSONObject.NULL.equals(this.opt(index)); + } + + /** + * Make a string from the contents of this JSONArray. The + * separator string is inserted between each element. Warning: + * This method assumes that the data structure is acyclical. + * + * @param separator + * A string that will be inserted between the elements. + * @return a string. + * @throws JSONException + * If the array contains an invalid number. + */ + public String join(String separator) throws JSONException { + int len = this.length(); + StringBuilder sb = new StringBuilder(); + + for (int i = 0; i < len; i += 1) { + if (i > 0) { + sb.append(separator); + } + sb.append(JSONObject.valueToString(this.myArrayList.get(i))); + } + return sb.toString(); + } + + /** + * Get the number of elements in the JSONArray, included nulls. + * + * @return The length (or size). + */ + public int length() { + return this.myArrayList.size(); + } + + /** + * Get the optional object value associated with an index. + * + * @param index + * The index must be between 0 and length() - 1. + * @return An object value, or null if there is no object at that index. + */ + public Object opt(int index) { + return (index < 0 || index >= this.length()) ? null : this.myArrayList + .get(index); + } + + /** + * Get the optional boolean value associated with an index. It returns false + * if there is no value at that index, or if the value is not Boolean.TRUE + * or the String "true". + * + * @param index + * The index must be between 0 and length() - 1. + * @return The truth. + */ + public boolean optBoolean(int index) { + return this.optBoolean(index, false); + } + + /** + * Get the optional boolean value associated with an index. It returns the + * defaultValue if there is no value at that index or if it is not a Boolean + * or the String "true" or "false" (case insensitive). + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * A boolean default. + * @return The truth. + */ + public boolean optBoolean(int index, boolean defaultValue) { + try { + return this.getBoolean(index); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get the optional double value associated with an index. NaN is returned + * if there is no value for the index, or if the value is not a number and + * cannot be converted to a number. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + */ + public double optDouble(int index) { + return this.optDouble(index, Double.NaN); + } + + /** + * Get the optional double value associated with an index. The defaultValue + * is returned if there is no value for the index, or if the value is not a + * number and cannot be converted to a number. + * + * @param index + * subscript + * @param defaultValue + * The default value. + * @return The value. + */ + public double optDouble(int index, double defaultValue) { + try { + return this.getDouble(index); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get the optional int value associated with an index. Zero is returned if + * there is no value for the index, or if the value is not a number and + * cannot be converted to a number. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + */ + public int optInt(int index) { + return this.optInt(index, 0); + } + + /** + * Get the optional int value associated with an index. The defaultValue is + * returned if there is no value for the index, or if the value is not a + * number and cannot be converted to a number. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return The value. + */ + public int optInt(int index, int defaultValue) { + try { + return this.getInt(index); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get the optional JSONArray associated with an index. + * + * @param index + * subscript + * @return A JSONArray value, or null if the index has no value, or if the + * value is not a JSONArray. + */ + public JSONArray optJSONArray(int index) { + Object o = this.opt(index); + return o instanceof JSONArray ? (JSONArray) o : null; + } + + /** + * Get the optional JSONObject associated with an index. Null is returned if + * the key is not found, or null if the index has no value, or if the value + * is not a JSONObject. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A JSONObject value. + */ + public JSONObject optJSONObject(int index) { + Object o = this.opt(index); + return o instanceof JSONObject ? (JSONObject) o : null; + } + + /** + * Get the optional long value associated with an index. Zero is returned if + * there is no value for the index, or if the value is not a number and + * cannot be converted to a number. + * + * @param index + * The index must be between 0 and length() - 1. + * @return The value. + */ + public long optLong(int index) { + return this.optLong(index, 0); + } + + /** + * Get the optional long value associated with an index. The defaultValue is + * returned if there is no value for the index, or if the value is not a + * number and cannot be converted to a number. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return The value. + */ + public long optLong(int index, long defaultValue) { + try { + return this.getLong(index); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get the optional string value associated with an index. It returns an + * empty string if there is no value at that index. If the value is not a + * string and is not null, then it is coverted to a string. + * + * @param index + * The index must be between 0 and length() - 1. + * @return A String value. + */ + public String optString(int index) { + return this.optString(index, ""); + } + + /** + * Get the optional string associated with an index. The defaultValue is + * returned if the key is not found. + * + * @param index + * The index must be between 0 and length() - 1. + * @param defaultValue + * The default value. + * @return A String value. + */ + public String optString(int index, String defaultValue) { + Object object = this.opt(index); + return JSONObject.NULL.equals(object) ? defaultValue : object + .toString(); + } + + /** + * Append a boolean value. This increases the array's length by one. + * + * @param value + * A boolean value. + * @return this. + */ + public JSONArray put(boolean value) { + this.put(value ? Boolean.TRUE : Boolean.FALSE); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONArray which + * is produced from a Collection. + * + * @param value + * A Collection value. + * @return this. + */ + public JSONArray put(Collection value) { + this.put(new JSONArray(value)); + return this; + } + + /** + * Append a double value. This increases the array's length by one. + * + * @param value + * A double value. + * @throws JSONException + * if the value is not finite. + * @return this. + */ + public JSONArray put(double value) throws JSONException { + Double d = new Double(value); + JSONObject.testValidity(d); + this.put(d); + return this; + } + + /** + * Append an int value. This increases the array's length by one. + * + * @param value + * An int value. + * @return this. + */ + public JSONArray put(int value) { + this.put(new Integer(value)); + return this; + } + + /** + * Append an long value. This increases the array's length by one. + * + * @param value + * A long value. + * @return this. + */ + public JSONArray put(long value) { + this.put(new Long(value)); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONObject which + * is produced from a Map. + * + * @param value + * A Map value. + * @return this. + */ + public JSONArray put(Map value) { + this.put(new JSONObject(value)); + return this; + } + + /** + * Append an object value. This increases the array's length by one. + * + * @param value + * An object value. The value should be a Boolean, Double, + * Integer, JSONArray, JSONObject, Long, or String, or the + * JSONObject.NULL object. + * @return this. + */ + public JSONArray put(Object value) { + this.myArrayList.add(value); + return this; + } + + /** + * Put or replace a boolean value in the JSONArray. If the index is greater + * than the length of the JSONArray, then null elements will be added as + * necessary to pad it out. + * + * @param index + * The subscript. + * @param value + * A boolean value. + * @return this. + * @throws JSONException + * If the index is negative. + */ + public JSONArray put(int index, boolean value) throws JSONException { + this.put(index, value ? Boolean.TRUE : Boolean.FALSE); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONArray which + * is produced from a Collection. + * + * @param index + * The subscript. + * @param value + * A Collection value. + * @return this. + * @throws JSONException + * If the index is negative or if the value is not finite. + */ + public JSONArray put(int index, Collection value) throws JSONException { + this.put(index, new JSONArray(value)); + return this; + } + + /** + * Put or replace a double value. If the index is greater than the length of + * the JSONArray, then null elements will be added as necessary to pad it + * out. + * + * @param index + * The subscript. + * @param value + * A double value. + * @return this. + * @throws JSONException + * If the index is negative or if the value is not finite. + */ + public JSONArray put(int index, double value) throws JSONException { + this.put(index, new Double(value)); + return this; + } + + /** + * Put or replace an int value. If the index is greater than the length of + * the JSONArray, then null elements will be added as necessary to pad it + * out. + * + * @param index + * The subscript. + * @param value + * An int value. + * @return this. + * @throws JSONException + * If the index is negative. + */ + public JSONArray put(int index, int value) throws JSONException { + this.put(index, new Integer(value)); + return this; + } + + /** + * Put or replace a long value. If the index is greater than the length of + * the JSONArray, then null elements will be added as necessary to pad it + * out. + * + * @param index + * The subscript. + * @param value + * A long value. + * @return this. + * @throws JSONException + * If the index is negative. + */ + public JSONArray put(int index, long value) throws JSONException { + this.put(index, new Long(value)); + return this; + } + + /** + * Put a value in the JSONArray, where the value will be a JSONObject that + * is produced from a Map. + * + * @param index + * The subscript. + * @param value + * The Map value. + * @return this. + * @throws JSONException + * If the index is negative or if the the value is an invalid + * number. + */ + public JSONArray put(int index, Map value) throws JSONException { + this.put(index, new JSONObject(value)); + return this; + } + + /** + * Put or replace an object value in the JSONArray. If the index is greater + * than the length of the JSONArray, then null elements will be added as + * necessary to pad it out. + * + * @param index + * The subscript. + * @param value + * The value to put into the array. The value should be a + * Boolean, Double, Integer, JSONArray, JSONObject, Long, or + * String, or the JSONObject.NULL object. + * @return this. + * @throws JSONException + * If the index is negative or if the the value is an invalid + * number. + */ + public JSONArray put(int index, Object value) throws JSONException { + JSONObject.testValidity(value); + if (index < 0) { + throw new JSONException("JSONArray[" + index + "] not found."); + } + if (index < this.length()) { + this.myArrayList.set(index, value); + } else { + while (index != this.length()) { + this.put(JSONObject.NULL); + } + this.put(value); + } + return this; + } + + /** + * Remove an index and close the hole. + * + * @param index + * The index of the element to be removed. + * @return The value that was associated with the index, or null if there + * was no value. + */ + public Object remove(int index) { + return index >= 0 && index < this.length() + ? this.myArrayList.remove(index) + : null; + } + + /** + * Determine if two JSONArrays are similar. + * They must contain similar sequences. + * + * @param other The other JSONArray + * @return true if they are equal + */ + public boolean similar(Object other) { + if (!(other instanceof JSONArray)) { + return false; + } + int len = this.length(); + if (len != ((JSONArray)other).length()) { + return false; + } + for (int i = 0; i < len; i += 1) { + Object valueThis = this.get(i); + Object valueOther = ((JSONArray)other).get(i); + if (valueThis instanceof JSONObject) { + if (!((JSONObject)valueThis).similar(valueOther)) { + return false; + } + } else if (valueThis instanceof JSONArray) { + if (!((JSONArray)valueThis).similar(valueOther)) { + return false; + } + } else if (!valueThis.equals(valueOther)) { + return false; + } + } + return true; + } + + /** + * Produce a JSONObject by combining a JSONArray of names with the values of + * this JSONArray. + * + * @param names + * A JSONArray containing a list of key strings. These will be + * paired with the values. + * @return A JSONObject, or null if there are no names or if this JSONArray + * has no values. + * @throws JSONException + * If any of the names are null. + */ + public JSONObject toJSONObject(JSONArray names) throws JSONException { + if (names == null || names.length() == 0 || this.length() == 0) { + return null; + } + JSONObject jo = new JSONObject(); + for (int i = 0; i < names.length(); i += 1) { + jo.put(names.getString(i), this.opt(i)); + } + return jo; + } + + /** + * Make a JSON text of this JSONArray. For compactness, no unnecessary + * whitespace is added. If it is not possible to produce a syntactically + * correct JSON text then null will be returned instead. This could occur if + * the array contains an invalid number. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @return a printable, displayable, transmittable representation of the + * array. + */ + public String toString() { + try { + return this.toString(0); + } catch (Exception e) { + return null; + } + } + + /** + * Make a prettyprinted JSON text of this JSONArray. Warning: This method + * assumes that the data structure is acyclical. + * + * @param indentFactor + * The number of spaces to add to each level of indentation. + * @return a printable, displayable, transmittable representation of the + * object, beginning with [ (left + * bracket) and ending with ] + *  (right bracket). + * @throws JSONException + */ + public String toString(int indentFactor) throws JSONException { + StringWriter sw = new StringWriter(); + synchronized (sw.getBuffer()) { + return this.write(sw, indentFactor, 0).toString(); + } + } + + /** + * Write the contents of the JSONArray as JSON text to a writer. For + * compactness, no whitespace is added. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @return The writer. + * @throws JSONException + */ + public Writer write(Writer writer) throws JSONException { + return this.write(writer, 0, 0); + } + + /** + * Write the contents of the JSONArray as JSON text to a writer. For + * compactness, no whitespace is added. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @param indentFactor + * The number of spaces to add to each level of indentation. + * @param indent + * The indention of the top level. + * @return The writer. + * @throws JSONException + */ + Writer write(Writer writer, int indentFactor, int indent) + throws JSONException { + try { + boolean commanate = false; + int length = this.length(); + writer.write('['); + + if (length == 1) { + JSONObject.writeValue(writer, this.myArrayList.get(0), + indentFactor, indent); + } else if (length != 0) { + final int newindent = indent + indentFactor; + + for (int i = 0; i < length; i += 1) { + if (commanate) { + writer.write(','); + } + if (indentFactor > 0) { + writer.write('\n'); + } + JSONObject.indent(writer, newindent); + JSONObject.writeValue(writer, this.myArrayList.get(i), + indentFactor, newindent); + commanate = true; + } + if (indentFactor > 0) { + writer.write('\n'); + } + JSONObject.indent(writer, indent); + } + writer.write(']'); + return writer; + } catch (IOException e) { + throw new JSONException(e); + } + } +} diff --git a/org/json/JSONException.java b/org/json/JSONException.java new file mode 100644 index 0000000..6fef519 --- /dev/null +++ b/org/json/JSONException.java @@ -0,0 +1,43 @@ +package org.json; + +/** + * The JSONException is thrown by the JSON.org classes when things are amiss. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class JSONException extends RuntimeException { + private static final long serialVersionUID = 0; + private Throwable cause; + + /** + * Constructs a JSONException with an explanatory message. + * + * @param message + * Detail about the reason for the exception. + */ + public JSONException(String message) { + super(message); + } + + /** + * Constructs a new JSONException with the specified cause. + * @param cause The cause. + */ + public JSONException(Throwable cause) { + super(cause.getMessage()); + this.cause = cause; + } + + /** + * Returns the cause of this exception or null if the cause is nonexistent + * or unknown. + * + * @return the cause of this exception or null if the cause is nonexistent + * or unknown. + */ + @Override + public Throwable getCause() { + return this.cause; + } +} diff --git a/org/json/JSONML.java b/org/json/JSONML.java new file mode 100644 index 0000000..42027cb --- /dev/null +++ b/org/json/JSONML.java @@ -0,0 +1,469 @@ +package org.json; + +/* +Copyright (c) 2008 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +import java.util.Iterator; + + +/** + * This provides static methods to convert an XML text into a JSONArray or + * JSONObject, and to covert a JSONArray or JSONObject into an XML text using + * the JsonML transform. + * + * @author JSON.org + * @version 2014-05-03 + */ +public class JSONML { + + /** + * Parse XML values and store them in a JSONArray. + * @param x The XMLTokener containing the source string. + * @param arrayForm true if array form, false if object form. + * @param ja The JSONArray that is containing the current tag or null + * if we are at the outermost level. + * @return A JSONArray if the value is the outermost tag, otherwise null. + * @throws JSONException + */ + private static Object parse( + XMLTokener x, + boolean arrayForm, + JSONArray ja + ) throws JSONException { + String attribute; + char c; + String closeTag = null; + int i; + JSONArray newja = null; + JSONObject newjo = null; + Object token; + String tagName = null; + +// Test for and skip past these forms: +// +// +// +// + + while (true) { + if (!x.more()) { + throw x.syntaxError("Bad XML"); + } + token = x.nextContent(); + if (token == XML.LT) { + token = x.nextToken(); + if (token instanceof Character) { + if (token == XML.SLASH) { + +// Close tag "); + } else { + x.back(); + } + } else if (c == '[') { + token = x.nextToken(); + if (token.equals("CDATA") && x.next() == '[') { + if (ja != null) { + ja.put(x.nextCDATA()); + } + } else { + throw x.syntaxError("Expected 'CDATA['"); + } + } else { + i = 1; + do { + token = x.nextMeta(); + if (token == null) { + throw x.syntaxError("Missing '>' after ' 0); + } + } else if (token == XML.QUEST) { + +// "); + } else { + throw x.syntaxError("Misshaped tag"); + } + +// Open tag < + + } else { + if (!(token instanceof String)) { + throw x.syntaxError("Bad tagName '" + token + "'."); + } + tagName = (String)token; + newja = new JSONArray(); + newjo = new JSONObject(); + if (arrayForm) { + newja.put(tagName); + if (ja != null) { + ja.put(newja); + } + } else { + newjo.put("tagName", tagName); + if (ja != null) { + ja.put(newjo); + } + } + token = null; + for (;;) { + if (token == null) { + token = x.nextToken(); + } + if (token == null) { + throw x.syntaxError("Misshaped tag"); + } + if (!(token instanceof String)) { + break; + } + +// attribute = value + + attribute = (String)token; + if (!arrayForm && ("tagName".equals(attribute) || "childNode".equals(attribute))) { + throw x.syntaxError("Reserved attribute."); + } + token = x.nextToken(); + if (token == XML.EQ) { + token = x.nextToken(); + if (!(token instanceof String)) { + throw x.syntaxError("Missing value"); + } + newjo.accumulate(attribute, XML.stringToValue((String)token)); + token = null; + } else { + newjo.accumulate(attribute, ""); + } + } + if (arrayForm && newjo.length() > 0) { + newja.put(newjo); + } + +// Empty tag <.../> + + if (token == XML.SLASH) { + if (x.nextToken() != XML.GT) { + throw x.syntaxError("Misshaped tag"); + } + if (ja == null) { + if (arrayForm) { + return newja; + } else { + return newjo; + } + } + +// Content, between <...> and + + } else { + if (token != XML.GT) { + throw x.syntaxError("Misshaped tag"); + } + closeTag = (String)parse(x, arrayForm, newja); + if (closeTag != null) { + if (!closeTag.equals(tagName)) { + throw x.syntaxError("Mismatched '" + tagName + + "' and '" + closeTag + "'"); + } + tagName = null; + if (!arrayForm && newja.length() > 0) { + newjo.put("childNodes", newja); + } + if (ja == null) { + if (arrayForm) { + return newja; + } else { + return newjo; + } + } + } + } + } + } else { + if (ja != null) { + ja.put(token instanceof String + ? XML.stringToValue((String)token) + : token); + } + } + } + } + + + /** + * Convert a well-formed (but not necessarily valid) XML string into a + * JSONArray using the JsonML transform. Each XML tag is represented as + * a JSONArray in which the first element is the tag name. If the tag has + * attributes, then the second element will be JSONObject containing the + * name/value pairs. If the tag contains children, then strings and + * JSONArrays will represent the child tags. + * Comments, prologs, DTDs, and <[ [ ]]> are ignored. + * @param string The source string. + * @return A JSONArray containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONArray toJSONArray(String string) throws JSONException { + return toJSONArray(new XMLTokener(string)); + } + + + /** + * Convert a well-formed (but not necessarily valid) XML string into a + * JSONArray using the JsonML transform. Each XML tag is represented as + * a JSONArray in which the first element is the tag name. If the tag has + * attributes, then the second element will be JSONObject containing the + * name/value pairs. If the tag contains children, then strings and + * JSONArrays will represent the child content and tags. + * Comments, prologs, DTDs, and <[ [ ]]> are ignored. + * @param x An XMLTokener. + * @return A JSONArray containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONArray toJSONArray(XMLTokener x) throws JSONException { + return (JSONArray)parse(x, true, null); + } + + + /** + * Convert a well-formed (but not necessarily valid) XML string into a + * JSONObject using the JsonML transform. Each XML tag is represented as + * a JSONObject with a "tagName" property. If the tag has attributes, then + * the attributes will be in the JSONObject as properties. If the tag + * contains children, the object will have a "childNodes" property which + * will be an array of strings and JsonML JSONObjects. + + * Comments, prologs, DTDs, and <[ [ ]]> are ignored. + * @param x An XMLTokener of the XML source text. + * @return A JSONObject containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONObject toJSONObject(XMLTokener x) throws JSONException { + return (JSONObject)parse(x, false, null); + } + + + /** + * Convert a well-formed (but not necessarily valid) XML string into a + * JSONObject using the JsonML transform. Each XML tag is represented as + * a JSONObject with a "tagName" property. If the tag has attributes, then + * the attributes will be in the JSONObject as properties. If the tag + * contains children, the object will have a "childNodes" property which + * will be an array of strings and JsonML JSONObjects. + + * Comments, prologs, DTDs, and <[ [ ]]> are ignored. + * @param string The XML source text. + * @return A JSONObject containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException { + return toJSONObject(new XMLTokener(string)); + } + + + /** + * Reverse the JSONML transformation, making an XML text from a JSONArray. + * @param ja A JSONArray. + * @return An XML string. + * @throws JSONException + */ + public static String toString(JSONArray ja) throws JSONException { + int i; + JSONObject jo; + String key; + Iterator keys; + int length; + Object object; + StringBuilder sb = new StringBuilder(); + String tagName; + String value; + +// Emit = length) { + sb.append('/'); + sb.append('>'); + } else { + sb.append('>'); + do { + object = ja.get(i); + i += 1; + if (object != null) { + if (object instanceof String) { + sb.append(XML.escape(object.toString())); + } else if (object instanceof JSONObject) { + sb.append(toString((JSONObject)object)); + } else if (object instanceof JSONArray) { + sb.append(toString((JSONArray)object)); + } else { + sb.append(object.toString()); + } + } + } while (i < length); + sb.append('<'); + sb.append('/'); + sb.append(tagName); + sb.append('>'); + } + return sb.toString(); + } + + /** + * Reverse the JSONML transformation, making an XML text from a JSONObject. + * The JSONObject must contain a "tagName" property. If it has children, + * then it must have a "childNodes" property containing an array of objects. + * The other properties are attributes with string values. + * @param jo A JSONObject. + * @return An XML string. + * @throws JSONException + */ + public static String toString(JSONObject jo) throws JSONException { + StringBuilder sb = new StringBuilder(); + int i; + JSONArray ja; + String key; + Iterator keys; + int length; + Object object; + String tagName; + String value; + +//Emit '); + } else { + sb.append('>'); + length = ja.length(); + for (i = 0; i < length; i += 1) { + object = ja.get(i); + if (object != null) { + if (object instanceof String) { + sb.append(XML.escape(object.toString())); + } else if (object instanceof JSONObject) { + sb.append(toString((JSONObject)object)); + } else if (object instanceof JSONArray) { + sb.append(toString((JSONArray)object)); + } else { + sb.append(object.toString()); + } + } + } + sb.append('<'); + sb.append('/'); + sb.append(tagName); + sb.append('>'); + } + return sb.toString(); + } +} diff --git a/org/json/JSONObject.java b/org/json/JSONObject.java new file mode 100644 index 0000000..e28c9cd --- /dev/null +++ b/org/json/JSONObject.java @@ -0,0 +1,1695 @@ +package org.json; + +/* + Copyright (c) 2002 JSON.org + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + The Software shall be used for Good, not Evil. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + */ + +import java.io.IOException; +import java.io.StringWriter; +import java.io.Writer; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.util.Collection; +import java.util.Enumeration; +import java.util.HashMap; +import java.util.Iterator; +import java.util.Locale; +import java.util.Map; +import java.util.Map.Entry; +import java.util.ResourceBundle; +import java.util.Set; + +/** + * A JSONObject is an unordered collection of name/value pairs. Its external + * form is a string wrapped in curly braces with colons between the names and + * values, and commas between the values and names. The internal form is an + * object having get and opt methods for accessing + * the values by name, and put methods for adding or replacing + * values by name. The values can be any of these types: Boolean, + * JSONArray, JSONObject, Number, + * String, or the JSONObject.NULL object. A + * JSONObject constructor can be used to convert an external form JSON text + * into an internal form whose values can be retrieved with the + * get and opt methods, or to convert values into a + * JSON text using the put and toString methods. A + * get method returns a value if one can be found, and throws an + * exception if one cannot be found. An opt method returns a + * default value instead of throwing an exception, and so is useful for + * obtaining optional values. + *

+ * The generic get() and opt() methods return an + * object, which you can cast or query for type. There are also typed + * get and opt methods that do type checking and type + * coercion for you. The opt methods differ from the get methods in that they + * do not throw. Instead, they return a specified value, such as null. + *

+ * The put methods add or replace values in an object. For + * example, + * + * 

+ * myString = new JSONObject()
+ *         .put("JSON", "Hello, World!").toString();
+ *
+ * + * produces the string {"JSON": "Hello, World"}. + *

+ * The texts produced by the toString methods strictly conform to + * the JSON syntax rules. The constructors are more forgiving in the texts they + * will accept: + *

    + *
  • An extra , (comma) may appear just + * before the closing brace.
    • + *
  • Strings may be quoted with ' (single + * quote).
    • + *
  • Strings do not need to be quoted at all if they do not begin with a + * quote or single quote, and if they do not contain leading or trailing + * spaces, and if they do not contain any of these characters: + * { } [ ] / \ : , # and if they do not look like numbers and + * if they are not the reserved words true, false, + * or null.
    • + *
+ * + * @author JSON.org + * @version 2015-05-05 + */ +public class JSONObject { + /** + * JSONObject.NULL is equivalent to the value that JavaScript calls null, + * whilst Java's null is equivalent to the value that JavaScript calls + * undefined. + */ + private static final class Null { + + /** + * There is only intended to be a single instance of the NULL object, + * so the clone method returns itself. + * + * @return NULL. + */ + @Override + protected final Object clone() { + return this; + } + + /** + * A Null object is equal to the null value and to itself. + * + * @param object + * An object to test for nullness. + * @return true if the object parameter is the JSONObject.NULL object or + * null. + */ + @Override + public boolean equals(Object object) { + return object == null || object == this; + } + + /** + * Get the "null" string value. + * + * @return The string "null". + */ + public String toString() { + return "null"; + } + } + + /** + * The map where the JSONObject's properties are kept. + */ + private final Map map; + + /** + * It is sometimes more convenient and less ambiguous to have a + * NULL object than to use Java's null value. + * JSONObject.NULL.equals(null) returns true. + * JSONObject.NULL.toString() returns "null". + */ + public static final Object NULL = new Null(); + + /** + * Construct an empty JSONObject. + */ + public JSONObject() { + this.map = new HashMap(); + } + + /** + * Construct a JSONObject from a subset of another JSONObject. An array of + * strings is used to identify the keys that should be copied. Missing keys + * are ignored. + * + * @param jo + * A JSONObject. + * @param names + * An array of strings. + * @throws JSONException + * @exception JSONException + * If a value is a non-finite number or if a name is + * duplicated. + */ + public JSONObject(JSONObject jo, String[] names) { + this(); + for (int i = 0; i < names.length; i += 1) { + try { + this.putOnce(names[i], jo.opt(names[i])); + } catch (Exception ignore) { + } + } + } + + /** + * Construct a JSONObject from a JSONTokener. + * + * @param x + * A JSONTokener object containing the source string. + * @throws JSONException + * If there is a syntax error in the source string or a + * duplicated key. + */ + public JSONObject(JSONTokener x) throws JSONException { + this(); + char c; + String key; + + if (x.nextClean() != '{') { + throw x.syntaxError("A JSONObject text must begin with '{'"); + } + for (;;) { + c = x.nextClean(); + switch (c) { + case 0: + throw x.syntaxError("A JSONObject text must end with '}'"); + case '}': + return; + default: + x.back(); + key = x.nextValue().toString(); + } + +// The key is followed by ':'. + + c = x.nextClean(); + if (c != ':') { + throw x.syntaxError("Expected a ':' after a key"); + } + this.putOnce(key, x.nextValue()); + +// Pairs are separated by ','. + + switch (x.nextClean()) { + case ';': + case ',': + if (x.nextClean() == '}') { + return; + } + x.back(); + break; + case '}': + return; + default: + throw x.syntaxError("Expected a ',' or '}'"); + } + } + } + + /** + * Construct a JSONObject from a Map. + * + * @param map + * A map object that can be used to initialize the contents of + * the JSONObject. + * @throws JSONException + */ + public JSONObject(Map map) { + this.map = new HashMap(); + if (map != null) { + Iterator> i = map.entrySet().iterator(); + while (i.hasNext()) { + Entry entry = i.next(); + Object value = entry.getValue(); + if (value != null) { + this.map.put(entry.getKey(), wrap(value)); + } + } + } + } + + /** + * Construct a JSONObject from an Object using bean getters. It reflects on + * all of the public methods of the object. For each of the methods with no + * parameters and a name starting with "get" or + * "is" followed by an uppercase letter, the method is invoked, + * and a key and the value returned from the getter method are put into the + * new JSONObject. + * + * The key is formed by removing the "get" or "is" + * prefix. If the second remaining character is not upper case, then the + * first character is converted to lower case. + * + * For example, if an object has a method named "getName", and + * if the result of calling object.getName() is + * "Larry Fine", then the JSONObject will contain + * "name": "Larry Fine". + * + * @param bean + * An object that has getter methods that should be used to make + * a JSONObject. + */ + public JSONObject(Object bean) { + this(); + this.populateMap(bean); + } + + /** + * Construct a JSONObject from an Object, using reflection to find the + * public members. The resulting JSONObject's keys will be the strings from + * the names array, and the values will be the field values associated with + * those keys in the object. If a key is not found or not visible, then it + * will not be copied into the new JSONObject. + * + * @param object + * An object that has fields that should be used to make a + * JSONObject. + * @param names + * An array of strings, the names of the fields to be obtained + * from the object. + */ + public JSONObject(Object object, String names[]) { + this(); + Class c = object.getClass(); + for (int i = 0; i < names.length; i += 1) { + String name = names[i]; + try { + this.putOpt(name, c.getField(name).get(object)); + } catch (Exception ignore) { + } + } + } + + /** + * Construct a JSONObject from a source JSON text string. This is the most + * commonly used JSONObject constructor. + * + * @param source + * A string beginning with { (left + * brace) and ending with } + *  (right brace). + * @exception JSONException + * If there is a syntax error in the source string or a + * duplicated key. + */ + public JSONObject(String source) throws JSONException { + this(new JSONTokener(source)); + } + + /** + * Construct a JSONObject from a ResourceBundle. + * + * @param baseName + * The ResourceBundle base name. + * @param locale + * The Locale to load the ResourceBundle for. + * @throws JSONException + * If any JSONExceptions are detected. + */ + public JSONObject(String baseName, Locale locale) throws JSONException { + this(); + ResourceBundle bundle = ResourceBundle.getBundle(baseName, locale, + Thread.currentThread().getContextClassLoader()); + +// Iterate through the keys in the bundle. + + Enumeration keys = bundle.getKeys(); + while (keys.hasMoreElements()) { + Object key = keys.nextElement(); + if (key != null) { + +// Go through the path, ensuring that there is a nested JSONObject for each +// segment except the last. Add the value using the last segment's name into +// the deepest nested JSONObject. + + String[] path = ((String) key).split("\\."); + int last = path.length - 1; + JSONObject target = this; + for (int i = 0; i < last; i += 1) { + String segment = path[i]; + JSONObject nextTarget = target.optJSONObject(segment); + if (nextTarget == null) { + nextTarget = new JSONObject(); + target.put(segment, nextTarget); + } + target = nextTarget; + } + target.put(path[last], bundle.getString((String) key)); + } + } + } + + /** + * Accumulate values under a key. It is similar to the put method except + * that if there is already an object stored under the key then a JSONArray + * is stored under the key to hold all of the accumulated values. If there + * is already a JSONArray, then the new value is appended to it. In + * contrast, the put method replaces the previous value. + * + * If only one value is accumulated that is not a JSONArray, then the result + * will be the same as using put. But if multiple values are accumulated, + * then the result will be like append. + * + * @param key + * A key string. + * @param value + * An object to be accumulated under the key. + * @return this. + * @throws JSONException + * If the value is an invalid number or if the key is null. + */ + public JSONObject accumulate(String key, Object value) throws JSONException { + testValidity(value); + Object object = this.opt(key); + if (object == null) { + this.put(key, + value instanceof JSONArray ? new JSONArray().put(value) + : value); + } else if (object instanceof JSONArray) { + ((JSONArray) object).put(value); + } else { + this.put(key, new JSONArray().put(object).put(value)); + } + return this; + } + + /** + * Append values to the array under a key. If the key does not exist in the + * JSONObject, then the key is put in the JSONObject with its value being a + * JSONArray containing the value parameter. If the key was already + * associated with a JSONArray, then the value parameter is appended to it. + * + * @param key + * A key string. + * @param value + * An object to be accumulated under the key. + * @return this. + * @throws JSONException + * If the key is null or if the current value associated with + * the key is not a JSONArray. + */ + public JSONObject append(String key, Object value) throws JSONException { + testValidity(value); + Object object = this.opt(key); + if (object == null) { + this.put(key, new JSONArray().put(value)); + } else if (object instanceof JSONArray) { + this.put(key, ((JSONArray) object).put(value)); + } else { + throw new JSONException("JSONObject[" + key + + "] is not a JSONArray."); + } + return this; + } + + /** + * Produce a string from a double. The string "null" will be returned if the + * number is not finite. + * + * @param d + * A double. + * @return A String. + */ + public static String doubleToString(double d) { + if (Double.isInfinite(d) || Double.isNaN(d)) { + return "null"; + } + +// Shave off trailing zeros and decimal point, if possible. + + String string = Double.toString(d); + if (string.indexOf('.') > 0 && string.indexOf('e') < 0 + && string.indexOf('E') < 0) { + while (string.endsWith("0")) { + string = string.substring(0, string.length() - 1); + } + if (string.endsWith(".")) { + string = string.substring(0, string.length() - 1); + } + } + return string; + } + + /** + * Get the value object associated with a key. + * + * @param key + * A key string. + * @return The object associated with the key. + * @throws JSONException + * if the key is not found. + */ + public Object get(String key) throws JSONException { + if (key == null) { + throw new JSONException("Null key."); + } + Object object = this.opt(key); + if (object == null) { + throw new JSONException("JSONObject[" + quote(key) + "] not found."); + } + return object; + } + + /** + * Get the boolean value associated with a key. + * + * @param key + * A key string. + * @return The truth. + * @throws JSONException + * if the value is not a Boolean or the String "true" or + * "false". + */ + public boolean getBoolean(String key) throws JSONException { + Object object = this.get(key); + if (object.equals(Boolean.FALSE) + || (object instanceof String && ((String) object) + .equalsIgnoreCase("false"))) { + return false; + } else if (object.equals(Boolean.TRUE) + || (object instanceof String && ((String) object) + .equalsIgnoreCase("true"))) { + return true; + } + throw new JSONException("JSONObject[" + quote(key) + + "] is not a Boolean."); + } + + /** + * Get the double value associated with a key. + * + * @param key + * A key string. + * @return The numeric value. + * @throws JSONException + * if the key is not found or if the value is not a Number + * object and cannot be converted to a number. + */ + public double getDouble(String key) throws JSONException { + Object object = this.get(key); + try { + return object instanceof Number ? ((Number) object).doubleValue() + : Double.parseDouble((String) object); + } catch (Exception e) { + throw new JSONException("JSONObject[" + quote(key) + + "] is not a number."); + } + } + + /** + * Get the int value associated with a key. + * + * @param key + * A key string. + * @return The integer value. + * @throws JSONException + * if the key is not found or if the value cannot be converted + * to an integer. + */ + public int getInt(String key) throws JSONException { + Object object = this.get(key); + try { + return object instanceof Number ? ((Number) object).intValue() + : Integer.parseInt((String) object); + } catch (Exception e) { + throw new JSONException("JSONObject[" + quote(key) + + "] is not an int."); + } + } + + /** + * Get the JSONArray value associated with a key. + * + * @param key + * A key string. + * @return A JSONArray which is the value. + * @throws JSONException + * if the key is not found or if the value is not a JSONArray. + */ + public JSONArray getJSONArray(String key) throws JSONException { + Object object = this.get(key); + if (object instanceof JSONArray) { + return (JSONArray) object; + } + throw new JSONException("JSONObject[" + quote(key) + + "] is not a JSONArray."); + } + + /** + * Get the JSONObject value associated with a key. + * + * @param key + * A key string. + * @return A JSONObject which is the value. + * @throws JSONException + * if the key is not found or if the value is not a JSONObject. + */ + public JSONObject getJSONObject(String key) throws JSONException { + Object object = this.get(key); + if (object instanceof JSONObject) { + return (JSONObject) object; + } + throw new JSONException("JSONObject[" + quote(key) + + "] is not a JSONObject."); + } + + /** + * Get the long value associated with a key. + * + * @param key + * A key string. + * @return The long value. + * @throws JSONException + * if the key is not found or if the value cannot be converted + * to a long. + */ + public long getLong(String key) throws JSONException { + Object object = this.get(key); + try { + return object instanceof Number ? ((Number) object).longValue() + : Long.parseLong((String) object); + } catch (Exception e) { + throw new JSONException("JSONObject[" + quote(key) + + "] is not a long."); + } + } + + /** + * Get an array of field names from a JSONObject. + * + * @return An array of field names, or null if there are no names. + */ + public static String[] getNames(JSONObject jo) { + int length = jo.length(); + if (length == 0) { + return null; + } + Iterator iterator = jo.keys(); + String[] names = new String[length]; + int i = 0; + while (iterator.hasNext()) { + names[i] = iterator.next(); + i += 1; + } + return names; + } + + /** + * Get an array of field names from an Object. + * + * @return An array of field names, or null if there are no names. + */ + public static String[] getNames(Object object) { + if (object == null) { + return null; + } + Class klass = object.getClass(); + Field[] fields = klass.getFields(); + int length = fields.length; + if (length == 0) { + return null; + } + String[] names = new String[length]; + for (int i = 0; i < length; i += 1) { + names[i] = fields[i].getName(); + } + return names; + } + + /** + * Get the string associated with a key. + * + * @param key + * A key string. + * @return A string which is the value. + * @throws JSONException + * if there is no string value for the key. + */ + public String getString(String key) throws JSONException { + Object object = this.get(key); + if (object instanceof String) { + return (String) object; + } + throw new JSONException("JSONObject[" + quote(key) + "] not a string."); + } + + /** + * Determine if the JSONObject contains a specific key. + * + * @param key + * A key string. + * @return true if the key exists in the JSONObject. + */ + public boolean has(String key) { + return this.map.containsKey(key); + } + + /** + * Increment a property of a JSONObject. If there is no such property, + * create one with a value of 1. If there is such a property, and if it is + * an Integer, Long, Double, or Float, then add one to it. + * + * @param key + * A key string. + * @return this. + * @throws JSONException + * If there is already a property with this name that is not an + * Integer, Long, Double, or Float. + */ + public JSONObject increment(String key) throws JSONException { + Object value = this.opt(key); + if (value == null) { + this.put(key, 1); + } else if (value instanceof Integer) { + this.put(key, (Integer) value + 1); + } else if (value instanceof Long) { + this.put(key, (Long) value + 1); + } else if (value instanceof Double) { + this.put(key, (Double) value + 1); + } else if (value instanceof Float) { + this.put(key, (Float) value + 1); + } else { + throw new JSONException("Unable to increment [" + quote(key) + "]."); + } + return this; + } + + /** + * Determine if the value associated with the key is null or if there is no + * value. + * + * @param key + * A key string. + * @return true if there is no value associated with the key or if the value + * is the JSONObject.NULL object. + */ + public boolean isNull(String key) { + return JSONObject.NULL.equals(this.opt(key)); + } + + /** + * Get an enumeration of the keys of the JSONObject. + * + * @return An iterator of the keys. + */ + public Iterator keys() { + return this.keySet().iterator(); + } + + /** + * Get a set of keys of the JSONObject. + * + * @return A keySet. + */ + public Set keySet() { + return this.map.keySet(); + } + + /** + * Get the number of keys stored in the JSONObject. + * + * @return The number of keys in the JSONObject. + */ + public int length() { + return this.map.size(); + } + + /** + * Produce a JSONArray containing the names of the elements of this + * JSONObject. + * + * @return A JSONArray containing the key strings, or null if the JSONObject + * is empty. + */ + public JSONArray names() { + JSONArray ja = new JSONArray(); + Iterator keys = this.keys(); + while (keys.hasNext()) { + ja.put(keys.next()); + } + return ja.length() == 0 ? null : ja; + } + + /** + * Produce a string from a Number. + * + * @param number + * A Number + * @return A String. + * @throws JSONException + * If n is a non-finite number. + */ + public static String numberToString(Number number) throws JSONException { + if (number == null) { + throw new JSONException("Null pointer"); + } + testValidity(number); + +// Shave off trailing zeros and decimal point, if possible. + + String string = number.toString(); + if (string.indexOf('.') > 0 && string.indexOf('e') < 0 + && string.indexOf('E') < 0) { + while (string.endsWith("0")) { + string = string.substring(0, string.length() - 1); + } + if (string.endsWith(".")) { + string = string.substring(0, string.length() - 1); + } + } + return string; + } + + /** + * Get an optional value associated with a key. + * + * @param key + * A key string. + * @return An object which is the value, or null if there is no value. + */ + public Object opt(String key) { + return key == null ? null : this.map.get(key); + } + + /** + * Get an optional boolean associated with a key. It returns false if there + * is no such key, or if the value is not Boolean.TRUE or the String "true". + * + * @param key + * A key string. + * @return The truth. + */ + public boolean optBoolean(String key) { + return this.optBoolean(key, false); + } + + /** + * Get an optional boolean associated with a key. It returns the + * defaultValue if there is no such key, or if it is not a Boolean or the + * String "true" or "false" (case insensitive). + * + * @param key + * A key string. + * @param defaultValue + * The default. + * @return The truth. + */ + public boolean optBoolean(String key, boolean defaultValue) { + try { + return this.getBoolean(key); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get an optional double associated with a key, or NaN if there is no such + * key or if its value is not a number. If the value is a string, an attempt + * will be made to evaluate it as a number. + * + * @param key + * A string which is the key. + * @return An object which is the value. + */ + public double optDouble(String key) { + return this.optDouble(key, Double.NaN); + } + + /** + * Get an optional double associated with a key, or the defaultValue if + * there is no such key or if its value is not a number. If the value is a + * string, an attempt will be made to evaluate it as a number. + * + * @param key + * A key string. + * @param defaultValue + * The default. + * @return An object which is the value. + */ + public double optDouble(String key, double defaultValue) { + try { + return this.getDouble(key); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get an optional int value associated with a key, or zero if there is no + * such key or if the value is not a number. If the value is a string, an + * attempt will be made to evaluate it as a number. + * + * @param key + * A key string. + * @return An object which is the value. + */ + public int optInt(String key) { + return this.optInt(key, 0); + } + + /** + * Get an optional int value associated with a key, or the default if there + * is no such key or if the value is not a number. If the value is a string, + * an attempt will be made to evaluate it as a number. + * + * @param key + * A key string. + * @param defaultValue + * The default. + * @return An object which is the value. + */ + public int optInt(String key, int defaultValue) { + try { + return this.getInt(key); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get an optional JSONArray associated with a key. It returns null if there + * is no such key, or if its value is not a JSONArray. + * + * @param key + * A key string. + * @return A JSONArray which is the value. + */ + public JSONArray optJSONArray(String key) { + Object o = this.opt(key); + return o instanceof JSONArray ? (JSONArray) o : null; + } + + /** + * Get an optional JSONObject associated with a key. It returns null if + * there is no such key, or if its value is not a JSONObject. + * + * @param key + * A key string. + * @return A JSONObject which is the value. + */ + public JSONObject optJSONObject(String key) { + Object object = this.opt(key); + return object instanceof JSONObject ? (JSONObject) object : null; + } + + /** + * Get an optional long value associated with a key, or zero if there is no + * such key or if the value is not a number. If the value is a string, an + * attempt will be made to evaluate it as a number. + * + * @param key + * A key string. + * @return An object which is the value. + */ + public long optLong(String key) { + return this.optLong(key, 0); + } + + /** + * Get an optional long value associated with a key, or the default if there + * is no such key or if the value is not a number. If the value is a string, + * an attempt will be made to evaluate it as a number. + * + * @param key + * A key string. + * @param defaultValue + * The default. + * @return An object which is the value. + */ + public long optLong(String key, long defaultValue) { + try { + return this.getLong(key); + } catch (Exception e) { + return defaultValue; + } + } + + /** + * Get an optional string associated with a key. It returns an empty string + * if there is no such key. If the value is not a string and is not null, + * then it is converted to a string. + * + * @param key + * A key string. + * @return A string which is the value. + */ + public String optString(String key) { + return this.optString(key, ""); + } + + /** + * Get an optional string associated with a key. It returns the defaultValue + * if there is no such key. + * + * @param key + * A key string. + * @param defaultValue + * The default. + * @return A string which is the value. + */ + public String optString(String key, String defaultValue) { + Object object = this.opt(key); + return NULL.equals(object) ? defaultValue : object.toString(); + } + + private void populateMap(Object bean) { + Class klass = bean.getClass(); + +// If klass is a System class then set includeSuperClass to false. + + boolean includeSuperClass = klass.getClassLoader() != null; + + Method[] methods = includeSuperClass ? klass.getMethods() : klass + .getDeclaredMethods(); + for (int i = 0; i < methods.length; i += 1) { + try { + Method method = methods[i]; + if (Modifier.isPublic(method.getModifiers())) { + String name = method.getName(); + String key = ""; + if (name.startsWith("get")) { + if ("getClass".equals(name) + || "getDeclaringClass".equals(name)) { + key = ""; + } else { + key = name.substring(3); + } + } else if (name.startsWith("is")) { + key = name.substring(2); + } + if (key.length() > 0 + && Character.isUpperCase(key.charAt(0)) + && method.getParameterTypes().length == 0) { + if (key.length() == 1) { + key = key.toLowerCase(); + } else if (!Character.isUpperCase(key.charAt(1))) { + key = key.substring(0, 1).toLowerCase() + + key.substring(1); + } + + Object result = method.invoke(bean, (Object[]) null); + if (result != null) { + this.map.put(key, wrap(result)); + } + } + } + } catch (Exception ignore) { + } + } + } + + /** + * Put a key/boolean pair in the JSONObject. + * + * @param key + * A key string. + * @param value + * A boolean which is the value. + * @return this. + * @throws JSONException + * If the key is null. + */ + public JSONObject put(String key, boolean value) throws JSONException { + this.put(key, value ? Boolean.TRUE : Boolean.FALSE); + return this; + } + + /** + * Put a key/value pair in the JSONObject, where the value will be a + * JSONArray which is produced from a Collection. + * + * @param key + * A key string. + * @param value + * A Collection value. + * @return this. + * @throws JSONException + */ + public JSONObject put(String key, Collection value) throws JSONException { + this.put(key, new JSONArray(value)); + return this; + } + + /** + * Put a key/double pair in the JSONObject. + * + * @param key + * A key string. + * @param value + * A double which is the value. + * @return this. + * @throws JSONException + * If the key is null or if the number is invalid. + */ + public JSONObject put(String key, double value) throws JSONException { + this.put(key, new Double(value)); + return this; + } + + /** + * Put a key/int pair in the JSONObject. + * + * @param key + * A key string. + * @param value + * An int which is the value. + * @return this. + * @throws JSONException + * If the key is null. + */ + public JSONObject put(String key, int value) throws JSONException { + this.put(key, new Integer(value)); + return this; + } + + /** + * Put a key/long pair in the JSONObject. + * + * @param key + * A key string. + * @param value + * A long which is the value. + * @return this. + * @throws JSONException + * If the key is null. + */ + public JSONObject put(String key, long value) throws JSONException { + this.put(key, new Long(value)); + return this; + } + + /** + * Put a key/value pair in the JSONObject, where the value will be a + * JSONObject which is produced from a Map. + * + * @param key + * A key string. + * @param value + * A Map value. + * @return this. + * @throws JSONException + */ + public JSONObject put(String key, Map value) throws JSONException { + this.put(key, new JSONObject(value)); + return this; + } + + /** + * Put a key/value pair in the JSONObject. If the value is null, then the + * key will be removed from the JSONObject if it is present. + * + * @param key + * A key string. + * @param value + * An object which is the value. It should be of one of these + * types: Boolean, Double, Integer, JSONArray, JSONObject, Long, + * String, or the JSONObject.NULL object. + * @return this. + * @throws JSONException + * If the value is non-finite number or if the key is null. + */ + public JSONObject put(String key, Object value) throws JSONException { + if (key == null) { + throw new NullPointerException("Null key."); + } + if (value != null) { + testValidity(value); + this.map.put(key, value); + } else { + this.remove(key); + } + return this; + } + + /** + * Put a key/value pair in the JSONObject, but only if the key and the value + * are both non-null, and only if there is not already a member with that + * name. + * + * @param key string + * @param value object + * @return this. + * @throws JSONException + * if the key is a duplicate + */ + public JSONObject putOnce(String key, Object value) throws JSONException { + if (key != null && value != null) { + if (this.opt(key) != null) { + throw new JSONException("Duplicate key \"" + key + "\""); + } + this.put(key, value); + } + return this; + } + + /** + * Put a key/value pair in the JSONObject, but only if the key and the value + * are both non-null. + * + * @param key + * A key string. + * @param value + * An object which is the value. It should be of one of these + * types: Boolean, Double, Integer, JSONArray, JSONObject, Long, + * String, or the JSONObject.NULL object. + * @return this. + * @throws JSONException + * If the value is a non-finite number. + */ + public JSONObject putOpt(String key, Object value) throws JSONException { + if (key != null && value != null) { + this.put(key, value); + } + return this; + } + + /** + * Produce a string in double quotes with backslash sequences in all the + * right places. A backslash will be inserted within = '\u0080' && c < '\u00a0') + || (c >= '\u2000' && c < '\u2100')) { + w.write("\\u"); + hhhh = Integer.toHexString(c); + w.write("0000", 0, 4 - hhhh.length()); + w.write(hhhh); + } else { + w.write(c); + } + } + } + w.write('"'); + return w; + } + + /** + * Remove a name and its value, if present. + * + * @param key + * The name to be removed. + * @return The value that was associated with the name, or null if there was + * no value. + */ + public Object remove(String key) { + return this.map.remove(key); + } + + /** + * Determine if two JSONObjects are similar. + * They must contain the same set of names which must be associated with + * similar values. + * + * @param other The other JSONObject + * @return true if they are equal + */ + public boolean similar(Object other) { + try { + if (!(other instanceof JSONObject)) { + return false; + } + Set set = this.keySet(); + if (!set.equals(((JSONObject)other).keySet())) { + return false; + } + Iterator iterator = set.iterator(); + while (iterator.hasNext()) { + String name = iterator.next(); + Object valueThis = this.get(name); + Object valueOther = ((JSONObject)other).get(name); + if (valueThis instanceof JSONObject) { + if (!((JSONObject)valueThis).similar(valueOther)) { + return false; + } + } else if (valueThis instanceof JSONArray) { + if (!((JSONArray)valueThis).similar(valueOther)) { + return false; + } + } else if (!valueThis.equals(valueOther)) { + return false; + } + } + return true; + } catch (Throwable exception) { + return false; + } + } + + /** + * Try to convert a string into a number, boolean, or null. If the string + * can't be converted, return the string. + * + * @param string + * A String. + * @return A simple JSON value. + */ + public static Object stringToValue(String string) { + Double d; + if (string.equals("")) { + return string; + } + if (string.equalsIgnoreCase("true")) { + return Boolean.TRUE; + } + if (string.equalsIgnoreCase("false")) { + return Boolean.FALSE; + } + if (string.equalsIgnoreCase("null")) { + return JSONObject.NULL; + } + + /* + * If it might be a number, try converting it. If a number cannot be + * produced, then the value will just be a string. + */ + + char b = string.charAt(0); + if ((b >= '0' && b <= '9') || b == '-') { + try { + if (string.indexOf('.') > -1 || string.indexOf('e') > -1 + || string.indexOf('E') > -1) { + d = Double.valueOf(string); + if (!d.isInfinite() && !d.isNaN()) { + return d; + } + } else { + Long myLong = new Long(string); + if (string.equals(myLong.toString())) { + if (myLong == myLong.intValue()) { + return myLong.intValue(); + } else { + return myLong; + } + } + } + } catch (Exception ignore) { + } + } + return string; + } + + /** + * Throw an exception if the object is a NaN or infinite number. + * + * @param o + * The object to test. + * @throws JSONException + * If o is a non-finite number. + */ + public static void testValidity(Object o) throws JSONException { + if (o != null) { + if (o instanceof Double) { + if (((Double) o).isInfinite() || ((Double) o).isNaN()) { + throw new JSONException( + "JSON does not allow non-finite numbers."); + } + } else if (o instanceof Float) { + if (((Float) o).isInfinite() || ((Float) o).isNaN()) { + throw new JSONException( + "JSON does not allow non-finite numbers."); + } + } + } + } + + /** + * Produce a JSONArray containing the values of the members of this + * JSONObject. + * + * @param names + * A JSONArray containing a list of key strings. This determines + * the sequence of the values in the result. + * @return A JSONArray of values. + * @throws JSONException + * If any of the values are non-finite numbers. + */ + public JSONArray toJSONArray(JSONArray names) throws JSONException { + if (names == null || names.length() == 0) { + return null; + } + JSONArray ja = new JSONArray(); + for (int i = 0; i < names.length(); i += 1) { + ja.put(this.opt(names.getString(i))); + } + return ja; + } + + /** + * Make a JSON text of this JSONObject. For compactness, no whitespace is + * added. If this would not result in a syntactically correct JSON text, + * then null will be returned instead. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @return a printable, displayable, portable, transmittable representation + * of the object, beginning with { (left + * brace) and ending with } (right + * brace). + */ + public String toString() { + try { + return this.toString(0); + } catch (Exception e) { + return null; + } + } + + /** + * Make a prettyprinted JSON text of this JSONObject. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @param indentFactor + * The number of spaces to add to each level of indentation. + * @return a printable, displayable, portable, transmittable representation + * of the object, beginning with { (left + * brace) and ending with } (right + * brace). + * @throws JSONException + * If the object contains an invalid number. + */ + public String toString(int indentFactor) throws JSONException { + StringWriter w = new StringWriter(); + synchronized (w.getBuffer()) { + return this.write(w, indentFactor, 0).toString(); + } + } + + /** + * Make a JSON text of an Object value. If the object has an + * value.toJSONString() method, then that method will be used to produce the + * JSON text. The method is required to produce a strictly conforming text. + * If the object does not contain a toJSONString method (which is the most + * common case), then a text will be produced by other means. If the value + * is an array or Collection, then a JSONArray will be made from it and its + * toJSONString method will be called. If the value is a MAP, then a + * JSONObject will be made from it and its toJSONString method will be + * called. Otherwise, the value's toString method will be called, and the + * result will be quoted. + * + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @param value + * The value to be serialized. + * @return a printable, displayable, transmittable representation of the + * object, beginning with { (left + * brace) and ending with } (right + * brace). + * @throws JSONException + * If the value is or contains an invalid number. + */ + public static String valueToString(Object value) throws JSONException { + if (value == null || value.equals(null)) { + return "null"; + } + if (value instanceof JSONString) { + Object object; + try { + object = ((JSONString) value).toJSONString(); + } catch (Exception e) { + throw new JSONException(e); + } + if (object instanceof String) { + return (String) object; + } + throw new JSONException("Bad value from toJSONString: " + object); + } + if (value instanceof Number) { + return numberToString((Number) value); + } + if (value instanceof Boolean || value instanceof JSONObject + || value instanceof JSONArray) { + return value.toString(); + } + if (value instanceof Map) { + @SuppressWarnings("unchecked") + Map map = (Map) value; + return new JSONObject(map).toString(); + } + if (value instanceof Collection) { + @SuppressWarnings("unchecked") + Collection coll = (Collection) value; + return new JSONArray(coll).toString(); + } + if (value.getClass().isArray()) { + return new JSONArray(value).toString(); + } + return quote(value.toString()); + } + + /** + * Wrap an object, if necessary. If the object is null, return the NULL + * object. If it is an array or collection, wrap it in a JSONArray. If it is + * a map, wrap it in a JSONObject. If it is a standard property (Double, + * String, et al) then it is already wrapped. Otherwise, if it comes from + * one of the java packages, turn it into a string. And if it doesn't, try + * to wrap it in a JSONObject. If the wrapping fails, then null is returned. + * + * @param object + * The object to wrap + * @return The wrapped value + */ + public static Object wrap(Object object) { + try { + if (object == null) { + return NULL; + } + if (object instanceof JSONObject || object instanceof JSONArray + || NULL.equals(object) || object instanceof JSONString + || object instanceof Byte || object instanceof Character + || object instanceof Short || object instanceof Integer + || object instanceof Long || object instanceof Boolean + || object instanceof Float || object instanceof Double + || object instanceof String) { + return object; + } + + if (object instanceof Collection) { + @SuppressWarnings("unchecked") + Collection coll = (Collection) object; + return new JSONArray(coll); + } + if (object.getClass().isArray()) { + return new JSONArray(object); + } + if (object instanceof Map) { + @SuppressWarnings("unchecked") + Map map = (Map) object; + return new JSONObject(map); + } + Package objectPackage = object.getClass().getPackage(); + String objectPackageName = objectPackage != null ? objectPackage + .getName() : ""; + if (objectPackageName.startsWith("java.") + || objectPackageName.startsWith("javax.") + || object.getClass().getClassLoader() == null) { + return object.toString(); + } + return new JSONObject(object); + } catch (Exception exception) { + return null; + } + } + + /** + * Write the contents of the JSONObject as JSON text to a writer. For + * compactness, no whitespace is added. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @return The writer. + * @throws JSONException + */ + public Writer write(Writer writer) throws JSONException { + return this.write(writer, 0, 0); + } + + static final Writer writeValue(Writer writer, Object value, + int indentFactor, int indent) throws JSONException, IOException { + if (value == null || value.equals(null)) { + writer.write("null"); + } else if (value instanceof JSONObject) { + ((JSONObject) value).write(writer, indentFactor, indent); + } else if (value instanceof JSONArray) { + ((JSONArray) value).write(writer, indentFactor, indent); + } else if (value instanceof Map) { + @SuppressWarnings("unchecked") + Map map = (Map) value; + new JSONObject(map).write(writer, indentFactor, indent); + } else if (value instanceof Collection) { + @SuppressWarnings("unchecked") + Collection coll = (Collection) value; + new JSONArray(coll).write(writer, indentFactor, + indent); + } else if (value.getClass().isArray()) { + new JSONArray(value).write(writer, indentFactor, indent); + } else if (value instanceof Number) { + writer.write(numberToString((Number) value)); + } else if (value instanceof Boolean) { + writer.write(value.toString()); + } else if (value instanceof JSONString) { + Object o; + try { + o = ((JSONString) value).toJSONString(); + } catch (Exception e) { + throw new JSONException(e); + } + writer.write(o != null ? o.toString() : quote(value.toString())); + } else { + quote(value.toString(), writer); + } + return writer; + } + + static final void indent(Writer writer, int indent) throws IOException { + for (int i = 0; i < indent; i += 1) { + writer.write(' '); + } + } + + /** + * Write the contents of the JSONObject as JSON text to a writer. For + * compactness, no whitespace is added. + *

+ * Warning: This method assumes that the data structure is acyclical. + * + * @return The writer. + * @throws JSONException + */ + Writer write(Writer writer, int indentFactor, int indent) + throws JSONException { + try { + boolean commanate = false; + final int length = this.length(); + Iterator keys = this.keys(); + writer.write('{'); + + if (length == 1) { + Object key = keys.next(); + writer.write(quote(key.toString())); + writer.write(':'); + if (indentFactor > 0) { + writer.write(' '); + } + writeValue(writer, this.map.get(key), indentFactor, indent); + } else if (length != 0) { + final int newindent = indent + indentFactor; + while (keys.hasNext()) { + Object key = keys.next(); + if (commanate) { + writer.write(','); + } + if (indentFactor > 0) { + writer.write('\n'); + } + indent(writer, newindent); + writer.write(quote(key.toString())); + writer.write(':'); + if (indentFactor > 0) { + writer.write(' '); + } + writeValue(writer, this.map.get(key), indentFactor, newindent); + commanate = true; + } + if (indentFactor > 0) { + writer.write('\n'); + } + indent(writer, indent); + } + writer.write('}'); + return writer; + } catch (IOException exception) { + throw new JSONException(exception); + } + } +} diff --git a/org/json/JSONString.java b/org/json/JSONString.java new file mode 100644 index 0000000..1f2d77d --- /dev/null +++ b/org/json/JSONString.java @@ -0,0 +1,18 @@ +package org.json; +/** + * The JSONString interface allows a toJSONString() + * method so that a class can change the behavior of + * JSONObject.toString(), JSONArray.toString(), + * and JSONWriter.value(Object). The + * toJSONString method will be used instead of the default behavior + * of using the Object's toString() method and quoting the result. + */ +public interface JSONString { + /** + * The toJSONString method allows a class to produce its own JSON + * serialization. + * + * @return A strictly syntactically correct JSON text. + */ + public String toJSONString(); +} diff --git a/org/json/JSONStringer.java b/org/json/JSONStringer.java new file mode 100644 index 0000000..32c9f7f --- /dev/null +++ b/org/json/JSONStringer.java @@ -0,0 +1,78 @@ +package org.json; + +/* +Copyright (c) 2006 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +import java.io.StringWriter; + +/** + * JSONStringer provides a quick and convenient way of producing JSON text. + * The texts produced strictly conform to JSON syntax rules. No whitespace is + * added, so the results are ready for transmission or storage. Each instance of + * JSONStringer can produce one JSON text. + *

+ * A JSONStringer instance provides a value method for appending + * values to the + * text, and a key + * method for adding keys before values in objects. There are array + * and endArray methods that make and bound array values, and + * object and endObject methods which make and bound + * object values. All of these methods return the JSONWriter instance, + * permitting cascade style. For example, 

+ * myString = new JSONStringer()
+ *     .object()
+ *         .key("JSON")
+ *         .value("Hello, World!")
+ *     .endObject()
+ *     .toString();
which produces the string 
+ * {"JSON":"Hello, World!"}
+ *

+ * The first method called must be array or object. + * There are no methods for adding commas or colons. JSONStringer adds them for + * you. Objects and arrays can be nested up to 20 levels deep. + *

+ * This can sometimes be easier than using a JSONObject to build a string. + * @author JSON.org + * @version 2008-09-18 + */ +public class JSONStringer extends JSONWriter { + /** + * Make a fresh JSONStringer. It can be used to build one JSON text. + */ + public JSONStringer() { + super(new StringWriter()); + } + + /** + * Return the JSON text. This method is used to obtain the product of the + * JSONStringer instance. It will return null if there was a + * problem in the construction of the JSON text (such as the calls to + * array were not properly balanced with calls to + * endArray). + * @return The JSON text. + */ + public String toString() { + return this.mode == 'd' ? this.writer.toString() : null; + } +} diff --git a/org/json/JSONTokener.java b/org/json/JSONTokener.java new file mode 100644 index 0000000..32548ed --- /dev/null +++ b/org/json/JSONTokener.java @@ -0,0 +1,446 @@ +package org.json; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.StringReader; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +/** + * A JSONTokener takes a source string and extracts characters and tokens from + * it. It is used by the JSONObject and JSONArray constructors to parse + * JSON source strings. + * @author JSON.org + * @version 2014-05-03 + */ +public class JSONTokener { + + private long character; + private boolean eof; + private long index; + private long line; + private char previous; + private Reader reader; + private boolean usePrevious; + + + /** + * Construct a JSONTokener from a Reader. + * + * @param reader A reader. + */ + public JSONTokener(Reader reader) { + this.reader = reader.markSupported() + ? reader + : new BufferedReader(reader); + this.eof = false; + this.usePrevious = false; + this.previous = 0; + this.index = 0; + this.character = 1; + this.line = 1; + } + + + /** + * Construct a JSONTokener from an InputStream. + * @param inputStream The source. + */ + public JSONTokener(InputStream inputStream) throws JSONException { + this(new InputStreamReader(inputStream)); + } + + + /** + * Construct a JSONTokener from a string. + * + * @param s A source string. + */ + public JSONTokener(String s) { + this(new StringReader(s)); + } + + + /** + * Back up one character. This provides a sort of lookahead capability, + * so that you can test for a digit or letter before attempting to parse + * the next number or identifier. + */ + public void back() throws JSONException { + if (this.usePrevious || this.index <= 0) { + throw new JSONException("Stepping back two steps is not supported"); + } + this.index -= 1; + this.character -= 1; + this.usePrevious = true; + this.eof = false; + } + + + /** + * Get the hex value of a character (base16). + * @param c A character between '0' and '9' or between 'A' and 'F' or + * between 'a' and 'f'. + * @return An int between 0 and 15, or -1 if c was not a hex digit. + */ + public static int dehexchar(char c) { + if (c >= '0' && c <= '9') { + return c - '0'; + } + if (c >= 'A' && c <= 'F') { + return c - ('A' - 10); + } + if (c >= 'a' && c <= 'f') { + return c - ('a' - 10); + } + return -1; + } + + public boolean end() { + return this.eof && !this.usePrevious; + } + + + /** + * Determine if the source string still contains characters that next() + * can consume. + * @return true if not yet at the end of the source. + */ + public boolean more() throws JSONException { + this.next(); + if (this.end()) { + return false; + } + this.back(); + return true; + } + + + /** + * Get the next character in the source string. + * + * @return The next character, or 0 if past the end of the source string. + */ + public char next() throws JSONException { + int c; + if (this.usePrevious) { + this.usePrevious = false; + c = this.previous; + } else { + try { + c = this.reader.read(); + } catch (IOException exception) { + throw new JSONException(exception); + } + + if (c <= 0) { // End of stream + this.eof = true; + c = 0; + } + } + this.index += 1; + if (this.previous == '\r') { + this.line += 1; + this.character = c == '\n' ? 0 : 1; + } else if (c == '\n') { + this.line += 1; + this.character = 0; + } else { + this.character += 1; + } + this.previous = (char) c; + return this.previous; + } + + + /** + * Consume the next character, and check that it matches a specified + * character. + * @param c The character to match. + * @return The character. + * @throws JSONException if the character does not match. + */ + public char next(char c) throws JSONException { + char n = this.next(); + if (n != c) { + throw this.syntaxError("Expected '" + c + "' and instead saw '" + + n + "'"); + } + return n; + } + + + /** + * Get the next n characters. + * + * @param n The number of characters to take. + * @return A string of n characters. + * @throws JSONException + * Substring bounds error if there are not + * n characters remaining in the source string. + */ + public String next(int n) throws JSONException { + if (n == 0) { + return ""; + } + + char[] chars = new char[n]; + int pos = 0; + + while (pos < n) { + chars[pos] = this.next(); + if (this.end()) { + throw this.syntaxError("Substring bounds error"); + } + pos += 1; + } + return new String(chars); + } + + + /** + * Get the next char in the string, skipping whitespace. + * @throws JSONException + * @return A character, or 0 if there are no more characters. + */ + public char nextClean() throws JSONException { + for (;;) { + char c = this.next(); + if (c == 0 || c > ' ') { + return c; + } + } + } + + + /** + * Return the characters up to the next close quote character. + * Backslash processing is done. The formal JSON format does not + * allow strings in single quotes, but an implementation is allowed to + * accept them. + * @param quote The quoting character, either + * " (double quote) or + * ' (single quote). + * @return A String. + * @throws JSONException Unterminated string. + */ + public String nextString(char quote) throws JSONException { + char c; + StringBuilder sb = new StringBuilder(); + for (;;) { + c = this.next(); + switch (c) { + case 0: + case '\n': + case '\r': + throw this.syntaxError("Unterminated string"); + case '\\': + c = this.next(); + switch (c) { + case 'b': + sb.append('\b'); + break; + case 't': + sb.append('\t'); + break; + case 'n': + sb.append('\n'); + break; + case 'f': + sb.append('\f'); + break; + case 'r': + sb.append('\r'); + break; + case 'u': + sb.append((char)Integer.parseInt(this.next(4), 16)); + break; + case '"': + case '\'': + case '\\': + case '/': + sb.append(c); + break; + default: + throw this.syntaxError("Illegal escape."); + } + break; + default: + if (c == quote) { + return sb.toString(); + } + sb.append(c); + } + } + } + + + /** + * Get the text up but not including the specified character or the + * end of line, whichever comes first. + * @param delimiter A delimiter character. + * @return A string. + */ + public String nextTo(char delimiter) throws JSONException { + StringBuilder sb = new StringBuilder(); + for (;;) { + char c = this.next(); + if (c == delimiter || c == 0 || c == '\n' || c == '\r') { + if (c != 0) { + this.back(); + } + return sb.toString().trim(); + } + sb.append(c); + } + } + + + /** + * Get the text up but not including one of the specified delimiter + * characters or the end of line, whichever comes first. + * @param delimiters A set of delimiter characters. + * @return A string, trimmed. + */ + public String nextTo(String delimiters) throws JSONException { + char c; + StringBuilder sb = new StringBuilder(); + for (;;) { + c = this.next(); + if (delimiters.indexOf(c) >= 0 || c == 0 || + c == '\n' || c == '\r') { + if (c != 0) { + this.back(); + } + return sb.toString().trim(); + } + sb.append(c); + } + } + + + /** + * Get the next value. The value can be a Boolean, Double, Integer, + * JSONArray, JSONObject, Long, or String, or the JSONObject.NULL object. + * @throws JSONException If syntax error. + * + * @return An object. + */ + public Object nextValue() throws JSONException { + char c = this.nextClean(); + String string; + + switch (c) { + case '"': + case '\'': + return this.nextString(c); + case '{': + this.back(); + return new JSONObject(this); + case '[': + this.back(); + return new JSONArray(this); + } + + /* + * Handle unquoted text. This could be the values true, false, or + * null, or it can be a number. An implementation (such as this one) + * is allowed to also accept non-standard forms. + * + * Accumulate characters until we reach the end of the text or a + * formatting character. + */ + + StringBuilder sb = new StringBuilder(); + while (c >= ' ' && ",:]}/\\\"[{;=#".indexOf(c) < 0) { + sb.append(c); + c = this.next(); + } + this.back(); + + string = sb.toString().trim(); + if ("".equals(string)) { + throw this.syntaxError("Missing value"); + } + return JSONObject.stringToValue(string); + } + + + /** + * Skip characters until the next character is the requested character. + * If the requested character is not found, no characters are skipped. + * @param to A character to skip to. + * @return The requested character, or zero if the requested character + * is not found. + */ + public char skipTo(char to) throws JSONException { + char c; + try { + long startIndex = this.index; + long startCharacter = this.character; + long startLine = this.line; + this.reader.mark(1000000); + do { + c = this.next(); + if (c == 0) { + this.reader.reset(); + this.index = startIndex; + this.character = startCharacter; + this.line = startLine; + return c; + } + } while (c != to); + } catch (IOException exception) { + throw new JSONException(exception); + } + this.back(); + return c; + } + + + /** + * Make a JSONException to signal a syntax error. + * + * @param message The error message. + * @return A JSONException object, suitable for throwing + */ + public JSONException syntaxError(String message) { + return new JSONException(message + this.toString()); + } + + + /** + * Make a printable string of this JSONTokener. + * + * @return " at {index} [character {character} line {line}]" + */ + public String toString() { + return " at " + this.index + " [character " + this.character + " line " + + this.line + "]"; + } +} diff --git a/org/json/JSONWriter.java b/org/json/JSONWriter.java new file mode 100644 index 0000000..8c69caf --- /dev/null +++ b/org/json/JSONWriter.java @@ -0,0 +1,327 @@ +package org.json; + +import java.io.IOException; +import java.io.Writer; + +/* +Copyright (c) 2006 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +/** + * JSONWriter provides a quick and convenient way of producing JSON text. + * The texts produced strictly conform to JSON syntax rules. No whitespace is + * added, so the results are ready for transmission or storage. Each instance of + * JSONWriter can produce one JSON text. + *

+ * A JSONWriter instance provides a value method for appending + * values to the + * text, and a key + * method for adding keys before values in objects. There are array + * and endArray methods that make and bound array values, and + * object and endObject methods which make and bound + * object values. All of these methods return the JSONWriter instance, + * permitting a cascade style. For example, 

+ * new JSONWriter(myWriter)
+ *     .object()
+ *         .key("JSON")
+ *         .value("Hello, World!")
+ *     .endObject();
which writes 
+ * {"JSON":"Hello, World!"}
+ *

+ * The first method called must be array or object. + * There are no methods for adding commas or colons. JSONWriter adds them for + * you. Objects and arrays can be nested up to 20 levels deep. + *

+ * This can sometimes be easier than using a JSONObject to build a string. + * @author JSON.org + * @version 2011-11-24 + */ +public class JSONWriter { + private static final int maxdepth = 200; + + /** + * The comma flag determines if a comma should be output before the next + * value. + */ + private boolean comma; + + /** + * The current mode. Values: + * 'a' (array), + * 'd' (done), + * 'i' (initial), + * 'k' (key), + * 'o' (object). + */ + protected char mode; + + /** + * The object/array stack. + */ + private final JSONObject stack[]; + + /** + * The stack top index. A value of 0 indicates that the stack is empty. + */ + private int top; + + /** + * The writer that will receive the output. + */ + protected Writer writer; + + /** + * Make a fresh JSONWriter. It can be used to build one JSON text. + */ + public JSONWriter(Writer w) { + this.comma = false; + this.mode = 'i'; + this.stack = new JSONObject[maxdepth]; + this.top = 0; + this.writer = w; + } + + /** + * Append a value. + * @param string A string value. + * @return this + * @throws JSONException If the value is out of sequence. + */ + private JSONWriter append(String string) throws JSONException { + if (string == null) { + throw new JSONException("Null pointer"); + } + if (this.mode == 'o' || this.mode == 'a') { + try { + if (this.comma && this.mode == 'a') { + this.writer.write(','); + } + this.writer.write(string); + } catch (IOException e) { + throw new JSONException(e); + } + if (this.mode == 'o') { + this.mode = 'k'; + } + this.comma = true; + return this; + } + throw new JSONException("Value out of sequence."); + } + + /** + * Begin appending a new array. All values until the balancing + * endArray will be appended to this array. The + * endArray method must be called to mark the array's end. + * @return this + * @throws JSONException If the nesting is too deep, or if the object is + * started in the wrong place (for example as a key or after the end of the + * outermost array or object). + */ + public JSONWriter array() throws JSONException { + if (this.mode == 'i' || this.mode == 'o' || this.mode == 'a') { + this.push(null); + this.append("["); + this.comma = false; + return this; + } + throw new JSONException("Misplaced array."); + } + + /** + * End something. + * @param mode Mode + * @param c Closing character + * @return this + * @throws JSONException If unbalanced. + */ + private JSONWriter end(char mode, char c) throws JSONException { + if (this.mode != mode) { + throw new JSONException(mode == 'a' + ? "Misplaced endArray." + : "Misplaced endObject."); + } + this.pop(mode); + try { + this.writer.write(c); + } catch (IOException e) { + throw new JSONException(e); + } + this.comma = true; + return this; + } + + /** + * End an array. This method most be called to balance calls to + * array. + * @return this + * @throws JSONException If incorrectly nested. + */ + public JSONWriter endArray() throws JSONException { + return this.end('a', ']'); + } + + /** + * End an object. This method most be called to balance calls to + * object. + * @return this + * @throws JSONException If incorrectly nested. + */ + public JSONWriter endObject() throws JSONException { + return this.end('k', '}'); + } + + /** + * Append a key. The key will be associated with the next value. In an + * object, every value must be preceded by a key. + * @param string A key string. + * @return this + * @throws JSONException If the key is out of place. For example, keys + * do not belong in arrays or if the key is null. + */ + public JSONWriter key(String string) throws JSONException { + if (string == null) { + throw new JSONException("Null key."); + } + if (this.mode == 'k') { + try { + this.stack[this.top - 1].putOnce(string, Boolean.TRUE); + if (this.comma) { + this.writer.write(','); + } + this.writer.write(JSONObject.quote(string)); + this.writer.write(':'); + this.comma = false; + this.mode = 'o'; + return this; + } catch (IOException e) { + throw new JSONException(e); + } + } + throw new JSONException("Misplaced key."); + } + + + /** + * Begin appending a new object. All keys and values until the balancing + * endObject will be appended to this object. The + * endObject method must be called to mark the object's end. + * @return this + * @throws JSONException If the nesting is too deep, or if the object is + * started in the wrong place (for example as a key or after the end of the + * outermost array or object). + */ + public JSONWriter object() throws JSONException { + if (this.mode == 'i') { + this.mode = 'o'; + } + if (this.mode == 'o' || this.mode == 'a') { + this.append("{"); + this.push(new JSONObject()); + this.comma = false; + return this; + } + throw new JSONException("Misplaced object."); + + } + + + /** + * Pop an array or object scope. + * @param c The scope to close. + * @throws JSONException If nesting is wrong. + */ + private void pop(char c) throws JSONException { + if (this.top <= 0) { + throw new JSONException("Nesting error."); + } + char m = this.stack[this.top - 1] == null ? 'a' : 'k'; + if (m != c) { + throw new JSONException("Nesting error."); + } + this.top -= 1; + this.mode = this.top == 0 + ? 'd' + : this.stack[this.top - 1] == null + ? 'a' + : 'k'; + } + + /** + * Push an array or object scope. + * @param jo The scope to open. + * @throws JSONException If nesting is too deep. + */ + private void push(JSONObject jo) throws JSONException { + if (this.top >= maxdepth) { + throw new JSONException("Nesting too deep."); + } + this.stack[this.top] = jo; + this.mode = jo == null ? 'a' : 'k'; + this.top += 1; + } + + + /** + * Append either the value true or the value + * false. + * @param b A boolean. + * @return this + * @throws JSONException + */ + public JSONWriter value(boolean b) throws JSONException { + return this.append(b ? "true" : "false"); + } + + /** + * Append a double value. + * @param d A double. + * @return this + * @throws JSONException If the number is not finite. + */ + public JSONWriter value(double d) throws JSONException { + return this.value(new Double(d)); + } + + /** + * Append a long value. + * @param l A long. + * @return this + * @throws JSONException + */ + public JSONWriter value(long l) throws JSONException { + return this.append(Long.toString(l)); + } + + + /** + * Append an object value. + * @param object The object to append. It can be null, or a Boolean, Number, + * String, JSONObject, or JSONArray, or an object that implements JSONString. + * @return this + * @throws JSONException If the value is out of sequence. + */ + public JSONWriter value(Object object) throws JSONException { + return this.append(JSONObject.valueToString(object)); + } +} diff --git a/org/json/Property.java b/org/json/Property.java new file mode 100644 index 0000000..73ddb12 --- /dev/null +++ b/org/json/Property.java @@ -0,0 +1,72 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +import java.util.Enumeration; +import java.util.Iterator; +import java.util.Properties; + +/** + * Converts a Property file data into JSONObject and back. + * @author JSON.org + * @version 2015-05-05 + */ +public class Property { + /** + * Converts a property file object into a JSONObject. The property file object is a table of name value pairs. + * @param properties java.util.Properties + * @return JSONObject + * @throws JSONException + */ + public static JSONObject toJSONObject(java.util.Properties properties) throws JSONException { + JSONObject jo = new JSONObject(); + if (properties != null && !properties.isEmpty()) { + Enumeration enumProperties = properties.propertyNames(); + while(enumProperties.hasMoreElements()) { + String name = (String)enumProperties.nextElement(); + jo.put(name, properties.getProperty(name)); + } + } + return jo; + } + + /** + * Converts the JSONObject into a property file object. + * @param jo JSONObject + * @return java.util.Properties + * @throws JSONException + */ + public static Properties toProperties(JSONObject jo) throws JSONException { + Properties properties = new Properties(); + if (jo != null) { + Iterator keys = jo.keys(); + while (keys.hasNext()) { + String name = keys.next(); + properties.put(name, jo.getString(name)); + } + } + return properties; + } +} diff --git a/org/json/README b/org/json/README new file mode 100644 index 0000000..2de22ff --- /dev/null +++ b/org/json/README @@ -0,0 +1,73 @@ +JSON in Java [package org.json] + +This package needs a new owner. I have not used it in over a decade, and I do +not have time to maintain programs that I do not use. + +If you think you can give this package a good home, please contact me. + +Douglas Crockford +douglas@crockford.com + +2015-02-06 + + +JSON is a light-weight, language independent, data interchange format. +See http://www.JSON.org/ + +The files in this package implement JSON encoders/decoders in Java. +It also includes the capability to convert between JSON and XML, HTTP +headers, Cookies, and CDL. + +This is a reference implementation. There is a large number of JSON packages +in Java. Perhaps someday the Java community will standardize on one. Until +then, choose carefully. + +The license includes this restriction: "The software shall be used for good, +not evil." If your conscience cannot live with that, then choose a different +package. + +The package compiles on Java 1.8. + + +JSONObject.java: The JSONObject can parse text from a String or a JSONTokener +to produce a map-like object. The object provides methods for manipulating its +contents, and for producing a JSON compliant object serialization. + +JSONArray.java: The JSONObject can parse text from a String or a JSONTokener +to produce a vector-like object. The object provides methods for manipulating +its contents, and for producing a JSON compliant array serialization. + +JSONTokener.java: The JSONTokener breaks a text into a sequence of individual +tokens. It can be constructed from a String, Reader, or InputStream. + +JSONException.java: The JSONException is the standard exception type thrown +by this package. + + +JSONString.java: The JSONString interface requires a toJSONString method, +allowing an object to provide its own serialization. + +JSONStringer.java: The JSONStringer provides a convenient facility for +building JSON strings. + +JSONWriter.java: The JSONWriter provides a convenient facility for building +JSON text through a writer. + + +CDL.java: CDL provides support for converting between JSON and comma +delimited lists. + +Cookie.java: Cookie provides support for converting between JSON and cookies. + +CookieList.java: CookieList provides support for converting between JSON and +cookie lists. + +HTTP.java: HTTP provides support for converting between JSON and HTTP headers. + +HTTPTokener.java: HTTPTokener extends JSONTokener for parsing HTTP headers. + +XML.java: XML provides support for converting between JSON and XML. + +JSONML.java: JSONML provides support for converting between JSONML and XML. + +XMLTokener.java: XMLTokener extends JSONTokener for parsing XML text. diff --git a/org/json/XML.java b/org/json/XML.java new file mode 100644 index 0000000..07090ab --- /dev/null +++ b/org/json/XML.java @@ -0,0 +1,490 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +import java.util.Iterator; + +/** + * This provides static methods to convert an XML text into a JSONObject, + * and to covert a JSONObject into an XML text. + * @author JSON.org + * @version 2014-05-03 + */ +public class XML { + + /** The Character '&'. */ + public static final Character AMP = '&'; + + /** The Character '''. */ + public static final Character APOS = '\''; + + /** The Character '!'. */ + public static final Character BANG = '!'; + + /** The Character '='. */ + public static final Character EQ = '='; + + /** The Character '>'. */ + public static final Character GT = '>'; + + /** The Character '<'. */ + public static final Character LT = '<'; + + /** The Character '?'. */ + public static final Character QUEST = '?'; + + /** The Character '"'. */ + public static final Character QUOT = '"'; + + /** The Character '/'. */ + public static final Character SLASH = '/'; + + /** + * Replace special characters with XML escapes: + * 

+     * & (ampersand) is replaced by &amp;
+     * < (less than) is replaced by &lt;
+     * > (greater than) is replaced by &gt;
+     * " (double quote) is replaced by &quot;
+     *
+ * @param string The string to be escaped. + * @return The escaped string. + */ + public static String escape(String string) { + StringBuilder sb = new StringBuilder(string.length()); + for (int i = 0, length = string.length(); i < length; i++) { + char c = string.charAt(i); + switch (c) { + case '&': + sb.append("&"); + break; + case '<': + sb.append("<"); + break; + case '>': + sb.append(">"); + break; + case '"': + sb.append("""); + break; + case '\'': + sb.append("'"); + break; + default: + sb.append(c); + } + } + return sb.toString(); + } + + /** + * Throw an exception if the string contains whitespace. + * Whitespace is not allowed in tagNames and attributes. + * @param string A string. + * @throws JSONException + */ + public static void noSpace(String string) throws JSONException { + int i, length = string.length(); + if (length == 0) { + throw new JSONException("Empty string."); + } + for (i = 0; i < length; i += 1) { + if (Character.isWhitespace(string.charAt(i))) { + throw new JSONException("'" + string + + "' contains a space character."); + } + } + } + + /** + * Scan the content following the named tag, attaching it to the context. + * @param x The XMLTokener containing the source string. + * @param context The JSONObject that will include the new material. + * @param name The tag name. + * @return true if the close tag is processed. + * @throws JSONException + */ + private static boolean parse(XMLTokener x, JSONObject context, + String name) throws JSONException { + char c; + int i; + JSONObject jsonobject = null; + String string; + String tagName; + Object token; + +// Test for and skip past these forms: +// +// +// +// +// Report errors for these forms: +// <> +// <= +// << + + token = x.nextToken(); + +// "); + return false; + } + x.back(); + } else if (c == '[') { + token = x.nextToken(); + if ("CDATA".equals(token)) { + if (x.next() == '[') { + string = x.nextCDATA(); + if (string.length() > 0) { + context.accumulate("content", string); + } + return false; + } + } + throw x.syntaxError("Expected 'CDATA['"); + } + i = 1; + do { + token = x.nextMeta(); + if (token == null) { + throw x.syntaxError("Missing '>' after ' 0); + return false; + } else if (token == QUEST) { + +// "); + return false; + } else if (token == SLASH) { + +// Close tag + + } else if (token == SLASH) { + if (x.nextToken() != GT) { + throw x.syntaxError("Misshaped tag"); + } + if (jsonobject.length() > 0) { + context.accumulate(tagName, jsonobject); + } else { + context.accumulate(tagName, ""); + } + return false; + +// Content, between <...> and + + } else if (token == GT) { + for (;;) { + token = x.nextContent(); + if (token == null) { + if (tagName != null) { + throw x.syntaxError("Unclosed tag " + tagName); + } + return false; + } else if (token instanceof String) { + string = (String)token; + if (string.length() > 0) { + jsonobject.accumulate("content", + XML.stringToValue(string)); + } + +// Nested element + + } else if (token == LT) { + if (parse(x, jsonobject, tagName)) { + if (jsonobject.length() == 0) { + context.accumulate(tagName, ""); + } else if (jsonobject.length() == 1 && + jsonobject.opt("content") != null) { + context.accumulate(tagName, + jsonobject.opt("content")); + } else { + context.accumulate(tagName, jsonobject); + } + return false; + } + } + } + } else { + throw x.syntaxError("Misshaped tag"); + } + } + } + } + + + /** + * Try to convert a string into a number, boolean, or null. If the string + * can't be converted, return the string. This is much less ambitious than + * JSONObject.stringToValue, especially because it does not attempt to + * convert plus forms, octal forms, hex forms, or E forms lacking decimal + * points. + * @param string A String. + * @return A simple JSON value. + */ + public static Object stringToValue(String string) { + if ("true".equalsIgnoreCase(string)) { + return Boolean.TRUE; + } + if ("false".equalsIgnoreCase(string)) { + return Boolean.FALSE; + } + if ("null".equalsIgnoreCase(string)) { + return JSONObject.NULL; + } + +// If it might be a number, try converting it, first as a Long, and then as a +// Double. If that doesn't work, return the string. + + try { + char initial = string.charAt(0); + if (initial == '-' || (initial >= '0' && initial <= '9')) { + Long value = new Long(string); + if (value.toString().equals(string)) { + return value; + } + } + } catch (Exception ignore) { + try { + Double value = new Double(string); + if (value.toString().equals(string)) { + return value; + } + } catch (Exception ignoreAlso) { + } + } + return string; + } + + + /** + * Convert a well-formed (but not necessarily valid) XML string into a + * JSONObject. Some information may be lost in this transformation + * because JSON is a data format and XML is a document format. XML uses + * elements, attributes, and content text, while JSON uses unordered + * collections of name/value pairs and arrays of values. JSON does not + * does not like to distinguish between elements and attributes. + * Sequences of similar elements are represented as JSONArrays. Content + * text may be placed in a "content" member. Comments, prologs, DTDs, and + * <[ [ ]]> are ignored. + * @param string The source string. + * @return A JSONObject containing the structured data from the XML string. + * @throws JSONException + */ + public static JSONObject toJSONObject(String string) throws JSONException { + JSONObject jo = new JSONObject(); + XMLTokener x = new XMLTokener(string); + while (x.more() && x.skipPast("<")) { + parse(x, jo, null); + } + return jo; + } + + + /** + * Convert a JSONObject into a well-formed, element-normal XML string. + * @param object A JSONObject. + * @return A string. + * @throws JSONException + */ + public static String toString(Object object) throws JSONException { + return toString(object, null); + } + + + /** + * Convert a JSONObject into a well-formed, element-normal XML string. + * @param object A JSONObject. + * @param tagName The optional name of the enclosing tag. + * @return A string. + * @throws JSONException + */ + public static String toString(Object object, String tagName) + throws JSONException { + StringBuilder sb = new StringBuilder(); + int i; + JSONArray ja; + JSONObject jo; + String key; + Iterator keys; + int length; + String string; + Object value; + if (object instanceof JSONObject) { + +// Emit + + if (tagName != null) { + sb.append('<'); + sb.append(tagName); + sb.append('>'); + } + +// Loop thru the keys. + + jo = (JSONObject)object; + keys = jo.keys(); + while (keys.hasNext()) { + key = keys.next(); + value = jo.opt(key); + if (value == null) { + value = ""; + } + string = value instanceof String ? (String)value : null; + +// Emit content in body + + if ("content".equals(key)) { + if (value instanceof JSONArray) { + ja = (JSONArray)value; + length = ja.length(); + for (i = 0; i < length; i += 1) { + if (i > 0) { + sb.append('\n'); + } + sb.append(escape(ja.get(i).toString())); + } + } else { + sb.append(escape(value.toString())); + } + +// Emit an array of similar keys + + } else if (value instanceof JSONArray) { + ja = (JSONArray)value; + length = ja.length(); + for (i = 0; i < length; i += 1) { + value = ja.get(i); + if (value instanceof JSONArray) { + sb.append('<'); + sb.append(key); + sb.append('>'); + sb.append(toString(value)); + sb.append("'); + } else { + sb.append(toString(value, key)); + } + } + } else if ("".equals(value)) { + sb.append('<'); + sb.append(key); + sb.append("/>"); + +// Emit a new tag + + } else { + sb.append(toString(value, key)); + } + } + if (tagName != null) { + +// Emit the close tag + + sb.append("'); + } + return sb.toString(); + +// XML does not have good support for arrays. If an array appears in a place +// where XML is lacking, synthesize an element. + + } else { + if (object.getClass().isArray()) { + object = new JSONArray(object); + } + if (object instanceof JSONArray) { + ja = (JSONArray)object; + length = ja.length(); + for (i = 0; i < length; i += 1) { + sb.append(toString(ja.opt(i), tagName == null ? "array" : tagName)); + } + return sb.toString(); + } else { + string = (object == null) ? "null" : escape(object.toString()); + return (tagName == null) ? "\"" + string + "\"" : + (string.length() == 0) ? "<" + tagName + "/>" : + "<" + tagName + ">" + string + ""; + } + } + } +} diff --git a/org/json/XMLTokener.java b/org/json/XMLTokener.java new file mode 100644 index 0000000..d319765 --- /dev/null +++ b/org/json/XMLTokener.java @@ -0,0 +1,365 @@ +package org.json; + +/* +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +*/ + +/** + * The XMLTokener extends the JSONTokener to provide additional methods + * for the parsing of XML texts. + * @author JSON.org + * @version 2014-05-03 + */ +public class XMLTokener extends JSONTokener { + + + /** The table of entity values. It initially contains Character values for + * amp, apos, gt, lt, quot. + */ + public static final java.util.HashMap entity; + + static { + entity = new java.util.HashMap(8); + entity.put("amp", XML.AMP); + entity.put("apos", XML.APOS); + entity.put("gt", XML.GT); + entity.put("lt", XML.LT); + entity.put("quot", XML.QUOT); + } + + /** + * Construct an XMLTokener from a string. + * @param s A source string. + */ + public XMLTokener(String s) { + super(s); + } + + /** + * Get the text in the CDATA block. + * @return The string up to the ]]>. + * @throws JSONException If the ]]> is not found. + */ + public String nextCDATA() throws JSONException { + char c; + int i; + StringBuilder sb = new StringBuilder(); + for (;;) { + c = next(); + if (end()) { + throw syntaxError("Unclosed CDATA"); + } + sb.append(c); + i = sb.length() - 3; + if (i >= 0 && sb.charAt(i) == ']' && + sb.charAt(i + 1) == ']' && sb.charAt(i + 2) == '>') { + sb.setLength(i); + return sb.toString(); + } + } + } + + + /** + * Get the next XML outer token, trimming whitespace. There are two kinds + * of tokens: the '<' character which begins a markup tag, and the content + * text between markup tags. + * + * @return A string, or a '<' Character, or null if there is no more + * source text. + * @throws JSONException + */ + public Object nextContent() throws JSONException { + char c; + StringBuilder sb; + do { + c = next(); + } while (Character.isWhitespace(c)); + if (c == 0) { + return null; + } + if (c == '<') { + return XML.LT; + } + sb = new StringBuilder(); + for (;;) { + if (c == '<' || c == 0) { + back(); + return sb.toString().trim(); + } + if (c == '&') { + sb.append(nextEntity(c)); + } else { + sb.append(c); + } + c = next(); + } + } + + + /** + * Return the next entity. These entities are translated to Characters: + * & ' > < ". + * @param ampersand An ampersand character. + * @return A Character or an entity String if the entity is not recognized. + * @throws JSONException If missing ';' in XML entity. + */ + public Object nextEntity(char ampersand) throws JSONException { + StringBuilder sb = new StringBuilder(); + for (;;) { + char c = next(); + if (Character.isLetterOrDigit(c) || c == '#') { + sb.append(Character.toLowerCase(c)); + } else if (c == ';') { + break; + } else { + throw syntaxError("Missing ';' in XML entity: &" + sb); + } + } + String string = sb.toString(); + Object object = entity.get(string); + return object != null ? object : ampersand + string + ";"; + } + + + /** + * Returns the next XML meta token. This is used for skipping over + * and structures. + * @return Syntax characters (< > / = ! ?) are returned as + * Character, and strings and names are returned as Boolean. We don't care + * what the values actually are. + * @throws JSONException If a string is not properly closed or if the XML + * is badly structured. + */ + public Object nextMeta() throws JSONException { + char c; + char q; + do { + c = next(); + } while (Character.isWhitespace(c)); + switch (c) { + case 0: + throw syntaxError("Misshaped meta tag"); + case '<': + return XML.LT; + case '>': + return XML.GT; + case '/': + return XML.SLASH; + case '=': + return XML.EQ; + case '!': + return XML.BANG; + case '?': + return XML.QUEST; + case '"': + case '\'': + q = c; + for (;;) { + c = next(); + if (c == 0) { + throw syntaxError("Unterminated string"); + } + if (c == q) { + return Boolean.TRUE; + } + } + default: + for (;;) { + c = next(); + if (Character.isWhitespace(c)) { + return Boolean.TRUE; + } + switch (c) { + case 0: + case '<': + case '>': + case '/': + case '=': + case '!': + case '?': + case '"': + case '\'': + back(); + return Boolean.TRUE; + } + } + } + } + + + /** + * Get the next XML Token. These tokens are found inside of angle + * brackets. It may be one of these characters: / > = ! ? or it + * may be a string wrapped in single quotes or double quotes, or it may be a + * name. + * @return a String or a Character. + * @throws JSONException If the XML is not well formed. + */ + public Object nextToken() throws JSONException { + char c; + char q; + StringBuilder sb; + do { + c = next(); + } while (Character.isWhitespace(c)); + switch (c) { + case 0: + throw syntaxError("Misshaped element"); + case '<': + throw syntaxError("Misplaced '<'"); + case '>': + return XML.GT; + case '/': + return XML.SLASH; + case '=': + return XML.EQ; + case '!': + return XML.BANG; + case '?': + return XML.QUEST; + +// Quoted string + + case '"': + case '\'': + q = c; + sb = new StringBuilder(); + for (;;) { + c = next(); + if (c == 0) { + throw syntaxError("Unterminated string"); + } + if (c == q) { + return sb.toString(); + } + if (c == '&') { + sb.append(nextEntity(c)); + } else { + sb.append(c); + } + } + default: + +// Name + + sb = new StringBuilder(); + for (;;) { + sb.append(c); + c = next(); + if (Character.isWhitespace(c)) { + return sb.toString(); + } + switch (c) { + case 0: + return sb.toString(); + case '>': + case '/': + case '=': + case '!': + case '?': + case '[': + case ']': + back(); + return sb.toString(); + case '<': + case '"': + case '\'': + throw syntaxError("Bad character in a name"); + } + } + } + } + + + /** + * Skip characters until past the requested string. + * If it is not found, we are left at the end of the source with a result of false. + * @param to A string to skip past. + * @throws JSONException + */ + public boolean skipPast(String to) throws JSONException { + boolean b; + char c; + int i; + int j; + int offset = 0; + int length = to.length(); + char[] circle = new char[length]; + + /* + * First fill the circle buffer with as many characters as are in the + * to string. If we reach an early end, bail. + */ + + for (i = 0; i < length; i += 1) { + c = next(); + if (c == 0) { + return false; + } + circle[i] = c; + } + + /* We will loop, possibly for all of the remaining characters. */ + + for (;;) { + j = offset; + b = true; + + /* Compare the circle buffer with the to string. */ + + for (i = 0; i < length; i += 1) { + if (circle[j] != to.charAt(i)) { + b = false; + break; + } + j += 1; + if (j >= length) { + j -= length; + } + } + + /* If we exit the loop with b intact, then victory is ours. */ + + if (b) { + return true; + } + + /* Get the next character. If there isn't one, then defeat is ours. */ + + c = next(); + if (c == 0) { + return false; + } + /* + * Shove the character in the circle buffer and advance the + * circle offset. The offset is mod n. + */ + circle[offset] = c; + offset += 1; + if (offset >= length) { + offset -= length; + } + } + } +} diff --git a/src/main/java/com/ftec/resources/MailResources.java b/src/main/java/com/ftec/resources/MailResources.java new file mode 100644 index 0000000..1988d86 --- /dev/null +++ b/src/main/java/com/ftec/resources/MailResources.java @@ -0,0 +1,28 @@ +package com.ftec.resources; + +import lombok.Data; +import lombok.NoArgsConstructor; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.context.annotation.Configuration; + +@Data +@Configuration +@ConfigurationProperties(prefix = "mail") +public class MailResources { + + public String userid; + + public String userSecret; + + public String sendFrom; + + public String sendTo; + + public Test test = new Test(); //does'nt works with mail.test.testdata = test + + @Data + public static class Test { + private String testdata; + } + +} diff --git a/src/main/java/com/ftec/services/MailService.java b/src/main/java/com/ftec/services/MailService.java index 1e0d5f9..1e78327 100644 --- a/src/main/java/com/ftec/services/MailService.java +++ b/src/main/java/com/ftec/services/MailService.java @@ -1,53 +1,72 @@ package com.ftec.services; -import com.ftec.utils.Logger; -import com.ftec.resources.Resources; -import com.ftec.resources.Stocks; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Locale; +import java.util.Map; +import java.util.stream.Collectors; + import org.apache.commons.mail.HtmlEmail; +import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.MessageSource; import org.springframework.core.io.ClassPathResource; import org.springframework.stereotype.Service; -import javax.mail.internet.InternetAddress; -import java.nio.charset.Charset; -import java.nio.file.Files; -import java.nio.file.Paths; -import java.util.*; -import java.util.stream.Collectors; +import com.ftec.resources.MailResources; +import com.ftec.resources.Stocks; +import com.ftec.utils.Logger; +import com.sendpulse.restapi.Sendpulse; @Service public class MailService { //For translations private final MessageSource messageSource; - private final Resources resources; - public MailService(MessageSource messageSource, Resources resources) { + private MailResources mailRes; + + @Autowired + public MailService(MessageSource messageSource, MailResources mailRes) { this.messageSource = messageSource; - this.resources = resources; + this.mailRes = mailRes; } public void sendEmail(List users, Emails emailType){ - if(resources.emulateEmail) return; + // if(mailRes.emulateEmail) return; try { List uniqueLocales = new ArrayList<>(); users.forEach(emailUser -> { if (!uniqueLocales.contains(emailUser.language)) uniqueLocales.add(emailUser.language); }); + + String fromEmail = mailRes.getSendFrom(); + + String userId = mailRes.getUserid(); + String userSecret = mailRes.getUserSecret(); + + Sendpulse sendpulse = new Sendpulse(userId, userSecret); + + Map from = new HashMap(); + from.put("name", "admin"); + from.put("email", fromEmail); + Map subjects = prepareSubjects(uniqueLocales, emailType); Map headers = prepareHeaders(uniqueLocales); Map footers = prepareFooters(uniqueLocales); Map templates = prepareTemplates(uniqueLocales, emailType); + for (EmailUser user : users) { - HtmlEmail email = getEmail(); + if (!user.subscribedToEmail) continue; - email.addTo(user.email); - email.setSubject(subjects.get(user.language)); + try { - email.setHtmlMsg(headers.get(user.language) - + insertValues(templates.get(user.language), user.createParams()) - + footers.get(user.language)); - email.send(); + + sendOneEmail(sendpulse, from, headers, footers, templates, user); + }catch (Exception e){ Logger.logException("While sending email "+emailType.name()+" to user "+user.email, e, true); } @@ -57,28 +76,60 @@ public void sendEmail(List users, Emails emailType){ } } + private void sendOneEmail(Sendpulse sendpulse, Map from, Map headers, Map footers, Map templates, EmailUser user) { + Map emaildata = new HashMap(); + + List to = new ArrayList(); + + Map receiver = new HashMap(); + receiver.put("name", "namee"); + receiver.put("email", user.email); + + to.add(receiver); + + emaildata.put("html",headers.get(user.language) + + insertValues(templates.get(user.language), user.createParams()) + + footers.get(user.language)); + emaildata.put("text","text to " + user.email); + emaildata.put("subject","subject"); + emaildata.put("from",from);//ok + emaildata.put("to",to); + Map result = (Map) sendpulse.smtpSendMail(emaildata); + System.out.println("Results: " + result); + } + public void sendToMany(List emails, Locale locale, String text){ - if(resources.emulateEmail) return; - try { - String message = prepareHeaders(locale)+createInfoBody(locale, text)+prepareFooters(locale); - for (int i=emails.size()-1; i>=0; i-=10){ - HtmlEmail email = getEmail(); - email.setSubject(prepareSubjects(locale, Emails.InfoEmail)); - email.setHtmlMsg(message); - ArrayList addresses = new ArrayList<>(); - for(int j=0; j<((i>10)?10:i+1); j++){ - addresses.add(new InternetAddress(emails.get(i-j))); - } - email.setTo(addresses); - try { - email.send(); - }catch (Exception e){ - Logger.logException("While sending email info email to user", e, true); - } - } - }catch (Exception e){ - Logger.logException("While creating info email", e, true); + + + String sendFromEmail = mailRes.getSendFrom(); + String userId = mailRes.getUserid(); + String userSecret = mailRes.getUserSecret(); + + Sendpulse sendpulse = new Sendpulse(userId, userSecret); + ArrayList to = new ArrayList(); + + Map from = new HashMap(); + from.put("name", "admin"); + from.put("email", sendFromEmail); + + Map elemto = null; + + for(String email : emails) { + elemto = new HashMap(); + elemto.put("name", "name1"); + elemto.put("email", email); + to.add(elemto); } + + Map emaildata = new HashMap(); + emaildata.put("html",text); + emaildata.put("text","text"); + emaildata.put("subject","text"); + emaildata.put("from",from);//ok + emaildata.put("to",to); + + Map result = (Map) sendpulse.smtpSendMail(emaildata); + System.out.println("Results: " + result); } public static abstract class EmailUser{ @@ -113,7 +164,6 @@ public Email_BotTradesUser(String email, boolean subscribedToEmail, String langu this.stock = stock; } - @Override Map createParams(){ Map params = new HashMap<>(); @@ -176,6 +226,7 @@ public String toString() { '}'; } } + public static class Email_Balance extends EmailUser{ String login; public double currentBalance; @@ -264,7 +315,7 @@ private Map prepareHeaders(List uniqueLocales){ return headers; } private String prepareHeaders(Locale locale){ - String prefixPathToHeader = "static/emails/shared/header"; + String prefixPathToHeader ="static/emails/shared/header"; return loadFile(prefixPathToHeader+"_"+locale.getLanguage()+".html"); } @@ -317,7 +368,7 @@ private String loadFile(String filename){ try { ClassPathResource file = new ClassPathResource(filename); if(!file.exists()) file=new ClassPathResource(filename.substring(0, filename.indexOf("_"))+"_"+fallbackLanguage+".html"); - return Files.lines(Paths.get(file.getPath()), Charset.forName("utf8")).collect(Collectors.joining()); + return Files.lines(Paths.get(file.getURI())).collect(Collectors.joining()); }catch (Exception e){ Logger.logException("Loading html content from file "+filename, e, true); } @@ -346,27 +397,27 @@ public void sendSimpleMessageWithText(String to, String subject, String text) { private HtmlEmail getEmail(){ HtmlEmail email = new HtmlEmail(); - email.setHostName(resources.email.host_name); - email.setSmtpPort(resources.email.smtp_port); - email.setTLS(resources.email.tls); - email.setSSL(resources.email.ssl); - email.setCharset("utf-8"); - if(resources.email.authNeeded) { - email.setAuthentication(resources.email.mailLogin, resources.email.mailPassword); - } +// email.setHostName(resources.email.host_name); +// email.setSmtpPort(resources.email.smtp_port); +// email.setTLS(resources.email.tls); +// email.setSSL(resources.email.ssl); +// email.setCharset("utf-8"); +// if(resources.email.authNeeded) { +// email.setAuthentication(resources.email.mailLogin, resources.email.mailPassword); +// } return email; } //Temporary disable unused messages public enum Emails{ -// BotDisabled(Email_BotDisabled.class, "BotDisabled"), -// ManualTrades(EmailUser.class, "ManualTrades"), -// AutomaticTradesStarted(Email_BotTradesUser.class, "AutomaticStarted"), -// AutomaticTradesFinished(Email_BotTradesUser.class, "AutomaticFinished"), -// TrialEnded(Email_UsernameOnly.class, "TrialEnded"), -// ForgotPassword(Email_Link.class, "ForgotPassword"), -// BalanceRefilled(Email_Balance.class, "BalanceRefilled"), -// TradesMissed(Email_TradeMissed.class, "TradesMissed"), -// SocialAssistant(Email_UsernameOnly.class, "SocialAssistant"), + BotDisabled(Email_BotDisabled.class, "BotDisabled"), + ManualTrades(EmailUser.class, "ManualTrades"), + AutomaticTradesStarted(Email_BotTradesUser.class, "AutomaticStarted"), + AutomaticTradesFinished(Email_BotTradesUser.class, "AutomaticFinished"), + TrialEnded(Email_UsernameOnly.class, "TrialEnded"), + ForgotPassword(Email_Link.class, "ForgotPassword"), + BalanceRefilled(Email_Balance.class, "BalanceRefilled"), + TradesMissed(Email_TradeMissed.class, "TradesMissed"), + SocialAssistant(Email_UsernameOnly.class, "SocialAssistant"), InfoEmail(null, "InfoTemplate"); private String filePrefix; @@ -376,7 +427,7 @@ public enum Emails{ this.filePrefix = filePrefix; } String getPath(){ - return "static/emails/"+filePrefix+"/main"; + return "static/emails/" +filePrefix+"/main"; } } } diff --git a/src/main/java/com/sendpulse/restapi/Sendpulse.java b/src/main/java/com/sendpulse/restapi/Sendpulse.java new file mode 100644 index 0000000..e2d721b --- /dev/null +++ b/src/main/java/com/sendpulse/restapi/Sendpulse.java @@ -0,0 +1,949 @@ +package com.sendpulse.restapi; +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.OutputStreamWriter; +import java.io.UnsupportedEncodingException; +import java.net.URL; +import java.net.URLEncoder; +import java.security.MessageDigest; +import java.security.NoSuchAlgorithmException; +import java.util.Base64; +import java.util.HashMap; +import java.util.Map; +import java.util.Map.Entry; + +import javax.net.ssl.HttpsURLConnection; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import de.ailis.pherialize.Pherialize; +public class Sendpulse implements SendpulseInterface{ + private String apiUrl = "https://api.sendpulse.com"; + private String userId = null; + private String secret = null; + private String tokenName = null; + private int refreshToken = 0; + /** + * Sendpulse API constructor + * + * @param String userId + * @param String secret + * + */ + public Sendpulse(String _userId, String _secret ) { + if( _userId ==null || _secret==null) { + System.out.println( "Empty ID or SECRET" ); + } + this.userId = _userId; + this.secret = _secret; + try { + this.tokenName = md5( this.userId + "::" + this.secret ); + } catch (NoSuchAlgorithmException e) { + } catch (UnsupportedEncodingException e) {} + if( this.tokenName!=null) { + if( !this.getToken() ) { + System.out.println( "Could not connect to api, check your ID and SECRET" ); + } + } + } + public String md5(String param) throws NoSuchAlgorithmException, UnsupportedEncodingException{ + StringBuilder hexString = new StringBuilder(); + try { + MessageDigest md = MessageDigest.getInstance("MD5"); + byte[] thedigest = md.digest(param.getBytes()); + for (int i = 0; i < thedigest.length; i++) { + hexString.append(Integer.toString((thedigest[i] & 0xff) + 0x100, 16).substring(1)); + } + } catch (NoSuchAlgorithmException e) { + return e.toString(); + } + return hexString.toString(); + } + /** + * Get token and store it + * + * @return bool + */ + private boolean getToken() { + Map data = new HashMap(); + data.put("grant_type", "client_credentials"); + data.put("client_id", this.userId); + data.put("client_secret", this.secret); + Map requestResult = null; + try { + requestResult = this.sendRequest( "oauth/access_token", "POST", data, false ); + } catch (IOException e) {System.out.println(e);} + if(requestResult==null) return false; + if(Integer.parseInt(requestResult.get("http_code").toString()) != 200 ) { + return false; + } + this.refreshToken = 0; + JSONObject jdata = (JSONObject) requestResult.get("data"); + if (jdata instanceof JSONObject){ + try { + this.tokenName = jdata.get("access_token").toString(); + } catch (JSONException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } + return true; + } + /** + * Make post data string + * @param data + * @return + * @throws UnsupportedEncodingException + */ + private StringBuilder makePostDataParamsString(Map data) throws UnsupportedEncodingException{ + StringBuilder postData = new StringBuilder(); + if(data!=null){ + for (Entry param : data.entrySet()) { + if (postData.length() != 0) postData.append('&'); + postData.append(URLEncoder.encode(param.getKey(), "UTF-8")); + postData.append('='); + postData.append(URLEncoder.encode(String.valueOf(param.getValue()), "UTF-8")); + } + } + return postData; + } + /** + * Form and send request to API service + * + * @param String path + * @param String method + * @param Map data + * @param boolean useToken + * @return Map + */ + private Map sendRequest(String path,String method, Map data , boolean useToken) throws IOException { + Map returndata = new HashMap(); + StringBuilder postData = new StringBuilder(); + if(data!=null && data.size()>0){ + postData = this.makePostDataParamsString(data); + } + method = method.toUpperCase(); + if(method.equals("GET")){ + path = path+"?"+postData.toString(); + } + URL obj = new URL(this.apiUrl+ "/" + path); + HttpsURLConnection con = (HttpsURLConnection) obj.openConnection(); + if(useToken && this.tokenName!=null ) { + con.setRequestProperty("Authorization", "Bearer " +this.tokenName); + } + con.setRequestMethod(method); + if(!method.equals("GET")){ + if(method.equals("PUT")) con.setRequestProperty("Content-type", "application/x-www-form-urlencoded;charset=utf-8"); + con.setDoOutput(true); + con.setDoInput(true); + OutputStreamWriter wr = new OutputStreamWriter(con.getOutputStream()); + wr.write(postData.toString()); + wr.flush(); + wr.close(); + } + InputStream inputStream = null; + try{ + inputStream = con.getInputStream(); + } + catch(IOException exception) { + inputStream = con.getErrorStream(); + } + int responseCode = con.getResponseCode(); + if(inputStream!=null){ + BufferedReader in = new BufferedReader(new InputStreamReader(inputStream)); + String inputLine; + StringBuffer response = new StringBuffer(); + while ((inputLine = in.readLine()) != null) { + response.append(inputLine); + } + in.close(); + if( responseCode == 401 && this.refreshToken == 0 ) { + this.refreshToken += 1; + this.getToken(); + returndata = this.sendRequest( path, method, data,false); + } else { + Object jo = null; + try { + jo = new JSONObject(response.toString()); + } catch (JSONException ex) { + try { + jo = new JSONArray(response.toString()); + } catch (JSONException ex1) {} + } + returndata.put("data",jo); + returndata.put("http_code", responseCode); + } + } + return returndata; + } + + /** + * Process results + * + * @param Map data + * @return Map + */ + private Map handleResult( Map data ) { + if( data.get("data")==null ) { + data.put("data", null); + } + if( Integer.parseInt(data.get("http_code").toString()) != 200 ) { + data.put("is_error", true); + } + return data; + } + + /** + * Process errors + * + * @param String customMessage + * @return Map + */ + private Map handleError(String customMessage ) { + Map data = new HashMap(); + data.put("is_error", true); + if( customMessage!=null && customMessage.length()>0 ) { + data.put("message", customMessage); + } + return data; + } + + /** + * Get list of address books + * + * @param int limit + * @param int offset + * @return Map + */ + public Map listAddressBooks( int limit, int offset){ + Map data = new HashMap(); + if(limit>0) data.put("limit", limit); + if(offset>0) data.put("offset", offset); + Map result = null; + try { + result = this.sendRequest( "addressbooks", "GET", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + + /** + * Get book info + * + * @param int id + */ + public Map getBookInfo( int id ){ + if(id<=0) return this.handleError("Empty book id"); + Map result = null; + try { + result = this.sendRequest("addressbooks/"+id, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get list pf emails from book + * + * @param int id + */ + public Map getEmailsFromBook( int id ){ + if(id<=0) return this.handleError("Empty book id"); + Map result = null; + try { + result = this.sendRequest("addressbooks/"+id+ "/emails", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Remove address book + * + * @param int id + * @return Map + */ + public Map removeAddressBook( int id ){ + if(id<=0) return this.handleError("Empty book id"); + Map result = null; + try { + result = this.sendRequest("addressbooks/"+id, "DELETE", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Edit address book name + * + * @param int id + * @param String newName + */ + public Map editAddressBook( int id , String newname){ + if(id<=0 || newname.length()==0) return this.handleError("Empty new name or book id"); + Map data = new HashMap(); + data.put("name", newname); + Map result = null; + try { + result = this.sendRequest("addressbooks/"+id, "PUT", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Create new address book + * + * @param String bookName + */ + public Map createAddressBook(String bookName ){ + if(bookName.length()==0) return this.handleError("Empty book name"); + Map data = new HashMap(); + data.put("bookName", bookName); + Map result = null; + try { + result = this.sendRequest("addressbooks", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Add new emails to book + * + * @param int bookId + * @param String emails + */ + public Map addEmails( int bookId , String emails){ + if(bookId<=0 || emails.length()==0) return this.handleError("Empty book id or emails"); + Map data = new HashMap(); + data.put("emails", emails); + Map result = null; + try { + result = this.sendRequest("addressbooks/" + bookId + "/emails", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Remove emails from book + * + * @param int bookId + * @param String emails + */ + public Map removeEmails( int bookId , String emails){ + if(bookId<=0 || emails.length()==0) return this.handleError("Empty book id or emails"); + Map data = new HashMap(); + data.put("emails", emails); + Map result = null; + try { + result = this.sendRequest("addressbooks/" + bookId + "/emails", "DELETE", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get information about email from book + * + * @param int bookId + * @param String email + */ + public Map getEmailInfo( int bookId,String email ){ + if(bookId<=0 || email.length()==0) return this.handleError("Empty book id or email"); + Map result = null; + try { + result = this.sendRequest( "addressbooks/" + bookId + "/emails/" + email , "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Calculate cost of the campaign based on address book + * + * @param int bookId + */ + public Map campaignCost( int bookId ){ + if(bookId<=0) return this.handleError("Empty book id"); + Map result = null; + try { + result = this.sendRequest( "addressbooks/" + bookId + "/cost/", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get list of campaigns + * + * @param int limit + * @param int offset + */ + public Map listCampaigns( int limit, int offset){ + Map data = new HashMap(); + if(limit>0) data.put("limit", limit); + if(offset>0) data.put("offset", offset); + Map result = null; + try { + result = this.sendRequest( "campaigns", "GET", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get information about campaign + * + * @param int id + */ + public Map getCampaignInfo( int id ){ + Map result = null; + try { + result = this.sendRequest( "campaigns/"+id, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get campaign statistic by countries + * + * @param int id + */ + public Map campaignStatByCountries( int id ){ + if(id<=0) return this.handleError("Empty campaign id"); + Map result = null; + try { + result = this.sendRequest( "campaigns/"+id+"/countries", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get campaign statistic by referrals + * + * @param int id + */ + public Map campaignStatByReferrals( int id ){ + if(id<=0) return this.handleError("Empty campaign id"); + Map result = null; + try { + result = this.sendRequest( "campaigns/"+id+"/referrals", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Create new campaign + * + * @param String senderName + * @param String senderEmail + * @param String subject + * @param String body + * @param String bookId + * @param String name + * @param String attachments + */ + public Map createCampaign( String senderName, String senderEmail, String subject, String body, int bookId, String name, String attachments){ + if( senderName.length()==0 || senderEmail.length()==0 || subject.length()==0 || body.length()==0 || bookId<=0 ) + return this.handleError( "Not all data."); + String encodedBody = Base64.getEncoder().encodeToString(body.getBytes()); + Map data = new HashMap(); + if(attachments.length()>0) data.put("attachments", attachments); + data.put("sender_name", senderName); + data.put("sender_email", senderEmail); + data.put("subject", subject); + if(encodedBody.length()>0) data.put("body", encodedBody.toString()); + data.put("list_id", bookId); + if(name.length()>0) data.put("name", name); + Map result = null; + try { + result = this.sendRequest( "campaigns", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Cancel campaign + * + * @param int id + */ + public Map cancelCampaign( int id ){ + if(id<=0) return this.handleError("Empty campaign id"); + Map result = null; + try { + result = this.sendRequest( "campaigns/"+id, "DELETE", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get list of allowed senders + */ + public Map listSenders(){ + Map result = null; + try { + result = this.sendRequest( "senders", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Add new sender + * + * @param String senderName + * @param String senderEmail + */ + public Map addSender( String senderName,String senderEmail ){ + if(senderName.length()==0 || senderEmail.length()==0) return this.handleError("Empty sender name or email"); + Map data = new HashMap(); + data.put("name", senderName); + data.put("email", senderEmail); + Map result = null; + try { + result = this.sendRequest( "senders", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Remove sender + * + * @param String email + */ + public Map removeSender( String email ){ + if(email.length()==0) return this.handleError("Empty email"); + Map data = new HashMap(); + data.put("email", email); + Map result = null; + try { + result = this.sendRequest( "senders", "DELETE", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Activate sender using code from mail + * + * @param String email + * @param String code + */ + public Map activateSender( String email, String code ){ + if(email.length()==0 || code.length()==0) return this.handleError("Empty email or activation code"); + Map data = new HashMap(); + data.put("code", code); + Map result = null; + try { + result = this.sendRequest( "senders/" + email + "/code", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Send mail with activation code on sender email + * + * @param String email + */ + public Map getSenderActivationMail( String email ){ + if(email.length()==0) return this.handleError("Empty email"); + Map result = null; + try { + result = this.sendRequest( "senders/" + email + "/code", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get global information about email + * + * @param String email + * @return Map + */ + public Map getEmailGlobalInfo( String email ){ + if(email.length()==0) return this.handleError("Empty email"); + Map result = null; + try { + result = this.sendRequest( "emails/" + email, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Remove email address from all books + * + * @param String email + * @return Map + */ + public Map removeEmailFromAllBooks( String email ){ + if(email.length()==0) return this.handleError("Empty email"); + Map result = null; + try { + result = this.sendRequest( "emails/" + email, "DELETE", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get statistic for email by all campaigns + * + * @param String email + * @return Map + */ + public Map emailStatByCampaigns( String email ){ + if(email.length()==0) return this.handleError("Empty email"); + Map result = null; + try { + result = this.sendRequest( "emails/" + email + "/campaigns", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Show emails from blacklist + * @return Map + */ + public Map getBlackList(){ + Map result = null; + try { + result = this.sendRequest( "blacklist", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Add email address to blacklist + * + * @param String emails + * @param String comment + * @return Map + */ + public Map addToBlackList( String emails){ + if(emails.length()==0) return this.handleError("Empty emails"); + Map data = new HashMap(); + String encodedemails = Base64.getEncoder().encodeToString(emails.getBytes()); + data.put("emails", encodedemails); + Map result = null; + try { + result = this.sendRequest( "blacklist", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Remove email address from blacklist + * + * @param String emails + * @return Map + */ + public Map removeFromBlackList( String emails ){ + if(emails.length()==0) return this.handleError("Empty emails"); + Map data = new HashMap(); + String encodedemails = Base64.getEncoder().encodeToString(emails.getBytes()); + data.put("emails", encodedemails); + Map result = null; + try { + result = this.sendRequest( "blacklist", "DELETE", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Return user balance + * + * @param String currency + * @return Map + */ + public Map getBalance( String currency){ + String url = "balance"; + if(currency.length()>0){ + currency = currency.toUpperCase(); + url = url+"/"+currency; + } + Map result = null; + try { + result = this.sendRequest( url, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Send mail using SMTP + * + * @param String email + * @return Map + */ + public Map smtpSendMail( Map emaildata){ + if(emaildata.size()==0) return this.handleError("Empty email data"); + String html = emaildata.get("html").toString(); + try { + html = Base64.getEncoder().encodeToString(html.getBytes("UTF-8")); + } catch (UnsupportedEncodingException e1) { + e1.printStackTrace(); + } + emaildata.put("html", html); + Map data = new HashMap(); + String serialized = Pherialize.serialize(emaildata); + data.put("email", serialized); + Map result = null; + try { + result = this.sendRequest( "smtp/emails", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get list of emails that was sent by SMTP + * + * @param int limit + * @param int offset + * @param String fromDate + * @param String toDate + * @param String sender + * @param String recipient + * @return Map + */ + public Map smtpListEmails( int limit, int offset, String fromDate, String toDate, String sender, String recipient){ + Map data = new HashMap(); + data.put("limit", limit); + data.put("offset", offset); + if(fromDate.length()>0) data.put("fromDate", fromDate); + if(toDate.length()>0) data.put("toDate", toDate); + if(sender.length()>0) data.put("sender", sender); + if(recipient.length()>0) data.put("recipient", recipient); + Map result = null; + try { + result = this.sendRequest( "smtp/emails", "GET", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get information about email by his id + * + * @param int id + * @return Map + */ + public Map smtpGetEmailInfoById( String id ){ + if(id.length()==0) return this.handleError("Empty id"); + Map result = null; + try { + result = this.sendRequest( "smtp/emails/"+id, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Unsubscribe emails using SMTP + * + * @param String emails + * @return Map + */ + public Map smtpUnsubscribeEmails( String emails ){ + if(emails.length()==0) return this.handleError("Empty emails"); + Map data = new HashMap(); + data.put("emails", emails); + Map result = null; + try { + result = this.sendRequest( "/smtp/unsubscribe", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Remove emails from unsubscribe list using SMTP + * + * @param String emails + * @return Map + */ + public Map smtpRemoveFromUnsubscribe( String emails ){ + if(emails.length()==0) return this.handleError("Empty emails"); + Map data = new HashMap(); + data.put("emails", emails); + Map result = null; + try { + result = this.sendRequest( "/smtp/unsubscribe", "DELETE", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get list of allowed IPs using SMTP + * @return Map + */ + public Map smtpListIP(){ + Map result = null; + try { + result = this.sendRequest( "smtp/ips", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get list of allowed domains using SMTP + * @return Map + */ + public Map smtpListAllowedDomains(){ + Map result = null; + try { + result = this.sendRequest( "smtp/domains", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Add domain using SMTP + * + * @param String email + * @return Map + */ + public Map smtpAddDomain( String email ){ + if(email.length()==0) return this.handleError("Empty email"); + Map data = new HashMap(); + data.put("email", email); + Map result = null; + try { + result = this.sendRequest( "smtp/domains", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Send confirm mail to verify new domain + * + * @param String email + * @return Map + */ + public Map smtpVerifyDomain( String email ){ + if(email.length()==0) return this.handleError("Empty email"); + Map result = null; + try { + result = this.sendRequest( "smtp/domains/"+email, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + + /** + * Get list of push campaigns + * @param limit + * @param offset + * @return + */ + public Map pushListCampaigns(int limit, int offset){ + Map data = new HashMap(); + if(limit>0) data.put("limit", limit); + if(offset>0) data.put("offset", offset); + Map result = null; + try { + result = this.sendRequest( "push/tasks", "GET", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + /** + * Get push campaigns info + * @param id + * @return + */ + public Map pushCampaignInfo( int id ){ + if(id>0){ + Map result = null; + try { + result = this.sendRequest( "push/tasks/"+id, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + }else{ + return this.handleError("No such push campaign"); + } + } + /** + * Get amount of websites + * @return + */ + public Map pushCountWebsites(){ + Map result = null; + try { + result = this.sendRequest( "push/websites/total", "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + + /** + * Get list of websites + * @param limit + * @param offset + * @return + */ + public Map pushListWebsites(int limit, int offset){ + Map data = new HashMap(); + if(limit>0) data.put("limit", limit); + if(offset>0) data.put("offset", offset); + Map result = null; + try { + result = this.sendRequest( "push/websites", "GET", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } + + /** + * Get list of all variables for website + * @param id + * @return + */ + public Map pushListWebsiteVariables( int id){ + Map result = null; + String url = ""; + if(id>0){ + url = "push/websites/"+id+"/variables"; + try { + result = this.sendRequest( url, "GET", null,true ); + } catch (IOException e) {} + } + return this.handleResult(result); + } + + /** + * Get list of subscriptions for the website + * @param id + * @param limit + * @param offset + * @return + */ + public Map pushListWebsiteSubscriptions(int id,int limit, int offset){ + Map result = null; + String url = ""; + if(id>0){ + Map data = new HashMap(); + if(limit>0) data.put("limit", limit); + if(offset>0) data.put("offset", offset); + url = "push/websites/"+id+"/subscriptions"; + try { + result = this.sendRequest( url, "GET", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + }else{ + return this.handleError("Empty ID"); + } + } + + /** + * Get amount of subscriptions for the site + * @param id + * @return + */ + public Map pushCountWebsiteSubscriptions( int id){ + Map result = null; + String url = ""; + if(id>0){ + url = "push/websites/"+id+"/subscriptions/total"; + try { + result = this.sendRequest( url, "GET", null,true ); + } catch (IOException e) {} + return this.handleResult(result); + }else{ + return this.handleError("Empty ID"); + } + } + + /** + * Set state for subscription + * @param id + * @param state + * @return + */ + public Map pushSetSubscriptionState( int id, int state){ + if(id>0) { + Map data = new HashMap(); + data.put("id", id); + data.put("state", state); + Map result = null; + try { + result = this.sendRequest( "push/subscriptions/state", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + }else{ + return this.handleError("Empty ID"); + } + } + + /** + * Create new push campaign + * @param Map taskinfo + * @param Map additionalParams + * @return + */ + public Map createPushTask( Map taskinfo, Map additionalParams){ + Map data = taskinfo; + Object ttl = data.get("ttl"); + if(ttl==null) data.put("ttl", 0); + + if(data.get("title")==null || data.get("website_id")==null || data.get("body")==null) { + return this.handleError("Not all data"); + } + if(additionalParams!=null && additionalParams.size()>0){ + data.putAll(additionalParams); + } + Map result = null; + try { + result = this.sendRequest( "/push/tasks", "POST", data,true ); + } catch (IOException e) {} + return this.handleResult(result); + } +} diff --git a/src/main/java/com/sendpulse/restapi/SendpulseInterface.java b/src/main/java/com/sendpulse/restapi/SendpulseInterface.java new file mode 100644 index 0000000..0351bcd --- /dev/null +++ b/src/main/java/com/sendpulse/restapi/SendpulseInterface.java @@ -0,0 +1,388 @@ +package com.sendpulse.restapi; + +import java.util.Map; + +/* + * Interface for SendPulse REST API + * + * Documentation + * https://login.sendpulse.com/manual/rest-api/ + * https://sendpulse.com/api + * + */ +public interface SendpulseInterface { + /** + * Create new address book + * + * @param String bookName + * @return Map + */ + public Map createAddressBook(String bookName ); + + /** + * Edit address book name + * + * @param int id + * @param String newName + * @return Map + */ + public Map editAddressBook( int id , String newname); + + /** + * Remove address book + * + * @param int id + * @return Map + */ + public Map removeAddressBook( int id ); + + /** + * Get list of address books + * + * @param int limit + * @param int offset + * @return Map + */ + public Map listAddressBooks( int limit, int offset); + + /** + * Get book info + * + * @param int id + * @return Map + */ + public Map getBookInfo( int id ); + + /** + * Get list pf emails from book + * + * @param int id + * @return Map + */ + public Map getEmailsFromBook( int id ); + + /** + * Add new emails to book + * + * @param int bookId + * @param String emails + * @return Map + */ + public Map addEmails( int bookId , String emails); + + /** + * Remove emails from book + * + * @param int bookId + * @param String emails + * @return Map + */ + public Map removeEmails( int bookId , String emails); + + /** + * Get information about email from book + * + * @param int bookId + * @param String email + * @return Map + */ + public Map getEmailInfo( int bookId, String email ); + + /** + * Calculate cost of the campaign based on address book + * + * @param int bookId + * @return Map + */ + public Map campaignCost( int bookId ); + + /** + * Get list of campaigns + * + * @param int limit + * @param int offset + * @return Map + */ + public Map listCampaigns( int limit, int offset); + + /** + * Get information about campaign + * + * @param int id + * @return Map + */ + public Map getCampaignInfo( int id ); + + /** + * Get campaign statistic by countries + * + * @param int id + * @return Map + */ + public Map campaignStatByCountries( int id ); + + /** + * Get campaign statistic by referrals + * + * @param int id + * @return Map + */ + public Map campaignStatByReferrals( int id ); + + /** + * Create new campaign + * + * @param String senderName + * @param String senderEmail + * @param String subject + * @param String body + * @param int bookId + * @param String name + * @param String attachments + * @return Map + */ + public Map createCampaign( String senderName, String senderEmail, String subject, String body, int bookId, String name, String attachments); + + /** + * Cancel campaign + * + * @param int id + * @return Map + */ + public Map cancelCampaign( int id ); + + /** + * Get list of allowed senders + * @return Map + */ + public Map listSenders(); + + /** + * Add new sender + * + * @param String senderName + * @param String senderEmail + * @return Map + */ + public Map addSender( String senderName,String senderEmail ); + + /** + * Remove sender + * + * @param String email + * @return Map + */ + public Map removeSender( String email ); + + /** + * Activate sender using code from mail + * + * @param String email + * @param String code + * @return Map + */ + public Map activateSender( String email, String code ); + + /** + * Send mail with activation code on sender email + * + * @param String email + * @return Map + */ + public Map getSenderActivationMail( String email ); + + /** + * Get global information about email + * + * @param String email + * @return Map + */ + public Map getEmailGlobalInfo( String email ); + + /** + * Remove email address from all books + * + * @param String email + * @return Map + */ + public Map removeEmailFromAllBooks( String email ); + + /** + * Get statistic for email by all campaigns + * + * @param String email + * @return Map + */ + public Map emailStatByCampaigns( String email ); + + /** + * Show emails from blacklist + * @return Map + */ + public Map getBlackList(); + + /** + * Add email address to blacklist + * + * @param String emails + * @return Map + */ + public Map addToBlackList( String emails); + + /** + * Remove email address from blacklist + * + * @param String emails + * @return Map + */ + public Map removeFromBlackList( String emails ); + + /** + * Return user balance + * + * @param String currency + * @return Map + */ + public Map getBalance( String currency); + + /** + * Get list of emails that was sent by SMTP + * + * @param int limit + * @param int offset + * @param String fromDate + * @param String toDate + * @param String sender + * @param String recipient + * @return Map + */ + public Map smtpListEmails( int limit, int offset, String fromDate, String toDate, String sender, String recipient); + + /** + * Get information about email by his id + * + * @param String id + * @return Map + */ + public Map smtpGetEmailInfoById( String id ); + + /** + * Unsubscribe emails using SMTP + * + * @param String emails + * @return Map + */ + public Map smtpUnsubscribeEmails( String emails ); + + /** + * Remove emails from unsubscribe list using SMTP + * + * @param String emails + * @return Map + */ + public Map smtpRemoveFromUnsubscribe( String emails ); + + /** + * Get list of allowed IPs using SMTP + * @return Map + */ + public Map smtpListIP(); + + /** + * Get list of allowed domains using SMTP + * @return Map + */ + public Map smtpListAllowedDomains(); + + /** + * Add domain using SMTP + * + * @param String email + * @return Map + */ + public Map smtpAddDomain( String email ); + + /** + * Send confirm mail to verify new domain + * + * @param String email + * @return Map + */ + public Map smtpVerifyDomain( String email ); + + /** + * Send mail using SMTP + * + * @param String email + * @return Map + */ + public Map smtpSendMail( Map emaildata ); + + /** + * Get list of push campaigns + * @param limit + * @param offset + * @return + */ + public Map pushListCampaigns(int limit, int offset); + + /** + * Get push campaigns info + * @param id + * @return + */ + public Map pushCampaignInfo( int id ); + + /** + * Get amount of websites + * @return + */ + public Map pushCountWebsites(); + + /** + * Get list of websites + * @param limit + * @param offset + * @return + */ + public Map pushListWebsites(int limit, int offset); + + /** + * Get list of all variables for website + * @param id + * @return + */ + public Map pushListWebsiteVariables( int id); + + /** + * Get list of subscriptions for the website + * @param id + * @param limit + * @param offset + * @return + */ + public Map pushListWebsiteSubscriptions(int id,int limit, int offset); + + /** + * Get amount of subscriptions for the site + * @param id + * @return + */ + public Map pushCountWebsiteSubscriptions( int id); + + /** + * Set state for subscription + * @param id + * @param state + * @return + */ + public Map pushSetSubscriptionState( int id, int state); + + /** + * Create new push campaign + * @param Map taskinfo + * @param Map additionalParams + * @return + */ + public Map createPushTask( Map taskinfo, Map additionalParams); +} \ No newline at end of file diff --git a/src/main/java/de/ailis/pherialize/Mixed.java b/src/main/java/de/ailis/pherialize/Mixed.java new file mode 100644 index 0000000..b5c1ac5 --- /dev/null +++ b/src/main/java/de/ailis/pherialize/Mixed.java @@ -0,0 +1,788 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize; + +import java.io.Serializable; +import java.util.List; +import java.util.Map; + + +/** + * A mixed data type. This data type is used to represent PHP values like + * string, int and double. It can be converted to any other Java type by using + * one of the to*() methods. Conversion errors results in returning a 0 because + * that's the same behaviour as in PHP. + * + * @author Klaus Reimer (k@ailis.de) + * @version $Revision$ + */ + +public class Mixed implements Serializable, Comparable +{ + /** Serial version UID */ + private static final long serialVersionUID = -599069055376420973L; + + /** Constant for unknown type */ + public static final int TYPE_UNKNOWN = -1; + + /** Constant for type "character" */ + public static final int TYPE_CHAR = 0; + + /** Constant for type "byte" */ + public static final int TYPE_BYTE = 1; + + /** Constant for type "byte" */ + public static final int TYPE_SHORT = 2; + + /** Constant for type "byte" */ + public static final int TYPE_INT = 3; + + /** Constant for type "byte" */ + public static final int TYPE_LONG = 4; + + /** Constant for type "byte" */ + public static final int TYPE_FLOAT = 5; + + /** Constant for type "byte" */ + public static final int TYPE_DOUBLE = 6; + + /** Constant for type "byte" */ + public static final int TYPE_BOOLEAN = 7; + + /** Constant for type "string" */ + public static final int TYPE_STRING = 8; + + /** Constant for type "array" */ + public static final int TYPE_ARRAY = 9; + + /** The value */ + private Object value; + + /** The data type */ + private final int type; + + + /** + * Constructor + * + * @param value + * The real value + */ + + public Mixed(final Object value) + { + super(); + this.type = Mixed.getTypeOf(value); + switch (this.type) + { + case TYPE_STRING: + this.value = value.toString(); + break; + + case TYPE_ARRAY: + if (value instanceof MixedArray) + { + this.value = value; + } + else if (value instanceof List) + { + this.value = new MixedArray((List) value); + } + else + { + this.value = new MixedArray((Map) value); + } + break; + + default: + this.value = value; + } + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final char value) + { + super(); + this.value = Character.valueOf(value); + this.type = TYPE_CHAR; + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final byte value) + { + super(); + this.value = Byte.valueOf(value); + this.type = TYPE_BYTE; + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final short value) + { + super(); + this.value = Short.valueOf(value); + this.type = TYPE_SHORT; + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final int value) + { + super(); + this.value = Integer.valueOf(value); + this.type = TYPE_INT; + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final long value) + { + super(); + this.value = Long.valueOf(value); + this.type = TYPE_LONG; + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final float value) + { + super(); + this.value = Float.valueOf(value); + this.type = TYPE_FLOAT; + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final double value) + { + super(); + this.value = Double.valueOf(value); + this.type = TYPE_DOUBLE; + } + + + /** + * Constructor + * + * @param value + * The mixed value + */ + + public Mixed(final boolean value) + { + this.value = Boolean.valueOf(value); + this.type = TYPE_BOOLEAN; + } + + + /** + * Returns the type of the specified object + * + * @param value + * The object + * @return The type + */ + + public static int getTypeOf(final Object value) + { + if (value instanceof String + || (value != null && value.getClass().isEnum())) + { + return TYPE_STRING; + } + else if (value instanceof Integer) + { + return TYPE_INT; + } + else if (value instanceof List) + { + return TYPE_ARRAY; + } + else if (value instanceof Map) + { + return TYPE_ARRAY; + } + else if (value instanceof Character) + { + return TYPE_CHAR; + } + else if (value instanceof Byte) + { + return TYPE_BYTE; + } + else if (value instanceof Short) + { + return TYPE_SHORT; + } + else if (value instanceof Integer) + { + return TYPE_INT; + } + else if (value instanceof Long) + { + return TYPE_LONG; + } + else if (value instanceof Float) + { + return TYPE_FLOAT; + } + else if (value instanceof Double) + { + return TYPE_DOUBLE; + } + else if (value instanceof Boolean) + { + return TYPE_BOOLEAN; + } + else + return TYPE_UNKNOWN; + } + + + /** + * @see java.lang.Object#hashCode() + */ + + @Override + public int hashCode() + { + return toString().hashCode(); + } + + + /** + * @see java.lang.Object#equals(java.lang.Object) + */ + + @Override + public boolean equals(final Object other) + { + if (other == null) return false; + if (other instanceof Mixed) + { + return toString().equals(other.toString()); + } + else + { + return toString().equals(other.toString()); + } + } + + + /** + * @see java.lang.Object#toString() + */ + + @Override + public String toString() + { + if (this.value == null) return null; + return this.value.toString(); + } + + + /** + * Returns the value converted to the specified type. + * + * @param type + * The type to convert the object to + * @return The converted type + */ + + public Object toType(final int type) + { + // Return the value right away if it's already the correct type + if (this.type == type) return this.value; + + switch (type) + { + case TYPE_BOOLEAN: + return Boolean.valueOf(toBoolean()); + case TYPE_BYTE: + return Byte.valueOf(toByte()); + case TYPE_CHAR: + return Character.valueOf(toChar()); + case TYPE_DOUBLE: + return Double.valueOf(toFloat()); + case TYPE_FLOAT: + return Float.valueOf(toFloat()); + case TYPE_INT: + return Integer.valueOf(toInt()); + case TYPE_LONG: + return Long.valueOf(toLong()); + case TYPE_ARRAY: + return toArray(); + case TYPE_SHORT: + return Short.valueOf(toShort()); + case TYPE_STRING: + return toString(); + default: + return this.value; + } + } + + + /** + * Returns mixed value as a char. If value is not a char then the first + * character of the string representation of the value is returned. If this + * string is empty then a 0-character is returned. + * + * @return Mixed value as a char + */ + + public char toChar() + { + if (this.value == null) return 0; + if (isArray()) + return (char) (((MixedArray) this.value).size() == 0 ? 0 : 1); + if (toString().length() > 0) + { + return toString().charAt(0); + } + return 0; + } + + + /** + * Returns mixed value as a short. If value is a boolean value then 0 is + * returned if value is false and 1 is returned if value is true. For any + * other data type a conversion is tried and 0 is returned if this fails. + * + * @return Mixed value as a short + */ + + public short toShort() + { + if (this.value == null) return 0; + if (isBoolean()) return toBoolean() ? (short) 1 : (short) 0; + if (isArray()) + return (short) (((MixedArray) this.value).size() == 0 ? 0 : 1); + try + { + return (short) toLong(); + } + catch (final NumberFormatException e) + { + return 0; + } + } + + + /** + * Returns mixed value as a byte. If value is a boolean value then 0 is + * returned if value is false and 1 is returned if value is true. For any + * other data type a conversion is tried and 0 is returned if this fails. + * + * @return Mixed value as a byte + */ + + public byte toByte() + { + if (this.value == null) return 0; + if (isBoolean()) return toBoolean() ? (byte) 1 : (byte) 0; + if (isArray()) + return (byte) (((MixedArray) this.value).size() == 0 ? 0 : 1); + try + { + return (byte) toLong(); + } + catch (final NumberFormatException e) + { + return 0; + } + } + + + /** + * Returns mixed value as an int. If value is a boolean value then 0 is + * returned if value is false and 1 is returned if value is true. For any + * other data type a conversion is tried and 0 is returned if this fails. + * + * @return Mixed value as an int + */ + + public int toInt() + { + if (this.value == null) return 0; + if (isBoolean()) return toBoolean() ? 1 : 0; + if (isArray()) return ((MixedArray) this.value).size() == 0 ? 0 : 1; + try + { + return (int) toLong(); + } + catch (final NumberFormatException e) + { + return 0; + } + } + + + /** + * Returns mixed value as a long. If value is a boolean value then 0 is + * returned if value is false and 1 is returned if value is true. For any + * other data type a conversion is tried and 0 is returned if this fails. + * + * @return Mixed value as a long + */ + + public long toLong() + { + if (this.value == null) return 0; + if (isBoolean()) return toBoolean() ? 1 : 0; + if (isArray()) return ((MixedArray) this.value).size() == 0 ? 0 : 1; + try + { + return (long) toDouble(); + } + catch (final NumberFormatException e) + { + return 0; + } + } + + + /** + * Returns mixed value as a float. If value is a boolean value then 0 is + * returned if value is false and 1 is returned if value is true. For any + * other data type a conversion is tried and 0 is returned if this fails. + * + * @return Mixed value as a float + */ + + public float toFloat() + { + if (this.value == null) return 0; + if (isBoolean()) return toBoolean() ? 1 : 0; + if (isArray()) return ((MixedArray) this.value).size() == 0 ? 0 : 1; + try + { + return Float.parseFloat(this.value.toString()); + } + catch (final NumberFormatException e) + { + return 0; + } + } + + + /** + * Returns the value as an array. If value is not an array then null is + * returned. + * + * @return The value as an array + */ + + public MixedArray toArray() + { + if (this.value == null) return null; + if (isArray()) + { + return (MixedArray) this.value; + } + else + { + return null; + } + } + + + /** + * Returns mixed value as a double. If value is a boolean value then 0 is + * returned if value is false and 1 is returned if value is true. For any + * other data type a conversion is tried and 0 is returned if this fails. + * + * @return Mixed value as a double + */ + + public double toDouble() + { + if (this.value == null) return 0; + if (isBoolean()) return toBoolean() ? 1 : 0; + if (isArray()) return ((MixedArray) this.value).size() == 0 ? 0 : 1; + try + { + return Double.parseDouble(this.value.toString()); + } + catch (final NumberFormatException e) + { + return 0; + } + } + + + /** + * Returns mixed value as a boolean. Everything except a real false, an + * empty string, a numerical 0, a 0 character or an empty list/map is + * handled as "true". + * + * @return Mixed value as a boolean + */ + + public boolean toBoolean() + { + if (this.value == null) return false; + if (isBoolean()) + { + return ((Boolean) this.value).booleanValue(); + } + else if (isString()) + { + return toString().length() > 0; + } + else if (isNumber()) + { + return toDouble() != 0; + } + else if (isChar()) + { + return toChar() != '\0'; + } + else if (isArray()) + { + return toArray().size() > 0; + } + else + return false; + } + + + /** + * @see java.lang.Comparable#compareTo(java.lang.Object) + */ + + @SuppressWarnings("unchecked") + public int compareTo(final Object other) + { + if (other instanceof Mixed) + { + return ((Comparable) this.value) + .compareTo(((Mixed) other).value); + } + else + { + return ((Comparable) this.value).compareTo(other); + } + } + + + /** + * Returns the data type (One of the TYPE_* constants) + * + * @return The data type + */ + + public int getType() + { + return this.type; + } + + + /** + * Returns the raw value. + * + * @return The raw value + */ + + public Object getValue() + { + return this.value; + } + + + /** + * Checks if type is a char. + * + * @return If type is a char + */ + + public boolean isChar() + { + return this.type == TYPE_CHAR; + } + + + /** + * Checks if type is a byte. + * + * @return If type is a byte + */ + + public boolean isByte() + { + return this.type == TYPE_BYTE; + } + + + /** + * Checks if type is a short. + * + * @return If type is a short + */ + + public boolean isShort() + { + return this.type == TYPE_SHORT; + } + + + /** + * Checks if type is a int. + * + * @return If type is a int + */ + + public boolean isInt() + { + return this.type == TYPE_INT; + } + + + /** + * Checks if type is a long. + * + * @return If type is a long + */ + + public boolean isLong() + { + return this.type == TYPE_LONG; + } + + + /** + * Checks if type is a float. + * + * @return If type is a float + */ + + public boolean isFloat() + { + return this.type == TYPE_FLOAT; + } + + + /** + * Checks if type is a double. + * + * @return If type is a double + */ + + public boolean isDouble() + { + return this.type == TYPE_DOUBLE; + } + + + /** + * Checks if type is a boolean. + * + * @return If type is a boolean + */ + + public boolean isBoolean() + { + return this.type == TYPE_BOOLEAN; + } + + + /** + * Checks if type is a number (Float, Double, Byte, Short, Int or Long). + * + * @return If type is a number + */ + + public boolean isNumber() + { + return isFloat() || isDouble() || isByte() || isShort() || isInt() + || isLong(); + } + + + /** + * Checks if type is a string. + * + * @return If type is a string + */ + + public boolean isString() + { + return this.type == TYPE_STRING; + } + + + /** + * Checks if type is an array. + * + * @return If type is a array + */ + + public boolean isArray() + { + return this.type == TYPE_ARRAY; + } +} diff --git a/src/main/java/de/ailis/pherialize/MixedArray.java b/src/main/java/de/ailis/pherialize/MixedArray.java new file mode 100644 index 0000000..7f20494 --- /dev/null +++ b/src/main/java/de/ailis/pherialize/MixedArray.java @@ -0,0 +1,607 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize; + +import java.util.Collection; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.Map; + + +/** + * A Map/List implementation with Mixed keys and values. + * + * @author Klaus Reimer (k@ailis.de) + * @version $Revision$ + */ + +public class MixedArray extends LinkedHashMap +{ + /** Serial version UID */ + private static final long serialVersionUID = -194078593900457504L; + + + /** + * Constructor + * + * @param initialCapacity + * The initial capacity + * @param loadFactor + * The load factor + */ + + public MixedArray(final int initialCapacity, final float loadFactor) + { + super(initialCapacity, loadFactor); + } + + + /** + * Constructor + * + * @param initialCapacity + * The initial capacity + */ + + public MixedArray(final int initialCapacity) + { + super(initialCapacity); + } + + + /** + * Constructor + */ + + public MixedArray() + { + super(); + } + + + /** + * Constructor + * + * @param map + * The map to copy + */ + + public MixedArray(final Map map) + { + super(map); + } + + + /** + * Constructor + * + * @param list + * The list to copy + */ + + public MixedArray(final Collection list) + { + super(); + + int i; + Iterator iterator; + + i = 0; + iterator = list.iterator(); + while (iterator.hasNext()) + { + this.put(new Mixed(i), iterator.next()); + i++; + } + } + + + /** + * @see java.util.HashMap#get(java.lang.Object) + */ + + @Override + public Object get(final Object key) + { + if (key instanceof Mixed) + { + return super.get(key); + } + else + { + return super.get(new Mixed(key)); + } + } + + + /** + * Returns value for specified key as mixed value. + * + * @param key + * The key + * @return The value + */ + + public Mixed getMixed(final Object key) + { + return (Mixed) get(key); + } + + + /** + * Returns value for specified key as string. + * + * @param key + * The key + * @return The value + */ + + public String getString(final Object key) + { + return getMixed(key).toString(); + } + + + /** + * Returns value for specified key as boolean. + * + * @param key + * The key + * @return The value + */ + + public boolean getBooolean(final Object key) + { + return getMixed(key).toBoolean(); + } + + + /** + * Returns value for specified key as byte. + * + * @param key + * The key + * @return The value + */ + + public byte getByte(final Object key) + { + return getMixed(key).toByte(); + } + + + /** + * Returns value for specified key as char. + * + * @param key + * The key + * @return The value + */ + + public char getChar(final Object key) + { + return getMixed(key).toChar(); + } + + + /** + * Returns value for specified key as double. + * + * @param key + * The key + * @return The value + */ + + public double getDouble(final Object key) + { + return getMixed(key).toDouble(); + } + + + /** + * Returns value for specified key as float. + * + * @param key + * The key + * @return The value + */ + + public float getFloat(final Object key) + { + return getMixed(key).toFloat(); + } + + + /** + * Returns value for specified key as int. + * + * @param key + * The key + * @return The value + */ + + public int getInt(final Object key) + { + return getMixed(key).toInt(); + } + + + /** + * Returns value for specified key as boolean. + * + * @param key + * The key + * @return The value + */ + + public boolean getBoolean(final Object key) + { + return getMixed(key).toBoolean(); + } + + + /** + * Returns value for specified key as list. + * + * @param key + * The key + * @return The value + */ + + public MixedArray getArray(final Object key) + { + return getMixed(key).toArray(); + } + + + /** + * Returns value for specified key as long. + * + * @param key + * The key + * @return The value + */ + + public long getLong(final Object key) + { + return getMixed(key).toLong(); + } + + + /** + * Returns value for specified key as short. + * + * @param key + * The key + * @return The value + */ + + public short getShort(final Object key) + { + return getMixed(key).toShort(); + } + + + /** + * Returns value for specified key as custom type + * + * @param key + * The key + * @param type + * The type + * @return The value + */ + + public Object getType(final Object key, final int type) + { + return getMixed(key).toType(type); + } + + + /** + * @see java.util.HashMap#put(java.lang.Object, java.lang.Object) + */ + + @Override + public Object put(final Object key, final Object value) + { + Mixed mixedKey, mixedValue; + + if (!(key instanceof Mixed)) + mixedKey = new Mixed(key); + else + mixedKey = (Mixed) key; + if (!(value instanceof Mixed)) + mixedValue = new Mixed(value); + else + mixedValue = (Mixed) value; + return super.put(mixedKey, mixedValue); + } + + + /** + * @see java.util.HashMap#containsKey(java.lang.Object) + */ + + @Override + public boolean containsKey(final Object key) + { + if (key instanceof Mixed) + { + return super.containsKey(key); + } + else + { + return super.containsKey(new Mixed(key)); + } + } + + + /** + * @see java.util.HashMap#containsValue(java.lang.Object) + */ + + @Override + public boolean containsValue(final Object value) + { + if (value instanceof Mixed) + { + return super.containsValue(value); + } + else + { + return super.containsValue(new Mixed(value)); + } + } + + + /** + * Checks if value exists in array. + * + * @param value + * The value to check + * @return If value exists or not + */ + + public boolean contains(final Object value) + { + return containsValue(value); + } + + + /** + * @see java.util.HashMap#remove(java.lang.Object) + */ + + @Override + public Object remove(final Object key) + { + if (key instanceof Mixed) + { + return super.remove(key); + } + else + { + return super.remove(new Mixed(key)); + } + } + + + /** + * Returns value with specified index. + * + * @param index + * The index + * @return The value + */ + + public Object get(final int index) + { + return get(new Mixed(index)); + } + + + /** + * Returns value as mixed value. + * + * @param index + * The index + * @return The value + */ + + public Mixed getMixed(final int index) + { + return (Mixed) get(index); + } + + + /** + * Returns value as string. + * + * @param index + * The index + * @return The value + */ + + public String getString(final int index) + { + return getMixed(index).toString(); + } + + + /** + * Returns value as boolean. + * + * @param index + * The index + * @return The value + */ + + public boolean getBooolean(final int index) + { + return getMixed(index).toBoolean(); + } + + + /** + * Returns value as byte. + * + * @param index + * The index + * @return The value + */ + + public byte getByte(final int index) + { + return getMixed(index).toByte(); + } + + + /** + * Returns value as char. + * + * @param index + * The index + * @return The value + */ + + public char getChar(final int index) + { + return getMixed(index).toChar(); + } + + + /** + * Returns value as double. + * + * @param index + * The index + * @return The value + */ + + public double getDouble(final int index) + { + return getMixed(index).toDouble(); + } + + + /** + * Returns value as float. + * + * @param index + * The index + * @return The value + */ + + public float getFloat(final int index) + { + return getMixed(index).toFloat(); + } + + + /** + * Returns value as int. + * + * @param index + * The index + * @return The value + */ + + public int getInt(final int index) + { + return getMixed(index).toInt(); + } + + + /** + * Returns value as boolean. + * + * @param index + * The index + * @return The value + */ + + public boolean getBoolean(final int index) + { + return getMixed(index).toBoolean(); + } + + + /** + * Returns value as array. + * + * @param index + * The index + * @return The value + */ + + public MixedArray getArray(final int index) + { + return getMixed(index).toArray(); + } + + + /** + * Returns value as long. + * + * @param index + * The index + * @return The value + */ + + public long getLong(final int index) + { + return getMixed(index).toLong(); + } + + + /** + * Returns value as short. + * + * @param index + * The index + * @return The value + */ + + public short getShort(final int index) + { + return getMixed(index).toShort(); + } + + + /** + * Returns value as custom type + * + * @param index + * The index + * @param type + * The type + * @return The value + */ + + public Object getType(final int index, final int type) + { + return getMixed(index).toType(type); + } +} diff --git a/src/main/java/de/ailis/pherialize/Pherialize.java b/src/main/java/de/ailis/pherialize/Pherialize.java new file mode 100644 index 0000000..db235cb --- /dev/null +++ b/src/main/java/de/ailis/pherialize/Pherialize.java @@ -0,0 +1,130 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize; + +import java.nio.charset.Charset; + + +/** + * The main interface to Pherialize. Just implements the static methods + * serialize and unserialize for easier usage of the Serializer and + * Unserializer classes. + * + * @author Klaus Reimer (k@ailis.de) + * @version $Revision$ + */ + +public class Pherialize +{ + /** + * Hide constructor + */ + + private Pherialize() + { + // Empty + } + + + /** + * Returns the serialized representation of the specified object. + * + * @param object + * The object to serialize + * @param charset + * The charset of data. + * @return The serialized representation of the object + */ + + public static String serialize(final Object object, Charset charset) + { + Serializer pherialize; + + pherialize = new Serializer(charset); + return pherialize.serialize(object); + } + + + /** + * Returns the serialized representation of the specified object. + * + * @param object + * The object to serialize + * @return The serialized representation of the object + */ + + public static String serialize(final Object object) + { + Serializer pherialize; + + pherialize = new Serializer(); + return pherialize.serialize(object); + } + + + /** + * Returns the unserialized object of the specified PHP serialize format + * string. The returned object is wrapped in a Mixed object allowing easy + * conversion to any data type needed. This wrapping is needed because PHP + * is a loosely typed language and it is quite propable that a boolean is + * sometimes a int or a string. So with the Mixed wrapper object you can + * easily decide on your own how to interpret the unserialized data. + * + * @param data + * The serialized data + * @param charset + * The charset of data. + * @return The unserialized object + */ + + public static Mixed unserialize(final String data, Charset charset) + { + Unserializer unserializer; + + unserializer = new Unserializer(data, charset); + return unserializer.unserializeObject(); + } + + + /** + * Returns the unserialized object of the specified PHP serialize format + * string. The returned object is wrapped in a Mixed object allowing easy + * conversion to any data type needed. This wrapping is needed because PHP + * is a loosely typed language and it is quite propable that a boolean is + * sometimes a int or a string. So with the Mixed wrapper object you can + * easily decide on your own how to interpret the unserialized data. + * + * @param data + * The serialized data + * @return The unserialized object + */ + + public static Mixed unserialize(final String data) + { + Unserializer unserializer; + + unserializer = new Unserializer(data); + return unserializer.unserializeObject(); + } +} diff --git a/src/main/java/de/ailis/pherialize/Serializer.java b/src/main/java/de/ailis/pherialize/Serializer.java new file mode 100644 index 0000000..d334ccc --- /dev/null +++ b/src/main/java/de/ailis/pherialize/Serializer.java @@ -0,0 +1,564 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize; + +import java.io.Serializable; +import java.lang.reflect.Field; +import java.lang.reflect.Modifier; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Iterator; +import java.util.List; +import java.util.Map; + +import de.ailis.pherialize.exceptions.SerializeException; + + +/** + * Serializes Java objects in a PHP serializer format string. + * + * @author Klaus Reimer (k.reimer@iplabs.de) + * @version $Revision$ + */ + +public class Serializer +{ + /** The original charset of the input data. */ + private final Charset charset; + + /** The object history for resolving references */ + private final List history; + + + /** + * Constructor + */ + + public Serializer() + { + this(Charset.forName("UTF-8")); + } + + + /** + * Constructor + */ + + public Serializer(Charset charset) + { + super(); + this.charset = charset; + this.history = new ArrayList(); + } + + + /** + * Serializes the specified object. + * + * @param object + * The object + * @return The serialized data + */ + + public String serialize(final Object object) + { + StringBuffer buffer; + + buffer = new StringBuffer(); + serializeObject(object, buffer); + return buffer.toString(); + } + + + /** + * This method is used internally for recursively scanning the object while + * serializing. It just calls the other serializeObject method defaulting + * to allowing references. + * + * @param object + * The object to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeObject(final Object object, final StringBuffer buffer) + { + serializeObject(object, buffer, true); + } + + + /** + * This method is used internally for recursively scanning the object while + * serializing. If references are allowed or not can be specified with the + * last parameter. For example Array/Map-Keys are not allowed to be a + * reference. + * + * @param object + * The object to serialize + * @param buffer + * The string buffer to append serialized data to + * @param allowReference + * If reference is allowed for this object + */ + + private void serializeObject(final Object object, final StringBuffer buffer, + final boolean allowReference) + { + if (object == null) + { + serializeNull(buffer); + } + else if (allowReference && serializeReference(object, buffer)) + { + return; + } + else if (object instanceof String) + { + serializeString((String) object, buffer); + } + else if (object instanceof Character) + { + serializeCharacter((Character) object, buffer); + } + else if (object instanceof Integer) + { + serializeInteger(((Integer) object).intValue(), buffer); + } + else if (object instanceof Short) + { + serializeInteger(((Short) object).intValue(), buffer); + } + else if (object instanceof Byte) + { + serializeInteger(((Byte) object).intValue(), buffer); + } + else if (object instanceof Long) + { + serializeLong(((Long) object).longValue(), buffer); + } + else if (object instanceof Double) + { + serializeDouble(((Double) object).doubleValue(), buffer); + } + else if (object instanceof Float) + { + serializeDouble(((Float) object).doubleValue(), buffer); + } + else if (object instanceof Boolean) + { + serializeBoolean((Boolean) object, buffer); + } + else if (object instanceof Mixed) + { + serializeMixed((Mixed) object, buffer); + return; + } + else if (object instanceof Object[]) + { + serializeArray((Object[]) object, buffer); + return; + } + else if (object instanceof Collection) + { + serializeCollection((Collection) object, buffer); + return; + } + else if (object instanceof Map) + { + serializeMap((Map) object, buffer); + return; + } + else if (object instanceof Serializable) + { + serializeSerializable((Serializable) object, buffer); + return; + } + else + { + throw new SerializeException("Unable to serialize " + + object.getClass().getName()); + } + + this.history.add(object); + } + + + /** + * Tries to serialize a reference if the specified object was already + * serialized. It returns true in this case. If the object was not + * serialized before then false is returned. + * + * @param object + * The object to serialize + * @param buffer + * The string buffer to append serialized data to + * @return If a reference was serialized or not + */ + + private boolean serializeReference(final Object object, final StringBuffer buffer) + { + Iterator iterator; + int index; + boolean isReference; + + // Don't allow references for simple types because here PHP and + // Java are VERY different and the best way it to simply disallow + // References for these types + if (object instanceof Number || object instanceof Boolean || + object instanceof String) + { + return false; + } + + iterator = this.history.iterator(); + index = 0; + isReference = false; + while (iterator.hasNext()) + { + if (iterator.next() == object) + { + buffer.append("R:"); + buffer.append(index + 1); + buffer.append(';'); + isReference = true; + break; + } + index++; + } + return isReference; + } + + + /** + * Serializes the specified mixed object and appends it to the serialization + * buffer. + * + * @param mixed + * The object to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeMixed(final Mixed mixed, final StringBuffer buffer) + { + serializeObject(mixed.getValue(), buffer); + } + + + /** + * Serializes the specified string and appends it to the serialization + * buffer. + * + * @param string + * The string to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeString(final String string, final StringBuffer buffer) + { + String decoded = Unserializer.decode(string, charset); + + buffer.append("s:"); + buffer.append(decoded.length()); + buffer.append(":\""); + buffer.append(string); + buffer.append("\";"); + } + + + /** + * Serializes the specified character and appends it to the serialization + * buffer. + * + * @param value + * The value to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeCharacter(final Character value, final StringBuffer buffer) + { + buffer.append("s:1:\""); + buffer.append(value); + buffer.append("\";"); + } + + + /** + * Adds a serialized NULL to the serialization buffer. + * + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeNull(final StringBuffer buffer) + { + buffer.append("N;"); + } + + + /** + * Serializes the specified integer number and appends it to the + * serialization buffer. + * + * @param number + * The integer number to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeInteger(final int number, final StringBuffer buffer) + { + buffer.append("i:"); + buffer.append(number); + buffer.append(';'); + } + + + /** + * Serializes the specified lonf number and appends it to the serialization + * buffer. + * + * @param number + * The lonf number to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeLong(final long number, final StringBuffer buffer) + { + if ((number >= Integer.MIN_VALUE) && (number <= Integer.MAX_VALUE)) + { + buffer.append("i:"); + } + else + { + buffer.append("d:"); + } + buffer.append(number); + buffer.append(';'); + } + + + /** + * Serializes the specfied double number and appends it to the serialization + * buffer. + * + * @param number + * The number to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeDouble(final double number, final StringBuffer buffer) + { + buffer.append("d:"); + buffer.append(number); + buffer.append(';'); + } + + + /** + * Serializes the specfied boolean and appends it to the serialization + * buffer. + * + * @param value + * The value to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeBoolean(final Boolean value, final StringBuffer buffer) + { + buffer.append("b:"); + buffer.append(value.booleanValue() ? 1 : 0); + buffer.append(';'); + } + + + /** + * Serializes the specfied collection and appends it to the serialization + * buffer. + * + * @param collection + * The collection to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeCollection(final Collection collection, final StringBuffer buffer) + { + Iterator iterator; + int index; + + this.history.add(collection); + buffer.append("a:"); + buffer.append(collection.size()); + buffer.append(":{"); + iterator = collection.iterator(); + index = 0; + while (iterator.hasNext()) + { + serializeObject(Integer.valueOf(index), buffer, false); + this.history.remove(this.history.size() - 1); + serializeObject(iterator.next(), buffer); + index++; + } + buffer.append('}'); + } + + + /** + * Serializes the specfied array and appends it to the serialization + * buffer. + * + * @param array + * The array to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeArray(final Object[] array, final StringBuffer buffer) + { + int max; + + this.history.add(array); + buffer.append("a:"); + max = array.length; + buffer.append(max); + buffer.append(":{"); + for (int i = 0; i < max; i++) + { + serializeObject(Integer.valueOf(i), buffer, false); + this.history.remove(this.history.size() - 1); + serializeObject(array[i], buffer); + } + buffer.append('}'); + } + + + /** + * Serializes the specfied map and appends it to the serialization buffer. + * + * @param map + * The map to serialize + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeMap(final Map map, final StringBuffer buffer) + { + Iterator iterator; + Object key; + + this.history.add(map); + buffer.append("a:"); + buffer.append(map.size()); + buffer.append(":{"); + iterator = map.keySet().iterator(); + while (iterator.hasNext()) + { + key = iterator.next(); + serializeObject(key, buffer, false); + this.history.remove(this.history.size() - 1); + serializeObject(map.get(key), buffer); + } + buffer.append('}'); + } + + + /** + * Serializes a serializable object + * + * @param object + * The serializable object + * @param buffer + * The string buffer to append serialized data to + */ + + private void serializeSerializable(final Serializable object, final StringBuffer buffer) + { + String className; + Class c; + Field[] fields; + int i, max; + Field field; + String key; + Object value; + StringBuffer fieldBuffer; + int fieldCount; + + this.history.add(object); + c = object.getClass(); + className = c.getSimpleName(); + buffer.append("O:"); + buffer.append(className.length()); + buffer.append(":\""); + buffer.append(className); + buffer.append("\":"); + + fieldBuffer = new StringBuffer(); + fieldCount = 0; + while (c != null) + { + fields = c.getDeclaredFields(); + for (i = 0, max = fields.length; i < max; i++) + { + field = fields[i]; + if (Modifier.isStatic(field.getModifiers())) continue; + if (Modifier.isVolatile(field.getModifiers())) continue; + + try + { + field.setAccessible(true); + key = field.getName(); + value = field.get(object); + serializeObject(key, fieldBuffer); + this.history.remove(this.history.size() - 1); + serializeObject(value, fieldBuffer); + fieldCount++; + } + catch (final SecurityException e) + { + // Field is just ignored when this exception is thrown + } + catch (final IllegalArgumentException e) + { + // Field is just ignored when this exception is thrown + } + catch (final IllegalAccessException e) + { + // Field is just ignored when this exception is thrown + } + } + c = c.getSuperclass(); + } + buffer.append(fieldCount); + buffer.append(":{"); + buffer.append(fieldBuffer); + buffer.append("}"); + } +} diff --git a/src/main/java/de/ailis/pherialize/Unserializer.java b/src/main/java/de/ailis/pherialize/Unserializer.java new file mode 100644 index 0000000..5824739 --- /dev/null +++ b/src/main/java/de/ailis/pherialize/Unserializer.java @@ -0,0 +1,291 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize; + +import java.io.UnsupportedEncodingException; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.List; + +import de.ailis.pherialize.exceptions.UnserializeException; + + +/** + * Unserializes a PHP serialize format string into a Java object. + * + * @author Klaus Reimer (k@ailis.de) + * @version $Revision$ + */ + +public class Unserializer +{ + /** The current pointer in the data */ + private int pos; + + /** The data to unserialize */ + private final String data; + + /** The original charset of the input data. */ + private final Charset charset; + + /** The object history for resolving references */ + private final List history; + + + /** + * Constructor + * + * @param data + * The data to unserialize + */ + + public Unserializer(final String data) + { + this(data, Charset.forName("UTF-8")); + } + + + /** + * Constructor + * + * @param data + * The data to unserialize + */ + + public Unserializer(final String data, Charset charset) + { + super(); + this.data = decode(data, charset); + this.charset = charset; + this.pos = 0; + this.history = new ArrayList(); + } + + + /** + * Unserializes the next object in the data stream. + * + * @return The unserializes object + */ + + public Mixed unserializeObject() + { + char type; + Mixed result; + + type = this.data.charAt(this.pos); + switch (type) + { + case 's': + result = unserializeString(); + break; + + case 'i': + result = unserializeInteger(); + break; + + case 'd': + result = unserializeDouble(); + break; + + case 'b': + result = unserializeBoolean(); + break; + + case 'N': + result = unserializeNull(); + break; + + case 'a': + return unserializeArray(); + + case 'R': + result = unserializeReference(); + break; + + default: + throw new UnserializeException( + "Unable to unserialize unknown type " + type); + } + + this.history.add(result); + return result; + } + + + /** + * Unserializes the next object in the data stream into a String. + * + * @return The unserialized String + */ + + private Mixed unserializeString() + { + int pos, length; + + pos = this.data.indexOf(':', this.pos + 2); + length = Integer.parseInt(this.data.substring(this.pos + 2, pos)); + this.pos = pos + length + 4; + String unencoded = this.data.substring(pos + 2, pos + 2 + length); + return new Mixed(encode(unencoded, charset)); + } + + + /** + * Unserializes the next object in the data stream into an Integer. + * + * @return The unserialized Integer + */ + + private Mixed unserializeInteger() + { + Integer result; + int pos; + + pos = this.data.indexOf(';', this.pos + 2); + result = Integer.valueOf(this.data.substring(this.pos + 2, pos)); + this.pos = pos + 1; + return new Mixed(result); + } + + + /** + * Unserializes the next object in the data stream into an Double. + * + * @return The unserialized Double + */ + + private Mixed unserializeDouble() + { + Double result; + int pos; + + pos = this.data.indexOf(';', this.pos + 2); + result = Double.valueOf(this.data.substring(this.pos + 2, pos)); + this.pos = pos + 1; + return new Mixed(result); + } + + + /** + * Unserializes the next object in the data stream as a reference. + * + * @return The unserialized reference + */ + + private Mixed unserializeReference() + { + int index; + int pos; + + pos = this.data.indexOf(';', this.pos + 2); + index = Integer.parseInt(this.data.substring(this.pos + 2, pos)); + this.pos = pos + 1; + return (Mixed) this.history.get(index - 1); + } + + + /** + * Unserializes the next object in the data stream into a Boolean. + * + * @return The unserialized Boolean + */ + + private Mixed unserializeBoolean() + { + Boolean result; + + result = Boolean.valueOf(this.data.charAt(this.pos + 2) == '1'); + this.pos += 4; + return new Mixed(result); + } + + + /** + * Unserializes the next object in the data stream into a Null + * + * @return The unserialized Null + */ + + private Mixed unserializeNull() + { + this.pos += 2; + return null; + } + + + /** + * Unserializes the next object in the data stream into an array. This + * method returns an ArrayList if the unserialized array has numerical + * keys starting with 0 or a HashMap otherwise. + * + * @return The unserialized array + */ + + private Mixed unserializeArray() + { + Mixed result; + MixedArray array; + int pos; + int max; + int i; + Object key, value; + + pos = this.data.indexOf(':', this.pos + 2); + max = Integer.parseInt(this.data.substring(this.pos + 2, pos)); + this.pos = pos + 2; + array = new MixedArray(max); + result = new Mixed(array); + this.history.add(result); + for (i = 0; i < max; i++) + { + key = unserializeObject(); + this.history.remove(this.history.size() - 1); + value = unserializeObject(); + array.put(key, value); + } + this.pos++; + return result; + } + + + static String decode(String encoded, Charset charset) + { + try { + return new String(encoded.getBytes(charset), "ISO-8859-1"); + } catch (UnsupportedEncodingException e) { + return encoded; + } + } + + + static String encode(String decoded, Charset charset) + { + try { + return new String(decoded.getBytes("ISO-8859-1"), charset); + } catch (UnsupportedEncodingException e) { + return decoded; + } + } +} diff --git a/src/main/java/de/ailis/pherialize/exceptions/PherializeException.java b/src/main/java/de/ailis/pherialize/exceptions/PherializeException.java new file mode 100644 index 0000000..e2aa10b --- /dev/null +++ b/src/main/java/de/ailis/pherialize/exceptions/PherializeException.java @@ -0,0 +1,89 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize.exceptions; + + +/** + * Base exception for Pherialize problems. + * + * @author Klaus Reimer (k@ailis.de) + * @version $Revision$ + */ + +abstract public class PherializeException extends RuntimeException +{ + /** Serial version UID */ + private static final long serialVersionUID = 1479169743443565173L; + + + /** + * Constructor + */ + + public PherializeException() + { + super(); + } + + + /** + * Constructor + * + * @param message + * The exception message + */ + + public PherializeException(final String message) + { + super(message); + } + + + /** + * Constructor + * + * @param message + * The exception message + * @param cause + * The root cause + */ + + public PherializeException(final String message, final Throwable cause) + { + super(message, cause); + } + + + /** + * Constructor + * + * @param cause + * The root cause + */ + + public PherializeException(final Throwable cause) + { + super(cause); + } +} diff --git a/src/main/java/de/ailis/pherialize/exceptions/SerializeException.java b/src/main/java/de/ailis/pherialize/exceptions/SerializeException.java new file mode 100644 index 0000000..b24c93b --- /dev/null +++ b/src/main/java/de/ailis/pherialize/exceptions/SerializeException.java @@ -0,0 +1,90 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize.exceptions; + + + +/** + * Exception thrown when someting goes wrong while serializing. + * + * @author Klaus Reimer (k@ailis.de) + * @version $Revision$ + */ + +public class SerializeException extends PherializeException +{ + /** Serial version UID */ + private static final long serialVersionUID = 5304443329670892370L; + + + /** + * Constructor + */ + + public SerializeException() + { + super(); + } + + + /** + * Constructor + * + * @param message + * The exception message + */ + + public SerializeException(final String message) + { + super(message); + } + + + /** + * Constructor + * + * @param message + * The exception message + * @param cause + * The root cause + */ + + public SerializeException(final String message, final Throwable cause) + { + super(message, cause); + } + + + /** + * Constructor + * + * @param cause + * The root cause + */ + + public SerializeException(final Throwable cause) + { + super(cause); + } +} diff --git a/src/main/java/de/ailis/pherialize/exceptions/UnserializeException.java b/src/main/java/de/ailis/pherialize/exceptions/UnserializeException.java new file mode 100644 index 0000000..c760dff --- /dev/null +++ b/src/main/java/de/ailis/pherialize/exceptions/UnserializeException.java @@ -0,0 +1,90 @@ +/* + * $Id$ + * Copyright (C) 2009 Klaus Reimer + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +package de.ailis.pherialize.exceptions; + + + +/** + * Exception thrown when someting goes wrong while unserializing. + * + * @author Klaus Reimer (k@ailis.de) + * @version $Revision$ + */ + +public class UnserializeException extends PherializeException +{ + /** Serial version UID */ + private static final long serialVersionUID = -7127648595193318947L; + + + /** + * Constructor + */ + + public UnserializeException() + { + super(); + } + + + /** + * Constructor + * + * @param message + * The exception message + */ + + public UnserializeException(final String message) + { + super(message); + } + + + /** + * Constructor + * + * @param message + * The exception message + * @param cause + * The root cause + */ + + public UnserializeException(final String message, final Throwable cause) + { + super(message, cause); + } + + + /** + * Constructor + * + * @param cause + * The root cause + */ + + public UnserializeException(final Throwable cause) + { + super(cause); + } +} diff --git a/src/test/java/com/ftec/services/EmailTest.java b/src/test/java/com/ftec/services/EmailTest.java new file mode 100644 index 0000000..00fcf33 --- /dev/null +++ b/src/test/java/com/ftec/services/EmailTest.java @@ -0,0 +1,98 @@ +package com.ftec.services; + +import java.util.ArrayList; +import java.util.List; +import java.util.Locale; + +import javax.mail.internet.AddressException; + +import com.ftec.resources.MailResources; +import org.apache.commons.mail.EmailException; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.junit4.SpringRunner; + +import com.ftec.configs.ApplicationConfig; +import com.ftec.resources.Stocks; +import com.ftec.services.MailService.Email_BotTradesUser; +import com.ftec.services.MailService.Emails; + +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; + +@ActiveProfiles("test") +@RunWith(SpringRunner.class) +@SpringBootTest(classes = ApplicationConfig.class) +public class EmailTest { + + @Autowired + public MailService emailService; + + @Autowired + private MailResources mailResources; + + + + @Test + public void sendEmails() throws AddressException, EmailException { + List users = new ArrayList(){{ + add("a@ukr.net"); + add("example@gmail.com"); + add("example@gmail.com"); + + }}; + + emailService.sendToMany(users, new Locale("en"), "Hello! You received this letter since you have been used the services of COINBOT trading modules.
" + + "
" + + "If the fields of algorithmic trading and crypto trading in general are interesting for you, pay attention to the Token Sale of the First Trading Ecosystem.
" + + "
" + + "Now there is a 25% discount on the ecosystem tokens. Also, all participants will be provided with a large number of advantages while using all future new modules of COINBOT and the First Trading Ecosystem.
" + + "
" + + "TOKEN SALE: https://ftec.tech/
" + + "REFERRAL PROGRAM: https://ftec.tech/referral_reports/
" + + "
" + + "If you have already invested in Token Sale projects, we recommend you to pay attention to the First Trading Ecosystem since the project got very high grades from auditors and ratings.
" + + "
" + + "Icobench: 4.9/5 | Icomarks: 9.4/10 | Trackico: 5/5
" + + "ICOrating: Hype score: Very High | Risk score: Low
" + + "
" + + "Also, pay attention to a large number of documents presented on the website:
" + + "
" + + "How To Participate?
" + + "Ambisafe Audit Report
" + + "OnePager
" + + "WhitePaper
" + + "Howey Test
" + + "Registration Certificate
" + + "Benefits for tokenholders
" + + "Marketing Plan
" + + "Financial plan
" + + "KYC ALMP
" + + "Privacy Policy
" + + "Pre-order Agreement
" + + "Tokens Quantity
" + + "Legal Opinion
" + + "CNR
" + + "Anti-Spam Policy
" + + "
" + + "The link to the promo, a video about the team, and Q&A session are attached to this letter.
" + + "https://www.youtube.com/watch?v=4Ekaw7hctkg
" + + "https://www.youtube.com/watch?v=qG8o-RA7GDY
" + + "https://www.youtube.com/watch?v=yfxO-FnmKN8
"); + } + + @Test + public void sendUniqueEmails() throws AddressException, EmailException { + List users = new ArrayList(){{ + + add(new Email_BotTradesUser(mailResources.sendTo, true, new Locale("en"), "pair", "logs",Stocks.Binance)); + + }}; + emailService.sendEmail(users, Emails.AutomaticTradesStarted); + assertNotNull(mailResources.sendTo); + } + +} \ No newline at end of file diff --git a/src/test/java/test/DBtest.java b/src/test/java/test/DBtest.java new file mode 100644 index 0000000..63539d8 --- /dev/null +++ b/src/test/java/test/DBtest.java @@ -0,0 +1,99 @@ +package test; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.test.web.servlet.MockMvc; + +import com.ftec.configs.ApplicationConfig; +import com.ftec.configs.enums.TutorialSteps; +import com.ftec.entities.User; +import com.ftec.repositories.UserDAO; +import com.ftec.repositories.UserTokenDAO; +import com.ftec.services.TokenService; + +@ActiveProfiles("test") +@RunWith(SpringRunner.class) +@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT,classes = ApplicationConfig.class) +@AutoConfigureMockMvc +public class DBtest { + + @Autowired + MockMvc mvc; + + @Autowired + UserTokenDAO tokenDAO; + + @Autowired + UserDAO userDAO; + + @Autowired + TokenService service; + + @Before + public void setUp() { + userDAO.deleteAll(); + tokenDAO.deleteAll(); + } + + + @Test + public void userDBtest() { + assertFalse(userDAO.findAll().iterator().hasNext()); //isEmptyTable + Long id = 11L; + + String username = "user1"; + String password = "pass1"; + String email = "email@d.net"; + TutorialSteps currentStep = TutorialSteps.FIRST; + boolean subscribeForNews = false; + Boolean twoStepVerification = false; + + User u = new User(id, username, password, + email, currentStep, subscribeForNews, twoStepVerification); + userDAO.save(u); + //works with 1 user + assertTrue(userDAO.findById(id).get().getUsername().equals(username)); + assertTrue(userDAO.findByUsername(username).get().getPassword().equals(password)); + assertTrue(userDAO.findByEmail(email).get().getUsername().equals(username)); + assertTrue(userDAO.findByCurrentStep(currentStep).get().getUsername().equals(username)); + + userDAO.deleteById(id); + assertFalse(userDAO.findById(id).isPresent()); + + userDAO.save(u); + assertTrue(userDAO.findById(id).get().getUsername().equals(username)); + userDAO.deleteByEmail(email); + assertFalse(userDAO.findById(id).isPresent()); + + userDAO.save(u); + assertTrue(userDAO.findByCurrentStep(currentStep).get().getUsername().equals(username)); + userDAO.deleteByCurrentStep(currentStep); + assertFalse(userDAO.findById(id).isPresent()); + + u.setEmail("new_email"); + userDAO.save(u); + + assertTrue(userDAO.findByEmail("new_email").get().getUsername().equals(username)); + userDAO.deleteById(id); + + assertFalse(userDAO.findById(id).isPresent()); + } + + + @Test + public void TokenDBtest() { + String token = service.createSaveAndGetNewToken(132L); + //tokenDAO.findById(id) + } + +}