Home | History | Annotate | Download | only in public
      1 /*
      2  * Copyright (C) 2009 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions are
      6  * met:
      7  *
      8  *     * Redistributions of source code must retain the above copyright
      9  * notice, this list of conditions and the following disclaimer.
     10  *     * Redistributions in binary form must reproduce the above
     11  * copyright notice, this list of conditions and the following disclaimer
     12  * in the documentation and/or other materials provided with the
     13  * distribution.
     14  *     * Neither the name of Google Inc. nor the names of its
     15  * contributors may be used to endorse or promote products derived from
     16  * this software without specific prior written permission.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 #ifndef WebSecurityOrigin_h
     32 #define WebSecurityOrigin_h
     33 
     34 #include "WebCommon.h"
     35 
     36 #if WEBKIT_IMPLEMENTATION
     37 namespace WebCore { class SecurityOrigin; }
     38 namespace WTF { template <typename T> class PassRefPtr; }
     39 #endif
     40 
     41 namespace WebKit {
     42 
     43 class WebSecurityOriginPrivate;
     44 class WebString;
     45 
     46 class WebSecurityOrigin {
     47 public:
     48     ~WebSecurityOrigin() { reset(); }
     49 
     50     WebSecurityOrigin() : m_private(0) { }
     51     WebSecurityOrigin(const WebSecurityOrigin& s) : m_private(0) { assign(s); }
     52     WebSecurityOrigin& operator=(const WebSecurityOrigin& s)
     53     {
     54         assign(s);
     55         return *this;
     56     }
     57 
     58     // FIXME: This should return a WebSecurityOrigin, not a pointer to one.
     59     WEBKIT_API static WebSecurityOrigin* createFromDatabaseIdentifier(const WebString& databaseIdentifier);
     60     WEBKIT_API static WebSecurityOrigin createFromString(const WebString&);
     61 
     62     WEBKIT_API void reset();
     63     WEBKIT_API void assign(const WebSecurityOrigin&);
     64 
     65     bool isNull() const { return !m_private; }
     66 
     67     WEBKIT_API WebString protocol() const;
     68     WEBKIT_API WebString host() const;
     69     WEBKIT_API unsigned short port() const;
     70 
     71     // The empty WebSecurityOrigin is the least privileged WebSecurityOrigin.
     72     WEBKIT_API bool isEmpty() const;
     73 
     74     // Returns a string representation of the WebSecurityOrigin.  The empty
     75     // WebSecurityOrigin is represented by "null".  The representation of a
     76     // non-empty WebSecurityOrigin resembles a standard URL.
     77     WEBKIT_API WebString toString() const;
     78 
     79     // Returns a string representation of this WebSecurityOrigin that can
     80     // be used as a file.  Should be used in storage APIs only.
     81     WEBKIT_API WebString databaseIdentifier();
     82 
     83 #if WEBKIT_IMPLEMENTATION
     84     WebSecurityOrigin(const WTF::PassRefPtr<WebCore::SecurityOrigin>&);
     85     WebSecurityOrigin& operator=(const WTF::PassRefPtr<WebCore::SecurityOrigin>&);
     86     operator WTF::PassRefPtr<WebCore::SecurityOrigin>() const;
     87 #endif
     88 
     89 private:
     90     void assign(WebSecurityOriginPrivate*);
     91     WebSecurityOriginPrivate* m_private;
     92 };
     93 
     94 } // namespace WebKit
     95 
     96 #endif
     97