summaryrefslogtreecommitdiff
path: root/Master/tlpkg/tlgs/lib/zugferd.ps
blob: 0320fb69e8e04971dfc0e87083fb7ca83f47f425 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
% Copyright (C) 2001-2021 Artifex Software, Inc.
% All Rights Reserved.
%
% This software is provided AS-IS with no warranty, either express or
% implied.
%
% This software is distributed under license and may not be copied,
% modified or distributed except as expressly authorized under the terms
% of the license contained in the file LICENSE in this distribution.
%
% Refer to licensing information at http://www.artifex.com or contact
% Artifex Software, Inc.,  1305 Grant Avenue - Suite 200, Novato,
% CA 94945, U.S.A., +1(415)492-9861, for further information.
%
% zugferd.ps
% This program will create an (unsigned) ZUGFeRD compliant PDF file. In
% order to do so the user must provide certain information, or edit this program.
%
% Required information is the path to the XML file containing the invoice data,
% and the path to an ICC profile appropriate for the chosen ColorConversionStrategy.
% -sZUGFeRDXMLFile defines a path to the XML invoice file and -sZUGFeRDProfile
% defines the path to the ICC profile.
%
% The user must additionally set -dPDFA=3 and -sColorConversionStrategy on the
% Ghostscript command line, and set the permissions for Ghostscript to read
% both these files. It is simplest to put the files in a directory and then
% permit reading of the entire directory.
%
% Example command line :
%
% gs --permit-file-read=/usr/home/me/zugferd/ -sDEVICE=pdfwrite -dPDFA=3 -sColorConversionStrategy=RGB \
%    -sZUGFeRDXMLFile=/usr/home/me/zugferd/invoice.xml  -sZUGFeRDProfile=/usr/home/me/rgb.icc \
%    -o /usr/home/me/zugferd/zugferd.pdf /usr/home/me/zugferd/zugferd.ps /usr/home/me/zugferd/original.pdf
%
% Much of this program results from a Ghostscript bug report, the thread can be found at
% https://bugs.ghostscript.com/show_bug.cgi?id=696472 Portions of the code below were
% supplied by Reinhard Nissl and I'm indebted to him for his efforts in helping me create
% a solution for this problem as well as for the code he supplied, particularly for the
% SimpleUTF16BE routine.
%
% It should not be necessary to modify this program, the comments in the code are there purely for information,
% but there are two areas which might reasonably be altered. The section with the --8<-- lines could be replaced
% with a simpler /N 3 or /N 4 if you always intend to produce the same kind of files; RGB or CMYK.
% In step 7, the large XML string will need to be replaced if you want to produce a ZUGFeRD 2.1
% file, and in future may require similar modification for later versions.
%

% istring SimpleUTF16BE ostring
/SimpleUTF16BE
{
    dup length
    1 add
    2 mul
    string

    % istring ostring
    dup 0 16#FE put
    dup 1 16#FF put
    2
    3 -1 roll

    % ostring index istring
    {
        % ostring index ichar
        3 1 roll
        % ichar ostring index
        2 copy 16#00 put
        1 add
        2 copy
        5 -1 roll
        % ostring index ostring index ichar
        put
        1 add
        % ostring index
    }
    forall

    % ostring index
    pop
}
bind def

% First check that the user has defined the XML invoice file on the command line
%
/ZUGFeRDXMLFile where {
  pop % Discard the dictionary
  %
  % Now check that the ICC Profile is defined
  %
  /ZUGFeRDProfile where {
    pop % Discard the dictionary

    % Step 1, add the required PDF/A boilerplate. This is mostly copied from lib/pdfa_de.ps
    % Create a PDF stream object to hold the ICC profile.
    [ /_objdef {icc_PDFA} /type /stream /OBJ pdfmark

    % Add the required entries to the stream dictionary (/N only)
    [ {icc_PDFA}
    <<
    %% This code attempts to set the /N (number of components) key for the ICC colour space.
    %% To do this it checks the ColorConversionStrategy or the device ProcessColorModel if
    %% ColorConversionStrategy is not set.
    %% This is not 100% reliable. A better solution is for the user to edit this and replace
    %% the code between the ---8<--- lines with a simple declaration like:
    %%   /N 3
    %% where the value of N is the number of components from the profile defined in ZUGFeRDProfile.
    %%
    %% ----------8<--------------8<-------------8<--------------8<----------
      systemdict /ColorConversionStrategy known {
        systemdict /ColorConversionStrategy get cvn dup /Gray eq {
          pop /N 1 false
        }{
          dup /RGB eq {
            pop /N 3 false
          }{
            /CMYK eq {
              /N 4 false
            }{
              (ColorConversionStrategy not a device space, falling back to ProcessColorModel, output may not be valid PDF/A.)=
              true
            } ifelse
          } ifelse
        } ifelse
      } {
        (ColorConversionStrategy not set, falling back to ProcessColorModel, output may not be valid PDF/A.)=
        true
      } ifelse

      {
        currentpagedevice /ProcessColorModel get
        dup /DeviceGray eq {
          pop /N 1
        }{
          dup /DeviceRGB eq {
            pop /N 3
          }{
            dup /DeviceCMYK eq {
              pop /N 4
            } {
              (ProcessColorModel not a device space.)=
              /ProcessColorModel cvx /rangecheck signalerror
            } ifelse
          } ifelse
        } ifelse
      } if
    %% ----------8<--------------8<-------------8<--------------8<----------
    >> /PUT pdfmark

    % Now read the ICC profile from the file into the stream
    [ {icc_PDFA} ZUGFeRDProfile (r) file /PUT pdfmark

    % Define the output intent dictionary :
    [/_objdef {OutputIntent_PDFA} /type /dict /OBJ pdfmark

    % Add the required keys to the dictionary
    [{OutputIntent_PDFA} <<
        /Type /OutputIntent
        /S /GTS_PDFA1                       % Required for PDF/A.
        /DestOutputProfile {icc_PDFA}       % The actual profile.
        /OutputConditionIdentifier (Custom) % A better solution is a string from the ICC Registry, but Custom is always valid.
      >> /PUT pdfmark

    % And now add the OutputIntent to the Catalog dictionary
    [ {Catalog} << /OutputIntents [ {OutputIntent_PDFA} ]>> /PUT pdfmark


    % Step 2, define the XML file and read it into the PDF
    % First we define the PDF stream to contain the XML invoice
    [ /_objdef {InvoiceStream} /type /stream /OBJ pdfmark

    % Fill in the dictionary elements we need. We believe the
    % ModDate is not useful so it's just set to a valid value.
    [ {InvoiceStream} <<
        /Type        /EmbeddedFile
        /Subtype    (text/xml) cvn
        /Params <<
          /ModDate    (D:20130121081433+01’00’)
        >>
      >> /PUT pdfmark

    % Now read the data from the file and store it in the stream
    [ {InvoiceStream} ZUGFeRDXMLFile (r) file /PUT pdfmark

    % and close the stream
    [ {InvoiceStream} /CLOSE pdfmark


    % Step 3 create the File Specification dictionary for the embedded file
    % Create the dictionary
    [ /_objdef {FSDict} /type /dict /OBJ pdfmark

    % Fill in the required dictionary elements
    [ {FSDict}    <<
      /Type /FileSpec
      /F ZUGFeRDXMLFile
      /UF ZUGFeRDXMLFile SimpleUTF16BE
      /Desc (ZUGFeRD electronic invoice)
      /AFRelationship    /Alternative
      /EF <<
          /F {InvoiceStream}
          /UF {InvoiceStream}
        >>
      >>
    /PUT pdfmark


    % Step 4 Create the Associated Files dictionary to hold the FS dict
    % Create the dictionary
    [ /_objdef {AFArray} /type /array /OBJ pdfmark

    % Put (append) the FS dictionary into the Associated Files array
    [ {AFArray} {FSDict} /APPEND pdfmark


    % Step 5 Add an entry in the Catalog dictionary containing the AF array
    [ {Catalog} << /AF {AFArray} >> /PUT pdfmark


    % Step 6 use the EMBED pdfmark to add the XML file and FS dictionary to the PDF name tree
    [ /Name ZUGFeRDXMLFile /FS {FSDict} /EMBED pdfmark


    % Step 7 Add the extra ZUGFeRD XML data to the Metadata
    [ /XML
(
    <!-- XMP extension schema container for the zugferd schema -->
    <rdf:Description rdf:about=""
    xmlns:pdfaExtension="http://www.aiim.org/pdfa/ns/extension/"
    xmlns:pdfaSchema="http://www.aiim.org/pdfa/ns/schema#"
    xmlns:pdfaProperty="http://www.aiim.org/pdfa/ns/property#">

    <!-- Container for all embedded extension schema descriptions -->
    <pdfaExtension:schemas>
        <rdf:Bag>
        <rdf:li rdf:parseType="Resource">
            <!-- Optional description of schema -->
            <pdfaSchema:schema>ZUGFeRD PDFA Extension Schema</pdfaSchema:schema>
            <!-- Schema namespace URI -->
            <pdfaSchema:namespaceURI>urn:ferd:pdfa:invoice:rc#</pdfaSchema:namespaceURI>
            <!-- Preferred schema namespace prefix -->
            <pdfaSchema:prefix>zf</pdfaSchema:prefix>

            <!-- Description of schema properties -->
            <pdfaSchema:property>
            <rdf:Seq>!
                <rdf:li rdf:parseType="Resource">
                <!-- DocumentFileName: Name of the embedded file;
                    must be equal with the value of the /F tag in the /EF
                    structure -->
                <pdfaProperty:name>DocumentFileName</pdfaProperty:name>
                <pdfaProperty:valueType>Text</pdfaProperty:valueType>
                <pdfaProperty:category>external</pdfaProperty:category>
                <pdfaProperty:description>name of the embedded xml invoice file</pdfaProperty:description>
                </rdf:li>
                <rdf:li rdf:parseType="Resource">
                <!-- DocumentType: INVOICE -->
                <pdfaProperty:name>DocumentType</pdfaProperty:name>
                <pdfaProperty:valueType>Text</pdfaProperty:valueType>
                <pdfaProperty:category>external</pdfaProperty:category>
                <pdfaProperty:description>INVOICE</pdfaProperty:description>
                </rdf:li>
                <rdf:li rdf:parseType="Resource">
                <!-- Version: The actual version of the
                    ZUGFeRD standard -->
                <pdfaProperty:name>Version</pdfaProperty:name>
                <pdfaProperty:valueType>Text</pdfaProperty:valueType>
                <pdfaProperty:category>external</pdfaProperty:category>
                <pdfaProperty:description>The actual version of the ZUGFeRD data</pdfaProperty:description>
                </rdf:li>
                <rdf:li rdf:parseType="Resource">
                <!-- ConformanceLevel: The actual conformance
                    level of the ZUGFeRD standard,
                    e.g. BASIC, COMFORT, EXTENDED -->
                <pdfaProperty:name>ConformanceLevel</pdfaProperty:name>
                <pdfaProperty:valueType>Text</pdfaProperty:valueType>
                <pdfaProperty:category>external</pdfaProperty:category>
                <pdfaProperty:description>The conformance level of the ZUGFeRD data</pdfaProperty:description>
                </rdf:li>
            </rdf:Seq>
            </pdfaSchema:property>
        </rdf:li>
        </rdf:Bag>
    </pdfaExtension:schemas>
    </rdf:Description>

    <rdf:Description rdf:about="" xmlns:zf="urn:ferd:pdfa:invoice:rc#">
    <zf:DocumentType>INVOICE</zf:DocumentType>
    <zf:DocumentFileName>ZUGFeRD-invoice.xml</zf:DocumentFileName>
    <zf:Version>RC</zf:Version>
    <zf:ConformanceLevel>BASIC</zf:ConformanceLevel>
    </rdf:Description>
) /Ext_Metadata pdfmark
  }
  {
    % No ICC Profile definition on the command line; chide the user and give them an example
    %
    (\nERROR - ZUGFeRDProfile has not been supplied, you must supply an ICC profile\n) print
    (        Producing a potentially invalid PDF/A file!!\n) print
    (example usage -  gs --permit-file-read=/usr/home/me/zugferd/ -sDEVICE=pdfwrite -dPDFA=3\\\n) print
    (         -sColorConversionStrategy=RGB -sZUGFeRDXMLFile=/usr/home/me/zugferd/invoice.xml\\\n) print
    (         -sZUGFeRDProfile=/usr/home/me/rgb.icc -o /usr/home/me/zugferd/zugferd.pdf\\\n) print
    (         /usr/home/me/zugferd/zugferd.ps /usr/home/me/zugferd/original.pdf\n\n) print flush
  } ifelse
}
{
  % No XML invoice definition on the command line; chide the user and give them an example
  %
  (\nERROR - ZUGFeRDXMLFile has not been supplied, you must supply an XML invoice file\n) print
  (        Producing a PDF/A file not a ZUGFeRD file.\n) print
  (example usage -  gs --permit-file-read=/usr/home/me/zugferd/ -sDEVICE=pdfwrite -dPDFA=3\\\n) print
  (         -sColorConversionStrategy=RGB -sZUGFeRDXMLFile=/usr/home/me/zugferd/invoice.xml\\\n) print
  (         -sZUGFeRDProfile=/usr/home/me/rgb.icc -o /usr/home/me/zugferd/zugferd.pdf\\\n) print
  (         /usr/home/me/zugferd/zugferd.ps /usr/home/me/zugferd/original.pdf\n\n) print flush
} ifelse

% That's all the ZUGFeRD and PDF/A-3 setup completed, all that remains now is to run the input file