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
|
// Package decoder provides low-level decoding utilities for MaxMind DB data.
package decoder
import (
"fmt"
"iter"
"github.com/oschwald/maxminddb-golang/v2/internal/mmdberrors"
)
// Decoder allows decoding of a single value stored at a specific offset
// in the database.
type Decoder struct {
d DataDecoder
offset uint
nextOffset uint
opts decoderOptions
hasNextOffset bool
}
type decoderOptions struct {
// Reserved for future options
}
// DecoderOption configures a Decoder.
//
//nolint:revive // name follows existing library pattern (ReaderOption, NetworksOption)
type DecoderOption func(*decoderOptions)
// NewDecoder creates a new Decoder with the given DataDecoder, offset, and options.
func NewDecoder(d DataDecoder, offset uint, options ...DecoderOption) *Decoder {
opts := decoderOptions{}
for _, option := range options {
option(&opts)
}
decoder := &Decoder{
d: d,
offset: offset,
opts: opts,
}
return decoder
}
// ReadBool reads the value pointed by the decoder as a bool.
//
// Returns an error if the database is malformed or if the pointed value is not a bool.
func (d *Decoder) ReadBool() (bool, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindBool)
if err != nil {
return false, d.wrapError(err)
}
value, newOffset, err := d.d.decodeBool(size, offset)
if err != nil {
return false, d.wrapError(err)
}
d.setNextOffset(newOffset)
return value, nil
}
// ReadString reads the value pointed by the decoder as a string.
//
// Returns an error if the database is malformed or if the pointed value is not a string.
func (d *Decoder) ReadString() (string, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindString)
if err != nil {
return "", d.wrapError(err)
}
value, newOffset, err := d.d.decodeString(size, offset)
if err != nil {
return "", d.wrapError(err)
}
d.setNextOffset(newOffset)
return value, nil
}
// ReadBytes reads the value pointed by the decoder as bytes.
//
// Returns an error if the database is malformed or if the pointed value is not bytes.
func (d *Decoder) ReadBytes() ([]byte, error) {
val, err := d.readBytes(KindBytes)
if err != nil {
return nil, d.wrapError(err)
}
return val, nil
}
// ReadFloat32 reads the value pointed by the decoder as a float32.
//
// Returns an error if the database is malformed or if the pointed value is not a float.
func (d *Decoder) ReadFloat32() (float32, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindFloat32)
if err != nil {
return 0, d.wrapError(err)
}
value, nextOffset, err := d.d.decodeFloat32(size, offset)
if err != nil {
return 0, d.wrapError(err)
}
d.setNextOffset(nextOffset)
return value, nil
}
// ReadFloat64 reads the value pointed by the decoder as a float64.
//
// Returns an error if the database is malformed or if the pointed value is not a double.
func (d *Decoder) ReadFloat64() (float64, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindFloat64)
if err != nil {
return 0, d.wrapError(err)
}
value, nextOffset, err := d.d.decodeFloat64(size, offset)
if err != nil {
return 0, d.wrapError(err)
}
d.setNextOffset(nextOffset)
return value, nil
}
// ReadInt32 reads the value pointed by the decoder as a int32.
//
// Returns an error if the database is malformed or if the pointed value is not an int32.
func (d *Decoder) ReadInt32() (int32, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindInt32)
if err != nil {
return 0, d.wrapError(err)
}
value, nextOffset, err := d.d.decodeInt32(size, offset)
if err != nil {
return 0, d.wrapError(err)
}
d.setNextOffset(nextOffset)
return value, nil
}
// ReadUint16 reads the value pointed by the decoder as a uint16.
//
// Returns an error if the database is malformed or if the pointed value is not an uint16.
func (d *Decoder) ReadUint16() (uint16, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindUint16)
if err != nil {
return 0, d.wrapError(err)
}
value, nextOffset, err := d.d.decodeUint16(size, offset)
if err != nil {
return 0, d.wrapError(err)
}
d.setNextOffset(nextOffset)
return value, nil
}
// ReadUint32 reads the value pointed by the decoder as a uint32.
//
// Returns an error if the database is malformed or if the pointed value is not an uint32.
func (d *Decoder) ReadUint32() (uint32, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindUint32)
if err != nil {
return 0, d.wrapError(err)
}
value, nextOffset, err := d.d.decodeUint32(size, offset)
if err != nil {
return 0, d.wrapError(err)
}
d.setNextOffset(nextOffset)
return value, nil
}
// ReadUint64 reads the value pointed by the decoder as a uint64.
//
// Returns an error if the database is malformed or if the pointed value is not an uint64.
func (d *Decoder) ReadUint64() (uint64, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindUint64)
if err != nil {
return 0, d.wrapError(err)
}
value, nextOffset, err := d.d.decodeUint64(size, offset)
if err != nil {
return 0, d.wrapError(err)
}
d.setNextOffset(nextOffset)
return value, nil
}
// ReadUint128 reads the value pointed by the decoder as a uint128.
//
// Returns an error if the database is malformed or if the pointed value is not an uint128.
func (d *Decoder) ReadUint128() (hi, lo uint64, err error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindUint128)
if err != nil {
return 0, 0, d.wrapError(err)
}
hi, lo, nextOffset, err := d.d.decodeUint128(size, offset)
if err != nil {
return 0, 0, d.wrapError(err)
}
d.setNextOffset(nextOffset)
return hi, lo, nil
}
// ReadMap returns an iterator to read the map along with the map size. The
// size can be used to pre-allocate a map with the correct capacity for better
// performance. The first value from the iterator is the key. Please note that
// this byte slice is only valid during the iteration. This is done to avoid
// an unnecessary allocation. You must make a copy of it if you are storing it
// for later use. The second value is an error indicating that the database is
// malformed or that the pointed value is not a map.
func (d *Decoder) ReadMap() (iter.Seq2[[]byte, error], uint, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindMap)
if err != nil {
return nil, 0, d.wrapError(err)
}
iterator := func(yield func([]byte, error) bool) {
currentOffset := offset
for range size {
key, keyEndOffset, err := d.d.decodeKey(currentOffset)
if err != nil {
yield(nil, d.wrapErrorAtOffset(err, currentOffset))
return
}
// Position decoder to read value after yielding key
d.reset(keyEndOffset)
ok := yield(key, nil)
if !ok {
return
}
// Skip the value to get to next key-value pair
valueEndOffset, err := d.d.nextValueOffset(keyEndOffset, 1)
if err != nil {
yield(nil, d.wrapError(err))
return
}
currentOffset = valueEndOffset
}
// Set the final offset after map iteration
d.reset(currentOffset)
}
return iterator, size, nil
}
// ReadSlice returns an iterator over the values of the slice along with the
// slice size. The size can be used to pre-allocate a slice with the correct
// capacity for better performance. The iterator returns an error if the
// database is malformed or if the pointed value is not a slice.
func (d *Decoder) ReadSlice() (iter.Seq[error], uint, error) {
size, offset, err := d.decodeCtrlDataAndFollow(KindSlice)
if err != nil {
return nil, 0, d.wrapError(err)
}
iterator := func(yield func(error) bool) {
currentOffset := offset
for i := range size {
// Position decoder to read current element
d.reset(currentOffset)
ok := yield(nil)
if !ok {
// Skip the unvisited elements
remaining := size - i - 1
if remaining > 0 {
endOffset, err := d.d.nextValueOffset(currentOffset, remaining)
if err == nil {
d.reset(endOffset)
}
}
return
}
// Advance to next element
nextOffset, err := d.d.nextValueOffset(currentOffset, 1)
if err != nil {
yield(d.wrapError(err))
return
}
currentOffset = nextOffset
}
// Set final offset after slice iteration
d.reset(currentOffset)
}
return iterator, size, nil
}
// SkipValue skips over the current value without decoding it.
// This is useful in custom decoders when encountering unknown fields.
// The decoder will be positioned after the skipped value.
func (d *Decoder) SkipValue() error {
// We can reuse the existing nextValueOffset logic by jumping to the next value
nextOffset, err := d.d.nextValueOffset(d.offset, 1)
if err != nil {
return d.wrapError(err)
}
d.reset(nextOffset)
return nil
}
// PeekKind returns the kind of the current value without consuming it.
// This allows for look-ahead parsing similar to jsontext.Decoder.PeekKind().
func (d *Decoder) PeekKind() (Kind, error) {
kindNum, _, _, err := d.d.decodeCtrlData(d.offset)
if err != nil {
return 0, d.wrapError(err)
}
// Follow pointers to get the actual kind
if kindNum == KindPointer {
// We need to follow the pointer to get the real kind
dataOffset := d.offset
for {
var size uint
kindNum, size, dataOffset, err = d.d.decodeCtrlData(dataOffset)
if err != nil {
return 0, d.wrapError(err)
}
if kindNum != KindPointer {
break
}
dataOffset, _, err = d.d.decodePointer(size, dataOffset)
if err != nil {
return 0, d.wrapError(err)
}
}
}
return kindNum, nil
}
// Offset returns the current offset position in the database.
// If the current position points to a pointer, this method resolves the
// pointer chain and returns the offset of the actual data. This ensures
// that multiple pointers to the same data return the same offset, which
// is important for caching purposes.
func (d *Decoder) Offset() uint {
// Follow pointer chain to get resolved data location
dataOffset := d.offset
for {
kindNum, size, ctrlEndOffset, err := d.d.decodeCtrlData(dataOffset)
if err != nil {
// Return original offset to avoid breaking the public API.
// Offset() returns uint (not (uint, error)), so we can't propagate errors.
// In practice, errors here are rare and the original offset is still valid.
return d.offset
}
if kindNum != KindPointer {
// dataOffset is now pointing at the actual data (not a pointer)
// Return this offset, which is where the data's control bytes start
break
}
// Follow the pointer to get the target offset
dataOffset, _, err = d.d.decodePointer(size, ctrlEndOffset)
if err != nil {
// Return original offset to avoid breaking the public API.
// The caller will encounter the same error when they try to read.
return d.offset
}
// dataOffset is now the pointer target; loop to check if it's also a pointer
}
return dataOffset
}
func (d *Decoder) reset(offset uint) {
d.offset = offset
d.hasNextOffset = false
d.nextOffset = 0
}
func (d *Decoder) setNextOffset(offset uint) {
if !d.hasNextOffset {
d.hasNextOffset = true
d.nextOffset = offset
}
}
func unexpectedKindErr(expectedKind, actualKind Kind) error {
return fmt.Errorf("unexpected kind %d, expected %d", actualKind, expectedKind)
}
func (d *Decoder) decodeCtrlDataAndFollow(expectedKind Kind) (uint, uint, error) {
dataOffset := d.offset
for {
var kindNum Kind
var size uint
var err error
kindNum, size, dataOffset, err = d.d.decodeCtrlData(dataOffset)
if err != nil {
return 0, 0, err // Don't wrap here, let caller wrap
}
if kindNum == KindPointer {
var nextOffset uint
dataOffset, nextOffset, err = d.d.decodePointer(size, dataOffset)
if err != nil {
return 0, 0, err // Don't wrap here, let caller wrap
}
d.setNextOffset(nextOffset)
continue
}
if kindNum != expectedKind {
return 0, 0, unexpectedKindErr(expectedKind, kindNum)
}
return size, dataOffset, nil
}
}
func (d *Decoder) readBytes(kind Kind) ([]byte, error) {
size, offset, err := d.decodeCtrlDataAndFollow(kind)
if err != nil {
return nil, err // Return unwrapped - caller will wrap
}
if offset+size > uint(len(d.d.getBuffer())) {
return nil, mmdberrors.NewInvalidDatabaseError(
"the MaxMind DB file's data section contains bad data (offset+size %d exceeds buffer length %d)",
offset+size,
len(d.d.getBuffer()),
)
}
d.setNextOffset(offset + size)
return d.d.getBuffer()[offset : offset+size], nil
}
|