plugin_image.py

#!/usr/bin/python

import sys
import os
import base64

import utils
import logger
import config
log = logger.get_logger(__name__)
conf = config.get_config()

# return an image not available picture
def get_image_unavailable():
	with open(conf["constants"]["image_unavailable"],'r') as file:
		data = base64.b64encode(file.read())
	file.close()
	return data

# poll the sensor
def poll(sensor):
	# retrieve the image from a url
	if "url" in sensor["plugin"]:
		# set the parameters
		username = sensor['plugin']['username'] if 'username' in sensor['plugin'] else None
		password = sensor['plugin']['password'] if 'password' in sensor['plugin'] else None
		# visit the page
		try:
			data = utils.web_get(sensor['plugin']['url'],username,password,binary=True,timeout=conf["plugins"]["image"]["timeout"])
		except Exception,e:
			log.debug("["+sensor["module_id"]+"]["+sensor["group_id"]+"]["+sensor["sensor_id"]+"] unable to visit "+sensor['plugin']['url']+": "+utils.get_exception(e))
			return ""
	# run a command to retrieve the image
	elif "command" in sensor["plugin"]:
		data = utils.run_command(sensor["plugin"]["command"],timeout=conf["plugins"]["image"]["timeout"])
	else: 
		log.error("["+sensor["module_id"]+"]["+sensor["group_id"]+"]["+sensor["sensor_id"]+"] must have a url or a command configured")
		return ""
	# return empty if the data is not binary
	if "<html" in data.lower() or data == "": return ""
	# return the data, if binary return the base64 encoding
	return base64.b64encode(data)

# parse the data
def parse(sensor,data):
	# if expecting an image and no data or an error is returned, return a placeholder
	if data == "": return get_image_unavailable()
	return data

# return the cache schema
def cache_schema(sensor):
	if "url" in sensor["plugin"]: return sensor['plugin']['url']
	elif "command" in sensor["plugin"]: return sensor['plugin']['command']