/
FileUpload.java
471 lines (443 loc) · 15.3 KB
/
FileUpload.java
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* 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.
*/
package net.dv8tion.jda.api.utils;
import net.dv8tion.jda.api.utils.data.DataObject;
import net.dv8tion.jda.internal.requests.Requester;
import net.dv8tion.jda.internal.utils.Checks;
import net.dv8tion.jda.internal.utils.EntityString;
import net.dv8tion.jda.internal.utils.IOUtil;
import net.dv8tion.jda.internal.utils.requestbody.DataSupplierBody;
import net.dv8tion.jda.internal.utils.requestbody.TypedBody;
import okhttp3.MediaType;
import okhttp3.MultipartBody;
import okhttp3.RequestBody;
import okio.Okio;
import okio.Source;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.*;
import java.nio.file.Files;
import java.nio.file.OpenOption;
import java.nio.file.Path;
import java.util.function.Supplier;
/**
* Represents a file that is intended to be uploaded to Discord for arbitrary requests.
* <br>This is used to upload data to discord for various purposes.
*
* <p>The {@link InputStream} will be closed on consumption by the request.
* You can use {@link #close()} to close the stream manually.
*/
public class FileUpload implements Closeable, AttachedFile
{
private final InputStream resource;
private final Supplier<? extends Source> resourceSupplier;
private String name;
private TypedBody<?> body;
private String description;
protected FileUpload(InputStream resource, String name)
{
this.resource = resource;
this.resourceSupplier = null;
this.name = name;
}
protected FileUpload(Supplier<? extends Source> resourceSupplier, String name)
{
this.resourceSupplier = resourceSupplier;
this.resource = null;
this.name = name;
}
/**
* Creates a FileUpload that sources its data from the supplier.
* <br>The supplier <em>must</em> return a new stream on every call.
*
* <p>The streams are expected to always be at the beginning, when they are taken from the supplier.
* If the supplier returned the same stream instance, the reader would start at the wrong position when re-attempting a request.
*
* <p>When this supplier factory is used, {@link #getData()} will return a new instance on each call.
* It is the responsibility of the caller to close that stream.
*
* @param name
* The file name
* @param supplier
* The resource supplier, which returns a new stream on each call
*
* @throws IllegalArgumentException
* If null is provided or the name is blank
*
* @return {@link FileUpload}
*/
@Nonnull
public static FileUpload fromStreamSupplier(@Nonnull String name, @Nonnull Supplier<? extends InputStream> supplier)
{
Checks.notNull(supplier, "Supplier");
return fromSourceSupplier(name, () -> Okio.source(supplier.get()));
}
/**
* Creates a FileUpload that sources its data from the supplier.
* <br>The supplier <em>must</em> return a new stream on every call.
*
* <p>The streams are expected to always be at the beginning, when they are taken from the supplier.
* If the supplier returned the same stream instance, the reader would start at the wrong position when re-attempting a request.
*
* <p>When this supplier factory is used, {@link #getData()} will return a new instance on each call.
* It is the responsibility of the caller to close that stream.
*
* @param name
* The file name
* @param supplier
* The resource supplier, which returns a new {@link Source} on each call
*
* @throws IllegalArgumentException
* If null is provided or the name is blank
*
* @return {@link FileUpload}
*/
@Nonnull
public static FileUpload fromSourceSupplier(@Nonnull String name, @Nonnull Supplier<? extends Source> supplier)
{
Checks.notNull(supplier, "Supplier");
Checks.notBlank(name, "Name");
return new FileUpload(supplier, name);
}
/**
* Create a new {@link FileUpload} for an input stream.
* <br>This is used to upload data to discord for various purposes.
*
* <p>The {@link InputStream} will be closed on consumption by the request.
* You can use {@link FileUpload#close()} to close the stream manually.
*
* @param data
* The {@link InputStream} to upload
* @param name
* The representative name to use for the file
*
* @throws IllegalArgumentException
* If null is provided or the name is empty
*
* @return {@link FileUpload}
*
* @see java.io.FileInputStream FileInputStream
*/
@Nonnull
public static FileUpload fromData(@Nonnull InputStream data, @Nonnull String name)
{
Checks.notNull(data, "Data");
Checks.notBlank(name, "Name");
return new FileUpload(data, name);
}
/**
* Create a new {@link FileUpload} for a byte array.
* <br>This is used to upload data to discord for various purposes.
*
* @param data
* The {@code byte[]} to upload
* @param name
* The representative name to use for the file
*
* @throws IllegalArgumentException
* If null is provided or the name is empty
*
* @return {@link FileUpload}
*/
@Nonnull
public static FileUpload fromData(@Nonnull byte[] data, @Nonnull String name)
{
Checks.notNull(data, "Data");
Checks.notNull(name, "Name");
return fromData(new ByteArrayInputStream(data), name);
}
/**
* Create a new {@link FileUpload} for a local file.
* <br>This is used to upload data to discord for various purposes.
*
* <p>This opens a {@link FileInputStream}, which will be closed on consumption by the request.
* You can use {@link FileUpload#close()} to close the stream manually.
*
* @param file
* The {@link File} to upload
* @param name
* The representative name to use for the file
*
* @throws IllegalArgumentException
* If null is provided or the name is empty
* @throws UncheckedIOException
* If an IOException is thrown while opening the file
*
* @return {@link FileUpload}
*
* @see java.io.FileInputStream FileInputStream
*/
@Nonnull
public static FileUpload fromData(@Nonnull File file, @Nonnull String name)
{
Checks.notNull(file, "File");
try
{
return fromData(new FileInputStream(file), name);
}
catch (FileNotFoundException e)
{
throw new UncheckedIOException(e);
}
}
/**
* Create a new {@link FileUpload} for a local file.
* <br>This is used to upload data to discord for various purposes.
*
* <p>This opens a {@link FileInputStream}, which will be closed on consumption by the request.
* You can use {@link FileUpload#close()} to close the stream manually.
*
* @param file
* The {@link File} to upload
*
* @throws IllegalArgumentException
* If null is provided
* @throws UncheckedIOException
* If an IOException is thrown while opening the file
*
* @return {@link FileUpload}
*
* @see java.io.FileInputStream FileInputStream
* @see #fromData(File, String)
*/
@Nonnull
public static FileUpload fromData(@Nonnull File file)
{
Checks.notNull(file, "File");
try
{
return fromData(new FileInputStream(file), file.getName());
}
catch (FileNotFoundException e)
{
throw new UncheckedIOException(e);
}
}
/**
* Create a new {@link FileUpload} for a local file.
* <br>This is used to upload data to discord for various purposes.
*
* <p>This opens the path using {@link Files#newInputStream(Path, OpenOption...)}, which will be closed on consumption by the request.
* You can use {@link FileUpload#close()} to close the stream manually.
*
* @param path
* The {@link Path} of the file to upload
* @param name
* The representative name to use for the file
* @param options
* The {@link OpenOption OpenOptions} specifying how the file is opened
*
* @throws IllegalArgumentException
* If null is provided or the name is empty
* @throws UncheckedIOException
* If an IOException is thrown while opening the file
*
* @return {@link FileUpload}
*/
@Nonnull
public static FileUpload fromData(@Nonnull Path path, @Nonnull String name, @Nonnull OpenOption... options)
{
Checks.notNull(path, "Path");
Checks.noneNull(options, "Options");
Checks.check(Files.isReadable(path), "File for specified path cannot be read. Path: %s", path);
try
{
return fromData(Files.newInputStream(path, options), name);
}
catch (IOException e)
{
throw new UncheckedIOException("Could not open file for specified path. Path: " + path, e);
}
}
/**
* Create a new {@link FileUpload} for a local file.
* <br>This is used to upload data to discord for various purposes.
* Uses {@link Path#getFileName()} to specify the name of the file, to customize the filename use {@link #fromData(Path, String, OpenOption...)}.
*
* <p>This opens the path using {@link Files#newInputStream(Path, OpenOption...)}, which will be closed on consumption by the request.
* You can use {@link FileUpload#close()} to close the stream manually.
*
* @param path
* The {@link Path} of the file to upload
* @param options
* The {@link OpenOption OpenOptions} specifying how the file is opened
*
* @throws IllegalArgumentException
* If null is provided
* @throws UncheckedIOException
* If an IOException is thrown while opening the file
*
* @return {@link FileUpload}
*/
@Nonnull
public static FileUpload fromData(@Nonnull Path path, @Nonnull OpenOption... options)
{
Checks.notNull(path, "Path");
Path fileName = path.getFileName();
Checks.check(fileName != null, "Path does not have a file name. Path: %s", path);
return fromData(path, fileName.toString(), options);
}
/**
* Changes the name of this file, to be prefixed as {@code SPOILER_}.
* <br>This will cause the file to be rendered as a spoiler attachment in the client.
*
* @return The updated FileUpload instance
*/
@Nonnull
public FileUpload asSpoiler()
{
if (name.startsWith("SPOILER_"))
return this;
return setName("SPOILER_" + name);
}
/**
* Changes the name of this file.
*
* @param name
* The new filename
*
* @throws IllegalArgumentException
* If the name is null, blank, or empty
*
* @return The updated FileUpload instance
*/
@Nonnull
public FileUpload setName(@Nonnull String name)
{
Checks.notBlank(name, "Name");
this.name = name;
return this;
}
/**
* Set the file description used as ALT text for screenreaders.
*
* @param description
* The alt text describing this file attachment (up to {@value MAX_DESCRIPTION_LENGTH} characters)
*
* @throws IllegalArgumentException
* If the description is longer than {@value MAX_DESCRIPTION_LENGTH} characters
*
* @return The same FileUpload instance with the new description
*/
@Nonnull
public FileUpload setDescription(@Nullable String description)
{
if (description != null)
Checks.notLonger(description = description.trim(), MAX_DESCRIPTION_LENGTH, "Description");
this.description = description;
return this;
}
/**
* The filename for the file.
*
* @return The filename
*/
@Nonnull
public String getName()
{
return name;
}
/**
* The description for the file.
*
* @return The description
*/
@Nullable
public String getDescription()
{
return description;
}
/**
* The {@link InputStream} representing the data to upload as a file.
*
* @return The {@link InputStream}
*/
@Nonnull
public InputStream getData()
{
if (resource != null)
return resource;
else
return Okio.buffer(resourceSupplier.get()).inputStream();
}
/**
* Creates a re-usable instance of {@link RequestBody} with the specified content-type.
*
* <p>This body will automatically close the {@link #getData() resource} when the request is done.
* However, since the body buffers the data, it can be used multiple times regardless.
*
* @param type
* The content-type to use for the body (e.g. {@code "application/octet-stream"})
*
* @throws IllegalArgumentException
* If the content-type is null
*
* @return {@link RequestBody}
*/
@Nonnull
public synchronized RequestBody getRequestBody(@Nonnull MediaType type)
{
Checks.notNull(type, "Type");
if (body != null) // This allows FileUpload to be used more than once!
return body.withType(type);
if (resource == null)
return body = new DataSupplierBody(type, resourceSupplier);
else
return body = IOUtil.createRequestBody(type, resource);
}
@Override
@SuppressWarnings("ConstantConditions")
public synchronized void addPart(@Nonnull MultipartBody.Builder builder, int index)
{
builder.addFormDataPart("files[" + index + "]", name, getRequestBody(Requester.MEDIA_TYPE_OCTET));
}
@Nonnull
@Override
public DataObject toAttachmentData(int index)
{
return DataObject.empty()
.put("id", index)
.put("description", description == null ? "" : description)
.put("filename", name);
}
@Override
public synchronized void close() throws IOException
{
if (body == null)
forceClose();
}
@Override
public void forceClose() throws IOException
{
if (resource != null)
resource.close();
}
@Override
@SuppressWarnings("deprecation")
protected void finalize()
{
if (body == null && resource != null) // Only close if the resource was never used
IOUtil.silentClose(resource);
}
@Override
public String toString()
{
return new EntityString("AttachedFile")
.setType("Data")
.setName(name)
.toString();
}
}