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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/* 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/. */
/*
* This file provides the "explicit attribute" provider for messages. It is
* concerned with attributes that are the result of user actions. For example,
* whether a message is starred (flagged), message tags, whether it is
* read/unread, etc.
*/
this.EXPORTED_SYMBOLS = ['GlodaExplicitAttr'];
var Cc = Components.classes;
var Ci = Components.interfaces;
var Cr = Components.results;
var Cu = Components.utils;
Cu.import("resource:///modules/gloda/log4moz.js");
Cu.import("resource:///modules/StringBundle.js");
Cu.import("resource:///modules/gloda/utils.js");
Cu.import("resource:///modules/gloda/gloda.js");
Cu.import("resource:///modules/gloda/noun_tag.js");
Cu.import("resource:///modules/mailServices.js");
var nsMsgMessageFlags_Replied = Ci.nsMsgMessageFlags.Replied;
var nsMsgMessageFlags_Forwarded = Ci.nsMsgMessageFlags.Forwarded;
var EXT_BUILTIN = "built-in";
/**
* @namespace Explicit attribute provider. Indexes/defines attributes that are
* explicitly a result of user action. This dubiously includes marking a
* message as read.
*/
var GlodaExplicitAttr = {
providerName: "gloda.explattr",
strings: new StringBundle("chrome://messenger/locale/gloda.properties"),
_log: null,
_msgTagService: null,
init: function gloda_explattr_init() {
this._log = Log4Moz.repository.getLogger("gloda.explattr");
this._msgTagService = MailServices.tags;
try {
this.defineAttributes();
}
catch (ex) {
this._log.error("Error in init: " + ex);
throw ex;
}
},
/** Boost for starred messages. */
NOTABILITY_STARRED: 16,
/** Boost for tagged messages, first tag. */
NOTABILITY_TAGGED_FIRST: 8,
/** Boost for tagged messages, each additional tag. */
NOTABILITY_TAGGED_ADDL: 1,
defineAttributes: function() {
// Tag
this._attrTag = Gloda.defineAttribute({
provider: this,
extensionName: Gloda.BUILT_IN,
attributeType: Gloda.kAttrExplicit,
attributeName: "tag",
bindName: "tags",
singular: false,
emptySetIsSignificant: true,
facet: true,
subjectNouns: [Gloda.NOUN_MESSAGE],
objectNoun: Gloda.NOUN_TAG,
parameterNoun: null,
// Property change notifications that we care about:
propertyChanges: ["keywords"],
}); // not-tested
// Star
this._attrStar = Gloda.defineAttribute({
provider: this,
extensionName: Gloda.BUILT_IN,
attributeType: Gloda.kAttrExplicit,
attributeName: "star",
bindName: "starred",
singular: true,
facet: true,
subjectNouns: [Gloda.NOUN_MESSAGE],
objectNoun: Gloda.NOUN_BOOLEAN,
parameterNoun: null,
}); // tested-by: test_attributes_explicit
// Read/Unread
this._attrRead = Gloda.defineAttribute({
provider: this,
extensionName: Gloda.BUILT_IN,
attributeType: Gloda.kAttrExplicit,
attributeName: "read",
singular: true,
subjectNouns: [Gloda.NOUN_MESSAGE],
objectNoun: Gloda.NOUN_BOOLEAN,
parameterNoun: null,
}); // tested-by: test_attributes_explicit
/**
* Has this message been replied to by the user.
*/
this._attrRepliedTo = Gloda.defineAttribute({
provider: this,
extensionName: Gloda.BUILT_IN,
attributeType: Gloda.kAttrExplicit,
attributeName: "repliedTo",
singular: true,
subjectNouns: [Gloda.NOUN_MESSAGE],
objectNoun: Gloda.NOUN_BOOLEAN,
parameterNoun: null,
}); // tested-by: test_attributes_explicit
/**
* Has this user forwarded this message to someone.
*/
this._attrForwarded = Gloda.defineAttribute({
provider: this,
extensionName: Gloda.BUILT_IN,
attributeType: Gloda.kAttrExplicit,
attributeName: "forwarded",
singular: true,
subjectNouns: [Gloda.NOUN_MESSAGE],
objectNoun: Gloda.NOUN_BOOLEAN,
parameterNoun: null,
}); // tested-by: test_attributes_explicit
},
process: function* Gloda_explattr_process(aGlodaMessage, aRawReps, aIsNew,
aCallbackHandle) {
let aMsgHdr = aRawReps.header;
aGlodaMessage.starred = aMsgHdr.isFlagged;
if (aGlodaMessage.starred)
aGlodaMessage.notability += this.NOTABILITY_STARRED;
aGlodaMessage.read = aMsgHdr.isRead;
let flags = aMsgHdr.flags;
aGlodaMessage.repliedTo = Boolean(flags & nsMsgMessageFlags_Replied);
aGlodaMessage.forwarded = Boolean(flags & nsMsgMessageFlags_Forwarded);
let tags = aGlodaMessage.tags = [];
// -- Tag
// build a map of the keywords
let keywords = aMsgHdr.getStringProperty("keywords");
let keywordList = keywords.split(' ');
let keywordMap = {};
for (let iKeyword = 0; iKeyword < keywordList.length; iKeyword++) {
let keyword = keywordList[iKeyword];
keywordMap[keyword] = true;
}
let tagArray = TagNoun.getAllTags();
for (let iTag = 0; iTag < tagArray.length; iTag++) {
let tag = tagArray[iTag];
if (tag.key in keywordMap)
tags.push(tag);
}
if (tags.length)
aGlodaMessage.notability += this.NOTABILITY_TAGGED_FIRST +
(tags.length - 1) * this.NOTABILITY_TAGGED_ADDL;
yield Gloda.kWorkDone;
},
/**
* Duplicates the notability logic from process(). Arguably process should
* be factored to call us, grokNounItem should be factored to call us, or we
* should get sufficiently fancy that our code wildly diverges.
*/
score: function Gloda_explattr_score(aMessage, aContext) {
let score = 0;
if (aMessage.starred)
score += this.NOTABILITY_STARRED;
if (aMessage.tags.length)
score += this.NOTABILITY_TAGGED_FIRST +
(aMessage.tags.length - 1) * this.NOTABILITY_TAGGED_ADDL;
return score;
},
};
|
