diff options
| author | Marie <github@yuugi.dev> | 2024-10-18 21:03:07 +0000 |
|---|---|---|
| committer | Marie <github@yuugi.dev> | 2024-10-18 21:03:07 +0000 |
| commit | 290bfd2075fa7f26f283bf621842b205d2bb3eb1 (patch) | |
| tree | d29f4a2b00a18efa400fef7501e2215ac6898694 | |
| parent | merge: Free up Usernames after deny/decline (!696) (diff) | |
| parent | chore: update misskey-js (diff) | |
| download | sharkey-290bfd2075fa7f26f283bf621842b205d2bb3eb1.tar.gz sharkey-290bfd2075fa7f26f283bf621842b205d2bb3eb1.tar.bz2 sharkey-290bfd2075fa7f26f283bf621842b205d2bb3eb1.zip | |
merge: Allow logged in users to refresh polls (!686)
View MR for information: https://activitypub.software/TransFem-org/Sharkey/-/merge_requests/686
Closes #743
Approved-by: Hazelnoot <acomputerdog@gmail.com>
Approved-by: dakkar <dakkar@thenautilus.net>
| -rw-r--r-- | packages/backend/src/core/activitypub/models/ApQuestionService.ts | 2 | ||||
| -rw-r--r-- | packages/backend/src/server/api/EndpointsModule.ts | 4 | ||||
| -rw-r--r-- | packages/backend/src/server/api/endpoints.ts | 2 | ||||
| -rw-r--r-- | packages/backend/src/server/api/endpoints/notes/polls/refresh.ts | 98 | ||||
| -rw-r--r-- | packages/frontend/src/components/MkNote.vue | 2 | ||||
| -rw-r--r-- | packages/frontend/src/components/MkNoteDetailed.vue | 2 | ||||
| -rw-r--r-- | packages/frontend/src/components/MkPoll.vue | 17 | ||||
| -rw-r--r-- | packages/frontend/src/components/SkNote.vue | 2 | ||||
| -rw-r--r-- | packages/frontend/src/components/SkNoteDetailed.vue | 2 | ||||
| -rw-r--r-- | packages/misskey-js/etc/misskey-js.api.md | 4 | ||||
| -rw-r--r-- | packages/misskey-js/src/autogen/apiClientJSDoc.ts | 11 | ||||
| -rw-r--r-- | packages/misskey-js/src/autogen/endpoint.ts | 3 | ||||
| -rw-r--r-- | packages/misskey-js/src/autogen/entities.ts | 1 | ||||
| -rw-r--r-- | packages/misskey-js/src/autogen/types.ts | 61 |
14 files changed, 205 insertions, 6 deletions
diff --git a/packages/backend/src/core/activitypub/models/ApQuestionService.ts b/packages/backend/src/core/activitypub/models/ApQuestionService.ts index 73004d10b0..9246398fde 100644 --- a/packages/backend/src/core/activitypub/models/ApQuestionService.ts +++ b/packages/backend/src/core/activitypub/models/ApQuestionService.ts @@ -98,7 +98,7 @@ export class ApQuestionService { const newCount = apChoices.filter(ap => ap.name === choice).at(0)?.replies?.totalItems; if (newCount == null) throw new Error('invalid newCount: ' + newCount); - if (oldCount !== newCount) { + if (oldCount <= newCount) { changed = true; poll.votes[poll.choices.indexOf(choice)] = newCount; } diff --git a/packages/backend/src/server/api/EndpointsModule.ts b/packages/backend/src/server/api/EndpointsModule.ts index 31f96e854f..c9a637261f 100644 --- a/packages/backend/src/server/api/EndpointsModule.ts +++ b/packages/backend/src/server/api/EndpointsModule.ts @@ -300,6 +300,7 @@ import * as ep___notes_localTimeline from './endpoints/notes/local-timeline.js'; import * as ep___notes_mentions from './endpoints/notes/mentions.js'; import * as ep___notes_polls_recommendation from './endpoints/notes/polls/recommendation.js'; import * as ep___notes_polls_vote from './endpoints/notes/polls/vote.js'; +import * as ep___notes_polls_refresh from './endpoints/notes/polls/refresh.js'; import * as ep___notes_reactions from './endpoints/notes/reactions.js'; import * as ep___notes_reactions_create from './endpoints/notes/reactions/create.js'; import * as ep___notes_reactions_delete from './endpoints/notes/reactions/delete.js'; @@ -699,6 +700,7 @@ const $notes_localTimeline: Provider = { provide: 'ep:notes/local-timeline', use const $notes_mentions: Provider = { provide: 'ep:notes/mentions', useClass: ep___notes_mentions.default }; const $notes_polls_recommendation: Provider = { provide: 'ep:notes/polls/recommendation', useClass: ep___notes_polls_recommendation.default }; const $notes_polls_vote: Provider = { provide: 'ep:notes/polls/vote', useClass: ep___notes_polls_vote.default }; +const $notes_polls_refresh: Provider = { provide: 'ep:notes/polls/refresh', useClass: ep___notes_polls_refresh.default }; const $notes_reactions: Provider = { provide: 'ep:notes/reactions', useClass: ep___notes_reactions.default }; const $notes_reactions_create: Provider = { provide: 'ep:notes/reactions/create', useClass: ep___notes_reactions_create.default }; const $notes_reactions_delete: Provider = { provide: 'ep:notes/reactions/delete', useClass: ep___notes_reactions_delete.default }; @@ -1102,6 +1104,7 @@ const $reversi_verify: Provider = { provide: 'ep:reversi/verify', useClass: ep__ $notes_mentions, $notes_polls_recommendation, $notes_polls_vote, + $notes_polls_refresh, $notes_reactions, $notes_reactions_create, $notes_reactions_delete, @@ -1498,6 +1501,7 @@ const $reversi_verify: Provider = { provide: 'ep:reversi/verify', useClass: ep__ $notes_mentions, $notes_polls_recommendation, $notes_polls_vote, + $notes_polls_refresh, $notes_reactions, $notes_reactions_create, $notes_reactions_delete, diff --git a/packages/backend/src/server/api/endpoints.ts b/packages/backend/src/server/api/endpoints.ts index 8be9854b15..a88bed8e7a 100644 --- a/packages/backend/src/server/api/endpoints.ts +++ b/packages/backend/src/server/api/endpoints.ts @@ -306,6 +306,7 @@ import * as ep___notes_localTimeline from './endpoints/notes/local-timeline.js'; import * as ep___notes_mentions from './endpoints/notes/mentions.js'; import * as ep___notes_polls_recommendation from './endpoints/notes/polls/recommendation.js'; import * as ep___notes_polls_vote from './endpoints/notes/polls/vote.js'; +import * as ep___notes_polls_refresh from './endpoints/notes/polls/refresh.js'; import * as ep___notes_reactions from './endpoints/notes/reactions.js'; import * as ep___notes_reactions_create from './endpoints/notes/reactions/create.js'; import * as ep___notes_reactions_delete from './endpoints/notes/reactions/delete.js'; @@ -703,6 +704,7 @@ const eps = [ ['notes/mentions', ep___notes_mentions], ['notes/polls/recommendation', ep___notes_polls_recommendation], ['notes/polls/vote', ep___notes_polls_vote], + ['notes/polls/refresh', ep___notes_polls_refresh], ['notes/reactions', ep___notes_reactions], ['notes/reactions/create', ep___notes_reactions_create], ['notes/reactions/delete', ep___notes_reactions_delete], diff --git a/packages/backend/src/server/api/endpoints/notes/polls/refresh.ts b/packages/backend/src/server/api/endpoints/notes/polls/refresh.ts new file mode 100644 index 0000000000..b96691f894 --- /dev/null +++ b/packages/backend/src/server/api/endpoints/notes/polls/refresh.ts @@ -0,0 +1,98 @@ +/* + * SPDX-FileCopyrightText: marie and sharkey-project + * SPDX-License-Identifier: AGPL-3.0-only + */ + +import { Injectable } from '@nestjs/common'; +import { Endpoint } from '@/server/api/endpoint-base.js'; +import { GetterService } from '@/server/api/GetterService.js'; +import { UserBlockingService } from '@/core/UserBlockingService.js'; +import { ApQuestionService } from '@/core/activitypub/models/ApQuestionService.js'; +import { NoteEntityService } from '@/core/entities/NoteEntityService.js'; +import { ApiError } from '../../../error.js'; + +export const meta = { + tags: ['notes'], + + requireCredential: true, + + prohibitMoved: true, + + kind: 'read:federation', + + errors: { + noSuchNote: { + message: 'No such note.', + code: 'NO_SUCH_NOTE', + id: 'ecafbd2e-c283-4d6d-aecb-1a0a33b75396', + }, + + noPoll: { + message: 'The note does not attach a poll.', + code: 'NO_POLL', + id: '5f979967-52d9-4314-a911-1c673727f92f', + }, + + noUri: { + message: 'The note has no URI defined.', + code: 'INVALID_URI', + id: 'e0cc9a04-f2e8-41e4-a5f1-4127293260ca', + }, + + youHaveBeenBlocked: { + message: 'You cannot refresh this poll because you have been blocked by this user.', + code: 'YOU_HAVE_BEEN_BLOCKED', + id: '85a5377e-b1e9-4617-b0b9-5bea73331e49', + }, + }, +} as const; + +export const paramDef = { + type: 'object', + properties: { + noteId: { type: 'string', format: 'misskey:id' }, + }, + required: ['noteId'], +} as const; + +// TODO: ロジックをサービスに切り出す + +@Injectable() +export default class extends Endpoint<typeof meta, typeof paramDef> { // eslint-disable-line import/no-default-export + constructor( + private getterService: GetterService, + private userBlockingService: UserBlockingService, + private apQuestionService: ApQuestionService, + private noteEntityService: NoteEntityService, + ) { + super(meta, paramDef, async (ps, me) => { + // Get note + const note = await this.getterService.getNote(ps.noteId).catch(err => { + if (err.id === '9725d0ce-ba28-4dde-95a7-2cbb2c15de24') throw new ApiError(meta.errors.noSuchNote); + throw err; + }); + + if (!note.hasPoll) { + throw new ApiError(meta.errors.noPoll); + } + + // Check blocking + if (note.userId !== me.id) { + const blocked = await this.userBlockingService.checkBlocked(note.userId, me.id); + if (blocked) { + throw new ApiError(meta.errors.youHaveBeenBlocked); + } + } + + if (!note.uri) { + throw new ApiError(meta.errors.noUri); + } + + await this.apQuestionService.updateQuestion(note.uri); + + return await this.noteEntityService.pack(note, me, { + detail: true, + }); + }); + } +} diff --git a/packages/frontend/src/components/MkNote.vue b/packages/frontend/src/components/MkNote.vue index edae1e91b2..beaf9bc52b 100644 --- a/packages/frontend/src/components/MkNote.vue +++ b/packages/frontend/src/components/MkNote.vue @@ -94,7 +94,7 @@ SPDX-License-Identifier: AGPL-3.0-only <div v-if="appearNote.files && appearNote.files.length > 0"> <MkMediaList ref="galleryEl" :mediaList="appearNote.files" @click.stop/> </div> - <MkPoll v-if="appearNote.poll" :noteId="appearNote.id" :poll="appearNote.poll" :class="$style.poll" @click.stop/> + <MkPoll v-if="appearNote.poll" :noteId="appearNote.id" :poll="appearNote.poll" :local="!appearNote.user.host" :class="$style.poll" @click.stop/> <div v-if="isEnabledUrlPreview"> <MkUrlPreview v-for="url in urls" :key="url" :url="url" :compact="true" :detail="false" :class="$style.urlPreview" @click.stop/> </div> diff --git a/packages/frontend/src/components/MkNoteDetailed.vue b/packages/frontend/src/components/MkNoteDetailed.vue index 123e94c3e0..508ea18153 100644 --- a/packages/frontend/src/components/MkNoteDetailed.vue +++ b/packages/frontend/src/components/MkNoteDetailed.vue @@ -100,7 +100,7 @@ SPDX-License-Identifier: AGPL-3.0-only <div v-if="appearNote.files && appearNote.files.length > 0"> <MkMediaList ref="galleryEl" :mediaList="appearNote.files"/> </div> - <MkPoll v-if="appearNote.poll" ref="pollViewer" :noteId="appearNote.id" :poll="appearNote.poll" :class="$style.poll"/> + <MkPoll v-if="appearNote.poll" ref="pollViewer" :noteId="appearNote.id" :poll="appearNote.poll" :local="!appearNote.user.host" :class="$style.poll"/> <div v-if="isEnabledUrlPreview"> <MkUrlPreview v-for="url in urls" :key="url" :url="url" :compact="true" :detail="true" style="margin-top: 6px;"/> </div> diff --git a/packages/frontend/src/components/MkPoll.vue b/packages/frontend/src/components/MkPoll.vue index 393ac4efba..4d893df39d 100644 --- a/packages/frontend/src/components/MkPoll.vue +++ b/packages/frontend/src/components/MkPoll.vue @@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-only <template> <div :class="{ [$style.done]: closed || isVoted }"> <ul :class="$style.choices"> - <li v-for="(choice, i) in poll.choices" :key="i" :class="$style.choice" @click="vote(i)"> + <li v-for="(choice, i) in props.poll.choices" :key="i" :class="$style.choice" @click="vote(i)"> <div :class="$style.bg" :style="{ 'width': `${showResult ? (choice.votes / total * 100) : 0}%` }"></div> <span :class="$style.fg"> <template v-if="choice.isVoted"><i class="ti ti-check" style="margin-right: 4px; color: var(--accent);"></i></template> @@ -24,6 +24,8 @@ SPDX-License-Identifier: AGPL-3.0-only <span v-if="isVoted">{{ i18n.ts._poll.voted }}</span> <span v-else-if="closed">{{ i18n.ts._poll.closed }}</span> <span v-if="remaining > 0"> · {{ timer }}</span> + <span v-if="!closed && $i && !props.local"> · </span> + <a v-if="!closed && $i && !props.local" style="color: inherit;" @click="refreshVotes()">{{ i18n.ts.reload }}</a> </p> </div> </template> @@ -39,11 +41,13 @@ import { i18n } from '@/i18n.js'; import { host } from '@/config.js'; import { useInterval } from '@/scripts/use-interval.js'; import type { OpenOnRemoteOptions } from '@/scripts/please-login.js'; +import { $i } from '@/account.js'; const props = defineProps<{ noteId: string; poll: NonNullable<Misskey.entities.Note['poll']>; readOnly?: boolean; + local?: boolean; }>(); const remaining = ref(-1); @@ -108,6 +112,17 @@ const vote = async (id) => { }); if (!showResult.value) showResult.value = !props.poll.multiple; }; + +const refreshVotes = async () => { + pleaseLogin(undefined, pleaseLoginContext.value); + + if (props.readOnly || closed.value) return; + await misskeyApi('notes/polls/refresh', { + noteId: props.noteId, + // Sadly due to being in the same component and the poll being a prop we require to break Vue's recommendation of not mutating the prop to update it. + // eslint-disable-next-line vue/no-mutating-props + }).then((res: any) => res.poll ? props.poll.choices = res.poll.choices : null ); +}; </script> <style lang="scss" module> diff --git a/packages/frontend/src/components/SkNote.vue b/packages/frontend/src/components/SkNote.vue index 3d5c5f5fae..382ee9541a 100644 --- a/packages/frontend/src/components/SkNote.vue +++ b/packages/frontend/src/components/SkNote.vue @@ -96,7 +96,7 @@ SPDX-License-Identifier: AGPL-3.0-only <div v-if="appearNote.files && appearNote.files.length > 0"> <MkMediaList ref="galleryEl" :mediaList="appearNote.files" @click.stop/> </div> - <MkPoll v-if="appearNote.poll" :noteId="appearNote.id" :poll="appearNote.poll" :class="$style.poll" @click.stop/> + <MkPoll v-if="appearNote.poll" :noteId="appearNote.id" :poll="appearNote.poll" :local="!appearNote.user.host" :class="$style.poll" @click.stop/> <div v-if="isEnabledUrlPreview"> <MkUrlPreview v-for="url in urls" :key="url" :url="url" :compact="true" :detail="false" :class="$style.urlPreview" @click.stop/> </div> diff --git a/packages/frontend/src/components/SkNoteDetailed.vue b/packages/frontend/src/components/SkNoteDetailed.vue index 5b85e21bac..3e1f6f729d 100644 --- a/packages/frontend/src/components/SkNoteDetailed.vue +++ b/packages/frontend/src/components/SkNoteDetailed.vue @@ -108,7 +108,7 @@ SPDX-License-Identifier: AGPL-3.0-only <div v-if="appearNote.files && appearNote.files.length > 0"> <MkMediaList ref="galleryEl" :mediaList="appearNote.files"/> </div> - <MkPoll v-if="appearNote.poll" ref="pollViewer" :noteId="appearNote.id" :poll="appearNote.poll" :class="$style.poll"/> + <MkPoll v-if="appearNote.poll" ref="pollViewer" :noteId="appearNote.id" :poll="appearNote.poll" :local="!appearNote.user.host" :class="$style.poll"/> <div v-if="isEnabledUrlPreview"> <MkUrlPreview v-for="url in urls" :key="url" :url="url" :compact="true" :detail="true" style="margin-top: 6px;"/> </div> diff --git a/packages/misskey-js/etc/misskey-js.api.md b/packages/misskey-js/etc/misskey-js.api.md index daaa288fd9..8b3c56f1db 100644 --- a/packages/misskey-js/etc/misskey-js.api.md +++ b/packages/misskey-js/etc/misskey-js.api.md @@ -1663,6 +1663,7 @@ declare namespace entities { NotesPollsRecommendationRequest, NotesPollsRecommendationResponse, NotesPollsVoteRequest, + NotesPollsRefreshRequest, NotesReactionsRequest, NotesReactionsResponse, NotesReactionsCreateRequest, @@ -2705,6 +2706,9 @@ type NotesPollsRecommendationRequest = operations['notes___polls___recommendatio type NotesPollsRecommendationResponse = operations['notes___polls___recommendation']['responses']['200']['content']['application/json']; // @public (undocumented) +type NotesPollsRefreshRequest = operations['notes___polls___refresh']['requestBody']['content']['application/json']; + +// @public (undocumented) type NotesPollsVoteRequest = operations['notes___polls___vote']['requestBody']['content']['application/json']; // @public (undocumented) diff --git a/packages/misskey-js/src/autogen/apiClientJSDoc.ts b/packages/misskey-js/src/autogen/apiClientJSDoc.ts index 6ea8e83277..e0815f70cc 100644 --- a/packages/misskey-js/src/autogen/apiClientJSDoc.ts +++ b/packages/misskey-js/src/autogen/apiClientJSDoc.ts @@ -3287,6 +3287,17 @@ declare module '../api.js' { /** * No description provided. * + * **Credential required**: *Yes* / **Permission**: *read:federation* + */ + request<E extends 'notes/polls/refresh', P extends Endpoints[E]['req']>( + endpoint: E, + params: P, + credential?: string | null, + ): Promise<SwitchCaseResponseType<E, P>>; + + /** + * No description provided. + * * **Credential required**: *No* */ request<E extends 'notes/reactions', P extends Endpoints[E]['req']>( diff --git a/packages/misskey-js/src/autogen/endpoint.ts b/packages/misskey-js/src/autogen/endpoint.ts index 35bd6de8a2..0e58d2fc4e 100644 --- a/packages/misskey-js/src/autogen/endpoint.ts +++ b/packages/misskey-js/src/autogen/endpoint.ts @@ -438,6 +438,7 @@ import type { NotesPollsRecommendationRequest, NotesPollsRecommendationResponse, NotesPollsVoteRequest, + NotesPollsRefreshRequest, NotesReactionsRequest, NotesReactionsResponse, NotesReactionsCreateRequest, @@ -888,6 +889,7 @@ export type Endpoints = { 'notes/mentions': { req: NotesMentionsRequest; res: NotesMentionsResponse }; 'notes/polls/recommendation': { req: NotesPollsRecommendationRequest; res: NotesPollsRecommendationResponse }; 'notes/polls/vote': { req: NotesPollsVoteRequest; res: EmptyResponse }; + 'notes/polls/refresh': { req: NotesPollsRefreshRequest; res: EmptyResponse }; 'notes/reactions': { req: NotesReactionsRequest; res: NotesReactionsResponse }; 'notes/reactions/create': { req: NotesReactionsCreateRequest; res: EmptyResponse }; 'notes/reactions/delete': { req: NotesReactionsDeleteRequest; res: EmptyResponse }; @@ -1286,6 +1288,7 @@ export const endpointReqTypes: Record<keyof Endpoints, 'application/json' | 'mul 'notes/mentions': 'application/json', 'notes/polls/recommendation': 'application/json', 'notes/polls/vote': 'application/json', + 'notes/polls/refresh': 'application/json', 'notes/reactions': 'application/json', 'notes/reactions/create': 'application/json', 'notes/reactions/delete': 'application/json', diff --git a/packages/misskey-js/src/autogen/entities.ts b/packages/misskey-js/src/autogen/entities.ts index 53d57696d2..2073425588 100644 --- a/packages/misskey-js/src/autogen/entities.ts +++ b/packages/misskey-js/src/autogen/entities.ts @@ -441,6 +441,7 @@ export type NotesMentionsResponse = operations['notes___mentions']['responses'][ export type NotesPollsRecommendationRequest = operations['notes___polls___recommendation']['requestBody']['content']['application/json']; export type NotesPollsRecommendationResponse = operations['notes___polls___recommendation']['responses']['200']['content']['application/json']; export type NotesPollsVoteRequest = operations['notes___polls___vote']['requestBody']['content']['application/json']; +export type NotesPollsRefreshRequest = operations['notes___polls___refresh']['requestBody']['content']['application/json']; export type NotesReactionsRequest = operations['notes___reactions']['requestBody']['content']['application/json']; export type NotesReactionsResponse = operations['notes___reactions']['responses']['200']['content']['application/json']; export type NotesReactionsCreateRequest = operations['notes___reactions___create']['requestBody']['content']['application/json']; diff --git a/packages/misskey-js/src/autogen/types.ts b/packages/misskey-js/src/autogen/types.ts index 8800bb7252..37c6c014e7 100644 --- a/packages/misskey-js/src/autogen/types.ts +++ b/packages/misskey-js/src/autogen/types.ts @@ -2845,6 +2845,15 @@ export type paths = { */ post: operations['notes___polls___vote']; }; + '/notes/polls/refresh': { + /** + * notes/polls/refresh + * @description No description provided. + * + * **Credential required**: *Yes* / **Permission**: *read:federation* + */ + post: operations['notes___polls___refresh']; + }; '/notes/reactions': { /** * notes/reactions @@ -22868,6 +22877,58 @@ export type operations = { }; }; /** + * notes/polls/refresh + * @description No description provided. + * + * **Credential required**: *Yes* / **Permission**: *read:federation* + */ + notes___polls___refresh: { + requestBody: { + content: { + 'application/json': { + /** Format: misskey:id */ + noteId: string; + }; + }; + }; + responses: { + /** @description OK (without any results) */ + 204: { + content: never; + }; + /** @description Client error */ + 400: { + content: { + 'application/json': components['schemas']['Error']; + }; + }; + /** @description Authentication error */ + 401: { + content: { + 'application/json': components['schemas']['Error']; + }; + }; + /** @description Forbidden error */ + 403: { + content: { + 'application/json': components['schemas']['Error']; + }; + }; + /** @description I'm Ai */ + 418: { + content: { + 'application/json': components['schemas']['Error']; + }; + }; + /** @description Internal server error */ + 500: { + content: { + 'application/json': components['schemas']['Error']; + }; + }; + }; + }; + /** * notes/reactions * @description No description provided. * |