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