/*
* Copyright (c) 2022 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Data
* File: ProtectedEntityExtensions.cs
*
* ProtectedEntityExtensions.cs is part of VNLib.Plugins.Extensions.Data which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Data is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Data 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using VNLib.Utils;
using VNLib.Plugins.Extensions.Data.Abstractions;
namespace VNLib.Plugins.Extensions.Data
{
public static class ProtectedEntityExtensions
{
///
/// Updates the specified record within the store
///
///
/// The record to update
/// The userid of the record owner
/// A task that evaluates to the number of records modified
public static Task UpdateUserRecordAsync(this IDataStore store, TEntity record, string userId) where TEntity : class, IDbModel, IUserEntity
{
record.UserId = userId;
return store.UpdateAsync(record);
}
///
/// Updates the specified record within the store
///
///
/// The record to update
/// The userid of the record owner
/// A task that evaluates to the number of records modified
public static Task CreateUserRecordAsync(this IDataStore store, TEntity record, string userId) where TEntity : class, IDbModel, IUserEntity
{
record.UserId = userId;
return store.CreateAsync(record);
}
///
/// Gets a single entity from its ID and user-id
///
///
/// The unique id of the entity
/// The user's id that owns the resource
/// A task that resolves the entity or null if not found
public static Task GetSingleUserRecordAsync(this IDataStore store, string key, string userId) where TEntity : class, IDbModel, IUserEntity
{
return store.GetSingleAsync(key, userId);
}
///
/// Gets a page by its number offset constrained by its limit,
/// for the given user id
///
///
///
/// The collection to store found records
/// The user to get the page for
/// The page offset
/// The record limit for the page
/// A task that resolves the number of entities added to the collection
public static Task GetUserPageAsync(this IPaginatedDataStore store, ICollection collection, string userId, int page, int limit)
where TEntity : class, IDbModel, IUserEntity
{
return store.GetPageAsync(collection, page, limit, userId);
}
///
/// Deletes a single entiry by its ID only if it belongs to the speicifed user
///
///
/// The unique id of the entity
/// The user's id that owns the resource
/// A task the resolves the number of eneities deleted (should evaluate to true or false)
public static Task DeleteUserRecordAsync(this IDataStore store, string key, string userId) where TEntity : class, IDbModel, IUserEntity
{
return store.DeleteAsync(key, userId);
}
///
/// Gets the record count for the specified userId
///
///
///
/// The unique id of the user to query record count
/// A task that resolves the number of records belonging to the specified user
public static Task GetUserRecordCountAsync(this IDataStore store, string userId) where TEntity : class, IDbModel, IUserEntity
{
return store.GetCountAsync(userId);
}
}
}