Műszaki cikk

PDFlibPas Compliance and Signing Workbench in Delphi magyarul

Ez a magyar cikk a(z) PDFlibPas Compliance and Signing Workbench in Delphi magyarul témát foglalja össze olyan csapatoknak, amelyek Delphi, C++Builder, Lazarus/FPC és losLab komponensek köré építenek üzleti megoldásokat

A hangsúly a gyakorlati döntéseken, a buktatókon és az ellenőrzési pontokon van, hogy a megoldás éles környezetben is megbízható legyen

Mikor hasznos ez a téma

A téma akkor fontos, amikor a dokumentumkezelésnek éles környezetben is ismételhetőnek, mérhetőnek és támogatásbarátnak kell lennie, nem csak egy bemutatóprojektben.

  • Rögzítse a bemeneti fájlokat, jogosultságokat, várt kimenetet és hibautakat
  • A terméknevek, API-nevek és fájlnevek maradjanak pontosan az eredeti alakjukban
  • Őrizzen meg rövid regressziós fájlokat és naplókat a későbbi támogatáshoz

Gyakorlati munkafolyamat

Az angol forrás fő pontjai alapján érdemes a megvalósítást áttekinthető Delphi-munkafolyamattá alakítani. A forrás kiemelt témái:

  • A kód módosítása előtt rögzítse a használati esetet
  • Az eredményt kis tesztfájlokkal ellenőrizze
  • Az API-neveket és literal értékeket hagyja változatlanul

Először egy kisméretű, reprodukálható példát készítsen, majd ehhez kapcsolja a komponenshívásokat, a hibakezelést és a felhasználói üzeneteket. A dokumentumformátumoknál a részletek döntik el, hogy a megoldás megbízható-e.

API- és kódhorgonyok

var
  PDF: TPDFlib;
  ListID, I: Integer;
begin
  PDF := TPDFlib.Create;
  try
    ListID := PDF.CheckFileCompliance('invoice-fixed.pdf', '', 1, 0);  // 1 = PDF/A
    if ListID = 0 then
    begin
      if PDF.LastErrorCode <> 0 then
        raise Exception.Create('Preflight could not read the file')
      else
        Writeln('No PDF/A findings');
    end
    else
    begin
      for I := 0 to PDF.GetStringListCount(ListID) - 1 do
        Writeln(PDF.GetStringListItem(ListID, I));
      PDF.ReleaseStringList(ListID);
    end;
  finally
    PDF.Free;
  end;
end;
ProcessID := PDF.NewSignProcessFromFile('invoice-fixed.pdf', '');
if ProcessID = 0 then
  raise Exception.Create('Cannot open source for signing');
PDF.SetSignProcessField(ProcessID, 'ApprovalSig');
PDF.SetSignProcessPFXFromFile(ProcessID, 'company.pfx', PfxPassword);
PDF.SetSignProcessInfo(ProcessID, 'Invoice approval', 'Berlin', 'billing@example.com');
PDF.SetSignProcessCustomSubFilter(ProcessID, 'ETSI.CAdES.detached');  // PAdES baseline
PDF.SetSignProcessDigestAlgorithm(ProcessID, 2);                      // SHA-256
PDF.SetSignProcessReserveContentsBytes(ProcessID, 8192);              // room for a later timestamp
PDF.EndSignProcessToFile(ProcessID, 'invoice-signed.pdf');
if PDF.GetSignProcessResult(ProcessID) <> 1 then
  Writeln('Sign failed, code ', PDF.GetSignProcessResult(ProcessID));
PDF.ReleaseSignProcess(ProcessID);

Ellenőrzés kiadás előtt

Kiadás előtt ellenőrizze a kimeneti fájlt, a metaadatokat, a titkosítást, a renderelést vagy az importált állapotot, a cikk témájának megfelelően. Jegyezze fel az eszközverziót, a komponensverziót, a tesztfájlt és a megfigyelt eredményt.

A terméknevek, API-nevek és kódrészletek változatlanok maradnak, hogy a fejlesztők könnyen összevethessék őket a dokumentációval és a forráskóddal

Kapcsolódó olvasnivaló

További kódpéldák

var
  Doc: TPDFlibSignDoc;
  Names: TStringList;
  FS: TFileStream;
  I: Integer;
  SourceSize, RangeStart, GapStart, TailStart, TailLen: Int64;
begin
  // Capture the size before Open: the audit object holds a share lock on the file
  FS := TFileStream.Create('invoice-signed.pdf', fmOpenRead or fmShareDenyNone);
  SourceSize := FS.Size;
  FS.Free;
  Doc := TPDFlibSignDoc.Create;
  Names := TStringList.Create;
  try
    if not Doc.Open('invoice-signed.pdf', '', False) then Exit;
    Doc.GetSignatureFieldNames(Names);
    for I := 0 to Names.Count - 1 do
      if Doc.GetSignatureValueObjNum(Names[I]) > 0 then  // > 0 means the field is signed
      begin
        RangeStart := StrToInt64(string(Doc.GetSignatureValueByName(Names[I], 11)));
        GapStart   := StrToInt64(string(Doc.GetSignatureValueByName(Names[I], 12)));
        TailStart  := StrToInt64(string(Doc.GetSignatureValueByName(Names[I], 13)));
        TailLen    := StrToInt64(string(Doc.GetSignatureValueByName(Names[I], 14)));
        if (RangeStart = 0) and (TailStart + TailLen = SourceSize) then
          Writeln(Names[I], ': signature covers the file to EOF')
        else
          Writeln(Names[I], ': earlier revision, or unusual ByteRange layout');
      end;
    Doc.Close;
  finally
    Names.Free;
    Doc.Free;
  end;
end;

Kiegészítő megjegyzések

Ez a kiegészítés a rövid verziót egy használhatóbb munkalappá bővíti, miközben továbbra is illeszkedik a Building a Compliance and Signing Workbench in Delphi with PDFlibPas és az angol alapcikk technikai keretéhez. A szövegnek világosan meg kell mutatnia, milyen bemenettől indul a téma, milyen kimenet a cél, és melyik ellenőrzési ponton kell a viselkedést visszaigazolni.

Az átdolgozásnál a döntési sorrend számít: először az adat alakja, utána a módosítás határa, majd az API-függőségek, végül a tényleges viselkedés. Ha a cikk több lehetőséget említ, érdemes azt is leírni, melyik út védhetőbb karbantartás, támogatás és hibareprodukció szempontjából.

Minden code block, fájlnév, API-név és literal érték maradjon változatlan. A környező magyarázat lehet részletesebb, de a példakódnak ugyanazt a pontos referenciát kell adnia, hogy az olvasó közvetlenül összevesse a saját Delphi-, C++Builder- vagy Lazarus/FPC-projektjével.

A validation részben szerepeljen kis mintaállomány, kimenet-összevetés, valamint component- vagy validator-verzió rögzítése. Ha bug fixről vagy migrációról van szó, a reprodukciós útvonalat, az első megfigyelt állapotot és az ellenőrzési pontot is világosan kell leírni, hogy a regression később ne találgatás legyen.

Az ilyen bővítés azért hasznos, mert a lap nem csak első olvasásra marad értelmezhető: reviewernek döntési háttér, supportnak vizsgálati kontextus, a karbantartó csapatnak pedig hivatkozható megjegyzés lesz a következő módosítások előtt.

  • A termék-, API-, fájl- és literal neveket ne módosítsd
  • A code blockot, ha van, hagyd érintetlenül
  • A validationhez adj mintafájlt és összevethető kimenetet
  • A döntési sorrendet ne csak röviden, hanem érthetően írd le