1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsIFile;
interface nsIMsgNewsFolder;
interface nsINNTPProtocol;
interface nsNNTPProtocol;
interface nsIChannel;
interface nsIURI;
interface nsIMsgWindow;
[scriptable, uuid(077620ed-c6c4-4d4d-bed5-4d041f924002)]
interface nsINntpIncomingServer : nsISupports {
/* the on-disk path to the newsrc file for this server */
attribute nsIFile newsrcFilePath;
/* the newsrc root path (the directories all the newsrc files live) */
attribute nsIFile newsrcRootPath;
/* ask the user before downloading more than maxArticles? */
attribute boolean notifyOn;
/* the max articles to download */
attribute long maxArticles;
/* when we don't download all, do we mark the rest read? */
attribute boolean markOldRead;
/* abbreviate the newsgroup names in the folder pane? */
attribute boolean abbreviate;
/* do we use a single login per server or do we login per group */
attribute boolean singleSignon;
/** the server charset and it may be needed to display newsgroup folder
* names correctly
**/
attribute ACString charset;
/* the server keeps track of all the newsgroups we are subscribed to */
void addNewsgroup(in AString name);
void removeNewsgroup(in AString name);
void writeNewsrcFile();
attribute boolean newsrcHasChanged;
/**
* The maximum number of connections to make to the server.
*
* This preference (internally max_cached_connections) controls how many
* connections we can make. A negative connection count is treated as only
* one connection, while 0 (the default) loads the default number of
* connections, presently 2.
*/
attribute long maximumConnectionsNumber;
void displaySubscribedGroup(in nsIMsgNewsFolder msgFolder,
in long firstMessage, in long lastMessage,
in long totalMessages);
/**
* Get a new NNTP channel to run the URI.
*
* If the server has used up all of its connections, this will place the URI
* in the queue to be run when one is freed.
*
* @param uri The URI to run.
* @param window The standard message window object.
*/
nsIChannel getNntpChannel(in nsIURI uri, in nsIMsgWindow window);
/**
* Enqueues a URI to be run when we have a free connection.
*
* If there is one already free, it will be immediately started.
*
* @param uri The URI to run.
* @param window The standard message window object.
* @param consumer An argument to be passed to nsINNTPProtocol:LoadNewUrl.
*/
void loadNewsUrl(in nsIURI uri, in nsIMsgWindow window,
in nsISupports consumer);
/**
* Remove a connection from our connection cache.
*
* @param aNntpConnection The connection to be removed.
*/
void removeConnection(in nsINNTPProtocol aNntpConnection);
/**
* Load the next URI in the queue to the given connection.
*
* @param aNntpConnection The newly-freed connection.
*/
[noscript] void prepareForNextUrl(in nsNNTPProtocol aNntpConnection);
/**
* Returns whether or not the server has subscribed to the given newsgroup.
*
* Note that the name here is intended to be escaped; however, since `%' is
* not a legal newsgroup name, it is possibly safe to pass in an unescaped
* newsgroup name.
*/
boolean containsNewsgroup(in AUTF8String escapedName);
void subscribeToNewsgroup(in AUTF8String name);
/* used for the subscribe dialog.
name is encoded in |charset| (attribute declared above) */
[noscript] void addNewsgroupToList(in string name);
attribute boolean supportsExtensions;
void addExtension(in string extension);
boolean queryExtension(in string extension);
attribute boolean postingAllowed;
attribute boolean pushAuth;
attribute unsigned long lastUpdatedTime;
void addPropertyForGet(in string name, in string value);
string queryPropertyForGet(in string name);
void addSearchableGroup(in AString name);
boolean querySearchableGroup(in AString name);
void addSearchableHeader(in string headerName);
boolean querySearchableHeader(in string headerName);
/**
* Returns the folder corresponding to the given group.
*
* Note that this name is expected to be unescaped.
* @note If the group does not exist, a bogus news folder will be returned.
* DO NOT call this method unless you are sure that the newsgroup
* is subscribed to (e.g., by containsNewsgroup)
*/
nsIMsgNewsFolder findGroup(in AUTF8String name);
readonly attribute AUTF8String firstGroupNeedingExtraInfo;
void setGroupNeedsExtraInfo(in AUTF8String name, in boolean needsExtraInfo);
void groupNotFound(in nsIMsgWindow window, in AString group,
in boolean opening);
void setPrettyNameForGroup(in AString name, in AString prettyName);
};
|
