Merge pull request #25 from aadrian/patch_1

updates and use backup/ subdirectory

Author: aadrian

README.MD

@@ -1,14 +1,14 @@
 # gitbucket-h2-backup-plugin
 
-This plugin enhances [takezoe/gitbucket](https://github.com/takezoe/gitbucket) by offering a way to backup/dump the h2 database of gitbucket.
+This plugin enhances [GitBucket](https://github.com/gitbucket/gitbucket) by offering a way to backup/dump the H2 database of GitBucket.
 
-It originates from [pull request #845](takezoe/gitbucket#845) and can be used to adress database backup described in [gitbucket backup documentation](https://github.com/takezoe/gitbucket/wiki/Backup)
+It originates from [pull request #845](takezoe/gitbucket#845) and can be used to address database backup described in [gitbucket backup documentation](https://github.com/takezoe/gitbucket/wiki/Backup)
 
 ## Features
 
 ### H2 Backup
 
-This plugin allows to backup the underlying H2 database used by default by gitbucket.
+This plugin allows to backup the underlying H2 database used by default by GitBucket.
 
 ## Usage
 
@@ -45,6 +45,7 @@ On success, you will receive a `HTTP 200` answer with a body containing `done: F
 
 Plugin version | GitBucket version
 :--------------|:-----------------
+1.5.x          | >= 4.12.y
 1.4.x          | >= 4.10.y
 1.3.x          | >= 4.3.y
 1.2.x          | 4.x.y
@@ -64,6 +65,9 @@ sbt clean package
 
 ## Release Notes
 
+### 1.5.0
+- compatibility with gitbucket 4.12.1 and scala 2.12
+
 ### 1.4.0
 
 - compatibility with gitbucket 4.10, scala 2.12 [#20](https://github.com/gitbucket-plugins/gitbucket-h2-backup-plugin/issues/20)
@@ -94,7 +98,7 @@ sbt clean package
 In version 1.4.0, it is possible to secure the `database/backup` endpoint:
 
 - launch gitbucket with System property _secure.backup_ set to true (for example `-Dsecure.backup=true` on the command line)
-- due to actual limitations of gibucket & plugins security, once the previous setting is activated, 
+- due to actual limitations of gitbucket & plugins security, once the previous setting is activated, 
 a call to `http://YOUR_GITBUCKET/database/backup` will be temporary redirected `http://YOUR_GITBUCKET/api/v3/plugins/database/backup`. 
 You have to follow this temporary redirection.
    - if you call the endpoint using _httpie_, use the `--follow` parameter

build.sbt

@@ -1,18 +1,18 @@
 val Organization = "fr.brouillard.gitbucket"
 val ProjectName = "gitbucket-h2-backup-plugin"
-val ProjectVersion = "1.4.0"
+val ProjectVersion = "1.5.0"
 
 lazy val h2_backup_plugin = (project in file(".")).enablePlugins(SbtTwirl)
 
 organization := Organization
 name := ProjectName
 version := ProjectVersion
-scalaVersion := "2.12.1"
+scalaVersion := "2.12.2"
 
 
 libraryDependencies ++= Seq(
-  "io.github.gitbucket" %% "gitbucket"         % "4.10.0" % "provided",
-  "io.github.gitbucket"  % "solidbase"         % "1.0.0" % "provided",
+  "io.github.gitbucket" %% "gitbucket"         % "4.12.1" % "provided",
+  "io.github.gitbucket"  % "solidbase"         % "1.0.2" % "provided",
   "com.typesafe.play"   %% "twirl-compiler"    % "1.3.0" % "provided",
   "javax.servlet"        % "javax.servlet-api" % "3.1.0" % "provided"
 )

project/build.properties

@@ -1 +1 @@
-sbt.version = 0.13.12
+sbt.version = 0.13.15

sbt-launch-0.13.12.jar

@@ -9,13 +9,14 @@ class Plugin extends gitbucket.core.plugin.Plugin {
 
   override val pluginName: String = "H2 Database Backup Plugin"
 
-  override val description: String = "Allows to export h2 database of gitbucket"
+  override val description: String = "Allows to export the H2 database of GitBucket"
 
   override val versions: List[Version] = List(
     new Version("1.0.0"),
     new Version("1.2.0"),
     new Version("1.3.0"),
-    new Version("1.4.0")
+    new Version("1.4.0"),
+    new Version("1.5.0")
   )
 
   override val systemSettingMenus: Seq[(Context) => Option[Link]] = Seq(

sbt.bat

@@ -27,18 +27,18 @@ class H2BackupController extends ControllerBase with AdminAuthenticator {
   // private val defaultBackupFile:String = new File(GitBucketHome, "gitbucket-database-backup.zip").toString;
 
   def exportDatabase(exportFile: File): Unit = {
-    val destFile = if (exportFile.isAbsolute()) exportFile else new File(GitBucketHome, exportFile.toString)
+    val destFile = if (exportFile.isAbsolute()) exportFile else new File(GitBucketHome+"/backup", exportFile.toString)
 
     val session = Database.getSession(request)
     val conn = session.conn
 
     logger.info("exporting database to {}", destFile)
 
-    conn.prepareStatement("BACKUP TO '" + destFile + "'").execute();
+    conn.prepareStatement("BACKUP TO '" + destFile + "'").execute()
   }
 
   get("/admin/h2backup") (adminOnly {
-    html.export(flash.get("info"), flash.get("dest").orElse(Some(defaultBackupFileName())));
+    html.export(flash.get("info"), flash.get("dest").orElse(Some(defaultBackupFileName())))
   })
 
   get("/api/v3/plugins/database/backup") {
@@ -64,13 +64,14 @@ class H2BackupController extends ControllerBase with AdminAuthenticator {
 
   post("/database/backup", backupForm) { form: BackupForm =>
     exportDatabase(new File(form.destFile))
-    flash += "info" -> "H2 Database has been exported."
+    val msg:String = "H2 Database has been exported to '"+form.destFile+"'."
+    flash += "info" -> msg
     flash += "dest" -> form.destFile
     redirect("/admin/h2backup")
   }
 
   private def defaultBackupFileName(): String = {
-    val format = new java.text.SimpleDateFormat("yyyy-MM-dd-HHmm")
-    "gitbucket-database-backup-" + format.format(new Date())+ ".zip";
+    val format = new java.text.SimpleDateFormat("yyyy-MM-dd_HH-mm")
+    "gitbucket-db-" + format.format(new Date())+ ".zip"
   }
 }

sbt.sh

@@ -10,14 +10,14 @@
 @information(info)
 <form action="@path/database/backup" method="POST">
     <div class="panel panel-default">
-        <div class="panel-heading strong">Database backup</div>
+        <div class="panel-heading strong">H2 Database Backup</div>
         <div class="panel-body">
             <fieldset>
-                <label><span class="strong">Database backup file:</span></label>
+                <label><span class="strong">H2 Database Backup File:</span></label>
                 <p class="muted">
-                    Allows to export/backup the database content. The same action can be achieved via an HTTP GET call to @path/database/backup
+                    Allows to export/backup the H2 database content. The same action can be achieved via an HTTP GET call to @path/database/backup .
                 </p>
-                <input type="text" name="dest" value="@dest" style="width: 400px" />
+                backup/<input type="text" name="dest" value="@dest" style="width: 400px" />
             </fieldset>
         </div>
     </div>