client.go 23 KB

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