d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- $Id$

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--- @file

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- VBox Test Manager Database Stored Procedures - UserAccounts.

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- Copyright (C) 2012-2014 Oracle Corporation

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- This file is part of VirtualBox Open Source Edition (OSE), as

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- available from http://www.virtualbox.org. This file is free software;

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- you can redistribute it and/or modify it under the terms of the GNU

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- General Public License (GPL) as published by the Free Software

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- Foundation, in version 2 as it comes in the "COPYING" file of the

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- VirtualBox OSE distribution. VirtualBox OSE is distributed in the

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync--

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- The contents of this file may alternatively be used under the terms

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- of the Common Development and Distribution License Version 1.0

fcae7923a3c756b333f1e33eba002edf4448fb54vboxsync-- (CDDL) only, as it comes in the "COPYING.CDDL" file of the

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- VirtualBox OSE distribution, in which case the provisions of the

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- CDDL are applicable instead of those of the GPL.

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- You may elect to license modified versions of this file under the

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- terms and conditions of either the GPL or the CDDL or both.

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync\set ON_ERROR_STOP 1

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync\connect testmanager;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync---

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- Checks if the user name and login name are unique, ignoring a_uidIgnore.

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- Raises exception if duplicates are found.

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync-- @internal

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync--

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsyncCREATE OR REPLACE FUNCTION UserAccountLogic_checkUniqueUser(a_sUsername TEXT, a_sLoginName TEXT, a_uidIgnore INTEGER)

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync RETURNS VOID AS $$

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync DECLARE

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync v_cRows INTEGER;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync BEGIN

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync -- sUserName

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync SELECT COUNT(*) INTO v_cRows

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync FROM Users

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync WHERE sUsername = a_sUsername

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync AND tsExpire = 'infinity'::TIMESTAMP

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync AND uid <> a_uidIgnore;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync IF v_cRows <> 0 THEN

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync RAISE EXCEPTION 'Duplicate user name "%" (% times)', a_sUsername, v_cRows;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync END IF;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync -- sLoginName

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync SELECT COUNT(*) INTO v_cRows

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync FROM Users

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync WHERE sLoginName = a_sLoginName

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync AND tsExpire = 'infinity'::TIMESTAMP

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync AND uid <> a_uidIgnore;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync IF v_cRows <> 0 THEN

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync RAISE EXCEPTION 'Duplicate login name "%" (% times)', a_sUsername, v_cRows;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync END IF;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync END;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync$$ LANGUAGE plpgsql;

d2236df2116a3cbe8b17c567f4a9c2281733a956vboxsync

---

-- Check that the user account exists.

-- Raises exception if it doesn't.

--

-- @internal

--

CREATE OR REPLACE FUNCTION UserAccountLogic_checkExists(a_uid INTEGER) RETURNS VOID AS $$

DECLARE

v_cUpdatedRows INTEGER;

BEGIN

IF NOT EXISTS( SELECT *

FROM Users

WHERE uid = a_uid

AND tsExpire = 'infinity'::TIMESTAMP ) THEN

RAISE EXCEPTION 'User with ID % does not currently exist', a_uid;

END IF;

END;

$$ LANGUAGE plpgsql;

---

-- Historize a row.

-- @internal

--

CREATE OR REPLACE FUNCTION UserAccountLogic_historizeEntry(a_uid INTEGER, a_tsExpire TIMESTAMP WITH TIME ZONE)

RETURNS VOID AS $$

DECLARE

v_cUpdatedRows INTEGER;

BEGIN

UPDATE Users

SET tsExpire = a_tsExpire

WHERE uid = a_uid

AND tsExpire = 'infinity'::TIMESTAMP;

GET DIAGNOSTICS v_cUpdatedRows = ROW_COUNT;

IF v_cUpdatedRows <> 1 THEN

IF v_cUpdatedRows = 0 THEN

RAISE EXCEPTION 'User with ID % does not currently exist', a_uid;

END IF;

RAISE EXCEPTION 'Integrity error in UserAccounts: % current rows with uid=%d', v_cUpdatedRows, a_uid;

END IF;

END;

$$ LANGUAGE plpgsql;

---

-- Adds a new user.

--

CREATE OR REPLACE FUNCTION UserAccountLogic_addEntry(a_uidAuthor INTEGER, a_sUsername TEXT, a_sEmail TEXT, a_sFullName TEXT,

a_sLoginName TEXT)

RETURNS VOID AS $$

DECLARE

v_cRows INTEGER;

BEGIN

PERFORM UserAccountLogic_checkUniqueUser(a_sUsername, a_sLoginName, -1);

INSERT INTO Users(uidAuthor, sUsername, sEmail, sFullName, sLoginName)

VALUES (a_uidAuthor, a_sUsername, a_sEmail, a_sFullName, a_sLoginName);

END;

$$ LANGUAGE plpgsql;

CREATE OR REPLACE FUNCTION UserAccountLogic_editEntry(a_uidAuthor INTEGER, a_uid INTEGER, a_sUsername TEXT, a_sEmail TEXT,

a_sFullName TEXT, a_sLoginName TEXT)

RETURNS VOID AS $$

BEGIN

PERFORM UserAccountLogic_checkExists(a_uid);

PERFORM UserAccountLogic_checkUniqueUser(a_sUsername, a_sLoginName, a_uid);

PERFORM UserAccountLogic_historizeEntry(a_uid, CURRENT_TIMESTAMP);

INSERT INTO Users (uid, uidAuthor, sUsername, sEmail, sFullName, sLoginName)

VALUES (a_uid, a_uidAuthor, a_sUsername, a_sEmail, a_sFullName, a_sLoginName);

END;

$$ LANGUAGE plpgsql;

CREATE OR REPLACE FUNCTION UserAccountLogic_delEntry(a_uidAuthor INTEGER, a_uid INTEGER) RETURNS VOID AS $$

DECLARE

v_Row Users%ROWTYPE;

v_tsEffective TIMESTAMP WITH TIME ZONE;

BEGIN

--

-- To preserve the information about who deleted the record, we try to

-- add a dummy record which expires immediately. I say try because of

-- the primary key, we must let the new record be valid for 1 us. :-(

--

SELECT * INTO STRICT v_Row

FROM Users

WHERE uid = a_uid

AND tsExpire = 'infinity'::TIMESTAMP;

v_tsEffective := CURRENT_TIMESTAMP - INTERVAL '1 microsecond';

IF v_Row.tsEffective < v_tsEffective THEN

PERFORM UserAccountLogic_historizeEntry(a_uid, v_tsEffective);

v_Row.tsEffective = v_tsEffective;

v_Row.tsExpire = CURRENT_TIMESTAMP;

INSERT INTO Users VALUES (v_Row.*);

ELSE

PERFORM UserAccountLogic_historizeEntry(a_uid, CURRENT_TIMESTAMP);

END IF;

EXCEPTION

WHEN NO_DATA_FOUND THEN

RAISE EXCEPTION 'User with ID % does not currently exist', a_uid;

WHEN TOO_MANY_ROWS THEN

RAISE EXCEPTION 'Integrity error in UserAccounts: Too many current rows for %', a_uid;

END;

$$ LANGUAGE plpgsql;