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

   1 /**
   2  * Copyright (c) 2010-2024 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.freeboxos.internal.handler;
  14
  15 import java.math.BigDecimal;
  16 import java.time.ZonedDateTime;
  17 import java.util.HashMap;
  18 import java.util.Hashtable;
  19 import java.util.Map;
  20 import java.util.concurrent.ScheduledFuture;
  21 import java.util.concurrent.TimeUnit;
  22
  23 import javax.measure.Unit;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.openhab.binding.freeboxos.internal.api.FreeboxException;
  28 import org.openhab.binding.freeboxos.internal.api.rest.LanBrowserManager.Source;
  29 import org.openhab.binding.freeboxos.internal.api.rest.MediaReceiverManager;
  30 import org.openhab.binding.freeboxos.internal.api.rest.MediaReceiverManager.MediaType;
  31 import org.openhab.binding.freeboxos.internal.api.rest.MediaReceiverManager.Receiver;
  32 import org.openhab.binding.freeboxos.internal.api.rest.RestManager;
  33 import org.openhab.binding.freeboxos.internal.config.ApiConsumerConfiguration;
  34 import org.openhab.binding.freeboxos.internal.config.ClientConfiguration;
  35 import org.openhab.core.audio.AudioSink;
  36 import org.openhab.core.config.core.Configuration;
  37 import org.openhab.core.library.types.DateTimeType;
  38 import org.openhab.core.library.types.DecimalType;
  39 import org.openhab.core.library.types.OnOffType;
  40 import org.openhab.core.library.types.QuantityType;
  41 import org.openhab.core.library.types.StringType;
  42 import org.openhab.core.thing.Bridge;
  43 import org.openhab.core.thing.ChannelUID;
  44 import org.openhab.core.thing.Thing;
  45 import org.openhab.core.thing.ThingStatus;
  46 import org.openhab.core.thing.ThingStatusDetail;
  47 import org.openhab.core.thing.ThingStatusInfo;
  48 import org.openhab.core.thing.binding.BaseThingHandler;
  49 import org.openhab.core.thing.binding.BridgeHandler;
  50 import org.openhab.core.types.Command;
  51 import org.openhab.core.types.RefreshType;
  52 import org.openhab.core.types.State;
  53 import org.openhab.core.types.UnDefType;
  54 import org.osgi.framework.ServiceRegistration;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 import inet.ipaddr.IPAddress;
  59
  60 /**
  61  * The {@link ApiConsumerHandler} is a base abstract class for all devices made available by the FreeboxOs bridge
  62  *
  63  * @author Gaël L'hopital - Initial contribution
  64  */
  65 @NonNullByDefault
  66 public abstract class ApiConsumerHandler extends BaseThingHandler implements ApiConsumerIntf {
  67     private final Logger logger = LoggerFactory.getLogger(ApiConsumerHandler.class);
  68     private final Map<String, ScheduledFuture<?>> jobs = new HashMap<>();
  69
  70     private @Nullable ServiceRegistration<?> reg;
  71     protected boolean statusDrivenByBridge = true;
  72
  73     ApiConsumerHandler(Thing thing) {
  74         super(thing);
  75     }
  76
  77     @Override
  78     public void initialize() {
  79         FreeboxOsHandler bridgeHandler = checkBridgeHandler();
  80         if (bridgeHandler == null) {
  81             return;
  82         }
  83         initializeOnceBridgeOnline(bridgeHandler);
  84     }
  85
  86     private void initializeOnceBridgeOnline(FreeboxOsHandler bridgeHandler) {
  87         Map<String, String> properties = editProperties();
  88         if (properties.isEmpty()) {
  89             try {
  90                 initializeProperties(properties);
  91                 checkAirMediaCapabilities(properties);
  92                 updateProperties(properties);
  93             } catch (FreeboxException e) {
  94                 logger.warn("Error getting thing {} properties: {}", thing.getUID(), e.getMessage());
  95             }
  96         }
  97
  98         boolean isAudioReceiver = Boolean.parseBoolean(properties.get(MediaType.AUDIO.name()));
  99         if (isAudioReceiver) {
 100             configureMediaSink(bridgeHandler, properties.getOrDefault(Source.UPNP.name(), ""));
 101         }
 102
 103         startRefreshJob();
 104     }
 105
 106     private void configureMediaSink(FreeboxOsHandler bridgeHandler, String upnpName) {
 107         try {
 108             Receiver receiver = getManager(MediaReceiverManager.class).getReceiver(upnpName);
 109             if (receiver != null && reg == null) {
 110                 ApiConsumerConfiguration config = getConfig().as(ApiConsumerConfiguration.class);
 111                 String callbackURL = bridgeHandler.getCallbackURL();
 112                 if (!config.password.isEmpty() || !receiver.passwordProtected()) {
 113                     reg = bridgeHandler.getBundleContext().registerService(
 114                             AudioSink.class.getName(), new AirMediaSink(this, bridgeHandler.getAudioHTTPServer(),
 115                                     callbackURL, receiver.name(), config.password, config.acceptAllMp3),
 116                             new Hashtable<>());
 117                 } else {
 118                     logger.info("A password needs to be configured to enable Air Media capability.");
 119                 }
 120             }
 121         } catch (FreeboxException e) {
 122             logger.warn("Unable to retrieve Media Receivers: {}", e.getMessage());
 123         }
 124     }
 125
 126     public <T extends RestManager> T getManager(Class<T> clazz) throws FreeboxException {
 127         FreeboxOsHandler handler = checkBridgeHandler();
 128         if (handler != null) {
 129             return handler.getManager(clazz);
 130         }
 131         throw new FreeboxException("Bridge handler not yet defined");
 132     }
 133
 134     abstract void initializeProperties(Map<String, String> properties) throws FreeboxException;
 135
 136     @Override
 137     public void bridgeStatusChanged(ThingStatusInfo bridgeStatusInfo) {
 138         FreeboxOsHandler bridgeHandler = checkBridgeHandler();
 139         if (bridgeHandler != null) {
 140             initializeOnceBridgeOnline(bridgeHandler);
 141         } else {
 142             stopJobs();
 143         }
 144     }
 145
 146     @Override
 147     public void handleCommand(ChannelUID channelUID, Command command) {
 148         if (getThing().getStatus() != ThingStatus.ONLINE) {
 149             return;
 150         }
 151         try {
 152             if (checkBridgeHandler() != null) {
 153                 if (command instanceof RefreshType) {
 154                     internalPoll();
 155                 } else if (!internalHandleCommand(channelUID.getIdWithoutGroup(), command)) {
 156                     logger.debug("Unexpected command {} on channel {}", command, channelUID.getId());
 157                 }
 158             }
 159         } catch (FreeboxException e) {
 160             logger.warn("Error handling command: {}", e.getMessage());
 161         }
 162     }
 163
 164     private void checkAirMediaCapabilities(Map<String, String> properties) throws FreeboxException {
 165         String upnpName = properties.getOrDefault(Source.UPNP.name(), "");
 166         Receiver receiver = getManager(MediaReceiverManager.class).getReceiver(upnpName);
 167         if (receiver != null) {
 168             receiver.capabilities().entrySet()
 169                     .forEach(entry -> properties.put(entry.getKey().name(), entry.getValue().toString()));
 170         }
 171     }
 172
 173     private @Nullable FreeboxOsHandler checkBridgeHandler() {
 174         Bridge bridge = getBridge();
 175         if (bridge != null) {
 176             BridgeHandler handler = bridge.getHandler();
 177             if (handler instanceof FreeboxOsHandler fbOsHandler) {
 178                 if (bridge.getStatus() == ThingStatus.ONLINE) {
 179                     if (statusDrivenByBridge) {
 180                         updateStatus(ThingStatus.ONLINE);
 181                     }
 182                     return fbOsHandler;
 183                 }
 184                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.BRIDGE_OFFLINE);
 185             } else {
 186                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.HANDLER_MISSING_ERROR);
 187             }
 188         } else {
 189             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.BRIDGE_UNINITIALIZED);
 190         }
 191         return null;
 192     }
 193
 194     @Override
 195     public void dispose() {
 196         stopJobs();
 197         ServiceRegistration<?> localReg = reg;
 198         if (localReg != null) {
 199             localReg.unregister();
 200         }
 201         super.dispose();
 202     }
 203
 204     private void startRefreshJob() {
 205         removeJob("GlobalJob");
 206
 207         int refreshInterval = getConfigAs(ApiConsumerConfiguration.class).refreshInterval;
 208         logger.debug("Scheduling state update every {} seconds for thing {}...", refreshInterval, getThing().getUID());
 209
 210         ThingStatusDetail detail = thing.getStatusInfo().getStatusDetail();
 211         if (ThingStatusDetail.DUTY_CYCLE.equals(detail)) {
 212             try {
 213                 internalPoll();
 214             } catch (FreeboxException ignore) {
 215                 // An exception is normal if the box is rebooting then let's try again later...
 216                 addJob("Initialize", this::initialize, 10, TimeUnit.SECONDS);
 217                 return;
 218             }
 219         }
 220
 221         addJob("GlobalJob", () -> {
 222             try {
 223                 internalPoll();
 224             } catch (FreeboxException e) {
 225                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
 226             }
 227         }, 0, refreshInterval, TimeUnit.SECONDS);
 228     }
 229
 230     private void removeJob(String name) {
 231         ScheduledFuture<?> existing = jobs.get(name);
 232         if (existing != null && !existing.isCancelled()) {
 233             existing.cancel(true);
 234         }
 235     }
 236
 237     @Override
 238     public void addJob(String name, Runnable command, long initialDelay, long delay, TimeUnit unit) {
 239         removeJob(name);
 240         jobs.put(name, scheduler.scheduleWithFixedDelay(command, initialDelay, delay, unit));
 241     }
 242
 243     @Override
 244     public void addJob(String name, Runnable command, long delay, TimeUnit unit) {
 245         removeJob(name);
 246         jobs.put(name, scheduler.schedule(command, delay, unit));
 247     }
 248
 249     @Override
 250     public void stopJobs() {
 251         jobs.keySet().forEach(name -> removeJob(name));
 252         jobs.clear();
 253     }
 254
 255     protected boolean internalHandleCommand(String channelId, Command command) throws FreeboxException {
 256         return false;
 257     }
 258
 259     protected abstract void internalPoll() throws FreeboxException;
 260
 261     private void updateIfActive(String group, String channelId, State state) {
 262         ChannelUID id = new ChannelUID(getThing().getUID(), group, channelId);
 263         if (isLinked(id)) {
 264             updateState(id, state);
 265         }
 266     }
 267
 268     protected void updateIfActive(String channelId, State state) {
 269         ChannelUID id = new ChannelUID(getThing().getUID(), channelId);
 270         if (isLinked(id)) {
 271             updateState(id, state);
 272         }
 273     }
 274
 275     protected void updateChannelDateTimeState(String channelId, @Nullable ZonedDateTime timestamp) {
 276         updateIfActive(channelId, timestamp == null ? UnDefType.NULL : new DateTimeType(timestamp));
 277     }
 278
 279     protected void updateChannelDateTimeState(String group, String channelId, @Nullable ZonedDateTime timestamp) {
 280         updateIfActive(group, channelId, timestamp == null ? UnDefType.NULL : new DateTimeType(timestamp));
 281     }
 282
 283     protected void updateChannelOnOff(String group, String channelId, boolean value) {
 284         updateIfActive(group, channelId, OnOffType.from(value));
 285     }
 286
 287     protected void updateChannelOnOff(String channelId, boolean value) {
 288         updateIfActive(channelId, OnOffType.from(value));
 289     }
 290
 291     protected void updateChannelString(String group, String channelId, @Nullable String value) {
 292         updateIfActive(group, channelId, value != null ? new StringType(value) : UnDefType.NULL);
 293     }
 294
 295     protected void updateChannelString(String group, String channelId, @Nullable IPAddress value) {
 296         updateIfActive(group, channelId, value != null ? new StringType(value.toCanonicalString()) : UnDefType.NULL);
 297     }
 298
 299     protected void updateChannelString(String channelId, @Nullable String value) {
 300         updateIfActive(channelId, value != null ? new StringType(value) : UnDefType.NULL);
 301     }
 302
 303     protected void updateChannelString(String channelId, Enum<?> value) {
 304         updateIfActive(channelId, new StringType(value.name()));
 305     }
 306
 307     protected void updateChannelString(String group, String channelId, Enum<?> value) {
 308         updateIfActive(group, channelId, new StringType(value.name()));
 309     }
 310
 311     protected void updateChannelQuantity(String group, String channelId, double d, Unit<?> unit) {
 312         updateChannelQuantity(group, channelId, new QuantityType<>(d, unit));
 313     }
 314
 315     protected void updateChannelQuantity(String channelId, @Nullable QuantityType<?> quantity) {
 316         updateIfActive(channelId, quantity != null ? quantity : UnDefType.NULL);
 317     }
 318
 319     protected void updateChannelQuantity(String group, String channelId, @Nullable QuantityType<?> quantity) {
 320         updateIfActive(group, channelId, quantity != null ? quantity : UnDefType.NULL);
 321     }
 322
 323     protected void updateChannelDecimal(String group, String channelId, @Nullable Integer value) {
 324         updateIfActive(group, channelId, value != null ? new DecimalType(value) : UnDefType.NULL);
 325     }
 326
 327     protected void updateChannelQuantity(String group, String channelId, QuantityType<?> qtty, Unit<?> unit) {
 328         updateChannelQuantity(group, channelId, qtty.toUnit(unit));
 329     }
 330
 331     @Override
 332     public void updateStatus(ThingStatus status, ThingStatusDetail statusDetail, @Nullable String description) {
 333         super.updateStatus(status, statusDetail, description);
 334     }
 335
 336     @Override
 337     public Map<String, String> editProperties() {
 338         return super.editProperties();
 339     }
 340
 341     @Override
 342     public void updateProperties(@Nullable Map<String, String> properties) {
 343         super.updateProperties(properties);
 344     }
 345
 346     @Override
 347     public Configuration getConfig() {
 348         return super.getConfig();
 349     }
 350
 351     @Override
 352     public int getClientId() {
 353         return ((BigDecimal) getConfig().get(ClientConfiguration.ID)).intValue();
 354     }
 355 }