source: trunk/src/org/expeditee/agents/CopyTree.java@ 1415

/**
 *    CopyTree.java
 *    Copyright (C) 2010 New Zealand Digital Library, http://expeditee.org
 *
 *    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 org.expeditee.agents;

import java.util.HashMap;
import java.util.LinkedList;

import org.expeditee.gui.Frame;
import org.expeditee.gui.FrameIO;
import org.expeditee.gui.FrameUtils;
import org.expeditee.gui.MessageBay;
import org.expeditee.items.Item;

public class CopyTree extends TreeProcessor {

        private String _nameTo;

        private String _nameFrom;

        private String _framePath;

        private int _lastNumber = -1;

        private int _firstNumber = 1;

        private HashMap<String, String> _nameMap = new HashMap<String, String>();

        private LinkedList<String> _toReparse = new LinkedList<String>();

        public CopyTree(String framesetTo) {
                _nameTo = framesetTo.trim();
        }

        @Override
        public boolean initialise(Frame init, Item launcher) {
                _nameFrom = init.getFramesetName().toLowerCase();

                // create the new frameset
                try {
                        // get the last used frame in the destination frameset
                        _lastNumber = FrameIO.getLastNumber(_nameTo);
                        Frame one = FrameIO.CreateFrameset(_nameTo, init.getPath());

                        _framePath = one.getPath();
                        _lastNumber = -1;
                        _firstNumber = 1;

                        // copy the original .0 frame
                        Frame zero = FrameIO
                                        .LoadFrame(init.getFramesetName() + "0");
                        processFrame(zero);
                } catch (ExistingFramesetException efe) {
                        MessageBay.errorMessage("A frameset called " + _nameTo
                                        + " already exists.");
                        return false;
                } catch (Exception e) {
                        return false;
                }

                return super.initialise(init, launcher);
        }

        @Override
        protected void processFrame(Frame toProcess) {
                // load a fresh copy of the frame that bypasses the cache
                FrameIO.SuspendCache();

                Frame fresh = FrameIO.LoadFrame(toProcess.getName());
                if (_nameMap.containsKey(fresh.getName().toLowerCase())) {
                        fresh
                                        .setName(_nameMap.get(fresh.getName()
                                                        .toLowerCase()));
                } else {
                        fresh.setFrameset(_nameTo);
                        fresh.setFrameNumber(++_lastNumber);

                        _nameMap.put(toProcess.getName().toLowerCase(), fresh
                                        .getName().toLowerCase());
                }

                boolean added = false;
                for (Item i : fresh.getSortedItems())
                        if (i.getLink() != null && !i.isAnnotation() && i.isLinkValid()) {
                                String link = i.getLink().toLowerCase();
                                //convert to absolute link with the old framesetName
                                if (FrameIO.isPositiveInteger(link)){
                                        link = _nameFrom + link;
                                }
                                //check if we already have this in our map
                                if (_nameMap.containsKey(link))
                                        link = _nameMap.get(link);
                                //otherwise add it to our map
                                else if (link.startsWith(_nameFrom)) {
                                        _nameMap.put(link, _nameTo + (++_lastNumber));
                                        link = "" + _lastNumber;
                                }
                                i.setLink(link);
                        } else if (!added && i.getLink() != null && i.isAnnotation()
                                        && i.isLinkValid()) {
                                // annotation links need to be parsed at the end
                                if (i.getAbsoluteLink().toLowerCase().startsWith(_nameFrom)) {
                                        _toReparse.add(fresh.getName());
                                        added = true;
                                }

                        }
                _frameCount++;
                fresh.setPath(_framePath);
                FrameIO.ForceSaveFrame(fresh);
                FrameIO.ResumeCache();
        }

        @Override
        protected void finalise(Frame frame) {
                // reparse all frames that have annotation links that may need updating
                for (String name : _toReparse) {
                        Frame toParse = FrameIO.LoadFrame(name);
                        boolean changed = false;
                        for (Item i : toParse.getSortedItems()) {
                                if (i.getLink() != null && i.isAnnotation() && i.isLinkValid()) {
                                        String link = i.getLink();
                                        link = link.toLowerCase();
                                        // link = link.replace(_nameFrom, _nameTo);
                                        if (_nameMap.containsKey(link)) {
                                                link = _nameMap.get(link);
                                                i.setLink(link);
                                                changed = true;
                                        }
                                }
                        }
                        if (changed) {
                                FrameIO.SaveFrame(toParse);
                        }
                }

                message("Tree successfully copied to " + _nameTo);
                FrameUtils.DisplayFrame(_nameTo + _firstNumber);
                
                super.finalise(frame);
        }

}