pfSense

<?php

/****h* pfSense/notices

		notices.inc - pfSense notice utilities

	DESCRIPTION

		This include contains the pfSense notice facilities.

	HISTORY

		$Id$

	Copyright (C) 2009 Scott Ullrich (sullrich@gmail.com)

	Copyright (C) 2005 Colin Smith (ethethlay@gmail.com)

	All rights reserved.

	Redistribution and use in source and binary forms, with or without

	modification, are permitted provided that the following conditions are met:

	1. Redistributions of source code must retain the above copyright notice,

	   this list of conditions and the following disclaimer.

	2. Redistributions in binary form must reproduce the above copyright

	   notice, this list of conditions and the following disclaimer in the

	   documentation and/or other materials provided with the distribution.

	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,

	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY

	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,

	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

	RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

	POSSIBILITY OF SUCH DAMAGE.

	pfSense_BUILDER_BINARIES:	/bin/echo

	pfSense_MODULE:	notifications

*/

$notice_path = $g['tmp_path'] . '/notices';

	'PLAIN' => 'PLAIN',

	'LOGIN' => 'LOGIN');

/* Other SMTP Authentication Mechanisms that could be supported.

 * Note that MD5 is no longer considered secure.

 *	'GSSAPI' => 'GSSAPI ' . gettext("Generic Security Services Application Program Interface")

 *	'DIGEST-MD5' => 'DIGEST-MD5 ' . gettext("Digest access authentication")

 *	'MD5' => 'MD5'

 *	'CRAM-MD5' => 'CRAM-MD5'

*/

 * NAME

 *   file_notice

 * INPUTS

 *	 $id, $notice, $category, $url, $priority

 * RESULT

 *   Files a notice and kicks off the various alerts, smtp, growl, system log, LED's, etc.

 ******/

	 * $category - Category that this notice should be displayed under. This can be arbitrary,

	 * 	       but a page must be set to receive this messages for it to be displayed.

	 *

	 * $priority - A notice's priority. Higher numbers indicate greater severity.

	 *	       0 = informational, 1 = warning, 2 = error, etc. This may also be arbitrary,

	 */

		$queue = array();

	}

	$toqueue = array(

				'id'		=> $id,

				'notice'	=> $notice,

				'url'		=> $url,

				'category'	=> $category,

				'priority'	=> $priority,

			);

		$queuekey++;

	}

	$queueout = fopen($notice_path, "w");

	}

	fclose($queueout);

 * NAME

 *   get_notices

 * INPUTS

 *	 $category

 * RESULT

 *   Returns a specific notices text

 ******/

			return false;

		}

		if ($category != 'all') {

			foreach ($queue as $time => $notice) {

				if (strtolower($notice['category']) == strtolower($category)) {

			return $toreturn;

		} else {

			return $queue;

		}

	} else {

		return false;

	}

}

 * NAME

 *   close_notice

 * INPUTS

 *	 $id

 * RESULT

 *   Removes a notice from the list

 ******/

	global $notice_path;

	require_once("util.inc");

	led_normalize();

		return;

	}

	if ($id == "all") {

		return;

	}

		if ($id == $time) {

			break;

		}

	}

	}

		if ($id == $tocheck) {

			break;

		}

	}

		fclose($queueout);

		unlink_if_exists($notice_path);

	}

 * NAME

 *   dump_xml_notices

 * INPUTS

 *	 NONE

 * RESULT

 *   Outputs notices in XML formatted text

 ******/

	$listtags[] = 'notice';

		return;

	}

	foreach ($notices as $time => $notice) {

		$toput['notice'][] = $notice;

	}

	$xml = dump_xml_config($toput, 'notices');

	return $xml;

}

 * NAME

 *   print_notices

 * INPUTS

 *	 $notices, $category

 * RESULT

 *   prints notices to the GUI

 ******/

		if ($category != "all") {

			if (in_array($notice['category'], $category)) {

				$categories[] = $notice['category'];

			}

			$categories[] = $notice['category'];

		}

	}

	$categories = array_unique($categories);

	sort($categories);

			if (strtolower($notice['category']) == strtolower($category)) {

				if ($notice['id'] != "") {

					if ($notice['url'] != "") {

					} else {

						$toreturn .= "<li>{$notice['id']} - {$notice['notice']}</li>";

					}

				}

			}

		}

		$toreturn .= "</ul></li></ul>";

	}

	return $toreturn;

}

 * NAME

 *   print_notice_box

 * INPUTS

 *	 $category

 * RESULT

 *   prints an info box to the GUI

 ******/

	$notices = get_notices();

		return;

	}

	return;

}

 * NAME

 *   are_notices_pending

 * INPUTS

 *	 $category to check

 * RESULT

 *   returns true if notices are pending, false if they are not

 ******/

	global $notice_path;

	}

	return false;

 *   notify_via_smtp

 * INPUTS

 *	 notification string to send as an email

 * RESULT

 *   returns true if message was sent

 ******/

	$fd = fopen("/var/db/notices_lastmsg.txt", "w");

	fwrite($fd, $message);

	fclose($fd);

}

	$from = "pfsense@{$config['system']['hostname']}.{$config['system']['domain']}";

	$to = $config['notifications']['smtp']['notifyemailaddress'];

	$smtp->host_name = $config['notifications']['smtp']['ipaddress'];

	$smtp->tls = (isset($config['notifications']['smtp']['tls'])) ? 1 : 0;

	if ($config['notifications']['smtp']['fromaddress']) {

	    $config['notifications']['smtp']['password']) {

			$smtp->authentication_mechanism = $config['notifications']['smtp']['authentication_mechanism'];

		} else {

			$smtp->authentication_mechanism = "PLAIN";

		}

	}

	$headers = array(

		"From: {$from}",

		"To: {$to}",

	} else {

		return(sprintf(gettext('Could not send the message to %1$s -- Error: %2$s'), $to, $smtp->error));

 *   notify_via_growl

 * INPUTS

 *	 notification string to send

 * RESULT

 *   returns true if message was sent

 ******/

	$growl_password = $config['notifications']['growl']['password'];

	$growl_notification = $config['notifications']['growl']['notification_name'];

	/* Store last message sent to avoid spamming */

	$fd = fopen("/var/db/growlnotices_lastmsg.txt", "w");

	fwrite($fd, $message);

	fclose($fd);

 *   register_via_growl

 * INPUTS

 *	 none

 * RESULT

 *   none

 ******/

function register_via_growl() {

	require_once("growl.class");

	global $config;

	$growl_ip = $config['notifications']['growl']['ipaddress'];

	$growl_password = $config['notifications']['growl']['password'];

	$growl_notification = $config['notifications']['growl']['notification_name'];

	if ($growl_ip) {

		$growl = new Growl($growl_ip, $growl_password, $growl_name);

	}

}

function notify_all_remote($msg) {

	notify_via_smtp($msg);

	notify_via_growl($msg);

}