examples: update python examples

Update the raw D-Bus python examples to use newer APIs where
appropriate (and split the add-connection example into 1.0-only and
0.9-compatible versions). Update the gi-based python examples for the
various API changes since they were last updated.

Also add a comment to the ruby add-connection example pointing out
that it's still using the old settings APIs.

examples/python/dbus/Makefile.am

@@ -1,6 +1,7 @@
 EXTRA_DIST = \
 	nm-state.py \
 	add-connection.py \
+	add-connection-compat.py \
 	add-system-wifi-connection.py \
 	vpn.py \
 	update-secrets.py \

examples/python/dbus/add-connection-compat.py

@@ -0,0 +1,66 @@
+#!/usr/bin/env python
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Copyright (C) 2010 - 2012 Red Hat, Inc.
+#
+
+#
+# This example adds a new ethernet connection via the AddConnection()
+# D-Bus call, using backward-compatible settings, so it will work with
+# both old and new versions of NetworkManager. Compare
+# add-connection.py, which only supports NM 1.0 and later.
+#
+# Configuration settings are described at
+# https://developer.gnome.org/NetworkManager/1.0/ref-settings.html
+#
+
+import socket, struct, dbus, uuid
+
+# Helper functions
+def ip_to_int(ip_string):
+    return struct.unpack("=I", socket.inet_aton(ip_string))[0]
+
+def int_to_ip(ip_int):
+    return socket.inet_ntoa(struct.pack("=I", ip_int))
+
+s_wired = dbus.Dictionary({'duplex': 'full'})
+s_con = dbus.Dictionary({
+            'type': '802-3-ethernet',
+            'uuid': str(uuid.uuid4()),
+            'id': 'MyConnectionExample'})
+
+addr1 = dbus.Array([ip_to_int("10.1.2.3"), dbus.UInt32(8L), ip_to_int("10.1.2.1")], signature=dbus.Signature('u'))
+s_ip4 = dbus.Dictionary({
+            'addresses': dbus.Array([addr1], signature=dbus.Signature('au')),
+            'method': 'manual'})
+
+s_ip6 = dbus.Dictionary({'method': 'ignore'})
+
+con = dbus.Dictionary({
+    '802-3-ethernet': s_wired,
+    'connection': s_con,
+    'ipv4': s_ip4,
+    'ipv6': s_ip6})
+
+
+print "Creating connection:", s_con['id'], "-", s_con['uuid']
+
+bus = dbus.SystemBus()
+proxy = bus.get_object("org.freedesktop.NetworkManager", "/org/freedesktop/NetworkManager/Settings")
+settings = dbus.Interface(proxy, "org.freedesktop.NetworkManager.Settings")
+
+settings.AddConnection(con)
+

examples/python/dbus/add-connection.py

@@ -18,20 +18,17 @@
 #
 
 #
-# This example adds a new ethernet connection via AddConnection() D-Bus call.
+# This example adds a new ethernet connection via the AddConnection()
+# D-Bus call, using the new 'ipv4.address-data' and 'ipv4.gateway'
+# settings introduced in NetworkManager 1.0. Compare
+# add-connection-compat.py, which will work against older versions of
+# NetworkManager as well.
 #
 # Configuration settings are described at
-# https://developer.gnome.org/NetworkManager/0.9/ref-settings.html
+# https://developer.gnome.org/NetworkManager/1.0/ref-settings.html
 #
 
-import socket, struct, dbus, uuid
+import dbus, uuid
-
-# Helper functions
-def ip_to_int(ip_string):
-    return struct.unpack("=I", socket.inet_aton(ip_string))[0]
-
-def int_to_ip(ip_int):
-    return socket.inet_ntoa(struct.pack("=I", ip_int))
 
 s_wired = dbus.Dictionary({'duplex': 'full'})
 s_con = dbus.Dictionary({
@@ -39,9 +36,12 @@ s_con = dbus.Dictionary({
             'uuid': str(uuid.uuid4()),
             'id': 'MyConnectionExample'})
 
-addr1 = dbus.Array([ip_to_int("10.1.2.3"), dbus.UInt32(8L), ip_to_int("10.1.2.1")], signature=dbus.Signature('u'))
+addr1 = dbus.Dictionary({
+    'address': '10.1.2.3',
+    'prefix': dbus.UInt32(8L)})
 s_ip4 = dbus.Dictionary({
-            'addresses': dbus.Array([addr1], signature=dbus.Signature('au')),
+            'address-data': dbus.Array([addr1], signature=dbus.Signature('a{sv}')),
+            'gateway': '10.1.2.1',
             'method': 'manual'})
 
 s_ip6 = dbus.Dictionary({'method': 'ignore'})

examples/python/dbus/is-wwan-default.py

@@ -28,6 +28,8 @@ NM_SERVICE_NAME = "org.freedesktop.NetworkManager"
 NM_MANAGER_IFACE = "org.freedesktop.NetworkManager"
 DBUS_PROPS_IFACE = "org.freedesktop.DBus.Properties"
 
+NM_ACTIVE_CONNECTION_INTERFACE = "org.freedesktop.NetworkManager.Connection.Active"
+
 bus = dbus.SystemBus()
 
 # Exit early if NetworkManager is not running
@@ -42,34 +44,54 @@ proxy = bus.get_object(NM_SERVICE_NAME, "/org/freedesktop/NetworkManager")
 manager = dbus.Interface(proxy, NM_MANAGER_IFACE)
 props = dbus.Interface(proxy, DBUS_PROPS_IFACE)
 
-default_is_wwan = False
+def found_connection_type(ctype):
+    if ctype == '':
+        print "No active connection"
+    elif ctype in ["gsm", "cdma", "bluetooth"]:
+        print "WWAN is default"
+    else:
+        print "WWAN is not default"
+        sys.exit(0)
 
-# Look through all active network connections for the default one
+# Shortcut #1, for NM 1.0
+try:
+    ctype = props.Get(NM_MANAGER_IFACE, "PrimaryConnectionType")
+    found_connection_type(ctype)
+except KeyError:
+    pass
+
+# Shortcut #2, for NM 0.9.10
+try:
+    primary = props.Get(NM_MANAGER_IFACE, "PrimaryConnection")
+    if not primary:
+        found_connection_type('')
+    primary_proxy = bus.get_object(NM_SERVICE_NAME, primary)
+    primary_props = dbus.Interface(primary_proxy, DBUS_PROPS_IFACE)
+    ctype = primary_props.Get(NM_ACTIVE_CONNECTION_INTERFACE, "Type")
+    found_connection_type(ctype)
+except KeyError:
+    pass
+
+# Fallback for NM 0.9.8 and earlier; look through all active network
+# connections for the default one
+default_is_wwan = False
 active = props.Get(NM_MANAGER_IFACE, "ActiveConnections")
 for a in active:
     a_proxy = bus.get_object(NM_SERVICE_NAME, a)
     a_props = dbus.Interface(a_proxy, DBUS_PROPS_IFACE)
-    all_props = a_props.GetAll("org.freedesktop.NetworkManager.Connection.Active")
+    all_props = a_props.GetAll(NM_ACTIVE_CONNECTION_INTERFACE)
 
     # Ignore this network connection if it's not default for IPv4 or IPv6
     if all_props["Default"] == False and all_props["Default6"] == False:
         continue
 
-    # Shortcut: check for Type property (only present in NM 0.9.9+)
+    dev_path = all_props["Devices"][0]
-    try:
+    dev_proxy = bus.get_object(NM_SERVICE_NAME, dev_path)
-        ctype = all_props["Type"]
+    dev_props = dbus.Interface(dev_proxy, DBUS_PROPS_IFACE)
-        if ctype in ["gsm", "cdma", "bluetooth"]:
+    devtype = dev_props.Get("org.freedesktop.NetworkManager.Device", "DeviceType")
-            default_is_wwan = True
+    if devtype == NM_DEVICE_TYPE_MODEM or devtype == NM_DEVICE_TYPE_BLUETOOTH:
-            break
+        default_is_wwan = True
-    except KeyError:
+        break
-        # Fall back to checking the type of the network connection's device
-        dev_path = all_props["Devices"][0]
-        dev_proxy = bus.get_object(NM_SERVICE_NAME, dev_path)
-        dev_props = dbus.Interface(dev_proxy, DBUS_PROPS_IFACE)
-        devtype = dev_props.Get("org.freedesktop.NetworkManager.Device", "DeviceType")
-        if devtype == NM_DEVICE_TYPE_MODEM or devtype == NM_DEVICE_TYPE_BLUETOOTH:
-            default_is_wwan = True
-            break
 
 if default_is_wwan:
     print "WWAN is default"

examples/python/dbus/update-ip4-method.py

@@ -21,15 +21,14 @@
 #
 # This example updates a connection's IPv4 method with the Update() method.
 #
+# This uses the new NM 1.0 setting properties. See add-connection-compat.py
+# for a similar example using the backward-compatible properties
+#
 # Configuration settings are described at
-# https://developer.gnome.org/NetworkManager/0.9/ref-settings.html
+# https://developer.gnome.org/NetworkManager/1.0/ref-settings.html
 #
 
-import socket, struct, dbus, sys
+import dbus, sys
-
-def ip_to_int(ip_string):
-    return struct.unpack("=I", socket.inet_aton(ip_string))[0]
-
 
 if len(sys.argv) < 3:
     print "Usage: %s <uuid> <auto|static> [address prefix gateway]" % sys.argv[0]
@@ -61,18 +60,22 @@ for c_path in settings.ListConnections():
     if 'ipv4' not in c_settings:
         c_settings['ipv4'] = {}
 
+    # clear existing address info
+    if c_settings['ipv4'].has_key('addresses'):
+        del c_settings['ipv4']['addresses']
+    if c_settings['ipv4'].has_key('address-data'):
+        del c_settings['ipv4']['address-data']
+    if c_settings['ipv4'].has_key('gateway'):
+        del c_settings['ipv4']['gateway']
+
     # set the method and change properties
     c_settings['ipv4']['method'] = method
-    if method == "auto":
+    if method == "manual":
-        # remove addresses
-    	c_settings['ipv4']['addresses'] = dbus.Array([], signature=dbus.Signature('au'))
-    elif method == "manual":
         # Add the static IP address, prefix, and (optional) gateway
-        gw = 0
+        addr = dbus.Dictionary({'address': sys.argv[3], 'prefix': dbus.UInt32(int(sys.argv[4]))})
+        c_settings['ipv4']['address-data'] = dbus.Array([addr], signature=dbus.Signature('a{sv}'))
         if len(sys.argv) == 6:
-            gw = ip_to_int(sys.argv[5])
+            c_settings['ipv4']['gateway'] = sys.argv[5]
-        addr = dbus.Array([ip_to_int(sys.argv[3]), dbus.UInt32(int(sys.argv[4])), gw], signature=dbus.Signature('u'))
-        c_settings['ipv4']['addresses'] = dbus.Array([addr], signature=dbus.Signature('au'))
 
     # Save all the updated settings back to NetworkManager
     c_obj.Update(c_settings)

examples/python/gi/add_connection.py

@@ -48,10 +48,10 @@ def create_profile(name):
     s_wired = NM.SettingWired.new()
 
     s_ip4 = NM.SettingIP4Config.new()
-    s_ip4.set_property(NM.SETTING_IP4_CONFIG_METHOD, "auto")
+    s_ip4.set_property(NM.SETTING_IP_CONFIG_METHOD, "auto")
 
     s_ip6 = NM.SettingIP6Config.new()
-    s_ip6.set_property(NM.SETTING_IP6_CONFIG_METHOD, "auto")
+    s_ip6.set_property(NM.SETTING_IP_CONFIG_METHOD, "auto")
 
     profile.add_setting(s_con)
     profile.add_setting(s_ip4)
@@ -64,11 +64,12 @@ def create_profile(name):
     return profile
 
 # callback function
-def added_cb(settings, con, error, data):
+def added_cb(client, result, data):
-    if error is (None):
+    try:
+        client.add_connection_finish(result)
         print("The connection profile has been succesfully added to NetworkManager.")
-    else:
+    except Exception, e:
-        print(error)
+        print("Error: %s" % e)
     main_loop.quit()
 
 if __name__ == "__main__":
@@ -85,17 +86,14 @@ if __name__ == "__main__":
 
     main_loop = GLib.MainLoop()
 
-    # create RemoteSettings object
+    # create Client object
-    settings = NM.RemoteSettings.new(None)
+    client = NM.Client.new(None)
 
     # create a connection profile for NM
     con = create_profile(profile_name)
 
     # send the connection to NM
-    if persistent:
+    client.add_connection_async(con, persistent, None, added_cb, None)
-        settings.add_connection(con, added_cb, None)
-    else:
-        settings.add_connection_unsaved(con, added_cb, None)
 
     main_loop.run()
 

examples/python/gi/firewall-zone.py

@@ -48,8 +48,8 @@ if __name__ == "__main__":
         sys.exit('Usage: %s <connection name or UUID> [new zone]' % sys.argv[0])
 
     main_loop = GLib.MainLoop()
-    settings = NM.RemoteSettings.new(None)
+    client = NM.Client.new(None)
-    connections = settings.list_connections()
+    connections = client.get_connections()
 
     con_name = sys.argv[1]
     if len(sys.argv) == 3:

examples/python/gi/get_ips.py

@@ -20,7 +20,7 @@
 # Copyright 2014 Red Hat, Inc.
 #
 
-import sys, socket, struct
+import sys, socket
 from gi.repository import GLib, NM
 
 #
@@ -28,11 +28,11 @@ from gi.repository import GLib, NM
 #  from NMIP4Config and NMIP6Config (got out of NMDevice)
 #
 
-def show_addresses(self, family):
+def show_addresses(dev, family):
     if (family == socket.AF_INET):
-       ip_cfg = self.get_ip4_config()
+       ip_cfg = dev.get_ip4_config()
     else:
-       ip_cfg = self.get_ip6_config()
+       ip_cfg = dev.get_ip6_config()
 
     if ip_cfg is None:
         print("None")
@@ -46,24 +46,29 @@ def show_addresses(self, family):
     for nm_address in nm_addresses:
         addr = nm_address.get_address()
         prefix = nm_address.get_prefix()
-        gateway = nm_address.get_gateway()
 
-        if (family == socket.AF_INET):
+        print("%s/%d") % (addr, prefix)
-            addr_struct = struct.pack("=I", addr)
-            gateway_struct = struct.pack("=I", gateway)
-        else:
-            addr_struct = addr
-            gateway_struct = gateway
-        print("%s/%d  %s") % (socket.inet_ntop(family, addr_struct),
-                              prefix,
-                              socket.inet_ntop(family, gateway_struct))
 
-
+def show_gateway(dev, family):
-def show_routes(self, family):
     if (family == socket.AF_INET):
-       ip_cfg = self.get_ip4_config()
+        ip_cfg = dev.get_ip4_config()
     else:
-       ip_cfg = self.get_ip6_config()
+        ip_cfg = dev.get_ip6_config()
+
+    if ip_cfg is None:
+        gw = "None"
+    else:
+        gw = ip_cfg.get_gateway()
+        if gw == '':
+            gw = "None"
+
+    print(gw)
+
+def show_routes(dev, family):
+    if (family == socket.AF_INET):
+       ip_cfg = dev.get_ip4_config()
+    else:
+       ip_cfg = dev.get_ip6_config()
 
     if ip_cfg is None:
         print("None")
@@ -80,23 +85,14 @@ def show_routes(self, family):
         next_hop = nm_route.get_next_hop()
         metric = nm_route.get_metric()
 
-        if (family == socket.AF_INET):
+        print("%s/%d  %s  %d") % (dest, prefix, next_hop, metric)
-            dest_struct = struct.pack("=I", dest)
-            next_hop_struct = struct.pack("=I", next_hop)
-        else:
-            dest_struct = dest
-            next_hop_struct = next_hop
-        print("%s/%d  %s  %d") % (socket.inet_ntop(family, dest_struct),
-                                  prefix,
-                                  socket.inet_ntop(family, next_hop_struct),
-                                  metric)
 
 
-def show_dns(self, family):
+def show_dns(dev, family):
     if (family == socket.AF_INET):
-       ip_cfg = self.get_ip4_config()
+       ip_cfg = dev.get_ip4_config()
     else:
-       ip_cfg = self.get_ip6_config()
+       ip_cfg = dev.get_ip6_config()
 
     if ip_cfg is None:
         print("None")
@@ -126,6 +122,11 @@ if __name__ == "__main__":
     show_addresses(dev, socket.AF_INET)
     print
 
+    print("IPv4 gateway:")
+    print("-------------")
+    show_gateway(dev, socket.AF_INET)
+    print
+
     print("IPv4 routes:")
     print("------------")
     show_routes(dev, socket.AF_INET)
@@ -136,6 +137,11 @@ if __name__ == "__main__":
     show_addresses(dev, socket.AF_INET6)
     print
 
+    print("IPv6 gateway:")
+    print("-------------")
+    show_gateway(dev, socket.AF_INET6)
+    print
+
     print "IPv6 routes:"
     print("------------")
     show_routes(dev, socket.AF_INET6)

examples/python/gi/list-connections.py

@@ -23,21 +23,16 @@
 from gi.repository import NM
 
 # This example asks settings service for all configured connections.
-# Unfortunately, at this time since libnm still makes heavy use of
-# GValue and GHashTable (rather than GVariant), libnm isn't fully
-# usable from GObject Introspection-ready languages. Most functions will
-# work fine, but e.g. nm_connection_to_dbus() causes failures.
-
 
 def print_values(setting, key, value, flags, data):
     print "  %s.%s: %s" % (setting.get_name(), key, value)
 
 if __name__ == "__main__":
-    # create RemoteSettings object
+    # create Client object
-    settings = NM.RemoteSettings.new(None)
+    client = NM.Client.new(None)
 
     # get all connections
-    connections = settings.list_connections()
+    connections = client.get_connections()
 
     # print the connections' details
     for c in connections:

examples/python/gi/show-wifi-networks.py

@@ -20,6 +20,7 @@
 # Copyright (C) 2013 Red Hat, Inc.
 #
 
+import locale
 from gi.repository import NM
 
 #
@@ -31,22 +32,20 @@ from gi.repository import NM
 # an error without it: http://www.python.org/dev/peps/pep-0263/
 #
 
-signal_bars = {
-    0 : "____",
-    1 : "▂___",
-    2 : "▂▄__",
-    3 : "▂▄▆_",
-    4 : "▂▄▆█"
-}
-
 def clamp(value, minvalue, maxvalue):
     return max(minvalue, min(value, maxvalue))
 
+def ssid_to_utf8(ap):
+    ssid = ap.get_ssid()
+    if not ssid:
+        return ""
+    return NM.utils_ssid_to_utf8(ap.get_ssid().get_data())
+
 def print_device_info(device):
     active_ap = dev.get_active_access_point()
     ssid = None
     if active_ap is not None:
-        ssid = active_ap.get_ssid()
+        ssid = ssid_to_utf8(active_ap)
     info = "Device: %s | Driver: %s | Active AP: %s" % (dev.get_iface(), dev.get_driver(), ssid)
     print info
     print '=' * len(info)
@@ -54,14 +53,19 @@ def print_device_info(device):
 def print_ap_info(ap):
     strength = ap.get_strength()
     frequency = ap.get_frequency()
-    print "SSID:      %s"      % (ap.get_ssid())
+    print "SSID:      %s"      % (ssid_to_utf8(ap))
     print "BSSID:     %s"      % (ap.get_bssid())
     print "Frequency: %s"      % (frequency)
     print "Channel:   %s"      % (NM.utils_wifi_freq_to_channel(frequency))
-    print "Strength:  %s %s%%" % (signal_bars[(clamp(strength-5, 0, 99)+24)/25], strength)
+    print "Strength:  %s %s%%" % (NM.utils_wifi_strength_bars(strength), strength)
     print
 
 if __name__ == "__main__":
+    # Python apparently doesn't call setlocale() on its own? We have to call this or else
+    # NM.utils_wifi_strength_bars() will think the locale is ASCII-only, and return the
+    # fallback characters rather than the unicode bars
+    locale.setlocale(locale.LC_ALL, '')
+
     nmc = NM.Client.new(None)
     devs = nmc.get_devices()
 

examples/python/gi/update-ip4-method.py

@@ -24,22 +24,11 @@
 # using the libnm GObject-based convenience APIs.
 #
 # Configuration settings are described at
-# https://developer.gnome.org/NetworkManager/0.9/ref-settings.html
+# https://developer.gnome.org/NetworkManager/1.0/ref-settings.html
 #
 
 from gi.repository import GLib, NM
-import sys, struct, socket
+import sys, socket
-
-def ip_to_int(ip_string):
-    return struct.unpack("=I", socket.inet_aton(ip_string))[0]
-
-# callback function
-def commit_cb(connection, error, data):
-    if error is (None):
-        print("The connection profile has been updated.")
-    else:
-        print(error)
-    main_loop.quit()
 
 if __name__ == "__main__":
     # parse and validate arguments
@@ -48,7 +37,7 @@ if __name__ == "__main__":
         sys.exit(1)
 
     method = sys.argv[2]
-    if method == "static" or method == "manual" and len(sys.argv) < 5:
+    if (method == "static" or method == "manual") and len(sys.argv) < 5:
         print "Usage: %s %s static address prefix [gateway]" % (sys.argv[0], sys.argv[1])
         sys.exit(1)
 
@@ -60,10 +49,10 @@ if __name__ == "__main__":
 
     main_loop = GLib.MainLoop()
 
-    # create RemoteSettings object
+    # create Client object
-    settings = NM.RemoteSettings.new(None)
+    client = NM.Client.new(None)
 
-    all_connections = settings.list_connections()
+    all_connections = client.get_connections()
     for c in all_connections:
         if c.get_uuid() != uuid:
             continue
@@ -75,21 +64,22 @@ if __name__ == "__main__":
             c.add_setting(s_ip4)
 
         # set the method and change properties
-        s_ip4.set_property(NM.SETTING_IP4_CONFIG_METHOD, method)
+        s_ip4.set_property(NM.SETTING_IP_CONFIG_METHOD, method)
         if method == "auto":
-            # remove addresses
+            # remove addresses and gateway
             s_ip4.clear_addresses()
+            s_ip4.props.gateway = None
         elif method == "manual":
             # Add the static IP address, prefix, and (optional) gateway
-            addr = NM.IP4Address.new()
+            addr = NM.IPAddress.new(socket.AF_INET, sys.argv[3], int(sys.argv[4]))
-            addr.set_address(ip_to_int(sys.argv[3]))
-            addr.set_prefix(int(sys.argv[4]))
-            if len(sys.argv) == 6:
-                addr.set_gateway(ip_to_int(sys.argv[5]))
             s_ip4.add_address(addr)
+            if len(sys.argv) == 6:
+                s_ip4.props.gateway = sys.argv[5]
 
-        c.commit_changes(commit_cb, None)
+        try:
-
+            c.commit_changes(True, None)
-    # run main loop
+            print("The connection profile has been updated.")
-    main_loop.run()
+        except Exception, e:
+            print("Error: %s" % e)
+        break
 

examples/ruby/add-connection.rb

@@ -27,8 +27,13 @@ require 'ipaddr'
 # It also shows how to specify D-Bus signature for properties like "addresses"
 # and "clone-mac-address".
 #
+# This uses the old, backwards-compatible settings properties. The new 1.0
+# properties (eg, 'address-data' rather than 'addresses') would make this simpler;
+# see the python add-connection.py and add-connection-compat.py examples for
+# details
+#
 # Configuration settings are described here:
-# https://developer.gnome.org/NetworkManager/0.9/ref-settings.html
+# https://developer.gnome.org/NetworkManager/1.0/ref-settings.html
 #
 
 # Helper functions