Merge pull request #57 from Kataane/master

Russian translation added

README.md

@@ -1,6 +1,6 @@
 # .NET Telegram Bot Framework - Context based addon
 
-[![NuGet version (TelegramBotBase)](https://img.shields.io/nuget/vpre/TelegramBotBase.svg?style=flat-square)](https://www.nuget.org/packages/TelegramBotBase/)
+[![NuGet version (TelegramBotBase)](https://img.shields.io/nuget/v/TelegramBotBase.svg?style=flat-square)](https://www.nuget.org/packages/TelegramBotBase/)
 [![Telegram chat](https://img.shields.io/badge/Support_Chat-Telegram-blue.svg?style=flat-square)](https://www.t.me/tgbotbase)
 
 [![License](https://img.shields.io/github/license/MajMcCloud/telegrambotframework.svg?style=flat-square&maxAge=2592000&label=License)](https://raw.githubusercontent.com/MajMcCloud/TelegramBotFramework/master/LICENCE.md)
@@ -10,7 +10,7 @@
 
 **Support group: [@tgbotbase](https://t.me/tgbotbase)**
 
-**Discord Server: [https://discord.gg/p3PPhYbTf](https://discord.gg/p3PPhYbTf)**
+**Discord Server: [https://discord.gg/V3PxreDYfE](https://discord.gg/V3PxreDYfE)**
 
 **Releases: [GitHub](https://github.com/MajMcCloud/TelegramBotFramework/releases)**
 
@@ -59,6 +59,7 @@ BitTorrent: `TYVZSykaVT1nKZnz9hjDgBRNB9VavU1bpW`
     * [TaggedButtonGrid](#tagged-button-grid)
     * [CheckedButtonList](#checked-button-list)
     * [MultiToggleButton](#multi-toggle-button)
+- [Localizations](#localizations)
 - [Groups](#groups)
     * [SplitterForm](#splitter-form)
     * [GroupForm](#group-form)
@@ -714,6 +715,19 @@ Check the example project [TelegramBotBase.Test/Tests/Controls/CheckedButtonList
 
 Check the example project [TelegramBotBase.Test/Tests/Controls/MultiToggleButtonForm.cs](TelegramBotBase.Test/Tests/Controls/MultiToggleButtonForm.cs)
 
+
+## Localizations
+
+The current available languages for controls are:
+
+- English
+- German
+- Persian
+
+You can add other languages easily by creating a subclass of the [TelegramBotBase/Localizations/Localization.cs](TelegramBotBase/Localizations/Localization.cs) class.
+
+To set the default language set the *Language* property on the static [TelegramBotBase/Localizations/Default.cs](TelegramBotBase/Localizations/Default.cs) instance.
+
 ## Groups
 
 For groups, there are multiple different tools which help to work with and allows bot also to manage
@@ -1087,4 +1101,4 @@ Want to use Inline- and ReplyMarkup at the same time ? Here is an example how yo
 
 Alpha: Full Dependency Injection example within this framework.
 
-- [Examples/DependencyInjection](Examples/DependencyInjection)
+- [Examples/DependencyInjection](Examples/DependencyInjection)

TelegramBotBase.Extensions.Images/TelegramBotBase.Extensions.Images.csproj

@@ -15,11 +15,14 @@
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
         <PackageReference Include="System.Drawing.Common" Version="6.0.0" />
-        <PackageReference Include="TelegramBotBase" Version="6.0.0" />
     </ItemGroup>
 
     <ItemGroup>
       <Folder Include="Properties\" />
     </ItemGroup>
 
+    <ItemGroup>
+      <ProjectReference Include="..\TelegramBotBase\TelegramBotBase.csproj" />
+    </ItemGroup>
+
 </Project>

TelegramBotBase.Extensions.Serializer.Database.MSSQL/TelegramBotBase.Extensions.Serializer.Database.MSSQL.csproj

@@ -16,7 +16,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.Data.SqlClient" Version="5.0.0" />
+        <PackageReference Include="Microsoft.Data.SqlClient" Version="5.1.3" />
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
             <PrivateAssets>all</PrivateAssets>
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

TelegramBotBase/Base/ErrorResult.cs

@@ -0,0 +1,14 @@
+using System;
+
+namespace TelegramBotBase.Base
+{
+    public class ErrorResult : EventArgs
+    {
+        public ErrorResult(Exception exception)
+        {
+            Exception = exception;
+        }
+
+        public Exception Exception { get; }
+    }
+}

TelegramBotBase/Base/MessageClient.cs

@@ -18,6 +18,7 @@ namespace TelegramBotBase.Base;
 public class MessageClient
 {
     private static readonly object EvOnMessageLoop = new();
+    private static readonly object EvOnReceiveError = new();
 
     private static object __evOnMessage = new();
 
@@ -27,6 +28,14 @@ public class MessageClient
 
     private CancellationTokenSource _cancellationTokenSource;
 
+    /// <summary>
+    ///    Indicates if all pending Telegram.Bot.Types.Updates should be thrown out before
+    //     start polling. If set to true Telegram.Bot.Polling.ReceiverOptions.AllowedUpdates
+    //     should be set to not null, otherwise Telegram.Bot.Polling.ReceiverOptions.AllowedUpdates
+    //     will effectively be set to receive all Telegram.Bot.Types.Updates.
+    /// </summary>
+    public bool ThrowPendingUpdates { get; set; }
+
 
     public MessageClient(string apiKey)
     {
@@ -113,6 +122,8 @@ public class MessageClient
 
         var receiverOptions = new ReceiverOptions();
 
+        receiverOptions.ThrowPendingUpdates = ThrowPendingUpdates;
+
         TelegramClient.StartReceiving(HandleUpdateAsync, HandleErrorAsync, receiverOptions,
                                       _cancellationTokenSource.Token);
     }
@@ -128,22 +139,12 @@ public class MessageClient
         await OnMessageLoop(new UpdateResult(update, null));
     }
 
-    public Task HandleErrorAsync(ITelegramBotClient botClient, Exception exception,
+    public async Task HandleErrorAsync(ITelegramBotClient botClient, Exception exception,
                                  CancellationToken cancellationToken)
     {
-        if (exception is ApiRequestException exApi)
+        await OnReceiveError(new ErrorResult(exception));
-        {
-            Console.WriteLine($"Telegram API Error:\n[{exApi.ErrorCode}]\n{exApi.Message}");
-        }
-        else
-        {
-            Console.WriteLine(exception.ToString());
-        }
-
-        return Task.CompletedTask;
     }
 
-
     /// <summary>
     ///     This will return the current list of bot commands.
     /// </summary>
@@ -186,7 +187,41 @@ public class MessageClient
 
     public async Task OnMessageLoop(UpdateResult update)
     {
-        await (Events[EvOnMessageLoop] as Async.AsyncEventHandler<UpdateResult>)?.Invoke(this, update);
+        var eventHandlers = (Events[EvOnMessageLoop] as Async.AsyncEventHandler<UpdateResult>)?.Invoke(this, update);
+
+        if (eventHandlers != null)
+        {
+            await eventHandlers;
+        }
+    }
+
+
+    public event Async.AsyncEventHandler<ErrorResult> ReceiveError
+    {
+        add => Events.AddHandler(EvOnReceiveError, value);
+        remove => Events.RemoveHandler(EvOnReceiveError, value);
+    }
+
+    public async Task OnReceiveError(ErrorResult update)
+    {
+        var eventHandlers = (Events[EvOnReceiveError] as Async.AsyncEventHandler<ErrorResult>)?.Invoke(this, update);
+
+        if (eventHandlers != null)
+        {
+            await eventHandlers;
+            return;
+        }
+
+        //Fallback when no event handler is used.
+        if (update.Exception is ApiRequestException exApi)
+        {
+            Console.WriteLine($"Telegram API Error:\n[{exApi.ErrorCode}]\n{exApi.Message}");
+        }
+        else
+        {
+            Console.WriteLine(update.Exception.ToString());
+        }
+
     }
 
     #endregion

TelegramBotBase/BotBase.cs

@@ -115,12 +115,13 @@ public sealed class BotBase
             if (ds == null)
             {
                 ds = await Sessions.StartSession(e.DeviceId);
-                e.Device = ds;
                 ds.LastMessage = e.RawData.Message;
 
                 OnSessionBegins(new SessionBeginEventArgs(e.DeviceId, ds));
             }
 
+            e.Device = ds;
+
             var mr = new MessageResult(e.RawData);
 
             var i = 0;

TelegramBotBase/Builder/BotBaseBuilder.cs

@@ -207,7 +207,7 @@ public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage,
 
     #region "Step 4 (Network Settings)"
 
-    public IBotCommandsStage WithProxy(string proxyAddress)
+    public IBotCommandsStage WithProxy(string proxyAddress, bool throwPendingUpdates = false)
     {
         var url = new Uri(proxyAddress);
         _client = new MessageClient(_apiKey, url)
@@ -217,11 +217,12 @@ public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage,
                 Timeout = new TimeSpan(0, 1, 0)
             },
         };
+        _client.ThrowPendingUpdates = throwPendingUpdates;
         return this;
     }
 
 
-    public IBotCommandsStage NoProxy()
+    public IBotCommandsStage NoProxy(bool throwPendingUpdates = false)
     {
         _client = new MessageClient(_apiKey)
         {
@@ -230,11 +231,12 @@ public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage,
                 Timeout = new TimeSpan(0, 1, 0)
             }
         };
+        _client.ThrowPendingUpdates = throwPendingUpdates;
         return this;
     }
 
 
-    public IBotCommandsStage WithBotClient(TelegramBotClient tgclient)
+    public IBotCommandsStage WithBotClient(TelegramBotClient tgclient, bool throwPendingUpdates = false)
     {
         _client = new MessageClient(_apiKey, tgclient)
         {
@@ -243,11 +245,12 @@ public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage,
                 Timeout = new TimeSpan(0, 1, 0)
             }
         };
+        _client.ThrowPendingUpdates = throwPendingUpdates;
         return this;
     }
 
 
-    public IBotCommandsStage WithHostAndPort(string proxyHost, int proxyPort)
+    public IBotCommandsStage WithHostAndPort(string proxyHost, int proxyPort, bool throwPendingUpdates = false)
     {
         _client = new MessageClient(_apiKey, proxyHost, proxyPort)
         {
@@ -256,10 +259,11 @@ public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage,
                 Timeout = new TimeSpan(0, 1, 0)
             }
         };
+        _client.ThrowPendingUpdates = throwPendingUpdates;
         return this;
     }
 
-    public IBotCommandsStage WithHttpClient(HttpClient tgclient)
+    public IBotCommandsStage WithHttpClient(HttpClient tgclient, bool throwPendingUpdates = false)
     {
         _client = new MessageClient(_apiKey, tgclient)
         {
@@ -268,6 +272,7 @@ public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage,
                 Timeout = new TimeSpan(0, 1, 0)
             }
         };
+        _client.ThrowPendingUpdates = throwPendingUpdates;
         return this;
     }
 
@@ -386,29 +391,41 @@ public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage,
 
     #region "Step 7 (Language)"
 
+    /// <inheritdoc cref="ILanguageSelectionStage.DefaultLanguage"/>
     public IBuildingStage DefaultLanguage()
     {
         return this;
     }
 
+    /// <inheritdoc cref="ILanguageSelectionStage.UseEnglish"/>
     public IBuildingStage UseEnglish()
     {
         Default.Language = new English();
         return this;
     }
 
+    /// <inheritdoc cref="ILanguageSelectionStage.UseGerman"/>
     public IBuildingStage UseGerman()
     {
         Default.Language = new German();
         return this;
     }
 
+    /// <inheritdoc cref="ILanguageSelectionStage.UsePersian"/>
     public IBuildingStage UsePersian()
     {
         Default.Language = new Persian();
         return this;
     }
 
+    /// <inheritdoc cref="ILanguageSelectionStage.UseRussian"/>
+    public IBuildingStage UseRussian()
+    {
+        Default.Language = new Russian();
+        return this;
+    }
+
+    /// <inheritdoc cref="ILanguageSelectionStage.Custom"/>
     public IBuildingStage Custom(Localization language)
     {
         Default.Language = language;

TelegramBotBase/Builder/Interfaces/ILanguageSelectionStage.cs

@@ -2,35 +2,44 @@
 
 namespace TelegramBotBase.Builder.Interfaces;
 
+/// <summary>
+/// Represents the language selection stage in the localization process.
+/// </summary>
 public interface ILanguageSelectionStage
 {
     /// <summary>
     ///     Selects the default language for control usage. (English)
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The next stage in the building process.</returns>
     IBuildingStage DefaultLanguage();
 
     /// <summary>
     ///     Selects english as the default language for control labels.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The next stage in the building process.</returns>
     IBuildingStage UseEnglish();
 
     /// <summary>
     ///     Selects german as the default language for control labels.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The next stage in the building process.</returns>
     IBuildingStage UseGerman();
 
     /// <summary>
     ///     Selects persian as the default language for control labels.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The next stage in the building process.</returns>
     IBuildingStage UsePersian();
 
+    /// <summary>
+    ///     Selects russian as the default language for control labels.
+    /// </summary>
+    /// <returns>The next stage in the building process.</returns>
+    IBuildingStage UseRussian();
+
     /// <summary>
     ///     Selects a custom language as the default language for control labels.
     /// </summary>
-    /// <returns></returns>
+    /// <returns>The next stage in the building process.</returns>
     IBuildingStage Custom(Localization language);
 }

TelegramBotBase/Builder/Interfaces/INetworkingSelectionStage.cs

@@ -9,22 +9,25 @@ public interface INetworkingSelectionStage
     ///     Chooses a proxy as network configuration.
     /// </summary>
     /// <param name="proxyAddress"></param>
+    /// <param name="throwPendingUpdates">Indicates if all pending Telegram.Bot.Types.Updates should be thrown out before start polling.</param>
     /// <returns></returns>
-    IBotCommandsStage WithProxy(string proxyAddress);
+    IBotCommandsStage WithProxy(string proxyAddress, bool throwPendingUpdates = false);
 
     /// <summary>
     ///     Do not choose a proxy as network configuration.
     /// </summary>
+    /// <param name="throwPendingUpdates">Indicates if all pending Telegram.Bot.Types.Updates should be thrown out before start polling.</param>
     /// <returns></returns>
-    IBotCommandsStage NoProxy();
+    IBotCommandsStage NoProxy(bool throwPendingUpdates = false);
 
 
     /// <summary>
     ///     Chooses a custom instance of TelegramBotClient.
     /// </summary>
     /// <param name="client"></param>
+    /// <param name="throwPendingUpdates">Indicates if all pending Telegram.Bot.Types.Updates should be thrown out before start polling.</param>
     /// <returns></returns>
-    IBotCommandsStage WithBotClient(TelegramBotClient client);
+    IBotCommandsStage WithBotClient(TelegramBotClient client, bool throwPendingUpdates = false);
 
 
     /// <summary>
@@ -32,13 +35,15 @@ public interface INetworkingSelectionStage
     /// </summary>
     /// <param name="proxyHost"></param>
     /// <param name="Port"></param>
+    /// <param name="throwPendingUpdates">Indicates if all pending Telegram.Bot.Types.Updates should be thrown out before start polling.</param>
     /// <returns></returns>
-    IBotCommandsStage WithHostAndPort(string proxyHost, int Port);
+    IBotCommandsStage WithHostAndPort(string proxyHost, int Port, bool throwPendingUpdates = false);
 
     /// <summary>
     ///     Uses a custom http client.
     /// </summary>
     /// <param name="client"></param>
+    /// <param name="throwPendingUpdates">Indicates if all pending Telegram.Bot.Types.Updates should be thrown out before start polling.</param>
     /// <returns></returns>
-    IBotCommandsStage WithHttpClient(HttpClient client);
+    IBotCommandsStage WithHttpClient(HttpClient client, bool throwPendingUpdates = false);
 }

TelegramBotBase/Localizations/Russian.cs

@@ -0,0 +1,36 @@
+namespace TelegramBotBase.Localizations;
+
+public sealed class Russian : Localization
+{
+    public Russian()
+    {
+        Values["Language"] = "Русский (Russian)";
+        Values["ButtonGrid_Title"] = "Меню";
+        Values["ButtonGrid_NoItems"] = "Нет доступных элементов.";
+        Values["ButtonGrid_PreviousPage"] = "◀️";
+        Values["ButtonGrid_NextPage"] = "▶️";
+        Values["ButtonGrid_CurrentPage"] = "Страница {0} из {1}";
+        Values["ButtonGrid_SearchFeature"] = "💡 Отправьте сообщение, чтобы отфильтровать список. Нажмите на 🔍, чтобы сбросить фильтр.";
+        Values["ButtonGrid_Back"] = "Назада";
+        Values["ButtonGrid_CheckAll"] = "Выделить все";
+        Values["ButtonGrid_UncheckAll"] = "Отменить выбор";
+        Values["CalendarPicker_Title"] = "Календарь / Выберите дату";
+        Values["CalendarPicker_PreviousPage"] = "◀️";
+        Values["CalendarPicker_NextPage"] = "▶️";
+        Values["TreeView_Title"] = "Выберите пункт";
+        Values["TreeView_LevelUp"] = "🔼 Обратно";
+        Values["ToggleButton_On"] = "Вкл";
+        Values["ToggleButton_Off"] = "Выкл";
+        Values["ToggleButton_OnIcon"] = "⚫";
+        Values["ToggleButton_OffIcon"] = "⚪";
+        Values["ToggleButton_Title"] = "Переключить";
+        Values["ToggleButton_Changed"] = "Выбрано";
+        Values["MultiToggleButton_SelectedIcon"] = "✅";
+        Values["MultiToggleButton_Title"] = "Множественный выбор";
+        Values["MultiToggleButton_Changed"] = "Выбрано";
+        Values["PromptDialog_Back"] = "Назад";
+        Values["ToggleButton_Changed"] = "Настройки изменены";
+        Values["ButtonGrid_SearchIcon"] = "🔍";
+        Values["ButtonGrid_TagIcon"] = "📁";
+    }
+}

TelegramBotBase/TelegramBotBase.nuspec

@@ -14,12 +14,10 @@
     <dependencies>
       <group targetFramework=".NETFramework4.6.1">
         <dependency id="Newtonsoft.Json" version="13.0.1" exclude="Build,Analyzers" />
-        <dependency id="System.Drawing.Common" version="4.6.0" exclude="Build,Analyzers" />
         <dependency id="Telegram.Bot" version="19.0.0" exclude="Build,Analyzers" />
       </group>
       <group targetFramework=".NETStandard2.0">
         <dependency id="Newtonsoft.Json" version="13.0.1" exclude="Build,Analyzers" />
-        <dependency id="System.Drawing.Common" version="4.6.0" exclude="Build,Analyzers" />
         <dependency id="Telegram.Bot" version="19.0.0" exclude="Build,Analyzers" />
       </group>
     </dependencies>