/*
 * rest-annotate.js
 * REST implementation of the connection to the annotation back-end
 *
 * Marginalia has been developed with funding and support from
 * BC Campus, Simon Fraser University, and the Government of
 * Canada, the UNDESA Africa i-Parliaments Action Plan, and  
 * units and individuals within those organizations.  Many 
 * thanks to all of them.  See CREDITS.html for details.
 * Copyright (C) 2005-2007 Geoffrey Glass; the United Nations
 * http://www.geof.net/code/annotation
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * $Id: rest-annotate.js 340 2008-11-30 06:50:46Z geof.glass $
 */

// If this is true, uses paths like annotate/nnn
// if false, use paths like annotation/annotate.php?id=nnn
ANNOTATION_NICE_URLS = false;


/**
 * Oops.  This didn't conform to the URI spec - all those nice juice characters are
 * reserved.  So now all it does is replace %20 with + to make URIs easier to read.
 *
 * I'm tired of the standard Javascript encodeURIComponent encoding slashes
 * and colons in query parameters.  This makes debugging information difficult
 * to read, and there's really no point to it (at least for URI parameters).  
 * This function uses encodeURIComponent, then converts back some translations 
 * to make everything easier to read and debug.
 */
function encodeURIParameter( s )
{
	s = encodeURIComponent( s );
//	s = s.replace( /%2[fF]/g, '/' );
//	s = s.replace( /%3[aA]/g, ':' );
	//	s = s.replace( /%20/g, '+' );
//	s = s.replace( /%5[bB]/g, '[' );
//	s = s.replace( /%5[dD]/g, ']' );
//	s = s.replace( /%2[cC]/g, ',' );
//	s = s.replace( /%3[bB]/g, ';' );
	return s;
}


/**
 * Initialize the REST annotation service
 */
function RestAnnotationService( serviceUrl, features )
{
	this.serviceUrl = serviceUrl;
	this.niceUrls = false;
	this.noPutDelete = false;
	
	if ( features )
	{
		for ( feature in features )
		{
			value = features[ feature ];
			switch ( feature )
			{
				// Name of cookie to use for preventing cross-site request forgery
				case 'csrfCookie':
					this.csrfCookie = value;
					break;
				
				// Use nice service URLs (currently unsupported)
				case 'niceUrls':
					this.niceUrls = value;
					break;
					
				// Use HTTP POST instead of PUT and DELETE.  In this case, the operation can be determined as follows:
				//   create:  no id or search parameters in URL, body contains new annotation data
				//   delete: id in URL with no body
				//   update:  id in URL, body contains new annotation data
				//   bulkUpdate:  search parameters in URL, body contains substitution data
				// Why not pass method=PUT or method=DELETE in body or URL?
				// - in URL is incorrect as this does not help identify the resource
				// - in body is incorrect if mime type is not application/x-www-url-encoded;  makes no sense in XML body
				case noPutDelete:
					this.noPutDelete = value;
					break;
					
				default:
					if ( typeof( this[ feature ] ) != 'undefined' )
						throw 'Attempt to override feature: ' + feature;
					else
						this[ feature ] = value;
			}
		}
	}
}


/**
 * Fetch a list of annotated blocks
 */
RestAnnotationService.prototype.listBlocks = function( url, f )
{
	var serviceUrl = this.serviceUrl + '?format=blocks&url=' + encodeURIParameter( url );
	
	// For demo debugging only
	if ( window.marginalia && window.marginalia.userInRequest )
		serviceUrl += '&curuser=' + encodeURIParameter( window.marginalia.loginUserId );
	
	var xmlhttp = domutil.createAjaxRequest( );
	xmlhttp.open( 'GET', serviceUrl );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.onreadystatechange = function( ) {
		if ( xmlhttp.readyState == 4 ) {
			if ( xmlhttp.status == 200 ) {
				if ( null != f )
				{
					trace( 'block-users-xml', "listBlocks result:\n" + xmlhttp.responseText );
					// alert( serviceUrl + "\n" + xmlhttp.responseText );
					f( xmlhttp.responseXML );
				}
			}
			else {
				trace( "listBlocks Server request failed with code " + xmlhttp.status + ":\n" + serviceUrl );
			}
			xmlhttp = null;
		}
	}
	// Decode the URI to make it easier to read and debug
	trace( 'annotation-service', "AnnotationService.listBlocks " + decodeURI( serviceUrl ));
	xmlhttp.send( null );
}


/**
 * Fetch a list of annotations from the server
 */
RestAnnotationService.prototype.listAnnotations = function( url, userid, block, f )
{
	// exclude content to lighten the size across the wire
	var serviceUrl = this.serviceUrl;
	serviceUrl += '?format=atom';
	if ( block )
		serviceUrl += '&block=' + encodeURIParameter( block );
	if ( userid )
		serviceUrl += '&user=' + encodeURIParameter( userid );
	serviceUrl += '&url=' + encodeURIParameter( url );
	
	// For demo debugging only
	if ( window.marginalia && window.marginalia.userInRequest )
		serviceUrl += '&curuser=' + encodeURIParameter( window.marginalia.loginUserId );

	var xmlhttp = domutil.createAjaxRequest( );
	xmlhttp.open( 'GET', serviceUrl );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.onreadystatechange = function( ) {
		if ( xmlhttp.readyState == 4 ) {
			if ( xmlhttp.status == 200 ) {
				if ( null != f )
				{
					trace( 'list-annotations-xml', "listAnnotations result:\n" + xmlhttp.responseText );
					// alert( serviceUrl + "\n" + xmlhttp.responseText );
					f( xmlhttp.responseXML );
				}
			}
			else {
				trace( "ListAnnotations Server request failed with code " + xmlhttp.status + ":\n" + serviceUrl );
			}
			xmlhttp = null;
		}
	}
	trace( 'annotation-service', "AnnotationService.listAnnotations " + decodeURI( serviceUrl ) );
	xmlhttp.send( null );
}

/**
 * Create an annotation on the server
 * When successful, calls a function f with one parameter:  the URL of the created annotation
 */
RestAnnotationService.prototype.createAnnotation = function( annotation, f )
{
	var serviceUrl = this.serviceUrl;
	// For demo debugging only
	if ( window.marginalia && window.marginalia.userInRequest )
		serviceUrl += '?curuser=' + encodeURIParameter( window.marginalia.loginUserId );
	var body
		= 'url=' + encodeURIParameter( annotation.getUrl() )
		+ '&note=' + encodeURIParameter( annotation.getNote() )
		+ '&access=' + encodeURIParameter( annotation.getAccess() )
		+ '&quote=' + encodeURIParameter( annotation.getQuote() )
		//+ '&quote_title=' + encodeURIParameter( annotation.getQuoteTitle() )
		+ '&quote_title=' + annotation.getQuoteTitle() 
		+ '&quote_author_id=' + encodeURIParameter( annotation.getQuoteAuthorId() )
		+ '&quote_author_name=' + encodeURIParameter( annotation.getQuoteAuthorName() )
		+ '&link=' + encodeURIParameter( annotation.getLink() )
		+ '&userid=' + encodeURIParameter( annotation.getUserId() );
	// userid shouldn't be trusted by the server of course, except for demo applications for
	// which it can be useful.
		
	if ( annotation.getAction() )
		body += '&action=' + encodeURIParameter (annotation.getAction() );
	if ( annotation.getSequenceRange( ) )
		body += '&sequence-range=' + encodeURIParameter( annotation.getSequenceRange( ).toString( ) );
	if ( annotation.getXPathRange( ) )
		body += '&xpath-range=' + encodeURIParameter( annotation.getXPathRange( ).toString( ) );
	if ( annotation.getLinkTitle( ) )
		+ '&linkTitle=' + encodeURIParameter( annotation.getLinkTitle( ) );

	// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
		body += '&' + encodeURIComponent( this.csrfCookie ) + '=' + encodeURIParameter( readCookie( this.csrfCookie ) );
		
	// May need to pass method name instead of using PUT or DELETE
	if ( this.noPutDelete )
		serviceUrl += '&method=POST';
	
	var xmlhttp = domutil.createAjaxRequest( );
	
	xmlhttp.open( 'POST', serviceUrl, true );
	xmlhttp.setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8' );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.setRequestHeader( 'Content-length', body.length );
	xmlhttp.onreadystatechange = function( ) {
		if ( xmlhttp.readyState == 4 ) {
			// No need for Safari hack, since Safari can't create annotations anyway.
			if ( xmlhttp.status == 201 ) {
				var url = xmlhttp.getResponseHeader( 'Location' );
				if ( null != f )
				{
					trace( 'annotation-service', 'Create annotation body: ' + xmlhttp.responseText );
					f( url );
				}
			}
			else {
				logError( "AnnotationService.createAnnotation failed with code " + xmlhttp.status + ":\n" + serviceUrl + "\n" + xmlhttp.responseText );
			}
			xmlhttp = null;
		}
	}
	trace( 'annotation-service', "AnnotationService.createAnnotation " + decodeURI( serviceUrl ) + "\n" + body );
	xmlhttp.send( body );
}

/**
 * Update an annotation on the server
 * Only updates the fields that have changed
 */
RestAnnotationService.prototype.updateAnnotation = function( annotation, f )
{
	var serviceUrl = this.serviceUrl;
	serviceUrl += this.niceUrls ? ( '/' + annotation.getId() ) : ( '?id=' + annotation.getId() );
	
//	if ( window.marginalia && window.marginalia.userInRequest )
		serviceUrl += '&curuser=' + encodeURIParameter( window.marginalia.loginUserId );

	var body = '';
	if ( annotation.hasChanged( 'note' )  )
		body = 'note=' + encodeURIParameter( annotation.getNote() );
	if ( annotation.hasChanged( 'access' ) )
		body += ( body == '' ? '' : '&' ) + 'access=' + encodeURIParameter( annotation.getAccess() );
	if ( annotation.hasChanged( 'link' ) )
		body += ( body == '' ? '' : '&' ) + 'link=' + encodeURIParameter( annotation.getLink() );
	if ( annotation.hasChanged( 'linkTitle' ) )
		body += ( body == '' ? '' : '&' ) + 'link_title=' + encodeURIParameter( annotation.getLinkTitle( ) );
	if ( annotation.hasChanged( 'range/sequence' ) )
		body += '&sequence-range=' + encodeURIParameter( annotation.getSequenceRange( ).toString( ) );
	if ( annotation.hasChanged( 'range/xpath' ) )
		body += '&xpath-range=' + encodeURIParameter( annotation.getXPathRange( ).toString( ) );

// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
		body += '&' + encodeURIComponent( this.csrfCookie ) + '=' + encodeURIParameter( readCookie( this.csrfCookie ) );

	// May need to pass method name instead of using PUT or DELETE
	var method = 'PUT';
	if ( this.noPutDelete )
	{
		serviceUrl += '&method=PUT';
		method = 'POST';
	}
	
	var xmlhttp = domutil.createAjaxRequest( );
	xmlhttp.open( method, serviceUrl, true );
	xmlhttp.setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8' );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.setRequestHeader( 'Content-length', body.length );
	xmlhttp.onreadystatechange = function( ) {
		if ( xmlhttp.readyState == 4 ) {
			// Safari is braindead here:  any status code other than 200 is converted to undefined
			// IE invents its own 1223 status code
			// See http://www.trachtenberg.com/blog/?p=74
			if ( 204 == xmlhttp.status || xmlhttp.status == null || xmlhttp.status == 1223 ) {
				if ( null != f )
					f( xmlhttp.responseXML );
			}
			else
				logError( "AnnotationService.updateAnnotation failed with code " + xmlhttp.status + " (" + xmlhttp.statusText + ")\n" + xmlhttp.statusText + "\n" + xmlhttp.responseText );
			xmlhttp = null;
		}
	}
	trace( 'annotation-service', "AnnotationService.updateAnnotation " + decodeURI( serviceUrl ) );
	trace( 'annotation-service', "  " + body );
	xmlhttp.send( body );
}


/**
 * Update multiple annotations at once
 * The method signature will likely change in future;  for now it only deals with updates to
 * the note field.
 */
RestAnnotationService.prototype.bulkUpdate = function( oldNote, newNote, f )
{
	var serviceUrl = this.serviceUrl;
	serviceUrl += '?note=' + encodeURIComponent( oldNote );
		
	var body = 'note=' + encodeURIComponent( newNote );
		
	// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
		body += '&' + encodeURIComponent( this.csrfCookie ) + '=' + encodeURIComponent( readCookie( this.csrfCookie ) );

	// May need to pass method name instead of using PUT or DELETE
	var method = 'PUT';
	if ( this.noPutDelete )
	{
		serviceUrl += '&method=PUT';
		method = 'POST';
	}
	
	var xmlhttp = domutil.createAjaxRequest( );
	
	// This use of PUT is suspect, as it does not send a full representation of the resource -
	// instead it sends a delta for the resource (or rather for child resources of which this
	// resource is composed)
	xmlhttp.open( method, serviceUrl, true );
	xmlhttp.setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8' );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.setRequestHeader( 'Content-length', body.length );
	xmlhttp.onreadystatechange = function( ) {
		if ( xmlhttp.readyState == 4 ) {
			// No need for Safari hack, since Safari can't create annotations anyway.
			if ( xmlhttp.status == 200 ) {
				var url = xmlhttp.getResponseHeader( 'Location' );
				if ( null != f )
				{
					trace( 'annotation-service', 'Create annotation body: ' + xmlhttp.responseText );
					f( xmlhttp.responseText, url );
				}
			}
			else {
				logError( "AnnotationService.bulkUpdate failed with code " + xmlhttp.status + ":\n" + serviceUrl + "\n" + xmlhttp.responseText );
			}
			xmlhttp = null;
		}
	}
	trace( 'annotation-service', "AnnotationService.bulkUpdate " + decodeURI( serviceUrl ) + "\n" + body );
	xmlhttp.send( body );
}


/**
 * Delete an annotation on the server
 */
RestAnnotationService.prototype.deleteAnnotation = function( annotationId, f )
{
	var serviceUrl = this.serviceUrl;
	var hasParams = false;
	
	if ( this.niceUrls )
		serviceUrl += '/' + annotationId;
	else
	{
		serviceUrl += '?id=' + annotationId;
		hasParams = true;
	}
	
	// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
	{
		serviceUrl += ( hasParams ? '&' : '?' )
			+ encodeURIComponent( this.csrfCookie ) + '=' + encodeURIComponent( readCookie( this.csrfCookie ) );
		hasParams = true;
	}

	// For demo debugging only
	if ( window.marginalia && window.marginalia.userInRequest )
	{
		serviceUrl += ( hasParams ? '&' : '?' )
			+ 'curuser=' + encodeURIParameter( window.marginalia.loginUserId );
		hasParams = true;
	}
	
	// May need to pass method name instead of using PUT or DELETE
	var method = 'DELETE';
	if ( this.noPutDelete )
	{
		serviceUrl += ( hasParams ? '&' : '?' ) + 'method=DELETE';
		method = 'POST';
	}
	
	var xmlhttp = domutil.createAjaxRequest( );
	xmlhttp.open( method, serviceUrl, true );
	
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.onreadystatechange = function( ) {
		if ( xmlhttp.readyState == 4 ) {
			// Safari is braindead here:  any status code other than 200 is converted to undefined
			// IE invents its own 1223 status code
			if ( 204 == xmlhttp.status || xmlhttp.status == null || xmlhttp.status == 1223 ) {
				if ( null != f )
					f( xmlhttp.responseXML );
			}
			else
				logError( "AnnotationService.deleteAnnotation failed with code " + xmlhttp.status + "\n" + xmlhttp.responseText );
			xmlhttp = null;
		}
	}
	trace( 'annotation-service', "AnnotationService.deleteAnnotation " + decodeURI( serviceUrl ) );
	xmlhttp.send( null );
}





/**
 * Create an bookmark on the server
 * When successful, calls a function f with one parameter:  the URL of the created annotation
 */
RestAnnotationService.prototype.addToBookmark = function( annotation, f )
{
	//var serviceUrl = this.serviceUrl;
	var serviceUrl = '/bookmark.php';
	// For demo debugging only
	if ( window.marginalia && window.marginalia.userInRequest )
		serviceUrl += '?curuser=' + encodeURIParameter( window.marginalia.loginUserId );

	var body
		= 'url=' + encodeURIParameter( annotation.getUrl() )
		+ '&note=' + encodeURIParameter( annotation.getNote() )
		+ '&access=' + encodeURIParameter( annotation.getAccess() )
		+ '&quote=' + encodeURIParameter( annotation.getQuote() )
		+ '&quote_title=' + encodeURIParameter( annotation.getQuoteTitle() )
		+ '&quote_author_id=' + encodeURIParameter( annotation.getQuoteAuthorId() )
		+ '&quote_author_name=' + encodeURIParameter( annotation.getQuoteAuthorName() )
		+ '&link=' + encodeURIParameter( annotation.getLink())
		+ '&userid=' + encodeURIParameter( annotation.getUserId() );
	// userid shouldn't be trusted by the server of course, except for demo applications for
	// which it can be useful.
	var tempId = annotation.getLink();	
	var bookmarkid = tempId.substring( tempId.lastIndexOf( '#' ) + 1 );
	    bookmarkid = bookmarkid + "_bk";
	    if ( annotation.getAction() )
		body += '&action=' + encodeURIParameter (annotation.getAction() );
	if ( annotation.getSequenceRange( ) )
		body += '&sequence-range=' + encodeURIParameter( annotation.getSequenceRange( ).toString( ) );
	if ( annotation.getXPathRange( ) )
		body += '&xpath-range=' + encodeURIParameter( annotation.getXPathRange( ).toString( ) );
	if ( annotation.getLinkTitle( ) )
		+ '&linkTitle=' + encodeURIParameter( annotation.getLinkTitle( ) );

	// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
		body += '&' + encodeURIComponent( this.csrfCookie ) + '=' + encodeURIParameter( readCookie( this.csrfCookie ) );
		
	// May need to pass method name instead of using PUT or DELETE
	if ( this.noPutDelete )
		serviceUrl += '&method=POST';
	
	

	//var tempstr = document.getElementById(bookmarkid);


	var xmlhttp = domutil.createAjaxRequest( );
	
	xmlhttp.open( 'POST', serviceUrl, true );
	xmlhttp.setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8' );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.setRequestHeader( 'Content-length', body.length );
	xmlhttp.onreadystatechange = function( ) {
		if ( xmlhttp.readyState == 4 ) {
			// No need for Safari hack, since Safari can't create annotations anyway.
			if ( xmlhttp.status == 201 ) {
		document.getElementById(bookmarkid).innerHTML="<img src=\"/oso/public/all_images/savedbookmark.jpg\" title=\"remove bookmark\" onclick=\"myClickRemoveBookmark(event,'"+ tempId +"')\">";

			}
			else {
				logError( "AnnotationService.addToBookmark failed with code " + xmlhttp.status + ":\n" + serviceUrl + "\n" + xmlhttp.responseText );
			}
			xmlhttp = null;
		}
	}
	//trace( 'bookmark-service', "AnnotationService.addToBookmark " + decodeURI( serviceUrl ) + "\n" + body );
	xmlhttp.send( body );
}


/**
* Remove an bookmark on the server
* When successful, calls a function f with one parameter:  the URL of the created annotation
*/
RestAnnotationService.prototype.removeBookmark = function( annotation, f )
{
	//var serviceUrl = this.serviceUrl;
	var serviceUrl = '/bookmark.php';

	serviceUrl += this.niceUrls ? ( '/' + encodeURIParameter(annotation.getLink()) ) : ( '?id=' + encodeURIParameter(annotation.getLink()) );
	serviceUrl += ( this.niceUrls ? '?' : '&' ) + 'curuser=' + encodeURIParameter( window.marginalia.loginUserId );


	var body
	= 'url=' + encodeURIParameter( annotation.getUrl() )
	+ '&note=' + encodeURIParameter( annotation.getNote() )
	+ '&access=' + encodeURIParameter( annotation.getAccess() )
	+ '&quote=' + encodeURIParameter( annotation.getQuote() )
	+ '&quote_title=' + encodeURIParameter( annotation.getQuoteTitle() )
	+ '&quote_author_id=' + encodeURIParameter( annotation.getQuoteAuthorId() )
	+ '&quote_author_name=' + encodeURIParameter( annotation.getQuoteAuthorName() )
	+ '&link=' + encodeURIParameter( annotation.getLink() )
	+ '&userid=' + encodeURIParameter( annotation.getUserId() );
	// userid shouldn't be trusted by the server of course, except for demo applications for
	// which it can be useful.

	var tempId = annotation.getLink();
	var bookmarkid = tempId.substring( tempId.lastIndexOf( '#' ) + 1 );
	bookmarkid = bookmarkid + "_bk"; 

	if ( annotation.getAction() )
		body += '&action=' + encodeURIParameter (annotation.getAction() );
	if ( annotation.getSequenceRange( ) )
		body += '&sequence-range=' + encodeURIParameter( annotation.getSequenceRange( ).toString( ) );
	if ( annotation.getXPathRange( ) )
		body += '&xpath-range=' + encodeURIParameter( annotation.getXPathRange( ).toString( ) );
	if ( annotation.getLinkTitle( ) )
		+ '&linkTitle=' + encodeURIParameter( annotation.getLinkTitle( ) );

	// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
		body += '&' + encodeURIComponent( this.csrfCookie ) + '=' + encodeURIParameter( readCookie( this.csrfCookie ) );

	// May need to pass method name instead of using PUT or DELETE
	var method = 'DELETE';
	if ( this.noPutDelete )
	{
		serviceUrl += ( hasParams ? '&' : '?' ) + 'method=DELETE';
		method = 'POST';
	}

	var xmlhttp = domutil.createAjaxRequest( );

	xmlhttp.open( method, serviceUrl, true );
	xmlhttp.setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8' );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.setRequestHeader( 'Content-length', body.length );
	xmlhttp.onreadystatechange = function( ) {
	if ( xmlhttp.readyState == 4 ) {
		// No need for Safari hack, since Safari can't create annotations anyway.
		if ( xmlhttp.status == 204 ) {

			document.getElementById(bookmarkid).innerHTML="<img src='/oso/public/all_images/bookmark.jpg' title='bookmark this subsection' onclick=\"myClickAddToBookmark(event,'"+ tempId +"')\">";

		}	
		else {
			logError( "AnnotationService.addToBookmark failed with code " + xmlhttp.status + ":\n" + serviceUrl + "\n" + xmlhttp.responseText );
		}
	xmlhttp = null;
	}
	}
	//trace( 'bookmark-service', "AnnotationService.addToBookmark " + decodeURI( serviceUrl ) + "\n" + body );
	xmlhttp.send( body );
}




/**
* Update SearchHistory on the server
* When successful, calls a function f with one parameter:  the URL of the created annotation
*/
RestAnnotationService.prototype.saveSearch = function( saveSearch, f )
{
	//var serviceUrl = this.serviceUrl;
	var serviceUrl = '/searchhistory.php';
	serviceUrl += this.niceUrls ? ( '/' + saveSearch.getId() ) : ( '?id=' + saveSearch.getId() );
	serviceUrl += ( this.niceUrls ? '?' : '&' ) + 'curuser=' + encodeURIParameter( window.marginalia.loginUserId );	
	

	var body
	= 'id=' + encodeURIParameter( saveSearch.getId() )
	+ '&userid=' + encodeURIParameter( saveSearch.getUserId() );
	// userid shouldn't be trusted by the server of course, except for demo applications for
	// which it can be useful.

	// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
	body += '&' + encodeURIComponent( this.csrfCookie ) + '=' + encodeURIParameter( readCookie( this.csrfCookie ) );

	var method = 'PUT'; 

	// May need to pass method name instead of using PUT or DELETE
	if ( this.noPutDelete ){
	serviceUrl += '&method=PUT';
	method = 'POST';
	}

	var xmlhttp = domutil.createAjaxRequest( );

	xmlhttp.open( method, serviceUrl, true );
	xmlhttp.setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded; charset=UTF-8' );
	//xmlhttp.setRequestHeader( 'Accept', 'application/xml' );
	xmlhttp.setRequestHeader( 'Content-length', body.length );
	xmlhttp.onreadystatechange = function( ) {
	if ( xmlhttp.readyState == 4 ) {
	// No need for Safari hack, since Safari can't create annotations anyway.


	if ( 204 == xmlhttp.status || xmlhttp.status == null || xmlhttp.status == 1223 ) {

		document.getElementById("saveSearchId").innerHTML="<img src='/oso/public/all_images/saved.jpg'  border='0' />";

	}
	else {
		logError( "Save Search failed with code " + xmlhttp.status + ":\n" + serviceUrl + "\n" + xmlhttp.responseText );
	}
		xmlhttp = null;
	}
	}
	xmlhttp.send( body );
}

RestAnnotationService.prototype.deleteSearchHistory = function( searchId, f )
{
	var serviceUrl = '/searchhistory.php';
	var hasParams = false;

	if ( this.niceUrls )
		serviceUrl += '/' + searchId;
	else
	{
		serviceUrl += '?id=' + searchId;
		hasParams = true;
	}

	// Cross-site request forgery protection (if present)
	if ( this.csrfCookie )
	{
		serviceUrl += ( hasParams ? '&' : '?' )
		+ encodeURIComponent( this.csrfCookie ) + '=' + encodeURIComponent( readCookie( this.csrfCookie ) );
		hasParams = true;
	}

	if(window.marginalia && window.marginalia.userInRequest )
	{
		serviceUrl += ( hasParams ? '&' : '?' )
		+ 'curuser=' + encodeURIParameter( window.marginalia.loginUserId );
		hasParams = true;
	}

	// May need to pass method name instead of using PUT or DELETE
	var method = 'DELETE';
	if ( this.noPutDelete )
	{
		serviceUrl += ( hasParams ? '&' : '?' ) + 'method=DELETE';
		method = 'POST';
	}

	var xmlhttp = domutil.createAjaxRequest( );
	xmlhttp.open( method, serviceUrl, true );

	xmlhttp.onreadystatechange = function( ) {
	if ( xmlhttp.readyState == 4 ) {
		// Safari is braindead here:  any status code other than 200 is converted to undefined
		// IE invents its own 1223 status code
		if ( 204 == xmlhttp.status || xmlhttp.status == null || xmlhttp.status == 1223 ) {
		if ( null != f )
		f( xmlhttp.responseXML );
		}
		else
		logError( "SearchHistoryService.deleteSearchHistory failed with code " + xmlhttp.status + "\n" + xmlhttp.responseText );
		xmlhttp = null;
	}
	}
	trace( 'annotation-service', "SearchHistoryService.deleteSearchHistory " + decodeURI( serviceUrl ) );
	xmlhttp.send( null );
}