]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame_incremental - server/controllers/api/users/me.ts
Implement signup approval in server
[github/Chocobozzz/PeerTube.git] / server / controllers / api / users / me.ts
... / ...
CommitLineData
1import 'multer'
2import express from 'express'
3import { auditLoggerFactory, getAuditIdFromRes, UserAuditView } from '@server/helpers/audit-logger'
4import { getBiggestActorImage } from '@server/lib/actor-image'
5import { Hooks } from '@server/lib/plugins/hooks'
6import { pick } from '@shared/core-utils'
7import { ActorImageType, HttpStatusCode, UserUpdateMe, UserVideoQuota, UserVideoRate as FormattedUserVideoRate } from '@shared/models'
8import { AttributesOnly } from '@shared/typescript-utils'
9import { createReqFiles } from '../../../helpers/express-utils'
10import { getFormattedObjects } from '../../../helpers/utils'
11import { CONFIG } from '../../../initializers/config'
12import { MIMETYPES } from '../../../initializers/constants'
13import { sequelizeTypescript } from '../../../initializers/database'
14import { sendUpdateActor } from '../../../lib/activitypub/send'
15import { deleteLocalActorImageFile, updateLocalActorImageFiles } from '../../../lib/local-actor'
16import { getOriginalVideoFileTotalDailyFromUser, getOriginalVideoFileTotalFromUser, sendVerifyUserEmail } from '../../../lib/user'
17import {
18 asyncMiddleware,
19 asyncRetryTransactionMiddleware,
20 authenticate,
21 paginationValidator,
22 setDefaultPagination,
23 setDefaultSort,
24 setDefaultVideosSort,
25 usersUpdateMeValidator,
26 usersVideoRatingValidator
27} from '../../../middlewares'
28import {
29 deleteMeValidator,
30 getMyVideoImportsValidator,
31 usersVideosValidator,
32 videoImportsSortValidator,
33 videosSortValidator
34} from '../../../middlewares/validators'
35import { updateAvatarValidator } from '../../../middlewares/validators/actor-image'
36import { AccountModel } from '../../../models/account/account'
37import { AccountVideoRateModel } from '../../../models/account/account-video-rate'
38import { UserModel } from '../../../models/user/user'
39import { VideoModel } from '../../../models/video/video'
40import { VideoImportModel } from '../../../models/video/video-import'
41
42const auditLogger = auditLoggerFactory('users')
43
44const reqAvatarFile = createReqFiles([ 'avatarfile' ], MIMETYPES.IMAGE.MIMETYPE_EXT)
45
46const meRouter = express.Router()
47
48meRouter.get('/me',
49 authenticate,
50 asyncMiddleware(getUserInformation)
51)
52meRouter.delete('/me',
53 authenticate,
54 deleteMeValidator,
55 asyncMiddleware(deleteMe)
56)
57
58meRouter.get('/me/video-quota-used',
59 authenticate,
60 asyncMiddleware(getUserVideoQuotaUsed)
61)
62
63meRouter.get('/me/videos/imports',
64 authenticate,
65 paginationValidator,
66 videoImportsSortValidator,
67 setDefaultSort,
68 setDefaultPagination,
69 getMyVideoImportsValidator,
70 asyncMiddleware(getUserVideoImports)
71)
72
73meRouter.get('/me/videos',
74 authenticate,
75 paginationValidator,
76 videosSortValidator,
77 setDefaultVideosSort,
78 setDefaultPagination,
79 asyncMiddleware(usersVideosValidator),
80 asyncMiddleware(getUserVideos)
81)
82
83meRouter.get('/me/videos/:videoId/rating',
84 authenticate,
85 asyncMiddleware(usersVideoRatingValidator),
86 asyncMiddleware(getUserVideoRating)
87)
88
89meRouter.put('/me',
90 authenticate,
91 asyncMiddleware(usersUpdateMeValidator),
92 asyncRetryTransactionMiddleware(updateMe)
93)
94
95meRouter.post('/me/avatar/pick',
96 authenticate,
97 reqAvatarFile,
98 updateAvatarValidator,
99 asyncRetryTransactionMiddleware(updateMyAvatar)
100)
101
102meRouter.delete('/me/avatar',
103 authenticate,
104 asyncRetryTransactionMiddleware(deleteMyAvatar)
105)
106
107// ---------------------------------------------------------------------------
108
109export {
110 meRouter
111}
112
113// ---------------------------------------------------------------------------
114
115async function getUserVideos (req: express.Request, res: express.Response) {
116 const user = res.locals.oauth.token.User
117
118 const apiOptions = await Hooks.wrapObject({
119 accountId: user.Account.id,
120 start: req.query.start,
121 count: req.query.count,
122 sort: req.query.sort,
123 search: req.query.search,
124 channelId: res.locals.videoChannel?.id,
125 isLive: req.query.isLive
126 }, 'filter:api.user.me.videos.list.params')
127
128 const resultList = await Hooks.wrapPromiseFun(
129 VideoModel.listUserVideosForApi,
130 apiOptions,
131 'filter:api.user.me.videos.list.result'
132 )
133
134 const additionalAttributes = {
135 waitTranscoding: true,
136 state: true,
137 scheduledUpdate: true,
138 blacklistInfo: true
139 }
140 return res.json(getFormattedObjects(resultList.data, resultList.total, { additionalAttributes }))
141}
142
143async function getUserVideoImports (req: express.Request, res: express.Response) {
144 const user = res.locals.oauth.token.User
145 const resultList = await VideoImportModel.listUserVideoImportsForApi({
146 userId: user.id,
147
148 ...pick(req.query, [ 'targetUrl', 'start', 'count', 'sort', 'search', 'videoChannelSyncId' ])
149 })
150
151 return res.json(getFormattedObjects(resultList.data, resultList.total))
152}
153
154async function getUserInformation (req: express.Request, res: express.Response) {
155 // We did not load channels in res.locals.user
156 const user = await UserModel.loadForMeAPI(res.locals.oauth.token.user.id)
157
158 return res.json(user.toMeFormattedJSON())
159}
160
161async function getUserVideoQuotaUsed (req: express.Request, res: express.Response) {
162 const user = res.locals.oauth.token.user
163 const videoQuotaUsed = await getOriginalVideoFileTotalFromUser(user)
164 const videoQuotaUsedDaily = await getOriginalVideoFileTotalDailyFromUser(user)
165
166 const data: UserVideoQuota = {
167 videoQuotaUsed,
168 videoQuotaUsedDaily
169 }
170 return res.json(data)
171}
172
173async function getUserVideoRating (req: express.Request, res: express.Response) {
174 const videoId = res.locals.videoId.id
175 const accountId = +res.locals.oauth.token.User.Account.id
176
177 const ratingObj = await AccountVideoRateModel.load(accountId, videoId, null)
178 const rating = ratingObj ? ratingObj.type : 'none'
179
180 const json: FormattedUserVideoRate = {
181 videoId,
182 rating
183 }
184 return res.json(json)
185}
186
187async function deleteMe (req: express.Request, res: express.Response) {
188 const user = await UserModel.loadByIdWithChannels(res.locals.oauth.token.User.id)
189
190 auditLogger.delete(getAuditIdFromRes(res), new UserAuditView(user.toFormattedJSON()))
191
192 await user.destroy()
193
194 return res.status(HttpStatusCode.NO_CONTENT_204).end()
195}
196
197async function updateMe (req: express.Request, res: express.Response) {
198 const body: UserUpdateMe = req.body
199 let sendVerificationEmail = false
200
201 const user = res.locals.oauth.token.user
202
203 const keysToUpdate: (keyof UserUpdateMe & keyof AttributesOnly<UserModel>)[] = [
204 'password',
205 'nsfwPolicy',
206 'p2pEnabled',
207 'autoPlayVideo',
208 'autoPlayNextVideo',
209 'autoPlayNextVideoPlaylist',
210 'videosHistoryEnabled',
211 'videoLanguages',
212 'theme',
213 'noInstanceConfigWarningModal',
214 'noAccountSetupWarningModal',
215 'noWelcomeModal'
216 ]
217
218 for (const key of keysToUpdate) {
219 if (body[key] !== undefined) user.set(key, body[key])
220 }
221
222 if (body.p2pEnabled !== undefined) {
223 user.set('p2pEnabled', body.p2pEnabled)
224 } else if (body.webTorrentEnabled !== undefined) { // FIXME: deprecated in 4.1
225 user.set('p2pEnabled', body.webTorrentEnabled)
226 }
227
228 if (body.email !== undefined) {
229 if (CONFIG.SIGNUP.REQUIRES_EMAIL_VERIFICATION) {
230 user.pendingEmail = body.email
231 sendVerificationEmail = true
232 } else {
233 user.email = body.email
234 }
235 }
236
237 await sequelizeTypescript.transaction(async t => {
238 await user.save({ transaction: t })
239
240 if (body.displayName === undefined && body.description === undefined) return
241
242 const userAccount = await AccountModel.load(user.Account.id, t)
243
244 if (body.displayName !== undefined) userAccount.name = body.displayName
245 if (body.description !== undefined) userAccount.description = body.description
246 await userAccount.save({ transaction: t })
247
248 await sendUpdateActor(userAccount, t)
249 })
250
251 if (sendVerificationEmail === true) {
252 await sendVerifyUserEmail(user, true)
253 }
254
255 return res.status(HttpStatusCode.NO_CONTENT_204).end()
256}
257
258async function updateMyAvatar (req: express.Request, res: express.Response) {
259 const avatarPhysicalFile = req.files['avatarfile'][0]
260 const user = res.locals.oauth.token.user
261
262 const userAccount = await AccountModel.load(user.Account.id)
263
264 const avatars = await updateLocalActorImageFiles(
265 userAccount,
266 avatarPhysicalFile,
267 ActorImageType.AVATAR
268 )
269
270 return res.json({
271 // TODO: remove, deprecated in 4.2
272 avatar: getBiggestActorImage(avatars).toFormattedJSON(),
273 avatars: avatars.map(avatar => avatar.toFormattedJSON())
274 })
275}
276
277async function deleteMyAvatar (req: express.Request, res: express.Response) {
278 const user = res.locals.oauth.token.user
279
280 const userAccount = await AccountModel.load(user.Account.id)
281 await deleteLocalActorImageFile(userAccount, ActorImageType.AVATAR)
282
283 return res.json({ avatars: [] })
284}