# -*- coding: utf-8 -*-
#
# (c) Copyright 2003-2015 HP Development Company, L.P.
#
# This program 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 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# Author: Shunmugaraj.K
#
# StdLib
import time
import io
import binascii
import xml.parsers.expat
from string import *
# Local
from .g import *
from . import device, utils
from .sixext import to_bytes_utf8
http_result_pat = re.compile(r"""HTTP/\d.\d\s(\d+)""", re.I)
HTTP_OK = 200
HTTP_ACCEPTED = 202
HTTP_NOCONTENT = 204
HTTP_ERROR = 500
MAX_RETRIES = 2
LEDM_WIFI_BASE_URI = "/IoMgmt/Adapters/"
# This payload is working for LaserJet Devices
adapterPowerXml_payload2 =""" %s """
# This payload is working for OfficeJet and Photosmart Devices
adapterPowerXml_payload1 = """%s"""
passPhraseXml="""%s%s%s%s"""
keyInfoXml = """AESOrTKIPautoWPA%s"""
def flushThePort(dev):
response = io.BytesIO()
timeout = 1
if dev.openLEDM() == -1:
dev.closeLEDM()
if dev.openEWS_LEDM() == -1:
dev.openMarvell_EWS()
try:
while dev.readMarvell_EWS(1024, response, timeout):
pass
except Error:
log.error("Unable to read Marvell_EWS Channel")
finally:
dev.closeMarvell_EWS()
else:
try:
dev.readLEDMAllData(dev.readEWS_LEDM, response, timeout)
except Error:
log.error("Unable to read EWS_LEDM Channel")
finally:
dev.closeEWS_LEDM()
else:
try:
dev.readLEDMAllData(dev.readLEDM, response, timeout)
except Error:
log.error("Unable to read LEDM Channel")
finally:
dev.closeLEDM()
def getAdaptorList(dev):
ret,params,elementCount,code ={},{},0,HTTP_ERROR
max_tries = 0
flushThePort(dev)
while max_tries < MAX_RETRIES:
max_tries +=1
URI = LEDM_WIFI_BASE_URI[0:len(LEDM_WIFI_BASE_URI)-1]# to remove "\" from the string
paramsList,code = readXmlTagDataFromURI(dev,URI,'')
if code == HTTP_OK:
break
if code != HTTP_OK:
log.error("Request Failed With Response Code %d"%code)
return ret
ret['adaptorlistlength'] = len(paramsList)
if len(paramsList) != 0:
a = 0
for params in paramsList:
ret['adaptorpresence-%d' % a] = ''
ret['adaptorstate-%d' % a] = ''
try:
ret['adaptorid-%d' % a] = params['io:adapter-map:resourcenode-map:resourcelink-dd:resourceuri']
except KeyError as e:
log.debug("Missing response key: %s" % e) #changed from error to debug
ret['adaptorid-%d' % a]=""
try:
ret['adaptorname-%d' % a] = params['io:adapter-io:hardwareconfig-dd:name']
except KeyError as e:
log.debug("Missing response key: %s" % e) #changed from error to debug
ret['adaptorname-%d' % a] = ""
try:
ret['adaptortype-%d' % a] = params['io:adapter-io:hardwareconfig-dd:deviceconnectivityporttype']
except KeyError as e:
log.debug("Missing response key: %s" % e) #changed from error to debug
ret['adaptortype-%d' % a] = ""
a = a+1
return ret
def getWifiAdaptorID(dev):
rVal = []
ret = getAdaptorList(dev)
try:
num_adaptors = ret['adaptorlistlength']
except KeyError:
num_adaptors = 0
for n in range(num_adaptors):
try:
name = ret['adaptortype-%d' % n]
except KeyError:
name = ''
if name.lower() in ('wifiembedded', 'wifiaccessory'):
params = ['adaptorid', 'adaptorname', 'adaptorstate', 'adaptorpresence']
r = []
for p in params:
try:
x = ret[''.join([p, '-', str(n)])]
except KeyError:
if p == 'adaptorid':
x = -1
else:
x = 'Unknown'
r.append(x)
rVal.append(r)
return rVal
def setAdaptorPower(dev, adapterList, power_state='on'):
adaptor_id=-1
adaptorName =""
for a in adapterList:
adaptor_id = a[0]
adaptorName = a[1]
ret,powerXml,URI,code = {},'','',HTTP_ERROR
URI = LEDM_WIFI_BASE_URI + adaptorName
powerXml = adapterPowerXml_payload1 %(power_state)
ret['errorreturn'] = writeXmlDataToURI(dev,URI,powerXml,60)
if not(ret['errorreturn'] == HTTP_OK or ret['errorreturn'] == HTTP_NOCONTENT):
log.debug("Wifi Adapter turn ON request Failed. ResponseCode=%s AdaptorId=%s AdaptorName=%s. Trying another interface" %(ret['errorreturn'],adaptor_id,adaptorName))
powerXml = adapterPowerXml_payload2 %(power_state)
ret['errorreturn'] = writeXmlDataToURI(dev,URI,powerXml,60)
if not(ret['errorreturn'] == HTTP_OK or ret['errorreturn'] == HTTP_NOCONTENT):
log.error("Wifi Adapter turn ON request Failed. ResponseCode=%s AdaptorId=%s AdaptorName=%s" %(ret['errorreturn'],adaptor_id,adaptorName))
else:
log.debug("Wifi Adapter turn ON request is Success. AdaptorId=%s AdaptorName=%s" %(adaptor_id,adaptorName))
# adapaterState = a[2], adapterPresence= a[3]
return adaptor_id, adaptorName, a[2], a[3]
return -1 ,"","",""
def performScan(dev, adapterName, ssid=None):
ret ={}
if ssid is None:
URI = LEDM_WIFI_BASE_URI + adapterName + "/WifiNetworks"
else:
URI = LEDM_WIFI_BASE_URI + adapterName + "/WifiNetworks/SSID="+ssid
while True:
params,code,elementCount = readXmlDataFromURI(dev,URI,'',30)
if code == HTTP_ACCEPTED:
continue
else:
break
ret['numberofscanentries'] = elementCount
if code != HTTP_OK:
log.error("Request Failed With Response Code %d"%code)
return ret
if params is not None:
if elementCount == 1:
try:
ssid = binascii.unhexlify(str(params['io:wifinetworks-io:wifinetwork-wifi:ssid']).encode('utf-8')).decode("utf-8")
if not ssid:
ret['ssid-0'] = to_unicode('(unknown)')
else:
ret['ssid-0'] = ssid
try:
ret['bssid-0'] = binascii.unhexlify(str(params['io:wifinetworks-io:wifinetwork-wifi:bssid']).encode('utf-8')).decode("utf-8")
except:
ret['bssid-0'] = params['io:wifinetworks-io:wifinetwork-wifi:bssid']
ret['channel-0'] = params['io:wifinetworks-io:wifinetwork-wifi:channel']
ret['communicationmode-0'] = params['io:wifinetworks-io:wifinetwork-wifi:communicationmode']
ret['dbm-0'] = params['io:wifinetworks-io:wifinetwork-io:signalinfo-wifi:dbm']
ret['encryptiontype-0'] = params['io:wifinetworks-io:wifinetwork-wifi:encryptiontype']
ret['signalstrength-0'] = params['io:wifinetworks-io:wifinetwork-io:signalinfo-wifi:signalstrength']
except KeyError as e:
log.debug("Missing response key: %s" % e)
else:
for a in range(elementCount):
try:
try:
ssid = binascii.unhexlify(str(params['io:wifinetworks-io:wifinetwork-wifi:ssid-%d' % a]).encode('utf-8')).decode('utf-8')
except TypeError:
# Some devices returns one invalid SSID (i.e. 0) along with valid SSIDs. e.g. Epic.
ssid = params['io:wifinetworks-io:wifinetwork-wifi:ssid-%d' % a]
except binascii.Error as err:
ssid = params['io:wifinetworks-io:wifinetwork-wifi:ssid-%d' % a]
if not ssid:
ret['ssid-%d' % a] = to_unicode('(unknown)')
else:
ret['ssid-%d' % a] = ssid
try:
ret['bssid-%d' % a] = binascii.unhexlify(str(params['io:wifinetworks-io:wifinetwork-wifi:bssid-%d' % a]).encode('utf-8')).decode("utf-8")
except:
ret['bssid-%d' % a] = params['io:wifinetworks-io:wifinetwork-wifi:bssid-%d' % a]
ret['channel-%d' % a] = params['io:wifinetworks-io:wifinetwork-wifi:channel-%d' % a]
ret['communicationmode-%d' % a] = params['io:wifinetworks-io:wifinetwork-wifi:communicationmode-%d' % a]
ret['dbm-%d' % a] = params['io:wifinetworks-io:wifinetwork-io:signalinfo-wifi:dbm-%d' % a]
ret['encryptiontype-%d' % a] = params['io:wifinetworks-io:wifinetwork-wifi:encryptiontype-%d' % a]
ret['signalstrength-%d' % a] = params['io:wifinetworks-io:wifinetwork-io:signalinfo-wifi:signalstrength-%d' % a]
except KeyError as e:
log.debug("Missing response key: %s" % e)
try:
ret['signalstrengthmax'] = 5
ret['signalstrengthmin'] = 0
except KeyError as e:
log.debug("Missing response key: %s" % e)
return ret
def getIPConfiguration(dev, adapterName):
ip, hostname, addressmode, subnetmask, gateway, pridns, sec_dns = \
'0.0.0.0', 'Unknown', 'Unknown', '0.0.0.0', '0.0.0.0', '0.0.0.0', '0.0.0.0'
protocol = 'old'
URI = LEDM_WIFI_BASE_URI + adapterName + "/Protocols"
#URI = "/DevMgmt/IOConfigDyn.xml"
params,code,elementCount = {},HTTP_ERROR,0
max_tries = 0
while max_tries < MAX_RETRIES:
max_tries +=1
params,code,elementCount = readXmlDataFromURI(dev,URI,'",0,len(passPhraseXml))
ppXml = (passPhraseXml[:pos] + keyInfoXml + passPhraseXml[pos:])%(binascii.hexlify(to_bytes_utf8(ssid)).decode('utf-8'),communication_mode,encryption_type,\
authMode,binascii.hexlify(to_bytes_utf8(key)).decode('utf-8'))
code = writeXmlDataToURI(dev,URI,ppXml,60)
ret['errorreturn'] = code
if not(code == HTTP_OK or HTTP_NOCONTENT):
log.error("Request Failed With Response Code %d" % ret['errorreturn'])
return ret
def getVSACodes(dev, adapterName):
ret,params,code,elementCount = [],{},HTTP_ERROR,0
severity,rule ='',''
URI = LEDM_WIFI_BASE_URI + adapterName + "/VsaCodes.xml"
max_tries = 0
while max_tries < MAX_RETRIES:
max_tries +=1
params,code,elementCount = readXmlDataFromURI(dev,URI,"', xmlReqDataNode)) # [c for c in xmlReqDataNode if c not in "<>"] # To remove '<' and '>' characters
reqDataElementList = root_element.getElementsByTagName(xmlReqDataNode)
for node in reqDataElementList:
repstr = node.toString()
repstr = repstr.replace('\r',' ').replace('\t',' ').replace('\n',' ') # To remove formating characters from the received xml
params = utils.XMLToDictParser().parseXML(to_bytes_utf8(repstr))
paramsList.append(params)
except xml.parsers.expat.ExpatError as e:
log.debug("XML parser failed: %s" % e) #changed from error to debug
else:
log.debug("HTTP Responce failed with %s code"%code)
return paramsList,code
def readXmlDataFromURI(dev,URI,xmlRootNode,xmlChildNode,timeout=60):
params,code,elementCount ={},HTTP_ERROR,0
data = format_http_get(URI,0,"")
log.info(data)
response = io.BytesIO()
if dev.openLEDM() == -1:
dev.closeLEDM()
if dev.openEWS_LEDM() == -1:
dev.openMarvell_EWS()
dev.writeMarvell_EWS(data)
try:
while dev.readMarvell_EWS(1024, response, timeout):
pass
except Error:
dev.closeMarvell_EWS()
log.error("Unable to read Marvell_EWS Channel")
else:
dev.writeEWS_LEDM(data)
try:
dev.readLEDMData(dev.readEWS_LEDM, response,timeout)
except Error:
dev.closeEWS_LEDM()
log.error("Unable to read EWS_LEDM Channel")
else:
dev.writeLEDM(data)
try:
dev.readLEDMData(dev.readLEDM, response,timeout)
except Error:
dev.closeLEDM()
log.error("Unable to read LEDM Channel")
#dev.closeEWS_LEDM()
strResp = response.getvalue().decode('utf-8')
if strResp is not None:
code = get_error_code(strResp)
if code == HTTP_OK:
#strResp = utils.unchunck_xml_data(strResp)
strResp = utils.extract_xml_chunk(strResp)
pos = strResp.find(xmlRootNode,0,len(strResp))
repstr = strResp[pos:].strip()
repstr = repstr.replace('\r',' ').replace('\t',' ').replace('\n',' ') # To remove formating characters from the received xml
repstr = repstr.rstrip('0') # To remove trailing zero from the received xml
elementCount = repstr.count(xmlChildNode)
try:
params = utils.XMLToDictParser().parseXML(repstr)
except xml.parsers.expat.ExpatError as e:
log.debug("XML parser failed: %s" % e) #changed from error to debug
else:
log.debug(" HTTP Responce failed with %s code"%code)
return params,code,elementCount
def writeXmlDataToURI(dev,URI,xml,timeout=60):
code = HTTP_ERROR
data = format_http_put(URI,len(xml),xml)
response = io.BytesIO()
if dev.openLEDM() == -1:
if dev.openEWS_LEDM() == -1:
dev.openMarvell_EWS()
dev.writeMarvell_EWS(data)
try:
while dev.readMarvell_EWS(1000, response, timeout):
pass
except Error:
dev.closeMarvell_EWS()
log.error("Unable to read Marvell_EWS Channel")
else:
dev.writeEWS_LEDM(data)
try:
dev.readLEDMData(dev.readEWS_LEDM, response, timeout)
except Error:
dev.closeEWS_LEDM()
log.error("Unable to read EWS_LEDM Channel")
else:
dev.writeLEDM(data)
try:
dev.readLEDMData(dev.readLEDM, response,timeout )
except Error:
dev.closeLEDM()
log.error("Unable to read LEDM Channel")
strResp = response.getvalue().decode('utf-8')
if strResp is not None:
code = get_error_code(strResp)
return code
def get_error_code(ret):
if not ret: return HTTP_ERROR
match = http_result_pat.match(ret)
if match is None: return HTTP_ERROR
try:
code = int(match.group(1))
except (ValueError, TypeError):
code = HTTP_ERROR
return code
def format_http_get(requst, ledmlen, xmldata, content_type="text/xml; charset=utf-8"):
host = 'localhost'
return utils.cat(
"""GET $requst HTTP/1.1\r
Host: $host\r
User-Agent: hplip/3.0\r
Content-Type: $content_type\r
Content-Length: $ledmlen\r
\r
$xmldata""")
def format_http_put(requst, ledmlen, xmldata, content_type="text/xml; charset=utf-8"):
host = 'localhost'
return utils.cat(
"""PUT $requst HTTP/1.1\r
Host: $host\r
User-Agent: hplip/3.0\r
Content-Type: $content_type\r
Content-Length: $ledmlen\r
\r
$xmldata""")