improve base directory handling

scm-plugin-backend/src/main/java/sonia/scm/plugin/BaseDirectory.java

@@ -0,0 +1,158 @@
+/**
+ * Copyright (c) 2010, Sebastian Sdorra All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer. 2. 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. 3. Neither the name of SCM-Manager;
+ * 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 REGENTS 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.
+ *
+ * http://bitbucket.org/sdorra/scm-manager
+ *
+ */
+
+
+
+package sonia.scm.plugin;
+
+//~--- non-JDK imports --------------------------------------------------------
+
+import sonia.scm.util.IOUtil;
+import sonia.scm.util.Util;
+
+//~--- JDK imports ------------------------------------------------------------
+
+import java.io.File;
+
+/**
+ *
+ * @author Sebastian Sdorra
+ */
+public class BaseDirectory
+{
+
+  /** Field description */
+  private static final String DIRECTORY_DEFAULT = ".scm-backend";
+
+  /** Field description */
+  private static final String DIRECTORY_ENVIRONMENT = "SCMBACKEND_HOME";
+
+  /** Field description */
+  static final String DIRECTORY_PROPERTY = "scm-backend.home";
+
+  /** Field description */
+  private static BaseDirectory instance;
+
+  //~--- constructors ---------------------------------------------------------
+
+  /**
+   * Constructs ...
+   *
+   */
+  public BaseDirectory()
+  {
+    baseDirectory = findBaseDirectory();
+  }
+
+  //~--- get methods ----------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @param name
+   *
+   * @return
+   */
+  public static File getDirectory(String name)
+  {
+    File directory = getFile(name);
+
+    IOUtil.mkdirs(directory);
+
+    return directory;
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @param name
+   *
+   * @return
+   */
+  public static File getFile(String name)
+  {
+    return new File(getInstance().baseDirectory, name);
+  }
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  private static BaseDirectory getInstance()
+  {
+    if (instance == null)
+    {
+      instance = new BaseDirectory();
+    }
+
+    return instance;
+  }
+
+  //~--- methods --------------------------------------------------------------
+
+  /**
+   * Method description
+   *
+   *
+   * @return
+   */
+  private File findBaseDirectory()
+  {
+    String path = System.getProperty(DIRECTORY_PROPERTY);
+
+    if (Util.isEmpty(path))
+    {
+      path = System.getenv(DIRECTORY_ENVIRONMENT);
+
+      if (Util.isEmpty(path))
+      {
+        path = System.getProperty("user.home").concat(File.separator).concat(
+          DIRECTORY_DEFAULT);
+      }
+    }
+
+    File directory = new File(path);
+
+    if (!directory.exists() &&!directory.mkdirs())
+    {
+      throw new IllegalStateException("could not create directory");
+    }
+
+    return directory;
+  }
+
+  //~--- fields ---------------------------------------------------------------
+
+  /** Field description */
+  private File baseDirectory;
+}