netwerk/cookie/src/nsCookie.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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  * Daniel Witte.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Daniel Witte (dwitte@stanford.edu)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * 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 #ifndef nsCookie_h__
  40 #define nsCookie_h__
  41
  42 #include "nsICookie.h"
  43 #include "nsICookie2.h"
  44 #include "nsString.h"
  45
  46 /**
  47  * The nsCookie class is the main cookie storage medium for use within cookie
  48  * code. It implements nsICookie2, which extends nsICookie, a frozen interface
  49  * for xpcom access of cookie objects.
  50  */
  51
  52 /******************************************************************************
  53  * nsCookie:
  54  * implementation
  55  ******************************************************************************/
  56
  57 class nsCookie : public nsICookie2
  58 {
  59   public:
  60     // nsISupports
  61     NS_DECL_ISUPPORTS
  62     NS_DECL_NSICOOKIE
  63     NS_DECL_NSICOOKIE2
  64
  65   private:
  66     // for internal use only. see nsCookie::Create().
  67     nsCookie(const char     *aName,
  68              const char     *aValue,
  69              const char     *aHost,
  70              const char     *aPath,
  71              const char     *aEnd,
  72              PRInt64         aExpiry,
  73              PRInt64         aLastAccessed,
  74              PRInt64         aCreationID,
  75              PRBool          aIsSession,
  76              PRBool          aIsSecure,
  77              PRBool          aIsHttpOnly)
  78      : mNext(nsnull)
  79      , mName(aName)
  80      , mValue(aValue)
  81      , mHost(aHost)
  82      , mPath(aPath)
  83      , mEnd(aEnd)
  84      , mExpiry(aExpiry)
  85      , mLastAccessed(aLastAccessed)
  86      , mCreationID(aCreationID)
  87      , mIsSession(aIsSession != PR_FALSE)
  88      , mIsSecure(aIsSecure != PR_FALSE)
  89      , mIsHttpOnly(aIsHttpOnly != PR_FALSE)
  90     {
  91     }
  92
  93   public:
  94     // public helper to create an nsCookie object. use |operator delete|
  95     // to destroy an object created by this method.
  96     static nsCookie * Create(const nsACString &aName,
  97                              const nsACString &aValue,
  98                              const nsACString &aHost,
  99                              const nsACString &aPath,
 100                              PRInt64           aExpiry,
 101                              PRInt64           aLastAccessed,
 102                              PRInt64           aCreationID,
 103                              PRBool            aIsSession,
 104                              PRBool            aIsSecure,
 105                              PRBool            aIsHttpOnly);
 106
 107     virtual ~nsCookie() {}
 108
 109     // fast (inline, non-xpcom) getters
 110     inline const nsDependentCString Name()  const { return nsDependentCString(mName, mValue - 1); }
 111     inline const nsDependentCString Value() const { return nsDependentCString(mValue, mHost - 1); }
 112     inline const nsDependentCString Host()  const { return nsDependentCString(mHost, mPath - 1); }
 113     inline const nsDependentCString RawHost() const { return nsDependentCString(IsDomain() ? mHost + 1 : mHost, mPath - 1); }
 114     inline const nsDependentCString Path()  const { return nsDependentCString(mPath, mEnd); }
 115     inline PRInt64 Expiry()                 const { return mExpiry; }        // in seconds
 116     inline PRInt64 LastAccessed()           const { return mLastAccessed; }  // in microseconds
 117     inline PRInt64 CreationID()             const { return mCreationID; }    // in microseconds
 118     inline PRBool IsSession()               const { return mIsSession; }
 119     inline PRBool IsDomain()                const { return *mHost == '.'; }
 120     inline PRBool IsSecure()                const { return mIsSecure; }
 121     inline PRBool IsHttpOnly()              const { return mIsHttpOnly; }
 122
 123     // setters
 124     inline void SetExpiry(PRInt64 aExpiry)        { mExpiry = aExpiry; }
 125     inline void SetLastAccessed(PRInt64 aTime)    { mLastAccessed = aTime; }
 126     inline void SetIsSession(PRBool aIsSession)   { mIsSession = (PRPackedBool) aIsSession; }
 127     // set the creation id manually, overriding the monotonicity checks in Create().
 128     // use with caution!
 129     inline void SetCreationID(PRInt64 aID)        { mCreationID = aID; }
 130
 131     // linked list management helper
 132     inline nsCookie*& Next() { return mNext; }
 133
 134   protected:
 135     // member variables
 136     // we use char* ptrs to store the strings in a contiguous block,
 137     // so we save on the overhead of using nsCStrings. However, we
 138     // store a terminating null for each string, so we can hand them
 139     // out as nsAFlatCStrings.
 140
 141     nsCookie    *mNext;
 142     const char  *mName;
 143     const char  *mValue;
 144     const char  *mHost;
 145     const char  *mPath;
 146     const char  *mEnd;
 147     PRInt64      mExpiry;
 148     PRInt64      mLastAccessed;
 149     // creation id is unique for each cookie and approximately represents the cookie
 150     // creation time, in microseconds.
 151     PRInt64      mCreationID;
 152     PRPackedBool mIsSession;
 153     PRPackedBool mIsSecure;
 154     PRPackedBool mIsHttpOnly;
 155 };
 156
 157 #endif // nsCookie_h__