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

   1 /**
   2  * Copyright (c) 2010-2021 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.miio.internal.cloud;
  14
  15 import static org.openhab.binding.miio.internal.MiIoBindingConstants.BINDING_ID;
  16
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import java.util.concurrent.TimeUnit;
  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.miio.internal.MiIoSendCommand;
  25 import org.openhab.core.cache.ExpiringCache;
  26 import org.openhab.core.io.net.http.HttpClientFactory;
  27 import org.openhab.core.io.net.http.HttpUtil;
  28 import org.openhab.core.library.types.RawType;
  29 import org.osgi.service.component.annotations.Activate;
  30 import org.osgi.service.component.annotations.Component;
  31 import org.osgi.service.component.annotations.Deactivate;
  32 import org.osgi.service.component.annotations.Reference;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 import com.google.gson.JsonParseException;
  37
  38 /**
  39  * The {@link CloudConnector} is responsible for connecting OH to the Xiaomi cloud communication.
  40  *
  41  * @author Marcel Verpaalen - Initial contribution
  42  */
  43 @Component(service = CloudConnector.class)
  44 @NonNullByDefault
  45 public class CloudConnector {
  46
  47     private static final long CACHE_EXPIRY = TimeUnit.SECONDS.toMillis(60);
  48
  49     private static enum DeviceListState {
  50         FAILED,
  51         STARTING,
  52         REFRESHING,
  53         AVAILABLE,
  54     }
  55
  56     private volatile DeviceListState deviceListState = DeviceListState.STARTING;
  57
  58     private String username = "";
  59     private String password = "";
  60     private String country = "ru,us,tw,sg,cn,de,i2";
  61     private List<CloudDeviceDTO> deviceList = new ArrayList<>();
  62     private boolean connected;
  63     private final HttpClient httpClient;
  64     private @Nullable MiCloudConnector cloudConnector;
  65     private final Logger logger = LoggerFactory.getLogger(CloudConnector.class);
  66
  67     private ExpiringCache<Boolean> logonCache = new ExpiringCache<Boolean>(CACHE_EXPIRY, () -> {
  68         return logon();
  69     });
  70
  71     private ExpiringCache<String> refreshDeviceList = new ExpiringCache<String>(CACHE_EXPIRY, () -> {
  72         if (deviceListState == DeviceListState.FAILED && !isConnected()) {
  73             return ("Could not connect to Xiaomi cloud");
  74         }
  75         final @Nullable MiCloudConnector cl = this.cloudConnector;
  76         if (cl == null) {
  77             return ("Could not connect to Xiaomi cloud");
  78         }
  79         deviceListState = DeviceListState.REFRESHING;
  80         deviceList.clear();
  81         for (String server : country.split(",")) {
  82             try {
  83                 deviceList.addAll(cl.getDevices(server));
  84             } catch (JsonParseException e) {
  85                 logger.debug("Parsing error getting devices: {}", e.getMessage());
  86             }
  87         }
  88         deviceListState = DeviceListState.AVAILABLE;
  89         return "done";// deviceList;
  90     });
  91
  92     @Activate
  93     public CloudConnector(@Reference HttpClientFactory httpClientFactory) {
  94         this.httpClient = httpClientFactory.createHttpClient(BINDING_ID);
  95     }
  96
  97     @Deactivate
  98     public void dispose() {
  99         final MiCloudConnector cl = cloudConnector;
 100         if (cl != null) {
 101             cl.stopClient();
 102         }
 103         cloudConnector = null;
 104     }
 105
 106     public boolean isConnected() {
 107         final MiCloudConnector cl = cloudConnector;
 108         if (cl != null && cl.hasLoginToken()) {
 109             return true;
 110         }
 111         final @Nullable Boolean c = logonCache.getValue();
 112         if (c != null && c.booleanValue()) {
 113             return true;
 114         }
 115         deviceListState = DeviceListState.FAILED;
 116         return false;
 117     }
 118
 119     public String sendRPCCommand(String device, String country, MiIoSendCommand command) throws MiCloudException {
 120         final @Nullable MiCloudConnector cl = this.cloudConnector;
 121         if (cl == null || !isConnected()) {
 122             throw new MiCloudException("Cannot execute request. Cloud service not available");
 123         }
 124         return cl.sendRPCCommand(device, country.trim().toLowerCase(), command.getCommandString());
 125     }
 126
 127     public @Nullable RawType getMap(String mapId, String country) throws MiCloudException {
 128         logger.debug("Getting vacuum map {} from Xiaomi cloud server: '{}'", mapId, country);
 129         String mapCountry;
 130         String mapUrl = "";
 131         final @Nullable MiCloudConnector cl = this.cloudConnector;
 132         if (cl == null || !isConnected()) {
 133             throw new MiCloudException("Cannot execute request. Cloud service not available");
 134         }
 135         if (country.isEmpty()) {
 136             logger.debug("Server not defined in thing. Trying servers: {}", this.country);
 137             for (String mapCountryServer : this.country.split(",")) {
 138                 mapCountry = mapCountryServer.trim().toLowerCase();
 139                 mapUrl = cl.getMapUrl(mapId, mapCountry);
 140                 logger.debug("Map download from server {} returned {}", mapCountry, mapUrl);
 141                 if (!mapUrl.isEmpty()) {
 142                     break;
 143                 }
 144             }
 145         } else {
 146             mapCountry = country.trim().toLowerCase();
 147             mapUrl = cl.getMapUrl(mapId, mapCountry);
 148         }
 149         if (mapUrl.isBlank()) {
 150             logger.debug("Cannot download map data: Returned map URL is empty");
 151             return null;
 152         }
 153         try {
 154             RawType mapData = HttpUtil.downloadData(mapUrl, null, false, -1);
 155             if (mapData != null) {
 156                 return mapData;
 157             } else {
 158                 logger.debug("Could not download '{}'", mapUrl);
 159                 return null;
 160             }
 161         } catch (IllegalArgumentException e) {
 162             logger.debug("Error downloading map: {}", e.getMessage());
 163         }
 164         return null;
 165     }
 166
 167     public void setCredentials(@Nullable String username, @Nullable String password, @Nullable String country) {
 168         if (country != null) {
 169             this.country = country;
 170         }
 171         if (username != null && password != null) {
 172             this.username = username;
 173             this.password = password;
 174         }
 175     }
 176
 177     private boolean logon() {
 178         if (username.isEmpty() || password.isEmpty()) {
 179             logger.debug("No Xiaomi cloud credentials. Cloud connectivity disabled");
 180             logger.debug("Logon details: username: '{}', pass: '{}', country: '{}'", username,
 181                     password.replaceAll(".", "*"), country);
 182             return connected;
 183         }
 184         try {
 185             final MiCloudConnector cl = new MiCloudConnector(username, password, httpClient);
 186             this.cloudConnector = cl;
 187             connected = cl.login();
 188             if (connected) {
 189                 getDevicesList();
 190             } else {
 191                 deviceListState = DeviceListState.FAILED;
 192             }
 193         } catch (MiCloudException e) {
 194             connected = false;
 195             deviceListState = DeviceListState.FAILED;
 196             logger.debug("Xiaomi cloud login failed: {}", e.getMessage());
 197         }
 198         return connected;
 199     }
 200
 201     public List<CloudDeviceDTO> getDevicesList() {
 202         refreshDeviceList.getValue();
 203         return deviceList;
 204     }
 205
 206     public @Nullable CloudDeviceDTO getDeviceInfo(String id) {
 207         getDevicesList();
 208         if (deviceListState != DeviceListState.AVAILABLE) {
 209             return null;
 210         }
 211         String did = Long.toString(Long.parseUnsignedLong(id, 16));
 212         List<CloudDeviceDTO> devicedata = new ArrayList<>();
 213         for (CloudDeviceDTO deviceDetails : deviceList) {
 214             if (deviceDetails.getDid().contentEquals(did)) {
 215                 devicedata.add(deviceDetails);
 216             }
 217         }
 218         if (devicedata.isEmpty()) {
 219             return null;
 220         }
 221         for (CloudDeviceDTO device : devicedata) {
 222             if (device.getIsOnline()) {
 223                 return device;
 224             }
 225         }
 226         if (devicedata.size() > 1) {
 227             logger.debug("Found multiple servers for device {} {} returning first", devicedata.get(0).getDid(),
 228                     devicedata.get(0).getName());
 229         }
 230         return devicedata.get(0);
 231     }
 232 }