Initialize repository

Author: eikendev

.editorconfig

@@ -0,0 +1,18 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_style = space
+
+[Makefile]
+indent_style = tab

.gitignore

@@ -0,0 +1,22 @@
+*.db
+*.yml
+debugging/
+pushbits
+
+### Go
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+

LICENSE

@@ -0,0 +1,7 @@
+ISC License (ISC)
+
+Copyright 2020 eikendev
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Makefile

@@ -0,0 +1,15 @@
+.PHONY: test
+test:
+	stdout=$$(gofmt -l . 2>&1); \
+	if [ "$$stdout" ]; then \
+		exit 1; \
+	fi
+	go test -v -cover ./...
+	stdout=$$(golint ./... 2>&1); \
+	if [ "$$stdout" ]; then \
+		exit 1; \
+	fi
+
+.PHONY: dependencies
+dependencies:
+	go get -u golang.org/x/lint/golint

README.md

@@ -0,0 +1,30 @@
+## About
+
+PushBits is a relay server for push notifications.
+It enables your services to send notifications via a simple web API, and delivers them to you through various messaging services.
+
+The vision is to have compatibility with [Gotify](https://gotify.net/) on the sending side, while on the receiving side established services are used.
+This has the advantages that
+- plugins written for Gotify and
+- clients written for all major platforms can be reused.
+
+For now, only the [Matrix protocol](https://matrix.org/) is supported, but support for different services like [Telegram](https://telegram.org/) could be added in the future.
+I am myself experimenting with Matrix currently because I like the idea of a federated, synchronized but still end-to-end encrypted protocol.
+
+The idea for this software and most parts of the initial source are heavily inspired by [Gotify](https://gotify.net/).
+Many thanks to [jmattheis](https://jmattheis.de/) for his well-structured code.
+
+## Usage
+
+PushBits is meant to be self-hosted.
+You are advised to install PushBits behind a reverse proxy and enable TLS.
+
+At the moment, there is no front-end implemented.
+New users and applications need to be created via the API.
+Details will be made available once the interface is more stable.
+
+## Development
+
+PushBits is currently in alpha stage.
+The API is neither stable, nor is provided functionality guaranteed to work.
+Stay tuned! 😉

api/application.go

@@ -0,0 +1,63 @@
+package api
+
+import (
+	"log"
+	"net/http"
+
+	"github.com/eikendev/pushbits/authentication"
+	"github.com/eikendev/pushbits/model"
+
+	"github.com/gin-gonic/gin"
+)
+
+// The ApplicationDatabase interface for encapsulating database access.
+type ApplicationDatabase interface {
+	CreateApplication(application *model.Application) error
+	GetApplicationByToken(token string) (*model.Application, error)
+}
+
+// The ApplicationDispatcher interface for relaying notifications.
+type ApplicationDispatcher interface {
+	RegisterApplication(name, user string) (string, error)
+}
+
+// ApplicationHandler holds information for processing requests about applications.
+type ApplicationHandler struct {
+	DB         ApplicationDatabase
+	Dispatcher ApplicationDispatcher
+}
+
+func (h *ApplicationHandler) applicationExists(token string) bool {
+	application, _ := h.DB.GetApplicationByToken(token)
+	return application != nil
+}
+
+// CreateApplication is used to create a new user.
+func (h *ApplicationHandler) CreateApplication(ctx *gin.Context) {
+	application := model.Application{}
+
+	if success := successOrAbort(ctx, http.StatusBadRequest, ctx.Bind(&application)); !success {
+		return
+	}
+
+	user := authentication.GetUser(ctx)
+
+	application.Token = authentication.GenerateNotExistingToken(authentication.GenerateApplicationToken, h.applicationExists)
+	application.UserID = user.ID
+
+	log.Printf("User %s will receive notifications for application %s.\n", user.Name, application.Name)
+
+	matrixid, err := h.Dispatcher.RegisterApplication(application.Name, user.MatrixID)
+
+	if success := successOrAbort(ctx, http.StatusInternalServerError, err); !success {
+		return
+	}
+
+	application.MatrixID = matrixid
+
+	if success := successOrAbort(ctx, http.StatusInternalServerError, h.DB.CreateApplication(&application)); !success {
+		return
+	}
+
+	ctx.JSON(http.StatusOK, &application)
+}

api/notification.go

@@ -0,0 +1,53 @@
+package api
+
+import (
+	"log"
+	"net/http"
+	"strings"
+	"time"
+
+	"github.com/eikendev/pushbits/authentication"
+	"github.com/eikendev/pushbits/model"
+
+	"github.com/gin-gonic/gin"
+)
+
+// The NotificationDatabase interface for encapsulating database access.
+type NotificationDatabase interface {
+}
+
+// The NotificationDispatcher interface for relaying notifications.
+type NotificationDispatcher interface {
+	SendNotification(a *model.Application, n *model.Notification) error
+}
+
+// NotificationHandler holds information for processing requests about notifications.
+type NotificationHandler struct {
+	DB         NotificationDatabase
+	Dispatcher NotificationDispatcher
+}
+
+// CreateNotification is used to create a new notification for a user.
+func (h *NotificationHandler) CreateNotification(ctx *gin.Context) {
+	notification := model.Notification{}
+
+	if success := successOrAbort(ctx, http.StatusBadRequest, ctx.Bind(&notification)); !success {
+		return
+	}
+
+	application := authentication.GetApplication(ctx)
+	log.Printf("Sending notification for application %s.\n", application.Name)
+
+	notification.ID = 0
+	notification.ApplicationID = application.ID
+	if strings.TrimSpace(notification.Title) == "" {
+		notification.Title = application.Name
+	}
+	notification.Date = time.Now()
+
+	if success := successOrAbort(ctx, http.StatusInternalServerError, h.Dispatcher.SendNotification(application, &notification)); !success {
+		return
+	}
+
+	ctx.JSON(http.StatusOK, &notification)
+}

api/user.go

@@ -0,0 +1,48 @@
+package api
+
+import (
+	"errors"
+	"net/http"
+
+	"github.com/eikendev/pushbits/model"
+
+	"github.com/gin-gonic/gin"
+)
+
+// The UserDatabase interface for encapsulating database access.
+type UserDatabase interface {
+	CreateUser(user *model.User) error
+	GetUserByName(name string) (*model.User, error)
+}
+
+// UserHandler holds information for processing requests about users.
+type UserHandler struct {
+	DB UserDatabase
+}
+
+func (h *UserHandler) userExists(name string) bool {
+	user, _ := h.DB.GetUserByName(name)
+	return user != nil
+}
+
+// CreateUser creates a new user.
+func (h *UserHandler) CreateUser(ctx *gin.Context) {
+	externalUser := model.ExternalUserWithCredentials{}
+
+	if success := successOrAbort(ctx, http.StatusBadRequest, ctx.Bind(&externalUser)); !success {
+		return
+	}
+
+	user := externalUser.IntoInternalUser()
+
+	if h.userExists(user.Name) {
+		ctx.AbortWithError(http.StatusBadRequest, errors.New("username already exists"))
+		return
+	}
+
+	if success := successOrAbort(ctx, http.StatusInternalServerError, h.DB.CreateUser(user)); !success {
+		return
+	}
+
+	ctx.JSON(http.StatusOK, user.IntoExternalUser())
+}

api/util.go

@@ -0,0 +1,13 @@
+package api
+
+import (
+	"github.com/gin-gonic/gin"
+)
+
+func successOrAbort(ctx *gin.Context, code int, err error) bool {
+	if err != nil {
+		ctx.AbortWithError(code, err)
+	}
+
+	return err == nil
+}

app.go

@@ -0,0 +1,53 @@
+package main
+
+import (
+	"log"
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/eikendev/pushbits/configuration"
+	"github.com/eikendev/pushbits/database"
+	"github.com/eikendev/pushbits/dispatcher"
+	"github.com/eikendev/pushbits/router"
+	"github.com/eikendev/pushbits/runner"
+)
+
+func setupCleanup(db *database.Database, dp *dispatcher.Dispatcher) {
+	c := make(chan os.Signal)
+	signal.Notify(c, os.Interrupt, syscall.SIGTERM)
+
+	go func() {
+		<-c
+		dp.Close()
+		db.Close()
+		os.Exit(1)
+	}()
+}
+
+func main() {
+	log.Println("Starting PushBits.")
+
+	c := configuration.Get()
+
+	db, err := database.Create(c.Database.Dialect, c.Database.Connection)
+	if err != nil {
+		panic(err)
+	}
+	defer db.Close()
+
+	if err := db.Populate(c.Admin.Name, c.Admin.Password, c.Admin.MatrixID); err != nil {
+		panic(err)
+	}
+
+	dp, err := dispatcher.Create(db, c.Matrix.Homeserver, c.Matrix.Username, c.Matrix.Password)
+	if err != nil {
+		panic(err)
+	}
+	defer dp.Close()
+
+	setupCleanup(db, dp)
+
+	engine := router.Create(db, dp)
+	runner.Run(engine)
+}