--
--  $Id$
--
--  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
--  project.
--
--  Copyright (C) 1998-2018 OpenLink Software
--
--  This project 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; only version 2 of the License, dated June 1991.
--
--  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.,
--  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
--

--
-- ODS API for accessing & data manipulation
-- All requests are authorized via one of:
--   1) HTTP authentication (not yet supported)
--   2) OAuth
--   3) VSPX session (sid & realm)
--   4) username=<user>&password=<pass>
--   5) FOAF+SSL
-- The effective user is authenticated account
--
-- Important:
-- Any API method MUST follow namin convention as follows
-- methods : ods.<object type>.<action>
-- parameters : <lower_case>
-- composite patameters: atom-pub, OpenSocial XML format
-- response : GData format , i.e. Atom extension
--
-- Note: some of methods bellow uses ods_api.sql code

use ODS;

--!
-- \brief Try to create a nice new username from arbitrary profile information.
--
-- This is used for auto-registration via third-party service profiles.
--/
create procedure ODS.DBA.ods_build_new_user_name (
  in firstName varchar,
  in lastName varchar,
  in uid varchar := null,
  in email varchar := null)
{
  -- prepare input
  if (firstName = '')
    firstName := null;
  if (lastName = '')
    lastName := null;
  if (uid = '')
    uid := null;
  if (email = '')
    email := null;

  if (not firstName is null)
    firstName := replace (firstName, ' ', '');
  if (not lastName is null)
    lastName := replace (lastName, ' ', '');

  if (not firstName is null and not lastName is null)
    return sprintf('%s.%s', lcase(substring(firstName, 1, 1)), lcase(lastName));
  else if (not lastName is null)
    return lcase(lastName);
  else if (not firstName is null)
    return lcase(firstName);
  else if (not email is null)
    return lcase(left(email, strcr(email, '@')));
  else
    return uid;
}
;

--!
-- \brief Internal utility proc to build the authentication callback URL.
--
-- The callback URL always points to the user.authenticate.callback procedure
-- if possible using a secure connection.
--
-- \param service The service type like \p facebook or \p google.
-- \param url An optional base64 callback URL. See user.authenticate.authenticationUrl for details.
--/
create procedure ODS.DBA.ods_authenticate_callback_url()
{
  declare sslInfo any;
  declare sslPort, sslHost varchar;
  declare callback varchar;

  --
  -- FIXME: Virtuoso will always ask for a client certificate when the callback is called
  --        via https. Since this is a very confusing experience for the user who tries to
  --        login via a non-certificate-based method like Google or Twitter we disable
  --        the https callback for now. As soon as this problem is fixed the documentation of
  --        user.authenticate.authenticationUrl needs to be updated to reflect the usage of
  --        https.
  --
  if (0 and is_https_ctx())
  {
    return sprintf('https://%s/ods/api/user.authenticate.callback', http_host());
  }
  else
  {
    --sslInfo := json_parse(ODS.ODS_API."server.getInfo"('sslPort'));
    if (0 and length(sslInfo) > 1)
    {
      sslPort := get_keyword('sslPort', sslInfo);
      sslHost := get_keyword('sslHost', sslInfo);
      callback := sprintf('https://%s:%s/ods/api/user.authenticate.callback', sslHost, sslPort);
    }
    else
    {
      callback := sprintf('http://%s/ods/api/user.authenticate.callback', http_host());
    }

    return callback;
  }
}
;

--!
-- Internal utility procedure to check if a client has been registered via admin.clients.new()
--
-- \return \p 1 if allowed, \p 0 otherwise.
--/
create procedure ODS..ods_check_client_url (
  in callback varchar)
{
  if (exists (select * from DB.DBA.WA_CLIENT_REG where starts_with(callback, CLIENT_URL)))
    return 1;
  else
    return 0;
}
;

--!
-- \brief Get the key and secret for the given service API.
--
-- This procedure reads client id and secret from OAUTH.DBA.APP_REG.
--
-- \param service The name of the service.
-- \param clientId[out] A vector containing the client ID and secret on success.
--
-- \return On success \p 1 is returned, \p 0 otherwise.
--/
create procedure ODS..ods_get_service_client_key (
  in service varchar,
  out clientId any)
{
  -- For historical reasons the names of the services are like "Wordpress API" or "Windows Live API"
  -- while internally we now use "wordpress" or "windowslive" which is much easier to handle all over
  service := replace(lcase(service), ' ', '');
  if (not ends_with(service, 'api'))
    service := service || 'api';

  clientId := null;
  for (select a_key, a_secret from OAUTH.DBA.APP_REG where a_owner = 0 and replace(lcase(a_name), ' ', '') = service) do
  {
    clientId := vector (a_key, a_secret);
    return 1;
  }
  return 0;
}
;

--!
-- Creates an XML stream of a user session as returned by authentication and registration methods.
--/
create procedure ODS.DBA.ods_serialize_user_session (
  in sid varchar,
  in uname varchar,
  in isNewUser int := 0)
{
  return
    '<userSession>' ||
      '<sid>' || sid  || '</sid>' ||
      '<user>' ||
        '<uname>' || uname || '</uname>' ||
        '<uid>' || cast (username2id (uname) as varchar) || '</uid>' ||
        '<new>'  || cast (isNewUser as varchar) || '</new>' ||
        '<dba>' || cast (is_dba (uname) as varchar) || '</dba>' ||
      '</user>' ||
    '</userSession>';
}
;

create procedure ods_serialize_int_res (in rc any, in msg varchar := '')
{
  if (isarray (rc) and length (rc) = 2 and __tag (rc[0]) = 255)
    rc := rc[1];
  rc := cast (rc as int);
  if (msg = '')
    {
      if (rc < 0)
        msg := DB.DBA.DAV_PERROR (rc);
      else
	msg := 'Success';
    }
  if (rc >= 0)
    return sprintf ('<result><code>%d</code><message>%V</message></result>', rc, msg);

    return sprintf ('<failed><code>%d</code><message>%V</message></failed>', rc, msg);
}
;

create procedure ods_serialize_sql_error (in state varchar, in message varchar)
{
  message := substring (message, 1, coalesce (strstr (message, '<>'), length (message)));
  message := substring (message, 1, coalesce (strstr (message, '\nin'), length (message)));
  return sprintf ('<failed><code>%s</code><message>%V</message></failed>', state, message);
}
;

--!
-- Performs HTTP, OAuth, session based authentication, FOAF+SSL in same order
--/
create procedure ods_check_auth (
  out uname varchar,
  in inst_id integer := null,
  in mode char := 'owner')
{
  return ods_check_auth2 (uname, inst_id, mode);
}
;

create procedure ods_check_auth2 (
  out uname varchar,
  inout inst_id integer := null,
  in mode char := 'owner',
  in withSSL int := 1)
{
  declare rc, authType integer;
  declare params, lines any;

  params := http_param ();
  lines := http_request_header ();
  rc := 0;

  whenever not found goto nf;

  -- check authentication
  if (OAUTH..check_authentication_safe (params, lines, uname, inst_id))
    {
    rc := 1;
    }
  else if (http_request_header (lines, 'Authentication', null, null) is not null) -- not supported
    {
      ;
    }
  else if (get_keyword ('sid', params) is not null and get_keyword ('realm', params) is not null)
    {
      select VS_UID into uname from DB.DBA.VSPX_SESSION where VS_SID = get_keyword ('sid', params) and VS_REALM = get_keyword ('realm', params);
      rc := 1;
      authType := 1;
    }
  else if (get_keyword ('user_name', params) is not null and get_keyword ('password_hash', params) is not null)
    {
      if ((select top 1 WS_LOGIN from DB.DBA.WA_SETTINGS) = 1)
      {
      declare pwd any;
      uname := get_keyword ('user_name', params);
      select pwd_magic_calc (U_NAME, U_PASSWORD, 1) into pwd from DB.DBA.SYS_USERS where U_NAME = uname;
      if (_hex_sha1_digest (uname||pwd) = get_keyword ('password_hash', params))
	rc := 1;
      authType := 1;
    }
    }
  else if (withSSL and check_authentication_ssl (uname))
    {
      if ((select top 1 WS_LOGIN_SSL from DB.DBA.WA_SETTINGS) = 1)
    {
      rc := 1;
      authType := 1;
    }
    }
  -- check ACL
  if (inst_id > 0 and rc > 0)
    {
      declare member_type integer;
      if (mode = 'owner')
      {
	member_type := 1;
	    }
      else
       {
	      member_type := (select WMT_ID from DB.DBA.WA_MEMBER_TYPE, DB.DBA.WA_INSTANCE where WAI_ID = inst_id and WMT_NAME = mode and WMT_APP = WAI_TYPE_NAME);
       }
      if (
          ((authType = 0) or (uname not in ('dba', 'dav'))) and
          (not exists (select 1 from DB.DBA.WA_INSTANCE, DB.DBA.WA_MEMBER, DB.DBA.SYS_USERS where WAI_ID = inst_id and WAM_INST = WAI_NAME and WAM_USER = U_ID and U_NAME = uname and WAM_MEMBER_TYPE <= member_type))
         )
      {
	rc := 0;
    }
    }
  else if (inst_id = -1 and rc > 0)
  {
    if ((mode = 'owner') and (uname not in ('dba', 'dav')))
      rc := 0;
  }
nf:
  if (rc = 0)
  {
  declare cookie_arr any;
  cookie_arr := DB.DBA.vsp_ua_get_cookie_vec(lines);
  if(cookie_arr is not null and get_keyword('interface',cookie_arr,'js')='vspx')
  {
    if (get_keyword ('sid', cookie_arr) is not null)
    {
      select VS_UID into uname from DB.DBA.VSPX_SESSION where VS_SID = get_keyword ('sid', cookie_arr);
      if (uname is not null)
	return 1;
    }
   }
  }
  return rc;
}
;

--!
-- \ingroup ods_devel_api
--
-- \brief Try to map a WebID to an ODS user account.
--
-- Each ODS user account has one main WebID and a set of optional
-- additional WebIDs. This method can be used to retrieve the ODS user
-- account name accociated with the provided WebID.
--
-- \param webid The WebID which should be mapped to a user account.
--
-- \return The accociated ODS user account name or \p null if the given WebID
-- does not map to any user account.
--/
create procedure webid_to_ods_user (
  in webid varchar)
{
  declare uname varchar;

  -- FIXME: normally this should be handled by the Virtuoso inferencer via owl:sameAs inferencing
  --        However, in order to do that securely we need to make sure to only look into the user
  --        profile's graphs. At the moment there are at least 3. Thus, we need to make a graph
  --        group of all of them. Otherwise something like the following might occure:
  --        A profile is loaded into a tmp graph which claims to be the same as our user's webid.
  --        The inferencer would then pick it up and return the wrong user account.
  --
  --        graph := getGraphGroupContainingAllUserProfiles();
  --        return (sparql define input:same-as "yes" select ?user where { graph `iri(?:graph)` { ?user a sioc:User ; sioc:account_of `iri(?:webid)` . } });
  --
  --        For now we do it the dumb way and simply look into the profile table

  -- 1. Check if we have a user that is accociated with the verified WebID
  uname := sprintf_inverse(webid, sprintf('http://%s/dataspace/person/%s#this', SIOC..get_cname(), '%s'), 2)[0];
  if (not isnull(uname))
    {
      if ((select U_ID from DB.DBA.SYS_USERS where U_NAME = uname))
        return uname;
    }

  -- 2. Check if we have a user that set the verified WebID as an alternative
  uname := (select U_NAME from DB.DBA.SYS_USERS, DB.DBA.WA_USER_OL_ACCOUNTS where U_ID = WUO_U_ID and WUO_NAME = 'webid' and WUO_URL = webid);

  -- nothing found
  return uname;
}
;

--!
-- \ingroup ods_devel_api
--
-- \brief Try to map an X.509 certificate fingerprint to an ODS user account.
--
-- Each ODS user accountcan have several X.509 certificate fingerprints accociated with it.
-- These are typically added when registering with or connecting to an X.509 certificate
-- without am embedded WebID.
--
-- \param fingerprint The X.509 certifcate fingerprint which should be mapped to a user account.
--
-- \return The accociated ODS user account name or \p null if the given fingerprint
-- does not map to any user account.
--/
create procedure x509_cert_fingerprint_to_ods_user (
  in fingerprint varchar)
{
  return (select U_NAME from DB.DBA.SYS_USERS, DB.DBA.WA_USER_CERTS where U_ID = UC_U_ID and UC_FINGERPRINT = fingerprint);
}
;

--!
-- \ingroup ods_devel_api
--
-- \brief Verify a provided X.509 certificate and map the accociated WebID to an ODS account.
--
-- \param uname[out] The ODs user name to which the WebID in the certificate is accociated.
--
-- \return If the WebID in the certificate could be mapped to an ODS user \p 1 is returned
-- and \p uname is set to the user account name. Otherwise \p 0 is returned.
--/
create procedure check_authentication_ssl (
  out uname varchar := null)
{
  declare webid varchar;

  if (not is_https_ctx ())
    return 0;

  -- 1. Verify that the given WebID matches the given certificate
  if (not SIOC..foaf_check_ssl_2 (null, webid))
    return 0;

  -- 2. Check if we have a user that is accociated with the verified WebID
  uname := webid_to_ods_user(webid);
  if (not isnull(uname))
    return 1;

  -- 3.Check if we have the certifcate fingerprint accociated with a user
  uname := x509_cert_fingerprint_to_ods_user(get_certificate_info (6));
  if (not isnull(uname))
    return 1;

  return 0;
}
;

create procedure normalize_url_like_browser (in x varchar)
{
  declare h any;
  h := rfc1808_parse_uri (x);
  h [5] := '';
  return DB.DBA.vspx_uri_compose (h);
}
;

--!
-- FIXME: get_ses is only used in Gallery!
--/
create procedure get_ses (in uname varchar)
{
  declare params, lines any;
  declare sid any;

  params := http_param ();
  lines := http_request_header ();

  sid := get_keyword ('sid', params);
  --if (sid is null)
  --  sid := OAUTH.DBA.get_sid (params, lines);
  if (sid is null)
    {
      sid := DB.DBA.vspx_sid_generate ();
      insert into DB.DBA.VSPX_SESSION (VS_SID, VS_REALM, VS_UID, VS_EXPIRY) values (sid, 'wa', uname, now ());
    }
  return sid;
}
;

--!
-- FIXME: close_ses is only used in Gallery!
--/
create procedure close_ses (in sid1 varchar)
{
  declare params, lines any;
  declare sid any;

  params := http_param ();
  lines := http_request_header ();

  sid := get_keyword ('sid', params);
  if (sid is null)
    sid := OAUTH.DBA.get_sid (params, lines);
  if (sid is null)
    {
      delete from DB.DBA.VSPX_SESSION where VS_SID = sid1 and  VS_REALM = 'wa';
    }
}
;

create procedure exec_sparql (in qr varchar)
{
  declare ses, stat, msg, metas, rset any;
  declare accept, fmt varchar;

  accept := 'application/sparql-results+xml';

  set http_charset='utf-8';
  declare exit handler for sqlstate '*'
    {
      stat := __SQL_STATE;
      msg := __SQL_MESSAGE;
      goto reporterr;
    };

  set_user_id ('SPARQL');
  stat := '00000';
  qr := 'SPARQL define output:valmode "LONG" ' ||
  ' define input:inference "' || sioc..get_graph() || '"' ||
  sioc..std_pref_declare () || qr;
  exec (qr, stat, msg, vector (), 0, metas, rset);
  if (stat <> '00000')
    {
reporterr:
      http (ods_serialize_int_res (-500, msg));
      return;
    }
  ses := string_output ();
  DB.DBA.SPARQL_RESULTS_WRITE (ses, metas, rset, accept, 0);
  http_header ('Content-Type: application/sparql-results+xml\r\n');
  http (ses);
}
;

create procedure ods_graph ()
{
	return SIOC..fix_graph (SIOC..get_graph ());
}
;

create procedure ods_describe_iri (
  in iri varchar)
{
	exec_sparql (sprintf ('describe <%s> from <%s>', SIOC..fix_uri (iri), ods_graph ()));
}
;

create procedure ods_auth_failed ()
{
  return ods_serialize_int_res (-12);
}
;

create procedure ods_xml_item (
  in pTag varchar,
  in pValue any)
{
  -- sprintf %V cannot handle UTF-8. We need to convert to wide chars first. Otherwise we end up with double-endoded characters.
  -- if the input string is already wide nothing is done.
  if (not DB.DBA.is_empty_or_null (pValue))
    http (sprintf ('<%s>%V</%s>', pTag,  charset_recode (cast (pValue as varchar), 'UTF-8', '_WIDE_'), pTag));
}
;

create procedure jsonObject ()
{
  return subseq (soap_box_structure ('x', 1), 0, 2);
}
;

create procedure isJsonObject (inout o any)
{
  if (isarray (o) and (length (o) > 1) and (__tag (o[0]) = 255))
    return 1;
  return 0;
}
;

create procedure array2obj (in V any)
{
  return vector_concat (jsonObject (), V);
}
;

create procedure obj2json (
  in o any,
  in d integer := 10,
  in nsArray any := null,
  in attributePrefix varchar := null)
{
  declare N, M integer;
  declare R, T any;
  declare S, retValue any;

	if (d = 0)
	  return '[maximum depth achieved]';

  T := vector ('\b', '\\b', '\t', '\\t', '\n', '\\n', '\f', '\\f',	'\r', '\\r', '"', '\\"', '\\', '\\\\');
	retValue := '';
  if (isnull (o))
  {
    retValue := 'null';
  }
  else if (isnumeric (o))
	{
		retValue := cast (o as varchar);
	}
	else if (isstring (o))
	{
		for (N := 0; N < length(o); N := N + 1)
		{
			R := chr (o[N]);
		  for (M := 0; M < length(T); M := M + 2)
		  {
				if (R = T[M])
				  R := T[M+1];
			}
			retValue := retValue || R;
		}
		retValue := '"' || retValue || '"';
	}
  else if (isarray (o) and (length (o) > 1) and ((__tag (o[0]) = 255) or (o[0] is null and (o[1] = '<soap_box_structure>' or o[1] = 'structure'))))
  {
  	retValue := '{';
  	for (N := 2; N < length(o); N := N + 2)
  	{
  	  S := o[N];
  	  if (chr (S[0]) = attributePrefix)
  	    S := subseq (S, length (attributePrefix));
  	  if (not isnull (nsArray))
  	  {
        for (M := 0; M < length (nsArray); M := M + 1)
    	  {
          if (S like nsArray[M]||':%')
  	        S := subseq (S, length (nsArray[M])+1);
        }
  	  }
  	  retValue := retValue || '"' || S || '":' || obj2json (o[N+1], d-1, nsArray, attributePrefix);
  	  if (N <> length(o)-2)
  		  retValue := retValue || ', ';
  	}
  	retValue := retValue || '}';
  }
	else if (isarray (o))
	{
		retValue := '[';
		for (N := 0; N < length(o); N := N + 1)
		{
      retValue := retValue || obj2json (o[N], d-1, nsArray, attributePrefix);
		  if (N <> length(o)-1)
			  retValue := retValue || ',\n';
		}
		retValue := retValue || ']';
	}
	return retValue;
}
;

-----------------------------------------------------------------------------------------
--
create procedure obj2xml (
  in o any,
  in d integer := 10,
  in tag varchar := null,
  in nsArray any := null,
  in attributePrefix varchar := '')
{
  declare N, M integer;
  declare R, T any;
  declare S, nsValue, retValue any;

  if (d = 0)
    return '[maximum depth achieved]';

  nsValue := '';
  if (not isnull (nsArray))
  {
    for (N := 0; N < length(nsArray); N := N + 2)
      nsValue := sprintf ('%s xmlns%s="%s"', nsValue, case when nsArray[N]='' then '' else ':'||nsArray[N] end, nsArray[N+1]);
  }
  retValue := '';
  if (isnumeric (o))
  {
    retValue := cast (o as varchar);
  }
  else if (isstring (o))
  {
    retValue := sprintf ('%V', o);
  }
  else if (__tag (o) = 211)
  {
    retValue := datestring (o);
  }
  else if (isJsonObject (o))
  {
    for (N := 2; N < length(o); N := N + 2)
    {
      if (not isJsonObject (o[N+1]) and isarray (o[N+1]) and not isstring (o[N+1]))
      {
        retValue := retValue || obj2xml (o[N+1], d-1, o[N], nsArray, attributePrefix);
      } else {
    	  if (chr (o[N][0]) <> attributePrefix)
    	  {
          nsArray := null;
          S := '';
          if ((attributePrefix <> '') and isJsonObject (o[N+1]))
          {
            for (M := 2; M < length(o[N+1]); M := M + 2)
            {
          	  if (chr (o[N+1][M][0]) = attributePrefix)
          	    S := sprintf ('%s %s="%s"', S, subseq (o[N+1][M], length (attributePrefix)), obj2xml (o[N+1][M+1]));
            }
          }
          retValue := retValue || sprintf ('<%s%s%s>%s</%s>\n', o[N], S, nsValue, obj2xml (o[N+1], d-1, null, nsArray, attributePrefix), o[N]);
        }
      }
    }
  }
  else if (isarray (o))
  {
    for (N := 0; N < length(o); N := N + 1)
    {
      if (isnull (tag))
      {
        retValue := retValue || obj2xml (o[N], d-1, tag, nsArray, attributePrefix);
      } else {
        nsArray := null;
        S := '';
        if (not isnull (attributePrefix) and isJsonObject (o[N]))
        {
          for (M := 2; M < length(o[N]); M := M + 2)
          {
        	  if (chr (o[N][M][0]) = attributePrefix)
        	    S := sprintf ('%s %s="%s"', S, subseq (o[N][M], length (attributePrefix)), obj2xml (o[N][M+1]));
          }
        }
        retValue := retValue || sprintf ('<%s%s%s>%s</%s>\n', tag, S, nsValue, obj2xml (o[N], d-1, null, nsArray, attributePrefix), tag);
      }
    }
  }
  return retValue;
}
;

create procedure params2json (in o any)
{
  return obj2json (array2obj(o));
}
;

create procedure json2obj (
  in o any)
{
  return json_parse (o);
}
;

create procedure dav_path_normalize (
  in path varchar,
  in path_type varchar := 'P')
{
  declare N integer;

  path := trim (path);
  N := length (path);
  if (N > 0)
  {
    if (chr (path[0]) <> '/')
    {
      path := '/' || path;
    }
    if ((path_type = 'C') and (chr (path[N-1]) <> '/'))
    {
      path := path || '/';
    }
    if (chr (path[1]) = '~')
    {
      path := replace (path, '/~', '/DAV/home/');
    }
    if (path not like '/DAV/%')
    {
      path := '/DAV' || path;
    }
  }
  return path;
}
;

-- QRCode
create procedure ODS.ODS_API."make_curie" (
  in url varchar) __soap_http 'text/plain'
{
  if (__proc_exists ('WS.CURI.curi_make_curi') is null)
    return url;

  declare curie, chost, dhost varchar;
  declare lines any;

  lines := http_request_header ();
  curie := WS.CURI.curi_make_curi (url);
  dhost := registry_get ('URIQADefaultHost');
  chost := http_request_header(lines, 'Host', null, dhost);

  return sprintf ('http://%s/c/%s', chost, curie);
}
;

create procedure ODS.ODS_API."qrcode" (
  in data any,
  in width int := 120,
  in height int := 120,
  in scale int := 3) __soap_http 'text/plain'
{
  declare qrcode_bytes, mixed_content, content varchar;
  declare qrcode any;

  if (__proc_exists ('QRcode encodeString8bit', 2) is null)
    return null;

  declare exit handler for sqlstate '*' { return null; };

  content := "IM CreateImageBlob" (width, height, 'white', 'jpg');
  qrcode := "QRcode encodeString8bit" (data);
  qrcode_bytes := aref_set_0 (qrcode, 0);
  mixed_content := "IM PasteQRcode" (qrcode_bytes, qrcode[1], qrcode[2], scale, scale, 0, 0, cast (content as varchar), length (content));
  mixed_content := encode_base64 (cast (mixed_content as varchar));
  mixed_content := replace (mixed_content, '\r\n', '');

  return mixed_content;
}
;

create procedure ODS.ODS_API."iri2proxy" (
  in iri any) __soap_http 'text/plain'
{
  return DB.DBA.RDF_PROXY_ENTITY_IRI (rtrim (iri, '#this'));
}
;

-- Ontology Info
create procedure ODS.ODS_API."ontology.classes" (
  in ontology varchar,
  in prefix varchar,
  in dependentOntology varchar := null) __soap_http 'application/json'
{
  declare S, data any;
  declare tmp, classes, clazz, subClasses, retValue, dependency any;

  set_user_id ('dba');
  -- load ontology
  ODS.ODS_API."ontology.load" (ontology, 0);

  dependency := '';
  if (not isnull (dependentOntology))
    dependency := sprintf (' || (str(?sc) like "%s%%")', dependentOntology);

  -- select classes ontology
  classes := vector ();
  S := sprintf(
         '\n SPARQL ' ||
         '\n PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>' ||
         '\n PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>' ||
         '\n PREFIX owl: <http://www.w3.org/2002/07/owl#>' ||
         '\n SELECT distinct ?c ?sc' ||
         '\n   FROM <%s>' ||
         '\n  WHERE {' ||
         '\n          {' ||
         '\n          ?c rdf:type owl:Class .' ||
         '\n          OPTIONAL ' ||
         '\n          { ' ||
         '\n            ?c rdfs:subClassOf ?sc .' ||
         '\n              filter ((str(?sc) = \'\') || (((str(?sc) like "%s%%")%s) && not (str(?sc) like "nodeID://%%"))).' ||
         '\n          }.' ||
         '\n          filter (str(?c) like "%s%%").' ||
         '\n        }' ||
         '\n          union' ||
         '\n          {' ||
         '\n            ?c rdf:type rdfs:Class .' ||
         '\n            OPTIONAL ' ||
         '\n            { ' ||
         '\n              ?c rdfs:subClassOf ?sc .' ||
         '\n              filter ((str(?sc) = \'\') || (((str(?sc) like "%s%%")%s) && not (str(?sc) like "nodeID://%%"))).' ||
         '\n            }.' ||
         '\n            filter (str(?c) like "%s%%").' ||
         '\n          }' ||
         '\n        }' ||
         '\n  ORDER BY ?c ?sc',
         ontology,
         ontology,
         dependency,
         ontology,
         ontology,
         dependency,
         ontology);
  clazz := '';
  subClasses := vector ();
  data := ODS.ODS_API."ontology.sparql" (S);
  foreach (any item in data) do
  {
    if (clazz <> ODS.ODS_API."ontology.normalize2" (ontology, prefix, item[0]))
    {
      if (clazz <> '')
      {
        tmp := vector_concat (jsonObject (), vector ('name', clazz, 'subClassOf', subClasses));
        classes := vector_concat (classes, vector (tmp));
      }
      clazz := ODS.ODS_API."ontology.normalize2" (ontology, prefix, item[0]);
      subClasses := vector ();
    }
    subClasses := vector_concat (subClasses, vector (case when isnull (item[1]) then 'rdfs:Class' else ODS.ODS_API."ontology.normalize2" (ontology, prefix, item[1]) end));
  }
  if (clazz <> '')
  {
    tmp := vector_concat (jsonObject (), vector ('name', clazz, 'subClassOf', subClasses));
    classes := vector_concat (classes, vector (tmp));
  }
  retValue := vector_concat (jsonObject (), vector ('name', ontology, 'classes', classes));
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."ontology.classProperties" (
  in ontology varchar,
  in prefix varchar,
  in ontologyClass varchar) __soap_http 'application/json'
{
  declare N integer;
  declare S, data any;
  declare tmp, property, properties any;

  -- select class properties ontology
  properties := vector ();
  S := sprintf(
         '\n SPARQL' ||
         '\n PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>' ||
         '\n PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>' ||
         '\n PREFIX owl: <http://www.w3.org/2002/07/owl#>' ||
         '\n PREFIX %s: <%s>' ||
         '\n SELECT ?p ?t ?r1' ||
         '\n   FROM <%s>' ||
         '\n  WHERE {' ||
         '\n          {?p a owl:ObjectProperty} UNION {?p a owl:DatatypeProperty} UNION {?p a owl:Property} .' ||
         '\n          ?p rdf:type ?t .' ||
         '\n          optional {?p rdfs:range ?r1} .' ||
         '\n            {' ||
         '\n              ?p rdfs:domain %s .' ||
         '\n            }' ||
         '\n            union' ||
         '\n            {' ||
         '\n              ?p rdfs:domain ?_b0 .'   ||
         '\n              ?_b0 owl:unionOf ?_b1 .' ||
         '\n              ?_b1 rdf:first %s . '    ||
         '\n            }' ||
         '\n            union' ||
         '\n            {' ||
         '\n              ?p rdfs:domain ?_b0 .'   ||
         '\n              ?_b0 owl:unionOf ?_b1 .' ||
         '\n              ?_b1 rdf:rest ?_b2 . '   ||
         '\n              ?_b2 rdf:first %s . '    ||
         '\n            }' ||
         '\n            union' ||
         '\n            {' ||
         '\n            ?p rdfs:domain ?_b0 .'   ||
         '\n            ?_b0 owl:unionOf ?_b1 .' ||
         '\n            ?_b1 rdf:rest ?_b2 . '   ||
         '\n            ?_b2 rdf:rest ?_b3 . '   ||
         '\n            ?_b3 rdf:first %s . '    ||
         '\n          }' ||
         '\n        }' ||
         '\n  ORDER BY ?p ?r1',
         prefix,
         ontology,
         ontology,
         ontologyClass,
         ontologyClass,
         ontologyClass,
         ontologyClass);

  data := ODS.ODS_API."ontology.sparql" (S);
  property := vector ('', vector (), vector ());
  foreach (any item in data) do
  {
    if (property[0] <> item[0])
    {
      if (property[0] <> '')
        properties := vector_concat (properties, vector (ODS.ODS_API."ontology.objectProperty" (ontology, prefix, property)));
      property := vector (item[0], vector (), vector ());
    }
    tmp := ODS.ODS_API."ontology.normalize2" (ontology, prefix, item[1]);
    if (tmp = 'owl:ObjectProperty')
    {
      tmp := ODS.ODS_API."ontology.normalize2" (ontology, prefix, item[2]);
      if (tmp not like 'nodeID:%')
      {
        property[1] := vector_concat (property[1], vector (tmp));
      } else {
        property[1] := vector_concat (property[1], ODS.ODS_API."ontology.collection" (ontology, tmp));
      }
    }
    else if (tmp = 'owl:DatatypeProperty')
    {
      property[2] := vector_concat (property[2], vector (ODS.ODS_API."ontology.normalize2" (ontology, prefix, coalesce (item[2], 'xsd:string'))));
    }
  }
  if (property[0] <> '')
    properties := vector_concat (properties, vector (ODS.ODS_API."ontology.objectProperty" (ontology, prefix, property)));
  return obj2json (properties, 10);
}
;

create procedure ODS.ODS_API."ontology.objects" (
  in ontology varchar,
  in prefix varchar) __soap_http 'application/json'
{
  declare S, data any;
  declare tmp, objects any;

  -- select classes ontology
  objects := vector ();
  S := sprintf(
         '\n SPARQL ' ||
         '\n PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>' ||
         '\n PREFIX owl: <http://www.w3.org/2002/07/owl#>' ||
         '\n SELECT ?o ?c' ||
         '\n   FROM <%s>' ||
         '\n  WHERE {' ||
         '\n          ?o a ?c .' ||
         '\n          ?c rdf:type owl:Class.' ||
         '\n        }' ||
         '\n  ORDER BY ?c',
         ontology,
         ontology);
  data := ODS.ODS_API."ontology.sparql" (S);
  foreach (any item in data) do
  {
    tmp := vector_concat (jsonObject (), vector ('id', ODS.ODS_API."ontology.normalize2" (ontology, prefix, item[0]), 'class', ODS.ODS_API."ontology.normalize2" (ontology, prefix, item[1])));
    objects := vector_concat (objects , vector (tmp));
  }
  return obj2json (objects , 10);
}
;

create procedure ODS.ODS_API."ontology.sparql" (
  in S varchar,
  in V any := null,
  in debug integer := 0)
{
  declare st, msg, data, meta any;

  set_user_id ('dba');
  if (isnull (V))
    V := vector ();
  commit work;
  st := '00000';
  exec (S, st, msg, V, vector ('use_cache', 1), meta, data);
  if (debug)
    dbg_obj_princ (S, st, msg);
  if (st = '00000')
    return data;
  return vector ();
}
;

create procedure ODS.ODS_API."ontology.load" (
  in ontology varchar,
  in needCheck integer := 1)
{
  declare S, data any;

  -- check graph ontology
  if (needCheck)
  {
    S := sprintf('SPARQL select count (*) from <%s> {?s ?p ?o}', ontology);
    data := ODS.ODS_API."ontology.sparql" (S);
    if (length(data) and (data[0][0] > 0))
      return;
  }

  -- clear graph ontology
  S := sprintf('SPARQL clear graph <%s>', ontology);
  ODS.ODS_API."ontology.sparql" (S);

  -- load ontology
  S := sprintf('SPARQL load <%s> into graph <%s>', ontology, ontology);
  ODS.ODS_API."ontology.sparql" (S);
}
;

create procedure ODS.ODS_API."ontology.objectProperty" (
  in ontology varchar,
  in prefix varchar,
  in property any)
{
  declare retValue any;

  retValue := vector_concat (jsonObject (), vector ('name', ODS.ODS_API."ontology.normalize2" (ontology, prefix, property[0])));
  if (length (property[1]))
    retValue := vector_concat (retValue, vector ('objectProperties', property[1]));
  if (length (property[2]))
    retValue := vector_concat (retValue, vector ('datatypeProperties', property[2]));

  return retValue;
}
;

create procedure ODS.ODS_API."ontology.array" ()
{
  return vector (
                 'acl',  'http://www.w3.org/ns/auth/acl#',
                 'annotation', 'http://www.w3.org/2000/10/annotation-ns#',
                 'atom', 'http://atomowl.org/ontologies/atomrdf#',
                 'book', 'http://purl.org/NET/book/vocab#',
                 'dc',   'http://purl.org/dc/elements/1.1/',
                 'foaf', 'http://xmlns.com/foaf/0.1/',
                 'frbr', 'http://vocab.org/frbr/core#',
                 'gr',   'http://purl.org/goodrelations/v1#',
                 'ibis', 'http://purl.org/ibis#',
                 'ical', 'http://www.w3.org/2002/12/cal/icaltzd#',
                 'like', 'http://ontologi.es/like#',
                 'mo',   'http://purl.org/ontology/mo/',
                 'movie','http://www.csd.abdn.ac.uk/~ggrimnes/dev/imdb/IMDB#',
                 'owl',  'http://www.w3.org/2002/07/owl#',
                 'rdf',  'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
                 'rdfs', 'http://www.w3.org/2000/01/rdf-schema#',
                 'rel',  'http://purl.org/vocab/relationship/',
                 'rev',  'http://purl.org/stuff/rev#',
                 'sioc', 'http://rdfs.org/sioc/ns#',
                 'sioct','http://rdfs.org/sioc/types#',
                 'xsd',  'http://www.w3.org/2001/XMLSchema#'
                );
}
;

create procedure ODS.ODS_API."ontology.prefix" (
  in inValue varchar)
{
  declare pos any;

  pos := strrchr (inValue, ':');
  if (pos is not null)
    return subseq (inValue, 0, pos);
  return null;
}
;

create procedure ODS.ODS_API."ontology.byPrefix" (
  in prefix varchar)
{
  declare N, ontologies any;

  ontologies := ODS.ODS_API."ontology.array" ();
  for (N := 0; N < length (ontologies); N := N + 2)
  {
    if (prefix = ontologies[N])
      return ontologies[N+1];
  }
  return null;
}
;

create procedure ODS.ODS_API."ontology.normalize" (
  in inValue varchar,
  in ontologies any := null)
{
  if (not isnull (inValue))
  {
    declare N integer;

    if (isnull (ontologies))
    ontologies := ODS.ODS_API."ontology.array" ();
    for (N := 0; N < length (ontologies); N := N + 2)
    {
      if (inValue like (ontologies[N+1] || '%'))
        return ontologies[N] || ':' || subseq (inValue, length (ontologies[N+1]));
    }
  }
  return inValue;
}
;

create procedure ODS.ODS_API."ontology.normalize2" (
  in ontology varchar,
  in prefix varchar,
  in inValue varchar)
{
  if (not isnull (inValue))
  {
    if (inValue like (ontology || '%'))
      return prefix || ':' || subseq (inValue, length (ontology));
  }
  return ODS.ODS_API."ontology.normalize" (inValue);
}
;

create procedure ODS.ODS_API."ontology.denormalize" (
  in inValue varchar,
  in ontologies any := null)
{
  if (not isnull (inValue))
  {
    declare N, pos, tmp any;

    if (isnull (ontologies))
    ontologies := ODS.ODS_API."ontology.array" ();
    pos := strrchr (inValue, ':');
    if (pos is not null)
    {
      tmp := subseq (inValue, 0, pos);
      for (N := 0; N < length (ontologies); N := N + 2)
      {
        if (tmp = ontologies[N])
          return ontologies[N+1] || subseq (inValue, length (tmp)+1);
      }
    }
  }
  return inValue;
}
;

create procedure ODS.ODS_API."ontology.denormalize2" (
  in ontology varchar,
  in prefix varchar,
  in inValue varchar)
{
  if (not isnull (inValue))
  {
    if (inValue like (prefix || ':%'))
      return ontology || subseq (inValue, length (prefix)+1);
  }
  return ODS.ODS_API."ontology.denormalize" (inValue);
}
;

create procedure ODS.ODS_API."ontology.collection" (
  in ontology varchar,
  in inValue varchar)
{
  declare N integer;
  declare node, steps, tmp, tmp2, S varchar;
  declare data, collection any;

  N := 0;
  node := 'b%d';
  steps := '?_%s rdf:first ?r . ?_%s rdf:rest ?_rest';
  collection := vector ();

_again:
  tmp := sprintf (node, N);
  steps := sprintf (steps, tmp, tmp);
  S := sprintf(
         '\n SPARQL' ||
         '\n PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>' ||
         '\n PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>' ||
         '\n PREFIX owl: <http://www.w3.org/2002/07/owl#>' ||
         '\n SELECT ?r ?_rest' ||
         '\n   FROM <%s>' ||
         '\n  WHERE {' ||
         '\n          <%s> owl:unionOf ?_%s .' ||
         '\n          %s.'                         ||
         '\n        }',
         ontology,
         inValue,
         tmp,
         steps);
  data := ODS.ODS_API."ontology.sparql" (S);
  foreach (any item in data) do
  {
    tmp2 := ODS.ODS_API."ontology.normalize" (item[0]);
    if (not isnull (tmp2) and (tmp2 not like 'nodeID:%'))
    {
      collection := vector_concat (collection, vector (tmp2));
      tmp2 := ODS.ODS_API."ontology.normalize" (item[1]);
      if (tmp2 like 'nodeID:%')
      {
        N := N + 1;
        steps := replace ('?_%s rdf:rest ?_<XXX>. ', '<XXX>', tmp) || steps;
        goto _again;
      }
    }
  }
  return collection;
}
;

create procedure ODS.ODS_API."objects.rdf" (
  in items varchar,
  in format varchar := 'TTL')  __soap_http 'text/plain'
{
  declare accept, graph_iri, forum_iri, user_iri varchar;
  declare S, state, msg, accept, sStream any;
  declare ontologies, rows, meta any;

  graph_iri := ODS.ODS_API.graph_create ();
  forum_iri := graph_iri || '/forum';
  user_iri := graph_iri || '/user';

  ontologies := json_parse (items);
  foreach (any ontology in ontologies) do
  {
    SIOC..sioc_user_item_create (graph_iri, forum_iri, user_iri, get_keyword ('items', ontology, vector ()));
  }

  sStream := string_output();
  S := sprintf ('SPARQL select * from <%s> where {?s ?p ?o}', graph_iri);
  state := '00000';
  set_user_id ('dba');
  exec (S, state, msg, vector (), 0, meta, rows);
  if (state = '00000')
  {
    declare dict any;

    dict := dict_new (10);
    for (select S, P, O from DB.DBA.RDF_QUAD where G = iri_to_id (graph_iri)) do
      dict_put (dict, vector (S, P, O), 1);

    if (format = 'TTL')
    {
      sStream := DB.DBA.RDF_FORMAT_TRIPLE_DICT_AS_TTL (dict);
    } else {
      sStream := DB.DBA.RDF_FORMAT_TRIPLE_DICT_AS_RDF_XML (dict);
    }
  }
  ODS.ODS_API.graph_clear (graph_iri);
  return sprintf ('%V', string_output_string (sStream));
}
;

create procedure ODS.ODS_API."lookup.list" (
  in "key" varchar,
  in "param" varchar := '',
  in "depend" varchar := '')  __soap_http 'text/plain'
{
  if ("key" = 'onlineAccounts')
  {
     http (
                '12seconds'
      || '\n'|| 'Amazon.com'
      || '\n'|| 'Ameba'
      || '\n'|| 'Backtype'
      || '\n'|| 'Blog'
      || '\n'|| 'brightkite.com'
      || '\n'|| 'Custom RSS/Atom'
      || '\n'|| 'Dailymotion'
      || '\n'|| 'Del.icio.us'
      || '\n'|| 'Digg'
      || '\n'|| 'Diigo'
      || '\n'|| 'Disqus'
      || '\n'|| 'Facebook'
      || '\n'|| 'Flickr'
      || '\n'|| 'Fotolog'
      || '\n'|| 'FriendFeed'
      || '\n'|| 'Furl'
      || '\n'|| 'Gmail/Google Talk'
      || '\n'|| 'Goodreads'
      || '\n'|| 'Google Reader'
      || '\n'|| 'Google Shared Stuff'
      || '\n'|| 'identi.ca'
      || '\n'|| 'iLike'
      || '\n'|| 'Intense Debate'
      || '\n'|| 'Jaiku'
      || '\n'|| 'Joost'
      || '\n'|| 'Last.fm'
      || '\n'|| 'LibraryThing'
      || '\n'|| 'LinkedIn'
      || '\n'|| 'LiveJournal'
      || '\n'|| 'Ma.gnolia'
      || '\n'|| 'meneame'
      || '\n'|| 'Mister Wong'
      || '\n'|| 'Mixx'
      || '\n'|| 'MySpace'
      || '\n'|| 'Netflix'
      || '\n'|| 'Netvibes'
      || '\n'|| 'Pandora'
      || '\n'|| 'Photobucket'
      || '\n'|| 'Picasa Web Albums'
      || '\n'|| 'Plurk'
      || '\n'|| 'Polyvore'
      || '\n'|| 'Pownce'
      || '\n'|| 'Reddit'
      || '\n'|| 'Seesmic'
      || '\n'|| 'Skyrock'
      || '\n'|| 'SlideShare'
      || '\n'|| 'Smotri.com'
      || '\n'|| 'SmugMug'
      || '\n'|| 'StumbleUpon'
      || '\n'|| 'tipjoy'
      || '\n'|| 'Tumblr'
      || '\n'|| 'Twine'
      || '\n'|| 'Twitter'
      || '\n'|| 'Upcoming'
      || '\n'|| 'Vimeo'
      || '\n'|| 'Wakoopa'
      || '\n'|| 'Yahoo'
      || '\n'|| 'Yelp'
      || '\n'|| 'YouTube'
      || '\n'|| 'Zooomr'
    );
  }
  else if ("key" = 'webIDs')
  {
    declare uname, S varchar;

    S := '';
    if (ods_check_auth (uname))
    {
      declare uid integer;
      declare paramTest varchar;
      declare sql, st, msg, meta, rows any;

      uid := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
      paramTest := '';
      if ("param" <> '')
        paramTest := sprintf (' and lcase (x.F2) like ''%%%s%%''', lcase("param"));

      if ("depend" = '' or "depend" = 'p')
        sql := sprintf ('select x.F1, x.F2, x.F3 from DB.DBA.wa_webid_users(user_id) (F1 varchar, F2 varchar, F3 varchar) x where x.user_id = %d %s', uid, paramTest);

      if ("depend" = 'g')
        sql := sprintf ('select x.* from (select ''Group'' F1, SIOC..acl_group_iri (%d, WACL_NAME) F2, WACL_DESCRIPTION F3 from WA_GROUPS_ACL where WACL_USER_ID = %d) x where 1=1 %s', uid, uid, paramTest);

      set_user_id ('dba');
      st := '00000';
      exec (sql, st, msg, vector (), 0, meta, rows);
      if (st = '00000')
      {
        foreach (any row in rows) do
          S := S || case when S <> '' then '\n' else '' end || row[1];
      }
    }
    http (S);
  }
  else if ("key" = 'Industry')
  {
    http ('<items>');
    for (select WI_NAME from DB.DBA.WA_INDUSTRY order by WI_NAME) do {
      http (sprintf ('<item>%s</item>', WI_NAME));
    }
    http ('</items>');
  }
  else if ("key" = 'Country')
  {
    http ('<items>');
    for (select WC_NAME from DB.DBA.WA_COUNTRY order by WC_NAME) do {
      http (sprintf ('<item>%s</item>', WC_NAME));
    }
    http ('</items>');
  }
  else if ("key" = 'Province')
  {
    http ('<items>');
    for (select WP_PROVINCE from DB.DBA.WA_PROVINCE where WP_COUNTRY = "param" and WP_COUNTRY <> '' order by WP_PROVINCE) do {
      http (sprintf ('<item>%s</item>', WP_PROVINCE));
    }
    http ('</items>');
  }
  else if ("key" = 'DataSpaces')
  {
    http ('<items>');
    for (select SIOC..forum_iri (WAI_TYPE_NAME, WAI_NAME) as instance_iri, WAI_NAME
           from DB.DBA.SYS_USERS, DB.DBA.WA_MEMBER, DB.DBA.WA_INSTANCE
          where WAM_INST = WAI_NAME and WAM_USER = "param" and U_ID = WAM_USER) do
    {
      http (sprintf ('<item href="%V">%V</item>', instance_iri, WAI_NAME));
    }
    http ('</items>');
  }
  else if ("key" = 'WebServices')
  {
    declare N integer;
    declare sql varchar;
    declare st, msg, meta, rows any;

    sql := 'sparql
            PREFIX sioc: <http://rdfs.org/sioc/ns#>
            PREFIX foaf: <http://xmlns.com/foaf/0.1/>
            SELECT ?title, ?service_definition
              FROM <%s>
             WHERE {
                     ?forum foaf:maker <%s>.
                     ?forum sioc:id ?title.
                     ?forum sioc:has_service ?svc.
                     ?svc sioc:service_definition ?service_definition.
                     ?svc sioc:service_protocol "SOAP".
                   }
             ORDER BY ?title';

    sql := sprintf (sql, SIOC..get_graph (), SIOC..person_iri (SIOC..user_iri ("param")));
    st := '00000';

    set_user_id ('dba');
    exec (sql, st, msg, vector (), 0, meta, rows);
    http ('<items>');
    if ('00000' = st)
    {
      for (N := 0; N < length (rows); N := N + 1)
      {
        http (sprintf ('<item href="%V">%V</item>', rows[N][1], rows[N][0]));
      }
    }
    http ('</items>');
  }
  return '';
}
;

create procedure ODS.ODS_API.getDefaultHttps () __SOAP_HTTP 'text/plain'
{
  declare host, port, tmp varchar;

  host := null;
  port := null;
  for select top 1 HP_HOST, HP_LISTEN_HOST
        from DB.DBA.HTTP_PATH, DB.DBA.WA_DOMAINS
       where HP_PPATH like '/DAV/VAD/wa/%'
         and WD_HOST = HP_HOST
         and WD_LISTEN_HOST = HP_LISTEN_HOST
	       and WD_LPATH = HP_LPATH
	       and HP_HOST not like '*sslini*'
	       and HP_SECURITY = 'SSL'
	       and length (HP_HOST) do
	{
	  tmp := split_and_decode (HP_LISTEN_HOST, 0, '\0\0:');
	  if (length (tmp) = 2)
	    tmp := tmp[1];
	  else
	    tmp := HP_LISTEN_HOST;
	  host := HP_HOST;
	  port := tmp;
	  if (port <> '443')
	    host := host || ':' || port;
	}
  if (server_https_port () is not null and host is null)
  {
    host := registry_get ('URIQADefaultHost');
    tmp := split_and_decode (host, 0, '\0\0:');
    if (length (tmp) = 2)
	    tmp := tmp[0];
    else
	    tmp := host;

    port := server_https_port ();
    if (port <> '443')
	    host := tmp || ':' || port;
  }
  return host;
}
;

--!
-- \brief Get information about the ODS instance's configuration.
--
-- \param info The type of info to return. Supported values are
-- - \p sslPort This will return the SSL host and port of the ODS instance if available.
-- - \p regData This will return the registration and authentication configuration, ie. which
--   registration and authentication methods are available and enabled. See below for an example of the
--   returned data.
--
-- \return A JSON stream containing the requested information.
--
-- \b Example:
--
-- The following result shows that authentication via WebID, OpenID, Facebook, Twitter, and Google
-- are enabled while LinkedIn and Windows Live are disabled. \p digest refers to authentication or
-- registration via username and password. \p connect refers to connecting an external account with
-- an ODS account. The three blocks \p authenticate, \p register, and \p connect map to the actions
-- as defined in \ref ods_authentication_url_action.
--
-- \verbatim
-- {
--   "openidEnable":1,
--   "facebookEnable":1,
--   "twitterEnable":1,
--   "linkedinEnable":0,
--   "googleEnable":1,
--   "sslEnable":1,
--   "sslAutomaticEnable":1,
--   "authenticate":
--   {
--     "digest":1,
--     "webid":1,
--     "openid":1,
--     "facebook":1,
--     "twitter":1,
--     "linkedin":0,
--     "google":1,
--     "windowslive":0,
--     [...]
--   },
--   "register":
--   {
--     "digest":1,
--     "webid":1,
--     "openid":1,
--     "facebook":1,
--     "twitter":1,
--     "linkedin":0,
--     "google":1,
--     "windowslive":0,
--     [...]
--   },
--   "connect":
--   {
--     "webid":1,
--     "openid":1,
--     "facebook":1,
--     "twitter":1,
--     "linkedin":0,
--     "google":1,
--     "windowslive":0,
--     [...]
--   }
-- }
-- \endverbatim
--/
create procedure ODS.ODS_API."server.getInfo" (
  in info varchar,
  in json integer := 1) __soap_http 'application/json'
{
  declare retValue, params any;
  declare sslHost varchar;

  params := http_param ();
  retValue := null;
  if (info = 'sslPort')
  {
  	for select top 1 HP_HOST, HP_LISTEN_HOST
  	      from DB.DBA.HTTP_PATH, DB.DBA.WA_DOMAINS
  	     where HP_PPATH like '/DAV/VAD/wa/%' and WD_HOST = HP_HOST and WD_LISTEN_HOST = HP_LISTEN_HOST and WD_LPATH = HP_LPATH
  	       and HP_HOST not like '*sslini*' and HP_SECURITY = 'SSL' and length (HP_HOST) do
      {
    	   declare tmp any;
    	   tmp := split_and_decode (HP_LISTEN_HOST, 0, '\0\0:');
    	   if (length (tmp) = 2)
    	     tmp := tmp[1];
    	   else
    	     tmp := HP_LISTEN_HOST;
    	   retValue := vector ('sslPort', tmp, 'sslHost', HP_HOST);
   	  }
    if (retValue is null and server_https_port () is not null)
    {
      sslHost := http_host();
      sslHost := substring (sslHost, 1, coalesce (strstr (sslHost, ':'), length (sslHost)));
      retValue := vector ('sslPort', server_https_port (), 'sslHost', sslHost);
    }
  }
  else if (info = 'regData')
  {
    for (select TOP 1
         WS_LOGIN,
         WS_LOGIN_OPENID,
         WS_LOGIN_BROWSERID,
         WS_LOGIN_FACEBOOK,
         WS_LOGIN_TWITTER,
         WS_LOGIN_LINKEDIN,
         WS_LOGIN_GOOGLE,
         WS_LOGIN_WINLIVE,
         WS_LOGIN_WORDPRESS,
         WS_LOGIN_YAHOO,
         WS_LOGIN_TUMBLR,
         WS_LOGIN_DISQUS,
         WS_LOGIN_INSTAGRAM,
         WS_LOGIN_BITLY,
         WS_LOGIN_FOURSQUARE,
         WS_LOGIN_DROPBOX,
         WS_LOGIN_GITHUB,
         WS_LOGIN_SSL,
         WS_REGISTER,
         WS_REGISTER_OPENID,
         WS_REGISTER_BROWSERID,
         WS_REGISTER_FACEBOOK,
         WS_REGISTER_TWITTER,
         WS_REGISTER_LINKEDIN,
         WS_REGISTER_GOOGLE,
         WS_REGISTER_WINLIVE,
         WS_REGISTER_WORDPRESS,
         WS_REGISTER_YAHOO,
         WS_REGISTER_TUMBLR,
         WS_REGISTER_DISQUS,
         WS_REGISTER_INSTAGRAM,
         WS_REGISTER_BITLY,
         WS_REGISTER_FOURSQUARE,
         WS_REGISTER_DROPBOX,
         WS_REGISTER_GITHUB,
         WS_REGISTER_SSL,
         WS_REGISTER_AUTOMATIC_SSL from DB.DBA.WA_SETTINGS) do
    {
      declare loginFacebookEnable, loginTwitterEnable, loginLinkedinEnable, loginGoogleEnable, loginWinliveEnable, loginWordpressEnable, loginYahooEnable, loginTumblrEnable, loginDisqusEnable, loginInstagramEnable, loginBitlyEnable, loginFoursquareEnable, loginDropboxEnable, loginGithubEnable integer;
      declare facebookEnable, twitterEnable, linkedinEnable, googleEnable, winliveEnable, wordpressEnable, yahooEnable, tumblrEnable, disqusEnable, instagramEnable, bitlyEnable, foursquareEnable, dropboxEnable, githubEnable integer;
      declare haveFacebookApiID, haveTwitterApiID, haveLinkedinApiID, haveGoogleApiID, haveWinliveApiID, haveWordpressApiID, haveYahooApiID, haveTumblrApiID, haveDisqusApiID, haveInstagramApiID, haveBitlyApiID, haveFoursquareApiID, haveDropboxApiID, haveGitHubApiID integer;
      declare facebookApiID varchar;
      declare tmp any;

      -- FIXME: We do not want to expose this. As soon as the 2000 UI has been ported to the new auth/reg API, remove it.
      facebookApiID := (select a_key from OAUTH.DBA.APP_REG where a_owner = 0 and a_name = 'Facebook API');

      haveFacebookApiID := ODS.DBA.ods_get_service_client_key('Facebook API', tmp);
      haveTwitterApiID := ODS.DBA.ods_get_service_client_key('Twitter API', tmp);
      haveLinkedinApiID := ODS.DBA.ods_get_service_client_key('LinkedIn API', tmp);
      haveGoogleApiID := ODS.DBA.ods_get_service_client_key('Google API', tmp);
      haveWinliveApiID := ODS.DBA.ods_get_service_client_key('Windows Live API', tmp);
      haveWordpressApiID := ODS.DBA.ods_get_service_client_key('Wordpress API', tmp);
      haveYahooApiID := ODS.DBA.ods_get_service_client_key('Yahoo API', tmp);
      haveTumblrApiID := ODS.DBA.ods_get_service_client_key('Tumblr API', tmp);
      haveDisqusApiID := ODS.DBA.ods_get_service_client_key('Disqus API', tmp);
      haveInstagramApiID := ODS.DBA.ods_get_service_client_key('Instagram API', tmp);
      haveBitlyApiID := ODS.DBA.ods_get_service_client_key('Bitly API', tmp);
      haveFoursquareApiID := ODS.DBA.ods_get_service_client_key('Foursquare API', tmp);
      haveDropboxApiID := ODS.DBA.ods_get_service_client_key('DropBox API', tmp);
      haveGitHubApiID := ODS.DBA.ods_get_service_client_key('GitHub API', tmp);

      loginFacebookEnable := case when (WS_LOGIN_FACEBOOK and haveFacebookApiID) then 1 else 0 end;
      loginTwitterEnable := case when (WS_LOGIN_TWITTER and haveTwitterApiID) then 1 else 0 end;
      loginLinkedinEnable := case when (WS_LOGIN_LINKEDIN and haveLinkedinApiID) then 1 else 0 end;
      loginGoogleEnable := case when (WS_LOGIN_GOOGLE and haveGoogleApiID) then 1 else 0 end;
      loginWinliveEnable := case when (WS_LOGIN_WINLIVE and haveWinliveApiID) then 1 else 0 end;
      loginWordpressEnable := case when (WS_LOGIN_WORDPRESS and haveWordpressApiID) then 1 else 0 end;
      loginYahooEnable := case when (WS_LOGIN_YAHOO and haveYahooApiID) then 1 else 0 end;
      loginTumblrEnable := case when (WS_LOGIN_TUMBLR and haveTumblrApiID) then 1 else 0 end;
      loginDisqusEnable := case when (WS_LOGIN_DISQUS and haveDisqusApiID) then 1 else 0 end;
      loginInstagramEnable := case when (WS_LOGIN_INSTAGRAM and haveInstagramApiID) then 1 else 0 end;
      loginBitlyEnable := case when (WS_LOGIN_BITLY and haveBitlyApiID) then 1 else 0 end;
      loginFoursquareEnable := case when (WS_LOGIN_FOURSQUARE and haveFoursquareApiID) then 1 else 0 end;
      loginDropboxEnable := case when (WS_LOGIN_DROPBOX and haveDropboxApiID) then 1 else 0 end;
      loginGithubEnable := case when (WS_LOGIN_GITHUB and haveGitHubApiID) then 1 else 0 end;

      facebookEnable := case when (WS_REGISTER_FACEBOOK and haveFacebookApiID) then 1 else 0 end;
      twitterEnable := case when (WS_REGISTER_TWITTER and haveTwitterApiID) then 1 else 0 end;
      linkedinEnable := case when (WS_REGISTER_LINKEDIN and haveLinkedinApiID) then 1 else 0 end;
      googleEnable := case when (WS_REGISTER_GOOGLE and haveGoogleApiID) then 1 else 0 end;
      winliveEnable := case when (WS_REGISTER_WINLIVE and haveWinliveApiID) then 1 else 0 end;
      wordpressEnable := case when (WS_REGISTER_WORDPRESS and haveWordpressApiID) then 1 else 0 end;
      yahooEnable := case when (WS_REGISTER_YAHOO and haveYahooApiID) then 1 else 0 end;
      tumblrEnable := case when (WS_REGISTER_TUMBLR and haveTumblrApiID) then 1 else 0 end;
      disqusEnable := case when (WS_REGISTER_DISQUS and haveDisqusApiID) then 1 else 0 end;
      instagramEnable := case when (WS_REGISTER_INSTAGRAM and haveInstagramApiID) then 1 else 0 end;
      bitlyEnable := case when (WS_REGISTER_BITLY and haveBitlyApiID) then 1 else 0 end;
      foursquareEnable := case when (WS_REGISTER_FOURSQUARE and haveFoursquareApiID) then 1 else 0 end;
      dropboxEnable := case when (WS_REGISTER_DROPBOX and haveDropboxApiID) then 1 else 0 end;
      githubEnable := case when (WS_REGISTER_GITHUB and haveGitHubApiID) then 1 else 0 end;

      -- At the moment of this writing Tumblr did not expose the email address via the API. Thus, we cannot register with Tumblr.
      -- Once we have additional parameter handling in user.authenticate.authenticationUrl to allow setting a custom email we can
      -- remove the following:
      tumblrEnable := 0;

      -- CAUTION/FIXME: This info block contains the authentication information in two forms: 1. the old plain way and 2. the new nested way.
      --                The former information is kept for backwards compatibility. But the goal is to get rid of it.
  	  retValue := vector (
                          'login', WS_LOGIN,
                          'loginOpenidEnable', WS_LOGIN_OPENID,
                          'loginFacebookEnable', loginFacebookEnable,
                          'loginTwitterEnable', loginTwitterEnable,
                          'loginLinkedinEnable', loginLinkedinEnable,
                          'loginSslEnable', WS_LOGIN_SSL,
  	                      'openidEnable', WS_REGISTER_OPENID,
  	                      'facebookEnable', facebookEnable,
                          'facebookApiID', facebookApiID,
  	                      'twitterEnable', twitterEnable,
  	                      'linkedinEnable', linkedinEnable,
  	                      'sslEnable', WS_REGISTER_SSL,
                          'sslAutomaticEnable', WS_REGISTER_AUTOMATIC_SSL,
                          'authenticate', array2Obj(vector (
                            'digest', WS_LOGIN,
                            'webid', WS_LOGIN_SSL,
                            'openid', WS_LOGIN_OPENID,
                            'browserid', WS_LOGIN_BROWSERID,
                            'facebook', loginFacebookEnable,
                            'twitter', loginTwitterEnable,
                            'linkedin', loginLinkedinEnable,
                            'google', loginGoogleEnable,
                            'windowslive', loginWinliveEnable,
                            'wordpress', loginWordpressEnable,
                            'yahoo', loginYahooEnable,
                            'tumblr', loginTumblrEnable,
                            'disqus', loginDisqusEnable,
                            'instagram', loginInstagramEnable,
                            'bitly', loginBitlyEnable,
                            'foursquare', loginFoursquareEnable,
                            'dropbox', loginDropboxEnable,
                            'github', loginGithubEnable
                          )),
                          'register', array2Obj(vector (
                            'digest', WS_REGISTER,
                            'webid', WS_REGISTER_SSL,
                            'openid', WS_REGISTER_OPENID,
                            'browserid', WS_REGISTER_BROWSERID,
                            'facebook', facebookEnable,
                            'twitter', twitterEnable,
                            'linkedin', linkedinEnable,
                            'google', googleEnable,
                            'windowslive', winliveEnable,
                            'wordpress', wordpressEnable,
                            'yahoo', yahooEnable,
                            'tumblr', tumblrEnable,
                            'disqus', disqusEnable,
                            'instagram', instagramEnable,
                            'bitly', bitlyEnable,
                            'foursquare', foursquareEnable,
                            'dropbox', dropboxEnable,
                            'github', githubEnable
                          )),
                          'connect', array2Obj(vector (
                            'webid', 1,
                            'openid', 1,
                            'browserid', 1,
                            'facebook', haveFacebookApiID,
                            'twitter', haveTwitterApiID,
                            'linkedin', haveLinkedinApiID,
                            'google', haveGoogleApiID,
                            'windowslive', haveWinliveApiID,
                            'wordpress', haveWordpressApiID,
                            'yahoo', haveYahooApiID,
                            'tumblr', haveTumblrApiID,
                            'disqus', haveDisqusApiID,
                            'instagram', haveInstagramApiID,
                            'bitly', haveBitlyApiID,
                            'foursquare', haveFoursquareApiID,
                            'dropbox', haveDropboxApiID,
                            'github', haveGitHubApiID
                          ))
  	                     );
  	}
  }
  if (json)
  return params2json (retValue);

  return retValue;
}
;

-- address geo data
create procedure ODS.ODS_API."address.geoData" (
  in address1 varchar := '',
  in address2 varchar := '',
  in city varchar := '',
  in state varchar := '',
  in code varchar := '',
  in country varchar := '') __soap_http 'application/json'
{
  declare lat, lng double precision;
  declare retValue any;

  retValue := null;
  if (0 <> DB.DBA.WA_MAPS_ADDR_TO_COORDS (
        trim (coalesce (address1, '')),
        trim (coalesce (address2, '')),
        trim (coalesce (city, '')),
        trim (coalesce (state, '')),
        trim (coalesce (code, '')),
        trim (coalesce (country, '')),
        lat,
        lng
    ))
  {
    retValue := vector ('lat', sprintf ('%.6f', coalesce (lat, 0.00)), 'lng', sprintf ('%.6f', coalesce (lng, 0.00)));
  }
  return params2json (retValue);
}
;

--!
-- Utility procedure to map a facebook account to an ODS user.
-- The issue is that ODS stores Facebook URIs. These have changed in the past. So at the moment of
-- this writing there are three possible URL variants. These are all checked here based on Facebook
-- username and numerical ID.
--/
create procedure ODS..facebook_to_ods_user (
  in username varchar,
  in id varchar)
{
  return (select U_NAME
          from DB.DBA.SYS_USERS,
               DB.DBA.WA_USER_OL_ACCOUNTS
          where WUO_U_ID = U_ID
                and WUO_TYPE = 'P'
                and (WUO_URL = DB.DBA.WA_USER_OL_ACCOUNTS_FACEBOOK (cast (id as integer)) or
                     WUO_URL = DB.DBA.WA_USER_OL_ACCOUNTS_FACEBOOK_URI (username) or
                     WUO_URL = DB.DBA.WA_USER_OL_ACCOUNTS_FACEBOOK_URI (id)));
}
;


--!
-- \brief Check if a certain user account name is available.
--
-- Before creating an account via user.register() this method can be used
-- to check the availability of the user name and the email address.
--
-- Although both parameters are marked as optional reliable results are only
-- obtained if both parameters are given.
--
-- \param name The user account name to check.
-- \param email The corresponding email address.
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
-- If the account name and email address are available \p 1 is returned. Otherwise an error code and a human readable message
-- indicating the problem are returned.
--
-- \b Example:
-- \verbatim
-- $ curl -i http://demo.openlinksw.com/ods/api/user.checkAvailability?name=demo2&email=demo2@hello.com
--
-- HTTP/1.1 200 OK
-- Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu
-- Connection: Keep-Alive
-- Date: Tue, 17 Apr 2012 15:44:46 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="UTF-8"
-- Content-Length: 57
--
-- <result><code>1</code><message>Success</message></result>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.checkAvailability" (
  in name varchar := null,
	in email varchar := null) __soap_http 'text/xml'
{
  declare exit handler for sqlstate '*'
  {
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (name is null or length (name) < 1 or length (name) > 20)
    signal ('23023', 'Login name cannot be empty or longer than 20 chars');

  if (regexp_match ('^[A-Za-z0-9_.@-]+\$', name) is null)
    signal ('23023', 'The login name contains invalid characters');

  if (exists (select 1 from DB.DBA.SYS_USERS where U_NAME = name))
    signal ('23023', 'This login name is already registered');

  if (email is null or length (email) < 1 or length (email) > 40)
    signal ('23023', 'E-mail address cannot be empty or longer then 40 chars');

  if (regexp_match ('[^@ ]+@([^\. ]+\.)+[^\. ]+', email) is null)
    signal ('23023', 'Invalid E-mail address');

  if (exists (select 1 from DB.DBA.SYS_USERS where U_E_MAIL = email) and exists (select 1 from DB.DBA.WA_SETTINGS where WS_UNIQUE_MAIL = 1))
    signal ('23023', 'This e-mail address is already registered');

  return ods_serialize_int_res (1);
}
;

--!
-- \brief Register a new user account.
--
-- ODS allows to register new accounts in several ways, ranging from simple a username/password combination to registration through an existing Twitter account.
-- Some registration methods such as the registration via OAuth or OpenID requires more than one step. However, any registration method ends with a call to
-- user.register() which will create the actual ODS account.
--
-- For security reasons it is highly recommended to perform any registration calls through a secure connection.
--
-- \section ods_user_register_password Classical Registration via Username and Password
--
-- Registration via username and password is as easy as calling user.register() with the \p name, \p password, and \p email parameters filled. If the \p name is not
-- in use yet and the \p email address is either unique or ODS has been configured to allow non-unique email addresses, then a new user account will be created
-- which can immediately be used for \ref ods_authentication.
--
-- \section ods_user_register_openid Registration via OpenID
--
-- A new ODS account can be created through an existing OpenID. To that end the user needs to login with their OpenID before the account can be created. This process
-- involves three steps on behalf of the ODS client:
-- - Using the provided OpenID the client creates a login URL via user.openid.authenticationUrl() to which the user needs to be navigated.
-- - After the user did login successfully with the OpenID provider they are redirected to the ODS client according to the callback URL provided as a parameter to
--   user.openid.authenticationUrl(). The client then needs to convert the URL parameters into a form suitable for user.register()'s \p data parameter. This is
--   done via user.openid.registrationData().
-- - Finally user.register() is called with the mentioned \p data paramter, a \p mode of \p 1, and a suitable \p name and \p email. The latter two can be taken
--   from the \p data JSON blob in case the OpenID provider did add this information to the callback URL.
--
-- As a result the newly created ODS account will be connected to the given OpenID.
--
-- \section ods_user_register_webid Registration via WebID
--
-- Creating a new ODS account via an existing WebID involves two steps:
-- - Fetch details about the profile accociated with the WebID via user.getFOAFData() which will return a blob of JSON data suitable for the \p data parameter.
-- - Call user.register() through an SSL connection with the mentioned \p data parameter, a \p mode of \p 3, and a suitable \p name and \p email. The SSL connection
--   is required for the browser to be able to provide the certificate with the embedded WebID.
--
-- As a result the newly created ODS account will be connected to the given WebID.
--
-- \section ods_user_register_oauth Registration via OAuth (Twitter, LinkedIn, Facebook)
--
-- ODS aupports the creation of user accounts based on existing accounts from Twitter, LinkedIn, or Facebook via their OAuth interfaces. Like with the OpenID
-- support this requires the user to log into the third party service and authenticate ODS to use the account. An ODS client performs the requried steps as
-- follows:
-- - A login URL is created via one of the authenticationUrl functions suitable for the service in question: user.oauth.twitter.authenticationUrl(),
--   user.oauth.linkedin.authenticationUrl() providing a callback URL.
-- - The client directs the user to the login URL from the previous step. Once the user sucessfully logged in and confirmed that ODS should indeed be allowed
--   to authenticate through that account, the OAuth-enabled service will redirect the user to the callback URL providing three parametes \p sid, \p oauth_verifier,
--   and \p oauth_token.
-- - The three parameters from the callback URL are used in one of the OAuth registrationData functions suitable for the service in question to prepare the \p data
--   blob required for user.register() : user.oauth.twitter.registrationData(), user.oauth.linkedin.registrationData()
-- - Finally user.register() is called with the mentioned \p data paramter, a suitable \p mode for the service in question, and a \p name and \p email. The \p name
--   is optional since it will be taken from the existing account profile of the third party service.
--
-- As a result the newly created ODS account will be connected to the given OAuth-enabled account.
--
--
-- \par Post Registration
-- ODS accounts which have not beed created with a classical password have a random password which can be changed later on via user.password_change() to enable
-- classical \ref ods_authentication_password_hash. In addition any of the supported registration and authentication methods can be added to an existing account
-- at any time through the user.update() or user.update.fields() functions.
--
-- \param name The user name for the new account. Except for \p mode \p 4 and \p 5 (Twitter and LinkedIn) this is mandatory. If omitted the username will be taken
--             from the third-party service data.
-- \param password The password for the new account. Only used if \p mode is \p 0. Otherwise authentication is done through the specified service without the need
-- for a specific ODS password.
-- \param email The email address for the new account. Except for \p mode \p 2 (Facebook) this is mandatory.
-- \param mode ODS supports different methods of authentication as detailed in \ref ods_authentication. For user registration ODS also supports several methods:
-- - \p 0 - Default registration via username and password. This is the default.
-- - \p 1 - Registration via OpenID.
-- - \p 2 - Registration via Facebook.
-- - \p 3 - Registration via FOAF+SSL/WebID.
-- - \p 4 - Registration via Twitter.
-- - \p 5 - Registration via LinkedIn.
-- \param data Additional registration details. The format depends on the registration \p mode.
-- - \p mode = \p 0 (username/password) - \p data is unused.
-- - \p mode = \p 1 (OpenID) - A JSON stream of profile details as created by user.openid.registrationData().
-- - \p mode = \p 2 (Facebook) - A JSON stream of profile data. This data is typically retrieved via user.oauth.facebook.registrationData().
-- - \p mode = \p 3 (FOAF+SSL/WebID) - A JSON stream of details retrieved from a WebID profile. One way of getting that information is user.getFOAFData().
-- - \p mode = \p 4 (Twitter) - An XML stream of Twitter user profile details. This data is typically retrieved via user.oauth.twitter.registrationData().
-- - \p mode = \p 5 (LinkedIn) - An XML stream of user information from LinkedIn. This data is typically retrieved via user.oauth.linkedin.registrationData().
--
-- \return On success a new user session as detailed in \ref ods_user_session_example is returned which can be used as described in \ref ods_authentication_session_id.
--
-- \sa \ref ods_authentication_oauth
--
-- \b Example:
-- \verbatim
-- $ curl -i "http://demo.openlinksw.com/ods/api/user.register?name=test123&password=1&email=test@yahoo.com"
--
-- HTTP/1.1 200 OK
-- Server: Virtuoso/05.12.3041 (Solaris) x86_64-sun-solaris2.10-64  VDB
-- Connection: Keep-Alive
-- Date: Mon, 28 Dec 2009 22:18:59 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="ISO-8859-1"
-- Content-Length: 59
--
-- <userSession>
--   <sid>1de236f5da2f32d92e8c0cce5053a96e</sid>
--   <user>
--     <uname>test123</uname>
--     <uid>132</uid>
--     <new>1</new>
--     <dba>0</dba>
--   </user>
-- </userSession>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.register" (
  in name varchar := null,
	in "password" varchar := null,
	in "email" varchar := null,
	in mode integer := 0,
	in data any := null) __soap_http 'text/xml'
{
  declare sid, rc, tmp, name2, xmlData any;
  declare registerData any;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  registerData := ODS.ODS_API."server.getInfo" ('regData', 0);
	if (mode = 1)
	{
	  -- OpenID
    if (get_keyword ('openidEnable', registerData, 0) = 0)
      signal ('22023', 'The OpenID registration type is disabled');

	  data := json_parse (data);
    "password" := uuid ();
	}
	else if (mode = 2)
	{
	  -- Facebook
    if (get_keyword ('facebookEnable', registerData, 0) = 0)
      signal ('22023', 'The Facebook registration type is disabled');

	  data := json_parse (data);
    "password" := uuid ();
	}
	else if (mode = 3)
	{
	  -- FOAF+SSL
    if (get_keyword ('sslEnable', registerData, 0) = 0)
      signal ('22023', 'The WebID registration type is disabled');

	  data := json_parse (data);
    "password" := uuid ();
	}
	else if (mode = 4)
	{
	  -- Twitter
    if (get_keyword ('twitterEnable', registerData, 0) = 0)
      signal ('22023', 'The Twitter registration type is disabled');

    xmlData := xml_tree_doc (data);
    if (xpath_eval ('string(/users/user/id)', xmlData))
      name2 := cast (xpath_eval ('string(/users/user/screen_name)', xmlData) as varchar);

    if (isnull (name))
      name := name2;

    "password" := uuid ();
	}
	else if (mode = 5)
	{
	  -- LinkedIn
    if (get_keyword ('linkedinEnable', registerData, 0) = 0)
      signal ('22023', 'The LinkedIn registration type is disabled');

    xmlData := xml_tree_doc (data);
    if (xpath_eval ('string(/person/first-name)', xmlData))
      name2 := cast (xpath_eval ('string(/person/first-name)', xmlData) as varchar);

    if (isnull (name))
      name := name2;

    "password" := uuid ();
	}

  if ((mode = 1) and get_keyword ('openid_url', data) is not null and exists (select 1 from DB.DBA.WA_USER_INFO where WAUI_OPENID_URL = get_keyword ('openid_url', data)))
    signal ('23023', 'This OpenID identity is already registered');

  if ((mode = 2) and not ODS..facebook_to_ods_user (name2, get_keyword ('id', data)) is null)
    signal ('23023', 'This Facebook identity is already registered');

  if ((mode = 4) and exists (select 1 from DB.DBA.WA_USER_OL_ACCOUNTS where WUO_TYPE = 'P' and WUO_NAME = 'Twitter' and WUO_URL = DB.DBA.WA_USER_OL_ACCOUNTS_TWITTER (name2)))
    signal ('23023', 'This Twitter identity is already registered');

  if ((mode = 5) and exists (select 1 from DB.DBA.WA_USER_OL_ACCOUNTS where WUO_TYPE = 'P' and WUO_NAME = 'LinkedIn' and WUO_URL = cast (xpath_eval ('string(/person/public-profile-url)', xmlData) as varchar)))
    signal ('23023', 'This LinkedIn identity is already registered');

  rc := DB.DBA.ODS_CREATE_USER (name, "password", "email");
  if (not isinteger (rc))
    signal ('23023', rc);

  if (mode = 1)
  {
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FULL_NAME', get_keyword ('name', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FIRST_NAME'   , get_keyword ('firstName', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_LAST_NAME'    , get_keyword ('family_name', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_GENDER', case get_keyword ('gender', data) when 'M' then 'male' when 'F' then 'female' else NULL end);
    DB.DBA.WA_USER_EDIT (name, 'WAUI_HCODE', get_keyword ('homeCode', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_HCOUNTRY', (select WC_NAME from DB.DBA.WA_COUNTRY where WC_ISO_CODE = upper (get_keyword ('homeCode', data))));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_HTZONE', get_keyword ('homeTimezone', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_OPENID_URL', get_keyword ('openid_url', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_OPENID_SERVER', get_keyword ('openid_server', data));
  }
  else if (mode = 2)
  {
    -- facebook
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FULL_NAME'    , get_keyword ('name', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FIRST_NAME'   , get_keyword ('firstName', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_LAST_NAME'    , get_keyword ('family_name', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_GENDER'       , get_keyword ('gender', data));

    tmp := get_keyword ('link', data);
    if (isnull (tmp))
    {
      tmp := get_keyword ('id', data);
      if (not isnull (tmp))
        tmp := DB.DBA.WA_USER_OL_ACCOUNTS_FACEBOOK_URI (get_keyword ('id', data));
    }
    if (not isnull (tmp))
    {
    insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE,  WUO_NAME, WUO_URL, WUO_URI)
      values (rc, 'P', 'Facebook', tmp, ODS.ODS_API."user.onlineAccounts.uri" (tmp));
  }
  }
  else if (mode = 3)
  {
    -- FOAF+SSL
    DB.DBA.WA_USER_EDIT (name, 'WAUI_TITLE'        , get_keyword ('title', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FULL_NAME'    , get_keyword ('name', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FIRST_NAME'   , get_keyword ('firstName', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_LAST_NAME'    , get_keyword ('family_name', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_BIRTHDAY'     , get_keyword ('birthday', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_GENDER'       , get_keyword ('gender', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_ICQ'          , get_keyword ('icqChatID', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_MSN'          , get_keyword ('msnChatID', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_AIM'          , get_keyword ('aimChatID', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_YAHOO'        , get_keyword ('yahooChatID', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_BORG_HOMEPAGE', get_keyword ('workplaceHomepage', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_WEBPAGE'      , get_keyword ('homepage', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_HPHONE'       , get_keyword ('phone', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_BORG_HOMEPAGE', get_keyword ('organizationHomepage', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_BORG'         , get_keyword ('organizationTitle', data));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_PHOTO_URL'    , get_keyword ('depiction', data));
    insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE, WUO_NAME, WUO_URL, WUO_URI, WUO_PUBLIC)
      values (rc, 'P', 'webid', get_keyword ('iri', data), get_keyword ('iri', data), 1);

    declare cert any;
    cert := client_attr ('client_certificate');
    insert into DB.DBA.WA_USER_CERTS (UC_U_ID, UC_CERT, UC_FINGERPRINT, UC_LOGIN) 
	values (rc, cert, get_certificate_info (6, cert, 0, ''), 1);
  }
  else if (mode = 4)
  {
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FULL_NAME'    , xpath_eval ('string(/users/user/name)', xmlData));
    tmp := DB.DBA.WA_USER_OL_ACCOUNTS_TWITTER (name2);
    insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE, WUO_NAME, WUO_URL, WUO_URI, WUO_PUBLIC)
      values (rc, 'P', 'Twitter', tmp, ODS.ODS_API."user.onlineAccounts.uri" (tmp), 1);
  }
  else if (mode = 5)
  {
    DB.DBA.WA_USER_EDIT (name, 'WAUI_FIRST_NAME'    , xpath_eval ('string(/person/first-name)', xmlData));
    DB.DBA.WA_USER_EDIT (name, 'WAUI_LAST_NAME'     , xpath_eval ('string(/person/last-name)', xmlData));
    tmp := cast (xpath_eval ('string(/person/public-profile-url)', xmlData) as varchar);
    insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE, WUO_NAME, WUO_URL, WUO_URI, WUO_PUBLIC)
      values (rc, 'P', 'LinkedIn', tmp, ODS.ODS_API."user.onlineAccounts.uri" (tmp), 1);
  }

  sid := ODS..ods_new_user_session(name, 0);
  return ODS.DBA.ods_serialize_user_session (sid, name, 1);
}
;

--!
-- An internal utility function used by authentication procs:
-- - user.authenticate.callback()
-- - user.authenticate.browserid()
-- - user.authenticate.webid()
--
-- It performs the final steps which are similar in all three situations:
-- create the new account, connect the online account to the ODS account.
--
-- On error the procedure will simple throw a signal which is handled
-- by the calling procedure.
--
-- \param action The performed action. If \p auto it will be set to the actual used value.
-- \param confirm The confirmation mode (auto, always, or never)
-- \param service The service type like "facebook" or "webid"
-- \param serviceId The identifier like the facebook profile URL or the actual WebID.
-- \param uname The authenticated ODS user. null if not authenticated.
-- \param newUsr A possible username as extracted from the external profile data.
-- \param newEmail A possible email as extracted from the external profile data.
--
-- \return The username of the ODS account which was authenticated, newly registered,
-- or connected to.
--/
create procedure ODS.DBA.ods_authenticate_finish (
  inout action varchar,
  in confirm varchar,
  in service varchar,
  in serviceId varchar,
  in uname varchar,
  in newUsr varchar,
  in newEmail varchar,
  in odsuser varchar := null)
{
  declare uid any;
  declare cid varchar;
  declare i int;
  declare tmpUsr varchar;


  -- Map the serviceId to an ODS account
  if (odsuser is null)
    odsuser := (select U_NAME from DB.DBA.SYS_USERS, DB.DBA.WA_USER_OL_ACCOUNTS where WUO_U_ID = U_ID and lcase(WUO_NAME) = lcase(service) and WUO_URL = serviceId);


    -- Login if there is an account, register otherwise
  if (action = 'auto')
{
    if (odsuser is null)
      action := 'register';
    else
      action := 'authenticate';
  }


  -- Finally perform the requested action
  if (action = 'authenticate')
  {
    if (odsuser is null)
      signal ('22023', sprintf('The %s account "%s" is not connected to any ODS account.', service, serviceId));

    -- Successfully verified and mapped to ODS account odsuser
    uname := odsuser;
}

  else -- action = 'register' or 'connect'
{
    -- Both for register and connect we need the BrowserID not to be connected to any ODS account
    if (not odsuser is null)
      signal ('22023', sprintf ('The %s account "%s" is already connected to ODS user account "%s".', service, serviceId, odsuser));

    if (action = 'register')
    {
      -- Prepare username (take first part of email address if too long
      while (length(newUsr) > 20)
      {
        i := strchr (newUsr, '@');
        if (i > 0)
          newUsr := left(newUsr, i);
        else
          newUsr := left(newUsr, 20);
      }

      -- Make username unique
      i := 0;
      tmpUsr := newUsr;
      while (not (select U_ID from DB.DBA.SYS_USERS where U_NAME = tmpUsr) is null)
      {
        i := i + 1;
        tmpUsr := sprintf ('%s%d', newUsr, i);
      }
      newUsr := tmpUsr;


      if (confirm = 'auto' and (newUsr is null or newEmail is null))
        confirm := 'always';

      if (confirm = 'always')
      {
        -- We create a new confirm session
        cid := DB.DBA.vspx_sid_generate ();
        insert into DB.DBA.WA_AUTH_CONFIRM_SESS(AUTH_SESS_CID, AUTH_SESS_CLIENT_IP, AUTH_SESS_SERVICE, AUTH_SESS_SERVICE_ID, AUTH_SESS_TIMESTAMP)
          values(cid, http_client_ip(), service, serviceId, now());

        -- Return the confirm session to the calling procedure
        return vector(
          'cid', cid,
          'service', coalesce(service, ''),
          'serviceId', coalesce(serviceId, ''),
          'newUsr', coalesce(newUsr, ''),
          'newEmail', coalesce(newEmail, '')
        );
      }

      else -- confirm = 'never'
      {
        -- Create the new user account
        uid := DB.DBA.ODS_CREATE_USER (newUsr, uuid(), newEmail);
        if (not isinteger (uid))
          signal ('22023', uid);
        uname := newUsr;
      }
    }

    else -- action = 'connect'
    {
      if (uname is null)
        signal ('22023', 'Trying to connect a service account to an ODS account without a valid session.');

      -- We already have an authenticated ODS user in "uname"
      uid := (select U_ID from DB.DBA.SYS_USERS where U_NAME=uname);
    }

    -- FIXME: OpenIDs should also be stored in WA_USER_OL_ACCOUNTS
    if (service = 'openid')
    {
      update DB.DBA.WA_USER_INFO
         set WAUI_OPENID_URL = serviceId,
             WAUI_OPENID_SERVER = http_param('openid.server')
       where WAUI_U_ID = uid;
    }
    else
    {
      -- Connect the service ID to the account from register or connect action
      insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE,  WUO_NAME, WUO_URL)
        values (uid, 'P', service, serviceId);
      -- TODO: add profile details including optional photo
      --       there probably is no other way then to convert each profile into a generic form and then add the data here.
      --       Thus, we basically need to have a "registrationData" for each service.
    }
  }


  return uname;
}
;

--!
-- \brief Create an authentication URL to log into or register with ODS through a third party service.
--
-- ODS supports a variety of third-party services for login and registration including Twitter, Facebook,
-- or Google. ODS clients can use this method to easily expose this functionality to their users. Clients
-- can either start authentication, registration or the connection of an ODS account with a third-party
-- service account.
--
-- \section ods_authentication_url_workflow Client Workflow
--
-- The workflow for a client is always the same irrespective of the service type:
-- -# The client requests an authentication URL via this method, specifying the \p service type (see below
--    for supported services, the \p action to take, and a callback URL.
-- -# The client navigates to the returned URL allowing the user to authenticate with the 3rd party service.
-- -# The 3rd party service redirects to ODS which concludes the action and performs the final redirect to
--    the \p callback URL provided by the client. The \p callback URL contains one the following:
--    -# A new ODS session ID in the \p userSession.sid parameter and a flag (\p 0 or \p 1) to indicate if a new account has been registered \p user.new.
--       See also \ref ods_authentication_session_id.
--    -# An authentication confirmation session consisting of the parameters \p confirmSession.cid, \p user.name,
--       \p user.email, \p onlineAccount.service, and \p onlineAccount.uid. See \ref ods_authentication_url_confirm
--       for details.
--    -# In the case of a workflow error an error messages in the \p error.msg parameter. Errors include such
--       conditions as a failed 3rd party service authentication or a missing detail in the profile for
--       registration (ODS for example requires an email address for account creation).
--
-- Clients can use server.getInfo() to retrieve the enabled services. A service is available if it
-- is enabled in the ODS configuration (all are enabled by default) and if the ODS instance contains
-- an application ID. Application IDs are typically created through the third-party service's web interface
-- and can be added by the ODS administrator via admin.apikeys.add(). (See below for links to the respective
-- admin pages and the required callback links.)
--
-- For security reasons the \p callback URL needs to match one of the configures clients URLs. See
-- admin.clients.new() for details.
--
-- \section ods_authentication_url_action Authentication Action Types
--
-- Clients can initiate three different types of actions revolving around third-party service accounts with
-- this methods. The actions are as follows:
--
-- - \p authenticate A basic authentication workflow which, if succesful results in the client being authenticated
--      with the ODS account which is connected to the 3rd-party service account the user logged into.
-- - \p register The creation of a new ODS account which will be connected to the 3rd-party service account the user
--      logged into. The new ODS account will have a random password set which can later be changed via user.password_change()
--      to allow authentication with classical username digest information.
-- - \p connect Connect an existing ODS account with a third-party service account. This is the convenient version of
--      user.onlineAccounts.new().
-- - \p auto In automatic mode ODS tries to choose the best fitting action. Should an ODS account be connected to the
--      3rd-party service account the user logged into \p authenticate will be chosen. Otherwise ODS will try to create
--      a new account like with \p register. Should the client provide authentication information according to \ref
--      ods_authentication ODS will try to connect the 3rd-party service account the user logged into with the
--      authenticated ODS account.
--
-- \section ods_authentication_url_confirm Authentication Confirmation Mode
--
-- ODS allows to create accounts by simply connecting them to third-party online accounts. Clients can either ask the user to confirm
-- the creation of the new account or have it done automatically. ODS supports three modes for registration confirmation:
-- - \p always ODS will always ask the client to confirm the creation of the new account.
-- - \p never ODS will never ask the client for confirmation. If certain details like the email are missing for account creation
--      it will simply fail.
-- - \p auto ODS will decide based on the available profile detail. If both username and email address are available the new account
--      will be created without confirmation. Otherwise ODS will request confirmation.
--
-- A verified and completed confirmation request can be confirmed to create the final account via user.authenticate.confirm().
--
-- \section ods_authentication_url_services Supported Services
--
-- ODS supports the following services for authentication and registration. Except for OpenID each service
-- uses one flavor of OAuth and requires a client ID and secret to be registered with ODS. Client IDs are managed
-- via admin.apikeys.add().
--
-- Most services require that a callback URL is stored with the client ID. The following list contains details on
-- the values to add for ODS. Keep in mind that both ODS and Virtuoso support OAuth workflows in other situations
-- like Briefcase external web drive mounting. These use different callback URLs which needs to be taken into
-- account when configuring certain services like Google.
--
-- - \p facebook Create a login link for Facebook. Client IDs including key and secret can be created at https://developers.facebook.com/apps.
--      The Facebook client app should be configured as "Website with Facebook login" with a site URL matching the host of the ODS installation.
--      Example: if ODS runs at <code>http://myhost.com/ods/api</code> then the URL in the Facebook app should be <code>http://myhost.com/</code>.
-- - \p google Create a login link for Google. Client IDs including key and secret can be created at https://code.google.com/apis/console/.
--      The redirect urls need to contain <code>http[s]://HOST[:PORT]/ods/api/user.authenticate.callback</code>.
-- - \p twitter Create a login link for Twitter. Consumer key and secret can be created at https://dev.twitter.com/apps.
--      The Twitter Callback URL should be set to the host of the ODS installation. See \p facebook above for an example.
-- - \p linkedin Create a login link for LinkedIn. Client IDs including API and secret key can be created at https://www.linkedin.com/secure/developer.
--      There is no need to specify a callback URL.
-- - \p windowslive Create a login link for Windows Live. Client IDs including API and secret key can be created at https://manage.dev.live.com/Applications/Index.
--      The redirect domain of the configured application needs to match the host of the ODS installation. See \p facebook above for an example.
-- - \p wordpress Create a login link for Wordpress. Client IDs including API and secret key can be created at https://developer.wordpress.com/apps/.
--      The redirect URL of the configured OAuth application needs to match the host of the ODS installation. See \p facebook above for an example.
-- - \p yahoo Create a login link for Yahoo. Client IDs including API and secret key can be created at https://developer.apps.yahoo.com/dashboard/createKey.html.
--      When creating the key make sure to select read/write permissions for the <em>Social Directory</em> scope.
--      The redirect URL of the configured OAuth application needs to match the host of the ODS installation. See \p facebook above for an example.
-- - \p tumblr Create a login link for Tumblr. Client IDs including API and secret key can be created at http://www.tumblr.com/oauth/apps.
--      The redirect URL of the configured OAuth application needs to match the host of the ODS installation. See \p facebook above for an example.
-- - \p disqus Create a login link for Disqus. Client IDs including API and secret key can be created at http://disqus.com/api/applications/.
--      ODS only requires the created application to have read access. The redirect URL of the configured OAuth application needs to match
--      the host of the ODS installation. See \p facebook above for an example.
-- - \p instagram Create a login link for Instagram. Client IDs including API and secret key can be created at http://instagram.com/developer/clients/manage/.
-- - \p bitly Create a login link for Bitly. Client IDs including API and secret key can be created at http://bitly.com/a/settings/advanced#oauthapps by
--      registering an OAuth 2 application. The application link should be set to the host of the ODS installation. See \p facebook above for an example.
-- - \p foursquare Create a login link for Foursquare. Client IDs including API and secret key can be created at https://foursquare.com/developers/apps.
--      The application link should be set to the host of the ODS installation. See \p facebook above for an example.
-- - \p dropbox Create a login link for DropBox. Client IDs including API and secret key can be created at https://www.dropbox.com/developers/apps. No callback
--      URL needs to be configured.
-- - \p github Create a login link for GitHub. Client IDs including API and secret key can be created at https://github.com/settings/applications/new.
--      The callback URL should be set to the host of the ODS installation. See \p facebook above for an example.
-- - \p openid (The actual OpenID is specified in \p data)
--
--
-- \param service The type of service to authenticate with. See the list above for supported services. An example would be \p google.
-- \param callback The client callback URL. Once the login is complete the user will be redirected here. ODS will add one of two parameters
--        to the URL depending on the success of the login. If the login was successful a new session ID will be provided in the \p sid
--        parameter. For details see \ref ods_authentication_session_id. If the login was not successful ODS will add query parameter \p error_msg
--        containing an error message.
-- \param action The action that should be taken. Can be one of \p authenticate, \p register, \p connect, or \p auto. See \ref ods_authentication_url_action
--        for details.
-- \param confirm FIXME: ADD CONFIRM DETAILS
-- \param data Optional data only required for \p openid login.
--
-- \return A URL pointing to the third-party's login page which will result in a redirection to ODS. Clients need to point their users to this URL.
--         In the case of an error like missing input or a disabled service this method will return with a 4xx HTTP error code.
--
-- \sa user.authenticate(), user.authenticate.browserid(), user.authenticate.webid()
--/
create procedure ODS.ODS_API."user.authenticate.authenticationUrl" (
  in service varchar,
  in callback varchar,
  in action varchar := 'authenticate',
  in confirm varchar := 'auto',
  in data varchar := null) __SOAP_HTTP 'text/plain'
{
  --
  -- CONCEPT:
  --
  -- The client will use the URL returned from this procedure to redirect the user.
  -- The URL created by this proc uses user.authenticate.callback as callback URL instead of the one given by the client.
  -- The client callback URL as well as any other parameters will be added as a query parameter in base64-encoded
  -- form (state). The latter is necessary to avoid problems with special chars in callback URLs (Facebook is a pain).
  -- Once the user logged in the service redirects to user.authenticate.callback which will conclude the ODS login process by
  -- fetching user information and matching that to an ODS account. Finally user.authenticate.callback concludes with a redirect to
  -- the client including the new session ID in the query parameters.
  --


  declare odsCallback, callbackParams varchar;
  declare clientKey any;
  declare uname, sid varchar;
  uname := null;


  -- This procedure is supposed to be called in an http context
  -- Thus, the error handler does produce http status codes
  declare exit handler for sqlstate '*'
  {
    rollback work;
    if (__SQL_STATE = '42000') -- permission denied
      http_status_set(403);
    else
      http_status_set(400); -- misc error
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };


  -- Check if the callback URL's domain is registered as a trusted application
  -- Without this malicious applications could log into ODS
  if (ODS.DBA.ods_check_client_url (callback) = 0)
  {
    signal ('42000', sprintf('Unknown callback domain "%s". Please register via admin.clients.new', callback));
  }


  -- Normalize and verify parameters
  if (service is null)
  {
    signal ('22023', 'No Service specified');
  }
  if (callback is null or callback = '')
  {
    signal ('22023', 'No callback URL specified');
  }
  service := lcase(service);
  action := lcase(action);
  confirm := lcase(confirm);


  -- Check the input parameters
  if (action <> 'authenticate' and action <> 'register' and action <> 'auto' and action <> 'connect')
  {
    signal ('22023', sprintf('Unknown authentication action: %s', action));
  }
  if (confirm <> 'never' and confirm <> 'always' and confirm <> 'auto')
  {
    signal ('22023', sprintf('Unknown confirmation mode: %s', confirm));
  }


  -- Check if authentication or registration with the service has been disabled
  -- In auto mode this will never be fired. Instead the callback will handle it
  if (cast (get_keyword (service, get_keyword (action, json_parse (ODS.ODS_API."server.getInfo" ('regData')))) as varchar) = '0')
  {
    signal ('42000', sprintf ('%s has been disabled for service %s.', action, service));
  }


  -- We need to encode a few parameters into our redirection URL for the service. That way we
  -- know what to do in our callback function
  --
  -- Some services allow arbitrary query params in the callback URL. For others, like Google
  -- we will simply put the params in the state parameter which is intended for this use.
  callbackParams := sprintf('service=%U&url=%U&confirm=%U', service, callback, confirm);


  -- For the connect action we need to be authenticated. So we check for authentication information if we might connect
  if (action = 'connect' or action = 'auto')
  {
    -- We cannot allow SSL authentication in auto mode, otherwise the result is not what the user expects (silent SSL authentication)
    declare inst_id integer;
    inst_id := null;
    if (not ods_check_auth2 (uname, inst_id, 'owner', (case when (action <> 'auto') then 1 else 0 end)))
    {
      if (action = 'connect')
        signal ('42000', sprintf ('Need to be authenticated to perform serivce account connection.'));
    }
    else
    {
      -- automatic mode will always add the account to the authenticated user
      if (action = 'auto')
        action := 'connect';

      -- If the client already created a session we will resue it, otherwise we create a new one to verify in the callback procedure
      sid := http_param ('sid');
      if (not exists (select 1 from DB.DBA.VSPX_SESSION where VS_SID = sid and VS_REALM = http_param ('realm') and VS_UID = uname))
        sid := ODS.DBA.ods_new_user_session(uname);

      callbackParams := sprintf('%s&sid=%U', callbackParams, sid);
    }
  }


  -- Encode the action into the parameters for the callback procedure
  callbackParams := sprintf('%s&action=%U', callbackParams, action);

  -- Some services get confused with special chars in the query params. Thus, we bas64-encode our params
  -- We also need to strip away the = chars since they are not allowed either and are not really part of the base64 encoded value
  callbackParams := replace(encode_base64(callbackParams), '=', '');


  -- Build our proxy callback URL
  odsCallback := ODS.DBA.ods_authenticate_callback_url();


  -- -----------------------------------------------------------------------------------
  -- OpenID
  -- -----------------------------------------------------------------------------------
  if (service = 'openid')
  {
    if (data is null or data = '')
    {
      signal ('22023', 'No OpenID specified.');
    }

    -- Append the OpenID to the callback URL so it is available in user.authenticate.callback
    odsCallback := odsCallback || sprintf('?state=%U&openid=%U', callbackParams, data);

    return ODS.ODS_API."user.openid.authenticationUrl" (data, odsCallback);
  }


  -- -----------------------------------------------------------------------------------
  -- Every service that needs a client id and secret (basically OAuth)
  -- -----------------------------------------------------------------------------------
  else
  {
    if (ODS.DBA.ods_get_service_client_key(service, clientKey) = 0)
    {
      signal ('22023', sprintf('No %s App ID has been added to this instance of ODS.', service));
    }

    -- -----------------------------------------------------------------------------------
    -- Facebook
    -- -----------------------------------------------------------------------------------
    if (service = 'facebook')
    {
      return sprintf('https://www.facebook.com/dialog/oauth?redirect_uri=%U&scope=email&client_id=%s&state=%s', odsCallback, clientKey[0], callbackParams);
    }


    -- -----------------------------------------------------------------------------------
    -- Google
    -- -----------------------------------------------------------------------------------
    else if (service = 'google')
    {
      return sprintf('https://accounts.google.com/o/oauth2/auth?response_type=code&redirect_uri=%U&state=%s&scope=%U&client_id=%s', odsCallback, callbackParams, 'https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile', clientKey[0]);
    }


    -- -----------------------------------------------------------------------------------
    -- Windows Live
    -- -----------------------------------------------------------------------------------
    else if (service = 'windowslive')
    {
      return sprintf('https://login.live.com/oauth20_authorize.srf?client_id=%U&scope=%U&response_type=code&redirect_uri=%U&state=%s', clientKey[0], 'wl.basic wl.signin', odsCallback, callbackParams);
    }


    -- -----------------------------------------------------------------------------------
    -- Wordpress
    -- -----------------------------------------------------------------------------------
    else if (service = 'wordpress')
    {
      return sprintf('https://public-api.wordpress.com/oauth2/authorize?client_id=%U&response_type=code&redirect_uri=%U&state=%s', clientKey[0], odsCallback, callbackParams);
    }


    -- -----------------------------------------------------------------------------------
    -- Disqus
    -- -----------------------------------------------------------------------------------
    else if (service = 'disqus')
    {
      return sprintf('https://disqus.com/api/oauth/2.0/authorize/?client_id=%U&response_type=code&redirect_uri=%U&scope=%U&state=%s', clientKey[0], odsCallback, 'read', callbackParams);
    }


    -- -----------------------------------------------------------------------------------
    -- Instagram
    -- -----------------------------------------------------------------------------------
    else if (service = 'instagram')
    {
      return sprintf('https://api.instagram.com/oauth/authorize/?client_id=%U&response_type=code&redirect_uri=%U&state=%s', clientKey[0], odsCallback, callbackParams);
    }


    -- -----------------------------------------------------------------------------------
    -- Bitly
    -- -----------------------------------------------------------------------------------
    else if (service = 'bitly')
    {
      -- Bitly does not support the OAuth 2 "state" parameter the way the rest of the OAuth 2 serivces do. We need to put it in the callback URL.
      return sprintf('https://bitly.com/oauth/authorize?client_id=%U&response_type=code&redirect_uri=%U', clientKey[0], sprintf('%s?state=%U', odsCallback, callbackParams));
    }


    -- -----------------------------------------------------------------------------------
    -- Foursquare
    -- -----------------------------------------------------------------------------------
    else if (service = 'foursquare')
    {
      return sprintf('https://foursquare.com/oauth2/authenticate?redirect_uri=%U&response_type=code&client_id=%s&state=%s', odsCallback, clientKey[0], callbackParams);
    }


    -- -----------------------------------------------------------------------------------
    -- GitHub
    -- -----------------------------------------------------------------------------------
    else if (service = 'github')
    {
      return sprintf('https://github.com/login/oauth/authorize?redirect_uri=%U&client_id=%s&state=%U&scope=user', odsCallback, clientKey[0], callbackParams);
    }


    -- -----------------------------------------------------------------------------------
    -- Twitter
    -- -----------------------------------------------------------------------------------
    else if (service = 'twitter')
    {
      return OAUTH.DBA.ods_oauth_one_authentication_url (clientKey[0], 'http://twitter.com/oauth/request_token', 'http://twitter.com/oauth/authenticate', sprintf('%s?state=%U', odsCallback, callbackParams));
    }


    -- -----------------------------------------------------------------------------------
    -- LinkedIn
    -- -----------------------------------------------------------------------------------
    else if (service = 'linkedin')
    {
      return OAUTH.DBA.ods_oauth_one_authentication_url (clientKey[0], 'https://api.linkedin.com/uas/oauth/requestToken?scope=r_basicprofile+r_emailaddress', 'https://www.linkedin.com/uas/oauth/authenticate', sprintf('%s?state=%U', odsCallback, callbackParams));
    }


    -- -----------------------------------------------------------------------------------
    -- Yahoo
    -- -----------------------------------------------------------------------------------
    else if (service = 'yahoo')
    {
      return OAUTH.DBA.ods_oauth_one_authentication_url (clientKey[0], 'https://api.login.yahoo.com/oauth/v2/get_request_token', 'https://api.login.yahoo.com/oauth/v2/request_auth', sprintf('%s?state=%U', odsCallback, callbackParams));
    }


    -- -----------------------------------------------------------------------------------
    -- Tumblr
    -- -----------------------------------------------------------------------------------
    else if (service = 'tumblr')
    {
      return OAUTH.DBA.ods_oauth_one_authentication_url (clientKey[0], 'http://www.tumblr.com/oauth/request_token', 'http://www.tumblr.com/oauth/authorize', sprintf('%s?state=%U', odsCallback, callbackParams));
    }


    -- -----------------------------------------------------------------------------------
    -- DropBox
    -- -----------------------------------------------------------------------------------
    else if (service = 'dropbox')
    {
      return OAUTH.DBA.ods_oauth_one_authentication_url (clientKey[0], 'https://api.dropbox.com/1/oauth/request_token', 'https://www.dropbox.com/1/oauth/authorize', sprintf('%s?state=%U', odsCallback, callbackParams), 'POST');
    }


    -- -----------------------------------------------------------------------------------
    -- UNKNOWN
    -- -----------------------------------------------------------------------------------
    else
    {
      signal ('22023', sprintf('Unknown authentication service type: "%s"', service));
    }
  }
}
;

--!
-- \brief Internal callback function used for user authentication.
--
-- This is an internal function which is used to process the authentication via OAuth-based
-- third-party APIs. Clients never need to call this function.
--/
create procedure ODS.ODS_API."user.authenticate.callback" (
  in state varchar) __SOAP_HTTP 'text/xml'
{
  declare errMsg, httpHeader varchar;
  declare token, data, sid, redirUrl, sig, _key, _val, serviceId, uname, activeOdsAcc, tmp varchar;
  declare oauthVerifier, oauthSid varchar;
  declare clientKey any;
  declare odsOpts, uriParams any;
  declare uid any;

  -- parameters which were provided to user.authenticate.authenticationUrl
  declare service, url, action, confirm varchar;

  -- values extracted from 3rd party profiles for registration
  declare newUsr, newEmail varchar;
  newUsr := null;
  newEmail := null;

  -- The session id after successful login or registration or as encoded in the parameters
  sid := null;
  -- The user name of the ODS account matching the 3rd party serivce profile
  uname := null;
  -- The authenticated ODS user in case action is "connect"
  activeOdsAcc := null;
  -- The 3rd party service id as used in ODS (often an URL)
  serviceId := null;


  -- This procedure is supposed to be called in an http context
  -- It will always perform a redirect and never fail
  http_status_set (303);
  declare exit handler for sqlstate '*'
  {
    rollback work;
    redirUrl := sprintf('%serror.msg=%U', redirUrl, __SQL_MESSAGE);
    http_header (sprintf('Location: %s\r\n', redirUrl));
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };


  --
  -- Decode the parameters
  --
  odsOpts := decode_base64(state);
  odsOpts := split_and_decode(odsOpts);
  service := get_keyword('service', odsOpts);
  url := get_keyword('url', odsOpts);
  action := get_keyword('action', odsOpts);
  confirm := get_keyword('confirm', odsOpts);
  sid := get_keyword('sid', odsOpts);


  -- Prepare the redirection URL
  redirUrl := url;
  if (strcontains(redirUrl, '?'))
    redirUrl := redirUrl || '&';
  else
    redirUrl := redirUrl || '?';


  --
  -- For the "connect" action we need to be authenticated, thus "sid" needs to be a valid session which maps to a user account
  --
  if (action = 'connect')
  {
    -- Map the session id to an ODS account
    select VS_UID into activeOdsAcc from DB.DBA.VSPX_SESSION where VS_SID = sid and VS_REALM = 'wa';
  }


  -- ===================================================================================
  -- STEP 1: Verify the OAuth information, fetch profile data from service, and map to ODS user
  -- ===================================================================================

  -- -----------------------------------------------------------------------------------
  -- OpenID
  -- -----------------------------------------------------------------------------------
  if(service = 'openid')
  {
    -- Get the login URL we need for user.authenticate

    -- Add basic OpenID parameters to the login URL
    token := http_param('openid.server');
    if (strcontains(token, '?'))
      token := token || '&';
    else
      token := token || '?';
    token := token || 'openid.mode=check_authentication'
      || sprintf('&openid.assoc_handle=%U', http_param('openid.assoc_handle'))
      || sprintf('&openid.sig=%U', http_param('openid.sig'))
      || sprintf('&openid.signed=%U', http_param('openid.signed'));

    sig := split_and_decode(http_param('openid.signed'), 0, '\0\0,');
    for (declare i int, i := 0; i < length(sig); i := i + 1)
    {
      _key := trim(sig[i]);
      if (_key <> 'mode' and
          _key <> 'signed' and
          _key <> 'assoc_handle')
      {
        _val := http_param('openid.' || _key);
        if (not _val is null and _val <> '')
          token := token || sprintf('&openid.%s=%U', _key, _val);
      }
    }

    tmp := http_client (token);
    if (tmp not like '%is_valid:%true\n%')
      signal ('22023', 'OpenID Authentication Failed.');

    serviceId := http_param('openid');
    uname := (select U_NAME from DB.DBA.WA_USER_INFO, DB.DBA.SYS_USERS where WAUI_U_ID = U_ID and rtrim (WAUI_OPENID_URL, '/') = rtrim (serviceId, '/'));

    -- All profile details are added as URL params, we simply search the ones we need supporting different namespaces
    uriParams := http_param();
    for (declare i, l int, i := 0, l := length (uriParams); i < l; i := i + 2)
    {
      if (ends_with(uriParams[i], 'email'))
        newEmail := uriParams[i+1];
      else if (newUsr is null and (ends_with(uriParams[i], 'fname') or ends_with(uriParams[i], 'fullname')))
        newUsr := uriParams[i+1];
      else if (ends_with(uriParams[i], 'nickname'))
        newUsr := uriParams[i+1];
    }

    -- fallback username
    if (newUsr is null)
      newUsr := serviceId;
  }


  -- -----------------------------------------------------------------------------------
  -- Every service that needs a client id and secret (basically OAuth)
  -- -----------------------------------------------------------------------------------
  else
  {
    if (ODS.DBA.ods_get_service_client_key(service, clientKey) = 0)
    {
      signal ('22023', sprintf('No %s App ID has been added to this instance of ODS.', service));
    }

    -- -----------------------------------------------------------------------------------
    -- Facebook
    -- -----------------------------------------------------------------------------------
    if (service = 'facebook')
    {
      -- Check for code
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error_description'));
      }

      -- Convert the Facebook code into an access token
      token := http_get (sprintf('https://graph.facebook.com/oauth/access_token?client_id=%s&client_secret=%s&code=%s&redirect_uri=%U', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url()));

      -- TODO: error handling for the http get above
      token := get_keyword('access_token', split_and_decode(token));

      -- Fetch the Facebook profile details
      data := http_get (sprintf('https://graph.facebook.com/me?access_token=%s', token));

      -- Extract the details we need and map to ODS account
      data := json_parse(data);
      serviceId := get_keyword('id', data);
      if (serviceId is null or serviceId = '')
      {
        -- FIXME: get actual error message
        signal ('22023', 'Facebook authorization failed. Could not fetch profile details.');
      }

      newUsr := get_keyword ('username', data);
      newEmail := get_keyword ('email', data);
      uname := ODS.DBA.facebook_to_ods_user (newUsr, serviceId);
      serviceId := DB.DBA.WA_USER_OL_ACCOUNTS_FACEBOOK_URI (coalesce (get_keyword ('username', data), serviceId));
    }


    -- -----------------------------------------------------------------------------------
    -- Google
    -- -----------------------------------------------------------------------------------
    else if (service = 'google')
    {
      token := get_keyword('code', http_param());
      if (token is null or token = '')
        signal('22023', http_param('error'));

      -- Convert the Google OAuth 2.0 code into an access token. Google's API requires this to be a HTTPS POST
      declare header any;
      data := http_get ('https://accounts.google.com/o/oauth2/token',
                        header,
                        'POST',
                        null,
                        sprintf('client_id=%s&client_secret=%s&code=%s&redirect_uri=%U&grant_type=authorization_code', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url()));

      token := get_keyword('access_token', json_parse(data));
      if (token is null or token = '')
        signal ('22023', sprintf('Failed to obtain Google OAuth token: %s', get_keyword('error', json_parse(data))));

      -- Fetch the Google profile details
      data := http_get (sprintf('https://www.googleapis.com/oauth2/v1/userinfo?access_token=%s', token));
       -- Extract the Email address from the Google account
      data := json_parse(data);
      serviceId := get_keyword ('email', data);
      if (serviceId is null or serviceId = '')
      {
        -- FIXME: get actual error message
        signal ('22023', 'Google authorization failed. Could not fetch profile details.');
      }

      newUsr := serviceId;
      newEmail := coalesce (get_keyword('email', data), serviceId);
    }


    -- -----------------------------------------------------------------------------------
    -- Windows Live
    -- -----------------------------------------------------------------------------------
    else if (service = 'windowslive')
    {
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error'));
      }

      -- Convert the Windows Live OAuth 2.0 code into an access token. Windows Live's API requires this to be a HTTPS POST
      declare header any;
      data := http_get ('https://login.live.com/oauth20_token.srf',
                        header,
                        'POST',
                        null,
                        sprintf('client_id=%s&client_secret=%s&code=%s&redirect_uri=%U&grant_type=authorization_code', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url()));

      token := get_keyword('access_token', json_parse(data));
      if (token is null or token = '')
      {
        signal ('22023', sprintf('Failed to obtain Windows Live OAuth token: %s', get_keyword('error', json_parse(data))));
      }

      -- Fetch the Windows Live profile details
      data := http_get (sprintf('https://apis.live.net/v5.0/me?access_token=%s', token));

      -- Extract the Windows Live profile link of the form http://profile.live.com/cid-7a6b1666d21a866b/
      data := json_parse(data);
      serviceId := get_keyword ('link', data);
      if (serviceId is null or serviceId = '')
      {
        -- FIXME: get actual error message
        signal ('22023', 'Windows Live authorization failed. Could not fetch profile details.');
      }

      newUsr := lcase(replace(get_keyword ('name', data), ' ', '_')); -- FIXME: create a better name ->username conversion
      newEmail := get_keyword ('account', data);
    }


    -- -----------------------------------------------------------------------------------
    -- Wordpress
    -- -----------------------------------------------------------------------------------
    else if (service = 'wordpress')
    {
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error'));
      }

      -- Convert the Wordpress OAuth 2.0 code into an access token. Wordpress' API requires this to be a HTTPS POST
      declare header any;
      data := http_get ('https://public-api.wordpress.com/oauth2/token',
                        header,
                        'POST',
                        null,
                        sprintf('client_id=%U&client_secret=%s&code=%s&redirect_uri=%U&grant_type=authorization_code', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url()));

      token := get_keyword('access_token', json_parse(data));
      if (token is null or token = '')
      {
        signal ('22023', sprintf('Failed to obtain Wordpress OAuth token: %s', get_keyword('error', json_parse(data))));
      }

      -- Fetch the Wordpress profile details using the token in an authorization header
      data := http_get ('https://public-api.wordpress.com/rest/v1/me',
                        header,
                        'GET',
                        sprintf('authorization: Bearer %s', token));

      -- Extract the Wordpress profile link of the form http://USER.wordpress.com/
      data := json_parse (data);
      serviceId := get_keyword ('username', data);
      if (serviceId is null or serviceId = '')
      {
        -- FIXME: get actual error message
        signal ('22023', 'Wordpress authorization failed. Could not fetch profile details.');
      }

      newUsr := serviceId;
      newEmail := get_keyword ('email', data);
    }


    -- -----------------------------------------------------------------------------------
    -- Disqus
    -- -----------------------------------------------------------------------------------
    else if (service = 'disqus')
    {
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error'));
      }

      -- Convert the Disqus OAuth 2.0 code into an access token.
      declare header any;
      data := http_get ('https://disqus.com/api/oauth/2.0/access_token/',
                       header,
                      'POST',
                       null,
                       sprintf('client_id=%U&client_secret=%s&code=%s&redirect_uri=%U&grant_type=authorization_code', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url()));

      token := get_keyword('access_token', json_parse(data));
      if (token is null or token = '')
      {
        signal ('22023', sprintf('Failed to obtain Disqus OAuth token: %s', get_keyword('error', json_parse(data))));
      }

      -- Fetch the Disqus profile details using the token in an authorization header
      data := http_get (sprintf('https://disqus.com/api/3.0/users/details.json?access_token=%U&api_key=%U&api_secret=%U', token, clientKey[0], clientKey[1]), httpHeader);
      data := json_parse (data);
      data := get_keyword ('response', data);

      -- error handling
      if (httpHeader[0] not like 'HTTP/1._ 20_ %' or not isvector(data))
      {
        signal ('22023', coalesce(data, httpHeader[0]));
      }

      -- Extract the Disqus profile url
      serviceId := get_keyword ('profileUrl', data);
      newEmail := get_keyword ('email', data);
      newUsr := get_keyword ('username', data);
    }


    -- -----------------------------------------------------------------------------------
    -- Instagram
    -- -----------------------------------------------------------------------------------
    else if (service = 'instagram')
    {
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error_description'));
      }

      -- Convert the OAuth 2.0 code into an access token.
      declare header any;
      data := http_get ('https://api.instagram.com/oauth/access_token',
                        header,
                        'POST',
                        null,
                        sprintf('client_id=%U&client_secret=%s&code=%s&redirect_uri=%U&grant_type=authorization_code', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url()));

      token := get_keyword('access_token', json_parse(data));
      if (token is null or token = '')
      {
        signal ('22023', sprintf('Failed to obtain Instagram OAuth token: %s', get_keyword('error', json_parse(data))));
      }

      -- The user API does not provide the email and the username is already in the token response, no need to get more
      data := get_keyword ('user', json_parse (data));
      if (isvector (data))
      {
        serviceId := get_keyword ('username', data);
        newUsr := serviceId;
      }
      else
      {
        signal ('22023', 'Failed to extract Instagram username from OAuth reply.');
      }
    }


    -- -----------------------------------------------------------------------------------
    -- Bitly
    -- -----------------------------------------------------------------------------------
    else if (service = 'bitly')
    {
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error'));
      }

      -- Convert the OAuth 2.0 code into an access token.
      declare header any;
      data := http_get ('https://api-ssl.bitly.com/oauth/access_token',
                        header,
                        'POST',
                        null,
                        sprintf('client_id=%U&client_secret=%U&code=%U&redirect_uri=%U&grant_type=authorization_code', clientKey[0], clientKey[1], token, sprintf('%s?state=%U', ODS.DBA.ods_authenticate_callback_url(), state)));

      -- Bitly does not return Json but an URL-encoded string
      if (header[0] not like 'HTTP/1._ 20_ %')
      {
        signal ('22023', sprintf('Failed to obtain Bitly OAuth token: %s', data));
      }

      token := get_keyword('access_token', split_and_decode(data));

      -- Fetch the profile details using the token in an authorization header
      data := http_get (sprintf('https://api-ssl.bitly.com/v3/user/info?access_token=%U', token));

      tmp := json_parse (data);
      data := get_keyword ('data', tmp);

      -- error handling
      if (not isvector (data) or get_keyword ('status_code', tmp) <> 200)
      {
        signal ('22023', get_keyword ('status_txt', tmp));
      }

      -- Extract the Disqus profile url (sadly no email)
      serviceId := get_keyword ('profile_url', data);
      newUsr := get_keyword ('login', data);
    }


    -- -----------------------------------------------------------------------------------
    -- Foursquare
    -- -----------------------------------------------------------------------------------
    else if (service = 'foursquare')
    {
      -- Check for code
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error_description'));
      }

      -- Convert the code into an access token
      data := http_get (sprintf('https://foursquare.com/oauth2/access_token?client_id=%s&client_secret=%s&code=%s&redirect_uri=%U&grant_type=authorization_code', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url()));

      data := json_parse (data);
      token := get_keyword('access_token', data);
      if (token is null)
        signal ('22023', sprintf ('Foursquare OAuth error: %s', get_keyword ('error', data)));

      -- Fetch the profile details
      data := http_get (sprintf('https://api.foursquare.com/v2/users/self?oauth_token=%s', token));

      -- Extract the details we need and map to ODS account
      data := json_parse(data);
      tmp := get_keyword ('user', coalesce (get_keyword ('response', data), vector()));
      if (tmp is null)
        signal ('22023', sprintf ('Foursquare profile error: %s', get_keyword ('errorType', coalesce (get_keyword ('meta', data), vector()))));
      data := tmp;

      serviceId := get_keyword('id', data);
      if (serviceId is null or serviceId = '')
        signal ('22023', 'Failed to extract Foursquare profile ID.');

      -- We use a service profile URL because it is "webby"
      serviceId := sprintf ('https://foursquare.com/user/%s', serviceId);

      newUsr := ODS.DBA.ods_build_new_user_name (get_keyword ('firstName', data), get_keyword ('lastName', data), get_keyword ('id', data));
      newEmail := get_keyword ('email', coalesce (get_keyword ('contact', data), vector()));
    }


    -- -----------------------------------------------------------------------------------
    -- GitHub
    -- -----------------------------------------------------------------------------------
    else if (service = 'github')
    {
      -- Check for code
      token := get_keyword('code', http_param());
      if (token is null or token = '')
      {
        signal ('22023', http_param('error_description'));
      }

      -- Convert the OAuth 2.0 code into an access token.
      declare header any;
      data := http_get ('https://github.com/login/oauth/access_token',
                        header,
                        'POST',
                        null,
                        sprintf('client_id=%U&client_secret=%U&code=%U&redirect_uri=%U&state=%U', clientKey[0], clientKey[1], token, ODS.DBA.ods_authenticate_callback_url(), state));

      -- GitHub does not return Json but an URL-encoded string
      if (header[0] not like 'HTTP/1._ 20_ %')
        signal ('22023', sprintf('Failed to obtain GitHub OAuth token: %s', data));

      token := get_keyword('access_token', split_and_decode(data));

      -- Fetch the profile details using the token in an authorization header
      tmp := http_get (sprintf('https://api.github.com/user?access_token=%U', token));

      data := json_parse (tmp);

      serviceId := get_keyword ('url', data);
      newUsr := get_keyword ('login', data);
      newEmail := get_keyword ('email', data);
    }


    -- -----------------------------------------------------------------------------------
    -- Twitter
    -- -----------------------------------------------------------------------------------
    else if (service = 'twitter')
    {
      -- Extract the OAuth 1.0 sid, token, and verifier
      oauthSid := http_param('sid');
      token := cast (http_param('oauth_token') as varchar);
      oauthVerifier := http_param('oauth_verifier');

      -- If there is no token, get the error
      if (token is null or length(token) < 2)
      {
        -- FIXME: get the correct OAuth 1.0 error message key
        signal ('22023', 'Failed to obtain Twitter OAuth 1.0 request token.');
      }

      tmp := OAUTH.DBA.sign_request ('GET',
                                     'http://twitter.com/oauth/access_token',
                                     sprintf ('oauth_verifier=%U', oauthVerifier),
                                     clientKey[0],
                                     oauthSid,
                                     1);
      tmp := http_get (tmp);
      OAUTH.DBA.parse_response (oauthSid, clientKey[0], tmp);
      tmp := split_and_decode (tmp, 0);

      newUsr := get_keyword ('screen_name', tmp);
      -- FIXME: fetch twitter profile if action not auth!

      serviceId := DB.DBA.WA_USER_OL_ACCOUNTS_TWITTER (newUsr);

      OAUTH.DBA.session_terminate (oauthSid);
    }


    -- -----------------------------------------------------------------------------------
    -- LinkedIn
    -- -----------------------------------------------------------------------------------
    else if (service = 'linkedin')
    {
      -- Extract the OAuth 1.0 sid, token, and verifier
      oauthSid := http_param('sid');
      token := cast (http_param('oauth_token') as varchar);
      oauthVerifier := http_param('oauth_verifier');

      -- If there is no token, get the error
      if (token is null or length(token) < 2)
      {
        -- FIXME: get the correct OAuth 1.0 error message key
        signal ('22023', 'Failed to obtain LinkedIn OAuth 1.0 request token.');
      }

      tmp := OAUTH.DBA.sign_request ('GET',
                                     'https://api.linkedin.com/uas/oauth/accessToken',
                                     sprintf ('oauth_verifier=%U', oauthVerifier),
                                     clientKey[0],
                                     oauthSid,
                                     1);
      tmp := http_get (tmp);
      OAUTH.DBA.parse_response (oauthSid, clientKey[0], tmp);
      tmp := OAUTH.DBA.sign_request ('GET',
                                     'https://api.linkedin.com/v1/people/~:(id,email-address,first-name,last-name,public-profile-url)',
                                     '',
                                     clientKey[0],
                                     oauthSid,
                                     1);
      data := http_get (tmp);
      data := xtree_doc (data);

      -- See for more fields: https://developer.linkedin.com/documents/profile-fields

      serviceId := cast (xpath_eval ('/person/public-profile-url', data) as varchar);
      newUsr := lcase (sprintf('%s.%s', xpath_eval ('string(/person/first-name)', data), xpath_eval ('string(/person/last-name)', data)));
      newEmail := xpath_eval ('string(/person/email-address)', data);

      OAUTH.DBA.session_terminate (oauthSid);
    }


    -- -----------------------------------------------------------------------------------
    -- Yahoo
    -- -----------------------------------------------------------------------------------
    else if (service = 'yahoo')
    {
      -- Extract the OAuth 1.0 sid, token, and verifier
      oauthSid := http_param('sid');
      token := cast (http_param('oauth_token') as varchar);
      oauthVerifier := http_param('oauth_verifier');

      -- If there is no token, get the error
      if (token is null or length(token) < 2)
      {
        -- FIXME: get the correct OAuth 1.0 error message key
        signal ('22023', 'Failed to obtain Yahoo OAuth 1.0 request token.');
      }

      tmp := OAUTH.DBA.sign_request ('GET',
                                     'https://api.login.yahoo.com/oauth/v2/get_token',
                                     sprintf ('oauth_verifier=%U', oauthVerifier),
                                     clientKey[0],
                                     oauthSid,
                                     1);

      tmp := http_get (tmp);
      OAUTH.DBA.parse_response (oauthSid, clientKey[0], tmp);
      tmp := OAUTH.DBA.sign_request ('GET',
                                     'http://query.yahooapis.com/v1/yql',
                                     sprintf('q=%U', 'select * from social.profile where guid=me'),
                                     clientKey[0],
                                     oauthSid,
                                     1);
      data := http_get (tmp);
      data := xtree_doc (data);

      -- Check if we have an error
      if (xpath_eval ('[ xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" ] boolean(//yahoo:error)', data))
      {
        signal ('22023', xpath_eval ('[ xmlns:yahoo="http://www.yahooapis.com/v1/base.rng" ] string(//yahoo:error/yahoo:detail)', data));
      }

      -- See for more fields: http://developer.yahoo.com/yql/console/#h=select%20*%20from%20social.profile%20where%20guid%3Dme

      serviceId := xpath_eval ('string(//profile/profileUrl)', data);
      newUsr := xpath_eval ('string(//profile/emails[not(primary="true")]/handle)', data);
      newEmail := xpath_eval ('string(//profile/emails[primary="true"]/handle)', data);
      if (length(newEmail) = 0)
        newEmail := newUsr;
      if (length(newUsr) = 0)
        newUsr := newEmail;

      OAUTH.DBA.session_terminate (oauthSid);
    }


    -- -----------------------------------------------------------------------------------
    -- Tumblr
    -- -----------------------------------------------------------------------------------
    else if (service = 'tumblr')
    {
      -- Extract the OAuth 1.0 sid, token, and verifier
      oauthSid := http_param('sid');
      token := cast (http_param('oauth_token') as varchar);
      oauthVerifier := http_param('oauth_verifier');

      -- If there is no token, get the error
      if (token is null or length(token) < 2)
      {
        -- FIXME: get the correct OAuth 1.0 error message key
        signal ('22023', 'Failed to obtain Tumblr OAuth 1.0 request token.');
      }

      tmp := OAUTH.DBA.sign_request ('GET',
                                     'http://www.tumblr.com/oauth/access_token',
                                     sprintf ('oauth_verifier=%U', oauthVerifier),
                                     clientKey[0],
                                     oauthSid,
                                     1);
      tmp := http_get (tmp);
      OAUTH.DBA.parse_response (oauthSid, clientKey[0], tmp);

      tmp := OAUTH.DBA.sign_request ('GET',
                                     'http://api.tumblr.com/v2/user/info',
                                     '',
                                     clientKey[0],
                                     oauthSid,
                                     1);
      data := http_get (tmp);
      data := json_parse (data);
      data := get_keyword ('response', data);
      if (isvector(data))
        data := get_keyword ('user', data);
      if (isvector(data))
        serviceId := get_keyword ('name', data);
      newUsr := serviceId;

      -- It looks like sadly Tumblr does not expose the email address through the API. Thus, we cannot register with it.
      -- If this situation is "fixed" by allowing additional parameters in user.authenticate.authenticationUrl then enable registration in server.getInfo also

      OAUTH.DBA.session_terminate (oauthSid);
   }


    -- -----------------------------------------------------------------------------------
    -- DropBox
    -- -----------------------------------------------------------------------------------
    else if (service = 'dropbox')
    {
      -- Extract the OAuth 1.0 sid, token, and verifier
      oauthSid := http_param('sid');
      token := cast (http_param('oauth_token') as varchar);

      -- If there is no token, get the error
      if (token is null or length(token) < 2)
      {
        -- FIXME: get the correct OAuth 1.0 error message key
        signal ('22023', 'Failed to obtain DropBox OAuth 1.0 request token.');
      }

      tmp := OAUTH.DBA.sign_request ('POST',
                                     'https://api.dropbox.com/1/oauth/access_token',
                                     '',
                                     clientKey[0],
                                     oauthSid,
                                     1);

      declare header any;
      data := http_get ('https://api.dropbox.com/1/oauth/access_token', header, 'POST', null, tmp);
      OAUTH.DBA.parse_response (oauthSid, clientKey[0], data);

      tmp := OAUTH.DBA.sign_request ('GET',
                                     'https://api.dropbox.com/1/account/info',
                                     '',
                                     clientKey[0],
                                     oauthSid,
                                     1);
      data := http_get (tmp);
      data := json_parse (data);

      serviceId := cast (get_keyword ('uid', data) as varchar);
      newEmail := get_keyword ('email', data);
      newUsr := ODS.DBA.ods_build_new_user_name (get_keyword ('display_name', data), null, serviceId);

      OAUTH.DBA.session_terminate (oauthSid);
   }


    -- -----------------------------------------------------------------------------------
    -- UNKNWON
    -- -----------------------------------------------------------------------------------
    else
    {
      signal ('22023', sprintf('Unknown authentication service type: "%s"', service));
    }
  }


  -- =====================================================================================
  -- STEP 2: Perform the requested action: Create a new user session or register a new account or connect the service to an ODS account
  -- =====================================================================================

  -- Check if authentication or registration with the service has been disabled
  -- This is only of interest in auto mode. Otherwise user.authenticate.authenticationUrl has already quit with an error
  if (cast (get_keyword (service, get_keyword (action, json_parse (ODS.ODS_API."server.getInfo" ('regData')))) as varchar) = '0')
  {
    signal ('22023', sprintf ('%s has been disabled for service %s.', action, service));
  }


  if (serviceId is null)
    signal ('22023', sprintf('Failed to get a %s profile ID.', service));


  -- Finish the requested action (throws a signal on error)
  uname := ODS.DBA.ods_authenticate_finish(action, confirm, service, serviceId, activeOdsAcc, newUsr, newEmail, uname);


  -- If an auth confirm session has been created the result is a vector
  if(isvector(uname))
  {
    redirUrl := sprintf('%sconfirmSession.cid=%U&user.name=%U&user.email=%U&onlineAccount.service=%U&onlineAccount.uid=%U',
                        redirUrl,
                        get_keyword('cid', uname),
                        get_keyword('newUsr', uname, ''),
                        get_keyword('newEmail', uname, ''),
                        get_keyword('service', uname, ''),
                        get_keyword('serviceId', uname, ''));
  }
  else
  {
    -- We always return a valid session
    if (sid is null)
      sid := ods_new_user_session(uname);


    -- Redirect the client with the new session ID
    redirUrl := sprintf('%suserSession.sid=%s&user.uname=%U&user.uid=%d&user.new=%d&user.dba=%d', redirUrl, sid, uname, username2id (uname), case when (action = 'register') then 1 else 0 end, is_dba (uname));
  }

  http_header (sprintf('Location: %s\r\n', redirUrl));
}
;

--!
-- \brief Verify a BrowserID assertion.
--
-- This procedure will verify a BrowserID assertion.
--
-- \param assertion The assertion to verify.
-- \param[out] browserid Will be set to the BrowserID corresponding to the \p assertion on success.
--
-- \return \p 1 on successful verification, \p 0 on failure. Normally there is no need to check
--         the return value as the procedure will throw a signal on error which the calling procedure
--         should catch.
--/
create procedure ODS.DBA.ods_browserid_verify_assertion (
  in assertion varchar,
  in audience varchar,
  out browserid varchar)
{
  declare returnHeader any;
  declare result any;
  declare status varchar;

  -- Simply forward the assertion to Mozilla's service for now.
  -- We can implement the verification ourselves at any time
  result := http_get ('https://verifier.login.persona.org/verify',
                      returnHeader,
                      'POST',
                      '',
                      sprintf('assertion=%U&audience=%U', assertion, audience));

  -- The result is a JSON stream
  result := json_parse (result);
  status := get_keyword ('status', result);
  if (status <> 'okay')
    signal ('42000', sprintf('Failed to verify BrowserID assertion: %s.', get_keyword ('reason', result)));

  -- Extract the BrowserID (email)
  browserid := get_keyword ('email', result);
  if (browserid = null)
    signal ('22023', 'Could not extract BrowserID from assertion validation reply.');

  return 1;
}
;

--!
-- \brief Authenticate with, register with, or connect a BrowserID.
--
-- This method represents the ODS support for BrowserID. It can be used to connect an ODS account to
-- a BrowserID, to register a new ODS account using a BrowserID, or to authenticate a user via their BrowserID.
--
-- \section ods_user_authenticate_browserid_client BrowserID Javascript Client Library
--
-- BrowserID requires the client to make use of the BrowserID/Persona Javascript library from Mozilla
-- (see https://developer.mozilla.org/en-US/docs/Persona). There are a few minor things to take into account
-- when using BrowserID with ODS in a client. It is recommended to use the ODS session management instead of
-- BrowserID persistent login. To accomplish that a client simply needs to tell the BrowserID Javascript library
-- to logout directly after having logged in. The following example code demonstrates this (based on the code in
-- the <a href="https://developer.mozilla.org/en/Persona/Quick_Setup">BrowserID/Personal Quick setup guide</a>):
--
-- Connect the BrowserID/Persona login button to the <code>navigator.id.request</code> call as usual. Then
-- handle <code>navigator.id</code> events along the lines of the following:
--
-- \code
-- navigator.id.watch({
--   loggedInUser: null,
--
--   onlogin: function(assertion) {
--     navigator.id.logout();
--
--     $.ajax({
--        type: 'GET',
--        url: '/ods/api/user.authenticate.browserid',
--        data: { assertion: assertion },
--        success: function(sid, status, xhr) { /* do something with the new Session ID in "sid" */ }.
--        error: function(sid, status, xhr) { alert("login failure" + res); }
--     });
--   },
--
--   onlogout: function() { /* do nothing */ }
-- });
-- \endcode
--
-- There are three distinct differences to the example code in the <a href="https://developer.mozilla.org/en/Persona/Quick_Setup">BrowserID/Personal Quick setup guide</a>:
-- - The \p loggedInUser is always \p null. This is because from a BrowserID point of view the user is never logged in.
--   Only the ODS session ID is used.
-- - Directly before the call to user.authenticate.browserid() <code>navigator.id.logout</code> will disable the persistent login so all
--   session management can be done via ODS session IDs.
-- - The \p onlogout function does nothing since logout is handled via user.logout() instead.
--
-- The simplest way to accomplish this is to use the <a href="http://web.ods.openlinksw.com/jods.vsp">ODS Javascript Library</a> as provided by OpenLink Software.
--
-- \section ods_user_authenticate_browserid_storage BrowserID Storage
--
-- BrowserIDs will be stored like other 3rd party online accounts as handled by user.authenticate.authenticationUrl(). As such
-- one can also add BrowserIDs via user.onlineAccounts.new() instead of using \p action \p connect. In that case the name of
-- the online account is \p "browserid" and the \p uri is the actual BrowserID, ie. the email address. It is, however, recommended
-- to use the \p connect action instead since that requires the user to proove that they actually own the BrowserID.
--
--
-- \param assertion The assertion to verify as produced by the BrowserID client library in the browser.
-- \param audience The client address as required by Persona, consisting of protocol, domain, and port. The domain has to be registered via admin.clients.new(). It needs
-- to match the address of the client initiating the Javascript BrowserID session.
-- \param action The action to perform. See \ref ods_authentication_url_action for details on the supported actions.
-- \param confirm The confirmation mode. See \ref ods_authentication_url_confirm for details on the supported modes.
--
-- \return A valid ODS session or the confirmation session encoded as an XML stream. In case the client authenticated with a session ID for the \p connect action this session ID
-- will be returned.
--
-- \sa user.authenticate(), user.authenticate.webid(), user.authenticate.authenticationUrl()
--
-- \section ods_user_session_example Example User Session:
--
-- The user session object contains:
-- - The session ID \p sid
-- - The user with username \p uname, the internal numerical \p uid, and two flags:
--   - \p dba indicates if the user is the dba user, ie. has administrator priviledges.
--   - \p new indicates if this user has been newly registered. This is useful for client to show some welcome message or the like.
--
-- \verbatim
-- <userSession>
--   <sid>1de236f5da2f32d92e8c0cce5053a96e</sid>
--   <user>
--     <uname>demo</uname>
--     <uid>127</uid>
--     <new>0</new>
--     <dba>0</dba>
--   </user>
-- </userSession>
-- \endverbatim
--
-- \section ods_auth_confirmation_session_example Example Confirmation Session:
--
-- \verbatim
-- <confirmSession>
--   <cid></cid>
--   <user>
--     <name></name>
--     <email></email>
--   </user>
--   <onlineAccount>
--     <service>browserid</service>
--     <uid></uid>
--   </onlineAccount>
-- </confirmSession>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.authenticate.browserid" (
  in assertion varchar,
  in audience varchar,
  in action varchar := 'authenticate',
  in confirm varchar := 'auto') __SOAP_HTTP 'text/xml'
{
  declare browserid, uname, sid varchar;
  sid := null;


  -- This procedure is supposed to be called in an http context
  -- Thus, the error handler does produce http status codes
  declare exit handler for sqlstate '*'
  {
    rollback work;
    if (__SQL_STATE = '42000') -- permission denied
      http_status_set(403);
    else
      http_status_set(400); -- misc error
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };


  -- Check the input parameters
  action := lcase(action);
  confirm := lcase(confirm);
  if (action <> 'authenticate' and action <> 'register' and action <> 'auto' and action <> 'connect')
  {
    signal ('22023', sprintf('Unknown authentication action: %s', action));
  }
  if (confirm <> 'never' and confirm <> 'always' and confirm <> 'auto')
  {
    signal ('22023', sprintf('Unknown confirmation mode: %s', confirm));
  }


  -- Check the audience. Only registered clients are allowed to use the BrowserID feature
  if (ODS.DBA.ods_check_client_url (audience) = 0)
    signal ('42000', sprintf('Unknown client "%s". Please register via admin.clients.new.', audience));


  -- For the connect action we need to be authenticated. So we check for authentication information if we might connect
  if (action = 'connect' or action = 'auto')
  {
    if (not ods_check_auth (uname))
    {
      if (action = 'connect')
        signal ('42000', sprintf ('Need to be authenticated to perform service account connection.'));
    }
    else
    {
      -- automatic mode will always add the account to the authenticated user
      if (action = 'auto')
        action := 'connect';

      -- If the client already created a session we will resue it, otherwise we create a new one
      sid := http_param ('sid');
      if (not exists (select 1 from DB.DBA.VSPX_SESSION where VS_SID = sid and VS_REALM = http_param ('realm') and VS_UID = uname))
        sid := null;
    }
  }


  -- Check if authentication or registration with the service has been disabled
  if (cast (get_keyword ('browserid', get_keyword (action, json_parse (ODS.ODS_API."server.getInfo" ('regData')))) as varchar) = '0')
  {
    signal ('42000', sprintf ('%s has been disabled for BrowserID login.', action));
  }


  -- This will throw a signal on error
  ODS.DBA.ods_browserid_verify_assertion (assertion, audience, browserid);


  -- Finish the requested action (throws a signal on error)
  uname := ODS.DBA.ods_authenticate_finish(action, confirm, 'browserid', browserid, uname, browserid, browserid);


  -- If an auth confirm session has been created the result is a vector
  if(isvector(uname))
  {
    return
      '<confirmSession>' ||
        '<cid>' || get_keyword('cid', uname) || '</cid>' ||
        '<user>' ||
          '<name>' || get_keyword('newUsr', uname) || '</name>' ||
          '<email>' || get_keyword('newEmail', uname) || '</email>' ||
          '<onlineAccount>' ||
            '<service>' || get_keyword('service', uname) || '</service>' ||
            '<uid>' || get_keyword('serviceId', uname) || '</uid>' ||
          '</onlineAccount>' ||
        '</user>' ||
      '</confirmSession>';
  }
  else
  {
    -- We always return a valid session
    if (sid is null)
      sid := ods_new_user_session(uname);

    return ODS.DBA.ods_serialize_user_session (sid, uname, case when (action = 'register') then 1 else 0 end);
  }
}
;

--!
-- \brief Authenticate with, register with, or connect a WebID
--
-- This method represents the ODS support for WebID authentiction. It can be used to connect an ODS account to
-- a WebID, to register a new ODS account using a WebID, or to authenticate a user via their WebID.
-- In addition ODS supports X.509 certificates without an embedded WebID.
--
-- Clients need to call this method through an SSL connection providing the X.509 client certifcate which
-- should be used for authentication, registration, or to connect to an account. In the case of account
-- connection the user need to authenticate themselves in addition to providing the certificate. Any of the
-- supported ways can be used except for the certificate itself. Typically clients will use a session ID.
-- See \ref ods_authentication for details.
--
-- \section ods_user_authenticate_web_storage WebID Storage
--
-- WedIDs will be stored like other 3rd party online accounts as handled by user.authenticate.authenticationUrl(). As such
-- one can also add WebIDs via user.onlineAccounts.new() instead of using \p action \p connect. In that case the name of
-- the online account is \p "webid" and the \p uri is the actual WebID. It is, however, recommended
-- to use the \p connect action instead since that requires the user to proove that they actually own the WebID.
--
-- \param action The action to perform. See \ref ods_authentication_url_action for details on the supported actions.
-- \param confirm The confirmation mode. See \ref ods_authentication_url_confirm for details on the supported modes.
--
-- \return A valid ODS session ID. In case the client authenticated with a session ID for the \p connect action this session ID
-- will be returned. See user.authenticate.browserid() for an example.
--
-- \sa user.authenticate(), user.authenticate.webid(), user.authenticate.authenticationUrl()
--/
create procedure ODS.ODS_API."user.authenticate.webid" (
  in action varchar := 'authenticate',
  in confirm varchar := 'auto') __SOAP_HTTP 'text/xml'
{
  declare webid, odsuser, newUsr, newEmail, uname, sid varchar;
  declare webidCacheGraph varchar;
  sid := null;

  -- This procedure is supposed to be called in an http context
  -- Thus, the error handler does produce http status codes
  declare exit handler for sqlstate '*'
  {
    rollback work;
    if (__SQL_STATE = '42000') -- permission denied
      http_status_set(403);
    else
      http_status_set(400); -- misc error
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };


  -- Check the input parameters
  action := lcase(action);
  confirm := lcase(confirm);
  if (action <> 'authenticate' and action <> 'register' and action <> 'auto' and action <> 'connect')
  {
    signal ('22023', sprintf('Unknown authentication action: %s', action));
  }
  if (confirm <> 'never' and confirm <> 'always' and confirm <> 'auto')
  {
    signal ('22023', sprintf('Unknown confirmation mode: %s', confirm));
  }


  -- For the connect action we need to be authenticated. So we check for authentication information if we might connect
  if (action = 'connect' or action = 'auto')
  {
    -- We need to check authentication without SSL since that is what we are trying to connect
    declare inst_id integer;
    inst_id := null;
    if (not ods_check_auth2 (uname, inst_id, 'owner', 0))
    {
      if (action = 'connect')
        signal ('42000', sprintf ('Need to be authenticated to perform serivce account connection.'));
    }
    else
    {
      -- automatic mode will always add the account to the authenticated user
      if (action = 'auto')
        action := 'connect';

      -- If the client already created a session we will resue it, otherwise we create a new one
      sid := http_param ('sid');
      if (not exists (select 1 from DB.DBA.VSPX_SESSION where VS_SID = sid and VS_REALM = http_param ('realm') and VS_UID = uname))
        sid := null;
    }
  }


  -- Check if authentication or registration with the service has been disabled
  if (cast (get_keyword ('webid', get_keyword (action, json_parse (ODS.ODS_API."server.getInfo" ('regData')))) as varchar) = '0')
  {
    signal ('42000', sprintf ('%s has been disabled for WebID login.', action));
  }


  -- Verify the WebID in the given certificate and cache the profile data in a tmp graph
  webidCacheGraph := sprintf('http://%s/%s', http_host(), uuid());
  SIOC.DBA.acl_webid (webid, webidCacheGraph);


  -- We need a WebID to continue
  if (webid is null)
    signal ('22023', 'The provided client certificate did not have an embedded verifiable WebID.');


  -- Get nickname and email address from the profile
  if (action = 'register' or action = 'auto')
  {
    for (sparql select bif:coalesce (?nick_name, ?full_name) as ?nick, ?email
                where {
                  graph `iri(?:webidCacheGraph)` {
                    `iri(?:webid)` a ?type .
                    OPTIONAL { `iri(?:webid)` foaf:nick ?nick_name . } .
                    OPTIONAL { `iri(?:webid)` foaf:name ?full_name . } .
                    OPTIONAL { `iri(?:webid)` foaf:mbox ?email . } .
                  }
                } LIMIT 1) do
    {
       newUsr := "nick";
       newEmail := "email";
       -- FIXME: find out why sometimes we get integers
       if (isinteger(newUsr))
        newUsr := null;
       if (isinteger(newEmail))
        newEmail := null;
    }
  }


  -- Finish the requested action (throws a signal on error)
  odsuser := coalesce (ODS.DBA.webid_to_ods_user(webid), ODS.DBA.x509_cert_fingerprint_to_ods_user(get_certificate_info (6)));
  uname := ODS.DBA.ods_authenticate_finish(action, confirm, 'webid', webid, uname, newUsr, newEmail, odsuser);


  -- If an auth confirm session has been created the result is a vector
  if(isvector(uname))
  {
    return
      '<confirmSession>' ||
        '<cid>' || get_keyword('cid', uname) || '</cid>' ||
        '<user>' ||
          '<name>' || get_keyword('newUsr', uname) || '</name>' ||
          '<email>' || get_keyword('newEmail', uname) || '</email>' ||
          '<onlineAccount>' ||
            '<service>' || get_keyword('service', uname) || '</service>' ||
            '<uid>' || get_keyword('serviceId', uname) || '</uid>' ||
          '</onlineAccount>' ||
        '</user>' ||
      '</confirmSession>';
  }
  else
  {
    -- We always return a valid session
    if (sid is null)
      sid := ods_new_user_session(uname);

    -- Clear the tmp profile graph
    sparql clear graph iri(?:webidCacheGraph);

    return ODS.DBA.ods_serialize_user_session (sid, uname, case when (action = 'register') then 1 else 0 end);
  }
}
;

--!
-- \brief Confirm an authentication confirmation request.
--
-- Whenever ODS creates an authentication confirmation request as a result to a call to user.authenticate.authenticationUrl(),
-- user.authenticate.browserid(), or user.authenticate.webid() this method can be used to complete the authentication and
-- create the final account with the verified profile details.
--
-- \param cid The confirmation session ID.
-- \param userName The username as verified and optionally changed by the user.
-- \param email The email as verified and optionally changed by the user.
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--/
create procedure ODS.ODS_API."user.authenticate.confirm" (
  in cid varchar,
  in username varchar,
  in email varchar) __SOAP_HTTP 'text/xml'
{
  declare service, serviceId varchar;
  declare uid any;


  -- This procedure is supposed to be called in an http context
  -- Thus, the error handler does produce http status codes
  declare exit handler for sqlstate '*'
  {
    rollback work;
    if (__SQL_STATE = '42000') -- permission denied
      http_status_set(403);
    else
      http_status_set(400); -- misc error
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };


  -- Check that we have a valid confirm session ID
  if (not (select (1) from DB.DBA.WA_AUTH_CONFIRM_SESS where AUTH_SESS_CID = cid and AUTH_SESS_CLIENT_IP = http_client_ip()))
    signal ('42000', 'Invalid confirm session ID or mismatching client IP.');


  -- Get the values from the session
  select AUTH_SESS_SERVICE, AUTH_SESS_SERVICE_ID into service, serviceId from DB.DBA.WA_AUTH_CONFIRM_SESS where AUTH_SESS_CID = cid;


  -- Delete the session which is not required anymore
  delete from DB.DBA.WA_AUTH_CONFIRM_SESS where AUTH_SESS_CID = cid;


  -- complete the registration
  uid := DB.DBA.ODS_CREATE_USER (username, uuid(), email);
  if (not isinteger (uid))
    signal ('22023', uid);


  -- FIXME: OpenIDs should also be stored in WA_USER_OL_ACCOUNTS
  if (service = 'openid')
  {
    update DB.DBA.WA_USER_INFO
       set WAUI_OPENID_URL = serviceId,
           WAUI_OPENID_SERVER = http_param('openid.server')
     where WAUI_U_ID = uid;
  }
  else
  {
     -- Connect the service ID to the account from register or connect action
    insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE,  WUO_NAME, WUO_URL)
      values (uid, 'P', service, serviceId);
  }

  return ODS.DBA.ods_serialize_user_session (ods_new_user_session(username), username, 1);
}
;

--!
-- \brief Request a Twitter authentication URL.
--
-- Twitter is supported via OAuth. This requires the user to authenticate ODS for login via their Twitter account.
-- The user needs to login with Twitter, following a redirect to ODS. This function will setup the OAuth session
-- with Twitter and return the authentication URL.
--
-- \param hostUrl The callback URL. Once authenticated Twitter will redirect here adding the following parameters
--                to the URL which can be used in user.authenticate() or user.oauth.twitter.registrationData() to complete the OAuth process:
--                - \p sid - The OAuth session ID
--                - \p oauth_verifier - The OAuth verifer
--                - \p oauth_token - The OAuth request token
--
-- \return The Twitter authentication URL which the client needs to direct the user to. At that URL the user needs
--         to authenticate with Twitter which will retult in the callback to \p hostUrl as explained above.
--
-- \sa user.oauth.twitter.registrationData(), user.oauth.linkedin.authenticationUrl(), user.authenticate(), user.register()
--/
create procedure ODS.ODS_API."user.oauth.twitter.authenticationUrl" (
  in hostUrl varchar) __SOAP_HTTP 'text/plain'
{
  declare token, result, url, sid, oauth_token, return_url any;

  token := ODS.ODS_API.get_oauth_tok ('Twitter API');
  sid := md5 (datestring (now ()));
  return_url := sprintf ('%s&sid=%U', hostUrl, sid);
  url := OAUTH..sign_request ('GET', 'http://twitter.com/oauth/request_token', sprintf ('oauth_callback=%U', return_url), token, null, 1);
  result := http_get (url);
  sid := OAUTH..parse_response (sid, token, result);

  OAUTH..set_session_data (sid, vector());
  oauth_token := OAUTH..get_auth_token (sid);

  return sprintf ('http://twitter.com/oauth/authenticate?oauth_token=%U', oauth_token);
}
;

--!
-- \deprecated Use user.oauth.twitter.authenticationUrl() instead.
--/
create procedure ODS.ODS_API.twitterServer (
  in hostUrl varchar) __SOAP_HTTP 'text/plain'
{
  return ODS.ODS_API."user.oauth.twitter.authenticationUrl"(hostUrl);
}
;

--!
-- \brief Get Twitter account details.
--
-- ODS supports registration and authentication via Twitter's OAuth API. This requires two steps:
-- -# Let the user log into Twitter and authenticate ODS
-- -# Map the Twitter account to an ODS account
--
-- user.oauth.twitter.authenticationUrl() can be used to perform the first step. In the case of authentication user.authenticate() performs the second step.
-- In the case of registration the second step is performed by this function. It will fetch the user details from the authenticated
-- Twitter user. The result can then be passed into the \p data parameter of the user.register() function.
--
-- \param sid The OAuth session ID as provided by the Twitter callback initiated by the URL returned from user.oauth.twitter.authenticationUrl()
-- \param oauth_verifier The OAuth verifer as provided by the Twitter callback initiated by the URL returned from user.oauth.twitter.authenticationUrl()
-- \param oauth_token The OAuth request token as provided by the Twitter callback initiated by the URL returned from user.oauth.twitter.authenticationUrl()
--
-- \return An XML stream containing the usr profile details from the Twitter account which provided the paramters. This can be used
-- as input for user.register().
--
-- \sa user.oauth.twitter.authenticationUrl(), user.oauth.linkedin.registrationData(), user.register()
--/
create procedure ODS.ODS_API."user.oauth.twitter.registrationData" (
  in sid varchar,
  in oauth_verifier varchar,
  in oauth_token varchar) __SOAP_HTTP 'text/xml'
{
  declare tmp, screen_name, header, auth any;
  declare token, result, url, return_url any;

  token := ODS.ODS_API.get_oauth_tok ('Twitter API');
  url := OAUTH..sign_request (
    'GET',
    'http://twitter.com/oauth/access_token',
    sprintf ('oauth_token=%U&oauth_verifier=%U', oauth_token, oauth_verifier),
    token,
    sid,
    1);
  result := http_get (url);
  sid := OAUTH..parse_response (sid, token, result);
  tmp := split_and_decode (result, 0);
  screen_name := get_keyword ('screen_name', tmp);

  auth := OAUTH..signed_request_header ('GET', 'http://api.twitter.com/1/users/lookup.xml', sprintf ('screen_name=%U', screen_name), token, '', sid, 0);
  url := sprintf ('http://api.twitter.com/1/users/lookup.xml?screen_name=%U', screen_name);
  result := http_get (url, header, 'GET', auth);
  OAUTH..session_terminate (sid);

  return result;
}
;

--!
-- \deprecated Use user.oauth.twitter.registrationData() instead.
--/
create procedure ODS.ODS_API.twitterVerify (
  in sid varchar,
  in oauth_verifier varchar,
  in oauth_token varchar) __SOAP_HTTP 'text/xml'
{
  return ODS.ODS_API."user.oauth.twitter.registrationData"(sid, oauth_verifier, oauth_token);
}
;

--!
-- \brief Request a LinkedIn authentication URL.
--
-- LinkedIn is supported via OAuth. This requires the user to authenticate ODS for login via their LinkedIn account.
-- The user needs to login with LinkedIn, following a redirect to ODS. This function will setup the OAuth session
-- with LinkedIn and return the authentication URL.
--
-- \param hostUrl The callback URL. Once authenticated LinkedIn will redirect here adding the following parameters
--                to the URL which can be used in user.authenticate() or user.oauth.twitter.registrationData() to complete the OAuth process:
--                - \p sid - The OAuth session ID
--                - \p oauth_verifier - The OAuth verifer
--                - \p oauth_token - The OAuth request token
--
-- \return The LinkedIn authentication URL which the client needs to direct the user to. At that URL the user needs
--         to authenticate with LinkedIn which will retult in the callback to \p hostUrl as explained above.
--
-- \sa user.oauth.linkedin.registrationData(), user.oauth.twitter.authenticationUrl(), user.authenticate(), user.register()
--/
create procedure ODS.ODS_API."user.oauth.linkedin.authenticationUrl" (
  in hostUrl varchar) __SOAP_HTTP 'text/plain'
{
  declare token, result, url, sid, oauth_token, return_url any;

  token := ODS.ODS_API.get_oauth_tok ('LinkedIn API');
  sid := md5 (datestring (now ()));
  return_url := sprintf ('%s&sid=%U', hostUrl, sid);
  url := OAUTH..sign_request ('GET', 'https://api.linkedin.com/uas/oauth/requestToken?scope=r_basicprofile+r_emailaddress', sprintf ('oauth_callback=%U', return_url), token, null, 1);
  result := http_get (url);
  sid := OAUTH..parse_response (sid, token, result);

  OAUTH..set_session_data (sid, vector());
  oauth_token := OAUTH..get_auth_token (sid);

  return sprintf ('https://www.linkedin.com/uas/oauth/authenticate?oauth_token=%U', oauth_token);
}
;

--!
-- \deprecated Use user.oauth.linkedin.authenticationUrl() instead.
--/
create procedure ODS.ODS_API.linkedinServer (
  in hostUrl varchar) __SOAP_HTTP 'text/plain'
{
  return ODS.ODS_API."user.oauth.linkedin.authenticationUrl"(hostUrl);
}
;

--!
-- \brief Get LinkedIn account details.
--
-- ODS supports registration and authentication via LinkedIn's OAuth API. This requires two steps:
-- -# Let the user log into LinkedIn and authenticate ODS
-- -# Map the LinkedIn account to an ODS account
--
-- user.oauth.linkedin.authenticationUrl() can be used to perform the first step. In the case of authentication user.authenticate() performs the second step.
-- In the case of registration the second step is performed by this function. It will fetch the user details from the authenticated
-- LinkedIn user. The result can then be passed into the \p data parameter of the user.register() function.
--
-- \param sid The OAuth session ID as provided by the LinkedIn callback initiated by the URL returned from user.oauth.linkedin.authenticationUrl()
-- \param oauth_verifier The OAuth verifer as provided by the LinkedIn callback initiated by the URL returned from user.oauth.linkedin.authenticationUrl()
-- \param oauth_token The OAuth request token as provided by the LinkedIn callback initiated by the URL returned from user.oauth.linkedin.authenticationUrl()
--
-- \return An XML stream containing the usr profile details from the LinkedIn account which provided the paramters. This can be used
-- as input for user.register().
--
-- \sa user.oauth.linkedin.authenticationUrl(), user.oauth.twitter.registrationData(), user.register()
--/
create procedure ODS.ODS_API."user.oauth.linkedin.registrationData" (
  in sid varchar,
  in oauth_verifier varchar,
  in oauth_token varchar) __SOAP_HTTP 'text/xml'
{
  declare tmp, header, auth any;
  declare token, result, url, return_url any;

  token := ODS.ODS_API.get_oauth_tok ('LinkedIn API');
  url := OAUTH..sign_request (
    'GET',
    'https://api.linkedin.com/uas/oauth/accessToken',
    sprintf ('oauth_token=%U&oauth_verifier=%U', oauth_token, oauth_verifier),
    token,
    sid,
    1);
  result := http_get (url);
  sid := OAUTH..parse_response (sid, token, result);

  url := OAUTH..sign_request ('GET', 'https://api.linkedin.com/v1/people/~:(id,first-name,last-name,industry,public-profile-url,date-of-birth)', '', token, sid, 1);
  result := http_get (url);
  OAUTH..session_terminate (sid);

  return result;
}
;

--!
-- \deprecated Use user.oauth.linkedin.registrationData() instead.
--/
create procedure ODS.ODS_API.linkedinVerify (
  in sid varchar,
  in oauth_verifier varchar,
  in oauth_token varchar) __SOAP_HTTP 'text/xml'
{
  return ODS.ODS_API."user.oauth.linkedin.registrationData"(sid, oauth_verifier, oauth_token);
}
;

--!
-- \brief Request an OpenID authentication URL.
--
-- Registration or authentication via OpenID is a two-step process. First the client needs to retrieve the OpenID server details. This is done
-- through this function which will return a URL directing the user to the login page of the OpenID provider. After the login the provider
-- will use the provided callback URL to redirect the user to the ODS client. The second step is to either call user.register() or
-- user.authenticate() to either create a new account or log into an existing one which is connected to the provided OpenID.
--
-- \param openid The OpenID to register or authenticate with.
-- \param hostUrl The callback URL. Once authenticated the OpenID provider will redirect the client to this URL including a set of parameters.
--                Clients may use user.openid.registrationData() to prepare the redirection URL for user.register()'s \p data parameter.
--                These parameters include at least the following but may, depending on the OpenID provider, contain additional user profile data:
--                - \p openid.server - The OpenID server handling the authentication for the provider.
--                - \p openid.identity - The OpenID identity. This is typically the same as \p openid although it might differ in certain cases.
-- \param trustroot An optional base URL for the ODS instance, see the OpenID spec for details. If omitted ODS will use the domain of \p hostUrl.
--
-- \return The authentication URL which the client needs to direct the user to. At that URL the user needs
--         to authenticate with the OpenId provider which will retult in the callback to \p hostUrl as explained above.
--
-- \sa user.openid.registrationData()
--/
create procedure ODS.ODS_API."user.openid.authenticationUrl" (
  in openid varchar,
  in hostUrl varchar,
  in trustroot varchar := null) __SOAP_HTTP 'text/plain'
{
  declare oi_version, oi_srv, oi_identity, oi_delegate, oi_params varchar;
  declare authUrl varchar;
  declare h any;

  -- Get the details of the server
  getOpenIdServer(openid, oi_srv, oi_version, oi_identity, oi_delegate, oi_params);

  -- optimize some parameters
  if (oi_params is null or oi_params = '')
    oi_params := 'sreg';

  if (oi_delegate is not null and oi_delegate <> '')
      oi_identity := oi_delegate;

  -- fall back to the domain of the callback URL
  if (trustroot is null)
  {
    h := rfc1808_parse_uri(hostUrl);
    h[2] := '';
    h[3] := '';
    h[4] := '';
    h[5] := '';
    trustroot := DB.DBA.vspx_uri_compose(h);
  }

  -- We always need the oid_server for user.register
  if (strcontains(hostUrl, '?'))
    hostUrl := hostUrl || '&';
  else
    hostUrl := hostUrl || '?';
  hostUrl := hostUrl || sprintf('openid.server=%U', oi_srv);

  -- Build the authentication URL the client needs to show to the user
  authUrl := oi_srv;
  if (strcontains(oi_srv, '?'))
    authUrl := authUrl || '&';
  else
    authUrl := authUrl || '?';

  authUrl := authUrl || sprintf('openid.mode=checkid_setup&openid.return_to=%U', hostUrl);

  if (oi_version = '1.0')
      authUrl := authUrl
                 || sprintf('&openid.identity=%U', oi_identity)
                 || sprintf('&openid.trust_root=%U', trustroot);

  else if (oi_version = '2.0')
    authUrl := authUrl
               || sprintf('&openid.ns=%U', 'http://specs.openid.net/auth/2.0')
               || sprintf('&openid.claimed_id=%U', oi_identity)
               || sprintf('&openid.identity=%U', oi_identity);

  if (oi_params = 'sreg')
    authUrl := authUrl
               || sprintf('&openid.sreg.optional=%U', 'fullname,nickname,dob,gender,postcode,country,timezone')
               || sprintf('&openid.sreg.required=%U', 'email,nickname');

  else if (oi_params = 'ax')
    authUrl := authUrl
               || sprintf('&openid.ns.ax=%U', 'http://openid.net/srv/ax/1.0')
               || sprintf('&openid.ax.mode=%U', 'fetch_request')
               || sprintf('&openid.ax.required=%U', 'country,email,firstname,fname,language,lastname,timezone')
               || sprintf('&openid.ax.type.country=%U', 'http://axschema.org/contact/country/home')
               || sprintf('&openid.ax.type.email=%U', 'http://axschema.org/contact/email')
               || sprintf('&openid.ax.type.firstname=%U', 'http://axschema.org/namePerson/first')
               || sprintf('&openid.ax.type.fname=%U', 'http://axschema.org/namePerson')
               || sprintf('&openid.ax.type.language=%U', 'http://axschema.org/pref/language')
               || sprintf('&openid.ax.type.lastname=%U', 'http://axschema.org/namePerson/last')
               || sprintf('&openid.ax.type.timezone=%U', 'http://axschema.org/pref/timezone');

  return authUrl;
}
;

--!
-- \brief Get OpenID accound details for user registration.
--
-- ODS supports registration via OpenID. To this end the data returned by the OpenID provider as
-- query parameters to the callback URL from user.openid.authenticationUrl() needs to be prepared for feeding into the \p data parameter
-- of user.register(). Be aware though that user.register() still requires a \p name and an \p email value to be present. These values might
-- be contained in the returned JSON blob (\p nick and \p mbox) if the OpenID provider returns them. Otherwise the user needs to provide those
-- values manually.
--
-- \param url The redirect URL with the OpenID parameters from the OpenID provider. This URL is obtained by the client
--            by navigating to the URL provided through user.openid.authenticationUrl() and awaiting the redirect.
--
-- \return A JSON stream of OpenID account data suitable for user.register()
--
-- \sa user.openid.authenticationUrl()
--/
create procedure ODS.ODS_API."user.openid.registrationData" (
  in url varchar) __SOAP_HTTP 'text/json'
{
  declare data any;
  declare uriParams any;

  uriParams := split_and_decode(rfc1808_parse_uri(url)[4], 0);

  data := ODS..jsonObject ();

  -- Convert all the profile detail properties to key names user.register can handle
  for (declare i, l int, i := 0, l := length (uriParams); i < l; i := i + 2)
  {
    if (ends_with(uriParams[i], 'country'))
      ODS.ODS_API.set_keyword ('homeCountry', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'email'))
      ODS.ODS_API.set_keyword ('mbox', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'firstname'))
      ODS.ODS_API.set_keyword ('firstName', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'fname') or ends_with(uriParams[i], 'fullname'))
      ODS.ODS_API.set_keyword ('name', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'language'))
      ODS.ODS_API.set_keyword ('language', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'lastname'))
      ODS.ODS_API.set_keyword ('family_name', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'timezone'))
      ODS.ODS_API.set_keyword ('timezone', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'dob'))
      ODS.ODS_API.set_keyword ('birthday', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'postcode'))
      ODS.ODS_API.set_keyword ('homeCode', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'gender'))
      ODS.ODS_API.set_keyword ('gender', data, uriParams[i+1]);

    else if (ends_with(uriParams[i], 'nickname'))
      ODS.ODS_API.set_keyword ('nick', data, uriParams[i+1]);
  }

  -- If we have no nick we use name
  if (not get_keyword('nick', data) and get_keyword('name', data))
    ODS.ODS_API.set_keyword ('nick', data, get_keyword('name', data));

  -- Add the values required by user.register
  ODS.ODS_API.set_keyword ('openid_url', data, get_keyword('openid.identity', uriParams));
  ODS.ODS_API.set_keyword ('openid_server', data, get_keyword('openid.server', uriParams));

  return ODS..obj2json(data);
}
;

--!
-- \brief Request an OpenID Login URL
--
-- Authentication via OpenID is a three-step process in ODS including user.openid.authenticationUrl(), this function, and
-- a call to user.authenticate() using the result as input.
--
-- \param url The redirection URL constructed by the OpenID provider.
--
-- \return An OpenID login url which can be used to authenticate the ODS user via user.authenticate()
--         and its \p openIdUrl parameter.
--/
create procedure ODS.ODS_API."user.openid.loginUrl" (
  in url varchar) __SOAP_HTTP 'text/plain'
{
  declare uriParams any;
  declare loginUrl varchar;
  declare sig any;
  declare _key, _val varchar;

  -- Get a hash of all query parameters in the given URL
  uriParams := split_and_decode(rfc1808_parse_uri(url)[4], 0);

  -- Add basic OpenID parameters to the login URL
  loginUrl := get_keyword('openid.server', uriParams);
  if (strcontains(loginUrl, '?'))
    loginUrl := loginUrl || '&';
  else
    loginUrl := loginUrl || '?';
  loginUrl := loginUrl || 'openid.mode=check_authentication'
    || sprintf('&openid.assoc_handle=%U', get_keyword('openid.assoc_handle', uriParams))
    || sprintf('&openid.sig=%U', get_keyword('openid.sig', uriParams))
    || sprintf('&openid.signed=%U', get_keyword('openid.signed', uriParams));

  --
  sig := split_and_decode(get_keyword('openid.signed', uriParams), 0, '\0\0,');
  for (declare i int, i := 0; i < length(sig); i := i + 1)
  {
    _key := trim(sig[i]);
    if (_key <> 'mode' and
        _key <> 'signed' and
        _key <> 'assoc_handle')
    {
      _val := get_keyword('openid.' || _key, uriParams);
      if (not _val is null and _val <> '')
        loginUrl := loginUrl || sprintf('&openid.%s=%U', _key, _val);
    }
  }

  return loginUrl;
}
;

--!
-- \brief Internal procedure which creates a new user session and returns the session ID.
--
-- No authentication checks are made. However, if the user is deactivated an error signal
-- will be thrown.
--
-- \param uname The name of the user to create the session for.
-- \param checkDeactivated If \p 1 (the default) deactivated user sessions will be refused.
--
-- \return The session ID (varchar) on success, \p null otherwise.
--/
create procedure ODS..ods_new_user_session (
  in uname varchar,
  in checkDeactivated int := 1)
{
  declare sid varchar;

  if (isnull (uname))
    return null;

  if (checkDeactivated and (select U_ACCOUNT_DISABLED from DB.DBA.SYS_USERS where U_NAME = uname) = 1)
    signal ('22000', sprintf('The ODS account "%s" is deactivated.', uname));

  sid := DB.DBA.vspx_sid_generate ();

  insert into DB.DBA.VSPX_SESSION (VS_SID, VS_REALM, VS_UID, VS_STATE, VS_EXPIRY)
    values (sid, 'wa', uname, serialize (vector ('vspx_user', uname)), now ());

  return sid;
}
;

--!
-- \brief Start a new user session via user digest information.
--
-- ODS supports a variety of authentication methods. The most common way of operation for a client is to obtain a session ID and use it in subsequent calls to the API as
-- described in \ref ods_authentication_session_id. Session IDs are obtained in one of the following ways. This method allows to authenticate via classical user digest information
-- (user name and password). Authentication through third-party services is handled by user.authenticate.authenticationUrl(). user.authenticate.webid() and user.authenticate.browserid()
-- handle WebiD (X.509 client SSL certificate authentication) and BrowserID (Mozilla Persona) respectively.
-- In contrast to the other methods user.authenticate.authenticationUrl() will return a URL the client needs to navigate the user to in order to complete the authentication.
-- The other methods will return a session ID.
--
-- A session will timeout after being unused for half an hour.
--
-- \section ods_user_authenticate_password Authentication via Password Hash
--
-- When authenticating via password hashes parameters \p user_name and \p password_hash need to be specified. The
-- password hash uses the \em sha1 digest algorithm and includes both the user name and the password.
--
-- This can be created via openssl or any sha1 tool available in the environment of the client:
-- \code
-- # echo -n "demofoobar" | openssl dgst -sha1
-- # echo -n "demofoobar" | sha1sum
-- \endcode
--
-- \param user_name The user name of the account created via user.register(). If specified \p password_hash also needs to be provided.
-- \param password_hash The password hash as explained in \ref ods_authentication_password_hash. Mandatory if \p user_name is specified.
-- \param facebookUID Deprecated Use user.authenticate.authenticationUrl() for Facebook login.
-- \param openIdUrl Deprecated Use user.authenticate.authenticationUrl() for OpenID login.
-- \param openIdIdentity Deprecated Use user.authenticate.authenticationUrl() for OpenID login.
-- \param oauthMode Deprecated Use user.authenticate.authenticationUrl() for OAuth login.
-- \param oauthSid Deprecated Use user.authenticate.authenticationUrl() for OAuth login.
-- \param oauthVerifier Deprecated Use user.authenticate.authenticationUrl() for OAuth login.
-- \param oauthToken Deprecated Use user.authenticate.authenticationUrl() for OAuth login.
--
-- \return An XML stream containing the session id of the newly created session. This session id can then be
-- used to authenticate other method calls as explained in \ref ods_authentication_session_id. For an example of a user session
-- object see \ref ods_user_session_example.
--
-- \sa \ref ods_authentication_oauth, user.authenticate.browserid(), user.authenticate.webid(), user.authenticate.authenticationUrl()
--
-- \b Example:
-- \verbatim
-- $ curl -i "http://demo.openlinksw.com/ods/api/user.authenticate?user_name=demo&password_hash=49e473da03fbc286f06b5f0bf1f3301b5e4a67fd"
--
-- HTTP/1.1 200 OK
-- Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu
-- Connection: Keep-Alive
-- Date: Tue, 17 Apr 2012 09:31:34 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="UTF-8"
-- Content-Length: 114
--
-- <userSession>
--   <sid>1de236f5da2f32d92e8c0cce5053a96e</sid>
--   <user>
--     <uname>demo</uname>
--     <uid>127</uid>
--     <new>0</new>
--     <dba>0</dba>
--   </user>
-- </userSession>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.authenticate" (
  in user_name varchar := null,
	in password_hash varchar := null,
	in facebookUID varchar := null,
	in openIdUrl varchar := null,
	in openIdIdentity varchar := null,
  in oauthMode varchar := null,
  in oauthSid varchar := null,
  in oauthVerifier varchar := null,
  in oauthToken varchar := null) __soap_http 'text/xml'
{
  declare uname varchar;
  declare sid, tmp, profile_url varchar;
  declare loginData any;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  tmp := (select WAB_DISABLE_UNTIL from DB.DBA.WA_BLOCKED_IP where WAB_IP = http_client_ip ());
  --if (tmp is not null and tmp > now ())
  --  signal ('22023', 'Too many failed attempts. Try again in an hour.');

  loginData := ODS.ODS_API."server.getInfo" ('regData', 0);
  uname := null;
    if (not isnull (facebookUID))
    {
    if (get_keyword ('facebookEnable', loginData, 0) = 0)
      signal ('22023', 'The Facebook authentication type is disabled.');

    profile_url := DB.DBA.WA_USER_OL_ACCOUNTS_FACEBOOK (facebookUID);
    uname := (select U_NAME
                from DB.DBA.SYS_USERS,
                     DB.DBA.WA_USER_OL_ACCOUNTS
               where WUO_U_ID = U_ID
                 and WUO_TYPE = 'P'
                 and WUO_URL = profile_url);

    if (isnull (uname))
      signal ('22023', 'The Facebook account is not registered.\nPlease enter your Facebook account data in ODS ''Edit Profile/Personal/Online Accounts'' \nfor a successful authentication.');
    }
  else if (not isnull (openIdUrl))
    {
      declare vResult any;

    if (get_keyword ('openidEnable', loginData, 0) = 0)
      signal ('22023', 'The OpenID authentication type is disabled.');

      commit work;
      vResult := http_client (openIdUrl);
      if (vResult not like '%is_valid:%true\n%')
      signal ('22023', 'OpenID Authentication Failed.');

    uname := (select U_NAME from DB.DBA.WA_USER_INFO, DB.DBA.SYS_USERS where WAUI_U_ID = U_ID and rtrim (WAUI_OPENID_URL, '/') = rtrim (openIdIdentity, '/'));
    if (isnull (uname))
      signal ('22023', 'The OpenID account is not registered.\nPlease enter your OpenID account data in ODS ''Edit Profile/Security/OpenID'' \nfor a successful authentication.');
    }
  else if (not isnull (oauthMode))
  {
    declare url, token, result, screen_name any;

    if (oauthMode = 'twitter')
    {
      if (get_keyword ('twitterEnable', loginData, 0) = 0)
        signal ('22023', 'The Twitter authentication type is disabled.');

    token := ODS.ODS_API.get_oauth_tok ('Twitter API');
    url := OAUTH..sign_request ('GET',
                                'http://twitter.com/oauth/access_token',
  		                            sprintf ('oauth_token=%U&oauth_verifier=%U', oauthToken, oauthVerifier),
		                            token,
  		                            oauthSid,
		                            1);
    result := http_get (url);
      OAUTH..parse_response (oauthSid, token, result);
    tmp := split_and_decode (result, 0);
    screen_name := get_keyword ('screen_name', tmp);

    uname := (select U_NAME
                from DB.DBA.SYS_USERS,
                     DB.DBA.WA_USER_OL_ACCOUNTS
               where WUO_U_ID = U_ID
                   and WUO_TYPE = 'P'
                   and WUO_URL = DB.DBA.WA_USER_OL_ACCOUNTS_TWITTER (screen_name));
  }
    else if (oauthMode = 'linkedin')
    {
      if (get_keyword ('linkedinEnable', loginData, 0) = 0)
        signal ('22023', 'The LinkedIn authentication type is disabled.');

      token := ODS.ODS_API.get_oauth_tok ('LinkedIn API');
      url := OAUTH..sign_request ('GET',
                                  'https://api.linkedin.com/uas/oauth/accessToken',
  		                            sprintf ('oauth_token=%U&oauth_verifier=%U', oauthToken, oauthVerifier),
  		                            token,
  		                            oauthSid,
  		                            1);
      result := http_get (url);
      OAUTH..parse_response (oauthSid, token, result);
      url := OAUTH..sign_request ('GET', 'https://api.linkedin.com/v1/people/~:(id,first-name,last-name,industry,public-profile-url,date-of-birth)', '', token, oauthSid, 1);
      result := http_get (url);
      profile_url := cast (xpath_eval ('/person/public-profile-url', xtree_doc (result)) as varchar);

      uname := (select U_NAME
                  from DB.DBA.SYS_USERS,
                       DB.DBA.WA_USER_OL_ACCOUNTS
                 where WUO_U_ID = U_ID
                   and WUO_TYPE = 'P'
                   and WUO_URL = profile_url);
    }
    OAUTH..session_terminate (oauthSid);

    if (isnull (uname) and (oauthMode = 'twitter'))
      signal ('22000', 'The Twitter account is not registered.\nPlease enter your Twitter account data in ODS ''Edit Profile/Personal/Online Accounts'' \nfor a successful authentication.');

    if (isnull (uname) and (oauthMode = 'linkedin'))
      signal ('22000', 'The LinkedIn account is not registered.\nPlease enter your LinkedIn account data in ODS ''Edit Profile/Personal/Online Accounts'' \nfor a successful authentication.');
  }
  else
  {
    if (not ods_check_auth (uname))
      uname := null;
  }
  if (isnull (uname))
    return ods_auth_failed ();

  sid := ODS..ods_new_user_session(uname);
  return ODS.DBA.ods_serialize_user_session (sid, uname, 0);
}
;

--!
-- \deprecated Use user.authenticate() instead.
--
-- \brief Start a new user session.
--
-- Calling this method is similar to calling user.authenticate() with the password hash
-- method.
--
-- \param user_name The user name of the account created via user.register().
-- \param password_hash The password hash as explained in \ref ods_authentication_password_hash.
--
-- \return The session id of the newly created session. This session id can then be
-- used to authenticate other method calls as explained in \ref ods_authentication_session_id.
--/
create procedure ODS.ODS_API."user.login" (
  in user_name varchar,
	in password_hash varchar) __soap_http 'text/plain'
{
  return ODS.ODS_API."user.authenticate" (user_name, password_hash);
}
;

--!
-- \brief Validate user authentication credentials.
--
-- This method can be used to check user authentication credentials as detailed in
-- \ref ods_authentication.
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
-- If the authentication credentials are valid \p 1 is returned.
--/
create procedure ODS.ODS_API."user.validate" () __soap_http 'text/xml'
{
  declare uname varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    http_rewrite();
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  return ods_serialize_int_res (1);
}
;

--!
-- \brief End a user session.
--
-- This method ends a user session created via user.login() or user.authenticate().
-- The user session needs to be specified via \ref ods_authentication_session_id.
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--/
create procedure ODS.ODS_API."user.logout" () __soap_http 'text/plain'
{
  declare uname varchar;
  declare rc integer;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  rc := 0;
  if (ods_check_auth (uname))
  {
    declare params, sid, realm any;

    params := http_param ();
    sid := get_keyword ('sid', params);
    realm := get_keyword ('realm', params);
    delete from DB.DBA.VSPX_SESSION where VS_REALM = realm and VS_SID = sid;
    rc := row_count ();
  }
  return ods_serialize_int_res (rc);
}
;

--!
-- \brief Change user profile information.
--
-- This method allows to update any key/value pair in the user profile.
--
-- \param user_info A comma-separated list of \p key=value pairs identifying
-- details in the user profile of the authenticated user. The following keys are supported:
-- - \p WAUI_TITLE
-- - \p WAUI_FIRST_NAME
-- - \p WAUI_LAST_NAME
-- - \p WAUI_FULL_NAME
-- - \p WAUI_GENDER
-- - \p WAUI_BIRTHDAY
-- - \p WAUI_WEBPAGE
-- - \p WAUI_MSIGNATURE
-- - \p WAUI_ICQ
-- - \p WAUI_SKYPE
-- - \p WAUI_AIM
-- - \p WAUI_YAHOO
-- - \p WAUI_MSN
-- - \p WAUI_HADDRESS1
-- - \p WAUI_HADDRESS2
-- - \p WAUI_HCODE
-- - \p WAUI_HCITY
-- - \p WAUI_HSTATE
-- - \p WAUI_HCOUNTRY
-- - \p WAUI_HTZONE
-- - \p WAUI_HPHONE
-- - \p WAUI_HPHONE_EXT
-- - \p WAUI_HMOBILE
-- - \p WAUI_BINDUSTRY
-- - \p WAUI_BORG
-- - \p WAUI_BJOB
-- - \p WAUI_BADDRESS1
-- - \p WAUI_BADDRESS2
-- - \p WAUI_BCODE
-- - \p WAUI_BCITY
-- - \p WAUI_BSTATE
-- - \p WAUI_BCOUNTRY
-- - \p WAUI_BTZONE
-- - \p WAUI_BLAT
-- - \p WAUI_BLNG
-- - \p WAUI_BPHONE
-- - \p WAUI_BPHONE_EXT
-- - \p WAUI_BMOBILE
-- - \p WAUI_BREGNO
-- - \p WAUI_BCAREER
-- - \p WAUI_BEMPTOTAL
-- - \p WAUI_BVENDOR
-- - \p WAUI_BSERVICE
-- - \p WAUI_BOTHER
-- - \p WAUI_BNETWORK
-- - \p WAUI_SUMMARY
-- - \p WAUI_RESUME
-- - \p WAUI_SEC_QUESTION
-- - \p WAUI_SEC_ANSWER
-- - \p WAUI_PHOTO_URL
-- - \p WAUI_TEMPLATE
-- - \p WAUI_LAT
-- - \p WAUI_LNG
-- - \p WAUI_LATLNG_VISIBLE
-- - \p WAUI_USER_SEARCHABLE
-- - \p WAUI_AUDIO_CLIP
-- - \p WAUI_FAVORITE_BOOKS
-- - \p WAUI_FAVORITE_MUSIC
-- - \p WAUI_FAVORITE_MOVIES
-- - \p WAUI_SEARCHABLE
-- - \p WAUI_SHOWACTIVE
-- - \p WAUI_LATLNG_HBDEF
-- - \p WAUI_SITE_NAME
-- - \p WAUI_INTERESTS
-- - \p WAUI_INTEREST_TOPICS
-- - \p WAUI_BORG_HOMEPAGE
-- - \p WAUI_OPENID_URL
-- - \p WAUI_OPENID_SERVER
-- - \p WAUI_FACEBOOK_ID
-- - \p WAUI_IS_ORG
-- - \p WAUI_APP_ENABLE
-- - \p WAUI_SPB_ENABLE
-- - \p WAUI_NICK
-- - \p WAUI_BICQ
-- - \p WAUI_BSKYPE
-- - \p WAUI_BAIM
-- - \p WAUI_BYAHOO
-- - \p WAUI_BMSN
-- - \p WAUI_MESSAGING
-- - \p WAUI_BMESSAGING
-- - \p WAUI_CERT_LOGIN
-- - \p WAUI_CERT_FINGERPRINT
-- - \p WAUI_CERT
-- - \p WAUI_ACL - A serialized array of ACLs which is nearly impossible to create as a client since the serialization requires an internal Virtuoso function called serialize().
-- - \p WAUI_SALMON_KEY
-- - \p WAUI_SETTINGS
-- - \p WAUI_JOIN_DATE
-- - \p WAUI_FOAF
--
-- \reqb{The request body should contain a \ref ods_user_profile_resource.}
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \sa user.update.fields()
--/
create procedure ODS.ODS_API."user.update" (
	in user_info any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare pars any;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  pars := split_and_decode (user_info, 0, '%\0,='); -- XXX: FIXME
  for (declare i, l int, i := 0, l := length (pars); i < l; i := i + 2)
    {
      declare k, v any;
      k := pars[i];
      v := pars [i + 1];
      k := upper (k);
      if (k <> 'E_MAIL')
        k := 'WAUI_' || k;
      DB.DBA.WA_USER_EDIT (uname, k, v);
      rc := 1;
    }
  return ods_serialize_int_res (rc, 'Profile was updated');
}
;

create procedure ODS.ODS_API."user.update.field" (
  in userName varchar,
  in fieldName varchar,
  in fieldValue varchar)
{
  if (isnull (fieldValue))
    return;

  DB.DBA.WA_USER_EDIT (userName, fieldName, fieldValue);
}
;

--!
-- \brief Change user profile information.
--
-- This method allows to update details in the user profile. Any parameter can be omitted which will
-- result in its value not being touched.
--
-- \param nickName The user's nick name. Typically a short name used in chats and such.
-- \param mail The user's email address.
-- \param title The user's title. Can be something like "Mr." or "Ms."
-- \param firstName The user's first name.
-- \param lastName The user's last name.
-- \param fullName The user's full name including any middle names.
-- \param gender The user's gender. Can be either \p "male" or \p "female".
-- \param birthday The user's birthday. The date format is \p YYYY.MM.DD.
-- \param homepage The user's homepage.
-- \param mailSignature The user's mail signature to be attached to each mail written.
-- \param sumary A piece of text giving a summary of the user. This can be anything. The summary is subject to privacy settings as detailed in \ref ods_user_privacy.
-- \param appSetting
-- \param spbEnable
-- \param Search
-- \param showActive
-- \param webIDs
-- \param interests
-- \param topicInterests
-- \param icq
-- \param skype
-- \param yahoo
-- \param aim
-- \param msn
-- \param messaging
-- \param defaultMapLocation
-- \param homeCountry
-- \param homeState
-- \param homeCity
-- \param homeCode
-- \param homeAddress1
-- \param homeAddress2
-- \param homeTimezone
-- \param homeLatitude
-- \param homeLongitude
-- \param homePhone
-- \param homePhoneExt
-- \param homeMobile
-- \param businessIndustry
-- \param businessOrganization
-- \param businessHomePage
-- \param businessJob
-- \param businessRegNo
-- \param businessCareer
-- \param businessEmployees
-- \param businessVendor
-- \param businessService
-- \param businessOther
-- \param businessNetwork
-- \param businessResume
-- \param businessCountry
-- \param businessState
-- \param businessCity
-- \param businessCode
-- \param businessAddress1
-- \param businessAddress2
-- \param businessTimezone
-- \param businessLatitude
-- \param businessLongitude
-- \param businessPhone
-- \param businessPhoneExt
-- \param businessMobile
-- \param businessIcq
-- \param businessSkype
-- \param businessYahoo
-- \param businessAim
-- \param businessMsn
-- \param businessMessaging
-- \param securityOpenID
-- \param securityFacebookID
-- \param securitySecretQuestion
-- \param securitySecretAnswer
-- \param securitySiocLimit
-- \param photo
-- \param photoContent
-- \param audio
-- \param audioContent
-- \param mode
-- \param onlineAccounts
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \sa user.update()
--/
create procedure ODS.ODS_API."user.update.fields" (
  in nickName varchar := null,
  in mail varchar := null,
  in title varchar := null,
  in firstName varchar := null,
  in lastName varchar := null,
  in fullName varchar := null,
  in gender varchar := null,
  in birthday varchar := null,
  in homepage varchar := null,
  in mailSignature varchar := null,
  in sumary varchar := null,
  in appSetting varchar := null,
  in spbEnable varchar := null,
  in inSearch varchar := null,
  in showActive varchar := null,
  in webIDs varchar := null,
  in interests varchar := null,
  in topicInterests varchar := null,

  in icq varchar := null,
  in skype varchar := null,
  in yahoo varchar := null,
  in aim varchar := null,
  in msn varchar := null,
  in messaging varchar := null,

  in defaultMapLocation varchar := null,
  in homeCountry varchar := null,
  in homeState varchar := null,
  in homeCity varchar := null,
  in homeCode varchar := null,
  in homeAddress1 varchar := null,
  in homeAddress2 varchar := null,
  in homeTimezone varchar := null,
  in homeLatitude varchar := null,
  in homeLongitude varchar := null,
  in homePhone varchar := null,
  in homePhoneExt varchar := null,
  in homeMobile varchar := null,

  in businessIndustry varchar := null,
  in businessOrganization varchar := null,
  in businessHomePage varchar := null,
  in businessJob varchar := null,
  in businessRegNo varchar := null,
  in businessCareer varchar := null,
  in businessEmployees varchar := null,
  in businessVendor varchar := null,
  in businessService varchar := null,
  in businessOther varchar := null,
  in businessNetwork varchar := null,
  in businessResume varchar := null,

  in businessCountry varchar := null,
  in businessState varchar := null,
  in businessCity varchar := null,
  in businessCode varchar := null,
  in businessAddress1 varchar := null,
  in businessAddress2 varchar := null,
  in businessTimezone varchar := null,
  in businessLatitude varchar := null,
  in businessLongitude varchar := null,
  in businessPhone varchar := null,
  in businessPhoneExt varchar := null,
  in businessMobile varchar := null,

  in businessIcq varchar := null,
  in businessSkype varchar := null,
  in businessYahoo varchar := null,
  in businessAim varchar := null,
  in businessMsn varchar := null,
  in businessMessaging varchar := null,

  in securityOpenID varchar := null,

  in securityFacebookID varchar := null,

  in securitySecretQuestion varchar := null,
  in securitySecretAnswer varchar := null,
  in securitySiocLimit varchar := null,

  in photo varchar := null,
  in photoContent varchar := null,

  in audio varchar := null,
  in audioContent varchar := null,

  in mode varchar := null,
  in onlineAccounts varchar := null) __soap_http 'text/xml'
{
  declare rc, uid, uname any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  uid := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  -- Personal
  if (not isnull (nickName))
    ODS.ODS_API."user.update.field" (uname, 'WAUI_NICK', DB.DBA.WA_MAKE_NICK (nickName));
  ODS.ODS_API."user.update.field" (uname, 'E_MAIL', mail);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_TITLE', title);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_FIRST_NAME', firstName);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_LAST_NAME', lastName);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_FULL_NAME', fullName);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_GENDER', gender);
  {
    declare dt any;
    declare continue handler for sqlstate '*'
	  {
	    goto _skip;
		};
    dt := stringdate (birthday);
    ODS.ODS_API."user.update.field" (uname, 'WAUI_BIRTHDAY', dt);
  _skip:;
	}
  ODS.ODS_API."user.update.field" (uname, 'WAUI_WEBPAGE', homepage);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_MSIGNATURE', mailSignature);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_SUMMARY', sumary);

  ODS.ODS_API."user.update.field" (uname, 'WAUI_APP_ENABLE', atoi(appSetting));
  ODS.ODS_API."user.update.field" (uname, 'WAUI_SPB_ENABLE', atoi(spbEnable));
  ODS.ODS_API."user.update.field" (uname, 'WAUI_SEARCHABLE', atoi(inSearch));
  ODS.ODS_API."user.update.field" (uname, 'WAUI_SHOWACTIVE', atoi(showActive));

  ODS.ODS_API."user.update.field" (uname, 'WAUI_INTERESTS', interests);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_INTEREST_TOPICS', topicInterests);
  delete from DB.DBA.WA_USER_OL_ACCOUNTS where WUO_NAME = 'webid' and WUO_TYPE = 'P' and WUO_U_ID = uid;
  for (select _iri, _public from DB.DBA.WA_USER_INTERESTS (txt) (_iri varchar, _public varchar) P where txt = webIDs) do
  {
    insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE, WUO_NAME, WUO_URL, WUO_URI, WUO_PUBLIC)
      values (uid, 'P', 'webid', _iri, _iri, _public);
  }

  -- Contact
  ODS.ODS_API."user.update.field" (uname, 'WAUI_ICQ', icq);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_SKYPE', skype);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_AIM', yahoo);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_YAHOO', aim);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_MSN', msn);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_MESSAGING', messaging);

  if (defaultMapLocation = 'on');
    defaultMapLocation := '1';
  ODS.ODS_API."user.update.field" (uname, 'WAUI_LATLNG_HBDEF', defaultMapLocation);
  -- Home
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HCOUNTRY', homeCountry);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HSTATE', homeState);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HCITY', homeCity);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HCODE', homeCode);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HADDRESS1', homeAddress1);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HADDRESS2', homeAddress2);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HTZONE', homeTimezone);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_LAT', homeLatitude);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_LNG', homeLongitude);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HPHONE', homePhone);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HPHONE_EXT', homePhoneExt);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_HMOBILE', homeMobile);

  -- Business
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BINDUSTRY', businessIndustry);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BORG', businessOrganization);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BORG_HOMEPAGE', businessHomePage);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BJOB', businessJob);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BCOUNTRY', businessCountry);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BSTATE', businessState);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BCITY', businessCity);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BCODE', businessCode);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BADDRESS1', businessAddress1);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BADDRESS2', businessAddress2);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BTZONE', businessTimezone);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BLAT', businessLatitude);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BLNG', businessLongitude);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BPHONE', businessPhone);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BPHONE_EXT', businessPhoneExt);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BMOBILE', businessMobile);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BREGNO', businessRegNo);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BCAREER', businessCareer);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BEMPTOTAL', businessEmployees);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BVENDOR', businessVendor);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BSERVICE', businessService);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BOTHER', businessOther);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BNETWORK', businessNetwork);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_RESUME', businessResume);

  ODS.ODS_API."user.update.field" (uname, 'WAUI_BICQ', businessIcq);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BSKYPE', businessSkype);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BAIM', businessYahoo);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BYAHOO', businessAim);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BMSN', businessMsn);
  ODS.ODS_API."user.update.field" (uname, 'WAUI_BMESSAGING', businessMessaging);

  -- Security
  rc := ODS..openid_url_set (uid, securityOpenID);
  if (not isnull (rc))
    signal ('23023', rc);

  if (not DB.DBA.is_empty_or_null (securityFacebookID))
  {
    if (exists (select 1 from DB.DBA.WA_USER_INFO where WAUI_U_ID <> uid and WAUI_FACEBOOK_ID = securityFacebookID))
      signal ('23023', 'This Facebook identity is already registered');
  }
  ODS.ODS_API."user.update.field" (uname, 'WAUI_FACEBOOK_ID', securityFacebookID);

  ODS.ODS_API."user.update.field" (uname, 'SEC_QUESTION', securitySecretQuestion);
  ODS.ODS_API."user.update.field" (uname, 'SEC_ANSWER', securitySecretAnswer);
  if (not isnull (securitySiocLimit))
    DB.DBA.USER_SET_OPTION (uname, 'SIOC_POSTS_QUERY_LIMIT', atoi (securitySiocLimit));

  -- Photo & Audio
  ODS.ODS_API."user.upload.internal" (uname, photo, photoContent, audio, audioContent);

  return ods_serialize_int_res (1);
}
;

-- FIXME: this does not seem to be complete
create procedure ODS.ODS_API."user.acl.array" ()
{
  return vector (
                  'title',                0,
                  'firstName',            1,
                  'lastName',             2,
                  'fullName',             3,
                  'mail',                 4,
                  'gender',               5,
                  'birthday',             6,
                  'homepage',             7,
                  'webIDs',               8,
                  'mailSignature',        9,
                  'icq',                  10,
                  'skype',                11,
                  'yahoo',                12,
                  'aim',                  13,
                  'msn',                  14,
                  'homeAddress1',         15,
                  'homeCountry',          16,
                  'homeTimezone',         17,
                  'homePhone',            18,
                  'businessIndustry',     19,
                  'businessOrganization', 20,
                  'businessJob',          21,
                  'businessAddress1',     22,
                  'businessCountry',      23,
                  'businessTimezone',     24,
                  'businessPhone',        25,
                  'businessRegNo',        26,
                  'businessCareer',       27,
                  'businessEmployees',    28,
                  'businessVendor',       29,
                  'businessService',      30,
                  'businessOther',        31,
                  'businessNetwork',      32,
                  'summary',              33,
                  'businessResume',       34,
                  'photo',                37,
                  'homeLatitude',         39,
                  'audio',                43,
                  'businessLatitude',     47,
                  'interests',            48,
                  'topicInterests',       49,
                  'businessIcq',          50,
                  'businessSkype',        51,
                  'businessYahoo',        52,
                  'businessAim',          53,
                  'businessMsn',          54,
                  'homeCode',             57,
                  'homeCity',             58,
                  'homeState',            59,
                  'businessCode',         60,
                  'businessCity',         61,
                  'businessState',        62
                );
}
;

--!
-- \brief Get privacy information about user profile details.
--
-- Almost each detail in a user's profile can have its individual privacy setting as detailed in
-- \ref ods_user_privacy. This method returns the currently configured privacy settings for the
-- authenticated user.
--
-- \return An XML stream containing one tag for each user profile detail with the following content:
-- - \p 1 - The detail is public
-- - \p 2 - The detail is controlled by ACLs. FIXME: see also somewhere
-- - \p 3 - The detail is private
--
-- \sa user.acl.update()
--
-- \b Example:
-- \verbatim
-- $ curl -i "http://demo.openlinksw.com/ods/api/user.acl.info?user_name=demo&password_hash=49e473da03fbf295f06b5f0bf1f3301b5e4a67fc"
--
-- HTTP/1.1 200 OK
-- Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu
-- Connection: Keep-Alive
-- Date: Wed, 18 Apr 2012 06:30:48 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="UTF-8"
-- Content-Length: 1421
--
-- <acl>
--   <title>1</title>
--   <firstName>1</firstName>
--   <lastName>1</lastName>
--   <fullName>1</fullName>
--   <mail>1</mail>
--   <gender>1</gender>
--   <birthday>2</birthday>
--   <homepage>1</homepage>
--   <webIDs>1</webIDs>
--   <mailSignature>3</mailSignature>
--   <icq>1</icq>
--   <skype>1</skype>
--   <yahoo>1</yahoo>
--   [...]
-- </acl>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.acl.info" () __soap_http 'text/xml'
{
  declare uname varchar;
  declare N, M, acl, aclArray any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  http ('<acl>');
  aclArray := ODS.ODS_API."user.acl.array" ();
  acl := DB.DBA.WA_USER_VISIBILITY(uname);
  for (N := 0; N < length (aclArray); N := N + 2)
  {
    M := aclArray[N+1];
    if (M < length (acl))
      ods_xml_item (aclArray[N], acl[M]);
  }
  http ('</acl>');

  return '';
}
;

--!
-- \brief Change the user profile detail privacy settings.
--
-- Almost each detail in a user's profile can have its individual privacy setting as detailed in
-- \ref ods_user_privacy. This method allows to change these privacy settings.
--
-- The following user detail identifier are supported:
-- - \p title
-- - \p firstName
-- - \p lastName
-- - \p fullName
-- - \p mail
-- - \p gender
-- - \p birthday
-- - \p homepage
-- - \p webIDs
-- - \p mailSignature
-- - \p icq
-- - \p skype
-- - \p yahoo
-- - \p aim
-- - \p msn
-- - \p homeAddress1
-- - \p homeCountry
-- - \p homeTimezone
-- - \p homePhone
-- - \p businessIndustry
-- - \p businessOrganization
-- - \p businessJob
-- - \p businessAddress1
-- - \p businessCountry
-- - \p businessTimezone
-- - \p businessPhone
-- - \p businessRegNo
-- - \p businessCareer
-- - \p businessEmployees
-- - \p businessVendor
-- - \p businessService
-- - \p businessOther
-- - \p businessNetwork
-- - \p summary
-- - \p businessResume
-- - \p photo
-- - \p homeLatitude
-- - \p audio
-- - \p businessLatitude
-- - \p interests
-- - \p topicInterests
-- - \p businessIcq
-- - \p businessSkype
-- - \p businessYahoo
-- - \p businessAim
-- - \p businessMsn
-- - \p homeCode
-- - \p homeCity
-- - \p homeState
-- - \p businessCode
-- - \p businessCity
-- - \p businessState
--
-- \param acls A list of URL-parameter style key/value pairs where each key corresponds to one user profile
-- detail and each value refers to its visibility. A simple example would be \p "gender=1&birthday=3&photo=1"
-- which would set the gender to be public, the birthday to be controlled by fine grained ACLs, and
-- the photo to be public, too. The visibility value can be one of the following:
-- - \p 1 - The detail is public
-- - \p 2 - The detail is controlled by ACLs. FIXME: see also somewhere
-- - \p 3 - The detail is private
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \sa user.acl.info()
--
-- \b Example:
-- \verbatim
-- $ curl -i "http://demo.openlinksw.com/ods/api/user.acl.update?user_name=demo&password_hash=49e473da03fbd296f05b5f0bf1f3301b5e4a67fc&acls=gender%3D1%26birthday%3D3%26photo%3D1"
--
-- HTTP/1.1 200 OK
-- Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu
-- Connection: Keep-Alive
-- Date: Wed, 18 Apr 2012 09:07:25 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="UTF-8"
-- Content-Length: 57
--
-- <result><code>1</code><message>Success</message></result>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.acl.update" (
  in acls varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare N, tmp, acl, aclArray any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  tmp := vector ();
  aclArray := ODS.ODS_API."user.acl.array" ();
  acl := DB.DBA.WA_USER_VISIBILITY(uname);
  acls := split_and_decode (acls);
  if (length (acls))
  {
    for (N := 0; N < length (aclArray); N := N + 2)
    {
      if (not isnull (get_keyword (aclArray[N], acls)))
        tmp := vector_concat (tmp, vector (cast (aclArray[N+1] as varchar), get_keyword (aclArray[N], acls)));
    }
    DB.DBA.WA_USER_VISIBILITY(uname, tmp, 2);
  }

  return ods_serialize_int_res (1);
}
;

--!
-- \brief Change the password of a user account.
--
-- This method allows to change the password on a user account. Since passwords
-- are transmitted in plain text it is recommended to use an encrypted connection.
--
-- \param old_password The old password in plain text.
-- \param new_password The new password in plain text.
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \b Example:
-- \verbatim
-- $ curl -i "http://demo.openlinksw.com/ods/api/user.password_change?user_name=test123&password_hash=4674a4b44e89011cfa581ff90967ebc52fd1080d&old_password=1&new_password=2"
--
-- HTTP/1.1 200 OK
-- Server: Virtuoso/05.12.3041 (Solaris) x86_64-sun-solaris2.10-64  VDB
-- Connection: Keep-Alive
-- Date: Mon, 28 Dec 2009 22:46:56 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="ISO-8859-1"
-- Content-Length: 57
--
-- <result>
--   <code>1</code>
--   <message>Success</message>
-- </result>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.password_change" (
  in old_password varchar,
	in new_password varchar) __soap_http 'text/xml'
{
  declare uname, msg varchar;
  declare rc integer;
  declare tmp, userPassword, noPassword varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  declare exit handler for sqlstate '*' {
    msg := __SQL_MESSAGE;
    goto ret;
  };
  rc := -1;
  msg := 'Success';
  set_user_id ('dba');
  for (select U_NAME, U_PASSWORD from DB.DBA.SYS_USERS, DB.DBA.WA_USER_INFO where WAUI_U_ID = U_ID and U_NAME = uname) do
  {
    userPassword := pwd_magic_calc (U_NAME, U_PASSWORD, 1);
    tmp := uuid ();
    tmp := subseq (tmp, strrchr (tmp, '-'));
    if ((userPassword like '%'||tmp) and (regexp_match ('[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}', userPassword) is not null))
      old_password := userPassword;
  }
  DB.DBA.USER_CHANGE_PASSWORD (uname, old_password, new_password);
  rc := 1;
ret:
  return ods_serialize_int_res (rc, msg);
}
;

--!
-- \deprecated Use user.update() instead.
--
-- \brief Upload binary user data.
--
-- The ODS user profile contains an optional user photo and user audio file. These can be
-- uploaded through this method.
--
-- For this purpose an HTTP POST needs to be performed with the following paramters:
-- - \c pf_photo - The file name of the photo.
-- - \c pf_photoContent - The content of the photo file (jpg, gif, or png)
-- - \c pf_audio - The file name of the audio.
-- - \c pf_audioContent - The content of the audio file.
--
-- \return \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \sa user.update(), user.update.fields()
--/
create procedure ODS.ODS_API."user.upload" () __soap_http 'text/xml'
{
  declare params any;
  declare photo, photoContent, audio, audioContent any;

  declare uname varchar;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  params := http_param ();

  photo := get_keyword ('pf_photo', params);
  photoContent := get_keyword ('pf_photoContent', params);

  audio := get_keyword ('pf_audio', params);
  audioContent := get_keyword ('pf_audioContent', params);

  ODS.ODS_API."user.upload.internal" (uname, photo, photoContent, audio, audioContent);

  return ods_serialize_int_res (1);
}
;

create procedure ODS.ODS_API."user.upload.internal" (
  in uname varchar,
  in photo varchar := null,
  in photoContent varchar := null,

  in audio varchar := null,
  in audioContent varchar := null)
{
  -- Photo
  if (length(photo) and length(photoContent))
  {
    declare rc, uid integer;
    declare dir, path, path_org, path_size2, dotpos any;
    declare img, thumb, thumb_size2 any;
    declare ext any;

    ext := split_and_decode (photo, 0, '\0\0.');
    if (ext is not null and ext[length(ext)-1] is not null and lcase(ext[length(ext)-1]) not in ('jpg', 'png', 'gif'))
      signal ('23023', 'Invalid image type. Please use jpg, png or gif for browser compatibility');

    uid := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
    dir := rtrim (DB.DBA.DAV_HOME_DIR (uname), '/')||'/wa/images/';
    path := photo;
    if (photo not like '/%')
      path := dir || path;

    dotpos := regexp_instr (photo,'\..{3}\$')-1;
    path_org := subseq (photo, 0, dotpos) || '_org' || subseq (photo, dotpos);
    path_size2 := subseq (photo, 0, dotpos) || '_size2' || subseq (photo, dotpos);
    if (photo not like '/%')
    {
      path_org := dir || path_org;
      path_size2 := dir || path_size2;
    }
    DB.DBA.DAV_MAKE_DIR (dir, uid, http_admin_gid (), '110100100N');
    rc := DB.DBA.DAV_RES_UPLOAD_STRSES_INT (path_org, photoContent, '', '110100100RR', uname, http_nogroup_gid(), null, null, 0);
    if (rc < 0)
      signal ('23023', DB.DBA.DAV_PERROR (rc));
    rc := DB.DBA.DAV_RES_UPLOAD_STRSES_INT (path, photoContent, '', '110100100RR', uname, http_nogroup_gid(), null, null, 0);
    if (rc < 0)
      signal ('23023', DB.DBA.DAV_PERROR (rc));

    img := (select blob_to_string (RES_CONTENT) from WS.WS.SYS_DAV_RES where RES_ID = rc);
    thumb := null;
    if (img is not null)
      thumb := DB.DBA.WA_MAKE_THUMBNAIL_1 (img);
    thumb_size2 := DB.DBA.WA_MAKE_THUMBNAIL_1 (img, 115, 160);

    if (thumb is not null)
      DB.DBA.DAV_RES_UPLOAD_STRSES_INT (path, thumb, '', '110100100RR', uname, http_nogroup_gid(), null, null, 0);

    if (thumb_size2 is not null)
      DB.DBA.DAV_RES_UPLOAD_STRSES_INT (path_size2, thumb_size2, '', '110100100RR', uname, http_nogroup_gid(), null, null, 0);

    if (path like '/DAV/%')
      path := subseq (path, 4);
    ODS.ODS_API."user.update.field" (uname, 'WAUI_PHOTO_URL', path);
  }
  else if (length(photo))
  {
    ODS.ODS_API."user.update.field" (uname, 'WAUI_PHOTO_URL', photo);
  }
  else if (photo = '')
  {
    ODS.ODS_API."user.update.field" (uname, 'WAUI_PHOTO_URL', '');
  }

  -- Audio
  if (length(audio) and length (audioContent))
  {
    declare rc, uid integer;
    declare dir, path any;

    uid := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
    dir := rtrim (DB.DBA.DAV_HOME_DIR (uname), '/') || '/wa/media/';

    path := audio;
    if (audio not like '/%')
      path := dir || path;

    DB.DBA.DAV_MAKE_DIR (dir, uid, http_admin_gid (), '110100100N');
    rc := DB.DBA.DAV_RES_UPLOAD_STRSES_INT (path, audioContent, '', '110100100RR', uname, http_nogroup_gid(), null, null, 0);
    if (rc < 0)
      signal ('23023', DB.DBA.DAV_PERROR (rc));

    if (path like '/DAV/%')
      path := subseq (path, 4);
    ODS.ODS_API."user.update.field" (uname, 'WAUI_AUDIO_CLIP', path);
  }
  else if (audio = '')
  {
    ODS.ODS_API."user.update.field" (uname, 'WAUI_AUDIO_CLIP', '');
  }
}
;

-- ODS admin privilege
create procedure ODS.ODS_API."user.delete" (
  in name varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();
  if (not exists (select 1 from DB.DBA.SYS_USERS where U_NAME = name))
    return ods_serialize_sql_error ('37000', 'The item is not found');
  if (uname in ('dav', 'dba'))
    {
      delete from DB.DBA.SYS_USERS where U_NAME = name;
      rc := row_count ();
  } else {
    rc := -13;
  }
  return ods_serialize_int_res (rc);
}
;

-- ODS admin privilege
create procedure ODS.ODS_API."user.enable" (
  in name varchar) __soap_http 'text/xml'
{
  declare rc, allow integer;
  declare uname varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  if (not exists (select 1 from DB.DBA.SYS_USERS where U_NAME = name))
    return ods_serialize_sql_error ('37000', 'The item is not found');

  allow := 0;
  if (uname in ('dav', 'dba'))
    allow := 1;

  if ((not allow) and (uname = DB.DBA.WA_USER_SETTING_GET (name, 'DISABLED_BY')))
    allow := 1;

  if (allow)
    {
    update DB.DBA.WA_INSTANCE
       set WAI_IS_FROZEN = 0
     where WAI_NAME in (select WAM_INST from DB.DBA.WA_MEMBER, DB.DBA.SYS_USERS where WAM_USER = U_ID and U_NAME = name and WAM_MEMBER_TYPE = 1);
    DB.DBA.WA_USER_SETTING_SET (name, 'DISABLED_BY', null);
    connection_set ('WA_USER_DISABLED', name);
      DB.DBA.USER_SET_OPTION (name, 'DISABLED', 0);
      rc := 1;
  } else {
    rc := -13;
  }
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.disable" (
  in name varchar) __soap_http 'text/xml'
{
  declare rc integer;
  declare uname varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  if (not exists (select 1 from DB.DBA.SYS_USERS where U_NAME = name))
    return ods_serialize_sql_error ('37000', 'The item is not found');

  if ((uname in ('dav', 'dba')) or (uname = name))
    {
    delete from DB.DBA.VSPX_SESSION where VS_UID = name;
    update DB.DBA.WA_INSTANCE
       set WAI_IS_FROZEN = 1
     where WAI_NAME in (select WAM_INST from DB.DBA.WA_MEMBER, DB.DBA.SYS_USERS where WAM_USER = U_ID and U_NAME = name and WAM_MEMBER_TYPE = 1);
    DB.DBA.WA_USER_SETTING_SET (name, 'DISABLED_BY', uname);
    connection_set ('WA_USER_DISABLED', name);
    DB.DBA.USER_SET_OPTION (name, 'DISABLED', 1);
      rc := 1;
  } else {
    rc := -13;
  }
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.get" (
  in name varchar) __soap_http 'text/xml'
{
  declare q varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  q := sprintf ('select * from <%s> where { ?user a sioc:User ; sioc:id "%s" ; ?property ?value } ', ods_graph(), name);
  exec_sparql (q);
  return '';
}
;

--!
-- \brief Fetch basic information about a user.
--
-- This method allows to fetch details about an ODS user. If no user name is given the authenticated
-- user is returned. This means that user.info() can be used to get user information for an authentication
-- session (see also \ref ods_authentication_session_id).
--
-- \param name The optional ODS user name. Defaults to the authenticated user.
-- \param short An optional boolean setting. If \p 1 only the most basic information is returned.
--
-- \return An XML stream encoding the user details such as uid, name, or the personal URL.
--
-- \b Example:
-- \verbatim
-- $ curl -i "http://demo.openlinksw.com/ods/api/user.info?sid=07e6e4b8da77691c729e6c95e3016ac8&short=1"
-- HTTP/1.1 200 OK
-- Server: Virtuoso/06.01.3127 (Linux) x86_64-unknown-linux-gnu
-- Connection: Keep-Alive
-- Date: Sat, 21 Apr 2012 09:52:46 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="UTF-8"
-- Content-Length: 157
--
-- <user><uid>127</uid><iri>http://demo.openlinksw.com/dataspace/person/demo#this</iri><name>demo</name><nickName>demo</nickName><fullName>Demo User
-- </fullName></user>
-- \endverbatim
--/
create procedure ODS.ODS_API."user.info" (
  in name varchar := null,
  in "short" varchar := '0') __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc, tmp, userPassword, noPassword integer;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    http_rewrite();
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname) and isnull (name))
    return ods_auth_failed ();

  if (isinteger (uname))
    uname := null;

  if (not isnull (uname) and isnull (name))
    name := uname;

  if (not isnull (uname) and (uname <> name))
    return ods_serialize_sql_error ('37000', 'Bad  user''s name parameter');

  if (not exists (select 1 from DB.DBA.SYS_USERS where U_NAME = name))
    return ods_serialize_sql_error ('37000', 'The item is not found');

  for (select * from DB.DBA.SYS_USERS, DB.DBA.WA_USER_INFO where WAUI_U_ID = U_ID and U_NAME = name) do
  {
    userPassword := pwd_magic_calc (U_NAME, U_PASSWORD, 1);
    tmp := uuid ();
    tmp := subseq (tmp, strrchr (tmp, '-'));
    noPassword := case when (userPassword like '%'||tmp) and (regexp_match ('[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}', userPassword) is not null) then '1' else '0' end;

    http ('<user>');

    -- Personal
    ods_xml_item ('uid',       U_ID);
    ods_xml_item ('iri',        SIOC..person_iri (SIOC..user_obj_iri (U_NAME)));
    ods_xml_item ('name',      U_NAME);
    ods_xml_item ('nickName',  WAUI_NICK);
    ods_xml_item ('firstName', WAUI_FIRST_NAME);
    ods_xml_item ('lastName',  WAUI_LAST_NAME);
    ods_xml_item ('fullName',  WAUI_FULL_NAME);

    if (isnull (uname))
      goto _notLogged;

    ods_xml_item ('noPassword', noPassword);
    ods_xml_item ('mail',       U_E_MAIL);
    ods_xml_item ('title',      WAUI_TITLE);
    ods_xml_item ('homepage',  WAUI_WEBPAGE);
    ods_xml_item ('qrcode',     ODS.ODS_API."qrcode"(WAUI_WEBPAGE));

    if ("short" = '0')
    {
      -- Personal
      ods_xml_item ('gender',                 WAUI_GENDER);
      if (not isnull (WAUI_BIRTHDAY))
        ods_xml_item ('birthday',             subseq (datestring (WAUI_BIRTHDAY), 0, 10));

      tmp := '';
      for (select WUO_URL, WUO_PUBLIC from DB.DBA.WA_USER_OL_ACCOUNTS where WUO_NAME = 'webid' and WUO_TYPE = 'P' and WUO_U_ID = U_ID) do
      {
        tmp := tmp || WUO_URL || ';' || cast (WUO_PUBLIC as varchar)  || '\n';
      }
      ods_xml_item ('webIDs',                 tmp);
      ods_xml_item ('interests',              WAUI_INTERESTS);
      ods_xml_item ('topicInterests',         WAUI_INTEREST_TOPICS);

      -- Contact
      ods_xml_item ('icq',                    WAUI_ICQ);
      ods_xml_item ('skype',                  WAUI_SKYPE);
      ods_xml_item ('yahoo',                  WAUI_YAHOO);
      ods_xml_item ('aim',                    WAUI_AIM);
      ods_xml_item ('msn',                    WAUI_MSN);
      ods_xml_item ('messaging',              WAUI_MESSAGING);

      ods_xml_item ('defaultMapLocation',     WAUI_LATLNG_HBDEF);
      -- Home
      ods_xml_item ('homeCountry',            WAUI_HCOUNTRY);
      ods_xml_item ('homeState',              WAUI_HSTATE);
      ods_xml_item ('homeCity',               WAUI_HCITY);
      ods_xml_item ('homeCode',               WAUI_HCODE);
      ods_xml_item ('homeAddress1',           WAUI_HADDRESS1);
      ods_xml_item ('homeAddress2',           WAUI_HADDRESS2);
      ods_xml_item ('homeTimezone',           WAUI_HTZONE);
      ods_xml_item ('homeLatitude',           case when isnull (WAUI_LAT) then '' else sprintf ('%.6f', coalesce (WAUI_LAT, 0.00)) end);
      ods_xml_item ('homeLongitude',          case when isnull (WAUI_LNG) then '' else sprintf ('%.6f', coalesce (WAUI_LNG, 0.00)) end);
      ods_xml_item ('homePhone',              WAUI_HPHONE);
      ods_xml_item ('homePhoneExt',           WAUI_HPHONE_EXT);
      ods_xml_item ('homeMobile',             WAUI_HMOBILE);

      -- Business
      ods_xml_item ('businessIndustry',       WAUI_BINDUSTRY);
      ods_xml_item ('businessOrganization',   WAUI_BORG);
      ods_xml_item ('businessHomePage',       WAUI_BORG_HOMEPAGE);
      ods_xml_item ('businessJob',            WAUI_BJOB);
      ods_xml_item ('businessCountry',        WAUI_BCOUNTRY);
      ods_xml_item ('businessState',          WAUI_BSTATE);
      ods_xml_item ('businessCity',           WAUI_BCITY);
      ods_xml_item ('businessCode',           WAUI_BCODE);
      ods_xml_item ('businessAddress1',       WAUI_BADDRESS1);
      ods_xml_item ('businessAddress2',       WAUI_BADDRESS2);
      ods_xml_item ('businessTimezone',       WAUI_BTZONE);
      ods_xml_item ('businessLatitude',       case when isnull (WAUI_BLAT) then '' else sprintf ('%.6f', coalesce (WAUI_BLAT, 0.00)) end);
      ods_xml_item ('businessLongitude',      case when isnull (WAUI_BLNG) then '' else sprintf ('%.6f', coalesce (WAUI_BLNG, 0.00)) end);
      ods_xml_item ('businessPhone',          WAUI_BPHONE);
      ods_xml_item ('businessPhoneExt',       WAUI_BPHONE_EXT);
      ods_xml_item ('businessMobile',         WAUI_BMOBILE);
      ods_xml_item ('businessRegNo',          WAUI_BREGNO);
      ods_xml_item ('businessCareer',         WAUI_BCAREER);
      ods_xml_item ('businessEmployees',      WAUI_BEMPTOTAL);
      ods_xml_item ('businessVendor',         WAUI_BVENDOR);
      ods_xml_item ('businessService',        WAUI_BSERVICE);
      ods_xml_item ('businessOther',          WAUI_BOTHER);
      ods_xml_item ('businessNetwork',        WAUI_BNETWORK);
      ods_xml_item ('businessResume',         WAUI_RESUME);

      ods_xml_item ('businessIcq',            WAUI_BICQ);
      ods_xml_item ('businessSkype',          WAUI_BSKYPE);
      ods_xml_item ('businessYahoo',          WAUI_BYAHOO);
      ods_xml_item ('businessAim',            WAUI_BAIM);
      ods_xml_item ('businessMsn',            WAUI_BMSN);
      ods_xml_item ('businessMessaging',      WAUI_BMESSAGING);

      -- Security
      ods_xml_item ('securityOpenID',         WAUI_OPENID_URL);
      ods_xml_item ('securityFacebookID',     WAUI_FACEBOOK_ID);
      if (not isnull (WAUI_FACEBOOK_ID))
      {
        declare fb_options any;
        declare fb DB.DBA.Facebook;

        if (DB.DBA._get_ods_fb_settings (fb_options))
        {
          fb := new DB.DBA.Facebook(fb_options[0], fb_options[1], http_param (), http_request_header ());
          rc := fb.api_client.users_getInfo(WAUI_FACEBOOK_ID, 'name');
          ods_xml_item ('securityFacebookName', serialize_to_UTF8_xml (xpath_eval('string(/users_getInfo_response/user/name)', rc)));
        }
      }
      ods_xml_item ('securitySecretQuestion', WAUI_SEC_QUESTION);
      ods_xml_item ('securitySecretAnswer',   WAUI_SEC_ANSWER);
      ods_xml_item ('securitySiocLimit',      DB.DBA.USER_GET_OPTION (U_NAME, 'SIOC_POSTS_QUERY_LIMIT'));

      ods_xml_item ('appSetting',             cast (WAUI_APP_ENABLE as varchar));
      ods_xml_item ('spbEnable',              cast (WAUI_SPB_ENABLE as varchar));
      ods_xml_item ('inSearch',               cast (WAUI_SEARCHABLE as varchar));
      ods_xml_item ('showActive',             cast (WAUI_SHOWACTIVE as varchar));

      ods_xml_item ('photo',                  WAUI_PHOTO_URL);
      ods_xml_item ('audio',                  WAUI_AUDIO_CLIP);
    }
  _notLogged:;
    http ('</user>');
  }
  return '';
}
;

--!
-- \brief Fetch details about an ODS user based on their WebID.
--
-- This method returns public information about an ODS user based on their specific
-- ODS WebID.
--
-- \param webID The WebID of the user to lookup.
-- \param output The output type. Can be either \p xml or \p json. Defaults to \p xml.
--
-- \return The details of the requested user serialized as an xml stream.s
--/
create procedure ODS.ODS_API."user.info.webID" (
  in webID varchar,
  in output varchar := 'xml') __soap_http 'text/xml'
{
  declare N, M, L integer;
  declare foafGraph varchar;
  declare S, st, msg, data, meta, cleanMeta any;
  declare V, tmp, metaName, metaValue, _names, _values, _newValue any;

  V := jsonObject ();
  set_user_id ('dba');
  foafGraph := SIOC..get_graph();
  S := sprintf ('sparql
                 define input:storage ""
                 prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
                 prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
                 prefix dc: <http://purl.org/dc/elements/1.1/>
                 prefix foaf: <http://xmlns.com/foaf/0.1/>
                 prefix geo: <http://www.w3.org/2003/01/geo/wgs84_pos#>
                 prefix bio: <http://vocab.org/bio/0.1/>
                 select *
         		       from <%s>
                  where {
                          {?iri a foaf:Person } UNION {?iri a foaf:Organization } .
                          ?iri rdf:type ?kind .
                          optional { ?iri foaf:name ?name } .
                          optional { ?iri foaf:title ?title } .
                          optional { ?iri foaf:nick ?nick } .
                          optional { ?iri foaf:firstName ?firstName } .
                          optional { ?iri foaf:givenname ?givenname } .
                          optional { ?iri foaf:family_name ?family_name } .
                          optional { ?iri foaf:mbox ?mbox } .
                          optional { ?iri foaf:mbox_sha1sum ?mbox_sha1sum } .
                          optional { ?iri foaf:gender ?gender } .
                          optional { ?iri foaf:birthday ?birthday } .
                          optional { ?iri foaf:based_near ?t_b1 .
                                     ?t_b1 geo:lat ?lat;
                                           geo:long ?lng .
                                   } .
                          optional { ?iri foaf:icqChatID ?icqChatID } .
                          optional { ?iri foaf:msnChatID ?msnChatID } .
                          optional { ?iri foaf:aimChatID ?aimChatID } .
                          optional { ?iri foaf:yahooChatID ?yahooChatID } .
	                        optional { {?iri foaf:holdsAccount ?t_holdsAccount} UNION {?iri foaf:account ?t_holdsAccount}.
         	                           ?t_holdsAccount foaf:accountServiceHomepage ?t_accountServiceHomepage ;
         	                                           foaf:accountName ?skypeChatID.
                                     filter (str(?t_accountServiceHomepage) like ''skype%%'').
                                   } .
                          optional { ?iri foaf:workplaceHomepage ?workplaceHomepage } .
                          optional { ?iri foaf:homepage ?homepage } .
                          optional { ?iri foaf:phone ?phone } .
                          optional { ?iri foaf:depiction ?depiction } .
                          optional { ?iri bio:keywords ?keywords } .
                          optional { ?organization a foaf:Organization }.
                          optional { ?organization foaf:homepage ?workplaceHomepage }.
                          optional { ?organization dc:title ?organizationTitle }.
                          optional { ?iri vcard:ADR ?t_address .
                                     optional { ?t_address vcard:Country ?country } .
                             	       optional { ?t_address vcard:Locality ?locality } .
                              			 optional { ?t_address vcard:Region ?region } .
                              			 optional { ?t_address vcard:Pobox ?pobox } .
                              			 optional { ?t_address vcard:Street ?street } .
                              			 optional { ?t_address vcard:Extadd ?extadd } .
                          	       } .
                          optional { ?iri foaf:interest ?x_interest_url .
                                     ?x_interest_url rdfs:label ?xa_interest_label. } .
                          optional { ?iri foaf:topic_interest ?x_topicInterest_url .
                                     ?x_topicInterest_url rdfs:label ?xa_topicInterest_label. } .
	                        optional { {?iri foaf:holdsAccount ?t_oa} UNION {?iri foaf:account ?t_oa}.
                                     ?t_oa a foaf:OnlineAccount.
                                     ?t_oa foaf:accountServiceHomepage ?x_onlineAccount_url.
                                     ?t_oa foaf:accountName ?xa_onlineAccount_label.
                                     filter (!(str(?x_onlineAccount_url) like ''skype%%'')).
                                   } .
                          optional { ?iri owl:sameAs ?x_sameAs } .
             	            optional { ?iri foaf:knows ?x_knows_iri .
             	                      ?x_knows_iri rdfs:seeAlso ?xa_knows_seeAlso .
             	                      ?x_knows_iri foaf:nick ?xa_knows_nick .
             	                    } .
                          optional { ?iri bio:olb ?resume } .
                          optional { ?iri foaf:made ?x_made } .
                          filter (?iri = iri(?::0)).
                        }', foafGraph);
  commit work;
  st := '00000';
  exec (S, st, msg, vector (webID), vector ('use_cache', 1), meta, data);
  if (st <> '00000')
    goto _exit;

  -- clean meta
  cleanMeta := vector ();
  for (N := 0; N < length (meta[0]); N := N + 1)
    cleanMeta := vector_concat (cleanMeta, vector (meta[0][N][0]));

  for (N := 0; N < length (data); N := N + 1)
  {
    for (M := 0; M < length (cleanMeta); M := M + 1)
    {
      metaName := cleanMeta[M];
      if (metaName like 't_%')
        goto _skip;
      if (metaName like 'xa_%')
        goto _skip;
      if ((N > 0) and (metaName not like 'x_%'))
        goto _skip;

      metaValue := data[N][M];
      if (metaName like 'x_%')
      {
        _names := split_and_decode (metaName, 0, '\0\0_');
        if (length (_names) = 2)
        {
          if (not isnull (metaValue))
          {
            _values := get_keyword (_names[1], V, vector ());
            if (not ODS.ODS_API.vector_contains(_values, metaValue))
            {
              _values := vector_concat (_values, vector (metaValue));
              ODS.ODS_API.set_keyword (_names[1], V, _values);
            }
          }
        } else {
          _values := get_keyword (_names[1], V, vector ());
          _newValue := jsonObject ();
          if (not isnull (metaValue))
            _newValue := vector_concat (_newValue, vector (_names[2], metaValue));
          for (L := 0; L < length (cleanMeta); L := L + 1)
          {
            if (cleanMeta[L] like 'xa_'||_names[1]||'_%')
            {
              metaName := subseq (cleanMeta[L], length ('xa_'||_names[1]||'_'));
              metaValue := data[N][L];
              if (not isnull (metaValue))
                _newValue := vector_concat (_newValue, vector (metaName, metaValue));
            }
          }
          if ((length (_newValue) > 2) and not ODS.ODS_API.vector_contains(_values, _newValue))
          {
            _values := vector_concat (_values, vector (_newValue));
            ODS.ODS_API.set_keyword (_names[1], V, _values);
          }
        }
      }
      else if ((N = 0) and not isnull (metaValue))
      {
        ODS.ODS_API.set_keyword (metaName, V, metaValue);
      }

    _skip:;
    }
  }

  if (length (V) > 2)
  {
    commit work;
    S := DB.DBA.FOAF_SSL_QR (SIOC..get_graph(), webID);
    exec (S, st, msg, vector (), 0, meta, data);
    if (st = '00000' and length (data))
    {
      declare C any;

      C := vector ();
      for (N := 0; N < length (data); N := N + 1)
        C := vector_concat (C, vector (vector_concat (jsonObject (), vector ('rsaNo', N, 'rsaPublicExponent', data[N][0], 'rsaModulus', data[N][1]))));

      ODS.ODS_API.set_keyword ('rsaPublicKey', V, C);
    }
    tmp := get_keyword ('homepage', V);
    if (not isnull (tmp))
      ODS.ODS_API.set_keyword ('qrcode', V, ODS.ODS_API."qrcode"(tmp));
  }

_exit:;
  if (output = 'xml')
    return obj2xml(vector (V), 10, 'user');
  return obj2json(V, 10);
}
;

create procedure ODS.ODS_API."user.certificateUrl" () __soap_http 'application/json'
{
  declare uname, rc, ua, url, webId any;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  rc := null;
  ua := http_request_header (http_request_header (), 'User-Agent');
  if (coalesce (strstr (ua, 'MSIE'), -1) > 0 or regexp_match ('Mozilla.*Windows.*Firefox.*\.NET CLR .*', ua) is not null)
  {
    declare svc_url varchar;

    rc := '';
    url := (select  top 1 WS_CERT_GEN_URL from DB.DBA.WA_SETTINGS);
    if (length (url))
    {
      for (select U_NAME, U_FULL_NAME, U_E_MAIL, WAUI_BORG, WAUI_BCOUNTRY
             from DB.DBA.SYS_USERS,
                  DB.DBA.WA_USER_INFO
     	      where U_NAME = uname and U_ID = WAUI_U_ID) do
      {
        webId := sioc..person_iri (sioc..user_obj_iri (U_NAME));
        rc := sprintf ('%s?uri=%U&name=%U&email=%U&organization=%U', url, webId, coalesce (U_FULL_NAME, U_NAME), coalesce (U_E_MAIL, ''), coalesce (WAUI_BORG, ''));
      }
    }
  }
  return obj2json(rc, 10);
}
;

create procedure ODS.ODS_API."user.search" (
  in pattern varchar) __soap_http 'text/xml'
{
  declare q varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  q := sprintf ('select * from <%s> where { ?user a sioc:User ; ?property ?value . ?value bif:contains "%s" } ', ods_graph(), pattern);
  exec_sparql (q);
  return '';
}
;

-- Social Network activity

--!
-- \brief Invite someone to join the user's social network.
--
-- ODS allows users to be connected in a social network. This requires users to send invitations
-- to other users. The other users then need to either approve or reject that invitation.
--
-- \param friends_email The email address the invitation should be sent to. This can either be
-- an already registered user or someone that is also invited to create an account with the instance of ODS.
-- \param custom_message An optional custom message to be sent as part of the autogenerated one. The auto-generated
-- message is based on a template stored in the DAV file system at \p "/DAV/VAD/wa/tmpl/SN_INV_TEMPLATE" or in the
-- web server's file structure at \p "wa/tmpl/SN_INV_TEMPLATE". The default template can be seen below.
-- \verbatim
-- %invitation%
--
-- I've created my own place on %app% and I'd like you to connect to me so we can stay in touch.
-- You can view my blog, my photos, my news and wiki.
--
-- With %app%, you can create your own personal page and blog of your own,
-- which will can be linked to mine.
--
-- To join my network please visit %url%
--
-- - %user%
--
-- --------------------------------------------------------------------------
--
-- Thank you for using Virtuoso Web Applications. Virtuoso Team
--
-- -- Powered by Virtuoso  http://virtuoso.openlinksw.com/
-- \endverbatim
-- It can easily be replaced by the system administrator. The following placeholders are supported:
-- - \p %app% - The title of the web service or the server's hostname as a fallback.
-- - \p %user% - The full name of the user sending the invitation.
-- - \p %url% - The URL to the login page of this ODS instance. FIXME: This depends on the used UI. It should be provided by the client or be configurable.
-- - \p %invitation% - The \p custom_message provided as a parameter.
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \sa user.invitation.approve(), user.invitation.list()
--/
create procedure ODS.ODS_API."user.invitation.new" (
  in friends_email varchar,
  in custom_message varchar := '') __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare i, uids, sn_id, msg, url any;
  declare copy varchar;
  declare _u_full_name, _u_e_mail varchar;
  declare msg varchar;

  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

-- FIXME: this URL is UI specific and should be provided by the client rather than being hard-coded here.
  url := WS.WS.EXPAND_URL (HTTP_URL_HANDLER (), 'login.vspx?URL=sn_rec_inv.vspx');
  copy := (select top 1 WS_WEB_TITLE from DB.DBA.WA_SETTINGS);
  if (copy = '' or copy is null)
    copy := sys_stat ('st_host_name');

  whenever not found goto ret;
  msg := '';
  select U_FULL_NAME, U_E_MAIL into _u_full_name, _u_e_mail from DB.DBA.SYS_USERS where U_NAME = uname;
  sn_id := (select sne_id from DB.DBA.sn_person where sne_name = uname);
  msg := DB.DBA.WA_GET_EMAIL_TEMPLATE ('SN_INV_TEMPLATE', 1);
  msg := replace (msg, '%app%', copy);
-- FIXME: the template does not contain the '%invitation%' placeholder
  msg := replace (msg, '%invitation%', custom_message);
-- FIXME: why would the user send a message to themselves. Here the receipiant's name should go. This we only have if the user is already registered or if we invite a WebID which should be possible, too.
  msg := replace (msg, '%user%', DB.DBA.WA_WIDE_TO_UTF8 (_u_full_name));
  msg := replace (msg, '%url%', url);

-- FIXME: %app_action_url%, %service_url%, %app_owner%, %timeout_join% and %service% are never replaced in the msg.

  uids := split_and_decode (friends_email, 0, '\0\0,');

  if (not length (uids))
    {
      rc := -1;
      msg := 'Please enter at least one mail address';
      goto ret;
    }

  i := 0;

  foreach (any mail in uids) do
    {
      mail := trim (mail);
      msg := replace (msg, '%name%', mail);
      msg := replace (msg, '%url%', url);

      insert soft DB.DBA.sn_invitation (sni_from, sni_to, sni_status) values (sn_id, mail, 0);
      rc := rc + row_count();

      if (row_count () > 0)
	{
	  declare exit handler for sqlstate '*'
	    {
	      rollback work;
	      if (__SQL_STATE not like 'WA%')
      		msg := 'The e-mail address(es) is not valid and mail cannot be sent';
	      else
		msg := __SQL_MESSAGE;
              rc := -1;
              goto ret;
	    };
	  DB.DBA.WA_SEND_MAIL (_u_e_mail, mail, 'Join my network', msg);
	  commit work;
	  i := i + 1;
	}
    }

  if (i <> length (uids))
    {
      msg := 'Some of the e-mail addresses entered already have a pending invitation, the mail was not sent to he/she.';
    }
ret:
  return ods_serialize_int_res (rc, msg);
}
;

--!
-- \deprecated Use user.invitation.new() instead.
--/
create procedure ODS.ODS_API."user.invite" (
  in friends_email varchar,
  in custom_message varchar := '') __soap_http 'text/xml'
{
  return ODS.ODS_API."user.invitation.new"(friends_email, custom_message);
}
;

--!
-- \brief Approve an invitation from another user.
--
-- ODS allows users to be connected in a social network. This requires users to send invitations
-- to other users. The other users then need to either approve or reject that invitation.
--
-- This method allow to approve or reject invitations from other users.
--
-- \param invitation_id The id of the invitation as reported by user.invitation.list().
-- \param approve Either \p 1 or \p 0 to \em approve or \em reject the invitation.
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \sa user.invitation.new(), user.invitation.list()
--/
create procedure ODS.ODS_API."user.invitation.approve" (
  in invitation_id int,
  in approve smallint) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare sn_me, sn_from int;
  declare e_mail varchar;
  declare msg varchar;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  whenever not found goto ret;
  msg := 'No pending invitations';
  rc := -1;
  select U_E_MAIL into e_mail from DB.DBA.SYS_USERS where U_NAME = uname;
  select sni_from into sn_from from DB.DBA.sn_invitation where sni_id = invitation_id and sni_to = e_mail;
  sn_me := (select sne_id from DB.DBA.sn_person where sne_name = uname);

  if (approve)
    {
      insert soft DB.DBA.sn_related (snr_from, snr_to, snr_since, snr_serial, snr_source)
	  values (sn_from, sn_me, now (), 0, 1);
      delete from DB.DBA.sn_invitation where sni_id = invitation_id and sni_to = e_mail;
    }
  else
    {
      update DB.DBA.sn_invitation set sni_status = -1 where sni_id = invitation_id and sni_to = e_mail;
    }
  msg := '';
  rc := 1;
ret:
  return ods_serialize_int_res (rc);
}
;

--!
-- \deprecated Use user.invitation.approve() instead.
--/
create procedure ODS.ODS_API."user.invitation" (
  in invitation_id int,
  in approve smallint) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.invitation.approve"(invitation_id, approve);
}
;

--!
-- \brief Get a list of pending invitations.
--
-- ODS allows users to be connected in a social network. This requires users to send invitations
-- to other users. The other users then need to either approve or reject that invitation.
--
-- This method lists the invitations other users sent to the authenticated user.
--
-- \return FIXME
--
-- \sa user.invitation.new(), user.invitation.approve()
--/
create procedure ODS.ODS_API."user.invitation.list" () __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare sn_me, sn_from int;
  declare e_mail varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  -- XXX: add sparql_exec after RDF data update triggers is done
-- FIXME: simply return the values from sn_invitation
ret:
  return ods_serialize_int_res (rc);
}
;

--!
-- \deprecated Use user.invitation.list() instead.
--/
create procedure ODS.ODS_API."user.invitations.get" () __soap_http 'text/xml'
{
  return ODS.ODS_API."user.invitation.list"();
}
;

--!
-- \brief Delete a connection to another user.
--
-- ODS allows users to be connected in a social network. This requires users to send invitations
-- to other users. The other users then need to either approve or reject that invitation.
--
-- This method allows to remove a connection that has been created through an approved invitation.
--
-- \return An error code stating the success of the command execution as detailed in \ref ods_response_format_result_code.
--
-- \sa user.invitation.new(), user.invitation.list()
--/
create procedure ODS.ODS_API."user.relation.delete" (
  in friend varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc, sn_id, f_sn_id int;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();
  sn_id := (select sne_id from DB.DBA.sn_person where sne_name = uname);
  f_sn_id := (select sne_id from DB.DBA.sn_person where sne_name = friend);
  delete from DB.DBA.sn_related where (snr_from = f_sn_id and snr_to = sn_id) or (snr_to = f_sn_id and snr_from = sn_id);
  rc := row_count ();
  return ods_serialize_int_res (rc);
}
;

--!
-- \deprecated Use user.relation.delete() instead.
--/
create procedure ODS.ODS_API."user.relation_terminate" (
  in friend varchar) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.relation.delete"(friend);
}
;

--!
-- \brief Change connection details. FIXME: this does nothing!
--/
create procedure ODS.ODS_API."user.relation_update" (
  in friend varchar,
  in relation_details any) __soap_http 'text/xml'
{
  return;
}
;

-- User Settings

-- Tagging Rules
create procedure ODS.ODS_API."user.tagging_rules.add" (
  in rulelist_name varchar,
  in rules any,
  in is_public integer := 1) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare aps_id, apc_id, id, _u_id, ord int;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  rc := -1;
  rulelist_name := trim (rulelist_name);
  if (length (rulelist_name) = 0)
    signal ('22023', 'The ruleset name cannot be empty');

  rules := json_parse (rules);
  if (not isarray (rules))
    signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

  aps_id := DB.DBA.ANN_GETID ('S');
  apc_id := coalesce ((select top 1 APC_ID from DB.DBA.SYS_ANN_PHRASE_CLASS where APC_OWNER_UID = _u_id), DB.DBA.ANN_GETID ('C'));
  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  declare exit handler for sqlstate '23000'
    {
    signal ('22023', 'The ruleset name is already used, please enter unique rule name');
    };

  insert into DB.DBA.tag_rule_set (trs_name, trs_owner, trs_is_public, trs_apc_id, trs_aps_id)
      values (rulelist_name, _u_id, is_public, apc_id, aps_id);
  id := identity_value ();
  rc := id;
  ord := coalesce ((select top 1 tu_order from DB.DBA.tag_user where tu_u_id = _u_id order by tu_order desc), 0);
  ord := ord + 1;
  insert into DB.DBA.tag_user (tu_u_id, tu_trs, tu_order) values (_u_id, id, ord);
  delete from DB.DBA.tag_rules where rs_trs = id;

  delete from DB.DBA.tag_content_tc_text_query where tt_tag_set = id;
  delete from DB.DBA.SYS_ANN_PHRASE where AP_APS_ID = aps_id;

  insert soft DB.DBA.SYS_ANN_PHRASE_CLASS (APC_ID, APC_NAME, APC_OWNER_UID, APC_READER_GID, APC_CALLBACK, APC_APP_ENV)
    values (apc_id, uname || '''s Tagging Rule Class', _u_id, http_nogroup_gid (), null, null);

  insert soft DB.DBA.SYS_ANN_PHRASE_SET (APS_ID, APS_NAME, APS_OWNER_UID, APS_READER_GID, APS_APC_ID, APS_LANG_NAME, APS_APP_ENV, APS_SIZE, APS_LOAD_AT_BOOT)
    values (aps_id, uname || '''s ' || rulelist_name, _u_id, http_nogroup_gid (), apc_id, 'x-any', null, 10000, 1);

  foreach (any r in rules) do
    {
    if (not isarray (r) or (length (r) <> 3))
      signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

      insert into DB.DBA.tag_rules (rs_trs, rs_query, rs_tag, rs_is_phrase)
	  values (id, r[0], r[1], r[2]);
      if (r[2] = 1)
	{
	  ap_add_phrases (aps_id, vector ( vector (r[0], r[1]) ));
	}
      else
	{
	  DB.DBA.tt_query_tag_content (r[0], _u_id, '', '', serialize (vector (id, r[1], r[2])));
	}
    }

  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.tagging_rules.delete" (
  in rulelist_name varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _aps_id, _apc_id, id, _u_id int;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  rc := -1;
  rulelist_name := trim (rulelist_name);
  if (length (rulelist_name) = 0)
    signal ('22023', 'The ruleset name cannot be empty');

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  select trs_id, trs_apc_id, trs_aps_id
    into id, _apc_id, _aps_id
    from DB.DBA.tag_rule_set
      where trs_owner = _u_id and trs_name = rulelist_name;

  delete from DB.DBA.tag_rules where rs_trs = id;
  delete from DB.DBA.tag_content_tc_text_query where tt_tag_set = id;
  delete from DB.DBA.tag_rule_set where trs_owner = _u_id and trs_name = rulelist_name;
  delete from DB.DBA.SYS_ANN_PHRASE where AP_APS_ID = _aps_id;
  delete from DB.DBA.SYS_ANN_PHRASE_CLASS  where APC_ID = _apc_id and APC_OWNER_UID = _u_id;
  delete from DB.DBA.SYS_ANN_PHRASE_SET where APS_ID = _aps_id and APS_OWNER_UID = _u_id;

  rc := row_count ();
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.tagging_rules.update" (
  in rulelist_name varchar,
  in rules any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare aps_id, apc_id, id, _u_id int;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  rc := -1;
  rulelist_name := trim (rulelist_name);
  if (length (rulelist_name) = 0)
    signal ('22023', 'The ruleset name cannot be empty');

  rules := json_parse (rules);
  if (not isarray (rules))
    signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  select trs_id, trs_apc_id, trs_aps_id
    into id, apc_id, aps_id
    from DB.DBA.tag_rule_set
      where trs_owner = _u_id and trs_name = rulelist_name;

  rc := id;

  delete from DB.DBA.tag_rules where rs_trs = id;
  delete from DB.DBA.tag_content_tc_text_query where tt_tag_set = id;
  delete from DB.DBA.SYS_ANN_PHRASE where AP_APS_ID = aps_id;

  foreach (any r in rules) do
    {
    if (not isarray (r) or (length (r) <> 3))
      signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

      insert into DB.DBA.tag_rules (rs_trs, rs_query, rs_tag, rs_is_phrase)
	  values (id, r[0], r[1], r[2]);
      if (r[2] = 1)
	{
	  ap_add_phrases (aps_id, vector ( vector (r[0], r[1]) ));
	}
      else
	{
	  DB.DBA.tt_query_tag_content (r[0], _u_id, '', '', serialize (vector (id, r[1], r[2])));
	}
    }
ret:
  return ods_serialize_int_res (rc);
}
;

-- Hyperlinking Rules
create procedure ODS.ODS_API."user.hyperlinking_rules.add" (
  in rules any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare aps_id, apc_id, id, _u_id int;
  declare ap_name varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  rules := json_parse (rules);
  if (not isarray (rules))
    signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  ap_name := sprintf ('Hyperlinking-%d', _u_id);
  aps_id := (select APS_ID from DB.DBA.SYS_ANN_PHRASE_SET where APS_OWNER_UID = _u_id and APS_NAME = ap_name);
  if (aps_id is null)
    {
      declare c_id, s_id int;
    c_id := DB.DBA.ANN_GETID ('C');
    s_id := DB.DBA.ANN_GETID ('S');
      DB.DBA.ANN_PHRASE_CLASS_ADD_INT (c_id, ap_name, _u_id, http_nogroup_gid (), null, null);
      DB.DBA.ANN_PHRASE_SET_ADD_INT (s_id, ap_name, _u_id, http_nogroup_gid (), c_id, 'x-any', null, 100000, 1);
      aps_id := s_id;
    }
  foreach (any r in rules) do
    {
    if (not isarray (r) or (length (r) <> 2))
      signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

    ap_add_phrases (aps_id, vector (vector (r[0], r[1])));
    }
  return ods_serialize_int_res (1);
}
;

create procedure ODS.ODS_API."user.hyperlinking_rules.update" (in rules any) __soap_http 'text/xml'
{
  return;
}
;

create procedure ODS.ODS_API."user.hyperlinking_rules.delete" (in rules any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare aps_id, apc_id, id, _u_id int;
  declare ap_name varchar;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  rules := json_parse (rules);
  if (not isarray (rules))
    signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  ap_name := sprintf ('Hyperlinking-%d', _u_id);
  aps_id := (select APS_ID from DB.DBA.SYS_ANN_PHRASE_SET where APS_OWNER_UID = _u_id and APS_NAME = ap_name);
  foreach (any r in rules) do
    {
    if (not isarray (r) or (length (r) <> 2))
      signal ('22023', 'Bad rules parameter - must be valid JSON array of arrays');

    delete from DB.DBA.SYS_ANN_PHRASE where AP_APS_ID = aps_id and AP_TEXT = r[0] and AP_CHKSUM = r[1];
    }
  return ods_serialize_int_res (1);
}
;

create procedure ODS.ODS_API."user.topicOfInterest.new" (
  in topicURI varchar,
  in topicLabel varchar := null) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id, notFound integer;
  declare oldData, newData any;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  notFound := 1;
  topicURI := trim (topicURI);
  topicLabel := coalesce (trim (topicLabel), '');
  newData := '';
  oldData := (select WAUI_INTEREST_TOPICS from DB.DBA.WA_USER_INFO, DB.DBA.SYS_USERS where WAUI_U_ID = U_ID and U_NAME = uname);
  for (select property, label from DB.DBA.WA_USER_INTERESTS (txt) (property varchar, label varchar) P where txt = oldData) do
  {
    if (property = topicURI)
    {
      notFound := 0;
      newData := newData || topicURI || ';' || topicLabel || '\n';
    } else {
      newData := newData || property || ';' || label || '\n';
    }
  }
  if (notFound)
    newData := newData || topicURI || ';' || topicLabel || '\n';
  DB.DBA.WA_USER_EDIT (uname, 'WAUI_INTEREST_TOPICS', newData);
  return ods_serialize_int_res (1);
}
;

create procedure ODS.ODS_API."user.topicOfInterest.delete" (
  in topicURI varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare oldData, newData any;

  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  topicURI := trim (topicURI);
  newData := '';
  oldData := (select WAUI_INTEREST_TOPICS from DB.DBA.WA_USER_INFO, DB.DBA.SYS_USERS where WAUI_U_ID = U_ID and U_NAME = uname);
  for (select property, label from DB.DBA.WA_USER_INTERESTS (txt) (property varchar, label varchar) P where txt = oldData) do
  {
    if (property <> topicURI)
      newData := newData || property || ';' || label || '\n';
  }
  DB.DBA.WA_USER_EDIT (uname, 'WAUI_INTEREST_TOPICS', newData);
  return ods_serialize_int_res (1);
}
;

create procedure ODS.ODS_API."user.thingOfInterest.new" (
  in thingURI varchar,
  in thingLabel varchar := null) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id, notFound integer;
  declare oldData, newData any;
  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  notFound := 1;
  thingURI := trim (thingURI);
  thingLabel := coalesce (trim (thingLabel), '');
  newData := '';
  oldData := (select WAUI_INTERESTS from DB.DBA.WA_USER_INFO, DB.DBA.SYS_USERS where WAUI_U_ID = U_ID and U_NAME = uname);
  for (select property, label from DB.DBA.WA_USER_INTERESTS (txt) (property varchar, label varchar) P where txt = oldData) do
  {
    if (property = thingURI)
    {
      notFound := 0;
      newData := newData || thingURI || ';' || thingLabel || '\n';
    } else {
      newData := newData || property || ';' || label || '\n';
    }
  }
  if (notFound)
    newData := newData || thingURI || ';' || thingLabel || '\n';
  DB.DBA.WA_USER_EDIT (uname, 'WAUI_INTERESTS', newData);
  return ods_serialize_int_res (1);
}
;

create procedure ODS.ODS_API."user.thingOfInterest.delete" (
  in thingURI varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare oldData, newData any;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  thingURI := trim (thingURI);
  newData := '';
  oldData := (select WAUI_INTERESTS from DB.DBA.WA_USER_INFO, DB.DBA.SYS_USERS where WAUI_U_ID = U_ID and U_NAME = uname);
  for (select property, label from DB.DBA.WA_USER_INTERESTS (txt) (property varchar, label varchar) P where txt = oldData) do
  {
    if (property <> thingURI)
      newData := newData || property || ';' || label || '\n';
  }
  DB.DBA.WA_USER_EDIT (uname, 'WAUI_INTERESTS', newData);
  return ods_serialize_int_res (1);
}
;

create procedure ODS.ODS_API."user.annotation.new" (
  in claimIri varchar,
  in claimRelation varchar,
  in claimValue varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  if (exists (select 1 from DB.DBA.WA_USER_RELATED_RES where WUR_U_ID = _u_id and WUR_SEEALSO_IRI = claimIri))
    return ods_serialize_sql_error ('37000', 'The item already exists');
  insert into DB.DBA.WA_USER_RELATED_RES (WUR_U_ID, WUR_LABEL, WUR_SEEALSO_IRI, WUR_P_IRI)
    values (_u_id, claimValue, claimIri, claimRelation);
  rc := (select max (WUR_ID) from DB.DBA.WA_USER_RELATED_RES);
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.annotation.delete" (
  in claimIri varchar,
  in claimRelation varchar,
  in claimValue varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  delete
    from DB.DBA.WA_USER_RELATED_RES
   where WUR_U_ID = _u_id
     and WUR_LABEL = claimValue
     and WUR_SEEALSO_IRI = claimIri
     and WUR_P_IRI = claimRelation;

  rc := row_count ();
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.onlineAccounts.uri" (
  in url varchar) __soap_http 'text/plain'
{
  declare rc varchar;

  rc := null;
  if (__proc_exists ('DB.DBA.RDF_PROXY_ENTITY_IRI'))
    rc := DB.DBA.RDF_PROXY_ENTITY_IRI(url);
  if (isnull (rc))
    rc := url || '#this';

  return rc;
}
;

create procedure ODS.ODS_API."user.onlineAccounts.list" (
  in "type" varchar) __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  retValue := vector();
  for (select WUO_ID, WUO_NAME, WUO_URL, WUO_URI from DB.DBA.WA_USER_OL_ACCOUNTS where WUO_TYPE = "type" and WUO_U_ID = _u_id) do
  {
    retValue := vector_concat (retValue, vector (vector (WUO_ID, WUO_NAME, WUO_URL, WUO_URI)));
  }

  -- include OpenID. FIXME: OpenIDs should also be stored in the same table
  for (select WAUI_OPENID_URL from DB.DBA.WA_USER_INFO where WAUI_U_ID = _u_id and not WAUI_OPENID_URL is null) do
  {
    retValue := vector_concat (retValue, vector (vector (-1, 'openid', WAUI_OPENID_URL, '')));
  }

  return obj2json (retValue);
}
;

--!
-- \brief Add a new online account to an ODS account.
--
-- An ODS user profile can contain an arbitrary number of online accounts from any service
-- available. Only two main things are required: the name of the service and the service identifier.
--
-- For many services adding an online account will result in the user being able to log into their
-- ODS account through that service (See user.authenticate.authenticationUrl(), user.authenticate.browserid(),
-- and user.authenticate.webid()). In order for this connection to work properly the online accounts need to
-- be added in a special form (be aware that the \p connect action in the mentioned authentication methods
-- allow to add online accounts automatically).
--
-- The following list gives an overview of the supported services (See also \ref ods_authentication_url_services)
-- and the identifiers used in ODS:
--
-- Service Type   | Identifier used         | Example
-- ---------------|-------------------------|--------
-- \p facebook    | The profile URL         | http://www.facebook.com/sebastian.trug
-- \p twitter     | The profile URL         | http://twitter.com/tmptrueg
-- \p linkedin    | The profile URL         | http://www.linkedin.com/in/trueg
-- \p windowslive | The profile URL         | http://profile.live.com/cid-7a6b1666d21a866b/
-- \p google      | The login email address |
-- \p wordpress   | The username            | trueg
-- \p disqus      | The profile URL         | http://disqus.com/strueg/
-- \p instagram   | The username            |
-- \p yahoo       | The profile URL         | http://profile.yahoo.com/S4KF6WXGWUBRV74G4TD6GOPCAE
-- \p tumblr      | The username            |
-- \p bitly       | The profile URL         | http://bitly.com/u/webods
-- \p browserid   | The email address       |
-- \p webid       | The personal URI        | http://web.ods.openlinksw.com/dataspace/person/trueg#this
-- \p openid      | The OpenID URL          |
--
-- \param name The name of the online account service provider (Examples: \p facebook, \p disqus, \p browserid)
-- \param url The service account identifier or username.
-- \param uri An optional named graph to publish the information to (typically this can be left out since ODS
-- will handle that automatically).
-- \param type The type of the account, ie. is it a private account (\p P) or a business account (\p B).
--
-- \return An error code as defined in \ref ods_response_format_result_code.
--/
create procedure ODS.ODS_API."user.onlineAccounts.new" (
  in name varchar,
  in url varchar,
  in uri varchar := null,
  in "type" varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  rc := (select WUO_ID from DB.DBA.WA_USER_OL_ACCOUNTS where WUO_U_ID = _u_id and WUO_TYPE = "type" and WUO_NAME = name and WUO_URL = url);
  if (isnull (rc))
  {
    insert into DB.DBA.WA_USER_OL_ACCOUNTS (WUO_U_ID, WUO_TYPE, WUO_NAME, WUO_URL, WUO_URI)
      values (_u_id, "type", name, url, uri);
  rc := (select max (WUO_ID) from DB.DBA.WA_USER_OL_ACCOUNTS);
  }
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.onlineAccounts.delete" (
  in id integer := null,
  in name varchar := null,
  in url varchar := null,
  in uri varchar := null,
  in "type" varchar := null) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  if (isnull (id))
  {
    if (name = 'openid')
      update DB.DBA.WA_USER_INFO set WAUI_OPENID_URL=null, WAUI_OPENID_SERVER=null where WAUI_U_ID=_u_id;
    else
    delete
      from DB.DBA.WA_USER_OL_ACCOUNTS
     where WUO_U_ID = _u_id
       and WUO_TYPE = "type"
       and (name is null or WUO_NAME = name)
       and (url  is null or WUO_URL = url)
       and (uri  is null or WUO_URI = uri);
  } else {
    if (id = -1)
      update DB.DBA.WA_USER_INFO set WAUI_OPENID_URL=null, WAUI_OPENID_SERVER=null where WAUI_U_ID=_u_id;
    else
    delete
      from DB.DBA.WA_USER_OL_ACCOUNTS
     where WUO_U_ID = _u_id
       and WUO_ID   = id;
  }
  rc := row_count ();
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.bioEvents.list" () __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  retValue := vector();
  for (select * from DB.DBA.WA_USER_BIOEVENTS where WUB_U_ID = _u_id) do
  {
    retValue := vector_concat (retValue, vector (vector (WUB_ID, WUB_EVENT, WUB_DATE, WUB_PLACE)));
  }
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.bioEvents.new" (
  in event varchar,
  in "date" varchar := null,
  in place varchar := null) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  insert into DB.DBA.WA_USER_BIOEVENTS (WUB_U_ID, WUB_EVENT, WUB_DATE, WUB_PLACE)
    values (_u_id, event, "date", place);
  rc := (select max (WUB_ID) from DB.DBA.WA_USER_BIOEVENTS);
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.bioEvents.delete" (
  in id varchar := null,
  in event varchar := null,
  in "date" varchar := null,
  in place varchar := null) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  if (isnull (id))
  {
    delete
      from DB.DBA.WA_USER_BIOEVENTS
     where WUB_U_ID = _u_id
       and (event  is null or WUB_EVENT = event)
       and ("date" is null or WUB_DATE  = "date")
       and (place  is null or WUB_PLACE = place);
  } else {
    delete
      from DB.DBA.WA_USER_BIOEVENTS
     where WUB_U_ID = _u_id
       and WUB_ID   = id;
  }
  rc := row_count ();
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.favorites.list" () __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  retValue := vector();
  for (select WUF_ID, WUF_TYPE, WUF_CLASS, WUF_LABEL, WUF_URI from DB.DBA.WA_USER_FAVORITES where WUF_U_ID = _u_id) do
  {
    retValue := vector_concat (retValue, vector (vector (WUF_ID, WUF_TYPE, WUF_CLASS, WUF_LABEL, WUF_URI)));
  }
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.favorites.get" (
  in id integer) __soap_http 'application/json'
{
  declare uname varchar;
  declare retValue any;
  declare _u_id integer;
  declare flag, label, uri, properties any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  flag := '1';
  label := '';
  uri := '';
  properties := vector();
  for (select WUF_ID, WUF_FLAG, WUF_LABEL, WUF_URI, WUF_PROPERTIES from DB.DBA.WA_USER_FAVORITES where WUF_ID = id and WUF_U_ID = _u_id) do
  {
    flag := WUF_FLAG;
    label := WUF_LABEL;
    uri := WUF_URI;
    properties := deserialize (WUF_PROPERTIES);
  }
  properties := vector (
                        vector_concat (
                                       ODS..jsonObject (),
                                       vector (
                                               'id', '0',
                                               'ontology', 'http://rdfs.org/sioc/ns#',
                                               'items', vector (
                                                                vector_concat (
                                                                               ODS..jsonObject (),
                                                                               vector (
                                                                                       'id', '0',
                                                                                       'className', 'sioc:Item',
                                                                                       'properties', properties
                                                                                      )
                                                                              )
                                                                )
                                              )
                                      )
                       );
  retValue := vector_concat (jsonObject (), vector ('id', id, 'flag', flag, 'label', label, 'uri', uri, 'properties', properties));
  return obj2json (retValue);
    }
;

create procedure ODS.ODS_API."user.favorites.update" (
  in id integer,
  in flag varchar := '1',
  in label varchar,
  in uri varchar,
  in properties varchar)
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  properties := json_parse (properties);
  if (isnull (id))
  {
    insert into DB.DBA.WA_USER_FAVORITES (WUF_U_ID, WUF_FLAG, WUF_TYPE, WUF_CLASS, WUF_LABEL, WUF_URI, WUF_PROPERTIES)
      values (_u_id, flag, 'http://rdfs.org/sioc/ns#', 'sioc:Item', label, uri, serialize (properties));
    rc := (select max (WUF_ID) from DB.DBA.WA_USER_FAVORITES);
  } else {
    update DB.DBA.WA_USER_FAVORITES
       set WUF_FLAG = flag,
           WUF_LABEL = label,
           WUF_URI = uri,
           WUF_PROPERTIES = serialize (properties)
     where WUF_ID = id;
    rc := id;
  }
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.favorites.new" (
  in flag varchar := '1',
  in label varchar,
  in uri varchar,
  in properties varchar) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.favorites.update" (null, flag, label, uri, properties);
}
;

create procedure ODS.ODS_API."user.favorites.edit" (
  in id integer,
  in flag varchar := '1',
  in label varchar,
  in uri varchar,
  in properties varchar) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.favorites.update" (id, flag, label, uri, properties);
}
;

create procedure ODS.ODS_API."user.favorites.delete" (
  in id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
    delete
      from DB.DBA.WA_USER_FAVORITES
     where WUF_U_ID = _u_id
       and WUF_ID   = id;

  rc := row_count ();
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.mades.list" () __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  retValue := vector();
  for (select WUP_ID, WUP_NAME, WUP_URL, WUP_DESC from DB.DBA.WA_USER_PROJECTS where WUP_U_ID = _u_id) do
  {
    retValue := vector_concat (retValue, vector (vector (WUP_ID, WUP_NAME, WUP_URL, WUP_DESC)));
  }
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.mades.get" (
  in id integer) __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare property, url, description, retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  property := '';
  url := '';
  description := '';
  for (select WUP_ID, WUP_NAME, WUP_URL, WUP_DESC from DB.DBA.WA_USER_PROJECTS where WUP_ID = id) do
  {
    property := WUP_NAME;
    url := WUP_URL;
    description := WUP_DESC;
  }
  retValue := vector_concat (jsonObject (), vector ('id', id, 'property', property, 'url', url, 'description', description));
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.mades.update" (
  in id integer,
  in property varchar,
  in url varchar,
  in description varchar)
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare tmp, name, iri varchar;
  declare stat, msg, dta, mdta, qrs any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  name := property;
  iri := url;
  tmp := uuid ();
  {
    declare exit handler for sqlstate '*'
    {
      SPARQL clear graph ?:tmp;
      goto _next;
    };
    qrs := vector (0,0,0);
    exec (sprintf ('sparql load "%s" into graph <%s>', url, tmp));

    qrs[0] := sprintf ('sparql
                        prefix doap: <http://usefulinc.com/ns/doap#>
                        select ?P ?N ?D
                          from <%s>
                         where { ?P a doap:Project ; doap:name ?N ; doap:description ?D . }', tmp);
    qrs[1] := sprintf ('sparql
                        prefix foaf: <http://xmlns.com/foaf/0.1/>
                        select ?P ?N ?D
                          from <%s>
                         where { ?P a foaf:Organization ; foaf:name ?N . optional { ?P foaf:dummy ?D . } }', tmp);
    qrs[2] := sprintf ('sparql
                        prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
                        prefix dc: <http://purl.org/dc/elements/1.1/>
                   			prefix foaf: <http://xmlns.com/foaf/0.1/>
                    		select ?P ?N ?D ?TI
                    		  from <%s>
                    		 where { ?P a ?TP .
             			     	        optional { ?P foaf:name ?N } .
                         				optional { ?P rdfs:label ?D . } .
                         				optional { ?P dc:title ?TI }
                         				filter ( ?P = <%s> )
                         			 }', tmp, url);
    foreach (any qr in qrs) do
    {
      exec (qr, stat, msg, vector (), 0, mdta, dta);
      if (length (dta) and length (dta[0]) > 3)
	    {
    	  iri := url;
    	  name := coalesce (dta[0][1], dta[0][2], dta[0][3]);
    	  description := coalesce (name, description);
    	  goto _found;
    	}
      else if (length (dta) and length (dta[0]) > 2)
    	{
    	  iri := dta[0][0];
    	  name := dta[0][1];
    	  description := coalesce (dta[0][2], description);
    	  goto _found;
    	}
    }
  _found:
    SPARQL clear graph ?:tmp;
  }
_next:;

  if (length (property))
    name := property;
  if (not length (name))
    signal ('23023', 'The title of item made is not specified nor can be retrieved from source URI, please specify.');
  if (not length (description))
    signal ('23023', 'The description of item made is not specified nor can be retrieved from source URI, please specify.');

  if (isnull (id))
  {
    insert into DB.DBA.WA_USER_PROJECTS (WUP_U_ID, WUP_NAME, WUP_URL, WUP_DESC, WUP_IRI)
      values (_u_id, name, url, description, iri);
    } else {
    update DB.DBA.WA_USER_PROJECTS
       set WUP_NAME = name,
           WUP_URL = url,
           WUP_DESC = description,
           WUP_IRI = iri
     where WUP_ID = id;
    }
  rc := row_count ();

  return ods_serialize_int_res (rc);
  }
;

create procedure ODS.ODS_API."user.mades.new" (
  in property varchar,
  in url varchar,
  in description varchar) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.mades.update" (null, property, url, description);
}
;

create procedure ODS.ODS_API."user.mades.edit" (
  in id integer,
  in property varchar,
  in url varchar,
  in description varchar) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.mades.update" (id, property, url, description);
}
;

create procedure ODS.ODS_API."user.mades.delete" (
  in id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  delete from DB.DBA.WA_USER_PROJECTS where WUP_ID = id and WUP_U_ID = _u_id;
  rc := row_count ();

  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.products.fix" (
  in products any,
  in ontologyURI varchar := 'http://purl.org/goodrelations/v1#')
{
  if (get_keyword ('version', products) = '2.0')
  {
    products := get_keyword ('ontologies', products, vector ());
  }
  else
  {
    products := vector (vector_concat (ODS..jsonObject (), vector ('id', '0', 'ontology', ontologyURI, 'items', get_keyword ('products', products, vector ()))));
  }
  return products;
}
;

create procedure ODS.ODS_API."user.offers.list" (
  in type varchar := '1') __soap_http 'application/json'
  {
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  retValue := vector();
  for (select WUOL_ID, WUOL_OFFER, WUOL_COMMENT, WUOL_PROPERTIES from DB.DBA.WA_USER_OFFERLIST where WUOL_U_ID = _u_id and WUOL_TYPE = type) do
  {
    retValue := vector_concat (retValue, vector (vector (WUOL_ID, WUOL_OFFER, WUOL_COMMENT)));
  }
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.offers.get" (
  in id integer) __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare flag, name, comment, products, retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  flag := '1';
  name := '';
  comment := '';
  products := vector ();
  for (select WUOL_ID, WUOL_FLAG, WUOL_OFFER, WUOL_COMMENT, WUOL_PROPERTIES from DB.DBA.WA_USER_OFFERLIST where WUOL_ID = id) do
  {
    flag := WUOL_FLAG;
    name := WUOL_OFFER;
    comment := WUOL_COMMENT;
    products := deserialize (WUOL_PROPERTIES);
  }
  retValue := vector_concat (jsonObject (),
                             vector (
                                     'id', id,
                                     'flag', flag,
                                     'name', name,
                                     'comment', comment,
                                     'properties', ODS.ODS_API."user.products.fix" (products)
                                    )
                            );
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.offers.update" (
  in id integer,
  in type varchar := '1',
  in flag varchar := '1',
  in name varchar,
  in comment varchar,
  in properties any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare _u_id integer;
  declare products, ontologies any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  ontologies := json_parse (properties);
  products := vector_concat (ODS..jsonObject (), vector ('version', '2.0', 'ontologies', ontologies));
  if (isnull (id))
  {
    insert into DB.DBA.WA_USER_OFFERLIST (WUOL_U_ID, WUOL_TYPE, WUOL_FLAG, WUOL_OFFER, WUOL_COMMENT, WUOL_PROPERTIES)
      values (_u_id, type, flag, name, comment, serialize (products));
    id := (select max (WUOL_ID) from DB.DBA.WA_USER_OFFERLIST);
  }
  else
  {
    update DB.DBA.WA_USER_OFFERLIST
       set WUOL_FLAG = flag,
           WUOL_OFFER = name,
           WUOL_COMMENT = comment,
           WUOL_PROPERTIES = serialize (products)
     where WUOL_ID = id;
  }
  return ods_serialize_int_res (id);
}
;

create procedure ODS.ODS_API."user.offers.new" (
  in type varchar := '1',
  in flag varchar := '1',
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.offers.update" (null, type, flag, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.offers.edit" (
  in id integer,
  in type varchar := '1',
  in flag varchar := '1',
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.offers.update" (id, type, flag, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.offers.delete" (
  in id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  delete from DB.DBA.WA_USER_OFFERLIST where WUOL_ID = id and WUOL_U_ID = _u_id;
  rc := row_count ();

  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.seeks.list" () __soap_http 'application/json'
{
  return ODS.ODS_API."user.offers.list"('2');
}
;

create procedure ODS.ODS_API."user.seeks.get" (
  in id integer) __soap_http 'application/json'
{
  return ODS.ODS_API."user.offers.get"(id);
}
;

create procedure ODS.ODS_API."user.seeks.new" (
  in type varchar := '2',
  in flag varchar := '1',
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.offers.update" (null, type, flag, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.seeks.edit" (
  in id integer,
  in type varchar := '2',
  in flag varchar := '1',
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.offers.update" (id, type, flag, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.seeks.delete" (
  in id integer) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.offers.update" (id);
}
;

create procedure ODS.ODS_API."user.owns.list" (
  in type varchar := '3') __soap_http 'application/json'
{
  return ODS.ODS_API."user.offers.list"(type);
}
;

create procedure ODS.ODS_API."user.owns.get" (
  in id integer) __soap_http 'application/json'
{
  return ODS.ODS_API."user.offers.get"(id);
}
;

create procedure ODS.ODS_API."user.owns.new" (
  in type varchar := '3',
  in flag varchar := '1',
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.offers.update" (null, type, flag, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.owns.edit" (
  in id integer,
  in type varchar := '3',
  in flag varchar := '1',
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
 return ODS.ODS_API."user.offers.update" (id, type, flag, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.owns.delete" (
  in id integer) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.offers.update" (id);
}
;

create procedure ODS.ODS_API."user.likes.list" () __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  retValue := vector();
  for (select WUL_ID, WUL_URI, WUL_TYPE, WUL_NAME, WUL_COMMENT, WUL_PROPERTIES from DB.DBA.WA_USER_LIKES where WUL_U_ID = _u_id) do
  {
    retValue := vector_concat (retValue, vector (vector (WUL_ID, WUL_URI, case when (WUL_TYPE = 'L') then 'Like' else 'DisLike' end, WUL_NAME, WUL_COMMENT)));
  }
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.likes.get" (
  in id integer) __soap_http 'application/json'
  {
  declare uname varchar;
  declare _u_id integer;
  declare flag, uri, type, name, comment, products, retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  flag := '';
  uri := '';
  type := '';
  name := '';
  comment := '';
  products := vector ();
  for (select WUL_ID, WUL_FLAG, WUL_URI, WUL_TYPE, WUL_NAME, WUL_COMMENT, WUL_PROPERTIES from DB.DBA.WA_USER_LIKES where WUL_ID = id) do
    {
    flag := WUL_FLAG;
    uri := WUL_URI;
    type := WUL_TYPE;
    name := WUL_NAME;
    comment := WUL_COMMENT;
    products := deserialize (WUL_PROPERTIES);
    }
  retValue := vector_concat (jsonObject (),
                             vector (
                                     'id', id,
                                     'flag', flag,
                                     'uri', uri,
                                     'type', type,
                                     'name', name,
                                     'comment', comment,
                                     'properties', ODS.ODS_API."user.products.fix" (products, 'http://ontologi.es/like#')
                                    )
                            );
  return obj2json (retValue);
  }
;

create procedure ODS.ODS_API."user.likes.update" (
  in id integer,
  in flag varchar := '1',
  in uri varchar,
  in type varchar,
  in name varchar,
  in comment varchar,
  in properties any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare _u_id integer;
  declare products, ontologies any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  ontologies := json_parse (properties);
  products := vector_concat (ODS..jsonObject (), vector ('version', '2.0', 'ontologies', ontologies));
  if (isnull (id))
  {
    insert into DB.DBA.WA_USER_LIKES (WUL_U_ID, WUL_FLAG, WUL_URI, WUL_TYPE, WUL_NAME, WUL_COMMENT, WUL_PROPERTIES)
      values (_u_id, flag, uri, type, name, comment, serialize (products));
    id := (select max (WUL_ID) from DB.DBA.WA_USER_LIKES);
  }
  else
  {
    update DB.DBA.WA_USER_LIKES
       set WUL_FLAG = flag,
           WUL_URI = uri,
           WUL_TYPE = type,
           WUL_NAME = name,
           WUL_COMMENT = comment,
           WUL_PROPERTIES = serialize (products)
     where WUL_ID = id;
  }
  return ods_serialize_int_res (id);
}
;

create procedure ODS.ODS_API."user.likes.new" (
  in flag varchar := '1',
  in uri varchar,
  in type varchar,
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.likes.update" (null, flag, uri, type, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.likes.edit" (
  in id integer,
  in flag varchar := '1',
  in uri varchar,
  in type varchar,
  in name varchar,
  in comment varchar,
  in properties any := null) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.likes.update" (id, flag, uri, type, name, comment, properties);
}
;

create procedure ODS.ODS_API."user.likes.delete" (
  in id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  delete from DB.DBA.WA_USER_LIKES where WUL_ID = id and WUL_U_ID = _u_id;
  rc := row_count ();

  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."user.knows.list" () __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  retValue := vector();
  for (select WUK_ID, WUK_URI, WUK_LABEL from DB.DBA.WA_USER_KNOWS where WUK_U_ID = _u_id) do
  {
    retValue := vector_concat (retValue, vector (vector (WUK_ID, WUK_URI, WUK_LABEL)));
  }
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.knows.get" (
  in id integer) __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare flag, uri, label, retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  flag := '';
  uri := '';
  label := '';
  for (select WUK_ID, WUK_FLAG, WUK_URI, WUK_LABEL from DB.DBA.WA_USER_KNOWS where WUK_ID = id) do
  {
    flag := WUK_FLAG;
    uri := WUK_URI;
    label := WUK_LABEL;
  }
  retValue := vector_concat (jsonObject (),
                             vector (
                                     'id', id,
                                     'flag', flag,
                                     'uri', uri,
                                     'label', label
                                    )
                            );
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.knows.update" (
  in id integer,
  in flag varchar := '1',
  in uri varchar,
  in label varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare _u_id integer;
  declare products, ontologies any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  if (isnull (id))
  {
    if (not exists (select 1 from DB.DBA.WA_USER_KNOWS where WUK_U_ID = _u_id and WUK_URI = uri))
    {
      insert into DB.DBA.WA_USER_KNOWS (WUK_U_ID, WUK_FLAG, WUK_URI, WUK_LABEL)
        values (_u_id, flag, uri, label);
      id := (select max (WUK_ID) from DB.DBA.WA_USER_KNOWS);
    } else {
      id := 0;
    }
  }
  else
  {
    update DB.DBA.WA_USER_KNOWS
       set WUK_FLAG = flag,
           WUK_URI = uri,
           WUK_LABEL = label
     where WUK_ID = id;
  }
  return ods_serialize_int_res (id);
}
;

create procedure ODS.ODS_API."user.knows.new" (
  in flag varchar := '1',
  in uri varchar,
  in label varchar) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.knows.update" (null, flag, uri, label);
}
;

create procedure ODS.ODS_API."user.knows.edit" (
  in id integer,
  in flag varchar := '1',
  in uri varchar,
  in label varchar) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.knows.update" (id, flag, uri, label);
}
;

create procedure ODS.ODS_API."user.knows.delete" (
  in id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  delete from DB.DBA.WA_USER_KNOWS where WUK_ID = id and WUK_U_ID = _u_id;
  rc := row_count ();

  return ods_serialize_int_res (rc);
}
;

--!
-- \brief List all X.509 certificates accociated with an account.
--
-- An ODS account can contain an arbitrary number of certificates which can either be
-- imported via user.certificates.new() or be created via user.certificates.create().
-- This method lists all certificates in the profile.
--
-- \return A JSON list of all X.509 certificates accociated with the account. For historical
-- reasons all information is provided twice: once in a plain list and once in a clean JSON map.
--
-- \b Example:
--
-- \verbatim
-- [
--   [
--     1,
--     "/CN=Sebastian Trueg (local ODS instance)/emailAddress=trueg@openlinksw.com",
--     "1 week(s) ago",
--     "67:1C:7A:E3:D2:2D:85:C9:E4:AF:BB:D7:F1:EA:53:3B",
--     "Yes",
--     {
--       "id": 1,
--       "fingerprint": "67:1C:7A:E3:D2:2D:85:C9:E4:AF:BB:D7:F1:EA:53:3B",
--       "timestamp": "2012-10-15 20:31:36",
--       "fuzzyTimestamp": "1 week(s) ago",
--       "subject":
--       {
--         "CN": "Sebastian Trueg (local ODS instance)",
--         "emailAddress": "trueg@openlinksw.com"
--       }
--     }
--   ]
-- ]
-- \endverbatim
--/
create procedure ODS.ODS_API."user.certificates.list" () __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare isFirst int;
  declare certVec any;
  declare subject varchar;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  isFirst := 1;
  http('[');
  for (select UC_ID, UC_CERT, UC_TS, UC_FINGERPRINT, UC_LOGIN, UC_FINGERPRINT from DB.DBA.WA_USER_CERTS where UC_U_ID = _u_id order by UC_TS desc) do
  {
    if(isFirst)
      isFirst := 0;
    else
      http(',');

    subject := get_certificate_info (2, cast (UC_CERT as varchar), 0, '');

    -- old-style plain list without any context
    certVec := vector (UC_ID, subject, DB.DBA.wa_abs_date (UC_TS), UC_FINGERPRINT, case when UC_LOGIN = 1 then 'Yes' else 'No' end);

    -- Add a new-style JSON blob at the end of the vector
    subject := split_and_decode(ltrim(subject, '/'), 0, '\0\0/=');

    -- Start the old-style list but open it at the end
    http (rtrim (obj2json (certVec), ']') || ',');

    -- Add our new JSON object
    http(params2Json (
            vector('id', UC_ID,
                   'fingerprint', UC_FINGERPRINT,
                   'timestamp', cast (UC_TS as varchar),
                   'fuzzyTimestamp', DB.DBA.wa_abs_date (UC_TS),
                   'subject', array2Obj(subject))));

    -- Close the list
    http(']');
  }

  http(']');
  return '';
}
;

create procedure ODS.ODS_API."user.instances.list" () __soap_http 'text/xml'
{
  declare uname varchar;
  declare _u_id integer;
  declare retValue any;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();
  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  retValue := (select 
  	xmlelement ('result', 
	  	xmlagg (
		  	xmlelement ('instance', 
			xmlelement ('id', WAI_ID), 
			xmlelement ('name', WAI_NAME), 
			xmlelement ('type', DB.DBA.wa_type_to_app (WAI_TYPE_NAME)), 
			xmlelement ('member_type', WAM_MEMBER_TYPE)))) 
	from DB.DBA.WA_MEMBER, DB.DBA.WA_INSTANCE where WAM_INST = WAI_NAME and WAM_USER = _u_id);
  return serialize_to_UTF8_xml (retValue);
}
;

create procedure ODS.ODS_API."user.certificates.get" (
  in id integer) __soap_http 'application/json'
{
  declare uname varchar;
  declare _u_id integer;
  declare subject, agentID, fingerPrint, certificate, enableLogin, retValue any;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  subject := '';
  agentID := '';
  fingerPrint := '';
  certificate := '';
  enableLogin := 0;
  for (select UC_ID, UC_CERT, UC_LOGIN, UC_FINGERPRINT from DB.DBA.WA_USER_CERTS where UC_ID = id and UC_U_ID = _u_id) do
  {
    subject := get_certificate_info (2, UC_CERT, 0, '');
    agentID := DB.DBA.FOAF_SSL_WEBID_GET (UC_CERT);
    fingerPrint := get_certificate_info (6, UC_CERT, 0, '');
    certificate := UC_CERT;
    enableLogin := UC_LOGIN;
  }
  retValue := vector_concat (jsonObject (),
                             vector (
                                     'id', id,
                                     'subject', subject,
                                     'agentID', agentID,
                                     'fingerPrint', fingerPrint,
                                     'certificate', certificate,
                                     'enableLogin', enableLogin
                                    )
                            );
  return obj2json (retValue);
}
;

create procedure ODS.ODS_API."user.certificates.update" (
  in id integer,
  in certificate varchar,
  in enableLogin integer)
{
  declare uname, agent varchar;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  agent := DB.DBA.FOAF_SSL_WEBID_GET (certificate);
  if ((agent is null and length (certificate)) or (0 = length (certificate)))
	  signal ('', 'The certificate must be in PEM format and must have Alternate Name attribute.');

	if (id is null)
  {
    insert into DB.DBA.WA_USER_CERTS (UC_U_ID, UC_CERT, UC_FINGERPRINT, UC_LOGIN)
      values (_u_id, certificate, get_certificate_info (6, certificate, 0, ''), enableLogin);
    id := (select max (UC_ID) from DB.DBA.WA_USER_CERTS);
	}
	else
	{
	  update DB.DBA.WA_USER_CERTS
	     set UC_CERT = certificate,
			     UC_FINGERPRINT = get_certificate_info (6, certificate, 0, ''),
				   UC_LOGIN = enableLogin
		 where UC_U_ID = _u_id
		   and UC_ID = id;
  }
  return ods_serialize_int_res (id);
}
;

create procedure ODS.ODS_API."user.certificates.new" (
  in certificate varchar,
  in enableLogin integer) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.certificates.update" (null, certificate, enableLogin);
}
;

create procedure ODS.ODS_API."user.certificates.edit" (
  in id integer,
  in certificate varchar,
  in enableLogin integer) __soap_http 'text/xml'
{
  return ODS.ODS_API."user.certificates.update" (id, certificate, enableLogin);
}
;

create procedure ODS.ODS_API."user.certificates.delete" (
  in id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare _u_id integer;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  _u_id := (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);

  delete from DB.DBA.WA_USER_CERTS where UC_ID = id and UC_U_ID = _u_id;
  rc := row_count ();

  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API.appendPropertyTitle (
  in title varchar)
{
  declare M integer;
  declare V any;

  V := vector ('Mr', 'Mrs', 'Dr', 'Ms', 'Sir');
  for (M := 0; M < length (V); M := M + 1)
  {
    if (lcase (title) like (lcase (V[M])|| '%'))
      return V[M];
  }
  return '';
}
;

create procedure ODS.ODS_API.appendProperty (
  inout V any,
  in propertyName varchar,
  in propertyValue any,
  in propertyNS varchar := '')
{
  if (not DB.DBA.is_empty_or_null (propertyValue) and isstring (propertyValue) and propertyValue not like 'nodeID:%' and isnull (get_keyword (propertyName, V)))
  {
    if (propertyNS <> '')
    {
      if (propertyValue like propertyNS || '%')
        propertyValue := substring (propertyValue, length (propertyNS) + 1, length (propertyValue));
    }
    if (propertyValue like 'mailto:%')
    {
      propertyValue := replace (propertyValue, 'mailto:', '');
    }
    else if (propertyValue like 'tel:%')
    {
      propertyValue := replace (propertyValue, 'tel:', '');
    }
    else if (propertyName = 'title')
    {
      propertyValue := appendPropertyTitle (propertyValue);
    }
    V := vector_concat (V, vector (propertyName, propertyValue));
  }
  return V;
}
;

create procedure ODS.ODS_API.appendPropertyArray (
  inout V any,
  inout N integer,
  in propertyName varchar,
  in propertyValue any,
  in meta any,
  in data any)
{
  declare M integer;
  declare property varchar;
  declare newPropertyArray, propertyArray any;

  property := replace (propertyName, '_array', '');
  N := N + 1;
  if (not DB.DBA.is_empty_or_null (propertyValue) and isstring (propertyValue) and (propertyValue not like 'nodeID:%'))
  {
    newPropertyArray := vector_concat (jsonObject(), vector ('value', propertyValue));

    propertyArray := get_keyword (property, V);
    if (isnull (propertyArray))
      propertyArray := vector ();

    for (M := 0; M < length (propertyArray); M := M + 1)
    {
      if (get_keyword ('value', propertyArray[M]) = propertyValue)
        goto _exit;
    }

    while ((N < length(meta)) and (meta[N] like property || '_%'))
    {
      if (not DB.DBA.is_empty_or_null (data[N]) and isstring (data[N]) and (data[N] not like 'nodeID:%'))
        newPropertyArray := vector_concat (newPropertyArray, vector (replace (meta[N], property||'_', ''), data[N]));

      N := N + 1;
    }

    propertyArray := vector_concat (propertyArray, vector (newPropertyArray));
    ODS.ODS_API.set_keyword (property, V, propertyArray);
  }
  else
  {
  _exit:;
    while ((N < length(meta)) and (meta[N] like property || '_%'))
      N := N + 1;
  }

  N := N - 1;
  return V;
}
;

grant execute on DB.DBA.RDF_GRAB to SPARQL_SELECT;
grant execute on DB.DBA.RDF_GRAB_SINGLE_ASYNC to SPARQL_SELECT;

create procedure ODS.ODS_API.vector_contains(
  inout aVector any,
  in aValue any)
{
  declare N, M, L integer;

  for (N := 0; N < length(aVector); N := N + 1)
  {
    if (isarray (aValue) and not isstring (aValue))
    {
      if (isarray (aVector[N]) and not isstring (aVector[N]))
      {
        if (length (aValue) = length (aVector[N]))
        {
          L := case when (isJsonObject (aValue) and isJsonObject (aVector[N])) then 2 else 0 end;
          for (M := L; M < length(aValue); M := M + 1)
          {
            if (aValue[M] <> aVector[N][M])
              goto _skip;
          }
          return 1;
        }
      }
    _skip:;
    } else {
    if (aValue = aVector[N])
      return 1;
    }
  }
  return 0;
}
;

create procedure ODS.ODS_API.simplifyMeta (
  in abMeta any)
{
  declare N integer;
  declare newMeta any;

  newMeta := vector ();
  for (N := 0; N < length (abMeta[0]); N := N + 1)
    newMeta := vector_concat (newMeta, vector (abMeta[0][N][0]));

  return newMeta;
}
;

create procedure ODS.ODS_API.set_keyword (
  in    name   varchar,
  inout params any,
  in    value  any)
{
  declare N integer;

  for (N := 0; N < length(params); N := N + 2)
  {
    if (params[N] = name)
    {
      params[N+1] := value;
      goto _end;
    }
  }
  params := vector_concat (params, vector(name, value));
_end:
  return params;
}
;

create procedure ODS.ODS_API.graph_create ()
{
  return 'http://local.virt/ods/' || cast (rnd (1000) as varchar);
}
;

create procedure ODS.ODS_API.graph_clear (
  in graph varchar)
{
  commit work;
  SPARQL clear graph ?:graph;
}
;

create procedure ODS.ODS_API.getFOAFDataArray (
  in foafIRI varchar,
  in sslFOAFCheck integer := 0,
  in sslLoginCheck integer := 0)
{
  declare N integer;
  declare S, SQLs, IRI, foafGraph, _identity, _loc_idn varchar;
  declare V, st, msg, rows, meta any;
  declare loginName, certLogin, certLoginEnable any;
  declare personUri any;
  declare host, port, arr any;
  declare info any;

  set_user_id ('dba');
  _identity := trim (foafIRI);
  _loc_idn := trim (foafIRI);
  V := rfc1808_parse_uri (_identity);
  if (is_https_ctx () and cfg_item_value (virtuoso_ini_path (), 'URIQA', 'DynamicLocal') = '1' and V[1] = registry_get ('URIQADefaultHost'))
    {
      V [0] := 'local';
      V [1] := '';
      _loc_idn := db.dba.vspx_uri_compose (V);
      V [0] := 'https';
      V [1] := http_request_header (http_request_header(), 'Host', null, registry_get ('URIQADefaultHost'));
      _identity := db.dba.vspx_uri_compose (V);
    }
  V := rfc1808_parse_uri (trim (foafIRI));
  V[5] := '';
  IRI := DB.DBA.vspx_uri_compose (V);

  V := vector ();
  foafGraph := ODS.ODS_API.graph_create ();
  sqls := vector (sprintf ('sparql
                            define input:storage ""
                            prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
                            prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
                            prefix foaf: <http://xmlns.com/foaf/0.1/>
                            select ?iri
          		                from <%s>
                             where {
                                     ?personalProfileDocument a foaf:PersonalProfileDocument;
                                                              foaf:primaryTopic ?iri .
                                   }', foafGraph),
                  sprintf ('sparql
                            define input:storage ""
                            prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
                            prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
                            prefix foaf: <http://xmlns.com/foaf/0.1/>
                            select ?iri
          		                from <%s>
                             where {
			     	     [] foaf:primaryTopic ?iri .
                                     ?iri a foaf:Person .
                                   } ', foafGraph)
                 );

  personUri := ODS.ODS_API.getPersonUri (
                 sprintf ('sparql load <%s> into graph <%s>', IRI, foafGraph),
                 sqls,
                 IRI,
                 foafGraph
               );
  if (isnull (personUri))
  {
  personUri := ODS.ODS_API.getPersonUri (
                 sprintf ('sparql define get:soft "soft" define get:uri <%s> select * from <%s> where { ?s ?p ?o }', IRI, foafGraph),
                 sqls,
                 IRI,
                 foafGraph
               );
  }
  if (isnull (personUri))
    goto _exit;

  commit work;
  set isolation='committed';
  if (sslFOAFCheck)
  {
    if (not is_https_ctx ())
      goto _exit;

    info := get_certificate_info (9);
    S := DB.DBA.FOAF_SSL_QR (foafGraph, _loc_idn);       

    st := '00000';
    commit work;
    exec (S, st, msg, vector (), vector ('use_cache', 1), meta, rows);
    if (st = '00000' and length (rows))
      {
	    foreach (any _row in rows) do
	  {
	    if (_row[0] = cast (info[1] as varchar) and DB.DBA.FOAF_MOD (_row[1]) = bin2hex (info[2]))
  	      goto _loginIn;
	  }
      }
      goto _exit;
  }

_loginIn:
  loginName := '';
  certLogin := 0;
  certLoginEnable := 0;
  if (is_https_ctx ())
  {
    -- FIXME: there is a lot of redundance here: we get the WebID at least twice and we fetch and delete the profile
    if (check_authentication_ssl(loginName))
      {
	-- Any WebID mapping to an ODS account can be used to login
      certLogin := 1;
	certLoginEnable := 1;
	appendProperty (V, 'certLogin', cast (certLogin as varchar));
	appendProperty (V, 'certLoginEnable', cast (certLoginEnable as varchar));
  }
  }
  V := ODS.ODS_API.extractFOAFDataArray (personUri, foafGraph);

  if (is_https_ctx () and isnull (get_keyword ('mbox', V)))
  {
    declare X, Y any;

    X := vector ();
    info := get_certificate_info (2);
    Y := split_and_decode (info, 0, '\0\0/');
    for (N := 0; N < length (Y); N := N + 1)
      X := vector_concat (X, split_and_decode (Y[N], 0, '\0\0='));

    appendProperty (V, 'mbox', get_keyword ('emailAddress', X));
  }

  if (certLogin and length (V))
    appendProperty (V, 'certLogin', cast (certLogin as varchar));

  if (loginName = '')
    loginName := DB.DBA.WA_MAKE_NICK2 (get_keyword ('nick', V), get_keyword ('name', V), get_keyword ('firstName', V), get_keyword ('family_name', V));

  if (loginName <> '')
    appendProperty (V, 'loginName', loginName);

_exit:;
  ODS.ODS_API.graph_clear (foafGraph);
  return V;
}
;

create procedure ODS.ODS_API.getPersonUri (
  in S varchar,
  in SQLs any,
  in iri varchar,
  in graph varchar)
{
  declare N integer;
  declare st, msg, rows, meta any;

  ODS.ODS_API.graph_clear (graph);

  st := '00000';
  commit work;
  exec (S, st, msg, vector (), vector ('use_cache', 1));
  if (st <> '00000')
    return null;

  for (N := 0; N < length(SQLs); n := N + 1)
  {
    st := '00000';
    commit work;
    exec (SQLs[N], st, msg, vector (), vector ('use_cache', 1), meta, rows);
    if (st = '00000' and (length (rows) > 0))
    {
      return rows[0][0];
    }
  }
  return null;
}
;

create procedure ODS.ODS_API.extractFOAFDataArray (
  in iri varchar,
  in graph varchar)
{
  declare V any;

  V := vector ();
  ODS.ODS_API.extractPersonData (V, iri, graph);

  return V;
}
;


create procedure ODS.ODS_API.extractPersonData (
  inout V any,
  in iri varchar,
  in graph varchar)
{
  declare N integer;
  declare S, st, msg, rows, meta any;

  S := sprintf ('sparql
                 define input:storage ""
                  prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
                  prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
                  prefix dc: <http://purl.org/dc/elements/1.1/>
                  prefix foaf: <http://xmlns.com/foaf/0.1/>
                  prefix geo: <http://www.w3.org/2003/01/geo/wgs84_pos#>
                  prefix bio: <http://vocab.org/bio/0.1/>
                 select *
		               from <%s>
                   where {
                          ?iri rdf:type ?type .
                          optional { ?personalProfileDocument foaf:primaryTopic ?iri }.
                            optional { ?iri foaf:name ?name } .
                            optional { ?iri foaf:title ?title } .
                            optional { ?iri foaf:nick ?nick } .
                            optional { ?iri foaf:firstName ?firstName } .
                            optional { ?iri foaf:givenname ?givenname } .
                            optional { ?iri foaf:family_name ?family_name } .
                            optional { ?iri foaf:mbox ?mbox } .
                            optional { ?iri foaf:gender ?gender } .
                            optional { ?iri foaf:birthday ?birthday } .
                          optional { ?iri foaf:based_near ?b1 .
                                     ?b1 geo:lat ?lat ;
                                         geo:long ?lng . } .
                            optional { ?iri foaf:icqChatID ?icqChatID } .
                            optional { ?iri foaf:msnChatID ?msnChatID } .
                            optional { ?iri foaf:aimChatID ?aimChatID } .
                            optional { ?iri foaf:yahooChatID ?yahooChatID } .
	                        optional { {?iri foaf:holdsAccount ?holdsAccount} UNION {?iri foaf:account ?holdsAccount}.
  	                                   ?holdsAccount foaf:accountServiceHomepage ?accountServiceHomepage ;
  	                                                 foaf:accountName ?skypeChatID.
                                       filter (str(?accountServiceHomepage) like ''skype%%'').
                                     } .
                            optional { ?iri foaf:workplaceHomepage ?workplaceHomepage } .
                            optional { ?iri foaf:homepage ?homepage } .
                            optional { ?iri foaf:phone ?phone } .
                            optional { ?iri foaf:depiction ?depiction } .
                            optional { ?iri bio:keywords ?keywords } .
                             optional { ?organization a foaf:Organization }.
                             optional { ?organization foaf:homepage ?workplaceHomepage }.
                             optional { ?organization dc:title ?organizationTitle }.
                          optional { ?iri vcard:ADR ?t_address .
                                     optional { ?t_address vcard:Country ?country } .
                             	       optional { ?t_address vcard:Locality ?locality } .
                              			 optional { ?t_address vcard:Region ?region } .
                              			 optional { ?t_address vcard:Pobox ?pobox } .
                              			 optional { ?t_address vcard:Street ?street } .
                              			 optional { ?t_address vcard:Extadd ?extadd } .
                          	       } .
                            optional { ?iri foaf:interest ?interest_array .
                                       ?interest_array rdfs:label ?interest_label. } .
                            optional { ?iri foaf:topic_interest ?topic_interest_array .
                                       ?topic_interest_array rdfs:label ?topic_interest_label. } .
	                        optional { {?iri foaf:holdsAccount ?oa} UNION {?iri foaf:account ?oa}.
                                       ?oa a foaf:OnlineAccount;
                                           foaf:accountServiceHomepage ?onlineAccount_url;
                                           foaf:accountName ?onlineAccount_array. } .
                            optional { ?iri owl:sameAs ?sameAs_array } .
                            optional { ?iri bio:olb ?resume } .
                            optional { ?iri foaf:knows ?knows_array .
                                       optional { ?knows_array foaf:nick ?knows_nick } .
                                       optional { ?knows_array foaf:name ?knows_name } .
                                     } .
                          filter (?iri = iri(?::0)).
                        }', graph);
  st := '00000';
  commit work;
  exec (S, st, msg, vector (iri), vector ('use_cache', 1), meta, rows);
  if (st = '00000')
  {
    meta := ODS.ODS_API.simplifyMeta (meta);
  foreach (any row in rows) do
  {
    N := 0;
    while (N < length(meta))
    {
      if (meta[N] like '%_array')
    {
        appendPropertyArray (V, N, meta[N], row[N], meta, row);
      } else {
        appendProperty (V, meta[N], row[N]);
      }
      N := N + 1;
    }
  }
  }
  }
;

--!
-- \brief Fetch the contents of a FOAF user profile.
--
-- \param foafIRI The URL of the FOAF profile to lookup.
-- \param spongerMode \em unused
-- \param sslFOAFCheck If set to anything but \p 0 no action will be taken unless the connection is secure.
-- \param outputMode \em unused
-- \param sslLoginCheck \em unused
--
-- \return The details of the FOAF profile serialized as a JSON stream. This stream can be used in user.register().
--
-- \b FIXME: support CN and fix outputMode.
--/
create procedure ODS.ODS_API."user.getFOAFData" (
  in foafIRI varchar,
  in spongerMode integer := 0,
  in sslFOAFCheck integer := 0,
  in outputMode integer := 1,
  in sslLoginCheck integer := 0) __soap_http 'application/json'
{
  declare V any;
  declare exit handler for sqlstate '*'
  {
    return case when outputMode then obj2json (null) else null end;
  };
  V := ODS.ODS_API.getFOAFDataArray (foafIRI, sslFOAFCheck, sslLoginCheck);
  return case when outputMode then params2json (V) else V end;
}
;

create procedure ODS.ODS_API.SSL_WEBID_GET (
  in cert any := null)
{
  declare rc, webid, webidType, graph any;

  graph := null;
  rc := ODS.ODS_API.SSL_WEBID_GET_2 (cert, webid, webidType, graph);
  if (rc)
    return webid;

  return null;
}
;

create procedure ODS.ODS_API.SSL_WEBID_GET_2 (
  in cert any,
  inout webid varchar,
  inout webidType integer,
  inout graph varchar)
{
  declare rc any;

  if (isnull (cert))
    cert := client_attr ('client_certificate');

  rc := DB.DBA.WEBID_AUTH_GEN_2 (cert, 0, null, 1, 0, webid, graph, 0, webidType);
  return rc;
}
;

--!
-- \brief Fetch the FOAF profile for a WebID certificate.
--
-- The client needs to provide the WebID X.509 certificate as an additional context attribute.
--
-- \param sslFOAFCheck \em unused
-- \param outputMode \em unused
-- \param sslLoginCheck \em unused
--
-- \return The details of the FOAF profile serialized as a JSON stream.
--/
create procedure ODS.ODS_API."user.getFOAFSSLData" (
  in sslFOAFCheck integer := 0,
  in outputMode integer := 1,
  in sslLoginCheck integer := 0) __soap_http 'application/json'
{
  declare rc, webid, webidType, graph, alts any;
  declare V any;
  declare cert, loginName, certLogin, certRegister, certLoginAutomatic, certLoginEnable, certRegisterEnable, certFilter, certFilterCheck any;

  set_user_id ('dba');
  graph := 'http://' || uuid ();
  cert := client_attr ('client_certificate');
  rc := ODS.ODS_API.SSL_WEBID_GET_2 (cert, webid, webidType, graph);
  if (not rc)
    return obj2json (null);

 	V := vector ();
  appendProperty (V, 'iri', webid);

 	loginName := '';
 	certFilter := 1;
  certLoginEnable := coalesce ((select top 1 WS_LOGIN_SSL from DB.DBA.WA_SETTINGS), 1);
 	if (certLoginEnable)
    appendProperty (V, 'certLoginEnable', cast (certLoginEnable as varchar));

  certRegisterEnable := coalesce ((select top 1 WS_REGISTER_SSL from DB.DBA.WA_SETTINGS), 1);
 	if (certRegisterEnable)
    appendProperty (V, 'certRegisterEnable', cast (certRegisterEnable as varchar));

	for (select TOP 1 WS_REGISTER_SSL_FILTER, WS_REGISTER_SSL_RULE, WS_REGISTER_SSL_REALM from DB.DBA.WA_SETTINGS) do
	{
	  if (WS_REGISTER_SSL_FILTER)
	  {
  	  certFilterCheck := sprintf ('DB.DBA.WEBID_ACL_CHECK__%s_%s', WS_REGISTER_SSL_RULE, WS_REGISTER_SSL_REALM);
      if (__proc_exists (certFilterCheck) is not null)
        certFilter := call (certFilterCheck) (cert, graph);
    }
	}

	if (certFilter and (certLoginEnable or certRegisterEnable))
	{
    appendProperty (V, 'certFilterCheck', cast (certFilter as varchar));
  for (select UC_U_ID, UC_LOGIN from DB.DBA.WA_USER_CERTS where UC_FINGERPRINT = get_certificate_info (6, cert, 0, '')) do
	{
    loginName := (select U_NAME from DB.DBA.SYS_USERS where U_ID = UC_U_ID);
    if (not isnull (loginName))
    {
	  certLogin := 1;
    	  certLoginAutomatic := coalesce (UC_LOGIN, 0);
	  appendProperty (V, 'certLogin', cast (certLogin as varchar));
       	if (certLoginAutomatic)
          appendProperty (V, 'certLoginAutomatic', cast (certLoginAutomatic as varchar));
    	}
  	}
	}

	if (certFilter and certRegisterEnable and not certLogin)
	{
    certRegister := 1;
    appendProperty (V, 'certRegister', cast (certRegister as varchar));
	}

  if (webidType = 0)
  {
    -- FOAF
    ODS.ODS_API.extractPersonData (V, webid, graph);
  }
  else if (webidType = 1)
  {
    -- WEBFINGER
    appendProperty (V, 'mbox', get_certificate_info (10, cert, 0, '', 'emailAddress'));
	  appendProperty (V, 'name', get_certificate_info (10, cert, 0, '', 'CN'));
  }
  else if (webidType = 2)
  {
    -- DI
    ;
  }
  else if (webidType = 3)
  {
    -- SEARCH
    ;
  }
  else if (webidType = 4)
  {
    -- SPONGE
    ODS.ODS_API.extractPersonData (V, webid, graph);
  }
  else if (webidType = 5)
  {
    -- LDAP
    declare i, items any;

  	if (DB.DBA.FOAF_SSL_LDAP_CHECK_INT (webid, items))
  	{
    	items := items[1];
    	for (i := 0; i < length (items); i := i + 2)
      {
        if (items[i] = 'mail')
          appendProperty (V, 'mbox', cast (items[i+1][0] as varchar));
        else if (items[i] = 'cn')
          appendProperty (V, 'name', cast (items[i+1][0] as varchar));
      }
      }
  }
  if (loginName = '')
    loginName := DB.DBA.WA_MAKE_NICK2 (get_keyword ('nick', V), get_keyword ('name', V), get_keyword ('firstName', V), get_keyword ('family_name', V));

  if (loginName <> '')
    appendProperty (V, 'loginName', loginName);


  return params2json (V);
}
;

create procedure ODS.ODS_API."user.getFacebookData" (
  in fb DB.DBA.Facebook := null,
  in fields varchar := 'uid,name',
  in outputMode integer := 1) __soap_http 'application/json'
{
  declare N integer;
  declare fbOptions, fbPaths, fbMaps, resValue, V, retValue any;
  declare tmpValue, tmpPath any;

  retValue := null;
  if (isnull (fb) and DB.DBA._get_ods_fb_settings (fbOptions))
    fb := new DB.DBA.Facebook(fbOptions[0], fbOptions[1], http_param (), http_request_header ());

  if (not isnull (fb))
  {
    fbPaths := vector ();
    fbMaps := vector (
                      'first_name', 'firstName',
                      'last_name', 'family_name',
                      'sex', 'gender'
                     );
    retValue := vector_concat (jsonObject (), vector ('api_key', fb.api_key, 'secret', fb.secret));
    if (length (fb._user))
    {
      resValue := fb.api_client.users_getInfo(fb._user, fields);
      if (not isnull (resValue))
      {
        V := split_and_decode (fields, 0, '\0\0,');
        if (not ODS.ODS_API.vector_contains(V, 'uid'))
          V := vector_concat (V, vector ('uid'));
        for (N := 0; N < length(V); N := N + 1)
        {
          tmpPath := '/users_getInfo_response/user/' || get_keyword (V[N], fbPaths, V[N]);
          tmpValue := serialize_to_UTF8_xml (xpath_eval (sprintf ('string(%s)', tmpPath), resValue));
          if (length (tmpValue))
            retValue := vector_concat (retValue, vector (get_keyword (V[N], fbMaps, V[N]), tmpValue));
          }
        }
      }
    }
  return case when outputMode then obj2json (retValue) else retValue end;
}
;

create procedure ODS.ODS_API."user.getKnowsData" (
  in sourceURI varchar,
  in spongerMode integer := 0) __soap_http 'application/json'
{
  declare N integer;
  declare S, sourceIRI, foafGraph varchar;
  declare V, st, msg, data, meta any;
  declare knows, seeAlso, nick, name, uri, label any;

  set_user_id ('dba');

  V := rfc1808_parse_uri (trim (sourceURI));
  V[5] := '';
  sourceIRI := DB.DBA.vspx_uri_compose (V);

  -- V := vector (vector_concat (jsonObject (), vector ('label', 'mara', 'uri', 'http://mara.com#this')));
  V := vector ();
  foafGraph := 'http://local.virt/FOAF/' || cast (rnd (1000) as varchar);
  if (spongerMode)
  {
    S := sprintf ('sparql define get:soft "soft" define input:grab-destination <%s> select * from <%S> where { ?s ?p ?o }', foafGraph, sourceIRI);
  } else {
    S := sprintf ('sparql load <%s> into graph <%s>', sourceIRI, foafGraph);
  }
  st := '00000';
  commit work;
  exec (S, st, msg, vector (), 0);
  if (st <> '00000')
    goto _exit;

  S := sprintf ('sparql
                 define input:storage ""
                 prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
                 prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
                 prefix dc: <http://purl.org/dc/elements/1.1/>
                 prefix foaf: <http://xmlns.com/foaf/0.1/>
                 select ?knows
                        ?nick
                        ?name
		               from <%s>
                  where {
                          [] a foaf:PersonalProfileDocument ;
                             foaf:primaryTopic ?person .
                          ?person foaf:knows ?knows.
                          optional {?knows foaf:nick ?nick.}
                          optional {?knows foaf:name ?name.}
                        }
                  order by ?knows', foafGraph);
  commit work;
  exec (S, st, msg, vector (), 0, meta, data);
  if (st <> '00000')
    goto _exit;

  knows := '';
  nick := '';
  name := '';
  for (N := 0; N < length (data); N := N + 1)
  {
    if (knows <> data[N][0])
    {
      if (knows <> '')
      {
        -- store data
        uri := knows;
        if (uri not like 'nodeID:%')
        {
          label := name;
          if (label = '')
          {
            label := nick;
          }
          else if (nick <> '')
          {
            label := name || ' (' || nick || ')';
          }
          V := vector_concat (V, vector (vector_concat (jsonObject (), vector ('uri', uri, 'label', label))));
        }
      }

      -- start new collect data
      knows := data[N][0];
      nick := '';
      name := '';
    }
    if ((nick = '') and not DB.DBA.is_empty_or_null (data[N][1]))
      nick := data[N][1];

    if ((name = '') and not DB.DBA.is_empty_or_null (data[N][2]))
      name := data[N][2];
  }

_exit:;
  SPARQL clear graph ?:foafGraph;
  return obj2json (V);
}
;

--!
-- \brief Create a new client certificate and accociate it with the authenticated user.
--
-- FIXME: create new X.509 certificate, example with <keygen>, etc.
--
-- \return The new X.509 certificate with mimetype "application/x-x509-user-cert" or an
-- error code as defined in \ref ods_response_format_result_code.
--/
create procedure ODS.ODS_API."user.certificates.create" (
  in commonName varchar := null,
  in country varchar := null,
  in organization varchar := null,
  in email varchar := null,
  in expirationDays int := null,
  in expirationHours float := 0.0,
  in publicKey varchar := null) __soap_http 'text/xml'
{
  declare kname, certPem, certDer varchar;
  declare webid, uname varchar;
  declare uid int;
  declare exts any;
  declare instanceName varchar;
  declare cn, c, o, mail varchar;


  -- This procedure is supposed to be called in an http context
  -- Thus, the error handler does produce http status codes
  declare exit handler for sqlstate '*'
  {
    rollback work;
    if (__SQL_STATE = '42000') -- permission denied
      http_status_set(403);
    else
      http_status_set(400); -- misc error
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };


  if (not ods_check_auth (uname))
    signal ('42000', 'Authentication failed');

  if(publicKey is null or publicKey = '')
    signal('22023', 'Cannot create certificate without public key.');

  -- We do not allows an empty common name
  if (commonName = '')
    commonName := null;


  -- An identifier for the ODS instance which we add to the default common name
  if(commonName is null)
  {
    instanceName := (select top 1 WS_WEB_TITLE from DB.DBA.WA_SETTINGS);
    if(length(instanceName) = 0)
      instanceName := sys_stat ('st_host_name');
  }
  else
  {
    instanceName := null;
  }


  -- Fetch default values for all parameters
  select
    coalesce(commonName, U_FULL_NAME, U_NAME),
    coalesce(email, U_E_MAIL),
    coalesce(organization, WAUI_BORG),
    coalesce(country, WAUI_BCOUNTRY),
    U_ID
  into
    commonName,
    email,
    organization,
    country,
    uid
  from
    DB.DBA.SYS_USERS,
    DB.DBA.WA_USER_INFO
  where
    U_ID = WAUI_U_ID and
    U_NAME = uname;

  expirationDays := coalesce(expirationDays, (select top 1 WS_CERT_EXPIRATION_PERIOD from DB.DBA.WA_SETTINGS), 365);
  expirationHours:= coalesce(expirationHours, 0.0);

  if (not instanceName is null)
    commonName := commonName || ' (' || instanceName || ')';

  webid := sioc.DBA.person_iri (sioc..user_obj_iri (uname));

  -- Clean up public key
  publicKey := replace (publicKey, '\r\n', '');
  publicKey := replace (publicKey, '\n', '');
  publicKey := replace (publicKey, '\r', '');


  -- Need dba privileges to create certificates
  set_user_id ('dba');

  -- Build the certificate
  kname := xenc_SPKI_read (null, publicKey);

  webid := 'URI:' || replace (webid, ',', '%2C');
  exts := vector ('subjectAltName', webid,
                  'nsComment', 'Virtuoso Generated Certificate',
                  'keyUsage', 'critical, digitalSignature, keyEncipherment',
                  'extendedKeyUsage', 'critical, clientAuth, emailProtection');

  xenc_x509_generate ('id_rsa', kname, sequence_next ('ca_id_rsa'), expirationDays,
                      vector (
                        'CN', commonName,
                        'C',  country,
                        'O',  organization,
                        'emailAddress', email
                      ),
                      exts,
                      expirationHours);

  -- prepare the certificate for further processing
  certDer := decode_base64 (xenc_X509_certificate_serialize (kname));
  certPem := xenc_pem_export (kname);

  -- Accociate the new cert with the user
  insert into DB.DBA.WA_USER_CERTS (UC_U_ID, UC_CERT, UC_FINGERPRINT, UC_LOGIN, UC_TS)
    values (uid, certPem, get_certificate_info (6, certPem, 0, ''), 1, now ());

  -- Cleanup
  xenc_key_remove (kname);

  -- Return the newly created certificate
  http_rewrite();
  http_header ('Content-Type: application/x-x509-user-cert\r\n');
  http(certDer);
  return '';
}
;

-- Application instance activity
create procedure ODS.ODS_API."instance.create" (
	in "type" varchar,
    	in name varchar,
	in description varchar,
	in model integer,
	in "public" integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare msg varchar;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  msg := '';
  rc := DB.DBA.ODS_CREATE_NEW_APP_INST ("type", name, uname, model, "public", description);
  if (not isinteger (rc))
    {
      msg := rc;
      rc := -1;
    }
  return ods_serialize_int_res (rc);
}
;


create procedure ODS.ODS_API."instance.update" (
	in inst_id integer,
    	in name varchar,
	in description varchar,
	in model int,
	in "public" int) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare dummy int;
  declare msg varchar;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname, inst_id))
    return ods_auth_failed ();

  whenever not found goto ret;
  msg := 'No such instance';
  rc := -1;
  select WAI_ID into dummy from DB.DBA.WA_INSTANCE, DB.DBA.WA_MEMBER, DB.DBA.SYS_USERS
      where WAI_NAME = WAM_INST and WAM_MEMBER_TYPE = 1 and WAM_USER = U_ID and U_NAME = uname and WAI_ID = inst_id;

  update DB.DBA.WA_INSTANCE set WAI_NAME = name, WAI_DESCRIPTION = description, WAI_MEMBER_MODEL = model,
	 WAI_IS_PUBLIC = "public" where WAI_ID = inst_id;
  rc := row_count ();
  msg := '';
ret:
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."instance.delete" (
  in inst_id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;
  declare inst any;
  declare h any;
  declare msg varchar;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname, inst_id))
    return ods_auth_failed ();

  whenever not found goto ret;
  msg := 'No such instance';
  rc := -1;
  select WAI_INST into inst from DB.DBA.WA_INSTANCE, DB.DBA.WA_MEMBER, DB.DBA.SYS_USERS
      where WAI_NAME = WAM_INST and WAM_MEMBER_TYPE = 1 and WAM_USER = U_ID and U_NAME = uname and WAI_ID = inst_id;

  h := udt_implements_method (inst, 'wa_drop_instance');
  declare exit handler for sqlstate '*' {
                                            msg := __SQL_MESSAGE;
					    rc := -1;
                                            rollback work;
                                            goto ret;
                                        };
  commit work;
  rc := call (h) (inst);
  msg := '';
  rc := 1;
ret:
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."instance.join" (
  in inst_id integer) __soap_http 'text/xml'
{
  declare _wai_name, acc_type, app_type any;
  declare uname varchar;
  declare rc integer;
  declare _u_id, _result any;
  declare msg varchar;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  msg := '';
  rc := -1;
  declare exit handler for sqlstate '*', not found
    {
      msg := __SQL_MESSAGE;
      rc := -1;
      rollback work;
      goto ret;
    };

  select U_ID into _u_id from DB.DBA.SYS_USERS where U_NAME = uname;
  select WAI_NAME, WAI_TYPE_NAME into _wai_name, app_type from DB.DBA.WA_INSTANCE where WAI_ID = inst_id;
  acc_type := (select max(WMT_ID) from DB.DBA.WA_MEMBER_TYPE where WMT_APP = app_type);

  insert into DB.DBA.WA_MEMBER (WAM_USER, WAM_INST, WAM_MEMBER_TYPE, WAM_STATUS)
      values (_u_id, _wai_name, acc_type, 3);
  _result := connection_get('join_result');
  rc := 1;
  if (_result = 'approved')
    msg := 'Your join request approved.';
  else if (_result = 'ownerwait')
    {
      msg := 'Application owner notified about your join request. You will get e-mail message after approval.';
      rc := 0;
    }
ret:
  return ods_serialize_int_res (rc, msg);
}
;

create procedure ODS.ODS_API."instance.disjoin" (
  in inst_id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();
  delete from DB.DBA.WA_MEMBER where
      WAM_INST = (select WAI_NAME from DB.DBA.WA_INSTANCE where WAI_ID = inst_id)
      and
      WAM_USER = (select U_ID from DB.DBA.SYS_USERS where U_NAME = uname);
  rc := row_count ();
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."instance.join_approve" (
  in inst_id integer,
  in uname varchar) __soap_http 'text/xml'
{
  return;
}
;

create procedure ODS.ODS_API."notification.services" () __soap_http 'text/xml'
{
  declare q varchar;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  q := sprintf ('select * from <%s> where { <%s> sioc:has_service ?svc . ?svc dc:identifier ?id ; rdfs:label ?label  } ', ods_graph(), ods_graph());
  exec_sparql (q);
  return '';
}
;

create procedure ODS.ODS_API."instance.notification.services" (in inst_id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc, dummy int;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname, inst_id))
    return ods_auth_failed ();
ret:
  return '';
}
;


create procedure ODS.ODS_API."instance.notification.set" (in inst_id integer, in services any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc, dummy int;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname, inst_id))
    return ods_auth_failed ();

  whenever not found goto ret;
  rc := 'No enough permissions, must be instance owner';
  select WAI_ID
    into dummy
    from DB.DBA.WA_INSTANCE, DB.DBA.WA_MEMBER, DB.DBA.SYS_USERS
      where WAI_NAME = WAM_INST and WAM_MEMBER_TYPE = 1 and WAM_USER = U_ID and U_NAME = uname and WAI_ID = inst_id;
   foreach (any psi in services) do
     {
	if (psi > 0)
          insert soft ODS..APP_PING_REG (AP_HOST_ID, AP_WAI_ID) values (psi, inst_id);
     }
  rc := row_count ();
ret:
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."instance.notification.cancel" (
  in inst_id integer,
  in services any) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc, dummy int;
  declare msg varchar;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname, inst_id))
    return ods_auth_failed ();

  whenever not found goto ret;
  msg := 'No enough permissions, must be instance owner';
  rc := -13;
  select WAI_ID
    into dummy
    from DB.DBA.WA_INSTANCE, DB.DBA.WA_MEMBER, DB.DBA.SYS_USERS
      where WAI_NAME = WAM_INST and WAM_MEMBER_TYPE = 1 and WAM_USER = U_ID and U_NAME = uname and WAI_ID = inst_id;
   foreach (any psi in services) do
     {
       delete from ODS..APP_PING_REG where AP_HOST_ID = psi and AP_WAI_ID = inst_id;
     }

  rc := row_count ();
  msg := '';
ret:
  return ods_serialize_int_res (rc, msg);
}
;

create procedure ODS.ODS_API."instance.notification.log" (in inst_id integer) __soap_http 'text/xml'
{
  return;
}
;


create procedure ODS.ODS_API."instance.search" (in pattern varchar) __soap_http 'text/xml'
{
  declare q varchar;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  q := sprintf ('select * from <%s> where { ?inst a sioc:Container ; dc:identifier ?inst_id ; ?property ?value . ?value bif:contains "%s" } ', ods_graph(), pattern);
  exec_sparql (q);
  return '';
}
;

create procedure ODS.ODS_API."instance.get" (
  in inst_id integer) __soap_http 'text/xml'
{
  declare q varchar;
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  q := sprintf ('select * from <%s> where { ?inst a sioc:Container ; dc:identifier %d ; ?property ?value . } ', ods_graph(), inst_id);
  exec_sparql (q);
  return '';
}
;

--!
-- \brief Get the id of an ODS app instance.
--
-- Each ODS app has a unique numeric id which is required for almost
-- all operations. This method allows to determine that id from the
-- app instance's name (App instance names are oftern something like
-- "foobar's Calendar").
--
-- \param instanceName The name of the app instance.
--
-- \return An error code as defined in \ref ods_response_format_result_code which in this case
-- matches the instance id.
--
-- \sa \ref ods_instance_id
--
-- \b Example:
-- \verbatim
-- $ curl -i "http://demo.openlinksw.com/ods/api/instance.get.id?instanceName=Demo%20account%27s%20Briefcase&sid=c198c56e675abd9967b2b264d1119ae2&realm=wa"
--
-- HTTP/1.1 200 OK
-- Server: Virtuoso/05.12.3041 (Solaris) x86_64-sun-solaris2.10-64  VDB
-- Connection: Keep-Alive
-- Date: Tue, 01 Dec 2009 12:39:19 GMT
-- Accept-Ranges: bytes
-- Content-Type: text/xml; charset="ISO-8859-1"
-- Content-Length: 57
--
-- <result>
--   <code>6</code>
--   <message>Success</message>
-- </result>
-- \endverbatim
--/
create procedure ODS.ODS_API."instance.get.id" (
  in instanceName varchar) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;

  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname))
    return ods_auth_failed ();

  rc := (select WAI_ID from DB.DBA.WA_INSTANCE where WAI_NAME = instanceName);
  if (isnull (rc))
    return ods_serialize_sql_error ('-1', 'No such instance');
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."instance.freeze" (
  in inst_id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;

  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname, inst_id))
    return ods_auth_failed ();

  if (not exists (select 1 from DB.DBA.WA_INSTANCE where WAI_ID = inst_id))
    return ods_serialize_sql_error ('37000', 'The item is not found');
  if (uname in ('dav', 'dba'))
  {
    update DB.DBA.WA_INSTANCE set WAI_IS_FROZEN = 1 where WAI_ID = inst_id;
    rc := row_count ();
  } else {
    rc := -13;
  }
ret:
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API."instance.unfreeze" (
  in inst_id integer) __soap_http 'text/xml'
{
  declare uname varchar;
  declare rc integer;

  declare exit handler for sqlstate '*'
  {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  if (not ods_check_auth (uname, inst_id))
    return ods_auth_failed ();

  if (not exists (select 1 from DB.DBA.WA_INSTANCE where WAI_ID = inst_id))
    return ods_serialize_sql_error ('37000', 'The item is not found');
  if (uname in ('dav', 'dba'))
  {
    update DB.DBA.WA_INSTANCE set WAI_IS_FROZEN = 0 where WAI_ID = inst_id;
    rc := row_count ();
  }
  else
  {
    rc := -13;
  }
ret:
  return ods_serialize_int_res (rc);
}
;

create procedure ODS.ODS_API.predicates ()
{
  return vector (
    'webIDVerified'  , vector ('Certificate - Verified',           'boolean',     'boolean',  vector ()),
    'certExpiration' , vector ('Certificate - Expiration Status',  'boolean',     'boolean',  vector ()),
    'certSerial'     , vector ('Certificate - Serial Number',      'varchar',     'varchar',  vector ()),
    'webID'            , vector ('Certificate - WebID',              'varchar',     'varchar',  vector ()),
    'certMail'       , vector ('Certificate - Mail',               'varchar',     'varchar',  vector ()),
    'certSubject'    , vector ('Certificate - Subject',            'varchar',     'varchar',  vector ()),
    'certIssuer'     , vector ('Certificate - Issuer',             'varchar',     'varchar',  vector ()),
    'certStartDate'  , vector ('Certificate - Issue Date',         'date',        'date',     vector ('size', '10', 'class', '_validate_ _date_', 'onclick', 'datePopup(\'-FIELD-\')', 'button', '<img id="-FIELD-_select" border="0" src="/oMail/i/pick_calendar.gif" onclick="javascript: datePopup(\'-FIELD-\');" />')),
    'certEndDate'    , vector ('Certificate - Expiry Date',        'date',        'date',     vector ('size', '10', 'class', '_validate_ _date_', 'onclick', 'datePopup(\'-FIELD-\')', 'button', '<img id="-FIELD-_select" border="0" src="/oMail/i/pick_calendar.gif" onclick="javascript: datePopup(\'-FIELD-\');" />')),
    'certDigest'     , vector ('Certificate - Fingerprint Digest', 'digest',      'varchar',  vector ('class', '_validate_ _digest_')),
    'certSparqlTriplet', vector ('Certificate - SPARQL Triplet',     'triplet',     'varchar',  vector ()),
    'certSparqlASK'  , vector ('Certificate - SPARQL ASK',         'sparql',      'boolean',  vector ())
  );
}
;

create procedure ODS.ODS_API.compares ()
{
  return vector (
    'eq'           , vector ('equal to'                  , vector ('integer', 'date', 'varchar', 'address', 'priority', 'folder', 'boolean', 'triplet', 'sparql', 'digest'), 1),
    'neq'          , vector ('not equal to'              , vector ('integer', 'date', 'varchar', 'address', 'priority', 'folder', 'boolean', 'triplet', 'sparql', 'digest'), 1),
    'lt'           , vector ('less than'                , vector ('integer', 'date', 'priority'), 1),
    'lte'          , vector ('less thanor equal to'     , vector ('integer', 'date', 'priority'), 1),
    'gt'           , vector ('greater than'             , vector ('integer', 'date', 'priority'), 1),
    'gte'          , vector ('greater than or equal to' , vector ('integer', 'date', 'priority'), 1),
    'contains'     , vector ('contains substring'        , vector ('varchar', 'address', 'triplet'), 1),
    'notContains'  , vector ('does not contain substring', vector ('varchar', 'address', 'triplet'), 1),
    'startsWith'   , vector ('starts with'               , vector ('varchar', 'address', 'triplet'), 1),
    'notStartsWith', vector ('does not start with'       , vector ('varchar', 'address', 'triplet'), 1),
    'endsWith'     , vector ('ends with'                 , vector ('varchar', 'address', 'triplet'), 1),
    'notEndsWith'  , vector ('does not end with'         , vector ('varchar', 'address', 'triplet'), 1),
    'isNull'       , vector ('is null'                  , vector ('address'), 0),
    'isNotNull'    , vector ('is not null'              , vector ('address'), 0)
  );
}
;

--!
-- \brief Mapping of ODS supported comparison commands to SQL expressions.
--
-- The returned vector contains a mapping from comparison name (\p eq, \p gt, etc)
-- to an SQL command which does the actual comparison. The command uses two variables:
-- - value
-- - pattern
--
-- One example is the \greater \p than command which is encoded as follows:
-- \verbatim
--     'gt', '(^{value}^ > ^{pattern}^)'
-- \endverbatim
--
-- This is used by sioc.sql for ACL rule checking only.
--/
create procedure ODS.ODS_API.commands ()
{
  return vector (
    'eq'           , '(^{value}^ = ^{pattern}^)',
    'neq'          , '(^{value}^ <> ^{pattern}^)',
    'lt'           , '(^{value}^ < ^{pattern}^)',
    'lte'          , '(^{value}^ <= ^{pattern}^)',
    'gt'           , '(^{value}^ > ^{pattern}^)',
    'gte'          , '(^{value}^ >= ^{pattern}^)',
    'contains'     , '(bif:isnull (bif:strstr (bif:ucase (^{value}^), bif:ucase (^{pattern}^))) = 0)',
    'notContains'  , '(bif:isnull (bif:strstr (bif:ucase (^{value}^), bif:ucase (^{pattern}^))) = 1)',
    'startsWith'   , '(bif:starts_with (bif:ucase (^{value}^), bif:ucase (^{pattern}^)) = 1)',
    'notStartsWith', '(bif:starts_with (bif:ucase (^{value}^), bif:ucase (^{pattern}^)) = 0)',
    'endsWith'     , '(bif:ends_with (bif:ucase (^{value}^), bif:ucase (^{pattern}^)) = 1)',
    'notEndsWith'  , '(bif:ends_with (bif:ucase (^{value}^), bif:ucase (^{pattern}^)) = 0)',
    'isNull'       , '(DB.DBA.is_empty_or_null (^{value}^) = 1)',
    'isNotNull'    , '(DB.DBA.is_empty_or_null (^{value}^) = 0)'
    );
}
;

create procedure ODS.ODS_API."triplets" ()
{
  return vector ('foaf:knows');
}
;

create procedure ODS.ODS_API."filtersData" () __soap_http 'application/json'
{
  return obj2json (vector (ODS.ODS_API."predicates" (), ODS.ODS_API."compares" (), ODS.ODS_API."triplets" ()));
}
;

-- global actions

create procedure ODS.ODS_API."site.search" (in pattern varchar, in options any) __soap_http 'text/xml'
{
  declare exit handler for sqlstate '*' {
    rollback work;
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };
  ODS.DBA.search_do_rdf (pattern, options, vector ('Accept: application/sparql-results+xml\r\n'), 100);
  return '';
}
;

create procedure ODS.ODS_API.error_handler () __soap_http 'text/xml'
{
  declare code, msg any;
  code := http_param ('__SQL_STATE');
  msg  := http_param ('__SQL_MESSAGE');
  if (isstring (code) and isstring (msg))
    return ods_serialize_sql_error (code, msg);
  return '<failed><code>-500</code><message>Can not process your request, please check parameters</message></failed>';
}
;

--!
-- \brief Register a new client application with an ODS instance.
--
-- Certain operations in ODS require special security mesures. This includes authentication
-- through third-party services for which the callback URL needs to be trusted. To this end
-- administrator can register client URLs via this function.
--
-- This administration function requires \p dba priviledges.
--
-- \param name A descriptive name for the client.
-- \param url The URL of the client which will access the ODS instance. The base URL is sufficient.
--
-- \return An error code as defined in \ref ods_response_format, \p 0 on success. On
-- error the HTTP status code will be set to \p 403 or \p 400, depending on the type
-- of error.
--/
create procedure ODS.ODS_API."admin.clients.new" (
  in name varchar,
  in url varchar) __SOAP_HTTP 'text/xml'
{
  declare uname varchar;

  -- This procedure is supposed to be called in an http context
  -- Thus, the error handler does produce http status codes
  declare exit handler for sqlstate '*'
  {
    rollback work;
    if (__SQL_STATE = '42000') -- permission denied
      http_status_set(403);
    else
      http_status_set(400); -- misc error
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
  {
    signal('42000', 'Admin priviledges are required to add client URLs to an ODS instance.');
  }

  -- become the authenticated user for further operations
  set_qualifier(uname);

  insert into DB.DBA.WA_CLIENT_REG(CLIENT_NAME, CLIENT_URL) VALUES (name, url);

  return ods_serialize_int_res(0);
}
;

--!
-- \brief Add a 3rd-party service client key and secret for OAuth authentication.
--
-- ODS (and Virtuoso) supports many 3rd-party services via OAuth. In order to use these
-- features the ODS instance needs to be registered with the service and the client key
-- and secret needs to be added to the ODS instance through this function.
--
-- See \ref ods_authentication_url_services for details on how to create the client key
-- and secret for the different supported services.
--
-- \return An error code as defined in \ref ods_response_format, \p 0 on success. On
-- error the HTTP status code will be set to \p 403 or \p 400, depending on the type
-- of error.
--/
create procedure ODS.ODS_API."admin.apikeys.new" (
  in name varchar,
  in clientkey varchar,
  in clientsecret varchar) __SOAP_HTTP 'text/xml'
{
  declare uname varchar;

  -- This procedure is supposed to be called in an http context
  -- Thus, the error handler does produce http status codes
  declare exit handler for sqlstate '*'
  {
    rollback work;
    if (__SQL_STATE = '42000') -- permission denied
      http_status_set(403);
    else
      http_status_set(400); -- misc error
    return ods_serialize_sql_error (__SQL_STATE, __SQL_MESSAGE);
  };

  if (not ods_check_auth (uname))
    signal('42000', 'Admin priviledges are required to add client URLs to an ODS instance.');

  if (length(name) = 0)
    signal('22023', 'Cannot add a client key with an empty name');
  if (length(clientKey) = 0)
    signal('22023', 'Cannot add a client key with an empty key');

  -- become the authenticated user for further operations
  set_qualifier(uname);

  insert into OAUTH.DBA.APP_REG(a_owner, a_name, a_key, a_secret) VALUES (0, name, clientkey, clientsecret);

  return ods_serialize_int_res(0);
}
;


DB.DBA.USER_CREATE ('ODS_API', uuid(), vector ('DISABLED', 1, 'LOGIN_QUALIFIER', 'ODS'));
DB.DBA.EXEC_STMT ('grant SPARQL_UPDATE to ODS_API', 0);
DB.DBA.VHOST_REMOVE (lpath=>'/ods/api');
DB.DBA.VHOST_DEFINE (lpath=>'/ods/api', ppath=>'/SOAP/Http', soap_user=>'ODS_API', opts=>vector ('500_page', 'error_handler'));

grant execute on ODS.ODS_API.error_handler to ODS_API;

grant execute on ODS.ODS_API."iri2proxy" to ODS_API;

grant execute on ODS.ODS_API."qrcode" to ODS_API;
grant execute on ODS.ODS_API."getDefaultHttps" to ODS_API;

grant execute on ODS.ODS_API."ontology.classes" to ODS_API;
grant execute on ODS.ODS_API."ontology.classProperties" to ODS_API;
grant execute on ODS.ODS_API."ontology.objects" to ODS_API;

grant execute on ODS.ODS_API."objects.rdf" to ODS_API;
grant execute on ODS.ODS_API."lookup.list" to ODS_API;

grant execute on ODS.ODS_API."server.getInfo" to ODS_API;
grant execute on ODS.ODS_API."address.geoData" to ODS_API;

grant execute on ODS.ODS_API."user.oauth.twitter.authenticationUrl" to ODS_API;
grant execute on ODS.ODS_API."user.oauth.twitter.registrationData" to ODS_API;
grant execute on ODS.ODS_API."twitterServer" to ODS_API;
grant execute on ODS.ODS_API."twitterVerify" to ODS_API;

grant execute on ODS.ODS_API."user.oauth.linkedin.authenticationUrl" to ODS_API;
grant execute on ODS.ODS_API."user.oauth.linkedin.registrationData" to ODS_API;
grant execute on ODS.ODS_API."linkedinServer" to ODS_API;
grant execute on ODS.ODS_API."linkedinVerify" to ODS_API;

grant execute on ODS.ODS_API."user.openid.authenticationUrl" to ODS_API;
grant execute on ODS.ODS_API."user.openid.registrationData" to ODS_API;
grant execute on ODS.ODS_API."user.openid.loginUrl" to ODS_API;

grant execute on ODS.ODS_API."user.checkAvailability" to ODS_API;
grant execute on ODS.ODS_API."user.register" to ODS_API;
grant execute on ODS.ODS_API."user.authenticate" to ODS_API;
grant execute on ODS.ODS_API."user.authenticate.authenticationUrl" to ODS_API;
grant execute on ODS.ODS_API."user.authenticate.callback" to ODS_API;
grant execute on ODS.ODS_API."user.authenticate.browserid" to ODS_API;
grant execute on ODS.ODS_API."user.authenticate.webid" to ODS_API;
grant execute on ODS.ODS_API."user.authenticate.confirm" to ODS_API;
grant execute on ODS.ODS_API."user.login" to ODS_API;
grant execute on ODS.ODS_API."user.validate" to ODS_API;
grant execute on ODS.ODS_API."user.logout" to ODS_API;
grant execute on ODS.ODS_API."user.update" to ODS_API;
grant execute on ODS.ODS_API."user.update.fields" to ODS_API;
grant execute on ODS.ODS_API."user.acl.update" to ODS_API;
grant execute on ODS.ODS_API."user.acl.info" to ODS_API;
grant execute on ODS.ODS_API."user.upload" to ODS_API;
grant execute on ODS.ODS_API."user.password_change" to ODS_API;
grant execute on ODS.ODS_API."user.delete" to ODS_API;
grant execute on ODS.ODS_API."user.enable" to ODS_API;
grant execute on ODS.ODS_API."user.disable" to ODS_API;
grant execute on ODS.ODS_API."user.get" to ODS_API;
grant execute on ODS.ODS_API."user.info" to ODS_API;
grant execute on ODS.ODS_API."user.info.webID" to ODS_API;
grant execute on ODS.ODS_API."user.certificateUrl" to ODS_API;
grant execute on ODS.ODS_API."user.search" to ODS_API;
grant execute on ODS.ODS_API."user.invitation.new" to ODS_API;
grant execute on ODS.ODS_API."user.invitation.approve" to ODS_API;
grant execute on ODS.ODS_API."user.invitation.list" to ODS_API;
grant execute on ODS.ODS_API."user.relation.delete" to ODS_API;
grant execute on ODS.ODS_API."user.invite" to ODS_API;
grant execute on ODS.ODS_API."user.invitation" to ODS_API;
grant execute on ODS.ODS_API."user.invitations.get" to ODS_API;
grant execute on ODS.ODS_API."user.relation_terminate" to ODS_API;
grant execute on ODS.ODS_API."user.relation_update" to ODS_API;
grant execute on ODS.ODS_API."user.tagging_rules.add" to ODS_API;
grant execute on ODS.ODS_API."user.tagging_rules.update" to ODS_API;
grant execute on ODS.ODS_API."user.tagging_rules.delete" to ODS_API;
grant execute on ODS.ODS_API."user.hyperlinking_rules.add" to ODS_API;
grant execute on ODS.ODS_API."user.hyperlinking_rules.update" to ODS_API;
grant execute on ODS.ODS_API."user.hyperlinking_rules.delete" to ODS_API;
grant execute on ODS.ODS_API."user.topicOfInterest.new" to ODS_API;
grant execute on ODS.ODS_API."user.topicOfInterest.delete" to ODS_API;
grant execute on ODS.ODS_API."user.thingOfInterest.new" to ODS_API;
grant execute on ODS.ODS_API."user.thingOfInterest.delete" to ODS_API;
grant execute on ODS.ODS_API."user.annotation.new" to ODS_API;
grant execute on ODS.ODS_API."user.annotation.delete" to ODS_API;
grant execute on ODS.ODS_API."user.onlineAccounts.uri" to ODS_API;
grant execute on ODS.ODS_API."user.onlineAccounts.list" to ODS_API;
grant execute on ODS.ODS_API."user.onlineAccounts.new" to ODS_API;
grant execute on ODS.ODS_API."user.onlineAccounts.delete" to ODS_API;
grant execute on ODS.ODS_API."user.bioEvents.list" to ODS_API;
grant execute on ODS.ODS_API."user.bioEvents.new" to ODS_API;
grant execute on ODS.ODS_API."user.bioEvents.delete" to ODS_API;
grant execute on ODS.ODS_API."user.favorites.list" to ODS_API;
grant execute on ODS.ODS_API."user.favorites.get" to ODS_API;
grant execute on ODS.ODS_API."user.favorites.new" to ODS_API;
grant execute on ODS.ODS_API."user.favorites.edit" to ODS_API;
grant execute on ODS.ODS_API."user.favorites.delete" to ODS_API;
grant execute on ODS.ODS_API."user.mades.list" to ODS_API;
grant execute on ODS.ODS_API."user.mades.get" to ODS_API;
grant execute on ODS.ODS_API."user.mades.new" to ODS_API;
grant execute on ODS.ODS_API."user.mades.edit" to ODS_API;
grant execute on ODS.ODS_API."user.mades.delete" to ODS_API;
grant execute on ODS.ODS_API."user.offers.list" to ODS_API;
grant execute on ODS.ODS_API."user.offers.get" to ODS_API;
grant execute on ODS.ODS_API."user.offers.new" to ODS_API;
grant execute on ODS.ODS_API."user.offers.edit" to ODS_API;
grant execute on ODS.ODS_API."user.offers.delete" to ODS_API;
grant execute on ODS.ODS_API."user.seeks.list" to ODS_API;
grant execute on ODS.ODS_API."user.seeks.get" to ODS_API;
grant execute on ODS.ODS_API."user.seeks.new" to ODS_API;
grant execute on ODS.ODS_API."user.seeks.edit" to ODS_API;
grant execute on ODS.ODS_API."user.seeks.delete" to ODS_API;
grant execute on ODS.ODS_API."user.owns.list" to ODS_API;
grant execute on ODS.ODS_API."user.owns.get" to ODS_API;
grant execute on ODS.ODS_API."user.owns.new" to ODS_API;
grant execute on ODS.ODS_API."user.owns.edit" to ODS_API;
grant execute on ODS.ODS_API."user.owns.delete" to ODS_API;
grant execute on ODS.ODS_API."user.likes.list" to ODS_API;
grant execute on ODS.ODS_API."user.likes.get" to ODS_API;
grant execute on ODS.ODS_API."user.likes.new" to ODS_API;
grant execute on ODS.ODS_API."user.likes.edit" to ODS_API;
grant execute on ODS.ODS_API."user.likes.delete" to ODS_API;
grant execute on ODS.ODS_API."user.knows.list" to ODS_API;
grant execute on ODS.ODS_API."user.knows.get" to ODS_API;
grant execute on ODS.ODS_API."user.knows.new" to ODS_API;
grant execute on ODS.ODS_API."user.knows.edit" to ODS_API;
grant execute on ODS.ODS_API."user.knows.delete" to ODS_API;
grant execute on ODS.ODS_API."user.instances.list" to ODS_API;
grant execute on ODS.ODS_API."user.certificates.list" to ODS_API;
grant execute on ODS.ODS_API."user.certificates.get" to ODS_API;
grant execute on ODS.ODS_API."user.certificates.new" to ODS_API;
grant execute on ODS.ODS_API."user.certificates.edit" to ODS_API;
grant execute on ODS.ODS_API."user.certificates.delete" to ODS_API;
grant execute on ODS.ODS_API."user.certificates.create" to ODS_API;
grant execute on ODS.ODS_API."user.getKnowsData" to ODS_API;
grant execute on ODS.ODS_API."user.getFOAFData" to ODS_API;
grant execute on ODS.ODS_API."user.getFOAFSSLData" to ODS_API;
grant execute on ODS.ODS_API."user.getFacebookData" to ODS_API;


grant execute on ODS.ODS_API."instance.create" to ODS_API;
grant execute on ODS.ODS_API."instance.update" to ODS_API;
grant execute on ODS.ODS_API."instance.delete" to ODS_API;
grant execute on ODS.ODS_API."instance.join" to ODS_API;
grant execute on ODS.ODS_API."instance.disjoin" to ODS_API;
grant execute on ODS.ODS_API."instance.join_approve" to ODS_API;
grant execute on ODS.ODS_API."notification.services" to ODS_API;
grant execute on ODS.ODS_API."instance.notification.set" to ODS_API;
grant execute on ODS.ODS_API."instance.notification.cancel" to ODS_API;
grant execute on ODS.ODS_API."instance.notification.log" to ODS_API;
grant execute on ODS.ODS_API."instance.search" to ODS_API;
grant execute on ODS.ODS_API."instance.get" to ODS_API;
grant execute on ODS.ODS_API."instance.get.id" to ODS_API;
grant execute on ODS.ODS_API."instance.freeze" to ODS_API;
grant execute on ODS.ODS_API."instance.unfreeze" to ODS_API;

grant execute on ODS.ODS_API."site.search" to ODS_API;

grant execute on ODS.ODS_API."filtersData" to ODS_API;

grant execute on ODS.ODS_API."admin.clients.new" to ODS_API;
grant execute on ODS.ODS_API."admin.apikeys.new" to ODS_API;

create procedure __user_password (in uname varchar)
{
  return (select pwd_magic_calc (U_NAME, U_PASSWORD, 1) from Db.DBA.SYS_USERS where U_NAME = uname);
}
;

use OAUTH;

create procedure OAUTH..check_authentication_safe (
  in inparams any := null,
  in lines any := null,
  out uname varchar,
  inout inst_id integer := null)
{
  if (inparams is null)
    inparams := http_param ();
  if (lines is null)
    lines := http_request_header ();
  declare exit handler for sqlstate '*'
  {
    return 0;
  };
  return OAUTH..check_authentication (inparams, lines, uname, inst_id);
}
;

create procedure OAUTH..check_authentication (
  in inparams any,
  in lines any,
  out uname varchar,
  inout inst_id integer := null)
{
  declare oauth_consumer_key varchar;
  declare oauth_token varchar;
  declare oauth_signature_method varchar;
  declare oauth_signature varchar;
  declare oauth_timestamp varchar;
  declare oauth_nonce varchar;
  declare oauth_version varchar;
  declare oauth_client_ip varchar;

  declare ret, tok, sec, ahead, params varchar;
  declare sid, app_sec, url, meth, cookie, req_sec, app_name varchar;
  declare app_id int;

  ahead := http_request_header (lines, 'Authorization', null, null);
  params := null;
  if (ahead is not null)
  {
    declare tmp, newpars any;
    tmp := split_and_decode (ahead, 0, '\0\0,');
    newpars := vector ();
    if (length (tmp) and trim(tmp[0]) like 'OAuth %')
	  {
	    for (declare i, l int, i := 1, l := length (tmp); i < l; i := i + 1)
	    {
	      declare par any;
	      par := split_and_decode (trim(tmp[0]), 0, '\0\0=');
	      newpars := vector_concat (newpars, par);
	    }
	    if (length (newpars))
	      params := newpars;
	  }
  }
  if (params is null)
    params := inparams;

  oauth_consumer_key := get_keyword ('oauth_consumer_key', params);
  oauth_token := get_keyword ('oauth_token', params);
  oauth_signature_method := get_keyword ('oauth_signature_method', params);
  oauth_signature := get_keyword ('oauth_signature', params);
  oauth_timestamp := get_keyword ('oauth_timestamp', params);
  oauth_nonce := get_keyword ('oauth_nonce', params);
  oauth_version := get_keyword ('oauth_version', params, '1.0');
  oauth_client_ip := get_keyword ('oauth_client_ip', params, http_client_ip ());

  declare exit handler for not found
  {
    signal ('22023', 'Can''t verify request, missing oauth_consumer_key or oauth_token');
  };

  declare exit handler for sqlstate '*'
  {
    resignal;
  };
  select a_secret, a_id, U_NAME, a_name
    into app_sec, app_id, uname, app_name
    from OAUTH..APP_REG, DB.DBA.SYS_USERS
   where a_owner = U_ID and a_key = oauth_consumer_key;

  if (exists (select 1 from OAUTH..SESSIONS where s_nonce = oauth_nonce))
    signal ('42000', 'OAuth Verification Failed');

  if ((inst_id is not null) and (inst_id <> -1) and not exists (select 1 from DB.DBA.WA_INSTANCE where WAI_NAME = app_name and WAI_ID = inst_id))
    signal ('42000', 'OAuth Verification Failed');

  declare exit handler for not found
  {
    signal ('42000', 'OAuth Verification Failed');
  };

  select s_access_secret into req_sec from OAUTH..SESSIONS where s_access_key = oauth_token and s_ip = oauth_client_ip and s_state = 3;

  url := get_requested_url ();
  lines := http_request_header ();
  params := http_request_get ('QUERY_STRING');
  meth := http_request_get ('REQUEST_METHOD');

  if (not OAUTH..check_signature (oauth_signature_method, oauth_signature, meth, url, params, lines, app_sec, req_sec))
  {
    signal ('42000', 'OAuth Verification Failed: Bad Signature');
  }
  if (isnull (inst_id))
  {
    inst_id := (select WAI_ID from DB.DBA.WA_INSTANCE where WAI_NAME = app_name);
  }
  return 1;
}
;

use DB;
