Implemented Option to choose default network interface

bundles/config/org.eclipse.smarthome.config.core/META-INF/MANIFEST.MF

@@ -4,12 +4,13 @@ Bundle-Name: Eclipse SmartHome Config Core
 Bundle-SymbolicName: org.eclipse.smarthome.config.core
 Bundle-Version: 0.9.0.qualifier
 Bundle-Vendor: Eclipse.org/SmartHome
-Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Import-Package: com.google.common.base,
  com.google.common.collect,
  com.google.gson,
  org.apache.commons.lang.reflect,
  org.eclipse.jdt.annotation;resolution:=optional,
+ org.apache.commons.net.util,
  org.eclipse.smarthome.config.core,
  org.eclipse.smarthome.config.core.dto,
  org.eclipse.smarthome.config.core.i18n,

bundles/config/org.eclipse.smarthome.config.core/OSGI-INF/.gitignore

@@ -1 +1,2 @@
 /org.eclipse.smarthome.config.core.internal.i18n.I18nConfigOptionsProvider.xml
+/org.eclipse.smarthome.config.core.net.internal.NetworkConfigOptionProvider.xml

bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/net/internal/NetworkConfigOptionProvider.java

@@ -0,0 +1,99 @@
+/**
+ * Copyright (c) 2014-2017 by the respective copyright holders.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.smarthome.config.core.net.internal;
+
+import java.net.Inet6Address;
+import java.net.InetAddress;
+import java.net.InterfaceAddress;
+import java.net.NetworkInterface;
+import java.net.SocketException;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Enumeration;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Locale;
+
+import org.apache.commons.net.util.SubnetUtils;
+import org.eclipse.smarthome.config.core.ConfigOptionProvider;
+import org.eclipse.smarthome.config.core.ParameterOption;
+import org.osgi.service.component.annotations.Component;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Provides a list of IPv4 addresses of the local machine and shows the user which interface belongs to which IP address
+ *
+ * @author Stefan Triller - initial contribution
+ *
+ */
+@Component
+public class NetworkConfigOptionProvider implements ConfigOptionProvider {
+
+    static final URI CONFIG_URI = URI.create("system:network");
+    static final String PARAM_PRIMARY_ADDRESS = "primaryAddress";
+
+    private final Logger logger = LoggerFactory.getLogger(NetworkConfigOptionProvider.class);
+
+    @Override
+    public Collection<ParameterOption> getParameterOptions(URI uri, String param, Locale locale) {
+        if (!uri.equals(CONFIG_URI)) {
+            return null;
+        }
+
+        if (param.equals(PARAM_PRIMARY_ADDRESS)) {
+            return getIPv4Addresses();
+        }
+        return null;
+    }
+
+    private List<ParameterOption> getIPv4Addresses() {
+        ArrayList<ParameterOption> interfaceOptions = new ArrayList<>();
+
+        HashSet<String> subnets = new HashSet<>();
+
+        try {
+            final Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
+            while (interfaces.hasMoreElements()) {
+                final NetworkInterface current = interfaces.nextElement();
+                if (!current.isUp() || current.isLoopback() || current.isVirtual()) {
+                    continue;
+                }
+
+                for (InterfaceAddress ifAddr : current.getInterfaceAddresses()) {
+                    InetAddress addr = ifAddr.getAddress();
+
+                    if (addr.isLoopbackAddress() || (addr instanceof Inet6Address)) {
+                        continue;
+                    }
+
+                    String ipv4Address = addr.getHostAddress();
+
+                    SubnetUtils su = new SubnetUtils(
+                            ipv4Address + "/" + String.valueOf(ifAddr.getNetworkPrefixLength()));
+                    String subNetString = su.getInfo().getNetworkAddress() + "/"
+                            + String.valueOf(ifAddr.getNetworkPrefixLength());
+
+                    subnets.add(subNetString);
+                }
+            }
+        } catch (SocketException ex) {
+            logger.error("Could not retrieve network interface: {}", ex.getMessage(), ex);
+            return null;
+        }
+
+        for (String subnet : subnets) {
+            ParameterOption po = new ParameterOption(subnet, subnet);
+            interfaceOptions.add(po);
+        }
+
+        return interfaceOptions;
+    }
+
+}

bundles/core/org.eclipse.smarthome.core/ESH-INF/config/networkinterface.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<config-description:config-descriptions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:config-description="http://eclipse.org/smarthome/schemas/config-description/v1.0.0"
+	xsi:schemaLocation="http://eclipse.org/smarthome/schemas/config-description/v1.0.0
+        http://eclipse.org/smarthome/schemas/config-description-1.0.0.xsd">
+
+	<config-description uri="system:network">
+		<parameter name="primaryAddress" type="text">
+			<label>Primary Address</label>
+			<description><![CDATA[<p>The primary network to be used</p>
+			<p>Alternative: Enter an IP address (XXX.XXX.XXX.XXX) manually</p>]]></description>
+			<limitToOptions>false</limitToOptions>
+		</parameter>
+	</config-description>
+
+</config-description:config-descriptions>

bundles/core/org.eclipse.smarthome.core/META-INF/MANIFEST.MF

@@ -28,7 +28,7 @@ Ignore-Package: org.eclipse.smarthome.core.internal.items,org.eclipse.smarthome.
  nal,org.eclipse.smarthome.core.internal.events,org.eclipse.smarthome.core.internal.loggin
  g
 Bundle-Name: Eclipse SmartHome Core
-Bundle-RequiredExecutionEnvironment: JavaSE-1.8
+Bundle-RequiredExecutionEnvironment: JavaSE-1.8
 Bundle-Vendor: Eclipse.org/SmartHome
 Bundle-Version: 0.9.0.qualifier
 Bundle-ManifestVersion: 2
@@ -39,6 +39,7 @@ Import-Package: com.google.common.base,
  org.apache.commons.io,
  org.apache.commons.lang,
  org.eclipse.jdt.annotation;resolution:=optional,
+ org.apache.commons.net.util,
  org.eclipse.smarthome.core.auth,
  org.eclipse.smarthome.core.binding,
  org.eclipse.smarthome.core.binding.dto,

bundles/core/org.eclipse.smarthome.core/OSGI-INF/.gitignore

@@ -0,0 +1 @@
+/org.eclipse.smarthome.network.xml

bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/net/NetUtil.java

@@ -13,10 +13,16 @@
 import java.net.InterfaceAddress;
 import java.net.NetworkInterface;
 import java.net.SocketException;
+import java.util.Dictionary;
 import java.util.Enumeration;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 
+import org.apache.commons.net.util.SubnetUtils;
+import org.osgi.service.component.ComponentContext;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Modified;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -25,12 +31,51 @@
  *
  * @author Markus Rathgeb - Initial contribution and API
  * @author Mark Herwege - Added methods to find broadcast address(es)
+ * @author Stefan Triller - Converted to OSGi service with primary ipv4 conf
  */
-public class NetUtil {
+@Component(name = "org.eclipse.smarthome.network", property = { "service.config.description.uri=system:network",
+        "service.config.label=Network Settings", "service.config.category=system" })
+public class NetUtil implements NetworkAddressProvider {
 
+    private static final String PRIMARY_ADDRESS = "primaryAddress";
     private static final Logger LOGGER = LoggerFactory.getLogger(NetUtil.class);
 
-    private NetUtil() {
+    private String primaryAddress;
+
+    @SuppressWarnings("unchecked")
+    protected void activate(ComponentContext componentContext) {
+        Dictionary<String, Object> props = componentContext.getProperties();
+        modified((Map<String, Object>) props);
+    }
+
+    @Modified
+    public synchronized void modified(Map<String, Object> config) {
+        String defaultInterfaceConfig = (String) config.get(PRIMARY_ADDRESS);
+        if (defaultInterfaceConfig == null || defaultInterfaceConfig.equals("")) {
+            // if none is specified we return the default one for backward compatibility
+            primaryAddress = NetUtil.getLocalIpv4HostAddress();
+        } else {
+            String primaryAddressConf = (String) config.get(PRIMARY_ADDRESS);
+
+            String[] addrString = primaryAddressConf.split("/");
+            if (addrString.length > 1) {
+                String ip = getIPv4inSubnet(primaryAddressConf);
+                if (ip == null) {
+                    // an error has occurred, used first interface like nothing has been configured
+                    LOGGER.warn("Error in IP configuration, will continue to use first interface");
+                    NetUtil.getLocalIpv4HostAddress();
+                } else {
+                    primaryAddress = ip;
+                }
+            } else {
+                primaryAddress = addrString[0];
+            }
+        }
+    }
+
+    @Override
+    public String getPrimaryIpv4HostAddress() {
+        return primaryAddress;
     }
 
     /**
@@ -104,4 +149,40 @@ public static String getBroadcastAddress() {
         }
     }
 
+    private String getIPv4inSubnet(String subnet) {
+        try {
+            final Enumeration<NetworkInterface> interfaces = NetworkInterface.getNetworkInterfaces();
+            while (interfaces.hasMoreElements()) {
+                final NetworkInterface current = interfaces.nextElement();
+                if (!current.isUp() || current.isLoopback() || current.isVirtual()) {
+                    continue;
+                }
+
+                for (InterfaceAddress ifAddr : current.getInterfaceAddresses()) {
+                    InetAddress addr = ifAddr.getAddress();
+
+                    if (addr.isLoopbackAddress() || (addr instanceof Inet6Address)) {
+                        continue;
+                    }
+
+                    String ipv4Address = addr.getHostAddress();
+
+                    SubnetUtils su = new SubnetUtils(
+                            ipv4Address + "/" + String.valueOf(ifAddr.getNetworkPrefixLength()));
+                    String subNetString = su.getInfo().getNetworkAddress() + "/"
+                            + String.valueOf(ifAddr.getNetworkPrefixLength());
+
+                    // use first IP within this subnet
+                    if (subNetString.equals(subnet)) {
+                        return ipv4Address;
+                    }
+                }
+            }
+        } catch (SocketException ex) {
+            LOGGER.error("Could not retrieve network interface: {}", ex.getMessage(), ex);
+            return null;
+        }
+        return null;
+    }
+
 }

bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/net/NetworkAddressProvider.java

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2014-2017 by the respective copyright holders.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.smarthome.core.net;
+
+/**
+ * Interface that provides access to configured network addresses
+ *
+ * @author Stefan Triller - initial contribution
+ *
+ */
+public interface NetworkAddressProvider {
+
+    public String getPrimaryIpv4HostAddress();
+}

docs/documentation/development/bindings/thing-handler.md

@@ -180,6 +180,27 @@ Furthermore bindings can specify a localized description of the thing status by
 rate_limit=Device is blocked by remote service for {0} minutes. Maximum limit of {1} configuration changes per {2} has been exceeded. For further info please refer to device vendor.
 ```
 
+## Offering a callback URL
+
+Some things might require a `callback` URL which should be bound to a certain network interface. A user can configure his default network address via Paper UI under `Configuration -> System -> Network Settings`. To obtain this configured address the `ThingHandlerFactory` needs a `service reference` to the `NetworkInterfaceService` in its `OSGI-INF/MyHandlerFactory.xml`:
+
+```
+<reference bind="setNetworkAddressprovider" cardinality="1..1" interface="org.eclipse.smarthome.core.net.NetworkAddressProvider" name="NetworkAddressprovider" policy="static" unbind="unsetNetworkAddressprovider"/>
+```
+
+Inside `MyHandlerFactory.java` two methods are required:
+
+```java
+protected void setNetworkAddressprovider(NetworkAddressprovider networkAddressprovider) {
+	this.networkAddressprovider = networkInterfaceService;
+	}
+protected void unsetNetworkAddressprovider(NetworkAddressprovider networkAddressprovider) {
+	this.networkAddressprovider = null;
+}
+```
+
+Now the `MyHandlerFactory` can obtain the configured IP address via `networkAddressprovider.getPrimaryIpv4HostAddress()`. This IP address can be used in callback URL offered to a device.
+
 ## Channel Links
 
 Some bindings might want to start specific functionality for a channel only if an item is linked to the channel. The `ThingHandler` has two callback methods `channelLinked(ChannelUID channelUID)` and `channelUnlinked(ChannelUID channelUID)`, which are called for every link that is added or removed to/from a channel. So please be aware of the fact that both methods can be called multiple times.

extensions/binding/org.eclipse.smarthome.binding.sonos/OSGI-INF/SonosHandlerFactory.xml

@@ -18,4 +18,5 @@
       <provide interface="org.eclipse.smarthome.core.thing.binding.ThingHandlerFactory"/>
    </service>
    <reference bind="setAudioHTTPServer" cardinality="1..1" interface="org.eclipse.smarthome.core.audio.AudioHTTPServer" name="AudioHTTPServer" policy="static" unbind="unsetAudioHTTPServer"/>
+   <reference bind="setNetworkAddressProvider" cardinality="1..1" interface="org.eclipse.smarthome.core.net.NetworkAddressProvider" name="NetworkAddressProvider" policy="static" unbind="unsetNetworkAddressProvider"/>
 </scr:component>

extensions/binding/org.eclipse.smarthome.binding.sonos/src/main/java/org/eclipse/smarthome/binding/sonos/internal/SonosHandlerFactory.java

@@ -21,7 +21,7 @@
 import org.eclipse.smarthome.core.audio.AudioHTTPServer;
 import org.eclipse.smarthome.core.audio.AudioSink;
 import org.eclipse.smarthome.core.net.HttpServiceUtil;
-import org.eclipse.smarthome.core.net.NetUtil;
+import org.eclipse.smarthome.core.net.NetworkAddressProvider;
 import org.eclipse.smarthome.core.thing.Thing;
 import org.eclipse.smarthome.core.thing.ThingTypeUID;
 import org.eclipse.smarthome.core.thing.ThingUID;
@@ -46,6 +46,7 @@ public class SonosHandlerFactory extends BaseThingHandlerFactory {
     private UpnpIOService upnpIOService;
     private DiscoveryServiceRegistry discoveryServiceRegistry;
     private AudioHTTPServer audioHTTPServer;
+    private NetworkAddressProvider networkAddressprovider;
 
     private Map<String, ServiceRegistration<AudioSink>> audioSinkRegistrations = new ConcurrentHashMap<>();
 
@@ -110,7 +111,7 @@ private String createCallbackUrl() {
         if (callbackUrl != null) {
             return callbackUrl;
         } else {
-            final String ipAddress = NetUtil.getLocalIpv4HostAddress();
+            final String ipAddress = networkAddressprovider.getPrimaryIpv4HostAddress();
             if (ipAddress == null) {
                 logger.warn("No network interface could be found.");
                 return null;
@@ -171,4 +172,12 @@ protected void unsetAudioHTTPServer(AudioHTTPServer audioHTTPServer) {
         this.audioHTTPServer = null;
     }
 
+    protected void setNetworkAddressProvider(NetworkAddressProvider networkUtil) {
+        this.networkAddressprovider = networkUtil;
+    }
+
+    protected void unsetNetworkAddressProvider(NetworkAddressProvider networkUtil) {
+        this.networkAddressprovider = null;
+    }
+
 }