client.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804
  1. // Copyright 2015 The etcd Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package v2http
  15. import (
  16. "encoding/json"
  17. "errors"
  18. "expvar"
  19. "fmt"
  20. "io/ioutil"
  21. "net/http"
  22. "net/url"
  23. "path"
  24. "strconv"
  25. "strings"
  26. "time"
  27. etcdErr "github.com/coreos/etcd/error"
  28. "github.com/coreos/etcd/etcdserver"
  29. "github.com/coreos/etcd/etcdserver/api"
  30. "github.com/coreos/etcd/etcdserver/api/v2http/httptypes"
  31. "github.com/coreos/etcd/etcdserver/auth"
  32. "github.com/coreos/etcd/etcdserver/etcdserverpb"
  33. "github.com/coreos/etcd/etcdserver/membership"
  34. "github.com/coreos/etcd/etcdserver/stats"
  35. "github.com/coreos/etcd/pkg/types"
  36. "github.com/coreos/etcd/raft"
  37. "github.com/coreos/etcd/store"
  38. "github.com/coreos/etcd/version"
  39. "github.com/coreos/pkg/capnslog"
  40. "github.com/jonboulle/clockwork"
  41. "github.com/prometheus/client_golang/prometheus"
  42. "golang.org/x/net/context"
  43. )
  44. const (
  45. authPrefix = "/v2/auth"
  46. keysPrefix = "/v2/keys"
  47. membersPrefix = "/v2/members"
  48. statsPrefix = "/v2/stats"
  49. varsPath = "/debug/vars"
  50. metricsPath = "/metrics"
  51. healthPath = "/health"
  52. versionPath = "/version"
  53. configPath = "/config"
  54. )
  55. // NewClientHandler generates a muxed http.Handler with the given parameters to serve etcd client requests.
  56. func NewClientHandler(server *etcdserver.EtcdServer, timeout time.Duration) http.Handler {
  57. sec := auth.NewStore(server, timeout)
  58. kh := &keysHandler{
  59. sec: sec,
  60. server: server,
  61. cluster: server.Cluster(),
  62. timer: server,
  63. timeout: timeout,
  64. clientCertAuthEnabled: server.Cfg.ClientCertAuthEnabled,
  65. }
  66. sh := &statsHandler{
  67. stats: server,
  68. }
  69. mh := &membersHandler{
  70. sec: sec,
  71. server: server,
  72. cluster: server.Cluster(),
  73. timeout: timeout,
  74. clock: clockwork.NewRealClock(),
  75. clientCertAuthEnabled: server.Cfg.ClientCertAuthEnabled,
  76. }
  77. sech := &authHandler{
  78. sec: sec,
  79. cluster: server.Cluster(),
  80. clientCertAuthEnabled: server.Cfg.ClientCertAuthEnabled,
  81. }
  82. mux := http.NewServeMux()
  83. mux.HandleFunc("/", http.NotFound)
  84. mux.Handle(healthPath, healthHandler(server))
  85. mux.HandleFunc(versionPath, versionHandler(server.Cluster(), serveVersion))
  86. mux.Handle(keysPrefix, kh)
  87. mux.Handle(keysPrefix+"/", kh)
  88. mux.HandleFunc(statsPrefix+"/store", sh.serveStore)
  89. mux.HandleFunc(statsPrefix+"/self", sh.serveSelf)
  90. mux.HandleFunc(statsPrefix+"/leader", sh.serveLeader)
  91. mux.HandleFunc(varsPath, serveVars)
  92. mux.HandleFunc(configPath+"/local/log", logHandleFunc)
  93. mux.Handle(metricsPath, prometheus.Handler())
  94. mux.Handle(membersPrefix, mh)
  95. mux.Handle(membersPrefix+"/", mh)
  96. handleAuth(mux, sech)
  97. return requestLogger(mux)
  98. }
  99. type keysHandler struct {
  100. sec auth.Store
  101. server etcdserver.Server
  102. cluster api.Cluster
  103. timer etcdserver.RaftTimer
  104. timeout time.Duration
  105. clientCertAuthEnabled bool
  106. }
  107. func (h *keysHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  108. if !allowMethod(w, r.Method, "HEAD", "GET", "PUT", "POST", "DELETE") {
  109. return
  110. }
  111. w.Header().Set("X-Etcd-Cluster-ID", h.cluster.ID().String())
  112. ctx, cancel := context.WithTimeout(context.Background(), h.timeout)
  113. defer cancel()
  114. clock := clockwork.NewRealClock()
  115. startTime := clock.Now()
  116. rr, noValueOnSuccess, err := parseKeyRequest(r, clock)
  117. if err != nil {
  118. writeKeyError(w, err)
  119. return
  120. }
  121. // The path must be valid at this point (we've parsed the request successfully).
  122. if !hasKeyPrefixAccess(h.sec, r, r.URL.Path[len(keysPrefix):], rr.Recursive, h.clientCertAuthEnabled) {
  123. writeKeyNoAuth(w)
  124. return
  125. }
  126. if !rr.Wait {
  127. reportRequestReceived(rr)
  128. }
  129. resp, err := h.server.Do(ctx, rr)
  130. if err != nil {
  131. err = trimErrorPrefix(err, etcdserver.StoreKeysPrefix)
  132. writeKeyError(w, err)
  133. reportRequestFailed(rr, err)
  134. return
  135. }
  136. switch {
  137. case resp.Event != nil:
  138. if err := writeKeyEvent(w, resp.Event, noValueOnSuccess, h.timer); err != nil {
  139. // Should never be reached
  140. plog.Errorf("error writing event (%v)", err)
  141. }
  142. reportRequestCompleted(rr, resp, startTime)
  143. case resp.Watcher != nil:
  144. ctx, cancel := context.WithTimeout(context.Background(), defaultWatchTimeout)
  145. defer cancel()
  146. handleKeyWatch(ctx, w, resp.Watcher, rr.Stream, h.timer)
  147. default:
  148. writeKeyError(w, errors.New("received response with no Event/Watcher!"))
  149. }
  150. }
  151. type membersHandler struct {
  152. sec auth.Store
  153. server etcdserver.Server
  154. cluster api.Cluster
  155. timeout time.Duration
  156. clock clockwork.Clock
  157. clientCertAuthEnabled bool
  158. }
  159. func (h *membersHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
  160. if !allowMethod(w, r.Method, "GET", "POST", "DELETE", "PUT") {
  161. return
  162. }
  163. if !hasWriteRootAccess(h.sec, r, h.clientCertAuthEnabled) {
  164. writeNoAuth(w, r)
  165. return
  166. }
  167. w.Header().Set("X-Etcd-Cluster-ID", h.cluster.ID().String())
  168. ctx, cancel := context.WithTimeout(context.Background(), h.timeout)
  169. defer cancel()
  170. switch r.Method {
  171. case "GET":
  172. switch trimPrefix(r.URL.Path, membersPrefix) {
  173. case "":
  174. mc := newMemberCollection(h.cluster.Members())
  175. w.Header().Set("Content-Type", "application/json")
  176. if err := json.NewEncoder(w).Encode(mc); err != nil {
  177. plog.Warningf("failed to encode members response (%v)", err)
  178. }
  179. case "leader":
  180. id := h.server.Leader()
  181. if id == 0 {
  182. writeError(w, r, httptypes.NewHTTPError(http.StatusServiceUnavailable, "During election"))
  183. return
  184. }
  185. m := newMember(h.cluster.Member(id))
  186. w.Header().Set("Content-Type", "application/json")
  187. if err := json.NewEncoder(w).Encode(m); err != nil {
  188. plog.Warningf("failed to encode members response (%v)", err)
  189. }
  190. default:
  191. writeError(w, r, httptypes.NewHTTPError(http.StatusNotFound, "Not found"))
  192. }
  193. case "POST":
  194. req := httptypes.MemberCreateRequest{}
  195. if ok := unmarshalRequest(r, &req, w); !ok {
  196. return
  197. }
  198. now := h.clock.Now()
  199. m := membership.NewMember("", req.PeerURLs, "", &now)
  200. _, err := h.server.AddMember(ctx, *m)
  201. switch {
  202. case err == membership.ErrIDExists || err == membership.ErrPeerURLexists:
  203. writeError(w, r, httptypes.NewHTTPError(http.StatusConflict, err.Error()))
  204. return
  205. case err != nil:
  206. plog.Errorf("error adding member %s (%v)", m.ID, err)
  207. writeError(w, r, err)
  208. return
  209. }
  210. res := newMember(m)
  211. w.Header().Set("Content-Type", "application/json")
  212. w.WriteHeader(http.StatusCreated)
  213. if err := json.NewEncoder(w).Encode(res); err != nil {
  214. plog.Warningf("failed to encode members response (%v)", err)
  215. }
  216. case "DELETE":
  217. id, ok := getID(r.URL.Path, w)
  218. if !ok {
  219. return
  220. }
  221. _, err := h.server.RemoveMember(ctx, uint64(id))
  222. switch {
  223. case err == membership.ErrIDRemoved:
  224. writeError(w, r, httptypes.NewHTTPError(http.StatusGone, fmt.Sprintf("Member permanently removed: %s", id)))
  225. case err == membership.ErrIDNotFound:
  226. writeError(w, r, httptypes.NewHTTPError(http.StatusNotFound, fmt.Sprintf("No such member: %s", id)))
  227. case err != nil:
  228. plog.Errorf("error removing member %s (%v)", id, err)
  229. writeError(w, r, err)
  230. default:
  231. w.WriteHeader(http.StatusNoContent)
  232. }
  233. case "PUT":
  234. id, ok := getID(r.URL.Path, w)
  235. if !ok {
  236. return
  237. }
  238. req := httptypes.MemberUpdateRequest{}
  239. if ok := unmarshalRequest(r, &req, w); !ok {
  240. return
  241. }
  242. m := membership.Member{
  243. ID: id,
  244. RaftAttributes: membership.RaftAttributes{PeerURLs: req.PeerURLs.StringSlice()},
  245. }
  246. _, err := h.server.UpdateMember(ctx, m)
  247. switch {
  248. case err == membership.ErrPeerURLexists:
  249. writeError(w, r, httptypes.NewHTTPError(http.StatusConflict, err.Error()))
  250. case err == membership.ErrIDNotFound:
  251. writeError(w, r, httptypes.NewHTTPError(http.StatusNotFound, fmt.Sprintf("No such member: %s", id)))
  252. case err != nil:
  253. plog.Errorf("error updating member %s (%v)", m.ID, err)
  254. writeError(w, r, err)
  255. default:
  256. w.WriteHeader(http.StatusNoContent)
  257. }
  258. }
  259. }
  260. type statsHandler struct {
  261. stats stats.Stats
  262. }
  263. func (h *statsHandler) serveStore(w http.ResponseWriter, r *http.Request) {
  264. if !allowMethod(w, r.Method, "GET") {
  265. return
  266. }
  267. w.Header().Set("Content-Type", "application/json")
  268. w.Write(h.stats.StoreStats())
  269. }
  270. func (h *statsHandler) serveSelf(w http.ResponseWriter, r *http.Request) {
  271. if !allowMethod(w, r.Method, "GET") {
  272. return
  273. }
  274. w.Header().Set("Content-Type", "application/json")
  275. w.Write(h.stats.SelfStats())
  276. }
  277. func (h *statsHandler) serveLeader(w http.ResponseWriter, r *http.Request) {
  278. if !allowMethod(w, r.Method, "GET") {
  279. return
  280. }
  281. stats := h.stats.LeaderStats()
  282. if stats == nil {
  283. writeError(w, r, httptypes.NewHTTPError(http.StatusForbidden, "not current leader"))
  284. return
  285. }
  286. w.Header().Set("Content-Type", "application/json")
  287. w.Write(stats)
  288. }
  289. func serveVars(w http.ResponseWriter, r *http.Request) {
  290. if !allowMethod(w, r.Method, "GET") {
  291. return
  292. }
  293. w.Header().Set("Content-Type", "application/json; charset=utf-8")
  294. fmt.Fprintf(w, "{\n")
  295. first := true
  296. expvar.Do(func(kv expvar.KeyValue) {
  297. if !first {
  298. fmt.Fprintf(w, ",\n")
  299. }
  300. first = false
  301. fmt.Fprintf(w, "%q: %s", kv.Key, kv.Value)
  302. })
  303. fmt.Fprintf(w, "\n}\n")
  304. }
  305. func healthHandler(server *etcdserver.EtcdServer) http.HandlerFunc {
  306. return func(w http.ResponseWriter, r *http.Request) {
  307. if !allowMethod(w, r.Method, "GET") {
  308. return
  309. }
  310. if uint64(server.Leader()) == raft.None {
  311. http.Error(w, `{"health": "false"}`, http.StatusServiceUnavailable)
  312. return
  313. }
  314. ctx, cancel := context.WithTimeout(context.Background(), time.Second)
  315. defer cancel()
  316. if _, err := server.Do(ctx, etcdserverpb.Request{Method: "QGET"}); err != nil {
  317. http.Error(w, `{"health": "false"}`, http.StatusServiceUnavailable)
  318. return
  319. }
  320. w.WriteHeader(http.StatusOK)
  321. w.Write([]byte(`{"health": "true"}`))
  322. }
  323. }
  324. func versionHandler(c api.Cluster, fn func(http.ResponseWriter, *http.Request, string)) http.HandlerFunc {
  325. return func(w http.ResponseWriter, r *http.Request) {
  326. v := c.Version()
  327. if v != nil {
  328. fn(w, r, v.String())
  329. } else {
  330. fn(w, r, "not_decided")
  331. }
  332. }
  333. }
  334. func serveVersion(w http.ResponseWriter, r *http.Request, clusterV string) {
  335. if !allowMethod(w, r.Method, "GET") {
  336. return
  337. }
  338. vs := version.Versions{
  339. Server: version.Version,
  340. Cluster: clusterV,
  341. }
  342. w.Header().Set("Content-Type", "application/json")
  343. b, err := json.Marshal(&vs)
  344. if err != nil {
  345. plog.Panicf("cannot marshal versions to json (%v)", err)
  346. }
  347. w.Write(b)
  348. }
  349. func logHandleFunc(w http.ResponseWriter, r *http.Request) {
  350. if !allowMethod(w, r.Method, "PUT") {
  351. return
  352. }
  353. in := struct{ Level string }{}
  354. d := json.NewDecoder(r.Body)
  355. if err := d.Decode(&in); err != nil {
  356. writeError(w, r, httptypes.NewHTTPError(http.StatusBadRequest, "Invalid json body"))
  357. return
  358. }
  359. logl, err := capnslog.ParseLevel(strings.ToUpper(in.Level))
  360. if err != nil {
  361. writeError(w, r, httptypes.NewHTTPError(http.StatusBadRequest, "Invalid log level "+in.Level))
  362. return
  363. }
  364. plog.Noticef("globalLogLevel set to %q", logl.String())
  365. capnslog.SetGlobalLogLevel(logl)
  366. w.WriteHeader(http.StatusNoContent)
  367. }
  368. // parseKeyRequest converts a received http.Request on keysPrefix to
  369. // a server Request, performing validation of supplied fields as appropriate.
  370. // If any validation fails, an empty Request and non-nil error is returned.
  371. func parseKeyRequest(r *http.Request, clock clockwork.Clock) (etcdserverpb.Request, bool, error) {
  372. noValueOnSuccess := false
  373. emptyReq := etcdserverpb.Request{}
  374. err := r.ParseForm()
  375. if err != nil {
  376. return emptyReq, false, etcdErr.NewRequestError(
  377. etcdErr.EcodeInvalidForm,
  378. err.Error(),
  379. )
  380. }
  381. if !strings.HasPrefix(r.URL.Path, keysPrefix) {
  382. return emptyReq, false, etcdErr.NewRequestError(
  383. etcdErr.EcodeInvalidForm,
  384. "incorrect key prefix",
  385. )
  386. }
  387. p := path.Join(etcdserver.StoreKeysPrefix, r.URL.Path[len(keysPrefix):])
  388. var pIdx, wIdx uint64
  389. if pIdx, err = getUint64(r.Form, "prevIndex"); err != nil {
  390. return emptyReq, false, etcdErr.NewRequestError(
  391. etcdErr.EcodeIndexNaN,
  392. `invalid value for "prevIndex"`,
  393. )
  394. }
  395. if wIdx, err = getUint64(r.Form, "waitIndex"); err != nil {
  396. return emptyReq, false, etcdErr.NewRequestError(
  397. etcdErr.EcodeIndexNaN,
  398. `invalid value for "waitIndex"`,
  399. )
  400. }
  401. var rec, sort, wait, dir, quorum, stream bool
  402. if rec, err = getBool(r.Form, "recursive"); err != nil {
  403. return emptyReq, false, etcdErr.NewRequestError(
  404. etcdErr.EcodeInvalidField,
  405. `invalid value for "recursive"`,
  406. )
  407. }
  408. if sort, err = getBool(r.Form, "sorted"); err != nil {
  409. return emptyReq, false, etcdErr.NewRequestError(
  410. etcdErr.EcodeInvalidField,
  411. `invalid value for "sorted"`,
  412. )
  413. }
  414. if wait, err = getBool(r.Form, "wait"); err != nil {
  415. return emptyReq, false, etcdErr.NewRequestError(
  416. etcdErr.EcodeInvalidField,
  417. `invalid value for "wait"`,
  418. )
  419. }
  420. // TODO(jonboulle): define what parameters dir is/isn't compatible with?
  421. if dir, err = getBool(r.Form, "dir"); err != nil {
  422. return emptyReq, false, etcdErr.NewRequestError(
  423. etcdErr.EcodeInvalidField,
  424. `invalid value for "dir"`,
  425. )
  426. }
  427. if quorum, err = getBool(r.Form, "quorum"); err != nil {
  428. return emptyReq, false, etcdErr.NewRequestError(
  429. etcdErr.EcodeInvalidField,
  430. `invalid value for "quorum"`,
  431. )
  432. }
  433. if stream, err = getBool(r.Form, "stream"); err != nil {
  434. return emptyReq, false, etcdErr.NewRequestError(
  435. etcdErr.EcodeInvalidField,
  436. `invalid value for "stream"`,
  437. )
  438. }
  439. if wait && r.Method != "GET" {
  440. return emptyReq, false, etcdErr.NewRequestError(
  441. etcdErr.EcodeInvalidField,
  442. `"wait" can only be used with GET requests`,
  443. )
  444. }
  445. pV := r.FormValue("prevValue")
  446. if _, ok := r.Form["prevValue"]; ok && pV == "" {
  447. return emptyReq, false, etcdErr.NewRequestError(
  448. etcdErr.EcodePrevValueRequired,
  449. `"prevValue" cannot be empty`,
  450. )
  451. }
  452. if noValueOnSuccess, err = getBool(r.Form, "noValueOnSuccess"); err != nil {
  453. return emptyReq, false, etcdErr.NewRequestError(
  454. etcdErr.EcodeInvalidField,
  455. `invalid value for "noValueOnSuccess"`,
  456. )
  457. }
  458. // TTL is nullable, so leave it null if not specified
  459. // or an empty string
  460. var ttl *uint64
  461. if len(r.FormValue("ttl")) > 0 {
  462. i, err := getUint64(r.Form, "ttl")
  463. if err != nil {
  464. return emptyReq, false, etcdErr.NewRequestError(
  465. etcdErr.EcodeTTLNaN,
  466. `invalid value for "ttl"`,
  467. )
  468. }
  469. ttl = &i
  470. }
  471. // prevExist is nullable, so leave it null if not specified
  472. var pe *bool
  473. if _, ok := r.Form["prevExist"]; ok {
  474. bv, err := getBool(r.Form, "prevExist")
  475. if err != nil {
  476. return emptyReq, false, etcdErr.NewRequestError(
  477. etcdErr.EcodeInvalidField,
  478. "invalid value for prevExist",
  479. )
  480. }
  481. pe = &bv
  482. }
  483. // refresh is nullable, so leave it null if not specified
  484. var refresh *bool
  485. if _, ok := r.Form["refresh"]; ok {
  486. bv, err := getBool(r.Form, "refresh")
  487. if err != nil {
  488. return emptyReq, false, etcdErr.NewRequestError(
  489. etcdErr.EcodeInvalidField,
  490. "invalid value for refresh",
  491. )
  492. }
  493. refresh = &bv
  494. if refresh != nil && *refresh {
  495. val := r.FormValue("value")
  496. if _, ok := r.Form["value"]; ok && val != "" {
  497. return emptyReq, false, etcdErr.NewRequestError(
  498. etcdErr.EcodeRefreshValue,
  499. `A value was provided on a refresh`,
  500. )
  501. }
  502. if ttl == nil {
  503. return emptyReq, false, etcdErr.NewRequestError(
  504. etcdErr.EcodeRefreshTTLRequired,
  505. `No TTL value set`,
  506. )
  507. }
  508. }
  509. }
  510. rr := etcdserverpb.Request{
  511. Method: r.Method,
  512. Path: p,
  513. Val: r.FormValue("value"),
  514. Dir: dir,
  515. PrevValue: pV,
  516. PrevIndex: pIdx,
  517. PrevExist: pe,
  518. Wait: wait,
  519. Since: wIdx,
  520. Recursive: rec,
  521. Sorted: sort,
  522. Quorum: quorum,
  523. Stream: stream,
  524. }
  525. if pe != nil {
  526. rr.PrevExist = pe
  527. }
  528. if refresh != nil {
  529. rr.Refresh = refresh
  530. }
  531. // Null TTL is equivalent to unset Expiration
  532. if ttl != nil {
  533. expr := time.Duration(*ttl) * time.Second
  534. rr.Expiration = clock.Now().Add(expr).UnixNano()
  535. }
  536. return rr, noValueOnSuccess, nil
  537. }
  538. // writeKeyEvent trims the prefix of key path in a single Event under
  539. // StoreKeysPrefix, serializes it and writes the resulting JSON to the given
  540. // ResponseWriter, along with the appropriate headers.
  541. func writeKeyEvent(w http.ResponseWriter, ev *store.Event, noValueOnSuccess bool, rt etcdserver.RaftTimer) error {
  542. if ev == nil {
  543. return errors.New("cannot write empty Event!")
  544. }
  545. w.Header().Set("Content-Type", "application/json")
  546. w.Header().Set("X-Etcd-Index", fmt.Sprint(ev.EtcdIndex))
  547. w.Header().Set("X-Raft-Index", fmt.Sprint(rt.Index()))
  548. w.Header().Set("X-Raft-Term", fmt.Sprint(rt.Term()))
  549. if ev.IsCreated() {
  550. w.WriteHeader(http.StatusCreated)
  551. }
  552. ev = trimEventPrefix(ev, etcdserver.StoreKeysPrefix)
  553. if noValueOnSuccess &&
  554. (ev.Action == store.Set || ev.Action == store.CompareAndSwap ||
  555. ev.Action == store.Create || ev.Action == store.Update) {
  556. ev.Node = nil
  557. ev.PrevNode = nil
  558. }
  559. return json.NewEncoder(w).Encode(ev)
  560. }
  561. func writeKeyNoAuth(w http.ResponseWriter) {
  562. e := etcdErr.NewError(etcdErr.EcodeUnauthorized, "Insufficient credentials", 0)
  563. e.WriteTo(w)
  564. }
  565. // writeKeyError logs and writes the given Error to the ResponseWriter.
  566. // If Error is not an etcdErr, the error will be converted to an etcd error.
  567. func writeKeyError(w http.ResponseWriter, err error) {
  568. if err == nil {
  569. return
  570. }
  571. switch e := err.(type) {
  572. case *etcdErr.Error:
  573. e.WriteTo(w)
  574. default:
  575. switch err {
  576. case etcdserver.ErrTimeoutDueToLeaderFail, etcdserver.ErrTimeoutDueToConnectionLost:
  577. mlog.MergeError(err)
  578. default:
  579. mlog.MergeErrorf("got unexpected response error (%v)", err)
  580. }
  581. ee := etcdErr.NewError(etcdErr.EcodeRaftInternal, err.Error(), 0)
  582. ee.WriteTo(w)
  583. }
  584. }
  585. func handleKeyWatch(ctx context.Context, w http.ResponseWriter, wa store.Watcher, stream bool, rt etcdserver.RaftTimer) {
  586. defer wa.Remove()
  587. ech := wa.EventChan()
  588. var nch <-chan bool
  589. if x, ok := w.(http.CloseNotifier); ok {
  590. nch = x.CloseNotify()
  591. }
  592. w.Header().Set("Content-Type", "application/json")
  593. w.Header().Set("X-Etcd-Index", fmt.Sprint(wa.StartIndex()))
  594. w.Header().Set("X-Raft-Index", fmt.Sprint(rt.Index()))
  595. w.Header().Set("X-Raft-Term", fmt.Sprint(rt.Term()))
  596. w.WriteHeader(http.StatusOK)
  597. // Ensure headers are flushed early, in case of long polling
  598. w.(http.Flusher).Flush()
  599. for {
  600. select {
  601. case <-nch:
  602. // Client closed connection. Nothing to do.
  603. return
  604. case <-ctx.Done():
  605. // Timed out. net/http will close the connection for us, so nothing to do.
  606. return
  607. case ev, ok := <-ech:
  608. if !ok {
  609. // If the channel is closed this may be an indication of
  610. // that notifications are much more than we are able to
  611. // send to the client in time. Then we simply end streaming.
  612. return
  613. }
  614. ev = trimEventPrefix(ev, etcdserver.StoreKeysPrefix)
  615. if err := json.NewEncoder(w).Encode(ev); err != nil {
  616. // Should never be reached
  617. plog.Warningf("error writing event (%v)", err)
  618. return
  619. }
  620. if !stream {
  621. return
  622. }
  623. w.(http.Flusher).Flush()
  624. }
  625. }
  626. }
  627. func trimEventPrefix(ev *store.Event, prefix string) *store.Event {
  628. if ev == nil {
  629. return nil
  630. }
  631. // Since the *Event may reference one in the store history
  632. // history, we must copy it before modifying
  633. e := ev.Clone()
  634. trimNodeExternPrefix(e.Node, prefix)
  635. trimNodeExternPrefix(e.PrevNode, prefix)
  636. return e
  637. }
  638. func trimNodeExternPrefix(n *store.NodeExtern, prefix string) {
  639. if n == nil {
  640. return
  641. }
  642. n.Key = strings.TrimPrefix(n.Key, prefix)
  643. for _, nn := range n.Nodes {
  644. trimNodeExternPrefix(nn, prefix)
  645. }
  646. }
  647. func trimErrorPrefix(err error, prefix string) error {
  648. if e, ok := err.(*etcdErr.Error); ok {
  649. e.Cause = strings.TrimPrefix(e.Cause, prefix)
  650. }
  651. return err
  652. }
  653. func unmarshalRequest(r *http.Request, req json.Unmarshaler, w http.ResponseWriter) bool {
  654. ctype := r.Header.Get("Content-Type")
  655. semicolonPosition := strings.Index(ctype, ";")
  656. if semicolonPosition != -1 {
  657. ctype = strings.TrimSpace(strings.ToLower(ctype[0:semicolonPosition]))
  658. }
  659. if ctype != "application/json" {
  660. writeError(w, r, httptypes.NewHTTPError(http.StatusUnsupportedMediaType, fmt.Sprintf("Bad Content-Type %s, accept application/json", ctype)))
  661. return false
  662. }
  663. b, err := ioutil.ReadAll(r.Body)
  664. if err != nil {
  665. writeError(w, r, httptypes.NewHTTPError(http.StatusBadRequest, err.Error()))
  666. return false
  667. }
  668. if err := req.UnmarshalJSON(b); err != nil {
  669. writeError(w, r, httptypes.NewHTTPError(http.StatusBadRequest, err.Error()))
  670. return false
  671. }
  672. return true
  673. }
  674. func getID(p string, w http.ResponseWriter) (types.ID, bool) {
  675. idStr := trimPrefix(p, membersPrefix)
  676. if idStr == "" {
  677. http.Error(w, "Method Not Allowed", http.StatusMethodNotAllowed)
  678. return 0, false
  679. }
  680. id, err := types.IDFromString(idStr)
  681. if err != nil {
  682. writeError(w, nil, httptypes.NewHTTPError(http.StatusNotFound, fmt.Sprintf("No such member: %s", idStr)))
  683. return 0, false
  684. }
  685. return id, true
  686. }
  687. // getUint64 extracts a uint64 by the given key from a Form. If the key does
  688. // not exist in the form, 0 is returned. If the key exists but the value is
  689. // badly formed, an error is returned. If multiple values are present only the
  690. // first is considered.
  691. func getUint64(form url.Values, key string) (i uint64, err error) {
  692. if vals, ok := form[key]; ok {
  693. i, err = strconv.ParseUint(vals[0], 10, 64)
  694. }
  695. return
  696. }
  697. // getBool extracts a bool by the given key from a Form. If the key does not
  698. // exist in the form, false is returned. If the key exists but the value is
  699. // badly formed, an error is returned. If multiple values are present only the
  700. // first is considered.
  701. func getBool(form url.Values, key string) (b bool, err error) {
  702. if vals, ok := form[key]; ok {
  703. b, err = strconv.ParseBool(vals[0])
  704. }
  705. return
  706. }
  707. // trimPrefix removes a given prefix and any slash following the prefix
  708. // e.g.: trimPrefix("foo", "foo") == trimPrefix("foo/", "foo") == ""
  709. func trimPrefix(p, prefix string) (s string) {
  710. s = strings.TrimPrefix(p, prefix)
  711. s = strings.TrimPrefix(s, "/")
  712. return
  713. }
  714. func newMemberCollection(ms []*membership.Member) *httptypes.MemberCollection {
  715. c := httptypes.MemberCollection(make([]httptypes.Member, len(ms)))
  716. for i, m := range ms {
  717. c[i] = newMember(m)
  718. }
  719. return &c
  720. }
  721. func newMember(m *membership.Member) httptypes.Member {
  722. tm := httptypes.Member{
  723. ID: m.ID.String(),
  724. Name: m.Name,
  725. PeerURLs: make([]string, len(m.PeerURLs)),
  726. ClientURLs: make([]string, len(m.ClientURLs)),
  727. }
  728. copy(tm.PeerURLs, m.PeerURLs)
  729. copy(tm.ClientURLs, m.ClientURLs)
  730. return tm
  731. }