/*
 * This file is part of muCommander, http://www.mucommander.com
 * Copyright (C) 2002-2016 Maxence Bernard
 *
 * muCommander is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * muCommander is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.mucommander.job.impl;

import java.io.IOException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.mucommander.command.Command;
import com.mucommander.commons.file.AbstractFile;
import com.mucommander.commons.file.PermissionAccess;
import com.mucommander.commons.file.PermissionType;
import com.mucommander.commons.file.util.FileSet;
import com.mucommander.process.ProcessRunner;
import com.mucommander.ui.dialog.file.ProgressDialog;
import com.mucommander.ui.main.MainFrame;

/**
 * This job copies a file or a set of files to a temporary folder, makes the temporary file(s) read-only and
 * executes them with a specific command. The temporary files are deleted when the JVM terminates.
 *
 * <p>It is important to understand that when this job operates on a set of files, a process is started for each file
  * to execute, so this operation should require confirmation by the user before being attempted.</p>
  *
 * @author Maxence Bernard, Nicolas Rinaudo
 */
public class TempOpenWithJob extends TempCopyJob {
	private static final Logger LOGGER = LoggerFactory.getLogger(TempOpenWithJob.class);
	
    /** The command to execute, appended with the temporary file path(s) */
    private Command command;

    /** Files to execute */
    private FileSet filesToOpen;

    /** This list is populated with temporary files, as they are created by processFile() */
    private FileSet tempFiles;


    /**
     * Creates a new <code>TempOpenWithJob</code> that operates on a single file.
     *
     * @param progressDialog the ProgressDialog that monitors this job
     * @param mainFrame the MainFrame this job is attached to
     * @param fileToOpen the file to copy to a temporary location and execute
     * @param command the command used to execute the temporary file
     */
    public TempOpenWithJob(ProgressDialog progressDialog, MainFrame mainFrame, AbstractFile fileToOpen, Command command) {
        this(progressDialog, mainFrame, new FileSet(fileToOpen.getParent(), fileToOpen), command);
    }

    /**
     * Creates a new <code>TempOpenWithJob</code> that operates on a set of files. Only a single command get executed, operating on
     * all files.
     *
     * @param progressDialog the ProgressDialog that monitors this job
     * @param mainFrame the MainFrame this job is attached to
     * @param filesToOpen the set of files to copy to a temporary location and execute
     * @param command the command used to execute the temporary file
     */
    public TempOpenWithJob(ProgressDialog progressDialog, MainFrame mainFrame, FileSet filesToOpen, Command command) {
        super(progressDialog, mainFrame, filesToOpen);
        this.command  = command;
        this.filesToOpen = filesToOpen;
        tempFiles = new FileSet(baseDestFolder);
    }


    ////////////////////////
    // Overridden methods //
    ////////////////////////

    @Override
    protected boolean processFile(AbstractFile file, Object recurseParams) {
        if(!super.processFile(file, recurseParams))
            return false;

        // TODO: temporary files seem to be left after the JVM quits under Mac OS X, even if the files permissions are unchanged

        // Add the file to the list of files to open, only if it is one of the top-level files
        if(filesToOpen.indexOf(file)!=-1) {
            if(!currentDestFile.isDirectory()) {        // Do not change directories' permissions
                try {
                    // Make the temporary file read only
                    if(currentDestFile.getChangeablePermissions().getBitValue(PermissionAccess.USER, PermissionType.WRITE))
                        currentDestFile.changePermission(PermissionAccess.USER, PermissionType.WRITE, false);
                }
                catch(IOException e) {
                    LOGGER.debug("Caught exeception while changing permissions of "+currentDestFile, e);
                    return false;
                }
            }
            
            tempFiles.add(currentDestFile);
        }

        return true;
    }

    @Override
    protected void jobCompleted() {
        super.jobCompleted();

        try {
            ProcessRunner.execute(command.getTokens(tempFiles), baseDestFolder);
        }
        catch(Exception e) {
            LOGGER.debug("Caught exception executing "+command+" "+tempFiles, e);
        }
    }
}