blob: bee5c4a9e255a71bb8dbd472761d596eb837a72a [file] [log] [blame]
/*
* Copyright (C) 2008 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.providers.downloads;
import static com.android.providers.downloads.Constants.TAG;
import android.app.DownloadManager;
import android.content.ContentResolver;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.Context;
import android.content.Intent;
import android.database.Cursor;
import android.net.ConnectivityManager;
import android.net.NetworkInfo;
import android.net.NetworkInfo.DetailedState;
import android.net.Uri;
import android.os.Environment;
import android.provider.Downloads;
import android.provider.Downloads.Impl;
import android.text.TextUtils;
import android.util.Log;
import android.util.Pair;
import com.android.internal.annotations.GuardedBy;
import com.android.internal.util.IndentingPrintWriter;
import java.io.CharArrayWriter;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
/**
* Details about a specific download. Fields should only be mutated by updating
* from database query.
*/
public class DownloadInfo {
// TODO: move towards these in-memory objects being sources of truth, and
// periodically pushing to provider.
public static class Reader {
private ContentResolver mResolver;
private Cursor mCursor;
public Reader(ContentResolver resolver, Cursor cursor) {
mResolver = resolver;
mCursor = cursor;
}
public DownloadInfo newDownloadInfo(
Context context, SystemFacade systemFacade, DownloadNotifier notifier) {
final DownloadInfo info = new DownloadInfo(context, systemFacade, notifier);
updateFromDatabase(info);
readRequestHeaders(info);
return info;
}
public void updateFromDatabase(DownloadInfo info) {
info.mId = getLong(Downloads.Impl._ID);
info.mUri = getString(Downloads.Impl.COLUMN_URI);
info.mNoIntegrity = getInt(Downloads.Impl.COLUMN_NO_INTEGRITY) == 1;
info.mHint = getString(Downloads.Impl.COLUMN_FILE_NAME_HINT);
info.mFileName = getString(Downloads.Impl._DATA);
info.mMimeType = Intent.normalizeMimeType(getString(Downloads.Impl.COLUMN_MIME_TYPE));
info.mDestination = getInt(Downloads.Impl.COLUMN_DESTINATION);
info.mVisibility = getInt(Downloads.Impl.COLUMN_VISIBILITY);
info.mStatus = getInt(Downloads.Impl.COLUMN_STATUS);
info.mNumFailed = getInt(Downloads.Impl.COLUMN_FAILED_CONNECTIONS);
int retryRedirect = getInt(Constants.RETRY_AFTER_X_REDIRECT_COUNT);
info.mRetryAfter = retryRedirect & 0xfffffff;
info.mLastMod = getLong(Downloads.Impl.COLUMN_LAST_MODIFICATION);
info.mPackage = getString(Downloads.Impl.COLUMN_NOTIFICATION_PACKAGE);
info.mClass = getString(Downloads.Impl.COLUMN_NOTIFICATION_CLASS);
info.mExtras = getString(Downloads.Impl.COLUMN_NOTIFICATION_EXTRAS);
info.mCookies = getString(Downloads.Impl.COLUMN_COOKIE_DATA);
info.mUserAgent = getString(Downloads.Impl.COLUMN_USER_AGENT);
info.mReferer = getString(Downloads.Impl.COLUMN_REFERER);
info.mTotalBytes = getLong(Downloads.Impl.COLUMN_TOTAL_BYTES);
info.mCurrentBytes = getLong(Downloads.Impl.COLUMN_CURRENT_BYTES);
info.mETag = getString(Constants.ETAG);
info.mUid = getInt(Constants.UID);
info.mMediaScanned = getInt(Downloads.Impl.COLUMN_MEDIA_SCANNED);
info.mDeleted = getInt(Downloads.Impl.COLUMN_DELETED) == 1;
info.mMediaProviderUri = getString(Downloads.Impl.COLUMN_MEDIAPROVIDER_URI);
info.mIsPublicApi = getInt(Downloads.Impl.COLUMN_IS_PUBLIC_API) != 0;
info.mAllowedNetworkTypes = getInt(Downloads.Impl.COLUMN_ALLOWED_NETWORK_TYPES);
info.mAllowRoaming = getInt(Downloads.Impl.COLUMN_ALLOW_ROAMING) != 0;
info.mAllowMetered = getInt(Downloads.Impl.COLUMN_ALLOW_METERED) != 0;
info.mTitle = getString(Downloads.Impl.COLUMN_TITLE);
info.mDescription = getString(Downloads.Impl.COLUMN_DESCRIPTION);
info.mBypassRecommendedSizeLimit =
getInt(Downloads.Impl.COLUMN_BYPASS_RECOMMENDED_SIZE_LIMIT);
synchronized (this) {
info.mControl = getInt(Downloads.Impl.COLUMN_CONTROL);
}
}
private void readRequestHeaders(DownloadInfo info) {
info.mRequestHeaders.clear();
Uri headerUri = Uri.withAppendedPath(
info.getAllDownloadsUri(), Downloads.Impl.RequestHeaders.URI_SEGMENT);
Cursor cursor = mResolver.query(headerUri, null, null, null, null);
try {
int headerIndex =
cursor.getColumnIndexOrThrow(Downloads.Impl.RequestHeaders.COLUMN_HEADER);
int valueIndex =
cursor.getColumnIndexOrThrow(Downloads.Impl.RequestHeaders.COLUMN_VALUE);
for (cursor.moveToFirst(); !cursor.isAfterLast(); cursor.moveToNext()) {
addHeader(info, cursor.getString(headerIndex), cursor.getString(valueIndex));
}
} finally {
cursor.close();
}
if (info.mCookies != null) {
addHeader(info, "Cookie", info.mCookies);
}
if (info.mReferer != null) {
addHeader(info, "Referer", info.mReferer);
}
}
private void addHeader(DownloadInfo info, String header, String value) {
info.mRequestHeaders.add(Pair.create(header, value));
}
private String getString(String column) {
int index = mCursor.getColumnIndexOrThrow(column);
String s = mCursor.getString(index);
return (TextUtils.isEmpty(s)) ? null : s;
}
private Integer getInt(String column) {
return mCursor.getInt(mCursor.getColumnIndexOrThrow(column));
}
private Long getLong(String column) {
return mCursor.getLong(mCursor.getColumnIndexOrThrow(column));
}
}
/**
* Constants used to indicate network state for a specific download, after
* applying any requested constraints.
*/
public enum NetworkState {
/**
* The network is usable for the given download.
*/
OK,
/**
* There is no network connectivity.
*/
NO_CONNECTION,
/**
* The download exceeds the maximum size for this network.
*/
UNUSABLE_DUE_TO_SIZE,
/**
* The download exceeds the recommended maximum size for this network,
* the user must confirm for this download to proceed without WiFi.
*/
RECOMMENDED_UNUSABLE_DUE_TO_SIZE,
/**
* The current connection is roaming, and the download can't proceed
* over a roaming connection.
*/
CANNOT_USE_ROAMING,
/**
* The app requesting the download specific that it can't use the
* current network connection.
*/
TYPE_DISALLOWED_BY_REQUESTOR,
/**
* Current network is blocked for requesting application.
*/
BLOCKED;
}
/**
* For intents used to notify the user that a download exceeds a size threshold, if this extra
* is true, WiFi is required for this download size; otherwise, it is only recommended.
*/
public static final String EXTRA_IS_WIFI_REQUIRED = "isWifiRequired";
public long mId;
public String mUri;
@Deprecated
public boolean mNoIntegrity;
public String mHint;
public String mFileName;
public String mMimeType;
public int mDestination;
public int mVisibility;
public int mControl;
public int mStatus;
public int mNumFailed;
public int mRetryAfter;
public long mLastMod;
public String mPackage;
public String mClass;
public String mExtras;
public String mCookies;
public String mUserAgent;
public String mReferer;
public long mTotalBytes;
public long mCurrentBytes;
public String mETag;
public int mUid;
public int mMediaScanned;
public boolean mDeleted;
public String mMediaProviderUri;
public boolean mIsPublicApi;
public int mAllowedNetworkTypes;
public boolean mAllowRoaming;
public boolean mAllowMetered;
public String mTitle;
public String mDescription;
public int mBypassRecommendedSizeLimit;
public int mFuzz;
private List<Pair<String, String>> mRequestHeaders = new ArrayList<Pair<String, String>>();
/**
* Result of last {@link DownloadThread} started by
* {@link #startDownloadIfReady(ExecutorService)}.
*/
@GuardedBy("this")
private Future<?> mSubmittedTask;
@GuardedBy("this")
private DownloadThread mTask;
private final Context mContext;
private final SystemFacade mSystemFacade;
private final DownloadNotifier mNotifier;
private DownloadInfo(Context context, SystemFacade systemFacade, DownloadNotifier notifier) {
mContext = context;
mSystemFacade = systemFacade;
mNotifier = notifier;
mFuzz = Helpers.sRandom.nextInt(1001);
}
public Collection<Pair<String, String>> getHeaders() {
return Collections.unmodifiableList(mRequestHeaders);
}
public String getUserAgent() {
if (mUserAgent != null) {
return mUserAgent;
} else {
return Constants.DEFAULT_USER_AGENT;
}
}
public void sendIntentIfRequested() {
if (mPackage == null) {
return;
}
Intent intent;
if (mIsPublicApi) {
intent = new Intent(DownloadManager.ACTION_DOWNLOAD_COMPLETE);
intent.setPackage(mPackage);
intent.putExtra(DownloadManager.EXTRA_DOWNLOAD_ID, mId);
} else { // legacy behavior
if (mClass == null) {
return;
}
intent = new Intent(Downloads.Impl.ACTION_DOWNLOAD_COMPLETED);
intent.setClassName(mPackage, mClass);
if (mExtras != null) {
intent.putExtra(Downloads.Impl.COLUMN_NOTIFICATION_EXTRAS, mExtras);
}
// We only send the content: URI, for security reasons. Otherwise, malicious
// applications would have an easier time spoofing download results by
// sending spoofed intents.
intent.setData(getMyDownloadsUri());
}
mSystemFacade.sendBroadcast(intent);
}
/**
* Returns the time when a download should be restarted.
*/
public long restartTime(long now) {
if (mNumFailed == 0) {
return now;
}
if (mRetryAfter > 0) {
return mLastMod + mRetryAfter;
}
return mLastMod +
Constants.RETRY_FIRST_DELAY *
(1000 + mFuzz) * (1 << (mNumFailed - 1));
}
/**
* Returns whether this download should be enqueued.
*/
private boolean isReadyToDownload() {
if (mControl == Downloads.Impl.CONTROL_PAUSED) {
// the download is paused, so it's not going to start
return false;
}
switch (mStatus) {
case 0: // status hasn't been initialized yet, this is a new download
case Downloads.Impl.STATUS_PENDING: // download is explicit marked as ready to start
case Downloads.Impl.STATUS_RUNNING: // download interrupted (process killed etc) while
// running, without a chance to update the database
return true;
case Downloads.Impl.STATUS_WAITING_FOR_NETWORK:
case Downloads.Impl.STATUS_QUEUED_FOR_WIFI:
return checkCanUseNetwork(mTotalBytes) == NetworkState.OK;
case Downloads.Impl.STATUS_WAITING_TO_RETRY:
// download was waiting for a delayed restart
final long now = mSystemFacade.currentTimeMillis();
return restartTime(now) <= now;
case Downloads.Impl.STATUS_DEVICE_NOT_FOUND_ERROR:
// is the media mounted?
final Uri uri = Uri.parse(mUri);
if (ContentResolver.SCHEME_FILE.equals(uri.getScheme())) {
final File file = new File(uri.getPath());
return Environment.MEDIA_MOUNTED
.equals(Environment.getExternalStorageState(file));
} else {
Log.w(TAG, "Expected file URI on external storage: " + mUri);
return false;
}
case Downloads.Impl.STATUS_INSUFFICIENT_SPACE_ERROR:
// avoids repetition of retrying download
return false;
}
return false;
}
/**
* Returns whether this download has a visible notification after
* completion.
*/
public boolean hasCompletionNotification() {
if (!Downloads.Impl.isStatusCompleted(mStatus)) {
return false;
}
if (mVisibility == Downloads.Impl.VISIBILITY_VISIBLE_NOTIFY_COMPLETED) {
return true;
}
return false;
}
/**
* Returns whether this download is allowed to use the network.
*/
public NetworkState checkCanUseNetwork(long totalBytes) {
final NetworkInfo info = mSystemFacade.getActiveNetworkInfo(mUid);
if (info == null || !info.isConnected()) {
return NetworkState.NO_CONNECTION;
}
if (DetailedState.BLOCKED.equals(info.getDetailedState())) {
return NetworkState.BLOCKED;
}
if (mSystemFacade.isNetworkRoaming() && !isRoamingAllowed()) {
return NetworkState.CANNOT_USE_ROAMING;
}
if (mSystemFacade.isActiveNetworkMetered() && !mAllowMetered) {
return NetworkState.TYPE_DISALLOWED_BY_REQUESTOR;
}
return checkIsNetworkTypeAllowed(info.getType(), totalBytes);
}
private boolean isRoamingAllowed() {
if (mIsPublicApi) {
return mAllowRoaming;
} else { // legacy behavior
return mDestination != Downloads.Impl.DESTINATION_CACHE_PARTITION_NOROAMING;
}
}
/**
* Check if this download can proceed over the given network type.
* @param networkType a constant from ConnectivityManager.TYPE_*.
* @return one of the NETWORK_* constants
*/
private NetworkState checkIsNetworkTypeAllowed(int networkType, long totalBytes) {
if (mIsPublicApi) {
final int flag = translateNetworkTypeToApiFlag(networkType);
final boolean allowAllNetworkTypes = mAllowedNetworkTypes == ~0;
if (!allowAllNetworkTypes && (flag & mAllowedNetworkTypes) == 0) {
return NetworkState.TYPE_DISALLOWED_BY_REQUESTOR;
}
}
return checkSizeAllowedForNetwork(networkType, totalBytes);
}
/**
* Translate a ConnectivityManager.TYPE_* constant to the corresponding
* DownloadManager.Request.NETWORK_* bit flag.
*/
private int translateNetworkTypeToApiFlag(int networkType) {
switch (networkType) {
case ConnectivityManager.TYPE_MOBILE:
return DownloadManager.Request.NETWORK_MOBILE;
case ConnectivityManager.TYPE_WIFI:
return DownloadManager.Request.NETWORK_WIFI;
case ConnectivityManager.TYPE_BLUETOOTH:
return DownloadManager.Request.NETWORK_BLUETOOTH;
default:
return 0;
}
}
/**
* Check if the download's size prohibits it from running over the current network.
* @return one of the NETWORK_* constants
*/
private NetworkState checkSizeAllowedForNetwork(int networkType, long totalBytes) {
if (totalBytes <= 0) {
// we don't know the size yet
return NetworkState.OK;
}
if (ConnectivityManager.isNetworkTypeMobile(networkType)) {
Long maxBytesOverMobile = mSystemFacade.getMaxBytesOverMobile();
if (maxBytesOverMobile != null && totalBytes > maxBytesOverMobile) {
return NetworkState.UNUSABLE_DUE_TO_SIZE;
}
if (mBypassRecommendedSizeLimit == 0) {
Long recommendedMaxBytesOverMobile = mSystemFacade
.getRecommendedMaxBytesOverMobile();
if (recommendedMaxBytesOverMobile != null
&& totalBytes > recommendedMaxBytesOverMobile) {
return NetworkState.RECOMMENDED_UNUSABLE_DUE_TO_SIZE;
}
}
}
return NetworkState.OK;
}
/**
* If download is ready to start, and isn't already pending or executing,
* create a {@link DownloadThread} and enqueue it into given
* {@link Executor}.
*
* @return If actively downloading.
*/
public boolean startDownloadIfReady(ExecutorService executor) {
synchronized (this) {
final boolean isReady = isReadyToDownload();
final boolean isActive = mSubmittedTask != null && !mSubmittedTask.isDone();
if (isReady && !isActive) {
if (mStatus != Impl.STATUS_RUNNING) {
mStatus = Impl.STATUS_RUNNING;
ContentValues values = new ContentValues();
values.put(Impl.COLUMN_STATUS, mStatus);
mContext.getContentResolver().update(getAllDownloadsUri(), values, null, null);
}
mTask = new DownloadThread(mContext, mSystemFacade, mNotifier, this);
mSubmittedTask = executor.submit(mTask);
}
return isReady;
}
}
/**
* If download is ready to be scanned, enqueue it into the given
* {@link DownloadScanner}.
*
* @return If actively scanning.
*/
public boolean startScanIfReady(DownloadScanner scanner) {
synchronized (this) {
final boolean isReady = shouldScanFile();
if (isReady) {
scanner.requestScan(this);
}
return isReady;
}
}
public boolean isOnCache() {
return (mDestination == Downloads.Impl.DESTINATION_CACHE_PARTITION
|| mDestination == Downloads.Impl.DESTINATION_SYSTEMCACHE_PARTITION
|| mDestination == Downloads.Impl.DESTINATION_CACHE_PARTITION_NOROAMING
|| mDestination == Downloads.Impl.DESTINATION_CACHE_PARTITION_PURGEABLE);
}
public Uri getMyDownloadsUri() {
return ContentUris.withAppendedId(Downloads.Impl.CONTENT_URI, mId);
}
public Uri getAllDownloadsUri() {
return ContentUris.withAppendedId(Downloads.Impl.ALL_DOWNLOADS_CONTENT_URI, mId);
}
@Override
public String toString() {
final CharArrayWriter writer = new CharArrayWriter();
dump(new IndentingPrintWriter(writer, " "));
return writer.toString();
}
public void dump(IndentingPrintWriter pw) {
pw.println("DownloadInfo:");
pw.increaseIndent();
pw.printPair("mId", mId);
pw.printPair("mLastMod", mLastMod);
pw.printPair("mPackage", mPackage);
pw.printPair("mUid", mUid);
pw.println();
pw.printPair("mUri", mUri);
pw.println();
pw.printPair("mMimeType", mMimeType);
pw.printPair("mCookies", (mCookies != null) ? "yes" : "no");
pw.printPair("mReferer", (mReferer != null) ? "yes" : "no");
pw.printPair("mUserAgent", mUserAgent);
pw.println();
pw.printPair("mFileName", mFileName);
pw.printPair("mDestination", mDestination);
pw.println();
pw.printPair("mStatus", Downloads.Impl.statusToString(mStatus));
pw.printPair("mCurrentBytes", mCurrentBytes);
pw.printPair("mTotalBytes", mTotalBytes);
pw.println();
pw.printPair("mNumFailed", mNumFailed);
pw.printPair("mRetryAfter", mRetryAfter);
pw.printPair("mETag", mETag);
pw.printPair("mIsPublicApi", mIsPublicApi);
pw.println();
pw.printPair("mAllowedNetworkTypes", mAllowedNetworkTypes);
pw.printPair("mAllowRoaming", mAllowRoaming);
pw.printPair("mAllowMetered", mAllowMetered);
pw.println();
pw.decreaseIndent();
}
/**
* Return time when this download will be ready for its next action, in
* milliseconds after given time.
*
* @return If {@code 0}, download is ready to proceed immediately. If
* {@link Long#MAX_VALUE}, then download has no future actions.
*/
public long nextActionMillis(long now) {
if (Downloads.Impl.isStatusCompleted(mStatus)) {
return Long.MAX_VALUE;
}
if (mStatus != Downloads.Impl.STATUS_WAITING_TO_RETRY) {
return 0;
}
long when = restartTime(now);
if (when <= now) {
return 0;
}
return when - now;
}
/**
* Returns whether a file should be scanned
*/
public boolean shouldScanFile() {
return (mMediaScanned == 0)
&& (mDestination == Downloads.Impl.DESTINATION_EXTERNAL ||
mDestination == Downloads.Impl.DESTINATION_FILE_URI ||
mDestination == Downloads.Impl.DESTINATION_NON_DOWNLOADMANAGER_DOWNLOAD)
&& Downloads.Impl.isStatusSuccess(mStatus);
}
void notifyPauseDueToSize(boolean isWifiRequired) {
Intent intent = new Intent(Intent.ACTION_VIEW);
intent.setData(getAllDownloadsUri());
intent.setClassName(SizeLimitActivity.class.getPackage().getName(),
SizeLimitActivity.class.getName());
intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
intent.putExtra(EXTRA_IS_WIFI_REQUIRED, isWifiRequired);
mContext.startActivity(intent);
}
/**
* Query and return status of requested download.
*/
public static int queryDownloadStatus(ContentResolver resolver, long id) {
final Cursor cursor = resolver.query(
ContentUris.withAppendedId(Downloads.Impl.ALL_DOWNLOADS_CONTENT_URI, id),
new String[] { Downloads.Impl.COLUMN_STATUS }, null, null, null);
try {
if (cursor.moveToFirst()) {
return cursor.getInt(0);
} else {
// TODO: increase strictness of value returned for unknown
// downloads; this is safe default for now.
return Downloads.Impl.STATUS_PENDING;
}
} finally {
cursor.close();
}
}
}