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        final Message.FileParams fileParams = message.getFileParams();
 72        if (message.isDeleted()) {
 73            if (message.getType() == Message.TYPE_PRIVATE_FILE) {
 74                message.setType(Message.TYPE_PRIVATE);
 75            } else if (message.isFileOrImage()) {
 76                message.setType(Message.TYPE_TEXT);
 77            }
 78            message.setDeleted(false);
 79            mXmppConnectionService.updateMessage(message);
 80        }
 81        this.message.setTransferable(this);
 82        try {
 83            if (message.hasFileOnRemoteHost()) {
 84                mUrl = AesGcmURL.of(fileParams.url);
 85            } else if (message.isOOb() && fileParams.url != null) {
 86                mUrl = AesGcmURL.of(fileParams.url);
 87            } else {
 88                mUrl = AesGcmURL.of(message.getBody().split("\n")[0]);
 89            }
 90            final AbstractConnectionManager.Extension extension = AbstractConnectionManager.Extension.of(mUrl.encodedPath());
 91            if (VALID_CRYPTO_EXTENSIONS.contains(extension.main)) {
 92                this.message.setEncryption(Message.ENCRYPTION_PGP);
 93            } else if (message.getEncryption() != Message.ENCRYPTION_OTR
 94                    && 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        boolean notify = acceptedAutomatically && !message.isRead();
189        if (message.getEncryption() == Message.ENCRYPTION_PGP) {
190            notify = message.getConversation().getAccount().getPgpDecryptionService().decrypt(message, notify);
191        }
192        DownloadableFile file;
193        final DownloadableFile tmp = mXmppConnectionService.getFileBackend().getFile(message);
194        final String extension = MimeUtils.extractRelevantExtension(tmp.getName());
195        try {
196            mXmppConnectionService.getFileBackend().setupRelativeFilePath(message, new FileInputStream(tmp), extension);
197            file = mXmppConnectionService.getFileBackend().getFile(message);
198            tmp.renameTo(file);
199        } catch (final IOException e) {
200            file = tmp;
201        }
202        message.setTransferable(null);
203        mXmppConnectionService.updateMessage(message);
204        mHttpConnectionManager.finishConnection(this);
205        final boolean notifyAfterScan = notify;
206        mXmppConnectionService.getFileBackend().updateMediaScanner(file, () -> {
207            if (notifyAfterScan) {
208                mXmppConnectionService.getNotificationService().push(message);
209            }
210        });
211    }
212
213    private void decryptIfNeeded() throws IOException {
214        if (file.getKey() != null && file.getIv() != null) {
215            decryptFile();
216        }
217    }
218
219    private void changeStatus(int status) {
220        this.mStatus = status;
221        mHttpConnectionManager.updateConversationUi(true);
222    }
223
224    private void showToastForException(final Exception e) {
225        final Call call = mostRecentCall;
226        final boolean cancelled = call != null && call.isCanceled();
227        if (e == null || cancelled) {
228            return;
229        }
230        if (e instanceof java.net.UnknownHostException) {
231            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_server_not_found);
232        } else if (e instanceof java.net.ConnectException) {
233            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_could_not_connect);
234        } else if (e instanceof FileWriterException) {
235            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_could_not_write_file);
236        } else if (e instanceof InvalidFileException) {
237            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_invalid_file);
238        } else {
239            mXmppConnectionService.showErrorToastInUi(R.string.download_failed_file_not_found);
240        }
241    }
242
243    private void updateProgress(long i) {
244        this.mProgress = (int) i;
245        mHttpConnectionManager.updateConversationUi(false);
246    }
247
248    @Override
249    public int getStatus() {
250        return this.mStatus;
251    }
252
253    @Override
254    public Long getFileSize() {
255        if (this.file != null) {
256            return this.file.getExpectedSize();
257        } else {
258            return null;
259        }
260    }
261
262    @Override
263    public int getProgress() {
264        return this.mProgress;
265    }
266
267    public Message getMessage() {
268        return message;
269    }
270
271    private class FileSizeChecker implements Runnable {
272
273        private final boolean interactive;
274
275        FileSizeChecker(boolean interactive) {
276            this.interactive = interactive;
277        }
278
279
280        @Override
281        public void run() {
282            check();
283        }
284
285        private void retrieveFailed(@Nullable final Exception e) {
286            changeStatus(STATUS_OFFER_CHECK_FILESIZE);
287            if (interactive) {
288                showToastForException(e);
289            } else {
290                HttpDownloadConnection.this.acceptedAutomatically = false;
291                HttpDownloadConnection.this.mXmppConnectionService.getNotificationService().push(message);
292            }
293            cancel();
294        }
295
296        private void check() {
297            long size;
298            try {
299                size = retrieveFileSize();
300            } catch (final Exception e) {
301                Log.d(Config.LOGTAG, "io exception in http file size checker: " + e.getMessage());
302                retrieveFailed(e);
303                return;
304            }
305            final Message.FileParams fileParams = message.getFileParams();
306            FileBackend.updateFileParams(message, fileParams.url, size);
307            mXmppConnectionService.databaseBackend.updateMessage(message, true);
308            file.setExpectedSize(size);
309            message.resetFileParams();
310            if (mHttpConnectionManager.hasStoragePermission()
311                    && size <= mHttpConnectionManager.getAutoAcceptFileSize()
312                    && mXmppConnectionService.isDataSaverDisabled()) {
313                HttpDownloadConnection.this.acceptedAutomatically = true;
314                download(interactive);
315            } else {
316                changeStatus(STATUS_OFFER);
317                HttpDownloadConnection.this.acceptedAutomatically = false;
318                HttpDownloadConnection.this.mXmppConnectionService.getNotificationService().push(message);
319            }
320        }
321
322        private long retrieveFileSize() throws IOException {
323            Log.d(Config.LOGTAG, "retrieve file size. interactive:" + interactive);
324            changeStatus(STATUS_CHECKING);
325            final OkHttpClient client = mHttpConnectionManager.buildHttpClient(
326                    mUrl,
327                    message.getConversation().getAccount(),
328                    interactive
329            );
330            final Request request = new Request.Builder()
331                    .url(URL.stripFragment(mUrl))
332                    .addHeader("Accept-Encoding", "identity")
333                    .head()
334                    .build();
335            mostRecentCall = client.newCall(request);
336            try {
337                final Response response = mostRecentCall.execute();
338                throwOnInvalidCode(response);
339                final String contentLength = response.header("Content-Length");
340                final String contentType = response.header("Content-Type");
341                final AbstractConnectionManager.Extension extension = AbstractConnectionManager.Extension.of(mUrl.encodedPath());
342                if (Strings.isNullOrEmpty(extension.getExtension()) && contentType != null) {
343                    final String fileExtension = MimeUtils.guessExtensionFromMimeType(contentType);
344                    if (fileExtension != null) {
345                        mXmppConnectionService.getFileBackend().setupRelativeFilePath(message, String.format("%s.%s", message.getUuid(), fileExtension), contentType);
346                        Log.d(Config.LOGTAG, "rewriting name after not finding extension in url but in content type");
347                        setupFile();
348                    }
349                }
350                if (Strings.isNullOrEmpty(contentLength)) {
351                    throw new IOException("no content-length found in HEAD response");
352                }
353                final long size = Long.parseLong(contentLength, 10);
354                if (size < 0) {
355                    throw new IOException("Server reported negative file size");
356                }
357                return size;
358            } catch (final IOException e) {
359                Log.d(Config.LOGTAG, "io exception during HEAD " + e.getMessage());
360                throw e;
361            } catch (final NumberFormatException e) {
362                throw new IOException(e);
363            }
364        }
365
366    }
367
368    private class FileDownloader implements Runnable {
369
370        private final boolean interactive;
371
372        public FileDownloader(boolean interactive) {
373            this.interactive = interactive;
374        }
375
376        @Override
377        public void run() {
378            try {
379                changeStatus(STATUS_DOWNLOADING);
380                download();
381                decryptIfNeeded();
382                finish();
383                updateImageBounds();
384            } catch (final SSLHandshakeException e) {
385                changeStatus(STATUS_OFFER);
386            } catch (final Exception e) {
387                Log.d(Config.LOGTAG, message.getConversation().getAccount().getJid().asBareJid() + ": unable to download file", e);
388                if (interactive) {
389                    showToastForException(e);
390                } else {
391                    HttpDownloadConnection.this.acceptedAutomatically = false;
392                    HttpDownloadConnection.this.mXmppConnectionService.getNotificationService().push(message);
393                }
394                cancel();
395            }
396        }
397
398        private void download() throws Exception {
399            final OkHttpClient client = mHttpConnectionManager.buildHttpClient(
400                    mUrl,
401                    message.getConversation().getAccount(),
402                    interactive
403            );
404
405            final Request.Builder requestBuilder = new Request.Builder().url(URL.stripFragment(mUrl));
406
407            final long expected = file.getExpectedSize();
408            final boolean tryResume = file.exists() && file.getSize() > 0 && file.getSize() < expected;
409            final long resumeSize;
410            if (tryResume) {
411                resumeSize = file.getSize();
412                Log.d(Config.LOGTAG, "http download trying resume after " + resumeSize + " of " + expected);
413                requestBuilder.addHeader("Range", String.format(Locale.ENGLISH, "bytes=%d-", resumeSize));
414            } else {
415                resumeSize = 0;
416            }
417            final Request request = requestBuilder.build();
418            mostRecentCall = client.newCall(request);
419            final Response response = mostRecentCall.execute();
420            throwOnInvalidCode(response);
421            final String contentRange = response.header("Content-Range");
422            final boolean serverResumed = tryResume && contentRange != null && contentRange.startsWith("bytes " + resumeSize + "-");
423            final InputStream inputStream = response.body().byteStream();
424            final OutputStream outputStream;
425            long transmitted = 0;
426            if (tryResume && serverResumed) {
427                Log.d(Config.LOGTAG, "server resumed");
428                transmitted = file.getSize();
429                updateProgress(Math.round(((double) transmitted / expected) * 100));
430                outputStream = AbstractConnectionManager.createOutputStream(file, true, false);
431            } else {
432                final String contentLength = response.header("Content-Length");
433                final long size = Strings.isNullOrEmpty(contentLength) ? 0 : Longs.tryParse(contentLength);
434                if (expected != size) {
435                    Log.d(Config.LOGTAG, "content-length reported on GET (" + size + ") did not match Content-Length reported on HEAD (" + expected + ")");
436                }
437                file.getParentFile().mkdirs();
438                Log.d(Config.LOGTAG,"creating file: "+file.getAbsolutePath());
439                if (!file.exists() && !file.createNewFile()) {
440                    throw new FileWriterException(file);
441                }
442                outputStream = AbstractConnectionManager.createOutputStream(file, false, false);
443            }
444            int count;
445            final byte[] buffer = new byte[4096];
446            while ((count = inputStream.read(buffer)) != -1) {
447                transmitted += count;
448                try {
449                    outputStream.write(buffer, 0, count);
450                } catch (final IOException e) {
451                    throw new FileWriterException(file);
452                }
453                if (transmitted > expected) {
454                    throw new InvalidFileException(String.format("File exceeds expected size of %d", expected));
455                }
456                updateProgress(Math.round(((double) transmitted / expected) * 100));
457            }
458            outputStream.flush();
459        }
460
461        private void updateImageBounds() {
462            final boolean privateMessage = message.isPrivateMessage();
463            message.setType(privateMessage ? Message.TYPE_PRIVATE_FILE : Message.TYPE_FILE);
464            final String url;
465            final String ref = mUrl.fragment();
466            if (ref != null && AesGcmURL.IV_KEY.matcher(ref).matches()) {
467                url = AesGcmURL.toAesGcmUrl(mUrl);
468            } else {
469                url = mUrl.toString();
470            }
471            mXmppConnectionService.getFileBackend().updateFileParams(message, url);
472            mXmppConnectionService.updateMessage(message);
473        }
474
475    }
476
477    private static void throwOnInvalidCode(final Response response) throws IOException {
478        final int code = response.code();
479        if (code < 200 || code >= 300) {
480            throw new IOException(String.format(Locale.ENGLISH, "HTTP Status code was %d", code));
481        }
482    }
483
484    private static class InvalidFileException extends IOException {
485
486        private InvalidFileException(final String message) {
487            super(message);
488        }
489
490    }
491}