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
|
package rardecode
import (
"errors"
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"strconv"
"strings"
"sync"
)
var (
ErrVerMismatch = errors.New("rardecode: volume version mistmatch")
ErrArchiveNameEmpty = errors.New("rardecode: archive name empty")
ErrFileNameRequired = errors.New("rardecode: filename required for multi volume archive")
ErrInvalidHeaderOff = errors.New("rardecode: invalid filed header offset")
defaultFS = osFS{}
)
const (
DefaultMaxDictionarySize = 4 << 30 // default max dictionary size of 4GB
)
type osFS struct{}
func (fs osFS) Open(name string) (fs.File, error) {
return os.Open(name)
}
type options struct {
bsize int // size to be use for bufio.Reader
maxDictSize int64 // max dictionary size
fs fs.FS // filesystem to use to open files
pass *string // password for encrypted volumes
skipCheck bool
openCheck bool
}
// An Option is used for optional archive extraction settings.
type Option func(*options)
// BufferSize sets the size of the bufio.Reader used in reading the archive.
func BufferSize(size int) Option {
return func(o *options) { o.bsize = size }
}
// MaxDictionarySize sets the maximum size in bytes of the dictionary used in decoding a file.
// Any attempt to decode a file with a larger size will return an error.
// The default size if not set is DefaultMaxDictionarySize.
// Any size above 64GB will be ignored. Any size below 256kB will prevent any file from being decoded.
func MaxDictionarySize(size int64) Option {
return func(o *options) { o.maxDictSize = size }
}
// FileSystem sets the fs.FS to be used for opening archive volumes.
func FileSystem(fs fs.FS) Option {
return func(o *options) { o.fs = fs }
}
// Password sets the password to use for decrypting archives.
func Password(pass string) Option {
return func(o *options) { o.pass = &pass }
}
// SkipCheck sets archive files checksum not to be checked.
func SkipCheck(o *options) { o.skipCheck = true }
// OpenFSCheck flags the archive files to be checked on Open or List.
func OpenFSCheck(o *options) { o.openCheck = true }
func getOptions(opts []Option) *options {
opt := &options{
fs: defaultFS,
maxDictSize: DefaultMaxDictionarySize,
}
for _, f := range opts {
f(opt)
}
// truncate password
if opt.pass != nil {
runes := []rune(*opt.pass)
if len(runes) > maxPassword {
pw := string(runes[:maxPassword])
opt.pass = &pw
}
}
return opt
}
type volume interface {
byteReader
writeToAtMost(w io.Writer, n int64) (int64, error)
nextBlock() (*fileBlockHeader, error)
openBlock(volnum int, offset, size int64) error
canSeek() bool
}
type readerVolume struct {
br *bufVolumeReader // buffered reader for current volume file
n int64 // bytes left in current block
num int // current volume number
ver int // archive file format version
arc archiveBlockReader
opt *options
}
func (v *readerVolume) init(r io.Reader, volnum int) error {
var err error
if v.br == nil {
v.br, err = newBufVolumeReader(r, v.opt.bsize)
} else {
err = v.br.Reset(r)
}
if err != nil {
return err
}
if v.arc == nil {
switch v.br.ver {
case archiveVersion15:
v.arc = newArchive15(v.opt.pass)
case archiveVersion50:
v.arc = newArchive50(v.opt.pass)
default:
return ErrUnknownVersion
}
v.ver = v.br.ver
} else if v.ver != v.br.ver {
return ErrVerMismatch
}
n, err := v.arc.init(v.br)
if err != nil {
return err
}
v.num = volnum
if n >= 0 && n != volnum {
return ErrBadVolumeNumber
}
return nil
}
func (v *readerVolume) nextBlock() (*fileBlockHeader, error) {
if v.n > 0 {
err := v.br.Discard(v.n)
if err != nil {
return nil, err
}
v.n = 0
}
f, err := v.arc.nextBlock(v.br)
if err != nil {
return nil, err
}
f.volnum = v.num
f.dataOff = v.br.off
v.n = f.PackedSize
return f, nil
}
func (v *readerVolume) Read(p []byte) (int, error) {
if v.n == 0 {
return 0, io.EOF
}
if v.n < int64(len(p)) {
p = p[:v.n]
}
n, err := v.br.Read(p)
v.n -= int64(n)
if err == io.EOF && v.n > 0 {
err = io.ErrUnexpectedEOF
}
return n, err
}
func (v *readerVolume) ReadByte() (byte, error) {
if v.n == 0 {
return 0, io.EOF
}
b, err := v.br.ReadByte()
if err == nil {
v.n--
} else if err == io.EOF && v.n > 0 {
err = io.ErrUnexpectedEOF
}
return b, err
}
func (v *readerVolume) writeToAtMost(w io.Writer, n int64) (int64, error) {
if n == 0 {
return 0, nil
}
if n > 0 {
n = min(n, v.n)
} else {
n = v.n
}
l, err := v.br.writeToN(w, n)
v.n -= l
return l, err
}
func (v *readerVolume) canSeek() bool {
return v.br.canSeek()
}
func (v *readerVolume) openBlock(volnum int, offset, size int64) error {
if v.num != volnum {
return ErrBadVolumeNumber
}
err := v.br.seek(offset)
if err != nil {
return err
}
v.n = size
return nil
}
func newVolume(r io.Reader, opt *options, volnum int) (*readerVolume, error) {
v := &readerVolume{opt: opt}
err := v.init(r, volnum)
if err != nil {
return nil, err
}
return v, nil
}
type fileVolume struct {
*readerVolume
f fs.File
vm *volumeManager
}
func (v *fileVolume) Close() error { return v.f.Close() }
func (v *fileVolume) open(volnum int) error {
err := v.Close()
if err != nil {
return err
}
f, err := v.vm.openVolumeFile(volnum)
if err != nil {
return err
}
err = v.readerVolume.init(f, volnum)
if err != nil {
f.Close()
return err
}
v.f = f
return nil
}
func (v *fileVolume) openBlock(volnum int, offset, size int64) error {
if v.num != volnum {
err := v.open(volnum)
if err != nil {
return err
}
}
return v.readerVolume.openBlock(volnum, offset, size)
}
func (v *fileVolume) openNext() error { return v.open(v.num + 1) }
func (v *fileVolume) nextBlock() (*fileBlockHeader, error) {
for {
h, err := v.readerVolume.nextBlock()
if err == nil {
return h, nil
}
if err == ErrMultiVolume {
err = v.openNext()
if err != nil {
return nil, err
}
} else if err == errVolumeOrArchiveEnd {
err = v.openNext()
if err != nil {
// new volume doesnt exist, assume end of archive
if errors.Is(err, fs.ErrNotExist) {
return nil, io.EOF
}
return nil, err
}
} else {
return nil, err
}
}
}
func nextNewVolName(file string) string {
var inDigit bool
var m []int
for i, c := range file {
if c >= '0' && c <= '9' {
if !inDigit {
m = append(m, i)
inDigit = true
}
} else if inDigit {
m = append(m, i)
inDigit = false
}
}
if inDigit {
m = append(m, len(file))
}
if l := len(m); l >= 4 {
// More than 1 match so assume name.part###of###.rar style.
// Take the last 2 matches where the first is the volume number.
m = m[l-4 : l]
if strings.Contains(file[m[1]:m[2]], ".") || !strings.Contains(file[:m[0]], ".") {
// Didn't match above style as volume had '.' between the two numbers or didnt have a '.'
// before the first match. Use the second number as volume number.
m = m[2:]
}
}
// extract and increment volume number
lo, hi := m[0], m[1]
n, err := strconv.Atoi(file[lo:hi])
if err != nil {
n = 0
} else {
n++
}
// volume number must use at least the same number of characters as previous volume
vol := fmt.Sprintf("%0"+fmt.Sprint(hi-lo)+"d", n)
return file[:lo] + vol + file[hi:]
}
func nextOldVolName(file string) string {
// old style volume naming
i := strings.LastIndex(file, ".")
// get file extension
b := []byte(file[i+1:])
// If 2nd and 3rd character of file extension is not a digit replace
// with "00" and ignore any trailing characters.
if len(b) < 3 || b[1] < '0' || b[1] > '9' || b[2] < '0' || b[2] > '9' {
return file[:i+2] + "00"
}
// start incrementing volume number digits from rightmost
for j := 2; j >= 0; j-- {
if b[j] != '9' {
b[j]++
break
}
// digit overflow
if j == 0 {
// last character before '.'
b[j] = 'A'
} else {
// set to '0' and loop to next character
b[j] = '0'
}
}
return file[:i+1] + string(b)
}
func hasDigits(s string) bool {
for _, c := range s {
if c >= '0' && c <= '9' {
return true
}
}
return false
}
func fixFileExtension(file string) string {
// check file extensions
i := strings.LastIndex(file, ".")
if i < 0 {
// no file extension, add one
return file + ".rar"
}
ext := strings.ToLower(file[i+1:])
// replace with .rar for empty extensions & self extracting archives
if ext == "" || ext == "exe" || ext == "sfx" {
file = file[:i+1] + "rar"
}
return file
}
type volumeManager struct {
dir string // current volume directory path
opt *options
mu sync.Mutex
files []string // file names for each volume
old bool // uses old naming scheme
}
func (vm *volumeManager) Files() []string {
vm.mu.Lock()
defer vm.mu.Unlock()
return vm.files
}
func (vm *volumeManager) tryNewName(file string) (fs.File, error) {
// try using new naming scheme
name := nextNewVolName(file)
f, err := vm.opt.fs.Open(vm.dir + name)
if !errors.Is(err, fs.ErrNotExist) {
vm.files = append(vm.files, name)
return f, err
}
// file didn't exist, try old naming scheme
name = nextOldVolName(file)
f, oldErr := vm.opt.fs.Open(vm.dir + name)
if !errors.Is(oldErr, fs.ErrNotExist) {
vm.old = true
vm.files = append(vm.files, name)
return f, oldErr
}
return nil, err
}
// next opens the next volume file in the archive.
func (vm *volumeManager) openVolumeFile(volnum int) (fs.File, error) {
vm.mu.Lock()
defer vm.mu.Unlock()
var file string
// check for cached volume name
if volnum < len(vm.files) {
return vm.opt.fs.Open(vm.dir + vm.files[volnum])
}
file = vm.files[len(vm.files)-1]
if len(vm.files) == 1 {
file = fixFileExtension(file)
if !vm.old && hasDigits(file) {
return vm.tryNewName(file)
}
vm.old = true
}
for len(vm.files) <= volnum {
if vm.old {
file = nextOldVolName(file)
} else {
file = nextNewVolName(file)
}
vm.files = append(vm.files, file)
}
return vm.opt.fs.Open(vm.dir + file)
}
func (vm *volumeManager) newVolume(volnum int) (*fileVolume, error) {
f, err := vm.openVolumeFile(volnum)
if err != nil {
return nil, err
}
v, err := newVolume(f, vm.opt, volnum)
if err != nil {
f.Close()
return nil, err
}
mv := &fileVolume{
readerVolume: v,
f: f,
vm: vm,
}
return mv, nil
}
func (vm *volumeManager) openBlockOffset(h *fileBlockHeader, offset int64) (*fileVolume, error) {
v, err := vm.newVolume(h.volnum)
if err != nil {
return nil, err
}
if h.dataOff < v.br.off {
v.Close()
return nil, ErrInvalidHeaderOff
}
err = v.br.Discard(h.dataOff - v.br.off + offset)
v.n = h.PackedSize - offset
if err != nil {
v.Close()
return nil, err
}
return v, nil
}
func (vm *volumeManager) openArchiveFile(blocks *fileBlockList) (fs.File, error) {
h := blocks.firstBlock()
if h.Solid {
return nil, ErrSolidOpen
}
v, err := vm.openBlockOffset(h, 0)
if err != nil {
return nil, err
}
pr := newPackedFileReader(v, vm.opt)
f, err := pr.newArchiveFile(blocks)
if err != nil {
v.Close()
return nil, err
}
if sr, ok := f.(archiveFileSeeker); ok {
return &fileSeekCloser{archiveFileSeeker: sr, Closer: v}, nil
}
return &fileCloser{archiveFile: f, Closer: v}, nil
}
func openVolume(filename string, opts *options) (*fileVolume, error) {
dir, file := filepath.Split(filename)
vm := &volumeManager{
dir: dir,
files: []string{file},
opt: opts,
}
v, err := vm.newVolume(0)
if err != nil {
return nil, err
}
vm.old = v.arc.useOldNaming()
return v, nil
}
|