/*
 * Copyright (c) 2010-2012 Lockheed Martin Corporation
 *
 * 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.eurekastreams.server.action.execution.notification.translator;

import java.io.Serializable;
import java.util.List;

import org.eurekastreams.server.action.execution.notification.NotificationBatch;
import org.eurekastreams.server.action.execution.notification.NotificationPropertyKeys;
import org.eurekastreams.server.action.request.notification.ActivityNotificationsRequest;
import org.eurekastreams.server.domain.NotificationType;
import org.eurekastreams.server.domain.stream.ActivityDTO;
import org.eurekastreams.server.domain.stream.StreamEntityDTO;
import org.eurekastreams.server.persistence.mappers.DomainMapper;
import org.eurekastreams.server.search.modelview.PersonModelView;
import org.eurekastreams.server.service.utility.ui.UiUrlBuilder;

/**
 * Translates the event of someone flagging an activity to appropriate notifications.
 */
public class FlagTranslator implements NotificationTranslator<ActivityNotificationsRequest>
{
    /** For getting activity details. */
    private final DomainMapper<Long, ActivityDTO> activityDAO;

    /**
     * Mapper to get a list of system admin ids.
     */
    private final DomainMapper<Serializable, List<Long>> systemAdminsDAO;

    /**
     * Constructor.
     *
     * @param inActivityDAO
     *            For getting activity details.
     * @param inSystemAdminsDAO
     *            For getting the system admin ids.
     */
    public FlagTranslator(final DomainMapper<Long, ActivityDTO> inActivityDAO,
            final DomainMapper<Serializable, List<Long>> inSystemAdminsDAO)
    {
        activityDAO = inActivityDAO;
        systemAdminsDAO = inSystemAdminsDAO;
    }

    /**
     * This method takes the activity and gets a list of all the admins since they have authority over the person or
     * group stream where the activity was posted. Those will be the recipients.
     *
     * {@inheritDoc}
     */
    @Override
    public NotificationBatch translate(final ActivityNotificationsRequest inRequest)
    {
        // Get the activity
        ActivityDTO activity = activityDAO.execute(inRequest.getActivityId());
        StreamEntityDTO stream = activity.getDestinationStream();

        // Get the list of admins, remove actor (in case actor is an admin)
        // NOTE: This code assumes that the DAO returns a list which can be safely altered, specifically that it
        // supports removing elements and is not used elsewhere (e.g. stored off).
        List<Long> adminIds = systemAdminsDAO.execute(null);
        adminIds.remove(inRequest.getActorId());

        NotificationBatch batch = new NotificationBatch(NotificationType.FLAG_ACTIVITY, adminIds);
        batch.setProperty(NotificationPropertyKeys.ACTOR, PersonModelView.class, inRequest.getActorId());
        batch.setProperty("activity", activity);
        batch.setProperty("stream", stream);
        batch.setPropertyAlias(NotificationPropertyKeys.SOURCE, "stream");
        batch.setProperty(NotificationPropertyKeys.HIGH_PRIORITY, true);
        batch.setProperty(NotificationPropertyKeys.URL, UiUrlBuilder.relativeUrlForFlaggedActivity());
        return batch;
    }
}