Sharkey/src/server/api/endpoints/users/followers.ts

133 lines
2.5 KiB
TypeScript
Raw Normal View History

2019-02-05 04:48:08 +02:00
import $ from 'cafy';
import ID, { transform } from '../../../../misc/cafy-id';
2018-11-02 06:47:44 +02:00
import User from '../../../../models/user';
2018-03-29 14:32:18 +03:00
import Following from '../../../../models/following';
import { pack } from '../../../../models/user';
2018-04-19 06:43:25 +03:00
import { getFriendIds } from '../../common/get-friends';
2018-11-02 06:47:44 +02:00
import define from '../../define';
import { ApiError } from '../../error';
2016-12-29 00:49:51 +02:00
2018-11-01 20:32:24 +02:00
export const meta = {
desc: {
'ja-JP': '指定したユーザーのフォロワー一覧を取得します。',
'en-US': 'Get followers of a user.'
},
tags: ['users'],
2018-11-01 20:32:24 +02:00
requireCredential: false,
2016-12-29 00:49:51 +02:00
2018-11-01 20:32:24 +02:00
params: {
userId: {
2019-02-16 03:58:44 +02:00
validator: $.optional.type(ID),
2018-11-01 20:32:24 +02:00
transform: transform,
2018-11-03 15:49:36 +02:00
desc: {
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
2018-11-01 20:32:24 +02:00
},
2016-12-29 00:49:51 +02:00
2019-02-16 03:58:44 +02:00
username: {
validator: $.optional.str
},
host: {
validator: $.optional.nullable.str
},
2018-11-01 20:32:24 +02:00
limit: {
2019-02-13 09:33:07 +02:00
validator: $.optional.num.range(1, 100),
2018-11-01 20:32:24 +02:00
default: 10
},
2016-12-29 00:49:51 +02:00
2018-11-01 20:32:24 +02:00
cursor: {
2019-02-13 09:33:07 +02:00
validator: $.optional.type(ID),
2018-11-01 20:32:24 +02:00
default: null as any,
transform: transform,
},
iknow: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
2018-11-01 20:32:24 +02:00
default: false,
}
},
2019-02-24 12:42:26 +02:00
res: {
type: 'object',
properties: {
users: {
type: 'array',
items: {
type: 'User',
}
},
next: {
type: 'string',
format: 'id',
nullable: true
}
}
},
errors: {
noSuchUser: {
message: 'No such user.',
code: 'NO_SUCH_USER',
id: '27fa5435-88ab-43de-9360-387de88727cd'
}
2018-11-01 20:32:24 +02:00
}
};
export default define(meta, async (ps, me) => {
2019-02-16 03:58:44 +02:00
const q: any = ps.userId != null
? { _id: ps.userId }
: { usernameLower: ps.username.toLowerCase(), host: ps.host };
const user = await User.findOne(q);
2016-12-29 00:49:51 +02:00
if (user === null) {
throw new ApiError(meta.errors.noSuchUser);
2016-12-29 00:49:51 +02:00
}
const query = {
followeeId: user._id
2017-03-03 00:47:14 +02:00
} as any;
2016-12-29 00:49:51 +02:00
// ログインしていてかつ iknow フラグがあるとき
2018-11-01 20:32:24 +02:00
if (me && ps.iknow) {
2016-12-29 00:49:51 +02:00
// Get my friends
2018-04-19 06:43:25 +03:00
const myFriends = await getFriendIds(me._id);
2016-12-29 00:49:51 +02:00
2018-03-29 08:48:47 +03:00
query.followerId = {
2016-12-29 00:49:51 +02:00
$in: myFriends
};
}
// カーソルが指定されている場合
2018-11-01 20:32:24 +02:00
if (ps.cursor) {
2016-12-29 00:49:51 +02:00
query._id = {
2018-11-01 20:32:24 +02:00
$lt: ps.cursor
2016-12-29 00:49:51 +02:00
};
}
// Get followers
const following = await Following
2017-01-17 04:11:22 +02:00
.find(query, {
2018-11-01 20:32:24 +02:00
limit: ps.limit + 1,
2016-12-29 00:49:51 +02:00
sort: { _id: -1 }
2017-01-17 04:11:22 +02:00
});
2016-12-29 00:49:51 +02:00
// 「次のページ」があるかどうか
2018-11-01 20:32:24 +02:00
const inStock = following.length === ps.limit + 1;
2016-12-29 00:49:51 +02:00
if (inStock) {
following.pop();
}
2018-09-12 20:07:03 +03:00
const users = await Promise.all(following.map(f => pack(f.followerId, me, { detail: true })));
2016-12-29 00:49:51 +02:00
return {
2016-12-29 00:49:51 +02:00
users: users,
next: inStock ? following[following.length - 1]._id : null,
};
});