Merge branch 'main' into filter-by-person

plugins/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "immich-core",
-  "version": "2.0.1",
+  "version": "2.4.1 ",
   "title": "Immich Core",
   "description": "Core workflow capabilities for Immich",
   "author": "Immich Team",
@@ -12,9 +12,7 @@
       "methodName": "filterFileName",
       "title": "Filter by filename",
       "description": "Filter assets by filename pattern using text matching or regular expressions",
-      "supportedContexts": [
-        "asset"
-      ],
+      "supportedContexts": ["asset"],
       "schema": {
         "type": "object",
         "properties": {
@@ -26,11 +24,7 @@
           "matchType": {
             "type": "string",
             "title": "Match type",
-            "enum": [
-              "contains",
-              "regex",
-              "exact"
-            ],
+            "enum": ["contains", "regex", "exact"],
             "default": "contains",
             "description": "Type of pattern matching to perform"
           },
@@ -40,18 +34,14 @@
             "description": "Whether matching should be case-sensitive"
           }
         },
-        "required": [
-          "pattern"
-        ]
+        "required": ["pattern"]
       }
     },
     {
       "methodName": "filterFileType",
       "title": "Filter by file type",
       "description": "Filter assets by file type",
-      "supportedContexts": [
-        "asset"
-      ],
+      "supportedContexts": ["asset"],
       "schema": {
         "type": "object",
         "properties": {
@@ -60,26 +50,19 @@
             "title": "File types",
             "items": {
               "type": "string",
-              "enum": [
-                "image",
-                "video"
-              ]
+              "enum": ["image", "video"]
             },
             "description": "Allowed file types"
           }
         },
-        "required": [
-          "fileTypes"
-        ]
+        "required": ["fileTypes"]
       }
     },
     {
       "methodName": "filterPerson",
       "title": "Filter by person",
-      "description": "Filter by detected person",
-      "supportedContexts": [
-        "person"
-      ],
+      "description": "Filter assets by detected people in the photo",
+      "supportedContexts": ["person"],
       "schema": {
         "type": "object",
         "properties": {
@@ -92,15 +75,14 @@
             "description": "List of person to match",
             "subType": "people-picker"
           },
-          "matchAny": {
-            "type": "boolean",
-            "default": true,
-            "description": "Match any name (true) or require all names (false)"
+          "matchMode": {
+            "type": "string",
+            "title": "Match mode",
+            "enum": ["any", "all", "exact"],
+            "default": "any"
           }
         },
-        "required": [
-          "personIds"
-        ]
+        "required": ["personIds"]
       }
     }
   ],
@@ -109,18 +91,14 @@
       "methodName": "actionArchive",
       "title": "Archive",
       "description": "Move the asset to archive",
-      "supportedContexts": [
-        "asset"
-      ],
+      "supportedContexts": ["asset"],
       "schema": {}
     },
     {
       "methodName": "actionFavorite",
       "title": "Favorite",
       "description": "Mark the asset as favorite or unfavorite",
-      "supportedContexts": [
-        "asset"
-      ],
+      "supportedContexts": ["asset"],
       "schema": {
         "type": "object",
         "properties": {
@@ -136,10 +114,7 @@
       "methodName": "actionAddToAlbum",
       "title": "Add to Album",
       "description": "Add the item to a specified album",
-      "supportedContexts": [
-        "asset",
-        "person"
-      ],
+      "supportedContexts": ["asset", "person"],
       "schema": {
         "type": "object",
         "properties": {
@@ -150,9 +125,7 @@
             "subType": "album-picker"
           }
         },
-        "required": [
-          "albumId"
-        ]
+        "required": ["albumId"]
       }
     }
   ]

plugins/src/index.d.ts

@@ -1,5 +1,6 @@
 declare module 'main' {
   export function filterFileName(): I32;
+  export function filterPerson(): I32;
   export function actionAddToAlbum(): I32;
   export function actionArchive(): I32;
 }

plugins/src/index.ts

@@ -9,6 +9,42 @@ function returnOutput(output: any) {
   return 0;
 }
 
+export function filterPerson() {
+  const input = parseInput();
+
+  const { data, config } = input;
+  const { personIds, matchMode } = config;
+
+  const faces = data.faces || [];
+
+  if (faces.length === 0) {
+    return returnOutput({ passed: false });
+  }
+
+  const assetPersonIds: string[] = faces
+    .filter((face: { personId: string | null }) => face.personId !== null)
+    .map((face: { personId: string }) => face.personId);
+
+  let passed = false;
+
+  if (!personIds || personIds.length === 0) {
+    passed = true;
+  } else if (matchMode === 'any') {
+    passed = personIds.some((id: string) => assetPersonIds.includes(id));
+  } else if (matchMode === 'all') {
+    passed = personIds.every((id: string) => assetPersonIds.includes(id));
+  } else if (matchMode === 'exact') {
+    const uniquePersonIds = new Set(personIds);
+    const uniqueAssetPersonIds = new Set(assetPersonIds);
+
+    passed =
+      uniquePersonIds.size === uniqueAssetPersonIds.size &&
+      personIds.every((id: string) => uniqueAssetPersonIds.has(id));
+  }
+
+  return returnOutput({ passed });
+}
+
 export function filterFileName() {
   const input = parseInput();
   const { data, config } = input;

server/src/queries/person.repository.sql

@@ -122,6 +122,7 @@ select
   "asset_face"."id",
   "asset_face"."personId",
   "asset_face"."sourceType",
+  "asset_face"."assetId",
   (
     select
       to_json(obj)

server/src/repositories/album.repository.ts

@@ -318,6 +318,7 @@ export class AlbumRepository {
     await db
       .insertInto('album_asset')
       .values(assetIds.map((assetId) => ({ albumId, assetId })))
+      .onConflict((oc) => oc.columns(['albumId', 'assetId']).doNothing())
       .execute();
   }
 
@@ -326,7 +327,11 @@ export class AlbumRepository {
     if (values.length === 0) {
       return;
     }
-    await this.db.insertInto('album_asset').values(values).execute();
+    await this.db
+      .insertInto('album_asset')
+      .values(values)
+      .onConflict((oc) => oc.columns(['albumId', 'assetId']).doNothing())
+      .execute();
   }
 
   /**

server/src/repositories/event.repository.ts

@@ -44,6 +44,7 @@ type EventMap = {
 
   // asset events
   AssetCreate: [{ asset: Asset }];
+  PersonRecognized: [{ assetId: string; ownerId: string; personId: string }];
   AssetTag: [{ assetId: string }];
   AssetUntag: [{ assetId: string }];
   AssetHide: [{ assetId: string; userId: string }];

server/src/repositories/person.repository.ts

@@ -248,7 +248,7 @@ export class PersonRepository {
   getFaceForFacialRecognitionJob(id: string) {
     return this.db
       .selectFrom('asset_face')
-      .select(['asset_face.id', 'asset_face.personId', 'asset_face.sourceType'])
+      .select(['asset_face.id', 'asset_face.personId', 'asset_face.sourceType', 'asset_face.assetId'])
       .select((eb) =>
         jsonObjectFrom(
           eb

server/src/services/person.service.ts

@@ -540,6 +540,12 @@ export class PersonService extends BaseService {
     if (personId) {
       this.logger.debug(`Assigning face ${id} to person ${personId}`);
       await this.personRepository.reassignFaces({ faceIds: [id], newPersonId: personId });
+
+      await this.eventRepository.emit('PersonRecognized', {
+        assetId: face.assetId,
+        ownerId: face.asset.ownerId,
+        personId,
+      });
     }
 
     return JobStatus.Success;

server/src/services/plugin.service.ts

@@ -17,6 +17,7 @@ import { IWorkflowJob, JobItem, JobOf, WorkflowData } from 'src/types';
 interface WorkflowContext {
   authToken: string;
   asset: Asset;
+  faces?: { faceId: string; personId: string | null }[];
 }
 
 interface PluginInput<T = unknown> {
@@ -24,6 +25,7 @@ interface PluginInput<T = unknown> {
   config: T;
   data: {
     asset: Asset;
+    faces?: { faceId: string; personId: string | null }[];
   };
 }
 
@@ -117,7 +119,9 @@ export class PluginService extends BaseService {
 
   private async loadPluginToDatabase(manifest: PluginManifestDto, basePath: string): Promise<void> {
     const currentPlugin = await this.pluginRepository.getPluginByName(manifest.name);
-    if (currentPlugin != null && currentPlugin.version === manifest.version) {
+    const isDev = this.configRepository.isDev();
+
+    if (currentPlugin != null && currentPlugin.version === manifest.version && !isDev) {
       this.logger.log(`Plugin ${manifest.name} is up to date (version ${manifest.version}). Skipping`);
       return;
     }
@@ -178,6 +182,14 @@ export class PluginService extends BaseService {
     });
   }
 
+  @OnEvent({ name: 'PersonRecognized' })
+  async handlePersonRecognized({ assetId, ownerId, personId }: ArgOf<'PersonRecognized'>) {
+    await this.handleTrigger(PluginTriggerType.PersonRecognized, {
+      ownerId,
+      event: { userId: ownerId, assetId, personId },
+    });
+  }
+
   private async handleTrigger<T extends PluginTriggerType>(
     triggerType: T,
     params: { ownerId: string; event: WorkflowData[T] },
@@ -230,13 +242,41 @@ export class PluginService extends BaseService {
           }
 
           await this.executeActions(workflowActions, context);
-          this.logger.debug(`Workflow ${workflowId} executed successfully`);
+          this.logger.debug(`Workflow ${workflowId} executed successfully for AssetCreate`);
           return JobStatus.Success;
         }
 
         case PluginTriggerType.PersonRecognized: {
-          this.logger.error('unimplemented');
-          return JobStatus.Skipped;
+          const data = event as WorkflowData[PluginTriggerType.PersonRecognized];
+
+          const asset = await this.assetRepository.getById(data.assetId);
+          if (!asset) {
+            this.logger.error(`Asset ${data.assetId} not found for workflow ${workflowId}`);
+            return JobStatus.Failed;
+          }
+
+          const authToken = this.cryptoRepository.signJwt({ userId: data.userId }, this.pluginJwtSecret);
+
+          const faces = await this.personRepository.getFaces(data.assetId);
+          const facePayload = faces.map((face) => ({
+            faceId: face.id,
+            personId: face.personId,
+          }));
+
+          const context = {
+            authToken,
+            asset,
+            faces: facePayload,
+          };
+
+          const filtersPassed = await this.executeFilters(workflowFilters, context);
+          if (!filtersPassed) {
+            return JobStatus.Skipped;
+          }
+
+          await this.executeActions(workflowActions, context);
+          this.logger.debug(`Workflow ${workflowId} executed successfully for PersonRecognized`);
+          return JobStatus.Success;
         }
 
         default: {
@@ -269,6 +309,7 @@ export class PluginService extends BaseService {
         config: workflowFilter.filterConfig,
         data: {
           asset: context.asset,
+          faces: context.faces,
         },
       };
 

server/src/types.ts

@@ -259,8 +259,9 @@ export interface WorkflowData {
     asset: Asset;
   };
   [PluginTriggerType.PersonRecognized]: {
-    personId: string;
+    userId: string;
     assetId: string;
+    personId: string;
   };
 }
 

web/src/lib/services/person.service.ts

@@ -4,13 +4,7 @@ import { handleError } from '$lib/utils/handle-error';
 import { getFormatter } from '$lib/utils/i18n';
 import { updatePerson, type PersonResponseDto } from '@immich/sdk';
 import { modalManager, toastManager, type ActionItem } from '@immich/ui';
-import {
-  mdiCalendarEditOutline,
-  mdiEyeOffOutline,
-  mdiEyeOutline,
-  mdiHeartMinusOutline,
-  mdiHeartOutline,
-} from '@mdi/js';
+import { mdiCalendarEditOutline } from '@mdi/js';
 import type { MessageFormatter } from 'svelte-i18n';
 
 export const getPersonActions = ($t: MessageFormatter, person: PersonResponseDto) => {
@@ -20,83 +14,7 @@ export const getPersonActions = ($t: MessageFormatter, person: PersonResponseDto
     onAction: () => modalManager.show(PersonEditBirthDateModal, { person }),
   };
 
-  const Favorite: ActionItem = {
-    title: $t('to_favorite'),
-    icon: mdiHeartOutline,
-    $if: () => !person.isFavorite,
-    onAction: () => handleFavoritePerson(person),
-  };
-
-  const Unfavorite: ActionItem = {
-    title: $t('unfavorite'),
-    icon: mdiHeartMinusOutline,
-    $if: () => !!person.isFavorite,
-    onAction: () => handleUnfavoritePerson(person),
-  };
-
-  const HidePerson: ActionItem = {
-    title: $t('hide_person'),
-    icon: mdiEyeOffOutline,
-    $if: () => !person.isHidden,
-    onAction: () => handleHidePerson(person),
-  };
-
-  const ShowPerson: ActionItem = {
-    title: $t('unhide_person'),
-    icon: mdiEyeOutline,
-    $if: () => !!person.isHidden,
-    onAction: () => handleShowPerson(person),
-  };
-
-  return { SetDateOfBirth, Favorite, Unfavorite, HidePerson, ShowPerson };
-};
-
-const handleFavoritePerson = async (person: { id: string }) => {
-  const $t = await getFormatter();
-
-  try {
-    const response = await updatePerson({ id: person.id, personUpdateDto: { isFavorite: true } });
-    eventManager.emit('PersonUpdate', response);
-    toastManager.success($t('added_to_favorites'));
-  } catch (error) {
-    handleError(error, $t('errors.unable_to_add_remove_favorites', { values: { favorite: false } }));
-  }
-};
-
-const handleUnfavoritePerson = async (person: { id: string }) => {
-  const $t = await getFormatter();
-
-  try {
-    const response = await updatePerson({ id: person.id, personUpdateDto: { isFavorite: false } });
-    eventManager.emit('PersonUpdate', response);
-    toastManager.success($t('removed_from_favorites'));
-  } catch (error) {
-    handleError(error, $t('errors.unable_to_add_remove_favorites', { values: { favorite: false } }));
-  }
-};
-
-const handleHidePerson = async (person: { id: string }) => {
-  const $t = await getFormatter();
-
-  try {
-    const response = await updatePerson({ id: person.id, personUpdateDto: { isHidden: true } });
-    toastManager.success($t('changed_visibility_successfully'));
-    eventManager.emit('PersonUpdate', response);
-  } catch (error) {
-    handleError(error, $t('errors.unable_to_hide_person'));
-  }
-};
-
-const handleShowPerson = async (person: { id: string }) => {
-  const $t = await getFormatter();
-
-  try {
-    const response = await updatePerson({ id: person.id, personUpdateDto: { isHidden: false } });
-    toastManager.success($t('changed_visibility_successfully'));
-    eventManager.emit('PersonUpdate', response);
-  } catch (error) {
-    handleError(error, $t('errors.something_went_wrong'));
-  }
+  return { SetDateOfBirth };
 };
 
 export const handleUpdatePersonBirthDate = async (person: PersonResponseDto, birthDate: string) => {

web/src/routes/(user)/people/[personId]/[[photos=photos]]/[[assetId=id]]/+page.svelte

@@ -4,6 +4,7 @@
   import { clickOutside } from '$lib/actions/click-outside';
   import { listNavigation } from '$lib/actions/list-navigation';
   import { scrollMemoryClearer } from '$lib/actions/scroll-memory';
+  import ActionMenuItem from '$lib/components/ActionMenuItem.svelte';
   import ImageThumbnail from '$lib/components/assets/thumbnail/image-thumbnail.svelte';
   import EditNameInput from '$lib/components/faces-page/edit-name-input.svelte';
   import MergeFaceSelector from '$lib/components/faces-page/merge-face-selector.svelte';
@@ -41,12 +42,16 @@
   import { handleError } from '$lib/utils/handle-error';
   import { isExternalUrl } from '$lib/utils/navigation';
   import { AssetVisibility, searchPerson, updatePerson, type PersonResponseDto } from '@immich/sdk';
-  import { ContextMenuButton, LoadingSpinner, modalManager, toastManager, type ActionItem } from '@immich/ui';
+  import { LoadingSpinner, modalManager, toastManager } from '@immich/ui';
   import {
     mdiAccountBoxOutline,
     mdiAccountMultipleCheckOutline,
     mdiArrowLeft,
     mdiDotsVertical,
+    mdiEyeOffOutline,
+    mdiEyeOutline,
+    mdiHeartMinusOutline,
+    mdiHeartOutline,
     mdiPlus,
   } from '@mdi/js';
   import { DateTime } from 'luxon';
@@ -139,6 +144,37 @@
     viewMode = PersonPageViewMode.UNASSIGN_ASSETS;
   };
 
+  const toggleHidePerson = async () => {
+    try {
+      await updatePerson({
+        id: person.id,
+        personUpdateDto: { isHidden: !person.isHidden },
+      });
+
+      toastManager.success($t('changed_visibility_successfully'));
+
+      await goto(previousRoute);
+    } catch (error) {
+      handleError(error, $t('errors.unable_to_hide_person'));
+    }
+  };
+
+  const handleToggleFavorite = async () => {
+    try {
+      const updatedPerson = await updatePerson({
+        id: person.id,
+        personUpdateDto: { isFavorite: !person.isFavorite },
+      });
+
+      // Invalidate to reload the page data and have the favorite status updated
+      await invalidateAll();
+
+      toastManager.success(updatedPerson.isFavorite ? $t('added_to_favorites') : $t('removed_from_favorites'));
+    } catch (error) {
+      handleError(error, $t('errors.unable_to_add_remove_favorites', { values: { favorite: person.isFavorite } }));
+    }
+  };
+
   const handleMerge = async (person: PersonResponseDto) => {
     await updateAssetCount();
     await handleGoBack();
@@ -289,35 +325,13 @@
     assetInteraction.clearMultiselect();
   };
 
-  const onPersonUpdate = async (response: PersonResponseDto) => {
-    if (response.id !== person.id) {
-      return;
+  const onPersonUpdate = (response: PersonResponseDto) => {
+    if (person.id === response.id) {
+      return (person = response);
     }
-
-    if (response.isHidden) {
-      await goto(previousRoute);
-      return;
-    }
-
-    person = response;
   };
 
-  const { SetDateOfBirth, Favorite, Unfavorite, HidePerson, ShowPerson } = $derived(getPersonActions($t, person));
-  const SelectFeaturePhoto: ActionItem = {
-    title: $t('select_featured_photo'),
-    icon: mdiAccountBoxOutline,
-    onAction: () => {
-      viewMode = PersonPageViewMode.SELECT_PERSON;
-    },
-  };
-
-  const Merge: ActionItem = {
-    title: $t('merge_people'),
-    icon: mdiAccountMultipleCheckOutline,
-    onAction: () => {
-      viewMode = PersonPageViewMode.MERGE_PEOPLE;
-    },
-  };
+  const { SetDateOfBirth } = $derived(getPersonActions($t, person));
 </script>
 
 <OnEvents {onPersonUpdate} onAssetsDelete={updateAssetCount} onAssetsArchive={updateAssetCount} />
@@ -493,10 +507,29 @@
     {#if viewMode === PersonPageViewMode.VIEW_ASSETS}
       <ControlAppBar showBackButton backIcon={mdiArrowLeft} onClose={() => goto(previousRoute)}>
         {#snippet trailing()}
-          <ContextMenuButton
-            items={[SelectFeaturePhoto, HidePerson, ShowPerson, SetDateOfBirth, Merge, Favorite, Unfavorite]}
-            aria-label={$t('open')}
-          />
+          <ButtonContextMenu icon={mdiDotsVertical} title={$t('menu')}>
+            <MenuOption
+              text={$t('select_featured_photo')}
+              icon={mdiAccountBoxOutline}
+              onClick={() => (viewMode = PersonPageViewMode.SELECT_PERSON)}
+            />
+            <MenuOption
+              text={person.isHidden ? $t('unhide_person') : $t('hide_person')}
+              icon={person.isHidden ? mdiEyeOutline : mdiEyeOffOutline}
+              onClick={() => toggleHidePerson()}
+            />
+            <ActionMenuItem action={SetDateOfBirth} />
+            <MenuOption
+              text={$t('merge_people')}
+              icon={mdiAccountMultipleCheckOutline}
+              onClick={() => (viewMode = PersonPageViewMode.MERGE_PEOPLE)}
+            />
+            <MenuOption
+              icon={person.isFavorite ? mdiHeartMinusOutline : mdiHeartOutline}
+              text={person.isFavorite ? $t('unfavorite') : $t('to_favorite')}
+              onClick={handleToggleFavorite}
+            />
+          </ButtonContextMenu>
         {/snippet}
       </ControlAppBar>
     {/if}