17685697493

Committed 12 Sep 2025 08:48PM UTC coverage: 65.828% (+1.7%) from 64.102%

Build # 17685697493

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1030 from bpatrik/db-projection

Implement projected (scoped/filtered) gallery. Fixes #1015

Run Details

1305 of 2243 branches covered (58.18%)

Branch coverage included in aggregate %.

706 of 873 new or added lines in 54 files covered. (80.87%)

16 existing lines in 10 files now uncovered.

4794 of 7022 relevant lines covered (68.27%)

4355.01 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

51.28

/src/backend/model/fileaccess/fileprocessing/PhotoProcessing.ts

import * as path from 'path';
import {constants as fsConstants, promises as fsp} from 'fs';
import * as os from 'os';
import * as crypto from 'crypto';
import {ProjectPath} from '../../../ProjectPath';
import {Config} from '../../../../common/config/private/Config';
import {MediaRendererInput, PhotoWorker, SvgRendererInput, ThumbnailSourceType,} from '../PhotoWorker';
import {ITaskExecuter, TaskExecuter} from '../TaskExecuter';
import {FaceRegion, PhotoDTO} from '../../../../common/entities/PhotoDTO';
import {SupportedFormats} from '../../../../common/SupportedFormats';
import {PersonEntry} from '../../database/enitites/person/PersonEntry';
import {SVGIconConfig} from '../../../../common/config/public/ClientConfig';

export class PhotoProcessing {
  private static initDone = false;
  private static taskQue: ITaskExecuter<MediaRendererInput | SvgRendererInput, void> = null;
  private static readonly CONVERTED_EXTENSION = '.webp';

  public static init(): void {
    if (this.initDone === true) {
      return;
    }

    Config.Media.Photo.concurrentThumbnailGenerations = Math.max(
      1,
      os.cpus().length - 1
    );

    this.taskQue = new TaskExecuter(
      Config.Media.Photo.concurrentThumbnailGenerations,
      (input): Promise<void> => PhotoWorker.render(input)
    );

    this.initDone = true;
  }

  public static async generatePersonThumbnail(
    person: PersonEntry
  ): Promise<string> {
    // load parameters
    const photo: PhotoDTO = person.cache.sampleRegion.media;
    const mediaPath = path.join(
      ProjectPath.ImageFolder,
      photo.directory.path,
      photo.directory.name,
      photo.name
    );
    const size: number = Config.Media.Photo.personThumbnailSize;
    const faceRegion = person.cache.sampleRegion.media.metadata.faces.find(f => f.name === person.name);
    // generate thumbnail path
    const thPath = PhotoProcessing.generatePersonThumbnailPath(
      mediaPath,
      faceRegion,
      size
    );

    // check if thumbnail already exist
    try {
      await fsp.access(thPath, fsConstants.R_OK);
      return thPath;
    } catch (e) {
      // ignoring errors
    }

    const margin = {
      x: Math.round(
        faceRegion.box.width *
        Config.Media.Photo.personFaceMargin
      ),
      y: Math.round(
        faceRegion.box.height *
        Config.Media.Photo.personFaceMargin
      ),
    };

    // run on other thread
    const input = {
      type: ThumbnailSourceType.Photo,
      mediaPath,
      size,
      outPath: thPath,
      makeSquare: false,
      cut: {
        left: Math.round(
          Math.max(0, faceRegion.box.left - margin.x / 2)
        ),
        top: Math.round(
          Math.max(0, faceRegion.box.top - margin.y / 2)
        ),
        width: faceRegion.box.width + margin.x,
        height: faceRegion.box.height + margin.y,
      },
      useLanczos3: Config.Media.Photo.useLanczos3,
      quality: Config.Media.Photo.quality,
      smartSubsample: Config.Media.Photo.smartSubsample,
    } as MediaRendererInput;
    input.cut.width = Math.min(
      input.cut.width,
      photo.metadata.size.width - input.cut.left
    );
    input.cut.height = Math.min(
      input.cut.height,
      photo.metadata.size.height - input.cut.top
    );

    await fsp.mkdir(ProjectPath.FacesFolder, {recursive: true});
    await PhotoProcessing.taskQue.execute(input);
    return thPath;
  }

  public static generateConvertedPath(mediaPath: string, size: number): string {
    const file = path.basename(mediaPath);
    const animated = Config.Media.Photo.animateGif && path.extname(mediaPath).toLowerCase() == '.gif';
    return path.join(
      ProjectPath.TranscodedFolder,
      ProjectPath.getRelativePathToImages(path.dirname(mediaPath)),
      file + '_' + size + 'q' + Config.Media.Photo.quality +
      (animated ? 'anim' : '') +
      (Config.Media.Photo.smartSubsample ? 'cs' : '') +
      PhotoProcessing.CONVERTED_EXTENSION
    );
  }

  public static generatePersonThumbnailPath(
    mediaPath: string,
    faceRegion: FaceRegion,
    size: number
  ): string {
    return path.join(
      ProjectPath.FacesFolder,
      crypto
        .createHash('md5')
        .update(
          mediaPath +
          '_' +
          faceRegion.name +
          '_' +
          faceRegion.box.left +
          '_' +
          faceRegion.box.top
        )
        .digest('hex') +
      '_' +
      size +
      '_' + Config.Media.Photo.personFaceMargin +
      PhotoProcessing.CONVERTED_EXTENSION
    );
  }

  /**
   * Tells if the path is valid with the current config
   * @param convertedPath
   */
  public static async isValidConvertedPath(
    convertedPath: string
  ): Promise<boolean> {
    const origFilePath = path.join(
      ProjectPath.ImageFolder,
      path.relative(
        ProjectPath.TranscodedFolder,
        convertedPath.substring(0, convertedPath.lastIndexOf('_'))
      )
    );

    if (path.extname(convertedPath) !== PhotoProcessing.CONVERTED_EXTENSION) {
      return false;
    }
    let nextIndex = convertedPath.lastIndexOf('_') + 1;

    const sizeStr = convertedPath.substring(
      nextIndex,
      convertedPath.lastIndexOf('q')
    );
    nextIndex = convertedPath.lastIndexOf('q') + 1;

    const size = parseInt(sizeStr, 10);

    if (
      (size + '').length !== sizeStr.length ||
      (Config.Media.Photo.thumbnailSizes.indexOf(size) === -1)
    ) {
      return false;
    }

    const qualityStr =convertedPath.substring(nextIndex,
      nextIndex+convertedPath.substring(nextIndex).search(/[A-Za-z]/)); // end of quality string

    const quality = parseInt(qualityStr, 10);

    if ((quality + '').length !== qualityStr.length ||
      quality !== Config.Media.Photo.quality) {
      return false;
    }


    nextIndex += qualityStr.length;


    const lowerExt = path.extname(origFilePath).toLowerCase();
    const shouldBeAnimated = Config.Media.Photo.animateGif && lowerExt == '.gif';
    if (shouldBeAnimated) {
      if (convertedPath.substring(
        nextIndex,
        nextIndex + 'anim'.length
      ) != 'anim') {
        return false;
      }
      nextIndex += 'anim'.length;
    }


    if (Config.Media.Photo.smartSubsample) {
      if (convertedPath.substring(
        nextIndex,
        nextIndex + 2
      ) != 'cs') {
        return false;
      }
      nextIndex+=2;
    }

    if(convertedPath.substring(
      nextIndex
    ).toLowerCase() !== path.extname(convertedPath)){
      return false;
    }


    try {
      await fsp.access(origFilePath, fsConstants.R_OK);
    } catch (e) {
      return false;
    }

    return true;
  }


  static async convertedPhotoExist(
    mediaPath: string,
    size: number
  ): Promise<boolean> {
    // generate thumbnail path
    const outPath = PhotoProcessing.generateConvertedPath(mediaPath, size);

    // check if file already exist
    try {
      await fsp.access(outPath, fsConstants.R_OK);
      return true;
    } catch (e) {
      // ignoring errors
    }
    return false;
  }


  public static async generateThumbnail(
    mediaPath: string,
    size: number,
    sourceType: ThumbnailSourceType,
    makeSquare: boolean
  ): Promise<string> {
    // generate thumbnail path
    const outPath = PhotoProcessing.generateConvertedPath(mediaPath, size);

    // check if file already exist
    try {
      await fsp.access(outPath, fsConstants.R_OK);
      return outPath;
    } catch (e) {
      // ignoring errors
    }

    // run on other thread
    const input = {
      type: sourceType,
      mediaPath,
      size,
      outPath,
      makeSquare,
      useLanczos3: Config.Media.Photo.useLanczos3,
      quality: Config.Media.Photo.quality,
      smartSubsample: Config.Media.Photo.smartSubsample,
    } as MediaRendererInput;

    const outDir = path.dirname(input.outPath);

    await fsp.mkdir(outDir, {recursive: true});
    await this.taskQue.execute(input);
    return outPath;
  }

  public static isPhoto(fullPath: string): boolean {
    const extension = path.extname(fullPath).toLowerCase();
    return SupportedFormats.WithDots.Photos.indexOf(extension) !== -1;
  }

  public static async renderSVG(
    svgIcon: SVGIconConfig,
    outPath: string,
    color = '#000'
  ): Promise<string> {

    // check if file already exist
    try {
      await fsp.access(outPath, fsConstants.R_OK);
      return outPath;
    } catch (e) {
      // ignoring errors
    }

    const size = 256;
    // run on other thread
    const input = {
      type: ThumbnailSourceType.Photo,
      svgString: `<svg fill="${color}" width="${size}" height="${size}" xmlns="http://www.w3.org/2000/svg"
viewBox="${svgIcon.viewBox || '0 0 512 512'}">d="${svgIcon.items}</svg>`,
      size: size,
      outPath,
      makeSquare: false,
      animate: false,
      useLanczos3: Config.Media.Photo.useLanczos3,
      quality: Config.Media.Photo.quality,
      smartSubsample: Config.Media.Photo.smartSubsample,
    } as SvgRendererInput;

    const outDir = path.dirname(input.outPath);

    await fsp.mkdir(outDir, {recursive: true});
    await this.taskQue.execute(input);
    return outPath;
  }

}


1	import * as path from 'path';	1✔
2	import {constants as fsConstants, promises as fsp} from 'fs';	1✔
3	import * as os from 'os';	1✔
4	import * as crypto from 'crypto';	1✔
5	import {ProjectPath} from '../../../ProjectPath';	1✔
6	import {Config} from '../../../../common/config/private/Config';	1✔
7	import {MediaRendererInput, PhotoWorker, SvgRendererInput, ThumbnailSourceType,} from '../PhotoWorker';	1✔
8	import {ITaskExecuter, TaskExecuter} from '../TaskExecuter';	1✔
9	import {FaceRegion, PhotoDTO} from '../../../../common/entities/PhotoDTO';
10	import {SupportedFormats} from '../../../../common/SupportedFormats';	1✔
11	import {PersonEntry} from '../../database/enitites/person/PersonEntry';
12	import {SVGIconConfig} from '../../../../common/config/public/ClientConfig';
13
14	export class PhotoProcessing {	1✔
15	private static initDone = false;	1✔
16	private static taskQue: ITaskExecuter<MediaRendererInput \| SvgRendererInput, void> = null;	1✔
17	private static readonly CONVERTED_EXTENSION = '.webp';	1✔
18
19	public static init(): void {
20	if (this.initDone === true) {	23✔
21	return;	22✔
22	}
23
24	Config.Media.Photo.concurrentThumbnailGenerations = Math.max(	1✔
25	1,
26	os.cpus().length - 1
27	);
28
29	this.taskQue = new TaskExecuter(	1✔
30	Config.Media.Photo.concurrentThumbnailGenerations,
31	(input): Promise<void> => PhotoWorker.render(input)	×
32	);
33
34	this.initDone = true;	1✔
35	}
36
37	public static async generatePersonThumbnail(
38	person: PersonEntry
39	): Promise<string> {
40	// load parameters
NEW 41	const photo: PhotoDTO = person.cache.sampleRegion.media;	×
42	const mediaPath = path.join(	×
43	ProjectPath.ImageFolder,
44	photo.directory.path,
45	photo.directory.name,
46	photo.name
47	);
48	const size: number = Config.Media.Photo.personThumbnailSize;	×
NEW 49	const faceRegion = person.cache.sampleRegion.media.metadata.faces.find(f => f.name === person.name);	×
50	// generate thumbnail path
51	const thPath = PhotoProcessing.generatePersonThumbnailPath(	×
52	mediaPath,
53	faceRegion,
54	size
55	);
56
57	// check if thumbnail already exist
58	try {	×
59	await fsp.access(thPath, fsConstants.R_OK);	×
60	return thPath;	×
61	} catch (e) {
62	// ignoring errors
63	}
64
65	const margin = {	×
66	x: Math.round(
67	faceRegion.box.width *
68	Config.Media.Photo.personFaceMargin
69	),
70	y: Math.round(
71	faceRegion.box.height *
72	Config.Media.Photo.personFaceMargin
73	),
74	};
75
76	// run on other thread
77	const input = {	×
78	type: ThumbnailSourceType.Photo,
79	mediaPath,
80	size,
81	outPath: thPath,
82	makeSquare: false,
83	cut: {
84	left: Math.round(
85	Math.max(0, faceRegion.box.left - margin.x / 2)
86	),
87	top: Math.round(
88	Math.max(0, faceRegion.box.top - margin.y / 2)
89	),
90	width: faceRegion.box.width + margin.x,
91	height: faceRegion.box.height + margin.y,
92	},
93	useLanczos3: Config.Media.Photo.useLanczos3,
94	quality: Config.Media.Photo.quality,
95	smartSubsample: Config.Media.Photo.smartSubsample,
96	} as MediaRendererInput;
97	input.cut.width = Math.min(	×
98	input.cut.width,
99	photo.metadata.size.width - input.cut.left
100	);
101	input.cut.height = Math.min(	×
102	input.cut.height,
103	photo.metadata.size.height - input.cut.top
104	);
105
106	await fsp.mkdir(ProjectPath.FacesFolder, {recursive: true});	×
107	await PhotoProcessing.taskQue.execute(input);	×
108	return thPath;	×
109	}
110
111	public static generateConvertedPath(mediaPath: string, size: number): string {
112	const file = path.basename(mediaPath);	500✔
113	const animated = Config.Media.Photo.animateGif && path.extname(mediaPath).toLowerCase() == '.gif';	500✔
114	return path.join(	500✔
115	ProjectPath.TranscodedFolder,
116	ProjectPath.getRelativePathToImages(path.dirname(mediaPath)),
117	file + '_' + size + 'q' + Config.Media.Photo.quality +
118	(animated ? 'anim' : '') +	500✔
119	(Config.Media.Photo.smartSubsample ? 'cs' : '') +	500!
120	PhotoProcessing.CONVERTED_EXTENSION
121	);
122	}
123
124	public static generatePersonThumbnailPath(
125	mediaPath: string,
126	faceRegion: FaceRegion,
127	size: number
128	): string {
129	return path.join(	×
130	ProjectPath.FacesFolder,
131	crypto
132	.createHash('md5')
133	.update(
134	mediaPath +
135	'_' +
136	faceRegion.name +
137	'_' +
138	faceRegion.box.left +
139	'_' +
140	faceRegion.box.top
141	)
142	.digest('hex') +
143	'_' +
144	size +
145	'_' + Config.Media.Photo.personFaceMargin +
146	PhotoProcessing.CONVERTED_EXTENSION
147	);
148	}
149
150	/**
151	* Tells if the path is valid with the current config
152	* @param convertedPath
153	*/
154	public static async isValidConvertedPath(
155	convertedPath: string
156	): Promise<boolean> {
157	const origFilePath = path.join(	5✔
158	ProjectPath.ImageFolder,
159	path.relative(
160	ProjectPath.TranscodedFolder,
161	convertedPath.substring(0, convertedPath.lastIndexOf('_'))
162	)
163	);
164
165	if (path.extname(convertedPath) !== PhotoProcessing.CONVERTED_EXTENSION) {	5!
166	return false;	×
167	}
168	let nextIndex = convertedPath.lastIndexOf('_') + 1;	5✔
169
170	const sizeStr = convertedPath.substring(	5✔
171	nextIndex,
172	convertedPath.lastIndexOf('q')
173	);
174	nextIndex = convertedPath.lastIndexOf('q') + 1;	5✔
175
176	const size = parseInt(sizeStr, 10);	5✔
177
178	if (	5✔
179	(size + '').length !== sizeStr.length \|\|	10✔
180	(Config.Media.Photo.thumbnailSizes.indexOf(size) === -1)
181	) {
182	return false;	1✔
183	}
184
185	const qualityStr =convertedPath.substring(nextIndex,	4✔
186	nextIndex+convertedPath.substring(nextIndex).search(/[A-Za-z]/)); // end of quality string
187
188	const quality = parseInt(qualityStr, 10);	4✔
189
190	if ((quality + '').length !== qualityStr.length \|\|	4!
191	quality !== Config.Media.Photo.quality) {
192	return false;	×
193	}
194
195
196	nextIndex += qualityStr.length;	4✔
197
198
199	const lowerExt = path.extname(origFilePath).toLowerCase();	4✔
200	const shouldBeAnimated = Config.Media.Photo.animateGif && lowerExt == '.gif';	4✔
201	if (shouldBeAnimated) {	4!
202	if (convertedPath.substring(	×
203	nextIndex,
204	nextIndex + 'anim'.length
205	) != 'anim') {
206	return false;	×
207	}
208	nextIndex += 'anim'.length;	×
209	}
210
211
212	if (Config.Media.Photo.smartSubsample) {	4✔
213	if (convertedPath.substring(	4!
214	nextIndex,
215	nextIndex + 2
216	) != 'cs') {
217	return false;	×
218	}
219	nextIndex+=2;	4✔
220	}
221
222	if(convertedPath.substring(	4!
223	nextIndex
224	).toLowerCase() !== path.extname(convertedPath)){
225	return false;	×
226	}
227
228
229	try {	4✔
230	await fsp.access(origFilePath, fsConstants.R_OK);	4✔
231	} catch (e) {
232	return false;	2✔
233	}
234
235	return true;	2✔
236	}
237
238
239	static async convertedPhotoExist(
240	mediaPath: string,
241	size: number
242	): Promise<boolean> {
243	// generate thumbnail path
244	const outPath = PhotoProcessing.generateConvertedPath(mediaPath, size);	×
245
246	// check if file already exist
247	try {	×
248	await fsp.access(outPath, fsConstants.R_OK);	×
249	return true;	×
250	} catch (e) {
251	// ignoring errors
252	}
253	return false;	×
254	}
255
256
257	public static async generateThumbnail(
258	mediaPath: string,
259	size: number,
260	sourceType: ThumbnailSourceType,
261	makeSquare: boolean
262	): Promise<string> {
263	// generate thumbnail path
264	const outPath = PhotoProcessing.generateConvertedPath(mediaPath, size);	×
265
266	// check if file already exist
267	try {	×
268	await fsp.access(outPath, fsConstants.R_OK);	×
269	return outPath;	×
270	} catch (e) {
271	// ignoring errors
272	}
273
274	// run on other thread
275	const input = {	×
276	type: sourceType,
277	mediaPath,
278	size,
279	outPath,
280	makeSquare,
281	useLanczos3: Config.Media.Photo.useLanczos3,
282	quality: Config.Media.Photo.quality,
283	smartSubsample: Config.Media.Photo.smartSubsample,
284	} as MediaRendererInput;
285
286	const outDir = path.dirname(input.outPath);	×
287
288	await fsp.mkdir(outDir, {recursive: true});	×
289	await this.taskQue.execute(input);	×
290	return outPath;	×
291	}
292
293	public static isPhoto(fullPath: string): boolean {
294	const extension = path.extname(fullPath).toLowerCase();	533✔
295	return SupportedFormats.WithDots.Photos.indexOf(extension) !== -1;	533✔
296	}
297
298	public static async renderSVG(
299	svgIcon: SVGIconConfig,
300	outPath: string,
301	color = '#000'	×
302	): Promise<string> {
303
304	// check if file already exist
305	try {	×
306	await fsp.access(outPath, fsConstants.R_OK);	×
307	return outPath;	×
308	} catch (e) {
309	// ignoring errors
310	}
311
312	const size = 256;	×
313	// run on other thread
314	const input = {	×
315	type: ThumbnailSourceType.Photo,
316	svgString: `<svg fill="${color}" width="${size}" height="${size}" xmlns="http://www.w3.org/2000/svg"
317	viewBox="${svgIcon.viewBox \|\| '0 0 512 512'}">d="${svgIcon.items}</svg>`,	×
318	size: size,
319	outPath,
320	makeSquare: false,
321	animate: false,
322	useLanczos3: Config.Media.Photo.useLanczos3,
323	quality: Config.Media.Photo.quality,
324	smartSubsample: Config.Media.Photo.smartSubsample,
325	} as SvgRendererInput;
326
327	const outDir = path.dirname(input.outPath);	×
328
329	await fsp.mkdir(outDir, {recursive: true});	×
330	await this.taskQue.execute(input);	×
331	return outPath;	×
332	}
333
334	}
335

bpatrik / pigallery2 / 17685697493

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous