Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

[http] Fixed NPE while executing background thread #5718

Merged
merged 4 commits into from
Dec 12, 2019
Merged

[http] Fixed NPE while executing background thread #5718

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ff2561
Don't execute when the binding is shutting down.
9037568 Dec 25, 2017
4845b3b
Minor cleanup.
9037568 Dec 25, 2017
f41948c
Synchronize to prevent execute() and deactivate() from running
9037568 Jan 28, 2018
be41865
Merge branch 'master' into http
kaikreuzer Dec 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 94 additions & 70 deletions ...org.openhab.binding.http/src/main/java/org/openhab/binding/http/internal/HttpBinding.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

import static org.openhab.binding.http.internal.HttpGenericBindingProvider.CHANGED_COMMAND_KEY;

import java.io.InputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Calendar;
import java.util.Dictionary;
import java.util.Enumeration;
Expand All @@ -28,7 +28,6 @@

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;

import org.openhab.binding.http.HttpBindingProvider;
import org.openhab.core.binding.AbstractActiveBinding;
import org.openhab.core.transform.TransformationException;
Expand All @@ -38,10 +37,8 @@
import org.openhab.core.types.State;
import org.openhab.core.types.Type;
import org.openhab.io.net.http.HttpUtil;

import org.osgi.service.cm.ConfigurationException;
import org.osgi.service.cm.ManagedService;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -88,6 +85,12 @@ public class HttpBinding extends AbstractActiveBinding<HttpBindingProvider> impl
private Map<String, CacheConfig> itemCache = new HashMap<String, CacheConfig>();
private Object itemCacheLock = new Object();

// true when the binding is shutting down
private boolean shuttingDown;

// lock to prevent execute() and deactivate() from running simultaneously
private Object shutdownLock = new Object();

public HttpBinding() {
}

Expand All @@ -106,10 +109,20 @@ protected String getName() {

@Override
public void activate() {
shuttingDown = false;
super.activate();
setProperlyConfigured(true);
}

@Override
public void deactivate() {
synchronized (shutdownLock) {
logger.debug("'deactivate()' called ...");
shuttingDown = true;
super.deactivate();
}
}

protected void addBindingProvider(HttpBindingProvider bindingProvider) {
super.addBindingProvider(bindingProvider);
}
Expand Down Expand Up @@ -139,87 +152,97 @@ public void internalReceiveCommand(String itemName, Command command) {
*/
@Override
public void execute() {
synchronized (shutdownLock) {
logger.debug("'execute()' called ...");

for (HttpBindingProvider provider : providers) {
for (String itemName : provider.getInBindingItemNames()) {
if (shuttingDown) {
logger.debug("Ignoring call to execute(), because binding is shutting down.");
return;
}

String url = provider.getUrl(itemName);
if (format) {
url = String.format(url, Calendar.getInstance().getTime());
}
for (HttpBindingProvider provider : providers) {
for (String itemName : provider.getInBindingItemNames()) {

Properties headers = provider.getHttpHeaders(itemName);
int refreshInterval = provider.getRefreshInterval(itemName);
String transformation = provider.getTransformation(itemName);
String url = provider.getUrl(itemName);
if (format) {
url = String.format(url, Calendar.getInstance().getTime());
}

Long lastUpdateTimeStamp = lastUpdateMap.get(itemName);
if (lastUpdateTimeStamp == null) {
lastUpdateTimeStamp = 0L;
}
Properties headers = provider.getHttpHeaders(itemName);
int refreshInterval = provider.getRefreshInterval(itemName);
String transformation = provider.getTransformation(itemName);

long age = System.currentTimeMillis() - lastUpdateTimeStamp;
boolean needsUpdate = age >= refreshInterval;
Long lastUpdateTimeStamp = lastUpdateMap.get(itemName);
if (lastUpdateTimeStamp == null) {
lastUpdateTimeStamp = 0L;
}

if (!needsUpdate) {
continue;
}
long age = System.currentTimeMillis() - lastUpdateTimeStamp;
boolean needsUpdate = age >= refreshInterval;

String response = null;

// check if special URL is used and data should get from
// cache rather than directly from server
if (isCacheConfig(url)) {
logger.debug("item '{}' is fetched from cache", itemName);
response = getCacheData(url);
} else if (isValidUrl(url)) {
logger.debug("item '{}' is about to be refreshed now", itemName);
response = HttpUtil.executeUrl("GET", url, headers, null, null, timeout);
} else {
logger.debug("item '{}' is not a valid URL or is a cache id yet to be initialised ({})", itemName,
url);
continue;
}
if (!needsUpdate) {
continue;
}

if (response == null) {
logger.error("No response received from '{}'", url);
lastUpdateMap.put(itemName, System.currentTimeMillis());
continue;
}
String response = null;

String transformedResponse;
try {
String[] parts = splitTransformationConfig(transformation);
String transformationType = parts[0];
String transformationFunction = parts[1];

TransformationService transformationService = TransformationHelper
.getTransformationService(HttpActivator.getContext(), transformationType);
if (transformationService != null) {
transformedResponse = transformationService.transform(transformationFunction, response);
// check if special URL is used and data should get from
// cache rather than directly from server
if (isCacheConfig(url)) {
logger.debug("item '{}' is fetched from cache", itemName);
response = getCacheData(url);
} else if (isValidUrl(url)) {
logger.debug("item '{}' is about to be refreshed now", itemName);
response = HttpUtil.executeUrl("GET", url, headers, null, null, timeout);
} else {
logger.debug("item '{}' is not a valid URL or is a cache id yet to be initialised ({})",
itemName, url);
continue;
}

if (response == null) {
logger.error("No response received from '{}'", url);
lastUpdateMap.put(itemName, System.currentTimeMillis());
continue;
}

String transformedResponse;
try {
String[] parts = splitTransformationConfig(transformation);
String transformationType = parts[0];
String transformationFunction = parts[1];

TransformationService transformationService = TransformationHelper
.getTransformationService(HttpActivator.getContext(), transformationType);
if (transformationService != null) {
transformedResponse = transformationService.transform(transformationFunction, response);
} else {
transformedResponse = response;
logger.warn(
"Couldn't transform response because transformationService of type '{}' is unavailable",
transformationType);
}
} catch (TransformationException te) {
logger.warn("Transformation '{}' threw an exception. [response={}]", transformation, response,
te);

// in case of an error we return the response without any
// transformation
transformedResponse = response;
logger.warn(
"Couldn't transform response because transformationService of type '{}' is unavailable",
transformationType);
}
} catch (TransformationException te) {
logger.warn("Transformation '{}' threw an exception. [response={}]", transformation, response, te);

// in case of an error we return the response without any
// transformation
transformedResponse = response;
}
logger.debug("transformed response is '{}'", transformedResponse);

logger.debug("transformed response is '{}'", transformedResponse);
State state = provider.getState(itemName, transformedResponse);
if (state != null) {
eventPublisher.postUpdate(itemName, state);
} else {
logger.debug("Couldn't create state for item '{}' from string '{}'", itemName,
transformedResponse);
}

State state = provider.getState(itemName, transformedResponse);
if (state != null) {
eventPublisher.postUpdate(itemName, state);
} else {
logger.debug("Couldn't create state for item '{}' from string '{}'", itemName, transformedResponse);
lastUpdateMap.put(itemName, System.currentTimeMillis());
}

lastUpdateMap.put(itemName, System.currentTimeMillis());
}
}
}
Expand Down Expand Up @@ -472,7 +495,8 @@ public void updated(Dictionary config) throws ConfigurationException {

// the config-key enumeration contains additional keys that we
// don't want to process here ...
if (CONFIG_TIMEOUT.equals(key) || CONFIG_GRANULARITY.equals(key) || CONFIG_FORMAT.equals(key) || "service.pid".equals(key)) {
if (CONFIG_TIMEOUT.equals(key) || CONFIG_GRANULARITY.equals(key) || CONFIG_FORMAT.equals(key)
|| "service.pid".equals(key)) {
continue;
}

Expand Down