pst-extractor 1.6.0 → 1.9.0

package/dist/PSTUtil.class.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import * as long from 'long';
+import Long from 'long';
 import { DescriptorIndexNode } from './DescriptorIndexNode.class';
 import { PSTDescriptorItem } from './PSTDescriptorItem.class';
 import { PSTFile } from './PSTFile.class';
@@ -43,7 +43,7 @@ export declare class PSTUtil {
      * @returns {long}
      * @memberof PSTUtil
      */
-    static convertLittleEndianBytesToLong(data: Buffer, start?: number, end?: number): long;
+    static convertLittleEndianBytesToLong(data: Buffer, start?: number, end?: number): Long;
     /**
      * Convert big endian bytes to long
      * @static
@@ -53,7 +53,7 @@ export declare class PSTUtil {
      * @returns {long}
      * @memberof PSTUtil
      */
-    static convertBigEndianBytesToLong(data: Buffer, start?: number, end?: number): long;
+    static convertBigEndianBytesToLong(data: Buffer, start?: number, end?: number): Long;
     /**
      * Handle strings using codepages.
      * @static
@@ -106,7 +106,7 @@ export declare class PSTUtil {
      * @returns {*}
      * @memberof PSTUtil
      */
-    static detectAndLoadPSTObject(theFile: PSTFile, descriptorIndex: long): any;
+    static detectAndLoadPSTObject(theFile: PSTFile, descriptorIndex: Long): any;
     static detectAndLoadPSTObject(theFile: PSTFile, folderIndexNode: DescriptorIndexNode): any;
     /**
      * Creates object based on message class
@@ -131,5 +131,5 @@ export declare class PSTUtil {
      * @returns {Date}
      * @memberof PSTUtil
      */
-    static filetimeToDate(hi: long, low: long): Date;
+    static filetimeToDate(hi: Long, low: Long): Date;
 }

package/dist/PSTUtil.class.js

@@ -1,6 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const long = require("long");
+exports.PSTUtil = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const long_1 = __importDefault(require("long"));
 const PSTAppointment_class_1 = require("./PSTAppointment.class");
 const PSTContact_class_1 = require("./PSTContact.class");
 const PSTFolder_class_1 = require("./PSTFolder.class");
@@ -9,6 +14,7 @@ const PSTNodeInputStream_class_1 = require("./PSTNodeInputStream.class");
 const PSTTableBC_class_1 = require("./PSTTableBC.class");
 const PSTTask_class_1 = require("./PSTTask.class");
 const PSTActivity_class_1 = require("./PSTActivity.class");
+const iconv_lite_1 = __importDefault(require("iconv-lite"));
 /**
  * Utility functions for PST components
  * @export
@@ -31,11 +37,11 @@ class PSTUtil {
         if (!end) {
             end = data.length;
         }
-        let offset = long.fromNumber(data[end - 1] & 0xff);
+        let offset = long_1.default.fromNumber(data[end - 1] & 0xff);
         let tmpLongValue;
         for (let x = end - 2; x >= start; x--) {
             offset = offset.shiftLeft(8);
-            tmpLongValue = long.fromNumber(data[x] & 0xff);
+            tmpLongValue = long_1.default.fromNumber(data[x] & 0xff);
             offset = offset.xor(tmpLongValue);
         }
         return offset;
@@ -56,10 +62,10 @@ class PSTUtil {
         if (!end) {
             end = data.length;
         }
-        let offset = long.ZERO;
+        let offset = long_1.default.ZERO;
         for (let x = start; x < end; ++x) {
             offset = offset.shiftLeft(8);
-            const tmpLongValue = long.fromNumber(data[x] & 0xff);
+            const tmpLongValue = long_1.default.fromNumber(data[x] & 0xff);
             offset = offset.xor(tmpLongValue);
         }
         return offset;
@@ -83,13 +89,16 @@ class PSTUtil {
      * @returns
      * @memberof PSTUtil
      */
-    static createJavascriptString(data, stringType, codepage) {
+    static createJavascriptString(data, stringType, codepage = 'utf8') {
         // TODO - codepage is not used...
         try {
             if (stringType == 0x1f) {
                 // convert and trim any nulls
                 return data.toString('utf16le').replace(/\0/g, '');
             }
+            else {
+                return iconv_lite_1.default.decode(data, codepage).toString();
+            }
         }
         catch (err) {
             console.error('PSTUtil::createJavascriptString Unable to decode string\n' + err);
@@ -286,7 +295,7 @@ class PSTUtil {
         const l = low.and(0xffffffff);
         const filetime = h.or(l);
         const msSince16010101 = filetime.divide(1000 * 10);
-        const epochDiff = long.fromValue('11644473600000');
+        const epochDiff = long_1.default.fromValue('11644473600000');
         const msSince19700101 = msSince16010101.subtract(epochDiff);
         return new Date(msSince19700101.toNumber());
     }

package/dist/RecurrencePattern.class.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+export declare enum RecurFrequency {
+    Daily = 8202,
+    Weekly = 8203,
+    Monthly = 8204,
+    Yearly = 8205
+}
+export declare enum PatternType {
+    Day = 0,
+    Week = 1,
+    Month = 2,
+    MonthEnd = 4,
+    MonthNth = 3
+}
+export declare enum EndType {
+    AfterDate = 8225,
+    AfterNOccurrences = 8226,
+    NeverEnd = 8227
+}
+export declare enum NthOccurrence {
+    First = 1,
+    Second = 2,
+    Third = 3,
+    Fourth = 4,
+    Last = 5
+}
+export declare type WeekSpecific = boolean[] & {
+    length: 7;
+};
+export declare type MonthNthSpecific = {
+    weekdays: WeekSpecific;
+    nth: NthOccurrence;
+};
+export declare class RecurrencePattern {
+    private buffer;
+    recurFrequency: RecurFrequency;
+    patternType: PatternType;
+    firstDateTime: Date;
+    period: number;
+    patternTypeSpecific: number | WeekSpecific | MonthNthSpecific | null;
+    endType: EndType;
+    occurrenceCount: number;
+    firstDOW: number;
+    startDate: Date;
+    endDate: Date;
+    constructor(buffer: Buffer);
+    toJSON(): any;
+    private readInt;
+    private readPatternTypeSpecific;
+}

package/dist/RecurrencePattern.class.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecurrencePattern = exports.NthOccurrence = exports.EndType = exports.PatternType = exports.RecurFrequency = void 0;
+const OFFSETS = {
+    RecurFrequency: 4,
+    PatternType: 6,
+    FirstDateTime: 10,
+    Period: 14,
+    PatternTypeSpecific: 22,
+    EndType: 22,
+    OccurrenceCount: 26,
+    FirstDOW: 30,
+    StartDate: -8,
+    EndDate: -4,
+};
+var RecurFrequency;
+(function (RecurFrequency) {
+    RecurFrequency[RecurFrequency["Daily"] = 8202] = "Daily";
+    RecurFrequency[RecurFrequency["Weekly"] = 8203] = "Weekly";
+    RecurFrequency[RecurFrequency["Monthly"] = 8204] = "Monthly";
+    RecurFrequency[RecurFrequency["Yearly"] = 8205] = "Yearly";
+})(RecurFrequency = exports.RecurFrequency || (exports.RecurFrequency = {}));
+var PatternType;
+(function (PatternType) {
+    PatternType[PatternType["Day"] = 0] = "Day";
+    PatternType[PatternType["Week"] = 1] = "Week";
+    PatternType[PatternType["Month"] = 2] = "Month";
+    PatternType[PatternType["MonthEnd"] = 4] = "MonthEnd";
+    PatternType[PatternType["MonthNth"] = 3] = "MonthNth";
+})(PatternType = exports.PatternType || (exports.PatternType = {}));
+var EndType;
+(function (EndType) {
+    EndType[EndType["AfterDate"] = 8225] = "AfterDate";
+    EndType[EndType["AfterNOccurrences"] = 8226] = "AfterNOccurrences";
+    EndType[EndType["NeverEnd"] = 8227] = "NeverEnd";
+})(EndType = exports.EndType || (exports.EndType = {}));
+var NthOccurrence;
+(function (NthOccurrence) {
+    NthOccurrence[NthOccurrence["First"] = 1] = "First";
+    NthOccurrence[NthOccurrence["Second"] = 2] = "Second";
+    NthOccurrence[NthOccurrence["Third"] = 3] = "Third";
+    NthOccurrence[NthOccurrence["Fourth"] = 4] = "Fourth";
+    NthOccurrence[NthOccurrence["Last"] = 5] = "Last";
+})(NthOccurrence = exports.NthOccurrence || (exports.NthOccurrence = {}));
+class RecurrencePattern {
+    constructor(buffer) {
+        this.buffer = buffer;
+        const bufferEnd = buffer.length;
+        let patternTypeOffset = 0;
+        this.recurFrequency = this.readInt(OFFSETS.RecurFrequency, 1);
+        this.patternType = this.readInt(OFFSETS.PatternType, 1);
+        this.firstDateTime = winToJsDate(this.readInt(OFFSETS.FirstDateTime, 2));
+        this.period = this.readInt(OFFSETS.Period, 2);
+        this.patternTypeSpecific = this.readPatternTypeSpecific(this.patternType);
+        switch (this.patternType) {
+            case PatternType.Week:
+            case PatternType.Month:
+            case PatternType.MonthEnd:
+                patternTypeOffset = 4;
+                break;
+            case PatternType.MonthNth:
+                patternTypeOffset = 8;
+                break;
+        }
+        this.endType = this.readInt(OFFSETS.EndType + patternTypeOffset, 2);
+        this.occurrenceCount = this.readInt(OFFSETS.OccurrenceCount + patternTypeOffset, 2);
+        this.firstDOW = this.readInt(OFFSETS.FirstDOW + patternTypeOffset, 2);
+        this.startDate = winToJsDate(this.readInt(bufferEnd + OFFSETS.StartDate, 2));
+        this.endDate = winToJsDate(this.readInt(bufferEnd + OFFSETS.EndDate, 2));
+    }
+    toJSON() {
+        return {
+            recurFrequency: RecurFrequency[this.recurFrequency],
+            patternType: PatternType[this.patternType],
+            firstDateTime: this.firstDateTime,
+            period: this.period,
+            patternTypeSpecific: this.patternTypeSpecific,
+            endType: EndType[this.endType],
+            occurrenceCount: this.occurrenceCount,
+            firstDOW: this.firstDOW,
+            startDate: this.startDate,
+            endDate: this.endDate,
+        };
+    }
+    readInt(offset, size) {
+        switch (size) {
+            case 1:
+                return this.buffer.readInt16LE(offset);
+            case 2:
+                return this.buffer.readInt32LE(offset);
+        }
+    }
+    readPatternTypeSpecific(type) {
+        switch (type) {
+            case PatternType.Day:
+                return null;
+            case PatternType.Week:
+                return readWeekByte(this.buffer.readInt8(OFFSETS.PatternTypeSpecific));
+            case PatternType.Month:
+            case PatternType.MonthEnd:
+                return this.readInt(OFFSETS.PatternTypeSpecific, 2);
+            case PatternType.MonthNth:
+                return {
+                    weekdays: readWeekByte(this.buffer.readInt8(OFFSETS.PatternTypeSpecific)),
+                    nth: this.readInt(OFFSETS.PatternTypeSpecific + 4, 2),
+                };
+        }
+    }
+}
+exports.RecurrencePattern = RecurrencePattern;
+function winToJsDate(dateInt) {
+    return new Date(dateInt * 60 * 1000 - 1.16444736e13); // subtract milliseconds between 1601-01-01 and 1970-01-01
+}
+function readWeekByte(byte) {
+    const weekArr = [];
+    for (let i = 0; i < 7; ++i) {
+        weekArr.push(Boolean(byte & (1 << i)));
+    }
+    return weekArr;
+}

package/dist/index.js

@@ -1,14 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PSTFolder = exports.PSTMessage = exports.PSTAttachment = exports.PSTRecipient = exports.PSTTask = exports.PSTFile = void 0;
 var PSTFile_class_1 = require("./PSTFile.class");
-exports.PSTFile = PSTFile_class_1.PSTFile;
+Object.defineProperty(exports, "PSTFile", { enumerable: true, get: function () { return PSTFile_class_1.PSTFile; } });
 var PSTTask_class_1 = require("./PSTTask.class");
-exports.PSTTask = PSTTask_class_1.PSTTask;
+Object.defineProperty(exports, "PSTTask", { enumerable: true, get: function () { return PSTTask_class_1.PSTTask; } });
 var PSTRecipient_class_1 = require("./PSTRecipient.class");
-exports.PSTRecipient = PSTRecipient_class_1.PSTRecipient;
+Object.defineProperty(exports, "PSTRecipient", { enumerable: true, get: function () { return PSTRecipient_class_1.PSTRecipient; } });
 var PSTAttachment_class_1 = require("./PSTAttachment.class");
-exports.PSTAttachment = PSTAttachment_class_1.PSTAttachment;
+Object.defineProperty(exports, "PSTAttachment", { enumerable: true, get: function () { return PSTAttachment_class_1.PSTAttachment; } });
 var PSTMessage_class_1 = require("./PSTMessage.class");
-exports.PSTMessage = PSTMessage_class_1.PSTMessage;
+Object.defineProperty(exports, "PSTMessage", { enumerable: true, get: function () { return PSTMessage_class_1.PSTMessage; } });
 var PSTFolder_class_1 = require("./PSTFolder.class");
-exports.PSTFolder = PSTFolder_class_1.PSTFolder;
+Object.defineProperty(exports, "PSTFolder", { enumerable: true, get: function () { return PSTFolder_class_1.PSTFolder; } });

package/example/package.json

@@ -1,22 +1,22 @@
 {
   "name": "pst-extractor-example",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "private": true,
   "dependencies": {
     "pst-extractor": "link:.."
   },
   "devDependencies": {
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-prettier": "^3.1.3",
-    "prettier": "^2.0.5",
-    "ts-node": "^8.9.0",
-    "typescript": "^3.8.3"
+    "@types/node": "^17.0.23",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "prettier": "^2.6.2",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3"
   },
   "scripts": {
     "start": "ts-node test-min.ts",
     "test-min": "ts-node test-min.ts",
-    "test-mem": "ts-node test-mem.ts",
-    "test-max": "ts-node test-max.ts"
+    "test": "ts-node test.ts"
   },
   "eslintConfig": {
     "extends": [

package/example/test-min.ts

@@ -1,11 +1,21 @@
+import * as fs from 'fs'
 import { PSTMessage } from '../src/PSTMessage.class'
 import { PSTFile } from '../src/PSTFile.class'
 import { PSTFolder } from '../src/PSTFolder.class'
 const resolve = require('path').resolve
 
+const pstFolder = './testdata/'
+const topOutputFolder = './testdataoutput/'
 let depth = -1
 let col = 0
 
+// console log highlight with https://en.wikipedia.org/wiki/ANSI_escape_code
+const ANSI_RED = 31
+const ANSI_YELLOW = 93
+const ANSI_GREEN = 32
+const ANSI_BLUE = 34
+const highlight = (str: string, code: number = ANSI_RED) => '\u001b[' + code + 'm' + str + '\u001b[0m'
+
 /**
  * Returns a string with visual indication of depth in tree.
  * @param {number} depth
@@ -51,10 +61,10 @@ function processFolder(folder: PSTFolder): void {
     while (email != null) {
       console.log(
         getDepth(depth) +
-          'Sender: ' +
-          email.senderName +
-          ', Subject: ' +
-          email.subject
+        'Sender: ' +
+        email.senderName +
+        ', Subject: ' +
+        email.subject
       )
       email = folder.getNextChild()
     }
@@ -63,6 +73,21 @@ function processFolder(folder: PSTFolder): void {
   depth--
 }
 
-const pstFile = new PSTFile(resolve('./testdata/enron.pst'))
-console.log(pstFile.getMessageStore().displayName)
-processFolder(pstFile.getRootFolder())
+const directoryListing = fs.readdirSync(pstFolder)
+directoryListing.forEach((filename) => {
+  if (filename.endsWith('.pst') || filename.endsWith('.ost')) {
+    console.log(highlight(pstFolder + filename, ANSI_GREEN))
+
+    // time for performance comparison to Java and improvement
+    const start = Date.now()
+
+    // load file into memory buffer, then open as PSTFile
+    const pstFile = new PSTFile(fs.readFileSync(pstFolder + filename))
+
+    console.log(pstFile.getMessageStore().displayName)
+    processFolder(pstFile.getRootFolder())
+
+    const end = Date.now()
+    console.log(highlight(pstFolder + filename + ' processed in ' + (end - start) + ' ms', ANSI_GREEN))
+  }
+})

package/example/{test-mem.ts → test.ts}

@@ -4,18 +4,26 @@ import { PSTFile } from '../src/PSTFile.class'
 import { PSTFolder } from '../src/PSTFolder.class'
 import { PSTMessage } from '../src/PSTMessage.class'
 
-const pstFolder = '/media/sf_Outlook/test/'
-const topOutputFolder = '/media/sf_Outlook/pst-extractor/'
-let outputFolder = ''
-const saveToFS = false
-const displaySender = true
-const displayBody = false
+const pstFolder = './testdata/'
+const saveToFS = true
+const topOutputFolder = './testdataoutput/'
+
 const verbose = true
+const displaySender = true
+const displayBody = true
+let outputFolder = ''
 let depth = -1
 let col = 0
 
+// console log highlight with https://en.wikipedia.org/wiki/ANSI_escape_code
+const ANSI_RED = 31
+const ANSI_YELLOW = 93
+const ANSI_GREEN = 32
+const ANSI_BLUE = 34
+const highlight = (str: string, code: number = ANSI_RED) => '\u001b[' + code + 'm' + str + '\u001b[0m'
+
 /**
- * Returns a string with visual indicattion of depth in tree.
+ * Returns a string with visual indication of depth in tree.
  * @param {number} depth
  * @returns {string}
  */
@@ -49,7 +57,7 @@ function doSaveToFS(
     // save the msg as a txt file
     const filename = emailFolder + msg.descriptorNodeId + '.txt'
     if (verbose) {
-      console.log('saving msg to ' + filename)
+      console.log(highlight('saving msg to ' + filename))
     }
     const fd = fs.openSync(filename, 'w')
     fs.writeSync(fd, msg.clientSubmitTime + '\r\n')
@@ -71,7 +79,7 @@ function doSaveToFS(
       const filename =
         emailFolder + msg.descriptorNodeId + '-' + attachment.longFilename
       if (verbose) {
-        console.log('saving attachment to ' + filename)
+        console.log(highlight('saving attachment to ' + filename, ANSI_BLUE))
       }
       try {
         const fd = fs.openSync(filename, 'w')
@@ -158,10 +166,10 @@ function processFolder(folder: PSTFolder): void {
       if (verbose) {
         console.log(
           getDepth(depth) +
-            'Email: ' +
-            email.descriptorNodeId +
-            ' - ' +
-            email.subject
+          'Email: ' +
+          email.descriptorNodeId +
+          ' - ' +
+          email.subject
         )
       } else {
         printDot()
@@ -175,8 +183,9 @@ function processFolder(folder: PSTFolder): void {
 
       // display body?
       if (verbose && displayBody) {
-        console.log(email.body)
-        console.log(email.bodyRTF)
+        console.log(highlight('email.body', ANSI_YELLOW), email.body)
+        console.log(highlight('email.bodyRTF', ANSI_YELLOW), email.bodyRTF)
+        console.log(highlight('email.bodyHTML', ANSI_YELLOW), email.bodyHTML)
       }
 
       // save content to fs?
@@ -223,27 +232,29 @@ try {
 
 const directoryListing = fs.readdirSync(pstFolder)
 directoryListing.forEach((filename) => {
-  console.log(pstFolder + filename)
+  if (filename.endsWith('.pst') || filename.endsWith('.ost')) {
+    console.log(highlight(pstFolder + filename, ANSI_GREEN))
 
-  // time for performance comparison to Java and improvement
-  const start = Date.now()
+    // time for performance comparison to Java and improvement
+    const start = Date.now()
 
-  // load file into memory buffer, then open as PSTFile
-  const pstFile = new PSTFile(fs.readFileSync(pstFolder + filename))
+    // load file into memory buffer, then open as PSTFile
+    const pstFile = new PSTFile(fs.readFileSync(pstFolder + filename))
 
-  // make a sub folder for each PST
-  try {
-    if (saveToFS) {
-      outputFolder = topOutputFolder + filename + '/'
-      fs.mkdirSync(outputFolder)
+    // make a sub folder for each PST
+    try {
+      if (saveToFS) {
+        outputFolder = topOutputFolder + filename + '/'
+        fs.mkdirSync(outputFolder)
+      }
+    } catch (err) {
+      console.error(err)
     }
-  } catch (err) {
-    console.error(err)
-  }
 
-  console.log(pstFile.getMessageStore().displayName)
-  processFolder(pstFile.getRootFolder())
+    console.log(pstFile.getMessageStore().displayName)
+    processFolder(pstFile.getRootFolder())
 
-  const end = Date.now()
-  console.log('processed in ' + (end - start) + ' ms')
+    const end = Date.now()
+    console.log(highlight(pstFolder + filename + ' processed in ' + (end - start) + ' ms', ANSI_GREEN))
+  }
 })

package/example/testdata/attachments/text.txt

@@ -0,0 +1 @@
+this is a text doc