Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
refactor: extract SecAgent support into native plugin by PANDAJSR · Pull Request #266 · SECTL/SecRandom · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor: extract SecAgent support into native plugin by PANDAJSR · Pull Request #266 · SECTL/SecRandom · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor: extract SecAgent support into native plugin by PANDAJSR · Pull Request #266 · SECTL/SecRandom · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' refactor: extract SecAgent support into native plugin by PANDAJSR · Pull Request #266 · SECTL/SecRandom · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor: extract SecAgent support into native plugin by PANDAJSR · Pull Request #266 · SECTL/SecRandom · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' refactor: extract SecAgent support into native plugin by PANDAJSR · Pull Request #266 · SECTL/SecRandom · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); refactor: extract SecAgent support into native plugin by PANDAJSR · Pull Request #266 · SECTL/SecRandom · GitHub
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions SecRandom.PluginSdk/IExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.PluginSdk;

/// <summary>
/// Host-neutral student draw boundary for plugins and other external integrations.
/// The transport and authentication policy belong to the integration that consumes it.
/// </summary>
public sealed record ExternalStudentDrawRequest
{
public string Mode { get; init; } = "result_only";
public int Count { get; init; } = 1;
public string Gender { get; init; } = string.Empty;
public IReadOnlyList<string> IncludeTags { get; init; } = [];
public IReadOnlyList<string> ExcludeTags { get; init; } = [];
public IReadOnlyList<string> IncludeIds { get; init; } = [];
public IReadOnlyList<string> IncludeNames { get; init; } = [];
}

public sealed record ExternalStudentDrawResult(
string Mode,
string Status,
string Profile,
IReadOnlyList<Student> Students);

public interface IExternalStudentDrawService
{
Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default);
}
6 changes: 6 additions & 0 deletions SecRandom.PluginSdk/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,6 +32,12 @@ Published plugins reference the SDK package and exclude its runtime assets so th

The repository template defaults `UseLocalPluginSdk=true` so solution builds work before the SDK is published; set `UseLocalPluginSdk=false` with a NuGet source that contains `SecRandom.PluginSdk` to exercise the release packaging path.

## Host integration APIs

`IExternalStudentDrawService` lets a transport plugin request a host-managed student draw
without depending on desktop application's internal service types. The host owns drawing,
temporary records, history, security, and notifications; the plugin owns its transport.

## Building a plugin package

Set `<CreateSrpx>true</CreateSrpx>` to produce `srpx/<ProjectName>.srpx` after every build. The package is a ZIP whose root contains `manifest.yml`, the entrance assembly, and any external package dependencies. Place it in `data/cache/plugin-packages` and restart the desktop application to install.
5 changes: 1 addition & 4 deletions SecRandom/App.axaml.cs
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,7 +59,6 @@
using SecRandom.Services.Music;
using SecRandom.Services.Settings;
using SecRandom.Services.Security;
using SecRandom.Services.SecAgent;
using SecRandom.Services.Telemetry;
using SecRandom.Services.Verification;
using SecRandom.Services.Voice;
Expand DownExpand Up@@ -844,9 +843,7 @@ private void BuildHost(IPlatformServiceRoot platform)
services.AddSingleton<IVoiceAnnouncementService>(serviceProvider =>
serviceProvider.GetRequiredService<VoiceAnnouncementService>());
services.AddSingleton<NotificationService>();
// Local-only REST endpoint for the SecAgent connector. It intentionally has no UI/settings registration.
services.AddHostedService<SecAgentHttpHostedService>();
services.AddHostedService<SecAgentPluginBootstrapHostedService>();
services.AddSingleton<IExternalStudentDrawService, ExternalStudentDrawService>();
services.AddSingleton(serviceProvider => new MusicLibraryService(
serviceProvider.GetRequiredService<MainConfigHandler>(),
serviceProvider.GetRequiredService<ILogger<MusicLibraryService>>(),
Expand Down
148 changes: 148 additions & 0 deletions SecRandom/Services/Draw/ExternalStudentDrawService.cs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using SecRandom.Core.Abstraction.Services;
using SecRandom.Core.Enums;
using SecRandom.Core.Enums.Configs;
using SecRandom.Core.Models.Draw;
using SecRandom.Core.Services.Config;
using SecRandom.Core.Services.Draw;
using SecRandom.PluginSdk;
using SecRandom.Services.Linkage;
using SecRandom.Services.Notification;
using SecRandom.Shared.Extensions;
using SecRandom.Shared.Models.Profile;

namespace SecRandom.Services.Draw;

/// <summary>
/// Implements the host-neutral external student draw boundary.
/// Transport-specific integrations, such as the SecAgent plugin, call this service.
/// </summary>
public sealed class ExternalStudentDrawService(
IProfileService profileService,
MainConfigHandler configHandler,
IDrawTemporaryRecordService temporaryRecordService,
DrawEngine drawEngine,
LinkageDrawCoordinator linkageDrawCoordinator,
NotificationService notificationService) : IExternalStudentDrawService
{
public async Task<ExternalStudentDrawResult> DrawAsync(
ExternalStudentDrawRequest request,
CancellationToken cancellationToken = default)
{
if (request.Mode is not ("flash" or "result_only"))
throw new ArgumentException("mode must be flash or result_only.", nameof(request));

var requestedCount = Math.Clamp(request.Count, 1, 100);
if (request.Mode == "flash")
requestedCount = 1;

var gender = request.Gender?.Trim() ?? string.Empty;
var listName = profileService.CurrentStudentList?.Name ?? string.Empty;
var temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
var hasMatchingStudents = (profileService.CurrentStudentList?.Students ?? [])
.Any(student => student.IsCandidate && Matches(student, gender, request));
var mayResetExhaustedRound = configHandler.Data.QuickDrawSettings.DrawMode != DrawMode.Repeat
&& hasMatchingStudents;

var result = await InvokeAuthorizedAsync(
SecurityOperation.QuickDrawStart,
async () =>
{
DrawResult<Student> DrawFromRemainingStudents()
=> drawEngine.DrawStudent(
requestedCount,
student => Matches(student, gender, request)
&& !HasReachedTemporaryLimit(student, temporaryCounts),
DrawSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName());

var draw = DrawFromRemainingStudents();
if (!draw.IsSuccess
&& mayResetExhaustedRound
&& draw.Status == DrawStatus.RepeatLimitExhausted)
{
profileService.ClearCurrentStudentHistory();
temporaryRecordService.ResetStudentList(listName);
temporaryCounts = temporaryRecordService.GetStudentCounts(listName, gender, string.Empty);
draw = DrawFromRemainingStudents();
}

if (!draw.IsSuccess || draw.Result.Count == 0)
return draw;

profileService.RecordStudentHistory(
draw.Result,
DateTime.Now,
requestedCount,
drawMethod: (int)configHandler.Data.QuickDrawSettings.DrawType,
courseName: linkageDrawCoordinator.GetCourseName());
temporaryRecordService.RecordStudents(listName, gender, string.Empty, draw.Result);
if (request.Mode == "flash")
notificationService.QueueStudents(
NotificationSettingsType.QuickDraw,
linkageDrawCoordinator.GetCourseName(),
draw.Result);
return draw;
},
cancellationToken).ConfigureAwait(false);

return new ExternalStudentDrawResult(
request.Mode,
result.Status.ToString(),
listName,
result.Result);
}

private async Task<DrawResult<Student>> InvokeAuthorizedAsync(
SecurityOperation operation,
Func<Task<DrawResult<Student>>> action,
CancellationToken cancellationToken)
{
DrawResult<Student>? result = null;
var authorized = await linkageDrawCoordinator.AuthorizeAsync(
operation,
async () => result = await action().ConfigureAwait(false),
cancellationToken).ConfigureAwait(false);
return authorized && result is not null
? result
: new DrawResult<Student> { Status = DrawStatus.Failure };
}

private bool HasReachedTemporaryLimit(
Student student,
IReadOnlyDictionary<string, int> temporaryCounts)
{
var settings = configHandler.Data.QuickDrawSettings;
var threshold = settings.DrawMode switch
{
DrawMode.Repeat => 0,
DrawMode.NoRepeat => 1,
DrawMode.HalfRepeat => Math.Max(1, settings.HalfRepeat),
_ => 1
};
return threshold > 0
&& temporaryCounts.GetValueOrDefault(ProfileRecordIdentity.EnsureRecordId(student)) >= threshold;
}

private static bool Matches(
Student student,
string gender,
ExternalStudentDrawRequest request)
{
var tags = student.Tags.Split(
[',', ';', ' '],
StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
return (string.IsNullOrWhiteSpace(gender)
|| string.Equals(student.Gender, gender, StringComparison.OrdinalIgnoreCase))
&& request.IncludeTags.All(tag => tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& request.ExcludeTags.All(tag => !tags.Contains(tag, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeIds.Count == 0
|| request.IncludeIds.Contains(student.Id, StringComparer.OrdinalIgnoreCase))
&& (request.IncludeNames.Count == 0
|| request.IncludeNames.Contains(student.Name, StringComparer.OrdinalIgnoreCase));
}
}
Loading
Loading