listener.go

package marionette

import (
	"context"
	"errors"
	"net"
	"strconv"
	"sync"

	"github.com/redjack/marionette/mar"
	"go.uber.org/zap"
)

// Listener listens on a port and communicates over the marionette protocol.
type Listener struct {
	mu         sync.RWMutex
	ln         net.Listener
	doc        *mar.Document
	newStreams chan *Stream
	err        error

	once    sync.Once
	wg      sync.WaitGroup
	closing chan struct{}
}

// Listen returns a new instance of Listener.
func Listen(doc *mar.Document, iface string) (*Listener, error) {
	// Parse port from MAR specification.
	// TODO: Handle "ftp_pasv_port".
	port, err := strconv.Atoi(doc.Port)
	if err != nil {
		return nil, errors.New("invalid connection port")
	}
	addr := net.JoinHostPort(iface, strconv.Itoa(port))

	Logger.Debug("opening listener", zap.String("transport", doc.Transport), zap.String("bind", addr))

	ln, err := net.Listen(doc.Transport, addr)
	if err != nil {
		return nil, err
	}
	l := &Listener{
		ln:         ln,
		doc:        doc,
		newStreams: make(chan *Stream),
		closing:    make(chan struct{}),
	}

	// Hand off connection handling to separate goroutine.
	l.wg.Add(1)
	go func() { defer l.wg.Done(); l.accept() }()

	return l, nil
}

// Err returns the last error that occurred on the listener.
func (l *Listener) Err() error {
	l.mu.RLock()
	defer l.mu.RUnlock()
	return l.err
}

// Addr returns the underlying network address.
func (l *Listener) Addr() net.Addr { return l.ln.Addr() }

// Close stops the listener and waits for the connections to finish.
func (l *Listener) Close() error {
	err := l.ln.Close()

	l.once.Do(func() { close(l.closing) })
	l.wg.Wait()
	return err
}

// Accept waits for a new connection.
func (l *Listener) Accept() (net.Conn, error) {
	stream := <-l.newStreams
	return stream, l.Err()
}

// accept continually accepts networks connections and multiplexes to streams.
func (l *Listener) accept() {
	defer close(l.newStreams)

	for {
		// Wait for next connection.
		conn, err := l.ln.Accept()
		if err != nil {
			l.mu.Lock()
			l.err = err
			l.mu.Unlock()
			return
		}

		fsm := NewFSM(l.doc, PartyServer)
		fsm.conn = conn
		fsm.streams.LocalAddr = conn.LocalAddr()
		fsm.streams.RemoteAddr = conn.RemoteAddr()
		fsm.streams.OnNewStream = l.onNewStream

		// Run execution in a separate goroutine.
		l.wg.Add(1)
		go func() { defer l.wg.Done(); l.execute(context.Background(), fsm) }()
	}
}

func (l *Listener) execute(ctx context.Context, fsm *FSM) {
	Logger.Debug("server fsm executing")
	defer Logger.Debug("server fsm execution complete")

	if err := fsm.Execute(ctx); err != nil {
		Logger.Debug("server fsm execution error", zap.Error(err))
	}
}

// onNewStream is called everytime the FSM's stream set creates a new stream.
func (l *Listener) onNewStream(stream *Stream) {
	Logger.Debug("new server stream")
	l.newStreams <- stream
}