/*
* Copyright (C) 2014, Alexey Kuznetsov <axet@me.com>
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.transport;
import static java.nio.charset.StandardCharsets.UTF_8;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.time.Instant;
import java.util.Collection;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.TreeMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.eclipse.jgit.util.FS;
NetRC file parser.
Since: 3.5
/**
* NetRC file parser.
*
* @since 3.5
*/
public class NetRC {
static final Pattern NETRC = Pattern.compile("(\\S+)"); //$NON-NLS-1$
'default' netrc entry. This is the same as machine name except that
default matches any name. There can be only one default token, and it
must be after all machine tokens.
/**
* 'default' netrc entry. This is the same as machine name except that
* default matches any name. There can be only one default token, and it
* must be after all machine tokens.
*/
static final String DEFAULT_ENTRY = "default"; //$NON-NLS-1$
.netrc file entry
/**
* .netrc file entry
*/
public static class NetRCEntry {
login netrc entry
/**
* login netrc entry
*/
public String login;
password netrc entry
/**
* password netrc entry
*/
public char[] password;
machine netrc entry
/**
* machine netrc entry
*/
public String machine;
account netrc entry
/**
* account netrc entry
*/
public String account;
macdef netrc entry. Defines a macro. This token functions like the
ftp macdef command functions. A macro is defined with the specified
name; its contents begins with the next .netrc line and continues
until a null line (consecutive new-line characters) is encountered.
If a macro named init is defined, it is automatically executed as the
last step in the auto-login process.
/**
* macdef netrc entry. Defines a macro. This token functions like the
* ftp macdef command functions. A macro is defined with the specified
* name; its contents begins with the next .netrc line and continues
* until a null line (consecutive new-line characters) is encountered.
* If a macro named init is defined, it is automatically executed as the
* last step in the auto-login process.
*/
public String macdef;
macro script body of macdef entry.
/**
* macro script body of macdef entry.
*/
public String macbody;
Default constructor
/**
* Default constructor
*/
public NetRCEntry() {
}
boolean complete() {
return login != null && password != null && machine != null;
}
}
private File netrc;
private Instant lastModified;
private Map<String, NetRCEntry> hosts = new HashMap<>();
private static final TreeMap<String, State> STATE = new TreeMap<String, NetRC.State>() {
private static final long serialVersionUID = -4285910831814853334L;
{
put("machine", State.MACHINE); //$NON-NLS-1$
put("login", State.LOGIN); //$NON-NLS-1$
put("password", State.PASSWORD); //$NON-NLS-1$
put(DEFAULT_ENTRY, State.DEFAULT);
put("account", State.ACCOUNT); //$NON-NLS-1$
put("macdef", State.MACDEF); //$NON-NLS-1$
}
};
enum State {
COMMAND, MACHINE, LOGIN, PASSWORD, DEFAULT, ACCOUNT, MACDEF
}
Constructor for NetRC.
/**
* <p>Constructor for NetRC.</p>
*/
public NetRC() {
netrc = getDefaultFile();
if (netrc != null)
parse();
}
Constructor for NetRC.
Params: - netrc –
the .netrc file
/**
* <p>Constructor for NetRC.</p>
*
* @param netrc
* the .netrc file
*/
public NetRC(File netrc) {
this.netrc = netrc;
parse();
}
private static File getDefaultFile() {
File home = FS.DETECTED.userHome();
File netrc = new File(home, ".netrc"); //$NON-NLS-1$
if (netrc.exists())
return netrc;
netrc = new File(home, "_netrc"); //$NON-NLS-1$
if (netrc.exists())
return netrc;
return null;
}
Get entry by host name
Params: - host –
the host name
Returns: entry associated with host name or null
/**
* Get entry by host name
*
* @param host
* the host name
* @return entry associated with host name or null
*/
public NetRCEntry getEntry(String host) {
if (netrc == null)
return null;
if (!this.lastModified
.equals(FS.DETECTED.lastModifiedInstant(this.netrc))) {
parse();
}
NetRCEntry entry = this.hosts.get(host);
if (entry == null)
entry = this.hosts.get(DEFAULT_ENTRY);
return entry;
}
Get all entries collected from .netrc file
Returns: all entries collected from .netrc file
/**
* Get all entries collected from .netrc file
*
* @return all entries collected from .netrc file
*/
public Collection<NetRCEntry> getEntries() {
return hosts.values();
}
private void parse() {
this.hosts.clear();
this.lastModified = FS.DETECTED.lastModifiedInstant(this.netrc);
try (BufferedReader r = new BufferedReader(
new InputStreamReader(new FileInputStream(netrc), UTF_8))) {
String line = null;
NetRCEntry entry = new NetRCEntry();
State state = State.COMMAND;
String macbody = ""; //$NON-NLS-1$
Matcher matcher = NETRC.matcher(""); //$NON-NLS-1$
while ((line = r.readLine()) != null) {
// reading macbody
if (entry.macdef != null && entry.macbody == null) {
if (line.length() == 0) {
entry.macbody = macbody;
macbody = ""; //$NON-NLS-1$
continue;
}
macbody += line + "\n"; //$NON-NLS-1$;
continue;
}
matcher.reset(line);
while (matcher.find()) {
String command = matcher.group().toLowerCase(Locale.ROOT);
if (command.startsWith("#")) { //$NON-NLS-1$
matcher.reset(""); //$NON-NLS-1$
continue;
}
state = STATE.get(command);
if (state == null)
state = State.COMMAND;
switch (state) {
case COMMAND:
break;
case ACCOUNT:
if (entry.account != null && entry.complete()) {
hosts.put(entry.machine, entry);
entry = new NetRCEntry();
}
if (matcher.find())
entry.account = matcher.group();
state = State.COMMAND;
break;
case LOGIN:
if (entry.login != null && entry.complete()) {
hosts.put(entry.machine, entry);
entry = new NetRCEntry();
}
if (matcher.find())
entry.login = matcher.group();
state = State.COMMAND;
break;
case PASSWORD:
if (entry.password != null && entry.complete()) {
hosts.put(entry.machine, entry);
entry = new NetRCEntry();
}
if (matcher.find())
entry.password = matcher.group().toCharArray();
state = State.COMMAND;
break;
case DEFAULT:
if (entry.machine != null && entry.complete()) {
hosts.put(entry.machine, entry);
entry = new NetRCEntry();
}
entry.machine = DEFAULT_ENTRY;
state = State.COMMAND;
break;
case MACDEF:
if (entry.macdef != null && entry.complete()) {
hosts.put(entry.machine, entry);
entry = new NetRCEntry();
}
if (matcher.find())
entry.macdef = matcher.group();
state = State.COMMAND;
break;
case MACHINE:
if (entry.machine != null && entry.complete()) {
hosts.put(entry.machine, entry);
entry = new NetRCEntry();
}
if (matcher.find())
entry.machine = matcher.group();
state = State.COMMAND;
break;
}
}
}
// reading macbody on EOF
if (entry.macdef != null && entry.macbody == null)
entry.macbody = macbody;
if (entry.complete())
hosts.put(entry.machine, entry);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}