-
Notifications
You must be signed in to change notification settings - Fork 339
/
torequtil.go
174 lines (155 loc) · 5 KB
/
torequtil.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
// torequtil has utility functions used by toreq and toreqnew
// which don't require the Traffic Ops client, and thus can be shared.
package torequtil
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import (
"encoding/json"
"errors"
"io/ioutil"
"math"
"net"
"net/http"
"path/filepath"
"strings"
"time"
"github.com/apache/trafficcontrol/lib/go-log"
"github.com/apache/trafficcontrol/lib/go-tc"
)
const CookieCacheDir = `/var/lib/trafficcontrol-cache-config/`
func CookieCacheFileName(userName string) string {
return userName + ".cookie"
}
func CookieCachePath(userName string) string {
return filepath.Join(CookieCacheDir, CookieCacheFileName(userName))
}
type Cookie struct {
Cookie *http.Cookie `json:"cookie"`
}
type FsCookie struct {
Cookies []Cookie `json:"cookies"`
}
func (fc *FsCookie) GetHTTPCookies() []*http.Cookie {
cookies := []*http.Cookie{}
for _, cookie := range fc.Cookies {
cookies = append(cookies, cookie.Cookie)
}
return cookies
}
// GetRetry attempts to get the given object, retrying with exponential backoff up to cfg.NumRetries.
// The objName is not used in actual fetching or logic, but only for logging. It can be any printable string, but should be unique and reflect the object being fetched.
func GetRetry(numRetries int, objName string, obj interface{}, getter func(obj interface{}) error) error {
start := time.Now()
currentRetry := 0
for {
err := getter(obj)
if err == nil {
break
}
if strings.Contains(strings.ToLower(err.Error()), "not found") {
// if the server returned a 404, retrying won't help
return errors.New("getting uncached: " + err.Error())
}
if currentRetry == numRetries {
return errors.New("getting uncached: " + err.Error())
}
sleepSeconds := RetryBackoffSeconds(currentRetry)
log.Warnf("getting '%v', sleeping for %v seconds: %v\n", objName, sleepSeconds, err)
currentRetry++
time.Sleep(time.Second * time.Duration(sleepSeconds)) // TODO make backoff configurable?
}
log.Infof("GetRetry %v retries %v took %v\n", objName, currentRetry, time.Since(start).Round(time.Millisecond))
return nil
}
func RetryBackoffSeconds(currentRetry int) int {
// TODO make configurable?
return int(math.Pow(2.0, float64(currentRetry)))
}
// MaybeIPStr returns the addr string if it isn't nil, or the empty string if it is.
// This is intended for logging, to allow logging with one line, whether addr is nil or not.
func MaybeIPStr(addr net.Addr) string {
if addr != nil {
return addr.String()
}
return ""
}
// MaybeHdrStr returns the header text if hdr isn't nil, or the empty string if it is.
// This is intended for logging, to allow logging with one line, whether a header object is nil or not.
//
// The hdrName must be the canonically-capitalized header name.
//
func MaybeHdrStr(hdr http.Header, hdrName string) string {
if hdr != nil {
return hdr.Get(hdrName)
}
return ""
}
func GetFsCookie(cookiePath string) (FsCookie, error) {
cookie := FsCookie{}
file, err := ioutil.ReadFile(cookiePath)
if err != nil {
return FsCookie{Cookies: nil}, err
}
err = json.Unmarshal(file, &cookie)
if err != nil {
return FsCookie{Cookies: nil}, err
}
for _, c := range cookie.Cookies {
if len(c.Cookie.String()) == 0 {
return FsCookie{Cookies: nil}, errors.New("file system cookie was empty")
}
}
return cookie, err
}
func StringToCookies(cookiesStr string) []*http.Cookie {
hdr := http.Header{}
hdr.Add("Cookie", cookiesStr)
req := http.Request{Header: hdr}
return req.Cookies()
}
func CookiesToString(cookies []*http.Cookie) string {
strs := []string{}
for _, cookie := range cookies {
strs = append(strs, cookie.String())
}
return strings.Join(strs, "; ")
}
func GetTOToolNameAndURL(globalParams []tc.Parameter) (string, string) {
// TODO move somewhere generic
toToolName := ""
toURL := ""
for _, param := range globalParams {
if param.Name == "tm.toolname" {
toToolName = param.Value
} else if param.Name == "tm.url" {
toURL = param.Value
}
if toToolName != "" && toURL != "" {
break
}
}
// TODO error here? Perl doesn't.
if toToolName == "" {
log.Warnln("Global Parameter tm.toolname not found, config may not be constructed properly!")
}
if toURL == "" {
log.Warnln("Global Parameter tm.url not found, config may not be constructed properly!")
}
return toToolName, toURL
}