service_upstart_linux.go 5.61 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
// Copyright 2015 Daniel Theophanes.
// Use of this source code is governed by a zlib-style
// license that can be found in the LICENSE file.

package service

import (
	"errors"
	"fmt"
	"os"
	"os/signal"
Frank Denis's avatar
Frank Denis committed
12
	"regexp"
13
	"strings"
14
	"syscall"
15 16 17 18 19 20 21 22
	"text/template"
	"time"
)

func isUpstart() bool {
	if _, err := os.Stat("/sbin/upstart-udev-bridge"); err == nil {
		return true
	}
Frank Denis's avatar
Frank Denis committed
23 24 25 26 27 28 29
	if _, err := os.Stat("/sbin/initctl"); err == nil {
		if _, out, err := runWithOutput("/sbin/initctl", "--version"); err == nil {
			if strings.Contains(out, "initctl (upstart") {
				return true
			}
		}
	}
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
	return false
}

type upstart struct {
	i Interface
	*Config
}

func newUpstartService(i Interface, c *Config) (Service, error) {
	s := &upstart{
		i:      i,
		Config: c,
	}

	return s, nil
}

func (s *upstart) String() string {
	if len(s.DisplayName) > 0 {
		return s.DisplayName
	}
	return s.Name
}

// Upstart has some support for user services in graphical sessions.
// Due to the mix of actual support for user services over versions, just don't bother.
// Upstart will be replaced by systemd in most cases anyway.
var errNoUserServiceUpstart = errors.New("User services are not supported on Upstart.")

func (s *upstart) configPath() (cp string, err error) {
	if s.Option.bool(optionUserService, optionUserServiceDefault) {
		err = errNoUserServiceUpstart
		return
	}
	cp = "/etc/init/" + s.Config.Name + ".conf"
	return
}
Frank Denis's avatar
Frank Denis committed
67 68 69

func (s *upstart) hasKillStanza() bool {
	defaultValue := true
Frank Denis's avatar
Frank Denis committed
70 71
	version := s.getUpstartVersion()
	if version == nil {
Frank Denis's avatar
Frank Denis committed
72 73 74
		return defaultValue
	}

Frank Denis's avatar
Frank Denis committed
75 76 77
	maxVersion := []int{0, 6, 5}
	if matches, err := versionAtMost(version, maxVersion); err != nil || matches {
		return false
Frank Denis's avatar
Frank Denis committed
78 79
	}

Frank Denis's avatar
Frank Denis committed
80 81 82 83 84 85 86 87
	return defaultValue
}

func (s *upstart) hasSetUIDStanza() bool {
	defaultValue := true
	version := s.getUpstartVersion()
	if version == nil {
		return defaultValue
Frank Denis's avatar
Frank Denis committed
88 89
	}

Frank Denis's avatar
Frank Denis committed
90 91
	maxVersion := []int{1, 4, 0}
	if matches, err := versionAtMost(version, maxVersion); err != nil || matches {
Frank Denis's avatar
Frank Denis committed
92 93 94 95 96 97
		return false
	}

	return defaultValue
}

Frank Denis's avatar
Frank Denis committed
98 99 100 101
func (s *upstart) getUpstartVersion() []int {
	_, out, err := runWithOutput("/sbin/initctl", "--version")
	if err != nil {
		return nil
Frank Denis's avatar
Frank Denis committed
102
	}
Frank Denis's avatar
Frank Denis committed
103 104 105 106 107 108 109 110

	re := regexp.MustCompile(`initctl \(upstart (\d+.\d+.\d+)\)`)
	matches := re.FindStringSubmatch(out)
	if len(matches) != 2 {
		return nil
	}

	return parseVersion(matches[1])
Frank Denis's avatar
Frank Denis committed
111 112
}

113
func (s *upstart) template() *template.Template {
Frank Denis's avatar
Frank Denis committed
114 115 116 117 118 119 120
	customScript := s.Option.string(optionUpstartScript, "")

	if customScript != "" {
		return template.Must(template.New("").Funcs(tf).Parse(customScript))
	} else {
		return template.Must(template.New("").Funcs(tf).Parse(upstartScript))
	}
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
}

func (s *upstart) Install() error {
	confPath, err := s.configPath()
	if err != nil {
		return err
	}
	_, err = os.Stat(confPath)
	if err == nil {
		return fmt.Errorf("Init already exists: %s", confPath)
	}

	f, err := os.Create(confPath)
	if err != nil {
		return err
	}
	defer f.Close()

	path, err := s.execPath()
	if err != nil {
		return err
	}

	var to = &struct {
		*Config
Frank Denis's avatar
Frank Denis committed
146 147 148 149
		Path            string
		HasKillStanza   bool
		HasSetUIDStanza bool
		LogOutput       bool
150 151 152
	}{
		s.Config,
		path,
Frank Denis's avatar
Frank Denis committed
153
		s.hasKillStanza(),
Frank Denis's avatar
Frank Denis committed
154 155
		s.hasSetUIDStanza(),
		s.Option.bool(optionLogOutput, optionLogOutputDefault),
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
	}

	return s.template().Execute(f, to)
}

func (s *upstart) Uninstall() error {
	cp, err := s.configPath()
	if err != nil {
		return err
	}
	if err := os.Remove(cp); err != nil {
		return err
	}
	return nil
}

func (s *upstart) Logger(errs chan<- error) (Logger, error) {
	if system.Interactive() {
		return ConsoleLogger, nil
	}
	return s.SystemLogger(errs)
}
func (s *upstart) SystemLogger(errs chan<- error) (Logger, error) {
	return newSysLogger(s.Name, errs)
}

func (s *upstart) Run() (err error) {
	err = s.i.Start(s)
	if err != nil {
		return err
	}

	s.Option.funcSingle(optionRunWait, func() {
		var sigChan = make(chan os.Signal, 3)
190
		signal.Notify(sigChan, syscall.SIGTERM, os.Interrupt)
191 192 193 194 195 196
		<-sigChan
	})()

	return s.i.Stop(s)
}

Frank Denis's avatar
Frank Denis committed
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
func (s *upstart) Status() (Status, error) {
	exitCode, out, err := runWithOutput("initctl", "status", s.Name)
	if exitCode == 0 && err != nil {
		return StatusUnknown, err
	}

	switch {
	case strings.HasPrefix(out, fmt.Sprintf("%s start/running", s.Name)):
		return StatusRunning, nil
	case strings.HasPrefix(out, fmt.Sprintf("%s stop/waiting", s.Name)):
		return StatusStopped, nil
	default:
		return StatusUnknown, ErrNotInstalled
	}
}

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
func (s *upstart) Start() error {
	return run("initctl", "start", s.Name)
}

func (s *upstart) Stop() error {
	return run("initctl", "stop", s.Name)
}

func (s *upstart) Restart() error {
	err := s.Stop()
	if err != nil {
		return err
	}
	time.Sleep(50 * time.Millisecond)
	return s.Start()
}

// The upstart script should stop with an INT or the Go runtime will terminate
// the program before the Stop handler can run.
const upstartScript = `# {{.Description}}

{{if .DisplayName}}description    "{{.DisplayName}}"{{end}}

Frank Denis's avatar
Frank Denis committed
236
{{if .HasKillStanza}}kill signal INT{{end}}
237 238 239 240 241
{{if .ChRoot}}chroot {{.ChRoot}}{{end}}
{{if .WorkingDirectory}}chdir {{.WorkingDirectory}}{{end}}
start on filesystem or runlevel [2345]
stop on runlevel [!2345]

Frank Denis's avatar
Frank Denis committed
242
{{if and .UserName .HasSetUIDStanza}}setuid {{.UserName}}{{end}}
243 244 245 246 247 248 249 250 251 252 253 254

respawn
respawn limit 10 5
umask 022

console none

pre-start script
    test -x {{.Path}} || { stop; exit 0; }
end script

# Start
Frank Denis's avatar
Frank Denis committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268
script
	{{if .LogOutput}}
	stdout_log="/var/log/{{.Name}}.out"
	stderr_log="/var/log/{{.Name}}.err"
	{{end}}
	
	if [ -f "/etc/sysconfig/{{.Name}}" ]; then
		set -a
		source /etc/sysconfig/{{.Name}}
		set +a
	fi

	exec {{if and .UserName (not .HasSetUIDStanza)}}sudo -E -u {{.UserName}} {{end}}{{.Path}}{{range .Arguments}} {{.|cmd}}{{end}}{{if .LogOutput}} >> $stdout_log 2>> $stderr_log{{end}}
end script
269
`