8 Commits

Author SHA1 Message Date
edc718b1f9 Доработан обработчик команд. Добавлена публикация команд
All checks were successful
CI / build-test (push) Successful in 31s
Release / pack-and-publish (release) Successful in 35s
2025-12-07 10:09:59 +03:00
8af03fa52b исправлена подпись
All checks were successful
CI / build-test (push) Successful in 30s
Release / pack-and-publish (release) Successful in 31s
2025-12-07 08:41:03 +03:00
d6f54bb0e6 Добавлен вывод кнопок для файлов
All checks were successful
CI / build-test (push) Successful in 31s
Release / pack-and-publish (release) Successful in 31s
2025-12-07 08:26:45 +03:00
db122e8aef Добавлено редактирование сообщений. Убран прогресс
All checks were successful
CI / build-test (push) Successful in 52s
Release / pack-and-publish (release) Successful in 46s
2025-12-06 09:15:00 +03:00
fce6e8d013 Добавлено скрытие Reply клавиатуры
All checks were successful
CI / build-test (push) Successful in 35s
Release / pack-and-publish (release) Successful in 34s
2025-12-06 08:36:04 +03:00
57b3706241 Выделены отдельные расширения
All checks were successful
CI / build-test (push) Successful in 29s
Release / pack-and-publish (release) Successful in 32s
2025-12-06 07:52:01 +03:00
f9584c5afe доработка роутинга
All checks were successful
CI / build-test (push) Successful in 48s
Release / pack-and-publish (release) Successful in 34s
2025-12-06 07:31:59 +03:00
07df710ce6 Добавлено автоматические заполнение маршрутов для страниц 2025-12-06 07:31:18 +03:00
22 changed files with 458 additions and 241 deletions

View File

@@ -9,35 +9,39 @@ namespace BotPages.Core.Abstractions;
/// </summary> /// </summary>
public interface IMessengerAdapter public interface IMessengerAdapter
{ {
/// <summary>
/// Доступные возможности мессенджера.
/// </summary>
Capabilities Capabilities { get; } Capabilities Capabilities { get; }
/// <summary> /// <summary>
/// Отправить текстовое сообщение в чат. /// Отправить текстовое сообщение в чат.
/// </summary> /// </summary>
Task SendTextAsync(string chatId, string text, MessageFormat format, Task<string?> SendTextAsync(string chatId,
IEnumerable<IEnumerable<InlineButton>>? inline, string text,
IEnumerable<IEnumerable<ReplyButton>>? reply, CancellationToken ct); MessageFormat format = MessageFormat.Plain,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
string? messageId = null,
CancellationToken ct = default
);
/// <summary> /// <summary>
/// Отправить файл в чат. /// Отправить файл в чат.
/// </summary> /// </summary>
Task SendFileAsync(string chatId, FileDescriptor file, string? caption, MessageFormat? captionFormat, CancellationToken ct); Task SendFileAsync(string chatId,
FileDescriptor file,
string? caption = null,
MessageFormat? captionFormat = null,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
CancellationToken ct = default);
/// <summary> /// <summary>
/// Создать билдер альбома для отправки медиагруппы. /// Создать билдер альбома для отправки медиагруппы.
/// </summary> /// </summary>
IAlbumBuilder CreateAlbumBuilder(PageContext ctx); IAlbumBuilder CreateAlbumBuilder(PageContext ctx);
/// <summary>
/// Начать отображение прогресса операции.
/// </summary>
Task<string?> StartProgressAsync(PageContext ctx, string title, CancellationToken ct);
/// <summary>
/// Обновить прогресс операции.
/// </summary>
Task UpdateProgressAsync(PageContext ctx, string messageId, string title, int percent, CancellationToken ct);
/// <summary> /// <summary>
/// Вызывается при выходе со страницы. /// Вызывается при выходе со страницы.
/// </summary> /// </summary>
@@ -55,5 +59,5 @@ public interface IMessangerAdapterSetup : IMessengerAdapter
/// <param name="onUpdate"></param> /// <param name="onUpdate"></param>
/// <param name="ct"></param> /// <param name="ct"></param>
/// <returns></returns> /// <returns></returns>
Task StartAdapterAsync(Func<UpdateContext, Task> onUpdate, CancellationToken ct); Task StartAdapterAsync(Func<UpdateContext, Task> onUpdate, List<Routing.Command> commands, CancellationToken ct);
} }

View File

@@ -4,6 +4,7 @@ using BotPages.Core.Abstractions;
using BotPages.Core.Context; using BotPages.Core.Context;
using BotPages.Core.Logging; using BotPages.Core.Logging;
using BotPages.Core.Routing; using BotPages.Core.Routing;
using System.Reflection;
/// <summary> /// <summary>
/// Основное приложение BotPages. /// Основное приложение BotPages.
@@ -68,16 +69,34 @@ public sealed class BotPagesApp
/// </summary> /// </summary>
public BotPagesApp MapCommand<TPage>(string commandTemplate) where TPage : Page public BotPagesApp MapCommand<TPage>(string commandTemplate) where TPage : Page
{ {
_commands.Map<TPage>(commandTemplate); _commands.Map<TPage>(commandTemplate, false, null);
return this;
}
/// <summary>
/// Зарегистрировать команду, ведущую на страницу.
/// </summary>
public BotPagesApp MapCommand<TPage>(string commandTemplate, bool publish, string description) where TPage : Page
{
_commands.Map<TPage>(commandTemplate, publish, description);
return this; return this;
} }
/// <summary> /// <summary>
/// Зарегистрировать команду с кастомным обработчиком. /// Зарегистрировать команду с кастомным обработчиком.
/// </summary> /// </summary>
public BotPagesApp MapCommand(string template, Func<PageContext, CancellationToken, Task> handler) public BotPagesApp MapCommand(string template, CommandHandler handler)
{ {
_commands.Map(template, handler); _commands.Map(template, handler, false, null);
return this;
}
/// <summary>
/// Зарегистрировать команду с кастомным обработчиком.
/// </summary>
public BotPagesApp MapCommand(string template, CommandHandler handler, bool publish, string description)
{
_commands.Map(template, handler, publish, description);
return this; return this;
} }
@@ -90,6 +109,45 @@ public sealed class BotPagesApp
return this; return this;
} }
/// <summary>
/// Зарегистрировать все маршруты для страницы.
/// Маршрутом является <see cref="RouteAttribute"/>.
/// Так же берется полное название класса.
/// </summary>
public BotPagesApp AutoMapRoute()
{
// Берём все загруженные сборки в текущем AppDomain
var assemblies = AppDomain.CurrentDomain.GetAssemblies();
// Находим все типы, которые наследуются от Page
var pageTypes = assemblies
.SelectMany(a =>
{
try
{
return a.GetTypes();
}
catch (ReflectionTypeLoadException ex)
{
// Если часть типов не загрузилась — берём только успешные
return ex.Types.Where(t => t != null)!;
}
})
.Where(t => t != null
&& t.IsClass
&& !t.IsAbstract
&& t.IsSubclassOf(typeof(Page)))
.ToList();
// Выводим полные имена
foreach (var type in pageTypes)
{
_routes.Map(type);
}
return this;
}
/// <summary> /// <summary>
/// Обработать входящее обновление. /// Обработать входящее обновление.
/// </summary> /// </summary>
@@ -102,7 +160,6 @@ public sealed class BotPagesApp
{ {
if (_commands.TryDispatch(ctx, update.Text, ct, out var dispatched) && dispatched is not null) if (_commands.TryDispatch(ctx, update.Text, ct, out var dispatched) && dispatched is not null)
{ {
_logger.Log(LogLevel.Info, $"Command '{update.Text}' dispatched.");
await dispatched; await dispatched;
return; return;
} }
@@ -161,7 +218,7 @@ public sealed class BotPagesApp
if (page is null) if (page is null)
{ {
await ctx.Navigation.GoToHome(ctx, ct); await ctx.Navigation.GoToHomeAsync(ctx, ct);
return; return;
} }
@@ -197,7 +254,7 @@ public sealed class BotPagesApp
{ {
foreach (var adapter in _adapterFactory.Adapters) foreach (var adapter in _adapterFactory.Adapters)
{ {
await adapter.Value.StartAdapterAsync(update => HandleUpdateAsync(update, cancellationToken), cancellationToken); await adapter.Value.StartAdapterAsync(update => HandleUpdateAsync(update, cancellationToken), _commands.Commands, cancellationToken);
} }
} }
} }

View File

@@ -22,93 +22,9 @@ public sealed class PageContext
/// <summary>Адаптер мессенджера.</summary> /// <summary>Адаптер мессенджера.</summary>
public required IMessengerAdapter Adapter { get; init; } public required IMessengerAdapter Adapter { get; init; }
//Storage
/// <summary>Получить состояние по ключу.</summary>
public Task<T?> GetStorageAsync<T>(string key, CancellationToken ct)
=> StateStorage.GetAsync<T>(SessionKey, key, ct);
/// <summary>Сохранить состояние по ключу.</summary>
public Task SetStorageAsync<T>(string key, T state, CancellationToken ct)
=> StateStorage.SetAsync<T>(SessionKey, key, state, ct);
/// <summary>Удалить состояние по ключу.</summary>
public Task<bool> RemoveStorageAsync(string key, CancellationToken ct)
=> StateStorage.RemoveAsync(SessionKey, key, ct);
/// <summary>Удалить все состояния по ключу.</summary>
public Task<bool> ClearStorageAsync(CancellationToken ct)
=> StateStorage.ClearAsync(SessionKey, ct);
//Adapter
/// <summary>
/// Отправить текстовое сообщение.
/// </summary>
public Task SendTextAsync(string text, MessageFormat format = MessageFormat.Plain,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
CancellationToken ct = default)
=> Adapter.SendTextAsync(this.Update.Chat.Id, text, format, inline, reply, ct);
/// <summary>
/// Отправить файл.
/// </summary>
public Task SendFileAsync(FileDescriptor file, string? caption = null, MessageFormat? captionFormat = null, CancellationToken ct = default)
=> Adapter.SendFileAsync(this.Update.Chat.Id, file, caption, captionFormat, ct);
/// <summary>
/// Отправить файл.
/// </summary>
public Task SendFileAsync(FileDescriptor file, string? caption = null, CancellationToken ct = default)
=> Adapter.SendFileAsync(this.Update.Chat.Id, file, caption, null, ct);
/// <summary> /// <summary>
/// Получить билдер альбомов. /// Получить билдер альбомов.
/// </summary> /// </summary>
public IAlbumBuilder Albums => Adapter.CreateAlbumBuilder(this); public IAlbumBuilder Albums => Adapter.CreateAlbumBuilder(this);
/// <summary>
/// Начать прогресс операции.
/// </summary>
public async Task<string?> StartProgressAsync(string title, CancellationToken ct)
{
var messageId = await Adapter.StartProgressAsync(this, title, ct);
if (messageId != null)
{
_progressMessageId = messageId;
_progressTitle = title;
}
return messageId;
}
/// <summary>
/// Обновить прогресс операции.
/// </summary>
public Task UpdateProgressAsync(int percent, CancellationToken ct)
{
if (_progressMessageId != null)
{
return Adapter.UpdateProgressAsync(this, _progressMessageId, _progressTitle ?? "", percent, ct);
}
else
{
return Task.CompletedTask;
}
}
/// <summary>
/// Обновить прогресс операции.
/// </summary>
public Task UpdateProgressAsync(string messageId, int percent, CancellationToken ct)
{
return Adapter.UpdateProgressAsync(this, messageId, _progressTitle ?? "", percent, ct);
}
private string? _progressMessageId = null;
private string? _progressTitle = null;
} }

View File

@@ -0,0 +1,41 @@
using BotPages.Core.Abstractions;
using BotPages.Core.Messaging;
namespace BotPages.Core;
/// <summary>
/// Расширения <see cref="PageContext"/> для работы с <see cref="IMessengerAdapter"/>
/// </summary>
public static class PageContextAdapterExtensions
{
/// <summary>
/// Отправить текстовое сообщение.
/// </summary>
public static Task<string?> SendTextAsync(this PageContext ctx,
string text,
MessageFormat format = MessageFormat.Plain,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
string? messageId = null,
CancellationToken ct = default)
=> ctx.Adapter.SendTextAsync(ctx.Update.Chat.Id, text, format, inline, reply, messageId, ct);
/// <summary>
/// Отправить файл.
/// </summary>
public static Task SendFileAsync(this PageContext ctx,
FileDescriptor file,
string? caption = null,
MessageFormat? captionFormat = null,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
CancellationToken ct = default
)
=> ctx.Adapter.SendFileAsync(chatId: ctx.Update.Chat.Id,
file: file,
caption: caption,
captionFormat: captionFormat,
inline: inline,
reply: reply,
ct: ct);
}

View File

@@ -0,0 +1,38 @@
namespace BotPages.Core;
/// <summary>
/// Расширения <see cref="PageContext"/> для работы с <see cref="NavigationService"/>
/// </summary>
public static class PageContextNavigationExtensions
{
/// <summary>
/// Перейти по маршруту без аргументов.
/// </summary>
public static Task GoToHomeAsync(this PageContext ctx, CancellationToken ct)
=> ctx.Navigation.GoToHomeAsync(ctx, ct);
/// <summary>
/// Перейти по маршруту без аргументов.
/// </summary>
public static Task GoToAsync(this PageContext ctx, string route, CancellationToken ct)
=> ctx.Navigation.GoToAsync(route, ctx, ct);
/// <summary>
/// Перейти по маршруту с аргументами.
/// </summary>
public static Task GoToAsync<TArgs>(this PageContext ctx, string route, TArgs args, CancellationToken ct)
=> ctx.Navigation.GoToAsync<TArgs>(route, args, ctx, ct);
/// <summary>
/// Перейти на страницу без аргументов.
/// </summary>
public static Task GoToAsync<TPage>(this PageContext ctx, CancellationToken ct) where TPage : Page
=> ctx.Navigation.GoToAsync<TPage>(ctx, ct);
/// <summary>
/// Перейти на страницу с аргументами.
/// </summary>
public static Task GoToAsync<TPage, TArgs>(this PageContext ctx, TArgs args, CancellationToken ct) where TPage : StatefullPage<TArgs>
=> ctx.Navigation.GoToAsync<TPage, TArgs>(ctx, args!, ct);
}

View File

@@ -0,0 +1,26 @@
using BotPages.Core.Abstractions;
namespace BotPages.Core;
/// <summary>
/// Расширения <see cref="PageContext"/> для работы с <see cref="IStateStorage"/>
/// </summary>
public static class PageContextStorageExtensions
{
/// <summary>Получить состояние по ключу.</summary>
public static Task<T?> GetStorageAsync<T>(this PageContext ctx, string key, CancellationToken ct)
=> ctx.StateStorage.GetAsync<T>(ctx.SessionKey, key, ct);
/// <summary>Сохранить состояние по ключу.</summary>
public static Task SetStorageAsync<T>(this PageContext ctx, string key, T state, CancellationToken ct)
=> ctx.StateStorage.SetAsync<T>(ctx.SessionKey, key, state, ct);
/// <summary>Удалить состояние по ключу.</summary>
public static Task<bool> RemoveStorageAsync(this PageContext ctx, string key, CancellationToken ct)
=> ctx.StateStorage.RemoveAsync(ctx.SessionKey, key, ct);
/// <summary>Удалить все состояния по ключу.</summary>
public static Task<bool> ClearStorageAsync(this PageContext ctx, CancellationToken ct)
=> ctx.StateStorage.ClearAsync(ctx.SessionKey, ct);
}

View File

@@ -14,9 +14,8 @@ public sealed class MessageBuilder
private readonly List<List<ReplyButton>> _reply = new(); private readonly List<List<ReplyButton>> _reply = new();
private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _files = new(); private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _files = new();
private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _album = new(); private readonly List<(FileDescriptor file, string? caption, MessageFormat? captionFormat)> _album = new();
private string? _progressTitle = null; private bool _disableReplyKeyboard;
private int? _progressPercent = null; private string? _editMessageId = null;
private string? _progressMessageId = null;
/// <summary>Создать билдер сообщений.</summary> /// <summary>Создать билдер сообщений.</summary>
public MessageBuilder(PageContext ctx) => _ctx = ctx; public MessageBuilder(PageContext ctx) => _ctx = ctx;
@@ -29,6 +28,13 @@ public sealed class MessageBuilder
return this; return this;
} }
/// <summary>Редактировать сообщение.</summary>
public MessageBuilder EditMessage(string messagId)
{
_editMessageId = messagId;
return this;
}
/// <summary>Добавить inlineкнопку.</summary> /// <summary>Добавить inlineкнопку.</summary>
public MessageBuilder Inline(string label, string value) public MessageBuilder Inline(string label, string value)
{ {
@@ -64,9 +70,20 @@ public sealed class MessageBuilder
return this; return this;
} }
/// <summary>
/// Отключение Reply клавиатуры.
/// </summary>
/// <returns></returns>
public MessageBuilder DisableReply()
{
_disableReplyKeyboard = true;
return this;
}
/// <summary>Добавить replyкнопку.</summary> /// <summary>Добавить replyкнопку.</summary>
public MessageBuilder Reply(params ReplyButton[] label) public MessageBuilder Reply(params ReplyButton[] label)
{ {
_disableReplyKeyboard = false;
_reply.Add(label.ToList()); _reply.Add(label.ToList());
return this; return this;
} }
@@ -74,6 +91,7 @@ public sealed class MessageBuilder
/// <summary>Добавить строку replyкнопок.</summary> /// <summary>Добавить строку replyкнопок.</summary>
public MessageBuilder Reply(IEnumerable<ReplyButton> row) public MessageBuilder Reply(IEnumerable<ReplyButton> row)
{ {
_disableReplyKeyboard = false;
_reply.Add(row.ToList()); _reply.Add(row.ToList());
return this; return this;
} }
@@ -81,6 +99,7 @@ public sealed class MessageBuilder
/// <summary>Добавить строку replyкнопок.</summary> /// <summary>Добавить строку replyкнопок.</summary>
public MessageBuilder Reply(IEnumerable<IEnumerable<ReplyButton>> row) public MessageBuilder Reply(IEnumerable<IEnumerable<ReplyButton>> row)
{ {
_disableReplyKeyboard = false;
_reply.AddRange(row.Select(t => t.ToList()).ToList()); _reply.AddRange(row.Select(t => t.ToList()).ToList());
return this; return this;
} }
@@ -99,26 +118,30 @@ public sealed class MessageBuilder
return this; return this;
} }
/// <summary>Установить прогресс операции.</summary>
public MessageBuilder Progress(string title, int percent = 0)
{
_progressTitle = title;
_progressPercent = percent;
return this;
}
/// <summary>Отправить собранное сообщение.</summary> /// <summary>Отправить собранное сообщение.</summary>
public async Task SendAsync(CancellationToken ct = default) public async Task<string?> SendAsync(CancellationToken ct = default)
{ {
string? messageId = null;
List<List<ReplyButton>>? reply = null;
if (_disableReplyKeyboard) reply = new();
else if (_reply.Any()) reply = _reply;
// Текст // Текст
if (!string.IsNullOrWhiteSpace(_text)) if (!string.IsNullOrWhiteSpace(_text))
{ {
await _ctx.SendTextAsync(_text, _format, _inline, _reply, ct); messageId = await _ctx.SendTextAsync(_text, _format, _inline, reply, _editMessageId, ct);
} }
// Файлы // Файлы
foreach (var (file, caption, captionFormat) in _files) foreach (var (file, caption, captionFormat) in _files)
await _ctx.SendFileAsync(file, caption, captionFormat, ct); await _ctx.SendFileAsync(file: file
, caption: caption
, captionFormat: captionFormat
, reply: reply
, inline: _inline
, ct: ct
);
// Альбом // Альбом
if (_album.Count > 0) if (_album.Count > 0)
@@ -129,25 +152,12 @@ public sealed class MessageBuilder
await builder.SendAsync(ct); await builder.SendAsync(ct);
} }
// Прогресс
if (_progressTitle is not null)
{
if (_progressMessageId is null)
_progressMessageId = await _ctx.StartProgressAsync(_progressTitle, ct);
if (_progressPercent > 0 && !string.IsNullOrEmpty(_progressMessageId))
await _ctx.UpdateProgressAsync(_progressMessageId, _progressPercent.Value, ct);
}
_text = null; _text = null;
_files.Clear(); _files.Clear();
_album.Clear(); _album.Clear();
if (_progressPercent >= 100) _editMessageId = null;
{
_progressTitle = null; return messageId;
_progressMessageId = null;
_progressPercent = null;
}
} }
} }

View File

@@ -31,7 +31,7 @@ public sealed class NavigationService
/// <summary> /// <summary>
/// Перейти по маршруту без аргументов. /// Перейти по маршруту без аргументов.
/// </summary> /// </summary>
public Task GoToHome(PageContext ctx, CancellationToken ct) public Task GoToHomeAsync(PageContext ctx, CancellationToken ct)
{ {
return NavigateAsync(_defaultPage!, ctx, null, ct); return NavigateAsync(_defaultPage!, ctx, null, ct);
} }

View File

@@ -0,0 +1,34 @@
namespace BotPages.Core.Routing;
using System.Text.RegularExpressions;
/// <summary>
/// Команда действий. Например "/start"
/// </summary>
public class Command
{
/// <summary>
/// Название команды.
/// </summary>
public required string Name { get; init; }
/// <summary>
/// Шаблон команды.
/// </summary>
public required Regex Pattern { get; init; }
/// <summary>
/// Обработчик команды.
/// </summary>
public required CommandHandler Handler { get; init; }
/// <summary>
/// Описание команды.
/// </summary>
public string? Description { get; init; }
/// <summary>
/// Публичный? нужно ли регистрировать в боте.
/// </summary>
public required bool Publish { get; init; }
}

View File

@@ -0,0 +1,12 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace BotPages.Core.Routing;
/// <summary>
/// Обработчик команды: получает контекст страницы, аргументы команды и токен отмены.
/// </summary>
public delegate Task CommandHandler(PageContext context, IReadOnlyDictionary<string, string>? args, CancellationToken cancellationToken);

View File

@@ -2,30 +2,40 @@
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
/// <summary> /// <summary>
/// Реестр команд, доступных из любого места. /// Реестр команд, доступных из любого места.
/// </summary> /// </summary>
internal sealed class CommandsRegistry internal sealed class CommandsRegistry
{ {
private readonly List<(Regex pattern, Func<PageContext, CancellationToken, Task> handler)> _commands = new(); private readonly List<Command> _commands = new();
public List<Command> Commands => _commands;
/// <summary> /// <summary>
/// Зарегистрировать команду, ведущую на страницу. /// Зарегистрировать команду, ведущую на страницу.
/// </summary> /// </summary>
public CommandsRegistry Map<TPage>(string commandTemplate) where TPage : Page public CommandsRegistry Map<TPage>(string commandTemplate, bool publish = false, string? description = null) where TPage : Page
{ {
var pattern = ToRegex(commandTemplate); var pattern = ToRegex(commandTemplate);
_commands.Add((pattern, (ctx, ct) => ctx.Navigation.GoToAsync<TPage>(ctx, ct)));
return this; return Map(commandTemplate, (ctx, args, ct) => ctx.Navigation.GoToAsync<TPage>(ctx, ct), publish, description);
} }
/// <summary> /// <summary>
/// Зарегистрировать команду с кастомным обработчиком. /// Зарегистрировать команду с кастомным обработчиком.
/// </summary> /// </summary>
public CommandsRegistry Map(string commandTemplate, Func<PageContext, CancellationToken, Task> handler) public CommandsRegistry Map(string commandTemplate, CommandHandler handler, bool publish = false, string? description = null)
{ {
var pattern = ToRegex(commandTemplate); var pattern = ToRegex(commandTemplate);
_commands.Add((pattern, handler)); _commands.Add(new Command()
{
Name = ToCommandName(commandTemplate),
Pattern = pattern,
Handler = handler,
Publish = publish,
Description = string.IsNullOrWhiteSpace(description) ? null : description
});
return this; return this;
} }
@@ -34,11 +44,19 @@ internal sealed class CommandsRegistry
/// </summary> /// </summary>
public bool TryDispatch(PageContext ctx, string command, CancellationToken ct, out Task? task) public bool TryDispatch(PageContext ctx, string command, CancellationToken ct, out Task? task)
{ {
foreach (var (pattern, handler) in _commands) foreach (var cmd in _commands)
{ {
if (pattern.IsMatch(command)) var match = cmd.Pattern.Match(command);
if (match.Success)
{ {
task = handler(ctx, ct); // Собираем аргументы
var args = cmd.Pattern.GetGroupNames()
.Where(n => n != "0")
.Select(n => new { n, v = match.Groups[n].Value })
.Where(x => !string.IsNullOrEmpty(x.v))
.ToDictionary(x => x.n, x => x.v);
task = cmd.Handler(ctx, args, ct);
return true; return true;
} }
} }
@@ -56,4 +74,10 @@ internal sealed class CommandsRegistry
.Replace("{id?}", "(?<id>\\S+)?") + "$"; .Replace("{id?}", "(?<id>\\S+)?") + "$";
return new Regex(pattern, RegexOptions.Compiled | RegexOptions.IgnoreCase); return new Regex(pattern, RegexOptions.Compiled | RegexOptions.IgnoreCase);
} }
private static string ToCommandName(string template)
{
// Простейшее преобразование шаблона: "/open {page} {id?}" -> "/open"
return template.Split(" ", StringSplitOptions.RemoveEmptyEntries).First().ToLowerInvariant();
}
} }

View File

@@ -1,4 +1,6 @@
namespace BotPages.Core.Routing; using System.Reflection;
namespace BotPages.Core.Routing;
/// <summary> /// <summary>
/// Реестр маршрутов страниц. /// Реестр маршрутов страниц.
@@ -26,4 +28,14 @@ internal sealed class RoutesRegistry
/// Получить снимок всех маршрутов. /// Получить снимок всех маршрутов.
/// </summary> /// </summary>
public IReadOnlyDictionary<string, Type> Snapshot() => _routes; public IReadOnlyDictionary<string, Type> Snapshot() => _routes;
internal void Map(Type? type)
{
foreach(var attr in type.GetCustomAttributes<RouteAttribute>(inherit: true))
{
_routes.Add(attr.Template, type);
}
_routes.Add(type.FullName, type);
}
} }

View File

@@ -56,7 +56,7 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
/// <summary> /// <summary>
/// Запустить polling для приема обновлений от Telegram. /// Запустить polling для приема обновлений от Telegram.
/// </summary> /// </summary>
public async Task StartAdapterAsync(Func<UpdateContext, Task> onUpdate, CancellationToken ct) public async Task StartAdapterAsync(Func<UpdateContext, Task> onUpdate, List<BotPages.Core.Routing.Command> commands, CancellationToken ct)
{ {
_client = new TelegramBotClient(_token); _client = new TelegramBotClient(_token);
@@ -77,6 +77,7 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
cancellationToken: ct cancellationToken: ct
); );
await _client.SetMyCommands(commands.Where(t => t.Publish).Select(t => new BotCommand(t.Name, t.Description ?? t.Name.TrimStart('/'))), cancellationToken: ct);
var me = await _client.GetMe(); var me = await _client.GetMe();
_logger.Log(LogLevel.Info, $"{MessengerType} started: @{me.Username}"); _logger.Log(LogLevel.Info, $"{MessengerType} started: @{me.Username}");
@@ -85,33 +86,44 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
} }
/// <inheritdoc /> /// <inheritdoc />
public async Task SendTextAsync(string chatId, string text, MessageFormat format, public async Task<string?> SendTextAsync(string chatId, string text,
IEnumerable<IEnumerable<InlineButton>>? inline, MessageFormat format = MessageFormat.Plain,
IEnumerable<IEnumerable<ReplyButton>>? reply, CancellationToken ct) IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
string? messageId = null,
CancellationToken ct = default)
{ {
if (_client is null) if (_client is null)
{ {
_logger.Log(LogLevel.Critical, $"{MessengerType} client is not initialized."); _logger.Log(LogLevel.Critical, $"{MessengerType} client is not initialized.");
return; return null;
} }
InlineKeyboardMarkup? inlineMarkup = null;
ReplyMarkup? markup = null; ReplyMarkup? markup = null;
if (inline is not null && inline.Any()) if (inline is not null && inline.Any())
{ {
markup = new InlineKeyboardMarkup( inlineMarkup = new InlineKeyboardMarkup(
inline.Select(row => row.Select(b => new InlineKeyboardButton(b.Label, b.Value)).ToArray()) inline.Select(row => row.Select(b => new InlineKeyboardButton(b.Label, b.Value)).ToArray())
.ToArray() .ToArray()
); );
} }
else if (reply is not null && reply.Any()) else if (reply is not null)
{ {
markup = new ReplyKeyboardMarkup( if (reply.Any())
reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray()
)
{ {
ResizeKeyboard = true markup = new ReplyKeyboardMarkup(
}; reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray()
)
{
ResizeKeyboard = true
};
}
else
{
markup = new ReplyKeyboardRemove();
}
} }
var parseMode = ParseMode.None; var parseMode = ParseMode.None;
@@ -147,17 +159,44 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
text = text.Substring(0, Capabilities.MaxMessageLength); text = text.Substring(0, Capabilities.MaxMessageLength);
} }
await _client.SendMessage( if (!string.IsNullOrWhiteSpace(messageId))
chatId: long.Parse(chatId), {
text: text, await _client.EditMessageText(
parseMode: parseMode, messageId: int.Parse(messageId),
replyMarkup: markup, chatId: long.Parse(chatId),
cancellationToken: ct text: text,
); parseMode: parseMode,
replyMarkup: inlineMarkup,
cancellationToken: ct
);
return messageId;
}
else
{
if (inlineMarkup is not null) markup = inlineMarkup;
var message = await _client.SendMessage(
chatId: long.Parse(chatId),
text: text,
parseMode: parseMode,
replyMarkup: markup,
cancellationToken: ct
);
return message.Id.ToString();
}
} }
/// <inheritdoc /> /// <inheritdoc />
public async Task SendFileAsync(string chatId, FileDescriptor file, string? caption, MessageFormat? captionFormat, CancellationToken ct) public async Task SendFileAsync(string chatId,
FileDescriptor file,
string? caption = null,
MessageFormat? captionFormat = null,
IEnumerable<IEnumerable<InlineButton>>? inline = null,
IEnumerable<IEnumerable<ReplyButton>>? reply = null,
CancellationToken ct = default
)
{ {
if (_client is null) if (_client is null)
{ {
@@ -219,20 +258,46 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
} }
} }
ReplyMarkup? markup = null;
if (inline is not null && inline.Any())
{
markup = new InlineKeyboardMarkup(
inline.Select(row => row.Select(b => new InlineKeyboardButton(b.Label, b.Value)).ToArray())
.ToArray()
);
}
else if (reply is not null)
{
if (reply.Any())
{
markup = new ReplyKeyboardMarkup(
reply.Select(row => row.Select(b => new KeyboardButton(b.Label)).ToArray()).ToArray()
)
{
ResizeKeyboard = true
};
}
else
{
markup = new ReplyKeyboardRemove();
}
}
// В зависимости от FileKind выбираем подходящий метод // В зависимости от FileKind выбираем подходящий метод
switch (file.Kind) switch (file.Kind)
{ {
case FileKind.Photo: case FileKind.Photo:
await _client.SendPhoto(long.Parse(chatId), inputFile, caption ?? "", parseMode, cancellationToken: ct); await _client.SendPhoto(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break; break;
case FileKind.Video: case FileKind.Video:
await _client.SendVideo(long.Parse(chatId), inputFile, caption: caption ?? "", parseMode, cancellationToken: ct); await _client.SendVideo(long.Parse(chatId), inputFile, caption: caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break; break;
case FileKind.Audio: case FileKind.Audio:
await _client.SendAudio(long.Parse(chatId), inputFile, caption ?? "", parseMode, cancellationToken: ct); await _client.SendAudio(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break; break;
default: default:
await _client.SendDocument(long.Parse(chatId), inputFile, caption ?? "", parseMode, cancellationToken: ct); await _client.SendDocument(long.Parse(chatId), inputFile, caption ?? "", parseMode, replyMarkup: markup, cancellationToken: ct);
break; break;
} }
} }
@@ -240,62 +305,6 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
/// <inheritdoc /> /// <inheritdoc />
public IAlbumBuilder CreateAlbumBuilder(PageContext ctx) => new TelegramAlbumBuilder(this, ctx, _logger, _client); public IAlbumBuilder CreateAlbumBuilder(PageContext ctx) => new TelegramAlbumBuilder(this, ctx, _logger, _client);
/// <inheritdoc />
public async Task<string?> StartProgressAsync(PageContext ctx, string title, CancellationToken ct)
{
if (_client is null)
{
_logger.Log(LogLevel.Critical, $"{MessengerType} client is not initialized.");
return null;
}
string text = "0%";
if (!string.IsNullOrEmpty(title))
{
text = title + Environment.NewLine + text;
}
var message = await _client.SendMessage(
chatId: long.Parse(ctx.Update.Chat.Id),
text: text,
cancellationToken: ct
);
return message.Id.ToString();
}
/// <inheritdoc />
public async Task UpdateProgressAsync(PageContext ctx, string messageId, string title, int percent, CancellationToken ct)
{
if (_client is null)
{
_logger.Log(LogLevel.Critical, $"{MessengerType} client is not initialized.");
return;
}
percent = Math.Clamp(percent, 0, 100);
string text = $"{percent}%";
if (!string.IsNullOrEmpty(title))
{
text = title + Environment.NewLine + text;
}
try
{
await _client.EditMessageText(
messageId: int.Parse(messageId),
chatId: long.Parse(ctx.Update.Chat.Id),
text: text,
cancellationToken: ct
);
}
catch (Exception ex)
{
_logger.Log(LogLevel.Critical, ex.Message, ex);
}
}
/// <inheritdoc /> /// <inheritdoc />
public Task OnLeaveAsync(PageContext ctx, CancellationToken ct) => Task.CompletedTask; public Task OnLeaveAsync(PageContext ctx, CancellationToken ct) => Task.CompletedTask;
} }

View File

@@ -53,7 +53,7 @@ public sealed class TelegramAlbumBuilder : IAlbumBuilder
{ {
_logger.Log(LogLevel.Warn, "Albums not supported. Degraded to sequential sends."); _logger.Log(LogLevel.Warn, "Albums not supported. Degraded to sequential sends.");
foreach (var (file, caption, captionFormat) in _items) foreach (var (file, caption, captionFormat) in _items)
await _adapter.SendFileAsync(_ctx.Update.Chat.Id, file, caption, captionFormat, ct); await _adapter.SendFileAsync(_ctx.Update.Chat.Id, file, caption, captionFormat, ct: ct);
return; return;
} }
@@ -95,7 +95,7 @@ public sealed class TelegramAlbumBuilder : IAlbumBuilder
{ {
// Telegram не поддерживает document в альбомах — деградация // Telegram не поддерживает document в альбомах — деградация
_logger.Log(LogLevel.Warn, $"Document '{file.Kind}' in album not supported. Sending document separately."); _logger.Log(LogLevel.Warn, $"Document '{file.Kind}' in album not supported. Sending document separately.");
await _adapter.SendFileAsync(_ctx.Update.Chat.Id, file, caption, captionFormat, ct); await _adapter.SendFileAsync(_ctx.Update.Chat.Id, file, caption, captionFormat, ct: ct);
} }
} }

View File

@@ -1,9 +1,21 @@
<Project Sdk="Microsoft.NET.Sdk"> <Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup> <PropertyGroup>
<TargetFramework>net8.0</TargetFramework> <TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings> <Nullable>enable</Nullable>
<Nullable>enable</Nullable> <ImplicitUsings>enable</ImplicitUsings>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageId>BotPages</PackageId>
<Version>1.0.0</Version>
<Authors>FrigaT</Authors>
<Company>FrigaT</Company>
<Product>BotPages</Product>
<Description>Платформонезависимый framework для создания диалоговых ботов с системой страниц.</Description>
<Copyright>Copyright © 2025 FrigaT</Copyright>
<RepositoryUrl>https://git.frigat.duckdns.org/FrigaT/BotPages</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageProjectUrl>https://git.frigat.duckdns.org/FrigaT/BotPages</PackageProjectUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
</PropertyGroup> </PropertyGroup>
<ItemGroup> <ItemGroup>

View File

@@ -1,9 +1,11 @@
using BotPages.Core; using BotPages.Core;
using BotPages.Core.Abstractions; using BotPages.Core.Abstractions;
using BotPages.Core.Messaging; using BotPages.Core.Messaging;
using BotPages.Core.Routing;
namespace Demo.Pages; namespace Demo.Pages;
[Route("FileSend")]
public sealed class FileSendPage : SingletonPage public sealed class FileSendPage : SingletonPage
{ {
public override Task OnEnter(PageContext ctx, CancellationToken ct) public override Task OnEnter(PageContext ctx, CancellationToken ct)

View File

@@ -20,7 +20,7 @@ public sealed class FilesPage : SingletonPage
{ {
foreach (var file in files) foreach (var file in files)
{ {
await ctx.SendFileAsync(file, $"Файл '{file.Name}' получен и отправлен обратно.", ct); await ctx.SendFileAsync(file, $"Файл '{file.Name}' получен и отправлен обратно.", ct: ct);
} }
//Обращение через Storage //Обращение через Storage

View File

@@ -12,8 +12,8 @@ public sealed class SubmitPage : SingletonPage
{ {
var progress = new MessageBuilder(ctx); var progress = new MessageBuilder(ctx);
await progress var messageId = await progress
.Progress("Отправка заявки", 7) .Text("Отправка заявки\n7%")
.SendAsync(ct); .SendAsync(ct);
int i = 7; int i = 7;
@@ -22,12 +22,13 @@ public sealed class SubmitPage : SingletonPage
i += 25; i += 25;
Thread.Sleep(TimeSpan.FromMilliseconds(200)); Thread.Sleep(TimeSpan.FromMilliseconds(200));
await progress await progress
.Progress("Отправка заявки", i) .Text($"Отправка заявки\n{i}%")
.EditMessage(messageId!)
.SendAsync(ct); .SendAsync(ct);
} }
while (i < 100); while (i < 100);
await ctx.Navigation.GoToHome(ctx, ct); await ctx.Navigation.GoToHomeAsync(ctx, ct);
} }
public override Task OnLeave(PageContext ctx, CancellationToken ct) public override Task OnLeave(PageContext ctx, CancellationToken ct)

View File

@@ -19,7 +19,7 @@ public sealed class TitlePage : SingletonPage
{ {
if (text == "Меню") if (text == "Меню")
{ {
return ctx.Navigation.GoToHome(ctx, ct); return ctx.Navigation.GoToHomeAsync(ctx, ct);
} }
else else
{ {

View File

@@ -1,6 +1,7 @@
using BotPages.Core; using BotPages.Core;
using BotPages.Core.Abstractions; using BotPages.Core.Abstractions;
using BotPages.Core.Messaging; using BotPages.Core.Messaging;
using BotPages.Core.Routing;
namespace Demo.Pages; namespace Demo.Pages;
@@ -8,6 +9,7 @@ namespace Demo.Pages;
/// Стартовая страница демо‑бота. /// Стартовая страница демо‑бота.
/// Обычная страница с кнопками /// Обычная страница с кнопками
/// </summary> /// </summary>
[Route("Welcome")]
public sealed class WelcomePage : SingletonPage public sealed class WelcomePage : SingletonPage
{ {
public override async Task OnEnter(PageContext ctx, CancellationToken ct) public override async Task OnEnter(PageContext ctx, CancellationToken ct)

View File

@@ -1,6 +1,7 @@
using BotPages.Core; using BotPages.Core;
using BotPages.Core.Logging; using BotPages.Core.Logging;
using BotPages.Core.Middleware; using BotPages.Core.Middleware;
using BotPages.Core.Routing;
using BotPages.Core.Storage; using BotPages.Core.Storage;
using BotPages.Telegram; using BotPages.Telegram;
using Demo.Pages; using Demo.Pages;
@@ -18,9 +19,26 @@ namespace Demo
var state = new InMemoryStateStorage(); var state = new InMemoryStateStorage();
using var cts = new CancellationTokenSource(); using var cts = new CancellationTokenSource();
// Можно использовать команды для открытия страниц с роутингом
// /open Welcome
// /open FileSend
CommandHandler openHandler = async (ctx, args, ct) =>
{
if (args is null || !args.TryGetValue("page", out var pageName))
{
await ctx.SendTextAsync("Не указана страница для открытия.", ct: ct);
return;
}
// Навигация на страницу по имени
await ctx.Navigation.GoToAsync(pageName, ctx, ct);
};
var app = new BotPagesApp(state, logger) var app = new BotPagesApp(state, logger)
.AddDefaultPage<WelcomePage>() .AddDefaultPage<WelcomePage>()
.MapCommand<WelcomePage>("/start") .MapCommand<WelcomePage>("/start", true, "Главная")
.MapCommand("/open {page}", openHandler, true, "открыть станицу /open {page}")
.AutoMapRoute()
.AddMiddleware(new ErrorHandlingMiddleware(logger)) .AddMiddleware(new ErrorHandlingMiddleware(logger))
.AddMiddleware(new LoggingMiddleware(logger)) .AddMiddleware(new LoggingMiddleware(logger))
.AddTelegramAdapter(token, "Telegram") .AddTelegramAdapter(token, "Telegram")

5
TZ.md
View File

@@ -17,7 +17,6 @@
- **Page** — класс, отвечающий за состояние экрана бота. - **Page** — класс, отвечающий за состояние экрана бота.
- `Page` — базовый класс. - `Page` — базовый класс.
- `Page<TArguments>` — страница с аргументами. - `Page<TArguments>` — страница с аргументами.
- `ModalPage` / `ModalPage<TArguments>` — модальная страница (перехватывает ввод, блокирует переходы).
- **Контекст:** - **Контекст:**
- `UserContext` — данные пользователя (UserId, MessengerType). - `UserContext` — данные пользователя (UserId, MessengerType).
- `ChatContext` — данные чата (ChatId, Title, ThreadId?, ленивое обновление). - `ChatContext` — данные чата (ChatId, Title, ThreadId?, ленивое обновление).
@@ -25,7 +24,7 @@
- **Состояние:** - **Состояние:**
- `IStateStorage` — универсальный интерфейс хранения. - `IStateStorage` — универсальный интерфейс хранения.
- Базовая реализация: InMemory. - Базовая реализация: InMemory.
- Ключ: `CompositeSessionKey(MessengerType:string, ChatId, UserId?)`. - Ключ: `CompositeSessionKey(MessengerType:string, ChatId, UserId)`.
- История состояний: опционально (None, LastN, TimeWindow, Full). - История состояний: опционально (None, LastN, TimeWindow, Full).
--- ---
@@ -125,7 +124,7 @@
``` ```
- Пример: - Пример:
```csharp ```csharp
app.AddMiddleware<IUpdateMiddleware, LoggingMiddleware>(); app.AddMiddleware<LoggingMiddleware>();
app.AddMiddleware<ErrorMiddleware>(params); app.AddMiddleware<ErrorMiddleware>(params);
``` ```
- Порядок регистрации = порядок выполнения. - Порядок регистрации = порядок выполнения.