yona-projects / yona star
Yi EungJun 2014-07-21
Introduce the Yobi Update Notification feature. 
Site Administrator can see Update Available notification in Software
Update page.

Yobi fetches the latest version from https://github.com/naver/yobi. You
can configure the url by modifying application.update.repositoryUrl. The
url should be to a git repository of Yobi.

The default link to a release of Yobi is defined by
application.update.releaseUrlFormat and the default value is
https://github.com/naver/yobi/releases/tag/v{version}.
@39d5ea222dff3c4bbb542c6d4205489e41378a60
2706761
39d5ea2
app/controllers/SiteApp.java
--- app/controllers/SiteApp.java
+++ app/controllers/SiteApp.java
@@ -31,6 +31,7 @@
 
 import org.apache.commons.mail.EmailException;
 
 import org.apache.commons.mail.SimpleEmail;
 
 import org.codehaus.jackson.node.ObjectNode;
 
+import org.eclipse.jgit.api.errors.GitAPIException;
 
 import play.Configuration;
 
 import play.Logger;
 
 import play.db.ebean.Transactional;
@@ -48,6 +49,8 @@
 
 import java.util.*;
 
 
 import static play.libs.Json.toJson;
 
+
 
+import utils.Config;
 
 
 /**
 
  * The Class SiteApp.
@@ -247,4 +250,23 @@
 
 
         return ok(toJson(emails));
 
     }
 
+
 
+    /**
 
+     * Show the page to update Yobi.
 
+     */
 
+    public static Result update() throws GitAPIException {
 
+        String currentVersion = null;
 
+        String versionToUpdate = null;
 
+        Exception exception = null;
 
+
 
+        try {
 
+            currentVersion = Config.getCurrentVersion();
 
+            versionToUpdate = YobiUpdate.fetchVersionToUpdate();
 
+        } catch (Exception e) {
 
+            exception = e;
 
+        }
 
+
 
+        return ok(update.render(
 
+                "title.siteSetting", currentVersion, versionToUpdate, exception));
 
+    }
 
 }
 
39d5ea2
app/models/YobiUpdate.java (added)
+++ app/models/YobiUpdate.java
@@ -0,0 +1,94 @@
+/**
+ * Yobi, Project Hosting SW
+ *
+ * Copyright 2014 NAVER Corp.
+ * http://yobi.io
+ *
+ * @Author Yi EungJun
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package models;
+
+import com.github.zafarkhaja.semver.Version;
+import com.github.zafarkhaja.semver.util.UnexpectedElementTypeException;
+import com.typesafe.config.*;
+import org.eclipse.jgit.api.Git;
+import org.eclipse.jgit.api.errors.GitAPIException;
+import org.eclipse.jgit.api.errors.InvalidRemoteException;
+import org.eclipse.jgit.lib.Ref;
+import play.Configuration;
+import play.Logger;
+import play.libs.Akka;
+import scala.concurrent.duration.Duration;
+import utils.Config;
+
+import java.util.*;
+import java.util.concurrent.TimeUnit;
+
+public class YobiUpdate {
+    private static final String UPDATE_REPOSITORY_URL = Configuration.root()
+            .getString("application.update.repositoryUrl", "http://demo.yobi.io/naver/Yobi");
+    private static final String RELEASE_URL_FORMAT = Configuration.root()
+            .getString("application.update.releaseUrlFormat",
+                    "https://github.com/naver/yobi/releases/tag/v%s");
+
+    public static String getReleaseUrl(String version) throws GitAPIException {
+        return String.format(RELEASE_URL_FORMAT, version);
+    }
+
+    /**
+     * Fetch the latest version to update.
+     *
+     * @Return  a string to represent the version to update; null if there is
+     *          no version to update
+     */
+    public static String fetchVersionToUpdate() throws GitAPIException {
+        Version current = Version.valueOf(Config.semverize(Config.getCurrentVersion()));
+        Version latest = current;
+        boolean isUpdateRequired = false;
+
+        Collection<Ref> refs;
+
+        refs = Git.lsRemoteRepository()
+                .setRemote(UPDATE_REPOSITORY_URL)
+                .setHeads(false)
+                .setTags(true)
+                .call();
+
+        for(Ref ref : refs) {
+            String tag = ref.getName().replaceFirst("^refs/tags/", "");
+            if (tag.charAt(0) == 'v') {
+                String versionString = Config.semverize(tag);
+
+                try {
+                    Version ver = Version.valueOf(versionString);
+                    if (ver.greaterThan(latest)) {
+                        isUpdateRequired = true;
+                        latest = ver;
+                    }
+                } catch (UnexpectedElementTypeException e) {
+                    play.Logger.warn("Failed to parse a version: " +
+                            versionString);
+                }
+            }
+        }
+
+        if (isUpdateRequired) {
+            return latest.toString();
+        } else {
+            return null;
+        }
+    }
+}
2706761
39d5ea2
app/utils/Config.java
--- app/utils/Config.java
+++ app/utils/Config.java
@@ -20,11 +20,14 @@
 
  */
 
 package utils;
 
 
+import com.typesafe.config.*;
 
 import org.apache.commons.lang3.ObjectUtils;
 
 import play.Configuration;
 
 import play.mvc.Http;
 
 
+import java.io.File;
 
 import java.net.*;
 
+import java.nio.file.Paths;
 
 import java.util.Enumeration;
 
 
 public class Config {
@@ -208,4 +211,41 @@
 
     public static URI createFullURI(String uri) throws URISyntaxException {
 
         return createFullURI(new URI(uri));
 
     }
 
+
 
+    /**
 
+     * Convert the given version to be compatible with
 
+     * <a href="http://semver.org/">semver</a>.
 
+     *
 
+     * Examples:
 
+     *   v0.5.7 -> 0.5.7
 
+     *   0.5 -> 0.5.0
 
+     *   0.4.0.pre -> 0.4.0-pre
 
+     *
 
+     * @param ver  a version string to be semverized
 
+     * @return     the semverized string
 
+     */
 
+    public static String semverize(String ver) {
 
+        // v0.5.7 -> 0.5.7
 
+        ver = ver.replaceFirst("^v", "");
 
+
 
+        // 0.4.0.pre -> 0.4.0-pre
 
+        ver = ver.replaceAll("\\.([^\\d]+)","-$1");
 
+
 
+        // 0.5 -> 0.5.0
 
+        // 0.5-alpha -> 0.5.0-alpha
 
+        ver = ver.replaceFirst("^(\\d+\\.\\d+)($|-)", "$1.0$2");
 
+
 
+        return ver;
 
+    }
 
+
 
+    /**
 
+     * Return the version of Yobi installed currently.
 
+     *
 
+     * @return  the current version
 
+     */
 
+    public static String getCurrentVersion() {
 
+        File versionFile = Paths.get("conf", "version.conf").toFile();
 
+
 
+        return ConfigFactory.parseFile(versionFile).resolve().getString("app.version");
 
+    }
 
 }
2706761
39d5ea2
app/views/site/siteMngLayout.scala.html
--- app/views/site/siteMngLayout.scala.html
+++ app/views/site/siteMngLayout.scala.html
@@ -59,6 +59,10 @@
 
                     <li class="@isActiveMenu(routes.SiteApp.massMail())">
 
                         <a href="@routes.SiteApp.massMail()">@Messages("site.sidebar.massMail")</a>
 
                     </li>
 
+                    <li class="@isActiveMenu(routes.SiteApp.update())">
 
+                        <a href="@routes.SiteApp.update()">@Messages("site.sidebar.update")
 
+                        </a>
 
+                    </li>
 
                 </ul>
 
             </div>
 
             <div class="span10">
 
39d5ea2
app/views/site/update.scala.html (added)
+++ app/views/site/update.scala.html
@@ -0,0 +1,48 @@
+@**
+* Yobi, Project Hosting SW
+*
+* Copyright 2014 NAVER Corp.
+* http://yobi.io
+*
+* @Author Yi EungJun
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+**@
+@(message: String, currentVersion: String, versionToUpdate: String, exception: Exception = null)
+
+@import org.apache.commons.lang.exception.ExceptionUtils
+@import utils.TemplateHelper._
+
+@siteMngLayout(message) {
+    <div class="title_area">
+        <h2 class="pull-left">@Messages("site.sidebar.update")</h2>
+    </div>
+
+    @if(versionToUpdate != null){
+      <p><strong>@Messages("site.update.isAvailable", versionToUpdate)</strong>
+      <a href="@YobiUpdate.getReleaseUrl(versionToUpdate)" class="ybtn ybtn-success">@Messages("site.update.download")</a></p>
+    }
+
+    @if(currentVersion != null){
+      <p>@Messages("site.update.currentVersion", currentVersion)</p>
+    }
+
+    @if(versionToUpdate == null && exception == null) {
+      <p>@Messages("site.update.isNotNecessary", currentVersion)</p>
+    }
+
+    @if(exception != null){
+      <p>@Messages("site.update.error")</p>
+      <pre>@ExceptionUtils.getStackTrace(exception)</pre>
+    }
+}
2706761
39d5ea2
conf/application.conf.default
--- conf/application.conf.default
+++ conf/application.conf.default
@@ -127,6 +127,14 @@
 
 # If this value is undefined or not positive number, notifications will remain forever.
 
 # application.notification.keep-time = 60
 
 
+# Software Update
 
+# ~~~~~~~~~~~~~~~
 
+# A url to the git repository for Yobi releases.
 
+application.update.repositoryUrl = "https://github.com/naver/yobi"
 
+# A format to construct the url to latest Yobi release. "%s" is a format
 
+# specifier for Yobi version to download like "0.5.7".
 
+application.update.releaesUrlFormat = "https://github.com/naver/yobi/releases/tag/v%s"
 
+
 
 #customize play default thread pool size
 
 play {
 
   akka {
2706761
39d5ea2
conf/messages
--- conf/messages
+++ conf/messages
@@ -672,6 +672,12 @@
 
 site.sidebar.postList = Posts
 
 site.sidebar.projectList = Projects
 
 site.sidebar.userList = Users
 
+site.sidebar.update = Software Update
 
+site.update.currentVersion = Current version is Yobi {0}
 
+site.update.download = Download
 
+site.update.isAvailable = Yobi {0} is available
 
+site.update.isNotNecessary = You are using the latest version
 
+site.update.error = Failed to check for updates because of the following error:
 
 site.user.delete = Delete user
 
 site.user.deleteConfirm = Are you sure you want this user to leave?
 
 site.userList.deleteAlert = This user cannot be deleted because this user is the only manager of the project.
2706761
39d5ea2
conf/messages.ko
--- conf/messages.ko
+++ conf/messages.ko
@@ -672,6 +672,12 @@
 
 site.sidebar.postList = 게시물
 
 site.sidebar.projectList = 프로젝트
 
 site.sidebar.userList = 사용자
 
+site.sidebar.update = 업데이트
 
+site.update.currentVersion = 현재 버전은 {0} 입니다
 
+site.update.download = 다운로드
 
+site.update.error = 다음과 같이 에러가 발생하여 업데이트 할 버전을 확인하지 못했습니다.
 
+site.update.isAvailable = Yobi {0} 버전으로 업데이트 할 수 있습니다
 
+site.update.isNotNecessary = 현재 최신 버전을 사용중입니다
 
 site.user.delete = 사용자 삭제
 
 site.user.deleteConfirm = 정말로 해당 사용자를 사이트에서 탈퇴시키겠습니까?
 
 site.userList.deleteAlert = 프로젝트의 유일한 관리자이므로 사이트에서 삭제할 수 없습니다.
2706761
39d5ea2
conf/routes
--- conf/routes
+++ conf/routes
@@ -70,6 +70,7 @@
 
 GET            /sites/projectList                                                     controllers.SiteApp.projectList(filter:String ?= "", pageNum: Int ?=0)
 
 DELETE         /sites/project/delete/:projectId                                       controllers.SiteApp.deleteProject(projectId:Long)
 
 POST           /sites/toggleAccountLock                                               controllers.SiteApp.toggleAccountLock(loginId: String, state: String ?= null, query: String ?= null)
 
+GET            /sites/update                                                          controllers.SiteApp.update()
 
 GET            /lostPassword                                                          controllers.PasswordResetApp.lostPassword
 
 POST           /lostPassword                                                          controllers.PasswordResetApp.requestResetPasswordEmail()
 
 GET            /resetPassword                                                         controllers.PasswordResetApp.resetPasswordForm(s:String)
2706761
39d5ea2
project/Build.scala
--- project/Build.scala
+++ project/Build.scala
@@ -49,7 +49,8 @@
 
       "commons-collections" % "commons-collections" % "3.2.1",
 
       "org.jsoup" % "jsoup" % "1.7.2",
 
       "com.googlecode.juniversalchardet" % "juniversalchardet" % "1.0.3",
 
-      "org.mockito" % "mockito-all" % "1.9.0" % "test"
 
+      "org.mockito" % "mockito-all" % "1.9.0" % "test",
 
+      "com.github.zafarkhaja" % "java-semver" % "0.7.2"
 
   )
 
 
     val projectSettings = Seq(
2706761
39d5ea2
test/utils/ConfigTest.java
--- test/utils/ConfigTest.java
+++ test/utils/ConfigTest.java
@@ -100,4 +100,13 @@
 
         assertThat(Config.getSiteName()).isEqualTo("Yobi");
 
         Helpers.stop(app);
 
     }
 
+
 
+    @Test
 
+    public void semverize() {
 
+        assertThat(Config.semverize("0.5.7")).isEqualTo("0.5.7");
 
+        assertThat(Config.semverize("v0.5.7")).isEqualTo("0.5.7");
 
+        assertThat(Config.semverize("0.5")).isEqualTo("0.5.0");
 
+        assertThat(Config.semverize("0.4.0.pre")).isEqualTo("0.4.0-pre");
 
+        assertThat(Config.semverize("0.5-alpha")).isEqualTo("0.5.0-alpha");
 
+    }
 
 }
Add a comment
List