wifi-wand 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4729288451e02d7b968dac5ef6bfd703383e3e7a759386ae6b74d82527e2dea6
-  data.tar.gz: '085c16eba0b518c4be31609cfd8847788f8d0e0985ae9b167c41585c66a18182'
+  metadata.gz: 71b05a8e0debe969871ce1c44e2a5497458b970f7cf6d666d2035448636f194b
+  data.tar.gz: 3decf9e34a5aaca2b0d1de7ccb91a93138b002d755c648d0975ca0164a48624d
 SHA512:
-  metadata.gz: 83b47a2b64ba1a6b436f38c7da2f546156076891cb73fae03a6b90f57b72119c4d6affd25bff7bac42523fd0e4abfcbf45eb9fb7363739cc9641a7992881fdad
-  data.tar.gz: 365bd3f24ed79803b100ab0785c16a4257dadb18c25f9a8a6c0617eda4e4bba8786104000c559d24932bffc6cda95e428bf617b1c39b50db675b87a8170eabed
+  metadata.gz: 57fa874a6588a7a03862a2397f172374a3203e27fb0694623a6385a1743d195e1899393705cb6ef2133448e402fdf09a8fd4cebb19dfd67fa16d367addaa9a99
+  data.tar.gz: 37b6a84124163b57e1a6922f7703dac69bb8ebcddf6c3ac5d4e056404b4a224b27f1a98505f09c798586df6e0a8cd6a6564664775f48742dd28d90d8dbf6f00a

data/README.md

@@ -32,7 +32,7 @@ $ wifi-wand -h
 Command Line Switches:                    [wifi-wand version 2.14.0 at https://github.com/keithrbennett/wifiwand]
 
 -o {i,j,k,p,y}            - outputs data in inspect, JSON, pretty JSON, puts, or YAML format when not in shell mode
--p wifi_port_name         - override automatic detection of port name with this name
+-p wifi_interface_name    - override automatic detection of interface name with this name
 -s                        - run in shell mode
 -v                        - verbose mode (prints OS commands and their outputs)
 
@@ -44,17 +44,18 @@ co[nnect] network-name    - turns wifi on, connects to network-name
 cy[cle]                   - turns wifi off, then on, preserving network selection
 d[isconnect]              - disconnects from current network, does not turn off wifi
 f[orget] name1 [..name_n] - removes network-name(s) from the preferred networks list
+                            in interactive mode, can be a single array of names, e.g. returned by `pref_nets`
 h[elp]                    - prints this help
 i[nfo]                    - a hash of wifi-related information
-l[s_avail_nets]           - details about available networks in descending order of signal strength
-na[meservers]             - nameservers: 'show' or no arg to show, 'clear' to clear, or IP addresses to set, e.g. '9.9.9.9  8.8.8.8'
+na[meservers]             - nameservers: 'show' or no arg to show, 'clear' to clear,
+                            or IP addresses to set, e.g. '9.9.9.9  8.8.8.8'
 ne[twork_name]            - name (SSID) of currently connected network
 on                        - turns wifi on
 of[f]                     - turns wifi off
 pa[ssword] network-name   - password for preferred network-name
 pr[ef_nets]               - preferred (saved) networks
 q[uit]                    - exits this program (interactive shell mode only) (see also 'x')
-ro[pen]                   - open resource ('ipl' (IP Location), 'ipw' (What is My IP), 'spe' (Speed Test), 'this' (wifi-wand home page))
+ro[pen]                   - open resource ('cap' (Portal Logins), 'ipl' (IP Location), 'ipw' (What is My IP), 'libre' (LibreSpeed), 'spe' (Speed Test), 'this' (wifi-wand home page))
 t[ill]                    - returns when the desired Internet connection state is true. Options:
                             1) 'on'/:on, 'off'/:off, 'conn'/:conn, or 'disc'/:disc
                             2) wait interval between tests, in seconds (optional, defaults to 0.5 seconds)
@@ -69,16 +70,6 @@ When in interactive shell mode:
 Internally, it uses several Mac command line utilities to interact with the
 underlying operating system.
 
-> [!WARNING]  
-> Starting in Mac OS version 14.4, the `airport` utility on which some of this project's
-> functionality relies has been disabled and will presumably eventually be removed.
-> 
-> The following commands will result in a runtime error if `airport` is no longer available:
-> 
-> * listing names of available wifi networks
-> * listing detailed information about available wifi networks
-> * disconnecting from a wifi network
-
 ### Pretty Output
 
 For nicely formatted output of the `info` command in non-interactive mode,
@@ -213,7 +204,6 @@ constants or instance variables if you want to create variables in your shell.
 ```
 wifi-wand i            # prints out wifi info
 wifi-wand a            # prints out names of available networks
-wifi-wand lsa          # prints available networks detailed information
 wifi-wand pr           # prints preferred networks
 wifi-wand cy           # cycles the wifi off and on
 wifi-wand co a-network a-password # connects to a network requiring a password
@@ -363,10 +353,27 @@ to create a script for your most commonly used networks containing something lik
 wifi-wand  connect  my-usual-network  its-password
 ```
 
+### Airport Utility Deprecation (April 2024)
+
+Starting in Mac OS version 14.4, the `airport` utility on which some of this project's
+functionality relies has been disabled and will presumably eventually be removed.
+
+The following tasks were restored by using Swift scripts:
+* listing names of all available networks
+* disconnecting from a network (with the added benefit that sudo access is no longer required)
+
+The following tasks were restored by using `networksetup`:
+* determining whether or not wifi is on
+* the name of the currently connected network
+
+The only remaining issue is that we were getting some extended information from airport for each available network. This extended information has now been removed in version 2.17.0.
+
+In addition, the extended information about the available networks (`ls_avail_nets`) has been removed in version 2.17.0.
+
 
 ### License
 
-MIT License (see LICENSE.txt)
+Apache 2 License (see LICENSE.txt)
 
 ### Logo
 

data/RELEASE_NOTES.md

@@ -1,3 +1,17 @@
+## v2.17.0
+
+* Remove all remaining uses of the 'airport' command.
+* Remove 'available_network_info' command which required the 'airport' command.
+* Remove extended information in the 'info' command output, which required the 'airport' command.
+* Remove unused ModelValidator class.
+* In README, update license reference and make other edits.
+
+
+## v2.16.1
+
+* Fix airport deprecations' removal of listing all networks and disconnecting from a network by using Swift scripts.
+
+
 ## v2.16.0 (2024-04)
 
 * Handle deprecation of the `airport` command starting at Mac OS 14.4.

data/integration-tests/wifi-wand/models/mac_os_model_spec.rb

@@ -40,7 +40,7 @@ describe MacOsModel do
 
     it 'can list available networks' do
       subject.wifi_on
-      subject.available_network_info
+      subject.available_network_names
     end
   end
 

data/lib/wifi-wand/command_line_interface.rb

@@ -73,7 +73,6 @@ f[orget] name1 [..name_n] - removes network-name(s) from the preferred networks
                             in interactive mode, can be a single array of names, e.g. returned by `pref_nets`
 h[elp]                    - prints this help
 i[nfo]                    - a hash of wifi-related information
-l[s_avail_nets]           - details about available networks, in descending order of signal strength
 na[meservers]             - nameservers: 'show' or no arg to show, 'clear' to clear,
                             or IP addresses to set, e.g. '9.9.9.9  8.8.8.8'
 ne[twork_name]            - name (SSID) of currently connected network
@@ -203,7 +202,6 @@ When in interactive shell mode:
   end
 
 
-
   def quit
     if interactive_mode
       exit(0)
@@ -272,29 +270,6 @@ When in interactive shell mode:
     end
   end
 
-
-  def cmd_l
-    info = model.available_network_info
-
-    if interactive_mode
-      info
-    else
-      output = ''
-      unless model.wifi_on?
-        output << "Wifi is off, cannot see available networks."
-      else
-        if post_processor
-          output = post_processor.(info)
-        else
-          output << "\nAccess points listed in descending order of signal strength (RSSI):\n\n"
-          output << fancy_string(info)
-        end
-      end
-      puts output
-    end
-  end
-
-
   # Performs nameserver functionality.
   # @param subcommand 'get' or no arg to get, 'clear' to clear, and an array of IP addresses to set
   def cmd_na(*args)

data/lib/wifi-wand/models/mac_os_model.rb

@@ -6,73 +6,15 @@ require 'shellwords'
 require_relative 'base_model'
 require_relative '../error'
 
-# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-# 2024-04-18:
-#
-# Apple has deprecated the 'airport' utility and has already disabled its
-# functionality. This utility is used for the following wifi-wand commands:
-
-# 1) cmd: info, fn: wifi_info - adds information to the info output
-# 2) cmd: avail_nets, fn: available_network_names - available wifi network names
-# 3) cmd: ls_avail_nets, fn: available_network_info - available wifi networks details
-# 4) cmd: wifi_on, fn: wifi_on?
-# 5) cmd: network_name, fn: connected_network_name
-# 6) cmd: disconnect, fn: disconnect
-
-# Functions 4 and 5 have been fixed to use `networksetup` instead of `airport`.
-# The others are not yet fixed.
-
-# An AskDifferent (Mac StackExchange site) question has been posted to
-# https://apple.stackexchange.com/questions/471886/how-to-replace-functionality-of-deprecated-airport-command-line-application.
-# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
 module WifiWand
 
 class MacOsModel < BaseModel
 
-  DEFAULT_AIRPORT_FILESPEC = '/System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport'
-
-  attr_reader :airport_deprecated, :mac_os_version_major, :mac_os_version_minor, :mac_os_version_string
-
   # Takes an OpenStruct containing options such as verbose mode and interface name.
   def initialize(options = OpenStruct.new)
     super
-    populate_mac_os_version
-    @airport_deprecated = @mac_os_version_major > 14 || (@mac_os_version_major == 14 && @mac_os_version_minor >= 4)
-  end
-
-  # Provides Mac OS major and minor version numbers
-  def populate_mac_os_version
-    @mac_os_version_string = `sw_vers --productVersion`.chomp
-    @mac_os_version_major, @mac_os_version_minor = mac_os_version_string.split('.').map(&:to_i)
-    [@mac_os_version_major, @mac_os_version_minor]
-  end
-
-  def airport_deprecated_message
-    <<~MESSAGE
-      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-      This method requires the airport utility which is no longer functional in Mac OS >= 14.4.
-      You are running Mac OS version #{mac_os_version_string}.
-      !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-    MESSAGE
   end
 
-  # Although at this time the airport command utility is predictable,
-  # allow putting it elsewhere in the path for overriding and easier fix
-  # if that location should change.
-  def airport_command
-    airport_in_path = `which airport`.chomp
-
-    return airport_in_path unless airport_in_path.empty?
-
-    return DEFAULT_AIRPORT_FILESPEC if File.exist?(DEFAULT_AIRPORT_FILESPEC)
-
-    raise Error.new("Airport command not found.") unless airport_deprecated
-
-    nil # no error, no data
-  end
-
-
   # Identifies the (first) wireless network hardware interface in the system, e.g. en0 or en1
   # This may not detect wifi ports with nonstandard names, such as USB wifi devices.
   def detect_wifi_interface
@@ -98,114 +40,10 @@ class MacOsModel < BaseModel
     end
   end
 
-
-  # Returns data pertaining to available wireless networks.
-  # For some reason, this often returns no results, so I've put the operation in a loop.
-  # I was unable to detect a sort strategy in the airport utility's output, so I sort
-  # the lines alphabetically, to show duplicates and for easier lookup.
-  #
-  # Sample Output:
-  #
-  # => ["SSID                             BSSID             RSSI CHANNEL HT CC SECURITY (auth/unicast/group)",
-  #     "ByCO-U00tRzUzMEg                 64:6c:b2:db:f3:0c -56  6       Y  -- NONE",
-  #     "Chancery                         0a:18:d6:0b:b9:c3 -82  11      Y  -- NONE",
-  #     "Chancery                         2a:a4:3c:03:33:99 -59  60,+1   Y  -- NONE",
-  #     "DIRECT-sq-BRAVIA                 02:71:cc:87:4a:8c -76  6       Y  -- WPA2(PSK/AES/AES) ",  #
-  def available_network_info
-
-    raise RuntimeError, airport_deprecated_message if airport_deprecated
-
-    return nil unless wifi_on? # no need to try
-    command = "#{airport_command} -s | iconv -f macroman -t utf-8"
-    max_attempts = 50
-
-    reformat_line = ->(line) do
-      ssid = line[0..31].strip
-      "%-32.32s%s" % [ssid, line[32..-1]]
-    end
-
-    signal_strength = ->(line) { (line[50..54] || '').to_i }
-
-    sort_in_place_by_signal_strength = ->(lines) do
-      lines.sort! { |x,y| signal_strength.(y) <=> signal_strength.(x) }
-    end
-
-    process_tabular_data = ->(output) do
-      lines = output.split("\n")
-      header_line = lines[0]
-      data_lines = lines[1..-1]
-      data_lines.map! do |line|
-        # Reformat the line so that the name is left instead of right justified
-        reformat_line.(line)
-      end
-      sort_in_place_by_signal_strength.(data_lines)
-      [reformat_line.(header_line)] + data_lines
-    end
-
-    output = try_os_command_until(command, ->(output) do
-      ! ([nil, ''].include?(output))
-    end)
-
-    if output
-      process_tabular_data.(output)
-    else
-      raise Error.new("Unable to get available network information after #{max_attempts} attempts.")
-    end
-  end
-
-
-  # The Mac OS airport utility (at
-  # /System/Library/PrivateFrameworks/Apple80211.framework/Versions/Current/Resources/airport)
-  # outputs the network names right padded with spaces so there is no way to differentiate a
-  # network name *with* leading space(s) from one without:
-  #
-  #                   SSID BSSID             RSSI CHANNEL HT CC SECURITY (auth/unicast/group)
-  #    ngHub_319442NL0293C 04:a1:51:58:5b:05 -65  11      Y  US WPA2(PSK/AES/AES)
-  #        NETGEAR89_2GEXT 9c:3d:cf:11:69:b4 -67  8       Y  US NONE
-  #
-  # To remedy this, they offer a "-x" option that outputs the information in (pseudo) XML.
-  # This XML has 'dict' elements that contain many elements. The SSID can be found in the
-  # XML element <string> which immediately follows an XML element whose text is "SSID_STR".
-  # Unfortunately, since there is no way to connect the two other than their physical location,
-  # the key is rather useless for XML parsing.
-  #
-  # I tried extracting the arrays of keys and strings, and finding the string element
-  # at the same position in the string array as the 'SSID_STR' was in the keys array.
-  # However, not all keys had string elements, so the index in the key array was the wrong index.
-  # Here is an excerpt from the XML output:
-  #
-  # 		<key>RSSI</key>
-  # 		<integer>-91</integer>
-  # 		<key>SSID</key>
-  # 		<data>
-  # 		TkVUR0VBUjY1
-  # 		</data>
-  # 		<key>SSID_STR</key>
-  # 		<string>NETGEAR65</string>
-  #
-  # The kludge I came up with was that the ssid was always the 2nd value in the <string> element
-  # array, so that's what is used here.
-  #
-  # But now even that approach has been superseded by the XPath approach now used.
-  #
-  # REXML is used here to avoid the need for the user to install Nokogiri.
   def available_network_names
-    raise RuntimeError, airport_deprecated_message if airport_deprecated
-
     return nil unless wifi_on? # no need to try
 
-    # For some reason, the airport command very often returns nothing, so we need to try until
-    # we get data in the response:
-
-    command = "#{airport_command} -s -x | iconv -f macroman -t utf-8"
-    stop_condition = ->(response) { ! [nil, ''].include?(response) }
-    output = try_os_command_until(command, stop_condition)
-    doc = REXML::Document.new(output)
-    xpath = '//key[text() = "SSID_STR"][1]/following-sibling::*[1]' # provided by @ScreenStaring on Twitter
-    REXML::XPath.match(doc, xpath) \
-        .map(&:text) \
-        .sort { |x,y| x.casecmp(y) } \
-        .uniq
+    run_swift_command('AvailableWifiNetworkLister').split("\n")
   end
 
 
@@ -323,10 +161,9 @@ class MacOsModel < BaseModel
 
   # Disconnects from the currently connected network. Does not turn off wifi.
   def disconnect
-    raise RuntimeError, airport_deprecated_message if airport_deprecated
-
     return nil unless wifi_on? # no need to try
-    run_os_command("sudo #{airport_command} -z")
+
+    run_swift_command('WifiNetworkDisconecter')
     nil
   end
 
@@ -365,13 +202,6 @@ class MacOsModel < BaseModel
         'timestamp'   => Time.now,
     }
 
-    unless airport_deprecated
-      more_output = run_os_command(airport_command + " -I")
-      more_info   = colon_output_to_hash(more_output)
-      info.merge!(more_info)
-      info.delete('AirPort') # will be here if off, but info is already in wifi_on key
-    end
-
     if info['internet_on'] && (! need_hotspot_login)
       begin
         info['public_ip'] = public_ip_address_info
@@ -463,5 +293,27 @@ class MacOsModel < BaseModel
     end
     output.split("\n")
   end
+
+  def ensure_swift_and_corewlan_present
+    unless swift_and_corewlan_present?
+      raise RuntimeError, <<~MESSAGE
+        Swift and/or CoreWLAN are not present and are needed by this task.
+        This can be fixed by installing XCode.
+      MESSAGE
+    end
+  end
+
+  def swift_and_corewlan_present?
+    system("swift -e 'import CoreWLAN' >/dev/null 2>&1")
+  end
+
+  def run_swift_command(basename)
+    ensure_swift_and_corewlan_present
+    swift_filespec = File.join(
+      File.dirname(__FILE__), "../../../swift/#{basename}.swift"
+    )
+    command = "swift #{swift_filespec}"
+    `#{command}`
+  end
 end
 end

data/lib/wifi-wand/version.rb

@@ -1,3 +1,3 @@
 module WifiWand
-  VERSION = '2.16.0' unless defined?(VERSION)
+  VERSION = '2.17.0' unless defined?(VERSION)
 end

data/swift/AvailableWifiNetworkLister.swift

@@ -0,0 +1,30 @@
+#!/usr/bin/env swift
+
+import Foundation
+import CoreWLAN
+
+class NetworkScanner {
+    var currentInterface: CWInterface
+    
+    init?() {
+        // Initialize with the default Wi-Fi interface
+        guard let defaultInterface = CWWiFiClient.shared().interface(),
+              defaultInterface.interfaceName != nil else {
+            return nil
+        }
+        self.currentInterface = defaultInterface
+    }
+    
+    func available_networks() {
+        do {
+            let networks = try currentInterface.scanForNetworks(withName: nil)
+            for network in networks {
+                print("\(network.ssid ?? "Unknown")")
+            }
+        } catch let error as NSError {
+            print("Error: \(error.localizedDescription)")
+        }
+    }
+}
+
+NetworkScanner()?.available_networks()

data/swift/WifiNetworkDisconecter.swift

@@ -0,0 +1,13 @@
+#!/usr/bin/env swift
+
+import Foundation
+import CoreWLAN
+
+if let wifiInterface = CWWiFiClient.shared().interface() {
+    wifiInterface.disassociate()
+    print("ok")
+    exit(0)
+} else {
+    print("error")
+    exit(1)
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wifi-wand
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.17.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-20 00:00:00.000000000 Z
+date: 2024-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -134,7 +134,6 @@ files:
 - lib/wifi-wand/models/base_model.rb
 - lib/wifi-wand/models/helpers/command_output_formatter.rb
 - lib/wifi-wand/models/mac_os_model.rb
-- lib/wifi-wand/models/model_validator.rb
 - lib/wifi-wand/operating_systems.rb
 - lib/wifi-wand/os/base_os.rb
 - lib/wifi-wand/os/imaginary_os.rb
@@ -155,6 +154,8 @@ files:
 - sample-available-networks.json
 - sample-available-networks.yaml
 - spec/wifi-wand/models/base_model_spec.rb
+- swift/AvailableWifiNetworkLister.swift
+- swift/WifiNetworkDisconecter.swift
 - test-data/invalid-byte-sequence-network-names.txt
 - wifi-wand.gemspec
 homepage: https://github.com/keithrbennett/wifiwand

data/lib/wifi-wand/models/model_validator.rb

@@ -1,60 +0,0 @@
-module WifiWand
-
-  class ModelValidator
-
-    BASE_MODEL_ESSENTIAL_METHODS = [
-        :connect,
-        :connected_to?,
-        :connected_to_internet?,
-        :cycle_network,
-        :preferred_network_password,
-        :public_ip_address_info,
-        :random_mac_address,
-        :remove_preferred_networks,
-        :run_os_command,
-        :till,
-        :try_os_command_until,
-        :verbose_mode,
-        :verbose_mode=,
-        :wifi_interface,
-        :wifi_interface=
-    ]
-
-
-    BASE_MODEL_NONESSENTIAL_METHODS = [
-    ]
-
-
-    MAC_OS_MODEL_ESSENTIAL_METHODS = [
-        :airport_command,
-        :available_network_info,
-        :available_network_names,
-        :connected_network_name,
-        :detect_wifi_interface,
-        :disconnect,
-        :ip_address,
-        :is_wifi_interface?,
-        :mac_address,
-        :nameservers_using_networksetup,
-        :nameservers_using_resolv_conf,
-        :nameservers_using_scutil,
-        :open_resource,
-        :os_level_connect,
-        :os_level_preferred_network_password,
-        :preferred_networks,
-        :remove_preferred_network,
-        :set_nameservers,
-        :wifi_info,
-        :wifi_off,
-        :wifi_on,
-        :wifi_on?
-    ]
-
-    MAC_OS_MODEL_ESSENTIAL_METHODS = [
-        ]
-
-    ALL_MODEL_METHODS = BASE_MODEL_ESSENTIAL_METHODS + MAC_OS_MODEL_ESSENTIAL_METHODS
-
-
-  end
-end