client.go 23 KB

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