# [PATCH JGIT] Compute the author/commiter name and email from the git configuration 10 messages from 2009-02-03 to 2009-02-04. Participants: Yann Simon, Shawn O. Pearce, Johannes Schindelin, Robin Rosenberg. Thread: https://gitlist.dev/t/17538 ## Yann Simon, 2009-02-03 21:13 Subject: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <1233695594.8042.6.camel@localhost> URL: https://gitlist.dev/e/1233695594.8042.6.camel%40localhost ``` The author/commiter name and email are retrieved from the system configuration and the local and global git configurations. When the name is not available, propose one default by using the system user name. When the email is not available, propose one default by concatenate the user name and the host name. The author name and email are used as default value in the author field while committing with the GUI. Fix issue 47 (field Author don't fill) Signed-off-by: Yann Simon --- .../egit/ui/internal/actions/CommitAction.java | 17 ++++ .../org/spearce/jgit/lib/RepositoryConfigTest.java | 56 +++++++++++ .../src/org/spearce/jgit/lib/Constants.java | 16 +++ .../src/org/spearce/jgit/lib/RepositoryConfig.java | 97 ++++++++++++++++++++ 4 files changed, 186 insertions(+), 0 deletions(-) diff --git a/org.spearce.egit.ui/src/org/spearce/egit/ui/internal/actions/CommitAction.java b/org.spearce.egit.ui/src/org/spearce/egit/ui/internal/actions/CommitAction.java index 17232d6..456745c 100644 --- a/org.spearce.egit.ui/src/org/spearce/egit/ui/internal/actions/CommitAction.java +++ b/org.spearce.egit.ui/src/org/spearce/egit/ui/internal/actions/CommitAction.java @@ -41,6 +41,7 @@ import org.spearce.jgit.lib.PersonIdent; import org.spearce.jgit.lib.RefUpdate; import org.spearce.jgit.lib.Repository; +import org.spearce.jgit.lib.RepositoryConfig; import org.spearce.jgit.lib.Tree; import org.spearce.jgit.lib.TreeEntry; import org.spearce.jgit.lib.GitIndex.Entry; @@ -70,8 +71,10 @@ public void run(IAction act) { } Repository[] repos = getRepositoriesFor(getProjectsForSelectedResources()); + Repository repository = null; amendAllowed = repos.length == 1; for (Repository repo : repos) { + repository = repo; if (!repo.getRepositoryState().canCommit()) { MessageDialog.openError(getTargetPart().getSite().getShell(), "Cannot commit now", "Repository state:" @@ -95,12 +98,26 @@ public void run(IAction act) { } } + assert repository != null; + RepositoryConfig repositoryConfig = repository.getConfig(); + String author = null; + String username = repositoryConfig.getAuthorName(); + if (username != null && username.length() != 0) { + author = username; + String email = repositoryConfig.getAuthorEmail(); + if (email != null && email.length() != 0) { + author = author + " <" + email + ">"; + } + } + loadPreviousCommit(); CommitDialog commitDialog = new CommitDialog(getTargetPart().getSite().getShell()); commitDialog.setAmending(amending); commitDialog.setAmendAllowed(amendAllowed); commitDialog.setFileList(files); + commitDialog.setAuthor(author); + if (previousCommit != null) commitDialog.setPreviousCommitMessage(previousCommit.getMessage()); diff --git a/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryConfigTest.java b/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryConfigTest.java index 34ce04a..4f53ca0 100644 --- a/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryConfigTest.java +++ b/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryConfigTest.java @@ -42,6 +42,8 @@ import java.io.File; import java.io.IOException; +import java.net.InetAddress; +import java.net.UnknownHostException; import java.util.Arrays; import java.util.LinkedList; @@ -116,4 +118,58 @@ public void test006_readCaseInsensitive() throws IOException { assertEquals(true, repositoryConfig.getBoolean("foo", null, "bar", false)); assertEquals("", repositoryConfig.getString("foo", null, "bar")); } + + public void test007_readUserInfos() throws IOException { + final File globalConfig = writeTrashFile("global.config", ""); + final File localConfig = writeTrashFile("global.config", ""); + System.clearProperty(Constants.OS_USER_NAME_KEY); + System.clearProperty(Constants.GIT_AUTHOR_NAME_KEY); + System.clearProperty(Constants.GIT_AUTHOR_EMAIL_KEY); + + RepositoryConfig globalRepositoryConfig = new RepositoryConfig(null, globalConfig); + RepositoryConfig localRepositoryConfig = new RepositoryConfig(globalRepositoryConfig, localConfig); + + String authorName; + String authorEmail; + + authorName = localRepositoryConfig.getAuthorName(); + authorEmail = localRepositoryConfig.getAuthorEmail(); + assertNull(authorName); + assertNull(authorEmail); + + System.setProperty(Constants.OS_USER_NAME_KEY, "os user name"); + authorName = localRepositoryConfig.getAuthorName(); + assertEquals("os user name", authorName); + InetAddress localMachine; + try { + localMachine = InetAddress.getLocalHost(); + String hostname = localMachine.getHostName(); + authorEmail = localRepositoryConfig.getAuthorEmail(); + assertEquals("os user name@" + hostname, authorEmail); + } catch (UnknownHostException e) { + // we do nothing + } + + + System.setProperty(Constants.GIT_AUTHOR_NAME_KEY, "git author name"); + System.setProperty(Constants.GIT_AUTHOR_EMAIL_KEY, "author@email"); + authorName = localRepositoryConfig.getAuthorName(); + authorEmail = localRepositoryConfig.getAuthorEmail(); + assertEquals("git author name", authorName); + assertEquals("author@email", authorEmail); + + globalRepositoryConfig.setString("user", null, "name", "global username"); + globalRepositoryConfig.setString("user", null, "email", "author@globalemail"); + authorName = localRepositoryConfig.getAuthorName(); + authorEmail = localRepositoryConfig.getAuthorEmail(); + assertEquals("global username", authorName); + assertEquals("author@globalemail", authorEmail); + + localRepositoryConfig.setString("user", null, "name", "local username"); + localRepositoryConfig.setString("user", null, "email", "author@localemail"); + authorName = localRepositoryConfig.getAuthorName(); + authorEmail = localRepositoryConfig.getAuthorEmail(); + assertEquals("local username", authorName); + assertEquals("author@localemail", authorEmail); + } } diff --git a/org.spearce.jgit/src/org/spearce/jgit/lib/Constants.java b/org.spearce.jgit/src/org/spearce/jgit/lib/Constants.java index 8f093d6..372fba5 100644 --- a/org.spearce.jgit/src/org/spearce/jgit/lib/Constants.java +++ b/org.spearce.jgit/src/org/spearce/jgit/lib/Constants.java @@ -228,6 +228,22 @@ /** Packed refs file */ public static final String PACKED_REFS = "packed-refs"; + /** The environment variable that contains the system user name */ + public static final String OS_USER_NAME_KEY = "user.name"; + + /** The environment variable that contains the author's name */ + public static final String GIT_AUTHOR_NAME_KEY = "GIT_AUTHOR_NAME"; + + /** The environment variable that contains the author's email */ + public static final String GIT_AUTHOR_EMAIL_KEY = "GIT_AUTHOR_EMAIL"; + + /** The environment variable that contains the commiter's name */ + public static final String GIT_COMMITER_NAME_KEY = "GIT_COMMITER_NAME"; + + /** The environment variable that contains the commiter's email */ + public static final String GIT_COMMITER_EMAIL_KEY = "GIT_COMMITER_EMAIL"; + + /** * Create a new digest function for objects. * diff --git a/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java b/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java index 7df90cd..5821f83 100644 --- a/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java +++ b/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java @@ -50,6 +50,8 @@ import java.io.InputStreamReader; import java.io.OutputStreamWriter; import java.io.PrintWriter; +import java.net.InetAddress; +import java.net.UnknownHostException; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; @@ -98,6 +100,8 @@ public static RepositoryConfig openUserConfig() { private Map byName; + private String hostname; + private static final String MAGIC_EMPTY_VALUE = "%%magic%%empty%%"; RepositoryConfig(final Repository repo) { @@ -308,6 +312,83 @@ public String getString(final String section, String subsection, final String na return result; } + /** + * @return the author name as defined in the git variables + * and configurations. If no name could be found, try + * to use the system user name instead. + */ + public String getAuthorName() { + return getUsernameInternal(Constants.GIT_AUTHOR_NAME_KEY); + } + + /** + * @return the commiter name as defined in the git variables + * and configurations. If no name could be found, try + * to use the system user name instead. + */ + public String getCommiterName() { + return getUsernameInternal(Constants.GIT_COMMITER_NAME_KEY); + } + + private String getUsernameInternal(String gitVariableKey) { + // try to get the user name from the local and global configurations. + String username = getString("user", null, "name"); + + if (username == null) { + // try to get the user name for the system property GIT_XXX_NAME + username = System.getProperty(gitVariableKey); + } + if (username == null) { + // get the system user name + username = System.getProperty(Constants.OS_USER_NAME_KEY); + } + + return username; + } + + /** + * @return the author email as defined in git variables and + * configurations. If no email could be found, try to + * propose one default with the author name and the + * host name. + */ + public String getAuthorEmail() { + return getUserEmailInternal(Constants.GIT_AUTHOR_EMAIL_KEY, true); + } + + /** + * @return the commiter email as defined in git variables and + * configurations. If no email could be found, try to + * propose one default with the author name and the + * host name. + */ + public String getCommiterEmail() { + return getUserEmailInternal(Constants.GIT_COMMITER_EMAIL_KEY, false); + } + + private String getUserEmailInternal(String gitVariableKey, boolean author) { + // try to get the email from the local and global configs. + String email = getString("user", null, "email"); + + if (email == null) { + // try to get the email for the system property GIT_XXX_EMAIL + email = System.getProperty(gitVariableKey); + } + + if (email == null) { + // try to construct an email + String userName = author ? getAuthorName() : getCommiterName(); + if (userName != null && userName.length() != 0) { + String hostnameTmp = getHostname(); + if (hostnameTmp != null && hostnameTmp.length() != 0) { + email = userName + "@" + hostnameTmp; + } + } + } + + return email; + } + private String getRawString(final String section, final String subsection, final String name) { final Object o = getRawEntry(section, subsection, name); @@ -957,4 +1038,20 @@ private static boolean eq(final String a, final String b) { return a.equalsIgnoreCase(b); } } + + /** + * @return the hostname + */ + public String getHostname() { + if (hostname == null) { + InetAddress localMachine; + try { + localMachine = InetAddress.getLocalHost(); + hostname = localMachine.getHostName(); + } catch (UnknownHostException e) { + // we do nothing + } + } + return hostname; + } } -- 1.6.0.6 ``` ## Shawn O. Pearce, 2009-02-03 23:13 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <20090203231357.GZ26880@spearce.org> URL: https://gitlist.dev/e/20090203231357.GZ26880%40spearce.org In-Reply-To: <1233695594.8042.6.camel@localhost> ``` Yann Simon wrote: > index 7df90cd..5821f83 100644 > --- a/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java > +++ b/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java > @@ -50,6 +50,8 @@ > import java.io.InputStreamReader; > import java.io.OutputStreamWriter; > import java.io.PrintWriter; > +import java.net.InetAddress; > +import java.net.UnknownHostException; > import java.util.ArrayList; > import java.util.Collections; > import java.util.HashMap; > @@ -98,6 +100,8 @@ public static RepositoryConfig openUserConfig() { > > private Map byName; > > + private String hostname; > + > private static final String MAGIC_EMPTY_VALUE = "%%magic%%empty%%"; > > RepositoryConfig(final Repository repo) { > @@ -308,6 +312,83 @@ public String getString(final String section, String subsection, final String na > return result; > } > > + /** > + * @return the author name as defined in the git variables > + * and configurations. If no name could be found, try > + * to use the system user name instead. > + */ > + public String getAuthorName() { > + return getUsernameInternal(Constants.GIT_AUTHOR_NAME_KEY); > + } > + > + /** > + * @return the commiter name as defined in the git variables > + * and configurations. If no name could be found, try > + * to use the system user name instead. > + */ > + public String getCommiterName() { > + return getUsernameInternal(Constants.GIT_COMMITER_NAME_KEY); > + } > + > + private String getUsernameInternal(String gitVariableKey) { > + // try to get the user name from the local and global configurations. > + String username = getString("user", null, "name"); > + > + if (username == null) { > + // try to get the user name for the system property GIT_XXX_NAME > + username = System.getProperty(gitVariableKey); Shouldn't that be System.getenv()? > + private String getUserEmailInternal(String gitVariableKey, boolean author) { > + // try to get the email from the local and global configs. > + String email = getString("user", null, "email"); > + > + if (email == null) { > + // try to get the email for the system property GIT_XXX_EMAIL > + email = System.getProperty(gitVariableKey); Again, System.getenv()? > + public String getHostname() { > + if (hostname == null) { > + InetAddress localMachine; > + try { > + localMachine = InetAddress.getLocalHost(); > + hostname = localMachine.getHostName(); > + } catch (UnknownHostException e) { > + // we do nothing > + } > + } > + return hostname; Do we want getHostName() or getCanonicalHostName() here? I think we'd want getCanonicalHostName(). Should we be caching this at the RepositoryConfig level, or at the whole JVM level (in a static). If the application is long-running its likely to keep the same RepositoryConfig instance around for the life of that JVM, so we'd only make this request once. Thus any change in hostname while the application is running would probably not take effect until after restart. But any long running app is also likely to access more than one Repository, and thus more than one RepositoryConfig, so they should at least use consistent names, even if the underlying hostname has changed. IMHO, just cache it in a static on first demand. -- Shawn. ``` ## Johannes Schindelin, 2009-02-03 23:20 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: URL: https://gitlist.dev/e/alpine.DEB.1.00.0902040019030.9822%40pacific.mpi-cbg.de In-Reply-To: <20090203231357.GZ26880@spearce.org> ``` Hi, On Tue, 3 Feb 2009, Shawn O. Pearce wrote: > Yann Simon wrote: > > > @@ -308,6 +312,83 @@ public String getString(final String section, String subsection, final String na > > return result; > > } > > > > + /** > > + * @return the author name as defined in the git variables > > + * and configurations. If no name could be found, try > > + * to use the system user name instead. > > + */ > > + public String getAuthorName() { > > + return getUsernameInternal(Constants.GIT_AUTHOR_NAME_KEY); > > + } > > + > > + /** > > + * @return the commiter name as defined in the git variables > > + * and configurations. If no name could be found, try > > + * to use the system user name instead. > > + */ > > + public String getCommiterName() { > > + return getUsernameInternal(Constants.GIT_COMMITER_NAME_KEY); > > + } > > + > > + private String getUsernameInternal(String gitVariableKey) { > > + // try to get the user name from the local and global configurations. > > + String username = getString("user", null, "name"); > > + > > + if (username == null) { > > + // try to get the user name for the system property GIT_XXX_NAME > > + username = System.getProperty(gitVariableKey); > > Shouldn't that be System.getenv()? According to http://java.sun.com/j2se/1.4.2/docs/api/java/lang/System.html#getenv(java.lang.String) getenv() is deprecated. However, in later editions (Java5 and later, to be precise), that deprecation seems to be lifted... Ciao, Dscho ``` ## Robin Rosenberg, 2009-02-04 00:55 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <200902040155.15206.robin.rosenberg.lists@dewire.com> URL: https://gitlist.dev/e/200902040155.15206.robin.rosenberg.lists%40dewire.com In-Reply-To: ``` onsdag 04 februari 2009 00:20:03 skrev Johannes Schindelin: > According to > > http://java.sun.com/j2se/1.4.2/docs/api/java/lang/System.html#getenv(java.lang.String) > > getenv() is deprecated. However, in later editions (Java5 and later, to > be precise), that deprecation seems to be lifted... It was worse, it wasn't even implemented. You got a runtime exception back then (1.3 or 1.4). So now it's fine. -- robin ``` ## Shawn O. Pearce, 2009-02-04 00:59 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <20090204005907.GA23383@spearce.org> URL: https://gitlist.dev/e/20090204005907.GA23383%40spearce.org In-Reply-To: ``` Johannes Schindelin wrote: > On Tue, 3 Feb 2009, Shawn O. Pearce wrote: > > Yann Simon wrote: > > > + username = System.getProperty(gitVariableKey); > > > > Shouldn't that be System.getenv()? > > According to > > http://java.sun.com/j2se/1.4.2/docs/api/java/lang/System.html#getenv(java.lang.String) > > getenv() is deprecated. However, in later editions (Java5 and later, to > be precise), that deprecation seems to be lifted... Yea, funny thing about that. In 1.3 getenv() worked. In 1.4 they not only marked it deprecated, they changed the method to always throw a RuntimeException. Java developers were outraged, so in 1.5 (aka Java 5) they added it back in as a supported method. JGit only runs on Java 5 and later. So we're safe, we don't have to worry about this #@(!@(! method and the 1.4 mistake. Hell, Java 6 added an executable flag to java.io.File. This is a rather funny concept on Windows where executablity is based on file name and not a "mode bit", but its in the Java 6 S2SE API. At least even on Windows getenv makes sense and provides data. -- Shawn. ``` ## Shawn O. Pearce, 2009-02-04 01:01 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <20090204010116.GB23383@spearce.org> URL: https://gitlist.dev/e/20090204010116.GB23383%40spearce.org In-Reply-To: <200902040155.15206.robin.rosenberg.lists@dewire.com> ``` Robin Rosenberg wrote: > onsdag 04 februari 2009 00:20:03 skrev Johannes Schindelin: > > According to > > > > http://java.sun.com/j2se/1.4.2/docs/api/java/lang/System.html#getenv(java.lang.String) > > > > getenv() is deprecated. However, in later editions (Java5 and later, to > > be precise), that deprecation seems to be lifted... > > It was worse, it wasn't even implemented. You got a runtime exception back then (1.3 or 1.4). > So now it's fine. FWIW, it worked in 1.3 and returned correct data on platforms that had a notion of "environment" (POSIX, Windows, not Mac OS 9). It was only 1.4 that threw a RuntimeException. That was a HUGE mistake on the Sun developer's part. IMHO, 1.4 should have always returned NULL instead of throwing RuntimeException. Most applications had ways to work around not getting a particular value from the environment, e.g. if the end-user didn't set something. But they weren't prepared to handle a new class of RuntimeException coming out of a method in System. -- Shawn. ``` ## Robin Rosenberg, 2009-02-04 01:04 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <200902040204.16102.robin.rosenberg.lists@dewire.com> URL: https://gitlist.dev/e/200902040204.16102.robin.rosenberg.lists%40dewire.com In-Reply-To: <20090204005907.GA23383@spearce.org> ``` onsdag 04 februari 2009 01:59:07 skrev Shawn O. Pearce: > Hell, Java 6 added an executable flag to java.io.File. This is > a rather funny concept on Windows where executablity is based on > file name and not a "mode bit", but its in the Java 6 S2SE API. > At least even on Windows getenv makes sense and provides data. There is an execute bit in windows ACL's. Disable it for an executables (exe, dll etc and see for yourself). I've hit it when trying to track an eclipse installation using git and some DLL wasn't executable after a checkout. -- robin ``` ## Yann Simon, 2009-02-04 08:08 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <551f769b0902040008o7e833b93ud94eeb87dc072084@mail.gmail.com> URL: https://gitlist.dev/e/551f769b0902040008o7e833b93ud94eeb87dc072084%40mail.gmail.com In-Reply-To: <1233695594.8042.6.camel@localhost> ``` Sorry to all, there is still 2 trailing whitespaces in this patch. I send a wrong version.. I will anyway send the patch again after dealing with the comments. Yann, bad man for patches ``` ## Yann Simon, 2009-02-04 08:14 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <551f769b0902040014g380d4f00nd3dbbd6322fca434@mail.gmail.com> URL: https://gitlist.dev/e/551f769b0902040014g380d4f00nd3dbbd6322fca434%40mail.gmail.com In-Reply-To: <20090203231357.GZ26880@spearce.org> ``` 2009/2/4 Shawn O. Pearce : > Yann Simon wrote: >> index 7df90cd..5821f83 100644 >> --- a/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java >> +++ b/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java >> @@ -50,6 +50,8 @@ >> import java.io.InputStreamReader; >> import java.io.OutputStreamWriter; >> import java.io.PrintWriter; >> +import java.net.InetAddress; >> +import java.net.UnknownHostException; >> import java.util.ArrayList; >> import java.util.Collections; >> import java.util.HashMap; >> @@ -98,6 +100,8 @@ public static RepositoryConfig openUserConfig() { >> >> private Map byName; >> >> + private String hostname; >> + >> private static final String MAGIC_EMPTY_VALUE = "%%magic%%empty%%"; >> >> RepositoryConfig(final Repository repo) { >> @@ -308,6 +312,83 @@ public String getString(final String section, String subsection, final String na >> return result; >> } >> >> + /** >> + * @return the author name as defined in the git variables >> + * and configurations. If no name could be found, try >> + * to use the system user name instead. >> + */ >> + public String getAuthorName() { >> + return getUsernameInternal(Constants.GIT_AUTHOR_NAME_KEY); >> + } >> + >> + /** >> + * @return the commiter name as defined in the git variables >> + * and configurations. If no name could be found, try >> + * to use the system user name instead. >> + */ >> + public String getCommiterName() { >> + return getUsernameInternal(Constants.GIT_COMMITER_NAME_KEY); >> + } >> + >> + private String getUsernameInternal(String gitVariableKey) { >> + // try to get the user name from the local and global configurations. >> + String username = getString("user", null, "name"); >> + >> + if (username == null) { >> + // try to get the user name for the system property GIT_XXX_NAME >> + username = System.getProperty(gitVariableKey); > > Shouldn't that be System.getenv()? > >> + private String getUserEmailInternal(String gitVariableKey, boolean author) { >> + // try to get the email from the local and global configs. >> + String email = getString("user", null, "email"); >> + >> + if (email == null) { >> + // try to get the email for the system property GIT_XXX_EMAIL >> + email = System.getProperty(gitVariableKey); > > Again, System.getenv()? > >> + public String getHostname() { >> + if (hostname == null) { >> + InetAddress localMachine; >> + try { >> + localMachine = InetAddress.getLocalHost(); >> + hostname = localMachine.getHostName(); >> + } catch (UnknownHostException e) { >> + // we do nothing >> + } >> + } >> + return hostname; > > Do we want getHostName() or getCanonicalHostName() here? > > I think we'd want getCanonicalHostName(). Yes, indeed. I change this. > > Should we be caching this at the RepositoryConfig level, or at the > whole JVM level (in a static). If the application is long-running > its likely to keep the same RepositoryConfig instance around for > the life of that JVM, so we'd only make this request once. Thus any > change in hostname while the application is running would probably > not take effect until after restart. But any long running app is > also likely to access more than one Repository, and thus more than > one RepositoryConfig, so they should at least use consistent names, > even if the underlying hostname has changed. > > IMHO, just cache it in a static on first demand. OK, that make sense. Should the call be thread-safe if it can be called from different instances? Yann ``` ## Yann Simon, 2009-02-04 08:42 Subject: Re: [PATCH JGIT] Compute the author/commiter name and email from the git configuration Message-ID: <551f769b0902040042j23238581ia248c949ee395ff7@mail.gmail.com> URL: https://gitlist.dev/e/551f769b0902040042j23238581ia248c949ee395ff7%40mail.gmail.com In-Reply-To: <20090203231357.GZ26880@spearce.org> ``` 2009/2/4 Shawn O. Pearce : > Yann Simon wrote: >> index 7df90cd..5821f83 100644 >> --- a/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java >> +++ b/org.spearce.jgit/src/org/spearce/jgit/lib/RepositoryConfig.java >> @@ -50,6 +50,8 @@ >> import java.io.InputStreamReader; >> import java.io.OutputStreamWriter; >> import java.io.PrintWriter; >> +import java.net.InetAddress; >> +import java.net.UnknownHostException; >> import java.util.ArrayList; >> import java.util.Collections; >> import java.util.HashMap; >> @@ -98,6 +100,8 @@ public static RepositoryConfig openUserConfig() { >> >> private Map byName; >> >> + private String hostname; >> + >> private static final String MAGIC_EMPTY_VALUE = "%%magic%%empty%%"; >> >> RepositoryConfig(final Repository repo) { >> @@ -308,6 +312,83 @@ public String getString(final String section, String subsection, final String na >> return result; >> } >> >> + /** >> + * @return the author name as defined in the git variables >> + * and configurations. If no name could be found, try >> + * to use the system user name instead. >> + */ >> + public String getAuthorName() { >> + return getUsernameInternal(Constants.GIT_AUTHOR_NAME_KEY); >> + } >> + >> + /** >> + * @return the commiter name as defined in the git variables >> + * and configurations. If no name could be found, try >> + * to use the system user name instead. >> + */ >> + public String getCommiterName() { >> + return getUsernameInternal(Constants.GIT_COMMITER_NAME_KEY); >> + } >> + >> + private String getUsernameInternal(String gitVariableKey) { >> + // try to get the user name from the local and global configurations. >> + String username = getString("user", null, "name"); >> + >> + if (username == null) { >> + // try to get the user name for the system property GIT_XXX_NAME >> + username = System.getProperty(gitVariableKey); > > Shouldn't that be System.getenv()? > >> + private String getUserEmailInternal(String gitVariableKey, boolean author) { >> + // try to get the email from the local and global configs. >> + String email = getString("user", null, "email"); >> + >> + if (email == null) { >> + // try to get the email for the system property GIT_XXX_EMAIL >> + email = System.getProperty(gitVariableKey); > > Again, System.getenv()? Just a precision: One of the consequences of using System.getenv() is that it does not let java programs to define the value of the variable. System.getProperty(), on the other hand, offers a System.setProperty() If we use System.getenv(), we cannot overwrite the value before. But we maybe do not need to overwrite system variables (except for unit test... :) ) In that case, we can live with System.getenv(). A workaround would be to use a method like: private static String readEnvironmentVariable(String key) { String result = System.getProperty(key); if (result == null || result.length() == 0) { result = System.getenv(key); } return result; } but I really dislike it. This is much more complex and make the results less predictable. I change my code to use System.getenv() unless you got other ideas. Yann ```