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 * Mozilla Foundation.
19 * Portions created by the Initial Developer are Copyright (C) 2008
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Jim Mathies <jmathies@mozilla.com>.
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
40 #include "nsISupports.idl"
41
42 interface nsIURI;
43 interface nsIFile;
44 interface nsIInterfaceRequestor;
45 interface nsIArray;
46
47 [scriptable, uuid(871cf229-2b21-4f04-b24d-e08061f14815)]
48 interface nsIParentalControlsService : nsISupports
49 {
50 /**
51 * @returns true if the current user account has parental controls
52 * restrictions enabled.
53 */
54 readonly attribute boolean parentalControlsEnabled;
55
56 /**
57 * @returns true if the current user account parental controls
58 * restrictions include the blocking of all file downloads.
59 */
60 readonly attribute boolean blockFileDownloadsEnabled;
61
62 /**
63 * Request that blocked URI(s) be allowed through parental
64 * control filters. Returns true if the URI was successfully
65 * overriden. Note, may block while native UI is shown.
66 *
67 * @param aTarget(s) URI to be overridden. In the case of
68 * multiple URI, the first URI in the array
69 * should be the root URI of the site.
70 * @param window Window that generates the event.
71 */
72 boolean requestURIOverride(in nsIURI aTarget, [optional] in nsIInterfaceRequestor aWindowContext);
73 boolean requestURIOverrides(in nsIArray aTargets, [optional] in nsIInterfaceRequestor aWindowContext);
74
75 /**
76 * @returns true if the current user account has parental controls
77 * logging enabled. If true, applications should log relevent events
78 * using 'log'.
79 */
80 readonly attribute boolean loggingEnabled;
81
82 /**
83 * Log entry types. Additional types can be defined and implemented
84 * as needed. Other possible event types might include email events,
85 * media related events, and IM events.
86 */
87 const short ePCLog_URIVisit = 1; /* Web content */
88 const short ePCLog_FileDownload = 2; /* File downloads */
89
90 /**
91 * Log an application specific parental controls
92 * event.
93 *
94 * @param aEntryType Constant defining the type of event.
95 * @param aFlag A flag indicating if the subject content
96 * was blocked.
97 * @param aSource The URI source of the subject content.
98 * @param aTarget The location the content was saved to if
99 * no blocking occured.
100 */
101 void log(in short aEntryType, in boolean aFlag, in nsIURI aSource, [optional] in nsIFile aTarget);
102 };