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.exec.internal;
  14
  15 import static java.nio.file.StandardWatchEventKinds.*;
  16
  17 import java.io.IOException;
  18 import java.nio.file.Files;
  19 import java.nio.file.Path;
  20 import java.util.HashSet;
  21 import java.util.Set;
  22 import java.util.stream.Stream;
  23
  24 import org.eclipse.jdt.annotation.NonNullByDefault;
  25 import org.openhab.core.service.WatchService;
  26 import org.osgi.service.component.annotations.Activate;
  27 import org.osgi.service.component.annotations.Component;
  28 import org.osgi.service.component.annotations.Deactivate;
  29 import org.osgi.service.component.annotations.Reference;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 /**
  34  * The {@link ExecWhitelistWatchService} provides a whitelist check for exec commands
  35  *
  36  * @author Jan N. Klug - Initial contribution
  37  */
  38 @Component(service = ExecWhitelistWatchService.class)
  39 @NonNullByDefault
  40 public class ExecWhitelistWatchService implements WatchService.WatchEventListener {
  41     private static final Path COMMAND_WHITELIST_FILE = Path.of("misc", "exec.whitelist");
  42
  43     private final Logger logger = LoggerFactory.getLogger(ExecWhitelistWatchService.class);
  44     private final Set<String> commandWhitelist = new HashSet<>();
  45     private final WatchService watchService;
  46
  47     @Activate
  48     public ExecWhitelistWatchService(
  49             final @Reference(target = WatchService.CONFIG_WATCHER_FILTER) WatchService watchService) {
  50         this.watchService = watchService;
  51         watchService.registerListener(this, COMMAND_WHITELIST_FILE, false);
  52
  53         // read initial content
  54         processWatchEvent(WatchService.Kind.CREATE, COMMAND_WHITELIST_FILE);
  55     }
  56
  57     @Deactivate
  58     public void deactivate() {
  59         watchService.unregisterListener(this);
  60     }
  61
  62     @Override
  63     public void processWatchEvent(WatchService.Kind kind, Path path) {
  64         if (path.endsWith(COMMAND_WHITELIST_FILE)) {
  65             commandWhitelist.clear();
  66             try (Stream<String> lines = Files.lines(path)) {
  67                 lines.filter(line -> !line.trim().startsWith("#")).forEach(commandWhitelist::add);
  68                 logger.debug("Updated command whitelist: {}", commandWhitelist);
  69             } catch (IOException e) {
  70                 logger.warn("Cannot read whitelist file, exec binding commands won't be processed: {}", e.getMessage());
  71             }
  72         }
  73     }
  74
  75     /**
  76      * Check if a command is whitelisted
  77      *
  78      * @param command the command to check alias
  79      * @return true if whitelisted, false if not
  80      */
  81     public boolean isWhitelisted(String command) {
  82         return commandWhitelist.contains(command);
  83     }
  84 }