-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
file.go
527 lines (460 loc) · 16.9 KB
/
file.go
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package metadata
import (
"bytes"
"context"
"fmt"
"io"
"reflect"
"unicode/utf8"
"github.com/apache/arrow/go/v17/parquet"
"github.com/apache/arrow/go/v17/parquet/compress"
"github.com/apache/arrow/go/v17/parquet/internal/encryption"
format "github.com/apache/arrow/go/v17/parquet/internal/gen-go/parquet"
"github.com/apache/arrow/go/v17/parquet/internal/thrift"
"github.com/apache/arrow/go/v17/parquet/schema"
"golang.org/x/xerrors"
)
// DefaultCompressionType is used unless a different compression is specified
// in the properties
var DefaultCompressionType = compress.Codecs.Uncompressed
// FileMetaDataBuilder is a proxy for more easily constructing file metadata
// particularly used when writing a file out.
type FileMetaDataBuilder struct {
metadata *format.FileMetaData
props *parquet.WriterProperties
schema *schema.Schema
rowGroups []*format.RowGroup
currentRgBldr *RowGroupMetaDataBuilder
kvmeta KeyValueMetadata
cryptoMetadata *format.FileCryptoMetaData
}
// NewFileMetadataBuilder will use the default writer properties if nil is passed for
// the writer properties and nil is allowable for the key value metadata.
func NewFileMetadataBuilder(schema *schema.Schema, props *parquet.WriterProperties, kvmeta KeyValueMetadata) *FileMetaDataBuilder {
var crypto *format.FileCryptoMetaData
if props.FileEncryptionProperties() != nil && props.FileEncryptionProperties().EncryptedFooter() {
crypto = format.NewFileCryptoMetaData()
}
return &FileMetaDataBuilder{
metadata: format.NewFileMetaData(),
props: props,
schema: schema,
kvmeta: kvmeta,
cryptoMetadata: crypto,
}
}
// GetFileCryptoMetaData returns the cryptographic information for encrypting/
// decrypting the file.
func (f *FileMetaDataBuilder) GetFileCryptoMetaData() *FileCryptoMetadata {
if f.cryptoMetadata == nil {
return nil
}
props := f.props.FileEncryptionProperties()
f.cryptoMetadata.EncryptionAlgorithm = props.Algorithm().ToThrift()
keyMetadata := props.FooterKeyMetadata()
if keyMetadata != "" {
f.cryptoMetadata.KeyMetadata = []byte(keyMetadata)
}
return &FileCryptoMetadata{f.cryptoMetadata, 0}
}
// AppendRowGroup adds a rowgroup to the list and returns a builder
// for that row group
func (f *FileMetaDataBuilder) AppendRowGroup() *RowGroupMetaDataBuilder {
if f.rowGroups == nil {
f.rowGroups = make([]*format.RowGroup, 0, 1)
}
rg := format.NewRowGroup()
f.rowGroups = append(f.rowGroups, rg)
f.currentRgBldr = NewRowGroupMetaDataBuilder(f.props, f.schema, rg)
return f.currentRgBldr
}
// AppendKeyValueMetadata appends a key/value pair to the existing key/value metadata
func (f *FileMetaDataBuilder) AppendKeyValueMetadata(key string, value string) error {
return f.kvmeta.Append(key, value)
}
// Finish will finalize the metadata of the number of rows, row groups,
// version etc. This will clear out this filemetadatabuilder so it can
// be re-used
func (f *FileMetaDataBuilder) Finish() (*FileMetaData, error) {
out, err := f.Snapshot()
f.Clear()
return out, err
}
// Snapshot returns finalized metadata of the number of rows, row groups, version etc.
// The snapshot must be used (e.g., serialized) before any additional (meta)data is
// written, as it refers to builder datastructures that will continue to mutate.
func (f *FileMetaDataBuilder) Snapshot() (*FileMetaData, error) {
totalRows := int64(0)
for _, rg := range f.rowGroups {
totalRows += rg.NumRows
}
f.metadata.NumRows = totalRows
f.metadata.RowGroups = f.rowGroups
switch f.props.Version() {
case parquet.V1_0:
f.metadata.Version = 1
default:
f.metadata.Version = 2
}
createdBy := f.props.CreatedBy()
f.metadata.CreatedBy = &createdBy
// Users cannot set the `ColumnOrder` since we do not have user defined sort order
// in the spec yet.
//
// We always default to `TYPE_DEFINED_ORDER`. We can expose it in
// the API once we have user defined sort orders in the Parquet format.
// TypeDefinedOrder implies choose SortOrder based on ConvertedType/PhysicalType
typeDefined := format.NewTypeDefinedOrder()
colOrder := &format.ColumnOrder{TYPE_ORDER: typeDefined}
f.metadata.ColumnOrders = make([]*format.ColumnOrder, f.schema.NumColumns())
for idx := range f.metadata.ColumnOrders {
f.metadata.ColumnOrders[idx] = colOrder
}
encryptProps := f.props.FileEncryptionProperties()
if encryptProps != nil && !encryptProps.EncryptedFooter() {
var signingAlgo parquet.Algorithm
algo := encryptProps.Algorithm()
signingAlgo.Aad.AadFileUnique = algo.Aad.AadFileUnique
signingAlgo.Aad.SupplyAadPrefix = algo.Aad.SupplyAadPrefix
if !algo.Aad.SupplyAadPrefix {
signingAlgo.Aad.AadPrefix = algo.Aad.AadPrefix
}
signingAlgo.Algo = parquet.AesGcm
f.metadata.EncryptionAlgorithm = signingAlgo.ToThrift()
footerSigningMetadata := f.props.FileEncryptionProperties().FooterKeyMetadata()
if footerSigningMetadata != "" {
f.metadata.FooterSigningKeyMetadata = []byte(footerSigningMetadata)
}
}
f.metadata.Schema = schema.ToThrift(f.schema.Root())
f.metadata.KeyValueMetadata = f.kvmeta
out := &FileMetaData{
FileMetaData: f.metadata,
version: NewAppVersion(f.metadata.GetCreatedBy()),
}
if err := out.initSchema(); err != nil {
return nil, err
}
out.initColumnOrders()
return out, nil
}
// Clears out this filemetadatabuilder so it can be re-used
func (f *FileMetaDataBuilder) Clear() {
f.metadata = format.NewFileMetaData()
f.rowGroups = nil
}
// KeyValueMetadata is an alias for a slice of thrift keyvalue pairs.
//
// It is presumed that the metadata should all be utf8 valid.
type KeyValueMetadata []*format.KeyValue
// NewKeyValueMetadata is equivalent to make(KeyValueMetadata, 0)
func NewKeyValueMetadata() KeyValueMetadata {
return make(KeyValueMetadata, 0)
}
// Append adds the passed in key and value to the metadata, if either contains
// any invalid utf8 runes, then it is not added and an error is returned.
func (k *KeyValueMetadata) Append(key, value string) error {
if !utf8.ValidString(key) || !utf8.ValidString(value) {
return fmt.Errorf("metadata must be valid utf8 strings, got key = '%s' and value = '%s'", key, value)
}
*k = append(*k, &format.KeyValue{Key: key, Value: &value})
return nil
}
func (k KeyValueMetadata) Len() int { return len(k) }
// Equals compares all of the metadata keys and values to check they are equal
func (k KeyValueMetadata) Equals(other KeyValueMetadata) bool {
return reflect.DeepEqual(k, other)
}
func (k KeyValueMetadata) Keys() (ret []string) {
ret = make([]string, len(k))
for idx, v := range k {
ret[idx] = v.GetKey()
}
return
}
func (k KeyValueMetadata) Values() (ret []string) {
ret = make([]string, len(k))
for idx, v := range k {
ret[idx] = v.GetValue()
}
return
}
func (k KeyValueMetadata) FindValue(key string) *string {
for _, v := range k {
if v.Key == key {
return v.Value
}
}
return nil
}
// FileMetaData is a proxy around the underlying thrift FileMetaData object
// to make it easier to use and interact with.
type FileMetaData struct {
*format.FileMetaData
Schema *schema.Schema
FileDecryptor encryption.FileDecryptor
// app version of the writer for this file
version *AppVersion
// size of the raw bytes of the metadata in the file which were
// decoded by thrift, Size() getter returns the value.
metadataLen int
}
// NewFileMetaData takes in the raw bytes of the serialized metadata to deserialize
// and will attempt to decrypt the footer if a decryptor is provided.
func NewFileMetaData(data []byte, fileDecryptor encryption.FileDecryptor) (*FileMetaData, error) {
meta := format.NewFileMetaData()
if fileDecryptor != nil {
footerDecryptor := fileDecryptor.GetFooterDecryptor()
data = footerDecryptor.Decrypt(data)
}
remain, err := thrift.DeserializeThrift(meta, data)
if err != nil {
return nil, err
}
f := &FileMetaData{
FileMetaData: meta,
version: NewAppVersion(meta.GetCreatedBy()),
metadataLen: len(data) - int(remain),
FileDecryptor: fileDecryptor,
}
f.initSchema()
f.initColumnOrders()
return f, nil
}
// Size is the length of the raw serialized metadata bytes in the footer
func (f *FileMetaData) Size() int { return f.metadataLen }
// NumSchemaElements is the length of the flattened schema list in the thrift
func (f *FileMetaData) NumSchemaElements() int {
return len(f.FileMetaData.Schema)
}
// RowGroup provides the metadata for the (0-based) index of the row group
func (f *FileMetaData) RowGroup(i int) *RowGroupMetaData {
return &RowGroupMetaData{
f.RowGroups[i], f.Schema, f.version, f.FileDecryptor,
}
}
func (f *FileMetaData) Serialize(ctx context.Context) ([]byte, error) {
return thrift.NewThriftSerializer().Write(ctx, f.FileMetaData)
}
func (f *FileMetaData) SerializeString(ctx context.Context) (string, error) {
return thrift.NewThriftSerializer().WriteString(ctx, f.FileMetaData)
}
// EncryptionAlgorithm constructs the algorithm object from the thrift
// information or returns an empty instance if it was not set.
func (f *FileMetaData) EncryptionAlgorithm() parquet.Algorithm {
if f.IsSetEncryptionAlgorithm() {
return parquet.AlgorithmFromThrift(f.GetEncryptionAlgorithm())
}
return parquet.Algorithm{}
}
func (f *FileMetaData) initSchema() error {
root, err := schema.FromParquet(f.FileMetaData.Schema)
if err != nil {
return err
}
f.Schema = schema.NewSchema(root.(*schema.GroupNode))
return nil
}
func (f *FileMetaData) initColumnOrders() {
orders := make([]parquet.ColumnOrder, 0, f.Schema.NumColumns())
if f.IsSetColumnOrders() {
for _, o := range f.GetColumnOrders() {
if o.IsSetTYPE_ORDER() {
orders = append(orders, parquet.ColumnOrders.TypeDefinedOrder)
} else {
orders = append(orders, parquet.ColumnOrders.Undefined)
}
}
} else {
orders = orders[:f.Schema.NumColumns()]
orders[0] = parquet.ColumnOrders.Undefined
for i := 1; i < len(orders); i *= 2 {
copy(orders[i:], orders[:i])
}
}
f.Schema.UpdateColumnOrders(orders)
}
// WriterVersion returns the constructed application version from the
// created by string
func (f *FileMetaData) WriterVersion() *AppVersion {
if f.version == nil {
f.version = NewAppVersion(f.GetCreatedBy())
}
return f.version
}
// SetFilePath will set the file path into all of the columns in each row group.
func (f *FileMetaData) SetFilePath(path string) {
for _, rg := range f.RowGroups {
for _, chunk := range rg.Columns {
chunk.FilePath = &path
}
}
}
// AppendRowGroups will add all of the rowgroup metadata from other to the
// current file metadata
func (f *FileMetaData) AppendRowGroups(other *FileMetaData) error {
if !f.Schema.Equals(other.Schema) {
return xerrors.New("parquet/FileMetaData: AppendRowGroups requires equal schemas")
}
f.RowGroups = append(f.RowGroups, other.GetRowGroups()...)
for _, rg := range other.GetRowGroups() {
f.NumRows += rg.NumRows
}
return nil
}
// Subset will construct a new FileMetaData object containing only the requested
// row groups by index
func (f *FileMetaData) Subset(rowGroups []int) (*FileMetaData, error) {
for _, i := range rowGroups {
if i < len(f.RowGroups) {
continue
}
return nil, fmt.Errorf("parquet: this file only has %d row groups, but requested a subset including row group: %d", len(f.RowGroups), i)
}
out := &FileMetaData{
&format.FileMetaData{
Schema: f.FileMetaData.Schema,
CreatedBy: f.CreatedBy,
ColumnOrders: f.GetColumnOrders(),
EncryptionAlgorithm: f.FileMetaData.EncryptionAlgorithm,
FooterSigningKeyMetadata: f.FooterSigningKeyMetadata,
Version: f.FileMetaData.Version,
KeyValueMetadata: f.KeyValueMetadata(),
},
f.Schema,
f.FileDecryptor,
f.version,
0,
}
out.RowGroups = make([]*format.RowGroup, 0, len(rowGroups))
for _, selected := range rowGroups {
out.RowGroups = append(out.RowGroups, f.RowGroups[selected])
out.NumRows += f.RowGroups[selected].GetNumRows()
}
return out, nil
}
func (f *FileMetaData) Equals(other *FileMetaData) bool {
return reflect.DeepEqual(f.FileMetaData, other.FileMetaData)
}
func (f *FileMetaData) KeyValueMetadata() KeyValueMetadata {
return f.GetKeyValueMetadata()
}
// VerifySignature constructs a cryptographic signature using the FileDecryptor
// of the footer and then verifies it's integrity.
//
// Panics if f.FileDecryptor is nil
func (f *FileMetaData) VerifySignature(signature []byte) bool {
if f.FileDecryptor == nil {
panic("decryption not set properly, cannot verify signature")
}
serializer := thrift.NewThriftSerializer()
data, _ := serializer.Write(context.Background(), f.FileMetaData)
nonce := signature[:encryption.NonceLength]
tag := signature[encryption.NonceLength : encryption.NonceLength+encryption.GcmTagLength]
key := f.FileDecryptor.GetFooterKey()
aad := encryption.CreateFooterAad(f.FileDecryptor.FileAad())
enc := encryption.NewAesEncryptor(f.FileDecryptor.Algorithm(), true)
var buf bytes.Buffer
buf.Grow(enc.CiphertextSizeDelta() + len(data))
encryptedLen := enc.SignedFooterEncrypt(&buf, data, []byte(key), []byte(aad), nonce)
return bytes.Equal(buf.Bytes()[encryptedLen-encryption.GcmTagLength:], tag)
}
// WriteTo will serialize and write out this file metadata, encrypting it if
// appropriate.
//
// If it is an encrypted file with a plaintext footer, then we will write the
// signature with the unencrypted footer.
func (f *FileMetaData) WriteTo(w io.Writer, encryptor encryption.Encryptor) (int64, error) {
serializer := thrift.NewThriftSerializer()
// only in encrypted files with plaintext footers, the encryption algorithm is set in the footer
if f.IsSetEncryptionAlgorithm() {
data, err := serializer.Write(context.Background(), f.FileMetaData)
if err != nil {
return 0, err
}
// encrypt the footer key
var buf bytes.Buffer
buf.Grow(encryptor.CiphertextSizeDelta() + len(data))
encryptedLen := encryptor.Encrypt(&buf, data)
wrote := 0
n := 0
// write unencrypted footer
if n, err = w.Write(data); err != nil {
return int64(n), err
}
wrote += n
// write signature (nonce and tag)
buf.Next(4)
if n, err = w.Write(buf.Next(encryption.NonceLength)); err != nil {
return int64(wrote + n), err
}
wrote += n
buf.Next(encryptedLen - 4 - encryption.NonceLength - encryption.GcmTagLength)
n, err = w.Write(buf.Next(encryption.GcmTagLength))
return int64(wrote + n), err
}
n, err := serializer.Serialize(f.FileMetaData, w, encryptor)
return int64(n), err
}
// Version returns the "version" of the file
//
// WARNING: The value returned by this method is unreliable as 1) the
// parquet file metadata stores the version as a single integer and
// 2) some producers are known to always write a hardcoded value. Therefore
// you cannot use this value to know which features are used in the file.
func (f *FileMetaData) Version() parquet.Version {
switch f.FileMetaData.Version {
case 1:
return parquet.V1_0
case 2:
return parquet.V2_LATEST
default:
// improperly set version, assume parquet 1.0
return parquet.V1_0
}
}
// FileCryptoMetadata is a proxy for the thrift fileCryptoMetadata object
type FileCryptoMetadata struct {
metadata *format.FileCryptoMetaData
cryptoMetadataLen uint32
}
// NewFileCryptoMetaData takes in the raw serialized bytes to deserialize
// storing the number of bytes that were actually deserialized.
func NewFileCryptoMetaData(metadata []byte) (ret FileCryptoMetadata, err error) {
ret.metadata = format.NewFileCryptoMetaData()
var remain uint64
remain, err = thrift.DeserializeThrift(ret.metadata, metadata)
ret.cryptoMetadataLen = uint32(uint64(len(metadata)) - remain)
return
}
// WriteTo writes out the serialized crypto metadata to w
func (fc FileCryptoMetadata) WriteTo(w io.Writer) (int64, error) {
serializer := thrift.NewThriftSerializer()
n, err := serializer.Serialize(fc.metadata, w, nil)
return int64(n), err
}
// Len is the number of bytes that were deserialized to create this object
func (fc FileCryptoMetadata) Len() int { return int(fc.cryptoMetadataLen) }
func (fc FileCryptoMetadata) KeyMetadata() []byte {
return fc.metadata.KeyMetadata
}
// EncryptionAlgorithm constructs the object from the thrift instance of
// the encryption algorithm
func (fc FileCryptoMetadata) EncryptionAlgorithm() parquet.Algorithm {
return parquet.AlgorithmFromThrift(fc.metadata.GetEncryptionAlgorithm())
}