git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2020 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.upnpcontrol.internal;
  14
  15 import static org.openhab.binding.upnpcontrol.internal.UpnpControlBindingConstants.*;
  16
  17 import java.util.Hashtable;
  18 import java.util.concurrent.ConcurrentHashMap;
  19 import java.util.concurrent.ConcurrentMap;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.openhab.binding.upnpcontrol.internal.handler.UpnpRendererHandler;
  24 import org.openhab.binding.upnpcontrol.internal.handler.UpnpServerHandler;
  25 import org.openhab.core.audio.AudioHTTPServer;
  26 import org.openhab.core.audio.AudioSink;
  27 import org.openhab.core.io.transport.upnp.UpnpIOService;
  28 import org.openhab.core.net.HttpServiceUtil;
  29 import org.openhab.core.net.NetworkAddressService;
  30 import org.openhab.core.thing.Thing;
  31 import org.openhab.core.thing.ThingTypeUID;
  32 import org.openhab.core.thing.binding.BaseThingHandlerFactory;
  33 import org.openhab.core.thing.binding.ThingHandler;
  34 import org.openhab.core.thing.binding.ThingHandlerFactory;
  35 import org.osgi.framework.ServiceRegistration;
  36 import org.osgi.service.component.annotations.Activate;
  37 import org.osgi.service.component.annotations.Component;
  38 import org.osgi.service.component.annotations.Reference;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * The {@link UpnpControlHandlerFactory} is responsible for creating things and thing
  44  * handlers.
  45  *
  46  * @author Mark Herwege - Initial contribution
  47  */
  48 @Component(service = ThingHandlerFactory.class, configurationPid = "binding.upnpcontrol")
  49 @NonNullByDefault
  50 public class UpnpControlHandlerFactory extends BaseThingHandlerFactory implements UpnpAudioSinkReg {
  51
  52     private final Logger logger = LoggerFactory.getLogger(getClass());
  53
  54     private ConcurrentMap<String, ServiceRegistration<AudioSink>> audioSinkRegistrations = new ConcurrentHashMap<>();
  55     private ConcurrentMap<String, UpnpRendererHandler> upnpRenderers = new ConcurrentHashMap<>();
  56     private ConcurrentMap<String, UpnpServerHandler> upnpServers = new ConcurrentHashMap<>();
  57
  58     private final UpnpIOService upnpIOService;
  59     private final AudioHTTPServer audioHTTPServer;
  60     private final NetworkAddressService networkAddressService;
  61     private final UpnpDynamicStateDescriptionProvider upnpStateDescriptionProvider;
  62     private final UpnpDynamicCommandDescriptionProvider upnpCommandDescriptionProvider;
  63
  64     private String callbackUrl = "";
  65
  66     @Activate
  67     public UpnpControlHandlerFactory(final @Reference UpnpIOService upnpIOService,
  68             final @Reference AudioHTTPServer audioHTTPServer,
  69             final @Reference NetworkAddressService networkAddressService,
  70             final @Reference UpnpDynamicStateDescriptionProvider dynamicStateDescriptionProvider,
  71             final @Reference UpnpDynamicCommandDescriptionProvider dynamicCommandDescriptionProvider) {
  72         this.upnpIOService = upnpIOService;
  73         this.audioHTTPServer = audioHTTPServer;
  74         this.networkAddressService = networkAddressService;
  75         this.upnpStateDescriptionProvider = dynamicStateDescriptionProvider;
  76         this.upnpCommandDescriptionProvider = dynamicCommandDescriptionProvider;
  77     }
  78
  79     @Override
  80     public boolean supportsThingType(ThingTypeUID thingTypeUID) {
  81         return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
  82     }
  83
  84     @Override
  85     protected @Nullable ThingHandler createHandler(Thing thing) {
  86         ThingTypeUID thingTypeUID = thing.getThingTypeUID();
  87
  88         if (thingTypeUID.equals(THING_TYPE_RENDERER)) {
  89             return addRenderer(thing);
  90         } else if (thingTypeUID.equals(THING_TYPE_SERVER)) {
  91             return addServer(thing);
  92         }
  93         return null;
  94     }
  95
  96     @Override
  97     public void unregisterHandler(Thing thing) {
  98         ThingTypeUID thingTypeUID = thing.getThingTypeUID();
  99         String key = thing.getUID().toString();
 100
 101         if (thingTypeUID.equals(THING_TYPE_RENDERER)) {
 102             removeRenderer(key);
 103         } else if (thingTypeUID.equals(THING_TYPE_SERVER)) {
 104             removeServer(key);
 105         }
 106         super.unregisterHandler(thing);
 107     }
 108
 109     private UpnpServerHandler addServer(Thing thing) {
 110         UpnpServerHandler handler = new UpnpServerHandler(thing, upnpIOService, upnpRenderers,
 111                 upnpStateDescriptionProvider, upnpCommandDescriptionProvider);
 112         String key = thing.getUID().toString();
 113         upnpServers.put(key, handler);
 114         logger.debug("Media server handler created for {}", thing.getLabel());
 115         return handler;
 116     }
 117
 118     private UpnpRendererHandler addRenderer(Thing thing) {
 119         callbackUrl = createCallbackUrl();
 120         UpnpRendererHandler handler = new UpnpRendererHandler(thing, upnpIOService, this);
 121         String key = thing.getUID().toString();
 122         upnpRenderers.put(key, handler);
 123         upnpServers.forEach((thingId, value) -> value.addRendererOption(key));
 124         logger.debug("Media renderer handler created for {}", thing.getLabel());
 125
 126         return handler;
 127     }
 128
 129     private void removeServer(String key) {
 130         logger.debug("Removing media server handler for {}", upnpServers.get(key).getThing().getLabel());
 131         upnpServers.remove(key);
 132     }
 133
 134     private void removeRenderer(String key) {
 135         logger.debug("Removing media renderer handler for {}", upnpRenderers.get(key).getThing().getLabel());
 136         if (audioSinkRegistrations.containsKey(key)) {
 137             logger.debug("Removing audio sink registration for {}", upnpRenderers.get(key).getThing().getLabel());
 138             ServiceRegistration<AudioSink> reg = audioSinkRegistrations.get(key);
 139             reg.unregister();
 140             audioSinkRegistrations.remove(key);
 141         }
 142         upnpServers.forEach((thingId, value) -> value.removeRendererOption(key));
 143         upnpRenderers.remove(key);
 144     }
 145
 146     @Override
 147     public void registerAudioSink(UpnpRendererHandler handler) {
 148         if (!(callbackUrl.isEmpty())) {
 149             UpnpAudioSink audioSink = new UpnpAudioSink(handler, audioHTTPServer, callbackUrl);
 150             @SuppressWarnings("unchecked")
 151             ServiceRegistration<AudioSink> reg = (ServiceRegistration<AudioSink>) bundleContext
 152                     .registerService(AudioSink.class.getName(), audioSink, new Hashtable<String, Object>());
 153             Thing thing = handler.getThing();
 154             audioSinkRegistrations.put(thing.getUID().toString(), reg);
 155             logger.debug("Audio sink added for media renderer {}", thing.getLabel());
 156         }
 157     }
 158
 159     private String createCallbackUrl() {
 160         if (!callbackUrl.isEmpty()) {
 161             return callbackUrl;
 162         }
 163         NetworkAddressService nwaService = networkAddressService;
 164         String ipAddress = nwaService.getPrimaryIpv4HostAddress();
 165         if (ipAddress == null) {
 166             logger.warn("No network interface could be found.");
 167             return "";
 168         }
 169         int port = HttpServiceUtil.getHttpServicePort(bundleContext);
 170         if (port == -1) {
 171             logger.warn("Cannot find port of the http service.");
 172             return "";
 173         }
 174         return "http://" + ipAddress + ":" + port;
 175     }
 176 }