001/*
002 * Licensed under the Apache License, Version 2.0 (the "License");
003 * you may not use this file except in compliance with the License.
004 * You may obtain a copy of the License at
005 *
006 *     http://www.apache.org/licenses/LICENSE-2.0
007 *
008 * Unless required by applicable law or agreed to in writing, software
009 * distributed under the License is distributed on an "AS IS" BASIS,
010 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
011 * See the License for the specific language governing permissions and
012 * limitations under the License.
013 */
014package org.gbif.api.jackson;
015
016import org.gbif.api.model.occurrence.DownloadFormat;
017import org.gbif.api.model.occurrence.DownloadRequest;
018import org.gbif.api.model.occurrence.DownloadType;
019import org.gbif.api.model.occurrence.PredicateDownloadRequest;
020import org.gbif.api.model.occurrence.SqlDownloadRequest;
021import org.gbif.api.model.predicate.Predicate;
022import org.gbif.api.util.VocabularyUtils;
023import org.gbif.api.vocabulary.Extension;
024
025import java.io.IOException;
026import java.util.ArrayList;
027import java.util.Arrays;
028import java.util.Collections;
029import java.util.HashSet;
030import java.util.List;
031import java.util.Optional;
032import java.util.Set;
033import java.util.stream.Collectors;
034
035import org.slf4j.Logger;
036import org.slf4j.LoggerFactory;
037
038import com.fasterxml.jackson.core.JsonParser;
039import com.fasterxml.jackson.databind.DeserializationContext;
040import com.fasterxml.jackson.databind.JsonDeserializer;
041import com.fasterxml.jackson.databind.JsonNode;
042import com.fasterxml.jackson.databind.ObjectMapper;
043
044/**
045 * Download request deserializer.
046 * <p>
047 * For most of the time, the serialization has been to "notificationAddresses" and
048 * "sendNotification".  For a few months in 2018-2019, it was "notification_address" and
049 * "send_notification".
050 * <p>
051 * The API documentation has previously specified "notification_address" and "sendNotification".
052 * <p>
053 * We therefore accept all combinations.
054 * <p>
055 * https://github.com/gbif/portal-feedback/issues/2046
056 */
057public class DownloadRequestSerde extends JsonDeserializer<DownloadRequest> {
058
059  private static final String PREDICATE = "predicate";
060  private static final List<String> SEND_NOTIFICATION = Collections
061    .unmodifiableList(Arrays.asList("sendNotification", "send_notification"));
062  private static final String SQL = "sql";
063  private static final List<String> NOTIFICATION_ADDRESSES =
064    Collections.unmodifiableList(
065      Arrays.asList("notificationAddresses", "notificationAddress", "notification_addresses",
066        "notification_address"));
067  private static final String CREATOR = "creator";
068  private static final String FORMAT = "format";
069  private static final String TYPE = "type";
070  private static final String VERBATIM_EXTENSIONS = "verbatimExtensions";
071  private static final String DESCRIPTION = "description";
072  private static final String MACHINE_DESCRIPTION = "machineDescription";
073
074  // Properties we ignore.
075  private static final List<String> IGNORED_PROPERTIES =
076    Collections.unmodifiableList(
077      Arrays.asList("created"));
078
079  private static final Set<String> ALL_PROPERTIES;
080  private static final Logger LOG = LoggerFactory.getLogger(DownloadRequestSerde.class);
081  private static final ObjectMapper MAPPER = new ObjectMapper();
082
083  static {
084    Set<String> allProperties = new HashSet<>(Arrays.asList(PREDICATE, SQL, CREATOR, FORMAT, TYPE, VERBATIM_EXTENSIONS, DESCRIPTION, MACHINE_DESCRIPTION));
085    allProperties.addAll(SEND_NOTIFICATION);
086    allProperties.addAll(NOTIFICATION_ADDRESSES);
087    allProperties.addAll(IGNORED_PROPERTIES);
088    ALL_PROPERTIES = Collections.unmodifiableSet(allProperties);
089  }
090
091  @Override
092  public DownloadRequest deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException {
093    JsonNode node = jp.getCodec().readTree(jp);
094    LOG.debug("DownloadRequest for deserialization: {}", node);
095    //at least one element must be defined
096    if (node.size() == 0) {
097      return null;
098    }
099    DownloadFormat format = Optional.ofNullable(node.get(FORMAT))
100      .map(n -> VocabularyUtils.lookupEnum(n.asText(), DownloadFormat.class)).orElse(DownloadFormat.DWCA);
101
102    DownloadType type = Optional.ofNullable(node.get(TYPE))
103      .map(n -> VocabularyUtils.lookupEnum(n.asText(), DownloadType.class)).orElse(DownloadType.OCCURRENCE);
104
105    String creator = Optional.ofNullable(node.get(CREATOR)).map(JsonNode::asText).orElse(null);
106
107    String description = Optional.ofNullable(node.get(DESCRIPTION)).map(JsonNode::asText).orElse(null);
108
109    List<String> notificationAddresses = new ArrayList<>();
110    for (final String jsonKey : NOTIFICATION_ADDRESSES) {
111      notificationAddresses.addAll(Optional.ofNullable(node.get(jsonKey)).map(jsonNode -> {
112        try {
113          return Arrays.asList(MAPPER.treeToValue(jsonNode, String[].class));
114        } catch (Exception e) {
115          throw new RuntimeException(e);
116        }
117      }).orElse(new ArrayList<>()));
118    }
119
120    boolean sendNotification = false;
121    for (final String jsonKey : SEND_NOTIFICATION) {
122      sendNotification |= Optional.ofNullable(node.get(jsonKey)).map(JsonNode::asBoolean).orElse(Boolean.FALSE);
123    }
124
125    Set<Extension> extensions = Optional.ofNullable(node.get(VERBATIM_EXTENSIONS)).map(jsonNode -> {
126      try {
127        return Arrays.stream(MAPPER.treeToValue(jsonNode, String[].class))
128                .map(Extension::fromRowType)
129                .collect(Collectors.toSet());
130      } catch (Exception e) {
131        throw new RuntimeException(e);
132      }
133    }).orElse(Collections.emptySet());
134
135    // Check requested extensions are available for download.
136    for (Extension e : extensions) {
137      if (!Extension.availableExtensions().contains(e)) {
138        throw new RuntimeException("The "+e.getRowType()+" extension is not available for downloads.");
139      }
140    }
141
142    JsonNode machineDescription = Optional.ofNullable(node.get(MACHINE_DESCRIPTION)).orElse(null);
143
144    String sql = Optional.ofNullable(node.get(SQL)).map(JsonNode::asText).orElse(null);
145
146    // Reject if unknown field names are present
147    // https://github.com/gbif/occurrence/issues/273
148    node.fieldNames().forEachRemaining(n -> { if (!ALL_PROPERTIES.contains(n)) { throw new RuntimeException("Unknown JSON property '"+n+"'."); }});
149
150    if (sql != null) {
151      if (format != DownloadFormat.SQL_TSV_ZIP) {
152        throw new RuntimeException("SQL downloads must use a suitable download format: SQL_TSV_ZIP.");
153      }
154      return new SqlDownloadRequest(sql, creator, notificationAddresses, sendNotification, format, type, description, machineDescription);
155    } else {
156      if (format == DownloadFormat.SQL_TSV_ZIP) {
157        throw new RuntimeException("Predicate downloads must not use an SQL download format.");
158      }
159      JsonNode predicate = Optional.ofNullable(node.get(PREDICATE)).orElse(null);
160      // Not yet enforced, we would need e.g. http://api.gbif.org/v1/occurrence/download/request/predicate?format=DWCA
161      // to return 'predicate: {}' etc.
162      //if (predicate == null) {
163      //  throw new RuntimeException("A predicate must be specified. Use {} for everything.");
164      //}
165      Predicate predicateObj = predicate == null ? null : MAPPER.treeToValue(predicate, Predicate.class);
166      return new PredicateDownloadRequest(predicateObj, creator, notificationAddresses, sendNotification, format, type, description, machineDescription, extensions);
167    }
168  }
169}