printer/templateprinter.go
author Mikael Berthe <mikael@lilotux.net>
Sun, 07 May 2017 17:32:33 +0200
changeset 89 3758bb5f0979
parent 85 a4464c0b0c36
child 90 b1da6dc9f689
permissions -rw-r--r--
ResourcePrinter (templates): Use options to pass color_mode
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     1
// Copyright © 2017 Mikael Berthe <mikael@lilotux.net>
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     2
//
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     3
// Licensed under the MIT license.
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     4
// Please see the LICENSE file is this directory.
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     5
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     6
package printer
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     7
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     8
import (
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
	"encoding/json"
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
	"fmt"
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    11
	"io"
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    12
	"os"
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    13
	"reflect"
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    14
	"text/template"
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    15
40
ad148f60dc87 TemplatePrinter: Handle InstanceStatus lists
Mikael Berthe <mikael@lilotux.net>
parents: 14
diff changeset
    16
	"github.com/m0t0k1ch1/gomif"
50
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
    17
	"github.com/mattn/go-isatty"
40
ad148f60dc87 TemplatePrinter: Handle InstanceStatus lists
Mikael Berthe <mikael@lilotux.net>
parents: 14
diff changeset
    18
0
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
	"github.com/McKael/madon"
49
d6b4e3b7c6c6 Add ANSI color support to templates (function "color")
Mikael Berthe <mikael@lilotux.net>
parents: 41
diff changeset
    20
	"github.com/McKael/madonctl/printer/colors"
0
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    21
)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
51
300ac09051a7 Add ability to force colors: option --color=auto|on|off
Mikael Berthe <mikael@lilotux.net>
parents: 50
diff changeset
    23
// disableColors can be set to true to disable the color template function
300ac09051a7 Add ability to force colors: option --color=auto|on|off
Mikael Berthe <mikael@lilotux.net>
parents: 50
diff changeset
    24
var disableColors bool
50
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
    25
0
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    26
// TemplatePrinter represents a Template printer
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    27
type TemplatePrinter struct {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    28
	rawTemplate string
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    29
	template    *template.Template
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    30
}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    31
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    32
// NewPrinterTemplate returns a Template ResourcePrinter
83
57afac822019 Use a map for ResourcePrinter options
Mikael Berthe <mikael@lilotux.net>
parents: 51
diff changeset
    33
// For TemplatePrinter, the options parameter contains the template string.
89
3758bb5f0979 ResourcePrinter (templates): Use options to pass color_mode
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    34
// The "color_mode" option defines the color behaviour: it can be
3758bb5f0979 ResourcePrinter (templates): Use options to pass color_mode
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    35
// "auto" (default), "on" (forced), "off" (disabled).
83
57afac822019 Use a map for ResourcePrinter options
Mikael Berthe <mikael@lilotux.net>
parents: 51
diff changeset
    36
func NewPrinterTemplate(options Options) (*TemplatePrinter, error) {
57afac822019 Use a map for ResourcePrinter options
Mikael Berthe <mikael@lilotux.net>
parents: 51
diff changeset
    37
	tmpl := options["template"]
85
a4464c0b0c36 Add theme support
Mikael Berthe <mikael@lilotux.net>
parents: 83
diff changeset
    38
	if tmpl == "" {
a4464c0b0c36 Add theme support
Mikael Berthe <mikael@lilotux.net>
parents: 83
diff changeset
    39
		return nil, fmt.Errorf("empty template")
a4464c0b0c36 Add theme support
Mikael Berthe <mikael@lilotux.net>
parents: 83
diff changeset
    40
	}
41
909c3ddd83f6 Add fromunix filter to templates (converts date from UNIX timestamp)
Mikael Berthe <mikael@lilotux.net>
parents: 40
diff changeset
    41
	t, err := template.New("output").Funcs(template.FuncMap{
909c3ddd83f6 Add fromunix filter to templates (converts date from UNIX timestamp)
Mikael Berthe <mikael@lilotux.net>
parents: 40
diff changeset
    42
		"fromhtml": html2string,
909c3ddd83f6 Add fromunix filter to templates (converts date from UNIX timestamp)
Mikael Berthe <mikael@lilotux.net>
parents: 40
diff changeset
    43
		"fromunix": unix2string,
50
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
    44
		"color":    ansiColor,
41
909c3ddd83f6 Add fromunix filter to templates (converts date from UNIX timestamp)
Mikael Berthe <mikael@lilotux.net>
parents: 40
diff changeset
    45
	}).Parse(tmpl)
0
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    46
	if err != nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    47
		return nil, err
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    48
	}
50
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
    49
51
300ac09051a7 Add ability to force colors: option --color=auto|on|off
Mikael Berthe <mikael@lilotux.net>
parents: 50
diff changeset
    50
	// Update disableColors.
300ac09051a7 Add ability to force colors: option --color=auto|on|off
Mikael Berthe <mikael@lilotux.net>
parents: 50
diff changeset
    51
	// In auto-mode, check if stdout is a TTY.
89
3758bb5f0979 ResourcePrinter (templates): Use options to pass color_mode
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    52
	colorMode := options["color_mode"]
3758bb5f0979 ResourcePrinter (templates): Use options to pass color_mode
Mikael Berthe <mikael@lilotux.net>
parents: 85
diff changeset
    53
	if colorMode == "off" || (colorMode != "on" && !isatty.IsTerminal(os.Stdout.Fd())) {
51
300ac09051a7 Add ability to force colors: option --color=auto|on|off
Mikael Berthe <mikael@lilotux.net>
parents: 50
diff changeset
    54
		disableColors = true
50
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
    55
	}
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
    56
0
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    57
	return &TemplatePrinter{
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    58
		rawTemplate: tmpl,
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    59
		template:    t,
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    60
	}, nil
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    61
}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    62
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    63
// PrintObj sends the object as text to the writer
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    64
// If the writer w is nil, standard output will be used.
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    65
func (p *TemplatePrinter) PrintObj(obj interface{}, w io.Writer, tmpl string) error {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    66
	if w == nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    67
		w = os.Stdout
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    68
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    69
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    70
	if p.template == nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    71
		return fmt.Errorf("template not built")
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    72
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    73
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    74
	switch ot := obj.(type) { // I wish I knew a better way...
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    75
	case []madon.Account, []madon.Application, []madon.Attachment, []madon.Card,
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    76
		[]madon.Client, []madon.Context, []madon.Instance, []madon.Mention,
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    77
		[]madon.Notification, []madon.Relationship, []madon.Report,
40
ad148f60dc87 TemplatePrinter: Handle InstanceStatus lists
Mikael Berthe <mikael@lilotux.net>
parents: 14
diff changeset
    78
		[]madon.Results, []madon.Status, []madon.StreamEvent, []madon.Tag,
ad148f60dc87 TemplatePrinter: Handle InstanceStatus lists
Mikael Berthe <mikael@lilotux.net>
parents: 14
diff changeset
    79
		[]*gomif.InstanceStatus:
0
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    80
		return p.templateForeach(ot, w)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    81
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    82
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    83
	return p.templatePrintSingleObj(obj, w)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    84
}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    85
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    86
func (p *TemplatePrinter) templatePrintSingleObj(obj interface{}, w io.Writer) error {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    87
	// This code comes from Kubernetes.
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    88
	data, err := json.Marshal(obj)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    89
	if err != nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    90
		return err
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    91
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    92
	out := map[string]interface{}{}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    93
	if err := json.Unmarshal(data, &out); err != nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    94
		return err
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    95
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    96
	if err = p.safeExecute(w, out); err != nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    97
		return fmt.Errorf("error executing template %q: %v", p.rawTemplate, err)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    98
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    99
	return nil
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   100
}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   101
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   102
// safeExecute tries to execute the template, but catches panics and returns an error
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   103
// should the template engine panic.
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   104
// This code comes from Kubernetes.
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   105
func (p *TemplatePrinter) safeExecute(w io.Writer, obj interface{}) error {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   106
	var panicErr error
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   107
	// Sorry for the double anonymous function. There's probably a clever way
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   108
	// to do this that has the defer'd func setting the value to be returned, but
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   109
	// that would be even less obvious.
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   110
	retErr := func() error {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   111
		defer func() {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   112
			if x := recover(); x != nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   113
				panicErr = fmt.Errorf("caught panic: %+v", x)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   114
			}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   115
		}()
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   116
		return p.template.Execute(w, obj)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   117
	}()
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   118
	if panicErr != nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   119
		return panicErr
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   120
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   121
	return retErr
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   122
}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   123
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   124
func (p *TemplatePrinter) templateForeach(ol interface{}, w io.Writer) error {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   125
	switch reflect.TypeOf(ol).Kind() {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   126
	case reflect.Slice:
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   127
		s := reflect.ValueOf(ol)
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   128
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   129
		for i := 0; i < s.Len(); i++ {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   130
			o := s.Index(i).Interface()
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   131
			if err := p.templatePrintSingleObj(o, w); err != nil {
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   132
				return err
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   133
			}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   134
		}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   135
	}
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   136
	return nil
5abace724584 Initial public release
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   137
}
50
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
   138
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
   139
func ansiColor(desc string) (string, error) {
51
300ac09051a7 Add ability to force colors: option --color=auto|on|off
Mikael Berthe <mikael@lilotux.net>
parents: 50
diff changeset
   140
	if disableColors {
50
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
   141
		return "", nil
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
   142
	}
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
   143
	return colors.ANSICodeString(desc)
c6adf9d9e996 Disable ANSI sequences when stdout is not a TTY
Mikael Berthe <mikael@lilotux.net>
parents: 49
diff changeset
   144
}