/
util.go
401 lines (355 loc) · 10.2 KB
/
util.go
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
// Copyright 2021 iLogtail 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 util
import (
"bufio"
"bytes"
"crypto/rand"
"crypto/tls"
"crypto/x509"
"encoding/json"
"errors"
"fmt"
"hash/fnv"
"log"
"os"
"os/exec"
"path/filepath"
"reflect"
"strconv"
"strings"
"sync/atomic"
"time"
"unicode"
"unsafe"
"github.com/alibaba/ilogtail/pkg/protocol"
)
const alphanum string = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
const (
ShardHashTagKey = "__shardhash__"
PackIDTagKey = "__pack_id__"
)
var (
ErrCommandTimeout = errors.New("command time out")
ErrNotImplemented = errors.New("not implemented yet")
ErrInvalidEnvType = errors.New("invalid env type")
)
// ReadLines reads contents from a file and splits them by new lines.
// A convenience wrapper to ReadLinesOffsetN(filename, 0, -1).
func ReadLines(filename string) ([]string, error) {
return ReadLinesOffsetN(filename, 0, -1)
}
// ReadFirstBlock read first \S+ from head of line
func ReadFirstBlock(line string) string {
for i, c := range line {
// 32 -> [SPACE] 33 -> ! 126 -> ~ 127 -> [DEL]
if c < 33 || c > 126 {
return line[0:i]
}
}
return line
}
// ReadLinesOffsetN reads contents from file and splits them by new line.
// The offset tells at which line number to start.
// The count determines the number of lines to read (starting from offset):
// n >= 0: at most n lines
// n < 0: whole file
func ReadLinesOffsetN(filename string, offset uint, n int) ([]string, error) {
f, err := os.Open(filepath.Clean(filename))
if err != nil {
return []string{""}, err
}
defer func(f *os.File) {
_ = f.Close()
}(f)
var ret []string
r := bufio.NewReader(f)
for i := 0; i < n+int(offset) || n < 0; i++ {
line, err := r.ReadString('\n')
if err != nil {
break
}
if i < int(offset) {
continue
}
ret = append(ret, strings.Trim(line, "\n"))
}
return ret, nil
}
// RandomString returns a random string of alpha-numeric characters
func RandomString(n int) string {
var slice = make([]byte, n)
_, _ = rand.Read(slice)
for i, b := range slice {
slice[i] = alphanum[b%byte(len(alphanum))]
}
return string(slice)
}
// GetTLSConfig gets a tls.Config object from the given certs, key, and CA files.
// you must give the full path to the files.
// If all files are blank and InsecureSkipVerify=false, returns a nil pointer.
func GetTLSConfig(sslCert, sslKey, sslCA string, insecureSkipVerify bool) (*tls.Config, error) {
if sslCert == "" && sslKey == "" && sslCA == "" && !insecureSkipVerify {
return nil, nil
}
t := &tls.Config{InsecureSkipVerify: insecureSkipVerify} //nolint:gosec
if sslCA != "" {
caCert, err := os.ReadFile(filepath.Clean(sslCA))
if err != nil {
return nil, fmt.Errorf("Could not load TLS CA: %v", err)
}
caCertPool := x509.NewCertPool()
caCertPool.AppendCertsFromPEM(caCert)
t.RootCAs = caCertPool
}
if sslCert != "" && sslKey != "" {
cert, err := tls.LoadX509KeyPair(sslCert, sslKey)
if err != nil {
return nil, fmt.Errorf("could not load TLS client key/certificate from %s:%s: %s", sslKey, sslCert, err)
}
t.Certificates = []tls.Certificate{cert}
t.BuildNameToCertificate()
}
// will be nil by default if nothing is provided
return t, nil
}
// SnakeCase converts the given string to snake case following the Golang format:
// acronyms are converted to lower-case and preceded by an underscore.
func SnakeCase(in string) string {
runes := []rune(in)
length := len(runes)
var out []rune
for i := 0; i < length; i++ {
if i > 0 && unicode.IsUpper(runes[i]) && ((i+1 < length && unicode.IsLower(runes[i+1])) || unicode.IsLower(runes[i-1])) {
out = append(out, '_')
}
out = append(out, unicode.ToLower(runes[i]))
}
return string(out)
}
// CombinedOutputTimeout runs the given command with the given timeout and
// returns the combined output of stdout and stderr.
// If the command times out, it attempts to kill the process.
func CombinedOutputTimeout(c *exec.Cmd, timeout time.Duration) ([]byte, error) {
var b bytes.Buffer
c.Stdout = &b
c.Stderr = &b
if err := c.Start(); err != nil {
return nil, err
}
err := WaitTimeout(c, timeout)
return b.Bytes(), err
}
// RunTimeout runs the given command with the given timeout.
// If the command times out, it attempts to kill the process.
func RunTimeout(c *exec.Cmd, timeout time.Duration) error {
if err := c.Start(); err != nil {
return err
}
return WaitTimeout(c, timeout)
}
// WaitTimeout waits for the given command to finish with a timeout.
// It assumes the command has already been started.
// If the command times out, it attempts to kill the process.
func WaitTimeout(c *exec.Cmd, timeout time.Duration) error {
timer := time.NewTimer(timeout)
done := make(chan error)
go func() { done <- c.Wait() }()
select {
case err := <-done:
timer.Stop()
return err
case <-timer.C:
if err := c.Process.Kill(); err != nil {
log.Printf("E! FATAL error killing process: %s", err)
return err
}
// wait for the command to return after killing it
<-done
return ErrCommandTimeout
}
}
// return true if shutdown is signaled
func RandomSleep(base time.Duration, precisionLose float64, shutdown <-chan struct{}) bool {
// TODO: Last implementation costs too much CPU, find a better way to implement it.
return Sleep(base, shutdown)
}
// Sleep returns true if shutdown is signaled.
func Sleep(interval time.Duration, shutdown <-chan struct{}) bool {
select {
case <-time.After(interval):
return false
case <-shutdown:
return true
}
}
func CutString(val string, maxLen int) string {
if len(val) < maxLen {
return val
}
return val[0:maxLen]
}
func GetCurrentBinaryPath() string {
ex, err := os.Executable()
if err != nil {
return "./"
}
exPath := filepath.Dir(ex)
return exPath + "/"
}
func PathExists(path string) (bool, error) {
_, err := os.Stat(path)
if err == nil {
return true, nil
}
if os.IsNotExist(err) {
return false, nil
}
return false, err
}
func SplitPath(path string) (dir string, filename string) {
lastIndex := strings.LastIndexByte(path, '/')
lastIndex2 := strings.LastIndexByte(path, '\\')
if lastIndex < 0 && lastIndex2 < 0 {
return "", ""
}
index := 0
if lastIndex > lastIndex2 {
index = lastIndex
} else {
index = lastIndex2
}
return path[0:index], path[index+1:]
}
func InitFromEnvBool(key string, value *bool, defaultValue bool) error {
if envValue := os.Getenv(key); len(envValue) > 0 {
lowErVal := strings.ToLower(envValue)
if strings.HasPrefix(lowErVal, "y") || strings.HasPrefix(lowErVal, "t") || strings.HasPrefix(lowErVal, "on") || strings.HasPrefix(lowErVal, "ok") {
*value = true
} else {
*value = false
}
return nil
}
*value = defaultValue
return nil
}
func InitFromEnvInt(key string, value *int, defaultValue int) error {
if envValue := os.Getenv(key); len(envValue) > 0 {
if val, err := strconv.Atoi(envValue); err == nil {
*value = val
return nil
}
*value = defaultValue
return ErrInvalidEnvType
}
*value = defaultValue
return nil
}
func InitFromEnvString(key string, value *string, defaultValue string) error {
if envValue := os.Getenv(key); len(envValue) > 0 {
*value = envValue
return nil
}
*value = defaultValue
return nil
}
// GuessRegionByEndpoint guess region
// cn-hangzhou.log.aliyuncs.com cn-hangzhou-intranet.log.aliyuncs.com cn-hangzhou-vpc.log.aliyuncs.com cn-hangzhou-share.log.aliyuncs.com
func GuessRegionByEndpoint(endPoint, defaultRegion string) string {
if strings.HasPrefix(endPoint, "http://") {
endPoint = endPoint[len("http://"):]
} else {
endPoint = strings.TrimPrefix(endPoint, "https://")
}
if dotIndex := strings.IndexByte(endPoint, '.'); dotIndex > 0 {
region := endPoint[0:dotIndex]
if strings.HasSuffix(region, "-intranet") || strings.HasSuffix(region, "-vpc") || strings.HasSuffix(region, "-share") {
region = region[0:strings.LastIndexByte(region, '-')]
}
return region
}
return defaultRegion
}
func DeepCopy(src *map[string]interface{}) *map[string]interface{} {
if src == nil {
return nil
}
var buf []byte
var err error
if buf, err = json.Marshal(src); err != nil {
return nil
}
dst := new(map[string]interface{})
if err := json.Unmarshal(buf, dst); err != nil {
return nil
}
return dst
}
func InterfaceToString(val interface{}) (string, bool) {
if val == nil {
return "", false
}
strVal, ok := val.(string)
return strVal, ok
}
func InterfaceToJSONString(val interface{}) (string, error) {
b, err := json.Marshal(val)
return string(b), err
}
func NewPackIDPrefix(text string) string {
h := fnv.New64a()
_, _ = h.Write([]byte(text + GetIPAddress() + time.Now().String()))
return fmt.Sprintf("%X-", h.Sum64())
}
func NewLogTagForPackID(prefix string, seqNum *int64) *protocol.LogTag {
tag := &protocol.LogTag{
Key: PackIDTagKey,
Value: fmt.Sprintf("%s%X", prefix, atomic.LoadInt64(seqNum)),
}
atomic.AddInt64(seqNum, 1)
return tag
}
func MinInt(a, b int) int {
if a < b {
return a
}
return b
}
// StringDeepCopy returns a deep copy or src.
// Because we can not make sure the life cycle of string passed from C++,
// so we have to make a deep copy of them so that they are always valid in Go.
func StringDeepCopy(src string) string {
return string([]byte(src))
}
// StringPointer returns the pointer of the given string.
// nolint:gosec
func StringPointer(s string) unsafe.Pointer {
p := (*reflect.StringHeader)(unsafe.Pointer(&s))
return unsafe.Pointer(p.Data)
}
// UniqueStrings Merge (append) slices and remove duplicate from them!
func UniqueStrings(strSlices ...[]string) []string {
uniqueMap := map[string]bool{}
for _, strSlice := range strSlices {
for _, number := range strSlice {
uniqueMap[number] = true
}
}
result := make([]string, 0, len(uniqueMap))
for key := range uniqueMap {
result = append(result, key)
}
return result
}