public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[twitter] rename binding to X (#15809)

Browse Source 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
This commit is contained in:
lsiepel
2023-11-15 09:12:24 +01:00
committed by GitHub
parent ab0ea34d5a
commit 12f02124b6
19 changed files with 228 additions and 274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
bundles/org.openhab.binding.x/src/main/feature/feature.xml Normal file
View File

@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<features name="org.openhab.binding.x-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0">
<repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository>
<feature name="openhab-binding-x" description="X Binding" version="${project.version}">
<feature>openhab-runtime-base</feature>
<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.x/${project.version}</bundle>
</feature>
</features>

34
bundles/org.openhab.binding.x/src/main/java/org/openhab/binding/x/internal/XBindingConstants.java Normal file
View File

@@ -0,0 +1,34 @@
/**
* Copyright (c) 2010-2023 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.x.internal;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.core.thing.ThingTypeUID;
/**
* The {@link XBindingConstants} class defines common constants, which are
* used across the whole binding.
*
* @author Scott Hanson - Initial contribution
*/
@NonNullByDefault
public class XBindingConstants {
private static final String BINDING_ID = "x";
// List of all Thing Type UIDs
public static final ThingTypeUID THING_TYPE_ACCOUNT = new ThingTypeUID(BINDING_ID, "account");
// List of all Channel ids
public static final String CHANNEL_LASTPOST = "lastpost";
}

332
bundles/org.openhab.binding.x/src/main/java/org/openhab/binding/x/internal/XHandler.java Normal file
View File

@@ -0,0 +1,332 @@
/**
* Copyright (c) 2010-2023 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.x.internal;
import static org.openhab.binding.x.internal.XBindingConstants.CHANNEL_LASTPOST;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.x.internal.action.XActions;
import org.openhab.binding.x.internal.config.XConfig;
import org.openhab.core.io.net.http.HttpUtil;
import org.openhab.core.library.types.RawType;
import org.openhab.core.library.types.StringType;
import org.openhab.core.thing.ChannelUID;
import org.openhab.core.thing.Thing;
import org.openhab.core.thing.ThingStatus;
import org.openhab.core.thing.binding.BaseThingHandler;
import org.openhab.core.thing.binding.ThingHandlerService;
import org.openhab.core.types.Command;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import twitter4j.Twitter;
import twitter4j.TwitterException;
import twitter4j.v1.DirectMessage;
import twitter4j.v1.ResponseList;
import twitter4j.v1.Status;
import twitter4j.v1.StatusUpdate;
/**
* The {@link XHandler} is responsible for handling commands, which are
* sent to one of the channels.
*
* @author Scott Hanson - Initial contribution
*/
@NonNullByDefault
public class XHandler extends BaseThingHandler {
private final Logger logger = LoggerFactory.getLogger(XHandler.class);
private XConfig config = new XConfig();
private @Nullable ScheduledFuture<?> refreshTask;
private static final int CHARACTER_LIMIT = 280;
private static @Nullable Twitter client = null;
boolean isProperlyConfigured = false;
public XHandler(Thing thing) {
super(thing);
}
@Override
public void handleCommand(ChannelUID channelUID, Command command) {
}
// creates list of available Actions
@Override
public Collection<Class<? extends ThingHandlerService>> getServices() {
return List.of(XActions.class);
}
@Override
public void initialize() {
config = getConfigAs(XConfig.class);
// create a New X/Twitter Client
Twitter localClient = createClient();
client = localClient;
refresh();// Get latest status
isProperlyConfigured = true;
refreshTask = scheduler.scheduleWithFixedDelay(this::refresh, 0, config.refresh, TimeUnit.MINUTES);
updateStatus(ThingStatus.ONLINE);
}
@Override
public void dispose() {
ScheduledFuture<?> localRefreshTask = refreshTask;
if (localRefreshTask != null) {
localRefreshTask.cancel(true);
}
}
/**
* Internal method for Getting X Status
*
*/
private void refresh() {
try {
if (!checkPrerequisites()) {
return;
}
Twitter localClient = client;
if (localClient != null) {
ResponseList<Status> statuses = localClient.v1().timelines().getUserTimeline();
if (!statuses.isEmpty()) {
updateState(CHANNEL_LASTPOST, StringType.valueOf(statuses.get(0).getText()));
} else {
logger.debug("No Statuses Found");
}
}
} catch (TwitterException e) {
logger.debug("Error when trying to refresh X Account: {}", e.getMessage());
}
}
/**
* Internal method for sending a post, with or without image
*
* @param postTxt
* text string to be sent as a Post
* @param fileToAttach
* the file to attach. May be null if no attached file.
*
* @return <code>true</code>, if sending the post has been successful and
* <code>false</code> in all other cases.
*/
private boolean sendPost(final String postTxt, final @Nullable File fileToAttach) {
if (!checkPrerequisites()) {
return false;
}
// abbreviate the Post to meet the 280 character limit ...
String abbreviatedPostTxt = abbreviateString(postTxt, CHARACTER_LIMIT);
try {
Twitter localClient = client;
if (localClient != null) {
// send the Post
StatusUpdate status = StatusUpdate.of(abbreviatedPostTxt);
if (fileToAttach != null && fileToAttach.isFile()) {
status = status.media(fileToAttach);
}
Status updatedStatus = localClient.v1().tweets().updateStatus(status);
logger.debug("Successfully sent Post '{}'", updatedStatus.getText());
updateState(CHANNEL_LASTPOST, StringType.valueOf(updatedStatus.getText()));
return true;
}
} catch (TwitterException e) {
logger.warn("Failed to send Post '{}' because of : {}", abbreviatedPostTxt, e.getLocalizedMessage());
}
return false;
}
/**
* Sends a standard Post.
*
* @param postTxt
* text string to be sent as a Post
*
* @return <code>true</code>, if sending the post has been successful and
* <code>false</code> in all other cases.
*/
public boolean sendPost(String postTxt) {
if (!checkPrerequisites()) {
return false;
}
return sendPost(postTxt, (File) null);
}
/**
* Sends a Post with an image
*
* @param postTxt
* text string to be sent as a Post
* @param postPicture
* the path of the picture that needs to be attached (either an url,
* either a path pointing to a local file)
*
* @return <code>true</code>, if sending the post has been successful and
* <code>false</code> in all other cases.
*/
public boolean sendPost(String postTxt, String postPicture) {
if (!checkPrerequisites()) {
return false;
}
// prepare the image attachment
File fileToAttach = null;
boolean deleteTemporaryFile = false;
if (postPicture.startsWith("http://") || postPicture.startsWith("https://")) {
try {
// we have a remote url and need to download the remote file to a temporary location
Path tDir = Files.createTempDirectory("TempDirectory");
String path = tDir + File.separator + "openhab-x-remote_attached_file" + "."
+ getExtension(postPicture);
// URL url = new URL(postPicture);
fileToAttach = new File(path);
deleteTemporaryFile = true;
RawType rawPicture = HttpUtil.downloadImage(postPicture);
if (rawPicture != null) {
try (FileOutputStream fos = new FileOutputStream(path)) {
fos.write(rawPicture.getBytes(), 0, rawPicture.getBytes().length);
} catch (FileNotFoundException ex) {
logger.debug("Could not create {} in temp dir. {}", path, ex.getMessage());
} catch (IOException ex) {
logger.debug("Could not write {} to temp dir. {}", path, ex.getMessage());
}
} else {
logger.debug("Could not download post file from {}", postPicture);
}
} catch (IOException ex) {
logger.debug("Could not write {} to temp dir. {}", postPicture, ex.getMessage());
}
} else {
// we have a local file and can just use it directly
fileToAttach = new File(postPicture);
}
if (fileToAttach != null && fileToAttach.isFile()) {
logger.debug("Image '{}' correctly found, will be included in post", postPicture);
} else {
logger.warn("Image '{}' not found, will only post text", postPicture);
}
// send the Post
boolean result = sendPost(postTxt, fileToAttach);
// delete temp file (if needed)
if (deleteTemporaryFile) {
if (fileToAttach != null) {
try {
fileToAttach.delete();
} catch (final Exception ignored) {
return false;
}
}
}
return result;
}
/**
* Sends a DirectMessage
*
* @param recipientId
* recipient ID of the twitter user
* @param messageTxt
* text string to be sent as a Direct Message
*
* @return <code>true</code>, if sending the direct message has been successful and
* <code>false</code> in all other cases.
*/
public boolean sendDirectMessage(String recipientId, String messageTxt) {
if (!checkPrerequisites()) {
return false;
}
try {
Twitter localClient = client;
if (localClient != null) {
// abbreviate the Post to meet the allowed character limit ...
String abbreviatedMessageTxt = abbreviateString(messageTxt, CHARACTER_LIMIT);
// send the direct message
DirectMessage message = localClient.v1().directMessages().sendDirectMessage(recipientId,
abbreviatedMessageTxt);
logger.debug("Successfully sent direct message '{}' to @'{}'", message.getText(),
message.getRecipientId());
return true;
}
} catch (TwitterException e) {
logger.warn("Failed to send Direct Message '{}' because of :'{}'", messageTxt, e.getLocalizedMessage());
}
return false;
}
/**
* check if X account was created with prerequisites
*
* @return <code>true</code>, if X account was initialized
* <code>false</code> in all other cases.
*/
private boolean checkPrerequisites() {
if (client == null) {
logger.debug("X client is not yet configured > execution aborted!");
return false;
}
if (!isProperlyConfigured) {
logger.debug("X client is not yet configured > execution aborted!");
return false;
}
return true;
}
/**
* Creates and returns a Twitter4J Twitter client.
*
* @return a new instance of a Twitter4J Twitter client.
*/
private twitter4j.Twitter createClient() {
Twitter client = Twitter.newBuilder().oAuthConsumer(config.consumerKey, config.consumerSecret)
.oAuthAccessToken(config.accessToken, config.accessTokenSecret).build();
return client;
}
public static String abbreviateString(String input, int maxLength) {
if (input.length() <= maxLength) {
return input;
} else {
return input.substring(0, maxLength);
}
}
public static String getExtension(String filename) {
if (filename.contains(".")) {
return filename.substring(filename.lastIndexOf(".") + 1);
}
return new String();
}
}

55
bundles/org.openhab.binding.x/src/main/java/org/openhab/binding/x/internal/XHandlerFactory.java Normal file
View File

@@ -0,0 +1,55 @@
/**
* Copyright (c) 2010-2023 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.x.internal;
import static org.openhab.binding.x.internal.XBindingConstants.THING_TYPE_ACCOUNT;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.core.thing.Thing;
import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.binding.BaseThingHandlerFactory;
import org.openhab.core.thing.binding.ThingHandler;
import org.openhab.core.thing.binding.ThingHandlerFactory;
import org.osgi.service.component.annotations.Component;
/**
* The {@link XHandlerFactory} is responsible for creating things and thing
* handlers.
*
* @author Scott Hanson - Initial contribution
*/
@NonNullByDefault
@Component(configurationPid = "binding.x", service = ThingHandlerFactory.class)
public class XHandlerFactory extends BaseThingHandlerFactory {
private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(THING_TYPE_ACCOUNT);
@Override
public boolean supportsThingType(ThingTypeUID thingTypeUID) {
return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
}
@Override
protected @Nullable ThingHandler createHandler(Thing thing) {
ThingTypeUID thingTypeUID = thing.getThingTypeUID();
if (THING_TYPE_ACCOUNT.equals(thingTypeUID)) {
return new XHandler(thing);
}
return null;
}
}

124
bundles/org.openhab.binding.x/src/main/java/org/openhab/binding/x/internal/action/XActions.java Normal file
View File

@@ -0,0 +1,124 @@
/**
* Copyright (c) 2010-2023 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.x.internal.action;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.x.internal.XHandler;
import org.openhab.core.automation.annotation.ActionInput;
import org.openhab.core.automation.annotation.ActionOutput;
import org.openhab.core.automation.annotation.RuleAction;
import org.openhab.core.thing.binding.ThingActions;
import org.openhab.core.thing.binding.ThingActionsScope;
import org.openhab.core.thing.binding.ThingHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The {@link XActions} class defines rule actions for sending post
*
* @author Scott Hanson - Initial contribution
*/
@ThingActionsScope(name = "x")
@NonNullByDefault
public class XActions implements ThingActions {
private final Logger logger = LoggerFactory.getLogger(XActions.class);
private @Nullable XHandler handler;
@RuleAction(label = "@text/sendPostActionLabel", description = "@text/sendPostActionDescription")
public @ActionOutput(name = "success", type = "java.lang.Boolean") Boolean sendPost(
@ActionInput(name = "text") @Nullable String text) {
if (text == null) {
logger.warn("Cannot send Post as text is missing.");
return false;
}
final XHandler handler = this.handler;
if (handler == null) {
logger.debug("Handler is null, cannot post.");
return false;
} else {
return handler.sendPost(text);
}
}
@RuleAction(label = "@text/sendAttachmentPostActionLabel", description = "@text/sendAttachmentPostActionDescription")
public @ActionOutput(name = "success", type = "java.lang.Boolean") Boolean sendPostWithAttachment(
@ActionInput(name = "text") @Nullable String text, @ActionInput(name = "url") @Nullable String urlString) {
if (text == null) {
logger.warn("Cannot send Post as text is missing.");
return false;
}
if (urlString == null) {
logger.warn("Cannot send Post as urlString is missing.");
return false;
}
final XHandler handler = this.handler;
if (handler == null) {
logger.debug("Handler is null, cannot post.");
return false;
} else {
return handler.sendPost(text, urlString);
}
}
@RuleAction(label = "@text/sendDirectMessageActionLabel", description = "@text/sendDirectMessageActionDescription")
public @ActionOutput(name = "success", type = "java.lang.Boolean") Boolean sendDirectMessage(
@ActionInput(name = "recipient") @Nullable String recipient,
@ActionInput(name = "text") @Nullable String text) {
if (recipient == null) {
logger.warn("Cannot send Direct Message as recipient is missing.");
return false;
}
if (text == null) {
logger.warn("Cannot send Direct Message as text is missing.");
return false;
}
final XHandler handler = this.handler;
if (handler == null) {
logger.debug("Handler is null, cannot post.");
return false;
} else {
return handler.sendDirectMessage(recipient, text);
}
}
public static boolean sendPost(ThingActions actions, @Nullable String text) {
return ((XActions) actions).sendPost(text);
}
public static boolean sendPostWithAttachment(ThingActions actions, @Nullable String text,
@Nullable String urlString) {
return ((XActions) actions).sendPostWithAttachment(text, urlString);
}
public static boolean sendDirectMessage(ThingActions actions, @Nullable String recipient, @Nullable String text) {
return ((XActions) actions).sendDirectMessage(recipient, text);
}
@Override
public void setThingHandler(@Nullable ThingHandler handler) {
if (handler instanceof XHandler xHandler) {
this.handler = xHandler;
}
}
@Override
public @Nullable ThingHandler getThingHandler() {
return handler;
}
}

30
bundles/org.openhab.binding.x/src/main/java/org/openhab/binding/x/internal/config/XConfig.java Normal file
View File

@@ -0,0 +1,30 @@
/**
* Copyright (c) 2010-2023 Contributors to the openHAB project
*
* See the NOTICE file(s) distributed with this work for additional
* information.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.openhab.binding.x.internal.config;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* The {@link XConfig} class contains fields mapping thing configuration parameters.
*
* @author Scott Hanson - Initial contribution
*/
@NonNullByDefault
public class XConfig {
public String consumerKey = "";
public String consumerSecret = "";
public String accessToken = "";
public String accessTokenSecret = "";
public int refresh = 30;
}

11
bundles/org.openhab.binding.x/src/main/resources/OH-INF/addon/addon.xml Normal file
View File

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<addon:addon id="x" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:addon="https://openhab.org/schemas/addon/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/addon/v1.0.0 https://openhab.org/schemas/addon-1.0.0.xsd">
<type>binding</type>
<name>X Binding</name>
<description>Supports adding Thing for getting the Last Post. Send Posts and Pictures with Actions.</description>
<connection>cloud</connection>
</addon:addon>

32
bundles/org.openhab.binding.x/src/main/resources/OH-INF/i18n/x.properties Normal file
View File

@@ -0,0 +1,32 @@
# add-on
addon.x.name = X Binding
addon.x.description = Supports adding Thing for getting the Last Post. Send Posts and Pictures with Actions.
# thing types
thing-type.x.account.label = X Account
thing-type.x.account.description = Account uses for sending posts
# thing types config
thing-type.config.x.account.accessToken.label = Access Token
thing-type.config.x.account.accessTokenSecret.label = Access Token Secret
thing-type.config.x.account.consumerKey.label = Consumer API Key
thing-type.config.x.account.consumerSecret.label = Consumer API Secret
thing-type.config.x.account.refresh.label = Refresh Time
thing-type.config.x.account.refresh.description = Refresh Time for This Account in Mins
# channel types
channel-type.x.lastpost.label = Last Post
channel-type.x.lastpost.description = Users Last Post
# actions
sendAttachmentPostActionLabel = send a Post with attachment
sendAttachmentPostActionDescription = Sends a Post with an attachment.
sendDirectMessageActionLabel = send a DirectMessage
sendDirectMessageActionDescription = Sends a DirectMessage.
sendPostActionLabel = send a Post
sendPostActionDescription = Sends a Post.

46
bundles/org.openhab.binding.x/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="x" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="account">
<label>X Account</label>
<description>Account uses for sending posts</description>
<channels>
<channel id="lastpost" typeId="lastpost"/>
</channels>
<config-description>
<parameter name="consumerKey" type="text" required="true">
<label>Consumer API Key</label>
<context>password</context>
</parameter>
<parameter name="consumerSecret" type="text" required="true">
<label>Consumer API Secret</label>
<context>password</context>
</parameter>
<parameter name="accessToken" type="text" required="true">
<label>Access Token</label>
<context>password</context>
</parameter>
<parameter name="accessTokenSecret" type="text" required="true">
<label>Access Token Secret</label>
<context>password</context>
</parameter>
<parameter name="refresh" type="integer" required="false" unit="min" min="1">
<label>Refresh Time</label>
<description>Refresh Time for This Account in Mins</description>
<default>30</default>
</parameter>
</config-description>
</thing-type>
<channel-type id="lastpost">
<item-type>String</item-type>
<label>Last Post</label>
<description>Users Last Post</description>
<state readOnly="true"/>
</channel-type>
</thing:thing-descriptions>