7 Commits

Author SHA1 Message Date
246a5cb278 Удалено отключение бота
All checks were successful
CI / build-test (push) Successful in 35s
Release / pack-and-publish (release) Successful in 37s
2025-12-10 20:54:18 +03:00
644749929e Убивает клиента ТГ, если он запущен вторым по токену
All checks were successful
CI / build-test (push) Successful in 37s
Release / pack-and-publish (release) Successful in 41s
2025-12-10 20:31:10 +03:00
8528b814d8 Удалить TZ.md
All checks were successful
CI / build-test (push) Successful in 30s
2025-12-07 12:04:50 +03:00
d60bef7070 фикс
All checks were successful
CI / build-test (push) Successful in 29s
Release / pack-and-publish (release) Successful in 31s
2025-12-07 11:28:11 +03:00
7556b3d638 Доработаны паттерны команд 2025-12-07 11:17:21 +03:00
67de9e197a исправлен парсер команд
All checks were successful
CI / build-test (push) Successful in 32s
Release / pack-and-publish (release) Successful in 35s
2025-12-07 10:50:58 +03:00
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
12 changed files with 170 additions and 198 deletions

View File

@@ -59,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

@@ -69,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;
} }
@@ -142,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;
} }
@@ -237,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

@@ -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,38 @@
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); return Map(commandTemplate, (ctx, args, ct) => ctx.Navigation.GoToAsync<TPage>(ctx, ct), publish, description);
_commands.Add((pattern, (ctx, ct) => ctx.Navigation.GoToAsync<TPage>(ctx, ct)));
return this;
} }
/// <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 +42,17 @@ 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 => !int.TryParse(n, out _))
.ToDictionary(n => n, n => match.Groups[n].Value);
task = cmd.Handler(ctx, args, ct);
return true; return true;
} }
} }
@@ -46,14 +60,37 @@ internal sealed class CommandsRegistry
return false; return false;
} }
/// <summary>
/// Универсальный парсер шаблонов: /cmd {a} {b?} {c}
/// </summary>
private static Regex ToRegex(string template) private static Regex ToRegex(string template)
{ {
// Простейшее преобразование шаблона: "/open {page} {id?}" -> Regex // Заменяем все {name} и {name?} на регулярные группы
var escaped = Regex.Escape(template) var pattern = "^" + Regex.Replace(template, @"\s*\{(\w+)(\?)?\}", m =>
.Replace("\\{", "{").Replace("\\}", "}"); {
var pattern = "^" + escaped var name = m.Groups[1].Value;
.Replace("{page}", "(?<page>\\S+)") var optional = m.Groups[2].Success;
.Replace("{id?}", "(?<id>\\S+)?") + "$";
var argPattern = $"(?:\"(?<{name}>[^\"]+)\"|(?<{name}>\\S+))";
if (optional)
{
// необязательный параметр: пробел + значение целиком необязательны
return $"(?:\\s+{argPattern})?";
}
else
{
// обязательный параметр: пробел обязателен
return $"\\s+{argPattern}";
}
}) + "\\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

@@ -10,6 +10,7 @@ using System.Linq;
using System.Threading; using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using Telegram.Bot; using Telegram.Bot;
using Telegram.Bot.Exceptions;
using Telegram.Bot.Types; using Telegram.Bot.Types;
using Telegram.Bot.Types.Enums; using Telegram.Bot.Types.Enums;
using Telegram.Bot.Types.ReplyMarkups; using Telegram.Bot.Types.ReplyMarkups;
@@ -56,7 +57,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);
@@ -66,6 +67,10 @@ public sealed class TelegramAdapter : IMessangerAdapterSetup
var mapped = TelegramUpdateMapper.Map(MessengerType, update, _client); var mapped = TelegramUpdateMapper.Map(MessengerType, update, _client);
if (mapped is not null) if (mapped is not null)
await onUpdate(mapped); await onUpdate(mapped);
if (update.CallbackQuery is not null)
{
await _.AnswerCallbackQuery(update.CallbackQuery.Id);
}
}, },
errorHandler: async (_, ex, ct2) => errorHandler: async (_, ex, ct2) =>
@@ -77,6 +82,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}");

View File

@@ -1,5 +1,6 @@
using BotPages.Core; using BotPages.Core;
using BotPages.Core.Messaging; using BotPages.Core.Messaging;
using BotPages.Core.Routing;
namespace Demo.Pages; namespace Demo.Pages;
@@ -7,20 +8,20 @@ namespace Demo.Pages;
/// Страница ввода деталей заявки. /// Страница ввода деталей заявки.
/// Страница с параметрами и получением состояния. /// Страница с параметрами и получением состояния.
/// </summary> /// </summary>
public sealed class DetailsPage : StatefullPage<DetailsArgs> public sealed class DetailsPage : StatefullPage<string>
{ {
[Statefull("Request")] [Statefull("Request")]
private Models.Request Request; private Models.Request Request;
public override Task OnEnter(PageContext ctx, DetailsArgs args, CancellationToken ct) public override Task OnEnter(PageContext ctx, string args, CancellationToken ct)
{ {
Request = new() Request = new()
{ {
Title = args.Title, Title = args,
}; };
return new MessageBuilder(ctx) return new MessageBuilder(ctx)
.Text($"Заголовок: {args.Title}\nДобавьте детали или нажмите Далее.") .Text($"Заголовок: {args}\nДобавьте детали или нажмите Далее.")
.Inline(new InlineButton("Далее", "next"), new InlineButton("Назад", "back")) .Inline(new InlineButton("Далее", "next"), new InlineButton("Назад", "back"))
.Reply("Отмена") .Reply("Отмена")
.SendAsync(ct); .SendAsync(ct);
@@ -52,12 +53,15 @@ public sealed class DetailsPage : StatefullPage<DetailsArgs>
await SaveState(ctx, ct); await SaveState(ctx, ct);
await ctx.Navigation.GoToAsync<FilesPage>(ctx, ct); await ctx.Navigation.GoToAsync<FilesPage>(ctx, ct);
} }
}
/// <summary> internal static string Command => "/create_request {title?}";
/// Аргументы для страницы DetailsPage. internal static string CommandDescription => "создание заявки /create_request {title}";
/// </summary> internal static CommandHandler CommandHandler = async (ctx, args, ct) =>
public sealed class DetailsArgs {
{ string? title = "";
public string Title { get; set; } = ""; args?.TryGetValue("title", out title);
// Навигация на страницу по имени
await ctx.Navigation.GoToAsync<DetailsPage, string>(ctx, title ?? "", ct);
};
} }

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

@@ -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;
/// <summary> /// <summary>
@@ -23,7 +24,7 @@ public sealed class TitlePage : SingletonPage
} }
else else
{ {
return ctx.Navigation.GoToAsync<DetailsPage, DetailsArgs>(ctx, new DetailsArgs { Title = text }, ct); return ctx.Navigation.GoToAsync<DetailsPage, string>(ctx, text, ct);
} }
} }
} }

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,27 @@ 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}")
.MapCommand(DetailsPage.Command, DetailsPage.CommandHandler, true, DetailsPage.CommandDescription)
.AutoMapRoute()
.AddMiddleware(new ErrorHandlingMiddleware(logger)) .AddMiddleware(new ErrorHandlingMiddleware(logger))
.AddMiddleware(new LoggingMiddleware(logger)) .AddMiddleware(new LoggingMiddleware(logger))
.AddTelegramAdapter(token, "Telegram") .AddTelegramAdapter(token, "Telegram")

162
TZ.md
View File

@@ -1,162 +0,0 @@
# Техническое задание
## Проект: BotPages
### 1. Общая информация
- **Название:** BotPages
- **Цель:** Создание библиотеки (NuGetпакета) для управления страницами в ботах (Telegram, VK, Discord, WhatsApp и др.), позволяющей строить логику без жёсткой привязки к конкретному API.
- **Платформа:** .NET 8
- **Артефакты:**
- `BotPages.Core` — ядро, независимое от транспорта.
- `BotPages.Telegram` — адаптер для Telegram.
- В будущем: адаптеры для VK, Discord, WhatsApp.
- **Демо:** `Demo.exe` — демонстрация работы (создание заявки через несколько страниц, кнопки, файлы).
---
### 2. Основные понятия
- **Page** — класс, отвечающий за состояние экрана бота.
- `Page` — базовый класс.
- `Page<TArguments>` — страница с аргументами.
- **Контекст:**
- `UserContext` — данные пользователя (UserId, MessengerType).
- `ChatContext` — данные чата (ChatId, Title, ThreadId?, ленивое обновление).
- `PageContext` — объединяет UserContext, ChatContext, состояние, навигацию, файлы.
- **Состояние:**
- `IStateStorage` — универсальный интерфейс хранения.
- Базовая реализация: InMemory.
- Ключ: `CompositeSessionKey(MessengerType:string, ChatId, UserId)`.
- История состояний: опционально (None, LastN, TimeWindow, Full).
---
### 3. Жизненный цикл страницы
- Методы (все async, с `CancellationToken`):
- `OnEnter(ctx)` — вход.
- `OnUpdate(ctx, update)` — общий обработчик.
- `OnText(ctx, text)` — текстовые сообщения.
- `OnFile(ctx, file)` — файлы.
- `OnButton(ctx, action)` — кнопки.
- `OnLeave(ctx)` — выход.
- `OnError(ctx, exception)` — ошибки.
- `OnTimeout(ctx, timeoutInfo)` — таймауты.
- Прогресс фоновых операций:
- `StartProgress()`, `UpdateProgress(percent)` + событие обновления.
---
### 4. Навигация
- Императивный API:
```csharp
ctx.GoTo<CitySelectionPage>();
ctx.GoTo<ConfirmationPage>(new ConfirmationArgs { PhotoId = photoId });
ctx.GoTo<DetailsPage>(args => { args.Photo = photoId; });
ctx.ReplaceWith<MainPage>();
ctx.Back();
```
- Декларативный роутинг:
- Атрибуты `[Route("order/create")]`.
- Реестр `routes.Map<CreateOrderPage>("order/create")`.
- Проверка конфликтов при старте.
- Стек навигации: отдельный пакет `BotPages.Navigation.Stack`.
---
### 5. Команды
- Команды имеют приоритет над событиями страниц.
- Поддержка шаблонов:
```csharp
app.Commands.Map("/start").To<WelcomePage>();
app.Commands.Map("/open {page} {id?}")
.To(ctx => ctx.GoToByName(page, new { id }));
```
- Возможность указать страницу, которая открывается при вводе команды.
---
### 6. Файлы
- **FileDescriptor:**
- `Id`, `Name`, `Extension`, `Size`, `Mime`, `Type(enum)`, `SourceMessenger`, `GetStreamAsync()`, `Checksum?`.
- Отправка:
```csharp
await ctx.Chat.SendFileAsync(file, caption: "Документ");
await ctx.Chat.Files.BeginAlbum().Add(file1).Add(file2).SendAsync();
```
- Альбомы, сжатие — на уровне адаптера.
- Метаданные файлов — временно в контексте, экспорт в состояние вручную.
---
### 7. Адаптеры
- Интерфейс `IMessengerAdapter`:
- `SendMessage`, `EditMessage`, `DeleteMessage`, `SendFile`, `SendAlbum`.
- `ReceiveUpdate`.
- `GetChat`, `GetFileStream`.
- `AnswerCallback`, `SetTypingIndicator`.
- Telegram: первая реализация.
- Поддержка **Webhook** и **Polling** (выбор конфигом).
---
### 8. Capabilities
- В `ChatContext.Capabilities`:
- `SupportsInlineButtons`, `SupportsReplyButtons`, `SupportsAlbums`, `SupportsFormattingMarkdown`, `SupportsFormattingHtml`, `MaxMessageLength`.
- Разработчик может проверять возможности.
- Адаптер всегда деградирует и логирует `Warn`.
---
### 9. Логирование
- Уровни: `Info`, `Warn`, `Critical`.
- Примеры:
- Info: вход на страницу, прогресс.
- Warn: деградация возможностей.
- Critical: падение хранилища.
---
### 10. Middleware
- Интерфейс:
```csharp
public interface IUpdateMiddleware
{
Task InvokeAsync(UpdateContext ctx, Func<Task> next, CancellationToken ct);
}
```
- Пример:
```csharp
app.AddMiddleware<LoggingMiddleware>();
app.AddMiddleware<ErrorMiddleware>(params);
```
- Порядок регистрации = порядок выполнения.
- Middleware только для входящих обновлений.
---
### 11. Дефолтная страница
- Конфигурация:
```csharp
app.UseDefaultPage<WelcomePage>();
```
- Одна дефолтная страница для всех мессенджеров.
- Условия не нужны.
---
### 12. Demo.exe
- Сценарий: создание заявки.
- Страницы:
1. **StartPage** — приветствие, кнопка «Создать заявку».
2. **TitlePage** — ввод текста.
3. **DetailsPage** — доп. поля, inline/reply кнопки.
4. **FilesPage** — загрузка файлов, просмотр списка.
5. **ConfirmPage** — подтверждение заявки.
6. **SubmitPage** — отправка, итоговое сообщение.
---
### 13. TODO (будущие версии)
- Поддержка модальных страниц со стеком.
- Расширенные Capabilities (rate limits, threads).
- ViewDSL как надстройка над контекстом.
- Crosstransport identity.
- Расширенные таймауты и политики отката.