contrib/storage-http/src/main/java/org/apache/drill/exec/store/http/udfs/HttpHelperFunctions.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

package org.apache.drill.exec.store.http.udfs;

import org.apache.drill.exec.expr.DrillSimpleFunc;
import org.apache.drill.exec.expr.annotations.FunctionTemplate;
import org.apache.drill.exec.expr.annotations.Output;
import org.apache.drill.exec.expr.annotations.Param;
import org.apache.drill.exec.expr.annotations.Workspace;
import org.apache.drill.exec.expr.holders.NullableVarCharHolder;
import org.apache.drill.exec.expr.holders.VarCharHolder;
import org.apache.drill.exec.physical.resultSet.ResultSetLoader;
import org.apache.drill.exec.server.DrillbitContext;
import org.apache.drill.exec.server.options.OptionManager;
import org.apache.drill.exec.vector.complex.writer.BaseWriter.ComplexWriter;

import javax.inject.Inject;

public class HttpHelperFunctions {

  @FunctionTemplate(names = {"http_get", "httpGet"},
    scope = FunctionTemplate.FunctionScope.SIMPLE,
    isVarArg = true)
  public static class HttpGetFunction implements DrillSimpleFunc {

    @Param
    VarCharHolder rawInput;

    @Param
    NullableVarCharHolder[] inputReaders;

    @Output // todo: remove. Not used in this UDF
    ComplexWriter writer;

    @Inject
    OptionManager options;

    @Inject
    ResultSetLoader rsLoader;

    @Workspace
    org.apache.drill.exec.store.easy.json.loader.JsonLoaderImpl jsonLoader;

    @Workspace
    org.apache.drill.exec.store.easy.json.loader.SingleElementIterator<java.io.InputStream> stream;

    @Override
    public void setup() {
      stream = new org.apache.drill.exec.store.easy.json.loader.SingleElementIterator<>();
      rsLoader.startBatch();
    }

    @Override
    public void eval() {
      // Get the URL
      String url = org.apache.drill.exec.expr.fn.impl.StringFunctionHelpers.toStringFromUTF8(rawInput.start, rawInput.end, rawInput.buffer);
      // Process Positional Arguments
      java.util.List args = org.apache.drill.exec.store.http.util.SimpleHttp.buildParameterList(inputReaders);
      // If the arg list is null, indicating at least one null arg, return an empty map
      // as an approximation of null-if-null handling.
      if (args == null) {
        return;
      }
      String finalUrl = org.apache.drill.exec.store.http.util.SimpleHttp.mapPositionalParameters(url, args);
      // Make the API call, we expect that results will be closed by the JsonLoader
      java.io.InputStream results = org.apache.drill.exec.store.http.util.SimpleHttp.getRequestAndStreamResponse(finalUrl);
      // If the result string is null or empty, return an empty map
      if (results == null) {
        return;
      }
      try {
        stream.setValue(results);
        if (jsonLoader == null) {
          jsonLoader = org.apache.drill.exec.store.http.udfs.HttpUdfUtils.createJsonLoader(rsLoader, options, stream);
        }
        org.apache.drill.exec.physical.resultSet.RowSetLoader rowWriter = rsLoader.writer();
        rowWriter.start();
        if (jsonLoader.parser().next()) {
          rowWriter.save();
        } else {
          jsonLoader.close();
        }
      } catch (Exception e) {
        throw org.apache.drill.common.exceptions.UserException.dataReadError(e)
          .message("Error while reading JSON. ")
          .addContext(e.getMessage())
          .build();
      }
    }
  }

  @FunctionTemplate(names = {"http_request", "httpRequest"},
    scope = FunctionTemplate.FunctionScope.SIMPLE,
    isVarArg = true)
  public static class HttpGetFromStoragePluginFunction implements DrillSimpleFunc {

    @Param(constant = true)
    VarCharHolder rawInput;

    @Param
    NullableVarCharHolder[] inputReaders;

    @Output // todo: remove. Not used in this UDF
    ComplexWriter writer;

    @Inject
    OptionManager options;

    @Inject
    DrillbitContext drillbitContext;

    @Inject
    ResultSetLoader rsLoader;

    @Workspace
    org.apache.drill.exec.store.easy.json.loader.JsonLoaderImpl jsonLoader;

    @Workspace
    org.apache.drill.exec.store.http.HttpStoragePlugin plugin;

    @Workspace
    org.apache.drill.exec.store.http.HttpApiConfig endpointConfig;

    @Workspace
    org.apache.drill.exec.store.easy.json.loader.SingleElementIterator<java.io.InputStream> stream;

    @Override
    public void setup() {
      String schemaPath = org.apache.drill.exec.expr.fn.impl.StringFunctionHelpers.toStringFromUTF8(rawInput.start, rawInput.end, rawInput.buffer);
      // Get the plugin name and endpoint name
      String[] parts = schemaPath.split("\\.");
      if (parts.length < 2) {
        throw new org.apache.drill.common.exceptions.DrillRuntimeException(
          "You must call this function with a connection name and endpoint."
        );
      }
      String pluginName = parts[0], endpointName = parts[1];

      plugin = org.apache.drill.exec.store.http.util.SimpleHttp.getStoragePlugin(pluginName, drillbitContext);

      endpointConfig = org.apache.drill.exec.store.http.util.SimpleHttp.getEndpointConfig(
        endpointName,
        plugin.getConfig()
      );
      stream = new org.apache.drill.exec.store.easy.json.loader.SingleElementIterator<>();
      // Add JSON configuration from Storage plugin, if present.
      rsLoader.startBatch();
    }

    @Override
    public void eval() {
      // Process Positional Arguments
      java.util.List args = org.apache.drill.exec.store.http.util.SimpleHttp.buildParameterList(inputReaders);
      // If the arg list is null, indicating at least one null arg, return an empty map
      // as an approximation of null-if-null handling.
      if (args == null) {
        return;
      }
      // we expect that results will be closed by the JsonLoader
      java.io.InputStream results = org.apache.drill.exec.store.http.util.SimpleHttp.apiCall(plugin, endpointConfig, drillbitContext, args)
        .getInputStream();
      // If the result string is null or empty, return an empty map
      if (results == null) {
        return;
      }
      try {
        stream.setValue(results);
        if (jsonLoader == null) {
          // Add JSON configuration from Storage plugin, if present.
          jsonLoader = org.apache.drill.exec.store.http.udfs.HttpUdfUtils.createJsonLoader(endpointConfig, rsLoader, options, stream);
        }
        org.apache.drill.exec.physical.resultSet.RowSetLoader rowWriter = rsLoader.writer();
        rowWriter.start();
        if (jsonLoader.parser().next()) {
          rowWriter.save();
        } else {
          jsonLoader.close();
        }
      } catch (Exception e) {
        throw org.apache.drill.common.exceptions.UserException.dataReadError(e)
          .message("Error while reading JSON. ")
          .addContext(e.getMessage())
          .build();
      }
    }
  }
}