gluetun/internal/shadowsocks/loop.go

// Package shadowsocks defines interfaces to configure and run a Shadowsocks server.
package shadowsocks

import (
	"context"
	"fmt"
	"sync"
	"time"

	"github.com/qdm12/gluetun/internal/configuration"
	"github.com/qdm12/gluetun/internal/constants"
	"github.com/qdm12/gluetun/internal/models"
	"github.com/qdm12/golibs/logging"
	shadowsockslib "github.com/qdm12/ss-server/pkg"
)

type Looper interface {
	Run(ctx context.Context, wg *sync.WaitGroup)
	SetStatus(status models.LoopStatus) (outcome string, err error)
	GetStatus() (status models.LoopStatus)
	GetSettings() (settings configuration.ShadowSocks)
	SetSettings(settings configuration.ShadowSocks) (outcome string)
}

type looper struct {
	state state
	// Other objects
	logger logging.Logger
	// Internal channels and locks
	loopLock      sync.Mutex
	running       chan models.LoopStatus
	stop, stopped chan struct{}
	start         chan struct{}
	backoffTime   time.Duration
}

func (l *looper) logAndWait(ctx context.Context, err error) {
	if err != nil {
		l.logger.Error(err)
	}
	l.logger.Info("retrying in %s", l.backoffTime)
	timer := time.NewTimer(l.backoffTime)
	l.backoffTime *= 2
	select {
	case <-timer.C:
	case <-ctx.Done():
		if !timer.Stop() {
			<-timer.C
		}
	}
}

const defaultBackoffTime = 10 * time.Second

func NewLooper(settings configuration.ShadowSocks, logger logging.Logger) Looper {
	return &looper{
		state: state{
			status:   constants.Stopped,
			settings: settings,
		},
		logger:      logger.WithPrefix("shadowsocks: "),
		start:       make(chan struct{}),
		running:     make(chan models.LoopStatus),
		stop:        make(chan struct{}),
		stopped:     make(chan struct{}),
		backoffTime: defaultBackoffTime,
	}
}

func (l *looper) Run(ctx context.Context, wg *sync.WaitGroup) {
	defer wg.Done()

	crashed := false

	if l.GetSettings().Enabled {
		go func() {
			_, _ = l.SetStatus(constants.Running)
		}()
	}

	select {
	case <-l.start:
	case <-ctx.Done():
		return
	}

	defer l.logger.Warn("loop exited")

	for ctx.Err() == nil {
		settings := l.GetSettings()
		server, err := shadowsockslib.NewServer(settings.Method, settings.Password, adaptLogger(l.logger, settings.Log))
		if err != nil {
			crashed = true
			l.logAndWait(ctx, err)
			continue
		}

		shadowsocksCtx, shadowsocksCancel := context.WithCancel(ctx)

		waitError := make(chan error)
		go func() {
			waitError <- server.Listen(shadowsocksCtx, fmt.Sprintf("0.0.0.0:%d", settings.Port))
		}()
		if err != nil {
			crashed = true
			shadowsocksCancel()
			l.logAndWait(ctx, err)
			continue
		}

		isStableTimer := time.NewTimer(time.Second)

		stayHere := true
		for stayHere {
			select {
			case <-ctx.Done():
				l.logger.Warn("context canceled: exiting loop")
				shadowsocksCancel()
				<-waitError
				close(waitError)
				return
			case <-isStableTimer.C:
				if !crashed {
					l.running <- constants.Running
					crashed = false
				} else {
					l.backoffTime = defaultBackoffTime
					l.state.setStatusWithLock(constants.Running)
				}
			case <-l.start:
				l.logger.Info("starting")
				shadowsocksCancel()
				<-waitError
				close(waitError)
				stayHere = false
			case <-l.stop:
				l.logger.Info("stopping")
				shadowsocksCancel()
				<-waitError
				close(waitError)
				l.stopped <- struct{}{}
			case err := <-waitError: // unexpected error
				shadowsocksCancel()
				close(waitError)
				l.state.setStatusWithLock(constants.Crashed)
				l.logAndWait(ctx, err)
				crashed = true
				stayHere = false
			}
		}
		shadowsocksCancel() // repetition for linter only
		if !isStableTimer.Stop() {
			<-isStableTimer.C
		}
	}
}