garrettreid/prowl.cpp

## 633 changes: 633 additions & 0 deletions prowl.cpp
@@ -0,0 +1,633 @@

    /*
/*

     * Copyright (C) 2009 flakes @ EFNet
 * Copyright (C) 2009 flakes @ EFNet

     * New match logic by Gm4n @ freenode
 * New match logic by Gm4n @ freenode

     * Version 1.0 (2012-08-19)
 * Version 1.0 (2012-08-19)

     *
 *

     * This program is free software; you can redistribute it and/or modify it
 * This program is free software; you can redistribute it and/or modify it

     * under the terms of the GNU General Public License version 2 as published
 * under the terms of the GNU General Public License version 2 as published

     * by the Free Software Foundation.
 * by the Free Software Foundation.

     */
 */


    #define REQUIRESSL
#define REQUIRESSL


    #include "znc.h"
#include "znc.h"

    #include "User.h"
#include "User.h"

    #include "Chan.h"
#include "Chan.h"

    #include "Nick.h"
#include "Nick.h"

    #include "Modules.h"
#include "Modules.h"

    #include <string>
#include <string>


    #if (!defined(VERSION_MAJOR) || !defined(VERSION_MINOR) || (VERSION_MAJOR == 0 && VERSION_MINOR < 72))
#if (!defined(VERSION_MAJOR) || !defined(VERSION_MINOR) || (VERSION_MAJOR == 0 && VERSION_MINOR < 72))

    #error This module needs ZNC 0.072 or newer.
#error This module needs ZNC 0.072 or newer.

    #endif
#endif


    class CProwlMod : public CModule
class CProwlMod : public CModule

    {
{

    protected:
protected:

    	// Internal variables
	// Internal variables

    	CString m_host;
	CString m_host;

    	unsigned int m_notificationsSent;
	unsigned int m_notificationsSent;

    	time_t m_lastActivity;
	time_t m_lastActivity;


    	// Settings for prowl
	// Settings for prowl

    	CString m_apiKey;
	CString m_apiKey;

    	int m_priority;
	int m_priority;

    	CString m_subjectSuffix;
	CString m_subjectSuffix;


    	// Settings for matching
	// Settings for matching

    	int m_idleThreshold;
	int m_idleThreshold;

    	CString m_matchMode;
	CString m_matchMode;

    	CString m_chanOverride;
	CString m_chanOverride;

    	CString m_privOverride;
	CString m_privOverride;


    	VCString m_hilights;
	VCString m_hilights;


    public:
public:

    	MODCONSTRUCTOR(CProwlMod)
	MODCONSTRUCTOR(CProwlMod)

    	{
	{

    		m_host = "api.prowlapp.com";
		m_host = "api.prowlapp.com";

    		m_notificationsSent = 0;
		m_notificationsSent = 0;

    		m_lastActivity = time(NULL);
		m_lastActivity = time(NULL);


    		// defaults:
		// defaults:

    		m_priority = 0;
		m_priority = 0;

    		m_idleThreshold = 5;
		m_idleThreshold = 5;

    		m_matchMode = "basic";
		m_matchMode = "basic";

    		m_chanOverride = "normal";
		m_chanOverride = "normal";

    		m_privOverride = "normal";
		m_privOverride = "normal";

    		m_subjectSuffix = "";
		m_subjectSuffix = "";

    		// defaults end.
		// defaults end.

    	}
	}


    protected:
protected:

    	static CString URLEscape(const CString& sStr)
	static CString URLEscape(const CString& sStr)

    	{
	{

    		return sStr.Escape_n(CString::EASCII, CString::EURL);
		return sStr.Escape_n(CString::EASCII, CString::EURL);

    	}
	}


    	// This strips any forms of IRC formatting that google found for me
	// This strips any forms of IRC formatting that google found for me

    	static CString StripFormatting(const CString& sStr)
	static CString StripFormatting(const CString& sStr)

    	{
	{

    		CString s;
		CString s;

    		int state;
		int state;

    		int length = sStr.length();
		int length = sStr.length();

    		char *content = (char *) malloc(length+1), *cptr = content;
		char *content = (char *) malloc(length+1), *cptr = content;


    		// Loop through the source string one character at a time
		// Loop through the source string one character at a time

    		for(int i = 0; i < length; i++){
		for(int i = 0; i < length; i++){

    			switch(sStr.data()[i]) {
			switch(sStr.data()[i]) {

    				case 0x03:
				case 0x03:

    					// Remove color codes
					// Remove color codes

    					state = 0;
					state = 0;

    					i++;
					i++;

    					while(i < length) {
					while(i < length) {

    						// If we see a digit in 0 or 1, advance state
						// If we see a digit in 0 or 1, advance state

    						if((state == 0 || state == 1) && (sStr.data()[i] >= 0x30 && sStr.data()[i] <= 0x39)) {
						if((state == 0 || state == 1) && (sStr.data()[i] >= 0x30 && sStr.data()[i] <= 0x39)) {

    							i++;
							i++;

    							state++;
							state++;

    							continue;
							continue;

    						}
						}


    						// If we see a comma in either 1 or 2, move along to 3
						// If we see a comma in either 1 or 2, move along to 3

    						if((state == 1 || state == 2) && sStr.data()[i] == ',') {
						if((state == 1 || state == 2) && sStr.data()[i] == ',') {

    							i++;
							i++;

    							state = 3;
							state = 3;

    							continue;
							continue;

    						}
						}


    						// If we're at-or-post comma, a digit is all we need
						// If we're at-or-post comma, a digit is all we need

    						if((state == 3 || state == 4) && (sStr.data()[i] >= 0x30 || sStr.data()[i] <= 0x39)) {
						if((state == 3 || state == 4) && (sStr.data()[i] >= 0x30 || sStr.data()[i] <= 0x39)) {

    							i++;
							i++;

    							state++;
							state++;

    							continue;
							continue;

    						}
						}


    						// If no other conditions have matched, this character can't be parsed - abort!
						// If no other conditions have matched, this character can't be parsed - abort!

    						i--;
						i--;

    						break;
						break;

    					}
					}


    					// And now that we're done looping through this character
					// And now that we're done looping through this character

    					break;
					break;

    				case 0x02:
				case 0x02:

    					// Remove start/end bold
					// Remove start/end bold

    					break;
					break;

    				case 0x1F:
				case 0x1F:

    					// Remove start/end underline
					// Remove start/end underline

    					break;
					break;

    				case 0x0F:
				case 0x0F:

    					// Remove reset color
					// Remove reset color

    					break;
					break;

    				case 0x0E:
				case 0x0E:

    					// Remove italic/reverse
					// Remove italic/reverse

    					break;
					break;

    				default:
				default:

    					// If this is a normal character, just copy it over
					// If this is a normal character, just copy it over

    					*cptr = sStr.data()[i];
					*cptr = sStr.data()[i];

    					cptr++;
					cptr++;

    					break;
					break;

    			}
			}

    		}
		}


    		// Null terminate our string and return
		// Null terminate our string and return

    		*cptr = 0x00;
		*cptr = 0x00;

    		s = CString(content);
		s = CString(content);

    		free(content);
		free(content);

    		return s;
		return s;

    	}
	}


    	CString BuildRequest(const CString& sEvent, const CString& sDescription)
	CString BuildRequest(const CString& sEvent, const CString& sDescription)

    	{
	{

    		CString s;
		CString s;


    		s += "GET /publicapi/add";
		s += "GET /publicapi/add";

    		s += "?apikey=" + URLEscape(m_apiKey);
		s += "?apikey=" + URLEscape(m_apiKey);

    		s += "&priority=" + CString(m_priority);
		s += "&priority=" + CString(m_priority);

    		s += "&application=ZNC";
		s += "&application=ZNC";

    		s += "&event=" + URLEscape(sEvent);
		s += "&event=" + URLEscape(sEvent);

    		s += "&description=" + URLEscape(StripFormatting(sDescription));
		s += "&description=" + URLEscape(StripFormatting(sDescription));


    		s += " HTTP/1.0\r\n";
		s += " HTTP/1.0\r\n";

    		s += "Connection: close\r\n";
		s += "Connection: close\r\n";

    		s += "Host: " + m_host + "\r\n";
		s += "Host: " + m_host + "\r\n";

    		s += "User-Agent: " + CZNC::GetTag() + "\r\n";
		s += "User-Agent: " + CZNC::GetTag() + "\r\n";

    		s += "\r\n";
		s += "\r\n";


    		return s;
		return s;

    	}
	}


    	void SendNotification(const CString& sEvent, const CString& sMessage)
	void SendNotification(const CString& sEvent, const CString& sMessage)

    	{
	{

    		if(!m_apiKey.empty())
		if(!m_apiKey.empty())

    		{
		{

    			CSocket *p = new CSocket(this);
			CSocket *p = new CSocket(this);

    			p->Connect(m_host, 443, true); // connect to host at port 443 using SSL
			p->Connect(m_host, 443, true); // connect to host at port 443 using SSL

    			p->Write(BuildRequest(sEvent, sMessage));
			p->Write(BuildRequest(sEvent, sMessage));

    			p->Close(Csock::CLT_AFTERWRITE); // discard the response...
			p->Close(Csock::CLT_AFTERWRITE); // discard the response...

    			AddSocket(p);
			AddSocket(p);


    			m_notificationsSent++;
			m_notificationsSent++;

    		}
		}

    	}
	}


    	// Called internally to do "is this a hilight" logic
	// Called internally to do "is this a hilight" logic

    	bool CheckHilight(const CString& sMessage)
	bool CheckHilight(const CString& sMessage)

    	{
	{

    		// Do case insensitive matching:
		// Do case insensitive matching:

    		const CString sLcMessage = sMessage.AsLower();
		const CString sLcMessage = sMessage.AsLower();


    		// Do some setup:
		// Do some setup:

    		const CString sLcNick = m_pUser->GetCurNick();
		const CString sLcNick = m_pUser->GetCurNick();

    		// Prepend current nick to list of hilights
		// Prepend current nick to list of hilights

    		m_hilights.push_back(sLcNick);
		m_hilights.push_back(sLcNick);


    		// Iterate through all the hilights, attempting one match at a time
		// Iterate through all the hilights, attempting one match at a time

    		bool retval = false;
		bool retval = false;

    		for(VCString::iterator it = m_hilights.begin();
		for(VCString::iterator it = m_hilights.begin();

    			it != m_hilights.end();
			it != m_hilights.end();

    			it++)
			it++)

    		{
		{

    			// If the string is too short to match, do nothing
			// If the string is too short to match, do nothing

    			if(sLcMessage.length() < (*it).length())
			if(sLcMessage.length() < (*it).length())

    				continue;
				continue;


    			// If lengths are equal, comparison is simple
			// If lengths are equal, comparison is simple

    			if(sLcMessage.length() == (*it).length()) {
			if(sLcMessage.length() == (*it).length()) {

    				// If we're a direct match, we win.
				// If we're a direct match, we win.

    				if(sLcMessage.CaseCmp(*it) == 0) {
				if(sLcMessage.CaseCmp(*it) == 0) {

    					retval = true;
					retval = true;

    					break;
					break;

    				}
				}


    				// If we don't match, this loop failed
				// If we don't match, this loop failed

    				continue;
				continue;

    			}
			}


    			// Check message if we're using "addressed" type matching:
			// Check message if we're using "addressed" type matching:

    			if(m_matchMode.StrCmp("addressed") == 0) {
			if(m_matchMode.StrCmp("addressed") == 0) {

    				// If the message starts with our nick
				// If the message starts with our nick

    				if(strncmp(sLcMessage.data(), (*it).data(), (*it).length()) == 0) {
				if(strncmp(sLcMessage.data(), (*it).data(), (*it).length()) == 0) {

    					// See if we have an immediate delimiter:
					// See if we have an immediate delimiter:

    					char c = sLcMessage.data()[(*it).length()];
					char c = sLcMessage.data()[(*it).length()];

    					if(c == ' ' || c == ':' || c == ',') {
					if(c == ' ' || c == ':' || c == ',') {

    						retval = true;
						retval = true;

    						break;
						break;

    					}
					}

    				}
				}

    				continue;
				continue;

    			}
			}


    			// Check message if we're using "basic" type matching:
			// Check message if we're using "basic" type matching:

    			if(m_matchMode.StrCmp("basic") == 0) {
			if(m_matchMode.StrCmp("basic") == 0) {

    				// Check for a plain old match
				// Check for a plain old match

    				if(sLcMessage.find((*it).AsLower()) != CString::npos) {
				if(sLcMessage.find((*it).AsLower()) != CString::npos) {

    					retval = true;
					retval = true;

    					break;
					break;

    				}
				}

    			}
			}

    		}
		}


    		// Clean up, and return our result
		// Clean up, and return our result

    		m_hilights.erase(m_hilights.begin());
		m_hilights.erase(m_hilights.begin());

    		return retval;
		return retval;

    	}
	}


    	void ParsePrivMsg(const CString& sNick, const CString& sMessage)
	void ParsePrivMsg(const CString& sNick, const CString& sMessage)

    	{
	{

    		// Sanity check
		// Sanity check

    		if(!m_pUser) return;
		if(!m_pUser) return;


    		// If user is attached and recently active, return
		// If user is attached and recently active, return

    		if (m_pUser->IsUserAttached() &&
		if (m_pUser->IsUserAttached() &&

    				m_lastActivity > time(NULL) - m_idleThreshold * 60)
				m_lastActivity > time(NULL) - m_idleThreshold * 60)

    					return;
					return;


    		// Check if we have an override preventing match
		// Check if we have an override preventing match

    		if (m_privOverride == "disable")
		if (m_privOverride == "disable")

    			return;
			return;


    		// If we're here, send if override forces match, or if match
		// If we're here, send if override forces match, or if match

    		if(m_privOverride == "force" || CheckHilight(sMessage)) {
		if(m_privOverride == "force" || CheckHilight(sMessage)) {

    			return SendNotification("Private message" + m_subjectSuffix, "<" + sNick + ">: " + sMessage);
			return SendNotification("Private message" + m_subjectSuffix, "<" + sNick + ">: " + sMessage);

    		}
		}

    	}
	}


    	void ParseChanMsg(const CString& sNick, const CString &chan, const CString& sMessage)
	void ParseChanMsg(const CString& sNick, const CString &chan, const CString& sMessage)

    	{
	{

    		// Sanity check
		// Sanity check

    		if(!m_pUser) return;
		if(!m_pUser) return;


    		// If idle is non-zero and user is attached, user must be idle
		// If idle is non-zero and user is attached, user must be idle

    		if (m_idleThreshold != 0 && m_pUser->IsUserAttached())
		if (m_idleThreshold != 0 && m_pUser->IsUserAttached())

    			if (m_lastActivity > time(NULL) - m_idleThreshold * 60)
			if (m_lastActivity > time(NULL) - m_idleThreshold * 60)

    				return;
				return;


    		// Check if we have an override preventing match
		// Check if we have an override preventing match

    		if (m_chanOverride == "disable")
		if (m_chanOverride == "disable")

    			return;
			return;


    		// If we're here, send if override forces match, or if match
		// If we're here, send if override forces match, or if match

    		if(m_chanOverride == "force" || CheckHilight(sMessage)) {
		if(m_chanOverride == "force" || CheckHilight(sMessage)) {

    			return SendNotification(chan + " hilight" + m_subjectSuffix, "<" + sNick + ">: " + sMessage);
			return SendNotification(chan + " hilight" + m_subjectSuffix, "<" + sNick + ">: " + sMessage);

    		}
		}

    	}
	}


    	void LoadSettings()
	void LoadSettings()

    	{
	{

    		for(MCString::iterator it = BeginNV(); it != EndNV(); it++)
		for(MCString::iterator it = BeginNV(); it != EndNV(); it++)

    		{
		{

    			// Settings for prowl
			// Settings for prowl

    			if(it->first == "api:key")
			if(it->first == "api:key")

    			{
			{

    				m_apiKey = it->second;
				m_apiKey = it->second;

    			}
			}

    			else if(it->first == "api:priority")
			else if(it->first == "api:priority")

    			{
			{

    				m_priority = it->second.ToInt();
				m_priority = it->second.ToInt();

    			}
			}


    			// Settings for matching
			// Settings for matching

    			else if(it->first == "u:idle")
			else if(it->first == "u:idle")

    			{
			{

    				m_idleThreshold = it->second.ToInt();
				m_idleThreshold = it->second.ToInt();

    			}
			}

    			else if(it->first == "u:matchmode")
			else if(it->first == "u:matchmode")

    			{
			{

    				m_matchMode = it->second;
				m_matchMode = it->second;

    			}
			}

    			else if(it->first == "u:privoverride")
			else if(it->first == "u:privoverride")

    			{
			{

    				m_privOverride = it->second;
				m_privOverride = it->second;

    			}
			}

    			else if(it->first == "u:chanoverride")
			else if(it->first == "u:chanoverride")

    			{
			{

    				m_chanOverride = it->second;
				m_chanOverride = it->second;

    			}
			}

    			else if(it->first == "u:suffix")
			else if(it->first == "u:suffix")

    			{
			{

    				m_subjectSuffix = it->second;
				m_subjectSuffix = it->second;

    			}
			}

    			else if(it->first == "u:hilights")
			else if(it->first == "u:hilights")

    			{
			{

    				it->second.Split("\n", m_hilights, false);
				it->second.Split("\n", m_hilights, false);

    			}
			}

    		}
		}

    	}
	}


    	void SaveSettings()
	void SaveSettings()

    	{
	{

    		ClearNV();
		ClearNV();


    		// Settings for prowl
		// Settings for prowl

    		SetNV("api:key", m_apiKey, false);
		SetNV("api:key", m_apiKey, false);

    		SetNV("api:priority", CString(m_priority), false);
		SetNV("api:priority", CString(m_priority), false);


    		// Settings for matching
		// Settings for matching

    		SetNV("u:idle", CString(m_idleThreshold), false);
		SetNV("u:idle", CString(m_idleThreshold), false);

    		SetNV("u:matchmode", m_matchMode, false);
		SetNV("u:matchmode", m_matchMode, false);

    		SetNV("u:privoverride", m_privOverride, false);
		SetNV("u:privoverride", m_privOverride, false);

    		SetNV("u:chanoverride", m_chanOverride, false);
		SetNV("u:chanoverride", m_chanOverride, false);

    		SetNV("u:suffix", m_subjectSuffix, false);
		SetNV("u:suffix", m_subjectSuffix, false);


    		CString sTmp;
		CString sTmp;

    		for(VCString::const_iterator it = m_hilights.begin(); it != m_hilights.end(); it++) { sTmp += *it + "\n"; }
		for(VCString::const_iterator it = m_hilights.begin(); it != m_hilights.end(); it++) { sTmp += *it + "\n"; }

    		SetNV("u:hilights", sTmp, true);
		SetNV("u:hilights", sTmp, true);

    	}
	}


    	bool OnLoad(const CString& sArgs, CString& sMessage)
	bool OnLoad(const CString& sArgs, CString& sMessage)

    	{
	{

    		LoadSettings();
		LoadSettings();

    		return true;
		return true;

    	}
	}

    public:
public:

    	void OnModCommand(const CString& sCommand)
	void OnModCommand(const CString& sCommand)

    	{
	{

    		const CString sCmd = sCommand.Token(0).AsUpper();
		const CString sCmd = sCommand.Token(0).AsUpper();


    		if(sCmd == "HELP")
		if(sCmd == "HELP")

    		{
		{

    			CTable CmdTable;
			CTable CmdTable;

    			CmdTable.AddColumn("Command");
			CmdTable.AddColumn("Command");

    			CmdTable.AddColumn("Description");
			CmdTable.AddColumn("Description");


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Command", "SET [<variable> [<value>]]");
			CmdTable.SetCell("Command", "SET [<variable> [<value>]]");

    			CmdTable.SetCell("Description", "View and set configuration variables.");
			CmdTable.SetCell("Description", "View and set configuration variables.");


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Command", "STATUS");
			CmdTable.SetCell("Command", "STATUS");

    			CmdTable.SetCell("Description", "Show module status information.");
			CmdTable.SetCell("Description", "Show module status information.");


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Command", "HIGHLIGHTS");
			CmdTable.SetCell("Command", "HIGHLIGHTS");

    			CmdTable.SetCell("Description", "Shows words (besides your nick) that trigger a notification.");
			CmdTable.SetCell("Description", "Shows words (besides your nick) that trigger a notification.");


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Command", "HIGHLIGHTS ADD <word>");
			CmdTable.SetCell("Command", "HIGHLIGHTS ADD <word>");

    			CmdTable.SetCell("Description", "Adds a word or string to match and notify.");
			CmdTable.SetCell("Description", "Adds a word or string to match and notify.");


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Command", "HIGHLIGHTS REMOVE <index>");
			CmdTable.SetCell("Command", "HIGHLIGHTS REMOVE <index>");

    			CmdTable.SetCell("Description", "Removes a word from the hilights list by index number.");
			CmdTable.SetCell("Description", "Removes a word from the hilights list by index number.");


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Command", "HELP");
			CmdTable.SetCell("Command", "HELP");

    			CmdTable.SetCell("Description", "This help message.");
			CmdTable.SetCell("Description", "This help message.");


    			PutModule(CmdTable);
			PutModule(CmdTable);

    			return;
			return;

    		}
		}


    		const CString sSubCmd = sCommand.Token(1).AsLower();
		const CString sSubCmd = sCommand.Token(1).AsLower();


    		if(sCmd == "SET" || sCmd == "CHANGE")
		if(sCmd == "SET" || sCmd == "CHANGE")

    		{
		{

    			if(sSubCmd == "")
			if(sSubCmd == "")

    			{
			{

    				CTable CmdTable;
				CTable CmdTable;

    				CmdTable.AddColumn("Setting");
				CmdTable.AddColumn("Setting");

    				CmdTable.AddColumn("Description");
				CmdTable.AddColumn("Description");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "apikey <key>");
				CmdTable.SetCell("Setting", "apikey <key>");

    				CmdTable.SetCell("Description", "Your prowl API key.");
				CmdTable.SetCell("Description", "Your prowl API key.");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "priority <number>");
				CmdTable.SetCell("Setting", "priority <number>");

    				CmdTable.SetCell("Description", "The priority of the delivered prowl notification.");
				CmdTable.SetCell("Description", "The priority of the delivered prowl notification.");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "idle <minutes>");
				CmdTable.SetCell("Setting", "idle <minutes>");

    				CmdTable.SetCell("Description", "Only send notifications if idle for <minutes> or not connected. 0 disables this check.");
				CmdTable.SetCell("Description", "Only send notifications if idle for <minutes> or not connected. 0 disables this check.");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "matchmode basic");
				CmdTable.SetCell("Setting", "matchmode basic");

    				CmdTable.SetCell("Description", "Match any message containing a hilighted term (nickname or highlights list).");
				CmdTable.SetCell("Description", "Match any message containing a hilighted term (nickname or highlights list).");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "matchmode addressed");
				CmdTable.SetCell("Setting", "matchmode addressed");

    				CmdTable.SetCell("Description", "Match if line begins with a hilighted term and is followed by a space, comma or colon.");
				CmdTable.SetCell("Description", "Match if line begins with a hilighted term and is followed by a space, comma or colon.");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "privoverride <normal|disable|force>");
				CmdTable.SetCell("Setting", "privoverride <normal|disable|force>");

    				CmdTable.SetCell("Description", "For PMs, optionally disable hilights or force all messages to hilight.");
				CmdTable.SetCell("Description", "For PMs, optionally disable hilights or force all messages to hilight.");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "chanoverride <normal|disable|force>");
				CmdTable.SetCell("Setting", "chanoverride <normal|disable|force>");

    				CmdTable.SetCell("Description", "For channel messages, optionally disable hilights or force all messages to hilight.");
				CmdTable.SetCell("Description", "For channel messages, optionally disable hilights or force all messages to hilight.");


    				CmdTable.AddRow();
				CmdTable.AddRow();

    				CmdTable.SetCell("Setting", "suffix [string]");
				CmdTable.SetCell("Setting", "suffix [string]");

    				CmdTable.SetCell("Description", "An optional suffix for message subjects to differentiate accounts. Eg 'on Freenode'.");
				CmdTable.SetCell("Description", "An optional suffix for message subjects to differentiate accounts. Eg 'on Freenode'.");


    				PutModule(CmdTable);
				PutModule(CmdTable);

    			}
			}


    			if(sSubCmd == "apikey")
			if(sSubCmd == "apikey")

    			{
			{

    				if(sCommand.Token(2) == "")
				if(sCommand.Token(2) == "")

    				{
				{

    					PutModule("Your API key is '" + m_apiKey + "'.");
					PutModule("Your API key is '" + m_apiKey + "'.");

    				} else {
				} else {

    					m_apiKey = sCommand.Token(2).AsLower();
					m_apiKey = sCommand.Token(2).AsLower();

    					PutModule("Your API key is now '" + m_apiKey + "'.");
					PutModule("Your API key is now '" + m_apiKey + "'.");

    				}
				}

    			}
			}

    			else if(sSubCmd == "priority")
			else if(sSubCmd == "priority")

    			{
			{

    				if(sCommand.Token(2) == "")
				if(sCommand.Token(2) == "")

    				{
				{

    					PutModule("Your priority is " + CString(m_priority) + ".");
					PutModule("Your priority is " + CString(m_priority) + ".");

    				} else {
				} else {

    					m_priority = sCommand.Token(2).ToInt();
					m_priority = sCommand.Token(2).ToInt();

    					PutModule("Your priority is now " + CString(m_priority) + ".");
					PutModule("Your priority is now " + CString(m_priority) + ".");

    				}
				}

    			}
			}

    			else if(sSubCmd == "idle")
			else if(sSubCmd == "idle")

    			{
			{

    				if(sCommand.Token(2) == "")
				if(sCommand.Token(2) == "")

    				{
				{

    					PutModule("Your idle time is " + CString(m_idleThreshold) + " minutes.");
					PutModule("Your idle time is " + CString(m_idleThreshold) + " minutes.");

    				} else {
				} else {

    					m_idleThreshold = sCommand.Token(2).ToInt();
					m_idleThreshold = sCommand.Token(2).ToInt();

    					PutModule("Your idle time is now " + CString(m_idleThreshold) + " minutes.");
					PutModule("Your idle time is now " + CString(m_idleThreshold) + " minutes.");

    				}
				}

    			}
			}

    			else if(sSubCmd == "matchmode")
			else if(sSubCmd == "matchmode")

    			{
			{

    				if(sCommand.Token(2) == "")
				if(sCommand.Token(2) == "")

    				{
				{

    					PutModule("Your matchmode is '" + m_matchMode + "'.");
					PutModule("Your matchmode is '" + m_matchMode + "'.");

    				} else {
				} else {

    					const CString tmp = sCommand.Token(2).AsLower();
					const CString tmp = sCommand.Token(2).AsLower();

    					if(tmp == "basic" || tmp == "addressed")
					if(tmp == "basic" || tmp == "addressed")

    					{
					{

    						m_matchMode = tmp;
						m_matchMode = tmp;

    						PutModule("Your matchmode is now '" + m_matchMode + "'.");
						PutModule("Your matchmode is now '" + m_matchMode + "'.");

    					} else {
					} else {

    						PutModule("Invalid matchmode '" + tmp + "'!");
						PutModule("Invalid matchmode '" + tmp + "'!");

    					}
					}

    				}
				}

    			}
			}

    			else if(sSubCmd == "privoverride")
			else if(sSubCmd == "privoverride")

    			{
			{

    				if(sCommand.Token(2) == "")
				if(sCommand.Token(2) == "")

    				{
				{

    					PutModule("Your privoverride is '" + m_privOverride + "'.");
					PutModule("Your privoverride is '" + m_privOverride + "'.");

    				} else {
				} else {

    					const CString tmp = sCommand.Token(2).AsLower();
					const CString tmp = sCommand.Token(2).AsLower();

    					if(tmp == "normal" || tmp == "disable" || tmp == "force")
					if(tmp == "normal" || tmp == "disable" || tmp == "force")

    					{
					{

    						m_privOverride = tmp;
						m_privOverride = tmp;

    						PutModule("Your privoverride is now '" + m_privOverride + "'.");
						PutModule("Your privoverride is now '" + m_privOverride + "'.");

    					} else {
					} else {

    						PutModule("Invalid privoverride '" + tmp + "'!");
						PutModule("Invalid privoverride '" + tmp + "'!");

    					}
					}

    				}
				}

    			}
			}

    			else if(sSubCmd == "chanoverride")
			else if(sSubCmd == "chanoverride")

    			{
			{

    				if(sCommand.Token(2) == "")
				if(sCommand.Token(2) == "")

    				{
				{

    					PutModule("Your chanoverride is '" + m_chanOverride + "'.");
					PutModule("Your chanoverride is '" + m_chanOverride + "'.");

    				} else {
				} else {

    					const CString tmp = sCommand.Token(2).AsLower();
					const CString tmp = sCommand.Token(2).AsLower();

    					if(tmp == "normal" || tmp == "disable" || tmp == "force")
					if(tmp == "normal" || tmp == "disable" || tmp == "force")

    					{
					{

    						m_chanOverride = tmp;
						m_chanOverride = tmp;

    						PutModule("Your chanoverride is now '" + m_chanOverride + "'.");
						PutModule("Your chanoverride is now '" + m_chanOverride + "'.");

    					} else {
					} else {

    						PutModule("Invalid chanoverride '" + tmp + "'!");
						PutModule("Invalid chanoverride '" + tmp + "'!");

    					}
					}

    				}
				}

    			}
			}

    			else if(sSubCmd == "suffix")
			else if(sSubCmd == "suffix")

    			{
			{

    				if(sCommand.Token(2) == "")
				if(sCommand.Token(2) == "")

    				{
				{

    					PutModule("Your suffix is" + m_subjectSuffix + ". To unset, use suffix 'unset'.");
					PutModule("Your suffix is" + m_subjectSuffix + ". To unset, use suffix 'unset'.");

    				}
				}

    				else if(sCommand.Token(2) == "unset") {
				else if(sCommand.Token(2) == "unset") {

    					m_subjectSuffix = "";
					m_subjectSuffix = "";

    					PutModule("Your suffix is now" + m_subjectSuffix + ".");
					PutModule("Your suffix is now" + m_subjectSuffix + ".");

    				} else {
				} else {

    					m_subjectSuffix = sCommand.LeftChomp_n(10); // strip off the "set suffix"
					m_subjectSuffix = sCommand.LeftChomp_n(10); // strip off the "set suffix"

    					PutModule("Your suffix is now" + m_subjectSuffix + ".");
					PutModule("Your suffix is now" + m_subjectSuffix + ".");

    				}
				}

    			}
			}

    			else if(sSubCmd != "")
			else if(sSubCmd != "")

    			{
			{

    				PutModule("Unknown setting. Use SET to list available settings.");
				PutModule("Unknown setting. Use SET to list available settings.");

    			}
			}


    			// Save what we've done, so reboot doesn't lose anything
			// Save what we've done, so reboot doesn't lose anything

    			SaveSettings();
			SaveSettings();

    		}
		}


    		else if(sCmd == "HIGHLIGHTS" || sCmd == "HIGHLIGHT" || sCmd == "HILIGHTS" || sCmd == "HILIGHT")
		else if(sCmd == "HIGHLIGHTS" || sCmd == "HIGHLIGHT" || sCmd == "HILIGHTS" || sCmd == "HILIGHT")

    		{
		{

    			if(sSubCmd == "")
			if(sSubCmd == "")

    			{
			{

    				size_t iIndex = 1;
				size_t iIndex = 1;


    				PutModule("Active additional hilights:");
				PutModule("Active additional hilights:");


    				for(VCString::const_iterator it = m_hilights.begin(); it != m_hilights.end(); it++)
				for(VCString::const_iterator it = m_hilights.begin(); it != m_hilights.end(); it++)

    				{
				{

    					PutModule(CString(iIndex) + ": " + *it);
					PutModule(CString(iIndex) + ": " + *it);

    					iIndex++;
					iIndex++;

    				}
				}


    				PutModule("--End of list");
				PutModule("--End of list");

    			}
			}

    			else if(sSubCmd == "add")
			else if(sSubCmd == "add")

    			{
			{

    				const CString sParam = sCommand.Token(2, true);
				const CString sParam = sCommand.Token(2, true);


    				if(!sParam.empty())
				if(!sParam.empty())

    				{
				{

    					m_hilights.push_back(sParam);
					m_hilights.push_back(sParam);

    					PutModule("Entry '" + sParam + "' added.");
					PutModule("Entry '" + sParam + "' added.");

    					SaveSettings();
					SaveSettings();

    				}
				}

    				else
				else

    				{
				{

    					PutModule("Usage: HIGHTLIGHTS ADD <string>");
					PutModule("Usage: HIGHTLIGHTS ADD <string>");

    				}
				}

    			}
			}

    			else if(sSubCmd == "remove" || sSubCmd == "delete")
			else if(sSubCmd == "remove" || sSubCmd == "delete")

    			{
			{

    				size_t iIndex = sCommand.Token(2).ToUInt();
				size_t iIndex = sCommand.Token(2).ToUInt();


    				if(iIndex > 0 && iIndex <= m_hilights.size())
				if(iIndex > 0 && iIndex <= m_hilights.size())

    				{
				{

    					m_hilights.erase(m_hilights.begin() + iIndex - 1);
					m_hilights.erase(m_hilights.begin() + iIndex - 1);

    					PutModule("Entry removed.");
					PutModule("Entry removed.");

    					SaveSettings();
					SaveSettings();

    				}
				}

    				else
				else

    				{
				{

    					PutModule("Invalid list index.");
					PutModule("Invalid list index.");

    				}
				}

    			}
			}

    			else
			else

    			{
			{

    				PutModule("Unknown action. Try HELP.");
				PutModule("Unknown action. Try HELP.");

    			}
			}

    		}
		}


    		else if(sCmd == "STATUS" || sCmd == "SHOW")
		else if(sCmd == "STATUS" || sCmd == "SHOW")

    		{
		{

    			CTable CmdTable;
			CTable CmdTable;


    			CmdTable.AddColumn("Status Item");
			CmdTable.AddColumn("Status Item");

    			CmdTable.AddColumn("Value");
			CmdTable.AddColumn("Value");


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Status Item", "Additional Hilights");
			CmdTable.SetCell("Status Item", "Additional Hilights");

    			CmdTable.SetCell("Value", CString(m_hilights.size()));
			CmdTable.SetCell("Value", CString(m_hilights.size()));


    			CmdTable.AddRow();
			CmdTable.AddRow();

    			CmdTable.SetCell("Status Item", "Notifications Sent");
			CmdTable.SetCell("Status Item", "Notifications Sent");

    			CmdTable.SetCell("Value", CString(m_notificationsSent));
			CmdTable.SetCell("Value", CString(m_notificationsSent));


    			PutModule(CmdTable);
			PutModule(CmdTable);

    		}
		}

    		else
		else

    		{
		{

    			PutModule("Unknown command! Try HELP.");
			PutModule("Unknown command! Try HELP.");

    		}
		}

    	}
	}


    	EModRet OnPrivMsg(CNick& Nick, CString& sMessage)
	EModRet OnPrivMsg(CNick& Nick, CString& sMessage)

    	{
	{

    		ParsePrivMsg(Nick.GetNick(), sMessage);
		ParsePrivMsg(Nick.GetNick(), sMessage);

    		return CONTINUE;
		return CONTINUE;

    	}
	}

    	EModRet OnPrivAction(CNick& Nick, CString& sMessage)
	EModRet OnPrivAction(CNick& Nick, CString& sMessage)

    	{
	{

    		ParsePrivMsg(Nick.GetNick(), sMessage);
		ParsePrivMsg(Nick.GetNick(), sMessage);

    		return CONTINUE;
		return CONTINUE;

    	}
	}


    	EModRet OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage)
	EModRet OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage)

    	{
	{

    		ParseChanMsg(Nick.GetNick(), Channel.GetName(), sMessage);
		ParseChanMsg(Nick.GetNick(), Channel.GetName(), sMessage);

    		return CONTINUE;
		return CONTINUE;

    	}
	}

    	EModRet OnChanAction(CNick& Nick, CChan& Channel, CString& sMessage)
	EModRet OnChanAction(CNick& Nick, CChan& Channel, CString& sMessage)

    	{
	{

    		ParseChanMsg(Nick.GetNick(), Channel.GetName(), sMessage);
		ParseChanMsg(Nick.GetNick(), Channel.GetName(), sMessage);

    		return CONTINUE;
		return CONTINUE;

    	}
	}


    	EModRet OnUserAction(CString& sTarget, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }
	EModRet OnUserAction(CString& sTarget, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }

    	EModRet OnUserMsg(CString& sTarget, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }
	EModRet OnUserMsg(CString& sTarget, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }

    	EModRet OnUserNotice(CString& sTarget, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }
	EModRet OnUserNotice(CString& sTarget, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }

    	EModRet OnUserJoin(CString& sChannel, CString& sKey) { m_lastActivity = time(NULL); return CONTINUE; }
	EModRet OnUserJoin(CString& sChannel, CString& sKey) { m_lastActivity = time(NULL); return CONTINUE; }

    	EModRet OnUserPart(CString& sChannel, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }
	EModRet OnUserPart(CString& sChannel, CString& sMessage) { m_lastActivity = time(NULL); return CONTINUE; }

    };
};


    MODULEDEFS(CProwlMod, "Forwards hilights and PMs to prowl.")
MODULEDEFS(CProwlMod, "Forwards hilights and PMs to prowl.")