callback support for events

Author: Swapnil

README.md

@@ -1,4 +1,4 @@
-# service [![GoDoc](https://godoc.org/github.com/kardianos/service?status.svg)](https://godoc.org/github.com/kardianos/service)
+# service [![GoDoc](https://godoc.org/github.com/fourcorelabs/service?status.svg)](https://godoc.org/github.com/fourcorelabs/service)
 
 service will install / un-install, start / stop, and run a program as a service (daemon).
 Currently supports Windows XP+, Linux/(systemd | Upstart | SysV), and OSX/Launchd.
@@ -9,6 +9,9 @@ despite the substantial differences.
 It also can be used to detect how a program is called, from an interactive
 terminal or from a service manager.
 
+Added Support for windows callbacks on events. This can help you receive session change and other notifications
+Look at examples/winextracallback for how to do this
+
 ## BUGS
  * Dependencies field is not implemented for Linux systems and Launchd.
  * OS X when running as a UserService Interactive will not be accurate.

example/logging/main.go

@@ -10,13 +10,14 @@ import (
 	"log"
 	"time"
 
-	"github.com/kardianos/service"
+	"github.com/fourcorelabs/service"
 )
 
 var logger service.Logger
 
 // Program structures.
-//  Define Start and Stop methods.
+//
+//	Define Start and Stop methods.
 type program struct {
 	exit chan struct{}
 }
@@ -54,11 +55,12 @@ func (p *program) Stop(s service.Service) error {
 }
 
 // Service setup.
-//   Define service config.
-//   Create the service.
-//   Setup the logger.
-//   Handle service controls (optional).
-//   Run the service.
+//
+//	Define service config.
+//	Create the service.
+//	Setup the logger.
+//	Handle service controls (optional).
+//	Run the service.
 func main() {
 	svcFlag := flag.String("service", "", "Control the system service.")
 	flag.Parse()

example/runner/runner.go

@@ -14,7 +14,7 @@ import (
 	"os/exec"
 	"path/filepath"
 
-	"github.com/kardianos/service"
+	"github.com/fourcorelabs/service"
 )
 
 // Config is the runner app config structure.

example/simple/main.go

@@ -8,7 +8,7 @@ package main
 import (
 	"log"
 
-	"github.com/kardianos/service"
+	"github.com/fourcorelabs/service"
 )
 
 var logger service.Logger

example/stopPause/main.go

@@ -10,7 +10,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/kardianos/service"
+	"github.com/fourcorelabs/service"
 )
 
 var logger service.Logger

example/winextracallback/main.go

@@ -0,0 +1,121 @@
+// Copyright 2015 Daniel Theophanes.
+// Use of this source code is governed by a zlib-style
+// license that can be found in the LICENSE file.
+
+// simple does nothing except block while running the service.
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"strings"
+	"time"
+
+	"github.com/fourcorelabs/service"
+	"golang.org/x/sys/windows/svc"
+)
+
+var notifyMap = map[svc.Cmd]string{
+	svc.Stop:                  "SERVICE_CONTROL_STOP",
+	svc.Pause:                 "SERVICE_CONTROL_PAUSE",
+	svc.Continue:              "SERVICE_CONTROL_CONTINUE",
+	svc.Interrogate:           "SERVICE_CONTROL_INTERROGATE",
+	svc.Shutdown:              "SERVICE_CONTROL_SHUTDOWN",
+	svc.ParamChange:           "SERVICE_CONTROL_PARAMCHANGE",
+	svc.NetBindAdd:            "SERVICE_CONTROL_NETBINDADD",
+	svc.NetBindRemove:         "SERVICE_CONTROL_NETBINDREMOVE",
+	svc.NetBindEnable:         "SERVICE_CONTROL_NETBINDENABLE",
+	svc.NetBindDisable:        "SERVICE_CONTROL_NETBINDDISABLE",
+	svc.DeviceEvent:           "SERVICE_CONTROL_DEVICEEVENT",
+	svc.HardwareProfileChange: "SERVICE_CONTROL_HARDWAREPROFILECHANGE",
+	svc.PowerEvent:            "SERVICE_CONTROL_POWEREVENT",
+	svc.SessionChange:         "SERVICE_CONTROL_SESSIONCHANGE",
+	svc.PreShutdown:           "SERVICE_CONTROL_PRESHUTDOWN",
+}
+
+var logger service.Logger
+
+type program struct{}
+
+func (p *program) handleService(svc service.Service, action string) error {
+
+	switch action {
+	case "status":
+		status, err := svc.Status()
+		if err != nil {
+			return fmt.Errorf("cannot get status, error: %v", err)
+		}
+		switch status {
+		case service.StatusRunning:
+			fmt.Println("Status Running")
+		case service.StatusStopped:
+			fmt.Println("Status Stopped")
+		default:
+			fmt.Println("Status Unknown")
+		}
+		return nil
+	default:
+		return service.Control(svc, action)
+	}
+}
+
+func (p *program) Start(s service.Service) error {
+	logger.Infof("Program started on %v platform", service.Platform())
+	go Main()
+	return nil
+}
+
+func (p *program) Stop(s service.Service) error {
+	// Stop should not block. Return with a few seconds.
+	return nil
+}
+
+func (p *program) Callback(e svc.ChangeRequest) {
+	if logger == nil {
+		return
+	}
+
+	if v, ok := notifyMap[e.Cmd]; ok {
+		logger.Infof("Received Event: %v", v)
+	} else {
+		logger.Infof("Received Unknown Event: %v", e.Cmd)
+	}
+}
+
+func main() {
+	prg := &program{}
+
+	svcConfig := &service.Config{
+		Name:        "GoServiceExampleSimple",
+		DisplayName: "Go Service Example",
+		Description: "This is an example Go service.",
+		Option:      service.KeyValue{"ExtraCommandsAccepted": svc.AcceptSessionChange, "AcceptedCommandsCallback": prg.Callback},
+	}
+
+	s, err := service.New(prg, svcConfig)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	logger, err = s.Logger(nil)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	if len(os.Args) <= 1 {
+		if err := s.Run(); err != nil {
+			logger.Error(err)
+		}
+	} else {
+		if err := prg.handleService(s, strings.ToLower(os.Args[1])); err != nil {
+			logger.Error(err)
+		}
+	}
+}
+
+func Main() {
+	for range time.NewTicker(30 * time.Second).C {
+		logger.Info("Weirdo Service still running")
+	}
+}

go.mod

@@ -1,4 +1,4 @@
-module github.com/kardianos/service
+module github.com/fourcorelabs/service
 
 go 1.12
 

service_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/kardianos/service"
+	"github.com/fourcorelabs/service"
 )
 
 func TestRunInterrupt(t *testing.T) {

service_windows.go

@@ -182,15 +182,31 @@ func (ws *windowsService) Execute(args []string, r <-chan svc.ChangeRequest, cha
 	const cmdsAccepted = svc.AcceptStop | svc.AcceptShutdown
 	changes <- svc.Status{State: svc.StartPending}
 
+	cmdsAcceptedUpdate := cmdsAccepted
+	if ev, ok := ws.Option["ExtraCommandsAccepted"]; ok {
+		if conv, ok := ev.(svc.Accepted); ok {
+			cmdsAcceptedUpdate |= conv
+		}
+	}
+
+	var eventCallback func(svc.ChangeRequest)
+	if f, ok := ws.Option["AcceptedCommandsCallback"]; ok {
+		if conv, ok := f.(func(svc.ChangeRequest)); ok {
+			eventCallback = conv
+		}
+	}
+
 	if err := ws.i.Start(ws); err != nil {
 		ws.setError(err)
 		return true, 1
 	}
-
-	changes <- svc.Status{State: svc.Running, Accepts: cmdsAccepted}
+	changes <- svc.Status{State: svc.Running, Accepts: cmdsAcceptedUpdate}
 loop:
 	for {
 		c := <-r
+		if eventCallback != nil {
+			go eventCallback(c)
+		}
 		switch c.Cmd {
 		case svc.Interrogate:
 			changes <- c.CurrentStatus