XML DOM wrapper (COM)

SUBMITTED BY: Guest

DATE: May 30, 2013, 7:56 a.m.

FORMAT: Text only

SIZE: 80.3 kB

Raw Download

HITS: 1030

Report
  1. #include-once
  2. ; =======================================================================
  3. ; Project Manager 3.0 Preprocessed - Date 25:04:2007 Time 14:28
  4. ; =======================================================================
  5. ; ------------------------------------------------------------------------------
  6. ;
  7. ; AutoIt Version: 3.0
  8. ; Language: English
  9. ; Description: Functions that assist with using xml files
  10. ; Stephen Podhajecki <gehossafats@netmdc.com>
  11. ; Dec 15, 2005, Update Jan10,2006, Update Feb 5,8,14-15, 2006
  12. ; Feb 24, 2006 Updated _XMLCreateCDATA, code cleaned up Gary Frost (custompcs@charter.net)
  13. ; Feb 24, 2006 bug fix in re-init COM error handler, rewrote _XMLCreateChildNodeWAttr()
  14. ; Jun 20, 2006 Added count to index[0] of the _XMLGetValue return value
  15. ; Jun 26, 2006 Changed _XMLCreateFile to include option flag for UTF-8 encoding
  16. ; Jun 29, 2006 Added count to index[0] of the _XMLGetValue return
  17. ; Changed _XMLFileOpen and _XMLFileCreate
  18. ; Mar 30, 2007 Rewrote _AddFormat function to break up tags( no indentation)
  19. ; Added _XMLTransform() which runs the document against a xsl(t) style sheet for indentation.
  20. ; Changed _XMLCreateRootChildWAttr() to use new formatting
  21. ; Changed _XMLChreateChildNode() to use new formatting
  22. ; Apr 02, 2007 Added _XMLReplaceChild()
  23. ; Apr 03, 2007 Changed other node creating function to use new formatting
  24. ; Changed _XMLFileOpen() _XMLFileCreate to take an optional version number of MSXML to use.
  25. ; Changed _XMLFileOpen() _XMLFileCreate find latest MSXML version logic.
  26. ; Apr 24, 2007 Fixed _XMLCreateChileNodeWAttr() - Instead of removal, It points to the function that replaced it.
  27. ; Apr 25, 2007 Added _XMLCreateAttrib()
  28. ; Fixed bug with _XMLCreateRootNodeWAttr , _XMLCreateChild[Node]WAttr() where an extra node with same name was added.
  29. ; Stripped extrenous comments.
  30. ; Removed dependency on Array.au3 (I added the func from Array.au3 and renamed it to avoid conflicts.)
  31. ; May 03, 2007 Changed method of msxml version lookup. Updated api call tips.
  32. ; May 11, 2007 Fixed missing \
  33. ; Jun 08, 2007 Fixed Namespace issue with _XMLCreateChildNode() and _XMLCreateChildNodeWAttr()
  34. ; Jun 12, 2007 Added workaround for MSXML6 to parse file with DTD's
  35. ; Jun 13, 2007 Fixed bug in _XMLGetField() where all text was returned in one node.
  36. ; Actually this is not a bug, because it is the way that WC3 says it will be returned
  37. ; However, it will now return in a way that is expected.
  38. ; _XMLGetValue now returns just the text associated with the node or empty string.
  39. ; Jul 20, 2007 Fixed bug where failure to open the xml file would return an empty xml object, it now returns 0(no object).
  40. ; Added object check to all applicable functions.
  41. ; Aug 08, 2007 Add a _XMLSetAutoSave() to turn off/on forced saving within each function. --Thanks drlava
  42. ; Added check for previous COM error handler. --Thanks Lukasz Suleja
  43. ; Aug 27,2007 Changed property setting order for _XMLFileOpen. The previous order was causing a problem with default namespaces.
  44. ; -- It seems that "selectionLanguage" needs to be declared before some other properties.
  45. ; Aug 31,2007 Fixed bug where _XMLUpdateField would inadvertantly erase child nodes.
  46. ; Sep 07,2007 Fixed _XMLDeleteNode bug where non-existant node cause COM error.
  47. ; Added _XMLNodeExist function to check for the existence of node or nodes matching the specified path
  48. ; Jan 05,2008 Fixed documentation problem in function header with _XMLGetAttrib.
  49. ; Feb 25,2008 Fixed dimensioning bug in _XMLGetChildren --Thanks oblique
  50. ; Mar 05,2008 Return values fixed for the following functions: --Thanks oblique
  51. ; _XMLFileOpen ,_XMLLoadXML,_XMLCreateFile,
  52. ; Documentation fixed for _XMLGetNodeCount,_XMLGetChildren --Thanks oblique
  53. ; Mar 07,2008 Small changes.
  54. ; Fixed an issue point out by lgr.
  55. ; ------------------------------------------------------------------------------
  56. ;===============================================================================
  57. ; XML DOM Wrapper functions
  58. ;
  59. ; These funtions require BETA as they need support for COM
  60. ;
  61. ;===============================================================================
  62. #cs defs to add to au3.api
  63. _XMLCreateFile($sPath, $sRootNode, [$bOverwrite = False]) Creates an XML file with the given name and root.(Requires: #include <_XMLDomWrapper.au3>)
  64. _XMLFileOpen($sXMLFile,[$sNamespace=""],[$ver=-1]) Creates an instance of an XML file.(Requires: #include <_XMLDomWrapper.au3>)
  65. ;==============================================================================
  66. _XMLGetChildNodes ( strXPath ) Selects XML child Node(s) of an element based on XPath input from root node. (Requires: #include <_XMLDomWrapper.au3>)
  67. _XMLGetNodeCount ( strXPath, strQry = "", iNodeType = 1 ) Get node count for specified path and type. (Requires: #include <_XMLDomWrapper.au3>)
  68. _XMLGetPath ( strXPath ) Returns a nodes full path based on XPath input from root node. (Requires: #include <_XMLDomWrapper.au3>)
  69. ;==============================================================================
  70. _XMLSelectNodes ( strXPath ) Selects XML Node(s) based on XPath input from root node. (Requires: #include <_XMLDomWrapper.au3>)
  71. _XMLGetField ( strXPath ) Get XML Field(s) based on XPath input from root node.(Requires: #include <_XMLDomWrapper.au3>)
  72. _XMLGetValue ( strXPath ) Get XML Field based on XPath input from root node. (Requires: #include <_XMLDomWrapper.au3>)
  73. _XMLGetChildText ( strXPath ) Selects XML child Node(s) of an element based on XPath input from root node. (Requires: #include <_XMLDomWrapper.au3>)
  74. _XMLUpdateField ( strXPath, strData ) Update existing node(s) based on XPath specs.(Requires: #include <_XMLDomWrapper.au3>)
  75. _XMLReplaceChild ( objOldNode, objNewNode, ns = "" ) Replaces a node with a new node. (Requires: #include <_XMLDomWrapper.au3>)
  76. ;==============================================================================
  77. _XMLDeleteNode ( strXPath ) Delete specified XPath node.(Requires: #include <_XMLDomWrapper.au3>)
  78. _XMLDeleteAttr ( strXPath, strAttrib ) Delete attribute for specified XPath(Requires: #include <_XMLDomWrapper.au3>)
  79. _XMLDeleteAttrNode ( strXPath, strAttrib ) Delete attribute node for specified XPath(Requires: #include <_XMLDomWrapper.au3>)
  80. ;==============================================================================
  81. _XMLGetAttrib ( strXPath, strAttrib, strQuery = "" ) Get XML attribute based on XPath input from root node.(Requires: #include <_XMLDomWrapper.au3>)
  82. _XMLGetAllAttrib ( strXPath, ByRef aName, ByRef aValue, strQry = "" ) Get all XML Field(s) attributes based on XPath input from root node.(Requires: #include <_XMLDomWrapper.au3>)
  83. _XMLGetAllAttribIndex ( strXPath, ByRef aName, ByRef aValue, strQry = "", NodeIndex = 0 ) Get all XML Field(s) attributes based on Xpathn and specific index.(Requires: #include <_XMLDomWrapper.au3>)
  84. _XMLSetAttrib ( strXPath, strAttrib, strValue = "" ) Set XML Field(s) attributes based on XPath input from root node.(Requires: #include <_XMLDomWrapper.au3>)
  85. ;==============================================================================
  86. _XMLCreateCDATA ( strNode, strCDATA, strNameSpc = "" ) Create a CDATA SECTION node directly under root. (Requires: #include <_XMLDomWrapper.au3>)
  87. _XMLCreateComment ( strNode, strComment ) Create a COMMENT node at specified path.(Requires: #include <_XMLDomWrapper.au3>)
  88. _XMLCreateAttrib ( strXPath,strAttrName,strAttrValue="" ) Creates an attribute for the specified node. (Requires: #include <_XMLDomWrapper.au3>)
  89. ;==============================================================================
  90. _XMLCreateRootChild ( strNode, strData = "", strNameSpc = "" ) Create node directly under root.(Requires: #include <_XMLDomWrapper.au3>)
  91. _XMLCreateRootNodeWAttr ( strNode, aAttr, aVal, strData = "", strNameSpc = "" ) Create a child node under root node with attributes.(Requires: #include <_XMLDomWrapper.au3>)
  92. _XMLCreateChildNode ( strXPath, strNode, strData = "", strNameSpc = "" ) Create a child node under the specified XPath Node.(Requires: #include <_XMLDomWrapper.au3>)
  93. _XMLCreateChildWAttr ( strXPath, strNode, aAttr, aVal, strData = "", strNameSpc = "" ) Create a child node under the specified XPath Node with Attributes. (Requires: #include <_XMLDomWrapper.au3>)
  94. ;==============================================================================
  95. _XMLSchemaValidate ( sXMLFile, ns, sXSDFile ) _XMLSchemaValidate($sXMLFile, $ns, $sXSDFile) Validate a document against a DTD. (Requires: #include <_XMLDomWrapper.au3>)
  96. _XMLGetDomVersion ( ) Returns the XSXML version currently in use. (Requires: #include <_XMLDomWrapper.au3>)
  97. _XMLError ( sError = "" ) Sets or Gets XML error message generated by XML functions.(Requires: #include <_XMLDomWrapper.au3>)
  98. _XMLUDFVersion ( ) eturns the UDF Version number. (Requires: #include <_XMLDomWrapper.au3>)
  99. _XMLTransform ( oXMLDoc, Style = "",szNewDoc="" ) Transfroms the document using built-in sheet or xsl file passed to function. (Requires: #include <_XMLDomWrapper.au3>)
  100. _XMLNodeExists( $strXPath) Checks for the existence of the specified path. (Requires: #include <_XMLDomWrapper.au3>)
  101. #ce
  102. ;===============================================================================
  103. ;Global variables
  104. Global Const $_XMLUDFVER = "1.0.3.87"
  105. Global Const $NODE_ELEMENT = 1
  106. Global Const $NODE_ATTRIBUTE = 2
  107. Global Const $NODE_TEXT = 3
  108. Global Const $NODE_CDATA_SECTION = 4
  109. Global Const $NODE_ENTITY_REFERENCE = 5
  110. Global Const $NODE_ENTITY = 6
  111. Global Const $NODE_PROCESSING_INSTRUCTION = 7
  112. Global Const $NODE_COMMENT = 8
  113. Global Const $NODE_DOCUMENT = 9
  114. Global Const $NODE_DOCUMENT_TYPE = 10
  115. Global Const $NODE_DOCUMENT_FRAGMENT = 11
  116. Global Const $NODE_NOTATION = 12
  117. Global $strFile
  118. Global $objDoc
  119. Global $oXMLMyError ;COM error handler OBJ ; Initialize SvenP 's error handler
  120. Global $sXML_error
  121. Global $debugging
  122. Global $DOMVERSION = -1
  123. Global $bXMLAUTOSAVE = True
  124. ;===============================================================================
  125. ;UDF functions
  126. ;===============================================================================
  127. ; Function Name: _XMLFileOpen
  128. ; Description: Creates an instance of an XML file.
  129. ; Parameter(s): $strXMLFile - the XML file to open
  130. ; $strNameSpc - the namespace to specifiy if the file uses one.
  131. ; $iVer - specifically try to use the version supplied here.
  132. ; $bValOnParse - validate the document as it is being parsed
  133. ; Syntax: _XMLFileOpen($strXMLFile, [$strNameSpc], [$iVer], [$bValOnParse] )
  134. ; Return Value(s): On Success - 1
  135. ; On Failure - -1 and set
  136. ; @Error to:
  137. ; 0 - No error
  138. ; 1 - Parse error, @Extended = MSXML reason
  139. ; 2 - No object
  140. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  141. ;===============================================================================
  142. Func _XMLFileOpen($strXMLFile, $strNameSpc = "", $iVer = -1, $bValOnParse = True)
  143. ;==== pick your poison
  144. If $iVer <> -1 Then
  145. If $iVer > -1 And $iVer < 7 Then
  146. $objDoc = ObjCreate("Msxml2.DOMDocument." & $iVer & ".0")
  147. If IsObj($objDoc) Then
  148. $DOMVERSION = $iVer
  149. EndIf
  150. Else
  151. MsgBox(266288, "Error:", "Failed to create object with MSXML version " & $iVer)
  152. SetError(1)
  153. Return 0
  154. EndIf
  155. Else
  156. For $x = 8 To 0 Step - 1
  157. If FileExists(@SystemDir & "\msxml" & $x & ".dll") Then
  158. $objDoc = ObjCreate("Msxml2.DOMDocument." & $x & ".0")
  159. If IsObj($objDoc) Then
  160. $DOMVERSION = $x
  161. ExitLoop
  162. EndIf
  163. EndIf
  164. Next
  165. EndIf
  166. If Not IsObj($objDoc) Then
  167. _XMLError("Error: MSXML not found. This object is required to use this program.")
  168. SetError(2)
  169. Return -1
  170. EndIf
  171. ;Thanks Lukasz Suleja
  172. $oXMLMyError = ObjEvent("AutoIt.Error")
  173. If $oXMLMyError = "" Then
  174. $oXMLMyError = ObjEvent("AutoIt.Error", "_XMLCOMEerr") ; ; Initialize SvenP 's error handler
  175. EndIf
  176. $strFile = $strXMLFile
  177. $objDoc.async = False
  178. $objDoc.preserveWhiteSpace = True
  179. $objDoc.validateOnParse = $bValOnParse
  180. if $DOMVERSION > 4 Then $objDoc.setProperty ("ProhibitDTD",false)
  181. $objDoc.Load ($strFile)
  182. $objDoc.setProperty ("SelectionLanguage", "XPath")
  183. $objDoc.setProperty ("SelectionNamespaces", $strNameSpc)
  184. if $objDoc.parseError.errorCode >0 Then consoleWrite($objDoc.parseError.reason&@LF)
  185. If $objDoc.parseError.errorCode <> 0 Then
  186. _XMLError("Error opening specified file: " & $strXMLFile & @CRLF & $objDoc.parseError.reason)
  187. ;Tom Hohmann 2008/02/29
  188. SetError(1,$objDoc.parseError.errorCode,-1)
  189. $objDoc = 0
  190. Return -1
  191. EndIf
  192. ;Tom Hohmann 2008/02/29
  193. Return 1
  194. EndFunc ;==>_XMLFileOpen
  195. ;===============================================================================
  196. ; Function Name: _XMLLoadXML
  197. ; Description: Creates an instance for a string of XML .
  198. ; Parameters: $strXML - The XML to load into the document
  199. ; Syntax: _XMLLoadXML($strXML)
  200. ; Return Value(s): On Success - 1
  201. ; On Failure - -1 and set @error to
  202. ; 1 - failed to create object, @Extended = MSXML reason
  203. ; 2 - no object found (MSXML required for _XML functions
  204. ;
  205. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>,Lukasz Suleja,Tom Hohmann
  206. ;===============================================================================
  207. Func _XMLLoadXML($strXML,$strNameSpc="", $iVer = -1, $bValOnParse = True)
  208. If $iVer <> -1 Then
  209. If $iVer > -1 And $iVer < 7 Then
  210. $objDoc = ObjCreate("Msxml2.DOMDocument." & $iVer & ".0")
  211. If IsObj($objDoc) Then
  212. $DOMVERSION = $iVer
  213. EndIf
  214. Else
  215. MsgBox(266288, "Error:", "Failed to create object with MSXML version " & $iVer)
  216. SetError(1)
  217. Return 0
  218. EndIf
  219. Else
  220. For $x = 8 To 0 Step - 1
  221. If FileExists(@SystemDir & "\msxml" & $x & ".dll") Then
  222. $objDoc = ObjCreate("Msxml2.DOMDocument." & $x & ".0")
  223. If IsObj($objDoc) Then
  224. $DOMVERSION = $x
  225. ExitLoop
  226. EndIf
  227. EndIf
  228. Next
  229. EndIf
  230. If Not IsObj($objDoc) Then
  231. _XMLError("Error: MSXML not found. This object is required to use this program.")
  232. SetError(2)
  233. Return -1
  234. EndIf
  235. ;Thanks Lukasz Suleja
  236. $oXMLMyError = ObjEvent("AutoIt.Error")
  237. If $oXMLMyError = "" Then
  238. $oXMLMyError = ObjEvent("AutoIt.Error", "_XMLCOMEerr") ; ; Initialize SvenP 's error handler
  239. EndIf
  240. $objDoc.async = False
  241. $objDoc.preserveWhiteSpace = True
  242. $objDoc.validateOnParse = $bValOnParse
  243. if $DOMVERSION > 4 Then $objDoc.setProperty ("ProhibitDTD",false)
  244. $objDoc.LoadXml ($strXML)
  245. $objDoc.setProperty ("SelectionLanguage", "XPath")
  246. $objDoc.setProperty ("SelectionNamespaces", $strNameSpc); "xmlns:ms='urn:schemas-microsoft-com:xslt'"
  247. If $objDoc.parseError.errorCode <> 0 Then
  248. _XMLError("Error loading the XML data: " & @CRLF & $objDoc.parseError.reason)
  249. ;Tom Hohmann 2008/02/29
  250. SetError(1,$objDoc.parseError.errorCode, -1)
  251. Return -1
  252. EndIf
  253. ;Tom Hohmann 2008/02/29
  254. Return 1
  255. EndFunc ;==>_MSXMLLoadXML
  257. ;===============================================================================
  258. ; Function Name: _XMLCreateFile
  259. ; Description: Create a new blank metafile with header.
  260. ; Parameter(s): $strPath - The xml filename with full path to create
  261. ; $strRoot - The root of the xml file to create
  262. ; $bOverwrite - boolean flag to auto overwrite existing file of same name.
  263. ; $bUTF8 - boolean flag to specify UTF-8 encoding in header.
  264. ; Syntax: _XMLCreateFile($strPath,$strRoot,[$bOverwrite],[$bUTF8])
  265. ; Return Value(s): On Success - 1
  266. ; On Failure - -1 and sets
  267. ; @Error to:
  268. ; 0 = No error
  269. ; 1 = Failed to create file
  270. ; 2 = No object
  271. ; 3 = File creation failed MSXML error
  272. ; 4 = File exists
  273. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  274. ;===============================================================================
  275. Func _XMLCreateFile($strPath, $strRoot, $bOverwrite = False, $bUTF8 = False, $ver = -1)
  276. Local $retval, $fe, $objPI, $objDoc, $rootElement
  277. $fe = FileExists($strPath)
  278. If $fe And Not $bOverwrite Then
  279. $retval = (MsgBox(4097, "File Exists:", "The specified file exits." & @CRLF & "Click OK to overwrite file or cancel to exit."))
  280. If $retval = 1 Then
  281. FileCopy($strPath, $strPath & @YEAR & "-" & @MON & "-" & @MDAY & "_" & @HOUR & "-" & @MIN & "-" & @SEC & ".bak", 1)
  282. FileDelete($strPath)
  283. $fe = False
  284. Else
  285. _XMLError("Error failed to create file: " & $strPath & @CRLF & "File exists.")
  286. SetError(4)
  287. Return -1
  288. EndIf
  289. Else
  290. FileCopy($strPath, $strPath & ".old", 1)
  291. FileDelete($strPath)
  292. $fe = False
  293. EndIf
  294. If $fe = False Then
  295. If $ver <> -1 Then
  296. If $ver > -1 And $ver < 7 Then
  297. $objDoc = ObjCreate("Msxml2.DOMDocument." & $ver & ".0")
  298. If IsObj($objDoc) Then
  299. $DOMVERSION = $ver
  300. EndIf
  301. Else
  302. MsgBox(266288, "Error:", "Failed to create object with MSXML version " & $ver)
  303. SetError(3)
  304. Return 0
  305. EndIf
  306. Else
  307. For $x = 8 To 0 Step - 1
  308. If FileExists(@SystemDir & "\msxml" & $x & ".dll") Then
  309. $objDoc = ObjCreate("Msxml2.DOMDocument." & $x & ".0")
  310. If IsObj($objDoc) Then
  311. $DOMVERSION = $x
  312. ExitLoop
  313. EndIf
  314. EndIf
  315. Next
  316. EndIf
  317. If Not IsObj($objDoc) Then
  318. Return SetError(2)
  319. EndIf
  320. If $bUTF8 Then
  321. $objPI = $objDoc.createProcessingInstruction ("xml", "version=""1.0"" encoding=""UTF-8""")
  322. Else
  323. $objPI = $objDoc.createProcessingInstruction ("xml", "version=""1.0""")
  324. EndIf
  325. $objDoc.appendChild ($objPI)
  326. $rootElement = $objDoc.createElement ($strRoot)
  327. $objDoc.documentElement = $rootElement
  328. $objDoc.save ($strPath)
  329. If $objDoc.parseError.errorCode <> 0 Then
  330. _XMLError("Error Creating specified file: " & $strPath)
  331. ; Tom Hohmann 2008/02/29
  332. SetError(1, $objDoc.parseError.errorCode, -1)
  333. Return -1
  334. EndIf
  335. Return 1
  336. Else
  337. _XMLError("Error! Failed to create file: " & $strPath)
  338. SetError(1)
  339. Return 0
  340. EndIf
  341. Return 1
  342. EndFunc ;==>_XMLCreateFile
  343. ;===============================================================================
  344. ; Function Name: _XMLSelectNodes
  345. ; Description: Selects XML Node(s) based on XPath input from root node.
  346. ; Parameter(s): $strXPath - xml tree path from root node (root/child/child..)
  347. ; Syntax: _XMLSelectNode($strXPath)
  348. ; Return Value(s): On Success - An array of Nodes(count is in first element)
  349. ; On Failure - -1 and set @Error = 1
  350. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  351. ;===============================================================================
  352. Func _XMLSelectNodes($strXPath)
  353. If not IsObj($objDoc) then
  354. _XMLError("No object passed to function _XMLSelectNodes")
  355. Return SetError(2,0,-1)
  356. EndIf
  357. Local $objNode, $objNodeList, $arrResponse[1], $xmlerr
  358. $objNodeList = $objDoc.selectNodes ($strXPath)
  359. If Not IsObj($objNodeList) Then
  360. _XMLError("\nNo matching nodes found")
  361. Return SetError(1,0,-1)
  362. EndIf
  363. If $objNodeList.length < 1 Then
  364. _XMLError("\nNo matching nodes found")
  365. Return SetError(1,0,-1)
  366. EndIf
  367. For $objNode In $objNodeList
  368. _XMLArrayAdd($arrResponse, $objNode.nodeName)
  369. _DebugWrite($objNode.nodeName)
  370. _DebugWrite($objNode.namespaceURI)
  371. Next
  372. $arrResponse[0] = $objNodeList.length
  373. Return $arrResponse
  374. _XMLError("Error Selecting Node(s): " & $strXPath & $xmlerr)
  375. Return SetError(1,0,-1)
  376. EndFunc ;==>_XMLSelectNodes
  378. ;===============================================================================
  379. ; Function Name: _XMLGetField
  380. ; Description: Get XML Field(s) based on XPath input from root node.
  381. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  382. ; Syntax: _XMLGetField($path)
  383. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  384. ; Return Value(s): On Success An array of fields text values(count is in first element)
  385. ; On Failure -1 set @Error = 1
  386. ;===============================================================================
  387. Func _XMLGetField($strXPath)
  388. If not IsObj($objDoc) then
  389. _XMLError("No object passed to function _XMLGetField")
  390. Return SetError(1,2,-1)
  391. EndIf
  392. Local $objNodeList, $arrResponse[1], $xmlerr, $szNodePath
  393. $objNodeList = $objDoc.selectSingleNode ($strXPath)
  394. If Not IsObj($objNodeList) Then
  395. _XMLError("\nNo Matching Nodes found")
  396. $arrResponse[0] = 0
  397. Return SetError(2,0,-1)
  398. EndIf
  399. If $objNodeList.hasChildNodes () Then
  400. Local $count = $objNodeList.childNodes.length
  401. For $x =1 to $count
  402. $objChild = $objNodeList.childNodes($x)
  403. _DebugWrite("ParentNode="&$objNodeList.parentNode.nodeType)
  404. If $objNodeList.parentNode.nodeType =$NODE_DOCUMENT Then
  405. $szNodePath="/"&$objNodeList.baseName &"/*["&$x&"]"
  406. Else
  407. $szNodePath = $objNodeList.baseName &"/*["&$x&"]"
  408. EndIf
  410. $aRet = _XMLGetValue($szNodePath)
  411. If IsArray($aRet) Then
  412. If UBound($aRet) > 1 Then
  413. _XMLArrayAdd($arrResponse, $aRet[1])
  414. _DebugWrite("GetField>Text:" & $aRet[1])
  415. EndIf
  416. Else
  417. _XMLArrayAdd($arrResponse, "")
  418. _DebugWrite("GetField>Text:" & "")
  419. EndIf
  420. Next
  421. $arrResponse[0] = UBound($arrResponse) - 1
  422. Return $arrResponse
  423. Else
  424. $arrResponse[0] = 0
  425. _XMLError("\nNo Child Nodes found")
  426. Return SetError(1,0,-1)
  427. EndIf
  428. _XMLError("Error Selecting Node(s): " & $strXPath & $xmlerr)
  429. Return SetError(1,0,-1)
  430. EndFunc ;==>_XMLGetField
  431. ;===============================================================================
  432. ; Function Name: _XMLGetValue
  433. ; Description: Get XML values based on XPath input from root node.
  434. ; Parameter(s): $strXPath - xml tree path from root node (root/child/child..)
  435. ; Syntax: _XMLGetValue($strXPath)
  436. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  437. ; Return Value(s): On Success An array of fields text values(count is in first element)
  438. ; On Failure -1 set
  439. ; @Error = 1
  440. ; @Extended to:
  441. ; 0 = No matching node
  442. ; 1 = No object passed
  443. ;===============================================================================
  444. Func _XMLGetValue($strXPath)
  445. If not IsObj($objDoc) then
  446. _XMLError("No object passed to function _XMLGetValue")
  447. Return SetError(1,1,-1)
  448. EndIf
  449. Local $objNodeList, $arrResponse[1], $objNodeChild, $xmlerr
  450. _DebugWrite("GetValue>$strXPath:"&$strXPath)
  451. $objNodeList = $objDoc.documentElement.selectNodes ($strXPath)
  452. If $objNodeList.length > 0 Then
  453. _DebugWrite("GetValue list length:" & $objNodeList.length)
  454. For $objNode In $objNodeList
  455. If $objNode.hasChildNodes () = False Then
  456. _XMLArrayAdd($arrResponse, $objNode.nodeValue)
  457. Else
  458. For $objNodeChild In $objNode.childNodes ()
  459. If $objNodeChild.nodeType = $NODE_CDATA_SECTION Then
  460. _XMLArrayAdd($arrResponse, $objNodeChild.data)
  461. _DebugWrite("GetValue>CData:" & $objNodeChild.data)
  462. ElseIf $objNodeChild.nodeType = $NODE_TEXT Then
  463. _XMLArrayAdd($arrResponse, $objNodeChild.Text)
  464. _DebugWrite("GetValue>Text:" & $objNodeChild.Text)
  465. EndIf
  466. Next
  467. EndIf
  468. Next
  469. $arrResponse[0] = UBound($arrResponse) - 1
  470. Return $arrResponse
  471. Else
  472. $xmlerr = @CRLF & "No matching node(s)found!"
  473. Return SetError(1,0,-1)
  474. EndIf
  475. _XMLError("Error Retrieving: " & $strXPath & $xmlerr)
  477. Return SetError(1,0, -1)
  478. EndFunc ;==>_XMLGetValue
  479. ;===============================================================================
  480. ; Function Name: _XMLDeleteNode
  481. ; Description: Deletes XML Node based on XPath input from root node.
  482. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  483. ; Syntax: _XMLDeleteNode($path)
  484. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  485. ; Return Value(s): On Success 1
  486. ; On Failure -1 and Sets
  487. ; @Error to:
  488. ; 0 = No error
  489. ; 1 = Deletion error
  490. ; 2 = No object passed
  491. ;===============================================================================
  492. Func _XMLDeleteNode($strXPath)
  493. If not IsObj($objDoc) then
  494. _XMLError("No object passed to function _XMLDeleteNode")
  495. Return SetError(2,0,-1)
  496. EndIf
  497. Local $objNode, $xmlerr
  498. $objNode = $objDoc.selectNodes ($strXPath)
  499. If Not IsObj($objNode) Then $xmlerr = @CRLF & "Node Not found"
  500. if @error = 0 Then
  501. For $objChild in $objNode
  502. ConsoleWrite("Delete node " & $objChild.nodeName & @LF)
  503. $objChild.parentNode.removeChild ($objChild)
  504. Next
  505. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  506. Return 1
  507. EndIf
  508. _XMLError("Error Deleting Node: " & $strXPath & $xmlerr)
  509. Return SetError(1,0,-1)
  510. EndFunc ;==>_XMLDeleteNode
  512. ;===============================================================================
  513. ; Function Name: _XMLDeleteAttr
  514. ; Description: Delete XML Attribute based on XPath input from root node.
  515. ; Parameter(s): $strXPath xml tree path from root node (root/child/child..)
  516. ; $strAttribute The attribute node to delete
  517. ; Syntax: _XMLDeleteAttr($strPath,$strAttribute)
  518. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  519. ; Return Value(s): On Success 1
  520. ; On Failure -1 and sets
  521. ; @Error to:
  522. ; 0 = No error
  523. ; 1 = Error removing attribute
  524. ; 2 = No object
  525. ;===============================================================================
  526. Func _XMLDeleteAttr($strXPath, $strAttrib)
  527. If not IsObj($objDoc) then
  528. _XMLError("No object passed to function _XMLDeleteAttr")
  529. Return SetError(2,0,-1)
  530. EndIf
  531. Local $objNode, $objAttr, $xmlerr
  532. $objNode = $objDoc.selectSingleNode ($strXPath)
  533. If IsObj($objNode) Then
  534. $objAttr = $objNode.getAttributeNode ($strAttrib)
  535. If Not (IsObj($objAttr)) Then
  536. _XMLError("Attribute " & $strAttrib & " does not exist!")
  537. Return SetError(2,0,-1)
  538. EndIf
  539. $objAttr = $objNode.removeAttribute ($strAttrib)
  540. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  541. Return 1
  542. EndIf
  543. _XMLError("Error Removing Attribute: " & $strXPath & " - " & $strAttrib & @CRLF & $xmlerr)
  544. $xmlerr = ""
  545. Return SetError(1,0,-1)
  546. EndFunc ;==>_XMLDeleteAttr
  547. ;===============================================================================
  548. ; Function Name: _XMLDeleteAttrNode
  549. ; Description: Delete XML Attribute node based on XPath input from root node.
  550. ; Parameter(s): $strXpath xml tree path from root node (root/child/child..)
  551. ; $strAttribute The attribute node to delete
  552. ; Syntax: _XMLDeleteAttrNode($strXPath,$strAttribute)
  553. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  554. ; Return Value(s): On Success 1
  555. ; On Failure -1 and sets
  556. ; @Error to:
  557. ; 0 = No error
  558. ; 1 = Error removing node
  559. ; 2 = No object
  560. ;===============================================================================
  561. Func _XMLDeleteAttrNode($strXPath, $strAttrib)
  562. If not IsObj($objDoc) then
  563. _XMLError("No object passed to function _XMLDeleteAttrNode")
  564. Return SetError(2,0,-1)
  565. EndIf
  566. Local $objNode, $objAttr, $xmlerr
  567. $objNode = $objDoc.selectSingleNode ($strXPath)
  568. If Not IsObj($objNode) Then
  569. _XMLError("\nSpecified node not found!")
  570. Return SetError(2,0,-1)
  571. EndIf
  572. $objAttr = $objNode.removeAttributeNode ($objNode.getAttributeNode ($strAttrib))
  573. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  574. If Not (IsObj($objAttr)) Then
  575. _XMLError("\nUnspecified error:!")
  576. Return SetError(1,0,-1)
  577. EndIf
  578. Return 1
  579. EndFunc ;==>_XMLDeleteAttrNode
  580. ;===============================================================================
  581. ; Function Name: _XMLGetAttrib
  582. ; Description: Get XML Field based on XPath input from root node.
  583. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  584. ; Syntax: _XMLGetAttrib($path,$attrib)
  585. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  586. ; Return Value(s): On Success The attribute value.
  587. ; On Failure -1 and sets
  588. ; @Error to:
  589. ; 0 = No error
  590. ; 1 = Attribute not found.
  591. ; 2 = No object
  592. ;===============================================================================
  593. Func _XMLGetAttrib($strXPath, $strAttrib, $strQuery = "")
  594. If not IsObj($objDoc) then
  595. _XMLError("No object passed to function _XMLGetAttrib")
  596. Return SetError(2,0,-1)
  597. EndIf
  598. ;Local $objNodeList, $arrResponse[1], $i, $xmlerr, $objAttr
  599. Local $objNodeList, $arrResponse, $i, $xmlerr, $objAttr
  600. $objNodeList = $objDoc.documentElement.selectNodes ($strXPath & $strQuery)
  601. _DebugWrite("Get Attrib length= " & $objNodeList.length)
  602. If $objNodeList.length > 0 Then
  603. For $i = 0 To $objNodeList.length - 1
  604. $objAttr = $objNodeList.item ($i).getAttribute ($strAttrib)
  605. $arrResponse = $objAttr
  606. _DebugWrite("RET>>" & $objAttr)
  607. Next
  608. Return $arrResponse
  609. EndIf
  610. $xmlerr = "\nNo qualified items found"
  611. _XMLError("Attribute " & $strAttrib & " not found for: " & $strXPath & $xmlerr)
  612. Return SetError(1,0,-1)
  613. EndFunc ;==>_XMLGetAttrib
  614. ;===============================================================================
  615. ; Function Name: _XMLSetAttrib
  616. ; Description: Set XML Field(s) based on XPath input from root node.
  617. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  618. ; $attrib the attribute to set.
  619. ; $value the value to give the attribute defaults to ""
  620. ; Syntax: _XMLSetAttrib($path,$attrib,$value)
  621. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  622. ; Return Value(s) array of fields text values
  623. ; on error returns -1 and sets error to 1
  624. ;===============================================================================
  625. Func _XMLSetAttrib($strXPath, $strAttrib, $strValue = "", $iIndex =-1)
  626. If not IsObj($objDoc) then
  627. _XMLError("No object passed to function _XMLSetAttrib")
  628. Return SetError(1,8,-1)
  629. EndIf
  630. Local $objNodeList, $arrResponse[1], $i
  631. $objNodeList = $objDoc.selectNodes ($strXPath)
  632. _DebugWrite(" Node list Length: " & $objNodeList.length)
  633. If @error = 0 And $objNodeList.length > 0 Then
  634. If $iIndex > 0 Then
  635. $arrResponse[0] = $objNodeList.item ($iIndex).SetAttribute ($strAttrib, $strValue)
  636. Else
  637. ReDim $arrResponse[$objNodeList.length]
  638. For $i = 0 To $objNodeList.length - 1
  639. $arrResponse[$i] = $objNodeList.item ($i).SetAttribute ($strAttrib, $strValue)
  640. If $objDoc.parseError.errorCode <> 0 Then ExitLoop
  641. Next
  642. EndIf
  643. If $objDoc.parseError.errorCode <> 0 Then
  644. _XMLError("Error setting attribute for: " & $strXPath & @CRLF & $objDoc.parseError.reason)
  645. Return SetError(1,$objDoc.parseError.errorCode,-1)
  646. EndIf
  647. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  648. Return $arrResponse
  649. EndIf
  650. _XMLError("Error failed to set attribute for: " & $strXPath & @CRLF)
  651. SetError(1)
  652. Return -1
  653. EndFunc ;==>_XMLSetAttrib
  654. ;===============================================================================
  655. ; Function Name: _XMLGetAllAttrib
  656. ; Description: Get all XML Field(s) attributes based on XPath input from root node.
  657. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  658. ; $query the query string in xml format
  659. ; $names the array to return the attrib names
  660. ; $value the array to return the attrib values
  661. ; [$query] DOM compliant query string (not really necessary as it becomes
  662. ;part of the path
  663. ; Syntax: _XMLGetAllAttrib($path,$query)
  664. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  665. ; Return Value(s) array of fields text values(number of items is in [0][0]
  666. ; on error set error to 1 and returns -1
  667. ;===============================================================================
  668. Func _XMLGetAllAttrib($strXPath, ByRef $aName, ByRef $aValue, $strQry = "")
  669. If not IsObj($objDoc) then
  670. _XMLError("No object passed to function _XMLGetAllAttrib")
  671. Return SetError(1,9,-1)
  672. EndIf
  673. Local $objNodeList, $objQueryNodes, $objNode, $arrResponse[2][1], $i
  674. $objQueryNodes = $objDoc.selectNodes ($strXPath & $strQry)
  675. If $objQueryNodes.length > 0 Then
  676. For $objNode In $objQueryNodes
  677. $objNodeList = $objNode.attributes
  678. If ($objNodeList.length) Then
  679. _DebugWrite("Get all attrib " & $objNodeList.length)
  680. ReDim $arrResponse[2][$objNodeList.length + 2]
  681. ReDim $aName[$objNodeList.length]
  682. ReDim $aValue[$objNodeList.length]
  683. For $i = 0 To $objNodeList.length - 1
  684. $arrResponse[0][$i + 1] = $objNodeList.item ($i).nodeName
  685. $arrResponse[1][$i + 1] = $objNodeList.item ($i).Value
  686. $aName[$i] = $objNodeList.item ($i).nodeName
  687. $aValue[$i] = $objNodeList.item ($i).Value
  688. Next
  689. Else
  690. _XMLError("No Attributes found for node")
  691. Return SetError(1,0, -1)
  692. EndIf
  693. Next
  694. $arrResponse[0][0] = $objNodeList.length
  695. Return $arrResponse
  696. EndIf
  697. _XMLError("Error retrieving attributes for: " & $strXPath & @CRLF)
  698. return SetError(1,0 ,-1)
  699. ; EndIf
  700. EndFunc ;==>_XMLGetAllAttrib
  701. ;===============================================================================
  702. ; Function Name: _XMLUpdateField
  703. ; Description: Update existing node(s) based on XPath specs.
  704. ; Parameter(s): $path Path from root node
  705. ; $new_data Data to update node with
  706. ; Syntax: _XMLUpdateField($path,$new_data)
  707. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  708. ; Return Value(s) on error set error to 1 and returns -1
  709. ;===============================================================================
  710. Func _XMLUpdateField($strXPath, $strData)
  711. If not IsObj($objDoc) then
  712. _XMLError("No object passed to function _XMLUpdateField")
  713. Return SetError(1,9,-1)
  714. EndIf
  715. Local $objField, $bUpdate, $objNode
  716. #forceref $objField
  717. $objField = $objDoc.selectSingleNode ($strXPath)
  718. If IsObj($objField) Then
  719. If $objField.hasChildNodes Then
  720. For $objChild In $objField.childNodes ()
  721. If $objChild.nodetype = $NODE_TEXT Then
  722. $objChild.Text = $strData
  723. $bUpdate = True
  724. ExitLoop
  725. EndIf
  726. Next
  727. EndIf
  728. if $bUpdate = False Then
  729. $objNode = $objDoc.createTextNode($strData)
  730. $objField.appendChild($objNode)
  731. EndIf
  732. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  733. $objField = ""
  734. Return
  735. EndIf
  736. _XMLError("Failed to update field for: " & $strXPath & @CRLF)
  737. Return SetError(1,0,-1)
  739. EndFunc ;==>_XMLUpdateField
  740. ;===============================================================================
  741. ; Function Name: _XMLCreateCDATA
  742. ; Description: Create a CDATA SECTION node directly under root.
  743. ; Parameter(s): $node name of node to create
  744. ; $data CDATA value
  745. ; Syntax: _XMLCreateCDATA($node,$data)
  746. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  747. ; Return Value(s):on error set error to 1 and returns -1
  748. ; fixme, won't append to exisiting node. must create new node.
  749. ;===============================================================================
  750. Func _XMLCreateCDATA($strNode, $strCDATA, $strNameSpc = "")
  751. If not IsObj($objDoc) then
  752. _XMLError("No object passed to function _XMLCreateCDATA")
  753. Return SetError(1,10,-1)
  754. EndIf
  755. Local $objChild, $objNode
  756. $objNode = $objDoc.createNode ($NODE_ELEMENT, $strNode, $strNameSpc)
  757. If IsObj($objNode)Then
  758. If Not ($objNode.hasChildNodes ()) Then
  759. _AddFormat($objDoc, $objNode)
  760. EndIf
  761. $objChild = $objDoc.createCDATASection ($strCDATA)
  762. $objNode.appendChild ($objChild)
  763. $objDoc.documentElement.appendChild ($objNode)
  764. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  765. _AddFormat($objDoc)
  766. $objChild = ""
  767. Return 1
  768. EndIf
  769. _XMLError("Failed to create CDATA Section: " & $strNode & @CRLF)
  770. Return SetError(1, 0 ,-1)
  771. EndFunc ;==>_XMLCreateCDATA
  772. ;===============================================================================
  773. ; Function Name: _XMLCreateComment
  774. ; Description: Create a COMMENT node at specified path.
  775. ; Parameter(s): $node name of node to create
  776. ; $comment the comment to add the to the xml file
  777. ; Syntax: _XMLCreateComment($node,$comment)
  778. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  779. ; Return Value(s) on error set error to 1 and returns -1
  780. ;===============================================================================
  781. Func _XMLCreateComment($strNode, $strComment)
  782. If not IsObj($objDoc) then
  783. _XMLError("No object passed to function _XMLCreateComment")
  784. Return SetError(1,11,-1)
  785. EndIf
  786. Local $objChild, $objNode
  788. $objNode = $objDoc.selectSingleNode ($strNode)
  789. If IsObj($objNode) Then
  790. If Not ($objNode.hasChildNodes ()) Then
  791. _AddFormat($objDoc, $objNode)
  792. EndIf
  793. $objChild = $objDoc.createComment ($strComment)
  794. $objNode.insertBefore ($objChild, $objNode.childNodes (0))
  795. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  796. _AddFormat($objDoc)
  797. $objChild = ""
  798. Return 1
  799. EndIf
  800. _XMLError("Failed to root child: " & $strNode & @CRLF)
  801. Return SetError(1,0, -1)
  802. EndFunc ;==>_XMLCreateComment
  803. ;===============================================================================
  804. ; Function Name: _XMLCreateAttribute
  805. ; Description:
  806. ; Parameter(s): $strXPath xml tree path from root node (root/child/child..)
  807. ; $strAttrName the attribute to set.
  808. ; $strAttrValue the value to give the attribute defaults to ""
  809. ; Syntax: _XMLCreateAttrib($strXPath,$strAttrName,$strAttrValue="")
  810. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  811. ; Return Value(s) 1 on success, 0 on error
  812. ;===============================================================================
  813. Func _XMLCreateAttrib($strXPath, $strAttrName, $strAttrValue = "")
  814. If not IsObj($objDoc) then
  815. _XMLError("No object passed to function _XMLCreateAttrib")
  816. Return SetError(1,12,-1)
  817. EndIf
  818. Local $objNode, $objAttr, $objAttrVal, $err
  819. $objNode = $objDoc.selectSingleNode ($strXPath)
  820. If IsObj($objNode) Then
  821. $objAttr = $objDoc.createAttribute ($strAttrName);, $strNameSpc)
  822. $objNode.SetAttribute ($strAttrName, $strAttrValue)
  823. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  824. $objAttr = 0
  825. $objAttrVal = 0
  826. $objNode = 0
  827. $err = $objDoc.parseError.errorCode
  828. If $err = 0 Then Return 1
  829. EndIf
  830. _XMLError("Error creating Attribute: " & $strAttrName & @CRLF & $strXPath & " does not exist." & @CRLF)
  831. Return 0
  832. EndFunc ;==>_XMLCreateAttrib
  833. ;===============================================================================
  834. ; Function Name: _XMLCreateRootChild
  835. ; Description: Create node directly under root.
  836. ; Parameter(s): $node name of node to create
  837. ; $value optional value to create
  838. ; Syntax: _XMLCreateRootChild($node,[$value])
  839. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  840. ; Return Value(s) on error set error to 1 and returns -1
  841. ;===============================================================================
  842. Func _XMLCreateRootChild($strNode, $strData = "", $strNameSpc = "")
  843. If not IsObj($objDoc) then
  844. _XMLError("No object passed to function _XMLCreateRootChild")
  845. Return SetError(1,14,-1)
  846. EndIf
  847. ConsoleWrite("_XMLCreateRootChild:"&$strNode&@LF)
  848. Local $objChild
  849. If Not ($objDoc.documentElement.hasChildNodes ()) Then
  850. _AddFormat($objDoc)
  851. EndIf
  852. $objChild = $objDoc.createNode ($NODE_ELEMENT, $strNode, $strNameSpc)
  853. If IsObj($objChild) Then
  854. If $strData <> "" Then $objChild.text = $strData
  855. $objDoc.documentElement.appendChild ($objChild)
  856. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  857. _AddFormat($objDoc)
  858. $objChild = 0
  859. Return 1
  860. EndIf
  861. _XMLError("Failed to root child: " & $strNode & @CRLF)
  862. Return SetError(1,0,-1)
  863. EndFunc ;==>_XMLCreateRootChild
  864. ;===============================================================================
  865. ; Function Name: _XMLCreateRootNodeWAttr
  866. ; Description: Create a child node under root node with attributes.
  867. ; Parameter(s): $node node to add with attibute(s)
  868. ; $[array]attrib attribute name(s) -- can be array
  869. ; $[array]value attribute value(s) -- can be array
  870. ; $data optional value to give the node.
  871. ; Requirements This function requires that each attribute name has
  872. ; a corresponding value.
  873. ; Syntax: _XMLCreateRootNodeWAttr($node,$array_attribs,$array_value)
  874. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  875. ; Return Value(s) on error set error to 1 or 2 and returns -1
  876. ;===============================================================================
  877. Func _XMLCreateRootNodeWAttr($strNode, $aAttr, $aVal, $strData = "", $strNameSpc = "")
  878. If not IsObj($objDoc) then
  879. _XMLError("No object passed to function _XMLCreateRootNodeWAttr")
  880. Return SetError(1,15,-1)
  881. EndIf
  882. Local $objChild, $objAttr, $objAttrVal
  883. $objChild = $objDoc.createNode ($NODE_ELEMENT, $strNode, $strNameSpc)
  884. If IsObj($objChild) Then
  885. If $strData <> "" Then $objChild.text = $strData
  886. If Not ($objDoc.documentElement.hasChildNodes ()) Then
  887. _AddFormat($objDoc)
  888. EndIf
  889. If IsArray($aAttr) And IsArray($aVal) Then
  890. If UBound($aAttr) <> UBound($aVal) Then
  891. _XMLError("Attribute and value mismatch" & @CRLF & "Please make sure each attribute has a matching value.")
  892. SetError(2)
  893. Return -1
  894. Else
  895. Local $i
  896. For $i = 0 To UBound($aAttr) - 1
  897. If $aAttr[$i] = "" Then
  898. _XMLError("Error creating child node: " & $strNode & @CRLF & " Attribute Name Cannot be NULL." & @CRLF)
  899. Return SetError(1,0,-1)
  900. EndIf
  901. $objAttr = $objDoc.createAttribute ($aAttr[$i]);, $strNameSpc)
  902. $objChild.SetAttribute ($aAttr[$i], $aVal[$i])
  903. Next
  904. EndIf
  905. Else
  906. $objAttr = $objDoc.createAttribute ($aAttr)
  907. $objChild.SetAttribute ($aAttr, $aVal)
  908. EndIf
  909. $objDoc.documentElement.appendChild ($objChild)
  910. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  911. _AddFormat($objDoc)
  912. $objChild = 0
  913. Return 1
  914. EndIf
  915. _XMLError("Failed to create root child with attributes: " & $strNode & @CRLF)
  916. Return SetError(1,0,-1)
  917. EndFunc ;==>_XMLCreateRootNodeWAttr
  918. ;===============================================================================
  919. ; Function Name: _XMLCreateChildNode
  920. ; Description: Create a child node under the specified XPath Node.
  921. ; Parameter(s): $path Path from root
  922. ; $node Node to add
  923. ; Syntax: _XMLCreateChildNode($path,$node)
  924. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  925. ; Return Value(s) on error set error to 1 and returns -1
  926. ;===============================================================================
  927. Func _XMLCreateChildNode($strXPath, $strNode, $strData = "", $strNameSpc = "")
  928. If not IsObj($objDoc) then
  929. _XMLError("No object passed to function _XMLCreateChildNode")
  930. Return SetError(1,16,-1)
  931. EndIf
  932. Local $objParent, $objChild, $objNodeList
  933. $objNodeList = $objDoc.selectNodes ($strXPath)
  934. If IsObj($objNodeList) And $objNodeList.length > 0 Then
  935. For $objParent In $objNodeList
  936. If Not ($objParent.hasChildNodes ()) Then
  937. _AddFormat($objDoc, $objParent)
  938. EndIf
  939. If $strNameSpc = "" Then
  940. If Not ($objParent.namespaceURI = 0 Or $objParent.namespaceURI = "") Then $strNameSpc = $objParent.namespaceURI
  941. EndIf
  942. ;ConsoleWrite("$strNameSpc=" & $strNameSpc & @LF)
  943. $objChild = $objDoc.createNode ($NODE_ELEMENT, $strNode, $strNameSpc)
  944. If $strData <> "" Then $objChild.text = $strData
  945. $objParent.appendChild ($objChild)
  946. _AddFormat($objDoc, $objParent)
  947. Next
  948. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  949. $objParent = ""
  950. $objChild = ""
  951. Return 1
  952. EndIf
  953. _XMLError("Error creating child node: " & $strNode & @CRLF & $strXPath & " does not exist." & @CRLF)
  954. Return SetError(1,0,-1)
  955. EndFunc ;==>_XMLCreateChildNode
  956. ;===============================================================================
  957. ; Function Name: _XMLCreateChildNodeWAttr
  958. ; Description: Create a child node(s) under the specified XPath Node with attributes.
  959. ; Parameter(s): $sPath Path from root
  960. ; $sNode node to add with attibute(s)
  961. ; $[array]attrib attribute name(s) -- can be array
  962. ; $[array]value attribute value(s) -- can be array
  963. ; $data Optional value to give the child node.
  964. ; Requirements This function requires that each attribute name has
  965. ; a corresponding value.
  966. ; Syntax: _XMLCreateChildNodeWAttr($path,$node,$[array]attrib,$]array]value)
  967. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  968. ; Return Value(s) 0 on error and set error 1 or 2
  969. ;===============================================================================
  970. Func _XMLCreateChildNodeWAttr($strXPath, $strNode, $aAttr, $aVal, $strData = "", $strNameSpc = "")
  971. Return _XMLCreateChildWAttr($strXPath, $strNode, $aAttr, $aVal, $strData, $strNameSpc)
  972. EndFunc ;==>_XMLCreateChildNodeWAttr
  973. ;===============================================================================
  974. ; Function Name: _XMLCreateChildWAttr
  975. ; Description: Create a child node(s) under the specified XPath Node with attributes.
  976. ; Parameter(s): $sPath Path from root
  977. ; $sNode node to add with attibute(s)
  978. ; $[array]attrib attribute name(s) -- can be array
  979. ; $[array]value attribute value(s) -- can be array
  980. ; $data Optional value to give the child node.
  981. ; Requirements This function requires that each attribute name has
  982. ; a corresponding value.
  983. ; Syntax: _XMLCreateChildWAttr($path,$node,$[array]attrib,$]array]value)
  984. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  985. ; Return Value(s) 0 on error and set error 1 or 2
  986. ;===============================================================================
  987. Func _XMLCreateChildWAttr($strXPath, $strNode, $aAttr, $aVal, $strData = "", $strNameSpc = "")
  988. If not IsObj($objDoc) then
  989. _XMLError("No object passed to function _XMLCreateChildWAttr")
  990. Return SetError(1,18,-1)
  991. EndIf
  992. Local $objParent, $objChild, $objAttr, $objAttrVal, $objNodeList
  993. $objNodeList = $objDoc.selectNodes ($strXPath)
  994. _DebugWrite("Node Selected")
  995. If IsObj($objNodeList) And $objNodeList.length <> 0 Then
  996. _DebugWrite("Entering if")
  997. For $objParent In $objNodeList
  998. If Not ($objParent.hasChildNodes ()) Then
  999. _AddFormat($objDoc, $objParent)
  1000. EndIf
  1001. _DebugWrite("Entering for")
  1002. If $strNameSpc = "" Then
  1003. If Not ($objParent.namespaceURI = 0 Or $objParent.namespaceURI = "") Then $strNameSpc = $objParent.namespaceURI
  1004. EndIf
  1005. $objChild = $objDoc.createNode ($NODE_ELEMENT, $strNode, $strNameSpc)
  1006. If @error Then Return -1
  1007. If $strData <> "" Then $objChild.text = $strData
  1008. If IsArray($aAttr) And IsArray($aVal) Then
  1009. If UBound($aAttr) <> UBound($aVal) Then
  1010. _XMLError("Attribute and value mismatch" & @CRLF & "Please make sure each attribute has a matching value.")
  1011. Return SetError(2,0,-1)
  1012. Else
  1013. Local $i
  1014. For $i = 0 To UBound($aAttr) - 1
  1015. _DebugWrite("Entering inside for")
  1016. If $aAttr[$i] = "" Then
  1017. _XMLError("Error creating child node: " & $strNode & @CRLF & " Attribute Name Cannot be NULL." & @CRLF)
  1018. SetError(1)
  1019. Return -1
  1020. EndIf
  1021. _DebugWrite($aAttr[$i] & " " & $strNameSpc)
  1022. $objAttr = $objDoc.createAttribute ($aAttr[$i]);, $strNameSpc)
  1023. If @error Then ExitLoop
  1024. $objChild.SetAttribute ($aAttr[$i], $aVal[$i])
  1025. If @error <> 0 Then
  1026. _XMLError("Error creating child node: " & $strNode & @CRLF & $strXPath & " does not exist." & @CRLF)
  1027. Return SetError(1,0,-1)
  1028. EndIf
  1029. _DebugWrite("Looping inside for")
  1030. Next
  1031. EndIf
  1032. Else
  1033. If IsArray($aAttr) Or IsArray($aVal) Then
  1034. _XMLError("Type non-Array and Array detected" & @LF)
  1035. Return SetError(1,0,-1)
  1036. EndIf
  1037. If $aAttr = "" Then
  1038. _XMLError("Attribute Name cannot be empty string." & @LF)
  1039. Return SetError(5,0,-1)
  1040. EndIf
  1041. _DebugWrite($aAttr & " " & $strNameSpc)
  1042. $objAttr = $objDoc.createAttribute ($aAttr);, $strNameSpc)
  1043. $objChild.SetAttribute ($aAttr, $aVal)
  1044. EndIf
  1045. $objParent.appendChild ($objChild)
  1046. _DebugWrite("Looping for")
  1047. Next
  1048. _AddFormat($objDoc, $objParent)
  1049. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  1050. _DebugWrite("Saved")
  1051. $objParent = ""
  1052. $objChild = ""
  1053. _DebugWrite("Returning")
  1054. Return
  1055. EndIf
  1056. _XMLError("Error creating child node: " & $strNode & @CRLF & $strXPath & " does not exist." & @CRLF)
  1057. Return SetError(1,0,-1)
  1058. EndFunc ;==>_XMLCreateChildWAttr
  1059. ;===============================================================================
  1060. ; Function Name: _XMLGetChildText
  1061. ; Description: Selects XML child Node(s) of an element based on XPath input from root node.
  1062. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  1063. ; Syntax: _XMLGetChildText($path)
  1064. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1065. ; Return Value(s) array of Nodes or -1 on failure
  1066. ;===============================================================================
  1067. Func _XMLGetChildText($strXPath)
  1068. If not IsObj($objDoc) then
  1069. _XMLError("No object passed to function _XMLGetChildText")
  1070. Return SetError(1,19,-1)
  1071. EndIf
  1072. Local $objNodeList, $arrResponse[1], $xmlerr
  1073. $objNodeList = $objDoc.selectSingleNode ($strXPath)
  1074. If Not IsObj($objNodeList) Then
  1075. _XMLError(@CRLF & "No Matching Nodes found")
  1076. $arrResponse[0] = 0
  1077. Return SetError(1,0,-1)
  1078. EndIf
  1079. If $objNodeList.hasChildNodes () Then
  1080. For $objChild In $objNodeList.childNodes ()
  1081. If $objChild.nodeType = $NODE_ELEMENT Then
  1082. _XMLArrayAdd($arrResponse, $objChild.baseName)
  1083. ElseIf $objChild.nodeType = $NODE_TEXT Then
  1084. _XMLArrayAdd($arrResponse, $objChild.text)
  1085. EndIf
  1086. Next
  1087. $arrResponse[0] = UBound($arrResponse) - 1
  1088. Return $arrResponse
  1089. EndIf
  1090. $arrResponse[0] = 0
  1091. $xmlerr = @CRLF & "No Child Text Nodes found"
  1092. _XMLError("Error Selecting Node(s): " & $strXPath & $xmlerr)
  1093. Return SetError(1,0,-1)
  1094. EndFunc ;==>_XMLGetChildText
  1095. ;===============================================================================
  1096. ; Function Name: _XMLGetChildNodes
  1097. ; Description: Selects XML child Node(s) of an element based on XPath input from root node.
  1098. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  1099. ; Syntax: _XMLGetChildNodes($path)
  1100. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1101. ; Return Value(s) array of Nodes or -1 on failure
  1102. ;===============================================================================
  1103. Func _XMLGetChildNodes($strXPath)
  1104. If not IsObj($objDoc) then
  1105. _XMLError("No object passed to function _XMLGetChildNodes")
  1106. Return SetError(1,20,-1)
  1107. EndIf
  1108. Local $objNodeList, $arrResponse[1], $xmlerr
  1109. $objNodeList = $objDoc.selectSingleNode ($strXPath)
  1110. If Not IsObj($objNodeList) Then
  1111. _XMLError(@LF & "No Matching Nodes found")
  1112. $arrResponse[0] = 0
  1113. Return SetError(1,0,-1)
  1114. EndIf
  1115. If $objNodeList.hasChildNodes () Then
  1116. For $objChild In $objNodeList.childNodes ()
  1117. If $objChild.nodeType () = $NODE_ELEMENT Then
  1118. _DebugWrite($objChild.NamespaceURI &"::"& $objChild.baseName &@LF)
  1119. _XMLArrayAdd($arrResponse, $objChild.baseName)
  1120. EndIf
  1121. Next
  1122. $arrResponse[0] = UBound($arrResponse) - 1
  1123. Return $arrResponse
  1124. EndIf
  1125. $arrResponse[0] = 0
  1126. $xmlerr = @LF & "No Child Nodes found"
  1127. _XMLError("Error Selecting Node(s): " & $strXPath & $xmlerr)
  1128. Return SetError(1,0,-1)
  1129. EndFunc ;==>_XMLGetChildNodes
  1130. ;===============================================================================
  1131. ; Function Name: _XMLGetChildren
  1132. ; Description: Selects XML child Node(s) of an element based on XPath input from root node.
  1133. ; And returns there text values.
  1134. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  1135. ; Syntax: _XMLGetChildren($path)
  1136. ; Return Value(s): On Success an array where
  1137. ; $array[0][0] = Size of array
  1138. ; $array[1][0] = Name
  1139. ; $array[1][1] = Text
  1140. ; $array[1][2] = NameSpaceURI
  1141. ; ...
  1142. ; $array[n][0] = Name
  1143. ; $array[n][1] = Text
  1144. ; $array[n][2] = NamespaceURI
  1145. ; On Failure - Returns -1 and sets @ERROR to
  1146. ; 1 - Failure
  1147. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1148. ;===============================================================================
  1149. Func _XMLGetChildren($strXPath)
  1150. If not IsObj($objDoc) then
  1151. _XMLError("No object passed to function _XMLGetChildren")
  1152. Return SetError(1,21,-1)
  1153. EndIf
  1154. Local $objNodeList, $arrResponse[1][3], $xmlerr
  1155. $objNodeList = $objDoc.selectSingleNode ($strXPath)
  1156. If Not IsObj($objNodeList) Then
  1157. _XMLError(@LF & "No Matching Nodes found")
  1158. $arrResponse[0][0]= 0
  1159. Return SetError(1,0,-1)
  1160. EndIf
  1161. If $objNodeList.hasChildNodes () Then
  1162. For $objChild In $objNodeList.childNodes ()
  1163. If $objChild.nodeType () = $NODE_ELEMENT Then
  1164. Local $dims = UBound($arrResponse,1)
  1165. ReDim $arrResponse[$dims+1][3]
  1166. $arrResponse[$dims][0] = $objChild.baseName
  1167. $arrResponse[$dims][1] = $objChild.text
  1168. $arrResponse[$dims][2] = $objChild.NamespaceURI
  1169. ;_XMLArrayAdd($arrResponse, $objChild.baseName)
  1170. EndIf
  1171. Next
  1172. $arrResponse[0][0] = UBound($arrResponse,1) - 1
  1173. Return $arrResponse
  1174. EndIf
  1175. $arrResponse[0][0] = 0
  1176. $xmlerr = @LF & "No Child Nodes found"
  1177. _XMLError("Error Selecting Node(s): " & $strXPath & $xmlerr)
  1178. Return SetError(1,0,-1)
  1179. EndFunc ;==>_XMLGetChildren
  1181. ;===============================================================================
  1182. ; Function Name: _XMLGetNodeCount
  1183. ; Description: Get Node Count based on XPath input from root node.
  1184. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  1185. ; [$query] DOM compliant query string (not really necessary as it becomes part of the path
  1186. ; $iNodeType The type of node to count. (element, attrib, comment etc.)
  1187. ; Syntax: _XMLGetNodeCount($path,$query,$iNodeType)
  1188. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com> & DickB
  1189. ; Return Value(s):0 or Number of Nodes found
  1190. ; on error set error to 1 and returns -1
  1191. ;===============================================================================
  1192. Func _XMLGetNodeCount($strXPath, $strQry = "", $iNodeType = 1)
  1193. If not IsObj($objDoc) then
  1194. _XMLError("No object passed to function _XMLGetNodeCount")
  1195. Return SetError(1,22,-1)
  1196. EndIf
  1197. Local $objQueryNodes, $objNode, $nodeCount = 0, $errMsg
  1198. $objQueryNodes = $objDoc.selectNodes ($strXPath & $strQry)
  1199. If @error = 0 And $objQueryNodes.length > 0 Then
  1200. For $objNode In $objQueryNodes
  1201. If $objNode.nodeType = $iNodeType Then $nodeCount = $nodeCount + 1
  1202. Next
  1203. Return $nodeCount
  1204. Else
  1205. $errMsg = "No nodes of specified type found."
  1206. EndIf
  1207. _XMLError("Error retrieving node count for: " & $strXPath & @CRLF & $errMsg & @CRLF)
  1208. SetError(1)
  1209. Return -1
  1210. ; EndIf
  1211. EndFunc ;==>_XMLGetNodeCount
  1212. ;===============================================================================
  1213. ; Function Name: _XMLGetAllAttribIndex
  1214. ; Description: Get all XML Field(s) attributes based on Xpathn and specific index.
  1215. ; Parameter(s): $sXpath xml tree path from root node (root/child/child..)
  1216. ; $aNames the array to return the attrib names
  1217. ; $aValue the array to return the attrib values
  1218. ; [$sQuery] DOM compliant query string (not really necessary as it becomes
  1219. ; [$iNode] node index.
  1220. ;part of the path
  1221. ; Syntax: _XMLGetAllAttribIndex($path,$aNames,$aValues,[$sQuery="",$iNode=0]])
  1222. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1223. ; Return Value(s) array of attrib node names, array of attrib values
  1224. ; on error set error to 1 and returns -1
  1225. ;===============================================================================
  1226. Func _XMLGetAllAttribIndex($strXPath, ByRef $aName, ByRef $aValue, $strQry = "", $NodeIndex = 0)
  1227. If not IsObj($objDoc) then
  1228. _XMLError("No object passed to function _XMLGetAllAttribIndex")
  1229. Return SetError(1,23,-1)
  1230. EndIf
  1231. Local $objNodeList, $objQueryNodes, $arrResponse[2][1], $i
  1232. $objQueryNodes = $objDoc.selectNodes ($strXPath & $strQry)
  1233. If $objQueryNodes.length > 0 Then
  1234. $objNodeList = $objQueryNodes.item($NodeIndex).attributes
  1235. _DebugWrite("GetAllAttribIndex " & $objNodeList.length)
  1236. ReDim $arrResponse[2][$objNodeList.length + 1]
  1237. ReDim $aName[$objNodeList.length]
  1238. ReDim $aValue[$objNodeList.length]
  1239. For $i = 0 To $objNodeList.length - 1
  1240. $arrResponse[0][$i] = $objNodeList.item ($i).nodeName
  1241. $arrResponse[1][$i] = $objNodeList.item ($i).Value
  1242. $aName[$i] = $objNodeList.item ($i).nodeName
  1243. $aValue[$i] = $objNodeList.item ($i).Value
  1244. Next
  1245. Return $arrResponse
  1246. EndIf
  1247. _XMLError("Error retrieving attributes for: " & $strXPath & @CRLF)
  1248. Return SetError(1,0,-1)
  1249. EndFunc ;==>_XMLGetAllAttribIndex
  1250. ;===============================================================================
  1251. ; Function Name: _XMLGetPath
  1252. ; Description: Return a nodes full path based on XPath input from root node.
  1253. ; Parameter(s): $path xml tree path from root node (root/child/child..)
  1254. ; Syntax: _XMLGetPath($path)
  1255. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1256. ; Return Value(s): array of fields text values -1 on failure
  1257. ;===============================================================================
  1258. Func _XMLGetPath($strXPath)
  1259. If not IsObj($objDoc) then
  1260. _XMLError("No object passed to function _XMLGetPath")
  1261. Return SetError(1,24,-1)
  1262. EndIf
  1263. If $DOMVERSION < 4 Then
  1264. _XMLError("Error DOM Version: " & "MSXML Version 4 or greater required for this function")
  1265. Return SetError(1,0,-1)
  1266. EndIf
  1267. Local $objNodeList, $arrResponse[1], $objNodeChild, $xmlerr, $nodepath, $ns
  1268. $objNodeList = $objDoc.selectNodes ($strXPath)
  1269. If $objNodeList.length > 0 Then
  1270. _DebugWrite("GetPath list length:" & $objNodeList.length)
  1271. For $objNode In $objNodeList
  1272. Local $objNode1 = $objNode
  1273. $nodepath = ""
  1274. $nodepathtag = ""
  1275. If $objNode.nodeType <> $NODE_DOCUMENT Then
  1276. $ns = $objNode.namespaceURI ()
  1277. If $ns <> "" Then
  1278. $ns = StringRight($ns, StringLen($ns) - StringInStr($ns, "/", 0, -1)) & ":"
  1279. EndIf
  1280. if $ns =0 then $ns =""
  1281. $nodepath = "/" & $ns & $objNode.nodeName () & $nodepath
  1282. EndIf
  1283. Do
  1284. $objParent = $objNode1.parentNode ()
  1285. _DebugWrite("parent " & $objParent.nodeName () & @LF)
  1286. If $objParent.nodeType <> $NODE_DOCUMENT Then
  1287. $ns = $objParent.namespaceURI ()
  1288. If $ns <> "" Then
  1289. ;$ns = StringRight($ns, StringLen($ns) - StringInStr($ns, "/", 0, -1)) & ":"
  1290. $ns &=":"
  1291. EndIf
  1292. if $ns =0 then $ns= ""
  1293. $nodepath = "/" &$ns & $objParent.nodeName ()& $nodepath
  1294. $objNode1 = $objParent
  1295. Else
  1296. $objNode1 = 0
  1297. EndIf
  1298. $objParent = 0
  1299. Until (Not (IsObj($objNode1)))
  1300. _DebugWrite("Path node> " & $nodepath & @LF)
  1301. _XMLArrayAdd($arrResponse, $nodepath)
  1302. Next
  1303. $arrResponse[0] = UBound($arrResponse) - 1
  1304. Return $arrResponse
  1305. EndIf
  1306. $xmlerr = @CRLF & "No matching node(s)found!"
  1307. _XMLError("Error Retrieving: " & $strXPath & $xmlerr)
  1308. Return SetError(1,0,-1)
  1309. EndFunc ;==>_XMLGetPath
  1311. ;===============================================================================
  1312. ; Function Name : _XMLGetPathInternal
  1313. ; Description : Returns the path of a valid node object.
  1314. ; Parameter(s) : $objNode A valid node object
  1315. ; Requirement(s) :
  1316. ; Return Value(s) : A string path, an empty string and set error on fail.
  1317. ; User CallTip :
  1318. ; Author(s) : Stephen Podhajecki <gehossafats at netmdc.com/>
  1319. ; Note(s) :
  1320. ;===============================================================================
  1321. Func _XMLGetPathInternal($objNode)
  1322. If not IsObj($objDoc) then
  1323. _XMLError("No object passed to function _XMLGetPathInternal")
  1324. Return SetError(1,25,-1)
  1325. EndIf
  1326. Local $nodepath, $na, $objParent
  1327. If IsObj($objNode) Then
  1328. $nodepath = "/" & $objNode.baseName
  1329. Do
  1330. $objParent = $objNode.parentNode ()
  1331. _DebugWrite("parent" & $objParent.nodeName () & ">" & @LF)
  1332. If $objParent.nodeType <> $NODE_DOCUMENT Then
  1333. $ns = $objParent.namespaceURI ()
  1334. If $ns = 0 Then $ns = ""
  1335. If $ns <> "" Then
  1336. $ns = StringRight($ns, StringLen($ns) - StringInStr($ns, "/", 0, -1)) & ":"
  1337. EndIf
  1338. $nodepath = "/" & $ns & $objParent.nodeName () & $nodepath
  1339. $objNode = $objParent
  1340. Else
  1341. $objNode = 0
  1342. EndIf
  1343. $objParent = 0
  1344. Until (Not (IsObj($objNode)))
  1345. _DebugWrite("Path node>" & $nodepath & @LF)
  1346. Return ($nodepath)
  1347. Else
  1348. Return SetError(1, 0, "")
  1349. EndIf
  1350. EndFunc ;==>_XMLGetPathInternal
  1351. ;===============================================================================
  1352. ; Function Name: _XMLReplaceChild
  1353. ; Description: Replaces a node with another
  1354. ; Parameter(s): $oldNode Node to replace
  1355. ; $newNode The replacement node.
  1356. ; Syntax: _XMLReplaceChild(oldNode,newNode)
  1357. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com> adapted from
  1358. ; http://www.perfectxml.com/msxmlAnswers.asp?Row_ID=65
  1359. ; Return Value(s)
  1360. ;===============================================================================
  1361. Func _XMLReplaceChild($objOldNode, $objNewNode, $ns = "")
  1362. If not IsObj($objDoc) then
  1363. _XMLError("No object passed to function _XMLReplaceChild")
  1364. Return SetError(1,26,-1)
  1365. EndIf
  1366. If $objOldNode = "" Or $objNewNode = "" Then Return SetError(1)
  1367. Local $nodeRoot
  1368. Local $nodeOld
  1369. Local $nodeNew
  1370. Local $nodeTemp
  1371. Local $bSuccess = False
  1372. ;No error handling done
  1373. With $objDoc
  1374. ;;.Load "c:\books.xml"
  1375. $nodeRoot = .documentElement
  1376. $oldNodes = $nodeRoot.selectNodes ($objOldNode)
  1377. ;'For each Node
  1378. For $nodeOld In $oldNodes
  1379. ;Create a New element
  1380. $nodeNew = .createNode ($NODE_ELEMENT, $objNewNode, $ns)
  1381. ;Copy attributes
  1382. For $nodeTemp In $nodeOld.Attributes
  1383. $nodeNew.Attributes.setNamedItem ($nodeTemp.cloneNode (True))
  1384. Next
  1385. ;Copy Child Nodes
  1386. For $nodeTemp In $nodeOld.childNodes
  1387. $nodeNew.appendChild ($nodeTemp)
  1388. Next
  1389. ;Replace with the renamed node
  1390. If IsObj($nodeOld.parentNode.replaceChild ($nodeNew, $nodeOld)) Then $bSuccess = 1
  1391. If Not ($objDoc.parseError.errorCode = 0) Then
  1392. _XMLError("_XMLReplaceChild:" & @LF & "Error Replacing Child: " & _
  1393. $objDoc.parseError.errorCode & _
  1394. " " & $objDoc.parseError.reason)
  1395. $bSucess = False
  1396. ExitLoop
  1397. Else
  1398. $bSuccess = True
  1399. EndIf
  1400. Next
  1401. .save ($strFile)
  1402. EndWith
  1403. $nodeRoot = 0
  1404. $nodeOld = 0
  1405. $nodeNew = 0
  1406. $nodeTemp = 0
  1407. Return $bSuccess
  1408. EndFunc ;==>_XMLReplaceChild
  1409. ;===============================================================================
  1410. ; Function Name: _XMLSchemaValidate
  1411. ; Description: Validates a document against a dtd.
  1412. ; Parameter(s): $sXMLFile The file to validate
  1413. ; $ns xml namespace
  1414. ; $sXSDFile DTD file to validate against.
  1415. ; Syntax: _XMLSchemaValidate($sXMLFile, $ns, $sXSDFile)
  1416. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1417. ; Return Value(s) 1 on success or SetError(errorcode) on failure
  1418. ;===============================================================================
  1419. Func _XMLSchemaValidate($sXMLFile, $ns, $sXSDFile)
  1420. ;~ If not IsObj($objDoc) then
  1421. ;~ _XMLError("No object passed to function _XMLSchemaValidate")
  1422. ;~ Return SetError(1,27,-1)
  1423. ;~ EndIf
  1424. Local $cache, $xmldoc
  1425. $cache = ObjCreate("Msxml2.XMLSchemaCache." & $DOMVERSION & ".0")
  1426. If Not IsObj($cache) Then
  1427. MsgBox(266288, "XML Error", "Unable to instantiate the XML object" & @LF & "Please check your components.")
  1428. Return SetError(-1)
  1429. EndIf
  1430. $cache.add ($ns, $sXSDFile)
  1431. $xmldoc = ObjCreate("Msxml2.DOMDocument." & $DOMVERSION & ".0")
  1432. If Not IsObj($xmldoc) Then
  1433. MsgBox(266288, "XML Error", "Unable to instantiate the XML object" & @LF & "Please check your components.")
  1434. Return SetError(-1)
  1435. EndIf
  1436. $xmldoc.async = False
  1437. $xmldoc.schemas = $cache
  1438. $xmldoc.load ($sXMLFile)
  1439. If Not ($xmldoc.parseError.errorCode = 0) Then
  1440. _XMLError("_XMLSchemaValidate:" & @LF & "Error: " & $xmldoc.parseError.errorCode & " " & $xmldoc.parseError.reason)
  1441. Return SetError($xmldoc.parseError.errorCode)
  1442. EndIf
  1443. Return 0
  1444. EndFunc ;==>_XMLSchemaValidate
  1445. ;===============================================================================
  1446. ; Function Name: _XMLGetDomVersion
  1447. ; Description: Returns the version of msxml that is in use for the document.
  1448. ;
  1449. ; Syntax: _XMLGetDomVersion()
  1450. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1451. ; Return Value(s) msxml version or -1
  1452. ;===============================================================================
  1453. Func _XMLGetDomVersion()
  1454. Return $DOMVERSION
  1455. EndFunc ;==>_XMLGetDomVersion
  1456. ;===============================================================================
  1457. ; Function Name: _XMLError
  1458. ; Description: Sets error message generated by XML functs.
  1459. ; or Gets the message that was Set.
  1460. ; Parameter(s): $sError Node from root to delete
  1461. ; Syntax: _XMLError([$sError)
  1462. ; Author(s): Stephen Podhajecki <gehossafats@netmdc.com>
  1463. ; Return Value(s) Nothing or Error message
  1464. ;===============================================================================
  1465. Func _XMLError($sError = "")
  1466. If $sError = "" Then
  1467. $sError = $sXML_error
  1468. $sXML_error = ""
  1469. Return $sError
  1470. Else
  1471. $sXML_error = StringFormat($sError)
  1472. EndIf
  1473. _DebugWrite($sXML_error)
  1474. EndFunc ;==>_XMLError
  1475. ;===============================================================================
  1476. ; Function Name: _XMLCOMEerr
  1477. ; Description: Displays a message box with the COM Error.
  1478. ; Parameter(s): none
  1479. ; Syntax: _XMLCOMEerr()
  1480. ; Author(s): SvenP 's error handler
  1481. ; Return Value(s)
  1482. ; From the forum this came.
  1483. ;===============================================================================
  1484. Func _XMLCOMEerr()
  1485. _ComErrorHandler()
  1486. Return
  1487. EndFunc ;==>_XMLCOMEerr
  1488. Func _ComErrorHandler($quiet = "")
  1489. Local $COMErr_Silent, $HexNumber
  1490. ;===============================================================================
  1491. ;added silent switch to allow the func returned to the option to display custom
  1492. ;error messages
  1493. If $quiet = True Or $quiet = False Then
  1494. $COMErr_Silent = $quiet
  1495. $quiet = ""
  1496. EndIf
  1497. ;===============================================================================
  1498. $HexNumber = Hex($oXMLMyError.number, 8)
  1499. If @error Then Return
  1500. Local $msg = "COM Error with DOM!" & @CRLF & @CRLF & _
  1501. "err.description is: " & @TAB & $oXMLMyError.description & @CRLF & _
  1502. "err.windescription:" & @TAB & $oXMLMyError.windescription & @CRLF & _
  1503. "err.number is: " & @TAB & $HexNumber & @CRLF & _
  1504. "err.lastdllerror is: " & @TAB & $oXMLMyError.lastdllerror & @CRLF & _
  1505. "err.scriptline is: " & @TAB & $oXMLMyError.scriptline & @CRLF & _
  1506. "err.source is: " & @TAB & $oXMLMyError.source & @CRLF & _
  1507. "err.helpfile is: " & @TAB & $oXMLMyError.helpfile & @CRLF & _
  1508. "err.helpcontext is: " & @TAB & $oXMLMyError.helpcontext
  1509. If $COMErr_Silent <> True Then
  1510. MsgBox(0, @AutoItExe, $msg)
  1511. Else
  1512. _XMLError($msg)
  1513. EndIf
  1514. SetError(1)
  1515. EndFunc ;==>_ComErrorHandler
  1516. ; simple helper functions
  1517. ;===============================================================================
  1518. ; Function Name: - _DebugWrite($message)
  1519. ; Description: - Writes a message to console with a crlf on the end
  1520. ; Parameter(s): - $message the message to display
  1521. ; Syntax: - _DebugWrite($message)
  1522. ; Author(s): -
  1523. ; Return Value(s) -
  1524. ;===============================================================================
  1525. Func _DebugWrite($message, $flag = @LF)
  1526. If $debugging Then
  1527. ConsoleWrite(StringFormat($message)&$flag)
  1528. EndIf
  1529. EndFunc ;==>_DebugWrite
  1530. ;===============================================================================
  1531. ; Function Name: _Notifier($Notifier_msg)
  1532. ; Description: displays a simple "ok" messagebox
  1533. ; Parameter(s): $Notifier_Msg The message to display
  1534. ; Syntax: _Notifier($Notifier_msg)
  1535. ; Author(s): -
  1536. ; Return Value(s) -
  1537. ;===============================================================================
  1538. Func _Notifier($Notifier_msg)
  1539. Return MsgBox(266288, @ScriptName, $Notifier_msg)
  1540. EndFunc ;==>_Notifier
  1541. ;===============================================================================
  1542. ; Function Name: - _SetDebug($flag =False)
  1543. ; Description: - Writes a message to console with a crlf on the end
  1544. ; Parameter(s): - $message the message to display
  1545. ; Syntax: - _DebugWrite($message)
  1546. ; Author(s): -
  1547. ; Return Value(s) -
  1548. ;===============================================================================
  1549. Func _SetDebug($debug_flag = True)
  1550. $debugging = $debug_flag
  1551. ConsoleWrite("Debug = " & $debugging & @LF)
  1552. EndFunc ;==>_SetDebug
  1553. ;===============================================================================
  1554. ; Function Name: _XMLUDFVersion()
  1555. ; Description: Returns UDF version number
  1556. ; Parameter(s): None
  1557. ; Syntax: _XMLUDFVersion()
  1558. ; Author(s): Stephen Podhajecki
  1559. ; Return Value(s) UDF version number
  1560. ;===============================================================================
  1561. Func _XMLUDFVersion()
  1562. Return $_XMLUDFVER
  1563. EndFunc ;==>_XMLUDFVersion
  1564. ;===============================================================================
  1565. ; Function Name: _XMLTransform
  1566. ; Description:
  1567. ; Parameter(s): $oXMLDoc The document to transform
  1568. ; $Style (optional) The stylesheet to use
  1569. ; $szNewDoc (optional) Save to this file.
  1570. ; Return Value(s): On Success returns 1
  1571. ; On Failure @Error = 1
  1572. ; User CallTip:
  1573. ; Author(s): Stephen Podhajecki <gehossafats at netmdc dot com>
  1574. ; Note(s):
  1575. ;===============================================================================
  1576. Func _XMLTransform($oXMLDoc="", $Style = "", $szNewDoc = "")
  1577. If $oXMLDoc = "" Then
  1578. $oXMLDoc = $objDoc
  1579. EndIf
  1580. If not IsObj($oXMLDoc) then
  1581. _XMLError("No object passed to function _XMLSetAttrib")
  1582. Return SetError(1,29,-1)
  1583. EndIf
  1584. Local $bIndented = False
  1585. Local $xslt = ObjCreate("MSXML2.XSLTemplate." & $DOMVERSION & ".0")
  1586. Local $xslDoc = ObjCreate("MSXML2.FreeThreadedDOMDocument." & $DOMVERSION & ".0")
  1587. Local $xmldoc = ObjCreate("MSXML2.DOMDocument." & $DOMVERSION & ".0")
  1588. Local $xslProc
  1589. $xslDoc.async = False
  1590. If FileExists($Style) Then
  1591. _DebugWrite("LoadXML:1:" & $xslDoc.load ($Style) & @LF)
  1592. Else
  1593. _DebugWrite("LoadXML:2:" & $xslDoc.loadXML (_GetDefaultStyleSheet()) & @LF)
  1594. EndIf
  1595. If $xslDoc.parseError.errorCode <> 0 Then
  1596. _XMLError("Error Transforming NodeToObject: " & $xslDoc.parseError.reason)
  1597. EndIf
  1598. If Not FileExists("XSLFile.xsl") Then FileWrite("XSLFile.xsl", $xslDoc.xml ())
  1599. $xslt.stylesheet = $xslDoc
  1600. $xslProc = $xslt.createProcessor ()
  1601. $xslProc.input = $objDoc
  1602. $oXMLDoc.transformNodeToObject ($xslDoc, $xmldoc)
  1603. If $oXMLDoc.parseError.errorCode <> 0 Then
  1604. _XMLError("_XMLTransform:" & @LF & "Error Transforming NodeToObject: " & $oXMLDoc.parseError.reason)
  1605. $bIndented = False
  1606. Else
  1607. $bIndented = True
  1608. EndIf
  1609. If $bIndented Then
  1610. If $szNewDoc <> "" Then
  1611. $xmldoc.save ($szNewDoc)
  1612. If $xmldoc.parseError.errorCode <> 0 Then
  1613. _XMLError("_XMLTransform:" & @LF & "Error Saving: " & $xmldoc.parseError.reason)
  1614. $bIndented = False
  1615. EndIf
  1616. Else
  1617. $xmldoc.save ($strFile)
  1618. $oXMLDoc.Load ($strFile)
  1619. If $oXMLDoc.parseError.errorCode <> 0 Then
  1620. _XMLError("_XMLTransform:" & @LF & "Error Saving: " & $oXMLDoc.parseError.reason)
  1621. $bIndented = False
  1622. EndIf
  1623. EndIf
  1624. EndIf
  1625. $xslProc = 0
  1626. $xslt = 0
  1627. $xslDoc = 0
  1628. $xmldoc = 0
  1629. Return $bIndented
  1630. EndFunc ;==>_XMLTransform
  1631. ;===============================================================================
  1632. ; Function Name: _GetDefaultStyleSheet
  1633. ; Description: Internal function, returns the default indenting style sheet
  1634. ; Parameter(s): Requirement(s):
  1635. ; Return Value(s): Stylesheet on success for nothing on failure.
  1636. ; User CallTip:
  1637. ; Author(s):
  1638. ; Note(s):
  1639. ;===============================================================================
  1640. Func _GetDefaultStyleSheet()
  1641. Return '<?xml version="1.0" encoding="ISO-8859-1"?>' & _
  1642. '<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">' & _
  1643. '<xsl:output method="xml" indent="yes"/> ' & _
  1644. '<xsl:template match="*">' & _
  1645. '<xsl:copy>' & _
  1646. '<xsl:copy-of select="@*" />' & _
  1647. '<xsl:apply-templates />' & _
  1648. '</xsl:copy>' & _
  1649. '</xsl:template>' & _
  1650. '<xsl:template match="comment()|processing-instruction()">' & _
  1651. '<xsl:copy />' & _
  1652. '</xsl:template>' & _
  1653. '</xsl:stylesheet>'
  1654. EndFunc ;==>_GetDefaultStyleSheet
  1655. ;===============================================================================
  1656. ; Function Name: _AddFormat
  1657. ; Description:
  1658. ; Parameter(s): $objDoc Document to format
  1659. ; $objParent Optional node to add formatting to
  1660. ; Requirement(s):
  1661. ; Return Value(s):
  1662. ; User CallTip:
  1663. ; Author(s): Stephen Podhajecki <gehossafats a t netmdc.com>
  1664. ; Note(s): just break up the tags, no indenting is done here.
  1665. ;===============================================================================
  1666. Func _AddFormat($objDoc, $objParent = "")
  1667. If not IsObj($objDoc) then
  1668. _XMLError("No object passed to function _XMLAddFormat")
  1669. Return SetError(1,30,-1)
  1670. EndIf
  1671. $objFormat = $objDoc.createTextNode (@CR)
  1672. If IsObj($objParent) Then
  1673. $objParent.appendChild ($objFormat)
  1674. Else
  1675. $objDoc.documentElement.appendChild ($objFormat)
  1676. EndIf
  1677. If ($bXMLAUTOSAVE = True) Then $objDoc.save ($strFile)
  1678. EndFunc ;==>_AddFormat
  1679. ;===============================================================================
  1680. ; Function Name: _XMLSetAutoSave
  1681. ; Description: Set the forced save to on or off
  1682. ; Parameter(s): $bSave
  1683. ; Requirement(s):
  1684. ; Return Value(s): previous state
  1685. ; User CallTip:
  1686. ; Author(s): Stephen Podhajecki <gehossafats a t netmdc.com>
  1687. ; Note(s): Defaults to true.
  1688. ;===============================================================================
  1689. Func _XMLSetAutoSave($bSave = True)
  1690. Local $oldSave = $bXMLAUTOSAVE
  1691. if $bSave = False Then
  1692. $bXMLAUTOSAVE = True
  1693. Else
  1694. $bXMLAUTOSAVE = False
  1695. EndIf
  1696. Return $oldSave
  1697. EndFunc
  1698. ;===============================================================================
  1699. ; Function Name: _XMLSaveDoc
  1700. ; Description: Save the current xml doc
  1701. ; Parameter(s): $sFile - The filename to save the xml doc as.
  1702. ; Requirement(s):
  1703. ; Return Value(s): none
  1704. ; User CallTip:
  1705. ; Author(s): Stephen Podhajecki <gehossafats a t netmdc.com>
  1706. ; Note(s): Defaults to the current filename.
  1707. ;===============================================================================
  1708. Func _XMLSaveDoc($sFile="")
  1709. if $sFile = "" Then $sFile = $strFile
  1710. $objDoc.save($sFile)
  1711. EndFunc
  1713. ;===============================================================================
  1714. ; Function Name: _XMLNodeExists
  1715. ; Description: Checks for the existence of a node or nodes matching the specified path
  1716. ; Parameter(s): $strXPath - Path to check for.
  1717. ; Requirement(s):
  1718. ; Return Value(s): 1 or Higher on success, 0 on failure
  1719. ; @Error set to
  1720. ; 0 no error
  1721. ; 1 No XML object @extended = 31
  1722. ; 2 Node not found
  1723. ; User CallTip:
  1724. ; Author(s): Stephen Podhajecki <gehossafats a t netmdc.com>
  1725. ; Note(s): Returns the number of nodes found (could be greater than 1)
  1726. ;===============================================================================
  1727. Func _XMLNodeExists($strXPath)
  1728. If not IsObj($objDoc) then
  1729. _XMLError("No object passed to function _XMLNodeExists")
  1730. Return SetError(1,31,0)
  1731. EndIf
  1732. Local $objNode, $iCount
  1733. Local $objNode = $objDoc.SelectNodes($strXPath)
  1734. If IsObj($objNode) Then $iCount = $objNode.length
  1735. $objNode = 0
  1736. if $iCount Then Return $iCount
  1737. Return SetError(2,0,0)
  1738. EndFunc
  1739. ; =======================================================================
  1740. ; Preprocessed included functions...
  1741. ; =======================================================================
  1742. Func _XMLArrayAdd(ByRef $avArray, $sValue)
  1743. If IsArray($avArray) Then
  1744. ReDim $avArray[UBound($avArray) + 1]
  1745. $avArray[UBound($avArray) - 1] = $sValue
  1746. SetError(0)
  1747. Return 1
  1748. Else
  1749. SetError(1)
  1750. Return 0
  1751. EndIf
  1752. EndFunc ;==>_XMLArrayAdd
comments powered by Disqus