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