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
|
package octoprintApis
import (
"errors"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"time"
"github.com/Z-Bolt/OctoScreen/logger"
// "github.com/Z-Bolt/OctoScreen/octoprintApis/dataModels"
)
// ErrUnauthorized missing or invalid API key
var ErrUnauthorized = errors.New("Missing or invalid API key")
// A Client manages communication with the OctoPrint API.
type Client struct {
// Endpoint address to the OctoPrint REST API server.
Endpoint string
// APIKey used to connect to the OctoPrint REST API server.
APIKey string
// HTTP client connection.
httpClient *http.Client
}
// NewClient returns a new OctoPrint API client with provided base URL and API
// Key. If baseURL does not have a trailing slash, one is added automatically. If
// `Access Control` is enabled at OctoPrint configuration an apiKey should be
// provided (http://docs.octoprint.org/en/master/api/general.html#authorization).
func NewClient(endpoint, apiKey string) *Client {
return &Client {
Endpoint: endpoint,
APIKey: apiKey,
httpClient: &http.Client {
Timeout: time.Second * 3,
Transport: &http.Transport {
DisableKeepAlives: true,
},
},
}
}
func (this *Client) doJsonRequest(
method string,
target string,
body io.Reader,
statusMapping StatusMapping,
isRequired bool,
) ([]byte, error) {
logger.TraceEnter("Client.doJsonRequest()")
bytes, err := this.doRequest(method, target, "application/json", body, statusMapping, isRequired)
if err != nil {
if isRequired {
// Some APIs return an error and the error should be logged.
logger.LogError("Client.doJsonRequest()", "this.doRequest()", err)
} else {
// On the other hand, calls to some APIs are optional, and the result should be logged
// as info and leave it up to the caller to determine whether it's an error or not.
logger.Infof("Client.doJsonRequest() - this.doRequest() returned %q", err)
}
logger.TraceLeave("Client.doJsonRequest()")
return nil, err
}
// Use the following only for debugging.
if logger.LogLevel() == "debug" {
json := string(bytes)
logger.Debugf("JSON response: %s", json)
}
logger.TraceLeave("Client.doJsonRequest()")
return bytes, err
}
func (this *Client) doRequest(
method string,
target string,
contentType string,
body io.Reader,
statusMapping StatusMapping,
isRequired bool,
) ([]byte, error) {
logger.TraceEnter("Client.doRequest()")
logger.Debugf("method: %s", method)
logger.Debugf("target: %s", target)
logger.Debugf("contentType: %s", contentType)
url := joinUrl(this.Endpoint, target)
logger.Debugf("url: %s", url)
req, err := http.NewRequest(method, url, body)
if err != nil {
logger.LogError("Client.doRequest()", "http.NewRequest()", err)
logger.TraceLeave("Client.doRequest()")
return nil, err
}
req.Header.Add("Host", "localhost:5000")
req.Header.Add("Accept", "*/*")
userAgent := fmt.Sprintf("go-octoprint/%s", Version)
logger.Debugf("userAgent: %s", userAgent)
req.Header.Add("User-Agent", userAgent)
if contentType != "" {
req.Header.Add("Content-Type", contentType)
}
// Don't log APIKey due to privacy & security.
// logger.Debugf("API key: %s", this.APIKey)
req.Header.Add("X-Api-Key", this.APIKey)
response, err := this.httpClient.Do(req)
if err != nil {
logger.LogError("Client.doRequest()", "this.httpClient.Do()", err)
logger.TraceLeave("Client.doRequest()")
return nil, err
} else {
logger.Debug("Client.doRequest() - httpClient.Do() passed")
}
bytes, err := this.handleResponse(response, statusMapping, isRequired)
if err != nil {
logOptionalError("Client.doRequest()", "this.handleResponse()", err, isRequired)
bytes = nil
} else {
logger.Debug("Client.doRequest() - handleResponse() passed")
}
logger.TraceLeave("Client.doRequest()")
return bytes, err
}
func (this *Client) handleResponse(
httpResponse *http.Response,
statusMapping StatusMapping,
isRequired bool,
) ([]byte, error) {
logger.TraceEnter("Client.handleResponse()")
defer httpResponse.Body.Close()
if statusMapping != nil {
if err := statusMapping.Error(httpResponse.StatusCode); err != nil {
logOptionalError("Client.handleResponse()", "statusMapping.Error()", err, isRequired)
logger.TraceLeave("Client.handleResponse()")
return nil, err
}
}
if httpResponse.StatusCode == 401 {
logOptionalMessage("Client.handleResponse() - StatusCode is 401", isRequired)
logger.TraceLeave("Client.handleResponse()")
return nil, ErrUnauthorized
}
if httpResponse.StatusCode == 204 {
logOptionalMessage("Client.handleResponse() - StatusCode is 204", isRequired)
logger.TraceLeave("Client.handleResponse()")
return nil, nil
}
body, err := ioutil.ReadAll(httpResponse.Body)
if err != nil {
logOptionalError("Client.handleResponse()", "ioutil.ReadAll()", err, isRequired)
logger.TraceLeave("Client.handleResponse()")
return nil, err
}
if httpResponse.StatusCode >= 200 && httpResponse.StatusCode <= 209 {
logger.Debugf("Client.handleResponse() - status code %d was within range", httpResponse.StatusCode)
} else {
errMsg := fmt.Sprintf("unexpected status code: %d", httpResponse.StatusCode)
logOptionalMessage(errMsg, isRequired)
err = fmt.Errorf(errMsg)
body = nil
}
logger.TraceLeave("Client.handleResponse()")
return body, err
}
func logOptionalError(
currentFunctionName string,
functionCalledName string,
err error,
isRequired bool,
) {
if isRequired {
// Some APIs return an error and the error should be logged.
logger.LogError(currentFunctionName, functionCalledName, err)
} else {
// On the other hand, calls to some APIs are optional, and the result should be logged
// as info and leave it up to the caller to determine whether it's an error or not.
msg := fmt.Sprintf("%s - %s returned %q", currentFunctionName, functionCalledName, err)
logger.Info(msg)
}
}
func logOptionalMessage(
msg string,
isRequired bool,
) {
if isRequired {
logger.Error(msg)
} else {
logger.Info(msg)
}
}
func joinUrl(base, uri string) string {
u, _ := url.Parse(uri)
b, _ := url.Parse(base)
return b.ResolveReference(u).String()
}
|
