Improve Zip File Scanning on Mac

third_party/zlib/google/zip_reader.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "third_party/zlib/google/zip_reader.h"
 
 #include <utility>
 
 #include "base/bind.h"
 #include "base/files/file.h"
@@ skipping 271 matching lines @@
   const int result = unzLocateFile(zip_file_,
                                    path_in_zip.AsUTF8Unsafe().c_str(),
                                    kDefaultCaseSensivityOfOS);
   if (result != UNZ_OK)
     return false;
 
   // Then Open the entry.
   return OpenCurrentEntryInZip();
 }
 
-bool ZipReader::ExtractCurrentEntry(WriterDelegate* delegate) const {
+bool ZipReader::ExtractCurrentEntry(WriterDelegate* delegate,
+                                    uint64_t num_bytes_to_extract) const {
   DCHECK(zip_file_);
 
   const int open_result = unzOpenCurrentFile(zip_file_);
   if (open_result != UNZ_OK)
     return false;
 
   if (!delegate->PrepareOutput())
     return false;
+  bool entire_file_extracted = true;

[satorux1, 2017/07/27 07:05:31]

start with false and set it to true only when the entire file is read?

[mortonm, 2017/07/27 18:32:00]

Done.

+  std::unique_ptr<char[]> buf(new char[internal::kZipBufSize]);
+  uint64_t total_num_bytes_read = 0;
+  while (true) {
+    uint64_t bytes_to_read = internal::kZipBufSize;
+    // This should never result in a negative value, as |num_bytes_to_extract|
+    // will always be greater than |total_num_bytes_read|.
+    auto unread_bytes = base::CheckedNumeric<uint64_t>(num_bytes_to_extract) -
+                        total_num_bytes_read;
+    if (unread_bytes.ValueOrDie() < internal::kZipBufSize) {
+      bytes_to_read = unread_bytes.ValueOrDie();
+    }
 
-  bool success = true;  // This becomes false when something bad happens.
-  std::unique_ptr<char[]> buf(new char[internal::kZipBufSize]);
-  while (true) {
-    const int num_bytes_read = unzReadCurrentFile(zip_file_, buf.get(),
-                                                  internal::kZipBufSize);
+    const int num_bytes_read =
+        unzReadCurrentFile(zip_file_, buf.get(), bytes_to_read);
+
     if (num_bytes_read == 0) {
-      // Reached the end of the file.
+      // Reached the end of the file without reaching |num_bytes_to_extract|.
+      entire_file_extracted = true;
       break;
     } else if (num_bytes_read < 0) {
       // If num_bytes_read < 0, then it's a specific UNZ_* error code.
-      success = false;
+      entire_file_extracted = false;
       break;
     } else if (num_bytes_read > 0) {
       // Some data is read.
       if (!delegate->WriteBytes(buf.get(), num_bytes_read)) {
-        success = false;
+        entire_file_extracted = false;
         break;
       }
     }
+    // Previous check ensures that num_bytes_read is not negative here.
+    total_num_bytes_read += base::checked_cast<uint64_t>(num_bytes_read);
+    if (total_num_bytes_read == num_bytes_to_extract) {

[satorux1, 2017/07/27 07:05:31]

Special-casing this case seems tricky. Maybe we can get rid of this by something
like below?

while (true) {
  const int num_bytes_read =
    unzReadCurrentFile(zip_file_, buf.get(), internal::kZipBufSize);

  if (num_bytes == 0) {
    entire_file_extracted = true;
    break;
  } else if (num_bytes_read < 0) {
    // If num_bytes_read < 0, then it's a specific UNZ_* error code.
    break;
  } else if (num_bytes_read > 0) {
    // Some data is read.
    auto unread_bytes = base::CheckedNumeric<uint64_t>(num_bytes_to_extract) -
                        total_num_bytes_read;
    uint_64 num_bytes_to_write = std::min(unread_bytes.ValueOrDie(),
                                          num_bytes_read);
    if (!delegate->WriteBytes(buf.get(), num_bytes_to_write))
      break;
  }
}
 

[satorux1, 2017/07/27 07:10:28]

we'd also need

  if (num_bytes_to_write == 0) 
    break;

[mortonm, 2017/07/27 18:32:00]

Done.

[mortonm, 2017/07/27 18:32:00]

Done.

+      // Read as much data as was specified by |num_bytes_to_extract|. Still
+      // checks whether entire file has been read, since |num_bytes_to_extract|
+      // may or may not equal file size.
+      if (unzReadCurrentFile(zip_file_, buf.get(), 1) == 0) {
+        entire_file_extracted = true;
+      } else {
+        entire_file_extracted = false;
+      }
+      break;
+    }
   }
 
   unzCloseCurrentFile(zip_file_);
 
-  return success;
+  return entire_file_extracted;
 }
 
 bool ZipReader::ExtractCurrentEntryToFilePath(
     const base::FilePath& output_file_path) const {
   DCHECK(zip_file_);
 
   // If this is a directory, just create it and return.
   if (current_entry_info()->is_directory())
     return base::CreateDirectory(output_file_path);
 
   bool success = false;
   {
     FilePathWriterDelegate writer(output_file_path);
-    success = ExtractCurrentEntry(&writer);
+    success =
+        ExtractCurrentEntry(&writer, std::numeric_limits<uint64_t>::max());
   }
 
   if (success &&
       current_entry_info()->last_modified() != base::Time::UnixEpoch()) {
     base::TouchFile(output_file_path,
                     base::Time::Now(),
                     current_entry_info()->last_modified());
   }
 
   return success;
@@ skipping 59 matching lines @@
 
 bool ZipReader::ExtractCurrentEntryToFile(base::File* file) const {
   DCHECK(zip_file_);
 
   // If this is a directory, there's nothing to extract to the file, so return
   // false.
   if (current_entry_info()->is_directory())
     return false;
 
   FileWriterDelegate writer(file);
-  return ExtractCurrentEntry(&writer);
+  return ExtractCurrentEntry(&writer, std::numeric_limits<uint64_t>::max());
 }
 
-bool ZipReader::ExtractCurrentEntryToString(size_t max_read_bytes,
+bool ZipReader::ExtractCurrentEntryToString(uint64_t num_bytes,

[satorux1, 2017/07/27 07:05:31]

num_bytes -> max_read_bytes to be consistent with the header file

[mortonm, 2017/07/27 18:32:00]

Done.

                                             std::string* output) const {
   DCHECK(output);
   DCHECK(zip_file_);
-  DCHECK_NE(0U, max_read_bytes);
+
+  if (num_bytes == 0) {
+    output->clear();
+    return true;
+  }
 
   if (current_entry_info()->is_directory()) {
     output->clear();
     return true;
   }
 
   // The original_size() is the best hint for the real size, so it saves
   // doing reallocations for the common case when the uncompressed size is
   // correct. However, we need to assume that the uncompressed size could be
   // incorrect therefore this function needs to read as much data as possible.
   std::string contents;
   contents.reserve(
-      static_cast<size_t>(std::min(static_cast<int64_t>(max_read_bytes),
+      static_cast<size_t>(std::min(base::checked_cast<int64_t>(num_bytes),
                                    current_entry_info()->original_size())));
 
-  StringWriterDelegate writer(max_read_bytes, &contents);
-  if (!ExtractCurrentEntry(&writer))
+  StringWriterDelegate writer(num_bytes, &contents);
+  if (!ExtractCurrentEntry(&writer, num_bytes)) {
+    if (contents.length() < num_bytes) {
+      // There was an error in extracting entry.

[satorux1, 2017/07/27 07:05:31]

I was a bit confused at first. Maybe add something like below?

There was an error. If the current entry is smaller than max_read_bytes,
ExtractCurrentEntry() should read the whole content and return true.

[mortonm, 2017/07/27 18:32:00]

Done. The revised comment now explains the situation more clearly.

+      output->clear();
+    } else {
+      // |num_bytes| is less than the length of current entry.
+      output->swap(contents);
+    }
     return false;
+  }
   output->swap(contents);
   return true;
 }
 
 bool ZipReader::OpenInternal() {
   DCHECK(zip_file_);
 
   unz_global_info zip_info = {};  // Zero-clear.
   if (unzGetGlobalInfo(zip_file_, &zip_info) != UNZ_OK) {
     return false;
@@ skipping 69 matching lines @@
 }
 
 bool FileWriterDelegate::WriteBytes(const char* data, int num_bytes) {
   int bytes_written = file_->WriteAtCurrentPos(data, num_bytes);
   if (bytes_written > 0)
     file_length_ += bytes_written;
   return bytes_written == num_bytes;
 }
 
 }  // namespace zip