initial creation of gitbucket-announce-plugin

Author: McFoggy

.gitignore

@@ -0,0 +1,2 @@
+.idea/
+target/

README.MD

@@ -0,0 +1,28 @@
+# gitbucket-announce-plugin
+
+This plugin enhances [takezoe/gitbucket](https://github.com/takezoe/gitbucket) by providing an announce mechanism.
+
+## Features
+
+### Global Announce
+
+This feature allows to notify gitbucket users. It is available to `admin` via  the `System Administration` menu of gitbucket.
+
+The global announce, sends an email to all active users.
+
+It is then possible, for example, to notify every user that an upgarde of the system is planned the next monday at midday.
+
+## Usage
+
+- Open a shell window at the root of the project, hit `sbt package` in the root directory of this repository
+- remove any copy of gitbucket-announce-plugin from GITBUCKET_HOME/plugins
+- Copy target/scala-2.11/gitbucket-announce-plugin_2.11-1.0.jar into GITBUCKET_HOME/plugins
+- Restart GitBucket
+
+## Release Notes
+
+### 1.0
+
+- introduce gitbucket-announce-plugin
+- global announce by email in `System Administration` menu
+- depends on takezoe/gitbucket#861

project/build.properties

@@ -0,0 +1 @@
+sbt.version = 0.13.5

project/build.scala

@@ -0,0 +1,34 @@
+import sbt._
+import Keys._
+import play.twirl.sbt.SbtTwirl
+import play.twirl.sbt.Import.TwirlKeys._
+
+object MyBuild extends Build {
+
+  val Organization = "fr.brouillard.gitbucket"
+  val Name = "gitbucket-announce-plugin"
+  val Version = "1.0"
+  val ScalaVersion = "2.11.6"
+
+  lazy val project = Project (
+    "gitbucket-announce-plugin",
+    file(".")
+  )
+  .settings(
+    sourcesInBase := false,
+    organization := Organization,
+    name := Name,
+    version := Version,
+    scalaVersion := ScalaVersion,
+    scalacOptions := Seq("-deprecation", "-language:postfixOps"),
+    resolvers ++= Seq(
+      "amateras-repo" at "http://amateras.sourceforge.jp/mvn/"
+    ),
+    libraryDependencies ++= Seq(
+      "gitbucket"          % "gitbucket-assembly" % "3.5.0" % "provided",
+      "com.typesafe.play" %% "twirl-compiler"     % "1.0.4" % "provided",
+      "javax.servlet"      % "javax.servlet-api"  % "3.1.0" % "provided"
+    ),
+    javacOptions in compile ++= Seq("-target", "7", "-source", "7")
+  ).enablePlugins(SbtTwirl)
+}

project/plugins.sbt

@@ -0,0 +1,3 @@
+logLevel := Level.Warn
+
+addSbtPlugin("com.typesafe.sbt" % "sbt-twirl" % "1.0.2")

sbt-launch-0.13.5.jar

@@ -0,0 +1,2 @@
+set SCRIPT_DIR=%~dp0
+java -Dsbt.log.noformat=true -XX:+CMSClassUnloadingEnabled -XX:MaxPermSize=256m -Xmx512M -Xss2M -jar "%SCRIPT_DIR%\sbt-launch-0.13.5.jar" %*

sbt.bat

@@ -0,0 +1,2 @@
+#!/bin/sh
+java -Dsbt.log.noformat=true -XX:+CMSClassUnloadingEnabled -XX:MaxPermSize=256m -Xmx512M -Xss2M -jar `dirname $0`/sbt-launch-0.13.5.jar "$@"

sbt.sh

@@ -0,0 +1,39 @@
+import javax.servlet.ServletContext
+
+import fr.brouillard.gitbucket.announce.controller.AnnounceController
+import gitbucket.core.plugin.PluginRegistry
+import gitbucket.core.service.SystemSettingsService.SystemSettings
+import gitbucket.core.util.Version
+
+class Plugin extends gitbucket.core.plugin.Plugin {
+  override val pluginId: String = "announce"
+
+  override val pluginName: String = "Announce Plugin"
+
+  override val description: String = "Allows to handle announces for gitbucket"
+
+  override val versions: List[Version] = List(
+    Version(1, 0)
+  )
+
+  override def javaScripts(registry: PluginRegistry, context: ServletContext, settings: SystemSettings): Seq[(String, String)] = {
+    // Add Snippet link to the header
+    val path = settings.baseUrl.getOrElse(context.getContextPath)
+    Seq(
+      ".*/admin/announce" -> s"""
+        |$$('#system-admin-menu-container>li:last').after(
+        |  $$('<li class="active"><a href="${path}/admin/announce">Global Announce</a></li>')
+        |);
+      """.stripMargin,
+      ".*/admin/(?!announce).*" -> s"""
+        |$$('#system-admin-menu-container>li:last').after(
+        |  $$('<li><a href="${path}/admin/announce">Global Announce</a></li>')
+        |);
+      """.stripMargin
+    )
+  }
+
+  override val controllers = Seq(
+    "/admin/announce" -> new AnnounceController()
+  )
+}

src/main/scala/Plugin.scala

@@ -0,0 +1,74 @@
+package fr.brouillard.gitbucket.announce.controller
+
+import fr.brouillard.gitbucket.announce.html
+import gitbucket.core.controller.ControllerBase
+import gitbucket.core.service.{AccountService, SystemSettingsService}
+import gitbucket.core.servlet.Database
+import gitbucket.core.util.AdminAuthenticator
+import jp.sf.amateras.scalatra.forms._
+import org.apache.commons.mail.{DefaultAuthenticator, HtmlEmail}
+import org.pegdown.PegDownProcessor
+import org.slf4j.LoggerFactory
+
+class AnnounceController extends AnnounceControllerBase
+with AdminAuthenticator
+
+trait AnnounceControllerBase extends ControllerBase with AccountService {
+  self:  AdminAuthenticator =>
+
+  private val logger = LoggerFactory.getLogger(classOf[AnnounceController])
+
+  case class AnnounceForm(content: String, subject: String)
+
+  private val announceForm = mapping(
+    "content" -> trim(label("Announce", text(required))),
+    "subject" -> trim(label("Subject", text(required)))
+  )(AnnounceForm.apply)
+
+  get("/admin/announce")(adminOnly {
+    html.announce(flash.get("info"))
+  })
+
+  post("/admin/announce", announceForm)(adminOnly { form =>
+    flash += "info" -> "Announce has been sent."
+
+    if (logger.isDebugEnabled) {
+      logger.debug("sending announce: {}", form.content)
+    }
+
+    val systemSettings = new SystemSettingsService {}.loadSystemSettings
+    if (systemSettings.notification && systemSettings.smtp.nonEmpty) {
+      val email = new HtmlEmail
+      val smtp = systemSettings.smtp.get
+
+      email.setHostName(smtp.host)
+      email.setSmtpPort(smtp.port.get)
+      smtp.user.foreach { user =>
+        email.setAuthenticator(new DefaultAuthenticator(user, smtp.password.getOrElse("")))
+      }
+      smtp.ssl.foreach { ssl =>
+        email.setSSLOnConnect(ssl)
+      }
+      smtp.fromAddress
+        .map (_ -> smtp.fromName.orNull)
+        .orElse (Some("[email protected]" -> context.loginAccount.get.userName))
+        .foreach { case (address, name) =>
+        email.setFrom(address, name)
+      }
+      email.setCharset("UTF-8")
+      email.setSubject(form.subject)
+
+      email.setHtmlMsg(new PegDownProcessor().markdownToHtml(form.content))
+
+      logger.info("sending email: {}", form.content)
+      val database = Database()
+      database withSession { implicit session =>
+        getAllUsers(false).filter(account => !account.isGroupAccount && account.mailAddress.nonEmpty).foreach(account => email.addBcc(account.mailAddress))
+      }
+
+      email.send()
+    }
+
+    redirect("/admin/announce")
+  })
+}