/* 
 * Copyright (c) 2008 Intel Corporation
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * -- Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * -- Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * -- Neither the name of the Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE INTEL OR ITS
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;
using OpenMetaverse;

namespace GridServer
{
    /// <summary>
    /// Response from a call to a backend provider
    /// </summary>
    public enum BackendResponse
    {
        /// <summary>The call succeeded</summary>
        Success,
        /// <summary>The resource requested was not found</summary>
        NotFound,
        /// <summary>A server failure prevented the call from
        /// completing</summary>
        Failure
    }

    public interface IAvatarProvider
    {
        bool SaveAvatar(Avatar avatar);
        bool RemoveAvatar(UUID avatarID);
        bool TryGetAvatar(UUID avatarID, out Avatar avatar);
        bool TryGetAvatar(string firstName, string lastName, out Avatar avatar);
        List<Avatar> AvatarSearch(string searchQuery);

        bool AddAvatarMapping(string loginKey, UUID avatarID);
        bool RemoveAvatarMapping(string loginKey);
        bool TryGetAvatar(string loginKey, out Avatar avatar);

        int ForEach(Action<Avatar> action, int start, int count);
    }

    public interface ISessionProvider
    {
        UUID CreateSession(UUID avatarID);
        bool RemoveSession(UUID authToken);
        bool TryGetAvatar(UUID authToken, out Avatar avatar);
        bool TryGetSession(UUID avatarID, out UUID authToken);

        int CurrentSessionCount();
    }

    public interface IAuthorizationProvider
    {
        bool IsAvatarAuthorized(UUID authToken, UUID avatarID);
        bool IsRegionAuthorized(UUID authToken, UUID regionID);
        bool IsRegionCreateAuthorized(UUID authToken);
        bool IsRegionDeleteAuthorized(UUID authToken, UUID regionID);
    }

    public interface IGridProvider
    {
        BackendResponse TryCreateRegion(Region region);
        BackendResponse TryCreateRegionNearest(Region region);
        BackendResponse TryDeleteRegion(UUID id);
        BackendResponse TryDeleteRegion(uint x, uint y);
        BackendResponse TryFetchRegion(UUID id, out Region region);
        BackendResponse TryFetchRegion(uint x, uint y, out Region region);

        BackendResponse RegionSearch(string query, out List<Region> results);
        int RegionCount();
        int OnlineRegionCount();

        int ForEach(Action<Region> action, int start, int count);
    }
}