src/utils/download.ts

/*
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import axios, { AxiosRequestConfig } from "axios";
import { createWriteStream } from "fs";
import { basename, join } from "path";
import stream from "stream";
import { promisify } from "util";
import { logInfo } from "./Logger";
import { sudoPrefix } from "./utils";

export const finished = promisify(stream.finished);

export async function downloadFile({ url, path, name, axiosOptions }: DownloadFileOptions) {
    logInfo("Attempting to download file: " + url);

    const storagePath = path ?? sudoPrefix("storage");
    const filePath = join(storagePath, name ?? basename(url));
    const writer = createWriteStream(filePath);
    const response = await axios.request({
        method: "GET",
        url,
        responseType: "stream",
        ...axiosOptions
    });

    if (response.status < 200 || response.status >= 300) {
        throw new Error("HTTP error: Non 2xx response received: code " + response.status);
    }

    response.data.pipe(writer);

    await finished(writer);

    if (!writer.closed) await promisify(writer.close.bind(writer))();

    logInfo("Saved downloaded file to: " + filePath);

    return {
        filePath,
        storagePath
    };
}

interface DownloadFileOptions {
    url: string;
    path?: string;
    name?: string;
    axiosOptions?: AxiosRequestConfig;
}
1	rakinar2	577	/*
2			* This file is part of SudoBot.
3			*
4			* Copyright (C) 2021-2023 OSN Developers.
5			*
6			* SudoBot is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU Affero General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* SudoBot is distributed in the hope that it will be useful, but
12			* WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU Affero General Public License for more details.
15			*
16			* You should have received a copy of the GNU Affero General Public License
17			* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			import axios, { AxiosRequestConfig } from "axios";
21			import { createWriteStream } from "fs";
22			import { basename, join } from "path";
23			import stream from "stream";
24			import { promisify } from "util";
25			import { logInfo } from "./Logger";
26			import { sudoPrefix } from "./utils";
27
28			export const finished = promisify(stream.finished);
29
30			export async function downloadFile({ url, path, name, axiosOptions }: DownloadFileOptions) {
31			logInfo("Attempting to download file: " + url);
32
33			const storagePath = path ?? sudoPrefix("storage");
34			const filePath = join(storagePath, name ?? basename(url));
35			const writer = createWriteStream(filePath);
36			const response = await axios.request({
37			method: "GET",
38			url,
39			responseType: "stream",
40			...axiosOptions
41			});
42
43			if (response.status < 200 \|\| response.status >= 300) {
44			throw new Error("HTTP error: Non 2xx response received: code " + response.status);
45			}
46
47			response.data.pipe(writer);
48
49			await finished(writer);
50
51			if (!writer.closed) await promisify(writer.close.bind(writer))();
52
53			logInfo("Saved downloaded file to: " + filePath);
54
55			return {
56			filePath,
57			storagePath
58			};
59			}
60
61			interface DownloadFileOptions {
62			url: string;
63			path?: string;
64			name?: string;
65			axiosOptions?: AxiosRequestConfig;
66			}