From 24871a00d771db170c2578dc7f1a38909134ed1a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Ricks?= <bjoern.ricks@greenbone.net>
Date: Tue, 16 Apr 2024 11:32:03 +0200
Subject: [PATCH] Add: Add a useDownload hook

The useDownload hook in conjunction with the Download component should
replace the withDownload HOC in future.
---
 src/web/components/form/useDownload.jsx | 37 +++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 src/web/components/form/useDownload.jsx

diff --git a/src/web/components/form/useDownload.jsx b/src/web/components/form/useDownload.jsx
new file mode 100644
index 0000000000..160b586535
--- /dev/null
+++ b/src/web/components/form/useDownload.jsx
@@ -0,0 +1,37 @@
+/* SPDX-FileCopyrightText: 2024 Greenbone AG
+ *
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import {useRef, useCallback} from 'react';
+
+import logger from 'gmp/log';
+
+import {hasValue} from 'gmp/utils/identity';
+
+const log = logger.getLogger('web.components.form.useDownload');
+
+/**
+ * Hook to download a file
+ *
+ * Should be used in combination with the Download component
+ *
+ * @returns Array of downloadRef and download function
+ */
+const useDownload = () => {
+  const downloadRef = useRef(null);
+
+  const download = useCallback(({filename, data, mimetype}) => {
+    if (!hasValue(downloadRef.current)) {
+      log.warn('Download ref not set.');
+      return;
+    }
+
+    downloadRef.current.setFilename(filename);
+    downloadRef.current.setData(data, mimetype);
+    downloadRef.current.download();
+  }, []);
+  return [downloadRef, download];
+};
+
+export default useDownload;