Obi2Yac.au3

#Region ;**** Directives created by AutoIt3Wrapper_GUI ****
#AutoIt3Wrapper_Icon=Obi2Yac.ico
#AutoIt3Wrapper_Outfile=Obi2Yac.exe
#AutoIt3Wrapper_Res_Comment=This script is designed to do name substitutions based on a phone number located in local access database.  If name is not found, it will query OpenCNAM/WhitePages.com
#AutoIt3Wrapper_Res_Description=Obi to YAC Caller ID Reverse Lookup
#AutoIt3Wrapper_Res_Fileversion=1.0.0.59
#AutoIt3Wrapper_Res_Fileversion_AutoIncrement=y
#AutoIt3Wrapper_Res_Language=1033
#EndRegion ;**** Directives created by AutoIt3Wrapper_GUI ****
#cs ----------------------------------------------------------------------------

 AutoIt Version: 3.3.14.5
 Author: Carlos Amézaga
 Licence: Apache License 2.0.  Free to modify at will, but hopefully you post your changes so other Obi users benefit. :-)

 Script Function:
	This script is designed to do name substitutions based on a phone number located in local access database.  If the name is not found in the
	local database, it will	query OpenCNAM/WhitePages.com and hope it gets lucky during it's query.  Failing that, it returns NAME UNAVAILABLE
	for CNAM.  Queries using Whitepages.com will only occur if you have a valid APIKey defined in the INI. Results are then broadcast to Yac
	listeners defined in database, Growl or PushBullet if enabled.  All successful  queries are cached to improve speed during future calls. This script
	runs as a Syslog server and is designed to work with an Obi set to forward Syslog data to PC where Obi2Yac is running.  Your mileage may
	vary.

	You can find my program here: https://github.com/thesmee/obi2yac/
	You can find YAC here: http://www.sunflowerhead.com/software/yac/
	You can find Growl for Windows here: http://www.growlforwindows.com/gfw/
	You can find Growl for Android here: https://play.google.com/store/apps/details?id=com.growlforandroid.client
	More information on PushBullet: https://www.pushbullet.com

Access Database Tables are as follows:
	CallLogs: Log of all received calls
	Listeners: PCs which will receive YAC broadcasts
	ListenerTypes: Currently defines listener types Obi2Yac can send too.  YAC/NCID are listed, but I never got around to doing NCID broadcasts.
	Substitutions: Your personal substitutions.  You can add both Obi or regular numbers.
	SubstitutionsCache: All successful  queries to OpenCNAM/WhitePages.com are cached here to avoid lookups & increase spead of CID broadcast

Obi2Yac uses an INI file to define the following:
	APIKey: WhitePages.com API Key.  If defined, lookups will will occur after OpenCNAM query.
	GrowlEnable: If defined, will register with Growl if installed on local PC and send CID for broadcast.
	PushBulletlEnable: If defined, will broadcast CID information to PushBullet.  Must enter API key in INI under PushBulletlKey.
	SysLogIP: If defined, will bind to this IP for Syslog.  Do not use 127.0.0.1. If not defined, will bind to first IP it finds.
	SysLogPort: If defined, will bind to that port via UDP. Otherwise it will bind to port 514 UDP.
	NoBreak: If set to 0, will prevent App exit/pause via Systray + Right click.

#ce ----------------------------------------------------------------------------

; Script Start

$listObiProcess = ProcessList("Obi2Yac.exe")
If $listObiProcess[0][0] > 1 Then
	MsgBox(0, "Error", "Process Already Running. Exiting....")
	Exit
EndIf

#include <String.au3>
#include <Date.au3>
#include <array.au3> ; Thanks zatorg: http://www.autoitscript.com/forum/index.php?showtopic=45189&hl=Asock
#include <_Growl.au3> ;Thanks Markus Mohnen <markus.mohnen@googlemail.com>: http://www.autoitscript.com/forum/topic/95141-growl-for-windows-udf/
#include <_StringStripChars.au3> ;Thanks amel27 & G.Sandler (a.k.a MsCreatoR): http://www.autoitscript.com/forum/topic/69186-stringstripchr/
#include <INet.au3>
#Include "Curl.au3" ; Thanks Ward: https://www.autoitscript.com/forum/topic/173067-curl-udf-autoit-binary-code-version-of-libcurl-with-ssl-support/

;Don't allow pause
AutoItSetOption ( "TrayAutoPause" , 0)

;Look for INI and MDB files necessary by this app, if they don't exist, create them.
FileInstall("Obi2Yac.ini", @ScriptDir & "\", 0)
FileInstall("Obi2Yac.mdb", @ScriptDir & "\", 0)
FileInstall("readme.md",  @ScriptDir & "\", 0)

;Don't allow exit via Systray.  Must Kill PID.  Change via INI
$NoBreak = ReadINI("NoBreak", 0)
Break($NoBreak)

;Define Access Database Name Here
Global $dbname = @ScriptDir & "\Obi2Yac.mdb"

;Define CID Syslog String to Look for Here
Global $CIDString = "[SLIC] CID to deliver:"

;Define CID Syslog String to Look for Here
Global $DTMFString
Global $CaptureDTMF

;Define Push Bullet String
$PushBulletlKey = ReadINI("PushBulletlKey", "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")

;Define cURL Buffer Constant Here
Global $_cURL_OutputBuffer

;What IP to use for Syslog
$SysLogIP = ReadINI("SysLogIP", @IPAddress1)

;What port to use for Syslog
$SysLogPort = ReadINI("SysLogPort", 514)

;DTMF Trigger Vallues
Global $DTMFTrigger1 = ReadINI("DTMFTrigger1", "X")
Global $DTMFTrigger2 = ReadINI("DTMFTrigger2", "X")
Global $DTMFTrigger3 = ReadINI("DTMFTrigger3", "X")

; Install a custom error handler
$oError = ObjEvent("AutoIt.Error","ErrFunc")

; Start The UDP Services
;==============================================
UDPStartup()

; Bind to a SOCKET as if Sysloger.  Will bind to Local IP1.  Can be a problem if you have more than one IP.
;==============================================
$socket = UDPBind($SysLogIP, $SysLogPort)
If @error <> 0 Then
	MsgBox(0, "Error", "Unable to bind to " & $SysLogIP & " on port 514")
	Exit
EndIf

;Wait for data and do things when received.
While 1
    $data = UDPRecv($socket, 100, 1)
    If $data <> "" Then
		$stringData = BinaryToString($data)

		;Output Syslog Data for Curious People
        ConsoleWrite($stringData & @CRLF)

		$CheckSyslogData = StringInStr( $stringData, $CIDString, 0, 1, 1)
		;Filter out null messages sent by some Obi devices to obi2yac
		$CheckSyslogDataNull = StringInStr( $stringData, "'(null)' (null)", 0, 1, 1)
		$DTMFDialStart = StringInStr( $stringData, "[CPT] --- FXS h/w tone generator (dial)---", 0, 1, 1) ; Set to 1 if Dialing detected
		;$DTMFDialEnd = StringInStr( $stringData, "GTT:call state changed from 0 to 2", 0, 1, 1) ;Set to 1 if call is starting.  End DTMF capture.
		$DTMFDialEnd = StringInStr( $stringData, "[CPT] --- FXS h/w tone generator (ringback)---", 0, 1, 1) ;Set to 1 if call is starting.  End DTMF capture.
		$PhoneOnHook= StringInStr( $stringData, "[SLIC]:Slic#0 ONHOOK", 0, 1, 1) ;Phone went On hook, Reset.

		;If Dialing detected, setup to capture DTMF
		If $DTMFDialStart > 0 Then $CaptureDTMF = 1

		;Start Capturing Touch Tones
		If $CaptureDTMF = 1  AND StringInStr( $stringData, "[DSP]: ---- H/W DTMF ON (level:1) :", 0, 1, 1) > 0 Then
			$DTMFString = $DTMFString & StringMid($stringData, 41, 1)
		EndIf

		;End of DTMF Capture. Now do Something special.
		If $DTMFDialEnd > 0 Then
			ConsoleWrite("DTMF Event Received: " & $DTMFString & @CRLF)
				If $DTMFString = $DTMFTrigger1 OR $DTMFString = $DTMFTrigger2 OR $DTMFString = $DTMFTrigger3 Then
					SendEmail($DTMFString)
				EndIf
			$DTMFString = ""
			$CaptureDTMF = 0
		EndIf

		;Phone went back on hook.  Reset & Clear DTMF captured data if any.
		If $PhoneOnHook > 0 Then
			$DTMFString = ""
			$CaptureDTMF = 0
		EndIf

		If $CheckSyslogData > 0 AND $CheckSyslogDataNull = 0 Then
			;Start the Lookups
			ObiPhoneCall($stringData)
		EndIf

    EndIf
    Sleep(100)
WEnd

Func ObiPhoneCall($SyslogString)
	;Parse number from Syslog string and format
	$phoneNumber = 	FormatPhone($SyslogString)

	;If no CNAM in string then start phone lookup here.  Local database first, otherwise OpenCNAM.  If neither return a hit
	;and you have a defined API key in INI file, it will query Whitepages.com as a last option.  Results ar cached in database
	;for next call.

	$CIDName = LookupPhoneNumber($phoneNumber[2], StringLen($phoneNumber[1]), $phoneNumber[1])

	;Write output to console for curious people...
	ConsoleWrite(@CRLF & "Name: " & $CIDName & @CRLF)
	ConsoleWrite("Number: " & StringRegExpReplace($phoneNumber[2], "\A(\d{1})(\d{3})(\d{3})(\d{4})","($2) $3-$4") & @CRLF)

	;Broadcast number lookup results to YAC clients.  It will also send out Growl or PushBullet if it is enabled in INI file.
	$formatedPhone = Broadcast($CIDName, $phoneNumber[2])

	;Log results in database
	LogCID($CIDName, $formatedPhone)

	;Reduce working set to free up memory
	SelfReduceMemory()

	Return
EndFunc

Func FormatPhone($SyslogString)
	$phoneNumberSyslogL = StringSplit($SyslogString, $CIDString, 1)
	$phoneNumber = StringSplit(StringStripWS($phoneNumberSyslogL[2],3), "' ", 1)
	$phoneNumber[1] = _StringStripChars($phoneNumber[1], "'", 3, 0, 0)
	;$phoneNumber[2] = StringLeft($phoneNumber[2], StringLen($phoneNumber[2]) - 2)
	$phoneNumber[2] = StringLeft($phoneNumber[2], StringLen($phoneNumber[2]))
	ConsoleWrite($phoneNumber[1] & ' ' & $phoneNumber[2])
	Return($phoneNumber)
EndFunc

Func LookupPhoneNumber($phoneNumber, $phoneLen, $phoneCNAM)
	$query  = "SELECT Name, Number FROM Substitutions WHERE Number = '" & StringRight($phoneNumber,10) & "' UNION SELECT Name, Number FROM SubstitutionsCache WHERE Number = '" & StringRight($phoneNumber,10) & "'"
	$adoCon = ObjCreate("ADODB.Connection")
	$adoCon.Open("Driver={Microsoft Access Driver (*.mdb)}; DBQ=" & $dbname) ;Use this line if using MS Access 2003 and lower
	;$adoCon.Open ("Provider=Microsoft.Jet.OLEDB.4.0; Data Source=" & $dbname) ;Use this line if using MS Access 2007 and using the .accdb file extension
	$adoRs = ObjCreate ("ADODB.Recordset")
	$adoRs.CursorType = 1
	$adoRs.LockType = 3
	$adoRs.Open ($query, $adoCon)
	$APIKey = ReadINI("APIKey", 0)

	With $adoRs
		If $adoRs.RecordCount Then
		$count=0
			While Not .EOF
				$count=$count+1
				$theName = $adoRs.Fields("Name").value
			.MoveNext
			WEnd
		ElseIf $phoneLen > 0 Then
			$theName = $phoneCNAM
		Else
			$sData = InetRead("https://api.opencnam.com/v2/phone/+" & $phoneNumber)
			$nBytesRead = @extended
			If $nBytesRead > 0 Then
				$theName = BinaryToString($sData)
				CacheCID($theName, StringRight($phoneNumber,10))
			ElseIf $APIKey <> 0 Then
				$url = 'http://api.whitepages.com/reverse_phone/1.0/?phone=' & StringRight($phoneNumber,10) & ';api_key=' & $APIKey
				$objhttp = ObjCreate("MSXML2.XMLhttp.3.0")
				$objhttp.Open("GET", $url, false)
				$objhttp.Send
				$data = $objhttp.responseText

				$oNodeResult = _StringBetween($data, "<wp:result ", "/>")
			If IsArray($oNodeResult) Then
				$oResult = _StringBetween($oNodeResult[0], 'wp:type="', '"')
				$oCode = _StringBetween($oNodeResult[0], 'wp:code="', '"')

				If $oResult[0] = "success" AND $oCode[0] = "Found Data" Then
					$oNodeListing = _StringBetween($data, "<wp:listing>", "</wp:listing>")
					$oCity =  _StringBetween($oNodeListing[0], "<wp:city>", "</wp:city>")
					$oState =  _StringBetween($oNodeListing[0], "<wp:state>", "</wp:state>")
					$oDisplayName = _StringBetween($oNodeListing[0], "<wp:displayname>", "</wp:displayname>")
					$oCarrier =  _StringBetween($oNodeListing[0], "<wp:carrier>", "</wp:carrier>")

					If (UBound($oDisplayName)) > 0 Then
						$theDisplayName = $oDisplayName[0]
					ElseIf (UBound($oCarrier)) > 0 Then
						$theDisplayName = $oCity[0] & ", " & $oState[0] &  " - " & $oCarrier[0]
					Else
						$theDisplayName = ""
					EndIf

					$theName = $theDisplayName
					CacheCID($theName, StringRight($phoneNumber,10))
			EndIf
				Else
					$theName = "NAME UNAVAILABLE"
				EndIf
			Else
				$theName = "NAME UNAVAILABLE"
			EndIf
		EndIf
	EndWith
	$adoCon.Close
	Return($theName)
EndFunc

Func Broadcast($aName, $aNumber)
	$query  = "SELECT * FROM Listeners WHERE ACTIVE=1"
	$adoCon = ObjCreate("ADODB.Connection")
	$adoCon.Open("Driver={Microsoft Access Driver (*.mdb)}; DBQ=" & $dbname) ;Use this line if using MS Access 2003 and lower
	;$adoCon.Open ("Provider=Microsoft.Jet.OLEDB.4.0; Data Source=" & $dbname) ;Use this line if using MS Access 2007 and using the .accdb file extension
	$adoRs = ObjCreate ("ADODB.Recordset")
	$adoRs.CursorType = 1
	$adoRs.LockType = 3
	$adoRs.Open ($query, $adoCon)

	If StringLen($aNumber) = 11 Then
		$phoneNumber = StringRegExpReplace($aNumber, "\A(\d{1})(\d{3})(\d{3})(\d{4})","($2) $3-$4")
	ElseIf StringLen($aNumber) = 10 Then
		$phoneNumber = StringRegExpReplace($aNumber, "\A(\d{3})(\d{3})(\d{4})","($1) $2-$3")
	Else
		$phoneNumber = $aNumber
	EndIf

	;Broadcast number lookup results to Growl
	If ReadINI("GrowlEnable", 0) = 1 Then
		Local $notifications[1][1] = [["Notifcation"]]
		Local $id=_GrowlRegister("Obi2Yac", $notifications, "http://www.autoitscript.com/autoit3/files/graphics/au3.ico")
		_GrowlNotify($id, $notifications[0][0], "Call From: " & $phoneNumber , $aName & " : "& _Now())
	EndIf

	;Broadcast number lookup results to PushBullet
	If ReadINI("PushBulletlEnable", 0) = 1 Then
		$doPushBullet = PushBulletCURL($aName, $phoneNumber)
	EndIf


	With $adoRs
		If $adoRs.RecordCount Then
		TCPStartup()
		$count=0
			While Not .EOF
				$count=$count+1
				$szIPADDRESS = $adoRs.Fields("IP").value  ;Retrieve value by field name
				$theType = $adoRs.Fields("Type").value    ;Retrieve value by field name
				If $theType = 1 Then
					$PingHost = Ping($szIPADDRESS, 10)
					If $PingHost Then
						$ConnectedSocket = TCPConnect($szIPADDRESS, "10629")
						TCPSend($ConnectedSocket, StringToBinary("@CALL" & StringLeft($aName, 25) & "~" & $phoneNumber, 4))
						TCPCloseSocket($ConnectedSocket)
					EndIf
				EndIf
			.MoveNext
			WEnd

			TCPShutdown()
		EndIf

	EndWith

	$adoCon.Close

	Return($phoneNumber)
EndFunc

Func CacheCID($aName, $aNumber)
	$query  = "INSERT INTO SubstitutionsCache ([Name], [Number]) VALUES ('" & StringReplace($aName, "'", "''") & "', '" & $aNumber &"')"
	$adoCon = ObjCreate("ADODB.Connection")
	$adoCon.Open("Driver={Microsoft Access Driver (*.mdb)}; DBQ=" & $dbname) ;Use this line if using MS Access 2003 and lower
	;$adoCon.Open ("Provider=Microsoft.Jet.OLEDB.4.0; Data Source=" & $dbname) ;Use this line if using MS Access 2007 and using the .accdb file extension
	$adoCon.Execute($query)
	$adoCon.Close
	Return
EndFunc

Func LogCID($aName, $aNumber)
	$query  = "INSERT INTO CallLogs ([Name], [Number]) VALUES ('" & StringReplace($aName, "'", "''") & "', '" & $aNumber &"')"
	$adoCon = ObjCreate("ADODB.Connection")
	$adoCon.Open("Driver={Microsoft Access Driver (*.mdb)}; DBQ=" & $dbname) ;Use this line if using MS Access 2003 and lower
	;$adoCon.Open ("Provider=Microsoft.Jet.OLEDB.4.0; Data Source=" & $dbname) ;Use this line if using MS Access 2007 and using the .accdb file extension
	$adoCon.Execute($query)
	$adoCon.Close
	Return
EndFunc

Func ReadINI($theKey, $theDefault)
	$query = IniRead(@ScriptDir& "\Obi2Yac.ini", "Obi2YacConfig", $theKey, $theDefault)
	Return($query)
EndFunc

Func SelfReduceMemory()
	DllCall("psapi.dll", "int", "EmptyWorkingSet", "long", -1)
	Return
EndFunc   ;==>_SelfReduceMemory

Func SendEmail($DTMFReceived)
 If ReadINI("EnableDTMFTrigger", 0) = 1 Then
	TraySetToolTip("Obi2Yac Event Received: " & $DTMFReceived)
	$EmailSubject = ReadINI("EmailSubject", "Undefined")
	$s_SmtpServer = ReadINI("SmtpServer", 0)
	$s_FromName = ReadINI("FromName", "Obi2Yac Alert")
	$s_FromAddress = ReadINI("FromAddress", "postmaster@somewhere.net")
	$s_ToAddress = ReadINI("ToAddress", "jdoe@@somewhere.net")
	$s_Subject = "Obi2Yac Alert: " & $EmailSubject
	Dim $as_Body[6]
	$as_Body[0] = "Greetings,"
	$as_Body[1] = ""
	$as_Body[2] = " Obi2Yac event received (" & $DTMFReceived & ").  Event type is: " & $EmailSubject
	$as_Body[3] = ""
	$as_Body[4] = "--"
	$as_Body[5] = "Obi2Yac"
	$Response = _INetSmtpMail ($s_SmtpServer, $s_FromName, $s_FromAddress, $s_ToAddress, $s_Subject, $as_Body, @computername, -1)
	If $Response = 1 Then
		ConsoleWrite("Message Sucessfully sent with the following paramaters: " & $s_SmtpServer & ", " & $s_FromName & ", " & $s_FromAddress & ", " & $s_ToAddress & ", " & $s_Subject & ", " & $DTMFReceived & @CRLF)
	Else
		ConsoleWrite("SMTP failed with error code " & @error & @CRLF)
	EndIf
 EndIf
Return
EndFunc

Func JsonPost($sJson, ByRef $iRetCode)

	; Init Easy Curl Interface e set url (echo service)
	Local $oCurl = Curl_Easy_Init()
	curl_easy_setopt($oCurl, $CURLOPT_URL, "https://api.pushbullet.com/v2/pushes")
	curl_easy_setopt($oCurl, $CURLOPT_USERPWD, $PushBulletlKey)

	; Set content type header
	Local $headers = curl_slist_append(0, "Content-Type: application/json")
	curl_easy_setopt($oCurl, $CURLOPT_HTTPHEADER, $headers)

	; Post fields & size
	Local $stString = DllStructCreate("char v[" & StringLen($sJson) & "]")
	DllStructSetData($stString, 1, $sJson)
	curl_easy_setopt($oCurl, $CURLOPT_POSTFIELDS, DllStructGetPtr($stString))
	curl_easy_setopt($oCurl, $CURLOPT_POSTFIELDSIZE, StringLen($sJson))

	; Set callbac function to get server response back (see global var $_cURL_OutputBuffer)
	$hWriteFunc = DllCallbackRegister("WriteFunc_CallBack", "uint:cdecl", "ptr;uint;uint;ptr")
	curl_easy_setopt($oCurl, $CURLOPT_WRITEFUNCTION, DllCallbackGetPtr($hWriteFunc))

	; Ignore ssl certificates check
	curl_easy_setopt($oCurl, $CURLOPT_SSL_VERIFYPEER, 0)
	curl_easy_setopt($oCurl, $CURLOPT_SSL_VERIFYHOST, 0)

	; Execute the post request
	$iRetCode = curl_easy_perform($oCurl)

	; Set return trasfer & clear output buffer global var
	Local $sReturnTransfer = $_cURL_OutputBuffer
	$_cURL_OutputBuffer = ""

	Return SetError(0, 0, $sReturnTransfer)
EndFunc

Func WriteFunc_CallBack($ptr,$nSize,$nMemb,$pStream)
	Local $vData = DllStructCreate ("byte[" & $nSize*$nMemb & "]",$ptr)
	$_cURL_OutputBuffer &= BinaryToString(DllStructGetData($vData,1))
	Return $nSize*$nMemb
EndFunc

Func PushBulletCURL($phoneNumber, $phoneCNAM)
	Local $sJson  = '{"type": "note", "title": "New House Call", "body": "Name: ' & $phoneNumber & '\nNumber: ' & $phoneCNAM & '\nTime: ' & _Now() & '"}'
	Local $iRetCode, $sServerResponse

	;ConsoleWrite("=== Json post test ===" & @LF)
	ConsoleWrite(StringFormat("PushPullet Return Code: %s - %s", $iRetCode, Curl_Easy_strerror($iRetCode)) & @LF)
	;ConsoleWrite("Data returned from server" & @LF & @LF)
	$sServerResponse = JsonPost($sJson, $iRetCode)
	;ConsoleWrite($sServerResponse & @LF)
EndFunc

Func OnAutoItExit()
    UDPCloseSocket($socket)
    UDPShutdown()
EndFunc

; Custom error handler
Func ErrFunc()
   $HexNumber=hex($oError.number,8)
   ConsoleWrite(@CRLF &"COM Error!" & @CRLF & _
                "Error Number: " & $HexNumber & @CRLF & _
                "Error Description: " & $oError.windescription & @CRLF & @CRLF)
   SetError(1) ; something to check for when this function returns
Endfunc