Bot Gadu-Gadu

<font size="4">Wstęp</span>

Protokół Gadu-Gadu jest w Polsce powszechnie znany i lubiany, co świadczy o dużej liczbie użytkowników. Prawie każdy internauta go używa. Lecz nie o tym temat. Zajmiemy się dzisiaj korzystać z dobrodziejstw tego protokołu w Delphi. Co prawda nie będziemy pisać wszystkiego od początku, bo bym musiał pisać osobny artykuł, lecz posłużymy się gotowym komponentem THGG (ten artykuł jest tak jakby instrukcją). Dany komponent, by mógł poprawnie funkcjonować , potrzebna mu będzie paczka Indy (wersję 9.x).
Celem naszym będzie napisanie prostego bota, który będzie odpisywał na podane komendy. Będzie to troszeczkę wersja rozbudowana.
To więc co? Do dzieła.

<font size="4">Część wizualna</span>

Przepis:
To więc wrzucamy poniższe komponenty na formę:

• Panel (zakładka standard)
• THGG
• SaveDialog i OpenDialog (zakładka Dialogs)
• ValueListEditor (zakładka Additional)
• 3 Edit'y
• 5 Button'ów
• Label
• Memo

Przygotowanie:

#Panel: Ustaw go w lewym górnym rogu tak jak na obrazku. Zmień jego Name na 'PlStatus'.
#ValueListEditor: Zmień jego nazwę na Command, oraz wybierz z Menu Object Inspector – TitleCaptions ... i dodaj do wyświetlonego pola tekstowego 'Komenda' i 'Odpowiedź' (każde w osobnej linii). Jeśli już tam jesteśmy to wybierz też Strings i w kolumnie Key wpisz 'Witaj' a znów w polu Value daj 'Witam człowieku :D'
#Edit1 : Ustaw go tak jak na obrazku
#Edit2 : Ustaw go tak jak na obrazku
#Edit3 : Zmień jego Name na TmpEdit, oraz usuń wartość z Text. Następnie schowaj go, aby ci nie przeszkadzał. On i tak będzie schowany podczas pracy programu.
#Button1 : Zmień Caption na 'Połącz'
#Button2 : Zmień Caption na 'Rozłącz'
#Button3: Zmień Caption na 'Dodaj
#Button4 : Zmien Caption na 'Zapisz'
#Button5 : Zmien Caption na 'Ładuj
#Label1: Zmień Caption na 'Logi Bota'
#Memo1: Usuń jego wartość Lines.
#THGG: Name zostaw tak jak jest, czyli na hgg1.
#SaveDialog1 - Dodaj filtr na nasze rozszerzenie, czyli ggb, poprzez klikniecie na ... w Filter w Inspektorze obiektów. W kolumnie filter name wstaw 'Gadu Gadu Bot (.ggb)' a znów w Filter na '.ggb'
#OpenDialog1 - też dodajemy filtr. Tak samo jak w SaveDialog1, tylko w kolumnie Filter zamiast '*.ggb' daj na '.ggb'

Mniej więcej ustaw komponenty tak jak na obrazku poniżej:

<font size="4">Część programistyczna</span>

Teraz już odpowiednia cześć naszego programu. Więc na początek wywołajmy procedurę OnClick Buttona 1. Uzupełnij go poniższym kodem:

procedure TForm1.Button1Click(Sender: TObject);
begin
  try
    hgg1.Number  := numerGG;
    hgg1.Password  := '*****';
    HGG1.Host := HGG1.GetServerAddress;
    hgg1.Status:=usAvailable;
    hgg1.connect;
  except
    ShowMessage('Wystąpił błąd');
    hgg1.Disconnect;
  end;
end;

Wyjaśnienie:
*hgg1.Number - to jest zmienna, którą uzupełniamy naszym numerem GaduGadu
*hgg1.Password - jak sama nazwa wskazuje, podajemy hasło do danego numeru GaduGadu
*HGG1.Host := HGG1.GetServerAddress; - tutaj ustawiamy adres IP serwera GG. Jeśli damy na HGG1.GetServerAddress to THGG sam sprawdzi i da odpowiedni aktywny IP.
*hgg1.Status:=usAvailable; - Ustawiamy status na aktywny. Mamy do wyboru
**usNotAvailable - niedostępny
**usAvailable dostępny
**usBusy - zajęty
**usInvisible - niewidoczny
*hgg1.connect; - połączenie się z serwerem.
*hgg1.Disconnect; - rozłączenie się z serwerem

Teraz wybierz THGG, i w inspektorze obiektów wybierz zakładkę Events, i wywołaj procedurę OnConnected. Uzupełnij go kodem:

procedure TForm1.HGG1Connected(Sender: TObject);
begin
  PlStatus.Color := clLime;
  PlStatus.Caption :='Połączony';
  hgg1.Description :='Bot Gadu-Gadu';
end;

• PlStatus.Color := clLime; - Tutaj zmieniamy kolor Panela na zielony
• PlStatus.Caption :='Połączony'; - zmieniamy Caption Panela na 'Połączony'
• hgg1.Description :='Bot Gadu-Gadu'; - Ustawiamy opis Gadu-Gadu

Teraz też z tego komponentu wywołaj procedurę OnDisconnet i wpisz do tej niej:

procedure TForm1.HGG1Disconnected(Sender: TObject);
begin
  PlStatus.Color := clRed;
  PlStatus.Caption :='Niepołączony';
end;

Ustaw też w procedurze OnMessage:

procedure TForm1.HGG1Message(Sender: TObject; GGNumber: Integer;
  MessageContent: String; MessageTime: TDateTime);
var
  Reply : string;
  Row : integer;
begin
 Memo1.Lines.Add('['+DateToStr(MessageTime)+']('+IntToStr(GGNumber)+') '+MessageContent);
 TmpEdit.Text := MessageContent;
    Command.FindRow(TmpEdit.Text,  Row);

 if  Row = -1 then
  Reply := 'Nie ma u nas takiej komendy' else
 begin
  Reply := Command.Values[Edit1.Text];
 end;

  HGG1.SendMessage(GGNumber, Reply, []);
end;

Powyższa procedura jest wykonywana wtenczas, jak ktoś wyśle do nas wiadomość. Masz w niej do dyspozycji zmienne:

• GGNumber - numer od kogo został wysłana wiadomość
• MessageContent - Treść wiadomości
• MessageTime - czas wysłania wiadomości.
  Co w niej wykonujemy? Po pierwsze dodajemy odebraną wiadomość do komponentu Memo1 (nasza log-lista), następnie do TmpEdit dajemy otrzymana wiadomość. Dlaczego? Iż jest jeden błąd. Gdybyśmy odróżniali wiadomość prosto z zmiennej MessageContent to by nasz program później nie odróżniał komend. Po prostu program nasz jest tak leniwy, ze myśli ze zmienna MessageContent się nie zmienia, i przy drugiej wysłanej wiadomości zmienna MessageContent jest równa pierwszej wiadomości, czyli się nie zmieniła.

W procedurze OnClick Buttonu 2 wpisz:

procedure TForm1.Button2Click(Sender: TObject);
begin
 hgg1.disconnect;
end;

Kliknij 2x w puste miejsce formy. Tak właśnie przejdziesz do kodu i wywołasz procedurę OnCreate. Wpisz do niej:

PlStatus.Color := clRed; // zmieniamy kolor panela na czerwony
PlStatus.Caption := 'Niepołączony';// i caption na Niepołączony
TmpEdit.Hide; // Ukrywamy nasz edit TmpEdit
Memo1.Clear; // czyścimy Memo

Ok. Teraz klikamy 2x na button 3 :

procedure TForm1.Button3Click(Sender: TObject);
var
  RowNo : Integer;
begin
Command.FindRow(Edit1.Text, RowNo);
   if  RowNo = -1 then
Command.InsertRow(Edit1.Text, Edit2.Text, true)
else
ShowMessage('Jest już taka komenda w rzędzie '+IntToStr( RowNo))
end;

Tutaj sprawdzamy czy już użytkownik dodał daną komendę do tabeli.

Przejdźmy jeszcze raz na formę i wywołajmy procedurę OnClose. Wpisz do niej:

procedure TForm1.FormClose(Sender: TObject; var Action: TCloseAction);
begin
      hgg1.disconnect;
end;

Rozłączamy się z serwerem gg podczas zamykania programu.

Teraz przejdźmy do komponentu ValueListEditor - Command. Przejdź do listy procedur (Events) i wybierz OnKeyDown. Uzupełnij kodem:

procedure TForm1.CommandKeyDown(Sender: TObject; var Key: Word;
  Shift: TShiftState);
begin
  if Integer(Key)=46  then
    begin
        if MessageBox(Handle,PChar('Czy napewno usunąć komendę '+Command.Strings[Command.Selection.Top -1]+' ?'),
            'Usuwanie', MB_YESNO + MB_ICONQUESTION) = IdYes then
              begin
                Command.DeleteRow(Command.Selection.Top);
              end;

      end;
end;

Posłuży nam do usuwania rzędu. To znaczy jak ktoś wybierze dowolny rząd i naciśnie klawisz delete, to zostanie usunięty.

Czas na zapisywanie ustawień programu. Co prawda wystarczy tylko zapisać to co jest w Command. Więc tak zróbmy.
Kliknij 2x na Button 4 :

procedure TForm1.Button4Click(Sender: TObject);
begin
SaveDialog1.FileName := 'GaduGaduBot';
if SaveDialog1.Execute then
begin
 Command.Strings.SaveToFile(SaveDialog1.FileName + '.ggb');
end;

Oraz w OnClick buttona 5 :

procedure TForm1.Button5Click(Sender: TObject);
begin
OpenDialog1.Filter :='GaduGadu Bot (*.ggb)|*.ggb';
if OpenDialog1.Execute then begin
Command.Strings.LoadFromFile(OpenDialog1.FileName);
end;
end;

Cały kod powinien wyglądać mniej więcej tak:

unit Unit1;

interface

uses
  Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,
  Dialogs, IdBaseComponent, IdComponent, IdTCPConnection, IdTCPClient, HGG,
  StdCtrls, ExtCtrls, Grids, ValEdit;

type
  TForm1 = class(TForm)
    HGG1: THGG;
    Button1: TButton;
    PlStatus: TPanel;
    Button2: TButton;
    Memo1: TMemo;
    TmpEdit: TEdit;
    Label1: TLabel;
    Command: TValueListEditor;
    Edit1: TEdit;
    Edit2: TEdit;
    Button3: TButton;
    Button4: TButton;
    Button5: TButton;
    SaveDialog1: TSaveDialog;
    OpenDialog1: TOpenDialog;
    procedure HGG1Message(Sender: TObject; GGNumber: Integer;
      MessageContent: String; MessageTime: TDateTime);
    procedure Button1Click(Sender: TObject);
    procedure HGG1Connected(Sender: TObject);
    procedure HGG1Disconnected(Sender: TObject);
     procedure Button2Click(Sender: TObject);
    procedure FormCreate(Sender: TObject);
    procedure Button3Click(Sender: TObject);
    procedure FormClose(Sender: TObject; var Action: TCloseAction);
    procedure CommandKeyDown(Sender: TObject; var Key: Word;
      Shift: TShiftState);
    procedure Button4Click(Sender: TObject);
    procedure Button5Click(Sender: TObject);
  private
    { Private declarations }
  public
    { Public declarations }
  end;

var
  Form1: TForm1;

implementation

{$R *.dfm}






procedure TForm1.Button1Click(Sender: TObject);
begin
  try
    hgg1.Number  := numer;
    hgg1.Password  := '*****';
    HGG1.Host := HGG1.GetServerAddress;
    hgg1.Status:=usAvailable;
    hgg1.connect;
  except
    ShowMessage('Wystąpił błąd');
    hgg1.Disconnect;
  end;
end;

procedure TForm1.HGG1Connected(Sender: TObject);
begin
  PlStatus.Color := clLime;
  PlStatus.Caption :='Połączony';
  hgg1.Description :='Bot Gadu-Gadu';
end;

procedure TForm1.HGG1Disconnected(Sender: TObject);
begin
  PlStatus.Color := clRed;
  PlStatus.Caption :='Niepołączony';
end;

procedure TForm1.Button2Click(Sender: TObject);
begin
 hgg1.disconnect;
end;

procedure TForm1.HGG1Message(Sender: TObject; GGNumber: Integer;
  MessageContent: String; MessageTime: TDateTime);
var
  Reply : string;
  Row : integer;
begin
 Memo1.Lines.Add('['+DateToStr(MessageTime)+']('+IntToStr(GGNumber)+') '+MessageContent);
 TmpEdit.Text := MessageContent;
    Command.FindRow(TmpEdit.Text,  Row);

 if  Row = -1 then
  Reply := 'Nie ma u nas takiej komendy' else
 begin
  Reply := Command.Values[Edit1.Text];
 end;

  HGG1.SendMessage(GGNumber, Reply, []);
end;


procedure TForm1.FormCreate(Sender: TObject);
begin
PlStatus.Color := clRed;
PlStatus.Caption := 'Niepołączony';
TmpEdit.Hide;
Memo1.Clear;
end;

procedure TForm1.Button3Click(Sender: TObject);
var
  RowNo : Integer;
begin
Command.FindRow(Edit1.Text, RowNo);
   if  RowNo = -1 then
Command.InsertRow(Edit1.Text, Edit2.Text, true)
else
ShowMessage('Jest już taka komenda w rzędzie '+IntToStr( RowNo))
end;

procedure TForm1.FormClose(Sender: TObject; var Action: TCloseAction);
begin
      hgg1.disconnect;
end;

procedure TForm1.CommandKeyDown(Sender: TObject; var Key: Word;
  Shift: TShiftState);
begin
  if Integer(Key)=46  then
    begin
        if MessageBox(Handle,PChar('Czy napewno usunąć komendę '+Command.Strings[Command.Selection.Top -1]+' ?'),
            'Usuwanie', MB_YESNO + MB_ICONQUESTION) = IdYes then
              begin
                Command.DeleteRow(Command.Selection.Top);
              end;

      end;
end;

procedure TForm1.Button4Click(Sender: TObject);
begin
SaveDialog1.FileName := 'GaduGaduBot';
if SaveDialog1.Execute then
begin
 Command.Strings.SaveToFile(SaveDialog1.FileName + '.ggb');
end;



end;

procedure TForm1.Button5Click(Sender: TObject);
begin
OpenDialog1.Filter :='GaduGadu Bot (*.ggb)|*.ggb';
if OpenDialog1.Execute then begin
Command.Strings.LoadFromFile(OpenDialog1.FileName);
end;
end;

end.

Komponent THGG zawiera wiele, wiele więcej funkcji. Zapraszam do przeczytania dokumentacji, która jest dołączona razem z nim.

Załączniki

GGB.zip - Gotowy program z kodem źródłowym
THGG - http://members.chello.pl/w.redlowska/hakger/projthgg.htm
Mirror 2 http://download.4programmers.net/THGG.zip

Bordeux
http://www.bordeux.net