/** * ZNC Push Module * * Allows the user to enter a Push user and API token, and sends * channel highlights and personal messages to Push. * * Copyright (c) 2011 John Reese * Licensed under the MIT license */ #define REQUIRESSL #include "znc.h" #include "Chan.h" #include "User.h" #include "Modules.h" #include "time.h" #if (!defined(VERSION_MAJOR) || !defined(VERSION_MINOR) || (VERSION_MAJOR == 0 && VERSION_MINOR < 72)) #error This module needs ZNC 0.072 or newer. #endif // Handle versions of ZNC older than 0.090 by disabling the away_only condition #if VERSION_MAJOR == 0 && VERSION_MINOR >= 90 #define PUSH_AWAY #endif // Forward declaration class CPushMod; /** * Socket class for generating HTTP requests. */ class CPushSocket : public CSocket { public: CPushSocket(CModule *p) : CSocket(p) { EnableReadLine(); parent = (CPushMod*) p; first = true; crlf = "\r\n"; user_agent = "ZNC Push"; } // Implemented after CPushMod void Request(bool post, const CString& host, const CString& url, MCString& parameters, const CString& auth=""); virtual void ReadLine(const CString& data); virtual void Disconnected(); private: CPushMod *parent; bool first; // Too lazy to add CString("\r\n\") everywhere CString crlf; // User agent to use CString user_agent; /** * Shorthand for encoding a string for a URL. * * @param str String to be encoded * @return Encoded string */ CString urlencode(const CString& str) { return str.Escape_n(CString::EASCII, CString::EURL); } }; /** * Push notification module. */ class CPushMod : public CModule { protected: // Application name CString app; // Time last notification was sent for a given context map last_notification_time; // Time of last message by user to a given context map last_reply_time; // Time of last activity by user for a given context map last_active_time; // Time of last activity by user in any context unsigned int idle_time; // User object CUser *user; // Configuration options MCString options; MCString defaults; public: MODCONSTRUCTOR(CPushMod) { app = "ZNC"; idle_time = time(NULL); // Current user user = GetUser(); // Push service information defaults["service"] = ""; defaults["username"] = ""; defaults["secret"] = ""; // Condition strings defaults["channel_conditions"] = "all"; defaults["query_conditions"] = "all"; // Notification conditions #ifdef PUSH_AWAY defaults["away_only"] = "no"; #endif defaults["client_count_less_than"] = "0"; defaults["highlight"] = ""; defaults["idle"] = "0"; defaults["last_active"] = "180"; defaults["last_notification"] = "300"; defaults["nick_blacklist"] = ""; defaults["replied"] = "yes"; // Notification settings defaults["message_length"] = "100"; defaults["message_uri"] = ""; defaults["debug"] = "off"; } virtual ~CPushMod() {} public: /** * Debugging messages. Prints to *push when the debug option is enabled. * * @param data Debug message */ void PutDebug(const CString& data) { if (options["debug"] == "on") { PutModule(data); } } protected: /** * Performs string expansion on a set of keywords. * Given an initial string and a dictionary of string replacments, * iterate over the dictionary, expanding keywords one-by-one. * * @param content String contents * @param replace Dictionary of string replacements * @return Result of string replacements */ CString expand(const CString& content, MCString& replace) { CString result = content.c_str(); for(MCString::iterator i = replace.begin(); i != replace.end(); i++) { result.Replace(i->first, i->second); } return result; } /** * Send a message to the currently-configured Notifo account. * Requires (and assumes) that the user has already configured their * username and API secret using the 'set' command. * * @param message Message to be sent to the user * @param title Message title to use * @param context Channel or nick context */ void send_message(const CString& message, const CString& title="New Message", const CString& context="*push", const CNick& nick=CString("*push")) { // Set the last notification time last_notification_time[context] = time(NULL); // Shorten message if needed unsigned int message_length = options["message_length"].ToUInt(); CString short_message = message; if (message_length > 0) { short_message = message.Ellipsize(message_length); } // Generate an ISO8601 date string time_t rawtime; struct tm * timeinfo; time(&rawtime); timeinfo = localtime(&rawtime); char iso8601 [20]; strftime(iso8601, 20, "%Y-%m-%d %H:%M:%S", timeinfo); // URI string replacements MCString replace; replace["{context}"] = context; replace["{nick}"] = nick.GetNick(); replace["{datetime}"] = CString(iso8601); replace["{unixtime}"] = CString(time(NULL)); CString uri = expand(options["message_uri"], replace); // Set up the connection profile CString service = options["service"]; bool use_post = true; int use_port = 443; bool use_ssl = true; CString service_host; CString service_url; CString service_auth; MCString params; // Service-specific profiles if (service == "notifo") { if (options["username"] == "" || options["secret"] == "") { PutModule("Error: username or secret not set"); return; } service_host = "api.notifo.com"; service_url = "/v1/send_notification"; // BASIC auth, base64-encoded username:password service_auth = options["username"] + CString(":") + options["secret"]; service_auth.Base64Encode(); params["to"] = options["username"]; params["msg"] = short_message; params["label"] = app; params["title"] = title; params["uri"] = uri; } else if (service == "boxcar") { if (options["username"] == "") { PutModule("Error: username not set"); return; } CString boxcar_api_key = "puSd2qp2gCDZO7nWkvb9"; CString boxcar_api_secret = "wLQQKSyGybIOkggbiKipefeYGLni9B3FPZabopHp"; service_host = "boxcar.io"; service_url = "/devices/providers/" + boxcar_api_key + "/notifications"; params["email"] = options["username"]; params["notification[from_screen_name]"] = context; params["notification[message]"] = short_message; params["notification[source_url]"] = uri; } else if (service == "nma") { if (options["secret"] == "") { PutModule("Error: secret not set"); return; } service_host = "www.notifymyandroid.com"; service_url = "/publicapi/notify"; params["apikey"] = options["secret"]; params["application"] = app; params["event"] = title; params["description"] = short_message; params["url"] = uri; } else if (service == "prowl") { if (options["secret"] == "") { PutModule("Error: secret not set"); return; } service_host = "api.prowlapp.com"; service_url = "/publicapi/add"; params["apikey"] = options["secret"]; params["application"] = app; params["event"] = title; params["description"] = short_message; params["url"] = uri; } else { PutModule("Error: service type not selected"); return; } // Create the socket connection, write to it, and add it to the queue CPushSocket *sock = new CPushSocket(this); sock->Connect(service_host, use_port, use_ssl); sock->Request(use_post, service_host, service_url, params, service_auth); AddSocket(sock); } /** * Evaluate a boolean expression using condition values. * All tokens must be separated by spaces, using "and" and "or" for * boolean operators, "(" and ")" to enclose sub-expressions, and * condition option names to evaluate each condition. * * @param expression Boolean expression string * @param context Notification context * @param nick Sender nick * @param message Message contents * @return Result of boolean evaluation */ bool eval(const CString& expression, const CString& context=CString(""), const CNick& nick=CNick(""), const CString& message=" ") { CString padded = expression.Replace_n("(", " ( "); padded.Replace(")", " ) "); VCString tokens; padded.Split(" ", tokens, false); PutDebug("Evaluating message: <" + nick.GetNick() + "> " + message); bool result = eval_tokens(tokens.begin(), tokens.end(), context, nick, message); return result; } #define expr(x, y) else if (token == x) { \ bool result = y; \ dbg += CString(x) + "/" + CString(result ? "true" : "false") + " "; \ value = oper ? value && result : value || result; \ } /** * Evaluate a tokenized boolean expression, or sub-expression. * * @param pos Token vector iterator current position * @param end Token vector iterator end position * @param context Notification context * @param nick Sender nick * @param message Message contents * @return Result of boolean expression */ bool eval_tokens(VCString::iterator pos, VCString::iterator end, const CString& context, const CNick& nick, const CString& message) { bool oper = true; bool value = true; CString dbg = ""; for(; pos != end; pos++) { CString token = pos->AsLower(); if (token == "(") { // recursively evaluate sub-expressions bool inner = eval_tokens(++pos, end, context, nick, message); dbg += "( inner/" + CString(inner ? "true" : "false") + " ) "; value = oper ? value && inner : value || inner; // search ahead to the matching parenthesis token unsigned int parens = 1; while(pos != end) { if (*pos == "(") { parens++; } else if (*pos == ")") { parens--; } if (parens == 0) { break; } pos++; } } else if (token == ")") { pos++; PutDebug(dbg); return value; } else if (token == "and") { dbg += "and "; oper = true; } else if (token == "or") { dbg += "or "; oper = false; } expr("true", true) expr("false", false) expr("away_only", away_only()) expr("client_count_less_than", client_count_less_than()) expr("highlight", highlight(message)) expr("idle", idle()) expr("last_active", last_active(context)) expr("last_notification", last_notification(context)) expr("nick_blacklist", nick_blacklist(nick)) expr("replied", replied(context)) else { PutModule("Error: Unexpected token \"" + token + "\""); } } PutDebug(dbg); return value; } #undef expr protected: /** * Check if the away status condition is met. * * @return True if away_only is not "yes" or away status is set */ bool away_only() { #ifdef PUSH_AWAY CString value = options["away_only"].AsLower(); return value != "yes" || user->IsIRCAway(); #else return true #endif } /** * Check how many clients are connected to ZNC. * * @return Number of connected clients */ unsigned int client_count() { return user->GetClients().size(); } /** * Check if the client_count condition is met. * * @return True if client_count is less than client_count_less_than or if client_count_less_than is zero */ bool client_count_less_than() { unsigned int value = options["client_count_less_than"].ToUInt(); return value == 0 || client_count() < value; } /** * Determine if the given message matches any highlight rules. * * @param message Message contents * @return True if message matches a highlight */ bool highlight(const CString& message) { CString msg = " " + message.AsLower() + " "; VCString values; options["highlight"].Split(" ", values, false); for (VCString::iterator i = values.begin(); i != values.end(); i++) { CString value = i->AsLower(); char prefix = value[0]; bool push = true; if (prefix == '-') { push = false; value.LeftChomp(1); } else if (prefix == '_') { value = " " + value.LeftChomp_n(1) + " "; } value = "*" + value + "*"; if (msg.WildCmp(value)) { return push; } } CNick nick = user->GetIRCNick(); if (message.find(nick.GetNick()) != string::npos) { return true; } return false; } /** * Check if the idle condition is met. * * @return True if idle is zero or elapsed time is greater than idle */ bool idle() { unsigned int value = options["idle"].ToUInt(); unsigned int now = time(NULL); return value == 0 || idle_time + value < now; } /** * Check if the last_active condition is met. * * @param context Channel or nick context * @return True if last_active is zero or elapsed time is greater than last_active */ bool last_active(const CString& context) { unsigned int value = options["last_active"].ToUInt(); unsigned int now = time(NULL); return value == 0 || last_active_time.count(context) < 1 || last_active_time[context] + value < now; } /** * Check if the last_notification condition is met. * * @param context Channel or nick context * @return True if last_notification is zero or elapsed time is greater than last_nofication */ bool last_notification(const CString& context) { unsigned int value = options["last_notification"].ToUInt(); unsigned int now = time(NULL); return value == 0 || last_notification_time.count(context) < 1 || last_notification_time[context] + value < now; } /** * Check if the nick_blacklist condition is met. * * @param nick Nick that sent the message * @return True if nick is not in the blacklist */ bool nick_blacklist(const CNick& nick) { VCString blacklist; options["nick_blacklist"].Split(" ", blacklist, false); CString name = nick.GetNick().AsLower(); for (VCString::iterator i = blacklist.begin(); i != blacklist.end(); i++) { if (name.WildCmp(i->AsLower())) { return false; } } return true; } /** * Check if the replied condition is met. * * @param context Channel or nick context * @return True if last_reply_time > last_notification_time or if replied is not "yes" */ bool replied(const CString& context) { CString value = options["replied"].AsLower(); return value != "yes" || last_notification_time[context] == 0 || last_notification_time[context] < last_reply_time[context]; } /** * Determine when to notify the user of a channel message. * * @param nick Nick that sent the message * @param channel Channel the message was sent to * @param message Message contents * @return Notification should be sent */ bool notify_channel(const CNick& nick, const CChan& channel, const CString& message) { CString context = channel.GetName(); CString expression = options["channel_conditions"].AsLower(); if (expression != "all") { return eval(expression, context, nick, message); } return away_only() && client_count_less_than() && highlight(message) && idle() && last_active(context) && last_notification(context) && nick_blacklist(nick) && replied(context) && true; } /** * Determine when to notify the user of a private message. * * @param nick Nick that sent the message * @return Notification should be sent */ bool notify_pm(const CNick& nick, const CString& message) { CString context = nick.GetNick(); CString expression = options["query_conditions"].AsLower(); if (expression != "all") { return eval(expression, context, nick, message); } return away_only() && client_count_less_than() && idle() && last_active(context) && last_notification(context) && nick_blacklist(nick) && replied(context) && true; } protected: /** * Handle the plugin being loaded. Retrieve plugin config values. * * @param args Plugin arguments * @param message Message to show the user after loading */ bool OnLoad(const CString& args, CString& message) { for (MCString::iterator i = defaults.begin(); i != defaults.end(); i++) { CString value = GetNV(i->first); if (value != "") { options[i->first] = value; } else { options[i->first] = defaults[i->first]; } } return true; } /** * Handle channel messages. * * @param nick Nick that sent the message * @param channel Channel the message was sent to * @param message Message contents */ EModRet OnChanMsg(CNick& nick, CChan& channel, CString& message) { if (notify_channel(nick, channel, message)) { CString title = "Highlight"; CString msg = channel.GetName(); msg += ": <" + nick.GetNick(); msg += "> " + message; send_message(msg, title, channel.GetName()); } return CONTINUE; } /** * Handle channel actions. * * @param nick Nick that sent the action * @param channel Channel the message was sent to * @param message Message contents */ EModRet OnChanAction(CNick& nick, CChan& channel, CString& message) { if (notify_channel(nick, channel, message)) { CString title = "Highlight"; CString msg = channel.GetName(); msg += ": " + nick.GetNick(); msg += " " + message; send_message(msg, title, channel.GetName()); } return CONTINUE; } /** * Handle a private message. * * @param nick Nick that sent the message * @param message Message contents */ EModRet OnPrivMsg(CNick& nick, CString& message) { if (notify_pm(nick, message)) { CString title = "Private Message"; CString msg = "From " + nick.GetNick(); msg += ": " + message; send_message(msg, title, nick.GetNick()); } return CONTINUE; } /** * Handle a private action. * * @param nick Nick that sent the action * @param message Message contents */ EModRet OnPrivAction(CNick& nick, CString& message) { if (notify_pm(nick, message)) { CString title = "Private Message"; CString msg = "* " + nick.GetNick(); msg += " " + message; send_message(msg, title, nick.GetNick()); } return CONTINUE; } /** * Handle a message sent by the user. * * @param target Target channel or nick * @param message Message contents */ EModRet OnUserMsg(CString& target, CString& message) { last_reply_time[target] = last_active_time[target] = idle_time = time(NULL); return CONTINUE; } /** * Handle an action sent by the user. * * @param target Target channel or nick * @param message Message contents */ EModRet OnUserAction(CString& target, CString& message) { last_reply_time[target] = last_active_time[target] = idle_time = time(NULL); return CONTINUE; } /** * Handle the user joining a channel. * * @param channel Channel name * @param key Channel key */ EModRet OnUserJoin(CString& channel, CString& key) { idle_time = time(NULL); return CONTINUE; } /** * Handle the user parting a channel. * * @param channel Channel name * @param message Part message */ EModRet OnUserPart(CString& channel, CString& message) { idle_time = time(NULL); return CONTINUE; } /** * Handle the user setting the channel topic. * * @param channel Channel name * @param topic Topic message */ EModRet OnUserTopic(CString& channel, CString& topic) { idle_time = time(NULL); return CONTINUE; } /** * Handle the user requesting the channel topic. * * @param channel Channel name */ EModRet OnUserTopicRequest(CString& channel) { idle_time = time(NULL); return CONTINUE; } /** * Handle direct commands to the *push virtual user. * * @param command Command string */ void OnModCommand(const CString& command) { VCString tokens; int token_count = command.Split(" ", tokens, false); if (token_count < 1) { return; } CString action = tokens[0].AsLower(); // SET command if (action == "set") { if (token_count < 3) { PutModule("Usage: set