* added back support for detecting malformed sequences.

* updated readEncapsulatedPixelData to not use readSequenceItem() for finding delimeter item so the malfromed sequence check didn't cause it to fail * made error message for non DICOM P10 files more clear * improved clarity of some error messages by adding the source function to the message
sirrrich · May 4, 2016 · 12a338e · 12a338e
1 parent a42c62a
commit 12a338e
Show file tree

Hide file tree

Showing 15 changed files with 59 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -346,4 +346,4 @@ You can find out more about this by googling for "self documenting code"
 
 Copyright
 ============
-Copyright 2015 Chris Hafey [[email protected]](mailto:[email protected])
+Copyright 2016 Chris Hafey [[email protected]](mailto:[email protected])
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
     "name": "dicomParser",
-    "version": "1.4.0",
+    "version": "1.4.1",
     "description": "Javascript parser for DICOM Part 10 data",
     "main" : "dist/dicomParser.js",
     "ignore": [

diff --git a/dist/dicomParser.js b/dist/dicomParser.js
@@ -1,4 +1,4 @@
-/*! dicom-parser - v1.4.0 - 2016-05-03 | (c) 2014 Chris Hafey | https://github.com/chafey/dicomParser */
+/*! dicom-parser - v1.4.1 - 2016-05-04 | (c) 2014 Chris Hafey | https://github.com/chafey/dicomParser */
 (function (root, factory) {
 
     // node.js
@@ -558,14 +558,21 @@ var dicomParser = (function (dicomParser)
         var fragments = [];
         var bufferSize = 0;
         while(byteStream.position < endOfFrame && byteStream.position < byteStream.byteArray.length) {
-            var fragment = dicomParser.readSequenceItem(byteStream);
-            // NOTE: we only encounter this for the sequence delimiter tag when extracting the last frame
-            if(fragment.tag === 'xfffee0dd') {
+
+            // read the fragment
+            var item = {
+                tag : dicomParser.readTag(byteStream),
+                length : byteStream.readUint32(),
+                dataOffset :  byteStream.position
+            };
+
+            // NOTE: we only encounter this for the sequence delimiter item when extracting the last frame
+            if(item.tag === 'xfffee0dd') {
                 break;
             }
-            fragments.push(fragment);
-            byteStream.seek(fragment.length);
-            bufferSize += fragment.length;
+            fragments.push(item);
+            byteStream.seek(item.length);
+            bufferSize += item.length;
         }
 
         // Convert the fragments into a single pixelData buffer
@@ -702,7 +709,7 @@ var dicomParser = (function (dicomParser)
     else if(byteArray instanceof Uint8Array) {
       return new Uint8Array(byteArray.buffer, byteOffset, length);
     } else {
-      throw 'unknown buffer type';
+      throw 'dicomParser.from: unknown type for byteArray';
     }
   };
 
@@ -719,7 +726,7 @@ var dicomParser = (function (dicomParser)
     else if(byteArray instanceof Uint8Array) {
       return new Uint8Array(length);
     } else {
-      throw 'unknown buffer type';
+      throw 'dicomParser.alloc: unknown type for byteArray';
     }
   };
 
@@ -928,7 +935,7 @@ var dicomParser = (function (dicomParser)
     {
         if(length < 0)
         {
-            throw 'readFixedString - length cannot be less than 0';
+            throw 'dicomParser.readFixedString - length cannot be less than 0';
         }
 
         if(position + length > byteArray.length) {
@@ -1019,7 +1026,7 @@ var dicomParser = (function (dicomParser)
     {
         if(this.position + offset < 0)
         {
-            throw "cannot seek to position < 0";
+            throw "dicomParser.ByteStream.prototype.seek: cannot seek to position < 0";
         }
         this.position += offset;
     };
@@ -1033,7 +1040,7 @@ var dicomParser = (function (dicomParser)
     dicomParser.ByteStream.prototype.readByteStream = function(numBytes)
     {
         if(this.position + numBytes > this.byteArray.length) {
-            throw 'readByteStream - buffer overread';
+            throw 'dicomParser.ByteStream.prototype.readByteStream: readByteStream - buffer overread';
         }
         var byteArrayView = dicomParser.from(this.byteArray, this.position, numBytes);
         this.position += numBytes;
@@ -1963,7 +1970,7 @@ var dicomParser = (function(dicomParser) {
       var prefix = littleEndianByteStream.readFixedString(4);
       if(prefix !== "DICM")
       {
-        throw "dicomParser.readPart10Header: DICM prefix not found at location 132";
+        throw "dicomParser.readPart10Header: DICM prefix not found at location 132 - this is not a valid DICOM P10 file.";
       }
     }
 
@@ -2259,6 +2266,11 @@ var dicomParser = (function (dicomParser)
             dataOffset :  byteStream.position
         };
 
+        if (element.tag !== 'xfffee000') {
+            var startPosition = byteStream.position;
+            throw "dicomParser.readSequenceItem: item tag (FFFE,E000) not found at offset " + startPosition;
+        }
+
         return element;
     };
 
@@ -2312,7 +2324,7 @@ var dicomParser = (function (dicomParser)
     dicomParser = {};
   }
 
-  dicomParser.version = "1.4.0";
+  dicomParser.version = "1.4.1";
 
   return dicomParser;
 }(dicomParser));

diff --git a/dist/dicomParser.min.js b/dist/dicomParser.min.js
diff --git a/dist/package.js b/dist/package.js
@@ -1,7 +1,7 @@
 Package.describe({
   name: 'chafey:dicom-parser',
   summary: 'Javascript parser for DICOM Part 10 data',
-  version: '1.4.0',
+  version: '1.4.1',
   git: 'https://github.com/chafey/dicomParser.git/',
   documentation: null
 });

diff --git a/meteor/dicomParser/package.js b/meteor/dicomParser/package.js
@@ -1,7 +1,7 @@
 Package.describe({
   name: 'chafey:dicom-parser',
   summary: 'Javascript parser for DICOM Part 10 data',
-  version: '1.4.0',
+  version: '1.4.1',
   git: 'https://github.com/chafey/dicomParser.git/',
   documentation: null
 });

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dicom-parser",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Javascript parser for DICOM Part 10 data",
   "keywords": [
     "DICOM",

diff --git a/src/alloc.js b/src/alloc.js
@@ -27,7 +27,7 @@ var dicomParser = (function (dicomParser)
     else if(byteArray instanceof Uint8Array) {
       return new Uint8Array(byteArray.buffer, byteOffset, length);
     } else {
-      throw 'unknown buffer type';
+      throw 'dicomParser.from: unknown type for byteArray';
     }
   };
 
@@ -44,7 +44,7 @@ var dicomParser = (function (dicomParser)
     else if(byteArray instanceof Uint8Array) {
       return new Uint8Array(length);
     } else {
-      throw 'unknown buffer type';
+      throw 'dicomParser.alloc: unknown type for byteArray';
     }
   };
 

diff --git a/src/byteArrayParser.js b/src/byteArrayParser.js
@@ -27,7 +27,7 @@ var dicomParser = (function (dicomParser)
     {
         if(length < 0)
         {
-            throw 'readFixedString - length cannot be less than 0';
+            throw 'dicomParser.readFixedString - length cannot be less than 0';
         }
 
         if(position + length > byteArray.length) {

diff --git a/src/byteStream.js b/src/byteStream.js
@@ -64,7 +64,7 @@ var dicomParser = (function (dicomParser)
     {
         if(this.position + offset < 0)
         {
-            throw "cannot seek to position < 0";
+            throw "dicomParser.ByteStream.prototype.seek: cannot seek to position < 0";
         }
         this.position += offset;
     };
@@ -78,7 +78,7 @@ var dicomParser = (function (dicomParser)
     dicomParser.ByteStream.prototype.readByteStream = function(numBytes)
     {
         if(this.position + numBytes > this.byteArray.length) {
-            throw 'readByteStream - buffer overread';
+            throw 'dicomParser.ByteStream.prototype.readByteStream: readByteStream - buffer overread';
         }
         var byteArrayView = dicomParser.from(this.byteArray, this.position, numBytes);
         this.position += numBytes;

diff --git a/src/readEncapsulatedPixelData.js b/src/readEncapsulatedPixelData.js
@@ -36,14 +36,21 @@ var dicomParser = (function (dicomParser)
         var fragments = [];
         var bufferSize = 0;
         while(byteStream.position < endOfFrame && byteStream.position < byteStream.byteArray.length) {
-            var fragment = dicomParser.readSequenceItem(byteStream);
-            // NOTE: we only encounter this for the sequence delimiter tag when extracting the last frame
-            if(fragment.tag === 'xfffee0dd') {
+
+            // read the fragment
+            var item = {
+                tag : dicomParser.readTag(byteStream),
+                length : byteStream.readUint32(),
+                dataOffset :  byteStream.position
+            };
+
+            // NOTE: we only encounter this for the sequence delimiter item when extracting the last frame
+            if(item.tag === 'xfffee0dd') {
                 break;
             }
-            fragments.push(fragment);
-            byteStream.seek(fragment.length);
-            bufferSize += fragment.length;
+            fragments.push(item);
+            byteStream.seek(item.length);
+            bufferSize += item.length;
         }
 
         // Convert the fragments into a single pixelData buffer

diff --git a/src/readPart10Header.js b/src/readPart10Header.js
@@ -30,7 +30,7 @@ var dicomParser = (function(dicomParser) {
       var prefix = littleEndianByteStream.readFixedString(4);
       if(prefix !== "DICM")
       {
-        throw "dicomParser.readPart10Header: DICM prefix not found at location 132";
+        throw "dicomParser.readPart10Header: DICM prefix not found at location 132 - this is not a valid DICOM P10 file.";
       }
     }
 

diff --git a/src/readSequenceItem.js b/src/readSequenceItem.js
@@ -32,6 +32,11 @@ var dicomParser = (function (dicomParser)
             dataOffset :  byteStream.position
         };
 
+        if (element.tag !== 'xfffee000') {
+            var startPosition = byteStream.position;
+            throw "dicomParser.readSequenceItem: item tag (FFFE,E000) not found at offset " + startPosition;
+        }
+
         return element;
     };
 

diff --git a/src/version.js b/src/version.js
@@ -11,7 +11,7 @@ var dicomParser = (function (dicomParser)
     dicomParser = {};
   }
 
-  dicomParser.version = "1.4.0";
+  dicomParser.version = "1.4.1";
 
   return dicomParser;
 }(dicomParser));
diff --git a/test/readDicomElementImplicitTest.js b/test/readDicomElementImplicitTest.js
@@ -158,8 +158,7 @@
     var byteStream = new dicomParser.ByteStream(dicomParser.littleEndianByteArrayParser, convertToByteArray(bytes));
 
     // Act/Assert
-    assert.throws(function() { dicomParser.readDicomElementImplicit(byteStream, undefined); }, /invalid value for parameter 'maxPosition'/);
-
+    assert.throws(function() { dicomParser.readDicomElementImplicit(byteStream, undefined); }, 'dicomParser.readSequenceItem: item tag (FFFE,E000) not found at offset 8');
   });
 
   test("bytes resembling an end-of-sequence tag are not treated like an SQ item when using a callback", function(assert) {