Added net logging to DownloadItem.

content/browser/download/download_item_impl.h

-// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// 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.
 
 #ifndef CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_IMPL_H_
 #define CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_IMPL_H_
 #pragma once
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/file_path.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list.h"
 #include "base/time.h"
 #include "base/timer.h"
+#include "content/browser/download/download_net_log_parameters.h"
 #include "content/browser/download/download_request_handle.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/download_id.h"
 #include "content/public/browser/download_item.h"
 #include "googleurl/src/gurl.h"
 #include "net/base/net_errors.h"
+#include "net/base/net_log.h"
 
 
 // See download_item.h for usage.
 class CONTENT_EXPORT DownloadItemImpl : public content::DownloadItem {
  public:
   // Delegate is defined in DownloadItemImpl (rather than DownloadItem)
   // as it's relevant to the class implementation (class methods need to
   // call into it) and doesn't have anything to do with its interface.
   // Despite this, the delegate methods take DownloadItems as arguments
   // (rather than DownloadItemImpls) so that classes that inherit from it
@@ skipping 43 matching lines @@
     int count_;
   };
 
   // Note that it is the responsibility of the caller to ensure that a
   // DownloadItemImpl::Delegate passed to a DownloadItemImpl constructor
   // outlives the DownloadItemImpl.
 
   // Constructing from persistent store:
   DownloadItemImpl(Delegate* delegate,
                    content::DownloadId download_id,
-                   const DownloadPersistentStoreInfo& info);
+                   const DownloadPersistentStoreInfo& info,
+                   net::NetLog* log);

[mmenke, 2012/02/03 17:59:45]

nit:  net_log.  Below, too

[Randy Smith (Not in Mondays), 2012/02/03 18:23:37]

I'm somewhat uncomfortable with having different ways of initializing logging
among the different constructors.  Given that we're eventually going to want to
pass a BoundNetLog into DownloadItemImpl, my preference would be to have all
three of these constructors take a BoundNetLog, and create the appropriate
(possibly NULL) type at point of entry.  If there's some reason you don't want
to do that, please comment clearly as to what's goes in in the different cases
(creates a new BoundNetLog based on the NetLog/copies an existing BoundNetLog)
along with a bit of the context for why (download operations occur on multiple
threads, but want to log to the same event source, so we take the BoundNetLog as
a parameter/have an option to either take it as a parameter or create a new
one).

[ahendrickson, 2012/02/04 05:24:04]

Done.

[ahendrickson, 2012/02/04 05:24:04]

Two of the constructors now take BoundNetLogs, and the other will take it via
DownloadCreateInfo (in the next CL).

Done.

 
   // Constructing for a regular download.
   // Takes ownership of the object pointed to by |request_handle|.
   DownloadItemImpl(Delegate* delegate,
                    const DownloadCreateInfo& info,
                    DownloadRequestHandleInterface* request_handle,
                    bool is_otr);
 
   // Constructing for the "Save Page As..." feature:
   DownloadItemImpl(Delegate* delegate,
                    const FilePath& path,
                    const GURL& url,
                    bool is_otr,
-                   content::DownloadId download_id);
+                   content::DownloadId download_id,
+                   net::NetLog* log);
 
   virtual ~DownloadItemImpl();
 
   // Overridden from DownloadItem.
   virtual void AddObserver(DownloadItem::Observer* observer) OVERRIDE;
   virtual void RemoveObserver(DownloadItem::Observer* observer) OVERRIDE;
   virtual void UpdateObservers() OVERRIDE;
   virtual bool CanShowInFolder() OVERRIDE;
   virtual bool CanOpenDownload() OVERRIDE;
   virtual bool ShouldOpenFileBasedOnExtension() OVERRIDE;
@@ skipping 86 matching lines @@
   virtual bool NeedsRename() const OVERRIDE;
   virtual void OffThreadCancel(DownloadFileManager* file_manager) OVERRIDE;
   virtual std::string DebugString(bool verbose) const OVERRIDE;
   virtual void MockDownloadOpenForTesting() OVERRIDE;
   virtual ExternalData* GetExternalData(const void* key) OVERRIDE;
   virtual void SetExternalData(const void* key, ExternalData* data) OVERRIDE;
 
  private:
   // Construction common to all constructors. |active| should be true for new
   // downloads and false for downloads from the history.
-  void Init(bool active);
+  // |download_type| indicates to the net log system what kind of download
+  // this is.
+  void Init(bool active, download_net_logs::DownloadType download_type);
 
   // Internal helper for maintaining consistent received and total sizes, and
   // hash state.
   void UpdateProgress(int64 bytes_so_far, const std::string& hash_state);
 
   // Internal helper for maintaining consistent received and total sizes, and
   // setting the final hash.
   // Should only be called from |OnAllDataSaved|.
   void ProgressComplete(int64 bytes_so_far,
                         const std::string& final_hash);
@@ skipping 146 matching lines @@
   // only.
   bool open_enabled_;
 
   // Did the delegate delay calling Complete on this download?
   bool delegate_delayed_complete_;
 
   // External Data storage.  All objects in the store
   // are owned by the DownloadItemImpl.
   std::map<const void*, ExternalData*> external_data_map_;
 
+  // Net log to use for this download.
+  net::BoundNetLog bound_net_log_;

[mmenke, 2012/02/03 17:59:45]

nit: const

[ahendrickson, 2012/02/04 05:24:04]

Done.

+
   DISALLOW_COPY_AND_ASSIGN(DownloadItemImpl);
 };
 
 #endif  // CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_IMPL_H_