l2j-server-game/L2_GameServer/java/net/sf/l2j/gameserver/instancemanager/QuestManager.java

/*
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
package net.sf.l2j.gameserver.instancemanager;

import java.util.Map;
import java.util.logging.Logger;

import javolution.util.FastMap;
import net.sf.l2j.gameserver.model.quest.Quest;
import net.sf.l2j.gameserver.scripting.ScriptManager;

public class QuestManager extends ScriptManager<Quest>
{
    protected static final Logger _log = Logger.getLogger(QuestManager.class.getName());

    // =========================================================
    private static QuestManager _instance;
    public static final QuestManager getInstance()
    {
        if (_instance == null)
        {
    		_log.info("Initializing QuestManager");
            _instance = new QuestManager();
        }
        return _instance;
    }
    // =========================================================


    // =========================================================
    // Data Field
    private Map<String, Quest> _quests = new FastMap<String, Quest>();

    // =========================================================
    // Constructor
    public QuestManager()
    {
    }

    // =========================================================
    // Method - Public
    public final boolean reload(String questFolder)
    {
    	Quest q = getQuest(questFolder);
    	if (q == null)
    	{
            return false;
    	}
    	return q.reload();
    }
    
    /**
     * Reloads a the quest given by questId.<BR>
     * <B>NOTICE: Will only work if the quest name is equal the quest folder name</B>
     * @param questId The id of the quest to be reloaded
     * @return true if reload was succesful, false otherwise
     */
    public final boolean reload(int questId)
    {
    	Quest q = this.getQuest(questId);
    	if (q == null)
    	{
    		return false;
    	}
    	return q.reload();
    }
    
    public final void report()
    {
        _log.info("Loaded: " + getQuests().size() + " quests");
    }
    
    public final void save()
    {
    	for (Quest q: getQuests().values())
        {
    		q.saveGlobalData();
        }
    }

    // =========================================================
    // Property - Public
    public final Quest getQuest(String name)
    {
		return getQuests().get(name);
    }

    public final Quest getQuest(int questId)
    {
    	for (Quest q: getQuests().values())
    	{
    		if (q.getQuestIntId() == questId)
    			return q;
    	}
    	return null;
    }
    

    public final void addQuest(Quest newQuest)
    {
        if (newQuest == null)
        {
            throw new IllegalArgumentException("Quest argument cannot be null");
        }
    	Quest old = this.getQuests().get(newQuest.getName());
        
        // FIXME: unloading the old quest at this point is a tad too late.
        // the new quest has already initialized itself and read the data, starting
        // an unpredictable number of tasks with that data.  The old quest will now
        // save data which will never be read.
        // However, requesting the newQuest to re-read the data is not necessarily a 
        // good option, since the newQuest may have already started timers, spawned NPCs
        // or taken any other action which it might re-take by re-reading the data. 
        // the current solution properly closes the running tasks of the old quest but
        // ignores the data; perhaps the least of all evils...
        if (old != null)
        {
            old.unload();
            _log.info("Replaced: ("+old.getName()+") with a new version ("+newQuest.getName()+")");
            
        }
        this.getQuests().put(newQuest.getName(), newQuest);
    }
    
    public final boolean removeQuest(Quest q)
    {
        return this.getQuests().remove(q.getName()) != null;
    }
    
    public final FastMap<String, Quest> getQuests()
    {
        if (_quests == null) _quests = new FastMap<String, Quest>();
        return (FastMap<String, Quest>) _quests;
    }

    /**
     * @see net.sf.l2j.gameserver.scripting.ScriptManager#getAllManagedScripts()
     */
    @Override
    public Iterable<Quest> getAllManagedScripts()
    {
        return _quests.values();
    }

    /**
     * @see net.sf.l2j.gameserver.scripting.ScriptManager#unload(net.sf.l2j.gameserver.scripting.ManagedScript)
     */
    @Override
    public boolean unload(Quest ms)
    {
        ms.saveGlobalData();
        return this.removeQuest(ms);
    }

    /**
     * @see net.sf.l2j.gameserver.scripting.ScriptManager#getScriptManagerName()
     */
    @Override
    public String getScriptManagerName()
    {
        return "QuestManager";
    }
}