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.hydrawise.internal.handler;
  14
  15 import java.io.IOException;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.Collections;
  19 import java.util.List;
  20 import java.util.concurrent.ScheduledFuture;
  21 import java.util.concurrent.TimeUnit;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.eclipse.jetty.client.HttpClient;
  26 import org.openhab.binding.hydrawise.internal.HydrawiseControllerListener;
  27 import org.openhab.binding.hydrawise.internal.api.HydrawiseAuthenticationException;
  28 import org.openhab.binding.hydrawise.internal.api.HydrawiseConnectionException;
  29 import org.openhab.binding.hydrawise.internal.api.graphql.HydrawiseGraphQLClient;
  30 import org.openhab.binding.hydrawise.internal.api.graphql.dto.Customer;
  31 import org.openhab.binding.hydrawise.internal.api.graphql.dto.QueryResponse;
  32 import org.openhab.binding.hydrawise.internal.config.HydrawiseAccountConfiguration;
  33 import org.openhab.binding.hydrawise.internal.discovery.HydrawiseCloudControllerDiscoveryService;
  34 import org.openhab.core.auth.client.oauth2.AccessTokenRefreshListener;
  35 import org.openhab.core.auth.client.oauth2.AccessTokenResponse;
  36 import org.openhab.core.auth.client.oauth2.OAuthClientService;
  37 import org.openhab.core.auth.client.oauth2.OAuthException;
  38 import org.openhab.core.auth.client.oauth2.OAuthFactory;
  39 import org.openhab.core.auth.client.oauth2.OAuthResponseException;
  40 import org.openhab.core.config.core.Configuration;
  41 import org.openhab.core.thing.Bridge;
  42 import org.openhab.core.thing.ChannelUID;
  43 import org.openhab.core.thing.ThingStatus;
  44 import org.openhab.core.thing.ThingStatusDetail;
  45 import org.openhab.core.thing.binding.BaseBridgeHandler;
  46 import org.openhab.core.thing.binding.ThingHandlerService;
  47 import org.openhab.core.types.Command;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 /**
  52  * The {@link HydrawiseAccountHandler} is responsible for handling for connecting to a Hydrawise account and polling for
  53  * controller data
  54  *
  55  * @author Dan Cunningham - Initial contribution
  56  */
  57 @NonNullByDefault
  58 public class HydrawiseAccountHandler extends BaseBridgeHandler implements AccessTokenRefreshListener {
  59     private final Logger logger = LoggerFactory.getLogger(HydrawiseAccountHandler.class);
  60     /**
  61      * Minimum amount of time we can poll for updates
  62      */
  63     private static final int MIN_REFRESH_SECONDS = 30;
  64     private static final String BASE_URL = "https://app.hydrawise.com/api/v2/";
  65     private static final String AUTH_URL = BASE_URL + "oauth/access-token";
  66     private static final String CLIENT_SECRET = "zn3CrjglwNV1";
  67     private static final String CLIENT_ID = "hydrawise_app";
  68     private static final String SCOPE = "all";
  69     private final List<HydrawiseControllerListener> controllerListeners = Collections
  70             .synchronizedList(new ArrayList<HydrawiseControllerListener>());
  71     private final HydrawiseGraphQLClient apiClient;
  72     private final OAuthClientService oAuthService;
  73     private @Nullable ScheduledFuture<?> pollFuture;
  74     private @Nullable Customer lastData;
  75     private int refresh;
  76
  77     public HydrawiseAccountHandler(final Bridge bridge, final HttpClient httpClient, final OAuthFactory oAuthFactory) {
  78         super(bridge);
  79         this.oAuthService = oAuthFactory.createOAuthClientService(getThing().toString(), AUTH_URL, AUTH_URL, CLIENT_ID,
  80                 CLIENT_SECRET, SCOPE, false);
  81         oAuthService.addAccessTokenRefreshListener(this);
  82         this.apiClient = new HydrawiseGraphQLClient(httpClient, oAuthService);
  83     }
  84
  85     @Override
  86     public void handleCommand(ChannelUID channelUID, Command command) {
  87     }
  88
  89     @Override
  90     public void initialize() {
  91         logger.debug("Handler initialized.");
  92         scheduler.schedule(this::configure, 0, TimeUnit.SECONDS);
  93     }
  94
  95     @Override
  96     public void dispose() {
  97         logger.debug("Handler disposed.");
  98         clearPolling();
  99     }
 100
 101     @Override
 102     public void onAccessTokenResponse(AccessTokenResponse tokenResponse) {
 103         logger.debug("Auth Token Refreshed, expires in {}", tokenResponse.getExpiresIn());
 104     }
 105
 106     @Override
 107     public Collection<Class<? extends ThingHandlerService>> getServices() {
 108         return Collections.singleton(HydrawiseCloudControllerDiscoveryService.class);
 109     }
 110
 111     public void addControllerListeners(HydrawiseControllerListener listener) {
 112         this.controllerListeners.add(listener);
 113         Customer data = lastData;
 114         if (data != null) {
 115             listener.onData(data.controllers);
 116         }
 117     }
 118
 119     public void removeControllerListeners(HydrawiseControllerListener listener) {
 120         synchronized (controllerListeners) {
 121             this.controllerListeners.remove(listener);
 122         }
 123     }
 124
 125     public @Nullable HydrawiseGraphQLClient graphQLClient() {
 126         return apiClient;
 127     }
 128
 129     public @Nullable Customer lastData() {
 130         return lastData;
 131     }
 132
 133     public void refreshData(int delaySeconds) {
 134         initPolling(delaySeconds, this.refresh);
 135     }
 136
 137     private void configure() {
 138         HydrawiseAccountConfiguration config = getConfig().as(HydrawiseAccountConfiguration.class);
 139         try {
 140             if (!config.userName.isEmpty() && !config.password.isEmpty()) {
 141                 if (!config.savePassword) {
 142                     Configuration editedConfig = editConfiguration();
 143                     editedConfig.remove("password");
 144                     updateConfiguration(editedConfig);
 145                 }
 146                 oAuthService.getAccessTokenByResourceOwnerPasswordCredentials(config.userName, config.password, SCOPE);
 147             } else if (oAuthService.getAccessTokenResponse() == null) {
 148                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, "Login credentials required.");
 149                 return;
 150             }
 151             this.refresh = Math.max(config.refreshInterval, MIN_REFRESH_SECONDS);
 152             initPolling(0, refresh);
 153         } catch (OAuthException | IOException e) {
 154             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
 155         } catch (OAuthResponseException e) {
 156             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, "Login credentials required.");
 157         }
 158     }
 159
 160     /**
 161      * Starts/Restarts polling with an initial delay. This allows changes in the poll cycle for when commands are sent
 162      * and we need to poll sooner then the next refresh cycle.
 163      */
 164     private synchronized void initPolling(int initalDelay, int refresh) {
 165         clearPolling();
 166         pollFuture = scheduler.scheduleWithFixedDelay(this::poll, initalDelay, refresh, TimeUnit.SECONDS);
 167     }
 168
 169     /**
 170      * Stops/clears this thing's polling future
 171      */
 172     private void clearPolling() {
 173         ScheduledFuture<?> localFuture = pollFuture;
 174         if (isFutureValid(localFuture)) {
 175             if (localFuture != null) {
 176                 localFuture.cancel(false);
 177             }
 178         }
 179     }
 180
 181     private boolean isFutureValid(@Nullable ScheduledFuture<?> future) {
 182         return future != null && !future.isCancelled();
 183     }
 184
 185     private void poll() {
 186         poll(true);
 187     }
 188
 189     private void poll(boolean retry) {
 190         try {
 191             QueryResponse response = apiClient.queryControllers();
 192             if (response == null) {
 193                 throw new HydrawiseConnectionException("Malformed response");
 194             }
 195             if (response.errors != null && response.errors.size() > 0) {
 196                 throw new HydrawiseConnectionException(response.errors.stream().map(error -> error.message).reduce("",
 197                         (messages, message) -> messages + message + ". "));
 198             }
 199             if (getThing().getStatus() != ThingStatus.ONLINE) {
 200                 updateStatus(ThingStatus.ONLINE);
 201             }
 202             lastData = response.data.me;
 203             synchronized (controllerListeners) {
 204                 controllerListeners.forEach(listener -> {
 205                     listener.onData(response.data.me.controllers);
 206                 });
 207             }
 208         } catch (HydrawiseConnectionException e) {
 209             if (retry) {
 210                 logger.debug("Retrying failed poll", e);
 211                 poll(false);
 212             } else {
 213                 logger.debug("Will try again during next poll period", e);
 214                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR, e.getMessage());
 215             }
 216         } catch (HydrawiseAuthenticationException e) {
 217             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
 218             clearPolling();
 219         }
 220     }
 221 }