def removeRadio(self, did, radiodev):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.radio.remove', 'device_id': did, 'radiodev_counter': radiodev}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
print 'Radio %s from device %s succesfully removed' % (radiodev, did)
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def removeNode(self, nid):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.node.remove', 'node_id': nid}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
print 'Node %s succesfully removed' % nid
else:
# [{"code":500,"str":"Request could not be completed. The object was not found","extra":"node_id = 49836"}]}
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def removeZone(self, zid):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.zone.remove', 'zone_id': zid}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
pass
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def removeLink(self, lid):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.link.remove', 'link_id': lid}
params = urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
print('Link {id} succesfully removed'.format(id=lid))
else:
extra = response.get('extra', None)
raise GuifiApiError(response['str'], response['code'], extra)
def removeRadio(self, did, radiodev):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.radio.remove', 'device_id': did, 'radiodev_counter': radiodev}
params = urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
print('Radio {radio} from device {id} successfully removed'.format(radio=radiodev, id=did))
else:
extra = response.get('extra', None)
raise GuifiApiError(response['str'], response['code'], extra)
def removeLink(self, lid):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.link.remove', 'link_id': lid}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
print 'Link %s succesfully removed' % lid
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def updateRadio(self, did, radiodev, angle=None, gain=None,
azimuth=None, amode=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.radio.update', 'device_id': did, 'radiodev_counter': radiodev}
params = urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
print('Radio {id}/{radiodev} successfully updated'.format(id=did, radiodev=radiodev))
else:
extra = response.get('extra', None)
raise GuifiApiError(response['str'], response['code'], extra)
def updateRadio(self, did, radiodev, angle=None, gain=None,
azimuth=None, amode=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.radio.update', 'device_id': did, 'radiodev_counter': radiodev}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
pass
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def addRadio(self, mode, did, mac, angle=None, gain=None, azimuth=None,
amode=None, ssid=None, protocol=None, channel=None, clients='Yes'):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.radio.add', 'mode': mode, 'device_id': did, 'mac': mac}
if angle is not None:
data['antenna_angle'] = angle
if gain is not None:
data['antenna_gain'] = gain
if azimuth is not None:
data['antenna_azimuth'] = azimuth
if amode is not None:
data['antenna_mode'] = amode
if mode == 'ap':
if ssid is None or protocol is None or channel is None or clients is None:
raise ValueError
data['ssid'] = ssid
data['protocol'] = protocol
data['channel'] = channel
data['clients_accepted'] = clients
elif mode == 'ad-hoc':
if ssid is None or protocol is None or channel is None:
raise ValueError
data['ssid'] = ssid
data['protocol'] = protocol
data['channel'] = channel
else:
print mode
raise NotImplementedError
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
# TODO: qué devolver? array tb?
radiodev_counter = int(response.get('radiodev_counter'))
interfaces = response.get('interfaces')
print 'Radio succesfully created', radiodev_counter
print self.urlForDevice(int(did))
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
return (radiodev_counter, interfaces)
def addRadio(self, mode, did, mac, angle=None, gain=None, azimuth=None,
amode=None, ssid=None, protocol=None, channel=None, clients='Yes'):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.radio.add', 'mode': mode, 'device_id': did, 'mac': mac}
if angle:
data['antenna_angle'] = angle
if gain:
data['antenna_gain'] = gain
if azimuth:
data['antenna_azimuth'] = azimuth
if amode:
data['antenna_mode'] = amode
if mode == 'ap':
if None in (ssid, protocol, channel, clients):
raise ValueError("If mode=='ap' you must specify ssid, protocol, channel and clients too")
data['ssid'] = ssid
data['protocol'] = protocol
data['channel'] = channel
data['clients_accepted'] = clients
elif mode == 'ad-hoc':
if None in (ssid, protocol, channel):
raise ValueError("If mode=='ad-hoc' you must specify ssid, protocol, and channel too")
data['ssid'] = ssid
data['protocol'] = protocol
data['channel'] = channel
else:
print(mode)
raise NotImplementedError
params = urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
# TODO: qué devolver? array tb?
radiodev_counter = int(response.get('radiodev_counter'))
interfaces = response.get('interfaces')
print('Radio {counter} successfully created'.format(counter=radiodev_counter))
print(self.urlForDevice(int(did)))
else:
extra = response.get('extra', None)
raise GuifiApiError(response['str'], response['code'], extra)
return (radiodev_counter, interfaces)
def addDevice(self, nid, rtype, mac, nick=None, notification=None,
comment=None, status=None, graph_server=None,
model_id=None, firmware=None, download=None, upload=None, mrtg_index=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.device.add', 'node_id': nid, 'type': rtype, 'mac': mac}
if nick is not None:
data['nick'] = nick
if notification is not None:
data['notification'] = notification
if comment is not None:
data['comment'] = comment
if status is not None:
data['status'] = status
if graph_server is not None:
data['graph_server'] = graph_server
if rtype == 'radio':
if model_id is None or firmware is None:
raise ValueError
data['model_id'] = model_id
data['firmware'] = firmware
elif rtype == 'adsl':
if download is None or upload is None or mrtg_index is None:
raise ValueError
data['download'] = download
data['upload'] = upload
data['mrtg_index'] = mrtg_index
elif rtype == 'generic':
if mrtg_index is None:
raise ValueError
data['mrtg_index'] = mrtg_index
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
device_id = int(response.get('device_id'))
print 'Device succesfully created', device_id
print self.urlForDevice(device_id)
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
return device_id
def addDevice(self, nid, rtype, mac, nick=None, notification=None,
comment=None, status=None, graph_server=None,
model_id=None, firmware=None, download=None, upload=None, mrtg_index=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.device.add', 'node_id': nid, 'type': rtype, 'mac': mac}
if nick:
data['nick'] = nick
if notification:
data['notification'] = notification
if comment:
data['comment'] = comment
if status:
data['status'] = status
if graph_server:
data['graph_server'] = graph_server
if rtype == 'radio':
if None in (model_id, firmware):
raise ValueError("If rtype=='radio' you must specify model_id and firmware too")
data['model_id'] = model_id
data['firmware'] = firmware
elif rtype == 'adsl':
if None in (download, upload, mrtg_index):
raise ValueError("If rtype=='adsl' you must specify download, upload and mrtg_index too")
data['download'] = download
data['upload'] = upload
data['mrtg_index'] = mrtg_index
elif rtype == 'generic':
if mrtg_index is None:
raise ValueError("If rtype=='generic' you must specify mrtg_index too")
data['mrtg_index'] = mrtg_index
params = urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
device_id = int(response.get('device_id'))
print('Device {id} succesfully created'.format(id=device_id))
print(self.urlForDevice(device_id))
else:
extra = response.get('extra', None)
raise GuifiApiError(response['str'], response['code'], extra)
return device_id
def addZone(self, title, master, minx, miny, maxx, maxy, nick=None,
mode='infrastructure', body=None, timezone='+01 2 2',
graph_server=None, proxy_server=None, dns_servers=None,
ntp_servers=None, ospf_zone=None, homepage=None,
notification=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.zone.add', 'title': title, 'master': master,
'minx': minx, 'miny': miny, 'maxx': maxx, 'maxy': maxy}
if nick is not None:
data['nick'] = nick
if mode != 'infrastructure':
data['mode'] = mode
if body is not None:
data['body'] = body
if timezone != '+01 2 2':
data['timezone'] = timezone
if graph_server is not None:
data['graph_server'] = graph_server
if proxy_server is not None:
data['proxy_server'] = proxy_server
if dns_servers is not None:
data['dns_servers'] = dns_servers
if ntp_servers is not None:
data['ntp_servers'] = ntp_servers
if ospf_zone is not None:
data['ospf_zone'] = ospf_zone
if homepage is not None:
data['homepage'] = homepage
if notification is not None:
data['notification'] = notification
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
zone_id = int(response.get('zone_id'))
print 'Zone succesfully created', zone_id
print self.urlForZone(zone_id)
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
return zone_id
def updateNode(self, nid, title=None, nick=None, body=None, zone_id=None,
zone_description=None, notification=None, lat=None,
lon=None, elevation=None, stable=None, graph_server=None,
status=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.node.update', 'node_id': nid}
if title is not None:
data['title'] = title
if nick is not None:
data['nick'] = nick
if body is not None:
data['body'] = body
if zone_id is not None:
data['zone_id'] = zone_id
if zone_description is not None:
data['zone_description'] = zone_description
if notification is not None:
data['notification'] = notification
if lat is not None:
data['lat'] = lat
if lon is not None:
data['lon'] = lon
if elevation is not None:
data['elevation'] = elevation
if stable is not None:
data['stable'] = stable
if status is not None:
data['status_flag'] = status
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
node_id = response['node']['node_id']
print 'Node succesfully updated', node_id
print '%s/node/%s' % (self.base_url, node_id)
else:
# [{"code":500,"str":"Request could not be completed. The object was not found","extra":"zone_id = is not a guifi node"}]}
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
return node_id
def updateZone(self, zid, title=None, nick=None, mode='infrastructure',
body=None, timezone='+01 2 2', graph_server=None,
proxy_server=None, dns_servers=None, ntp_servers=None,
ospf_zone=None, homepage=None, notification=None,
master=None, minx=None, miny=None, maxx=None, maxy=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.zone.update', 'zone_id': zid}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
pass
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def getModels(self, type=None, fid=None, supported=None):
data = {'command': 'guifi.misc.model'}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
return response['models']
else:
raise GuifiApiError(response['str'], response['code'], response['extra'])
def getProtocols(self):
data = {'command': 'guifi.misc.protocol'}
params = urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
return response['protocols']
else:
extra = response.get('extra', None)
raise GuifiApiError(response['str'], response['code'], extra)
def getChannels(self, protocol):
data = {'command': 'guifi.misc.channel', 'protocol': protocol}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
return response['channels']
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def getFirmwares(self, model_id=None):
data = {'command': 'guifi.misc.firmware'}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
return response['firmwares']
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def getManufacturers(self):
data = {'command': 'guifi.misc.manufacturer'}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
return response['manufacturers']
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def updateDevice(self, did, nid=None, nick=None, notification=None,
mac=None, comment=None, status=None, graph_server=None,
model_id=None, firmware=None, download=None, upload=None,
mrtg_index=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.device.update', 'device_id': did}
# TODO: update nid. Is it safe to change it directly in the database?
if nick is not None:
data['nick'] = nick
if notification is not None:
data['notification'] = notification
if mac is not None:
data['mac'] = mac
if comment is not None:
data['comment'] = comment
if status is not None:
data['flag'] = status
if graph_server is not None:
data['graph_server'] = graph_server
if model_id is not None:
data['model_id'] = model_id
if firmware is not None:
data['firmware'] = firmware
if download is not None:
data['download'] = download
if upload is not None:
data['upload'] = upload
if mrtg_index is not None:
data['mrtg_index'] = mrtg_index
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
pass
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def addInterface(self, did, radiodev):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.interface.add', 'device_id': did, 'radiodev_counter': radiodev}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
# "responses":{"ipv4":[{"ipv4_type":"1","ipv4":"10.64.3.33","netmask":"255.255.255.224"}],"interface_id":76140}
if codenum == ANSWER_GOOD:
iid = int(response.get('interface_id'))
ipv4 = response.get('ipv4')
print 'Interface succesfully created', iid
print self.urlForDevice(int(did))
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
return (iid, ipv4)
def updateLink(self, lid, ipv4=None, status=None, routing=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.link.update', 'link_id': lid}
if ipv4:
data['ipv4'] = ipv4
if status:
data['status'] = status
if routing:
data['routing'] = routing
params = urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
print('Link {id} succesfully updated'.format(id=lid))
else:
extra = response.get('extra', None)
raise GuifiApiError(response['str'], response['code'], extra)
def updateLink(self, lid, ipv4=None, status=None, routing=None):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.link.update', 'link_id': lid}
if ipv4 is not None:
data['ipv4'] = ipv4
if status is not None:
data['status'] = status
if routing is not None:
data['routing'] = routing
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
pass
else:
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
def auth(self):
""" Authenticate user and get the Authorization Token """
if self.username is None or self.passwd is None:
raise GuifiApiError('You need to set username and password first')
self.authToken = None
if 'Authorization' in self.headers:
del self.headers['Authorization']
# XXX: There's some kind of bug when you submit the Authorization header to this command
# Then, you get 502 error if command is the last parameters specified
# http://test.guifi.net/api?username=user1&password=pass1&command=guifi.auth.login
# {"command":"","code":{"code":201,"str":"Request could not be completed, errors found"},"errors":[{"code":502,"str":"The given Auth token is invalid"}]}
# Note 1: the command is not specified in the response (!!)
# Note 2: it works well in firefox
# A workaround fix is also using the method parameter which is added to the end in the dict structure
#data = urllib.urlencode({'command':'guifi.auth.login', 'username':self.username, 'password':self.passwd})
data = urllib.urlencode({'command': 'guifi.auth.login', 'username': self.username, 'password': self.passwd, 'method': 'password'})
try:
(codenum, response) = self.sendRequest(data)
print 'auth:', codenum
print response
if codenum == ANSWER_GOOD:
self.authToken = response.get('authToken')
self.headers['Authorization'] = 'GuifiLogin auth=' + self.authToken
else:
# Expect just one error
errorcode = response['code']
if errorcode == CODE_ERROR_INVALID_TOKEN: # Nosense (:?)
#{"errors":[{"code":403,"str":"Request is not valid: some input data is incorrect","extra":"Either the supplied username or password are not correct"}]}
raise GuifiApiError('Error during authentication: ' + str(errorcode) + ': ' + response['str'])
else:
raise GuifiApiError('Unexpected return code: ' + str(errorcode))
except URLError: # Not connected to the Internets
raise
def addNode(self, title, zone_id, lat, lon, nick=None, body=None,
zone_desc=None, notification=None, elevation=None,
stable='Yes', graph_server=None, status='Planned'):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.node.add', 'title': title, 'zone_id': zone_id, 'lat': lat, 'lon': lon}
if nick is not None:
data['nick'] = nick
if body is not None:
data['body'] = body
if zone_desc is not None:
data['zone_description'] = zone_desc
if notification is not None:
data['notification'] = notification
if elevation is not None:
data['elevation'] = elevation
if stable != 'Yes':
data['stable'] = 'No'
if graph_server is not None:
data['graph_server'] = graph_server
if status is not 'Planned':
data['status'] = status
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
node_id = int(response.get('node_id'))
print 'Node succesfully created', node_id
print self.urlForNode(node_id)
else:
# Everybody can create nodes
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
return node_id
def addLink(self, fromdid, fromradiodev, todid, toradiodev,
ipv4=None, status='Working'):
if not self.is_authenticated():
raise GuifiApiError('You have to be authenticated to run this action')
data = {'command': 'guifi.link.add', 'from_device_id': fromdid,
'from_radiodev_counter': fromradiodev, 'to_device_id': todid,
'to_radiodev_counter': toradiodev}
params = urllib.urlencode(data)
(codenum, response) = self.sendRequest(params)
if codenum == ANSWER_GOOD:
lid = int(response.get('link_id'))
ipv4 = response.get('ipv4')
print 'Link succesfully created', lid
print self.urlForDevice(int(fromdid))
else:
# FIXME: Crashes when there are several errors and extra is a list (no has_key())
extra = response['extra'] if 'extra' in response else None
raise GuifiApiError(response['str'], response['code'], extra)
return (lid, ipv4)
def _parseResponse(self, jsondata):
""" Parses json response.
Returns a tuple with the code and the result of the request (it can be an errorenous response)
Raises exception if any error code is unknown """
print('<<<parseResponse>>>')
codenum = jsondata.get('code')['code']
codestr = jsondata.get('code')['str']
print('Got code {num}: {msg}'.format(num=codenum, msg=codestr))
if codenum == ANSWER_GOOD:
responses = jsondata.get('responses')
if isinstance(responses, list):
if len(responses) == 1:
responses = responses[0]
print('Just one response')
else:
print('There are several responses')
return (codenum, responses)
elif codenum == ANSWER_BAD:
errors = jsondata.get('errors')
if len(errors) == 1:
errors = errors[0]
print('Just one response (error)')
print('Error {code}: {msg}'.format(code=errors['code'], msg=errors['str']))
if 'extra' in errors:
print('Extra information: {msg}'.format(msg=errors['extra']))
else:
print('There are several responses (errors)')
for e in errors:
print('Error {code}: {msg}'.format(code=e['code'], msg=e['str']))
if 'extra' in e:
print('Extra information: {msg}'.format(msg=e['extra']))
return (codenum, errors)
else:
raise GuifiApiError('Unexpected return code: ' + codenum)
def _parseResponse(self, jsondata):
""" Parses json response.
Returns a tuple with the code and the result of the request (it can be an errorenous response)
Raises exception if any error code is unknown """
print '<<<parseResponse>>>'
codenum = jsondata.get('code')['code']
codestr = jsondata.get('code')['str']
print 'Got code %d: %s' % (codenum, codestr)
if codenum == ANSWER_GOOD:
responses = jsondata.get('responses')
if isinstance(responses, list):
if len(responses) == 1:
responses = responses[0]
print 'Just one response'
else:
print 'There are several responses'
return (codenum, responses)
elif codenum == ANSWER_BAD:
errors = jsondata.get('errors')
if len(errors) == 1:
errors = errors[0]
print 'Just one response (error)'
print 'Error', errors['code'], ':', errors['str']
if 'extra' in errors:
print 'Extra information:', errors['extra']
else:
print 'There are several responses (errors)'
for e in errors:
print 'Error', e['code'], ':', e['str']
if 'extra' in e:
print 'Extra information:', e['extra']
return (codenum, errors)
else:
raise GuifiApiError('Unexpected return code: ' + codenum)
