client.go 21 KB

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