package commands import ( "bytes" "encoding/json" "encoding/xml" "fmt" "io" "strings" ) // ErrorType signfies a category of errors type ErrorType uint // ErrorTypes convey what category of error ocurred const ( ErrNormal ErrorType = iota // general errors ErrClient // error was caused by the client, (e.g. invalid CLI usage) // TODO: add more types of errors for better error-specific handling ) // Error is a struct for marshalling errors type Error struct { Message string Code ErrorType } func (e Error) Error() string { return e.Message } // EncodingType defines a supported encoding type EncodingType string // Supported EncodingType constants. const ( JSON = "json" XML = "xml" Text = "text" // TODO: support more encoding types ) // Marshaller is a function used by coding types. // TODO this should just be a `coding.Codec` type Marshaller func(res Response) ([]byte, error) var marshallers = map[EncodingType]Marshaller{ JSON: func(res Response) ([]byte, error) { if res.Error() != nil { return json.Marshal(res.Error()) } return json.Marshal(res.Output()) }, XML: func(res Response) ([]byte, error) { if res.Error() != nil { return xml.Marshal(res.Error()) } return xml.Marshal(res.Output()) }, Text: func(res Response) ([]byte, error) { format := res.Request().Command().Format if format == nil { return nil, ErrNoFormatter } s, err := format(res) if err != nil { return nil, err } return []byte(s), nil }, } // Response is the result of a command request. Handlers write to the response, // setting Error or Value. Response is returned to the client. type Response interface { Request() Request // Set/Return the response Error SetError(err error, code ErrorType) Error() *Error // Sets/Returns the response value SetOutput(interface{}) Output() interface{} // Marshal marshals out the response into a buffer. It uses the EncodingType // on the Request to chose a Marshaller (Codec). Marshal() ([]byte, error) // Gets a io.Reader that reads the marshalled output Reader() (io.Reader, error) } type response struct { req Request err *Error value interface{} out io.Reader } func (r *response) Request() Request { return r.req } func (r *response) Output() interface{} { return r.value } func (r *response) SetOutput(v interface{}) { r.value = v } func (r *response) Error() *Error { return r.err } func (r *response) SetError(err error, code ErrorType) { r.err = &Error{Message: err.Error(), Code: code} } func (r *response) Marshal() ([]byte, error) { if r.err == nil && r.value == nil { return []byte{}, nil } enc, ok := r.req.Option(EncShort) if !ok || enc.(string) == "" { return nil, fmt.Errorf("No encoding type was specified") } encType := EncodingType(strings.ToLower(enc.(string))) marshaller, ok := marshallers[encType] if !ok { return nil, fmt.Errorf("No marshaller found for encoding type '%s'", enc) } return marshaller(r) } // Reader returns an `io.Reader` representing marshalled output of this Response // Note that multiple calls to this will return a reference to the same io.Reader func (r *response) Reader() (io.Reader, error) { // if command set value to a io.Reader, use that as our reader if r.out == nil { if out, ok := r.value.(io.Reader); ok { r.out = out } } if r.out == nil { // no reader set, so marshal the error or value marshalled, err := r.Marshal() if err != nil { return nil, err } // create a Reader from the marshalled data r.out = bytes.NewReader(marshalled) } return r.out, nil } // NewResponse returns a response to match given Request func NewResponse(req Request) Response { return &response{req: req} }