cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- $Id$
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--- @file
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- VBox Test Manager Database Stored Procedures - UserAccounts.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Copyright (C) 2012-2014 Oracle Corporation
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- This file is part of VirtualBox Open Source Edition (OSE), as
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- available from http://www.virtualbox.org. This file is free software;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- you can redistribute it and/or modify it under the terms of the GNU
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- General Public License (GPL) as published by the Free Software
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Foundation, in version 2 as it comes in the "COPYING" file of the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- VirtualBox OSE distribution. VirtualBox OSE is distributed in the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- The contents of this file may alternatively be used under the terms
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- of the Common Development and Distribution License Version 1.0
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- (CDDL) only, as it comes in the "COPYING.CDDL" file of the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- VirtualBox OSE distribution, in which case the provisions of the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- CDDL are applicable instead of those of the GPL.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- You may elect to license modified versions of this file under the
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- terms and conditions of either the GPL or the CDDL or both.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync\set ON_ERROR_STOP 1
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync\connect testmanager;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync---
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Checks if the user name and login name are unique, ignoring a_uidIgnore.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Raises exception if duplicates are found.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- @internal
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncCREATE OR REPLACE FUNCTION UserAccountLogic_checkUniqueUser(a_sUsername TEXT, a_sLoginName TEXT, a_uidIgnore INTEGER)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RETURNS VOID AS $$
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync DECLARE
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_cRows INTEGER;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync BEGIN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync -- sUserName
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync SELECT COUNT(*) INTO v_cRows
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync FROM Users
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync WHERE sUsername = a_sUsername
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync AND tsExpire = 'infinity'::TIMESTAMP
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync AND uid <> a_uidIgnore;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync IF v_cRows <> 0 THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RAISE EXCEPTION 'Duplicate user name "%" (% times)', a_sUsername, v_cRows;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END IF;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync -- sLoginName
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync SELECT COUNT(*) INTO v_cRows
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync FROM Users
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync WHERE sLoginName = a_sLoginName
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync AND tsExpire = 'infinity'::TIMESTAMP
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync AND uid <> a_uidIgnore;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync IF v_cRows <> 0 THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RAISE EXCEPTION 'Duplicate login name "%" (% times)', a_sUsername, v_cRows;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END IF;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync$$ LANGUAGE plpgsql;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync---
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Check that the user account exists.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Raises exception if it doesn't.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- @internal
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncCREATE OR REPLACE FUNCTION UserAccountLogic_checkExists(a_uid INTEGER) RETURNS VOID AS $$
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync DECLARE
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_cUpdatedRows INTEGER;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync BEGIN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync IF NOT EXISTS( SELECT *
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync FROM Users
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync WHERE uid = a_uid
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync AND tsExpire = 'infinity'::TIMESTAMP ) THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RAISE EXCEPTION 'User with ID % does not currently exist', a_uid;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END IF;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync$$ LANGUAGE plpgsql;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync---
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Historize a row.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- @internal
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncCREATE OR REPLACE FUNCTION UserAccountLogic_historizeEntry(a_uid INTEGER, a_tsExpire TIMESTAMP WITH TIME ZONE)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RETURNS VOID AS $$
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync DECLARE
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_cUpdatedRows INTEGER;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync BEGIN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync UPDATE Users
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync SET tsExpire = a_tsExpire
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync WHERE uid = a_uid
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync AND tsExpire = 'infinity'::TIMESTAMP;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync GET DIAGNOSTICS v_cUpdatedRows = ROW_COUNT;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync IF v_cUpdatedRows <> 1 THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync IF v_cUpdatedRows = 0 THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RAISE EXCEPTION 'User with ID % does not currently exist', a_uid;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END IF;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RAISE EXCEPTION 'Integrity error in UserAccounts: % current rows with uid=%d', v_cUpdatedRows, a_uid;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END IF;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync$$ LANGUAGE plpgsql;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync---
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync-- Adds a new user.
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync--
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncCREATE OR REPLACE FUNCTION UserAccountLogic_addEntry(a_uidAuthor INTEGER, a_sUsername TEXT, a_sEmail TEXT, a_sFullName TEXT,
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync a_sLoginName TEXT)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RETURNS VOID AS $$
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync DECLARE
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_cRows INTEGER;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync BEGIN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync PERFORM UserAccountLogic_checkUniqueUser(a_sUsername, a_sLoginName, -1);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync INSERT INTO Users(uidAuthor, sUsername, sEmail, sFullName, sLoginName)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync VALUES (a_uidAuthor, a_sUsername, a_sEmail, a_sFullName, a_sLoginName);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync$$ LANGUAGE plpgsql;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncCREATE OR REPLACE FUNCTION UserAccountLogic_editEntry(a_uidAuthor INTEGER, a_uid INTEGER, a_sUsername TEXT, a_sEmail TEXT,
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync a_sFullName TEXT, a_sLoginName TEXT)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RETURNS VOID AS $$
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync BEGIN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync PERFORM UserAccountLogic_checkExists(a_uid);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync PERFORM UserAccountLogic_checkUniqueUser(a_sUsername, a_sLoginName, a_uid);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync PERFORM UserAccountLogic_historizeEntry(a_uid, CURRENT_TIMESTAMP);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync INSERT INTO Users (uid, uidAuthor, sUsername, sEmail, sFullName, sLoginName)
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync VALUES (a_uid, a_uidAuthor, a_sUsername, a_sEmail, a_sFullName, a_sLoginName);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync$$ LANGUAGE plpgsql;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsyncCREATE OR REPLACE FUNCTION UserAccountLogic_delEntry(a_uidAuthor INTEGER, a_uid INTEGER) RETURNS VOID AS $$
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync DECLARE
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_Row Users%ROWTYPE;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_tsEffective TIMESTAMP WITH TIME ZONE;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync BEGIN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync --
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync -- To preserve the information about who deleted the record, we try to
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync -- add a dummy record which expires immediately. I say try because of
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync -- the primary key, we must let the new record be valid for 1 us. :-(
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync --
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync SELECT * INTO STRICT v_Row
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync FROM Users
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync WHERE uid = a_uid
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync AND tsExpire = 'infinity'::TIMESTAMP;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_tsEffective := CURRENT_TIMESTAMP - INTERVAL '1 microsecond';
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync IF v_Row.tsEffective < v_tsEffective THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync PERFORM UserAccountLogic_historizeEntry(a_uid, v_tsEffective);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_Row.tsEffective = v_tsEffective;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync v_Row.tsExpire = CURRENT_TIMESTAMP;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync INSERT INTO Users VALUES (v_Row.*);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync ELSE
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync PERFORM UserAccountLogic_historizeEntry(a_uid, CURRENT_TIMESTAMP);
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END IF;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync EXCEPTION
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync WHEN NO_DATA_FOUND THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RAISE EXCEPTION 'User with ID % does not currently exist', a_uid;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync WHEN TOO_MANY_ROWS THEN
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync RAISE EXCEPTION 'Integrity error in UserAccounts: Too many current rows for %', a_uid;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync END;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync$$ LANGUAGE plpgsql;
cf22150eaeeb72431bf1cf65c309a431454fb22bvboxsync