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

   1 /**
   2  * Copyright (c) 2010-2022 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.pushover.internal.handler;
  14
  15 import static org.openhab.binding.pushover.internal.PushoverBindingConstants.*;
  16
  17 import java.util.Collection;
  18 import java.util.List;
  19 import java.util.Set;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.eclipse.jetty.client.HttpClient;
  24 import org.openhab.binding.pushover.internal.actions.PushoverActions;
  25 import org.openhab.binding.pushover.internal.config.PushoverAccountConfiguration;
  26 import org.openhab.binding.pushover.internal.config.PushoverConfigOptionProvider;
  27 import org.openhab.binding.pushover.internal.connection.PushoverAPIConnection;
  28 import org.openhab.binding.pushover.internal.connection.PushoverMessageBuilder;
  29 import org.openhab.binding.pushover.internal.dto.Sound;
  30 import org.openhab.core.i18n.CommunicationException;
  31 import org.openhab.core.i18n.ConfigurationException;
  32 import org.openhab.core.thing.ChannelUID;
  33 import org.openhab.core.thing.Thing;
  34 import org.openhab.core.thing.ThingStatus;
  35 import org.openhab.core.thing.ThingStatusDetail;
  36 import org.openhab.core.thing.binding.BaseThingHandler;
  37 import org.openhab.core.thing.binding.ThingHandlerService;
  38 import org.openhab.core.types.Command;
  39
  40 /**
  41  * The {@link PushoverAccountHandler} is responsible for handling commands, which are sent to one of the channels.
  42  *
  43  * @author Christoph Weitkamp - Initial contribution
  44  */
  45 @NonNullByDefault
  46 public class PushoverAccountHandler extends BaseThingHandler {
  47
  48     private static final Collection<Class<? extends ThingHandlerService>> SUPPORTED_THING_ACTIONS = Set
  49             .of(PushoverActions.class, PushoverConfigOptionProvider.class);
  50
  51     private final HttpClient httpClient;
  52
  53     private PushoverAccountConfiguration config = new PushoverAccountConfiguration();
  54     private @Nullable PushoverAPIConnection connection;
  55
  56     public PushoverAccountHandler(Thing thing, HttpClient httpClient) {
  57         super(thing);
  58         this.httpClient = httpClient;
  59     }
  60
  61     @Override
  62     public void handleCommand(ChannelUID channelUID, Command command) {
  63         // nothing
  64     }
  65
  66     @Override
  67     public void initialize() {
  68         config = getConfigAs(PushoverAccountConfiguration.class);
  69
  70         boolean configValid = true;
  71         final String apikey = config.apikey;
  72         if (apikey == null || apikey.isBlank()) {
  73             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
  74                     TEXT_OFFLINE_CONF_ERROR_MISSING_APIKEY);
  75             configValid = false;
  76         }
  77         final String user = config.user;
  78         if (user == null || user.isBlank()) {
  79             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
  80                     TEXT_OFFLINE_CONF_ERROR_MISSING_USER);
  81             configValid = false;
  82         }
  83
  84         if (configValid) {
  85             updateStatus(ThingStatus.UNKNOWN);
  86
  87             connection = new PushoverAPIConnection(httpClient, config);
  88             scheduler.submit(this::asyncValidateUser);
  89         }
  90     }
  91
  92     @Override
  93     public Collection<Class<? extends ThingHandlerService>> getServices() {
  94         return SUPPORTED_THING_ACTIONS;
  95     }
  96
  97     /**
  98      * Retrieves the list of current sounds and their descriptions from the Pushover API.
  99      *
 100      * @return a list of {@link Sound}s
 101      */
 102     public List<Sound> getSounds() {
 103         try {
 104             if (connection != null) {
 105                 List<Sound> sounds = connection.getSounds();
 106                 if (sounds != null) {
 107                     return sounds;
 108                 }
 109             }
 110         } catch (CommunicationException e) {
 111             // do nothing, causing exception is already logged
 112         } catch (ConfigurationException e) {
 113             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getRawMessage());
 114         }
 115         return PushoverAccountConfiguration.DEFAULT_SOUNDS;
 116     }
 117
 118     /**
 119      * Returns a preconfigured {@link PushoverMessageBuilder}.
 120      *
 121      * @param message the message
 122      * @return a {@link PushoverMessageBuilder} instance
 123      */
 124     public PushoverMessageBuilder getDefaultPushoverMessageBuilder(String message) {
 125         PushoverMessageBuilder builder = PushoverMessageBuilder.getInstance(config.apikey, config.user)
 126                 .withMessage(message) //
 127                 .withTitle(config.title) //
 128                 .withRetry(config.retry) //
 129                 .withExpire(config.expire);
 130         // specify format if defined
 131         switch (config.format) {
 132             case PushoverMessageBuilder.MESSAGE_KEY_HTML:
 133                 builder.withHtmlFormatting();
 134                 break;
 135             case PushoverMessageBuilder.MESSAGE_KEY_MONOSPACE:
 136                 builder.withMonospaceFormatting();
 137             default:
 138                 break;
 139         }
 140         // add sound, if defined
 141         if (!DEFAULT_SOUND.equals(config.sound)) {
 142             builder.withSound(config.sound);
 143         }
 144         return builder;
 145     }
 146
 147     public boolean sendMessage(PushoverMessageBuilder messageBuilder) {
 148         if (connection != null) {
 149             try {
 150                 return connection.sendMessage(messageBuilder);
 151             } catch (CommunicationException e) {
 152                 // do nothing, causing exception is already logged
 153             } catch (ConfigurationException e) {
 154                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getRawMessage());
 155             }
 156             return false;
 157         } else {
 158             throw new IllegalArgumentException("PushoverAPIConnection is null!");
 159         }
 160     }
 161
 162     public String sendPriorityMessage(PushoverMessageBuilder messageBuilder) {
 163         if (connection != null) {
 164             try {
 165                 return connection.sendPriorityMessage(messageBuilder);
 166             } catch (CommunicationException e) {
 167                 // do nothing, causing exception is already logged
 168             } catch (ConfigurationException e) {
 169                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getRawMessage());
 170             }
 171             return "";
 172         } else {
 173             throw new IllegalArgumentException("PushoverAPIConnection is null!");
 174         }
 175     }
 176
 177     public boolean cancelPriorityMessage(String receipt) {
 178         if (connection != null) {
 179             try {
 180                 return connection.cancelPriorityMessage(receipt);
 181             } catch (CommunicationException e) {
 182                 // do nothing, causing exception is already logged
 183             } catch (ConfigurationException e) {
 184                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getRawMessage());
 185             }
 186             return false;
 187         } else {
 188             throw new IllegalArgumentException("PushoverAPIConnection is null!");
 189         }
 190     }
 191
 192     @SuppressWarnings("null")
 193     private void asyncValidateUser() {
 194         try {
 195             connection.validateUser();
 196             updateStatus(ThingStatus.ONLINE);
 197         } catch (CommunicationException | ConfigurationException e) {
 198             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getRawMessage());
 199         }
 200     }
 201 }