First cut of the AVM filesystem driver for CIFS/FTP support.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@4388 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/filesys/avm/AVMSearchContext.java

@@ -0,0 +1,269 @@
+/*
+ * Copyright (C) 2006 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+
+package org.alfresco.filesys.avm;
+
+import java.util.Collection;
+import java.util.SortedMap;
+
+import org.alfresco.filesys.server.filesys.FileAttribute;
+import org.alfresco.filesys.server.filesys.FileInfo;
+import org.alfresco.filesys.server.filesys.SearchContext;
+import org.alfresco.filesys.util.WildCard;
+import org.alfresco.service.cmr.avm.AVMNodeDescriptor;
+
+/**
+ * AVM Filesystem Search Context Class
+ * 
+ * <p>Contains the details of a wildcard folder search.
+ *
+ * @author GKSpencer
+ */
+public class AVMSearchContext extends SearchContext {
+
+	// File list and current index
+	
+	private AVMNodeDescriptor[] m_fileList;
+	private int m_fileIdx;
+	
+	// File attributes
+	
+	private int m_attrib;
+	
+	// Optional wildcard filter
+	
+	private WildCard m_filter;
+	
+	/**
+	 * Class constructor
+	 * 
+	 * @param fileList SortedMap<String, AVMNodeDescriptor>
+	 * @param attrib int
+	 * @param filter WildCard
+	 */
+	public AVMSearchContext( AVMNodeDescriptor[]  fileList, int attrib, WildCard filter)
+	{
+		m_attrib   = attrib;
+		m_filter   = filter;
+		m_fileList = fileList;
+	}
+	
+    /**
+     * Determine if there are more files for the active search.
+     * 
+     * @return boolean
+     */
+    public boolean hasMoreFiles()
+    {
+    	return m_fileIdx < m_fileList.length ? true : false;
+    }
+
+    /**
+     * Return file information for the next file in the active search. Returns false if the search
+     * is complete.
+     * 
+     * @param info FileInfo to return the file information.
+     * @return true if the file information is valid, else false
+     */
+    public boolean nextFileInfo(FileInfo info)
+    {
+    	// Check if there is another file record to return
+    	
+    	if ( m_fileIdx >= m_fileList.length)
+    		return false;
+
+    	// Search for the next valid file
+    	
+        boolean foundMatch = false;
+    	AVMNodeDescriptor curFile = null;
+    	
+        while (foundMatch == false && m_fileIdx < m_fileList.length)
+        {
+        	// 	Get the next file from the list
+        	
+        	curFile = m_fileList[ m_fileIdx++];
+        	
+        	//	Check if the file name matches the search pattern
+  				
+  			if ( m_filter.matchesPattern(curFile.getName()) == true)
+  			{
+  					
+  				//  Check if the file matches the search attributes
+  	
+  				if (FileAttribute.hasAttribute(m_attrib, FileAttribute.Directory) &&
+  					curFile.isDirectory())
+  				{
+  	
+  					//  Found a match
+  	
+  					foundMatch = true;
+  				}
+  				else if ( curFile.isFile())
+  				{
+  	
+  					//  Found a match
+  	
+  					foundMatch = true;
+  				}
+
+  				//	Check if we found a match
+  				
+  				if ( foundMatch == false)
+  				{
+  					
+  					//  Get the next file from the list
+
+  					if ( ++m_fileIdx < m_fileList.length)
+  			        	curFile = m_fileList[ m_fileIdx];
+  				}
+  			}
+        }
+
+        // If we found a match then fill in the file information
+
+        if ( foundMatch)
+        {
+        	// Fill in the file information
+        	
+        	info.setFileName( curFile.getName());
+        	
+        	if ( curFile.isFile())
+        	{
+        		info.setFileSize( curFile.getLength());
+        		info.setAllocationSize((curFile.getLength() + 512L) & 0xFFFFFFFFFFFFFE00L);
+        	}
+        	else
+        		info.setFileSize( 0L);
+
+        	info.setAccessDateTime( curFile.getAccessDate());
+        	info.setCreationDateTime( curFile.getCreateDate());
+        	info.setModifyDateTime( curFile.getModDate());
+
+        	// Build the file attributes
+        	
+        	int attr = 0;
+        	
+        	if ( curFile.isDirectory())
+        		attr += FileAttribute.Directory;
+        	
+        	if ( curFile.getName().startsWith( ".") ||
+        			curFile.getName().equalsIgnoreCase( "Desktop.ini") ||
+        			curFile.getName().equalsIgnoreCase( "Thumbs.db"))
+        		attr += FileAttribute.Hidden;
+        	
+        	info.setFileAttributes( attr);
+        }
+        
+        // Indicate if the file information is valid
+        
+    	return foundMatch;
+    }
+
+    /**
+     * Return the file name of the next file in the active search. Returns null is the search is
+     * complete.
+     * 
+     * @return String
+     */
+    public String nextFileName()
+    {
+    	// Check if there is another file record to return
+    	
+    	//	Find the next matching file name
+    	
+    	while ( m_fileIdx < m_fileList.length) {
+    		
+    		//	Check if the current file name matches the search pattern
+    		
+    		String fname = m_fileList[m_fileIdx++].getName();
+    		
+    		if ( m_filter.matchesPattern(fname))
+    			return fname;
+    	}
+    	
+    	// No more matching file names
+    	
+    	return null;
+    }
+
+    /**
+     * Return the total number of file entries for this search if known, else return -1
+     * 
+     * @return int
+     */
+    public int numberOfEntries()
+    {
+        return m_fileList.length;
+    }
+
+    /**
+     * Return the resume id for the current file/directory in the search.
+     * 
+     * @return int
+     */
+    public int getResumeId()
+    {
+    	return m_fileIdx;
+    }
+    
+    /**
+     * Restart a search at the specified resume point.
+     * 
+     * @param resumeId Resume point id.
+     * @return true if the search can be restarted, else false.
+     */
+    public boolean restartAt(int resumeId)
+    {
+    	// Range check the resume id
+    	
+    	if ( resumeId < 0 || resumeId >= m_fileList.length)
+    		return false;
+    	
+    	// Reset the current file index
+    	
+    	m_fileIdx = resumeId;
+    	return true;
+    }
+
+    /**
+     * Restart the current search at the specified file.
+     * 
+     * @param info File to restart the search at.
+     * @return true if the search can be restarted, else false.
+     */
+    public boolean restartAt(FileInfo info)
+    {
+    	// Search backwards from the current file
+    	
+    	int curFileIdx = m_fileIdx;
+    	
+    	while ( m_fileIdx > 0) {
+    		
+    		// Check if the current file is the required search restart point
+    		
+    		if ( m_fileList[ m_fileIdx].getName().equals( info.getFileName()))
+    			return true;
+    		else
+    			m_fileIdx--;
+    	}
+    	
+    	// Failed to find the restart file
+    	
+    	m_fileIdx = curFileIdx;
+    	return false;
+    }
+}