source: trunk/gli/src/org/greenstone/gatherer/file/FileQueue.java@ 11085

/**
 *#########################################################################
 *
 * A component of the Gatherer application, part of the Greenstone digital
 * library suite from the New Zealand Digital Library Project at the
 * University of Waikato, New Zealand.
 *
 * Author: John Thompson, Greenstone Digital Library, University of Waikato
 *
 * Copyright (C) 1999 New Zealand Digital Library Project
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *########################################################################
 */
package org.greenstone.gatherer.file;

import java.io.*;
import java.util.*;
import javax.swing.*;
import javax.swing.event.*;
import javax.swing.tree.*;
import org.greenstone.gatherer.Configuration;
import org.greenstone.gatherer.DebugStream;
import org.greenstone.gatherer.Dictionary;
import org.greenstone.gatherer.Gatherer;
import org.greenstone.gatherer.collection.CollectionTreeNode;
import org.greenstone.gatherer.gui.GProgressBar;
import org.greenstone.gatherer.gui.tree.DragTree;
import org.greenstone.gatherer.metadata.MetadataValue;
import org.greenstone.gatherer.metadata.MetadataXMLFileManager;
import org.greenstone.gatherer.util.DragComponent;
import org.greenstone.gatherer.util.StaticStrings;
import org.greenstone.gatherer.util.SynchronizedTreeModelTools;
import org.greenstone.gatherer.util.Utility;

/** A threaded object which processes a queue of file actions such as copying and movement. It also handles updating the various trees involved so they are an accurate representation of the file system they are meant to match.
 * @author John Thompson, Greenstone Digital Library, University of Waikato
 * @version 2.3
 */
public class FileQueue
    extends Thread
{
    /** When someone requests the movement queue to be dumped this cancel flag is set to true. */
    private boolean cancel_action = false;
    /** The button which controls the stopping of the file queue. */
    private JButton stop_button = null;
    /** true if the user has selected yes to all from a file 'clash' dialog. */
    private boolean yes_to_all = false;
    /** A label explaining the current moving files status. */
    private JLabel file_status = null;
    /** A list containing a queue of waiting movement jobs. */
    private ArrayList queue = null;
    /** A progress bar which shows how many bytes, out of the total size of bytes, has been moved. */
    private GProgressBar progress = null;


    /** Constructor.
     */
    public FileQueue() {
    DebugStream.println("FileQueue started.");
    this.queue = new ArrayList();
    file_status = new JLabel();
    Dictionary.setText(file_status, "FileActions.No_Activity");
    progress = new GProgressBar();
    progress.setBackground(Configuration.getColor("coloring.collection_tree_background", false));
    progress.setForeground(Configuration.getColor("coloring.collection_tree_foreground", false));
    progress.setString(Dictionary.get("FileActions.No_Activity"));
    progress.setStringPainted(true);
    }

    /** Requeue an existing job into the queue.
     * @param job A previously created FileJob.
     */
//     synchronized private void addJob(FileJob job, int position) {
//  job.done = true; // Ensure that the requeued job is marked as done.
//  queue.add(position, job);
//  notify();
//     }

    /** Add a new job to the queue, specifiying as many arguments as is necessary to complete this type of job (ie delete needs no target information).
     * @param id A long id unique to all jobs created by a single action.
     * @param source The DragComponent source of this file, most likely a DragTree.
     * @param child The FileNode you wish to mode.
     * @param target The DragComponent to move the file to, again most likely a DragTree.
     * @param parent The files new FileNode parent within the target.
     * @param type The type of this movement as an int, either COPY or DELETE.
     */
    public void addJob(long id, DragComponent source, FileNode[] children, DragComponent target, FileNode parent, byte type, boolean folder_level)
    {
    // Queue the sub-job(s) (this may fail if we are asked to delete a read only file)
    for (int i = 0; i < children.length; i++) {
        addJob(id, source, children[i], target, parent, type, folder_level, -1);
    }
    }
    
    synchronized private void addJob(long id, DragComponent source, FileNode child, DragComponent target, FileNode parent, byte type, boolean folder_level, int position) {
    FileJob job = new FileJob(id, source, child, target, parent, type);
    job.folder_level = folder_level;
    DebugStream.println("Adding job: " + job);
    if(position != -1 && position <= queue.size() + 1) {
        queue.add(position, job);
    }
    else {
        queue.add(job);
    }
    notify();
    }

    /** Calculates the total deep file size of the selected file nodes.
     * @param files a FileNode[] of selected files
     * @return true if a cancel was signalled, false otherwise
     * @see org.greenstone.gatherer.file.FileManager.Task#run()
     */
    public boolean calculateSize(FileNode[] files)
    {
    file_status.setText(Dictionary.get("FileActions.Calculating_Size"));
    progress.setString(Dictionary.get("FileActions.Calculating_Size"));

    // Calculate the total file size of all the selected file nodes
    Vector remaining = new Vector();
    for (int i = 0; !cancel_action && i < files.length; i++) {
        remaining.add(files[i]);
    }
    while (!cancel_action && remaining.size() > 0) {
        FileNode node = (FileNode) remaining.remove(0);
        if (node.isLeaf()) {
        progress.addMaximum(node.getFile().length());
        }
        else {
        for (int i = 0; !cancel_action && i < node.getChildCount(); i++) {
            remaining.add(node.getChildAt(i));
        }
        }
    }

    // Now we return if calculation was cancelled so that the FileManagers Task can skip the addJob phase correctly.
    if (cancel_action) {
        cancel_action = false; // reset
        return true;
    }
    else {
        return false;
    }
    }

    /** This method is called to cancel the job queue at the next available moment. */
    public void cancelAction() {
    cancel_action = true;
    }


//     private int countFolderDepth(File file)
//     {
//  int depth = 0;
//  while (file != null) {
//      depth++;
//      file = file.getParentFile();
//  }
//  return depth;
//     }


    /** Format the given filename path string so that it is no longer than the given width. If it is wider replace starting directories with ...
     * @param key The key <strong>String</Strong> used to retrieve a phrase from the dictionary for this item.
     * @param raw The raw filename path <strong>String</strong>.
     * @param width The maximum width as an <i>int</i>.
     * @return A path <strong>String</strong> no longer than width.
     */
    private String formatPath(String key, String raw, int width)
    {
    JLabel label = new JLabel(Dictionary.get(key, raw));
    int position = -1;
    while(label.getPreferredSize().width > width && (position = raw.indexOf(File.separator)) != -1) {
        raw = "..." + raw.substring(position + 1);
        label.setText(Dictionary.get(key, raw));
    }
    if(raw.indexOf(File.separator) == -1 && raw.startsWith("...")) {
        raw = raw.substring(3);
    }
    return raw;
    }


    /** Access to the file state label. */
    public JLabel getFileStatus() {
    return file_status;
    }

    /** Access to the progress bar. */
    public GProgressBar getProgressBar() {
    return progress;
    }


    synchronized private void addFileJob(long id, DragComponent source, FileNode child, DragComponent target, FileNode parent, byte type)
    {
    queue.add(new FileJob(id, source, child, target, parent, type));
    notify();
    }


    private void doEmptyDirectoryDelete(FileJob file_job)
    {
    FileNode source_node = file_job.getOrigin();
    File source_directory = source_node.getFile();

    // If the directory isn't empty then this will fail
    if (source_directory.delete() == false) {
        // The source directory couldn't be deleted, so give the user the option of continuing or cancelling
        if (showErrorDialog(Dictionary.get("FileActions.Could_Not_Delete", source_directory.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }

    // Remove the node from the model
    SynchronizedTreeModelTools.removeNodeFromParent(file_job.source.getTreeModel(), source_node);
    }


    private void doDirectoryDelete(FileJob file_job)
    {
    FileNode source_node = file_job.getOrigin();
    File source_directory = source_node.getFile();

    // The last thing we will do is delete this directory (which should be empty by then)
    addFileJob(file_job.ID(), file_job.source, source_node, null, null, FileJob.DELETE_EMPTY_DIRECTORY);

    // Add a new Delete job for each child of this directory (except metadata.xml files)
    source_node.refresh();
    for (int i = 0; i < source_node.size(); i++) {
        FileNode child_file_node = (FileNode) source_node.getChildAtUnfiltered(i);
        if (!child_file_node.getFile().getName().equals(StaticStrings.METADATA_XML)) {
        addFileJob(file_job.ID(), file_job.source, child_file_node, null, null, FileJob.DELETE);
        }
    }

    // Treat metadata.xml files specially: delete them first
    for (int i = 0; i < source_node.size(); i++) {
        FileNode child_file_node = (FileNode) source_node.getChildAtUnfiltered(i);
        if (child_file_node.getFile().getName().equals(StaticStrings.METADATA_XML)) {
        addFileJob(file_job.ID(), file_job.source, child_file_node, null, null, FileJob.DELETE);
        break;
        }
    }
    }


    private void doDirectoryCopy(FileJob file_job)
    {
    FileNode source_node = file_job.getOrigin();
    FileNode target_node = file_job.getDestination();

    File source_directory = source_node.getFile();
    File target_directory = new File(target_node.getFile(), source_directory.getName());

    // The target directory shouldn't already exist
    if (target_directory.exists()) {
        if (showErrorDialog(Dictionary.get("FileActions.Folder_Already_Exists", target_directory.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }
    target_directory.mkdirs();

    // Create a node for the new directory in the collection tree
    FileSystemModel target_model = (FileSystemModel) file_job.target.getTreeModel();
    CollectionTreeNode new_target_node = new CollectionTreeNode(target_directory);
    SynchronizedTreeModelTools.insertNodeInto(target_model, target_node, new_target_node);
    new_target_node.setParent(target_node);

    // Copy the non-folder level metadata assigned to the original directory to the new directory
    ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToExternalFile(source_directory);
    MetadataXMLFileManager.addMetadata((CollectionTreeNode) new_target_node, assigned_metadata);

    // Add a new Copy job for each child of this directory (except metadata.xml files)
    source_node.refresh();
    for (int i = 0; i < source_node.size(); i++) {
        FileNode child_file_node = (FileNode) source_node.getChildAtUnfiltered(i);
        if (!child_file_node.getFile().getName().equals(StaticStrings.METADATA_XML)) {
        addFileJob(file_job.ID(), file_job.source, child_file_node, file_job.target, new_target_node, FileJob.COPY);
        }
    }
    }


    private void doDirectoryMove(FileJob file_job)
    {
    FileNode source_node = file_job.getOrigin();
    FileNode target_node = file_job.getDestination();

    File source_directory = source_node.getFile();
    File target_directory = new File(target_node.getFile(), source_directory.getName());

    // Check the target directory isn't the source directory
    if (target_directory.equals(source_directory)) {
        DebugStream.println("Target directory is the source directory!");
        return;
    }

    // The target directory shouldn't already exist
    if (target_directory.exists()) {
        if (showErrorDialog(Dictionary.get("FileActions.Folder_Already_Exists", target_directory.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }
    target_directory.mkdirs();

    // Create a node for the new directory in the collection tree
    FileSystemModel target_model = (FileSystemModel) file_job.target.getTreeModel();
    CollectionTreeNode new_target_node = new CollectionTreeNode(target_directory);
    SynchronizedTreeModelTools.insertNodeInto(target_model, target_node, new_target_node);
    new_target_node.setParent(target_node);

    // Move the folder level metadata assigned to the original directory to the new directory
    ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToFile(source_directory);
    MetadataXMLFileManager.removeMetadata((CollectionTreeNode) source_node, assigned_metadata);
    MetadataXMLFileManager.addMetadata((CollectionTreeNode) new_target_node, assigned_metadata);

    // The last thing we will do is delete this directory
    addFileJob(file_job.ID(), file_job.source, source_node, null, null, FileJob.DELETE);

    // Treat metadata.xml files specially: delete them last
    source_node.refresh();
    for (int i = 0; i < source_node.size(); i++) {
        FileNode child_file_node = (FileNode) source_node.getChildAtUnfiltered(i);
        if (child_file_node.getFile().getName().equals(StaticStrings.METADATA_XML)) {
        addFileJob(file_job.ID(), file_job.source, child_file_node, null, null, FileJob.DELETE);
        break;
        }
    }

    // Add a new Move job for each child of this directory (except metadata.xml files)
    for (int i = 0; i < source_node.size(); i++) {
        FileNode child_file_node = (FileNode) source_node.getChildAtUnfiltered(i);
        if (!child_file_node.getFile().getName().equals(StaticStrings.METADATA_XML)) {
        addFileJob(file_job.ID(), file_job.source, child_file_node, file_job.target, new_target_node, FileJob.MOVE);
        }
    }
    }


    private void doFileDelete(FileJob file_job)
    {
    FileNode source_node = file_job.getOrigin();
    File source_file = source_node.getFile();

    // If we're deleting a metadata.xml file we must unload it
    boolean metadata_xml_file = source_file.getName().equals(StaticStrings.METADATA_XML);
    if (metadata_xml_file) {
        MetadataXMLFileManager.unloadMetadataXMLFile(source_file);
    }
    // Otherwise remove any metadata assigned directly to the file
    else {
        ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToFile(source_file);
        MetadataXMLFileManager.removeMetadata((CollectionTreeNode) source_node, assigned_metadata);
    }

    // Delete the source file
    if (!Utility.delete(source_file)) {
        // The source file couldn't be deleted, so give the user the option of continuing or cancelling
        if (showErrorDialog(Dictionary.get("FileActions.File_Not_Deleted_Message", source_file.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }

    // Remove the node from the model
    SynchronizedTreeModelTools.removeNodeFromParent(file_job.source.getTreeModel(), source_node);
    }


    private void doFileCopy(FileJob file_job)
    {
    FileNode source_node = file_job.getOrigin();
    FileNode target_node = file_job.getDestination();

    File source_file = source_node.getFile();
    File target_file = new File(target_node.getFile(), source_file.getName());

    // The target file shouldn't already exist
    if (target_file.exists()) {
        int result = showOverwriteDialog(target_file.getName());
        if (result == JOptionPane.NO_OPTION) {
        // Don't overwrite
        return;
        }
        if (result == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        return;
        }
    }

    // Copy the file
    try {
        copyFile(source_file, target_file, true);
    }
    catch (FileAlreadyExistsException exception) {
        // This should not ever happen, since we've called copyFile with overwrite set
        DebugStream.printStackTrace(exception);
        return;
    }
    catch (FileNotFoundException exception) {
        DebugStream.printStackTrace(exception);
        if (showErrorDialog(Dictionary.get("FileActions.File_Not_Found_Message", source_file.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        // Refresh the source tree model
        FileSystemModel source_model = file_job.source.getTreeModel();
        source_model.refresh(new TreePath(((FileNode) file_job.getOrigin().getParent()).getPath()));
        return;
    }
    catch (InsufficientSpaceException exception) {
        DebugStream.printStackTrace(exception);
        if (showErrorDialog(Dictionary.get("FileActions.Insufficient_Space_Message", exception.getMessage())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }
    catch (IOException exception) {
        DebugStream.printStackTrace(exception);
        if (showErrorDialog(exception.getMessage()) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }
    catch (ReadNotPermittedException exception) {
        DebugStream.printStackTrace(exception);
        if (showErrorDialog(Dictionary.get("FileActions.Read_Not_Permitted_Message", source_file.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }
    catch (UnknownFileErrorException exception) {
        DebugStream.printStackTrace(exception);
        if (showErrorDialog(Dictionary.get("FileActions.Unknown_File_Error_Message")) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }
    catch (WriteNotPermittedException exception) {
        DebugStream.printStackTrace(exception);
        if (showErrorDialog(Dictionary.get("FileActions.Write_Not_Permitted_Message", target_file.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }

    CollectionTreeNode new_target_node = new CollectionTreeNode(target_file);
    FileSystemModel target_model = file_job.target.getTreeModel();
    SynchronizedTreeModelTools.insertNodeInto(target_model, target_node, new_target_node);
    Gatherer.c_man.fireFileAddedToCollection(target_file);

    // Copy the non-folder level metadata assigned to the original file to the new file
    ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToExternalFile(source_file);
    MetadataXMLFileManager.addMetadata((CollectionTreeNode) new_target_node, assigned_metadata);
    }


    private void doFileMove(FileJob file_job)
    {
    FileNode source_node = file_job.getOrigin();
    FileNode target_node = file_job.getDestination();

    File source_file = source_node.getFile();
    File target_file = new File(target_node.getFile(), source_file.getName());

    // Check the target file isn't the source file
    if (target_file.equals(source_file)) {
        DebugStream.println("Target file is the source file!");
        return;
    }

    // The target file shouldn't already exist
    if (target_file.exists()) {
        int result = showOverwriteDialog(target_file.getName());
        if (result == JOptionPane.NO_OPTION) {
        // Don't overwrite
        return;
        }
        if (result == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        return;
        }
    }

    // Move the file by renaming it
    if (!source_file.renameTo(target_file)) {
        String args[] = { source_file.getName(), target_file.getAbsolutePath() };
        if (showErrorDialog(Dictionary.get("FileActions.File_Move_Error_Message", args)) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        return;
    }

    // Remove the node from the source model and add it to the target model
    SynchronizedTreeModelTools.removeNodeFromParent(file_job.source.getTreeModel(), source_node);
    CollectionTreeNode new_target_node = new CollectionTreeNode(target_file);
    FileSystemModel target_model = file_job.target.getTreeModel();
    SynchronizedTreeModelTools.insertNodeInto(target_model, target_node, new_target_node);

    // Move the non-folder level metadata assigned to the original file to the new file
    ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToFile(source_file);
    MetadataXMLFileManager.removeMetadata((CollectionTreeNode) source_node, assigned_metadata);
    MetadataXMLFileManager.addMetadata((CollectionTreeNode) new_target_node, assigned_metadata);
    }


    private void processFileJob(FileJob file_job)
    {
    DebugStream.println("Processing file job " + file_job + "...");

    // Ensure that the source file exists
    File source_file = file_job.getOrigin().getFile();
    if (!source_file.exists()) {
        // The source file doesn't exist, so give the user the option of continuing or cancelling
        if (showErrorDialog(Dictionary.get("FileActions.File_Not_Found_Message", source_file.getAbsolutePath())) == JOptionPane.CANCEL_OPTION) {
        clearJobs();  // Aborting action
        }
        // Refresh the source tree model
        FileSystemModel source_model = file_job.source.getTreeModel();
        source_model.refresh(new TreePath(((FileNode) file_job.getOrigin().getParent()).getPath()));
        return;
    }

    // Enable the "Stop" button
    stop_button.setEnabled(true);

    // Delete empty directory job
    if (file_job.type == FileJob.DELETE_EMPTY_DIRECTORY) {
        file_status.setText(Dictionary.get("FileActions.Deleting", formatPath("FileActions.Deleting", source_file.getAbsolutePath(), file_status.getSize().width)));
        doEmptyDirectoryDelete(file_job);
    }

    // Delete job
    if (file_job.type == FileJob.DELETE) {
        file_status.setText(Dictionary.get("FileActions.Deleting", formatPath("FileActions.Deleting", source_file.getAbsolutePath(), file_status.getSize().width)));
        if (source_file.isFile()) {
        long source_file_size = source_file.length();
        doFileDelete(file_job);
        progress.addValue(source_file_size);  // Update progress bar
        }
        else {
        doDirectoryDelete(file_job);
        }
    }

    // Copy job
    if (file_job.type == FileJob.COPY) {
        file_status.setText(Dictionary.get("FileActions.Copying", formatPath("FileActions.Copying", source_file.getAbsolutePath(), file_status.getSize().width)));
        if (source_file.isFile()) {
        long source_file_size = source_file.length();
        doFileCopy(file_job);
        progress.addValue(source_file_size);  // Update progress bar
        }
        else {
        doDirectoryCopy(file_job);
        }
    }

    // Move job
    if (file_job.type == FileJob.MOVE) {
        file_status.setText(Dictionary.get("FileActions.Moving", formatPath("FileActions.Moving", source_file.getAbsolutePath(), file_status.getSize().width)));
        if (source_file.isFile()) {
        long source_file_size = source_file.length();
        doFileMove(file_job);
        progress.addValue(source_file_size);  // Update progress bar
        }
        else {
        doDirectoryMove(file_job);
        }
    }
    }


    private int showErrorDialog(String error_message)
    {
    Object[] options = { Dictionary.get("General.OK"), Dictionary.get("General.Cancel") };
    int result = JOptionPane.showOptionDialog(Gatherer.g_man, error_message, Dictionary.get("General.Error"), JOptionPane.DEFAULT_OPTION, JOptionPane.ERROR_MESSAGE, null, options, options[0]);
    if (result == 0) {
        return JOptionPane.OK_OPTION;
    }
    else {
        return JOptionPane.CANCEL_OPTION;
    }
    }


    private int showOverwriteDialog(String target_file_name)
    {
    // Has "yes to all" been set?
    if (yes_to_all) {
        return JOptionPane.YES_OPTION;
    }

    Object[] options = { Dictionary.get("General.Yes"), Dictionary.get("FileActions.Yes_To_All"), Dictionary.get("General.No"), Dictionary.get("General.Cancel") };
    int result = JOptionPane.showOptionDialog(Gatherer.g_man, Dictionary.get("FileActions.File_Exists", target_file_name), Dictionary.get("General.Warning"), JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE, null, options, options[0]);
    if (result == 0) {
        return JOptionPane.YES_OPTION;
    }
    else if (result == 1) {
        yes_to_all = true;
        return JOptionPane.YES_OPTION;
    }
    else if (result == 2) {
        return JOptionPane.NO_OPTION;
    }
    else {
        return JOptionPane.CANCEL_OPTION;
    }
    }


    public void run()
    {
    super.setName("FileQueue");

    while (!Gatherer.exit) {
        // Retrieve the next job
        int position = queue.size() - 1;
        if (position >= 0) {
        // We have a file job, so process it
        processFileJob((FileJob) queue.remove(position));
        }
        else {
        // No jobs, so reset and wait until we are notified of one
        synchronized(this) {
            // Force both workspace and collection trees to refresh
            if (Gatherer.g_man != null) {
            Gatherer.g_man.refreshWorkspaceTree(DragTree.COLLECTION_CONTENTS_CHANGED);
            // Gatherer.g_man.refreshCollectionTree(DragTree.COLLECTION_CONTENTS_CHANGED);
            }

            // Reset status area
            file_status.setText(Dictionary.get("FileActions.No_Activity"));
            progress.reset();
            progress.setString(Dictionary.get("FileActions.No_Activity"));

            // Reset "yes to all"
            yes_to_all = false;

            // Wait for a new file job
            try {
            wait();
            }
            catch (InterruptedException exception) {}
        }
        }
    }
    }


    /** The run method exists in every thread, and here it is used to work its way through the queue of Jobs. If no jobs are waiting and it cans, it waits until a job arrives. If a job is present then it is either COPIED or DELETED, with the records being copied or removed as necessary, and directories being recursed through. Finally the user can press cancel to cause the loop to prematurely dump the job queue then wait.
     * @see org.greenstone.gatherer.Gatherer
     * @see org.greenstone.gatherer.collection.CollectionManager
     * @see org.greenstone.gatherer.file.FileJob
     * @see org.greenstone.gatherer.file.FileNode
     * @see org.greenstone.gatherer.gui.GProgressBar
     * @see org.greenstone.gatherer.util.Utility
     */
//     public void run()
//     {
//  super.setName("FileQueue");

//  while (!Gatherer.exit) {
//      try {
//      // Retrieve the next job
//      int position = queue.size() - 1;
//      FileJob job = null;
//      if (position >= 0) {
//          job = (FileJob) queue.remove(position);
//      }

//      if (job != null) {
//          ///ystem.err.println("Found job: " + job);
//          // Enabled stop button
//          stop_button.setEnabled(true);
//          // The user can cancel this individual action at several places, so keep track if the state is 'ready' for the next step.
//          boolean ready = true;
//          FileNode origin_node = job.getOrigin();
//          FileNode destination_node = job.getDestination();
//          FileSystemModel source_model = (FileSystemModel)job.source.getTreeModel();
//          FileSystemModel target_model = (FileSystemModel)job.target.getTreeModel();
//          if(destination_node == null) {
//          // Retrieve the root node of the target model instead. A delete, or course, has no target file so all deleted files are added to the root of the Recycle Bin model.
//          destination_node = (FileNode) target_model.getRoot();
//          }

//          // Extract common job details.
//          File source_file = origin_node.getFile();
//          File target_file = null;
//          // Determine the target file for a copy or move.
//          if (job.type == FileJob.COPY || job.type == FileJob.MOVE) {
//          // use the name of the filenode instead of the name of the file - these should be the same except for the collection directories where we want the collection name to be used, not 'import' which is the underlying name
//          target_file = new File(destination_node.getFile(), origin_node.toString());
//          }
//          // To copy a file, copy it then add any metadata found at the source. If this file was already in our collection then we must ensure the lastest version of its metadata.xml has been saved to disk. To copy a directory simply create the directory at the destination, then add all of its children files as new jobs.
//          if((job.type == FileJob.COPY || job.type == FileJob.MOVE) && !job.done) {
//          ///ystem.err.println("Copy/Move: " + origin_node);

//          // The number one thing to check is whether we are in a cyclic loop. The easiest way is just to check how deep we are
//          int max_folder_depth = Configuration.getInt("general.max_folder_depth", Configuration.COLLECTION_SPECIFIC);
//          boolean continue_over_depth = false;
//          if (countFolderDepth(source_file) > max_folder_depth) {
//              Object[] options = { Dictionary.get("General.Yes"), Dictionary.get("General.No"), Dictionary.get("FileActions.Increase_Depth") };
//              String args[] = { String.valueOf(max_folder_depth), source_file.getAbsolutePath() };
//              int result = JOptionPane.showOptionDialog(Gatherer.g_man, Utility.formatHTMLWidth(Dictionary.get("FileActions.Possible_Cyclic_Path", args), 80), Dictionary.get("General.Warning"), JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE, null, options, options[1]);
//              args = null;
//              options = null;
//              switch(result) {
//              case 0: // Yes
//              continue_over_depth = true;
//              break;
//              case 2: // Continue and increase depth
//              continue_over_depth = true;
//              Configuration.setInt("general.max_folder_depth", Configuration.COLLECTION_SPECIFIC, (max_folder_depth + 1));
//              break;
//              }
//          }
//          else {
//              continue_over_depth = true;
//          }
               
//          if(continue_over_depth) {
//              FileNode new_node = null;
//              // Check if file exists, and action as necessary. Be aware the user can choose to cancel the action all together (where upon ready becomes false).
//              if(target_file.exists()) {
//              // We've previously been told
//              if(yes_to_all) {
//                  // Remove the old file and tree entry.
//                  target_file.delete();
//                  ready = true;
//              }
//              else {
//                  ///atherer.println("Opps! This filename already exists. Give the user some options.");
//                  Object[] options = { Dictionary.get("General.Yes"), Dictionary.get("FileActions.Yes_To_All"), Dictionary.get("General.No"), Dictionary.get("General.Cancel") };
//                  int result = JOptionPane.showOptionDialog(Gatherer.g_man, Dictionary.get("FileActions.File_Exists", target_file.getName()), Dictionary.get("General.Warning"), JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE, null, options, options[0]);
//                  switch(result) {
//                  case 1: // Yes To All
//                  yes_to_all = true;
//                  case 0: // Yes
//                  // Remove the old file and tree entry.
//                  if(destination_node != null) {
//                      TreePath destination_path = new TreePath(destination_node.getPath());
//                      CollectionTreeNode temp_target_node = new CollectionTreeNode(target_file);  // !!! , target_model, true);
//                      TreePath target_path = destination_path.pathByAddingChild(temp_target_node);
//                      SynchronizedTreeModelTools.removeNodeFromParent(target_model, target_model.getNode(target_path));
//                      target_path = null;
//                      temp_target_node = null;
//                      destination_path = null;
//                  }
//                  target_file.delete();
//                  ready = true;
//                  break;
//                  case 3: // No To All
//                  cancel_action = true;
//                  case 2: // No
//                  default:
//                  ready = false;
//                  // Increment progress by size of potentially copied file
//                  progress.addValue(origin_node.getFile().length());
//                  }
//              }
//              }
//              // We proceed with the copy/move if the ready flag is still set. If it is that means there is no longer any existing file of the same name.
//              if(ready) {
//              // update status area
//              String args[] = new String[1];
//              args[0] = "" + (queue.size() + 1) + "";
//              if(job.type == FileJob.COPY) {
//                  args[0] = formatPath("FileActions.Copying", source_file.getAbsolutePath(), file_status.getSize().width);
//                  file_status.setText(Dictionary.get("FileActions.Copying", args));
//              }
//              else {
//                  args[0] = formatPath("FileActions.Moving", source_file.getAbsolutePath(), file_status.getSize().width);
//                  file_status.setText(Dictionary.get("FileActions.Moving", args));
//              }
//              args = null;
                
//              // If source is a file
//              if(source_file.isFile()) {
//                  // copy the file. If anything goes wrong the copy file should throw the appropriate exception. No matter what exception is thrown (bar an IOException) we display some message, perhaps take some action, then cancel the remainder of the pending file jobs. No point in being told your out of hard drive space for each one of six thousand files eh?
//                  try {
//                  copyFile(source_file, target_file, false);
//                  progress.addValue(source_file.length());
//                  }
//                  // If we can't find the source file, then the most likely reason is that the file system has changed since the last time it was mapped. Warn the user that the requested file can't be found, then force a refresh of the source folder involved.
//                  catch(FileNotFoundException fnf_exception) {
//                  DebugStream.printStackTrace(fnf_exception);
//                  cancel_action = true;
//                  // Show warning.
//                  JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.File_Not_Found_Message", source_file.getName()), Dictionary.get("FileActions.File_Not_Found_Title"), JOptionPane.ERROR_MESSAGE);
//                  // Force refresh of source folder.
//                  source_model.refresh(new TreePath(((FileNode)origin_node.getParent()).getPath()));
//                  }
//                  catch(FileAlreadyExistsException fae_exception) {
//                  DebugStream.printStackTrace(fae_exception);
//                  cancel_action = true;
//                  // Show warning.
//                  JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.File_Already_Exists_Message", target_file.getName()), Dictionary.get("FileActions.File_Already_Exists_Title"), JOptionPane.ERROR_MESSAGE);
//                  // Nothing else can be done by the Gatherer.
//                  }
//                  catch(InsufficientSpaceException is_exception) {
//                  DebugStream.printStackTrace(is_exception);
//                  cancel_action = true;
//                  // Show warning. The message body of the expection explains how much more space is required for this file copy.
//                  JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.Insufficient_Space_Message", is_exception.getMessage()), Dictionary.get("FileActions.Insufficient_Space_Title"), JOptionPane.ERROR_MESSAGE);
//                  // Nothing else can be done by the Gatherer. In fact if we are really out of space I'm not even sure we can quit safely.
//                  }
//                  catch (ReadNotPermittedException rnp_exception) {
//                  if (DebugStream.isDebuggingEnabled()) {
//                      DebugStream.printStackTrace(rnp_exception);
//                  }
//                  cancel_action = true;
//                  // Show warning
//                  JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.Read_Not_Permitted_Message", source_file.getAbsolutePath()), Dictionary.get("FileActions.Write_Not_Permitted_Title"), JOptionPane.ERROR_MESSAGE);
//                  // Nothing else we can do.
//                  }
//                  catch(UnknownFileErrorException ufe_exception) {
//                  DebugStream.printStackTrace(ufe_exception);
//                  cancel_action = true;
//                  // Show warning
//                  JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.Unknown_File_Error_Message"), Dictionary.get("FileActions.Unknown_File_Error_Title"), JOptionPane.ERROR_MESSAGE);
//                  // Nothing else we can do.
//                  }
//                  catch(WriteNotPermittedException wnp_exception) {
//                  if (DebugStream.isDebuggingEnabled()) {
//                      DebugStream.printStackTrace(wnp_exception);
//                  }
//                  cancel_action = true;
//                  // Show warning
//                  JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.Write_Not_Permitted_Message", target_file.getAbsolutePath()), Dictionary.get("FileActions.Write_Not_Permitted_Title"), JOptionPane.ERROR_MESSAGE);
//                  // Nothing else we can do.
//                  }
//                  catch(IOException exception) {
//                  // Can't really do much about this.
//                  DebugStream.printStackTrace(exception);
//                  }
//                  // If not cancelled
//                  if (!cancel_action) {
//                  // Create a dummy FileNode with the correct structure (so getPath works)
//                  new_node = new CollectionTreeNode(target_file);
//                  SynchronizedTreeModelTools.insertNodeInto(target_model, destination_node, new_node);
//                  }
//              }
//              // Else
//              else if(source_file.isDirectory()) {
//                  // create new record
//                  CollectionTreeNode directory_record = new CollectionTreeNode(target_file);
//                  SynchronizedTreeModelTools.insertNodeInto(target_model, destination_node, directory_record);
//                  // Why is this not happening eh?
//                  directory_record.setParent(destination_node);
//                  if(!target_file.exists()) {
//                  // make the directory
//                  target_file.mkdirs();
//                  new_node = directory_record;
//                  }

//                  // Queue non-filtered child files for copying. If this directory already existed, the child records will have to generate the undo jobs, as we don't want to entirely delete this directory if it already existed.
//                  FileNode child_record = null;
//                  // In order to have a sane copy proceedure (rather than always copying last file first as it used to) we always add the child node at the position the parent was removed from. Consider the file job 'a' at the end of the queue which generates three new jobs 'b', 'c' and 'd'. The resulting flow should look like this.
//                  // -- Starting queue                   ...[a]
//                  // remove(position) = 'a'              ...
//                  // add(position, 'b')                  ...[b]
//                  // add(position, 'c')                  ...[c][b]
//                  // add(position, 'd')                  ...[d][c][b]
//                  // Next loop
//                  // remove(position) = 'b'              ...[d][c]
//                  //for(int i = 0; i < origin_node.getChildCount(); i++) {
//                  for (int i=origin_node.getChildCount()-1; i>=0; i--) {
//                  child_record = (FileNode) origin_node.getChildAt(i);
//                  addJob(job.ID(), job.source, child_record, job.target, directory_record, job.type, false, position);
//                  }
//                  child_record = null;
//                  directory_record = null;
//              }
//              // The file wasn't found!
//              else {
//                  cancel_action = true;
//                  // Show warning.
//                  JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.File_Not_Found_Message", source_file.getName()), Dictionary.get("FileActions.File_Not_Found_Title"), JOptionPane.ERROR_MESSAGE);
//                  // Force refresh of source folder.
//                  source_model.refresh(new TreePath(((FileNode)origin_node.getParent()).getPath()));
//              }

//              // If we haven't been cancelled and we created a new FileNode during the above phase, now is the time to deal with metadata
//              if (!cancel_action && new_node != null) {
//                  // If the file came from inside our collection...
//                  if (job.source.toString().equals("Collection")) {
//                  // Get the non-folder level metadata assigned to the origin node...
//                  ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToFile(source_file);
//                  // ...and remove it from the original node and assign it to the new folder
//                  MetadataXMLFileManager.removeMetadata((CollectionTreeNode) origin_node, assigned_metadata);
//                  MetadataXMLFileManager.addMetadata((CollectionTreeNode) new_node, assigned_metadata);
//                  }
//                  // If it came from the workspace search for metadata assigned to the file
//                  else if (job.source.toString().equals("Workspace")) {
//                  ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToExternalFile(origin_node.getFile());
//                  MetadataXMLFileManager.addMetadata((CollectionTreeNode) new_node, assigned_metadata);
//                  }

//                  if (job.type == FileJob.COPY && new_node.getFile().isFile()) {
//                  Gatherer.c_man.fireFileAddedToCollection(new_node.getFile());
//                  }
//              }
//              new_node = null;
//              }
//          }
//          }
//          // If we haven't been cancelled, and we've been asked to delete a directory/file, or perhaps as part of a move, we delete the file. This involves removing any existing metadata and then copying the file to the recycled bin (for a delete only), then deleting the file. When deleting a directory record from the tree (or from the filesystem for that matter) we must ensure that all of the descendant records have already been removed. If we fail to do this the delete will fail, or you will be bombarded with hundreds of 'Parent node of null not allowed' error messages. Also be aware that if the user has cancelled just this action, because of say a name clash, then we shouldn't do any deleting of any sort dammit.
//          if(!cancel_action && ready && (job.type == FileJob.DELETE || job.type == FileJob.MOVE)) {
//          // Update the progress bar for this job
//          if (source_file.isFile()) {
//              progress.addValue(source_file.length());
//          }

//          // If the source is a file or an empty directory (but not the root node of a tree)
//          File[] child_list = source_file.listFiles();
//          if (source_file.isFile() || (child_list != null && child_list.length == 0 && origin_node.getParent() != null)) {
//              // Update status area
//              String args[] = new String[1];
//              args[0] = formatPath("FileActions.Deleting", source_file.getAbsolutePath(), file_status.getSize().width);
//              file_status.setText(Dictionary.get("FileActions.Deleting", args));

//              // If it is a metadata.xml file, we must unload it
//              if (source_file.getName().equals(StaticStrings.METADATA_XML)) {
//              MetadataXMLFileManager.unloadMetadataXMLFile(source_file);
//              }

//              // Remove the metadata assigned directly to the file
//              ArrayList assigned_metadata = MetadataXMLFileManager.getMetadataAssignedDirectlyToFile(origin_node.getFile());
//              MetadataXMLFileManager.removeMetadata((CollectionTreeNode) origin_node, assigned_metadata);

//              // Remove from model
//              FileNode parent_record = (FileNode) origin_node.getParent();
//              if (parent_record != null) {
//              SynchronizedTreeModelTools.removeNodeFromParent(source_model, origin_node);
//              }

//              // Delete the source file
//              if (!Utility.delete(source_file)) {
//              // Show message that we couldn't delete
//              JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("FileActions.File_Not_Deleted_Message", source_file.getName()), Dictionary.get("FileActions.File_Not_Deleted_Title"), JOptionPane.ERROR_MESSAGE);
//              }
//          }
//          // Else the source is a directory and it has children remaining
//          else if(child_list != null && child_list.length > 0) {
//              // Don't worry about all this for true file move actions.
//              if(job.type == FileJob.DELETE) {
//              // queue all of its children, (both filtered and non-filtered), but for deleting only. Don't queue jobs for a current move event, as they would be queued as part of copying. I have no idea way, per sec, however the children within the origin node are always invalid during deletion (there are several copies of some nodes?!?). I'll check that each child is only added once.
//              origin_node.refresh();
//              for(int i = 0; i < origin_node.size(); i++) {
//                  FileNode child_record = (FileNode) origin_node.getChildAtUnfiltered(i);
//                  ///atherer.println("Queuing: " + child_record);
//                  addJob(job.ID(), job.source, child_record, job.target, destination_node, FileJob.DELETE, false, position);
//              }  
//              }
//              // Requeue a delete job -after- the children have been dealt with. Remember I've reversed the direction of the queue so sooner is later. Te-he. Also have to remember that we have have followed this path to get here for a move job: Copy Directory -> Queue Child Files -> Delete Directory (must occur after child files) -> Queue Directory.
//              // One special case. Do not requeue root nodes. Don't requeue jobs marked as done.
//              if(origin_node.getParent() != null && !job.done) {
//              ///atherer.println("Requeuing: " + origin_node.getFile().getAbsolutePath());
//              job.type = FileJob.DELETE; // You only requeue jobs that are deletes, as directories must be inspected before children, but deleted after.
//              addJob(job, position);
//              }
//              else {
//              DebugStream.println("I've already done this job twice. I refuse to requeue it again!");
//              }
//          }
//          }
//          job = null;
//          source_file = null;
//          target_file = null;
//          origin_node = null;

//          // We only break out of the while loop if we are out of files or the action was cancelled
//          if (cancel_action) {
//          // Empty queue
//          clearJobs();
//          cancel_action = false;
//          }
//      }
//      else { // job == null
//          // Disable stop button
//          if (stop_button != null) {
//          stop_button.setEnabled(false);
//          }
//          synchronized(this) {
//          // Force both workspace and collection trees to refresh
//          if (Gatherer.g_man != null) {
//              Gatherer.g_man.refreshWorkspaceTree(DragTree.COLLECTION_CONTENTS_CHANGED);
//              Gatherer.g_man.refreshCollectionTree(DragTree.COLLECTION_CONTENTS_CHANGED);
//          }

//          // Reset status area
//          file_status.setText(Dictionary.get("FileActions.No_Activity"));
//          progress.reset();
//          progress.setString(Dictionary.get("FileActions.No_Activity"));
//          yes_to_all = false;
//          try {
//              wait();
//          }
//          catch (InterruptedException exception) {}
//          }
//      }
//      }
//      catch (Exception error) {
//      DebugStream.printStackTrace(error);
//      }
//  }
//     }


    /** Register the button that will be responsible for stopping executing file actions. 
     * @param stop_button a JButton
     */
    public void registerStopButton(JButton stop_button) {
    this.stop_button = stop_button;
    }


    synchronized private void clearJobs() {
    queue.clear();
    }
    
    /** Copy the contents from the source directory to the destination 
     * directory.
     * @param source The source directory
     * @param destination The destination directory
     * @see org.greenstone.gatherer.Gatherer
     */
    public void copyDirectoryContents(File source, File destination) 
    throws FileAlreadyExistsException, FileNotFoundException, InsufficientSpaceException, IOException, ReadNotPermittedException, UnknownFileErrorException, WriteNotPermittedException
    {
    if (!source.isDirectory()) return;
    // check that dest dirs exist
    destination.mkdirs();
    
    File [] src_files = source.listFiles();
    if (src_files.length == 0) return; // nothing to copy
    for (int i=0; i<src_files.length; i++) {
        File f = src_files[i];
        String f_name = f.getName();
        File new_file = new File(destination, f_name);
        if (f.isDirectory()) {
        copyDirectoryContents(f, new_file);
        } else if (f.isFile()) {
        copyFile(f, new_file, false);
        }
    }
    }

    
    /** Copy a file from the source location to the destination location.
     * @param source The source File.
     * @param destination The destination File.
     * @see org.greenstone.gatherer.Gatherer
     */
    public void copyFile(File source, File destination, boolean overwrite)
    throws FileAlreadyExistsException, FileNotFoundException, InsufficientSpaceException, IOException, ReadNotPermittedException, UnknownFileErrorException, WriteNotPermittedException
    {
    if (source.isDirectory()) {
        destination.mkdirs();
        return;
    }

    // Check if the origin file exists.
    if (!source.exists()) {
        DebugStream.println("Couldn't find the source file.");
        throw new FileNotFoundException();
    }

    // Make sure the destination file does not exist.
    if (destination.exists() && !overwrite) {
        throw new FileAlreadyExistsException();
    }

    // Open an input stream to the source file
    FileInputStream f_in = null;
    try {
        f_in = new FileInputStream(source);
    }
    catch (FileNotFoundException exception) {
        // A FileNotFoundException translates into a ReadNotPermittedException in this case
        throw new ReadNotPermittedException(exception.toString());      
    }

    // Create an necessary directories for the target file
    File dirs = destination.getParentFile();
    dirs.mkdirs();

    // Open an output stream to the target file
    FileOutputStream f_out = null;
    try {
        f_out = new FileOutputStream(destination);
    }
    catch (FileNotFoundException exception) {
        // A FileNotFoundException translates into a WriteNotPermittedException in this case
        throw new WriteNotPermittedException(exception.toString());
    }

    // Copy the file
    byte data[] = new byte[Utility.BUFFER_SIZE];
    int data_size = 0;
    while ((data_size = f_in.read(data, 0, Utility.BUFFER_SIZE)) != -1 && !cancel_action) {
        long destination_size = destination.length();
        try {
        f_out.write(data, 0, data_size);
        }
        // If an IO exception occurs, we can do some maths to determine if the number of bytes written to the file was less than expected. If so we assume a InsufficientSpace exception. If not we just throw the exception again.
        catch (IOException io_exception) {
        if (destination_size + (long) data_size > destination.length()) {
            // Determine the difference (which I guess is in bytes).
            long difference = (destination_size + (long) data_size) - destination.length();
            // Transform that into a human readable string.
            String message = Utility.formatFileLength(difference);
            throw new InsufficientSpaceException(message);
        }
        else {
            throw(io_exception);
        }
        }
    }

    // Flush and close the streams to ensure all bytes are written.
    f_in.close();
    f_out.close();

    // We have now, in theory, produced an exact copy of the source file. Check this by comparing sizes.
    if(!destination.exists() || (!cancel_action && source.length() != destination.length())) {
        throw new UnknownFileErrorException();
    }

    // If we were cancelled, ensure that none of the destination file exists.
    if (cancel_action) {
        destination.delete();
    }
    }
}