/*
 *  Copyright 2010 Anyware Services
 *
 *  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.ametys.plugins.newsletter.daos;

import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.session.SqlSession;

import org.ametys.core.datasource.AbstractMyBatisDAO;

/**
 * DAO for accessing newsletters subscribers.
 */
public class SubscribersDAO extends AbstractMyBatisDAO implements ThreadSafe
{
    /** The Avalon role name. */
    public static final String ROLE = SubscribersDAO.class.getName();
    
    /**
     * Get the whole list for subscribers
     * @return The list for subscribers
     */
    public List<Subscriber> getSubscribers()
    {
        try (SqlSession session = getSession())
        {
            return session.selectList("Subscribers.getSubscribers");
        }
    }
    
    /**
     * Get the subscribers to a newsletter category
     * @param siteName The site name
     * @param categoryId The newsletter category's id
     * @return the subscribers
     */
    public List<Subscriber> getSubscribers (String siteName, String categoryId)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("siteName", siteName);
        params.put("category", categoryId);
        
        try (SqlSession session = getSession())
        {
            return session.selectList("Subscribers.getSubscribersByCategory", params);
        }
    }
    
    /**
     * Get the subscribers to a newsletter category
     * @param siteName The site name
     * @param categoryId The newsletter category's id
     * @param offset The number of results to ignore.
     * @param limit The maximum number of results to return.
     * @return the subscribers
     */
    public List<Subscriber> getSubscribers (String siteName, String categoryId, int offset, int limit)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("siteName", siteName);
        params.put("category", categoryId);
        
        try (SqlSession session = getSession())
        {
            return session.selectList("Subscribers.getSubscribersByCategory", params, new RowBounds(offset, limit));
        }
    }
    
    /**
     * Get the subscribers count for a newsletter category
     * @param siteName The site name
     * @param categoryId The newsletter category's id
     * @return the subscribers count
     */
    public int getSubscribersCount (String siteName, String categoryId)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("siteName", siteName);
        params.put("category", categoryId);
        
        try (SqlSession session = getSession())
        {
            return (Integer) session.selectOne("Subscribers.getSubscribersCount", params);
        }
    }
    
    /**
     * Get a subscriber to a newsletter category
     * @param email The subscriber email
     * @param siteName The site name
     * @param categoryId The newsletter category's id
     * @return the subscribers
     */
    public Subscriber getSubscriber (String email, String siteName, String categoryId)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("email", email);
        params.put("siteName", siteName);
        params.put("category", categoryId);
        
        try (SqlSession session = getSession())
        {
            return (Subscriber) session.selectOne("Subscribers.getSubscriber", params);
        }
    }
    
    /**
     * Get a subscriber by his token
     * @param token The user token
     * @return the subscribers
     */
    public Subscriber getSubscriberByToken (String token)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("token", token);
        
        try (SqlSession session = getSession())
        {
            return (Subscriber) session.selectOne("Subscribers.getSubscriberByToken", params);
        }
    }
    
    /**
     * Get the list of subscriptions for a given email and site name.
     * @param email the email.
     * @param siteName the site name.
     * @return the list of subscriptions.
     */
    public List<Subscriber> getSubscriptions(String email, String siteName)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("email", email);
        params.put("siteName", siteName);
        
        try (SqlSession session = getSession())
        {
            return session.selectList("Subscribers.getSubscriptionsByEmail", params);
        }
    }
    
    /**
     * Subscribes to the newsletter
     * @param subscriber The subscriber
     */
    public void subscribe (Subscriber subscriber)
    {
        try (SqlSession session = getSession(true))
        {
            session.insert("Subscribers.subscribe", subscriber);
        }
    }
    
    /**
     * Insert several subscriptions to newsletters.
     * @param subscribers a list of subscribers.
     */
    public void subscribe(Collection<Subscriber> subscribers)
    {
        try (SqlSession session = getSession())
        {
            for (Subscriber subscriber : subscribers)
            {
                session.insert("Subscribers.subscribe", subscriber);
            }
            
            session.commit();
        }
    }
    
    
    /**
     * Insert several subscriptions to newsletters.
     * @param newSubscribers the collection of subscribers to insert.
     * @param removeSubscriptions the collection of subscription tokens to remove.
     */
    public void modifySubscriptions(Collection<Subscriber> newSubscribers, Collection<String> removeSubscriptions)
    {
        try (SqlSession session = getSession())
        {
            for (Subscriber subscriber : newSubscribers)
            {
                session.insert("Subscribers.subscribe", subscriber);
            }
            
            for (String tokenToRemove : removeSubscriptions)
            {
                session.update("Subscribers.unsubscribe", tokenToRemove);
            }
            
            session.commit();
        }
    }
    
    /**
     * Unsubscribes to the newsletter
     * @param token The unique token
     */
    public void unsubscribe (String token)
    {
        try (SqlSession session = getSession(true))
        {
            session.update("Subscribers.unsubscribe", token);
        }
    }
    
    /**
     * Empty a category's subscribers.
     * @param categoryId the category to empty.
     * @param siteName the site name.
     */
    public void empty(String categoryId, String siteName)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("categoryId", categoryId);
        params.put("siteName", siteName);
        
        try (SqlSession session = getSession(true))
        {
            session.delete("Subscribers.empty", params);
        }
    }
    
    /**
     * Remove all subscriptions for a subscriber in a given site.
     * @param email the category to empty.
     * @param siteName the site name.
     */
    public void unsubscribe(String email, String siteName)
    {
        Map<String, Object> params = new HashMap<>();
        params.put("email", email);
        params.put("siteName", siteName);
        
        try (SqlSession session = getSession(true))
        {
            session.delete("Subscribers.removeSubscriptionsByEmail", params);
        }
    }
}