Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

raise ZabbixAPIException instead of 'e' and pep8 compliant #25

Merged
merged 3 commits into from
Feb 8, 2017
Merged

raise ZabbixAPIException instead of 'e' and pep8 compliant #25

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef1ee59
raise ZabbixAPIException instead of 'e'
mprenditore Feb 1, 2017
b51b8c6
pep8 compliant
mprenditore Feb 1, 2017
7a6f0c6
better exception handling
mprenditore Feb 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 33 additions & 31 deletions zabbix/zabbix_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# This is a port of the ruby zabbix api found here:
# http://trac.red-tux.net/browser/ruby/api/zbx_api.rb
#
#LGPL 2.1 http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
#Zabbix API Python Library.
#Original Ruby Library is Copyright (C) 2009 Andrew Nelson nelsonab(at)red-tux(dot)net
#Python Library is Copyright (C) 2009 Brett Lentz brett.lentz(at)gmail(dot)com
# LGPL 2.1 http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
# Zabbix API Python Library.
# Original Ruby Library is Copyright (C) 2009 Andrew Nelson nelsonab(at)red-tux(dot)net
# Python Library is Copyright (C) 2009 Brett Lentz brett.lentz(at)gmail(dot)com
#
#This library is free software; you can redistribute it and/or
#modify it under the terms of the GNU Lesser General Public
#License as published by the Free Software Foundation; either
#version 2.1 of the License, or (at your option) any later version.
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
#This library 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
#Lesser General Public License for more details.
# This library 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
# Lesser General Public License for more details.
#
#You should have received a copy of the GNU Lesser General Public
#License along with this library; if not, write to the Free Software
#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA


# NOTES:
Expand Down Expand Up @@ -64,6 +64,7 @@

def checkauth(fn):
""" Decorator to check authentication of the decorated method """

def ret(self, *args):
self.__checkauth__()
return fn(self, args)
Expand All @@ -72,14 +73,15 @@ def ret(self, *args):

def dojson(fn):
def wrapper(self, method, opts):
self.logger.log(logging.DEBUG, \
"Going to do_request for %s with opts %s" \
self.logger.log(logging.DEBUG,
"Going to do_request for %s with opts %s"
% (repr(fn), repr(opts)))
return self.do_request(self.json_obj(method, opts))['result']
return wrapper


class ZabbixAPIException(Exception):

""" generic zabbix api exception
code list:
-32602 - Invalid params (eg already exists)
Expand All @@ -93,6 +95,7 @@ class Already_Exists(ZabbixAPIException):


class InvalidProtoError(ZabbixAPIException):

""" Recived an invalid proto """
pass

Expand Down Expand Up @@ -137,7 +140,7 @@ def __init__(self, server='http://localhost/zabbix', user=httpuser, passwd=httpp
self.server = server
self.url = server + '/api_jsonrpc.php'
self.proto = self.server.split("://")[0]
#self.proto=proto
# self.proto=proto
self.httpuser = user
self.httppasswd = passwd
self.timeout = timeout
Expand Down Expand Up @@ -174,9 +177,9 @@ def json_obj(self, method, params={}, auth=True):
'method': method,
'params': params,
'auth': self.auth,
'id': self.id
}
if not auth: del obj['auth']
'id': self.id}
if not auth:
del obj['auth']

self.debug(logging.DEBUG, "json_obj: " + str(obj))

Expand All @@ -198,7 +201,7 @@ def login(self, user='', password='', save=True):

# don't print the raw password.
hashed_pw_string = "md5(" + hashlib.md5(l_password.encode('utf-8')).hexdigest() + ")"
self.debug(logging.DEBUG, "Trying to login with %s:%s" % \
self.debug(logging.DEBUG, "Trying to login with %s:%s" %
(repr(l_user), repr(hashed_pw_string)))
obj = self.json_obj('user.login', {'user': l_user, 'password': l_password}, auth=False)
result = self.do_request(obj)
Expand Down Expand Up @@ -231,7 +234,7 @@ def do_request(self, json_obj):
request = urllib2.Request(url=self.url, data=json_obj.encode('utf-8'), headers=headers)
if self.proto == "https":
if HAS_SSLCONTEXT and not self.validate_certs:
https_handler = urllib2.HTTPSHandler(debuglevel=0,context=_create_unverified_context())
https_handler = urllib2.HTTPSHandler(debuglevel=0, context=_create_unverified_context())
else:
https_handler = urllib2.HTTPSHandler(debuglevel=0)
opener = urllib2.build_opener(https_handler)
Expand All @@ -245,17 +248,15 @@ def do_request(self, json_obj):
try:
response = opener.open(request, timeout=self.timeout)
except ssl.SSLError as e:
if e.message == "The read operation timed out":
raise APITimeout("SSL read timeout",)
else:
raise e
if hasattr(e, 'message'):
e = e.message
raise ZabbixAPIException("ssl.SSLError - %s" % e)
except socket.timeout as e:
raise APITimeout("HTTP read timeout",)
except urllib2.URLError as e:
if "Connection timed out" in e.message:
raise APITimeout("HTTP read timeout",)
else:
raise e
if hasattr(e, 'message'):
e = e.message
raise ZabbixAPIException("urllib2.URLError - %s" % e)
self.debug(logging.INFO, "Response Code: " + str(response.code))

# NOTE: Getting a 412 response code means the headers are not in the
Expand Down Expand Up @@ -303,6 +304,7 @@ def __getattr__(self, name):


class ZabbixAPISubClass(ZabbixAPI):

""" wrapper class to ensure all calls go through the parent object """
parent = None
data = None
Expand Down