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

   1 /**
   2  * Copyright (c) 2010-2020 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.icalendar.internal.handler;
  14
  15 import static org.openhab.binding.icalendar.internal.ICalendarBindingConstants.*;
  16
  17 import java.io.File;
  18 import java.io.FileInputStream;
  19 import java.io.IOException;
  20 import java.math.BigDecimal;
  21 import java.net.URI;
  22 import java.net.URISyntaxException;
  23 import java.time.Instant;
  24 import java.util.List;
  25 import java.util.concurrent.ScheduledFuture;
  26 import java.util.concurrent.TimeUnit;
  27
  28 import org.eclipse.jdt.annotation.NonNullByDefault;
  29 import org.eclipse.jdt.annotation.Nullable;
  30 import org.eclipse.jetty.client.HttpClient;
  31 import org.openhab.binding.icalendar.internal.config.ICalendarConfiguration;
  32 import org.openhab.binding.icalendar.internal.handler.PullJob.CalendarUpdateListener;
  33 import org.openhab.binding.icalendar.internal.logic.AbstractPresentableCalendar;
  34 import org.openhab.binding.icalendar.internal.logic.CalendarException;
  35 import org.openhab.binding.icalendar.internal.logic.CommandTag;
  36 import org.openhab.binding.icalendar.internal.logic.CommandTagType;
  37 import org.openhab.binding.icalendar.internal.logic.Event;
  38 import org.openhab.core.OpenHAB;
  39 import org.openhab.core.events.EventPublisher;
  40 import org.openhab.core.i18n.TimeZoneProvider;
  41 import org.openhab.core.items.events.ItemEventFactory;
  42 import org.openhab.core.library.types.DateTimeType;
  43 import org.openhab.core.library.types.OnOffType;
  44 import org.openhab.core.library.types.StringType;
  45 import org.openhab.core.thing.Bridge;
  46 import org.openhab.core.thing.ChannelUID;
  47 import org.openhab.core.thing.Thing;
  48 import org.openhab.core.thing.ThingStatus;
  49 import org.openhab.core.thing.ThingStatusDetail;
  50 import org.openhab.core.thing.binding.BaseBridgeHandler;
  51 import org.openhab.core.thing.binding.ThingHandler;
  52 import org.openhab.core.types.Command;
  53 import org.openhab.core.types.RefreshType;
  54 import org.openhab.core.types.UnDefType;
  55 import org.slf4j.Logger;
  56 import org.slf4j.LoggerFactory;
  57
  58 /**
  59  * The {@link ICalendarHandler} is responsible for handling commands, which are
  60  * sent to one of the channels.
  61  *
  62  * @author Michael Wodniok - Initial contribution
  63  * @author Andrew Fiddian-Green - Support for Command Tags embedded in the Event description
  64  */
  65 @NonNullByDefault
  66 public class ICalendarHandler extends BaseBridgeHandler implements CalendarUpdateListener {
  67
  68     private final File calendarFile;
  69     private @Nullable ICalendarConfiguration configuration;
  70     private final EventPublisher eventPublisherCallback;
  71     private final HttpClient httpClient;
  72     private final Logger logger = LoggerFactory.getLogger(ICalendarHandler.class);
  73     private final TimeZoneProvider tzProvider;
  74     private @Nullable ScheduledFuture<?> pullJobFuture;
  75     private @Nullable AbstractPresentableCalendar runtimeCalendar;
  76     private @Nullable ScheduledFuture<?> updateJobFuture;
  77     private Instant updateStatesLastCalledTime;
  78
  79     public ICalendarHandler(Bridge bridge, HttpClient httpClient, EventPublisher eventPublisher,
  80             TimeZoneProvider tzProvider) {
  81         super(bridge);
  82         this.httpClient = httpClient;
  83         calendarFile = new File(OpenHAB.getUserDataFolder() + File.separator
  84                 + getThing().getUID().getAsString().replaceAll("[<>:\"/\\\\|?*]", "_") + ".ical");
  85         eventPublisherCallback = eventPublisher;
  86         updateStatesLastCalledTime = Instant.now();
  87         this.tzProvider = tzProvider;
  88     }
  89
  90     @Override
  91     public void dispose() {
  92         final ScheduledFuture<?> currentUpdateJobFuture = updateJobFuture;
  93         if (currentUpdateJobFuture != null) {
  94             currentUpdateJobFuture.cancel(true);
  95         }
  96         final ScheduledFuture<?> currentPullJobFuture = pullJobFuture;
  97         if (currentPullJobFuture != null) {
  98             currentPullJobFuture.cancel(true);
  99         }
 100     }
 101
 102     @Override
 103     public void handleCommand(ChannelUID channelUID, Command command) {
 104         switch (channelUID.getId()) {
 105             case CHANNEL_CURRENT_EVENT_PRESENT:
 106             case CHANNEL_CURRENT_EVENT_TITLE:
 107             case CHANNEL_CURRENT_EVENT_START:
 108             case CHANNEL_CURRENT_EVENT_END:
 109             case CHANNEL_NEXT_EVENT_TITLE:
 110             case CHANNEL_NEXT_EVENT_START:
 111             case CHANNEL_NEXT_EVENT_END:
 112                 if (command instanceof RefreshType) {
 113                     updateStates();
 114                 }
 115                 break;
 116             default:
 117                 logger.warn("Framework sent command to unknown channel with id '{}'", channelUID.getId());
 118         }
 119     }
 120
 121     @Override
 122     public void initialize() {
 123         updateStatus(ThingStatus.UNKNOWN);
 124
 125         final ICalendarConfiguration currentConfiguration = getConfigAs(ICalendarConfiguration.class);
 126         configuration = currentConfiguration;
 127
 128         try {
 129             if ((currentConfiguration.username == null && currentConfiguration.password != null)
 130                     || (currentConfiguration.username != null && currentConfiguration.password == null)) {
 131                 throw new ConfigBrokenException("Only one of username and password was set. This is invalid.");
 132             }
 133
 134             PullJob regularPull;
 135             final BigDecimal maxSizeBD = currentConfiguration.maxSize;
 136             if (maxSizeBD == null || maxSizeBD.intValue() < 1) {
 137                 throw new ConfigBrokenException(
 138                         "maxSize is either not set or less than 1 (mebibyte), which is not allowed.");
 139             }
 140             final int maxSize = maxSizeBD.intValue();
 141             try {
 142                 regularPull = new PullJob(httpClient, new URI(currentConfiguration.url), currentConfiguration.username,
 143                         currentConfiguration.password, calendarFile, maxSize * 1048576, this);
 144             } catch (URISyntaxException e) {
 145                 throw new ConfigBrokenException(String.format(
 146                         "The URI '%s' for downloading the calendar contains syntax errors.", currentConfiguration.url));
 147
 148             }
 149
 150             final BigDecimal refreshTimeBD = currentConfiguration.refreshTime;
 151             if (refreshTimeBD == null || refreshTimeBD.longValue() < 1) {
 152                 throw new ConfigBrokenException(
 153                         "refreshTime is either not set or less than 1 (minute), which is not allowed.");
 154             }
 155             final long refreshTime = refreshTimeBD.longValue();
 156             if (calendarFile.isFile()) {
 157                 if (reloadCalendar()) {
 158                     updateStatus(ThingStatus.ONLINE);
 159                     updateStates();
 160                     rescheduleCalendarStateUpdate();
 161                 } else {
 162                     updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
 163                             "The calendar seems to be configured correctly, but the local copy of calendar could not be loaded.");
 164                 }
 165                 pullJobFuture = scheduler.scheduleWithFixedDelay(regularPull, refreshTime, refreshTime,
 166                         TimeUnit.MINUTES);
 167             } else {
 168                 updateStatus(ThingStatus.OFFLINE);
 169                 logger.debug(
 170                         "The calendar is currently offline as no local copy exists. It will go online as soon as a valid valid calendar is retrieved.");
 171                 pullJobFuture = scheduler.scheduleWithFixedDelay(regularPull, 0, refreshTime, TimeUnit.MINUTES);
 172             }
 173         } catch (ConfigBrokenException e) {
 174             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
 175         }
 176     }
 177
 178     @Override
 179     public void onCalendarUpdated() {
 180         if (reloadCalendar()) {
 181             updateStates();
 182             for (Thing childThing : getThing().getThings()) {
 183                 ThingHandler handler = childThing.getHandler();
 184                 if (handler instanceof CalendarUpdateListener) {
 185                     try {
 186                         ((CalendarUpdateListener) handler).onCalendarUpdated();
 187                     } catch (Exception e) {
 188                         logger.trace("The update of a child handler failed. Ignoring.", e);
 189                     }
 190                 }
 191             }
 192         } else {
 193             logger.trace("Calendar was updated, but loading failed.");
 194         }
 195     }
 196
 197     /**
 198      * @return the calendar that is used for all operations
 199      */
 200     @Nullable
 201     public AbstractPresentableCalendar getRuntimeCalendar() {
 202         return runtimeCalendar;
 203     }
 204
 205     private void executeEventCommands(List<Event> events, CommandTagType execTime) {
 206         // no begun or ended events => exit quietly as there is nothing to do
 207         if (events.isEmpty()) {
 208             return;
 209         }
 210
 211         final ICalendarConfiguration syncConfiguration = configuration;
 212         if (syncConfiguration == null) {
 213             logger.debug("Configuration not instantiated!");
 214             return;
 215         }
 216         // loop through all events in the list
 217         for (Event event : events) {
 218
 219             // loop through all command tags in the event
 220             for (CommandTag cmdTag : event.commandTags) {
 221
 222                 // only process the BEGIN resp. END tags
 223                 if (cmdTag.getTagType() != execTime) {
 224                     continue;
 225                 }
 226                 if (!cmdTag.isAuthorized(syncConfiguration.authorizationCode)) {
 227                     logger.warn("Event: {}, Command Tag: {} => Command not authorized!", event.title,
 228                             cmdTag.getFullTag());
 229                     continue;
 230                 }
 231
 232                 final Command cmdState = cmdTag.getCommand();
 233                 if (cmdState == null) {
 234                     logger.warn("Event: {}, Command Tag: {} => Error creating Command State!", event.title,
 235                             cmdTag.getFullTag());
 236                     continue;
 237                 }
 238
 239                 // (try to) execute the command
 240                 try {
 241                     eventPublisherCallback.post(ItemEventFactory.createCommandEvent(cmdTag.getItemName(), cmdState));
 242                     if (logger.isDebugEnabled()) {
 243                         String cmdType = cmdState.getClass().toString();
 244                         int index = cmdType.lastIndexOf(".") + 1;
 245                         if ((index > 0) && (index < cmdType.length())) {
 246                             cmdType = cmdType.substring(index);
 247                         }
 248                         logger.debug("Event: {}, Command Tag: {} => {}.postUpdate({}: {})", event.title,
 249                                 cmdTag.getFullTag(), cmdTag.getItemName(), cmdType, cmdState);
 250                     }
 251                 } catch (IllegalArgumentException | IllegalStateException e) {
 252                     logger.warn("Event: {}, Command Tag: {} => Unable to push command to target item!", event.title,
 253                             cmdTag.getFullTag());
 254                     logger.debug("Exception occured while pushing to item!", e);
 255                 }
 256             }
 257         }
 258     }
 259
 260     /**
 261      * Reloads the calendar from local ical-file. Replaces the class internal calendar - if loading succeeds. Else
 262      * logging details at warn-level logger.
 263      *
 264      * @return Whether the calendar was loaded successfully.
 265      */
 266     private boolean reloadCalendar() {
 267         if (!calendarFile.isFile()) {
 268             logger.info("Local file for reloading calendar is missing.");
 269             return false;
 270         }
 271         final ICalendarConfiguration config = configuration;
 272         if (config == null) {
 273             logger.warn("Can't reload calendar when configuration is missing.");
 274             return false;
 275         }
 276         try (final FileInputStream fileStream = new FileInputStream(calendarFile)) {
 277             final AbstractPresentableCalendar calendar = AbstractPresentableCalendar.create(fileStream);
 278             runtimeCalendar = calendar;
 279             rescheduleCalendarStateUpdate();
 280         } catch (IOException | CalendarException e) {
 281             logger.warn("Loading calendar failed: {}", e.getMessage());
 282             return false;
 283         }
 284         return true;
 285     }
 286
 287     /**
 288      * Reschedules the next update of the states.
 289      */
 290     private void rescheduleCalendarStateUpdate() {
 291         final ScheduledFuture<?> currentUpdateJobFuture = updateJobFuture;
 292         if (currentUpdateJobFuture != null) {
 293             if (!(currentUpdateJobFuture.isCancelled() || currentUpdateJobFuture.isDone())) {
 294                 currentUpdateJobFuture.cancel(true);
 295             }
 296             updateJobFuture = null;
 297         }
 298         final AbstractPresentableCalendar currentCalendar = runtimeCalendar;
 299         if (currentCalendar == null) {
 300             return;
 301         }
 302         final Instant now = Instant.now();
 303         if (currentCalendar.isEventPresent(now)) {
 304             final Event currentEvent = currentCalendar.getCurrentEvent(now);
 305             if (currentEvent == null) {
 306                 logger.debug(
 307                         "Could not schedule next update of states, due to unexpected behaviour of calendar implementation.");
 308                 return;
 309             }
 310             updateJobFuture = scheduler.schedule(() -> {
 311                 ICalendarHandler.this.updateStates();
 312                 ICalendarHandler.this.rescheduleCalendarStateUpdate();
 313             }, currentEvent.end.getEpochSecond() - now.getEpochSecond(), TimeUnit.SECONDS);
 314         } else {
 315             final Event nextEvent = currentCalendar.getNextEvent(now);
 316             final ICalendarConfiguration currentConfig = this.configuration;
 317             if (currentConfig == null) {
 318                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
 319                         "Something is broken, the configuration is not available.");
 320                 return;
 321             }
 322             if (nextEvent == null) {
 323                 updateJobFuture = scheduler.schedule(() -> {
 324                     ICalendarHandler.this.rescheduleCalendarStateUpdate();
 325                 }, 1L, TimeUnit.DAYS);
 326             } else {
 327                 updateJobFuture = scheduler.schedule(() -> {
 328                     ICalendarHandler.this.updateStates();
 329                     ICalendarHandler.this.rescheduleCalendarStateUpdate();
 330                 }, nextEvent.start.getEpochSecond() - now.getEpochSecond(), TimeUnit.SECONDS);
 331             }
 332         }
 333     }
 334
 335     /**
 336      * Updates the states of the Thing and its channels.
 337      */
 338     private void updateStates() {
 339         final AbstractPresentableCalendar calendar = runtimeCalendar;
 340         if (calendar == null) {
 341             updateStatus(ThingStatus.OFFLINE);
 342         } else {
 343             updateStatus(ThingStatus.ONLINE);
 344
 345             final Instant now = Instant.now();
 346             if (calendar.isEventPresent(now)) {
 347                 updateState(CHANNEL_CURRENT_EVENT_PRESENT, OnOffType.ON);
 348                 final Event currentEvent = calendar.getCurrentEvent(now);
 349                 if (currentEvent == null) {
 350                     logger.warn("Unexpected inconsistency of internal API. Not Updating event details.");
 351                 } else {
 352                     updateState(CHANNEL_CURRENT_EVENT_TITLE, new StringType(currentEvent.title));
 353                     updateState(CHANNEL_CURRENT_EVENT_START,
 354                             new DateTimeType(currentEvent.start.atZone(tzProvider.getTimeZone())));
 355                     updateState(CHANNEL_CURRENT_EVENT_END,
 356                             new DateTimeType(currentEvent.end.atZone(tzProvider.getTimeZone())));
 357                 }
 358             } else {
 359                 updateState(CHANNEL_CURRENT_EVENT_PRESENT, OnOffType.OFF);
 360                 updateState(CHANNEL_CURRENT_EVENT_TITLE, UnDefType.UNDEF);
 361                 updateState(CHANNEL_CURRENT_EVENT_START, UnDefType.UNDEF);
 362                 updateState(CHANNEL_CURRENT_EVENT_END, UnDefType.UNDEF);
 363             }
 364
 365             final Event nextEvent = calendar.getNextEvent(now);
 366             if (nextEvent != null) {
 367                 updateState(CHANNEL_NEXT_EVENT_TITLE, new StringType(nextEvent.title));
 368                 updateState(CHANNEL_NEXT_EVENT_START,
 369                         new DateTimeType(nextEvent.start.atZone(tzProvider.getTimeZone())));
 370                 updateState(CHANNEL_NEXT_EVENT_END, new DateTimeType(nextEvent.end.atZone(tzProvider.getTimeZone())));
 371             } else {
 372                 updateState(CHANNEL_NEXT_EVENT_TITLE, UnDefType.UNDEF);
 373                 updateState(CHANNEL_NEXT_EVENT_START, UnDefType.UNDEF);
 374                 updateState(CHANNEL_NEXT_EVENT_END, UnDefType.UNDEF);
 375             }
 376
 377             // process all Command Tags in all Calendar Events which ENDED since updateStates was last called
 378             // the END Event tags must be processed before the BEGIN ones
 379             executeEventCommands(calendar.getJustEndedEvents(updateStatesLastCalledTime, now), CommandTagType.END);
 380
 381             // process all Command Tags in all Calendar Events which BEGAN since updateStates was last called
 382             // the END Event tags must be processed before the BEGIN ones
 383             executeEventCommands(calendar.getJustBegunEvents(updateStatesLastCalledTime, now), CommandTagType.BEGIN);
 384
 385             // save time when updateStates was previously called
 386             // the purpose is to prevent repeat command execution of events that have already been executed
 387             updateStatesLastCalledTime = now;
 388         }
 389     }
 390 }