GetFeature.js 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. // @require WFS_URL
  2. if (!WFS_URL) throw "Missing WFS_URL"
  3. var DBG = DBG || false
  4. // wfsFeature json format:
  5. /*
  6. {
  7. $fieldName:
  8. - string => field value
  9. - array of objects => ref features as objects (wfsFeature)
  10. - array of strings => ref features as xlink url
  11. }
  12. */
  13. function p5WFS_ParseFeatureFieldRecurse(tagNode) { // @returns object from xml element
  14. var item = {}
  15. var i = 0
  16. for (i = 0; i < tagNode.children.length; i++) {
  17. var fieldNode = tagNode.children[i]
  18. if ('p5:links' === fieldNode.tagName) {
  19. // <p5:links>
  20. // ​<p5:next p5:typeName=​"default_db__x3A__BI_audit_KW_requested_person:​BI_audit_KW_requested_person"
  21. // p5:backRefNS=​"default_db/​BI_audit_ENERGA_RUM_KONTRAHENCI_POWIAZANIA/​BI_audit_ENERGA_RUM_KONTRAHENCI_POWIAZANIA"
  22. // p5:backRefPK=​"20"
  23. // p5:startIndex=​"10">
  24. // ​"https://.../wfs-data.php/default_db/?SERVICE=WFS&amp;VERSION=1.0.0&amp;TYPENAME=default_db__x3A__BI_audit_KW_requested_person:BI_audit_KW_requested_person&amp;REQUEST=GetFeature&amp;backRefNS=default_db/BI_audit_ENERGA_RUM_KONTRAHENCI_POWIAZANIA/BI_audit_ENERGA_RUM_KONTRAHENCI_POWIAZANIA&amp;backRefPK=20&amp;backRefField=default_db__x3A__BI_audit_KW_requested_person:BI_audit_KW_requested_person&amp;startIndex=10"
  25. // </p5:next>​</p5:links>​
  26. for (var j = 0; j < fieldNode.children.length; j++) {
  27. var p5LinkNode = fieldNode.children[j]
  28. if ('p5:next' === p5LinkNode.tagName) {
  29. var typeName = p5LinkNode.getAttribute('p5:typeName')
  30. item[ typeName ].push( {
  31. 'type': 'next',
  32. '@backRefNS': p5LinkNode.getAttribute('p5:backRefNS'),
  33. '@backRefPK': p5LinkNode.getAttribute('p5:backRefPK'),
  34. '@typeName': p5LinkNode.getAttribute('p5:typeName'),
  35. '@startIndex': p5LinkNode.getAttribute('p5:startIndex'),
  36. 'value': p5LinkNode.textContent
  37. } )
  38. } else {
  39. if (DBG) console.warn("Not implemented p5:links/" + p5LinkNode.tagName)
  40. }
  41. }
  42. }
  43. else if (!fieldNode.children.length) {
  44. if (fieldNode.textContent) item[ fieldNode.localName ] = fieldNode.textContent
  45. else {
  46. var xlink = fieldNode.getAttribute('xlink:href')
  47. if (xlink) {
  48. if (!(fieldNode.tagName in item)) item[ fieldNode.tagName ] = []
  49. item[ fieldNode.tagName ].push( xlink )
  50. }
  51. }
  52. }
  53. else {
  54. if (!(fieldNode.tagName in item)) item[ fieldNode.tagName ] = []
  55. item[ fieldNode.tagName ].push( p5WFS_ParseFeatureFieldRecurse(fieldNode) )
  56. }
  57. }
  58. return item
  59. }
  60. function p5WFS_ParseFeatureMember(featureMember) { // @returns object from xml element <gml:featureMemeber>
  61. if (!featureMember) return null
  62. if (!featureMember.children.length) return null
  63. var featureNode = featureMember.children[0]
  64. if (!featureNode) return null
  65. if (!featureNode.children.length) return null
  66. return p5WFS_ParseFeatureFieldRecurse(featureNode)
  67. }
  68. /**
  69. * @usage
  70. p5WFS_GetFeature('p5_default_db:CRM_PROCES', {
  71. 'featureID': 'CRM_PROCES.' + id,
  72. }).then(function (features) {
  73. // ...
  74. }).catch(function (e) {
  75. // ...
  76. })
  77. * @usage - expected one feature
  78. p5WFS_GetFeature('p5_default_db:CRM_PROCES', {
  79. 'featureID': 'CRM_PROCES.' + id,
  80. }).then(function (features) {
  81. if (!features) throw "Nie odnaleziono rekordu id = " + id
  82. if (!features.length) throw "Nie odnaleziono rekordu id = " + id
  83. if (1 !== features.length) throw "Bład: API zwróciło za dużo rekordów"
  84. return features[0]
  85. console.log('fetched features', features)
  86. }).then(function (feature) {
  87. // ...
  88. }).catch(function (e) {
  89. // ...
  90. })
  91. * @usage - POST
  92. p5WFS_GetFeature('p5_default_db:CRM_PROCES', {
  93. // 'Filter': '<ogc:PropertyIsEqualTo><ogc:PropertyName>' + "PARENT_ID" + '</ogc:PropertyName><ogc:Literal>' + parent_id + '</ogc:Literal></ogc:PropertyIsEqualTo>',
  94. 'sortBy': 'SORT_PRIO+A,ID',
  95. 'ogc:Filter': '<GetFeature xmlns="http://www.opengis.net/wfs/2.0"'+
  96. ' xmlns:p5_default_db="' + BASE_WFS_URL + '/default_db"' +
  97. ' xmlns:ogc="http://www.opengis.net/ogc"' +
  98. ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
  99. ' service="WFS"' +
  100. ' version="2.0.2"' +
  101. ' xsi:schemaLocation="http://www.opengis.net/wfs/2.0 http://schemas.opengis.net/wfs/2.0/wfs.xsd">' +
  102. '<ogc:Filter>' +
  103. '<ogc:PropertyIsEqualTo><ogc:PropertyName>' + "PARENT_ID" + '</ogc:PropertyName><ogc:Literal>' + parent_id + '</ogc:Literal></ogc:PropertyIsEqualTo>' +
  104. '</ogc:Filter>' +
  105. '</GetFeature>'
  106. }).then(function (features) {
  107. ...
  108. */
  109. function p5WFS_GetFeature(typeName, query) { // @returns Promise
  110. var postData = null
  111. var link = WFS_URL + '?SERVICE=WFS&VERSION=1.0.0' +
  112. '&REQUEST=GetFeature' +
  113. '&TYPENAME=' + typeName +
  114. '&SRSNAME=EPSG:3003'
  115. ;
  116. if ('WFS_URL' in query && query['WFS_URL'].length) {
  117. link = query['WFS_URL']
  118. link += ( (-1 !== query['WFS_URL'].indexOf('?')) ? '&' : '?' )
  119. link += 'SERVICE=WFS&VERSION=1.0.0'
  120. link += '&REQUEST=GetFeature'
  121. link += '&TYPENAME=' + typeName
  122. link += '&SRSNAME=EPSG:3003'
  123. }
  124. // '&Filter=<ogc:Filter><ogc:Or><ogc:PropertyIsEqualTo><ogc:PropertyName>ID</ogc:PropertyName><ogc:Literal>' + id + '</ogc:Literal></ogc:PropertyIsEqualTo></ogc:Or></ogc:Filter>'
  125. var query = query || {}
  126. if ('featureID' in query) link += '&featureID=' + query['featureID']
  127. if ('Filter' in query && 'string' === typeof query['Filter']) {
  128. var ogcFilter = ('<ogc:Filter>' !== query['Filter'].substr(0, '<ogc:Filter>'.length))
  129. ? '<ogc:Filter>' + query['Filter'] + '</ogc:Filter>'
  130. : query['Filter']
  131. ;
  132. link += '&Filter=' + ogcFilter
  133. }
  134. if ('ogc:Filter' in query && 'string' === typeof query['ogc:Filter']) {
  135. var headerOgcFilter = '<GetFeature xmlns="http://www.opengis.net/wfs/2.0"' +
  136. ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
  137. ' xmlns:ogc="http://www.opengis.net/ogc"' +
  138. ' xmlns:wfs="http://www.opengis.net/wfs"' +
  139. ' service="WFS"' +
  140. ' version="2.0.2"' + '>'
  141. if ('<GetFeature' === query['ogc:Filter'].substr(0, '<GetFeature'.length)) {
  142. postData = query['ogc:Filter']
  143. } else if ('<ogc:Filter>' === query['ogc:Filter'].substr(0, '<ogc:Filter>'.length)) {
  144. postData = headerOgcFilter + '<wfs:Query>' + query['ogc:Filter'] + '</wfs:Query>' + '</GetFeature>'
  145. } else if ('<wfs:Query>' === query['ogc:Filter'].substr(0, '<wfs:Query>'.length)) {
  146. postData = headerOgcFilter + query['ogc:Filter'] + '</GetFeature>'
  147. } else {
  148. return Promise.reject(new Error('Wrong syntax ogc:Filter'))
  149. }
  150. }
  151. if ('graphql:query' in query && 'string' === typeof query['graphql:query']) { // TODO: http://graphql.org/learn/queries/
  152. link += '&outputFormat=json'
  153. postData = query['graphql:query']
  154. }
  155. if ('sortBy' in query) link += '&sortBy=' + query['sortBy']
  156. if ('maxFeatures' in query) link += '&maxFeatures=' + query['maxFeatures']
  157. if ('count' in query) link += '&count=' + query['count']
  158. if ('startIndex' in query) link += '&startIndex=' + query['startIndex']
  159. if ('primaryKey' in query) link += '&primaryKey=' + query['primaryKey']
  160. if ('resolveDepth' in query && !('resolve' in query)) return Promise.reject(new Error('ResolveDepth set but missing resolve="all"'))
  161. if ('resolve' in query) link += '&resolve=' + query['resolve']
  162. if ('resolveDepth' in query) link += '&resolveDepth=' + query['resolveDepth']
  163. if ('xlink' in query) link += '&xlink=' + query['xlink'] // NOTE: replace '#' to '/'
  164. if ('root' in query) link += '&root=' + query['root'] // NOTE: require admin perms (admin level 0)
  165. if ('backRefNS' in query && 'backRefPK' in query && 'backRefField' in query) {
  166. link += '&backRefNS=' + query['backRefNS']
  167. link += '&backRefPK=' + query['backRefPK']
  168. link += '&backRefField=' + query['backRefField']
  169. }
  170. var method = (postData) ? 'POST' : 'GET'
  171. return window.fetch(link, Object.assign({
  172. method: method,
  173. credentials: 'include',
  174. }, ('POST' === method)
  175. ? {
  176. body: postData
  177. }
  178. : {}
  179. )).then(function (response) {
  180. return response.text()
  181. }).then(function (responseText) {
  182. return (new DOMParser()).parseFromString(responseText, "text/xml");
  183. }).then(function (xmlResponse) {
  184. if (!xmlResponse.children.length) throw "Missing response xml root element"
  185. return xmlResponse.children[0]
  186. }).then(function (xmlRoot) {
  187. if ('html' === xmlRoot.localName) {
  188. console.log(xmlRoot) // html / body / parseerror / div
  189. throw "Parse xml error"
  190. }
  191. if ('FeatureCollection' !== xmlRoot.localName) {
  192. if ('ServiceExceptionReport' === xmlRoot.tagName) {
  193. if (xmlRoot.children[0] && xmlRoot.children[0].textContent) throw xmlRoot.children[0].textContent
  194. throw "WFS API Exception"
  195. }
  196. throw "Missing FeatureCollection as root element in wfs response"
  197. }
  198. var features = []
  199. for (var i = 0; i < xmlRoot.children.length; i++) {
  200. features.push(p5WFS_ParseFeatureMember(xmlRoot.children[i]))
  201. }
  202. return features.filter(function (item) { return !!item; })
  203. })
  204. }
  205. global.p5WFS_ParseFeatureMember = p5WFS_ParseFeatureMember
  206. global.p5WFS_ParseFeatureFieldRecurse = p5WFS_ParseFeatureFieldRecurse
  207. global.p5WFS_GetFeature = p5WFS_GetFeature