|
|
@@ -10,91 +10,76 @@ import (
|
|
|
"github.com/docker/docker/pkg/progress"
|
|
|
)
|
|
|
|
|
|
-// StreamFormatter formats a stream, optionally using JSON.
|
|
|
-type StreamFormatter struct {
|
|
|
- json bool
|
|
|
-}
|
|
|
-
|
|
|
-// NewStreamFormatter returns a simple StreamFormatter
|
|
|
-func NewStreamFormatter() *StreamFormatter {
|
|
|
- return &StreamFormatter{}
|
|
|
-}
|
|
|
-
|
|
|
-// NewJSONStreamFormatter returns a StreamFormatter configured to stream json
|
|
|
-func NewJSONStreamFormatter() *StreamFormatter {
|
|
|
- return &StreamFormatter{true}
|
|
|
-}
|
|
|
-
|
|
|
const streamNewline = "\r\n"
|
|
|
|
|
|
-var streamNewlineBytes = []byte(streamNewline)
|
|
|
+type jsonProgressFormatter struct{}
|
|
|
|
|
|
-// FormatStream formats the specified stream.
|
|
|
-func (sf *StreamFormatter) FormatStream(str string) []byte {
|
|
|
- if sf.json {
|
|
|
- b, err := json.Marshal(&jsonmessage.JSONMessage{Stream: str})
|
|
|
- if err != nil {
|
|
|
- return sf.FormatError(err)
|
|
|
- }
|
|
|
- return append(b, streamNewlineBytes...)
|
|
|
- }
|
|
|
- return []byte(str + "\r")
|
|
|
+func appendNewline(source []byte) []byte {
|
|
|
+ return append(source, []byte(streamNewline)...)
|
|
|
}
|
|
|
|
|
|
// FormatStatus formats the specified objects according to the specified format (and id).
|
|
|
-func (sf *StreamFormatter) FormatStatus(id, format string, a ...interface{}) []byte {
|
|
|
+func FormatStatus(id, format string, a ...interface{}) []byte {
|
|
|
str := fmt.Sprintf(format, a...)
|
|
|
- if sf.json {
|
|
|
- b, err := json.Marshal(&jsonmessage.JSONMessage{ID: id, Status: str})
|
|
|
- if err != nil {
|
|
|
- return sf.FormatError(err)
|
|
|
- }
|
|
|
- return append(b, streamNewlineBytes...)
|
|
|
+ b, err := json.Marshal(&jsonmessage.JSONMessage{ID: id, Status: str})
|
|
|
+ if err != nil {
|
|
|
+ return FormatError(err)
|
|
|
}
|
|
|
- return []byte(str + streamNewline)
|
|
|
+ return appendNewline(b)
|
|
|
}
|
|
|
|
|
|
-// FormatError formats the specified error.
|
|
|
-func (sf *StreamFormatter) FormatError(err error) []byte {
|
|
|
- if sf.json {
|
|
|
- jsonError, ok := err.(*jsonmessage.JSONError)
|
|
|
- if !ok {
|
|
|
- jsonError = &jsonmessage.JSONError{Message: err.Error()}
|
|
|
- }
|
|
|
- if b, err := json.Marshal(&jsonmessage.JSONMessage{Error: jsonError, ErrorMessage: err.Error()}); err == nil {
|
|
|
- return append(b, streamNewlineBytes...)
|
|
|
- }
|
|
|
- return []byte("{\"error\":\"format error\"}" + streamNewline)
|
|
|
+// FormatError formats the error as a JSON object
|
|
|
+func FormatError(err error) []byte {
|
|
|
+ jsonError, ok := err.(*jsonmessage.JSONError)
|
|
|
+ if !ok {
|
|
|
+ jsonError = &jsonmessage.JSONError{Message: err.Error()}
|
|
|
}
|
|
|
- return []byte("Error: " + err.Error() + streamNewline)
|
|
|
+ if b, err := json.Marshal(&jsonmessage.JSONMessage{Error: jsonError, ErrorMessage: err.Error()}); err == nil {
|
|
|
+ return appendNewline(b)
|
|
|
+ }
|
|
|
+ return []byte(`{"error":"format error"}` + streamNewline)
|
|
|
+}
|
|
|
+
|
|
|
+func (sf *jsonProgressFormatter) formatStatus(id, format string, a ...interface{}) []byte {
|
|
|
+ return FormatStatus(id, format, a...)
|
|
|
}
|
|
|
|
|
|
-// FormatProgress formats the progress information for a specified action.
|
|
|
-func (sf *StreamFormatter) FormatProgress(id, action string, progress *jsonmessage.JSONProgress, aux interface{}) []byte {
|
|
|
+// formatProgress formats the progress information for a specified action.
|
|
|
+func (sf *jsonProgressFormatter) formatProgress(id, action string, progress *jsonmessage.JSONProgress, aux interface{}) []byte {
|
|
|
if progress == nil {
|
|
|
progress = &jsonmessage.JSONProgress{}
|
|
|
}
|
|
|
- if sf.json {
|
|
|
- var auxJSON *json.RawMessage
|
|
|
- if aux != nil {
|
|
|
- auxJSONBytes, err := json.Marshal(aux)
|
|
|
- if err != nil {
|
|
|
- return nil
|
|
|
- }
|
|
|
- auxJSON = new(json.RawMessage)
|
|
|
- *auxJSON = auxJSONBytes
|
|
|
- }
|
|
|
- b, err := json.Marshal(&jsonmessage.JSONMessage{
|
|
|
- Status: action,
|
|
|
- ProgressMessage: progress.String(),
|
|
|
- Progress: progress,
|
|
|
- ID: id,
|
|
|
- Aux: auxJSON,
|
|
|
- })
|
|
|
+ var auxJSON *json.RawMessage
|
|
|
+ if aux != nil {
|
|
|
+ auxJSONBytes, err := json.Marshal(aux)
|
|
|
if err != nil {
|
|
|
return nil
|
|
|
}
|
|
|
- return append(b, streamNewlineBytes...)
|
|
|
+ auxJSON = new(json.RawMessage)
|
|
|
+ *auxJSON = auxJSONBytes
|
|
|
+ }
|
|
|
+ b, err := json.Marshal(&jsonmessage.JSONMessage{
|
|
|
+ Status: action,
|
|
|
+ ProgressMessage: progress.String(),
|
|
|
+ Progress: progress,
|
|
|
+ ID: id,
|
|
|
+ Aux: auxJSON,
|
|
|
+ })
|
|
|
+ if err != nil {
|
|
|
+ return nil
|
|
|
+ }
|
|
|
+ return appendNewline(b)
|
|
|
+}
|
|
|
+
|
|
|
+type rawProgressFormatter struct{}
|
|
|
+
|
|
|
+func (sf *rawProgressFormatter) formatStatus(id, format string, a ...interface{}) []byte {
|
|
|
+ return []byte(fmt.Sprintf(format, a...) + streamNewline)
|
|
|
+}
|
|
|
+
|
|
|
+func (sf *rawProgressFormatter) formatProgress(id, action string, progress *jsonmessage.JSONProgress, aux interface{}) []byte {
|
|
|
+ if progress == nil {
|
|
|
+ progress = &jsonmessage.JSONProgress{}
|
|
|
}
|
|
|
endl := "\r"
|
|
|
if progress.String() == "" {
|
|
|
@@ -105,16 +90,23 @@ func (sf *StreamFormatter) FormatProgress(id, action string, progress *jsonmessa
|
|
|
|
|
|
// NewProgressOutput returns a progress.Output object that can be passed to
|
|
|
// progress.NewProgressReader.
|
|
|
-func (sf *StreamFormatter) NewProgressOutput(out io.Writer, newLines bool) progress.Output {
|
|
|
- return &progressOutput{
|
|
|
- sf: sf,
|
|
|
- out: out,
|
|
|
- newLines: newLines,
|
|
|
- }
|
|
|
+func NewProgressOutput(out io.Writer) progress.Output {
|
|
|
+ return &progressOutput{sf: &rawProgressFormatter{}, out: out, newLines: true}
|
|
|
+}
|
|
|
+
|
|
|
+// NewJSONProgressOutput returns a progress.Output that that formats output
|
|
|
+// using JSON objects
|
|
|
+func NewJSONProgressOutput(out io.Writer, newLines bool) progress.Output {
|
|
|
+ return &progressOutput{sf: &jsonProgressFormatter{}, out: out, newLines: newLines}
|
|
|
+}
|
|
|
+
|
|
|
+type formatProgress interface {
|
|
|
+ formatStatus(id, format string, a ...interface{}) []byte
|
|
|
+ formatProgress(id, action string, progress *jsonmessage.JSONProgress, aux interface{}) []byte
|
|
|
}
|
|
|
|
|
|
type progressOutput struct {
|
|
|
- sf *StreamFormatter
|
|
|
+ sf formatProgress
|
|
|
out io.Writer
|
|
|
newLines bool
|
|
|
}
|
|
|
@@ -123,10 +115,10 @@ type progressOutput struct {
|
|
|
func (out *progressOutput) WriteProgress(prog progress.Progress) error {
|
|
|
var formatted []byte
|
|
|
if prog.Message != "" {
|
|
|
- formatted = out.sf.FormatStatus(prog.ID, prog.Message)
|
|
|
+ formatted = out.sf.formatStatus(prog.ID, prog.Message)
|
|
|
} else {
|
|
|
jsonProgress := jsonmessage.JSONProgress{Current: prog.Current, Total: prog.Total, HideCounts: prog.HideCounts}
|
|
|
- formatted = out.sf.FormatProgress(prog.ID, prog.Action, &jsonProgress, prog.Aux)
|
|
|
+ formatted = out.sf.formatProgress(prog.ID, prog.Action, &jsonProgress, prog.Aux)
|
|
|
}
|
|
|
_, err := out.out.Write(formatted)
|
|
|
if err != nil {
|
|
|
@@ -134,39 +126,9 @@ func (out *progressOutput) WriteProgress(prog progress.Progress) error {
|
|
|
}
|
|
|
|
|
|
if out.newLines && prog.LastUpdate {
|
|
|
- _, err = out.out.Write(out.sf.FormatStatus("", ""))
|
|
|
+ _, err = out.out.Write(out.sf.formatStatus("", ""))
|
|
|
return err
|
|
|
}
|
|
|
|
|
|
return nil
|
|
|
}
|
|
|
-
|
|
|
-// StdoutFormatter is a streamFormatter that writes to the standard output.
|
|
|
-type StdoutFormatter struct {
|
|
|
- io.Writer
|
|
|
- *StreamFormatter
|
|
|
-}
|
|
|
-
|
|
|
-func (sf *StdoutFormatter) Write(buf []byte) (int, error) {
|
|
|
- formattedBuf := sf.StreamFormatter.FormatStream(string(buf))
|
|
|
- n, err := sf.Writer.Write(formattedBuf)
|
|
|
- if n != len(formattedBuf) {
|
|
|
- return n, io.ErrShortWrite
|
|
|
- }
|
|
|
- return len(buf), err
|
|
|
-}
|
|
|
-
|
|
|
-// StderrFormatter is a streamFormatter that writes to the standard error.
|
|
|
-type StderrFormatter struct {
|
|
|
- io.Writer
|
|
|
- *StreamFormatter
|
|
|
-}
|
|
|
-
|
|
|
-func (sf *StderrFormatter) Write(buf []byte) (int, error) {
|
|
|
- formattedBuf := sf.StreamFormatter.FormatStream("\033[91m" + string(buf) + "\033[0m")
|
|
|
- n, err := sf.Writer.Write(formattedBuf)
|
|
|
- if n != len(formattedBuf) {
|
|
|
- return n, io.ErrShortWrite
|
|
|
- }
|
|
|
- return len(buf), err
|
|
|
-}
|
Daniel Nephin