/*
    *  ginp - Java Web Application for Viewing Photo Collections
    *  Copyright (C) 2004  Douglas John Culnane <doug@culnane.net>
    *
    *  This library is free software; you can redistribute it and/or
    *  modify it under the terms of the GNU Lesser General Public
    *  License as published by the Free Software Foundation; either
    *  version 2.1 of the License, or any later version.
    *
   *  This library 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
   *  Lesser General Public License for more details.
   *
   *  You should have received a copy of the GNU Lesser General Public
   *  License along with this library; if not, write to the Free Software
   *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
   */
  package net.sf.ginp;
  
  import java.io.File;
  
  import net.sf.ginp.config.ModelUtil;
  
  import org.dom4j.Element;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  /**
   *  This class represents a collection of pictures as configured in the
   *  ginp.xml config file. A PicCollection has a root and a files system of
   *  folders and pictures. Renamed from Collection because that was too easy to
   *  confuse with the java collections class
   *
   *@author     Doug Culnane
   *@version    $Revision: 303 $
   */
  public class PicCollection {
  
               String         name                = "";
               String         path                = "/";
               String         root                = "";
               boolean        sortDESC            = false;
               boolean        userHasWriteAccess  = false;
      private Log log = LogFactory.getLog(PicCollection.class);
                 
      /**
       *  Constructor for the PicCollection object. The xml parameter contains the
       *  configuration for this PicCollection.
       *
       *@param  elem    Dom4j document element.
       */
      public PicCollection(Element elem) {
          root = elem.selectSingleNode("root").getText();
          name = elem.selectSingleNode("name").getText();
      }
  
  
  
      /**
       *  Sets the path attribute of the PicCollection, which idenfifies the
       *  current postion in the file system from the PicCollection's root.
       *
       *@param  s  The new path value.
       */
      public void setPath(String s) {
      	
      	//Sanitize Input
      	s=s.replaceAll("\\.\\./","");
      	s=s.replaceAll("\\.\\.\\\\","");
      	
          if (!(s.startsWith("/"))) {
              s = "/" + s;
          }
          if (!(s.endsWith("/"))) {
              s = s + "/";
          }
  
          File  dir  = new File(root + s.substring(0, s.length() - 1));
          if (dir.isDirectory()) {
              path = s;
              if (log.isDebugEnabled()) {
                  log.debug("setPath to:" + path);
              }
          } else {
              log.info("Attempt to setPath to non directory:" + dir.getAbsolutePath());
          }
       }
  
  
      /**
       *  Sets the userHasWriteAccess attribute of the PicCollection object
       *
       *@param  b  The new userHasWriteAccess value
       */
      public void setUserHasWriteAccess(boolean b) {
          userHasWriteAccess = b;
      }
  
 
   
 
   
     /**
      *  Gets the name attribute of the PicCollection.
      *
      *@return    The PicCollection name.
      */
     public String getName() {
         return name;
     }
 
 
 
     /**
      *  Gets the path of the collection from its root to the current location.
      *
      *@return    The path.
      */
     public String getPath() {
         return path;
     }
 
 
 
     /**
      *  Gets the root attribute of the PicCollection object
      *
      *@return    The root value
      */
     public String getRoot() {
         return root;
     }
 
 
     /**
      *  Description of the Method
      *
      *@return    Description of the Return Value
      */
     public boolean userHasWriteAccess() {
         return userHasWriteAccess;
     }
 
 
 
 
 
     /**
      *  Do a dump of info for debugging
      *
      *@return    The debugDump value
      */
     public String getDebugDump() {
         return "name: " + name + "\n"
                  + "root: " + root + "\n"
                  + "path: " + path + "\n";
     }
 
 
 
 	/**
 	 * @return
 	 */
 	public int getPictureLength() {
 		return ModelUtil.getFolderManager().getPicturesLength(this);
 	}
 
 
 
 
 
 
 	/**
 	 * @param count
 	 * @return
 	 */
 	public String getFolder(int count) {
 		return ModelUtil.getFolderManager().getFolder(this,count);
 	}
 
 
 
 	/**
 	 * @param count
 	 * @return
 	 */
 	public String getPicture(int count) {
 		String pic[]=ModelUtil.getFolderManager().getPictures(this);
 		if (count>=pic.length) { 
 			return null;
 		}
 		return pic[count];
 	}
 
 
 
 	/**
 	 * @return
 	 */
 	public int getFoldersLength() {
 		return ModelUtil.getFolderManager().getFoldersLength(this);
 	}
 
 
 
 	/**
 	 * @param picName
 	 * @return
 	 */
 	public String getNextPictureName(String picName) {
 		return ModelUtil.getFolderManager().getNextPictureName(picName,this);
 	}
 
 
 	/**
 	 * @param picName
 	 * @return
 	 */
 	public String getPrevPictureName(String picName) {
 		return ModelUtil.getFolderManager().getPrevPictureName(picName,this);
 	}
 
 	/**
 	 * @param string
 	 * @return
 	 */
 	public int getPicturesInDirectoryLength(String path) {
 		return ModelUtil.getFolderManager().getPicturesLength(this,path);
 	}
 
 
 
 	/**
 	 * @return
 	 */
 	public String[] getPictures() {
 		return ModelUtil.getFolderManager().getPictures(this);
 	}
 
 
 
 }