tikhomirov@413: /*
tikhomirov@413:  * Copyright (c) 2012 TMate Software Ltd
tikhomirov@413:  *  
tikhomirov@413:  * This program is free software; you can redistribute it and/or modify
tikhomirov@413:  * it under the terms of the GNU General Public License as published by
tikhomirov@413:  * the Free Software Foundation; version 2 of the License.
tikhomirov@413:  *
tikhomirov@413:  * This program is distributed in the hope that it will be useful,
tikhomirov@413:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
tikhomirov@413:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
tikhomirov@413:  * GNU General Public License for more details.
tikhomirov@413:  *
tikhomirov@413:  * For information on how to redistribute this software under
tikhomirov@413:  * the terms of a license other than GNU General Public License
tikhomirov@413:  * contact TMate Software at support@hg4j.com
tikhomirov@413:  */
tikhomirov@413: package org.tmatesoft.hg.util;
tikhomirov@413: 
tikhomirov@456: import static org.tmatesoft.hg.util.LogFacility.Severity.Warn;
tikhomirov@456: 
tikhomirov@413: import java.io.File;
tikhomirov@413: import java.io.IOException;
tikhomirov@413: import java.util.ArrayList;
tikhomirov@413: import java.util.Arrays;
tikhomirov@413: import java.util.Collections;
tikhomirov@413: import java.util.HashMap;
tikhomirov@413: import java.util.HashSet;
tikhomirov@413: import java.util.List;
tikhomirov@413: import java.util.Map;
tikhomirov@413: import java.util.Set;
tikhomirov@413: import java.util.TreeMap;
tikhomirov@413: import java.util.regex.Matcher;
tikhomirov@413: import java.util.regex.Pattern;
tikhomirov@413: 
tikhomirov@425: import org.tmatesoft.hg.core.SessionContext;
tikhomirov@413: import org.tmatesoft.hg.internal.Internals;
tikhomirov@413: import org.tmatesoft.hg.internal.ProcessExecHelper;
tikhomirov@413: 
tikhomirov@413: /**
tikhomirov@413:  * Utility to collect executable files and symbolic links in a directory.
tikhomirov@413:  * 
tikhomirov@413:  * 
tikhomirov@413:  * Not public as present approach (expect file but collect once per directory) may need to be made explicit
tikhomirov@413:  * 
tikhomirov@413:  * TODO post-1.0 Add Linux-specific set of tests (similar to my test-flags repository, with symlink, executable and regular file,
tikhomirov@413:  * and few revisions where link and exec flags change. +testcase when link points to non-existing file (shall not report as missing, 
tikhomirov@413:  * iow either FileInfo.exist() shall respect symlinks or WCSC account for )
tikhomirov@413:  * 
tikhomirov@413:  * TODO post-1.0 Add extraction of link modification time, see RegularFileInfo#lastModified()
tikhomirov@413:  * 
tikhomirov@413:  * @author Artem Tikhomirov
tikhomirov@423:  * @author TMate Software Ltd.
tikhomirov@413:  */
tikhomirov@413: /*package-local*/ class RegularFileStats {
tikhomirov@413: 	private boolean isExec, isSymlink;
tikhomirov@413: 	private String symlinkValue;
tikhomirov@413: 	private final List<String> command;
tikhomirov@413: 	private final ProcessExecHelper execHelper;
tikhomirov@413: 	private final Matcher linkMatcher, execMatcher;
tikhomirov@425: 	private final SessionContext sessionContext;
tikhomirov@413: 	
tikhomirov@413: 	
tikhomirov@413: 	// directory name to (short link name -> link target)
tikhomirov@413: 	private Map<String, Map<String, String>> dir2links = new TreeMap<String, Map<String, String>>();
tikhomirov@413: 	// directory name to set of executable file short names
tikhomirov@413: 	private Map<String, Set<String>> dir2execs = new TreeMap<String, Set<String>>();
tikhomirov@413: 
tikhomirov@413: 
tikhomirov@425: 	RegularFileStats(SessionContext ctx) {
tikhomirov@425: 		sessionContext = ctx;
tikhomirov@413: 		if (Internals.runningOnWindows()) {
tikhomirov@413: 			// XXX this implementation is not yet tested against any Windows repository, 
tikhomirov@413: 			// only against sample dir listings. As long as Mercurial doesn't handle Windows
tikhomirov@413: 			// links, we don't really need this
tikhomirov@413: 			command = Arrays.asList("cmd", "/c", "dir");
tikhomirov@413: 			// Windows patterns need to work against full directory listing (I didn't find a way 
tikhomirov@413: 			// to list single file with its attributes like SYMLINK) 
tikhomirov@413: 			Pattern pLink = Pattern.compile("^\\S+.*\\s+<SYMLINK>\\s+(\\S.*)\\s+\\[(.+)\\]$", Pattern.MULTILINE);
tikhomirov@413: 			Pattern pExec = Pattern.compile("^\\S+.*\\s+\\d+\\s+(\\S.*\\.exe)$", Pattern.MULTILINE);
tikhomirov@413: 			linkMatcher = pLink.matcher("");
tikhomirov@413: 			execMatcher = pExec.matcher("");
tikhomirov@413: 		} else {
tikhomirov@413: 			command = Arrays.asList("/bin/ls", "-l", "-Q"); // -Q is essential to get quoted name - the only way to
tikhomirov@413: 			// tell exact file name (which may start or end with spaces.
tikhomirov@413: 			Pattern pLink = Pattern.compile("^lrwxrwxrwx\\s.*\\s\"(.*)\"\\s+->\\s+\"(.*)\"$", Pattern.MULTILINE);
tikhomirov@413: 			// pLink: group(1) is full name if single file listing (ls -l /usr/bin/java) and short name if directory listing (ls -l /usr/bin)
tikhomirov@413: 			//        group(2) is link target
tikhomirov@413: 			Pattern pExec = Pattern.compile("^-..[sx]..[sx]..[sx]\\s.*\\s\"(.+)\"$", Pattern.MULTILINE);
tikhomirov@413: 			// pExec: group(1) is name of executable file
tikhomirov@413: 			linkMatcher = pLink.matcher("");
tikhomirov@413: 			execMatcher = pExec.matcher("");
tikhomirov@413: 		}
tikhomirov@413: 		execHelper = new ProcessExecHelper();
tikhomirov@413: 	}
tikhomirov@413: 
tikhomirov@425: 	/**
tikhomirov@425: 	 * Fails silently indicating false for both x and l in case interaction with file system failed
tikhomirov@425: 	 * @param f file to check, doesn't need to exist
tikhomirov@425: 	 */
tikhomirov@413: 	public void init(File f) {
tikhomirov@425: 		isExec = isSymlink = false;
tikhomirov@425: 		symlinkValue = null;
tikhomirov@425: 		//
tikhomirov@413: 		// can't check isFile because Java would say false for a symlink with non-existing target
tikhomirov@413: 		if (f.isDirectory()) {
tikhomirov@413: 			// perhaps, shall just collect stats for all files and set false to exec/link flags?
tikhomirov@429: 			throw new IllegalArgumentException();
tikhomirov@413: 		}
tikhomirov@413: 		final String dirName = f.getParentFile().getAbsolutePath();
tikhomirov@413: 		final String fileName = f.getName();
tikhomirov@413: 		Map<String, String> links = dir2links.get(dirName);
tikhomirov@413: 		Set<String> execs = dir2execs.get(dirName);
tikhomirov@413: 		if (links == null || execs == null) {
tikhomirov@413: 			try {
tikhomirov@413: 				ArrayList<String> cmd = new ArrayList<String>(command);
tikhomirov@413: 				cmd.add(dirName);
tikhomirov@413: 				CharSequence result = execHelper.exec(cmd);
tikhomirov@413: 				
tikhomirov@413: 				if (execMatcher.reset(result).find()) {
tikhomirov@413: 					execs = new HashSet<String>();
tikhomirov@413: 					do {
tikhomirov@413: 						execs.add(execMatcher.group(1));
tikhomirov@413: 					} while (execMatcher.find());
tikhomirov@413: 				} else {
tikhomirov@413: 					execs = Collections.emptySet(); // indicate we tried and found nothing
tikhomirov@413: 				}
tikhomirov@413: 				if (linkMatcher.reset(result).find()) {
tikhomirov@413: 					links = new HashMap<String, String>();
tikhomirov@413: 					do {
tikhomirov@413: 						links.put(linkMatcher.group(1), linkMatcher.group(2));
tikhomirov@413: 					} while (linkMatcher.find());
tikhomirov@413: 				} else {
tikhomirov@413: 					links = Collections.emptyMap();
tikhomirov@413: 				}
tikhomirov@413: 				dir2links.put(dirName, links);
tikhomirov@413: 				dir2execs.put(dirName, execs);
tikhomirov@425: 				isExec = execs.contains(fileName);
tikhomirov@425: 				isSymlink = links.containsKey(fileName);
tikhomirov@425: 				if (isSymlink) {
tikhomirov@425: 					symlinkValue = links.get(fileName);
tikhomirov@425: 				} else {
tikhomirov@425: 					symlinkValue = null;
tikhomirov@425: 				}
tikhomirov@413: 			} catch (InterruptedException ex) {
tikhomirov@456: 				sessionContext.getLog().dump(getClass(), Warn, ex, String.format("Failed to detect flags for %s", f));
tikhomirov@413: 				// try again? ensure not too long? stop right away?
tikhomirov@425: 				// IGNORE, keep isExec and isSymlink false
tikhomirov@413: 			} catch (IOException ex) {
tikhomirov@456: 				sessionContext.getLog().dump(getClass(), Warn, ex, String.format("Failed to detect flags for %s", f));
tikhomirov@425: 				// IGNORE, keep isExec and isSymlink false
tikhomirov@413: 			}
tikhomirov@413: 		}
tikhomirov@413: 	}
tikhomirov@413: 
tikhomirov@413: 	public boolean isExecutable() {
tikhomirov@413: 		return isExec;
tikhomirov@413: 	}
tikhomirov@413: 	
tikhomirov@413: 	public boolean isSymlink() {
tikhomirov@413: 		return isSymlink;
tikhomirov@413: 	}
tikhomirov@413: 
tikhomirov@413: 	public String getSymlinkTarget() {
tikhomirov@413: 		if (isSymlink) {
tikhomirov@413: 			return symlinkValue;
tikhomirov@413: 		}
tikhomirov@413: 		throw new UnsupportedOperationException();
tikhomirov@413: 	}
tikhomirov@413: }