nntp

type ArticleAcceptor interface {
	// check article given an article header
	CheckHeader(hdr message.Header) PolicyStatus
	// check article given a message id
	CheckMessageID(msgid MessageID) PolicyStatus
	// get max article size in bytes
	MaxArticleSize() int64
}

type ArticleEntry [2]string

type ArticleFilter interface {
	// filter the article header
	// returns the modified Header and an error if one occurs
	FilterHeader(hdr message.Header) (message.Header, error)

	// reads the article's body and write the filtered version to an io.Writer
	// returns the number of bytes written to the io.Writer, true if the body was
	// modifed (or false if body is unchanged) and an error if one occurs
	FilterAndWriteBody(body io.Reader, wr io.Writer) (int64, bool, error)
}

type Command string

type Conn interface {

	// negotiate an nntp session on this connection
	// returns nil if we negitated successfully
	// returns ErrAuthRejected if the remote server rejected any authentication
	// we sent or another error if one occured while negotiating
	Negotiate(stream bool) error

	// obtain connection state
	GetState() *ConnState

	// retutrn true if posting is allowed
	// return false if posting is not allowed
	PostingAllowed() bool

	// handle inbound non-streaming connection
	// call event hooks on event
	ProcessInbound(hooks EventHooks)

	// does this connection want to do nntp streaming?
	WantsStreaming() bool

	// what mode are we in?
	// returns mode in all caps
	Mode() Mode

	// initiate nntp streaming
	// after calling this the caller MUST call StreamAndQuit()
	// returns a channel for message ids, true if caller sends on the channel or
	// returns nil and ErrStreamingNotAllowed if streaming is not allowed on this
	// connection or another error if one occurs while trying to start streaming
	StartStreaming() (chan ArticleEntry, error)

	// stream articles and quit when the channel obtained by StartStreaming() is
	// closed, after which this nntp connection is no longer open
	StreamAndQuit()

	// is this nntp connection open?
	IsOpen() bool

	// send quit command and close connection
	Quit()

	// download all articles in a newsgroup
	// returns error if a network error occurs
	DownloadGroup(g Newsgroup) error

	// get list of active newsgroups
	ListNewsgroups() ([]Newsgroup, error)
}

type ConnState struct {
	// name of parent feed
	FeedName string `json:"feedname"`
	// name of the connection
	ConnName string `json:"connname"`
	// hostname of remote connection
	HostName string `json:"hostname"`
	// current nntp mode
	Mode Mode `json:"mode"`
	// current selected nntp newsgroup
	Group Newsgroup `json:"newsgroup"`
	// current selected nntp article
	Article string `json:"article"`
	// parent feed's policy
	Policy *FeedPolicy `json:"feedpolicy"`
	// is this connection open?
	Open bool `json:"open"`
}

type Dialer interface {
	// dial out with a dialer
	// if cfg is not nil, try to establish a tls connection with STARTTLS
	// returns a new nntp connection and nil on successful handshake and login
	// returns nil and an error if an error happened
	Dial(d network.Dialer, cfg *tls.Config) (*Conn, error)
}

type EventHooks interface {
	// called when we have obtained an article given its message-id
	GotArticle(msgid MessageID, group Newsgroup)
	// called when we have sent an article to a single remote feed
	SentArticleVia(msgid MessageID, feedname string)
}

type FeedPolicy struct {
	// list of whitelist regexps for newsgorups
	Whitelist []string `json:"whitelist"`
	// list of blacklist regexps for newsgroups
	Blacklist []string `json:"blacklist"`
	// are anon posts of any kind allowed?
	AllowAnonPosts bool `json:"anon"`
	// are anon posts with attachments allowed?
	AllowAnonAttachments bool `json:"anon_attachments"`
	// are any attachments allowed?
	AllowAttachments bool `json:"attachments"`
	// do we require Proof Of Work for untrusted connections?
	UntrustedRequiresPoW bool `json:"pow"`
}

type FlatfileAuth string

type Hook struct {
	// contains filtered or unexported fields
}

type MessageID string

type Mode string

type ModeCommand string

type MulitHook []EventHooks

type Newsgroup string

type PolicyStatus int

type Server struct {
	// user callback
	Hooks EventHooks
	// filters to apply
	Filters []ArticleFilter
	// global article acceptor
	Acceptor ArticleAcceptor
	// article storage
	Storage store.Storage
	// nntp config
	Config *config.NNTPServerConfig
	// outfeeds to connect to
	Feeds []*config.FeedConfig
	// inbound authentiaction mechanism
	Auth ServerAuth
	// contains filtered or unexported fields
}

type ServerAuth interface {
	// check plaintext login
	// returns nil on success otherwise error if one occurs during authentication
	// returns true if authentication was successful and an error if a network io error happens
	CheckLogin(username, passwd string) (bool, error)
}

type StreamEvent string