tikhomirov@74: /*
tikhomirov@578:  * Copyright (c) 2010-2013 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@2:  */
tikhomirov@74: package org.tmatesoft.hg.repo;
tikhomirov@2: 
tikhomirov@456: import static org.tmatesoft.hg.util.LogFacility.Severity.Warn;
tikhomirov@456: 
tikhomirov@2: import java.io.File;
tikhomirov@181: import java.net.MalformedURLException;
tikhomirov@170: import java.net.URL;
tikhomirov@148: 
tikhomirov@181: import org.tmatesoft.hg.core.HgBadArgumentException;
tikhomirov@423: import org.tmatesoft.hg.core.HgRepositoryNotFoundException;
tikhomirov@295: import org.tmatesoft.hg.core.SessionContext;
tikhomirov@295: import org.tmatesoft.hg.internal.BasicSessionContext;
tikhomirov@181: import org.tmatesoft.hg.internal.ConfigFile;
tikhomirov@169: import org.tmatesoft.hg.internal.DataAccessProvider;
tikhomirov@526: import org.tmatesoft.hg.internal.Internals;
tikhomirov@578: import org.tmatesoft.hg.internal.RequiresFile;
tikhomirov@503: import org.tmatesoft.hg.repo.HgRepoConfig.PathsSection;
tikhomirov@2: 
tikhomirov@2: /**
tikhomirov@148:  * Utility methods to find Mercurial repository at a given location
tikhomirov@74:  * 
tikhomirov@74:  * @author Artem Tikhomirov
tikhomirov@74:  * @author TMate Software Ltd.
tikhomirov@2:  */
tikhomirov@95: public class HgLookup {
tikhomirov@2: 
tikhomirov@181: 	private ConfigFile globalCfg;
tikhomirov@295: 	private SessionContext sessionContext;
tikhomirov@295: 	
tikhomirov@295: 	public HgLookup() {
tikhomirov@295: 	}
tikhomirov@295: 	
tikhomirov@295: 	public HgLookup(SessionContext ctx) {
tikhomirov@295: 		sessionContext = ctx;
tikhomirov@295: 	}
tikhomirov@181: 
tikhomirov@423: 	public HgRepository detectFromWorkingDir() throws HgRepositoryNotFoundException {
tikhomirov@2: 		return detect(System.getProperty("user.dir"));
tikhomirov@2: 	}
tikhomirov@2: 
tikhomirov@423: 	public HgRepository detect(String location) throws HgRepositoryNotFoundException {
tikhomirov@95: 		return detect(new File(location));
tikhomirov@95: 	}
tikhomirov@95: 
tikhomirov@578: 	/**
tikhomirov@578: 	 * Look up repository in specified location and above
tikhomirov@578: 	 * 
tikhomirov@578: 	 * @param location where to look for .hg directory, never <code>null</code>
tikhomirov@578: 	 * @return repository object, never <code>null</code>
tikhomirov@578: 	 * @throws HgRepositoryNotFoundException if no repository found, or repository version is not supported
tikhomirov@578: 	 */
tikhomirov@423: 	public HgRepository detect(File location) throws HgRepositoryNotFoundException {
tikhomirov@492: 		File dir = location.getAbsoluteFile();
tikhomirov@492: 		File repository;
tikhomirov@492: 		do {
tikhomirov@492: 			repository = new File(dir, ".hg");
tikhomirov@492: 			if (repository.exists() && repository.isDirectory()) {
tikhomirov@492: 				break;
tikhomirov@2: 			}
tikhomirov@492: 			repository = null;
tikhomirov@492: 			dir = dir.getParentFile();
tikhomirov@492: 			
tikhomirov@492: 		} while(dir != null);
tikhomirov@492: 		if (repository == null) {
tikhomirov@492: 			throw new HgRepositoryNotFoundException(String.format("Can't locate .hg/ directory of Mercurial repository in %s nor in parent dirs", location)).setLocation(location.getPath());
tikhomirov@148: 		}
tikhomirov@492: 		String repoPath = repository.getParentFile().getAbsolutePath();
tikhomirov@578: 		HgRepository rv = new HgRepository(getContext(), repoPath, repository);
tikhomirov@578: 		int requiresFlags = rv.getImplHelper().getRequiresFlags();
tikhomirov@578: 		if ((requiresFlags & RequiresFile.REVLOGV1) == 0) {
tikhomirov@578: 			throw new HgRepositoryNotFoundException(String.format("%s: repository version is not supported (Mercurial <0.9?)", repoPath)).setLocation(location.getPath());
tikhomirov@578: 		}
tikhomirov@578: 		return rv;
tikhomirov@4: 	}
tikhomirov@169: 	
tikhomirov@425: 	public HgBundle loadBundle(File location) throws HgRepositoryNotFoundException {
tikhomirov@169: 		if (location == null || !location.canRead()) {
tikhomirov@425: 			throw new HgRepositoryNotFoundException(String.format("Can't read file %s", location)).setLocation(String.valueOf(location));
tikhomirov@169: 		}
tikhomirov@357: 		return new HgBundle(getContext(), new DataAccessProvider(getContext()), location).link();
tikhomirov@169: 	}
tikhomirov@181: 	
tikhomirov@181: 	/**
tikhomirov@503: 	 * Try to instantiate remote server using an immediate url or an url from configuration files
tikhomirov@503: 	 * 
tikhomirov@503: 	 * @param key either URL or a key from configuration file that points to remote server; if <code>null</code> or empty string, default remote location of the supplied repository (if any) is looked up
tikhomirov@503: 	 * @param hgRepo optional local repository to get default or otherwise configured remote location
tikhomirov@181: 	 * @return an instance featuring access to remote repository, check {@link HgRemoteRepository#isInvalid()} before actually using it
tikhomirov@181: 	 * @throws HgBadArgumentException if anything is wrong with the remote server's URL
tikhomirov@181: 	 */
tikhomirov@181: 	public HgRemoteRepository detectRemote(String key, HgRepository hgRepo) throws HgBadArgumentException {
tikhomirov@181: 		URL url;
tikhomirov@181: 		Exception toReport;
tikhomirov@181: 		try {
tikhomirov@181: 			url = new URL(key);
tikhomirov@181: 			toReport = null;
tikhomirov@181: 		} catch (MalformedURLException ex) {
tikhomirov@181: 			url = null;
tikhomirov@181: 			toReport = ex;
tikhomirov@181: 		}
tikhomirov@181: 		if (url == null) {
tikhomirov@503: 			String server = null;
tikhomirov@503: 			if (hgRepo != null && !hgRepo.isInvalid()) {
tikhomirov@503: 				PathsSection ps = hgRepo.getConfiguration().getPaths();
tikhomirov@503: 				server = key == null || key.trim().isEmpty() ? ps.getDefault() : ps.getString(key, null);
tikhomirov@503: 			} else if (key == null || key.trim().length() == 0) {
tikhomirov@503: 				throw new HgBadArgumentException("Can't look up empty key in a global configuration", null);
tikhomirov@503: 			}
tikhomirov@503: 			if (server == null) {
tikhomirov@503: 				server = getGlobalConfig().getSection("paths").get(key);
tikhomirov@503: 			}
tikhomirov@181: 			if (server == null) {
tikhomirov@181: 				throw new HgBadArgumentException(String.format("Can't find server %s specification in the config", key), toReport);
tikhomirov@181: 			}
tikhomirov@181: 			try {
tikhomirov@181: 				url = new URL(server);
tikhomirov@181: 			} catch (MalformedURLException ex) {
tikhomirov@181: 				throw new HgBadArgumentException(String.format("Found %s server spec in the config, but failed to initialize with it", key), ex);
tikhomirov@181: 			}
tikhomirov@181: 		}
tikhomirov@295: 		return new HgRemoteRepository(getContext(), url);
tikhomirov@181: 	}
tikhomirov@181: 	
tikhomirov@295: 	public HgRemoteRepository detect(URL url) throws HgBadArgumentException {
tikhomirov@171: 		if (url == null) {
tikhomirov@171: 			throw new IllegalArgumentException();
tikhomirov@171: 		}
tikhomirov@170: 		if (Boolean.FALSE.booleanValue()) {
tikhomirov@526: 			throw Internals.notImplemented();
tikhomirov@170: 		}
tikhomirov@295: 		return new HgRemoteRepository(getContext(), url);
tikhomirov@170: 	}
tikhomirov@181: 
tikhomirov@181: 	private ConfigFile getGlobalConfig() {
tikhomirov@181: 		if (globalCfg == null) {
tikhomirov@483: 			globalCfg = new ConfigFile(getContext());
tikhomirov@295: 			try {
tikhomirov@295: 				globalCfg.addLocation(new File(System.getProperty("user.home"), ".hgrc"));
tikhomirov@483: 			} catch (HgInvalidFileException ex) {
tikhomirov@295: 				// XXX perhaps, makes sense to let caller/client know that we've failed to read global config? 
tikhomirov@456: 				getContext().getLog().dump(getClass(), Warn, ex, null);
tikhomirov@295: 			}
tikhomirov@181: 		}
tikhomirov@181: 		return globalCfg;
tikhomirov@181: 	}
tikhomirov@295: 
tikhomirov@295: 	private SessionContext getContext() {
tikhomirov@295: 		if (sessionContext == null) {
tikhomirov@431: 			sessionContext = new BasicSessionContext(null);
tikhomirov@295: 		}
tikhomirov@295: 		return sessionContext;
tikhomirov@295: 	}
tikhomirov@2: }