nntpserver

Documentation

Overview

Package nntpserver provides everything you need for your own NNTP server.

Index

• Constants
• Variables
• type Article
  • func (a *Article) MessageID() string
• type Backend
• type DiskBackend
  • func NewDiskBackend(cleanOnClose bool, dbPath string) *DiskBackend
  • func (b *DiskBackend) AllowPost() bool
  • func (b *DiskBackend) Authenticate(user, pass string) (Backend, error)
  • func (b *DiskBackend) Authorized() bool
  • func (b *DiskBackend) Close() error
  • func (b *DiskBackend) GetArticle(group *Group, id string) (*Article, error)
  • func (b *DiskBackend) GetArticles(group *Group, from, to int64) ([]NumberedArticle, error)
  • func (b *DiskBackend) GetGroup(name string) (*Group, error)
  • func (b *DiskBackend) ListGroups(max int) ([]*Group, error)
  • func (b *DiskBackend) Post(article *Article) error
  • func (b *DiskBackend) Stat(group *Group, id string) (string, string, error)
• type Group
• type Handler
• type NNTPError
  • func (e *NNTPError) Error() string
• type NumberedArticle
• type PostingStatus
  • func (ps PostingStatus) String() string
• type Server
  • func NewServer(backend Backend) *Server
  • func (s *Server) Process(nc net.Conn)

Constants

const (
	DefaultDBPath    = "nntp.db"
	ArticleNumberKey = "article_number"
)

const (
	Unknown             = PostingStatus(0)
	PostingPermitted    = PostingStatus('y')
	PostingNotPermitted = PostingStatus('n')
	PostingModerated    = PostingStatus('m')
)

PostingStatus values.

Variables

var ErrAuthRejected = &NNTPError{452, "authorization rejected"}

var ErrAuthRequired = &NNTPError{450, "authorization required"}

var ErrInvalidArticleNumber = &NNTPError{423, "No article with that number"}

var ErrInvalidMessageID = &NNTPError{430, "No article with that message-id"}

var ErrNoCurrentArticle = &NNTPError{420, "Current article number is invalid"}

var ErrNoGroupSelected = &NNTPError{412, "No newsgroup selected"}

var ErrNoSuchGroup = &NNTPError{411, "No such newsgroup"}

var ErrNotAuthenticated = &NNTPError{480, "authentication required"}

var ErrNotWanted = &NNTPError{435, "Article not wanted"}

var ErrPostingFailed = &NNTPError{441, "posting failed"}

var ErrPostingNotPermitted = &NNTPError{440, "Posting not permitted"}

var ErrSyntax = &NNTPError{501, "not supported, or syntax error"}

var ErrUnknownCommand = &NNTPError{500, "Unknown command"}

Types

type Article

type Article struct {
	Header textproto.MIMEHeader
	Body   io.Reader
	Bytes  int
	Lines  int
}

func (*Article) MessageID

func (a *Article) MessageID() string

type Backend

type Backend interface {
	ListGroups(max int) ([]*Group, error)
	GetGroup(name string) (*Group, error)
	GetArticle(group *Group, id string) (*Article, error)
	GetArticles(group *Group, from, to int64) ([]NumberedArticle, error)
	Authorized() bool
	Authenticate(user, pass string) (Backend, error)
	AllowPost() bool
	Post(article *Article) error
	Stat(group *Group, id string) (string, string, error)
}

type DiskBackend

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

func NewDiskBackend

func NewDiskBackend(
	cleanOnClose bool,
	dbPath string,
) *DiskBackend

func (*DiskBackend) AllowPost

func (b *DiskBackend) AllowPost() bool

func (*DiskBackend) Authenticate

func (b *DiskBackend) Authenticate(user, pass string) (Backend, error)

func (*DiskBackend) Authorized

func (b *DiskBackend) Authorized() bool

func (*DiskBackend) Close

func (b *DiskBackend) Close() error

func (*DiskBackend) GetArticle

func (b *DiskBackend) GetArticle(group *Group, id string) (*Article, error)

func (*DiskBackend) GetArticles

func (b *DiskBackend) GetArticles(group *Group, from, to int64) ([]NumberedArticle, error)

func (*DiskBackend) GetGroup

func (b *DiskBackend) GetGroup(name string) (*Group, error)

func (*DiskBackend) ListGroups

func (b *DiskBackend) ListGroups(max int) ([]*Group, error)

func (*DiskBackend) Post

func (b *DiskBackend) Post(article *Article) error

func (*DiskBackend) Stat

func (b *DiskBackend) Stat(group *Group, id string) (string, string, error)

type Group

type Group struct {
	Name        string
	Description string
	Count       int64
	High        int64
	Low         int64
	Posting     PostingStatus
}

type Handler

type Handler func(args []string, s *session, c *textproto.Conn) error

type NNTPError

type NNTPError struct {
	Code int
	Msg  string
}

func (*NNTPError) Error

func (e *NNTPError) Error() string

type NumberedArticle

type NumberedArticle struct {
	Num     int64
	Article *Article
}

type PostingStatus

type PostingStatus byte

PostingStatus type for groups.

func (PostingStatus) String

func (ps PostingStatus) String() string

type Server

type Server struct {
	Handlers map[string]Handler
	Backend  Backend
	// contains filtered or unexported fields
}

func NewServer

func NewServer(backend Backend) *Server

func (*Server) Process

func (s *Server) Process(nc net.Conn)

Process an NNTP session.