All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.atlassian.jira.rest.client.internal.json.JsonParseUtil Maven / Gradle / Ivy

    /*
 * Copyright (C) 2010 Atlassian
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * Modifications copyright (C) 2021 Simpleworks GmbH
 */

package com.atlassian.jira.rest.client.internal.json;

import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;

import javax.annotation.Nullable;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.codehaus.jettison.json.JSONArray;
import org.codehaus.jettison.json.JSONException;
import org.codehaus.jettison.json.JSONObject;
import org.joda.time.DateTime;
import org.joda.time.format.DateTimeFormat;
import org.joda.time.format.DateTimeFormatter;
import org.joda.time.format.ISODateTimeFormat;

import com.atlassian.jira.rest.client.api.ExpandableProperty;
import com.atlassian.jira.rest.client.api.OptionalIterable;
import com.atlassian.jira.rest.client.api.RestClientException;
import com.atlassian.jira.rest.client.api.domain.BasicUser;
import com.google.common.base.Optional;
import com.google.common.collect.Maps;

public class JsonParseUtil {
	private static final Logger logger = LogManager.getLogger(JsonParseUtil.class);

	public static final String JIRA_DATE_TIME_PATTERN = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
	public static final DateTimeFormatter JIRA_DATE_TIME_FORMATTER = DateTimeFormat
			.forPattern(JsonParseUtil.JIRA_DATE_TIME_PATTERN);
	public static final DateTimeFormatter JIRA_DATE_FORMATTER = ISODateTimeFormat.date();
	public static final String SELF_ATTR = "self";

	public static  Collection parseJsonArray(final JSONArray jsonArray, final JsonObjectParser jsonParser)
			throws JSONException {
		final Collection res = new ArrayList<>(jsonArray.length());
		for (int i = 0; i < jsonArray.length(); i++) {
			res.add(jsonParser.parse(jsonArray.getJSONObject(i)));
		}
		return res;
	}

	public static  OptionalIterable parseOptionalJsonArray(final JSONArray jsonArray,
			final JsonObjectParser jsonParser) throws JSONException {
		if (jsonArray == null) {
			return OptionalIterable.absent();
		}

		return new OptionalIterable<>(JsonParseUtil.parseJsonArray(jsonArray, jsonParser));
	}

	public static  T parseOptionalJsonObject(final JSONObject json, final String attributeName,
			final JsonObjectParser jsonParser) throws JSONException {
		final JSONObject attributeObject = JsonParseUtil.getOptionalJsonObject(json, attributeName);
		return attributeObject != null ? jsonParser.parse(attributeObject) : null;
	}

	public static  ExpandableProperty parseExpandableProperty(final JSONObject json,
			final JsonObjectParser expandablePropertyBuilder) throws JSONException {
		return JsonParseUtil.parseExpandableProperty(json, Boolean.FALSE, expandablePropertyBuilder);
	}

	@Nullable
	public static  ExpandableProperty parseOptionalExpandableProperty(@Nullable final JSONObject json,
			final JsonObjectParser expandablePropertyBuilder) throws JSONException {
		return JsonParseUtil.parseExpandableProperty(json, Boolean.TRUE, expandablePropertyBuilder);
	}

	@Nullable
	private static  ExpandableProperty parseExpandableProperty(@Nullable final JSONObject json,
			final Boolean optional, final JsonObjectParser expandablePropertyBuilder) throws JSONException {
		if (json == null) {
			if (!optional.booleanValue()) {
				throw new IllegalArgumentException("json object cannot be null while optional is false.");
			}

			return null;
		}

		final int numItems = json.getInt("size");
		final Collection items;
		final JSONArray itemsJa = json.getJSONArray("items");

		if (itemsJa.length() > 0) {
			items = new ArrayList<>(numItems);
			for (int i = 0; i < itemsJa.length(); i++) {
				final T item = expandablePropertyBuilder.parse(itemsJa.getJSONObject(i));
				items.add(item);
			}
		} else {
			items = null;
		}

		return new ExpandableProperty<>(numItems, items);
	}

	public static URI getSelfUri(final JSONObject jsonObject) throws JSONException {
		return JsonParseUtil.parseURI(jsonObject.getString(JsonParseUtil.SELF_ATTR));
	}

	public static URI optSelfUri(final JSONObject jsonObject, final URI defaultUri) {
		final String selfUri = jsonObject.optString(JsonParseUtil.SELF_ATTR, null);
		return selfUri != null ? JsonParseUtil.parseURI(selfUri) : defaultUri;
	}

	public static JSONObject getNestedObject(final JSONObject json, final String... path) throws JSONException {
		JSONObject result = json;

		for (final String s : path) {
			result = result.getJSONObject(s);
		}

		return result;
	}

	@Nullable
	public static JSONObject getNestedOptionalObject(final JSONObject json, final String... path) throws JSONException {
		JSONObject result = json;

		for (int i = 0; i < (path.length - 1); i++) {
			final String s = path[i];
			result = result.getJSONObject(s);
		}

		return result.optJSONObject(path[path.length - 1]);
	}

	public static JSONArray getNestedArray(final JSONObject json, final String... path) throws JSONException {
		JSONObject result = json;

		for (int i = 0; i < (path.length - 1); i++) {
			final String s = path[i];
			result = result.getJSONObject(s);
		}

		return result.getJSONArray(path[path.length - 1]);
	}

	public static JSONArray getNestedOptionalArray(final JSONObject json, final String... path) {
		JSONObject result = json;

		for (int i = 0; (json != null) && (i < (path.length - 1)); i++) {
			final String s = path[i];
			result = result.optJSONObject(s);
		}

		return result == null ? null : result.optJSONArray(path[path.length - 1]);
	}

	public static String getNestedString(final JSONObject json, final String... path) throws JSONException {
		JSONObject result = json;

		for (int i = 0; i < (path.length - 1); i++) {
			final String s = path[i];
			result = result.getJSONObject(s);
		}

		return result.getString(path[path.length - 1]);
	}

	public static boolean getNestedBoolean(final JSONObject json, final String... path) throws JSONException {
		JSONObject result = json;

		for (int i = 0; i < (path.length - 1); i++) {
			final String s = path[i];
			result = result.getJSONObject(s);
		}

		return result.getBoolean(path[path.length - 1]);
	}

	public static URI parseURI(final String str) {
		try {
			return new URI(str);
		} catch (final URISyntaxException e) {
			JsonParseUtil.logger.error(String.format("can't get URL from '%s'.", str), e);
			throw new RestClientException(e);
		}
	}

	@Nullable
	public static URI parseOptionalURI(final JSONObject jsonObject, final String attributeName) {
		final String s = JsonParseUtil.getOptionalString(jsonObject, attributeName);
		return s != null ? JsonParseUtil.parseURI(s) : null;
	}

	@Nullable
	public static BasicUser parseBasicUser(@Nullable final JSONObject json) {
		if (json == null) {
			return null;
		}
//        final String username = json.getString("name");
//        if (!json.has(JsonParseUtil.SELF_ATTR) && "Anonymous".equals(username)) {
//            return null; // insane representation for unassigned user - JRADEV-4262
//        }

		// deleted user? BUG in REST API: JRA-30263
		final URI selfUri = JsonParseUtil.optSelfUri(json, BasicUser.INCOMPLETE_URI);
		return new BasicUser(selfUri, json.optString("displayName", null), json.optString("displayName", null));
	}

	public static DateTime parseDateTime(final JSONObject jsonObject, final String attributeName) throws JSONException {
		return JsonParseUtil.parseDateTime(jsonObject.getString(attributeName));
	}

	@Nullable
	public static DateTime parseOptionalDateTime(final JSONObject jsonObject, final String attributeName) {
		final String s = JsonParseUtil.getOptionalString(jsonObject, attributeName);
		return s != null ? JsonParseUtil.parseDateTime(s) : null;
	}

	public static DateTime parseDateTime(final String str) {
		try {
			return JsonParseUtil.JIRA_DATE_TIME_FORMATTER.parseDateTime(str);
		} catch (final Exception e) {
			JsonParseUtil.logger.error(String.format("can't parse DateTime from '%s'.", str), e);
			throw new RestClientException(e);
		}
	}

	/**
	 * Tries to parse date and time and return that. If fails then tries to parse
	 * date only.
	 *
	 * @param str String contains either date and time or date only
	 * @return date and time or date only
	 */
	public static DateTime parseDateTimeOrDate(final String str) {
		try {
			return JsonParseUtil.JIRA_DATE_TIME_FORMATTER.parseDateTime(str);
		} catch (@SuppressWarnings("unused") final Exception ignored) {
			try {
				return JsonParseUtil.JIRA_DATE_FORMATTER.parseDateTime(str);
			} catch (final Exception e) {
				JsonParseUtil.logger.error(String.format("can't parse DateTime from '%s'.", str), e);
				throw new RestClientException(e);
			}
		}
	}

	public static DateTime parseDate(final String str) {
		try {
			return JsonParseUtil.JIRA_DATE_FORMATTER.parseDateTime(str);
		} catch (final Exception e) {
			JsonParseUtil.logger.error(String.format("can't parse Date from '%s'.", str), e);
			throw new RestClientException(e);
		}
	}

	public static String formatDate(final DateTime dateTime) {
		return JsonParseUtil.JIRA_DATE_FORMATTER.print(dateTime);
	}

	public static String formatDateTime(final DateTime dateTime) {
		return JsonParseUtil.JIRA_DATE_TIME_FORMATTER.print(dateTime);
	}

	@Nullable
	public static String getNullableString(final JSONObject jsonObject, final String attributeName)
			throws JSONException {
		final Object o = jsonObject.get(attributeName);
		if (o == JSONObject.NULL) {
			return null;
		}
		return o.toString();
	}

	@Nullable
	public static String getOptionalString(final JSONObject jsonObject, final String attributeName) {
		final Object res = jsonObject.opt(attributeName);
		if ((res == JSONObject.NULL) || (res == null)) {
			return null;
		}
		return res.toString();
	}

	@Nullable
	public static  T getOptionalJsonObject(final JSONObject jsonObject, final String attributeName,
			final JsonObjectParser jsonParser) throws JSONException {
		final JSONObject res = jsonObject.optJSONObject(attributeName);
		if ((res == JSONObject.NULL) || (res == null)) {
			return null;
		}
		return jsonParser.parse(res);
	}

	@Nullable
	public static JSONObject getOptionalJsonObject(final JSONObject jsonObject, final String attributeName) {
		final JSONObject res = jsonObject.optJSONObject(attributeName);
		if ((res == JSONObject.NULL) || (res == null)) {
			return null;
		}
		return res;
	}

	public static Collection toStringCollection(final JSONArray jsonArray) throws JSONException {
		final ArrayList res = new ArrayList<>(jsonArray.length());
		for (int i = 0; i < jsonArray.length(); i++) {
			res.add(jsonArray.getString(i));
		}
		return res;
	}

	public static Integer parseOptionInteger(final JSONObject json, final String attributeName) throws JSONException {
		return json.has(attributeName) ? Integer.valueOf(json.getInt(attributeName)) : null;
	}

	@Nullable
	public static Long getOptionalLong(final JSONObject jsonObject, final String attributeName) throws JSONException {
		return jsonObject.has(attributeName) ? Long.valueOf(jsonObject.getLong(attributeName)) : null;
	}

	public static Optional getOptionalArray(final JSONObject jsonObject, final String attributeName)
			throws JSONException {
		return jsonObject.has(attributeName) ? Optional.of(jsonObject.getJSONArray(attributeName))
				: Optional.absent();
	}

	public static Map getAvatarUris(final JSONObject jsonObject) throws JSONException {
		final Map uris = Maps.newHashMap();

		final Iterator iterator = jsonObject.keys();
		while (iterator.hasNext()) {
			final Object o = iterator.next();
			if (!(o instanceof String)) {
				throw new JSONException("Cannot parse URIs: key is expected to be valid String. Got "
						+ (o == null ? "null" : o.getClass()) + " instead.");
			}
			final String key = (String) o;
			uris.put(key, JsonParseUtil.parseURI(jsonObject.getString(key)));
		}
		return uris;
	}

	public static Iterator getStringKeys(final JSONObject json) {
		return json.keys();
	}

	public static Map toStringMap(final JSONArray names, final JSONObject values) throws JSONException {
		final Map result = Maps.newHashMap();
		for (int i = 0; i < names.length(); i++) {
			final String key = names.getString(i);
			result.put(key, values.getString(key));
		}
		return result;
	}
}    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy