Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Image format conversion using convert #597

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions src/images/convert.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/*
Copyright 2021 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { spawn } from 'child_process';
import { mkdtemp } from 'fs/promises';
import path from 'path';
import os from 'os';

let tempFolder: string;

const ensureTempFolder = async() => {
if (!tempFolder) {
tempFolder = await mkdtemp(path.join(os.tmpdir(), 'slack-bridge-convert'));
}
return tempFolder;
};

// eslint-disable-next-line @typescript-eslint/promise-function-async
const spawnConvertProcess = (inputPath: string, outputPath: string) =>
new Promise<void>((resolve, reject) => {
const ls = spawn(
'convert',
[inputPath, outputPath],
);
ls.on('close', (code) => {
if (code !== 0) {
reject(`convert exited with code ${code}`);
}
resolve();
});
ls.on('error', () => {
reject('Failed to start convert. Is it installed and in the PATH?');
});
});

/**
* Converts an image from one file format to another.
* @param inputPath The path of the image file
* @param targetMimetypes A list of target mimetypes
*/
const convertImage = async (inputPath: string, targetMimetypes = ['image/jpeg']): Promise<string|undefined> => {
let outputFilename;
for (const mimetype of targetMimetypes) {
if (/^image\/jpe?g$/.test(mimetype)) {
outputFilename = path.basename(inputPath) + '.jpg';
break;
} else if (mimetype === 'image/png') {
outputFilename = path.basename(inputPath) + '.png';
break;
}
}
if (outputFilename) {
const folder = await ensureTempFolder();
const outputPath = path.join(folder, outputFilename);
await spawnConvertProcess(inputPath, outputPath);
return outputPath;
}
};

export default convertImage;