/*
 * This work was created by participants in the DataONE project, and is
 * jointly copyrighted by participating institutions in DataONE. For
 * more information on DataONE, see our web site at http://dataone.org.
 *
 *   Copyright 2020. All rights reserved.
 *
 * 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.
 *
 */

package org.dataone.bookkeeper.jdbi;

import org.dataone.bookkeeper.api.Usage;
import org.jdbi.v3.sqlobject.config.RegisterBeanMapper;
import org.jdbi.v3.sqlobject.customizer.Bind;
import org.jdbi.v3.sqlobject.customizer.BindBean;
import org.jdbi.v3.sqlobject.customizer.BindList;
import org.jdbi.v3.sqlobject.statement.GetGeneratedKeys;
import org.jdbi.v3.sqlobject.statement.SqlQuery;
import org.jdbi.v3.sqlobject.statement.SqlUpdate;

import java.util.List;

@RegisterBeanMapper(Usage.class)
public interface UsageStore {

    /** The query used to find all usages */
    String SELECT_CLAUSE =
        "SELECT " +
            "u.id, " +
            "u.object, " +
            "u.quotaid, " +
            "u.instanceid, " +
            "u.quantity, " +
            "u.status, " +
            "u.nodeid " +
        "FROM usages u ";

    /** The full query */
    String SELECT_ALL = SELECT_CLAUSE;

    /** Select by identifer */
    String SELECT_BY_ID = SELECT_CLAUSE +
            "WHERE u.id = :id";

    /** Select by instance identifier */
    String SELECT_BY_INSTANCE_ID = SELECT_CLAUSE + "WHERE u.instanceId = :instanceId";

    /** Select by instance identifier and subjects */
    String SELECT_BY_INSTANCE_ID_AND_OWNERS = SELECT_CLAUSE +
            "INNER JOIN quotas q ON q.id = u.quotaid " +
            "WHERE u.instanceid = :instanceId " +
            "AND q.subject IN (<subjects>)";

    /** Select by instance identifier and quota identifier */
    String SELECT_BY_INSTANCE_ID_AND_QUOTA_ID = SELECT_CLAUSE + "WHERE u.instanceId = :instanceId AND u.quotaid = :quotaId";

    /** Select by instance identifier, quota identifier and subjects */
    String SELECT_BY_INSTANCE_ID_AND_QUOTA_ID_AND_OWNERS = SELECT_CLAUSE +
            "INNER JOIN quotas q ON q.id = u.quotaid " +
            "WHERE u.instanceid = :instanceId " +
            "AND u.quotaId = :quotaId " +
            "AND q.subject IN (<subjects>)";

    /** Select by quota identifier */
    String SELECT_BY_QUOTA_ID = SELECT_CLAUSE +
            "WHERE u.quotaId = :quotaId";

    /** Select by quota identifier and subject */
    String SELECT_BY_QUOTA_ID_AND_OWNERS = SELECT_CLAUSE +
            "INNER JOIN quotas q ON q.id = u.quotaid " +
            "WHERE u.quotaid = :quotaId " +
            "AND q.subject IN (<subjects>)";

    /** Select by quota type */
    String SELECT_BY_QUOTA_TYPE = SELECT_CLAUSE +
            "INNER JOIN quotas q ON q.id = u.quotaid " +
            "WHERE q.quotaType = :quotaType";

    /** Select by quota subjects */
    String SELECT_BY_QUOTA_OWNERS = SELECT_CLAUSE +
            "INNER JOIN quotas q ON q.id = u.quotaid " +
            "WHERE q.subject IN (<subjects>)";

    /** Select by quota type and subjects */
    String SELECT_BY_QUOTA_TYPE_AND_OWNERS = SELECT_CLAUSE +
            "INNER JOIN quotas q ON q.id = u.quotaid " +
            "WHERE q.quotaType = :quotaType " +
            "AND q.subject IN (<subjects>)";

    /** Select by instance identifier, quota identifier and subject */
    String SELECT_BY_INSTANCE_ID_AND_QUOTA_TYPE = SELECT_CLAUSE +
            "INNER JOIN quotas q ON q.id = u.quotaid " +
            "WHERE u.instanceid = :instanceId " +
            "AND q.quotaType = :quotaType";

    /**
     * List all usages
     * @return usages the list of usages
     */
    @SqlQuery(SELECT_ALL)
    List<Usage> listUsages();

    /**
     * Find usages by usage identifier
     * @param id the usage identifier
     * @return usage the usage for the identifier
     */
    @SqlQuery(SELECT_BY_ID)
    Usage getUsage(@Bind("id") Integer id);

    /**
     * Find usages by instance identifier
     * @param instanceId the usage instance id
     * @return usages the usages for the instanceId
     */
    @SqlQuery(SELECT_BY_INSTANCE_ID)
    List <Usage> findUsagesByInstanceId(@Bind("instanceId") String instanceId);

    /**
     * Find usages by instance identifier and subject.
     * @param instanceId the usage instance id
     * @param subjects list of quota subjects
     * @return usage the usage for the instanceId and subjects
     */
    @SqlQuery(SELECT_BY_INSTANCE_ID_AND_OWNERS)
    List<Usage> findUsagesByInstanceIdAndSubjects(@Bind("instanceId") String instanceId, @BindList("subjects") List<String> subjects);

    /**
     * Find usages by instance identifier and quota identifier.
     * @param instanceId the usage instance id
     * @param quotaId the quota id
     * @return usage the usage for the instance identifier and quota identifier
     */
    @SqlQuery(SELECT_BY_INSTANCE_ID_AND_QUOTA_ID)
    Usage findUsageByInstanceIdAndQuotaId(@Bind("instanceId") String instanceId, @Bind("quotaId") Integer quotaId);

    /**
     * Find usages by instance identifier, quota identifier and subjects.
     * @param instanceId the usage instance id
     * @param quotaId the quota id
     * @param subjects list of subjects
     * @return usage the usage for the instance identifier, quota identifier and subjects
     */
    @SqlQuery(SELECT_BY_INSTANCE_ID_AND_QUOTA_ID_AND_OWNERS)
    Usage findUsageByInstanceIdQuotaIdAndSubjects (@Bind("instanceId") String instanceId, @Bind("quotaId") Integer quotaId, @BindList("subjects") List<String> subjects);

    /**
     * Find usages by quota identifier
     * @param quotaId the quota id
     * @return usages the usages for the quota id
     */
    @SqlQuery(SELECT_BY_QUOTA_ID)
    List<Usage> findUsagesByQuotaId(@Bind("quotaId") Integer quotaId);

    /**
     * Find usages by quota identifier and subjects.
     * @param quotaId the quota id
     * @param subjects list of subjects
     * @return usage the usage for the instanceId and subjects
     */
    @SqlQuery(SELECT_BY_QUOTA_ID_AND_OWNERS)
    List<Usage> findUsagesByQuotaIdAndSubjects (@Bind("quotaId") Integer quotaId, @BindList("subjects") List<String> subjects);

    /**
     * Find usages by quota type.
     * @param quotaType quota type (e.g. "portal", "storage", ...)
     * @return the list of usages for the quota type
     */
    @SqlQuery(SELECT_BY_QUOTA_TYPE)
    List<Usage> findUsagesByQuotaType(@Bind("quotaType") String quotaType);

    /**
     * Find usages by quota subjects
     * @param subjects the quota subjects
     * @return the list of usages for the quota subjects
     */
    @SqlQuery(SELECT_BY_QUOTA_OWNERS)
    List<Usage> findUsagesByQuotaSubjects(@BindList("subjects") List<String> subjects);

    /**
     * Find usages by name and subjects.
     * @param quotaType the object ("portal", "storage", ...)
     * @param subjects the list of quota subjects
     * @return usages the list of usages for quota type and subjects
     */
    @SqlQuery(SELECT_BY_QUOTA_TYPE_AND_OWNERS)
    List<Usage> findUsagesByQuotaTypeAndSubjects(@Bind("quotaType") String quotaType, @BindList("subjects") List<String> subjects);

    /**
     * Find usages by instance identifier and quota type.
     * @param instanceId the usage instance id
     * @param quotaType the quota type
     * @return usageStatus the usage status for the instance identifier and quota type
     */
    @SqlQuery(SELECT_BY_INSTANCE_ID_AND_QUOTA_TYPE)
    Usage findUsageByInstanceIdAndQuotaType(@Bind("instanceId") String instanceId, @Bind("quotaType") String quotaType);

    /**
     * Insert a usage with a given Usage instance
     * @param usage the usage to insert
     */
    @SqlUpdate("INSERT INTO usages " +
            "(object, " +
            "quotaId, " +
            "instanceId, " +
            "quantity, " +
            "status, " +
            "nodeId) " +
            "VALUES " +
            "(:object, " +
            ":quotaId, " +
            ":instanceId, " +
            ":quantity, " +
            ":status, " +
            ":nodeId) " +
            "RETURNING id")
    @GetGeneratedKeys
    Integer insert(@BindBean Usage usage);

    /**
     * Update a usage for a given id
     * @param usage the usage to update
     */
    @SqlUpdate("UPDATE usages " +
            "SET object = :object, " +
            "quotaId = :quotaId, " +
            "instanceId = :instanceId, " +
            "quantity = :quantity, " +
            "status = :status, " +
            "nodeId = :nodeId " +
            "WHERE id = :id")
    @GetGeneratedKeys
    Usage update(@BindBean Usage usage);

    /**
     * Delete a usage
     * @param id the usage id to delete
     */
    @SqlUpdate("DELETE FROM usages WHERE id = :id")
    void delete(@Bind("id") Integer id);

}