AccessPoint.java revision 8c792880937fbdeba884bfffe86412b5ed537930
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 builder.append(",rankingScore=").append(mRankingScore); 340 builder.append(",badge=").append(mBadge); 341 builder.append(",metered=").append(isMetered()); 342 343 return builder.append(')').toString(); 344 } 345 346 /** 347 * Updates the AccessPoint rankingScore, metering, and badge, returning true if the data has 348 * changed. 349 * 350 * @param scoreCache The score cache to use to retrieve scores. 351 * @param scoringUiEnabled Whether to show scoring and badging UI. 352 */ 353 boolean update(WifiNetworkScoreCache scoreCache, boolean scoringUiEnabled) { 354 boolean scoreChanged = false; 355 if (scoringUiEnabled) { 356 scoreChanged = updateScores(scoreCache); 357 } 358 return updateMetered(scoreCache) || scoreChanged; 359 } 360 361 /** 362 * Updates the AccessPoint rankingScore and badge, returning true if the data has changed. 363 * 364 * @param scoreCache The score cache to use to retrieve scores. 365 */ 366 private boolean updateScores(WifiNetworkScoreCache scoreCache) { 367 int oldBadge = mBadge; 368 int oldRankingScore = mRankingScore; 369 mBadge = NetworkBadging.BADGING_NONE; 370 mRankingScore = Integer.MIN_VALUE; 371 372 for (ScanResult result : mScanResultCache.values()) { 373 ScoredNetwork score = scoreCache.getScoredNetwork(result); 374 if (score == null) { 375 continue; 376 } 377 378 if (score.hasRankingScore()) { 379 mRankingScore = Math.max(mRankingScore, score.calculateRankingScore(result.level)); 380 } 381 mBadge = Math.max(mBadge, score.calculateBadge(result.level)); 382 } 383 384 return (oldBadge != mBadge || oldRankingScore != mRankingScore); 385 } 386 387 /** 388 * Updates the AccessPoint's metering based on {@link ScoredNetwork#meteredHint}, returning 389 * true if the metering changed. 390 */ 391 private boolean updateMetered(WifiNetworkScoreCache scoreCache) { 392 boolean oldMetering = mIsScoredNetworkMetered; 393 mIsScoredNetworkMetered = false; 394 for (ScanResult result : mScanResultCache.values()) { 395 ScoredNetwork score = scoreCache.getScoredNetwork(result); 396 if (score == null) { 397 continue; 398 } 399 mIsScoredNetworkMetered |= score.meteredHint; 400 } 401 return oldMetering == mIsScoredNetworkMetered; 402 } 403 404 private void evictOldScanResults() { 405 long nowMs = SystemClock.elapsedRealtime(); 406 for (Iterator<ScanResult> iter = mScanResultCache.values().iterator(); iter.hasNext(); ) { 407 ScanResult result = iter.next(); 408 // result timestamp is in microseconds 409 if (nowMs - result.timestamp / 1000 > MAX_SCAN_RESULT_AGE_MS) { 410 iter.remove(); 411 } 412 } 413 } 414 415 public boolean matches(ScanResult result) { 416 return ssid.equals(result.SSID) && security == getSecurity(result); 417 } 418 419 public boolean matches(WifiConfiguration config) { 420 if (config.isPasspoint() && mConfig != null && mConfig.isPasspoint()) { 421 return ssid.equals(removeDoubleQuotes(config.SSID)) && config.FQDN.equals(mConfig.FQDN); 422 } else { 423 return ssid.equals(removeDoubleQuotes(config.SSID)) 424 && security == getSecurity(config) 425 && (mConfig == null || mConfig.shared == config.shared); 426 } 427 } 428 429 public WifiConfiguration getConfig() { 430 return mConfig; 431 } 432 433 public String getPasspointFqdn() { 434 return mFqdn; 435 } 436 437 public void clearConfig() { 438 mConfig = null; 439 networkId = WifiConfiguration.INVALID_NETWORK_ID; 440 } 441 442 public WifiInfo getInfo() { 443 return mInfo; 444 } 445 446 /** 447 * Returns the number of levels to show for a Wifi icon, from 0 to {@link #SIGNAL_LEVELS}-1. 448 * 449 * <p>Use {@#isReachable()} to determine if an AccessPoint is in range, as this method will 450 * always return at least 0. 451 */ 452 public int getLevel() { 453 return WifiManager.calculateSignalLevel(mRssi, SIGNAL_LEVELS); 454 } 455 456 public int getRssi() { 457 return mRssi; 458 } 459 460 /** 461 * Updates {@link #mRssi}. 462 * 463 * <p>If the given connection is active, the existing value of {@link #mRssi} will be returned. 464 * If the given AccessPoint is not active, a value will be calculated from previous scan 465 * results, returning the best RSSI for all matching AccessPoints averaged with the previous 466 * value. If the access point is not connected and there are no scan results, the rssi will be 467 * set to {@link #UNREACHABLE_RSSI}. 468 * 469 * <p>Old scan results will be evicted from the cache when this method is invoked. 470 */ 471 private void updateRssi() { 472 evictOldScanResults(); 473 474 if (this.isActive()) { 475 return; 476 } 477 478 int rssi = UNREACHABLE_RSSI; 479 for (ScanResult result : mScanResultCache.values()) { 480 if (result.level > rssi) { 481 rssi = result.level; 482 } 483 } 484 485 if (rssi != UNREACHABLE_RSSI && mRssi != UNREACHABLE_RSSI) { 486 mRssi = (mRssi + rssi) / 2; // half-life previous value 487 } else { 488 mRssi = rssi; 489 } 490 } 491 492 /** 493 * Updates {@link #mSeen} based on the scan result cache. 494 * 495 * <p>Old scan results will be evicted from the cache when this method is invoked. 496 */ 497 private void updateSeen() { 498 evictOldScanResults(); 499 500 // TODO(sghuman): Set to now if connected 501 502 long seen = 0; 503 for (ScanResult result : mScanResultCache.values()) { 504 if (result.timestamp > seen) { 505 seen = result.timestamp; 506 } 507 } 508 509 mSeen = seen; 510 } 511 512 /** 513 * Returns if the network is marked metered. Metering can be marked through its config in 514 * {@link WifiConfiguration}, after connection in {@link WifiInfo}, or from a score config in 515 * {@link ScoredNetwork}. 516 */ 517 public boolean isMetered() { 518 return mIsScoredNetworkMetered 519 || (mConfig != null && mConfig.meteredHint) 520 || (mInfo != null && mInfo.getMeteredHint()); 521 } 522 523 public NetworkInfo getNetworkInfo() { 524 return mNetworkInfo; 525 } 526 527 public int getSecurity() { 528 return security; 529 } 530 531 public String getSecurityString(boolean concise) { 532 Context context = mContext; 533 if (mConfig != null && mConfig.isPasspoint()) { 534 return concise ? context.getString(R.string.wifi_security_short_eap) : 535 context.getString(R.string.wifi_security_eap); 536 } 537 switch(security) { 538 case SECURITY_EAP: 539 return concise ? context.getString(R.string.wifi_security_short_eap) : 540 context.getString(R.string.wifi_security_eap); 541 case SECURITY_PSK: 542 switch (pskType) { 543 case PSK_WPA: 544 return concise ? context.getString(R.string.wifi_security_short_wpa) : 545 context.getString(R.string.wifi_security_wpa); 546 case PSK_WPA2: 547 return concise ? context.getString(R.string.wifi_security_short_wpa2) : 548 context.getString(R.string.wifi_security_wpa2); 549 case PSK_WPA_WPA2: 550 return concise ? context.getString(R.string.wifi_security_short_wpa_wpa2) : 551 context.getString(R.string.wifi_security_wpa_wpa2); 552 case PSK_UNKNOWN: 553 default: 554 return concise ? context.getString(R.string.wifi_security_short_psk_generic) 555 : context.getString(R.string.wifi_security_psk_generic); 556 } 557 case SECURITY_WEP: 558 return concise ? context.getString(R.string.wifi_security_short_wep) : 559 context.getString(R.string.wifi_security_wep); 560 case SECURITY_NONE: 561 default: 562 return concise ? "" : context.getString(R.string.wifi_security_none); 563 } 564 } 565 566 public String getSsidStr() { 567 return ssid; 568 } 569 570 public String getBssid() { 571 return bssid; 572 } 573 574 public CharSequence getSsid() { 575 final SpannableString str = new SpannableString(ssid); 576 str.setSpan(new TtsSpan.TelephoneBuilder(ssid).build(), 0, ssid.length(), 577 Spannable.SPAN_INCLUSIVE_INCLUSIVE); 578 return str; 579 } 580 581 public String getConfigName() { 582 if (mConfig != null && mConfig.isPasspoint()) { 583 return mConfig.providerFriendlyName; 584 } else if (mFqdn != null) { 585 return mProviderFriendlyName; 586 } else { 587 return ssid; 588 } 589 } 590 591 public DetailedState getDetailedState() { 592 if (mNetworkInfo != null) { 593 return mNetworkInfo.getDetailedState(); 594 } 595 Log.w(TAG, "NetworkInfo is null, cannot return detailed state"); 596 return null; 597 } 598 599 public String getSavedNetworkSummary() { 600 WifiConfiguration config = mConfig; 601 if (config != null) { 602 PackageManager pm = mContext.getPackageManager(); 603 String systemName = pm.getNameForUid(android.os.Process.SYSTEM_UID); 604 int userId = UserHandle.getUserId(config.creatorUid); 605 ApplicationInfo appInfo = null; 606 if (config.creatorName != null && config.creatorName.equals(systemName)) { 607 appInfo = mContext.getApplicationInfo(); 608 } else { 609 try { 610 IPackageManager ipm = AppGlobals.getPackageManager(); 611 appInfo = ipm.getApplicationInfo(config.creatorName, 0 /* flags */, userId); 612 } catch (RemoteException rex) { 613 } 614 } 615 if (appInfo != null && 616 !appInfo.packageName.equals(mContext.getString(R.string.settings_package)) && 617 !appInfo.packageName.equals( 618 mContext.getString(R.string.certinstaller_package))) { 619 return mContext.getString(R.string.saved_network, appInfo.loadLabel(pm)); 620 } 621 } 622 return ""; 623 } 624 625 public String getSummary() { 626 return getSettingsSummary(mConfig); 627 } 628 629 public String getSettingsSummary() { 630 return getSettingsSummary(mConfig); 631 } 632 633 private String getSettingsSummary(WifiConfiguration config) { 634 // Update to new summary 635 StringBuilder summary = new StringBuilder(); 636 637 if (isActive() && config != null && config.isPasspoint()) { 638 // This is the active connection on passpoint 639 summary.append(getSummary(mContext, getDetailedState(), 640 false, config.providerFriendlyName)); 641 } else if (isActive()) { 642 // This is the active connection on non-passpoint network 643 summary.append(getSummary(mContext, getDetailedState(), 644 mInfo != null && mInfo.isEphemeral())); 645 } else if (config != null && config.isPasspoint() 646 && config.getNetworkSelectionStatus().isNetworkEnabled()) { 647 String format = mContext.getString(R.string.available_via_passpoint); 648 summary.append(String.format(format, config.providerFriendlyName)); 649 } else if (config != null && config.hasNoInternetAccess()) { 650 int messageID = config.getNetworkSelectionStatus().isNetworkPermanentlyDisabled() 651 ? R.string.wifi_no_internet_no_reconnect 652 : R.string.wifi_no_internet; 653 summary.append(mContext.getString(messageID)); 654 } else if (config != null && !config.getNetworkSelectionStatus().isNetworkEnabled()) { 655 WifiConfiguration.NetworkSelectionStatus networkStatus = 656 config.getNetworkSelectionStatus(); 657 switch (networkStatus.getNetworkSelectionDisableReason()) { 658 case WifiConfiguration.NetworkSelectionStatus.DISABLED_AUTHENTICATION_FAILURE: 659 summary.append(mContext.getString(R.string.wifi_disabled_password_failure)); 660 break; 661 case WifiConfiguration.NetworkSelectionStatus.DISABLED_DHCP_FAILURE: 662 case WifiConfiguration.NetworkSelectionStatus.DISABLED_DNS_FAILURE: 663 summary.append(mContext.getString(R.string.wifi_disabled_network_failure)); 664 break; 665 case WifiConfiguration.NetworkSelectionStatus.DISABLED_ASSOCIATION_REJECTION: 666 summary.append(mContext.getString(R.string.wifi_disabled_generic)); 667 break; 668 } 669 } else if (config != null && config.getNetworkSelectionStatus().isNotRecommended()) { 670 summary.append(mContext.getString(R.string.wifi_disabled_by_recommendation_provider)); 671 } else if (!isReachable()) { // Wifi out of range 672 summary.append(mContext.getString(R.string.wifi_not_in_range)); 673 } else { // In range, not disabled. 674 if (config != null) { // Is saved network 675 summary.append(mContext.getString(R.string.wifi_remembered)); 676 } 677 } 678 679 if (WifiTracker.sVerboseLogging > 0) { 680 // Add RSSI/band information for this config, what was seen up to 6 seconds ago 681 // verbose WiFi Logging is only turned on thru developers settings 682 if (mInfo != null && mNetworkInfo != null) { // This is the active connection 683 summary.append(" f=" + Integer.toString(mInfo.getFrequency())); 684 } 685 summary.append(" " + getVisibilityStatus()); 686 if (config != null && !config.getNetworkSelectionStatus().isNetworkEnabled()) { 687 summary.append(" (" + config.getNetworkSelectionStatus().getNetworkStatusString()); 688 if (config.getNetworkSelectionStatus().getDisableTime() > 0) { 689 long now = System.currentTimeMillis(); 690 long diff = (now - config.getNetworkSelectionStatus().getDisableTime()) / 1000; 691 long sec = diff%60; //seconds 692 long min = (diff/60)%60; //minutes 693 long hour = (min/60)%60; //hours 694 summary.append(", "); 695 if (hour > 0) summary.append(Long.toString(hour) + "h "); 696 summary.append( Long.toString(min) + "m "); 697 summary.append( Long.toString(sec) + "s "); 698 } 699 summary.append(")"); 700 } 701 702 if (config != null) { 703 WifiConfiguration.NetworkSelectionStatus networkStatus = 704 config.getNetworkSelectionStatus(); 705 for (int index = WifiConfiguration.NetworkSelectionStatus.NETWORK_SELECTION_ENABLE; 706 index < WifiConfiguration.NetworkSelectionStatus 707 .NETWORK_SELECTION_DISABLED_MAX; index++) { 708 if (networkStatus.getDisableReasonCounter(index) != 0) { 709 summary.append(" " + WifiConfiguration.NetworkSelectionStatus 710 .getNetworkDisableReasonString(index) + "=" 711 + networkStatus.getDisableReasonCounter(index)); 712 } 713 } 714 } 715 } 716 return summary.toString(); 717 } 718 719 /** 720 * Returns the visibility status of the WifiConfiguration. 721 * 722 * @return autojoin debugging information 723 * TODO: use a string formatter 724 * ["rssi 5Ghz", "num results on 5GHz" / "rssi 5Ghz", "num results on 5GHz"] 725 * For instance [-40,5/-30,2] 726 */ 727 private String getVisibilityStatus() { 728 StringBuilder visibility = new StringBuilder(); 729 StringBuilder scans24GHz = null; 730 StringBuilder scans5GHz = null; 731 String bssid = null; 732 733 long now = System.currentTimeMillis(); 734 735 if (mInfo != null) { 736 bssid = mInfo.getBSSID(); 737 if (bssid != null) { 738 visibility.append(" ").append(bssid); 739 } 740 visibility.append(" rssi=").append(mInfo.getRssi()); 741 visibility.append(" "); 742 visibility.append(" score=").append(mInfo.score); 743 visibility.append(" rankingScore=").append(getRankingScore()); 744 visibility.append(" badge=").append(getBadge()); 745 visibility.append(String.format(" tx=%.1f,", mInfo.txSuccessRate)); 746 visibility.append(String.format("%.1f,", mInfo.txRetriesRate)); 747 visibility.append(String.format("%.1f ", mInfo.txBadRate)); 748 visibility.append(String.format("rx=%.1f", mInfo.rxSuccessRate)); 749 } 750 751 int rssi5 = WifiConfiguration.INVALID_RSSI; 752 int rssi24 = WifiConfiguration.INVALID_RSSI; 753 int num5 = 0; 754 int num24 = 0; 755 int numBlackListed = 0; 756 int n24 = 0; // Number scan results we included in the string 757 int n5 = 0; // Number scan results we included in the string 758 evictOldScanResults(); 759 // TODO: sort list by RSSI or age 760 for (ScanResult result : mScanResultCache.values()) { 761 762 if (result.frequency >= LOWER_FREQ_5GHZ 763 && result.frequency <= HIGHER_FREQ_5GHZ) { 764 // Strictly speaking: [4915, 5825] 765 // number of known BSSID on 5GHz band 766 num5 = num5 + 1; 767 } else if (result.frequency >= LOWER_FREQ_24GHZ 768 && result.frequency <= HIGHER_FREQ_24GHZ) { 769 // Strictly speaking: [2412, 2482] 770 // number of known BSSID on 2.4Ghz band 771 num24 = num24 + 1; 772 } 773 774 775 if (result.frequency >= LOWER_FREQ_5GHZ 776 && result.frequency <= HIGHER_FREQ_5GHZ) { 777 if (result.level > rssi5) { 778 rssi5 = result.level; 779 } 780 if (n5 < 4) { 781 if (scans5GHz == null) scans5GHz = new StringBuilder(); 782 scans5GHz.append(" \n{").append(result.BSSID); 783 if (bssid != null && result.BSSID.equals(bssid)) scans5GHz.append("*"); 784 scans5GHz.append("=").append(result.frequency); 785 scans5GHz.append(",").append(result.level); 786 scans5GHz.append("}"); 787 n5++; 788 } 789 } else if (result.frequency >= LOWER_FREQ_24GHZ 790 && result.frequency <= HIGHER_FREQ_24GHZ) { 791 if (result.level > rssi24) { 792 rssi24 = result.level; 793 } 794 if (n24 < 4) { 795 if (scans24GHz == null) scans24GHz = new StringBuilder(); 796 scans24GHz.append(" \n{").append(result.BSSID); 797 if (bssid != null && result.BSSID.equals(bssid)) scans24GHz.append("*"); 798 scans24GHz.append("=").append(result.frequency); 799 scans24GHz.append(",").append(result.level); 800 scans24GHz.append("}"); 801 n24++; 802 } 803 } 804 } 805 visibility.append(" ["); 806 if (num24 > 0) { 807 visibility.append("(").append(num24).append(")"); 808 if (n24 <= 4) { 809 if (scans24GHz != null) { 810 visibility.append(scans24GHz.toString()); 811 } 812 } else { 813 visibility.append("max=").append(rssi24); 814 if (scans24GHz != null) { 815 visibility.append(",").append(scans24GHz.toString()); 816 } 817 } 818 } 819 visibility.append(";"); 820 if (num5 > 0) { 821 visibility.append("(").append(num5).append(")"); 822 if (n5 <= 4) { 823 if (scans5GHz != null) { 824 visibility.append(scans5GHz.toString()); 825 } 826 } else { 827 visibility.append("max=").append(rssi5); 828 if (scans5GHz != null) { 829 visibility.append(",").append(scans5GHz.toString()); 830 } 831 } 832 } 833 if (numBlackListed > 0) 834 visibility.append("!").append(numBlackListed); 835 visibility.append("]"); 836 837 return visibility.toString(); 838 } 839 840 /** 841 * Return whether this is the active connection. 842 * For ephemeral connections (networkId is invalid), this returns false if the network is 843 * disconnected. 844 */ 845 public boolean isActive() { 846 return mNetworkInfo != null && 847 (networkId != WifiConfiguration.INVALID_NETWORK_ID || 848 mNetworkInfo.getState() != State.DISCONNECTED); 849 } 850 851 public boolean isConnectable() { 852 return getLevel() != -1 && getDetailedState() == null; 853 } 854 855 public boolean isEphemeral() { 856 return mInfo != null && mInfo.isEphemeral() && 857 mNetworkInfo != null && mNetworkInfo.getState() != State.DISCONNECTED; 858 } 859 860 /** 861 * Return true if this AccessPoint represents a Passpoint AP. 862 */ 863 public boolean isPasspoint() { 864 return mConfig != null && mConfig.isPasspoint(); 865 } 866 867 /** 868 * Return true if this AccessPoint represents a Passpoint provider configuration. 869 */ 870 public boolean isPasspointConfig() { 871 return mFqdn != null; 872 } 873 874 /** 875 * Return whether the given {@link WifiInfo} is for this access point. 876 * If the current AP does not have a network Id then the config is used to 877 * match based on SSID and security. 878 */ 879 private boolean isInfoForThisAccessPoint(WifiConfiguration config, WifiInfo info) { 880 if (isPasspoint() == false && networkId != WifiConfiguration.INVALID_NETWORK_ID) { 881 return networkId == info.getNetworkId(); 882 } else if (config != null) { 883 return matches(config); 884 } 885 else { 886 // Might be an ephemeral connection with no WifiConfiguration. Try matching on SSID. 887 // (Note that we only do this if the WifiConfiguration explicitly equals INVALID). 888 // TODO: Handle hex string SSIDs. 889 return ssid.equals(removeDoubleQuotes(info.getSSID())); 890 } 891 } 892 893 public boolean isSaved() { 894 return networkId != WifiConfiguration.INVALID_NETWORK_ID; 895 } 896 897 public Object getTag() { 898 return mTag; 899 } 900 901 public void setTag(Object tag) { 902 mTag = tag; 903 } 904 905 /** 906 * Generate and save a default wifiConfiguration with common values. 907 * Can only be called for unsecured networks. 908 */ 909 public void generateOpenNetworkConfig() { 910 if (security != SECURITY_NONE) 911 throw new IllegalStateException(); 912 if (mConfig != null) 913 return; 914 mConfig = new WifiConfiguration(); 915 mConfig.SSID = AccessPoint.convertToQuotedString(ssid); 916 mConfig.allowedKeyManagement.set(KeyMgmt.NONE); 917 } 918 919 void loadConfig(WifiConfiguration config) { 920 ssid = (config.SSID == null ? "" : removeDoubleQuotes(config.SSID)); 921 bssid = config.BSSID; 922 security = getSecurity(config); 923 networkId = config.networkId; 924 mConfig = config; 925 } 926 927 private void initWithScanResult(ScanResult result) { 928 ssid = result.SSID; 929 bssid = result.BSSID; 930 security = getSecurity(result); 931 if (security == SECURITY_PSK) 932 pskType = getPskType(result); 933 mRssi = result.level; 934 mSeen = result.timestamp; 935 } 936 937 public void saveWifiState(Bundle savedState) { 938 if (ssid != null) savedState.putString(KEY_SSID, getSsidStr()); 939 savedState.putInt(KEY_SECURITY, security); 940 savedState.putInt(KEY_PSKTYPE, pskType); 941 if (mConfig != null) savedState.putParcelable(KEY_CONFIG, mConfig); 942 savedState.putParcelable(KEY_WIFIINFO, mInfo); 943 evictOldScanResults(); 944 savedState.putParcelableArrayList(KEY_SCANRESULTCACHE, 945 new ArrayList<ScanResult>(mScanResultCache.values())); 946 if (mNetworkInfo != null) { 947 savedState.putParcelable(KEY_NETWORKINFO, mNetworkInfo); 948 } 949 if (mFqdn != null) { 950 savedState.putString(KEY_FQDN, mFqdn); 951 } 952 if (mProviderFriendlyName != null) { 953 savedState.putString(KEY_PROVIDER_FRIENDLY_NAME, mProviderFriendlyName); 954 } 955 } 956 957 public void setListener(AccessPointListener listener) { 958 mAccessPointListener = listener; 959 } 960 961 boolean update(ScanResult result) { 962 if (matches(result)) { 963 int oldLevel = getLevel(); 964 965 /* Add or update the scan result for the BSSID */ 966 mScanResultCache.put(result.BSSID, result); 967 updateSeen(); 968 updateRssi(); 969 int newLevel = getLevel(); 970 971 if (newLevel > 0 && newLevel != oldLevel && mAccessPointListener != null) { 972 mAccessPointListener.onLevelChanged(this); 973 } 974 // This flag only comes from scans, is not easily saved in config 975 if (security == SECURITY_PSK) { 976 pskType = getPskType(result); 977 } 978 979 if (mAccessPointListener != null) { 980 mAccessPointListener.onAccessPointChanged(this); 981 } 982 983 return true; 984 } 985 return false; 986 } 987 988 /** Attempt to update the AccessPoint and return true if an update occurred. */ 989 public boolean update(WifiConfiguration config, WifiInfo info, NetworkInfo networkInfo) { 990 boolean updated = false; 991 final int oldLevel = getLevel(); 992 if (info != null && isInfoForThisAccessPoint(config, info)) { 993 updated = (mInfo == null); 994 if (mRssi != info.getRssi()) { 995 mRssi = info.getRssi(); 996 updated = true; 997 } 998 mInfo = info; 999 // TODO(b/37289220): compare NetworkInfo states and set updated = true if necessary 1000 mNetworkInfo = networkInfo; 1001 } else if (mInfo != null) { 1002 updated = true; 1003 mInfo = null; 1004 mNetworkInfo = null; 1005 } 1006 if (updated && mAccessPointListener != null) { 1007 mAccessPointListener.onAccessPointChanged(this); 1008 1009 if (oldLevel != getLevel() /* current level */) { 1010 mAccessPointListener.onLevelChanged(this); 1011 } 1012 } 1013 return updated; 1014 } 1015 1016 void update(WifiConfiguration config) { 1017 mConfig = config; 1018 networkId = config.networkId; 1019 if (mAccessPointListener != null) { 1020 mAccessPointListener.onAccessPointChanged(this); 1021 } 1022 } 1023 1024 @VisibleForTesting 1025 void setRssi(int rssi) { 1026 mRssi = rssi; 1027 } 1028 1029 /** Sets the rssi to {@link #UNREACHABLE_RSSI}. */ 1030 void setUnreachable() { 1031 setRssi(AccessPoint.UNREACHABLE_RSSI); 1032 } 1033 1034 int getRankingScore() { 1035 return mRankingScore; 1036 } 1037 1038 int getBadge() { 1039 return mBadge; 1040 } 1041 1042 /** Return true if the current RSSI is reachable, and false otherwise. */ 1043 public boolean isReachable() { 1044 return mRssi != UNREACHABLE_RSSI; 1045 } 1046 1047 public static String getSummary(Context context, String ssid, DetailedState state, 1048 boolean isEphemeral, String passpointProvider) { 1049 if (state == DetailedState.CONNECTED && ssid == null) { 1050 if (TextUtils.isEmpty(passpointProvider) == false) { 1051 // Special case for connected + passpoint networks. 1052 String format = context.getString(R.string.connected_via_passpoint); 1053 return String.format(format, passpointProvider); 1054 } else if (isEphemeral) { 1055 // Special case for connected + ephemeral networks. 1056 final NetworkScoreManager networkScoreManager = context.getSystemService( 1057 NetworkScoreManager.class); 1058 NetworkScorerAppData scorer = networkScoreManager.getActiveScorer(); 1059 if (scorer != null && scorer.getRecommendationServiceLabel() != null) { 1060 String format = context.getString(R.string.connected_via_network_scorer); 1061 return String.format(format, scorer.getRecommendationServiceLabel()); 1062 } else { 1063 return context.getString(R.string.connected_via_network_scorer_default); 1064 } 1065 } 1066 } 1067 1068 // Case when there is wifi connected without internet connectivity. 1069 final ConnectivityManager cm = (ConnectivityManager) 1070 context.getSystemService(Context.CONNECTIVITY_SERVICE); 1071 if (state == DetailedState.CONNECTED) { 1072 IWifiManager wifiManager = IWifiManager.Stub.asInterface( 1073 ServiceManager.getService(Context.WIFI_SERVICE)); 1074 NetworkCapabilities nc = null; 1075 1076 try { 1077 nc = cm.getNetworkCapabilities(wifiManager.getCurrentNetwork()); 1078 } catch (RemoteException e) {} 1079 1080 if (nc != null) { 1081 if (nc.hasCapability(nc.NET_CAPABILITY_CAPTIVE_PORTAL)) { 1082 return context.getString( 1083 com.android.internal.R.string.network_available_sign_in); 1084 } else if (!nc.hasCapability(NetworkCapabilities.NET_CAPABILITY_VALIDATED)) { 1085 return context.getString(R.string.wifi_connected_no_internet); 1086 } 1087 } 1088 } 1089 if (state == null) { 1090 Log.w(TAG, "state is null, returning empty summary"); 1091 return ""; 1092 } 1093 String[] formats = context.getResources().getStringArray((ssid == null) 1094 ? R.array.wifi_status : R.array.wifi_status_with_ssid); 1095 int index = state.ordinal(); 1096 1097 if (index >= formats.length || formats[index].length() == 0) { 1098 return ""; 1099 } 1100 return String.format(formats[index], ssid); 1101 } 1102 1103 public static String getSummary(Context context, DetailedState state, boolean isEphemeral) { 1104 return getSummary(context, null, state, isEphemeral, null); 1105 } 1106 1107 public static String getSummary(Context context, DetailedState state, boolean isEphemeral, 1108 String passpointProvider) { 1109 return getSummary(context, null, state, isEphemeral, passpointProvider); 1110 } 1111 1112 public static String convertToQuotedString(String string) { 1113 return "\"" + string + "\""; 1114 } 1115 1116 private static int getPskType(ScanResult result) { 1117 boolean wpa = result.capabilities.contains("WPA-PSK"); 1118 boolean wpa2 = result.capabilities.contains("WPA2-PSK"); 1119 if (wpa2 && wpa) { 1120 return PSK_WPA_WPA2; 1121 } else if (wpa2) { 1122 return PSK_WPA2; 1123 } else if (wpa) { 1124 return PSK_WPA; 1125 } else { 1126 Log.w(TAG, "Received abnormal flag string: " + result.capabilities); 1127 return PSK_UNKNOWN; 1128 } 1129 } 1130 1131 private static int getSecurity(ScanResult result) { 1132 if (result.capabilities.contains("WEP")) { 1133 return SECURITY_WEP; 1134 } else if (result.capabilities.contains("PSK")) { 1135 return SECURITY_PSK; 1136 } else if (result.capabilities.contains("EAP")) { 1137 return SECURITY_EAP; 1138 } 1139 return SECURITY_NONE; 1140 } 1141 1142 static int getSecurity(WifiConfiguration config) { 1143 if (config.allowedKeyManagement.get(KeyMgmt.WPA_PSK)) { 1144 return SECURITY_PSK; 1145 } 1146 if (config.allowedKeyManagement.get(KeyMgmt.WPA_EAP) || 1147 config.allowedKeyManagement.get(KeyMgmt.IEEE8021X)) { 1148 return SECURITY_EAP; 1149 } 1150 return (config.wepKeys[0] != null) ? SECURITY_WEP : SECURITY_NONE; 1151 } 1152 1153 public static String securityToString(int security, int pskType) { 1154 if (security == SECURITY_WEP) { 1155 return "WEP"; 1156 } else if (security == SECURITY_PSK) { 1157 if (pskType == PSK_WPA) { 1158 return "WPA"; 1159 } else if (pskType == PSK_WPA2) { 1160 return "WPA2"; 1161 } else if (pskType == PSK_WPA_WPA2) { 1162 return "WPA_WPA2"; 1163 } 1164 return "PSK"; 1165 } else if (security == SECURITY_EAP) { 1166 return "EAP"; 1167 } 1168 return "NONE"; 1169 } 1170 1171 static String removeDoubleQuotes(String string) { 1172 if (TextUtils.isEmpty(string)) { 1173 return ""; 1174 } 1175 int length = string.length(); 1176 if ((length > 1) && (string.charAt(0) == '"') 1177 && (string.charAt(length - 1) == '"')) { 1178 return string.substring(1, length - 1); 1179 } 1180 return string; 1181 } 1182 1183 public interface AccessPointListener { 1184 void onAccessPointChanged(AccessPoint accessPoint); 1185 void onLevelChanged(AccessPoint accessPoint); 1186 } 1187} 1188