muhammara 3.1.1 → 3.3.0

package/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.3.0] - 2022-11-05
+
+### Fixed
+
+- Typescript definition of member buffer of PDFWStreamForBuffer fixed
+
+### Changed
+
+- Updated github actions to get rid of some deprecation warnings in gha ci
+- Pin python 3 version for builds
+
+### Added
+
+- Electron 21.0.0, 21.1.0 and 21.2.0
+
+## [3.2.0] - 2022-10-26
+
+### Added
+
+- Add electron 20.3.3
+- Ignore extra data above the header and below the footer in PDF Parser
+- Add node 19.0.0
+
 ## [3.1.1] - 2022-10-23
 
 ### Fixed
@@ -21,6 +44,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+- Electron 21.0
 - Node 18
 - Electron 20.0, 20.1, 20.2
 - Prettier as dev dependency and basics
@@ -48,6 +72,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Node < 11 and Electron < 11 removed
 - Renamed typo exported value from eTokenSeprator to eTokenSeparator
 
+## [2.6.1] - 2022-10-23
+
+### Fixed
+
+- Backport: NPE in parser when file ends before it really starts
+
 ## [2.6.0] - 2022-06-30
 
 ### Changed
@@ -280,10 +310,13 @@ with the following changes.
 
 - Initial release
 
-[unreleased]: https://github.com/julianhille/MuhammaraJS/compare/3.1.1...HEAD
+[unreleased]: https://github.com/julianhille/MuhammaraJS/compare/3.3.0...HEAD
+[3.3.0]: https://github.com/julianhille/MuhammaraJS/compare/3.2.0...3.3.0
+[3.2.0]: https://github.com/julianhille/MuhammaraJS/compare/3.1.1...3.2.0
 [3.1.1]: https://github.com/julianhille/MuhammaraJS/compare/3.1.0...3.1.1
 [3.1.0]: https://github.com/julianhille/MuhammaraJS/compare/3.0.0...3.1.0
-[3.0.0]: https://github.com/julianhille/MuhammaraJS/compare/2.6.0...3.0.0
+[3.0.0]: https://github.com/julianhille/MuhammaraJS/compare/2.6.1...3.0.0
+[2.6.1]: https://github.com/julianhille/MuhammaraJS/compare/2.6.0...2.6.1
 [2.6.0]: https://github.com/julianhille/MuhammaraJS/compare/2.5.0...2.6.0
 [2.5.0]: https://github.com/julianhille/MuhammaraJS/compare/2.4.0...2.5.0
 [2.4.0]: https://github.com/julianhille/MuhammaraJS/compare/2.3.0...2.4.0

package/PDFRStreamForBuffer.js

@@ -8,6 +8,7 @@ function PDFRStreamForBuffer(buffer) {
   this.innerArray = Array.prototype.slice.call(buffer, 0);
   this.rposition = 0;
   this.fileSize = this.innerArray.length;
+  this.mStartPosition = 0;
 }
 
 PDFRStreamForBuffer.prototype.read = function (inAmount) {
@@ -25,7 +26,7 @@ PDFRStreamForBuffer.prototype.notEnded = function () {
 };
 
 PDFRStreamForBuffer.prototype.setPosition = function (inPosition) {
-  this.rposition = inPosition;
+  this.rposition = this.mStartPosition + inPosition;
 };
 
 PDFRStreamForBuffer.prototype.setPositionFromEnd = function (inPosition) {
@@ -37,7 +38,11 @@ PDFRStreamForBuffer.prototype.skip = function (inAmount) {
 };
 
 PDFRStreamForBuffer.prototype.getCurrentPosition = function () {
-  return this.rposition;
+  return this.rposition - this.mStartPosition;
+};
+
+PDFRStreamForBuffer.prototype.moveStartPosition = function (inPosition) {
+  this.mStartPosition = inPosition;
 };
 
 module.exports = PDFRStreamForBuffer;

package/PDFRStreamForFile.js

@@ -8,6 +8,7 @@ function PDFRStreamForFile(inPath) {
   this.path = inPath;
   this.rposition = 0;
   this.fileSize = fs.statSync(inPath)["size"];
+  this.mStartPosition = 0;
 }
 
 PDFRStreamForFile.prototype.read = function (inAmount) {
@@ -25,7 +26,7 @@ PDFRStreamForFile.prototype.notEnded = function () {
 };
 
 PDFRStreamForFile.prototype.setPosition = function (inPosition) {
-  this.rposition = inPosition;
+  this.rposition = this.mStartPosition + inPosition;
 };
 
 PDFRStreamForFile.prototype.setPositionFromEnd = function (inPosition) {
@@ -37,7 +38,11 @@ PDFRStreamForFile.prototype.skip = function (inAmount) {
 };
 
 PDFRStreamForFile.prototype.getCurrentPosition = function () {
-  return this.rposition;
+  return this.rposition - this.mStartPosition;
+};
+
+PDFRStreamForFile.prototype.moveStartPosition = function (inPosition) {
+  this.mStartPosition = inPosition;
 };
 
 function noop() {}

package/binding.gyp

@@ -14,13 +14,13 @@
                 './src/deps/PDFWriter',
                 './src/deps/FreeType/include'
             ],
-            'msvs-settings':
+            'msvs_settings':
 			{
 				'VCCLCompilerTool':
 				{
 					'AdditionalOptions':
 						[
-						'-std:c++17',
+						'/std:c++17',
 						]
 				}
 			},

package/muhammara.d.ts

@@ -278,7 +278,7 @@ declare module "muhammara" {
 
   export interface PDFWStreamForBuffer extends WriteStream {
     new (): PDFWStreamForBuffer;
-    buffer: Promise<any>;
+    buffer: Buffer;
   }
 
   export interface PDFReaderOptions {

package/node_modules/tar/README.md

@@ -1,6 +1,6 @@
 # node-tar
 
-[Fast](./benchmarks) and full-featured Tar for Node.js
+Fast and full-featured Tar for Node.js
 
 The API is designed to mimic the behavior of `tar(1)` on unix systems.
 If you are familiar with how tar works, most of this will hopefully be
@@ -209,6 +209,19 @@ tar.t({
 })
 ```
 
+For example, to just get the list of filenames from an archive:
+
+```js
+const getEntryFilenames = async tarballFilename => {
+  const filenames = []
+  await tar.t({
+    file: tarballFilename,
+    onentry: entry => filenames.push(entry.path),
+  })
+  return filenames
+}
+```
+
 To replicate `cat my-tarball.tgz | tar t` do:
 
 ```js
@@ -223,6 +236,18 @@ When the function returns, it's already done.  Sync methods without a
 file argument return a sync stream, which flushes immediately.  But,
 of course, it still won't be done until you `.end()` it.
 
+```js
+const getEntryFilenamesSync = tarballFilename => {
+  const filenames = []
+  tar.t({
+    file: tarballFilename,
+    onentry: entry => filenames.push(entry.path),
+    sync: true,
+  })
+  return filenames
+}
+```
+
 To filter entries, add `filter: <function>` to the options.
 Tar-creating methods call the filter with `filter(path, stat)`.
 Tar-reading methods (including extraction) call the filter with
@@ -429,15 +454,18 @@ no paths are provided, then all the entries are listed.
 
 If the archive is gzipped, then tar will detect this and unzip it.
 
-Returns an event emitter that emits `entry` events with
-`tar.ReadEntry` objects.  However, they don't emit `'data'` or `'end'`
-events.  (If you want to get actual readable entries, use the
-`tar.Parse` class instead.)
+If the `file` option is _not_ provided, then returns an event emitter that
+emits `entry` events with `tar.ReadEntry` objects.  However, they don't
+emit `'data'` or `'end'` events.  (If you want to get actual readable
+entries, use the `tar.Parse` class instead.)
+
+If a `file` option _is_ provided, then the return value will be a promise
+that resolves when the file has been fully traversed in async mode, or
+`undefined` if `sync: true` is set.  Thus, you _must_ specify an `onentry`
+method in order to do anything useful with the data it parses.
 
 The following options are supported:
 
-- `cwd` Extract files relative to the specified directory.  Defaults
-  to `process.cwd()`. [Alias: `C`]
 - `file` The archive file to list.  If not specified, then a
   Writable stream is returned where the archive data should be
   written. [Alias: `f`]
@@ -449,8 +477,8 @@ The following options are supported:
   entry being listed.  Return `true` to emit the entry from the
   archive, or `false` to skip it.
 - `onentry` A function that gets called with `(entry)` for each entry
-  that passes the filter.  This is important for when both `file` and
-  `sync` are set, because it will be called synchronously.
+  that passes the filter.  This is important for when `file` is set,
+  because there is no other way to do anything useful with this method.
 - `maxReadSize` The maximum buffer size for `fs.read()` operations.
   Defaults to 16 MB.
 - `noResume` By default, `entry` streams are resumed immediately after

package/node_modules/tar/lib/create.js

@@ -9,24 +9,29 @@ const t = require('./list.js')
 const path = require('path')
 
 module.exports = (opt_, files, cb) => {
-  if (typeof files === 'function')
+  if (typeof files === 'function') {
     cb = files
+  }
 
-  if (Array.isArray(opt_))
+  if (Array.isArray(opt_)) {
     files = opt_, opt_ = {}
+  }
 
-  if (!files || !Array.isArray(files) || !files.length)
+  if (!files || !Array.isArray(files) || !files.length) {
     throw new TypeError('no files or directories specified')
+  }
 
   files = Array.from(files)
 
   const opt = hlo(opt_)
 
-  if (opt.sync && typeof cb === 'function')
+  if (opt.sync && typeof cb === 'function') {
     throw new TypeError('callback not supported for sync tar functions')
+  }
 
-  if (!opt.file && typeof cb === 'function')
+  if (!opt.file && typeof cb === 'function') {
     throw new TypeError('callback only supported with file option')
+  }
 
   return opt.file && opt.sync ? createFileSync(opt, files)
     : opt.file ? createFile(opt, files, cb)
@@ -65,13 +70,14 @@ const addFilesSync = (p, files) => {
   files.forEach(file => {
     if (file.charAt(0) === '@') {
       t({
-        file: path.resolve(p.cwd, file.substr(1)),
+        file: path.resolve(p.cwd, file.slice(1)),
         sync: true,
         noResume: true,
         onentry: entry => p.add(entry),
       })
-    } else
+    } else {
       p.add(file)
+    }
   })
   p.end()
 }
@@ -81,12 +87,13 @@ const addFilesAsync = (p, files) => {
     const file = files.shift()
     if (file.charAt(0) === '@') {
       return t({
-        file: path.resolve(p.cwd, file.substr(1)),
+        file: path.resolve(p.cwd, file.slice(1)),
         noResume: true,
         onentry: entry => p.add(entry),
       }).then(_ => addFilesAsync(p, files))
-    } else
+    } else {
       p.add(file)
+    }
   }
   p.end()
 }

package/node_modules/tar/lib/extract.js

@@ -9,29 +9,35 @@ const path = require('path')
 const stripSlash = require('./strip-trailing-slashes.js')
 
 module.exports = (opt_, files, cb) => {
-  if (typeof opt_ === 'function')
+  if (typeof opt_ === 'function') {
     cb = opt_, files = null, opt_ = {}
-  else if (Array.isArray(opt_))
+  } else if (Array.isArray(opt_)) {
     files = opt_, opt_ = {}
+  }
 
-  if (typeof files === 'function')
+  if (typeof files === 'function') {
     cb = files, files = null
+  }
 
-  if (!files)
+  if (!files) {
     files = []
-  else
+  } else {
     files = Array.from(files)
+  }
 
   const opt = hlo(opt_)
 
-  if (opt.sync && typeof cb === 'function')
+  if (opt.sync && typeof cb === 'function') {
     throw new TypeError('callback not supported for sync tar functions')
+  }
 
-  if (!opt.file && typeof cb === 'function')
+  if (!opt.file && typeof cb === 'function') {
     throw new TypeError('callback only supported with file option')
+  }
 
-  if (files.length)
+  if (files.length) {
     filesFilter(opt, files)
+  }
 
   return opt.file && opt.sync ? extractFileSync(opt)
     : opt.file ? extractFile(opt, cb)
@@ -87,9 +93,9 @@ const extractFile = (opt, cb) => {
     // This trades a zero-byte read() syscall for a stat
     // However, it will usually result in less memory allocation
     fs.stat(file, (er, stat) => {
-      if (er)
+      if (er) {
         reject(er)
-      else {
+      } else {
         const stream = new fsm.ReadStream(file, {
           readSize: readSize,
           size: stat.size,

package/node_modules/tar/lib/header.js

@@ -34,18 +34,21 @@ class Header {
     this.atime = null
     this.ctime = null
 
-    if (Buffer.isBuffer(data))
+    if (Buffer.isBuffer(data)) {
       this.decode(data, off || 0, ex, gex)
-    else if (data)
+    } else if (data) {
       this.set(data)
+    }
   }
 
   decode (buf, off, ex, gex) {
-    if (!off)
+    if (!off) {
       off = 0
+    }
 
-    if (!buf || !(buf.length >= off + 512))
+    if (!buf || !(buf.length >= off + 512)) {
       throw new Error('need 512 bytes for header')
+    }
 
     this.path = decString(buf, off, 100)
     this.mode = decNumber(buf, off + 100, 8)
@@ -62,18 +65,21 @@ class Header {
 
     // old tar versions marked dirs as a file with a trailing /
     this[TYPE] = decString(buf, off + 156, 1)
-    if (this[TYPE] === '')
+    if (this[TYPE] === '') {
       this[TYPE] = '0'
-    if (this[TYPE] === '0' && this.path.substr(-1) === '/')
+    }
+    if (this[TYPE] === '0' && this.path.slice(-1) === '/') {
       this[TYPE] = '5'
+    }
 
     // tar implementations sometimes incorrectly put the stat(dir).size
     // as the size in the tarball, even though Directory entries are
     // not able to have any body at all.  In the very rare chance that
     // it actually DOES have a body, we weren't going to do anything with
     // it anyway, and it'll just be a warning about an invalid header.
-    if (this[TYPE] === '5')
+    if (this[TYPE] === '5') {
       this.size = 0
+    }
 
     this.linkpath = decString(buf, off + 157, 100)
     if (buf.slice(off + 257, off + 265).toString() === 'ustar\u000000') {
@@ -87,23 +93,27 @@ class Header {
         this.path = prefix + '/' + this.path
       } else {
         const prefix = decString(buf, off + 345, 130)
-        if (prefix)
+        if (prefix) {
           this.path = prefix + '/' + this.path
+        }
         this.atime = decDate(buf, off + 476, 12)
         this.ctime = decDate(buf, off + 488, 12)
       }
     }
 
     let sum = 8 * 0x20
-    for (let i = off; i < off + 148; i++)
+    for (let i = off; i < off + 148; i++) {
       sum += buf[i]
+    }
 
-    for (let i = off + 156; i < off + 512; i++)
+    for (let i = off + 156; i < off + 512; i++) {
       sum += buf[i]
+    }
 
     this.cksumValid = sum === this.cksum
-    if (this.cksum === null && sum === 8 * 0x20)
+    if (this.cksum === null && sum === 8 * 0x20) {
       this.nullBlock = true
+    }
   }
 
   [SLURP] (ex, global) {
@@ -111,8 +121,9 @@ class Header {
       // we slurp in everything except for the path attribute in
       // a global extended header, because that's weird.
       if (ex[k] !== null && ex[k] !== undefined &&
-          !(global && k === 'path'))
+          !(global && k === 'path')) {
         this[k] = ex[k]
+      }
     }
   }
 
@@ -122,11 +133,13 @@ class Header {
       off = 0
     }
 
-    if (!off)
+    if (!off) {
       off = 0
+    }
 
-    if (!(buf.length >= off + 512))
+    if (!(buf.length >= off + 512)) {
       throw new Error('need 512 bytes for header')
+    }
 
     const prefixSize = this.ctime || this.atime ? 130 : 155
     const split = splitPrefix(this.path || '', prefixSize)
@@ -148,20 +161,22 @@ class Header {
     this.needPax = encNumber(buf, off + 329, 8, this.devmaj) || this.needPax
     this.needPax = encNumber(buf, off + 337, 8, this.devmin) || this.needPax
     this.needPax = encString(buf, off + 345, prefixSize, prefix) || this.needPax
-    if (buf[off + 475] !== 0)
+    if (buf[off + 475] !== 0) {
       this.needPax = encString(buf, off + 345, 155, prefix) || this.needPax
-    else {
+    } else {
       this.needPax = encString(buf, off + 345, 130, prefix) || this.needPax
       this.needPax = encDate(buf, off + 476, 12, this.atime) || this.needPax
       this.needPax = encDate(buf, off + 488, 12, this.ctime) || this.needPax
     }
 
     let sum = 8 * 0x20
-    for (let i = off; i < off + 148; i++)
+    for (let i = off; i < off + 148; i++) {
       sum += buf[i]
+    }
 
-    for (let i = off + 156; i < off + 512; i++)
+    for (let i = off + 156; i < off + 512; i++) {
       sum += buf[i]
+    }
 
     this.cksum = sum
     encNumber(buf, off + 148, 8, this.cksum)
@@ -172,8 +187,9 @@ class Header {
 
   set (data) {
     for (const i in data) {
-      if (data[i] !== null && data[i] !== undefined)
+      if (data[i] !== null && data[i] !== undefined) {
         this[i] = data[i]
+      }
     }
   }
 
@@ -186,10 +202,11 @@ class Header {
   }
 
   set type (type) {
-    if (types.code.has(type))
+    if (types.code.has(type)) {
       this[TYPE] = types.code.get(type)
-    else
+    } else {
       this[TYPE] = type
+    }
   }
 }
 
@@ -200,25 +217,23 @@ const splitPrefix = (p, prefixSize) => {
   let ret
   const root = pathModule.parse(p).root || '.'
 
-  if (Buffer.byteLength(pp) < pathSize)
+  if (Buffer.byteLength(pp) < pathSize) {
     ret = [pp, prefix, false]
-  else {
+  } else {
     // first set prefix to the dir, and path to the base
     prefix = pathModule.dirname(pp)
     pp = pathModule.basename(pp)
 
     do {
-      // both fit!
       if (Buffer.byteLength(pp) <= pathSize &&
-          Buffer.byteLength(prefix) <= prefixSize)
+          Buffer.byteLength(prefix) <= prefixSize) {
+        // both fit!
         ret = [pp, prefix, false]
-
-      // prefix fits in prefix, but path doesn't fit in path
-      else if (Buffer.byteLength(pp) > pathSize &&
-          Buffer.byteLength(prefix) <= prefixSize)
-        ret = [pp.substr(0, pathSize - 1), prefix, true]
-
-      else {
+      } else if (Buffer.byteLength(pp) > pathSize &&
+          Buffer.byteLength(prefix) <= prefixSize) {
+        // prefix fits in prefix, but path doesn't fit in path
+        ret = [pp.slice(0, pathSize - 1), prefix, true]
+      } else {
         // make path take a bit from prefix
         pp = pathModule.join(pathModule.basename(prefix), pp)
         prefix = pathModule.dirname(prefix)
@@ -226,8 +241,9 @@ const splitPrefix = (p, prefixSize) => {
     } while (prefix !== root && !ret)
 
     // at this point, found no resolution, just truncate
-    if (!ret)
-      ret = [p.substr(0, pathSize - 1), '', true]
+    if (!ret) {
+      ret = [p.slice(0, pathSize - 1), '', true]
+    }
   }
   return ret
 }

package/node_modules/tar/lib/large-numbers.js

@@ -3,14 +3,15 @@
 // 0xff for negative, and 0x80 for positive.
 
 const encode = (num, buf) => {
-  if (!Number.isSafeInteger(num))
-    // The number is so large that javascript cannot represent it with integer
-    // precision.
+  if (!Number.isSafeInteger(num)) {
+  // The number is so large that javascript cannot represent it with integer
+  // precision.
     throw Error('cannot encode number outside of javascript safe integer range')
-  else if (num < 0)
+  } else if (num < 0) {
     encodeNegative(num, buf)
-  else
+  } else {
     encodePositive(num, buf)
+  }
   return buf
 }
 
@@ -30,11 +31,11 @@ const encodeNegative = (num, buf) => {
   for (var i = buf.length; i > 1; i--) {
     var byte = num & 0xff
     num = Math.floor(num / 0x100)
-    if (flipped)
+    if (flipped) {
       buf[i - 1] = onesComp(byte)
-    else if (byte === 0)
+    } else if (byte === 0) {
       buf[i - 1] = 0
-    else {
+    } else {
       flipped = true
       buf[i - 1] = twosComp(byte)
     }
@@ -46,13 +47,15 @@ const parse = (buf) => {
   const value = pre === 0x80 ? pos(buf.slice(1, buf.length))
     : pre === 0xff ? twos(buf)
     : null
-  if (value === null)
+  if (value === null) {
     throw Error('invalid base256 encoding')
+  }
 
-  if (!Number.isSafeInteger(value))
-    // The number is so large that javascript cannot represent it with integer
-    // precision.
+  if (!Number.isSafeInteger(value)) {
+  // The number is so large that javascript cannot represent it with integer
+  // precision.
     throw Error('parsed number outside of javascript safe integer range')
+  }
 
   return value
 }
@@ -64,16 +67,17 @@ const twos = (buf) => {
   for (var i = len - 1; i > -1; i--) {
     var byte = buf[i]
     var f
-    if (flipped)
+    if (flipped) {
       f = onesComp(byte)
-    else if (byte === 0)
+    } else if (byte === 0) {
       f = byte
-    else {
+    } else {
       flipped = true
       f = twosComp(byte)
     }
-    if (f !== 0)
+    if (f !== 0) {
       sum -= f * Math.pow(256, len - i - 1)
+    }
   }
   return sum
 }
@@ -83,8 +87,9 @@ const pos = (buf) => {
   var sum = 0
   for (var i = len - 1; i > -1; i--) {
     var byte = buf[i]
-    if (byte !== 0)
+    if (byte !== 0) {
       sum += byte * Math.pow(256, len - i - 1)
+    }
   }
   return sum
 }