/*
 *  Copyright 2013 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.skincommons;

import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.Date;
import java.util.List;

import org.apache.avalon.framework.component.Component;
import org.apache.avalon.framework.logger.AbstractLogEnabled;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.avalon.framework.service.ServiceManager;
import org.apache.avalon.framework.service.Serviceable;
import org.apache.avalon.framework.thread.ThreadSafe;
import org.apache.commons.io.IOUtils;
import org.joda.time.format.ISODateTimeFormat;

import org.ametys.core.user.CurrentUserProvider;
import org.ametys.core.user.UserIdentity;

/**
 * Component to manage lock on skin directories.
 *
 */
public class SkinLockManager extends AbstractLogEnabled implements Component, ThreadSafe, Serviceable
{
    /** The Avalon role name */
    public static final String ROLE = SkinLockManager.class.getName();
    
    private CurrentUserProvider _userProvider;
    
    @Override
    public void service(ServiceManager smanager) throws ServiceException
    {
        _userProvider = (CurrentUserProvider) smanager.lookup(CurrentUserProvider.ROLE);
    }
    
    /**
     * Determines if the current user can write in skin directory
     * @param file The skin directory
     * @return <code>true</code> if the skin directory is not locked by another user
     * @throws IOException If an error occurred
     */
    public boolean canWrite (File file) throws IOException
    {
        return getLockOwner(file).equals(_userProvider.getUser());
    }
    
    /**
     * Create or update .lock file
     * @param file The skin directory
     * @param toolId The id of tool responsible for lock.
     * @throws IOException If an error occurred
     */
    public void updateLockFile (File file, String toolId) throws IOException
    {
        File lockFile = new File(file, ".lock");
        if (lockFile.exists())
        {
            lockFile.delete();
        }
        lockFile.createNewFile();
        
        try (Writer writer = new FileWriter(lockFile);)
        {
            IOUtils.write(UserIdentity.userIdentityToString(_userProvider.getUser()) + "\n", writer);
            IOUtils.write(ISODateTimeFormat.dateTime().print(new Date().getTime()) + "\n", writer);
            IOUtils.write(toolId, writer);
        }
    }
    
    /**
     * Remove lock file
     * @param file The skin directory
     */
    public void unlock (File file)
    {
        File lockFile = new File(file, ".lock");
        if (lockFile.exists())
        {
            lockFile.delete();
        }
    }
    
    /**
     * Determines if the skin directory is locked
     * @param file The skin directory
     * @return <code>true</code> if the skin directory is locked
     */
    public boolean isLocked (File file)
    {
        File lockFile = new File(file, ".lock");
        return lockFile.exists();
    }
    
    /**
     * Get lock owner
     * @param file The skin directory
     * @return The lock owner or null.
     * @throws IOException if an error occurs while manipulating files
     */
    public UserIdentity getLockOwner (File file) throws IOException
    {
        File lockFile = new File(file, ".lock");
        if (!lockFile.exists())
        {
            return null;
        }
        
        try (FileReader reader = new FileReader(lockFile);)
        {
            List<String> lines = IOUtils.readLines(reader);
            
            if (!lines.isEmpty())
            {
                return UserIdentity.stringToUserIdentity(lines.get(0));
            }
            
            return null;
        }
    }
    
    /**
     * Get tool responsible for lock
     * @param file The skin directory
     * @return The tool responsible for lock or <code>null</code>
     * @throws IOException if an error occurs while manipulating files
     */
    public String getLockTool (File file)  throws IOException
    {
        File lockFile = new File(file, ".lock");
        if (!lockFile.exists())
        {
            return null;
        }
        
        try (FileReader reader = new FileReader(lockFile);)
        {
            List<String> lines = IOUtils.readLines(reader);
            
            if (!lines.isEmpty() && lines.size() > 2)
            {
                return lines.get(2);
            }
            
            return null;
        }
    }
    
    /**
     * Get the last modified date
     * @param file The skin directory
     * @return the last modified date
     * @throws IOException if an error occurs while manipulating files
     */
    public Date lastModified (File file) throws IOException
    {
        File lockFile = new File(file, ".lock");
        if (!lockFile.exists())
        {
            return null;
        }
        
        try (FileReader reader = new FileReader(lockFile);)
        {
            List<String> lines = IOUtils.readLines(reader);
            
            if (!lines.isEmpty() && lines.size() > 1)
            {
                return ISODateTimeFormat.dateTime().parseDateTime(lines.get(1)).toDate();
            }
            
            return null;
        }
        catch (IndexOutOfBoundsException e)
        {
            return null;
        }
    }
}