AccessPoint.java revision 96a53579088a21590cb02e5befc88ef965520d3e
1/* 2 * Copyright (C) 2015 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 17package com.android.settingslib.wifi; 18 19import android.app.AppGlobals; 20import android.content.Context; 21import android.content.pm.ApplicationInfo; 22import android.content.pm.IPackageManager; 23import android.content.pm.PackageManager; 24import android.net.ConnectivityManager; 25import android.net.NetworkBadging; 26import android.net.NetworkCapabilities; 27import android.net.NetworkInfo; 28import android.net.NetworkInfo.DetailedState; 29import android.net.NetworkInfo.State; 30import android.net.NetworkScoreManager; 31import android.net.NetworkScorerAppData; 32import android.net.ScoredNetwork; 33import android.net.wifi.IWifiManager; 34import android.net.wifi.ScanResult; 35import android.net.wifi.WifiConfiguration; 36import android.net.wifi.WifiConfiguration.KeyMgmt; 37import android.net.wifi.WifiInfo; 38import android.net.wifi.WifiManager; 39import android.net.wifi.WifiNetworkScoreCache; 40import android.net.wifi.hotspot2.PasspointConfiguration; 41import android.os.Bundle; 42import android.os.RemoteException; 43import android.os.ServiceManager; 44import android.os.SystemClock; 45import android.os.UserHandle; 46import android.support.annotation.NonNull; 47import android.text.Spannable; 48import android.text.SpannableString; 49import android.text.TextUtils; 50import android.text.style.TtsSpan; 51import android.util.Log; 52 53import com.android.internal.annotations.VisibleForTesting; 54import com.android.settingslib.R; 55 56import java.util.ArrayList; 57import java.util.Iterator; 58import java.util.concurrent.ConcurrentHashMap; 59import java.util.concurrent.atomic.AtomicInteger; 60 61 62public class AccessPoint implements Comparable<AccessPoint> { 63 static final String TAG = "SettingsLib.AccessPoint"; 64 65 /** 66 * Lower bound on the 2.4 GHz (802.11b/g/n) WLAN channels 67 */ 68 public static final int LOWER_FREQ_24GHZ = 2400; 69 70 /** 71 * Upper bound on the 2.4 GHz (802.11b/g/n) WLAN channels 72 */ 73 public static final int HIGHER_FREQ_24GHZ = 2500; 74 75 /** 76 * Lower bound on the 5.0 GHz (802.11a/h/j/n/ac) WLAN channels 77 */ 78 public static final int LOWER_FREQ_5GHZ = 4900; 79 80 /** 81 * Upper bound on the 5.0 GHz (802.11a/h/j/n/ac) WLAN channels 82 */ 83 public static final int HIGHER_FREQ_5GHZ = 5900; 84 85 86 /** 87 * Experimental: we should be able to show the user the list of BSSIDs and bands 88 * for that SSID. 89 * For now this data is used only with Verbose Logging so as to show the band and number 90 * of BSSIDs on which that network is seen. 91 */ 92 private final ConcurrentHashMap<String, ScanResult> mScanResultCache = 93 new ConcurrentHashMap<String, ScanResult>(32); 94 private static final long MAX_SCAN_RESULT_AGE_MS = 15000; 95 96 static final String KEY_NETWORKINFO = "key_networkinfo"; 97 static final String KEY_WIFIINFO = "key_wifiinfo"; 98 static final String KEY_SCANRESULT = "key_scanresult"; 99 static final String KEY_SSID = "key_ssid"; 100 static final String KEY_SECURITY = "key_security"; 101 static final String KEY_PSKTYPE = "key_psktype"; 102 static final String KEY_SCANRESULTCACHE = "key_scanresultcache"; 103 static final String KEY_CONFIG = "key_config"; 104 static final String KEY_FQDN = "key_fqdn"; 105 static final String KEY_PROVIDER_FRIENDLY_NAME = "key_provider_friendly_name"; 106 static final AtomicInteger sLastId = new AtomicInteger(0); 107 108 /** 109 * These values are matched in string arrays -- changes must be kept in sync 110 */ 111 public static final int SECURITY_NONE = 0; 112 public static final int SECURITY_WEP = 1; 113 public static final int SECURITY_PSK = 2; 114 public static final int SECURITY_EAP = 3; 115 116 private static final int PSK_UNKNOWN = 0; 117 private static final int PSK_WPA = 1; 118 private static final int PSK_WPA2 = 2; 119 private static final int PSK_WPA_WPA2 = 3; 120 121 /** 122 * The number of distinct wifi levels. 123 * 124 * <p>Must keep in sync with {@link R.array.wifi_signal} and {@link WifiManager#RSSI_LEVELS}. 125 */ 126 public static final int SIGNAL_LEVELS = 5; 127 128 public static final int UNREACHABLE_RSSI = Integer.MIN_VALUE; 129 130 private final Context mContext; 131 132 private String ssid; 133 private String bssid; 134 private int security; 135 private int networkId = WifiConfiguration.INVALID_NETWORK_ID; 136 137 private int pskType = PSK_UNKNOWN; 138 139 private WifiConfiguration mConfig; 140 141 private int mRssi = UNREACHABLE_RSSI; 142 private long mSeen = 0; 143 144 private WifiInfo mInfo; 145 private NetworkInfo mNetworkInfo; 146 AccessPointListener mAccessPointListener; 147 148 private Object mTag; 149 150 private int mRankingScore = Integer.MIN_VALUE; 151 private int mBadge = NetworkBadging.BADGING_NONE; 152 private boolean mIsScoredNetworkMetered = false; 153 154 // used to co-relate internal vs returned accesspoint. 155 int mId; 156 157 /** 158 * Information associated with the {@link PasspointConfiguration}. Only maintaining 159 * the relevant info to preserve spaces. 160 */ 161 private String mFqdn; 162 private String mProviderFriendlyName; 163 164 public AccessPoint(Context context, Bundle savedState) { 165 mContext = context; 166 mConfig = savedState.getParcelable(KEY_CONFIG); 167 if (mConfig != null) { 168 loadConfig(mConfig); 169 } 170 if (savedState.containsKey(KEY_SSID)) { 171 ssid = savedState.getString(KEY_SSID); 172 } 173 if (savedState.containsKey(KEY_SECURITY)) { 174 security = savedState.getInt(KEY_SECURITY); 175 } 176 if (savedState.containsKey(KEY_PSKTYPE)) { 177 pskType = savedState.getInt(KEY_PSKTYPE); 178 } 179 mInfo = (WifiInfo) savedState.getParcelable(KEY_WIFIINFO); 180 if (savedState.containsKey(KEY_NETWORKINFO)) { 181 mNetworkInfo = savedState.getParcelable(KEY_NETWORKINFO); 182 } 183 if (savedState.containsKey(KEY_SCANRESULTCACHE)) { 184 ArrayList<ScanResult> scanResultArrayList = 185 savedState.getParcelableArrayList(KEY_SCANRESULTCACHE); 186 mScanResultCache.clear(); 187 for (ScanResult result : scanResultArrayList) { 188 mScanResultCache.put(result.BSSID, result); 189 } 190 } 191 if (savedState.containsKey(KEY_FQDN)) { 192 mFqdn = savedState.getString(KEY_FQDN); 193 } 194 if (savedState.containsKey(KEY_PROVIDER_FRIENDLY_NAME)) { 195 mProviderFriendlyName = savedState.getString(KEY_PROVIDER_FRIENDLY_NAME); 196 } 197 update(mConfig, mInfo, mNetworkInfo); 198 updateRssi(); 199 updateSeen(); 200 mId = sLastId.incrementAndGet(); 201 } 202 203 public AccessPoint(Context context, WifiConfiguration config) { 204 mContext = context; 205 loadConfig(config); 206 mId = sLastId.incrementAndGet(); 207 } 208 209 /** 210 * Initialize an AccessPoint object for a {@link PasspointConfiguration}. This is mainly 211 * used by "Saved Networks" page for managing the saved {@link PasspointConfiguration}. 212 */ 213 public AccessPoint(Context context, PasspointConfiguration config) { 214 mContext = context; 215 mFqdn = config.getHomeSp().getFqdn(); 216 mProviderFriendlyName = config.getHomeSp().getFriendlyName(); 217 mId = sLastId.incrementAndGet(); 218 } 219 220 AccessPoint(Context context, AccessPoint other) { 221 mContext = context; 222 copyFrom(other); 223 } 224 225 AccessPoint(Context context, ScanResult result) { 226 mContext = context; 227 initWithScanResult(result); 228 mId = sLastId.incrementAndGet(); 229 } 230 231 /** 232 * Copy accesspoint information. NOTE: We do not copy tag information because that is never 233 * set on the internal copy. 234 * @param that 235 */ 236 void copyFrom(AccessPoint that) { 237 that.evictOldScanResults(); 238 this.ssid = that.ssid; 239 this.bssid = that.bssid; 240 this.security = that.security; 241 this.networkId = that.networkId; 242 this.pskType = that.pskType; 243 this.mConfig = that.mConfig; //TODO: Watch out, this object is mutated. 244 this.mRssi = that.mRssi; 245 this.mSeen = that.mSeen; 246 this.mInfo = that.mInfo; 247 this.mNetworkInfo = that.mNetworkInfo; 248 this.mScanResultCache.clear(); 249 this.mScanResultCache.putAll(that.mScanResultCache); 250 this.mId = that.mId; 251 this.mBadge = that.mBadge; 252 this.mIsScoredNetworkMetered = that.mIsScoredNetworkMetered; 253 this.mRankingScore = that.mRankingScore; 254 } 255 256 /** 257 * Returns a negative integer, zero, or a positive integer if this AccessPoint is less than, 258 * equal to, or greater than the other AccessPoint. 259 * 260 * Sort order rules for AccessPoints: 261 * 1. Active before inactive 262 * 2. Reachable before unreachable 263 * 3. Saved before unsaved 264 * 4. (Internal only) Network ranking score 265 * 5. Stronger signal before weaker signal 266 * 6. SSID alphabetically 267 * 268 * Note that AccessPoints with a signal are usually also Reachable, 269 * and will thus appear before unreachable saved AccessPoints. 270 */ 271 @Override 272 public int compareTo(@NonNull AccessPoint other) { 273 // Active one goes first. 274 if (isActive() && !other.isActive()) return -1; 275 if (!isActive() && other.isActive()) return 1; 276 277 // Reachable one goes before unreachable one. 278 if (isReachable() && !other.isReachable()) return -1; 279 if (!isReachable() && other.isReachable()) return 1; 280 281 // Configured (saved) one goes before unconfigured one. 282 if (isSaved() && !other.isSaved()) return -1; 283 if (!isSaved() && other.isSaved()) return 1; 284 285 // Higher scores go before lower scores 286 if (getRankingScore() != other.getRankingScore()) { 287 return (getRankingScore() > other.getRankingScore()) ? -1 : 1; 288 } 289 290 // Sort by signal strength, bucketed by level 291 int difference = WifiManager.calculateSignalLevel(other.mRssi, SIGNAL_LEVELS) 292 - WifiManager.calculateSignalLevel(mRssi, SIGNAL_LEVELS); 293 if (difference != 0) { 294 return difference; 295 } 296 // Sort by ssid. 297 return getSsidStr().compareToIgnoreCase(other.getSsidStr()); 298 } 299 300 @Override 301 public boolean equals(Object other) { 302 if (!(other instanceof AccessPoint)) return false; 303 return (this.compareTo((AccessPoint) other) == 0); 304 } 305 306 @Override 307 public int hashCode() { 308 int result = 0; 309 if (mInfo != null) result += 13 * mInfo.hashCode(); 310 result += 19 * mRssi; 311 result += 23 * networkId; 312 result += 29 * ssid.hashCode(); 313 return result; 314 } 315 316 @Override 317 public String toString() { 318 StringBuilder builder = new StringBuilder().append("AccessPoint(") 319 .append(ssid); 320 if (bssid != null) { 321 builder.append(":").append(bssid); 322 } 323 if (isSaved()) { 324 builder.append(',').append("saved"); 325 } 326 if (isActive()) { 327 builder.append(',').append("active"); 328 } 329 if (isEphemeral()) { 330 builder.append(',').append("ephemeral"); 331 } 332 if (isConnectable()) { 333 builder.append(',').append("connectable"); 334 } 335 if (security != SECURITY_NONE) { 336 builder.append(',').append(securityToString(security, pskType)); 337 } 338 builder.append(",level=").append(getLevel()); 339 if (mRankingScore != Integer.MIN_VALUE) { 340 builder.append(",rankingScore=").append(mRankingScore); 341 } 342 if (mBadge != NetworkBadging.BADGING_NONE) { 343 builder.append(",badge=").append(mBadge); 344 } 345 builder.append(",metered=").append(isMetered()); 346 347 return builder.append(')').toString(); 348 } 349 350 /** 351 * Updates the AccessPoint rankingScore, metering, and badge, returning true if the data has 352 * changed. 353 * 354 * @param scoreCache The score cache to use to retrieve scores. 355 * @param scoringUiEnabled Whether to show scoring and badging UI. 356 */ 357 boolean update(WifiNetworkScoreCache scoreCache, boolean scoringUiEnabled) { 358 boolean scoreChanged = false; 359 if (scoringUiEnabled) { 360 scoreChanged = updateScores(scoreCache); 361 } 362 return updateMetered(scoreCache) || scoreChanged; 363 } 364 365 /** 366 * Updates the AccessPoint rankingScore and badge, returning true if the data has changed. 367 * 368 * @param scoreCache The score cache to use to retrieve scores. 369 */ 370 private boolean updateScores(WifiNetworkScoreCache scoreCache) { 371 int oldBadge = mBadge; 372 int oldRankingScore = mRankingScore; 373 mBadge = NetworkBadging.BADGING_NONE; 374 mRankingScore = Integer.MIN_VALUE; 375 376 for (ScanResult result : mScanResultCache.values()) { 377 ScoredNetwork score = scoreCache.getScoredNetwork(result); 378 if (score == null) { 379 continue; 380 } 381 382 if (score.hasRankingScore()) { 383 mRankingScore = Math.max(mRankingScore, score.calculateRankingScore(result.level)); 384 } 385 mBadge = Math.max(mBadge, score.calculateBadge(result.level)); 386 } 387 388 return (oldBadge != mBadge || oldRankingScore != mRankingScore); 389 } 390 391 /** 392 * Updates the AccessPoint's metering based on {@link ScoredNetwork#meteredHint}, returning 393 * true if the metering changed. 394 */ 395 private boolean updateMetered(WifiNetworkScoreCache scoreCache) { 396 boolean oldMetering = mIsScoredNetworkMetered; 397 mIsScoredNetworkMetered = false; 398 for (ScanResult result : mScanResultCache.values()) { 399 ScoredNetwork score = scoreCache.getScoredNetwork(result); 400 if (score == null) { 401 continue; 402 } 403 mIsScoredNetworkMetered |= score.meteredHint; 404 } 405 return oldMetering == mIsScoredNetworkMetered; 406 } 407 408 private void evictOldScanResults() { 409 long nowMs = SystemClock.elapsedRealtime(); 410 for (Iterator<ScanResult> iter = mScanResultCache.values().iterator(); iter.hasNext(); ) { 411 ScanResult result = iter.next(); 412 // result timestamp is in microseconds 413 if (nowMs - result.timestamp / 1000 > MAX_SCAN_RESULT_AGE_MS) { 414 iter.remove(); 415 } 416 } 417 } 418 419 public boolean matches(ScanResult result) { 420 return ssid.equals(result.SSID) && security == getSecurity(result); 421 } 422 423 public boolean matches(WifiConfiguration config) { 424 if (config.isPasspoint() && mConfig != null && mConfig.isPasspoint()) { 425 return ssid.equals(removeDoubleQuotes(config.SSID)) && config.FQDN.equals(mConfig.FQDN); 426 } else { 427 return ssid.equals(removeDoubleQuotes(config.SSID)) 428 && security == getSecurity(config) 429 && (mConfig == null || mConfig.shared == config.shared); 430 } 431 } 432 433 public WifiConfiguration getConfig() { 434 return mConfig; 435 } 436 437 public String getPasspointFqdn() { 438 return mFqdn; 439 } 440 441 public void clearConfig() { 442 mConfig = null; 443 networkId = WifiConfiguration.INVALID_NETWORK_ID; 444 } 445 446 public WifiInfo getInfo() { 447 return mInfo; 448 } 449 450 /** 451 * Returns the number of levels to show for a Wifi icon, from 0 to {@link #SIGNAL_LEVELS}-1. 452 * 453 * <p>Use {@#isReachable()} to determine if an AccessPoint is in range, as this method will 454 * always return at least 0. 455 */ 456 public int getLevel() { 457 return WifiManager.calculateSignalLevel(mRssi, SIGNAL_LEVELS); 458 } 459 460 public int getRssi() { 461 return mRssi; 462 } 463 464 /** 465 * Updates {@link #mRssi}. 466 * 467 * <p>If the given connection is active, the existing value of {@link #mRssi} will be returned. 468 * If the given AccessPoint is not active, a value will be calculated from previous scan 469 * results, returning the best RSSI for all matching AccessPoints averaged with the previous 470 * value. If the access point is not connected and there are no scan results, the rssi will be 471 * set to {@link #UNREACHABLE_RSSI}. 472 * 473 * <p>Old scan results will be evicted from the cache when this method is invoked. 474 */ 475 private void updateRssi() { 476 evictOldScanResults(); 477 478 if (this.isActive()) { 479 return; 480 } 481 482 int rssi = UNREACHABLE_RSSI; 483 for (ScanResult result : mScanResultCache.values()) { 484 if (result.level > rssi) { 485 rssi = result.level; 486 } 487 } 488 489 if (rssi != UNREACHABLE_RSSI && mRssi != UNREACHABLE_RSSI) { 490 mRssi = (mRssi + rssi) / 2; // half-life previous value 491 } else { 492 mRssi = rssi; 493 } 494 } 495 496 /** 497 * Updates {@link #mSeen} based on the scan result cache. 498 * 499 * <p>Old scan results will be evicted from the cache when this method is invoked. 500 */ 501 private void updateSeen() { 502 evictOldScanResults(); 503 504 // TODO(sghuman): Set to now if connected 505 506 long seen = 0; 507 for (ScanResult result : mScanResultCache.values()) { 508 if (result.timestamp > seen) { 509 seen = result.timestamp; 510 } 511 } 512 513 mSeen = seen; 514 } 515 516 /** 517 * Returns if the network is marked metered. Metering can be marked through its config in 518 * {@link WifiConfiguration}, after connection in {@link WifiInfo}, or from a score config in 519 * {@link ScoredNetwork}. 520 */ 521 public boolean isMetered() { 522 return mIsScoredNetworkMetered 523 || (mConfig != null && mConfig.meteredHint) 524 || (mInfo != null && mInfo.getMeteredHint()); 525 } 526 527 public NetworkInfo getNetworkInfo() { 528 return mNetworkInfo; 529 } 530 531 public int getSecurity() { 532 return security; 533 } 534 535 public String getSecurityString(boolean concise) { 536 Context context = mContext; 537 if (mConfig != null && mConfig.isPasspoint()) { 538 return concise ? context.getString(R.string.wifi_security_short_eap) : 539 context.getString(R.string.wifi_security_eap); 540 } 541 switch(security) { 542 case SECURITY_EAP: 543 return concise ? context.getString(R.string.wifi_security_short_eap) : 544 context.getString(R.string.wifi_security_eap); 545 case SECURITY_PSK: 546 switch (pskType) { 547 case PSK_WPA: 548 return concise ? context.getString(R.string.wifi_security_short_wpa) : 549 context.getString(R.string.wifi_security_wpa); 550 case PSK_WPA2: 551 return concise ? context.getString(R.string.wifi_security_short_wpa2) : 552 context.getString(R.string.wifi_security_wpa2); 553 case PSK_WPA_WPA2: 554 return concise ? context.getString(R.string.wifi_security_short_wpa_wpa2) : 555 context.getString(R.string.wifi_security_wpa_wpa2); 556 case PSK_UNKNOWN: 557 default: 558 return concise ? context.getString(R.string.wifi_security_short_psk_generic) 559 : context.getString(R.string.wifi_security_psk_generic); 560 } 561 case SECURITY_WEP: 562 return concise ? context.getString(R.string.wifi_security_short_wep) : 563 context.getString(R.string.wifi_security_wep); 564 case SECURITY_NONE: 565 default: 566 return concise ? "" : context.getString(R.string.wifi_security_none); 567 } 568 } 569 570 public String getSsidStr() { 571 return ssid; 572 } 573 574 public String getBssid() { 575 return bssid; 576 } 577 578 public CharSequence getSsid() { 579 final SpannableString str = new SpannableString(ssid); 580 str.setSpan(new TtsSpan.TelephoneBuilder(ssid).build(), 0, ssid.length(), 581 Spannable.SPAN_INCLUSIVE_INCLUSIVE); 582 return str; 583 } 584 585 public String getConfigName() { 586 if (mConfig != null && mConfig.isPasspoint()) { 587 return mConfig.providerFriendlyName; 588 } else if (mFqdn != null) { 589 return mProviderFriendlyName; 590 } else { 591 return ssid; 592 } 593 } 594 595 public DetailedState getDetailedState() { 596 if (mNetworkInfo != null) { 597 return mNetworkInfo.getDetailedState(); 598 } 599 Log.w(TAG, "NetworkInfo is null, cannot return detailed state"); 600 return null; 601 } 602 603 public String getSavedNetworkSummary() { 604 WifiConfiguration config = mConfig; 605 if (config != null) { 606 PackageManager pm = mContext.getPackageManager(); 607 String systemName = pm.getNameForUid(android.os.Process.SYSTEM_UID); 608 int userId = UserHandle.getUserId(config.creatorUid); 609 ApplicationInfo appInfo = null; 610 if (config.creatorName != null && config.creatorName.equals(systemName)) { 611 appInfo = mContext.getApplicationInfo(); 612 } else { 613 try { 614 IPackageManager ipm = AppGlobals.getPackageManager(); 615 appInfo = ipm.getApplicationInfo(config.creatorName, 0 /* flags */, userId); 616 } catch (RemoteException rex) { 617 } 618 } 619 if (appInfo != null && 620 !appInfo.packageName.equals(mContext.getString(R.string.settings_package)) && 621 !appInfo.packageName.equals( 622 mContext.getString(R.string.certinstaller_package))) { 623 return mContext.getString(R.string.saved_network, appInfo.loadLabel(pm)); 624 } 625 } 626 return ""; 627 } 628 629 public String getSummary() { 630 return getSettingsSummary(mConfig); 631 } 632 633 public String getSettingsSummary() { 634 return getSettingsSummary(mConfig); 635 } 636 637 private String getSettingsSummary(WifiConfiguration config) { 638 // Update to new summary 639 StringBuilder summary = new StringBuilder(); 640 641 if (isActive() && config != null && config.isPasspoint()) { 642 // This is the active connection on passpoint 643 summary.append(getSummary(mContext, getDetailedState(), 644 false, config.providerFriendlyName)); 645 } else if (isActive()) { 646 // This is the active connection on non-passpoint network 647 summary.append(getSummary(mContext, getDetailedState(), 648 mInfo != null && mInfo.isEphemeral())); 649 } else if (config != null && config.isPasspoint() 650 && config.getNetworkSelectionStatus().isNetworkEnabled()) { 651 String format = mContext.getString(R.string.available_via_passpoint); 652 summary.append(String.format(format, config.providerFriendlyName)); 653 } else if (config != null && config.hasNoInternetAccess()) { 654 int messageID = config.getNetworkSelectionStatus().isNetworkPermanentlyDisabled() 655 ? R.string.wifi_no_internet_no_reconnect 656 : R.string.wifi_no_internet; 657 summary.append(mContext.getString(messageID)); 658 } else if (config != null && !config.getNetworkSelectionStatus().isNetworkEnabled()) { 659 WifiConfiguration.NetworkSelectionStatus networkStatus = 660 config.getNetworkSelectionStatus(); 661 switch (networkStatus.getNetworkSelectionDisableReason()) { 662 case WifiConfiguration.NetworkSelectionStatus.DISABLED_AUTHENTICATION_FAILURE: 663 summary.append(mContext.getString(R.string.wifi_disabled_password_failure)); 664 break; 665 case WifiConfiguration.NetworkSelectionStatus.DISABLED_DHCP_FAILURE: 666 case WifiConfiguration.NetworkSelectionStatus.DISABLED_DNS_FAILURE: 667 summary.append(mContext.getString(R.string.wifi_disabled_network_failure)); 668 break; 669 case WifiConfiguration.NetworkSelectionStatus.DISABLED_ASSOCIATION_REJECTION: 670 summary.append(mContext.getString(R.string.wifi_disabled_generic)); 671 break; 672 } 673 } else if (config != null && config.getNetworkSelectionStatus().isNotRecommended()) { 674 summary.append(mContext.getString(R.string.wifi_disabled_by_recommendation_provider)); 675 } else if (!isReachable()) { // Wifi out of range 676 summary.append(mContext.getString(R.string.wifi_not_in_range)); 677 } else { // In range, not disabled. 678 if (config != null) { // Is saved network 679 summary.append(mContext.getString(R.string.wifi_remembered)); 680 } 681 } 682 683 if (WifiTracker.sVerboseLogging > 0) { 684 // Add RSSI/band information for this config, what was seen up to 6 seconds ago 685 // verbose WiFi Logging is only turned on thru developers settings 686 if (mInfo != null && mNetworkInfo != null) { // This is the active connection 687 summary.append(" f=" + Integer.toString(mInfo.getFrequency())); 688 } 689 summary.append(" " + getVisibilityStatus()); 690 if (config != null && !config.getNetworkSelectionStatus().isNetworkEnabled()) { 691 summary.append(" (" + config.getNetworkSelectionStatus().getNetworkStatusString()); 692 if (config.getNetworkSelectionStatus().getDisableTime() > 0) { 693 long now = System.currentTimeMillis(); 694 long diff = (now - config.getNetworkSelectionStatus().getDisableTime()) / 1000; 695 long sec = diff%60; //seconds 696 long min = (diff/60)%60; //minutes 697 long hour = (min/60)%60; //hours 698 summary.append(", "); 699 if (hour > 0) summary.append(Long.toString(hour) + "h "); 700 summary.append( Long.toString(min) + "m "); 701 summary.append( Long.toString(sec) + "s "); 702 } 703 summary.append(")"); 704 } 705 706 if (config != null) { 707 WifiConfiguration.NetworkSelectionStatus networkStatus = 708 config.getNetworkSelectionStatus(); 709 for (int index = WifiConfiguration.NetworkSelectionStatus.NETWORK_SELECTION_ENABLE; 710 index < WifiConfiguration.NetworkSelectionStatus 711 .NETWORK_SELECTION_DISABLED_MAX; index++) { 712 if (networkStatus.getDisableReasonCounter(index) != 0) { 713 summary.append(" " + WifiConfiguration.NetworkSelectionStatus 714 .getNetworkDisableReasonString(index) + "=" 715 + networkStatus.getDisableReasonCounter(index)); 716 } 717 } 718 } 719 } 720 return summary.toString(); 721 } 722 723 /** 724 * Returns the visibility status of the WifiConfiguration. 725 * 726 * @return autojoin debugging information 727 * TODO: use a string formatter 728 * ["rssi 5Ghz", "num results on 5GHz" / "rssi 5Ghz", "num results on 5GHz"] 729 * For instance [-40,5/-30,2] 730 */ 731 private String getVisibilityStatus() { 732 StringBuilder visibility = new StringBuilder(); 733 StringBuilder scans24GHz = null; 734 StringBuilder scans5GHz = null; 735 String bssid = null; 736 737 long now = System.currentTimeMillis(); 738 739 if (mInfo != null) { 740 bssid = mInfo.getBSSID(); 741 if (bssid != null) { 742 visibility.append(" ").append(bssid); 743 } 744 visibility.append(" rssi=").append(mInfo.getRssi()); 745 visibility.append(" "); 746 visibility.append(" score=").append(mInfo.score); 747 visibility.append(" rankingScore=").append(getRankingScore()); 748 visibility.append(" badge=").append(getBadge()); 749 visibility.append(String.format(" tx=%.1f,", mInfo.txSuccessRate)); 750 visibility.append(String.format("%.1f,", mInfo.txRetriesRate)); 751 visibility.append(String.format("%.1f ", mInfo.txBadRate)); 752 visibility.append(String.format("rx=%.1f", mInfo.rxSuccessRate)); 753 } 754 755 int rssi5 = WifiConfiguration.INVALID_RSSI; 756 int rssi24 = WifiConfiguration.INVALID_RSSI; 757 int num5 = 0; 758 int num24 = 0; 759 int numBlackListed = 0; 760 int n24 = 0; // Number scan results we included in the string 761 int n5 = 0; // Number scan results we included in the string 762 evictOldScanResults(); 763 // TODO: sort list by RSSI or age 764 for (ScanResult result : mScanResultCache.values()) { 765 766 if (result.frequency >= LOWER_FREQ_5GHZ 767 && result.frequency <= HIGHER_FREQ_5GHZ) { 768 // Strictly speaking: [4915, 5825] 769 // number of known BSSID on 5GHz band 770 num5 = num5 + 1; 771 } else if (result.frequency >= LOWER_FREQ_24GHZ 772 && result.frequency <= HIGHER_FREQ_24GHZ) { 773 // Strictly speaking: [2412, 2482] 774 // number of known BSSID on 2.4Ghz band 775 num24 = num24 + 1; 776 } 777 778 779 if (result.frequency >= LOWER_FREQ_5GHZ 780 && result.frequency <= HIGHER_FREQ_5GHZ) { 781 if (result.level > rssi5) { 782 rssi5 = result.level; 783 } 784 if (n5 < 4) { 785 if (scans5GHz == null) scans5GHz = new StringBuilder(); 786 scans5GHz.append(" \n{").append(result.BSSID); 787 if (bssid != null && result.BSSID.equals(bssid)) scans5GHz.append("*"); 788 scans5GHz.append("=").append(result.frequency); 789 scans5GHz.append(",").append(result.level); 790 scans5GHz.append("}"); 791 n5++; 792 } 793 } else if (result.frequency >= LOWER_FREQ_24GHZ 794 && result.frequency <= HIGHER_FREQ_24GHZ) { 795 if (result.level > rssi24) { 796 rssi24 = result.level; 797 } 798 if (n24 < 4) { 799 if (scans24GHz == null) scans24GHz = new StringBuilder(); 800 scans24GHz.append(" \n{").append(result.BSSID); 801 if (bssid != null && result.BSSID.equals(bssid)) scans24GHz.append("*"); 802 scans24GHz.append("=").append(result.frequency); 803 scans24GHz.append(",").append(result.level); 804 scans24GHz.append("}"); 805 n24++; 806 } 807 } 808 } 809 visibility.append(" ["); 810 if (num24 > 0) { 811 visibility.append("(").append(num24).append(")"); 812 if (n24 <= 4) { 813 if (scans24GHz != null) { 814 visibility.append(scans24GHz.toString()); 815 } 816 } else { 817 visibility.append("max=").append(rssi24); 818 if (scans24GHz != null) { 819 visibility.append(",").append(scans24GHz.toString()); 820 } 821 } 822 } 823 visibility.append(";"); 824 if (num5 > 0) { 825 visibility.append("(").append(num5).append(")"); 826 if (n5 <= 4) { 827 if (scans5GHz != null) { 828 visibility.append(scans5GHz.toString()); 829 } 830 } else { 831 visibility.append("max=").append(rssi5); 832 if (scans5GHz != null) { 833 visibility.append(",").append(scans5GHz.toString()); 834 } 835 } 836 } 837 if (numBlackListed > 0) 838 visibility.append("!").append(numBlackListed); 839 visibility.append("]"); 840 841 return visibility.toString(); 842 } 843 844 /** 845 * Return whether this is the active connection. 846 * For ephemeral connections (networkId is invalid), this returns false if the network is 847 * disconnected. 848 */ 849 public boolean isActive() { 850 return mNetworkInfo != null && 851 (networkId != WifiConfiguration.INVALID_NETWORK_ID || 852 mNetworkInfo.getState() != State.DISCONNECTED); 853 } 854 855 public boolean isConnectable() { 856 return getLevel() != -1 && getDetailedState() == null; 857 } 858 859 public boolean isEphemeral() { 860 return mInfo != null && mInfo.isEphemeral() && 861 mNetworkInfo != null && mNetworkInfo.getState() != State.DISCONNECTED; 862 } 863 864 /** 865 * Return true if this AccessPoint represents a Passpoint AP. 866 */ 867 public boolean isPasspoint() { 868 return mConfig != null && mConfig.isPasspoint(); 869 } 870 871 /** 872 * Return true if this AccessPoint represents a Passpoint provider configuration. 873 */ 874 public boolean isPasspointConfig() { 875 return mFqdn != null; 876 } 877 878 /** 879 * Return whether the given {@link WifiInfo} is for this access point. 880 * If the current AP does not have a network Id then the config is used to 881 * match based on SSID and security. 882 */ 883 private boolean isInfoForThisAccessPoint(WifiConfiguration config, WifiInfo info) { 884 if (isPasspoint() == false && networkId != WifiConfiguration.INVALID_NETWORK_ID) { 885 return networkId == info.getNetworkId(); 886 } else if (config != null) { 887 return matches(config); 888 } 889 else { 890 // Might be an ephemeral connection with no WifiConfiguration. Try matching on SSID. 891 // (Note that we only do this if the WifiConfiguration explicitly equals INVALID). 892 // TODO: Handle hex string SSIDs. 893 return ssid.equals(removeDoubleQuotes(info.getSSID())); 894 } 895 } 896 897 public boolean isSaved() { 898 return networkId != WifiConfiguration.INVALID_NETWORK_ID; 899 } 900 901 public Object getTag() { 902 return mTag; 903 } 904 905 public void setTag(Object tag) { 906 mTag = tag; 907 } 908 909 /** 910 * Generate and save a default wifiConfiguration with common values. 911 * Can only be called for unsecured networks. 912 */ 913 public void generateOpenNetworkConfig() { 914 if (security != SECURITY_NONE) 915 throw new IllegalStateException(); 916 if (mConfig != null) 917 return; 918 mConfig = new WifiConfiguration(); 919 mConfig.SSID = AccessPoint.convertToQuotedString(ssid); 920 mConfig.allowedKeyManagement.set(KeyMgmt.NONE); 921 } 922 923 void loadConfig(WifiConfiguration config) { 924 ssid = (config.SSID == null ? "" : removeDoubleQuotes(config.SSID)); 925 bssid = config.BSSID; 926 security = getSecurity(config); 927 networkId = config.networkId; 928 mConfig = config; 929 } 930 931 private void initWithScanResult(ScanResult result) { 932 ssid = result.SSID; 933 bssid = result.BSSID; 934 security = getSecurity(result); 935 if (security == SECURITY_PSK) 936 pskType = getPskType(result); 937 mRssi = result.level; 938 mSeen = result.timestamp; 939 } 940 941 public void saveWifiState(Bundle savedState) { 942 if (ssid != null) savedState.putString(KEY_SSID, getSsidStr()); 943 savedState.putInt(KEY_SECURITY, security); 944 savedState.putInt(KEY_PSKTYPE, pskType); 945 if (mConfig != null) savedState.putParcelable(KEY_CONFIG, mConfig); 946 savedState.putParcelable(KEY_WIFIINFO, mInfo); 947 evictOldScanResults(); 948 savedState.putParcelableArrayList(KEY_SCANRESULTCACHE, 949 new ArrayList<ScanResult>(mScanResultCache.values())); 950 if (mNetworkInfo != null) { 951 savedState.putParcelable(KEY_NETWORKINFO, mNetworkInfo); 952 } 953 if (mFqdn != null) { 954 savedState.putString(KEY_FQDN, mFqdn); 955 } 956 if (mProviderFriendlyName != null) { 957 savedState.putString(KEY_PROVIDER_FRIENDLY_NAME, mProviderFriendlyName); 958 } 959 } 960 961 public void setListener(AccessPointListener listener) { 962 mAccessPointListener = listener; 963 } 964 965 boolean update(ScanResult result) { 966 if (matches(result)) { 967 int oldLevel = getLevel(); 968 969 /* Add or update the scan result for the BSSID */ 970 mScanResultCache.put(result.BSSID, result); 971 updateSeen(); 972 updateRssi(); 973 int newLevel = getLevel(); 974 975 if (newLevel > 0 && newLevel != oldLevel && mAccessPointListener != null) { 976 mAccessPointListener.onLevelChanged(this); 977 } 978 // This flag only comes from scans, is not easily saved in config 979 if (security == SECURITY_PSK) { 980 pskType = getPskType(result); 981 } 982 983 if (mAccessPointListener != null) { 984 mAccessPointListener.onAccessPointChanged(this); 985 } 986 987 return true; 988 } 989 return false; 990 } 991 992 /** Attempt to update the AccessPoint and return true if an update occurred. */ 993 public boolean update(WifiConfiguration config, WifiInfo info, NetworkInfo networkInfo) { 994 boolean updated = false; 995 final int oldLevel = getLevel(); 996 if (info != null && isInfoForThisAccessPoint(config, info)) { 997 updated = (mInfo == null); 998 if (mRssi != info.getRssi()) { 999 mRssi = info.getRssi(); 1000 updated = true; 1001 } else if (mNetworkInfo.getDetailedState() != networkInfo.getDetailedState()) { 1002 updated = true; 1003 } 1004 mInfo = info; 1005 mNetworkInfo = networkInfo; 1006 } else if (mInfo != null) { 1007 updated = true; 1008 mInfo = null; 1009 mNetworkInfo = null; 1010 } 1011 if (updated && mAccessPointListener != null) { 1012 mAccessPointListener.onAccessPointChanged(this); 1013 1014 if (oldLevel != getLevel() /* current level */) { 1015 mAccessPointListener.onLevelChanged(this); 1016 } 1017 } 1018 return updated; 1019 } 1020 1021 void update(WifiConfiguration config) { 1022 mConfig = config; 1023 networkId = config.networkId; 1024 if (mAccessPointListener != null) { 1025 mAccessPointListener.onAccessPointChanged(this); 1026 } 1027 } 1028 1029 @VisibleForTesting 1030 void setRssi(int rssi) { 1031 mRssi = rssi; 1032 } 1033 1034 /** Sets the rssi to {@link #UNREACHABLE_RSSI}. */ 1035 void setUnreachable() { 1036 setRssi(AccessPoint.UNREACHABLE_RSSI); 1037 } 1038 1039 int getRankingScore() { 1040 return mRankingScore; 1041 } 1042 1043 int getBadge() { 1044 return mBadge; 1045 } 1046 1047 /** Return true if the current RSSI is reachable, and false otherwise. */ 1048 public boolean isReachable() { 1049 return mRssi != UNREACHABLE_RSSI; 1050 } 1051 1052 public static String getSummary(Context context, String ssid, DetailedState state, 1053 boolean isEphemeral, String passpointProvider) { 1054 if (state == DetailedState.CONNECTED && ssid == null) { 1055 if (TextUtils.isEmpty(passpointProvider) == false) { 1056 // Special case for connected + passpoint networks. 1057 String format = context.getString(R.string.connected_via_passpoint); 1058 return String.format(format, passpointProvider); 1059 } else if (isEphemeral) { 1060 // Special case for connected + ephemeral networks. 1061 final NetworkScoreManager networkScoreManager = context.getSystemService( 1062 NetworkScoreManager.class); 1063 NetworkScorerAppData scorer = networkScoreManager.getActiveScorer(); 1064 if (scorer != null && scorer.getRecommendationServiceLabel() != null) { 1065 String format = context.getString(R.string.connected_via_network_scorer); 1066 return String.format(format, scorer.getRecommendationServiceLabel()); 1067 } else { 1068 return context.getString(R.string.connected_via_network_scorer_default); 1069 } 1070 } 1071 } 1072 1073 // Case when there is wifi connected without internet connectivity. 1074 final ConnectivityManager cm = (ConnectivityManager) 1075 context.getSystemService(Context.CONNECTIVITY_SERVICE); 1076 if (state == DetailedState.CONNECTED) { 1077 IWifiManager wifiManager = IWifiManager.Stub.asInterface( 1078 ServiceManager.getService(Context.WIFI_SERVICE)); 1079 NetworkCapabilities nc = null; 1080 1081 try { 1082 nc = cm.getNetworkCapabilities(wifiManager.getCurrentNetwork()); 1083 } catch (RemoteException e) {} 1084 1085 if (nc != null) { 1086 if (nc.hasCapability(nc.NET_CAPABILITY_CAPTIVE_PORTAL)) { 1087 return context.getString( 1088 com.android.internal.R.string.network_available_sign_in); 1089 } else if (!nc.hasCapability(NetworkCapabilities.NET_CAPABILITY_VALIDATED)) { 1090 return context.getString(R.string.wifi_connected_no_internet); 1091 } 1092 } 1093 } 1094 if (state == null) { 1095 Log.w(TAG, "state is null, returning empty summary"); 1096 return ""; 1097 } 1098 String[] formats = context.getResources().getStringArray((ssid == null) 1099 ? R.array.wifi_status : R.array.wifi_status_with_ssid); 1100 int index = state.ordinal(); 1101 1102 if (index >= formats.length || formats[index].length() == 0) { 1103 return ""; 1104 } 1105 return String.format(formats[index], ssid); 1106 } 1107 1108 public static String getSummary(Context context, DetailedState state, boolean isEphemeral) { 1109 return getSummary(context, null, state, isEphemeral, null); 1110 } 1111 1112 public static String getSummary(Context context, DetailedState state, boolean isEphemeral, 1113 String passpointProvider) { 1114 return getSummary(context, null, state, isEphemeral, passpointProvider); 1115 } 1116 1117 public static String convertToQuotedString(String string) { 1118 return "\"" + string + "\""; 1119 } 1120 1121 private static int getPskType(ScanResult result) { 1122 boolean wpa = result.capabilities.contains("WPA-PSK"); 1123 boolean wpa2 = result.capabilities.contains("WPA2-PSK"); 1124 if (wpa2 && wpa) { 1125 return PSK_WPA_WPA2; 1126 } else if (wpa2) { 1127 return PSK_WPA2; 1128 } else if (wpa) { 1129 return PSK_WPA; 1130 } else { 1131 Log.w(TAG, "Received abnormal flag string: " + result.capabilities); 1132 return PSK_UNKNOWN; 1133 } 1134 } 1135 1136 private static int getSecurity(ScanResult result) { 1137 if (result.capabilities.contains("WEP")) { 1138 return SECURITY_WEP; 1139 } else if (result.capabilities.contains("PSK")) { 1140 return SECURITY_PSK; 1141 } else if (result.capabilities.contains("EAP")) { 1142 return SECURITY_EAP; 1143 } 1144 return SECURITY_NONE; 1145 } 1146 1147 static int getSecurity(WifiConfiguration config) { 1148 if (config.allowedKeyManagement.get(KeyMgmt.WPA_PSK)) { 1149 return SECURITY_PSK; 1150 } 1151 if (config.allowedKeyManagement.get(KeyMgmt.WPA_EAP) || 1152 config.allowedKeyManagement.get(KeyMgmt.IEEE8021X)) { 1153 return SECURITY_EAP; 1154 } 1155 return (config.wepKeys[0] != null) ? SECURITY_WEP : SECURITY_NONE; 1156 } 1157 1158 public static String securityToString(int security, int pskType) { 1159 if (security == SECURITY_WEP) { 1160 return "WEP"; 1161 } else if (security == SECURITY_PSK) { 1162 if (pskType == PSK_WPA) { 1163 return "WPA"; 1164 } else if (pskType == PSK_WPA2) { 1165 return "WPA2"; 1166 } else if (pskType == PSK_WPA_WPA2) { 1167 return "WPA_WPA2"; 1168 } 1169 return "PSK"; 1170 } else if (security == SECURITY_EAP) { 1171 return "EAP"; 1172 } 1173 return "NONE"; 1174 } 1175 1176 static String removeDoubleQuotes(String string) { 1177 if (TextUtils.isEmpty(string)) { 1178 return ""; 1179 } 1180 int length = string.length(); 1181 if ((length > 1) && (string.charAt(0) == '"') 1182 && (string.charAt(length - 1) == '"')) { 1183 return string.substring(1, length - 1); 1184 } 1185 return string; 1186 } 1187 1188 public interface AccessPointListener { 1189 void onAccessPointChanged(AccessPoint accessPoint); 1190 void onLevelChanged(AccessPoint accessPoint); 1191 } 1192} 1193