summaryrefslogtreecommitdiff
path: root/caddyconfig/caddyfile/formatter.go
blob: 82b8b3c30d128aeed63c9f062f178ce2a64389b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
// Copyright 2015 Matthew Holt and The Caddy Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package caddyfile

import (
	"bytes"
	"io"
	"unicode"
)

// Format formats a Caddyfile to conventional standards.
func Format(body []byte) []byte {
	reader := bytes.NewReader(body)
	result := new(bytes.Buffer)

	var (
		commented,
		quoted,
		escaped,
		environ,
		lineBegin bool

		firstIteration = true

		indentation = 0

		prev,
		curr,
		next rune

		err error
	)

	insertTabs := func(num int) {
		for tabs := num; tabs > 0; tabs-- {
			result.WriteRune('\t')
		}
	}

	for {
		prev = curr
		curr = next

		if curr < 0 {
			break
		}

		next, _, err = reader.ReadRune()
		if err != nil {
			if err == io.EOF {
				next = -1
			} else {
				panic(err)
			}
		}

		if firstIteration {
			firstIteration = false
			lineBegin = true
			continue
		}

		if quoted {
			if escaped {
				escaped = false
			} else {
				if curr == '\\' {
					escaped = true
				}
				if curr == '"' {
					quoted = false
				}
			}
			if curr == '\n' {
				quoted = false
			}
		} else if commented {
			if curr == '\n' {
				commented = false
			}
		} else {
			if curr == '"' {
				quoted = true
			}
			if curr == '#' {
				commented = true
			}
			if curr == '}' {
				if environ {
					environ = false
				} else if indentation > 0 {
					indentation--
				}
			}
			if curr == '{' {
				if unicode.IsSpace(next) {
					indentation++

					if !unicode.IsSpace(prev) && !lineBegin {
						result.WriteRune(' ')
					}
				} else {
					environ = true
				}
			}
			if lineBegin {
				if curr == ' ' || curr == '\t' {
					continue
				} else {
					lineBegin = false
					if curr == '{' && unicode.IsSpace(next) {
						// If the block is global, i.e., starts with '{'
						// One less indentation for these blocks.
						insertTabs(indentation - 1)
					} else {
						insertTabs(indentation)
					}
				}
			} else {
				if prev == '{' &&
					(curr == ' ' || curr == '\t') &&
					(next != '\n' && next != '\r') {
					curr = '\n'
				}
			}
		}

		if curr == '\n' {
			lineBegin = true
		}

		result.WriteRune(curr)
	}

	return result.Bytes()
}