src/third_party/WebKit/Source/core/frame/Location.idl

   1 /*
   2  * Copyright (C) 2008 Apple 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
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 [
  30     CheckSecurity=Frame,
  31     WillBeGarbageCollected,
  32 ] interface Location {
  33     // |assign|, |replace|, and *writing* |href| do not require a security
  34     // check, as they *change* the page, and thus these do not change any
  35     // property of an *existing* document at a different origin.
  36     // However, *reading* |href|, or accessing any component, is a security
  37     // problem, since that allows tracking navigation.
  38     [SetterCallWith=ActiveWindow&FirstWindow, DoNotCheckSecurity=Setter, Unforgeable] attribute DOMString href;
  39
  40     [CallWith=ActiveWindow&FirstWindow, DoNotCheckSecurity, Unforgeable, ReadOnly, PerWorldBindings, LogActivity] void assign(DOMString url);
  41     [CallWith=ActiveWindow&FirstWindow, DoNotCheckSecurity, Unforgeable, ReadOnly, PerWorldBindings, LogActivity] void replace(DOMString url);
  42     [CallWith=ActiveWindow, Unforgeable, ReadOnly] void reload();
  43
  44     // URI decomposition attributes
  45     [SetterCallWith=ActiveWindow&FirstWindow, RaisesException=Setter] attribute DOMString protocol;
  46     [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString host;
  47     [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString hostname;
  48     [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString port;
  49     [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString pathname;
  50     [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString search;
  51     [SetterCallWith=ActiveWindow&FirstWindow] attribute DOMString hash;
  52
  53     readonly attribute DOMString origin;
  54
  55     readonly attribute DOMStringList ancestorOrigins;
  56
  57     [NotEnumerable, Unforgeable, ReadOnly, ImplementedAs=href] DOMString toString();
  58     [NotEnumerable, Custom, Unforgeable, ReadOnly] any valueOf();
  59 };
  60