Makoto Onuki | 0acbb14 | 2016-03-22 17:02:57 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2016 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 | package com.android.server.pm; |
| 17 | |
| 18 | import android.annotation.NonNull; |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 19 | import android.content.pm.PackageInfo; |
| 20 | import android.util.Slog; |
Makoto Onuki | 0acbb14 | 2016-03-22 17:02:57 -0700 | [diff] [blame] | 21 | |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 22 | import com.android.internal.util.Preconditions; |
| 23 | |
Makoto Onuki | 7626992 | 2016-07-15 14:58:54 -0700 | [diff] [blame] | 24 | import org.json.JSONException; |
| 25 | import org.json.JSONObject; |
Makoto Onuki | 0acbb14 | 2016-03-22 17:02:57 -0700 | [diff] [blame] | 26 | import org.xmlpull.v1.XmlPullParserException; |
| 27 | import org.xmlpull.v1.XmlSerializer; |
| 28 | |
| 29 | import java.io.IOException; |
| 30 | |
Makoto Onuki | 22fcc68 | 2016-05-17 14:52:19 -0700 | [diff] [blame] | 31 | /** |
| 32 | * All methods should be guarded by {@code #mShortcutUser.mService.mLock}. |
| 33 | */ |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 34 | abstract class ShortcutPackageItem { |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 35 | private static final String TAG = ShortcutService.TAG; |
Makoto Onuki | 7626992 | 2016-07-15 14:58:54 -0700 | [diff] [blame] | 36 | private static final String KEY_NAME = "name"; |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 37 | |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 38 | private final int mPackageUserId; |
| 39 | private final String mPackageName; |
Makoto Onuki | 0acbb14 | 2016-03-22 17:02:57 -0700 | [diff] [blame] | 40 | |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 41 | private final ShortcutPackageInfo mPackageInfo; |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 42 | |
Makoto Onuki | fc4cf2d | 2016-08-24 11:10:26 -0700 | [diff] [blame] | 43 | protected ShortcutUser mShortcutUser; |
Makoto Onuki | 4d36b3a | 2016-04-27 12:00:17 -0700 | [diff] [blame] | 44 | |
| 45 | protected ShortcutPackageItem(@NonNull ShortcutUser shortcutUser, |
| 46 | int packageUserId, @NonNull String packageName, |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 47 | @NonNull ShortcutPackageInfo packageInfo) { |
Makoto Onuki | 4d36b3a | 2016-04-27 12:00:17 -0700 | [diff] [blame] | 48 | mShortcutUser = shortcutUser; |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 49 | mPackageUserId = packageUserId; |
| 50 | mPackageName = Preconditions.checkStringNotEmpty(packageName); |
| 51 | mPackageInfo = Preconditions.checkNotNull(packageInfo); |
| 52 | } |
| 53 | |
Makoto Onuki | fc4cf2d | 2016-08-24 11:10:26 -0700 | [diff] [blame] | 54 | /** |
| 55 | * Change the parent {@link ShortcutUser}. Need it in the restore code. |
| 56 | */ |
| 57 | public void replaceUser(ShortcutUser user) { |
| 58 | mShortcutUser = user; |
| 59 | } |
| 60 | |
Makoto Onuki | 4e6cef4 | 2016-07-13 16:14:01 -0700 | [diff] [blame] | 61 | public ShortcutUser getUser() { |
| 62 | return mShortcutUser; |
| 63 | } |
| 64 | |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 65 | /** |
| 66 | * ID of the user who actually has this package running on. For {@link ShortcutPackage}, |
| 67 | * this is the same thing as {@link #getOwnerUserId}, but if it's a {@link ShortcutLauncher} and |
Makoto Onuki | c8c3329 | 2016-09-12 16:36:59 -0700 | [diff] [blame] | 68 | * {@link #getOwnerUserId} is of work profile, then this ID is of the primary user. |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 69 | */ |
| 70 | public int getPackageUserId() { |
| 71 | return mPackageUserId; |
| 72 | } |
| 73 | |
| 74 | /** |
| 75 | * ID of the user who sees the shortcuts from this instance. |
| 76 | */ |
| 77 | public abstract int getOwnerUserId(); |
| 78 | |
| 79 | @NonNull |
| 80 | public String getPackageName() { |
| 81 | return mPackageName; |
| 82 | } |
| 83 | |
| 84 | public ShortcutPackageInfo getPackageInfo() { |
| 85 | return mPackageInfo; |
| 86 | } |
| 87 | |
Makoto Onuki | c8c3329 | 2016-09-12 16:36:59 -0700 | [diff] [blame] | 88 | public void refreshPackageSignatureAndSave() { |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 89 | if (mPackageInfo.isShadow()) { |
| 90 | return; // Don't refresh for shadow user. |
| 91 | } |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 92 | final ShortcutService s = mShortcutUser.mService; |
Makoto Onuki | c8c3329 | 2016-09-12 16:36:59 -0700 | [diff] [blame] | 93 | mPackageInfo.refreshSignature(s, this); |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 94 | s.scheduleSaveUser(getOwnerUserId()); |
| 95 | } |
| 96 | |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 97 | public void attemptToRestoreIfNeededAndSave() { |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 98 | if (!mPackageInfo.isShadow()) { |
| 99 | return; // Already installed, nothing to do. |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 100 | } |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 101 | final ShortcutService s = mShortcutUser.mService; |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 102 | if (!s.isPackageInstalled(mPackageName, mPackageUserId)) { |
| 103 | if (ShortcutService.DEBUG) { |
| 104 | Slog.d(TAG, String.format("Package still not installed: %s user=%d", |
| 105 | mPackageName, mPackageUserId)); |
| 106 | } |
| 107 | return; // Not installed, no need to restore yet. |
| 108 | } |
| 109 | if (!mPackageInfo.hasSignatures()) { |
| 110 | s.wtf("Attempted to restore package " + mPackageName + ", user=" + mPackageUserId |
| 111 | + " but signatures not found in the restore data."); |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 112 | onRestoreBlocked(); |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 113 | return; |
| 114 | } |
| 115 | |
| 116 | final PackageInfo pi = s.getPackageInfoWithSignatures(mPackageName, mPackageUserId); |
| 117 | if (!mPackageInfo.canRestoreTo(s, pi)) { |
| 118 | // Package is now installed, but can't restore. Let the subclass do the cleanup. |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 119 | onRestoreBlocked(); |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 120 | return; |
| 121 | } |
| 122 | if (ShortcutService.DEBUG) { |
| 123 | Slog.d(TAG, String.format("Restored package: %s/%d on user %d", mPackageName, |
| 124 | mPackageUserId, getOwnerUserId())); |
| 125 | } |
| 126 | |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 127 | onRestored(); |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 128 | |
| 129 | // Now the package is not shadow. |
| 130 | mPackageInfo.setShadow(false); |
| 131 | |
| 132 | s.scheduleSaveUser(mPackageUserId); |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 133 | } |
| 134 | |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 135 | /** |
| 136 | * Called when the new package can't be restored because it has a lower version number |
| 137 | * or different signatures. |
| 138 | */ |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 139 | protected abstract void onRestoreBlocked(); |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 140 | |
| 141 | /** |
| 142 | * Called when the new package is successfully restored. |
| 143 | */ |
Makoto Onuki | c51b287 | 2016-05-04 15:24:50 -0700 | [diff] [blame] | 144 | protected abstract void onRestored(); |
Makoto Onuki | 2e210c4 | 2016-03-30 08:30:36 -0700 | [diff] [blame] | 145 | |
Makoto Onuki | 9da23fc | 2016-03-29 11:14:42 -0700 | [diff] [blame] | 146 | public abstract void saveToXml(@NonNull XmlSerializer out, boolean forBackup) |
Makoto Onuki | 0acbb14 | 2016-03-22 17:02:57 -0700 | [diff] [blame] | 147 | throws IOException, XmlPullParserException; |
Makoto Onuki | 7001a61 | 2016-05-27 13:24:28 -0700 | [diff] [blame] | 148 | |
Makoto Onuki | 7626992 | 2016-07-15 14:58:54 -0700 | [diff] [blame] | 149 | public JSONObject dumpCheckin(boolean clear) throws JSONException { |
| 150 | final JSONObject result = new JSONObject(); |
| 151 | result.put(KEY_NAME, mPackageName); |
| 152 | return result; |
| 153 | } |
| 154 | |
Makoto Onuki | 7001a61 | 2016-05-27 13:24:28 -0700 | [diff] [blame] | 155 | /** |
| 156 | * Verify various internal states. |
| 157 | */ |
| 158 | public void verifyStates() { |
| 159 | } |
Makoto Onuki | 0acbb14 | 2016-03-22 17:02:57 -0700 | [diff] [blame] | 160 | } |