#!/usr/bin/python

# initially written by Shane Anglin on 5-19-01
# JSA - 06-04-01 added multiple pager capability
# JSA - 06-01-01 added module to replace non-friendly XML characters
# JSA - 06-12-01 added more documentation comments
#
# Call this program from another program by using the following commands:
# from wctpXml import *
# pagers = [1111111,2222222,3333333]
# msgString = 'This is a test message'
# wctpxmlSendMsg(msgString,pagers)

import os, sys, time, string, smtplib, httplib
from Pager import *

def sendFailureEmail(String):
        sndStringX = String
        separatorline = '------------------------'
        server=smtplib.SMTP("smtp.yourdomain.com")
        tolist=["person1@yourdomain.com"]
        msg = "From: AutoNotify@yourdomain.com\012Subject: Message Failed for WCTP SendMsg" + "\012\012" + "The following is the message that failed for the WCTP SendMsg: \012\012" + separatorline + "\012" + sndStringX + separatorline + "\012\012"
        fromwhom = "autonotify@yourdomain.com"
        server.sendmail(fromwhom,tolist,msg)
        server.quit()

def replaceChars(msgText):
	# this module replaces non-friendly XML characters
	x = 0
	replaceList = [('&','&amp;'),('\033','&lt;esc&gt;'),('"','&quot;'),("'",'&apos;'),('<','&lt;'),('>','&gt;')]
	for replacement in replaceList:
		toBeReplaced = replaceList[x][0]
		replaceWith = replaceList[x][1]
		msgText = string.replace(msgText,toBeReplaced,replaceWith)
		x = x + 1
	return msgText	

def fileContents1():
	partA = '<?xml version="1.0"?>'
	partB = '<!DOCTYPE wctp-Operation SYSTEM "http://www.skytel.com/protocol/dtds/wctp/wctpV1-0.dtd">'
	partC = '<wctp-Operation wctpVersion="WCTP-DTD-1.0">'
	partD = '  <wctp-SubmitClientMessage>'
	partE = '    <wctp-SubmitClientHeader'
	totalStringFC1 = partA + "\012" + partB + "\012" + partC + "\012" + partD + "\012" + partE + "\012"
	# the 'submitTimestamp' will go after this
	return totalStringFC1

def fileContents2():
	partA = '    >'
	partB = '      <wctp-ClientOriginator'
	partC = '        senderID="personsName@yourdomain.com"'
	partD = '        miscInfo="WCTP MTNI MSGSEND"'
	partE = '      />'
	partF = '      <wctp-ClientMessageControl'
	totalStringFC2 = partA + "\012" + partB + "\012" + partC + "\012" + partD + "\012" + partE + "\012" + partF + "\012"
	# the 'messageID' (random number) will go after this
	return totalStringFC2
	
def fileContents3():
	partA = '        allowResponse="true"'
	partB = '        preformatted="true"'
	# place any other supported commands, like deliveryPriority, here
	partC = '      />'
	partD = '      <wctp-Recipient'
	totalStringFC3 = partA + "\012" + partB + "\012" + partC + "\012" + partD + "\012"
	# the 'RecipientID' will go after this
	return totalStringFC3

def fileContents4():
	partA = '      />'
	partB = '    </wctp-SubmitClientHeader>'
	partC = '    <wctp-Payload>'
	partD = '      <wctp-Alphanumeric>'
	totalStringFC4 = partA + "\012" + partB + "\012" + partC + "\012" + partD + "\012"
	# the 'msgPayload' will go after this
	return totalStringFC4

def fileContents5():
	partA = '      </wctp-Alphanumeric>'
	partB = '    </wctp-Payload>'
	partC = '  </wctp-SubmitClientMessage>'
	partD = '</wctp-Operation>'
	totalStringFC5 = partA + "\012" + partB + "\012" + partC + "\012" + partD + "\012"
        return totalStringFC5


def buildXMLFile(msgPayload,pagerIdX,timeStamp,randomidNum):
	# get all the pieces and put them together into a valid XML format
	formDataX = ""
	fc1 = fileContents1()
	X1 = '      submitTimestamp="' + timeStamp + '"'
	fc2 = fileContents2()
	X2 = '        messageID="' + randomidNum + '"'
	fc3 = fileContents3()
	X3 = '        RecipientID=' + '"' + pagerIdX + '"'
	fc4 = fileContents4()
	X4 = msgPayload 
	fc5 = fileContents5()
	# Now put the pieces of the files into one XML document file
	formDataX = fc1 + X1 + "\012" + fc2 + X2 + "\012" + fc3 + X3 + "\012" + fc4 + X4 + "\012" + fc5
	return formDataX
	
def postXML(formData,msgPayload,pagerID):
	# Send data to target webserver for data submission
	formDataZ = formData
	#print formDataZ  # uncomment this line if you wish to see the form as it looks after compilation
	h = httplib.HTTP("wctp.skytel.com",80)   # port 80 may not be the default port on the target server
	h.set_debuglevel(0) # [enable logging=>debug_level(1)] and [disable logging=debug_level(0)]
	h.putrequest("POST","/wctp")  # on some WCTP gateways, the "/wctp" may need to be "/WCTP"
	h.putheader("Content-Type","text/xml")
	formDataLEN= str(len(formDataZ))   # determine the length of the entire XML form
	h.putheader("Content-Length",formDataLEN)
	h.putheader('Accept', 'text/html')
	h.putheader('Accept', 'text/plain')
	h.endheaders()
	h.send(formDataZ) # send wctpXML data
	errcode, errmsg, headers = h.getreply()   # read responses that return from the WCTP server
	print "errcode = ",errcode # error code should be 200
	print "errmsg = ",errmsg
	#print "headers = ",headers
	currentDate = time.strftime("%m-%d-%y",time.localtime(time.time())) # i.e. 06-05-01
	currentTime = time.strftime("%H:%M",time.localtime(time.time()))  # example: 1408 for 2:08pm
	print "Current Time = " + currentTime + " and current date = " + currentDate
	print 'messageSent to ' + pagerID + ' = \012' + msgPayload
	print "\012"
	f = h.getfile()
	response = f.read()   # read the raw HTML return file
	#print response   # print the raw HTML return file
	f.close()
	return response 

def wctpxmlSendMsg(msgString,pagerList):
	# THIS MODULE IS EXPECTING TO RECEIVE A TEXT STRING AND A LIST OF PAGERID(S)
        msgPayload = msgString
	pagerListX = pagerList
	if len(pagerListX) == 0:
		print "The pagerList was empty!  Please put at least one pagerid in the list!"
		time.sleep(5)
		sys.exit()
        todaysDate = ""
        todaysTime = ""
        # sys.stderr = sys.stdout
	msgPayload = replaceChars(msgPayload) # replace non-compliant XML characters

	for pageridX in pagerListX:
		# these formats must be exactly as shown
	        todaysTime = time.strftime("%H:%M:%S",time.localtime(time.time()))  # example: 10:12:34
	        todaysDate= time.strftime("%Y-%m-%d",time.localtime(time.time()))   # example:2001-01-01
	        randomidNum = time.strftime("%Y%m%d%H%M%S",time.localtime(time.time()))   # example: 20010517165456
        	timeStamp = todaysDate + 'T' + todaysTime
		# piece together the components of the XML form to be transmitted
		formData = buildXMLFile(msgPayload,str(pageridX),timeStamp,randomidNum) # compile the XML form 
		cnt = 0
		while cnt < 5:   # try at least 5 times to transmit the XML data to the WCTP target server
			try:
				responseResult = postXML(formData,msgPayload,str(pageridX))
				break   # get out of while loop... SUCCESS! My work is finished here.
					# NOTE: to handle error codes, simply place IF statements after the
					#   responseResult variable and check for error codes and perform
					#    whatever action upon finding them
			except:
				print '***** Sending of XML form to WCTP Server failed... I will try again! *****'
				pass
			cnt = cnt + 1
			if cnt == 6:   # if you are here... bad news... the function, postXML, failed 5 times in a row
				try:
					sendFailureEmail(formData)   # send an email to someone to notify them
									#  of the sendMsg failure
					print ' I generated a notificiation email.'
				except:
					print ' I cannot even generate an email to tell anyone WCTP Send Message failed!'
					time.sleep(30)
					pass

if __name__ == '__main__':
	# dummyMsg = "This is the MAIN module"
	dummyVar = 0