3413: update for code review
[arvados.git] / services / keepstore / handlers.go
index 039b2ac9a346ac6c1bbb1d81f6f70ddc80c2bf5a..289b0c8c743d9afeb0fc3afad2332a3f3d7d18f1 100644 (file)
@@ -10,6 +10,7 @@ package main
 import (
        "bufio"
        "bytes"
+       "container/list"
        "crypto/md5"
        "encoding/json"
        "fmt"
@@ -58,6 +59,18 @@ func MakeRESTRouter() *mux.Router {
                `/index/{prefix:[0-9a-f]{0,32}}`, IndexHandler).Methods("GET", "HEAD")
        rest.HandleFunc(`/status.json`, StatusHandler).Methods("GET", "HEAD")
 
+       // The PullHandler and TrashHandler process "PUT /pull" and "PUT
+       // /trash" requests from Data Manager.  These requests instruct
+       // Keep to replicate or delete blocks; see
+       // https://arvados.org/projects/orvos-private/wiki/Keep_Design_Doc
+       // for more details.
+       //
+       // Each handler parses the JSON list of block management requests
+       // in the message body, and delivers them to the pull queue or
+       // trash queue, respectively.
+       rest.HandleFunc(`/pull`, PullHandler).Methods("PUT")
+       rest.HandleFunc(`/trash`, TrashHandler).Methods("PUT")
+
        // Any request which does not match any of these routes gets
        // 400 Bad Request.
        rest.NotFoundHandler = http.HandlerFunc(BadRequestHandler)
@@ -397,6 +410,123 @@ func DeleteHandler(resp http.ResponseWriter, req *http.Request) {
        }
 }
 
+/* PullHandler processes "PUT /pull" requests for the data manager.
+   The request body is a JSON message containing a list of pull
+   requests in the following format:
+
+   [
+      {
+         "locator":"e4d909c290d0fb1ca068ffaddf22cbd0+4985",
+         "servers":[
+                       "keep0.qr1hi.arvadosapi.com:25107",
+                       "keep1.qr1hi.arvadosapi.com:25108"
+                ]
+         },
+         {
+                "locator":"55ae4d45d2db0793d53f03e805f656e5+658395",
+                "servers":[
+                       "10.0.1.5:25107",
+                       "10.0.1.6:25107",
+                       "10.0.1.7:25108"
+                ]
+         },
+         ...
+   ]
+
+   Each pull request in the list consists of a block locator string
+   and an ordered list of servers.  Keepstore should try to fetch the
+   block from each server in turn.
+
+   If the request has not been sent by the Data Manager, return 401
+   Unauthorized.
+
+   If the JSON unmarshalling fails, return 400 Bad Request.
+*/
+
+type PullRequest struct {
+       Locator string   `json:"locator"`
+       Servers []string `json:"servers"`
+}
+
+func PullHandler(resp http.ResponseWriter, req *http.Request) {
+       // Reject unauthorized requests.
+       api_token := GetApiToken(req)
+       if !IsDataManagerToken(api_token) {
+               http.Error(resp, UnauthorizedError.Error(), UnauthorizedError.HTTPCode)
+               log.Printf("%s %s: %s\n", req.Method, req.URL, UnauthorizedError.Error())
+               return
+       }
+
+       // Parse the request body.
+       var pr []PullRequest
+       r := json.NewDecoder(req.Body)
+       if err := r.Decode(&pr); err != nil {
+               http.Error(resp, BadRequestError.Error(), BadRequestError.HTTPCode)
+               log.Printf("%s %s: %s\n", req.Method, req.URL, err.Error())
+               return
+       }
+
+       // We have a properly formatted pull list sent from the data
+       // manager.  Report success and send the list to the pull list
+       // manager for further handling.
+       log.Printf("%s %s: received %v\n", req.Method, req.URL, pr)
+       resp.WriteHeader(http.StatusOK)
+       resp.Write([]byte(
+               fmt.Sprintf("Received %d pull requests\n", len(pr))))
+
+       plist := list.New()
+       for _, p := range pr {
+               plist.PushBack(p)
+       }
+
+       if pullq == nil {
+               pullq = NewWorkQueue()
+       }
+       pullq.ReplaceQueue(plist)
+}
+
+type TrashRequest struct {
+       Locator    string `json:"locator"`
+       BlockMtime int64  `json:"block_mtime"`
+}
+
+func TrashHandler(resp http.ResponseWriter, req *http.Request) {
+       // Reject unauthorized requests.
+       api_token := GetApiToken(req)
+       if !IsDataManagerToken(api_token) {
+               http.Error(resp, UnauthorizedError.Error(), UnauthorizedError.HTTPCode)
+               log.Printf("%s %s: %s\n", req.Method, req.URL, UnauthorizedError.Error())
+               return
+       }
+
+       // Parse the request body.
+       var trash []TrashRequest
+       r := json.NewDecoder(req.Body)
+       if err := r.Decode(&trash); err != nil {
+               http.Error(resp, BadRequestError.Error(), BadRequestError.HTTPCode)
+               log.Printf("%s %s: %s\n", req.Method, req.URL, err.Error())
+               return
+       }
+
+       // We have a properly formatted trash list sent from the data
+       // manager.  Report success and send the list to the trash work
+       // queue for further handling.
+       log.Printf("%s %s: received %v\n", req.Method, req.URL, trash)
+       resp.WriteHeader(http.StatusOK)
+       resp.Write([]byte(
+               fmt.Sprintf("Received %d trash requests\n", len(trash))))
+
+       tlist := list.New()
+       for _, t := range trash {
+               tlist.PushBack(t)
+       }
+
+       if trashq == nil {
+               trashq = NewWorkQueue()
+       }
+       trashq.ReplaceQueue(tlist)
+}
+
 // ==============================
 // GetBlock and PutBlock implement lower-level code for handling
 // blocks by rooting through volumes connected to the local machine.
@@ -606,10 +736,7 @@ func CanDelete(api_token string) bool {
        }
        // Blocks may be deleted only when Keep has been configured with a
        // data manager.
-       if data_manager_token == "" {
-               return false
-       }
-       if api_token == data_manager_token {
+       if IsDataManagerToken(api_token) {
                return true
        }
        // TODO(twp): look up api_token with the API server
@@ -617,3 +744,9 @@ func CanDelete(api_token string) bool {
        // has unlimited scope
        return false
 }
+
+// IsDataManagerToken returns true if api_token represents the data
+// manager's token.
+func IsDataManagerToken(api_token string) bool {
+       return data_manager_token != "" && api_token == data_manager_token
+}