From: Mike Taylor Date: Tue, 9 Jul 2013 16:13:06 +0000 (+0100) Subject: Merge branch 'master' of ssh://git.indexdata.com/home/git/private/mkws X-Git-Tag: 0.9.1~305 X-Git-Url: http://sru.miketaylor.org.uk/?a=commitdiff_plain;h=837b47e87c3656247fa16ba1dea58330cab31f01;hp=2f8a2bf4ab2f08b524957ebec715cae97b56e6dc;p=mkws-moved-to-github.git Merge branch 'master' of ssh://git.indexdata.com/home/git/private/mkws --- diff --git a/Makefile b/Makefile index 5944316..1be877d 100644 --- a/Makefile +++ b/Makefile @@ -1,2 +1,2 @@ **default**: - (cd experiments/spclient; $(MAKE)) + (cd tools/htdocs; $(MAKE)) diff --git a/etc/apache2/README b/etc/apache2/README deleted file mode 100644 index 351fc7f..0000000 --- a/etc/apache2/README +++ /dev/null @@ -1,5 +0,0 @@ -You will need to enable the Rewrite module for this to work: - -$ sudo a2enmod rewrite -$ sudo service apache2 reload - diff --git a/etc/apache2/spclient-dev b/etc/apache2/spclient-dev deleted file mode 100644 index b4a7e8a..0000000 --- a/etc/apache2/spclient-dev +++ /dev/null @@ -1,26 +0,0 @@ -# Configuration for the apache web server -*- apache -*- - -# pazpar2 / service proxy config - - ServerName spclient.example.com - ServerAlias spclient-dev.indexdata.com - ServerAdmin webmaster@example.com - ErrorLog /var/log/apache2/spdemo-error.log - CustomLog /var/log/apache2/spdemo-access.log combined - - RewriteEngine on - RewriteLogLevel 1 - RewriteLog /var/log/apache2/spdemo-rewrite.log - - DocumentRoot /home/indexdata/mkws/experiments/spclient - - RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] - - ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - - ProxyPass /pazpar2/ http://localhost:8004/pazpar2/ - ProxyPassReverse /pazpar2/ http://localhost:8004/pazpar2/ - - - diff --git a/etc/apache2/spclient-live b/etc/apache2/spclient-live deleted file mode 100644 index dfa7ed4..0000000 --- a/etc/apache2/spclient-live +++ /dev/null @@ -1,39 +0,0 @@ -# Configuration for the apache web server -# Running on caliban - - - - ServerName somesite.indexdata.com - DocumentRoot /home/indexdata/mkws/experiments/spclient/ - ErrorLog /var/log/apache2/somesite-error.log - CustomLog /var/log/apache2/somesite-access.log combined - - - - - ServerName mkws.indexdata.com - - ErrorLog /var/log/apache2/mkws-error.log - CustomLog /var/log/apache2/mkws-access.log combined - - DocumentRoot /home/indexdata/mkws/experiments/spclient/ - Alias /libjs-pz2/ /home/indexdata/libjs-pz2/ - Alias /index.html /home/indexdata/mkws/experiments/spclient/index-mkws.html - - RewriteEngine on - RewriteLogLevel 1 - RewriteLog /var/log/apache2/mkws-rewrite.log - RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=demo&password=demo [P] # [NE,P] - - Header set Access-Control-Allow-Credentials true - - # For MKC Service Proxy - ProxyPass /service-proxy/ http://mk2-test.indexdata.com/service-proxy/ - ProxyPassReverse /service-proxy/ http://mk2-test.indexdata.com/service-proxy/ - - PerlOptions +Parent - PerlSwitches -I/home/indexdata/mkws/etc/mod_perl - - PerlOutputFilterHandler MyApache2::SetACAO - - diff --git a/etc/apache2/spclient-mike b/etc/apache2/spclient-mike deleted file mode 100644 index 44efb2b..0000000 --- a/etc/apache2/spclient-mike +++ /dev/null @@ -1,29 +0,0 @@ -# Configuration for the apache web server -# Running on Mike's local development box - - - ServerName x.spclient.indexdata.com - ErrorLog /var/log/apache2/spclient-error.log - CustomLog /var/log/apache2/spclient-access.log combined - - DocumentRoot /usr/local/src/git/mkws/experiments/spclient/ - Alias /libjs-pz2/ /usr/local/src/git/libjs-pz2/ - - RewriteEngine on - RewriteLogLevel 1 - RewriteLog /var/log/apache2/spclient-rewrite.log - RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] - - # For MKC Service Proxy - ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - - # For local Service Proxy running as mvn jetty:run - #ProxyPass /service-proxy/ http://localhost:8585/service-proxy/ - #ProxyPassReverse /service-proxy/ http://localhost:8585/service-proxy/ - - # Needed on Mac, which locks Apache down hard by default. - - Allow from all - - diff --git a/etc/apache2/spclient-proxy b/etc/apache2/spclient-proxy deleted file mode 100644 index 4e16c51..0000000 --- a/etc/apache2/spclient-proxy +++ /dev/null @@ -1,19 +0,0 @@ - - ServerName mkws.indexdata.com - ServerAlias somesite.indexdata.com - - ProxyRequests off - ProxyVia On - ProxyPreserveHost On - - Order deny,allow - Allow from all - - - ProxyPass / http://caliban:80/ - ProxyPassReverse / http://caliban:80/ - - # These are the logs for the proxying operation - ErrorLog /var/log/apache2/mkws-proxy-error.log - CustomLog /var/log/apache2/mkws-proxy-access.log combined - diff --git a/etc/apache2/spdemo b/etc/apache2/spdemo deleted file mode 100644 index cc187be..0000000 --- a/etc/apache2/spdemo +++ /dev/null @@ -1,26 +0,0 @@ -# Configuration for the apache web server -*- apache -*- - -# pazpar2 / service proxy config - - ServerName spdemo.example.com - ServerAlias spdemo-dev.indexdata.com spdemo-devel.indexdata.com spdemo-sp.indexdata.com spdemo-pp2.indexdata.com - ServerAdmin webmaster@example.com - ErrorLog /var/log/apache2/spdemo-error.log - CustomLog /var/log/apache2/spdemo-access.log combined - - RewriteEngine on - RewriteLogLevel 1 - RewriteLog /var/log/apache2/spdemo-rewrite.log - - DocumentRoot /home/indexdata/mkws/experiments/spdemo - - RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] - - ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - - ProxyPass /pazpar2/ http://localhost:8004/pazpar2/ - ProxyPassReverse /pazpar2/ http://localhost:8004/pazpar2/ - - - diff --git a/etc/apache2/spdemo-mike b/etc/apache2/spdemo-mike deleted file mode 100644 index 3654479..0000000 --- a/etc/apache2/spdemo-mike +++ /dev/null @@ -1,26 +0,0 @@ -# Configuration for the apache web server -*- apache -*- -# Running on Mike's local development box -# This file is a variant of "spdemo" - -# pazpar2 / service proxy config - - ServerName x.spdemo-sp.indexdata.com - ErrorLog /var/log/apache2/spdemo-error.log - CustomLog /var/log/apache2/spdemo-access.log combined - - RewriteEngine on - RewriteLogLevel 1 - RewriteLog /var/log/apache2/spdemo-rewrite.log - - DocumentRoot /usr/local/src/git/mkws/experiments/spdemo/ - - RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] - - # For MKC Service Proxy - ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ - - # For local Service Proxy running as mvn jetty:run - #ProxyPass /service-proxy/ http://localhost:8585/service-proxy/ - #ProxyPassReverse /service-proxy/ http://localhost:8585/service-proxy/ - diff --git a/etc/apache2/spdemo-px b/etc/apache2/spdemo-px deleted file mode 100644 index 7f28300..0000000 --- a/etc/apache2/spdemo-px +++ /dev/null @@ -1,21 +0,0 @@ - - ServerName spdemo.indexdata.com - ServerAlias spdemo-dev.indexdata.com spdemo-devel.indexdata.com spdemo-sp.indexdata.com spdemo-pp2.indexdata.com spclient-dev.indexdata.com - - ErrorLog /var/log/apache2/spdemo-error.log - CustomLog /var/log/apache2/spdemo-access.log combined - - DefaultType text/html - - ProxyRequests off - ProxyPreserveHost On - - - Order deny,allow - Allow from all - - - ProxyPass / http://spdemo/ - ProxyPassReverse / http://spdemo/ - - diff --git a/etc/mod_perl/MyApache2/CopyCookie.pm b/etc/mod_perl/MyApache2/CopyCookie.pm deleted file mode 100644 index 3e29647..0000000 --- a/etc/mod_perl/MyApache2/CopyCookie.pm +++ /dev/null @@ -1,41 +0,0 @@ -package MyApache2::CopyCookie; - -use Apache2::Filter (); -use Apache2::RequestRec (); -use APR::Table (); - -use Apache2::Const -compile => qw(OK); - -use constant BUFF_LEN => 1024; - -sub handler { - my $f = shift; - - # If the server generated a new cookie, make it available in a - # header other than the magic "Cookie" that clients can't read. - my $ho = $f->r->headers_out; - my $cookie = $ho->get('Set-Cookie'); - if (defined $cookie && $cookie ne "") { - $ho->set('X-Set-Cake', $cookie); - } - - # If the client sent an existing cookie as X-Cake, but didn't - # set Cookie, copy the former to the latter. - my $hi = $f->r->headers_in; - $cookie = $hi->get('Cookie'); - if (!defined $cookie || $cookie eq "") { - $cookie = $hi->get('X-Cake'); - if (defined $cookie && $cookie ne "") { - warn "copying X-Cake '$cookie' to Cookie"; - $hi->set('Cookie', $cookie); - } - } - - while ($f->read(my $buffer, BUFF_LEN)) { - $f->print($buffer); - } - - return Apache2::Const::OK; -} - -1; diff --git a/etc/mod_perl/MyApache2/SetACAO.pm b/etc/mod_perl/MyApache2/SetACAO.pm deleted file mode 100644 index 66334fc..0000000 --- a/etc/mod_perl/MyApache2/SetACAO.pm +++ /dev/null @@ -1,30 +0,0 @@ -package MyApache2::SetACAO; - -use Apache2::Filter (); -use Apache2::RequestRec (); -use APR::Table (); - -use Apache2::Const -compile => qw(OK); - -use constant BUFF_LEN => 1024; - -sub handler { - my $f = shift; - - # If the client generated an Origin header, echo its content back - # in an ACAO header. This is better than just using *, since it - # doesnt prevent credentials from being accepted. - my $origin = $f->r->headers_in->get('Origin'); - if (defined $origin && $origin ne "") { - $f->r->headers_out->set('Access-Control-Allow-Origin', $origin); - warn "MyApache2::SetACAO copied Origin '$origin' to ACAO"; - } - - while ($f->read(my $buffer, BUFF_LEN)) { - $f->print($buffer); - } - - return Apache2::Const::OK; -} - -1; diff --git a/etc/service-proxy/mkws_confd b/etc/service-proxy/mkws_confd deleted file mode 100755 index 78ede88..0000000 --- a/etc/service-proxy/mkws_confd +++ /dev/null @@ -1 +0,0 @@ -CONFIG_DIR=mkws diff --git a/etc/service-proxy/service-proxy.properties b/etc/service-proxy/service-proxy.properties deleted file mode 100755 index d589de3..0000000 --- a/etc/service-proxy/service-proxy.properties +++ /dev/null @@ -1,107 +0,0 @@ -# Specify chains of plugins -chains.* = relay,statistics -chains.auth = authn -chains.categories = categories -chains.record = relay,holdings,recordcache,statistics -chains.show = relay,recordcache,statistics -chains.imageproxy = imageproxy -chains.exportrecords = exportrecords -chains.recordcache = recordcache -chains.clickout = statistics,clickout -chains.ils = ils - -# Map plug-in names to classes -plugins.relay = com.indexdata.serviceproxy.plugins.Pazpar2RelayPlugin -plugins.authn = com.indexdata.serviceproxy.plugins.AuthNTorusPlugin -plugins.ace = com.indexdata.serviceproxy.plugins.AcePlugin -plugins.holdings = com.indexdata.serviceproxy.plugins.HoldingsPlugin -plugins.categories = com.indexdata.serviceproxy.plugins.TargetCategoriesPlugin -plugins.imageproxy = com.indexdata.serviceproxy.plugins.ImageProxyPlugin -plugins.statistics = com.indexdata.serviceproxy.plugins.StatisticsPlugin -plugins.ace = com.indexdata.serviceproxy.plugins.AcePlugin -plugins.exportrecords = com.indexdata.serviceproxy.plugins.ExportRecordsPlugin -plugins.recordcache = com.indexdata.serviceproxy.plugins.recordcache.RecordCachePlugin -plugins.clickout = com.indexdata.serviceproxy.plugins.ClickOutPlugin -plugins.ils = com.indexdata.serviceproxy.plugins.ILSPlugin - - - -# Properties for plug-ins -# -# relay plugin -relay.PROXY_MODE = 3 -relay.PAZPAR2_URL = http://localhost:8004/search.pz2 -relay.PAZPAR2_SERVICE_ID = mk2demo -relay.TORUS_BASEURL = http://${thisHost}/torus2/ -relay.TORUS_REALM = * -relay.TORUS_PARAMS = ?param1=value1 -relay.STREAMBUFF_SIZE = 4096 -relay.PARSE_RESPONSES = true -relay.SERIALIZE_REQUESTS = false - -# authn plugin -authn.MASTER_TORUS_URL = http://${thisHost}/torus2/admin.admin/records/ -authn.TORUS_URL = http://${thisHost}/torus2/identity.USERS/records/ -authn.ACTION_SEQUENCE = check,cookie,referrer,ipauth -authn.REQUIRED_COOKIES = InstCode BrCode -authn.COOKIE_QUERY = shibId=${InstCode} -authn.AGGRESSIVE_SESSION_INVALIDATION = yes - -# categories plugin -categories.TORUS_BASEURL = http://${thisHost}/torus2/ -categories.EXCLUDE_EMPTY_CATEGORIES = true -categories.TORUS_BASEURL_SEARCHABLE = http://${thisHost}/torus2/ -categories.CACHE_CATEGORIES_ON_SESSION = true - -# ACE plugin -ace.PZ2P_CLIENT_LIFETIME_MSECS = 55000 -ace.TIME_BETWEEN_ACE_AND_RECORD_MSECS = 100 -ace.ACE_SEARCH_TIME_OUT = 5000 -ace.RECORD_TIME_OUT = 2500 -ace.DUMP_RECORDS_TO_CONSOLE = false -ace.PUSH!PZ2_ACE_CLIENT = record -ace.TYPE!PZ2_ACE_CLIENT = com.indexdata.serviceproxy.plugins.ace.Pz2AceRecordSession -ace.PULL!PZ2_ACE_CLIENT = record -ace.DUMP_BYTARGET_DOC = false -ace.PER_TARGET_HITS_THRESHOLD = 100 - -# Holdings plug-in -holdings.DUMP_RECORDS_TO_CONSOLE = true -holdings.RECORD_TIME_OUT = 2500 -#holdings.PULL!PZ2_ACE_CLIENT = record -holdings.PUSH!ACE_RESPONSE : record -holdings.TYPE!ACE_RESPONSE = org.w3c.dom.Document -holdings.DUMP_TARGET_SETTINGS_TO_CONSOLE = false -holdings.PAZPAR2_URL = REF:relay.PAZPAR2_URL - -# Image Proxy plug-in -imageproxy.OPEN_LIBRARY_IMAGE_URL = http://covers.openlibrary.org/b/isbn/${isbn}-${size}.jpg -imageproxy.CACHE_ON_SERVER = true -imageproxy.CACHE_IN_BROWSER = true -imageproxy.CACHE_MISSING_IMAGE = true - -# Statistics plug-in -statistics.MAX_BACKUP_INDEX = 5 -statistics.MAX_FILE_SIZE = 10000KB - -# Exporting Records -exportrecords.BRANDING = MasterKey -exportrecords.SMTP_HOST_NAME = kebab.indexdata.com -exportrecords.SMTP_PORT = 25 -exportrecords.SMTP_AUTH = false -exportrecords.EMAIL_SUBJECT = Export by email -exportrecords.EMAIL_FROM = info@indexdata.com -exportrecords.PERMALINK_PROTOCOL = http -exportrecords.PERMALINK_DOMAIN = ${thisHost} -exportrecords.PERMALINK_PATH = item.html -exportrecords.PERMALINK_REC_ID= prefixrecid=rec_${recid} -#exportrecords.PERMALINK_REC_QRY = au="${md-author}" and ti="${md-title}" - -# Record Cache Settings -recordcache.MAX_BASKET_SIZE = 50 -recordcache.MAX_VIEWED_SIZE = 10 - -# ClickOut plug-in (in order to generate click out statistics) -clickout.PARAMETER = No parameters required for this plug-in - -ils.CFWS_URL = http://connect.indexdata.com:9000/connector diff --git a/examples/apache2/mkws-examples b/examples/apache2/mkws-examples new file mode 100644 index 0000000..bb76cd1 --- /dev/null +++ b/examples/apache2/mkws-examples @@ -0,0 +1,6 @@ + + ServerName example.indexdata.com + DocumentRoot /home/indexdata/mkws/examples/htdocs/ + ErrorLog /var/log/apache2/mkws-examples-error.log + CustomLog /var/log/apache2/mkws-examples-access.log combined + diff --git a/examples/apache2/mkws-examples-proxy b/examples/apache2/mkws-examples-proxy new file mode 100644 index 0000000..7fb168b --- /dev/null +++ b/examples/apache2/mkws-examples-proxy @@ -0,0 +1,18 @@ + + ServerName example.indexdata.com + + ProxyRequests off + ProxyVia On + ProxyPreserveHost On + + Order deny,allow + Allow from all + + + ProxyPass / http://caliban:80/ + ProxyPassReverse / http://caliban:80/ + + # These are the logs for the proxying operation + ErrorLog /var/log/apache2/mkws-examples-proxy-error.log + CustomLog /var/log/apache2/mkws-examples-proxy-access.log combined + diff --git a/examples/htdocs/favicon.ico b/examples/htdocs/favicon.ico new file mode 100644 index 0000000..35c4899 Binary files /dev/null and b/examples/htdocs/favicon.ico differ diff --git a/examples/htdocs/index-full.html b/examples/htdocs/index-full.html new file mode 100644 index 0000000..f82d261 --- /dev/null +++ b/examples/htdocs/index-full.html @@ -0,0 +1,67 @@ + + + + + + + MKWS demo: full configuration + + + + + +
+
+
+
+
+
+

+ Welcome to the MasterKey Widget Set demo. +

+

+ Enter a search above to begin, or + Visit the MKWS home page to find out more. +

+
+ + + diff --git a/examples/htdocs/index-jquery.html b/examples/htdocs/index-jquery.html new file mode 100644 index 0000000..e2d3e19 --- /dev/null +++ b/examples/htdocs/index-jquery.html @@ -0,0 +1,11 @@ + + + + MKWS demo: jQuery plugin + + + + + + + diff --git a/examples/htdocs/index-lowlevel.html b/examples/htdocs/index-lowlevel.html new file mode 100644 index 0000000..f04060d --- /dev/null +++ b/examples/htdocs/index-lowlevel.html @@ -0,0 +1,55 @@ + + + + MKWS demo: low-level subcomponents + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + diff --git a/examples/htdocs/index-mike.html b/examples/htdocs/index-mike.html new file mode 100644 index 0000000..3e99c9c --- /dev/null +++ b/examples/htdocs/index-mike.html @@ -0,0 +1,29 @@ + + + + MKWS demo: Mike's playground + + + + + + +
+
+
+
+
+
+
+

+ Welcome to the MasterKey Widget Set demo. +

+

+ Enter a search above to begin, or + Visit the MKWS home page to find out more. +

+
+ + + diff --git a/examples/htdocs/index-mobile.html b/examples/htdocs/index-mobile.html new file mode 100644 index 0000000..02f4342 --- /dev/null +++ b/examples/htdocs/index-mobile.html @@ -0,0 +1,43 @@ + + + + + + + MKWS demo: mobile-screen resizing + + + + + + + +
+
+
+
+
+ +
+ + + + diff --git a/examples/htdocs/index-popup.html b/examples/htdocs/index-popup.html new file mode 100644 index 0000000..a5e3d0d --- /dev/null +++ b/examples/htdocs/index-popup.html @@ -0,0 +1,72 @@ + + + + MKWS demo: popup search box + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + + + + diff --git a/examples/htdocs/index.html b/examples/htdocs/index.html new file mode 100644 index 0000000..687aec5 --- /dev/null +++ b/examples/htdocs/index.html @@ -0,0 +1,16 @@ + + + + MKWS demo client + + + + +
+
+
+
+
+
+ + diff --git a/examples/htdocs/robots.txt b/examples/htdocs/robots.txt new file mode 100644 index 0000000..1f53798 --- /dev/null +++ b/examples/htdocs/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / diff --git a/experiments/spclient/.gitignore b/experiments/spclient/.gitignore deleted file mode 100644 index a7392c7..0000000 --- a/experiments/spclient/.gitignore +++ /dev/null @@ -1 +0,0 @@ -mkws-complete.js diff --git a/experiments/spclient/Makefile b/experiments/spclient/Makefile index 38d83f4..31a73d7 100644 --- a/experiments/spclient/Makefile +++ b/experiments/spclient/Makefile @@ -2,22 +2,23 @@ # Copyright (c) 2013 IndexData ApS. http://indexdata.com # -MKWS_JS= mkws-complete.js -all: ${MKWS_JS} +ALL= libjs-pz2 mkws.js mkwsStyle.css -mkws-js ${MKWS_JS}: ../../../libjs-pz2/pz2api.1.js mkws.js - ( echo "/* created at: $$(date)"; \ - echo " mkws.js GIT id: $$(git log mkws.js | head -n 1 | perl -npe 's,\S+\s+,,') */"; \ - curl -sSf http://code.jquery.com/jquery-1.10.0.min.js; \ - cat ../../../libjs-pz2/pz2api.1.js mkws.js ) > ${MKWS_JS}.new - mv -f ${MKWS_JS}.new ${MKWS_JS} +all: build -distclean: clean +mkwsStyle.css mkws.js: + ln -fs ../../tools/htdocs/$@ . + +libjs-pz2: + ln -fs ../../../$@ . + +build: ${ALL} + clean: - rm -f ${MKWS_JS} + rm -f ${ALL} help: - @echo "make [ help | mkws-js | clean ]" + @echo "make [ help | build | clean ]" @echo "" - @echo "Please check ./README file too!" + @echo "Please check ../../README file too!" diff --git a/experiments/spclient/README b/experiments/spclient/README deleted file mode 100644 index bcd492c..0000000 --- a/experiments/spclient/README +++ /dev/null @@ -1,128 +0,0 @@ -An embryonic MasterKey Widget Set -================================= - -This directory contains an embryonic MasterKey Widget Set, based -initially on "jsdemo" though now far removed from those beginnnings. - - -How this works --------------- - -The goal is to make it that as much of the searching functionality as -possible is hosted on - http://mkws.indexdata.com/ -so that very simple websites such as - http://somesite.indexdata.com/ -can have MasterKey searching with minimal effort. - -The following files must be hosted on mkws.indexdata.com: - mkws.js - mkwsStyle.css - /libjs-pz2/pz2api.1.js (*) - -The following files make up the application: - index.html - favicon.ico [optional] - robots.txt [optional] - -(At present, the client application's configuruation also needs an -Alias for /service-proxy/, to avoid cross-site scripting issues. We -will fix this.) - -(*) if you don't have already installed libjs-pz2 on the machine, you can -do it by installing a debian package or check it out from GIT: -$ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2 - -Configuring a client --------------------- - -The application's HTML must contains the following elements as well as -whatever makes up the application itself: - -Prerequisites: - - - - - -(Yes, we're using JQuery. We use it only in the most trivial ways, and -could probably get rid of it without too much pain. I'd like to have -mkws.js automatically pull in pz2api.1.js, too, so you don't need to -do so many things, but that's not quite trivial.) - -Then the following special
s can be added (with no content), and -will be filled in by MKWS: -
-- switch between record and target views -
-- switch between English, Danish and German -
-- search box and button -
-- result list, including pager/sorting -
-- target list, including status -
-- summary statistics - -At present, MKWS will not work correctly if any of these is -missing. One of the TODOs is to fix it so that it doesn't try to use -whatever is not there, and just uses what is. - - -You can configure and control the client with the JavaScript mkws_config object. - -Here is an example of all possible options - - -Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files. - -Supported Browsers ------------------- - -Any modern HTML5 browser will work fine. JavaScript must be enabled. - -* IE8 or later -* Firefox 17 or later -* Google Chrome 27 or later -* Safari 6 or later -* Opera 12 or later -* iOS 6.x (iPhone, iPad) -* Android 4.x - -Not supported: IE6, IE7 - -New Features since jsdemo --------------------------- -- multilinguality: English (default), Danish, German -- depends on the new pazpar2 JS library libjs-pz2/pz2api.1.js - which will make the development of pazpar2 plugins faster and - easier to share code between projects -- supports basic pazpar2 and service-proxy requests -- simplified HTML -- the search page is fully configurable by a JSON object - - -What next? ----------- - -Main areas of work: -* Make MKWS robust to missing widgets -* Clean up the code diff --git a/experiments/spclient/favicon.ico b/experiments/spclient/favicon.ico deleted file mode 100644 index 35c4899..0000000 Binary files a/experiments/spclient/favicon.ico and /dev/null differ diff --git a/experiments/spclient/html-structure.txt b/experiments/spclient/html-structure.txt deleted file mode 100644 index c6d0da8..0000000 --- a/experiments/spclient/html-structure.txt +++ /dev/null @@ -1,62 +0,0 @@ -The HTML structure of the MKWS
s is as follows. This is useful to -know when working on stylesheets. As in CSS, #ID indicates a unique -identifier and .CLASS indicates an instance of a class. - - -#mkwsSwitch - a* - -#mkwsLang - ( a | span )* - -#mkwsSearch - form - input#mkwsQuery type=text - input#mkwsButton type=submit - -#mkwsBlanket - (no contents -- used only for masking) - -#mkwsResults - table - tbody - tr - td - #mkwsTermlists - div.title - div.facet* - div.termtitle - ( a span br )* - td - div#mkwsRanking - form#mkwsSelect - select#mkwsSort - select#mkwsPerpage - #mkwsPager - #mkwsNavi - #mkwsRecords - div.record* - span (for sequence number) - a (for title) - span (for other information such as author) - div.details (sometimes) - table - tbody - tr* - th - td -#mkwsTargets - #mkwsBytarget - table - thead - tr* - td* - tbody - tr* - td* - -#mkwsStat - span.head - span.clients - span.records - diff --git a/experiments/spclient/index-full.html b/experiments/spclient/index-full.html deleted file mode 100644 index f82d261..0000000 --- a/experiments/spclient/index-full.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - MKWS demo: full configuration - - - - - -
-
-
-
-
-
-

- Welcome to the MasterKey Widget Set demo. -

-

- Enter a search above to begin, or - Visit the MKWS home page to find out more. -

-
- - - diff --git a/experiments/spclient/index-jquery.html b/experiments/spclient/index-jquery.html deleted file mode 100644 index e2d3e19..0000000 --- a/experiments/spclient/index-jquery.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - MKWS demo: jQuery plugin - - - - - - - diff --git a/experiments/spclient/index-lowlevel.html b/experiments/spclient/index-lowlevel.html deleted file mode 100644 index f04060d..0000000 --- a/experiments/spclient/index-lowlevel.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - MKWS demo: low-level subcomponents - - - - - - - - - - - - - - - - - - - -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - diff --git a/experiments/spclient/index-mike.html b/experiments/spclient/index-mike.html deleted file mode 100644 index 69cbc96..0000000 --- a/experiments/spclient/index-mike.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - MKWS demo: Mike's playground - - - - - - -
-
-
-
-
-
-
-

- Welcome to the MasterKey Widget Set demo. -

-

- Enter a search above to begin, or - Visit the MKWS home page to find out more. -

-
- - - diff --git a/experiments/spclient/index-mkws.html b/experiments/spclient/index-mkws.html deleted file mode 100644 index 570f42e..0000000 --- a/experiments/spclient/index-mkws.html +++ /dev/null @@ -1,135 +0,0 @@ - - - - MKWS: the MasterKey Widget Set - - - -

MKWS: the MasterKey Widget Set

-

- This site contains tools, not content: -

-
    -
  • - mkws.js - -- - JavaScript code that powers the MasterKey Widget Set -
  • -
  • - /libjs-pz2/pz2api.1.js - -- - Low-level JavaScript library for access to the MasterKey web - service. -
  • -
  • - mkws-complete.js - -- - A single large JavaScript file containing everything needed for - MKWS to work: the widget-set itself, the API library, and any - additional prerequisites such as jQuery. -
  • -
  • - mkwsStyle.css - -- - A stylesheet which styles only MasterKey widgets, and does not - otherwise interfere with application-site's styles. - -
  • -
-

- For examples of how to use the widget-set, see: -

- -

- The set of targets can be maintained: -

- -

- Documentation is as yet in short supply: -

- - - diff --git a/experiments/spclient/index-mobile.html b/experiments/spclient/index-mobile.html deleted file mode 100644 index decaf1c..0000000 --- a/experiments/spclient/index-mobile.html +++ /dev/null @@ -1,43 +0,0 @@ - - - - - - - MKWS demo: mobile-screen resizing - - - - - - - -
-
-
-
-
- -
- - - - diff --git a/experiments/spclient/index-popup.html b/experiments/spclient/index-popup.html deleted file mode 100644 index 01d3218..0000000 --- a/experiments/spclient/index-popup.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - MKWS demo: popup search box - - - - - - - - - - - - - - - - - -
- -
- -
- - - - - - diff --git a/experiments/spclient/index-wolfram.html b/experiments/spclient/index-wolfram.html new file mode 100644 index 0000000..bdde406 --- /dev/null +++ b/experiments/spclient/index-wolfram.html @@ -0,0 +1,84 @@ + + + + MKWS demo: Wolfram's playground + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ + diff --git a/experiments/spclient/index.html b/experiments/spclient/index.html deleted file mode 100644 index 687aec5..0000000 --- a/experiments/spclient/index.html +++ /dev/null @@ -1,16 +0,0 @@ - - - - MKWS demo client - - - - -
-
-
-
-
-
- - diff --git a/experiments/spclient/mkws.js b/experiments/spclient/mkws.js deleted file mode 100644 index 98ac5ee..0000000 --- a/experiments/spclient/mkws.js +++ /dev/null @@ -1,873 +0,0 @@ -/* A very simple client that shows a basic usage of the pz2.js -*/ - -"use strict"; // HTML5: disable for debug >= 2 - -/* - * global config object: mkws_config - * - * needs to be defined in the HTML header before - * including this JS file - */ - -if (!mkws_config) - var mkws_config = {}; // for the guys who forgot to define mkws_config... - -if (typeof mkws_config.use_service_proxy === 'undefined') - mkws_config.use_service_proxy = true; - -// global debug flag -var mkws_debug; - -var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2"; -var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/"; - -var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url; -var usesessions = mkws_config.use_service_proxy ? false : true; - - -var mkws_locale_lang = { - "de": { - "Authors": "Autoren", - "Subjects": "Schlagwörter", - "Sources": "Daten und Quellen", - "Termlists": "Termlisten", - "Next": "Weiter", - "Prev": "Zurück", - "Search": "Suche", - "Sort by": "Sortieren nach", - "and show": "und zeige", - "per page": "pro Seite", - "Displaying": "Zeige", - "to": "von", - "of": "aus", - "found": "gefunden", - "Title": "Titel", - "Author": "Autor", - "Date": "Datum", - "Subject": "Schlagwort", - "Location": "Ort", - - "dummy": "dummy" - }, - - "da": { - "Authors": "Forfattere", - "Subjects": "Emner", - "Sources": "Kilder", - "Termlists": "Termlists", - "Next": "Næste", - "Prev": "Forrige", - "Search": "Søg", - "Sort by": "Sorter efter", - "and show": "og vis", - "per page": "per side", - "Displaying": "Viser", - "to": "til", - "of": "ud af", - "found": "fandt", - "Title": "Title", - "Author": "Forfatter", - "Date": "Dato", - "Subject": "Emneord", - "Location": "Lokation", - - "dummy": "dummy" - } -}; - - -for (var key in mkws_config) { - if (mkws_config.hasOwnProperty(key)) { - if (key.match(/^language_/)) { - var lang = key.replace(/^language_/, ""); - // Copy custom languages into list - mkws_locale_lang[lang] = mkws_config[key]; - } - } -} - - -// create a parameters array and pass it to the pz2's constructor -// then register the form submit event with the pz2.search function -// autoInit is set to true on default -var my_paz = new pz2( { "onshow": my_onshow, - "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "pazpar2path": pazpar2path, - "oninit": my_oninit, - "onstat": my_onstat, - "onterm": my_onterm, - "termlist": "xtargets,subject,author", - "onbytarget": my_onbytarget, - "usesessions" : usesessions, - "showResponseType": '', // or "json" (for debugging?) - "onrecord": my_onrecord } ); -// some state vars -var curPage = 1; -var recPerPage = 20; -var totalRec = 0; -var curDetRecId = ''; -var curDetRecData = null; -var curSort = 'relevance'; -var curFilter = null; -var submitted = false; -var SourceMax = 16; -var SubjectMax = 10; -var AuthorMax = 10; - -// -// pz2.js event handlers: -// -function my_oninit() { - my_paz.stat(); - my_paz.bytarget(); -} - -function my_onshow(data) { - totalRec = data.merged; - // move it out - var pager = document.getElementById("mkwsPager"); - pager.innerHTML = ""; - pager.innerHTML +='
' + M('Displaying') + ': ' - + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + - ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' - + data.total + ')
'; - drawPager(pager); - // navi - var results = document.getElementById("mkwsRecords"); - - var html = []; - for (var i = 0; i < data.hits.length; i++) { - var hit = data.hits[i]; - html.push('
' - +''+ (i + 1 + recPerPage * (curPage - 1)) +'. ' - +'' - + hit["md-title"] +' '); - if (hit["md-title-remainder"] !== undefined) { - html.push('' + hit["md-title-remainder"] + ' '); - } - if (hit["md-title-responsibility"] !== undefined) { - html.push(''+hit["md-title-responsibility"]+''); - } - if (hit.recid == curDetRecId) { - html.push(renderDetails(curDetRecData)); - } - html.push('
'); - } - replaceHtml(results, html.join('')); -} - -function my_onstat(data) { - var stat = document.getElementById("mkwsStat"); - if (stat == null) - return; - - stat.innerHTML = 'Status info' + - ' -- ' + - '' + data.activeclients + '/' + data.clients + '' + - ' -- ' + - '' + data.records + '/' + data.hits + ''; -} - -function my_onterm(data) { - // no facets - if (!mkws_config.facets || mkws_config.facets.length == 0) { - $("#mkwsTermlists").hide(); - return; - } - - // display if we first got results - $("#mkwsTermlists").show(); - - var acc = []; - acc.push('
' + M('Termlists') + '
'); - var facets = mkws_config.facets; - - for(var i = 0; i < facets.length; i++) { - if (facets[i] == "sources") { - add_single_facet(acc, "Sources", data.xtargets, SourceMax, null); - } else if (facets[i] == "subjects") { - add_single_facet(acc, "Subjects", data.subject, SubjectMax, "su"); - } else if (facets[i] == "authors") { - add_single_facet(acc, "Authors", data.author, AuthorMax, "au"); - } else { - alert("bad facet configuration: '" + facets[i] + "'"); - } - } - - var termlist = document.getElementById("mkwsTermlists"); - replaceHtml(termlist, acc.join('')); - - if (mkws_config.responsive_design) - mkws_mobile_resize(); -} - -function add_single_facet(acc, caption, data, max, cclIndex) { - acc.push('
'); - acc.push('
' + M(caption) + '
'); - for (var i = 0; i < data.length && i < max; i++ ) { - acc.push('' + data[i].name + '' - + ' (' + data[i].freq + ')
'); - } - acc.push('
'); -} - -function my_onrecord(data) { - // FIXME: record is async!! - clearTimeout(my_paz.recordTimer); - // in case on_show was faster to redraw element - var detRecordDiv = document.getElementById('mkwsDet_'+data.recid); - if (detRecordDiv) return; - curDetRecData = data; - var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid); - var html = renderDetails(curDetRecData); - recordDiv.innerHTML += html; -} - -function my_onbytarget(data) { - var targetDiv = document.getElementById("mkwsBytarget"); - var table ='' - +''; - - for (var i = 0; i < data.length; i++ ) { - table += ""; - } - - table += '
Target IDHitsDiagsRecordsState
" + data[i].id + - "" + data[i].hits + - "" + data[i].diagnostic + - "" + data[i].records + - "" + data[i].state + "
'; - targetDiv.innerHTML = table; -} - -//////////////////////////////////////////////////////////////////////////////// -//////////////////////////////////////////////////////////////////////////////// - -// wait until the DOM is ready -function domReady () -{ - document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler; - document.mkwsSearchForm.mkwsQuery.value = ''; - if (document.mkwsSelect) { - if (document.mkwsSelect.mkwsSort) - document.mkwsSelect.mkwsSort.onchange = onSelectDdChange; - if (document.mkwsSelect.mkwsPerpage) - document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange; - } -} - -// when search button pressed -function onFormSubmitEventHandler() -{ - resetPage(); - loadSelect(); - triggerSearch(); - switchView('records'); // In case it's configured to start off as hidden - submitted = true; - return false; -} - -function onSelectDdChange() -{ - if (!submitted) return false; - resetPage(); - loadSelect(); - my_paz.show(0, recPerPage, curSort); - return false; -} - -function resetPage() -{ - curPage = 1; - totalRec = 0; -} - -function triggerSearch () -{ - my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter); -} - -function loadSelect () -{ - if (document.mkwsSelect) { - if (document.mkwsSelect.mkwsSort) - curSort = document.mkwsSelect.mkwsSort.value; - if (document.mkwsSelect.mkwsPerpage) - recPerPage = document.mkwsSelect.mkwsPerpage.value; - } -} - -// limit the query after clicking the facet -function limitQuery (field, value) -{ - document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"'; - onFormSubmitEventHandler(); -} - -// limit by target functions -function limitTarget (id, name) -{ - var navi = document.getElementById('mkwsNavi'); - navi.innerHTML = - 'Source: ' - + name + ''; - curFilter = 'pz:id=' + id; - resetPage(); - loadSelect(); - triggerSearch(); - return false; -} - -function delimitTarget () -{ - var navi = document.getElementById('mkwsNavi'); - navi.innerHTML = ''; - curFilter = null; - resetPage(); - loadSelect(); - triggerSearch(); - return false; -} - -function drawPager (pagerDiv) -{ - //client indexes pages from 1 but pz2 from 0 - var onsides = 6; - var pages = Math.ceil(totalRec / recPerPage); - - var firstClkbl = ( curPage - onsides > 0 ) - ? curPage - onsides - : 1; - - var lastClkbl = firstClkbl + 2*onsides < pages - ? firstClkbl + 2*onsides - : pages; - - var prev = '<< ' + M('Prev') + ' | '; - if (curPage > 1) - prev = '' - +'<< ' + M('Prev') + ' | '; - - var middle = ''; - for(var i = firstClkbl; i <= lastClkbl; i++) { - var numLabel = i; - if(i == curPage) - numLabel = '' + i + ''; - - middle += ' ' - + numLabel + ' '; - } - - var next = ' | ' + M('Next') + ' >>'; - if (pages - curPage > 0) - next = ' | ' - + M('Next') + ' >>'; - - var predots = ''; - if (firstClkbl > 1) - predots = '...'; - - var postdots = ''; - if (lastClkbl < pages) - postdots = '...'; - - pagerDiv.innerHTML += '
' - + prev + predots + middle + postdots + next + '
'; -} - -function showPage (pageNum) -{ - curPage = pageNum; - my_paz.showPage( curPage - 1 ); -} - -// simple paging functions - -function pagerNext() { - if ( totalRec - recPerPage*curPage > 0) { - my_paz.showNext(); - curPage++; - } -} - -function pagerPrev() { - if ( my_paz.showPrev() != false ) - curPage--; -} - -// switching view between targets and records - -function switchView(view) { - var targets = document.getElementById('mkwsTargets'); - var results = document.getElementById('mkwsResults') || - document.getElementById('mkwsRecords'); - var blanket = document.getElementById('mkwsBlanket'); - var motd = document.getElementById('mkwsEmbeddedMOTD'); - - switch(view) { - case 'targets': - if (targets) targets.style.display = "block"; - if (results) results.style.display = "none"; - if (blanket) blanket.style.display = "none"; - if (motd) motd.style.display = "none"; - break; - case 'records': - if (targets) targets.style.display = "none"; - if (results) results.style.display = "block"; - if (blanket) blanket.style.display = "block"; - if (motd) motd.style.display = "none"; - break; - case 'none': - if (targets) targets.style.display = "none"; - if (results) results.style.display = "none"; - if (blanket) blanket.style.display = "none"; - if (motd) motd.style.display = "none"; - break; - default: - alert("Unknown view '" + view + "'"); - } -} - -// detailed record drawing -function showDetails (prefixRecId) { - var recId = prefixRecId.replace('mkwsRec_', ''); - var oldRecId = curDetRecId; - curDetRecId = recId; - - // remove current detailed view if any - var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId); - // lovin DOM! - if (detRecordDiv) - detRecordDiv.parentNode.removeChild(detRecordDiv); - - // if the same clicked, just hide - if (recId == oldRecId) { - curDetRecId = ''; - curDetRecData = null; - return; - } - // request the record - my_paz.record(recId); -} - -function replaceHtml(el, html) { - var oldEl = typeof el === "string" ? document.getElementById(el) : el; - /*@cc_on // Pure innerHTML is slightly faster in IE - oldEl.innerHTML = html; - return oldEl; - @*/ - var newEl = oldEl.cloneNode(false); - newEl.innerHTML = html; - oldEl.parentNode.replaceChild(newEl, oldEl); - /* Since we just removed the old element from the DOM, return a reference - to the new element, which can be used to restore variable references. */ - return newEl; -}; - -function renderDetails(data, marker) -{ - var details = '
'; - if (marker) details += ''; - - details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]); - details += renderField("Date", data["md-date"]); - details += renderField("Author", data["md-author"]); - details += renderField("URL", data["md-electronic-url"]); - details += renderField("Subject", data["location"][0]["md-subject"]); - details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]); - details += '
'+ marker + '
'; - - return details; -} - -function renderField(caption, data, data2, data3) { - if (data === undefined) { - return ""; - } - - if (caption == "URL") { - data = '' + data + ''; - } - - if (data2 != undefined) { - data = data + " (" + data2 + ")"; - } - - if (data3 != undefined) { - data = data + " " + data3 + ""; - } - - return '' + M(caption) + '' + data + ''; -} - - -/* - * All the HTML stuff to render the search forms and - * result pages. - */ -function mkws_html_all(config) { - - /* default mkws config */ - var mkws_config_default = { - sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], - perpage: [10, 20, 30, 50], - sort_default: "relevance", - perpage_default: 20, - query_width: 50, - switch_menu: false, /* show/hide Records|Targets menu */ - lang_menu: true, /* show/hide language menu */ - sort_menu: true, /* show/hide sort menu */ - perpage_menu: true, /* show/hide perpage menu */ - lang_display: [], /* display languages links for given languages, [] for all */ - facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */ - responsive_design_width: 980, /* a page with less pixel width considered as mobile */ - debug: 1, /* debug level for development: 0..2 */ - - dummy: "dummy" - }; - - /* set global debug flag early */ - if (typeof config.debug !== 'undefined') { - mkws_debug = config.debug; - } else if (typeof mkws_config_default.debug !== 'undefined') { - mkws_debug = mkws_config_default.debug; - } - - /* override standard config values by function parameters */ - for (var k in mkws_config_default) { - if (typeof config[k] === 'undefined') - mkws_config[k] = mkws_config_default[k]; - debug("Set config: " + k + ' => ' + mkws_config[k]); - } - - if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { - debug("Reset query width: " + mkws_config.query_width); - mkws_config.query_width = 50; - } - - mkws_set_lang(mkws_config); - if (mkws_config.lang_menu) - mkws_html_lang(mkws_config); - - // For some reason, doing this programmatically results in - // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML. - debug("HTML search form"); - $("#mkwsSearch").html('\ -
\ - \ - \ -
'); - - debug("HTML records"); - // If the application has an #mkwsResults, populate it in the - // usual way. If not, assume that it's a smarter application that - // defines its own subcomponents: - // #mkwsTermlists - // #mkwsRanking - // #mkwsPager - // #mkwsNavi - // #mkwsRecords - if ($("#mkwsResults").length) { - $("#mkwsResults").html('\ - \ - \ - \ - \ - \ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
\ -
'); - } - - if ($("#mkwsRanking").length) { - var ranking_data = ''; - ranking_data += '
'; - if (config.sort_menu) { - ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' '; - } - if (config.perpage_menu) { - ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.'; - } - ranking_data += '
'; - - $("#mkwsRanking").html(ranking_data); - } - - mkws_html_switch(config); - - if (mkws_config.use_service_proxy) - mkws_service_proxy_auth(config.service_proxy_auth); - - if (mkws_config.responsive_design) - mkws_responsive_design(); - - domReady(); - - // on first page, hide the termlist - $(document).ready(function() { $("#mkwsTermlists").hide(); } ); - var elem = document.getElementById("mkwsMOTD"); - if (elem) { - // Move the MOTD from the provided element down into the embedded one - document.getElementById("mkwsEmbeddedMOTD").innerHTML = elem.innerHTML; - elem.style.display = "none"; - } -} - -/* Responsive web design - change layout on the fly depending on - * the current screen size width/height. Required for mobile devices. - */ -function mkws_responsive_design () { - var timeout = null; - - $(window).resize( function(e) { - if (timeout) - clearTimeout(timeout); - timeout = setTimeout(function () { mkws_mobile_resize() }, 50); - }); - - // initial check after page load - $(document).ready(function() { mkws_mobile_resize() }); -} - -function mkws_set_lang(mkws_config) { - var lang = jQuery.parseQuerystring().lang || mkws_config.lang || ""; - if (!lang || !mkws_locale_lang[lang]) { - mkws_config.lang = "" - } else { - mkws_config.lang = lang; - } - - debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none")); - return mkws_config.lang; -} - -function mkws_html_switch(config) { - debug("HTML switch"); - - $("#mkwsSwitch").html($("", { - href: '#', - onclick: "switchView(\'records\')", - text: M("Records") - })); - $("#mkwsSwitch").append($("", { text: " | " })); - $("#mkwsSwitch").append($("", { - href: '#', - onclick: "switchView(\'targets\')", - text: M("Targets") - })); - - debug("HTML targets"); - $("#mkwsTargets").html('\ -
\ - No information available yet.\ -
'); - $("#mkwsTargets").css("display", "none"); - - if (!config.switch_menu) { - debug("disable switch menu"); - $("#mkwsSwitch").css("display", "none"); - } -} - -function mkws_html_sort(config) { - debug("HTML sort"); - var sort_html = ''; - - return sort_html; -} - -function mkws_html_perpage(config) { - debug("HTML perpage"); - var perpage_html = ''; - - return perpage_html; -} - -/* - * Run service-proxy authentication in background (after page load). - * The username/password is configured in the apache config file - * for the site. - */ -function mkws_service_proxy_auth(auth_url) { - if (!auth_url) - auth_url = "http://mkws.indexdata.com/service-proxy-auth"; - - debug("Run service proxy auth URL: " + auth_url); - - var request = new pzHttpRequest(auth_url); - request.get(null, function(data) { - if (!jQuery.isXMLDoc(data)) { - alert("service proxy auth response document is not valid XML document, give up!"); - return; - } - var status = $(data).find("status"); - if (status.text() != "OK") { - alert("service proxy auth repsonse status: " + status.text() + ", give up!"); - return; - } - }); -} - -/* create locale language menu */ -function mkws_html_lang(mkws_config) { - var lang_default = "en"; - var lang = mkws_config.lang || lang_default; - var list = []; - - /* display a list of configured languages, or all */ - var lang_display = mkws_config.lang_display || []; - var hash = {}; - for (var i = 0; i < lang_display.length; i++) { - hash[lang_display[i]] = 1; - } - - for (var k in mkws_locale_lang) { - if (hash[k] == 1 || lang_display.length == 0) - list.push(k); - } - - // add english link - if (lang_display.length == 0 || hash[lang_default] == 1) - list.push(lang_default); - - debug("Language menu for: " + list.join(", ")); - - /* the HTML part */ - var data = ""; - for(var i = 0; i < list.length; i++) { - var l = list[i]; - - if (data) - data += ' | '; - - if (lang == l) { - data += ' ' + l + ' '; - } else { - data += '
' + l + ' ' - } - } - - $("#mkwsLang").html(data); -} - -function mkws_mobile_resize () { - debug("resize width: " + $(window).height() + ", width: " + $(window).width()); - var list = ["mkwsSwitch"]; - var obj; - // alert($(window).width()); - - var width = mkws_config.responsive_design_width || 980; - - if ($(window).width() <= width) { - for(var i = 0; i < list.length; i++) { - $("#" + list[i]).hide(); - } - - $("#mkwsTermlists").hide(); - obj = $("#mkwsTermlists").html(); - $("#mkwsShiftedTermlists").html(obj); - } else { - for(var i = 0; i < list.length; i++) { - $("#" + list[i]).show(); - } - $("#mkwsTermlists").show(); - $("#mkwsShiftedTermlists").html(""); - } -}; - -/* locale */ -function M(word) { - var lang = mkws_config.lang; - - if (!lang || !mkws_locale_lang[lang]) - return word; - - return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word; -} - -/* implement jQuery.parseQuerystring() for parsing URL parameters */ -jQuery.extend({ - parseQuerystring: function() { - var nvpair = {}; - var qs = window.location.search.replace('?', ''); - var pairs = qs.split('&'); - $.each(pairs, function(i, v){ - var pair = v.split('='); - nvpair[pair[0]] = pair[1]; - }); - return nvpair; - }, - pazpar2: function(data) { - document.write('
\ -
\ -
\ -
\ -
\ -
\ -
\ - Powered by MKWS © 2013 Index Data\ -
'); - - mkws_html_all(mkws_config); - } -}); - -function debug(string) { - if (!mkws_debug) - return; - - if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ - return; - } - - // you need to disable use strict at the top of the file!!! - if (mkws_debug >= 3) { - console.log(arguments.callee.caller); - } else if (mkws_debug >= 2) { - console.log(">>> called from function " + arguments.callee.caller.name + ' <<<'); - } - console.log(string); -} - -/* magic */ -$(document).ready(function() { mkws_html_all(mkws_config) }); diff --git a/experiments/spclient/mkwsStyle.css b/experiments/spclient/mkwsStyle.css deleted file mode 100644 index 08e2fbf..0000000 --- a/experiments/spclient/mkwsStyle.css +++ /dev/null @@ -1,196 +0,0 @@ -#mkwsLang, -#mkwsSwitch, -#mkwsSearch, -#mkwsTermlists, -#mkwsRanking, -#mkwsPager, -#mkwsNavi, -#mkwsRecords, -#mkwsTargets, -#mkwsStat, -#mkwsShiftedTermlists, -#mkwsEmbeddedMOTD { - font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Verdana, Sans-Serif; -} - -#mkwsLang { - float: left; - padding-left: 1em; - padding-top: 0.4em; -} - -#mkwsLang a { - background: #d0e0ff; - padding: 1px 4px; -} - -#mkwsLang span { - border: solid 1px #d0e0ff; - padding: 0px 3px; -} - -#mkwsSearch { - float: right; -} - -#mkwsSwitch { - float: right; - padding-left: 1em; - padding-top: 0.4em; -} - -#mkwsTargets { - background-color: #fafafa; -} - -#mkwsStat { - margin-top: 10px; - border-top: 1px solid #156a16; - padding-top: 5px; - font-size: small; -} - -#mkwsStat span.head { - font-weight: bold; -} - -#mkwsStat span.clients:before { - content: "Active clients: "; -} - -#mkwsStat span.records:before { - content: "Retrieved records: "; -} - -#mkwsSwitch a, -#mkwsLang a, -#mkwsTermlists a, -#mkwsRanking a, -#mkwsPager a, -#mkwsNavi a, -#mkwsRecords a, -#mkwsShiftedTermlists a { - color: #005701; - text-decoration: none; -} - -#mkwsSwitch a:hover, -#mkwsLang a:hover, -#mkwsTermlists a:hover, -#mkwsPager a:hover, -#mkwsRecords a:hover, -#mkwsShiftedTermlists a:hover { - text-decoration: underline; -} - -#mkwsNavi a.crossout:hover { - text-decoration: line-through; -} - -#mkwsSearch input#mkwsButton { - border: 3px outset #132194; - background-color: #132194; - padding: 2px; - width: 6em; - color: #FFFFFF; - font-weight: bold; - text-transform: uppercase; - font-size: 10px; - margin-left: 8px; - cursor: pointer; -} - -#mkwsSearch input#mkwsQuery { - border: 2px inset #e0f0ff; - padding: 3px; - font-size: 12px; - background: #f0f8ff; -} - -#mkwsTermlists .title, -#mkwsShiftedTermlists .title { - font-size: large; - font-weight: bold; - text-transform: uppercase; -} - -#mkwsTermlists, -#mkwsShiftedTermlists div#termlist { - background: #d0e0ff; - padding: 0.7em; - font-size: small; - - border-top-right-radius: 10px; - -moz-border-top-right-radius: 10px; - -webkit-border-top-right-radius: 10px; -} - -#mkwsTermlists div.facet, -#mkwsShiftedTermlists div.facet { - background: #e0f0ff; - padding: 0.7em; - margin-top: 0.7em; - - border-top-right-radius: 10px; - -moz-border-top-right-radius: 10px; - -webkit-border-top-right-radius: 10px; -} - -#mkwsTermlists div.termtitle, -#mkwsShiftedTermlists div.termtitle { - font-weight: bold; -} - -#mkwsRecords div.record, -#mkwsShiftedTermlists div.record { - padding: 5px; -} - -#mkwsRecords div.details { - border: 1px solid #404040; - background: #e8e8e8; - color: darkgray; - padding: 5px 10px; - margin: 10px 0px; - box-shadow: 10px 10px 5px #808080; - - border-top-right-radius: 10px; - -moz-border-top-right-radius: 10px; - -webkit-border-top-right-radius: 10px; -} - -#mkwsRecords div.details th, -#mkwsShiftedTermlists div.details th { - text-align: right; - vertical-align: top; - padding-right: 0.6em; -} - -#mkwsRecords div.details th:after, -#mkwsShiftedTermlists div.details th:after { - content: ":"; -} - -#mkwsPager { - background: #e0e0e0; - padding: 0.3em; -} - -#mkwsBytarget table thead tr td { - background-color: #132194; - color: white; - font-weight: bold; - padding: 0.2em 0.5em; -} - -#mkwsBytarget table tbody tr:nth-child(odd) { - background-color: #e0f0ff; -} - -#mkwsBytarget table tbody tr:nth-child(even) { - background-color: #d0e0ff; -} - -#mkwsBytarget table tbody tr td { - padding: 0.2em 0.5em; -} diff --git a/experiments/spclient/robots.txt b/experiments/spclient/robots.txt deleted file mode 100644 index 1f53798..0000000 --- a/experiments/spclient/robots.txt +++ /dev/null @@ -1,2 +0,0 @@ -User-agent: * -Disallow: / diff --git a/experiments/spdemo/example_client.js b/experiments/spdemo/example_client.js deleted file mode 100644 index a8b9a9a..0000000 --- a/experiments/spdemo/example_client.js +++ /dev/null @@ -1,394 +0,0 @@ -/* A very simple client that shows a basic usage of the pz2.js -*/ - -// create a parameters array and pass it to the pz2's constructor -// then register the form submit event with the pz2.search function -// autoInit is set to true on default - -var pazpar2URL = "/pazpar2/search.pz2"; -var serviceProxyURL = "/service-proxy/"; -var authURLServiceProxy = "/service-proxy-auth"; -var pazpar2path = useServiceProxy ? serviceProxyURL : pazpar2URL; - -var usesessions; - -var showResponseType = ''; -if (document.location.hash == '#useproxy') { - usesessions = false; - pazpar2path = '/service-proxy/'; - showResponseType = 'json'; -} -if (useServiceProxy) { - usesessions = false; -} - -var my_paz = new pz2( { "onshow": my_onshow, - "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way - "pazpar2path": pazpar2path, - "oninit": my_oninit, - "onstat": my_onstat, - "onterm": my_onterm, - "termlist": "xtargets,subject,author", - "onbytarget": my_onbytarget, - "usesessions" : usesessions, - "showResponseType": showResponseType, - "onrecord": my_onrecord } ); -// some state vars -var curPage = 1; -var recPerPage = 20; -var totalRec = 0; -var curDetRecId = ''; -var curDetRecData = null; -var curSort = 'relevance'; -var curFilter = null; -var submitted = false; -var SourceMax = 16; -var SubjectMax = 10; -var AuthorMax = 10; - -// -// pz2.js event handlers: -// -function my_oninit() { - my_paz.stat(); - my_paz.bytarget(); -} - -function my_onshow(data) { - totalRec = data.merged; - // move it out - var pager = document.getElementById("pager"); - pager.innerHTML = ""; - pager.innerHTML +='
Displaying: ' - + (data.start + 1) + ' to ' + (data.start + data.num) + - ' of ' + data.merged + ' (found: ' - + data.total + ')
'; - drawPager(pager); - // navi - var results = document.getElementById("results"); - - var html = []; - for (var i = 0; i < data.hits.length; i++) { - var hit = data.hits[i]; - html.push('
' - +''+ (i + 1 + recPerPage * (curPage - 1)) +'. ' - +'' - + hit["md-title"] +' '); - if (hit["md-title-remainder"] !== undefined) { - html.push('' + hit["md-title-remainder"] + ' '); - } - if (hit["md-title-responsibility"] !== undefined) { - html.push(''+hit["md-title-responsibility"]+''); - } - if (hit.recid == curDetRecId) { - html.push(renderDetails(curDetRecData)); - } - html.push('
'); - } - replaceHtml(results, html.join('')); -} - -function my_onstat(data) { - var stat = document.getElementById("stat"); - if (stat == null) - return; - - stat.innerHTML = ' .:STATUS INFO -- Active clients: ' - + data.activeclients - + '/' + data.clients + ' -- ' - + 'Retrieved records: ' + data.records - + '/' + data.hits - + ' -- by ' - + (useServiceProxy ? 'service proxy' : 'pazpar2') - + ' :.'; -} - -function my_onterm(data) { - var termlists = []; - termlists.push('
TERMLISTS:
.::Sources
'); - for (var i = 0; i < data.xtargets.length && i < SourceMax; i++ ) { - termlists.push('' + data.xtargets[i].name - + ' (' + data.xtargets[i].freq + ')
'); - } - - termlists.push('
.::Subjects
'); - for (var i = 0; i < data.subject.length && i < SubjectMax; i++ ) { - termlists.push('' + data.subject[i].name + ' (' - + data.subject[i].freq + ')
'); - } - - termlists.push('
.::Authors
'); - for (var i = 0; i < data.author.length && i < AuthorMax; i++ ) { - termlists.push('' - + data.author[i].name - + ' (' - + data.author[i].freq - + ')
'); - } - var termlist = document.getElementById("termlist"); - replaceHtml(termlist, termlists.join('')); -} - -function my_onrecord(data) { - // FIXME: record is async!! - clearTimeout(my_paz.recordTimer); - // in case on_show was faster to redraw element - var detRecordDiv = document.getElementById('det_'+data.recid); - if (detRecordDiv) return; - curDetRecData = data; - var recordDiv = document.getElementById('recdiv_'+curDetRecData.recid); - var html = renderDetails(curDetRecData); - recordDiv.innerHTML += html; -} - -function my_onbytarget(data) { - var targetDiv = document.getElementById("bytarget"); - var table ='' - +''; - - for (var i = 0; i < data.length; i++ ) { - table += ""; - } - - table += '
Target IDHitsDiagsRecordsState
" + data[i].id + - "" + data[i].hits + - "" + data[i].diagnostic + - "" + data[i].records + - "" + data[i].state + "
'; - targetDiv.innerHTML = table; -} - -//////////////////////////////////////////////////////////////////////////////// -//////////////////////////////////////////////////////////////////////////////// - -// wait until the DOM is ready -function domReady () -{ - document.search.onsubmit = onFormSubmitEventHandler; - document.search.query.value = ''; - document.select.sort.onchange = onSelectDdChange; - document.select.perpage.onchange = onSelectDdChange; -} - -// when search button pressed -function onFormSubmitEventHandler() -{ - resetPage(); - loadSelect(); - triggerSearch(); - submitted = true; - return false; -} - -function onSelectDdChange() -{ - if (!submitted) return false; - resetPage(); - loadSelect(); - my_paz.show(0, recPerPage, curSort); - return false; -} - -function resetPage() -{ - curPage = 1; - totalRec = 0; -} - -function triggerSearch () -{ - my_paz.search(document.search.query.value, recPerPage, curSort, curFilter); -} - -function loadSelect () -{ - curSort = document.select.sort.value; - recPerPage = document.select.perpage.value; -} - -// limit the query after clicking the facet -function limitQuery (field, value) -{ - document.search.query.value += ' and ' + field + '="' + value + '"'; - onFormSubmitEventHandler(); -} - -// limit by target functions -function limitTarget (id, name) -{ - var navi = document.getElementById('navi'); - navi.innerHTML = - 'Source: ' - + name + ''; - navi.innerHTML += '
'; - curFilter = 'pz:id=' + id; - resetPage(); - loadSelect(); - triggerSearch(); - return false; -} - -function delimitTarget () -{ - var navi = document.getElementById('navi'); - navi.innerHTML = ''; - curFilter = null; - resetPage(); - loadSelect(); - triggerSearch(); - return false; -} - -function drawPager (pagerDiv) -{ - //client indexes pages from 1 but pz2 from 0 - var onsides = 6; - var pages = Math.ceil(totalRec / recPerPage); - - var firstClkbl = ( curPage - onsides > 0 ) - ? curPage - onsides - : 1; - - var lastClkbl = firstClkbl + 2*onsides < pages - ? firstClkbl + 2*onsides - : pages; - - var prev = '<< Prev | '; - if (curPage > 1) - prev = ' | '; - - var middle = ''; - for(var i = firstClkbl; i <= lastClkbl; i++) { - var numLabel = i; - if(i == curPage) - numLabel = '' + i + ''; - - middle += ' ' - + numLabel + ' '; - } - - var next = ' | Next >>'; - if (pages - curPage > 0) - next = ' | '; - - var predots = ''; - if (firstClkbl > 1) - predots = '...'; - - var postdots = ''; - if (lastClkbl < pages) - postdots = '...'; - - pagerDiv.innerHTML += '
' - + prev + predots + middle + postdots + next + '

'; -} - -function showPage (pageNum) -{ - curPage = pageNum; - my_paz.showPage( curPage - 1 ); -} - -// simple paging functions - -function pagerNext() { - if ( totalRec - recPerPage*curPage > 0) { - my_paz.showNext(); - curPage++; - } -} - -function pagerPrev() { - if ( my_paz.showPrev() != false ) - curPage--; -} - -// swithing view between targets and records - -function switchView(view) { - - var targets = document.getElementById('targetview'); - var records = document.getElementById('recordview'); - - switch(view) { - case 'targetview': - targets.style.display = "block"; - records.style.display = "none"; - break; - case 'recordview': - targets.style.display = "none"; - records.style.display = "block"; - break; - default: - alert('Unknown view.'); - } -} - -// detailed record drawing -function showDetails (prefixRecId) { - var recId = prefixRecId.replace('rec_', ''); - var oldRecId = curDetRecId; - curDetRecId = recId; - - // remove current detailed view if any - var detRecordDiv = document.getElementById('det_'+oldRecId); - // lovin DOM! - if (detRecordDiv) - detRecordDiv.parentNode.removeChild(detRecordDiv); - - // if the same clicked, just hide - if (recId == oldRecId) { - curDetRecId = ''; - curDetRecData = null; - return; - } - // request the record - my_paz.record(recId); -} - -function replaceHtml(el, html) { - var oldEl = typeof el === "string" ? document.getElementById(el) : el; - /*@cc_on // Pure innerHTML is slightly faster in IE - oldEl.innerHTML = html; - return oldEl; - @*/ - var newEl = oldEl.cloneNode(false); - newEl.innerHTML = html; - oldEl.parentNode.replaceChild(newEl, oldEl); - /* Since we just removed the old element from the DOM, return a reference - to the new element, which can be used to restore variable references. */ - return newEl; -}; - -function renderDetails(data, marker) -{ - var details = '
'; - if (marker) details += ''; - if (data["md-title"] != undefined) { - details += ''; - } - if (data["md-date"] != undefined) - details += ''; - if (data["md-author"] != undefined) - details += ''; - if (data["md-electronic-url"] != undefined) - details += ''; - if (data["location"][0]["md-subject"] != undefined) - details += ''; - if (data["location"][0]["@name"] != undefined) - details += ''; - details += '
'+ marker + '
Title: '+data["md-title"]; - if (data["md-title-remainder"] !== undefined) { - details += ' : ' + data["md-title-remainder"] + ' '; - } - if (data["md-title-responsibility"] !== undefined) { - details += ' '+ data["md-title-responsibility"] +''; - } - details += '
Date: ' + data["md-date"] + '
Author: ' + data["md-author"] + '
URL: ' + data["md-electronic-url"] + '' + '
Subject: ' + data["location"][0]["md-subject"] + '
Location: ' + data["location"][0]["@name"] + " (" +data["location"][0]["@id"] + ")" + '
'; - return details; -} - //EOF diff --git a/experiments/spdemo/favicon.ico b/experiments/spdemo/favicon.ico deleted file mode 100644 index 35c4899..0000000 Binary files a/experiments/spdemo/favicon.ico and /dev/null differ diff --git a/experiments/spdemo/index.html b/experiments/spdemo/index.html deleted file mode 100644 index d8543da..0000000 --- a/experiments/spdemo/index.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - Pazpar2 demo client - - - - - - - - - - - - - - - -
- -
- - - -
- - - - - - -
Pazpar2 -
- - -
-
- -
-
- -
- - - - - -
-
-
-
-
- Sort by - - and show - - per page. -
-
-
- -
-
-
- - - - - - - diff --git a/experiments/spdemo/indexdata_logo.png b/experiments/spdemo/indexdata_logo.png deleted file mode 100644 index 171c039..0000000 Binary files a/experiments/spdemo/indexdata_logo.png and /dev/null differ diff --git a/experiments/spdemo/pz2.js b/experiments/spdemo/pz2.js deleted file mode 100644 index 309ad1e..0000000 --- a/experiments/spdemo/pz2.js +++ /dev/null @@ -1,1110 +0,0 @@ -/* - * $Id: 3a9980787bb5d0fe966140b243a4a5eb6768913e $ -** pz2.js - pazpar2's javascript client library. -*/ - -//since explorer is flawed -if (!window['Node']) { - window.Node = new Object(); - Node.ELEMENT_NODE = 1; - Node.ATTRIBUTE_NODE = 2; - Node.TEXT_NODE = 3; - Node.CDATA_SECTION_NODE = 4; - Node.ENTITY_REFERENCE_NODE = 5; - Node.ENTITY_NODE = 6; - Node.PROCESSING_INSTRUCTION_NODE = 7; - Node.COMMENT_NODE = 8; - Node.DOCUMENT_NODE = 9; - Node.DOCUMENT_TYPE_NODE = 10; - Node.DOCUMENT_FRAGMENT_NODE = 11; - Node.NOTATION_NODE = 12; -} - -// prevent execution of more than once -if(typeof window.pz2 == "undefined") { -window.undefined = window.undefined; - -var pz2 = function ( paramArray ) -{ - - // at least one callback required - if ( !paramArray ) - throw new Error("Pz2.js: Array with parameters has to be supplied."); - - //supported pazpar2's protocol version - this.suppProtoVer = '1'; - if (typeof paramArray.pazpar2path != "undefined") - this.pz2String = paramArray.pazpar2path; - else - this.pz2String = "/pazpar2/search.pz2"; - this.useSessions = true; - - this.stylesheet = paramArray.detailstylesheet || null; - //load stylesheet if required in async mode - if( this.stylesheet ) { - var context = this; - var request = new pzHttpRequest( this.stylesheet ); - request.get( {}, function ( doc ) { context.xslDoc = doc; } ); - } - - this.errorHandler = paramArray.errorhandler || null; - this.showResponseType = paramArray.showResponseType || "xml"; - - // function callbacks - this.initCallback = paramArray.oninit || null; - this.statCallback = paramArray.onstat || null; - this.showCallback = paramArray.onshow || null; - this.termlistCallback = paramArray.onterm || null; - this.recordCallback = paramArray.onrecord || null; - this.bytargetCallback = paramArray.onbytarget || null; - this.resetCallback = paramArray.onreset || null; - - // termlist keys - this.termKeys = paramArray.termlist || "subject"; - - // some configurational stuff - this.keepAlive = 50000; - - if ( paramArray.keepAlive < this.keepAlive ) - this.keepAlive = paramArray.keepAlive; - - this.sessionID = null; - this.serviceId = paramArray.serviceId || null; - this.initStatusOK = false; - this.pingStatusOK = false; - this.searchStatusOK = false; - - // for sorting - this.currentSort = "relevance"; - - // where are we? - this.currentStart = 0; - // currentNum can be overwritten in show - this.currentNum = 20; - - // last full record retrieved - this.currRecID = null; - - // current query - this.currQuery = null; - - //current raw record offset - this.currRecOffset = null; - - //timers - this.pingTimer = null; - this.statTime = paramArray.stattime || 1000; - this.statTimer = null; - this.termTime = paramArray.termtime || 1000; - this.termTimer = null; - this.showTime = paramArray.showtime || 1000; - this.showTimer = null; - this.showFastCount = 4; - this.bytargetTime = paramArray.bytargettime || 1000; - this.bytargetTimer = null; - this.recordTime = paramArray.recordtime || 500; - this.recordTimer = null; - - // counters for each command and applied delay - this.dumpFactor = 500; - this.showCounter = 0; - this.termCounter = 0; - this.statCounter = 0; - this.bytargetCounter = 0; - this.recordCounter = 0; - - // active clients, updated by stat and show - // might be an issue since bytarget will poll accordingly - this.activeClients = 1; - - // if in proxy mode no need to init - if (paramArray.usesessions != undefined) { - this.useSessions = paramArray.usesessions; - this.initStatusOK = true; - } - // else, auto init session or wait for a user init? - if (this.useSessions && paramArray.autoInit !== false) { - this.init(this.sessionID, this.serviceId); - } - // Version parameter - this.version = paramArray.version || null; -}; - -pz2.prototype = -{ - //error handler for async error throws - throwError: function (errMsg, errCode) - { - var err = new Error(errMsg); - if (errCode) err.code = errCode; - - if (this.errorHandler) { - this.errorHandler(err); - } - else { - throw err; - } - }, - - // stop activity by clearing tiemouts - stop: function () - { - clearTimeout(this.statTimer); - clearTimeout(this.showTimer); - clearTimeout(this.termTimer); - clearTimeout(this.bytargetTimer); - }, - - // reset status variables - reset: function () - { - if ( this.useSessions ) { - this.sessionID = null; - this.initStatusOK = false; - this.pingStatusOK = false; - clearTimeout(this.pingTimer); - } - this.searchStatusOK = false; - this.stop(); - - if ( this.resetCallback ) - this.resetCallback(); - }, - - init: function (sessionId, serviceId) - { - this.reset(); - - // session id as a param - if (sessionId && this.useSessions ) { - this.initStatusOK = true; - this.sessionID = sessionId; - this.ping(); - // old school direct pazpar2 init - } else if (this.useSessions) { - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - var opts = {'command' : 'init'}; - if (serviceId) opts.service = serviceId; - request.safeGet( - opts, - function(data) { - if ( data.getElementsByTagName("status")[0] - .childNodes[0].nodeValue == "OK" ) { - if ( data.getElementsByTagName("protocol")[0] - .childNodes[0].nodeValue - != context.suppProtoVer ) - throw new Error( - "Server's protocol not supported by the client" - ); - context.initStatusOK = true; - context.sessionID = - data.getElementsByTagName("session")[0] - .childNodes[0].nodeValue; - if (data.getElementsByTagName("keepAlive").length > 0) { - context.keepAlive = data.getElementsByTagName("keepAlive")[0].childNodes[0].nodeValue; - } - context.pingTimer = - setTimeout( - function () { - context.ping(); - }, - context.keepAlive - ); - if ( context.initCallback ) - context.initCallback(); - } - else - context.throwError('Init failed. Malformed WS resonse.', - 110); - } - ); - // when through proxy no need to init - } else { - this.initStatusOK = true; - } - }, - // no need to ping explicitly - ping: function () - { - // pinging only makes sense when using pazpar2 directly - if( !this.initStatusOK || !this.useSessions ) - throw new Error( - 'Pz2.js: Ping not allowed (proxy mode) or session not initialized.' - ); - var context = this; - - clearTimeout(context.pingTimer); - - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.safeGet( - { "command": "ping", "session": this.sessionID, "windowid" : window.name }, - function(data) { - if ( data.getElementsByTagName("status")[0] - .childNodes[0].nodeValue == "OK" ) { - context.pingStatusOK = true; - context.pingTimer = - setTimeout( - function () { - context.ping(); - }, - context.keepAlive - ); - } - else - context.throwError('Ping failed. Malformed WS resonse.', - 111); - } - ); - }, - search: function (query, num, sort, filter, showfrom, addParamsArr) - { - clearTimeout(this.statTimer); - clearTimeout(this.showTimer); - clearTimeout(this.termTimer); - clearTimeout(this.bytargetTimer); - - this.showCounter = 0; - this.termCounter = 0; - this.bytargetCounter = 0; - this.statCounter = 0; - this.activeClients = 1; - - // no proxy mode - if( !this.initStatusOK ) - throw new Error('Pz2.js: session not initialized.'); - - if( query !== undefined ) - this.currQuery = query; - else - throw new Error("Pz2.js: no query supplied to the search command."); - - if ( showfrom !== undefined ) - var start = showfrom; - else - var start = 0; - - var searchParams = { - "command": "search", - "query": this.currQuery, - "session": this.sessionID, - "windowid" : window.name - }; - - if( sort !== undefined ) { - this.currentSort = sort; - searchParams["sort"] = sort; - } - if (filter !== undefined) - searchParams["filter"] = filter; - - // copy additional parmeters, do not overwrite - if (addParamsArr != undefined) { - for (var prop in addParamsArr) { - if (!searchParams.hasOwnProperty(prop)) - searchParams[prop] = addParamsArr[prop]; - } - } - - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.safeGet( - searchParams, - function(data) { - if ( data.getElementsByTagName("status")[0] - .childNodes[0].nodeValue == "OK" ) { - context.searchStatusOK = true; - //piggyback search - context.show(start, num, sort); - if (context.statCallback) - context.stat(); - if (context.termlistCallback) - context.termlist(); - if (context.bytargetCallback) - context.bytarget(); - } - else - context.throwError('Search failed. Malformed WS resonse.', - 112); - } - ); - }, - stat: function() - { - if( !this.initStatusOK ) - throw new Error('Pz2.js: session not initialized.'); - - // if called explicitly takes precedence - clearTimeout(this.statTimer); - - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.safeGet( - { "command": "stat", "session": this.sessionID, "windowid" : window.name }, - function(data) { - if ( data.getElementsByTagName("stat") ) { - var activeClients = - Number( data.getElementsByTagName("activeclients")[0] - .childNodes[0].nodeValue ); - context.activeClients = activeClients; - - var stat = Element_parseChildNodes(data.documentElement); - - context.statCounter++; - var delay = context.statTime - + context.statCounter * context.dumpFactor; - - if ( activeClients > 0 ) - context.statTimer = - setTimeout( - function () { - context.stat(); - }, - delay - ); - context.statCallback(stat); - } - else - context.throwError('Stat failed. Malformed WS resonse.', - 113); - } - ); - }, - show: function(start, num, sort, query_state) - { - if( !this.searchStatusOK && this.useSessions ) - throw new Error( - 'Pz2.js: show command has to be preceded with a search command.' - ); - - // if called explicitly takes precedence - clearTimeout(this.showTimer); - - if( sort !== undefined ) - this.currentSort = sort; - if( start !== undefined ) - this.currentStart = Number( start ); - if( num !== undefined ) - this.currentNum = Number( num ); - - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - var requestParameters = - { - "command": "show", - "session": this.sessionID, - "start": this.currentStart, - "num": this.currentNum, - "sort": this.currentSort, - "block": 1, - "type": this.showResponseType, - "windowid" : window.name - }; - if (query_state) - requestParameters["query-state"] = query_state; - if (this.version && this.version > 0) - requestParameters["version"] = this.version; - request.safeGet( - requestParameters, - function(data, type) { - var show = null; - var activeClients = 0; - if (type === "json") { - show = {}; - activeClients = Number(data.activeclients[0]); - show.activeclients = activeClients; - show.merged = Number(data.merged[0]); - show.total = Number(data.total[0]); - show.start = Number(data.start[0]); - show.num = Number(data.num[0]); - show.hits = data.hit; - } else if (data.getElementsByTagName("status")[0] - .childNodes[0].nodeValue == "OK") { - // first parse the status data send along with records - // this is strictly bound to the format - activeClients = - Number(data.getElementsByTagName("activeclients")[0] - .childNodes[0].nodeValue); - show = { - "activeclients": activeClients, - "merged": - Number( data.getElementsByTagName("merged")[0] - .childNodes[0].nodeValue ), - "total": - Number( data.getElementsByTagName("total")[0] - .childNodes[0].nodeValue ), - "start": - Number( data.getElementsByTagName("start")[0] - .childNodes[0].nodeValue ), - "num": - Number( data.getElementsByTagName("num")[0] - .childNodes[0].nodeValue ), - "hits": [] - }; - // parse all the first-level nodes for all tags - var hits = data.getElementsByTagName("hit"); - for (i = 0; i < hits.length; i++) - show.hits[i] = Element_parseChildNodes(hits[i]); - } else { - context.throwError('Show failed. Malformed WS resonse.', - 114); - }; - - var approxNode = data.getElementsByTagName("approximation"); - if (approxNode && approxNode[0] && approxNode[0].childNodes[0] && approxNode[0].childNodes[0].nodeValue) - show['approximation'] = - Number( approxNode[0].childNodes[0].nodeValue); - - - data.getElementsByTagName("") - context.activeClients = activeClients; - context.showCounter++; - var delay = context.showTime; - if (context.showCounter > context.showFastCount) - delay += context.showCounter * context.dumpFactor; - if ( activeClients > 0 ) - context.showTimer = setTimeout( - function () { - context.show(); - }, - delay); - context.showCallback(show); - } - ); - }, - record: function(id, offset, syntax, handler) - { - // we may call record with no previous search if in proxy mode - if(!this.searchStatusOK && this.useSessions) - throw new Error( - 'Pz2.js: record command has to be preceded with a search command.' - ); - - if( id !== undefined ) - this.currRecID = id; - - var recordParams = { - "command": "record", - "session": this.sessionID, - "id": this.currRecID, - "windowid" : window.name - }; - - this.currRecOffset = null; - if (offset != undefined) { - recordParams["offset"] = offset; - this.currRecOffset = offset; - } - - if (syntax != undefined) - recordParams['syntax'] = syntax; - - //overwrite default callback id needed - var callback = this.recordCallback; - var args = undefined; - if (handler != undefined) { - callback = handler['callback']; - args = handler['args']; - } - - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - - request.safeGet( - recordParams, - function(data) { - var recordNode; - var record; - //raw record - if (context.currRecOffset !== null) { - record = new Array(); - record['xmlDoc'] = data; - record['offset'] = context.currRecOffset; - callback(record, args); - //pz2 record - } else if ( recordNode = - data.getElementsByTagName("record")[0] ) { - // if stylesheet was fetched do not parse the response - if ( context.xslDoc ) { - record = new Array(); - record['xmlDoc'] = data; - record['xslDoc'] = context.xslDoc; - record['recid'] = - recordNode.getElementsByTagName("recid")[0] - .firstChild.nodeValue; - //parse record - } else { - record = Element_parseChildNodes(recordNode); - } - var activeClients = - Number( data.getElementsByTagName("activeclients")[0] - .childNodes[0].nodeValue ); - context.activeClients = activeClients; - context.recordCounter++; - var delay = context.recordTime + context.recordCounter * context.dumpFactor; - if ( activeClients > 0 ) - context.recordTimer = - setTimeout ( - function() { - context.record(id, offset, syntax, handler); - }, - delay - ); - callback(record, args); - } - else - context.throwError('Record failed. Malformed WS resonse.', - 115); - } - ); - }, - - termlist: function() - { - if( !this.searchStatusOK && this.useSessions ) - throw new Error( - 'Pz2.js: termlist command has to be preceded with a search command.' - ); - - // if called explicitly takes precedence - clearTimeout(this.termTimer); - - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.safeGet( - { - "command": "termlist", - "session": this.sessionID, - "name": this.termKeys, - "windowid" : window.name, - "version" : this.version - - }, - function(data) { - if ( data.getElementsByTagName("termlist") ) { - var activeClients = - Number( data.getElementsByTagName("activeclients")[0] - .childNodes[0].nodeValue ); - context.activeClients = activeClients; - var termList = { "activeclients": activeClients }; - var termLists = data.getElementsByTagName("list"); - //for each termlist - for (i = 0; i < termLists.length; i++) { - var listName = termLists[i].getAttribute('name'); - termList[listName] = new Array(); - var terms = termLists[i].getElementsByTagName('term'); - //for each term in the list - for (j = 0; j < terms.length; j++) { - var term = { - "name": - (terms[j].getElementsByTagName("name")[0] - .childNodes.length - ? terms[j].getElementsByTagName("name")[0] - .childNodes[0].nodeValue - : 'ERROR'), - "freq": - terms[j] - .getElementsByTagName("frequency")[0] - .childNodes[0].nodeValue || 'ERROR' - }; - - // Only for xtargets: id, records, filtered - var termIdNode = - terms[j].getElementsByTagName("id"); - if(terms[j].getElementsByTagName("id").length) - term["id"] = - termIdNode[0].childNodes[0].nodeValue; - termList[listName][j] = term; - - var recordsNode = terms[j].getElementsByTagName("records"); - if (recordsNode && recordsNode.length) - term["records"] = recordsNode[0].childNodes[0].nodeValue; - - var filteredNode = terms[j].getElementsByTagName("filtered"); - if (filteredNode && filteredNode.length) - term["filtered"] = filteredNode[0].childNodes[0].nodeValue; - - } - } - - context.termCounter++; - var delay = context.termTime - + context.termCounter * context.dumpFactor; - if ( activeClients > 0 ) - context.termTimer = - setTimeout( - function () { - context.termlist(); - }, - delay - ); - - context.termlistCallback(termList); - } - else - context.throwError('Termlist failed. Malformed WS resonse.', - 116); - } - ); - - }, - bytarget: function() - { - if( !this.initStatusOK && this.useSessions ) - throw new Error( - 'Pz2.js: bytarget command has to be preceded with a search command.' - ); - - // no need to continue - if( !this.searchStatusOK ) - return; - - // if called explicitly takes precedence - clearTimeout(this.bytargetTimer); - - var context = this; - var request = new pzHttpRequest(this.pz2String, this.errorHandler); - request.safeGet( - { - "command": "bytarget", - "session": this.sessionID, - "block": 1, - "windowid" : window.name, - "version" : this.version - }, - function(data) { - if ( data.getElementsByTagName("status")[0] - .childNodes[0].nodeValue == "OK" ) { - var targetNodes = data.getElementsByTagName("target"); - var bytarget = new Array(); - for ( i = 0; i < targetNodes.length; i++) { - bytarget[i] = new Array(); - for( j = 0; j < targetNodes[i].childNodes.length; j++ ) { - if ( targetNodes[i].childNodes[j].nodeType - == Node.ELEMENT_NODE ) { - var nodeName = - targetNodes[i].childNodes[j].nodeName; - if (targetNodes[i].childNodes[j].firstChild != null) - { - var nodeText = targetNodes[i].childNodes[j] - .firstChild.nodeValue; - bytarget[i][nodeName] = nodeText; - } - else { - bytarget[i][nodeName] = ""; - } - - - } - } - if (bytarget[i]["state"]=="Client_Disconnected") { - bytarget[i]["hits"] = "Error"; - } else if (bytarget[i]["state"]=="Client_Error") { - bytarget[i]["hits"] = "Error"; - } else if (bytarget[i]["state"]=="Client_Working") { - bytarget[i]["hits"] = "..."; - } - if (bytarget[i].diagnostic == "1") { - bytarget[i].diagnostic = "Permanent system error"; - } else if (bytarget[i].diagnostic == "2") { - bytarget[i].diagnostic = "Temporary system error"; - } - var targetsSuggestions = targetNodes[i].getElementsByTagName("suggestions"); - if (targetsSuggestions != undefined && targetsSuggestions.length>0) { - var suggestions = targetsSuggestions[0]; - bytarget[i]["suggestions"] = Element_parseChildNodes(suggestions); - } - } - - context.bytargetCounter++; - var delay = context.bytargetTime - + context.bytargetCounter * context.dumpFactor; - if ( context.activeClients > 0 ) - context.bytargetTimer = - setTimeout( - function () { - context.bytarget(); - }, - delay - ); - - context.bytargetCallback(bytarget); - } - else - context.throwError('Bytarget failed. Malformed WS resonse.', - 117); - } - ); - }, - - // just for testing, probably shouldn't be here - showNext: function(page) - { - var step = page || 1; - this.show( ( step * this.currentNum ) + this.currentStart ); - }, - - showPrev: function(page) - { - if (this.currentStart == 0 ) - return false; - var step = page || 1; - var newStart = this.currentStart - (step * this.currentNum ); - this.show( newStart > 0 ? newStart : 0 ); - }, - - showPage: function(pageNum) - { - //var page = pageNum || 1; - this.show(pageNum * this.currentNum); - } -}; - -/* -******************************************************************************** -** AJAX HELPER CLASS *********************************************************** -******************************************************************************** -*/ -var pzHttpRequest = function ( url, errorHandler ) { - this.maxUrlLength = 2048; - this.request = null; - this.url = url; - this.errorHandler = errorHandler || null; - this.async = true; - this.requestHeaders = {}; - - if ( window.XMLHttpRequest ) { - this.request = new XMLHttpRequest(); - } else if ( window.ActiveXObject ) { - try { - this.request = new ActiveXObject( 'Msxml2.XMLHTTP' ); - } catch (err) { - this.request = new ActiveXObject( 'Microsoft.XMLHTTP' ); - } - } -}; - - -pzHttpRequest.prototype = -{ - safeGet: function ( params, callback ) - { - var encodedParams = this.encodeParams(params); - var url = this._urlAppendParams(encodedParams); - if (url.length >= this.maxUrlLength) { - this.requestHeaders["Content-Type"] - = "application/x-www-form-urlencoded"; - this._send( 'POST', this.url, encodedParams, callback ); - } else { - this._send( 'GET', url, '', callback ); - } - }, - - get: function ( params, callback ) - { - this._send( 'GET', this._urlAppendParams(this.encodeParams(params)), - '', callback ); - }, - - post: function ( params, data, callback ) - { - this._send( 'POST', this._urlAppendParams(this.encodeParams(params)), - data, callback ); - }, - - load: function () - { - this.async = false; - this.request.open( 'GET', this.url, this.async ); - this.request.send(''); - if ( this.request.status == 200 ) - return this.request.responseXML; - }, - - encodeParams: function (params) - { - var sep = ""; - var encoded = ""; - for (var key in params) { - if (params[key] != null) { - encoded += sep + key + '=' + encodeURIComponent(params[key]); - sep = '&'; - } - } - return encoded; - }, - - _send: function ( type, url, data, callback) - { - var context = this; - this.callback = callback; - this.async = true; - this.request.open( type, url, this.async ); - for (var key in this.requestHeaders) - this.request.setRequestHeader(key, this.requestHeaders[key]); - this.request.onreadystatechange = function () { - context._handleResponse(url); /// url used ONLY for error reporting - } - this.request.send(data); - }, - - _urlAppendParams: function (encodedParams) - { - if (encodedParams) - return this.url + "?" + encodedParams; - else - return this.url; - }, - - _handleResponse: function (savedUrlForErrorReporting) - { - if ( this.request.readyState == 4 ) { - // pick up appplication errors first - var errNode = null; - if (this.request.responseXML && - (errNode = this.request.responseXML.documentElement) - && errNode.nodeName == 'error') { - var errMsg = errNode.getAttribute("msg"); - var errCode = errNode.getAttribute("code"); - var errAddInfo = ''; - if (errNode.childNodes.length) - errAddInfo = ': ' + errNode.childNodes[0].nodeValue; - - var err = new Error(errMsg + errAddInfo); - err.code = errCode; - - if (this.errorHandler) { - this.errorHandler(err); - } - else { - throw err; - } - } else if (this.request.status == 200 && - this.request.responseXML == null) { - if (this.request.responseText != null) { - //assume JSON - - var json = null; - var text = this.request.responseText; - if (typeof window.JSON == "undefined") - json = eval("(" + text + ")"); - else { - try { - json = JSON.parse(text); - } - catch (e) { - // Safari: eval will fail as well. Considering trying JSON2 (non-native implementation) instead - /* DEBUG only works in mk2-mobile - if (document.getElementById("log")) - document.getElementById("log").innerHTML = "" + e + " " + length + ": " + text; - */ - try { - json = eval("(" + text + ")"); - } - catch (e) { - /* DEBUG only works in mk2-mobile - if (document.getElementById("log")) - document.getElementById("log").innerHTML = "" + e + " " + length + ": " + text; - */ - } - } - } - this.callback(json, "json"); - } else { - var err = new Error("XML response is empty but no error " + - "for " + savedUrlForErrorReporting); - err.code = -1; - if (this.errorHandler) { - this.errorHandler(err); - } else { - throw err; - } - } - } else if (this.request.status == 200) { - this.callback(this.request.responseXML); - } else { - var err = new Error("HTTP response not OK: " - + this.request.status + " - " - + this.request.statusText ); - err.code = '00' + this.request.status; - if (this.errorHandler) { - this.errorHandler(err); - } - else { - throw err; - } - } - } - } -}; - -/* -******************************************************************************** -** XML HELPER FUNCTIONS ******************************************************** -******************************************************************************** -*/ - -// DOMDocument - -if ( window.ActiveXObject) { - var DOMDoc = document; -} else { - var DOMDoc = Document.prototype; -} - -DOMDoc.newXmlDoc = function ( root ) -{ - var doc; - - if (document.implementation && document.implementation.createDocument) { - doc = document.implementation.createDocument('', root, null); - } else if ( window.ActiveXObject ) { - doc = new ActiveXObject("MSXML2.DOMDocument"); - doc.loadXML('<' + root + '/>'); - } else { - throw new Error ('No XML support in this browser'); - } - - return doc; -} - - -DOMDoc.parseXmlFromString = function ( xmlString ) -{ - var doc; - - if ( window.DOMParser ) { - var parser = new DOMParser(); - doc = parser.parseFromString( xmlString, "text/xml"); - } else if ( window.ActiveXObject ) { - doc = new ActiveXObject("MSXML2.DOMDocument"); - doc.loadXML( xmlString ); - } else { - throw new Error ("No XML parsing support in this browser."); - } - - return doc; -} - -DOMDoc.transformToDoc = function (xmlDoc, xslDoc) -{ - if ( window.XSLTProcessor ) { - var proc = new XSLTProcessor(); - proc.importStylesheet( xslDoc ); - return proc.transformToDocument(xmlDoc); - } else if ( window.ActiveXObject ) { - return document.parseXmlFromString(xmlDoc.transformNode(xslDoc)); - } else { - alert( 'Unable to perform XSLT transformation in this browser' ); - } -} - -// DOMElement - -Element_removeFromDoc = function (DOM_Element) -{ - DOM_Element.parentNode.removeChild(DOM_Element); -} - -Element_emptyChildren = function (DOM_Element) -{ - while( DOM_Element.firstChild ) { - DOM_Element.removeChild( DOM_Element.firstChild ) - } -} - -Element_appendTransformResult = function ( DOM_Element, xmlDoc, xslDoc ) -{ - if ( window.XSLTProcessor ) { - var proc = new XSLTProcessor(); - proc.importStylesheet( xslDoc ); - var docFrag = false; - docFrag = proc.transformToFragment( xmlDoc, DOM_Element.ownerDocument ); - DOM_Element.appendChild(docFrag); - } else if ( window.ActiveXObject ) { - DOM_Element.innerHTML = xmlDoc.transformNode( xslDoc ); - } else { - alert( 'Unable to perform XSLT transformation in this browser' ); - } -} - -Element_appendTextNode = function (DOM_Element, tagName, textContent ) -{ - var node = DOM_Element.ownerDocument.createElement(tagName); - var text = DOM_Element.ownerDocument.createTextNode(textContent); - - DOM_Element.appendChild(node); - node.appendChild(text); - - return node; -} - -Element_setTextContent = function ( DOM_Element, textContent ) -{ - if (typeof DOM_Element.textContent !== "undefined") { - DOM_Element.textContent = textContent; - } else if (typeof DOM_Element.innerText !== "undefined" ) { - DOM_Element.innerText = textContent; - } else { - throw new Error("Cannot set text content of the node, no such method."); - } -} - -Element_getTextContent = function (DOM_Element) -{ - if ( typeof DOM_Element.textContent != 'undefined' ) { - return DOM_Element.textContent; - } else if (typeof DOM_Element.text != 'undefined') { - return DOM_Element.text; - } else { - throw new Error("Cannot get text content of the node, no such method."); - } -} - -Element_parseChildNodes = function (node) -{ - var parsed = {}; - var hasChildElems = false; - var textContent = ''; - - if (node.hasChildNodes()) { - var children = node.childNodes; - for (var i = 0; i < children.length; i++) { - var child = children[i]; - switch (child.nodeType) { - case Node.ELEMENT_NODE: - hasChildElems = true; - var nodeName = child.nodeName; - if (!(nodeName in parsed)) - parsed[nodeName] = []; - parsed[nodeName].push(Element_parseChildNodes(child)); - break; - case Node.TEXT_NODE: - textContent += child.nodeValue; - break; - case Node.CDATA_SECTION_NODE: - textContent += child.nodeValue; - break; - } - } - } - - var attrs = node.attributes; - for (var i = 0; i < attrs.length; i++) { - hasChildElems = true; - var attrName = '@' + attrs[i].nodeName; - var attrValue = attrs[i].nodeValue; - parsed[attrName] = attrValue; - } - - // if no nested elements/attrs set value to text - if (hasChildElems) - parsed['#text'] = textContent; - else - parsed = textContent; - - return parsed; -} - -/* do not remove trailing bracket */ -} diff --git a/experiments/spdemo/robots.txt b/experiments/spdemo/robots.txt deleted file mode 100644 index 1f53798..0000000 --- a/experiments/spdemo/robots.txt +++ /dev/null @@ -1,2 +0,0 @@ -User-agent: * -Disallow: / diff --git a/experiments/spdemo/styles.css b/experiments/spdemo/styles.css deleted file mode 100644 index e6cd2b0..0000000 --- a/experiments/spdemo/styles.css +++ /dev/null @@ -1,110 +0,0 @@ -html { - overflow-y: scroll; - font-size: 12px; -} - -body { - font-family: tahoma, arial, sans-serif; - color: #156a16; -} - -hr { - border: 0; - color: #156a16; - background-color: #156a16; - height: 1px; -} - -thead { - font-weight: bold; -} - -a { - color: #005701; - text-decoration: none; -} - -a.extern { - color: #CC6600; -} - -a:hover { - text-decoration: underline; -} - -a.crossout:hover { - text-decoration: line-through; - font-weight: bold; -} - - -#heading { - background-color: #87c9af; - border-top: 1px solid #156a16; - color: #ffffff; - font-size: large; -} - -input#button { - border: 3px outset #132194; - background-color: #132194; - padding: 2px; - width: 6em; - color: #FFFFFF; - font-weight: bold; - text-transform: uppercase; - font-size: 10px; - margin-left: 8px; - cursor: pointer; -} - -input#query { - border: 2px inset #34cc67; - padding: 3px; - font-size: 12px; -} - -div.termtitle { - margin: 4px; - font-weight: bold; -} - -div.record { - padding: 5px; -} - -div.details { - border: 3px dashed gray; - color: gray; - padding: 5px; - margin: 4px; -} - -#switchmenu { - padding-bottom: 3px; - text-align: right; -} - -#recordview { - background-color: #fafafa; - border-bottom: 1px solid #156a16; -} - -#targetview { - background-color: #fafafa; - border-bottom: 1px solid #156a16; -} - -#bytarget { - padding: 7px; -} - -#footer { - padding-top: 4px; - color: #74c775; - text-align: center; -} - -#stat { - font-weight: bold; -} diff --git a/tools/apache2/README b/tools/apache2/README new file mode 100644 index 0000000..351fc7f --- /dev/null +++ b/tools/apache2/README @@ -0,0 +1,5 @@ +You will need to enable the Rewrite module for this to work: + +$ sudo a2enmod rewrite +$ sudo service apache2 reload + diff --git a/tools/apache2/mkws-dev b/tools/apache2/mkws-dev new file mode 100644 index 0000000..5f6634e --- /dev/null +++ b/tools/apache2/mkws-dev @@ -0,0 +1,26 @@ +# Configuration for the apache web server -*- apache -*- + +# pazpar2 / service proxy config + + ServerName spclient.example.com + ServerAlias spclient-dev.indexdata.com + ServerAdmin webmaster@example.com + ErrorLog /var/log/apache2/mkws-dev-error.log + CustomLog /var/log/apache2/mkws-dev-access.log combined + + RewriteEngine on + RewriteLogLevel 1 + RewriteLog /var/log/apache2/mkws-dev-rewrite.log + + DocumentRoot /home/indexdata/mkws/experiments/spclient + + RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] + + ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + + ProxyPass /pazpar2/ http://localhost:8004/pazpar2/ + ProxyPassReverse /pazpar2/ http://localhost:8004/pazpar2/ + + + diff --git a/tools/apache2/mkws-dev-proxy b/tools/apache2/mkws-dev-proxy new file mode 100644 index 0000000..ef05c02 --- /dev/null +++ b/tools/apache2/mkws-dev-proxy @@ -0,0 +1,19 @@ + + ServerName mkws-dev.indexdata.com + ServerAlias spclient-dev.indexdata.com + + ProxyRequests off + ProxyVia On + ProxyPreserveHost On + + Order deny,allow + Allow from all + + + ProxyPass / http://dart:80/ + ProxyPassReverse / http://dart:80/ + + # These are the logs for the proxying operation + ErrorLog /var/log/apache2/mkws-dev-proxy-error.log + CustomLog /var/log/apache2/mkws-dev-proxy-access.log combined + diff --git a/tools/apache2/mkws-live b/tools/apache2/mkws-live new file mode 100644 index 0000000..aac6d2a --- /dev/null +++ b/tools/apache2/mkws-live @@ -0,0 +1,29 @@ +# Configuration for the apache web server +# Running on caliban + + + ServerName mkws.indexdata.com + + ErrorLog /var/log/apache2/mkws-error.log + CustomLog /var/log/apache2/mkws-access.log combined + + DocumentRoot /home/indexdata/mkws/tools/htdocs + Alias /libjs-pz2/ /home/indexdata/libjs-pz2/ + + RewriteEngine on + RewriteLogLevel 1 + RewriteLog /var/log/apache2/mkws-rewrite.log + RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=demo&password=demo [P] # [NE,P] + + Header set Access-Control-Allow-Credentials true + + # For MKC Service Proxy + ProxyPass /service-proxy/ http://mk2-test.indexdata.com/service-proxy/ + ProxyPassReverse /service-proxy/ http://mk2-test.indexdata.com/service-proxy/ + + PerlOptions +Parent + PerlSwitches -I/home/indexdata/mkws/tools/mod_perl + + PerlOutputFilterHandler MyApache2::SetACAO + + diff --git a/tools/apache2/mkws-mike b/tools/apache2/mkws-mike new file mode 100644 index 0000000..e31347b --- /dev/null +++ b/tools/apache2/mkws-mike @@ -0,0 +1,29 @@ +# Configuration for the apache web server +# Running on Mike's local development box + + + ServerName x.mkws.indexdata.com + ErrorLog /var/log/apache2/mkws-error.log + CustomLog /var/log/apache2/mkws-access.log combined + + DocumentRoot /usr/local/src/git/mkws/tools/htdocs + Alias /libjs-pz2/ /usr/local/src/git/libjs-pz2/ + + RewriteEngine on + RewriteLogLevel 1 + RewriteLog /var/log/apache2/spclient-rewrite.log + RewriteRule /service-proxy-auth /service-proxy/?command=auth&action=login&username=guest&password=guest [P] # [NE,P] + + # For MKC Service Proxy + ProxyPass /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + ProxyPassReverse /service-proxy/ http://mkc.indexdata.com:9009/service-proxy/ + + # For local Service Proxy running as mvn jetty:run + #ProxyPass /service-proxy/ http://localhost:8585/service-proxy/ + #ProxyPassReverse /service-proxy/ http://localhost:8585/service-proxy/ + + # Needed on Mac, which locks Apache down hard by default. + + Allow from all + + diff --git a/tools/apache2/mkws-proxy b/tools/apache2/mkws-proxy new file mode 100644 index 0000000..1ec95b5 --- /dev/null +++ b/tools/apache2/mkws-proxy @@ -0,0 +1,18 @@ + + ServerName mkws.indexdata.com + + ProxyRequests off + ProxyVia On + ProxyPreserveHost On + + Order deny,allow + Allow from all + + + ProxyPass / http://caliban:80/ + ProxyPassReverse / http://caliban:80/ + + # These are the logs for the proxying operation + ErrorLog /var/log/apache2/mkws-proxy-error.log + CustomLog /var/log/apache2/mkws-proxy-access.log combined + diff --git a/tools/htdocs/.gitignore b/tools/htdocs/.gitignore new file mode 100644 index 0000000..a7392c7 --- /dev/null +++ b/tools/htdocs/.gitignore @@ -0,0 +1 @@ +mkws-complete.js diff --git a/tools/htdocs/Makefile b/tools/htdocs/Makefile new file mode 100644 index 0000000..38d83f4 --- /dev/null +++ b/tools/htdocs/Makefile @@ -0,0 +1,23 @@ +###################################################################### +# Copyright (c) 2013 IndexData ApS. http://indexdata.com +# + +MKWS_JS= mkws-complete.js +all: ${MKWS_JS} + +mkws-js ${MKWS_JS}: ../../../libjs-pz2/pz2api.1.js mkws.js + ( echo "/* created at: $$(date)"; \ + echo " mkws.js GIT id: $$(git log mkws.js | head -n 1 | perl -npe 's,\S+\s+,,') */"; \ + curl -sSf http://code.jquery.com/jquery-1.10.0.min.js; \ + cat ../../../libjs-pz2/pz2api.1.js mkws.js ) > ${MKWS_JS}.new + mv -f ${MKWS_JS}.new ${MKWS_JS} + +distclean: clean +clean: + rm -f ${MKWS_JS} + +help: + @echo "make [ help | mkws-js | clean ]" + @echo "" + @echo "Please check ./README file too!" + diff --git a/tools/htdocs/README b/tools/htdocs/README new file mode 100644 index 0000000..0c4d98d --- /dev/null +++ b/tools/htdocs/README @@ -0,0 +1,128 @@ +An embryonic MasterKey Widget Set +================================= + +This directory contains an embryonic MasterKey Widget Set, based +initially on "jsdemo" though now far removed from those beginnnings. + + +How this works +-------------- + +The goal is to make it that as much of the searching functionality as +possible is hosted on + http://mkws.indexdata.com/ +so that very simple websites such as + http://example.indexdata.com/ +can have MasterKey searching with minimal effort. + +The following files must be hosted on mkws.indexdata.com: + mkws.js + mkwsStyle.css + /libjs-pz2/pz2api.1.js (*) + +The following files make up the application: + index.html + favicon.ico [optional] + robots.txt [optional] + +(At present, the client application's configuruation also needs an +Alias for /service-proxy/, to avoid cross-site scripting issues. We +will fix this.) + +(*) if you don't have already installed libjs-pz2 on the machine, you can +do it by installing a debian package or check it out from GIT: +$ git clone ssh://git.indexdata.com:222/home/git/pub/libjs-pz2 + +Configuring a client +-------------------- + +The application's HTML must contains the following elements as well as +whatever makes up the application itself: + +Prerequisites: + + + + + +(Yes, we're using JQuery. We use it only in the most trivial ways, and +could probably get rid of it without too much pain. I'd like to have +mkws.js automatically pull in pz2api.1.js, too, so you don't need to +do so many things, but that's not quite trivial.) + +Then the following special
s can be added (with no content), and +will be filled in by MKWS: +
-- switch between record and target views +
-- switch between English, Danish and German +
-- search box and button +
-- result list, including pager/sorting +
-- target list, including status +
-- summary statistics + +At present, MKWS will not work correctly if any of these is +missing. One of the TODOs is to fix it so that it doesn't try to use +whatever is not there, and just uses what is. + + +You can configure and control the client with the JavaScript mkws_config object. + +Here is an example of all possible options + + +Note: the mkws_config object which must be loaded before the mkws.js and pz2api.js files. + +Supported Browsers +------------------ + +Any modern HTML5 browser will work fine. JavaScript must be enabled. + +* IE8 or later +* Firefox 17 or later +* Google Chrome 27 or later +* Safari 6 or later +* Opera 12 or later +* iOS 6.x (iPhone, iPad) +* Android 4.x + +Not supported: IE6, IE7 + +New Features since jsdemo +-------------------------- +- multilinguality: English (default), Danish, German +- depends on the new pazpar2 JS library libjs-pz2/pz2api.1.js + which will make the development of pazpar2 plugins faster and + easier to share code between projects +- supports basic pazpar2 and service-proxy requests +- simplified HTML +- the search page is fully configurable by a JSON object + + +What next? +---------- + +Main areas of work: +* Make MKWS robust to missing widgets +* Clean up the code diff --git a/tools/htdocs/html-structure.txt b/tools/htdocs/html-structure.txt new file mode 100644 index 0000000..c6d0da8 --- /dev/null +++ b/tools/htdocs/html-structure.txt @@ -0,0 +1,62 @@ +The HTML structure of the MKWS
s is as follows. This is useful to +know when working on stylesheets. As in CSS, #ID indicates a unique +identifier and .CLASS indicates an instance of a class. + + +#mkwsSwitch + a* + +#mkwsLang + ( a | span )* + +#mkwsSearch + form + input#mkwsQuery type=text + input#mkwsButton type=submit + +#mkwsBlanket + (no contents -- used only for masking) + +#mkwsResults + table + tbody + tr + td + #mkwsTermlists + div.title + div.facet* + div.termtitle + ( a span br )* + td + div#mkwsRanking + form#mkwsSelect + select#mkwsSort + select#mkwsPerpage + #mkwsPager + #mkwsNavi + #mkwsRecords + div.record* + span (for sequence number) + a (for title) + span (for other information such as author) + div.details (sometimes) + table + tbody + tr* + th + td +#mkwsTargets + #mkwsBytarget + table + thead + tr* + td* + tbody + tr* + td* + +#mkwsStat + span.head + span.clients + span.records + diff --git a/tools/htdocs/index.html b/tools/htdocs/index.html new file mode 100644 index 0000000..7b90bcc --- /dev/null +++ b/tools/htdocs/index.html @@ -0,0 +1,135 @@ + + + + MKWS: the MasterKey Widget Set + + + +

MKWS: the MasterKey Widget Set

+

+ This site contains tools, not content: +

+
    +
  • + mkws.js + -- + JavaScript code that powers the MasterKey Widget Set +
  • +
  • + /libjs-pz2/pz2api.1.js + -- + Low-level JavaScript library for access to the MasterKey web + service. +
  • +
  • + mkws-complete.js + -- + A single large JavaScript file containing everything needed for + MKWS to work: the widget-set itself, the API library, and any + additional prerequisites such as jQuery. +
  • +
  • + mkwsStyle.css + -- + A stylesheet which styles only MasterKey widgets, and does not + otherwise interfere with application-site's styles. + +
  • +
+

+ For examples of how to use the widget-set, see: +

+ +

+ The set of targets can be maintained: +

+ +

+ Documentation is as yet in short supply: +

+ + + diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js new file mode 100644 index 0000000..6c544ea --- /dev/null +++ b/tools/htdocs/mkws.js @@ -0,0 +1,873 @@ +/* A very simple client that shows a basic usage of the pz2.js +*/ + +"use strict"; // HTML5: disable for debug >= 2 + +/* + * global config object: mkws_config + * + * needs to be defined in the HTML header before + * including this JS file + */ + +if (!mkws_config) + var mkws_config = {}; // for the guys who forgot to define mkws_config... + +if (typeof mkws_config.use_service_proxy === 'undefined') + mkws_config.use_service_proxy = true; + +// global debug flag +var mkws_debug; + +var pazpar2_url = mkws_config.pazpar2_url ? mkws_config.pazpar2_url : "/pazpar2/search.pz2"; +var service_proxy_url = mkws_config.service_proxy_url ? mkws_config.service_proxy_url : "http://mkws.indexdata.com/service-proxy/"; + +var pazpar2path = mkws_config.use_service_proxy ? service_proxy_url : pazpar2_url; +var usesessions = mkws_config.use_service_proxy ? false : true; + + +var mkws_locale_lang = { + "de": { + "Authors": "Autoren", + "Subjects": "Schlagwörter", + "Sources": "Daten und Quellen", + "Termlists": "Termlisten", + "Next": "Weiter", + "Prev": "Zurück", + "Search": "Suche", + "Sort by": "Sortieren nach", + "and show": "und zeige", + "per page": "pro Seite", + "Displaying": "Zeige", + "to": "von", + "of": "aus", + "found": "gefunden", + "Title": "Titel", + "Author": "Autor", + "Date": "Datum", + "Subject": "Schlagwort", + "Location": "Ort", + + "dummy": "dummy" + }, + + "da": { + "Authors": "Forfattere", + "Subjects": "Emner", + "Sources": "Kilder", + "Termlists": "Termlists", + "Next": "Næste", + "Prev": "Forrige", + "Search": "Søg", + "Sort by": "Sorter efter", + "and show": "og vis", + "per page": "per side", + "Displaying": "Viser", + "to": "til", + "of": "ud af", + "found": "fandt", + "Title": "Title", + "Author": "Forfatter", + "Date": "Dato", + "Subject": "Emneord", + "Location": "Lokation", + + "dummy": "dummy" + } +}; + + +for (var key in mkws_config) { + if (mkws_config.hasOwnProperty(key)) { + if (key.match(/^language_/)) { + var lang = key.replace(/^language_/, ""); + // Copy custom languages into list + mkws_locale_lang[lang] = mkws_config[key]; + } + } +} + + +// create a parameters array and pass it to the pz2's constructor +// then register the form submit event with the pz2.search function +// autoInit is set to true on default +var my_paz = new pz2( { "onshow": my_onshow, + "showtime": 500, //each timer (show, stat, term, bytarget) can be specified this way + "pazpar2path": pazpar2path, + "oninit": my_oninit, + "onstat": my_onstat, + "onterm": my_onterm, + "termlist": "xtargets,subject,author", + "onbytarget": my_onbytarget, + "usesessions" : usesessions, + "showResponseType": '', // or "json" (for debugging?) + "onrecord": my_onrecord } ); +// some state vars +var curPage = 1; +var recPerPage = 20; +var totalRec = 0; +var curDetRecId = ''; +var curDetRecData = null; +var curSort = 'relevance'; +var curFilter = null; +var submitted = false; +var SourceMax = 16; +var SubjectMax = 10; +var AuthorMax = 10; + +// +// pz2.js event handlers: +// +function my_oninit() { + my_paz.stat(); + my_paz.bytarget(); +} + +function my_onshow(data) { + totalRec = data.merged; + // move it out + var pager = document.getElementById("mkwsPager"); + pager.innerHTML = ""; + pager.innerHTML +='
' + M('Displaying') + ': ' + + (data.start + 1) + ' ' + M('to') + ' ' + (data.start + data.num) + + ' ' + M('of') + ' ' + data.merged + ' (' + M('found') + ': ' + + data.total + ')
'; + drawPager(pager); + // navi + var results = document.getElementById("mkwsRecords"); + + var html = []; + for (var i = 0; i < data.hits.length; i++) { + var hit = data.hits[i]; + html.push('
' + +''+ (i + 1 + recPerPage * (curPage - 1)) +'. ' + +'' + + hit["md-title"] +' '); + if (hit["md-title-remainder"] !== undefined) { + html.push('' + hit["md-title-remainder"] + ' '); + } + if (hit["md-title-responsibility"] !== undefined) { + html.push(''+hit["md-title-responsibility"]+''); + } + if (hit.recid == curDetRecId) { + html.push(renderDetails(curDetRecData)); + } + html.push('
'); + } + replaceHtml(results, html.join('')); +} + +function my_onstat(data) { + var stat = document.getElementById("mkwsStat"); + if (stat == null) + return; + + stat.innerHTML = 'Status info' + + ' -- ' + + '' + data.activeclients + '/' + data.clients + '' + + ' -- ' + + '' + data.records + '/' + data.hits + ''; +} + +function my_onterm(data) { + // no facets + if (!mkws_config.facets || mkws_config.facets.length == 0) { + $("#mkwsTermlists").hide(); + return; + } + + // display if we first got results + $("#mkwsTermlists").show(); + + var acc = []; + acc.push('
' + M('Termlists') + '
'); + var facets = mkws_config.facets; + + for(var i = 0; i < facets.length; i++) { + if (facets[i] == "sources") { + add_single_facet(acc, "Sources", data.xtargets, SourceMax, null); + } else if (facets[i] == "subjects") { + add_single_facet(acc, "Subjects", data.subject, SubjectMax, "su"); + } else if (facets[i] == "authors") { + add_single_facet(acc, "Authors", data.author, AuthorMax, "au"); + } else { + alert("bad facet configuration: '" + facets[i] + "'"); + } + } + + var termlist = document.getElementById("mkwsTermlists"); + replaceHtml(termlist, acc.join('')); + + if (mkws_config.responsive_design) + mkws_mobile_resize(); +} + +function add_single_facet(acc, caption, data, max, cclIndex) { + acc.push('
'); + acc.push('
' + M(caption) + '
'); + for (var i = 0; i < data.length && i < max; i++ ) { + acc.push('' + data[i].name + '' + + ' (' + data[i].freq + ')
'); + } + acc.push('
'); +} + +function my_onrecord(data) { + // FIXME: record is async!! + clearTimeout(my_paz.recordTimer); + // in case on_show was faster to redraw element + var detRecordDiv = document.getElementById('mkwsDet_'+data.recid); + if (detRecordDiv) return; + curDetRecData = data; + var recordDiv = document.getElementById('mkwsRecdiv_'+curDetRecData.recid); + var html = renderDetails(curDetRecData); + recordDiv.innerHTML += html; +} + +function my_onbytarget(data) { + var targetDiv = document.getElementById("mkwsBytarget"); + var table ='' + +''; + + for (var i = 0; i < data.length; i++ ) { + table += ""; + } + + table += '
Target IDHitsDiagsRecordsState
" + data[i].id + + "" + data[i].hits + + "" + data[i].diagnostic + + "" + data[i].records + + "" + data[i].state + "
'; + targetDiv.innerHTML = table; +} + +//////////////////////////////////////////////////////////////////////////////// +//////////////////////////////////////////////////////////////////////////////// + +// wait until the DOM is ready +function domReady () +{ + document.mkwsSearchForm.onsubmit = onFormSubmitEventHandler; + document.mkwsSearchForm.mkwsQuery.value = ''; + if (document.mkwsSelect) { + if (document.mkwsSelect.mkwsSort) + document.mkwsSelect.mkwsSort.onchange = onSelectDdChange; + if (document.mkwsSelect.mkwsPerpage) + document.mkwsSelect.mkwsPerpage.onchange = onSelectDdChange; + } +} + +// when search button pressed +function onFormSubmitEventHandler() +{ + resetPage(); + loadSelect(); + triggerSearch(); + switchView('records'); // In case it's configured to start off as hidden + submitted = true; + return false; +} + +function onSelectDdChange() +{ + if (!submitted) return false; + resetPage(); + loadSelect(); + my_paz.show(0, recPerPage, curSort); + return false; +} + +function resetPage() +{ + curPage = 1; + totalRec = 0; +} + +function triggerSearch () +{ + my_paz.search(document.mkwsSearchForm.mkwsQuery.value, recPerPage, curSort, curFilter); +} + +function loadSelect () +{ + if (document.mkwsSelect) { + if (document.mkwsSelect.mkwsSort) + curSort = document.mkwsSelect.mkwsSort.value; + if (document.mkwsSelect.mkwsPerpage) + recPerPage = document.mkwsSelect.mkwsPerpage.value; + } +} + +// limit the query after clicking the facet +function limitQuery (field, value) +{ + document.mkwsSearchForm.query.value += ' and ' + field + '="' + value + '"'; + onFormSubmitEventHandler(); +} + +// limit by target functions +function limitTarget (id, name) +{ + var navi = document.getElementById('mkwsNavi'); + navi.innerHTML = + 'Source: ' + + name + ''; + curFilter = 'pz:id=' + id; + resetPage(); + loadSelect(); + triggerSearch(); + return false; +} + +function delimitTarget () +{ + var navi = document.getElementById('mkwsNavi'); + navi.innerHTML = ''; + curFilter = null; + resetPage(); + loadSelect(); + triggerSearch(); + return false; +} + +function drawPager (pagerDiv) +{ + //client indexes pages from 1 but pz2 from 0 + var onsides = 6; + var pages = Math.ceil(totalRec / recPerPage); + + var firstClkbl = ( curPage - onsides > 0 ) + ? curPage - onsides + : 1; + + var lastClkbl = firstClkbl + 2*onsides < pages + ? firstClkbl + 2*onsides + : pages; + + var prev = '<< ' + M('Prev') + ' | '; + if (curPage > 1) + prev = '' + +'<< ' + M('Prev') + ' | '; + + var middle = ''; + for(var i = firstClkbl; i <= lastClkbl; i++) { + var numLabel = i; + if(i == curPage) + numLabel = '' + i + ''; + + middle += ' ' + + numLabel + ' '; + } + + var next = ' | ' + M('Next') + ' >>'; + if (pages - curPage > 0) + next = ' | ' + + M('Next') + ' >>'; + + var predots = ''; + if (firstClkbl > 1) + predots = '...'; + + var postdots = ''; + if (lastClkbl < pages) + postdots = '...'; + + pagerDiv.innerHTML += '
' + + prev + predots + middle + postdots + next + '
'; +} + +function showPage (pageNum) +{ + curPage = pageNum; + my_paz.showPage( curPage - 1 ); +} + +// simple paging functions + +function pagerNext() { + if ( totalRec - recPerPage*curPage > 0) { + my_paz.showNext(); + curPage++; + } +} + +function pagerPrev() { + if ( my_paz.showPrev() != false ) + curPage--; +} + +// switching view between targets and records + +function switchView(view) { + var targets = document.getElementById('mkwsTargets'); + var results = document.getElementById('mkwsResults') || + document.getElementById('mkwsRecords'); + var blanket = document.getElementById('mkwsBlanket'); + var motd = document.getElementById('mkwsMOTD'); + + switch(view) { + case 'targets': + if (targets) targets.style.display = "block"; + if (results) results.style.display = "none"; + if (blanket) blanket.style.display = "none"; + if (motd) motd.style.display = "none"; + break; + case 'records': + if (targets) targets.style.display = "none"; + if (results) results.style.display = "block"; + if (blanket) blanket.style.display = "block"; + if (motd) motd.style.display = "none"; + break; + case 'none': + if (targets) targets.style.display = "none"; + if (results) results.style.display = "none"; + if (blanket) blanket.style.display = "none"; + if (motd) motd.style.display = "none"; + break; + default: + alert("Unknown view '" + view + "'"); + } +} + +// detailed record drawing +function showDetails (prefixRecId) { + var recId = prefixRecId.replace('mkwsRec_', ''); + var oldRecId = curDetRecId; + curDetRecId = recId; + + // remove current detailed view if any + var detRecordDiv = document.getElementById('mkwsDet_'+oldRecId); + // lovin DOM! + if (detRecordDiv) + detRecordDiv.parentNode.removeChild(detRecordDiv); + + // if the same clicked, just hide + if (recId == oldRecId) { + curDetRecId = ''; + curDetRecData = null; + return; + } + // request the record + my_paz.record(recId); +} + +function replaceHtml(el, html) { + var oldEl = typeof el === "string" ? document.getElementById(el) : el; + /*@cc_on // Pure innerHTML is slightly faster in IE + oldEl.innerHTML = html; + return oldEl; + @*/ + var newEl = oldEl.cloneNode(false); + newEl.innerHTML = html; + oldEl.parentNode.replaceChild(newEl, oldEl); + /* Since we just removed the old element from the DOM, return a reference + to the new element, which can be used to restore variable references. */ + return newEl; +}; + +function renderDetails(data, marker) +{ + var details = '
'; + if (marker) details += ''; + + details += renderField("Title", data["md-title"], data["md-title-remainder"], data["md-title-responsibility"]); + details += renderField("Date", data["md-date"]); + details += renderField("Author", data["md-author"]); + details += renderField("URL", data["md-electronic-url"]); + details += renderField("Subject", data["location"][0]["md-subject"]); + details += renderField("Location", data["location"][0]["@name"], data["location"][0]["@id"]); + details += '
'+ marker + '
'; + + return details; +} + +function renderField(caption, data, data2, data3) { + if (data === undefined) { + return ""; + } + + if (caption == "URL") { + data = '' + data + ''; + } + + if (data2 != undefined) { + data = data + " (" + data2 + ")"; + } + + if (data3 != undefined) { + data = data + " " + data3 + ""; + } + + return '' + M(caption) + '' + data + ''; +} + + +/* + * All the HTML stuff to render the search forms and + * result pages. + */ +function mkws_html_all(config) { + + /* default mkws config */ + var mkws_config_default = { + sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]], + perpage: [10, 20, 30, 50], + sort_default: "relevance", + perpage_default: 20, + query_width: 50, + switch_menu: false, /* show/hide Records|Targets menu */ + lang_menu: true, /* show/hide language menu */ + sort_menu: true, /* show/hide sort menu */ + perpage_menu: true, /* show/hide perpage menu */ + lang_display: [], /* display languages links for given languages, [] for all */ + facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */ + responsive_design_width: 980, /* a page with less pixel width considered as mobile */ + debug: 1, /* debug level for development: 0..2 */ + + dummy: "dummy" + }; + + /* set global debug flag early */ + if (typeof config.debug !== 'undefined') { + mkws_debug = config.debug; + } else if (typeof mkws_config_default.debug !== 'undefined') { + mkws_debug = mkws_config_default.debug; + } + + /* override standard config values by function parameters */ + for (var k in mkws_config_default) { + if (typeof config[k] === 'undefined') + mkws_config[k] = mkws_config_default[k]; + debug("Set config: " + k + ' => ' + mkws_config[k]); + } + + if (mkws_config.query_width < 5 || mkws_config.query_width > 150) { + debug("Reset query width: " + mkws_config.query_width); + mkws_config.query_width = 50; + } + + mkws_set_lang(mkws_config); + if (mkws_config.lang_menu) + mkws_html_lang(mkws_config); + + // For some reason, doing this programmatically results in + // document.mkwsSearchForm.mkwsQuery being undefined, hence the raw HTML. + debug("HTML search form"); + $("#mkwsSearch").html('\ +
\ + \ + \ +
'); + + debug("HTML records"); + // If the application has an #mkwsResults, populate it in the + // usual way. If not, assume that it's a smarter application that + // defines its own subcomponents: + // #mkwsTermlists + // #mkwsRanking + // #mkwsPager + // #mkwsNavi + // #mkwsRecords + if ($("#mkwsResults").length) { + $("#mkwsResults").html('\ + \ + \ + \ + \ + \ +
\ +
\ +
\ +
\ +
\ +
\ +
\ +
'); + } + + if ($("#mkwsRanking").length) { + var ranking_data = ''; + ranking_data += '
'; + if (config.sort_menu) { + ranking_data += M('Sort by') + ' ' + mkws_html_sort(config) + ' '; + } + if (config.perpage_menu) { + ranking_data += M('and show') + ' ' + mkws_html_perpage(config) + ' ' + M('per page') + '.'; + } + ranking_data += '
'; + + $("#mkwsRanking").html(ranking_data); + } + + mkws_html_switch(config); + + if (mkws_config.use_service_proxy) + mkws_service_proxy_auth(config.service_proxy_auth); + + if (mkws_config.responsive_design) + mkws_responsive_design(); + + domReady(); + + // on first page, hide the termlist + $(document).ready(function() { $("#mkwsTermlists").hide(); } ); + var motd = document.getElementById("mkwsMOTD"); + var container = document.getElementById("mkwsMOTDContainer"); + if (motd && container) { + // Move the MOTD from the provided element down into the container + motd.parentNode.removeChild(motd); + container.appendChild(motd); + } +} + +/* Responsive web design - change layout on the fly depending on + * the current screen size width/height. Required for mobile devices. + */ +function mkws_responsive_design () { + var timeout = null; + + $(window).resize( function(e) { + if (timeout) + clearTimeout(timeout); + timeout = setTimeout(function () { mkws_mobile_resize() }, 50); + }); + + // initial check after page load + $(document).ready(function() { mkws_mobile_resize() }); +} + +function mkws_set_lang(mkws_config) { + var lang = jQuery.parseQuerystring().lang || mkws_config.lang || ""; + if (!lang || !mkws_locale_lang[lang]) { + mkws_config.lang = "" + } else { + mkws_config.lang = lang; + } + + debug("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none")); + return mkws_config.lang; +} + +function mkws_html_switch(config) { + debug("HTML switch"); + + $("#mkwsSwitch").html($("", { + href: '#', + onclick: "switchView(\'records\')", + text: M("Records") + })); + $("#mkwsSwitch").append($("", { text: " | " })); + $("#mkwsSwitch").append($("", { + href: '#', + onclick: "switchView(\'targets\')", + text: M("Targets") + })); + + debug("HTML targets"); + $("#mkwsTargets").html('\ +
\ + No information available yet.\ +
'); + $("#mkwsTargets").css("display", "none"); + + if (!config.switch_menu) { + debug("disable switch menu"); + $("#mkwsSwitch").css("display", "none"); + } +} + +function mkws_html_sort(config) { + debug("HTML sort"); + var sort_html = ''; + + return sort_html; +} + +function mkws_html_perpage(config) { + debug("HTML perpage"); + var perpage_html = ''; + + return perpage_html; +} + +/* + * Run service-proxy authentication in background (after page load). + * The username/password is configured in the apache config file + * for the site. + */ +function mkws_service_proxy_auth(auth_url) { + if (!auth_url) + auth_url = "http://mkws.indexdata.com/service-proxy-auth"; + + debug("Run service proxy auth URL: " + auth_url); + + var request = new pzHttpRequest(auth_url); + request.get(null, function(data) { + if (!jQuery.isXMLDoc(data)) { + alert("service proxy auth response document is not valid XML document, give up!"); + return; + } + var status = $(data).find("status"); + if (status.text() != "OK") { + alert("service proxy auth repsonse status: " + status.text() + ", give up!"); + return; + } + }); +} + +/* create locale language menu */ +function mkws_html_lang(mkws_config) { + var lang_default = "en"; + var lang = mkws_config.lang || lang_default; + var list = []; + + /* display a list of configured languages, or all */ + var lang_display = mkws_config.lang_display || []; + var hash = {}; + for (var i = 0; i < lang_display.length; i++) { + hash[lang_display[i]] = 1; + } + + for (var k in mkws_locale_lang) { + if (hash[k] == 1 || lang_display.length == 0) + list.push(k); + } + + // add english link + if (lang_display.length == 0 || hash[lang_default] == 1) + list.push(lang_default); + + debug("Language menu for: " + list.join(", ")); + + /* the HTML part */ + var data = ""; + for(var i = 0; i < list.length; i++) { + var l = list[i]; + + if (data) + data += ' | '; + + if (lang == l) { + data += ' ' + l + ' '; + } else { + data += '
' + l + ' ' + } + } + + $("#mkwsLang").html(data); +} + +function mkws_mobile_resize () { + debug("resize width: " + $(window).height() + ", width: " + $(window).width()); + var list = ["mkwsSwitch"]; + var obj; + // alert($(window).width()); + + var width = mkws_config.responsive_design_width || 980; + + if ($(window).width() <= width) { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).hide(); + } + + $("#mkwsTermlists").hide(); + obj = $("#mkwsTermlists").html(); + $("#mkwsShiftedTermlists").html(obj); + } else { + for(var i = 0; i < list.length; i++) { + $("#" + list[i]).show(); + } + $("#mkwsTermlists").show(); + $("#mkwsShiftedTermlists").html(""); + } +}; + +/* locale */ +function M(word) { + var lang = mkws_config.lang; + + if (!lang || !mkws_locale_lang[lang]) + return word; + + return mkws_locale_lang[lang][word] ? mkws_locale_lang[lang][word] : word; +} + +/* implement jQuery.parseQuerystring() for parsing URL parameters */ +jQuery.extend({ + parseQuerystring: function() { + var nvpair = {}; + var qs = window.location.search.replace('?', ''); + var pairs = qs.split('&'); + $.each(pairs, function(i, v){ + var pair = v.split('='); + nvpair[pair[0]] = pair[1]; + }); + return nvpair; + }, + pazpar2: function(data) { + document.write('
\ +
\ +
\ +
\ +
\ +
\ +
\ + Powered by MKWS © 2013 Index Data\ +
'); + + mkws_html_all(mkws_config); + } +}); + +function debug(string) { + if (!mkws_debug) + return; + + if (typeof console === "undefined" || typeof console.log === "undefined") { /* ARGH!!! old IE */ + return; + } + + // you need to disable use strict at the top of the file!!! + if (mkws_debug >= 3) { + console.log(arguments.callee.caller); + } else if (mkws_debug >= 2) { + console.log(">>> called from function " + arguments.callee.caller.name + ' <<<'); + } + console.log(string); +} + +/* magic */ +$(document).ready(function() { mkws_html_all(mkws_config) }); diff --git a/tools/htdocs/mkwsStyle.css b/tools/htdocs/mkwsStyle.css new file mode 100644 index 0000000..1571da7 --- /dev/null +++ b/tools/htdocs/mkwsStyle.css @@ -0,0 +1,196 @@ +#mkwsLang, +#mkwsSwitch, +#mkwsSearch, +#mkwsTermlists, +#mkwsRanking, +#mkwsPager, +#mkwsNavi, +#mkwsRecords, +#mkwsTargets, +#mkwsStat, +#mkwsShiftedTermlists, +#mkwsMOTD { + font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Verdana, Sans-Serif; +} + +#mkwsLang { + float: left; + padding-left: 1em; + padding-top: 0.4em; +} + +#mkwsLang a { + background: #d0e0ff; + padding: 1px 4px; +} + +#mkwsLang span { + border: solid 1px #d0e0ff; + padding: 0px 3px; +} + +#mkwsSearch { + float: right; +} + +#mkwsSwitch { + float: right; + padding-left: 1em; + padding-top: 0.4em; +} + +#mkwsTargets { + background-color: #fafafa; +} + +#mkwsStat { + margin-top: 10px; + border-top: 1px solid #156a16; + padding-top: 5px; + font-size: small; +} + +#mkwsStat span.head { + font-weight: bold; +} + +#mkwsStat span.clients:before { + content: "Active clients: "; +} + +#mkwsStat span.records:before { + content: "Retrieved records: "; +} + +#mkwsSwitch a, +#mkwsLang a, +#mkwsTermlists a, +#mkwsRanking a, +#mkwsPager a, +#mkwsNavi a, +#mkwsRecords a, +#mkwsShiftedTermlists a { + color: #005701; + text-decoration: none; +} + +#mkwsSwitch a:hover, +#mkwsLang a:hover, +#mkwsTermlists a:hover, +#mkwsPager a:hover, +#mkwsRecords a:hover, +#mkwsShiftedTermlists a:hover { + text-decoration: underline; +} + +#mkwsNavi a.crossout:hover { + text-decoration: line-through; +} + +#mkwsSearch input#mkwsButton { + border: 3px outset #132194; + background-color: #132194; + padding: 2px; + width: 6em; + color: #FFFFFF; + font-weight: bold; + text-transform: uppercase; + font-size: 10px; + margin-left: 8px; + cursor: pointer; +} + +#mkwsSearch input#mkwsQuery { + border: 2px inset #e0f0ff; + padding: 3px; + font-size: 12px; + background: #f0f8ff; +} + +#mkwsTermlists .title, +#mkwsShiftedTermlists .title { + font-size: large; + font-weight: bold; + text-transform: uppercase; +} + +#mkwsTermlists, +#mkwsShiftedTermlists div#termlist { + background: #d0e0ff; + padding: 0.7em; + font-size: small; + + border-top-right-radius: 10px; + -moz-border-top-right-radius: 10px; + -webkit-border-top-right-radius: 10px; +} + +#mkwsTermlists div.facet, +#mkwsShiftedTermlists div.facet { + background: #e0f0ff; + padding: 0.7em; + margin-top: 0.7em; + + border-top-right-radius: 10px; + -moz-border-top-right-radius: 10px; + -webkit-border-top-right-radius: 10px; +} + +#mkwsTermlists div.termtitle, +#mkwsShiftedTermlists div.termtitle { + font-weight: bold; +} + +#mkwsRecords div.record, +#mkwsShiftedTermlists div.record { + padding: 5px; +} + +#mkwsRecords div.details { + border: 1px solid #404040; + background: #e8e8e8; + color: darkgray; + padding: 5px 10px; + margin: 10px 0px; + box-shadow: 10px 10px 5px #808080; + + border-top-right-radius: 10px; + -moz-border-top-right-radius: 10px; + -webkit-border-top-right-radius: 10px; +} + +#mkwsRecords div.details th, +#mkwsShiftedTermlists div.details th { + text-align: right; + vertical-align: top; + padding-right: 0.6em; +} + +#mkwsRecords div.details th:after, +#mkwsShiftedTermlists div.details th:after { + content: ":"; +} + +#mkwsPager { + background: #e0e0e0; + padding: 0.3em; +} + +#mkwsBytarget table thead tr td { + background-color: #132194; + color: white; + font-weight: bold; + padding: 0.2em 0.5em; +} + +#mkwsBytarget table tbody tr:nth-child(odd) { + background-color: #e0f0ff; +} + +#mkwsBytarget table tbody tr:nth-child(even) { + background-color: #d0e0ff; +} + +#mkwsBytarget table tbody tr td { + padding: 0.2em 0.5em; +} diff --git a/tools/mod_perl/MyApache2/CopyCookie.pm b/tools/mod_perl/MyApache2/CopyCookie.pm new file mode 100644 index 0000000..3e29647 --- /dev/null +++ b/tools/mod_perl/MyApache2/CopyCookie.pm @@ -0,0 +1,41 @@ +package MyApache2::CopyCookie; + +use Apache2::Filter (); +use Apache2::RequestRec (); +use APR::Table (); + +use Apache2::Const -compile => qw(OK); + +use constant BUFF_LEN => 1024; + +sub handler { + my $f = shift; + + # If the server generated a new cookie, make it available in a + # header other than the magic "Cookie" that clients can't read. + my $ho = $f->r->headers_out; + my $cookie = $ho->get('Set-Cookie'); + if (defined $cookie && $cookie ne "") { + $ho->set('X-Set-Cake', $cookie); + } + + # If the client sent an existing cookie as X-Cake, but didn't + # set Cookie, copy the former to the latter. + my $hi = $f->r->headers_in; + $cookie = $hi->get('Cookie'); + if (!defined $cookie || $cookie eq "") { + $cookie = $hi->get('X-Cake'); + if (defined $cookie && $cookie ne "") { + warn "copying X-Cake '$cookie' to Cookie"; + $hi->set('Cookie', $cookie); + } + } + + while ($f->read(my $buffer, BUFF_LEN)) { + $f->print($buffer); + } + + return Apache2::Const::OK; +} + +1; diff --git a/tools/mod_perl/MyApache2/SetACAO.pm b/tools/mod_perl/MyApache2/SetACAO.pm new file mode 100644 index 0000000..66334fc --- /dev/null +++ b/tools/mod_perl/MyApache2/SetACAO.pm @@ -0,0 +1,30 @@ +package MyApache2::SetACAO; + +use Apache2::Filter (); +use Apache2::RequestRec (); +use APR::Table (); + +use Apache2::Const -compile => qw(OK); + +use constant BUFF_LEN => 1024; + +sub handler { + my $f = shift; + + # If the client generated an Origin header, echo its content back + # in an ACAO header. This is better than just using *, since it + # doesnt prevent credentials from being accepted. + my $origin = $f->r->headers_in->get('Origin'); + if (defined $origin && $origin ne "") { + $f->r->headers_out->set('Access-Control-Allow-Origin', $origin); + warn "MyApache2::SetACAO copied Origin '$origin' to ACAO"; + } + + while ($f->read(my $buffer, BUFF_LEN)) { + $f->print($buffer); + } + + return Apache2::Const::OK; +} + +1;