Run a gopher application that may cause effects in IO. The application function is given the GopherRequest sent by the client and must produce a GopherResponse.

Like runGopher, but may not cause effects in IO (or anywhere else).

Same as runGopher, but allows you to setup the Socket manually and calls an user provided action soon as the server is ready to accept requests. When the server terminates, it calls the given clean up action which must close the socket and may perform other shutdown tasks (like notifying a supervisor it is stopping).

Spacecookie assumes the Socket is properly set up to listen on the port and host specified in the GopherConfig (i. e. bind and listen have been called). This can be achieved using setupGopherSocket. Especially note that spacecookie does not check if the listening address and port of the given socket match cListenAddr and cServerPort.

This is intended for supporting systemd socket activation and storage, but may also be used to support other use cases where more control is necessary. Always use runGopher if possible, as it offers less ways of messing things up.

Necessary information to handle gopher requests

Default GopherConfig describing a server on localhost:70 with no registered log handler.

entry in a gopher menu

rfc-defined gopher file types plus info line and HTML

Type for an user defined IO action which handles logging a given GopherLogStr of a given GopherLogLevel. It may process the string and format in any way desired, but it must be thread safe and should not block (too long) since it is called syncronously.

UTF-8 encoded string which may have parts of it marked as sensitive (see makeSensitive). Use its ToGopherLogStr, Semigroup and IsString instances to construct GopherLogStrs and FromGopherLogStr to convert to the commonly used Haskell string types.

Mark a GopherLogStr as sensitive. This is used by this library mostly to mark IP addresses of connecting clients. By using hideSensitive on a GopherLogStr sensitive parts will be hidden from the string — even if the sensitive string was concatenated to other strings.

Replaces all chunks of the GopherLogStr that have been marked as sensitive by makeSensitive with [redacted]. Note that the chunking is dependent on the way the string was assembled by the user and the internal implementation of GopherLogStr which can lead to multiple consecutive [redacted] being returned unexpectedly. This may be improved in the future.

Indicates the log level of a GopherLogStr to a GopherLogHandler. If you want to filter by log level you can use either the Ord or Enum instance of GopherLogLevel as the following holds:

GopherLogLevelError < GopherLogLevelWarn < GopherLogLevelInfo

Convert something to a GopherLogStr. In terms of performance it is best to implement a Builder for the type you are trying to render to GopherLogStr and then reuse its ToGopherLogStr instance.

Convert GopherLogStrs to other string types. Since it is used internally by GopherLogStr, it is best to use the Builder instance for performance if possible.

Auxiliary function that sets up the listening socket for runGopherManual correctly and starts to listen.

May throw a SocketException if an error occurs while setting up the socket.

Given a directory and a Gophermap contained within it, return the corresponding gopher menu response.

A gophermap entry makes all values of a gopher menu item optional except for file type and description. When converting to a GopherMenuItem, appropriate default values are used.