Compare commits

...

4 Commits

Author SHA1 Message Date
Alex Tran
bbb2f01aa7 wip: call host function from plugin 2026-01-21 15:17:54 +00:00
Alex
92fae68253 Merge branch 'main' into filter-by-person 2026-01-20 14:33:18 -06:00
Noel S
72caf8983c fix(mobile): indicators not showing on thumbnail tile after asset change in viewer (#25297)
* fixed indicators staying hidden

* remove logs

* explanation comment

* move import to correct place

* revert accidental change in null handling
2026-01-20 14:02:54 -06:00
Alex Tran
35fed9c4ed feat: filter by person 2025-12-21 05:18:51 +00:00
12 changed files with 179 additions and 58 deletions

View File

@@ -6,6 +6,7 @@ import 'package:immich_mobile/domain/models/setting.model.dart';
import 'package:immich_mobile/extensions/build_context_extensions.dart';
import 'package:immich_mobile/extensions/duration_extensions.dart';
import 'package:immich_mobile/extensions/theme_extensions.dart';
import 'package:immich_mobile/presentation/widgets/asset_viewer/asset_viewer.state.dart';
import 'package:immich_mobile/presentation/widgets/images/thumbnail.widget.dart';
import 'package:immich_mobile/presentation/widgets/timeline/constants.dart';
import 'package:immich_mobile/providers/backup/asset_upload_progress.provider.dart';
@@ -47,6 +48,7 @@ class _ThumbnailTileState extends ConsumerState<ThumbnailTile> {
Widget build(BuildContext context) {
final asset = widget.asset;
final heroIndex = widget.heroOffset ?? TabsRouterScope.of(context)?.controller.activeIndex ?? 0;
final isCurrentAsset = ref.watch(assetViewerProvider.select((current) => current.currentAsset == asset));
final assetContainerColor = context.isDarkTheme
? context.primaryColor.darken(amount: 0.4)
@@ -59,6 +61,10 @@ class _ThumbnailTileState extends ConsumerState<ThumbnailTile> {
final bool storageIndicator =
ref.watch(settingsProvider.select((s) => s.get(Setting.showStorageIndicator))) && widget.showStorageIndicator;
if (!isCurrentAsset) {
_hideIndicators = false;
}
if (isSelected) {
_showSelectionContainer = true;
}
@@ -96,7 +102,11 @@ class _ThumbnailTileState extends ConsumerState<ThumbnailTile> {
children: [
Positioned.fill(
child: Hero(
tag: '${asset?.heroTag ?? ''}_$heroIndex',
// This key resets the hero animation when the asset is changed in the asset viewer.
// It doesn't seem like the best solution, and only works to reset the hero, not prime the hero of the new active asset for animation,
// but other solutions have failed thus far.
key: ValueKey(isCurrentAsset),
tag: '${asset?.heroTag}_$heroIndex',
child: Thumbnail.fromAsset(asset: asset, size: widget.size),
// Placeholderbuilder used to hide indicators on first hero animation, since flightShuttleBuilder isn't called until both source and destination hero exist in widget tree.
placeholderBuilder: (context, heroSize, child) {

View File

@@ -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"]
}
}
]

View File

@@ -1,5 +1,6 @@
declare module 'main' {
export function filterFileName(): I32;
export function filterPerson(): I32;
export function actionAddToAlbum(): I32;
export function actionArchive(): I32;
}
@@ -8,5 +9,6 @@ declare module 'extism:host' {
interface user {
updateAsset(ptr: PTR): I32;
addAssetToAlbum(ptr: PTR): I32;
getFacesForAsset(ptr: PTR): PTR;
}
}

View File

@@ -1,4 +1,4 @@
const { updateAsset, addAssetToAlbum } = Host.getFunctions();
const { updateAsset, addAssetToAlbum, getFacesForAsset } = Host.getFunctions();
function parseInput() {
return JSON.parse(Host.inputString());
@@ -9,6 +9,64 @@ function returnOutput(output: any) {
return 0;
}
/**
* Filter by person - checks if the recognized person matches the configured person IDs.
*
* For PersonRecognized trigger:
* - data.personId contains the ID of the person that was just recognized
* - Checks if personId is in the configured list
*
* matchMode options:
* - 'any': passes if the triggering person is in the list
* - 'all': passes if all configured persons are present in the asset
* - 'exact': passes if the asset contains exactly the configured persons
*/
export function filterPerson() {
const input = parseInput();
const { authToken, data, config } = input;
const { personIds, matchMode = 'any' } = config;
if (!personIds || personIds.length === 0) {
return returnOutput({ passed: true });
}
const triggerPersonId = data.personId;
if (matchMode === 'any') {
const passed = triggerPersonId && personIds.includes(triggerPersonId);
return returnOutput({ passed });
}
const payload = Memory.fromJsonObject({
authToken,
assetId: data.asset.id,
});
const resultPtr = getFacesForAsset(payload.offset);
payload.free();
const faces = JSON.parse(Memory.find(resultPtr).readJsonObject());
const assetPersonIds: string[] = faces
.filter((face: { personId: string | null }) => face.personId !== null)
.map((face: { personId: string }) => face.personId);
let passed = false;
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;
@@ -44,7 +102,7 @@ export function actionAddToAlbum() {
authToken,
assetId: data.asset.id,
albumId: albumId,
})
}),
);
addAssetToAlbum(ptr.offset);
@@ -61,7 +119,7 @@ export function actionArchive() {
authToken,
id: data.asset.id,
visibility: 'archive',
})
}),
);
updateAsset(ptr.offset);

View File

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

View File

@@ -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();
}
/**

View File

@@ -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 }];

View File

@@ -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

View File

@@ -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;

View File

@@ -7,6 +7,7 @@ import { AlbumRepository } from 'src/repositories/album.repository';
import { AssetRepository } from 'src/repositories/asset.repository';
import { CryptoRepository } from 'src/repositories/crypto.repository';
import { LoggingRepository } from 'src/repositories/logging.repository';
import { PersonRepository } from 'src/repositories/person.repository';
import { AssetTable } from 'src/schema/tables/asset.table';
import { requireAccess } from 'src/utils/access';
@@ -20,6 +21,7 @@ export class PluginHostFunctions {
private albumRepository: AlbumRepository,
private accessRepository: AccessRepository,
private cryptoRepository: CryptoRepository,
private personRepository: PersonRepository,
private logger: LoggingRepository,
private pluginJwtSecret: string,
) {}
@@ -33,6 +35,7 @@ export class PluginHostFunctions {
'extism:host/user': {
updateAsset: (cp: CurrentPlugin, offs: bigint) => this.handleUpdateAsset(cp, offs),
addAssetToAlbum: (cp: CurrentPlugin, offs: bigint) => this.handleAddAssetToAlbum(cp, offs),
getFacesForAsset: (cp: CurrentPlugin, offs: bigint) => this.handleGetFacesForAsset(cp, offs),
},
};
}
@@ -117,4 +120,28 @@ export class PluginHostFunctions {
await this.albumRepository.addAssetIds(albumId, [assetId]);
return 0;
}
/**
* Host function wrapper for getFacesForAsset.
* Reads the input from the plugin, parses it, and returns faces data.
*/
private async handleGetFacesForAsset(cp: CurrentPlugin, offs: bigint) {
const input = JSON.parse(cp.read(offs)!.text());
const result = await this.getFacesForAsset(input);
return cp.store(JSON.stringify(result));
}
async getFacesForAsset(input: { authToken: string; assetId: string }) {
const { authToken, assetId } = input;
const auth = this.validateToken(authToken);
await requireAccess(this.accessRepository, {
auth: { user: { id: auth.userId } } as any,
permission: Permission.AssetRead,
ids: [assetId],
});
return this.personRepository.getFaces(assetId);
}
}

View File

@@ -17,6 +17,7 @@ import { IWorkflowJob, JobItem, JobOf, WorkflowData } from 'src/types';
interface WorkflowContext {
authToken: string;
asset: Asset;
personId?: string;
}
interface PluginInput<T = unknown> {
@@ -24,6 +25,7 @@ interface PluginInput<T = unknown> {
config: T;
data: {
asset: Asset;
personId?: string;
};
}
@@ -44,6 +46,7 @@ export class PluginService extends BaseService {
this.albumRepository,
this.accessRepository,
this.cryptoRepository,
this.personRepository,
this.logger,
this.pluginJwtSecret,
);
@@ -117,7 +120,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 +183,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] },
@@ -219,7 +232,7 @@ export class PluginService extends BaseService {
const authToken = this.cryptoRepository.signJwt({ userId: data.userId }, this.pluginJwtSecret);
const context = {
const context: WorkflowContext = {
authToken,
asset,
};
@@ -230,13 +243,35 @@ 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 context: WorkflowContext = {
authToken,
asset,
personId: data.personId,
};
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 +304,7 @@ export class PluginService extends BaseService {
config: workflowFilter.filterConfig,
data: {
asset: context.asset,
personId: context.personId,
},
};
@@ -311,6 +347,7 @@ export class PluginService extends BaseService {
config: workflowAction.actionConfig,
data: {
asset: context.asset,
personId: context.personId,
},
};

View File

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