rename folder extensions -> services

Signed-off-by: Christian Richter <crichter@owncloud.com>

services/notifications/Makefile

@@ -0,0 +1,37 @@
+SHELL := bash
+NAME := notifications
+
+include ../../.make/recursion.mk
+
+############ tooling ############
+ifneq (, $(shell command -v go 2> /dev/null)) # suppress `command not found warnings` for non go targets in CI
+include ../../.bingo/Variables.mk
+endif
+
+############ go tooling ############
+include ../../.make/go.mk
+
+############ release ############
+include ../../.make/release.mk
+
+############ docs generate ############
+include ../../.make/docs.mk
+
+.PHONY: docs-generate
+docs-generate: config-docs-generate
+
+############ generate ############
+include ../../.make/generate.mk
+
+.PHONY: ci-go-generate
+ci-go-generate: # CI runs ci-node-generate automatically before this target
+
+.PHONY: ci-node-generate
+ci-node-generate:
+
+############ licenses ############
+.PHONY: ci-node-check-licenses
+ci-node-check-licenses:
+
+.PHONY: ci-node-save-licenses
+ci-node-save-licenses:

services/notifications/cmd/notifications/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"os"
+
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/command"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config/defaults"
+)
+
+func main() {
+	if err := command.Execute(defaults.DefaultConfig()); err != nil {
+		os.Exit(1)
+	}
+}

services/notifications/pkg/channels/channels.go

@@ -0,0 +1,105 @@
+// Package channels provides different communication channels to notify users.
+package channels
+
+import (
+	"context"
+	"net/smtp"
+
+	gateway "github.com/cs3org/go-cs3apis/cs3/gateway/v1beta1"
+	groups "github.com/cs3org/go-cs3apis/cs3/identity/group/v1beta1"
+	rpc "github.com/cs3org/go-cs3apis/cs3/rpc/v1beta1"
+	"github.com/cs3org/reva/v2/pkg/rgrpc/todo/pool"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+	"github.com/owncloud/ocis/v2/ocis-pkg/log"
+	"github.com/pkg/errors"
+)
+
+// Channel defines the methods of a communication channel.
+type Channel interface {
+	// SendMessage sends a message to users.
+	SendMessage(userIDs []string, msg string) error
+	// SendMessageToGroup sends a message to a group.
+	SendMessageToGroup(groupdID *groups.GroupId, msg string) error
+}
+
+// NewMailChannel instantiates a new mail communication channel.
+func NewMailChannel(cfg config.Config, logger log.Logger) (Channel, error) {
+	gc, err := pool.GetGatewayServiceClient(cfg.Notifications.RevaGateway)
+	if err != nil {
+		logger.Error().Err(err).Msg("could not get gateway client")
+		return nil, err
+	}
+	return Mail{
+		gatewayClient: gc,
+		conf:          cfg,
+		logger:        logger,
+	}, nil
+}
+
+// Mail is the communcation channel for email.
+type Mail struct {
+	gatewayClient gateway.GatewayAPIClient
+	conf          config.Config
+	logger        log.Logger
+}
+
+// SendMessage sends a message to all given users.
+func (m Mail) SendMessage(userIDs []string, msg string) error {
+	to, err := m.getReceiverAddresses(userIDs)
+	if err != nil {
+		return err
+	}
+	body := []byte(msg)
+
+	smtpConf := m.conf.Notifications.SMTP
+	auth := smtp.PlainAuth("", smtpConf.Sender, smtpConf.Password, smtpConf.Host)
+	if err := smtp.SendMail(smtpConf.Host+":"+smtpConf.Port, auth, smtpConf.Sender, to, body); err != nil {
+		return errors.Wrap(err, "could not send mail")
+	}
+	return nil
+}
+
+// SendMessageToGroup sends a message to all members of the given group.
+func (m Mail) SendMessageToGroup(groupID *groups.GroupId, msg string) error {
+	// TODO We need an authenticated context here...
+	res, err := m.gatewayClient.GetGroup(context.Background(), &groups.GetGroupRequest{GroupId: groupID})
+	if err != nil {
+		return err
+	}
+	if res.Status.Code != rpc.Code_CODE_OK {
+		return errors.New("could not get group")
+	}
+
+	members := make([]string, 0, len(res.Group.Members))
+	for _, id := range res.Group.Members {
+		members = append(members, id.OpaqueId)
+	}
+
+	return m.SendMessage(members, msg)
+}
+
+func (m Mail) getReceiverAddresses(receivers []string) ([]string, error) {
+	addresses := make([]string, 0, len(receivers))
+	for _, id := range receivers {
+		// Authenticate is too costly but at the moment our only option to get the user.
+		// We don't have an authenticated context so calling `GetUser` doesn't work.
+		res, err := m.gatewayClient.Authenticate(context.Background(), &gateway.AuthenticateRequest{
+			Type:         "machine",
+			ClientId:     "userid:" + id,
+			ClientSecret: m.conf.Notifications.MachineAuthAPIKey,
+		})
+		if err != nil {
+			return nil, err
+		}
+		if res.Status.Code != rpc.Code_CODE_OK {
+			m.logger.Error().
+				Interface("status", res.Status).
+				Str("receiver_id", id).
+				Msg("could not get user")
+			continue
+		}
+		addresses = append(addresses, res.User.Mail)
+	}
+
+	return addresses, nil
+}

services/notifications/pkg/command/health.go

@@ -0,0 +1,18 @@
+package command
+
+import (
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+	"github.com/urfave/cli/v2"
+)
+
+// Health is the entrypoint for the health command.
+func Health(cfg *config.Config) *cli.Command {
+	return &cli.Command{
+		Name:  "health",
+		Usage: "Check health status",
+		Action: func(c *cli.Context) error {
+			// Not implemented
+			return nil
+		},
+	}
+}

services/notifications/pkg/command/root.go

@@ -0,0 +1,64 @@
+package command
+
+import (
+	"context"
+	"os"
+
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+	"github.com/owncloud/ocis/v2/ocis-pkg/clihelper"
+	ociscfg "github.com/owncloud/ocis/v2/ocis-pkg/config"
+	"github.com/thejerf/suture/v4"
+	"github.com/urfave/cli/v2"
+)
+
+// GetCommands provides all commands for this service
+func GetCommands(cfg *config.Config) cli.Commands {
+	return []*cli.Command{
+		// start this service
+		Server(cfg),
+
+		// interaction with this service
+
+		// infos about this service
+		Health(cfg),
+		Version(cfg),
+	}
+}
+
+// Execute is the entry point for the notifications command.
+func Execute(cfg *config.Config) error {
+	app := clihelper.DefaultApp(&cli.App{
+		Name:     "notifications",
+		Usage:    "starts notifications service",
+		Commands: GetCommands(cfg),
+	})
+
+	cli.HelpFlag = &cli.BoolFlag{
+		Name:  "help,h",
+		Usage: "Show the help",
+	}
+
+	return app.Run(os.Args)
+}
+
+// SutureService allows for the notifications command to be embedded and supervised by a suture supervisor tree.
+type SutureService struct {
+	cfg *config.Config
+}
+
+// NewSutureService creates a new notifications.SutureService
+func NewSutureService(cfg *ociscfg.Config) suture.Service {
+	cfg.Notifications.Commons = cfg.Commons
+	return SutureService{
+		cfg: cfg.Notifications,
+	}
+}
+
+func (s SutureService) Serve(ctx context.Context) error {
+	s.cfg.Context = ctx
+	if err := Execute(s.cfg); err != nil {
+		return err
+	}
+
+	return nil
+}

services/notifications/pkg/command/server.go

@@ -0,0 +1,59 @@
+package command
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/cs3org/reva/v2/pkg/events"
+	"github.com/cs3org/reva/v2/pkg/events/server"
+	"github.com/go-micro/plugins/v4/events/natsjs"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/channels"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config/parser"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/logging"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/service"
+	"github.com/urfave/cli/v2"
+)
+
+// Server is the entrypoint for the server command.
+func Server(cfg *config.Config) *cli.Command {
+	return &cli.Command{
+		Name:     "server",
+		Usage:    fmt.Sprintf("start %s extension without runtime (unsupervised mode)", cfg.Service.Name),
+		Category: "server",
+		Before: func(c *cli.Context) error {
+			err := parser.ParseConfig(cfg)
+			if err != nil {
+				fmt.Printf("%v", err)
+				os.Exit(1)
+			}
+			return err
+		},
+		Action: func(c *cli.Context) error {
+			logger := logging.Configure(cfg.Service.Name, cfg.Log)
+
+			evs := []events.Unmarshaller{
+				events.ShareCreated{},
+			}
+
+			evtsCfg := cfg.Notifications.Events
+			client, err := server.NewNatsStream(
+				natsjs.Address(evtsCfg.Endpoint),
+				natsjs.ClusterID(evtsCfg.Cluster),
+			)
+			if err != nil {
+				return err
+			}
+			evts, err := events.Consume(client, evtsCfg.ConsumerGroup, evs...)
+			if err != nil {
+				return err
+			}
+			channel, err := channels.NewMailChannel(*cfg, logger)
+			if err != nil {
+				return err
+			}
+			svc := service.NewEventsNotifier(evts, channel, logger)
+			return svc.Run()
+		},
+	}
+}

services/notifications/pkg/command/version.go

@@ -0,0 +1,19 @@
+package command
+
+import (
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+	"github.com/urfave/cli/v2"
+)
+
+// Version prints the service versions of all running instances.
+func Version(cfg *config.Config) *cli.Command {
+	return &cli.Command{
+		Name:     "version",
+		Usage:    "print the version of this binary and the running extension instances",
+		Category: "info",
+		Action: func(c *cli.Context) error {
+			// not implemented
+			return nil
+		},
+	}
+}

services/notifications/pkg/config/config.go

@@ -0,0 +1,44 @@
+package config
+
+import (
+	"context"
+
+	"github.com/owncloud/ocis/v2/ocis-pkg/shared"
+)
+
+// Config combines all available configuration parts.
+type Config struct {
+	Commons *shared.Commons `yaml:"-"` // don't use this directly as configuration for a service
+
+	Service Service `yaml:"-"`
+
+	Log   *Log  `yaml:"log"`
+	Debug Debug `yaml:"debug"`
+
+	Notifications Notifications `yaml:"notifications"`
+
+	Context context.Context `yaml:"-"`
+}
+
+// Notifications definces the config options for the notifications service.
+type Notifications struct {
+	SMTP              SMTP   `yaml:"SMTP"`
+	Events            Events `yaml:"events"`
+	RevaGateway       string `yaml:"reva_gateway" env:"REVA_GATEWAY;NOTIFICATIONS_REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata"`
+	MachineAuthAPIKey string `yaml:"machine_auth_api_key" env:"OCIS_MACHINE_AUTH_API_KEY;NOTIFICATIONS_MACHINE_AUTH_API_KEY" desc:"Machine auth API key used for accessing the 'auth-machine' service to look up their email."`
+}
+
+// SMTP combines the smtp configuration options.
+type SMTP struct {
+	Host     string `yaml:"smtp_host" env:"NOTIFICATIONS_SMTP_HOST" desc:"SMTP host, to connect to."`
+	Port     string `yaml:"smtp_port" env:"NOTIFICATIONS_SMTP_PORT" desc:"Port of the SMTP host, to connect to."`
+	Sender   string `yaml:"smtp_sender" env:"NOTIFICATIONS_SMTP_SENDER" desc:"Sender of emails, that will be sent."`
+	Password string `yaml:"smtp_password" env:"NOTIFICATIONS_SMTP_PASSWORD" desc:"Password of the SMTP host, to connect to."`
+}
+
+// Events combines the configuration options for the event bus.
+type Events struct {
+	Endpoint      string `yaml:"endpoint" env:"NOTIFICATIONS_EVENTS_ENDPOINT" desc:"Endpoint of the event system."`
+	Cluster       string `yaml:"cluster" env:"NOTIFICATIONS_EVENTS_CLUSTER" desc:"Cluster ID of the event system."`
+	ConsumerGroup string `yaml:"group" env:"NOTIFICATIONS_EVENTS_GROUP" desc:"Name of the event group / queue on the event system."`
+}

services/notifications/pkg/config/debug.go

@@ -0,0 +1,9 @@
+package config
+
+// Debug defines the available debug configuration.
+type Debug struct {
+	Addr   string `yaml:"addr" env:"NOTIFICATIONS_DEBUG_ADDR" desc:"Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed."`
+	Token  string `yaml:"token" env:"NOTIFICATIONS_DEBUG_TOKEN" desc:"Token to secure the metrics endpoint"`
+	Pprof  bool   `yaml:"pprof" env:"NOTIFICATIONS_DEBUG_PPROF" desc:"Enables pprof, which can be used for profiling"`
+	Zpages bool   `yaml:"zpages" env:"NOTIFICATIONS_DEBUG_ZPAGES" desc:"Enables zpages, which can be used for collecting and viewing in-memory traces."`
+}

services/notifications/pkg/config/defaults/defaultconfig.go

@@ -0,0 +1,61 @@
+package defaults
+
+import (
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+)
+
+func FullDefaultConfig() *config.Config {
+	cfg := DefaultConfig()
+	EnsureDefaults(cfg)
+	Sanitize(cfg)
+	return cfg
+}
+
+// NOTE: Most of this configuration is not needed to keep it as simple as possible
+// TODO: Clean up unneeded configuration
+
+func DefaultConfig() *config.Config {
+	return &config.Config{
+		Debug: config.Debug{
+			Addr: "127.0.0.1:9174",
+		},
+		Service: config.Service{
+			Name: "notifications",
+		},
+		Notifications: config.Notifications{
+			SMTP: config.SMTP{
+				Host:   "127.0.0.1",
+				Port:   "1025",
+				Sender: "noreply@example.com",
+			},
+			Events: config.Events{
+				Endpoint:      "127.0.0.1:9233",
+				Cluster:       "ocis-cluster",
+				ConsumerGroup: "notifications",
+			},
+			RevaGateway: "127.0.0.1:9142",
+		},
+	}
+}
+
+func EnsureDefaults(cfg *config.Config) {
+	// provide with defaults for shared logging, since we need a valid destination address for BindEnv.
+	if cfg.Log == nil && cfg.Commons != nil && cfg.Commons.Log != nil {
+		cfg.Log = &config.Log{
+			Level:  cfg.Commons.Log.Level,
+			Pretty: cfg.Commons.Log.Pretty,
+			Color:  cfg.Commons.Log.Color,
+			File:   cfg.Commons.Log.File,
+		}
+	} else if cfg.Log == nil {
+		cfg.Log = &config.Log{}
+	}
+
+	if cfg.Notifications.MachineAuthAPIKey == "" && cfg.Commons != nil && cfg.Commons.MachineAuthAPIKey != "" {
+		cfg.Notifications.MachineAuthAPIKey = cfg.Commons.MachineAuthAPIKey
+	}
+}
+
+func Sanitize(cfg *config.Config) {
+	// nothing to sanitize here atm
+}

services/notifications/pkg/config/log.go

@@ -0,0 +1,9 @@
+package config
+
+// Log defines the available log configuration.
+type Log struct {
+	Level  string `mapstructure:"level" env:"OCIS_LOG_LEVEL;NOTIFICATIONS_LOG_LEVEL" desc:"The log level. Valid values are: \"panic\", \"fatal\", \"error\", \"warn\", \"info\", \"debug\", \"trace\"."`
+	Pretty bool   `mapstructure:"pretty" env:"OCIS_LOG_PRETTY;NOTIFICATIONS_LOG_PRETTY" desc:"Activates pretty log output."`
+	Color  bool   `mapstructure:"color" env:"OCIS_LOG_COLOR;NOTIFICATIONS_LOG_COLOR" desc:"Activates colorized log output."`
+	File   string `mapstructure:"file" env:"OCIS_LOG_FILE;NOTIFICATIONS_LOG_FILE" desc:"The path to the log file. Activates logging to this file if set."`
+}

services/notifications/pkg/config/parser/parse.go

@@ -0,0 +1,42 @@
+package parser
+
+import (
+	"errors"
+
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config/defaults"
+	ociscfg "github.com/owncloud/ocis/v2/ocis-pkg/config"
+	"github.com/owncloud/ocis/v2/ocis-pkg/shared"
+
+	"github.com/owncloud/ocis/v2/ocis-pkg/config/envdecode"
+)
+
+// ParseConfig loads configuration from known paths.
+func ParseConfig(cfg *config.Config) error {
+	_, err := ociscfg.BindSourcesToStructs(cfg.Service.Name, cfg)
+	if err != nil {
+		return err
+	}
+
+	defaults.EnsureDefaults(cfg)
+
+	// load all env variables relevant to the config in the current context.
+	if err := envdecode.Decode(cfg); err != nil {
+		// no environment variable set for this config is an expected "error"
+		if !errors.Is(err, envdecode.ErrNoTargetFieldsAreSet) {
+			return err
+		}
+	}
+
+	defaults.Sanitize(cfg)
+
+	return Validate(cfg)
+}
+
+func Validate(cfg *config.Config) error {
+	if cfg.Notifications.MachineAuthAPIKey == "" {
+		return shared.MissingMachineAuthApiKeyError(cfg.Service.Name)
+	}
+
+	return nil
+}

services/notifications/pkg/config/service.go

@@ -0,0 +1,6 @@
+package config
+
+// Service defines the available service configuration.
+type Service struct {
+	Name string `yaml:"-"`
+}

services/notifications/pkg/logging/logging.go

@@ -0,0 +1,17 @@
+package logging
+
+import (
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/config"
+	"github.com/owncloud/ocis/v2/ocis-pkg/log"
+)
+
+// LoggerFromConfig initializes a service-specific logger instance.
+func Configure(name string, cfg *config.Log) log.Logger {
+	return log.NewLogger(
+		log.Name(name),
+		log.Level(cfg.Level),
+		log.Pretty(cfg.Pretty),
+		log.Color(cfg.Color),
+		log.File(cfg.File),
+	)
+}

services/notifications/pkg/service/service.go

@@ -0,0 +1,64 @@
+package service
+
+import (
+	"os"
+	"os/signal"
+	"syscall"
+
+	"github.com/cs3org/reva/v2/pkg/events"
+	"github.com/owncloud/ocis/v2/extensions/notifications/pkg/channels"
+	"github.com/owncloud/ocis/v2/ocis-pkg/log"
+)
+
+type Service interface {
+	Run() error
+}
+
+func NewEventsNotifier(events <-chan interface{}, channel channels.Channel, logger log.Logger) Service {
+	return eventsNotifier{
+		logger:  logger,
+		channel: channel,
+		events:  events,
+		signals: make(chan os.Signal, 1),
+	}
+}
+
+type eventsNotifier struct {
+	logger  log.Logger
+	channel channels.Channel
+	events  <-chan interface{}
+	signals chan os.Signal
+}
+
+func (s eventsNotifier) Run() error {
+	signal.Notify(s.signals, syscall.SIGINT, syscall.SIGTERM)
+	s.logger.Debug().
+		Msg("eventsNotifier started")
+	for {
+		select {
+		case evt := <-s.events:
+			go func() {
+				switch e := evt.(type) {
+				case events.ShareCreated:
+					msg := "You got a share!"
+					var err error
+					if e.GranteeUserID != nil {
+						err = s.channel.SendMessage([]string{e.GranteeUserID.OpaqueId}, msg)
+					} else if e.GranteeGroupID != nil {
+						err = s.channel.SendMessageToGroup(e.GranteeGroupID, msg)
+					}
+					if err != nil {
+						s.logger.Error().
+							Err(err).
+							Str("event", "ShareCreated").
+							Msg("failed to send a message")
+					}
+				}
+			}()
+		case <-s.signals:
+			s.logger.Debug().
+				Msg("eventsNotifier stopped")
+			return nil
+		}
+	}
+}