feat: Configuration implemented

Author: gcarreno

pasirclogbot.example.config

@@ -0,0 +1,7 @@
+[Main]
+Host="localhost"
+Port=6667
+NickName="[PasLogBot]"
+UserName="paslogbot"
+RealName="IRC channel #pascal log bot"
+Channel="#pascal"

src/bot/bot.pas src/bot/irclogbot.bot.passrc/bot/bot.pas renamed to src/bot/irclogbot.bot.pas

@@ -1,4 +1,4 @@
-unit Bot;
+unit IRCLogBot.Bot;
 
 {$mode ObjFPC}{$H+}
 
@@ -35,8 +35,8 @@   TIRCLogBot = class(TObject)
       ATarget, AMessage: String);
   protected
   public
-    constructor Create(ANickName, AUserName, ARealName, AHost: String;
-      APort: Word; AChannel: String);
+    constructor Create(AHost: String; APort: Word;
+      ANickName, AUserName, ARealName, AChannel: String);
     destructor Destroy; override;
 
     procedure Run;
@@ -124,12 +124,12 @@ procedure TIRCLogBot.Shutdown;
   if FIRC.Connected then
   begin
     WriteLn('Disconnecting...');
-    FIRC.Disconnect('Quitting.');
+    FIRC.Disconnect('Need to go and have a wee nap.');
   end;
 end;
 
-constructor TIRCLogBot.Create(ANickName, AUserName, ARealName, AHost: String;
-  APort: Word; AChannel: String);
+constructor TIRCLogBot.Create(AHost: String; APort: Word; ANickName, AUserName,
+  ARealName, AChannel: String);
 begin
   FNickname:= ANickname;
   FUsername:= AUserName;

src/config/irclogbot.config.pas

@@ -0,0 +1,92 @@
+unit IRCLogBot.Config;
+
+{$mode ObjFPC}{$H+}
+
+interface
+
+uses
+  Classes
+, SysUtils
+, IniFiles
+;
+
+type
+{ TBotConfig }
+  TBotConfig = class(TObject)
+  private
+    FINIFile: String;
+    FINI: TIniFile;
+    FHost: String;
+    FPort: Word;
+    FNickName: String;
+    FUserName: String;
+    FRealName: String;
+    FChannel: String;
+  protected
+  public
+    constructor Create(AConfigFile: String);
+    destructor Destroy; override;
+
+    procedure LoadValues;
+
+    property Host: String
+      read FHost
+      write FHost;
+    property Port: Word
+      read FPort
+      write FPort;
+    property NickName: String
+      read FNickName
+      write FNickName;
+    property UserName: String
+      read FUserName
+      write FUserName;
+    property RealName: String
+      read FRealName
+      write FRealName;
+    property Channel: String
+      read FChannel
+      write FChannel;
+  published
+  end;
+
+implementation
+
+{ TBotConfig }
+
+constructor TBotConfig.Create(AConfigFile: String);
+begin
+  FINIFile:= AConfigFile;
+  FHost:= 'localhost';
+  FPort:= 6667;
+  FNickName:= '';
+  FUserName:= '';
+  FRealName:= '';
+  FChannel:= '';
+end;
+
+destructor TBotConfig.Destroy;
+begin
+  inherited Destroy;
+end;
+
+procedure TBotConfig.LoadValues;
+begin
+  if FileExists(FINIFile) then
+  begin
+    FINI:= TIniFile.Create(FINIFile);
+    FHost:= FINI.ReadString('Main', 'Host', 'localhost');
+    FPort:= FINI.ReadInteger('Main', 'Port', 6667);
+    FNickName:= FINI.ReadString('Main', 'NickName', '');
+    FUserName:= FINI.ReadString('Main', 'UserName', '');
+    FRealName:= FINI.ReadString('Main', 'RealName', '');
+    FChannel:= FINI.ReadString('Main', 'Channel', '');
+  end
+  else
+  begin
+    raise EFileNotFoundException.Create(Format('Cannot find file "%s".', [FINIFile]));
+  end;
+end;
+
+end.
+

src/paslogbot.lpi

@@ -23,7 +23,7 @@
           </Target>
           <SearchPaths>
             <IncludeFiles Value="$(ProjOutDir)"/>
-            <OtherUnitFiles Value="bot"/>
+            <OtherUnitFiles Value="bot;config"/>
             <UnitOutputDirectory Value="../bin/lib/$(TargetCPU)-$(TargetOS)"/>
           </SearchPaths>
           <Parsing>
@@ -57,7 +57,7 @@
           </Target>
           <SearchPaths>
             <IncludeFiles Value="$(ProjOutDir)"/>
-            <OtherUnitFiles Value="bot"/>
+            <OtherUnitFiles Value="bot;config"/>
             <UnitOutputDirectory Value="../bin/lib/$(TargetCPU)-$(TargetOS)"/>
           </SearchPaths>
           <CodeGeneration>
@@ -95,9 +95,14 @@
         <IsPartOfProject Value="True"/>
       </Unit>
       <Unit>
-        <Filename Value="bot/bot.pas"/>
+        <Filename Value="bot/irclogbot.bot.pas"/>
         <IsPartOfProject Value="True"/>
-        <UnitName Value="Bot"/>
+        <UnitName Value="IRCLogBot.Bot"/>
+      </Unit>
+      <Unit>
+        <Filename Value="config/irclogbot.config.pas"/>
+        <IsPartOfProject Value="True"/>
+        <UnitName Value="IRCLogBot.Config"/>
       </Unit>
     </Units>
   </ProjectOptions>
@@ -108,7 +113,7 @@
     </Target>
     <SearchPaths>
       <IncludeFiles Value="$(ProjOutDir)"/>
-      <OtherUnitFiles Value="bot"/>
+      <OtherUnitFiles Value="bot;config"/>
       <UnitOutputDirectory Value="../bin/lib/$(TargetCPU)-$(TargetOS)"/>
     </SearchPaths>
   </CompilerOptions>

src/paslogbot.lpr

@@ -4,10 +4,10 @@
 
 uses
   {$IFDEF UNIX}
-  cthreads,
+  cThreads,
   BaseUnix,
   {$ENDIF}
-  Classes, SysUtils, CustApp, Bot
+  Classes, SysUtils, CustApp, IRCLogBot.Bot, IRCLogBot.Config
   { you can add units after this };
 
 type
@@ -16,6 +16,8 @@
   TPasLogBot = class(TCustomApplication)
   private
     FIRCLogBot: TIRCLogBot;
+    FConfigFile: String;
+    FBotConfig: TBotConfig;
   protected
     procedure DoRun; override;
   public
@@ -93,7 +95,7 @@ procedure TPasLogBot.DoRun;
   // Signal Handling
   SetupSignalHandlers;
   // quick check parameters
-  ErrorMsg:= CheckOptions('h', 'help');
+  ErrorMsg:= CheckOptions('hc:', ['help', 'config:']);
   if ErrorMsg<>'' then
   begin
     //ShowException(Exception.Create(ErrorMsg));
@@ -109,13 +111,50 @@ procedure TPasLogBot.DoRun;
     exit;
   end;
 
+  if HasOption('c', 'config') then
+  begin
+    FConfigFile:= GetOptionValue('c', 'config');
+  end
+  else
+  begin
+    FConfigFile:= ConcatPaths([GetUserDir, '.pasirclogbot']);
+  end;
+
+  WriteLn(Format('Attempting to read config from: "%s"...', [FConfigFile]));
+
+  { #todo 100 -ogcarreno : Parse param c/config }
+  FBotConfig:= TBotConfig.Create(FConfigFile);
+  try
+    FBotConfig.LoadValues;
+  except
+    on e:Exception do
+    begin
+      WriteLn(Format('Error: %s', [e.Message]));
+      Terminate;
+      exit;
+    end;
+  end;
+
+  { #todo 100 -ogcarreno : Use data from config }
+  WriteLn('Creating IRC client...');
+  FIRCLogBot:= TIRCLogBot.Create(
+    FBotConfig.Host,
+    FBotConfig.Port,
+    FBotConfig.NickName,
+    FBotConfig.UserName,
+    FBotConfig.Realname,
+    FBotConfig.Channel
+  );
+  WriteLn('Successfully created IRC client.');
   WriteLn('Starting...');
+  { #todo 100 -ogcarreno : Read Config }
   FIRCLogBot.Run;
   while not Terminated do
   begin
     Sleep(50);
   end;
   FIRCLogBot.Shutdown;
+  FIRCLogBot.Free;
   WriteLn('Exiting.');
   // stop program loop
   //Terminate;
@@ -125,26 +164,22 @@ constructor TPasLogBot.Create(TheOwner: TComponent);
 begin
   inherited Create(TheOwner);
   StopOnException:= True;
-  FIRCLogBot:= TIRCLogBot.Create(
-    '[PasLogBot]',
-    'paslogbot',
-    'Pascal channel IRC log bot',
-    'localhost',
-    6667,
-    '#test'
-  );
 end;
 
 destructor TPasLogBot.Destroy;
 begin
-  FIRCLogBot.Free;
   inherited Destroy;
 end;
 
 procedure TPasLogBot.WriteHelp;
 begin
   { add your help code here }
-  WriteLn('Usage: ', ExtractFileName(ExeName), ' -h');
+  WriteLn('Usage:');
+  WriteLn('  ', ExtractFileName(ExeName), ' [PARAMS]');
+  WriteLn;
+  WriteLn('PARAMS:');
+  WriteLn('    -h/--help         This help message.');
+  WriteLn('    -c/--config=FILE  Use provided FILE as config. ( default: ~/.pasirclogbot )');
 end;
 
 begin