resolved conflicts for merge of 3d55d829 to gingerbread-plus-aosp
[android/platform/packages/providers/DownloadProvider.git] / src / com / android / providers / downloads / DownloadThread.java
1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.android.providers.downloads;
18
19 import org.apache.http.conn.params.ConnRouteParams;
20
21 import android.content.ContentValues;
22 import android.content.Context;
23 import android.content.Intent;
24 import android.drm.mobile1.DrmRawContent;
25 import android.net.http.AndroidHttpClient;
26 import android.net.Proxy;
27 import android.net.Uri;
28 import android.os.FileUtils;
29 import android.os.PowerManager;
30 import android.os.Process;
31 import android.provider.Downloads;
32 import android.provider.DrmStore;
33 import android.util.Config;
34 import android.util.Log;
35
36 import org.apache.http.Header;
37 import org.apache.http.HttpResponse;
38 import org.apache.http.client.methods.HttpGet;
39
40 import java.io.File;
41 import java.io.FileNotFoundException;
42 import java.io.FileOutputStream;
43 import java.io.IOException;
44 import java.io.InputStream;
45 import java.io.SyncFailedException;
46 import java.net.URI;
47 import java.net.URISyntaxException;
48 import java.util.Locale;
49 import java.util.Map;
50
51 /**
52  * Runs an actual download
53  */
54 public class DownloadThread extends Thread {
55
56     private Context mContext;
57     private DownloadInfo mInfo;
58     private SystemFacade mSystemFacade;
59
60     public DownloadThread(Context context, SystemFacade systemFacade, DownloadInfo info) {
61         mContext = context;
62         mSystemFacade = systemFacade;
63         mInfo = info;
64     }
65
66     /**
67      * Returns the user agent provided by the initiating app, or use the default one
68      */
69     private String userAgent() {
70         String userAgent = mInfo.mUserAgent;
71         if (userAgent != null) {
72         }
73         if (userAgent == null) {
74             userAgent = Constants.DEFAULT_USER_AGENT;
75         }
76         return userAgent;
77     }
78
79     /**
80      * State for the entire run() method.
81      */
82     private static class State {
83         public String mFilename;
84         public FileOutputStream mStream;
85         public String mMimeType;
86         public boolean mCountRetry = false;
87         public int mRetryAfter = 0;
88         public int mRedirectCount = 0;
89         public String mNewUri;
90         public boolean mGotData = false;
91         public String mRequestUri;
92
93         public State(DownloadInfo info) {
94             mMimeType = sanitizeMimeType(info.mMimeType);
95             mRedirectCount = info.mRedirectCount;
96             mRequestUri = info.mUri;
97             mFilename = info.mFileName;
98         }
99     }
100
101     /**
102      * State within executeDownload()
103      */
104     private static class InnerState {
105         public int mBytesSoFar = 0;
106         public String mHeaderETag;
107         public boolean mContinuingDownload = false;
108         public String mHeaderContentLength;
109         public String mHeaderContentDisposition;
110         public String mHeaderContentLocation;
111         public int mBytesNotified = 0;
112         public long mTimeLastNotification = 0;
113     }
114
115     /**
116      * Raised from methods called by run() to indicate that the current request should be stopped
117      * immediately.
118      */
119     private class StopRequest extends Throwable {
120         public int mFinalStatus;
121
122         public StopRequest(int finalStatus) {
123             mFinalStatus = finalStatus;
124         }
125
126         public StopRequest(int finalStatus, Throwable throwable) {
127             super(throwable);
128             mFinalStatus = finalStatus;
129         }
130     }
131
132     /**
133      * Raised from methods called by executeDownload() to indicate that the download should be
134      * retried immediately.
135      */
136     private class RetryDownload extends Throwable {}
137
138     /**
139      * Executes the download in a separate thread
140      */
141     public void run() {
142         Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
143
144         State state = new State(mInfo);
145         AndroidHttpClient client = null;
146         PowerManager.WakeLock wakeLock = null;
147         int finalStatus = Downloads.Impl.STATUS_UNKNOWN_ERROR;
148         mInfo.mPausedReason = null;
149
150         try {
151             PowerManager pm = (PowerManager) mContext.getSystemService(Context.POWER_SERVICE);
152             wakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, Constants.TAG);
153             wakeLock.acquire();
154
155
156             if (Constants.LOGV) {
157                 Log.v(Constants.TAG, "initiating download for " + mInfo.mUri);
158             }
159
160             client = AndroidHttpClient.newInstance(userAgent(), mContext);
161
162             boolean finished = false;
163             while(!finished) {
164                 // Set or unset proxy, which may have changed since last GET request.
165                 // setDefaultProxy() supports null as proxy parameter.
166                 ConnRouteParams.setDefaultProxy(client.getParams(),
167                         Proxy.getPreferredHttpHost(mContext, state.mRequestUri));
168                 HttpGet request = new HttpGet(state.mRequestUri);
169                 try {
170                     executeDownload(state, client, request);
171                     finished = true;
172                 } catch (RetryDownload exc) {
173                     // fall through
174                 } finally {
175                     request.abort();
176                     request = null;
177                 }
178             }
179
180             if (Constants.LOGV) {
181                 Log.v(Constants.TAG, "download completed for " + mInfo.mUri);
182             }
183             finalizeDestinationFile(state);
184             finalStatus = Downloads.Impl.STATUS_SUCCESS;
185         } catch (StopRequest error) {
186             if (Constants.LOGV) {
187                 Log.v(Constants.TAG, "Aborting request for " + mInfo.mUri, error);
188             }
189             finalStatus = error.mFinalStatus;
190             // fall through to finally block
191         } catch (FileNotFoundException ex) {
192             Log.d(Constants.TAG, "FileNotFoundException for " + state.mFilename + " : " +  ex);
193             finalStatus = Downloads.Impl.STATUS_FILE_ERROR;
194             // falls through to the code that reports an error
195         } catch (RuntimeException ex) { //sometimes the socket code throws unchecked exceptions
196             if (Constants.LOGV) {
197                 Log.d(Constants.TAG, "Exception for " + mInfo.mUri, ex);
198             } else if (Config.LOGD) {
199                 Log.d(Constants.TAG, "Exception for id " + mInfo.mId, ex);
200             }
201             finalStatus = Downloads.Impl.STATUS_UNKNOWN_ERROR;
202             // falls through to the code that reports an error
203         } finally {
204             mInfo.mHasActiveThread = false;
205             if (wakeLock != null) {
206                 wakeLock.release();
207                 wakeLock = null;
208             }
209             if (client != null) {
210                 client.close();
211                 client = null;
212             }
213             cleanupDestination(state, finalStatus);
214             notifyDownloadCompleted(finalStatus, state.mCountRetry, state.mRetryAfter,
215                                     state.mRedirectCount, state.mGotData, state.mFilename,
216                                     state.mNewUri, state.mMimeType);
217         }
218     }
219
220     /**
221      * Fully execute a single download request - setup and send the request, handle the response,
222      * and transfer the data to the destination file.
223      */
224     private void executeDownload(State state, AndroidHttpClient client, HttpGet request)
225             throws StopRequest, RetryDownload, FileNotFoundException {
226         InnerState innerState = new InnerState();
227         byte data[] = new byte[Constants.BUFFER_SIZE];
228
229         setupDestinationFile(state, innerState);
230         addRequestHeaders(innerState, request);
231
232         // check just before sending the request to avoid using an invalid connection at all
233         checkConnectivity(state);
234
235         HttpResponse response = sendRequest(state, client, request);
236         handleExceptionalStatus(state, innerState, response);
237
238         if (Constants.LOGV) {
239             Log.v(Constants.TAG, "received response for " + mInfo.mUri);
240         }
241
242         processResponseHeaders(state, innerState, response);
243         InputStream entityStream = openResponseEntity(state, response);
244         transferData(state, innerState, data, entityStream);
245     }
246
247     /**
248      * Check if current connectivity is valid for this request.
249      */
250     private void checkConnectivity(State state) throws StopRequest {
251         if (!mInfo.canUseNetwork()) {
252             throw new StopRequest(Downloads.Impl.STATUS_RUNNING_PAUSED);
253         }
254     }
255
256     /**
257      * Transfer as much data as possible from the HTTP response to the destination file.
258      * @param data buffer to use to read data
259      * @param entityStream stream for reading the HTTP response entity
260      */
261     private void transferData(State state, InnerState innerState, byte[] data,
262                                  InputStream entityStream) throws StopRequest {
263         for (;;) {
264             int bytesRead = readFromResponse(state, innerState, data, entityStream);
265             if (bytesRead == -1) { // success, end of stream already reached
266                 handleEndOfStream(state, innerState);
267                 return;
268             }
269
270             state.mGotData = true;
271             writeDataToDestination(state, data, bytesRead);
272             innerState.mBytesSoFar += bytesRead;
273             reportProgress(state, innerState);
274
275             if (Constants.LOGVV) {
276                 Log.v(Constants.TAG, "downloaded " + innerState.mBytesSoFar + " for "
277                       + mInfo.mUri);
278             }
279
280             checkPausedOrCanceled(state);
281         }
282     }
283
284     /**
285      * Called after a successful completion to take any necessary action on the downloaded file.
286      */
287     private void finalizeDestinationFile(State state) throws StopRequest {
288         if (isDrmFile(state)) {
289             transferToDrm(state);
290         } else {
291             // make sure the file is readable
292             FileUtils.setPermissions(state.mFilename, 0644, -1, -1);
293             syncDestination(state);
294         }
295     }
296
297     /**
298      * Called just before the thread finishes, regardless of status, to take any necessary action on
299      * the downloaded file.
300      */
301     private void cleanupDestination(State state, int finalStatus) {
302         closeDestination(state);
303         if (state.mFilename != null && Downloads.Impl.isStatusError(finalStatus)) {
304             new File(state.mFilename).delete();
305             state.mFilename = null;
306         }
307     }
308
309     /**
310      * Sync the destination file to storage.
311      */
312     private void syncDestination(State state) {
313         FileOutputStream downloadedFileStream = null;
314         try {
315             downloadedFileStream = new FileOutputStream(state.mFilename, true);
316             downloadedFileStream.getFD().sync();
317         } catch (FileNotFoundException ex) {
318             Log.w(Constants.TAG, "file " + state.mFilename + " not found: " + ex);
319         } catch (SyncFailedException ex) {
320             Log.w(Constants.TAG, "file " + state.mFilename + " sync failed: " + ex);
321         } catch (IOException ex) {
322             Log.w(Constants.TAG, "IOException trying to sync " + state.mFilename + ": " + ex);
323         } catch (RuntimeException ex) {
324             Log.w(Constants.TAG, "exception while syncing file: ", ex);
325         } finally {
326             if(downloadedFileStream != null) {
327                 try {
328                     downloadedFileStream.close();
329                 } catch (IOException ex) {
330                     Log.w(Constants.TAG, "IOException while closing synced file: ", ex);
331                 } catch (RuntimeException ex) {
332                     Log.w(Constants.TAG, "exception while closing file: ", ex);
333                 }
334             }
335         }
336     }
337
338     /**
339      * @return true if the current download is a DRM file
340      */
341     private boolean isDrmFile(State state) {
342         return DrmRawContent.DRM_MIMETYPE_MESSAGE_STRING.equalsIgnoreCase(state.mMimeType);
343     }
344
345     /**
346      * Transfer the downloaded destination file to the DRM store.
347      */
348     private void transferToDrm(State state) throws StopRequest {
349         File file = new File(state.mFilename);
350         Intent item = DrmStore.addDrmFile(mContext.getContentResolver(), file, null);
351         file.delete();
352
353         if (item == null) {
354             Log.w(Constants.TAG, "unable to add file " + state.mFilename + " to DrmProvider");
355             throw new StopRequest(Downloads.Impl.STATUS_UNKNOWN_ERROR);
356         } else {
357             state.mFilename = item.getDataString();
358             state.mMimeType = item.getType();
359         }
360     }
361
362     /**
363      * Close the destination output stream.
364      */
365     private void closeDestination(State state) {
366         try {
367             // close the file
368             if (state.mStream != null) {
369                 state.mStream.close();
370                 state.mStream = null;
371             }
372         } catch (IOException ex) {
373             if (Constants.LOGV) {
374                 Log.v(Constants.TAG, "exception when closing the file after download : " + ex);
375             }
376             // nothing can really be done if the file can't be closed
377         }
378     }
379
380     /**
381      * Check if the download has been paused or canceled, stopping the request appropriately if it
382      * has been.
383      */
384     private void checkPausedOrCanceled(State state) throws StopRequest {
385         synchronized (mInfo) {
386             if (mInfo.mControl == Downloads.Impl.CONTROL_PAUSED) {
387                 if (Constants.LOGV) {
388                     Log.v(Constants.TAG, "paused " + mInfo.mUri);
389                 }
390                 throw new StopRequest(Downloads.Impl.STATUS_RUNNING_PAUSED);
391             }
392         }
393         if (mInfo.mStatus == Downloads.Impl.STATUS_CANCELED) {
394             if (Constants.LOGV) {
395                 Log.d(Constants.TAG, "canceled " + mInfo.mUri);
396             }
397             throw new StopRequest(Downloads.Impl.STATUS_CANCELED);
398         }
399     }
400
401     /**
402      * Report download progress through the database if necessary.
403      */
404     private void reportProgress(State state, InnerState innerState) {
405         long now = mSystemFacade.currentTimeMillis();
406         if (innerState.mBytesSoFar - innerState.mBytesNotified
407                         > Constants.MIN_PROGRESS_STEP
408                 && now - innerState.mTimeLastNotification
409                         > Constants.MIN_PROGRESS_TIME) {
410             ContentValues values = new ContentValues();
411             values.put(Downloads.Impl.COLUMN_CURRENT_BYTES, innerState.mBytesSoFar);
412             mContext.getContentResolver().update(mInfo.getAllDownloadsUri(), values, null, null);
413             innerState.mBytesNotified = innerState.mBytesSoFar;
414             innerState.mTimeLastNotification = now;
415         }
416     }
417
418     /**
419      * Write a data buffer to the destination file.
420      * @param data buffer containing the data to write
421      * @param bytesRead how many bytes to write from the buffer
422      */
423     private void writeDataToDestination(State state, byte[] data, int bytesRead)
424             throws StopRequest {
425         for (;;) {
426             try {
427                 if (state.mStream == null) {
428                     state.mStream = new FileOutputStream(state.mFilename, true);
429                 }
430                 state.mStream.write(data, 0, bytesRead);
431                 if (mInfo.mDestination == Downloads.Impl.DESTINATION_EXTERNAL
432                             && !isDrmFile(state)) {
433                     closeDestination(state);
434                 }
435                 return;
436             } catch (IOException ex) {
437                 if (mInfo.isOnCache()
438                         && Helpers.discardPurgeableFiles(mContext, Constants.BUFFER_SIZE)) {
439                     continue;
440                 }
441                 throw new StopRequest(Downloads.Impl.STATUS_FILE_ERROR, ex);
442             }
443         }
444     }
445
446     /**
447      * Called when we've reached the end of the HTTP response stream, to update the database and
448      * check for consistency.
449      */
450     private void handleEndOfStream(State state, InnerState innerState) throws StopRequest {
451         ContentValues values = new ContentValues();
452         values.put(Downloads.Impl.COLUMN_CURRENT_BYTES, innerState.mBytesSoFar);
453         if (innerState.mHeaderContentLength == null) {
454             values.put(Downloads.Impl.COLUMN_TOTAL_BYTES, innerState.mBytesSoFar);
455         }
456         mContext.getContentResolver().update(mInfo.getAllDownloadsUri(), values, null, null);
457
458         boolean lengthMismatched = (innerState.mHeaderContentLength != null)
459                 && (innerState.mBytesSoFar != Integer.parseInt(innerState.mHeaderContentLength));
460         if (lengthMismatched) {
461             if (cannotResume(innerState)) {
462                 if (Constants.LOGV) {
463                     Log.d(Constants.TAG, "mismatched content length " +
464                             mInfo.mUri);
465                 } else if (Config.LOGD) {
466                     Log.d(Constants.TAG, "mismatched content length for " +
467                             mInfo.mId);
468                 }
469                 throw new StopRequest(Downloads.Impl.STATUS_CANNOT_RESUME);
470             } else {
471                 throw new StopRequest(handleHttpError(state, "closed socket"));
472             }
473         }
474     }
475
476     private boolean cannotResume(InnerState innerState) {
477         return innerState.mBytesSoFar > 0 && !mInfo.mNoIntegrity && innerState.mHeaderETag == null;
478     }
479
480     /**
481      * Read some data from the HTTP response stream, handling I/O errors.
482      * @param data buffer to use to read data
483      * @param entityStream stream for reading the HTTP response entity
484      * @return the number of bytes actually read or -1 if the end of the stream has been reached
485      */
486     private int readFromResponse(State state, InnerState innerState, byte[] data,
487                                  InputStream entityStream) throws StopRequest {
488         try {
489             return entityStream.read(data);
490         } catch (IOException ex) {
491             logNetworkState();
492             ContentValues values = new ContentValues();
493             values.put(Downloads.Impl.COLUMN_CURRENT_BYTES, innerState.mBytesSoFar);
494             mContext.getContentResolver().update(mInfo.getAllDownloadsUri(), values, null, null);
495             if (cannotResume(innerState)) {
496                 Log.d(Constants.TAG, "download IOException for download " + mInfo.mId, ex);
497                 Log.d(Constants.TAG, "can't resume interrupted download with no ETag");
498                 throw new StopRequest(Downloads.Impl.STATUS_CANNOT_RESUME, ex);
499             } else {
500                 throw new StopRequest(handleHttpError(state, "download IOException"), ex);
501             }
502         }
503     }
504
505     /**
506      * Open a stream for the HTTP response entity, handling I/O errors.
507      * @return an InputStream to read the response entity
508      */
509     private InputStream openResponseEntity(State state, HttpResponse response)
510             throws StopRequest {
511         try {
512             return response.getEntity().getContent();
513         } catch (IOException ex) {
514             logNetworkState();
515             throw new StopRequest(handleHttpError(state, "IOException getting entity"), ex);
516         }
517     }
518
519     private void logNetworkState() {
520         if (Constants.LOGX) {
521             Log.i(Constants.TAG,
522                     "Net " + (Helpers.isNetworkAvailable(mSystemFacade) ? "Up" : "Down"));
523         }
524     }
525
526     /**
527      * Read HTTP response headers and take appropriate action, including setting up the destination
528      * file and updating the database.
529      */
530     private void processResponseHeaders(State state, InnerState innerState, HttpResponse response)
531             throws StopRequest, FileNotFoundException {
532         if (innerState.mContinuingDownload) {
533             // ignore response headers on resume requests
534             return;
535         }
536
537         readResponseHeaders(state, innerState, response);
538
539         DownloadFileInfo fileInfo = Helpers.generateSaveFile(
540                 mContext,
541                 mInfo.mUri,
542                 mInfo.mHint,
543                 innerState.mHeaderContentDisposition,
544                 innerState.mHeaderContentLocation,
545                 state.mMimeType,
546                 mInfo.mDestination,
547                 (innerState.mHeaderContentLength != null) ?
548                         Long.parseLong(innerState.mHeaderContentLength) : 0,
549                 mInfo.mIsPublicApi);
550         if (fileInfo.mFileName == null) {
551             throw new StopRequest(fileInfo.mStatus);
552         }
553         state.mFilename = fileInfo.mFileName;
554         state.mStream = fileInfo.mStream;
555         if (Constants.LOGV) {
556             Log.v(Constants.TAG, "writing " + mInfo.mUri + " to " + state.mFilename);
557         }
558
559         updateDatabaseFromHeaders(state, innerState);
560         // check connectivity again now that we know the total size
561         checkConnectivity(state);
562     }
563
564     /**
565      * Update necessary database fields based on values of HTTP response headers that have been
566      * read.
567      */
568     private void updateDatabaseFromHeaders(State state, InnerState innerState) {
569         ContentValues values = new ContentValues();
570         values.put(Downloads.Impl._DATA, state.mFilename);
571         if (innerState.mHeaderETag != null) {
572             values.put(Constants.ETAG, innerState.mHeaderETag);
573         }
574         if (state.mMimeType != null) {
575             values.put(Downloads.Impl.COLUMN_MIME_TYPE, state.mMimeType);
576         }
577         values.put(Downloads.Impl.COLUMN_TOTAL_BYTES, mInfo.mTotalBytes);
578         mContext.getContentResolver().update(mInfo.getAllDownloadsUri(), values, null, null);
579     }
580
581     /**
582      * Read headers from the HTTP response and store them into local state.
583      */
584     private void readResponseHeaders(State state, InnerState innerState, HttpResponse response)
585             throws StopRequest {
586         Header header = response.getFirstHeader("Content-Disposition");
587         if (header != null) {
588             innerState.mHeaderContentDisposition = header.getValue();
589         }
590         header = response.getFirstHeader("Content-Location");
591         if (header != null) {
592             innerState.mHeaderContentLocation = header.getValue();
593         }
594         if (state.mMimeType == null) {
595             header = response.getFirstHeader("Content-Type");
596             if (header != null) {
597                 state.mMimeType = sanitizeMimeType(header.getValue());
598             }
599         }
600         header = response.getFirstHeader("ETag");
601         if (header != null) {
602             innerState.mHeaderETag = header.getValue();
603         }
604         String headerTransferEncoding = null;
605         header = response.getFirstHeader("Transfer-Encoding");
606         if (header != null) {
607             headerTransferEncoding = header.getValue();
608         }
609         if (headerTransferEncoding == null) {
610             header = response.getFirstHeader("Content-Length");
611             if (header != null) {
612                 innerState.mHeaderContentLength = header.getValue();
613                 mInfo.mTotalBytes = Long.parseLong(innerState.mHeaderContentLength);
614             }
615         } else {
616             // Ignore content-length with transfer-encoding - 2616 4.4 3
617             if (Constants.LOGVV) {
618                 Log.v(Constants.TAG,
619                         "ignoring content-length because of xfer-encoding");
620             }
621         }
622         if (Constants.LOGVV) {
623             Log.v(Constants.TAG, "Content-Disposition: " +
624                     innerState.mHeaderContentDisposition);
625             Log.v(Constants.TAG, "Content-Length: " + innerState.mHeaderContentLength);
626             Log.v(Constants.TAG, "Content-Location: " + innerState.mHeaderContentLocation);
627             Log.v(Constants.TAG, "Content-Type: " + state.mMimeType);
628             Log.v(Constants.TAG, "ETag: " + innerState.mHeaderETag);
629             Log.v(Constants.TAG, "Transfer-Encoding: " + headerTransferEncoding);
630         }
631
632         boolean noSizeInfo = innerState.mHeaderContentLength == null
633                 && (headerTransferEncoding == null
634                     || !headerTransferEncoding.equalsIgnoreCase("chunked"));
635         if (!mInfo.mNoIntegrity && noSizeInfo) {
636             Log.d(Constants.TAG, "can't know size of download, giving up");
637             throw new StopRequest(Downloads.Impl.STATUS_HTTP_DATA_ERROR);
638         }
639     }
640
641     /**
642      * Check the HTTP response status and handle anything unusual (e.g. not 200/206).
643      */
644     private void handleExceptionalStatus(State state, InnerState innerState, HttpResponse response)
645             throws StopRequest, RetryDownload {
646         int statusCode = response.getStatusLine().getStatusCode();
647         if (statusCode == 503 && mInfo.mNumFailed < Constants.MAX_RETRIES) {
648             handleServiceUnavailable(state, response);
649         }
650         if (statusCode == 301 || statusCode == 302 || statusCode == 303 || statusCode == 307) {
651             handleRedirect(state, response, statusCode);
652         }
653
654         int expectedStatus = innerState.mContinuingDownload ? 206 : Downloads.Impl.STATUS_SUCCESS;
655         if (statusCode != expectedStatus) {
656             handleOtherStatus(state, innerState, statusCode);
657         }
658     }
659
660     /**
661      * Handle a status that we don't know how to deal with properly.
662      */
663     private void handleOtherStatus(State state, InnerState innerState, int statusCode)
664             throws StopRequest {
665         if (Constants.LOGV) {
666             Log.d(Constants.TAG, "http error " + statusCode + " for " + mInfo.mUri);
667         } else if (Config.LOGD) {
668             Log.d(Constants.TAG, "http error " + statusCode + " for download " +
669                     mInfo.mId);
670         }
671         int finalStatus;
672         if (Downloads.Impl.isStatusError(statusCode)) {
673             finalStatus = statusCode;
674         } else if (statusCode >= 300 && statusCode < 400) {
675             finalStatus = Downloads.Impl.STATUS_UNHANDLED_REDIRECT;
676         } else if (innerState.mContinuingDownload && statusCode == Downloads.Impl.STATUS_SUCCESS) {
677             finalStatus = Downloads.Impl.STATUS_CANNOT_RESUME;
678         } else {
679             finalStatus = Downloads.Impl.STATUS_UNHANDLED_HTTP_CODE;
680         }
681         throw new StopRequest(finalStatus);
682     }
683
684     /**
685      * Handle a 3xx redirect status.
686      */
687     private void handleRedirect(State state, HttpResponse response, int statusCode)
688             throws StopRequest, RetryDownload {
689         if (Constants.LOGVV) {
690             Log.v(Constants.TAG, "got HTTP redirect " + statusCode);
691         }
692         if (state.mRedirectCount >= Constants.MAX_REDIRECTS) {
693             if (Constants.LOGV) {
694                 Log.d(Constants.TAG, "too many redirects for download " + mInfo.mId +
695                         " at " + mInfo.mUri);
696             } else if (Config.LOGD) {
697                 Log.d(Constants.TAG, "too many redirects for download " + mInfo.mId);
698             }
699             throw new StopRequest(Downloads.Impl.STATUS_TOO_MANY_REDIRECTS);
700         }
701         Header header = response.getFirstHeader("Location");
702         if (header == null) {
703             return;
704         }
705         if (Constants.LOGVV) {
706             Log.v(Constants.TAG, "Location :" + header.getValue());
707         }
708
709         String newUri;
710         try {
711             newUri = new URI(mInfo.mUri).resolve(new URI(header.getValue())).toString();
712         } catch(URISyntaxException ex) {
713             if (Constants.LOGV) {
714                 Log.d(Constants.TAG, "Couldn't resolve redirect URI " + header.getValue()
715                         + " for " + mInfo.mUri);
716             } else if (Config.LOGD) {
717                 Log.d(Constants.TAG,
718                         "Couldn't resolve redirect URI for download " +
719                         mInfo.mId);
720             }
721             throw new StopRequest(Downloads.Impl.STATUS_HTTP_DATA_ERROR);
722         }
723         ++state.mRedirectCount;
724         state.mRequestUri = newUri;
725         if (statusCode == 301 || statusCode == 303) {
726             // use the new URI for all future requests (should a retry/resume be necessary)
727             state.mNewUri = newUri;
728         }
729         throw new RetryDownload();
730     }
731
732     /**
733      * Handle a 503 Service Unavailable status by processing the Retry-After header.
734      */
735     private void handleServiceUnavailable(State state, HttpResponse response) throws StopRequest {
736         if (Constants.LOGVV) {
737             Log.v(Constants.TAG, "got HTTP response code 503");
738         }
739         state.mCountRetry = true;
740         Header header = response.getFirstHeader("Retry-After");
741         if (header != null) {
742            try {
743                if (Constants.LOGVV) {
744                    Log.v(Constants.TAG, "Retry-After :" + header.getValue());
745                }
746                state.mRetryAfter = Integer.parseInt(header.getValue());
747                if (state.mRetryAfter < 0) {
748                    state.mRetryAfter = 0;
749                } else {
750                    if (state.mRetryAfter < Constants.MIN_RETRY_AFTER) {
751                        state.mRetryAfter = Constants.MIN_RETRY_AFTER;
752                    } else if (state.mRetryAfter > Constants.MAX_RETRY_AFTER) {
753                        state.mRetryAfter = Constants.MAX_RETRY_AFTER;
754                    }
755                    state.mRetryAfter += Helpers.sRandom.nextInt(Constants.MIN_RETRY_AFTER + 1);
756                    state.mRetryAfter *= 1000;
757                }
758            } catch (NumberFormatException ex) {
759                // ignored - retryAfter stays 0 in this case.
760            }
761         }
762         throw new StopRequest(Downloads.Impl.STATUS_RUNNING_PAUSED);
763     }
764
765     /**
766      * Send the request to the server, handling any I/O exceptions.
767      */
768     private HttpResponse sendRequest(State state, AndroidHttpClient client, HttpGet request)
769             throws StopRequest {
770         try {
771             return client.execute(request);
772         } catch (IllegalArgumentException ex) {
773             if (Constants.LOGV) {
774                 Log.d(Constants.TAG, "Arg exception trying to execute request for " +
775                         mInfo.mUri + " : " + ex);
776             } else if (Config.LOGD) {
777                 Log.d(Constants.TAG, "Arg exception trying to execute request for " +
778                         mInfo.mId + " : " +  ex);
779             }
780             throw new StopRequest(Downloads.Impl.STATUS_HTTP_DATA_ERROR, ex);
781         } catch (IOException ex) {
782             logNetworkState();
783             throw new StopRequest(handleHttpError(state, "IOException trying to execute request"),
784                     ex);
785         }
786     }
787
788     /**
789      * @return the final status for this attempt
790      */
791     private int handleHttpError(State state, String message) {
792         if (Constants.LOGV) {
793             Log.d(Constants.TAG, message + " for " + mInfo.mUri);
794         }
795
796         if (!Helpers.isNetworkAvailable(mSystemFacade)) {
797             return Downloads.Impl.STATUS_RUNNING_PAUSED;
798         } else if (mInfo.mNumFailed < Constants.MAX_RETRIES) {
799             state.mCountRetry = true;
800             return Downloads.Impl.STATUS_RUNNING_PAUSED;
801         } else {
802             Log.d(Constants.TAG, "reached max retries: " + message + " for " + mInfo.mId);
803             return Downloads.Impl.STATUS_HTTP_DATA_ERROR;
804         }
805     }
806
807     /**
808      * Prepare the destination file to receive data.  If the file already exists, we'll set up
809      * appropriately for resumption.
810      */
811     private void setupDestinationFile(State state, InnerState innerState)
812             throws StopRequest, FileNotFoundException {
813         if (state.mFilename != null) { // only true if we've already run a thread for this download
814             if (!Helpers.isFilenameValid(state.mFilename)) {
815                 throw new StopRequest(Downloads.Impl.STATUS_FILE_ERROR);
816             }
817             // We're resuming a download that got interrupted
818             File f = new File(state.mFilename);
819             if (f.exists()) {
820                 long fileLength = f.length();
821                 if (fileLength == 0) {
822                     // The download hadn't actually started, we can restart from scratch
823                     f.delete();
824                     state.mFilename = null;
825                 } else if (mInfo.mETag == null && !mInfo.mNoIntegrity) {
826                     // This should've been caught upon failure
827                     Log.wtf(Constants.TAG, "Trying to resume a download that can't be resumed");
828                     f.delete();
829                     throw new StopRequest(Downloads.Impl.STATUS_CANNOT_RESUME);
830                 } else {
831                     // All right, we'll be able to resume this download
832                     state.mStream = new FileOutputStream(state.mFilename, true);
833                     innerState.mBytesSoFar = (int) fileLength;
834                     if (mInfo.mTotalBytes != -1) {
835                         innerState.mHeaderContentLength = Long.toString(mInfo.mTotalBytes);
836                     }
837                     innerState.mHeaderETag = mInfo.mETag;
838                     innerState.mContinuingDownload = true;
839                 }
840             }
841         }
842
843         if (state.mStream != null && mInfo.mDestination == Downloads.Impl.DESTINATION_EXTERNAL
844                 && !isDrmFile(state)) {
845             closeDestination(state);
846         }
847     }
848
849     /**
850      * Add custom headers for this download to the HTTP request.
851      */
852     private void addRequestHeaders(InnerState innerState, HttpGet request) {
853         for (Map.Entry<String, String> header : mInfo.getHeaders().entrySet()) {
854             request.addHeader(header.getKey(), header.getValue());
855         }
856
857         if (innerState.mContinuingDownload) {
858             if (innerState.mHeaderETag != null) {
859                 request.addHeader("If-Match", innerState.mHeaderETag);
860             }
861             request.addHeader("Range", "bytes=" + innerState.mBytesSoFar + "-");
862         }
863     }
864
865     /**
866      * Stores information about the completed download, and notifies the initiating application.
867      */
868     private void notifyDownloadCompleted(
869             int status, boolean countRetry, int retryAfter, int redirectCount, boolean gotData,
870             String filename, String uri, String mimeType) {
871         notifyThroughDatabase(
872                 status, countRetry, retryAfter, redirectCount, gotData, filename, uri, mimeType);
873         if (Downloads.Impl.isStatusCompleted(status)) {
874             mInfo.sendIntentIfRequested();
875         }
876     }
877
878     private void notifyThroughDatabase(
879             int status, boolean countRetry, int retryAfter, int redirectCount, boolean gotData,
880             String filename, String uri, String mimeType) {
881         ContentValues values = new ContentValues();
882         values.put(Downloads.Impl.COLUMN_STATUS, status);
883         values.put(Downloads.Impl._DATA, filename);
884         if (uri != null) {
885             values.put(Downloads.Impl.COLUMN_URI, uri);
886         }
887         values.put(Downloads.Impl.COLUMN_MIME_TYPE, mimeType);
888         values.put(Downloads.Impl.COLUMN_LAST_MODIFICATION, mSystemFacade.currentTimeMillis());
889         values.put(Constants.RETRY_AFTER_X_REDIRECT_COUNT, retryAfter + (redirectCount << 28));
890         if (!countRetry) {
891             values.put(Constants.FAILED_CONNECTIONS, 0);
892         } else if (gotData) {
893             values.put(Constants.FAILED_CONNECTIONS, 1);
894         } else {
895             values.put(Constants.FAILED_CONNECTIONS, mInfo.mNumFailed + 1);
896         }
897
898         mContext.getContentResolver().update(mInfo.getAllDownloadsUri(), values, null, null);
899     }
900
901     /**
902      * Clean up a mimeType string so it can be used to dispatch an intent to
903      * view a downloaded asset.
904      * @param mimeType either null or one or more mime types (semi colon separated).
905      * @return null if mimeType was null. Otherwise a string which represents a
906      * single mimetype in lowercase and with surrounding whitespaces trimmed.
907      */
908     private static String sanitizeMimeType(String mimeType) {
909         try {
910             mimeType = mimeType.trim().toLowerCase(Locale.ENGLISH);
911
912             final int semicolonIndex = mimeType.indexOf(';');
913             if (semicolonIndex != -1) {
914                 mimeType = mimeType.substring(0, semicolonIndex);
915             }
916             return mimeType;
917         } catch (NullPointerException npe) {
918             return null;
919         }
920     }
921 }