/* ======================================================================
The Bodington System Software License, Version 1.0
  
Copyright (c) 2001 The University of Leeds.  All rights reserved.
  
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

1.  Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES 
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO 
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR 
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
=========================================================

This software was originally created by the University of Leeds and may contain voluntary 
contributions from others.  For more information on the Bodington Open Source Project, please 
see http://bodington.org/

====================================================================== */

package org.bodington.applet.data;

import org.w3c.dom.*;

import java.util.Stack;
import java.net.*;

public class RemoteFile
    implements Comparable
	{
	Document dom;
	RemoteFile parent;
	Element element;
    URL resource_url;
	String name=null;
	
	String url_char_encoding;
	
	public RemoteFile( Document dom, URL url )
		{
		this.dom = dom;
		resource_url = url;
		parent = null;
		
		NodeList list = dom.getElementsByTagName( "filelisting" );
		if ( list.getLength() != 1 )
			throw new IllegalArgumentException( "File listing XML must contain exactly one filelisting element." );
		
		
		Element listing = (Element)list.item( 0 );
		url_char_encoding = listing.getAttribute( "url_char_encoding" );
		if ( url_char_encoding == null )
		    throw new IllegalArgumentException( "The filelisting element must have a url_char_encoding attribute." );
		
		list = list.item( 0 ).getChildNodes();
		int n=0;
		Element other;
		for ( int i=0; i<list.getLength(); i++ )
			{
			if ( element != null )
				{
				if ( list.item( i ).getNodeType() == Node.ELEMENT_NODE )
					{
					other = (Element)list.item( i );
					if ( other.getTagName().equals( "file" ) )
						throw new IllegalArgumentException( "The filelisting element must contain exactly one file element." );
					}
				}
			else
				{
				if ( list.item( i ).getNodeType() == Node.ELEMENT_NODE )
					{
					element = (Element)list.item( i );
					if ( !element.getTagName().equals( "file" ) )
						throw new IllegalArgumentException( "The filelisting element must contain exactly one file element." );
					}
				}
			}
			
		if ( element == null )
			throw new IllegalArgumentException( "The filelisting element must contain exactly one file element." );
		
		if ( !element.getAttribute( "type" ).equals( "folder" ) )
			throw new IllegalArgumentException( "The top level file element must have attribute type=\"folder\"." );
			
		}
	
	private RemoteFile( RemoteFile parent, Element element )
		{
		this.dom = parent.dom;
		this.resource_url = parent.resource_url;
		this.parent = parent;
		this.element = element;
		this.url_char_encoding = parent.url_char_encoding;
		}
	
	private RemoteFile[] list( boolean files, boolean folders )
		{
		NodeList list = element.getChildNodes();
		Element child;
		int n=0;
		
		for ( int i=0; i<list.getLength(); i++ )
			{
			if ( list.item( i ).getNodeType() != Node.ELEMENT_NODE )
				continue;

			child = (Element)list.item( i );
			if ( !child.getTagName().equals( "file" ) )
				continue;
				
			if ( files && child.getAttribute( "type" ).equals( "file" ) )
				n++;
					
			if ( folders && child.getAttribute( "type" ).equals( "folder" ) )
				n++;
			}
		
		RemoteFile[] file_list = new RemoteFile[n];
		
		n=0;
		for ( int i=0; i<list.getLength(); i++ )
			{
			if ( list.item( i ).getNodeType() != Node.ELEMENT_NODE )
				continue;

			child = (Element)list.item( i );
			if ( !child.getTagName().equals( "file" ) )
				continue;
				
			if ( files && child.getAttribute( "type" ).equals( "file" ) )
				file_list[n++] = new RemoteFile( this, child );
					
			if ( folders && child.getAttribute( "type" ).equals( "folder" ) )
				file_list[n++] = new RemoteFile( this, child );
			}

		return file_list;
		}
		
	public RemoteFile[] list()
		{
		return list( true, true );
		}

	public RemoteFile[] listFiles()
		{
		return list( true, false );
		}

	public RemoteFile[] listFolders()
		{
		return list( false, true );
		}

    public RemoteFile findFile( String name )
        {
		NodeList list = element.getChildNodes();
		Element child;
		int n=0;
		String testname;
		
		for ( int i=0; i<list.getLength(); i++ )
			{
			if ( list.item( i ).getNodeType() != Node.ELEMENT_NODE )
				continue;

			child = (Element)list.item( i );
			if ( !child.getTagName().equals( "file" ) )
				continue;
				
			if ( child.getAttribute( "type" ).equals( "file" ) || 
                 child.getAttribute( "type" ).equals( "folder" )  )
			    {
			    try
			        {
                    testname = child.getAttribute( "name" );
                    }
                catch ( Exception ex )
                    {
                    testname = "";
                    }
                    
                if ( name.equals( testname ) )
                    return new RemoteFile( this, child );
			    }
			}
		
		return null;
        }

	public boolean containsDeletedFiles()
		{
		if ( !isFolder() )
		    return false;
		    
		NodeList list = element.getElementsByTagName( "file" );
		Element child;
		String att;
		
		for ( int i=0; i<list.getLength(); i++ )
			{
			if ( list.item( i ).getNodeType() != Node.ELEMENT_NODE )
				continue;

			child = (Element)list.item( i );
			if ( !child.getTagName().equals( "file" ) )
				continue;
				
			att = child.getAttribute( "deleted" );
			if ( att!=null && att.equals( "true" ) )
			    return true;
			}
		
		return false;
		}
		
	public boolean isFile()
		{
		return element.getAttribute( "type" ).equals( "file" );
		}

	public boolean isDeleted()
		{
		String d = element.getAttribute( "deleted" );
		return d !=null && d.equals( "true" );
		}

	public boolean isFolder()
		{
		return element.getAttribute( "type" ).equals( "folder" );
		}

	public String getHRef()
		{
		return element.getAttribute( "href" );
		}

    public void setHRef( String n )
        {
        element.setAttribute( "href", n );
        }
        
	public String getName()
		{
		return element.getAttribute( "name" );
		}
    
    public void setName( String n )
        {
        element.setAttribute( "name", n );
        }

	public String toString()
		{
		return getHRef();
		}

    public String getUrlCharEncoding()
	{
	return url_char_encoding;
	}
		
    public int compareTo( Object o )
        {
        return this.toString().compareTo( o.toString() );
        }

	public RemoteFile getParent()
		{
		return parent;
		}

	public URL getResourceUrl()
	    {
	    return resource_url;
	    }
	    
    public String getPath()
        {
		Stack path = new Stack();
		RemoteFile current=this;

		// if this is the root its simple...
		if ( current.getParent() == null )
		    {
		    return "";
		    }
        // push onto stack down to but not including
        // the root
		while ( current.getParent() != null )
		    {
		    path.push( current );
		    current = current.getParent();
		    }
		
		StringBuffer offset = new StringBuffer();
		while ( !path.isEmpty() )
		    {
		    current = (RemoteFile)path.pop();
		    if ( offset.length() > 0 )
		        offset.append( "/" );
		    offset.append( current.getHRef() );
		    }
		if ( isFolder() )
		    offset.append( "/" );
		return offset.toString();
	    }	
	}