Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added functions for chatDescription #210

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Added functions for chatDescription #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb2dfb1
Added functions for chatDescription
cb-lock Nov 3, 2020
227f131
Added getMyCommands
cb-lock Nov 9, 2020
0cfd5f7
Added method for URL encoded setting of the setMyCommands
cb-lock Nov 10, 2020
a77b010
Add support for editing messages
cb-lock Nov 27, 2020
262a0c8
Merged changes
cb-lock Oct 12, 2021
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,6 @@
.gcc-flags.json
.pio/
.vscode/

# MacOS
.DS_Store
237 changes: 212 additions & 25 deletions src/UniversalTelegramBot.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ String UniversalTelegramBot::sendMultipartFormDataToTelegram(
client->print(buildCommand(command));
client->println(F(" HTTP/1.1"));
// Host header
client->print(F("Host: " TELEGRAM_HOST));
client->println(F("Host: " TELEGRAM_HOST));
client->println(F("User-Agent: arduino/1.0"));
client->println(F("Accept: */*"));

Expand All @@ -247,7 +247,7 @@ String UniversalTelegramBot::sendMultipartFormDataToTelegram(
client->println(String(contentLength));
client->print(F("Content-Type: multipart/form-data; boundary="));
client->println(boundary);
client->println(F(""));
client->println();
client->print(start_request);

#ifdef TELEGRAM_DEBUG
Expand Down Expand Up @@ -318,6 +318,29 @@ bool UniversalTelegramBot::getMe() {
return false;
}

/*********************************************************************************
* GetMyCommands - Get the command list of the bot from the telegram server *
* Returns the JSON string with the command list for the key "result" in the *
* server response *
********************************************************************************/
String UniversalTelegramBot::getMyCommands()
{
#ifdef TELEGRAM_DEBUG
Serial.println(F("GET getMyCommands"));
#endif
String command = BOT_CMD("getMyCommands");
String response = sendGetToTelegram(command); // receive reply from telegram.org
#ifdef TELEGRAM_DEBUG
Serial.print(F("incoming message length "));
Serial.println(response.length());
Serial.println(F("Creating DynamicJsonBuffer"));
#endif
closeClient();

return response;
}


/*********************************************************************************
* SetMyCommands - Update the command list of the bot on the telegram server *
* (Argument to pass: Serialied array of BotCommand) *
Expand Down Expand Up @@ -348,6 +371,30 @@ bool UniversalTelegramBot::setMyCommands(const String& commandArray) {
}


bool UniversalTelegramBot::setMyCommandsStr(String commands)
{
bool sent = false;
String response = "";
#if defined(_debug)
Serial.println(F("sendSetMyCommands: SEND Post /setMyCommands"));
#endif // defined(_debug)
unsigned long sttime = millis();

while (millis() - sttime < 8000ul)
{ // loop for a while to send the message
response = sendGetToTelegram(BOT_CMD("setMyCommands") + commands);
#ifdef _debug
Serial.println("setMyCommands response" + response);
#endif
sent = checkForOkResponse(response);
if (sent) break;
}

closeClient();
return sent;
}


/***************************************************************
* GetUpdates - function to receive messages from telegram *
* (Argument to pass: the last+1 message to read) *
Expand Down Expand Up @@ -445,6 +492,8 @@ bool UniversalTelegramBot::processResult(JsonObject result, int messageIndex) {
messages[messageIndex].text = F("");
messages[messageIndex].from_id = F("");
messages[messageIndex].from_name = F("");
messages[messageIndex].hasPhoto = false;
messages[messageIndex].file_caption = F("");
messages[messageIndex].longitude = 0;
messages[messageIndex].latitude = 0;
messages[messageIndex].reply_to_message_id = 0;
Expand All @@ -460,9 +509,13 @@ bool UniversalTelegramBot::processResult(JsonObject result, int messageIndex) {
messages[messageIndex].chat_id = message["chat"]["id"].as<String>();
messages[messageIndex].chat_title = message["chat"]["title"].as<String>();
messages[messageIndex].hasDocument = false;
messages[messageIndex].message_id = message["message_id"].as<int>();
if (message.containsKey("text")) {
messages[messageIndex].text = message["text"].as<String>();


} else if (message.containsKey("photo")) {
messages[messageIndex].hasPhoto = true;
messages[messageIndex].file_caption = message["caption"].as<String>();
} else if (message.containsKey("location")) {
messages[messageIndex].longitude = message["location"]["longitude"].as<float>();
messages[messageIndex].latitude = message["location"]["latitude"].as<float>();
Expand All @@ -479,14 +532,16 @@ bool UniversalTelegramBot::processResult(JsonObject result, int messageIndex) {
messages[messageIndex].reply_to_message_id = message["reply_to_message"]["message_id"];
// no need to check if containsKey["text"]. If it doesn't, it default to null
messages[messageIndex].reply_to_text = message["reply_to_message"]["text"].as<String>();
}
}

} else if (result.containsKey("channel_post")) {
JsonObject message = result["channel_post"];
messages[messageIndex].type = F("channel_post");
messages[messageIndex].text = message["text"].as<String>();
messages[messageIndex].date = message["date"].as<String>();
messages[messageIndex].chat_id = message["chat"]["id"].as<String>();
messages[messageIndex].chat_title = message["chat"]["title"].as<String>();
messages[messageIndex].message_id = message["message_id"].as<int>(); // added message id

} else if (result.containsKey("callback_query")) {
JsonObject message = result["callback_query"];
Expand All @@ -499,6 +554,8 @@ bool UniversalTelegramBot::processResult(JsonObject result, int messageIndex) {
messages[messageIndex].reply_to_text = message["message"]["text"].as<String>();
messages[messageIndex].chat_title = F("");
messages[messageIndex].query_id = message["id"].as<String>();
messages[messageIndex].message_id = message["message"]["message_id"].as<int>(); // added message id

} else if (result.containsKey("edited_message")) {
JsonObject message = result["edited_message"];
messages[messageIndex].type = F("edited_message");
Expand All @@ -507,6 +564,7 @@ bool UniversalTelegramBot::processResult(JsonObject result, int messageIndex) {
messages[messageIndex].date = message["date"].as<String>();
messages[messageIndex].chat_id = message["chat"]["id"].as<String>();
messages[messageIndex].chat_title = message["chat"]["title"].as<String>();
messages[messageIndex].message_id = message["message_id"].as<int>(); // added message id

if (message.containsKey("text")) {
messages[messageIndex].text = message["text"].as<String>();
Expand Down Expand Up @@ -554,23 +612,45 @@ bool UniversalTelegramBot::sendSimpleMessage(const String& chat_id, const String
return sent;
}


bool UniversalTelegramBot::sendMessage(const String& chat_id, const String& text,
const String& parse_mode) {
const String& parse_mode, int message_id)
{
DynamicJsonDocument payload(maxMessageLength);
payload["chat_id"] = chat_id;
payload["text"] = text;

if (message_id != 0)
payload["message_id"] = message_id; // added message_id

if (parse_mode != "")
payload["parse_mode"] = parse_mode;

return sendPostMessage(payload.as<JsonObject>(), message_id); // if message id == 0 then edit is false, else edit is true
}


/*
bool UniversalTelegramBot::editMessage(const String& chat_id, const String & message_id, const String& text,
const String& parse_mode)
{
DynamicJsonDocument payload(maxMessageLength);
payload["chat_id"] = chat_id;
payload["text"] = text;
payload["message_id"] = message_id;

if (parse_mode != "")
payload["parse_mode"] = parse_mode;

return sendPostMessage(payload.as<JsonObject>());
return sendPostMessage(payload.as<JsonObject>(), EDIT_TEXT);
}
*/


bool UniversalTelegramBot::sendMessageWithReplyKeyboard(
const String& chat_id, const String& text, const String& parse_mode, const String& keyboard,
bool resize, bool oneTime, bool selective) {
bool resize, bool oneTime, bool selective, bool removeKeyboard)
{
DynamicJsonDocument payload(maxMessageLength);
payload["chat_id"] = chat_id;
payload["text"] = text;
Expand All @@ -579,45 +659,54 @@ bool UniversalTelegramBot::sendMessageWithReplyKeyboard(
payload["parse_mode"] = parse_mode;

JsonObject replyMarkup = payload.createNestedObject("reply_markup");

replyMarkup["keyboard"] = serialized(keyboard);

// Telegram defaults these values to false, so to decrease the size of the
// payload we will only send them if needed
if (resize)
replyMarkup["resize_keyboard"] = resize;

if (oneTime)
replyMarkup["one_time_keyboard"] = oneTime;

if (selective)
replyMarkup["selective"] = selective;
if (removeKeyboard)
replyMarkup["remove_keyboard"] = removeKeyboard;
else
{
if (resize)
replyMarkup["resize_keyboard"] = resize;

if (oneTime)
replyMarkup["one_time_keyboard"] = oneTime;

if (selective)
replyMarkup["selective"] = selective;
}

return sendPostMessage(payload.as<JsonObject>());
}

bool UniversalTelegramBot::sendMessageWithInlineKeyboard(const String& chat_id,
const String& text,
const String& parse_mode,
const String& keyboard) {
const String& keyboard,
int message_id) { // added message_id

DynamicJsonDocument payload(maxMessageLength);
payload["chat_id"] = chat_id;
payload["text"] = text;

if (message_id != 0)
payload["message_id"] = message_id; // added message_id

if (parse_mode != "")
payload["parse_mode"] = parse_mode;

JsonObject replyMarkup = payload.createNestedObject("reply_markup");
replyMarkup["inline_keyboard"] = serialized(keyboard);
return sendPostMessage(payload.as<JsonObject>());
return sendPostMessage(payload.as<JsonObject>(), message_id); // if message id == 0 then edit is false, else edit is true
}

/***********************************************************************
* SendPostMessage - function to send message to telegram *
* SendPostMessage - function to send message to telegram *
* (Arguments to pass: chat_id, text to transmit and markup(optional)) *
***********************************************************************/
bool UniversalTelegramBot::sendPostMessage(JsonObject payload) {
bool UniversalTelegramBot::sendPostMessage(JsonObject payload, bool edit) { // added message_id

bool sent = false;
#ifdef TELEGRAM_DEBUG
Expand All @@ -627,10 +716,13 @@ bool UniversalTelegramBot::sendPostMessage(JsonObject payload) {
#endif
unsigned long sttime = millis();

if (payload.containsKey("text")) {
while (millis() - sttime < 8000ul) { // loop for a while to send the message
String response = sendPostToTelegram(BOT_CMD("sendMessage"), payload);
#ifdef TELEGRAM_DEBUG
if (payload.containsKey("text"))
{
String response;
while (millis() < sttime + 8000ul)
{ // loop for a while to send the message
String response = sendPostToTelegram((edit ? BOT_CMD("editMessageText") : BOT_CMD("sendMessage")), payload); // if edit is true we send a editMessageText CMD
#ifdef TELEGRAM_DEBUG
Serial.println(response);
#endif
sent = checkForOkResponse(response);
Expand Down Expand Up @@ -757,6 +849,101 @@ bool UniversalTelegramBot::sendChatAction(const String& chat_id, const String& t
return sent;
}


bool UniversalTelegramBot::getChatDescription(String chat_id, String & text)
{
String command = "bot" + _token + "/getChat?chat_id=" + chat_id;
String response = sendGetToTelegram(command); // receive reply from telegram.org
DynamicJsonDocument doc(maxMessageLength);
DeserializationError error = deserializeJson(doc, response);
JsonObject obj = doc.as<JsonObject>(); //there is nothing better right now to use obj.containsKey("result")
closeClient();

if (!error)
{
if (obj.containsKey("result"))
{
String descr = doc["result"]["description"];
text = descr;
return true;
}
}

return false;
}



bool UniversalTelegramBot::setChatDescription(String chat_id, String text)
{
bool sent = false;
#ifdef TELEGRAM_DEBUG
Serial.println(F("SEND Chat Description"));
#endif
long sttime = millis();

if (text != "")
{
while (millis() < sttime + 8000)
{ // loop for a while to send the message
String command = "bot" + _token + "/setChatDescription?chat_id=" + chat_id + "&description=" + text;
String response = sendGetToTelegram(command);

#ifdef TELEGRAM_DEBUG
Serial.println(response);
#endif
sent = checkForOkResponse(response);

if (sent) break;
}
}

closeClient();
return sent;
}



bool UniversalTelegramBot::restrictChatMember(String chat_id, String user_id, bool permit, String until_date)
{
bool sent = false;
long sttime = millis();

DynamicJsonDocument doc(maxMessageLength);
doc["chat_id"] = chat_id;
doc["user_id"] = user_id;
JsonObject permissions = doc.createNestedObject("permissions");
permissions["can_send_messages"] = permit ? "True" : "False";
doc["until_date"] = until_date;
// DeserializationError error = deserializeJson(doc, response);
JsonObject payload = doc.as<JsonObject>(); //there is nothing better right now to use obj.containsKey("result")

#ifdef TELEGRAM_DEBUG
Serial.print(F("SEND User Restriction"));
serializeJson(payload, Serial);
Serial.println();
#endif

if (payload.containsKey("text"))
{
while (millis() < sttime + 8000)
{ // loop for a while to send the message
String command = "bot" + _token + "/restrictChatMember";
String response = sendPostToTelegram(command, payload);
#ifdef TELEGRAM_DEBUG
Serial.println(response);
#endif
sent = checkForOkResponse(response);
if (sent) break;
}
}

closeClient();
return sent;
}



void UniversalTelegramBot::closeClient() {
if (client->connected()) {
#ifdef TELEGRAM_DEBUG
Expand Down
Loading