/*
 * 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.hadoop.yarn.appcatalog.controller;

import java.io.IOException;
import java.util.List;

import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

import org.apache.hadoop.yarn.appcatalog.application.AppCatalogSolrClient;
import org.apache.hadoop.yarn.appcatalog.model.AppStoreEntry;
import org.apache.hadoop.yarn.appcatalog.model.Application;

/**
 * Application catalog REST API for searching and recommending
 * applications.
 *
 */
@Path("/app_store")
public class AppStoreController {

  public AppStoreController() {
  }

  /**
   * Display the most frequently used applications on YARN AppCatalog home page.
   *
   * <pre>{@code
   * @apiGroup AppStoreController
   * @apiName get
   * @api {get} /app_store/recommended  Display recommended applications.
   * @apiSuccess {Object} AppEntry Application configuration.
   * @apiSuccessExample {json} Success-Response:
   *     HTTP/1.1 200 OK
   *     [
   *        {
   *           "id":"96b7833a-e3",
   *           "org":"Hortonworks",
   *           "name":"LAMP",
   *           "desc":"Linux Apache MySQL PHP web application",
   *           "icon":"/css/img/feather.png",
   *           "like":0,
   *           "download":0,
   *           "app":null
   *        },
   *        {
   *        ...
   *        }
   *     ]
   * }</pre>
   *
   * @return List of YARN applications
   */
  @GET
  @Path("recommended")
  @Produces(MediaType.APPLICATION_JSON)
  public List<AppStoreEntry> get() {
    AppCatalogSolrClient sc = new AppCatalogSolrClient();
    return sc.getRecommendedApps();
  }

  /**
   * Search for yarn applications from solr.
   *
   * <pre>{@code
   * @apiGroup AppStoreController
   * @apiName search
   * @api {get} /app_store/search  Find application from appstore.
   * @apiParam {String} q Keyword to search.
   * @apiSuccess {Object} AppStoreEntry List of matched applications.
   * @apiSuccessExample {json} Success-Response:
   *     HTTP/1.1 200 OK
   *     [
   *        {
   *           "id":"96b7833a-e3",
   *           "org":"Hortonworks",
   *           "name":"LAMP",
   *           "desc":"Linux Apache MySQL PHP web application",
   *           "icon":"/css/img/feather.png",
   *           "like":0,
   *           "download":0,
   *           "app":null
   *        },
   *        {
   *        ...
   *        }
   *     ]
   * }</pre>
   *
   * @param keyword search for keyword
   * @return List of YARN applications matching keyword search.
   */
  @GET
  @Path("search")
  @Produces(MediaType.APPLICATION_JSON)
  public List<AppStoreEntry> search(@QueryParam("q") String keyword) {
    AppCatalogSolrClient sc = new AppCatalogSolrClient();
    return sc.search(keyword);
  }

  /**
   * Find yarn application from solr.
   *
   * @param id Application ID
   * @return AppEntry
   */
  @GET
  @Path("get/{id}")
  @Produces(MediaType.APPLICATION_JSON)
  public AppStoreEntry get(@PathParam("id") String id) {
    AppCatalogSolrClient sc = new AppCatalogSolrClient();
    return sc.findAppStoreEntry(id);
  }

  /**
   * Register an application.
   *
   * <pre>{@code
   * @apiGroup AppStoreController
   * @apiName register
   * @api {post} /app_store/register  Register an application in appstore.
   * @apiParam {Object} app Application definition.
   * @apiParamExample {json} Request-Example:
   *     {
   *       "name": "Jenkins",
   *       "organization": "Jenkins-ci.org",
   *       "description": "The leading open source automation server",
   *       "icon": "/css/img/jenkins.png",
   *       "lifetime": "3600",
   *       "components": [
   *         {
   *           "name": "jenkins",
   *           "number_of_containers": 1,
   *           "artifact": {
   *             "id": "eyang-1.openstacklocal:5000/jenkins:latest",
   *             "type": "DOCKER"
   *           },
   *           "launch_command": "",
   *           "resource": {
   *             "cpus": 1,
   *             "memory": "2048"
   *           },
   *           "configuration": {
   *             "env": {
   *             },
   *             "files": [
   *             ]
   *           }
   *         }
   *       ],
   *       "quicklinks": {
   *         "Jenkins UI": "http://jenkins.${SERVICE_NAME}.${USER}.${DOMAIN}:8080/"
   *       }
   *     }
   * @apiSuccess {String} Response Application register result.
   * @apiError BadRequest Error in process application registration.
   * }</pre>
   *
   * @param app Yarnfile in JSON form
   * @return Web response
   */
  @POST
  @Path("register")
  @Produces(MediaType.APPLICATION_JSON)
  public Response register(Application app) {
    try {
      if (app.getName()==null) {
        throw new IOException("Application name can not be empty.");
      }
      if (app.getOrganization()==null) {
        throw new IOException("Application organization can not be empty.");
      }
      if (app.getDescription()==null) {
        throw new IOException("Application description can not be empty.");
      }
      AppCatalogSolrClient sc = new AppCatalogSolrClient();
      sc.register(app);
    } catch (IOException e) {
      return Response.status(Status.BAD_REQUEST).entity(e.getMessage()).build();
    }
    return Response.status(Status.ACCEPTED).build();
  }
}
