/*
* This file is part of muCommander, http://www.mucommander.com
* Copyright (C) 2002-2012 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.ui.main.toolbar;
import com.mucommander.MuLogging;
import com.mucommander.PlatformManager;
import com.mucommander.commons.file.AbstractFile;
import com.mucommander.commons.file.FileFactory;
import com.mucommander.ui.notifier.SystemTrayNotifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.helpers.DefaultHandler;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
/**
*
* @author Arik Hadas
*/
public abstract class ToolBarIO extends DefaultHandler {
private static final Logger LOGGER = LoggerFactory.getLogger(ToolBarIO.class);
/* Variables used for XML parsing */
/** Root element */
protected static final String ROOT_ELEMENT = "toolbar";
/** Attribute containing the last muCommander version that was used to create the file */
protected static final String VERSION_ATTRIBUTE = "version";
/** Element describing one of the button in the list */
protected static final String BUTTON_ELEMENT = "button";
/** Attribute containing the action class associated with the button */
protected static final String ACTION_ATTRIBUTE = "action";
/** Attribute containing the action id associated with the button */
protected static final String ACTION_ID_ATTRIBUTE = "action_id";
/** Element describing one of the separator in the list */
protected static final String SEPARATOR_ELEMENT = "separator";
/** Default toolbar descriptor filename */
protected final static String DEFAULT_TOOLBAR_FILE_NAME = "toolbar.xml";
/** Toolbar descriptor file used when calling {@link #loadDescriptionFile()} */
private static AbstractFile descriptionFile;
/** ToolBarWriter instance */
private static ToolBarWriter toolBarWriter;
/** Whether the command-bar has been modified and should be saved */
protected static boolean wasToolBarModified;
/**
* Parses the XML file describing the toolbar's buttons and associated actions.
* If the file doesn't exist, default toolbar elements will be used.
*/
public static void loadDescriptionFile() throws Exception {
AbstractFile descriptionFile = getDescriptionFile();
if (descriptionFile != null && descriptionFile.exists()) {
ToolBarReader reader = new ToolBarReader(descriptionFile);
ToolBarAttributes.setActions(reader.getActionsRead());
}
else
LOGGER.debug("User toolbar.xml was not found, using default toolbar");
toolBarWriter = ToolBarWriter.create();
}
/**
* Writes the current tool bar to the user's tool bar file.
* @throws IOException
* @throws IOException
*/
public static void saveToolBar() throws IOException {
if (ToolBarAttributes.areDefaultAttributes()) {
AbstractFile toolBarFile = getDescriptionFile();
if (toolBarFile != null && toolBarFile.exists()) {
LOGGER.info("Toolbar use default settings, removing descriptor file");
toolBarFile.delete();
}
else
LOGGER.debug("Toolbar not modified, not saving");
}
else if (toolBarWriter != null) {
if (wasToolBarModified)
toolBarWriter.write();
else
LOGGER.debug("Toolbar not modified, not saving");
}
else
LOGGER.warn("Could not save toolbar. writer is null");
}
/**
* Mark that actions were modified and therefore should be saved.
*/
public static void setModified() { wasToolBarModified = true; }
/**
* Sets the path to the toolbar description file to be loaded when calling {@link #loadDescriptionFile()}.
* By default, this file is {@link #DEFAULT_TOOLBAR_FILE_NAME} within the preferences folder.
* @param file path to the toolbar descriptor file
*/
public static void setDescriptionFile(AbstractFile file) throws FileNotFoundException {
if(file.isBrowsable())
throw new FileNotFoundException("Not a valid file: " + file);
descriptionFile = file;
}
public static AbstractFile getDescriptionFile() throws IOException {
if(descriptionFile == null)
return PlatformManager.getPreferencesFolder().getChild(DEFAULT_TOOLBAR_FILE_NAME);
return descriptionFile;
}
/**
* Sets the path to the toolbar description file to be loaded when calling {@link #loadDescriptionFile()}.
* By default, this file is {@link #DEFAULT_TOOLBAR_FILE_NAME} within the preferences folder.
* @param path path to the toolbar descriptor file
*/
public static void setDescriptionFile(String path) throws FileNotFoundException {
AbstractFile file;
if((file = FileFactory.getFile(path)) == null)
setDescriptionFile(new File(path));
else
setDescriptionFile(file);
}
/**
* Sets the path to the toolbar description file to be loaded when calling {@link #loadDescriptionFile()}.
* By default, this file is {@link #DEFAULT_TOOLBAR_FILE_NAME} within the preferences folder.
* @param file path to the toolbar descriptor file
*/
public static void setDescriptionFile(File file) throws FileNotFoundException {setDescriptionFile(FileFactory.getFile(file.getAbsolutePath()));}
}