1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137 |
- /**
- * 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
- #ifndef PUSHVERSION
- #define PUSHVERSION "dev"
- #endif
- #include <znc/znc.h>
- #include <znc/Chan.h>
- #include <znc/User.h>
- #include <znc/IRCNetwork.h>
- #include <znc/Modules.h>
- #include <znc/FileUtils.h>
- #include <znc/Client.h>
- #include "time.h"
- #include <string.h>
- #ifdef USE_CURL
- #include <curl/curl.h>
- #endif // USE_CURL
- // Forward declaration
- class CPushMod;
- /**
- * 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);
- }
- #ifndef USE_CURL
- /**
- * 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/" + CString(PUSHVERSION);
- }
- // 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;
- };
- #else
- // forward declaration
- long make_curl_request(const CString& service_host, const CString& service_url,
- const CString& service_auth, MCString& params, int port,
- bool use_ssl, bool use_post,
- const CString& proxy, bool proxy_ssl_verify,
- bool debug);
- #endif // USE_CURL
- /**
- * Push notification module.
- */
- class CPushMod : public CModule
- {
- protected:
- // Application name
- CString app;
- // Time last notification was sent for a given context
- std::map <CString, time_t> last_notification_time;
- // Time of last message by user to a given context
- std::map <CString, time_t> last_reply_time;
- // Time of last activity by user for a given context
- std::map <CString, time_t> last_active_time;
- // Time of last activity by user in any context
- time_t idle_time;
- // User object
- CUser *user;
- // Configuration options
- MCString options;
- MCString defaults;
- public:
- MODCONSTRUCTOR(CPushMod) {
- #ifdef USE_CURL
- curl_global_init(CURL_GLOBAL_DEFAULT);
- #endif
- app = "ZNC";
- idle_time = time(NULL);
- // Current user
- user = GetUser();
- // Push service information
- defaults["service"] = "igloo";
- defaults["username"] = "";
- defaults["secret"] = "";
- defaults["target"] = "";
- // Igloo Devices
- defaults["device1"] = "";
- defaults["device2"] = "";
- defaults["device3"] = "";
- defaults["device4"] = "";
- defaults["device5"] = "";
- // Notification settings
- defaults["message_content"] = "{context}: [{nick}] {message}";
- defaults["message_length"] = "100";
- defaults["message_title"] = "{title}";
- defaults["message_uri"] = "";
- defaults["message_uri_post"] = "no";
- defaults["message_uri_title"] = "";
- defaults["message_priority"] = "0";
- defaults["message_sound"] = "";
- defaults["message_escape"] = "";
- // Notification conditions
- defaults["away_only"] = "no";
- defaults["client_count_less_than"] = "0";
- defaults["highlight"] = "";
- defaults["idle"] = "0";
- defaults["last_active"] = "180";
- defaults["last_notification"] = "300";
- defaults["nick_blacklist"] = "";
- defaults["network_blacklist"] = "";
- defaults["replied"] = "yes";
- defaults["context"] = "*";
- // Proxy, for libcurl
- defaults["proxy"] = "";
- defaults["proxy_ssl_verify"] = "yes";
- // Advanced
- defaults["channel_conditions"] = "all";
- defaults["query_conditions"] = "all";
- defaults["debug"] = "off";
- }
- virtual ~CPushMod() {
- #ifdef USE_CURL
- curl_global_cleanup();
- #endif
- }
- 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;
- }
- /**
- * Verifies whether a given string contains only numbers.
- *
- * @param content String to verify
- */
- bool is_number(const CString& content)
- {
- CString::const_iterator it = content.begin();
- while(it != content.end() && std::isdigit(*it)) ++it;
- return !content.empty() && it == content.end();
- }
- /**
- * Send a message to the currently-configured push service.
- * 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"), const CString& type="")
- {
- // 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);
- // Message string replacements
- MCString replace;
- replace["{context}"] = context;
- replace["{nick}"] = nick.GetNick();
- replace["{datetime}"] = CString(iso8601);
- replace["{unixtime}"] = CString(time(NULL));
- replace["{message}"] = short_message;
- replace["{title}"] = title;
- replace["{username}"] = options["username"];
- replace["{secret}"] = options["secret"];
- replace["{target}"] = options["target"];
- // network is special because it can be nullptr if the user has none set up yet
- CIRCNetwork* network = GetNetwork();
- if (network) {
- replace["{network}"] = network->GetName();
- } else {
- replace["{network}"] = "(No network)";
- }
- if (options["message_escape"] != "")
- {
- CString::EEscape esc = CString::ToEscape(options["message_escape"]);
- for (MCString::iterator i = replace.begin(); i != replace.end(); i++) {
- i->second = i->second.Escape(esc);
- }
- }
- CString message_uri = expand(options["message_uri"], replace);
- CString message_title = expand(options["message_title"], replace);
- CString message_content = expand(options["message_content"], 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 == "pushbullet")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret (api key) not set");
- return;
- }
- service_host = "api.pushbullet.com";
- service_url = "/v2/pushes";
- // BASIC auth, base64-encoded APIKey:
- service_auth = options["secret"] + CString(":");
- if (options["target"] != "")
- {
- params["device_iden"] = options["target"];
- }
- if (message_uri == "")
- {
- params["type"] = "note";
- } else {
- params["type"] = "link";
- params["url"] = message_uri;
- }
- params["title"] = message_title;
- params["body"] = message_content;
- }
- 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]"] = message_content;
- params["notification[source_url]"] = message_uri;
- }
- else if (service == "boxcar2")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret not set to apikey");
- return;
- }
- service_host = "new.boxcar.io";
- service_url = "/api/notifications";
- params["user_credentials"] = options["secret"];
- params["notification[title]"] = message_title;
- params["notification[long_message]"] = message_content;
- if ( options["message_sound"] != "" )
- {
- params["notification[sound]"] = options["message_sound"];
- }
- }
- else if (service == "nma")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret not set");
- return;
- }
- if (options["message_priority"] != "")
- {
- params["priority"] = options["message_priority"];
- }
- service_host = "www.notifymyandroid.com";
- service_url = "/publicapi/notify";
- params["apikey"] = options["secret"];
- params["application"] = app;
- params["event"] = message_title;
- params["description"] = message_content;
- params["url"] = message_uri;
- }
- else if (service == "pushover")
- {
- if (options["username"] == "")
- {
- PutModule("Error: username (user key) not set");
- return;
- }
- if (options["secret"] == "")
- {
- PutModule("Error: secret (application token/key) not set");
- return;
- }
- service_host = "api.pushover.net";
- service_url = "/1/messages.json";
- params["token"] = options["secret"];
- params["user"] = options["username"];
- params["title"] = message_title;
- params["message"] = message_content;
- if (message_uri != "")
- {
- params["url"] = message_uri;
- }
- if ( options["message_uri_title"] != "" )
- {
- params["url_title"] = options["message_uri_title"];
- }
- if (options["target"] != "")
- {
- params["device"] = options["target"];
- }
- if ( options["message_sound"] != "" )
- {
- params["sound"] = options["message_sound"];
- }
- if (options["message_priority"] != "")
- {
- params["priority"] = options["message_priority"];
- }
- }
- else if (service == "pushsafer")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: privatekey (private or alias key) not set");
- return;
- }
- service_host = "pushsafer.com";
- service_url = "/api";
- params["k"] = options["secret"];
- params["t"] = message_title;
- params["m"] = message_content;
- if (message_uri != "")
- {
- params["u"] = message_uri;
- }
- if (options["message_uri_title"] != "" )
- {
- params["ut"] = options["message_uri_title"];
- }
- if (options["target"] != "")
- {
- params["d"] = options["target"];
- }
- if (options["message_sound"] != "" )
- {
- params["s"] = options["message_sound"];
- }
- }
- else if (service == "pushalot")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret (authorization token) not set");
- return;
- }
- service_host = "pushalot.com";
- service_url = "/api/sendmessage";
- params["AuthorizationToken"] = options["secret"];
- params["Title"] = message_title;
- params["Body"] = message_content;
- if (message_uri != "")
- {
- params["Link"] = message_uri;
- }
- if (options["message_uri_title"] != "" )
- {
- params["LinkTitle"] = options["message_uri_title"];
- }
- }
- 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"] = message_title;
- params["description"] = message_content;
- params["url"] = message_uri;
- }
- else if (service == "igloo")
- {
- if (options["device1"] == "" && options["device2"] == "" && options["device3"] == "" && options["device4"] == "" && options["device5"] == "")
- {
- PutModule("Error: no devices are set");
- return;
- }
- service_host = "api.iglooirc.com";
- service_url = "/znc/push";
- params["network"] = network->GetName();
- params["channel"] = context;
- params["message"] = message;
- params["nick"] = network->GetNick();
- params["sender"] = nick.GetNick();
- params["type"] = type;
- //params["developer"] = "true";
- params["device1"] = options["device1"];
- params["device2"] = options["device2"];
- params["device3"] = options["device3"];
- params["device4"] = options["device4"];
- params["device5"] = options["device5"];
- }
- else if (service == "supertoasty")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret (device id) not set");
- return;
- }
- use_post = false;
- use_port = 80;
- use_ssl = false;
- service_host = "api.supertoasty.com";
- service_url = "/notify/"+options["secret"];
- params["title"] = message_title;
- params["text"] = message_content;
- params["image"] = "https://raw2.github.com/jreese/znc-push/master/logo.png";
- params["sender"] = "ZNC Push";
- }
- else if (service == "faast")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret not set to apikey");
- return;
- }
- service_host = "www.appnotifications.com";
- service_url = "/account/notifications.json";
- params["user_credentials"] = options["secret"];
- params["notification[title]"] = message_title;
- params["notification[subtitle]"] = context;
- params["notification[message]"] = message_content;
- params["notification[long_message]"] = message_content;
- params["notification[icon_url]"] = "https://raw2.github.com/jreese/znc-push/master/logo.png";
- if ( options["message_sound"] != "" )
- {
- params["notification[sound]"] = options["message_sound"];
- }
- if ( options["message_uri"] != "" )
- {
- params["notification[run_command]"] = options["message_uri"];
- }
- }
- else if (service == "nexmo")
- {
- if (options["username"] == "")
- {
- PutModule("Error: username (api key) not set");
- return;
- }
- if (options["secret"] == "")
- {
- PutModule("Error: secret (api secret) not set");
- return;
- }
- if (options["target"] == "")
- {
- PutModule("Error: destination mobile number (in international format) not set");
- return;
- }
- service_host = "rest.nexmo.com";
- service_url = "/sms/json";
- params["api_secret"] = options["secret"];
- params["api_key"] = options["username"];
- params["from"] = message_title;
- params["to"] = options["target"];
- params["text"] = message_content;
- }
- else if (service == "url")
- {
- if (options["message_uri"] == "")
- {
- PutModule("Error: message_uri not set");
- return;
- }
- CString::size_type count;
- VCString parts;
- CString url = options["message_uri"];
- // Verify that the URL begins with either http:// or https://
- count = url.Split("://", parts, false);
- if (count != 2)
- {
- PutModule("Error: invalid url format");
- return;
- }
- if(options["message_uri_post"] != "yes")
- {
- use_post = false;
- }
- if (parts[0] == "https")
- {
- use_ssl = true;
- use_port = 443;
- }
- else if (parts[0] == "http")
- {
- use_ssl = false;
- use_port = 80;
- }
- else
- {
- PutModule("Error: invalid url schema");
- return;
- }
- // HTTP basic auth
- if(options["username"] != "" || options["secret"] != "")
- {
- service_auth = options["username"] + CString(":") + options["secret"];
- }
- // Process the remaining portion of the URL
- url = parts[1];
- // Split out the host and optional port number; this breaks with raw IPv6 addresses
- CString host = url.Token(0, false, "/");
- count = host.Split(":", parts, false);
- if (count > 1)
- {
- use_port = parts[1].ToInt();
- }
- service_host = parts[0];
- // Split remaining URL into path and query components
- url = "/" + url.Token(1, true, "/");
- service_url = expand(url.Token(0, false, "?"), replace);
- // Parse and expand query parameter values
- url = url.Token(1, true, "?");
- url.URLSplit(params);
- for (MCString::iterator i = params.begin(); i != params.end(); i++) {
- i->second = expand(i->second, replace);
- }
- }
- else if (service == "airgram")
- {
- PutModule("Error: Airgram service shut down. Please configure another notification provider.");
- }
- else if (service == "slack")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret (from webhook, e.g. T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX) not set");
- return;
- }
- if (options["target"] == "")
- {
- PutModule("Error: target (channel or username) not set");
- return;
- }
- service_host = "hooks.slack.com";
- service_url = "/services/" + options["secret"];
- if (options["username"] != "")
- {
- params["username"] = options["username"];
- }
- params["payload"] = expand("{\"channel\": \"{target}\", \"text\": \"*{title}*: {message}\"}", replace);
- PutDebug("payload: " + params["payload"]);
- }
- else if (service == "discord")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret (from webhook, e.g. 111111111111111111/abcdefghijklmopqrstuvwxyz1234567890-ABCDEFGHIJKLMNOPQRSTUVWXYZ123456) not set");
- return;
- }
- service_host = "discordapp.com";
- service_url = "/api/webhooks/" + options["secret"];
- if (options["username"] != "")
- {
- params["username"] = options["username"];
- }
- params["content"] = message_content;
- }
- else if (service == "pushjet")
- {
- if (options["secret"] == "")
- {
- PutModule("Error: secret (service key) not set");
- return;
- }
- service_host = "api.pushjet.io";
- service_url = "/message";
- params["secret"] = options["secret"];
- params["title"] = message_title;
- params["message"] = message_content;
- if (message_uri != "")
- {
- params["link"] = message_uri;
- }
- if (options["message_priority"] != "")
- {
- params["level"] = options["message_priority"];
- }
- }
- else if (service == "telegram")
- {
- if ((options["secret"] == "") || (options["target"] ==""))
- {
- PutModule("Error: secret (API key) or target (chat_id) not set");
- return;
- }
- service_host = "api.telegram.org";
- service_url = "/bot" + options["secret"] + "/sendMessage";
- params["chat_id"] = options["target"];
- params["text"] = message_content;
- if (options["message_escape"] == "HTML") {
- params["parse_mode"] = "HTML";
- }
- }
- else
- {
- PutModule("Error: service type not selected");
- return;
- }
- PutDebug("service: " + service);
- PutDebug("service_host: " + service_host);
- PutDebug("service_url: " + service_url);
- PutDebug("service_auth: " + service_auth);
- PutDebug("use_port: " + CString(use_port));
- PutDebug("use_ssl: " + CString(use_ssl ? 1 : 0));
- PutDebug("use_post: " + CString(use_post ? 1 : 0));
- #ifdef USE_CURL
- PutDebug("using libcurl");
- long http_code = make_curl_request(service_host, service_url, service_auth, params, use_port, use_ssl, use_post, options["proxy"], options["proxy_ssl_verify"] != "no", options["debug"] == "on");
- PutDebug("curl: HTTP status code " + CString(http_code));
- if (!(http_code >= 200 && http_code < 300)) {
- PutModule("Error: HTTP status code " + CString(http_code));
- }
- #else
- PutDebug("NOT using libcurl");
- // 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);
- #endif
- }
- /**
- * 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("network_blacklist", network_blacklist())
- expr("replied", replied(context))
- expr("context", context_filter(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()
- {
- CString value = options["away_only"].AsLower();
- return value != "yes" || GetNetwork()->IsIRCAway();
- }
- /**
- * Check how many clients are connected to ZNC.
- *
- * @return Number of connected clients
- */
- size_t client_count()
- {
- return GetNetwork()->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);
- values.push_back("%nick%");
- for (VCString::iterator i = values.begin(); i != values.end(); i++)
- {
- CString value = i->AsLower();
- char prefix = value[0];
- bool negate_match = false;
- if (prefix == '-')
- {
- negate_match = true;
- value.LeftChomp(1);
- }
- else if (prefix == '_')
- {
- value = " " + value.LeftChomp_n(1) + " ";
- }
- // Expand substrings like %nick%
- if (m_pNetwork)
- {
- value = m_pNetwork->ExpandString(value);
- }
- else
- {
- value = GetUser()->ExpandString(value);
- }
- value = "*" + value.AsLower() + "*";
- if (msg.WildCmp(value))
- {
- return !negate_match;
- }
- }
- return false;
- }
- /**
- * Determine if the given context matches any context rules.
- *
- * @param context The context of a message
- * @return True if context matches the filter
- */
- bool context_filter(const CString& raw_context)
- {
- CString context = raw_context.AsLower();
- if (context == "all" || context == "*")
- return true;
- VCString values;
- options["context"].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);
- }
- if (value != "*")
- {
- value = "*" + value.AsLower() + "*";
- }
- if (context.WildCmp(value))
- {
- return push;
- }
- }
- return false;
- }
- /**
- * Check if the idle condition is met.
- *
- * @return True if idle is less than or equal to zero or elapsed time is greater than idle
- */
- bool idle()
- {
- unsigned int value = options["idle"].ToUInt();
- time_t now = time(NULL);
- return value == 0 || difftime(now, idle_time) >= value;
- }
- /**
- * Check if the last_active condition is met.
- *
- * @param context Channel or nick context
- * @return True if last_active is less than or equal to zero or elapsed time is greater than last_active
- */
- bool last_active(const CString& context)
- {
- unsigned int value = options["last_active"].ToUInt();
- time_t now = time(NULL);
- return value == 0
- || last_active_time.count(context) < 1
- || difftime(now, last_active_time[context]) >= value;
- }
- /**
- * Check if the last_notification condition is met.
- *
- * @param context Channel or nick context
- * @return True if last_notification is less than or equal to zero or elapsed time is greater than last_nofication
- */
- bool last_notification(const CString& context)
- {
- unsigned int value = options["last_notification"].ToUInt();
- time_t now = time(NULL);
- return value == 0
- || last_notification_time.count(context) < 1
- || difftime(now, last_notification_time[context]) >= value;
- }
- /**
- * 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++)
- {
- CString value;
- // Expand substrings like %nick%
- if (m_pNetwork)
- {
- value = m_pNetwork->ExpandString(*i);
- }
- else
- {
- value = GetUser()->ExpandString(*i);
- }
- if (name.WildCmp(value.AsLower()))
- {
- return false;
- }
- }
- return true;
- }
- /**
- * Check if the network_blacklist condition is met.
- *
- * @param network Network that the message was received on
- * @return True if network is not in the blacklist
- */
- bool network_blacklist()
- {
- VCString blacklist;
- options["network_blacklist"].Split(" ", blacklist, false);
- CString name = (*m_pNetwork).GetName().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)
- && network_blacklist()
- && replied(context)
- && context_filter(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)
- && network_blacklist()
- && 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";
- send_message(message, title, channel.GetName(), nick);
- }
- 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";
- send_message(message, title, channel.GetName(), nick, "action");
- }
- return CONTINUE;
- }
- /**
- * Handle channel notices.
- *
- * @param nick Nick that sent the notice
- * @param channel Channel the notice was sent to
- * @param message Notice contents
- */
- EModRet OnChanNotice(CNick& nick, CChan& channel, CString& message)
- {
- if (notify_channel(nick, channel, message))
- {
- CString title = "Channel Notice";
- send_message(message, title, channel.GetName(), nick, "notice");
- }
- 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";
- send_message(message, title, nick.GetNick(), nick);
- }
- 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";
- send_message(message, title, nick.GetNick(), nick, "action");
- }
- return CONTINUE;
- }
- /**
- * Handle a private notice.
- *
- * @param nick Nick that sent the notice
- * @param message Notice contents
- */
- EModRet OnPrivNotice(CNick& nick, CString& message)
- {
- if (notify_pm(nick, message))
- {
- CString title = "Private Notice";
- send_message(message, title, nick.GetNick(), nick, "notice");
- }
- 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 a notice sent by the user.
- *
- * @param target Target channel or nick
- * @param message Notice contents
- */
- EModRet OnUserNotice(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;
- CString::size_type 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 <option> <value>");
- return;
- }
- CString option = tokens[1].AsLower();
- CString value = command.Token(2, true, " ");
- MCString::iterator pos = options.find(option);
- if (pos == options.end())
- {
- PutModule("Error: invalid option name");
- }
- else
- {
- value.Trim();
- if (option == "channel_conditions" || option == "query_conditions")
- {
- if (value != "all")
- {
- eval(value);
- }
- }
- else if (option == "service")
- {
- value.MakeLower();
- if (value == "pushbullet")
- {
- PutModule("Note: Pushbullet requires setting both 'target' (to device id) and 'secret' (to api key) options");
- }
- else if (value == "boxcar")
- {
- PutModule("Note: Boxcar requires setting the 'username' option");
- }
- else if (value == "boxcar2")
- {
- PutModule("Note: Boxcar 2 requires setting the 'secret' option");
- }
- else if (value == "nma")
- {
- PutModule("Note: NMA requires setting the 'secret' option");
- }
- else if (value == "pushover")
- {
- PutModule("Note: Pushover requires setting both the 'username' (to user key) and the 'secret' (to application api key) option");
- }
- else if (value == "pushsafer")
- {
- PutModule("Note: Pushsafer requires setting the 'private or alias key' option");
- }
- else if (value == "pushalot")
- {
- PutModule("Note: Pushalot requires setting the 'secret' (to user key) (to authorization token) option");
- }
- else if (value == "prowl")
- {
- PutModule("Note: Prowl requires setting the 'secret' option");
- }
- else if (value == "igloo")
- {
- PutModule("Note: Igloo requires adding your devices with device1-5");
- }
- else if (value == "supertoasty")
- {
- PutModule("Note: Supertoasty requires setting the 'secret' option with device id");
- }
- else if (value == "url")
- {
- PutModule("Note: URL requires setting the 'message_uri' option with the full URL");
- }
- else if (value == "faast")
- {
- PutModule("Note: Faast requires setting the secret to your apikey");
- }
- else if (value == "nexmo")
- {
- PutModule("Note: Nexmo requires setting the 'username' (to api key), 'secret' (to api secret), 'message_title' (to sender number in international format), and 'target' (to destination number in international format) options");
- }
- else if (value == "slack")
- {
- PutModule("Note: Slack requires setting 'secret' (from webhook) and 'target' (channel or username), optional 'username' (bot name)");
- }
- else if (value == "discord")
- {
- PutModule("Note: Discord requires setting 'secret' (from webhook), optional 'username' (bot name)");
- }
- else if (value == "pushjet")
- {
- PutModule("Note: Pushjet requires setting 'secret' (service key) option");
- }
- else if (value == "telegram")
- {
- PutModule("Note: Telegram requires setting both the 'secret' (api key) and 'target' (chat_id)");
- }
- else
- {
- PutModule("Error: unknown service name");
- return;
- }
- }
- options[option] = value;
- SetNV(option, options[option]);
- PutModule("Ok");
- }
- }
- // APPEND command
- else if (action == "append")
- {
- if (token_count < 3)
- {
- PutModule("Usage: append <option> <value>");
- return;
- }
- CString option = tokens[1].AsLower();
- CString value = command.Token(2, true, " ");
- MCString::iterator pos = options.find(option);
- if (pos == options.end())
- {
- PutModule("Error: invalid option name");
- }
- else if (option == "service")
- {
- PutModule("Error: cannot append to this option");
- }
- else
- {
- options[option] += " " + value;
- options[option].Trim();
- SetNV(option, options[option]);
- PutModule("Ok");
- }
- }
- // PREPEND command
- else if (action == "prepend")
- {
- if (token_count < 3)
- {
- PutModule("Usage: prepend <option> <value>");
- return;
- }
- CString option = tokens[1].AsLower();
- CString value = command.Token(2, true, " ");
- MCString::iterator pos = options.find(option);
- if (pos == options.end())
- {
- PutModule("Error: invalid option name");
- }
- else if (option == "service")
- {
- PutModule("Error: cannot prepend to this option");
- }
- else
- {
- options[option] = value + " " + options[option];
- options[option].Trim();
- SetNV(option, options[option]);
- PutModule("Ok");
- }
- }
- // UNSET command
- else if (action == "unset")
- {
- if (token_count != 2)
- {
- PutModule("Usage: unset <option>");
- return;
- }
- CString option = tokens[1].AsLower();
- MCString::iterator pos = options.find(option);
- if (pos == options.end())
- {
- PutModule("Error: invalid option name");
- }
- else
- {
- options[option] = defaults[option];
- DelNV(option);
- PutModule("Ok");
- }
- }
- // GET command
- else if (action == "get")
- {
- if (token_count > 2)
- {
- PutModule("Usage: get [<option>]");
- return;
- }
- if (token_count < 2)
- {
- CTable table;
- table.AddColumn("Option");
- table.AddColumn("Value");
- for (MCString::iterator i = options.begin(); i != options.end(); i++)
- {
- table.AddRow();
- table.SetCell("Option", i->first);
- table.SetCell("Value", i->second);
- }
- PutModule(table);
- return;
- }
- CString option = tokens[1].AsLower();
- MCString::iterator pos = options.find(option);
- if (pos == options.end())
- {
- PutModule("Error: invalid option name");
- }
- else
- {
- PutModule(option + CString(": ") + options[option]);
- }
- }
- // SAVE command
- else if (action == "save")
- {
- if (token_count < 2)
- {
- PutModule("Usage: save <filepath>");
- }
- CString file_path = command.Token(1, true, " ");
- int status = options.WriteToDisk(file_path);
- if (status == MCString::MCS_SUCCESS)
- {
- PutModule("Options saved to " + file_path);
- }
- else
- {
- switch (status)
- {
- case MCString::MCS_EOPEN:
- case MCString::MCS_EWRITE:
- case MCString::MCS_EWRITEFIL:
- PutModule("Failed to save options to " + file_path);
- break;
- default:
- PutModule("Failure");
- break;
- }
- }
- }
- // LOAD command
- else if (action == "load")
- {
- if (token_count < 2)
- {
- PutModule("Usage: load <filename>");
- }
- CString file_path = command.Token(1, true, " ");
- if (!CFile::Exists(file_path))
- {
- PutModule("File does not exist: " + file_path);
- return;
- }
- int status = options.ReadFromDisk(file_path);
- if (status == MCString::MCS_SUCCESS)
- {
- PutModule("Options loaded from " + file_path);
- // Restore any defaults that aren't in the loaded dictionary,
- // and save loaded options to ZNC's data store
- for (MCString::iterator i = defaults.begin(); i != defaults.end(); i++)
- {
- CString option = i->first;
- MCString::iterator pos = options.find(option);
- if (pos == options.end())
- {
- options[option] = defaults[option];
- DelNV(option);
- }
- else
- {
- SetNV(option, options[option]);
- }
- }
- }
- else
- {
- switch (status)
- {
- case MCString::MCS_EOPEN:
- case MCString::MCS_EREADFIL:
- PutModule("Failed to read options from " + file_path);
- break;
- default:
- PutModule("Failure");
- break;
- }
- }
- }
- // STATUS command
- else if (action == "status")
- {
- CTable table;
- table.AddColumn("Condition");
- table.AddColumn("Status");
- table.AddRow();
- table.SetCell("Condition", "away");
- table.SetCell("Status", GetNetwork()->IsIRCAway() ? "yes" : "no");
- table.AddRow();
- table.SetCell("Condition", "client_count");
- table.SetCell("Status", CString(client_count()));
- time_t now = time(NULL);
- time_t ago = now - idle_time;
- table.AddRow();
- table.SetCell("Condition", "idle");
- table.SetCell("Status", CString(ago) + " seconds");
- table.AddRow();
- table.SetCell("Condition", "network_blacklist");
- // network_blacklist() is True if the network is not in a blacklist
- table.SetCell("Status", network_blacklist() ? "no" : "yes");
- if (token_count > 1)
- {
- CString context = tokens[1];
- table.AddRow();
- table.SetCell("Condition", "last_active");
- if (last_active_time.count(context) < 1)
- {
- table.SetCell("Status", "n/a");
- }
- else
- {
- ago = now - last_active_time[context];
- table.SetCell("Status", CString(ago) + " seconds");
- }
- table.AddRow();
- table.SetCell("Condition", "last_notification");
- if (last_notification_time.count(context) < 1)
- {
- table.SetCell("Status", "n/a");
- }
- else
- {
- ago = now - last_notification_time[context];
- table.SetCell("Status", CString(ago) + " seconds");
- }
- table.AddRow();
- table.SetCell("Condition", "replied");
- table.SetCell("Status", replied(context) ? "yes" : "no");
- }
- PutModule(table);
- }
- // SUBSCRIBE command
- else if (action == "subscribe")
- {
- // 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;
- if (service == "boxcar")
- {
- if (options["username"] == "")
- {
- PutModule("Error: username not set");
- return;
- }
- CString boxcar_api_key = "puSd2qp2gCDZO7nWkvb9";
- service_host = "boxcar.io";
- service_url = "/devices/providers/" + boxcar_api_key + "/notifications/subscribe";
- params["email"] = options["username"];
- }
- else if (service == "airgram")
- {
- PutModule("Error: Airgram service shut down. Please configure a different notification provider.");
- }
- else
- {
- PutModule("Error: service does not support subscribe command");
- return;
- }
- #ifdef USE_CURL
- long http_code = make_curl_request(service_host, service_url, service_auth, params, use_port, use_ssl, use_post, options["proxy"], options["proxy_ssl_verify"] != "no", options["debug"] == "on");
- PutDebug("curl: HTTP status code " + CString(http_code));
- if (!(http_code >= 200 && http_code < 300)) {
- PutModule("Error: HTTP status code " + CString(http_code));
- }
- #else
- // 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);
- #endif
- PutModule("Ok");
- }
- // SEND command
- else if (action == "send")
- {
- CString message = command.Token(1, true, " ", true);
- send_message(message);
- PutModule("Ok");
- }
- // HELP command
- else if (action == "help")
- {
- PutModule("View the detailed documentation at https://github.com/jreese/znc-push/blob/master/README.md");
- }
- // VERSION command
- else if (action == "version")
- {
- PutModule("znc-push " + CString(PUSHVERSION));
- }
- // EVAL command
- else if (action == "eval")
- {
- CString value = command.Token(1, true, " ");
- PutModule(eval(value) ? "true" : "false");
- }
- else
- {
- PutModule("Error: invalid command, try `help`");
- }
- }
- };
- /**
- * Build a query string from a dictionary of request parameters.
- *
- * @param params Request parameters
- * @return query string
- */
- CString build_query_string(MCString& params)
- {
- bool more = false;
- CString query;
- CString key;
- CString value;
- for (MCString::iterator param = params.begin(); param != params.end(); param++)
- {
- key = urlencode(param->first);
- value = urlencode(param->second);
- if (more)
- {
- query += "&" + key + "=" + value;
- }
- else
- {
- query += key + "=" + value;
- more = true;
- }
- }
- return query;
- }
- #ifdef USE_CURL
- /**
- * Send an HTTP request using libcurl.
- *
- * @param service_host Host domain
- * @param service_url Host path
- * @param service_auth Basic auth string
- * @param params Request parameters
- * @param port Port number
- * @param use_ssl Use SSL
- * @param use_post Use POST method
- */
- long make_curl_request(const CString& service_host, const CString& service_url,
- const CString& service_auth, MCString& params, int port,
- bool use_ssl, bool use_post,
- const CString& proxy, bool proxy_ssl_verify,
- bool debug)
- {
- CURL *curl;
- CURLcode result;
- long http_code;
- curl = curl_easy_init();
- CString user_agent = "ZNC Push/" + CString(PUSHVERSION);
- CString url = CString(use_ssl ? "https" : "http") + "://" + service_host + service_url;
- CString query = build_query_string(params);
- if (!query.empty())
- {
- url = url + "?" + query;
- }
- if (debug)
- {
- curl_easy_setopt(curl, CURLOPT_VERBOSE, 1);
- }
- curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L);
- curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2L);
- curl_easy_setopt(curl, CURLOPT_URL, url.data());
- curl_easy_setopt(curl, CURLOPT_PORT, port);
- curl_easy_setopt(curl, CURLOPT_USERAGENT, user_agent.c_str());
- curl_easy_setopt(curl, CURLOPT_TIMEOUT, 3); // three seconds ought to be good enough for anyone, eh?
- if (service_auth != "")
- {
- curl_easy_setopt(curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
- curl_easy_setopt(curl, CURLOPT_USERPWD, service_auth.data());
- }
- if (use_post)
- {
- curl_easy_setopt(curl, CURLOPT_POST, 1);
- curl_easy_setopt(curl, CURLOPT_POSTFIELDS, query.data());
- curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, query.length());
- }
- if (proxy != "") {
- curl_easy_setopt(curl, CURLOPT_PROXY, proxy.c_str());
- if (!proxy_ssl_verify) {
- curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
- }
- }
- result = curl_easy_perform(curl);
- if (result != CURLE_OK) {
- curl_easy_cleanup(curl);
- return -1;
- }
- curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &http_code);
- curl_easy_cleanup(curl);
- return http_code;
- }
- #else
- /**
- * Send an HTTP request.
- *
- * @param post POST command
- * @param host Host domain
- * @param url Resource path
- * @param parameters Query parameters
- * @param auth Basic authentication string
- */
- void CPushSocket::Request(bool post, const CString& host, const CString& url, MCString& parameters, const CString& auth)
- {
- parent->PutDebug("Building notification to " + host + url + "...");
- CString query = build_query_string(parameters);
- // Request headers and POST body
- CString request;
- if (post)
- {
- request += "POST " + url + " HTTP/1.1" + crlf;
- request += "Content-Type: application/x-www-form-urlencoded" + crlf;
- request += "Content-Length: " + CString(query.length()) + crlf;
- }
- else
- {
- request += "GET " + url + "?" + query + " HTTP/1.1" + crlf;
- }
- request += "Host: " + host + crlf;
- request += "Connection: close" + crlf;
- request += "User-Agent: " + user_agent + crlf;
- parent->PutDebug("User-Agent: " + user_agent);
- if (auth != "")
- {
- CString auth_b64 = auth.Base64Encode_n();
- request += "Authorization: Basic " + auth_b64 + crlf;
- parent->PutDebug("Authorization: Basic " + auth_b64);
- }
- request += crlf;
- if (post)
- {
- request += query;
- }
- parent->PutDebug("Query string: " + query);
- Write(request);
- parent->PutDebug("Request sending");
- }
- /**
- * Read each line of data returned from the HTTP request.
- */
- void CPushSocket::ReadLine(const CString& data)
- {
- if (first)
- {
- CString status = data.Token(1);
- CString message = data.Token(2, true);
- parent->PutDebug("Status: " + status);
- parent->PutDebug("Message: " + message);
- first = false;
- }
- else
- {
- parent->PutDebug("Data: " + data);
- }
- }
- void CPushSocket::Disconnected()
- {
- parent->PutDebug("Disconnected.");
- Close(CSocket::CLT_AFTERWRITE);
- }
- #endif // USE_CURL
- template<> void TModInfo<CPushMod>(CModInfo& Info) {
- Info.AddType(CModInfo::UserModule);
- Info.SetWikiPage("push");
- }
- NETWORKMODULEDEFS(CPushMod, "Send highlights and personal messages to a push notification service")
|