/**
 * This file Copyright (c) 2003-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.module;

import info.magnolia.cms.core.Content;
import info.magnolia.cms.core.HierarchyManager;
import info.magnolia.cms.core.ItemType;
import info.magnolia.cms.util.ContentUtil;
import info.magnolia.context.MgnlContext;
import info.magnolia.module.model.ModuleDefinition;
import info.magnolia.repository.RepositoryConstants;

import javax.inject.Inject;
import javax.inject.Singleton;
import javax.jcr.RepositoryException;
import javax.jcr.Session;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * Default implementation of {@link info.magnolia.module.InstallContext}; provided by the {@link info.magnolia.module.ModuleManager}.
 *
 * @author gjoseph
 * @version $Revision: $ ($Author: $)
 */
@Singleton
public class InstallContextImpl implements InstallContext {
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(InstallContextImpl.class);

    private static final String DEFAULT_KEY = "General messages";

    private final ModuleRegistry moduleRegistry;
    private ModuleDefinition currentModule;
    private InstallStatus status;
    private boolean restartNeeded;
    private int executedTaskCount;
    private int totalTaskCount;
    // ensure we'll keep messages in the order they were added
    private final Map<String, List<Message>> messages = new LinkedHashMap<String, List<Message>>();

    @Inject
    public InstallContextImpl(ModuleRegistry moduleRegistry) {
        this.moduleRegistry = moduleRegistry;
    }

    public void setCurrentModule(ModuleDefinition module) {
        this.currentModule = module;
    }

    @Override
    public void info(String message) {
        log.info("> " + message);
        log(new Message(MessagePriority.info, message));
    }

    @Override
    public void warn(String message) {
        log.warn("> " + message);
        log(new Message(MessagePriority.warning, message));
    }

    @Override
    public void error(String message, Throwable th) {
        log.error("> " + message, th);
        log(new Message(MessagePriority.error, message, th));
    }

    @Override
    public void restartNeeded(String message) {
        this.restartNeeded = true;
        log.warn("> restartNeeded > " + message);
        log(new Message(MessagePriority.restartNeeded, message));
    }

    boolean isRestartNeeded() {
        return restartNeeded;
    }

    void incExecutedTaskCount() {
        executedTaskCount++;
    }

    @Override
    public int getExecutedTaskCount() {
        return executedTaskCount;
    }

    @Override
    public int getTotalTaskCount() {
        return totalTaskCount;
    }

    void setTotalTaskCount(int totalTaskCount) {
        this.totalTaskCount = totalTaskCount;
    }

    @Override
    public InstallStatus getStatus() {
        return status;
    }

    void setStatus(InstallStatus status) {
        this.status = status;
    }

    @Override
    public Map<String, List<Message>> getMessages() {
        return messages;
    }

    @Override
    public ModuleDefinition getCurrentModuleDefinition() {
        return currentModule;
    }

    @Override
    public boolean isModuleRegistered(String moduleName) {
        return moduleRegistry.isModuleRegistered(moduleName);
    }

    @Override
    public HierarchyManager getHierarchyManager(String workspace) {
        return MgnlContext.getSystemContext().getHierarchyManager(workspace);
    }

    @Override
    public HierarchyManager getConfigHierarchyManager() {
        return getHierarchyManager(RepositoryConstants.CONFIG);
    }

    @Override
    public Session getJCRSession(String workspaceName) throws RepositoryException {
        return MgnlContext.getSystemContext().getJCRSession(workspaceName);
    }

    @Override
    public Session getConfigJCRSession() throws RepositoryException {
        return getJCRSession(RepositoryConstants.CONFIG);
    }

    @Override
    public boolean hasModulesNode() {
        final HierarchyManager hm = getConfigHierarchyManager();
        return hm.isExist("/" + ModuleManagerImpl.MODULES_NODE);
    }

    @Override
    public Content getModulesNode() throws RepositoryException {
        final HierarchyManager hm = getConfigHierarchyManager();
        return hm.getContent(ModuleManagerImpl.MODULES_NODE);
    }

    @Override
    public Content getOrCreateCurrentModuleNode() throws RepositoryException {
        final Content allModulesNode = getModulesNode();
        return ContentUtil.getOrCreateContent(allModulesNode, currentModule.getName(), ItemType.CONTENT);
    }

    @Override
    public Content getOrCreateCurrentModuleConfigNode() throws RepositoryException {
        final Content moduleNode = getOrCreateCurrentModuleNode();
        return ContentUtil.getOrCreateContent(moduleNode, "config", ItemType.CONTENT);
    }

    protected void log(final Message message) {
        final String k = getModuleKey();
        List<Message> messagesForKey = messages.get(k);
        if (messagesForKey == null) {
            messagesForKey = new ArrayList<Message>();
            messages.put(k, messagesForKey);
        }
        messagesForKey.add(message);
    }

    /**
     * The key used in the map of messages. This is mostly because Maps keys in FreeMarker can only be Strings...
     * We just need to make sure this is consistent across templates...
     */
    protected String getModuleKey() {
        return currentModule != null ? currentModule.toString() : DEFAULT_KEY;
    }
}