client.go 23 KB

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