znc-push/README.md

ZNC to Notifo

ZNC to Notifo is a module for ZNC that will send notifications to a Notifo account for any private message or channel highlight that matches a configurable set of conditions.

This project is still a Work In Progress, but should be functional enough and stable enough for everyday usage. Users are more than welcome to submit feature requests or patches for discussion or inclusion. Bug reports and feature requests can be submitted to my bug tracker or sent via email.

For full functionality, this module requires ZNC version 0.090 or newer, but should compile and run with a reduced feature set on versions as old as 0.078, the current version used by Ubuntu. However, development and testing is done exclusively against the latest source distribution, so feedback on older releases of ZNC is needed to continue supporting them.

ZNC to Notifo was created by John Reese and designed to fill a personal need. It may not fit your use cases, but any and all feedback would be greatly appreciated.

Compiling

If you have installed ZNC from a Linux distribution's repository, you will most likely need to install the development package before building this module. On Ubuntu, this can be installed with:

$ sudo aptitude install znc-dev

If you have make installed, you can compile the module with:

$ make

Otherwise, run the full command:

$ znc-build notifo.cpp

Installation

Copy the compiled module into your ZNC profile:

$ cp notifo.so ~/.znc/modules/

Now, load the module in ZNC:

/msg *status loadmod notifo

Then set your Notifo username and API secret:

/msg *notifo set username foo
/msg *notifo set secret ...

At this point, it should start sending notifications every time you get a private message or someone says your name in a channel. If this is everything you wanted, congratulations, you're done!

Commands

• help

  Links you to this fine document.

• set <option> <value>

  Allows you to modify configuration values.

• append <option> <value>

  Allows you to add a string to end of a configuration value. Automatically adds a space to separate the appended value from the existing value.

• prepend <option> <value>

  Allows you to add a string to beginning of a configuration value. Automatically adds a space to separate the prepended value from the existing value.

• get [<option>]

  Allows you to see current configuration values.

• unset <option>

  Allows you to reset a configuration option back to the default value.

• status [<context>]

  Check the status of current conditions. Specifying the "context" of either a channel or nick name will provide status values specific to that context.

• send <message>

  Manually trigger a notification with the given message. Useful for testing to validate credentials, etc.

Configuration

Conditions

• away_only = "no"

  If set to "yes", notifications will only be sent if the user has set their /away status.

  This condition requires version 0.090 of ZNC to operate, and will be disabled when compiled against older versions.

• client_count_less_than = 0

  Notifications will only be sent if the number of connected IRC clients is less than this value. A value of 0 (zero) will disable this condition.

• highlight = ""

  Space-separated list of highlight strings to match against channel messages using case-insensitive, wildcard matching. Strings will be compared in order they appear in the configuration value, and the first string to match will end the search, meaning that earlier strings take priority over later values.

  Individual strings may be prefixed with:

  • - (hypen) to negate the match, which makes the string act as a filter rather than a search

  • _ (underscore) to trigger a "whole-word" match, where it must be surrounded by whitespace to match the value

  • * (asterisk) to match highlight strings that start with any of the above prefixes

  As an example, a highlight value of "-pinto car" will trigger notification on the message "I like cars", but will prevent notifications for "My favorite car is the Pinto" and "I like pinto beans". Conversely, a highlight value of "car -pinto" will trigger notifications for the first two messages, and only prevent notification of the last one.

  As another example, a value of "_car" will trigger notification for the message "my car is awesome", but will not match the message "I like cars".

• idle = 0

  Time in seconds since the last activity by the user on any channel or query window, including joins, parts, messages, and actions. Notifications will only be sent if the elapsed time is greater than this value. A value of 0 (zero) will disable this condition.

• last_active = 180

  Time in seconds since the last message sent by the user on that channel or query window. Notifications will only be sent if the elapsed time is greater than this value. A value of 0 (zero) will disable this condition.

  Note that this condition keeps track of the last message sent to each channel and query window separately, so a recent PM to Joe will not affect a notification sent from channel #foo.

• last_notification = 300

  Time in seconds since the last notification sent from that channel or query window. Notifications will only be sent if the elapsed time is greater than this value. A value of 0 (zero) will disable this condition.

  Note that this condition keeps track of the last notification sent from each channel and query window separately, so a recent PM from Joe will not affect a notification sent from channel #foo.

• nick_blacklist = ""

  Space-separated list of nicks. Applies to both channel mentions and query windows. Notifications will only be sent for messages from nicks that are not present in this list, using a case-insensitive comparison.

  Note that wildcard patterns can be used to match multiple nicks with a single blacklist entry. For example, set nick_blacklist *bot will not send notifications from nicks like "channelbot", "FooBot", or "Robot". Care must be used to not accidentally blacklist legitimate nicks with wildcards.

Notifications

• message_length = 100

  Maximum length of the notification message to be sent. The message will be nicely truncated and ellipsized at or before this length is reached. A value of 0 (zero) will disable this option.

• message_url = ""

  URI that will be sent with the notification to Notifo. This could be a web address or a local scheme to access a mobile application.

Roadmap

Conditions

• User inactivity: How long, in seconds, since the last action made by user, in any channel or query window.

Settings

• Customizable notification titles and message formats.

License

This project is licensed under the MIT license. See the LICENSE file for details.