feat: Add option to link an external registration provider for events

Signed-off-by: Thomas Citharel <tcit@tcit.fr>

js/src/components/Event/EventActionSection.vue

@@ -1,7 +1,13 @@
 <template>
   <div class="">
+    <external-participation-button
+      v-if="event && event.joinOptions === EventJoinOptions.EXTERNAL"
+      :event="event"
+      :current-actor="currentActor"
+    />
+
     <participation-section
-      v-if="event && anonymousParticipationConfig"
+      v-else-if="event && anonymousParticipationConfig"
       :participation="participations[0]"
       :event="event"
       :anonymousParticipation="anonymousParticipation"
@@ -15,7 +21,10 @@
       @cancel-anonymous-participation="cancelAnonymousParticipation"
     />
     <div class="flex flex-col gap-1 mt-1">
-      <p class="inline-flex gap-2 ml-auto">
+      <p
+        class="inline-flex gap-2 ml-auto"
+        v-if="event.joinOptions !== EventJoinOptions.EXTERNAL"
+      >
         <TicketConfirmationOutline />
         <router-link
           class="participations-link"
@@ -349,6 +358,7 @@ import { useMutation } from "@vue/apollo-composable";
 import { useCreateReport } from "@/composition/apollo/report";
 import { useDeleteEvent } from "@/composition/apollo/event";
 import { useProgrammatic } from "@oruga-ui/oruga-next";
+import ExternalParticipationButton from "./ExternalParticipationButton.vue";
 
 const ShareEventModal = defineAsyncComponent(
   () => import("@/components/Event/ShareEventModal.vue")

js/src/components/Event/ExternalParticipationButton.vue

@@ -0,0 +1,30 @@
+<template>
+  <o-button
+    tag="a"
+    :href="
+      event.externalParticipationUrl
+        ? encodeURI(`${event.externalParticipationUrl}?uuid=${event.uuid}`)
+        : '#'
+    "
+    rel="noopener ugc"
+    target="_blank"
+    :disabled="!event.externalParticipationUrl"
+    icon-right="OpenInNew"
+  >
+    {{ t("Go to booking") }}
+  </o-button>
+</template>
+
+<script lang="ts" setup>
+import { computed } from "vue";
+import { IEvent } from "../../types/event.model";
+import { useI18n } from "vue-i18n";
+
+const { t } = useI18n({ useScope: "global" });
+
+const props = defineProps<{
+  event: IEvent;
+}>();
+
+const event = computed(() => props.event);
+</script>

js/src/graphql/event.ts

@@ -21,6 +21,7 @@ const FULL_EVENT_FRAGMENT = gql`
     status
     visibility
     joinOptions
+    externalParticipationUrl
     draft
     language
     category
@@ -121,6 +122,7 @@ export const FETCH_EVENT_BASIC = gql`
       id
       uuid
       joinOptions
+      externalParticipationUrl
       participantStats {
         going
         notApproved
@@ -199,6 +201,7 @@ export const CREATE_EVENT = gql`
     $status: EventStatus
     $visibility: EventVisibility
     $joinOptions: EventJoinOptions
+    $externalParticipationUrl: String
     $draft: Boolean
     $tags: [String]
     $picture: MediaInput
@@ -220,6 +223,7 @@ export const CREATE_EVENT = gql`
       status: $status
       visibility: $visibility
       joinOptions: $joinOptions
+      externalParticipationUrl: $externalParticipationUrl
       draft: $draft
       tags: $tags
       picture: $picture
@@ -247,6 +251,7 @@ export const EDIT_EVENT = gql`
     $status: EventStatus
     $visibility: EventVisibility
     $joinOptions: EventJoinOptions
+    $externalParticipationUrl: String
     $draft: Boolean
     $tags: [String]
     $picture: MediaInput
@@ -269,6 +274,7 @@ export const EDIT_EVENT = gql`
       status: $status
       visibility: $visibility
       joinOptions: $joinOptions
+      externalParticipationUrl: $externalParticipationUrl
       draft: $draft
       tags: $tags
       picture: $picture

js/src/i18n/en_US.json

@@ -1605,5 +1605,9 @@
   "Reported by an unknown actor": "Reported by an unknown actor",
   "Reported at": "Reported at",
   "Updated at": "Updated at",
-  "Suspend the profile?": "Suspend the profile?"
+  "Suspend the profile?": "Suspend the profile?",
+  "Go to booking": "Go to booking",
+  "External registration": "External registration",
+  "I want to manage the registration with an external provider": "I want to manage the registration with an external provider",
+  "External provider URL": "External provider URL"
 }

js/src/i18n/fr_FR.json

@@ -1601,5 +1601,9 @@
   "{username} was invited to {group}": "{username} a été invité à {group}",
   "{user}'s follow request was accepted": "La demande de suivi de {user} a été acceptée",
   "{user}'s follow request was rejected": "La demande de suivi de {user} a été rejetée",
-  "© The OpenStreetMap Contributors": "© Les Contributeur⋅ices OpenStreetMap"
+  "© The OpenStreetMap Contributors": "© Les Contributeur⋅ices OpenStreetMap",
+  "Go to booking": "Aller à la réservation",
+  "External registration": "Inscription externe",
+  "I want to manage the registration with an external provider": "Je souhaite gérer l'enregistrement auprès d'un fournisseur externe",
+  "External provider URL": "URL du fournisseur externe"
 }

js/src/types/enums.ts

@@ -64,6 +64,7 @@ export enum EventJoinOptions {
   FREE = "FREE",
   RESTRICTED = "RESTRICTED",
   INVITE = "INVITE",
+  EXTERNAL = "EXTERNAL",
 }
 
 export enum EventVisibilityJoinOptions {

js/src/types/event.model.ts

@@ -43,6 +43,7 @@ interface IEventEditJSON {
   status: EventStatus;
   visibility: EventVisibility;
   joinOptions: EventJoinOptions;
+  externalParticipationUrl: string | null;
   draft: boolean;
   picture?: IMedia | { mediaId: string } | null;
   attributedToId: string | null;
@@ -72,6 +73,7 @@ export interface IEvent {
   status: EventStatus;
   visibility: EventVisibility;
   joinOptions: EventJoinOptions;
+  externalParticipationUrl: string | null;
   draft: boolean;
 
   picture: IMedia | null;
@@ -132,6 +134,8 @@ export class EventModel implements IEvent {
 
   joinOptions = EventJoinOptions.FREE;
 
+  externalParticipationUrl: string | null = null;
+
   status = EventStatus.CONFIRMED;
 
   draft = true;
@@ -197,6 +201,7 @@ export class EventModel implements IEvent {
     this.status = hash.status;
     this.visibility = hash.visibility;
     this.joinOptions = hash.joinOptions;
+    this.externalParticipationUrl = hash.externalParticipationUrl;
     this.draft = hash.draft;
 
     this.picture = hash.picture;
@@ -248,6 +253,7 @@ export function toEditJSON(event: IEditableEvent): IEventEditJSON {
     category: event.category,
     visibility: event.visibility,
     joinOptions: event.joinOptions,
+    externalParticipationUrl: event.externalParticipationUrl,
     draft: event.draft,
     tags: event.tags.map((t) => t.title),
     onlineAddress: event.onlineAddress,

js/src/views/Event/EditView.vue

@@ -246,8 +246,25 @@
           </o-radio>
         </div>-->
 
+        <o-field :label="t('External registration')">
+          <o-switch v-model="externalParticipation">
+            {{
+              t("I want to manage the registration with an external provider")
+            }}
+          </o-switch>
+        </o-field>
+
+        <o-field v-if="externalParticipation" :label="t('URL')">
+          <o-input
+            icon="link"
+            type="url"
+            v-model="event.externalParticipationUrl"
+            :placeholder="t('External provider URL')"
+          />
+        </o-field>
+
         <o-field
-          v-if="anonymousParticipationConfig?.allowed"
+          v-if="anonymousParticipationConfig?.allowed && !externalParticipation"
           :label="t('Anonymous participations')"
         >
           <o-switch v-model="eventOptions.anonymousParticipation">
@@ -268,19 +285,22 @@
           </o-switch>
         </o-field>
 
-        <o-field :label="t('Participation approval')">
+        <o-field
+          :label="t('Participation approval')"
+          v-show="!externalParticipation"
+        >
           <o-switch v-model="needsApproval">{{
             t("I want to approve every participation request")
           }}</o-switch>
         </o-field>
 
-        <o-field :label="t('Number of places')">
+        <o-field :label="t('Number of places')" v-show="!externalParticipation">
           <o-switch v-model="limitedPlaces">{{
             t("Limited number of places")
           }}</o-switch>
         </o-field>
 
-        <div class="" v-if="limitedPlaces">
+        <div class="" v-if="limitedPlaces && !externalParticipation">
           <o-field :label="t('Number of places')" label-for="number-of-places">
             <o-input
               type="number"
@@ -1308,6 +1328,19 @@ const orderedCategories = computed(() => {
   if (!eventCategories.value) return undefined;
   return sortBy(eventCategories.value, ["label"]);
 });
+
+const externalParticipation = computed({
+  get() {
+    return event.value?.joinOptions === EventJoinOptions.EXTERNAL;
+  },
+  set(newValue) {
+    if (newValue === true) {
+      event.value.joinOptions = EventJoinOptions.EXTERNAL;
+    } else {
+      event.value.joinOptions = EventJoinOptions.FREE;
+    }
+  },
+});
 </script>
 
 <style lang="scss">

lib/federation/activity_stream/converter/event.ex

@@ -78,6 +78,7 @@ defmodule Mobilizon.Federation.ActivityStream.Converter.Event do
           visibility: visibility,
           join_options: Map.get(object, "joinMode", "free"),
           local: is_local?(object["id"]),
+          external_participation_url: object["externalParticipationUrl"],
           options: options,
           metadata: metadata,
           status: object |> Map.get("ical:status", "CONFIRMED") |> String.downcase(),
@@ -129,6 +130,7 @@ defmodule Mobilizon.Federation.ActivityStream.Converter.Event do
       "mediaType" => "text/html",
       "startTime" => event.begins_on |> shift_tz(event.options.timezone) |> date_to_string(),
       "joinMode" => to_string(event.join_options),
+      "externalParticipationUrl" => event.external_participation_url,
       "endTime" => event.ends_on |> shift_tz(event.options.timezone) |> date_to_string(),
       "tag" => event.tags |> build_tags(),
       "maximumAttendeeCapacity" => event.options.maximum_attendee_capacity,

lib/graphql/schema/event.ex

@@ -35,6 +35,7 @@ defmodule Mobilizon.GraphQL.Schema.EventType do
     field(:status, :event_status, description: "Status of the event")
     field(:visibility, :event_visibility, description: "The event's visibility")
     field(:join_options, :event_join_options, description: "The event's visibility")
+    field(:external_participation_url, :string, description: "External URL for participation")
 
     field(:picture, :media,
       description: "The event's picture",
@@ -130,6 +131,7 @@ defmodule Mobilizon.GraphQL.Schema.EventType do
     value(:free, description: "Anyone can join and is automatically accepted")
     value(:restricted, description: "Manual acceptation")
     value(:invite, description: "Participants must be invited")
+    value(:external, description: "External registration")
   end
 
   @desc "The list of possible options for the event's status"
@@ -398,6 +400,8 @@ defmodule Mobilizon.GraphQL.Schema.EventType do
         description: "The event's options to join"
       )
 
+      arg(:external_participation_url, :string, description: "External URL for participation")
+
       arg(:tags, list_of(:string),
         default_value: [],
         description: "The list of tags associated to the event"
@@ -469,6 +473,8 @@ defmodule Mobilizon.GraphQL.Schema.EventType do
         description: "The event's options to join"
       )
 
+      arg(:external_participation_url, :string, description: "External URL for participation")
+
       arg(:tags, list_of(:string), description: "The list of tags associated to the event")
 
       arg(:picture, :media_input,

lib/mobilizon/events/event.ex

@@ -47,6 +47,7 @@ defmodule Mobilizon.Events.Event do
           draft: boolean,
           visibility: atom(),
           join_options: atom(),
+          external_participation_url: String.t(),
           publish_at: DateTime.t() | nil,
           uuid: Ecto.UUID.t(),
           online_address: String.t() | nil,
@@ -81,6 +82,7 @@ defmodule Mobilizon.Events.Event do
     :local,
     :visibility,
     :join_options,
+    :external_participation_url,
     :publish_at,
     :online_address,
     :phone_address,
@@ -105,6 +107,7 @@ defmodule Mobilizon.Events.Event do
     field(:draft, :boolean, default: false)
     field(:visibility, EventVisibility, default: :public)
     field(:join_options, JoinOptions, default: :free)
+    field(:external_participation_url, :string)
     field(:publish_at, :utc_datetime)
     field(:uuid, Ecto.UUID, default: Ecto.UUID.generate())
     field(:online_address, :string)

lib/mobilizon/events/events.ex

@@ -46,7 +46,8 @@ defmodule Mobilizon.Events do
   defenum(JoinOptions, :join_options, [
     :free,
     :restricted,
-    :invite
+    :invite,
+    :external
   ])
 
   defenum(EventStatus, :event_status, [

priv/repo/migrations/20230901160000_add_external_url_for_events.exs

@@ -0,0 +1,33 @@
+defmodule Mobilizon.Storage.Repo.Migrations.AddExternalUrlForEvents do
+  use Ecto.Migration
+  alias Mobilizon.Events.JoinOptions
+
+  def up do
+    alter table(:events) do
+      add(:external_participation_url, :string)
+    end
+
+    reset_join_options_enum()
+  end
+
+  def down do
+    alter table(:events) do
+      remove(:external_participation_url, :string)
+    end
+
+    reset_join_options_enum()
+  end
+
+  defp reset_join_options_enum do
+    execute("ALTER TABLE events ALTER COLUMN join_options TYPE VARCHAR USING join_options::text")
+    execute("ALTER TABLE events ALTER COLUMN join_options DROP DEFAULT")
+    JoinOptions.drop_type()
+    JoinOptions.create_type()
+
+    execute(
+      "ALTER TABLE events ALTER COLUMN join_options TYPE join_options USING join_options::join_options"
+    )
+
+    execute("ALTER TABLE events ALTER COLUMN join_options SET DEFAULT 'free'::join_options")
+  end
+end

schema.graphql

@@ -1551,6 +1551,9 @@ type RootMutationType {
     "The event's options to join"
     joinOptions: EventJoinOptions
 
+    "External URL for participation"
+    externalParticipationUrl: String
+
     "The list of tags associated to the event"
     tags: [String]
 
@@ -1620,6 +1623,9 @@ type RootMutationType {
     "The event's options to join"
     joinOptions: EventJoinOptions
 
+    "External URL for participation"
+    externalParticipationUrl: String
+
     "The list of tags associated to the event"
     tags: [String]
 
@@ -2956,6 +2962,9 @@ type Event implements ActivityObject & Interactable & ActionLogObject {
   "The event's visibility"
   joinOptions: EventJoinOptions
 
+  "External URL for participation"
+  externalParticipationUrl: String
+
   "The event's picture"
   picture: Media
 
@@ -3144,6 +3153,9 @@ enum EventJoinOptions {
 
   "Participants must be invited"
   INVITE
+
+  "External registration"
+  EXTERNAL
 }
 
 type InstanceFeeds {