content/browser/site_instance_impl.h

   1 // Copyright (c) 2012 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 CONTENT_BROWSER_SITE_INSTANCE_IMPL_H_
   6 #define CONTENT_BROWSER_SITE_INSTANCE_IMPL_H_
   7
   8 #include "content/browser/renderer_host/render_process_host_impl.h"
   9 #include "content/common/content_export.h"
  10 #include "content/public/browser/notification_observer.h"
  11 #include "content/public/browser/notification_registrar.h"
  12 #include "content/public/browser/site_instance.h"
  13 #include "googleurl/src/gurl.h"
  14
  15 namespace content {
  16 class RenderProcessHostFactory;
  17
  18 class CONTENT_EXPORT SiteInstanceImpl : public SiteInstance,
  19                                         public NotificationObserver {
  20  public:
  21   // SiteInstance interface overrides.
  22   virtual int32 GetId() OVERRIDE;
  23   virtual bool HasProcess() const OVERRIDE;
  24   virtual  RenderProcessHost* GetProcess() OVERRIDE;
  25   virtual const GURL& GetSiteURL() const OVERRIDE;
  26   virtual SiteInstance* GetRelatedSiteInstance(const GURL& url) OVERRIDE;
  27   virtual bool IsRelatedSiteInstance(const SiteInstance* instance) OVERRIDE;
  28   virtual BrowserContext* GetBrowserContext() const OVERRIDE;
  29
  30   // Set the web site that this SiteInstance is rendering pages for.
  31   // This includes the scheme and registered domain, but not the port.  If the
  32   // URL does not have a valid registered domain, then the full hostname is
  33   // stored.
  34   void SetSite(const GURL& url);
  35   bool HasSite() const;
  36
  37   // Returns whether there is currently a related SiteInstance (registered with
  38   // BrowsingInstance) for the site of the given url.  If so, we should try to
  39   // avoid dedicating an unused SiteInstance to it (e.g., in a new tab).
  40   bool HasRelatedSiteInstance(const GURL& url);
  41
  42   // Returns whether this SiteInstance has a process that is the wrong type for
  43   // the given URL.  If so, the browser should force a process swap when
  44   // navigating to the URL.
  45   bool HasWrongProcessForURL(const GURL& url);
  46
  47   // Sets the factory used to create new RenderProcessHosts. This will also be
  48   // passed on to SiteInstances spawned by this one.
  49   // The factory must outlive the SiteInstance; ownership is not transferred. It
  50   // may be NULL, in which case the default BrowserRenderProcessHost will be
  51   // created (this is the behavior if you don't call this function).
  52   void set_render_process_host_factory(RenderProcessHostFactory* rph_factory) {
  53     render_process_host_factory_ = rph_factory;
  54   }
  55
  56  protected:
  57   friend class BrowsingInstance;
  58   friend class SiteInstance;
  59
  60   // Virtual to allow tests to extend it.
  61   virtual ~SiteInstanceImpl();
  62
  63   // Create a new SiteInstance.  Protected to give access to BrowsingInstance
  64   // and tests; most callers should use Create or GetRelatedSiteInstance
  65   // instead.
  66   explicit SiteInstanceImpl(BrowsingInstance* browsing_instance);
  67
  68  private:
  69   // Get the effective URL for the given actual URL.
  70   static GURL GetEffectiveURL(BrowserContext* browser_context,
  71                               const GURL& url);
  72
  73   // NotificationObserver implementation.
  74   virtual void Observe(int type,
  75                        const NotificationSource& source,
  76                        const NotificationDetails& details) OVERRIDE;
  77
  78   // Used to restrict a process' origin access rights.
  79   void LockToOrigin();
  80
  81   // The next available SiteInstance ID.
  82   static int32 next_site_instance_id_;
  83
  84   // A unique ID for this SiteInstance.
  85   int32 id_;
  86
  87   NotificationRegistrar registrar_;
  88
  89   // BrowsingInstance to which this SiteInstance belongs.
  90   scoped_refptr<BrowsingInstance> browsing_instance_;
  91
  92   // Factory for new RenderProcessHosts, not owned by this class. NULL indiactes
  93   // that the default BrowserRenderProcessHost should be created.
  94   const RenderProcessHostFactory* render_process_host_factory_;
  95
  96   // Current RenderProcessHost that is rendering pages for this SiteInstance.
  97   // This pointer will only change once the RenderProcessHost is destructed.  It
  98   // will still remain the same even if the process crashes, since in that
  99   // scenario the RenderProcessHost remains the same.
 100   RenderProcessHost* process_;
 101
 102   // The web site that this SiteInstance is rendering pages for.
 103   GURL site_;
 104
 105   // Whether SetSite has been called.
 106   bool has_site_;
 107
 108   DISALLOW_COPY_AND_ASSIGN(SiteInstanceImpl);
 109 };
 110
 111 }  // namespace content
 112
 113 #endif  // CONTENT_BROWSER_SITE_INSTANCE_IMPL_H_