Index: /branches/PublicaMundi_David_integration_01-devel/debian/changelog =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/changelog (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/changelog (revision 672) @@ -0,0 +1,20 @@ +zoo-project (1.4~devel01) UNRELEASED; urgency=low + + * Added Gdal ZOO Services + * Added Cgal ZOO Services + * Added WPS Status Services + + -- David Saggiorato Fri, 31 Oct 2014 17:54:34 +0100 + +zoo-project (1.3.0-1~trusty10) trusty; urgency=low + + * Added OGR ZOO Services. + + -- Angelos Tzotsos Sun, 28 Jul 2014 19:48:00 +0200 + +zoo-project (1.3.0-1~trusty7) trusty; urgency=low + + * Initial Debian packaging. + + -- Angelos Tzotsos Tue, 10 Jun 2014 21:17:04 +0200 + Index: /branches/PublicaMundi_David_integration_01-devel/debian/compat =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/compat (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/compat (revision 672) @@ -0,0 +1,1 @@ +9 Index: /branches/PublicaMundi_David_integration_01-devel/debian/control =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/control (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/control (revision 672) @@ -0,0 +1,49 @@ +Source: zoo-project +Maintainer: Angelos Tzotsos +Section: web +Priority: optional +Build-Depends: debhelper (>= 9), + dpkg-dev (>= 1.16.1.1), + autoconf, + automake, + autotools-dev, + flex, + bison, + libssl-dev, + libcurl4-gnutls-dev, + libcgic-dev (>= 2.06), + libgdal-dev, + python-all (>= 2.6.6-3~) | python-dev, + libfcgi-dev, + libxml2-dev, + libxslt1-dev, + libcgal-dev, + libmozjs185-dev, +Build-Conflicts: libcurl3-openssl-dev +Standards-Version: 3.9.3 +X-Python-Version: >= 2.7 +Homepage: http://zoo-project.org + +Package: zoo-kernel +Architecture: any +Section: web +Depends: ${shlibs:Depends}, + ${misc:Depends} +Description: This package contains the CGI ZOO Kernel + . + ZOO is a WPS (Web Processing Service) open source project released + under a MIT/X-11 style license . It provides an OGC WPS compliant + developer-friendly framework to create and chain WPS Web services. + +Package: zoo-services +Architecture: any +Section: web +Depends: ${shlibs:Depends}, + ${misc:Depends}, + python (>=2.7), + python-gdal +Description: This package contains the CGI ZOO Services + . + ZOO is a WPS (Web Processing Service) open source project released + under a MIT/X-11 style license . It provides an OGC WPS compliant + developer-friendly framework to create and chain WPS Web services. Index: /branches/PublicaMundi_David_integration_01-devel/debian/copyright =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/copyright (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/copyright (revision 672) @@ -0,0 +1,37 @@ +This package was debianized by Angelos Tzotsos gcpp.kalxas@gmail.com on +Tue, 10 Jun 2014 21:17:04 +0200. + +It was downloaded from: + + http://zoo-project.org + +Upstream author: + + Gerald Fenoy + +Copyright: + + Copyright (C) 2010-2011 GeoLabs. + +License: + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, copy, + modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + Index: /branches/PublicaMundi_David_integration_01-devel/debian/rules =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/rules (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/rules (revision 672) @@ -0,0 +1,41 @@ +#!/usr/bin/make -f +# -*- makefile -*- + +%: + dh $@ + +override_dh_auto_configure: + cd zoo-project/zoo-kernel && autoconf && ./configure --with-python --with-js --with-cgi-dir=$(CURDIR)/debian/tmp/usr/lib/cgi-bin + +override_dh_auto_build: + dh_auto_build --builddirectory zoo-project/zoo-kernel + dh_auto_build --builddirectory zoo-project/zoo-services/cgal + dh_auto_build --builddirectory zoo-project/zoo-services/gdal/contour + dh_auto_build --builddirectory zoo-project/zoo-services/gdal/translate + dh_auto_build --builddirectory zoo-project/zoo-services/gdal/dem + dh_auto_build --builddirectory zoo-project/zoo-services/gdal/grid + dh_auto_build --builddirectory zoo-project/zoo-services/gdal/profile + dh_auto_build --builddirectory zoo-project/zoo-services/gdal/warp + dh_auto_build --builddirectory zoo-project/zoo-services/ogr/base-vect-ops + dh_auto_build --builddirectory zoo-project/zoo-services/ogr/ogr2ogr + dh_auto_build --builddirectory zoo-project/zoo-services/utils/status + +override_dh_auto_install: + dh_auto_install --builddirectory zoo-project/zoo-kernel + dh_auto_install --builddirectory zoo-project/zoo-services/cgal + dh_auto_install --builddirectory zoo-project/zoo-services/gdal/contour + dh_auto_install --builddirectory zoo-project/zoo-services/gdal/translate + dh_auto_install --builddirectory zoo-project/zoo-services/gdal/dem + dh_auto_install --builddirectory zoo-project/zoo-services/gdal/grid + dh_auto_install --builddirectory zoo-project/zoo-services/gdal/profile + dh_auto_install --builddirectory zoo-project/zoo-services/gdal/warp + install -d $(CURDIR)/debian/tmp/usr/lib/cgi-bin/gdal/ndvi + install $(CURDIR)/zoo-project/zoo-services/gdal/ndvi/cgi-env/* $(CURDIR)/debian/tmp/usr/lib/cgi-bin/gdal/ndvi/ + dh_auto_install --builddirectory zoo-project/zoo-services/ogr/base-vect-ops + dh_auto_install --builddirectory zoo-project/zoo-services/ogr/ogr2ogr + install -d $(CURDIR)/debian/tmp/usr/lib/cgi-bin/ogr/base-vect-ops-py + install $(CURDIR)/zoo-project/zoo-services/ogr/base-vect-ops-py/cgi-env/* $(CURDIR)/debian/tmp/usr/lib/cgi-bin/ogr/base-vect-ops-py/ + dh_auto_install --builddirectory zoo-project/zoo-services/utils/status + +#override_dh_auto_clean: +# dh_auto_clean --builddirectory zoo-project/zoo-kernel Index: /branches/PublicaMundi_David_integration_01-devel/debian/source/format =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/source/format (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/source/format (revision 672) @@ -0,0 +1,1 @@ +3.0 (native) Index: /branches/PublicaMundi_David_integration_01-devel/debian/zoo-kernel.install =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/zoo-kernel.install (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/zoo-kernel.install (revision 672) @@ -0,0 +1,3 @@ +usr/lib/cgi-bin/zoo_loader.cgi +usr/lib/cgi-bin/main.cfg +zoo-project/zoo-api/js/* usr/lib/cgi-bin/ Index: /branches/PublicaMundi_David_integration_01-devel/debian/zoo-services.install =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/debian/zoo-services.install (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/debian/zoo-services.install (revision 672) @@ -0,0 +1,9 @@ +usr/lib/cgi-bin/cgal usr/lib/cgi-bin/ +usr/lib/cgi-bin/gdal usr/lib/cgi-bin/ +usr/lib/cgi-bin/ogr usr/lib/cgi-bin/ +usr/lib/cgi-bin/demo.zcfg usr/lib/cgi-bin/ +usr/lib/cgi-bin/GetStatus.zcfg usr/lib/cgi-bin/ +usr/lib/cgi-bin/longProcess.zcfg usr/lib/cgi-bin/ +usr/lib/cgi-bin/service.py usr/lib/cgi-bin/ +usr/lib/cgi-bin/updateStatus.xsl usr/lib/cgi-bin/ +usr/lib/cgi-bin/wps_status.zo usr/lib/cgi-bin/ Index: /branches/PublicaMundi_David_integration_01-devel/docs/Makefile =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/Makefile (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/Makefile (revision 672) @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ZOOProject.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ZOOProject.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/ZOOProject" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ZOOProject" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." Index: /branches/PublicaMundi_David_integration_01-devel/docs/_static/basic.css =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_static/basic.css (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_static/basic.css (revision 672) @@ -0,0 +1,545 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 25%; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; + padding:10px; + background: #FFCD0B; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFF', endColorstr='#FFCD0B'); /* for IE */ + background:-webkit-gradient(linear, left top, left bottom, from(#FFFFFF), to(#FFCD0B)); /* for webkit browsers */ + background: -moz-linear-gradient(center top , #FFFFFF, #FFCD0B) repeat scroll 0 0 transparent; + -moz-border-radius-bottomright: 5px; +border-bottom-right-radius:5px; +-webkit-border-bottom-right-radius:5px; +-moz-border-radius-bottomleft: 5px; +border-bottom-left-radius:5px; +-webkit-border-bottom-left-radius:5px; +background:#FFFFFF; + } + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: Verdana; + font-size: 1em; +} + +img { + border: 0; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + clear: both; + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.refcount { + color: #060; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: verdana; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + + div.footer { + padding:0; + margin:0; + } + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} Index: /branches/PublicaMundi_David_integration_01-devel/docs/_static/default.css =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_static/default.css (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_static/default.css (revision 672) @@ -0,0 +1,528 @@ +/* + * default.css_t + * ~~~~~~~~~~~~~ + * + * Sphinx stylesheet -- default theme. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 14px; + background-color: #ffffff; + color: #000; + margin: 0; + padding: 0; +} + +div.document { + background-color: white; +} + +div.documentwrapper { + float: left; + width: 100%; + background:#bababa; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#bababa', endColorstr='#707070'); /* for IE */ +background:-webkit-gradient(linear, left top, left bottom, from(#bababa), to(#707070)); /* for webkit browsers */ +background:-moz-linear-gradient(top, #bababa, #707070); /* for firefox 3.6+ */ + } + +div.bodywrapper { + margin: 0 0 0 230px; + +} + +div.body { +background:#FFFFFF; + color: #333333; + padding: 10px 20px 20px 20px; +} +div.bodywrapper { + margin: 1em 25% 1em 1em; +} + + +div.footer { + color: #333333; + width: 100%; + padding:0; + text-align: center; + font-size:12px; +} + +#footer p{padding:10px 0 5px 0;} + + +div.footer a { + color: #646464; + text-decoration: underline; +} + +div.related { + background-color: #ed910d; + line-height: 30px; + color: #ffffff; +} + +div.related a { + margin: 0 0 10px 10px; + color: #ffffff; +} + +div.sphinxsidebar { + float: right; + +} + +/* -- Custom Sidebar styles ----------------------------------------------------------- */ + +.categories{ + background: #ee920c; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ee920c', endColorstr='#ffcd0b'); /* for IE */ + background:-webkit-gradient(linear, left top, left bottom, from(#ee920c), to(#ffcd0b)); /* for webkit browsers */ + background:-moz-linear-gradient(top, #ee920c, #ffcd0b); /* for firefox 3.6+ */ + font-size: 1.3em; + width: 98%; + margin-bottom: 10px; + border:0; + padding:1%; + text-shadow: 1px 1px 1px #E0E0E0; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; +} + +.twitts, .donate, #searchbox { + -moz-border-radius: 5px; + -webkit-border-radius:5px; + border-radius:5px; + background: #FFCD0B; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFF', endColorstr='#FFCD0B'); /* for IE */ + background:-webkit-gradient(linear, left top, left bottom, from(#FFFFFF), to(#FFCD0B)); /* for webkit browsers */ + background: -moz-linear-gradient(center top , #FFFFFF, #FFCD0B) repeat scroll 0 0 transparent; + border: 0 none; + height: auto; + margin-bottom: 10px; + padding: 1%; + width: 98%; +} + +.twitts img{width:180px;height:40px;} + + + +/* -- End Custom Sidebar styles ----------------------------------------------------------- */ + +div.sphinxsidebar h1, .donate h1, .twitts h1 { + font-family: Verdana, Arial, Helvetica, sans-serif; + color: #663e05; + font-size: 1.4em; + font-weight: normal; + margin: 0; + padding: 0; + margin:10px 0 10px 10px; +} + +div.sphinxsidebar h3 { + font-family: Verdana, Arial, Helvetica, sans-serif; + color: #663e05; + font-size: 1.4em; + font-weight: normal; + margin: 0; + padding: 0; + +} + +div.sphinxsidebar h3 a { + color: #5D3805; + -moz-border-radius-topright: 5px; +border-top-right-radius:5px; +-webkit-border-top-right-radius:5px; +-moz-border-radius-topleft: 5px; +border-top-left-radius:5px; +-webkit-border-top-left-radius:5px; +background:#FFFFFF; +display:block; +padding:5px; +} + +div.sphinxsidebar h4 { + font-family: 'Verdana, Arial, Helvetica, sans-serif'; + color: #663e05; + font-size: 1.3em; + font-weight: normal; + margin: 5px 0 0 0; + padding: 0; +} + +div.sphinxsidebar p { + color: #333333; +} + +div.sphinxsidebar p.topless { + margin: 5px 10px 10px 10px; +} + +div.sphinxsidebar ul { + margin: 0 0 1em 0; + + + +} + +div.sphinxsidebar a { + color: #ED910D; + text-decoration:none; +} + + +div.sphinxsidebar a p.version{ +color:#FFFFFF; +text-shadow: none; +margin:0 0 10px 10px ; +padding:0; +} + +div.sphinxsidebar input { + border: 1px solid #5F3A05; + font-family: Verdana; + font-size: 1em; + -moz-border-radius:5px; + -webkit-border-radius:5px; + border-radius:5px; +} + + + +/* -- hyperlink styles ------------------------------------------------------ */ + +a { + color: #ffac59; + text-decoration: none; +} + +a:visited { + color: #ffac59; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + + + +/* -- body styles ----------------------------------------------------------- */ + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: 'Verdana'; + background-color: #ffffff; + font-weight: normal; + color: #663e05; + margin: 20px -20px 10px -20px; + padding: 3px 0 3px 10px; +} + +div.body h1 { + font-size: 1.4em; + font-family:Verdana; + margin: 10px 0 0 0; + padding:0; + } +div.body h2 { font-size: 120%; } +div.body h3 { font-size: 100%; } +div.body h4 { font-size: 90%; } +div.body h5 { font-size: 80%; } +div.body h6 { font-size: 70%; } + +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li { + text-align: justify; + line-height: 130%; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.admonition p { + margin-bottom: 5px; +} + +div.admonition pre { + margin-bottom: 5px; +} + +div.admonition ul, div.admonition ol { + margin-bottom: 5px; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + padding: 5px; + background-color: #fff6ce; + color: #333333; + line-height: 120%; + border: 1px solid #beb899; + border-left: none; + border-right: none; +} + +tt { + background-color: #ecf0f3; + padding: 0 1px 0 1px; + font-size: 0.95em; +} + +th { + background-color: #fff6ce; +} + +.warning tt { + background: #efc2c2; +} + +.note tt { + background: #d6d6d6; +} + +.viewcode-back { + font-family: sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} + +/* Custom Menu Bar ---------------------------------------- */ + +ul.topnav { + position:relative; + top:0; + left:0; + list-style: none; + padding: 0 ; + margin: 0; + float: left; + width: 100%; + height:40px; + background: #563404; +filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#563404', endColorstr='#663e05'); /* for IE */ +background:-webkit-gradient(linear, left top, left bottom, from(#563404), to(#663e05)); /* for webkit browsers */ +background:-moz-linear-gradient(top, #563404, #663e05); /* for firefox 3.6+ */ + font-size: 1.2em; +} +ul.topnav li { + float: left; + margin: 0; + padding: 0 15px 0 0; + position: relative; /*--Declare X and Y axis base--*/ +} +ul.topnav li a{ + padding: 9px 10px 10px 20px; + color: #fff; + display: block; + text-decoration: none; + float: left; + +} +ul.topnav li a:hover{ + background: transparent; + color:#ffcd0b; +} +ul.topnav li span { /*--Drop down trigger styles--*/ + width: 17px; + height: 35px; + float: left; +} +ul.topnav li span.subhover {background-position: center bottom; cursor: pointer;} /*--Hover effect for trigger--*/ +ul.topnav li ul.subnav { + list-style: none; + position: absolute; /*--Important - Keeps subnav from affecting main navigation flow--*/ + left: 20px; top: 35px; + margin: 0; padding: 0; + display: none; + float: left; + width: 170px; + -moz-border-radius-bottomleft: 5px; + -moz-border-radius-bottomright: 5px; + -webkit-border-bottom-left-radius: 5px; + -webkit-border-bottom-right-radius: 5px; + border: 1px solid #663e05; + z-index:1000000; + + +} +ul.topnav li ul.subnav li{ + margin: 0; padding: 0; + + clear: both; + width: 125px; +} +html ul.topnav li ul.subnav li a { + font-size:.8em; + float: left; + width: 155px; + background: #663e05; + padding:5px 5px 7px 10px ; + +} +html ul.topnav li ul.subnav li a:hover { /*--Hover effect for subnav links--*/ + +} + +/* Custom Header ---------------------------------------- */ + +#wrapper { + margin: 0; + padding: 0; + width: 100%; +} + +#myheader { + color: #333; + width: 100%; + height: 180px; + margin: 0; + background: #FFFFFF ; +filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFF', endColorstr='#fff196'); /* for IE */ +background:-webkit-gradient(linear, left top, left bottom, from(#FFFFFF), to(#fff196)); /* for webkit browsers */ +background:-moz-linear-gradient(top, #FFFFFF, #fff196 ); /* for firefox 3.6+ */ +} + +.hleft{ +float:left; +margin:0; +width:380px; +height:180px; +background:url(images/zoo-title.png) no-repeat;} + +h1.title{width:290px;position:relative;top:102px;left:15px;font-size:1.4em;letter-spacing:2px;color:#727272;text-transform:uppercase;padding:5px; + background:#999999;font-weight:normal; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#e0e0e0', endColorstr='#bbbbbb'); /* for IE */ +background:-webkit-gradient(linear, left top, left bottom, from(#e0e0e0), to(#bbbbbb)); /* for webkit browsers */ +background:-moz-linear-gradient(top, #e0e0e0, #bbbbbb); /* for firefox 3.6+ */ + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + -webkit-border-radius: 5px; + border: 1px solid #d4d4d4; + text-align:center; + text-shadow: 1px 1px 1px #E0E0E0; +} + +.orange{color:#ffaa17;display:block;padding:5px;} + +.hright{ +float:right; +margin:0; +width:533px; +background:url(images/zoo-banner.png) no-repeat; +height:180px; +} + +/* Custom Footer ---------------------------------------- */ + +#footer { + clear:both; + width:99.99%; + color: #333; + background: #ffcd0b; + filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffcd0b', endColorstr='#ee920c'); /* for IE */ +background:-webkit-gradient(linear, left top, left bottom, from(#ffcd0b), to(#ee920c)); /* for webkit browsers */ +background:-moz-linear-gradient(top, #ffcd0b, #ee920c ); /* for firefox 3.6+ */ + margin: 0; + padding: 0; +} + +#footer p{ + padding: 0; + text-align: center; + margin: 0; + padding:10px 0 10px 0; + color: #676561; + font-size: 12px; +} + +#footer a{ + color: #663e05; + font-weight: bold; + text-decoration: none; + font-size: 14px; +} + +#footer .icon{ + display: none; +} + +#footer div{ + text-align: center; +} + + +#footer .menuContainer{ +width: 750px; margin-left: auto; margin-right: auto; +} + +#footer .menuItemList{ + margin-top: 1em; + float: left; + padding-left: 1em; + padding-right: 1em; + border-left: 1px dashed #563404;; +} + +#footer .menuItemList a{ + font-weight: normal; +} Index: /branches/PublicaMundi_David_integration_01-devel/docs/_static/doctools.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_static/doctools.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_static/doctools.js (revision 672) @@ -0,0 +1,247 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilties for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +} + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * small function to check if an array contains + * a given item. + */ +jQuery.contains = function(arr, item) { + for (var i = 0; i < arr.length; i++) { + if (arr[i] == item) + return true; + } + return false; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('
  • ' + _('Hide Search Matches') + '
    • ') + .appendTo($('.sidebar .this-page-menu')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); Index: /branches/PublicaMundi_David_integration_01-devel/docs/_static/jquery.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_static/jquery.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_static/jquery.js (revision 672) @@ -0,0 +1,154 @@ +/*! + * jQuery JavaScript Library v1.4.2 + * http://jquery.com/ + * + * Copyright 2010, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2010, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Sat Feb 13 22:33:48 2010 -0500 + */ +(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, +Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& +(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, +a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== +"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, +function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
    a"; +var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, +parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= +false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= +s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, +applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; +else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, +a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== +w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, +cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= +c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); +a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, +function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); +k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), +C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= +e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& +f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; +if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", +e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, +"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, +d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, +e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); +t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| +g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, +CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, +g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, +text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, +setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= +h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== +"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, +h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& +q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; +if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

    ";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); +(function(){var g=s.createElement("div");g.innerHTML="
    ";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: +function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= +{},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== +"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", +d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? +a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== +1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
    ","
    "],thead:[1,"","
    "],tr:[2,"","
    "],td:[3,"","
    "],col:[2,"","
    "],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
    ","
    "];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= +c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, +wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, +prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, +this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); +return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, +""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); +return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", +""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= +c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? +c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= +function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= +Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, +"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= +a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= +a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== +"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
    ").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, +serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), +function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, +global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& +e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? +"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== +false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= +false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", +c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| +d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); +g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== +1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== +"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; +if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== +"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| +c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; +this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= +this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, +e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
    "; +a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); +c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, +d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- +f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": +"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in +e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); Index: /branches/PublicaMundi_David_integration_01-devel/docs/_static/pygments.css =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_static/pygments.css (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_static/pygments.css (revision 672) @@ -0,0 +1,62 @@ +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #303030 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ Index: /branches/PublicaMundi_David_integration_01-devel/docs/_static/searchtools.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_static/searchtools.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_static/searchtools.js (revision 672) @@ -0,0 +1,518 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilties for the full-text search. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words, hlwords is the list of normal, unstemmed + * words. the first one is used to find the occurance, the + * latter for highlighting it. + */ + +jQuery.makeSearchSummary = function(text, keywords, hlwords) { + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('
    ').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlighted'); + }); + return rv; +} + +/** + * Porter Stemmer + */ +var PorterStemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + loadIndex : function(url) { + $.ajax({type: "GET", url: url, data: null, success: null, + dataType: "script", cache: true}); + }, + + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (var i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

    ' + _('Searching') + '

    ').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

    ').appendTo(this.out); + this.output = $('
      ').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.deferQuery(query); + }, + + query : function(query) { + var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in', + 'if', 'for', 'no', 'there', 'their', 'was', 'is', + 'be', 'to', 'that', 'but', 'they', 'not', 'such', + 'with', 'by', 'a', 'on', 'these', 'of', 'will', + 'this', 'near', 'the', 'or', 'at']; + + // stem the searchterms and add them to the correct list + var stemmer = new PorterStemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = query.split(/\s+/); + var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; + for (var i = 0; i < tmp.length; i++) { + if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || + tmp[i] == "") { + // skip this "word" + continue; + } + // stem the word + var word = stemmer.stemWord(tmp[i]).toLowerCase(); + // select the correct list + if (word[0] == '-') { + var toAppend = excluded; + word = word.substr(1); + } + else { + var toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$.contains(toAppend, word)) + toAppend.push(word); + }; + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + // console.debug('SEARCH: searching for:'); + // console.info('required: ', searchterms); + // console.info('excluded: ', excluded); + + // prepare search + var filenames = this._index.filenames; + var titles = this._index.titles; + var terms = this._index.terms; + var objects = this._index.objects; + var objtypes = this._index.objtypes; + var objnames = this._index.objnames; + var fileMap = {}; + var files = null; + // different result priorities + var importantResults = []; + var objectResults = []; + var regularResults = []; + var unimportantResults = []; + $('#search-progress').empty(); + + // lookup as object + if (object != null) { + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + match = objects[prefix][name]; + descr = objnames[match[1]] + _(', in ') + titles[match[0]]; + // XXX the generated anchors are not generally correct + // XXX there may be custom prefixes + result = [filenames[match[0]], fullname, '#'+fullname, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + + // perform the search on the required terms + for (var i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + // no match but word was a required one + if ((files = terms[word]) == null) + break; + if (files.length == undefined) { + files = [files]; + } + // create the mapping + for (var j = 0; j < files.length; j++) { + var file = files[j]; + if (file in fileMap) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (var file in fileMap) { + var valid = true; + + // check if all requirements are matched + if (fileMap[file].length != searchterms.length) + continue; + + // ensure that none of the excluded terms is in the + // search result. + for (var i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + $.contains(terms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it + // to the result list + if (valid) + regularResults.push([filenames[file], titles[file], '', null]); + } + + // delete unused variables in order to not waste + // memory until list is retrieved completely + delete filenames, titles, terms; + + // now sort the regular results descending by title + regularResults.sort(function(a, b) { + var left = a[1].toLowerCase(); + var right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + }); + + // combine all results + var results = unimportantResults.concat(regularResults) + .concat(objectResults).concat(importantResults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('
    • '); + if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { + // dirhtml builder + var dirname = item[0] + '/'; + if (dirname.match(/\/index\/$/)) { + dirname = dirname.substring(0, dirname.length-6); + } else if (dirname == 'index/') { + dirname = ''; + } + listItem.append($('').attr('href', + DOCUMENTATION_OPTIONS.URL_ROOT + dirname + + highlightstring + item[2]).html(item[1])); + } else { + // normal html builders + listItem.append($('').attr('href', + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + + highlightstring + item[2]).html(item[1])); + } + if (item[3]) { + listItem.append($(' (' + item[3] + ')')); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + + item[0] + '.txt', function(data) { + if (data != '') { + listItem.append($.makeSearchSummary(data, searchterms, hlterms)); + Search.output.append(listItem); + } + listItem.slideDown(5, function() { + displayNextItem(); + }); + }); + } else { + // no source available, just display title + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + } +} + +$(document).ready(function() { + Search.init(); +}); Index: /branches/PublicaMundi_David_integration_01-devel/docs/_static/sidebar.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_static/sidebar.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_static/sidebar.js (revision 672) @@ -0,0 +1,148 @@ +/* + * sidebar.js + * ~~~~~~~~~~ + * + * This script makes the Sphinx sidebar collapsible. + * + * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds + * in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton + * used to collapse and expand the sidebar. + * + * When the sidebar is collapsed the .sphinxsidebarwrapper is hidden + * and the width of the sidebar and the margin-left of the document + * are decreased. When the sidebar is expanded the opposite happens. + * This script saves a per-browser/per-session cookie used to + * remember the position of the sidebar among the pages. + * Once the browser is closed the cookie is deleted and the position + * reset to the default (expanded). + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +$(function() { + // global elements used by the functions. + // the 'sidebarbutton' element is defined as global after its + // creation, in the add_sidebar_button function + var bodywrapper = $('.bodywrapper'); + var sidebar = $('.sphinxsidebar'); + var sidebarwrapper = $('.sphinxsidebarwrapper'); + + // original margin-left of the bodywrapper and width of the sidebar + // with the sidebar expanded + var bw_margin_expanded = bodywrapper.css('margin-left'); + var ssb_width_expanded = sidebar.width(); + + // margin-left of the bodywrapper and width of the sidebar + // with the sidebar collapsed + var bw_margin_collapsed = '.8em'; + var ssb_width_collapsed = '.8em'; + + // colors used by the current theme + var dark_color = $('.related').css('background-color'); + var light_color = $('.document').css('background-color'); + + function sidebar_is_collapsed() { + return sidebarwrapper.is(':not(:visible)'); + } + + function toggle_sidebar() { + if (sidebar_is_collapsed()) + expand_sidebar(); + else + collapse_sidebar(); + } + + function collapse_sidebar() { + sidebarwrapper.hide(); + sidebar.css('width', ssb_width_collapsed); + bodywrapper.css('margin-left', bw_margin_collapsed); + sidebarbutton.css({ + 'margin-left': '0', + 'height': bodywrapper.height() + }); + sidebarbutton.find('span').text('»'); + sidebarbutton.attr('title', _('Expand sidebar')); + document.cookie = 'sidebar=collapsed'; + } + + function expand_sidebar() { + bodywrapper.css('margin-left', bw_margin_expanded); + sidebar.css('width', ssb_width_expanded); + sidebarwrapper.show(); + sidebarbutton.css({ + 'margin-left': ssb_width_expanded-12, + 'height': bodywrapper.height() + }); + sidebarbutton.find('span').text('«'); + sidebarbutton.attr('title', _('Collapse sidebar')); + document.cookie = 'sidebar=expanded'; + } + + function add_sidebar_button() { + sidebarwrapper.css({ + 'float': 'left', + 'margin-right': '0', + 'width': ssb_width_expanded - 28 + }); + // create the button + sidebar.append( + '
      «
      ' + ); + var sidebarbutton = $('#sidebarbutton'); + light_color = sidebarbutton.css('background-color'); + // find the height of the viewport to center the '<<' in the page + var viewport_height; + if (window.innerHeight) + viewport_height = window.innerHeight; + else + viewport_height = $(window).height(); + sidebarbutton.find('span').css({ + 'display': 'block', + 'margin-top': (viewport_height - sidebar.position().top - 20) / 2 + }); + + sidebarbutton.click(toggle_sidebar); + sidebarbutton.attr('title', _('Collapse sidebar')); + sidebarbutton.css({ + 'color': '#FFFFFF', + 'border-left': '1px solid ' + dark_color, + 'font-size': '1.2em', + 'cursor': 'pointer', + 'height': bodywrapper.height(), + 'padding-top': '1px', + 'margin-left': ssb_width_expanded - 12 + }); + + sidebarbutton.hover( + function () { + $(this).css('background-color', dark_color); + }, + function () { + $(this).css('background-color', light_color); + } + ); + } + + function set_position_from_cookie() { + if (!document.cookie) + return; + var items = document.cookie.split(';'); + for(var k=0; k=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); +return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); +var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; +if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== +0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& +a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, +" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); +o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); Index: /branches/PublicaMundi_David_integration_01-devel/docs/_templates/index.html =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_templates/index.html (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_templates/index.html (revision 672) @@ -0,0 +1,3 @@ +{% extends "layout.html" %} +{% set title = 'Overview' %} + Index: /branches/PublicaMundi_David_integration_01-devel/docs/_templates/indexsidebar.html =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_templates/indexsidebar.html (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_templates/indexsidebar.html (revision 672) @@ -0,0 +1,20 @@ +
      +

      Download now !

      +

      ZOO Version 1.4.0

       +
      + +
      +

      Follow the ZOO

      +

      + http://a0.twimg.com/a/1291253242/images/fronts/logo_withbird_home.png +

      +
      + Index: /branches/PublicaMundi_David_integration_01-devel/docs/_templates/layout.html =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/_templates/layout.html (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/_templates/layout.html (revision 672) @@ -0,0 +1,165 @@ +{% extends "!layout.html" %} + +{% block extrahead %} + + + + {{ super() }} +{% endblock %} + +{% block header %} + +
      +
      +
      +

      Open WPS Platform

      +
      +
      +
      +
      +
      + + + {{ super() }} +{% endblock %} + +{% block footer %} + + + + {{ super() }} +{% endblock %} + +{# put the sidebar before the body #} +{% block sidebar1 %}{% endblock %} +{% block sidebar2 %}{{ sidebar() }}{% endblock %} + +{# remove second relbar, at the bottom of the page #} +{% block relbar2 %}{% endblock %} Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/classes.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/classes.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/classes.txt (revision 672) @@ -0,0 +1,38 @@ +.. _api-classes: + +Classes +======= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +The following classes are available in the ZOO API: + +.. toctree:: + :maxdepth: 2 + + zoo + zoo-bounds + zoo-feature + zoo-format + zoo-format-geojson + zoo-format-gml + zoo-format-json + zoo-format-kml + zoo-format-wkt + zoo-format-wps + zoo-geometry + zoo-geometry-collection + zoo-geometry-curve + zoo-geometry-linearring + zoo-geometry-linestring + zoo-geometry-multilinestring + zoo-geometry-multipoint + zoo-geometry-multipolygon + zoo-geometry-point + zoo-geometry-polygon + zoo-geometry-surface + zoo-process + zoo-projection + zoo-request + zoo-string Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/description.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/description.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/description.txt (revision 672) @@ -0,0 +1,43 @@ +.. _api-description: + +Description +=========== + +ZOO API is a Javascript library designed to make the WPS Process creation and chaining +easier. It works on the server-side using the Mozilla foundation `JavaScript `__ +engine, `SpiderMonkey `__. +It uses a `Proj4js `__ adaptation for server-side reprojection. It also allows to easily +convert vector formats (such as `GML `__, `KML `__, +`GeoJSON `__, etc). The API lets you orchestrate WPS +services simply and offers the ability to add logic and controls in the WPS chaining. + +Download ZOO API +---------------- + + * `zoo-api.js `__ + * `zoo-proj4js.js `__ + +ZOO API MIT/X-11 License +------------------------ + +:: + + Copyright (c) 2011 3LIZ + + Permission is hereby granted, free of charge, to any person obtaining a copy of this + software and associated documentation files (the "Software"), to deal in the Software + without restriction, including without limitation the rights to use, copy, modify, + merge, publish, distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice shall be included in all copies + or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE + LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE + OR OTHER DEALINGS IN THE SOFTWARE. + Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/examples.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/examples.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/examples.txt (revision 672) @@ -0,0 +1,54 @@ +.. _api-examples: + +Examples +======== + +In this page you can find some small examples on how to use the JavaScript ZOO-API +on the server side. + +ZOO-API contains many classes and functions. You can find the description list :ref:`here `. + +ZOO.Process example of use +-------------------------- + +:: + + function SampleService(conf,inputs,outputs){ + var myProcess = new ZOO.Process('http://localhost/cgi-bin-new1/zoo_loader_new1.cgi','Boundary'); + var myInputs = {InputPolygon: { type: 'complex', value: '{"type":"Polygon","coordinates":[[[-106.993853,35.998758],[-107.407233,35.997524],[-107.430525,35.997726],[-107.4824,35.99878],[-108.37013,35.999472],[-109.043633,35.996652],[-109.096265,35.997817],[-109.148763,36.001751],[-109.200981,36.008442],[-109.252775,36.017871],[-109.304,36.030014],[-109.354516,36.044835],[-106.468201,35.991497],[-106.855511,35.989504],[-106.90933,35.990676],[-106.963008,35.994743],[-106.993853,35.998758]]]}', mimeType: "application/json"} }; + var myExecuteResult=myProcess.Execute(myInputs); + return {result: ZOO.SERVICE_SUCCEEDED, outputs: [ {name:"Result", value: myExecuteResult} ] }; + } + +In this really short example you can see how to create ``ZOO.Process`` class instance and +call the Execute method on such an instance. Then you'll just need to return a JavaScript +object containing the attributes result and outputs, which I'm sure you already know +what is about. The first is about the status of the process (can be ``ZOO.SERVICE_SUCEEDED``, +``ZOO.SERVICE_FAILED`` and so on), the last is obviously the resulting maps (take a +look at the maps internal data structure used by ZOO Kernel in ``service.h``). + +ZOO.UpdateStatus +---------------- + +:: + + function SampleLongService(conf,inputs,outputs){ + var my_i=0; + while(my_i<100){ + try{ + conf["lenv"]["status"]=my_i; + } + catch(e){ + } + ZOOUpdateStatus(conf,my_i); + SampleService(conf,inputs,outputs); + my_i+=10; + } + return SampleService(conf,inputs,outputs); + } + +You can see in this sample code how to use the ``ZOOUpdateStatus`` function to update the +current status of your running process. This information will be really helpfull when the +ZOO Kernel will run your JavaScript Service in background mode (if the user set to ``true`` +the ``storeExecuteResponse`` parameter in his request). + Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/index.txt (revision 672) @@ -0,0 +1,14 @@ +.. _api: + +ZOO API Documentation +===================== + +The following sections will assist you with the ZOO API: + +.. toctree:: + :maxdepth: 2 + + description + classes + examples + Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-bounds.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-bounds.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-bounds.txt (revision 672) @@ -0,0 +1,254 @@ +.. _api-zoo-bounds: + +ZOO.Bounds +========== + +Instances of this class represent bounding boxes. + +Properties +---------- + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`left ` + - {Number} Minimum horizontal coordinate. + * - :ref:`bottom ` + - {Number} Minimum vertical coordinate. + * - :ref:`right ` + - {Number} Maximum horizontal coordinate. + * - :ref:`top ` + - {Number} Maximum vertical coordinate. + +Functions +--------- + +.. list-table:: + :widths: 20 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Bounds ` + - Construct a new bounds object. + * - :ref:`clone ` + - Create a cloned instance of this bounds. + * - :ref:`equals ` + - Test a two bounds for equivalence. + * - :ref:`toString ` + - {String} String representation of bounds object. + * - :ref:`toBBOX ` + - + * - :ref:`toGeometry ` + - Create a new polygon geometry based on this bounds. + * - :ref:`getWidth ` + - {Float} The width of the bounds + * - :ref:`getHeight ` + - {Float} The height of the bounds (top minus bottom) + * - :ref:`add ` + - + * - :ref:`extend ` + - Extend the bounds to include the point, lonlat, or bounds specified. + * - :ref:`intersectsBounds ` + - Determine whether the target bounds intersects this bounds. + * - :ref:`containsBounds ` + - Determine whether the target bounds is contained within this bounds. + +**Properties** + +.. _left: + +left + ``{Number}`` Minimum horizontal coordinate. + +.. _bottom: + +bottom + ``{Number}`` Minimum vertical coordinate. + +.. _right: + +right + ``{Number}`` Maximum horizontal coordinate. + +.. _top: + +top + ``{Number}`` Maximum vertical coordinate. + +**Functions** + +.. _ZOO.Bounds: + +ZOO.Bounds + Construct a new bounds object. + + *Parameters* + + | ``left {Number}`` The left bounds of the box. Note that for width calculations, this is assumed to be less than the right value. + | ``bottom {Number}`` The bottom bounds of the box. Note that for height calculations, this is assumed to be more than the top value. + | ``right {Number}`` The right bounds. + | ``top {Number}`` The top bounds. + +.. _clone: + +clone + :: + + clone:function() + + Create a cloned instance of this bounds. + + *Returns* + + :ref:`{ZOO.Bounds} ` A fresh copy of the bounds + +.. _equals: + +equals + :: + + equals:function(bounds) + + Test a two bounds for equivalence. + + *Parameters* + + | ``bounds {ZOO.Bounds}`` + + *Returns* + + ``{Boolean}`` The passed-in bounds object has the same left, right, top, bottom components as this. Note + that if bounds passed in is null, returns false. + +.. _toString: + +toString + :: + + toString:function() + + *Returns* + + ``{String}`` String representation of bounds object. (ex. *"left-bottom=(5,42) right-top=(10,45)"*) + +.. _toBBOX: + +toBBOX + :: + + toBBOX:function(decimal) + + *Parameters* + + ``decimal {Integer}`` How many significant digits in the bbox coords? Default is 6 + + *Returns* + + ``{String}`` Simple String representation of bounds object. (ex. *"5,42,10,45"*) + +.. _toGeometry: + +toGeometry + :: + + toGeometry: function() + + Create a new polygon geometry based on this bounds. + + *Returns* + + :ref:`{ZOO.Geometry.Polygon} ` A new polygon with the coordinates of this bounds. + +.. _getWidth: + +getWidth + :: + + getWidth:function() + + *Returns* + + ``{Float}`` The width of the bounds + +.. _getHeight: + +getHeight + :: + + getHeight:function() + + *Returns* + + ``{Float}`` The height of the bounds (top minus bottom). + +.. _add: + +add + :: + + add:function(x,y) + + *Parameters* + + | ``x {Float}`` + | ``y {Float}`` + + *Returns* + + :ref:`{ZOO.Bounds} ` A new bounds whose coordinates are the same as this, but shifted by the passed-in x and y values. + +.. _extend: + +extend + :: + + extend:function(object) + + Extend the bounds to include the point, lonlat, or bounds specified. Note, this function assumes that left + < right and bottom < top. + + *Parameters* + + ``object {Object}`` Can be Point, or Bounds. + +.. _intersectsBounds: + +intersectsBounds + :: + + intersectsBounds:function(bounds,inclusive) + + Determine whether the target bounds intersects this bounds. Bounds are considered intersecting if any + of their edges intersect or if one bounds contains the other. + + *Parameters* + + | ``bounds`` :ref:`{ZOO.Bounds} ` The target bounds. + | ``inclusive {Boolean}`` Treat coincident borders as intersecting. Default is true. If false, bounds that do not overlap but only touch at the border will not be considered as intersecting. + + *Returns* + + ``{Boolean}`` The passed-in bounds object intersects this bounds. + +.. _containsBounds: + +containsBounds + :: + + containsBounds:function(bounds,partial,inclusive) + + Determine whether the target bounds is contained within this bounds. + + *Parameters* + + | ``bounds`` :ref:`{ZOO.Bounds} ` The target bounds. + | ``partial {Boolean}`` If any of the target corners is within this bounds consider the bounds contained. Default is false. If true, the entire target bounds must be contained within this bounds. + | ``inclusive {Boolean}`` Treat shared edges as contained. Default is true. + + *Returns* + + ``{Boolean}`` The passed-in bounds object is contained within this bounds. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-feature.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-feature.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-feature.txt (revision 672) @@ -0,0 +1,107 @@ +.. _api-zoo-feature: + +ZOO.Feature +=========== + +Vector features use the ZOO.Geometry classes as geometry description. + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`fid ` + - {String} + * - :ref:`geometry ` + - {ZOO.Geometry} + * - :ref:`attributes ` + - {Object} This object holds arbitrary properties that describe the feature. + * - :ref:`bounds ` + - {ZOO.Bounds} The box bounding that feature's geometry, that property can be set by an ZOO.Format object when deserializing the feature, so in most cases it represents an information set by the server. + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Feature ` + - Create a vector feature. + * - :ref:`destroy ` + - nullify references to prevent circular references and memory leaks + * - :ref:`clone ` + - Create a clone of this vector feature. + * - :ref:`move ` + - Moves the feature and redraws it at its new location + + +**Properties** + +.. _fid: + +fid + ``{String}`` + +.. _geometry: + +geometry + :ref:`{ZOO.Geometry} ` + +.. _attributes: + +attributes + ``{Object}`` This object holds arbitrary properties that describe the feature. + +.. _bounds: + +bounds + :ref:`{ZOO.Bounds} ` The box bounding that feature's geometry, that + property can be set by an ZOO.Format object when deserializing the feature, so in most cases + it represents an information set by the server. + +**Functions** + +.. _ZOO.Feature: + +ZOO.Feature + Create a vector feature. + + + *Parameters* + + | ``geometry`` :ref:`{ZOO.Geometry} ` The geometry that this feature represents. + | ``attributes {Object}`` An optional object that will be mapped to the attributes property. + +.. _destroy: + +destroy + :: + + destroy: function() + + nullify references to prevent circular references and memory leaks + +.. _clone: + +clone + :: + + clone: function () + + Create a clone of this vector feature. Does not set any non-standard properties. + + *Returns* + + :ref:`{ZOO.Feature} ` An exact clone of this vector feature. + +.. _move: + +move + Moves the feature and redraws it at its new location Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-geojson.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-geojson.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-geojson.txt (revision 672) @@ -0,0 +1,455 @@ +.. _api-zoo-format-geojson: + +ZOO.Format.GeoJSON +================== + +Read and write GeoJSON. + +Inherits from + +- :ref:`ZOO.Format.JSON ` + +Properties +---------- + +.. list-table:: + :widths: 20 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Format.GeoJSON ` + - Create a new parser for GeoJSON. + * - :ref:`read ` + - Deserialize a GeoJSON string. + * - :ref:`isValidType ` + - Check if a GeoJSON object is a valid representative of the given type. + * - :ref:`parseFeature ` + - Convert a feature object from GeoJSON into an ZOO.Feature. + * - :ref:`parseGeometry ` + - Convert a geometry object from GeoJSON into an ZOO.Geometry. + +parseCoords Properties +---------------------- + +.. list-table:: + :widths: 20 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`parseCoords ` + - Object with properties corresponding to the GeoJSON geometry types. + +parseCoords Functions +--------------------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`parseCoords.point ` + - Convert a coordinate array from GeoJSON into an ZOO.Geometry.Point. + * - :ref:`parseCoords.multipoint ` + - Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPoint. + * - :ref:`parseCoords.linestring ` + - Convert a coordinate array from GeoJSON into an ZOO.Geometry.LineString. + * - :ref:`parseCoords.multilinestring ` + - Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiLineString. + * - :ref:`parseCoords.polygon ` + - Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon. + * - :ref:`parseCoords.multipolygon ` + - Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPolygon. + * - :ref:`parseCoords.box ` + - Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon. + * - :ref:`write ` + - Serialize a feature, geometry, array of features into a GeoJSON string. + * - :ref:`createCRSObject ` + - Create the CRS object for an object. + +extract Properties +------------------ + +.. list-table:: + :widths: 20 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`extract ` + - Object with properties corresponding to the GeoJSON types. + +extract Functions +----------------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`extract.feature ` + - Return a partial GeoJSON object representing a single feature. + * - :ref:`extract.geometry ` + - Return a GeoJSON object representing a single geometry. + * - :ref:`extract.point ` + - Return an array of coordinates from a point. + * - :ref:`extract.multipoint ` + - Return an array of coordinates from a multipoint. + * - :ref:`extract.linestring ` + - Return an array of coordinate arrays from a linestring. + * - :ref:`extract.multilinestring ` + - Return an array of linestring arrays from a linestring. + * - :ref:`extract.polygon ` + - Return an array of linear ring arrays from a polygon. + * - :ref:`extract.multipolygon ` + - Return an array of polygon arrays from a multipolygon. + * - :ref:`extract.collection ` + - Return an array of geometries from a geometry collection. + +**Functions** + +.. _ZOO.Format.GeoJSON: + +ZOO.Format.GeoJSON + Create a new parser for GeoJSON. + + + *Parameters* + + ``options {Object}`` An optional object whose properties will be set on this instance. + +.. _read: + +read + :: + + read: function(json,type,filter) + + Deserialize a GeoJSON string. + + *Parameters* + + | ``json {String}`` A GeoJSON string + | ``type {String}`` Optional string that determines the structure of the output. Supported values are "Geometry", "Feature", and "FeatureCollection". If absent or null, a default of "FeatureCollection" is assumed. + | ``filter {Function}`` A function which will be called for every key and value at every level of the final result. Each value will be replaced by the result of the filter function. This can be used to reform generic objects into instances of classes, or to transform date strings into Date objects. + + *Returns* + + ``{Object}`` The return depends on the value of the type argument. If type is "FeatureCollection" (the default), + the return will be an array of :ref:`ZOO.Feature `. If type is "Geometry", the input json must + represent a single geometry, and the return will be an :ref:`ZOO.Geometry `. If type + is "Feature", the input json must represent a single feature, and the return will be an :ref:`ZOO.Feature `. + +.. _isValidType: + +isValidType + :: + + isValidType: function(obj,type) + + Check if a GeoJSON object is a valid representative of the given type. + + *Returns* + + ``{Boolean}`` The object is valid GeoJSON object of the given type. + +.. _parseFeature: + +parseFeature + :: + + parseFeature: function(obj) + + Convert a feature object from GeoJSON into a :ref:`ZOO.Feature `. + + *Parameters* + + ``obj {Object}`` An object created from a GeoJSON object + + *Returns* + + :ref:`{ZOO.Feature} ` A feature. + +.. _parseGeometry: + +parseGeometry + :: + + parseGeometry: function(obj) + + Convert a geometry object from GeoJSON into a :ref:`ZOO.Geometry `. + + *Parameters* + + ``obj {Object}`` An object created from a GeoJSON object + + *Returns* + + :ref:`{ZOO.Geometry} ` A geometry. + +**parseCoords Properties** + +.. _parseCoords: + +parseCoords + Object with properties corresponding to the GeoJSON geometry types. Property + values are functions that do the actual parsing. + +**parseCoords Functions** + +.. _parseCoords.point: + +parseCoords.point + Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.Point `. + + *Parameters* + + ``array {Object}`` The coordinates array from the GeoJSON fragment. + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` A geometry. + +.. _parseCoords.multipoint: + +parseCoords.multipoint + Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.MultiPoint `. + + *Parameters* + + ``array {Object}`` The coordinates array from the GeoJSON fragment. + + *Returns* + + :ref:`{ZOO.Geometry.MultiPoint} ` A geometry. + +.. _parseCoords.linestring: + +parseCoords.linestring + Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.LineString `. + + *Parameters* + + ``array {Object}`` The coordinates array from the GeoJSON fragment. + + *Returns* + + :ref:`{ZOO.Geometry.LineString} ` A geometry. + +.. _parseCoords.multilinestring: + +parseCoords.multilinestring + Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.MultiLineString `. + + *Parameters* + + ``array {Object}`` The coordinates array from the GeoJSON fragment. + + *Returns* + + :ref:`{ZOO.Geometry.MultiLineString} ` A geometry. + +.. _parseCoords.polygon: + +parseCoords.polygon + Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.Polygon `. + + *Parameters* + + ``array {Object}`` The coordinates array from the GeoJSON fragment. + + *Returns* + + :ref:`{ZOO.Geometry.Polygon} ` A geometry. + +.. _parseCoords.multipolygon: + +parseCoords.multipolygon + Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.MultiPolygon `. + + *Parameters* + + ``array {Object}`` The coordinates array from the GeoJSON fragment. + + *Returns* + + :ref:`{ZOO.Geometry.MultiPolygon} ` A geometry. + +.. _parseCoords.box: + +parseCoords.box + Convert a coordinate array from GeoJSON into a :ref:`ZOO.Geometry.Polygon `. + + *Parameters* + + ``array {Object}`` The coordinates array from the GeoJSON fragment. + + *Returns* + + :ref:`{ZOO.Geometry.Polygon} ` A geometry. + +.. _write: + +write + :: + + write: function(obj,pretty) + + Serialize a feature, geometry, array of features into a GeoJSON string. + + *Parameters* + + | ``obj {Object}`` A :ref:`{ZOO.Feature} `, :ref:`{ZOO.Geometry} `, or an array of features. + | ``pretty {Boolean}`` Structure the output with newlines and indentation. Default is false. + + *Returns* + + ``{String}`` The GeoJSON string representation of the input geometry, features, or array of features. + +.. _createCRSObject: + +createCRSObject + :: + + createCRSObject: function(object) + + Create the CRS object for an object. + + *Parameters* + + ``object`` :ref:`{ZOO.Feature} ` + + *Returns* + + ``{Object}`` An object which can be assigned to the crs property of a GeoJSON object. + +**extract Properties** + +.. _extract: + +extract + Object with properties corresponding to the GeoJSON types. Property values are + functions that do the actual value extraction. + +**extract Functions** + +.. _extract.feature: + +extract.feature + Return a partial GeoJSON object representing a single feature. + + + *Parameters* + + ``feature`` :ref:`{ZOO.Feature} ` + + *Returns* + + ``{Object}`` An object representing the point. + +.. _extract.geometry: + +extract.geometry + Return a GeoJSON object representing a single geometry. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` + + *Returns* + + ``{Object}`` An object representing the geometry. + +.. _extract.point: + +extract.point + Return an array of coordinates from a point. + + *Parameters* + + ``point`` :ref:`{ZOO.Geometry.Point} ` + + *Returns* + + ``{Array}`` An array of coordinates representing the point. + +.. _extract.multipoint: + +extract.multipoint + Return an array of coordinates from a multipoint. + + *Parameters* + + ``multipoint`` :ref:`{ZOO.Geometry.MultiPoint} ` + + *Returns* + + ``{Array}`` An array of point coordinate arrays representing the multipoint. + +.. _extract.linestring: + +extract.linestring + Return an array of coordinate arrays from a linestring. + + *Parameters* + + ``linestring`` :ref:`{ZOO.Geometry.LineString} ` + + *Returns* + + ``{Array}`` An array of coordinate arrays representing the linestring. + +.. _extract.multilinestring: + +extract.multilinestring + Return an array of linestring arrays from a linestring. + + *Parameters* + + ``multilinestring`` :ref:`{ZOO.Geometry.MultiLineString} ` + + *Returns* + + ``{Array}`` An array of linestring arrays representing the multilinestring. + +.. _extract.polygon: + +extract.polygon + Return an array of linear ring arrays from a polygon. + + *Parameters* + + ``polygon`` :ref:`{ZOO.Geometry.Polygon} ` + + *Returns* + + ``{Array}`` An array of linear ring arrays representing the polygon. + +.. _extract.multipolygon: + +extract.multipolygon + Return an array of polygon arrays from a multipolygon. + + *Parameters* + + ``multipolygon`` :ref:`{ZOO.Geometry.MultiPolygon} ` + + *Returns* + + ``{Array}`` An array of polygon arrays representing the multipolygon + +.. _extract.collection: + +extract.collection + Return an array of geometries from a geometry collection. + + *Parameters* + + ``collection`` :ref:`{ZOO.Geometry.Collection} ` + + *Returns* + + ``{Array}`` An array of geometry objects representing the geometry collection. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-gml.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-gml.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-gml.txt (revision 672) @@ -0,0 +1,446 @@ +.. _api-zoo-format-gml: + +ZOO.Format.GML +============== + +Read/Write GML. + +Inherits from + +- :ref:`ZOO.Format ` + +Properties and Functions +------------------------ + +.. list-table:: + :widths: 20 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`schemaLocation ` + - {String} Schema location for a particular minor version. + * - :ref:`namespaces ` + - {Object} Mapping of namespace aliases to namespace URIs. + * - :ref:`defaultPrefix ` + - + * - :ref:`collectionName ` + - {String} Name of featureCollection element. + * - :ref:`featureName ` + - {String} Element name for features. + * - :ref:`geometryName ` + - {String} Name of geometry element. + * - :ref:`xy ` + - {Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated. + * - :ref:`extractAttributes ` + - {Boolean} Could we extract attributes + * - :ref:`ZOO.Format.GML ` + - Create a new parser for GML. + * - :ref:`read ` + - Read data from a string, and return a list of features. + * - :ref:`parseFeature ` + - This function is the core of the GML parsing code in ZOO. + * - :ref:`parseGeometry ` + - Properties of this object are the functions that parse geometries based on their type. + * - :ref:`parseGeometry.point ` + - Given a GML node representing a point geometry, create a ZOO point geometry. + * - :ref:`parseGeometry.multipoint ` + - Given a GML node representing a point geometry, create a ZOO multipoint geometry. + * - :ref:`parseGeometry.linestring ` + - Given a GML node representing a linestring geometry, create a ZOO linestring geometry. + * - :ref:`parseGeometry.polygon ` + - Given a GML node representing a polygon geometry, create a ZOO polygon geometry. + * - :ref:`parseGeometry.multigeometry ` + - Given a GML node representing a multigeometry, create a ZOO geometry collection. + * - :ref:`parseAttributes ` + - + * - :ref:`parseExtendedData ` + - Parse ExtendedData from GML. + * - :ref:`write ` + - Accept Feature Collection, and return a string. + * - :ref:`createFeature ` + - Accept an ZOO.Feature, and build a GML node for it. + * - :ref:`buildGeometryNode ` + - Builds and returns a GML geometry node with the given geometry. + * - :ref:`buildGeometry ` + - Object containing methods to do the actual geometry node building based on geometry type. + * - :ref:`buildGeometry.point ` + - Given a ZOO point geometry, create a GML point. + * - :ref:`buildGeometry.multipoint ` + - Given a ZOO multipoint geometry, create a GML GeometryCollection. + * - :ref:`buildGeometry.linestring ` + - Given a ZOO linestring geometry, create a GML linestring. + * - :ref:`buildGeometry.multilinestring ` + - Given a ZOO multilinestring geometry, create a GML GeometryCollection. + * - :ref:`buildGeometry.linearring ` + - Given a ZOO linearring geometry, create a GML linearring. + * - :ref:`buildGeometry.polygon ` + - Given a ZOO polygon geometry, create a GML polygon. + * - :ref:`buildGeometry.multipolygon ` + - Given a ZOO multipolygon geometry, create a GML GeometryCollection. + * - :ref:`buildGeometry.collection ` + - Given a ZOO geometry collection, create a GML MultiGeometry. + * - :ref:`buildCoordinatesNode ` + - builds the coordinates XmlNode + +.. _schemaLocation: + +schemaLocation + ``{String}`` Schema location for a particular minor version. + +.. _namespaces: + +namespaces + ``{Object}`` Mapping of namespace aliases to namespace URIs. + +.. _defaultPrefix: + +defaultPrefix + +.. _collectionName: + +collectionName + ``{String}`` Name of featureCollection element. + +.. _featureName: + +featureName + ``{String}`` Element name for features. Default is "sql_statement". + +.. _geometryName: + +geometryName + ``{String}`` Name of geometry element. Defaults to "geometryProperty". + +.. _xy: + +xy + ``{Boolean}`` Order of the GML coordinate true:(x,y) or false:(y,x) Changing is not recommended, a new Format should be instantiated. + +.. _extractAttributes: + +extractAttributes + ``{Boolean}`` Could we extract attributes + +.. _ZOO.Format.GML: + +ZOO.Format.GML + Create a new parser for GML. + + *Parameters* + + ``options {Object}`` An optional object whose properties will be set on this instance. + +.. _read: + +read + :: + + read: function(data) + + Read data from a string, and return a list of features. + + *Parameters* + + ``data {String}`` data to read/parse. + + *Returns* + + :ref:`{Array(ZOO.Feature)} ` An array of features. + +.. _parseFeature: + +parseFeature + :: + + parseFeature: function(node) + + This function is the core of the GML parsing code in ZOO. It creates the geometries + that are then attached to the returned feature, and calls parseAttributes() to get + attribute data out. + + *Parameters* + + ``node {E4XElement}`` + + *Returns* + + :ref:`{ZOO.Feature} ` A vector feature. + +.. _parseGeometry: + +parseGeometry + Properties of this object are the functions that parse geometries based on their type. + +.. _parseGeometry.point: + +parseGeometry.point + Given a GML node representing a point geometry, create a ZOO point geometry. + + *Parameters* + + ``node {E4XElement}`` A GML node. + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` A point geometry. + +.. _parseGeometry.multipoint: + +parseGeometry.multipoint + Given a GML node representing a multipoint geometry, create a ZOO multipoint geometry. + + *Parameters* + + ``node {E4XElement}`` A GML node. + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` A multipoint geometry. + +.. _parseGeometry.linestring: + +parseGeometry.linestring + Given a GML node representing a linestring geometry, create a ZOO linestring geometry. + + *Parameters* + + ``node {E4XElement}`` A GML node. + + *Returns* + + :ref:`{ZOO.Geometry.LineString} ` A linestring geometry. + +.. _parseGeometry.multilinestring: + +parseGeometry.multilinestring + Given a GML node representing a multilinestring geometry, create a ZOO multilinestring geometry. + + *Parameters* + + ``node {E4XElement}`` A GML node. + + *Returns* + + :ref:`{ZOO.Geometry.MultiLineString} ` A multilinestring geometry. + +.. _parseGeometry.polygon: + +parseGeometry.polygon + Given a GML node representing a polygon geometry, create a ZOO polygon geometry. + + *Parameters* + + ``node {E4XElement}`` A GML node. + + *Returns* + + :ref:`{ZOO.Geometry.Polygon} ` A polygon geometry. + +.. _parseGeometry.multipolygon: + +parseGeometry.multipolygon + Given a GML node representing a multipolygon geometry, create a ZOO multipolygon geometry. + + *Parameters* + + ``node {E4XElement}`` A GML node. + + *Returns* + + :ref:`{ZOO.Geometry.MultiPolygon} ` A multipolygon geometry. + +.. _parseGeometry.envelope: + +parseGeometry.envelope + Given a GML node representing an envelope, create a ZOO polygon geometry. + + *Parameters* + + ``node {E4XElement}`` A GML node. + + *Returns* + + :ref:`{ZOO.Geometry.Polygon} ` A polygon geometry. + +.. _parseAttributes: + +parseAttributes + :: + + parseAttributes: function(node) + + *Parameters* + + ``node {E4XElement}`` + + *Returns* + + ``{Object}`` An attributes object. + +.. _write: + +write + :: + + write: function(features) + + Generate a GML document string given a list of features. + + *Parameters* + + ``features`` :ref:`{Array(ZOO.Feature)} ` List of features to serialize into a string. + + *Returns* + + ``{String}`` A string representing the GML document. + +.. _createFeature: + +createFeature + :: + + createFeature: function(feature) + + Accept an ZOO.Feature, and build a GML node for it. + + *Parameters* + + ``feature`` :ref:`{ZOO.Feature} ` The feature to be built as GML. + + *Returns* + + ``{E4XElement}`` A node reprensting the feature in GML. + +.. _buildGeometryNode: + +buildGeometryNode + :: + + buildGeometryNode: function(geometry) + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` The geometry to be built as GML. + + *Returns* + + ``{E4XElement}`` A node reprensting the geometry in GML. + +.. _buildGeometry: + +buildGeometry + Object containing methods to do the actual geometry node building based on geometry type. + +.. _buildGeometry.point: + +buildGeometry.point + Given a ZOO point geometry, create a GML point. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.Point} ` A point geometry. + + *Returns* + + ``{E4XElement}`` A GML point node. + +.. _buildGeometry.multipoint: + +buildGeometry.multipoint + Given a ZOO multipoint geometry, create a GML multipoint. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.MultiPoint} ` A multipoint geometry. + + *Returns* + + ``{E4XElement}`` A GML multipoint node. + +.. _buildGeometry.linestring: + +buildGeometry.linestring + Given a ZOO linestring geometry, create a GML linestring. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.LineString} ` A linestring geometry. + + *Returns* + + ``{E4XElement}`` A GML linestring node. + +.. _buildGeometry.multilinestring: + +buildGeometry.multilinestring + Given a ZOO multilinestring geometry, create a GML multilinestring. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.MultiLineString} ` A multilinestring geometry. + + *Returns* + + ``{E4XElement}`` A GML multilinestring node. + +.. _buildGeometry.linearring: + +buildGeometry.linearring + Given a ZOO linearring geometry, create a GML linearring. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.LinearRing} ` A linearring geometry. + + *Returns* + + ``{E4XElement}`` A GML linearring node. + +.. _buildGeometry.polygon: + +buildGeometry.polygon + Given an ZOO polygon geometry, create a GML polygon. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.Polygon} ` A polygon geometry. + + *Returns* + + ``{E4XElement}`` A GML polygon node. + +.. _buildGeometry.multipolygon: + +buildGeometry.multipolygon + Given a ZOO multipolygon geometry, create a GML multipolygon. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.MultiPolygon} ` A multipolygon geometry. + + *Returns* + + ``{E4XElement}`` A GML multipolygon node. + +.. _buildCoordinatesNode: + +buildCoordinatesNode + :: + + buildCoordinatesNode: function(geometry) + + builds the coordinates XmlNode + + :: + + ... + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` + + *Returns* + + ``{E4XElement}`` created E4XElement + Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-json.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-json.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-json.txt (revision 672) @@ -0,0 +1,287 @@ +.. _api-zoo-format-json: + +ZOO.Format.JSON +=============== + +A parser to read/write JSON safely. + +Inherits from + +- :ref:`ZOO.Format ` + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`indent ` + - {String} For "pretty" printing, the indent string will be used once for each indentation level. + * - :ref:`space ` + - {String} For "pretty" printing, the space string will be used after the ":" separating a name/value pair. + * - :ref:`newline ` + - {String} For "pretty" printing, the newline string will be used at the end of each name/value pair or array item. + * - :ref:`level ` + - {Integer} For "pretty" printing, this is incremented/decremented during serialization. + * - :ref:`pretty ` + - {Boolean} Serialize with extra whitespace for structure. + +Functions +--------- + +.. list-table:: + :widths: 14 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Format.JSON ` + - Create a new parser for JSON. + * - :ref:`read ` + - Deserialize a json string. + * - :ref:`write ` + - Serialize an object into a JSON string. + * - :ref:`writeIndent ` + - Output an indentation string depending on the indentation level. + * - :ref:`writeNewline ` + - Output a string representing a newline if in pretty printing mode. + * - :ref:`writeSpace ` + - Output a string representing a space if in pretty printing mode. + +Serialize Properties +-------------------- + +.. list-table:: + :widths: 14 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`serialize ` + - Object with properties corresponding to the serializable data types. + +Serialize Functions +------------------- + +.. list-table:: + :widths: 14 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`serialize.object ` + - Transform an object into a JSON string. + * - :ref:`serialize.array ` + - Transform an array into a JSON string. + * - :ref:`serialize.string ` + - Transform a string into a JSON string. + * - :ref:`serialize.number ` + - Transform a number into a JSON string. + * - :ref:`serialize.boolean ` + - Transform a boolean into a JSON string. + * - :ref:`serialize.date ` + - Transform a date into a JSON string. + +**Properties** + +.. _indent: + +indent + ``{String}`` For "pretty" printing, the indent string will be used once for each indentation level. + +.. _space: + +space + ``{String}`` For "pretty" printing, the space string will be used after the ":" separating a name/value pair. + +.. _newline: + +newline + ``{String}`` For "pretty" printing, the newline string will be used at the end of each name/value pair or array item. + +.. _level: + +level + ``{Integer}`` For "pretty" printing, this is incremented/decremented during serialization. + +.. _pretty: + +pretty + ``{Boolean}`` Serialize with extra whitespace for structure. This is set by the :ref:`write ` method. + +**Functions** + +.. _ZOO.Format.JSON: + +ZOO.Format.JSON + Create a new parser for JSON. + + *Parameters* + + ``options {Object}`` An optional object whose properties will be set on this instance. + +.. _read: + +read + :: + + read: function(json,filter) + + Deserialize a json string. + + *Parameters* + + | ``json {String}`` A JSON string + | ``filter {Function}`` A function which will be called for every key and value at every level of the final result. Each value will be replaced by the result of the filter function. This can be used to reform generic objects into instances of classes, or to transform date strings into Date objects. + + *Returns* + + ``{Object}`` An object, array, string, or number. + +.. _write: + +write + :: + + write: function(value,pretty) + + Serialize an object into a JSON string. + + *Parameters* + + | ``value {String}`` The object, array, string, number, boolean or date to be serialized. + | ``pretty {Boolean}`` Structure the output with newlines and indentation. Default is false. + + *Returns* + + ``{String}`` The JSON string representation of the input value. + +.. _writeIndent: + +writeIndent + :: + + writeIndent: function() + + Output an indentation string depending on the indentation level. + + *Returns* + + ``{String}`` An appropriate indentation string. + +.. _writeNewline: + +writeNewline + :: + + writeNewline: function() + + Output a string representing a newline if in pretty printing mode. + + *Returns* + + ``{String}`` A string representing a new line. + +.. _writeSpace: + +writeSpace + :: + + writeSpace: function() + + Output a string representing a space if in pretty printing mode. + + *Returns* + + ``{String}`` A space. + +**Serialize Properties** + +.. _serialize: + +serialize + Object with properties corresponding to the serializable data types. Property + values are functions that do the actual serializing. + +**Serialize Functions** + +.. _serialize.object: + +serialize.object + Transform an object into a JSON string. + + *Parameters* + + ``object {Object}`` The object to be serialized. + + *Returns* + + ``{String}`` A JSON string representing the object. + +.. _serialize.array: + +serialize.array + Transform an array into a JSON string. + + *Parameters* + + ``array {Array}`` The array to be serialized + + *Returns* + + ``{String}`` A JSON string representing the array. + +.. _serialize.string: + +serialize.string + Transform a string into a JSON string. + + *Parameters* + + ``string {String}`` The string to be serialized + + *Returns* + + ``{String}`` A JSON string representing the string. + +.. _serialize.number: + +serialize.number + Transform a number into a JSON string. + + *Parameters* + + ``number {Number}`` The number to be serialized. + + *Returns* + + ``{String}`` A JSON string representing the number. + +.. _serialize.boolean: + +serialize.boolean + Transform a boolean into a JSON string. + + *Parameters* + + ``bool {Boolean}`` The boolean to be serialized. + + *Returns* + + ``{String}`` A JSON string representing the boolean. + +.. _serialize.date: + +serialize.date + Transform a date into a JSON string. + + *Parameters* + + ``date {Date}`` The date to be serialized. + + *Returns* + + ``{String}`` A JSON string representing the date. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-kml.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-kml.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-kml.txt (revision 672) @@ -0,0 +1,412 @@ +.. _api-zoo-format-kml: + +ZOO.Format.KML +============== + +Read/Write KML. + +Inherits from + +- :ref:`ZOO.Format ` + +Properties and Functions +------------------------ + +.. list-table:: + :widths: 20 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`kmlns ` + - {String} KML Namespace to use. + * - :ref:`foldersName ` + - {String} Name of the folders. + * - :ref:`foldersDesc ` + - {String} Description of the folders. + * - :ref:`placemarksDesc ` + - {String} Name of the placemarks. + * - :ref:`extractAttributes ` + - {Boolean} Extract attributes from KML. + * - :ref:`ZOO.Format.KML ` + - Create a new parser for KML. + * - :ref:`parseFeatures ` + - Loop through all Placemark nodes and parse them. + * - :ref:`parseFeature ` + - This function is the core of the KML parsing code in ZOO. + * - :ref:`parseGeometry ` + - Properties of this object are the functions that parse geometries based on their type. + * - :ref:`parseGeometry.point ` + - Given a KML node representing a point geometry, create a ZOO point geometry. + * - :ref:`parseGeometry.linestring ` + - Given a KML node representing a linestring geometry, create a ZOO linestring geometry. + * - :ref:`parseGeometry.polygon ` + - Given a KML node representing a polygon geometry, create a ZOO polygon geometry. + * - :ref:`parseGeometry.multigeometry ` + - Given a KML node representing a multigeometry, create a ZOO geometry collection. + * - :ref:`parseAttributes ` + - + * - :ref:`parseExtendedData ` + - Parse ExtendedData from KML. + * - :ref:`write ` + - Accept Feature Collection, and return a string. + * - :ref:`createPlacemark ` + - Creates and returns a KML placemark node representing the given feature. + * - :ref:`buildGeometryNode ` + - Builds and returns a KML geometry node with the given geometry. + * - :ref:`buildGeometry ` + - Object containing methods to do the actual geometry node building based on geometry type. + * - :ref:`buildGeometry.point ` + - Given a ZOO point geometry, create a KML point. + * - :ref:`buildGeometry.multipoint ` + - Given a ZOO multipoint geometry, create a KML GeometryCollection. + * - :ref:`buildGeometry.linestring ` + - Given a ZOO linestring geometry, create a KML linestring. + * - :ref:`buildGeometry.multilinestring ` + - Given a ZOO multilinestring geometry, create a KML GeometryCollection. + * - :ref:`buildGeometry.linearring ` + - Given a ZOO linearring geometry, create a KML linearring. + * - :ref:`buildGeometry.polygon ` + - Given a ZOO polygon geometry, create a KML polygon. + * - :ref:`buildGeometry.multipolygon ` + - Given a ZOO multipolygon geometry, create a KML GeometryCollection. + * - :ref:`buildGeometry.collection ` + - Given a ZOO geometry collection, create a KML MultiGeometry. + * - :ref:`buildCoordinatesNode ` + - Builds and returns the KML coordinates node with the given geometry ... + +.. _kmlns: + +kmlns + ``{String}`` KML Namespace to use. Defaults to 2.2 namespace. + +.. _foldersName: + +foldersName + ``{String}`` Name of the folders. Default is "ZOO export". If set to null, no name element will be created. + +.. _foldersDesc: + +foldersDesc + ``{String}`` Description of the folders. Default is "Exported on [date]." If set to null, no description element will be created. + +.. _placemarksDesc: + +placemarksDesc + ``{String}`` Name of the placemarks. Default is "No description available". + +.. _extractAttributes: + +extractAttributes + ``{Boolean}`` Extract attributes from KML. Default is true. Extracting styleUrls requires this to be set to true + +.. _ZOO.Format.KML: + +ZOO.Format.KML + Create a new parser for KML. + + *Parameters* + + ``options {Object}`` An optional object whose properties will be set on this instance. + +.. _parseFeatures: + +parseFeatures + :: + + parseFeatures: function(nodes) + + Loop through all Placemark nodes and parse them. Will create a list of features + + *Parameters* + + | ``nodes {Array}`` of {E4XElement} data to read/parse. + | ``options {Object}`` Hash of options + +.. _parseFeature: + +parseFeature + :: + + parseFeature: function(node) + + This function is the core of the KML parsing code in ZOO. It creates the geometries + that are then attached to the returned feature, and calls parseAttributes() to get + attribute data out. + + *Parameters* + + ``node {E4XElement}`` + + *Returns* + + :ref:`{ZOO.Feature} ` A vector feature. + +.. _parseGeometry: + +parseGeometry + Properties of this object are the functions that parse geometries based on their type. + +.. _parseGeometry.point: + +parseGeometry.point + Given a KML node representing a point geometry, create a ZOO point geometry. + + *Parameters* + + ``node {E4XElement}`` A KML Point node. + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` A point geometry. + +.. _parseGeometry.linestring: + +parseGeometry.linestring + Given a KML node representing a linestring geometry, create a ZOO linestring geometry. + + *Parameters* + + ``node {E4XElement}`` A KML LineString node. + + *Returns* + + :ref:`{ZOO.Geometry.LineString} ` A linestring geometry. + +.. _parseGeometry.polygon: + +parseGeometry.polygon + Given a KML node representing a polygon geometry, create a ZOO polygon geometry. + + *Parameters* + + ``node {E4XElement}`` A KML Polygon node. + + *Returns* + + :ref:`{ZOO.Geometry.Polygon} ` A polygon geometry. + +.. _parseGeometry.multigeometry: + +parseGeometry.multigeometry + Given a KML node representing a multigeometry, create a ZOO geometry collection. + + *Parameters* + + ``node {E4XElement}`` A KML MultiGeometry node. + + *Returns* + + :ref:`{ZOO.Geometry.Collection} ` A geometry collection. + +.. _parseAttributes: + +parseAttributes + :: + + parseAttributes: function(node) + + *Parameters* + + ``node {E4XElement}`` + + *Returns* + + ``{Object}`` An attributes object. + +.. _parseExtendedData: + +parseExtendedData + :: + + parseExtendedData: function(node) + + Parse ExtendedData from KML. Limited support for schemas/datatypes. See http://code.google.com/apis/kml/documentation/kmlreference.html#extendeddata + for more information on extendeddata. + + *Parameters* + + ``node {E4XElement}`` + + *Returns* + + ``{Object}`` An attributes object. + +.. _write: + +write + :: + + write: function(features) + + Accept Feature Collection, and return a string. + + *Parameters* + + ``features`` :ref:`{Array(ZOO.Feature)} ` An array of features. + + *Returns* + + ``{String}`` A KML string. + +.. _createPlacemark: + +createPlacemark + :: + + createPlacemark: function(feature) + + Creates and returns a KML placemark node representing the given feature. + + *Parameters* + + ``feature`` :ref:`{ZOO.Feature} ` + + *Returns* + + ``{E4XElement}`` + +.. _buildGeometryNode: + +buildGeometryNode + :: + + buildGeometryNode: function(geometry) + + Builds and returns a KML geometry node with the given geometry. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` + + *Returns* + + ``{E4XElement}`` + +.. _buildGeometry: + +buildGeometry + Object containing methods to do the actual geometry node building based on geometry type. + +.. _buildGeometry.point: + +buildGeometry.point + Given a ZOO point geometry, create a KML point. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.Point} ` A point geometry. + + *Returns* + + ``{E4XElement}`` A KML point node. + +.. _buildGeometry.multipoint: + +buildGeometry.multipoint + Given a ZOO multipoint geometry, create a KML GeometryCollection. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.MultiPoint} ` A multipoint geometry. + + *Returns* + + ``{E4XElement}`` A KML GeometryCollection node. + +.. _buildGeometry.linestring: + +buildGeometry.linestring + Given a ZOO linestring geometry, create a KML linestring. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.LineString} ` A linestring geometry. + + *Returns* + + ``{E4XElement}`` A KML linestring node. + +.. _buildGeometry.multilinestring: + +buildGeometry.multilinestring + Given a ZOO multilinestring geometry, create a KML GeometryCollection. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.MultiLineString} ` A multilinestring geometry. + + *Returns* + + ``{E4XElement}`` A KML GeometryCollection node. + +.. _buildGeometry.linearring: + +buildGeometry.linearring + Given a ZOO linearring geometry, create a KML linearring. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.LinearRing} ` A linearring geometry. + + *Returns* + + ``{E4XElement}`` A KML linearring node. + +.. _buildGeometry.polygon: + +buildGeometry.polygon + Given a ZOO polygon geometry, create a KML polygon. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.Polygon} ` A polygon geometry. + + *Returns* + + ``{E4XElement}`` A KML polygon node. + +.. _buildGeometry.multipolygon: + +buildGeometry.multipolygon + Given a ZOO multipolygon geometry, create a KML GeometryCollection. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.Point} ` A multipolygon geometry. + + *Returns* + + ``{E4XElement}`` A KML GeometryCollection node. + +.. _buildGeometry.collection: + +buildGeometry.collection + Given a ZOO geometry collection, create a KML MultiGeometry. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry.Collection} ` A geometry collection. + + *Returns* + + ``{E4XElement}`` A KML MultiGeometry node. + +.. _buildCoordinatesNode: + +buildCoordinatesNode + :: + + buildCoordinatesNode: function(geometry) + + Builds and returns the KML coordinates node with the given geometry ... + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` + + *Return* + + ``{E4XElement}`` + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-wkt.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-wkt.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-wkt.txt (revision 672) @@ -0,0 +1,196 @@ +.. _api-zoo-format-wkt: + +ZOO.Format.WKT +============== + +Class for reading and writing Well-Known Text. + +Inherits from + +- :ref:`ZOO.Format ` + +Functions and Properties +------------------------ + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Format.WKT ` + - Create a new parser for WKT + * - :ref:`read ` + - Deserialize a WKT string and return a vector feature or an array of vector features. + * - :ref:`write ` + - Serialize a feature or array of features into a WKT string. + * - :ref:`extract ` + - Object with properties corresponding to the geometry types. + * - :ref:`parse ` + - Object with properties corresponding to the geometry types. + * - :ref:`parse.point ` + - Return point feature given a point WKT fragment. + * - :ref:`parse.multipoint ` + - Return a multipoint feature given a multipoint WKT fragment. + * - :ref:`parse.linestring ` + - Return a linestring feature given a linestring WKT fragment. + * - :ref:`parse.multilinestring ` + - Return a multilinestring feature given a multilinestring WKT fragment. + * - :ref:`parse.polygon ` + - Return a polygon feature given a polygon WKT fragment. + * - :ref:`parse.multipolygon ` + - Return a multipolygon feature given a multipolygon WKT fragment. + * - :ref:`parse.geometrycollection ` + - Return an array of features given a geometrycollection WKT fragment. + +.. _ZOO.Format.WKT: + +ZOO.Format.WKT + Create a new parser for WKT + + *Parameters* + + ``options {Object}`` An optional object whose properties will be set on this instance + + *Returns* + + :ref:`{ZOO.Format.WKT} ` A new WKT parser. + +.. _read: + +read + :: + + read: function(wkt) + + Deserialize a WKT string and return a vector feature or an array of vector features. + Supports WKT for POINT, MULTIPOINT, LINESTRING, MULTILINESTRING, POLYGON, MULTIPOLYGON, + and GEOMETRYCOLLECTION. + + *Parameters* + + ``wkt {String}`` A WKT string + + *Returns* + + {|Array} A feature or array of features for GEOMETRYCOLLECTION WKT. + +.. _write: + +write + :: + + write: function(features) + + Serialize a feature or array of features into a WKT string. + + *Parameters* + + ``features {|Array}`` A feature or array of features + + *Returns* + + ``{String}`` The WKT string representation of the input geometries + +.. _extract: + +extract + Object with properties corresponding to the geometry types. Property values are + functions that do the actual data extraction. + +.. _parse: + +parse + Object with properties corresponding to the geometry types. Property values are + functions that do the actual parsing. + +.. _parse.point: + +parse.point + Return point feature given a point WKT fragment. + + *Parameters* + + ``str {String}`` A WKT fragment representing the point + + *Returns* + + :ref:`{ZOO.Feature} ` A point feature + +.. _parse.multipoint: + +parse.multipoint + Return a multipoint feature given a multipoint WKT fragment. + + *Parameters* + + ``str {String}`` A WKT fragment representing the multipoint + + *Returns* + + :ref:`{ZOO.Feature} ` A multipoint feature + +.. _parse.linestring: + +parse.linestring + Return a linestring feature given a linestring WKT fragment. + + *Parameters* + + ``str {String}`` A WKT fragment representing the linestring + + *Returns* + + :ref:`{ZOO.Feature} ` A linestring feature + +.. _parse.multilinestring: + +parse.multilinestring + Return a multilinestring feature given a multilinestring WKT fragment. + + *Parameters* + + ``str {String}`` A WKT fragment representing the multilinestring + + *Returns* + + :ref:`{ZOO.Feature} ` A multilinestring feature + +.. _parse.polygon: + +parse.polygon + Return a polygon feature given a polygon WKT fragment. + + *Parameters* + + ``str {String}`` A WKT fragment representing the polygon + + *Returns* + + :ref:`{ZOO.Feature} ` A polygon feature + +.. _parse.multipolygon: + +parse.multipolygon + Return a multipolygon feature given a multipolygon WKT fragment. + + *Parameters* + + ``str {String}`` A WKT fragment representing the multipolygon + + *Returns* + + :ref:`{ZOO.Feature} ` A multipolygon feature + +.. _parse.geometrycollection: + +parse.geometrycollection + Return an array of features given a geometrycollection WKT fragment. + + *Parameters* + + ``str {String}`` A WKT fragment representing the geometrycollection + + *Returns* + + ``{Array}`` An array of ZOO.Feature Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-wps.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-wps.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format-wps.txt (revision 672) @@ -0,0 +1,120 @@ +.. _api-zoo-format-wps: + +ZOO.Format.WPS +============== + +Read/Write WPS. + +Inherits from + +- :ref:`ZOO.Format ` + +Functions and Properties +------------------------ + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`schemaLocation ` + - {String} Schema location for a particular minor version. + * - :ref:`namespaces ` + - {Object} Mapping of namespace aliases to namespace URIs. + * - :ref:`read ` + - + * - :ref:`parseExecuteResponse ` + - + * - :ref:`parseData ` + - Object containing methods to analyse data response. + * - :ref:`parseData.complexdata ` + - Given an Object representing the WPS complex data response. + * - :ref:`parseData.literaldata ` + - Given an Object representing the WPS literal data response. + * - :ref:`parseData.reference ` + - Given an Object representing the WPS reference response. + +.. _schemaLocation: + +schemaLocation + ``{String}`` Schema location for a particular minor version. + +.. _namespaces: + +namespaces + ``{Object}`` Mapping of namespace aliases to namespace URIs. + +.. _read: + +read + :: + + read:function(data) + + *Parameters* + + ``data {String}`` A WPS xml document + + *Returns* + + ``{Object}`` Execute response. + +.. _parseExecuteResponse: + +parseExecuteResponse + :: + + parseExecuteResponse: function(node) + + *Parameters* + + ``node {E4XElement}`` A WPS ExecuteResponse document + + *Returns* + + ``{Object}`` Execute response. + +.. _parseData: + +parseData + Object containing methods to analyse data response. + +.. _parseData.complexdata: + +parseData.complexdata + Given an Object representing the WPS complex data response. + + *Parameters* + + ``node {E4XElement}`` A WPS node. + + *Returns* + + ``{Object}`` A WPS complex data response. + +.. _parseData.literaldata: + +parseData.literaldata + Given an Object representing the WPS literal data response.\ + + *Parameters* + + ``node {E4XElement}`` A WPS node. + + *Returns* + + ``{Object}`` A WPS literal data response. + +.. _parseData.reference: + +parseData.reference + Given an Object representing the WPS reference response. + + *Parameters* + + ``node {E4XElement}`` A WPS node. + + *Returns* + + ``{Object}`` A WPS reference response. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-format.txt (revision 672) @@ -0,0 +1,143 @@ +.. _api-zoo-format: + +ZOO.Format +========== + +Base class for format reading/writing a variety of formats. + +Properties +---------- + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`options ` + - {Object} A reference to options passed to the constructor. + * - :ref:`externalProjection ` + - {ZOO.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes. + * - :ref:`internalProjection ` + - {ZOO.Projection} When passed a externalProjection and internalProjection, the format will reproject the geometries it reads or writes. + * - :ref:`data ` + - {Object} When keepData is true, this is the parsed string sent to read. + * - :ref:`keepData ` + - {Object} Maintain a reference (data) to the most recently read data. + +Functions +--------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Format ` + - Instances of this class are not useful. + * - :ref:`destroy ` + - Clean up. + * - :ref:`read ` + - Read data from a string, and return an object whose type depends on the subclass. + * - :ref:`data ` + - {Object} When keepData is true, this is the parsed string sent to read. + * - :ref:`write ` + - Accept an object, and return a string. + +**Properties** + +.. _options: + +options + ``{Object}`` A reference to options passed to the constructor. + +.. _externalProjection: + +externalProjection + :ref:`{ZOO.Projection} ` When passed a externalProjection and internalProjection, + the format will reproject the geometries it reads or writes. The externalProjection is the projection + used by the content which is passed into read or which comes out of write. In order to reproject, + a projection transformation function for the specified projections must be available. This support + is provided via zoo-proj4js. + +.. _internalProjection: + +internalProjection + :ref:`{ZOO.Projection} ` When passed a externalProjection and internalProjection, + the format will reproject the geometries it reads or writes. The internalProjection is the projection + used by the geometries which are returned by read or which are passed into write. In order to reproject, + a projection transformation function for the specified projections must be available. This support + is provided via zoo-proj4js. + +.. _data: + +data + ``{Object}`` When :ref:`keepData ` is true, this is the parsed string sent to :ref:`read `. + +.. _keepData: + +keepData + ``{Object}`` Maintain a reference (:ref:`data `) to the most recently read data. Default is false. + +**Functions** + +.. _ZOO.Format: + +ZOO.Format + Instances of this class are not useful. See one of the subclasses. + + *Parameters* + + ``options {Object}`` An optional object with properties to set on the format + + *Valid options* + + ``keepData {Boolean}`` If true, upon read, the data property will be set to the parsed object (e.g. the json or xml object). + + *Returns* + + An instance of ZOO.Format + +.. _destroy: + +destroy + :: + + destroy: function() + + Clean up. + +.. _read: + +read + :: + + read: function(data) + + Read data from a string, and return an object whose type depends on the subclass. + + *Parameters* + + ``data {string}`` Data to read/parse. + + *Returns* + + Depends on the subclass + +.. _write: + +write + :: + + write: function(data) + + Accept an object, and return a string. + + *Parameters* + + ``object {Object}`` Object to be serialized + + *Returns* + + ``{String}`` A string representation of the object. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-collection.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-collection.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-collection.txt (revision 672) @@ -0,0 +1,355 @@ +.. _api-zoo-geometry-collection: + +ZOO.Geometry.Collection +======================= + +A Collection is exactly what it sounds like: A collection of different Geometries. +These are stored in the local parameter :ref:`components ` (which can +be passed as a parameter to the constructor). + +As new geometries are added to the collection, they are NOT cloned. When removing geometries, +they need to be specified by reference (ie you have to pass in the exact geometry to be removed). + +The and :ref:`getLength ` functions here merely iterate through the components, +summing their respective areas and lengths. + +Create a new instance with the :ref:`ZOO.Geometry.Collection ` constructor. + +Inherits from + +- :ref:`ZOO.Geometry ` + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`components ` + - {Array(ZOO.Geometry)} The component parts of this geometry + * - :ref:`componentTypes ` + - {Array(String)} An array of class names representing the types of components that the collection can include. + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.Collection ` + - Creates a Geometry Collection -- a list of geoms. + * - :ref:`destroy ` + - Destroy this geometry. + * - :ref:`clone ` + - Clone this geometry. + * - :ref:`getComponentsString ` + - Get a string representing the components for this collection. + * - :ref:`calculateBounds ` + - Recalculate the bounds by iterating through the components and calling extendBounds() on each item. + * - :ref:`addComponent ` + - Add a new component (geometry) to the collection. + * - :ref:`removeComponents ` + - Remove components from this geometry. + * - :ref:`removeComponent ` + - Remove a component from this geometry. + * - :ref:`getLength ` + - Calculate the length of this geometry. + * - :ref:`getCentroid ` + - {ZOO.Geometry.Point} The centroid of the collection. + * - :ref:`getGeodesicLength ` + - Calculate the approximate length of the geometry were it projected onto the earth. + * - :ref:`move ` + - Moves a geometry by the given displacement along positive x and y axes. + * - :ref:`rotate ` + - Rotate a geometry around some origin. + * - :ref:`resize ` + - Resize a geometry relative to some origin. + * - :ref:`equals ` + - Determine whether another geometry is equivalent to this one. + * - :ref:`transform ` + - Reproject the components geometry from source to dest. + * - :ref:`intersects ` + - Determine if the input geometry intersects this one. + * - :ref:`getVertices ` + - Return a list of all points in this geometry. + + +**Properties** + +.. _components: + +components + {Array(:ref:`ZOO.Geometry `)} The component parts of this geometry + +.. _componentTypes: + +componentTypes + ``{Array(String)}`` An array of class names representing the types of components that the collection can include. + A null value means the component types are not restricted. + +**Functions** + +.. _ZOO.Geometry.Collection: + +ZOO.Geometry.Collection + Creates a Geometry Collection -- a list of geoms. + + *Parameters* + + ``components`` {Array(:ref:`ZOO.Geometry `)} Optional array of geometries + +.. _destroy: + +destroy + :: + + destroy: function () + +Destroy this geometry. + +.. _clone: + +clone + :: + + clone: function() + + Clone this geometry. + + *Returns* + + :ref:`{ZOO.Geometry.Collection} ` An exact clone of this collection. + +.. _getComponentsString: + +getComponentsString + :: + + getComponentsString: function() + + Get a string representing the components for this collection. + + *Returns* + + ``{String}`` A string representation of the components of this geometry. + +.. _calculateBounds: + +calculateBounds + :: + + calculateBounds: function() + + Recalculate the bounds by iterating through the components and calling extendBounds() on each item. + +.. _addComponent: + +addComponent + :: + + addComponent: function(component,index) + + Add a new component (geometry) to the collection. If this.componentTypes is set, then the + component class name must be in the componentTypes array. The bounds cache is reset. + + *Parameters* + + | ``component`` :ref:`{ZOO.Geometry} ` A geometry to add + | ``index {int}`` Optional index into the array to insert the component + + *Returns* + + ``{Boolean}`` The component geometry was successfully added + +.. _removeComponents: + +removeComponents + :: + + removeComponents: function(components) + + Remove components from this geometry.\ + + *Parameters* + + ``components`` {Array(:ref:`ZOO.Geometry `)} The components to be removed + +.. _removeComponent: + +removeComponent + :: + + removeComponent: function(component) + + Remove a component from this geometry. + + *Parameters* + + ``component`` :ref:`{ZOO.Geometry} ` + +.. _getLength: + +getLength + :: + + getLength: function() + + Calculate the length of this geometry + + *Returns* + + ``{Float}`` The length of the geometry + +.. _getCentroid: + +getCentroid + :: + + getCentroid: function() + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` The centroid of the collection + +.. _getGeodesicLength: + +getGeodesicLength + :: + + getGeodesicLength: function(projection) + + Calculate the approximate length of the geometry were it projected onto the earth. + + *Parameters* + + ``projection`` :ref:`{ZOO.Projection} ` The spatial + reference system for the geometry coordinates. If not provided, Geographic/WGS84 is assumed. + + *Returns* + + ``{Float}`` The appoximate geodesic length of the geometry in meters. + +.. _move: + +move + :: + + move: function(x,y) + + Moves a geometry by the given displacement along positive x and y axes. This modifies the + position of the geometry and clears the cached bounds. + + *Parameters* + + | ``x {Float}`` Distance to move geometry in positive x direction. + | ``y {Float}`` Distance to move geometry in positive y direction. + +.. _rotate: + +rotate + :: + + rotate: function(angle,origin) + + Rotate a geometry around some origin + + *Parameters* + + | ``angle {Float}`` Rotation angle in degrees (measured counterclockwise from the positive x-axis) + | ``origin`` :ref:`{ZOO.Geometry.Point} ` Center point for the rotation + +.. _resize: + +resize + :: + + resize: function(scale,origin,ratio) + + Resize a geometry relative to some origin. Use this method to apply a uniform scaling to a geometry. + + *Parameters* + + | ``scale {Float}`` Factor by which to scale the geometry. A scale of 2 doubles the size of the geometry in each dimension (lines, for example, will be twice as long, and polygons will have four times the area). + | ``origin`` :ref:`{ZOO.Geometry.Point} ` Point of origin for resizing + | ``ratio {Float}`` Optional x:y ratio for resizing. Default ratio is 1. + + *Returns* + + :ref:`{ZOO.Geometry} ` The current geometry. + +.. _equals: + +equals + :: + + equals: function(geometry) + + Determine whether another geometry is equivalent to this one. Geometries are considered equivalent if + all components have the same coordinates. + + *Parameters* + + ``geom`` :ref:`{ZOO.Geometry} ` The geometry to test. + + *Returns* + + ``{Boolean}`` The supplied geometry is equivalent to this geometry. + +.. _transform: + +transform + :: + + transform: function(source,dest) + + Reproject the components geometry from source to dest. + + *Parameters* + + | ``source`` :ref:`{ZOO.Projection} ` + | ``dest`` :ref:`{ZOO.Projection} ` + + *Returns* + + :ref:`{ZOO.Geometry} ` + +.. _intersects: + +intersects + :: + + intersects: function(geometry) + + Determine if the input geometry intersects this one. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` Any type of geometry. + + *Returns* + + ``{Boolean}`` The input geometry intersects this one. + +.. _getVertices: + +getVertices + :: + + getVertices: function(nodes) + + Return a list of all points in this geometry. + + *Parameters* + + ``nodes {Boolean}`` For lines, only return vertices that are endpoints. If false, for lines, + only vertices that are not endpoints will be returned. If not provided, all vertices will be returned. + + *Returns* + + ``{Array}`` A list of all vertices in the geometry. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-curve.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-curve.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-curve.txt (revision 672) @@ -0,0 +1,68 @@ +.. _api-zoo-geometry-curve: + +ZOO.Geometry.Curve +================== + +A Curve is a MultiPoint, whose points are assumed to be connected. To this end, +we provide a "getLength()" function, which iterates through the points, summing the +distances between them. + +Inherits from + +- :ref:`ZOO.Geometry.MultiPoint ` + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`componentTypes ` + - {Array(String)} An array of class names representing the types of components that the collection can include. + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.Curve ` + - + * - :ref:`getLength ` + - {Float} The length of the curve + +**Properties** + +.. _componentTypes: + +componentTypes + ``{Array(String)}`` An array of class names representing the types of components that the + collection can include. A null value means the component types are not restricted. + +**Functions** + +.. _ZOO.Geometry.Curve: + +ZOO.Geometry.Curve + + *Parameters* + + ``point`` {Array(:ref:`ZOO.Geometry.Point `)} + +.. _getLength: + +getLength + + :: + + getLength: function() + + *Returns* + + ``{Float}`` The length of the curve Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-linearring.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-linearring.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-linearring.txt (revision 672) @@ -0,0 +1,231 @@ +.. _api-zoo-geometry-linearring: + +ZOO.Geometry.LinearRing +======================= + +A Linear Ring is a special LineString which is closed. It closes itself automatically +on every addPoint/removePoint by adding a copy of the first point as the last point. + +Also, as it is the first in the line family to close itself, a getArea() function is +defined to calculate the enclosed area of the linearRing + +Inherits from + +- :ref:`ZOO.Geometry.LineString ` + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`componentTypes ` + - {Array(String)} An array of class names representing the types of components that the collection can include. + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.LinearRing ` + - Linear rings are constructed with an array of points. + * - :ref:`addComponent ` + - Adds a point to geometry components. + * - :ref:`move ` + - Moves a geometry by the given displacement along positive x and y axes. + * - :ref:`rotate ` + - Rotate a geometry around some origin + * - :ref:`resize ` + - Resize a geometry relative to some origin. + * - :ref:`transform ` + - Reproject the components geometry from source to dest. + * - :ref:`getCentroid ` + - {ZOO.Geometry.Point} The centroid of the ring + * - :ref:`getArea ` + - + * - :ref:`getGeodesicArea ` + - Calculate the approximate area of the polygon were it projected onto the earth. + * - :ref:`containsPoint ` + - Test if a point is inside a linear ring. + +**Properties** + +.. _componentTypes: + +componentTypes + ``{Array(String)}`` An array of class names representing the types of components that the + collection can include. A null value means the component types are not restricted. + +**Functions** + +.. _ZOO.Geometry.LinearRing: + +ZOO.Geometry.LinearRing + Linear rings are constructed with an array of points. This array can represent a closed + or open ring. If the ring is open (the last point does not equal the first point), + the constructor will close the ring. If the ring is already closed (the last point does + equal the first point), it will be left closed. + + *Parameters* + + ``points`` {Array(:ref:`ZOO.Geometry.Point `)} points + +.. _addComponent: + +addComponent + :: + + addComponent: function(point,index) + + Adds a point to geometry components. If the point is to be added to the end of the + components array and it is the same as the last point already in that array, the + duplicate point is not added. This has the effect of closing the ring if it is not + already closed, and doing the right thing if it is already closed. This behavior can be + overridden by calling the method with a non-null index as the second argument. + + *Parameter* + + | ``point`` :ref:`{ZOO.Geometry.Point} ` + | ``index {Integer}`` Index into the array to insert the component + + *Returns* + + ``{Boolean}`` Was the Point successfully added? + +.. _move: + +move + :: + + move: function(x,y) + + Moves a geometry by the given displacement along positive x and y axes. This + modifies the position of the geometry and clears the cached bounds. + + *Parameters* + + | ``x {Float}`` Distance to move geometry in positive x direction. + | ``y {Float}`` Distance to move geometry in positive y direction. + +.. _rotate: + +rotate + :: + + rotate: function(angle,origin) + + Rotate a geometry around some origin + + *Parameters* + + | ``angle {Float}`` Rotation angle in degrees (measured counterclockwise from the positive x-axis) + | ``origin`` :ref:`{ZOO.Geometry.Point} ` Center point for the rotation + +.. _resize: + +resize + :: + + resize: function(scale,origin,ratio) + + Resize a geometry relative to some origin. Use this method to apply a uniform scaling to a geometry. + + *Parameters* + + | ``scale {Float}`` Factor by which to scale the geometry. A scale of 2 doubles the size of the geometry in each dimension (lines, for example, will be twice as long, and polygons will have four times the area). + | ``origin`` :ref:`{ZOO.Geometry.Point} ` Point of origin for resizing + | ``ratio {Float}`` Optional x:y ratio for resizing. Default ratio is 1. + + *Returns* + + ``{ZOO.Geometry}`` The current geometry. + +.. _transform: + +transform + :: + + transform: function(source,dest) + + Reproject the components geometry from source to dest. + + *Parameters* + + | ``source`` :ref:`{ZOO.Projection} ` + | ``dest`` :ref:`{ZOO.Projection} ` + + *Returns* + + :ref:`{ZOO.Geometry} ` + +.. _getCentroid: + +getCentroid + :: + + getCentroid: function() + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` The centroid of the ring + +.. _getArea: + +getArea + :: + + getArea: function() + + .. note:: The area is positive if the ring is oriented CW, otherwise it will be negative. + + *Returns* + + ``{Float}`` The signed area for a ring. + +.. _getGeodesicArea: + +getGeodesicArea + :: + + getGeodesicArea: function(projection) + + Calculate the approximate area of the polygon were it projected onto the earth. Note that + this area will be positive if ring is oriented clockwise, otherwise it will be negative. + + *Parameters* + + ``projection`` :ref:`{ZOO.Projection} ` The spatial reference system for the geometry coordinates. If not provided, Geographic/WGS84 is assumed. + + *Reference* + + Robert. G. Chamberlain and William H. Duquette, "Some Algorithms for Polygons on a Sphere", + JPL Publication 07-03, Jet Propulsion Laboratory, Pasadena, CA, June 2007 http://trs-new.jpl.nasa.gov/dspace/handle/2014/40409 + + *Returns* + + ``{float}`` The approximate signed geodesic area of the polygon in square meters. + +.. _containsPoint: + +containsPoint + :: + + containsPoint: function(point) + + Test if a point is inside a linear ring. For the case where a point is coincident with a + linear ring edge, returns 1. Otherwise, returns boolean. + + *Parameters* + + ``point`` :ref:`{ZOO.Geometry.Point} ` + + *Returns* + + ``{Boolean | Number}`` The point is inside the linear ring. Returns 1 if the point is coincident with an edge. Returns boolean otherwise. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-linestring.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-linestring.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-linestring.txt (revision 672) @@ -0,0 +1,180 @@ +.. _api-zoo-geometry-linestring: + +ZOO.Geometry.LineString +======================= + +A LineString is a Curve which, once two points have been added to it, can never be less than two points long. + +Inherits from + +- :ref:`ZOO.Geometry.Curve ` + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.LineString ` + - Create a new LineString geometry + * - :ref:`removeComponent ` + - Only allows removal of a point if there are three or more points in the linestring. + * - :ref:`intersects ` + - Test for instersection between two geometries. + * - :ref:`getSortedSegments ` + - {Array} An array of segment objects. + * - :ref:`splitWithSegment ` + - Split this geometry with the given segment. + * - :ref:`split ` + - Use this geometry (the source) to attempt to split a target geometry. + * - :ref:`splitWith ` + - Split this geometry (the target) with the given geometry (the source). + * - :ref:`getVertices ` + - Return a list of all points in this geometry. + +.. _ZOO.Geometry.LineString: + +ZOO.Geometry.LineString + Create a new LineString geometry + + *Parameters* + + ``points`` {Array(:ref:`ZOO.Geometry.Point `)} An array of points used to generate the linestring + +.. _removeComponent: + +removeComponent + :: + + removeComponent: function(point) + + Only allows removal of a point if there are three or more points in the linestring. (otherwise + the result would be just a single point) + + *Parameters* + + ``point`` :ref:`{ZOO.Geometry.Point} ` The point to be removed + +.. _intersects: + +intersects + :: + + intersects: function(geometry) + + Test for instersection between two geometries. This is a cheapo implementation of the + Bently-Ottmann algorigithm. It doesn't really keep track of a sweep line data structure. + It is closer to the brute force method, except that segments are sorted and potential intersections + are only calculated when bounding boxes intersect. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` + + *Returns* + + ``{Boolean}`` The input geometry intersects this geometry. + +.. _getSortedSegments: + +getSortedSegments + :: + + getSortedSegments: function() + + *Returns* + + ``{Array}`` An array of segment objects. Segment objects have properties x1, y1, x2, and y2. + The start point is represented by x1 and y1. The end point is represented by x2 and y2. + Start and end are ordered so that x1 < x2. + +.. _splitWithSegment: + +splitWithSegment + :: + + splitWithSegment: function(seg,options) + + Split this geometry with the given segment. + + *Parameters* + + | ``seg {Object}`` An object with x1, y1, x2, and y2 properties referencing segment endpoint coordinates. + | ``options {Object}`` Properties of this object will be used to determine how the split is conducted. + + *Valid options* + + | ``edge {Boolean}`` Allow splitting when only edges intersect. Default is true. If false, a vertex on the source segment must be within the tolerance distance of the intersection to be considered a split. + | ``tolerance {Number}`` If a non-null value is provided, intersections within the tolerance distance of one of the source segment's endpoints will be assumed to occur at the endpoint. + + *Returns* + + ``{Object}`` An object with lines and points properties. If the given segment intersects this linestring, the lines array will reference geometries that result from the split. The points array will contain all intersection points. Intersection points are sorted along the segment (in order from x1,y1 to x2,y2). + +.. _split: + +split + :: + + split: function(target,options) + + Use this geometry (the source) to attempt to split a target geometry. + + *Parameters* + + | ``target`` :ref:`{ZOO.Geometry} ` The target geometry. + | ``options {Object}`` Properties of this object will be used to determine how the split is conducted. + + *Valid options* + + | ``mutual {Boolean}`` Split the source geometry in addition to the target geometry. Default is false. + | ``edge {Boolean}`` Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. + | ``tolerance {Number}`` If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. + + *Returns* + + ``{Array}`` A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry. + +.. _splitWith: + +splitWith + :: + + splitWith: function(geometry,options) + + Split this geometry (the target) with the given geometry (the source). + + *Parameters* + + | ``geometry`` :ref:`{ZOO.Geometry} ` A geometry used to split this geometry (the source). + | ``options {Object}`` Properties of this object will be used to determine how the split is conducted. + + *Valid options* + + | ``mutual {Boolean}`` Split the source geometry in addition to the target geometry. Default is false. + | ``edge {Boolean}`` Allow splitting when only edges intersect. Default is true. If false, a vertex on the source must be within the tolerance distance of the intersection to be considered a split. + | ``tolerance {Number}`` If a non-null value is provided, intersections within the tolerance distance of an existing vertex on the source will be assumed to occur at the vertex. + + *Returns* + + ``{Array}`` A list of geometries (of this same type as the target) that result from splitting the target with the source geometry. The source and target geometry will remain unmodified. If no split results, null will be returned. If mutual is true and a split results, return will be an array of two arrays - the first will be all geometries that result from splitting the source geometry and the second will be all geometries that result from splitting the target geometry. + +.. _getVertices: + +getVertices + :: + + getVertices: function(nodes) + + Return a list of all points in this geometry. + + *Parameters* + + ``nodes {Boolean}`` For lines, only return vertices that are endpoints. If false, for lines, only vertices that are not endpoints will be returned. If not provided, all vertices will be returned. + + *Returns* + + ``{Array}`` A list of all vertices in the geometry. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multilinestring.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multilinestring.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multilinestring.txt (revision 672) @@ -0,0 +1,31 @@ +.. _api-zoo-geometry-multilinestring: + +ZOO.Geometry.MultiLineString +============================ + +A MultiLineString is a geometry with multiple ZOO.Geometry.LineString components. + +Inherits from + +- :ref:`ZOO.Geometry.Collection ` + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.MultiLineString ` + - Constructor for a MultiLineString Geometry. + +.. _ZOO.Geometry.MultiLineString: + +ZOO.Geometry.MultiLineString + Constructor for a MultiLineString Geometry. + + *Parameters* + + ``components`` {Array(:ref:`ZOO.Geometry.LineString `)} Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multipoint.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multipoint.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multipoint.txt (revision 672) @@ -0,0 +1,90 @@ +.. _api-zoo-geometry-multipoint: + +ZOO.Geometry.MultiPoint +======================= + +MultiPoint is a collection of Points. Create a new instance with the +:ref:`ZOO.Geometry.MultiPoint ` constructor. + +Inherits from + +- :ref:`ZOO.Geometry.Collection ` + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`componentTypes ` + - {Array(String)} An array of class names representing the types of components that the collection can include. + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.MultiPoint ` + - Create a new MultiPoint Geometry + * - :ref:`addPoint ` + - rapper for ZOO.Geometry.Collection.addComponent + * - :ref:`removePoint ` + - Wrapper for ZOO.Geometry.Collection.removeComponent + +**Properties** + +.. _componentTypes: + +componentTypes + ``{Array(String)}`` An array of class names representing the types of components that the collection can include. + A null value means the component types are not restricted. + +**Functions** + +.. _ZOO.Geometry.MultiPoint: + +ZOO.Geometry.MultiPoint + Create a new MultiPoint Geometry + + + *Parameters* + + ``components`` {Array(:ref:`ZOO.Geometry.Point `)} + + *Returns* + + :ref:`{ZOO.Geometry.MultPoint} ` + +.. _addPoint: + +addPoint + :: + + addPoint: function(point,index) + + Wrapper for :ref:`ZOO.Geometry.Collection.addComponent ` + + *Parameters* + + | ``point`` :ref:`{ZOO.Geometry.Point} ` Point to be added + | ``index {Integer}`` Optional index + +.. _removePoint: + +removePoint + :: + + removePoint: function(point) + + Wrapper for :ref:`ZOO.Geometry.Collection.removeComponent ` + + *Parameters* + + ``point`` :ref:`{ZOO.Geometry.Point} ` Point to be removed Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multipolygon.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multipolygon.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-multipolygon.txt (revision 672) @@ -0,0 +1,32 @@ +.. _api-zoo-geometry-multipolygon: + +ZOO.Geometry.MultiPolygon +========================= + +MultiPolygon is a geometry with multiple :ref:`ZOO.Geometry.Polygon ` components. +Create a new instance with the :ref:`ZOO.Geometry.MultiPolygon ` constructor. + +Inherits from + +- :ref:`ZOO.Geometry.Collection ` + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.MultiPolygon ` + - Create a new MultiPolygon geometry + +.. _ZOO.Geometry.MultiPolygon: + +ZOO.Geometry.MultiPolygon + Create a new MultiPolygon geometry + + *Parameters* + + ``components`` {Array(:ref:`ZOO.Geometry.Polygon `)} An array of polygons used to generate the MultiPolygon Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-point.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-point.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-point.txt (revision 672) @@ -0,0 +1,246 @@ +.. _api-zoo-geometry-point: + +ZOO.Geometry.Point +================== + +Point geometry class. + +Inherits from + +- :ref:`ZOO.Geometry ` + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`x ` + - {float} + * - :ref:`y ` + - {float} + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.Point ` + - Construct a point geometry. + * - :ref:`clone ` + - {ZOO.Geometry.Point} An exact clone of this ZOO.Geometry.Point + * - :ref:`calculateBounds ` + - Create a new Bounds based on the x/y + * - :ref:`equals ` + - Determine whether another geometry is equivalent to this one. + * - :ref:`toShortString ` + - {String} Shortened String representation of Point object. + * - :ref:`move ` + - Moves a geometry by the given displacement along positive x and y axes. + * - :ref:`rotate ` + - Rotate a point around another. + * - :ref:`getCentroid ` + - {ZOO.Geometry.Point} The centroid of the collection + * - :ref:`resize ` + - Resize a point relative to some origin. + * - :ref:`intersects ` + - Determine if the input geometry intersects this one. + * - :ref:`transform ` + - Translate the x,y properties of the point from source to dest. + * - :ref:`getVertices ` + - Return a list of all points in this geometry. + + +**Properties** + +.. _x: + +x + ``{float}`` + +.. _y: + +y + ``{float}`` + +**Functions** + +.. _ZOO.Geometry.Point: + +ZOO.Geometry.Point + Construct a point geometry. + + *Parameters* + + | ``x {float}`` + | ``y {float}`` + +.. _clone: + +clone + :: + + clone: function(obj) + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` An exact clone of this ZOO.Geometry.Point + +.. _calculateBounds: + +calculateBounds + :: + + calculateBounds: function () + + Create a new Bounds based on the x/y + +.. _equals: + +equals + :: + + equals: function(geom) + + Determine whether another geometry is equivalent to this one. Geometries are considered + equivalent if all components have the same coordinates. + + *Parameters* + + ``geom`` :ref:`{ZOO.Geometry.Point} ` The geometry to test. + + *Returns* + + ``{Boolean}`` The supplied geometry is equivalent to this geometry. + +.. _toShortString: + +toShortString + :: + + toShortString: function() + + *Returns* + + ``{String}`` Shortened String representation of Point object. (ex. "5, 42") + +.. _move: + +move + :: + + move: function(x,y) + + Moves a geometry by the given displacement along positive x and y axes. This modifies + the position of the geometry and clears the cached bounds. + + *Parameters* + + | ``x {Float}`` Distance to move geometry in positive x direction. + | ``y {Float}`` Distance to move geometry in positive y direction. + +.. _rotate: + +rotate + :: + + rotate: function(angle,origin) + + Rotate a point around another. + + *Parameters* + + | ``angle {Float}`` Rotation angle in degrees (measured counterclockwise from the positive x-axis) + | ``origin`` :ref:`{ZOO.Geometry.Point} ` Center point for the rotation + +.. _getCentroid: + +getCentroid + :: + + getCentroid: function() + + *Returns* + + :ref:`{ZOO.Geometry.Point} ` The centroid of the collection + +.. _resize: + +resize + :: + + resize: function(scale,origin,ratio) + + Resize a point relative to some origin. For points, this has the effect of scaling a + vector (from the origin to the point). This method is more useful on geometry collection + subclasses. + + *Parameters* + + | ``scale {Float}`` Ratio of the new distance from the origin to the old distance from the origin. A scale of 2 doubles the distance between the point and origin. + | ``origin`` :ref:`{ZOO.Geometry.Point} ` Point of origin for resizing + | ``ratio {Float}`` Optional x:y ratio for resizing. Default ratio is 1. + + *Returns* + + :ref:`{ZOO.Geometry} ` The current geometry. + +.. _intersects: + +intersects + :: + + intersects: function(geometry) + + Determine if the input geometry intersects this one. + + *Parameters* + + ``geometry`` :ref:`{ZOO.Geometry} ` Any type of geometry. + + *Returns* + + ``{Boolean}`` The input geometry intersects this one. + +.. _transform: + +transform + :: + + transform: function(source,dest) + + Translate the x,y properties of the point from source to dest. + + *Parameters* + + | ``source`` :ref:`{ZOO.Projection} ` + | ``dest`` :ref:`{ZOO.Projection} ` + + *Returns* + + :ref:`{ZOO.Geometry} ` + +.. _getVertices: + +getVertices + :: + + getVertices: function(nodes) + + Return a list of all points in this geometry. + + *Parameters* + + ``nodes {Boolean}`` For lines, only return vertices that are endpoints. If false, for lines, + only vertices that are not endpoints will be returned. If not provided, all vertices will be returned. + + *Returns* + + ``{Array}`` A list of all vertices in the geometry. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-polygon.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-polygon.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-polygon.txt (revision 672) @@ -0,0 +1,87 @@ +.. _api-zoo-geometry-polygon: + +ZOO.Geometry.Polygon +==================== + +Polygon is a collection of :ref:`ZOO.Geometry.LinearRing `. + +Inherits from + +- :ref:`ZOO.Geometry.Collection ` + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry.Polygon ` + - Constructor for a Polygon geometry. + * - :ref:`getArea ` + - Calculated by subtracting the areas of the internal holes from the area of the outer hole. + * - :ref:`containsPoint ` + - Test if a point is inside a polygon. + * - :ref:`createRegularPolygon ` + - Create a regular polygon around a radius. + +.. _ZOO.Geometry.Polygon: + +ZOO.Geometry.Polygon + Constructor for a Polygon geometry. The first ring (*this.component[0]*) is the outer + bounds of the polygon and all subsequent rings (*this.component[1-n]*) are internal holes. + + *Parameters* + + ``components`` {Array(:ref:`ZOO.Geometry.LinearRing `)} + +.. _getArea: + +getArea + :: + + getArea: function() + + Calculated by subtracting the areas of the internal holes from the area of the outer hole. + + *Returns* + + ``{float}`` The area of the geometry + +.. _containsPoint: + +containsPoint + :: + + containsPoint: function(point) + + Test if a point is inside a polygon. Points on a polygon edge are considered inside. + + *Parameters* + + ``point`` :ref:`{ZOO.Geometry.Point} ` + + *Returns* + + ``{Boolean | Number}`` The point is inside the polygon. Returns 1 if the point is on an edge. Returns boolean otherwise. + +.. _createRegularPolygon: + +createRegularPolygon + :: + + ZOO.Geometry.Polygon.createRegularPolygon = function( origin, + radius, + sides, + rotation ) + + Create a regular polygon around a radius. Useful for creating circles and the like. + + *Parameters* + + | ``origin`` :ref:`{ZOO.Geometry.Point} ` center of polygon. + | ``radius {Float}`` distance to vertex, in map units. + | ``sides {Integer}`` Number of sides. 20 approximates a circle. + | ``rotation {Float}`` original angle of rotation, in degrees. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-surface.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-surface.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry-surface.txt (revision 672) @@ -0,0 +1,10 @@ +.. _api-zoo-geometry-surface: + +ZOO.Geometry.Surface +==================== + +Surface geometry class. + +Inherits from + +- :ref:`ZOO.Geometry ` Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-geometry.txt (revision 672) @@ -0,0 +1,173 @@ +.. _api-zoo-geometry: + +ZOO.Geometry +============ + +A Geometry is a description of a geographic object. + +Properties +---------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`id ` + - {String} A unique identifier for this geometry. + * - :ref:`parent ` + - {ZOO.Geometry}This is set when a Geometry is added as component of another geometry + * - :ref:`bounds ` + - {ZOO.Bounds} The bounds of this geometry + +Functions +--------- + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Geometry ` + - Creates a geometry object. + * - :ref:`destroy ` + - nullify references to prevent circular references and memory leaks + * - :ref:`clone ` + - Create a clone of this vector feature. + * - :ref:`extendBounds ` + - Moves the feature and redraws it at its new location + * - :ref:`clearBounds ` + - Nullify this components bounds and that of its parent as well. + * - :ref:`getBounds ` + - Get the bounds for this Geometry. + * - :ref:`calculateBounds ` + - Recalculate the bounds for the geometry. + * - :ref:`toString ` + - Returns the Well-Known Text representation of a geometry + * - :ref:`ZOO.Geometry.fromWKT ` + - Generate a geometry given a Well-Known Text string. + + +**Properties** + +.. _id: + +id + ``{String}`` A unique identifier for this geometry. + +.. _parent: + +parent + :ref:`{ZOO.Geometry} ` This is set when a Geometry is added as component of another geometry + +.. _bounds: + +bounds + :ref:`{ZOO.Bounds} ` The bounds of this geometry + +**Functions** + +.. _ZOO.Geometry: + +ZOO.Geometry + Creates a geometry object. + +.. _destroy: + +destroy + :: + + destroy: function() + + Destroy this geometry. + +.. _clone: + +clone + :: + + clone: function() + + Create a clone of this geometry. Does not set any non-standard properties of the cloned geometry. + + *Returns* + + :ref:`{ZOO.Geometry} ` An exact clone of this geometry. + +.. _extendBounds: + +extendBounds + :: + + extendBounds: function(newBounds) + + Extend the existing bounds to include the new bounds. If geometry's bounds is not yet set, + then set a new Bounds. + + *Parameters* + + ``newBounds`` :ref:`{ZOO.Bounds} ` + +.. _clearBounds: + +clearBounds + :: + + clearBounds: function() + + Nullify this components bounds and that of its parent as well. + +.. _getBounds: + +getBounds + :: + + getBounds: function() + + Get the bounds for this Geometry. If bounds is not set, it is calculated again, this + makes queries faster. + + *Returns* + + ``newBounds`` :ref:`{ZOO.Bounds} ` + +.. _calculateBounds: + +calculateBounds + :: + + calculateBounds: function() + + Recalculate the bounds for the geometry. + +.. _toString: + +toString + :: + + toString: function() + + Returns the Well-Known Text representation of a geometry + + *Returns* + + ``{String}`` Well-Known Text + +.. _ZOO.Geometry.fromWKT: + +ZOO.Geometry.fromWKT + :: + + ZOO.Geometry.fromWKT = function(wkt) + + Generate a geometry given a Well-Known Text string. + + *Parameters* + + ``wkt {String}`` A string representing the geometry in Well-Known Text. + + *Returns* + + :ref:`{ZOO.Geometry} ` A geometry of the appropriate class. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-process.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-process.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-process.txt (revision 672) @@ -0,0 +1,149 @@ +.. _api-zoo-process: + +ZOO.Process +=========== + +Used to query OGC WPS process defined by its URL and its identifier. Useful for chaining localhost process. + +Properties and Functions +------------------------ + +.. list-table:: + :widths: 15 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`schemaLocation ` + - {String} Schema location for a particular minor version. + * - :ref:`namespaces ` + - {Object} Mapping of namespace aliases to namespace URIs. + * - :ref:`url ` + - {String} The OGC's Web PRocessing Service URL, default is http://localhost/zoo. + * - :ref:`identifier ` + - {String} Process identifier in the OGC's Web Processing Service. + * - :ref:`ZOO.Process ` + - Create a new Process + * - :ref:`Execute ` + - Query the OGC's Web PRocessing Servcie to Execute the process. + * - :ref:`buildInput ` + - Object containing methods to build WPS inputs. + * - :ref:`buildInput.complex ` + - Given an E4XElement representing the WPS complex data input. + * - :ref:`buildInput.reference ` + - Given an E4XElement representing the WPS reference input. + * - :ref:`buildInput.literal ` + - Given an E4XElement representing the WPS literal data input. + * - :ref:`buildDataInputsNode ` + - Method to build the WPS DataInputs element. + +.. _schemaLocation: + +schemaLocation + ``{String}`` Schema location for a particular minor version. + +.. _namespaces: + +namespaces + ``{Object}`` Mapping of namespace aliases to namespace URIs. + +.. _url: + +url + ``{String}`` The OGC's Web PRocessing Service URL, default is http://localhost/zoo. + +.. _identifier: + +identifier + ``{String}`` Process identifier in the OGC's Web Processing Service. + +.. _ZOO.Process: + +ZOO.Process + Create a new Process + + *Parameters* + + | ``url {String}`` The OGC's Web Processing Service URL. + | ``identifier {String}`` The process identifier in the OGC's Web Processing Service. + +.. _Execute: + +Execute + :: + + Execute: function(inputs) + + Query the OGC's Web PRocessing Servcie to Execute the process. + + *Parameters* + + ``inputs {Object}`` + + *Returns* + + ``{String}`` The OGC's Web processing Service XML response. The result needs to be interpreted. + +.. _buildInput: + +buildInput + Object containing methods to build WPS inputs. + +.. _buildInput.complex: + +buildInput.complex + Given an E4XElement representing the WPS complex data input. + + *Parameters* + + | ``identifier {String}`` the input indetifier + | ``data {Object}`` A WPS complex data input. + + *Returns* + + ``{E4XElement}`` A WPS Input node. + +.. _buildInput.reference: + +buildInput.reference + Given an E4XElement representing the WPS reference input. + + *Parameters* + + | ``identifier {String}`` the input indetifier + | ``data {Object}`` A WPS reference input. + + *Returns* + + ``{E4XElement}`` A WPS Input node. + +.. _buildInput.literal: + +buildInput.literal + Given an E4XElement representing the WPS literal data input. + + *Parameters* + + | ``identifier {String}`` the input indetifier + | ``data {Object}`` A WPS literal data input. + + *Returns* + + ``{E4XElement}`` The WPS Input node. + +.. _buildDataInputsNode: + +buildDataInputsNode + :: + + buildDataInputsNode:function(inputs) + + Method to build the WPS DataInputs element. + + *Parameters* + + ``inputs {Object}`` + + *Returns* + + ``{E4XElement}`` The WPS DataInputs node for Execute query. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-projection.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-projection.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-projection.txt (revision 672) @@ -0,0 +1,153 @@ +.. _api-zoo-projection: + +ZOO.Projection +============== + +Class for coordinate transforms between coordinate systems. + +Properties +---------- + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`proj ` + - {Number} Proj4js.Proj instance. + * - :ref:`projCode ` + - {String} + +Functions +--------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`ZOO.Projection ` + - This class offers several methods for interacting with a wrapped zoo-pro4js projection object. + * - :ref:`getCode ` + - Get the string SRS code. + * - :ref:`getUnits ` + - Get the units string for the projection -- returns null if zoo-proj4js is not available. + * - :ref:`toString ` + - Convert projection to string (getCode wrapper). + * - :ref:`equals ` + - Test equality of two projection instances. + * - :ref:`destroy ` + - Destroy projection object. + * - :ref:`transform ` + - Transform a point coordinate from one projection to another. + +**Properties** + +.. _proj: + +proj + ``{Object}`` Proj4js.Proj instance. + +.. _projCode: + +projCode + ``{String}`` + +**Functions** + +.. _ZOO.Projection: + +ZOO.Projection + This class offers several methods for interacting with a wrapped zoo-pro4js projection object. + + *Parameters* + + | ``projCode {String}`` A string identifying the Well Known Identifier for the projection. + | ``options {Object}`` An optional object to set additional properties. + + *Returns* + + :ref:`{ZOO.Projection} ` A projection object. + +.. _getCode: + +getCode + :: + + getCode: function() + + Get the string SRS code. + + *Returns* + + ``{String}`` The SRS code. + +.. _getUnits: + +getUnits + :: + + getUnits: function() + + Get the units string for the projection -- returns null if zoo-proj4js is not available. + + *Returns* + + ``{String}`` The units abbreviation. + +.. _toString: + +toString + :: + + toString: function() + + Convert projection to string (getCode wrapper). + + *Returns* + + ``{String}`` The projection code. + +.. _equals: + +equals + :: + + equals: function(projection) + + Test equality of two projection instances. Determines equality based soley on the projection code. + + *Returns* + + ``{Boolean}`` The two projections are equivalent. + +.. _destroy: + +destroy + :: + + destroy: function() + + Destroy projection object. + +.. _transform: + +transform + :: + + ZOO.Projection.transform = function(point,source,dest) + + Transform a point coordinate from one projection to another. Note that the input point is + transformed in place. + + *Parameters* + + | ``point {{ZOO.Geometry.Point> | Object}`` An object with x and y properties representing coordinates in those dimensions. + | ``sourceProj {ZOO.Projection}`` Source map coordinate system + | ``destProj {ZOO.Projection}`` Destination map coordinate system + + *Returns* + + ``point {object}`` A transformed coordinate. The original point is modified. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-request.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-request.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-request.txt (revision 672) @@ -0,0 +1,49 @@ +.. _api-zoo-request: + +ZOO.Request +=========== + +Contains convenience methods for working with ZOORequest which replace XMLHttpRequest. + +Functions +--------- + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`GET ` + - Send an HTTP GET request. + * - :ref:`POST ` + - Send an HTTP POST request. + +.. _GET: + +GET + Send an HTTP GET request. + + *Parameters* + + | ``url {String}`` The URL to request. + | ``params {Object}`` Params to add to the url + + *Returns* + + ``{String}`` Request result. + +.. _POST: + +POST + Send an HTTP POST request. + + *Parameters* + + | ``url {String}`` The URL to request. + | ``body {String}`` The request's body to send. + | ``headers {Object}`` A key-value object of headers to push to the request's head + + *Returns* + + ``{String}`` Request result. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-string.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-string.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo-string.txt (revision 672) @@ -0,0 +1,147 @@ +.. _api-zoo-string: + +ZOO.String +========== + +Contains convenience methods for string manipulation: + +Functions and Properties +------------------------ + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`startsWith ` + - Test whether a string starts with another string. + * - :ref:`contains ` + - Test whether a string contains another string. + * - :ref:`trim ` + - Removes leading and trailing whitespace characters from a string. + * - :ref:`camelize ` + - Camel-case a hyphenated string. + * - :ref:`tokenRegEx ` + - Used to find tokens in a string. + * - :ref:`numberRegEx ` + - Used to test strings as numbers. + * - :ref:`isNumeric ` + - Determine whether a string contains only a numeric value. + * - :ref:`numericIf ` + - Converts a string that appears to be a numeric value into a number. + +.. _startsWith: + +startsWith + :: + + startsWith: function(str,sub) + + Test whether a string starts with another string. + + *Parameters* + + | ``str {String}`` The string to test. + | ``sub {Sring}`` The substring to look for. + + *Returns* + + ``{Boolean}`` The first string starts with the second. + +.. _contains: + +contains + :: + + contains: function(str,sub) + + Test whether a string contains another string. + + *Parameters* + + | ``str {String}`` The string to test. + | ``sub {String}`` The substring to look for. + + *Returns* + + ``{Boolean}`` The first string contains the second. + +.. _trim: + +trim + :: + + trim: function(str) + + Removes leading and trailing whitespace characters from a string. + + *Parameters* + + ``str {String}`` The (potentially) space-padded string. This string is not modified. + + *Returns* + + ``{String}`` A trimmed version of the string with all leading and trailing spaces removed. + +.. _camelize: + +camelize + :: + + camelize: function(str) + + Camel-case a hyphenated string. Ex. "chicken-head" becomes "chickenHead", and "-chicken-head" becomes "ChickenHead". + + *Parameters* + + ``str {String}`` The string to be camelized. The original is not modified. + + *Returns* + + ``{String}`` The string, camelized + +.. _tokenRegEx: + +tokenRegEx + Used to find tokens in a string. Examples: *${a}, ${a.b.c}, ${a-b}, ${5}* + +.. _numberRegEx: + +numberRegEx + Used to test strings as numbers. + +.. _isNumeric: + +isNumeric + :: + + isNumeric: function(value) + + Determine whether a string contains only a numeric value. + + *Examples* + + :: + + ZOO.String.isNumeric("6.02e23") // true + ZOO.String.isNumeric("12 dozen") // false + ZOO.String.isNumeric("4") // true + ZOO.String.isNumeric(" 4 ") // false + + *Returns* + + ``{Boolean}`` String contains only a number. + +.. _numericIf: + +numericIf + :: + + numericIf: function(value) + + Converts a string that appears to be a numeric value into a number. + + *Returns* + + ``{Number|String}`` a Number if the passed value is a number, a String otherwise. Index: /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/api/zoo.txt (revision 672) @@ -0,0 +1,188 @@ +.. _api-zoo: + +ZOO +=== + +The following constants and functions are available for the ZOO class: + +Constants +--------- + +.. list-table:: + :widths: 30 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`SERVICE_ACCEPTED ` + - {Integer} used for + * - :ref:`SERVICE_STARTED ` + - {Integer} used for + * - :ref:`SERVICE_PAUSED ` + - {Integer} used for + * - :ref:`SERVICE_SUCCEEDED ` + - {Integer} used for + * - :ref:`SERVICE_FAILED ` + - {Integer} used for + +Functions +--------- + +.. list-table:: + :widths: 12 50 + :header-rows: 1 + + * - NAME + - DESCRIPTION + * - :ref:`removeItem ` + - Remove an object from an array. + * - :ref:`indexOf ` + - + * - :ref:`extend ` + - Copy all properties of a source object to a destination object. + * - :ref:`rad ` + - + * - :ref:`distVincenty ` + - Given two objects representing points with geographic coordinates, + this calculates the distance between those points on the surface of an + ellipsoid. + * - :ref:`Class ` + - Method used to create ZOO classes. + * - :ref:`UpdateStatus ` + - Method used to update the status of the process + +**Constants** + +.. _service_accepted: + +SERVICE_ACCEPTED + ``{Integer}`` used for + +.. _service_started: + +SERVICE_STARTED + ``{Integer}`` used for + +.. _service_paused: + +SERVICE_PAUSED + ``{Integer}`` used for + +.. _service_succeeded: + +SERVICE_SUCCEEDED + ``{Integer}`` used for + +.. _service_failed: + +SERVICE_FAILED + ``{Integer}`` used for + +**Functions** + +.. _removeItem: + +removeItem + :: + + removeItem: function(array,item) + + Remove an object from an array. Iterates through the array to find the item, then removes it. + + *Parameters* + + | ``array {Array}`` + | ``item {Object}`` + + *Returns* + + ``{Array}`` A reference to the array + +.. _indexOf: + +indexOf + :: + + indexOf: function(array,obj) + + *Parameters* + + | ``array {Array}`` + | ``obj {Object}`` + + *Returns* + + ``{Integer}`` The index at, which the first object was found in the array. If not found, returns -1. + +.. _extend: + +extend + :: + + extend: function(destination,source) + + Copy all properties of a source object to a destination object. Modifies the passed in destination object. + Any properties on the source object that are set to undefined will not be (re)set on the destination object. + + *Parameters* + + | ``destination {Object}`` The object that will be modified + | ``source {Object}`` The object with properties to be set on the destination + + *Returns* + + ``{Object}`` The destination object. + +.. _rad: + +rad + :: + + rad: function(x) + + *Parameters* + + | ``x {Float}`` + + *Returns* + + ``{Float}`` + +.. _distVincenty: + +distVincenty + :: + + distVincenty: function(p1,p2) + + Given two objects representing points with geographic coordinates, this calculates the distance between + those points on the surface of an ellipsoid. + + *Parameters:* + + | ``p1`` :ref:`{ZOO.Geometry.Point} ` (or any object with both .x, .y properties) + | ``p2`` :ref:`{ZOO.Geometry.Point} ` (or any object with both .x, .y properties) + +.. _Class: + +Class + :: + + Class: function() + + Method used to create ZOO classes. Includes support for multiple inheritance. + +.. _UpdateStatus: + +UpdateStatus + :: + + UpdateStatus: function(env,value) + + Method used to update the status of the process + + *Parameters* + + | ``env {Object}`` The environment object + | ``value {Float}`` The status value between 0 to 100 + Index: /branches/PublicaMundi_David_integration_01-devel/docs/client/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/client/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/client/index.txt (revision 672) @@ -0,0 +1,12 @@ +.. _client: + +ZOO-Client Documentation +======================== + +The following sections will assist you with the ZOO-Client: + +.. toctree:: + :maxdepth: 2 + + introduction + Index: /branches/PublicaMundi_David_integration_01-devel/docs/client/introduction.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/client/introduction.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/client/introduction.txt (revision 672) @@ -0,0 +1,235 @@ +.. _services-howtos: + +How To Use ZOO-Client +========================= + +:Authors: Nicolas Bozon, Luca Delucchi, Gérald Fenoy, Jeff McKenna +:Last Updated: $Id$ + +ZOO-Client is a client-side Javascript API which ease the +use and integration of WPS in your web applications. + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +Requirements +---------------------- + +The ZOO-Client is depending on various Javscript libraries, they are +axhaustively listed bellow: + * `jQuery `__ + * `x2js `__ + * `requirejs `__ + * `Hogan.js `__ + * `query-string `__ + +Compile mustache templates +************************** + +For being able to use the ZOO-Client API from your web appplication +you will need to compile the mustache templates files located in the +tpl directory. This compilation process imply that you have setup +`node.js `__ on your computer. + +:: + + sudo npm install hogan + hulk zoo-client/lib/tpl/*mustache > \ + zoo-client/lib/js/wps-client/payloads.js + +.. Note:: the Hogan version used to compile the template should be the + same as the one used from your web application, in other case you + may face compatibility issue. + +Build the API documentation +*************************** + +You can build the ZOO-Client API documentation by using jsDoc, to +build the docuementation use the following command: + +:: + + npm install jsdoc + ~/node_modules/.bin/jsdoc zoo-client/lib/js/wps-client/* -p + +This will build the documentation in a directory named `out` in your +current working directory. + +Create your first application +----------------------------- + +For this first application, we will suppose that you have setup a +directory named `zoo-client-demo` accessible from your server by using +`http://localhost/zoo-client-demo`. In this directory, you should have +the following subdirectories: + +:: + + assets + assets/js + assets/js/lib + assets/js/lib/hogan + assets/js/lib/jquery + assets/js/lib/query-string + assets/js/lib/xml2json + assets/js/lib/zoo + assets/tpl + +You will need to copy your node_modules javascript files copied in the +`hogan` and `query-string` directories. First, you wil need to install +query-string. + +:: + + npm install query-string + +Then you will copy `query-string.js` and `hogan-3.0.2.js` files in +your `zoo-client-demo` web directory. Those files are located in your +`~/node_modules` directory. + +For other libraries, you will need to download them from their +official web sites and uncompress them in the corresponding +directories. + +Loading the modules from your web application +********************************************* + +Before using the ZOO-Client, you will first have to include the +javascript files from your web page. With the use of requirejs you +will need only one line in your HTML page to include everything at +once. This line will look like the following: + +:: + + + +In this example, we suppose that you have created a `first.js` file +in the `assets/js` directory containing your main application +code. First, you define there the required JavaScript libraries and +potentially their configuration, then you can add any relevant code. + +.. code-block:: javascript + :linenos: + + requirejs.config({ + baseUrl: 'assets/js', + paths: { + jquery: 'lib/jquery/jquery-1.11.0.min', + hogan: 'lib/hogan/hogan-3.0.2', + xml2json: 'lib/xml2json/xml2json.min', + queryString: 'lib/query-string/query-string', + wpsPayloads: 'lib/zoo/payloads', + wpsPayload: 'lib/zoo/wps-payload', + utils: 'lib/zoo/utils', + zoo: 'lib/zoo/zoo', + domReady: 'lib/domReady', + app: 'first-app', + }, + shim: { + wpsPayloads: { + deps: ['hogan'], + }, + wpsPayload: { + deps: ['wpsPayloads'], + exports: 'wpsPayload', + }, + hogan: { + exports: 'Hogan', + }, + xml2json: { + exports: "X2JS", + }, + queryString: { + exports: 'queryString', + }, + }, + }); + + requirejs.config({ + config: { + app: { + url: '/cgi-bin/zoo_loader.cgi', + delay: 2000, + } + } + }); + + require(['domReady', 'app'], function(domReady, app) { + domReady(function() { + app.initialize(); + }); + }); + +On line 2, you define the url where your files are located on the web +server, in `assets/js`. From line 3 to 14, you define the JavaScript +files to be loaded. From line 15 to 21, you configure the dependencies +and exported symbols. From line 35 to 42, you configure your main +application. + +In this application, we use the `domReady +`__ module to call the +`initialize` function defined in the `app` module, which is defined in +the `first-app.js` file as defined on line 13. + + + +.. code-block:: javascript + :linenos: + + define([ + 'module','zoo','wpsPayload' + ], function(module, ZooProcess, wpsPayload) { + + var myZooObject = new ZooProcess({ + url: module.config().url, + delay: module.config().delay, + }); + + var initialize = function() { + self = this; + myZooObject.getCapabilities({ + type: 'POST', + success: function(data){ + console.log(data); + } + }); + + myZooObject.describeProcess({ + type: 'POST', + identifier: "all", + success: function(data){ + console.log(data); + } + }); + + myZooObject.execute({ + identifier: "Buffer", + dataInputs: [{"identifier":"InputPolygon","href":"XXX","mimeType":"text/xml"}], + dataOutputs: [{"identifier":"Result","mimeType":"application/json","type":"raw"}], + type: 'POST', + success: function(data) { + console.log(data); + }, + error: function(data){ + console.log(data); + } + }); + } + + // Return public methods + return { + initialize: initialize + }; + + }); + +On line 5 you create a "global" `ZooProcess` instance named +`myZooObject`, you set the `url` and `delay` to the values defined in +`first.js` on line 35. From line 10 to 40, you define a simple +`initialize` function which will invoke the `getCapabilities` (line +12 to 18), `describeProcess` (from line 20 to 26) and `execute` (from +line 28 to 39) methods. For each you define a callback function which +will simply display the resulting data in the browser's console. + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/community/developer.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/community/developer.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/community/developer.txt (revision 672) @@ -0,0 +1,99 @@ +.. _community_developer: + +ZOO-Project Committer Guildlines +================================ + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +Election to SVN Commit Access +----------------------------- + +Permission for SVN commit access shall be provided to new developers only if accepted by the ZOO-Project Project Steering Committee. A proposal should be written to the PSC for new committers and voted. + +Removal of SVN commit access should be handled by the same process. + +The new committer should have demonstrated commitment to ZOO-Project and knowledge of the ZOO-Project source code and processes to the committee's satisfaction, usually by reporting bugs, submitting patches, and/or actively participating in the ZOO-Project mailing list(s). + +The new committer should also be prepared to support any new feature or changes that he/she commits to the ZOO-Project source tree in future releases, or to find someone to which to delegate responsibility for them if he/she stops being available to support the portions of code that he/she is responsible for. + +All committers should also be a member of the zoo-discuss mailing list so they can stay informed on policies, technical developments and release preparation. + +New commiters are responsible for having read, and understood this +document. + +Committer Tracking +------------------ + +A list of all project committers will be kept in the main zoo-project directory (called COMMITTERS) listing for each SVN committer: + + * Userid: the id that will appear in the SVN logs for this person. + * Full name: the users actual name. + * Email address: A current email address at which the committer can be reached. It may be altered in normal ways to make it harder to auto-harvest. + +SVN Administrator +----------------- + +One member of the Project Steering Committee will be designed the SVN Administrator. That person will be responsible for giving SVN commit access to folks, updating the COMMITTERS file, and other SVN related management. That person will need login access on the SVN server of course. + +Initially Gérald Fenoy will be the SVN Adminstrator. + +SVN Commit Practices +-------------------- + +The following are considered good SVN commit practices for the ZOO-Project project. + + * Use meaningful descriptions for SVN commit log entries. + * Add a bug reference like "(#1234)" at the end of SVN commit log entries when committing changes related to a ticket in Trac. The '#' character enables Trac to create a hyperlink from the changeset to the mentionned ticket. + * After commiting changes related to a ticket in Trac, write the tree and revision in which it was fixed in the ticket description. Such as "Fixed in trunk (r12345) and in branches/1.7 (r12346)". The 'r' character enables Trac to create a hyperlink from the ticket to the changeset. + * Changes should not be committed in stable branches without a corresponding bug id. Any change worth pushing into the stable version is worth a bug entry. + * Never commit new features to a stable branch without permission of the PSC or release manager. Normally only fixes should go into stable branches. + * New features go in the main development trunk. + * Only bug fixes should be committed to the code during pre-release code freeze, without permission from the PSC or release manager. + * Significant changes to the main development version should be discussed on the zoo-discuss list before you make them, and larger changes will require a to be discussed and approved on zoo-psc list by the PSC. + * Do not create new branches without the approval of the PSC. Release managers are assumed to have permission to create a branch. + * All source code in SVN should be in Unix text format as opposed to DOS text mode. + * When committing new features or significant changes to existing source code, the committer should take reasonable measures to insure that the source code continues to build and work on the most commonly supported platforms (currently Linux and Windows), either by testing on those platforms directly, running Buildbot tests, or by getting help from other developers working on those platforms. If new files or library dependencies are added, then the configure.in, Makefile.in, Makefile.vc and related documentations should be kept up to date. + +Legal +----- + +Committers are the front line gatekeepers to keep the code base clear of improperly contributed code. It is important to the ZOO-Project users, developers and the OSGeo foundation to avoid contributing any code to the project without it being clearly licensed under the project license. + +Generally speaking the key issues are that those providing code to be included in the repository understand that the code will be released under the MIT/X license, and that the person providing the code has the right to contribute the code. For the commiter themselves understanding about the license is hopefully clear. For other contributors, the commiter should verify the understanding unless the commiter is very comfortable that the contributor understands the license (for instance frequent contributors). + +If the contribution was developed on behalf of an employer (on work time, as part of a work project, etc) then it is important that an appropriate representative of the employer understand that the code will be contributed under the MIT/X license. The arrangement should be cleared with an authorized supervisor/manager, etc. + +The code should be developed by the contributor, or the code should be from a source which can be rightfully contributed such as from the public domain, or from an open source project under a compatible license. + +All unusual situations need to be discussed and/or documented. + +Committers should adhere to the following guidelines, and may be personally legally liable for improperly contributing code to the source repository: + + * Make sure the contributor (and possibly employer) is aware of the contribution terms. + * Code coming from a source other than the contributor (such as adapted from another project) should be clearly marked as to the original source, copyright holders, license terms and so forth. This information can be in the file headers, but should also be added to the project licensing file if not exactly matching normal project licensing (zoo-project/zoo-kernel/LICENSE). + * Existing copyright headers and license text should never be stripped from a file. If a copyright holder wishes to give up copyright they must do so in writing to the foundation before copyright messages are removed. If license terms are changed it has to be by agreement (written in email is ok) of the copyright holders. + * Code with licenses requiring credit, or disclosure to users should be added to /trunk/zoo-project/zoo-kernel/LICENSE. + * When substantial contributions are added to a file (such as substantial patches) the author/contributor should be added to the list of copyright holders for the file. + * If there is uncertainty about whether a change it proper to contribute to the code base, please seek more information from the project steering committee, or the foundation legal counsel. + +Bootstrapping +------------ + +The following existing commiters will be considered authorized ZOO-Project committers as long as they each review the commiter guidelines, and agree to adhere to them. The SVN administrator will be responsible for checking with each person. + + * David SAGGIORATO (aka david) + * Gérald FENOY (aka djay) + * Jeff MCKENNA (aka jmckenna) + * Angelos TZOTSOS (aka kalxas) + * Luca DELUCCHI (aka lucadelu) + * Nicolas BOZON (aka nbozon) + * Markus NETELER (aka neteler) + * Marco NEGRETTI (aka nmarco) + * Knut LANDMARK (aka knut) + * René-Luc D'HONT (aka reluc) + * Trevor CLARKE (aka tclarke) Index: /branches/PublicaMundi_David_integration_01-devel/docs/community/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/community/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/community/index.txt (revision 672) @@ -0,0 +1,14 @@ +.. _community: + +ZOO Community +============= + +The following sections will help you interact with the ZOO community. + +.. toctree:: + :maxdepth: 2 + + developer + mailinglist + irc + Index: /branches/PublicaMundi_David_integration_01-devel/docs/community/irc.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/community/irc.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/community/irc.txt (revision 672) @@ -0,0 +1,59 @@ +.. _community-irc: + +IRC Chat +======== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi +:Last Updated: $Date$ + +Some of the development of the ZOO-Project is coordinated through IRC. This page +describes how you log on to chat, ask questions, and hack around with the +developers. + +Server and Channel Information +------------------------------ + +:: + + Server: irc.freenode.net + Channel: #zoo-project + +Why IRC? +-------- + +IRC is a primary medium where Open Source GIS hackers congregate, collaborate, +and hack. It makes it easy to communicate things like compilation issues, +where immediate, iterative feedback allows folks to make a lot of progress. +Something that might take days of heavily-quoted emails through a mailinglist +might only take fifteen minutes on IRC. + +IRC is a great way to coordinate on-line meetings. The ZOO PSC conducts their +monthly meetings through IRC. + +How do I join? +-------------- + +- `Chatzilla `__ is + probably the easiest way to get going. Chatzilla works with Mozilla or + Firefox, and once you have it installed, you can log on to the channel by + pointing your browser at:: + + irc://irc.freenode.net/#zoo-project + +- There are many other IRC clients available. `This page + `__ provides a good listing for many + different platforms. + +- You can also connect to IRC directly in your Web browser without a client: + + - goto http://webchat.freenode.net/ + - enter a nickname (usually your first initial plus your last name) + - in "Channels" enter: zoo-project + - Connect! + +IRC logs +----------- + +It is possible to see the logs (history) of ZOO-Project IRC channel +`here `_ + Index: /branches/PublicaMundi_David_integration_01-devel/docs/community/mailinglist.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/community/mailinglist.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/community/mailinglist.txt (revision 672) @@ -0,0 +1,28 @@ +.. _community-mailinglist: + +Mailing Lists +============= + +ZOO-Discuss +----------- + +The ``zoo-discuss`` list is your main source of support for the ZOO-Project. + +- **Subscribing to zoo-discuss** + + To subscribe to the zoo-discuss listserv visit + http://lists.osgeo.org/cgi-bin/mailman/listinfo/zoo-discuss. You can later change + your subscription information or leave the list at this website. + +- **Submitting Questions to zoo-discuss** + + To submit questions to the zoo-discuss listserv, first join the list by + following the subscription procedure above. Then post questions to the list by + sending an email message to zoo-discuss@lists.osgeo.org. + +- **Searching the Archives** + + All zoo-discuss archives are located in + http://lists.osgeo.org/pipermail/zoo-discuss/. + +.. Searching the archives is best done with `Nabble `_.: Index: /branches/PublicaMundi_David_integration_01-devel/docs/conf.py =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/conf.py (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/conf.py (revision 672) @@ -0,0 +1,267 @@ +# -*- coding: utf-8 -*- +# +# ZOO Project documentation build configuration file, created by +# sphinx-quickstart on Tue Mar 08 12:11:20 2011. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.txt' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'ZOO Project' +copyright = u'2011, Nicolas Bozon, Gérald Fenoy, Jeff McKenna' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '1.0' +# The full version, including alpha/beta/rc tags. +release = '1.4' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "rightsidebar": "true", + "headbgcolor": "#ffffff", + "bgcolor": "#ffffff", + "textcolor": "#333333", + "linkcolor": "#fc9326", + "visitedlinkcolor": "#fc9326", + "sidebarbgcolor": "white", + "relbarbgcolor": "#ffa500" +} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +html_title = "ZOO Project " + release + " documentation" + +# A shorter title for the navigation bar. Default is the same as html_title. +html_short_title = "ZOO Docs" + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = "favicon.ico" + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +html_sidebars = { +'**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'], +"index":["indexsidebar.html",'searchbox.html']} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +html_show_copyright = False + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ZOOProjectdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'ZOOProject.tex', u'ZOO Project Documentation', + u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +latex_logo = './_static/images/zoo-banner-large.png' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +latex_preamble = '\setcounter{tocdepth}{3}' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'zooproject', u'ZOO Project Documentation', + [u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna'], 1) +] + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'ZOO Project' +epub_author = u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna' +epub_publisher = u'Nicolas Bozon, Gérald Fenoy, Jeff McKenna' +epub_copyright = u'2011, Nicolas Bozon, Gérald Fenoy, Jeff McKenna' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +epub_scheme = 'URL' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +epub_identifier = 'http://zoo-project.org' + +# A unique identification for the text. +#epub_uid = '' + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True Index: /branches/PublicaMundi_David_integration_01-devel/docs/development/documentation.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/development/documentation.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/development/documentation.txt (revision 672) @@ -0,0 +1,179 @@ +.. _documentation_development: + +Documentation Development Guide +=============================== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + + +License +----------------- + +The ZOO-Project documentation is released under the `Creative Commons Attribution-ShareAlike 4.0 International Public License `__ (CC-BY-SA). This license must be kept when editing or creating a new documentation file. + +.. image:: ../../_static/images/by-sa.png + :target: https://creativecommons.org/licenses/by-sa/4.0/legalcode/ + :height: 31px + :width: 88px + + +Background +---------- + +The current structure of the ZOO Project documentation process is for +developers with :ref:`SVN ` commit access to maintain their documents +in reStructuredText format, and therefore all documents live in the +/docs directory in SVN. The `Sphinx `__ documentation generator is +used to convert the reStructuredText files to html, and the live +website is then updated on an hourly basis. + +reStructuredText Reference Guides +--------------------------------- + +- Docutils `Quick reStructuredText `__ +- Docutils `reStructuredText Directives `__ +- Sphinx's `reStructuredText Primer `__ +- search Sphinx's `mailing list `__ + +reStructuredText Formatting +--------------------------- + +- All text should be hard breaks at or around the 80 column mark, just as + the source code. + +Installing and Using Sphinx for rst-html Generation +--------------------------------------------------- + +.. note:: + + You can browse the versions of the Sphinx packages `here `__, + and then install the exact version such as: + + :: + + easy_install Sphinx==1.0.7 + + +**On Windows:** + +#. install `Python 2.X `__ +#. download `setuptools `__ +#. make sure that the ``C:/Python2X/Scripts`` directory is your path +#. execute the following at commandline: + + :: + + easy_install Sphinx + + ...you should see message: "Finished processing dependencies for Sphinx" + + .. note:: + + Make sure you install Sphinx 1.0 or more recent. See note above. + +#. install `MiKTeX `__ if you want to build pdfs + +#. checkout the /docs directory from SVN, such as: + + :: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +#. inside the /docs directory, execute: + + :: + + make html + + or + + :: + + make latex + + the HTML output will be written to the _build/html sub-directory. + +**On Linux:** + +#. make sure you have the Python dev and setuptools packages installed. + On Ubuntu: + + :: + + sudo apt-get install python-dev + sudo apt-get install python-setuptools + +#. install sphinx using easy_install: + + :: + + sudo easy_install Sphinx + + .. note:: + + Make sure you install Sphinx 1.0 or more recent. See note above. + +#. checkout the /docs directory from SVN, such as: + + :: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +#. to process the docs, from the ZOO /docs directory, run: + + :: + + make html + + or + + :: + + make latex + + the HTML output will be written to the build/html sub-directory. + +.. note:: + + If there are more than one translation, the above commands will automatically + build all translations. + + +**On Mac OS X:** + +#. install sphinx using easy_install: + + :: + + sudo easy_install Sphinx + + .. note:: + + Make sure you install Sphinx 1.0 or more recent. See note above. + +#. install `MacTex `__ if you want to build pdfs + +#. checkout the /docs directory from SVN, such as: + + :: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +#. to process the docs, from the ZOO /docs directory, run: + + :: + + make html + + or + + :: + + make latex + + the HTML output will be written to the build/html sub-directory. Index: /branches/PublicaMundi_David_integration_01-devel/docs/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/index.txt (revision 672) @@ -0,0 +1,85 @@ +.. _home: + +ZOO 1.5 Documentation +===================== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +Quick Links +=========== + +.. csv-table:: Quick Links + + :ref:`kernel`,:ref:`services`,:ref:`api` + :ref:`kernel-installation`,:ref:`community`,`Search mailing list `__ + :ref:`documentation_development`,:ref:`workshop-foss4g-2014` + +.. note:: + The entire documentation is also available as a single + `PDF document <./ZOOProject.pdf>`__ |image| and `ePub document <./ZOOProject.epub>`__ + +About ZOO Documentation +======================= + +ZOO Documentation is a collaborative process; once users contribute documentation +through the ZOO Wiki, the Documentation Committee will then review the contributions +to add them into the official docs. The committee is currently composed of: + +:: + + Nicolas Bozon (nicolas.bozon at gmail.com) + Gérald Fenoy (gerald.fenoy at geolabs.fr) + Jeff McKenna (jmckenna at gatewaygeomatics.com) + +A special thank to the ZOO-Project sponsors and knwoledge partners for their support. + +The committee would like to thank ``Venkatesh Raghavan`` for his help on promoting ZOO Workshop in many places. + +The committee would like to thank ``Hirofumi Hayashi`` and ``Daisuke Yoshida`` for their help and japanese translation effort for the ZOO-Project Worshop 2010. + +The committee would also like to thank the early contributors to the documentation: ``Luca Delucchi``, ``René-Luc D'Hont``, ``Angelos Tzotsos`` and ``Guillaume Sueur``. + +License +======================= + +The ZOO-Project documentation is released under the +`Creative Commons Attribution-ShareAlike 4.0 International Public License `__ +(CC-BY-SA). This license must be kept when editing or creating a new documentation file. + +.. image:: ./_static/images/by-sa.png + :target: https://creativecommons.org/licenses/by-sa/4.0/legalcode/ + :height: 31px + :width: 88px + + +ZOO Wiki +======== + +Users wishing to contribute steps and documents should use the +`ZOO Wiki `__. + +Official Documentation +====================== + +This section contains the official ZOO Project documentation. + +.. |image| image:: _static/images/pdf.png + :height: 15 + :width: 15 + :alt: PDF icon + :target: /ZOOProject.pdf + +.. toctree:: + :maxdepth: 3 + + kernel/index + services/index + api/index + client/index + workshop/2014/index + community/index + development/documentation + + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/index.txt (revision 672) @@ -0,0 +1,16 @@ +.. _kernel: + +ZOO Kernel Documentation +======================== + +The following sections will assist you with the ZOO Kernel: + +.. toctree:: + :maxdepth: 2 + + introduction + installation + mapserver + orfeotoolbox + sagagis + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-centos.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-centos.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-centos.txt (revision 672) @@ -0,0 +1,168 @@ +.. _kernel-installation-centos: + +CentOS +====== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +.. note:: + This documentation was created thanks to Guillaume Sueur from Neogeo Technologies which took time to test + installing the ZOO-Kernel on a CentOS 5.5 environment. + +Requirements +------------ + +Install some standard tools to be able to run ZOO-Kernel on your platform : + +:: + + yum install apache2 + yum install build-essentials + yum install gcc-c++ + yum install zlib-devel + yum install libxml2-devel + yum install bison + yum install openssl + yum install python-devel + yum install subversion + +Compile then install FastCGI library from source + +:: + + wget http://www.fastcgi.com/dist/fcgi.tar.gz + tar xzf fcgi-2.4.0.tar.gz + ./configure + make + make install + echo /usr/local/lib >> /etc/ld.so.conf.d/local.conf + ldconfig + +Compile then install the autoconf tools : + +:: + + wget http://ftp.gnu.org/gnu/autoconf/autoconf-latest.tar.gz + tar xzf autoconf-latest.tar.gz + ./configure --prefix=/usr + make + make install + +Compile then install the flex tool : + +:: + + wget http://downloads.sourceforge.net/project/flex/flex/flex-2.5.35/flex-2.5.35.tar.gz?r=http%3A%2F%2Fflex.sourceforge.net%2F&ts=1292529005&use_mirror=switch + tar xzf flex-2.5.35.tar.gz + cd flex-2.5.35 + ./configure --prefix=/usr + make + make install + +Using the curl provided in the CentOS distribution will produce a ZOO-Kernel unable to run any +Service. Indeed, some segmentation faults occur when trying to run ``Execute`` requests on the ZOO-Kernel, +compiling the ZOO-Kernel setting ``USE_GDB`` flag in the ``CFLAGS`` of your ``Makefile`` will let you run +ZOO-Kernel from gdb and be able to get more information on what is going wrong with your ZOO-Kernel. +Doing this we can figure out that code on `line 173 `__ +and `line 175 `__ have to be commented in the +``ulinet.c`` file to get a ZOO-Kernel working using the curl available in CentOS (curl version 7.15.5). +If you don't apply the modification, you will get an error from a gdb session pointing +segfault in ``Curl_cookie_clearall``. + +You can optionally compile then install curl from source : + +:: + + wget http://curl.haxx.se/download/curl-7.21.3.tar.bz2 + tar xjf curl-7.21.3.tar.bz2 + cd curl-7.21.3 + ./configure --prefix=/usr + make + make install + +Compile then install Python : + +:: + + wget http://www.python.org/ftp/python/2.6.6/Python-2.6.6.tar.bz2 + tar xjf Python-2.6.6.tar.bz2 + cd Python-2.6.6 + ./configure + make + make install + +Compile then install your own GDAL library : + +:: + + wget http://download.osgeo.org/gdal/gdal-1.7.3.tar.gz + tar xzf gdal-1.7.3.tar.gz + cd gdal-1.7.3 + ./configure # add your options here + make + make install + +Install the Sun JAVA SDK into ``/usr/share`` then use the following command to ensure that the ``libjvm.so`` +will be found at runtime from any context. + +:: + + echo /usr/share/java-1.6.0-openjdk-1.6.0.0/jre/lib/i386/client/ >> /etc/ld.so.conf.d/jvm.conf + ldconfig + +Compile ZOO-Kernel and ZOO-Services +----------------------------------- + +Compile then install ZOO-Kernel and your first ZOO-Services. + +First of all, compile the cgic library providen in the SVN source tree: + +:: + + svn co http://svn.zoo-project.org/svn/trunk zoo-project + cd zoo-project/thirds/cgic206 + make + +Compile then install ZOO-Kernel. + +:: + + cd ../../zoo-kernel + ./configure --with-java=/usr/share/jdk1.6.0_23/ --with-python + make zoo_loader.cgi + cp main.cfg /var/www/cgi-bin/ + cp zoo_loader.cgi /var/www/cgi-bin/ + +Compile then deploy your first ZOO-ServicesProviders (simple HelloPy, line 1 and 2, and the OGR base-vect-ops +ServiceProvider, line 3 to 6): + +:: + + cp ../zoo-services/hello-py/cgi-env/*.zcfg /var/www/cgi-bin/ + cp ../zoo-services/hello-py/test_service.py /var/www/cgi-bin/ + cd ../ogr/base-vect-ops/ + make + cp ./cgi-env/* /var/www/cgi-bin/ + vi /var/www/cgi-bin/main.cfg --> set your own informations here + +To ensure that the ``libjvm.so`` will be found from apache, please restart it : + +:: + + /etc/init.d/httpd restart + +Testing your ZOO-Kernel +----------------------- + +Test your ZOO-Kernel from command line: + +:: + + cd /var/www/cgi-bin + ./zoo_loader.cgi "request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Djay" + ./zoo_loader.cgi "request=Execute&service=WPS&version=1.0.0&Identifier=Buffer&DataInputs=BufferDistance=1@datat Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-debian.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-debian.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-debian.txt (revision 672) @@ -0,0 +1,253 @@ +.. _kernel-installation-debian: + +Debian / Ubuntu +=============== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +.. note:: + An Ubuntu 10.4 with ZOO virtual image is available at http://www.zoo-project.org/Ubuntu10.4_ZOO.zip + (root: ZOO.test) + +Ubuntu 12.04 dependencies +-------------------------------------- + +- install default dependencies + +:: + + sudo apt-get install flex bison libfcgi-dev libxml2 libxml2-dev curl openssl autoconf apache2 python-software-properties subversion libmozjs185-dev python-dev build-essential + +- add ubuntugis repository to obtain the newer GIS libraries + +:: + + sudo add-apt-repository ppa:ubuntugis/ppa + sudo apt-get update + + +- install geographic library + +:: + + sudo apt-get install libgdal1-dev + +- download ZOO source + +Debian 7.0 dependencies +-------------------------------------- + +- install dependencies + +:: + + apt-get install flex bison libfcgi-dev libxml2 libxml2-dev curl openssl autoconf apache2 python-software-properties subversion python-dev libgdal1-dev build-essential libmozjs185-dev + + +Installation Workflow +-------------------------------------- + +.. note :: In the following lines you will find ``as administrator user`` note, + on Ubuntu you have to add ``sudo`` at the beginning of line, on Debian + you can use ``su -c COMMAND``) + +:: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +- install cgic from packages + +:: + + cd zoo-project/thirds/cgic206/ + +- compile + +:: + + make + +- if you want use Mapserver (optional) for WMS, WFS and WCS output read :ref:`mapserver` + +- go to kernel path + +:: + + cd ../../zoo-project/zoo-kernel/ + +- create configure file + +:: + + autoconf + +- run configure + +:: + + ./configure --with-js --with-python + +.. note:: For PHP, you must make sure to compile PHP with `--enable-embed `__. + +.. note:: To use MapServer add the option ``--with-mapserver=/path/to/mapserver/source`` + +- compile + +:: + + make + +- copy necessary files into your cgi-bin (as administrator user) + + +:: + + cp main.cfg /usr/lib/cgi-bin + cp zoo_loader.cgi /usr/lib/cgi-bin + +- install ZOO ServiceProvider, in this case we try Python service (as administrator user) + +:: + + cp ../zoo-services/hello-py/cgi-env/*.zcfg /usr/lib/cgi-bin + cp ../zoo-services/hello-py/*.py /usr/lib/cgi-bin/ + +- change some information in the main.cfg (as administrator user) + +:: + + nano /usr/lib/cgi-bin/main.cfg + - serverAddress = http://127.0.0.1 + + +- try the installation + + - http://127.0.0.1/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=GetCapabilities&Version=1.0.0 + - http://127.0.0.1/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=DescribeProcess&Version=1.0.0&Identifier=HelloPy + - http://127.0.0.1/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=Execute&Version=1.0.0&Identifier=HelloPy&DataInputs=a=myname + +.. note:: + If you have some problem in the execute request using Python service, add the following to ``main.cfg``: + + :: + + [env] + PYTHONPATH= + + +Rewrite rule configuration +----------------------------- + +- for better readability and fully functional ZOO Kernel, you have to modify the default + Apache configuration in order to be able to use the http://localhost/zoo/ url directly. + Run (as administrator user) + +:: + + nano /usr/lib/cgi-bin/main.cfg + - serverAddress = http://localhost/zoo + +- first, please create a ``zoo`` directory in ``/var/www/`` which is used by Apache as the + DocumentRoot (as administrator user) + +:: + + mkdir /var/www/zoo + +- Then, please edit the ``/etc/apache2/sites-available/default`` configuration file and add the following + lines after the Directory block related to /var/www directory (as administrator user) + +:: + + + Options Indexes FollowSymLinks MultiViews + AllowOverride All + Order allow,deny + allow from all + + +- now create a small .htaccess file in the ``/var/www/zoo`` containing the following lines (as administrator user) + +:: + + RewriteEngine on + RewriteRule call/(.*)/(.*) /cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=$1&DataInputs=sid=$2&RawDataOutput=Result [L,QSA] + RewriteRule (.*)/(.*) /cgi-bin/zoo_loader.cgi?metapath=$1 [L,QSA] + RewriteRule (.*) /cgi-bin/zoo_loader.cgi [L,QSA] + + +- for this last file to be taken into account by Apache, you must activate the + rewrite Apache module by copying a load file as bellow (as administrator user) + +:: + + cp /etc/apache2/mods-available/rewrite.load /etc/apache2/mods-enabled/ + +- or using the a2enmod tool this way (as administrator user) + +:: + + a2enmod rewrite + +- now you should be able to access the ZOO Kernel using a simplified by restarting + your Apache Web server (as administrator user) + +:: + /etc/init.d/apache2 restart + +- now you can try: + + - http://localhost/zoo/?Service=WPS&Request=GetCapabilities&Version=1.0.0 + - http://localhost/zoo/?Service=WPS&Request=DescribeProcess&Version=1.0.0&Identifier=HelloPy + - http://localhost/zoo/?Service=WPS&Request=Execute&Version=1.0.0&Identifier=HelloPy&DataInputs=a=myname + +.. _mapserver: + +Compile MapServer +------------------ + +- install MapServer dependencies (as administrator user) + +:: + + apt-get install git libfreetype6-dev libproj-dev libkml-dev libcairo-dev libxml2-dev libgd2-xpm-dev libxslt1-dev + +- extract MapServer from git repository + +:: + + git clone https://github.com/mapserver/mapserver.git + cd mapserver + git checkout branch-6-2 + git pull + +- now compile MapServer + +:: + + ./configure --with-ogr --with-gdal --with-wfsclient --with-wmsclient --with-tiff --with-jpeg --with-gd --with-wcs --with-sos --with-xml2-config --with-wfs --with-fastcgi --with-proj --with-cairo --with-kml=yes --with-xslt --with-threads --with-geos + make + +- now install MapServer (as administrator user) + +:: + + make install + +- now add path to libraries path (as administrator user) + +:: + + nano /etc/ld.so.conf.d/mapserver.conf + - /usr/local/lib/ + +- run as administrator + +:: + + ldconfig Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-mac.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-mac.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-mac.txt (revision 672) @@ -0,0 +1,191 @@ +.. _kernel-installation-mac: + +Mac OS X +======== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +Using the Installer +------------------- + +1. To install a default build of the ZOO-Project on your Mac OS X computer use the `installer `__. + + .. note:: + The installer assumes that you are using the distributed Apache2 version that comes with your Mac. The installer will + place ZOO-Kernel and ZOO-Services into your cgi-bin at ``/Library/WebServer/CGI-Executables``, and the zoo-demo folder + will be placed within your document root at ``/Library/WebServer/Documents`` + +2. Make sure that your Apache server is running, and then access the ZOO Project Demo at: + + http://localhost/zoo-demo/spatialtools.html + +3. To add additional services, please follow the following intructions to compile your own ZOO Project instance. + +Compiling from Source +--------------------- + +1. Install `Xcode `__. + +2. Before you start downloading the ZOO-Project source code, you'll need to install some tools required to + compile ZOO-Kernel properly. + + First of all install PROJ, GEOS and GDAL frameworks from `here `__. + + At this step, you should get the following directories on your local hard drive : + + :: + + /Library/Frameworks/PROJ.framework + /Library/Frameworks/GEOS.framework + /Library/Frameworks/GDAL.framework + +3. Then, create a ``src`` directory and inside that directory download the `gettext source code `__ and uncompress it. + + now, compile gettext with the following commands to produce a universal binary : + + :: + + cd gettext-0.18.1.1 + CFLAGS="-O -g -arch i386 -arch ppc -arch x86_64" \ + LDFLAGS="-arch i386 -arch ppc -arch x86_64" ./configure + make + sudo make install + +4. Compile and install your ZOO-Kernel + + - Download source from SVN, and use the following command to compile libcgic : + + :: + + svn co http://svn.zoo-project.org/svn/trunk zoo + cd zoo/thirds/cgic206 + make + + - If you produced the ``libcgic.a`` file, you can run ``autoconf`` and then ``configure`` from zoo-kernel directory. + + :: + + cd zoo/zoo-kernel + autoconf + ./configure --with-python --with-java=macos \ + --with-gdal-config=/Library/Frameworks/GDAL.framework/Versions/1.8/Programs/gdal-config + + Obviously, if you don't need Python or Java support then you should remove the corresponding configure option. + + .. note:: + Note that we used the --with-java=macos configure option. Due to the generic location of the JDK on all + Mac OS X platforms, you don't have to provide its full path. + + - Now, run the following commands to compile and deploy your ZOO-Kernel on your Apache server : + + :: + + make + cp zoo_loader.cgi main.cfg /Library/WebServer/CGI-Executables + + You should be ready to request your ZOO-Kernel installation using the following link : http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS . + + If everything is ok, you can follow the next steps to deploy new Services Providers. + + .. note:: + If you are using your own libs (not the default libs on your system) then you must take care to create + universal versions of those libs, as the ZOO-Kernel will try to create a universal binary. If you are + not following this advice, you might receive compile errors of ``symbol(s) not found for architecture ppc`` or ``file was built for + unsupported file format which is not the architecture being linked (ppc)``. + +Deploy the OGR Services Provider +-------------------------------- + +Requirements +************ + +Before your try to use any service, please set the correct path in the ``main.cfg`` for tmpPath and tmpUrl. + +You can use the following setup : + +:: + + tmpPath = /Library/WebServer/Documents/tmp + tmpUrl = ../../tmp + +Obviously you'll then need to create this directory, using the following command : + +:: + + mkdir /Library/WebServer/Documents/tmp + +C Version +********* + +To compile the base-vect-ops ServicesProvider you'll need to edit the Makefile in *zoo/zoo-services/ogr/base-vect-ops/* +directory. Add "-I/Library//Frameworks/GEOS.framework/Versions/3/Headers/" to the CFLAGS value on the first line. +To compile, add GDAL framework to the PATH environmenet variable, to ensure that gdal-config tool will be found, +run make and then copy cgi-env files in the /Library/WebServer/CGI-Executables directory. + +:: + + cd zoo/zoo-services/ogr/base-vect-ops/ + export PATH=$PATH:/Library/Frameworks/GDAL.framework/Versions/1.7/Programs/ + make + cp cgi-env/* /Library/WebServer/CGI-Executables + +You can test using this `url `__ +if everything is ok with your setup. + +Python Version +************** + +**Requirements** + +First of all run python from a Terminal.app and try the following import from the python interpreter : + +:: + + import osgeo.ogr + import libxml2 + +If you get an issue when importing the libxml2 module from your python interpreter then that means you +need to install the Python support for the libxml2 library which is already installed on your Mac OS X environment. +To accomplish this, you have first to determine what version of libxml2 is installed on your platform, using the following command: + +xml2-config --version + +Download the source corresponding to your version (i.e. on 10.6.6 you get 2.7.3) from the libxml2 +`download page `__ into your ``src`` directory then uncompress it. + +Use the following command to install the python support : + +:: + + cd src/libxml2-2.7.3/python/ + python setup.py install + +**Deploy OGR Python Services Provider** + +- Now copy the ``zoo-services/ogt/base-vect-ops/cgi-env`` files into ``/Library/WebServer/CGI-Executables``. + +You can test using this `url `__ +if everything is ok with your setup. + +Test using Local Demo Page +-------------------------- + +- Download the `OpenLayers `__ library and uncompress it in your personal Sites directory + (located in your home directory). + +- Rename the OpenLayers directory as openlayers. + +- Download this `zip archive `__ + and then uncompress it in your personal Sites directory. + +- Load your local demo pages using urls similar to the following (replacing MyUserName by your MacOS user name) : + + * http://localhost/~MyUserName/zoo-demo/spatialtools.html + * http://localhost/~MyUserName/zoo-demo/spatialtools-py.html + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-opensuse.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-opensuse.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-opensuse.txt (revision 672) @@ -0,0 +1,67 @@ +.. _kernel-installation-opensuse: + +OpenSUSE +======== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +Zoo-Kernel is maintained as a package in `OpenSUSE Build Service (OBS) `__. +This way, rpm's are provided for all versions of openSUSE Linux (11.2, 11.3, 11.4, Factory). + +Stable Releases +--------------- + +For installing Zoo-Kernel in openSUSE there are 3 ways available: + +One Click Installer +******************* + +One-click installer that can be found `here `__. +For openSUSE 11.4 this is the direct `link `__. + +Yast Software Manager using a GUI +********************************* + +The `Application:Geo `__ repository has to be added +to the Software Repositories and then Zoo-kernel can be found in Software Management through search. + +Command line (as root for openSUSE 11.4) +**************************************** + +:: + + zypper ar http://download.opensuse.org/repositories/Application:/Geo/openSUSE_11.4/ + zypper refresh + zypper install zoo-kernel + +Unstable Version +---------------- + +The latest development version of ZOO-Kernel can be found in OBS under the project `home:tzotsos `__. +ZOO-Kernel packages are maintained and tested there before being released to the Application:Geo repository. + +Installation methods are identical as the stable version. Make sure to use `this `__ repository instead. + +Command line installation (as root for openSUSE 11.4) +***************************************************** + +:: + + zypper ar http://download.opensuse.org/repositories/home:/tzotsos/openSUSE_11.4/ + zypper refresh + zypper install zoo-kernel + zypper install zoo-kernel-grass-bridge + +Additionally, there is the option of adding the zoo-wps-grass-bridge package. This option will automatically install grass7 (svn trunk). + +Try the Installation +-------------------- + +- http://localhost/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=GetCapabilities&Version=1.0.0 +- http://localhost/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=DescribeProcess&Version=1.0.0&Identifier=HelloPy +- http://localhost/cgi-bin/zoo_loader.cgi?ServiceProvider=&metapath=&Service=WPS&Request=Execute&Version=1.0.0&Identifier=HelloPy&DataInputs=a=myname Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-prerequisites.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-prerequisites.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-prerequisites.txt (revision 672) @@ -0,0 +1,76 @@ +.. _kernel-installation-prereq: + +Prerequisites +============= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +Obtaining the ZOO Kernel Source +------------------------------- + +.. _svn: + +Use the following command to get the ZOO Kernel source code through Subversion: + +:: + + svn checkout http://svn.zoo-project.org/svn/trunk zoo-project + +For users which get a developer account, use the following: + +:: + + sed "s:\[tunnels\]:\[tunnels\]\nzoosvn = /usr/bin/ssh -p 1046:g" -i ~/.subversion/config + svn co svn+zoosvn://svn.zoo-project.org/var/svn/repos/trunk zoo-project + +The first line of the instruction above defines a specific tunnel to access the svn server through +the SSH protocol. Indeed, the ZOO SVN server listens on the 1046 (1024+22) port rather than the default one (22). + +Prerequisites +------------- + +The following libraries are required on your system before you can install the ZOO Kernel: + +- autoconf ( http://www.gnu.org/software/autoconf/ ) +- cgic ( http://www.boutell.com/cgic ) +- cURL ( http://curl.haxx.se ) +- FastCGI ( http://www.fastcgi.com ) +- Flex & Bison ( http://flex.sourceforge.net/ http://www.gnu.org/software/bison/ ) +- libxml2 ( http://xmlsoft.org ) +- OpenSSL ( http://www.openssl.org ) +- Python ( http://www.python.org ) + +Optional libraries include: + +- MapServer (optional for WMS, WFS and WCS output) ( http://mapserver.org ) +- PHP Embedded (optional) ( http://www.php.net ) +- Java SDK (optional) ( http://java.sun.com ) +- SpiderMonkey (optional) ( http://www.mozilla.org/js/spidermonkey/ ) + +Compile libcgic +--------------- + +The first step is to compile libcgic from the ``zoo-project/thirds`` directory. For such a task, please use +the following command: + +:: + + cd thirds/cgic206 + make + +Make sure that a ``libcgic.a`` is created in your ``zoo-project/thirds/cgic206`` directory. If yes, then +you can go to the next step. + +On Windows, rather than using the make command, please use: + +:: + + nmake /f makefile.vc. + +.. warning:: + If you don't compile libcgic first, and try to compile the ZOO Kernel, you will get an error such as *cannot find -lcgic* Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-unix.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-unix.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-unix.txt (revision 672) @@ -0,0 +1,233 @@ +.. _kernel-installation-unix: + +Unix +==== + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +.. note:: + You must be sure to perform the :ref:`prerequisite steps ` before following this page. + +For the impatient +----------------- + +To build the ``zoo_loader.cgi`` CGI program with the default options, cd to the directory +where you extracted the ZOO Kernel source code package and use the following commands: + +:: + + $ cd zoo-kernel + $ autoconf + $ ./configure + $ make + +Unless something went wrong, you should have executables in the current directory for the ``zoo_loader.cgi`` +CGI program. You can copy the ``zoo_loader.cgi`` program and the ``main.cfg`` file to your HTTP server's CGI +directory and start using it. + +At this step your ZOO-Kernel should work. Nevertheless, don't forget to correct the main.cfg settings +to set ``tmpPath`` and ``tmpUrl`` to fit your web server configuration. + +Configure Options +----------------- + +Here is the list of available options as returned by *./configure --help*: + +:: + + --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] + --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) + --with-gdal-config=FILE specify an alternative gdal-config file + --with-xml2config=FILE specify an alternative xml2-config file + --with-mapserver=PATH specify the path for MapServer compiled source tree + --with-python=PATH To enable python support or specify an alternative + directory for python installation, disabled by + default + --with-pyvers=NUM To use a specific python version + --with-php=PATH To enable php support or specify an alternative + directory for php installation, disabled by default + --with-perl=PATH To enable perl support or specify an alternative + directory for perl installation, disabled by default + --with-java=PATH To enable java support, specify a JDK_HOME, + disabled by default + --with-js=PATH specify --with-js=path-to-js to enable js support, + specify --with-js on linux debian like, js support + is disabled by default + +All the options are described in more details below. + +(Required) GDAL Support +*********************** + +If your gdal-config program is not found in your PATH then you can use the +``--with-gdal-config`` option to specify its location. For instance, let's suppose that your gdal-config +was installed in /usr/local/bin and this directory is not in your PATH, then you can use +the following command: + +:: + + $ ./configure --with-gdal-config=/usr/local/bin/gdal-config + +(Required) XML2 Support +*********************** + +If your xml2-config program is not found in your PATH then you can use the +``--with-xml2config`` option to specify its location. For instance, let's suppose that +your xml2-config was installed in /usr/local/bin and this directory is not in your PATH, +then you can use the following command: + +:: + + $ ./configure --with-xml2config=/usr/local/bin/xml2-config + +(Optional) MapServer Support +***************************** + +If you want to activate the WMS, WFS and WCS outputs using MapServer then you will have +to use the ``--with-mapserver`` option. You have to set the path to your ``mapserver-config`` +locate in the source code of MapServer as following command: + +:: + + $ ./configure --with-mapserver=/path/to/your/mapserver_config/ + +(Optional) Python Support +************************* + +If you want to activate Python support for the ZOO Kernel then you will have to use the +``--with-python`` option. If your python-config program is found in your PATH then you +don't have to specify the path where Python was installed, such as: + +:: + + $ ./configure --with-python + +This assumes that python-config is found in your PATH. + +In the case that your python-config is not found in your PATH, then you can specify the Python +installation directory you are using. For instance, let's suppose that you installed +Python in /usr/local, then you can use the following command: + +:: + + $ ./configure --with-python=/usr/local + +This assumes that /usr/local/bin/python-config exists. + +(Optional) Python Version +************************* + +If you want use a specific version of Python you will have to use the ``--with-pyvers`` +option. You can specify a Python version as: + +:: + + $ ./configure --with-pyvers=2.6 + + +(Optional) PHP Support +********************** + +To be able to activate PHP support for the ZOO Kernel you'll need to get a local PHP Embedded +installation; for more information about the required configure options when compiling PHP you +can refer to this page : + + http://zoo-project.org/trac/wiki/ZooKernel/Embed/PHP + +If you want to activate the PHP support for the ZOO Kernel then you will have to use the +``--with-php`` option. If your php-config program is found in your PATH then you don't have +to specify the path where PHP was installed, then you can use the following commnd: + +:: + + $ ./configure --with-php + +This assumes that php-config is found in your PATH. + +In the case that your php-config is not found in your PATH, then you can specify the PHP installation +directory you are using. For instance, let's suppose that you installed PHP in /usr/local, +then you can use the following command: + +:: + + $ ./configure --with-php=/usr/local + +This assumes that /usr/local/bin/php-config exists. + +(Optional) Perl Support +*********************** + +If you want to activate Perl support for the ZOO Kernel then you will have to use the +``--with-perl`` option. If you do not set any value to this option, then the perl program will +be searched in your PATH. So in such a case, you can use the following command: + +:: + + $ ./configure --with-perl + +This assumes that perl is found in your PATH. + +In the other case, for custom Perl installations, you can set the installation directory. For instance, +let's suppose that you installed Perl in /usr/local and /usr/local/bin is not in your PATH, +then you can use the following command: + +:: + + $ ./configure --with-perl=/usr/local + +This assumes that /usr/local/bin/perl exists. + +(Optional) Java Support +*********************** + +If you want to activate Java support for the ZOO Kernel then you will have to use the +``--with-java`` option and set the installation path of your Java SDK. For instance, +let's suppose that your Java SDK was installed in the /usr/lib/jvm/java-6-sun-1.6.0.22/ directory, +then you can use the following command: + +:: + + $ ./configure --with-java=/usr/lib/jvm/java-6-sun-1.6.0.22/ + +This assumes that the include/linux and jre/lib/i386/client/ subdirectories exist in +/usr/lib/jvm/java-6-sun-1.6.0.22/, include/linux contains the jni.h headers file and +jre/lib/i386/client/ contains the libjvm.so file. + +.. note:: + With Mac OS X you only have to set ``macos`` as the value for the ``--with-java`` option + to activate Java support. For example: + + :: + + $ ./configure --with-java=macos + +(Optional) JavaScript Support +***************************** + +If you want to activate JavaScript support for the ZOO Kernel then you will have to use +the ``--with-js`` option. If you are using a "Debian-like" GNU/Linux distribution then +dpkg will be used to detect if the required packages are installed and you don't have to +specify anything here, so you can use the following command: + +:: + + $ ./configure --with-js + +This assumes that js_api.h and libmozjs.so are found in default directories. + +If you have a custom installation of SpiderMonkey or you are not using a Debian packaging +system, then you'll have to specify the directory where you installed it. For +instance, let's suppose that you installed your SpiderMonkey in /usr, then you'll +have to use the following command: + +:: + + $ ./configure --with-js=/usr + +This assumes that the /usr/include/js exists and contains the js_api.h headers file and +/usr/lib contains libmozjs.so file. Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-windows.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-windows.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/install-windows.txt (revision 672) @@ -0,0 +1,175 @@ +.. _kernel-installation-windows: + +Windows +======= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 2 + :backlinks: top + +Using OSGeo4W +------------- + +Install OSGeo4W +*************** + +Download the OSGeo4W installer from http://trac.osgeo.org/osgeo4w/, and install it with all the dependencies needed by your +services (GDAL/OGR for example). The following libs are required: FastCGI, libxml, Python, cURL. + +Install other tools and libraries +********************************* + +After installing OSGeo4W on your platform you'll need more GNU tools and libraries. `This package `__ +contains full dependencies required to compile on WIN32 platform and this one contains `full runtime dependencies to place `__ +in your c:\OSGeo4W\bin. + +Download and Install ZOO Kernel +******************************* + +Download the `binary version `__ of the ZOO Kernel for WIN32 then place it in the +``C:\OSGeo4W\bin`` directory. Don't forget to place a ``main.cfg`` file in the same directory, you can use a modified copy of +`this file `__. + +Deploy ZOO Services Providers +***************************** + +Your can use the binary version of the OGR Services Provider available from `here `__. +Then place the two libraries with their respective .zcfg files in your local ``C:\OSGeo4W\bin`` directory. + +Testing +******* + +Now you should be able to query your local ZOO Kernel. + +Compiling Using Your Own Libraries +---------------------------------- + +.. note:: + You must be sure to perform the :ref:`prerequisite steps ` before compiling the ZOO Kernel. + +The following steps are for use with the Microsoft Visual Studio compiler (and tested with MSVC 2008). + +1. Make sure the gnuwin32 tools ``bison.exe`` and ``flex.exe`` are found in your path. You can download the GNUwin32 tools `here `__. + +2. Modify the file ``zoo-project\zoo-kernel\nmake.opt`` to point to your local libraries. You can find a modified nmake.opt that points to local libs `here `__. + You can also find a modified ``zoo-project\zoo-kernel\makefile.vc`` file `here `__. + +3. Execute: + + :: + + nmake /f makefile.vc + +4. A file ``zoo_loader.cgi`` should be created. Note that if another file named ``zoo_loader.cgi.manifest`` is also created, you + will have to run another command: + + :: + + nmake /f makefile.vc embed-manifest + +5. Copy the files ``zoo_loader.cgi`` and ``main.cfg`` into your cgi-bin directory. + +6. Using the command prompt, test the zoo-kernel by executing the following command: + + :: + + D:\ms4w\Apache\cgi-bin> zoo_loader.cgi + + which should display a message such as: + + :: + + Content-Type: text/xml; charset=utf-8 + Status: 200 OK + + + + + Parameter <request> was not specified + + + +7. Edit the file ``cgi-bin/main.cfg`` so that it contains values describing your WPS service. An example of such + a file running on Windows is: + + :: + + [main] + encoding = utf-8 + version = 1.0.0 + serverAddress = http://localhost/ + lang = en-CA + tmpPath=/ms4w/tmp/ms_tmp/ + tmpUrl = /ms_tmp/ + + [identification] + title = The Zoo WPS Development Server + abstract = Development version of ZooWPS. See http://www.zoo-project.org + fees = None + accessConstraints = none + keywords = WPS,GIS,buffer + + [provider] + providerName=Gateway Geomatics + providerSite=http://www.gatewaygeomatics.com + individualName=Jeff McKenna + positionName=Director + role=Dev + adressDeliveryPoint=1101 Blue Rocks Road + addressCity=Lunenburg + addressAdministrativeArea=False + addressPostalCode=B0J 2C0 + addressCountry=ca + addressElectronicMailAddress=info@gatewaygeomatics.com + phoneVoice=False + phoneFacsimile=False + +8. Open a web browser window, and execute a GetCapababilites request on your WPS service: http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS + + The response should be displayed in your browser, such as: + + :: + + + + The Zoo WPS Development Server + + Development version of ZooWPS. See http://www.zoo-project.org + + + WPS + GIS + buffer + + WPS + 1.0.0 + ... + +Optionally Compile Individual Services +************************************** + +An example could be the ``OGR base-vect-ops`` provider in the ``zoo-project\zoo-services\ogr\base-vect-ops`` directory. + +1. Edit the makefile.vc located in that directory, and execute: + + :: + + nmake /f makefile.vc + + Inside that same directory, the file ``cgi-env\ogr_service.zo`` should be created. + +2. Copy all of the files inside ``zoo-services\ogr\base-vect-ops\cgi-env`` into your cgi-bin directory + +3. Test this service provider through the following URL: + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Buffer&DataInputs=BufferDistance=1@datatype=interger;InputPolygon=Reference@xlink:href=http%3A%2F%2Fwww.zoo-project.org%3A8082%2Fgeoserver%2Fows%3FSERVICE%3DWFS%26REQUEST%3DGetFeature%26VERSION%3D1.0.0%26typename%3Dtopp%3Astates%26SRS%3DEPSG%3A4326%26FeatureID%3Dstates.15 + + The response displayed in your browser should contain: + + :: + + Service "Buffer" run successfully. + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/installation.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/installation.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/installation.txt (revision 672) @@ -0,0 +1,22 @@ +.. _kernel-installation: + +Installation +============ + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +This page provides documentation on how to compile then install the ZOO Kernel on Unix, Windows, and Mac OS X platforms. + +.. toctree:: + :maxdepth: 2 + + install-prerequisites + install-unix + install-opensuse + install-centos + install-debian + install-windows + install-mac + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/introduction.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/introduction.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/introduction.txt (revision 672) @@ -0,0 +1,52 @@ +.. _kernel-introduction: + +Introduction +============ + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +ZOO Kernel is the heart of the ZOO. It is a powerful server-side C Kernel which makes +it possible to manage and chain Web services, by loading dynamic libraries and handling +them as on-demand Web services. The ZOO Kernel is written in the C language, but supports +several common programming languages in order to connect to numerous libraries and models. + +Using ZOO Kernel as a Web Processing Platform +--------------------------------------------- + +ZOO Kernel works with Apache and can communicate with cartographic engines and Web mapping +clients. It simply adds the WPS support to your spatial data infrastructure and your +Web mapping application! + +.. note:: + If you'd like some background on the WPS standard, head to: http://www.opengeospatial.org/standards/wps + +Supported Languages +------------------- + +ZOO Kernel supports the following programming languages, and let's you use them to create +new ZOO Services from new or existing code: + +============ =================== ========================= ============ +**Language** **ServiceProvider** **DataStructure** **Return** +------------ ------------------- ------------------------- ------------ +C / C++ Shared Library maps* M integer +Fortran Shared Library CHARACTER*(1024) M(10,30) integer +Java Class File `HashMap`_ integer +Python Module File `dictionary`_ integer +PHP Script File `Array`_ integer +Perl Script File integer +JavaScript Script file `Object`_ or Array Array/Object +============ =================== ========================= ============ + +.. _`HashMap`: http://download.oracle.com/javase/6/docs/api/java/util/HashMap.html +.. _`dictionary`: http://docs.python.org/tutorial/datastructures.html#dictionaries +.. _`Array`: http://php.net/manual/language.types.array.php +.. _`Object`: http://www.json.org/ + +ZOO Kernel is a WPS Espresso Machine +------------------------------------ + +.. image:: ../_static/images/zoo_kernel_scheme.png + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/mapserver.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/mapserver.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/mapserver.txt (revision 672) @@ -0,0 +1,264 @@ +.. _kernel-mapserver: + +How To Use the Internal MapServer W*S support +============================================= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +The key idea of the MapServer W*S support implementation is that it +doesn't require to change a single line of the service source code to +activate the automatic publication of your result as WMS/WFS or WCS +ressource. You simply need to modify the ``zcfg`` file corresponding +to your service to make it working. + +Here is an overview of the way to install the MapServer W*S support, the +configuration required and the internal mechanisms. + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +How to make it working ? +------------------------ + +Requirement +************** + + * last ZOO-Kernel trunk version + * MapServer version >= 6.0.1 + +Installation steps +******************** + +First download lastest zoo-kernel directory available on the svn, do that from the directory of your previous checkout (so where zoo-api, zoo-services and zoo-kernel directories are available), we will use ```` here for this directory: + +.. code-block:: guess + + cd + svn checkout http://svn.zoo-project.org/svn/trunk/zoo-kernel zoo-kernel-ms + +Uncompress the MapServer archive (ie. ``mapserver-6.0.1.tar.bz2``) into ``/tmp/zoo-ms-src``, then compile MapServer using the following command: + +.. code-block:: guess + + cd /tmp/zoo-ms-src/mapserver-6.0.1 + ./configure --with-ogr=/usr/bin/gdal-config --with-gdal=/usr/bin/gdal-config \ + --with-proj --with-curl --with-sos --with-wfsclient --with-wmsclient \ + --with-wcs --with-wfs --with-postgis --with-kml=yes --with-geos \ + --with-xml --with-xslt --with-threads --with-cairo + make + cp mapserv /usr/lib/cgi-bin + +Autotools was updated to add the ``--with-mapserver`` configure option. From your ZOO-Project SVN trunk directory, compile the ZOO-Kernel using the following command: + +.. code-block:: guess + + cd zoo-kernel-ms + autoconf + ./configure --with-python --with-mapserver=/tmp/zoo-ms-src/mapserver-6.0.1 + make + cp zoo_loader.cgi /usr/lib/cgi-bin + +Configuration steps +************************* + +Main configuration file +^^^^^^^^^^^^^^^^^^^^^^^ + +Add the following content to your ``/usr/lib/cgi-bin/main.cfg`` file + in the ``[main]`` section: + +.. code-block:: guess + + dataPath = /var/www/temp/ + mapserverAddress=http://localhost/cgi-bin/mapserv + +The ``dataPath`` directory should exists and be writable by apache user. In this directory, a ``symbols.sym`` file have to be present, containing the following: + +.. code-block:: guess + + SYMBOLSET + SYMBOL + NAME "circle" + TYPE ellipse + FILLED true + POINTS + 1 1 + END + END + END + +Only one symbol definition is required with any name, used for WMS service output. + +Now, your ZOO-Kernel get the MapServer support ready to be used. Note that if you don't add the ``mapserverAddress`` then it imply the ZOO-Kernel will segfault (checking ``NULL`` value should correct this behavior). + +Here you can optionally add a ``msOgcVersion`` parameter to specify which version of the OGC WebService you want to use for each services. For example, if you want to force to version 1.0.0, you can set the following in the ``[main]`` section of your ``main.cfg`` file: + +.. code-block:: guess + + msOgcVersion=1.0.0 + +Service configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To activate MapServer WebServices output for a service, you have to add a specific parameter in the ```` or ```` block: ``useMapserver``. This can take the value true or should not appear. If true, it means that the output result is an OGR / GDAL compatible datasource and you want it to be outputted as an OGC web server instance (WMS/WFS/WCS). + +You get an optional parameter, to use a custom MapServer style block (used for vector datasource only): msStyle. For example: + +.. code-block:: guess + + msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END + +You get the same optional parameter ``msOgcVersion`` as for the ``main.cfg``. This will specify that this is the specific protocol version the service want to use (so you may set also locally to service rather than globally). + +When you add useMapserver option to an output ```` or ```` block, then you have to know what are the sensible mimeType: + + * text/xml: will imply that the output data will be accessible through a WFS GetFeature request (default protocol version 1.1.0) + * image/tiff: will imply that the output data will be accessible through a WCS GetCoverage request (default protocol version 2.0.0) + * any other mimeType coupled with useMapserver option: will imply that the output data will be accessible trhough a WMS GetMap request (you have to limit yourself to what your MapServer installation support, GetCapabilities? request give information of supported output mimeType) (default protocol version 1.3.0) + +How does it work ? +--------------------- + +Whatever your service return as default output ``mimeType``, this one will be used when one output including the ``useMapserver`` option was found. + +So if you get the following ```` and ```` blocks in the ZOO Configuration File of your service: + +.. code-block:: guess + + + mimeType = text/xml + encoding = UTF-8 + schema = http://schemas.opengis.net/gml/3.1.0/base/feature.xsd + + + mimeType = image/png + useMapserver = true + + +It means that per default, your service return GML 3.1 Feature. When the client request for ``mimeType=image/png``, then the ZOO-Kernel will detect that this ``mimeType`` get the ``useMapServer`` option set to true so it will: + + 1) execute the service using the ```` block definition (this should be understandable by GDAL/OGR) + + 2) store the result of the service on disk (in the ``[main]`` > ``dataPath`` directory) + + 3) write a Mapfile (in the ``[main]`` > ``dataPath`` directory) using the MapServer C-API to setup both WMS and WFS services. + +.. Note:: even if you don't ask for this, the resulting Mapfile includes both configuration for WMS and WFS in case of Vector datasource. + +If your service output a raster file, then the behavior is quite the same except that the ZOO-Kernel will setup both WMS and WCS services for the result of the service. Here you cannot define your own style. Nevertheless, when one band raster is returned then the ZOO-Kernel can use its own default style definitions to classify the raster using equivalent intervals (you can easily see that in the outputed Mapfile), this classification is specific to WMS protocol. You should add a ``msClassify`` parameter and set it to ``true`` in your output ComplexData ```` or ```` node to activate this classification. +Special note for client implementers + +Note that depending on the request, the ZOO-Kernel can return a location header. + +Differente request types: + + * ResponseDocument=XXXX@asReference=true - in this case, the Kernel will return the GetMap/GetFeature/GetCoverage request in KVP in the href of the result. + * ResponseDocument=XXXX@asReference=false - in this case, the Kernel will return the result he get using the GetMap/GetFeature/GetCoverage request in KVP used for the href in previous case. + * RawDataOutput=XXXX@asReference=true/false - in this case, the Kernel will return the GetMap/GetFeature/GetCoverage request in KVP in the specific location header, which imply that the browser should follow and request MapServer directly. + +Simple sample use cases +----------------------- + +Consider the existing BufferPy service from zoo-services/ogr-base-vect-ops-py. Set the following content to your local BufferPy.zcfg file in the Result output definition, then copy it to /usr/lib/cgi-bin/: + +.. code-block:: guess + + + mimeType = text/xml + encoding = UTF-8 + schema = http://schemas.opengis.net/gml/3.1.0/base/feature.xsd + useMapserver = true + + + mimeType = image/png + useMapserver = true + asReference = true + msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END + + + mimeType = image/tif + useMapserver = true + asReference = true + msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END + + + mimeType = application/vnd.google-earth.kmz + useMapserver = true + asReference = true + msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END + + +This modifications make your service ready to return result as WMS GetMap or WFS GetFeature requests. Note that some bug occurs locally using the application/vnd.google-earth.kmz output. +Raster + +Using the following simple service code we get a service capable to output any kind of internet files (useful for testing this functionality): + +.. code-block:: guess + + import zoo + def HelloPy(conf,inputs,outputs): + outputs["Result"]["value"]=inputs["a"]["value"] + return zoo.SERVICE_SUCCEEDED + +Define the ``[Result]`` output in your ``HelloPy.zcfg`` file with the following ComplexData block content: + +.. code-block:: guess + + + mimeType = image/png + useMapServer = true + + + mimeType = image/tiff + useMapServer = true + + + mimeType = text/xml + useMapServer = true + + +It means that the default output ``mimeType`` is ``image/png``, so a WMS GetMap request will be returned, or the resulting ``image/tiff`` will be returned as WCS GetCoverage request. + +With this simple service you can test the new capabilities to output result as WebServices for each mimeTypes. Note, that you'll probably get wrong ``mimeType``, as the default was set to ``image/png``. + +There is a support for Zipped ShapeFile but I doubt it is really +useful. Anyway, as it is present you can test it easily by passing a +zip file in ``xlink:href`` for the ``a`` value of the ``HelloPy`` +service. + +Testings +*********** + +Using the simple ``HelloPy`` service code, you can use the following urls, note it supposes that you get an available http://localhost/data/data.zip file containing a ShapeFile and a http://localhost/data/demo.tif: + +Test 1: Accessing a remote Zipped Shapefile as WFS GetFeatures Request +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.zip&ResponseDocument=Result@asReference=true@mimetype=text/xml + +Test 2: Accessing a remote Zipped Shapefile as WMS GetMap Request +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.zip&ResponseDocument=Result@asReference=true@mimetype=image/png + +Test 3: Accessing a remote tiff as WMS GetMap Request: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.tiff&ResponseDocument=Result@asReference=true@mimetype=image/png + +Test 4: Accessing a remote tiff as WCS GetMap Request: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=HelloPy&DataInputs=a=Reference@xlink:href=http://localhost/data/data.tiff&ResponseDocument=Result@asReference=true@mimetype=image/tiff + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/orfeotoolbox.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/orfeotoolbox.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/orfeotoolbox.txt (revision 672) @@ -0,0 +1,121 @@ +.. _kernel-orfeotoolbox: + +How To Use the Orfeo Toolbox support +============================================= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +The key idea of the ZOO `Orfeo Toolbox `_ support implementation is to take advantage of the `OTB Applications `_ by using them directly as ZOO WPS Services, without any modifications. + +Here is an overview of the installation procedure and the required configuration to activate the OTB support in ZOO-Project. + +.. Note:: These installation steps were successfully tested on Ubuntu 14.4 LTS + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +How to make it working ? +------------------------ + +Requirements +************** + + * latest `ZOO-Kernel `_ trunk version + * Orfeo Toolbox (`OTB 4.2.1 `_ ) + * Insight Segmentation and Registration Toolkit (`ITK-4.7 `_ ) + +Installation steps +******************** + +.. Note:: For OTB and ITK, the CMAKE_C_FLAGS and CMAKE_CXX_FLAGS must first be set to ``-fPIC`` + +Download lastest ZOO-Kernel code from SVN. + +.. code-block:: guess + + svn checkout http://svn.zoo-project.org/svn/trunk/zoo-kernel zoo-kernel + +Then compile ZOO-Kernel using the needed configuration options as shown bellow: + +.. code-block:: guess + + cd zoo-kernel + autoconf + ./configure --with-otb=/usr/local --with-itk=/usr/local --with-itk-version=4.7 + make + cp zoo_loader.cgi /usr/lib/cgi-bin + +Configuration steps +************************* + +Main configuration file +^^^^^^^^^^^^^^^^^^^^^^^ + +Add the following content to your ``/usr/lib/cgi-bin/main.cfg`` file +in the ``[env]`` section: + +.. code-block:: guess + + ITK_AUTOLOAD_PATH=/usr/local/lib/otb/applications + +Services configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The build of the `otb2zcfg `_ utility is required to activate the available OTB Applications as WPS services. This can be done using the following command: + +.. code-block:: guess + + mkdir build + cd build + ccmake .. + make + +Run the following command to generate all the needed zcfg files for the available OTB Application: + +.. code-block:: guess + + mkdir zcfgs + cd zcfgs + export ITK_AUTOLOAD_PATH=/your/path/to/otb/applications + ../build/otb2zcfg + mkdir /location/to/your/cgi-bin/OTB + cp *zcfg /location/to/your/cgi-bin/OTB + +.. warning + + The ITK_AUTOLOAD_PATH environment variable is required in the [env] section of your main.cfg. + +Test the ZOO OTB support +^^^^^^^^^^^^^^^^^^^^^^^ + +Once done, OTB Applications should be listed as available WPS Services when runing a GetCapabilities request + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS + +Each OTB Service can then be described individually using the DescribeProcess request, as for example: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=OTB.BandMath + +And executed according to your needs, as for the following example executing OTB.BandMath with the OTB sample data as input + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=OTB.BandMath&DataInputs=il=Reference@xlink:href=http://hg.orfeo-toolbox.org/OTB-Data/raw-file/ca154074b282/Examples/verySmallFSATSW.tif;il=Reference@xlink:href=http://hg.orfeo-toolbox.org/OTB-Data/raw-file/ca154074b282/Examples/verySmallFSATSW_nir.tif;out=float;exp=im1b3*cos%28im1b1%29,im1b2*cos%28im1b1%29,im1b1*cos%28im1b1%29&RawDataOutput=out@mimeType=image/png + +When executing OTB applications as WPS Services, it is also possible to check the OTB process status, using the usual ZOO GetStatus request. + + + + + + + + + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/kernel/sagagis.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/kernel/sagagis.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/kernel/sagagis.txt (revision 672) @@ -0,0 +1,91 @@ +.. _kernel-sagagis: + +How To Use the SAGA-GIS support +============================================= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +The key idea of the ZOO `SAGA GIS `_ support implementation is to take advantage of the `SAGA-GIS Modules `_ by using them directly as ZOO-Services, without any modifications. + +Here is an overview of the installation procedure and the required configuration to activate the SAGA-GIS support in ZOO-Project. + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +How to make it working ? +------------------------ + +Requirements +************** + + * latest `ZOO-Kernel `_ trunk version + * SAGA-GIS (`SAGA-GIS 2.1.4 `_ ) + * libLAS-1.2 (`LibLAS-1.2 `_ ) + +Installation steps +******************** + +Download lastest ZOO-Kernel code from SVN. + +.. code-block:: guess + + svn checkout http://svn.zoo-project.org/svn/trunk/zoo-kernel zoo-kernel + +Then compile ZOO-Kernel using the needed configuration options as shown bellow: + +.. code-block:: guess + + cd zoo-kernel + autoconf + ./configure --with-saga=/usr/local/ + make + cp zoo_loader.cgi /usr/lib/cgi-bin + +Configuration steps +************************* + +Services configuration file +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Building the `saga2zcfg `_ utility is required to activate the available SAGA-GIS Modules as WPS Services. This can be done using the following command: + +.. code-block:: guess + + cd thirds/saga2zcfg + make + +Run the following command to generate all the needed zcfg files for the available SAGA-GIS Modules: + +.. code-block:: guess + + mkdir zcfgs + cd zcfgs + ../saga2zcfg + mkdir /location/to/your/cgi-bin/SAGA + cp *zcfg /location/to/your/cgi-bin/SAGA + +Test the ZOO SAGA support +^^^^^^^^^^^^^^^^^^^^^^^ + +Once done, SAGA-GIS Modules should be listed as available WPS Services when runing a GetCapabilities request + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS + +Each SAGA-GIS Service can then be described individually using the DescribeProcess request, as for example: + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=SAGA.garden_fractals.1 + +And executed according to your needs, as for the following example +executing SAGA.garden_fractals.1 with no optional parameter + +.. code-block:: guess + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=SAGA.garden_fractals.1&DataInputs=&ResponseDocument=RESULT@mimeType=application/json@asReference=true + +When executing SAGA-GIS Modules as WPS Services, it is also possible to check its ongoing status, using the usual asynchronous Execute requests and polling the ZOO GetStatus request. Index: /branches/PublicaMundi_David_integration_01-devel/docs/make.bat =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/make.bat (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/make.bat (revision 672) @@ -0,0 +1,170 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ZOOProject.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ZOOProject.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/debug.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/debug.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/debug.txt (revision 672) @@ -0,0 +1,97 @@ +.. _services-debug: + +How To Debug ZOO Services +========================= + +:Authors: Luca Delucchi +:Last Updated: $Date$ + +There are different ways to debug your services, the most used solutions are via web +or via command line. + +Web +---- + +Using the web request you can see any problem in the log file of Apache. + +On Unix system the log file is usually in ``/var/log/apache2`` and the relevant file +is ``error_log``. A simple way to read the file is to use the ``tail`` command, +it permits to see the update of the file for each request :: + + tail -f /var/log/apache2/error_log + +If the log is not clear enough you can add some more debug information to your code. You have to write +to standard error. + +Python +******** +Using Python, you can for example do this + +.. code-block:: python + + import sys + + #add this line when you want see an own message + sys.stderr.write("My message") + +.. _web_javascript: + +Javascript +************ + +You can user ``alert`` to print a string to standard error: + +.. code-block:: javascript + + // add this line when you want see an own message + alert('My message') + // you can debug value of inputs, outputs or conf + alert(inputs["S"]["value"]) + +.. note:: If you try to pass an object it will only return ``[object Object]`` + +Command line +-------------- + +It is possible to use the ZOO kernel ``zoo_loader.cgi`` also from command line. +This is really useful to debug in a deeper way your service: + +.. code-block:: bash + + # in order to use it you have to copy test_service.py and HelloPy.zcfg from + # the example services + ./zoo_loader.cgi "service=wps&version=1.0.0&request=execute&identifier=HelloPy&datainputs=a=your name&responsedocument=Result" + +Working this way you can use the standard debug system of the actual programming language used +to develop your service. + +GDB +***** +From command line you can use also the command line tool `GDB `_ +to debug ``zoo_loader.cgi``, you have to run: + +.. code-block:: bash + + # launch zoo_loader.cgi from gdb + gdb zoo_loader.cgi + # now run your request + run "service=wps&version=1.0.0&request=execute&identifier=HelloPy&datainputs=a=your name&responsedocument=Result" + +At this point you can ask help at the `ZOO mailing list `_ +copying the result of the command. + +Python +********** +For Python, you can use ``pdb``, more info at http://docs.python.org/2/library/pdb.html + +.. code-block:: python + + import pdb + + # add this line when you want investigate your code in more detail + pdb.set_trace() + +Javascript +************ + +You can use ``alert`` also to print in the console, more info in the :ref:`web_javascript` web section Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/examples.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/examples.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/examples.txt (revision 672) @@ -0,0 +1,45 @@ +.. _services-examples: + +Service Examples +================ + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +ZOO Services are quite easy to create once you have installed the ZOO Kernel and have +chosen code (in the language of your choice) to turn into a ZOO service. Here are some +HelloWorlds with links to their corresponding ``.zcfg`` files. + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +GDAL ZOO Service +---------------- + +The GDAL ZOO Service is based on GDAL source code and copyright. This ZOO Service +aims to provide some basic raster processing operations to your ZOO Kernel installation. +Learn more and read documentation on the official `GDAL website `__. + +Implemented functions +********************* + +Gdal_Grid + creates regular grid from the scattered data + + +Gdal_Translate + converts raster data between different formats + + +OGR ZOO Service +--------------- + +The OGR ZOO Service is based on OGR source code and copyright. This ZOO Service aims +to provide some basic vector spatial operations to your ZOO Kernel installation. +Learn more and read documentation on the official `OGR website `__. + +Implemented functions +********************* + +Base_Vect_Ops Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/howtos.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/howtos.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/howtos.txt (revision 672) @@ -0,0 +1,341 @@ +.. _services-howtos: + +How To Setup ZOO Services +========================= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna, Luca Delucchi +:Last Updated: $Date$ + +ZOO Services are quite easy to create once you have installed the ZOO Kernel and have +chosen code (in the language of your choice) to turn into a ZOO service. Here are some +HelloWorlds in Python, PHP, Java and JavaScript with links to their corresponding +``.zcfg`` files. + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +Common informations +---------------------- + +A ZOO-Service is a couple composed of a ZCFG file and a +ServiceProvider. This last depend of the programming language but +should expose at least one function corresponding to the Service. This +function take three arguments: the main configuration, inputs and +outputs and return an integer: +* 3 if the process run sucessfully +* 4 in case any error occur. In such a case, programmer may add +detailler message map + +Data structures for those arguments depend on the programming +-UMRlanguage and is detailled below. + +.. Note:: The service has to **return 3 if the process run successfully instead it + return 4** if the process end with an error. + +Python +------ + +You'll find here information needed to deploy your own Python Services Provider. + +Python ZCFG requirements +************************ + +.. Note:: For each Service provided by your ZOO Python Services Provider, the ZCFG File + must be named the same as the Python module function name (also the case of + characters is important). + +The ZCFG file should contain the following : + + +serviceType + Python +serviceProvider + The name of the Python module to use as a ZOO Service Provider. For instance, if your + script, located in the same directory as your ZOO Kernel, was named ``my_module.py`` then + you should use ``my_module`` (the Python module name) for the serviceProvider value in ZCFG file. + +Python Data Structure used +************************** +The three parameters of the function are passed to the Python module as dictionaries. + +Following you'll find an example for each parameters + +Main configuration +^^^^^^^^^^^^^^^^^^^^^ +Main configuration contains several informations, some of them are really useful to develop your service. +Following an example :: + + { + 'main': {'lang': 'en-UK', + 'language': 'en-US', + 'encoding': 'utf-8', + 'dataPath': '/var/www/tmp', + 'tmpPath': '/var/www/tmp', + 'version': '1.0.0', + 'mapserverAddress': 'http://localhost/cgi-bin/mapserv', + 'isSoap': 'false', + 'tmpUrl': 'http://localhost/tmp/', + 'serverAddress': 'http://localhost/zoo' + }, + 'identification': {'keywords': 'WPS,GIS', + 'abstract': 'WPS services for testing ZOO', + 'fees': 'None', + 'accessConstraints': 'none', + 'title': 'testing services' + }, + 'lenv': {'status': '0', + 'soap': 'false', + 'cwd': '/usr/lib/cgi-bin', + 'sid': '24709' + }, + 'env': {'DISPLAY': 'localhost:0'}, + 'provider': {'addressCountry': 'it', + 'positionName': 'Developer', + 'providerName': 'Name of provider', + 'addressAdministrativeArea': 'False', + 'phoneVoice': 'False', + 'addressCity': 'City', + 'providerSite': 'http://www.your.site', + 'addressPostalCode': '38122', + 'role': 'Developer', + 'addressDeliveryPoint': 'False', + 'phoneFacsimile': 'False', + 'addressElectronicMailAddress': 'your@email.com', + 'individualName': 'Your Name' + } + } + +Inputs +^^^^^^^^^^^^ +The inputs are somethings like this :: + + { + 'variable_name': {'minOccurs': '1', + 'DataType': 'string', + 'value': 'this_is_the_value', + 'maxOccurs': '1', + 'inRequest': 'true' + } + } + +The access to the value you have to require for the ``value`` parameter, something like this :: + + yourVariable = inputs['variable_name']['value'] + +Outputs +^^^^^^^^^^^^^ +The outputs data as a structure really similar to the inputs one :: + + { + 'result': {'DataType': 'string', + 'inRequest': 'true', + } + } + +There is no ``'value'`` parameter before you assign it :: + + inputs['result']['value'] = yourOutputDataVariable + +The return statement has to be an integer: corresponding to the service status code. + +To add a message for the wrong result you can add the massage to ``conf["lenv"]["message"]``, +for example: + +.. code-block:: python + + conf["lenv"]["message"] = 'Your module return an error' + +Sample ZOO Python Services Provider +*********************************** + +The following code represents a simple ZOO Python Services Provider which provides only one +Service, the HelloPy one. + +.. code-block:: python + + import zoo + import sys + def HelloPy(conf,inputs,outputs): + outputs["Result"]["value"]="Hello "+inputs["a"]["value"]+" from Python World !" + return zoo.SERVICE_SUCCEEDED + +PHP +--- + +ZOO-API +******* + +The ZOO-API for the PHP language is automatically available from your +service code. Tthe following functions are defined in the ZOO-API: + +int zoo_SERVICE_SUCCEEDED() + return the value of SERVICE_SUCCEEDED +int zoo_SERVICE_FAILED() + return the value of SERVICE_FAILED +string zoo_Translate(string a) + return the translated string (using the "zoo-service" `textdomain + `__) + +void zoo_UpdateStatus(Array conf,string message,int pourcent) + update the status of the running service + +PHP ZCFG requirements +********************************** + +The ZCFG file should contain the following : + +serviceType + PHP +serviceProvider + The name of the php script (ie. service.php) to use as a ZOO Service Provider. + +PHP Data Structure used +******************************** + +The three parameters are passed to the PHP function as +`Arrays `__. + +Sample ZOO PHP Services Provider +****************************************** + +.. code-block:: php + + + +Java +---- + +Specifically for the Java support, you may add the following two +sections to your ``main.cfg`` file: + +:[javaxx]: + This section is used to pass -XX:* parameters to the JVM created by the + ZOO-Kernel to handle your ZOO-Service (see `ref. 1 + `__ + or `ref. 2 + `__ + for sample available). + For each map ``a = b`` available in the ``[javaxx]`` section, the + option ``-XX:a=b`` will be passed to the JVM. In case of a map ``a = + minus`` (respectively ``a=plus``) then the option ``-XX:-a`` + (respectivelly ``-XX:+a``) will be passed. +:[javax]: + The section is used to pass -X* options to the JVM (see + `ref. `__). For + each map ``a = b`` available in the ``[javax]`` section, the option + ``-Xab`` will be passed to the JVM (ie. set ``mx=2G`` to pass + ``-Xmx2G``). + +ZOO-API +******* + +Before you build your first ZOO-Service implemented in Java, it is +recommended that you first build the ZOO class of the Java ZOO-API. + +.. Note:: You should build ZOO-Kernel prior to follow this instructions. + +To build the ZOO.class of the ZOO-API for Java, use the following +command: + +.. code-block:: guess + + cd zoo-api/java + make + cp ZOO.class libZOO.so /usr/lib/cgi-bin + +.. Note:: running the previous commands will require that both + ``javac`` and ``javah`` are in your PATH. + +Java ZCFG requirements +********************************** + +.. Note:: For each Service provided by your ZOO Java Services Provider + (your corresponding Java class), the ZCFG File should have + the name of the Java public method corresponding to the + service (case-sensitive). + +The ZCFG file should contain the following : + +serviceType + Java +serviceProvider + The name of the Java class to use as a ZOO Service Provider. For instance, if your + java class, located in the same directory as your ZOO-Kernel, was + named ``HelloJava.class`` then you should use ``HelloJava``. + +Java Data Structure used +******************************** + +The three parameters are passed to the Java function as +`java.util.HashMap `__. + +Sample ZOO Java Services Provider +****************************************** + +.. code-block:: java + + import java.util.*; + public class HelloJava { + public static int HelloWorldJava(HashMap conf,HashMap inputs, HashMap outputs) { + HashMap hm1 = new HashMap(); + hm1.put("dataType","string"); + HashMap tmp=(HashMap)(inputs.get("S")); + java.lang.String v=tmp.get("value").toString(); + hm1.put("value","Hello "+v+" from JAVA WOrld !"); + outputs.put("Result",hm1); + System.err.println("Hello from JAVA WOrld !"); + return ZOO.SERVICE_SUCCEEDED; + } + } + +Javascript +---------- + +ZOO API +********* + +If you need to use :ref:`ZOO API ` in your service, you have first to copy ``zoo-api.js`` +and ``zoo-proj4js.js`` where your services are located (for example in Unix system probably in +``/usr/lib/cgi-bin/`` + +Javascript ZCFG requirements +********************************** + +.. Note:: For each Service provided by your ZOO Javascript Services Provider, the ZCFG File + must be named the same as the Javascript function name (also the case of + characters is important). + +The ZCFG file should contain the following : + +serviceType + JS +serviceProvider + The name of the JavaScript file to use as a ZOO Service Provider. For instance, if your + script, located in the same directory as your ZOO Kernel, was named ``my_module.js`` then + you should use ``my_module.js``. + + +Javascript Data Structure used +******************************** + +The three parameters of the function are passed to the JavaScript function as Object. + +Sample ZOO Javascript Services Provider +****************************************** + +.. code-block:: javascript + + function hellojs(conf,inputs,outputs){ + outputs=new Array(); + outputs={}; + outputs["result"]["value"]="Hello "+inputs["S"]["value"]+" from JS World !"; + return Array(3,outputs); + } + Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/index.txt (revision 672) @@ -0,0 +1,17 @@ +.. _services: + +ZOO Services Documentation +========================== + +The following sections will assist you with ZOO Services: + +.. toctree:: + :maxdepth: 2 + + introduction + zcfg-reference + process-profiles + howtos + status + debug + examples Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/introduction.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/introduction.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/introduction.txt (revision 672) @@ -0,0 +1,30 @@ +.. _services-intro: + +Introduction +============ + +ZOO Services are example Web services which work with the ZOO :ref:`Kernel `. +They are based on various existing Open Source libraries and tend to provide simple Web processing +functions such as GIS format conversion, GIS file reprojection, basic spatial operations, +basic raster operations... + +The available ZOO Services are under development and come without any warranty. They are based +on existing code and prove that the :ref:`ZOO Kernel ` works with many different +codes and languages (please have a look to the ZOO demos!). The ZOO Project team wants to encourage +people to use the ZOO Services as a functional basis for Web processing, but above all to provide a +source of inspiration to the community for creating new ZOO Services. + +What is a ZOO Service? +---------------------- + +A ZOO Service is a couple composed of: + +- The code you want to turn into a standardized Web service +- A configuration file (.zcfg) which describes this Web service + +Learn more on configuring ZOO services by reading the :ref:`.zcfg Reference `. + +Example ZOO Services +-------------------- + +See the ZOO Services :ref:`examples page `. Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/process-profiles.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/process-profiles.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/process-profiles.txt (revision 672) @@ -0,0 +1,188 @@ +.. _process-profiles: + +Process Profiles Registry +========================================= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +Many times, services from the same ServicesProvider share inputs and +outputs. In such a casse, defining the ZCFG files for each service +from the same provider may lead to rewrite the same metadata +informations in different files. + +From `rev. 607 `__, the +ZOO-Kernel is able to handle metadata inheritance, it create a +Registry (before loading any other ZCFG files) containing a set of +Process Profiles organized in levels depending on their position in +the hierarchy: + +:Concept: the higher level in the hierarchy, concepts are basically + txt files containing an abstract description of a service, +:Generic: a generic profile can make reference to concepts, it defines + inputs and outputs but nor the data format nor the maximum size + limitation, +:Implementation: an implementation profile can inherit from a generic + profile and make reference to concepts, it contains all the + metadata informations about a service (see + `ref. `__). + +Both Generic Process Profiles and Process Implementation Profiles are +created from ZCFG files, stored in the registry sub-directories +depending on their level: ``concept``, ``generic`` and +``implementation``. + +To activate the registry, you have to add a ``registry`` key to the +``[main]`` section of your ``main.cfg`` file, and set its value to the +directory path used to store the profile ZCFG files. + + +Generic Process Profile +----------------------- + +A Generic Process Profile is a ZCFG file located in the ``generic`` +sub-directory, it defines `main metadata information +`__, inputs and outputs +name, basic metadata and multiplicity. It can make reference to a +concept by defining a ``concept`` key in the `main metadata +information `__ part. + +You can find below the `GO.zcfg` file, a typical Generic Process +Profile for Generic Geographic Operation, taking one InputPolygon +input parameter and returning a result named Result, it make reference +to the ``GOC`` concept: + +.. code-block:: none + :linenos: + + [GO] + Title = Geographic Operation + Abstract = Geographic Operation on exactly one input, returning one output + concept = GOC + level = generic + statusSupported = true + storeSupported = true + + [InputPolygon] + Title = the geographic data + Abstract = the geographic data to run geographipc operation + minOccurs = 1 + maxOccurs = 1 + + + [Result] + Title = the resulting data + Abstract = the resulting data after processing the operation + + + +.. Note:: if you need to reference more than one concept, you should + separate their names with a comma (ie. concept = GO,GB), + +Process Implementation Profile +------------------------------ + +A Process Implementation Profile is similar to a `ZCFG file +`__ located in the `implementation` +sub-directory, it defines (or inherit from its parent) all the +properties of a `Generic Process Profile <#generic-process-profile>`__ +and specify `Data Format `__ +for both inputs and outputs. It can make reference to a concept by +defining a ``concept`` key in the `main metadata information +`__ part. + +You can find below the `VectorOperation.zcfg` file, a typical Process +Implementation Profile for Vector Geographic Operation, it inherit +from the `GP generic profile <#generic-process-profile>`__: + +.. code-block:: none + :linenos: + + [VectorOperation] + Title = Vector Geographic Operation + Abstract = Apply a Vector Geographic Operation on a features collection and return the resulting features collection + extend = GO + level = profile + + [InputPolygon] + Title = the vector data + Abstract = the vector data to run geographic operation + + + mimeType = text/xml + encoding = UTF-8 + schema = http://fooa/gml/3.1.0/polygon.xsd + + + mimeType = application/json + encoding = UTF-8 + extension = js + + + + [Result] + Title = the resulting data + Abstract = the resulting geographic data after processing the operation + + + mimeType = text/xml + encoding = UTF-8 + schema = http://fooa/gml/3.1.0/polygon.xsd + + + mimeType = application/json + encoding = UTF-8 + extension = js + + + + + +ZCFG inheritance +---------------------------------- + +For the ZCFG files at the service level, you can inherit the metadata +from a Process Implementation Profile available in the registry. As +before, you simply need to add a ``extend`` key refering the ZCFG you +want to inherit from and a ``level`` key taking the `ìmplementation`` +value to your main metadata informations. + +So, for example, the original `ConvexHull.zcfg +`__ +may be rewritten as: + +.. code-block:: none + :linenos: + + [ConvexHull] + Title = Compute convex hull. + Abstract = Return a feature collection that represents the convex hull of each geometry from the input collection. + serviceProvider = ogr_service.zo + serviceType = C + extend = VectorOperation + level = implementation + +Now, suppose that your service is able to return the result in KML +format, then you may write the following: + +.. code-block:: none + :linenos: + + [ConvexHull] + Title = Compute convex hull. + Abstract = Return a feature collection that represents the convex hull of each geometry from the input collection. + serviceProvider = ogr_service.zo + serviceType = C + extend = VectorOperation + level = implementation + + [Result] + + mimeType = application/vnd.google-earth.kml+xml + encoding = utf-8 + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/status.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/status.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/status.txt (revision 672) @@ -0,0 +1,43 @@ +.. _services-status: + +How To Use ZOO Status Service +=============================== + +:Authors: Luca Delucchi +:Last Updated: $Date$ + +*ZOO Status Service* is a utility of ZOO-Project to return the +completion percent of your service. + +Install ZOO Status Service +----------------------------- + +To install the ``ZOO Status Service`` you have to move in +``/path/to/zoo/source/zoo-services/utils/status/`` and compile the source +running the ``make`` command. +If no errors are returned during compilation you can copy the content of ``cgi-env`` +to ``/usr/lib/cgi-bin/`` or where you have your ``zoo_loader.cgi`` working with this +command (you need administration right): + +:: + + cp /path/to/zoo/source/zoo-services/utils/status/cgi-env/*{zcfg,zo,py} /usr/lib/cgi-bin + +With this command you copy the code to permit to ``ZOO Status Service`` and some +example processes about how it works. + +Now you have to add these two lines to ``main.cfg`` : + +:: + + rewriteUrl=call + dataPath=/var/www/data + +Here you define the path where the service is able to find the xsl file, specified in the dataPath +parameter. You also tell the ZOO Kernel that you want to use the `rewriteUrl <../kernel/install-debian.html#rewrite-rule-configuration>`_. + +The last operation is to copy the ``updateStatus.xsl`` to ``dataPath`` directory as follow: + +:: + + cp /path/to/zoo/source/zoo-services/utils/status/cgi-env/*{xsl} /var/www/data Index: /branches/PublicaMundi_David_integration_01-devel/docs/services/zcfg-reference.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/services/zcfg-reference.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/services/zcfg-reference.txt (revision 672) @@ -0,0 +1,308 @@ +.. _services-zcfg: + +ZCFG : the ZOO Service Configuration File +========================================= + +:Authors: Nicolas Bozon, Gérald Fenoy, Jeff McKenna +:Last Updated: $Date$ + +.. contents:: Table of Contents + :depth: 3 + :backlinks: top + +The ZOO Service configuration file (.zcfg) describes the service and will be parsed by +the ZOO Kernel. We will describe here what such a file contains. +You can also take a look at the existing examples of ZCFG files in the ``cgi-env`` directory +of each services available in the `ZOO-Project SVN source tree `__. + +A ZOO Configuration file is divided into three distinct sections : + +1. Main Metadata information +2. List of Inputs metadata information (optional since `rev. 469 `__) +3. List of Outputs metadata information + +.. Note:: The ZOO Service Configuration File is case sensitive. + +Main Metadata Information +------------------------- + +The fist part in a ZOO Configuration file contains the metadata information relative to the service. +Note that the "name of your service" between brackets on the first line has to be the exact same name +as the function you defined in your services provider code. In most cases, this name is also the name +of the ZCFG file without the "``.zcfg``" extension. + +You can see below a description of the main metadata information: + +.. code-block:: none + :linenos: + + [Name of your service] + Title = Title of your service + Abstract = Description of your service + processVersion = Version number of your service + storeSupported = true/false + statusSupported = true/false + serviceType = the programming language used to implement the service (C/Fortran/Python/Java/PHP/Javascript) + serviceProvider = name of your services provider (shared library/Python Module/Java Class/PHP Script/JavaScript script) + + title = Metadata title of your service + + +.. Note:: you may add an ``extend`` key in case you use the `Process + Profile Registry `__. + +List of Inputs +-------------- + +The list of inputs contains metadata information of each supported input, and they are grouped using a ```` node. + +Each input is defined as : + +- a name (between brackets as for the name of the service before) +- various medata properties (``Title``, ``Abstract``, ``minOccurs``, ``maxOccurs`` and, in case of ComplexData, the optional ``maximumMegabytes``) +- a Type Of Data node (:ref:`description `) + +A typical list of inputs (````) look like the following: + +.. code-block:: none + :linenos: + + + [Name of the first input] + Title = Title of the first input + Abstract = Abstract describing the first input + minOccurs = Minimum occurence of the first input + maxOccurs = Maximum occurence of the first input + + [Name of the second input] + Title = Title of the second input + Abstract = Abstract describing the second input + minOccurs = Minimum occurence of the second input + maxOccurs = Maximum occurence of the second input + + + +.. Note:: you can add ```` node as in the main metadata information. + +List of Outputs +--------------- + +The list of outputs is very similar to a list of inputs except it is specified as a ```` node. + +A typical ```` node looks like the following: + +.. code-block:: none + :linenos: + + + [Name of the output] + Title = Title of the output + Abstract = Description of the output + + + +.. _typeDataNodes: + +Type Of Data Nodes +------------------ + +In the beginning of this ZCFG introduction, we spoke about "Type Of Data Nodes" to describe the data type of inputs and outputs. + +You can define your data as: + +- :ref:`LiteralData ` +- :ref:`BoundingBoxData ` +- :ref:`ComplexData ` + +Except for ``LiteralData``, each *Type Of Data* node must have at least one ```` node. Even +if empty, it **has to be present**. So, something +like the following should be present in your ZCFG file: + +.. code-block:: guess + :linenos: + + + +Otherwise, ZOO-Kernel won't be able to parse your ZCFG correctly. + +.. _LiteralData: + +LiteralData node +**************** + +A ```` node contains: + +- one (optional) ``AllowedValues`` key containing all value allowed for this input +- one (optional) ``range`` properties containing the range (``[``, ``]``) +- one (optional) ``rangeMin`` (``rangeMax``) properties containing the minimum (maximum) value of this range +- one (optional) ``rangeSpacing`` properties containing the regular distance or spacing between value in this range +- one (optional) ``rangeClosure`` properties containing the closure type (``c``, ``o``, ``oc``, ``co``) +- one ```` node, +- zero or more ```` nodes depending on the existence or the number of supported Units Of Measure (UOM), and +- a ``dataType`` property. The ``dataType`` property defines the type of literal data, such as a string, an interger and so on + (consult `the complete list `__ of supported data types). + +```` and ```` nodes can contain the ``uom`` property to define which UOM has to be used for +this input value. + +For input ```` nodes, you can add the ``value`` property to the ```` node to define a default +value for this input. This means that, when your Service will be run, even if the input wasn't defined, this default +value will be set as the current value for this input. + +A typical ```` node, defining a ``float`` data type using meters or degrees for its UOM, looks like the +following: + +.. code-block:: guess + :linenos: + + + dataType = float + + uom = meters + + + uom = feet + + + + +A typical ```` node, defining a ``float`` data type which +should take values contained in ``[0.0,100.0]``, looks like the following: + +.. code-block:: guess + :linenos: + + + dataType = float + rangeMin = 0.0 + rangeMax = 100.0 + rangeClosure = c + + + +Or more simply: + +.. code-block:: guess + :linenos: + + + dataType = float + range = [0.0,100.0] + + + +A typical ```` node, defining a ``string`` data type which +support values ``hillshade``, ``slope``, ``aspect``, ``TRI``, ``TPI`` +and ``roughness``, looks like the following: + +.. code-block:: guess + :linenos: + + + dataType = string + AllowedValues = hillshade,slope,aspect,TRI,TPI,roughness + + + +Properties ``AllowedValues`` and ``range*`` can be conbined with both ```` and +```` nodes in the same was as ```` node. For +instance, the following is supported: + +.. code-block:: guess + :linenos: + + + dataType = int + + value = 11 + AllowedValues = -10,-8,-7,-5,-1 + rangeMin = 0 + rangeMin = 100 + rangeClosure = co + + + rangeMin = 200 + rangeMin = 600 + rangeClosure = co + + + rangeMin = 750 + rangeMin = 990 + rangeClosure = co + rangeSpacing = 10 + + + +.. _BoundingBoxData: + +BoundingBoxData node +******************** + +A ```` node contains: + +- one ```` node with a CRS property defining the default Coordinate Reference Systems (CRS), and +- one or more ```` nodes depending on the number of CRS your service supports (note that you can + alternatively use a single ```` node with a comma-separated list of supported CRS). + +A typical ```` node, for two supported CRS (`EPSG:4326 `__ +and `EPSG:3785 `__), +looks like the following: + +.. code-block:: guess + :linenos: + + + + CRS = urn:ogc:def:crs:EPSG:6.6:4326 + + + CRS = urn:ogc:def:crs:EPSG:6.6:4326 + + + CRS = urn:ogc:def:crs:EPSG:6.6:3785 + + + +.. _ComplexData: + +ComplexData node +**************** + +A ComplexData node contains: + +- a ```` node and +- one or more ```` nodes depending on the number of supported formats. A format is made up of this + set of properties : ``mimeType``, ``encoding`` and optionaly ``schema``. + +For output ComplexData nodes, you can add the ``extension`` property to define what extension to use to name +the file when storing the result is required. Obviously, you'll have to add the ``extension`` property to each +supported format (for the ```` and ```` nodes). + +You can also add the ``asReference`` property to the ```` node to define if the output should be +stored on server side per default. + +.. Note:: the client can always modify this behavior by setting ``asReference`` attribute to ``true`` or ``false`` + for this output in the request ``ResponseDocument`` parameter. + +You can see below a sample ComplexData node for default ``application/json`` and ``text/xml`` (encoded in UTF-8 +or base64) mimeTypes support: + +.. code-block:: guess + :linenos: + + + + mimeType = application/json + encoding = UTF-8 + + + mimeType = text/xml + encoding = base64 + schema = http://fooa/gml/3.1.0/polygon.xsd + + + mimeType = text/xml + encoding = UTF-8 + schema = http://fooa/gml/3.1.0/polygon.xsd + + Index: /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/environment.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/environment.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/environment.txt (revision 672) @@ -0,0 +1,115 @@ +.. _environment: + +Using ZOO from an OSGeoLive virtual machine +=========================================== + +Development Environment Description +----------------------------------- + +`OSGeoLive `__ is a live DVD and virtual machine based on +`Xubuntu `__ that allows you to try a +wide variety of open source geospatial software without installing anything. It is +composed entirely of free software and include ZOO 1.0 this year, for testing purpose. + +As already said in introduction, an OSGeoLive virtual machine image disk has been +installed on your computer, allowing you to use ZOO Kernel in a development environment +directly. Using a virtual machine image disk seems to be the simplest way to use +ZOO Kernel and to develop ZOO Services locally, as we can ensure that everything +requested for compile C Services and run Python Services is available and ready to use. +Every ZOO related material and source code have been placed in */home/user/zoows* directory. +We will work inside it during this workshop. As the binary version of ZOO Kernel is +already compiled and stored in */home/user/zoows/sources/zoo-kernel*, you only have to +copy two important files inside the */usr/lib/cgi-bin directory*: *zoo_loader.cgi* +and the *main.cfg* in order to make ZOO Kernel available, using the following commands: + +:: + + sudo cp ~/zoows/sources/zoo-kernel/zoo_loader.cgi /usr/lib/cgi-bin + sudo cp ~/zoows/sources/zoo-kernel/main.cfg /usr/lib/cgi-bin + +Please note that we will talk about ZOO Kernel or zoo_loader.cgi script without any +distinction during this workshop. + +The *main.cfg* file contains metadata informations about the identification and provider +but also some important settings. The file is composed of various sections, namely *main*, +*identification* and *provider* per default. Obviously, you are free to add new sections +to the files if you need them for a specific Service. Nevertheless, you have to know +that the env section name is used in a specific way. It lets you define environment +variables that your Service requires during its runtime. For instance, if your Service +requires to access to a X server running on framebuffer, you can add *DISPLAY=:1* line in +your env section to take this specificity into account. + +Please have a look to this file. Three important parameters are commented below: + +serverAddress + The url to access to the ZOO Kernel + +tmpPath + The full path to store temporary files + +tmpUrl + The url path relative to serverAddress to access temporary directory. + +The values of the *main.cfg* file used from the running virtual machine are the following: + +:: + + serverAddress=http://localhost/zoo + tmpPath=/var/www/temp + tmpUrl=../temp/ + +You could have noticed that the *tmpUrl* is a relative url from *serverAddress*, so it must +be a directory. Even if ZOO Kernel can be used with the full url of the zoo_loader.cgi +script, for better readability and fully functional ZOO Kernel, you have to modify the +default Apache configuration in order to be able to use the http://localhost/zoo/ url +directly. + +First, please create a zoo directory in the existing */var/www* which is used by Apache as +the DirectoryIndex. Then, please edit the */etc/apache2/sites-available/default* configuration +file and add the following lines after the Directory block related to */var/www* directory : + +:: + + + Options Indexes FollowSymLinks MultiViews + AllowOverride All + Order allow,deny + allow from all + + +Now create a small *.htaccess* file in the */var/www/zoo* containing the following lines: + +:: + + RewriteEngine on + RewriteRule (.*)/(.*) /cgi-bin/zoo_loader.cgi?metapath=$1 [L,QSA] + RewriteRule (.*) /cgi-bin/zoo_loader.cgi [L,QSA] + +For this last file to be taken into account by Apache, you must activate the rewrite +Apache module by copying a load file as bellow : + +:: + + sudo cp /etc/apache2/mods-available/rewrite.load /etc/apache2/mods-enabled/ + +Now you should be able to access the ZOO Kernel using a simplified by restarting +your Apache Web server : + +:: + + sudo /etc/init.d/apache2 restart + +Two other softwares form the OSGeoLive environment will be used during this workshop. +Geoserver will first be used to provide WFS input data for the ZOO Services we are going +to develop. The Geoserver sample dataset (United States polygons) will be passed to our +service during section 3. So please start the Geoserver using the corresponding launcher +in the Servers folder, as illustrated in the following screenshot : + +OpenLayers library is also available on the OSGeoLive virtual machine image disk, and it +will be used during section 4, for building a simple WPS client application able to query +the newly developed ZOO Services. + +As we planned to use OGR C-API and Python module of the GDAL library, we will need the +corresponding header files, libraries and associated files. Hopefully everything was +already available per default and so ready to use on the OSGeoLive packaging. + Index: /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/index.txt (revision 672) @@ -0,0 +1,10 @@ +.. _tutorial: + +ZOO Tutorial +============ + +.. toctree:: + :maxdepth: 2 + + introduction + environment Index: /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/introduction.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/introduction.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/tutorial/introduction.txt (revision 672) @@ -0,0 +1,97 @@ +.. _tutorialintro: + +Introduction +============ + +What is ZOO? +------------ + +ZOO is a WPS (Web Processing Service) open source project recently released under a MIT/X-11 +style license. It provides an OGC WPS compliant developer-friendly framework to create and +chain WPS Web services. ZOO is made of three parts: + +ZOO Kernel + A powerful server-side C Kernel which makes it possible to manage and chain Web services + coded in different programming languages. + +ZOO Services + A growing suite of example Web Services based on various open source libraries. + +ZOO API + A server-side JavaScript API able to call and chain the ZOO Services, which makes the + development and chaining processes easier. + +ZOO is designed to make the WPS server-side development easier by providing a powerful system +able to understand and execute WPS compliant queries. It supports several programming languages, +thus allowing you to create Web Services in your favorite language and from existing code. +Further information on the project is available on the +`ZOO Project official website `__. + +How does ZOO work? +------------------ + +ZOO is based on a 'WPS Service Kernel' which constitutes the ZOO's core system (aka ZOO Kernel). +The latter is able to load dynamic libraries and to handle them as on-demand Web services. +The ZOO Kernel is written in C language, but supports several common programming languages +for creating ZOO Services. + +A :ref:`ZOO Service ` is a link composed of a ZOO metadata file (.zcfg) and the code +for the corresponding implementation. The metadata file describes all the available functions +which can be called using a WPS Exec Request, as well as the desired input/output. Services +contain the algorithms and functions, and can now be implemented in C/C++, Fortran, Java, +Python, PHP and JavaScript. + +:ref:`ZOO Kernel ` works with Apache and can communicate with cartographic engines +and Web mapping clients. It simply adds the WPS support to your spatial data infrastructure +and your Web mapping application. It can use every GDAL/OGR supported formats as input data +and create suitable vector or raster output for your cartographic engine and/or your +web-mapping client application. + +What are we going to do in this workshop? +----------------------------------------- + +This workshop aims to present the ZOO Project and its features, and to explain its capabilities +regarding the WPS 1.0.0 specification. The participants will learn in 3 hours how to use ZOO +Kernel, how to create ZOO Services and their configuration files and finally how to link +the created Service with a client-side webmapping application. + +A pre-compiled ZOO 1.0 version is provided inside OSGeoLive, the OSGeo official Live DVD. +For the sack of simplicity, an OSGeoLive Virtual Machine image disk is already installed +on your computers. This will be used during this workshop, so the participants won't have +to compile and install ZOO Kernel manually. Running and testing ZOO Kernel from this +OSGeoLive image disk is thus the first step of the workshop, and every participants should +get a working ZOO Kernel in less than 30 minutes. + +Once ZOO Kernel will be tested from a Web browser using GetCapabilities requests, +participants will be invited to create an OGR based ZOO Service Provider aiming to enable +simple spatial operations on vector data. Participants will first have to choose whether +they will create the service using C or Python language. Every programming step of the ZOO +Service Provider and the related Services will be each time detailed in C and Python. + +Once the ZOO Services will be ready and callable by ZOO Kernel, participants will finally +learn how to use its different functions from an OpenLayers simple application. A sample +dataset from Geoserver will be displayed on a simple map using WMS/WFS standards and used as +input data by the ZOO Services. Then, some specific selection and execution controls will be +added in the JavaScript code in order to execute single and multiple geometries on the displayed +polygons. + +Once again, the whole procedure will be organized step-by-step and detailed with numerous code +snippets and their respective explanations. The instructors will check the ZOO Kernel functioning +on each machine and will assist you while coding. Technical questions are of course welcome +during the workshop. + +Usefull tips for reading +------------------------ + +Codes snipets are included in yellow blocks + +Code changes are included in grey blocks + +Code snipets included in sentences are displayed this way + +HTTP and XML Requests are included in blue blocks + + + +*Let's go !* + Index: /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/building_blocks_presentation.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/building_blocks_presentation.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/building_blocks_presentation.txt (revision 672) @@ -0,0 +1,150 @@ +.. _ogr_base_vect_ops: + +********************************************************* +Building blocks presentation - Using OGR and PgRouting based Web Services +********************************************************* + +.. contents:: Table of Contents + :depth: 5 + :backlinks: top + +Introduction +============ + +In this section, you will use basic ZOO-Services : ``Buffer``, +``Intersection`` and ``DifferencePy`` which use OGR and psycopg Python modules. +The intended goal of this section is to present and interact with your new building blocks before chaining them in the next section. + +First of all, you should use the following links to access the user +interfaces and interact with your services, the first one is used to +access basic spatial-tools demo client interface and the second to +access the routing application : + * `http://localhost/zoo-ws/spatialtools-py.html `__ + * `http://localhost/zoo-ws/ `__ + +Services Provider and configuration files +========================================= + +First you may verify if the ZOO-Services are available from your current setup. +You can take a look at the ``Buffer.zcfg``, ``Intersection.zcfg`` and +``DifferencePy.zcfg`` to get details about parameters. +As you can see from the ZCFG files, you will use ZOO-Services provided by the +``service`` Python service provider. So if you want to modify the Python code +you will have to edit the corresponding file (so ``service.py``). +You are invited to use similar requests as the one used in previous +sections to learn about each services individually. + +The Buffer Service +========================= + +First click on a street then once the street is displayed in blue, click the +'Buffer' button on top, you should get similar result as displayed in the following. + +.. image:: ./images/Buffer_Level_15.png + :width: 650px + :align: center + +Since version ZOO-Project 1.2.0, you can run automatically some basic tests to +make sure that you wrote a correct ZCFG file and your service is validating. + +.. note:: the current testing is really simple and should be adapted to each Services + Provider, mainly to define input names. + +You can use the following command: + +.. code-block:: bash + + cd /home/user/zoo/testing + ./run.sh http://localhost/cgi-bin/zoo_loader.cgi Buffer + + +.. note:: During or after the test run, you can take a look inside the ``tmp`` directory + which contains both the XML requests send to the ZOO Kernel (``*1.xml``) and the + responses it gave (``output*.xml``). + +The Intersection Service +========================= + +Using the same client interface as before, once you get a Buffer, you can then +select a street intersecting the Buffer geometry to compute intersection by clicking on the Intersection button. + + +.. image:: ./images/Intersection_Level_15.png + :width: 650px + :align: center + + +The DifferencePy Service +========================= + +Using the same instructions as for Intersetion, you can get the following result. + +.. image:: ./images/Difference_Level_15.png + :width: 650px + :align: center + + +The Routing and Profile Services +========================= + +First click on the blue flag then place your starting point on the +map, do the same with the red flag to get the shortest path computed +by the dedicated service and then display its profile. Note that when +you pass the mouse over the profile display then you will see its +corresponding position displayed on the map. You can also click on a +specific step in your path to get the corresponding line displayed. + +.. image:: ./images/Routing_Basic.png + :width: 650px + :align: center + +If you take a look in the file: ``/usr/lib/cgi-bin/routing/do.zcfg`` +you may notice something new in the supported format which is +reproduced here after. + +.. code-block:: guess + + + mimeType = image/png + asReference = true + msStyle = STYLE COLOR 125 0 105 OUTLINECOLOR 0 0 0 WIDTH 3 END + useMapServer = true + extension = json + + +The ``mimeType`` is defined as ``image/png`` and there is two new +parameter which are both optional: + * ``useMapServer``: which make you able to inform the ZOO-Kernel + that it have to use MapServer to publish your result as WMS / WFS or WCS (this last + won't be used in this workshop) rather than simply storing the + result as a file. + * ``msStyle``: which let you define your own MapServer ``STYLE`` block definition. + +When you need to access a result many time or for different purpose +accross other services then it is really useful to ask ZOO-Kernel to +publish your result as WMS, WFS or WCS. + +Note that no modification of the code of the do service was required +to handle automatic pubilcation of the result as it is a vector format +supported by OGR, only modification of the zcfg was required. + +This routing example is here to illustrate how easy it is to publish +your result as WMS, WFS or WCS ressource. Indeed, when your routing +service was called, ZOO-Kernel published the result as WMS and WFS +ressources which was both used first for the UI purpose, the WMS to +display the resulting path on the map, the WFS for displaying details +about each steps. The WFS protocol is also used as the input value +for the profile computation. So, the computation was run once +and accessed three times for different purposes and from different +clients. + +For more informations about the MapServer support, please refer to `the +official ZOO-Project Documentation `_. + +Conclusion +======== + +Now you know this three services, and you get a simple interface to interact +with your MapServer WFS and your ZOO-Project WPS Servers, you are ready to use +the Services in a different way, by chaining them using the JavaScript ZOO-API to build +more complexe and powerfull services. Index: /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/first_service.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/first_service.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/first_service.txt (revision 672) @@ -0,0 +1,376 @@ +.. _first_service: + +******************************* +Creating your first ZOO Service +******************************* + +.. contents:: Table of Contents + :depth: 5 + :backlinks: top + +Introduction +============ + +In this part, you will create and publish a simple ZOO-Service named ``Hello`` which +will simply return a hello message containing the input value provided. It will be usefull +to present in deeper details general concept on how ZOO-Kernel works and handles +Execute requests. + +Service and publication process overview +======================================== + +Before starting developing a ZOO Service, you should remember that in +ZOO-Project, a Service is a couple made of: + + * a metadata file: a ZOO Service Configuration File (ZCFG) containing metadata + informations about a Service (providing informations about default / supported + inputs and outputs for a Service) + * a Services Provider: it depends on the programming language used, but for Python it + is a module and for JavaScript a script file. + +To publish your Service, which means make your ZOO Kernel aware of its presence, +you should copy a ZCFG file in the directory where ``zoo_loader.cgi`` is located (in this workshop, ``/usr/lib/cgi-bin``) or in any subdirectory. + +.. warning:: only the ZCFG file is required for the Service to be considerate as + available. So if you don't get the Service Provider, obviously your Execute + request will fail as we will discuss later. + +Before publication, you should store your ongoing work, so you'll start by +creating a directory to store the files of your Services Provider: + +.. code-block:: none + + mkdir -p /home/user/zoo-ws/ws_sp/cgi-env + +Once the ZCFG and the Python module are both ready, you can publish simply +by copying the corresponding files in the same directory as the ZOO-Kernel. + +Creating your first ZCFG file +============================= + +You will start by creating the ZCFG file for the ``Hello`` Service. Edit the +``/home/user/zoo-ws/ws_sp/cgi-env/Hello.zcfg`` file +and add the following content: + +.. code-block:: none + :linenos: + + [Hello] + Title = Return a hello message. + Abstract = Create a welcome string. + processVersion = 2 + storeSupported = true + statusSupported = true + serviceProvider = test_service + serviceType = Python + + [name] + Title = Input string + Abstract = The string to insert in the hello message. + minOccurs = 1 + maxOccurs = 1 + + dataType = string + + + + + [Result] + Title = The resulting string + Abstract = The hello message containing the input string + + dataType = string + + + + +.. note:: the name of the ZCFG file and the name between braket (here ``[Hello]``) + should be the same and correspond to the function name you will define in your + Services provider. + +As you can see in the ZOO Service Configuration File presented above it is divided into +three distinct sections: + #. Main Metadata information (from line 2 to 8) + #. List of Inputs metadata information (from 9 line to 19) + #. List of Outputs metadata information (from line 20 to 28) + +You can get more informations about ZCFG from `the reference documentation +`__. + +If you copy the ``Hello.zcfg`` file in the same directory as your ZOO Kernel +then you will be able to request for DescribeProcess using the ``Hello`` +``Identifier``. The ``Hello`` service should also be listed from Capabilities +document. + +.. code-block:: none + cp /home/user/zoo-ws/ws_sp/cgi-env/Hello.zcfg /usr/lib/cgi-bin + +Test requests +================= + +In this section you will tests each WPS requests : GetCapabilities, +DescribeProcess and Execute. Note that only GetCapabilities and DescribeProcess +should work at this step. + +Test the GetCapabilities request +-------------------------------- + +If you run the ``GetCapabilities`` request: + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=GetCapabilities&service=WPS + +Now, you should find your Hello Service in a ``Process`` node in +``ProcessOfferings``: + +.. code-block:: xml + + + Hello + Return a hello message. + Create a welcome string. + + +Test the DescribeProcess request +-------------------------------- + +You can access the ``ProcessDescription`` of the ``Hello`` service using the +following ``DescribeProcess`` request: + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=Hello + +You should get the following response: + +.. code-block:: xml + + + + Hello + Return a hello message. + Create a welcome string. + + + name + Input string + The string to insert in the hello message. + + string + + + + + + + Result + The resulting string + The hello message containing the input string + + string + + + + + + +Test the Execute request +------------------------ + +Obviously, you cannot run your Service because the Python file was not published +yet. If you try the following ``Execute`` request: + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Hello&DataInputs=name=toto + +You should get an ExceptionReport similar to the one provided in the following, +which is normal behavior: + +.. code-block:: xml + + + + Python module test_service cannot be loaded. + + + +Implementing the Python Service +================================ + +General Principles +------------------ + +The most important thing you must know when implementing a new ZOO-Services +using the Python language is that the function corresponding to your Service +returns an integer value representing the status of execution +(``SERVICE_FAILED`` [#f1]_ or ``SERVICE_SUCCEEDED`` [#f2]_) and takes three +arguments (`Python dictionaries +`__): + + - ``conf`` : the main environment configuration (corresponding to the main.cfg content) + - ``inputs`` : the requested / default inputs (used to access input values) + - ``outputs`` : the requested / default outputs (used to store computation result) + +.. note:: when your service return ``SERVICE_FAILED`` you can set + ``conf["lenv"]["message"]`` to add a personalized message in the ExceptionReport + returned by the ZOO Kernel in such case. + +You get in the following a sample ``conf`` value based on the ``main.cfg`` file you +saw `before `__. + +.. code-block:: javascript + :linenos: + + { + "main": { + language: "en-US", + lang: "fr-FR,ja-JP", + version: "1.0.0", + encoding: "utf-8", + serverAddress: "http://localhost/cgi-bin/zoo_loader.cgi", + dataPath: "/var/data", + tmpPath: "/var/www/temp", + tmpUrl: "../temp", + cacheDir: "/var/www/temp/" + }, + "identification": { + title: "ZOO-Project Workshop - FOSS4G 2014", + keywords: "WPS,GIS,buffer", + abstract: "Deploying Web Processing Services using ZOO-Project – Examples of Python based WPS using PgRouting", + accessConstraints: "none", + fees: "None" + }, + "provider": { + positionName: "Developer", + providerName: "ZOO-Project", + addressAdministrativeArea: "Lattes", + addressCountry: "fr", + phoneVoice: "False", + addressPostalCode: "34970", + role: "Dev", + providerSite: "http://www.zoo-project.org", + phoneFacsimile: "False", + addressElectronicMailAddress: "gerald.fenoy@geolabs.fr", + addressCity: "Denver", + individualName: "Gérald FENOY" + } + +In the following you get a sample outputs value passed to a Python or a JavaScript Service: + +.. code-block:: javascript + :linenos: + + { + 'Result': { + 'mimeType': 'application/json', + 'inRequest': 'true', + 'encoding': 'UTF-8' + } + } + +.. note:: the ``inRequest`` value is set internally by the ZOO-Kernel and can be used to determine from the Service if the key was provided in the request. + +ZOO-Project provide a ZOO-API which was originally only available for +JavaScript services, but thanks to the work of the ZOO-Project +community, now you have also access to a ZOO-API when using +the Python language. Thanks to the Python ZOO-API you don't have to remember anymore +the value of SERVICE_SUCCEDED and SERVICE_FAILED, you +have the capability to translate any string from your Python service +by calling the ``_`` function (ie: ``zoo._('My string to +translate')``) or to update the current status of a running service by +using the ``update_status`` [#f4]_ function the same way you use it from +JavaScript or C services. + +The Hello Service +------------------------ + +You can copy and paste the following into the +``/home/user/zoo-ws/ws_sp/cgi-env/test_service.py`` file. + +.. code-block:: python + + import zoo + def Hello(conf,inputs,outputs): + outputs["Result"]["value"]=\ + "Hello "+inputs["name"]["value"]+" from the ZOO-Project Python world !" + return zoo.SERVICE_SUCCEEDED + +Once you finish editing the file, you should copy it in the ``/usr/lib/cgi-bin`` directory: + +.. code-block:: none + + sudo cp /home/user/zoo-ws/ws_sp/cgi-env/* /usr/lib/cgi-bin + + +Interracting with your service using Execute requests +===================================================== + +Now, you can request for Execute using the following basic url: + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Hello&DataInputs=name=toto + +You can request the WPS Server to return a XML WPS Response containing the result of +your computation, requesting for ResponseDocument or you can access the data directly +requesting for RawDataOutput. + +* Sample request using the RawDataOutput parameter: + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Hello&DataInputs=name=toto&RawDataOutput=Result + +* Sample request using the default ResponseDocument parameter: + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Hello&DataInputs=name=toto&ResponseDocument=Result + +When you are using ResponseDocument there is specific attribut you can use to ask +the ZOO Kernel to store the result: ``asReference``. You can use the following example: + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Hello&DataInputs=name=toto&ResponseDocument=Result@asReference=true + +When computation take long time, the client should request the +execution of a Service by setting both ``storeExecuteResponse`` and +``status`` parameter to true to force asynchronous execution. This +will make the ZOO-Kernel return, without waiting for the Service execution +completion but after starting another ZOO-Kernel process responsible +of the Service execution, a ResponseDocument containing a ``statusLocation`` +attribute which can be used to access the status of an ongoing service +or the result when the process ended [#f3]_. + +.. code-block:: none + + http://localhost/cgi-bin/zoo_loader.cgi?request=Execute&service=WPS&version=1.0.0&Identifier=Hello&DataInputs=name=toto&ResponseDocument=Result&storeExecuteResponse=true&status=true + +Conclusion +========== + +Even if this first service was really simple it was useful to illustrate how the +ZOO-Kernel fill ``conf``, ``inputs`` and ``outputs`` parameter prior to load +and run your function service, how to write a ZCFG file, how to publish a Services +Provider by placing the ZCFG and Python files in the same directory as the +ZOO-Kernel, then how to interract with your service using both +``GetCapabilities``, ``DescribeProcess`` and ``Execute`` requests. We will see +in the `next section `__ how to write similar requests +using the XML syntax. + +.. rubric:: Footnotes + +.. [#f1] ``SERVICE_FAILED=4`` +.. [#f2] ``SERVICE_SUCCEEDED=3`` +.. [#f4] sample use of update_status is available `here `_ +.. [#f3] To get on-going status url in ``statusLocation``, you'll + need to setup the `utils/status + `_ + Service. If you don't get this service available, the ZOO-Kernel will + simply give the url to a flat XML file stored on the server which will + contain, at the end of the execution, the result of the Service + execution. For more informations please take a look into the + reference `documentation `__. Index: /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/index.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/index.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/index.txt (revision 672) @@ -0,0 +1,70 @@ +.. _workshop-foss4g-2014: + +########################################## +Deploying Web Processing Services using ZOO-Project – Examples of Python based WPS using PgRouting +########################################## + +:Author: Gérald Fenoy, Nicolas Bozon, Venkatesh Raghavan +:Contact: gerald.fenoy at geolabs.fr, nicolas.bozon at gmail.com, venka at osgeo.org +:Last Updated: $Date$ + +**************************************** +FOSS4G 2014 Portland +**************************************** + +.. image:: ./images/FOSS4G_Ad_200x100_2x.jpg + :target: http://2014.foss4g.org/ + :align: center + +************** +Sponsored By +************** + +.. image:: ../../_static/images/geolabs-logo.png + :target: http://www.geolabs.fr/ + +.. image:: ../../_static/images/apptech-logo.png + :target: http://www.apptec.co.jp/ + +.. image:: ../../_static/images/neogeo-logo.png + :target: http://www-neogeo-online.net/ + +.. image:: ../../_static/images/3liz-logo.png + :target: http://www.3liz.com/ + +.. image:: ../../_static/images/gateway-logo.png + :target: http://www.gatewaygeomatics.com/ + +******************************************* +Special thanks to our Knowledge Partners +******************************************* + +.. image:: ../../_static/images/ocu-logo.png + :target: http://www.osaka-cu.ac.jp/english/ + +.. image:: ../../_static/images/logo-fem.png + :target: http://www.fondazioneedmundmach.it/ + +.. image:: ../../_static/images/polimi-logo.png + :target: http://geomatica.como.polimi.it/ + +.. image:: ../../_static/images/gucas-logo.png + :target: http://www.gucas.ac.cn/gscasenglish/index.aspx + +.. image:: ../../_static/images/cumtb-logo.png + :target: http://www.cumtb.edu.cn/ + +.. image:: ../../_static/images/logo-supsi.png + :target: http://www.supsi.ch/home.html + +**************************** +WorkShop table of content +**************************** +.. toctree:: + :maxdepth: 5 + + introduction + using_zoo_from_osgeolivevm + first_service + building_blocks_presentation + js_services_chaining Index: /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/introduction.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/introduction.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/introduction.txt (revision 672) @@ -0,0 +1,60 @@ +.. _introduction: + +************** +Introduction +************** + +.. contents:: Table of Contents + :depth: 5 + :backlinks: top + +What is ZOO ? +============= + +ZOO-Project is a WPS (Web Processing Service) open source project released under a `MIT/X-11 `__ style license. It provides an OGC WPS compliant developer-friendly framework to create and chain WPS Web services. ZOO is made of three parts: + +* `ZOO Kernel `__ : A powerful server-side C Kernel which makes it possible to manage and chain Web services coded in different programming languages. +* `ZOO Services `__ : A growing suite of example Web Services based on various open source libraries. +* `ZOO API `__ : A server-side JavaScript API able to call and chain the ZOO Services, which makes the development and chaining processes easier and faster. + +ZOO was designed to make the service creation and deployment easy, by providing a powerful system able to understand and execute WPS compliant queries. It supports seven programming languages, thus allowing you to create Web Services using the one you prefer. It also lets you use an existing code and to turn it as a WPS Service. +The current supported programming languages are the following: + +* C/C++ +* Python +* Perl +* Java +* Fortran +* PHP +* JavaScript + +More information on the project is available on the `ZOO-Project official website `__ . + +How does ZOO works ? +==================== + +ZOO is based on a C Kernel which is the ZOO-Project core system (aka ZOO-Kernel). The latter is able to dynamically load libraries and to handle them as on-demand Web services. + +A ZOO-Service is a link composed of a ZOO metadata file (.zcfg) and the code for the corresponding implementation. The metadata file describes the function that can be called using a WPS Execute Request, as well as the supported input/output formats. Service contains the algorithms and functions, and can be implemented using any of the supported languages. + +ZOO-Kernel works as CGI through Apache and can communicate with cartographic engines and Web mapping clients. It simply adds the WPS support to your spatial data infrastructure and your webmapping applications. It can use every GDAL/OGR supported formats as input data and create suitable vector or raster output for your cartographic engine and/or your web-mapping client application. + +What are we going to do in this workshop? +=============================== + +You will learn how to use ZOO-Kernel and how to create ZOO-Services using the OSGeoLiveDVD 7.9 `iso image `_ provided at the begining of this workshop on MapMint USB Sticks. Despite a pre-compiled ZOO 1.3.0 package is provided inside the official OSGeoLive, some optional supports are not available in the default setup and the ZOO-Kernel made available correspond to the 1.4-dev version, so let say the current version. So you will use the binary version of ZOO-Kernel available on the iso image provided. Configuration file and basic ways to use ZOO-Kernel and ZOO-Service will be presented. Then you will be invited to start programming your own simple service using Python language. Some ZOO-Services will be presented and individually tested inside a ready-to-use OpenLayers application. Finally, this services will be chained using the server-side Javascript ZOO-API. + +The whole workshop is organized step-by-step and numerous code snippets are available. The instructors will check the ZOO-Kernel is functioning on each machine and will assist you while coding. Technical questions are of course welcome during the workshop. + +Usefull tips for reading +======================== + +.. code-block:: guess + + this is a code block + +.. warning:: This is a warning message. + +.. note:: This is an important note. + +**Let's go !** Index: /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/js_services_chaining.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/js_services_chaining.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/js_services_chaining.txt (revision 672) @@ -0,0 +1,593 @@ +.. _ogr_base_vect_ops: + +*************************************************************** +Playing with buildign blocks - Creating JavaScript Web Services +*************************************************************** + +.. contents:: Table of Contents + :depth: 5 + :backlinks: top + +Introduction +============ + + +This section illustrate how you can use JavaScript on the server-side to chain +services together to build new ones. You will create a ZOO Services Provider +using the services you seen before and the WFS server using the ZOO-API. The +final goal is to query all POIs included in a buffer around a feature and +to highlight them using a mask around this buffer. The following screenshot show +you the expected result: + +.. image:: ./images/BufferMaskAndRequest_Level_15.png + :width: 650px + :align: center + +For the routing interface result should look like this: + +.. image:: ./images/BufferMaskAndRequest_Routing_Level_15.png + :width: 650px + :align: center + +You can decompose the result above in two different ones: the mask around the +buffer and the points included in the buffer. So you will create two different +Services: one called ``BufferMask`` and another one called ``BufferRequest``. + +But before implementing any JavaScript Service, you will get an overview of how +to use ZOO-API from your ZOO-Project installation in the next section. + +As before, you first create a new directory to store files for your new Services +Provider: + +.. code-block:: guess + + mkdir -p ~/zoo-ws/jschains/cgi-env/ + + +ZOO-API Overview +================ + +ZOO-API and ZOO-Kernel JavaScript support make you able to run services +implemented in JavaScript on the server side. JavaScript is a popular programing +language but mostly used on the client side. Let say from a browser, but here it +is a bit different. + +To support JavaScript language ZOO-Kernel use the +`SpiderMonkey `__ API to create a +javascript runtime environment from which it will load your JS file then extract +the function corresponding to the service to run it using the prefilled +parameters. The JavaScript runtime environment created by the ZOO-Kernel +depend on your setup. If you placed the ``ZOO-api.js`` and ``ZOO-proj4js.js`` in +the same directory as your ZOO-Kernel it means that your environment will +contains ZOO-API and Proj4js which will be loaded before your service. In such case you can access to the Classes defined in the JavaScript ZOO-API +to manipulate geographic data, for more informations please refer to the +`ZOO-API Documentation `__. + +Even if it can be useful to run JavaScript on the server side, you should +remember that some basic JavaScript functions you are familiar with does not +exist or get a different behavior. For instance the simple ``alert`` +function will display messages in apache error logs rather than in a window when +used from a browser. The ``alert`` function can be used as follow: + +.. code-block:: guess + + alert("My alert message"); + +There is no XMLHttpRequest available in the JavaScript evironement your service +will run into. Hopefully, the ZOO-Kernel expose a C function to the JavaScript +world named: ``JSRequest``. This function make you able from your JavaScript +services to call other WPS services (locally or remotelly) or other kind OGC +services such as WFS. When you are using the ZOO-API it is possible to call +Services using a ``ZOO.Process`` instance [#f3]_, to parse WPS Responses using +``ZOO.Format.WPS`` +(cf. `ref `__). + +As for Python services you already seen in previous sections, the functions +corresponding to a Service should take three arguments: ``conf``, ``inputs`` and +``outputs`` [#f4]_. Nevertheless, as the ZOO-Kernel is not able to access the +values modified [#f5]_ by the Service code, rather than returning an integer as +in Python, here you'll need to return both the integer value representing the +Status of your Service in a JavaScript Object and the resulting ``outputs`` +values as an Object [#f6]_. You can see in the following an example of a JavaScript +Service code: + +.. code-block:: none + + function SampleService(conf,inputs,outputs){ + var resultValue=someComputation(inputs); + return + { + result: ZOO.SERVICE_SUCCEEDED, + outputs: { "Result": { "mimeType": "application/json", "value": resultValue } } + }; + } + +Before starting to implement the Services we will need to get our final +BufferRequest service, let start with a simplier one. + +The Mask Service +================ + +In this section you will learn how to create your first JavaScript service which +will simply return a rectangular mask around a selected feature. To build this +mask you will use the Buffer service to create a buffer big enough around a +selected geometry to cover a significant part of your map. You can see the +expected result in the following screenshot: + +.. image:: ./images/Mask_Level_12.png + :width: 650px + :align: center + +As before, you will first start by writting the ZCFG, then you will write the +JavaScript source code and finish by publishing your Services Provider. + +The ZCFG +-------- + +Open a file named +``~/zoo-ws/jschains/cgi-env/Mask.zcfg`` +with your favorite text editor and add the following content: + +.. code-block:: none + :linenos: + + [Mask] + Title = Compute mask + Abstract = Compute mask around a geometry + processVersion = 1 + storeSupported = true + statusSupported = true + serviceProvider = foss4gws.js + serviceType = JS + + [InputData] + Title = The feature + Abstract = The feature to run the service with + minOccurs = 1 + maxOccurs = 1 + + + mimeType = text/xml + encoding = utf-8 + + + + + [Result] + Title = The resulting feature + Abstract = The feature created by the service. + + + mimeType = application/json + + + + +Here you simply define one default ``ComplexData`` for both ``inputData`` and +``Result``: a GML and a GeoJSON respectively [#f7]_. + +The JavaScript service +---------------------- + +As you will have to request the Buffer service many times from your service, you +will first define a ``Buffer`` function as follow. It uses the ``ZOO.Process`` +to request the Buffer service you seen in the previous section. + +Open a file named +``~/zoo-ws/jschains/cgi-env/foss4gws.js`` and +add the following content: + +.. code-block:: javascript + :linenos: + + var zoo_url='http://localhost/cgi-bin/zoo_loader.cgi'; + var mapfile="/var/data/maps/project_WS2014.map"; + var mapserv_url="http://localhost/cgi-bin/mapserv?map="+mapfile; + + function Buffer(inputData,bDist){ + + // Create all required ZOO.formats + var fJ=new ZOO.Format.JSON(); + var fGJ=new ZOO.Format.GeoJSON(); + var fWPS=new ZOO.Format.WPS(); + + // Pass the value as json + var myInputs = { + InputPolygon: { type: 'complex', value: fGJ.write(inputData), mimeType: "application/json"}, + BufferDistance: {type: 'float', "value": bDist } + }; + var myOutputs= { Result: { type: 'RawDataOutput', "mimeType": "application/json" } }; + var myProcess = new ZOO.Process(zoo_url,'BufferPy'); + var myExecuteResult=myProcess.Execute(myInputs,myOutputs); + + return fGJ.read(myExecuteResult); + + } + +From line 12 to 16, you give a GeoJSON string (created from ``inputData``) for +InputPolygon and, on line 15, you set the BufferDistance value to ``bDist``. +On line 17, you define Result as a RawDataOutput, so you won'tl have to parse the +WPS response using the ZOO.Format.WPS. + +On line 18, you create a +`ZOO.Process `__ +instance providing the ZOO-Kernel url and the Service name. Then, on line 19, you +run the request passing inputs and outputs previously defined (from line 12 to 15). On line 21 you return the GeoJSON red. + +Now, you get your ``Buffer`` function, it is time to create your first JavaScript +service. So, edit your ``foss4gws.js`` file you created before and add the following content: + +.. code-block:: javascript + :linenos: + + function Mask(conf,inputs,outputs){ + + // Create all required ZOO.formats + var fGML=new ZOO.Format.GML(); + var fGJ=new ZOO.Format.GeoJSON(); + + // Read the input GML + var inputData=fGML.read(inputs["InputData"]["value"]); + + // Compute Buffer + var bufferResultAsJSON=Buffer(inputData,0.015); + + // Create the Buffer result BBOX and store its geometry in a ZOO.Feature + var bbox = new ZOO.Bounds(); + var bounds=bufferResultAsJSON[0].geometry.getVertices(); + for(var t in bounds){ + bbox.extend(bounds[t]); + } + var finalG=bbox.toGeometry(); + var result=new ZOO.Feature(finalG,{"name": "Result1000"}); + + // Return the created feature + return { + result: ZOO.SERVICE_SUCCEEDED, + outputs: { "Result": { mimeType: "application/json", value: fGJ.write(result) } } + }; + + } + +Publish and use your Service +---------------------------- + +Now you get both your ZCFG and your service code ready, you need to deploy your +new Services Provider using the following command: + +.. code-block:: bash + + sudo cp ~/zoo-ws/jschains/cgi-env/* /usr/lib/cgi-bin + +Now you are ready to use your JavaScript service by loading the following `url +`__, click on a street then click on +the "Mask" button. + +BufferMask Service +================== + +In this section you will implement a simple JavaScript service which will be able create +a hole in the mask you created in `previous section <#mask-service>`__. This service +will be used to highlight the buffer zone around a selected fature. You get a preview of +the expected result in the following screenshot: + +.. image:: ./images/BufferMask_Level_15.png + :width: 650px + :align: center + + +The ZCFG +-------- + +Open the file named +``~/zoo-ws/jschains/cgi-env/BufferMask.zcfg`` +with your favorite text editor and copy / paste the following content: + +.. code-block:: none + :linenos: + + [BufferMask] + Title = Compute buffer mask + Abstract = Compute buffer mask around a geometry + processVersion = 1 + storeSupported = true + statusSupported = true + serviceProvider = foss4gws.js + serviceType = JS + + [InputData] + Title = The feature + Abstract = The feature to run the service with + minOccurs = 1 + maxOccurs = 1 + + + mimeType = text/xml + encoding = utf-8 + + + + + [Result] + Title = The resulting feature + Abstract = The feature created by the service. + + + mimeType = application/json + + + + +This ZCFG is similar to the previous one. Please, refer to comments in the +`previous section <#the-zcfg>`__ for more informations. + +The JavaScript service +---------------------- + +In this Service you will use same source code (until line 19) you used in the +`previous section <#the-javascript-service>`__. Indeed, you should compute the Mask +as you did before then compute Buffer for creating a hole in the mask (on line 22) to run +the Difference service (from line 25 to 40). + +.. code-block:: guess + :linenos: + + function BufferMask(conf,inputs,outputs){ + + // Create all required ZOO.formats + var fGML=new ZOO.Format.GML(); + var fGJ=new ZOO.Format.GeoJSON(); + + // Read the input GML + var inputData=fGML.read(inputs["InputData"]["value"]); + + // Compute Buffer + var bufferResultAsJSON=Buffer(inputData,0.015); + + // Create the Buffer result BBOX + var bbox = new ZOO.Bounds(); + var bounds=bufferResultAsJSON[0].geometry.getVertices(); + for(var t in bounds){ + bbox.extend(bounds[t]); + } + var finalG=bbox.toGeometry(); + + // Compute Buffer standard buffer + var bufferResultAsJSON=Buffer(inputData,0.0015); + + // Request Difference service using Buffer result and features in the BBOX + var result=new ZOO.Feature(finalG,{"name": "Result1000"}); + var myProcess2 = new ZOO.Process(zoo_url,'DifferencePy'); + var myInputs2 = { + InputEntity1: { + type: 'complex', + value: fGJ.write(finalG), + mimeType: "application/json" + }, + InputEntity2: { + type: 'complex', + value: fGJ.write(bufferResultAsJSON), + mimeType: "application/json" + } + }; + var myOutputs2= {Result: {type: 'RawDataOutput', mimeType: "application/json" } }; + var myExecuteResult4=myProcess2.Execute(myInputs2,myOutputs2); + + // Return the bbox + var result=new ZOO.Feature(finalG,{"name": "Result1000"}); + return { + result: ZOO.SERVICE_SUCCEEDED, + outputs: { "Result": {mimeType: "application/json", value: myExecuteResult4 } } + }; + + } + +Publish and use your Service +---------------------------- + +Now, you can publish your service as you did `before <#publish-your-service>`__. To +use your service, please use the following `url +`__. + +BufferRequest service +====================== + +In this section, you will create a new Service: ``BufferRequest`` which will request +POIs included in the Buffer around a selected feature [#f8]_. You will use the ``poi`` +layer served as WFS through your local mapserver installation. You can see in the +following screenshot the expected result: + +.. image:: ./images/BufferRequest_Level_15.png + :width: 650px + :align: center + +The ZCFG +-------- + +Open the file named +``~/zoo-ws/jschains/cgi-env/BufferRequest.zcfg`` +with your favorite text editor and copy / paste the following content: + +.. code-block:: none + :linenos: + + [BufferRequest] + Title = Compute buffer request + Abstract = Compute buffer request around a geometry + processVersion = 1 + storeSupported = true + statusSupported = true + serviceProvider = foss4gws.js + serviceType = JS + + [InputData] + Title = The feature + Abstract = The feature to run the service with + minOccurs = 1 + maxOccurs = 1 + + + mimeType = text/xml + encoding = utf-8 + + + + + [Result] + Title = The resulting feature + Abstract = The feature created by the service. + + + mimeType = application/json + + + + + +The JavaScript code +------------------- + +As in the previous Service, you will compute a buffer around the input feature. But then +you will request POIs available in the Buffer extent using a WFS request to use them to +run ``Intersection`` service using the initial Buffer. The WFS request is useful to limit +the number of points to use when requesting the ``Intersection`` Service. + +.. code-block:: javascript + :linenos: + + function BufferRequest(conf,inputs,outputs){ + + // Create all required ZOO.formats + var fGJ=new ZOO.Format.GeoJSON(); + var fGML=new ZOO.Format.GML(); + + // Read the input GML + var inputData=fGML.read(inputs["InputData"]["value"]); + + // Compute Buffer + var bufferResultAsJSON=Buffer(inputData,0.0015); + + // Create the Buffer result BBOX + var bbox = new ZOO.Bounds(); + var bounds=bufferResultAsJSON[0].geometry.getVertices(); + for(var t in bounds){ + bbox.extend(bounds[t]); + } + + // Request Intersection service using Buffer result and WFS request using the + // BBOX + var myProcess2 = new ZOO.Process(zoo_url,'Intersection'); + var req="&SERVICE=WFS&version=1.0.0&request=GetFeature&typename=poi1"; + req+="&SRS=EPSG:4326&BBOX="; + var myInputs2 = { + InputEntity1: { + type: 'complex', + value: fGJ.write(bufferResultAsJSON), + mimeType: "application/json" + }, + InputEntity2: { + type: 'complex', + xlink: mapserv_url+req+bbox.left+","+bbox.bottom+","+bbox.right+","+bbox.top, + mimeType: "text/xml" + } + }; + var myOutputs2= {Result: { type: 'RawDataOutput', "mimeType": "application/json" } }; + var myExecuteResult4=myProcess2.Execute(myInputs2,myOutputs2); + + return { + result: ZOO.SERVICE_SUCCEEDED, + outputs: [ {name:"Result", mimeType: "application/json", value: myExecuteResult4} ] + }; + + } + +.. warning:: to take advantage of the ZOO-Kernel cache system, you directly use the WFS + request as ``xlink:href`` rather than value for ``InputEntity2`` (from line 31 to 34) and use ``text/xml`` ``mimeType`` + (on line 40). Indeed, the ZOO-API doesn't use the internal cache mechanisms. + + +Publish and use your Service +---------------------------- + +Now, you can publish your service as you did `before <#publish-your-service>`__. To +use your service, please use the following `url +`__. + +.. note:: You can click on "Buffer Request and Mask" to get the same result as presented + in `the initial screenshot <#introduction>`__. + + +Add Union into the chain +=================================== + +As you can see in the following screenshot, when using the Buffer +service using a feature collection containing more than one geometry, +the result is made of multiple geometries. So, running Buffer service +on the routing interface will result in multiple buffer: + +.. image:: ./images/Buffer_Routing_Level_15.png + :width: 650px + :align: center + +So, to get the same result as you got when selecting a single +road, you should use Union of geometry (input or the one outputed by the +``Buffer`` Service). As you are using the JavaScript ZOO-API, you can +simply update the ``Buffer`` JavaScript function you defined earlier, to +first call the Union of each geometry avaible in a feature collection +prior to request (or after requesting) the Buffer Service. Hopefully, +there is already this Python Service available, its name is +``UnionOne1``, so you just need to add it in your Service chain. + +Here is the final code for the Buffer JavaScript function: + +.. code-block:: javascript + :linenos: + + function Buffer(inputData,bDist){ + + // Create all required ZOO.formats + var fJ=new ZOO.Format.JSON(); + var fGJ=new ZOO.Format.GeoJSON(); + var fWPS=new ZOO.Format.WPS(); + + // Call the UnionOne1 Service + var myInputs0 = { + InputPolygon: { type: 'complex', value: fGJ.write(inputData), mimeType: "application/json"}, + BufferDistance: {type: 'float', "value": bDist } + }; + var myOutputs0= { Result: { type: 'RawDataOutput', "mimeType": "application/json" } }; + var myProcess0 = new ZOO.Process(zoo_url,'UnionOne1'); + var myExecuteResult0=myProcess0.Execute(myInputs0,myOutputs0); + + // Call the BufferPy Service + var myInputs = { + InputPolygon: { type: 'complex', value: myExecuteResult0, mimeType: "application/json"}, + BufferDistance: {type: 'float', "value": bDist } + }; + var myOutputs= { Result: { type: 'RawDataOutput', "mimeType": "application/json" } }; + var myProcess = new ZOO.Process(zoo_url,'BufferPy'); + var myExecuteResult=myProcess.Execute(myInputs,myOutputs); + + return fGJ.read(myExecuteResult); + + } + + +Conclusion +========== + +After understanding how basic Geometric Operation Services works, here you built step by step new JavaScript services which reuse the previous ones and combine them in different ways. This was achieved using the ZOO-API, composed by C functions exposed by the ZOO-Kernel to the JavaScript services runtime environement and the JS files which can be optionally installed. + +.. rubric:: Footnotes + +.. [#f3] The ``ZOO.Process`` class uses ``JSRequest`` (cf. `ref + `__). You will get example + of use `later <#the-javascript-service>`__. +.. [#f4] So ``conf``, ``inputs`` and ``outputs`` are simple JavaScript objects, similar + to the Python dictionaries used in the `previous section `__. +.. [#f5] Such as ``conf``, ``inputs`` and ``outputs``. +.. [#f6] You can also return a conf Object if you get any informations updated from your JavaScript service (such as cookie for instance) +.. [#f7] Using one of the available ``ZOO.formats`` you are also able to support various + ``ComplexData`` for both input and output of the service. To simplify the + presentation here, you will use only this default ones. +.. [#f8] So in the hole you created in the previous section. Index: /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/using_zoo_from_osgeolivevm.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/using_zoo_from_osgeolivevm.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/docs/workshop/2014/using_zoo_from_osgeolivevm.txt (revision 672) @@ -0,0 +1,218 @@ +.. _using_zoo_from_osgeolivevm: + +******************************************************************** +Configuration and ZOO-Kernel use +******************************************************************** + +.. contents:: Table of Contents + :depth: 5 + :backlinks: top + +ZOO-Kernel Configuration +======================== + +As already said in introduction, an OSGeoLive Virtual Machine has been booted on your computer, allowing you to use ZOO-Kernel in a development environment directly. + +.. note:: we will use ZOO-Kernel or ``zoo_loader.cgi`` script without any distinction + in this document. + +General ZOO-Kernel settings are set in the ``main.cfg`` file located in the same directory as the ZOO-Kernel, so in ``/usr/lib/cgi-bin/``. This informations will be accessible from each services at runtime, so when you wil use Execute requests. You can see a typical ``main.cfg`` content in the following: + +.. code-block:: guess + :linenos: + + [headers] + X-Powered-By=ZOO-Project@MapMint + + [main] + encoding=utf-8 + dataPath=/var/data + tmpPath=/var/www/temp + cacheDir=/var/www/cache + version=1.0.0 + sessPath=/tmp + msOgcVersion=1.0.0 + serverAddress=http://localhost/cgi-bin/mm/zoo_loader.cgi + lang=fr-FR,ja-JP + language=en-US + mapserverAddress=http://localhost/cgi-bin/mapserv.cgi + tmpUrl=http://127.0.0.1/temp/ + + [identification] + keywords=WPS,GIS,buffer,MapMint,ZOO-Project + title=ZOO-Project Workshop - FOSS4G 2014 + abstract= Deploying Web Processing Services using ZOO-Project – Examples of Python based WPS using PgRouting + accessConstraints=none + fees=None + + [provider] + positionName=Developer + providerName=GeoLabs SARL + addressAdministrativeArea=False + addressDeliveryPoint=1280, avenue des Platanes + addressCountry=fr + phoneVoice=+33467430995 + addressPostalCode=34970 + role=Dev + providerSite=http://www.geolabs.fr + phoneFacsimile=False + addressElectronicMailAddress=gerald@geolabs.fr + addressCity=Lattes + individualName=Gérald FENOY + + +The ``main.cfg`` file contains metadata informations about the identification and provider but also some important settings. The file is composed of various sections, namely ``[main]``, ``[identification]`` and ``[provider]`` per default. + +From the ``[main]`` section settings are as follow: + * ``lang``: the supported languages separated by a coma (the first is the default one), + * ``version``: the supported WPS version, + * ``encoding``: the default encoding of WPS Responses, + * ``serverAddress``: the url to access your ZOO-Kernel instance, + * ``dataPath``: the path to store data files (when MapServer support was activated, + this directory is used to store mapfiles and data). + * ``tmpPath``: the path to store temporary files (such as ExecuteResponse when + storeExecuteResponse was set to true), + * ``tmpUrl``: a url relative to ``serverAddress`` to access the temporary file, + * ``cacheDir``: the path to store cached request files [#f1]_ (optional), + * ``mapservAddress``: your local MapServer address (optional), + * ``msOgcVersion``: the version for all supported OGC Web Services output [#f2]_ + (optional). + +The ``[identification]`` and ``[provider]`` section are specific to OGC metadata and +should be set [#f3]_. + +Obviously, you are free to add new sections to this file if you need +more [#f8]_. Nevertheless, you have to know +that there is some specific names you should use only for specific +purposes: ``[headers]``, ``[mapserver]``, ``[env]``, ``[lenv]`` and ``[senv]``. + +.. warning:: ``[senv]`` and ``[lenv]`` are used / produced on runtime internaly by the ZOO-Kernel and should be defined only from the Service code. + +The ``headers`` section is used to define your own HTTP Response +headers. You may take a look at headers returned by web site such as +http://www.zoo-project.org by using curl command line tool for +instance and notice the specific heder ``X-Powered-By: Zoo-Project@Trac``. + +.. warning:: There is no reason to define basic headers such as + ``Content-Type`` or ``encoding`` as they will be overwritten at runtime by the + ZOO-Kernel. + +The ``mapserver`` section is used to store specific mapserver configuration +parameters such as `PROJ_LIB` and `GDAL_DATA` or any other you want to be set to +make your MapServer working. + +.. note:: the ``mapserver`` section is mainly used on WIN32 platform + + +The ``env`` section is used to store specific environment variables you want to be set +prior to load your Services Provider and run your Service. A typical example, is when your +Service requires to access to a X server running on framebuffer, then you will have to +set the ``DISPLAY`` environnement variable, in this case you would add +``DISPLAY=:1`` line in your ``[env]`` section. + +The ``lenv`` is used to store runtime informations automatically set by the +ZOO-Kernel before running your service and can be accesses / updated from it: + * ``sid`` (r): the service unique identifier, + * ``status`` (rw): the current progress value (value between 0 and 100, percent), + * ``cwd`` (r): the current working directory of the ZOO-Kernel, + * ``message`` (rw): an error message when returning ``SERVICE_FAILED`` (optional), + * ``cookie`` (rw): the cookie your service want to return to the client (for authentication + purpose or tracking). + +The ``senv`` is used to store session informations on the server +side. You can then access them automatically from service if the +server is requested using a valid cookie (as defined in ``lenv > +cookie``). The ZOO-Kernel will store on disk the values set in the +``senv`` maps, then load it and dynamically add its content to the one +available in the ``main.cfg``. The ``senv`` section should contain at +least: + * ``XXX``: the session unique identifier where ``XXX`` is the name included in the + returned cookie. + +.. _cookie_example: + +For instance, if you get the following in your Service source code [#f4]_ : + +.. code-block:: python + + conf["lenv"]["cookie"]="XXX=XXX1000000; path=/" + conf["senv"]={"XXX": "XXX1000000","login": "demoUser"} + +That means that the ZOO-Kernel will create a file ``sess_XXX1000000.cfg`` in the +``cacheDir`` and return the specified cookie to the client. Each time the client will +request the ZOO-Kernel using the Cookie, it will automatically load the value stored +before running your service. You can then easilly access this informations from your +service source code. This functionality won't be used in the following presentation. + +Testing the ZOO installation with GetCapabilities +================================================= + +Once you have a main.cfg file available in the same directory as your +ZOO-Kernel, then you can use `GetCapablities`. Indeed, to answer such +kind of requests, the ZOO-Kernel will simply parse the `main.cfg` file +(to gather global informations), then parse individually each zcfg +files (if any) contained in the same directory or in sub-directories +[#f9]_, then return a well formed `Capabilities` document. + +You can request ZOO-Kernel using the following link from your Internet browser: + +http://localhost/cgi-bin/zoo_loader.cgi?Request=GetCapabilities&Service=WPS + +You should get a valid Capabilities XML document, looking like the following : + +.. image:: ./images/GC.png + :width: 650px + :align: center + +Please note that some Process nodes are returned in the +ProcessOfferings section, as somes are available already on OSGeoLive +DVD. You can also run a GetCapabilities request from the command line, +using the following command: + +.. code-block:: bash + + cd /usr/lib/cgi-bin + ./zoo_loader.cgi “request=GetCapabilities&service=WPS” | less + +The same result as in your browser will be returned, as shown in the following screenshot: + +.. image:: ./images/GC_CL.png + :width: 450px + :align: center + +Invoking ZOO Kernel from the command line can be helpful during +development process of new Services for debugging purpose. If you +need to simulate POST request from the command line, then you can use +the following: + +.. code-block:: bash + + cd /usr/lib/cgi-bin + # Download the sample GetCapabilities request + curl -o /tmp/10_wpsGetCapabilities_request.xml http://schemas.opengis.net/wps/1.0.0/examples/10_wpsGetCapabilities_request.xml + # Define required environment settings + export REQUEST_METHOD=POST + export CONTENT_TYPE=text/xml + # Run the request downloaded + ./zoo_loader.cgi < /tmp/10_wpsGetCapabilities_request.xml | less + +You should have the same result as presented before. + +.. rubric:: Footnotes + +.. [#f1] when you use GET requests passed through ``xlink:href`` the ZOO-Kernel will + execute the request only once, the first time you will ask for this ressource and it will + store on disk the result. The next time you will need the same feature, the cached file + will be used which make your process running faster. If ``cachedir`` was not + specified in the ``main.cfg`` then ``tmpPath`` value will be used. +.. [#f2] since version 1.3.0, when MapServer is activated, your service can automatically + return a WMS, WFS or WCS request to expose your data. Your can set here the specific + version number you want to use to request your local MapServer setup. It depends + mostly on the client capability to deal with specific OGC Web Services version. +.. [#f3] since version 1.3.0, when MapServer is activated, the same metadata will be used + for setting metadata for OGC Web Services. +.. [#f8] you can take a quick look into the mapmint ``main.cfg`` file + which is available in `/usr/lib/cgi-bin/mm/` directory to have + example of sections use. +.. [#f4] If you're not familiar with ZOO-Project, you can `pass `__ this part and come to it after the next section. +.. [#f9] sub-directories listing is available from `revision 469 `__. Index: /branches/PublicaMundi_David_integration_01-devel/testing/README =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/README (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/README (revision 672) @@ -0,0 +1,30 @@ +Please use the following syntaxe: + + ./run.sh + +where should be the url to a WPS Server and should +be the service name you want to run tests with. + +For instance to test the Buffer service on a localhost WPS server, use the +following command: + + ./run.sh http://localhost/cgi-bin/zoo_loader.cgi Buffer + + +Important note: sometimes XML validation failed because xmllint is unable to download +a file required to validate. In such case, you can use the file /etc/xml/catalog on your +local machine to use a local copy of the missing file. + +For instance, in case xml.xsd can't be downloaded, then you can download a copy using +this url http://www.w3.org/2001/xml.xsd, store it in /etc/schemas directory and then +use the following /etc/xml/catalog file: + + + + + + + +Obviously, you can do similar manipulation for the OGC schemas to use local files +rather than downloading them for each tests. Index: /branches/PublicaMundi_David_integration_01-devel/testing/extractExceptionInfo.xsl =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/extractExceptionInfo.xsl (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/extractExceptionInfo.xsl (revision 672) @@ -0,0 +1,14 @@ + + + + + + + + Code: , Locator: + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/extractStatusLocation.xsl =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/extractStatusLocation.xsl (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/extractStatusLocation.xsl (revision 672) @@ -0,0 +1,15 @@ + + + + + + + + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/dp.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/dp.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/dp.xml (revision 672) @@ -0,0 +1,4 @@ + + + ServiceName + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/igml_o.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/igml_o.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/igml_o.xml (revision 672) @@ -0,0 +1,19 @@ + +ServiceName + + +InputName +Playground area + +unknown-105.99836,31.393818 -106.212753,31.478128 -106.383041,31.733763 -106.538971,31.786198 -106.614441,31.817728 -106.615578,31.844635 -106.643532,31.895102 -106.633202,31.913998 -106.632057,31.972118 -106.649513,31.980228 -106.623077,32.000988 -106.377846,32.000645 -106.002708,32.001553 -104.921799,32.004269 -104.850563,32.003151 -104.018814,32.007278 -103.980896,32.00589 -103.728973,32.006104 -103.332092,32.004154 -103.057968,32.0019 -103.055191,32.084995 -103.059547,32.51543 -103.048836,32.953533 -103.042603,33.377728 -103.038239,33.565742 -103.032761,33.826088 -103.029144,34.307743 -103.022156,34.745266 -103.02475,34.964718 -103.02565,35.177208 -103.021797,35.623604 -103.022118,35.742287 -103.02356,36.056026 -103.026802,36.491566 -102.996918,36.492344 -102.165222,36.490208 -102.03421,36.492954 -101.620316,36.492004 -101.089668,36.488022 -100.956909,36.489609 -100.549416,36.489449 -100.006866,36.493877 -100.001144,36.492519 -99.997154,36.057549 -99.997726,35.883793 -100,35.618809 -99.994354,35.424572 -99.997185,35.182182 -99.996071,35.030998 -99.998878,34.747185 -99.996094,34.562321 -99.972099,34.561863 -99.94474,34.579571 -99.931908,34.579109 -99.8806,34.548176 -99.860573,34.518627 -99.829933,34.501778 -99.777687,34.443993 -99.684906,34.377445 -99.601448,34.368557 -99.58522,34.384857 -99.57785,34.408913 -99.553864,34.41518 -99.502136,34.404068 -99.479439,34.383522 -99.438377,34.364704 -99.409958,34.369106 -99.394157,34.396744 -99.392792,34.428993 -99.364204,34.450195 -99.323296,34.412708 -99.267174,34.398285 -99.254105,34.368214 -99.20549,34.331993 -99.196304,34.305122 -99.204597,34.255646 -99.190483,34.223736 -99.176155,34.21273 -99.127945,34.201469 -99.07843,34.208359 -99.035217,34.198921 -98.996193,34.209496 -98.952507,34.194565 -98.891342,34.16082 -98.811066,34.145935 -98.778534,34.131962 -98.705292,34.130714 -98.682213,34.149998 -98.66172,34.147038 -98.625992,34.158436 -98.607246,34.151398 -98.576332,34.14193 -98.557579,34.105335 -98.499519,34.066414 -98.448189,34.054375 -98.421341,34.06583 -98.407135,34.082455 -98.390953,34.087231 -98.384254,34.11578 -98.350403,34.14212 -98.320488,34.13942 -98.277,34.122871 -98.172844,34.115368 -98.136864,34.138432 -98.114868,34.148987 -98.094124,34.134556 -98.110687,34.06982 -98.086205,34.005314 -98.055557,33.989799 -98.023491,33.986984 -97.982681,34.001286 -97.950226,33.971161 -97.947754,33.959751 -97.962997,33.94865 -97.950684,33.932518 -97.976128,33.912052 -97.976379,33.902504 -97.954735,33.88348 -97.909065,33.874023 -97.869751,33.855114 -97.852547,33.857071 -97.790207,33.890457 -97.756363,33.932098 -97.729019,33.939293 -97.704262,33.971546 -97.671066,33.988613 -97.600182,33.969437 -97.592354,33.917885 -97.575668,33.902531 -97.554588,33.903904 -97.518204,33.916771 -97.477531,33.907707 -97.462761,33.902382 -97.457062,33.89043 -97.452736,33.836212 -97.410118,33.820709 -97.363319,33.831024 -97.341805,33.861916 -97.314957,33.870392 -97.314087,33.89584 -97.272278,33.872574 -97.263908,33.85873 -97.250687,33.872971 -97.246063,33.894238 -97.211334,33.905689 -97.187767,33.899204 -97.164169,33.863148 -97.168594,33.847794 -97.195015,33.836159 -97.208321,33.819649 -97.189163,33.752769 -97.152473,33.728668 -97.115562,33.725933 -97.0905,33.73167 -97.083466,33.742413 -97.087669,33.807571 -97.050026,33.823448 -97.078247,33.837811 -97.082176,33.851101 -97.0709,33.856728 -97.025597,33.840561 -97.005852,33.850513 -96.987709,33.876423 -96.987862,33.944202 -96.968185,33.937321 -96.936203,33.947849 -96.929565,33.961773 -96.898453,33.950027 -96.882851,33.924591 -96.878937,33.884003 -96.861015,33.861679 -96.844009,33.858032 -96.814117,33.871769 -96.797592,33.869949 -96.748825,33.831738 -96.711678,33.83387 -96.693382,33.847904 -96.677704,33.904324 -96.666237,33.913544 -96.584488,33.896145 -96.614166,33.8629 -96.601196,33.842957 -96.562134,33.82542 -96.510574,33.815685 -96.500748,33.78809 -96.487373,33.77813 -96.419464,33.788326 -96.370819,33.740395 -96.347588,33.705528 -96.316277,33.701801 -96.300789,33.71405 -96.28968,33.761932 -96.278076,33.773388 -96.212547,33.756691 -96.187027,33.758583 -96.168816,33.769356 -96.161316,33.798229 -96.141418,33.82032 -96.154518,33.823944 -96.180725,33.808434 -96.183128,33.815792 -96.169205,33.828983 -96.148964,33.83559 -96.109444,33.829258 -96.091522,33.844578 -96.047974,33.841278 -96.026749,33.856022 -96.014069,33.844208 -96.001793,33.856979 -96.002617,33.87339 -95.994209,33.875378 -95.977394,33.857952 -95.958763,33.86504 -95.943069,33.889973 -95.933075,33.89053 -95.846558,33.841038 -95.825974,33.843025 -95.795479,33.864674 -95.768517,33.851402 -95.764252,33.879005 -95.760696,33.89344 -95.746864,33.903397 -95.699707,33.894825 -95.633492,33.920105 -95.612984,33.920238 -95.61483,33.936691 -95.606071,33.944553 -95.562775,33.936073 -95.546318,33.904034 -95.519577,33.906643 -95.526733,33.897816 -95.547493,33.893158 -95.544037,33.885742 -95.512886,33.897736 -95.498856,33.881718 -95.468124,33.886433 -95.451607,33.865753 -95.33004,33.870918 -95.336227,33.897114 -95.301956,33.886623 -95.28643,33.886902 -95.277351,33.917938 -95.263618,33.8978 -95.250992,33.905022 -95.251289,33.936443 -95.234039,33.964863 -95.148315,33.943546 -95.127968,33.940868 -95.126678,33.917145 -95.119225,33.912281 -95.09536,33.921738 -95.082268,33.918453 -95.089714,33.896915 -95.083603,33.888462 -95.063477,33.917648 -95.063141,33.896694 -95.042862,33.884445 -95.037361,33.866451 -95.012772,33.869946 -94.989281,33.856182 -94.968704,33.866215 -94.959908,33.848076 -94.939888,33.840824 -94.940399,33.815807 -94.918236,33.816196 -94.908546,33.803478 -94.913879,33.789597 -94.881638,33.774963 -94.85788,33.749321 -94.81916,33.749405 -94.803223,33.739582 -94.783508,33.753262 -94.764175,33.752842 -94.782028,33.742268 -94.783157,33.733665 -94.749771,33.736706 -94.762718,33.716797 -94.742111,33.719048 -94.754478,33.707771 -94.741653,33.701267 -94.690987,33.690289 -94.668457,33.696537 -94.655479,33.692291 -94.644325,33.67765 -94.667953,33.671459 -94.669426,33.666061 -94.658539,33.663738 -94.638763,33.670105 -94.631737,33.683899 -94.600945,33.665607 -94.585106,33.678982 -94.578506,33.670471 -94.560722,33.671913 -94.565208,33.663013 -94.585159,33.662132 -94.588387,33.655449 -94.576462,33.652157 -94.545418,33.661621 -94.541931,33.648247 -94.562195,33.64283 -94.562149,33.635536 -94.550194,33.632694 -94.51799,33.643009 -94.525055,33.621021 -94.510559,33.63081 -94.50061,33.623047 -94.476486,33.631966 -94.435913,33.636444 -94.436333,33.616844 -94.451553,33.604347 -94.443329,33.596504 -94.428467,33.597141 -94.40657,33.573486 -94.393417,33.574959 -94.379112,33.593327 -94.370628,33.590042 -94.372307,33.572662 -94.395264,33.560303 -94.370758,33.547684 -94.328751,33.573135 -94.302383,33.556934 -94.29882,33.579853 -94.278984,33.589333 -94.272079,33.584606 -94.274544,33.561737 -94.237236,33.592422 -94.223038,33.58572 -94.235367,33.561535 -94.210884,33.557987 -94.205345,33.585079 -94.159515,33.593773 -94.155167,33.567085 -94.098701,33.572998 -94.086655,33.583954 -94.061432,33.577213 -94.035927,33.555912 -94.036507,33.270325 -94.03875,33.023289 -94.041603,32.882347 -94.040199,32.694813 -94.035233,32.389225 -94.034767,32.199448 -94.035065,31.994513 -94.009888,31.989134 -94.004395,31.977942 -93.977211,31.946159 -93.969986,31.923164 -93.93573,31.909456 -93.917923,31.909702 -93.923462,31.892593 -93.899261,31.894455 -93.892525,31.870066 -93.881264,31.87142 -93.877403,31.850113 -93.864822,31.817272 -93.834328,31.802017 -93.822067,31.774637 -93.831161,31.753281 -93.80999,31.730352 -93.814949,31.712351 -93.808769,31.707565 -93.792267,31.711395 -93.811844,31.674566 -93.806427,31.653767 -93.814728,31.647966 -93.819588,31.618092 -93.835579,31.615189 -93.832619,31.590183 -93.816322,31.57711 -93.810516,31.559063 -93.780128,31.533735 -93.763306,31.530724 -93.747543,31.537718 -93.731659,31.521877 -93.705795,31.520569 -93.718994,31.495403 -93.750435,31.490557 -93.751244,31.4855 -93.726784,31.459475 -93.698418,31.461458 -93.701927,31.446251 -93.687004,31.438131 -93.696129,31.427736 -93.694443,31.415922 -93.687492,31.40613 -93.664017,31.398329 -93.661072,31.372395 -93.634857,31.373827 -93.67704,31.328386 -93.681587,31.312679 -93.656128,31.286671 -93.645592,31.290262 -93.630829,31.273903 -93.616455,31.275805 -93.611877,31.270033 -93.611,31.242188 -93.590546,31.229687 -93.602921,31.199066 -93.593941,31.180199 -93.576942,31.17214 -93.550591,31.190929 -93.528923,31.185774 -93.526932,31.178076 -93.537018,31.17634 -93.528328,31.162943 -93.544189,31.159166 -93.537506,31.132441 -93.528091,31.125925 -93.535088,31.116072 -93.556679,31.109343 -93.559982,31.100536 -93.543121,31.094751 -93.544106,31.082373 -93.516998,31.074671 -93.525742,31.05698 -93.507217,31.038908 -93.547119,31.014141 -93.564941,31.018063 -93.567894,31.012924 -93.570847,30.997271 -93.560951,30.99169 -93.572456,30.976177 -93.548676,30.97019 -93.537338,30.956884 -93.532188,30.960732 -93.52562,30.93582 -93.529984,30.926971 -93.549622,30.924885 -93.546516,30.905334 -93.564476,30.901932 -93.568497,30.886234 -93.560844,30.87188 -93.552803,30.860283 -93.566444,30.845148 -93.555641,30.842342 -93.550682,30.828344 -93.581871,30.80204 -93.585175,30.772184 -93.618454,30.745789 -93.607651,30.73201 -93.61779,30.732548 -93.612411,30.710329 -93.617607,30.686802 -93.659988,30.672859 -93.677971,30.639692 -93.692879,30.640041 -93.684586,30.623425 -93.692696,30.615795 -93.671585,30.597832 -93.69342,30.598835 -93.717812,30.587379 -93.71788,30.568153 -93.735306,30.545517 -93.70546,30.522858 -93.714638,30.505114 -93.707275,30.496241 -93.714851,30.488628 -93.697975,30.470047 -93.703423,30.462513 -93.696571,30.442633 -93.721535,30.43298 -93.742561,30.408823 -93.754944,30.381788 -93.747833,30.367411 -93.759338,30.354145 -93.759178,30.340872 -93.729774,30.304916 -93.699211,30.297388 -93.707359,30.239372 -93.714844,30.220306 -93.704361,30.180861 -93.696167,30.175676 -93.699661,30.150808 -93.683144,30.148232 -93.685959,30.141253 -93.698639,30.141226 -93.696922,30.117929 -93.708382,30.11474 -93.715858,30.095669 -93.712479,30.06052 -93.760201,30.005964 -93.857277,29.990654 -93.856331,29.964602 -93.951767,29.818363 -93.834961,29.67457 -94.065407,29.674076 -94.356995,29.5599 -94.377007,29.55197 -94.682518,29.432905 -94.766548,29.363993 -94.785248,29.383261 -94.681915,29.475111 -94.572693,29.533052 -94.501282,29.517523 -94.469795,29.55678 -94.510811,29.545147 -94.533699,29.553984 -94.564438,29.578999 -94.788086,29.538557 -94.706421,29.658516 -94.700279,29.754568 -94.735725,29.792986 -94.829414,29.759857 -94.887161,29.668539 -94.932587,29.682209 -95.088264,29.80398 -95.040398,29.711578 -94.989334,29.679701 -95.014122,29.559265 -94.911156,29.500334 -94.982811,29.460527 -94.943756,29.464682 -94.952507,29.424234 -94.913445,29.420113 -94.916992,29.447823 -94.891136,29.399324 -94.815353,29.370932 -94.891472,29.393831 -94.898788,29.308775 -94.951134,29.325922 -95.066368,29.195877 -95.160522,29.200031 -95.16478,29.117548 -95.197342,29.105223 -95.248405,28.978392 -95.526581,28.803242 -95.683029,28.726954 -95.671318,28.752682 -95.786354,28.738871 -95.937309,28.690454 -95.956146,28.622673 -95.702148,28.718987 -96.206581,28.488386 -95.991646,28.596424 -95.983749,28.653133 -96.237587,28.571321 -96.239029,28.597116 -96.157471,28.611231 -96.240456,28.634859 -96.151062,28.762672 -96.212173,28.68672 -96.285973,28.661724 -96.270378,28.708981 -96.326157,28.634089 -96.364159,28.617981 -96.391777,28.670252 -96.392731,28.726028 -96.427086,28.712013 -96.449677,28.755035 -96.432259,28.697248 -96.403397,28.719494 -96.418785,28.638664 -96.375397,28.610088 -96.491203,28.556944 -96.437157,28.596991 -96.454384,28.655933 -96.483269,28.598055 -96.511894,28.608181 -96.511734,28.649542 -96.570396,28.636267 -96.570557,28.691841 -96.572212,28.808174 -96.576485,28.690689 -96.591499,28.71736 -96.646515,28.714142 -96.660011,28.679075 -96.606705,28.623634 -96.610344,28.558941 -96.566704,28.574099 -96.48658,28.506222 -96.563194,28.469627 -96.518501,28.460827 -96.476501,28.499454 -96.390724,28.434059 -96.661308,28.306263 -96.702362,28.340197 -96.703812,28.395885 -96.740768,28.403458 -96.787094,28.477507 -96.823875,28.44964 -96.788338,28.446255 -96.759102,28.410912 -96.77536,28.39163 -96.853493,28.404997 -96.788231,28.35247 -96.78627,28.312859 -96.793335,28.271372 -96.777931,28.229349 -96.803688,28.211447 -96.950905,28.114355 -96.91272,28.256798 -96.975304,28.210751 -96.941071,28.186771 -96.975105,28.115046 -97.033615,28.137398 -97.023567,28.199797 -97.131836,28.130426 -97.135414,28.16181 -97.167992,28.15946 -97.157059,28.116381 -97.260284,28.064724 -97.241234,28.048653 -97.270294,28.025932 -97.236214,28.04052 -97.123077,28.054266 -97.026405,28.10775 -97.023804,28.020237 -97.114624,27.915386 -97.195465,27.81222 -97.247025,27.822319 -97.213341,27.83111 -97.283485,27.871145 -97.361046,27.839954 -97.345619,27.873178 -97.479355,27.852962 -97.496681,27.875469 -97.521698,27.863626 -97.499535,27.843243 -97.479813,27.820282 -97.388542,27.831427 -97.396561,27.77084 -97.317795,27.712225 -97.34951,27.715328 -97.320015,27.690634 -97.353363,27.6408 -97.399216,27.633186 -97.347504,27.631439 -97.309212,27.707863 -97.249794,27.688831 -97.331459,27.562321 -97.412262,27.321024 -97.500435,27.319668 -97.507538,27.439215 -97.528381,27.344101 -97.600113,27.300135 -97.750076,27.419666 -97.680008,27.294373 -97.784744,27.28772 -97.548157,27.230207 -97.427216,27.265133 -97.503502,27.081541 -97.478996,26.996508 -97.568565,26.977858 -97.558052,26.846052 -97.495575,26.793781 -97.451698,26.600985 -97.425858,26.518225 -97.474709,26.476805 -97.421188,26.385059 -97.368698,26.35906 -97.353363,26.182449 -97.25312,26.068316 -97.276321,26.002275 -97.213097,26.009068 -97.172226,25.954569 -97.307144,25.965124 -97.304436,25.938663 -97.380989,25.917021 -97.385643,25.845362 -97.434349,25.845198 -97.590088,25.933231 -97.574936,25.954172 -97.612923,25.962002 -97.647972,26.023445 -97.867432,26.060141 -98.04007,26.059395 -98.076347,26.034626 -98.083214,26.065758 -98.200691,26.055376 -98.291946,26.098104 -98.271355,26.120895 -98.292274,26.132809 -98.327934,26.111647 -98.347191,26.15868 -98.384521,26.156031 -98.453392,26.220911 -98.488518,26.201544 -98.599968,26.260454 -98.677917,26.242056 -98.819832,26.375071 -98.908897,26.360329 -98.93927,26.395309 -99.106728,26.419531 -99.101471,26.48834 -99.168678,26.545729 -99.165817,26.579889 -99.285522,26.857361 -99.390518,26.94663 -99.392715,26.99555 -99.455063,27.028648 -99.437157,27.199198 -99.465271,27.269884 -99.543587,27.318653 -99.490494,27.490755 -99.526741,27.504284 -99.549187,27.612627 -99.714493,27.661558 -99.815727,27.780107 -99.874733,27.797686 -99.941856,27.986881 -99.993309,28.00346 -100.096924,28.154282 -100.214073,28.201935 -100.223465,28.241457 -100.29792,28.280354 -100.292892,28.32036 -100.35157,28.394182 -100.37677,28.478651 -100.345802,28.500811 -100.419533,28.544191 -100.403175,28.589733 -100.49791,28.660988 -100.58979,28.894222 -100.647224,28.92235 -100.66877,29.080072 -100.768608,29.166571 -100.796989,29.242502 -101.009056,29.373255 -101.06736,29.473553 -101.261429,29.526474 -101.254585,29.62875 -101.308929,29.58091 -101.305862,29.652431 -101.368401,29.657162 -101.4161,29.745434 -101.401276,29.769905 -101.448425,29.760586 -101.470467,29.788691 -101.538345,29.763018 -101.543953,29.81012 -101.58149,29.76515 -101.639671,29.75696 -101.759094,29.787167 -101.805206,29.779999 -101.819099,29.814125 -101.924225,29.788502 -101.97332,29.818773 -102.063995,29.784571 -102.324333,29.880116 -102.367561,29.845289 -102.384796,29.767946 -102.503098,29.785456 -102.551949,29.7495 -102.5765,29.778248 -102.637611,29.732338 -102.676361,29.744225 -102.804726,29.530146 -102.822205,29.411844 -102.883011,29.353371 -102.908325,29.269203 -102.866173,29.229036 -102.988098,29.190863 -103.153465,28.978682 -103.266586,29.007454 -103.28035,28.986374 -103.335518,29.050339 -103.37545,29.032108 -103.474075,29.072134 -103.526237,29.146646 -103.720314,29.190632 -103.739853,29.230349 -103.782158,29.229795 -103.767761,29.28124 -103.786995,29.26726 -104.045631,29.328119 -104.164383,29.400715 -104.204735,29.484041 -104.377594,29.550611 -104.535248,29.679466 -104.57756,29.807936 -104.67437,29.909283 -104.696495,30.057302 -104.674759,30.148964 -104.702614,30.238489 -104.813957,30.35047 -104.806473,30.376448 -104.852997,30.392263 -104.890678,30.570557 -104.986931,30.641325 -104.997543,30.684334 -105.060562,30.68787 -105.21434,30.812086 -105.258186,30.797653 -105.287598,30.831949 -105.313782,30.816507 -105.390312,30.853081 -105.409065,30.90251 -105.554382,30.998285 -105.603218,31.086428 -105.76973,31.17078 -105.99836,31.393818-94.913429,29.257572 -94.76738,29.342451 -94.748405,29.31949 -95.105415,29.096958 -94.913429,29.257572-96.397881,28.345846 -96.834625,28.066322 -96.803841,28.172161 -96.738907,28.183535 -96.532135,28.318245 -96.463051,28.325832 -96.422554,28.391439 -96.397881,28.345846-96.939964,28.045933 -96.872421,28.131405 -96.837425,28.101841 -96.853806,28.049402 -97.049606,27.840954 -97.024429,27.914381 -96.949387,27.984526 -96.973,28.000853 -96.939964,28.045933-97.359116,27.283718 -97.379379,27.210453 -97.376091,27.284643 -97.335503,27.440819 -97.248672,27.581133 -97.258682,27.651749 -97.203583,27.612064 -97.170181,27.70746 -97.075294,27.811274 -97.113037,27.819216 -97.053566,27.830473 -97.223717,27.574007 -97.359116,27.283718-97.301132,26.601023 -97.358025,26.706646 -97.381332,26.820375 -97.395309,26.921988 -97.400909,27.111227 -97.388786,27.201651 -97.378532,27.204449 -97.386925,27.097244 -97.381332,26.949022 -97.358025,26.802664 -97.295837,26.60067 -97.232109,26.418142 -97.194992,26.259241 -97.171799,26.077721 -97.179337,26.07192 -97.208916,26.250542 -97.226311,26.348551 -97.251251,26.419304 -97.26725,26.478905 -97.278549,26.539963 -97.301132,26.601023Texas48W S CenTX688219.0717337.5491.712202E74377106.06115966.08433346.000000018688674.06192585.05860490.01142908.0168814.07687338.0590269.02139266.01042397.00.4930.5072487642.0 + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/ijson_o.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/ijson_o.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/ijson_o.xml (revision 672) @@ -0,0 +1,19 @@ + +ServiceName + + +InputPolygon +Playground area + +{"type":"Polygon","coordinates":[[[-102.036758,36.988972],[-106.860657,36.989491],[-109.047821,36.996643],[-109.055199,38.24493],[-109.052864,39.518196],[-109.050591,40.210545],[-109.047638,40.998474],[-107.918037,41.00341],[-104.051201,41.003227],[-102.620789,41.000225],[-102.047279,40.998077],[-102.04557,40.697323],[-102.036758,36.988972]]]} + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_o.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_o.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_o.xml (revision 672) @@ -0,0 +1,17 @@ + +ServiceName + + +InputPolygon +Playground area + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_o_async.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_o_async.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_o_async.xml (revision 672) @@ -0,0 +1,17 @@ + +ServiceName + + +InputPolygon +Playground area + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_or.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_or.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_or.xml (revision 672) @@ -0,0 +1,17 @@ + +ServiceName + + +InputPolygon +Playground area + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_or_async.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_or_async.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/ir_or_async.xml (revision 672) @@ -0,0 +1,17 @@ + +ServiceName + + +InputPolygon +Playground area + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_o.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_o.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_o.xml (revision 672) @@ -0,0 +1,22 @@ + +ServiceName + + +InputPolygon +Playground area + + + +the_geom-98.417969 29.498046625-97.53906275 30.376952875 + + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_o_async.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_o_async.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_o_async.xml (revision 672) @@ -0,0 +1,22 @@ + +ServiceName + + +InputPolygon +Playground area + + + +the_geom-98.417969 29.498046625-97.53906275 30.376952875 + + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_or.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_or.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_or.xml (revision 672) @@ -0,0 +1,22 @@ + +ServiceName + + +InputPolygon +Playground area + + + +the_geom-98.417969 29.498046625-97.53906275 30.376952875 + + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_or_async.xml =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_or_async.xml (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/requests/irb_or_async.xml (revision 672) @@ -0,0 +1,22 @@ + +ServiceName + + +InputPolygon +Playground area + + + +the_geom-98.417969 29.498046625-97.53906275 30.376952875 + + + + + + + +Result + + + + Index: /branches/PublicaMundi_David_integration_01-devel/testing/run.sh =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/testing/run.sh (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/testing/run.sh (revision 672) @@ -0,0 +1,255 @@ +#!/bin/bash + +Usage=$(cat < + +where should be the url to a WPS Server, should +be the service name you want to run tests with (you can use multiple service +names, use quote and seperate them using space), should contain the +requests you want to use (you can use more than one at a time). + +For instance to test the Buffer service on a localhost WPS server, use the +following command: + + ./run.sh http://localhost/cgi-bin/zoo_loader.cgi Buffer "GetCapabilities DescribeProcess Execute" + +EOF +) + +if [ -z "$1" ] || [ -z "$2" ]; then + echo "$Usage" + exit +fi + +WPSInstance=$1 +ServiceName=$2 +NBRequests=1000 +NBConcurrents=50 +pstat=0 + +iter=0 + +function testPostRequests { +# +# Tests for Execute using POST requests +# + for i in $1; + do + cat requests/${i}.xml | sed "s:ServiceName:${ServiceName}:g;s:InputName:$(cat tmp/inputName.txt):g" > tmp/${i}1.xml + if [ -z "$(echo $i | grep async)" ]; then + postRequest "${WPSInstance}" "tmp/outputE${i}.xml" "Execute" "tmp/${i}1.xml" + else + postRequest "${WPSInstance}" "tmp/outputE${i}.xml" "Execute" "tmp/${i}1.xml" "async" + fi + echo "" + done + +} + +function plotStat { + echo " **" + echo " * Plot statistics ..." + echo " **" + cp run.tsv tmp/run$1.tsv + sed "s:\[image\]:$2:g;s:\[file\]:$3:g" -i tmp/run$1.tsv + gnuplot tmp/run$1.tsv + cp run1.tsv tmp/run1$1.tsv + sed "s:\[image\]:$(echo $2 | sed "s:.jpg:1.jpg:g"):g;s:\[file\]:$3:g" -i tmp/run1$1.tsv + gnuplot tmp/run1$1.tsv +} + + +function kvpRequest { + echo " **" + echo "

      Simple KVP request start on $(date)

      " + echo " $1" + + RESP=$(curl -v -o "$2" "$1" 2> tmp/temp.log; grep "< HTTP" tmp/temp.log | cut -d' ' -f3) + if [ "${3}" == "owsExceptionReport" ]; then + echo " *********************************" + if [ "$RESP" == "200" ]; then + echo " ! Invalid response code ($RESP)" + else + echo " * Valid response code ($RESP)" + fi + echo " *********************************" + echo " * Checking for ${3} response XML validity..." + echo " * Schema: [http://schemas.opengis.net/ows/1.1.0/${3}.xsd]" + echo " *********************************" + xmllint --noout --schema http://schemas.opengis.net/ows/1.1.0/${3}.xsd "$2" 2> tmp/res${iter}.txt + echo " *********************************" + echo "Verifying that the missing / wrong argument was referenced in locator and the exceptionCode take the corresponding value ..." + echo -n " *********************************" + xsltproc ./extractExceptionInfo.xsl "$2" + echo " *********************************" + else + if [ "$RESP" == "200" ]; then + echo " * Valid response code ($RESP)" + else + echo " ! Invalid response code ($RESP)" + fi + echo " * Checking for ${3} response XML validity..." + echo " * Schema: [http://schemas.opengis.net/wps/1.0.0/wps${3}_response.xsd]" + xmllint --noout --schema http://schemas.opengis.net/wps/1.0.0/wps${3}_response.xsd "$2" 2> tmp/res${iter}.txt + v="$(cat tmp/res${iter}.txt | grep validates)" + echo "" + fi + echo " **" + echo " * Sending $NBRequests ${3} requests starting on $(date) ..." + echo " **" + ab -g tmp/stat${3}${iter}.plot -e tmp/stat${3}${iter}.txt -n "$NBRequests" -c "$NBConcurrents" "$1" + if [ "$pstat" -eq 1 ]; then + plotStat ${iter} tmp/stat${3}${iter}.jpg tmp/stat${3}${iter}.plot + fi + iter=$(expr $iter + 1) + echo " ** Ending on $(date)" +} + +function postRequest { + echo " **" + echo " * Simple POST request started on $(date)" + echo " **" + echo " * Checking for ${3} request XML validity..." + echo " * Schema: http://schemas.opengis.net/wps/1.0.0/wps${3}_request.xsd" + echo " *********************************" + xmllint --noout --schema http://schemas.opengis.net/wps/1.0.0/wps${3}_request.xsd "$4" + echo " *********************************" + curl -H "Content-type: text/xml" -d@"$4" -o "$2" "$1" + echo " * Checking for ${3} response XML validity on $(date) ..." + echo " * Schema: http://schemas.opengis.net/wps/1.0.0/wps${3}_response.xsd" + echo " *********************************" + xmllint --noout --schema http://schemas.opengis.net/wps/1.0.0/wps${3}_response.xsd "$2" + echo " *********************************" + if [ -z "$5" ]; then + echo "" + else + echo " * Schema: http://schemas.opengis.net/wps/1.0.0/wps${3}_response.xsd" + echo " *********************************" + xmllint --noout --schema http://schemas.opengis.net/wps/1.0.0/wps${3}_response.xsd "$(xsltproc ./extractStatusLocation.xsl $2)" + echo " *********************************" + fi + echo " * Sending $NBRequests ${3} XML requests on $(date) ..." + ab -g tmp/stat${3}${iter}.plot -e tmp/stat${3}${iter}.txt -T "text/xml" -p "$4" -n "$NBRequests" -c "$NBConcurrents" "$1" + if [ "$pstat" -eq 1 ]; then + plotStat ${iter} tmp/stat${3}${iter}.jpg tmp/stat${3}${iter}.plot + fi + iter=$(expr $iter + 1) + echo " ** Ending on $(date)" +} + +function kvpRequestWrite { + suffix="" + cnt=0 + cnt0=0 + for i in $2; do + if [ ! $1 -eq $cnt0 ]; then + if [ $cnt -gt 0 ]; then + suffix="$suffix&$(echo $i | sed 's:\"::g')" + else + suffix="$(echo $i | sed 's:\"::g')" + fi + cnt=$(expr $cnt + 1) + fi + cnt0=$(expr $cnt0 + 1) + done + echo $suffix +} + +function kvpWrongRequestWrite { + suffix="" + cnt=0 + cnt0=0 + for i in $2; do + if [ ! $1 -eq $cnt0 ]; then + if [ $cnt -gt 0 ]; then + suffix="$suffix&$(echo $i | sed 's:\"::g')" + else + suffix="$(echo $i | sed 's:\"::g')" + fi + cnt=$(expr $cnt + 1) + else + cnt1=0 + for j in $3; do + if [ $cnt1 -eq $1 ]; then + suffix="$suffix&$(echo $j | sed 's:\"::g')" + fi + cnt1=$(expr $cnt1 + 1) + done + fi + cnt0=$(expr $cnt0 + 1) + done + echo $suffix +} + +for i in $3; do + if [ "$i" == "GetCapabilities" ]; then +# +# Tests for GetCapabilities using KVP (including wrong requests) and POST requests +# + kvpRequest "${WPSInstance}?REQUEST=GetCapabilities&SERVICE=WPS" "tmp/outputGC1.xml" "GetCapabilities" + + params='"request=GetCapabilities" "service=WPS"' + + suffix=$(kvpRequestWrite -1 "$params") + kvpRequest "${WPSInstance}?$suffix" "tmp/outputGC2.xml" "GetCapabilities" + + for j in 0 1; do + suffix=$(kvpRequestWrite $j "$params") + kvpRequest "${WPSInstance}?$suffix" "tmp/outputGC$(expr $j + 3).xml" "owsExceptionReport" + done + + paramsw='"request=GetCapabilitie" "service=WXS"' + for j in 0 1; do + suffix=$(kvpWrongRequestWrite $j "$params" "$paramsw") + kvpRequest "${WPSInstance}?$suffix" "tmp/outputGC$(expr $j + 5).xml" "owsExceptionReport" + done + + echo "Check if differences between upper case and lower case parameter names" + diff -ru tmp/outputGC1.xml tmp/outputGC2.xml + + echo "" + + curl -o tmp/10_wpsGetCapabilities_request.xml http://schemas.opengis.net/wps/1.0.0/examples/10_wpsGetCapabilities_request.xml + postRequest "${WPSInstance}" "tmp/outputGCp.xml" "GetCapabilities" "tmp/10_wpsGetCapabilities_request.xml" + echo "" + fi + if [ "$i" == "DescribeProcess" ]; then +# +# Tests for DescribeProcess using KVP and POST requests +# + kvpRequest "${WPSInstance}?request=DescribeProcess&service=WPS&version=1.0.0&Identifier=ALL" "tmp/outputDPall.xml" "DescribeProcess" + + params='"request=DescribeProcess" "service=WPS" "version=1.0.0" "Identifier='${ServiceName}'"' + + suffix=$(kvpRequestWrite -1 "$params") + kvpRequest "${WPSInstance}?$suffix" "tmp/outputDPb1.xml" "DescribeProcess" + + for j in 0 1 2 3; do + suffix=$(kvpRequestWrite $j "$params") + kvpRequest "${WPSInstance}?$suffix" "tmp/outputDPb$(expr $j + 2).xml" "owsExceptionReport" + done + + paramsw='"request=DescribeProces" "service=WXS" "version=1.2.0" "Identifier=Undefined"' + + for j in 0 1 2 3; do + suffix=$(kvpWrongRequestWrite $j "$params") + kvpRequest "${WPSInstance}?$suffix" "tmp/outputDPb$(expr $j + 6).xml" "owsExceptionReport" + done + + + cat requests/dp.xml | sed "s:ServiceName:${ServiceName}:g" > tmp/dp1.xml + postRequest "${WPSInstance}" "tmp/outputDPp.xml" "DescribeProcess" "tmp/dp1.xml" + xsltproc extractInputs.xsl tmp/outputDPp.xml > tmp/inputName.txt + echo "" + fi + if [ "$i" == "ExecuteSync" ]; then + testPostRequests "ijson_o igml_o ir_o ir_or irb_o irb_or" + echo "" + fi + if [ "$i" == "ExecuteAsync" ]; then + testPostRequests "ir_o_async ir_or_async irb_o_async irb_or_async" + echo "" + fi +done Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/Makefile =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/Makefile (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/Makefile (revision 672) @@ -0,0 +1,41 @@ +OS:=$(shell uname -s) +CPU:=$(shell uname -m) +ifeq ($(OS),Darwin) + MACOS_CFLAGS=-arch x86_64 + LIBS= -L./ -lcgic /usr/lib/libfcgi.dylib +else +ifeq ($(CPU),x86_64) + LIBS= -L./ -lcgic /usr/lib64/libfcgi.so +else + LIBS= -L./ -lcgic /usr/lib/libfcgi.a +endif +endif +CFLAGS=-g -Wall ${MACOS_CFLAGS} +CC=gcc +AR=ar +RANLIB=ranlib + +all: libcgic.a cgictest.cgi capture + +install: libcgic.a + mkdir -p ../../dist/lib + cp libcgic.a ../../dist/lib + cp cgic.h ../../dist/include + @echo libcgic.a is in ../../dist/lib/ and cgic.h is in ../../dist/include/ + +libcgic.a: cgic.o cgic.h + rm -f libcgic.a + $(AR) rc libcgic.a cgic.o + $(RANLIB) libcgic.a + +#mingw32 and cygwin users: replace .cgi with .exe + +cgictest.cgi: cgictest.o libcgic.a + gcc cgictest.o -o cgictest.cgi ${LIBS} + +capture: capture.o libcgic.a + gcc capture.o -o capture ${LIBS} + +clean: + rm -f *.o *.a cgictest.cgi capture + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/capture.c =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/capture.c (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/capture.c (revision 672) @@ -0,0 +1,12 @@ +#include "cgic.h" + +int cgiMain() { + cgiWriteEnvironment("/tmp/capcgi.dat"); + cgiHeaderContentType("text/html"); + fprintf(cgiOut, "Captured\n"); + fprintf(cgiOut, "

      Captured

      \n"); + fprintf(cgiOut, "Your form submission was captured for use in\n"); + fprintf(cgiOut, "debugging CGI code.\n"); + return 0; +} + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.c =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.c (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.c (revision 672) @@ -0,0 +1,2556 @@ +/* cgicTempDir is the only setting you are likely to need + to change in this file. */ + +/* Used only in Unix environments, in conjunction with mkstemp(). + Elsewhere (Windows), temporary files go where the tmpnam() + function suggests. If this behavior does not work for you, + modify the getTempFileName() function to suit your needs. */ + +#define cgicTempDir "/tmp" + +#include +#if CGICDEBUG +#define CGICDEBUGSTART \ + { \ + FILE *dout; \ + dout = fopen("/home/boutell/public_html/debug", "a"); \ + +#define CGICDEBUGEND \ + fclose(dout); \ + } +#else /* CGICDEBUG */ +#define CGICDEBUGSTART +#define CGICDEBUGEND +#endif /* CGICDEBUG */ + +#ifdef WIN32 +#define _INC_STDIO +#endif + +#include +#include +#include +#include +#include +#include +#include + +#ifdef WIN32 +#include + +/* cgic 2.01 */ +#include + +#else +#include +#endif /* WIN32 */ +#include "cgic.h" + +#define cgiStrEq(a, b) (!strcmp((a), (b))) + +char *cgiServerSoftware; +char *cgiServerName; +char *cgiGatewayInterface; +char *cgiServerProtocol; +char *cgiServerPort; +char *cgiRequestMethod; +char *cgiPathInfo; +char *cgiPathTranslated; +char *cgiScriptName; +char *cgiQueryString; +char *cgiRemoteHost; +char *cgiRemoteAddr; +char *cgiAuthType; +char *cgiRemoteUser; +char *cgiRemoteIdent; +char cgiContentTypeData[1024]; +char *cgiContentType = cgiContentTypeData; +char *cgiMultipartBoundary; +char *cgiCookie; +int cgiContentLength; +char *cgiAccept; +char *cgiUserAgent; +char *cgiReferrer; +char *cgiSid; + +FILE *cgiIn; +FILE *cgiOut; + +/* True if CGI environment was restored from a file. */ +static int cgiRestored = 0; +static int cgiTreatUrlEncoding; + +static void cgiGetenv(char **s, char *var); + +typedef enum { + cgiParseSuccess, + cgiParseMemory, + cgiParseIO +} cgiParseResultType; + +/* One form entry, consisting of an attribute-value pair, + and an optional filename and content type. All of + these are guaranteed to be valid null-terminated strings, + which will be of length zero in the event that the + field is not present, with the exception of tfileName + which will be null when 'in' is null. DO NOT MODIFY THESE + VALUES. Make local copies if modifications are desired. */ + +typedef struct cgiFormEntryStruct { + char *attr; + /* value is populated for regular form fields only. + For file uploads, it points to an empty string, and file + upload data should be read from the file tfileName. */ + char *value; + /* When fileName is not an empty string, tfileName is not null, + and 'value' points to an empty string. */ + /* Valid for both files and regular fields; does not include + terminating null of regular fields. */ + int valueLength; + char *fileName; + char *contentType; + /* Temporary file name for working storage of file uploads. */ + char *tfileName; + struct cgiFormEntryStruct *next; +} cgiFormEntry; + +/* The first form entry. */ +static cgiFormEntry *cgiFormEntryFirst; + +static cgiParseResultType cgiParseGetFormInput(); +static cgiParseResultType cgiParsePostFormInput(); +static cgiParseResultType cgiParsePostMultipartInput(); +static cgiParseResultType cgiParseFormInput(char *data, int length); +static void cgiSetupConstants(); +static void cgiFreeResources(); +static int cgiStrEqNc(char *s1, char *s2); +static int cgiStrBeginsNc(char *s1, char *s2); + +//int cgiMain_init() {} + + +int main(int argc, char *argv[]) { + int result; + char *cgiContentLengthString; + char *e; + while (FCGI_Accept() >= 0) { + cgiSetupConstants(); + cgiGetenv(&cgiServerSoftware, "SERVER_SOFTWARE"); + cgiGetenv(&cgiServerName, "SERVER_NAME"); + cgiGetenv(&cgiGatewayInterface, "GATEWAY_INTERFACE"); + cgiGetenv(&cgiServerProtocol, "SERVER_PROTOCOL"); + cgiGetenv(&cgiServerPort, "SERVER_PORT"); + cgiGetenv(&cgiRequestMethod, "REQUEST_METHOD"); + if(strcmp(cgiRequestMethod,"")==0 && argc>=1) + cgiRequestMethod="GET"; + cgiGetenv(&cgiPathInfo, "PATH_INFO"); + cgiGetenv(&cgiPathTranslated, "PATH_TRANSLATED"); + cgiGetenv(&cgiScriptName, "SCRIPT_NAME"); + cgiGetenv(&cgiQueryString, "QUERY_STRING"); + cgiSid=NULL; + if(cgiQueryString!=NULL && argc>=2){ + cgiQueryString=argv[1]; + if(argc>2){ + cgiSid=argv[2]; + } + } + cgiGetenv(&cgiRemoteHost, "REMOTE_HOST"); + cgiGetenv(&cgiRemoteAddr, "REMOTE_ADDR"); + cgiGetenv(&cgiAuthType, "AUTH_TYPE"); + cgiGetenv(&cgiRemoteUser, "REMOTE_USER"); + cgiGetenv(&cgiRemoteIdent, "REMOTE_IDENT"); + /* 2.0: the content type string needs to be parsed and modified, so + copy it to a buffer. */ + e = getenv("CONTENT_TYPE"); + if (e) { + if (strlen(e) < sizeof(cgiContentTypeData)) { + strcpy(cgiContentType, e); + } else { + /* Truncate safely in the event of what is almost certainly + a hack attempt */ + strncpy(cgiContentType, e, sizeof(cgiContentTypeData)); + cgiContentType[sizeof(cgiContentTypeData) - 1] = '\0'; + } + } else { + cgiContentType[0] = '\0'; + } + /* Never null */ + cgiMultipartBoundary = ""; + /* 2.0: parse semicolon-separated additional parameters of the + content type. The one we're interested in is 'boundary'. + We discard the rest to make cgiContentType more useful + to the typical programmer. */ + if (strchr(cgiContentType, ';')) { + char *sat = strchr(cgiContentType, ';'); + while (sat) { + *sat = '\0'; + sat++; + while (isspace(*sat)) { + sat++; + } + if (cgiStrBeginsNc(sat, "boundary=")) { + char *s; + cgiMultipartBoundary = sat + strlen("boundary="); + s = cgiMultipartBoundary; + while ((*s) && (!isspace(*s))) { + s++; + } + *s = '\0'; + break; + } else { + sat = strchr(sat, ';'); + } + } + } + cgiGetenv(&cgiContentLengthString, "CONTENT_LENGTH"); + cgiContentLength = atoi(cgiContentLengthString); + if(cgiContentLength==0 && argc>=2){ + cgiContentLength=strlen(argv[1]); + } + cgiGetenv(&cgiAccept, "HTTP_ACCEPT"); + cgiGetenv(&cgiUserAgent, "HTTP_USER_AGENT"); + cgiGetenv(&cgiReferrer, "HTTP_REFERER"); + cgiGetenv(&cgiCookie, "HTTP_COOKIE"); +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "%d\n", cgiContentLength); + fprintf(dout, "%s\n", cgiRequestMethod); + fprintf(dout, "%s\n", cgiContentType); + CGICDEBUGEND +#endif /* CGICDEBUG */ +#ifdef WIN32 + /* 1.07: Must set stdin and stdout to binary mode */ + /* 2.0: this is particularly crucial now and must not be removed */ + _setmode( FCGI_fileno( stdin ), _O_BINARY ); + _setmode( FCGI_fileno( stdout ), _O_BINARY ); +#endif /* WIN32 */ + cgiFormEntryFirst = 0; + cgiIn = FCGI_stdin; + cgiOut = FCGI_stdout; + cgiRestored = 0; + + + /* These five lines keep compilers from + producing warnings that argc and argv + are unused. They have no actual function. */ + if (argc) { + if (argv[0]) { + cgiRestored = 0; + } + } + + + cgiTreatUrlEncoding=0; + if (cgiStrEqNc(cgiRequestMethod, "post")) { + cgiTreatUrlEncoding=0; +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "POST recognized\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + if (cgiStrEqNc(cgiContentType, "application/x-www-form-urlencoded")) { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "Calling PostFormInput\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + if (cgiParsePostFormInput() != cgiParseSuccess) { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "PostFormInput failed\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + cgiFreeResources(); + return -1; + } +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "PostFormInput succeeded\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + } else if (cgiStrEqNc(cgiContentType, "multipart/form-data")) { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "Calling PostMultipartInput\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + if (cgiParsePostMultipartInput() != cgiParseSuccess) { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "PostMultipartInput failed\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + cgiFreeResources(); + return -1; + } +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "PostMultipartInput succeeded\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + } + } else if (cgiStrEqNc(cgiRequestMethod, "get")) { + /* The spec says this should be taken care of by + the server, but... it isn't */ + cgiContentLength = strlen(cgiQueryString); + if (cgiParseGetFormInput() != cgiParseSuccess) { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "GetFormInput failed\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + cgiFreeResources(); + return -1; + } else { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "GetFormInput succeeded\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + } + } + result = cgiMain(); + cgiFreeResources(); + } + FCGI_Finish(); + return result; +} + +static void cgiGetenv(char **s, char *var){ + *s = getenv(var); + if (!(*s)) { + *s = ""; + } +} + +static cgiParseResultType cgiParsePostFormInput() { + char *input; + cgiParseResultType result; + if (!cgiContentLength) { + return cgiParseSuccess; + } + input = (char *) malloc(cgiContentLength); + if (!input) { + return cgiParseMemory; + } + if (((int) fread(input, 1, cgiContentLength, cgiIn)) + != cgiContentLength) + { + return cgiParseIO; + } + result = cgiParseFormInput(input, cgiContentLength); + free(input); + return result; +} + +/* 2.0: A virtual datastream supporting putback of + enough characters to handle multipart boundaries easily. + A simple memset(&mp, 0, sizeof(mp)) is suitable initialization. */ + +typedef struct { + /* Buffer for putting characters back */ + char putback[1024]; + /* Position in putback from which next character will be read. + If readPos == writePos, then next character should + come from cgiIn. */ + int readPos; + /* Position in putback to which next character will be put back. + If writePos catches up to readPos, as opposed to the other + way around, the stream no longer functions properly. + Calling code must guarantee that no more than + sizeof(putback) bytes are put back at any given time. */ + int writePos; + /* Offset in the virtual datastream; can be compared + to cgiContentLength */ + int offset; +} mpStream, *mpStreamPtr; + +int mpRead(mpStreamPtr mpp, char *buffer, int len) +{ + int ilen = len; + int got = 0; + while (len) { + if (mpp->readPos != mpp->writePos) { + *buffer++ = mpp->putback[mpp->readPos++]; + mpp->readPos %= sizeof(mpp->putback); + got++; + len--; + } else { + break; + } + } + /* Refuse to read past the declared length in order to + avoid deadlock */ + if (len > (cgiContentLength - mpp->offset)) { + len = cgiContentLength - mpp->offset; + } + if (len) { + int fgot = fread(buffer, 1, len, cgiIn); + if (fgot >= 0) { + mpp->offset += (got + fgot); + return got + fgot; + } else if (got > 0) { + mpp->offset += got; + return got; + } else { + /* EOF or error */ + return fgot; + } + } else if (got) { + return got; + } else if (ilen) { + return EOF; + } else { + /* 2.01 */ + return 0; + } +} + +void mpPutBack(mpStreamPtr mpp, char *data, int len) +{ + mpp->offset -= len; + while (len) { + mpp->putback[mpp->writePos++] = *data++; + mpp->writePos %= sizeof(mpp->putback); + len--; + } +} + +/* This function copies the body to outf if it is not null, otherwise to + a newly allocated character buffer at *outP, which will be null + terminated; if both outf and outP are null the body is not stored. + If bodyLengthP is not null, the size of the body in bytes is stored + to *bodyLengthP, not including any terminating null added to *outP. + If 'first' is nonzero, a preceding newline is not expected before + the boundary. If 'first' is zero, a preceding newline is expected. + Upon return mpp is positioned after the boundary and its trailing + newline, if any; if the boundary is followed by -- the next two + characters read after this function returns will be --. Upon error, + if outP is not null, *outP is a null pointer; *bodyLengthP + is set to zero. Returns cgiParseSuccess, cgiParseMemory + or cgiParseIO. */ + +static cgiParseResultType afterNextBoundary(mpStreamPtr mpp, + FILE *outf, + char **outP, + int *bodyLengthP, + int first + ); + +static int readHeaderLine( + mpStreamPtr mpp, + char *attr, + int attrSpace, + char *value, + int valueSpace); + +static void decomposeValue(char *value, + char *mvalue, int mvalueSpace, + char **argNames, + char **argValues, + int argValueSpace); + +/* tfileName must be 1024 bytes to ensure adequacy on + win32 (1024 exceeds the maximum path length and + certainly exceeds observed behavior of _tmpnam). + May as well also be 1024 bytes on Unix, although actual + length is strlen(cgiTempDir) + a short unique pattern. */ + +static cgiParseResultType getTempFileName(char *tfileName); + +static cgiParseResultType cgiParsePostMultipartInput() { + cgiParseResultType result; + cgiFormEntry *n = 0, *l = 0; + int got; + FILE *outf = 0; + char *out = 0; + char tfileName[1024]; + mpStream mp; + mpStreamPtr mpp = ∓ + memset(&mp, 0, sizeof(mp)); + if (!cgiContentLength) { + return cgiParseSuccess; + } + /* Read first boundary, including trailing newline */ + result = afterNextBoundary(mpp, 0, 0, 0, 1); + if (result == cgiParseIO) { + /* An empty submission is not necessarily an error */ + return cgiParseSuccess; + } else if (result != cgiParseSuccess) { + return result; + } + while (1) { + char d[1024]; + char fvalue[1024]; + char fname[1024]; + int bodyLength = 0; + char ffileName[1024]; + char fcontentType[1024]; + char attr[1024]; + char value[1024]; + fvalue[0] = 0; + fname[0] = 0; + ffileName[0] = 0; + fcontentType[0] = 0; + out = 0; + outf = 0; + /* Check for EOF */ + got = mpRead(mpp, d, 2); + if (got < 2) { + /* Crude EOF */ + break; + } + if ((d[0] == '-') && (d[1] == '-')) { + /* Graceful EOF */ + break; + } + mpPutBack(mpp, d, 2); + /* Read header lines until end of header */ + while (readHeaderLine( + mpp, attr, sizeof(attr), value, sizeof(value))) + { + char *argNames[3]; + char *argValues[2]; + /* Content-Disposition: form-data; + name="test"; filename="googley.gif" */ + if (cgiStrEqNc(attr, "Content-Disposition")) { + argNames[0] = "name"; + argNames[1] = "filename"; + argNames[2] = 0; + argValues[0] = fname; + argValues[1] = ffileName; + decomposeValue(value, + fvalue, sizeof(fvalue), + argNames, + argValues, + 1024); + } else if (cgiStrEqNc(attr, "Content-Type")) { + argNames[0] = 0; + decomposeValue(value, + fcontentType, sizeof(fcontentType), + argNames, + 0, + 0); + } + } + if (!cgiStrEqNc(fvalue, "form-data")) { + /* Not form data */ + continue; + } + /* Body is everything from here until the next + boundary. So, set it aside and move past boundary. + If a filename was submitted as part of the + disposition header, store to a temporary file. + Otherwise, store to a memory buffer (it is + presumably a regular form field). */ + if (strlen(ffileName)) { + if (getTempFileName(tfileName) != cgiParseSuccess) { + return cgiParseIO; + } + outf = fopen(tfileName, "w+b"); + } else { + outf = 0; + tfileName[0] = '\0'; + } + result = afterNextBoundary(mpp, outf, &out, &bodyLength, 0); + if (result != cgiParseSuccess) { + /* Lack of a boundary here is an error. */ + if (outf) { + fclose(outf); + unlink(tfileName); + } + if (out) { + free(out); + } + return result; + } + /* OK, we have a new pair, add it to the list. */ + n = (cgiFormEntry *) malloc(sizeof(cgiFormEntry)); + if (!n) { + goto outOfMemory; + } + memset(n, 0, sizeof(cgiFormEntry)); + /* 2.01: one of numerous new casts required + to please C++ compilers */ + n->attr = (char *) malloc(strlen(fname) + 1); + if (!n->attr) { + goto outOfMemory; + } + strcpy(n->attr, fname); + if (out) { + n->value = out; + out = 0; + } else if (outf) { + n->value = (char *) malloc(1); + if (!n->value) { + goto outOfMemory; + } + n->value[0] = '\0'; + fclose(outf); + } + n->valueLength = bodyLength; + n->next = 0; + if (!l) { + cgiFormEntryFirst = n; + } else { + l->next = n; + } + n->fileName = (char *) malloc(strlen(ffileName) + 1); + if (!n->fileName) { + goto outOfMemory; + } + strcpy(n->fileName, ffileName); + n->contentType = (char *) malloc(strlen(fcontentType) + 1); + if (!n->contentType) { + goto outOfMemory; + } + strcpy(n->contentType, fcontentType); + n->tfileName = (char *) malloc(strlen(tfileName) + 1); + if (!n->tfileName) { + goto outOfMemory; + } + strcpy(n->tfileName, tfileName); + + l = n; + } + return cgiParseSuccess; +outOfMemory: + if (n) { + if (n->attr) { + free(n->attr); + } + if (n->value) { + free(n->value); + } + if (n->fileName) { + free(n->fileName); + } + if (n->tfileName) { + free(n->tfileName); + } + if (n->contentType) { + free(n->contentType); + } + free(n); + } + if (out) { + free(out); + } + if (outf) { + fclose(outf); + unlink(tfileName); + } + return cgiParseMemory; +} + +static cgiParseResultType getTempFileName(char *tfileName) +{ +#ifndef WIN32 + /* Unix. Use the robust 'mkstemp' function to create + a temporary file that is truly unique, with + permissions that are truly safe. The + fopen-for-write destroys any bogus information + written by potential hackers during the brief + window between the file's creation and the + chmod call (glibc 2.0.6 and lower might + otherwise have allowed this). */ + int outfd; + strcpy(tfileName, cgicTempDir "/cgicXXXXXX"); + outfd = mkstemp(tfileName); + if (outfd == -1) { + return cgiParseIO; + } + close(outfd); + /* Fix the permissions */ + if (chmod(tfileName, 0600) != 0) { + unlink(tfileName); + return cgiParseIO; + } +#else + /* Non-Unix. Do what we can. */ + if (!tmpnam(tfileName)) { + return cgiParseIO; + } +#endif + return cgiParseSuccess; +} + + +#define APPEND(string, char) \ + { \ + if ((string##Len + 1) < string##Space) { \ + string[string##Len++] = (char); \ + } \ + } + +#define RAPPEND(string, ch) \ + { \ + if ((string##Len + 1) == string##Space) { \ + char *sold = string; \ + string##Space *= 2; \ + string = (char *) realloc(string, string##Space); \ + if (!string) { \ + string = sold; \ + goto outOfMemory; \ + } \ + } \ + string[string##Len++] = (ch); \ + } + +#define BAPPEND(ch) \ + { \ + if (outf) { \ + putc(ch, outf); \ + outLen++; \ + } else if (out) { \ + RAPPEND(out, ch); \ + } \ + } + +cgiParseResultType afterNextBoundary(mpStreamPtr mpp, FILE *outf, char **outP, + int *bodyLengthP, int first) +{ + int outLen = 0; + int outSpace = 256; + char *out = 0; + cgiParseResultType result; + int boffset; + int got; + char d[2]; + /* This is large enough, because the buffer into which the + original boundary string is fetched is shorter by more + than four characters due to the space required for + the attribute name */ + char workingBoundaryData[1024]; + char *workingBoundary = workingBoundaryData; + int workingBoundaryLength; + if ((!outf) && (outP)) { + out = (char *) malloc(outSpace); + if (!out) { + goto outOfMemory; + } + } + boffset = 0; + sprintf(workingBoundaryData, "\r\n--%s", cgiMultipartBoundary); + if (first) { + workingBoundary = workingBoundaryData + 2; + } + workingBoundaryLength = strlen(workingBoundary); + while (1) { + got = mpRead(mpp, d, 1); + if (got != 1) { + /* 2.01: cgiParseIO, not cgiFormIO */ + result = cgiParseIO; + goto error; + } + if (d[0] == workingBoundary[boffset]) { + /* We matched the next byte of the boundary. + Keep track of our progress into the + boundary and don't emit anything. */ + boffset++; + if (boffset == workingBoundaryLength) { + break; + } + } else if (boffset > 0) { + /* We matched part, but not all, of the + boundary. Now we have to be careful: + put back all except the first + character and try again. The + real boundary could begin in the + middle of a false match. We can + emit the first character only so far. */ + BAPPEND(workingBoundary[0]); + mpPutBack(mpp, + workingBoundary + 1, boffset - 1); + mpPutBack(mpp, d, 1); + boffset = 0; + } else { + /* Not presently in the middle of a boundary + match; just emit the character. */ + BAPPEND(d[0]); + } + } + /* Read trailing newline or -- EOF marker. A literal EOF here + would be an error in the input stream. */ + got = mpRead(mpp, d, 2); + if (got != 2) { + result = cgiParseIO; + goto error; + } + if ((d[0] == '\r') && (d[1] == '\n')) { + /* OK, EOL */ + } else if (d[0] == '-') { + /* Probably EOF, but we check for + that later */ + mpPutBack(mpp, d, 2); + } + if (out && outSpace) { + char *oout = out; + out[outLen] = '\0'; + out = (char *) realloc(out, outLen + 1); + if (!out) { + /* Surprising if it happens; and not fatal! We were + just trying to give some space back. We can + keep it if we have to. */ + out = oout; + } + *outP = out; + } + if (bodyLengthP) { + *bodyLengthP = outLen; + } + return cgiParseSuccess; +outOfMemory: + result = cgiParseMemory; + if (outP) { + if (out) { + free(out); + } + *outP = '\0'; + } +error: + if (bodyLengthP) { + *bodyLengthP = 0; + } + if (out) { + free(out); + } + if (outP) { + *outP = 0; + } + return result; +} + +static void decomposeValue(char *value, + char *mvalue, int mvalueSpace, + char **argNames, + char **argValues, + int argValueSpace) +{ + char argName[1024]; + int argNameSpace = sizeof(argName); + int argNameLen = 0; + int mvalueLen = 0; + char *argValue; + int argNum = 0; + while (argNames[argNum]) { + if (argValueSpace) { + argValues[argNum][0] = '\0'; + } + argNum++; + } + while (isspace(*value)) { + value++; + } + /* Quoted mvalue */ + if (*value == '\"') { + value++; + while ((*value) && (*value != '\"')) { + APPEND(mvalue, *value); + value++; + } + while ((*value) && (*value != ';')) { + value++; + } + } else { + /* Unquoted mvalue */ + while ((*value) && (*value != ';')) { + APPEND(mvalue, *value); + value++; + } + } + if (mvalueSpace) { + mvalue[mvalueLen] = '\0'; + } + while (*value == ';') { + int argNum; + int argValueLen = 0; + /* Skip the ; between parameters */ + value++; + /* Now skip leading whitespace */ + while ((*value) && (isspace(*value))) { + value++; + } + /* Now read the parameter name */ + argNameLen = 0; + while ((*value) && (isalnum(*value))) { + APPEND(argName, *value); + value++; + } + if (argNameSpace) { + argName[argNameLen] = '\0'; + } + while ((*value) && isspace(*value)) { + value++; + } + if (*value != '=') { + /* Malformed line */ + return; + } + value++; + while ((*value) && isspace(*value)) { + value++; + } + /* Find the parameter in the argument list, if present */ + argNum = 0; + argValue = 0; + while (argNames[argNum]) { + if (cgiStrEqNc(argName, argNames[argNum])) { + argValue = argValues[argNum]; + break; + } + argNum++; + } + /* Finally, read the parameter value */ + if (*value == '\"') { + value++; + while ((*value) && (*value != '\"')) { + if (argValue) { + APPEND(argValue, *value); + } + value++; + } + while ((*value) && (*value != ';')) { + value++; + } + } else { + /* Unquoted value */ + while ((*value) && (*value != ';')) { + if (argNames[argNum]) { + APPEND(argValue, *value); + } + value++; + } + } + if (argValueSpace) { + argValue[argValueLen] = '\0'; + } + } +} + +static int readHeaderLine( + mpStreamPtr mpp, + char *attr, + int attrSpace, + char *value, + int valueSpace) +{ + int attrLen = 0; + int valueLen = 0; + int valueFound = 0; + while (1) { + char d[1]; + int got = mpRead(mpp, d, 1); + if (got != 1) { + return 0; + } + if (d[0] == '\r') { + got = mpRead(mpp, d, 1); + if (got == 1) { + if (d[0] == '\n') { + /* OK */ + } else { + mpPutBack(mpp, d, 1); + } + } + break; + } else if (d[0] == '\n') { + break; + } else if ((d[0] == ':') && attrLen) { + valueFound = 1; + while (mpRead(mpp, d, 1) == 1) { + if (!isspace(d[0])) { + mpPutBack(mpp, d, 1); + break; + } + } + } else if (!valueFound) { + if (!isspace(*d)) { + if (attrLen < (attrSpace - 1)) { + attr[attrLen++] = *d; + } + } + } else if (valueFound) { + if (valueLen < (valueSpace - 1)) { + value[valueLen++] = *d; + } + } + } + if (attrSpace) { + attr[attrLen] = '\0'; + } + if (valueSpace) { + value[valueLen] = '\0'; + } + if (attrLen && valueLen) { + return 1; + } else { + return 0; + } +} + +static cgiParseResultType cgiParseGetFormInput() { + return cgiParseFormInput(cgiQueryString, cgiContentLength); +} + +typedef enum { + cgiEscapeRest, + cgiEscapeFirst, + cgiEscapeSecond +} cgiEscapeState; + +typedef enum { + cgiUnescapeSuccess, + cgiUnescapeMemory +} cgiUnescapeResultType; + +static cgiUnescapeResultType cgiUnescapeChars(char **sp, char *cp, int len); + +static cgiParseResultType cgiParseFormInput(char *data, int length) { + /* Scan for pairs, unescaping and storing them as they are found. */ + int pos = 0; + cgiFormEntry *n; + cgiFormEntry *l = 0; + while (pos != length) { + int foundEq = 0; + int foundAmp = 0; + int start = pos; + int len = 0; + char *attr; + char *value; + while (pos != length) { + if (data[pos] == '=') { + foundEq = 1; + pos++; + break; + } + pos++; + len++; + } + if (!foundEq) { + break; + } + if (cgiUnescapeChars(&attr, data+start, len) + != cgiUnescapeSuccess) { + return cgiParseMemory; + } + start = pos; + len = 0; + while (pos != length) { + if (data[pos] == '&') { + foundAmp = 1; + pos++; + break; + } + pos++; + len++; + } + /* The last pair probably won't be followed by a &, but + that's fine, so check for that after accepting it */ + if (cgiUnescapeChars(&value, data+start, len) + != cgiUnescapeSuccess) { + free(attr); + return cgiParseMemory; + } + /* OK, we have a new pair, add it to the list. */ + n = (cgiFormEntry *) malloc(sizeof(cgiFormEntry)); + if (!n) { + free(attr); + free(value); + return cgiParseMemory; + } + n->attr = attr; + n->value = value; + n->valueLength = strlen(n->value); + n->fileName = (char *) malloc(1); + if (!n->fileName) { + free(attr); + free(value); + free(n); + return cgiParseMemory; + } + n->fileName[0] = '\0'; + n->contentType = (char *) malloc(1); + if (!n->contentType) { + free(attr); + free(value); + free(n->fileName); + free(n); + return cgiParseMemory; + } + n->contentType[0] = '\0'; + n->tfileName = (char *) malloc(1); + if (!n->tfileName) { + free(attr); + free(value); + free(n->fileName); + free(n->contentType); + free(n); + return cgiParseMemory; + } + n->tfileName[0] = '\0'; + n->next = 0; + if (!l) { + cgiFormEntryFirst = n; + } else { + l->next = n; + } + l = n; + if (!foundAmp) { + break; + } + } + return cgiParseSuccess; +} + +static int cgiHexValue[256]; + +cgiUnescapeResultType cgiUnescapeChars(char **sp, char *cp, int len) { + char *s; + cgiEscapeState escapeState = cgiEscapeRest; + int escapedValue = 0; + int srcPos = 0; + int dstPos = 0; + s = (char *) malloc(len + 1); + if (!s) { + return cgiUnescapeMemory; + } + while (srcPos < len) { + int ch = cp[srcPos]; + if(cgiTreatUrlEncoding==1) + switch (escapeState) { + case cgiEscapeRest: + if (ch == '%') { + escapeState = cgiEscapeFirst; + } else if (ch == '+') { + s[dstPos++] = ' '; + } else { + s[dstPos++] = ch; + } + break; + case cgiEscapeFirst: + escapedValue = cgiHexValue[ch] << 4; + escapeState = cgiEscapeSecond; + break; + case cgiEscapeSecond: + escapedValue += cgiHexValue[ch]; + s[dstPos++] = escapedValue; + escapeState = cgiEscapeRest; + break; + } + else + s[dstPos++] = ch; + srcPos++; + } + s[dstPos] = '\0'; + *sp = s; + return cgiUnescapeSuccess; +} + +static void cgiSetupConstants() { + int i; + for (i=0; (i < 256); i++) { + cgiHexValue[i] = 0; + } + cgiHexValue['0'] = 0; + cgiHexValue['1'] = 1; + cgiHexValue['2'] = 2; + cgiHexValue['3'] = 3; + cgiHexValue['4'] = 4; + cgiHexValue['5'] = 5; + cgiHexValue['6'] = 6; + cgiHexValue['7'] = 7; + cgiHexValue['8'] = 8; + cgiHexValue['9'] = 9; + cgiHexValue['A'] = 10; + cgiHexValue['B'] = 11; + cgiHexValue['C'] = 12; + cgiHexValue['D'] = 13; + cgiHexValue['E'] = 14; + cgiHexValue['F'] = 15; + cgiHexValue['a'] = 10; + cgiHexValue['b'] = 11; + cgiHexValue['c'] = 12; + cgiHexValue['d'] = 13; + cgiHexValue['e'] = 14; + cgiHexValue['f'] = 15; +} + +static void cgiFreeResources() { + cgiFormEntry *c = cgiFormEntryFirst; + cgiFormEntry *n; + while (c) { + n = c->next; + free(c->attr); + free(c->value); + free(c->fileName); + free(c->contentType); + if (strlen(c->tfileName)) { + unlink(c->tfileName); + } + free(c->tfileName); + free(c); + c = n; + } + /* If the cgi environment was restored from a saved environment, + then these are in allocated space and must also be freed */ + if (cgiRestored) { + free(cgiServerSoftware); + free(cgiServerName); + free(cgiGatewayInterface); + free(cgiServerProtocol); + free(cgiServerPort); + free(cgiRequestMethod); + free(cgiPathInfo); + free(cgiPathTranslated); + free(cgiScriptName); + free(cgiQueryString); + free(cgiRemoteHost); + free(cgiRemoteAddr); + free(cgiAuthType); + free(cgiRemoteUser); + free(cgiRemoteIdent); + free(cgiContentType); + free(cgiAccept); + free(cgiUserAgent); + free(cgiReferrer); + } + /* 2.0: to clean up the environment for cgiReadEnvironment, + we must set these correctly */ + cgiFormEntryFirst = 0; + cgiRestored = 0; +} + +static cgiFormResultType cgiFormEntryString( + cgiFormEntry *e, char *result, int max, int newlines); + +static cgiFormEntry *cgiFormEntryFindFirst(char *name); +static cgiFormEntry *cgiFormEntryFindNext(); + +cgiFormResultType cgiFormString( + char *name, char *result, int max) { + cgiFormEntry *e; + e = cgiFormEntryFindFirst(name); + if (!e) { + strcpy(result, ""); + return cgiFormNotFound; + } + return cgiFormEntryString(e, result, max, 1); +} + +cgiFormResultType cgiFormFileName( + char *name, char *result, int resultSpace) +{ + cgiFormEntry *e; + int resultLen = 0; + char *s; + e = cgiFormEntryFindFirst(name); + if (!e) { + strcpy(result, ""); + return cgiFormNotFound; + } + s = e->fileName; + while (*s) { + APPEND(result, *s); + s++; + } + if (resultSpace) { + result[resultLen] = '\0'; + } + if (!strlen(e->fileName)) { + return cgiFormNoFileName; + } else if (((int) strlen(e->fileName)) > (resultSpace - 1)) { + return cgiFormTruncated; + } else { + return cgiFormSuccess; + } +} + +cgiFormResultType cgiFormFileContentType( + char *name, char *result, int resultSpace) +{ + cgiFormEntry *e; + int resultLen = 0; + char *s; + e = cgiFormEntryFindFirst(name); + if (!e) { + if (resultSpace) { + result[0] = '\0'; + } + return cgiFormNotFound; + } + s = e->contentType; + while (*s) { + APPEND(result, *s); + s++; + } + if (resultSpace) { + result[resultLen] = '\0'; + } + if (!strlen(e->contentType)) { + return cgiFormNoContentType; + } else if (((int) strlen(e->contentType)) > (resultSpace - 1)) { + return cgiFormTruncated; + } else { + return cgiFormSuccess; + } +} + +cgiFormResultType cgiFormFileSize( + char *name, int *sizeP) +{ + cgiFormEntry *e; + e = cgiFormEntryFindFirst(name); + if (!e) { + if (sizeP) { + *sizeP = 0; + } + return cgiFormNotFound; + } else if (!strlen(e->tfileName)) { + if (sizeP) { + *sizeP = 0; + } + return cgiFormNotAFile; + } else { + if (sizeP) { + *sizeP = e->valueLength; + } + return cgiFormSuccess; + } +} + +typedef struct cgiFileStruct { + FILE *in; +} cgiFile; + +cgiFormResultType cgiFormFileOpen( + char *name, cgiFilePtr *cfpp) +{ + cgiFormEntry *e; + cgiFilePtr cfp; + e = cgiFormEntryFindFirst(name); + if (!e) { + *cfpp = 0; + return cgiFormNotFound; + } + if (!strlen(e->tfileName)) { + *cfpp = 0; + return cgiFormNotAFile; + } + cfp = (cgiFilePtr) malloc(sizeof(cgiFile)); + if (!cfp) { + *cfpp = 0; + return cgiFormMemory; + } + cfp->in = fopen(e->tfileName, "rb"); + if (!cfp->in) { + free(cfp); + return cgiFormIO; + } + *cfpp = cfp; + return cgiFormSuccess; +} + +cgiFormResultType cgiFormFileRead( + cgiFilePtr cfp, char *buffer, + int bufferSize, int *gotP) +{ + int got = 0; + if (!cfp) { + return cgiFormOpenFailed; + } + got = fread(buffer, 1, bufferSize, cfp->in); + if (got <= 0) { + return cgiFormEOF; + } + *gotP = got; + return cgiFormSuccess; +} + +cgiFormResultType cgiFormFileClose(cgiFilePtr cfp) +{ + if (!cfp) { + return cgiFormOpenFailed; + } + fclose(cfp->in); + free(cfp); + return cgiFormSuccess; +} + +cgiFormResultType cgiFormStringNoNewlines( + char *name, char *result, int max) { + cgiFormEntry *e; + e = cgiFormEntryFindFirst(name); + if (!e) { + strcpy(result, ""); + return cgiFormNotFound; + } + return cgiFormEntryString(e, result, max, 0); +} + +cgiFormResultType cgiFormStringMultiple( + char *name, char ***result) { + char **stringArray; + cgiFormEntry *e; + int i; + int total = 0; + /* Make two passes. One would be more efficient, but this + function is not commonly used. The select menu and + radio box functions are faster. */ + e = cgiFormEntryFindFirst(name); + if (e != 0) { + do { + total++; + } while ((e = cgiFormEntryFindNext()) != 0); + } + stringArray = (char **) malloc(sizeof(char *) * (total + 1)); + if (!stringArray) { + *result = 0; + return cgiFormMemory; + } + /* initialize all entries to null; the last will stay that way */ + for (i=0; (i <= total); i++) { + stringArray[i] = 0; + } + /* Now go get the entries */ + e = cgiFormEntryFindFirst(name); +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "StringMultiple Beginning\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + if (e) { + i = 0; + do { + int max = (int) (strlen(e->value) + 1); + stringArray[i] = (char *) malloc(max); + if (stringArray[i] == 0) { + /* Memory problems */ + cgiStringArrayFree(stringArray); + *result = 0; + return cgiFormMemory; + } + strcpy(stringArray[i], e->value); + cgiFormEntryString(e, stringArray[i], max, 1); + i++; + } while ((e = cgiFormEntryFindNext()) != 0); + *result = stringArray; +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "StringMultiple Succeeding\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + return cgiFormSuccess; + } else { + *result = stringArray; +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "StringMultiple found nothing\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + return cgiFormNotFound; + } +} + +cgiFormResultType cgiFormStringSpaceNeeded( + char *name, int *result) { + cgiFormEntry *e; + e = cgiFormEntryFindFirst(name); + if (!e) { + *result = 1; + return cgiFormNotFound; + } + *result = ((int) strlen(e->value)) + 1; + return cgiFormSuccess; +} + +static cgiFormResultType cgiFormEntryString( + cgiFormEntry *e, char *result, int max, int newlines) { + char *dp, *sp; + int truncated = 0; + int len = 0; + int avail = max-1; + int crCount = 0; + int lfCount = 0; + dp = result; + sp = e->value; + while (1) { + int ch; + /* 1.07: don't check for available space now. + We check for it immediately before adding + an actual character. 1.06 handled the + trailing null of the source string improperly, + resulting in a cgiFormTruncated error. */ + ch = *sp; + /* Fix the CR/LF, LF, CR nightmare: watch for + consecutive bursts of CRs and LFs in whatever + pattern, then actually output the larger number + of LFs. Consistently sane, yet it still allows + consecutive blank lines when the user + actually intends them. */ + if ((ch == 13) || (ch == 10)) { + if (ch == 13) { + crCount++; + } else { + lfCount++; + } + } else { + if (crCount || lfCount) { + int lfsAdd = crCount; + if (lfCount > crCount) { + lfsAdd = lfCount; + } + /* Stomp all newlines if desired */ + if (!newlines) { + lfsAdd = 0; + } + while (lfsAdd) { + if (len >= avail) { + truncated = 1; + break; + } + *dp = 10; + dp++; + lfsAdd--; + len++; + } + crCount = 0; + lfCount = 0; + } + if (ch == '\0') { + /* The end of the source string */ + break; + } + /* 1.06: check available space before adding + the character, because a previously added + LF may have brought us to the limit */ + if (len >= avail) { + truncated = 1; + break; + } + *dp = ch; + dp++; + len++; + } + sp++; + } + *dp = '\0'; + if (truncated) { + return cgiFormTruncated; + } else if (!len) { + return cgiFormEmpty; + } else { + return cgiFormSuccess; + } +} + +static int cgiFirstNonspaceChar(char *s); + +cgiFormResultType cgiFormInteger( + char *name, int *result, int defaultV) { + cgiFormEntry *e; + int ch; + e = cgiFormEntryFindFirst(name); + if (!e) { + *result = defaultV; + return cgiFormNotFound; + } + if (!strlen(e->value)) { + *result = defaultV; + return cgiFormEmpty; + } + ch = cgiFirstNonspaceChar(e->value); + if (!(isdigit(ch)) && (ch != '-') && (ch != '+')) { + *result = defaultV; + return cgiFormBadType; + } else { + *result = atoi(e->value); + return cgiFormSuccess; + } +} + +cgiFormResultType cgiFormIntegerBounded( + char *name, int *result, int min, int max, int defaultV) { + cgiFormResultType error = cgiFormInteger(name, result, defaultV); + if (error != cgiFormSuccess) { + return error; + } + if (*result < min) { + *result = min; + return cgiFormConstrained; + } + if (*result > max) { + *result = max; + return cgiFormConstrained; + } + return cgiFormSuccess; +} + +cgiFormResultType cgiFormDouble( + char *name, double *result, double defaultV) { + cgiFormEntry *e; + int ch; + e = cgiFormEntryFindFirst(name); + if (!e) { + *result = defaultV; + return cgiFormNotFound; + } + if (!strlen(e->value)) { + *result = defaultV; + return cgiFormEmpty; + } + ch = cgiFirstNonspaceChar(e->value); + if (!(isdigit(ch)) && (ch != '.') && (ch != '-') && (ch != '+')) { + *result = defaultV; + return cgiFormBadType; + } else { + *result = atof(e->value); + return cgiFormSuccess; + } +} + +cgiFormResultType cgiFormDoubleBounded( + char *name, double *result, double min, double max, double defaultV) { + cgiFormResultType error = cgiFormDouble(name, result, defaultV); + if (error != cgiFormSuccess) { + return error; + } + if (*result < min) { + *result = min; + return cgiFormConstrained; + } + if (*result > max) { + *result = max; + return cgiFormConstrained; + } + return cgiFormSuccess; +} + +cgiFormResultType cgiFormSelectSingle( + char *name, char **choicesText, int choicesTotal, + int *result, int defaultV) +{ + cgiFormEntry *e; + int i; + e = cgiFormEntryFindFirst(name); +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "%d\n", (int) e); + CGICDEBUGEND +#endif /* CGICDEBUG */ + if (!e) { + *result = defaultV; + return cgiFormNotFound; + } + for (i=0; (i < choicesTotal); i++) { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "%s %s\n", choicesText[i], e->value); + CGICDEBUGEND +#endif /* CGICDEBUG */ + if (cgiStrEq(choicesText[i], e->value)) { +#ifdef CGICDEBUG + CGICDEBUGSTART + fprintf(dout, "MATCH\n"); + CGICDEBUGEND +#endif /* CGICDEBUG */ + *result = i; + return cgiFormSuccess; + } + } + *result = defaultV; + return cgiFormNoSuchChoice; +} + +cgiFormResultType cgiFormSelectMultiple( + char *name, char **choicesText, int choicesTotal, + int *result, int *invalid) +{ + cgiFormEntry *e; + int i; + int hits = 0; + int invalidE = 0; + for (i=0; (i < choicesTotal); i++) { + result[i] = 0; + } + e = cgiFormEntryFindFirst(name); + if (!e) { + *invalid = invalidE; + return cgiFormNotFound; + } + do { + int hit = 0; + for (i=0; (i < choicesTotal); i++) { + if (cgiStrEq(choicesText[i], e->value)) { + result[i] = 1; + hits++; + hit = 1; + break; + } + } + if (!(hit)) { + invalidE++; + } + } while ((e = cgiFormEntryFindNext()) != 0); + + *invalid = invalidE; + + if (hits) { + return cgiFormSuccess; + } else { + return cgiFormNotFound; + } +} + +cgiFormResultType cgiFormCheckboxSingle( + char *name) +{ + cgiFormEntry *e; + e = cgiFormEntryFindFirst(name); + if (!e) { + return cgiFormNotFound; + } + return cgiFormSuccess; +} + +extern cgiFormResultType cgiFormCheckboxMultiple( + char *name, char **valuesText, int valuesTotal, + int *result, int *invalid) +{ + /* Implementation is identical to cgiFormSelectMultiple. */ + return cgiFormSelectMultiple(name, valuesText, + valuesTotal, result, invalid); +} + +cgiFormResultType cgiFormRadio( + char *name, + char **valuesText, int valuesTotal, int *result, int defaultV) +{ + /* Implementation is identical to cgiFormSelectSingle. */ + return cgiFormSelectSingle(name, valuesText, valuesTotal, + result, defaultV); +} + +cgiFormResultType cgiCookieString( + char *name, + char *value, + int space) +{ + char *p = cgiCookie; + while (*p) { + char *n = name; + /* 2.02: if cgiCookie is exactly equal to name, this + can cause an overrun. The server probably wouldn't + allow it, since a name without values makes no sense + -- but then again it might not check, so this is a + genuine security concern. Thanks to Nicolas + Tomadakis. */ + while (*p == *n) { + if ((p == '\0') && (n == '\0')) { + /* Malformed cookie header from client */ + return cgiFormNotFound; + } + p++; + n++; + } + if ((!*n) && (*p == '=')) { + p++; + while ((*p != ';') && (*p != '\0') && + (space > 1)) + { + *value = *p; + value++; + p++; + space--; + } + if (space > 0) { + *value = '\0'; + } + /* Correct parens: 2.02. Thanks to + Mathieu Villeneuve-Belair. */ + if (!(((*p) == ';') || ((*p) == '\0'))) + { + return cgiFormTruncated; + } else { + return cgiFormSuccess; + } + } else { + /* Skip to next cookie */ + while (*p) { + if (*p == ';') { + break; + } + p++; + } + if (!*p) { + /* 2.01: default to empty */ + if (space) { + *value = '\0'; + } + return cgiFormNotFound; + } + p++; + /* Allow whitespace after semicolon */ + while ((*p) && isspace(*p)) { + p++; + } + } + } + /* 2.01: actually the above loop never terminates except + with a return, but do this to placate gcc */ + if (space) { + *value = '\0'; + } + return cgiFormNotFound; +} + +cgiFormResultType cgiCookieInteger( + char *name, + int *result, + int defaultV) +{ + char buffer[256]; + cgiFormResultType r = + cgiCookieString(name, buffer, sizeof(buffer)); + if (r != cgiFormSuccess) { + *result = defaultV; + } else { + *result = atoi(buffer); + } + return r; +} + +void cgiHeaderCookieSetInteger(char *name, int value, int secondsToLive, + char *path, char *domain) +{ + char svalue[256]; + sprintf(svalue, "%d", value); + cgiHeaderCookieSetString(name, svalue, secondsToLive, path, domain); +} + +char *days[] = { + "Sun", + "Mon", + "Tue", + "Wed", + "Thu", + "Fri", + "Sat" +}; + +char *months[] = { + "Jan", + "Feb", + "Mar", + "Apr", + "May", + "Jun", + "Jul", + "Aug", + "Sep", + "Oct", + "Nov", + "Dec" +}; + +void cgiHeaderCookieSetString(char *name, char *value, int secondsToLive, + char *path, char *domain) +{ + /* cgic 2.02: simpler and more widely compatible implementation. + Thanks to Chunfu Lai. + cgic 2.03: yes, but it didn't work. Reimplemented by + Thomas Boutell. ; after last element was a bug. + Examples of real world cookies that really work: + Set-Cookie: MSNADS=UM=; domain=.slate.com; + expires=Tue, 26-Apr-2022 19:00:00 GMT; path=/ + Set-Cookie: MC1=V=3&ID=b5bc08af2b8a43ff85fcb5efd8b238f0; + domain=.slate.com; expires=Mon, 04-Oct-2021 19:00:00 GMT; path=/ + */ + time_t now; + time_t then; + struct tm *gt; + time(&now); + then = now + secondsToLive; + gt = gmtime(&then); + fprintf(cgiOut, + "Set-Cookie: %s=%s; domain=%s; expires=%s, %02d-%s-%04d %02d:%02d:%02d GMT; path=%s\r\n", + name, value, domain, + days[gt->tm_wday], + gt->tm_mday, + months[gt->tm_mon], + gt->tm_year + 1900, + gt->tm_hour, + gt->tm_min, + gt->tm_sec, + path); +} + +void cgiHeaderLocation(char *redirectUrl) { + fprintf(cgiOut, "Location: %s\r\n\r\n", redirectUrl); +} + +void cgiHeaderStatus(int status, char *statusMessage) { + fprintf(cgiOut, "Status: %d %s\r\n\r\n", status, statusMessage); +} + +void cgiHeaderContentType(char *mimeType) { + fprintf(cgiOut, "Content-type: %s\r\n\r\n", mimeType); +} + +static int cgiWriteString(FILE *out, char *s); + +static int cgiWriteInt(FILE *out, int i); + +#define CGIC_VERSION "2.0" + +cgiEnvironmentResultType cgiWriteEnvironment(char *filename) { + FILE *out; + cgiFormEntry *e; + /* Be sure to open in binary mode */ + out = fopen(filename, "wb"); + if (!out) { + /* Can't create file */ + return cgiEnvironmentIO; + } + if (!cgiWriteString(out, "CGIC2.0")) { + goto error; + } + if (!cgiWriteString(out, cgiServerSoftware)) { + goto error; + } + if (!cgiWriteString(out, cgiServerName)) { + goto error; + } + if (!cgiWriteString(out, cgiGatewayInterface)) { + goto error; + } + if (!cgiWriteString(out, cgiServerProtocol)) { + goto error; + } + if (!cgiWriteString(out, cgiServerPort)) { + goto error; + } + if (!cgiWriteString(out, cgiRequestMethod)) { + goto error; + } + if (!cgiWriteString(out, cgiPathInfo)) { + goto error; + } + if (!cgiWriteString(out, cgiPathTranslated)) { + goto error; + } + if (!cgiWriteString(out, cgiScriptName)) { + goto error; + } + if (!cgiWriteString(out, cgiQueryString)) { + goto error; + } + if (!cgiWriteString(out, cgiRemoteHost)) { + goto error; + } + if (!cgiWriteString(out, cgiRemoteAddr)) { + goto error; + } + if (!cgiWriteString(out, cgiAuthType)) { + goto error; + } + if (!cgiWriteString(out, cgiRemoteUser)) { + goto error; + } + if (!cgiWriteString(out, cgiRemoteIdent)) { + goto error; + } + if (!cgiWriteString(out, cgiContentType)) { + goto error; + } + if (!cgiWriteString(out, cgiAccept)) { + goto error; + } + if (!cgiWriteString(out, cgiUserAgent)) { + goto error; + } + if (!cgiWriteString(out, cgiReferrer)) { + goto error; + } + if (!cgiWriteString(out, cgiCookie)) { + goto error; + } + if (!cgiWriteInt(out, cgiContentLength)) { + goto error; + } + e = cgiFormEntryFirst; + while (e) { + cgiFilePtr fp; + if (!cgiWriteString(out, e->attr)) { + goto error; + } + if (!cgiWriteString(out, e->value)) { + goto error; + } + /* New 2.0 fields and file uploads */ + if (!cgiWriteString(out, e->fileName)) { + goto error; + } + if (!cgiWriteString(out, e->contentType)) { + goto error; + } + if (!cgiWriteInt(out, e->valueLength)) { + goto error; + } + if (cgiFormFileOpen(e->attr, &fp) == cgiFormSuccess) { + char buffer[1024]; + int got; + if (!cgiWriteInt(out, 1)) { + cgiFormFileClose(fp); + goto error; + } + while (cgiFormFileRead(fp, buffer, + sizeof(buffer), &got) == cgiFormSuccess) + { + if (((int) fwrite(buffer, 1, got, out)) != got) { + cgiFormFileClose(fp); + goto error; + } + } + if (cgiFormFileClose(fp) != cgiFormSuccess) { + goto error; + } + } else { + if (!cgiWriteInt(out, 0)) { + goto error; + } + } + e = e->next; + } + fclose(out); + return cgiEnvironmentSuccess; +error: + fclose(out); + /* If this function is not defined in your system, + you must substitute the appropriate + file-deletion function. */ + unlink(filename); + return cgiEnvironmentIO; +} + +static int cgiWriteString(FILE *out, char *s) { + int len = (int) strlen(s); + cgiWriteInt(out, len); + if (((int) fwrite(s, 1, len, out)) != len) { + return 0; + } + return 1; +} + +static int cgiWriteInt(FILE *out, int i) { + if (!fwrite(&i, sizeof(int), 1, out)) { + return 0; + } + return 1; +} + +static int cgiReadString(FILE *out, char **s); + +static int cgiReadInt(FILE *out, int *i); + +cgiEnvironmentResultType cgiReadEnvironment(char *filename) { + FILE *in; + cgiFormEntry *e = 0, *p; + char *version; + /* Prevent compiler warnings */ + cgiEnvironmentResultType result = cgiEnvironmentIO; + /* Free any existing data first */ + cgiFreeResources(); + /* Be sure to open in binary mode */ + in = fopen(filename, "rb"); + if (!in) { + /* Can't access file */ + return cgiEnvironmentIO; + } + if (!cgiReadString(in, &version)) { + goto error; + } + if (strcmp(version, "CGIC" CGIC_VERSION)) { + /* 2.02: Merezko Oleg */ + free(version); + return cgiEnvironmentWrongVersion; + } + /* 2.02: Merezko Oleg */ + free(version); + if (!cgiReadString(in, &cgiServerSoftware)) { + goto error; + } + if (!cgiReadString(in, &cgiServerName)) { + goto error; + } + if (!cgiReadString(in, &cgiGatewayInterface)) { + goto error; + } + if (!cgiReadString(in, &cgiServerProtocol)) { + goto error; + } + if (!cgiReadString(in, &cgiServerPort)) { + goto error; + } + if (!cgiReadString(in, &cgiRequestMethod)) { + goto error; + } + if (!cgiReadString(in, &cgiPathInfo)) { + goto error; + } + if (!cgiReadString(in, &cgiPathTranslated)) { + goto error; + } + if (!cgiReadString(in, &cgiScriptName)) { + goto error; + } + if (!cgiReadString(in, &cgiQueryString)) { + goto error; + } + if (!cgiReadString(in, &cgiRemoteHost)) { + goto error; + } + if (!cgiReadString(in, &cgiRemoteAddr)) { + goto error; + } + if (!cgiReadString(in, &cgiAuthType)) { + goto error; + } + if (!cgiReadString(in, &cgiRemoteUser)) { + goto error; + } + if (!cgiReadString(in, &cgiRemoteIdent)) { + goto error; + } + if (!cgiReadString(in, &cgiContentType)) { + goto error; + } + if (!cgiReadString(in, &cgiAccept)) { + goto error; + } + if (!cgiReadString(in, &cgiUserAgent)) { + goto error; + } + if (!cgiReadString(in, &cgiReferrer)) { + goto error; + } + /* 2.0 */ + if (!cgiReadString(in, &cgiCookie)) { + goto error; + } + if (!cgiReadInt(in, &cgiContentLength)) { + goto error; + } + p = 0; + while (1) { + int fileFlag; + e = (cgiFormEntry *) calloc(1, sizeof(cgiFormEntry)); + if (!e) { + cgiFreeResources(); + fclose(in); + return cgiEnvironmentMemory; + } + memset(e, 0, sizeof(cgiFormEntry)); + if (!cgiReadString(in, &e->attr)) { + /* This means we've reached the end of the list. */ + /* 2.02: thanks to Merezko Oleg */ + free(e); + break; + } + if (!cgiReadString(in, &e->value)) { + goto outOfMemory; + } + if (!cgiReadString(in, &e->fileName)) { + goto outOfMemory; + } + if (!cgiReadString(in, &e->contentType)) { + goto outOfMemory; + } + if (!cgiReadInt(in, &e->valueLength)) { + goto outOfMemory; + } + if (!cgiReadInt(in, &fileFlag)) { + goto outOfMemory; + } + if (fileFlag) { + char buffer[1024]; + FILE *out; + char tfileName[1024]; + int got; + int len = e->valueLength; + if (getTempFileName(tfileName) + != cgiParseSuccess) + { + result = cgiEnvironmentIO; + goto error; + } + out = fopen(tfileName, "w+b"); + if (!out) { + result = cgiEnvironmentIO; + goto error; + } + while (len > 0) { + /* 2.01: try is a bad variable name in + C++, and it wasn't being used + properly either */ + int tryr = len; + if (tryr > ((int) sizeof(buffer))) { + tryr = sizeof(buffer); + } + got = fread(buffer, 1, tryr, in); + if (got <= 0) { + result = cgiEnvironmentIO; + fclose(out); + unlink(tfileName); + goto error; + } + if (((int) fwrite(buffer, 1, got, out)) != got) { + result = cgiEnvironmentIO; + fclose(out); + unlink(tfileName); + goto error; + } + len -= got; + } + /* cgic 2.05: should be fclose not rewind */ + fclose(out); + e->tfileName = (char *) malloc((int) strlen(tfileName) + 1); + if (!e->tfileName) { + result = cgiEnvironmentMemory; + unlink(tfileName); + goto error; + } + strcpy(e->tfileName, tfileName); + } else { + e->tfileName = (char *) malloc(1); + if (!e->tfileName) { + result = cgiEnvironmentMemory; + goto error; + } + } + e->next = 0; + if (p) { + p->next = e; + } else { + cgiFormEntryFirst = e; + } + p = e; + } + fclose(in); + cgiRestored = 1; + return cgiEnvironmentSuccess; +outOfMemory: + result = cgiEnvironmentMemory; +error: + cgiFreeResources(); + fclose(in); + if (e) { + if (e->attr) { + free(e->attr); + } + if (e->value) { + free(e->value); + } + if (e->fileName) { + free(e->fileName); + } + if (e->contentType) { + free(e->contentType); + } + if (e->tfileName) { + free(e->tfileName); + } + free(e); + } + return result; +} + +static int cgiReadString(FILE *in, char **s) { + int len; + /* 2.0 fix: test cgiReadInt for failure! */ + if (!cgiReadInt(in, &len)) { + return 0; + } + *s = (char *) malloc(len + 1); + if (!(*s)) { + return 0; + } + if (((int) fread(*s, 1, len, in)) != len) { + return 0; + } + (*s)[len] = '\0'; + return 1; +} + +static int cgiReadInt(FILE *out, int *i) { + if (!fread(i, sizeof(int), 1, out)) { + return 0; + } + return 1; +} + +static int cgiStrEqNc(char *s1, char *s2) { + while(1) { + if (!(*s1)) { + if (!(*s2)) { + return 1; + } else { + return 0; + } + } else if (!(*s2)) { + return 0; + } + if (isalpha(*s1)) { + if (tolower(*s1) != tolower(*s2)) { + return 0; + } + } else if ((*s1) != (*s2)) { + return 0; + } + s1++; + s2++; + } +} + +static int cgiStrBeginsNc(char *s1, char *s2) { + while(1) { + if (!(*s2)) { + return 1; + } else if (!(*s1)) { + return 0; + } + if (isalpha(*s1)) { + if (tolower(*s1) != tolower(*s2)) { + return 0; + } + } else if ((*s1) != (*s2)) { + return 0; + } + s1++; + s2++; + } +} + +static char *cgiFindTarget = 0; +static cgiFormEntry *cgiFindPos = 0; + +static cgiFormEntry *cgiFormEntryFindFirst(char *name) { + cgiFindTarget = name; + cgiFindPos = cgiFormEntryFirst; + return cgiFormEntryFindNext(); +} + +static cgiFormEntry *cgiFormEntryFindNext() { + while (cgiFindPos) { + cgiFormEntry *c = cgiFindPos; + cgiFindPos = c->next; + if (!strcmp(c -> attr, cgiFindTarget)) { + return c; + } + } + return 0; +} + +static int cgiFirstNonspaceChar(char *s) { + int len = strspn(s, " \n\r\t"); + return s[len]; +} + +void cgiStringArrayFree(char **stringArray) { + char *p; + char **arrayItself = stringArray; + p = *stringArray; + while (p) { + free(p); + stringArray++; + p = *stringArray; + } + /* 2.0: free the array itself! */ + free(arrayItself); +} + +cgiFormResultType cgiCookies(char ***result) { + char **stringArray; + int i; + int total = 0; + char *p; + char *n; + p = cgiCookie; + while (*p) { + if (*p == '=') { + total++; + } + p++; + } + stringArray = (char **) malloc(sizeof(char *) * (total + 1)); + if (!stringArray) { + *result = 0; + return cgiFormMemory; + } + /* initialize all entries to null; the last will stay that way */ + for (i=0; (i <= total); i++) { + stringArray[i] = 0; + } + i = 0; + p = cgiCookie; + while (*p) { + while (*p && isspace(*p)) { + p++; + } + n = p; + while (*p && (*p != '=')) { + p++; + } + if (p != n) { + stringArray[i] = (char *) malloc((p - n) + 1); + if (!stringArray[i]) { + cgiStringArrayFree(stringArray); + *result = 0; + return cgiFormMemory; + } + memcpy(stringArray[i], n, p - n); + stringArray[i][p - n] = '\0'; + i++; + } + while (*p && (*p != ';')) { + p++; + } + if (!*p) { + break; + } + if (*p == ';') { + p++; + } + } + *result = stringArray; + return cgiFormSuccess; +} + +cgiFormResultType cgiFormEntries(char ***result) { + char **stringArray; + cgiFormEntry *e, *pe; + int i; + int total = 0; + e = cgiFormEntryFirst; + while (e) { + /* Don't count a field name more than once if + multiple values happen to be present for it */ + pe = cgiFormEntryFirst; + while (pe != e) { + if (!strcmp(e->attr, pe->attr)) { + goto skipSecondValue; + } + pe = pe->next; + } + total++; +skipSecondValue: + e = e->next; + } + stringArray = (char **) malloc(sizeof(char *) * (total + 1)); + if (!stringArray) { + *result = 0; + return cgiFormMemory; + } + /* initialize all entries to null; the last will stay that way */ + for (i=0; (i <= total); i++) { + stringArray[i] = 0; + } + /* Now go get the entries */ + e = cgiFormEntryFirst; + i = 0; + while (e) { + int space; + /* Don't return a field name more than once if + multiple values happen to be present for it */ + pe = cgiFormEntryFirst; + while (pe != e) { + if (!strcmp(e->attr, pe->attr)) { + goto skipSecondValue2; + } + pe = pe->next; + } + space = (int) strlen(e->attr) + 1; + stringArray[i] = (char *) malloc(space); + if (stringArray[i] == 0) { + /* Memory problems */ + cgiStringArrayFree(stringArray); + *result = 0; + return cgiFormMemory; + } + strcpy(stringArray[i], e->attr); + i++; +skipSecondValue2: + e = e->next; + } + *result = stringArray; + return cgiFormSuccess; +} + +#define TRYPUTC(ch) \ + { \ + if (putc((ch), cgiOut) == EOF) { \ + return cgiFormIO; \ + } \ + } + +cgiFormResultType cgiHtmlEscapeData(char *data, int len) +{ + while (len--) { + if (*data == '<') { + TRYPUTC('&'); + TRYPUTC('l'); + TRYPUTC('t'); + TRYPUTC(';'); + } else if (*data == '&') { + TRYPUTC('&'); + TRYPUTC('a'); + TRYPUTC('m'); + TRYPUTC('p'); + TRYPUTC(';'); + } else if (*data == '>') { + TRYPUTC('&'); + TRYPUTC('g'); + TRYPUTC('t'); + TRYPUTC(';'); + } else { + TRYPUTC(*data); + } + data++; + } + return cgiFormSuccess; +} + +cgiFormResultType cgiHtmlEscape(char *s) +{ + return cgiHtmlEscapeData(s, (int) strlen(s)); +} + +/* Output data with the " character HTML-escaped, and no + other characters escaped. This is useful when outputting + the contents of a tag attribute such as 'href' or 'src'. + 'data' is not null-terminated; 'len' is the number of + bytes in 'data'. Returns cgiFormIO in the event + of error, cgiFormSuccess otherwise. */ +cgiFormResultType cgiValueEscapeData(char *data, int len) +{ + while (len--) { + if (*data == '\"') { + TRYPUTC('&'); + TRYPUTC('#'); + TRYPUTC('3'); + TRYPUTC('4'); + TRYPUTC(';'); + } else { + TRYPUTC(*data); + } + data++; + } + return cgiFormSuccess; +} + +cgiFormResultType cgiValueEscape(char *s) +{ + return cgiValueEscapeData(s, (int) strlen(s)); +} + + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.h =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.h (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.h (revision 672) @@ -0,0 +1,457 @@ +/* The CGI_C library, by Thomas Boutell, version 2.01. CGI_C is intended + to be a high-quality API to simplify CGI programming tasks. */ + +/* Make sure this is only included once. */ + +#ifndef CGI_C +#define CGI_C 1 + +/* Bring in standard I/O since some of the functions refer to + types defined by it, such as FILE *. */ + +#include "fcgi_stdio.h" +//#include + +/* The various CGI environment variables. Instead of using getenv(), + the programmer should refer to these, which are always + valid null-terminated strings (they may be empty, but they + will never be null). If these variables are used instead + of calling getenv(), then it will be possible to save + and restore CGI environments, which is highly convenient + for debugging. */ + +extern +#ifdef __cplusplus +"C" +#endif +char *cgiServerSoftware; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiServerName; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiGatewayInterface; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiServerProtocol; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiServerPort; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiRequestMethod; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiPathInfo; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiPathTranslated; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiScriptName; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiQueryString; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiRemoteHost; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiRemoteAddr; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiAuthType; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiRemoteUser; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiRemoteIdent; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiContentType; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiAccept; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiUserAgent; +extern +#ifdef __cplusplus +"C" +#endif +char *cgiReferrer; + +/* Cookies as sent to the server. You can also get them + individually, or as a string array; see the documentation. */ +extern +#ifdef __cplusplus +"C" +#endif +char *cgiCookie; + +extern +#ifdef __cplusplus +"C" +#endif +char *cgiSid; + +/* A macro providing the same incorrect spelling that is + found in the HTTP/CGI specifications */ +#define cgiReferer cgiReferrer + +/* The number of bytes of data received. + Note that if the submission is a form submission + the library will read and parse all the information + directly from cgiIn; the programmer need not do so. */ + +extern +#ifdef __cplusplus +"C" +#endif +int cgiContentLength; + +/* Pointer to CGI output. The cgiHeader functions should be used + first to output the mime headers; the output HTML + page, GIF image or other web document should then be written + to cgiOut by the programmer. In the standard CGIC library, + cgiOut is always equivalent to stdout. */ + +extern +#ifdef __cplusplus +"C" +#endif +FILE *cgiOut; + +/* Pointer to CGI input. The programmer does not read from this. + We have continued to export it for backwards compatibility + so that cgic 1.x applications link properly. */ + +extern +#ifdef __cplusplus +"C" +#endif +FILE *cgiIn; + +/* Possible return codes from the cgiForm family of functions (see below). */ + +typedef enum { + cgiFormSuccess, + cgiFormTruncated, + cgiFormBadType, + cgiFormEmpty, + cgiFormNotFound, + cgiFormConstrained, + cgiFormNoSuchChoice, + cgiFormMemory, + cgiFormNoFileName, + cgiFormNoContentType, + cgiFormNotAFile, + cgiFormOpenFailed, + cgiFormIO, + cgiFormEOF +} cgiFormResultType; + +/* These functions are used to retrieve form data. See + cgic.html for documentation. */ + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormString( + char *name, char *result, int max); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormStringNoNewlines( + char *name, char *result, int max); + + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormStringSpaceNeeded( + char *name, int *length); + + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormStringMultiple( + char *name, char ***ptrToStringArray); + +extern +#ifdef __cplusplus +"C" +#endif +void cgiStringArrayFree(char **stringArray); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormInteger( + char *name, int *result, int defaultV); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormIntegerBounded( + char *name, int *result, int min, int max, int defaultV); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormDouble( + char *name, double *result, double defaultV); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormDoubleBounded( + char *name, double *result, double min, double max, double defaultV); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormSelectSingle( + char *name, char **choicesText, int choicesTotal, + int *result, int defaultV); + + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormSelectMultiple( + char *name, char **choicesText, int choicesTotal, + int *result, int *invalid); + +/* Just an alias; users have asked for this */ +#define cgiFormSubmitClicked cgiFormCheckboxSingle + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormCheckboxSingle( + char *name); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormCheckboxMultiple( + char *name, char **valuesText, int valuesTotal, + int *result, int *invalid); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormRadio( + char *name, char **valuesText, int valuesTotal, + int *result, int defaultV); + +/* The paths returned by this function are the original names of files + as reported by the uploading web browser and shoult NOT be + blindly assumed to be "safe" names for server-side use! */ +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormFileName( + char *name, char *result, int max); + +/* The content type of the uploaded file, as reported by the browser. + It should NOT be assumed that browsers will never falsify + such information. */ +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormFileContentType( + char *name, char *result, int max); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormFileSize( + char *name, int *sizeP); + +typedef struct cgiFileStruct *cgiFilePtr; + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormFileOpen( + char *name, cgiFilePtr *cfpp); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormFileRead( + cgiFilePtr cfp, char *buffer, int bufferSize, int *gotP); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormFileClose( + cgiFilePtr cfp); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiCookieString( + char *name, char *result, int max); + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiCookieInteger( + char *name, int *result, int defaultV); + +cgiFormResultType cgiCookies( + char ***ptrToStringArray); + +/* path can be null or empty in which case a path of / (entire site) is set. + domain can be a single web site; if it is an entire domain, such as + 'boutell.com', it should begin with a dot: '.boutell.com' */ +extern +#ifdef __cplusplus +"C" +#endif +void cgiHeaderCookieSetString(char *name, char *value, + int secondsToLive, char *path, char *domain); +extern +#ifdef __cplusplus +"C" +#endif +void cgiHeaderCookieSetInteger(char *name, int value, + int secondsToLive, char *path, char *domain); +extern +#ifdef __cplusplus +"C" +#endif +void cgiHeaderLocation(char *redirectUrl); +extern +#ifdef __cplusplus +"C" +#endif +void cgiHeaderStatus(int status, char *statusMessage); +extern +#ifdef __cplusplus +"C" +#endif +void cgiHeaderContentType(char *mimeType); + +typedef enum { + cgiEnvironmentIO, + cgiEnvironmentMemory, + cgiEnvironmentSuccess, + cgiEnvironmentWrongVersion +} cgiEnvironmentResultType; + +extern +#ifdef __cplusplus +"C" +#endif +cgiEnvironmentResultType cgiWriteEnvironment(char *filename); +extern cgiEnvironmentResultType cgiReadEnvironment(char *filename); + +extern +#ifdef __cplusplus +"C" +#endif +int cgiMain(); +extern +#ifdef __cplusplus +"C" +#endif +int cgiMain_init(); + + +extern +#ifdef __cplusplus +"C" +#endif +cgiFormResultType cgiFormEntries( + char ***ptrToStringArray); + +/* Output string with the <, &, and > characters HTML-escaped. + 's' is null-terminated. Returns cgiFormIO in the event + of error, cgiFormSuccess otherwise. */ +cgiFormResultType cgiHtmlEscape(char *s); + +/* Output data with the <, &, and > characters HTML-escaped. + 'data' is not null-terminated; 'len' is the number of + bytes in 'data'. Returns cgiFormIO in the event + of error, cgiFormSuccess otherwise. */ +cgiFormResultType cgiHtmlEscapeData(char *data, int len); + +/* Output string with the " character HTML-escaped, and no + other characters escaped. This is useful when outputting + the contents of a tag attribute such as 'href' or 'src'. + 's' is null-terminated. Returns cgiFormIO in the event + of error, cgiFormSuccess otherwise. */ +cgiFormResultType cgiValueEscape(char *s); + +/* Output data with the " character HTML-escaped, and no + other characters escaped. This is useful when outputting + the contents of a tag attribute such as 'href' or 'src'. + 'data' is not null-terminated; 'len' is the number of + bytes in 'data'. Returns cgiFormIO in the event + of error, cgiFormSuccess otherwise. */ +cgiFormResultType cgiValueEscapeData(char *data, int len); + +#endif /* CGI_C */ + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.html =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.html (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgic.html (revision 672) @@ -0,0 +1,2116 @@ + + +cgic: an ANSI C library for CGI Programming + + +

      cgic 2.05: an ANSI C library for CGI Programming

      +

      By Thomas Boutell

      + +The LATEST documentation is available here. Check often +for new releases. +
      +IMPORTANT NOTICES: +

      +If you have CGIC 1.05 or earlier, you should upgrade to CGIC 1.07, +or to CGIC 2.02 or better, in order to obtain important security fixes. +

      +If you have CGIC 2.0 or CGIC 2.01 and you use the cgiCookie routines, +you should upgrade to CGIC 2.02 or better, in order to obtain +important security fixes. +

      +

      Table of Contents

      + + +

      Credits and License Terms

      + +cgic can be used free of charge, provided that a +credit notice is provided online. Alternatively, +a nonexclusive Commercial License can be purchased, which +grants the right to use cgic without a public credit notice. +

      +Please see the file +license.txt +for the details of the Basic License and Commercial License, +including ordering information for the Commercial License. +

      +Thanks are due to Robert Gustavsson, Ken Holervich, Bob Nestor, +Jon Ribbens, Thomas Strangert, Wu Yongwei, and other CGIC users +who have corresponded over the years. Although the implementation +of multipart/form-data file upload support in CGIC 2.x is my own, +I particularly wish to thank those who submitted their own +implementations of this feature. +

      How to Get Support

      +
      +

      STOP! READ THIS FIRST! REALLY!

      + Are you getting a "server error," indicating that your web server + "cannot allow POST to this URL," or a similar message? YOU MUST + CONFIGURE YOUR WEB SERVER TO ALLOW CGI PROGRAMS, AND YOU MUST + INSTALL CGI PROGRAMS IN THE LOCATION (OR WITH THE EXTENSION) THAT + YOUR WEB SERVER EXPECTS TO SEE. Please don't send me email about + this, unless you wish me to configure your web server for you; I can + certainly do that for $50/hr, but you can probably straighten this out + yourself or have your web server administrator do it. +
      +

      Free Support

      +Please submit support inquiries about CGIC via our contact page. +Please note that we receive a large volume of inquiries and cannot always +respond personally. Sometimes +the response must take the form of an eventual +new release or an addition to a FAQ or other document, as opposed to an +detailed individual response. +

      Hourly Support

      +Those requiring support in detail may arrange for direct support +from the author, Thomas Boutell, at the rate of $50/hr, billed +directly by credit card. To make arrangements, contact us via our +our secure +message page. To avoid delay, be sure to specifically mention +that you wish to purchase CGIC support at the hourly rate above. +

      What's new in version 2.05?

      +Uploaded files properly closed; corrects a resource leak and enables +file uploads to work properly on platforms with particular file +locking semantics. +

      What's new in version 2.04?

      +Documentation fixes: the cgiHtmlEscape, cgiHtmlEscapeData, +cgiValueEscape, and cgiValueEscapeData routines were named +incorrectly in the manual. No code changes in version 2.04. +

      What's new in version 2.03?

      +
        +
      • Support for setting cookies has been reimplemented. The new +code closely follows the actual practice of web sites that successfully +use cookies, rather than attempting to implement the specification. +The new code can successfully set more than one cookie at a time in +typical web browsers. +
      +

      What's new in version 2.02?

      +
        +
      • In CGIC 2.0 and 2.01, if the HTTP_COOKIE environment variable +was exactly equal to the name of a cookie requested with cgiCookieString, +with no value or equal sign or other characters present, a buffer +overrun could take place. This was not normal behavior and it is +unknown whether any actual web server would allow it to occur, however +we have of course released a patch to correct it. +Thanks to Nicolas Tomadakis. +
      • cgiCookieString returned cgiFormTruncated when cgiFormSuccess would +be appropriate. Fixed; thanks to Mathieu Villeneuve-Belair. +
      • Cookies are now set using a simpler Set-Cookie: header, and with +one header line per cookie, based on data collected by Chunfu Lai. +
      • Memory leaks in cgiReadEnvironment fixed by Merezko Oleg. These +memory leaks were not experienced in a normal CGI situation, only +when reading a saved CGI environment. +
      +

      What's new in version 2.01?

      +
        +
      • Makefile supports "make install" +
      • Compiles without warnings under both C and C++ with strict +warnings and strict ANSI compliance enabled +
      • Builds out of the box on Windows (#include <fcntl.h> was needed) +
      • Rare problem in cgiReadEnvironment corrected; no impact on +normal CGI operations +
      • cgiCookieString now sets the result to an empty string +when returning cgiFormNotFound +
      • Minor code cleanups +
      +

      What's new in version 2.0?

      +1. CGIC 2.0 provides support for file upload fields. User-uploaded +files are kept in temporary files, to avoid the use of +excessive swap space (Solaris users may wish to change the +cgicTempDir macro in cgic.c before compiling). +The cgiFormFileName, +cgiFormFileContentType, +cgiFormFileSize, +cgiFormFileOpen, +cgiFormFileRead, and +cgiFormFileClose functions +provide a complete interface to this new functionality. Remember, +the enctype attribute of the form tag +must be set to multipart/form-data when +<input type="file"> tags are used. +

      +2. CGIC 2.0 provides support for setting and examining cookies +(persistent data storage on the browser side). +The cgiCookieString, +and cgiCookieInteger +and cgiCookies +functions retrieve cookies. The +cgiHeaderCookieSetString +and cgiHeaderCookieSetInteger functions set cookies. +

      +3. CGIC 2.0 offers a convenient way to retrieve a list of all form fields. +The new cgiFormEntries +function performs this operation. +

      +4. CGIC 2.0 provides convenience functions to correctly escape +text before outputting it as part of HTML, or as part of the +value of a tag attribute, such as the HREF or +VALUE attribute. See +cgiHtmlEscape, +cgiHtmlEscapeData, +cgiValueEscape and +cgiValueEscapeData. +

      +5. Users have often asked the correct way to determine which submit +button was clicked. This could always be accomplished in previous versions, +but CGIC 2.0 also provides +cgiFormSubmitClicked, +a convenient alternate label for the +cgiFormCheckboxSingle function. +

      What's new in version 1.07?

      +A problem with the cgiFormString and related functions has been +corrected. These functions were previously incorrectly returning cgiFormTruncated +in cases where the returned string fit the buffer exactly. +

      What's new in version 1.06?

      +1. A potentially significant buffer overflow problem has been +corrected. Jon Ribbens correctly pointed out to me (and to the +Internet's bugtraq mailing list) that the cgiFormEntryString +function, which is used directly or indirectly by almost all +CGIC programs, can potentially write past the buffer passed +to it by the programmer. This bug has been corrected. +Upgrading to version 1.06 is strongly recommended. +

      +2. The function cgiSaferSystem() has been +removed entirely. This function escaped only a few metacharacters, +while most shells have many, and there was no way to account for +the many different operating system shells that might be in use +on different operating systems. Since this led to a false sense +of security, the function has been removed. It is our recommendation +that user input should never be passed directly on the command line +unless it has been carefully shown to contain only characters +regarded as safe and appropriate by the programmer. Even then, it is +better to design your utilities to accept their input from standard +input rather than the command line. +

      What's new in version 1.05?

      +Non-exclusive commercial license fee reduced to $200. +

      What's new in version 1.04?

      +For consistency with other packages, the standard Makefile +now produces a true library for cgic (libcgic.a). +

      What's new in version 1.03?

      +Version 1.03 sends line feeds only (ascii 10) to end +Content-type:, Status:, and other HTTP protocol output lines, +instead of CR/LF sequences. The standard specifies CR/LF. +Unfortunately, too many servers reject CR/LF to make +implementation of that standard practical. No server +tested ever rejects LF alone in this context. +

      What's new in version 1.02?

      +Version 1.02 corrects bugs in previous versions: +
        +
      • +cgiFormDoubleBounded specified +its arguments in the wrong order, with surprising results. +This bug has been corrected. +
      • +Many small changes have been made to increase compatibility. +cgic now compiles with no warnings under the compilers +available at boutell.com. +
      +

      What's new in version 1.01?

      +Version 1.01 adds no major functionality but corrects +significant bugs and incompatibilities: +
        +
      • +cgiFormInteger, +cgiFormIntegerBounded, +cgiFormDouble and +cgiFormDoubleBounded now +accept negative numbers properly. They also accept positive +numbers with an explicit + sign. +
      • Hex values containing the digit 9 are +now properly decoded. +
      • cgiFormString now +represents each newline as a single line feed (ascii 10 decimal) +as described in the documentation, not a carriage return +(ascii 13 decimal) as in version 1.0. The latter approach +pleased no one. +
      • cgiFormString and +cgiFormStringNoNewlines +no longer erroneously return cgiFormEmpty in place of +cgiFormSuccess. +
      • The main() function of cgic now flushes standard output +and sleeps for one second before exiting in order to inhibit +problems with the completion of I/O on some platforms. This was +not a cgic bug per se, but has been reported as a common problem +with CGI when used with the CERN server. This change should +improve compatibility. +
      • The single selection example in the testform.html +example now works properly. This was an error in the +form itself, not cgic. +
      • cgiRemoteUser and +cgiRemoteIdent are now +documented accurately. They were reversed earlier. +
      +

      What is cgic?

      +cgic is an ANSI C-language library for the creation of CGI-based +World Wide Web applications. For basic information about +the CGI standard, see the +CGI documentation at NCSA. +

      +cgic performs the following tasks: +

        +
      • Parses form data, correcting for defective and/or inconsistent browsers +
      • Transparently accepts both GET and POST form data +
      • Accepts uploaded files as well as regular form fields +
      • Provides functions to set and retrieve "cookies" +(browser-side persistent information) +
      • Handles line breaks in form fields in a consistent manner +
      • Provides string, integer, floating-point, and single- and +multiple-choice functions to retrieve form data +
      • Provides bounds checking for numeric fields +
      • Loads CGI environment variables into C strings which are always non-null +
      • Provides a way to capture CGI situations for replay in a debugging +environment, including file uploads and cookies +
      +

      +cgic is compatible with any CGI-compliant server environment, and +compiles without modification in Posix/Unix/Linux and Windows +environments. +

      Obtaining cgic

      +cgic is distributed via the web in two forms: as a Windows-compatible +.ZIP file, and as a gzipped tar file. Most users of Windows and +related operating systems have access to 'unzip' or 'pkunzip'. All modern Unix +systems come with 'gunzip' and 'tar' as standard equipment, and gzip/gunzip +is not difficult to find if yours does not. Versions +of these programs for other operating systems are widely +available if you do not already have them. +

      +Important: to use cgic, you will need an ANSI-standard +C compiler. Under Unix, just obtain and use gcc. Most Unix systems have +standardiszed on gcc. Users of Windows operating systems should not have +ANSI C-related problems as all of the popular compilers follow the ANSI +standard. +

      +Note for Windows Programmers: you must use a modern +32-bit compiler. Visual C++ 2.0 or higher, Borland C++ and the +mingw32 gcc compiler are all appropriate, as is cygwin. Do +NOT use an ancient 16-bit DOS executable compiler, please. +

      +

      What Operating System Does Your WEB SERVER Run?

      +Remember, the computer on your desk is usually NOT your web server. +Compiling a Windows console executable will not give you a CGI program that +can be installed on a Linux-based server. +
      +Your web browser should inquire whether to save the file to disk +when you select one of the links below. Under Unix and compatible +operating systems, save it, then issue the following +commands to unpack it: +
      +gunzip cgic205.tar.gz
+tar -xf cgic205.tar
+
      +This should produce the subdirectory 'cgic205', which will contain +the complete cgic distribution for version 2.05, including a copy of this +documentation in the file cgic.html. +

      +Under Windows and compatible operating systems, save it, +open a console ("DOS") window, and issue the following commands to unpack it: +

      +unzip /d cgic205.zip
+
      +Or use the unzip utility of your choice. +

      +This command also produces the subdirectory 'cgic205', which will contain +the complete cgic distribution for version 2.0, including a copy of this +documentation in the file cgic.html. +

      +cgic is available via the web from www.boutell.com: +

      +

      Building cgic: a sample application

      +The sample application 'cgictest.c' is provided as part of the +cgic distribution. This CGI program displays an input form, +accepts a submission, and then displays what was submitted. +In the process essentially all of cgic's features are tested. +

      +On a Unix system, you can build cgictest simply by typing +'make cgictest.cgi'. cgic.c and cgictest.c will be compiled and linked +together to produce the cgictest application. Under non-Unix +operating systems, you will need to create and compile an appropriate +project containing the files cgic.c and cgictest.c. +

      +IMPORTANT: after compiling cgictest.cgi, you will +need to place it in a location on your server system which is +designated by your server administrator as an appropriate location +for CGI scripts. Some servers are configured to recognize any +file ending in .cgi as a CGI program when it is found in any +subdirectory of the server's web space, but this is not always +the case! The right locations for CGI +programs vary greatly from one server to another. Resolving +this issue is between you, your web server administrator, +and your web server documentation. Before submitting a bug +report for cgic, make certain that the CGI example programs +which came with your server do work for you. Otherwise +it is very likely that you have a server configuration problem. +

      +Once you have moved cgictest.cgi (or cgictest.exe, under Windows) +to an appropriate cgi directory, +use the web browser of your choice to access the URL at which +you have installed it +(for instance, www.mysite.com/cgi-bin/cgictest.cgi). +Fill out the various fields in any manner you wish, then +select the SUBMIT button. +

      +If all goes well, cgictest.cgi will respond with a page which +indicates the various settings you submitted. If not, +please reread the section above regarding the correct location in +which to install your CGI program on your web server. +

      What to do if it won't compile

      +
        +
      • Are you using Visual C++ or Borland C++? Did you forget to add +cgic.c to your project? +
      • Make sure you are using an ANSI C or C++ compiler. +(All of the Windows compilers are ANSI C compliant.) +
      +If none of the above proves effective, please see the +section regarding support. +

      How to write a cgic application

      +Note: All cgic applications must be linked to the cgic.c module +itself. How to do this depends on your operating system; under Unix, +just use the provided Makefile as an example. +

      +Since all CGI applications must perform certain initial +tasks, such as parsing form data and examining +environment variables, the cgic library provides its +own main() function. When you write applications that +use cgic, you will begin your own programs by writing +a cgiMain() function, which cgic will invoke when +the initial cgi work has been successfully completed. Your +program must also be sure to #include the file cgic.h. +

      +Important: if you write your own main() +function, your program will not link properly. Your own +code should begin with cgiMain(). The library +provides main() for you. (Those who prefer different behavior +can easily modify cgic.c.) +

      +Consider the cgiMain function of cgictest.c: +

      +

      +int cgiMain() {
+#ifdef DEBUG
+  LoadEnvironment();
+#endif /* DEBUG */
+  /* Load a previously saved CGI scenario if that button
+    has been pressed. */
+  if (cgiFormSubmitClicked("loadenvironment") == cgiFormSuccess) {
+    LoadEnvironment();
+  }
+  /* Set any new cookie requested. Must be done *before*
+    outputting the content type. */
+  CookieSet();
+  /* Send the content type, letting the browser know this is HTML */
+  cgiHeaderContentType("text/html");
+  /* Top of the page */
+  fprintf(cgiOut, "<HTML><HEAD>\n");
+  fprintf(cgiOut, "<TITLE>cgic test</TITLE></HEAD>\n");
+  fprintf(cgiOut, "<BODY><H1>cgic test</H1>\n");
+  /* If a submit button has already been clicked, act on the 
+    submission of the form. */
+  if ((cgiFormSubmitClicked("testcgic") == cgiFormSuccess) ||
+    cgiFormSubmitClicked("saveenvironment") == cgiFormSuccess)
+  {
+    HandleSubmit();
+    fprintf(cgiOut, "<hr>\n");
+  }
+  /* Now show the form */
+  ShowForm();
+  /* Finish up the page */
+  fprintf(cgiOut, "</BODY></HTML>\n");
+  return 0;
+}
+
      +Note the DEBUG #ifdef. If DEBUG is defined at compile time, either by +inserting the line "#define DEBUG 1" into the program or by setting +it in the Makefile or other development environment, then the +LoadEnvironment function is invoked. This function calls +cgiReadEnvironment() +to restore a captured CGI environment for debugging purposes. See +also the discussion of the capture program, which is +provided for use in CGI debugging. Because this is a test program, +the cgiFormSubmitClicked function is +also called to check for the use of a button that requests the reloading +of a saved CGI environment. A completed CGI program typically would +never allow the end user to make that decision. +

      Setting Cookies

      +Next, one of the cgiHeader functions should be called. +This particular program demonstrates many features, including +the setting of cookies. If the programmer wishes to set a cookie, +the cookie-setting function must be called +first, before other headers are output. This is done by the +CookieSet() function of cgictest.c: +
      +void CookieSet()
+{
+  char cname[1024];
+  char cvalue[1024];
+  /* Must set cookies BEFORE calling 
+    cgiHeaderContentType */
+  cgiFormString("cname", cname, sizeof(cname));  
+  cgiFormString("cvalue", cvalue, sizeof(cvalue));  
+  if (strlen(cname)) {
+    /* Cookie lives for one day (or until 
+      browser chooses to get rid of it, which 
+      may be immediately), and applies only to 
+      this script on this site. */  
+    cgiHeaderCookieSetString(cname, cvalue,
+      86400, cgiScriptName, cgiServerName);
+  }
+}
+
      +Since this is a test program, the cgiFormString +function is used to fetch the name and value from the form previously filled +in by the user. Normally, cookie names and values are chosen to meet the +needs of the programmer and provide a means of identifying the same +user again later. +

      +The cgiHeaderCookieSetString +function sets the cookie by requesting that the web browser store it. +There is never any guarantee that this will happen! +Many browsers reject cookies completely; others do not necessarily keep +them as long as requested or return them with their values intact. +Always code defensively when using cookies. +

      +The cname and cvalue parameters are of course the namd and value for +the cookie. The third argument is the time, in seconds, that the +cookie should "live" on the browser side before it expires; in this +case it has been set to 86,400 seconds, which is exactly one day. +The browser may or may not respect this setting, as with everything +else about cookies. +

      +The fourth argument identifies the "path" within the web site for which +the cookie is considered valid. A cookie that should be sent back +for every access to the site should be set with a path of /. +In this case the cookie is relevant only to the CGI program itself, so +cgiScriptName (the URL of the CGI program, not including the +domain name) is sent. Similarly, a cookie can be considered relevant +to a single web site or to an entire domain, such as +www.boutell.com or the entire .boutell.com +domain. In this case, the current site on which the program is running +is the only relevant site, so cgiServerName is used +as the domain. +

      Outputting the Content Type Header

      +Next, cgiHeaderContentType() is +called to indicate the MIME type of the document being output, in this case +"text/html" (a normal HTML document). A few other common MIME types are +"image/gif", "image/jpeg" and "audio/wav". +

      +Note that cgiHeaderStatus() or +cgiHeaderLocation() could have +been invoked instead to output an error code or redirect the +request to a different URL. Only one of the cgiHeader functions +should be called in a single execution of the program. +

      +Important: one of the cgiHeader functions, +usually cgiHeaderContentType(), +must be invoked before outputting any other +response to the user. Otherwise, the result will not be a valid +document and the browser's behavior will be unpredictable. +You may, of course, output your own ContentType and other +header information to cgiOut if you prefer. The cgiHeader functions +are provided as a convenience. +

      Handling Form Submissions

      +Like many CGI programs, cgictest makes decisions about the way it +should behave based on whether various submit buttons have been clicked. +When either the testcgic or saveenvironment button is present, cgictest +invokes the HandleSubmit function, which invokes additional functions to +handle various parts of the form: +
      +void HandleSubmit()
+{
+  Name();
+  Address();
+  Hungry();
+  Temperature();
+  Frogs();
+  Color();
+  Flavors();
+  NonExButtons();
+  RadioButtons();
+  File();
+  Entries();
+  Cookies();
+  /* The saveenvironment button, in addition to submitting 
+    the form, also saves the resulting CGI scenario to 
+    disk for later replay with the 'load saved environment' 
+    button. */
+  if (cgiFormSubmitClicked("saveenvironment") == cgiFormSuccess) {
+    SaveEnvironment();
+  }
+}
+
      +

      Handling Text Input

      +The Name() function of cgictest is shown below, in its simplest +possible form: +
      +void Name() {
+        char name[81];
+        cgiFormStringNoNewlines("name", name, 81);
+        fprintf(cgiOut, "Name: ");
+        cgicHtmlEscape(name);
+        fprintf(cgiOut, "
      \n");
+}
+
      +The purpose of this function is to retrieve and display the name that was +input by the user. Since the programmer has decided that names should +be permitted to have up to 80 characters, a buffer of 81 characters +has been declared (allowing for the final null character). +The cgiFormStringNoNewlines() +function is then invoked to retrieve the name and ensure that +carriage returns are not present in the name (despite the +incorrect behavior of some web browsers). The first argument +is the name of the input field in the form, the second argument +is the buffer to which the data should be copied, and the third +argument is the size of the buffer. cgic will never write beyond +the size of the buffer, and will always provide a null-terminated +string in response; if the buffer is too small, the string will +be shortened. If this is not acceptable, the +cgiFormStringSpaceNeeded() +function can be used to check the amount of space needed; the +return value of cgiFormStringNoNewlines() can also be checked +to determine whether truncation occurred. See +the full description of +cgiFormStringNoNewlines(). +

      Handling Output

      +Note that Name() writes its HTML output to cgiOut, not +to stdout. +

      +The actual name submitted by the user may or may not contain +characters that have special meaning in HTML, specifically the +the <, >, and & characters. +The cgiHtmlEscape function is used to output +the user-entered name with any occurrences of these characters +correctly escaped as &lt;, &gt;, +and &amp;. +

      +Important: cgiOut is normally equivalent +to stdout, and there is no performance penalty for using it. +It is recommended that you write output to cgiOut to ensure compatibility +with modified versions of the cgic library for special +environments that do not provide stdin and stdout for +each cgi connection. +

      +Note that, for text input areas in which carriage returns are +desired, the function cgiFormString +should be used instead. cgiFormString ensures that line breaks +are always represented by a single carriage return (ascii decimal 13), +making life easier for the programmer. See the source code to +the Address() function of cgictest.c for an example. +

      Handling Single Checkboxes

      +Consider the Hungry() function, which determines whether +the user has selected the "hungry" checkbox: +
      +void Hungry() {
+        if (cgiFormCheckboxSingle("hungry") == cgiFormSuccess) {
+                fprintf(cgiOut, "I'm Hungry!<BR>\n");
+        } else {
+                fprintf(cgiOut, "I'm Not Hungry!<BR>\n");
+        }
+}
+
      +This function takes advantage of the +cgiFormCheckboxSingle() function, which +determines whether a single checkbox has been selected. +cgiFormCheckboxSingle() accepts the name attribute of the checkbox +as its sole argument and returns +cgiFormSuccess if the checkbox is selected, or +cgiFormNotFound if it is not. +If multiple checkboxes with the same name are in use, +consider the +cgiFormCheckboxMultiple() and +cgiFormStringMultiple() +functions. +

      Handling Numeric Input

      +Now consider the Temperature() function, which retrieves +a temperature in degrees (a floating-point value) and ensures +that it lies within particular bounds: +
      +void Temperature() {
+        double temperature;
+        cgiFormDoubleBounded("temperature", &temperature, 80.0, 120.0, 98.6);
+        fprintf(cgiOut, "My temperature is %f.<BR>\n", temperature);
+}
+
      +The temperature is retrieved by the function +cgiFormDoubleBounded(). The first +argument is the name of the temperature input field in the form; +the second argument points to the address of the variable that will +contain the result. The next two arguments are the lower and upper +bounds, respectively. The final argument is the default value to +be returned if the user did not submit a value. +

      +This function always retrieves a reasonable value within the +specified bounds; values above or below bounds are constrained +to fit the bounds. However, the return value of +cgiFormDoubleBounded can be checked to make sure the +actual user entry was in bounds, not blank, and so forth; +see the description of +cgiFormDoubleBounded() for more details. If bounds checking +is not desired, consider using +cgiFormDouble() instead. +

      +Note that, for integer input, the functions +cgiFormInteger and +cgiFormIntegerBounded +are available. The behavior of these functions is similar to +that of their floating-point counterparts above. +

      Handling Single-Choice Input

      +The <SELECT> tag of HTML is used to provide the user with +several choices. Radio buttons and checkboxes can also be used +when the number of choices is relatively small. Consider +the Color() function of cgictest.c: +
      +char *colors[] = {
+        "Red",
+        "Green",
+        "Blue"
+};
+
+void Color() {
+        int colorChoice;
+        cgiFormSelectSingle("colors", colors, 3, &colorChoice, 0);
+        fprintf(cgiOut, "I am: %s<BR>\n", colors[colorChoice]);
+}
+
      +This function determines which of several colors the user chose +from a <SELECT> list in the form. An array of colors is +declared; the cgiFormSelectSingle() +function is then invoked to determine which, if any, of those choices +was selected. The first argument indicates the name of the input +field in the form. The second argument points to the list of +acceptable colors. The third argument indicates the number of +entries in the color array. The fourth argument points to the +variable which will accept the chosen color, and the last argument +indicates the index of the default value to be set if no +selection was submitted by the browser. +

      +cgiFormSelectSingle() will +always indicate a reasonable selection value. However, if +the programmer wishes to know for certain that a value was +actually submitted, that the value submitted was a legal +response, and so on, the return value of cgiFormSelectSingle() +can be consulted. See the full description of +cgiFormSelectSingle() for +more information. +

      +Note that radio button groups and <SELECT> lists can both +be handled by this function. If you are processing radio +button groups, you may prefer to invoke +cgiFormRadio(), which functions +identically. +

      +"What if I won't know the acceptable choices at runtime?" +

      +If the acceptable choices aren't known until runtime, +one can simply load the choices from disk. But if the acceptable +choices aren't fixed at all (consider a list of country names; +new names may be added to the form at any time and it is +inconvenient to also update program code or a separate list +of countries), simply invoke +cgiFormStringNoNewlines() +instead to retrieve the string directly. Keep in mind that, if +you do so, validating the response to make sure it is +safe and legitimate becomes a problem for your own +program to solve. The advantage of cgiFormSelectSingle() is that invalid +responses are never returned. +

      +To handle multiple-selection <SELECT> lists and +groups of checkboxes with the same name, see the +discussion of the NonExButtons() function of cgictest.c, immediately below. +

      Handling Multiple-Choice Input

      +Consider the first half of the NonExButtons() function of cgictest.c: +
      +char *votes[] = {
+  "A",
+  "B",
+  "C",
+  "D"
+};
+
+void NonExButtons() {
+  int voteChoices[4];
+  int i;
+  int result;  
+  int invalid;
+
+  char **responses;
+
+  /* Method #1: check for valid votes. This is a good idea,
+    since votes for nonexistent candidates should probably
+    be discounted... */
+  fprintf(cgiOut, "Votes (method 1):<BR>\n");
+  result = cgiFormCheckboxMultiple("vote", votes, 4, 
+    voteChoices, &invalid);
+  if (result == cgiFormNotFound) {
+    fprintf(cgiOut, "I hate them all!<p>\n");
+  } else {  
+    fprintf(cgiOut, "My preferred candidates are:\n");
+    fprintf(cgiOut, "<ul>\n");
+    for (i=0; (i < 4); i++) {
+      if (voteChoices[i]) {
+        fprintf(cgiOut, "<li>%s\n", votes[i]);
+      }
+    }
+    fprintf(cgiOut, "</ul>\n");
+  }
+
      +This function takes advantage of +cgiFormCheckboxMultiple(), +which is used to identify one or more selected checkboxes with +the same name. This function performs identically to +cgiFormSelectMultiple(). +That is, <SELECT> tags with the MULTIPLE attribute are handled +just like a group of several checkboxes with the same name. +

      +The first argument to +cgiFormCheckboxMultiple() is the name given to all +checkbox input fields in the group. The second argument +points to an array of legitimate values; these should +correspond to the VALUE attributes of the checkboxes +(or OPTION tags in a <SELECT> list). The third argument +indicates the number of entries in the array of +legitimate values. The fourth argument points to +an array of integers with the same number of entries +as the array of legitimate values; each entry +will be set true if that checkbox or option was selected, +false otherwise. +

      +The last argument points to an integer which will be set to the +number of invalid responses (responses not in the array of +valid responses) that were submitted. If this value is not +of interest, the last argument may be a null pointer (0). +

      +Note that the return value of cgiFormCheckboxMultiple is +inspected to determine whether any choices at all were +set. See the full description of +cgiFormCheckboxMultiple +for other possible return values. +

      +"What if I won't know the acceptable choices at runtime?" +

      +If the acceptable choices aren't known until runtime, +one can simply load the choices from disk. But if the acceptable +choices aren't fixed at all (consider a list of ice cream flavors; +new names may be added to the form at any time and it is +inconvenient to also update program code or a separate list +of countries), a more dynamic approach is needed. Consider +the second half of the NonExButtons() function of cgictest.c: +

      +  /* Method #2: get all the names voted for and trust them.
+    This is good if the form will change more often
+    than the code and invented responses are not a danger
+    or can be checked in some other way. */
+  fprintf(cgiOut, "Votes (method 2):<BR>\n");
+  result = cgiFormStringMultiple("vote", &responses);
+  if (result == cgiFormNotFound) {  
+    fprintf(cgiOut, "I hate them all!<p>\n");
+  } else {
+    int i = 0;
+    fprintf(cgiOut, "My preferred candidates are:\n");
+    fprintf(cgiOut, "<ul>\n");
+    while (responses[i]) {
+      fprintf(cgiOut, "<li>%s\n", responses[i]);
+      i++;
+    }
+    fprintf(cgiOut, "</ul>\n");
+  }
+  /* We must be sure to free the string array or a memory
+    leak will occur. Simply calling free() would free
+    the array but not the individual strings. The
+    function cgiStringArrayFree() does the job completely. */  
+  cgiStringArrayFree(responses);
+}
+
      +This code excerpt demonstrates an alternate means of retrieving +a list of choices. The function +cgiFormStringMultiple() is used +to retrieve an array consisting of all the strings submitted +for with a particular input field name. This works both for +<SELECT> tags with the MULTIPLE attribute and for +groups of checkboxes with the same name. +

      +The first argument to +cgiFormStringMultiple() is the name of the input field or +group of input fields in question. The second argument should +be the address of a pointer to a pointer to a string, which +isn't as bad as it sounds. Consider the following simple call +of the function: +

      +/* An array of strings; each C string is an array of characters */
+char **responses; 
+
+cgiFormStringMultiple("vote", &responses);
+
      +"How do I know how many responses there are?" +

      +After the call, the last entry in the string array will be +a null pointer. Thus the simple loop: +

      +int i = 0;
+while (responses[i]) {
+  /* Do something with the string responses[i] */
+  i++;
+}
+
      +can be used to walk through the array until the last +entry is encountered. +

      +Important: the +cgiFormStringMultiple function +returns a pointer to allocated memory. Your code +should not modify the strings in the responses array or the responses +array itself; if modification is needed, the strings should be +copied. When your code is done examining the responses array, +you MUST call +cgiStringArrayFree() with the array as an argument to free the memory +associated with the array. Otherwise, the memory will not be available +again until the program exists. Don't just call the +free() function; if you do, the individual strings will not be freed. +

      Accessing Uploaded Files

      +CGIC provides functions to access files that have been uploaded +as part of a form submission. IMPORTANT: you MUST set +the enctype attribute of your form tag +to multipart/form-data for this feature to work! For an +example, see the ShowForm function of +cgictest.c, examined below. +

      +The File function of cgictest.c takes care of +receiving uploaded files: +

      +void File()
+{
+  cgiFilePtr file;
+  char name[1024];
+  char contentType[1024];
+  char buffer[1024];
+  int size;
+  int got;
+  if (cgiFormFileName("file", name, sizeof(name)) != 
+    cgiFormSuccess) 
+  {
+    printf("<p>No file was uploaded.<p>\n");
+    return;
+  } 
+        fprintf(cgiOut, "The filename submitted was: ");
+        cgiHtmlEscape(name);
+        fprintf(cgiOut, "<p>\n");
+        cgiFormFileSize("file", &size);
+        fprintf(cgiOut, "The file size was: %d bytes<p>\n", size);
+        cgiFormFileContentType("file", contentType, sizeof(contentType));
+        fprintf(cgiOut, "The alleged content type of the file was: ");
+        cgiHtmlEscape(contentType);
+        fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "Of course, this is only the claim the browser "
+    "made when uploading the file. Much like the filename, "
+    "it cannot be trusted.<p>\n");
+  fprintf(cgiOut, "The file's contents are shown here:<p>\n");
+  if (cgiFormFileOpen("file", &file) != cgiFormSuccess) {
+    fprintf(cgiOut, "Could not open the file.<p>\n");
+    return;
+  }
+  fprintf(cgiOut, "<pre>\n");
+  while (cgiFormFileRead(file, buffer, sizeof(buffer), &got) ==
+    cgiFormSuccess)
+  {
+    cgiHtmlEscapeData(buffer, got);
+  }
+  fprintf(cgiOut, "</pre>\n");
+  cgiFormFileClose(file);
+}
+
      +First, the File function checks to determine the filename that was +submitted by the user. VERY IMPORTANT: this filename may or +may not bear any relation to the real name of the file on the user's +computer, may be deliberately manipulated with malicious intent, +and should not be used for any purpose unless you have +determined that its content is safe for your intended use and will not, +at the very least, overwrite another file of importance to you, especially if +you intend to use it as a file name on the server side. The cgic library +itself does not use this file name for temporary storage. +

      +If the cgiFormFileName function does +not succeed, no file was uploaded. +

      +Next, the cgiFormFileSize function is called +to determine the size of the uploaded file, in bytes. +

      +The File function then proceeds to query the content type of the uploaded +file. Files uploaded by the user have their own content type information, +which may be useful in determining whether the file is an image, HTML document, +word processing document, or other type of file. However, +as with the filename and any other claim made by the browser, +this information should not be blindly trusted. The browser +may upload a file with the name picture.jpg and the +content type image/jpeg, but this does not guarantee that the +actual file will contain a valid JPEG image suitable for display. +

      +The content type submitted by the browser can be queried using the +cgiFormFileContentType function. +

      +Of course, CGIC also provides access to the actual uploded file. +First, the programmer calls cgiFormFileOpen, +passing the address of a cgiFilePtr object. If this function +succeeds, the cgiFilePtr object becomes valid, and can be +used in subsequent calls to cgiFormFileRead. +Notice that the number of bytes read may be less than the number requested, +in particular on the last successful call before cgiFormFileRead begins +to return cgiFormEOF. When cgiFormFileRead no longer returns +cgiFormSuccess, +the programmer calls cgiFormFileClose to +release the cgiFilePtr object. +

      +The uploaded file data may contain anything, including binary data, +null characters, and so on. The example program uses the +cgiHtmlEscapeData function to output the +data with any special characters that have meaning in HTML escaped. +Most programs will save the uploaded information to a server-side file or +database. +

      Fetching All Form Entries

      +From time to time, the programmer may not know the names of all +form fields in advance. In such situations it is convenient to +use the cgiFormEntries function. +The Entries function of cgictest.c demonstrates the use of +cgiFormEntries: +
      +void Entries()
+{
+        char **array, **arrayStep;
+        fprintf(cgiOut, "List of All Submitted Form Field Names:<p>\n");
+        if (cgiFormEntries(&array) != cgiFormSuccess) {
+                return;
+        }
+        arrayStep = array;
+        fprintf(cgiOut, "<ul>\n");
+        while (*arrayStep) {
+                fprintf(cgiOut, "<li>");
+                cgiHtmlEscape(*arrayStep);
+                fprintf(cgiOut, "\n");
+                arrayStep++;
+        }
+        fprintf(cgiOut, "</ul>\n");
+        cgiStringArrayFree(array);
+}
+
      +The cgiFormEntries function retrieves an array of form field names. +This array consists of pointers to strings, with a final null pointer +to mark the end of the list. The above code illustrates one way of +looping through the returned strings. Note the final call to +cgiStringArrayFree, which is +essential in order to return the memory used to store the strings +and the string array. +

      Retrieving Cookies

      +The Cookies function of cgictest.c displays a list of all cookies +submitted by the browser with the current form submission, along +with their values: +
      +void Cookies()
+{
+  char **array, **arrayStep;
+  char cname[1024], cvalue[1024];
+  fprintf(cgiOut, "Cookies Submitted On This Call, With Values "
+    "(Many Browsers NEVER Submit Cookies):<p>\n");
+  if (cgiCookies(&array) != cgiFormSuccess) {
+    return;
+  }
+  arrayStep = array;
+  fprintf(cgiOut, "<table border=1>\n");
+  fprintf(cgiOut, "<tr><th>Cookie<th>Value</tr>\n");
+  while (*arrayStep) {
+    char value[1024];
+    fprintf(cgiOut, "<tr>");
+    fprintf(cgiOut, "<td>");
+    cgiHtmlEscape(*arrayStep);
+    fprintf(cgiOut, "<td>");
+    cgiCookieString(*arrayStep, value, sizeof(value));
+    cgiHtmlEscape(value);
+    fprintf(cgiOut, "\n");
+    arrayStep++;
+  }
+  fprintf(cgiOut, "</table>\n");
+  cgiFormString("cname", cname, sizeof(cname));  
+  cgiFormString("cvalue", cvalue, sizeof(cvalue));  
+  if (strlen(cname)) {
+    fprintf(cgiOut, "New Cookie Set On This Call:<p>\n");
+    fprintf(cgiOut, "Name: ");  
+    cgiHtmlEscape(cname);
+    fprintf(cgiOut, "Value: ");  
+    cgiHtmlEscape(cvalue);
+    fprintf(cgiOut, "<p>\n");
+    fprintf(cgiOut, "If your browser accepts cookies "
+      "(many do not), this new cookie should appear "
+      "in the above list the next time the form is "
+      "submitted.<p>\n"); 
+  }
+  cgiStringArrayFree(array);
+}
+
      +VERY IMPORTANT: YOUR BROWSER MIGHT NOT SUBMIT COOKIES, +EVER, REGARDLESS OF WHAT VALUES YOU ENTER INTO THE TEST FORM. +Many, many browsers are configured not to accept or send cookies; +others are configured to send them as little as possible to meet the +bare minimum requirements for entry into popular sites. Users will often +refuse your cookies; make sure your code still works in that situation! +

      +The above code uses the cgiCookies function +to retrieve a list of all currently set cookies as a null-terminated +array of strings. The cgiCookieString +function is then used to fetch the value associated with each cookie; +this function works much like cgiFormString, +discussed earlier. Note that a cookie set as a part of the current +form submission process does not appear on this list immediately, as +it has not yet been sent back by the browser. It should appear on +future submissions, provided that the browser chooses to accept +and resend the cookie at all. +

      Displaying a Form That Submits to the Current Program

      +CGI programmers often need to display HTML pages as part of the output +of CGI programs; these HTML pages often contain forms which should submit +fields back to the same program they came from. Provided that your +web server is well-configured, this can be done conveniently using +the cgiScriptName environment variable, as shown below. Here is the +source code of the ShowForm function of cgictest.c: +
      +void ShowForm()
+{
+  fprintf(cgiOut, "<!-- 2.0: multipart/form-data is required 
+    "for file uploads. -->");
+  fprintf(cgiOut, "<form method=\"POST\" "
+    "enctype=\"multipart/form-data\" ");
+  fprintf(cgiOut, "  action=\"");
+  cgiValueEscape(cgiScriptName);
+  fprintf(cgiOut, "\">\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "Text Field containing Plaintext\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "<input type=\"text\" name=\"name\">Your Name\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "Multiple-Line Text Field\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "<textarea NAME=\"address\" ROWS=4 COLS=40>\n");
+  fprintf(cgiOut, "Default contents go here. \n");
+  fprintf(cgiOut, "</textarea>\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "Checkbox\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "<input type=\"checkbox\" name=\"hungry\" checked>Hungry\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "Text Field containing a Numeric Value\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "<input type=\"text\" name=\"temperature\" value=\"98.6\">\n");
+  fprintf(cgiOut, "Blood Temperature (80.0-120.0)\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "Text Field containing an Integer Value\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "<input type=\"text\" name=\"frogs\" value=\"1\">\n");
+  fprintf(cgiOut, "Frogs Eaten\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "Single-SELECT\n");
+  fprintf(cgiOut, "<br>\n");
+  fprintf(cgiOut, "<select name=\"colors\">\n");
+  fprintf(cgiOut, "<option value=\"Red\">Red\n");
+  fprintf(cgiOut, "<option value=\"Green\">Green\n");
+  fprintf(cgiOut, "<option value=\"Blue\">Blue\n");
+  fprintf(cgiOut, "</select>\n");
+  fprintf(cgiOut, "<br>\n");
+  fprintf(cgiOut, "Multiple-SELECT\n");
+  fprintf(cgiOut, "<br>\n");
+  fprintf(cgiOut, "<select name=\"flavors\" multiple>\n");
+  fprintf(cgiOut, "<option value=\"pistachio\">Pistachio\n");
+  fprintf(cgiOut, "<option value=\"walnut\">Walnut\n");
+  fprintf(cgiOut, "<option value=\"creme\">Creme\n");
+  fprintf(cgiOut, "</select>\n");
+  fprintf(cgiOut, "<p>Exclusive Radio Button Group: Age of "
+    "Truck in Years\n");
+  fprintf(cgiOut, "<input type=\"radio\" name=\"age\" "
+    "value=\"1\">1\n");
+  fprintf(cgiOut, "<input type=\"radio\" name=\"age\" "
+    "value=\"2\">2\n");
+  fprintf(cgiOut, "<input type=\"radio\" name=\"age\" "
+    "value=\"3\" checked>3\n");
+  fprintf(cgiOut, "<input type=\"radio\" name=\"age\" "
+    "value=\"4\">4\n");
+  fprintf(cgiOut, "<p>Nonexclusive Checkbox Group: "
+    "Voting for Zero through Four Candidates\n");
+  fprintf(cgiOut, "<input type=\"checkbox\" name=\"vote\" "
+    "value=\"A\">A\n");
+  fprintf(cgiOut, "<input type=\"checkbox\" name=\"vote\" "
+    "value=\"B\">B\n");
+  fprintf(cgiOut, "<input type=\"checkbox\" name=\"vote\" "
+    "value=\"C\">C\n");
+  fprintf(cgiOut, "<input type=\"checkbox\" name=\"vote\" "
+    "value=\"D\">D\n");
+  fprintf(cgiOut, "<p>File Upload:\n");
+  fprintf(cgiOut, "<input type=\"file\" name=\"file\" "
+    "value=\"\"> (Select A Local File)\n");
+  fprintf(cgiOut, "<p>\n");
+  fprintf(cgiOut, "<p>Set a Cookie<p>\n");
+  fprintf(cgiOut, "<input name=\"cname\" "
+    "value=\"\"> Cookie Name\n");
+  fprintf(cgiOut, "<input name=\"cvalue\" "
+    "value=\"\"> Cookie Value<p>\n");
+  fprintf(cgiOut, "<input type=\"submit\" "
+    "name=\"testcgic\" value=\"Submit Request\">\n");
+  fprintf(cgiOut, "<input type=\"reset\" "
+    "value=\"Reset Request\">\n");
+  fprintf(cgiOut, "<p>Save the CGI Environment<p>\n");
+  fprintf(cgiOut, "Pressing this button will submit the form, then "
+    "save the CGI environment so that it can be replayed later "
+    "by calling cgiReadEnvironment (in a debugger, for "
+    "instance).<p>\n");
+  fprintf(cgiOut, "<input type=\"submit\" name=\"saveenvironment\" "
+    "value=\"Save Environment\">\n");
+  fprintf(cgiOut, "</form>\n");
+}
+
      +Note the use of enctype="multipart/form-data" in the +FORM tag. This is absolutely required if the form +will contain file upload fields, as in the above example. Most +browsers will not even attempt file uploads without the +presence of this attribute. +

      Examining CGI environment variables

      +The CGI standard specifies a number of environment variables +which are set by the server. However, servers are somewhat +unpredictable as to whether these variables will be null or +point to empty strings when an environment variable is not set. +Also, in order to allow the programmer to restore saved +CGI environments, the cgic library needs have a way of insulating +the programmer from the actual environment variables. +

      +Instead of calling getenv() to determine the value of a +variable such as HTTP_USER_AGENT (the browser software being used), +always use the +cgic copies of the environment variables, +which are always valid C strings (they are never null, although +they may point to an empty string). For instance, the cgic +variable containing the name of the browser software is +cgiUserAgent. The referring URL appears +in the variable cgiReferrer. +

      How can I generate images from my cgic application?

      +cgic can be used in conjunction with the +gd graphics library, which +can produce GIF images on the fly. +

      +The following short sample program hints at the possibilities: +

      +#include "cgic.h"
+#include "gd.h"
+
+char *colors[] = {
+  "red", "green", "blue"
+};
+
+#define colorsTotal 3
+
+int cgiMain() {
+  int colorChosen;
+  gdImagePtr im;
+  int r, g, b;
+  /* Use gd to create an image */
+  im = gdImageCreate(64, 64);
+  r = gdImageColorAllocate(im, 255, 0, 0);  
+  g = gdImageColorAllocate(im, 0, 255, 0);  
+  b = gdImageColorAllocate(im, 0, 0, 255);  
+  /* Now use cgic to find out what color the user requested */
+  cgiFormSelectSingle("color", 3, &colorChosen, 0);  
+  /* Now fill with the desired color */
+  switch(colorChosen) {
+    case 0:
+    gdImageFill(im, 32, 32, r);
+    break;
+    case 1:
+    gdImageFill(im, 32, 32, g);
+    break;
+    case 2:
+    gdImageFill(im, 32, 32, b);
+    break;
+  }  
+  /* Now output the image. Note the content type! */
+  cgiHeaderContentType("image/gif");
+  /* Send the image to cgiOut */
+  gdImageGif(im, cgiOut);
+  /* Free the gd image */
+  gdImageDestroy(im);
+  return 0;
+}
+
      +Note that this program would need to be linked with both cgic.o +and libgd.a. Often programs of this type respond to one +cgiPathInfo value or set of form fields by returning an HTML page +with an inline image reference that, in turn, generates a GIF image. +

      Debugging CGI applications: using capture

      +Debugging CGI applications can be a painful task. Since CGI applications +run in a special environment created by the web server, it is difficult +to execute them in a debugger. However, the cgic library provides a way +of capturing "live" CGI environments to a file, and also provides a way +to reload saved environments. +

      +The provided program 'capture.c' can be used to capture CGI +environments. Just change the first line of the cgiMain() function +of capture.c to save the CGI environment to a filename appropriate +on your system and type 'make capture'. Then place capture in your +cgi directory and set the form action or other link you want to test +to point to it. When the form submission or other link takes place, +capture will write the CGI environment active at that time to +the filename you specified in the source. The +cgiReadEnvironment() function can then +be invoked on the same filename at the beginning of the cgiMain() function +of the application you want to test in order to restore the captured +environment. You can then execute your program in the debugger of your choice, +and it should perform exactly as it would have performed had +it been launched by the actual web server, including file uploads, +cookies and all other phenomena within the purview of cgic. +

      +Important: Make sure you specify the full path, as the +current working directory of a CGI script may not be what you +think it is! +

      +Even More Important: If you call getenv() yourself +in your code, instead of using the provided +cgic copies of the CGI environment variables, you will +not get the values you expect when running with +a saved CGI environment. Always use the cgic variables instead +of calling getenv(). +

      cgic function reference

      +
      +
      cgiFormResultType cgiFormString( + char *name, char *result, int max) +
      cgiFormString attempts to retrieve the string sent for the + specified input field. The text will be copied into + the buffer specified by result, up to but not + exceeding max-1 bytes; a terminating null is then + added to complete the string. Regardless of the newline + format submitted by the browser, cgiFormString always + encodes each newline as a single line feed (ascii decimal 10); as + a result the final string may be slightly shorter than indicated + by a call to + cgiFormStringSpaceNeeded but will never be longer. + cgiFormString returns cgiFormSuccess if the string was + successfully retrieved, + cgiFormTruncated if the string was + retrieved but was truncated to fit the buffer, + cgiFormEmpty if the string was + retrieved but was empty, and cgiFormNotFound if no + such input field was submitted. In the last case, + an empty string is copied to result. +

      +cgiFormResultType cgiFormStringNoNewlines( + char *name, char *result, int max) +
      +cgiFormStringNoNewlines() is exactly equivalent to + cgiFormString(), except + that any carriage returns or line feeds that occur in the input + will be stripped out. The use of this function is recommended + for single-line text input fields, as some browsers will submit + carriage returns and line feeds when they should not. +

      +cgiFormResultType cgiFormStringSpaceNeeded( + char *name, int *length) +
      +cgiFormStringSpaceNeeded() is used to determine the length of the input text + buffer needed to receive the contents of the specified input field. + This is useful if the programmer wishes to allocate sufficient memory + for input of arbitrary length. The actual length of the string + retrieved by a subsequent call to cgiFormString() may be slightly shorter + but will never be longer than *result. On success, cgiFormStringSpaceNeeded() + sets the value pointed to by length to the number of bytes of data, + including the terminating null, and returns cgiFormSuccess. If no + value was submitted for the specified field, cgiFormStringSpaceNeeded sets + the value pointed to by length to 1 and returns cgiFormNotFound. 1 is + set to ensure space for an empty string (a single null + character) if cgiFormString is called despite the return value. + +

      cgiFormResultType cgiFormStringMultiple( + char *name, char ***ptrToStringArray) +
      cgiFormStringMultiple is useful in the unusual case in which several + input elements in the form have the same name and, for whatever + reason, the programmer does not wish to use the checkbox, radio + button and selection menu functions provided below. This is + occasionally needed if the programmer cannot know + in advance what values might appear in a multiple-selection list + or group of checkboxes on a form. The value pointed to + by result will be set to a pointer to an array of strings; the last + entry in the array will be a null pointer. This array is allocated + by the CGI library. Important: when done working with the array, + you must call cgiStringArrayFree() with the array pointer as the + argument. cgiFormStringMultiple() returns cgiFormSuccess if at least + one occurrence of the name is found, cgiFormNotFound + if no occurrences are found, or cgiFormMemory if not enough + memory is available to allocate the array to be returned. + In all cases except the last, ptrToStringArray is set to point to a + valid array of strings, with the last element in the array being a + null pointer; in the out-of-memory case ptrToStringArray is set to + a null pointer. + +

      cgiFormResultType cgiFormEntries( + char ***ptrToStringArray) +
      cgiFormEntries is useful when the programmer cannot know the names + of all relevant form fields in advance. The value pointed to + by result will be set to a pointer to an array of strings; the last + entry in the array will be a null pointer. This array is allocated + by the CGI library. Important: when done working with the array, + you must call cgiStringArrayFree() with the array pointer as the + argument. cgiFormEntries() returns cgiFormSuccess except in the event of an out of memory error. + On success, ptrToStringArray is set to point to a + valid array of strings, with the last element in the array being a + null pointer; in the out-of-memory case ptrToStringArray is set to + a null pointer, and + cgiFormOutOfMemory is returned. + +

      void cgiStringArrayFree(char **stringArray) + +
      +cgiStringArrayFree() is used to free the memory associated with + a string array created by + cgiFormStringMultiple(), + cgiFormEntries(), or + cgiFormCookies(). +

      cgiFormResultType cgiFormInteger( + char *name, int *result, int defaultV) +
      cgiFormInteger() attempts to retrieve the integer sent for the + specified input field. The value pointed to by result + will be set to the value submitted. cgiFormInteger() returns + cgiFormSuccess if the value was successfully retrieved, + cgiFormEmpty if the value submitted is an empty string, + cgiFormBadType if the value submitted is not an integer, + and cgiFormNotFound if no such input field was submitted. + In the last three cases, the value pointed to by result + is set to the specified default. +

      +cgiFormResultType cgiFormIntegerBounded( + char *name, int *result, int min, int max, int defaultV) +
      cgiFormIntegerBounded() attempts to retrieve the integer sent for the + specified input field, and constrains the result to be within + the specified bounds. The value pointed to by result + will be set to the value submitted. cgiFormIntegerBounded() returns + cgiFormSuccess if the value was successfully retrieved, + cgiFormConstrained if the value was out of bounds and result + was adjusted accordingly, cgiFormEmpty if the value submitted is + an empty string, cgiFormBadType if the value submitted is not an + integer, and cgiFormNotFound if no such input field was submitted. + In the last three cases, the value pointed to by result + is set to the specified default. + +

      cgiFormResultType cgiFormDouble( + char *name, double *result, double defaultV) +
      cgiFormDouble attempts to retrieve the floating-point value sent for + the specified input field. The value pointed to by result + will be set to the value submitted. cgiFormDouble returns + cgiFormSuccess if the value was successfully retrieved, + cgiFormEmpty if the value submitted is an empty string, + cgiFormBadType if the value submitted is not a number, + and cgiFormNotFound if no such input field was submitted. + In the last three cases, the value pointed to by result + is set to the specified default. +

      +cgiFormResultType cgiFormDoubleBounded( + char *name, double *result, double min, double max, + double defaultV) +
      +cgiFormDoubleBounded() attempts to retrieve the floating-point + value sent for the specified input field, and constrains the + result to be within the specified bounds. The value pointed to by + result will be set to the value submitted. cgiFormDoubleBounded() returns + cgiFormSuccess if the value was successfully retrieved, + cgiFormConstrained if the value was out of bounds and result + was adjusted accordingly, cgiFormEmpty if the value submitted is + an empty string, cgiFormBadType if the value submitted is not a + number, and cgiFormNotFound if no such input field was submitted. + In the last three cases, the value pointed to by result + is set to the specified default. + +

      +cgiFormResultType cgiFormSelectSingle( + char *name, char **choicesText, int choicesTotal, + int *result, int defaultV) +
      +cgiFormSelectSingle() retrieves the selection number associated with a + <SELECT> element that does not allow multiple selections. name + should identify the NAME attribute of the <SELECT> element. choicesText + should point to an array of strings identifying each choice; + choicesTotal should indicate the total number of choices. The value + pointed to by result will be set to the position of the actual choice + selected within the choicesText array, if any, or to the value of + default, if no selection was submitted or an invalid selection was + made. cgiFormSelectSingle() returns cgiFormSuccess if the value was + successfully retrieved, cgiFormNotFound if no selection + was submitted, and cgiFormNoSuchChoice if the selection + does not match any of the possibilities in the choicesText array. +
      + +cgiFormResultType cgiFormSelectMultiple( + char *name, char **choicesText, int choicesTotal, + int *result, int *invalid) +
      cgiFormSelectMultiple() retrieves the selection numbers associated with a + <SELECT> element that does allow multiple selections. name should + identify the NAME attribute of the <SELECT> element. choicesText + should point to an array of strings identifying each choice; + choicesTotal should indicate the total number of choices. result + should point to an array of integers with as many elements as there + are strings in the choicesText array. For each choice in the + choicesText array that is selected, the corresponding integer in + the result array will be set to one; other entries in the result + array will be set to zero. cgiFormSelectMultiple() returns cgiFormSuccess + if at least one valid selection was successfully retrieved or + cgiFormNotFound if no valid selections were submitted. + The integer pointed to by invalid is set to the number of + invalid selections that were submitted, which should be zero + unless the form and the choicesText array do not agree. + +

      + +cgiFormResultType cgiFormSubmitClicked( + char *name) +
      +It is often desirable to know whether a particular submit button was clicked, + when multiple submit buttons with different name attributes exist. + cgiFormSubmitClicked is an alternative name for the + cgiFormCheckboxSingle function, + which is suitable for testing whether a particular submit button + was used. +

      + +cgiFormResultType cgiFormCheckboxSingle( + char *name) +
      +cgiFormCheckboxSingle determines whether the checkbox with the specified name + is checked. cgiFormCheckboxSingle returns cgiFormSuccess if the + button is checked, cgiFormNotFound if the checkbox is + not checked. cgiFormCheckboxSingle is intended for single + checkboxes with a unique name; see below for functions to + deal with multiple checkboxes with the same name, and + with radio buttons. + +

      +cgiFormResultType cgiFormCheckboxMultiple( + char *name, char **valuesText, int valuesTotal, + int *result, int *invalid) +
      cgiFormCheckboxMultiple() determines which checkboxes among a group + of checkboxes with the same name are checked. This is distinct + from radio buttons (see cgiFormRadio). + valuesText + should point to an array of strings identifying the VALUE + attribute of each checkbox; valuesTotal should indicate the total + number of checkboxes. result should point to an array of integers with + as many elements as there are strings in the valuesText array. For + each choice in the valuesText array that is selected, the corresponding + integer in the result array will be set to one; other entries in the + result array will be set to zero. cgiFormCheckboxMultiple returns + cgiFormSuccess if at least one valid checkbox was checked or + cgiFormNotFound if no valid checkboxes were checked. + The integer pointed to by invalid is set to the number of + invalid selections that were submitted, which should be zero + unless the form and the valuesText array do not agree. +

      +cgiFormResultType cgiFormRadio( + char *name, char **valuesText, int valuesTotal, + int *result, int defaultV) +
      cgiFormRadio() determines which, if any, of a group of radio boxes with + the same name was selected. valuesText should point to an array of + strings identifying the VALUE attribute of each radio box; + valuesTotal should indicate the total number of radio boxes. The value + pointed to by result will be set to the position of the actual choice + selected within the valuesText array, if any, or to the value of + default, if no radio box was checked or an invalid selection was + made. cgiFormRadio() returns cgiFormSuccess if a checked radio box was + found in the group, cgiFormNotFound if no box was checked, and + cgiFormNoSuchChoice if the radio box submitted does not match any of + the possibilities in the valuesText array. + +
      cgiFormResultType cgiFormFileName( + char *name, char *fileName, int max) +
      cgiFormFileName attempts to retrieve the file name uploaded by the + user for the specified form input field of type file. + NEVER, EVER TRUST THIS FILENAME TO BE REASONABLE AND + SAFE FOR DIRECT USE ON THE SERVER SIDE. + The text will be copied into + the buffer specified by fileName, up to but not + exceeding max-1 bytes; a terminating null is then + added to complete the string. cgiFormFileName returns + cgiFormSuccess if the string was + successfully retrieved and was not empty, + cgiFormNoFileName if the string was + successfully retrieved but empty indicating that no file was uploaded, + cgiFormTruncated if the string was + retrieved but was truncated to fit the buffer, + and cgiFormNotFound if no + such input field was submitted. In the last case, + an empty string is copied to result. +
      cgiFormResultType cgiFormFileSize( + char *name, int *sizeP) +
      cgiFormFileSize attempts to retrieve the size, in bytes, of a + file uploaded by the browser in response to the + input field of type file specified by the + name parameter. On success, the size is stored + to *sizeP, and this function returns + cgiFormSuccess. If the form + field does not exist, this function returns + cgiFormNotFound. + If the form field exists but no file was uploaded, this function + returns cgiFormNotAFile. +
      cgiFormResultType cgiFormFileContentType( + char *name, char *contentType, int max) +
      cgiFormString attempts to retrieve the content name claimed by the + user for the specified form input field of type file. + THERE IS NO GUARANTEE THAT THE CONTENT TYPE WILL BE + ACCURATE. + The content type string will be copied into + the buffer specified by contentType, up to but not + exceeding max-1 bytes; a terminating null is then + added to complete the string. cgiFormFileContentType returns + cgiFormSuccess if the string was + successfully retrieved and was not empty, + cgiFormNoContentType if the string was + successfully retrieved but empty indicating that no file was uploaded + or the browser did not know the content type, + cgiFormTruncated if the string was + retrieved but was truncated to fit the buffer, + and cgiFormNotFound if no + such input field was submitted. In the last case, + an empty string is copied to result. + +
      cgiFormResultType cgiFormFileOpen( + char *name, cgiFilePtr *cfpp) +
      cgiFormFileOpen attempts to open the actual uploaded file data for + the specified form field of type file. Upon success, + this function returns retrieve the content name claimed by the + user for the specified form input field of type file. + On success, this function sets *cfpp to a valid cgiFilePtr + object for use with cgiFormSuccess. + On failure, this function sets *cfpp to a null pointer, and + returns cgiFormNotFound, + cgiFormNotAFile, + cgiFormMemory or + cgiFormIO as appropriate. +

      + See also cgiFormFileRead +and cgiFormFileClose. +

      cgiFormResultType cgiFormFileRead( + cgiFilePtr cfp, char *buffer, int bufferSize, int *gotP) +
      cgiFormFileRead attempts to read up to bufferSize + bytes from a cgiFilePtr object previously opened with + cgiFormFileOpen. If any data + is successfully read, it is copied to buffer, + and the number of bytes successfully read is stored + to *gotP. This function returns + cgiFormSuccess if any data + is successfully read. At end of file, this function + returns cgiFormEOF. In the event + of an I/O error, this function returns + cgiFormIO. If cfp is a null pointer, + this function returns cgiFormOpenFailed. +

      + See also cgiFormFileOpen +and cgiFormFileClose. +

      cgiFormResultType cgiFormFileClose( + cgiFilePtr cfp) +
      cgiFormFileClose closes a cgiFilePtr object previously opened + with cgiFormFileOpen, freeing + memory and other system resources. This + function returns cgiFormSuccess + unless cfp is null, in which case + cgiFormOpenFailed is returned. +

      + See also cgiFormFileOpen +and cgiFormFileRead. +

      +void cgiHeaderLocation(char *redirectUrl) +
      +cgiHeaderLocation() should be called if the programmer wishes to +redirect the user to a different URL. No futher output +is needed in this case. +

      +If you wish to set cookies, +you must make your calls to +cgiHeaderCookieSetString +and +cgiHeaderCookieSetInteger + BEFORE invoking cgiHeaderLocation. +

      +void cgiHeaderStatus(int status, char *statusMessage) +
      +cgiHeaderStatus() should be called if the programmer wishes to +output an HTTP error status code instead of a document. The status +code is the first argument; the second argument is the status +message to be displayed to the user. +

      +If you wish to set cookies, +you must make your calls to +cgiHeaderCookieSetString +and +cgiHeaderCookieSetInteger + BEFORE invoking cgiHeaderStatus. +

      +void cgiHeaderContentType(char *mimeType) +
      +cgiHeaderContentType() should be called if the programmer wishes to +output a new document in response to the user's request. This is +the normal case. The single argument is the MIME document type +of the response; typical values are "text/html" for HTML documents, +"text/plain" for plain ASCII without HTML tags, "image/gif" for +a GIF image and "audio/basic" for .au-format audio. +

      +If you wish to set cookies, +you must make your calls to +cgiHeaderCookieSetString +and +cgiHeaderCookieSetInteger + BEFORE invoking cgiHeaderContentType. +

      +void cgiHeaderCookieSetString(char *name, char *value, + int secondsToLive, char *path, char *domain) +
      +cgiHeaderCookieSetString() should be called when the programmer wishes +to store a piece of information in the user's browser, so that the +stored information is again presented to the server on subsequent +accesses to the relevant site. The first argument is the name of the +cookie to be stored; for best results in all browsers, use a short +name without spaces or unusual punctuation. The second argument is +the value of the cookie to be stored. Again, for best results, use +a short string; it is recommended that cookies be used to store a +unique identifier which is then used to look up more detailed +information in a database on the server side. Attempts to store +elaborate information on the browser side are much more likely to fail. +The third argument is the number of seconds that the cookie should +be kept by the browser; 86400 is a single full day, 365*86400 is +roughly one year. The fourth argument is the partial URL of the +web site within which the cookie is relevant. If the cookie should +be sent to the server for every access to the entire site, +set this argument to /. The final argument is the +web site name or entire domain for which this cookie should be +submitted; if you choose to have the cookie sent back for an +entire domain, this argument must begin with a dot, such as +.boutell.com. The cgic variables cgiServerName are convenient +values for the fourth and fifth arguments. +See also cgiHeaderCookieSetInteger, +cgiCookieString, +cgiCookieInteger and +cgiCookies. +

      +void cgiHeaderCookieSetInteger(char *name, int value, + int secondsToLive, char *path, char *domain) +
      +cgiHeaderCookieSetInteger() is identical to +cgiHeaderCookieSetString, +except that the value to be set is an integer rather than a string. +See cgiHeaderCookieSetString +for complete information. +
      +
      cgiFormResultType cgiCookieString( + char *name, char *result, int max) +
      cgiFormString attempts to retrieve the string sent for the + specified cookie (browser-side persistent storage). The + text will be copied into + the buffer specified by result, up to but not + exceeding max-1 bytes; a terminating null is then + added to complete the string. + cgiCookieString returns cgiFormSuccess if the string was + successfully retrieved, + cgiFormTruncated if the string was + retrieved but was truncated to fit the buffer, + cgiFormEmpty if the string was + retrieved but was empty, and cgiFormNotFound if no + such cookie was submitted. In the last case, + an empty string is copied to result. +

      cgiFormResultType cgiCookieInteger( + char *name, int *result, int defaultV) + See also cgiCookieInteger, + cgiCookies, + cgiHeaderCookieSetInteger. +
      cgiCookieInteger() attempts to retrieve the integer sent for the + specified cookie (browser-side persistent storage). The value + pointed to by result will be set to the value submitted. + cgiCookieInteger() returns + cgiFormSuccess if the value was successfully retrieved, + cgiFormEmpty if the value submitted is an empty string, + cgiFormBadType if the value submitted is not an integer, + and cgiFormNotFound if no such + input field was submitted. In the last three cases, the value + pointed to by result is set to the specified default. + See also cgiCookieString, + cgiCookies, + cgiHeaderCookieSetInteger. +

      cgiFormResultType cgiCookies( + char *name, char ***ptrToStringArray) +
      cgiCookies is useful when the programmer cannot know the names + of all relevant cookies (browser-side persistent strings) in advance. + The value pointed to by result will be set to a pointer to an array + of strings; the last + entry in the array will be a null pointer. This array is allocated + by the CGI library. Important: when done working with the array, + you must call cgiStringArrayFree() with the array pointer as the + argument. cgiCookies() returns cgiFormSuccess except in the event of an out of memory error. + On success, ptrToStringArray is set to point to a + valid array of strings, with the last element in the array being a + null pointer; in the out-of-memory case ptrToStringArray is set to + a null pointer, and + cgiFormOutOfMemory is returned. +

      +cgiFormResultType cgiHtmlEscape(char *s) +
      +cgiHtmlEscape() outputs the specified null-terminated string to +cgiOut, +escaping any <, &, and > characters encountered correctly so that +they do not interfere with HTML markup. Returns +cgiFormSuccess, or +cgiFormIO in the event of an I/O error. +

      +

      +cgiFormResultType cgiHtmlEscapeData(char *data, int len) +
      +cgiHtmlEscapeData() is identical to cgiHtmlEscape, +except that the data is not null-terminated. This version of the function +outputs len bytes. See cgiHtmlEscape +for more information. +

      +cgiFormResultType cgiValueEscape(char *s) +
      +cgiValueEscape() outputs the specified null-terminated string to +cgiOut, +escaping any " characters encountered correctly so that +they do not interfere with the quotation marks of HTML attribute +values. This is useful when outputting a string as part of the +value attribute of an input tag, or the href attribute of a link +or form tag. This function returns +cgiFormSuccess, or +cgiFormIO in the event of an I/O error. +

      +

      +cgiFormResultType cgiValueEscapeData(char *data, int len) +
      +cgiValueEscapeData() is identical to cgiValueEscape, +except that the data is not null-terminated. This version of the function +outputs len bytes. See cgiValueEscape +for more information. +

      +cgiEnvironmentResultType cgiWriteEnvironment(char *filename) +
      +cgiWriteEnvironment() can + be used to write the entire CGI environment, including + form data, to the specified output file; + cgiReadEnvironment() + can then be used to restore that environment from the specified + input file for debugging. Of course, these will only work as expected + if you use the cgic copies of the CGI environment + variables and cgiIn and + cgiOut rather than stdin and + stdout (also see above). These functions are useful in order + to capture real CGI situations while the web server is running, then + recreate them in a debugging environment. Both functions + return cgiEnvironmentSuccess on + success, cgiEnvironmentIO on an I/O + error, and cgiEnvironmentMemory + on an out-of-memory error. +

      +cgiEnvironmentResultType cgiReadEnvironment(char *filename) +
      +cgiReadEnvironment() restores a CGI environment saved to the specified file by + cgiWriteEnvironment(). + Of course, these will only work as expected + if you use the cgic copies of the CGI environment + variables and cgiIn and + cgiOut rather than stdin and + stdout (also see above). These functions are useful in order + to capture real CGI situations while the web server is running, then + recreate them in a debugging environment. Both functions + return cgiEnvironmentSuccess on success, + cgiEnvironmentIO on an I/O error, and + cgiEnvironmentMemory + on an out-of-memory error. +

      int cgiMain() +
      The programmer must write this function, which performs + the unique task of the program and is invoked by the true main() + function, found in the cgic library itself. The return value from + cgiMain will be the return value of the program. It is expected that + the user will make numerous calls to the cgiForm functions + from within this function. See how to write + a cgic application for details. +
      +

      cgic variable reference

      +This section provides a reference guide to the various global +variables provided by cgic for the programmer to utilize. +These variables should always be used in preference to +stdin, stdout, and calls to getenv() in order to ensure +compatibility with the cgic CGI debugging features. +

      +Most of these variables are equivalent to various CGI environment +variables. The most important difference is that the cgic +environment string variables are never null pointers. They will always +point to valid C strings of zero or more characters. +

      +
      char *cgiServerSoftware +
      Points to the name of the server software, +or to an empty string if unknown. +
      char *cgiServerName +
      Points to the name of the server, +or to an empty string if unknown. +
      char *cgiGatewayInterface +
      Points to the name of the gateway interface (usually CGI/1.1), +or to an empty string if unknown. +
      char *cgiServerProtocol +
      Points to the protocol in use (usually HTTP/1.0), +or to an empty string if unknown. +
      char *cgiServerPort +
      Points to the port number on which the server is listening +for HTTP connections (usually 80), or an empty string if unknown. +
      char *cgiRequestMethod +
      Points to the method used in the request (usually GET or POST), +or an empty string if unknown (this should not happen). +
      char *cgiPathInfo +
      Most web servers recognize any additional path information in +the URL of the request beyond the name of the CGI program itself and +pass that information on to the program. cgiPathInfo points to this +additional path information. +
      char *cgiPathTranslated +
      Most web servers recognize any additional path information in +the URL of the request beyond the name of the CGI program itself and +pass that information on to the program. cgiPathTranslated points +to this additional path information, translated by the server into a +filesystem path on the local server. +
      char *cgiScriptName +
      Points to the name under which the program was invoked. +
      char *cgiQueryString +
      Contains any query information submitted by the user as a result +of a GET-method form or an <ISINDEX> tag. Note that this +information need not be parsed directly unless an <ISINDEX> tag +was used; normally it is parsed automatically by the cgic library. Use +the cgiForm family of functions to retrieve the values associated +with form input fields. See how to write +a cgic application for more information. +
      char *cgiRemoteHost +
      Points to the fully resolved hostname of the browser, if known, +or an empty string if unknown. +
      char *cgiRemoteAddr +
      Points to the dotted-decimal IP address of the browser, if known, +or an empty string if unknown. +
      char *cgiAuthType +
      Points to the type of authorization used for the request, +if any, or an empty string if none or unknown. +
      char *cgiRemoteUser +
      Points to the user name under which the user has +authenticated; an empty string if no authentication has +taken place. The certainty of this information depends on +the type of authorization in use; see +cgiAuthType. +
      char *cgiRemoteIdent +
      Points to the user name volunteered by the user via +the user identification protocol; an empty +string if unknown. This information is not secure. +Identification demons can be installed by users on +insecure systems such as Windows machines. +
      char *cgiContentType +
      Points to the MIME content type of the information +submitted by the user, if any; an empty string if no +information was submitted. If this string is equal to +application/x-www-form-urlencoded or +multipart/form-data, the cgic +library will automatically examine the form data submitted. +If this string has any other non-empty value, a different +type of data has been submitted. This is currently very rare, +as most browsers can only submit forms and file uploads which +cgic parses directly. +
      char *cgiCookie +
      Points to the raw cookie (browser-side persistent storage) +data submitted by the web browser. +Programmers should use the functions cgiCookies, +cgiCookieString and +cgiCookieInteger instead of +examining this string directly. +
      char *cgiAccept +
      Points to a space-separated list of MIME content types +acceptable to the browser (see +cgiHeaderContentType() ), or an empty string. Unfortunately, this variable +is not supplied in a useful form by most current browsers. Programmers wishing +to make decisions based on the capabilities of the browser +are advised to check the cgiUserAgent +variable against a list of browsers and capabilities instead. +
      char *cgiUserAgent +
      +Points to the name of the browser in use, or an empty +string if this information is not available. +
      char *cgiReferrer +
      +Points to the URL of the previous page visited by the user. This is +often the URL of the form that brought the user to your program. +Note that reporting this information is entirely up to the browser, +which may choose not do so, and may choose not to do so truthfully. +However, this variable is typically accurate. The frequently +used misspelling cgiReferer is also supplied as a macro. +
      int cgiContentLength +
      The number of bytes of form or query data received. + Note that if the submission is a form or query submission + the library will read and parse all the information + directly from cgiIn and/or cgiQueryString. The programmer should + not do so, and indeed the cgiIn pointer will be at end-of-file + in such cases. +
      FILE *cgiOut +
      Pointer to CGI output. The cgiHeader functions, such as + cgiHeaderContentType, should + be used first to output the mime headers; the output HTML + page, GIF image or other web document should then be written + to cgiOut by the programmer using standard C I/O functions + such as fprintf() and fwrite(). cgiOut is normally equivalent + to stdout; however, it is recommended that cgiOut be used to + ensure compatibility with future versions of cgic for + specialized environments. +
      FILE *cgiIn +
      Pointer to CGI input. In 99.99% of cases, you will not + need this. CGIC 2.0 supports both regular POST form submissions + and multipart/form-data file upload form submissions directly. +
      +

      cgic result code reference

      +

      +In most cases, cgic functions are designed to produce reasonable results +even when browsers and users do unreasonable things. However, it is sometimes +important to know precisely which unreasonable things took place, especially +when assigning a default value or bounding a value is an inadequate +solution. The following result codes are useful in making this determination. +

      +
      cgiFormSuccess +
      Indicates that the function successfully performed at least one +action (or retrieved at least one value, where applicable). +
      cgiFormTruncated +
      Indicates that a string value retrieved from the user was +cut short to avoid overwriting the end of a buffer. +
      cgiFormBadType +
      Indicates that a "numeric" value submitted by the user was +in fact not a legal number. +
      cgiFormEmpty +
      Indicates that a field was retrieved but contained no data. +
      cgiFormNotFound +
      Indicates that no value was submitted for a particular field. +
      cgiFormConstrained +
      Indicates that a numeric value was beyond the specified bounds +and was forced to the lower or upper bound as appropriate. +
      cgiFormNoSuchChoice +
      Indicates that the value submitted for a single-choice field +(such as a radio-button group) was not one of the acceptable values. +This usually indicates a discrepancy between the form and the program. +
      cgiFormEOF +
      Returned by cgiFormFileRead +when, at the start of the call, the cgiFilePtr object is already +positioned at the end of the uploaded file data. +
      cgiFormIO +
      Returned by cgiFormFileRead +when an I/O error occurs while reading uploaded file data. +
      cgiFormNotAFile +
      Returned in response to an attempt to manipulate a form field +that is not a file upload field using a file-related function. +
      cgiFormNoContentType +
      Returned in response to an attempt to fetch the content type of +a file-upload field when the content type is not specified by the browser. +
      cgiFormNoFileName +
      Returned in response to an attempt to fetch the file name of +a file-upload field when a file name is not specified by the browser. +
      cgiFormOpenFailed +
      Returned in response to an attempt to read from a null +cgiFilePtr object, typically when the programmer has failed to +check the result of a call to cgiFormFileOpen. +
      cgiEnvironmentMemory +
      Indicates that an attempt to read or write the CGI environment +to or from a capture file failed due to an out-of-memory error. +
      cgiEnvironmentSuccess +
      Indicates that an attempt to read or write the CGI environment +to or from a capture file was successful. +
      cgiEnvironmentIO +
      Indicates that an attempt to read or write the CGI environment +to or from a capture file failed due to an I/O error. +
      cgiEnvironmentWrongVersion +
      Indicates that an attempt to read from a saved debugging CGI environment +produced by a pre-2.0 version of CGIC was made. +
      +

      cgic quick index

      +cgiAccept | +cgiAuthType | +cgiContentLength | +cgiContentType | +cgiEnvironmentIO | +cgiEnvironmentMemory | +cgiEnvironmentSuccess | +cgiCookieInteger | +cgiCookies | +cgiCookieSetInteger | +cgiCookieSetString | +cgiCookieString | +cgiHtmlEscape | +cgiHtmlEscapeData | +cgiValueEscape | +cgiValueEscapeData | +cgiFormBadType | +cgiFormCheckboxMultiple() | +cgiFormCheckboxSingle() | +cgiFormConstrained | +cgiFormDouble() | +cgiFormDoubleBounded() | +cgiFormEOF | +cgiFormEmpty | +cgiFormEntries | +cgiFormFileClose | +cgiFormFileContentType | +cgiFormFileName | +cgiFormFileOpen | +cgiFormFileRead | +cgiFormFileSize | +cgiFormInteger() | +cgiFormIntegerBounded() | +cgiFormNoFileName | +cgiFormNoSuchChoice | +cgiFormNotFound | +cgiFormRadio() | +cgiFormSelectMultiple() | +cgiFormSelectSingle() | +cgiFormString() | +cgiFormStringMultiple() | +cgiFormStringNoNewlines() | +cgiFormStringSpaceNeeded() | +cgiFormSuccess | +cgiFormTruncated | +cgiGatewayInterface | +cgiHeaderContentType() | +cgiHeaderLocation() | +cgiHeaderStatus() | +cgiIn | +cgiMain() +cgiOut | +cgiPathInfo | +cgiPathTranslated | +cgiQueryString | +cgiReadEnvironment() | +cgiReferrer() | +cgiRemoteAddr | +cgiRemoteHost | +cgiRemoteIdent | +cgiRemoteUser | +cgiRequestMethod | +cgiScriptName | +cgiServerName | +cgiServerPort | +cgiServerProtocol | +cgiServerSoftware | +cgiStringArrayFree() | +cgiUserAgent | +cgiWriteEnvironment() +

      +

      +Boutell.Com, Inc. + + + + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgictest.c =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgictest.c (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/cgictest.c (revision 672) @@ -0,0 +1,222 @@ + +/* + $Id: cgictest.c,v 1.2 2004/04/07 17:09:27 fox Exp $ + */ + +#include +#include "cgic.h" + +void Name(); +void Address(); +void Hungry(); +void Temperature(); +void Frogs(); +void Color(); +void Flavors(); +void NonExButtons(); +void RadioButtons(); + + +int cgiMain() { +#if DEBUG + /* Load a saved CGI scenario if we're debugging */ + cgiReadEnvironment("/home/boutell/public_html/capcgi.dat"); +#endif + dup2(cgiOut,stdout); + printf("Content-Type: text/html; charset=utf-8\r\nStatus: 200 OK\r\n\r\n"); + //cgiHeaderContentType("text/html"); + printf( "\n"); + printf( "cgic test\n"); + printf( "

      cgic test

      \n"); + Name(); + Address(); + Hungry(); + Temperature(); + Frogs(); + Color(); + Flavors(); + NonExButtons(); + RadioButtons(); + printf( "\n"); + return 0; +} + +void Name() { + char name[81]; + int result = cgiFormStringNoNewlines("name", name, 81); + switch (result) { + case cgiFormSuccess: + printf( "Name fetched, result code: cgiFormSuccess
      \n"); + break; + case cgiFormTruncated: + printf( "Name fetched, result code: cgiFormTruncated
      \n"); + break; + case cgiFormEmpty: + printf( "Name fetched, result code: cgiFormEmpty
      \n"); + break; + case cgiFormNotFound: + printf( "Name fetched, result code: cgiFormNotFound
      \n"); + break; + case cgiFormMemory: + printf( "Name fetched, result code: cgiFormMemory
      \n"); + break; + default: + printf( "Name fetched, unexpected result code: %d\n", result); + break; + } + printf( "Name: %s
      \n", name); +} + +void Address() { + char address[241]; + cgiFormString("address", address, 241); + printf( "Address: 
      \n%s
      \n", address); +} + +void Hungry() { + if (cgiFormCheckboxSingle("hungry") == cgiFormSuccess) { + printf( "I'm Hungry!
      \n"); + } else { + printf( "I'm Not Hungry!
      \n"); + } +} + +void Temperature() { + double temperature; + cgiFormDoubleBounded("temperature", &temperature, 80.0, 120.0, 98.6); + printf( "My temperature is %f.
      \n", temperature); +} + +void Frogs() { + int frogsEaten; + cgiFormInteger("frogs", &frogsEaten, 0); + printf( "I have eaten %d frogs.
      \n", frogsEaten); +} + +char *colors[] = { + "Red", + "Green", + "Blue" +}; + +void Color() { + int colorChoice; + cgiFormSelectSingle("colors", colors, 3, &colorChoice, 0); + printf( "I am: %s
      \n", colors[colorChoice]); +} + +char *flavors[] = { + "pistachio", + "walnut", + "creme" +}; + +void Flavors() { + int flavorChoices[3]; + int i; + int result; + int invalid; + result = cgiFormSelectMultiple("flavors", flavors, 3, + flavorChoices, &invalid); + if (result == cgiFormNotFound) { + printf( "I hate ice cream.

      \n"); + } else { + printf( "My favorite ice cream flavors are:\n"); + printf( "

        \n"); + for (i=0; (i < 3); i++) { + if (flavorChoices[i]) { + printf( "
      • %s\n", flavors[i]); + } + } + printf( "
      \n"); + } +} + +char *ages[] = { + "1", + "2", + "3", + "4" +}; + +void RadioButtons() { + int ageChoice; + char ageText[10]; + /* Approach #1: check for one of several valid responses. + Good if there are a short list of possible button values and + you wish to enumerate them. */ + cgiFormRadio("age", ages, 4, &ageChoice, 0); + + printf( "Age of Truck: %s (method #1)
      \n", + ages[ageChoice]); + + /* Approach #2: just get the string. Good + if the information is not critical or if you wish + to verify it in some other way. Note that if + the information is numeric, cgiFormInteger, + cgiFormDouble, and related functions may be + used instead of cgiFormString. */ + cgiFormString("age", ageText, 10); + + printf( "Age of Truck: %s (method #2)
      \n", ageText); +} + +char *votes[] = { + "A", + "B", + "C", + "D" +}; + +void NonExButtons() { + int voteChoices[4]; + int i; + int result; + int invalid; + + char **responses; + + /* Method #1: check for valid votes. This is a good idea, + since votes for nonexistent candidates should probably + be discounted... */ + printf( "Votes (method 1):
      \n"); + result = cgiFormCheckboxMultiple("vote", votes, 4, + voteChoices, &invalid); + if (result == cgiFormNotFound) { + printf( "I hate them all!

      \n"); + } else { + printf( "My preferred candidates are:\n"); + printf( "

        \n"); + for (i=0; (i < 4); i++) { + if (voteChoices[i]) { + printf( "
      • %s\n", votes[i]); + } + } + printf( "
      \n"); + } + + /* Method #2: get all the names voted for and trust them. + This is good if the form will change more often + than the code and invented responses are not a danger + or can be checked in some other way. */ + printf( "Votes (method 2):
      \n"); + result = cgiFormStringMultiple("vote", &responses); + if (result == cgiFormNotFound) { + printf( "I hate them all!

      \n"); + } else { + int i = 0; + printf( "My preferred candidates are:\n"); + printf( "

        \n"); + while (responses[i]) { + printf( "
      • %s\n", responses[i]); + i++; + } + printf( "
      \n"); + } + /* We must be sure to free the string array or a memory + leak will occur. Simply calling free() would free + the array but not the individual strings. The + function cgiStringArrayFree() does the job completely. */ + cgiStringArrayFree(responses); +} + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/changelog =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/changelog (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/changelog (revision 672) @@ -0,0 +1,32 @@ +libcgic (2.06-1~trusty3) trusty; urgency=low + + * New version to be used for ZOO-Kernel. + + -- Angelos Tzotsos Tue, 10 Jun 2014 19:29:04 +0200 + +libcgic (2.05-3) unstable; urgency=low + + * debian/control: Suggests: httpd. Closes: #600138. + * debian/control: Fixed debhelper-but-no-misc-depends. + + -- Bart Martens Sun, 13 May 2012 08:33:04 +0000 + +libcgic (2.05-2) unstable; urgency=low + + * debian/control: Standards-Version, Homepage. + + -- Bart Martens Sun, 13 Jul 2008 09:31:48 +0200 + +libcgic (2.05-1) unstable; urgency=low + + * New maitnainer. Closes: #438643. + * New upstream release. + * debian/*: Repackaged with cdbs. + * debian/changelog-upstream.html: Removed. + * debian/Makefile.examples: Removed. + * debian/README.Debian: Removed. + * debian/copyright: Updated. + * debian/watch: Updated. + + -- Bart Martens Sun, 19 Aug 2007 09:18:53 +0200 + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/compat =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/compat (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/compat (revision 672) @@ -0,0 +1,1 @@ +5 Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/control =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/control (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/control (revision 672) @@ -0,0 +1,35 @@ +Source: libcgic +Section: libs +Priority: optional +Maintainer: Bart Martens +Build-Depends: cdbs, libfcgi-dev, debhelper (>= 5) +Standards-Version: 3.9.3 +Homepage: http://www.boutell.com/cgic/ + +Package: libcgic-dev +Section: libdevel +Architecture: any +Depends: libc6-dev, ${misc:Depends} +Suggests: httpd +Conflicts: libcgicg1-dev +Replaces: libcgicg1-dev +Description: C library for developing CGI applications + Cgic is an ANSI-C library for the creation of CGI-based World Wide Web + applications. Cgic provides the following: + . + * Parses form data, correcting for defective and/or inconsistent + browsers + * Transparently accepts both GET and POST form data + * Handles line breaks in form fields in a consistent manner + * Provides string, integer, floating-point, and single- and + multiple-choice functions to retrieve form data + * Provides bounds checking for numeric fields + * Loads CGI environment variables into C strings which are always + non-null + * Provides a way to capture CGI situations for replay in a debugging + environment + . + This package provides a static library version of cgic, examples of using + cgic (including a CGI application that captures a CGI environment for use + in debugging), and header files. + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/copyright =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/copyright (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/copyright (revision 672) @@ -0,0 +1,28 @@ +This package was debianized by Brian Bassett brian@butterfly.ml.org on +Tue, 11 Nov 1997 17:28:04 -0800. + +It was downloaded from: + + http://www.boutell.com/cgic/ + +Upstream author: + + Thomas Boutell + +Copyright: + + Copyright (C) 1996-2004 by Thomas Boutell and Boutell.Com, Inc. + +License: + + CGIC, copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, + 2004 by Thomas Boutell and Boutell.Com, Inc.. Permission is granted to + use CGIC in any application, commercial or noncommercial, at no cost. + HOWEVER, this copyright paragraph must appear on a "credits" page + accessible in the public online and offline documentation of the program. + Modified versions of the CGIC library should not be distributed without + the attachment of a clear statement regarding the author of the + modifications, and this notice may in no case be removed. + Modifications may also be submitted to the author for inclusion + in the main CGIC distribution. + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.docs =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.docs (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.docs (revision 672) @@ -0,0 +1,1 @@ +cgic.html Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.examples =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.examples (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.examples (revision 672) @@ -0,0 +1,2 @@ +capture.c +cgictest.c Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.install =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.install (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.install (revision 672) @@ -0,0 +1,2 @@ +cgic.h usr/include/ +libcgic.a usr/lib/ Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.links =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.links (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/libcgic-dev.links (revision 672) @@ -0,0 +1,1 @@ +/usr/lib/libcgic.so.2.06 /usr/lib/libcgic.so Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/rules =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/rules (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/rules (revision 672) @@ -0,0 +1,7 @@ +#!/usr/bin/make -f + +include /usr/share/cdbs/1/rules/debhelper.mk +include /usr/share/cdbs/1/class/makefile.mk + +clean:: + rm -f libcgic.so.2.06 Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/watch =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/watch (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/debian/watch (revision 672) @@ -0,0 +1,4 @@ +version=3 +opts="uversionmangle=s/^(\d)(\d\d)$/$1.$2/" \ +http://www.boutell.com/cgic/ \ +cgic(.*)\.t.* Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/license.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/license.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/license.txt (revision 672) @@ -0,0 +1,109 @@ +CGIC License Terms +------------------ + +Basic License +------------- + +CGIC, copyright 2009 GeoLabs SARL. +CGIC, copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, +2004 by Thomas Boutell and Boutell.Com, Inc.. Permission is granted to +use CGIC in any application, commercial or noncommercial, at no cost. +HOWEVER, this copyright paragraph must appear on a "credits" page +accessible in the public online and offline documentation of the program. +Modified versions of the CGIC library should not be distributed without +the attachment of a clear statement regarding the author of the +modifications, and this notice may in no case be removed. +Modifications may also be submitted to the author for inclusion +in the main CGIC distribution. + +IF YOU WOULD PREFER NOT TO ATTACH THE ABOVE NOTICE to +the public documentation of your application, consult the +information which follows regarding the availability +of a nonexclusive commercial license for CGIC. + +Commercial License +------------------ + +The price of a nonexclusive commercial license is $200 U.S. +To purchase the license: + +1. Print and sign two copies of the document below. + +2. Send both copies, along with Visa, Mastercard, Discover, or +Amex card number, cardholder's name, and expiration date +OR a check for $200 in U.S. funds drawn on a U.S. bank, to: + +Boutell.Com, Inc. +PO Box 63767 +Philadelphia, PA 19147 USA + +Credit card orders may alternatively be faxed to: + +Boutell.Com, Inc. +(208) 445-0327 + +BE SURE TO INCLUDE AN EMAIL ADDRESS, as well as +a postal address and phone number. + +3. We will return one signed copy to you promptly. + +You will also receive swift notification of new +versions of CGIC, in addition to ongoing +email support. + +* * * + +CGIC Nonexclusive Commercial License + +The licensee named below is granted the right +to utilize CGIC, major version 1 or 2, any minor +version thereof, in CGI applications without the +need for a credit notice of any kind. CGI applications +developed by the holder of this license may be +distributed freely in source code or binary form +without additional fees or royalties. This license does +not grant the right to use CGIC to create a development tool +which passes on substantially all of the capabilities of the +CGIC library to the user of the tool, unless that tool is +to be used internally by the license holder only in order +to develop CGI applications. This license may not +be resold, but applications developed in accordance +with the terms of the license may be distributed +freely subject to the limitations described above. + +Future minor (2.x) versions of CGIC will be covered by this +license free of charge. If significant defects of workmanship +are discovered in version 2.x, minor releases to correct them +will be made available before or at the same time that +those defects are addressed in any future major version. +Future "major" (3.x) versions will be available to +licensees at an upgrade price of $50. + +If, for any reason, any portion of this license is found +to be invalid, that portion of the license only +is invalidated and the remainder of the agreement +remains in effect. + +If this license has not been signed by Thomas Boutell +or M. L. Grant on behalf of Boutell. Com, Inc., +it is invalid. + +Licensee's Name: _____________________ + +Signed for Licensee: _____________________ + +Complete Mailing Address: _____________________ + + _____________________ + + _____________________ + +Phone Number: _____________________ + +Email Address: _____________________ + +Signed for Boutell.Com, Inc.: _____________________ + +Date: _____________________ + + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/makefile.vc =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/makefile.vc (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/makefile.vc (revision 672) @@ -0,0 +1,35 @@ +GEODIR=\MMBK\SRCS\fcgi-2.4.1-SNAP-0311112127\ +DESTDIR=.. +CFLAGS=-g -Wall +CC=cl /TP +LIBS=$(GEODIR)/libfcgi/Release/libfcgi.lib /nologo +LIBS1=./libcgic.lib + +CFLAGS=/EHa /nologo /DCRT_SECURE_NO_WARNING /MD /W2 /O2 /D "WIN32" \ + -I $(GEODIR)\include + +all: libcgic.lib #cgictest.exe capture.exe + +install: libcgic.lib + copy libcgic.lib $(DESTDIR)\lib + copy cgic.h $(DESTDIR)\include + @echo libcgic.lib is now installed in $(DESTDIR)\lib and cgic.h is in $(DESTDIR)\include. + +libcgic.lib: cgic.obj cgic.h + if exist cgic.lib del cgic.lib + lib /out:libcgic.lib cgic.obj $(LIBS) + +cgictest.obj: cgictest.c libcgic.lib + $(CC) $(CFLAGS) -c cgictest.c + +cgictest.exe: cgictest.obj + link cgictest.obj $(LIBS) /out:cgictest.exe + +cgic.obj: + $(CC) $(CFLAGS) -c cgic.c + +capture.exe: capture.obj libcgic.lib + $(CC) $(CFLAGS) capture.c $(LIBS) + +clean: + erase *.obj *.lib *.exe *.manifest Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/readme.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/readme.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/readme.txt (revision 672) @@ -0,0 +1,14 @@ +This is the CGIC CGI development library for C programmers. +Copyright 2009 GeoLabs SARL +Copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, +2004, Thomas Boutell and Boutell.Com, Inc. + +See the file cgic.html for complete documentation in a single +HTML hypertext file to be accessed with your web browser. If you +preferer, there is a plaintext version in the file cgic.txt. +Or see http://www.boutell.com/cgic/ for the latest copy of +the documentation. + +See the files license.txt and support.txt for terms of use and +technical support information. + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/support.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/support.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/cgic206/support.txt (revision 672) @@ -0,0 +1,46 @@ +Support for CGIC +---------------- + + ____ + / \ + | STOP | + \____/ + + Are you getting a "server error," indicating that your web server + "cannot allow POST to this URL," or a similar message? YOU MUST + CONFIGURE YOUR WEB SERVER TO ALLOW CGI PROGRAMS, AND YOU MUST + INSTALL CGI PROGRAMS IN THE LOCATION (OR WITH THE EXTENSION) THAT + YOUR WEB SERVER EXPECTS TO SEE. Please don't send me email about + this, unless you are purchasing commercial support. It is strictly + between you and your web server's documentation, or between you and + your ISP. If you wish to purchase commercial support, we will gladly + attempt to help you resolve such problems, but the cooperation of + your web server administrator will be necessary in most cases. Thanks! + +Free Support +------------ + +Anyone can mail questions about the gd and cgic libraries to +boutell@boutell.com. However, I receive a very large volume of email on +many subjects, and while I do my best to respond to all queries this can +take some time. Sometimes the response must take the form of an eventual +new release or an addition to a FAQ or other document, as opposed to an +detailed individual response. + +Hourly Support +-------------- + +Those requiring support in detail may arrange for direct support +from the author, Thomas Boutell, at the rate of $50/hr, billed +directly by credit card. Purchase orders are also accepted from +Fortune 500 corporations and institutions in good standing. +To make arrangements, contact boutell@boutell.com. Alternatively, +use our free-form secure message page at: + +https://www.boutell.com/freeform/ + +To avoid delay and/or confusion, be sure to specifically mention that +you wish to purchase CGIC support at the hourly rate above. + +-Thomas Boutell, boutell@boutell.com + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/dirent-win32/dirent.h =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/dirent-win32/dirent.h (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/dirent-win32/dirent.h (revision 672) @@ -0,0 +1,373 @@ +/***************************************************************************** + * dirent.h - dirent API for Microsoft Visual Studio + * + * Copyright (C) 2006 Toni Ronkko + * + * Permission is hereby granted, free of charge, to any person obtaining + * a copy of this software and associated documentation files (the + * ``Software''), to deal in the Software without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS + * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + * IN NO EVENT SHALL TONI RONKKO BE LIABLE FOR ANY CLAIM, DAMAGES OR + * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, + * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + * + * Mar 15, 2011, Toni Ronkko + * Defined FILE_ATTRIBUTE_DEVICE for MSVC 6.0. + * + * Aug 11, 2010, Toni Ronkko + * Added d_type and d_namlen fields to dirent structure. The former is + * especially useful for determining whether directory entry represents a + * file or a directory. For more information, see + * http://www.delorie.com/gnu/docs/glibc/libc_270.html + * + * Aug 11, 2010, Toni Ronkko + * Improved conformance to the standards. For example, errno is now set + * properly on failure and assert() is never used. Thanks to Peter Brockam + * for suggestions. + * + * Aug 11, 2010, Toni Ronkko + * Fixed a bug in rewinddir(): when using relative directory names, change + * of working directory no longer causes rewinddir() to fail. + * + * Dec 15, 2009, John Cunningham + * Added rewinddir member function + * + * Jan 18, 2008, Toni Ronkko + * Using FindFirstFileA and WIN32_FIND_DATAA to avoid converting string + * between multi-byte and unicode representations. This makes the + * code simpler and also allows the code to be compiled under MingW. Thanks + * to Azriel Fasten for the suggestion. + * + * Mar 4, 2007, Toni Ronkko + * Bug fix: due to the strncpy_s() function this file only compiled in + * Visual Studio 2005. Using the new string functions only when the + * compiler version allows. + * + * Nov 2, 2006, Toni Ronkko + * Major update: removed support for Watcom C, MS-DOS and Turbo C to + * simplify the file, updated the code to compile cleanly on Visual + * Studio 2005 with both unicode and multi-byte character strings, + * removed rewinddir() as it had a bug. + * + * Aug 20, 2006, Toni Ronkko + * Removed all remarks about MSVC 1.0, which is antiqued now. Simplified + * comments by removing SGML tags. + * + * May 14 2002, Toni Ronkko + * Embedded the function definitions directly to the header so that no + * source modules need to be included in the Visual Studio project. Removed + * all the dependencies to other projects so that this very header can be + * used independently. + * + * May 28 1998, Toni Ronkko + * First version. + *****************************************************************************/ +#ifndef DIRENT_H +#define DIRENT_H + +#define WIN32_LEAN_AND_MEAN +#include +#include +#include +#include +#include +#include + +/* Entries missing from MSVC 6.0 */ +#if !defined(FILE_ATTRIBUTE_DEVICE) +# define FILE_ATTRIBUTE_DEVICE 0x40 +#endif + +/* File type and permission flags for stat() */ +#if defined(_MSC_VER) && !defined(S_IREAD) +# define S_IFMT _S_IFMT /* file type mask */ +# define S_IFDIR _S_IFDIR /* directory */ +# define S_IFCHR _S_IFCHR /* character device */ +# define S_IFFIFO _S_IFFIFO /* pipe */ +# define S_IFREG _S_IFREG /* regular file */ +# define S_IREAD _S_IREAD /* read permission */ +# define S_IWRITE _S_IWRITE /* write permission */ +# define S_IEXEC _S_IEXEC /* execute permission */ +#endif +#define S_IFBLK 0 /* block device */ +#define S_IFLNK 0 /* link */ +#define S_IFSOCK 0 /* socket */ + +#if defined(_MSC_VER) +# define S_IRUSR S_IREAD /* read, user */ +# define S_IWUSR S_IWRITE /* write, user */ +# define S_IXUSR 0 /* execute, user */ +# define S_IRGRP 0 /* read, group */ +# define S_IWGRP 0 /* write, group */ +# define S_IXGRP 0 /* execute, group */ +# define S_IROTH 0 /* read, others */ +# define S_IWOTH 0 /* write, others */ +# define S_IXOTH 0 /* execute, others */ +#endif + +/* Indicates that d_type field is available in dirent structure */ +#define _DIRENT_HAVE_D_TYPE + +/* File type flags for d_type */ +#define DT_LNK -100 +#define DT_UNKNOWN 0 +#define DT_REG S_IFREG +#define DT_DIR S_IFDIR +#define DT_FIFO S_IFFIFO +#define DT_SOCK S_IFSOCK +#define DT_CHR S_IFCHR +#define DT_BLK S_IFBLK + +/* Macros for converting between st_mode and d_type */ +#define IFTODT(mode) ((mode) & S_IFMT) +#define DTTOIF(type) (type) + +/* + * File type macros. Note that block devices, sockets and links cannot be + * distinguished on Windows and the macros S_ISBLK, S_ISSOCK and S_ISLNK are + * only defined for compatibility. These macros should always return false + * on Windows. + */ +#define S_ISFIFO(mode) (((mode) & S_IFMT) == S_IFFIFO) +#define S_ISDIR(mode) (((mode) & S_IFMT) == S_IFDIR) +#define S_ISREG(mode) (((mode) & S_IFMT) == S_IFREG) +#define S_ISLNK(mode) (((mode) & S_IFMT) == S_IFLNK) +#define S_ISSOCK(mode) (((mode) & S_IFMT) == S_IFSOCK) +#define S_ISCHR(mode) (((mode) & S_IFMT) == S_IFCHR) +#define S_ISBLK(mode) (((mode) & S_IFMT) == S_IFBLK) + +#ifdef __cplusplus +extern "C" { +#endif + + +typedef struct dirent +{ + char d_name[MAX_PATH + 1]; /* File name */ + size_t d_namlen; /* Length of name without \0 */ + int d_type; /* File type */ +} dirent; + + +typedef struct DIR +{ + dirent curentry; /* Current directory entry */ + WIN32_FIND_DATAA find_data; /* Private file data */ + int cached; /* True if data is valid */ + HANDLE search_handle; /* Win32 search handle */ + char patt[MAX_PATH + 3]; /* Initial directory name */ +} DIR; + + +/* Forward declarations */ +static DIR *opendir(const char *dirname); +static struct dirent *readdir(DIR *dirp); +static int closedir(DIR *dirp); +static void rewinddir(DIR* dirp); + + +/* Use the new safe string functions introduced in Visual Studio 2005 */ +#if defined(_MSC_VER) && _MSC_VER >= 1400 +# define DIRENT_STRNCPY(dest,src,size) strncpy_s((dest),(size),(src),_TRUNCATE) +#else +# define DIRENT_STRNCPY(dest,src,size) strncpy((dest),(src),(size)) +#endif + +/* Set errno variable */ +#if defined(_MSC_VER) +#define DIRENT_SET_ERRNO(x) _set_errno (x) +#else +#define DIRENT_SET_ERRNO(x) (errno = (x)) +#endif + + + +/***************************************************************************** + * Open directory stream DIRNAME for read and return a pointer to the + * internal working area that is used to retrieve individual directory + * entries. + */ +static DIR *opendir(const char *dirname) +{ + DIR *dirp; + + /* ensure that the resulting search pattern will be a valid file name */ + if (dirname == NULL) { + DIRENT_SET_ERRNO (ENOENT); + return NULL; + } + if (strlen (dirname) + 3 >= MAX_PATH) { + DIRENT_SET_ERRNO (ENAMETOOLONG); + return NULL; + } + + /* construct new DIR structure */ + dirp = (DIR*) malloc (sizeof (struct DIR)); + if (dirp != NULL) { + int error; + + /* + * Convert relative directory name to an absolute one. This + * allows rewinddir() to function correctly when the current working + * directory is changed between opendir() and rewinddir(). + */ + if (GetFullPathNameA (dirname, MAX_PATH, dirp->patt, NULL)) { + char *p; + + /* append the search pattern "\\*\0" to the directory name */ + p = strchr (dirp->patt, '\0'); + if (dirp->patt < p && *(p-1) != '\\' && *(p-1) != ':') { + *p++ = '\\'; + } + *p++ = '*'; + *p = '\0'; + + /* open directory stream and retrieve the first entry */ + dirp->search_handle = FindFirstFileA (dirp->patt, &dirp->find_data); + if (dirp->search_handle != INVALID_HANDLE_VALUE) { + /* a directory entry is now waiting in memory */ + dirp->cached = 1; + error = 0; + } else { + /* search pattern is not a directory name? */ + DIRENT_SET_ERRNO (ENOENT); + error = 1; + } + } else { + /* buffer too small */ + DIRENT_SET_ERRNO (ENOMEM); + error = 1; + } + + if (error) { + free (dirp); + dirp = NULL; + } + } + + return dirp; +} + + +/***************************************************************************** + * Read a directory entry, and return a pointer to a dirent structure + * containing the name of the entry in d_name field. Individual directory + * entries returned by this very function include regular files, + * sub-directories, pseudo-directories "." and "..", but also volume labels, + * hidden files and system files may be returned. + */ +static struct dirent *readdir(DIR *dirp) +{ + DWORD attr; + if (dirp == NULL) { + /* directory stream did not open */ + DIRENT_SET_ERRNO (EBADF); + return NULL; + } + + /* get next directory entry */ + if (dirp->cached != 0) { + /* a valid directory entry already in memory */ + dirp->cached = 0; + } else { + /* get the next directory entry from stream */ + if (dirp->search_handle == INVALID_HANDLE_VALUE) { + return NULL; + } + if (FindNextFileA (dirp->search_handle, &dirp->find_data) == FALSE) { + /* the very last entry has been processed or an error occured */ + FindClose (dirp->search_handle); + dirp->search_handle = INVALID_HANDLE_VALUE; + return NULL; + } + } + + /* copy as a multibyte character string */ + DIRENT_STRNCPY ( dirp->curentry.d_name, + dirp->find_data.cFileName, + sizeof(dirp->curentry.d_name) ); + dirp->curentry.d_name[MAX_PATH] = '\0'; + + /* compute the length of name */ + dirp->curentry.d_namlen = strlen (dirp->curentry.d_name); + + /* determine file type */ + attr = dirp->find_data.dwFileAttributes; + if ((attr & FILE_ATTRIBUTE_DEVICE) != 0) { + dirp->curentry.d_type = DT_CHR; + } else if ((attr & FILE_ATTRIBUTE_DIRECTORY) != 0) { + dirp->curentry.d_type = DT_DIR; + } else { + dirp->curentry.d_type = DT_REG; + } + return &dirp->curentry; +} + + +/***************************************************************************** + * Close directory stream opened by opendir() function. Close of the + * directory stream invalidates the DIR structure as well as any previously + * read directory entry. + */ +static int closedir(DIR *dirp) +{ + if (dirp == NULL) { + /* invalid directory stream */ + DIRENT_SET_ERRNO (EBADF); + return -1; + } + + /* release search handle */ + if (dirp->search_handle != INVALID_HANDLE_VALUE) { + FindClose (dirp->search_handle); + dirp->search_handle = INVALID_HANDLE_VALUE; + } + + /* release directory structure */ + free (dirp); + return 0; +} + + +/***************************************************************************** + * Resets the position of the directory stream to which dirp refers to the + * beginning of the directory. It also causes the directory stream to refer + * to the current state of the corresponding directory, as a call to opendir() + * would have done. If dirp does not refer to a directory stream, the effect + * is undefined. + */ +static void rewinddir(DIR* dirp) +{ + if (dirp != NULL) { + /* release search handle */ + if (dirp->search_handle != INVALID_HANDLE_VALUE) { + FindClose (dirp->search_handle); + } + + /* open new search handle and retrieve the first entry */ + dirp->search_handle = FindFirstFileA (dirp->patt, &dirp->find_data); + if (dirp->search_handle != INVALID_HANDLE_VALUE) { + /* a directory entry is now waiting in memory */ + dirp->cached = 1; + } else { + /* failed to re-open directory: no directory entry in memory */ + dirp->cached = 0; + } + } +} + +#ifdef __cplusplus +} +#endif +#endif /*DIRENT_H*/ Index: /branches/PublicaMundi_David_integration_01-devel/thirds/include/unistd.h =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/include/unistd.h (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/include/unistd.h (revision 672) @@ -0,0 +1,41 @@ +/** + * Author : Gérald FENOY + * + * Copyright (c) 2009-2013 GeoLabs SARL + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ +#ifndef __STRICT_AINSI__ + +#include +#include +#define mode_t int +#define strtok_r strtok_s +#define S_IRWXU _S_IREAD|_S_IWRITE +#define S_IRGRP _S_IREAD|_S_IWRITE +#define S_IROTH _S_IREAD|_S_IWRITE +#define S_IXGRP _S_IREAD|_S_IWRITE +#define S_IXOTH _S_IREAD|_S_IWRITE +#define S_IWOTH _S_IREAD|_S_IWRITE +#define S_IRUSR _S_IREAD +#define S_IXGRP _S_IREAD|_S_IWRITE +#define S_IWGRP _S_IREAD|_S_IWRITE +#define S_IWUSR _S_IREAD|_S_IWRITE + +#endif Index: /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/CMakeLists.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/CMakeLists.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/CMakeLists.txt (revision 672) @@ -0,0 +1,14 @@ +PROJECT(otb2zcfg) + +cmake_minimum_required(VERSION 2.6) + +FIND_PACKAGE(OTB) +IF(OTB_FOUND) + INCLUDE(${OTB_USE_FILE}) +ELSE(OTB_FOUND) + MESSAGE(FATAL_ERROR + "Cannot build OTB project without OTB. Please set OTB_DIR.") +ENDIF(OTB_FOUND) + +ADD_EXECUTABLE(otb2zcfg otb2zcfg.cxx ) +TARGET_LINK_LIBRARIES(otb2zcfg OTBCommon OTBApplicationEngine OTBIO ${ITK_LIBRARIES}) Index: /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/README.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/README.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/README.txt (revision 672) @@ -0,0 +1,17 @@ +To build the otb2zcfg utility you should run the following command: + + mkdir build + cd build + ccmake .. + make + + +To generate the zcfgs for the OTB Applications available, you should run the following: + + mkdir zcfgs + cd zcfgs + export ITK_AUTOLOAD_PATH=/your/path/to/otb/applications + ../build/otb2zcfg + cp *zcfg /location/to/your/cgi-bin + +This ITK_AUTOLOAD_PATH environment variable will be required in the [env] section of your main.cfg. Index: /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/otb2zcfg.cxx =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/otb2zcfg.cxx (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/otb2zcfg/otb2zcfg.cxx (revision 672) @@ -0,0 +1,395 @@ +#include "otbWrapperApplicationRegistry.h" +#include "otbWrapperApplication.h" +#include "otbImage.h" +#include + +using namespace otb::Wrapper; + +std::string ReplaceAll(std::string str, const std::string& from, const std::string& to) { + size_t start_pos = 0; + while((start_pos = str.find(from, start_pos)) != std::string::npos) { + str.replace(start_pos, from.length(), to); + start_pos += to.length(); // Handles case where 'to' is a substring of 'from' + } + return str; +} + +void printDefaultOutput(){ + std::cout << " [Result]" << std::endl; + std::cout << " Title = the result message" << std::endl; + std::cout << " Abstract = the result message" << std::endl; + std::cout << " " << std::endl; + std::cout << " dataType = string" << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; +} + +void printAscii(){ + std::cout << " " << std::endl; + std::cout << " mimeType = text/plain" << std::endl; + std::cout << " encoding = ascii" << std::endl; + std::cout << " " << std::endl; +} + +void printXml(){ + std::cout << " " << std::endl; + std::cout << " mimeType = text/xml" << std::endl; + std::cout << " encoding = utf-8" << std::endl; + std::cout << " " << std::endl; +} + +void printGeoid(){ + std::cout << " " << std::endl; + std::cout << " mimeType = application/octet-stream" << std::endl; + std::cout << " " << std::endl; +} + +void printCSV(){ + std::cout << " " << std::endl; + std::cout << " mimeType = text/csv" << std::endl; + std::cout << " encoding = utf-8" << std::endl; + std::cout << " " << std::endl; +} + +void printUnknown(){ + std::cout << " " << std::endl; + std::cout << " mimeType = text/xml" << std::endl; + std::cout << " encoding = utf-8" << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; + std::cout << " mimeType = text/plain" << std::endl; + std::cout << " encoding = utf-8" << std::endl; + std::cout << " " << std::endl; +} + +void printImages(){ + std::cout << " " << std::endl; + std::cout << " mimeType = image/tiff" << std::endl; + std::cout << " " << std::endl; +#if defined(OTB_USE_JPEG2000) + std::cout << " " << std::endl; + std::cout << " mimeType = image/jp2" << std::endl; + std::cout << " " << std::endl; +#endif + std::cout << " " << std::endl; + std::cout << " mimeType = image/jpeg" << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; + std::cout << " mimeType = image/png" << std::endl; + std::cout << " " << std::endl; +} + +void printKmz(){ + std::cout << " " << std::endl; + std::cout << " mimeType = application/vnd.google-earth.kmz" << std::endl; + std::cout << " extension = kmz" << std::endl; + std::cout << " " << std::endl; +} + +void printVector(){ + std::cout << " " << std::endl; + std::cout << " mimeType = text/xml" << std::endl; + std::cout << " encoding = utf-8" << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; + std::cout << " mimeType = application/vnd.google-earth.kml+xml" << std::endl; + std::cout << " encoding = utf-8" << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; + std::cout << " mimeType = application/zip" << std::endl; + std::cout << " " << std::endl; +} + +void printOutputImage(){ + std::cout << " " << std::endl; + std::cout << " dataType = string" << std::endl; + std::cout << " " << std::endl; + std::cout << " value = float" << std::endl; + std::cout << " AllowedValues = uint8,uint16,int16n,int32,int32,float,double" << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; +} + +void printOutputComplexImage(){ + std::cout << " " << std::endl; + std::cout << " dataType = string" << std::endl; + std::cout << " " << std::endl; + std::cout << " value = cfloat" << std::endl; + std::cout << " AllowedValues = cfloat,cdouble" << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; +} + +int main(int itkNotUsed(argc), char * itkNotUsed(argv)[]) +{ + typedef otb::Image ImageType; + + ImageType::Pointer image = ImageType::New(); + + const char * ITK_AUTOLOAD_PATH = itksys::SystemTools::GetEnv("ITK_AUTOLOAD_PATH"); + std::cerr << "ERROR: Module search path: " << (ITK_AUTOLOAD_PATH ? ITK_AUTOLOAD_PATH : "none (check ITK_AUTOLOAD_PATH)") << std::endl; + + std::vector list = ApplicationRegistry::GetAvailableApplications(); + if (list.size() == 0) + std::cerr << "ERROR: Available modules : none." << std::endl; + else{ + std::cerr << "ERROR: Available modules :" << std::endl; + for (std::vector::const_iterator it = list.begin(); it != list.end(); ++it){ + std::string filename= *it + ".zcfg"; + std::ofstream out(filename.c_str(),std::ofstream::out); + std::streambuf *coutbuf = std::cout.rdbuf(); + std::cout.rdbuf(out.rdbuf()); + + std::cerr << *it << std::endl; + std::cout << "[" << *it << "]" << std::endl; + Application::Pointer m_Application=ApplicationRegistry::CreateApplication(*it); + std::string s0 = m_Application->GetDescription(); + s0=ReplaceAll(ReplaceAll(s0,std::string("\n"),std::string("")),std::string("\t"),std::string("")); + std::cout << " Title = " << s0 << std::endl; + s0 = m_Application->GetDocLongDescription(); + s0=ReplaceAll(ReplaceAll(s0,std::string("\n"),std::string("")),std::string("\t"),std::string("")); + std::cout << " Abstract = " << s0 << std::endl; + const std::vector appKeyList = m_Application->GetParametersKeys(true); + std::cout << " storeSupported = true"<< std::endl; + std::cout << " statusSupported = true" << std::endl; + std::cout << " serviceProvider = " << *it << std::endl; + std::cout << " serviceType = OTB" << std::endl; + std::cout << " " << std::endl; + for (unsigned int i = 0; i < appKeyList.size(); i++){ + const std::string paramKey(appKeyList[i]); + Parameter::Pointer param = m_Application->GetParameterByKey(paramKey); + ParameterType type = m_Application->GetParameterType(paramKey); + Role role = m_Application->GetParameterRole(paramKey); + + if(paramKey!="inxml" && paramKey!="outxml" && role==0 && type!=17 + && type!=ParameterType_OutputFilename && type!=ParameterType_OutputVectorData){ + std::vector values; + std::string s = m_Application->GetParameterDescription(paramKey); + s=ReplaceAll(ReplaceAll(ReplaceAll(s,std::string("\n"),std::string("")),std::string("\t"),std::string("")),std::string("<"),std::string("<")); + std::cout << " [" << paramKey << "]" << std::endl; + if(s.length()>0){ + std::cout << " Title = " << s << std::endl; + std::cout << " Abstract = " << s << std::endl; + }else{ + std::cout << " Title = " << paramKey << std::endl; + std::cout << " Abstract = " << paramKey << std::endl; + } + std::cout << " minOccurs = " << m_Application->IsMandatory(paramKey) << std::endl; + /* Bounded and unbounded parameters */ + if(type == ParameterType_StringList || type == ParameterType_InputImageList + || type == ParameterType_InputVectorDataList || type == ParameterType_InputFilenameList) + std::cout << " maxOccurs = 1024" << std::endl; + else + std::cout << " maxOccurs = 1" << std::endl; + std::replace( s.begin(), s.end(), '\n', ' '); + + if(type == ParameterType_StringList || type == ParameterType_String || type == ParameterType_Float + || type == ParameterType_Int || type == ParameterType_Choice || type == ParameterType_ListView + || type == ParameterType_RAM || type == ParameterType_Empty || type == ParameterType_Directory){ + std::cout << " " << std::endl; + std::string lt; + if(type == ParameterType_Int || type == ParameterType_RAM) + lt="integer"; + if(type == ParameterType_Float) + lt="float"; + if(type == ParameterType_String || type == ParameterType_StringList + || type == ParameterType_Choice || type == ParameterType_Directory + || type == ParameterType_ListView) + lt="string"; + if(type == ParameterType_Empty) + lt="boolean"; + std::cout << " dataType = " << lt << std::endl; + if(type == ParameterType_Choice || type == ParameterType_ListView){ + const std::vector nList = m_Application->GetChoiceNames(paramKey); + const std::vector keysList = m_Application->GetChoiceKeys(paramKey); + if(keysList.size()==0){ + std::cout << " " << std::endl; + } + for (unsigned int j = 0; j < keysList.size(); j++){ + const std::string key(keysList[j]); + if(j==0){ + std::cout << " " << std::endl; + if(m_Application->HasValue(paramKey)) + std::cout << " value = " << m_Application->GetParameterAsString(paramKey) << std::endl; + else + std::cout << " value = " << key << std::endl; + } + else{ + if(j==1){ + std::cout << " AllowedValues = "+keysList[0]+","; + } + std::cout << keysList[j]; + if(j+1>=keysList.size()){ + std::cout << std::endl; + std::cout << " " << std::endl; + } + else + std::cout << ","; + } + } + } + else{ + if(type!=17 && m_Application->HasValue(paramKey)){ + std::cout << " " << std::endl; + std::cout << " value = " << m_Application->GetParameterAsString(paramKey) << std::endl; + std::cout << " " << std::endl; + } + else + std::cout << " " << std::endl; + } + std::cout << " " << std::endl; + } + else{ + if(type == ParameterType_OutputImage) + printOutputImage(); + else{ + if(type == ParameterType_ComplexOutputImage){ + printOutputComplexImage(); + }else{ + std::cout << " " << std::endl; + if(type == ParameterType_InputImage || type == ParameterType_InputImageList || type == ParameterType_ComplexInputImage){ + printImages(); + } + else + if(type == ParameterType_InputVectorData || type == ParameterType_InputVectorDataList){ + printVector(); + } + else + if(type == ParameterType_InputFilename || type == ParameterType_OutputFilename){ + + std::string geoid("geoid"); + if(paramKey.find(geoid)!= std::string::npos) + printGeoid(); + else{ + std::string dtype("vector"); + std::string descr(m_Application->GetParameterDescription(paramKey)); + if(descr.find(dtype)!= std::string::npos) + printVector(); + else{ + std::string dtype1("ASCII"); + if(descr.find(dtype1)!= std::string::npos) + printAscii(); + else{ + std::string dtype2("XML"); + std::string dtype3("xml"); + if(descr.find(dtype2)!= std::string::npos || descr.find(dtype3)!= std::string::npos) + printXml(); + else + printImages(); + } + } + } + } + std::cout << " " << std::endl; + } + } + } + + + } + } + std::cout << " " << std::endl; + std::cout << " " << std::endl; + int hasOutput=-1; + for (unsigned int i = 0; i < appKeyList.size(); i++){ + const std::string paramKey(appKeyList[i]); + std::vector values; + Parameter::Pointer param = m_Application->GetParameterByKey(paramKey); + ParameterType type = m_Application->GetParameterType(paramKey); + Role role = m_Application->GetParameterRole(paramKey); + + if(paramKey!="inxml" && paramKey!="outxml" && + ((type == ParameterType_OutputVectorData || type == ParameterType_OutputImage + || type == ParameterType_OutputImage || type == ParameterType_ComplexOutputImage + || type == ParameterType_OutputFilename) || role==1) && type != ParameterType_Group){ + hasOutput=1; + std::vector values; + Parameter::Pointer param = m_Application->GetParameterByKey(paramKey); + ParameterType type = m_Application->GetParameterType(paramKey); + Role role = m_Application->GetParameterRole(paramKey); + std::cout << " [" << paramKey << "]" << std::endl; + std::string s=m_Application->GetParameterDescription(paramKey); + if(s.length()>0){ + std::cout << " Title = " << s << std::endl; + std::cout << " Abstract = " << s << std::endl; + }else{ + std::cout << " Title = " << paramKey << std::endl; + std::cout << " Abstract = " << paramKey << std::endl; + } + + if(type == ParameterType_OutputImage || type == ParameterType_ComplexOutputImage){ + std::cout << " " << std::endl; + printImages(); + std::cout << " " << std::endl; + } + else + if(type == ParameterType_OutputVectorData || type == ParameterType_OutputImage){ + std::cout << " " << std::endl; + if(type == ParameterType_OutputImage) + printImages(); + else + printVector(); + std::cout << " " << std::endl; + } + else + if(type == ParameterType_String || type == ParameterType_StringList + || type == ParameterType_Float || type == ParameterType_Int){ + std::cout << " " << std::endl; + std::string lt; + if(type == ParameterType_Int) + lt="integer"; + if(type == ParameterType_Float) + lt="float"; + if(type == ParameterType_String || type == ParameterType_StringList) + lt="string"; + std::cout << " dataType = " << lt << std::endl; + std::cout << " " << std::endl; + std::cout << " " << std::endl; + } + else + if(type == ParameterType_OutputFilename){ + std::cout << " " << std::endl; + std::string descr(m_Application->GetParameterDescription(paramKey)); + std::string dtype("csv"); + std::string dtype1("CSV"); + if(descr.find(dtype)!= std::string::npos || descr.find(dtype1)!= std::string::npos) + printCSV(); + else{ + std::string dtype2("text file"); + if(descr.find(dtype2)!= std::string::npos) + printAscii(); + else{ + std::string dtype2("XML"); + std::string dtype3("xml"); + if(descr.find(dtype2)!= std::string::npos || descr.find(dtype3)!= std::string::npos) + printXml(); + else{ + std::string dtype4("vector"); + std::string dtype5("Vector"); + if(descr.find(dtype4)!= std::string::npos || descr.find(dtype5)!= std::string::npos) + printVector(); + else{ + std::string dtype6("kmz"); + std::string dtype7("Kmz"); + if(descr.find(dtype6)!= std::string::npos || descr.find(dtype6)!= std::string::npos) + printKmz(); + else + printUnknown(); + } + } + } + } + std::cout << " " << std::endl; + } + } + } + if(hasOutput<0) + printDefaultOutput(); + std::cout << " " << std::endl; + std::cout.rdbuf(coutbuf); + } + } + + return EXIT_SUCCESS; +} + Index: /branches/PublicaMundi_David_integration_01-devel/thirds/saga2zcfg/Makefile =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/saga2zcfg/Makefile (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/saga2zcfg/Makefile (revision 672) @@ -0,0 +1,14 @@ +ZRPATH=../../zoo-project +include ${ZRPATH}/zoo-kernel/ZOOMakefile.opts +CFLAGS=${ZOO_CFLAGS} ${XML2CFLAGS} ${GDAL_CFLAGS} ${PYTHONCFLAGS} -DLINUX_FREE_ISSUE #-DDEBUG +CC=gcc + +WXCXX=`wx-config --cxx` +WXCFLAGS=`wx-config --cxxflags` +WXLIBS=`wx-config --libs` + +saga2zcfg: saga2zcfg.c + ${WXCXX} ${SAGA_CFLAGS} ${WXCFLAGS} ${CFLAGS} -fpic -o saga2zcfg ./saga2zcfg.c ${GDAL_LIBS} ${MACOS_LD_FLAGS} ${WXLIBS} ${SAGA_LDFLAGS} + +clean: + rm -f saga2zcfg Index: /branches/PublicaMundi_David_integration_01-devel/thirds/saga2zcfg/saga2zcfg.c =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/thirds/saga2zcfg/saga2zcfg.c (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/thirds/saga2zcfg/saga2zcfg.c (revision 672) @@ -0,0 +1,393 @@ +#include + +#include +#include + +#include +#include + +int Callback(TSG_UI_Callback_ID ID, CSG_UI_Parameter &Param_1, CSG_UI_Parameter &Param_2){ + return( 1 ); +} + +TSG_PFNC_UI_Callback Get_Callback(void){ + return( &Callback ); +} + +void cleanAbstract(CSG_String abstract,char**res){ + char* tmp=strdup(abstract.b_str()); + CSG_String val=CSG_String("")+tmp; + if(val.Contains("\r")){ + val.Replace("\r","
      "); + } + if(val.Contains("\n")){ + val.Replace("\n","
      "); + } + if(val.Contains("<")){ + val.Replace("<","<"); + } + if(val.Contains(">")){ + val.Replace(">",">"); + } + free(tmp); + if(val.is_Empty()) + *res=NULL; + else + *res=strdup(val.b_str()); +} + +void printBasicMetadata(FILE* stdout,CSG_Parameter* param,bool out=false,bool range=false,bool min=true,bool tin=false,char* tname=NULL,char* ttitle=NULL){ + fprintf(stdout," [%s]\n",(CSG_String(param->Get_Identifier())+(range?(min?"_MIN":"_MAX"):(tin?CSG_String("_")+tname:""))).b_str()); + fprintf(stdout," Title = %s\n",(CSG_String(param->Get_Name())+(range?(min?" (min value)":" (max value)"):(tin&&ttitle!=NULL?ttitle:""))).b_str()); + if(CSG_String(param->Get_Description()).is_Empty()) + fprintf(stdout," Abstract = %s\n",CSG_String(param->Get_Name()).b_str()); + else{ + char* tmp=strdup(CSG_String(param->Get_Description()).b_str()); + CSG_String val=CSG_String("")+tmp; + if(val.Contains("\r")){ + val.Replace("\r","
      "); + } + if(val.Contains("\n")){ + val.Replace("\n","
      "); + } + if(val.Contains("<")){ + val.Replace("<","<"); + } + if(val.Contains(">")){ + val.Replace(">",">"); + } + free(tmp); + fprintf(stdout," Abstract = %s\n",val.b_str()); + } + if(!out){ + if(param->is_Option() || param->is_Optional()){ + fprintf(stdout," minOccurs = 0\n"); + if(param->is_Option()) + fprintf(stdout," maxOccurs = 1\n"); + else{ + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("_list"))) + fprintf(stdout," maxOccurs = 1024\n"); + else + fprintf(stdout," maxOccurs = 1\n"); + } + }else{ + if(param->is_Input()) + fprintf(stdout," minOccurs = 1\n"); + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("_list"))) + fprintf(stdout," maxOccurs = 1024\n"); + else + fprintf(stdout," maxOccurs = 1\n"); + } + } + if(range){ + + } +} + +void printGrids(FILE* stdout){ + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = image/tiff\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = application/x-ogc-envi\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = application/x-ogc-aaigrid\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); +} + +void printShapes(FILE* stdout){ + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = text/xml\n"); + fprintf(stdout," encoding = utf-8\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = application/vnd.google-earth.kml+xml\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = application/json\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); +} + +void printTables(FILE* stdout){ + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = text/csv\n"); + fprintf(stdout," encoding = utf-8\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = text/csv\n"); + fprintf(stdout," encoding = base64\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); +} + +void printPoints(FILE* stdout){ + fprintf(stdout," \n"); + fprintf(stdout," \n"); + fprintf(stdout," mimeType = application/x-ogc-lasf\n"); + fprintf(stdout," extension = las\n"); + fprintf(stdout," \n"); + fprintf(stdout," \n"); +} + +int main(int argc, char *argv[]) { + if( !wxInitialize() ){ + fprintf(stderr,"initialisation failed"); + return -1; + } + setlocale(LC_NUMERIC, "C"); + static bool g_bShow_Messages = false; + SG_Set_UI_Callback(Get_Callback()); + int n = SG_Get_Module_Library_Manager().Add_Directory(wxT(MODULE_LIBRARY_PATH),false); + if( SG_Get_Module_Library_Manager().Get_Count() <= 0 ){ + fprintf(stderr,"could not load any tool library"); + return -2; + } + + for(int i=0;iGet_Count(); + if(!library->Get_Library_Name().Contains("io_")) { + + for(int j=0;jGet_Module(j); + if(module!=NULL && !module->needs_GUI() /*&& !module->is_Interactive()*/ ){ + + mkdir(library->Get_Library_Name().b_str(),0755); + + FILE *stdout1=fopen((library->Get_Library_Name()+"/"+module->Get_ID()+".zcfg").b_str(),"w+"); + fprintf(stdout1,"[%d]\n",j); + fprintf(stdout1," Title = %s\n",module->Get_Name().b_str()); + if(CSG_String(module->Get_Description()).is_Empty() || + module->Get_Description().Length()Get_Name().Length() ) + fprintf(stdout1," Abstract = %s\n",module->Get_Name().b_str()); + else{ + char *val0; + cleanAbstract(module->Get_Description(),&val0); + if(val0==NULL) + fprintf(stdout1," Abstract = %s\n",module->Get_Name().b_str()); + else{ + fprintf(stdout1," Abstract = %s\n",val0); + free(val0); + } + } + fprintf(stdout1," storeSupported = true\n"); + fprintf(stdout1," statusSupported = true\n"); + fprintf(stdout1," serviceType = SAGA\n"); + fprintf(stdout1," serviceProvider = %s\n",library->Get_Library_Name().b_str()); + CSG_Parameters * params=module->Get_Parameters(); + int pc=params->Get_Count(); + + fprintf(stdout1," \n"); + for(int k=0;kGet_Parameter(k); + + // Node should be used for defining Complex ComplexData + if(CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("color"))){ + + } + else if(CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("range"),true)){ + + param->Restore_Default(); + + printBasicMetadata(stdout1,param,false,true,true); + fprintf(stdout1," \n"); + fprintf(stdout1," dataType = float\n"); + CSG_Parameter_Range *range=param->asRange(); + fprintf(stdout1," \n"); + fprintf(stdout1," value = %f\n",((CSG_Parameter_Range*)param->Get_Data())->Get_LoVal()); + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + + printBasicMetadata(stdout1,param,false,true,false); + fprintf(stdout1," \n"); + fprintf(stdout1," dataType = float\n"); + fprintf(stdout1," \n"); + fprintf(stdout1," value = %f\n",((CSG_Parameter_Range*)param->Get_Data())->Get_HiVal()); + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + + } + else if(param!=NULL && !param->is_Output() + && + !CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("parameters"),true) + && + !CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("grid_system"),true) + && + !CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("node"),true)){ + + printBasicMetadata(stdout1,param); + + if(CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("file"),true)){ + if(CSG_String(param->Get_Description()).Contains(CSG_String("HTML"))){ + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + fprintf(stdout1," mimeType = text/html\n"); + fprintf(stdout1," encoding = utf-8\n"); + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + } + else{ + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + if(CSG_String(param->Get_Description()).Contains(CSG_String("HTML"))){ + fprintf(stdout1," mimeType = text/html\n"); + }else + if(CSG_String(param->Get_Description()).Contains(CSG_String("SVG"))){ + fprintf(stdout1," mimeType = image/svg+xml\n"); + }else + fprintf(stdout1," mimeType = text/plain\n"); + if(CSG_String(param->Get_Description()).Contains(CSG_String("ASCII"))){ + fprintf(stdout1," encoding = ascii\n"); + }else + fprintf(stdout1," encoding = utf-8\n"); + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + } + } + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("shapes")) || + CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("tin")) ){ + printShapes(stdout1); + } + if(CSG_String(param->Get_Type_Identifier()).Contains("points")){ + printPoints(stdout1); + } + if(CSG_String(param->Get_Type_Identifier()).Contains("grid") || + CSG_String(param->Get_Type_Identifier()).Contains("data_")){ + printGrids(stdout1); + } + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("table"))){ + printTables(stdout1); + } + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("text"))){ + fprintf(stdout1," \n"); + fprintf(stdout1," dataType = string\n"); + fprintf(stdout1," \n"); + if( !param->Get_Data()->Get_Default().is_Empty() ){ + fprintf(stdout1," value = %s\n",param->Get_Data()->Get_Default().b_str()); + } + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + } + if(CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("double"),true) + || + CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("degree"),true) + || + CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("integer"),true)){ + fprintf(stdout1," \n"); + if(CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("double"),true) || + CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("degree"),true)) + fprintf(stdout1," dataType = float\n"); + else + fprintf(stdout1," dataType = integer\n"); + + fprintf(stdout1," \n"); + if( !param->Get_Data()->Get_Default().is_Empty() ){ + fprintf(stdout1," value = %s\n",param->Get_Data()->Get_Default().b_str()); + } + if(param->asValue()->has_Minimum() && param->asValue()->has_Maximum()){ + fprintf(stdout1," rangeMin = %f\n",param->asValue()->Get_Minimum()); + fprintf(stdout1," rangeMax = %f\n",param->asValue()->Get_Maximum()); + fprintf(stdout1," rangeClosure = c\n"); + } + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + } + if(CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("boolean"),true)){ + fprintf(stdout1," \n"); + fprintf(stdout1," dataType = bool\n"); + fprintf(stdout1," \n"); + if( !param->Get_Data()->Get_Default().is_Empty() ){ + fprintf(stdout1," value = %s\n",(param->Get_Data()->Get_Default().Contains("0")?"false":"true")); + } + fprintf(stdout1," \n"); + fprintf(stdout1," \n"); + } + if(CSG_String(param->Get_Type_Identifier()).is_Same_As(CSG_String("choice"),true)){ + CSG_Parameter_Choice* choice=param->asChoice(); + if(choice!=NULL){ + fprintf(stdout1," \n"); + fprintf(stdout1," dataType = string\n"); + fprintf(stdout1," AllowedValues = "); + int clen=choice->Get_Count(); + if(clen>0){ + for(int l=0;lGet_Item(l))).b_str()); + if(l+1\n"); + if( !param->Get_Data()->Get_Default().is_Empty() ){ + fprintf(stdout1," value = %s\n",CSG_String(choice->Get_Item(atoi(param->Get_Data()->Get_Default()))).b_str()); + } + fprintf(stdout1,"       \n"); + fprintf(stdout1,"       \n"); + } + } + } + } + fprintf(stdout1,"       \n"); + fprintf(stdout1," \n"); + + bool hasOutput=false; + + for(int k=0;kGet_Parameter(k); + if(param!=NULL && param->is_Output()){ + hasOutput=true; + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("tin"))){ + char* tinOut[5]={ + (char*)"POINTS", + (char*)"CENTER", + (char*)"EDGES", + (char*)"TRIANGLES", + (char*)"POLYGONS" + }; + for(int l=0;l<5;l++){ + char *ttitle=(char*)malloc((strlen(tinOut[l])+8)*sizeof(char)); + sprintf(ttitle,"%s Shapes",tinOut[l]); + printBasicMetadata(stdout1,param,true,false,true,true,tinOut[l],ttitle); + printShapes(stdout1); + } + } + else { + printBasicMetadata(stdout1,param,true); + + if(CSG_String(param->Get_Type_Identifier()).Contains("points")){ + printPoints(stdout1); + } + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("shapes"))){ + printShapes(stdout1); + } + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("grid")) || + CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("data_object"))){ + printGrids(stdout1); + } + if(CSG_String(param->Get_Type_Identifier()).Contains(CSG_String("table"))){ + printTables(stdout1); + } + + } + } + } + fprintf(stdout1,"\n"); + fclose(stdout1); + if(!hasOutput) + unlink((library->Get_Library_Name()+"/"+module->Get_ID()+".zcfg").b_str()); + } + } + } + } + wxUninitialize(); + + return 0; +} Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/COMMITTERS =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/COMMITTERS (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/COMMITTERS (revision 672) @@ -0,0 +1,30 @@ +=========================================================== +List of ZOO-Project committers +=========================================================== + +Folks who have agreed to ZOO-Project Commiter Guildlines terms: + +SVN Login(s) Name/Contact +============ ============ +david David SAGGIORATO + dsaggiorato at free.fr +djay Gérald FENOY + gerald.fenoy at geolabs.fr +jmckenna Jeff MCKENNA + jmckenna at gatewaygeomatics.com +kalxas Angelos TZOTSOS + gcpp.kalxas at gmail.com +lucadelu Luca DELUCCHI + lucadeluge at gmail.com +nbozon Nicolas BOZON + nicolas.bozon@gmail.com +neteler Markus NETELER + neteler at osgeo.org +nmarco Marco NEGRETTI + marco.negretti at polimi.it +knut Knut LANDMARK + Knut.Landmark@ffi.no +reluc René-Luc D'HONT + rldhont at gmail.com +tclarke Trevor CLARKE + tclarke at ball.com Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/HISTORY.txt =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/HISTORY.txt (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/HISTORY.txt (revision 672) @@ -0,0 +1,128 @@ +Version 1.5.0-dev + * Initial support for WPS 2.0.0 including the Dismiss extension + * Fix concurrency access to status informations + * Use simple file rather than shared memory for storing status informations + * Add support for db backend to store status informations + * Add the lib_zoo_service shared library to be linked against C services + * Add ZOO-API for the PHP language (with documentation) + * Add doxygen comments in source code + * Add support for multiple Exception nodes + * Add a length key when creating MapArray + * Add OTB support for applications as a service + * Add the otb2zcfg utility to produce zcfg for otb applications + * Add OTB Application Observer to have progress status updates + * Fix maxOccurs handling + * Fix gesture of downloaded inputs when multiple values are given + * Add detection of generated_file key in outputs to read the file + generated by a service + * Add a minimal parsing API + * Run validateRequest (download, default settings and decoding) + after fork if any + * Add SAGA-GIS support for modules as a service + * Add saga2zcfg utility to generate zcfg for SAGA-GIS modules + * Add SAGA-GIS Observer to have ongoing status updates + +Version 1.4.0 + * Small fix for mimeType of results for CGAL services + +Version 1.4.0-rc1 + * Binary support for PHP language + * ZOO-API for the Java language + * ZOO-Client Javascript API + * FastCGI fixes + * JavaScript ZOO-API enhancements (COOKIE use and Output in + generated XML) + * Add debian files + * Inputs passed by reference downloaded in parallel + * Conform behavior for DescribeProcess when the Identifier was not + found + * Add support of maximumMegabytes keywords for ComplexData Inputs + * Add the optional YAML ZCFG support #4 and the zcfg2yaml converter + * Return error messages that enable the service provider to quickly + identify the root cause of errors due to configuration file syntax + (ticket #90) + * Fix logic in addMapToMap (ticket #91) + * Enable AllowedValue and multiple Range definitions using default + and supported blocks + * Add the lastest revision number in version.h (available in Python + ZOO-API) + * Add the optional Ruby Language Support to the ZOO-Kernel with an + API similar to the Python ZOO-API + * Small rewrite of Python support + * Inputs can be requested over https protocol (ticket #86) + * Add capability to define both percentage of execution and a + message (ticket #87). + * Add usid in lenv section used to generate an unique identifier + based on time and the process identifier. + * Add gdal_contour service + * Add dynamic definition of serverAddress from the main section + +Version 1.3.0-rc2 + * Fix POST Request issue (ticket #34) + * Fix COOKIE gesture (ticket #79) + * Remove verbose messages when using MapServer W*S (ticket #80) + * Add COMMITTERS and LICENSE files + +Version 1.3.0-rc1 + + * Updating ZOO.Class object with the OpenLayers.Class Updating + ZOO.Class with the (ticket #64) + * Correct the content of proj4js (ticket #63) + * Enhance the COOKIE gesture (ticket #68) + * Support for dataInputs URLEncoded and xlink:href (ticket #62) + * Use the same object structure for JavaScript arguments than for + Python + * Add the Normalized Difference Vegetation Index service + * Add importScripts function to JavaScript support (ticket #66) + * Add multiple inputs values for the same identifier (ticket #72) + * Add Python ZOO-API to access ZOO-Kernel internel functions + * Add a [headers] section in main.cfg file to add specifics to + header returned + * Add support for multiple outputs for both GET and POST requests + * Add Content-Length to the headers if the result is sized + * Add Content-Disposition to the headers if the result contains a + filename + * Add support for sending headers through JS ZOO-api + * Add support for multi-valued inputs in JS ZOO-api + * Fixing issue about invalid status document #73 + * Add Python-3.3.0 support + * Update documentation + * Add MapServer W*S Support documentation #34 + +Version 1.2.0-rc3 + + * add basic SOAP Envelope support (ticket #49) + * support request when Content-Length header is not set by the + * client (ticket #57) + * fix issue when POST request is empty (ticket #45) + * add minimalist cache system (ticket #51) + * fix Python support (ticket #29) + +Verseion 1.2.0-rc2 + + * fix for process to run in background + * add support for ALL identifier for !DescribeProcess + * add a small test suite in the testing directory to test ogr base-vect-ops + * big fix for storage of Session maps on disk + * support for {{{}}} node in ZCFG files + * fastcgi version now support both !GetCapabilities and !DescribeProcess requests + +Version 1.2.0-rc1 + + * add WIN32 support + * add GRASS support through wps-grass-bridge + * add languages support using libintl + * binary support for inputs and outputs for both JAVA and Python + * automatic loading of ZOO-API and proj4js files (if present in the ZOO-Kernel directory) when loading JS Service Provider + * numerous memory leaks removed + * add PERL support + * enhance speed for JAVA support + * enhance POST request support + * add !BoundingBoxData support + * Python support is now optional as other languages + * add lenv section before running the service to store informations runtime specific + * add COOKIE support and {{{senv}}} section to store informations session specific + * add {{{USE_GDB}}} compilation flag to remove signal handling for debuging purpose + * enhance base64 support when included in and XML POST request + * return !ExceptionReport when no protocol was specified for xlink:href value + Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/LICENSE =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/LICENSE (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/LICENSE (revision 672) @@ -0,0 +1,166 @@ +ZOO-Project Licensing +--------------------- + +This file attempts to include all licenses that apply within the ZOO-Project +source tree, in particular any that are supposed to be exposed to the end user +for credit requirements for instance. + +ZOO-Kernel License +------------------ + +Copyright (c) 2009-2015 GeoLabs SARL +Copyright 2010-2011 Fondazione Edmund Mach. All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the “Software”), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies of this Software or works derived from this Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +ZOO-Kernel OTB Support +---------------------- + +Copyright (c) Centre National d'Etudes Spatiales. All rights reserved. +See OTBCopyright.txt for details. + +Some parts of this code are derived from ITK. See ITKCopyright.txt +for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +See Ref: http://hg.orfeo-toolbox.org/OTB/ Copyright + +ZOO-API License +--------------- + +Copyright 2011-2013 GeoLabs SARL. All rights reserved. +Copyright 2010 3liz SARL. All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +Copyright (c) 2006-2011 by OpenLayers Contributors (see +https://github.com/openlayers/openlayers/blob/master/authors.txt for full +list of contributors). Published under the Clear BSD license. +See http://svn.openlayers.org/trunk/openlayers/license.txt for the +full text of the license. + +qrencode ZOO-Services License +----------------------------- + +Copyright (C) 2006-2012 Kentaro Fukuchi + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +Other ZOO-Services License +-------------------------- + +Copyright (c) 2009-2013, GeoLabs SARL +Copyright (c) 2006, 2009 Matthew Perry +Copyright (c) 2009 Even Rouault +Copyright (c) 2007, Andrey Kiselev +Copyright (c) 1998, 1999, 2002, Frank Warmerdam +Copyright (c) 2002, i3 - information integration and imaging Fort Collin, CO + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +CGIC License +------------ + +CGIC, copyright 2009 GeoLabs SARL. +CGIC, copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, +2004 by Thomas Boutell and Boutell.Com, Inc.. Permission is granted to +use CGIC in any application, commercial or noncommercial, at no cost. +HOWEVER, this copyright paragraph must appear on a "credits" page +accessible in the public online and offline documentation of the program. +Modified versions of the CGIC library should not be distributed without +the attachment of a clear statement regarding the author of the +modifications, and this notice may in no case be removed. +Modifications may also be submitted to the author for inclusion +in the main CGIC distribution. + +IF YOU WOULD PREFER NOT TO ATTACH THE ABOVE NOTICE to +the public documentation of your application, consult the +information which follows regarding the availability +of a nonexclusive commercial license for CGIC. + +dirent-win32 License +-------------------- + +Copyright (C) 2006 Toni Ronkko + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +``Software''), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL TONI RONKKO BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/Makefile =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/Makefile (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/Makefile (revision 672) @@ -0,0 +1,35 @@ +include ../../zoo-kernel/ZOOMakefile.opts + +OS:=$(shell uname -s) +ext=so +ifeq ($(OS),Darwin) + ext=dylib +endif + +JAVA_FILES=../../zoo-kernel/${JAVA_FILE} + +ifeq ($(JS_ENABLED),-DUSE_JS) + JS_FILES=../../zoo-kernel/${JS_FILE}, +endif +ifeq ($(MS_FILE),service_internal_ms.o) + MS_FILES=../../zoo-kernel/${MS_FILE}, +endif + + + +all: libZOO.${ext} + +ZOO.class: ZOO.java + javac ZOO.java + +ZOO.h: ZOO.java ZOO.class + javah ZOO + +zoo-api.o: zoo-api.c ZOO.h + gcc -fPIC -c zoo-api.c ${JAVACFLAGS} ${XML2CFLAGS} -I../../zoo-kernel/ -I../../../thirds/cgic206/ + +libZOO.${ext}: zoo-api.o + gcc zoo-api.o -shared -o libZOO.${ext} -Wl,../../zoo-kernel/service_internal.o,${JAVA_FILES},${MS_FILES}${JS_FILES}../../zoo-kernel/ulinet.o ${GDAL_LIBS} ${XML2LDFLAGS} ${PYTHONLDFLAGS} ${PERLLDFLAGS} ${PHPLDFLAGS} ${JAVALDFLAGS} ${JSLDFLAGS} -lcrypto ${MS_LDFLAGS} ${MACOS_LD_FLAGS} -lcurl -lfcgi ${MACOS_LD_NET_FLAGS} + +clean: + rm -f *${ext} *o *.h *class Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/ZOO.java =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/ZOO.java (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/ZOO.java (revision 672) @@ -0,0 +1,10 @@ +import java.lang.*; +import java.util.*; + +public class ZOO { + static { System.loadLibrary("ZOO"); } + public static Integer SERVICE_SUCCEEDED=3; + public static Integer SERVICE_FAILED=4; + public static native String _(String a); + public static native Integer updateStatus(HashMap conf,String pourcent,String message); +} Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/zoo-api.c =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/zoo-api.c (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/java/zoo-api.c (revision 672) @@ -0,0 +1,31 @@ +#include "ZOO.h" +#include "service.h" +#include "service_internal.h" +#include "service_internal_java.h" + +JNIEXPORT jstring JNICALL Java_ZOO__1 + (JNIEnv *env, jclass class, jstring msg){ + const char *message = (*env)->GetStringUTFChars(env,msg, 0); + return (*env)->NewStringUTF(env, _(message)); + +} + +JNIEXPORT jobject JNICALL Java_ZOO_updateStatus + (JNIEnv *env, jclass class, jobject conf, jstring pourc, jstring msg){ + + jclass scHashMapClass,scHashMap_class; +#ifdef JAVA7 + scHashMapClass = (*env).FindClass("java/util/HashMap"); +#else + scHashMapClass = (*env)->FindClass(env, "java/util/HashMap"); +#endif + const char *pourcent = (*env)->GetStringUTFChars(env,pourc, 0); + const char *message = (*env)->GetStringUTFChars(env,msg, 0); + maps* m = mapsFromHashMap(env,conf,scHashMapClass); + setMapInMaps(m,"lenv","status",pourcent); + setMapInMaps(m,"lenv","message",message); + _updateStatus(m); + freeMaps(&m); + free(m); + return (jint)0; +} Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/js/ZOO-api.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/js/ZOO-api.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/js/ZOO-api.js (revision 672) @@ -0,0 +1,6322 @@ +/** + * Author : René-Luc D'Hont + * + * Copyright 2010 3liz SARL. All rights reserved. + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +/* Copyright (c) 2006-2011 by OpenLayers Contributors (see + * https://github.com/openlayers/openlayers/blob/master/authors.txt for full + * list of contributors). Published under the Clear BSD license. + * See http://svn.openlayers.org/trunk/openlayers/license.txt for the + * full text of the license. + */ + +/** + * Class: ZOO + */ +ZOO = { + /** + * Constant: SERVICE_ACCEPTED + * {Integer} used for + */ + SERVICE_ACCEPTED: 0, + /** + * Constant: SERVICE_STARTED + * {Integer} used for + */ + SERVICE_STARTED: 1, + /** + * Constant: SERVICE_PAUSED + * {Integer} used for + */ + SERVICE_PAUSED: 2, + /** + * Constant: SERVICE_SUCCEEDED + * {Integer} used for + */ + SERVICE_SUCCEEDED: 3, + /** + * Constant: SERVICE_FAILED + * {Integer} used for + */ + SERVICE_FAILED: 4, + /** + * Function: removeItem + * Remove an object from an array. Iterates through the array + * to find the item, then removes it. + * + * Parameters: + * array - {Array} + * item - {Object} + * + * Return + * {Array} A reference to the array + */ + removeItem: function(array, item) { + for(var i = array.length - 1; i >= 0; i--) { + if(array[i] == item) { + array.splice(i,1); + } + } + return array; + }, + /** + * Function: indexOf + * + * Parameters: + * array - {Array} + * obj - {Object} + * + * Returns: + * {Integer} The index at, which the first object was found in the array. + * If not found, returns -1. + */ + indexOf: function(array, obj) { + for(var i=0, len=array.length; i} (or any object with both .x, .y properties) + * p2 - {} (or any object with both .x, .y properties) + * + * Returns: + * {Float} The distance (in km) between the two input points as measured on an + * ellipsoid. Note that the input point objects must be in geographic + * coordinates (decimal degrees) and the return distance is in kilometers. + */ + distVincenty: function(p1, p2) { + var a = 6378137, b = 6356752.3142, f = 1/298.257223563; + var L = ZOO.rad(p2.x - p1.y); + var U1 = Math.atan((1-f) * Math.tan(ZOO.rad(p1.y))); + var U2 = Math.atan((1-f) * Math.tan(ZOO.rad(p2.y))); + var sinU1 = Math.sin(U1), cosU1 = Math.cos(U1); + var sinU2 = Math.sin(U2), cosU2 = Math.cos(U2); + var lambda = L, lambdaP = 2*Math.PI; + var iterLimit = 20; + while (Math.abs(lambda-lambdaP) > 1e-12 && --iterLimit>0) { + var sinLambda = Math.sin(lambda), cosLambda = Math.cos(lambda); + var sinSigma = Math.sqrt((cosU2*sinLambda) * (cosU2*sinLambda) + + (cosU1*sinU2-sinU1*cosU2*cosLambda) * (cosU1*sinU2-sinU1*cosU2*cosLambda)); + if (sinSigma==0) { + return 0; // co-incident points + } + var cosSigma = sinU1*sinU2 + cosU1*cosU2*cosLambda; + var sigma = Math.atan2(sinSigma, cosSigma); + var alpha = Math.asin(cosU1 * cosU2 * sinLambda / sinSigma); + var cosSqAlpha = Math.cos(alpha) * Math.cos(alpha); + var cos2SigmaM = cosSigma - 2*sinU1*sinU2/cosSqAlpha; + var C = f/16*cosSqAlpha*(4+f*(4-3*cosSqAlpha)); + lambdaP = lambda; + lambda = L + (1-C) * f * Math.sin(alpha) * + (sigma + C*sinSigma*(cos2SigmaM+C*cosSigma*(-1+2*cos2SigmaM*cos2SigmaM))); + } + if (iterLimit==0) { + return NaN; // formula failed to converge + } + var uSq = cosSqAlpha * (a*a - b*b) / (b*b); + var A = 1 + uSq/16384*(4096+uSq*(-768+uSq*(320-175*uSq))); + var B = uSq/1024 * (256+uSq*(-128+uSq*(74-47*uSq))); + var deltaSigma = B*sinSigma*(cos2SigmaM+B/4*(cosSigma*(-1+2*cos2SigmaM*cos2SigmaM)- + B/6*cos2SigmaM*(-3+4*sinSigma*sinSigma)*(-3+4*cos2SigmaM*cos2SigmaM))); + var s = b*A*(sigma-deltaSigma); + var d = s.toFixed(3)/1000; // round to 1mm precision + return d; + }, + /** + * Function: Class + * Method used to create ZOO classes. Includes support for + * multiple inheritance. + */ + Class: function() { + var Class = function() { + this.initialize.apply(this, arguments); + }; + var extended = {}; + var parent; + for(var i=0; i 1) { + var newArgs = [C, P].concat( + Array.prototype.slice.call(arguments).slice(1, len-1), F); + ZOO.inherit.apply(null, newArgs); + } else { + C.prototype = F; + } + return C; +}; +/** + * Function: create + * Function for creating CLASS + */ +ZOO.Class.create = function() { + return function() { + if (arguments && arguments[0] != ZOO.Class.isPrototype) { + this.initialize.apply(this, arguments); + } + }; +}; +/** + * Function: inherit + * Function for inheriting CLASS + */ +ZOO.Class.inherit = function (P) { + var C = function() { + P.call(this); + }; + var newArgs = [C].concat(Array.prototype.slice.call(arguments)); + ZOO.inherit.apply(null, newArgs); + return C.prototype; +}; +/** + * Function: inherit + * Function for inheriting CLASS + */ +ZOO.inherit = function(C, P) { + var F = function() {}; + F.prototype = P.prototype; + C.prototype = new F; + var i, l, o; + for(i=2, l=arguments.length; i 0) { + var separator = (url.indexOf('?') > -1) ? '&' : '?'; + url += separator + paramString; + } + return ZOORequest('GET',url); + }, + /** + * Function: POST + * Send an HTTP POST request. + * + * Parameters: + * url - {String} The URL to request. + * body - {String} The request's body to send. + * headers - {Object} A key-value object of headers to push to + * the request's head + * + * Returns: + * {String} Request result. + */ + Post: function(url,body,headers) { + if(!(headers instanceof Array)) { + var headersArray = []; + for (var name in headers) { + headersArray.push(name+': '+headers[name]); + } + headers = headersArray; + } + return ZOORequest('POST',url,body,headers); + } +}; + +/** + * Class: ZOO.Bounds + * Instances of this class represent bounding boxes. Data stored as left, + * bottom, right, top floats. All values are initialized to null, + * however, you should make sure you set them before using the bounds + * for anything. + */ +ZOO.Bounds = ZOO.Class({ + /** + * Property: left + * {Number} Minimum horizontal coordinate. + */ + left: null, + /** + * Property: bottom + * {Number} Minimum vertical coordinate. + */ + bottom: null, + /** + * Property: right + * {Number} Maximum horizontal coordinate. + */ + right: null, + /** + * Property: top + * {Number} Maximum vertical coordinate. + */ + top: null, + /** + * Constructor: ZOO.Bounds + * Construct a new bounds object. + * + * Parameters: + * left - {Number} The left bounds of the box. Note that for width + * calculations, this is assumed to be less than the right value. + * bottom - {Number} The bottom bounds of the box. Note that for height + * calculations, this is assumed to be more than the top value. + * right - {Number} The right bounds. + * top - {Number} The top bounds. + */ + initialize: function(left, bottom, right, top) { + if (left != null) + this.left = parseFloat(left); + if (bottom != null) + this.bottom = parseFloat(bottom); + if (right != null) + this.right = parseFloat(right); + if (top != null) + this.top = parseFloat(top); + }, + /** + * Method: clone + * Create a cloned instance of this bounds. + * + * Returns: + * {} A fresh copy of the bounds + */ + clone:function() { + return new ZOO.Bounds(this.left, this.bottom, + this.right, this.top); + }, + /** + * Method: equals + * Test a two bounds for equivalence. + * + * Parameters: + * bounds - {} + * + * Returns: + * {Boolean} The passed-in bounds object has the same left, + * right, top, bottom components as this. Note that if bounds + * passed in is null, returns false. + */ + equals:function(bounds) { + var equals = false; + if (bounds != null) + equals = ((this.left == bounds.left) && + (this.right == bounds.right) && + (this.top == bounds.top) && + (this.bottom == bounds.bottom)); + return equals; + }, + /** + * Method: toString + * + * Returns: + * {String} String representation of bounds object. + * (ex."left-bottom=(5,42) right-top=(10,45)") + */ + toString:function() { + return ( "left-bottom=(" + this.left + "," + this.bottom + ")" + + " right-top=(" + this.right + "," + this.top + ")" ); + }, + /** + * APIMethod: toArray + * + * Returns: + * {Array} array of left, bottom, right, top + */ + toArray: function() { + return [this.left, this.bottom, this.right, this.top]; + }, + /** + * Method: toBBOX + * + * Parameters: + * decimal - {Integer} How many significant digits in the bbox coords? + * Default is 6 + * + * Returns: + * {String} Simple String representation of bounds object. + * (ex. "5,42,10,45") + */ + toBBOX:function(decimal) { + if (decimal== null) + decimal = 6; + var mult = Math.pow(10, decimal); + var bbox = Math.round(this.left * mult) / mult + "," + + Math.round(this.bottom * mult) / mult + "," + + Math.round(this.right * mult) / mult + "," + + Math.round(this.top * mult) / mult; + return bbox; + }, + /** + * Method: toGeometry + * Create a new polygon geometry based on this bounds. + * + * Returns: + * {} A new polygon with the coordinates + * of this bounds. + */ + toGeometry: function() { + return new ZOO.Geometry.Polygon([ + new ZOO.Geometry.LinearRing([ + new ZOO.Geometry.Point(this.left, this.bottom), + new ZOO.Geometry.Point(this.right, this.bottom), + new ZOO.Geometry.Point(this.right, this.top), + new ZOO.Geometry.Point(this.left, this.top) + ]) + ]); + }, + /** + * Method: getWidth + * + * Returns: + * {Float} The width of the bounds + */ + getWidth:function() { + return (this.right - this.left); + }, + /** + * Method: getHeight + * + * Returns: + * {Float} The height of the bounds (top minus bottom). + */ + getHeight:function() { + return (this.top - this.bottom); + }, + /** + * Method: add + * + * Parameters: + * x - {Float} + * y - {Float} + * + * Returns: + * {} A new bounds whose coordinates are the same as + * this, but shifted by the passed-in x and y values. + */ + add:function(x, y) { + if ( (x == null) || (y == null) ) + return null; + return new ZOO.Bounds(this.left + x, this.bottom + y, + this.right + x, this.top + y); + }, + /** + * Method: extend + * Extend the bounds to include the point, lonlat, or bounds specified. + * Note, this function assumes that left < right and bottom < top. + * + * Parameters: + * object - {Object} Can be Point, or Bounds + */ + extend:function(object) { + var bounds = null; + if (object) { + // clear cached center location + switch(object.CLASS_NAME) { + case "ZOO.Geometry.Point": + bounds = new ZOO.Bounds(object.x, object.y, + object.x, object.y); + break; + case "ZOO.Bounds": + bounds = object; + break; + } + if (bounds) { + if ( (this.left == null) || (bounds.left < this.left)) + this.left = bounds.left; + if ( (this.bottom == null) || (bounds.bottom < this.bottom) ) + this.bottom = bounds.bottom; + if ( (this.right == null) || (bounds.right > this.right) ) + this.right = bounds.right; + if ( (this.top == null) || (bounds.top > this.top) ) + this.top = bounds.top; + } + } + }, + /** + * APIMethod: contains + * + * Parameters: + * x - {Float} + * y - {Float} + * inclusive - {Boolean} Whether or not to include the border. + * Default is true. + * + * Returns: + * {Boolean} Whether or not the passed-in coordinates are within this + * bounds. + */ + contains:function(x, y, inclusive) { + //set default + if (inclusive == null) + inclusive = true; + if (x == null || y == null) + return false; + x = parseFloat(x); + y = parseFloat(y); + + var contains = false; + if (inclusive) + contains = ((x >= this.left) && (x <= this.right) && + (y >= this.bottom) && (y <= this.top)); + else + contains = ((x > this.left) && (x < this.right) && + (y > this.bottom) && (y < this.top)); + return contains; + }, + /** + * Method: intersectsBounds + * Determine whether the target bounds intersects this bounds. Bounds are + * considered intersecting if any of their edges intersect or if one + * bounds contains the other. + * + * Parameters: + * bounds - {} The target bounds. + * inclusive - {Boolean} Treat coincident borders as intersecting. Default + * is true. If false, bounds that do not overlap but only touch at the + * border will not be considered as intersecting. + * + * Returns: + * {Boolean} The passed-in bounds object intersects this bounds. + */ + intersectsBounds:function(bounds, inclusive) { + if (inclusive == null) + inclusive = true; + var intersects = false; + var mightTouch = ( + this.left == bounds.right || + this.right == bounds.left || + this.top == bounds.bottom || + this.bottom == bounds.top + ); + if (inclusive || !mightTouch) { + var inBottom = ( + ((bounds.bottom >= this.bottom) && (bounds.bottom <= this.top)) || + ((this.bottom >= bounds.bottom) && (this.bottom <= bounds.top)) + ); + var inTop = ( + ((bounds.top >= this.bottom) && (bounds.top <= this.top)) || + ((this.top > bounds.bottom) && (this.top < bounds.top)) + ); + var inLeft = ( + ((bounds.left >= this.left) && (bounds.left <= this.right)) || + ((this.left >= bounds.left) && (this.left <= bounds.right)) + ); + var inRight = ( + ((bounds.right >= this.left) && (bounds.right <= this.right)) || + ((this.right >= bounds.left) && (this.right <= bounds.right)) + ); + intersects = ((inBottom || inTop) && (inLeft || inRight)); + } + return intersects; + }, + /** + * Method: containsBounds + * Determine whether the target bounds is contained within this bounds. + * + * bounds - {} The target bounds. + * partial - {Boolean} If any of the target corners is within this bounds + * consider the bounds contained. Default is false. If true, the + * entire target bounds must be contained within this bounds. + * inclusive - {Boolean} Treat shared edges as contained. Default is + * true. + * + * Returns: + * {Boolean} The passed-in bounds object is contained within this bounds. + */ + containsBounds:function(bounds, partial, inclusive) { + if (partial == null) + partial = false; + if (inclusive == null) + inclusive = true; + var bottomLeft = this.contains(bounds.left, bounds.bottom, inclusive); + var bottomRight = this.contains(bounds.right, bounds.bottom, inclusive); + var topLeft = this.contains(bounds.left, bounds.top, inclusive); + var topRight = this.contains(bounds.right, bounds.top, inclusive); + return (partial) ? (bottomLeft || bottomRight || topLeft || topRight) + : (bottomLeft && bottomRight && topLeft && topRight); + }, + CLASS_NAME: 'ZOO.Bounds' +}); + +/** + * Class: ZOO.Projection + * Class for coordinate transforms between coordinate systems. + * Depends on the zoo-proj4js library. zoo-proj4js library + * is loaded by the ZOO Kernel with zoo-api. + */ +ZOO.Projection = ZOO.Class({ + /** + * Property: proj + * {Object} Proj4js.Proj instance. + */ + proj: null, + /** + * Property: projCode + * {String} + */ + projCode: null, + /** + * Constructor: ZOO.Projection + * This class offers several methods for interacting with a wrapped + * zoo-pro4js projection object. + * + * Parameters: + * projCode - {String} A string identifying the Well Known Identifier for + * the projection. + * options - {Object} An optional object to set additional properties. + * + * Returns: + * {} A projection object. + */ + initialize: function(projCode, options) { + ZOO.extend(this, options); + this.projCode = projCode; + if (Proj4js) { + this.proj = new Proj4js.Proj(projCode); + } + }, + /** + * Method: getCode + * Get the string SRS code. + * + * Returns: + * {String} The SRS code. + */ + getCode: function() { + return this.proj ? this.proj.srsCode : this.projCode; + }, + /** + * Method: getUnits + * Get the units string for the projection -- returns null if + * zoo-proj4js is not available. + * + * Returns: + * {String} The units abbreviation. + */ + getUnits: function() { + return this.proj ? this.proj.units : null; + }, + /** + * Method: toString + * Convert projection to string (getCode wrapper). + * + * Returns: + * {String} The projection code. + */ + toString: function() { + return this.getCode(); + }, + /** + * Method: equals + * Test equality of two projection instances. Determines equality based + * soley on the projection code. + * + * Returns: + * {Boolean} The two projections are equivalent. + */ + equals: function(projection) { + if (projection && projection.getCode) + return this.getCode() == projection.getCode(); + else + return false; + }, + /* Method: destroy + * Destroy projection object. + */ + destroy: function() { + this.proj = null; + this.projCode = null; + }, + CLASS_NAME: 'ZOO.Projection' +}); +/** + * Method: transform + * Transform a point coordinate from one projection to another. Note that + * the input point is transformed in place. + * + * Parameters: + * point - {{ZOO.Geometry.Point> | Object} An object with x and y + * properties representing coordinates in those dimensions. + * sourceProj - {ZOO.Projection} Source map coordinate system + * destProj - {ZOO.Projection} Destination map coordinate system + * + * Returns: + * point - {object} A transformed coordinate. The original point is modified. + */ +ZOO.Projection.transform = function(point, source, dest) { + if (source.proj && dest.proj) + point = Proj4js.transform(source.proj, dest.proj, point); + return point; +}; + +/** + * Class: ZOO.Format + * Base class for format reading/writing a variety of formats. Subclasses + * of ZOO.Format are expected to have read and write methods. + */ +ZOO.Format = ZOO.Class({ + /** + * Property: options + * {Object} A reference to options passed to the constructor. + */ + options:null, + /** + * Property: externalProjection + * {} When passed a externalProjection and + * internalProjection, the format will reproject the geometries it + * reads or writes. The externalProjection is the projection used by + * the content which is passed into read or which comes out of write. + * In order to reproject, a projection transformation function for the + * specified projections must be available. This support is provided + * via zoo-proj4js. + */ + externalProjection: null, + /** + * Property: internalProjection + * {} When passed a externalProjection and + * internalProjection, the format will reproject the geometries it + * reads or writes. The internalProjection is the projection used by + * the geometries which are returned by read or which are passed into + * write. In order to reproject, a projection transformation function + * for the specified projections must be available. This support is + * provided via zoo-proj4js. + */ + internalProjection: null, + /** + * Property: data + * {Object} When is true, this is the parsed string sent to + * . + */ + data: null, + /** + * Property: keepData + * {Object} Maintain a reference () to the most recently read data. + * Default is false. + */ + keepData: false, + /** + * Constructor: ZOO.Format + * Instances of this class are not useful. See one of the subclasses. + * + * Parameters: + * options - {Object} An optional object with properties to set on the + * format + * + * Valid options: + * keepData - {Boolean} If true, upon , the data property will be + * set to the parsed object (e.g. the json or xml object). + * + * Returns: + * An instance of ZOO.Format + */ + initialize: function(options) { + ZOO.extend(this, options); + this.options = options; + }, + /** + * Method: destroy + * Clean up. + */ + destroy: function() { + }, + /** + * Method: read + * Read data from a string, and return an object whose type depends on the + * subclass. + * + * Parameters: + * data - {string} Data to read/parse. + * + * Returns: + * Depends on the subclass + */ + read: function(data) { + }, + /** + * Method: write + * Accept an object, and return a string. + * + * Parameters: + * object - {Object} Object to be serialized + * + * Returns: + * {String} A string representation of the object. + */ + write: function(data) { + }, + CLASS_NAME: 'ZOO.Format' +}); +/** + * Class: ZOO.Format.WKT + * Class for reading and writing Well-Known Text. Create a new instance + * with the constructor. + * + * Inherits from: + * - + */ +ZOO.Format.WKT = ZOO.Class(ZOO.Format, { + /** + * Constructor: ZOO.Format.WKT + * Create a new parser for WKT + * + * Parameters: + * options - {Object} An optional object whose properties will be set on + * this instance + * + * Returns: + * {} A new WKT parser. + */ + initialize: function(options) { + this.regExes = { + 'typeStr': /^\s*(\w+)\s*\(\s*(.*)\s*\)\s*$/, + 'spaces': /\s+/, + 'parenComma': /\)\s*,\s*\(/, + 'doubleParenComma': /\)\s*\)\s*,\s*\(\s*\(/, // can't use {2} here + 'trimParens': /^\s*\(?(.*?)\)?\s*$/ + }; + ZOO.Format.prototype.initialize.apply(this, [options]); + }, + /** + * Method: read + * Deserialize a WKT string and return a vector feature or an + * array of vector features. Supports WKT for POINT, + * MULTIPOINT, LINESTRING, MULTILINESTRING, POLYGON, + * MULTIPOLYGON, and GEOMETRYCOLLECTION. + * + * Parameters: + * wkt - {String} A WKT string + * + * Returns: + * {|Array} A feature or array of features for + * GEOMETRYCOLLECTION WKT. + */ + read: function(wkt) { + var features, type, str; + var matches = this.regExes.typeStr.exec(wkt); + if(matches) { + type = matches[1].toLowerCase(); + str = matches[2]; + if(this.parse[type]) { + features = this.parse[type].apply(this, [str]); + } + if (this.internalProjection && this.externalProjection) { + if (features && + features.CLASS_NAME == "ZOO.Feature") { + features.geometry.transform(this.externalProjection, + this.internalProjection); + } else if (features && + type != "geometrycollection" && + typeof features == "object") { + for (var i=0, len=features.length; i|Array} A feature or array of + * features + * + * Returns: + * {String} The WKT string representation of the input geometries + */ + write: function(features) { + var collection, geometry, type, data, isCollection; + if(features.constructor == Array) { + collection = features; + isCollection = true; + } else { + collection = [features]; + isCollection = false; + } + var pieces = []; + if(isCollection) + pieces.push('GEOMETRYCOLLECTION('); + for(var i=0, len=collection.length; i0) + pieces.push(','); + geometry = collection[i].geometry; + type = geometry.CLASS_NAME.split('.')[2].toLowerCase(); + if(!this.extract[type]) + return null; + if (this.internalProjection && this.externalProjection) { + geometry = geometry.clone(); + geometry.transform(this.internalProjection, + this.externalProjection); + } + data = this.extract[type].apply(this, [geometry]); + pieces.push(type.toUpperCase() + '(' + data + ')'); + } + if(isCollection) + pieces.push(')'); + return pieces.join(''); + }, + /** + * Property: extract + * Object with properties corresponding to the geometry types. + * Property values are functions that do the actual data extraction. + */ + extract: { + /** + * Return a space delimited string of point coordinates. + * @param {} point + * @returns {String} A string of coordinates representing the point + */ + 'point': function(point) { + return point.x + ' ' + point.y; + }, + /** + * Return a comma delimited string of point coordinates from a multipoint. + * @param {} multipoint + * @returns {String} A string of point coordinate strings representing + * the multipoint + */ + 'multipoint': function(multipoint) { + var array = []; + for(var i=0, len=multipoint.components.length; i} linestring + * @returns {String} A string of point coordinate strings representing + * the linestring + */ + 'linestring': function(linestring) { + var array = []; + for(var i=0, len=linestring.components.length; i} multilinestring + * @returns {String} A string of of linestring strings representing + * the multilinestring + */ + 'multilinestring': function(multilinestring) { + var array = []; + for(var i=0, len=multilinestring.components.length; i} polygon + * @returns {String} An array of linear ring arrays representing the polygon + */ + 'polygon': function(polygon) { + var array = []; + for(var i=0, len=polygon.components.length; i} multipolygon + * @returns {Array} An array of polygon arrays representing + * the multipolygon + */ + 'multipolygon': function(multipolygon) { + var array = []; + for(var i=0, len=multipolygon.components.length; i} A point feature + */ + 'point': function(str) { + var coords = ZOO.String.trim(str).split(this.regExes.spaces); + return new ZOO.Feature( + new ZOO.Geometry.Point(coords[0], coords[1]) + ); + }, + /** + * Method: parse.multipoint + * Return a multipoint feature given a multipoint WKT fragment. + * + * Parameters: + * str - {String} A WKT fragment representing the multipoint + * + * Returns: + * {} A multipoint feature + */ + 'multipoint': function(str) { + var points = ZOO.String.trim(str).split(','); + var components = []; + for(var i=0, len=points.length; i} A linestring feature + */ + 'linestring': function(str) { + var points = ZOO.String.trim(str).split(','); + var components = []; + for(var i=0, len=points.length; i} A multilinestring feature + */ + 'multilinestring': function(str) { + var line; + var lines = ZOO.String.trim(str).split(this.regExes.parenComma); + var components = []; + for(var i=0, len=lines.length; i} A polygon feature + */ + 'polygon': function(str) { + var ring, linestring, linearring; + var rings = ZOO.String.trim(str).split(this.regExes.parenComma); + var components = []; + for(var i=0, len=rings.length; i} A multipolygon feature + */ + 'multipolygon': function(str) { + var polygon; + var polygons = ZOO.String.trim(str).split(this.regExes.doubleParenComma); + var components = []; + for(var i=0, len=polygons.length; i constructor. + * + * Inherits from: + * - + */ +ZOO.Format.JSON = ZOO.Class(ZOO.Format, { + /** + * Property: indent + * {String} For "pretty" printing, the indent string will be used once for + * each indentation level. + */ + indent: " ", + /** + * Property: space + * {String} For "pretty" printing, the space string will be used after + * the ":" separating a name/value pair. + */ + space: " ", + /** + * Property: newline + * {String} For "pretty" printing, the newline string will be used at the + * end of each name/value pair or array item. + */ + newline: "\n", + /** + * Property: level + * {Integer} For "pretty" printing, this is incremented/decremented during + * serialization. + */ + level: 0, + /** + * Property: pretty + * {Boolean} Serialize with extra whitespace for structure. This is set + * by the method. + */ + pretty: false, + /** + * Constructor: ZOO.Format.JSON + * Create a new parser for JSON. + * + * Parameters: + * options - {Object} An optional object whose properties will be set on + * this instance. + */ + initialize: function(options) { + ZOO.Format.prototype.initialize.apply(this, [options]); + }, + /** + * Method: read + * Deserialize a json string. + * + * Parameters: + * json - {String} A JSON string + * filter - {Function} A function which will be called for every key and + * value at every level of the final result. Each value will be + * replaced by the result of the filter function. This can be used to + * reform generic objects into instances of classes, or to transform + * date strings into Date objects. + * + * Returns: + * {Object} An object, array, string, or number . + */ + read: function(json, filter) { + /** + * Parsing happens in three stages. In the first stage, we run the text + * against a regular expression which looks for non-JSON + * characters. We are especially concerned with '()' and 'new' + * because they can cause invocation, and '=' because it can cause + * mutation. But just to be safe, we will reject all unexpected + * characters. + */ + try { + if (/^[\],:{}\s]*$/.test(json.replace(/\\["\\\/bfnrtu]/g, '@'). + replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g, ']'). + replace(/(?:^|:|,)(?:\s*\[)+/g, ''))) { + /** + * In the second stage we use the eval function to compile the + * text into a JavaScript structure. The '{' operator is + * subject to a syntactic ambiguity in JavaScript - it can + * begin a block or an object literal. We wrap the text in + * parens to eliminate the ambiguity. + */ + var object = eval('(' + json + ')'); + /** + * In the optional third stage, we recursively walk the new + * structure, passing each name/value pair to a filter + * function for possible transformation. + */ + if(typeof filter === 'function') { + function walk(k, v) { + if(v && typeof v === 'object') { + for(var i in v) { + if(v.hasOwnProperty(i)) { + v[i] = walk(i, v[i]); + } + } + } + return filter(k, v); + } + object = walk('', object); + } + if(this.keepData) { + this.data = object; + } + return object; + } + } catch(e) { + // Fall through if the regexp test fails. + } + return null; + }, + /** + * Method: write + * Serialize an object into a JSON string. + * + * Parameters: + * value - {String} The object, array, string, number, boolean or date + * to be serialized. + * pretty - {Boolean} Structure the output with newlines and indentation. + * Default is false. + * + * Returns: + * {String} The JSON string representation of the input value. + */ + write: function(value, pretty) { + this.pretty = !!pretty; + var json = null; + var type = typeof value; + if(this.serialize[type]) { + try { + json = this.serialize[type].apply(this, [value]); + } catch(err) { + //OpenLayers.Console.error("Trouble serializing: " + err); + } + } + return json; + }, + /** + * Method: writeIndent + * Output an indentation string depending on the indentation level. + * + * Returns: + * {String} An appropriate indentation string. + */ + writeIndent: function() { + var pieces = []; + if(this.pretty) { + for(var i=0; i 0) + pieces.push(','); + pieces.push(this.writeNewline(), this.writeIndent(), json); + } + } + this.level -= 1; + pieces.push(this.writeNewline(), this.writeIndent(), ']'); + return pieces.join(''); + }, + /** + * Method: serialize.string + * Transform a string into a JSON string. + * + * Parameters: + * string - {String} The string to be serialized + * + * Returns: + * {String} A JSON string representing the string. + */ + 'string': function(string) { + var m = { + '\b': '\\b', + '\t': '\\t', + '\n': '\\n', + '\f': '\\f', + '\r': '\\r', + '"' : '\\"', + '\\': '\\\\' + }; + if(/["\\\x00-\x1f]/.test(string)) { + return '"' + string.replace(/([\x00-\x1f\\"])/g, function(a, b) { + var c = m[b]; + if(c) + return c; + c = b.charCodeAt(); + return '\\u00' + + Math.floor(c / 16).toString(16) + + (c % 16).toString(16); + }) + '"'; + } + return '"' + string + '"'; + }, + /** + * Method: serialize.number + * Transform a number into a JSON string. + * + * Parameters: + * number - {Number} The number to be serialized. + * + * Returns: + * {String} A JSON string representing the number. + */ + 'number': function(number) { + return isFinite(number) ? String(number) : "null"; + }, + /** + * Method: serialize.boolean + * Transform a boolean into a JSON string. + * + * Parameters: + * bool - {Boolean} The boolean to be serialized. + * + * Returns: + * {String} A JSON string representing the boolean. + */ + 'boolean': function(bool) { + return String(bool); + }, + /** + * Method: serialize.date + * Transform a date into a JSON string. + * + * Parameters: + * date - {Date} The date to be serialized. + * + * Returns: + * {String} A JSON string representing the date. + */ + 'date': function(date) { + function format(number) { + // Format integers to have at least two digits. + return (number < 10) ? '0' + number : number; + } + return '"' + date.getFullYear() + '-' + + format(date.getMonth() + 1) + '-' + + format(date.getDate()) + 'T' + + format(date.getHours()) + ':' + + format(date.getMinutes()) + ':' + + format(date.getSeconds()) + '"'; + } + }, + CLASS_NAME: 'ZOO.Format.JSON' +}); +/** + * Class: ZOO.Format.GeoJSON + * Read and write GeoJSON. Create a new parser with the + * constructor. + * + * Inherits from: + * - + */ +ZOO.Format.GeoJSON = ZOO.Class(ZOO.Format.JSON, { + /** + * Constructor: ZOO.Format.GeoJSON + * Create a new parser for GeoJSON. + * + * Parameters: + * options - {Object} An optional object whose properties will be set on + * this instance. + */ + initialize: function(options) { + ZOO.Format.JSON.prototype.initialize.apply(this, [options]); + }, + /** + * Method: read + * Deserialize a GeoJSON string. + * + * Parameters: + * json - {String} A GeoJSON string + * type - {String} Optional string that determines the structure of + * the output. Supported values are "Geometry", "Feature", and + * "FeatureCollection". If absent or null, a default of + * "FeatureCollection" is assumed. + * filter - {Function} A function which will be called for every key and + * value at every level of the final result. Each value will be + * replaced by the result of the filter function. This can be used to + * reform generic objects into instances of classes, or to transform + * date strings into Date objects. + * + * Returns: + * {Object} The return depends on the value of the type argument. If type + * is "FeatureCollection" (the default), the return will be an array + * of . If type is "Geometry", the input json + * must represent a single geometry, and the return will be an + * . If type is "Feature", the input json must + * represent a single feature, and the return will be an + * . + */ + read: function(json, type, filter) { + type = (type) ? type : "FeatureCollection"; + var results = null; + var obj = null; + if (typeof json == "string") + obj = ZOO.Format.JSON.prototype.read.apply(this,[json, filter]); + else + obj = json; + if(!obj) { + //ZOO.Console.error("Bad JSON: " + json); + } else if(typeof(obj.type) != "string") { + //ZOO.Console.error("Bad GeoJSON - no type: " + json); + } else if(this.isValidType(obj, type)) { + switch(type) { + case "Geometry": + try { + results = this.parseGeometry(obj); + } catch(err) { + //ZOO.Console.error(err); + } + break; + case "Feature": + try { + results = this.parseFeature(obj); + results.type = "Feature"; + } catch(err) { + //ZOO.Console.error(err); + } + break; + case "FeatureCollection": + // for type FeatureCollection, we allow input to be any type + results = []; + switch(obj.type) { + case "Feature": + try { + results.push(this.parseFeature(obj)); + } catch(err) { + results = null; + //ZOO.Console.error(err); + } + break; + case "FeatureCollection": + for(var i=0, len=obj.features.length; i. + * + * Parameters: + * obj - {Object} An object created from a GeoJSON object + * + * Returns: + * {} A feature. + */ + parseFeature: function(obj) { + var feature, geometry, attributes, bbox; + attributes = (obj.properties) ? obj.properties : {}; + bbox = (obj.geometry && obj.geometry.bbox) || obj.bbox; + try { + geometry = this.parseGeometry(obj.geometry); + } catch(err) { + // deal with bad geometries + throw err; + } + feature = new ZOO.Feature(geometry, attributes); + if(bbox) + feature.bounds = ZOO.Bounds.fromArray(bbox); + if(obj.id) + feature.fid = obj.id; + return feature; + }, + /** + * Method: parseGeometry + * Convert a geometry object from GeoJSON into an . + * + * Parameters: + * obj - {Object} An object created from a GeoJSON object + * + * Returns: + * {} A geometry. + */ + parseGeometry: function(obj) { + if (obj == null) + return null; + var geometry, collection = false; + if(obj.type == "GeometryCollection") { + if(!(obj.geometries instanceof Array)) { + throw "GeometryCollection must have geometries array: " + obj; + } + var numGeom = obj.geometries.length; + var components = new Array(numGeom); + for(var i=0; i. + * + * Parameters: + * array - {Object} The coordinates array from the GeoJSON fragment. + * + * Returns: + * {} A geometry. + */ + "point": function(array) { + if(array.length != 2) { + throw "Only 2D points are supported: " + array; + } + return new ZOO.Geometry.Point(array[0], array[1]); + }, + /** + * Method: parseCoords.multipoint + * Convert a coordinate array from GeoJSON into an + * . + * + * Parameters: + * array - {Object} The coordinates array from the GeoJSON fragment. + * + * Returns: + * {} A geometry. + */ + "multipoint": function(array) { + var points = []; + var p = null; + for(var i=0, len=array.length; i. + * + * Parameters: + * array - {Object} The coordinates array from the GeoJSON fragment. + * + * Returns: + * {} A geometry. + */ + "linestring": function(array) { + var points = []; + var p = null; + for(var i=0, len=array.length; i. + * + * Parameters: + * array - {Object} The coordinates array from the GeoJSON fragment. + * + * Returns: + * {} A geometry. + */ + "multilinestring": function(array) { + var lines = []; + var l = null; + for(var i=0, len=array.length; i. + * + * Parameters: + * array - {Object} The coordinates array from the GeoJSON fragment. + * + * Returns: + * {} A geometry. + */ + "polygon": function(array) { + var rings = []; + var r, l; + for(var i=0, len=array.length; i. + * + * Parameters: + * array - {Object} The coordinates array from the GeoJSON fragment. + * + * Returns: + * {} A geometry. + */ + "multipolygon": function(array) { + var polys = []; + var p = null; + for(var i=0, len=array.length; i. + * + * Parameters: + * array - {Object} The coordinates array from the GeoJSON fragment. + * + * Returns: + * {} A geometry. + */ + "box": function(array) { + if(array.length != 2) { + throw "GeoJSON box coordinates must have 2 elements"; + } + return new ZOO.Geometry.Polygon([ + new ZOO.Geometry.LinearRing([ + new ZOO.Geometry.Point(array[0][0], array[0][1]), + new ZOO.Geometry.Point(array[1][0], array[0][1]), + new ZOO.Geometry.Point(array[1][0], array[1][1]), + new ZOO.Geometry.Point(array[0][0], array[1][1]), + new Z0O.Geometry.Point(array[0][0], array[0][1]) + ]) + ]); + } + }, + /** + * Method: write + * Serialize a feature, geometry, array of features into a GeoJSON string. + * + * Parameters: + * obj - {Object} An , , + * or an array of features. + * pretty - {Boolean} Structure the output with newlines and indentation. + * Default is false. + * + * Returns: + * {String} The GeoJSON string representation of the input geometry, + * features, or array of features. + */ + write: function(obj, pretty) { + var geojson = { + "type": null + }; + if(obj instanceof Array) { + geojson.type = "FeatureCollection"; + var numFeatures = obj.length; + geojson.features = new Array(numFeatures); + for(var i=0; i} + * + * Returns: + * {Object} An object which can be assigned to the crs property + * of a GeoJSON object. + */ + createCRSObject: function(object) { + //var proj = object.layer.projection.toString(); + var proj = object.projection.toString(); + var crs = {}; + if (proj.match(/epsg:/i)) { + var code = parseInt(proj.substring(proj.indexOf(":") + 1)); + if (code == 4326) { + crs = { + "type": "OGC", + "properties": { + "urn": "urn:ogc:def:crs:OGC:1.3:CRS84" + } + }; + } else { + crs = { + "type": "EPSG", + "properties": { + "code": code + } + }; + } + } + return crs; + }, + /** + * Property: extract + * Object with properties corresponding to the GeoJSON types. + * Property values are functions that do the actual value extraction. + */ + extract: { + /** + * Method: extract.feature + * Return a partial GeoJSON object representing a single feature. + * + * Parameters: + * feature - {} + * + * Returns: + * {Object} An object representing the point. + */ + 'feature': function(feature) { + var geom = this.extract.geometry.apply(this, [feature.geometry]); + return { + "type": "Feature", + "id": feature.fid == null ? feature.id : feature.fid, + "properties": feature.attributes, + "geometry": geom + }; + }, + /** + * Method: extract.geometry + * Return a GeoJSON object representing a single geometry. + * + * Parameters: + * geometry - {} + * + * Returns: + * {Object} An object representing the geometry. + */ + 'geometry': function(geometry) { + if (geometry == null) + return null; + if (this.internalProjection && this.externalProjection) { + geometry = geometry.clone(); + geometry.transform(this.internalProjection, + this.externalProjection); + } + var geometryType = geometry.CLASS_NAME.split('.')[2]; + var data = this.extract[geometryType.toLowerCase()].apply(this, [geometry]); + var json; + if(geometryType == "Collection") + json = { + "type": "GeometryCollection", + "geometries": data + }; + else + json = { + "type": geometryType, + "coordinates": data + }; + return json; + }, + /** + * Method: extract.point + * Return an array of coordinates from a point. + * + * Parameters: + * point - {} + * + * Returns: + * {Array} An array of coordinates representing the point. + */ + 'point': function(point) { + return [point.x, point.y]; + }, + /** + * Method: extract.multipoint + * Return an array of coordinates from a multipoint. + * + * Parameters: + * multipoint - {} + * + * Returns: + * {Array} An array of point coordinate arrays representing + * the multipoint. + */ + 'multipoint': function(multipoint) { + var array = []; + for(var i=0, len=multipoint.components.length; i} + * + * Returns: + * {Array} An array of coordinate arrays representing + * the linestring. + */ + 'linestring': function(linestring) { + var array = []; + for(var i=0, len=linestring.components.length; i} + * + * Returns: + * {Array} An array of linestring arrays representing + * the multilinestring. + */ + 'multilinestring': function(multilinestring) { + var array = []; + for(var i=0, len=multilinestring.components.length; i} + * + * Returns: + * {Array} An array of linear ring arrays representing the polygon. + */ + 'polygon': function(polygon) { + var array = []; + for(var i=0, len=polygon.components.length; i} + * + * Returns: + * {Array} An array of polygon arrays representing + * the multipolygon + */ + 'multipolygon': function(multipolygon) { + var array = []; + for(var i=0, len=multipolygon.components.length; i} + * + * Returns: + * {Array} An array of geometry objects representing the geometry + * collection. + */ + 'collection': function(collection) { + var len = collection.components.length; + var array = new Array(len); + for(var i=0; i + * constructor. + * + * Inherits from: + * - + */ +ZOO.Format.KML = ZOO.Class(ZOO.Format, { + /** + * Property: kmlns + * {String} KML Namespace to use. Defaults to 2.2 namespace. + */ + kmlns: "http://www.opengis.net/kml/2.2", + /** + * Property: foldersName + * {String} Name of the folders. Default is "ZOO export". + * If set to null, no name element will be created. + */ + foldersName: "ZOO export", + /** + * Property: foldersDesc + * {String} Description of the folders. Default is "Exported on [date]." + * If set to null, no description element will be created. + */ + foldersDesc: "Created on " + new Date(), + /** + * Property: placemarksDesc + * {String} Name of the placemarks. Default is "No description available". + */ + placemarksDesc: "No description available", + /** + * Property: extractAttributes + * {Boolean} Extract attributes from KML. Default is true. + * Extracting styleUrls requires this to be set to true + */ + extractAttributes: true, + /** + * Constructor: ZOO.Format.KML + * Create a new parser for KML. + * + * Parameters: + * options - {Object} An optional object whose properties will be set on + * this instance. + */ + initialize: function(options) { + // compile regular expressions once instead of every time they are used + this.regExes = { + trimSpace: (/^\s*|\s*$/g), + removeSpace: (/\s*/g), + splitSpace: (/\s+/), + trimComma: (/\s*,\s*/g), + kmlColor: (/(\w{2})(\w{2})(\w{2})(\w{2})/), + kmlIconPalette: (/root:\/\/icons\/palette-(\d+)(\.\w+)/), + straightBracket: (/\$\[(.*?)\]/g) + }; + // KML coordinates are always in longlat WGS84 + this.externalProjection = new ZOO.Projection("EPSG:4326"); + ZOO.Format.prototype.initialize.apply(this, [options]); + }, + /** + * APIMethod: read + * Read data from a string, and return a list of features. + * + * Parameters: + * data - {String} data to read/parse. + * + * Returns: + * {Array()} List of features. + */ + read: function(data) { + this.features = []; + data = data.replace(/^<\?xml\s+version\s*=\s*(["'])[^\1]+\1[^?]*\?>/, ""); + data = new XML(data); + var placemarks = data..*::Placemark; + this.parseFeatures(placemarks); + return this.features; + }, + /** + * Method: parseFeatures + * Loop through all Placemark nodes and parse them. + * Will create a list of features + * + * Parameters: + * nodes - {Array} of {E4XElement} data to read/parse. + * options - {Object} Hash of options + * + */ + parseFeatures: function(nodes) { + var features = new Array(nodes.length()); + for(var i=0, len=nodes.length(); i} A vector feature. + */ + parseFeature: function(node) { + // only accept one geometry per feature - look for highest "order" + var order = ["MultiGeometry", "Polygon", "LineString", "Point"]; + var type, nodeList, geometry, parser; + for(var i=0, len=order.length; i 0) { + var parser = this.parseGeometry[type.toLowerCase()]; + if(parser) { + geometry = parser.apply(this, [nodeList[0]]); + if (this.internalProjection && this.externalProjection) { + geometry.transform(this.externalProjection, + this.internalProjection); + } + } + // stop looking for different geometry types + break; + } + } + // construct feature (optionally with attributes) + var attributes; + if(this.extractAttributes) { + attributes = this.parseAttributes(node); + } + var feature = new ZOO.Feature(geometry, attributes); + var fid = node.@id || node.@name; + if(fid != null) + feature.fid = fid; + return feature; + }, + /** + * Property: parseGeometry + * Properties of this object are the functions that parse geometries based + * on their type. + */ + parseGeometry: { + /** + * Method: parseGeometry.point + * Given a KML node representing a point geometry, create a ZOO + * point geometry. + * + * Parameters: + * node - {E4XElement} A KML Point node. + * + * Returns: + * {} A point geometry. + */ + 'point': function(node) { + var coordString = node.*::coordinates.toString(); + coordString = coordString.replace(this.regExes.removeSpace, ""); + coords = coordString.split(","); + var point = null; + if(coords.length > 1) { + // preserve third dimension + if(coords.length == 2) { + coords[2] = null; + } + point = new ZOO.Geometry.Point(coords[0], coords[1], coords[2]); + } + return point; + }, + /** + * Method: parseGeometry.linestring + * Given a KML node representing a linestring geometry, create a + * ZOO linestring geometry. + * + * Parameters: + * node - {E4XElement} A KML LineString node. + * + * Returns: + * {} A linestring geometry. + */ + 'linestring': function(node, ring) { + var line = null; + var coordString = node.*::coordinates.toString(); + coordString = coordString.replace(this.regExes.trimSpace, + ""); + coordString = coordString.replace(this.regExes.trimComma, + ","); + var pointList = coordString.split(this.regExes.splitSpace); + var numPoints = pointList.length; + var points = new Array(numPoints); + var coords, numCoords; + for(var i=0; i 1) { + if(coords.length == 2) { + coords[2] = null; + } + points[i] = new ZOO.Geometry.Point(coords[0], + coords[1], + coords[2]); + } + } + if(numPoints) { + if(ring) { + line = new ZOO.Geometry.LinearRing(points); + } else { + line = new ZOO.Geometry.LineString(points); + } + } else { + throw "Bad LineString coordinates: " + coordString; + } + return line; + }, + /** + * Method: parseGeometry.polygon + * Given a KML node representing a polygon geometry, create a + * ZOO polygon geometry. + * + * Parameters: + * node - {E4XElement} A KML Polygon node. + * + * Returns: + * {} A polygon geometry. + */ + 'polygon': function(node) { + var nodeList = node..*::LinearRing; + var numRings = nodeList.length(); + var components = new Array(numRings); + if(numRings > 0) { + // this assumes exterior ring first, inner rings after + var ring; + for(var i=0, len=nodeList.length(); i} A geometry collection. + */ + 'multigeometry': function(node) { + var child, parser; + var parts = []; + var children = node.*::*; + for(var i=0, len=children.length(); i 0) { + attributes = this.parseExtendedData(edNodes[0]) + } + var child, grandchildren; + var children = node.*::*; + for(var i=0, len=children.length(); i 0) + ed['value'] = valueNode[0].toString(); + var nameNode = data.*::displayName; + if (nameNode.length() > 0) + ed['displayName'] = valueNode[0].toString(); + attributes[key] = ed; + } + return attributes; + }, + /** + * Method: write + * Accept Feature Collection, and return a string. + * + * Parameters: + * features - {Array(} An array of features. + * + * Returns: + * {String} A KML string. + */ + write: function(features) { + if(!(features instanceof Array)) + features = [features]; + var kml = new XML(''); + var folder = kml.Document.Folder; + folder.name = this.foldersName; + folder.description = this.foldersDesc; + for(var i=0, len=features.length; i} + * + * Returns: + * {E4XElement} + */ + createPlacemark: function(feature) { + var placemark = new XML(''); + placemark.name = (feature.attributes.name) ? + feature.attributes.name : feature.id; + placemark.description = (feature.attributes.description) ? + feature.attributes.description : this.placemarksDesc; + if(feature.fid != null) + placemark.@id = feature.fid; + placemark.*[2] = this.buildGeometryNode(feature.geometry); + return placemark; + }, + /** + * Method: buildGeometryNode + * Builds and returns a KML geometry node with the given geometry. + * + * Parameters: + * geometry - {} + * + * Returns: + * {E4XElement} + */ + buildGeometryNode: function(geometry) { + if (this.internalProjection && this.externalProjection) { + geometry = geometry.clone(); + geometry.transform(this.internalProjection, + this.externalProjection); + } + var className = geometry.CLASS_NAME; + var type = className.substring(className.lastIndexOf(".") + 1); + var builder = this.buildGeometry[type.toLowerCase()]; + var node = null; + if(builder) { + node = builder.apply(this, [geometry]); + } + return node; + }, + /** + * Property: buildGeometry + * Object containing methods to do the actual geometry node building + * based on geometry type. + */ + buildGeometry: { + /** + * Method: buildGeometry.point + * Given a ZOO point geometry, create a KML point. + * + * Parameters: + * geometry - {} A point geometry. + * + * Returns: + * {E4XElement} A KML point node. + */ + 'point': function(geometry) { + var kml = new XML(''); + kml.coordinates = this.buildCoordinatesNode(geometry); + return kml; + }, + /** + * Method: buildGeometry.multipoint + * Given a ZOO multipoint geometry, create a KML + * GeometryCollection. + * + * Parameters: + * geometry - {} A multipoint geometry. + * + * Returns: + * {E4XElement} A KML GeometryCollection node. + */ + 'multipoint': function(geometry) { + return this.buildGeometry.collection.apply(this, [geometry]); + }, + /** + * Method: buildGeometry.linestring + * Given a ZOO linestring geometry, create a KML linestring. + * + * Parameters: + * geometry - {} A linestring geometry. + * + * Returns: + * {E4XElement} A KML linestring node. + */ + 'linestring': function(geometry) { + var kml = new XML(''); + kml.coordinates = this.buildCoordinatesNode(geometry); + return kml; + }, + /** + * Method: buildGeometry.multilinestring + * Given a ZOO multilinestring geometry, create a KML + * GeometryCollection. + * + * Parameters: + * geometry - {} A multilinestring geometry. + * + * Returns: + * {E4XElement} A KML GeometryCollection node. + */ + 'multilinestring': function(geometry) { + return this.buildGeometry.collection.apply(this, [geometry]); + }, + /** + * Method: buildGeometry.linearring + * Given a ZOO linearring geometry, create a KML linearring. + * + * Parameters: + * geometry - {} A linearring geometry. + * + * Returns: + * {E4XElement} A KML linearring node. + */ + 'linearring': function(geometry) { + var kml = new XML(''); + kml.coordinates = this.buildCoordinatesNode(geometry); + return kml; + }, + /** + * Method: buildGeometry.polygon + * Given a ZOO polygon geometry, create a KML polygon. + * + * Parameters: + * geometry - {} A polygon geometry. + * + * Returns: + * {E4XElement} A KML polygon node. + */ + 'polygon': function(geometry) { + var kml = new XML(''); + var rings = geometry.components; + var ringMember, ringGeom, type; + for(var i=0, len=rings.length; i'); + ringMember.LinearRing = this.buildGeometry.linearring.apply(this,[rings[i]]); + kml.*[i] = ringMember; + } + return kml; + }, + /** + * Method: buildGeometry.multipolygon + * Given a ZOO multipolygon geometry, create a KML + * GeometryCollection. + * + * Parameters: + * geometry - {} A multipolygon geometry. + * + * Returns: + * {E4XElement} A KML GeometryCollection node. + */ + 'multipolygon': function(geometry) { + return this.buildGeometry.collection.apply(this, [geometry]); + }, + /** + * Method: buildGeometry.collection + * Given a ZOO geometry collection, create a KML MultiGeometry. + * + * Parameters: + * geometry - {} A geometry collection. + * + * Returns: + * {E4XElement} A KML MultiGeometry node. + */ + 'collection': function(geometry) { + var kml = new XML(''); + var child; + for(var i=0, len=geometry.components.length; i... + * + * Parameters: + * geometry - {} + * + * Return: + * {E4XElement} + */ + buildCoordinatesNode: function(geometry) { + var cooridnates = new XML(''); + var points = geometry.components; + if(points) { + // LineString or LinearRing + var point; + var numPoints = points.length; + var parts = new Array(numPoints); + for(var i=0; i + * constructor. Supports the GML simple features profile. + * + * Inherits from: + * - + */ +ZOO.Format.GML = ZOO.Class(ZOO.Format, { + /** + * Property: schemaLocation + * {String} Schema location for a particular minor version. + */ + schemaLocation: "http://www.opengis.net/gml http://schemas.opengis.net/gml/2.1.2/feature.xsd", + /** + * Property: namespaces + * {Object} Mapping of namespace aliases to namespace URIs. + */ + namespaces: { + ogr: "http://ogr.maptools.org/", + gml: "http://www.opengis.net/gml", + xlink: "http://www.w3.org/1999/xlink", + xsi: "http://www.w3.org/2001/XMLSchema-instance", + wfs: "http://www.opengis.net/wfs" // this is a convenience for reading wfs:FeatureCollection + }, + /** + * Property: defaultPrefix + */ + defaultPrefix: 'ogr', + /** + * Property: collectionName + * {String} Name of featureCollection element. + */ + collectionName: "FeatureCollection", + /* + * Property: featureName + * {String} Element name for features. Default is "sql_statement". + */ + featureName: "sql_statement", + /** + * Property: geometryName + * {String} Name of geometry element. Defaults to "geometryProperty". + */ + geometryName: "geometryProperty", + /** + * Property: xy + * {Boolean} Order of the GML coordinate true:(x,y) or false:(y,x) + * Changing is not recommended, a new Format should be instantiated. + */ + xy: true, + /** + * Property: extractAttributes + * {Boolean} Could we extract attributes + */ + extractAttributes: true, + /** + * Constructor: ZOO.Format.GML + * Create a new parser for GML. + * + * Parameters: + * options - {Object} An optional object whose properties will be set on + * this instance. + */ + initialize: function(options) { + // compile regular expressions once instead of every time they are used + this.regExes = { + trimSpace: (/^\s*|\s*$/g), + removeSpace: (/\s*/g), + splitSpace: (/\s+/), + trimComma: (/\s*,\s*/g) + }; + ZOO.Format.prototype.initialize.apply(this, [options]); + }, + /** + * Method: read + * Read data from a string, and return a list of features. + * + * Parameters: + * data - {String} data to read/parse. + * + * Returns: + * {Array()} An array of features. + */ + read: function(data) { + this.features = []; + data = data.replace(/^<\?xml\s+version\s*=\s*(["'])[^\1]+\1[^?]*\?>/, ""); + data = new XML(data); + + var gmlns = Namespace(this.namespaces['gml']); + var featureNodes = data..gmlns::featureMember; + if (data.localName() == 'featureMember') + featureNodes = data; + var features = []; + for(var i=0,len=featureNodes.length(); i 0) { + var parser = this.parseGeometry[type.toLowerCase()]; + if(parser) { + geometry = parser.apply(this, [nodeList[0]]); + if (this.internalProjection && this.externalProjection) { + geometry.transform(this.externalProjection, + this.internalProjection); + } + } + // stop looking for different geometry types + break; + } + } + var attributes; + if(this.extractAttributes) { + attributes = this.parseAttributes(node); + } + var feature = new ZOO.Feature(geometry, attributes); + return feature; + }, + /** + * Property: parseGeometry + * Properties of this object are the functions that parse geometries based + * on their type. + */ + parseGeometry: { + /** + * Method: parseGeometry.point + * Given a GML node representing a point geometry, create a ZOO + * point geometry. + * + * Parameters: + * node - {E4XElement} A GML node. + * + * Returns: + * {} A point geometry. + */ + 'point': function(node) { + /** + * Three coordinate variations to consider: + * 1) x y z + * 2) x, y, z + * 3) xy + */ + var nodeList, coordString; + var coords = []; + // look for + var nodeList = node..*::pos; + if(nodeList.length() > 0) { + coordString = nodeList[0].toString(); + coordString = coordString.replace(this.regExes.trimSpace, ""); + coords = coordString.split(this.regExes.splitSpace); + } + // look for + if(coords.length == 0) { + nodeList = node..*::coordinates; + if(nodeList.length() > 0) { + coordString = nodeList[0].toString(); + coordString = coordString.replace(this.regExes.removeSpace,""); + coords = coordString.split(","); + } + } + // look for + if(coords.length == 0) { + nodeList = node..*::coord; + if(nodeList.length() > 0) { + var xList = nodeList[0].*::X; + var yList = nodeList[0].*::Y; + if(xList.length() > 0 && yList.length() > 0) + coords = [xList[0].toString(), + yList[0].toString()]; + } + } + // preserve third dimension + if(coords.length == 2) + coords[2] = null; + if (this.xy) + return new ZOO.Geometry.Point(coords[0],coords[1],coords[2]); + else + return new ZOO.Geometry.Point(coords[1],coords[0],coords[2]); + }, + /** + * Method: parseGeometry.multipoint + * Given a GML node representing a multipoint geometry, create a + * ZOO multipoint geometry. + * + * Parameters: + * node - {E4XElement} A GML node. + * + * Returns: + * {} A multipoint geometry. + */ + 'multipoint': function(node) { + var nodeList = node..*::Point; + var components = []; + if(nodeList.length() > 0) { + var point; + for(var i=0, len=nodeList.length(); i} A linestring geometry. + */ + 'linestring': function(node, ring) { + /** + * Two coordinate variations to consider: + * 1) x0 y0 z0 x1 y1 z1 + * 2) x0, y0, z0 x1, y1, z1 + */ + var nodeList, coordString; + var coords = []; + var points = []; + // look for + nodeList = node..*::posList; + if(nodeList.length() > 0) { + coordString = nodeList[0].toString(); + coordString = coordString.replace(this.regExes.trimSpace, ""); + coords = coordString.split(this.regExes.splitSpace); + var dim = parseInt(nodeList[0].@dimension); + var j, x, y, z; + for(var i=0; i + if(coords.length == 0) { + nodeList = node..*::coordinates; + if(nodeList.length() > 0) { + coordString = nodeList[0].toString(); + coordString = coordString.replace(this.regExes.trimSpace,""); + coordString = coordString.replace(this.regExes.trimComma,","); + var pointList = coordString.split(this.regExes.splitSpace); + for(var i=0; i} A multilinestring geometry. + */ + 'multilinestring': function(node) { + var nodeList = node..*::LineString; + var components = []; + if(nodeList.length() > 0) { + var line; + for(var i=0, len=nodeList.length(); i} A polygon geometry. + */ + 'polygon': function(node) { + nodeList = node..*::LinearRing; + var components = []; + if(nodeList.length() > 0) { + // this assumes exterior ring first, inner rings after + var ring; + for(var i=0, len = nodeList.length(); i} A multipolygon geometry. + */ + 'multipolygon': function(node) { + var nodeList = node..*::Polygon; + var components = []; + if(nodeList.length() > 0) { + var polygon; + for(var i=0, len=nodeList.length(); i} A polygon geometry. + */ + 'envelope': function(node) { + var components = []; + var coordString; + var envelope; + var lpoint = node..*::lowerCorner; + if (lpoint.length() > 0) { + var coords = []; + if(lpoint.length() > 0) { + coordString = lpoint[0].toString(); + coordString = coordString.replace(this.regExes.trimSpace, ""); + coords = coordString.split(this.regExes.splitSpace); + } + if(coords.length == 2) + coords[2] = null; + if (this.xy) + var lowerPoint = new ZOO.Geometry.Point(coords[0], coords[1],coords[2]); + else + var lowerPoint = new ZOO.Geometry.Point(coords[1], coords[0],coords[2]); + } + var upoint = node..*::upperCorner; + if (upoint.length() > 0) { + var coords = []; + if(upoint.length > 0) { + coordString = upoint[0].toString(); + coordString = coordString.replace(this.regExes.trimSpace, ""); + coords = coordString.split(this.regExes.splitSpace); + } + if(coords.length == 2) + coords[2] = null; + if (this.xy) + var upperPoint = new ZOO.Geometry.Point(coords[0], coords[1],coords[2]); + else + var upperPoint = new ZOO.Geometry.Point(coords[1], coords[0],coords[2]); + } + if (lowerPoint && upperPoint) { + components.push(new ZOO.Geometry.Point(lowerPoint.x, lowerPoint.y)); + components.push(new ZOO.Geometry.Point(upperPoint.x, lowerPoint.y)); + components.push(new ZOO.Geometry.Point(upperPoint.x, upperPoint.y)); + components.push(new ZOO.Geometry.Point(lowerPoint.x, upperPoint.y)); + components.push(new ZOO.Geometry.Point(lowerPoint.x, lowerPoint.y)); + var ring = new ZOO.Geometry.LinearRing(components); + envelope = new ZOO.Geometry.Polygon([ring]); + } + return envelope; + } + }, + /** + * Method: parseAttributes + * + * Parameters: + * node - {} + * + * Returns: + * {Object} An attributes object. + */ + parseAttributes: function(node) { + var attributes = {}; + // assume attributes are children of the first type 1 child + var childNode = node.*::*[0]; + var child, grandchildren; + var children = childNode.*::*; + for(var i=0, len=children.length(); i)} List of features to + * serialize into a string. + * + * Returns: + * {String} A string representing the GML document. + */ + write: function(features) { + if(!(features instanceof Array)) { + features = [features]; + } + var pfx = this.defaultPrefix; + var name = pfx+':'+this.collectionName; + var gml = new XML('<'+name+' xmlns:'+pfx+'="'+this.namespaces[pfx]+'" xmlns:gml="'+this.namespaces['gml']+'" xmlns:xsi="'+this.namespaces['xsi']+'" xsi:schemaLocation="'+this.schemaLocation+'">'); + for(var i=0; i} The feature to be built as GML. + * + * Returns: + * {E4XElement} A node reprensting the feature in GML. + */ + createFeature: function(feature) { + var pfx = this.defaultPrefix; + var name = pfx+':'+this.featureName; + var fid = feature.fid || feature.id; + var gml = new XML('<'+name+' xmlns:'+pfx+'="'+this.namespaces[pfx]+'" fid="'+fid+'">'); + var geometry = feature.geometry; + gml.*::*[0].*::* = this.buildGeometryNode(geometry); + for(var attr in feature.attributes) { + var attrNode = new XML('<'+pfx+':'+attr+' xmlns:'+pfx+'="'+this.namespaces[pfx]+'">'+feature.attributes[attr]+''); + gml.*::*[0].appendChild(attrNode); + } + return gml; + }, + /** + * Method: buildGeometryNode + * + * Parameters: + * geometry - {} The geometry to be built as GML. + * + * Returns: + * {E4XElement} A node reprensting the geometry in GML. + */ + buildGeometryNode: function(geometry) { + if (this.externalProjection && this.internalProjection) { + geometry = geometry.clone(); + geometry.transform(this.internalProjection, + this.externalProjection); + } + var className = geometry.CLASS_NAME; + var type = className.substring(className.lastIndexOf(".") + 1); + var builder = this.buildGeometry[type.toLowerCase()]; + var pfx = this.defaultPrefix; + var name = pfx+':'+this.geometryName; + var gml = new XML('<'+name+' xmlns:'+pfx+'="'+this.namespaces[pfx]+'">'); + if (builder) + gml.*::* = builder.apply(this, [geometry]); + return gml; + }, + /** + * Property: buildGeometry + * Object containing methods to do the actual geometry node building + * based on geometry type. + */ + buildGeometry: { + /** + * Method: buildGeometry.point + * Given a ZOO point geometry, create a GML point. + * + * Parameters: + * geometry - {} A point geometry. + * + * Returns: + * {E4XElement} A GML point node. + */ + 'point': function(geometry) { + var gml = new XML(''); + gml.*::*[0] = this.buildCoordinatesNode(geometry); + return gml; + }, + /** + * Method: buildGeometry.multipoint + * Given a ZOO multipoint geometry, create a GML multipoint. + * + * Parameters: + * geometry - {} A multipoint geometry. + * + * Returns: + * {E4XElement} A GML multipoint node. + */ + 'multipoint': function(geometry) { + var gml = new XML(''); + var points = geometry.components; + var pointMember; + for(var i=0; i'); + pointMember.*::* = this.buildGeometry.point.apply(this,[points[i]]); + gml.*::*[i] = pointMember; + } + return gml; + }, + /** + * Method: buildGeometry.linestring + * Given a ZOO linestring geometry, create a GML linestring. + * + * Parameters: + * geometry - {} A linestring geometry. + * + * Returns: + * {E4XElement} A GML linestring node. + */ + 'linestring': function(geometry) { + var gml = new XML(''); + gml.*::*[0] = this.buildCoordinatesNode(geometry); + return gml; + }, + /** + * Method: buildGeometry.multilinestring + * Given a ZOO multilinestring geometry, create a GML + * multilinestring. + * + * Parameters: + * geometry - {} A multilinestring + * geometry. + * + * Returns: + * {E4XElement} A GML multilinestring node. + */ + 'multilinestring': function(geometry) { + var gml = new XML(''); + var lines = geometry.components; + var lineMember; + for(var i=0; i'); + lineMember.*::* = this.buildGeometry.linestring.apply(this,[lines[i]]); + gml.*::*[i] = lineMember; + } + return gml; + }, + /** + * Method: buildGeometry.linearring + * Given a ZOO linearring geometry, create a GML linearring. + * + * Parameters: + * geometry - {} A linearring geometry. + * + * Returns: + * {E4XElement} A GML linearring node. + */ + 'linearring': function(geometry) { + var gml = new XML(''); + gml.*::*[0] = this.buildCoordinatesNode(geometry); + return gml; + }, + /** + * Method: buildGeometry.polygon + * Given an ZOO polygon geometry, create a GML polygon. + * + * Parameters: + * geometry - {} A polygon geometry. + * + * Returns: + * {E4XElement} A GML polygon node. + */ + 'polygon': function(geometry) { + var gml = new XML(''); + var rings = geometry.components; + var ringMember, type; + for(var i=0; i'); + ringMember.*::* = this.buildGeometry.linearring.apply(this,[rings[i]]); + gml.*::*[i] = ringMember; + } + return gml; + }, + /** + * Method: buildGeometry.multipolygon + * Given a ZOO multipolygon geometry, create a GML multipolygon. + * + * Parameters: + * geometry - {} A multipolygon + * geometry. + * + * Returns: + * {E4XElement} A GML multipolygon node. + */ + 'multipolygon': function(geometry) { + var gml = new XML(''); + var polys = geometry.components; + var polyMember; + for(var i=0; i'); + polyMember.*::* = this.buildGeometry.polygon.apply(this,[polys[i]]); + gml.*::*[i] = polyMember; + } + return gml; + } + }, + /** + * Method: buildCoordinatesNode + * builds the coordinates XmlNode + * (code) + * ... + * (end) + * Parameters: + * geometry - {} + * + * Returns: + * {E4XElement} created E4XElement + */ + buildCoordinatesNode: function(geometry) { + var parts = []; + if(geometry instanceof ZOO.Bounds){ + parts.push(geometry.left + "," + geometry.bottom); + parts.push(geometry.right + "," + geometry.top); + } else { + var points = (geometry.components) ? geometry.components : [geometry]; + for(var i=0; i'+parts.join(" ")+''); + }, + CLASS_NAME: 'ZOO.Format.GML' +}); +/** + * Class: ZOO.Format.WPS + * Read/Write WPS. Create a new instance with the + * constructor. Supports only parseExecuteResponse. + * + * Inherits from: + * - + */ +ZOO.Format.WPS = ZOO.Class(ZOO.Format, { + /** + * Property: schemaLocation + * {String} Schema location for a particular minor version. + */ + schemaLocation: "http://www.opengis.net/wps/1.0.0/../wpsExecute_request.xsd", + /** + * Property: namespaces + * {Object} Mapping of namespace aliases to namespace URIs. + */ + namespaces: { + ows: "http://www.opengis.net/ows/1.1", + wps: "http://www.opengis.net/wps/1.0.0", + xlink: "http://www.w3.org/1999/xlink", + xsi: "http://www.w3.org/2001/XMLSchema-instance", + }, + /** + * Method: read + * + * Parameters: + * data - {String} A WPS xml document + * + * Returns: + * {Object} Execute response. + */ + read:function(data) { + data = data.replace(/^<\?xml\s+version\s*=\s*(["'])[^\1]+\1[^?]*\?>/, ""); + data = new XML(data); + switch (data.localName()) { + case 'ExecuteResponse': + return this.parseExecuteResponse(data); + default: + return null; + } + }, + /** + * Method: parseExecuteResponse + * + * Parameters: + * node - {E4XElement} A WPS ExecuteResponse document + * + * Returns: + * {Object} Execute response. + */ + parseExecuteResponse: function(node) { + var outputs = node.*::ProcessOutputs.*::Output; + if (outputs.length() > 0) { + var res=[]; + for(var i=0;i1?res:res[0]; + } else + return null; + }, + /** + * Property: parseData + * Object containing methods to analyse data response. + */ + parseData: { + /** + * Method: parseData.complexdata + * Given an Object representing the WPS complex data response. + * + * Parameters: + * node - {E4XElement} A WPS node. + * + * Returns: + * {Object} A WPS complex data response. + */ + 'complexdata': function(node) { + var result = {value:node.toString()}; + if (node.@mimeType.length()>0) + result.mimeType = node.@mimeType; + if (node.@encoding.length()>0) + result.encoding = node.@encoding; + if (node.@schema.length()>0) + result.schema = node.@schema; + return result; + }, + /** + * Method: parseData.literaldata + * Given an Object representing the WPS literal data response. + * + * Parameters: + * node - {E4XElement} A WPS node. + * + * Returns: + * {Object} A WPS literal data response. + */ + 'literaldata': function(node) { + var result = {value:node.toString()}; + if (node.@dataType.length()>0) + result.dataType = node.@dataType; + if (node.@uom.length()>0) + result.uom = node.@uom; + return result; + }, + /** + * Method: parseData.reference + * Given an Object representing the WPS reference response. + * + * Parameters: + * node - {E4XElement} A WPS node. + * + * Returns: + * {Object} A WPS reference response. + */ + 'reference': function(node) { + var result = {type:'reference',value:node.@href}; + return result; + } + }, + CLASS_NAME: 'ZOO.Format.WPS' +}); + +/** + * Class: ZOO.Feature + * Vector features use the ZOO.Geometry classes as geometry description. + * They have an 'attributes' property, which is the data object + */ +ZOO.Feature = ZOO.Class({ + /** + * Property: fid + * {String} + */ + fid: null, + /** + * Property: geometry + * {} + */ + geometry: null, + /** + * Property: attributes + * {Object} This object holds arbitrary properties that describe the + * feature. + */ + attributes: null, + /** + * Property: bounds + * {} The box bounding that feature's geometry, that + * property can be set by an object when + * deserializing the feature, so in most cases it represents an + * information set by the server. + */ + bounds: null, + /** + * Constructor: ZOO.Feature + * Create a vector feature. + * + * Parameters: + * geometry - {} The geometry that this feature + * represents. + * attributes - {Object} An optional object that will be mapped to the + * property. + */ + initialize: function(geometry, attributes) { + this.geometry = geometry ? geometry : null; + this.attributes = {}; + if (attributes) + this.attributes = ZOO.extend(this.attributes,attributes); + }, + /** + * Method: destroy + * nullify references to prevent circular references and memory leaks + */ + destroy: function() { + this.geometry = null; + }, + /** + * Method: clone + * Create a clone of this vector feature. Does not set any non-standard + * properties. + * + * Returns: + * {} An exact clone of this vector feature. + */ + clone: function () { + return new ZOO.Feature(this.geometry ? this.geometry.clone() : null, + this.attributes); + }, + /** + * Method: move + * Moves the feature and redraws it at its new location + * + * Parameters: + * x - {Float} + * y - {Float} + */ + move: function(x, y) { + if(!this.geometry.move) + return; + + this.geometry.move(x,y); + return this.geometry; + }, + CLASS_NAME: 'ZOO.Feature' +}); + +/** + * Class: ZOO.Geometry + * A Geometry is a description of a geographic object. Create an instance + * of this class with the constructor. This is a base class, + * typical geometry types are described by subclasses of this class. + */ +ZOO.Geometry = ZOO.Class({ + /** + * Property: id + * {String} A unique identifier for this geometry. + */ + id: null, + /** + * Property: parent + * {}This is set when a Geometry is added as component + * of another geometry + */ + parent: null, + /** + * Property: bounds + * {} The bounds of this geometry + */ + bounds: null, + /** + * Constructor: ZOO.Geometry + * Creates a geometry object. + */ + initialize: function() { + //generate unique id + }, + /** + * Method: destroy + * Destroy this geometry. + */ + destroy: function() { + this.id = null; + this.bounds = null; + }, + /** + * Method: clone + * Create a clone of this geometry. Does not set any non-standard + * properties of the cloned geometry. + * + * Returns: + * {} An exact clone of this geometry. + */ + clone: function() { + return new ZOO.Geometry(); + }, + /** + * Method: extendBounds + * Extend the existing bounds to include the new bounds. + * If geometry's bounds is not yet set, then set a new Bounds. + * + * Parameters: + * newBounds - {} + */ + extendBounds: function(newBounds){ + var bounds = this.getBounds(); + if (!bounds) + this.setBounds(newBounds); + else + this.bounds.extend(newBounds); + }, + /** + * Set the bounds for this Geometry. + * + * Parameters: + * bounds - {} + */ + setBounds: function(bounds) { + if (bounds) + this.bounds = bounds.clone(); + }, + /** + * Method: clearBounds + * Nullify this components bounds and that of its parent as well. + */ + clearBounds: function() { + this.bounds = null; + if (this.parent) + this.parent.clearBounds(); + }, + /** + * Method: getBounds + * Get the bounds for this Geometry. If bounds is not set, it + * is calculated again, this makes queries faster. + * + * Returns: + * {} + */ + getBounds: function() { + if (this.bounds == null) { + this.calculateBounds(); + } + return this.bounds; + }, + /** + * Method: calculateBounds + * Recalculate the bounds for the geometry. + */ + calculateBounds: function() { + // This should be overridden by subclasses. + return this.bounds; + }, + distanceTo: function(geometry, options) { + }, + getVertices: function(nodes) { + }, + getLength: function() { + return 0.0; + }, + getArea: function() { + return 0.0; + }, + getCentroid: function() { + return null; + }, + /** + * Method: toString + * Returns the Well-Known Text representation of a geometry + * + * Returns: + * {String} Well-Known Text + */ + toString: function() { + return ZOO.Format.WKT.prototype.write( + new ZOO.Feature(this) + ); + }, + CLASS_NAME: 'ZOO.Geometry' +}); +/** + * Function: ZOO.Geometry.fromWKT + * Generate a geometry given a Well-Known Text string. + * + * Parameters: + * wkt - {String} A string representing the geometry in Well-Known Text. + * + * Returns: + * {} A geometry of the appropriate class. + */ +ZOO.Geometry.fromWKT = function(wkt) { + var format = arguments.callee.format; + if(!format) { + format = new ZOO.Format.WKT(); + arguments.callee.format = format; + } + var geom; + var result = format.read(wkt); + if(result instanceof ZOO.Feature) { + geom = result.geometry; + } else if(result instanceof Array) { + var len = result.length; + var components = new Array(len); + for(var i=0; i= 0 && along1 <= 1 && along2 >=0 && along2 <= 1) { + // intersect + if(!point) { + intersection = true; + } else { + // calculate the intersection point + var x = seg1.x1 + (along1 * x12_11); + var y = seg1.y1 + (along1 * y12_11); + intersection = new ZOO.Geometry.Point(x, y); + } + } + } + if(tolerance) { + var dist; + if(intersection) { + if(point) { + var segs = [seg1, seg2]; + var seg, x, y; + // check segment endpoints for proximity to intersection + // set intersection to first endpoint within the tolerance + outer: for(var i=0; i<2; ++i) { + seg = segs[i]; + for(var j=1; j<3; ++j) { + x = seg["x" + j]; + y = seg["y" + j]; + dist = Math.sqrt( + Math.pow(x - intersection.x, 2) + + Math.pow(y - intersection.y, 2) + ); + if(dist < tolerance) { + intersection.x = x; + intersection.y = y; + break outer; + } + } + } + } + } else { + // no calculated intersection, but segments could be within + // the tolerance of one another + var segs = [seg1, seg2]; + var source, target, x, y, p, result; + // check segment endpoints for proximity to intersection + // set intersection to first endpoint within the tolerance + outer: for(var i=0; i<2; ++i) { + source = segs[i]; + target = segs[(i+1)%2]; + for(var j=1; j<3; ++j) { + p = {x: source["x"+j], y: source["y"+j]}; + result = ZOO.Geometry.distanceToSegment(p, target); + if(result.distance < tolerance) { + if(point) { + intersection = new ZOO.Geometry.Point(p.x, p.y); + } else { + intersection = true; + } + break outer; + } + } + } + } + } + return intersection; +}; +ZOO.Geometry.distanceToSegment = function(point, segment) { + var x0 = point.x; + var y0 = point.y; + var x1 = segment.x1; + var y1 = segment.y1; + var x2 = segment.x2; + var y2 = segment.y2; + var dx = x2 - x1; + var dy = y2 - y1; + var along = ((dx * (x0 - x1)) + (dy * (y0 - y1))) / + (Math.pow(dx, 2) + Math.pow(dy, 2)); + var x, y; + if(along <= 0.0) { + x = x1; + y = y1; + } else if(along >= 1.0) { + x = x2; + y = y2; + } else { + x = x1 + along * dx; + y = y1 + along * dy; + } + return { + distance: Math.sqrt(Math.pow(x - x0, 2) + Math.pow(y - y0, 2)), + x: x, y: y + }; +}; +/** + * Class: ZOO.Geometry.Collection + * A Collection is exactly what it sounds like: A collection of different + * Geometries. These are stored in the local parameter (which + * can be passed as a parameter to the constructor). + * + * As new geometries are added to the collection, they are NOT cloned. + * When removing geometries, they need to be specified by reference (ie you + * have to pass in the *exact* geometry to be removed). + * + * The and functions here merely iterate through + * the components, summing their respective areas and lengths. + * + * Create a new instance with the constructor. + * + * Inerhits from: + * - + */ +ZOO.Geometry.Collection = ZOO.Class(ZOO.Geometry, { + /** + * Property: components + * {Array()} The component parts of this geometry + */ + components: null, + /** + * Property: componentTypes + * {Array(String)} An array of class names representing the types of + * components that the collection can include. A null value means the + * component types are not restricted. + */ + componentTypes: null, + /** + * Constructor: ZOO.Geometry.Collection + * Creates a Geometry Collection -- a list of geoms. + * + * Parameters: + * components - {Array()} Optional array of geometries + * + */ + initialize: function (components) { + ZOO.Geometry.prototype.initialize.apply(this, arguments); + this.components = []; + if (components != null) { + this.addComponents(components); + } + }, + /** + * Method: destroy + * Destroy this geometry. + */ + destroy: function () { + this.components.length = 0; + this.components = null; + }, + /** + * Method: clone + * Clone this geometry. + * + * Returns: + * {} An exact clone of this collection + */ + clone: function() { + var geometry = eval("new " + this.CLASS_NAME + "()"); + for(var i=0, len=this.components.length; i 0) { + this.setBounds(this.components[0].getBounds()); + for (var i=1, len=this.components.length; i)} An array of geometries to add + */ + addComponents: function(components){ + if(!(components instanceof Array)) + components = [components]; + for(var i=0, len=components.length; i} A geometry to add + * index - {int} Optional index into the array to insert the component + * + * Returns: + * {Boolean} The component geometry was successfully added + */ + addComponent: function(component, index) { + var added = false; + if(component) { + if(this.componentTypes == null || + (ZOO.indexOf(this.componentTypes, + component.CLASS_NAME) > -1)) { + if(index != null && (index < this.components.length)) { + var components1 = this.components.slice(0, index); + var components2 = this.components.slice(index, + this.components.length); + components1.push(component); + this.components = components1.concat(components2); + } else { + this.components.push(component); + } + component.parent = this; + this.clearBounds(); + added = true; + } + } + return added; + }, + /** + * Method: removeComponents + * Remove components from this geometry. + * + * Parameters: + * components - {Array()} The components to be removed + */ + removeComponents: function(components) { + if(!(components instanceof Array)) + components = [components]; + for(var i=components.length-1; i>=0; --i) { + this.removeComponent(components[i]); + } + }, + /** + * Method: removeComponent + * Remove a component from this geometry. + * + * Parameters: + * component - {} + */ + removeComponent: function(component) { + ZOO.removeItem(this.components, component); + // clearBounds() so that it gets recalculated on the next call + // to this.getBounds(); + this.clearBounds(); + }, + /** + * Method: getLength + * Calculate the length of this geometry + * + * Returns: + * {Float} The length of the geometry + */ + getLength: function() { + var length = 0.0; + for (var i=0, len=this.components.length; i. + * + * Returns: + * {Float} The area of the collection by summing its parts + */ + getArea: function() { + var area = 0.0; + for (var i=0, len=this.components.length; i} The spatial reference system + * for the geometry coordinates. If not provided, Geographic/WGS84 is + * assumed. + * + * Reference: + * Robert. G. Chamberlain and William H. Duquette, "Some Algorithms for + * Polygons on a Sphere", JPL Publication 07-03, Jet Propulsion + * Laboratory, Pasadena, CA, June 2007 http://trs-new.jpl.nasa.gov/dspace/handle/2014/40409 + * + * Returns: + * {float} The approximate geodesic area of the geometry in square meters. + */ + getGeodesicArea: function(projection) { + var area = 0.0; + for(var i=0, len=this.components.length; i} The centroid of the collection + */ + getCentroid: function() { + return this.components.length && this.components[0].getCentroid(); + }, + /** + * Method: getGeodesicLength + * Calculate the approximate length of the geometry were it projected onto + * the earth. + * + * Parameters: + * projection - {} The spatial reference system + * for the geometry coordinates. If not provided, Geographic/WGS84 is + * assumed. + * + * Returns: + * {Float} The appoximate geodesic length of the geometry in meters. + */ + getGeodesicLength: function(projection) { + var length = 0.0; + for(var i=0, len=this.components.length; i} Center point for the rotation + */ + rotate: function(angle, origin) { + for(var i=0, len=this.components.length; i} Point of origin for resizing + * ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1. + * + * Returns: + * {ZOO.Geometry} - The current geometry. + */ + resize: function(scale, origin, ratio) { + for(var i=0; i} The geometry to test. + * + * Returns: + * {Boolean} The supplied geometry is equivalent to this geometry. + */ + equals: function(geometry) { + var equivalent = true; + if(!geometry || !geometry.CLASS_NAME || + (this.CLASS_NAME != geometry.CLASS_NAME)) + equivalent = false; + else if(!(geometry.components instanceof Array) || + (geometry.components.length != this.components.length)) + equivalent = false; + else + for(var i=0, len=this.components.length; i} + * dest - {} + * + * Returns: + * {} + */ + transform: function(source, dest) { + if (source && dest) { + for (var i=0, len=this.components.length; i} Any type of geometry. + * + * Returns: + * {Boolean} The input geometry intersects this one. + */ + intersects: function(geometry) { + var intersect = false; + for(var i=0, len=this.components.length; i + */ +ZOO.Geometry.Point = ZOO.Class(ZOO.Geometry, { + /** + * Property: x + * {float} + */ + x: null, + /** + * Property: y + * {float} + */ + y: null, + /** + * Constructor: ZOO.Geometry.Point + * Construct a point geometry. + * + * Parameters: + * x - {float} + * y - {float} + * + */ + initialize: function(x, y) { + ZOO.Geometry.prototype.initialize.apply(this, arguments); + this.x = parseFloat(x); + this.y = parseFloat(y); + }, + /** + * Method: clone + * + * Returns: + * {} An exact clone of this ZOO.Geometry.Point + */ + clone: function(obj) { + if (obj == null) + obj = new ZOO.Geometry.Point(this.x, this.y); + // catch any randomly tagged-on properties + // ZOO.Util.applyDefaults(obj, this); + return obj; + }, + /** + * Method: calculateBounds + * Create a new Bounds based on the x/y + */ + calculateBounds: function () { + this.bounds = new ZOO.Bounds(this.x, this.y, + this.x, this.y); + }, + distanceTo: function(geometry, options) { + var edge = !(options && options.edge === false); + var details = edge && options && options.details; + var distance, x0, y0, x1, y1, result; + if(geometry instanceof ZOO.Geometry.Point) { + x0 = this.x; + y0 = this.y; + x1 = geometry.x; + y1 = geometry.y; + distance = Math.sqrt(Math.pow(x0 - x1, 2) + Math.pow(y0 - y1, 2)); + result = !details ? + distance : {x0: x0, y0: y0, x1: x1, y1: y1, distance: distance}; + } else { + result = geometry.distanceTo(this, options); + if(details) { + // switch coord order since this geom is target + result = { + x0: result.x1, y0: result.y1, + x1: result.x0, y1: result.y0, + distance: result.distance + }; + } + } + return result; + }, + /** + * Method: equals + * Determine whether another geometry is equivalent to this one. Geometries + * are considered equivalent if all components have the same coordinates. + * + * Parameters: + * geom - {} The geometry to test. + * + * Returns: + * {Boolean} The supplied geometry is equivalent to this geometry. + */ + equals: function(geom) { + var equals = false; + if (geom != null) + equals = ((this.x == geom.x && this.y == geom.y) || + (isNaN(this.x) && isNaN(this.y) && isNaN(geom.x) && isNaN(geom.y))); + return equals; + }, + /** + * Method: toShortString + * + * Returns: + * {String} Shortened String representation of Point object. + * (ex. "5, 42") + */ + toShortString: function() { + return (this.x + ", " + this.y); + }, + /** + * Method: move + * Moves a geometry by the given displacement along positive x and y axes. + * This modifies the position of the geometry and clears the cached + * bounds. + * + * Parameters: + * x - {Float} Distance to move geometry in positive x direction. + * y - {Float} Distance to move geometry in positive y direction. + */ + move: function(x, y) { + this.x = this.x + x; + this.y = this.y + y; + this.clearBounds(); + }, + /** + * Method: rotate + * Rotate a point around another. + * + * Parameters: + * angle - {Float} Rotation angle in degrees (measured counterclockwise + * from the positive x-axis) + * origin - {} Center point for the rotation + */ + rotate: function(angle, origin) { + angle *= Math.PI / 180; + var radius = this.distanceTo(origin); + var theta = angle + Math.atan2(this.y - origin.y, this.x - origin.x); + this.x = origin.x + (radius * Math.cos(theta)); + this.y = origin.y + (radius * Math.sin(theta)); + this.clearBounds(); + }, + /** + * Method: getCentroid + * + * Returns: + * {} The centroid of the collection + */ + getCentroid: function() { + return new ZOO.Geometry.Point(this.x, this.y); + }, + /** + * Method: resize + * Resize a point relative to some origin. For points, this has the effect + * of scaling a vector (from the origin to the point). This method is + * more useful on geometry collection subclasses. + * + * Parameters: + * scale - {Float} Ratio of the new distance from the origin to the old + * distance from the origin. A scale of 2 doubles the + * distance between the point and origin. + * origin - {} Point of origin for resizing + * ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1. + * + * Returns: + * {ZOO.Geometry} - The current geometry. + */ + resize: function(scale, origin, ratio) { + ratio = (ratio == undefined) ? 1 : ratio; + this.x = origin.x + (scale * ratio * (this.x - origin.x)); + this.y = origin.y + (scale * (this.y - origin.y)); + this.clearBounds(); + return this; + }, + /** + * Method: intersects + * Determine if the input geometry intersects this one. + * + * Parameters: + * geometry - {} Any type of geometry. + * + * Returns: + * {Boolean} The input geometry intersects this one. + */ + intersects: function(geometry) { + var intersect = false; + if(geometry.CLASS_NAME == "ZOO.Geometry.Point") { + intersect = this.equals(geometry); + } else { + intersect = geometry.intersects(this); + } + return intersect; + }, + /** + * Method: transform + * Translate the x,y properties of the point from source to dest. + * + * Parameters: + * source - {} + * dest - {} + * + * Returns: + * {} + */ + transform: function(source, dest) { + if ((source && dest)) { + ZOO.Projection.transform( + this, source, dest); + this.bounds = null; + } + return this; + }, + /** + * Method: getVertices + * Return a list of all points in this geometry. + * + * Parameters: + * nodes - {Boolean} For lines, only return vertices that are + * endpoints. If false, for lines, only vertices that are not + * endpoints will be returned. If not provided, all vertices will + * be returned. + * + * Returns: + * {Array} A list of all vertices in the geometry. + */ + getVertices: function(nodes) { + return [this]; + }, + CLASS_NAME: 'ZOO.Geometry.Point' +}); +/** + * Class: ZOO.Geometry.Surface + * Surface geometry class. + * + * Inherits from: + * - + */ +ZOO.Geometry.Surface = ZOO.Class(ZOO.Geometry, { + initialize: function() { + ZOO.Geometry.prototype.initialize.apply(this, arguments); + }, + CLASS_NAME: "ZOO.Geometry.Surface" +}); +/** + * Class: ZOO.Geometry.MultiPoint + * MultiPoint is a collection of Points. Create a new instance with the + * constructor. + * + * Inherits from: + * - + */ +ZOO.Geometry.MultiPoint = ZOO.Class( + ZOO.Geometry.Collection, { + /** + * Property: componentTypes + * {Array(String)} An array of class names representing the types of + * components that the collection can include. A null value means the + * component types are not restricted. + */ + componentTypes: ["ZOO.Geometry.Point"], + /** + * Constructor: ZOO.Geometry.MultiPoint + * Create a new MultiPoint Geometry + * + * Parameters: + * components - {Array()} + * + * Returns: + * {} + */ + initialize: function(components) { + ZOO.Geometry.Collection.prototype.initialize.apply(this,arguments); + }, + /** + * Method: addPoint + * Wrapper for + * + * Parameters: + * point - {} Point to be added + * index - {Integer} Optional index + */ + addPoint: function(point, index) { + this.addComponent(point, index); + }, + /** + * Method: removePoint + * Wrapper for + * + * Parameters: + * point - {} Point to be removed + */ + removePoint: function(point){ + this.removeComponent(point); + }, + CLASS_NAME: "ZOO.Geometry.MultiPoint" +}); +/** + * Class: ZOO.Geometry.Curve + * A Curve is a MultiPoint, whose points are assumed to be connected. To + * this end, we provide a "getLength()" function, which iterates through + * the points, summing the distances between them. + * + * Inherits: + * - + */ +ZOO.Geometry.Curve = ZOO.Class(ZOO.Geometry.MultiPoint, { + /** + * Property: componentTypes + * {Array(String)} An array of class names representing the types of + * components that the collection can include. A null + * value means the component types are not restricted. + */ + componentTypes: ["ZOO.Geometry.Point"], + /** + * Constructor: ZOO.Geometry.Curve + * + * Parameters: + * point - {Array()} + */ + initialize: function(points) { + ZOO.Geometry.MultiPoint.prototype.initialize.apply(this,arguments); + }, + /** + * Method: getLength + * + * Returns: + * {Float} The length of the curve + */ + getLength: function() { + var length = 0.0; + if ( this.components && (this.components.length > 1)) { + for(var i=1, len=this.components.length; i} The spatial reference system + * for the geometry coordinates. If not provided, Geographic/WGS84 is + * assumed. + * + * Returns: + * {Float} The appoximate geodesic length of the geometry in meters. + */ + getGeodesicLength: function(projection) { + var geom = this; // so we can work with a clone if needed + if(projection) { + var gg = new ZOO.Projection("EPSG:4326"); + if(!gg.equals(projection)) { + geom = this.clone().transform(projection, gg); + } + } + var length = 0.0; + if(geom.components && (geom.components.length > 1)) { + var p1, p2; + for(var i=1, len=geom.components.length; i + */ +ZOO.Geometry.LineString = ZOO.Class(ZOO.Geometry.Curve, { + /** + * Constructor: ZOO.Geometry.LineString + * Create a new LineString geometry + * + * Parameters: + * points - {Array()} An array of points used to + * generate the linestring + * + */ + initialize: function(points) { + ZOO.Geometry.Curve.prototype.initialize.apply(this, arguments); + }, + /** + * Method: removeComponent + * Only allows removal of a point if there are three or more points in + * the linestring. (otherwise the result would be just a single point) + * + * Parameters: + * point - {} The point to be removed + */ + removeComponent: function(point) { + if ( this.components && (this.components.length > 2)) + ZOO.Geometry.Collection.prototype.removeComponent.apply(this,arguments); + }, + /** + * Method: intersects + * Test for instersection between two geometries. This is a cheapo + * implementation of the Bently-Ottmann algorigithm. It doesn't + * really keep track of a sweep line data structure. It is closer + * to the brute force method, except that segments are sorted and + * potential intersections are only calculated when bounding boxes + * intersect. + * + * Parameters: + * geometry - {} + * + * Returns: + * {Boolean} The input geometry intersects this geometry. + */ + intersects: function(geometry) { + var intersect = false; + var type = geometry.CLASS_NAME; + if(type == "ZOO.Geometry.LineString" || + type == "ZOO.Geometry.LinearRing" || + type == "ZOO.Geometry.Point") { + var segs1 = this.getSortedSegments(); + var segs2; + if(type == "ZOO.Geometry.Point") + segs2 = [{ + x1: geometry.x, y1: geometry.y, + x2: geometry.x, y2: geometry.y + }]; + else + segs2 = geometry.getSortedSegments(); + var seg1, seg1x1, seg1x2, seg1y1, seg1y2, + seg2, seg2y1, seg2y2; + // sweep right + outer: for(var i=0, len=segs1.length; i seg1x2) + break; + if(seg2.x2 < seg1x1) + continue; + seg2y1 = seg2.y1; + seg2y2 = seg2.y2; + if(Math.min(seg2y1, seg2y2) > Math.max(seg1y1, seg1y2)) + continue; + if(Math.max(seg2y1, seg2y2) < Math.min(seg1y1, seg1y2)) + continue; + if(ZOO.Geometry.segmentsIntersect(seg1, seg2)) { + intersect = true; + break outer; + } + } + } + } else { + intersect = geometry.intersects(this); + } + return intersect; + }, + /** + * Method: getSortedSegments + * + * Returns: + * {Array} An array of segment objects. Segment objects have properties + * x1, y1, x2, and y2. The start point is represented by x1 and y1. + * The end point is represented by x2 and y2. Start and end are + * ordered so that x1 < x2. + */ + getSortedSegments: function() { + var numSeg = this.components.length - 1; + var segments = new Array(numSeg); + for(var i=0; i 0) { + // sort intersections along segment + var xDir = seg.x1 < seg.x2 ? 1 : -1; + var yDir = seg.y1 < seg.y2 ? 1 : -1; + result = { + lines: lines, + points: intersections.sort(function(p1, p2) { + return (xDir * p1.x - xDir * p2.x) || (yDir * p1.y - yDir * p2.y); + }) + }; + } + return result; + }, + /** + * Method: split + * Use this geometry (the source) to attempt to split a target geometry. + * + * Parameters: + * target - {} The target geometry. + * options - {Object} Properties of this object will be used to determine + * how the split is conducted. + * + * Valid options: + * mutual - {Boolean} Split the source geometry in addition to the target + * geometry. Default is false. + * edge - {Boolean} Allow splitting when only edges intersect. Default is + * true. If false, a vertex on the source must be within the tolerance + * distance of the intersection to be considered a split. + * tolerance - {Number} If a non-null value is provided, intersections + * within the tolerance distance of an existing vertex on the source + * will be assumed to occur at the vertex. + * + * Returns: + * {Array} A list of geometries (of this same type as the target) that + * result from splitting the target with the source geometry. The + * source and target geometry will remain unmodified. If no split + * results, null will be returned. If mutual is true and a split + * results, return will be an array of two arrays - the first will be + * all geometries that result from splitting the source geometry and + * the second will be all geometries that result from splitting the + * target geometry. + */ + split: function(target, options) { + var results = null; + var mutual = options && options.mutual; + var sourceSplit, targetSplit, sourceParts, targetParts; + if(target instanceof ZOO.Geometry.LineString) { + var verts = this.getVertices(); + var vert1, vert2, seg, splits, lines, point; + var points = []; + sourceParts = []; + for(var i=0, stop=verts.length-2; i<=stop; ++i) { + vert1 = verts[i]; + vert2 = verts[i+1]; + seg = { + x1: vert1.x, y1: vert1.y, + x2: vert2.x, y2: vert2.y + }; + targetParts = targetParts || [target]; + if(mutual) + points.push(vert1.clone()); + for(var j=0; j 0) { + lines.unshift(j, 1); + Array.prototype.splice.apply(targetParts, lines); + j += lines.length - 2; + } + if(mutual) { + for(var k=0, len=splits.points.length; k 0 && points.length > 0) { + points.push(vert2.clone()); + sourceParts.push(new ZOO.Geometry.LineString(points)); + } + } else { + results = target.splitWith(this, options); + } + if(targetParts && targetParts.length > 1) + targetSplit = true; + else + targetParts = []; + if(sourceParts && sourceParts.length > 1) + sourceSplit = true; + else + sourceParts = []; + if(targetSplit || sourceSplit) { + if(mutual) + results = [sourceParts, targetParts]; + else + results = targetParts; + } + return results; + }, + /** + * Method: splitWith + * Split this geometry (the target) with the given geometry (the source). + * + * Parameters: + * geometry - {} A geometry used to split this + * geometry (the source). + * options - {Object} Properties of this object will be used to determine + * how the split is conducted. + * + * Valid options: + * mutual - {Boolean} Split the source geometry in addition to the target + * geometry. Default is false. + * edge - {Boolean} Allow splitting when only edges intersect. Default is + * true. If false, a vertex on the source must be within the tolerance + * distance of the intersection to be considered a split. + * tolerance - {Number} If a non-null value is provided, intersections + * within the tolerance distance of an existing vertex on the source + * will be assumed to occur at the vertex. + * + * Returns: + * {Array} A list of geometries (of this same type as the target) that + * result from splitting the target with the source geometry. The + * source and target geometry will remain unmodified. If no split + * results, null will be returned. If mutual is true and a split + * results, return will be an array of two arrays - the first will be + * all geometries that result from splitting the source geometry and + * the second will be all geometries that result from splitting the + * target geometry. + */ + splitWith: function(geometry, options) { + return geometry.split(this, options); + }, + /** + * Method: getVertices + * Return a list of all points in this geometry. + * + * Parameters: + * nodes - {Boolean} For lines, only return vertices that are + * endpoints. If false, for lines, only vertices that are not + * endpoints will be returned. If not provided, all vertices will + * be returned. + * + * Returns: + * {Array} A list of all vertices in the geometry. + */ + getVertices: function(nodes) { + var vertices; + if(nodes === true) + vertices = [ + this.components[0], + this.components[this.components.length-1] + ]; + else if (nodes === false) + vertices = this.components.slice(1, this.components.length-1); + else + vertices = this.components.slice(); + return vertices; + }, + distanceTo: function(geometry, options) { + var edge = !(options && options.edge === false); + var details = edge && options && options.details; + var result, best = {}; + var min = Number.POSITIVE_INFINITY; + if(geometry instanceof ZOO.Geometry.Point) { + var segs = this.getSortedSegments(); + var x = geometry.x; + var y = geometry.y; + var seg; + for(var i=0, len=segs.length; i x && ((y > seg.y1 && y < seg.y2) || (y < seg.y1 && y > seg.y2))) + break; + } + } + if(details) + best = { + distance: best.distance, + x0: best.x, y0: best.y, + x1: x, y1: y + }; + else + best = best.distance; + } else if(geometry instanceof ZOO.Geometry.LineString) { + var segs0 = this.getSortedSegments(); + var segs1 = geometry.getSortedSegments(); + var seg0, seg1, intersection, x0, y0; + var len1 = segs1.length; + var interOptions = {point: true}; + outer: for(var i=0, len=segs0.length; i + */ +ZOO.Geometry.LinearRing = ZOO.Class( + ZOO.Geometry.LineString, { + /** + * Property: componentTypes + * {Array(String)} An array of class names representing the types of + * components that the collection can include. A null + * value means the component types are not restricted. + */ + componentTypes: ["ZOO.Geometry.Point"], + /** + * Constructor: ZOO.Geometry.LinearRing + * Linear rings are constructed with an array of points. This array + * can represent a closed or open ring. If the ring is open (the last + * point does not equal the first point), the constructor will close + * the ring. If the ring is already closed (the last point does equal + * the first point), it will be left closed. + * + * Parameters: + * points - {Array()} points + */ + initialize: function(points) { + ZOO.Geometry.LineString.prototype.initialize.apply(this,arguments); + }, + /** + * Method: addComponent + * Adds a point to geometry components. If the point is to be added to + * the end of the components array and it is the same as the last point + * already in that array, the duplicate point is not added. This has + * the effect of closing the ring if it is not already closed, and + * doing the right thing if it is already closed. This behavior can + * be overridden by calling the method with a non-null index as the + * second argument. + * + * Parameter: + * point - {} + * index - {Integer} Index into the array to insert the component + * + * Returns: + * {Boolean} Was the Point successfully added? + */ + addComponent: function(point, index) { + var added = false; + //remove last point + var lastPoint = this.components.pop(); + // given an index, add the point + // without an index only add non-duplicate points + if(index != null || !point.equals(lastPoint)) + added = ZOO.Geometry.Collection.prototype.addComponent.apply(this,arguments); + //append copy of first point + var firstPoint = this.components[0]; + ZOO.Geometry.Collection.prototype.addComponent.apply(this,[firstPoint]); + return added; + }, + /** + * APIMethod: removeComponent + * Removes a point from geometry components. + * + * Parameters: + * point - {} + */ + removeComponent: function(point) { + if (this.components.length > 4) { + //remove last point + this.components.pop(); + //remove our point + ZOO.Geometry.Collection.prototype.removeComponent.apply(this,arguments); + //append copy of first point + var firstPoint = this.components[0]; + ZOO.Geometry.Collection.prototype.addComponent.apply(this,[firstPoint]); + } + }, + /** + * Method: move + * Moves a geometry by the given displacement along positive x and y axes. + * This modifies the position of the geometry and clears the cached + * bounds. + * + * Parameters: + * x - {Float} Distance to move geometry in positive x direction. + * y - {Float} Distance to move geometry in positive y direction. + */ + move: function(x, y) { + for(var i = 0, len=this.components.length; i} Center point for the rotation + */ + rotate: function(angle, origin) { + for(var i=0, len=this.components.length; i} Point of origin for resizing + * ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1. + * + * Returns: + * {ZOO.Geometry} - The current geometry. + */ + resize: function(scale, origin, ratio) { + for(var i=0, len=this.components.length; i} + * dest - {} + * + * Returns: + * {} + */ + transform: function(source, dest) { + if (source && dest) { + for (var i=0, len=this.components.length; i} The centroid of the ring + */ + getCentroid: function() { + if ( this.components && (this.components.length > 2)) { + var sumX = 0.0; + var sumY = 0.0; + for (var i = 0; i < this.components.length - 1; i++) { + var b = this.components[i]; + var c = this.components[i+1]; + sumX += (b.x + c.x) * (b.x * c.y - c.x * b.y); + sumY += (b.y + c.y) * (b.x * c.y - c.x * b.y); + } + var area = -1 * this.getArea(); + var x = sumX / (6 * area); + var y = sumY / (6 * area); + } + return new ZOO.Geometry.Point(x, y); + }, + /** + * Method: getArea + * Note - The area is positive if the ring is oriented CW, otherwise + * it will be negative. + * + * Returns: + * {Float} The signed area for a ring. + */ + getArea: function() { + var area = 0.0; + if ( this.components && (this.components.length > 2)) { + var sum = 0.0; + for (var i=0, len=this.components.length; i} The spatial reference system + * for the geometry coordinates. If not provided, Geographic/WGS84 is + * assumed. + * + * Reference: + * Robert. G. Chamberlain and William H. Duquette, "Some Algorithms for + * Polygons on a Sphere", JPL Publication 07-03, Jet Propulsion + * Laboratory, Pasadena, CA, June 2007 http://trs-new.jpl.nasa.gov/dspace/handle/2014/40409 + * + * Returns: + * {float} The approximate signed geodesic area of the polygon in square + * meters. + */ + getGeodesicArea: function(projection) { + var ring = this; // so we can work with a clone if needed + if(projection) { + var gg = new ZOO.Projection("EPSG:4326"); + if(!gg.equals(projection)) { + ring = this.clone().transform(projection, gg); + } + } + var area = 0.0; + var len = ring.components && ring.components.length; + if(len > 2) { + var p1, p2; + for(var i=0; i} + * + * Returns: + * {Boolean | Number} The point is inside the linear ring. Returns 1 if + * the point is coincident with an edge. Returns boolean otherwise. + */ + containsPoint: function(point) { + var approx = OpenLayers.Number.limitSigDigs; + var digs = 14; + var px = approx(point.x, digs); + var py = approx(point.y, digs); + function getX(y, x1, y1, x2, y2) { + return (((x1 - x2) * y) + ((x2 * y1) - (x1 * y2))) / (y1 - y2); + } + var numSeg = this.components.length - 1; + var start, end, x1, y1, x2, y2, cx, cy; + var crosses = 0; + for(var i=0; i= x1 && px <= x2) || // right or vert + x1 >= x2 && (px <= x1 && px >= x2)) { // left or vert + // point on edge + crosses = -1; + break; + } + } + // ignore other horizontal edges + continue; + } + cx = approx(getX(py, x1, y1, x2, y2), digs); + if(cx == px) { + // point on line + if(y1 < y2 && (py >= y1 && py <= y2) || // upward + y1 > y2 && (py <= y1 && py >= y2)) { // downward + // point on edge + crosses = -1; + break; + } + } + if(cx <= px) { + // no crossing to the right + continue; + } + if(x1 != x2 && (cx < Math.min(x1, x2) || cx > Math.max(x1, x2))) { + // no crossing + continue; + } + if(y1 < y2 && (py >= y1 && py < y2) || // upward + y1 > y2 && (py < y1 && py >= y2)) { // downward + ++crosses; + } + } + var contained = (crosses == -1) ? + // on edge + 1 : + // even (out) or odd (in) + !!(crosses & 1); + + return contained; + }, + intersects: function(geometry) { + var intersect = false; + if(geometry.CLASS_NAME == "ZOO.Geometry.Point") + intersect = this.containsPoint(geometry); + else if(geometry.CLASS_NAME == "ZOO.Geometry.LineString") + intersect = geometry.intersects(this); + else if(geometry.CLASS_NAME == "ZOO.Geometry.LinearRing") + intersect = ZOO.Geometry.LineString.prototype.intersects.apply( + this, [geometry] + ); + else + for(var i=0, len=geometry.components.length; i + * components. + * + * Inherits from: + * - + */ +ZOO.Geometry.MultiLineString = ZOO.Class( + ZOO.Geometry.Collection, { + componentTypes: ["ZOO.Geometry.LineString"], + /** + * Constructor: ZOO.Geometry.MultiLineString + * Constructor for a MultiLineString Geometry. + * + * Parameters: + * components - {Array()} + * + */ + initialize: function(components) { + ZOO.Geometry.Collection.prototype.initialize.apply(this,arguments); + }, + split: function(geometry, options) { + var results = null; + var mutual = options && options.mutual; + var splits, sourceLine, sourceLines, sourceSplit, targetSplit; + var sourceParts = []; + var targetParts = [geometry]; + for(var i=0, len=this.components.length; i 1) + sourceSplit = true; + else + sourceParts = []; + if(targetParts && targetParts.length > 1) + targetSplit = true; + else + targetParts = []; + if(sourceSplit || targetSplit) { + if(mutual) + results = [sourceParts, targetParts]; + else + results = targetParts; + } + return results; + }, + splitWith: function(geometry, options) { + var results = null; + var mutual = options && options.mutual; + var splits, targetLine, sourceLines, sourceSplit, targetSplit, sourceParts, targetParts; + if(geometry instanceof ZOO.Geometry.LineString) { + targetParts = []; + sourceParts = [geometry]; + for(var i=0, len=this.components.length; i 1) + sourceSplit = true; + else + sourceParts = []; + if(targetParts && targetParts.length > 1) + targetSplit = true; + else + targetParts = []; + if(sourceSplit || targetSplit) { + if(mutual) + results = [sourceParts, targetParts]; + else + results = targetParts; + } + return results; + }, + CLASS_NAME: "ZOO.Geometry.MultiLineString" +}); +/** + * Class: ZOO.Geometry.Polygon + * Polygon is a collection of . + * + * Inherits from: + * - + */ +ZOO.Geometry.Polygon = ZOO.Class( + ZOO.Geometry.Collection, { + componentTypes: ["ZOO.Geometry.LinearRing"], + /** + * Constructor: ZOO.Geometry.Polygon + * Constructor for a Polygon geometry. + * The first ring (this.component[0])is the outer bounds of the polygon and + * all subsequent rings (this.component[1-n]) are internal holes. + * + * + * Parameters: + * components - {Array()} + */ + initialize: function(components) { + ZOO.Geometry.Collection.prototype.initialize.apply(this,arguments); + }, + /** + * Method: getArea + * Calculated by subtracting the areas of the internal holes from the + * area of the outer hole. + * + * Returns: + * {float} The area of the geometry + */ + getArea: function() { + var area = 0.0; + if ( this.components && (this.components.length > 0)) { + area += Math.abs(this.components[0].getArea()); + for (var i=1, len=this.components.length; i} The spatial reference system + * for the geometry coordinates. If not provided, Geographic/WGS84 is + * assumed. + * + * Reference: + * Robert. G. Chamberlain and William H. Duquette, "Some Algorithms for + * Polygons on a Sphere", JPL Publication 07-03, Jet Propulsion + * Laboratory, Pasadena, CA, June 2007 http://trs-new.jpl.nasa.gov/dspace/handle/2014/40409 + * + * Returns: + * {float} The approximate geodesic area of the polygon in square meters. + */ + getGeodesicArea: function(projection) { + var area = 0.0; + if(this.components && (this.components.length > 0)) { + area += Math.abs(this.components[0].getGeodesicArea(projection)); + for(var i=1, len=this.components.length; i} + * + * Returns: + * {Boolean | Number} The point is inside the polygon. Returns 1 if the + * point is on an edge. Returns boolean otherwise. + */ + containsPoint: function(point) { + var numRings = this.components.length; + var contained = false; + if(numRings > 0) { + // check exterior ring - 1 means on edge, boolean otherwise + contained = this.components[0].containsPoint(point); + if(contained !== 1) { + if(contained && numRings > 1) { + // check interior rings + var hole; + for(var i=1; i} center of polygon. + * radius - {Float} distance to vertex, in map units. + * sides - {Integer} Number of sides. 20 approximates a circle. + * rotation - {Float} original angle of rotation, in degrees. + */ +ZOO.Geometry.Polygon.createRegularPolygon = function(origin, radius, sides, rotation) { + var angle = Math.PI * ((1/sides) - (1/2)); + if(rotation) { + angle += (rotation / 180) * Math.PI; + } + var rotatedAngle, x, y; + var points = []; + for(var i=0; i + * components. Create a new instance with the + * constructor. + * + * Inherits from: + * - + */ +ZOO.Geometry.MultiPolygon = ZOO.Class( + ZOO.Geometry.Collection, { + componentTypes: ["ZOO.Geometry.Polygon"], + /** + * Constructor: ZOO.Geometry.MultiPolygon + * Create a new MultiPolygon geometry + * + * Parameters: + * components - {Array()} An array of polygons + * used to generate the MultiPolygon + * + */ + initialize: function(components) { + ZOO.Geometry.Collection.prototype.initialize.apply(this,arguments); + }, + CLASS_NAME: "ZOO.Geometry.MultiPolygon" +}); +/** + * Class: ZOO.Process + * Used to query OGC WPS process defined by its URL and its identifier. + * Usefull for chaining localhost process. + */ +ZOO.Process = ZOO.Class({ + /** + * Property: schemaLocation + * {String} Schema location for a particular minor version. + */ + schemaLocation: "http://www.opengis.net/wps/1.0.0/../wpsExecute_request.xsd", + /** + * Property: namespaces + * {Object} Mapping of namespace aliases to namespace URIs. + */ + namespaces: { + ows: "http://www.opengis.net/ows/1.1", + wps: "http://www.opengis.net/wps/1.0.0", + xlink: "http://www.w3.org/1999/xlink", + xsi: "http://www.w3.org/2001/XMLSchema-instance", + }, + /** + * Property: url + * {String} The OGC's Web PRocessing Service URL, + * default is http://localhost/zoo. + */ + url: 'http://localhost/zoo', + /** + * Property: identifier + * {String} Process identifier in the OGC's Web Processing Service. + */ + identifier: null, + /** + * Constructor: ZOO.Process + * Create a new Process + * + * Parameters: + * url - {String} The OGC's Web Processing Service URL. + * identifier - {String} The process identifier in the OGC's Web Processing Service. + * + */ + initialize: function(url,identifier) { + this.url = url; + this.identifier = identifier; + }, + /** + * Method: Execute + * Query the OGC's Web PRocessing Servcie to Execute the process. + * + * Parameters: + * inputs - {Object} + * + * Returns: + * {String} The OGC's Web processing Service XML response. The result + * needs to be interpreted. + */ + Execute: function(inputs,outputs) { + if (this.identifier == null) + return null; + var body = new XML(''+this.identifier+''+this.buildDataInputsNode(inputs)+this.buildDataOutputsNode(outputs)+''); + body = body.toXMLString(); + var headers=['Content-Type: text/xml; charset=UTF-8']; + if(arguments.length>2){ + headers[headers.length]=arguments[2]; + } + var response = ZOO.Request.Post(this.url,body,headers); + return response; + }, + buildOutput:{ + /** + * Method: buildOutput.ResponseDocument + * Given an E4XElement representing the WPS ResponseDocument output. + * + * Parameters: + * identifier - {String} the input indetifier + * data - {Object} A WPS complex data input. + * + * Returns: + * {E4XElement} A WPS Input node. + */ + 'ResponseDocument': function(identifier,obj) { + var output = new XML(''+identifier+''); + if (obj.encoding) + output.*::Data.*::ComplexData.@encoding = obj.encoding; + if (obj.schema) + output.*::Data.*::ComplexData.@schema = obj.schema; + output = output.toXMLString(); + return output; + }, + 'RawDataOutput': function(identifier,obj) { + var output = new XML(''+identifier+''); + if (obj.encoding) + output.*::Data.*::ComplexData.@encoding = obj.encoding; + if (obj.schema) + output.*::Data.*::ComplexData.@schema = obj.schema; + output = output.toXMLString(); + return output; + } + + }, + /** + * Property: buildInput + * Object containing methods to build WPS inputs. + */ + buildInput: { + /** + * Method: buildInput.complex + * Given an E4XElement representing the WPS complex data input. + * + * Parameters: + * identifier - {String} the input indetifier + * data - {Object} A WPS complex data input. + * + * Returns: + * {E4XElement} A WPS Input node. + */ + 'complex': function(identifier,data) { + var input = new XML(''+identifier+''+(data.value?'':(data.xlink?'':''))+''); + if(data.xlink) + input.*::Reference.@mimeType = data.mimetype ? data.mimetype : 'application/json'; + else + input.*::Data.*::ComplexData.@mimeType = data.mimetype ? data.mimetype : 'application/json'; + if (data.encoding) + input.*::Data.*::ComplexData.@encoding = data.encoding; + if (data.schema) + input.*::Data.*::ComplexData.@schema = data.schema; + input = input.toXMLString(); + return input; + }, + /** + * Method: buildInput.reference + * Given an E4XElement representing the WPS reference input. + * + * Parameters: + * identifier - {String} the input indetifier + * data - {Object} A WPS reference input. + * + * Returns: + * {E4XElement} A WPS Input node. + */ + 'reference': function(identifier,data) { + return ''+identifier+''; + }, + /** + * Method: buildInput.literal + * Given an E4XElement representing the WPS literal data input. + * + * Parameters: + * identifier - {String} the input indetifier + * data - {Object} A WPS literal data input. + * + * Returns: + * {E4XElement} The WPS Input node. + */ + 'literal': function(identifier,data) { + if(data && !eval(data["isArray"])){ + var input = new XML(''+identifier+''+data.value+''); + if (data.type) + input.*::Data.*::LiteralData.@dataType = data.type; + if (data.uom) + input.*::Data.*::LiteralData.@uom = data.uom; + input = input.toXMLString(); + return input; + }else if(data){ + var inputf=""; + for(i=0;i'+identifier+''+data.value[i]+''); + if (data.type) + input.*::Data.*::LiteralData.@dataType = data.type; + if (data.uom) + input.*::Data.*::LiteralData.@uom = data.uom; + inputf += input.toXMLString(); + } + return inputf; + } + + } + }, + /** + * Method: buildDataInputsNode + * Method to build the WPS DataInputs element. + * + * Parameters: + * inputs - {Object} + * + * Returns: + * {E4XElement} The WPS DataInputs node for Execute query. + */ + buildDataInputsNode:function(inputs){ + var data, builder, inputsArray=[]; + for (var attr in inputs) { + data = inputs[attr]; + if (data && (data.mimetype || data.type == 'complex')) + builder = this.buildInput['complex']; + else if (data && (data.type == 'reference' || data.type == 'url')) + builder = this.buildInput['reference']; + else + builder = this.buildInput['literal']; + inputsArray.push(builder.apply(this,[attr,data])); + } + return ''+inputsArray.join('\n')+''; + }, + + buildDataOutputsNode:function(outputs){ + var data, builder, outputsArray=[]; + for (var attr in outputs) { + data = outputs[attr]; + builder = this.buildOutput[data.type]; + outputsArray.push(builder.apply(this,[attr,data])); + } + return outputsArray.join('\n'); + }, + + CLASS_NAME: "ZOO.Process" +}); Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/js/ZOO-proj4js.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/js/ZOO-proj4js.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-api/js/ZOO-proj4js.js (revision 672) @@ -0,0 +1,258 @@ +/* + proj4js.js -- Javascript reprojection library. + + Authors: Mike Adair madairATdmsolutions.ca + Richard Greenwood richATgreenwoodmap.com + Didier Richard didier.richardATign.fr + Stephen Irons + License: MIT as per: http://trac.osgeo.org/proj4js/browser/trunk/LICENSE + Note: This program is an almost direct port of the C library + Proj4. +*/ + +/** + * Author : René-Luc D'Hont + * + * Copyright 2010 3liz SARL. All rights reserved. + */ + +Proj4js={defaultDatum:'WGS84',transform:function(source,dest,point){if(!source.readyToUse||!dest.readyToUse){this.reportError("Proj4js initialization for "+source.srsCode+" not yet complete");return point;} +if((source.srsProjNumber=="900913"&&dest.datumCode!="WGS84")||(dest.srsProjNumber=="900913"&&source.datumCode!="WGS84")){var wgs84=Proj4js.WGS84;this.transform(source,wgs84,point);source=wgs84;} +if(source.projName=="longlat"){point.x*=Proj4js.common.D2R;point.y*=Proj4js.common.D2R;}else{if(source.to_meter){point.x*=source.to_meter;point.y*=source.to_meter;} +source.inverse(point);} +if(source.from_greenwich){point.x+=source.from_greenwich;} +point=this.datum_transform(source.datum,dest.datum,point);if(dest.from_greenwich){point.x-=dest.from_greenwich;} +if(dest.projName=="longlat"){point.x*=Proj4js.common.R2D;point.y*=Proj4js.common.R2D;}else{dest.forward(point);if(dest.to_meter){point.x/=dest.to_meter;point.y/=dest.to_meter;}} +return point;},datum_transform:function(source,dest,point){if(source.compare_datums(dest)){return point;} +if(source.datum_type==Proj4js.common.PJD_NODATUM||dest.datum_type==Proj4js.common.PJD_NODATUM){return point;} +if(source.datum_type==Proj4js.common.PJD_GRIDSHIFT) +{alert("ERROR: Grid shift transformations are not implemented yet.");} +if(dest.datum_type==Proj4js.common.PJD_GRIDSHIFT) +{alert("ERROR: Grid shift transformations are not implemented yet.");} +if(source.es!=dest.es||source.a!=dest.a||source.datum_type==Proj4js.common.PJD_3PARAM||source.datum_type==Proj4js.common.PJD_7PARAM||dest.datum_type==Proj4js.common.PJD_3PARAM||dest.datum_type==Proj4js.common.PJD_7PARAM) +{source.geodetic_to_geocentric(point);if(source.datum_type==Proj4js.common.PJD_3PARAM||source.datum_type==Proj4js.common.PJD_7PARAM){source.geocentric_to_wgs84(point);} +if(dest.datum_type==Proj4js.common.PJD_3PARAM||dest.datum_type==Proj4js.common.PJD_7PARAM){dest.geocentric_from_wgs84(point);} +dest.geocentric_to_geodetic(point);} +if(dest.datum_type==Proj4js.common.PJD_GRIDSHIFT) +{alert("ERROR: Grid shift transformations are not implemented yet.");} +return point;},reportError:function(msg){},extend:function(destination,source){destination=destination||{};if(source){for(var property in source){var value=source[property];if(value!==undefined){destination[property]=value;}}} +return destination;},Class:function(){var Class=function(){this.initialize.apply(this,arguments);};var extended={};var parent;for(var i=0;i-1)&&(index+scriptNameLen==src.length)){this.libPath=src.slice(0,-scriptNameLen);break;}}} +return this.libPath||"";}, + loadScript:function(url,onload,onfail,loadCheck){ + var script = []; + var script = ZOORequest('GET',url); + try { + eval(script); + onload(); + } catch (e) { + onfail(); + } + /* + var script=document.createElement('script'); + script.defer=false; + script.type="text/javascript"; + script.id=url; + script.src=url; + script.onload=onload; + script.onerror=onfail; + script.loadCheck=loadCheck; + if(/MSIE/.test(navigator.userAgent)){script.onreadystatechange=this.checkReadyState;} + document.getElementsByTagName('head')[0].appendChild(script); + */ + }, + checkReadyState:function(){if(this.readyState=='loaded'){if(!this.loadCheck()){this.onerror();}else{this.onload();}}}};Proj4js.Proj=Proj4js.Class({readyToUse:false,title:null,projName:null,units:null,datum:null,x0:0,y0:0,initialize:function(srsCode){this.srsCodeInput=srsCode;if(srsCode.indexOf('urn:')==0){var urn=srsCode.split(':');if((urn[1]=='ogc'||urn[1]=='x-ogc')&&(urn[2]=='def')&&(urn[3]=='crs')){srsCode=urn[4]+':'+urn[urn.length-1];}}else if(srsCode.indexOf('http://')==0){var url=srsCode.split('#');if(url[0].match(/epsg.org/)){srsCode='EPSG:'+url[1];}else if(url[0].match(/RIG.xml/)){srsCode='IGNF:'+url[1];}} +this.srsCode=srsCode.toUpperCase();if(this.srsCode.indexOf("EPSG")==0){this.srsCode=this.srsCode;this.srsAuth='epsg';this.srsProjNumber=this.srsCode.substring(5);}else if(this.srsCode.indexOf("IGNF")==0){this.srsCode=this.srsCode;this.srsAuth='IGNF';this.srsProjNumber=this.srsCode.substring(5);}else if(this.srsCode.indexOf("CRS")==0){this.srsCode=this.srsCode;this.srsAuth='CRS';this.srsProjNumber=this.srsCode.substring(4);}else{this.srsAuth='';this.srsProjNumber=this.srsCode;} +this.loadProjDefinition();}, + loadProjDefinition:function(){ + if(Proj4js.defs[this.srsCode]){this.defsLoaded();return;} + this.loadFromService(); + /* + var url=Proj4js.getScriptLocation()+'defs/'+this.srsAuth.toUpperCase()+this.srsProjNumber+'.js'; + Proj4js.loadScript(url,Proj4js.bind(this.defsLoaded,this),Proj4js.bind(this.loadFromService,this),Proj4js.bind(this.checkDefsLoaded,this)); + */ + }, + loadFromService:function(){var url=Proj4js.defsLookupService+'/'+this.srsAuth+'/'+this.srsProjNumber+'/proj4js/';Proj4js.loadScript(url,Proj4js.bind(this.defsLoaded,this),Proj4js.bind(this.defsFailed,this),Proj4js.bind(this.checkDefsLoaded,this));},defsLoaded:function(){this.parseDefs();this.loadProjCode(this.projName);},checkDefsLoaded:function(){if(Proj4js.defs[this.srsCode]){return true;}else{return false;}},defsFailed:function(){Proj4js.reportError('failed to load projection definition for: '+this.srsCode);Proj4js.defs[this.srsCode]=Proj4js.defs['WGS84'];this.defsLoaded();}, + loadProjCode:function(projName){ + if(Proj4js.Proj[projName]){this.initTransforms();return;} + var url=Proj4js.getScriptLocation()+'projCode/'+projName+'.js'; + Proj4js.loadScript(url,Proj4js.bind(this.loadProjCodeSuccess,this,projName),Proj4js.bind(this.loadProjCodeFailure,this,projName),Proj4js.bind(this.checkCodeLoaded,this,projName)); + }, + loadProjCodeSuccess:function(projName){if(Proj4js.Proj[projName].dependsOn){this.loadProjCode(Proj4js.Proj[projName].dependsOn);}else{this.initTransforms();}},loadProjCodeFailure:function(projName){Proj4js.reportError("failed to find projection file for: "+projName);},checkCodeLoaded:function(projName){if(Proj4js.Proj[projName]){return true;}else{return false;}},initTransforms:function(){Proj4js.extend(this,Proj4js.Proj[this.projName]);this.init();this.readyToUse=true;},parseDefs:function(){this.defData=Proj4js.defs[this.srsCode];var paramName,paramVal;if(!this.defData){return;} +var paramArray=this.defData.split("+");for(var prop=0;prop1.0e-7){con=eccent*sinphi;return((1.0-eccent*eccent)*(sinphi/(1.0-con*con)-(.5/eccent)*Math.log((1.0-con)/(1.0+con))));}else{return(2.0*sinphi);}},asinz:function(x){if(Math.abs(x)>1.0){x=(x>1.0)?1.0:-1.0;} +return Math.asin(x);},e0fn:function(x){return(1.0-0.25*x*(1.0+x/16.0*(3.0+1.25*x)));},e1fn:function(x){return(0.375*x*(1.0+0.25*x*(1.0+0.46875*x)));},e2fn:function(x){return(0.05859375*x*x*(1.0+0.75*x));},e3fn:function(x){return(x*x*x*(35.0/3072.0));},mlfn:function(e0,e1,e2,e3,phi){return(e0*phi-e1*Math.sin(2.0*phi)+e2*Math.sin(4.0*phi)-e3*Math.sin(6.0*phi));},srat:function(esinp,exp){return(Math.pow((1.0-esinp)/(1.0+esinp),exp));},sign:function(x){if(x<0.0)return(-1);else return(1);},adjust_lon:function(x){x=(Math.abs(x)this.HALF_PI)return+Number.NaN;if(phi==this.HALF_PI)return Number.POSITIVE_INFINITY;if(phi==-1.0*this.HALF_PI)return-1.0*Number.POSITIVE_INFINITY;var con=eccent*sinphi;return Math.log(Math.tan((this.HALF_PI+phi)/2.0))+eccent*Math.log((1.0-con)/(1.0+con))/2.0;},fL:function(x,L){return 2.0*Math.atan(x*Math.exp(L))-this.HALF_PI;},invlatiso:function(eccent,ts){var phi=this.fL(1.0,ts);var Iphi=0.0;var con=0.0;do{Iphi=phi;con=eccent*Math.sin(Iphi);phi=this.fL(Math.exp(eccent*Math.log((1.0+con)/(1.0-con))/2.0),ts)}while(Math.abs(phi-Iphi)>1.0e-12);return phi;},sinh:function(x) +{var r=Math.exp(x);r=(r-1.0/r)/2.0;return r;},cosh:function(x) +{var r=Math.exp(x);r=(r+1.0/r)/2.0;return r;},tanh:function(x) +{var r=Math.exp(x);r=(r-1.0/r)/(r+1.0/r);return r;},asinh:function(x) +{var s=(x>=0?1.0:-1.0);return s*(Math.log(Math.abs(x)+Math.sqrt(x*x+1.0)));},acosh:function(x) +{return 2.0*Math.log(Math.sqrt((x+1.0)/2.0)+Math.sqrt((x-1.0)/2.0));},atanh:function(x) +{return Math.log((x-1.0)/(x+1.0))/2.0;},gN:function(a,e,sinphi) +{var temp=e*sinphi;return a/Math.sqrt(1.0-temp*temp);}};Proj4js.datum=Proj4js.Class({initialize:function(proj){this.datum_type=Proj4js.common.PJD_WGS84;if(proj.datumCode&&proj.datumCode=='none'){this.datum_type=Proj4js.common.PJD_NODATUM;} +if(proj&&proj.datum_params){for(var i=0;i3){if(proj.datum_params[3]!=0||proj.datum_params[4]!=0||proj.datum_params[5]!=0||proj.datum_params[6]!=0){this.datum_type=Proj4js.common.PJD_7PARAM;proj.datum_params[3]*=Proj4js.common.SEC_TO_RAD;proj.datum_params[4]*=Proj4js.common.SEC_TO_RAD;proj.datum_params[5]*=Proj4js.common.SEC_TO_RAD;proj.datum_params[6]=(proj.datum_params[6]/1000000.0)+1.0;}}} +if(proj){this.a=proj.a;this.b=proj.b;this.es=proj.es;this.ep2=proj.ep2;this.datum_params=proj.datum_params;}},compare_datums:function(dest){if(this.datum_type!=dest.datum_type){return false;}else if(this.a!=dest.a||Math.abs(this.es-dest.es)>0.000000000050){return false;}else if(this.datum_type==Proj4js.common.PJD_3PARAM){return(this.datum_params[0]==dest.datum_params[0]&&this.datum_params[1]==dest.datum_params[1]&&this.datum_params[2]==dest.datum_params[2]);}else if(this.datum_type==Proj4js.common.PJD_7PARAM){return(this.datum_params[0]==dest.datum_params[0]&&this.datum_params[1]==dest.datum_params[1]&&this.datum_params[2]==dest.datum_params[2]&&this.datum_params[3]==dest.datum_params[3]&&this.datum_params[4]==dest.datum_params[4]&&this.datum_params[5]==dest.datum_params[5]&&this.datum_params[6]==dest.datum_params[6]);}else if(this.datum_type==Proj4js.common.PJD_GRIDSHIFT){return strcmp(pj_param(this.params,"snadgrids").s,pj_param(dest.params,"snadgrids").s)==0;}else{return true;}},geodetic_to_geocentric:function(p){var Longitude=p.x;var Latitude=p.y;var Height=p.z?p.z:0;var X;var Y;var Z;var Error_Code=0;var Rn;var Sin_Lat;var Sin2_Lat;var Cos_Lat;if(Latitude<-Proj4js.common.HALF_PI&&Latitude>-1.001*Proj4js.common.HALF_PI){Latitude=-Proj4js.common.HALF_PI;}else if(Latitude>Proj4js.common.HALF_PI&&Latitude<1.001*Proj4js.common.HALF_PI){Latitude=Proj4js.common.HALF_PI;}else if((Latitude<-Proj4js.common.HALF_PI)||(Latitude>Proj4js.common.HALF_PI)){Proj4js.reportError('geocent:lat out of range:'+Latitude);return null;} +if(Longitude>Proj4js.common.PI)Longitude-=(2*Proj4js.common.PI);Sin_Lat=Math.sin(Latitude);Cos_Lat=Math.cos(Latitude);Sin2_Lat=Sin_Lat*Sin_Lat;Rn=this.a/(Math.sqrt(1.0e0-this.es*Sin2_Lat));X=(Rn+Height)*Cos_Lat*Math.cos(Longitude);Y=(Rn+Height)*Cos_Lat*Math.sin(Longitude);Z=((Rn*(1-this.es))+Height)*Sin_Lat;p.x=X;p.y=Y;p.z=Z;return Error_Code;},geocentric_to_geodetic:function(p){var genau=1.E-12;var genau2=(genau*genau);var maxiter=30;var P;var RR;var CT;var ST;var RX;var RK;var RN;var CPHI0;var SPHI0;var CPHI;var SPHI;var SDPHI;var At_Pole;var iter;var X=p.x;var Y=p.y;var Z=p.z?p.z:0.0;var Longitude;var Latitude;var Height;At_Pole=false;P=Math.sqrt(X*X+Y*Y);RR=Math.sqrt(X*X+Y*Y+Z*Z);if(P/this.agenau2&&iter0) +{Longitude=Proj4js.common.HALF_PI;} +else if(Y<0) +{Longitude=-Proj4js.common.HALF_PI;} +else +{At_Pole=true;Longitude=0.0;if(Z>0.0) +{Latitude=Proj4js.common.HALF_PI;} +else if(Z<0.0) +{Latitude=-Proj4js.common.HALF_PI;} +else +{Latitude=Proj4js.common.HALF_PI;Height=-this.b;return;}}} +W2=X*X+Y*Y;W=Math.sqrt(W2);T0=Z*Proj4js.common.AD_C;S0=Math.sqrt(T0*T0+W2);Sin_B0=T0/S0;Cos_B0=W/S0;Sin3_B0=Sin_B0*Sin_B0*Sin_B0;T1=Z+this.b*this.ep2*Sin3_B0;Sum=W-this.a*this.es*Cos_B0*Cos_B0*Cos_B0;S1=Math.sqrt(T1*T1+Sum*Sum);Sin_p1=T1/S1;Cos_p1=Sum/S1;Rn=this.a/Math.sqrt(1.0-this.es*Sin_p1*Sin_p1);if(Cos_p1>=Proj4js.common.COS_67P5) +{Height=W/Cos_p1-Rn;} +else if(Cos_p1<=-Proj4js.common.COS_67P5) +{Height=W/-Cos_p1-Rn;} +else +{Height=Z/Sin_p1+Rn*(this.es-1.0);} +if(At_Pole==false) +{Latitude=Math.atan(Sin_p1/Cos_p1);} +p.x=Longitude;p.y=Latitude;p.z=Height;return p;},geocentric_to_wgs84:function(p){if(this.datum_type==Proj4js.common.PJD_3PARAM) +{p.x+=this.datum_params[0];p.y+=this.datum_params[1];p.z+=this.datum_params[2];} +else if(this.datum_type==Proj4js.common.PJD_7PARAM) +{var Dx_BF=this.datum_params[0];var Dy_BF=this.datum_params[1];var Dz_BF=this.datum_params[2];var Rx_BF=this.datum_params[3];var Ry_BF=this.datum_params[4];var Rz_BF=this.datum_params[5];var M_BF=this.datum_params[6];var x_out=M_BF*(p.x-Rz_BF*p.y+Ry_BF*p.z)+Dx_BF;var y_out=M_BF*(Rz_BF*p.x+p.y-Rx_BF*p.z)+Dy_BF;var z_out=M_BF*(-Ry_BF*p.x+Rx_BF*p.y+p.z)+Dz_BF;p.x=x_out;p.y=y_out;p.z=z_out;}},geocentric_from_wgs84:function(p){if(this.datum_type==Proj4js.common.PJD_3PARAM) +{p.x-=this.datum_params[0];p.y-=this.datum_params[1];p.z-=this.datum_params[2];} +else if(this.datum_type==Proj4js.common.PJD_7PARAM) +{var Dx_BF=this.datum_params[0];var Dy_BF=this.datum_params[1];var Dz_BF=this.datum_params[2];var Rx_BF=this.datum_params[3];var Ry_BF=this.datum_params[4];var Rz_BF=this.datum_params[5];var M_BF=this.datum_params[6];var x_tmp=(p.x-Dx_BF)/M_BF;var y_tmp=(p.y-Dy_BF)/M_BF;var z_tmp=(p.z-Dz_BF)/M_BF;p.x=x_tmp+Rz_BF*y_tmp-Ry_BF*z_tmp;p.y=-Rz_BF*x_tmp+y_tmp+Rx_BF*z_tmp;p.z=Ry_BF*x_tmp-Rx_BF*y_tmp+z_tmp;}}});Proj4js.Point=Proj4js.Class({initialize:function(x,y,z){if(typeof x=='object'){this.x=x[0];this.y=x[1];this.z=x[2]||0.0;}else if(typeof x=='string'){var coords=x.split(',');this.x=parseFloat(coords[0]);this.y=parseFloat(coords[1]);this.z=parseFloat(coords[2])||0.0;}else{this.x=x;this.y=y;this.z=z||0.0;}},clone:function(){return new Proj4js.Point(this.x,this.y,this.z);},toString:function(){return("x="+this.x+",y="+this.y);},toShortString:function(){return(this.x+", "+this.y);}});Proj4js.PrimeMeridian={"greenwich":0.0,"lisbon":-9.131906111111,"paris":2.337229166667,"bogota":-74.080916666667,"madrid":-3.687938888889,"rome":12.452333333333,"bern":7.439583333333,"jakarta":106.807719444444,"ferro":-17.666666666667,"brussels":4.367975,"stockholm":18.058277777778,"athens":23.7163375,"oslo":10.722916666667};Proj4js.Ellipsoid={"MERIT":{a:6378137.0,rf:298.257,ellipseName:"MERIT 1983"},"SGS85":{a:6378136.0,rf:298.257,ellipseName:"Soviet Geodetic System 85"},"GRS80":{a:6378137.0,rf:298.257222101,ellipseName:"GRS 1980(IUGG, 1980)"},"IAU76":{a:6378140.0,rf:298.257,ellipseName:"IAU 1976"},"airy":{a:6377563.396,b:6356256.910,ellipseName:"Airy 1830"},"APL4.":{a:6378137,rf:298.25,ellipseName:"Appl. Physics. 1965"},"NWL9D":{a:6378145.0,rf:298.25,ellipseName:"Naval Weapons Lab., 1965"},"mod_airy":{a:6377340.189,b:6356034.446,ellipseName:"Modified Airy"},"andrae":{a:6377104.43,rf:300.0,ellipseName:"Andrae 1876 (Den., Iclnd.)"},"aust_SA":{a:6378160.0,rf:298.25,ellipseName:"Australian Natl & S. Amer. 1969"},"GRS67":{a:6378160.0,rf:298.2471674270,ellipseName:"GRS 67(IUGG 1967)"},"bessel":{a:6377397.155,rf:299.1528128,ellipseName:"Bessel 1841"},"bess_nam":{a:6377483.865,rf:299.1528128,ellipseName:"Bessel 1841 (Namibia)"},"clrk66":{a:6378206.4,b:6356583.8,ellipseName:"Clarke 1866"},"clrk80":{a:6378249.145,rf:293.4663,ellipseName:"Clarke 1880 mod."},"CPM":{a:6375738.7,rf:334.29,ellipseName:"Comm. des Poids et Mesures 1799"},"delmbr":{a:6376428.0,rf:311.5,ellipseName:"Delambre 1810 (Belgium)"},"engelis":{a:6378136.05,rf:298.2566,ellipseName:"Engelis 1985"},"evrst30":{a:6377276.345,rf:300.8017,ellipseName:"Everest 1830"},"evrst48":{a:6377304.063,rf:300.8017,ellipseName:"Everest 1948"},"evrst56":{a:6377301.243,rf:300.8017,ellipseName:"Everest 1956"},"evrst69":{a:6377295.664,rf:300.8017,ellipseName:"Everest 1969"},"evrstSS":{a:6377298.556,rf:300.8017,ellipseName:"Everest (Sabah & Sarawak)"},"fschr60":{a:6378166.0,rf:298.3,ellipseName:"Fischer (Mercury Datum) 1960"},"fschr60m":{a:6378155.0,rf:298.3,ellipseName:"Fischer 1960"},"fschr68":{a:6378150.0,rf:298.3,ellipseName:"Fischer 1968"},"helmert":{a:6378200.0,rf:298.3,ellipseName:"Helmert 1906"},"hough":{a:6378270.0,rf:297.0,ellipseName:"Hough"},"intl":{a:6378388.0,rf:297.0,ellipseName:"International 1909 (Hayford)"},"kaula":{a:6378163.0,rf:298.24,ellipseName:"Kaula 1961"},"lerch":{a:6378139.0,rf:298.257,ellipseName:"Lerch 1979"},"mprts":{a:6397300.0,rf:191.0,ellipseName:"Maupertius 1738"},"new_intl":{a:6378157.5,b:6356772.2,ellipseName:"New International 1967"},"plessis":{a:6376523.0,rf:6355863.0,ellipseName:"Plessis 1817 (France)"},"krass":{a:6378245.0,rf:298.3,ellipseName:"Krassovsky, 1942"},"SEasia":{a:6378155.0,b:6356773.3205,ellipseName:"Southeast Asia"},"walbeck":{a:6376896.0,b:6355834.8467,ellipseName:"Walbeck"},"WGS60":{a:6378165.0,rf:298.3,ellipseName:"WGS 60"},"WGS66":{a:6378145.0,rf:298.25,ellipseName:"WGS 66"},"WGS72":{a:6378135.0,rf:298.26,ellipseName:"WGS 72"},"WGS84":{a:6378137.0,rf:298.257223563,ellipseName:"WGS 84"},"sphere":{a:6370997.0,b:6370997.0,ellipseName:"Normal Sphere (r=6370997)"}};Proj4js.Datum={"WGS84":{towgs84:"0,0,0",ellipse:"WGS84",datumName:"WGS84"},"GGRS87":{towgs84:"-199.87,74.79,246.62",ellipse:"GRS80",datumName:"Greek_Geodetic_Reference_System_1987"},"NAD83":{towgs84:"0,0,0",ellipse:"GRS80",datumName:"North_American_Datum_1983"},"NAD27":{nadgrids:"@conus,@alaska,@ntv2_0.gsb,@ntv1_can.dat",ellipse:"clrk66",datumName:"North_American_Datum_1927"},"potsdam":{towgs84:"606.0,23.0,413.0",ellipse:"bessel",datumName:"Potsdam Rauenberg 1950 DHDN"},"carthage":{towgs84:"-263.0,6.0,431.0",ellipse:"clark80",datumName:"Carthage 1934 Tunisia"},"hermannskogel":{towgs84:"653.0,-212.0,449.0",ellipse:"bessel",datumName:"Hermannskogel"},"ire65":{towgs84:"482.530,-130.596,564.557,-1.042,-0.214,-0.631,8.15",ellipse:"mod_airy",datumName:"Ireland 1965"},"nzgd49":{towgs84:"59.47,-5.04,187.44,0.47,-0.1,1.024,-4.5993",ellipse:"intl",datumName:"New Zealand Geodetic Datum 1949"},"OSGB36":{towgs84:"446.448,-125.157,542.060,0.1502,0.2470,0.8421,-20.4894",ellipse:"airy",datumName:"Airy 1830"}};Proj4js.WGS84=new Proj4js.Proj('WGS84');Proj4js.Datum['OSB36']=Proj4js.Datum['OSGB36'];Proj4js.Proj.aea={init:function(){if(Math.abs(this.lat1+this.lat2)Proj4js.common.EPSLN){this.ns0=(this.ms1*this.ms1-this.ms2*this.ms2)/(this.qs2-this.qs1);}else{this.ns0=this.con;} +this.c=this.ms1*this.ms1+this.ns0*this.qs1;this.rh=this.a*Math.sqrt(this.c-this.ns0*this.qs0)/this.ns0;},forward:function(p){var lon=p.x;var lat=p.y;this.sin_phi=Math.sin(lat);this.cos_phi=Math.cos(lat);var qs=Proj4js.common.qsfnz(this.e3,this.sin_phi,this.cos_phi);var rh1=this.a*Math.sqrt(this.c-this.ns0*qs)/this.ns0;var theta=this.ns0*Proj4js.common.adjust_lon(lon-this.long0);var x=rh1*Math.sin(theta)+this.x0;var y=this.rh-rh1*Math.cos(theta)+this.y0;p.x=x;p.y=y;return p;},inverse:function(p){var rh1,qs,con,theta,lon,lat;p.x-=this.x0;p.y=this.rh-p.y+this.y0;if(this.ns0>=0){rh1=Math.sqrt(p.x*p.x+p.y*p.y);con=1.0;}else{rh1=-Math.sqrt(p.x*p.x+p.y*p.y);con=-1.0;} +theta=0.0;if(rh1!=0.0){theta=Math.atan2(con*p.x,con*p.y);} +con=rh1*this.ns0/this.a;qs=(this.c-con*con)/this.ns0;if(this.e3>=1e-10){con=1-.5*(1.0-this.es)*Math.log((1.0-this.e3)/(1.0+this.e3))/this.e3;if(Math.abs(Math.abs(con)-Math.abs(qs))>.0000000001){lat=this.phi1z(this.e3,qs);}else{if(qs>=0){lat=.5*PI;}else{lat=-.5*PI;}}}else{lat=this.phi1z(e3,qs);} +lon=Proj4js.common.adjust_lon(theta/this.ns0+this.long0);p.x=lon;p.y=lat;return p;},phi1z:function(eccent,qs){var con,com,dphi;var phi=Proj4js.common.asinz(.5*qs);if(eccentProj4js.common.HALF_PI){Proj4js.reportError("equi:Inv:DataError");} +var lon=Proj4js.common.adjust_lon(this.long0+p.x/(this.a*Math.cos(this.lat0)));p.x=lon;p.y=lat;}};Proj4js.Proj.merc={init:function(){if(this.lat_ts){if(this.sphere){this.k0=Math.cos(this.lat_ts);}else{this.k0=Proj4js.common.msfnz(this.es,Math.sin(this.lat_ts),Math.cos(this.lat_ts));}}},forward:function(p){var lon=p.x;var lat=p.y;if(lat*Proj4js.common.R2D>90.0&&lat*Proj4js.common.R2D<-90.0&&lon*Proj4js.common.R2D>180.0&&lon*Proj4js.common.R2D<-180.0){Proj4js.reportError("merc:forward: llInputOutOfRange: "+lon+" : "+lat);return null;} +var x,y;if(Math.abs(Math.abs(lat)-Proj4js.common.HALF_PI)<=Proj4js.common.EPSLN){Proj4js.reportError("merc:forward: ll2mAtPoles");return null;}else{if(this.sphere){x=this.x0+this.a*this.k0*Proj4js.common.adjust_lon(lon-this.long0);y=this.y0+this.a*this.k0*Math.log(Math.tan(Proj4js.common.FORTPI+0.5*lat));}else{var sinphi=Math.sin(lat);var ts=Proj4js.common.tsfnz(this.e,lat,sinphi);x=this.x0+this.a*this.k0*Proj4js.common.adjust_lon(lon-this.long0);y=this.y0-this.a*this.k0*Math.log(ts);} +p.x=x;p.y=y;return p;}},inverse:function(p){var x=p.x-this.x0;var y=p.y-this.y0;var lon,lat;if(this.sphere){lat=Proj4js.common.HALF_PI-2.0*Math.atan(Math.exp(-y/this.a*this.k0));}else{var ts=Math.exp(-y/(this.a*this.k0));lat=Proj4js.common.phi2z(this.e,ts);if(lat==-9999){Proj4js.reportError("merc:inverse: lat = -9999");return null;}} +lon=Proj4js.common.adjust_lon(this.long0+x/(this.a*this.k0));p.x=lon;p.y=lat;return p;}};Proj4js.Proj.utm={dependsOn:'tmerc',init:function(){if(!this.zone){Proj4js.reportError("utm:init: zone must be specified for UTM");return;} +this.lat0=0.0;this.long0=((6*Math.abs(this.zone))-183)*Proj4js.common.D2R;this.x0=500000.0;this.y0=this.utmSouth?10000000.0:0.0;this.k0=0.9996;Proj4js.Proj['tmerc'].init.apply(this);this.forward=Proj4js.Proj['tmerc'].forward;this.inverse=Proj4js.Proj['tmerc'].inverse;}};Proj4js.Proj.eqdc={init:function(){if(!this.mode)this.mode=0;this.temp=this.b/this.a;this.es=1.0-Math.pow(this.temp,2);this.e=Math.sqrt(this.es);this.e0=Proj4js.common.e0fn(this.es);this.e1=Proj4js.common.e1fn(this.es);this.e2=Proj4js.common.e2fn(this.es);this.e3=Proj4js.common.e3fn(this.es);this.sinphi=Math.sin(this.lat1);this.cosphi=Math.cos(this.lat1);this.ms1=Proj4js.common.msfnz(this.e,this.sinphi,this.cosphi);this.ml1=Proj4js.common.mlfn(this.e0,this.e1,this.e2,this.e3,this.lat1);if(this.mode!=0){if(Math.abs(this.lat1+this.lat2)=Proj4js.common.EPSLN){this.ns=(this.ms1-this.ms2)/(this.ml2-this.ml1);}else{this.ns=this.sinphi;}}else{this.ns=this.sinphi;} +this.g=this.ml1+this.ms1/this.ns;this.ml0=Proj4js.common.mlfn(this.e0,this.e1,this.e2,this.e3,this.lat0);this.rh=this.a*(this.g-this.ml0);},forward:function(p){var lon=p.x;var lat=p.y;var ml=Proj4js.common.mlfn(this.e0,this.e1,this.e2,this.e3,lat);var rh1=this.a*(this.g-ml);var theta=this.ns*Proj4js.common.adjust_lon(lon-this.long0);var x=this.x0+rh1*Math.sin(theta);var y=this.y0+this.rh-rh1*Math.cos(theta);p.x=x;p.y=y;return p;},inverse:function(p){p.x-=this.x0;p.y=this.rh-p.y+this.y0;var con,rh1;if(this.ns>=0){var rh1=Math.sqrt(p.x*p.x+p.y*p.y);var con=1.0;}else{rh1=-Math.sqrt(p.x*p.x+p.y*p.y);con=-1.0;} +var theta=0.0;if(rh1!=0.0)theta=Math.atan2(con*p.x,con*p.y);var ml=this.g-rh1/this.a;var lat=this.phi3z(this.ml,this.e0,this.e1,this.e2,this.e3);var lon=Proj4js.common.adjust_lon(this.long0+theta/this.ns);p.x=lon;p.y=lat;return p;},phi3z:function(ml,e0,e1,e2,e3){var phi;var dphi;phi=ml;for(var i=0;i<15;i++){dphi=(ml+e1*Math.sin(2.0*phi)-e2*Math.sin(4.0*phi)+e3*Math.sin(6.0*phi))/e0-phi;phi+=dphi;if(Math.abs(dphi)<=.0000000001){return phi;}} +Proj4js.reportError("PHI3Z-CONV:Latitude failed to converge after 15 iterations");return null;}};Proj4js.Proj.tmerc={init:function(){this.e0=Proj4js.common.e0fn(this.es);this.e1=Proj4js.common.e1fn(this.es);this.e2=Proj4js.common.e2fn(this.es);this.e3=Proj4js.common.e3fn(this.es);this.ml0=this.a*Proj4js.common.mlfn(this.e0,this.e1,this.e2,this.e3,this.lat0);},forward:function(p){var lon=p.x;var lat=p.y;var delta_lon=Proj4js.common.adjust_lon(lon-this.long0);var con;var x,y;var sin_phi=Math.sin(lat);var cos_phi=Math.cos(lat);if(this.sphere){var b=cos_phi*Math.sin(delta_lon);if((Math.abs(Math.abs(b)-1.0))<.0000000001){Proj4js.reportError("tmerc:forward: Point projects into infinity");return(93);}else{x=.5*this.a*this.k0*Math.log((1.0+b)/(1.0-b));con=Math.acos(cos_phi*Math.cos(delta_lon)/Math.sqrt(1.0-b*b));if(lat<0)con=-con;y=this.a*this.k0*(con-this.lat0);}}else{var al=cos_phi*delta_lon;var als=Math.pow(al,2);var c=this.ep2*Math.pow(cos_phi,2);var tq=Math.tan(lat);var t=Math.pow(tq,2);con=1.0-this.es*Math.pow(sin_phi,2);var n=this.a/Math.sqrt(con);var ml=this.a*Proj4js.common.mlfn(this.e0,this.e1,this.e2,this.e3,lat);x=this.k0*n*al*(1.0+als/6.0*(1.0-t+c+als/20.0*(5.0-18.0*t+Math.pow(t,2)+72.0*c-58.0*this.ep2)))+this.x0;y=this.k0*(ml-this.ml0+n*tq*(als*(0.5+als/24.0*(5.0-t+9.0*c+4.0*Math.pow(c,2)+als/30.0*(61.0-58.0*t+Math.pow(t,2)+600.0*c-330.0*this.ep2)))))+this.y0;} +p.x=x;p.y=y;return p;},inverse:function(p){var con,phi;var delta_phi;var i;var max_iter=6;var lat,lon;if(this.sphere){var f=Math.exp(p.x/(this.a*this.k0));var g=.5*(f-1/f);var temp=this.lat0+p.y/(this.a*this.k0);var h=Math.cos(temp);con=Math.sqrt((1.0-h*h)/(1.0+g*g));lat=Proj4js.common.asinz(con);if(temp<0) +lat=-lat;if((g==0)&&(h==0)){lon=this.long0;}else{lon=Proj4js.common.adjust_lon(Math.atan2(g,h)+this.long0);}}else{var x=p.x-this.x0;var y=p.y-this.y0;con=(this.ml0+y/this.k0)/this.a;phi=con;for(i=0;true;i++){delta_phi=((con+this.e1*Math.sin(2.0*phi)-this.e2*Math.sin(4.0*phi)+this.e3*Math.sin(6.0*phi))/this.e0)-phi;phi+=delta_phi;if(Math.abs(delta_phi)<=Proj4js.common.EPSLN)break;if(i>=max_iter){Proj4js.reportError("tmerc:inverse: Latitude failed to converge");return(95);}} +if(Math.abs(phi)0)||(Math.abs(g)<=Proj4js.common.EPSLN)){var x=this.a*ksp*cosphi*Math.sin(dlon);var y=this.y0+this.a*ksp*(this.cos_p14*sinphi-this.sin_p14*cosphi*coslon);}else{Proj4js.reportError("orthoFwdPointError");} +p.x=x;p.y=y;return p;},inverse:function(p){var rh;var z;var sinz,cosz;var temp;var con;var lon,lat;p.x-=this.x0;p.y-=this.y0;rh=Math.sqrt(p.x*p.x+p.y*p.y);if(rh>this.a+.0000001){Proj4js.reportError("orthoInvDataError");} +z=Proj4js.common.asinz(rh/this.a);sinz=Math.sin(z);cosz=Math.cos(z);lon=this.long0;if(Math.abs(rh)<=Proj4js.common.EPSLN){lat=this.lat0;} +lat=Proj4js.common.asinz(cosz*this.sin_p14+(p.y*sinz*this.cos_p14)/rh);con=Math.abs(lat0)-Proj4js.common.HALF_PI;if(Math.abs(con)<=Proj4js.common.EPSLN){if(this.lat0>=0){lon=Proj4js.common.adjust_lon(this.long0+Math.atan2(p.x,-p.y));}else{lon=Proj4js.common.adjust_lon(this.long0-Math.atan2(-p.x,p.y));}} +con=cosz-this.sin_p14*Math.sin(lat);if((Math.abs(con)>=Proj4js.common.EPSLN)||(Math.abs(x)>=Proj4js.common.EPSLN)){lon=Proj4js.common.adjust_lon(this.long0+Math.atan2((p.x*sinz*this.cos_p14),(con*rh)));} +p.x=lon;p.y=lat;return p;}};Proj4js.Proj.somerc={init:function(){var phy0=this.lat0;this.lambda0=this.long0;var sinPhy0=Math.sin(phy0);var semiMajorAxis=this.a;var invF=this.rf;var flattening=1/invF;var e2=2*flattening-Math.pow(flattening,2);var e=this.e=Math.sqrt(e2);this.R=semiMajorAxis*Math.sqrt(1-e2)/(1-e2*Math.pow(sinPhy0,2.0));this.alpha=Math.sqrt(1+e2/(1-e2)*Math.pow(Math.cos(phy0),4.0));this.b0=Math.asin(sinPhy0/this.alpha);this.K=Math.log(Math.tan(Math.PI/4.0+this.b0/2.0)) +-this.alpha*Math.log(Math.tan(Math.PI/4.0+phy0/2.0)) ++this.alpha*e/2*Math.log((1+e*sinPhy0)/(1-e*sinPhy0));},forward:function(p){var Sa1=Math.log(Math.tan(Math.PI/4.0-p.y/2.0));var Sa2=this.e/2.0*Math.log((1+this.e*Math.sin(p.y))/(1-this.e*Math.sin(p.y)));var S=-this.alpha*(Sa1+Sa2)+this.K;var b=2.0*(Math.atan(Math.exp(S))-Math.PI/4.0);var I=this.alpha*(p.x-this.lambda0);var rotI=Math.atan(Math.sin(I)/(Math.sin(this.b0)*Math.tan(b)+ +Math.cos(this.b0)*Math.cos(I)));var rotB=Math.asin(Math.cos(this.b0)*Math.sin(b)- +Math.sin(this.b0)*Math.cos(b)*Math.cos(I));p.y=this.R/2.0*Math.log((1+Math.sin(rotB))/(1-Math.sin(rotB))) ++this.y0;p.x=this.R*rotI+this.x0;return p;},inverse:function(p){var Y=p.x-this.x0;var X=p.y-this.y0;var rotI=Y/this.R;var rotB=2*(Math.atan(Math.exp(X/this.R))-Math.PI/4.0);var b=Math.asin(Math.cos(this.b0)*Math.sin(rotB) ++Math.sin(this.b0)*Math.cos(rotB)*Math.cos(rotI));var I=Math.atan(Math.sin(rotI)/(Math.cos(this.b0)*Math.cos(rotI)-Math.sin(this.b0)*Math.tan(rotB)));var lambda=this.lambda0+I/this.alpha;var S=0.0;var phy=b;var prevPhy=-1000.0;var iteration=0;while(Math.abs(phy-prevPhy)>0.0000001) +{if(++iteration>20) +{Proj4js.reportError("omercFwdInfinity");return;} +S=1.0/this.alpha*(Math.log(Math.tan(Math.PI/4.0+b/2.0))-this.K) ++this.e*Math.log(Math.tan(Math.PI/4.0 ++Math.asin(this.e*Math.sin(phy))/2.0));prevPhy=phy;phy=2.0*Math.atan(Math.exp(S))-Math.PI/2.0;} +p.x=lambda;p.y=phy;return p;}};Proj4js.Proj.stere={ssfn_:function(phit,sinphi,eccen){sinphi*=eccen;return(Math.tan(.5*(Proj4js.common.HALF_PI+phit))*Math.pow((1.-sinphi)/(1.+sinphi),.5*eccen));},TOL:1.e-8,NITER:8,CONV:1.e-10,S_POLE:0,N_POLE:1,OBLIQ:2,EQUIT:3,init:function(){this.phits=this.lat_ts?this.lat_ts:Proj4js.common.HALF_PI;var t=Math.abs(this.lat0);if((Math.abs(t)-Proj4js.common.HALF_PI)Proj4js.common.EPSLN?this.OBLIQ:this.EQUIT;} +this.phits=Math.abs(this.phits);if(this.es){var X;switch(this.mode){case this.N_POLE:case this.S_POLE:if(Math.abs(this.phits-Proj4js.common.HALF_PI)=Proj4js.common.EPSLN?Math.cos(this.phits)/Math.tan(Proj4js.common.FORTPI-.5*this.phits):2.*this.k0;break;}}},forward:function(p){var lon=p.x;lon=Proj4js.common.adjust_lon(lon-this.long0);var lat=p.y;var x,y;if(this.sphere){var sinphi,cosphi,coslam,sinlam;sinphi=Math.sin(lat);cosphi=Math.cos(lat);coslam=Math.cos(lon);sinlam=Math.sin(lon);switch(this.mode){case this.EQUIT:y=1.+cosphi*coslam;if(y<=Proj4js.common.EPSLN){F_ERROR;} +y=this.akm1/y;x=y*cosphi*sinlam;y*=sinphi;break;case this.OBLIQ:y=1.+this.sinph0*sinphi+this.cosph0*cosphi*coslam;if(y<=Proj4js.common.EPSLN){F_ERROR;} +y=this.akm1/y;x=y*cosphi*sinlam;y*=this.cosph0*sinphi-this.sinph0*cosphi*coslam;break;case this.N_POLE:coslam=-coslam;lat=-lat;case this.S_POLE:if(Math.abs(lat-Proj4js.common.HALF_PI)0)||(Math.abs(g)<=Proj4js.common.EPSLN)){x=this.x0+this.a*ksp*cosphi*Math.sin(dlon)/g;y=this.y0+this.a*ksp*(this.cos_p14*sinphi-this.sin_p14*cosphi*coslon)/g;}else{Proj4js.reportError("orthoFwdPointError");x=this.x0+this.infinity_dist*cosphi*Math.sin(dlon);y=this.y0+this.infinity_dist*(this.cos_p14*sinphi-this.sin_p14*cosphi*coslon);} +p.x=x;p.y=y;return p;},inverse:function(p){var rh;var z;var sinc,cosc;var c;var lon,lat;p.x=(p.x-this.x0)/this.a;p.y=(p.y-this.y0)/this.a;p.x/=this.k0;p.y/=this.k0;if((rh=Math.sqrt(p.x*p.x+p.y*p.y))){c=Math.atan2(rh,this.rc);sinc=Math.sin(c);cosc=Math.cos(c);lat=Proj4js.common.asinz(cosc*this.sin_p14+(p.y*sinc*this.cos_p14)/rh);lon=Math.atan2(p.x*sinc,rh*this.cos_p14*cosc-p.y*this.sin_p14*sinc);lon=Proj4js.common.adjust_lon(this.long0+lon);}else{lat=this.phic0;lon=0.0;} +p.x=lon;p.y=lat;return p;}};Proj4js.Proj.sinu={init:function(){this.R=6370997.0;},forward:function(p){var x,y,delta_lon;var lon=p.x;var lat=p.y;delta_lon=Proj4js.common.adjust_lon(lon-this.long0);x=this.R*delta_lon*Math.cos(lat)+this.x0;y=this.R*lat+this.y0;p.x=x;p.y=y;return p;},inverse:function(p){var lat,temp,lon;p.x-=this.x0;p.y-=this.y0;lat=p.y/this.R;if(Math.abs(lat)>Proj4js.common.HALF_PI){Proj4js.reportError("sinu:Inv:DataError");} +temp=Math.abs(lat)-Proj4js.common.HALF_PI;if(Math.abs(temp)>Proj4js.common.EPSLN){temp=this.long0+p.x/(this.R*Math.cos(lat));lon=Proj4js.common.adjust_lon(temp);}else{lon=this.long0;} +p.x=lon;p.y=lat;return p;}};Proj4js.Proj.vandg={init:function(){this.R=6370997.0;},forward:function(p){var lon=p.x;var lat=p.y;var dlon=Proj4js.common.adjust_lon(lon-this.long0);var x,y;if(Math.abs(lat)<=Proj4js.common.EPSLN){x=this.x0+this.R*dlon;y=this.y0;} +var theta=Proj4js.common.asinz(2.0*Math.abs(lat/Proj4js.common.PI));if((Math.abs(dlon)<=Proj4js.common.EPSLN)||(Math.abs(Math.abs(lat)-Proj4js.common.HALF_PI)<=Proj4js.common.EPSLN)){x=this.x0;if(lat>=0){y=this.y0+Proj4js.common.PI*this.R*Math.tan(.5*theta);}else{y=this.y0+Proj4js.common.PI*this.R*-Math.tan(.5*theta);}} +var al=.5*Math.abs((Proj4js.common.PI/dlon)-(dlon/Proj4js.common.PI));var asq=al*al;var sinth=Math.sin(theta);var costh=Math.cos(theta);var g=costh/(sinth+costh-1.0);var gsq=g*g;var m=g*(2.0/sinth-1.0);var msq=m*m;var con=Proj4js.common.PI*this.R*(al*(g-msq)+Math.sqrt(asq*(g-msq)*(g-msq)-(msq+asq)*(gsq-msq)))/(msq+asq);if(dlon<0){con=-con;} +x=this.x0+con;con=Math.abs(con/(Proj4js.common.PI*this.R));if(lat>=0){y=this.y0+Proj4js.common.PI*this.R*Math.sqrt(1.0-con*con-2.0*al*con);}else{y=this.y0-Proj4js.common.PI*this.R*Math.sqrt(1.0-con*con-2.0*al*con);} +p.x=x;p.y=y;return p;},inverse:function(p){var dlon;var xx,yy,xys,c1,c2,c3;var al,asq;var a1;var m1;var con;var th1;var d;p.x-=this.x0;p.y-=this.y0;con=Proj4js.common.PI*this.R;xx=p.x/con;yy=p.y/con;xys=xx*xx+yy*yy;c1=-Math.abs(yy)*(1.0+xys);c2=c1-2.0*yy*yy+xx*xx;c3=-2.0*c1+1.0+2.0*yy*yy+xys*xys;d=yy*yy/c3+(2.0*c2*c2*c2/c3/c3/c3-9.0*c1*c2/c3/c3)/27.0;a1=(c1-c2*c2/3.0/c3)/c3;m1=2.0*Math.sqrt(-a1/3.0);con=((3.0*d)/a1)/m1;if(Math.abs(con)>1.0){if(con>=0.0){con=1.0;}else{con=-1.0;}} +th1=Math.acos(con)/3.0;if(p.y>=0){lat=(-m1*Math.cos(th1+Proj4js.common.PI/3.0)-c2/3.0/c3)*Proj4js.common.PI;}else{lat=-(-m1*Math.cos(th1+PI/3.0)-c2/3.0/c3)*Proj4js.common.PI;} +if(Math.abs(xx)0;--i){lat=2.0*Math.atan(num*Proj4js.common.srat(this.e*Math.sin(p.y),-0.5*this.e))-Proj4js.common.HALF_PI;if(Math.abs(lat-p.y)0.0){if(this.lat0>=0.0){this.f=this.d+Math.sqrt(this.d*this.d-1.0);}else{this.f=this.d-Math.sqrt(this.d*this.d-1.0);}}else{this.f=this.d;} +this.el=this.f*Math.pow(this.ts,this.bl);} +if(this.mode!=0){this.g=.5*(this.f-1.0/this.f);this.gama=Proj4js.common.asinz(Math.sin(this.alpha)/this.d);this.longc=this.longc-Proj4js.common.asinz(this.g*Math.tan(this.gama))/this.bl;this.con=Math.abs(this.lat0);if((this.con>Proj4js.common.EPSLN)&&(Math.abs(this.con-Proj4js.common.HALF_PI)>Proj4js.common.EPSLN)){this.singam=Math.sin(this.gama);this.cosgam=Math.cos(this.gama);this.sinaz=Math.sin(this.alpha);this.cosaz=Math.cos(this.alpha);if(this.lat0>=0){this.u=(this.al/this.bl)*Math.atan(Math.sqrt(this.d*this.d-1.0)/this.cosaz);}else{this.u=-(this.al/this.bl)*Math.atan(Math.sqrt(this.d*this.d-1.0)/this.cosaz);}}else{Proj4js.reportError("omerc:Init:DataError");}}else{this.sinphi=Math.sin(this.at1);this.ts1=Proj4js.common.tsfnz(this.e,this.lat1,this.sinphi);this.sinphi=Math.sin(this.lat2);this.ts2=Proj4js.common.tsfnz(this.e,this.lat2,this.sinphi);this.h=Math.pow(this.ts1,this.bl);this.l=Math.pow(this.ts2,this.bl);this.f=this.el/this.h;this.g=.5*(this.f-1.0/this.f);this.j=(this.el*this.el-this.l*this.h)/(this.el*this.el+this.l*this.h);this.p=(this.l-this.h)/(this.l+this.h);this.dlon=this.lon1-this.lon2;if(this.dlon<-Proj4js.common.PI)this.lon2=this.lon2-2.0*Proj4js.common.PI;if(this.dlon>Proj4js.common.PI)this.lon2=this.lon2+2.0*Proj4js.common.PI;this.dlon=this.lon1-this.lon2;this.longc=.5*(this.lon1+this.lon2)-Math.atan(this.j*Math.tan(.5*this.bl*this.dlon)/this.p)/this.bl;this.dlon=Proj4js.common.adjust_lon(this.lon1-this.longc);this.gama=Math.atan(Math.sin(this.bl*this.dlon)/this.g);this.alpha=Proj4js.common.asinz(this.d*Math.sin(this.gama));if(Math.abs(this.lat1-this.lat2)<=Proj4js.common.EPSLN){Proj4js.reportError("omercInitDataError");}else{this.con=Math.abs(this.lat1);} +if((this.con<=Proj4js.common.EPSLN)||(Math.abs(this.con-HALF_PI)<=Proj4js.common.EPSLN)){Proj4js.reportError("omercInitDataError");}else{if(Math.abs(Math.abs(this.lat0)-Proj4js.common.HALF_PI)<=Proj4js.common.EPSLN){Proj4js.reportError("omercInitDataError");}} +this.singam=Math.sin(this.gam);this.cosgam=Math.cos(this.gam);this.sinaz=Math.sin(this.alpha);this.cosaz=Math.cos(this.alpha);if(this.lat0>=0){this.u=(this.al/this.bl)*Math.atan(Math.sqrt(this.d*this.d-1.0)/this.cosaz);}else{this.u=-(this.al/this.bl)*Math.atan(Math.sqrt(this.d*this.d-1.0)/this.cosaz);}}},forward:function(p){var theta;var sin_phi,cos_phi;var b;var c,t,tq;var con,n,ml;var q,us,vl;var ul,vs;var s;var dlon;var ts1;var lon=p.x;var lat=p.y;sin_phi=Math.sin(lat);dlon=Proj4js.common.adjust_lon(lon-this.longc);vl=Math.sin(this.bl*dlon);if(Math.abs(Math.abs(lat)-Proj4js.common.HALF_PI)>Proj4js.common.EPSLN){ts1=Proj4js.common.tsfnz(this.e,lat,sin_phi);q=this.el/(Math.pow(ts1,this.bl));s=.5*(q-1.0/q);t=.5*(q+1.0/q);ul=(s*this.singam-vl*this.cosgam)/t;con=Math.cos(this.bl*dlon);if(Math.abs(con)<.0000001){us=this.al*this.bl*dlon;}else{us=this.al*Math.atan((s*this.cosgam+vl*this.singam)/con)/this.bl;if(con<0)us=us+Proj4js.common.PI*this.al/this.bl;}}else{if(lat>=0){ul=this.singam;}else{ul=-this.singam;} +us=this.al*lat/this.bl;} +if(Math.abs(Math.abs(ul)-1.0)<=Proj4js.common.EPSLN){Proj4js.reportError("omercFwdInfinity");} +vs=.5*this.al*Math.log((1.0-ul)/(1.0+ul))/this.bl;us=us-this.u;var x=this.x0+vs*this.cosaz+us*this.sinaz;var y=this.y0+us*this.cosaz-vs*this.sinaz;p.x=x;p.y=y;return p;},inverse:function(p){var delta_lon;var theta;var delta_theta;var sin_phi,cos_phi;var b;var c,t,tq;var con,n,ml;var vs,us,q,s,ts1;var vl,ul,bs;var dlon;var flag;p.x-=this.x0;p.y-=this.y0;flag=0;vs=p.x*this.cosaz-p.y*this.sinaz;us=p.y*this.cosaz+p.x*this.sinaz;us=us+this.u;q=Math.exp(-this.bl*vs/this.al);s=.5*(q-1.0/q);t=.5*(q+1.0/q);vl=Math.sin(this.bl*us/this.al);ul=(vl*this.cosgam+s*this.singam)/t;if(Math.abs(Math.abs(ul)-1.0)<=Proj4js.common.EPSLN) +{lon=this.longc;if(ul>=0.0){lat=Proj4js.common.HALF_PI;}else{lat=-Proj4js.common.HALF_PI;}}else{con=1.0/this.bl;ts1=Math.pow((this.el/Math.sqrt((1.0+ul)/(1.0-ul))),con);lat=Proj4js.common.phi2z(this.e,ts1);theta=this.longc-Math.atan2((s*this.cosgam-vl*this.singam),con)/this.bl;lon=Proj4js.common.adjust_lon(theta);} +p.x=lon;p.y=lat;return p;}};Proj4js.Proj.lcc={init:function(){if(!this.lat2){this.lat2=this.lat0;} +if(!this.k0)this.k0=1.0;if(Math.abs(this.lat1+this.lat2)Proj4js.common.EPSLN){this.ns=Math.log(ms1/ms2)/Math.log(ts1/ts2);}else{this.ns=sin1;} +this.f0=ms1/(this.ns*Math.pow(ts1,this.ns));this.rh=this.a*this.f0*Math.pow(ts0,this.ns);if(!this.title)this.title="Lambert Conformal Conic";},forward:function(p){var lon=p.x;var lat=p.y;if(lat<=90.0&&lat>=-90.0&&lon<=180.0&&lon>=-180.0){}else{Proj4js.reportError("lcc:forward: llInputOutOfRange: "+lon+" : "+lat);return null;} +var con=Math.abs(Math.abs(lat)-Proj4js.common.HALF_PI);var ts,rh1;if(con>Proj4js.common.EPSLN){ts=Proj4js.common.tsfnz(this.e,lat,Math.sin(lat));rh1=this.a*this.f0*Math.pow(ts,this.ns);}else{con=lat*this.ns;if(con<=0){Proj4js.reportError("lcc:forward: No Projection");return null;} +rh1=0;} +var theta=this.ns*Proj4js.common.adjust_lon(lon-this.long0);p.x=this.k0*(rh1*Math.sin(theta))+this.x0;p.y=this.k0*(this.rh-rh1*Math.cos(theta))+this.y0;return p;},inverse:function(p){var rh1,con,ts;var lat,lon;x=(p.x-this.x0)/this.k0;y=(this.rh-(p.y-this.y0)/this.k0);if(this.ns>0){rh1=Math.sqrt(x*x+y*y);con=1.0;}else{rh1=-Math.sqrt(x*x+y*y);con=-1.0;} +var theta=0.0;if(rh1!=0){theta=Math.atan2((con*x),(con*y));} +if((rh1!=0)||(this.ns>0.0)){con=1.0/this.ns;ts=Math.pow((rh1/(this.a*this.f0)),con);lat=Proj4js.common.phi2z(this.e,ts);if(lat==-9999)return null;}else{lat=-Proj4js.common.HALF_PI;} +lon=Proj4js.common.adjust_lon(theta/this.ns+this.long0);p.x=lon;p.y=lat;return p;}};Proj4js.Proj.laea={S_POLE:1,N_POLE:2,EQUIT:3,OBLIQ:4,init:function(){var t=Math.abs(this.lat0);if(Math.abs(t-Proj4js.common.HALF_PI)0){var sinphi;this.qp=Proj4js.common.qsfnz(this.e,1.0);this.mmf=.5/(1.-this.es);this.apa=this.authset(this.es);switch(this.mode){case this.N_POLE:case this.S_POLE:this.dd=1.;break;case this.EQUIT:this.rq=Math.sqrt(.5*this.qp);this.dd=1./this.rq;this.xmf=1.;this.ymf=.5*this.qp;break;case this.OBLIQ:this.rq=Math.sqrt(.5*this.qp);sinphi=Math.sin(this.lat0);this.sinb1=Proj4js.common.qsfnz(this.e,sinphi)/this.qp;this.cosb1=Math.sqrt(1.-this.sinb1*this.sinb1);this.dd=Math.cos(this.lat0)/(Math.sqrt(1.-this.es*sinphi*sinphi)*this.rq*this.cosb1);this.ymf=(this.xmf=this.rq)/this.dd;this.xmf*=this.dd;break;}}else{if(this.mode==this.OBLIQ){this.sinph0=Math.sin(this.lat0);this.cosph0=Math.cos(this.lat0);}}},forward:function(p){var x,y;var lam=p.x;var phi=p.y;lam=Proj4js.common.adjust_lon(lam-this.long0);if(this.sphere){var coslam,cosphi,sinphi;sinphi=Math.sin(phi);cosphi=Math.cos(phi);coslam=Math.cos(lam);switch(this.mode){case this.EQUIT:y=(this.mode==this.EQUIT)?1.+cosphi*coslam:1.+this.sinph0*sinphi+this.cosph0*cosphi*coslam;if(y<=Proj4js.common.EPSLN){Proj4js.reportError("laea:fwd:y less than eps");return null;} +y=Math.sqrt(2./y);x=y*cosphi*Math.sin(lam);y*=(this.mode==this.EQUIT)?sinphi:this.cosph0*sinphi-this.sinph0*cosphi*coslam;break;case this.N_POLE:coslam=-coslam;case this.S_POLE:if(Math.abs(phi+this.phi0)=0.){x=(b=Math.sqrt(q))*sinlam;y=coslam*((this.mode==this.S_POLE)?b:-b);}else{x=y=0.;} +break;}} +p.x=this.a*x+this.x0;p.y=this.a*y+this.y0;return p;},inverse:function(p){p.x-=this.x0;p.y-=this.y0;var x=p.x/this.a;var y=p.y/this.a;if(this.sphere){var cosz=0.0,rh,sinz=0.0;rh=Math.sqrt(x*x+y*y);var phi=rh*.5;if(phi>1.){Proj4js.reportError("laea:Inv:DataError");return null;} +phi=2.*Math.asin(phi);if(this.mode==this.OBLIQ||this.mode==this.EQUIT){sinz=Math.sin(phi);cosz=Math.cos(phi);} +switch(this.mode){case this.EQUIT:phi=(Math.abs(rh)<=Proj4js.common.EPSLN)?0.:Math.asin(y*sinz/rh);x*=sinz;y=cosz*rh;break;case this.OBLIQ:phi=(Math.abs(rh)<=Proj4js.common.EPSLN)?this.phi0:Math.asin(cosz*sinph0+y*sinz*cosph0/rh);x*=sinz*cosph0;y=(cosz-Math.sin(phi)*sinph0)*rh;break;case this.N_POLE:y=-y;phi=Proj4js.common.HALF_PI-phi;break;case this.S_POLE:phi-=Proj4js.common.HALF_PI;break;} +lam=(y==0.&&(this.mode==this.EQUIT||this.mode==this.OBLIQ))?0.:Math.atan2(x,y);}else{var cCe,sCe,q,rho,ab=0.0;switch(this.mode){case this.EQUIT:case this.OBLIQ:x/=this.dd;y*=this.dd;rho=Math.sqrt(x*x+y*y);if(rho(2.0*Proj4js.common.HALF_PI*this.a)){Proj4js.reportError("aeqdInvDataError");return;} +var z=rh/this.a;var sinz=Math.sin(z);var cosz=Math.cos(z);var lon=this.long0;var lat;if(Math.abs(rh)<=Proj4js.common.EPSLN){lat=this.lat0;}else{lat=Proj4js.common.asinz(cosz*this.sin_p12+(p.y*sinz*this.cos_p12)/rh);var con=Math.abs(this.lat0)-Proj4js.common.HALF_PI;if(Math.abs(con)<=Proj4js.common.EPSLN){if(lat0>=0.0){lon=Proj4js.common.adjust_lon(this.long0+Math.atan2(p.x,-p.y));}else{lon=Proj4js.common.adjust_lon(this.long0-Math.atan2(-p.x,p.y));}}else{con=cosz-this.sin_p12*Math.sin(lat);if((Math.abs(con)=50){Proj4js.reportError("moll:Fwd:IterationError");}} +theta/=2.0;if(Proj4js.common.PI/2-Math.abs(lat)0.999999999999)arg=0.999999999999;var theta=Math.asin(arg);var lon=Proj4js.common.adjust_lon(this.long0+(p.x/(0.900316316158*this.a*Math.cos(theta))));if(lon<(-Proj4js.common.PI))lon=-Proj4js.common.PI;if(lon>Proj4js.common.PI)lon=Proj4js.common.PI;arg=(2.0*theta+Math.sin(2.0*theta))/Proj4js.common.PI;if(Math.abs(arg)>1.0)arg=1.0;var lat=Math.asin(arg);p.x=lon;p.y=lat;return p;}}; Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/utils.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/utils.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/utils.js (revision 672) @@ -0,0 +1,74 @@ +define([ +], function() { + + + // parseUri 1.2.2 + // (c) Steven Levithan + // MIT License + + function parseUri (str) { + var o = parseUri.options, + m = o.parser[o.strictMode ? "strict" : "loose"].exec(str), + uri = {}, + i = 14; + + while (i--) uri[o.key[i]] = m[i] || ""; + + uri[o.q.name] = {}; + uri[o.key[12]].replace(o.q.parser, function ($0, $1, $2) { + if ($1) uri[o.q.name][$1] = $2; + }); + + return uri; + }; + + parseUri.options = { + strictMode: false, + key: ["source","protocol","authority","userInfo","user","password","host","port","relative","path","directory","file","query","anchor"], + q: { + name: "queryKey", + parser: /(?:^|&)([^&=]*)=?([^&]*)/g + }, + parser: { + strict: /^(?:([^:\/?#]+):)?(?:\/\/((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?))?((((?:[^?#\/]*\/)*)([^?#]*))(?:\?([^#]*))?(?:#(.*))?)/, + loose: /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)(((\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?([^?#\/]*))(?:\?([^#]*))?(?:#(.*))?)/ + } + }; + + + // + function xmlToString(data) { + //data.xml check for IE + var xmlstr = data.xml ? data.xml : (new XMLSerializer()).serializeToString(data); + return xmlstr; + } + + function equalsString(a, b) { + if (!a) { + return false; + } + + if (!b) { + return false; + } + + return jQuery.trim(a).localeCompare(jQuery.trim(b)) == 0; + } + + function encodeXML(str) { + return str.replace(/&/g, '&') + .replace(//g, '>') + .replace(/"/g, '"') + .replace(/'/g, '''); + }; + + return { + parseUri: parseUri, + xmlToString: xmlToString, + equalsString: equalsString, + encodeXML: encodeXML, + }; + + +}); Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/wps-payload.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/wps-payload.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/wps-payload.js (revision 672) @@ -0,0 +1,253 @@ +/** + * Author : Samuel Souk aloun + * + * Copyright (c) 2014 GeoLabs SARL + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +define([ + 'jquery', 'utils' +], function($, utils) { + + /** + * The wpsPayload module is using the + * [Hogan.js]{@link http://twitter.github.io/hogan.js/} templating engine to + * generate XML requests to be sent to a WPS Server. + * In the ZOO-Client API, the Hogan.js templates have to be compiled before + * you can use them from you application. Please refer to the ZOO-Client + * installation documentation for more informations. + * + * @module wpsPayload + * @requires payloads + * @requires jquery + * @requires utils + */ + + return { + + /** @exports wpsPayload */ + + /** + * The getPayload function uses the mustache + * templates and the parameters provided to generate a valid WPS XML + * request. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // GetCapabilities + * var request_params = { + * request: 'GetCapabilities', + * language: 'en-US' + * }; + * console.wpsPayload.getPayload(request_params)); + * @example + * // DescribeProcess with Identifier value set to "all". + * var request_params = { + * request: 'DescribeProcess', + * identifier: ["all"] + * }; + * console.log(wpsPayload.getPayload(request_params)); + * @example + * // + * var request_params = { + * request: 'Execute', + * Identifier: "Buffer", + * DataInputs: [{"identifier":"InputPolygon","href":"http://features.org/toto.xml","mimeType":"text/xml"}], + * DataOutputs: [{"identifier":"Result","mimeType":"application/json"}], + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload(request_params)); + */ + getPayload: function(params) { + if (params.request == 'DescribeProcess') { + return this.getPayload_DescribeProcess(params); + } else if (params.request == 'GetCapabilities') { + return this.getPayload_GetCapabilities(params); + } else if (params.request == 'Execute') { + return this.getPayload_Execute(params); + } else { + console.log("#### UNKNOWN REQUEST ####"); + } + }, + + /** + * The getPayload_GetCapabilities function is used to generate a valid + * WPS XML GetCapabilities request using the + * [payload_GetCapabilities.mustache]{@link http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache} + * template. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // log the XML request in console + * var request_params = { + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload_GetCapabilities(request_params)); + */ + getPayload_GetCapabilities: function(params) { + return templates["payload_GetCapabilities"].render(params); + }, + + /** + * The getPayload_DescribeProcess function is used to generate a valid + * WPS XML DescribeProcess request using the + * [payload_DescribeProcess.mustache]{@link http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-client/lib/tpl/payload_DescribeProcess.mustache} + * template. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // log the XML request in console + * var request_params = { + * Identifier: ["Buffer","Centroid"], + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload_DescribeProcess(request_params)); + */ + getPayload_DescribeProcess: function(params) { + if (params.Identifier) { + if ($.isArray(params.Identifier)) { + return templates["payload_DescribeProcess"].render({identifiers: params.Identifier,language: params.language}); + } + else { + return templates["payload_DescribeProcess"].render({identifiers: [params.Identifier],language: params.language}); + } + } + // TODO: no Identifier + }, + + /** + * The getPayload_Execute function is used to generate a valid WPS XML + * Excute request using the + * [payload_Execute.mustache]{@link http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache} + * template. + * + * @static + * @param {Object} params - The object representing the request. + * @returns {string} - The corresponding XML request + * @example + * // log the XML request in console + * var request_params = { + * Identifier: "Buffer", + * DataInputs: [{"identifier":"InputPolygon","href":"http://features.org/toto.xml","mimeType":"text/xml"}], + * DataOutputs: [{"identifier":"Result","mimeType":"application/json"}], + * language: 'en-US' + * }; + * console.log(wpsPayload.getPayload_Execute(request_params)); + */ + getPayload_Execute: function(params) { + if (params.DataInputs) { + for (var i = 0; i < params.DataInputs.length; i++) { + /** + * Define inputs type depending on presence of mimeType, + * dataType and crs or dimension for ComplexData, + * LiteralData and BoundingBox data respectively + */ + var hasType=false; + var lp={"data":"literal","mime":"complex"}; + for(j in lp){ + if (params.DataInputs[i][j+"Type"]) { + params.DataInputs[i]['is_'+lp[j]] = true; + params.DataInputs[i].type=lp[j]; + if(j=="mime"){ + params.DataInputs[i].is_XML=(params.DataInputs[i][j+"Type"]=="text/xml"); + if(!params.DataInputs[i].is_XML){ + var tmp=params.DataInputs[i][j+"Type"].split(";"); + params.DataInputs[i].is_XML=(tmp[0]=="text/xml"); + } + } + hasType=true; + } + } + if(!hasType){ + if (params.DataInputs[i]["type"]=="bbox" || + params.DataInputs[i]["dimension"] || + params.DataInputs[i]["crs"]){ + + params.DataInputs[i]['is_bbox'] = true; + params.DataInputs[i].type='bbox'; + hasType=true; + + } + if(!hasType){ + params.DataInputs[i]['is_literal'] = true; + params.DataInputs[i].type = "literal"; + } + } + /* + * Set some default values and flags. + */ + if (params.DataInputs[i].type == 'bbox') { + if (!params.DataInputs[i].crs) { + params.DataInputs[i].crs = "EPSG:4326"; + } + if (!params.DataInputs[i].dimension) { + params.DataInputs[i].dimension = 2; + } + } + + // Complex data from payload callback. + console.log("CALLBACK"); + console.log(params.DataInputs[i]); + if (params.DataInputs[i].complexPayload_callback) { + params.DataInputs[i].value = window[params.DataInputs[i].complexPayload_callback]; + console.log(params.DataInputs[i].value); + } + + // Complex data from reference. + if (params.DataInputs[i].href) { + params.DataInputs[i].is_reference = true; + //params.DataInputs[i].href = utils.encodeXML(params.DataInputs[i].href); + if (params.DataInputs[i].method == 'POST') { + params.DataInputs[i].is_post = true; + } else { + params.DataInputs[i].is_get = true; + } + } + else { + // Complex data, embeded + } + } // for i loop + } + + //console.log("==== OUTPUTS ===="); + if (params.DataOutputs || params.storeExecuteResponse || params.status || params.lineage) { + + for (var i = 0; i < params.DataOutputs.length; i++) { + //console.log(params.DataOutputs[i]); + + if (params.DataOutputs[i].type) { + params.DataOutputs[i]['is_'+params.DataOutputs[i].type] = true; + } + } + } + + return templates["payload_Execute"].render(params); + }, + + + }; + +}); Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/zoo.js =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/zoo.js (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/js/wps-client/zoo.js (revision 672) @@ -0,0 +1,798 @@ +/** + * Author : Samuel Souk aloun + * + * Copyright (c) 2014 GeoLabs SARL + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +define([ + 'xml2json', 'queryString', 'wpsPayload', 'utils' +], function(X2JS, qs, wpsPayload, utils) { + + /** + * The ZooProcess Class + * @constructs ZooProcess + * @param {Object} params Parameters + * @example + * var myZooObject = new ZooProcess({ + * url: "http://localhost/cgi-bin/zoo_loader.cgi", + * delay: 2500 + * }); + */ + var ZooProcess = function(params) { + + /** + * Object configuring the xml2json use. + * + * @access private + * @memberof ZooProcess# + * @var _x2js {x2js} + */ + var _x2js = new X2JS({ + arrayAccessFormPaths: [ + 'ProcessDescriptions.ProcessDescription.DataInputs.Input', + 'ProcessDescriptions.ProcessDescription.DataInputs.Input.ComplexData.Supported.Format', + 'ProcessDescriptions.ProcessDescription.ProcessOutputs.Output', + 'ProcessDescriptions.ProcessDescription.ProcessOutputs.Output.ComplexOutput.Supported.Format', + 'Capabilities.ServiceIdentification.Keywords' + ], + }); + + + /** + * @access public + * @memberof ZooProcess# + * @var debug {Boolean} true if verbose messages should be displayed on the console + * @default false + */ + this.debug = false; + /** + * @access public + * @memberof ZooProcess# + * @var url {String} The WPS Server URL + */ + this.url = params.url; + /** + * @access public + * @memberof ZooProcess# + * @var language {String} The language to be used to request the WPS Server + * @default "en-US" + */ + this.language = params.language?params.language:"en-US"; + /** + * @access public + * @memberof ZooProcess# + * @var statusLocation {Object} An object to store the statusLocation + * URLs when running request including both the storeExecuteResponse and + * the status parameters set to true. + */ + this.statusLocation = {}; + /** + * @access public + * @memberof ZooProcess# + * @var launched {Object} An object to store the running asynchrone services. + */ + this.launched = {}; + /** + * @access public + * @memberof ZooProcess# + * @var terminated {Object} An object to store the finished services. + */ + this.terminated = {}; + /** + * @access public + * @memberof ZooProcess# + * @var percent {Object} An object to store the percentage of completude of services. + */ + this.percent = {}; + /** + * @access public + * @memberof ZooProcess# + * @var delay {Integer} The time (in milliseconds) between each polling requests. + * @default 2000 + */ + this.delay = params.delay || 2000; + + /** + * The getCapabilities method run the GetCapabilities request by calling {@link ZooProcess#request}. + * + * @method getCapabilities + * @memberof ZooProcess# + * @param {Object} params The parameter for the request and callback functions to call on success or + * on failure. + * @example + * // Log the array of available processes in console + * myZooObject.getCapabilities({ + * type: 'POST', + * success: function(data){ + * console.log(data["Capabilities"]["ProcessOfferings"]["Process"]); + * } + * }); + */ + this.getCapabilities = function(params) { + var closure = this; + + if (!params.hasOwnProperty('type')) { + params.type = 'GET'; + } + + var zoo_request_params = { + request: 'GetCapabilities', + service: 'WPS', + version: '1.0.0', + } + + this.request(zoo_request_params, params.success, params.error, params.type); + }; + + /** + * The describeProcess method run the DescribeProcess request by calling {@link ZooProcess#request}. + * + * @method describeProcess + * @memberof ZooProcess# + * @param {Object} params + * @example + * // Log x2js representation of all available services in console + * myZooObject.describeProcess({ + * type: 'POST', + * identifier: "all" + * success: function(data){ + * console.log(data); + * } + * }); + */ + this.describeProcess = function(params) { + var closure = this; + + if (!params.hasOwnProperty('type')) { + params.type = 'GET'; + } + + var zoo_request_params = { + Identifier: params.identifier, + request: 'DescribeProcess', + service: 'WPS', + version: '1.0.0', + } + + this.request(zoo_request_params, params.success, params.error, params.type); + }; + + /** + * The convertParams method convert parameters for Execute requests + * + * @method convertParams + * @memberof ZooProcess# + * @param {Object} params The original object + * @returns {Object} The converted object + */ + this.convertParams = function(params){ + var closure = this; + if(closure.debug){ + console.log("======== Execute "+params.identifier); + console.log(params); + } + + if (!params.hasOwnProperty('type')) { + params.type = 'GET'; + } + + var zoo_request_params = { + request: 'Execute', + service: 'WPS', + version: '1.0.0', + Identifier: params.identifier, + DataInputs: params.dataInputs ? params.dataInputs : '', + DataOutputs: params.dataOutputs ? params.dataOutputs : '', + } + + + if (params.hasOwnProperty('responseDocument')) { + zoo_request_params.ResponseDocument = params.responseDocument; + } + if (params.hasOwnProperty('storeExecuteResponse') && params.storeExecuteResponse) { + zoo_request_params.storeExecuteResponse = 'true'; + } + if (params.hasOwnProperty('status') && params.status) { + zoo_request_params.status = 'true'; + } + if (params.hasOwnProperty('lineage') && params.lineage) { + zoo_request_params.lineage = 'true'; + } + return zoo_request_params; + }; + + /** + * The buildRequest method is building the object expected by + * [jQuery.ajax]{@link http://api.jquery.com/jquery.ajax/}. + * In case of GET request, it will use {@link ZooProcess#getQueryString}. + * In case of POST request, it will use {@link module:wpsPayload} getPayload. + * + * @method buildRequest + * @memberof ZooProcess# + * @param {Object} params the request parameters + * @param {String} type the request method ("GET" or "POST") + * @returns {Object} The expected object to give as input for the + * [jQuery.ajax]{@link http://api.jquery.com/jquery.ajax/} function. + */ + this.buildRequest = function(params,type){ + var closure = this; + if(closure.debug){ + console.log('======== REQUEST method='+type); + console.log(params); + } + var url = this.url; + var payload; + var headers; + if(params.hasOwnProperty('DataOutputs')) + for(var i=0;i +{{#identifiers}} + {{.}} +{{/identifiers}} + Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/tpl/payload_Execute.mustache (revision 672) @@ -0,0 +1,84 @@ + + + {{Identifier}} + +{{#DataInputs}} +{{#is_literal}} + + {{identifier}} + + {{value}} + + +{{/is_literal}} +{{#is_bbox}} + + {{identifier}} + + + {{lowerCorner}} + {{upperCorner}} + + + +{{/is_bbox}} +{{#is_complex}} +{{#is_reference}} +{{#is_get}} + + {{identifier}} + + +{{/is_get}} +{{#is_post}} + + {{identifier}} + +{{#headers}} + +{{/headers}} + {{{value}}} + + +{{/is_post}} +{{/is_reference}} +{{^is_reference}} + + {{identifier}} + + {{#is_XML}} + {{{value}}}{{/is_XML}}{{^is_XML}}{{/is_XML}} + + + +{{/is_reference}} +{{/is_complex}} +{{/DataInputs}} + + +{{#RawDataOutput}} +{{#DataOutputs}} + + {{identifier}} + +{{/DataOutputs}} +{{/RawDataOutput}} +{{^RawDataOutput}} + +{{#DataOutputs}} +{{#is_literal}} + + {{identifier}} + +{{/is_literal}} +{{^is_literal}} + + {{identifier}} + +{{/is_literal}} +{{/DataOutputs}} + +{{/RawDataOutput}} + + Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-client/lib/tpl/payload_GetCapabilities.mustache (revision 672) @@ -0,0 +1,5 @@ + + + 1.0.0 + + Index: /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-kernel/Doxyfile =================================================================== --- /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-kernel/Doxyfile (revision 672) +++ /branches/PublicaMundi_David_integration_01-devel/zoo-project/zoo-kernel/Doxyfile (revision 672) @@ -0,0 +1,2303 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "ZOO-Project" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = y=C + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = YES + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.dox *.y *.c *.cxx *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /