1a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair/* 2a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Copyright 2008 the original author or authors. 3a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 4a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Licensed under the Apache License, Version 2.0 (the "License"); 5a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * you may not use this file except in compliance with the License. 6a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * You may obtain a copy of the License at 7a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 8a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * http://www.apache.org/licenses/LICENSE-2.0 9a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 10a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Unless required by applicable law or agreed to in writing, software 11a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * distributed under the License is distributed on an "AS IS" BASIS, 12a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * See the License for the specific language governing permissions and 14a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * limitations under the License. 15a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 16a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairpackage org.mockftpserver.fake.filesystem; 17a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 18a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairimport org.mockftpserver.core.util.Assert; 19a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 20a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair/** 21a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Implementation of the {@link FileSystem} interface that simulates a Microsoft 22a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Windows file system. The rules for file and directory names include: 23a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * <ul> 24a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * <li>Filenames are case-insensitive (and normalized to lower-case)</li> 25a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * <li>Either forward slashes (/) or backward slashes (\) are valid path separators (but are normalized to '\')</li> 26a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * <li>An absolute path starts with a drive specifier (e.g. 'a:' or 'c:') followed 27a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * by '\' or '/', or else if it starts with "\\"</li> 28a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * </ul> 29a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * <p/> 30a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * The <code>directoryListingFormatter</code> property is automatically initialized to an instance 31a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * of {@link WindowsDirectoryListingFormatter}. 32a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 33a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @author Chris Mair 34a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @version $Revision$ - $Date$ 35a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 36a0ad464efff5f5e2d2523a3522cce6823ce05858chrismairpublic class WindowsFakeFileSystem extends AbstractFakeFileSystem { 37a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 38a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public static final char SEPARATOR = '\\'; 39a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair private static final String VALID_PATTERN = "\\p{Alpha}\\:" + "(\\\\|(\\\\[^\\\\\\:\\*\\?\\<\\>\\|\\\"]+)+)"; 40a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair //static final VALID_PATTERN = /\p{Alpha}\:(\\|(\\[^\\\:\*\?\<\>\|\"]+)+)/ 41a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair private static final String LAN_PREFIX = "\\\\"; 42a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 43a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 44a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Construct a new instance and initialize the directoryListingFormatter to a WindowsDirectoryListingFormatter. 45a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 46a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair public WindowsFakeFileSystem() { 47a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair this.setDirectoryListingFormatter(new WindowsDirectoryListingFormatter()); 48a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 49a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 50a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair //------------------------------------------------------------------------- 51a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair // Abstract Or Overridden Method Implementations 52a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair //------------------------------------------------------------------------- 53a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 54a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 55a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Return the normalized and unique key used to access the file system entry. Windows is case-insensitive, 56a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * so normalize all paths to lower-case. 57a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 58a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param path - the path 59a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return the corresponding normalized key 60a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 61a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair protected String getFileSystemEntryKey(String path) { 62a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return normalize(path).toLowerCase(); 63a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 64a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 65a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair protected char getSeparatorChar() { 66a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return SEPARATOR; 67a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 68a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 69a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 70a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Return true if the specified path designates a valid (absolute) file path. For Windows 71a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * paths, a path is valid if it starts with a drive specifier followed by 72a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * '\' or '/', or if it starts with "\\". 73a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 74a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param path - the path 75a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return true if path is valid, false otherwise 76a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @throws AssertionError - if path is null 77a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 78a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair protected boolean isValidName(String path) { 79a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair // \/:*?"<>| 80a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair Assert.notNull(path, "path"); 81a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair String standardized = path.replace('/', '\\'); 82a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return standardized.matches(VALID_PATTERN) || standardized.startsWith(LAN_PREFIX); 83a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 84a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 85a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 86a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * Return true if the specified char is a separator character ('\' or '/') 87a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * 88a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @param c - the character to test 89a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return true if the specified char is a separator character ('\' or '/') 90a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 91a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair protected boolean isSeparator(char c) { 92a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return c == '\\' || c == '/'; 93a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 94a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 95a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair /** 96a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair * @return true if the specified path component is a root for this filesystem 97a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair */ 98a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair protected boolean isRoot(String pathComponent) { 99a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair return pathComponent.indexOf(":") != -1; 100a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair } 101a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair 102a0ad464efff5f5e2d2523a3522cce6823ce05858chrismair}