gopherhole

package

v0.0.0-...-8711128 Latest Latest Go to latest Published: Oct 14, 2020 License: GPL-3.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/joshcom/gopherhole

Links

Open Source Insights

README ¶

gopher

Usage

  config := gopher.NewConfiguration{}
  config.Port = '...'

  // ... or ...
  config := gopher.NewConfigurationFromFile("/path/to/myconfig.json")

  server := gopher.NewServer(config)
  server.Run()

Configuration

See the parent README for details on configuration settings.

Documentation ¶

Overview ¶

Package gopherhole implements a gopher server.

Example usage:

// Any omitted config setting will use
// the default noted below.
// Prefer absolute paths.
// config := gopherhole.NewConfiguration() loads the defaults.
//
// View the README for more details on configuration options.
config := gopherhole.Configuration{
  RootDirectory:  "/var/gopherhole",
  Host:           "localhost",
  Port:           70,
  MaxConnections: 0, // 0 means no maximum.
  MapFileName:    "gophermap",
  LogFile:        "", // An empty string prints to STDOUT
  IdleTimeout:    60, // The number of seconds a client has after connecting
                      // to make a query.
}
server := gopherhole.NewServer(config)
server.Run()

Additionally, the configuration can be stored as JSON in a file:

{
  "Host": "localhost",
  // ...
}

The absolute path can be specified when building a new configuration:

config := gopherhole.NewConfigurationFromFile("/path/to/config.json")

Index ¶

Constants
Variables
type Configuration
- func NewConfiguration() Configuration
- func NewConfigurationFromFile(pathToFile string) (config Configuration, err error)
type EntityType
- func EntityForMimeType(mime string) (entity EntityType, ok bool)
type Server
- func NewServer(config Configuration) (server Server)
- func (s *Server) Run() (err error)

Constants ¶

View Source

const (
	ROOT_DIRECTORY    = "/var/gopherhole"
	PORT              = 70
	MAX_CONNECTIONS   = 0
	HOST              = "localhost"
	MAP_FILE_NAME     = "gophermap"
	LOG_DISABLED      = false
	LOG_FILE          = ""
	IDLE_TIMEOUT      = 60
	DEFAULT_MIME_TYPE = "text/plain"
)

View Source

const (
	CR_CHAR  = '\r'
	END_CHAR = '.'
	LF_CHAR  = '\n'
	TAB_CHAR = '\t'
	NOPATH   = "(NOTHING)"
	NOHOST   = "nohost"
	NOPORT   = 0
)

View Source

const (
	CONNECTION_FREED_BUFFER_SIZE = 10
)

Variables ¶

View Source

var AllEntities = [...]EntityType{
	TextFileEntity,
	DirectoryEntity,
	CsoNameServerEntity,
	ErrorEntity,
	MacBinaryEntity,
	DosBinaryEntity,
	UnixUUEncodedEntity,
	SearchServiceEntity,
	TelnetEntity,
	BinaryEntity,
	CalendarEntity,
	EventEntity,
	GifEntity,
	HtmlEntity,
	InlineTextEntity,
	SoundEntity,
	ImageEntity,
	MIMEEntity,
	TN3270Entity,
}

View Source

var Listen = func(network, address string) (net.Listener, error) {
	ln, err := net.Listen(network, address)
	return ln, err
}

View Source

var MimeTypeEntities = map[string]EntityType{
	"audio/":                      SoundEntity,
	"application/":                BinaryEntity,
	"application/binhex":          MacBinaryEntity,
	"application/mac-binhex40":    MacBinaryEntity,
	"application/mac-binhex":      MacBinaryEntity,
	"application/x-msdos-program": DosBinaryEntity,
	"image/":                      ImageEntity,
	"image/gif":                   GifEntity,
	"multipart/":                  MIMEEntity,
	"text/":                       TextFileEntity,
	"text/calendar":               CalendarEntity,
	"text/x-vcalendar":            CalendarEntity,
	"text/html":                   HtmlEntity,
	"video/":                      BinaryEntity,
}

Functions ¶

This section is empty.

Types ¶

type Configuration ¶

type Configuration struct {
	RootDirectory      string
	Host               string
	Port               int
	MaxConnections     int
	MapFileName        string
	LogDisabled        bool
	LogFile            string
	IdleTimeout        int
	DefaultMimeType    string
	MimeTypeIgnoreList []string
}

func NewConfiguration ¶

func NewConfiguration() Configuration

func NewConfigurationFromFile ¶

func NewConfigurationFromFile(pathToFile string) (config Configuration, err error)

type EntityType ¶

type EntityType byte

const (
	TextFileEntity      EntityType = '0'
	DirectoryEntity     EntityType = '1'
	CsoNameServerEntity EntityType = '2'
	ErrorEntity         EntityType = '3'
	MacBinaryEntity     EntityType = '4'
	DosBinaryEntity     EntityType = '5'
	UnixUUEncodedEntity EntityType = '6'
	SearchServiceEntity EntityType = '7'
	TelnetEntity        EntityType = '8'
	BinaryEntity        EntityType = '9'
	CalendarEntity      EntityType = 'c'
	EventEntity         EntityType = 'e'
	GifEntity           EntityType = 'g'
	HtmlEntity          EntityType = 'h'
	InlineTextEntity    EntityType = 'i'
	SoundEntity         EntityType = 's'
	ImageEntity         EntityType = 'I'
	MIMEEntity          EntityType = 'M'
	TN3270Entity        EntityType = 'T'
)

func EntityForMimeType ¶

func EntityForMimeType(mime string) (entity EntityType, ok bool)

type Server ¶

type Server struct {
	Configuration Configuration
	Logger        *log.Logger
	// contains filtered or unexported fields
}

func NewServer ¶

func NewServer(config Configuration) (server Server)

func (*Server) Run ¶

func (s *Server) Run() (err error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL