misskey/src/models/user.ts

304 lines
6.7 KiB
TypeScript
Raw Normal View History

2017-09-07 21:13:01 +02:00
import * as mongo from 'mongodb';
2018-02-02 00:06:01 +01:00
import deepcopy = require('deepcopy');
import rap from '@prezzemolo/rap';
2018-03-29 13:32:18 +02:00
import db from '../db/mongodb';
2018-02-02 00:06:01 +01:00
import { IPost, pack as packPost } from './post';
import Following from './following';
import Mute from './mute';
2018-03-29 13:32:18 +02:00
import getFriends from '../server/api/common/get-friends';
2018-04-02 06:15:53 +02:00
import config from '../config';
2017-01-17 01:12:33 +01:00
2018-02-02 00:06:01 +01:00
const User = db.get<IUser>('users');
2016-12-28 23:49:51 +01:00
2018-02-02 00:06:01 +01:00
User.createIndex('username');
User.createIndex('account.token');
2016-12-28 23:49:51 +01:00
2018-02-02 00:06:01 +01:00
export default User;
2016-12-28 23:49:51 +01:00
2018-04-01 21:01:34 +02:00
type IUserBase = {
2017-09-07 21:13:01 +02:00
_id: mongo.ObjectID;
2018-03-29 07:48:47 +02:00
createdAt: Date;
deletedAt: Date;
followersCount: number;
followingCount: number;
2017-02-28 15:56:20 +01:00
name: string;
2018-03-29 07:48:47 +02:00
postsCount: number;
driveCapacity: number;
2017-09-07 21:13:01 +02:00
username: string;
2018-03-29 07:48:47 +02:00
usernameLower: string;
avatarId: mongo.ObjectID;
bannerId: mongo.ObjectID;
2017-09-07 21:13:01 +02:00
data: any;
description: string;
2018-03-29 07:48:47 +02:00
latestPost: IPost;
pinnedPostId: mongo.ObjectID;
isSuspended: boolean;
2017-09-07 21:13:01 +02:00
keywords: string[];
2018-04-02 04:14:45 +02:00
host: string;
2018-03-29 07:48:47 +02:00
hostLower: string;
2017-09-07 21:13:01 +02:00
};
2017-10-07 00:23:00 +02:00
2018-04-01 21:48:38 +02:00
export interface ILocalUser extends IUserBase {
host: null;
account: {
keypair: string;
email: string;
links: string[];
password: string;
token: string;
twitter: {
accessToken: string;
accessTokenSecret: string;
userId: string;
screenName: string;
};
line: {
userId: string;
};
profile: {
location: string;
birthday: string; // 'YYYY-MM-DD'
tags: string[];
};
lastUsedAt: Date;
isBot: boolean;
isPro: boolean;
twoFactorSecret: string;
twoFactorEnabled: boolean;
twoFactorTempSecret: string;
clientSettings: any;
settings: any;
};
}
export interface IRemoteUser extends IUserBase {
account: {
inbox: string;
uri: string;
publicKey: {
id: string;
publicKeyPem: string;
};
};
}
2018-04-01 21:01:34 +02:00
2018-04-01 21:52:11 +02:00
export type IUser = ILocalUser | IRemoteUser;
2018-04-01 21:01:34 +02:00
export const isLocalUser = (user: any): user is ILocalUser =>
user.host === null;
export const isRemoteUser = (user: any): user is IRemoteUser =>
!isLocalUser(user);
2018-03-31 12:55:00 +02:00
2018-04-02 04:14:45 +02:00
//#region Validators
2018-04-01 21:52:11 +02:00
export function validateUsername(username: string): boolean {
return typeof username == 'string' && /^[a-zA-Z0-9\-]{3,20}$/.test(username);
}
export function validatePassword(password: string): boolean {
return typeof password == 'string' && password != '';
}
export function isValidName(name: string): boolean {
return typeof name == 'string' && name.length < 30 && name.trim() != '';
}
export function isValidDescription(description: string): boolean {
return typeof description == 'string' && description.length < 500 && description.trim() != '';
}
export function isValidLocation(location: string): boolean {
return typeof location == 'string' && location.length < 50 && location.trim() != '';
}
export function isValidBirthday(birthday: string): boolean {
return typeof birthday == 'string' && /^([0-9]{4})\-([0-9]{2})-([0-9]{2})$/.test(birthday);
}
2018-04-02 04:14:45 +02:00
//#endregion
2018-04-01 21:52:11 +02:00
2017-10-07 00:23:00 +02:00
export function init(user): IUser {
user._id = new mongo.ObjectID(user._id);
2018-03-29 07:48:47 +02:00
user.avatarId = new mongo.ObjectID(user.avatarId);
user.bannerId = new mongo.ObjectID(user.bannerId);
user.pinnedPostId = new mongo.ObjectID(user.pinnedPostId);
2017-10-07 00:34:35 +02:00
return user;
2017-10-07 00:23:00 +02:00
}
2018-02-02 00:06:01 +01:00
/**
* Pack a user for API response
*
* @param user target
* @param me? serializee
* @param options? serialize options
* @return Packed user
*/
export const pack = (
user: string | mongo.ObjectID | IUser,
me?: string | mongo.ObjectID | IUser,
options?: {
detail?: boolean,
includeSecrets?: boolean
}
) => new Promise<any>(async (resolve, reject) => {
const opts = Object.assign({
detail: false,
includeSecrets: false
}, options);
let _user: any;
const fields = opts.detail ? {
} : {
'account.settings': false,
2018-03-29 07:48:47 +02:00
'account.clientSettings': false,
'account.profile': false,
'account.keywords': false,
'account.domains': false
2018-02-02 00:06:01 +01:00
};
// Populate the user if 'user' is ID
if (mongo.ObjectID.prototype.isPrototypeOf(user)) {
_user = await User.findOne({
_id: user
}, { fields });
} else if (typeof user === 'string') {
_user = await User.findOne({
_id: new mongo.ObjectID(user)
}, { fields });
} else {
_user = deepcopy(user);
}
if (!_user) return reject('invalid user arg.');
// Me
const meId: mongo.ObjectID = me
? mongo.ObjectID.prototype.isPrototypeOf(me)
? me as mongo.ObjectID
: typeof me === 'string'
? new mongo.ObjectID(me)
: (me as IUser)._id
: null;
// Rename _id to id
_user.id = _user._id;
delete _user._id;
// Remove needless properties
2018-03-29 07:48:47 +02:00
delete _user.latestPost;
2018-02-02 00:06:01 +01:00
2018-03-27 09:51:12 +02:00
if (!_user.host) {
// Remove private properties
delete _user.account.keypair;
delete _user.account.password;
delete _user.account.token;
2018-03-29 07:48:47 +02:00
delete _user.account.twoFactorTempSecret;
delete _user.account.twoFactorSecret;
delete _user.usernameLower;
2018-03-27 09:51:12 +02:00
if (_user.account.twitter) {
2018-03-29 07:48:47 +02:00
delete _user.account.twitter.accessToken;
delete _user.account.twitter.accessTokenSecret;
2018-03-27 09:51:12 +02:00
}
delete _user.account.line;
// Visible via only the official client
if (!opts.includeSecrets) {
delete _user.account.email;
delete _user.account.settings;
2018-03-29 07:48:47 +02:00
delete _user.account.clientSettings;
2018-03-27 09:51:12 +02:00
}
if (!opts.detail) {
2018-03-29 07:48:47 +02:00
delete _user.account.twoFactorEnabled;
2018-03-27 09:51:12 +02:00
}
2018-02-02 00:06:01 +01:00
}
2018-03-29 07:48:47 +02:00
_user.avatarUrl = _user.avatarId != null
? `${config.drive_url}/${_user.avatarId}`
2018-02-02 00:06:01 +01:00
: `${config.drive_url}/default-avatar.jpg`;
2018-03-29 07:48:47 +02:00
_user.bannerUrl = _user.bannerId != null
? `${config.drive_url}/${_user.bannerId}`
2018-02-02 00:06:01 +01:00
: null;
if (!meId || !meId.equals(_user.id) || !opts.detail) {
2018-03-29 07:48:47 +02:00
delete _user.avatarId;
delete _user.bannerId;
2018-02-02 00:06:01 +01:00
2018-03-29 07:48:47 +02:00
delete _user.driveCapacity;
2018-02-02 00:06:01 +01:00
}
if (meId && !meId.equals(_user.id)) {
// Whether the user is following
2018-03-29 07:48:47 +02:00
_user.isFollowing = (async () => {
2018-02-02 00:06:01 +01:00
const follow = await Following.findOne({
2018-03-29 07:48:47 +02:00
followerId: meId,
followeeId: _user.id
2018-02-02 00:06:01 +01:00
});
return follow !== null;
})();
// Whether the user is followed
2018-03-29 07:48:47 +02:00
_user.isFollowed = (async () => {
2018-02-02 00:06:01 +01:00
const follow2 = await Following.findOne({
2018-03-29 07:48:47 +02:00
followerId: _user.id,
followeeId: meId
2018-02-02 00:06:01 +01:00
});
return follow2 !== null;
})();
// Whether the user is muted
2018-03-29 07:48:47 +02:00
_user.isMuted = (async () => {
2018-02-02 00:06:01 +01:00
const mute = await Mute.findOne({
2018-03-29 07:48:47 +02:00
muterId: meId,
muteeId: _user.id,
deletedAt: { $exists: false }
2018-02-02 00:06:01 +01:00
});
return mute !== null;
})();
}
if (opts.detail) {
2018-03-29 07:48:47 +02:00
if (_user.pinnedPostId) {
2018-02-02 00:06:01 +01:00
// Populate pinned post
2018-03-29 07:48:47 +02:00
_user.pinnedPost = packPost(_user.pinnedPostId, meId, {
2018-02-02 00:06:01 +01:00
detail: true
});
}
if (meId && !meId.equals(_user.id)) {
const myFollowingIds = await getFriends(meId);
// Get following you know count
2018-03-29 07:48:47 +02:00
_user.followingYouKnowCount = Following.count({
followeeId: { $in: myFollowingIds },
followerId: _user.id
2018-02-02 00:06:01 +01:00
});
// Get followers you know count
2018-03-29 07:48:47 +02:00
_user.followersYouKnowCount = Following.count({
followeeId: _user.id,
followerId: { $in: myFollowingIds }
2018-02-02 00:06:01 +01:00
});
}
}
// resolve promises in _user object
_user = await rap(_user);
resolve(_user);
});
/*
function img(url) {
return {
thumbnail: {
large: `${url}`,
medium: '',
small: ''
}
};
}
*/