Reguláris kifejezések használata

Az előző fejezetben részletesen áttekintettük a reguláris kifejezések alapjait. A példákhoz és a hatékony használathoz az előző fejezetben összeszedett tudás táblázatos kivonata talán hasznos lesz:

.NET esetén a reguláris kifejezések megvalósításáért a Regex osztály felel, amit a System.Text.RegularExpressions névtérben találunk meg.

A Regex osztály érdekes konstruktorai:

public Regex (string pattern);
public Regex (string pattern, RegexOptions options);
public Regex (string pattern, RegexOptions options, TimeSpan matchTimeout);

Az egy paraméteres változat esetén a paraméter maga a reguláris kifejezés. A két paraméteres változat esetén a második paraméter beállításokat ad meg a kifejezés számára. A beállítások a RegexOptions típusú enum-ban tárolódnak és az alábbi értékeket vehetik fel:

• RegexOptions.Compiled

  Memóriába fordított. Akkor hasznos, ha a mintát sűrűn, vagy sokszor kell illeszteni.

• RegexOptions.CultureInvariant

  Kultúra figyelmen kívül hagyása.

• RegexOptions.IgnoreCase

  Kis és nagy betű nem különbözik.

• RegexOptions.Multiline

  Többsoros mód. A $ és a ^ nem soronként értelmezettek, hanem a bemeneti szöveg elejére és végére.

• RegexOptions.Singleline

  Egy soros mód

• RegexOptions.None

  Nincs beállítás meghatározva (egy paraméteres konstruktor beállítása).

A konstruktor három paraméteres változatában az utolsó paraméter a mintaillesztés maximális idÅ‘korlátját határozza meg. Ez alapértelmezetten végtelenre van állítva. Ha a mintaillesztés nem sikerül a meghatározott idÅ‘n belül, akkor egy RegexMatchTimeoutException kivétel keletkezik.

Példaprogram mintaillesztés ellenőrzésre

using System;
using System.Collections.Generic;
using System.Text.RegularExpressions;

namespace PeldaRegexMatch
{
    class Program
    {
        const string emailPattern = @"[^@]+\@[^\.]+\..+";

        static IEnumerable<string> TestCases
        {
            get
            {
                yield return "user@test.com";
                yield return "test.com";
                yield return "user@.com";
                yield return "user@1234.com";
                yield return "12elemer@server.be";
                yield return "valaki@mymail.hu";
            }
        }

        static void Main(string[] args)
        {
            var expression = new Regex(emailPattern, RegexOptions.Compiled);

            foreach (var testcase in TestCases)
            {
                bool match = expression.IsMatch(testcase);
                Console.WriteLine("{0} match status: {1}", testcase, match);
            }

            Console.ReadKey();
        }
    }
}

A program kimenete:

user@test.com match status: True
test.com match status: False
user@.com match status: False
user@1234.com match status: True
12elemer@server.be match status: True
valaki@mymail.hu match status: True

A mintaprogram egy egyszerű e-mail cím ellenÅ‘rzÅ‘t valósít meg. Ennek kapcsán megjegyezném, hogy a fenti Regex minta valószínűleg nem fed le minden esetet az RFC szerinti lehetséges mail címekbÅ‘l, így ne alkalmazzuk éles környezetben.

A kódban a bonyolultságot talán a minta értelmezése jelenti. Nézzük tagonként.

A [^@]+ részlet legalább egy egyezést megkövetel bármilyen karakterbÅ‘l, ami nem a @ karakter. A \@ részlet a kukac karakter szereplését követeli meg. A [^\.]+ minta legalább egy karaktert köt ki, ami nem lehet a . karakter. A \..+ részminta pedig egy pont karakterrel kezdÅ‘dÅ‘ részt kér, ami után bármi állhat.

RFC szerinti mail cím variálásra az alábbi reguláris kifejezés jobban alkalmas, azonban a példát nem szerettem volna feleslegesen komplexé tenni:

^(?(")(".+?(?<!\\)"@)|(([0-9a-z]((\.(?!\.))|[-!#\$%&'\*\+/=\?\^`\{\}\|~\w])*)(?<=[0-9a-z])@))(?(\[)(\[(\d{1,3}\.){3}\d{1,3}\])|(([0-9a-z][-\w]*[0-9a-z]*\.)+[a-z0-9][\-a-z0-9]{0,22}[a-z0-9]))$

Csere és darabolás minta alapján

A reguláris kifejezések eszköztárában szerepel a sima egyszerű string műveleteknél bemutatott split és replace is.

Csere esetén bármilyen szöveget megadhatunk, amire cserélni szeretnénk, illetve létezik pár speciális csere minta is. Ezek:

${szám}

Az eredeti kifejezésben () jelek között szereplő részmintára illeszkedő szöveg behelyettesítése. A {szám} helyre a részminta sorszámát kell írni. A részminták sorszámozása 0-tól kezdődik.

$+

Az eredeti kifejezésben () jelek között szereplő utolsó részmintára illeszkedő szöveg behelyettesítése.

$&

A kifejezésre illeszkedő szövegrészletre cserélés.

$`

A bemeneti szövegből a minta előtt található szövegre cserélés.

$’

A bemeneti szövegből a minta után található szövegre cserélés.

Cserére a reguláris kifejezés példányunk Replace metódusát használhatjuk, ahol az elsÅ‘ paraméter a bemeneti szöveg, a második paraméter pedig a csere szöveg. A metódus kimenete pedig a szöveg a cserék végrehajtása után.

string Replace (string input, string replacement);

Darabolásra a Split metódust alkalmazhatjuk szintén a kifejezés példányon. Az egy paraméteres változat csak a bemeneti szöveget várja el. A kétparaméteres változatában a második paraméter a darabolás számát limitálja.

public string[] Split (string input);
public string[] Split (string input, int count);

Reguláris kifejezések és a biztonság

A reguláris kifejezéseket a legtöbb esetben bemenet validációra szoktuk alkalmazni, hogy megnézzük azt, hogy egy adott szöveg megfelel-e egy adott mintának vagy sem¹. Ilyen minták kitalálása komplex feladat tud lenni, éppen ezért a leggyakoribb adat mintákról az OWASP projektnek van egy Regex minta gyűjteménye, ami a https://owasp.org/www-community/OWASP_Validation_Regex_Repository címen lelhetÅ‘ fel. Ha ezeket a mintákat alkalmazzuk, akkor nagyon nem tudunk mellélÅ‘ni, ami a biztonságot illeti.

A gondok akkor kezdÅ‘dnek igazán, ha a használt mintánk "gonosz". Gonosznak akkor nevezünk egy reguláris kifejezést, ha a minta illesztés mohóságára épít. Ilyen például a (a+)+ minta. Ennek az illesztési ideje exponenciálisan növekszik a bemenet hossza alapján. Ha a szoftverünben egy ilyen minta van, akkor könnyen összeomolhat vagy működésképtelenné válhat a megfelelÅ‘ bemenettÅ‘l.

Éppen ezért az internetrÅ‘l csak olyan kifejezéseket alkalmazzunk, amelyrÅ‘l értjük is, hogy mit csinál, illetve minden esetben lássuk el egy beláthatóan elfogadható (Pl. 3 másodperc) idÅ‘korláttal (A Regex 3 paraméteres konstruktorát alkalmazzuk) a mintaillesztést.