ฉบับแปลนี้เจาะประเด็น Building a Compliance and Signing Workbench in Delphi with PDFlibPas โดยยึดบทความภาษาอังกฤษที่อัปเดตแล้วเป็นฐานอ้างอิงทางเทคนิคสำหรับทีม Delphi, PDF และซอฟต์แวร์เอกสาร
หน้านี้แปลงบทความฐานที่อัปเดตแล้วให้เป็นจุดตรวจสอบที่ใช้ได้จริงสำหรับการออกแบบ การนำไปใช้ และการตรวจสอบผล
เนื้อหาที่ซิงก์จากบทความภาษาอังกฤษ
บทความต้นฉบับภาษาอังกฤษได้รับการขยายด้วยบริบทการใช้งานจริง จุดตัดสินใจเชิงเทคนิค และตัวอย่างที่เป็นรูปธรรม หน้านี้จึงควรใช้เป็นคู่มือทำงาน ไม่ใช่บทสรุปสั้น
หัวข้อสำคัญในบทความฐานที่อัปเดตแล้ว:
- ใช้ไฟล์นำเข้าขนาดเล็กที่ทำซ้ำได้ก่อนเชื่อมฟีเจอร์กับข้อมูลจริง
- คงชื่อผลิตภัณฑ์ ชื่อ API ชื่อไฟล์ และค่า literal ไว้ตามเดิม
- เก็บผล validator และข้อมูลเวอร์ชันไว้พร้อมไฟล์ตัวอย่างที่สร้างขึ้น
ทางเลือกสำหรับการนำไปใช้จริง
เริ่มจากชนิดไฟล์ ผลลัพธ์ที่ต้องการ และสถานะข้อผิดพลาดที่ผู้ใช้ควรเห็น จากนั้นผูกการเรียก API แต่ละครั้งกับผลลัพธ์ที่ตรวจสอบได้ เพื่อให้การตรวจสอบ log และงานสนับสนุนจำลองกรณีลูกค้าได้
- ใช้ไฟล์นำเข้าขนาดเล็กที่ทำซ้ำได้ก่อนเชื่อมฟีเจอร์กับข้อมูลจริง
- คงชื่อผลิตภัณฑ์ ชื่อ API ชื่อไฟล์ และค่า literal ไว้ตามเดิม
- เก็บผล validator และข้อมูลเวอร์ชันไว้พร้อมไฟล์ตัวอย่างที่สร้างขึ้น
โค้ดและจุดอ้างอิง API
ตัวอย่างโค้ดคงไว้ตามเดิมเพื่อให้นักพัฒนาเทียบกับโปรเจ็กต์ Delphi, C++Builder และ Lazarus/FPC ได้โดยตรง
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);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;การตรวจสอบก่อนเผยแพร่
ตรวจไฟล์ผลลัพธ์ด้วยเครื่องมือเดียวกับที่ลูกค้าหรือระบบเก็บถาวรใช้ บันทึกเวอร์ชันคอมโพเนนต์ ข้อมูลทดสอบ เวอร์ชัน validator และผลที่สังเกตได้เพื่อไล่รอย regression ได้ชัดเจน
อ่านเพิ่มเติม
- the PAdES signing and validation walkthrough
- the PDF/A and PDF/UA preflight guide
- PDFlibPas product page
หมายเหตุเพิ่มเติม
ส่วนเสริมนี้ทำให้เวอร์ชันสั้นกลายเป็นคู่มือที่ใช้งานได้จริงมากขึ้น และยังคงสอดคล้องกับ Building a Compliance and Signing Workbench in Delphi with PDFlibPas รวมถึงฐานทางเทคนิคของบทความภาษาอังกฤษ เนื้อหาควรแสดงให้ชัดว่าเรื่องเริ่มจาก input แบบใด คาดหวัง output อะไร และต้องยืนยันพฤติกรรมตรงจุดไหนผ่าน validation
ลำดับของการตัดสินใจสำคัญมาก: เริ่มจากรูปแบบข้อมูล ต่อด้วยขอบเขตของการเปลี่ยนแปลง จากนั้นคือ dependency ของ API แล้วจึงถึงพฤติกรรมสุดท้าย หากบทความพูดถึงหลายทางเลือก ก็ควรอธิบายด้วยว่าทางไหนเหมาะกับ maintenance, support และการทำซ้ำปัญหามากกว่า
code block ชื่อไฟล์ ชื่อ API และค่า literal ทุกอย่างต้องคงเดิม คำอธิบายรอบ ๆ จะขยายได้ แต่ตัวอย่างโค้ดต้องเป็นจุดอ้างอิงที่แม่นยำ เพื่อให้ผู้อ่านเทียบกับโปรเจ็กต์ Delphi, C++Builder หรือ Lazarus/FPC ของตนได้ตรง ๆ
ส่วน validation ควรพูดถึงไฟล์ตัวอย่างขนาดเล็ก การเทียบผลลัพธ์ และการบันทึก version ของ component หรือ validator ถ้าหน้านี้อธิบาย bug fix หรือ migration ต้องระบุเส้นทางการทำซ้ำ สถานะเริ่มต้นที่เห็น และจุดยืนยันให้ชัด เพื่อให้ติดตาม regression ได้โดยไม่ต้องเดา
การขยายแบบนี้ทำให้หน้ายังมีประโยชน์หลังอ่านครั้งแรก ทั้งสำหรับ reviewer ในฐานะคำอธิบายเหตุผล สำหรับ support ในฐานะบริบทการวิเคราะห์ และสำหรับทีมดูแลในฐานะบันทึกอ้างอิงก่อนการเปลี่ยนแปลงครั้งถัดไป
- อย่าเปลี่ยนชื่อผลิตภัณฑ์ API ไฟล์ หรือ literal
- ถ้ามี code block ให้คงไว้ตามเดิม
- อธิบาย validation ด้วยไฟล์ตัวอย่างและผลลัพธ์ที่เทียบกันได้
- แสดงลำดับการตัดสินใจให้ชัด ไม่ใช่แค่สรุปสั้นเกินไป