client.go 23 KB

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