const debug = require('debug')('crowi:models:userGroupRelation'); const mongoose = require('mongoose'); const mongoosePaginate = require('mongoose-paginate'); const ObjectId = mongoose.Schema.Types.ObjectId; /* * define schema */ const schema = new mongoose.Schema({ relatedGroup: { type: ObjectId, ref: 'UserGroup', required: true }, relatedUser: { type: ObjectId, ref: 'User', required: true }, createdAt: { type: Date, default: Date.now, required: true }, }); schema.plugin(mongoosePaginate); /** * UserGroupRelation Class * * @class UserGroupRelation */ class UserGroupRelation { /** * limit items num for pagination * * @readonly * @static * @memberof UserGroupRelation */ static get PAGE_ITEMS() { return 50; } static set crowi(crowi) { this._crowi = crowi; } static get crowi() { return this._crowi; } /** * find all user and group relation * * @static * @returns {Promise} * @memberof UserGroupRelation */ static findAllRelation() { return this .find() .populate('relatedUser') .populate('relatedGroup') .exec(); }; /** * find all user and group relation of UserGroup * * @static * @param {UserGroup} userGroup * @returns {Promise} * @memberof UserGroupRelation */ static findAllRelationForUserGroup(userGroup) { debug('findAllRelationForUserGroup is called', userGroup); var UserGroupRelation = this; return this .find({ relatedGroup: userGroup }) .populate('relatedUser') .exec(); } /** * find all user and group relation of UserGroups * * @static * @param {UserGroup[]} userGroups * @returns {Promise} * @memberof UserGroupRelation */ static findAllRelationForUserGroups(userGroups) { return this .find({ relatedGroup: { $in: userGroups } }) .populate('relatedUser') .exec(); } /** * find all user and group relation of User * * @static * @param {User} user * @returns {Promise} * @memberof UserGroupRelation */ static findAllRelationForUser(user) { return this .find({ relatedUser: user.id }) .populate('relatedGroup') .exec(); } /** * find all entities with pagination * * @see https://github.com/edwardhotchkiss/mongoose-paginate * * @static * @param {UserGroup} userGroup * @param {any} opts mongoose-paginate options object * @returns {Promise} mongoose-paginate result object * @memberof UserGroupRelation */ static findUserGroupRelationsWithPagination(userGroup, opts) { const query = { relatedGroup: userGroup }; const options = Object.assign({}, opts); if (options.page == null) { options.page = 1; } if (options.limit == null) { options.limit = UserGroupRelation.PAGE_ITEMS; } return this.paginate(query, options) .catch((err) => { debug('Error on pagination:', err); }); } /** * find one result by related group id and related user * * @static * @param {string} userGroupId find query param for relatedGroup * @param {User} userData find query param for relatedUser * @returns {Promise} * @memberof UserGroupRelation */ static findByGroupIdAndUser(userGroupId, userData) { const query = { relatedGroup: userGroupId, relatedUser: userData.id } return this .findOne(query) .populate('relatedUser') .populate('relatedGroup') .exec(); } /** * find all "not" related user for UserGroup * * @static * @param {UserGroup} userGroup for find users not related * @returns {Promise} * @memberof UserGroupRelation */ static findUserByNotRelatedGroup(userGroup) { const User = UserGroupRelation.crowi.model('User'); return this.findAllRelationForUserGroup(userGroup) .then((relations) => { const relatedUserIds = relations.map((relation) => { return relation.relatedUser.id; }); const query = { _id: { $nin: relatedUserIds }, status: User.STATUS_ACTIVE }; debug("findUserByNotRelatedGroup ", query); return User.find(query).exec(); }); } /** * get if the user has relation for group * * @static * @param {User} userData * @param {UserGroup} userGroup * @returns {Promise} is user related for group(or not) * @memberof UserGroupRelation */ static isRelatedUserForGroup(userData, userGroup) { const query = { relatedGroup: userGroup.id, relatedUser: userData.id } return this .count(query) .exec() .then((count) => { // return true or false of the relation is exists(not count) return (0 < count); }) .catch((err) => { debug('An Error occured.', err); reject(err); }); } /** * create user and group relation * * @static * @param {UserGroup} userGroup * @param {User} user * @returns {Promise} created relation * @memberof UserGroupRelation */ static createRelation(userGroup, user) { return this.create({ relatedGroup: userGroup.id, relatedUser: user.id }); } /** * remove all relation for UserGroup * * @static * @param {UserGroup} userGroup related group for remove * @returns {Promise} * @memberof UserGroupRelation */ static removeAllByUserGroup(userGroup) { return this.findAllRelationForUserGroup(userGroup) .then((relations) => { if (relations == null) { return; } else { relations.map((relation) => { relation.remove(); }); } }); } /** * remove relation by id * * @static * @param {ObjectId} id * @returns {Promise} * @memberof UserGroupRelation */ static removeById(id) { return this.findById(id) .then((relationData) => { if (relationData == null) { throw new Exception('UserGroupRelation data is not exists. id:', id); } else { relationData.remove(); } }) .catch((err) => { debug('Error on find a removing user-group-relation', err); reject(err); }); } } module.exports = function (crowi) { UserGroupRelation.crowi = crowi; schema.loadClass(UserGroupRelation); return mongoose.model('UserGroupRelation', schema); }