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