Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2013 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.settings; |
| 18 | |
| 19 | import android.app.Activity; |
Maggie Benthall | 4453496 | 2013-08-29 10:49:13 -0400 | [diff] [blame] | 20 | import android.content.BroadcastReceiver; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 21 | import android.content.Context; |
| 22 | import android.content.Intent; |
Maggie Benthall | 4453496 | 2013-08-29 10:49:13 -0400 | [diff] [blame] | 23 | import android.content.IntentFilter; |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 24 | import android.content.RestrictionsManager; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 25 | import android.os.Bundle; |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 26 | import android.os.PersistableBundle; |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 27 | import android.os.UserHandle; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 28 | import android.os.UserManager; |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 29 | import android.view.View; |
| 30 | import android.widget.TextView; |
| 31 | |
jackqdyulei | e407e67 | 2017-05-05 16:07:48 -0700 | [diff] [blame] | 32 | import com.android.settings.dashboard.RestrictedDashboardFragment; |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 33 | import com.android.settingslib.RestrictedLockUtils; |
| 34 | |
| 35 | import static com.android.settingslib.RestrictedLockUtils.EnforcedAdmin; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 36 | |
| 37 | /** |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 38 | * Base class for settings screens that should be pin protected when in restricted mode or |
| 39 | * that will display an admin support message in case an admin has disabled the options. |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 40 | * The constructor for this class will take the restriction key that this screen should be |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 41 | * locked by. If {@link RestrictionsManager.hasRestrictionsProvider()} and |
| 42 | * {@link UserManager.hasUserRestriction()}, then the user will have to enter the restrictions |
| 43 | * pin before seeing the Settings screen. |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 44 | * |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 45 | * If this settings screen should be pin protected whenever |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 46 | * {@link RestrictionsManager.hasRestrictionsProvider()} returns true, pass in |
| 47 | * {@link RESTRICT_IF_OVERRIDABLE} to the constructor instead of a restrictions key. |
jackqdyulei | e407e67 | 2017-05-05 16:07:48 -0700 | [diff] [blame] | 48 | * |
| 49 | * @deprecated Use {@link RestrictedDashboardFragment} instead |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 50 | */ |
jackqdyulei | e407e67 | 2017-05-05 16:07:48 -0700 | [diff] [blame] | 51 | @Deprecated |
Sudheer Shanka | 8b72e56 | 2016-06-02 12:40:22 -0700 | [diff] [blame] | 52 | public abstract class RestrictedSettingsFragment extends SettingsPreferenceFragment { |
Maggie Benthall | 4453496 | 2013-08-29 10:49:13 -0400 | [diff] [blame] | 53 | |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 54 | protected static final String RESTRICT_IF_OVERRIDABLE = "restrict_if_overridable"; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 55 | |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 56 | // No RestrictedSettingsFragment screens should use this number in startActivityForResult. |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 57 | private static final int REQUEST_PIN_CHALLENGE = 12309; |
| 58 | |
| 59 | private static final String KEY_CHALLENGE_SUCCEEDED = "chsc"; |
| 60 | private static final String KEY_CHALLENGE_REQUESTED = "chrq"; |
| 61 | |
| 62 | // If the restriction PIN is entered correctly. |
| 63 | private boolean mChallengeSucceeded; |
| 64 | private boolean mChallengeRequested; |
| 65 | |
| 66 | private UserManager mUserManager; |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 67 | private RestrictionsManager mRestrictionsManager; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 68 | |
| 69 | private final String mRestrictionKey; |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 70 | private View mAdminSupportDetails; |
| 71 | private EnforcedAdmin mEnforcedAdmin; |
| 72 | private TextView mEmptyTextView; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 73 | |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 74 | private boolean mOnlyAvailableForAdmins = false; |
| 75 | private boolean mIsAdminUser; |
| 76 | |
Maggie Benthall | 4453496 | 2013-08-29 10:49:13 -0400 | [diff] [blame] | 77 | // Receiver to clear pin status when the screen is turned off. |
| 78 | private BroadcastReceiver mScreenOffReceiver = new BroadcastReceiver() { |
| 79 | @Override |
| 80 | public void onReceive(Context context, Intent intent) { |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 81 | if (!mChallengeRequested) { |
| 82 | mChallengeSucceeded = false; |
| 83 | mChallengeRequested = false; |
Maggie Benthall | 4453496 | 2013-08-29 10:49:13 -0400 | [diff] [blame] | 84 | } |
| 85 | } |
| 86 | }; |
| 87 | |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 88 | /** |
| 89 | * @param restrictionKey The restriction key to check before pin protecting |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 90 | * this settings page. Pass in {@link RESTRICT_IF_OVERRIDABLE} if it should |
| 91 | * be protected whenever a restrictions provider is set. Pass in |
| 92 | * null if it should never be protected. |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 93 | */ |
| 94 | public RestrictedSettingsFragment(String restrictionKey) { |
| 95 | mRestrictionKey = restrictionKey; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | @Override |
| 99 | public void onCreate(Bundle icicle) { |
| 100 | super.onCreate(icicle); |
| 101 | |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 102 | mRestrictionsManager = (RestrictionsManager) getSystemService(Context.RESTRICTIONS_SERVICE); |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 103 | mUserManager = (UserManager) getSystemService(Context.USER_SERVICE); |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 104 | mIsAdminUser = mUserManager.isAdminUser(); |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 105 | |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 106 | if (icicle != null) { |
| 107 | mChallengeSucceeded = icicle.getBoolean(KEY_CHALLENGE_SUCCEEDED, false); |
| 108 | mChallengeRequested = icicle.getBoolean(KEY_CHALLENGE_REQUESTED, false); |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 109 | } |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 110 | |
| 111 | IntentFilter offFilter = new IntentFilter(Intent.ACTION_SCREEN_OFF); |
| 112 | offFilter.addAction(Intent.ACTION_USER_PRESENT); |
| 113 | getActivity().registerReceiver(mScreenOffReceiver, offFilter); |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | @Override |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 117 | public void onActivityCreated(Bundle savedInstanceState) { |
| 118 | super.onActivityCreated(savedInstanceState); |
| 119 | mAdminSupportDetails = initAdminSupportDetailsView(); |
| 120 | mEmptyTextView = initEmptyTextView(); |
| 121 | } |
| 122 | |
| 123 | @Override |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 124 | public void onSaveInstanceState(Bundle outState) { |
| 125 | super.onSaveInstanceState(outState); |
| 126 | |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 127 | if (getActivity().isChangingConfigurations()) { |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 128 | outState.putBoolean(KEY_CHALLENGE_REQUESTED, mChallengeRequested); |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 129 | outState.putBoolean(KEY_CHALLENGE_SUCCEEDED, mChallengeSucceeded); |
| 130 | } |
| 131 | } |
| 132 | |
| 133 | @Override |
| 134 | public void onResume() { |
| 135 | super.onResume(); |
Julia Reynolds | d6e493f | 2014-07-29 09:50:04 -0400 | [diff] [blame] | 136 | |
| 137 | if (shouldBeProviderProtected(mRestrictionKey)) { |
| 138 | ensurePin(); |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 139 | } |
Maggie Benthall | 4453496 | 2013-08-29 10:49:13 -0400 | [diff] [blame] | 140 | } |
| 141 | |
| 142 | @Override |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 143 | public void onDestroy() { |
Maggie Benthall | 4453496 | 2013-08-29 10:49:13 -0400 | [diff] [blame] | 144 | getActivity().unregisterReceiver(mScreenOffReceiver); |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 145 | super.onDestroy(); |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | @Override |
| 149 | public void onActivityResult(int requestCode, int resultCode, Intent data) { |
| 150 | if (requestCode == REQUEST_PIN_CHALLENGE) { |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 151 | if (resultCode == Activity.RESULT_OK) { |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 152 | mChallengeSucceeded = true; |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 153 | mChallengeRequested = false; |
| 154 | } else { |
| 155 | mChallengeSucceeded = false; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 156 | } |
| 157 | return; |
| 158 | } |
| 159 | |
| 160 | super.onActivityResult(requestCode, resultCode, data); |
| 161 | } |
| 162 | |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 163 | private void ensurePin() { |
| 164 | if (!mChallengeSucceeded && !mChallengeRequested |
| 165 | && mRestrictionsManager.hasRestrictionsProvider()) { |
Amith Yamasani | 375baea | 2014-09-05 10:23:04 -0700 | [diff] [blame] | 166 | Intent intent = mRestrictionsManager.createLocalApprovalIntent(); |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 167 | if (intent != null) { |
| 168 | mChallengeRequested = true; |
| 169 | mChallengeSucceeded = false; |
| 170 | PersistableBundle request = new PersistableBundle(); |
| 171 | request.putString(RestrictionsManager.REQUEST_KEY_MESSAGE, |
| 172 | getResources().getString(R.string.restr_pin_enter_admin_pin)); |
| 173 | intent.putExtra(RestrictionsManager.EXTRA_REQUEST_BUNDLE, request); |
| 174 | startActivityForResult(intent, REQUEST_PIN_CHALLENGE); |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 175 | } |
| 176 | } |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 177 | } |
| 178 | |
| 179 | /** |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 180 | * Returns true if this activity is restricted, but no restrictions provider has been set. |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 181 | * Used to determine if the settings UI should disable UI. |
| 182 | */ |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 183 | protected boolean isRestrictedAndNotProviderProtected() { |
| 184 | if (mRestrictionKey == null || RESTRICT_IF_OVERRIDABLE.equals(mRestrictionKey)) { |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 185 | return false; |
| 186 | } |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 187 | return mUserManager.hasUserRestriction(mRestrictionKey) |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 188 | && !mRestrictionsManager.hasRestrictionsProvider(); |
| 189 | } |
| 190 | |
| 191 | protected boolean hasChallengeSucceeded() { |
| 192 | return (mChallengeRequested && mChallengeSucceeded) || !mChallengeRequested; |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 193 | } |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 194 | |
| 195 | /** |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 196 | * Returns true if this restrictions key is locked down. |
Geoffrey Borggaard | fe21d9a | 2013-08-02 18:16:27 -0400 | [diff] [blame] | 197 | */ |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 198 | protected boolean shouldBeProviderProtected(String restrictionKey) { |
| 199 | if (restrictionKey == null) { |
| 200 | return false; |
| 201 | } |
| 202 | boolean restricted = RESTRICT_IF_OVERRIDABLE.equals(restrictionKey) |
| 203 | || mUserManager.hasUserRestriction(mRestrictionKey); |
| 204 | return restricted && mRestrictionsManager.hasRestrictionsProvider(); |
| 205 | } |
Geoffrey Borggaard | 6e1102d | 2013-08-07 14:57:43 -0400 | [diff] [blame] | 206 | |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 207 | private View initAdminSupportDetailsView() { |
| 208 | return getActivity().findViewById(R.id.admin_support_details); |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 209 | } |
| 210 | |
| 211 | protected TextView initEmptyTextView() { |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 212 | TextView emptyView = (TextView) getActivity().findViewById(android.R.id.empty); |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 213 | return emptyView; |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 214 | } |
| 215 | |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 216 | public EnforcedAdmin getRestrictionEnforcedAdmin() { |
| 217 | mEnforcedAdmin = RestrictedLockUtils.checkIfRestrictionEnforced(getActivity(), |
| 218 | mRestrictionKey, UserHandle.myUserId()); |
| 219 | if (mEnforcedAdmin != null && mEnforcedAdmin.userId == UserHandle.USER_NULL) { |
| 220 | mEnforcedAdmin.userId = UserHandle.myUserId(); |
| 221 | } |
| 222 | return mEnforcedAdmin; |
| 223 | } |
| 224 | |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 225 | public TextView getEmptyTextView() { |
| 226 | return mEmptyTextView; |
| 227 | } |
| 228 | |
| 229 | @Override |
| 230 | protected void onDataSetChanged() { |
| 231 | highlightPreferenceIfNeeded(); |
Sudheer Shanka | 9e9e63b | 2016-02-11 18:48:14 +0000 | [diff] [blame] | 232 | if (mAdminSupportDetails != null && isUiRestrictedByOnlyAdmin()) { |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 233 | final EnforcedAdmin admin = getRestrictionEnforcedAdmin(); |
| 234 | ShowAdminSupportDetailsDialog.setAdminSupportDetails(getActivity(), |
| 235 | mAdminSupportDetails, admin, false); |
Sudheer Shanka | 95a71e0 | 2016-01-12 10:36:18 +0000 | [diff] [blame] | 236 | setEmptyView(mAdminSupportDetails); |
| 237 | } else if (mEmptyTextView != null) { |
| 238 | setEmptyView(mEmptyTextView); |
| 239 | } |
| 240 | super.onDataSetChanged(); |
| 241 | } |
| 242 | |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 243 | public void setIfOnlyAvailableForAdmins(boolean onlyForAdmins) { |
| 244 | mOnlyAvailableForAdmins = onlyForAdmins; |
| 245 | } |
| 246 | |
Geoffrey Borggaard | 6e1102d | 2013-08-07 14:57:43 -0400 | [diff] [blame] | 247 | /** |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 248 | * Returns whether restricted or actionable UI elements should be removed or disabled. |
Geoffrey Borggaard | 6e1102d | 2013-08-07 14:57:43 -0400 | [diff] [blame] | 249 | */ |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 250 | protected boolean isUiRestricted() { |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 251 | return isRestrictedAndNotProviderProtected() || !hasChallengeSucceeded() |
| 252 | || (!mIsAdminUser && mOnlyAvailableForAdmins); |
Julia Reynolds | 1a0297c | 2014-06-18 09:23:15 -0400 | [diff] [blame] | 253 | } |
Sudheer Shanka | 9e9e63b | 2016-02-11 18:48:14 +0000 | [diff] [blame] | 254 | |
| 255 | protected boolean isUiRestrictedByOnlyAdmin() { |
| 256 | return isUiRestricted() && !mUserManager.hasBaseUserRestriction(mRestrictionKey, |
Sudheer Shanka | 7dbbe13 | 2016-02-16 14:19:32 +0000 | [diff] [blame] | 257 | UserHandle.of(UserHandle.myUserId())) && (mIsAdminUser || !mOnlyAvailableForAdmins); |
Sudheer Shanka | 9e9e63b | 2016-02-11 18:48:14 +0000 | [diff] [blame] | 258 | } |
Geoffrey Borggaard | e38ea38 | 2013-08-02 15:03:22 -0400 | [diff] [blame] | 259 | } |