20259: Add documentation for banner and tooltip features
[arvados.git] / lib / controller / router / router.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package router
6
7 import (
8         "context"
9         "fmt"
10         "math"
11         "net/http"
12         "strings"
13
14         "git.arvados.org/arvados.git/lib/controller/api"
15         "git.arvados.org/arvados.git/sdk/go/arvados"
16         "git.arvados.org/arvados.git/sdk/go/auth"
17         "git.arvados.org/arvados.git/sdk/go/ctxlog"
18         "git.arvados.org/arvados.git/sdk/go/httpserver"
19         "github.com/gorilla/mux"
20         "github.com/sirupsen/logrus"
21 )
22
23 type router struct {
24         mux     *mux.Router
25         backend arvados.API
26         config  Config
27 }
28
29 type Config struct {
30         // Return an error if request body exceeds this size. 0 means
31         // unlimited.
32         MaxRequestSize int
33
34         // If wrapCalls is not nil, it is called once for each API
35         // method, and the returned method is used in its place. This
36         // can be used to install hooks before and after each API call
37         // and alter responses; see localdb.WrapCallsInTransaction for
38         // an example.
39         WrapCalls func(api.RoutableFunc) api.RoutableFunc
40 }
41
42 // New returns a new router (which implements the http.Handler
43 // interface) that serves requests by calling Arvados API methods on
44 // the given backend.
45 func New(backend arvados.API, config Config) *router {
46         rtr := &router{
47                 mux:     mux.NewRouter(),
48                 backend: backend,
49                 config:  config,
50         }
51         rtr.addRoutes()
52         return rtr
53 }
54
55 func (rtr *router) addRoutes() {
56         for _, route := range []struct {
57                 endpoint    arvados.APIEndpoint
58                 defaultOpts func() interface{}
59                 exec        api.RoutableFunc
60         }{
61                 {
62                         arvados.EndpointConfigGet,
63                         func() interface{} { return &struct{}{} },
64                         func(ctx context.Context, opts interface{}) (interface{}, error) {
65                                 return rtr.backend.ConfigGet(ctx)
66                         },
67                 },
68                 {
69                         arvados.EndpointVocabularyGet,
70                         func() interface{} { return &struct{}{} },
71                         func(ctx context.Context, opts interface{}) (interface{}, error) {
72                                 return rtr.backend.VocabularyGet(ctx)
73                         },
74                 },
75                 {
76                         arvados.EndpointLogin,
77                         func() interface{} { return &arvados.LoginOptions{} },
78                         func(ctx context.Context, opts interface{}) (interface{}, error) {
79                                 return rtr.backend.Login(ctx, *opts.(*arvados.LoginOptions))
80                         },
81                 },
82                 {
83                         arvados.EndpointLogout,
84                         func() interface{} { return &arvados.LogoutOptions{} },
85                         func(ctx context.Context, opts interface{}) (interface{}, error) {
86                                 return rtr.backend.Logout(ctx, *opts.(*arvados.LogoutOptions))
87                         },
88                 },
89                 {
90                         arvados.EndpointCollectionCreate,
91                         func() interface{} { return &arvados.CreateOptions{} },
92                         func(ctx context.Context, opts interface{}) (interface{}, error) {
93                                 return rtr.backend.CollectionCreate(ctx, *opts.(*arvados.CreateOptions))
94                         },
95                 },
96                 {
97                         arvados.EndpointCollectionUpdate,
98                         func() interface{} { return &arvados.UpdateOptions{} },
99                         func(ctx context.Context, opts interface{}) (interface{}, error) {
100                                 return rtr.backend.CollectionUpdate(ctx, *opts.(*arvados.UpdateOptions))
101                         },
102                 },
103                 {
104                         arvados.EndpointCollectionGet,
105                         func() interface{} { return &arvados.GetOptions{} },
106                         func(ctx context.Context, opts interface{}) (interface{}, error) {
107                                 return rtr.backend.CollectionGet(ctx, *opts.(*arvados.GetOptions))
108                         },
109                 },
110                 {
111                         arvados.EndpointCollectionList,
112                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
113                         func(ctx context.Context, opts interface{}) (interface{}, error) {
114                                 return rtr.backend.CollectionList(ctx, *opts.(*arvados.ListOptions))
115                         },
116                 },
117                 {
118                         arvados.EndpointCollectionProvenance,
119                         func() interface{} { return &arvados.GetOptions{} },
120                         func(ctx context.Context, opts interface{}) (interface{}, error) {
121                                 return rtr.backend.CollectionProvenance(ctx, *opts.(*arvados.GetOptions))
122                         },
123                 },
124                 {
125                         arvados.EndpointCollectionUsedBy,
126                         func() interface{} { return &arvados.GetOptions{} },
127                         func(ctx context.Context, opts interface{}) (interface{}, error) {
128                                 return rtr.backend.CollectionUsedBy(ctx, *opts.(*arvados.GetOptions))
129                         },
130                 },
131                 {
132                         arvados.EndpointCollectionDelete,
133                         func() interface{} { return &arvados.DeleteOptions{} },
134                         func(ctx context.Context, opts interface{}) (interface{}, error) {
135                                 return rtr.backend.CollectionDelete(ctx, *opts.(*arvados.DeleteOptions))
136                         },
137                 },
138                 {
139                         arvados.EndpointCollectionTrash,
140                         func() interface{} { return &arvados.DeleteOptions{} },
141                         func(ctx context.Context, opts interface{}) (interface{}, error) {
142                                 return rtr.backend.CollectionTrash(ctx, *opts.(*arvados.DeleteOptions))
143                         },
144                 },
145                 {
146                         arvados.EndpointCollectionUntrash,
147                         func() interface{} { return &arvados.UntrashOptions{} },
148                         func(ctx context.Context, opts interface{}) (interface{}, error) {
149                                 return rtr.backend.CollectionUntrash(ctx, *opts.(*arvados.UntrashOptions))
150                         },
151                 },
152                 {
153                         arvados.EndpointContainerCreate,
154                         func() interface{} { return &arvados.CreateOptions{} },
155                         func(ctx context.Context, opts interface{}) (interface{}, error) {
156                                 return rtr.backend.ContainerCreate(ctx, *opts.(*arvados.CreateOptions))
157                         },
158                 },
159                 {
160                         arvados.EndpointContainerPriorityUpdate,
161                         func() interface{} { return &arvados.UpdateOptions{} },
162                         func(ctx context.Context, opts interface{}) (interface{}, error) {
163                                 return rtr.backend.ContainerPriorityUpdate(ctx, *opts.(*arvados.UpdateOptions))
164                         },
165                 },
166                 {
167                         arvados.EndpointContainerUpdate,
168                         func() interface{} { return &arvados.UpdateOptions{} },
169                         func(ctx context.Context, opts interface{}) (interface{}, error) {
170                                 return rtr.backend.ContainerUpdate(ctx, *opts.(*arvados.UpdateOptions))
171                         },
172                 },
173                 {
174                         arvados.EndpointContainerGet,
175                         func() interface{} { return &arvados.GetOptions{} },
176                         func(ctx context.Context, opts interface{}) (interface{}, error) {
177                                 return rtr.backend.ContainerGet(ctx, *opts.(*arvados.GetOptions))
178                         },
179                 },
180                 {
181                         arvados.EndpointContainerList,
182                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
183                         func(ctx context.Context, opts interface{}) (interface{}, error) {
184                                 return rtr.backend.ContainerList(ctx, *opts.(*arvados.ListOptions))
185                         },
186                 },
187                 {
188                         arvados.EndpointContainerDelete,
189                         func() interface{} { return &arvados.DeleteOptions{} },
190                         func(ctx context.Context, opts interface{}) (interface{}, error) {
191                                 return rtr.backend.ContainerDelete(ctx, *opts.(*arvados.DeleteOptions))
192                         },
193                 },
194                 {
195                         arvados.EndpointContainerRequestCreate,
196                         func() interface{} { return &arvados.CreateOptions{} },
197                         func(ctx context.Context, opts interface{}) (interface{}, error) {
198                                 return rtr.backend.ContainerRequestCreate(ctx, *opts.(*arvados.CreateOptions))
199                         },
200                 },
201                 {
202                         arvados.EndpointContainerRequestUpdate,
203                         func() interface{} { return &arvados.UpdateOptions{} },
204                         func(ctx context.Context, opts interface{}) (interface{}, error) {
205                                 return rtr.backend.ContainerRequestUpdate(ctx, *opts.(*arvados.UpdateOptions))
206                         },
207                 },
208                 {
209                         arvados.EndpointContainerRequestGet,
210                         func() interface{} { return &arvados.GetOptions{} },
211                         func(ctx context.Context, opts interface{}) (interface{}, error) {
212                                 return rtr.backend.ContainerRequestGet(ctx, *opts.(*arvados.GetOptions))
213                         },
214                 },
215                 {
216                         arvados.EndpointContainerRequestList,
217                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
218                         func(ctx context.Context, opts interface{}) (interface{}, error) {
219                                 return rtr.backend.ContainerRequestList(ctx, *opts.(*arvados.ListOptions))
220                         },
221                 },
222                 {
223                         arvados.EndpointContainerRequestDelete,
224                         func() interface{} { return &arvados.DeleteOptions{} },
225                         func(ctx context.Context, opts interface{}) (interface{}, error) {
226                                 return rtr.backend.ContainerRequestDelete(ctx, *opts.(*arvados.DeleteOptions))
227                         },
228                 },
229                 {
230                         arvados.EndpointContainerLock,
231                         func() interface{} {
232                                 return &arvados.GetOptions{Select: []string{"uuid", "state", "priority", "auth_uuid", "locked_by_uuid"}}
233                         },
234                         func(ctx context.Context, opts interface{}) (interface{}, error) {
235                                 return rtr.backend.ContainerLock(ctx, *opts.(*arvados.GetOptions))
236                         },
237                 },
238                 {
239                         arvados.EndpointContainerUnlock,
240                         func() interface{} {
241                                 return &arvados.GetOptions{Select: []string{"uuid", "state", "priority", "auth_uuid", "locked_by_uuid"}}
242                         },
243                         func(ctx context.Context, opts interface{}) (interface{}, error) {
244                                 return rtr.backend.ContainerUnlock(ctx, *opts.(*arvados.GetOptions))
245                         },
246                 },
247                 {
248                         arvados.EndpointContainerSSH,
249                         func() interface{} { return &arvados.ContainerSSHOptions{} },
250                         func(ctx context.Context, opts interface{}) (interface{}, error) {
251                                 return rtr.backend.ContainerSSH(ctx, *opts.(*arvados.ContainerSSHOptions))
252                         },
253                 },
254                 {
255                         // arvados-client built before commit
256                         // bdc29d3129f6d75aa9ce0a24ffb849a272b06f08
257                         // used GET with params in headers instead of
258                         // POST form
259                         arvados.APIEndpoint{"GET", "arvados/v1/connect/{uuid}/ssh", ""},
260                         func() interface{} { return &arvados.ContainerSSHOptions{} },
261                         func(ctx context.Context, opts interface{}) (interface{}, error) {
262                                 return nil, httpError(http.StatusGone, fmt.Errorf("API endpoint is obsolete -- please upgrade your arvados-client program"))
263                         },
264                 },
265                 {
266                         arvados.EndpointContainerGatewayTunnel,
267                         func() interface{} { return &arvados.ContainerGatewayTunnelOptions{} },
268                         func(ctx context.Context, opts interface{}) (interface{}, error) {
269                                 return rtr.backend.ContainerGatewayTunnel(ctx, *opts.(*arvados.ContainerGatewayTunnelOptions))
270                         },
271                 },
272                 {
273                         arvados.EndpointGroupCreate,
274                         func() interface{} { return &arvados.CreateOptions{} },
275                         func(ctx context.Context, opts interface{}) (interface{}, error) {
276                                 return rtr.backend.GroupCreate(ctx, *opts.(*arvados.CreateOptions))
277                         },
278                 },
279                 {
280                         arvados.EndpointGroupUpdate,
281                         func() interface{} { return &arvados.UpdateOptions{} },
282                         func(ctx context.Context, opts interface{}) (interface{}, error) {
283                                 return rtr.backend.GroupUpdate(ctx, *opts.(*arvados.UpdateOptions))
284                         },
285                 },
286                 {
287                         arvados.EndpointGroupList,
288                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
289                         func(ctx context.Context, opts interface{}) (interface{}, error) {
290                                 return rtr.backend.GroupList(ctx, *opts.(*arvados.ListOptions))
291                         },
292                 },
293                 {
294                         arvados.EndpointGroupContents,
295                         func() interface{} { return &arvados.GroupContentsOptions{Limit: -1} },
296                         func(ctx context.Context, opts interface{}) (interface{}, error) {
297                                 return rtr.backend.GroupContents(ctx, *opts.(*arvados.GroupContentsOptions))
298                         },
299                 },
300                 {
301                         arvados.EndpointGroupContentsUUIDInPath,
302                         func() interface{} { return &arvados.GroupContentsOptions{Limit: -1} },
303                         func(ctx context.Context, opts interface{}) (interface{}, error) {
304                                 return rtr.backend.GroupContents(ctx, *opts.(*arvados.GroupContentsOptions))
305                         },
306                 },
307                 {
308                         arvados.EndpointGroupShared,
309                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
310                         func(ctx context.Context, opts interface{}) (interface{}, error) {
311                                 return rtr.backend.GroupShared(ctx, *opts.(*arvados.ListOptions))
312                         },
313                 },
314                 {
315                         arvados.EndpointGroupGet,
316                         func() interface{} { return &arvados.GetOptions{} },
317                         func(ctx context.Context, opts interface{}) (interface{}, error) {
318                                 return rtr.backend.GroupGet(ctx, *opts.(*arvados.GetOptions))
319                         },
320                 },
321                 {
322                         arvados.EndpointGroupDelete,
323                         func() interface{} { return &arvados.DeleteOptions{} },
324                         func(ctx context.Context, opts interface{}) (interface{}, error) {
325                                 return rtr.backend.GroupDelete(ctx, *opts.(*arvados.DeleteOptions))
326                         },
327                 },
328                 {
329                         arvados.EndpointGroupTrash,
330                         func() interface{} { return &arvados.DeleteOptions{} },
331                         func(ctx context.Context, opts interface{}) (interface{}, error) {
332                                 return rtr.backend.GroupTrash(ctx, *opts.(*arvados.DeleteOptions))
333                         },
334                 },
335                 {
336                         arvados.EndpointGroupUntrash,
337                         func() interface{} { return &arvados.UntrashOptions{} },
338                         func(ctx context.Context, opts interface{}) (interface{}, error) {
339                                 return rtr.backend.GroupUntrash(ctx, *opts.(*arvados.UntrashOptions))
340                         },
341                 },
342                 {
343                         arvados.EndpointLinkCreate,
344                         func() interface{} { return &arvados.CreateOptions{} },
345                         func(ctx context.Context, opts interface{}) (interface{}, error) {
346                                 return rtr.backend.LinkCreate(ctx, *opts.(*arvados.CreateOptions))
347                         },
348                 },
349                 {
350                         arvados.EndpointLinkUpdate,
351                         func() interface{} { return &arvados.UpdateOptions{} },
352                         func(ctx context.Context, opts interface{}) (interface{}, error) {
353                                 return rtr.backend.LinkUpdate(ctx, *opts.(*arvados.UpdateOptions))
354                         },
355                 },
356                 {
357                         arvados.EndpointLinkList,
358                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
359                         func(ctx context.Context, opts interface{}) (interface{}, error) {
360                                 return rtr.backend.LinkList(ctx, *opts.(*arvados.ListOptions))
361                         },
362                 },
363                 {
364                         arvados.EndpointLinkGet,
365                         func() interface{} { return &arvados.GetOptions{} },
366                         func(ctx context.Context, opts interface{}) (interface{}, error) {
367                                 return rtr.backend.LinkGet(ctx, *opts.(*arvados.GetOptions))
368                         },
369                 },
370                 {
371                         arvados.EndpointLinkDelete,
372                         func() interface{} { return &arvados.DeleteOptions{} },
373                         func(ctx context.Context, opts interface{}) (interface{}, error) {
374                                 return rtr.backend.LinkDelete(ctx, *opts.(*arvados.DeleteOptions))
375                         },
376                 },
377                 {
378                         arvados.EndpointLogCreate,
379                         func() interface{} { return &arvados.CreateOptions{} },
380                         func(ctx context.Context, opts interface{}) (interface{}, error) {
381                                 return rtr.backend.LogCreate(ctx, *opts.(*arvados.CreateOptions))
382                         },
383                 },
384                 {
385                         arvados.EndpointLogUpdate,
386                         func() interface{} { return &arvados.UpdateOptions{} },
387                         func(ctx context.Context, opts interface{}) (interface{}, error) {
388                                 return rtr.backend.LogUpdate(ctx, *opts.(*arvados.UpdateOptions))
389                         },
390                 },
391                 {
392                         arvados.EndpointLogList,
393                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
394                         func(ctx context.Context, opts interface{}) (interface{}, error) {
395                                 return rtr.backend.LogList(ctx, *opts.(*arvados.ListOptions))
396                         },
397                 },
398                 {
399                         arvados.EndpointLogGet,
400                         func() interface{} { return &arvados.GetOptions{} },
401                         func(ctx context.Context, opts interface{}) (interface{}, error) {
402                                 return rtr.backend.LogGet(ctx, *opts.(*arvados.GetOptions))
403                         },
404                 },
405                 {
406                         arvados.EndpointLogDelete,
407                         func() interface{} { return &arvados.DeleteOptions{} },
408                         func(ctx context.Context, opts interface{}) (interface{}, error) {
409                                 return rtr.backend.LogDelete(ctx, *opts.(*arvados.DeleteOptions))
410                         },
411                 },
412                 {
413                         arvados.EndpointSpecimenCreate,
414                         func() interface{} { return &arvados.CreateOptions{} },
415                         func(ctx context.Context, opts interface{}) (interface{}, error) {
416                                 return rtr.backend.SpecimenCreate(ctx, *opts.(*arvados.CreateOptions))
417                         },
418                 },
419                 {
420                         arvados.EndpointSpecimenUpdate,
421                         func() interface{} { return &arvados.UpdateOptions{} },
422                         func(ctx context.Context, opts interface{}) (interface{}, error) {
423                                 return rtr.backend.SpecimenUpdate(ctx, *opts.(*arvados.UpdateOptions))
424                         },
425                 },
426                 {
427                         arvados.EndpointSpecimenGet,
428                         func() interface{} { return &arvados.GetOptions{} },
429                         func(ctx context.Context, opts interface{}) (interface{}, error) {
430                                 return rtr.backend.SpecimenGet(ctx, *opts.(*arvados.GetOptions))
431                         },
432                 },
433                 {
434                         arvados.EndpointSpecimenList,
435                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
436                         func(ctx context.Context, opts interface{}) (interface{}, error) {
437                                 return rtr.backend.SpecimenList(ctx, *opts.(*arvados.ListOptions))
438                         },
439                 },
440                 {
441                         arvados.EndpointSpecimenDelete,
442                         func() interface{} { return &arvados.DeleteOptions{} },
443                         func(ctx context.Context, opts interface{}) (interface{}, error) {
444                                 return rtr.backend.SpecimenDelete(ctx, *opts.(*arvados.DeleteOptions))
445                         },
446                 },
447                 {
448                         arvados.EndpointAPIClientAuthorizationCreate,
449                         func() interface{} { return &arvados.CreateOptions{} },
450                         func(ctx context.Context, opts interface{}) (interface{}, error) {
451                                 return rtr.backend.APIClientAuthorizationCreate(ctx, *opts.(*arvados.CreateOptions))
452                         },
453                 },
454                 {
455                         arvados.EndpointAPIClientAuthorizationUpdate,
456                         func() interface{} { return &arvados.UpdateOptions{} },
457                         func(ctx context.Context, opts interface{}) (interface{}, error) {
458                                 return rtr.backend.APIClientAuthorizationUpdate(ctx, *opts.(*arvados.UpdateOptions))
459                         },
460                 },
461                 {
462                         arvados.EndpointAPIClientAuthorizationDelete,
463                         func() interface{} { return &arvados.DeleteOptions{} },
464                         func(ctx context.Context, opts interface{}) (interface{}, error) {
465                                 return rtr.backend.APIClientAuthorizationDelete(ctx, *opts.(*arvados.DeleteOptions))
466                         },
467                 },
468                 {
469                         arvados.EndpointAPIClientAuthorizationList,
470                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
471                         func(ctx context.Context, opts interface{}) (interface{}, error) {
472                                 return rtr.backend.APIClientAuthorizationList(ctx, *opts.(*arvados.ListOptions))
473                         },
474                 },
475                 {
476                         arvados.EndpointAPIClientAuthorizationCurrent,
477                         func() interface{} { return &arvados.GetOptions{} },
478                         func(ctx context.Context, opts interface{}) (interface{}, error) {
479                                 return rtr.backend.APIClientAuthorizationCurrent(ctx, *opts.(*arvados.GetOptions))
480                         },
481                 },
482                 {
483                         arvados.EndpointAPIClientAuthorizationGet,
484                         func() interface{} { return &arvados.GetOptions{} },
485                         func(ctx context.Context, opts interface{}) (interface{}, error) {
486                                 return rtr.backend.APIClientAuthorizationGet(ctx, *opts.(*arvados.GetOptions))
487                         },
488                 },
489                 {
490                         arvados.EndpointUserCreate,
491                         func() interface{} { return &arvados.CreateOptions{} },
492                         func(ctx context.Context, opts interface{}) (interface{}, error) {
493                                 return rtr.backend.UserCreate(ctx, *opts.(*arvados.CreateOptions))
494                         },
495                 },
496                 {
497                         arvados.EndpointUserMerge,
498                         func() interface{} { return &arvados.UserMergeOptions{} },
499                         func(ctx context.Context, opts interface{}) (interface{}, error) {
500                                 return rtr.backend.UserMerge(ctx, *opts.(*arvados.UserMergeOptions))
501                         },
502                 },
503                 {
504                         arvados.EndpointUserActivate,
505                         func() interface{} { return &arvados.UserActivateOptions{} },
506                         func(ctx context.Context, opts interface{}) (interface{}, error) {
507                                 return rtr.backend.UserActivate(ctx, *opts.(*arvados.UserActivateOptions))
508                         },
509                 },
510                 {
511                         arvados.EndpointUserSetup,
512                         func() interface{} { return &arvados.UserSetupOptions{} },
513                         func(ctx context.Context, opts interface{}) (interface{}, error) {
514                                 return rtr.backend.UserSetup(ctx, *opts.(*arvados.UserSetupOptions))
515                         },
516                 },
517                 {
518                         arvados.EndpointUserUnsetup,
519                         func() interface{} { return &arvados.GetOptions{} },
520                         func(ctx context.Context, opts interface{}) (interface{}, error) {
521                                 return rtr.backend.UserUnsetup(ctx, *opts.(*arvados.GetOptions))
522                         },
523                 },
524                 {
525                         arvados.EndpointUserGetCurrent,
526                         func() interface{} { return &arvados.GetOptions{} },
527                         func(ctx context.Context, opts interface{}) (interface{}, error) {
528                                 return rtr.backend.UserGetCurrent(ctx, *opts.(*arvados.GetOptions))
529                         },
530                 },
531                 {
532                         arvados.EndpointUserGetSystem,
533                         func() interface{} { return &arvados.GetOptions{} },
534                         func(ctx context.Context, opts interface{}) (interface{}, error) {
535                                 return rtr.backend.UserGetSystem(ctx, *opts.(*arvados.GetOptions))
536                         },
537                 },
538                 {
539                         arvados.EndpointUserGet,
540                         func() interface{} { return &arvados.GetOptions{} },
541                         func(ctx context.Context, opts interface{}) (interface{}, error) {
542                                 return rtr.backend.UserGet(ctx, *opts.(*arvados.GetOptions))
543                         },
544                 },
545                 {
546                         arvados.EndpointUserUpdate,
547                         func() interface{} { return &arvados.UpdateOptions{} },
548                         func(ctx context.Context, opts interface{}) (interface{}, error) {
549                                 return rtr.backend.UserUpdate(ctx, *opts.(*arvados.UpdateOptions))
550                         },
551                 },
552                 {
553                         arvados.EndpointUserList,
554                         func() interface{} { return &arvados.ListOptions{Limit: -1} },
555                         func(ctx context.Context, opts interface{}) (interface{}, error) {
556                                 return rtr.backend.UserList(ctx, *opts.(*arvados.ListOptions))
557                         },
558                 },
559                 {
560                         arvados.EndpointUserBatchUpdate,
561                         func() interface{} { return &arvados.UserBatchUpdateOptions{} },
562                         func(ctx context.Context, opts interface{}) (interface{}, error) {
563                                 return rtr.backend.UserBatchUpdate(ctx, *opts.(*arvados.UserBatchUpdateOptions))
564                         },
565                 },
566                 {
567                         arvados.EndpointUserDelete,
568                         func() interface{} { return &arvados.DeleteOptions{} },
569                         func(ctx context.Context, opts interface{}) (interface{}, error) {
570                                 return rtr.backend.UserDelete(ctx, *opts.(*arvados.DeleteOptions))
571                         },
572                 },
573                 {
574                         arvados.EndpointUserAuthenticate,
575                         func() interface{} { return &arvados.UserAuthenticateOptions{} },
576                         func(ctx context.Context, opts interface{}) (interface{}, error) {
577                                 return rtr.backend.UserAuthenticate(ctx, *opts.(*arvados.UserAuthenticateOptions))
578                         },
579                 },
580         } {
581                 exec := route.exec
582                 if rtr.config.WrapCalls != nil {
583                         exec = rtr.config.WrapCalls(exec)
584                 }
585                 rtr.addRoute(route.endpoint, route.defaultOpts, exec)
586         }
587         rtr.mux.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
588                 httpserver.Errors(w, []string{"API endpoint not found"}, http.StatusNotFound)
589         })
590         rtr.mux.MethodNotAllowedHandler = http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
591                 httpserver.Errors(w, []string{"API endpoint not found"}, http.StatusMethodNotAllowed)
592         })
593 }
594
595 var altMethod = map[string]string{
596         "PATCH": "PUT",  // Accept PUT as a synonym for PATCH
597         "GET":   "HEAD", // Accept HEAD at any GET route
598 }
599
600 func (rtr *router) addRoute(endpoint arvados.APIEndpoint, defaultOpts func() interface{}, exec api.RoutableFunc) {
601         methods := []string{endpoint.Method}
602         if alt, ok := altMethod[endpoint.Method]; ok {
603                 methods = append(methods, alt)
604         }
605         rtr.mux.Methods(methods...).Path("/" + endpoint.Path).HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
606                 logger := ctxlog.FromContext(req.Context())
607                 params, err := rtr.loadRequestParams(req, endpoint.AttrsKey)
608                 if err != nil {
609                         logger.WithFields(logrus.Fields{
610                                 "req":      req,
611                                 "method":   endpoint.Method,
612                                 "endpoint": endpoint,
613                         }).WithError(err).Debug("error loading request params")
614                         rtr.sendError(w, err)
615                         return
616                 }
617                 opts := defaultOpts()
618                 err = rtr.transcode(params, opts)
619                 if err != nil {
620                         logger.WithField("params", params).WithError(err).Debugf("error transcoding params to %T", opts)
621                         rtr.sendError(w, err)
622                         return
623                 }
624                 respOpts, err := rtr.responseOptions(opts)
625                 if err != nil {
626                         logger.WithField("opts", opts).WithError(err).Debugf("error getting response options from %T", opts)
627                         rtr.sendError(w, err)
628                         return
629                 }
630
631                 creds := auth.CredentialsFromRequest(req)
632                 err = creds.LoadTokensFromHTTPRequestBody(req)
633                 if err != nil {
634                         rtr.sendError(w, fmt.Errorf("error loading tokens from request body: %s", err))
635                         return
636                 }
637                 if rt, _ := params["reader_tokens"].([]interface{}); len(rt) > 0 {
638                         for _, t := range rt {
639                                 if t, ok := t.(string); ok {
640                                         creds.Tokens = append(creds.Tokens, t)
641                                 }
642                         }
643                 }
644                 ctx := auth.NewContext(req.Context(), creds)
645                 ctx = arvados.ContextWithRequestID(ctx, req.Header.Get("X-Request-Id"))
646                 logger.WithFields(logrus.Fields{
647                         "apiEndpoint": endpoint,
648                         "apiOptsType": fmt.Sprintf("%T", opts),
649                         "apiOpts":     opts,
650                 }).Debug("exec")
651                 // Extract the token UUIDs (or a placeholder for v1 tokens)
652                 var tokenUUIDs []string
653                 for _, t := range creds.Tokens {
654                         if strings.HasPrefix(t, "v2/") {
655                                 tokenParts := strings.Split(t, "/")
656                                 if len(tokenParts) >= 3 {
657                                         tokenUUIDs = append(tokenUUIDs, tokenParts[1])
658                                 }
659                         } else {
660                                 end := t
661                                 if len(t) > 5 {
662                                         end = t[len(t)-5:]
663                                 }
664                                 tokenUUIDs = append(tokenUUIDs, "v1 token ending in "+end)
665                         }
666                 }
667                 httpserver.SetResponseLogFields(req.Context(), logrus.Fields{"tokenUUIDs": tokenUUIDs})
668                 resp, err := exec(ctx, opts)
669                 if err != nil {
670                         logger.WithError(err).Debugf("returning error type %T", err)
671                         rtr.sendError(w, err)
672                         return
673                 }
674                 rtr.sendResponse(w, req, resp, respOpts)
675         })
676 }
677
678 func (rtr *router) ServeHTTP(w http.ResponseWriter, r *http.Request) {
679         switch strings.SplitN(strings.TrimLeft(r.URL.Path, "/"), "/", 2)[0] {
680         case "login", "logout", "auth":
681         default:
682                 w.Header().Set("Access-Control-Allow-Origin", "*")
683                 w.Header().Set("Access-Control-Allow-Methods", "GET, HEAD, PUT, POST, PATCH, DELETE")
684                 w.Header().Set("Access-Control-Allow-Headers", "Authorization, Content-Type, X-Http-Method-Override")
685                 w.Header().Set("Access-Control-Max-Age", "86486400")
686         }
687         if r.Method == "OPTIONS" {
688                 return
689         }
690         if r.Body != nil {
691                 // Wrap r.Body in a http.MaxBytesReader(), otherwise
692                 // r.ParseForm() uses a default max request body size
693                 // of 10 megabytes. Note we rely on the Nginx
694                 // configuration to enforce the real max body size.
695                 max := int64(rtr.config.MaxRequestSize)
696                 if max < 1 {
697                         max = math.MaxInt64 - 1
698                 }
699                 r.Body = http.MaxBytesReader(w, r.Body, max)
700         }
701         if r.Method == "POST" {
702                 err := r.ParseForm()
703                 if err != nil {
704                         if err.Error() == "http: request body too large" {
705                                 err = httpError(http.StatusRequestEntityTooLarge, err)
706                         }
707                         rtr.sendError(w, err)
708                         return
709                 }
710                 if m := r.FormValue("_method"); m != "" {
711                         r2 := *r
712                         r = &r2
713                         r.Method = m
714                 } else if m = r.Header.Get("X-Http-Method-Override"); m != "" {
715                         r2 := *r
716                         r = &r2
717                         r.Method = m
718                 }
719         }
720         rtr.mux.ServeHTTP(w, r)
721 }