caps/include/nsNullPrincipal.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * the Mozilla Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Boris Zbarsky <bzbarsky@mit.edu> (Original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 /**
  40  * This is the principal that has no rights and can't be accessed by
  41  * anything other than itself and chrome; null principals are not
  42  * same-origin with anything but themselves.
  43  */
  44
  45 #ifndef nsNullPrincipal_h__
  46 #define nsNullPrincipal_h__
  47
  48 #include "nsIPrincipal.h"
  49 #include "nsJSPrincipals.h"
  50 #include "nsCOMPtr.h"
  51
  52 class nsIURI;
  53
  54 #define NS_NULLPRINCIPAL_CLASSNAME "nullprincipal"
  55 #define NS_NULLPRINCIPAL_CID \
  56 { 0xdd156d62, 0xd26f, 0x4441, \
  57  { 0x9c, 0xdb, 0xe8, 0xf0, 0x91, 0x07, 0xc2, 0x73 } }
  58 #define NS_NULLPRINCIPAL_CONTRACTID "@mozilla.org/nullprincipal;1"
  59
  60 #define NS_NULLPRINCIPAL_SCHEME "moz-nullprincipal"
  61
  62 class nsNullPrincipal : public nsIPrincipal
  63 {
  64 public:
  65   nsNullPrincipal();
  66
  67   // Our refcount is managed by mJSPrincipals.  Use this macro to avoid an
  68   // extra refcount member.
  69
  70   // FIXME: bug 327245 -- I sorta wish there were a clean way to share the
  71   // mJSPrincipals munging code between the various principal classes without
  72   // giving up the NS_DECL_NSIPRINCIPAL goodness.
  73   NS_DECL_ISUPPORTS_INHERITED
  74   NS_DECL_NSIPRINCIPAL
  75   NS_DECL_NSISERIALIZABLE
  76
  77   nsresult Init();
  78
  79 protected:
  80   virtual ~nsNullPrincipal();
  81
  82   nsJSPrincipals mJSPrincipals;
  83   nsCOMPtr<nsIURI> mURI;
  84 };
  85
  86 #endif // nsNullPrincipal_h__