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.persistence.jdbc.internal;
  14
  15 import java.time.ZonedDateTime;
  16 import java.util.ArrayList;
  17 import java.util.HashMap;
  18 import java.util.List;
  19 import java.util.Map;
  20 import java.util.Set;
  21 import java.util.stream.Collectors;
  22
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.knowm.yank.Yank;
  25 import org.openhab.core.i18n.TimeZoneProvider;
  26 import org.openhab.core.items.Item;
  27 import org.openhab.core.persistence.FilterCriteria;
  28 import org.openhab.core.persistence.HistoricItem;
  29 import org.openhab.core.persistence.PersistenceItemInfo;
  30 import org.openhab.core.types.State;
  31 import org.openhab.persistence.jdbc.dto.ItemVO;
  32 import org.openhab.persistence.jdbc.dto.ItemsVO;
  33 import org.openhab.persistence.jdbc.dto.JdbcPersistenceItemInfo;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * Mapper class
  39  *
  40  * @author Helmut Lehmeyer - Initial contribution
  41  */
  42 public class JdbcMapper {
  43     private final Logger logger = LoggerFactory.getLogger(JdbcMapper.class);
  44
  45     private final TimeZoneProvider timeZoneProvider;
  46
  47     // Error counter - used to reconnect to database on error
  48     protected int errCnt;
  49     protected boolean initialized = false;
  50     protected JdbcConfiguration conf = null;
  51     protected final Map<String, String> sqlTables = new HashMap<>();
  52     private long afterAccessMin = 10000;
  53     private long afterAccessMax = 0;
  54     private static final String ITEM_NAME_PATTERN = "[^a-zA-Z_0-9\\-]";
  55
  56     public JdbcMapper(TimeZoneProvider timeZoneProvider) {
  57         this.timeZoneProvider = timeZoneProvider;
  58     }
  59
  60     /*****************
  61      * MAPPER ITEMS *
  62      *****************/
  63     public boolean pingDB() {
  64         logger.debug("JDBC::pingDB");
  65         boolean ret = false;
  66         long timerStart = System.currentTimeMillis();
  67         if (openConnection()) {
  68             if (conf.getDbName() == null) {
  69                 logger.debug(
  70                         "JDBC::pingDB asking db for name as absolutely first db action, after connection is established.");
  71                 String dbName = conf.getDBDAO().doGetDB();
  72                 conf.setDbName(dbName);
  73                 ret = dbName.length() > 0;
  74             } else {
  75                 ret = conf.getDBDAO().doPingDB() > 0;
  76             }
  77         }
  78         logTime("pingDB", timerStart, System.currentTimeMillis());
  79         return ret;
  80     }
  81
  82     public String getDB() {
  83         logger.debug("JDBC::getDB");
  84         long timerStart = System.currentTimeMillis();
  85         String res = conf.getDBDAO().doGetDB();
  86         logTime("pingDB", timerStart, System.currentTimeMillis());
  87         return res;
  88     }
  89
  90     public ItemsVO createNewEntryInItemsTable(ItemsVO vo) {
  91         logger.debug("JDBC::createNewEntryInItemsTable");
  92         long timerStart = System.currentTimeMillis();
  93         Long i = conf.getDBDAO().doCreateNewEntryInItemsTable(vo);
  94         vo.setItemid(i.intValue());
  95         logTime("doCreateNewEntryInItemsTable", timerStart, System.currentTimeMillis());
  96         return vo;
  97     }
  98
  99     public boolean createItemsTableIfNot(ItemsVO vo) {
 100         logger.debug("JDBC::createItemsTableIfNot");
 101         long timerStart = System.currentTimeMillis();
 102         conf.getDBDAO().doCreateItemsTableIfNot(vo);
 103         logTime("doCreateItemsTableIfNot", timerStart, System.currentTimeMillis());
 104         return true;
 105     }
 106
 107     public ItemsVO deleteItemsEntry(ItemsVO vo) {
 108         logger.debug("JDBC::deleteItemsEntry");
 109         long timerStart = System.currentTimeMillis();
 110         conf.getDBDAO().doDeleteItemsEntry(vo);
 111         logTime("deleteItemsEntry", timerStart, System.currentTimeMillis());
 112         return vo;
 113     }
 114
 115     public List<ItemsVO> getItemIDTableNames() {
 116         logger.debug("JDBC::getItemIDTableNames");
 117         long timerStart = System.currentTimeMillis();
 118         List<ItemsVO> vo = conf.getDBDAO().doGetItemIDTableNames(new ItemsVO());
 119         logTime("getItemIDTableNames", timerStart, System.currentTimeMillis());
 120         return vo;
 121     }
 122
 123     public List<ItemsVO> getItemTables() {
 124         logger.debug("JDBC::getItemTables");
 125         long timerStart = System.currentTimeMillis();
 126         ItemsVO vo = new ItemsVO();
 127         vo.setJdbcUriDatabaseName(conf.getDbName());
 128         List<ItemsVO> vol = conf.getDBDAO().doGetItemTables(vo);
 129         logTime("getItemTables", timerStart, System.currentTimeMillis());
 130         return vol;
 131     }
 132
 133     /****************
 134      * MAPPERS ITEM *
 135      ****************/
 136     public void updateItemTableNames(List<ItemVO> vol) {
 137         logger.debug("JDBC::updateItemTableNames");
 138         long timerStart = System.currentTimeMillis();
 139         conf.getDBDAO().doUpdateItemTableNames(vol);
 140         logTime("updateItemTableNames", timerStart, System.currentTimeMillis());
 141     }
 142
 143     public ItemVO createItemTable(ItemVO vo) {
 144         logger.debug("JDBC::createItemTable");
 145         long timerStart = System.currentTimeMillis();
 146         conf.getDBDAO().doCreateItemTable(vo);
 147         logTime("createItemTable", timerStart, System.currentTimeMillis());
 148         return vo;
 149     }
 150
 151     public Item storeItemValue(Item item, State itemState, @Nullable ZonedDateTime date) {
 152         logger.debug("JDBC::storeItemValue: item={} state={} date={}", item, itemState, date);
 153         String tableName = getTable(item);
 154         if (tableName == null) {
 155             logger.error("JDBC::store: Unable to store item '{}'.", item.getName());
 156             return item;
 157         }
 158         long timerStart = System.currentTimeMillis();
 159         if (date == null) {
 160             conf.getDBDAO().doStoreItemValue(item, itemState, new ItemVO(tableName, null));
 161         } else {
 162             conf.getDBDAO().doStoreItemValue(item, itemState, new ItemVO(tableName, null), date);
 163         }
 164         logTime("storeItemValue", timerStart, System.currentTimeMillis());
 165         errCnt = 0;
 166         return item;
 167     }
 168
 169     public List<HistoricItem> getHistItemFilterQuery(FilterCriteria filter, int numberDecimalcount, String table,
 170             Item item) {
 171         logger.debug(
 172                 "JDBC::getHistItemFilterQuery filter='{}' numberDecimalcount='{}' table='{}' item='{}' itemName='{}'",
 173                 (filter != null), numberDecimalcount, table, item, item.getName());
 174         if (table != null) {
 175             long timerStart = System.currentTimeMillis();
 176             List<HistoricItem> result = conf.getDBDAO().doGetHistItemFilterQuery(item, filter, numberDecimalcount,
 177                     table, item.getName(), timeZoneProvider.getTimeZone());
 178             logTime("getHistItemFilterQuery", timerStart, System.currentTimeMillis());
 179             errCnt = 0;
 180             return result;
 181         } else {
 182             logger.error("JDBC::getHistItemFilterQuery: TABLE is NULL; cannot get data from non-existent table.");
 183         }
 184         return null;
 185     }
 186
 187     public boolean deleteItemValues(FilterCriteria filter, String table, Item item) {
 188         logger.debug("JDBC::deleteItemValues filter='{}' table='{}' item='{}' itemName='{}'", (filter != null), table,
 189                 item, item.getName());
 190         if (table != null) {
 191             long timerStart = System.currentTimeMillis();
 192             conf.getDBDAO().doDeleteItemValues(item, filter, table, timeZoneProvider.getTimeZone());
 193             logTime("deleteItemValues", timerStart, System.currentTimeMillis());
 194             errCnt = 0;
 195             return true;
 196         } else {
 197             logger.error("JDBC::deleteItemValues: TABLE is NULL; cannot delete data from non-existent table.");
 198             return false;
 199         }
 200     }
 201
 202     /***********************
 203      * DATABASE CONNECTION *
 204      ***********************/
 205     protected boolean openConnection() {
 206         logger.debug("JDBC::openConnection isDriverAvailable: {}", conf.isDriverAvailable());
 207         if (conf.isDriverAvailable() && !conf.isDbConnected()) {
 208             logger.info("JDBC::openConnection: Driver is available::Yank setupDataSource");
 209             Yank.setupDefaultConnectionPool(conf.getHikariConfiguration());
 210             conf.setDbConnected(true);
 211             return true;
 212         } else if (!conf.isDriverAvailable()) {
 213             logger.warn("JDBC::openConnection: no driver available!");
 214             initialized = false;
 215             return false;
 216         }
 217         return true;
 218     }
 219
 220     protected void closeConnection() {
 221         logger.debug("JDBC::closeConnection");
 222         // Closes all open connection pools
 223         Yank.releaseDefaultConnectionPool();
 224         conf.setDbConnected(false);
 225     }
 226
 227     protected boolean checkDBAccessability() {
 228         // Check if connection is valid
 229         if (initialized) {
 230             return true;
 231         }
 232         // first
 233         boolean p = pingDB();
 234         if (p) {
 235             logger.debug("JDBC::checkDBAcessability, first try connection: {}", p);
 236             return (p && !(conf.getErrReconnectThreshold() > 0 && errCnt <= conf.getErrReconnectThreshold()));
 237         } else {
 238             // second
 239             p = pingDB();
 240             logger.debug("JDBC::checkDBAcessability, second try connection: {}", p);
 241             return (p && !(conf.getErrReconnectThreshold() > 0 && errCnt <= conf.getErrReconnectThreshold()));
 242         }
 243     }
 244
 245     /**************************
 246      * DATABASE TABLEHANDLING *
 247      **************************/
 248     protected void checkDBSchema() {
 249         // Create Items Table if does not exist
 250         createItemsTableIfNot(new ItemsVO());
 251         if (conf.getRebuildTableNames()) {
 252             formatTableNames();
 253             logger.info(
 254                     "JDBC::checkDBSchema: Rebuild complete, configure the 'rebuildTableNames' setting to 'false' to stop rebuilds on startup");
 255         } else {
 256             // Reset the error counter
 257             errCnt = 0;
 258             for (ItemsVO vo : getItemIDTableNames()) {
 259                 sqlTables.put(vo.getItemname(), getTableName(vo.getItemid(), vo.getItemname()));
 260             }
 261         }
 262     }
 263
 264     protected String getTable(Item item) {
 265         int rowId = 0;
 266         ItemsVO isvo;
 267         ItemVO ivo;
 268
 269         String itemName = item.getName();
 270         String tableName = sqlTables.get(itemName);
 271
 272         // Table already exists - return the name
 273         if (tableName != null) {
 274             return tableName;
 275         }
 276
 277         logger.debug("JDBC::getTable: no table found for item '{}' in sqlTables", itemName);
 278
 279         // Create a new entry in items table
 280         isvo = new ItemsVO();
 281         isvo.setItemname(itemName);
 282         isvo = createNewEntryInItemsTable(isvo);
 283         rowId = isvo.getItemid();
 284         if (rowId == 0) {
 285             logger.error("JDBC::getTable: Creating table for item '{}' failed.", itemName);
 286         }
 287         // Create the table name
 288         logger.debug("JDBC::getTable: getTableName with rowId={} itemName={}", rowId, itemName);
 289         tableName = getTableName(rowId, itemName);
 290
 291         // An error occurred adding the item name into the index list!
 292         if (tableName == null) {
 293             logger.error("JDBC::getTable: tableName was null; could not create a table for item '{}'", itemName);
 294             return null;
 295         }
 296
 297         // Create table for item
 298         String dataType = conf.getDBDAO().getDataType(item);
 299         ivo = new ItemVO(tableName, itemName);
 300         ivo.setDbType(dataType);
 301         ivo = createItemTable(ivo);
 302         logger.debug("JDBC::getTable: Table created for item '{}' with dataType {} in SQL database.", itemName,
 303                 dataType);
 304         sqlTables.put(itemName, tableName);
 305
 306         // Check if the new entry is in the table list
 307         // If it's not in the list, then there was an error and we need to do
 308         // some tidying up
 309         // The item needs to be removed from the index table to avoid duplicates
 310         if (sqlTables.get(itemName) == null) {
 311             logger.error("JDBC::getTable: Item '{}' was not added to the table - removing index", itemName);
 312             isvo = new ItemsVO();
 313             isvo.setItemname(itemName);
 314             deleteItemsEntry(isvo);
 315         }
 316
 317         return tableName;
 318     }
 319
 320     private void formatTableNames() {
 321         boolean tmpinit = initialized;
 322         if (tmpinit) {
 323             initialized = false;
 324         }
 325
 326         Map<Integer, String> tableIds = new HashMap<>();
 327
 328         //
 329         for (ItemsVO vo : getItemIDTableNames()) {
 330             String t = getTableName(vo.getItemid(), vo.getItemname());
 331             sqlTables.put(vo.getItemname(), t);
 332             tableIds.put(vo.getItemid(), t);
 333         }
 334
 335         //
 336         List<ItemsVO> al = getItemTables();
 337
 338         String oldName = "";
 339         String newName = "";
 340         List<ItemVO> oldNewTablenames = new ArrayList<>();
 341         for (int i = 0; i < al.size(); i++) {
 342             int id = -1;
 343             oldName = al.get(i).getTable_name();
 344             logger.info("JDBC::formatTableNames: found Table Name= {}", oldName);
 345
 346             if (oldName.startsWith(conf.getTableNamePrefix()) && !oldName.contains("_")) {
 347                 id = Integer.parseInt(oldName.substring(conf.getTableNamePrefix().length()));
 348                 logger.info("JDBC::formatTableNames: found Table with Prefix '{}' Name= {} id= {}",
 349                         conf.getTableNamePrefix(), oldName, (id));
 350             } else if (oldName.contains("_")) {
 351                 id = Integer.parseInt(oldName.substring(oldName.lastIndexOf("_") + 1));
 352                 logger.info("JDBC::formatTableNames: found Table Name= {} id= {}", oldName, (id));
 353             }
 354             logger.info("JDBC::formatTableNames: found Table id= {}", id);
 355
 356             newName = tableIds.get(id);
 357             logger.info("JDBC::formatTableNames: found Table newName= {}", newName);
 358
 359             if (newName != null) {
 360                 if (!oldName.equalsIgnoreCase(newName)) {
 361                     oldNewTablenames.add(new ItemVO(oldName, newName));
 362                     logger.info("JDBC::formatTableNames: Table '{}' will be renamed to '{}'", oldName, newName);
 363                 } else {
 364                     logger.info("JDBC::formatTableNames: Table oldName='{}' newName='{}' nothing to rename", oldName,
 365                             newName);
 366                 }
 367             } else {
 368                 logger.error("JDBC::formatTableNames: Table '{}' could NOT be renamed to '{}'", oldName, newName);
 369                 break;
 370             }
 371         }
 372
 373         updateItemTableNames(oldNewTablenames);
 374         logger.info("JDBC::formatTableNames: Finished updating {} item table names", oldNewTablenames.size());
 375
 376         initialized = tmpinit;
 377     }
 378
 379     private String getTableName(int rowId, String itemName) {
 380         return getTableNamePrefix(itemName) + formatRight(rowId, conf.getTableIdDigitCount());
 381     }
 382
 383     private String getTableNamePrefix(String itemName) {
 384         String name = conf.getTableNamePrefix();
 385         if (conf.getTableUseRealItemNames()) {
 386             // Create the table name with real Item Names
 387             name = (itemName.replaceAll(ITEM_NAME_PATTERN, "") + "_").toLowerCase();
 388         }
 389         return name;
 390     }
 391
 392     public Set<PersistenceItemInfo> getItems() {
 393         // TODO: in general it would be possible to query the count, earliest and latest values for each item too but it
 394         // would be a very costly operation
 395         return sqlTables.keySet().stream().map(itemName -> new JdbcPersistenceItemInfo(itemName))
 396                 .collect(Collectors.<PersistenceItemInfo> toSet());
 397     }
 398
 399     private static String formatRight(final Object value, final int len) {
 400         final String valueAsString = String.valueOf(value);
 401         if (valueAsString.length() < len) {
 402             final StringBuffer result = new StringBuffer(len);
 403             for (int i = len - valueAsString.length(); i > 0; i--) {
 404                 result.append('0');
 405             }
 406             result.append(valueAsString);
 407             return result.toString();
 408         } else {
 409             return valueAsString;
 410         }
 411     }
 412
 413     /*****************
 414      * H E L P E R S *
 415      *****************/
 416     private void logTime(String me, long timerStart, long timerStop) {
 417         if (conf.enableLogTime && logger.isInfoEnabled()) {
 418             conf.timerCount++;
 419             int timerDiff = (int) (timerStop - timerStart);
 420             if (timerDiff < afterAccessMin) {
 421                 afterAccessMin = timerDiff;
 422             }
 423             if (timerDiff > afterAccessMax) {
 424                 afterAccessMax = timerDiff;
 425             }
 426             conf.timeAverage50arr.add(timerDiff);
 427             conf.timeAverage100arr.add(timerDiff);
 428             conf.timeAverage200arr.add(timerDiff);
 429             if (conf.timerCount == 1) {
 430                 conf.timer1000 = System.currentTimeMillis();
 431             }
 432             if (conf.timerCount == 1001) {
 433                 conf.time1000Statements = Math.round(((int) (System.currentTimeMillis() - conf.timer1000)) / 1000);// Seconds
 434                 conf.timerCount = 0;
 435             }
 436             logger.info(
 437                     "JDBC::logTime: '{}':\n afterAccess     = {} ms\n timeAverage50  = {} ms\n timeAverage100 = {} ms\n timeAverage200 = {} ms\n afterAccessMin  = {} ms\n afterAccessMax  = {} ms\n 1000Statements = {} sec\n statementCount = {}\n",
 438                     me, timerDiff, conf.timeAverage50arr.getAverageInteger(),
 439                     conf.timeAverage100arr.getAverageInteger(), conf.timeAverage200arr.getAverageInteger(),
 440                     afterAccessMin, afterAccessMax, conf.time1000Statements, conf.timerCount);
 441         }
 442     }
 443 }