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

257 lines
5.3 KiB
TypeScript
Raw Normal View History

2019-02-05 04:48:08 +02:00
import $ from 'cafy';
import ID, { transform } from '../../../../misc/cafy-id';
import Note, { packMany } from '../../../../models/note';
2018-11-02 06:47:44 +02:00
import define from '../../define';
2019-01-21 14:51:58 +02:00
import Following from '../../../../models/following';
import { ApiError } from '../../error';
2019-02-22 07:02:56 +02:00
import { getUser } from '../../common/getters';
export const meta = {
desc: {
'ja-JP': '指定したユーザーのタイムラインを取得します。'
},
tags: ['users', 'notes'],
params: {
2018-11-01 20:32:24 +02:00
userId: {
validator: $.type(ID),
2018-11-01 20:32:24 +02:00
transform: transform,
desc: {
2018-11-03 15:49:36 +02:00
'ja-JP': '対象のユーザーのID',
'en-US': 'Target user ID'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
includeReplies: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'リプライを含めるか否か'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
limit: {
2019-02-13 09:33:07 +02:00
validator: $.optional.num.range(1, 100),
default: 10,
desc: {
'ja-JP': '最大数'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
sinceId: {
2019-02-13 09:33:07 +02:00
validator: $.optional.type(ID),
2018-11-01 20:32:24 +02:00
transform: transform,
desc: {
'ja-JP': '指定すると、この投稿を基点としてより新しい投稿を取得します'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
untilId: {
2019-02-13 09:33:07 +02:00
validator: $.optional.type(ID),
2018-11-01 20:32:24 +02:00
transform: transform,
desc: {
'ja-JP': '指定すると、この投稿を基点としてより古い投稿を取得します'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
sinceDate: {
2019-02-13 09:33:07 +02:00
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより新しい投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
untilDate: {
2019-02-13 09:33:07 +02:00
validator: $.optional.num,
desc: {
'ja-JP': '指定した時間を基点としてより古い投稿を取得します。数値は、1970年1月1日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
includeMyRenotes: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': '自分の行ったRenoteを含めるかどうか'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
includeRenotedMyNotes: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされた自分の投稿を含めるかどうか'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
includeLocalRenotes: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
default: true,
desc: {
'ja-JP': 'Renoteされたローカルの投稿を含めるかどうか'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
withFiles: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
default: false,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します'
}
2018-11-01 20:32:24 +02:00
},
2018-11-01 20:32:24 +02:00
mediaOnly: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
default: false,
2019-02-24 21:18:09 +02:00
deprecated: true,
desc: {
'ja-JP': 'true にすると、ファイルが添付された投稿だけ取得します (このパラメータは廃止予定です。代わりに withFiles を使ってください。)'
}
2018-11-01 20:32:24 +02:00
},
2018-10-19 03:20:11 +03:00
2018-11-01 20:32:24 +02:00
fileType: {
2019-02-13 09:33:07 +02:00
validator: $.optional.arr($.str),
2018-10-19 03:20:11 +03:00
desc: {
'ja-JP': '指定された種類のファイルが添付された投稿のみを取得します'
}
2018-11-01 20:32:24 +02:00
},
2019-01-11 01:10:39 +02:00
excludeNsfw: {
2019-02-13 09:33:07 +02:00
validator: $.optional.bool,
2019-01-11 01:10:39 +02:00
default: false,
desc: {
'ja-JP': 'true にすると、NSFW指定されたファイルを除外します(fileTypeが指定されている場合のみ有効)'
}
},
},
2018-03-27 10:51:12 +03:00
res: {
type: 'array',
items: {
type: 'Note',
},
},
errors: {
noSuchUser: {
message: 'No such user.',
code: 'NO_SUCH_USER',
id: '27e494ba-2ac2-48e8-893b-10d4d8c2387b'
}
2016-12-29 00:49:51 +02:00
}
};
2016-12-29 00:49:51 +02:00
export default define(meta, async (ps, me) => {
2016-12-29 00:49:51 +02:00
// Lookup user
2019-02-22 07:02:56 +02:00
const user = await getUser(ps.userId).catch(e => {
if (e.id === '15348ddd-432d-49c2-8a5a-8069753becff') throw new ApiError(meta.errors.noSuchUser);
throw e;
2017-02-22 06:08:33 +02:00
});
2016-12-29 00:49:51 +02:00
2019-01-21 14:51:58 +02:00
const isFollowing = me == null ? false : ((await Following.findOne({
followerId: me._id,
followeeId: user._id
})) != null);
2017-11-14 01:21:19 +02:00
//#region Construct query
2018-11-12 18:17:59 +02:00
const sort = { } as any;
2017-11-14 01:21:19 +02:00
const visibleQuery = me == null ? [{
2019-01-21 14:51:58 +02:00
visibility: { $in: ['public', 'home'] }
}] : [{
2019-01-21 14:51:58 +02:00
visibility: {
$in: isFollowing ? ['public', 'home', 'followers'] : ['public', 'home']
}
}, {
// myself (for specified/private)
userId: me._id
}, {
// to me (for specified)
visibleUserIds: { $in: [ me._id ] }
}];
2016-12-29 00:49:51 +02:00
const query = {
$and: [ {} ],
deletedAt: null,
userId: user._id,
$or: visibleQuery
2017-03-03 00:47:14 +02:00
} as any;
2017-11-14 01:21:19 +02:00
if (ps.sinceId) {
2016-12-29 00:49:51 +02:00
sort._id = 1;
query._id = {
$gt: ps.sinceId
2016-12-29 00:49:51 +02:00
};
} else if (ps.untilId) {
2018-11-12 18:17:59 +02:00
sort._id = -1;
2016-12-29 00:49:51 +02:00
query._id = {
$lt: ps.untilId
2016-12-29 00:49:51 +02:00
};
} else if (ps.sinceDate) {
2018-11-12 18:17:59 +02:00
sort.createdAt = 1;
2018-03-29 08:48:47 +03:00
query.createdAt = {
$gt: new Date(ps.sinceDate)
2017-11-14 01:21:19 +02:00
};
} else if (ps.untilDate) {
2018-11-12 18:17:59 +02:00
sort.createdAt = -1;
2018-03-29 08:48:47 +03:00
query.createdAt = {
$lt: new Date(ps.untilDate)
2017-11-14 01:21:19 +02:00
};
} else {
sort._id = -1;
2016-12-29 00:49:51 +02:00
}
if (!ps.includeReplies) {
2018-03-29 08:48:47 +03:00
query.replyId = null;
2016-12-29 00:49:51 +02:00
}
if (ps.includeMyRenotes === false) {
query.$and.push({
$or: [{
userId: { $ne: user._id }
}, {
renoteId: null
}, {
text: { $ne: null }
}, {
fileIds: { $ne: [] }
}, {
poll: { $ne: null }
}]
});
}
const withFiles = ps.withFiles != null ? ps.withFiles : ps.mediaOnly;
2018-09-05 13:32:46 +03:00
if (withFiles) {
query.fileIds = {
2016-12-29 00:49:51 +02:00
$exists: true,
2018-04-11 11:42:56 +03:00
$ne: []
2016-12-29 00:49:51 +02:00
};
}
2018-10-19 03:20:11 +03:00
if (ps.fileType) {
query.fileIds = { $exists: true, $ne: [] };
query['_files.contentType'] = {
$in: ps.fileType
};
2019-01-11 01:10:39 +02:00
if (ps.excludeNsfw) {
query['_files.metadata.isSensitive'] = {
$ne: true
};
}
2018-10-19 03:20:11 +03:00
}
2017-11-14 01:21:19 +02:00
//#endregion
2016-12-29 00:49:51 +02:00
const notes = await Note.find(query, {
limit: ps.limit,
sort: sort
});
2016-12-29 00:49:51 +02:00
return await packMany(notes, me);
});