Home | History | Annotate | Download | only in extensions
      1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
      2 // Use of this source code is governed by a BSD-style license that can be
      3 // found in the LICENSE file.
      4 
      5 #ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_ERROR_REPORTER_H_
      6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_ERROR_REPORTER_H_
      7 
      8 #include <string>
      9 #include <vector>
     10 
     11 #include "base/strings/string16.h"
     12 
     13 namespace base {
     14 class MessageLoop;
     15 class FilePath;
     16 }
     17 
     18 class Profile;
     19 
     20 // Exposes an easy way for the various components of the extension system to
     21 // report errors. This is a singleton that lives on the UI thread, with the
     22 // exception of ReportError() which may be called from any thread.
     23 // TODO(aa): Hook this up to about:extensions, when we have about:extensions.
     24 // TODO(aa): Consider exposing directly, or via a helper, to the renderer
     25 // process and plumbing the errors out to the browser.
     26 // TODO(aa): Add ReportError(extension_id, message, be_noisy), so that we can
     27 // report errors that are specific to a particular extension.
     28 class ExtensionErrorReporter {
     29  public:
     30   // Initializes the error reporter. Must be called before any other methods
     31   // and on the UI thread.
     32   static void Init(bool enable_noisy_errors);
     33 
     34   // Get the singleton instance.
     35   static ExtensionErrorReporter* GetInstance();
     36 
     37   // Report an extension load error. This forwards to ReportError() after
     38   // sending an EXTENSION_LOAD_ERROR notification.
     39   // TODO(rdevlin.cronin): There's a lot wrong with this. But some of our
     40   // systems rely on the notification. Investigate what it will take to remove
     41   // the notification and this method.
     42   void ReportLoadError(const base::FilePath& extension_path,
     43                        const std::string& error,
     44                        Profile* profile,
     45                        bool be_noisy);
     46 
     47   // Report an error. Errors always go to VLOG(1). Optionally, they can also
     48   // cause a noisy alert box.
     49   void ReportError(const base::string16& message, bool be_noisy);
     50 
     51   // Get the errors that have been reported so far.
     52   const std::vector<base::string16>* GetErrors();
     53 
     54   // Clear the list of errors reported so far.
     55   void ClearErrors();
     56 
     57  private:
     58   static ExtensionErrorReporter* instance_;
     59 
     60   explicit ExtensionErrorReporter(bool enable_noisy_errors);
     61   ~ExtensionErrorReporter();
     62 
     63   base::MessageLoop* ui_loop_;
     64   std::vector<base::string16> errors_;
     65   bool enable_noisy_errors_;
     66 };
     67 
     68 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_ERROR_REPORTER_H_
     69