notify: Call external notifier program on event.

ChangeLog

+xxxx-xx-xx : Version -next
+ * notify: Added option to execute external script on event.
+
 2011-11-14 : Version 3.2
  * Fixed bug that prevented tsdecrypt from working at all :(
 

Makefile

 TS_DIR = libtsfuncs
 TS_LIB = $(TS_DIR)/libtsfuncs.a
 
-tsdecrypt_SRC  = data.c udp.c util.c camd.c process.c tables.c tsdecrypt.c
+tsdecrypt_SRC  = data.c udp.c util.c camd.c process.c tables.c notify.c tsdecrypt.c
 tsdecrypt_LIBS = -lcrypto -ldvbcsa -lpthread
 tsdecrypt_OBJS = $(tsdecrypt_SRC:.c=.o) $(FUNCS_LIB) $(TS_LIB)
 

data.h

 // How much seconds to assume the key is valid
 #define KEY_VALID_TIME 10
 
+struct notify {
+	pthread_t	thread;				/* Thread handle */
+	QUEUE		*notifications;		/* Notification queue */
+	char		ident[512];			/* tsdecrypt ident (set by -i) */
+	char		program[512];		/* What program to exec */
+};
+
 struct key {
 	uint8_t				cw[16];
 	int					is_valid_cw;
 	int					write_stop;
 	pthread_t			write_thread;
 	CBUF				*write_buf;
+
+	struct notify		*notify;
+	char				notify_program[512];
 };
 
 enum msg_type { EMM_MSG, ECM_MSG };

notify-script.example

+#!/bin/sh
+# Example tsdecrypt notify script
+# Written by Georgi Chorbadzhiyski
+#
+# *** Released as PUBLIC DOMAIN ***
+# *** Do whatever you want with this code ***
+
+EMAIL_ENABLED="yes"
+EMAIL_TO="georgi@unixsol.org" # !!! Change this !!!
+EMAIL_FROM="georgi@unixsol.org" # !!! Change this !!!
+EMAIL_SUBJECT_PREFIX="[tsdecrypt]"
+EMAIL_PROGRAM="/usr/sbin/sendmail -t -i"
+
+LOG_ENABLED="yes"
+LOG_DIR="."
+LOG_FILE="$LOGDIR/notify.${_IDENT}.notify.log"
+
+# Environmental vars that are set by the calling process (tsdecrypt):
+#   _TS             Unix timestamp of the event.
+#   _IDENT          tsdecrypt ident (--ident parameter).
+#   _MESSAGE_ID     Event message id (For example START, STOP, etc...).
+#   _MESSAGE_TEXT   Event message text. Human readable event message.
+#   _MESSAGE_MSG    Event message id lower cased and "_" is replaced with " "
+
+export PATH="/bin:/usr/bin:/usr/local/bin"
+export LC_ALL=C
+
+if [ -z "${_IDENT}" -o -z "${_TS}" ]
+then
+	echo "This script must be run from tsdecrypt."
+	echo "In order for tsdecrypt to run this script use --ident and --notify-prg options."
+	echo
+	echo "Example:"
+	echo "   tsdecrypt --ident SOURCE/CHANNEL --notify-program ./notify-script.example --camd-server x.x.x.x"
+	echo
+	exit 1
+fi
+
+if [ "$LOG_ENABLED" = "yes" ]
+then
+	LOG_DATE="$(date +%F\ %T\ %z -d @${_TS})"
+	printf "%s | %s | %-16s | %s\n" \
+		"$LOG_DATE" \
+		"${_IDENT}" \
+		"${_MESSAGE_ID}" \
+		"${_MESSAGE_TEXT}" \
+		  >> $LOG_DIR/$LOG_FILE
+fi
+
+if [ "$EMAIL_ENABLED" = "yes" ]
+then
+	(
+		echo "To: <$EMAIL_TO>"
+		echo "From: <$EMAIL_FROM>"
+		echo "Return-Path: <$EMAIL_FROM>"
+		echo "Subject: $EMAIL_SUBJECT_PREFIX ${_IDENT} ${_MESSAGE_MSG}"
+		echo "X-IDENT: ${_IDENT}"
+		echo "X-MSG-ID: ${_MESSAGE_ID}"
+		echo "X-Mailer: tsdecrypt"
+		echo
+		echo "${_IDENT} ${_MESSAGE_TEXT}"
+	) | $EMAIL_PROGRAM
+fi

notify.c

+/*
+ * Exec external program to notify for an event
+ * Copyright (C) 2011 Unix Solutions Ltd.
+ *
+ * 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 by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ */
+
+// Needed for asprintf
+#define _GNU_SOURCE 1
+
+#include <stdlib.h>
+#include <stdarg.h>
+#include <unistd.h>
+#include <string.h>
+#include <errno.h>
+#include <ctype.h>
+#include <pthread.h>
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <sys/mman.h>
+
+#include "libfuncs/queue.h"
+
+#include "notify.h"
+
+struct npriv {
+	char	ident[512];
+	char	program[512];
+	char	msg_id[512];
+	char	text[512];
+};
+
+static void *do_notify(void *in) {
+	struct npriv *data = in;
+	struct npriv *shared = mmap(NULL, sizeof(struct npriv), PROT_READ | PROT_WRITE, MAP_SHARED | MAP_ANON, -1, 0);
+	if (!shared) {
+		perror("mmap");
+		goto OUT;
+	}
+	*shared = *data;
+	pid_t pid = fork();
+	if (pid==0) { // child process
+		char *args[] = { shared->program, shared->ident, NULL };
+		int e = 0;
+		unsigned int i, r;
+		char **env = calloc(32, sizeof(char *));
+		asprintf(&env[e++], "_TS=%ld"			, time(NULL));
+		asprintf(&env[e++], "_IDENT=%s"			, shared->ident);
+		asprintf(&env[e++], "_MESSAGE_ID=%s"	, shared->msg_id);
+		asprintf(&env[e++], "_MESSAGE_TEXT=%s"	, shared->text);
+		r = strlen(shared->msg_id);
+		for (i=0; i<r; i++) {
+			if (isalpha(shared->msg_id[i]))
+				shared->msg_id[i] = tolower(shared->msg_id[i]);
+			if (shared->msg_id[i] == '_')
+				shared->msg_id[i] = ' ';
+		}
+		asprintf(&env[e++], "_MESSAGE_MSG=%s"	, shared->msg_id);
+		execve(args[0], args, env);
+		// We reach here only if there is an error.
+		fprintf(stderr, "execve('%s') failed: %s!\n", args[0], strerror(errno));
+		do {
+			free(env[e--]);
+		} while (e);
+		free(env);
+		exit(127);
+	} else {
+		waitpid(pid, NULL, 0);
+	}
+
+	munmap(shared, sizeof(struct npriv));
+OUT:
+	free(data);
+	pthread_exit(0);
+}
+
+static void *notify_thread(void *data) {
+	struct notify *n = data;
+
+	while (1) {
+		struct npriv *np = queue_get(n->notifications); // Waits...
+		if (!np)
+			break;
+		pthread_t notifier; // The notifier frees the data
+		pthread_attr_t attr;
+		pthread_attr_init(&attr);
+		pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
+		if (pthread_create(&notifier, &attr, &do_notify, np) != 0) {
+			perror("pthread_create");
+			free(np);
+		}
+		pthread_attr_destroy(&attr);
+	}
+	pthread_exit(0);
+}
+
+/* ======================================================================== */
+
+struct notify *notify_alloc(struct ts *ts) {
+	unsigned int i;
+	if (!ts->ident[0] || !ts->notify_program[0])
+		return NULL;
+	struct notify *n = calloc(1, sizeof(struct notify));
+	n->notifications = queue_new("notifications");
+	strncpy(n->ident, ts->ident, sizeof(n->ident) - 1);
+	for (i=0; i<strlen(n->ident); i++) {
+		if (n->ident[i] == '/')
+			n->ident[i] = '-';
+	}
+	strncpy(n->program, ts->notify_program, sizeof(n->program) - 1);
+	pthread_create(&n->thread, NULL , &notify_thread, n);
+	return n;
+}
+
+static void npriv_init_defaults(struct notify *n, struct npriv *np) {
+	strncpy(np->program, n->program, sizeof(np->program) - 1);
+	strncpy(np->ident, n->ident, sizeof(np->ident) - 1);
+}
+
+void notify(struct ts *ts, char *msg_id, char *text_fmt, ...) {
+	va_list args;
+	struct npriv *np = calloc(1, sizeof(struct npriv));
+	if (!ts->notify)
+		return;
+	npriv_init_defaults(ts->notify, np);
+	strncpy(np->msg_id, msg_id, sizeof(np->ident) - 1);
+	np->msg_id[sizeof(np->ident) - 1] = 0;
+	va_start(args, text_fmt);
+	vsnprintf(np->text, sizeof(np->text) - 1, text_fmt, args);
+	np->text[sizeof(np->text) - 1] = 0;
+	va_end(args);
+	queue_add(ts->notify->notifications, np);
+}
+
+void notify_free(struct notify **pn) {
+	struct notify *n = *pn;
+	if (n) {
+		queue_add(n->notifications, NULL);
+		pthread_join(n->thread, NULL);
+		queue_free(&n->notifications);
+		FREE(*pn);
+	}
+}

notify.h

+/*
+ * Exec external program to notify for an event
+ * Copyright (C) 2011 Unix Solutions Ltd.
+ *
+ * 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 by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ */
+#ifndef NOTIFY_H
+# define NOTIFY_H
+
+#include "libfuncs/queue.h"
+#include "data.h"
+
+struct notify *notify_alloc(struct ts *ts);
+
+__attribute__ ((format(printf, 3, 4)))
+void notify(struct ts *ts, char *msg_id, char *text_fmt, ...);
+
+void notify_free(struct notify **pn);
+
+#endif

tsdecrypt.1

 \fB\-d\fR, \fB\-\-daemon\fR <pidfile>
 When started become a daemon and write pid file to <pidfile>.
 .TP
+\fB\-N\fR, \fB\-\-notify\-program\fR <program>
+Execute \fB<program>\fR when predefined events happen. In order for
+this option to work \fB\-\-ident\fR should also be used.
+
+You can use \fBnotify-script.example\fR file as notification program
+and an example on how to create your own notification script.
+.TP
 \fB\-l\fR, \fB\-\-syslog\-host\fR <addr>
 Set syslog host. tsdecrypt sends messages to this host over tcp in
 syslog compatible format. syslog-ng was tested as receiving syslog server.

tsdecrypt.c

 #include "camd.h"
 #include "process.h"
 #include "udp.h"
+#include "notify.h"
 
 #define FIRST_REPORT_SEC 3
 
 	{ "daemon",				required_argument, NULL, 'd' },
 	{ "syslog-host",		required_argument, NULL, 'l' },
 	{ "syslog-port",		required_argument, NULL, 'L' },
+	{ "notify-program",		required_argument, NULL, 'N' },
 
 	{ "input",				required_argument, NULL, 'I' },
 	{ "input-rtp",			no_argument,       NULL, 'R' },
 	printf("Daemon options:\n");
 	printf(" -i --ident <server>        | Format PROVIDER/CHANNEL. Default: empty\n");
 	printf(" -d --daemon <pidfile>      | Daemonize program and write pid file.\n");
+	printf(" -N --notify-program <prg>  | Execute <prg> to report events. Default: empty\n");
+	printf("\n");
 	printf(" -l --syslog-host <host>    | Syslog server address. Default: disabled\n");
 	printf(" -L --syslog-port <port>    | Syslog server port. Default: %d\n", ts->syslog_port);
 	printf("\n");
 
 static void parse_options(struct ts *ts, int argc, char **argv) {
 	int j, i, ca_err = 0, server_err = 1, input_addr_err = 0, output_addr_err = 0, output_intf_err = 0, ident_err = 0;
-	while ( (j = getopt_long(argc, argv, "i:d:l:L:I:RzO:o:t:pc:C:s:U:P:y:eZ:Ef:X:H:G:KJ:D:hV", long_options, NULL)) != -1 ) {
+	while ( (j = getopt_long(argc, argv, "i:d:N:l:L:I:RzO:o:t:pc:C:s:U:P:y:eZ:Ef:X:H:G:KJ:D:hV", long_options, NULL)) != -1 ) {
 		char *p = NULL;
 		switch (j) {
 			case 'i':
 				ts->pidfile[sizeof(ts->pidfile) - 1] = 0;
 				ts->daemonize = 1;
 				break;
+			case 'N':
+				strncpy(ts->notify_program, optarg, sizeof(ts->notify_program) - 1);
+				ts->notify_program[sizeof(ts->notify_program) - 1] = 0;
+				break;
+
 			case 'l':
 				strncpy(ts->syslog_host, optarg, sizeof(ts->syslog_host) - 1);
 				ts->syslog_host[sizeof(ts->syslog_host) - 1] = 0;
 			fprintf(stderr, "ERROR: Output interface address is invalid.\n");
 		exit(1);
 	}
-	if (ts->ident[0])
-		ts_LOGf("Ident      : %s\n", ts->ident);
-	else
-		ts_LOGf("Ident      : *NOT SET*\n");
+	ts_LOGf("Ident      : %s\n", ts->ident[0] ? ts->ident : "*NOT SET*");
+	ts_LOGf("Notify prog: %s\n", ts->notify_program[0] ? ts->notify_program : "*NOT SET*");
 	if (ts->pidfile[0])
 		ts_LOGf("Daemonize  : %s pid file.\n", ts->pidfile);
 	else
 		log_init(ts.ident, ts.syslog_active, ts.daemonize != 1, ts.syslog_host, ts.syslog_port);
 	}
 
+	ts.notify = notify_alloc(&ts);
+
 	ts_LOGf("Start %s\n", program_id);
 
 	if (ts.input.type == NET_IO && udp_connect_input(&ts.input) < 1)
 			pthread_join(ts.write_thread, NULL);
 	}
 
-	data_free(&ts);
-
 	ts_LOGf("Stop %s\n", program_id);
 
 	if (ts.syslog_active)
 	if (ts.daemonize)
 		unlink(ts.pidfile);
 
+	notify_free(&ts.notify);
+	data_free(&ts);
+
 	exit(0);
 }