-
Notifications
You must be signed in to change notification settings - Fork 7
/
attachment.go
332 lines (247 loc) · 9.92 KB
/
attachment.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
// go-pst is a library for reading Personal Storage Table (.pst) files (written in Go/Golang).
//
// Copyright 2023 Marten Mooij
//
// Licensed 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 pst
import (
"github.com/mooijtech/go-pst/v6/pkg/properties"
"io"
"github.com/rotisserie/eris"
)
// Attachment represents a message attachment.
type Attachment struct {
Identifier Identifier
PropertyContext *PropertyContext
LocalDescriptors []LocalDescriptor
properties.Attachment
}
// HasAttachments returns true if this message has attachments.
func (message *Message) HasAttachments() (bool, error) {
reader, err := message.PropertyContext.GetPropertyReader(3591, message.LocalDescriptors)
if err != nil {
return false, eris.Wrap(err, "failed to get property reader")
}
value, err := reader.GetInteger32()
if err != nil {
return false, eris.Wrap(err, "failed to read int32")
}
return value&0x10 != 0, nil
}
// GetAttachmentTableContext returns the table context of the attachments of this message.
// Note we only return the attachment identifier property.
func (message *Message) GetAttachmentTableContext() (*TableContext, error) {
hasAttachments, err := message.HasAttachments()
if err != nil {
return nil, eris.Wrap(err, "failed to check if there are attachments")
}
if !hasAttachments {
return nil, ErrAttachmentsNotFound
}
if message.AttachmentTableContext == nil {
// Initialize the attachments table context.
attachmentLocalDescriptor, err := FindLocalDescriptor(1649, message.LocalDescriptors)
if err != nil {
return nil, eris.Wrap(err, "failed to find attachment local descriptor")
}
attachmentHeapOnNode, err := message.File.GetHeapOnNodeFromLocalDescriptor(attachmentLocalDescriptor)
if err != nil {
return nil, eris.Wrap(err, "failed to get attachment Heap-on-Node")
}
attachmentLocalDescriptors, err := message.File.GetLocalDescriptorsFromIdentifier(attachmentLocalDescriptor.LocalDescriptorsIdentifier)
if err != nil {
return nil, eris.Wrap(err, "failed to get attachment local descriptors")
}
attachmentTableContext, err := message.File.GetTableContext(attachmentHeapOnNode, attachmentLocalDescriptors, 26610)
if err != nil {
return nil, eris.Wrap(err, "failed to get attachment table context")
}
message.AttachmentTableContext = &attachmentTableContext
}
return message.AttachmentTableContext, nil
}
// GetAttachmentCount returns the amount of rows in the attachment table context.
func (message *Message) GetAttachmentCount() (int, error) {
attachmentTableContext, err := message.GetAttachmentTableContext()
if eris.Is(err, ErrAttachmentsNotFound) {
return 0, nil
} else if err != nil {
return 0, eris.Wrap(err, "failed to get attachment table context")
}
return len(attachmentTableContext.Properties), nil
}
// GetAttachment returns the specified attachment.
func (message *Message) GetAttachment(attachmentIndex int) (*Attachment, error) {
attachmentsTableContext, err := message.GetAttachmentTableContext()
if err != nil {
return nil, eris.Wrap(err, "failed to get attachments table context")
} else if attachmentIndex > len(attachmentsTableContext.Properties)-1 {
return nil, ErrAttachmentIndexInvalid
}
var attachmentHNID Identifier
for _, attachmentProperty := range attachmentsTableContext.Properties[attachmentIndex] {
// We only get the attachment identifier property from GetAttachmentTableContext.
propertyReader, err := attachmentsTableContext.GetPropertyReader(attachmentProperty)
if err != nil {
return nil, eris.Wrap(err, "failed to get attachments table context property reader")
}
identifier, err := propertyReader.GetInteger32()
if err != nil {
return nil, eris.Wrap(err, "failed to read identifier")
}
attachmentHNID = Identifier(identifier)
}
if attachmentHNID == 0 {
return nil, eris.New("failed to get attachment HNID")
}
attachmentLocalDescriptor, err := FindLocalDescriptor(attachmentHNID, message.LocalDescriptors)
if err != nil {
return nil, eris.Wrap(err, "failed to find attachment local descriptor")
}
attachmentLocalDescriptors, err := message.File.GetLocalDescriptorsFromIdentifier(attachmentLocalDescriptor.LocalDescriptorsIdentifier)
if err != nil {
return nil, eris.Wrap(err, "failed to get local descriptors from identifier")
}
attachmentHeapOnNode, err := message.File.GetHeapOnNodeFromLocalDescriptor(attachmentLocalDescriptor)
if err != nil {
return nil, eris.Wrap(err, "failed to get attachment Heap-on-Node")
}
attachmentPropertyContext, err := message.File.GetPropertyContext(attachmentHeapOnNode)
if err != nil {
return nil, eris.Wrap(err, "failed to get attachment property context")
}
attachment := &Attachment{
Identifier: attachmentLocalDescriptor.Identifier,
PropertyContext: attachmentPropertyContext,
LocalDescriptors: attachmentLocalDescriptors,
}
if err := attachmentPropertyContext.Populate(attachment, attachmentLocalDescriptors); err != nil {
return nil, eris.Wrap(err, "failed to populate attachment property context")
}
return attachment, nil
}
// GetAttachment returns the attachment.
// Note that the properties aren't populated (call PropertyContext.Populate).
func (file *File) GetAttachment(messageIdentifier Identifier) (*Attachment, error) {
attachmentsNode, err := file.GetNodeBTreeNode(messageIdentifier)
if err != nil {
return nil, eris.Wrap(err, "failed to find node b-tree node")
}
attachmentsDataNode, err := file.GetBlockBTreeNode(attachmentsNode.DataIdentifier)
if err != nil {
return nil, eris.Wrap(err, "failed to find block b-tree node")
}
attachmentsHeapOnNode, err := file.GetHeapOnNode(attachmentsDataNode)
if err != nil {
return nil, eris.Wrap(err, "failed to get Heap-on-Node")
}
localDescriptors, err := file.GetLocalDescriptors(attachmentsNode)
if err != nil {
return nil, eris.Wrap(err, "failed to find local descriptors")
}
propertyContext, err := file.GetPropertyContext(attachmentsHeapOnNode)
attachment := &Attachment{
Identifier: messageIdentifier,
PropertyContext: propertyContext,
LocalDescriptors: localDescriptors,
}
if err := propertyContext.Populate(attachment, localDescriptors); err != nil {
return nil, eris.Wrap(err, "failed to populate attachment property context")
}
return attachment, nil
}
// GetAllAttachments returns the attachments of this message.
// See AttachmentIterator.
func (message *Message) GetAllAttachments() ([]*Attachment, error) {
attachmentCount, err := message.GetAttachmentCount()
if eris.Is(err, ErrAttachmentsNotFound) {
return nil, nil
} else if err != nil {
return nil, eris.Wrap(err, "failed to get attachment count")
}
attachments := make([]*Attachment, attachmentCount)
for i := 0; i < attachmentCount; i++ {
attachment, err := message.GetAttachment(i)
if err != nil {
return nil, eris.Wrap(err, "failed to get attachment")
}
attachments[i] = attachment
}
return attachments, nil
}
// AttachmentIterator implements an attachment iterator.
type AttachmentIterator struct {
message *Message
err error
currentIndex int
currentAttachment *Attachment
}
// Err return the error cause.
func (attachmentIterator *AttachmentIterator) Err() error {
return attachmentIterator.err
}
// Next will ensure that Value returns the next item when executed.
// If the next value is not retrievable, Next will return false and Err() will return the error cause.
func (attachmentIterator *AttachmentIterator) Next() bool {
hasNext := len(attachmentIterator.message.AttachmentTableContext.Properties) > attachmentIterator.currentIndex
if !hasNext {
return false
}
attachment, err := attachmentIterator.message.GetAttachment(attachmentIterator.currentIndex)
if err != nil {
attachmentIterator.err = eris.Wrap(err, "failed to get attachment")
return false
}
attachmentIterator.currentIndex++
attachmentIterator.currentAttachment = attachment
return true
}
// Value returns the current value in the iterator.
func (attachmentIterator *AttachmentIterator) Value() *Attachment {
return attachmentIterator.currentAttachment
}
// Size returns the amount of attachments in the message iterator.
func (attachmentIterator *AttachmentIterator) Size() int {
return len(attachmentIterator.message.AttachmentTableContext.Properties)
}
func (attachmentIterator *AttachmentIterator) CurrentIndex() int {
return attachmentIterator.currentIndex
}
// GetAttachmentIterator returns an iterator for attachments.
func (message *Message) GetAttachmentIterator() (AttachmentIterator, error) {
attachmentCount, err := message.GetAttachmentCount()
// TODO - Return an empty iterator instead of an error.
if err != nil {
return AttachmentIterator{}, eris.Wrap(err, "failed to get attachment count")
} else if attachmentCount == 0 {
return AttachmentIterator{}, ErrAttachmentsNotFound
}
return AttachmentIterator{
message: message,
}, nil
}
// WriteTo writes the attachment to the specified io.Writer.
func (attachment *Attachment) WriteTo(writer io.Writer) (int64, error) {
attachmentReader, err := attachment.PropertyContext.GetPropertyReader(14081, attachment.LocalDescriptors)
if eris.Is(err, ErrPropertyNoData) {
return 0, nil
} else if err != nil {
return 0, eris.Wrap(err, "failed to get attachment property reader")
}
sectionReader := io.NewSectionReader(&attachmentReader, 0, attachmentReader.Size())
written, err := io.CopyN(writer, sectionReader, sectionReader.Size())
if err != nil {
return written, eris.Wrap(err, "failed to write attachment")
}
return written, nil
}