Zaawansowanie filtrowanie i WebAPI

Zaawansowanie filtrowanie i WebAPI
JU
  • Rejestracja:około 22 lata
  • Ostatnio:29 dni
  • Postów:5042
0

Cześć, zastanawiam się, jak podejść do tego tematu i nie za bardzo widzę coś konkretnego.
Mam aplikację kliencką, która żąda odpowiednio przefiltrowanych danych. Dane mogą być filtrowane po dowolnej kolumnie.

W starych dobrych czasach, gdy była tylko aplikacja na desktop, po prostu składało się dynamicznie SQL i wio.
Natomiast jak to się robi, gdy używamy WebAPI RESTowego?

Załóżmy, że mam tabelę klientów. Klienci mają dla uproszczenia: miasto, wiek i płeć (ale mogą też mieć różne inne kolumny, które będę chciał filtrować)
I teraz z poziomu aplikacji klienckiej chciałbym móc zastosować przykładowe filtry:

  • miasto = Łódź and wiek >= 18 and płeć = kobieta
  • wiek >= 16 and wiek <= 18 and płeć = mężczyzna

itd. Pełne możliwości filtrowania. Jak to się ogarnia z WebAPI?

mad_penguin
mad_penguin
  • Rejestracja:ponad 10 lat
  • Ostatnio:około 3 lata
  • Lokalizacja:Rzeszów
0

Ja tworzę klasę ClientsSearchCriteria, która ma pole dla każdej możliwej wartości po której filtrujemy (np MinAge i MaxAge) i po kolei sprawdzam ifami, czy kolejne pola są wypełnione i jeśli tak to dodaję kolejne Where do IQueryable z zapytaniem. Nie jest to zbyt sprytne, ale zdaje egzamin ;)

JU
To ClientSearchCriteria ma wszystkie pola wszystkich modeli?
mad_penguin
mad_penguin
Ma wszystkie pola, po których filtrujemy na danej formatce, bo zwykle nie są to wszystkie pola w tabeli
JU
  • Rejestracja:około 22 lata
  • Ostatnio:29 dni
  • Postów:5042
0

Pokaż jak to wygląda.

mad_penguin
mad_penguin
  • Rejestracja:ponad 10 lat
  • Ostatnio:około 3 lata
  • Lokalizacja:Rzeszów
0

Mniej więcej coś takiego:

Kopiuj
class ClientsSearchCriteria
{
    public string Name {get;set;}
    public int? MinAge {get;set;}
    public int? MaxAge {get;set;}
}

List<ClientsSearchResult> SearchClients(ClientsSearchCriteria sc)
{
    var query = dbContext.Clients as IQueryable<Client>;

    if (sc.Name != null)
    {
        query = query.Where(client => client.Name.Contains(sc.Name));
    }

    if (sc.MinAge != null)
    {
        query = query.Where(client => client.Age >= sc.MinAge);
    }

    if (sc.MaxAge != null)
    {
        query = query.Where(client => client.Age <= sc.MaxAge);
    }

    return query.JakieśStronicowanieSortowanieProjekcjaItp()
        .ToList();
}

Sam jestem ciekaw opinii i możliwych innych rozwiązań :)

Ktos
Moderator
  • Rejestracja:prawie 23 lata
  • Ostatnio:około 16 godzin
1

W starych dobrych czasach, gdy była tylko aplikacja na desktop, po prostu składało się dynamicznie SQL i wio.

A to nie możesz tego robić nadal? Przecież twój klient może poprosić serwer o GET /Items?city=Łódź&age>=18.

Możesz spojrzeć jak to robi OData: http://www.odata.org/getting-started/basic-tutorial/#queryData

JU
No tak, najlepsze rozwiązania to te najprostsze :)
JU
  • Rejestracja:około 22 lata
  • Ostatnio:29 dni
  • Postów:5042
0

Hmm, tak sobie teraz myślę, że to co napisał @Ktos to bardzo fajne rozwiązanie. Ale chyba daje opcje czegoś na wzór SQL Inject?
Dla uproszczenia załóżmy taki model:

Kopiuj
public class Person
{
    public string FirstName {get; set;}
    public string LastName {get; set;}
    public string City {get ;set;}
    public int Age {get; set;}
}

Załóżmy teraz, że użytkownik może przeglądać osoby jedynie z Łodzi z filtrem na wiek:
Items?age>18

Ale teraz jakiś sprytny Pan zmienia mi w locie ten request na:
Items?city=Poznań&age>18

I w tym momencie jak ma zachować się serwer? Serwer teraz powinien zrobić dodatkowe sprawdzenie filtra. Ewentualnie pobrać rekordy i sprawdzić, czy użytkownik ma uprawnienia do przeglądania tych rekordów (lub wykluczyć z wyniku te, do których nie ma uprawnień). Jak takie rzeczy się ogrania w WebAPI?

Ktos
Moderator
  • Rejestracja:prawie 23 lata
  • Ostatnio:około 16 godzin
1

Tak, oczywiście, serwer musi zawsze robić dodatkowe sprawdzanie, czy ten filtr działa, ma sens i w ogóle użytkownik ma pozwolenie na zrobienie czegoś takiego. Znów zadam pytanie - a w aplikacji desktopowej aplikacja takich rzeczy nie sprawdzała? ;-)

Jeżeli użytkownik próbuje zrobić coś, do czego nie ma uprawnień, rzucasz błędem 401. Jeżeli robi w zapytaniu warunki, których nie powinien, rzucasz 400.

JP
To pytanie od @Juhas jest niemadre bo serwer się zawsze musi sprawdzać co do niego przychodzi (jeśli są takie ograniczenia). Bez znaczenia czy to Webapi czy zwykle strona. Jeśli pytamy się o zasoby to sprawdzamy czy mamy do niego dostep i nie ma znaczenia czy sobie jeszcze cos dodatkowo filtrujemy. W desktopach znacznie trudniej zmienić zapytanie do bazy szczególnie jak program gada bezpośrednio z bazą bez jakiegoś api.
Ktos
Ale jeżeli program przyjmował całkowicie dowolne rzeczy i wklejał do SQL-a to i tak SQL Injection było możliwe, nie?
JP
Tak. 20 lat temu jak sobie przypominam co robiłem to tak :) Z tym, że zapytania, jak pamiętam, były raczej parametryzowane chociaż pewnie nie zawsze.
JU
Chodzi mi głównie o to, że tym sprawdzaniem zajmuje się już wbudowany mechanizm autoryzacji. Ja mam dodatkowe sprawdzenie w 2, czy 3 miejscach. Ale nagle okazuje się, że poza wbudowanym mechanizmem autoryzacji muszę mieć jeszcze swój własny do sprawdzania warunków zapytań, zgadza się?
JP
Generalnie user ma dostęp do edycji zasobów. Ale... Jeśli zasób należy do innego usera to nie ma dostępu. Jeśli user należy do innej firmy to też nie ma praw edycji. Albo może jeszcze mieć prawa do edycji ale do momentu jakiegoś zatwierdzenia zasobu. Albo jest z innego miasta czy co tam jeszcze może przyjść w jakichś parametrach filtrowania czy wybierania danych. Pewnie w filtrach sporo da się zrobić ale nie wiem czy to jest najlepsze miejsce bo się słabo znam na web. Ja wolałbym chyba jakieś strategie określające dostępność w jakimś serwisie "domenowym".
neves
  • Rejestracja:ponad 21 lat
  • Ostatnio:około 4 godziny
  • Lokalizacja:Kraków
  • Postów:1114
0

Tylko jak już nawet to zapytanie sql sklejasz to używaj sparametryzowanych zapytań, tzn przesyłaj wartości za pomocą parametrów.


Ktos
Moderator
  • Rejestracja:prawie 23 lata
  • Ostatnio:około 16 godzin
0

Wyjdźmy z komentarzy, bo to ciekawy wątek.

Chodzi mi głównie o to, że tym sprawdzaniem zajmuje się już wbudowany mechanizm autoryzacji. Ja mam dodatkowe sprawdzenie w 2, czy 3 miejscach. Ale nagle okazuje się, że poza wbudowanym mechanizmem autoryzacji muszę mieć jeszcze swój własny do sprawdzania warunków zapytań, zgadza się?

Wbudowany mechanizm autoryzacji działa na poziomie zasobów (kontrolerów i akcji). Jeżeli potrzebujesz dodatkowych sprawdzań wewnątrz akcji (np. na poziomie warunków zapytań) to musisz to ogarnąć samemu.

@jacek.placek:

Ja wolałbym chyba jakieś strategie określające dostępność w jakimś serwisie "domenowym"

Zgadzam się tutaj. Skoro masz już sprawdzanie w innych miejscach, to stwórz jeden wspólny mechanizm, który powie, czy dana czynność może być wykonana, czy nie. Tak chyba by było najrozsądniej.

A może, skoro masz taki warunek:

Załóżmy teraz, że użytkownik może przeglądać osoby jedynie z Łodzi z filtrem na wiek:

To może wydzielić go do oddzielnej akcji? /PersonsOnlyFromBoatFilteredByAge/18 (żartuję ;))? Trzeba by się zastanowić jak bardzo granularne mają być twoje uprawnienia.

JU
  • Rejestracja:około 22 lata
  • Ostatnio:29 dni
  • Postów:5042
0

Załóżmy teraz, że użytkownik może przeglądać osoby jedynie z Łodzi z filtrem na wiek:

To może wydzielić go do oddzielnej akcji? /PersonsOnlyFromBoatFilteredByAge/18 (żartuję ;))? Trzeba by się zastanowić jak bardzo granularne mają być twoje uprawnienia.

No to jest całkiem bez sensu, bo filtry chcę mieć dowolne. Poza tym mam różne poziomy uprawnień. I tak np. użytkownik zwykły może przeglądać tylko ze swojego miasta. Ale admin już może wszystkich. Także wychodzi, że powinienem mieć coś w stylu:

Kopiuj
bool auth = UserCanManageCity(User, "Łódź");
if(!auth)
  return 400; // dla ułatwienia :)

auth = UserCanManageCośInnego(User, "wartość);
if(!auth)
  return 400;

auth = UserCanManageClient(User, 5);
if(!auth)
  return 400;

//i tu dopiero wykonanie konkretnej akcji

Oczywiście zakładam, że te wszystkie wartości pochodzą z filtrów. Czyli tak naprawdę jeśli mam 3 filtry, to muszę mieć 3 sprawdzenia. Ale że filtrów mogę mieć dajmy na to 0 lub 10, oznacza że muszę sobie ogarnąć jakiś sprytny sposób sprawdzania każdego z nich. Coś na zasadzie chain of responsibility?

Wtedy widziałbym to tak:

Kopiuj
FilterAuthManager manager = new FilterAuthManager(filters); //string z filtrami, który tworzy mi odpowiednie klasy w managerze, np: CityFilter, ClientFilter itd
if(!manager.UserCanManage(User))
  return 400;
SZ
  • Rejestracja:prawie 11 lat
  • Ostatnio:około godziny
  • Postów:1473
0

Nie wiem czy ogarnąłeś sobie to filtrowanie ale tu jest ciekawy przykład:
http://www.pashov.net/code/dynamic+filters

somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:około 2 godziny
  • Lokalizacja:Wrocław
0
Juhas napisał(a):

Załóżmy teraz, że użytkownik może przeglądać osoby jedynie z Łodzi z filtrem na wiek:
Items?age>18

Ale teraz jakiś sprytny Pan zmienia mi w locie ten request na:
Items?city=Poznań&age>18

I w tym momencie jak ma zachować się serwer? Serwer teraz powinien zrobić dodatkowe sprawdzenie filtra. Ewentualnie pobrać rekordy i sprawdzić, czy użytkownik ma uprawnienia do przeglądania tych rekordów (lub wykluczyć z wyniku te, do których nie ma uprawnień). Jak takie rzeczy się ogrania w WebAPI?

No, ale jeśli filtr na miasto zależy od zalogowanego użytkownika, to nie powinien być w ogóle dostępny przez query string tylko dynamicznie dodawany po stronie aplikacji.
To pierwsze da się osiągnąć banalnie, wystarczy, że obiekt bindowany z query stringa nie będzie miał właściwości City.
A do drugiego przydaje się właśnie prawdziwy ORM - taki, który pozwala dodawać globalne filtry do kontekstu oraz claimsy użytkownika dostarczające wartości dla danego filtru. Wtedy po prostu w fabryce kontekstów wystarczy aktywować filtr, który zawsze będzie działał dla wybranych tabel, więc mamy
gwarancję, że użytkownik nie zobaczy ani nie zmieni danych nie przeznaczonych dla siebie.

Można to też zaimplementować ręcznie, po prostu dodając where w miejscu wykonywania wszystkich zapytań, dlatego warto aby było jedno. Tylko tam znowu się przydadzą claimsy albo inne źrodło kontekstowej informacji o użytkowniku.

W ostateczności można taki warunek doklejać do każdego budowanego zapytania, tylko tu jest ryzyko, że w którymś miejscu to przeoczymy i ktoś zobaczy nie swoje dane.

A pisanie dziesiątek ifów i metod sprawdzających czy dany użytkownik może zbudować dany warunek, to więcej kodu, a zatem więcej możliwości przeoczenia czegoś i w konsekwencji udostępnienia danych niepowołanej osobie.

edytowany 1x, ostatnio: somekind
JU
  • Rejestracja:około 22 lata
  • Ostatnio:29 dni
  • Postów:5042
0
somekind napisał(a):
Juhas napisał(a):

Załóżmy teraz, że użytkownik może przeglądać osoby jedynie z Łodzi z filtrem na wiek:
Items?age>18

Ale teraz jakiś sprytny Pan zmienia mi w locie ten request na:
Items?city=Poznań&age>18

I w tym momencie jak ma zachować się serwer? Serwer teraz powinien zrobić dodatkowe sprawdzenie filtra. Ewentualnie pobrać rekordy i sprawdzić, czy użytkownik ma uprawnienia do przeglądania tych rekordów (lub wykluczyć z wyniku te, do których nie ma uprawnień). Jak takie rzeczy się ogrania w WebAPI?

No, ale jeśli filtr na miasto zależy od zalogowanego użytkownika, to nie powinien być w ogóle dostępny przez query string tylko dynamicznie dodawany po stronie aplikacji.

Tak, ale ja mówię o typowym ataku. Dajmy na to, że w aplikacji klienckiej mam do wyboru tylko przedział wieku. Ale hacker w jakiś magiczny sposób zmienił mi request, który wychodzi z aplikacji, np. z: items?age>18 na items?age>18&city=Poznań

Żeby się przed takim atakiem uchronić, muszę mieć dodatkowe sprawdzenia po stronie serwera.

somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:około 2 godziny
  • Lokalizacja:Wrocław
0

To Ty chcesz ten query string doklejać bezpośrednio do zapytania wysyłanego do bazy?

Bo normalnie, to query string jest bindowany do obiektu jakiejś klasy, jeśli w klasie nie ma właściwości, która jest w query stringu, to nie zostanie zbindowana - bo i do czego?

bartek164
fajny masz ogonek
JU
  • Rejestracja:około 22 lata
  • Ostatnio:29 dni
  • Postów:5042
0

No tak myślałem na podstawie tego, co napisał @Ktoś: https://4programmers.net/Forum/1486222
To jak to zrobić poprawnie?

somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:około 2 godziny
  • Lokalizacja:Wrocław
1

Kluczowa jest wiedza czy w końcu miasto każdy może sobie wyszukiwać jakie chce, czy użytkownik jest przypisany do jednego miasta i zawsze jak wyszukuje, to ma mieć filtr na to miasto?

JU
  • Rejestracja:około 22 lata
  • Ostatnio:29 dni
  • Postów:5042
0

Podam konkretny przykład z życia. Jest tabela z klientami. Każdy klient ma swojego ownera. Użytkownik jest przypisany do tego ownera, a więc może przeglądać jedynie klientów należących do swojego ownera. Analogicznie - użytkownik może szukać jedynie osób należących do jego miasta.

somekind
Moderator
  • Rejestracja:około 17 lat
  • Ostatnio:około 2 godziny
  • Lokalizacja:Wrocław
2

No czyli tak jak napisałem w swoim pierwszym poście - użytkownik nie powinien mieć możliwości podania miasta w zapytaniu do API.

Czyli Twój DTO bindowany z query stringa powinien wyglądać tak:

Kopiuj
public class PersonSearchModel
{
    public string FirstName {get; set;}
    public string LastName {get; set; }
    public int Age {get; set;}
}

Akcja kontrolera:

Kopiuj
public PersonSearchResult([FromUrl]PersonSearchModel psm)
{
    // do serwisu
}

A w miejscu, gdzie budujesz zapytanie:

Kopiuj
var persons = db.Persons.Where(p => p.Age > searchModel.Age && p.Name == searchModel.Name && p.City == CurrentUser.City).ToList();
edytowany 3x, ostatnio: somekind
JU
OK, dzięki to już wiem wszystko. I coraz mocniej widzę potrzebę ORMa.
Kliknij, aby dodać treść...

Pomoc 1.18.8

Typografia

Edytor obsługuje składnie Markdown, w której pojedynczy akcent *kursywa* oraz _kursywa_ to pochylenie. Z kolei podwójny akcent **pogrubienie** oraz __pogrubienie__ to pogrubienie. Dodanie znaczników ~~strike~~ to przekreślenie.

Możesz dodać formatowanie komendami , , oraz .

Ponieważ dekoracja podkreślenia jest przeznaczona na linki, markdown nie zawiera specjalnej składni dla podkreślenia. Dlatego by dodać podkreślenie, użyj <u>underline</u>.

Komendy formatujące reagują na skróty klawiszowe: Ctrl+B, Ctrl+I, Ctrl+U oraz Ctrl+S.

Linki

By dodać link w edytorze użyj komendy lub użyj składni [title](link). URL umieszczony w linku lub nawet URL umieszczony bezpośrednio w tekście będzie aktywny i klikalny.

Jeżeli chcesz, możesz samodzielnie dodać link: <a href="link">title</a>.

Wewnętrzne odnośniki

Możesz umieścić odnośnik do wewnętrznej podstrony, używając następującej składni: [[Delphi/Kompendium]] lub [[Delphi/Kompendium|kliknij, aby przejść do kompendium]]. Odnośniki mogą prowadzić do Forum 4programmers.net lub np. do Kompendium.

Wspomnienia użytkowników

By wspomnieć użytkownika forum, wpisz w formularzu znak @. Zobaczysz okienko samouzupełniające nazwy użytkowników. Samouzupełnienie dobierze odpowiedni format wspomnienia, zależnie od tego czy w nazwie użytkownika znajduje się spacja.

Znaczniki HTML

Dozwolone jest używanie niektórych znaczników HTML: <a>, <b>, <i>, <kbd>, <del>, <strong>, <dfn>, <pre>, <blockquote>, <hr/>, <sub>, <sup> oraz <img/>.

Skróty klawiszowe

Dodaj kombinację klawiszy komendą notacji klawiszy lub skrótem klawiszowym Alt+K.

Reprezentuj kombinacje klawiszowe używając taga <kbd>. Oddziel od siebie klawisze znakiem plus, np <kbd>Alt+Tab</kbd>.

Indeks górny oraz dolny

Przykład: wpisując H<sub>2</sub>O i m<sup>2</sup> otrzymasz: H2O i m2.

Składnia Tex

By precyzyjnie wyrazić działanie matematyczne, użyj składni Tex.

<tex>arcctg(x) = argtan(\frac{1}{x}) = arcsin(\frac{1}{\sqrt{1+x^2}})</tex>

Kod źródłowy

Krótkie fragmenty kodu

Wszelkie jednolinijkowe instrukcje języka programowania powinny być zawarte pomiędzy obróconymi apostrofami: `kod instrukcji` lub ``console.log(`string`);``.

Kod wielolinijkowy

Dodaj fragment kodu komendą . Fragmenty kodu zajmujące całą lub więcej linijek powinny być umieszczone w wielolinijkowym fragmencie kodu. Znaczniki ``` lub ~~~ umożliwiają kolorowanie różnych języków programowania. Możemy nadać nazwę języka programowania używając auto-uzupełnienia, kod został pokolorowany używając konkretnych ustawień kolorowania składni:

```javascript
document.write('Hello World');
```

Możesz zaznaczyć również już wklejony kod w edytorze, i użyć komendy  by zamienić go w kod. Użyj kombinacji Ctrl+`, by dodać fragment kodu bez oznaczników języka.

Tabelki

Dodaj przykładową tabelkę używając komendy . Przykładowa tabelka składa się z dwóch kolumn, nagłówka i jednego wiersza.

Wygeneruj tabelkę na podstawie szablonu. Oddziel komórki separatorem ; lub |, a następnie zaznacz szablonu.

nazwisko;dziedzina;odkrycie
Pitagoras;mathematics;Pythagorean Theorem
Albert Einstein;physics;General Relativity
Marie Curie, Pierre Curie;chemistry;Radium, Polonium

Użyj komendy by zamienić zaznaczony szablon na tabelkę Markdown.

Lista uporządkowana i nieuporządkowana

Możliwe jest tworzenie listy numerowanych oraz wypunktowanych. Wystarczy, że pierwszym znakiem linii będzie * lub - dla listy nieuporządkowanej oraz 1. dla listy uporządkowanej.

Użyj komendy by dodać listę uporządkowaną.

1. Lista numerowana
2. Lista numerowana

Użyj komendy by dodać listę nieuporządkowaną.

* Lista wypunktowana
* Lista wypunktowana
** Lista wypunktowana (drugi poziom)

Składnia Markdown

Edytor obsługuje składnię Markdown, która składa się ze znaków specjalnych. Dostępne komendy, jak formatowanie , dodanie tabelki lub fragmentu kodu są w pewnym sensie świadome otaczającej jej składni, i postarają się unikać uszkodzenia jej.

Dla przykładu, używając tylko dostępnych komend, nie możemy dodać formatowania pogrubienia do kodu wielolinijkowego, albo dodać listy do tabelki - mogłoby to doprowadzić do uszkodzenia składni.

W pewnych odosobnionych przypadkach brak nowej linii przed elementami markdown również mógłby uszkodzić składnie, dlatego edytor dodaje brakujące nowe linie. Dla przykładu, dodanie formatowania pochylenia zaraz po tabelce, mogłoby zostać błędne zinterpretowane, więc edytor doda oddzielającą nową linię pomiędzy tabelką, a pochyleniem.

Skróty klawiszowe

Skróty formatujące, kiedy w edytorze znajduje się pojedynczy kursor, wstawiają sformatowany tekst przykładowy. Jeśli w edytorze znajduje się zaznaczenie (słowo, linijka, paragraf), wtedy zaznaczenie zostaje sformatowane.

  • Ctrl+B - dodaj pogrubienie lub pogrub zaznaczenie
  • Ctrl+I - dodaj pochylenie lub pochyl zaznaczenie
  • Ctrl+U - dodaj podkreślenie lub podkreśl zaznaczenie
  • Ctrl+S - dodaj przekreślenie lub przekreśl zaznaczenie

Notacja Klawiszy

  • Alt+K - dodaj notację klawiszy

Fragment kodu bez oznacznika

  • Alt+C - dodaj pusty fragment kodu

Skróty operujące na kodzie i linijkach:

  • Alt+L - zaznaczenie całej linii
  • Alt+, Alt+ - przeniesienie linijki w której znajduje się kursor w górę/dół.
  • Tab/⌘+] - dodaj wcięcie (wcięcie w prawo)
  • Shit+Tab/⌘+[ - usunięcie wcięcia (wycięcie w lewo)

Dodawanie postów:

  • Ctrl+Enter - dodaj post
  • ⌘+Enter - dodaj post (MacOS)