tikhomirov@74: /*
tikhomirov@74:  * Copyright (c) 2011 TMate Software Ltd
tikhomirov@74:  *  
tikhomirov@74:  * This program is free software; you can redistribute it and/or modify
tikhomirov@74:  * it under the terms of the GNU General Public License as published by
tikhomirov@74:  * the Free Software Foundation; version 2 of the License.
tikhomirov@74:  *
tikhomirov@74:  * This program is distributed in the hope that it will be useful,
tikhomirov@74:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
tikhomirov@74:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tikhomirov@74:  * GNU General Public License for more details.
tikhomirov@74:  *
tikhomirov@74:  * For information on how to redistribute this software under
tikhomirov@74:  * the terms of a license other than GNU General Public License
tikhomirov@102:  * contact TMate Software at support@hg4j.com
tikhomirov@74:  */
tikhomirov@74: package org.tmatesoft.hg.internal;
tikhomirov@74: 
tikhomirov@74: import java.util.Arrays;
tikhomirov@74: import java.util.TreeSet;
tikhomirov@74: 
tikhomirov@74: import org.tmatesoft.hg.util.PathRewrite;
tikhomirov@74: 
tikhomirov@74: /**
tikhomirov@74:  * @see http://mercurial.selenic.com/wiki/CaseFoldingPlan
tikhomirov@80:  * @see http://mercurial.selenic.com/wiki/fncacheRepoFormat
tikhomirov@74:  * 
tikhomirov@74:  * @author Artem Tikhomirov
tikhomirov@74:  * @author TMate Software Ltd.
tikhomirov@74:  */
tikhomirov@74: class StoragePathHelper implements PathRewrite {
tikhomirov@74: 	
tikhomirov@74: 	private final boolean store;
tikhomirov@74: 	private final boolean fncache;
tikhomirov@74: 	private final boolean dotencode;
tikhomirov@74: 
tikhomirov@74: 	public StoragePathHelper(boolean isStore, boolean isFncache, boolean isDotencode) {
tikhomirov@74: 		store = isStore;
tikhomirov@74: 		fncache = isFncache;
tikhomirov@74: 		dotencode = isDotencode;
tikhomirov@74: 	}
tikhomirov@74: 
tikhomirov@74: 	// FIXME document what path argument is, whether it includes .i or .d, and whether it's 'normalized' (slashes) or not.
tikhomirov@74: 	// since .hg/store keeps both .i files and files without extension (e.g. fncache), guees, for data == false 
tikhomirov@74: 	// we shall assume path has extension
tikhomirov@292: 	public CharSequence rewrite(CharSequence p) {
tikhomirov@74: 		final String STR_STORE = "store/";
tikhomirov@74: 		final String STR_DATA = "data/";
tikhomirov@74: 		final String STR_DH = "dh/";
tikhomirov@83: 		final String reservedChars = "\\:*?\"<>|";
tikhomirov@83: 		char[] hexByte = new char[2];
tikhomirov@74: 		
tikhomirov@292: 		String path = p.toString();
tikhomirov@74: 		path = path.replace(".hg/", ".hg.hg/").replace(".i/", ".i.hg/").replace(".d/", ".d.hg/");
tikhomirov@74: 		StringBuilder sb = new StringBuilder(path.length() << 1);
tikhomirov@74: 		if (store || fncache) {
tikhomirov@74: 			// encodefilename
tikhomirov@74: 			for (int i = 0; i < path.length(); i++) {
tikhomirov@74: 				final char ch = path.charAt(i);
tikhomirov@74: 				if (ch >= 'a' && ch <= 'z') {
tikhomirov@74: 					sb.append(ch); // POIRAE
tikhomirov@74: 				} else if (ch >= 'A' && ch <= 'Z') {
tikhomirov@74: 					sb.append('_');
tikhomirov@74: 					sb.append(Character.toLowerCase(ch)); // Perhaps, (char) (((int) ch) + 32)? Even better, |= 0x20? 
tikhomirov@83: 				} else if (reservedChars.indexOf(ch) != -1) {
tikhomirov@74: 					sb.append('~');
tikhomirov@83: 					sb.append(toHexByte(ch, hexByte));
tikhomirov@74: 				} else if ((ch >= '~' /*126*/ && ch <= 255) || ch < ' ' /*32*/) {
tikhomirov@74: 					sb.append('~');
tikhomirov@74: 					sb.append(toHexByte(ch, hexByte));
tikhomirov@74: 				} else if (ch == '_') {
tikhomirov@74: 					sb.append('_');
tikhomirov@74: 					sb.append('_');
tikhomirov@74: 				} else {
tikhomirov@74: 					sb.append(ch);
tikhomirov@74: 				}
tikhomirov@74: 			}
tikhomirov@74: 			// auxencode
tikhomirov@74: 			if (fncache) {
tikhomirov@83: 				encodeWindowsDeviceNames(sb);
tikhomirov@83: 			}
tikhomirov@83: 		}
tikhomirov@83: 		final int MAX_PATH_LEN = 120;
tikhomirov@83: 		if (fncache && (sb.length() + STR_DATA.length() + ".i".length() > MAX_PATH_LEN)) {
tikhomirov@83: 			String digest = new DigestHelper().sha1(STR_DATA, path, ".i").asHexString();
tikhomirov@83: 			final int DIR_PREFIX_LEN = 8;
tikhomirov@83: 			 // not sure why (-4) is here. 120 - 40 = up to 80 for path with ext. dh/ + ext(.i) = 3+2
tikhomirov@83: 			final int MAX_DIR_PREFIX = 8 * (DIR_PREFIX_LEN + 1) - 4;
tikhomirov@83: 			sb = new StringBuilder(MAX_PATH_LEN);
tikhomirov@83: 			for (int i = 0; i < path.length(); i++) {
tikhomirov@83: 				final char ch = path.charAt(i);
tikhomirov@83: 				if (ch >= 'a' && ch <= 'z') {
tikhomirov@83: 					sb.append(ch);
tikhomirov@83: 				} else if (ch >= 'A' && ch <= 'Z') {
tikhomirov@83: 					sb.append((char) (ch | 0x20)); // lowercase 
tikhomirov@83: 				} else if (reservedChars.indexOf(ch) != -1) {
tikhomirov@83: 					sb.append('~');
tikhomirov@83: 					sb.append(toHexByte(ch, hexByte));
tikhomirov@83: 				} else if ((ch >= '~' /*126*/ && ch <= 255) || ch < ' ' /*32*/) {
tikhomirov@83: 					sb.append('~');
tikhomirov@83: 					sb.append(toHexByte(ch, hexByte));
tikhomirov@83: 				} else {
tikhomirov@83: 					sb.append(ch);
tikhomirov@83: 				}
tikhomirov@83: 			}
tikhomirov@83: 			encodeWindowsDeviceNames(sb);
tikhomirov@83: 			int fnameStart = sb.lastIndexOf("/"); // since we rewrite file names, it never ends with slash (for dirs, I'd pass length-2);
tikhomirov@83: 			StringBuilder completeHashName = new StringBuilder(MAX_PATH_LEN);
tikhomirov@83: 			completeHashName.append(STR_STORE);
tikhomirov@83: 			completeHashName.append(STR_DH);
tikhomirov@83: 			if (fnameStart == -1) {
tikhomirov@83: 				// no dirs, just long filename
tikhomirov@83: 				sb.setLength(MAX_PATH_LEN - 40 /*digest.length()*/ - STR_DH.length() - ".i".length());
tikhomirov@83: 				completeHashName.append(sb);
tikhomirov@83: 			} else {
tikhomirov@83: 				StringBuilder sb2 = new StringBuilder(MAX_PATH_LEN);
tikhomirov@83: 				int x = 0;
tikhomirov@74: 				do {
tikhomirov@74: 					int i = sb.indexOf("/", x);
tikhomirov@83: 					final int sb2Len = sb2.length(); 
tikhomirov@83: 					if (i-x <= DIR_PREFIX_LEN) { // a b c d e f g h /
tikhomirov@83: 						sb2.append(sb, x, i + 1); // with slash
tikhomirov@83: 					} else {
tikhomirov@83: 						sb2.append(sb, x, x + DIR_PREFIX_LEN);
tikhomirov@83: 						// may unexpectedly end with bad character
tikhomirov@83: 						final int last = sb2.length()-1;
tikhomirov@83: 						char lastChar = sb2.charAt(last); 
tikhomirov@83: 						assert lastChar == sb.charAt(x + DIR_PREFIX_LEN - 1);
tikhomirov@83: 						if (lastChar == '.' || lastChar == ' ') {
tikhomirov@83: 							sb2.setCharAt(last, '_');
tikhomirov@74: 						}
tikhomirov@83: 						sb2.append('/');
tikhomirov@74: 					}
tikhomirov@83: 					if (sb2.length()-1 > MAX_DIR_PREFIX) {
tikhomirov@83: 						sb2.setLength(sb2Len); // strip off last segment, it's too much
tikhomirov@83: 						break;
tikhomirov@74: 					}
tikhomirov@83: 					x = i+1; 
tikhomirov@83: 				} while (x < fnameStart);
tikhomirov@83: 				assert sb2.charAt(sb2.length() - 1) == '/';
tikhomirov@83: 				int left = MAX_PATH_LEN - sb2.length() - 40 /*digest.length()*/ - STR_DH.length() - ".i".length();
tikhomirov@83: 				assert left >= 0;
tikhomirov@83: 				fnameStart++; // move from / to actual name
tikhomirov@83: 				sb2.append(sb, fnameStart, fnameStart + left > sb.length() ? sb.length() : fnameStart+left);
tikhomirov@83: 				completeHashName.append(sb2);
tikhomirov@74: 			}
tikhomirov@83: 			completeHashName.append(digest);
tikhomirov@83: 			sb = completeHashName;
tikhomirov@83: 		} else if (store) {
tikhomirov@74: 			sb.insert(0, STR_STORE + STR_DATA);
tikhomirov@74: 		}
tikhomirov@74: 		sb.append(".i");
tikhomirov@74: 		return sb.toString();
tikhomirov@74: 	}
tikhomirov@83: 	
tikhomirov@83: 	private void encodeWindowsDeviceNames(StringBuilder sb) {
tikhomirov@83: 		char[] hexByte = new char[2];
tikhomirov@83: 		int x = 0; // last segment start
tikhomirov@83: 		final TreeSet<String> windowsReservedFilenames = new TreeSet<String>();
tikhomirov@83: 		windowsReservedFilenames.addAll(Arrays.asList("con prn aux nul com1 com2 com3 com4 com5 com6 com7 com8 com9 lpt1 lpt2 lpt3 lpt4 lpt5 lpt6 lpt7 lpt8 lpt9".split(" "))); 
tikhomirov@83: 		do {
tikhomirov@83: 			int i = sb.indexOf("/", x);
tikhomirov@83: 			if (i == -1) {
tikhomirov@83: 				i = sb.length();
tikhomirov@83: 			}
tikhomirov@83: 			// windows reserved filenames are at least of length 3 
tikhomirov@83: 			if (i - x >= 3) {
tikhomirov@83: 				boolean found = false;
tikhomirov@83: 				if (i-x == 3 || i-x == 4) {
tikhomirov@83: 					found = windowsReservedFilenames.contains(sb.subSequence(x, i));
tikhomirov@83: 				} else if (sb.charAt(x+3) == '.') { // implicit i-x > 3
tikhomirov@83: 					found = windowsReservedFilenames.contains(sb.subSequence(x, x+3));
tikhomirov@83: 				} else if (i-x > 4 && sb.charAt(x+4) == '.') {
tikhomirov@83: 					found = windowsReservedFilenames.contains(sb.subSequence(x, x+4));
tikhomirov@83: 				}
tikhomirov@83: 				if (found) {
tikhomirov@83: 					sb.insert(x+3, toHexByte(sb.charAt(x+2), hexByte));
tikhomirov@83: 					sb.setCharAt(x+2, '~');
tikhomirov@83: 					i += 2;
tikhomirov@83: 				}
tikhomirov@83: 			}
tikhomirov@83: 			if (dotencode && (sb.charAt(x) == '.' || sb.charAt(x) == ' ')) {
tikhomirov@83: 				sb.insert(x+1, toHexByte(sb.charAt(x), hexByte));
tikhomirov@83: 				sb.setCharAt(x, '~'); // setChar *after* charAt/insert to get ~2e, not ~7e for '.'
tikhomirov@83: 				i += 2;
tikhomirov@83: 			}
tikhomirov@83: 			x = i+1;
tikhomirov@83: 		} while (x < sb.length());
tikhomirov@83: 	}
tikhomirov@74: 
tikhomirov@74: 	private static char[] toHexByte(int ch, char[] buf) {
tikhomirov@74: 		assert buf.length > 1;
tikhomirov@74: 		final String hexDigits = "0123456789abcdef";
tikhomirov@74: 		buf[0] = hexDigits.charAt((ch & 0x00F0) >>> 4);
tikhomirov@74: 		buf[1] = hexDigits.charAt(ch & 0x0F);
tikhomirov@74: 		return buf;
tikhomirov@74: 	}
tikhomirov@74: }