forked from bluerobotics/BlueOS
/
filebrowser.ts
180 lines (162 loc) · 5.68 KB
/
filebrowser.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
import Notifier from '@/libs/notifier'
import { FilebrowserCredentials, FilebrowserFile, FilebrowserFolder } from '@/types/filebrowser'
import { filebrowser_service } from '@/types/frontend_services'
import back_axios from '@/utils/api'
const notifier = new Notifier(filebrowser_service)
const filebrowser_url = '/file-browser/api'
const filebrowser_credentials: FilebrowserCredentials = { username: '', password: '', recaptcha: '' }
class Filebrowser {
auth_token: string | null
constructor() {
this.auth_token = null
this.updateFilebrowserToken()
}
/* Fetch filebrowser API for a authentication token and store it.
This method should be called on constructor so other methods have a token to use. */
async updateFilebrowserToken(): Promise<void> {
await back_axios({
method: 'post',
url: `${filebrowser_url}/login`,
timeout: 10000,
data: filebrowser_credentials,
})
.then((response) => {
this.auth_token = response.data
})
.catch((error) => {
const message = `Could not authenticate to filebrowser API: ${error.message}`
notifier.pushError('FILEBROWSER_AUTH_FAIL', message)
throw new Error(error)
})
}
/* Helper to get the auth token, checking before if it was set. */
async filebrowserToken(): Promise<string> {
if (this.auth_token === null) {
await this.updateFilebrowserToken()
if (this.auth_token === null) {
throw new Error('Authentication token not set.')
}
}
return this.auth_token
}
/* Fetch a folder from filebrowser. */
/**
* @param folder_path - String absolute path of folder to be fetched
* @returns FilebrowserFolder object
* */
async fetchFolder(folder_path: string): Promise<FilebrowserFolder> {
return back_axios({
method: 'get',
url: `${filebrowser_url}/resources${folder_path}`,
timeout: 10000,
headers: { 'X-Auth': await this.filebrowserToken() },
})
.then((response) => response.data)
.catch((error) => {
const message = `Could not fetch folder ${folder_path}: ${error.message}`
notifier.pushError('FOLDER_FETCH_FAIL', message)
throw new Error(message)
})
}
async createFolder(folder_path: string): Promise<void> {
if (!folder_path.endsWith('/')) {
folder_path += '/'
}
this.createFile(folder_path)
}
async createFile(folder_path: string, override: Boolean = false): Promise<void> {
back_axios({
method: 'post',
url: `${filebrowser_url}/resources${folder_path}?override=${override}`,
timeout: 10000,
headers: { 'X-Auth': await this.filebrowserToken() },
})
.catch((error) => {
const message = `Could not create folder ${folder_path}: ${error.message}`
notifier.pushError('FOLDER_CREATE_FAIL', message)
throw new Error(message)
})
}
async writeToFile(file: string, content: string): Promise<void> {
back_axios({
method: 'put',
url: `/file-browser/api/resources${file}`,
timeout: 10000,
headers: { 'X-Auth': await this.filebrowserToken() },
data: content,
})
.catch((error) => {
const message = `Could not write to file ${file}: ${error.message}`
notifier.pushError('FILE_WRITE_FAIL', message)
throw new Error(message)
})
}
/* Delete a single file. */
/* Register a notification and throws if delete fails. */
/**
* @param file - FilebrowserFile object to be deleted
* */
async deleteFile(file: FilebrowserFile): Promise<void> {
back_axios({
method: 'delete',
url: `/file-browser/api/resources${file.path}`,
timeout: 10000,
headers: { 'X-Auth': await this.filebrowserToken() },
})
.catch((error) => {
const message = `Could not delete file ${file.path}: ${error.message}`
notifier.pushError('FILE_DELETE_FAIL', message)
throw new Error(message)
})
}
/* Performs multiple-file delete requests. */
/* Will perform all possible delete operations and reject if any of them fails. */
/**
* @param files - FilebrowserFile objects to be deleted
* */
async deleteFiles(files: FilebrowserFile[]): Promise<void> {
const delete_promises: Promise<void>[] = []
files.forEach((file) => {
delete_promises.push(this.deleteFile(file))
})
await Promise.all(delete_promises)
}
/* Returns the relative URL (without hostname) of a single file. */
/**
* @param file - FilebrowserFile object
* */
async singleFileRelativeURL(file: FilebrowserFile): Promise<string> {
return `${filebrowser_url}/raw${file.path}?auth=${await this.filebrowserToken()}`
}
/* Returns the relative URL (without hostname) of a zip of multiple files. */
/**
* @param files - FilebrowserFile objects
* */
async multipleFilesRelativeURL(files: FilebrowserFile[]): Promise<string> {
const files_arg = files.map((file) => file.path).join(',')
return `${filebrowser_url}/raw/?files=${files_arg}&algo=zip&auth=${await this.filebrowserToken()}`
}
/* Download files (single or multiple). */
/**
* @param files - FilebrowserFile objects array
* */
async downloadFiles(files: FilebrowserFile[]): Promise<void> {
let url = ''
if (files.length === 1) {
url = await this.singleFileRelativeURL(files[0])
} else {
url = await this.multipleFilesRelativeURL(files)
}
window.open(url)
}
/* Download folder */
/**
* @param folder - FilebrowserFolder
* */
async downloadFolder(folder: FilebrowserFolder): Promise<void> {
const url = `${filebrowser_url}/raw/${folder.path}/?algo=zip&auth=${await this.filebrowserToken()}`
window.open(url)
}
}
const filebrowser = new Filebrowser()
export default filebrowser