-
Notifications
You must be signed in to change notification settings - Fork 0
/
route-feedback.go
258 lines (191 loc) · 7.45 KB
/
route-feedback.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
package main
import (
"fmt"
"strconv"
"strings"
"html/template"
"net/http"
"github.com/freitagsrunde/modulist/db"
"github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/binding"
)
// Structs
type ReviewModulePayload struct {
ID int `conform:"trim,num" validate:"required,min=1"`
}
type AddFeedbackPayload struct {
Category int `form:"category" conform:"trim,num" validate:"min=0"`
Comment string `form:"comment" conform:"trim" validate:"required"`
}
// Functions
func (app *App) ReviewModule(c *gin.Context) {
// Check if user is authorized.
User, err := app.Authorize(c.Request, db.PRIVILEGE_REVIEWER)
if err != nil {
c.Redirect(http.StatusFound, "/")
return
}
// Update expiration time of session.
app.CreateSession(c, *User)
// Extract ID of module to review from URL.
id, err := strconv.Atoi(c.Param("moduleID"))
if err != nil {
c.Redirect(http.StatusFound, "/modules")
return
}
Payload := ReviewModulePayload{ID: id}
// Check supplied ID for conformity and validity.
if errs := app.ConformAndValidate(&Payload); errs != nil {
c.Redirect(http.StatusFound, "/modules")
return
}
// Retrieve module information for supplied ID from database.
var Module db.Module
app.DB.Preload("Courses").Preload("WorkingEfforts").Preload("ExamElements").First(&Module, "\"id\" = ?", Payload.ID)
// Check if a module for supplied ID exists.
if Module.URL == "" {
// If no module exists, redirect to modules list view.
c.Redirect(http.StatusFound, "/modules")
return
}
// Convert the working effort elements from database to
// structure better suited for displaying in HTML template.
Module.WorkingEffortsHTML = db.WorkingEffortsConvert(Module.WorkingEfforts)
// Only use this field if it contains a valid value.
if Module.ReferencePersonID.Valid {
app.DB.Model(&Module).Related(&Module.ReferencePerson, "ReferencePersonID")
}
// Only use this field if it contains a valid value.
if Module.ResponsiblePersonID.Valid {
app.DB.Model(&Module).Related(&Module.ResponsiblePerson, "ResponsiblePersonID")
}
// For each of the elements containing free text with linebreaks,
// convert each of those to HTML linebreaks in a safely manner.
Module.LearningOutcomesHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.LearningOutcomes.String), "\n", "<br />", -1))
Module.LearningOutcomesEnglishHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.LearningOutcomesEnglish.String), "\n", "<br />", -1))
Module.TeachingContentsHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.TeachingContents.String), "\n", "<br />", -1))
Module.TeachingContentsEnglishHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.TeachingContentsEnglish.String), "\n", "<br />", -1))
Module.InstructiveFormHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.InstructiveForm), "\n", "<br />", -1))
Module.OptionalRequirementsHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.OptionalRequirements), "\n", "<br />", -1))
Module.MandatoryRequirementsHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.MandatoryRequirements.String), "\n", "<br />", -1))
Module.ExaminationDescriptionHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.ExaminationDescription.String), "\n", "<br />", -1))
Module.MiscellaneousHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.Miscellaneous.String), "\n", "<br />", -1))
Module.LiteratureHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.Literature), "\n", "<br />", -1))
Module.RegistrationFormalitiesHTML = template.HTML(strings.Replace(template.HTMLEscapeString(Module.RegistrationFormalities.String), "\n", "<br />", -1))
c.HTML(http.StatusOK, "module-feedback.html", gin.H{
"PageTitle": fmt.Sprintf("Feedback zu Modul #%d", Module.ModuleID),
"User": User,
"Module": Module,
"Categories": db.CategoriesByName(),
})
}
func (app *App) AddFeedback(c *gin.Context) {
// Check if user is authorized.
User, err := app.Authorize(c.Request, db.PRIVILEGE_REVIEWER)
if err != nil {
c.Redirect(http.StatusFound, "/")
return
}
// Update expiration time of session.
app.CreateSession(c, *User)
// Extract ID of module to add a review for from URL.
id, err := strconv.Atoi(c.Param("moduleID"))
if err != nil {
c.Redirect(http.StatusFound, "/modules")
return
}
IDPayload := ReviewModulePayload{ID: id}
// Check supplied ID for conformity and validity.
if errs := app.ConformAndValidate(&IDPayload); errs != nil {
c.Redirect(http.StatusFound, "/modules")
return
}
var Module db.Module
app.DB.First(&Module, "\"id\" = ?", IDPayload.ID)
// Check if a module for supplied ID exists.
if Module.URL == "" {
// If it does not, send error message and return.
c.JSON(http.StatusBadRequest, gin.H{
"Reason": "Module does not exist.",
})
return
}
var FeedbackPayload AddFeedbackPayload
err = c.BindWith(&FeedbackPayload, binding.FormPost)
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{
"Reason": "Internal error. Please try again later.",
})
return
}
// Check sent content for validity.
ErrorDesc := app.ConformAndValidate(&FeedbackPayload)
if ErrorDesc != nil {
// If payload did not pass, report errors to user.
c.JSON(http.StatusBadRequest, gin.H{
"Reason": "Malformed input. Please check your values for validity and try again.",
"ErrorDescriptions": ErrorDesc,
})
return
}
// With supplied content, create new feedback.
var NewFeedback db.Feedback
NewFeedback.ModuleID = IDPayload.ID
NewFeedback.UserID = User.ID
NewFeedback.Category = FeedbackPayload.Category
NewFeedback.Comment = FeedbackPayload.Comment
// Save feedback to database.
app.DB.Create(&NewFeedback)
// Request all feedback comments for submitted
// category and include count of those.
var AllFeedback []db.Feedback
app.DB.Order("\"id\" asc").Find(&AllFeedback, "\"module_id\" = ? AND \"category\" = ?", IDPayload.ID, FeedbackPayload.Category)
// Return success as JSON to user.
c.JSON(http.StatusOK, gin.H{
"Success": true,
"Feedback": AllFeedback,
"Count": len(AllFeedback),
})
}
func (app *App) DeleteFeedback(c *gin.Context) {}
func (app *App) ListFeedback(c *gin.Context) {
// Check if user is authorized.
User, err := app.Authorize(c.Request, db.PRIVILEGE_REVIEWER)
if err != nil {
c.Redirect(http.StatusFound, "/")
return
}
// Update expiration time of session.
app.CreateSession(c, *User)
// Extract ID of module to fetch comments for from URL.
id, err := strconv.Atoi(c.Param("moduleID"))
if err != nil {
c.Redirect(http.StatusFound, "/modules")
return
}
Payload := ReviewModulePayload{ID: id}
// Check supplied ID for conformity and validity.
if errs := app.ConformAndValidate(&Payload); errs != nil {
c.Redirect(http.StatusFound, "/modules")
return
}
var Module db.Module
app.DB.First(&Module, "\"id\" = ?", Payload.ID)
// Check if a module for supplied ID exists.
if Module.URL == "" {
// If it does not, send error message and return.
c.JSON(http.StatusBadRequest, gin.H{
"Reason": "Module does not exist.",
})
return
}
// Fetch all available feedback for that module,
// calculate counts and return data to user.
var AllFeedback []db.Feedback
app.DB.Order("\"category\" asc").Order("\"id\" asc").Find(&AllFeedback, "\"module_id\" = ?", Payload.ID)
// TODO: Add calculation of counters per category.
c.JSON(http.StatusOK, gin.H{
"Success": true,
"Feedback": AllFeedback,
})
}