import { authWithHeaders } from '../../middlewares/api-v3/auth'; import _ from 'lodash'; import cron from '../../middlewares/api-v3/cron'; import { model as Challenge } from '../../models/challenge'; import { model as Group } from '../../models/group'; import { model as User, nameFields, } from '../../models/user'; import { NotFound, NotAuthorized, } from '../../libs/api-v3/errors'; import shared from '../../../../common'; import * as Tasks from '../../models/task'; import { sendTxn as txnEmail } from '../../libs/api-v3/email'; import pushNotify from '../../libs/api-v3/pushNotifications'; import Q from 'q'; import csvStringify from '../../libs/api-v3/csvStringify'; let api = {}; /** * @api {post} /challenges Create a new challenge * @apiVersion 3.0.0 * @apiName CreateChallenge * @apiGroup Challenge * * @apiSuccess {object} challenge The newly created challenge */ api.createChallenge = { method: 'POST', url: '/challenges', middlewares: [authWithHeaders(), cron], async handler (req, res) { let user = res.locals.user; req.checkBody('groupId', res.t('groupIdRequired')).notEmpty(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let groupId = req.body.groupId; let prize = req.body.prize; let group = await Group.getGroup({user, groupId, fields: '-chat', mustBeMember: true}); if (!group) throw new NotFound(res.t('groupNotFound')); if (!group.isMember(user)) throw new NotAuthorized(res.t('mustBeGroupMember')); if (group.leaderOnly && group.leaderOnly.challenges && group.leader !== user._id) { throw new NotAuthorized(res.t('onlyGroupLeaderChal')); } if (groupId === 'habitrpg' && prize < 1) { throw new NotAuthorized(res.t('pubChalsMinPrize')); } if (prize > 0) { let groupBalance = group.balance && group.leader === user._id ? group.balance : 0; let prizeCost = prize / 4; if (prizeCost > user.balance + groupBalance) { throw new NotAuthorized(res.t('cantAfford')); } if (groupBalance >= prizeCost) { // Group pays for all of prize group.balance -= prizeCost; } else if (groupBalance > 0) { // User pays remainder of prize cost after group let remainder = prizeCost - group.balance; group.balance = 0; user.balance -= remainder; } else { // User pays for all of prize user.balance -= prizeCost; } } group.challengeCount += 1; req.body.leader = user._id; req.body.official = user.contributor.admin && req.body.official; let challenge = new Challenge(Challenge.sanitize(req.body)); // First validate challenge so we don't save group if it's invalid (only runs sync validators) let challengeValidationErrors = challenge.validateSync(); if (challengeValidationErrors) throw challengeValidationErrors; let results = await Q.all([challenge.save({ validateBeforeSave: false, // already validate }), group.save()]); let savedChal = results[0]; await savedChal.syncToUser(user); // (it also saves the user) res.respond(201, savedChal); }, }; /** * @api {post} /challenges/:challengeId/join Joins a challenge * @apiVersion 3.0.0 * @apiName JoinChallenge * @apiGroup Challenge * @apiParam {UUID} challengeId The challenge _id * * @apiSuccess {object} challenge The challenge the user joined */ api.joinChallenge = { method: 'POST', url: '/challenges/:challengeId/join', middlewares: [authWithHeaders(), cron], async handler (req, res) { let user = res.locals.user; req.checkParams('challengeId', res.t('challengeIdRequired')).notEmpty().isUUID(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let challenge = await Challenge.findOne({ _id: req.params.challengeId }); if (!challenge) throw new NotFound(res.t('challengeNotFound')); if (!challenge.hasAccess(user)) throw new NotFound(res.t('challengeNotFound')); if (_.contains(user.challenges, challenge._id)) throw new NotAuthorized(res.t('userAlreadyInChallenge')); challenge.memberCount += 1; // Add all challenge's tasks to user's tasks and save the challenge await Q.all([challenge.syncToUser(user), challenge.save()]); res.respond(200, challenge); }, }; /** * @api {post} /challenges/:challengeId/leave Leaves a challenge * @apiVersion 3.0.0 * @apiName LeaveChallenge * @apiGroup Challenge * @apiParam {UUID} challengeId The challenge _id * * @apiSuccess {object} empty An empty object */ api.leaveChallenge = { method: 'POST', url: '/challenges/:challengeId/leave', middlewares: [authWithHeaders(), cron], async handler (req, res) { let user = res.locals.user; let keep = req.body.keep === 'remove-all' ? 'remove-all' : 'keep-all'; req.checkParams('challengeId', res.t('challengeIdRequired')).notEmpty().isUUID(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let challenge = await Challenge.findOne({ _id: req.params.challengeId }); if (!challenge) throw new NotFound(res.t('challengeNotFound')); let group = await Group.getGroup({user, groupId: challenge.groupId, fields: '_id type privacy'}); if (!group || !challenge.canView(user, group)) throw new NotFound(res.t('challengeNotFound')); if (!challenge.isMember(user)) throw new NotAuthorized(res.t('challengeMemberNotFound')); challenge.memberCount -= 1; // Unlink challenge's tasks from user's tasks and save the challenge await Q.all([user.unlinkChallengeTasks(challenge._id, keep), challenge.save()]); res.respond(200, {}); }, }; /** * @api {get} /challenges Get challenges for a user * @apiVersion 3.0.0 * @apiName GetChallenges * @apiGroup Challenge * * @apiSuccess {Array} challenges An array of challenges */ api.getChallenges = { method: 'GET', url: '/challenges', middlewares: [authWithHeaders(), cron], async handler (req, res) { let user = res.locals.user; let groups = user.guilds.slice(0); // slice is used to clone the array so we don't modify it directly if (user.party._id) groups.push(user.party._id); groups.push('habitrpg'); // tavern challenges let challenges = await Challenge.find({ $or: [ {_id: {$in: user.challenges}}, // Challenges where the user is participating {groupId: {$in: groups}}, // Challenges in groups where I'm a member {leader: user._id}, // Challenges where I'm the leader ], _id: {$ne: '95533e05-1ff9-4e46-970b-d77219f199e9'}, // remove the Spread the Word Challenge for now, will revisit when we fix the closing-challenge bug TODO revisit }) .sort('-official -timestamp') // TODO populate // .populate('group', '_id name type') // .populate('leader', 'profile.name') .exec(); res.respond(200, challenges); }, }; /** * @api {get} /challenges/group/group:Id Get challenges for a group * @apiVersion 3.0.0 * @apiName GetGroupChallenges * @apiGroup Challenge * * @apiParam {groupId} groupId The group _id * * @apiSuccess {Array} challenges An array of challenges */ api.getGroupChallenges = { method: 'GET', url: '/challenges/groups/:groupId', middlewares: [authWithHeaders(), cron], async handler (req, res) { let user = res.locals.user; let groupId = req.params.groupId; req.checkParams('groupId', res.t('groupIdRequired')).notEmpty(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let group = await Group.getGroup({user, groupId}); if (!group) throw new NotFound(res.t('groupNotFound')); let challenges = await Challenge.find({groupId}) .sort('-official -timestamp') // TODO populate // .populate('group', '_id name type') // .populate('leader', 'profile.name') .exec(); res.respond(200, challenges); }, }; /** * @api {get} /challenges/:challengeId Get a challenge given its id * @apiVersion 3.0.0 * @apiName GetChallenge * @apiGroup Challenge * * @apiParam {UUID} challengeId The challenge _id * * @apiSuccess {object} challenge The challenge object */ api.getChallenge = { method: 'GET', url: '/challenges/:challengeId', middlewares: [authWithHeaders(), cron], async handler (req, res) { req.checkParams('challengeId', res.t('challengeIdRequired')).notEmpty().isUUID(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let user = res.locals.user; let challengeId = req.params.challengeId; let challenge = await Challenge.findById(challengeId).exec(); if (!challenge) throw new NotFound(res.t('challengeNotFound')); let group = await Group.getGroup({user, groupId: challenge.groupId, fields: '_id type privacy', optionalMembership: true}); if (!group || !challenge.canView(user, group)) throw new NotFound(res.t('challengeNotFound')); res.respond(200, challenge); }, }; /** * @api {get} /challenges/:challengeId/export/csv Export a challenge in CSV * @apiVersion 3.0.0 * @apiName ExportChallengeCsv * @apiGroup Challenge * * @apiParam {UUID} challengeId The challenge _id * * @apiSuccess {object} challenge The challenge object */ api.exportChallengeCsv = { method: 'GET', url: '/challenges/:challengeId/export/csv', middlewares: [authWithHeaders(), cron], async handler (req, res) { req.checkParams('challengeId', res.t('challengeIdRequired')).notEmpty().isUUID(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let user = res.locals.user; let challengeId = req.params.challengeId; let challenge = await Challenge.findById(challengeId).select('_id groupId leader tasksOrder').exec(); if (!challenge) throw new NotFound(res.t('challengeNotFound')); let group = await Group.getGroup({user, groupId: challenge.groupId, fields: '_id type privacy', optionalMembership: true}); if (!group || !challenge.canView(user, group)) throw new NotFound(res.t('challengeNotFound')); // In v2 this used the aggregation framework to run some computation on MongoDB but then iterated through all // results on the server so the perf difference isn't that big (hopefully) let [members, tasks] = await Q.all([ User.find({challenges: challengeId}) .select(nameFields) .sort({_id: 1}) .lean() // so we don't involve mongoose .exec(), Tasks.Task.find({'challenge.id': challengeId, userId: {$exists: true}}) .sort({userId: 1, text: 1}).select('userId type text value notes').lean().exec(), ]); let resArray = members.map(member => [member._id, member.profile.name]); // We assume every user in the challenge as at least some data so we can say that members[0] tasks will be at tasks [0] let lastUserId; let index = -1; tasks.forEach(task => { if (task.userId !== lastUserId) { lastUserId = task.userId; index++; } resArray[index].push(`${task.type}:${task.text}`, task.value, task.notes); }); // The first row is going to be UUID name Task Value Notes repeated n times for the n challenge tasks let challengeTasks = _.reduce(challenge.tasksOrder.toObject(), (result, array) => { return result.concat(array); }, []).sort(); resArray.unshift(['UUID', 'name']); _.times(challengeTasks.length, () => resArray[0].push('Task', 'Value', 'Notes')); res.set({ 'Content-Type': 'text/csv', 'Content-disposition': `attachment; filename=${challengeId}.csv`, }); let csvRes = await csvStringify(resArray); res.status(200).send(csvRes); }, }; /** * @api {put} /challenges/:challengeId Update a challenge * @apiVersion 3.0.0 * @apiName UpdateChallenge * @apiGroup Challenge * * @apiParam {UUID} challengeId The challenge _id * * @apiSuccess {object} challenge The updated challenge object */ api.updateChallenge = { method: 'PUT', url: '/challenges/:challengeId', middlewares: [authWithHeaders(), cron], async handler (req, res) { req.checkParams('challengeId', res.t('challengeIdRequired')).notEmpty().isUUID(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let user = res.locals.user; let challengeId = req.params.challengeId; let challenge = await Challenge.findById(challengeId).exec(); if (!challenge) throw new NotFound(res.t('challengeNotFound')); let group = await Group.getGroup({user, groupId: challenge.groupId, fields: '_id name type privacy', optionalMembership: true}); if (!group || !challenge.canView(user, group)) throw new NotFound(res.t('challengeNotFound')); if (!challenge.canModify(user)) throw new NotAuthorized(res.t('onlyLeaderUpdateChal')); _.merge(challenge, Challenge.sanitizeUpdate(req.body)); let savedChal = await challenge.save(); res.respond(200, savedChal); }, }; // TODO everything here should be moved to a worker // actually even for a worker it's probably just too big and will kill mongo async function _closeChal (challenge, broken = {}) { let winner = broken.winner; let brokenReason = broken.broken; // Delete the challenge await Challenge.remove({_id: challenge._id}).exec(); // Refund the leader if the challenge is closed and the group not the tavern if (challenge.groupId !== 'habitrpg' && brokenReason === 'CHALLENGE_DELETED') { await User.update({_id: challenge.leader}, {$inc: {balance: challenge.prize / 4}}).exec(); } // Update the challengeCount on the group await Group.update({_id: challenge.groupId}, {$inc: {challengeCount: -1}}).exec(); // Award prize to winner and notify if (winner) { winner.achievements.challenges.push(challenge.name); winner.balance += challenge.prize / 4; let savedWinner = await winner.save(); if (savedWinner.preferences.emailNotifications.wonChallenge !== false) { txnEmail(savedWinner, 'won-challenge', [ {name: 'CHALLENGE_NAME', content: challenge.name}, ]); } pushNotify(savedWinner, shared.i18n.t('wonChallenge'), challenge.name); // TODO translate } // Run some operations in the background withouth blocking the thread let backgroundTasks = [ // And it's tasks Tasks.Task.remove({'challenge.id': challenge._id, userId: {$exists: false}}).exec(), // Set the challenge tag to non-challenge status and remove the challenge from the user's challenges User.update({ challenges: challenge._id, 'tags._id': challenge._id, }, { $set: {'tags.$.challenge': false}, $pull: {challenges: challenge._id}, }, {multi: true}).exec(), // Break users' tasks Tasks.Task.update({ 'challenge.id': challenge._id, }, { $set: { 'challenge.broken': brokenReason, 'challenge.winner': winner && winner.profile.name, }, }, {multi: true}).exec(), ]; Q.allSettled(backgroundTasks); // TODO look if allSettled could be useful somewhere else // TODO catch and handle } /** * @api {delete} /challenges/:challengeId Delete a challenge * @apiVersion 3.0.0 * @apiName DeleteChallenge * @apiGroup Challenge * * @apiSuccess {object} empty An empty object */ api.deleteChallenge = { method: 'DELETE', url: '/challenges/:challengeId', middlewares: [authWithHeaders(), cron], async handler (req, res) { let user = res.locals.user; req.checkParams('challengeId', res.t('challengeIdRequired')).notEmpty().isUUID(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let challenge = await Challenge.findOne({_id: req.params.challengeId}).exec(); if (!challenge) throw new NotFound(res.t('challengeNotFound')); if (!challenge.canModify(user)) throw new NotAuthorized(res.t('onlyLeaderDeleteChal')); // Close channel in background, some ops are run in the background without `await`ing await _closeChal(challenge, {broken: 'CHALLENGE_DELETED'}); res.respond(200, {}); }, }; /** * @api {post} /challenges/:challengeId/selectWinner/:winnerId Select winner for challenge * @apiVersion 3.0.0 * @apiName SelectChallengeWinner * @apiGroup Challenge * * @apiSuccess {object} empty An empty object */ api.selectChallengeWinner = { method: 'POST', url: '/challenges/:challengeId/selectWinner/:winnerId', middlewares: [authWithHeaders(), cron], async handler (req, res) { let user = res.locals.user; req.checkParams('challengeId', res.t('challengeIdRequired')).notEmpty().isUUID(); req.checkParams('winnerId', res.t('winnerIdRequired')).notEmpty().isUUID(); let validationErrors = req.validationErrors(); if (validationErrors) throw validationErrors; let challenge = await Challenge.findOne({_id: req.params.challengeId}).exec(); if (!challenge) throw new NotFound(res.t('challengeNotFound')); if (!challenge.canModify(user)) throw new NotAuthorized(res.t('onlyLeaderDeleteChal')); let winner = await User.findOne({_id: req.params.winnerId}).exec(); if (!winner || winner.challenges.indexOf(challenge._id) === -1) throw new NotFound(res.t('winnerNotFound', {userId: req.params.winnerId})); // Close channel in background, some ops are run in the background without `await`ing await _closeChal(challenge, {broken: 'CHALLENGE_CLOSED', winner}); res.respond(200, {}); }, }; export default api;