Přejít na obsah
Flexideo
Skip to main content

Požadavek load-files

Účel a dopady​

Načte obsah jednoho nebo více souborů ze složky serveru (podle masky/regulárního výrazu, případně i uvnitř ZIP archivů) a vrátí je jako XML. Požadavek jen čte, nic nemění. Párový požadavek k save-files.

Dostupnost, kontext, oprávnění apod.​

Server využívá oprávnění load-file u virtuálních adresářů, resp. vlastnost uživatele mapovanou pod p_publoads. Atribut path-log je účinný jen pro r_admin.

XML požadavek (syntax + popis)​

  <request>
   <load-files
    path="{string}"
    mask="{string}"
    file-type="txt|xml|csv|base64|json|raw|hex"
    recurse="{bool}"
    codepage="acp|utf8|utf16|{#number}"
    auth="{string}"
    accent="{bool}"
    regex="{bool}"
    path-log="{bool}"
    inzip-path="{string}"
    inzip-mask="{string}"
    inzip-recurse="{bool}"
    separator="{string}"
    line-separator="{string}"
    delimiter="{string}"
    header="{number}"
    />
  </request>

Parametry a pravidla (atributy, potomci)​

  • path - Relativní cesta ke zdrojové složce; neuvedena = výchozí uložiště. (typ: string; nepovinný)
  • mask - Souborová maska (např. *.txt), lze zadat víc masek oddělených |. (typ: string; nepovinný)
  • file-type - txt|xml|csv|base64|json|raw; jakákoli jiná/chybějící hodnota = hex. (typ: enum; nepovinný; výchozí: hex) – dosavadní dokumentace uváděla výchozí hodnotu txt; hodnoty json/raw v ní chyběly.
  • recurse - Určeno k zapnutí rekurzivního prohledávání podadresářů. (typ: bool; nepovinný) – pozorované chování serveru: atribut neaktivuje rekurzi v adresářové struktuře; aktivuje pouze rekurzi uvnitř ZIP archivu jako inzip-recurse. Vlastní adresářová rekurze tak tímto atributem prakticky nefunguje.
  • codepage - acp|utf8|utf16|číslo kódové stránky; nemá význam pro hex/base64. (typ: string; nepovinný; výchozí: konfigurace serveru)
  • auth - Autorizační řetězec pro načtení souboru z přílohy dokumentu (obsah za ? v odkazu na přílohu). (typ: string; nepovinný)
  • accent - (typ: bool; nepovinný) – v dosavadní dokumentaci zcela chyběl; přesný efekt nebyl v této revizi dohledán nad rámec čtení příznaku.
  • regex - Masku/regulární výraz interpretovat jako regulární výraz. (typ: bool; nepovinný; výchozí: false) – dosavadní dokumentace uváděla název regex shodně, potvrzeno.
  • path-log - Vrátit v odpovědi plnou vyřešenou cestu; účinné jen pro r_admin. (typ: bool; nepovinný) – v dosavadní dokumentaci chyběl.
  • inzip-path, inzip-mask, inzip-recurse - Prohledávání uvnitř ZIP archivů – inzip-mask aktivuje prohledávání archivů, inzip-recurse (nebo recurse, viz výše) prohledá i podsložky archivu. (typ: string/bool; nepovinné)
  • separator, line-separator, delimiter, header - Řízení CSV parseru, jen při file-type="csv"; stejný význam jako v dosavadní dokumentaci.

Požadavek nemá potomky.

Příklady požadavku​

(Zatím bez ověřeného příkladu.)

Zpracování a vedlejší účinky​

Chyba při načítání jednoho souboru nezastaví zpracování dalších – uvede se u konkrétního file, hledání pokračuje.

XML odpověď (syntax + popis)​

  <response>
   <load-files>
    <file
     path="{string}"
     type="ok|error"
     detail="{string}"
     name="{string}"
     >
     {obsah souboru nebo parsovaný XML/CSV obsah}
    </file> *
   </load-files>
  </response>

Příklady odpovědi​

(Zatím bez ověřeného příkladu.)

Chyby a reakce​

Chyba se uvádí u konkrétního file (type="error" detail="…"), ne na úrovni celého load-files. U XML a CSV souborů je chybou i obsah v neplatném formátu.

Výraz pro identifikaci chyb: load-files/file[@type='error'].

Související požadavky​