Mod.java

package modmanager.business;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamImplicit;
import com.thoughtworks.xstream.annotations.XStreamOmitField;

import modmanager.gui.views.DetailsView;

import javax.swing.Icon;
import javax.swing.ImageIcon;

import java.awt.Image;

import java.util.ArrayList;
import java.util.Iterator;
import modmanager.business.modactions.Action;
import modmanager.business.modactions.ActionApplyAfter;
import modmanager.business.modactions.ActionApplyBefore;
import modmanager.business.modactions.ActionCopyFile;
import modmanager.business.modactions.ActionEditFile;
import modmanager.business.modactions.ActionEditFileDelete;
import modmanager.business.modactions.ActionEditFileFind;
import modmanager.business.modactions.ActionEditFileFindUp;
import modmanager.business.modactions.ActionEditFileInsert;
import modmanager.business.modactions.ActionEditFileReplace;
import modmanager.business.modactions.ActionIncompatibility;
import modmanager.business.modactions.ActionRequirement;

/**
 * @author Shirkit
 *
 */
@XStreamAlias("modification")
public class Mod {

    // Constants
    public static final String MOD_FILENAME = "mod.xml";
    public static final String ICON_FILENAME = "icon.png";
    public static final String CHANGELOG_FILENAME = "changelog.txt";
    public static final int ICON_WIDTH = 48;
    public static final int ICON_HEIGHT = 48;
    // Attributes with Alias
    @XStreamAlias("name")
    @XStreamAsAttribute
    private String name;
    @XStreamAlias("version")
    @XStreamAsAttribute
    private String version;
    @XStreamAlias("date")
    @XStreamAsAttribute
    private String date;
    @XStreamAlias("author")
    @XStreamAsAttribute
    private String author;
    @XStreamAlias("description")
    @XStreamAsAttribute
    private String description;
    @XStreamAlias("application")
    @XStreamAsAttribute
    private String application;
    @XStreamAlias("appversion")
    @XStreamAsAttribute
    private String appversion;
    @XStreamAlias("mmversion")
    @XStreamAsAttribute
    private String mmversion;
    @XStreamAlias("weblink")
    @XStreamAsAttribute
    private String weblink;
    @XStreamAlias("updatecheckurl")
    @XStreamAsAttribute
    private String updatecheckurl;
    @XStreamAlias("updatedownloadurl")
    @XStreamAsAttribute
    private String updatedownloadurl;
    @XStreamImplicit
    private ArrayList<Action> actions = new ArrayList<Action>();
    // Extra
    /**
     * Absolute path of the .honmod file
     */
    @XStreamAlias("path")
    @XStreamAsAttribute
    private String path;
    @XStreamOmitField
    private boolean enabled;
    @XStreamOmitField
    private Icon icon;
    @XStreamOmitField
    private Icon resizedIcon;
    @XStreamOmitField
    private Icon smallIcon;
    @XStreamOmitField
    private String changelog;

    /**
     * Mod constructor.
     */
    public Mod() {
    }

    /**
     * This constructor should only be called by ManagerOptionsConverter.
     * @param name
     * @param version
     * @param author
     */
    public Mod(String name, String version, String author) {
        this.version = version;
        this.name = name;
        this.author = author;
    }

    /**
     * This methoud should only be called by ModListConverter.
     * @param name
     * @param version
     * @param author
     * @param updateDownloadUrl
     */
    public Mod(String name, String version, String author, String updateDownloadUrl, String path) {
        this.name = name;
        this.version = version;
        this.author = author;
        this.updatedownloadurl = updateDownloadUrl;
        this.path = path;
    }

    /**
     * Copies the passed mod by param to this mod. Only it's content are copied, the instances continues to exist.
     * <b>The argument mod is the one who will be copied, and the caller is the one who will recieve a copy of the parameter mod.</b>
     * @param mod to be copied.
     */
    public void copy(Mod mod) {
        if (mod.actions != null) {
            this.actions = new ArrayList<Action>(mod.actions);
        }
        this.application = mod.getApplication();
        this.appversion = mod.getAppVersion();
        this.author = mod.getAuthor();
        this.changelog = mod.getChangelog();
        this.date = mod.getDate();
        this.description = mod.getDescription();
        this.enabled = mod.isEnabled();
        this.icon = mod.getIcon();
        this.mmversion = mod.getMmVersion();
        this.name = mod.getName();
        this.path = mod.getPath();
        this.resizedIcon = mod.getSizedIcon();
        this.smallIcon = mod.getSmallIcon();
        this.updatecheckurl = mod.getUpdateCheckUrl();
        this.updatedownloadurl = mod.getUpdateDownloadUrl();
        this.version = mod.getVersion();
        this.weblink = mod.getWebLink();
    }

    /**
     * The actions (such as applyafter, insert, editfile) are stored in this array list.
     * @return the array list of the actions.
     */
    public ArrayList<Action> getActions() {
        if (actions != null) {
            return actions;
        } else {
            return actions = new ArrayList<Action>();
        }
    }

    /**
     * Get list of actions of a specified type
     *
     * @param type type of actions to return. See Action.java for action constants
     * @return list of actions of the given type (empty if there are none)
     */
    public ArrayList<Action> getActions(String type) {
        Action act;
        ArrayList<Action> typeActions = new ArrayList<Action>();
        if (actions == null) {
            actions = new ArrayList<Action>();
        }
        for (Iterator actionsIter = actions.iterator(); actionsIter.hasNext();) {
            act = (Action) actionsIter.next();
            if (act.getClass() == getTypeActionClass(type)) {
                typeActions.add(act);
            }
        }
        return typeActions;
    }

    private Class getTypeActionClass(String type) {
        if (type.equals(Action.APPLY_AFTER)) {
            return ActionApplyAfter.class;
        }
        if (type.equals(Action.APPLY_BEFORE)) {
            return ActionApplyBefore.class;
        }
        if (type.equals(Action.COPY_FILE)) {
            return ActionCopyFile.class;
        }
        if (type.equals(Action.DELETE)) {
            return ActionEditFileDelete.class;
        }
        if (type.equals(Action.EDIT_FILE)) {
            return ActionEditFile.class;
        }
        if (type.equals(Action.FIND)) {
            return ActionEditFileFind.class;
        }
        if (type.equals(Action.FIND_UP)) {
            return ActionEditFileFindUp.class;
        }
        if (type.equals(Action.INCOMPATIBILITY)) {
            return ActionIncompatibility.class;
        }
        if (type.equals(Action.INSERT)) {
            return ActionEditFileInsert.class;
        }
        if (type.equals(Action.REPLACE)) {
            return ActionEditFileReplace.class;
        }
        if (type.equals(Action.REQUIREMENT)) {
            return ActionRequirement.class;
        }
        return Action.class;
    }

    /**
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * @return the version
     */
    public String getVersion() {
        return version;
    }

    /**
     * @return the date
     */
    public String getDate() {
        return date;
    }

    /**
     * @return the author
     */
    public String getAuthor() {
        return author;
    }

    /**
     * @return the description
     */
    public String getDescription() {
        return description;
    }

    /**
     * @return the application
     */
    public String getApplication() {
        return application;
    }

    /**
     * @return the appversion
     */
    public String getAppVersion() {
        return appversion;
    }

    /**
     * @return the mmversion
     */
    public String getMmVersion() {
        return mmversion;
    }

    /**
     * @return the weblink
     */
    public String getWebLink() {
        return weblink;
    }

    /**
     * @return the updatecheckurl
     */
    public String getUpdateCheckUrl() {
        return updatecheckurl;
    }

    /**
     * @return the updatedownloadurl
     */
    public String getUpdateDownloadUrl() {
        return updatedownloadurl;
    }

    /**
     * @param path the path of the .honmod file.
     */
    public void setPath(String path) {
        this.path = path;
    }

    /**
     *
     * @return the path of the .honmod file.
     */
    public String getPath() {
        return path;
    }

    /**
     * Method to check if the mod is enabled.
     * @return true if the mod is enabled, false otherwise.
     */
    public boolean isEnabled() {
        return enabled;
    }

    /**
     * Method to enable or disable a mod.
     * @param _enabled true to enable this mod, false to disable it.
     */
    public void setEnabled(boolean _enabled) {
        enabled = _enabled;
    }

    /**
     * <b>This should only be called by the controller.</b><br/>
     * Method to enable the current mod
     */
    public void enable() {
        enabled = true;
    }

    /**
     * <b>This should only be called by the controller.</b><br/>
     * Method to disable the current mod
     */
    public void disable() {
        enabled = false;
    }

    /**
     * Sets the icon of a mod
     * @param icon Icon for this mod
     */
    public void setIcon(Icon icon) {
        this.icon = this.resizedIcon = this.smallIcon = icon;

        // Resize icon to normal size.
        if (icon.getIconHeight() != ICON_HEIGHT
                || icon.getIconWidth() != ICON_WIDTH) {
            resizedIcon = new ImageIcon(
                    ((ImageIcon) icon).getImage().getScaledInstance(
                    ICON_WIDTH, ICON_HEIGHT, Image.SCALE_SMOOTH));
        }

        // Resize icon to fit in DetailsView
        if (icon.getIconHeight() != DetailsView.DEFAULT_ROW_HEIGHT) {
            smallIcon = new ImageIcon(
                    ((ImageIcon) icon).getImage().getScaledInstance(
                    DetailsView.DEFAULT_ROW_HEIGHT,
                    DetailsView.DEFAULT_ROW_HEIGHT,
                    Image.SCALE_SMOOTH));
        }
    }

    /**
     * Returns icon of a mod
     * @return icon for this mod
     */
    public Icon getIcon() {
        return icon;
    }

    /**
     * Returns icon of a mod at the regular size; ICON_WIDTH v ICON_HEIGHT
     * @return the normalized icon for this mod
     */
    public Icon getSizedIcon() {
        return resizedIcon;
    }

    /**
     * Returns icon for a mod
     * @return the smaller icon for this mod to fit into DetailsView
     */
    public Icon getSmallIcon() {
        return smallIcon;
    }

    /**
     * Returns a String with the content of the mod's Changelog in it.
     * @return a String with the chanelog. If it's null or empty, returns an empty string.
     */
    public String getChangelog() {
        if (changelog != null) {
            return changelog;
        }
        return "";
    }

    public void setChangelog(String changelog) {
        this.changelog = changelog;
    }

    /**
     * This method checks if a Mod is equal to another one. To be equal, it's Name and Version must be equals, so that's what this checks.
     */
    @Override
    public boolean equals(Object o) {
        if (o != null && o.getClass().equals(Mod.class)) {
            Mod compare = (Mod) o;
            if (compare.getName().equals(this.getName()) && compare.getVersion().equals(this.getVersion())) {
                return true;
            }
        }
        return false;
    }

    @Override
    public int hashCode() {
        return this.getName().hashCode() + (int) this.getVersion().hashCode();
    }
}