mirror of
https://github.com/moparisthebest/SickRage
synced 2024-11-15 13:55:05 -05:00
0e34c8c4b3
General cleanups in notifiers. * Cleaned up notifier ui page wording so they follow similar pattern. * Better exception handling for pyTivo and NMJ * Cleaned up logging entries, trying to standardize on what level we report and verbiage (not using contractions, prune out duplicate/excessive entries)
150 lines
6.0 KiB
Python
150 lines
6.0 KiB
Python
# Author: Marvin Pinto <me@marvinp.ca>
|
|
# Author: Dennis Lutter <lad1337@gmail.com>
|
|
# URL: http://code.google.com/p/sickbeard/
|
|
#
|
|
# This file is part of SickRage.
|
|
#
|
|
# SickRage is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# SickRage 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 SickRage. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import urllib, urllib2
|
|
import time
|
|
|
|
import sickbeard
|
|
|
|
from sickbeard import logger
|
|
from sickbeard.common import notifyStrings, NOTIFY_SNATCH, NOTIFY_DOWNLOAD, NOTIFY_SUBTITLE_DOWNLOAD
|
|
from sickbeard.exceptions import ex
|
|
|
|
API_URL = "https://boxcar.io/devices/providers/fWc4sgSmpcN6JujtBmR6/notifications"
|
|
|
|
|
|
class BoxcarNotifier:
|
|
def test_notify(self, boxcar_username):
|
|
return self._notify("This is a test notification from Sick Beard", "Test", boxcar_username, force=True)
|
|
|
|
def _sendBoxcar(self, msg, title, email, subscribe=False):
|
|
"""
|
|
Sends a boxcar notification to the address provided
|
|
|
|
msg: The message to send (unicode)
|
|
title: The title of the message
|
|
email: The email address to send the message to (or to subscribe with)
|
|
subscribe: If true then instead of sending a message this function will send a subscription notification (optional, default is False)
|
|
|
|
returns: True if the message succeeded, False otherwise
|
|
"""
|
|
|
|
# build up the URL and parameters
|
|
msg = msg.strip()
|
|
curUrl = API_URL
|
|
|
|
# if this is a subscription notification then act accordingly
|
|
if subscribe:
|
|
data = urllib.urlencode({'email': email})
|
|
curUrl = curUrl + "/subscribe"
|
|
|
|
# for normal requests we need all these parameters
|
|
else:
|
|
data = urllib.urlencode({
|
|
'email': email,
|
|
'notification[from_screen_name]': title,
|
|
'notification[message]': msg.encode('utf-8'),
|
|
'notification[from_remote_service_id]': int(time.time())
|
|
})
|
|
|
|
|
|
# send the request to boxcar
|
|
try:
|
|
req = urllib2.Request(curUrl)
|
|
handle = urllib2.urlopen(req, data)
|
|
handle.close()
|
|
|
|
except urllib2.HTTPError, e:
|
|
# if we get an error back that doesn't have an error code then who knows what's really happening
|
|
if not hasattr(e, 'code'):
|
|
logger.log("Boxcar notification failed. Error code: " + ex(e), logger.ERROR)
|
|
return False
|
|
else:
|
|
logger.log("Boxcar notification failed. Error code: " + str(e.code), logger.WARNING)
|
|
|
|
# HTTP status 404 if the provided email address isn't a Boxcar user.
|
|
if e.code == 404:
|
|
logger.log("Username is wrong/not a boxcar email. Boxcar will send an email to it", logger.WARNING)
|
|
return False
|
|
|
|
# For HTTP status code 401's, it is because you are passing in either an invalid token, or the user has not added your service.
|
|
elif e.code == 401:
|
|
|
|
# If the user has already added your service, we'll return an HTTP status code of 401.
|
|
if subscribe:
|
|
logger.log("Already subscribed to service", logger.ERROR)
|
|
# i dont know if this is true or false ... its neither but i also dont know how we got here in the first place
|
|
return False
|
|
|
|
#HTTP status 401 if the user doesn't have the service added
|
|
else:
|
|
subscribeNote = self._sendBoxcar(msg, title, email, True)
|
|
if subscribeNote:
|
|
logger.log("Subscription send", logger.DEBUG)
|
|
return True
|
|
else:
|
|
logger.log("Subscription could not be send", logger.ERROR)
|
|
return False
|
|
|
|
# If you receive an HTTP status code of 400, it is because you failed to send the proper parameters
|
|
elif e.code == 400:
|
|
logger.log("Wrong data sent to boxcar", logger.ERROR)
|
|
return False
|
|
|
|
logger.log("Boxcar notification successful.", logger.MESSAGE)
|
|
return True
|
|
|
|
def notify_snatch(self, ep_name, title=notifyStrings[NOTIFY_SNATCH]):
|
|
if sickbeard.BOXCAR_NOTIFY_ONSNATCH:
|
|
self._notifyBoxcar(title, ep_name)
|
|
|
|
|
|
def notify_download(self, ep_name, title=notifyStrings[NOTIFY_DOWNLOAD]):
|
|
if sickbeard.BOXCAR_NOTIFY_ONDOWNLOAD:
|
|
self._notifyBoxcar(title, ep_name)
|
|
|
|
def notify_subtitle_download(self, ep_name, lang, title=notifyStrings[NOTIFY_SUBTITLE_DOWNLOAD]):
|
|
if sickbeard.BOXCAR_NOTIFY_ONSUBTITLEDOWNLOAD:
|
|
self._notifyBoxcar(title, ep_name + ": " + lang)
|
|
|
|
def _notifyBoxcar(self, title, message, username=None, force=False):
|
|
"""
|
|
Sends a boxcar notification based on the provided info or SB config
|
|
|
|
title: The title of the notification to send
|
|
message: The message string to send
|
|
username: The username to send the notification to (optional, defaults to the username in the config)
|
|
force: If True then the notification will be sent even if Boxcar is disabled in the config
|
|
"""
|
|
|
|
if not sickbeard.USE_BOXCAR and not force:
|
|
logger.log("Notification for Boxcar not enabled, skipping this notification", logger.DEBUG)
|
|
return False
|
|
|
|
# if no username was given then use the one from the config
|
|
if not username:
|
|
username = sickbeard.BOXCAR_USERNAME
|
|
|
|
logger.log("Sending notification for " + message, logger.DEBUG)
|
|
|
|
return self._sendBoxcar(message, title, username)
|
|
|
|
|
|
notifier = BoxcarNotifier
|