HttpDownloadConnection.java

  1package eu.siacs.conversations.http;
  2
  3import android.util.Log;
  4
  5import androidx.annotation.Nullable;
  6
  7import com.google.common.base.Strings;
  8import com.google.common.io.ByteStreams;
  9import com.google.common.primitives.Longs;
 10
 11import java.io.FileInputStream;
 12import java.io.IOException;
 13import java.io.InputStream;
 14import java.io.OutputStream;
 15import java.util.Locale;
 16
 17import javax.net.ssl.SSLHandshakeException;
 18
 19import eu.siacs.conversations.Config;
 20import eu.siacs.conversations.R;
 21import eu.siacs.conversations.entities.DownloadableFile;
 22import eu.siacs.conversations.entities.Message;
 23import eu.siacs.conversations.entities.Transferable;
 24import eu.siacs.conversations.persistance.FileBackend;
 25import eu.siacs.conversations.services.AbstractConnectionManager;
 26import eu.siacs.conversations.services.XmppConnectionService;
 27import eu.siacs.conversations.utils.CryptoHelper;
 28import eu.siacs.conversations.utils.FileWriterException;
 29import eu.siacs.conversations.utils.MimeUtils;
 30import okhttp3.Call;
 31import okhttp3.HttpUrl;
 32import okhttp3.OkHttpClient;
 33import okhttp3.Request;
 34import okhttp3.Response;
 35
 36import static eu.siacs.conversations.http.HttpConnectionManager.EXECUTOR;
 37
 38public class HttpDownloadConnection implements Transferable {
 39
 40    private final Message message;
 41    private final HttpConnectionManager mHttpConnectionManager;
 42    private final XmppConnectionService mXmppConnectionService;
 43    private HttpUrl mUrl;
 44    private DownloadableFile file;
 45    private int mStatus = Transferable.STATUS_UNKNOWN;
 46    private boolean acceptedAutomatically = false;
 47    private int mProgress = 0;
 48    private Call mostRecentCall;
 49
 50    HttpDownloadConnection(Message message, HttpConnectionManager manager) {
 51        this.message = message;
 52        this.mHttpConnectionManager = manager;
 53        this.mXmppConnectionService = manager.getXmppConnectionService();
 54    }
 55
 56    @Override
 57    public boolean start() {
 58        if (mXmppConnectionService.hasInternetConnection()) {
 59            if (this.mStatus == STATUS_OFFER_CHECK_FILESIZE) {
 60                checkFileSize(true);
 61            } else {
 62                download(true);
 63            }
 64            return true;
 65        } else {
 66            return false;
 67        }
 68    }
 69
 70    public void init(boolean interactive) {
 71        if (message.isDeleted()) {
 72            if (message.getType() == Message.TYPE_PRIVATE_FILE) {
 73                message.setType(Message.TYPE_PRIVATE);
 74            } else if (message.isFileOrImage()) {
 75                message.setType(Message.TYPE_TEXT);
 76            }
 77            message.setOob(true);
 78            message.setDeleted(false);
 79            mXmppConnectionService.updateMessage(message);
 80        }
 81        this.message.setTransferable(this);
 82        try {
 83            final Message.FileParams fileParams = message.getFileParams();
 84            if (message.hasFileOnRemoteHost()) {
 85                mUrl = AesGcmURL.of(fileParams.url);
 86            } else if (message.isOOb() && fileParams.url != null && fileParams.size != null) {
 87                mUrl = AesGcmURL.of(fileParams.url);
 88            } else {
 89                mUrl = AesGcmURL.of(message.getBody().split("\n")[0]);
 90            }
 91            final AbstractConnectionManager.Extension extension = AbstractConnectionManager.Extension.of(mUrl.encodedPath());
 92            if (VALID_CRYPTO_EXTENSIONS.contains(extension.main)) {
 93                this.message.setEncryption(Message.ENCRYPTION_PGP);
 94            } else if (message.getEncryption() != Message.ENCRYPTION_AXOLOTL) {
 95                this.message.setEncryption(Message.ENCRYPTION_NONE);
 96            }
 97            final String ext = extension.getExtension();
 98            final String filename = Strings.isNullOrEmpty(ext) ? message.getUuid() : String.format("%s.%s", message.getUuid(), ext);
 99            mXmppConnectionService.getFileBackend().setupRelativeFilePath(message, filename);
100            setupFile();
101            if (this.message.getEncryption() == Message.ENCRYPTION_AXOLOTL && this.file.getKey() == null) {
102                this.message.setEncryption(Message.ENCRYPTION_NONE);
103            }
104            final Long knownFileSize;
105            if (message.getEncryption() == Message.ENCRYPTION_PGP || message.getEncryption() == Message.ENCRYPTION_DECRYPTED) {
106                knownFileSize = null;
107            } else {
108                knownFileSize = message.getFileParams().size;
109            }
110            Log.d(Config.LOGTAG,"knownFileSize: "+knownFileSize+", body="+message.getBody());
111            if (knownFileSize != null && interactive) {
112                if (message.getEncryption() == Message.ENCRYPTION_AXOLOTL
113                        && this.file.getKey() != null) {
114                    this.file.setExpectedSize(knownFileSize + 16);
115                } else {
116                    this.file.setExpectedSize(knownFileSize);
117                }
118                download(true);
119            } else {
120                checkFileSize(interactive);
121            }
122        } catch (final IllegalArgumentException e) {
123            this.cancel();
124        }
125    }
126
127    private void setupFile() {
128        final String reference = mUrl.fragment();
129        if (reference != null && AesGcmURL.IV_KEY.matcher(reference).matches()) {
130            this.file = new DownloadableFile(mXmppConnectionService.getCacheDir(), message.getUuid());
131            this.file.setKeyAndIv(CryptoHelper.hexToBytes(reference));
132            Log.d(Config.LOGTAG, "create temporary OMEMO encrypted file: " + this.file.getAbsolutePath() + "(" + message.getMimeType() + ")");
133        } else {
134            this.file = mXmppConnectionService.getFileBackend().getFile(message, false);
135        }
136    }
137
138    private void download(final boolean interactive) {
139        EXECUTOR.execute(new FileDownloader(interactive));
140    }
141
142    private void checkFileSize(final boolean interactive) {
143        EXECUTOR.execute(new FileSizeChecker(interactive));
144    }
145
146    @Override
147    public void cancel() {
148        final Call call = this.mostRecentCall;
149        if (call != null && !call.isCanceled()) {
150            call.cancel();
151        }
152        mHttpConnectionManager.finishConnection(this);
153        message.setTransferable(null);
154        if (message.isFileOrImage()) {
155            message.setDeleted(true);
156        }
157        mHttpConnectionManager.updateConversationUi(true);
158    }
159
160    private void decryptFile() throws IOException {
161        final DownloadableFile outputFile = mXmppConnectionService.getFileBackend().getFile(message, true);
162
163        if (outputFile.getParentFile().mkdirs()) {
164            Log.d(Config.LOGTAG, "created parent directories for " + outputFile.getAbsolutePath());
165        }
166
167        if (!outputFile.createNewFile()) {
168            Log.w(Config.LOGTAG, "unable to create output file " + outputFile.getAbsolutePath());
169        }
170
171        final InputStream is = new FileInputStream(this.file);
172
173        outputFile.setKey(this.file.getKey());
174        outputFile.setIv(this.file.getIv());
175        final OutputStream os = AbstractConnectionManager.createOutputStream(outputFile, false, true);
176
177        ByteStreams.copy(is, os);
178
179        FileBackend.close(is);
180        FileBackend.close(os);
181
182        if (!file.delete()) {
183            Log.w(Config.LOGTAG, "unable to delete temporary OMEMO encrypted file " + file.getAbsolutePath());
184        }
185    }
186
187    private void finish() {
188        message.setTransferable(null);
189        mHttpConnectionManager.finishConnection(this);
190        boolean notify = acceptedAutomatically && !message.isRead();
191        if (message.getEncryption() == Message.ENCRYPTION_PGP) {
192            notify = message.getConversation().getAccount().getPgpDecryptionService().decrypt(message, notify);
193        }
194        mHttpConnectionManager.updateConversationUi(true);
195        final boolean notifyAfterScan = notify;
196        final DownloadableFile file = mXmppConnectionService.getFileBackend().getFile(message, true);
197        mXmppConnectionService.getFileBackend().updateMediaScanner(file, () -> {
198            if (notifyAfterScan) {
199                mXmppConnectionService.getNotificationService().push(message);
200            }
201        });
202    }
203
204    private void decryptIfNeeded() throws IOException {
205        if (file.getKey() != null && file.getIv() != null) {
206            decryptFile();
207        }
208    }
209
210    private void changeStatus(int status) {
211        this.mStatus = status;
212        mHttpConnectionManager.updateConversationUi(true);
213    }
214
215    private void showToastForException(final Exception e) {
216        final Call call = mostRecentCall;
217        final boolean cancelled = call != null && call.isCanceled();
218        if (e == null || cancelled) {
219            return;
220        }
221        if (e instanceof java.net.UnknownHostException) {
222            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_server_not_found);
223        } else if (e instanceof java.net.ConnectException) {
224            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_could_not_connect);
225        } else if (e instanceof FileWriterException) {
226            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_could_not_write_file);
227        } else if (e instanceof InvalidFileException) {
228            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_invalid_file);
229        } else {
230            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_file_not_found);
231        }
232    }
233
234    private void updateProgress(long i) {
235        this.mProgress = (int) i;
236        mHttpConnectionManager.updateConversationUi(false);
237    }
238
239    @Override
240    public int getStatus() {
241        return this.mStatus;
242    }
243
244    @Override
245    public Long getFileSize() {
246        if (this.file != null) {
247            return this.file.getExpectedSize();
248        } else {
249            return null;
250        }
251    }
252
253    @Override
254    public int getProgress() {
255        return this.mProgress;
256    }
257
258    public Message getMessage() {
259        return message;
260    }
261
262    private class FileSizeChecker implements Runnable {
263
264        private final boolean interactive;
265
266        FileSizeChecker(boolean interactive) {
267            this.interactive = interactive;
268        }
269
270
271        @Override
272        public void run() {
273            check();
274        }
275
276        private void retrieveFailed(@Nullable final Exception e) {
277            changeStatus(STATUS_OFFER_CHECK_FILESIZE);
278            if (interactive) {
279                showToastForException(e);
280            } else {
281                HttpDownloadConnection.this.acceptedAutomatically = false;
282                HttpDownloadConnection.this.mXmppConnectionService.getNotificationService().push(message);
283            }
284            cancel();
285        }
286
287        private void check() {
288            long size;
289            try {
290                size = retrieveFileSize();
291            } catch (final Exception e) {
292                Log.d(Config.LOGTAG, "io exception in http file size checker: " + e.getMessage());
293                retrieveFailed(e);
294                return;
295            }
296            final Message.FileParams fileParams = message.getFileParams();
297            FileBackend.updateFileParams(message, fileParams.url, size);
298            message.setOob(true);
299            mXmppConnectionService.databaseBackend.updateMessage(message, true);
300            file.setExpectedSize(size);
301            message.resetFileParams();
302            if (mHttpConnectionManager.hasStoragePermission()
303                    && size <= mHttpConnectionManager.getAutoAcceptFileSize()
304                    && mXmppConnectionService.isDataSaverDisabled()) {
305                HttpDownloadConnection.this.acceptedAutomatically = true;
306                download(interactive);
307            } else {
308                changeStatus(STATUS_OFFER);
309                HttpDownloadConnection.this.acceptedAutomatically = false;
310                HttpDownloadConnection.this.mXmppConnectionService.getNotificationService().push(message);
311            }
312        }
313
314        private long retrieveFileSize() throws IOException {
315            Log.d(Config.LOGTAG, "retrieve file size. interactive:" + interactive);
316            changeStatus(STATUS_CHECKING);
317            final OkHttpClient client = mHttpConnectionManager.buildHttpClient(
318                    mUrl,
319                    message.getConversation().getAccount(),
320                    interactive
321            );
322            final Request request = new Request.Builder()
323                    .url(URL.stripFragment(mUrl))
324                    .addHeader("Accept-Encoding", "identity")
325                    .head()
326                    .build();
327            mostRecentCall = client.newCall(request);
328            try {
329                final Response response = mostRecentCall.execute();
330                throwOnInvalidCode(response);
331                final String contentLength = response.header("Content-Length");
332                final String contentType = response.header("Content-Type");
333                final AbstractConnectionManager.Extension extension = AbstractConnectionManager.Extension.of(mUrl.encodedPath());
334                if (Strings.isNullOrEmpty(extension.getExtension()) && contentType != null) {
335                    final String fileExtension = MimeUtils.guessExtensionFromMimeType(contentType);
336                    if (fileExtension != null) {
337                        mXmppConnectionService.getFileBackend().setupRelativeFilePath(message, String.format("%s.%s", message.getUuid(), fileExtension), contentType);
338                        Log.d(Config.LOGTAG, "rewriting name after not finding extension in url but in content type");
339                        setupFile();
340                    }
341                }
342                if (Strings.isNullOrEmpty(contentLength)) {
343                    throw new IOException("no content-length found in HEAD response");
344                }
345                final long size = Long.parseLong(contentLength, 10);
346                if (size < 0) {
347                    throw new IOException("Server reported negative file size");
348                }
349                return size;
350            } catch (final IOException e) {
351                Log.d(Config.LOGTAG, "io exception during HEAD " + e.getMessage());
352                throw e;
353            } catch (final NumberFormatException e) {
354                throw new IOException(e);
355            }
356        }
357
358    }
359
360    private class FileDownloader implements Runnable {
361
362        private final boolean interactive;
363
364        public FileDownloader(boolean interactive) {
365            this.interactive = interactive;
366        }
367
368        @Override
369        public void run() {
370            try {
371                changeStatus(STATUS_DOWNLOADING);
372                download();
373                decryptIfNeeded();
374                updateImageBounds();
375                finish();
376            } catch (final SSLHandshakeException e) {
377                changeStatus(STATUS_OFFER);
378            } catch (final Exception e) {
379                Log.d(Config.LOGTAG, message.getConversation().getAccount().getJid().asBareJid() + ": unable to download file", e);
380                if (interactive) {
381                    showToastForException(e);
382                } else {
383                    HttpDownloadConnection.this.acceptedAutomatically = false;
384                    HttpDownloadConnection.this.mXmppConnectionService.getNotificationService().push(message);
385                }
386                cancel();
387            }
388        }
389
390        private void download() throws Exception {
391            final OkHttpClient client = mHttpConnectionManager.buildHttpClient(
392                    mUrl,
393                    message.getConversation().getAccount(),
394                    interactive
395            );
396
397            final Request.Builder requestBuilder = new Request.Builder().url(URL.stripFragment(mUrl));
398
399            final long expected = file.getExpectedSize();
400            final boolean tryResume = file.exists() && file.getSize() > 0 && file.getSize() < expected;
401            final long resumeSize;
402            if (tryResume) {
403                resumeSize = file.getSize();
404                Log.d(Config.LOGTAG, "http download trying resume after " + resumeSize + " of " + expected);
405                requestBuilder.addHeader("Range", String.format(Locale.ENGLISH, "bytes=%d-", resumeSize));
406            } else {
407                resumeSize = 0;
408            }
409            final Request request = requestBuilder.build();
410            mostRecentCall = client.newCall(request);
411            final Response response = mostRecentCall.execute();
412            throwOnInvalidCode(response);
413            final String contentRange = response.header("Content-Range");
414            final boolean serverResumed = tryResume && contentRange != null && contentRange.startsWith("bytes " + resumeSize + "-");
415            final InputStream inputStream = response.body().byteStream();
416            final OutputStream outputStream;
417            long transmitted = 0;
418            if (tryResume && serverResumed) {
419                Log.d(Config.LOGTAG, "server resumed");
420                transmitted = file.getSize();
421                updateProgress(Math.round(((double) transmitted / expected) * 100));
422                outputStream = AbstractConnectionManager.createOutputStream(file, true, false);
423            } else {
424                final String contentLength = response.header("Content-Length");
425                final long size = Strings.isNullOrEmpty(contentLength) ? 0 : Longs.tryParse(contentLength);
426                if (expected != size) {
427                    Log.d(Config.LOGTAG, "content-length reported on GET (" + size + ") did not match Content-Length reported on HEAD (" + expected + ")");
428                }
429                file.getParentFile().mkdirs();
430                Log.d(Config.LOGTAG,"creating file: "+file.getAbsolutePath());
431                if (!file.exists() && !file.createNewFile()) {
432                    throw new FileWriterException(file);
433                }
434                outputStream = AbstractConnectionManager.createOutputStream(file, false, false);
435            }
436            int count;
437            final byte[] buffer = new byte[4096];
438            while ((count = inputStream.read(buffer)) != -1) {
439                transmitted += count;
440                try {
441                    outputStream.write(buffer, 0, count);
442                } catch (final IOException e) {
443                    throw new FileWriterException(file);
444                }
445                if (transmitted > expected) {
446                    throw new InvalidFileException(String.format("File exceeds expected size of %d", expected));
447                }
448                updateProgress(Math.round(((double) transmitted / expected) * 100));
449            }
450            outputStream.flush();
451        }
452
453        private void updateImageBounds() {
454            final boolean privateMessage = message.isPrivateMessage();
455            message.setType(privateMessage ? Message.TYPE_PRIVATE_FILE : Message.TYPE_FILE);
456            final String url;
457            final String ref = mUrl.fragment();
458            if (ref != null && AesGcmURL.IV_KEY.matcher(ref).matches()) {
459                url = AesGcmURL.toAesGcmUrl(mUrl);
460            } else {
461                url = mUrl.toString();
462            }
463            mXmppConnectionService.getFileBackend().updateFileParams(message, url);
464            mXmppConnectionService.updateMessage(message);
465        }
466
467    }
468
469    private static void throwOnInvalidCode(final Response response) throws IOException {
470        final int code = response.code();
471        if (code < 200 || code >= 300) {
472            throw new IOException(String.format(Locale.ENGLISH, "HTTP Status code was %d", code));
473        }
474    }
475
476    private static class InvalidFileException extends IOException {
477
478        private InvalidFileException(final String message) {
479            super(message);
480        }
481
482    }
483}