* [JGit-RFC-PATCH 1/3] Introduce a new module for IO SPI of JGit
@ 2009-10-10 15:56 imyousuf
2009-10-10 15:57 ` [JGit-RFC-PATCH 2/3] Add JGit IO SPI and default implementation imyousuf
0 siblings, 1 reply; 3+ messages in thread
From: imyousuf @ 2009-10-10 15:56 UTC (permalink / raw)
To: git; +Cc: spearce, egit-dev, Imran M Yousuf
From: Imran M Yousuf <imyousuf@smartitengineering.com>
The reason for having a separate module is quite obvious, the IO SPI
providers need not have to depend on the whole JGit but rather only on
the SPI itself. As of the initial implementation the SPI will also contain
the default implementation - local file system provider.
Extract maven POM file to a common file to encapsulate the common setting
and configuration to be used across all maven modules for JGit.
Signed-off-by: Imran M Yousuf <imyousuf@smartitengineering.com>
---
jgit-maven/jgit-io/pom.xml | 65 +++++++++
jgit-maven/jgit/pom.xml | 287 ++++++++++-------------------------------
jgit-maven/{jgit => }/pom.xml | 31 +----
3 files changed, 143 insertions(+), 240 deletions(-)
create mode 100644 jgit-maven/jgit-io/pom.xml
rewrite jgit-maven/jgit/pom.xml (68%)
rename jgit-maven/{jgit => }/pom.xml (90%)
diff --git a/jgit-maven/jgit-io/pom.xml b/jgit-maven/jgit-io/pom.xml
new file mode 100644
index 0000000..f197f58
--- /dev/null
+++ b/jgit-maven/jgit-io/pom.xml
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.eclipse</groupId>
+ <artifactId>jgit-parent</artifactId>
+ <version>0.6.0-SNAPSHOT</version>
+ </parent>
+ <groupId>org.eclipse</groupId>
+ <artifactId>jgit-io</artifactId>
+ <packaging>jar</packaging>
+ <name>jgit-io</name>
+ <build>
+ <sourceDirectory>../../org.eclipse.jgit.io/src/</sourceDirectory>
+ <testResources>
+ <testResource>
+ <directory>../../org.eclipse.jgit.test/tst-rsrc/</directory>
+ </testResource>
+ </testResources>
+ <testSourceDirectory>../../org.eclipse.jgit.io/tst/</testSourceDirectory>
+ </build>
+ <dependencies>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/jgit-maven/jgit/pom.xml b/jgit-maven/jgit/pom.xml
dissimilarity index 68%
index d8772ad..9eb5758 100644
--- a/jgit-maven/jgit/pom.xml
+++ b/jgit-maven/jgit/pom.xml
@@ -1,216 +1,71 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-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.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <groupId>org.eclipse</groupId>
- <artifactId>jgit</artifactId>
- <packaging>jar</packaging>
- <version>0.6.0-SNAPSHOT</version>
- <name>jgit</name>
- <url>http://repo.or.cz/w/jgit.git</url>
- <mailingLists>
- <mailingList>
- <name>GIT Mailing List</name>
- <post>git@vger.kernel.org</post>
- <archive>http://marc.info/?l=git</archive>
- </mailingList>
- </mailingLists>
- <description>Pure Java implementation of Git</description>
- <developers>
- <developer>
- <name>Shawn O. Pearce</name>
- <email>spearce@spearce.org</email>
- <roles>
- <role>Maintainer</role>
- </roles>
- </developer>
- <developer>
- <name>Robin Rosenberg</name>
- <email>robin.rosenberg@dewire.com</email>
- <roles>
- <role>Maintainer</role>
- </roles>
- </developer>
- <developer>
- <name>Dave Watson</name>
- <email>dwatson@mimvista.com</email>
- <roles>
- <role>Developer</role>
- </roles>
- </developer>
- <developer>
- <name>Roger C. Soares</name>
- <email>rogersoares@intelinet.com.br</email>
- <roles>
- <role>Developer</role>
- </roles>
- </developer>
- <developer>
- <name>Marek Zawirski</name>
- <email>marek.zawirski@gmail.com</email>
- <roles>
- <role>Developer</role>
- </roles>
- </developer>
- <developer>
- <name>Charles O'Farrell</name>
- <email>charleso@charleso.org</email>
- <roles>
- <role>Contributor</role>
- </roles>
- </developer>
- <developer>
- <name>Imran M Yousuf</name>
- <email>imyousuf@smartitengineering.com</email>
- <organization>Smart IT Engineering</organization>
- <roles>
- <role>Contributor</role>
- </roles>
- </developer>
- </developers>
- <licenses>
- <license>
- <name>Eclipse Distribution License (New BSD License)</name>
- <comments>
- 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.
- </comments>
- </license>
- </licenses>
- <build>
- <sourceDirectory>../../org.eclipse.jgit/src/</sourceDirectory>
- <testResources>
- <testResource>
- <directory>../../org.eclipse.jgit.test/tst-rsrc/</directory>
- </testResource>
- </testResources>
- <testSourceDirectory>../../org.eclipse.jgit.test/tst/</testSourceDirectory>
- <plugins>
- <plugin>
- <artifactId>maven-compiler-plugin</artifactId>
- <version>2.0.2</version>
- <configuration>
- <source>1.5</source>
- <target>1.5</target>
- <encoding>UTF-8</encoding>
- </configuration>
- </plugin>
- <plugin>
- <artifactId>maven-surefire-plugin</artifactId>
- <version>2.4.2</version>
- <configuration>
- <includes>
- <include>**/*Test.java</include>
- <include>**/*TestCase.java</include>
- <include>**/T000*.java</include>
- </includes>
- </configuration>
- </plugin>
- <plugin>
- <artifactId>maven-source-plugin</artifactId>
- <executions>
- <execution>
- <goals>
- <goal>jar</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <artifactId>maven-javadoc-plugin</artifactId>
- <executions>
- <execution>
- <goals>
- <goal>jar</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- <dependencies>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <version>3.8.1</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>com.jcraft</groupId>
- <artifactId>jsch</artifactId>
- <version>0.1.41</version>
- <scope>compile</scope>
- </dependency>
- </dependencies>
- <distributionManagement>
- <snapshotRepository>
- <id>jgit-maven-snapshot-repository</id>
- <name>JGit Maven Snapshot Repository</name>
- <url>dav:https://egit.googlecode.com/svn/maven/snapshot-repository/</url>
- <uniqueVersion>true</uniqueVersion>
- </snapshotRepository>
- </distributionManagement>
-</project>
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.eclipse</groupId>
+ <artifactId>jgit-parent</artifactId>
+ <version>0.6.0-SNAPSHOT</version>
+ </parent>
+ <groupId>org.eclipse</groupId>
+ <artifactId>jgit</artifactId>
+ <packaging>jar</packaging>
+ <name>jgit</name>
+ <build>
+ <sourceDirectory>../../org.eclipse.jgit/src/</sourceDirectory>
+ <testResources>
+ <testResource>
+ <directory>../../org.eclipse.jgit.test/tst-rsrc/</directory>
+ </testResource>
+ </testResources>
+ <testSourceDirectory>../../org.eclipse.jgit.test/tst/</testSourceDirectory>
+ </build>
+ <dependencies>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <version>3.8.1</version>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>com.jcraft</groupId>
+ <artifactId>jsch</artifactId>
+ <version>0.1.41</version>
+ <scope>compile</scope>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/jgit-maven/jgit/pom.xml b/jgit-maven/pom.xml
similarity index 90%
rename from jgit-maven/jgit/pom.xml
rename to jgit-maven/pom.xml
index d8772ad..bac9629 100644
--- a/jgit-maven/jgit/pom.xml
+++ b/jgit-maven/pom.xml
@@ -37,10 +37,10 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.eclipse</groupId>
- <artifactId>jgit</artifactId>
- <packaging>jar</packaging>
+ <artifactId>jgit-parent</artifactId>
+ <packaging>pom</packaging>
<version>0.6.0-SNAPSHOT</version>
- <name>jgit</name>
+ <name>JGit</name>
<url>http://repo.or.cz/w/jgit.git</url>
<mailingLists>
<mailingList>
@@ -141,13 +141,6 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</license>
</licenses>
<build>
- <sourceDirectory>../../org.eclipse.jgit/src/</sourceDirectory>
- <testResources>
- <testResource>
- <directory>../../org.eclipse.jgit.test/tst-rsrc/</directory>
- </testResource>
- </testResources>
- <testSourceDirectory>../../org.eclipse.jgit.test/tst/</testSourceDirectory>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
@@ -191,20 +184,6 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</plugin>
</plugins>
</build>
- <dependencies>
- <dependency>
- <groupId>junit</groupId>
- <artifactId>junit</artifactId>
- <version>3.8.1</version>
- <scope>test</scope>
- </dependency>
- <dependency>
- <groupId>com.jcraft</groupId>
- <artifactId>jsch</artifactId>
- <version>0.1.41</version>
- <scope>compile</scope>
- </dependency>
- </dependencies>
<distributionManagement>
<snapshotRepository>
<id>jgit-maven-snapshot-repository</id>
@@ -213,4 +192,8 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<uniqueVersion>true</uniqueVersion>
</snapshotRepository>
</distributionManagement>
+ <modules>
+ <module>jgit</module>
+ <module>jgit-io</module>
+ </modules>
</project>
--
1.6.2.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [JGit-RFC-PATCH 2/3] Add JGit IO SPI and default implementation
2009-10-10 15:56 [JGit-RFC-PATCH 1/3] Introduce a new module for IO SPI of JGit imyousuf
@ 2009-10-10 15:57 ` imyousuf
2009-10-10 15:57 ` [JGit-RFC-PATCH 3/3] Incorporate current FileSystem Util implementations to the SPI imyousuf
0 siblings, 1 reply; 3+ messages in thread
From: imyousuf @ 2009-10-10 15:57 UTC (permalink / raw)
To: git; +Cc: spearce, egit-dev, Imran M Yousuf
From: Imran M Yousuf <imyousuf@smartitengineering.com>
The SPI mainly focus's in providing an API to JGit to be able to perform
similar operations to that of java.io.File. All direct I/O is based on the
java.io.Input/OutputStream classes.
Different JGit IO SPI provider is designed to be URI scheme based and thus
the default implementation is that of "file" scheme. SPI provider will be
integrated by their respective users in a manner similar to that of JDBC
driver registration. There is a SystemStorageManager that has similar
registration capabilities and the system storage providers should be
registered with the manager in one of the provided ways.
This SPI is based on the initial requirements for switching to it and thus
this SPI will change as required during full migration to it.
Signed-off-by: Imran M Yousuf <imyousuf@smartitengineering.com>
---
.../src/org/eclipse/jgit/io/Entry.java | 148 +++++++++++++
.../src/org/eclipse/jgit/io/StorageSystem.java | 58 +++---
.../org/eclipse/jgit/io/StorageSystemManager.java | 154 ++++++++++++++
.../eclipse/jgit/io/localfs/LocalFileEntry.java | 219 ++++++++++++++++++++
.../eclipse/jgit/io/localfs/LocalFileSystem.java | 53 +++---
5 files changed, 578 insertions(+), 54 deletions(-)
create mode 100644 org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java
copy org.eclipse.jgit.test/tst/org/eclipse/jgit/util/JGitTestUtil.java => org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java (61%)
create mode 100644 org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystemManager.java
create mode 100644 org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java
copy org.eclipse.jgit/src/org/eclipse/jgit/errors/RepositoryNotFoundException.java => org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java (64%)
diff --git a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java
new file mode 100644
index 0000000..b8c3236
--- /dev/null
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java
@@ -0,0 +1,148 @@
+/*
+ * Copyright (C) 2009, Imran M Yousuf <imyousuf@smartitengineering.com>
+ *
+ * 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.io;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URI;
+
+/**
+ * Represents each entry in a storage system. For example, in a local filesystem
+ * storage it would represent {@link java.io.File}. Here the storage system
+ * mainly refers to where repository meta data such as git objects, ref logs,
+ * packs are stored; for example a '.git' directory and all its contents in a
+ * clone repo would correspond to an entry.
+ * @author Imran M Yousuf (imyousuf at smartitengineering.com)
+ * @since 0.6
+ */
+public interface Entry {
+
+ /**
+ * Retrieves the name of the entry
+ * @return Name of the entry
+ */
+ public String getName();
+
+ /**
+ * Retrieves the absolute path of the entry.
+ * @return Absoluth path
+ */
+ public String getAbsolutePath();
+
+ /**
+ * Retrieves whether the entry represents a directory or not
+ * @return True if represents a directory else false
+ */
+ public boolean isDirectory();
+
+ /**
+ * Signifies whether the entry is a new one or being read from the
+ * persistent storage
+ * @return True if being read form storage else false
+ */
+ public boolean isExists();
+
+ /**
+ * Make directories upto the entry represented by this instance, provided
+ * that this instance itself is a directory.
+ * @return True if directories were created.
+ */
+ public boolean mkdirs();
+
+ /**
+ * Retrieves the URI of this entry. URI in this case acts as a primary key
+ * to identify an entry.
+ * @return URI to identify this entry instance
+ */
+ public URI getURI();
+
+ /**
+ * Retrieves the length of the entry if its predictable.
+ * @return < 0 if the length is unpredictable else the length of the entry's
+ * content
+ */
+ public long length();
+
+ /**
+ * Retrieves the InputStream for reading the content of the entry
+ * @return Input stream to read entry content
+ * @throws IOException If no such file exists or there is any other error
+ */
+ public InputStream getInputStream()
+ throws IOException;
+
+ /**
+ * Retrieves the OutputStream for writing content into the entry. It can be
+ * opened to either overwrite it or append to it.
+ * @param overwrite False if to write in append mode else true
+ * @return Output stream to write content to
+ * @throws IOException If no such file exists in append mode or there is any
+ * error in retrieving it.
+ */
+ public OutputStream getOutputStream(boolean overwrite)
+ throws IOException;
+
+ /**
+ * Retrieve all the child entries of this entries if its a directory.
+ * @return If not a directory then a empty array else array of sub-entries.
+ */
+ public Entry[] getChildren();
+
+ /**
+ * Retrieve a specific child of an entry. It will basically match
+ * {@link Entry#getName() name} of the children to find and that too only
+ * the direct children.
+ * @param name Name of the child to find
+ * @return If child is not found then NULL or else the child specified by
+ * the name
+ */
+ public Entry getChild(String name);
+
+ /**
+ * Retrieve the parent entry of the current entry.
+ * @return NULL if no parent or else the direct parent of the current entry
+ */
+ public Entry getParent();
+
+ /**
+ * Retrieve the storage system this entry either is from or will be
+ * persisted to.
+ * @return Storage system of the entry, will never be NULL.
+ */
+ public StorageSystem getStorageSystem();
+}
diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/util/JGitTestUtil.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java
similarity index 61%
copy from org.eclipse.jgit.test/tst/org/eclipse/jgit/util/JGitTestUtil.java
copy to org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java
index b259185..d3e60ab 100644
--- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/util/JGitTestUtil.java
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2008, Imran M Yousuf <imyousuf@smartitengineering.com>
+ * Copyright (C) 2009, Imran M Yousuf <imyousuf@smartitengineering.com>
*
* All rights reserved.
*
@@ -34,38 +34,36 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+package org.eclipse.jgit.io;
-package org.eclipse.jgit.util;
+import java.net.URI;
-import java.io.File;
-import java.net.URISyntaxException;
-import java.net.URL;
-
-public abstract class JGitTestUtil {
- public static final String CLASSPATH_TO_RESOURCES = "org/eclipse/jgit/test/resources/";
+/**
+ * SPI providing access to the underlying storage system. Each provider is
+ * differentiated using their {@link StorageSystem#getURIProtocol() URI Protocol}.
+ * @author Imran M Yousuf (imyousuf at smartitengineering.com)
+ * @since 0.6
+ */
+public interface StorageSystem {
- private JGitTestUtil() {
- throw new UnsupportedOperationException();
- }
+ /**
+ * Returns the supported scheme of this storage system.
+ * @return Scheme supported by this storage system.
+ * @see {@link http://tr.im/BiQ0 URI Scheme}
+ */
+ public String getURIScheme();
- public static File getTestResourceFile(final String fileName) {
- if (fileName == null || fileName.length() <= 0) {
- return null;
- }
- final URL url = cl().getResource(CLASSPATH_TO_RESOURCES + fileName);
- if (url == null) {
- // If URL is null then try to load it as it was being
- // loaded previously
- return new File("tst", fileName);
- }
- try {
- return new File(url.toURI());
- } catch(URISyntaxException e) {
- return new File(url.getPath());
- }
- }
+ /**
+ * Retrieve an entry using its URI
+ * @param uri URI to retrieve the entry for.
+ * @return Entry representing the URI
+ */
+ public Entry getEntry(URI uri);
- private static ClassLoader cl() {
- return JGitTestUtil.class.getClassLoader();
- }
+ /**
+ * Retrieve the current working directory from the file system if any.
+ * @return Entry for current working directory.
+ */
+ public Entry getWorkingDirectory();
+
}
diff --git a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystemManager.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystemManager.java
new file mode 100644
index 0000000..ae28865
--- /dev/null
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystemManager.java
@@ -0,0 +1,154 @@
+/*
+ * Copyright (C) 2009, Imran M Yousuf <imyousuf@smartitengineering.com>
+ *
+ * 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.io;
+
+import java.io.IOException;
+import java.net.URI;
+import java.util.Hashtable;
+import java.util.Map;
+import org.eclipse.jgit.io.localfs.LocalFileSystem;
+
+/**
+ * Manager that registers different storage system for different {@link URI}
+ * schemes and serves users with {@link Entry} or {@link StorageSystem} as URI
+ * schemes request.
+ * @author Imran M Yousuf (imyousuf at smartitengineering.com)
+ * @since 0.6
+ */
+public class StorageSystemManager {
+
+ /**
+ * Map to act as registrar for all registered schemes
+ */
+ private static Map<String, StorageSystem> storageSystemMap;
+
+ /**
+ * Initialize the registrar and and load the instance for default storage,
+ * i.e. the local file system.
+ */
+ static {
+ storageSystemMap = new Hashtable<String, StorageSystem>();
+ try {
+ register(LocalFileSystem.class);
+ }
+ catch (Exception ex) {
+ ex.printStackTrace();
+ }
+ }
+
+ /**
+ * Retrieves the storage system for a given scheme from the registrar.
+ * @param scheme Scheme to retrieve; it should never be null
+ * @return Storage system representing the scheme.
+ * @throws IOException If scheme is null or scheme does not exist.
+ */
+ public static StorageSystem getStorageSystem(String scheme)
+ throws IOException {
+ if (scheme != null && storageSystemMap.containsKey(scheme)) {
+ return storageSystemMap.get(scheme);
+ }
+ else {
+ throw new IOException("Scheme ( " + scheme +
+ " ) not registered with manager!");
+ }
+ }
+
+ /**
+ * Load an storage system entry using its respective URI.
+ * @param uri URI to retrieve the storage system entity for
+ * @return The entry in the storage system for the requested URI
+ * @throws IOException If scheme does not exist.
+ * @throws NullPointerException If uri is null
+ */
+ public static Entry getEntry(URI uri)
+ throws IOException,
+ NullPointerException {
+ String scheme = uri.getScheme();
+ return getStorageSystem(scheme).getEntry(uri);
+ }
+
+ /**
+ * Registers a {@link StorageSystem} implementaiton against its schema into
+ * the registrar using the implementions fully qualified class name and its
+ * non-args constructor.
+ * @param storageSystemClassName The class names representation is string.
+ * @throws ClassNotFoundException If no class is found with the name specified
+ * @throws InstantiationException If there is any exception during
+ * initialization
+ * @throws IllegalAccessException If the class dpes not have a public
+ * non-args constructor
+ * @throws ClassCastException If the class does implement {@link StorageSystem}
+ */
+ public static void register(String storageSystemClassName)
+ throws ClassNotFoundException,
+ InstantiationException,
+ IllegalAccessException,
+ ClassCastException {
+ register((Class<? extends StorageSystem>) Class.forName(
+ storageSystemClassName));
+ }
+
+ /**
+ * Registers a {@link StorageSystem} implementaiton against its schema into
+ * the registrar using the implemention class name and its non-args constructor.
+ * @param storageSystemClassName The class names representation is string.
+ * @throws InstantiationException If there is any exception during
+ * initialization
+ * @throws IllegalAccessException If the class dpes not have a public
+ * non-args constructor
+ */
+ public static void register(
+ Class<? extends StorageSystem> storageSystemClass)
+ throws InstantiationException,
+ IllegalAccessException {
+ if (storageSystemClass != null) {
+ StorageSystem system = storageSystemClass.newInstance();
+ register(system);
+ }
+ }
+
+ /**
+ * Registers a {@link StorageSystem} instance into the reigstrar. It would be
+ * particularly useful if system does not have a non-args constructor.
+ * @param system System to register in the manager
+ */
+ public static void register(StorageSystem system) {
+ if (system != null) {
+ storageSystemMap.put(system.getURIScheme(), system);
+ }
+ }
+}
diff --git a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java
new file mode 100644
index 0000000..20a64cb
--- /dev/null
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java
@@ -0,0 +1,219 @@
+/*
+ * Copyright (C) 2009, Imran M Yousuf <imyousuf@smartitengineering.com>
+ *
+ * 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.io.localfs;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.net.URI;
+import org.eclipse.jgit.io.Entry;
+import org.eclipse.jgit.io.StorageSystem;
+import org.eclipse.jgit.io.StorageSystemManager;
+
+/**
+ * Entry implementation for local file system. This class should not be
+ * initialized directly unless its a {@link LocalFileSystem}. SPI users should
+ * use {@link StorageSystemManager#getEntry(java.net.URI)} to get the first
+ * {@link Entry} and then traverse from there onwards.
+ * @author Imran M Yousuf (imyousuf at smartitengineering.com)
+ * @since 0.6
+ */
+public class LocalFileEntry
+ implements Entry {
+
+ private File localFile;
+ private StorageSystem storageSystem;
+
+ /**
+ * Contructs an entry based of on the local file system storage and a file
+ * that will be represented by this entry.
+ * @param localFile File represented by this entry
+ * @param storageSystem Storage system of the entry
+ * @throws IllegalArgumentException If either argument is NULL
+ */
+ protected LocalFileEntry(File localFile,
+ StorageSystem storageSystem)
+ throws IllegalArgumentException {
+ setLocalFile(localFile);
+ setStorageSystem(storageSystem);
+ }
+
+ /**
+ * Sets the storage system instance for this entry.
+ * @param storageSystem Storage system
+ * @throws IllegalArgumentException IF storageSystem is null
+ */
+ protected void setStorageSystem(StorageSystem storageSystem)
+ throws IllegalArgumentException {
+ if (storageSystem == null) {
+ throw new IllegalArgumentException("Storage system can't be NULL!");
+ }
+ this.storageSystem = storageSystem;
+ }
+
+ /**
+ * Retrieves the file being adapted by this entry.
+ * @return File being adapted
+ */
+ public File getLocalFile() {
+ return localFile;
+ }
+
+ /**
+ * Sets the file which is to be used as adapt from this instance by this
+ * implementation
+ * @param localFile Local file being adapted by this instance
+ * @throws IllegalArgumentException If localFile is null
+ */
+ protected void setLocalFile(File localFile)
+ throws IllegalArgumentException {
+ if (localFile == null) {
+ throw new IllegalArgumentException(
+ "Local file to be set can't be NULL");
+ }
+ this.localFile = localFile;
+ }
+
+ public String getName() {
+ return getLocalFile().getName();
+ }
+
+ public String getAbsolutePath() {
+ return getLocalFile().getAbsolutePath();
+ }
+
+ public boolean isDirectory() {
+ return getLocalFile().isDirectory();
+ }
+
+ public boolean isExists() {
+ return getLocalFile().exists();
+ }
+
+ public boolean mkdirs() {
+ return getLocalFile().mkdirs();
+ }
+
+ public URI getURI() {
+ return getLocalFile().toURI();
+ }
+
+ public InputStream getInputStream()
+ throws IOException {
+ if (getLocalFile().exists()) {
+ try {
+ return new FileInputStream(getLocalFile());
+ }
+ catch (FileNotFoundException ex) {
+ throw ex;
+ }
+ }
+ else {
+ throw new FileNotFoundException("File does not exists!");
+ }
+ }
+
+ public OutputStream getOutputStream(boolean overwrite)
+ throws IOException {
+ try {
+ if (!isExists()) {
+
+ return new FileOutputStream(getLocalFile());
+ }
+ else {
+ if (overwrite) {
+ return new FileOutputStream(getLocalFile());
+ }
+ else {
+ return new FileOutputStream(getLocalFile(), true);
+ }
+ }
+ }
+ catch (FileNotFoundException ex) {
+ throw ex;
+ }
+ }
+
+ public Entry[] getChildren() {
+ File[] children = getLocalFile().listFiles();
+ if (children == null || children.length == 0) {
+ return new Entry[0];
+ }
+ else {
+ Entry[] entries = new Entry[children.length];
+ for (int i = 0; i < children.length; ++i) {
+ entries[i] = getStorageSystem().getEntry(children[i].toURI());
+ }
+ return entries;
+ }
+ }
+
+ public Entry getChild(String name) {
+ if (name == null || name.length() == 0) {
+ return null;
+ }
+ Entry[] children = getChildren();
+ for (Entry entry : children) {
+ if (name.equals(entry.getName())) {
+ return entry;
+ }
+ }
+ return null;
+ }
+
+ public Entry getParent() {
+ File parent = getLocalFile().getParentFile();
+ if (parent == null) {
+ return null;
+ }
+ else {
+ return getStorageSystem().getEntry(parent.toURI());
+ }
+ }
+
+ public StorageSystem getStorageSystem() {
+ return storageSystem;
+ }
+
+ public long length() {
+ return getLocalFile().length();
+ }
+}
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/errors/RepositoryNotFoundException.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java
similarity index 64%
copy from org.eclipse.jgit/src/org/eclipse/jgit/errors/RepositoryNotFoundException.java
copy to org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java
index bb4ac3b..cf289ec 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/errors/RepositoryNotFoundException.java
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009, Google Inc.
+ * Copyright (C) 2009, Imran M Yousuf <imyousuf@smartitengineering.com>
*
* All rights reserved.
*
@@ -34,32 +34,37 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
-
-package org.eclipse.jgit.errors;
+package org.eclipse.jgit.io.localfs;
import java.io.File;
+import java.net.URI;
+import org.eclipse.jgit.io.Entry;
+import org.eclipse.jgit.io.StorageSystem;
+
+/**
+ * Implementation of storage system for the local file system.
+ * @author Imran M Yousuf (imyousuf at smartitengineering.com)
+ * @since 0.6
+ */
+public class LocalFileSystem
+ implements StorageSystem {
+ public static final String PROTOCOL_FILE = "file";
-/** Indicates a local repository does not exist. */
-public class RepositoryNotFoundException extends TransportException {
- private static final long serialVersionUID = 1L;
+ public String getURIScheme() {
+ return PROTOCOL_FILE;
+ }
- /**
- * Constructs an exception indicating a local repository does not exist.
- *
- * @param location
- * description of the repository not found, usually file path.
- */
- public RepositoryNotFoundException(final File location) {
- this(location.getPath());
- }
+ public Entry getEntry(URI uri) {
+ if(uri == null) {
+ return null;
+ }
+ else {
+ return new LocalFileEntry(new File(uri), this);
+ }
+ }
- /**
- * Constructs an exception indicating a local repository does not exist.
- *
- * @param location
- * description of the repository not found, usually file path.
- */
- public RepositoryNotFoundException(final String location) {
- super("repository not found: " + location);
- }
+ public Entry getWorkingDirectory() {
+ String curDir = System.getProperty("user.dir");
+ return new LocalFileEntry(new File(curDir), this);
+ }
}
--
1.6.2.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [JGit-RFC-PATCH 3/3] Incorporate current FileSystem Util implementations to the SPI
2009-10-10 15:57 ` [JGit-RFC-PATCH 2/3] Add JGit IO SPI and default implementation imyousuf
@ 2009-10-10 15:57 ` imyousuf
0 siblings, 0 replies; 3+ messages in thread
From: imyousuf @ 2009-10-10 15:57 UTC (permalink / raw)
To: git; +Cc: spearce, egit-dev, Imran M Yousuf
From: Imran M Yousuf <imyousuf@smartitengineering.com>
Operations such as setting executable bits if supported and resolving
relative path is incorporated with this change, as a result now it should
be possible to completely replace the currently being used util FS and
java.io.File.
Signed-off-by: Imran M Yousuf <imyousuf@smartitengineering.com>
---
.../src/org/eclipse/jgit/io/Entry.java | 35 ++++-
.../src/org/eclipse/jgit/io/StorageSystem.java | 17 ++-
.../eclipse/jgit/io/localfs/LocalFileEntry.java | 52 ++++++-
.../eclipse/jgit/io/localfs/LocalFileSystem.java | 162 +++++++++++++++++++-
4 files changed, 259 insertions(+), 7 deletions(-)
diff --git a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java
index b8c3236..67d2af5 100644
--- a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/Entry.java
@@ -78,6 +78,24 @@
public boolean isExists();
/**
+ * Does this operating system and JRE support the execute flag on entries?
+ *
+ * @return true if this implementation can provide reasonably accurate
+ * executable bit information; false otherwise.
+ */
+ public boolean isExecutableSupported();
+
+ /**
+ * Determine if the entry is executable (or not).
+ * <p>
+ * Not all platforms and JREs support executable flags on entries. If the
+ * feature is unsupported this method will always return false.
+ *
+ * @return true if the entry is believed to be executable by the user.
+ */
+ public boolean isExecutable();
+
+ /**
* Make directories upto the entry represented by this instance, provided
* that this instance itself is a directory.
* @return True if directories were created.
@@ -85,6 +103,19 @@
public boolean mkdirs();
/**
+ * Set an entry to be executable by the user.
+ * <p>
+ * Not all platforms and JREs support executable flags on entries. If the
+ * feature is unsupported this method will always return false and no
+ * changes will be made to the entry specified.
+ *
+ * @param executable
+ * true to enable execution; false to disable it.
+ * @return true if the change succeeded; false otherwise.
+ */
+ public boolean setExecutable(boolean executable);
+
+ /**
* Retrieves the URI of this entry. URI in this case acts as a primary key
* to identify an entry.
* @return URI to identify this entry instance
@@ -101,7 +132,7 @@
/**
* Retrieves the InputStream for reading the content of the entry
* @return Input stream to read entry content
- * @throws IOException If no such file exists or there is any other error
+ * @throws IOException If no such entry exists or there is any other error
*/
public InputStream getInputStream()
throws IOException;
@@ -111,7 +142,7 @@ public InputStream getInputStream()
* opened to either overwrite it or append to it.
* @param overwrite False if to write in append mode else true
* @return Output stream to write content to
- * @throws IOException If no such file exists in append mode or there is any
+ * @throws IOException If no such entry exists in append mode or there is any
* error in retrieving it.
*/
public OutputStream getOutputStream(boolean overwrite)
diff --git a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java
index d3e60ab..46c663b 100644
--- a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/StorageSystem.java
@@ -65,5 +65,20 @@
* @return Entry for current working directory.
*/
public Entry getWorkingDirectory();
-
+
+ /**
+ * Retrieve the home directory of the current user
+ * @return Home directory
+ */
+ public Entry getHomeDirectory();
+
+ /**
+ * Resolve relative path with respect to a path and return the absolute
+ * entry representing the relative path.
+ * @param entry The point of reference for the relative path
+ * @param path The relative path
+ * @return The absolute entry representing the relative path entry
+ */
+ public Entry resolve(Entry entry,
+ String path);
}
diff --git a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java
index 20a64cb..3d5fab4 100644
--- a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileEntry.java
@@ -43,6 +43,7 @@
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
+import java.lang.reflect.InvocationTargetException;
import java.net.URI;
import org.eclipse.jgit.io.Entry;
import org.eclipse.jgit.io.StorageSystem;
@@ -60,7 +61,7 @@
implements Entry {
private File localFile;
- private StorageSystem storageSystem;
+ private LocalFileSystem storageSystem;
/**
* Contructs an entry based of on the local file system storage and a file
@@ -70,7 +71,7 @@
* @throws IllegalArgumentException If either argument is NULL
*/
protected LocalFileEntry(File localFile,
- StorageSystem storageSystem)
+ LocalFileSystem storageSystem)
throws IllegalArgumentException {
setLocalFile(localFile);
setStorageSystem(storageSystem);
@@ -81,7 +82,7 @@ protected LocalFileEntry(File localFile,
* @param storageSystem Storage system
* @throws IllegalArgumentException IF storageSystem is null
*/
- protected void setStorageSystem(StorageSystem storageSystem)
+ protected void setStorageSystem(LocalFileSystem storageSystem)
throws IllegalArgumentException {
if (storageSystem == null) {
throw new IllegalArgumentException("Storage system can't be NULL!");
@@ -216,4 +217,49 @@ public StorageSystem getStorageSystem() {
public long length() {
return getLocalFile().length();
}
+
+ public boolean isExecutableSupported() {
+ return LocalFileSystem.platform.isExecutableSupproted();
+ }
+
+ public boolean isExecutable() {
+ if (LocalFileSystem.platform.isExecutableSupproted()) {
+ try {
+ final Object r = LocalFileSystem.canExecute.invoke(
+ getLocalFile(),
+ (Object[]) null);
+ return ((Boolean) r).booleanValue();
+ }
+ catch (IllegalArgumentException e) {
+ throw new Error(e);
+ }
+ catch (IllegalAccessException e) {
+ throw new Error(e);
+ }
+ catch (InvocationTargetException e) {
+ throw new Error(e);
+ }
+ }
+ else {
+ return false;
+ }
+ }
+
+ public boolean setExecutable(boolean executable) {
+ try {
+ final Object r;
+ r = LocalFileSystem.setExecute.invoke(getLocalFile(), new Object[] {
+ Boolean.valueOf(executable)});
+ return ((Boolean) r).booleanValue();
+ }
+ catch (IllegalArgumentException e) {
+ throw new Error(e);
+ }
+ catch (IllegalAccessException e) {
+ throw new Error(e);
+ }
+ catch (InvocationTargetException e) {
+ throw new Error(e);
+ }
+ }
}
diff --git a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java
index cf289ec..f18dbde 100644
--- a/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java
+++ b/org.eclipse.jgit.io/src/org/eclipse/jgit/io/localfs/LocalFileSystem.java
@@ -36,8 +36,14 @@
*/
package org.eclipse.jgit.io.localfs;
+import java.io.BufferedReader;
import java.io.File;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.lang.reflect.Method;
import java.net.URI;
+import java.security.AccessController;
+import java.security.PrivilegedAction;
import org.eclipse.jgit.io.Entry;
import org.eclipse.jgit.io.StorageSystem;
@@ -48,14 +54,23 @@
*/
public class LocalFileSystem
implements StorageSystem {
+
public static final String PROTOCOL_FILE = "file";
+ public static final Platform platform;
+ public static Method canExecute;
+ public static Method setExecute;
+ public static String cygpath;
+
+ static {
+ platform = Platform.detect();
+ }
public String getURIScheme() {
return PROTOCOL_FILE;
}
public Entry getEntry(URI uri) {
- if(uri == null) {
+ if (uri == null) {
return null;
}
else {
@@ -67,4 +82,149 @@ public Entry getWorkingDirectory() {
String curDir = System.getProperty("user.dir");
return new LocalFileEntry(new File(curDir), this);
}
+
+ public Entry resolve(Entry entry,
+ String path) {
+ if (!(entry instanceof LocalFileEntry)) {
+ return null;
+ }
+ LocalFileEntry fileEntry = (LocalFileEntry) entry;
+ File localFile = fileEntry.getLocalFile();
+ if (platform.equals(Platform.WIN32_CYGWIN)) {
+ try {
+ final Process p;
+
+ p = Runtime.getRuntime().exec(
+ new String[] {cygpath, "--windows", "--absolute", path},
+ null, localFile);
+ p.getOutputStream().close();
+
+ final BufferedReader lineRead = new BufferedReader(
+ new InputStreamReader(p.getInputStream(), "UTF-8"));
+ String r = null;
+ try {
+ r = lineRead.readLine();
+ }
+ finally {
+ lineRead.close();
+ }
+
+ for (;;) {
+ try {
+ if (p.waitFor() == 0 && r != null && r.length() > 0) {
+ return new LocalFileEntry(new File(r), this);
+ }
+ break;
+ }
+ catch (InterruptedException ie) {
+ // Stop bothering me, I have a zombie to reap.
+ }
+ }
+ }
+ catch (IOException ioe) {
+ // Fall through and use the default return.
+ }
+
+ }
+ final File abspn = new File(path);
+ if (abspn.isAbsolute()) {
+ return new LocalFileEntry(abspn, this);
+ }
+ return new LocalFileEntry(new File(localFile, path), this);
+ }
+
+ public Entry getHomeDirectory() {
+ if (platform.equals(Platform.WIN32_CYGWIN)) {
+ final String home = AccessController.doPrivileged(new PrivilegedAction<String>() {
+
+ public String run() {
+ return System.getenv("HOME");
+ }
+ });
+ if (!(home == null || home.length() == 0)) {
+ return resolve(new LocalFileEntry(new File("."), this), home);
+ }
+ }
+ final String home = AccessController.doPrivileged(new PrivilegedAction<String>() {
+
+ public String run() {
+ return System.getProperty("user.home");
+ }
+ });
+ if (home == null || home.length() == 0) {
+ return null;
+ }
+ return new LocalFileEntry(new File(home).getAbsoluteFile(), this);
+ }
+
+ public enum Platform {
+
+ WIN32_CYGWIN(false),
+ WIN32(false),
+ POSIX_JAVA5(false),
+ POSIX_JAVA6(true);
+ private boolean executableSupproted;
+
+ private Platform(boolean executableSupproted) {
+ this.executableSupproted = executableSupproted;
+ }
+
+ public boolean isExecutableSupproted() {
+ return executableSupproted;
+ }
+
+ public static Platform detect() {
+ final String osDotName = AccessController.doPrivileged(new PrivilegedAction<String>() {
+
+ public String run() {
+ return System.getProperty("os.name");
+ }
+ });
+ if (osDotName != null &&
+ osDotName.toLowerCase().indexOf("windows") != -1) {
+ final String path = AccessController.doPrivileged(new PrivilegedAction<String>() {
+
+ public String run() {
+ return System.getProperty("java.library.path");
+ }
+ });
+ if (path == null) {
+ return WIN32;
+ }
+ for (final String p : path.split(";")) {
+ final File e = new File(p, "cygpath.exe");
+ if (e.isFile()) {
+ cygpath = e.getAbsolutePath();
+ return WIN32_CYGWIN;
+ }
+ }
+ return WIN32;
+ }
+ else {
+ canExecute = needMethod(File.class, "canExecute");
+ setExecute = needMethod(File.class, "setExecutable",
+ Boolean.TYPE);
+ if (canExecute != null && setExecute != null) {
+ return POSIX_JAVA6;
+ }
+ else {
+ return POSIX_JAVA5;
+ }
+ }
+ }
+
+ private static Method needMethod(final Class<?> on,
+ final String name,
+ final Class<?>... args) {
+ try {
+ return on.getMethod(name, args);
+ }
+ catch (SecurityException e) {
+ return null;
+ }
+ catch (NoSuchMethodException e) {
+ return null;
+ }
+ }
+ }
}
--
1.6.2.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2009-10-10 16:04 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-10-10 15:56 [JGit-RFC-PATCH 1/3] Introduce a new module for IO SPI of JGit imyousuf
2009-10-10 15:57 ` [JGit-RFC-PATCH 2/3] Add JGit IO SPI and default implementation imyousuf
2009-10-10 15:57 ` [JGit-RFC-PATCH 3/3] Incorporate current FileSystem Util implementations to the SPI imyousuf
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).