Merge pull request #7 from gitbucket/disable-email

Disable email notification

Author: takezoe

build.sbt

@@ -1,12 +1,12 @@
 val Organization = "io.github.gitbucket"
 val ProjectName = "gitbucket-notifications-plugin"
-val ProjectVersion = "1.2.0"
+val ProjectVersion = "1.3.0"
 val GitBucketVersion = Option(System.getProperty("gitbucket.version")).getOrElse("4.17.0")
 
 name := ProjectName
 organization := Organization
 version := ProjectVersion
-scalaVersion := "2.12.2"
+scalaVersion := "2.12.3"
 
 lazy val root = (project in file(".")).enablePlugins(SbtTwirl)
 

project/build.properties

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

src/main/resources/update/gitbucket-notifications_1.3.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<changeSet>
+    <!--================================================================================================-->
+    <!-- NOTIFICATIONS_ACCOUNT -->
+    <!--================================================================================================-->
+    <createTable tableName="NOTIFICATIONS_ACCOUNT">
+        <column name="USER_NAME" type="varchar(100)" nullable="false"/>
+        <column name="DISABLE_EMAIL" type="boolean" nullable="false"/>
+    </createTable>
+
+    <addPrimaryKey constraintName="IDX_NOTIFICATIONS_ACCOUNT_PK" tableName="NOTIFICATIONS_ACCOUNT" columnNames="USER_NAME"/>
+    <addForeignKeyConstraint constraintName="IDX_NOTIFICATIONS_ACCOUNT_FK0" baseTableName="NOTIFICATIONS_ACCOUNT" baseColumnNames="USER_NAME" referencedTableName="ACCOUNT" referencedColumnNames="USER_NAME"/>
+
+</changeSet>

src/main/scala/Plugin.scala

@@ -1,5 +1,6 @@
 import gitbucket.core.controller.Context
 import gitbucket.core.model.Issue
+import gitbucket.core.plugin.Link
 import gitbucket.core.service.RepositoryService.RepositoryInfo
 import gitbucket.core.util.Implicits.request2Session
 import gitbucket.notifications._
@@ -22,7 +23,10 @@ class Plugin extends gitbucket.core.plugin.Plugin {
     new Version("1.1.0",
       new LiquibaseMigration("update/gitbucket-notifications_1.1.xml")
     ),
-    new Version("1.2.0")
+    new Version("1.2.0"),
+    new Version("1.3.0",
+      new LiquibaseMigration("update/gitbucket-notifications_1.3.xml")
+    )
   )
 
   override val controllers = Seq(
@@ -62,4 +66,15 @@ class Plugin extends gitbucket.core.plugin.Plugin {
       }
   )
 
+  override val accountSettingMenus = Seq(
+    (context: Context) =>
+      context.loginAccount map { account =>
+        Link(
+          id    = "notifications",
+          label = "Notifications",
+          path  = s"${account.userName}/_notifications"
+        )
+      }
+  )
+
 }

src/main/scala/gitbucket/notifications/controller/NotificationsController.scala

@@ -3,17 +3,19 @@ package gitbucket.notifications.controller
 import gitbucket.core.controller.ControllerBase
 import gitbucket.core.service.{AccountService, IssuesService, RepositoryService}
 import gitbucket.core.util.Implicits._
-import gitbucket.core.util.ReadableUsersAuthenticator
+import gitbucket.core.util.{OneselfAuthenticator, ReadableUsersAuthenticator}
 import gitbucket.core.util.SyntaxSugars._
 import gitbucket.notifications.model.Watch
 import gitbucket.notifications.service.NotificationsService
 import org.scalatra.Ok
 
 class NotificationsController extends NotificationsControllerBase
-  with NotificationsService with RepositoryService with AccountService with IssuesService with ReadableUsersAuthenticator
+  with NotificationsService with RepositoryService with AccountService with IssuesService
+  with ReadableUsersAuthenticator with OneselfAuthenticator
 
 trait NotificationsControllerBase extends ControllerBase {
-  self: NotificationsService with RepositoryService with AccountService with IssuesService with ReadableUsersAuthenticator =>
+  self: NotificationsService with RepositoryService with AccountService with IssuesService
+    with ReadableUsersAuthenticator with OneselfAuthenticator =>
 
   ajaxPost("/:owner/:repository/watch")(readableUsersOnly { repository =>
     params.get("notification").flatMap(Watch.Notification.valueOf).map { notification =>
@@ -33,4 +35,19 @@ trait NotificationsControllerBase extends ControllerBase {
     }
   })
 
+  get("/:userName/_notifications")(oneselfOnly {
+    val userName = params("userName")
+    getAccountByUserName(userName).map { account =>
+      gitbucket.notifications.html.settings(account, isDisableEmailNotification(account))
+    } getOrElse NotFound()
+  })
+
+  ajaxPost("/:userName/_notifications")(oneselfOnly {
+    val userName = params("userName")
+    params.getAs[Boolean]("disable").map { disable =>
+      updateEmailNotification(userName, disable)
+      Ok()
+    } getOrElse NotFound()
+  })
+
 }

src/main/scala/gitbucket/notifications/model/NotificationsAccount.scala

@@ -0,0 +1,18 @@
+package gitbucket.notifications.model
+
+trait NotificationsAccountComponent { self: gitbucket.core.model.Profile =>
+  import profile.api._
+
+  lazy val NotificationsAccounts = TableQuery[NotificationsAccounts]
+
+  class NotificationsAccounts(tag: Tag) extends Table[NotificationsAccount](tag, "NOTIFICATIONS_ACCOUNT") {
+    val userName     = column[String]("USER_NAME")
+    val disableEmail = column[Boolean]("DISABLE_EMAIL")
+    def * = (userName, disableEmail) <> (NotificationsAccount.tupled, NotificationsAccount.unapply)
+  }
+}
+
+case class NotificationsAccount(
+  userName: String,
+  disableEmail: Boolean
+)

src/main/scala/gitbucket/notifications/model/Profile.scala

@@ -5,3 +5,4 @@ import gitbucket.core.model._
 object Profile extends CoreProfile
   with IssueNotificationComponent
   with WatchComponent
+  with NotificationsAccountComponent

src/main/scala/gitbucket/notifications/service/NotificationsHook.scala

@@ -137,6 +137,7 @@ class IssueHook extends gitbucket.core.plugin.IssueHook
       getAccountByUserName(_)
         .filterNot (_.isGroupAccount)
         .filterNot (LDAPUtil.isDummyMailAddress)
+        .filterNot (isDisableEmailNotification)
         .map (_.mailAddress)
     )
   }

src/main/scala/gitbucket/notifications/service/NotificationsService.scala

@@ -1,6 +1,6 @@
 package gitbucket.notifications.service
 
-import gitbucket.core.model.Issue
+import gitbucket.core.model.{Account, Issue}
 import gitbucket.core.service.{AccountService, IssuesService, RepositoryService}
 import gitbucket.notifications.model._, Profile._
 import profile.blockingApi._
@@ -42,6 +42,15 @@ trait NotificationsService {
     )
   }
 
+  def isDisableEmailNotification(account: Account)(implicit s: Session): Boolean = {
+    NotificationsAccounts.filter(_.userName === account.userName.bind).firstOption.exists(_.disableEmail)
+  }
+
+  def updateEmailNotification(userName: String, disable: Boolean)(implicit s: Session): Unit = {
+    NotificationsAccounts.filter(_.userName === userName.bind).delete
+    if (disable) NotificationsAccounts insert NotificationsAccount(userName = userName, disableEmail = true)
+  }
+
   def autoSubscribeUsersForRepository(owner: String, repository: String)(implicit s: Session): List[String] = {
     // individual repository's owner
     owner ::

src/main/twirl/gitbucket/notifications/settings.scala.html

@@ -0,0 +1,26 @@
+@(account: gitbucket.core.model.Account,
+  disableEmail: Boolean)(implicit context: gitbucket.core.controller.Context)
+
+@gitbucket.core.html.main("Notifications"){
+  @gitbucket.core.account.html.menu("notifications", account.userName, account.isGroupAccount){
+    <div class="panel panel-default">
+      <div class="panel-heading strong">Email notification preferences</div>
+      <div class="panel-body">
+        <fieldset class="form-group">
+          <p class="muted">If checked, never be notified of anything.</p>
+          <label for="disable">
+            <input type="checkbox" name="disable" id="disable" value="true" @if(disableEmail){checked}/>
+            Disable
+          </label>
+        </fieldset>
+      </div>
+    </div>
+  }
+}
+<script>
+$(function(){
+  $('#disable').click(function(){
+    $.post('@context.path/@account.userName/_notifications', { 'disable': this.checked });
+  });
+});
+</script>