chore: Storing state for debug with Remy

Author: gcarreno

pasirclogbot.example.config

@@ -1,9 +1,12 @@
 [IRC]
-Host="localhost"
+#Host="localhost"
+Host="irc.libera.chat"
 Port=6667
-NickName="[PasLogBot]"
-UserName="paslogbot"
+#NickName="[PasLogBot]"
+NickName="[PasLogBotDev]"
+UserName="paslogbotdev"
 RealName="IRC channel #pascal log bot"
 Channel="#pascal"
+UseUTF8=1
 [DB]
 File="paslogbot.db"

research/ChatGPT-Colours.md

@@ -0,0 +1,81 @@
+# Prompt
+
+Can you please teach me how to include colour in IRC messages?
+
+# Answer
+
+
+
+Including color in IRC messages involves using special control codes that are recognized by most IRC clients. These control codes allow you to format your messages with different colors or styles like bold or underline. Here's how you can do it:
+
+### 1. **Color Control Code**
+- The control code for color is **`Ctrl + K`**, which appears as `\x03` in raw text.
+- After the color code, you specify the foreground color number, optionally followed by a comma and the background color number.
+
+### 2. **Color Codes**
+Here are the standard IRC color codes:
+
+| Code | Color          | Code | Color          |
+|------|----------------|------|----------------|
+| 00   | White          | 08   | Yellow         |
+| 01   | Black          | 09   | Light Green    |
+| 02   | Blue (Navy)    | 10   | Cyan           |
+| 03   | Green          | 11   | Light Cyan     |
+| 04   | Red            | 12   | Light Blue     |
+| 05   | Brown (Maroon) | 13   | Pink           |
+| 06   | Purple         | 14   | Grey           |
+| 07   | Orange         | 15   | Light Grey     |
+
+### 3. **Example Usage**
+To include color in your messages, use the format:
+
+```
+\x03<foreground>,<background>Text
+```
+
+#### Examples:
+1. **Simple colored text** (e.g., Red text):
+   ```
+   \x034This text is red.
+   ```
+   Output: *This text is red.*
+
+2. **Text with a background color** (e.g., Green text on a Yellow background):
+   ```
+   \x033,08This text is green with a yellow background.
+   ```
+   Output: *This text is green with a yellow background.*
+
+3. **Resetting the color**:
+   To stop the color effect, you can use the reset code: **`Ctrl + O`** (`\x0F` in raw text).
+
+   Example:
+   ```
+   \x034Red text\x0F Normal text
+   ```
+   Output: *Red text Normal text.*
+
+### 4. **Styling Codes**
+You can combine colors with other styles:
+
+| Style         | Code   | Description                     |
+|---------------|--------|---------------------------------|
+| Bold          | \x02   | Makes the text bold.           |
+| Underline     | \x1F   | Underlines the text.           |
+| Italic        | \x1D   | Italicizes the text.           |
+| Reverse Color | \x16   | Swaps foreground and background. |
+
+#### Example with Bold and Color:
+```
+\x02\x034Bold and Red\x0F Normal text
+```
+Output: **Bold and Red** *Normal text.*
+
+### 5. **Send Messages**
+When typing in an IRC client:
+- Use `Ctrl + K` to insert the color code.
+- Follow with the numeric codes for foreground and background colors as needed.
+
+If you're scripting for an IRC bot or using raw IRC commands, include the control characters as their ASCII values (`\x03`, `\x02`, etc.) directly in your message string.
+
+Let me know if you’d like examples in a specific programming language, like Go or PHP, for sending these formatted IRC messages!

src/bot/irclogbot.bot.pas

@@ -7,7 +7,10 @@ interface
 uses
   Classes
 , SysUtils
+, IdGlobal
 , IdContext
+, IdComponent
+, IdCmdTCPClient
 , IdIRC
 , IRCLogBot.Config
 , IRCLogBot.Database
@@ -37,6 +40,14 @@   TIRCLogBot = class(TObject)
       AChannel: String);
     procedure OnPrivateMessage(ASender: TIdContext; const ANickname, AHost,
       ATarget, AMessage: String);
+    procedure OnISupport(ASender: TIdContext; AParameters: TStrings);
+    procedure OnStatus(ASender: TObject; const AStatus: TIdStatus;
+      const AStatusText: string);
+    procedure OnRaw(ASender: TIdContext; AIn: Boolean; const AMessage: String);
+    procedure OnBeforeCommandHandler(ASender: TIdCmdTCPClient;
+      var AData: string; AContext: TIdContext);
+    procedure OnAfterCommandHandler(ASender: TIdCmdTCPClient;
+      AContext: TIdContext);
 
     procedure Help(const ATarget: String);
     procedure Version(const ATarget: String);
@@ -103,6 +114,12 @@ procedure TIRCLogBot.OnJoin(ASender: TIdContext; const ANickname, AHost,
   ]);
   if (ANickname = FConfig.NickName) and (AChannel = FConfig.Channel) then
   begin
+    if FConfig.UseUTF8 then
+    begin
+      debug('Using UTF8');
+      FIRC.IOHandler.DefStringEncoding:= IndyTextEncoding_UTF8;
+    end;
+
     debug('Successfully joined my channel.');
     FJoinedChannel:= True;
     FIRC.Say(AChannel, 'I have arrived!!! TADAAAAA!!! Send me a private message with ".help" to see what I can do for you.');
@@ -194,6 +211,38 @@ procedure TIRCLogBot.OnPrivateMessage(ASender: TIdContext; const ANickname,
   end;
 end;
 
+procedure TIRCLogBot.OnISupport(ASender: TIdContext; AParameters: TStrings);
+begin
+  debug('I Support: %s', [AParameters]);
+end;
+
+procedure TIRCLogBot.OnStatus(ASender: TObject; const AStatus: TIdStatus;
+  const AStatusText: string);
+begin
+  debug('Status: (%d) %s', [Ord(AStatus), AStatusText]);
+end;
+
+procedure TIRCLogBot.OnRaw(ASender: TIdContext; AIn: Boolean;
+  const AMessage: String);
+begin
+  if AIn then
+    debug('RAW(In ): "%s"', [AMessage])
+  else
+    debug('RAW(Out): "%s"', [AMessage]);
+end;
+
+procedure TIRCLogBot.OnBeforeCommandHandler(ASender: TIdCmdTCPClient;
+  var AData: string; AContext: TIdContext);
+begin
+  debug('Before Command: %s', [AData]);
+end;
+
+procedure TIRCLogBot.OnAfterCommandHandler(ASender: TIdCmdTCPClient;
+  AContext: TIdContext);
+begin
+  debug('After Command');
+end;
+
 procedure TIRCLogBot.Help(const ATarget: String);
 begin
   debug('Help command.');
@@ -304,12 +353,24 @@ constructor TIRCLogBot.Create(const AConfig: TBotConfig);
   FIRC.RealName:= FConfig.RealName;
   FIRC.Host:= FConfig.Host;
   FIRC.Port:= FConfig.Port;
+  { #todo 100 -ogcarreno : Need to revisit these }
+  //FIRC.Replies.ClientInfo:= 'PasLogBot';
+  //FIRC.Replies.Finger:= 'paslogbot';
+  //FIRC.Replies.UserInfo:= 'paslogbot';
+  //FIRC.Replies.Version:= cVersion;
+
+  // Events
   FIRC.OnConnected:= @OnConnected;
   FIRC.OnDisconnected:= @OnDisconnected;
   FIRC.OnServerQuit:= @OnServerQuit;
   FIRC.OnJoin:= @OnJoin;
   FIRC.OnNotice:= @OnNotice;
   FIRC.OnPrivateMessage:= @OnPrivateMessage;
+  //FIRC.OnISupport:= @OnISupport;
+  //FIRC.OnStatus:= @OnStatus;
+  //FIRC.OnRaw:= @OnRaw;
+  //FIRC.OnBeforeCommandHandler:= @OnBeforeCommandHandler;
+  //FIRC.OnAfterCommandHandler:= @OnAfterCommandHandler;
 
   // Setup Database
   FDB:= TDatabase.Create(FConfig.Database);

src/config/irclogbot.config.pas

@@ -23,6 +23,7 @@   TBotConfig = class(TObject)
     FIRCUserName: String;
     FIRCRealName: String;
     FIRCChannel: String;
+    FIRCUseUTF8: Boolean;
 
     FDBFile: String;
   protected
@@ -50,6 +51,9 @@   TBotConfig = class(TObject)
     property Channel: String
       read FIRCChannel
       write FIRCChannel;
+    property UseUTF8: Boolean
+      read FIRCUseUTF8
+      write FIRCUseUTF8;
 
     property Database: String
       read FDBFile
@@ -70,6 +74,7 @@ constructor TBotConfig.Create(AConfigFile: String);
   FIRCUserName:= '';
   FIRCRealName:= '';
   FIRCChannel:= '';
+  FIRCUseUTF8:= False;
 end;
 
 destructor TBotConfig.Destroy;
@@ -89,6 +94,7 @@ procedure TBotConfig.LoadValues;
       FIRCUserName:= FINI.ReadString('IRC', 'UserName', '');
       FIRCRealName:= FINI.ReadString('IRC', 'RealName', '');
       FIRCChannel:= FINI.ReadString('IRC', 'Channel', '');
+      FIRCUseUTF8:= FINI.ReadBool('IRC', 'UseUTF8', False);
 
       FDBFile:= FINI.ReadString('DB', 'File', 'paslogbot.db');