153 lines
7.9 KiB
C#
153 lines
7.9 KiB
C#
using ZB.MOM.WW.ScadaBridge.Commons.Entities.Sites;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Repositories;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Interfaces.Services;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.TemplateEngine.Services;
|
|
|
|
/// <summary>
|
|
/// Site and data connection management.
|
|
/// - Site CRUD (name, identifier, description)
|
|
/// - Data connection CRUD (name, protocol, config) — each connection belongs to exactly one site
|
|
/// - Audit logging
|
|
/// </summary>
|
|
public class SiteService
|
|
{
|
|
private readonly ISiteRepository _repository;
|
|
private readonly IAuditService _auditService;
|
|
|
|
/// <summary>Initializes the service with its repository and audit collaborators.</summary>
|
|
/// <param name="repository">Repository for site and data connection persistence.</param>
|
|
/// <param name="auditService">Audit service for logging CRUD operations.</param>
|
|
public SiteService(ISiteRepository repository, IAuditService auditService)
|
|
{
|
|
_repository = repository ?? throw new ArgumentNullException(nameof(repository));
|
|
_auditService = auditService ?? throw new ArgumentNullException(nameof(auditService));
|
|
}
|
|
|
|
// --- Site CRUD ---
|
|
|
|
/// <summary>Creates a new site with the given name and identifier, rejecting duplicates.</summary>
|
|
/// <param name="name">Display name of the site.</param>
|
|
/// <param name="siteIdentifier">Unique machine-readable site identifier.</param>
|
|
/// <param name="description">Optional description.</param>
|
|
/// <param name="user">Authenticated username for audit logging.</param>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>A successful result containing the new <see cref="Site"/>, or a failure result with a message.</returns>
|
|
public async Task<Result<Site>> CreateSiteAsync(
|
|
string name, string siteIdentifier, string? description, string user,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
if (string.IsNullOrWhiteSpace(name))
|
|
return Result<Site>.Failure("Site name is required.");
|
|
if (string.IsNullOrWhiteSpace(siteIdentifier))
|
|
return Result<Site>.Failure("Site identifier is required.");
|
|
|
|
var existing = await _repository.GetSiteByIdentifierAsync(siteIdentifier, cancellationToken);
|
|
if (existing != null)
|
|
return Result<Site>.Failure($"Site with identifier '{siteIdentifier}' already exists.");
|
|
|
|
var site = new Site(name, siteIdentifier) { Description = description };
|
|
await _repository.AddSiteAsync(site, cancellationToken);
|
|
await _repository.SaveChangesAsync(cancellationToken);
|
|
|
|
await _auditService.LogAsync(user, "Create", "Site", site.Id.ToString(), name, site, cancellationToken);
|
|
|
|
return Result<Site>.Success(site);
|
|
}
|
|
|
|
/// <summary>Updates the name and description of an existing site.</summary>
|
|
/// <param name="siteId">Primary key of the site to update.</param>
|
|
/// <param name="name">New display name.</param>
|
|
/// <param name="description">New optional description.</param>
|
|
/// <param name="user">Authenticated username for audit logging.</param>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>A successful result containing the updated <see cref="Site"/>, or a failure result if not found.</returns>
|
|
public async Task<Result<Site>> UpdateSiteAsync(
|
|
int siteId, string name, string? description, string user,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
var site = await _repository.GetSiteByIdAsync(siteId, cancellationToken);
|
|
if (site == null)
|
|
return Result<Site>.Failure($"Site with ID {siteId} not found.");
|
|
|
|
site.Name = name;
|
|
site.Description = description;
|
|
await _repository.UpdateSiteAsync(site, cancellationToken);
|
|
await _repository.SaveChangesAsync(cancellationToken);
|
|
|
|
await _auditService.LogAsync(user, "Update", "Site", site.Id.ToString(), name, site, cancellationToken);
|
|
|
|
return Result<Site>.Success(site);
|
|
}
|
|
|
|
/// <summary>Deletes a site, rejecting the request if any instances are assigned to it.</summary>
|
|
/// <param name="siteId">Primary key of the site to delete.</param>
|
|
/// <param name="user">Authenticated username for audit logging.</param>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>A successful result with <c>true</c>, or a failure result with a message if blocked.</returns>
|
|
public async Task<Result<bool>> DeleteSiteAsync(int siteId, string user, CancellationToken cancellationToken = default)
|
|
{
|
|
var site = await _repository.GetSiteByIdAsync(siteId, cancellationToken);
|
|
if (site == null)
|
|
return Result<bool>.Failure($"Site with ID {siteId} not found.");
|
|
|
|
// Check for instances assigned to this site
|
|
var instances = await _repository.GetInstancesBySiteIdAsync(siteId, cancellationToken);
|
|
if (instances.Count > 0)
|
|
{
|
|
var names = string.Join(", ", instances.Select(i => i.UniqueName).Take(5));
|
|
return Result<bool>.Failure(
|
|
$"Cannot delete site '{site.Name}': {instances.Count} instance(s) are assigned to it ({names}{(instances.Count > 5 ? "..." : "")}).");
|
|
}
|
|
|
|
await _repository.DeleteSiteAsync(siteId, cancellationToken);
|
|
await _repository.SaveChangesAsync(cancellationToken);
|
|
|
|
await _auditService.LogAsync(user, "Delete", "Site", siteId.ToString(), site.Name, null, cancellationToken);
|
|
|
|
return Result<bool>.Success(true);
|
|
}
|
|
|
|
/// <summary>Returns the site with the given primary key, or <c>null</c> if not found.</summary>
|
|
/// <param name="siteId">Primary key of the site.</param>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>A task that resolves to the matching <see cref="Site"/>, or <c>null</c> if not found.</returns>
|
|
public async Task<Site?> GetSiteByIdAsync(int siteId, CancellationToken cancellationToken = default) =>
|
|
await _repository.GetSiteByIdAsync(siteId, cancellationToken);
|
|
|
|
/// <summary>Returns all sites.</summary>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>A task that resolves to the complete list of all sites.</returns>
|
|
public async Task<IReadOnlyList<Site>> GetAllSitesAsync(CancellationToken cancellationToken = default) =>
|
|
await _repository.GetAllSitesAsync(cancellationToken);
|
|
|
|
// --- Data Connection CRUD ---
|
|
|
|
// Create/update of data connections deliberately live only in the Management
|
|
// Service, which audits the secret-scrubbed public shape. The SiteService versions
|
|
// (no production callers) audited the raw entity — Primary/BackupConfiguration can
|
|
// embed protocol credentials — and were removed (review 2026-10-21 08/C1).
|
|
|
|
/// <summary>Deletes a data connection by its primary key.</summary>
|
|
/// <param name="connectionId">Primary key of the data connection to delete.</param>
|
|
/// <param name="user">Authenticated username for audit logging.</param>
|
|
/// <param name="cancellationToken">Cancellation token.</param>
|
|
/// <returns>A successful result with <c>true</c>, or a failure result if not found.</returns>
|
|
public async Task<Result<bool>> DeleteDataConnectionAsync(
|
|
int connectionId, string user, CancellationToken cancellationToken = default)
|
|
{
|
|
var connection = await _repository.GetDataConnectionByIdAsync(connectionId, cancellationToken);
|
|
if (connection == null)
|
|
return Result<bool>.Failure($"Data connection with ID {connectionId} not found.");
|
|
|
|
await _repository.DeleteDataConnectionAsync(connectionId, cancellationToken);
|
|
await _repository.SaveChangesAsync(cancellationToken);
|
|
|
|
await _auditService.LogAsync(user, "Delete", "DataConnection",
|
|
connectionId.ToString(), connection.Name, null, cancellationToken);
|
|
|
|
return Result<bool>.Success(true);
|
|
}
|
|
}
|