From f860fe3689a53a47c5c7d9d8339aca5c9c452733 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Wed, 27 Mar 2024 15:37:52 +0100
Subject: [PATCH 01/12] Improve error handling for events and in general
---
src/command_utils/events.rs | 40 +++++++++++
src/command_utils/mod.rs | 1 +
src/commands.rs | 14 ++--
src/main.rs | 134 ++++++++++++++----------------------
src/wrappers.rs | 25 +++----
ts-control | 4 +-
6 files changed, 114 insertions(+), 104 deletions(-)
create mode 100644 src/command_utils/events.rs
create mode 100644 src/command_utils/mod.rs
diff --git a/src/command_utils/events.rs b/src/command_utils/events.rs
new file mode 100644
index 0000000..b4a8773
--- /dev/null
+++ b/src/command_utils/events.rs
@@ -0,0 +1,40 @@
+use telnet::Telnet;
+use crate::commands;
+use crate::models::{Event, EventType};
+use crate::response::Response;
+
+pub fn register_events(connection: &mut Telnet, events: Vec<EventType>) -> Result<(), String> {
+ for event in events {
+ if commands::clientnotifyregister(connection, 1, event).is_err() {
+ return Err(String::from("Failed to register event listener."));
+ }
+ }
+ Ok(())
+}
+
+pub fn handle_event_response(connection: &mut Telnet, response: Response) {
+ if let Response::Event(event_type, params) = response {
+
+ let event = Event::new(connection, event_type, params);
+ match serde_json::to_string(&event) {
+ Ok(json) => println!("{}", json),
+ Err(err) => {
+ // TODO: Handle serialization error
+ eprintln!("Serialization error: {}", err);
+ }
+ }
+
+ }
+}
+
+pub fn loop_response_reader(connection: &mut Telnet) {
+ loop {
+ match commands::read_response(connection, true, String::new()) {
+ Ok(response) => handle_event_response(connection, response),
+ Err(_) => {
+ // print error?
+ return;
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/command_utils/mod.rs b/src/command_utils/mod.rs
new file mode 100644
index 0000000..6226263
--- /dev/null
+++ b/src/command_utils/mod.rs
@@ -0,0 +1 @@
+pub mod events;
\ No newline at end of file
diff --git a/src/commands.rs b/src/commands.rs
index 204e455..f5fdea2 100644
--- a/src/commands.rs
+++ b/src/commands.rs
@@ -1,5 +1,6 @@
+use std::time::Duration;
use crate::utils::SendTextMessageTarget;
-use telnet::Event::Data;
+use telnet::Event::{Data, TimedOut};
use telnet::Telnet;
use crate::models::EventType;
@@ -14,18 +15,21 @@ fn to_single_response(resp: Response) -> Response {
}
fn read_part(connection: &mut Telnet) -> Result<String, String> {
- match connection.read() {
+ match connection.read_timeout(Duration::new(5, 0)) {
Ok(event) => {
match event {
Data(bytes) => Ok(String::from_utf8(bytes.to_vec())
- .map_err(|_| "Teamspeak returned a badly formatted models.")?),
+ .map_err(|_| "Teamspeak returned an invalid response.")?),
+ TimedOut => {
+ Ok(String::new())
+ },
_ => {
Err(String::from("Received unknown event from Teamspeak."))
}
}
}
- Err(_) => {
- Err(String::from("Failed to read from Teamspeak."))
+ Err(err) => {
+ Err(format!("Failed to read from Teamspeak: {}", err))
}
}
}
diff --git a/src/main.rs b/src/main.rs
index 6af36ac..24d8645 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,11 +1,10 @@
-use std::process::exit;
+use std::io::{Error, ErrorKind};
use telnet::Telnet;
use crate::cli::Commands;
-use crate::models::{Channel, Event};
+use crate::models::Channel;
use crate::models::Client;
-use crate::response::Response;
mod wrappers;
mod commands;
@@ -14,41 +13,42 @@ mod cli;
mod utils;
mod models;
mod response;
+mod command_utils;
-fn channel_or_exit(channel_res: Result<Option<Channel>, String>) -> Channel {
- channel_res.unwrap_or_else(|err| {
- println!("Failed to find channel: {}", err);
- exit(1);
- })
- .unwrap_or_else(|| {
- println!("Failed to find channel.");
- exit(1);
- })
+fn channel_or_error(channel_res: Result<Option<Channel>, String>) -> Result<Channel, Error> {
+ channel_res.map_err(|err| make_action_error("find channel", err))?
+ .ok_or_else(|| make_action_error("find channel", String::from("Not Found.")))
}
-fn client_or_exit(client_res: Result<Option<Client>, String>) -> Client {
- client_res.unwrap_or_else(|err| {
- println!("Failed to find client: {}", err);
- exit(1);
- })
- .unwrap_or_else(|| {
- println!("Failed to find client.");
- exit(1);
- })
+fn client_or_error(client_res: Result<Option<Client>, String>) -> Result<Client, Error> {
+ client_res.map_err(|err| make_action_error("find client", err))?
+ .ok_or_else(|| make_action_error("find client", String::from("Not Found.")))
}
-fn main() {
+fn connect() -> Result<Telnet, Error> {
+ let mut connection = Telnet::connect(("127.0.0.1", 25639), 512 * 1024)
+ .map_err(|_| Error::new(ErrorKind::AddrNotAvailable, String::from("Failed to connect to Teamspeak.")))?;
+
+ wrappers::skip_welcome(&mut connection)
+ .map_err(to_other_error)?;
+ wrappers::login(&mut connection)
+ .map_err(|msg| Error::new(ErrorKind::PermissionDenied, msg))?;
+
+ Ok(connection)
+}
+
+fn to_other_error(msg: String) -> Error {
+ Error::new(ErrorKind::Other, msg)
+}
+
+fn make_action_error(action: &str, msg: String) -> Error {
+ Error::new(ErrorKind::Other, format!("Failed to {}: {}", action, msg))
+}
+
+fn main() -> Result<(), Error> {
let cli = cli::init();
- let connection = Telnet::connect(("127.0.0.1", 25639), 512 * 1024);
- if connection.is_err() {
- println!("Failed to connect to Teamspeak.");
- exit(1);
- }
- let mut connection = connection.unwrap();
-
- wrappers::skip_welcome(&mut connection);
- wrappers::login(&mut connection);
+ let mut connection = connect()?;
// You can check for the existence of subcommands, and if found use their
// matches just as you would the top level cmd
@@ -61,8 +61,7 @@ fn main() {
}
}
Err(msg) => {
- println!("Failed to get channels: {}", msg);
- exit(1);
+ return Err(make_action_error("get channels", msg));
}
}
}
@@ -75,71 +74,62 @@ fn main() {
}
}
Err(msg) => {
- println!("Failed to get clients: {}", msg);
- exit(1);
+ return Err(make_action_error("get clients", msg));
}
}
}
Commands::Fetch(args) => {
if args.want_client() && args.want_channel() {
- println!("Fetching both clients and channels is not supported.");
- exit(1);
+ return Err(Error::new(ErrorKind::InvalidInput, "Fetching both clients and channels is not supported."));
}
if !args.want_client() && !args.want_channel() {
- println!("No clients or channels specified.");
- exit(1);
+ return Err(Error::new(ErrorKind::InvalidInput, "No clients or channels specified."));
}
if args.want_client() {
- let client = client_or_exit(args.client(&mut connection));
+ let client = client_or_error(args.client(&mut connection))?;
match wrappers::fetch_client(&mut connection, &[client]) {
Ok(_) => println!("Successfully fetched client."),
Err(msg) => {
- println!("Failed to fetch client: {}", msg);
- exit(1);
+ return Err(make_action_error("fetch client", msg));
}
}
}
if args.want_channel() {
- let channel = channel_or_exit(args.channel(&mut connection));
+ let channel = channel_or_error(args.channel(&mut connection))?;
match wrappers::fetch_channel(&mut connection, channel) {
Ok(_) => println!("Successfully fetched channel."),
Err(msg) => {
- println!("Failed to fetch channel: {}", msg);
- exit(1);
+ return Err(make_action_error("fetch channel", msg));
}
}
}
}
Commands::Message(args) => {
- let target = args.target(&mut connection).unwrap_or_else(|err| {
- println!("Failed to get message target: {}", err);
- exit(1);
- });
+ let target = args.target(&mut connection)
+ .map_err(|msg| make_action_error("message target", msg))?;
match wrappers::send_text_message(&mut connection, target, args.message) {
Ok(_) => println!("Successfully sent message."),
Err(msg) => {
- println!("Failed to send message: {}", msg);
- exit(1);
+ return Err(make_action_error("send message", msg));
}
}
}
Commands::Move(args) => {
- let channel = channel_or_exit(args.channel(&mut connection));
- let client = client_or_exit(args.client(&mut connection));
+ let channel = channel_or_error(args.channel(&mut connection))?;
+ let client = client_or_error(args.client(&mut connection))?;
match wrappers::move_client(&mut connection, &channel, &[client]) {
Ok(resp) => println!("Successfully moved client: {}", resp),
Err(msg) => {
- println!("Failed to move client: {}", msg);
- exit(1);
+ return Err(make_action_error("move client", msg));
}
}
}
@@ -148,40 +138,22 @@ fn main() {
match wrappers::update_client(&mut connection, args.to_parameter_list()) {
Ok(_) => println!("Successfully updated client."),
Err(msg) => {
- println!("Failed to update client: {}", msg);
- exit(1);
+ return Err(make_action_error("update client", msg));
}
}
}
Commands::Events(args) => {
- for event in args.event {
- if commands::clientnotifyregister(&mut connection, 1, event).is_err() {
- println!("Failed to register event listener.");
- exit(1);
- }
- }
-
loop {
- match commands::read_response(&mut connection, true, String::new()) {
- Ok(response) => {
- if let Response::Event(event_type, params) = response {
+ command_utils::events::register_events(&mut connection, args.event.clone())
+ .map_err(to_other_error)?;
+ command_utils::events::loop_response_reader(&mut connection);
- let event = Event::new(&mut connection, event_type, params);
- match serde_json::to_string(&event) {
- Ok(json) => println!("{}", json),
- Err(_) => {
- // TODO: Handle error
- }
- }
-
- }
- }
- Err(_) => {
- // TODO: Handle error
- }
- }
+ // loop_response_reader failed. Let's try to reconnect after 1 second.
+ std::thread::sleep(std::time::Duration::from_secs(1));
+ connection = connect()?;
}
}
}
+ Ok(())
}
\ No newline at end of file
diff --git a/src/wrappers.rs b/src/wrappers.rs
index 9c50680..fd9f64f 100644
--- a/src/wrappers.rs
+++ b/src/wrappers.rs
@@ -1,4 +1,3 @@
-use std::process::exit;
use std::time::Duration;
use telnet::Event::TimedOut;
@@ -11,34 +10,28 @@ use crate::models::Client;
use crate::response::Response;
use crate::utils::SendTextMessageTarget;
-pub fn skip_welcome(connection: &mut Telnet) {
+pub fn skip_welcome(connection: &mut Telnet) -> Result<(), String> {
loop {
let event_result = connection.read_timeout(Duration::from_millis(100));
match event_result {
Ok(event) => {
if let TimedOut = event {
- break;
+ return Ok(());
}
}
- Err(_) => println!("Failed to read from Teamspeak."),
+ Err(_) => return Err(String::from("Failed to read from Teamspeak.")),
}
}
}
-pub fn login(connection: &mut Telnet) {
+pub fn login(connection: &mut Telnet) -> Result<(), String> {
// read api key from environment variable
- let apikey = std::env::var("TS3_CLIENT_API_KEY").unwrap_or_else(|_| {
- println!("No API key found in environment variable TS3_CLIENT_API_KEY.");
- exit(1);
- });
+ let apikey = std::env::var("TS3_CLIENT_API_KEY")
+ .map_err(|_| String::from("No API key found in environment variable TS3_CLIENT_API_KEY."))?;
- match commands::login(connection, &apikey) {
- Ok(_) => {}
- Err(msg) => {
- println!("Failed to authenticate with Teamspeak: {}", msg);
- exit(1);
- }
- }
+ commands::login(connection, &apikey)
+ .map(|_| ())
+ .map_err(|err| format!("Failed to authenticate with Teamspeak: {}", err))
}
pub fn get_channels(connection: &mut Telnet, spacers: bool) -> Result<Vec<Channel>, String> {
diff --git a/ts-control b/ts-control
index 5f26108..462cb7c 100755
--- a/ts-control
+++ b/ts-control
@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
actions="quick
move
@@ -101,5 +101,5 @@ case $action in
"events-move")
teamspeak-query-lib events NotifyClientMoved NotifyClientEnterView \
| jq -r --unbuffered '.client.client_nickname + " joined " + .channel.channel_name // "the server"' \
- | xargs -I{} notify-send "TS3 movement" "{}"
+ | tee >(xargs -I{} notify-send "TS3 movement" "{}")
esac
From ae411b6dcc24e5a92bc3a684c52c7941f6d04d64 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Wed, 10 Apr 2024 17:36:51 +0200
Subject: [PATCH 02/12] Improve events
Add known clients (cache) for leaving clients
Add message to returned json object
---
Cargo.lock | 2 +-
Cargo.toml | 2 +-
src/command_utils/events.rs | 14 +++--
src/models/client.rs | 2 +-
src/models/event.rs | 109 ++++++++++++++++++++++++++++++++----
src/parameter.rs | 2 +-
ts-control | 10 ++--
7 files changed, 117 insertions(+), 24 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index 2e5639b..c66e204 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -182,7 +182,7 @@ dependencies = [
[[package]]
name = "teamspeak-query-lib"
-version = "0.1.2"
+version = "0.1.4"
dependencies = [
"clap",
"serde",
diff --git a/Cargo.toml b/Cargo.toml
index 8930810..abc17c0 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "teamspeak-query-lib"
-version = "0.1.2"
+version = "0.1.4"
edition = "2021"
[dependencies]
diff --git a/src/command_utils/events.rs b/src/command_utils/events.rs
index b4a8773..00ccaca 100644
--- a/src/command_utils/events.rs
+++ b/src/command_utils/events.rs
@@ -1,6 +1,6 @@
use telnet::Telnet;
-use crate::commands;
-use crate::models::{Event, EventType};
+use crate::{commands, wrappers};
+use crate::models::{Client, Event, EventType};
use crate::response::Response;
pub fn register_events(connection: &mut Telnet, events: Vec<EventType>) -> Result<(), String> {
@@ -12,10 +12,10 @@ pub fn register_events(connection: &mut Telnet, events: Vec<EventType>) -> Resul
Ok(())
}
-pub fn handle_event_response(connection: &mut Telnet, response: Response) {
+pub fn handle_event_response(connection: &mut Telnet, response: Response, known_clients: &mut Vec<Client>) {
if let Response::Event(event_type, params) = response {
- let event = Event::new(connection, event_type, params);
+ let event = Event::new(connection, event_type, params, &known_clients);
match serde_json::to_string(&event) {
Ok(json) => println!("{}", json),
Err(err) => {
@@ -24,13 +24,17 @@ pub fn handle_event_response(connection: &mut Telnet, response: Response) {
}
}
+ if let Ok(new_clients) = wrappers::get_clients(connection) {
+ *known_clients = new_clients;
+ }
}
}
pub fn loop_response_reader(connection: &mut Telnet) {
+ let mut known_clients = wrappers::get_clients(connection).unwrap_or_else(|_| Vec::new());
loop {
match commands::read_response(connection, true, String::new()) {
- Ok(response) => handle_event_response(connection, response),
+ Ok(response) => handle_event_response(connection, response, &mut known_clients),
Err(_) => {
// print error?
return;
diff --git a/src/models/client.rs b/src/models/client.rs
index fe38e06..41351e9 100644
--- a/src/models/client.rs
+++ b/src/models/client.rs
@@ -3,7 +3,7 @@ use serde::{Deserialize, Serialize};
use crate::parameter::{parameter_find, ParameterList};
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct Client {
pub cid: i32,
pub clid: i32,
diff --git a/src/models/event.rs b/src/models/event.rs
index 1d383c8..50360bd 100644
--- a/src/models/event.rs
+++ b/src/models/event.rs
@@ -1,7 +1,8 @@
use std::fmt::{Display, Formatter};
use std::str::FromStr;
-use serde::{Deserialize, Serialize};
+use serde::{Deserialize, Serialize, Serializer};
+use serde::ser::SerializeStruct;
use telnet::Telnet;
use crate::models::{Channel, Client};
@@ -43,7 +44,7 @@ pub enum EventType {
NotifyConnectStatusChange,
}
-#[derive(Serialize, Deserialize, Debug)]
+#[derive(Debug)]
pub struct Event {
pub event_type: EventType,
pub params: ParameterList,
@@ -152,36 +153,58 @@ impl Display for EventType {
}
impl EventType {
+
+ pub fn find_channel(&self, connection: &mut Telnet, params: &ParameterList, param_name: &str) -> Option<Channel> {
+ let id = parameter_find(params, param_name)?
+ .parse::<i32>().unwrap_or(0);
+ wrappers::find_channel(connection, "cid", &id.to_string(), true).unwrap().or(None)
+ }
pub fn get_channel(&self, connection: &mut Telnet, params: &ParameterList) -> Option<Channel> {
match self {
EventType::NotifyClientMoved => {
- let id = parameter_find(params, "ctid")?
- .parse::<i32>().unwrap_or(0);
- wrappers::find_channel(connection, "cid", &id.to_string(), true).unwrap().or(None)
+ self.find_channel(connection, params, "ctid")
}
_ => None,
}
}
+ pub fn find_client(&self, connection: &mut Telnet, params: &ParameterList, param_name: &str) -> Option<Client> {
+ let id = parameter_find(params, param_name)?
+ .parse::<i32>().unwrap_or(0);
+ wrappers::find_client(connection, "clid", &id.to_string(), true).unwrap().or(None)
+ }
+
pub fn get_client(&self, connection: &mut Telnet, params: &ParameterList) -> Option<Client> {
match self {
EventType::NotifyClientMoved => {
- let id = parameter_find(params, "clid")?
- .parse::<i32>().unwrap_or(0);
- wrappers::find_client(connection, "clid", &id.to_string(), true).unwrap().or(None)
+ self.find_client(connection, params, "clid")
}
EventType::NotifyClientEnterView => {
Some(Client::from(params.clone()))
}
+ EventType::NotifyTextMessage => {
+ self.find_client(connection, params, "invokerid")
+ }
+ EventType::NotifyClientPoke => {
+ self.find_client(connection, params, "invokerid")
+ }
_ => None,
}
}
}
impl Event {
- pub fn new(connection: &mut Telnet, event_type: EventType, params: ParameterList) -> Event {
+ pub fn new(connection: &mut Telnet, event_type: EventType, params: ParameterList, known_clients: &[Client]) -> Event {
let channel = event_type.get_channel(connection, ¶ms);
- let client = event_type.get_client(connection, ¶ms);
+ let mut client = event_type.get_client(connection, ¶ms);
+
+ if client.is_none() {
+ let id = parameter_find(¶ms, "clid")
+ .unwrap_or_else(|| String::from("0"))
+ .parse::<i32>().unwrap_or(0);
+ let client_id = id.to_string();
+ client = known_clients.iter().find(|c| c.clid.to_string() == client_id).cloned();
+ }
Event {
event_type,
@@ -190,4 +213,70 @@ impl Event {
client,
}
}
+
+ pub fn get_client_name(&self) -> String {
+ match &self.client {
+ Some(client) => client.client_nickname.clone(),
+ None => String::from("UNKNOWN"),
+ }
+ }
+
+ pub fn get_channel_name(&self) -> String {
+ match &self.channel {
+ Some(channel) => channel.channel_name.clone(),
+ None => String::from("UNKNOWN"),
+ }
+ }
+
+ pub fn get_event_msg(&self) -> String {
+ parameter_find(&self.params, "msg").unwrap_or_else(|| String::from(""))
+ }
+
+ pub fn get_message(&self) -> String {
+ match &self.event_type {
+ EventType::NotifyClientPoke => {
+ format!("{}: {}",
+ self.get_client_name(),
+ self.get_event_msg()
+ )
+ }
+ EventType::NotifyTextMessage => {
+ format!("{}: {}",
+ self.get_client_name(),
+ self.get_event_msg()
+ )
+ }
+ EventType::NotifyClientMoved => {
+ format!("{} joined {}",
+ self.get_client_name(),
+ self.get_channel_name()
+ )
+ }
+ EventType::NotifyClientLeftView => {
+ format!("{} left",
+ self.get_client_name()
+ )
+ }
+ EventType::NotifyClientEnterView => {
+ format!("{} connected",
+ self.get_client_name()
+ )
+ }
+ _ => String::from(""),
+ }
+ }
+}
+
+impl Serialize for Event {
+ fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+ where
+ S: Serializer,
+ {
+ let mut x = serializer.serialize_struct("Event", 4)?;
+ x.serialize_field("type", &self.event_type)?;
+ x.serialize_field("channel", &self.channel)?;
+ x.serialize_field("client", &self.client)?;
+ x.serialize_field("message", &self.get_message())?;
+ x.end()
+ }
}
\ No newline at end of file
diff --git a/src/parameter.rs b/src/parameter.rs
index 6424ecb..206412b 100644
--- a/src/parameter.rs
+++ b/src/parameter.rs
@@ -44,7 +44,7 @@ pub fn parameter_parse(params_str: &str) -> ParameterList {
let mut response_params = ParameterList::new();
parts.iter().for_each(|part| {
- let (key, value) = part.split_once('=').unwrap_or((part, "1"));
+ let (key, value) = part.split_once('=').unwrap_or((part, ""));
response_params.insert(key.to_string(), decode_value(value));
});
diff --git a/ts-control b/ts-control
index 462cb7c..31adc4e 100755
--- a/ts-control
+++ b/ts-control
@@ -9,7 +9,7 @@ not away
back
message
message-user
-events-move"
+events"
_ts_control_get_entity() {
entity=$(_ts_control_single_or_dmenu "$(teamspeak-query-lib "$1s")" "$2")
@@ -98,8 +98,8 @@ case $action in
message=$(_ts_control_get_message "$3")
teamspeak-query-lib message --strict-client --client "$user" "$message"
;;
- "events-move")
- teamspeak-query-lib events NotifyClientMoved NotifyClientEnterView \
- | jq -r --unbuffered '.client.client_nickname + " joined " + .channel.channel_name // "the server"' \
- | tee >(xargs -I{} notify-send "TS3 movement" "{}")
+ "events")
+ teamspeak-query-lib events NotifyClientMoved NotifyClientEnterView NotifyClientLeftView NotifyTextMessage NotifyClientPoke \
+ | jq -r --unbuffered '.message' \
+ | tee >(xargs -I{} notify-send "TS3 Event" "{}")
esac
From ea7815535c8e437852bbf1cdba88d61534b1be03 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Wed, 10 Apr 2024 17:40:51 +0200
Subject: [PATCH 03/12] Fix clippy issues
---
src/command_utils/events.rs | 2 +-
src/parameter.rs | 8 ++++----
src/response.rs | 6 +++---
3 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/src/command_utils/events.rs b/src/command_utils/events.rs
index 00ccaca..8e3e585 100644
--- a/src/command_utils/events.rs
+++ b/src/command_utils/events.rs
@@ -15,7 +15,7 @@ pub fn register_events(connection: &mut Telnet, events: Vec<EventType>) -> Resul
pub fn handle_event_response(connection: &mut Telnet, response: Response, known_clients: &mut Vec<Client>) {
if let Response::Event(event_type, params) = response {
- let event = Event::new(connection, event_type, params, &known_clients);
+ let event = Event::new(connection, event_type, params, known_clients);
match serde_json::to_string(&event) {
Ok(json) => println!("{}", json),
Err(err) => {
diff --git a/src/parameter.rs b/src/parameter.rs
index 206412b..b2476a0 100644
--- a/src/parameter.rs
+++ b/src/parameter.rs
@@ -5,7 +5,7 @@ pub type ParameterList = HashMap<String, String>;
pub type Parameter = (String, String);
pub fn parameter_find(params: &ParameterList, name: &str) -> Option<String> {
- params.get(name).map(|value| value.clone())
+ params.get(name).cloned()
}
pub fn parameter_list_has(params: &ParameterList, key: &str, value: &str, strict: bool) -> bool {
@@ -17,7 +17,7 @@ pub fn parameter_list_has(params: &ParameterList, key: &str, value: &str, strict
return true;
}
}
- return false;
+ false
}
pub fn parameter_list_find(param_lists: &Vec<ParameterList>, key: &str, value: &str, strict: bool) -> Option<ParameterList> {
@@ -58,7 +58,7 @@ pub fn parameter_to_string(param: Parameter) -> String {
pub fn parameter_list_to_string(parameter_list: ParameterList, sep: &str) -> String {
parameter_list
.into_iter()
- .map(|param| parameter_to_string(param))
+ .map(parameter_to_string)
.collect::<Vec<String>>()
.join(sep)
}
@@ -66,7 +66,7 @@ pub fn parameter_list_to_string(parameter_list: ParameterList, sep: &str) -> Str
pub fn parameters_to_string(parameters: Vec<Parameter>, sep: &str) -> String {
parameters
.into_iter()
- .map(|param| parameter_to_string(param))
+ .map(parameter_to_string)
.collect::<Vec<String>>()
.join(sep)
}
\ No newline at end of file
diff --git a/src/response.rs b/src/response.rs
index aed60d2..7901fa5 100644
--- a/src/response.rs
+++ b/src/response.rs
@@ -45,7 +45,7 @@ fn get_response_type(type_str: &str) -> Result<ResponseType, String> {
return Ok(ResponseType::Event(event_type));
}
- return Ok(ResponseType::Unknown);
+ Ok(ResponseType::Unknown)
}
impl TryFrom<String> for Response {
@@ -54,7 +54,7 @@ impl TryFrom<String> for Response {
fn try_from(response_str: String) -> Result<Self, ResponseError> {
let response_str = response_str.trim_end_matches("\n\r");
- let (rsp_type, rsp_params) = split_type_and_params(&response_str)
+ let (rsp_type, rsp_params) = split_type_and_params(response_str)
.map_err(|err| ResponseError {
id: -1,
msg: err,
@@ -66,7 +66,7 @@ impl TryFrom<String> for Response {
parameter_lists.push(response_params);
}
- return match rsp_type {
+ match rsp_type {
ResponseType::Error => {
Err(ResponseError::create_error(¶meter_lists[0]))
}
From 70e0a1d0b45c1645235dcd39ae617cbe3a45d7a0 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Mon, 15 Apr 2024 14:23:09 +0200
Subject: [PATCH 04/12] Fix events caused by yourself being shown
---
Cargo.lock | 2 +-
Cargo.toml | 2 +-
src/command_utils/events.rs | 40 +++++++++++++++++++++++--------------
src/main.rs | 9 ++++++++-
src/wrappers.rs | 2 +-
5 files changed, 36 insertions(+), 19 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
index c66e204..c541dfd 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -182,7 +182,7 @@ dependencies = [
[[package]]
name = "teamspeak-query-lib"
-version = "0.1.4"
+version = "0.1.5"
dependencies = [
"clap",
"serde",
diff --git a/Cargo.toml b/Cargo.toml
index abc17c0..78a7388 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "teamspeak-query-lib"
-version = "0.1.4"
+version = "0.1.5"
edition = "2021"
[dependencies]
diff --git a/src/command_utils/events.rs b/src/command_utils/events.rs
index 8e3e585..6689a3f 100644
--- a/src/command_utils/events.rs
+++ b/src/command_utils/events.rs
@@ -1,4 +1,5 @@
use telnet::Telnet;
+
use crate::{commands, wrappers};
use crate::models::{Client, Event, EventType};
use crate::response::Response;
@@ -12,29 +13,38 @@ pub fn register_events(connection: &mut Telnet, events: Vec<EventType>) -> Resul
Ok(())
}
-pub fn handle_event_response(connection: &mut Telnet, response: Response, known_clients: &mut Vec<Client>) {
- if let Response::Event(event_type, params) = response {
-
- let event = Event::new(connection, event_type, params, known_clients);
- match serde_json::to_string(&event) {
- Ok(json) => println!("{}", json),
- Err(err) => {
- // TODO: Handle serialization error
- eprintln!("Serialization error: {}", err);
- }
+pub fn handle_event_response(connection: &mut Telnet, event: Event, known_clients: &mut Vec<Client>) {
+ match serde_json::to_string(&event) {
+ Ok(json) => println!("{}", json),
+ Err(err) => {
+ // TODO: Handle serialization error
+ eprintln!("Serialization error: {}", err);
}
+ }
- if let Ok(new_clients) = wrappers::get_clients(connection) {
- *known_clients = new_clients;
- }
+ if let Ok(new_clients) = wrappers::get_clients(connection) {
+ *known_clients = new_clients;
}
}
-pub fn loop_response_reader(connection: &mut Telnet) {
+pub fn loop_response_reader(connection: &mut Telnet, self_clid: i32) {
let mut known_clients = wrappers::get_clients(connection).unwrap_or_else(|_| Vec::new());
+
loop {
match commands::read_response(connection, true, String::new()) {
- Ok(response) => handle_event_response(connection, response, &mut known_clients),
+ Ok(response) => {
+ if let Response::Event(event_type, params) = response {
+ let event = Event::new(connection, event_type, params, &known_clients);
+
+ if let Some(client) = &event.client {
+ if client.clid == self_clid {
+ continue;
+ }
+ }
+
+ handle_event_response(connection, event, &mut known_clients);
+ }
+ }
Err(_) => {
// print error?
return;
diff --git a/src/main.rs b/src/main.rs
index 24d8645..5ada48b 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,4 +1,5 @@
use std::io::{Error, ErrorKind};
+use std::num::ParseIntError;
use telnet::Telnet;
@@ -147,7 +148,13 @@ fn main() -> Result<(), Error> {
loop {
command_utils::events::register_events(&mut connection, args.event.clone())
.map_err(to_other_error)?;
- command_utils::events::loop_response_reader(&mut connection);
+
+ let self_clid: i32 = wrappers::get_self_clid(&mut connection)
+ .map_err(|msg| make_action_error("get self clid", msg))?
+ .parse()
+ .map_err(|err: ParseIntError| make_action_error("parse clid", err.to_string()))?;
+
+ command_utils::events::loop_response_reader(&mut connection, self_clid);
// loop_response_reader failed. Let's try to reconnect after 1 second.
std::thread::sleep(std::time::Duration::from_secs(1));
diff --git a/src/wrappers.rs b/src/wrappers.rs
index fd9f64f..546cd86 100644
--- a/src/wrappers.rs
+++ b/src/wrappers.rs
@@ -110,7 +110,7 @@ pub fn get_channel_clients(connection: &mut Telnet, channel: &Channel) -> Result
}
}
-fn get_self_clid(connection: &mut Telnet) -> Result<String, String> {
+pub fn get_self_clid(connection: &mut Telnet) -> Result<String, String> {
match commands::whoami(connection)? {
Response::Data(params) => {
match parameter::parameter_find(¶ms, "clid") {
From 895f5f9373f3afde98c40c151d114e626344d203 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Mon, 3 Jun 2024 01:11:05 +0200
Subject: [PATCH 05/12] Fix some small issues
Don't crash without self_clid
Improve functions in main.rs
---
Makefile | 4 +++-
src/command_utils/events.rs | 19 ++++++++++++++++---
src/main.rs | 30 +++++++++---------------------
3 files changed, 28 insertions(+), 25 deletions(-)
diff --git a/Makefile b/Makefile
index a45ec9f..6383dc1 100644
--- a/Makefile
+++ b/Makefile
@@ -2,11 +2,13 @@
INSTALL_DIR = $(HOME)/.local/bin
+export PATH := target/debug:$(PATH)
+
build:
@cargo build
run: build
- @PATH=$(PWD)/target/debug:$(PATH) ./ts-control
+ ./ts-control
install:
mkdir -p "$(INSTALL_DIR)"
diff --git a/src/command_utils/events.rs b/src/command_utils/events.rs
index 6689a3f..9e6f35e 100644
--- a/src/command_utils/events.rs
+++ b/src/command_utils/events.rs
@@ -27,9 +27,19 @@ pub fn handle_event_response(connection: &mut Telnet, event: Event, known_client
}
}
-pub fn loop_response_reader(connection: &mut Telnet, self_clid: i32) {
+fn try_get_self_clid(connection: &mut Telnet) -> Option<i32> {
+ wrappers::get_self_clid(connection)
+ .unwrap_or_default()
+ .parse()
+ .map(Some)
+ .unwrap_or(None)
+}
+
+pub fn loop_response_reader(connection: &mut Telnet) {
let mut known_clients = wrappers::get_clients(connection).unwrap_or_else(|_| Vec::new());
-
+
+ let mut self_clid: Option<i32> = try_get_self_clid(connection);
+
loop {
match commands::read_response(connection, true, String::new()) {
Ok(response) => {
@@ -37,7 +47,10 @@ pub fn loop_response_reader(connection: &mut Telnet, self_clid: i32) {
let event = Event::new(connection, event_type, params, &known_clients);
if let Some(client) = &event.client {
- if client.clid == self_clid {
+ if self_clid.is_none() {
+ self_clid = try_get_self_clid(connection);
+ }
+ if Some(client.clid) == self_clid {
continue;
}
}
diff --git a/src/main.rs b/src/main.rs
index 5ada48b..ac3fdf4 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,11 +1,8 @@
use std::io::{Error, ErrorKind};
-use std::num::ParseIntError;
use telnet::Telnet;
use crate::cli::Commands;
-use crate::models::Channel;
-use crate::models::Client;
mod wrappers;
mod commands;
@@ -16,14 +13,10 @@ mod models;
mod response;
mod command_utils;
-fn channel_or_error(channel_res: Result<Option<Channel>, String>) -> Result<Channel, Error> {
- channel_res.map_err(|err| make_action_error("find channel", err))?
- .ok_or_else(|| make_action_error("find channel", String::from("Not Found.")))
-}
-
-fn client_or_error(client_res: Result<Option<Client>, String>) -> Result<Client, Error> {
- client_res.map_err(|err| make_action_error("find client", err))?
- .ok_or_else(|| make_action_error("find client", String::from("Not Found.")))
+fn result_or_error<T>(res: Result<Option<T>, String>, result_type: &str) -> Result<T, Error> {
+ let error_action = format!("find {}", result_type);
+ res.map_err(|err| make_action_error(&error_action, err))?
+ .ok_or_else(|| make_action_error(&error_action, String::from("Not Found.")))
}
fn connect() -> Result<Telnet, Error> {
@@ -89,7 +82,7 @@ fn main() -> Result<(), Error> {
}
if args.want_client() {
- let client = client_or_error(args.client(&mut connection))?;
+ let client = result_or_error(args.client(&mut connection), "client")?;
match wrappers::fetch_client(&mut connection, &[client]) {
Ok(_) => println!("Successfully fetched client."),
@@ -100,7 +93,7 @@ fn main() -> Result<(), Error> {
}
if args.want_channel() {
- let channel = channel_or_error(args.channel(&mut connection))?;
+ let channel = result_or_error(args.channel(&mut connection), "channel")?;
match wrappers::fetch_channel(&mut connection, channel) {
Ok(_) => println!("Successfully fetched channel."),
@@ -124,8 +117,8 @@ fn main() -> Result<(), Error> {
}
Commands::Move(args) => {
- let channel = channel_or_error(args.channel(&mut connection))?;
- let client = client_or_error(args.client(&mut connection))?;
+ let channel = result_or_error(args.channel(&mut connection), "channel")?;
+ let client = result_or_error(args.client(&mut connection), "client")?;
match wrappers::move_client(&mut connection, &channel, &[client]) {
Ok(resp) => println!("Successfully moved client: {}", resp),
@@ -149,12 +142,7 @@ fn main() -> Result<(), Error> {
command_utils::events::register_events(&mut connection, args.event.clone())
.map_err(to_other_error)?;
- let self_clid: i32 = wrappers::get_self_clid(&mut connection)
- .map_err(|msg| make_action_error("get self clid", msg))?
- .parse()
- .map_err(|err: ParseIntError| make_action_error("parse clid", err.to_string()))?;
-
- command_utils::events::loop_response_reader(&mut connection, self_clid);
+ command_utils::events::loop_response_reader(&mut connection);
// loop_response_reader failed. Let's try to reconnect after 1 second.
std::thread::sleep(std::time::Duration::from_secs(1));
From 915c2ccbbfa8bf7c3561fc1a50752630720fb66b Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Mon, 3 Jun 2024 01:39:37 +0200
Subject: [PATCH 06/12] Add Events filter
---
src/cli.rs | 11 ++++++++++-
src/command_utils/events.rs | 15 +++++++--------
src/main.rs | 5 +++--
src/models/event.rs | 18 ++++++++++++++++++
ts-control | 2 +-
5 files changed, 39 insertions(+), 12 deletions(-)
diff --git a/src/cli.rs b/src/cli.rs
index 9cfdb0d..62898e9 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -1,4 +1,4 @@
-use clap::{Args, Parser, Subcommand};
+use clap::{Args, Parser, Subcommand, ValueEnum};
use telnet::Telnet;
use crate::parameter::ParameterList;
@@ -79,9 +79,18 @@ pub struct UpdateArgs {
speakers: Option<bool>,
}
+#[derive(Clone, ValueEnum)]
+pub enum EventArgsFilter {
+ All,
+ Mine,
+ Others,
+}
+
#[derive(Args)]
pub struct EventArgs {
pub event: Vec<EventType>,
+ #[arg(long, short)]
+ pub filter: Option<EventArgsFilter>,
}
impl FetchArgs {
diff --git a/src/command_utils/events.rs b/src/command_utils/events.rs
index 9e6f35e..34881fd 100644
--- a/src/command_utils/events.rs
+++ b/src/command_utils/events.rs
@@ -1,6 +1,7 @@
use telnet::Telnet;
use crate::{commands, wrappers};
+use crate::cli::EventArgsFilter;
use crate::models::{Client, Event, EventType};
use crate::response::Response;
@@ -35,7 +36,7 @@ fn try_get_self_clid(connection: &mut Telnet) -> Option<i32> {
.unwrap_or(None)
}
-pub fn loop_response_reader(connection: &mut Telnet) {
+pub fn loop_response_reader(connection: &mut Telnet, filter: &EventArgsFilter) {
let mut known_clients = wrappers::get_clients(connection).unwrap_or_else(|_| Vec::new());
let mut self_clid: Option<i32> = try_get_self_clid(connection);
@@ -46,13 +47,11 @@ pub fn loop_response_reader(connection: &mut Telnet) {
if let Response::Event(event_type, params) = response {
let event = Event::new(connection, event_type, params, &known_clients);
- if let Some(client) = &event.client {
- if self_clid.is_none() {
- self_clid = try_get_self_clid(connection);
- }
- if Some(client.clid) == self_clid {
- continue;
- }
+ if self_clid.is_none() {
+ self_clid = try_get_self_clid(connection);
+ }
+ if !event.should_handle(filter, self_clid) {
+ continue;
}
handle_event_response(connection, event, &mut known_clients);
diff --git a/src/main.rs b/src/main.rs
index ac3fdf4..d82e91b 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -2,7 +2,7 @@ use std::io::{Error, ErrorKind};
use telnet::Telnet;
-use crate::cli::Commands;
+use crate::cli::{Commands, EventArgsFilter};
mod wrappers;
mod commands;
@@ -138,11 +138,12 @@ fn main() -> Result<(), Error> {
}
Commands::Events(args) => {
+ let filter = args.filter.unwrap_or(EventArgsFilter::All);
loop {
command_utils::events::register_events(&mut connection, args.event.clone())
.map_err(to_other_error)?;
- command_utils::events::loop_response_reader(&mut connection);
+ command_utils::events::loop_response_reader(&mut connection, &filter);
// loop_response_reader failed. Let's try to reconnect after 1 second.
std::thread::sleep(std::time::Duration::from_secs(1));
diff --git a/src/models/event.rs b/src/models/event.rs
index 50360bd..fbc8b6d 100644
--- a/src/models/event.rs
+++ b/src/models/event.rs
@@ -4,6 +4,7 @@ use std::str::FromStr;
use serde::{Deserialize, Serialize, Serializer};
use serde::ser::SerializeStruct;
use telnet::Telnet;
+use crate::cli::EventArgsFilter;
use crate::models::{Channel, Client};
use crate::parameter::{parameter_find, ParameterList};
@@ -265,6 +266,23 @@ impl Event {
_ => String::from(""),
}
}
+
+ pub fn is_mine(&self, self_clid: Option<i32>) -> bool {
+ if let Some(self_clid) = self_clid {
+ if let Some(client) = &self.client {
+ return client.clid == self_clid;
+ }
+ }
+ false
+ }
+
+ pub fn should_handle(&self, filter: &EventArgsFilter, self_clid: Option<i32>) -> bool {
+ match filter {
+ EventArgsFilter::All => true,
+ EventArgsFilter::Mine => self.is_mine(self_clid),
+ EventArgsFilter::Others => !self.is_mine(self_clid),
+ }
+ }
}
impl Serialize for Event {
diff --git a/ts-control b/ts-control
index 31adc4e..61cced6 100755
--- a/ts-control
+++ b/ts-control
@@ -99,7 +99,7 @@ case $action in
teamspeak-query-lib message --strict-client --client "$user" "$message"
;;
"events")
- teamspeak-query-lib events NotifyClientMoved NotifyClientEnterView NotifyClientLeftView NotifyTextMessage NotifyClientPoke \
+ teamspeak-query-lib events --filter=others NotifyClientMoved NotifyClientEnterView NotifyClientLeftView NotifyTextMessage NotifyClientPoke \
| jq -r --unbuffered '.message' \
| tee >(xargs -I{} notify-send "TS3 Event" "{}")
esac
From b827471e6de1a1e6c0b3018e42eca08e9ba04ba0 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Fri, 27 Sep 2024 16:16:21 +0200
Subject: [PATCH 07/12] Add ntfy-events
---
src/models/event.rs | 1 +
ts-control | 43 ++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 43 insertions(+), 1 deletion(-)
diff --git a/src/models/event.rs b/src/models/event.rs
index fbc8b6d..281ada7 100644
--- a/src/models/event.rs
+++ b/src/models/event.rs
@@ -294,6 +294,7 @@ impl Serialize for Event {
x.serialize_field("type", &self.event_type)?;
x.serialize_field("channel", &self.channel)?;
x.serialize_field("client", &self.client)?;
+ x.serialize_field("params", &self.params)?;
x.serialize_field("message", &self.get_message())?;
x.end()
}
diff --git a/ts-control b/ts-control
index 61cced6..601bb90 100755
--- a/ts-control
+++ b/ts-control
@@ -9,7 +9,8 @@ not away
back
message
message-user
-events"
+events
+ntfy-events"
_ts_control_get_entity() {
entity=$(_ts_control_single_or_dmenu "$(teamspeak-query-lib "$1s")" "$2")
@@ -54,6 +55,41 @@ _ts_control_single_or_dmenu() {
fi
}
+handle_ntfy_events() {
+ while read -r data; do
+ msg=$(echo "$data" | jq -r --unbuffered '.message')
+ type=$(echo "$data" | jq -r --unbuffered '.type')
+ mode=$(echo "$data" | jq -r --unbuffered '.params.targetmode')
+
+ echo "$data"
+
+ if [ "$type" = "NotifyTextMessage" ] && [ "$mode" != "1" ]; then
+ continue # Skip all messages that are not direct messages
+ fi
+
+ friendly_type="Event"
+ case $type in
+ "NotifyClientPoke")
+ friendly_type="Poke"
+ ;;
+ "NotifyTextMessage")
+ friendly_type="Message"
+ ;;
+ esac
+
+ echo "($friendly_type) $target: $msg"
+
+ curl -sSL \
+ -H "Authorization: Bearer $TS3_NTFY_TOKEN" \
+ -d "{
+ \"topic\": \"$TS3_NTFY_TOPIC\",
+ \"message\": \"$msg\",
+ \"title\": \"TS3 $friendly_type\"
+ }" \
+ "$TS3_NTFY_HOST"
+ done
+}
+
# Add '$' to $1 to add 'End of line' to the regex for grep
action=$(_ts_control_single_or_dmenu "$actions" "$1$")
@@ -102,4 +138,9 @@ case $action in
teamspeak-query-lib events --filter=others NotifyClientMoved NotifyClientEnterView NotifyClientLeftView NotifyTextMessage NotifyClientPoke \
| jq -r --unbuffered '.message' \
| tee >(xargs -I{} notify-send "TS3 Event" "{}")
+ ;;
+ "ntfy-events")
+ teamspeak-query-lib events --filter=others NotifyClientPoke NotifyTextMessage \
+ | handle_ntfy_events
+ ;;
esac
From fb1e41ddc4efeea462652f584c1abf6117fced31 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Tue, 1 Oct 2024 00:20:08 +0200
Subject: [PATCH 08/12] Fix some issues
---
.forgejo/workflows/build.yaml | 10 +---------
Cargo.lock | 2 +-
Cargo.toml | 2 +-
ts-control | 11 +++++++----
4 files changed, 10 insertions(+), 15 deletions(-)
diff --git a/.forgejo/workflows/build.yaml b/.forgejo/workflows/build.yaml
index db7e32c..9a70b4a 100644
--- a/.forgejo/workflows/build.yaml
+++ b/.forgejo/workflows/build.yaml
@@ -16,17 +16,9 @@ jobs:
source "$HOME/.cargo/env"
cargo build --release
shell: bash
- - uses: https://code.forgejo.org/actions/upload-artifact@v3
- with:
- name: teamspeak-query-lib
- path: ${{ github.workspace }}/target/release/teamspeak-query-lib
- - uses: https://code.forgejo.org/actions/download-artifact@v3
- with:
- name: teamspeak-query-lib
- path: /tmp/artifacts
- shell: bash
- id: copy-ts-control-artificat
run: |
+ cp ${{ github.workspace }}/target/release/teamspeak-query-lib /tmp/artifacts
cp ${{ github.workspace }}/ts-control /tmp/artifacts
shell: bash
- uses: https://code.forgejo.org/actions/forgejo-release@v1
diff --git a/Cargo.lock b/Cargo.lock
index c541dfd..0d9a85b 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -182,7 +182,7 @@ dependencies = [
[[package]]
name = "teamspeak-query-lib"
-version = "0.1.5"
+version = "0.1.6"
dependencies = [
"clap",
"serde",
diff --git a/Cargo.toml b/Cargo.toml
index 78a7388..dfad335 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "teamspeak-query-lib"
-version = "0.1.5"
+version = "0.1.6"
edition = "2021"
[dependencies]
diff --git a/ts-control b/ts-control
index 601bb90..4c89323 100755
--- a/ts-control
+++ b/ts-control
@@ -46,12 +46,16 @@ _ts_control_fetch() {
}
_ts_control_single_or_dmenu() {
- options=$(echo "$1" | grep "$2")
+ filter="$2"
+ if [ "$filter" == "^$" ]; then
+ filter=""
+ fi
+ options=$(echo "$1" | grep "$filter")
count=$(echo "$options" | wc -l)
if [ "$count" -eq 1 ]; then
echo "$options"
else
- echo "$options" | $DMENU
+ echo "$1" | $DMENU
fi
}
@@ -90,8 +94,7 @@ handle_ntfy_events() {
done
}
-# Add '$' to $1 to add 'End of line' to the regex for grep
-action=$(_ts_control_single_or_dmenu "$actions" "$1$")
+action=$(_ts_control_single_or_dmenu "$actions" "^$1$")
case $action in
"quick")
From 3463907670d4bac7bab76b79e8399edef27cc0d8 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Sun, 27 Oct 2024 18:55:08 +0100
Subject: [PATCH 09/12] Add response option to ntfy
---
ts-control | 33 ++++++++++++++++++++++++---------
1 file changed, 24 insertions(+), 9 deletions(-)
diff --git a/ts-control b/ts-control
index 4c89323..d872875 100755
--- a/ts-control
+++ b/ts-control
@@ -64,6 +64,7 @@ handle_ntfy_events() {
msg=$(echo "$data" | jq -r --unbuffered '.message')
type=$(echo "$data" | jq -r --unbuffered '.type')
mode=$(echo "$data" | jq -r --unbuffered '.params.targetmode')
+ client_nickname=$(echo "$data" | jq -r --unbuffered '.client.client_nickname')
echo "$data"
@@ -71,25 +72,39 @@ handle_ntfy_events() {
continue # Skip all messages that are not direct messages
fi
- friendly_type="Event"
+ title="TS3 Event"
case $type in
"NotifyClientPoke")
- friendly_type="Poke"
+ title="TS3 Poke"
;;
"NotifyTextMessage")
- friendly_type="Message"
+ title="TS3 Message"
;;
esac
- echo "($friendly_type) $target: $msg"
+ echo "($title) $target: $msg"
+
+ payload=$(jq -n \
+ --arg topic "$TS3_NTFY_TOPIC" \
+ --arg webhook "$TS3_NTFY_WEBHOOK&client=$client_nickname" \
+ --arg msg "$msg" \
+ --arg type "$title" \
+ '{
+ topic: $topic,
+ message: $msg,
+ title: $type,
+ actions: [{
+ action: "http",
+ label: "TS response",
+ method: "POST",
+ url: $webhook,
+ clear: true
+ }]
+ }')
curl -sSL \
-H "Authorization: Bearer $TS3_NTFY_TOKEN" \
- -d "{
- \"topic\": \"$TS3_NTFY_TOPIC\",
- \"message\": \"$msg\",
- \"title\": \"TS3 $friendly_type\"
- }" \
+ -d "$payload" \
"$TS3_NTFY_HOST"
done
}
From 21c1e3fbb3a97239e5c96fa68daa292f8426f6de Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Thu, 9 Jan 2025 18:10:58 +0100
Subject: [PATCH 10/12] Add "migrate" command
---
src/cli.rs | 1 +
src/main.rs | 20 ++++++++++++++++++++
ts-control | 11 +++++++++++
3 files changed, 32 insertions(+)
diff --git a/src/cli.rs b/src/cli.rs
index 62898e9..4c72d25 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -17,6 +17,7 @@ struct Cli {
#[derive(Subcommand)]
pub enum Commands {
+ Info,
Channels(ChannelsArgs),
Clients,
Fetch(FetchArgs),
diff --git a/src/main.rs b/src/main.rs
index d82e91b..1451eb4 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -47,6 +47,26 @@ fn main() -> Result<(), Error> {
// You can check for the existence of subcommands, and if found use their
// matches just as you would the top level cmd
match cli {
+ Commands::Info => {
+ let client = match wrappers::find_self(&mut connection) {
+ Ok(client) => client,
+ Err(msg) => return Err(make_action_error("find self", msg))
+ };
+
+ let channel_name: String = match wrappers::find_channel(&mut connection, "cid", &client.cid.to_string(), true) {
+ Ok(channel) => match channel {
+ Some(channel) => channel.channel_name,
+ None => return Err(to_other_error("Channel not found.".to_string()))
+ },
+ Err(msg) => return Err(make_action_error("find self", msg))
+ };
+
+ println!("Client: {}", client.client_nickname);
+ println!("Channel: {}", channel_name);
+ println!("Channel ID: {}", client.cid);
+ println!("Client ID: {}", client.clid);
+ }
+
Commands::Channels(args) => {
match wrappers::get_channels(&mut connection, args.spacers) {
Ok(channels) => {
diff --git a/ts-control b/ts-control
index d872875..f791e83 100755
--- a/ts-control
+++ b/ts-control
@@ -4,6 +4,7 @@ actions="quick
move
fetch-client
fetch-channel
+migrate
away
not away
back
@@ -45,6 +46,13 @@ _ts_control_fetch() {
teamspeak-query-lib fetch "--strict-$1" "--$1" "$target"
}
+_ts_control_migrate() {
+ target=$(_ts_control_get_entity "channel" "$2")
+ current_channel=$(teamspeak-query-lib info | grep "Channel: " | sed 's/Channel: //')
+ _ts_control_move_self "$target"
+ teamspeak-query-lib fetch "--strict-channel" "--channel" "$current_channel"
+}
+
_ts_control_single_or_dmenu() {
filter="$2"
if [ "$filter" == "^$" ]; then
@@ -128,6 +136,9 @@ case $action in
"fetch-channel")
_ts_control_fetch channel "$2"
;;
+ "migrate")
+ _ts_control_migrate "$2"
+ ;;
"not away")
teamspeak-query-lib move "Not Away From Keyboard"
teamspeak-query-lib update --microphone=false --speakers=false
From 93ebbbd5d2e098aac4fb0145b151a1c3a31ce4d2 Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Tue, 24 Jun 2025 20:42:23 +0200
Subject: [PATCH 11/12] Fix wrong parameter for migrate command
---
ts-control | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/ts-control b/ts-control
index f791e83..120eabb 100755
--- a/ts-control
+++ b/ts-control
@@ -47,7 +47,7 @@ _ts_control_fetch() {
}
_ts_control_migrate() {
- target=$(_ts_control_get_entity "channel" "$2")
+ target=$(_ts_control_get_entity "channel" "$1")
current_channel=$(teamspeak-query-lib info | grep "Channel: " | sed 's/Channel: //')
_ts_control_move_self "$target"
teamspeak-query-lib fetch "--strict-channel" "--channel" "$current_channel"
From 7694bf365cc001dbeb92d508234032c8db96ddce Mon Sep 17 00:00:00 2001
From: Tobias Reisinger <tobias@msrg.cc>
Date: Tue, 8 Jul 2025 13:05:36 +0200
Subject: [PATCH 12/12] Refactor ts-control with bashly
---
.envrc | 1 +
.gitignore | 1 +
bashly-settings.yml | 1 +
control_src/ask_command.sh | 20 +++
control_src/away_command.sh | 4 +
control_src/back_command.sh | 3 +
control_src/bashly.yml | 59 +++++++++
control_src/events_command.sh | 5 +
control_src/events_ntfy_command.sh | 52 ++++++++
control_src/fetch_channel_command.sh | 1 +
control_src/fetch_client_command.sh | 1 +
control_src/lib/ntfy.sh | 0
control_src/lib/simple.sh | 46 +++++++
control_src/message_client_command.sh | 3 +
control_src/message_command.sh | 2 +
control_src/migrate_command.sh | 4 +
control_src/move_command.sh | 1 +
control_src/not_away_command.sh | 2 +
control_src/quick_command.sh | 5 +
shell.nix | 6 +
ts-control | 175 --------------------------
21 files changed, 217 insertions(+), 175 deletions(-)
create mode 100644 .envrc
create mode 100644 bashly-settings.yml
create mode 100644 control_src/ask_command.sh
create mode 100644 control_src/away_command.sh
create mode 100644 control_src/back_command.sh
create mode 100644 control_src/bashly.yml
create mode 100644 control_src/events_command.sh
create mode 100644 control_src/events_ntfy_command.sh
create mode 100644 control_src/fetch_channel_command.sh
create mode 100644 control_src/fetch_client_command.sh
create mode 100644 control_src/lib/ntfy.sh
create mode 100644 control_src/lib/simple.sh
create mode 100644 control_src/message_client_command.sh
create mode 100644 control_src/message_command.sh
create mode 100644 control_src/migrate_command.sh
create mode 100644 control_src/move_command.sh
create mode 100644 control_src/not_away_command.sh
create mode 100644 control_src/quick_command.sh
create mode 100644 shell.nix
delete mode 100755 ts-control
diff --git a/.envrc b/.envrc
new file mode 100644
index 0000000..1d953f4
--- /dev/null
+++ b/.envrc
@@ -0,0 +1 @@
+use nix
diff --git a/.gitignore b/.gitignore
index ea8c4bf..d3aa771 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
/target
+ts-control
diff --git a/bashly-settings.yml b/bashly-settings.yml
new file mode 100644
index 0000000..7b737a7
--- /dev/null
+++ b/bashly-settings.yml
@@ -0,0 +1 @@
+source_dir: control_src
diff --git a/control_src/ask_command.sh b/control_src/ask_command.sh
new file mode 100644
index 0000000..e855e88
--- /dev/null
+++ b/control_src/ask_command.sh
@@ -0,0 +1,20 @@
+actions=(
+ "quick"
+ "move"
+ "fetch-client"
+ "fetch-channel"
+ "migrate"
+ "away"
+ "not-away"
+ "back"
+ "message"
+ "message-client"
+ "events"
+ "events-ntfy"
+)
+
+action=$(echo "${actions[@]}" | tr ' ' '\n' | $DMENU)
+
+if [ -n "$action" ]; then
+ $0 "$action"
+fi
diff --git a/control_src/away_command.sh b/control_src/away_command.sh
new file mode 100644
index 0000000..9a4bbe0
--- /dev/null
+++ b/control_src/away_command.sh
@@ -0,0 +1,4 @@
+message=$(_ts_control_get_message "${args[channel]}")
+teamspeak-query-lib move "Away From Keyboard"
+teamspeak-query-lib update --away "$message"
+teamspeak-query-lib update --microphone=false --speakers=false --away "$message"
diff --git a/control_src/back_command.sh b/control_src/back_command.sh
new file mode 100644
index 0000000..f930b9b
--- /dev/null
+++ b/control_src/back_command.sh
@@ -0,0 +1,3 @@
+teamspeak-query-lib update --back
+_ts_control_move_self "${args[channel]}"
+teamspeak-query-lib update --microphone=true --speakers=true
diff --git a/control_src/bashly.yml b/control_src/bashly.yml
new file mode 100644
index 0000000..b04f3e6
--- /dev/null
+++ b/control_src/bashly.yml
@@ -0,0 +1,59 @@
+name: ts-control
+help: Teamspeak query lib utility script
+version: 0.1.0
+
+environment_variables:
+ - name: ts3_client_api_key
+ help: Set your API key
+ required: true
+
+commands:
+ - name: ask
+ default: force
+ - name: quick
+ - name: move
+ args:
+ - name: channel
+ required: false
+ - name: fetch-client
+ args:
+ - name: client
+ required: false
+ - name: fetch-channel
+ args:
+ - name: channel
+ required: false
+ - name: migrate
+ args:
+ - name: channel
+ required: false
+ - name: not-away
+ - name: away
+ args:
+ - name: message
+ required: false
+ - name: back
+ args:
+ - name: channel
+ required: false
+ - name: message
+ args:
+ - name: message
+ required: false
+ - name: message-client
+ args:
+ - name: client
+ required: false
+ - name: message
+ required: false
+ - name: events
+ - name: events-ntfy
+ environment_variables:
+ - name: ts3_ntfy_host
+ required: true
+ - name: ts3_ntfy_token
+ required: true
+ - name: ts3_ntfy_topic
+ required: true
+ - name: ts3_ntfy_webhook
+ required: true
diff --git a/control_src/events_command.sh b/control_src/events_command.sh
new file mode 100644
index 0000000..b1fbaa1
--- /dev/null
+++ b/control_src/events_command.sh
@@ -0,0 +1,5 @@
+teamspeak-query-lib events --filter=others \
+ NotifyClientMoved NotifyClientEnterView NotifyClientLeftView \
+ NotifyTextMessage NotifyClientPoke \
+ | jq -r --unbuffered '.message' \
+ | tee >(xargs -I{} notify-send "TS3 Event" "{}")
diff --git a/control_src/events_ntfy_command.sh b/control_src/events_ntfy_command.sh
new file mode 100644
index 0000000..22506c3
--- /dev/null
+++ b/control_src/events_ntfy_command.sh
@@ -0,0 +1,52 @@
+handle_ntfy_events() {
+ while read -r data; do
+ msg=$(echo "$data" | jq -r --unbuffered '.message')
+ type=$(echo "$data" | jq -r --unbuffered '.type')
+ mode=$(echo "$data" | jq -r --unbuffered '.params.targetmode')
+ client_nickname=$(echo "$data" | jq -r --unbuffered '.client.client_nickname')
+
+ echo "$data"
+
+ if [ "$type" = "NotifyTextMessage" ] && [ "$mode" != "1" ]; then
+ continue # Skip all messages that are not direct messages
+ fi
+
+ title="TS3 Event"
+ case $type in
+ "NotifyClientPoke")
+ title="TS3 Poke"
+ ;;
+ "NotifyTextMessage")
+ title="TS3 Message"
+ ;;
+ esac
+
+ echo "($title) $target: $msg"
+
+ payload=$(jq -n \
+ --arg topic "$TS3_NTFY_TOPIC" \
+ --arg webhook "$TS3_NTFY_WEBHOOK&client=$client_nickname" \
+ --arg msg "$msg" \
+ --arg type "$title" \
+ '{
+ topic: $topic,
+ message: $msg,
+ title: $type,
+ actions: [{
+ action: "http",
+ label: "TS response",
+ method: "POST",
+ url: $webhook,
+ clear: true
+ }]
+ }')
+
+ curl -sSL \
+ -H "Authorization: Bearer $TS3_NTFY_TOKEN" \
+ -d "$payload" \
+ "$TS3_NTFY_HOST"
+ done
+}
+
+teamspeak-query-lib events --filter=others NotifyClientPoke NotifyTextMessage \
+ | handle_ntfy_events
diff --git a/control_src/fetch_channel_command.sh b/control_src/fetch_channel_command.sh
new file mode 100644
index 0000000..ddefcd7
--- /dev/null
+++ b/control_src/fetch_channel_command.sh
@@ -0,0 +1 @@
+_ts_control_fetch channel "${args[channel]}"
diff --git a/control_src/fetch_client_command.sh b/control_src/fetch_client_command.sh
new file mode 100644
index 0000000..ff432fe
--- /dev/null
+++ b/control_src/fetch_client_command.sh
@@ -0,0 +1 @@
+_ts_control_fetch client "${args[client]}"
diff --git a/control_src/lib/ntfy.sh b/control_src/lib/ntfy.sh
new file mode 100644
index 0000000..e69de29
diff --git a/control_src/lib/simple.sh b/control_src/lib/simple.sh
new file mode 100644
index 0000000..2108a0a
--- /dev/null
+++ b/control_src/lib/simple.sh
@@ -0,0 +1,46 @@
+_ts_control_get_entity() {
+ entity=$(_ts_control_single_or_dmenu "$(teamspeak-query-lib "$1s")" "$2")
+ if [ -z "$entity" ]; then
+ exit 1
+ fi
+ echo "$entity"
+}
+
+_ts_control_get_message() {
+ if [ -n "$1" ];
+ then
+ message="$1"
+ else
+ message=$(printf "\n" | $DMENU -p "message")
+ fi
+
+ if [ -z "$message" ]; then
+ exit 1
+ fi
+
+ echo "$message"
+}
+
+_ts_control_move_self() {
+ channel=$(_ts_control_get_entity channel "$1" "$2")
+ teamspeak-query-lib move --strict-channel "$channel"
+}
+
+_ts_control_fetch() {
+ target=$(_ts_control_get_entity "$1" "$2")
+ teamspeak-query-lib fetch "--strict-$1" "--$1" "$target"
+}
+
+_ts_control_single_or_dmenu() {
+ filter="$2"
+ if [ "$filter" == "^$" ]; then
+ filter=""
+ fi
+ options=$(echo "$1" | grep "$filter")
+ count=$(echo "$options" | wc -l)
+ if [ "$count" -eq 1 ]; then
+ echo "$options"
+ else
+ echo "$1" | $DMENU
+ fi
+}
diff --git a/control_src/message_client_command.sh b/control_src/message_client_command.sh
new file mode 100644
index 0000000..17746f6
--- /dev/null
+++ b/control_src/message_client_command.sh
@@ -0,0 +1,3 @@
+client=$(_ts_control_get_entity client "${args[client]}")
+message=$(_ts_control_get_message "${args[message]}")
+teamspeak-query-lib message --strict-client --client "$client" "$message"
diff --git a/control_src/message_command.sh b/control_src/message_command.sh
new file mode 100644
index 0000000..f4a5ddf
--- /dev/null
+++ b/control_src/message_command.sh
@@ -0,0 +1,2 @@
+message=$(_ts_control_get_message "${args[message]}")
+teamspeak-query-lib message "$message"
diff --git a/control_src/migrate_command.sh b/control_src/migrate_command.sh
new file mode 100644
index 0000000..345d13e
--- /dev/null
+++ b/control_src/migrate_command.sh
@@ -0,0 +1,4 @@
+target=$(_ts_control_get_entity "channel" "$1")
+current_channel=$(teamspeak-query-lib info | grep "Channel: " | sed 's/Channel: //')
+_ts_control_move_self "$target"
+teamspeak-query-lib fetch "--strict-channel" "--channel" "$current_channel"
diff --git a/control_src/move_command.sh b/control_src/move_command.sh
new file mode 100644
index 0000000..bc60cba
--- /dev/null
+++ b/control_src/move_command.sh
@@ -0,0 +1 @@
+_ts_control_move_self "${args[channel]}"
diff --git a/control_src/not_away_command.sh b/control_src/not_away_command.sh
new file mode 100644
index 0000000..e090b5b
--- /dev/null
+++ b/control_src/not_away_command.sh
@@ -0,0 +1,2 @@
+teamspeak-query-lib move "Not Away From Keyboard"
+teamspeak-query-lib update --microphone=false --speakers=false
diff --git a/control_src/quick_command.sh b/control_src/quick_command.sh
new file mode 100644
index 0000000..ead1c38
--- /dev/null
+++ b/control_src/quick_command.sh
@@ -0,0 +1,5 @@
+action=$($DMENU < "$XDG_CONFIG_HOME/ts-control-quick")
+if [ -z "$action" ]; then
+ exit 1
+fi
+eval "$0 $action"
diff --git a/shell.nix b/shell.nix
new file mode 100644
index 0000000..121edf5
--- /dev/null
+++ b/shell.nix
@@ -0,0 +1,6 @@
+with import <nixpkgs> {};
+mkShell {
+ nativeBuildInputs = [
+ bashly
+ ];
+}
diff --git a/ts-control b/ts-control
deleted file mode 100755
index 120eabb..0000000
--- a/ts-control
+++ /dev/null
@@ -1,175 +0,0 @@
-#!/usr/bin/env bash
-
-actions="quick
-move
-fetch-client
-fetch-channel
-migrate
-away
-not away
-back
-message
-message-user
-events
-ntfy-events"
-
-_ts_control_get_entity() {
- entity=$(_ts_control_single_or_dmenu "$(teamspeak-query-lib "$1s")" "$2")
- if [ -z "$entity" ]; then
- exit 1
- fi
- echo "$entity"
-}
-
-_ts_control_get_message() {
- if [ -n "$1" ];
- then
- message="$1"
- else
- message=$(printf "\n" | $DMENU -p "message")
- fi
-
- if [ -z "$message" ]; then
- exit 1
- fi
-
- echo "$message"
-}
-
-_ts_control_move_self() {
- channel=$(_ts_control_get_entity channel "$1" "$2")
- teamspeak-query-lib move --strict-channel "$channel"
-}
-
-_ts_control_fetch() {
- target=$(_ts_control_get_entity "$1" "$2")
- teamspeak-query-lib fetch "--strict-$1" "--$1" "$target"
-}
-
-_ts_control_migrate() {
- target=$(_ts_control_get_entity "channel" "$1")
- current_channel=$(teamspeak-query-lib info | grep "Channel: " | sed 's/Channel: //')
- _ts_control_move_self "$target"
- teamspeak-query-lib fetch "--strict-channel" "--channel" "$current_channel"
-}
-
-_ts_control_single_or_dmenu() {
- filter="$2"
- if [ "$filter" == "^$" ]; then
- filter=""
- fi
- options=$(echo "$1" | grep "$filter")
- count=$(echo "$options" | wc -l)
- if [ "$count" -eq 1 ]; then
- echo "$options"
- else
- echo "$1" | $DMENU
- fi
-}
-
-handle_ntfy_events() {
- while read -r data; do
- msg=$(echo "$data" | jq -r --unbuffered '.message')
- type=$(echo "$data" | jq -r --unbuffered '.type')
- mode=$(echo "$data" | jq -r --unbuffered '.params.targetmode')
- client_nickname=$(echo "$data" | jq -r --unbuffered '.client.client_nickname')
-
- echo "$data"
-
- if [ "$type" = "NotifyTextMessage" ] && [ "$mode" != "1" ]; then
- continue # Skip all messages that are not direct messages
- fi
-
- title="TS3 Event"
- case $type in
- "NotifyClientPoke")
- title="TS3 Poke"
- ;;
- "NotifyTextMessage")
- title="TS3 Message"
- ;;
- esac
-
- echo "($title) $target: $msg"
-
- payload=$(jq -n \
- --arg topic "$TS3_NTFY_TOPIC" \
- --arg webhook "$TS3_NTFY_WEBHOOK&client=$client_nickname" \
- --arg msg "$msg" \
- --arg type "$title" \
- '{
- topic: $topic,
- message: $msg,
- title: $type,
- actions: [{
- action: "http",
- label: "TS response",
- method: "POST",
- url: $webhook,
- clear: true
- }]
- }')
-
- curl -sSL \
- -H "Authorization: Bearer $TS3_NTFY_TOKEN" \
- -d "$payload" \
- "$TS3_NTFY_HOST"
- done
-}
-
-action=$(_ts_control_single_or_dmenu "$actions" "^$1$")
-
-case $action in
- "quick")
- action=$($DMENU < "$XDG_CONFIG_HOME/ts-control-quick")
- if [ -z "$action" ]; then
- exit 1
- fi
- eval "$0 $action"
- ;;
- "move")
- _ts_control_move_self "$2"
- ;;
- "fetch-client")
- _ts_control_fetch client "$2"
- ;;
- "fetch-channel")
- _ts_control_fetch channel "$2"
- ;;
- "migrate")
- _ts_control_migrate "$2"
- ;;
- "not away")
- teamspeak-query-lib move "Not Away From Keyboard"
- teamspeak-query-lib update --microphone=false --speakers=false
- ;;
- "away")
- message=$(_ts_control_get_message)
- teamspeak-query-lib move "Away From Keyboard"
- teamspeak-query-lib update --away "$message"
- teamspeak-query-lib update --microphone=false --speakers=false --away "$message"
- ;;
- "back")
- teamspeak-query-lib update --back
- _ts_control_move_self "$2"
- teamspeak-query-lib update --microphone=true --speakers=true
- ;;
- "message")
- message=$(_ts_control_get_message "$2")
- teamspeak-query-lib message "$message"
- ;;
- "message-user")
- user=$(_ts_control_get_entity client "$2")
- message=$(_ts_control_get_message "$3")
- teamspeak-query-lib message --strict-client --client "$user" "$message"
- ;;
- "events")
- teamspeak-query-lib events --filter=others NotifyClientMoved NotifyClientEnterView NotifyClientLeftView NotifyTextMessage NotifyClientPoke \
- | jq -r --unbuffered '.message' \
- | tee >(xargs -I{} notify-send "TS3 Event" "{}")
- ;;
- "ntfy-events")
- teamspeak-query-lib events --filter=others NotifyClientPoke NotifyTextMessage \
- | handle_ntfy_events
- ;;
-esac