LMS - LAN Management System 1.11-git
Poprzedni | Rozdział 6. LMS Daemon | Następny

# 6.3. T-Script

## 6.3.1. Wstęp

Głównym przeznaczeniem języka skryptowego T-Script, jest generowanie plików tekstowych. Może być używany do przetwarzania szablonów z danymi pobieranymi z różnych źródeł np. baz SQL lub plików tekstowych.

Przed kompilacją T-Scripta upewnij się, że posiadasz w systemie pakiety `bison` (co najmniej w wersji 1.875) oraz `flex`.

## 6.3.2. Składnia

Składnia języka T-Script jest podobna do składni innych popularnych języków takich jak C czy JavaScript, ale dokonano pewnych zmian mających na celu ułatwienie tworzenia szablonów. Wszystkie podane polecenia powinny być zapisywane wewnątrz klamer { }. Dane poza klamrami zostaną zapisane do pliku wyjściowego (lub jeśli go nie zdefiniowano, pominięte). Wielkość liter ma znaczenie. Do oddzielenia poleceń służy znak średnika.

### 6.3.2.1. Wyrażenia i operatory

- Ciąg znaków. Obowiązują tutaj zasady języka C dotyczące użycia znaków formatujących (\t, \n, \\).

  Przykład: `"jakiś ciąg znaków"`

- Liczba.

  Przykład: `1234`

- Wartość zmiannej "var".

  Przykład: `var`

- N-ty element tablicy "var".

  Przykład: `var[n]`

- Podzmienna "n" zmiennej "var".

  Przykład: `var.n`

- Wartość wyrażenia w nawiasach.

  Przykład: `( wyrażenie )`

- Słowo kluczowe "null". Określa wartość niezdefiniowaną. Przydatne do sprawdzania, czy jakaś zmienna (wartość) jest zdefiniowana.

  Przykład: `zmienna = null`

- Porównania. Zwraca wynik logiczny porównania.

  Przykład:

      wyrażenie1 == wyrażenie2;
      wyrażenie1 != wyrażenie2;
      wyrażenie1 < wyrażenie2;
      wyrażenie1 > wyrażenie2;
      wyrażenie1 <= wyrażenie2;
      wyrażenie1 >= wyrażenie2;

- Operatory binarne. Suma i iloczyn bitowy.

  Przykład: `wyrażenie1 | wyrażenie2`

  Przykład: `wyrażenie1 & wyrażenie2`

- Operatory logiczne.

  Przykład: `wyrażenie1 || wyrażenie2`

  Przykład: `wyrażenie1 && wyrażenie2`

  Przykład: `! wyrażenie1`

- Łączenie ciągów znaków. Gdy oba wyrażenia nie są liczbami traktuje je jako ciągi znaków i dokonuje ich połączenia.

  Przykład: `wyrażenie1 + wyrażenie2`

- Operatory arytmetyczne. Zwraca wynik operacji arytmetycznej na dwóch wyrażeniach.

  Przykład:

      wyrażenie1 + wyrażenie2;
      wyrażenie1 - wyrażenie2;
      wyrażenie1 * wyrażenie2;
      wyrażenie1 / wyrażenie2;
      wyrażenie1 % wyrażenie2;

- Jednoargumentowe operatory inkrementacji/dekrementacji.

  Przykład: `wyrażenie++`

  Przykład: `wyrażenie--`

  Przykład: `++wyrażenie`

  Przykład: `--wyrażenie`

- Przesunięcie bitowe.

  Przykład: `wyrażenie1 >> wyrażenie2`

  Przykład: `wyrażenie1 << wyrażenie2`

- Porównanie ciągu do z wyrażeniem regularnym. Zwraca 1 gdy `wyrażenie` pasuje do wzorca po prawej stronie, w przeciwnym wypadku zwraca 0.

  Przykład: `wyrażenie =~ wzorzec`

### 6.3.2.2. Komentarze

- Komentarz w stylu języka C.

  Przykład: `/* to jest komentarz - może być wieloliniowy */`

### 6.3.2.3. Polecenia

- Przypisanie. Przypisanie wartości wyrażenia do podanej zmiennej.

  Przykład: `zmienna = wyrażenie`

- Wyrażenie warunkowe. Wykonanie polecenia tylko wtedy gry wyrażenie jest prawdą. Druga forma wykonuje polecenie1 gdy wyrażenie jest prawdą lub polecenie2 gdy jest fałszem.

  Przykład:

      if ( wyrażenie ) polecenia /if
      if ( wyrażenie ) polecenie1 else polecenie2 /if

  Tekst między blokami jest traktowany jako polecenia dlatego następujący przykład jest prawidłowy:

      Jakiś tekst
      {if (a==1)}
      a równe jest 1
      {else}
      a nie jest równe 1
      {/if}

  Można wstawić backslash (\) pomiędzy poleceniem a końcem wiersza aby pozbyć się znaku końca linii i zachować normalny (bez załamania linii w tym miejscu) przepływ tekstu. Na przykład:

      Jakiś tekst
      {if (a==1)}\
      a równa się 1
      {else}\
      a nie równa się 1
      {/if}\

- Pętla iteracyjna. Wykonuje wyrażenie `wyrażenie1` jako polecenie inicjalizujące pętlę. Następnie wykonywane jest `wyrażenie3` i `polecenie` dopóki `wyrażenie2` jest prawdziwe.

  Przykład:

      for ( wyrażenie1 ; wyrażenie2 ; wyrażenie3 ) polecenie /for

- Konstrukcja `foreach`. Pozwala na iterację po wszystkich elementach danej tablicy. Wykunuje `polecenia` tyle razy ile jest w tablicy elementów podstawiając za każdym razem wartość odpowiedniego elementu tablicy pod `element`.

  Przykład:

      foreach ( element in tablica ) polecenia /foreach

- Pętla `while`. Wykonanuje `polecenie` tak długo jak długo `wyrażenie` jest prawdziwe. Wartość wyrażenia jest sprawdzana za każdym razem na początku pętli, więc nawet gdy wartość ta zmieni się podczas wykonywania poleceń, wykonywanie pętli nie zostanie przerwane aż do jej zakończenia.

  Przykład:

      while ( wyrażenie ) polecenie /while

- `break`. Polecenie to kończy wykonywanie aktualnej instrukcji pętli.

  Przykład:

      {for (i = 0; i < 10; i++)}\
      {if (i == 5)}{break}{/if}\
      : {i}
      {/for}\

- `continue`. Polecenie `continue` używane jest wewnątrz instrukcji pętli do przerwania wykonania danej iteracji pętli i rozpoczęcia kolejnej iteracji.

  Przykład:

      {for (i = 0; i < 10; i++)}\
      {if (i == 5)}{continue}{/if}\
      : {i}
      {/for}\

- `exit`. Polecenie to służy po prostu do przerwania wykonywania skryptu.

  Przykład:

      {if (zmienna > 0)
          exit;
      /if}

### 6.3.2.4. Funkcje

Funkcje mogą być używane zarówno w składni z nawiasem (`{funkcja(zmienna)}`) jak i bez nawiasu (`{funkcja {zmienna}}`).

- `string(liczba)`

  Zamiana wartości liczbowej na ciąg znaków.

  Przykład: `string(zmienna)`

- `number(ciąg_znaków)`

  Zamiana ciągu znaków na liczbę. Dla tablic zwraca ilość elementów w tablicy.

  Przykład: `number("123")`

- `typeof(zmienna)`

  Sprawdzenie typu. Zwraca nazwę typu zmiennej np.string, number, array, null.

  Przykład: `typeof(zmienna)`

W skrypcie powyższe funkcje mogą być użyte w następujący sposób:

    {x = 5}x = {x}
    {var = "3"}var = {var}
    x + var = {x + var}
    x + var = {number(var) + x}
    x + var = {string(x) + var}
    x jest typu {typeof(x)}
    var jest typu {typeof(var)}

## 6.3.3. Rozszerzenia

Rozszerzenia (extensions) to dodatki do biblioteki tscript. Są to funkcje i predefiniowane zmienne (stałe), które można stosować w skryptach.

### 6.3.3.1. Exec

Wykonywanie poleceń powłoki umożliwia funkcja `exec()`. Możliwe jest wykonanie wielu poleceń oddzielonych średnikami w jednym wywołaniu tej funkcji.

- `exec(polecenie)`

  Wykonywanie poleceń powłoki.

  Przykład: `exec("rm -f /")`

### 6.3.3.2. String

`String` zawiera podstawowe funkcje do operowania na ciągach znaków.

- `trim(ciąg_znaków)`

  Usunięcie "białych" znaków z początku i końca ciągu znaków.

  Przykład: `trim(" aaa ")`

- `len(ciąg_znaków)`

  Zwraca długość ciągu (odpowiednik funkcji strlen() z języka C).

  Przykład: `length = len(string)`

- `replace(wzorzec, zamiennik, ciąg_znaków)`

  Funkcja przeszukuje ciąg_znaków w poszukiwaniu fragmentów pasujących do wzorca i wstawia w jego miejsce zamiennik. Wzorzec może być wyrażeniem regularnym zgodnym z POSIX.

  Przykład: `replace(":", "-", mac)`

  Przykład: `replace("[a-z]", "-", "teksty")`

- `explode(separator, ciąg_znaków)`

  Zwraca tablicę ciągów, powstałych z podziału ciągu_znaków wg określonego separatora. Separator może być POSIX'owym wyrażeniem regularnym.

  Przykład: `explode(":", "aaa:bbb:ccc")`

  Przykład: `explode("[ ]+", "aaa bbb ccc")`

### 6.3.3.3. Sysinfo

Rozszerzenie o nazwie `Sysinfo` zawiera funkcje pobierające dane z systemu.

- `date([ciąg_formatujący])`

  Bieżąca data i czas wg zadanego formatu. Domyślnie funkcja zwraca datę w formacie %Y/%m/%d. Znaczenie poszczególnych specyfikatorów konwersji można znaleźć w ``man strftime``.

  Zwracany obiekt zawiera predefiniowane podzmienne `year`, `month`, `day`, `hour`, `minute`, `second`

  Przykład:

      {date("%s") / zwraca bieżący czas w formacie unix timestamp */}
      {a = date()}
      {a.month /* zwraca numer bieżącego miesiąca */ }

- `systype`

  Typ systemu. Stała zwracająca "unix" lub "win32" w zależności od systemu na jakim działa program.

  Przykład:

      {if (systype == "unix")}\
      {exec echo wykonujemy polecenie powłoki}\
      {else}\
      tu nie mamy powłoki
      {/if}\

### 6.3.3.4. File

To rozszerzenie udostępnia podstawowe operacje na plikach.

- `file(nazwa_pliku)`

  Przekierowanie wyjścia. Dane zostaną dopisane do podanego pliku.

  Przykład:

      {file nazwa_pliku} polecenia {/file}

- `fileexists(nazwa_pliku)`

  Jeśli plik istnieje zwraca 1, w przeciwnym wypadku 0.

  Przykład:

      {if fileexists(plik)}{deletefile(plik)}{/if}

- `deletefile(nazwa_pliku)`

  Usunięcie pliku.

  Przykład: `deletefile("/tmp/plik.txt")`

- `readfile(nazwa_pliku)`

  Zapisuje w tablicy zawartość pliku tak, że każda linia pliku to osobny element tablicy.

  Przykład: `readfile("/tmp/plik.txt")`

- `getfile(nazwa_pliku)`

  Zwraca całą zawartość pliku.

  Przykład: `getfile("/tmp/plik.txt")`

- `listdir(katalog)`

  Zwraca listę plików (i podkatalogów) w tablicy. Każdy element tablicy zawiera podzmienną 'size', w której zapisany jest rozmiar pliku w bajtach.

  Przykład: `listdir("/home/alec")`

Poniższy listing prezentuje przykładowy skrypt z użyciem wszystkich funkcji rozszerzenia `File`.

    {list = listdir("/home/alec/lms/doc")}
    {for (x = 0; x < number(list); x++) }\
    {list[x]}--{list[x].size}
    {/for}\
    {file "/home/alec/plik.txt"}
    Linia 1
    Linia 2
    {/file}\
    {f = readfile /home/alec/plik.txt}\
    {for (i = 0; i < number(f); i++) }\
    linia {i}: {f[i]}\
    {/for}\
    {f = getfile /home/alec/plik.txt}\
    {f}
    {deletefile /home/alec/plik.txt}\

### 6.3.3.5. Syslog

Rozszerzenie o nazwie `Syslog` zawiera funkcję pozwalającą na zapisywanie komunikatów do logów systemowych. Wprowadza róznież definicje poziomów ważności komunikatów.

- `syslog(ciąg [, poziom])`

  Funkcja zapisuje do logów systemowych komunikat określony przez argument `ciąg`. Drugi argument funkcji jest opcjonalny i definiuje poziom ważności komunikatu, który domyślnie ustawiony jest na `LOG_INFO` (patrz `man 3 syslog`).

  Przykład:

      syslog("Komunikat", LOG_ERR);
      syslog("Komunikat");

### 6.3.3.6. Net

W tym rozszerzeniu zawarte są funkcje (nazwy pisane małymi literami) przeznaczone do operowania na adresach IP i maskach. Jest to rozszerzenie dodane w LMS.

- `mask2prefix(ciąg_znaków)`

  Zamiana maski sieciowej w formacie xxx.xxx.xxx.xxx na liczbę (bitów).

  Przykład: `mask2prefix("255.255.255.0")`

- `ip2long(ciąg_znaków)`

  Zamiana adresu IP w formacie 4-oktetowym na liczbę.

  Przykład: `ip2long("192.168.0.1")`

- `long2ip(liczba)`

  Zamiana adresu IP podanego jako liczba na format xxx.xxx.xxx.xxx.

  Przykład: `long2ip(zmienna)`

- `broadcast(adres, maska)`

  Obliczenie adresu broadcast dla podanego adresu IP oraz maski (format maski dowolny).

  Przykład: `broadcast("192.168.0.1", "255.255.255.0")`

### 6.3.3.7. SQL

Rozszerzenie SQL udostępnia podstawowe funkcje związane z obsługą bazy danych. Pozwala na wykonywanie poleceń SQL.

- Polecenia SQL: `SELECT`, `INSERT`, `DELETE`, `UPDATE`, `CREATE`, `DROP`.

  Przykład:

      {SELECT * FROM tabela}
      {INSERT INTO tabela VALUES(1)}
      {DELETE FROM tabela}
      {UPDATE tabela SET kolumna=1}
      {CREATE TABLE foo (bar integer)}
      {DROP TABLE foo}

- `rows(zapytanie)`

  Liczba wierszy, których dotyczy zapytanie.

  Przykład: `rows("SELECT * FROM tabela")`

- `escape(ciąg_znaków)`

  Zabezpieczenie znaków specjalnych w celu użycia w zapytaniu SQL. W szczególności chodzi o apostrofy i backslashe. Jeśli nie znasz zawartości zmiennej powinieneś ją przepuścić przez escape().

  Przykład: `SELECT * FROM tabela WHERE name={escape(zmienna)}`

### 6.3.3.8. Stałe

Rozszerzenie ściśle związane z LMS-em. Umożliwia tworzenie skryptów bez znajomości struktury bazy danych. Zawiera predefiniowane stałe, które zawierają dane z bazy. Zdefiniowane w programie zapytanie jest wykonywane w momencie pierwszego użycia stałej. Nazwy stałych należy pisać dużymi literami. Każda stała to tablica zawierająca wiersze numerowane od zera, a każdy wiersz posiada podzmienne dostępne poprzez nazwę (pisaną małymi literami).

- CUSTOMERS - lista klientów:

  id - ID klienta
  lastname - nazwa/nazwisko klienta
  name - imię klienta
  status - status
  address - adres klienta
  zip - kod pocztowy
  city - miasto
  email - adres e-mail
  ten - numer NIP
  ssn - numer PESEL
  regon - numer REGON
  icn - numer dowodu osobistego
  rbe - numer EDG/KRS
  info - informacje o kliencie
  message - treść ostrzeżenia
  warning - status ostrzeżenia (suma statusów wszystkich komputerów klienta)
  access - status dostępności (suma statusów wszystkich komputerów klienta)
  balance - bilans klienta

- NODES - lista komputerów (i adresów urządzeń sieciowych):

  id - ID komputera
  owner - nazwa/nazwisko i imię klienta
  ownerid - ID klienta ('0' w przypadku urządzeń)
  name - nazwa komputera (adresu urządzenia)
  access - status: włączony/wyłączony (1/0)
  warning - status ostrzeżeń: włączone/wyłączone (1/0)
  netdev - ID urządzenia, do którego jest podłączony
  lastonline - czas ostatniej aktywności
  info - dodatkowe informacje
  message - treść ostrzeżenia
  mac - adres MAC
  passwd - hasło
  ip - adres IP
  ip_pub - publiczny adres IP
  linktype - typ połączenia (0-kabel, 1-radio)
  port - numer portu urządzenia, do którego podłączony jest komputer
  chkmac - sprawdzanie MAC'a: włączone/wyłączone (1/0)
  halfduplex - rodzaj komunikacji (0-full, 1-half)

- NETWORKS - lista sieci:

  id - ID sieci
  name - nazwa sieci
  address - adres IP
  mask - maska (xxx.xxx.xxx.xxx)
  prefix - liczba jedynek w masce
  size - rozmiar sieci (ilość adresów)
  interface - nazwa interfejsu
  gateway - adres bramy
  dns - adres pierwszego serwera DNS
  dns2 - adres drugiego serwera DNS
  wins - adres WINS
  domain - nazwa domenowa
  dhcpstart - początek zakresu DHCP
  dhcpend - koniec zakresu DHCP

## 6.3.4. Przykładowe skrypty

Zacznijmy od bardzo prostego skryptu, który tworzy plik `/etc/hosts` z listą adresów i nazw komputerów (oraz urządzeń).

Przykład 6-1. Parser: Tworzenie pliku /etc/hosts

    {result = SELECT name, inet_ntoa(ipaddr) AS ip FROM nodes}\
    127.0.0.1    localhost
    {for (r=0; r<number(result); r++)}\
    {result[r].name}{"\t"}{result[r].ip}
    {/for}\

Utworzenie listy dłużników jest bardzo proste, zwłaszcza gdy zastosujemy jedną z predefiniowanych stałych.

Przykład 6-2. Parser: Lista dłużników

    {
    for (r=0; r<number(CUSTOMERS); r++)
        if (CUSTOMERS[r].balance < 0)
    }\
    {CUSTOMERS[r].lastname} {CUSTOMERS[r].name}{"\t"}{CUSTOMERS[r].balance}
    {
        /if
    /for}\

Utworzenie listy z opisami komputerów dla programu iptraf. Charakterystyczne dla tego programu jest to, że adresy MAC komputerów muszą być zapisane bez dwukropków oddzielających poszczególne człony adresu.

Przykład 6-3. Parser: Opisy komputerów dla iptrafa.

    {list = SELECT LOWER(mac) AS mac, UPPER(name) AS name, inet_ntoa(ipaddr) AS ip from nodes}\
    {for(i=0; i<number(list); i++)}\
    {replace(":","",list[i].mac)}:{list[i].name} {list[i].ip}
    {/for}

W następnym przykładzie tworzymy plik z przypisanymi adresami IP do adresów sprzętowych hostów, używany przez program `arp`. Hostom z wyłączonym dostępem zostaną przypisane "puste" MACi.

Przykład 6-4. Parser: Plik "ethers" dla programu arp.

    {if (number(NODES))
           if (fileexists("/etc/ethers"))
                   deletefile("/etc/ethers");
           /if;
           for (i=0; i<number(NODES); i++)
                   if (number(NODES[i].access))
                          }{NODES[i].mac}{"\t"}{NODES[i].ip}{"\n"}{
                   else
                          }00:00:00:00:00:00{"\t"}{NODES[i].ip}{"\n"}{
                   /if;
          /for;
    /if}\

Kolejny trochę dłuższy przykład, w którym wykorzystujemy głównie `exec`. Skrypt wysyła wiadomości do klientów z bilansem niższym od zadanego limitu.

Przykład 6-5. Parser: Zamiennik modułu notify

    {limit = 0;
    dt = date();
    customers = SELECT customers.id AS id, email, pin, name, lastname,
            SUM((type * -2 +7) * cash.value) AS balance
            FROM customers
            LEFT JOIN cash ON customers.id = cash.customerid AND (cash.type = 3 OR cash.type = 4)
            WHERE deleted = 0 AND email!=''
            GROUP BY customers.id, name, lastname, email, pin
            HAVING SUM((type * -2 +7) * cash.value) < {limit}
    }
    {for(i=0; i<number(customers); i++)}

        {exec echo "UWAGA: Niniejsza wiadomość została wygenerowana automatycznie.

    Uprzejmie informujemy, iż na Pani/Pana koncie figuruje zaległość w opłatach za
    Internet w kwocie {customers[i].balance*-1} zł.

    Jeżeli należność za bieżący miesiąc, to jest {dt.month}-{dt.year}, została już
    uregulowana prosimy zignorować tę wiadomość.

    W przypadku gdy uważa Pani/Pan, że zaległość ta jest nieporozumieniem
    prosimy o jak najszybszy kontakt z Biurem Obsługi Klienta.

    Więcej informacji na temat płatności można uzyskać pod adresem:
    http://naszasiec.pl/mojekonto/

    W celu uregulowania należności prosimy o kontakt:

    Nasz Siec ASK - Biuro Obsługi Klienta
    Gwidon Mniejważny
    telefon: 0-606031337
    e-mail: gwidonm@naszasiec.pl

    PS. Poniżej załączamy ostatnie 10 operacji na Państwa koncie.
    --------------+--------------+-----------------------------
         Data     |    Kwota     |           Komentarz
    --------------+--------------+-----------------------------" > /tmp/mail}

        {last10 = SELECT comment, time, CASE WHEN type=4 THEN value*-1 ELSE value END AS value
                FROM cash WHERE customerid = {customers[i].id}
                ORDER BY time DESC LIMIT 10}

        {for(j=0; j<number(last10); j++)}

            {exec echo "{last10[j].time}|{"\t"}{last10[j].value}|{"\t"}{last10[j].comment}" >> /tmp/mail}

        {/for}

        {exec mail -s "Powiadomienie o zaleglosciach" -r lms@domain.tld {customers[i].email} < /tmp/mail}

    {/for}

Kolejny rozbudowany przykład to odpowiednik modułu traffic. Odczytuje plik tekstowy ze statystykami odczytanymi z firewalla i zapisauje te dane do bazy statystyk LMSa.

Przykład 6-6. Parser: Statystyki.

    {
    log = "/var/log/traffic.log";
    nodes = SELECT id, INET_NTOA(ipaddr) AS ip, INET_NTOA(ipaddr_pub) AS ip_pub FROM nodes;
    if(! fileexists(log))
        exit;
    /if;
    lines = readfile(log);
    n = number(nodes);
    for (i=0; i<number(lines); i++)
        line = explode("[[:blank:]]+", lines[i]); /* file format: IP upload download */
        if ( number(line) == 3  && (line[1] > 0 || line[2] > 0) )
            for (x=0; x<n; x++)
                if (nodes[x].ip == line[0] || nodes[x].ip_pub == line[0] )
                    id = nodes[x].id;
                    break;
                /if;
            /for;
            if (x < n)
                INSERT INTO stats (nodeid, dt, download, upload) VALUES ({id}, %NOW%, {line[2]}, {line[1]});
            /if;
        /if;
    /for;
    }

Poprzedni | Spis treści | Następny
Moduły | Początek rozdziału | Dla dociekliwych