////////////////////////////////////////////////////////////////////////////////
   // MillScript: an Open Spice interpreter and batch website creation tool
   // Copyright (C) 2005 Kevin Rogers
   //
   // This file is part of MillScript.
   //
   // MillScript 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 2 of the License, or (at your option)
  // any later version.
  //
  // MillScript 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
  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
  // Place, Suite 330, Boston, MA  02111-1307  USA
  ////////////////////////////////////////////////////////////////////////////////
  package org.millscript.commons.vfs.util;
  
  import org.millscript.commons.vfs.VFile;
  import org.millscript.commons.vfs.VFolder;
  import org.millscript.commons.vfs.VVolume;
  import org.millscript.commons.vfs.mime.MIMETypeHandler;
  
  import java.io.InputStream;
  import java.io.OutputStream;
  import java.io.Reader;
  import java.io.Writer;
  
  /**
   * This class implements a virtual file for a Unix style chroot volume.
   */
  public class ChrootFile extends AbstractChrootEntry implements VFile {
  
      /**
       * The root folder for this volume.
       */
      private final ChrootVolume chrootVolume;
  
      /**
       * The hidden virtual file.
       */
      private final VFile chrootFile;
  
      /**
       * The parent folder for this file.
       */
      private final ChrootFolder parentFolder;
  
      /**
       * Constructs a new chroot file for the specified file, in the specified
       * folder, on the specified volume.
       *
       * @param vol   the chroot volume this file belongs on
       * @param parent    the chroot parent folder for this file
       * @param file  the underlying virtual file
       */
      ChrootFile( final ChrootVolume vol, final ChrootFolder parent, final VFile file ) {
          this.chrootVolume = vol;
          this.chrootFile = file;
          this.parentFolder = parent;
      }
  
      /**
       * @see org.millscript.commons.vfs.VEntry#appendRelativePath(java.lang.StringBuffer)
       */
      public StringBuffer appendRelativePath( final StringBuffer buffer ) {
          // If we have a parent, append it's relative path to the buffer.
          if ( this.getParent() != null ) {
              // This will recurse all the way up the chain to give us the
              // relative path from the root of the filesystem.
              // Append the parent entry to the buffer
              this.getParent().appendRelativePath( buffer );
          }
          // Append this entry to the buffer followed by a slash
          return buffer.append( this.getName() );
      }
  
      /**
       * @see org.millscript.commons.vfs.VEntry#appendURI(java.lang.StringBuffer)
       */
      public StringBuffer appendURI( final StringBuffer buffer ) {
          // If we have a parent, append it's URI to the buffer.
          // This will recurse all the way up the chain to give us the complete
          // URI for this entry
          if ( this.getParent() == null ) {
              // No parent - this is the root entry
              this.getVolume().appendBaseURI( buffer );
          } else {
              // We have a parent, so append it's URI
              this.getParent().appendURI( buffer );
          }
          return buffer.append( this.getName() );
      }
  
      /**
      * @see org.millscript.commons.vfs.VEntry#exists()
      */
     public boolean exists() {
         return this.chrootFile.exists();
     }
 
     /**
      * @see org.millscript.commons.vfs.VFile#getAppendOutputStream()
      */
     public OutputStream getAppendOutputStream() {
         return this.chrootFile.getAppendOutputStream();
     }
 
     /**
      * @see org.millscript.commons.vfs.VFile#getAppendWriter()
      */
     public Writer getAppendWriter() {
         return this.chrootFile.getAppendWriter();
     }
 
     /**
      * @see org.millscript.commons.vfs.VFile#getContentMIMEType()
      */
     public String getContentMIMEType() {
         return this.chrootFile.getContentMIMEType();
     }
 
     /**
      * @see org.millscript.commons.vfs.VFile#getInputStream()
      */
     public InputStream getInputStream() {
         return this.chrootFile.getInputStream();
     }
 
     /**
      * @see org.millscript.commons.vfs.VEntry#getMIMEType(java.lang.String)
      */
     public String getMIMEType( final String fileName ) {
         return this.chrootFile.getMIMEType( fileName );
     }
 
     /**
      * @see org.millscript.commons.vfs.VEntry#getMIMETypeHandler(java.lang.String)
      */
     public MIMETypeHandler getMIMETypeHandler( final String type ) {
         return this.chrootFile.getMIMETypeHandler( type );
     }
 
     /**
      * @see org.millscript.commons.vfs.VEntry#getName()
      */
     public String getName() {
         return this.chrootFile.getName();
     }
 
     /**
      * @see org.millscript.commons.vfs.VFile#getOutputStream()
      */
     public OutputStream getOutputStream() {
         return this.chrootFile.getOutputStream();
     }
 
     /**
      * @see org.millscript.commons.vfs.VEntry#getParent()
      */
     public VFolder getParent() {
         return this.parentFolder;
     }
 
     /**
      * @see org.millscript.commons.vfs.VFile#getReader()
      */
     public Reader getReader() {
         return this.chrootFile.getReader();
     }
 
     /**
      * @see org.millscript.commons.vfs.VEntry#getVolume()
      */
     public VVolume getVolume() {
         return this.chrootVolume;
     }
 
     /**
      * @see org.millscript.commons.vfs.VFile#getWriter()
      */
     public Writer getWriter() {
         return this.chrootFile.getWriter();
     }
 
     /**
      * @see org.millscript.commons.vfs.VEntry#toLocal()
      */
     public VFile toLocal() {
         return new ChrootFile( this.chrootVolume, this.parentFolder, this.chrootFile.toLocal() );
     }
 
     /**
      * @see java.lang.Object#toString()
      */
     @Override
     public String toString() {
         final StringBuffer buff = new StringBuffer( "CHROOT_FILE( " );
         return this.appendAbsolutePath( buff ).append( " )" ).toString();
     }
 
 }