go-gemini/response.go

206 lines
4.8 KiB
Go
Raw Normal View History

2020-10-24 13:15:32 -06:00
package gemini
2020-10-21 15:07:28 -06:00
import (
"bufio"
"crypto/tls"
2020-10-27 17:16:55 -06:00
"io"
2020-10-21 15:07:28 -06:00
"strconv"
)
// Response is a Gemini response.
type Response struct {
2020-10-31 18:32:38 -06:00
// Status contains the response status code.
Status Status
2020-10-21 15:07:28 -06:00
// Meta contains more information related to the response status.
2021-01-09 23:07:38 -07:00
// For successful responses, Meta should contain the media type of the response.
2020-10-21 15:07:28 -06:00
// For failure responses, Meta should contain a short description of the failure.
// Meta should not be longer than 1024 bytes.
Meta string
2020-10-27 17:16:55 -06:00
// Body contains the response body for successful responses.
Body io.ReadCloser
2020-10-21 15:07:28 -06:00
// TLS contains information about the TLS connection on which the response
// was received.
TLS tls.ConnectionState
}
// ReadResponse reads a Gemini response from the provided io.ReadCloser.
func ReadResponse(rc io.ReadCloser) (*Response, error) {
resp := &Response{}
2020-10-27 17:16:55 -06:00
br := bufio.NewReader(rc)
2020-10-21 15:07:28 -06:00
// Read the status
statusB := make([]byte, 2)
2020-10-27 17:16:55 -06:00
if _, err := br.Read(statusB); err != nil {
return nil, err
2020-10-21 15:07:28 -06:00
}
status, err := strconv.Atoi(string(statusB))
if err != nil {
return nil, err
2020-10-21 15:07:28 -06:00
}
resp.Status = Status(status)
2020-10-21 15:07:28 -06:00
// Disregard invalid status codes
const minStatus, maxStatus = 1, 6
statusClass := resp.Status.Class()
2020-10-21 15:07:28 -06:00
if statusClass < minStatus || statusClass > maxStatus {
return nil, ErrInvalidResponse
2020-10-21 15:07:28 -06:00
}
// Read one space
2020-10-27 17:16:55 -06:00
if b, err := br.ReadByte(); err != nil {
return nil, err
2020-10-21 15:07:28 -06:00
} else if b != ' ' {
return nil, ErrInvalidResponse
2020-10-21 15:07:28 -06:00
}
// Read the meta
2020-10-27 17:16:55 -06:00
meta, err := br.ReadString('\r')
2020-10-21 15:07:28 -06:00
if err != nil {
return nil, err
2020-10-21 15:07:28 -06:00
}
// Trim carriage return
meta = meta[:len(meta)-1]
// Ensure meta is less than or equal to 1024 bytes
if len(meta) > 1024 {
return nil, ErrInvalidResponse
2020-10-21 15:07:28 -06:00
}
2020-10-31 18:32:38 -06:00
// Default mime type of text/gemini; charset=utf-8
if statusClass == StatusClassSuccess && meta == "" {
meta = "text/gemini; charset=utf-8"
}
2020-10-21 15:07:28 -06:00
resp.Meta = meta
// Read terminating newline
2020-10-27 17:16:55 -06:00
if b, err := br.ReadByte(); err != nil {
return nil, err
2020-10-21 15:07:28 -06:00
} else if b != '\n' {
return nil, ErrInvalidResponse
2020-10-21 15:07:28 -06:00
}
if resp.Status.Class() == StatusClassSuccess {
2020-10-27 17:16:55 -06:00
resp.Body = newReadCloserBody(br, rc)
} else {
rc.Close()
2020-10-21 15:07:28 -06:00
}
return resp, nil
2020-10-21 15:07:28 -06:00
}
2020-10-27 17:16:55 -06:00
type readCloserBody struct {
br *bufio.Reader // used until empty
io.ReadCloser
}
func newReadCloserBody(br *bufio.Reader, rc io.ReadCloser) io.ReadCloser {
body := &readCloserBody{ReadCloser: rc}
if br.Buffered() != 0 {
body.br = br
}
return body
}
func (b *readCloserBody) Read(p []byte) (n int, err error) {
if b.br != nil {
if n := b.br.Buffered(); len(p) > n {
p = p[:n]
}
n, err = b.br.Read(p)
if b.br.Buffered() == 0 {
b.br = nil
}
return n, err
}
return b.ReadCloser.Read(p)
}
2021-01-09 22:50:35 -07:00
2021-01-09 23:07:38 -07:00
// ResponseWriter is used to construct a Gemini response.
2021-01-09 22:50:35 -07:00
type ResponseWriter struct {
b *bufio.Writer
status Status
meta string
setHeader bool
wroteHeader bool
bodyAllowed bool
}
// NewResponseWriter returns a ResponseWriter that uses the provided io.Writer.
func NewResponseWriter(w io.Writer) *ResponseWriter {
return &ResponseWriter{
b: bufio.NewWriter(w),
}
}
// Header sets the response header.
func (w *ResponseWriter) Header(status Status, meta string) {
w.status = status
w.meta = meta
}
// Status sets the response status code.
// It also sets the response meta to status.Meta().
func (w *ResponseWriter) Status(status Status) {
w.status = status
w.meta = status.Meta()
}
// Meta sets the response meta.
//
// For successful responses, meta should contain the media type of the response.
// For failure responses, meta should contain a short description of the failure.
// The response meta should not be greater than 1024 bytes.
func (w *ResponseWriter) Meta(meta string) {
w.meta = meta
}
// Write writes data to the connection as part of the response body.
// If the response status does not allow for a response body, Write returns
// ErrBodyNotAllowed.
//
// Write writes the response header if it has not already been written.
// It writes a successful status code if one is not set.
func (w *ResponseWriter) Write(b []byte) (int, error) {
if !w.wroteHeader {
w.writeHeader(StatusSuccess)
}
if !w.bodyAllowed {
return 0, ErrBodyNotAllowed
}
return w.b.Write(b)
}
func (w *ResponseWriter) writeHeader(defaultStatus Status) {
status := w.status
if status == 0 {
status = defaultStatus
}
meta := w.meta
if status.Class() == StatusClassSuccess {
w.bodyAllowed = true
if meta == "" {
meta = "text/gemini"
}
}
w.b.WriteString(strconv.Itoa(int(status)))
w.b.WriteByte(' ')
w.b.WriteString(meta)
w.b.Write(crlf)
w.wroteHeader = true
}
// Flush writes any buffered data to the underlying io.Writer.
//
// Flush writes the response header if it has not already been written.
// It writes a failure status code if one is not set.
func (w *ResponseWriter) Flush() error {
if !w.wroteHeader {
w.writeHeader(StatusTemporaryFailure)
}
// Write errors from writeHeader will be returned here.
return w.b.Flush()
}