Save net-internals log dumps directly to disk.

chrome/browser/resources/net_internals/dataview.js

 // Copyright (c) 2011 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.
 
 /**
  * This view displays options for importing/exporting the captured data. Its
  * primarily usefulness is to allow users to copy-paste their data in an easy
  * to read format for bug reports.
  *
  *   - Has a button to generate a text report.
  *
  *   - Shows how many events have been captured.
  *  @constructor
  */
 function DataView(mainBoxId,
-                  outputTextBoxId,
                   exportTextButtonId,
                   securityStrippingCheckboxId,
                   byteLoggingCheckboxId,
                   passivelyCapturedCountId,
                   activelyCapturedCountId,
                   deleteAllId,
                   dumpDataDivId,
                   loadDataDivId,
                   loadLogFileId,
                   capturingTextSpanId,
                   loggingTextSpanId) {
   DivView.call(this, mainBoxId);
 
-  this.textPre_ = document.getElementById(outputTextBoxId);
-
   var securityStrippingCheckbox =
       document.getElementById(securityStrippingCheckboxId);
   securityStrippingCheckbox.onclick =
       this.onSetSecurityStripping_.bind(this, securityStrippingCheckbox);
 
   var byteLoggingCheckbox = document.getElementById(byteLoggingCheckboxId);
   byteLoggingCheckbox.onclick =
       this.onSetByteLogging_.bind(this, byteLoggingCheckbox);
 
-  var exportTextButton = document.getElementById(exportTextButtonId);
-  exportTextButton.onclick = this.onExportToText_.bind(this);
+  this.exportTextButton_ = document.getElementById(exportTextButtonId);
+  this.exportTextButton_.onclick = this.onExportToText_.bind(this);
 
   this.activelyCapturedCountBox_ =
       document.getElementById(activelyCapturedCountId);
   this.passivelyCapturedCountBox_ =
       document.getElementById(passivelyCapturedCountId);
   document.getElementById(deleteAllId).onclick =
       g_browser.deleteAllEvents.bind(g_browser);
 
   this.dumpDataDiv_ = document.getElementById(dumpDataDivId);
   this.loadDataDiv_ = document.getElementById(loadDataDivId);
   this.capturingTextSpan_ = document.getElementById(capturingTextSpanId);
   this.loggingTextSpan_ = document.getElementById(loggingTextSpanId);
 
   var loadLogFileElement = document.getElementById(loadLogFileId);
   loadLogFileElement.onchange =
       this.logFileChanged.bind(this, loadLogFileElement);
 
   this.updateEventCounts_();
-  this.waitingForUpdate_ = false;
 
   g_browser.addLogObserver(this);
 }
 
 inherits(DataView, DivView);
 
 /**
  * Called whenever a new event is received.
  */
 DataView.prototype.onLogEntryAdded = function(logEntry) {
@@ skipping 17 matching lines @@
 
 /**
  * Called when either a log file is loaded or when going back to actively
  * logging events.  In either case, called after clearing the old entries,
  * but before getting any new ones.
  */
 DataView.prototype.onSetIsViewingLogFile = function(isViewingLogFile) {
   setNodeDisplay(this.dumpDataDiv_, !isViewingLogFile);
   setNodeDisplay(this.capturingTextSpan_, !isViewingLogFile);
   setNodeDisplay(this.loggingTextSpan_, isViewingLogFile);
-  this.setText_('');
 };
 
 /**
  * Updates the counters showing how many events have been captured.
  */
 DataView.prototype.updateEventCounts_ = function() {
   this.activelyCapturedCountBox_.innerText =
       g_browser.getNumActivelyCapturedEvents()
   this.passivelyCapturedCountBox_.innerText =
       g_browser.getNumPassivelyCapturedEvents();
@@ skipping 13 matching lines @@
 
 /**
  * Depending on the value of the checkbox, enables or disables stripping
  * cookies and passwords from log dumps and displayed events.
  */
 DataView.prototype.onSetSecurityStripping_ =
     function(securityStrippingCheckbox) {
   g_browser.setSecurityStripping(securityStrippingCheckbox.checked);
 };
 
-/**
- * Clears displayed text when security stripping is toggled.
- */
 DataView.prototype.onSecurityStrippingChanged = function() {
-  this.setText_('');
 }
 
 /**
  * Called when a log file is selected.
  *
  * Gets the log file from the input element and tries to read from it.
  */
 DataView.prototype.logFileChanged = function(loadLogFileElement) {
   var logFile = loadLogFileElement.files[0];
   if (logFile) {
@@ skipping 13 matching lines @@
   alert('Error ' + event.target.error.code + '.  Unable to load file.');
 }
 
 /**
  * Tries to load the contents of the log file.
  */
 DataView.prototype.onLoadLogFile = function(event) {
   g_browser.loadedLogFile(event.target.result);
 }
 
+DataView.prototype.EnableExportTextButton_ = function(enabled) {

[eroman, 2011/06/16 00:42:02]

nit: use lowercaseCamelCase for function names in javascript.

[mmenke, 2011/06/16 16:16:53]

Done.

+  this.exportTextButton_.disabled = !enabled;
+}
+
 /**
  * If not already waiting for results from all updates, triggers all
  * updates and starts waiting for them to complete.
  */
 DataView.prototype.onExportToText_ = function() {
-  if (this.waitingForUpdate_)
+  if (this.exportTextButton_.disabled)
     return;
-  this.waitingForUpdate = true;
-  this.setText_('Generating...');
+  this.EnableExportTextButton_(false);
+
   g_browser.updateAllInfo(this.onUpdateAllCompleted.bind(this));
 };
 
 /**
  * Presents the captured data as formatted text.
  */
 DataView.prototype.onUpdateAllCompleted = function(data) {
   // It's possible for a log file to be loaded while a dump is being generated.
   // When that happens, don't display the log dump, to avoid any confusion.
   if (g_browser.isViewingLogFile())
@@ skipping 207 matching lines @@
       var provider = namespaceProviders[i];
       text.push('name: ' + provider.name);
       text.push('version: ' + provider.version);
       text.push('type: ' +
                 ServiceProvidersView.getNamespaceProviderType(provider));
       text.push('active: ' + provider.active);
       text.push('');
     }
   }
 
-  // Open a new window to display this text.
-  this.setText_(text.join('\n'));
+  var chunkSize = 100 * 1024;

[eroman, 2011/06/16 00:42:02]

chunkSize is unused.

[mmenke, 2011/06/16 16:16:53]

Removed.  Accidentally left over from one of the aforementioned other
implementations.

+  var flatText = text.join('\n');
+  window.webkitRequestFileSystem(
+      window.TEMPORARY, 10*1024 + flatText.length,

[eroman, 2011/06/16 00:42:02]

nit: the assumption here is that 1 character = 1 byte, I don't think that is
correct.

It is possible that some of our characters in the string will be non-ascii (for
instance the formatted date strings can contain non-ascii for certain locales).

[mmenke, 2011/06/16 16:16:53]

Fixed.  Thanks for catching that.  Be a pain to run into it in the wild.

+      this.OnFileSystemCreate_.bind(this, flatText),
+      this.OnFileError_.bind(this, 'Unable to create file system.'));
+};
 
-  this.selectText_();
-};
+DataView.prototype.OnFileSystemCreate_ = function(text, fileSystem) {

[eroman, 2011/06/16 00:42:02]

I believe javascript style stipulates lowercase for function names (this comment
applies to rest of files).

[mmenke, 2011/06/16 16:16:53]

Fixed everywhere.

+  fileSystem.root.getFile(
+      'net_internals_log.txt', {create: true},

[eroman, 2011/06/16 00:42:02]

I wander if we should include a unique identifier (like timestamp) in the
filename.

[mmenke, 2011/06/16 16:16:53]

I considered that, but wasn't sure it was worth the effort:

We can't easily get a locale dependent version of "m.d.yyyy_hh.mm.ss" or
"d.m.yyyy_hh.mm.ss" from Javscript.  The only functions it has use a combination
of text and numbers, and I have no idea what the text looks like in different
locales, or how else the format may change.

Another issue is then we'd have to be more careful about cleaning up files.  Not
too complicated, but I think we have more than enough callbacks as it is.

+      this.OnFileCreate_.bind(this, text),
+      this.OnFileError_.bind(this, 'Unable to create file.'));
+}

[eroman, 2011/06/16 00:42:02]

nit: can you put semicolon after all of these "statements" ?

[mmenke, 2011/06/16 16:16:53]

Done.

+
+DataView.prototype.OnFileCreate_ = function(text, fileEntry) {
+  fileEntry.createWriter(
+      this.OnFileCreateWriter_.bind(this, text, fileEntry),
+      this.OnFileError_.bind(this, 'Unable to create writer.'));
+}
+
+DataView.prototype.OnFileCreateWriter_ = function(text, fileEntry, fileWriter) {
+  fileWriter.onerror = this.OnFileError_.bind(this, 'Write failed.')
+  fileWriter.onwriteend = this.OnFileWriteComplete_.bind(this, fileEntry)
+  var blobBuilder = new WebKitBlobBuilder();
+  blobBuilder.append(text);

[eroman, 2011/06/16 00:42:02]

Do you know how it serializes strings? UTF16? UTF8?

[mmenke, 2011/06/16 16:16:53]

Experimentally, just writes out UTF8.

+  fileWriter.write(blobBuilder.getBlob('octet/stream'));

[eroman, 2011/06/16 00:42:02]

One annoyance is line ending on Windows are CR LF, however the string we built
up is using LF.

So I imagine if you were to open the resulting file in notepad it would be
smashed into one line.

[mmenke, 2011/06/16 16:16:53]

Fixed (Use CRLF on Windows only).

+}
+
+DataView.prototype.OnFileWriteComplete_ = function(fileEntry) {
+  window.location = fileEntry.toURL();

[eroman, 2011/06/16 00:42:02]

Not a big deal, but this might cause a flicker in the location bar. Or it might
overwrite it alltogether, i dunno.

If that is a problem, you can create an iframe and set the download target in
the iframe's .src.

This should still cause the download to be triggered, but without affecting our
URL or back/forward history.

[mmenke, 2011/06/16 16:16:53]

We don't actually update the address bar until we've decided it's a navigation,
I believe.

[mmenke, 2011/06/16 16:26:59]

Well...I was wrong about this.  I'll go ahead and add the iframe (Window.open
should work, too, but don't want to create a new process)

+  this.EnableExportTextButton_(true);
+}
+
+DataView.prototype.OnFileError_ = function(errorText, error) {
+  this.EnableExportTextButton_(true);
+  alert(errorText + ' Error: ' + error.code);

[eroman, 2011/06/16 00:42:02]

I suggest giving a more informative message, since experience has shown me that
somehow the error cases *always* end up happening :)

Right now this will print something like "Error: 10", which is a bit cryptic.

At a minimum, I suggest mentioning this is a FileError so we know what enum to
lookup the code in.

Even better if we can stringize it. Perhaps this would work (dunno havent
tested):

for (var errorName in FileError) {
  if (error.code == FileError[errorName])
     alert("FileError." + errorName + "(" + error.code + ")");
}

alert("FileError " + error.code);

[mmenke, 2011/06/16 16:16:53]

Done.

+}
 
 DataView.prototype.appendEventsPrintedAsText_ = function(out) {
   var allEvents = g_browser.getAllCapturedEvents();
 
   // Group the events into buckets by source ID, and buckets by source type.
   var sourceIds = [];
   var sourceIdToEventList = {};
   var sourceTypeToSourceIdList = {};
 
   // Lists used for actual output.
@@ skipping 51 matching lines @@
 
   for (var i = 0; i < socketPools.length; ++i) {
     if (socketPools[i].origPool.groups == undefined)
       continue;
     var groupTablePrinter = socketPools[i].createGroupTablePrinter();
     text.push(groupTablePrinter.toText(2));
   }
 };
 
 /**
- * Helper function to set this view's content to |text|.
- */
-DataView.prototype.setText_ = function(text) {
-  this.textPre_.innerHTML = '';
-  addTextNode(this.textPre_, text);
-};
-
-/**
  * Format a time ticks count as a timestamp.
  */
 DataView.prototype.formatExpirationTime_ = function(timeTicks) {
   var d = g_browser.convertTimeTicksToDate(timeTicks);
   var isExpired = d.getTime() < (new Date()).getTime();
   return 't=' + d.getTime() + (isExpired ? ' [EXPIRED]' : '');
 };
-
-/**
- * Select all text from log dump.
- */
-DataView.prototype.selectText_ = function() {
-  var selection = window.getSelection();
-  selection.removeAllRanges();
-
-  var range = document.createRange();
-  range.selectNodeContents(this.textPre_);
-  selection.addRange(range);
-};