-
Notifications
You must be signed in to change notification settings - Fork 7
/
sheet.go
347 lines (291 loc) · 10.2 KB
/
sheet.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
// InfoMark - a platform for managing courses with
// distributing exercise sheets and testing exercise submissions
// Copyright (C) 2019 ComputerGraphics Tuebingen
// Authors: Patrick Wieschollek
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package app
import (
"context"
"fmt"
"net/http"
"strconv"
"github.com/go-chi/chi"
"github.com/go-chi/render"
"github.com/infomark-org/infomark-backend/api/helper"
"github.com/infomark-org/infomark-backend/auth/authenticate"
"github.com/infomark-org/infomark-backend/auth/authorize"
"github.com/infomark-org/infomark-backend/model"
"github.com/infomark-org/infomark-backend/symbol"
)
// SheetResource specifies Sheet management handler.
type SheetResource struct {
Stores *Stores
}
// NewSheetResource create and returns a SheetResource.
func NewSheetResource(stores *Stores) *SheetResource {
return &SheetResource{
Stores: stores,
}
}
// IndexHandler is public endpoint for
// URL: /courses/{course_id}/sheets
// URLPARAM: course_id,integer
// METHOD: get
// TAG: sheets
// RESPONSE: 200,SheetResponseList
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: get all sheets in course
// DESCRIPTION:
// The sheets are ordered by their names
func (rs *SheetResource) IndexHandler(w http.ResponseWriter, r *http.Request) {
var sheets []model.Sheet
var err error
// we use middle to detect whether there is a course given
course := r.Context().Value(symbol.CtxKeyCourse).(*model.Course)
sheets, err = rs.Stores.Sheet.SheetsOfCourse(course.ID)
if err != nil {
render.Render(w, r, ErrInternalServerErrorWithDetails(err))
return
}
givenRole := r.Context().Value(symbol.CtxKeyCourseRole).(authorize.CourseRole)
// render JSON reponse
if err = render.RenderList(w, r, rs.newSheetListResponse(givenRole, sheets)); err != nil {
render.Render(w, r, ErrRender(err))
return
}
}
// CreateHandler is public endpoint for
// URL: /courses/{course_id}/sheets
// URLPARAM: course_id,integer
// METHOD: post
// TAG: sheets
// REQUEST: SheetRequest
// RESPONSE: 204,SheetResponse
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: create a new sheet
func (rs *SheetResource) CreateHandler(w http.ResponseWriter, r *http.Request) {
course := r.Context().Value(symbol.CtxKeyCourse).(*model.Course)
// start from empty Request
data := &SheetRequest{}
// parse JSON request into struct
if err := render.Bind(r, data); err != nil {
render.Render(w, r, ErrBadRequestWithDetails(err))
return
}
sheet := &model.Sheet{
Name: data.Name,
PublishAt: data.PublishAt,
DueAt: data.DueAt,
}
// create Sheet entry in database
newSheet, err := rs.Stores.Sheet.Create(sheet, course.ID)
if err != nil {
render.Render(w, r, ErrRender(err))
return
}
render.Status(r, http.StatusCreated)
// return Sheet information of created entry
if err := render.Render(w, r, rs.newSheetResponse(newSheet)); err != nil {
render.Render(w, r, ErrRender(err))
return
}
}
// GetHandler is public endpoint for
// URL: /courses/{course_id}/sheets/{sheet_id}
// URLPARAM: course_id,integer
// URLPARAM: sheet_id,integer
// METHOD: get
// TAG: sheets
// RESPONSE: 200,SheetResponse
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: get a specific sheet
func (rs *SheetResource) GetHandler(w http.ResponseWriter, r *http.Request) {
// `Sheet` is retrieved via middle-ware
Sheet := r.Context().Value(symbol.CtxKeySheet).(*model.Sheet)
// render JSON reponse
if err := render.Render(w, r, rs.newSheetResponse(Sheet)); err != nil {
render.Render(w, r, ErrRender(err))
return
}
render.Status(r, http.StatusOK)
}
// EditHandler is public endpoint for
// URL: /courses/{course_id}/sheets/{sheet_id}
// URLPARAM: course_id,integer
// URLPARAM: sheet_id,integer
// METHOD: put
// TAG: sheets
// REQUEST: SheetRequest
// RESPONSE: 204,NotContent
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: update a specific sheet
func (rs *SheetResource) EditHandler(w http.ResponseWriter, r *http.Request) {
sheet := r.Context().Value(symbol.CtxKeySheet).(*model.Sheet)
// start from empty Request
data := &SheetRequest{}
// parse JSON request into struct
if err := render.Bind(r, data); err != nil {
render.Render(w, r, ErrBadRequestWithDetails(err))
return
}
sheet.Name = data.Name
sheet.PublishAt = data.PublishAt
sheet.DueAt = data.DueAt
// update database entry
if err := rs.Stores.Sheet.Update(sheet); err != nil {
render.Render(w, r, ErrInternalServerErrorWithDetails(err))
return
}
render.Status(r, http.StatusNoContent)
}
// DeleteHandler is public endpoint for
// URL: /courses/{course_id}/sheets/{sheet_id}
// URLPARAM: course_id,integer
// URLPARAM: sheet_id,integer
// METHOD: delete
// TAG: sheets
// RESPONSE: 204,NoContent
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: delete a specific sheet
func (rs *SheetResource) DeleteHandler(w http.ResponseWriter, r *http.Request) {
Sheet := r.Context().Value(symbol.CtxKeySheet).(*model.Sheet)
// update database entry
if err := rs.Stores.Sheet.Delete(Sheet.ID); err != nil {
render.Render(w, r, ErrInternalServerErrorWithDetails(err))
return
}
render.Status(r, http.StatusNoContent)
}
// GetFileHandler is public endpoint for
// URL: /courses/{course_id}/sheets/{sheet_id}/file
// URLPARAM: course_id,integer
// URLPARAM: sheet_id,integer
// METHOD: get
// TAG: sheets
// RESPONSE: 200,ZipFile
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: get the zip file of a sheet
func (rs *SheetResource) GetFileHandler(w http.ResponseWriter, r *http.Request) {
sheet := r.Context().Value(symbol.CtxKeySheet).(*model.Sheet)
course := r.Context().Value(symbol.CtxKeyCourse).(*model.Course)
hnd := helper.NewSheetFileHandle(sheet.ID)
if !hnd.Exists() {
render.Render(w, r, ErrNotFound)
return
}
if err := hnd.WriteToBodyWithName(fmt.Sprintf("%s-%s.zip", course.Name, sheet.Name), w); err != nil {
render.Render(w, r, ErrInternalServerErrorWithDetails(err))
}
}
// ChangeFileHandler is public endpoint for
// URL: /courses/{course_id}/sheets/{sheet_id}/file
// URLPARAM: course_id,integer
// URLPARAM: sheet_id,integer
// METHOD: post
// TAG: sheets
// REQUEST: zipfile
// RESPONSE: 204,NoContent
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: change the zip file of a sheet
func (rs *SheetResource) ChangeFileHandler(w http.ResponseWriter, r *http.Request) {
// will always be a POST
sheet := r.Context().Value(symbol.CtxKeySheet).(*model.Sheet)
// the file will be located
if _, err := helper.NewSheetFileHandle(sheet.ID).WriteToDisk(r, "file_data"); err != nil {
render.Render(w, r, ErrInternalServerErrorWithDetails(err))
}
render.Status(r, http.StatusOK)
}
// PointsHandler is public endpoint for
// URL: /courses/{course_id}/sheets/{sheet_id}/points
// URLPARAM: course_id,integer
// URLPARAM: sheet_id,integer
// METHOD: get
// TAG: sheets
// RESPONSE: 200,newTaskListResponseList
// RESPONSE: 400,BadRequest
// RESPONSE: 401,Unauthenticated
// RESPONSE: 403,Unauthorized
// SUMMARY: return all points from a sheet for the request identity
func (rs *SheetResource) PointsHandler(w http.ResponseWriter, r *http.Request) {
sheet := r.Context().Value(symbol.CtxKeySheet).(*model.Sheet)
accessClaims := r.Context().Value(symbol.CtxKeyAccessClaims).(*authenticate.AccessClaims)
taskPoints, err := rs.Stores.Sheet.PointsForUser(accessClaims.LoginID, sheet.ID)
if err != nil {
render.Render(w, r, ErrInternalServerErrorWithDetails(err))
return
}
// resp := &SheetPointsResponse{SheetPoints: taskPoints}
if err := render.RenderList(w, r, newTaskPointsListResponse(taskPoints)); err != nil {
render.Render(w, r, ErrRender(err))
return
}
render.Status(r, http.StatusOK)
}
// .............................................................................
// Context middleware is used to load an Sheet object from
// the URL parameter `SheetID` passed through as the request. In case
// the Sheet could not be found, we stop here and return a 404.
// We do NOT check whether the Sheet is authorized to get this Sheet.
func (rs *SheetResource) Context(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
courseFromURL := r.Context().Value(symbol.CtxKeyCourse).(*model.Course)
var sheetID int64
var err error
// try to get id from URL
if sheetID, err = strconv.ParseInt(chi.URLParam(r, "sheet_id"), 10, 64); err != nil {
render.Render(w, r, ErrNotFound)
return
}
// find specific Sheet in database
sheet, err := rs.Stores.Sheet.Get(sheetID)
if err != nil {
render.Render(w, r, ErrNotFound)
return
}
// public yet?
if r.Context().Value(symbol.CtxKeyCourseRole).(authorize.CourseRole) == authorize.STUDENT && !PublicYet(sheet.PublishAt) {
render.Render(w, r, ErrBadRequestWithDetails(fmt.Errorf("sheet not published yet")))
return
}
ctx := context.WithValue(r.Context(), symbol.CtxKeySheet, sheet)
// when there is a sheetID in the url, there is NOT a courseID in the url,
// BUT: when there is a sheet, there is a course
course, err := rs.Stores.Sheet.IdentifyCourseOfSheet(sheet.ID)
if err != nil {
render.Render(w, r, ErrInternalServerErrorWithDetails(err))
return
}
if courseFromURL.ID != course.ID {
render.Render(w, r, ErrNotFound)
return
}
ctx = context.WithValue(ctx, symbol.CtxKeyCourse, course)
// serve next
next.ServeHTTP(w, r.WithContext(ctx))
})
}