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

   1 /**
   2  * Copyright (c) 2010-2023 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.kodi.internal;
  14
  15 import static org.openhab.binding.kodi.internal.KodiBindingConstants.*;
  16
  17 import java.util.Dictionary;
  18 import java.util.Hashtable;
  19 import java.util.Map;
  20 import java.util.concurrent.ConcurrentHashMap;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.eclipse.jetty.websocket.client.WebSocketClient;
  25 import org.openhab.binding.kodi.internal.handler.KodiHandler;
  26 import org.openhab.core.audio.AudioHTTPServer;
  27 import org.openhab.core.audio.AudioSink;
  28 import org.openhab.core.io.net.http.WebSocketFactory;
  29 import org.openhab.core.net.HttpServiceUtil;
  30 import org.openhab.core.net.NetworkAddressService;
  31 import org.openhab.core.thing.Thing;
  32 import org.openhab.core.thing.ThingTypeUID;
  33 import org.openhab.core.thing.binding.BaseThingHandlerFactory;
  34 import org.openhab.core.thing.binding.ThingHandler;
  35 import org.openhab.core.thing.binding.ThingHandlerFactory;
  36 import org.osgi.framework.ServiceRegistration;
  37 import org.osgi.service.component.ComponentContext;
  38 import org.osgi.service.component.annotations.Activate;
  39 import org.osgi.service.component.annotations.Component;
  40 import org.osgi.service.component.annotations.Reference;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * The {@link KodiHandlerFactory} is responsible for creating things and thing
  46  * handlers.
  47  *
  48  * @author Paul Frank - Initial contribution
  49  * @author Christoph Weitkamp - Improvements on channels for opening PVR TV or Radio streams
  50  */
  51 @NonNullByDefault
  52 @Component(service = ThingHandlerFactory.class, configurationPid = "binding.kodi")
  53 public class KodiHandlerFactory extends BaseThingHandlerFactory {
  54
  55     private final Logger logger = LoggerFactory.getLogger(KodiHandlerFactory.class);
  56
  57     private final AudioHTTPServer audioHTTPServer;
  58     private final NetworkAddressService networkAddressService;
  59     private final KodiDynamicCommandDescriptionProvider commandDescriptionProvider;
  60     private final KodiDynamicStateDescriptionProvider stateDescriptionProvider;
  61     private final WebSocketClient webSocketClient;
  62
  63     private final Map<String, ServiceRegistration<AudioSink>> audioSinkRegistrations = new ConcurrentHashMap<>();
  64
  65     // url (scheme+server+port) to use for playing notification sounds
  66     private @Nullable String callbackUrl;
  67
  68     @Activate
  69     public KodiHandlerFactory(final @Reference AudioHTTPServer audioHTTPServer,
  70             final @Reference NetworkAddressService networkAddressService,
  71             final @Reference KodiDynamicCommandDescriptionProvider commandDescriptionProvider,
  72             final @Reference KodiDynamicStateDescriptionProvider stateDescriptionProvider,
  73             final @Reference WebSocketFactory webSocketFactory) {
  74         this.audioHTTPServer = audioHTTPServer;
  75         this.networkAddressService = networkAddressService;
  76         this.commandDescriptionProvider = commandDescriptionProvider;
  77         this.stateDescriptionProvider = stateDescriptionProvider;
  78         this.webSocketClient = webSocketFactory.getCommonWebSocketClient();
  79     }
  80
  81     @Override
  82     protected void activate(ComponentContext componentContext) {
  83         super.activate(componentContext);
  84         Dictionary<String, Object> properties = componentContext.getProperties();
  85         callbackUrl = (String) properties.get("callbackUrl");
  86     }
  87
  88     @Override
  89     public boolean supportsThingType(ThingTypeUID thingTypeUID) {
  90         return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
  91     }
  92
  93     @Override
  94     protected @Nullable ThingHandler createHandler(Thing thing) {
  95         ThingTypeUID thingTypeUID = thing.getThingTypeUID();
  96
  97         if (thingTypeUID.equals(THING_TYPE_KODI)) {
  98             String callbackUrl = createCallbackUrl();
  99             KodiHandler handler = new KodiHandler(thing, commandDescriptionProvider, stateDescriptionProvider,
 100                     webSocketClient, callbackUrl);
 101
 102             // register the Kodi as an audio sink
 103             KodiAudioSink audioSink = new KodiAudioSink(handler, audioHTTPServer, callbackUrl);
 104             @SuppressWarnings("unchecked")
 105             ServiceRegistration<AudioSink> reg = (ServiceRegistration<AudioSink>) bundleContext
 106                     .registerService(AudioSink.class.getName(), audioSink, new Hashtable<>());
 107             audioSinkRegistrations.put(thing.getUID().toString(), reg);
 108
 109             return handler;
 110         }
 111
 112         return null;
 113     }
 114
 115     private @Nullable String createCallbackUrl() {
 116         if (callbackUrl != null) {
 117             return callbackUrl;
 118         } else {
 119             final String ipAddress = networkAddressService.getPrimaryIpv4HostAddress();
 120             if (ipAddress == null) {
 121                 logger.warn("No network interface could be found.");
 122                 return null;
 123             }
 124
 125             // we do not use SSL as it can cause certificate validation issues.
 126             final int port = HttpServiceUtil.getHttpServicePort(bundleContext);
 127             if (port == -1) {
 128                 logger.warn("Cannot find port of the http service.");
 129                 return null;
 130             }
 131
 132             return "http://" + ipAddress + ":" + port;
 133         }
 134     }
 135
 136     @Override
 137     public void unregisterHandler(Thing thing) {
 138         super.unregisterHandler(thing);
 139         ServiceRegistration<AudioSink> reg = audioSinkRegistrations.get(thing.getUID().toString());
 140         if (reg != null) {
 141             reg.unregister();
 142         }
 143     }
 144 }