summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/db/gloda/modules/GlodaSyntheticView.jsm
blob: 2e0fb7b5beb4d04f53ca801dd73f61a1d54a7eb2 (plain)
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
/* 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 is charged with providing you a way to have a pretty gloda-backed
 *  nsIMsgDBView.
 */

const EXPORTED_SYMBOLS = ["GlodaSyntheticView"];

/**
 * Create a synthetic view suitable for passing to |FolderDisplayWidget.show|.
 * You must pass a query, collection, or conversation in.
 *
 * @param {GlodaQuery} [aArgs.query] A gloda query to run.
 * @param {GlodaCollection} [aArgs.collection] An already-populated collection
 *     to display.  Do not call getCollection on a query and hand us that.  We
 *     will not register ourselves as a listener and things will not work.
 * @param {GlodaConversation} [aArgs.conversation] A conversation whose messages
 *     you want to display.
 */
function GlodaSyntheticView(aArgs) {
  if ("query" in aArgs) {
    this.query = aArgs.query;
    this.collection = this.query.getCollection(this);
    this.completed = false;
    this.viewType = "global";
  } else if ("collection" in aArgs) {
    this.query = null;
    this.collection = aArgs.collection;
    this.completed = true;
    this.viewType = "global";
  } else if ("conversation" in aArgs) {
    this.collection = aArgs.conversation.getMessagesCollection(this);
    this.query = this.collection.query;
    this.completed = false;
    this.viewType = "conversation";
    this.selectedMessage = aArgs.message.folderMessage;
  } else {
    throw new Error("You need to pass a query or collection");
  }

  this.customColumns = [];
}
GlodaSyntheticView.prototype = {
  defaultSort: [
    [Ci.nsMsgViewSortType.byDate, Ci.nsMsgViewSortOrder.descending],
  ],

  /**
   * Request the search be performed and notification provided to
   *  aSearchListener.  If results are already available, they should
   *  be provided to aSearchListener without re-performing the search.
   */
  search(aSearchListener, aCompletionCallback) {
    this.searchListener = aSearchListener;
    this.completionCallback = aCompletionCallback;

    this.searchListener.onNewSearch();
    if (this.completed) {
      this.reportResults(this.collection.items);
      // we're not really aborting, but it closes things out nicely
      this.abortSearch();
    }
  },

  abortSearch() {
    if (this.searchListener) {
      this.searchListener.onSearchDone(Cr.NS_OK);
    }
    if (this.completionCallback) {
      this.completionCallback();
    }
    this.searchListener = null;
    this.completionCallback = null;
  },

  reportResults(aItems) {
    for (let item of aItems) {
      let hdr = item.folderMessage;
      if (hdr) {
        this.searchListener.onSearchHit(hdr, hdr.folder);
      }
    }
  },

  /**
   * Helper function used by |DBViewWrapper.getMsgHdrForMessageID| since there
   *  are no actual backing folders for it to check.
   */
  getMsgHdrForMessageID(aMessageId) {
    for (let item of this.collection.items) {
      if (item.headerMessageID == aMessageId) {
        let hdr = item.folderMessage;
        if (hdr) {
          return hdr;
        }
      }
    }
    return null;
  },

  /**
   * The default set of columns to show.
   */
  DEFAULT_COLUMN_STATES: {
    threadCol: {
      visible: true,
    },
    flaggedCol: {
      visible: true,
    },
    subjectCol: {
      visible: true,
    },
    correspondentCol: {
      visible: Services.prefs.getBoolPref("mail.threadpane.use_correspondents"),
    },
    senderCol: {
      visible: !Services.prefs.getBoolPref(
        "mail.threadpane.use_correspondents"
      ),
    },
    dateCol: {
      visible: true,
    },
    locationCol: {
      visible: true,
    },
  },

  // --- settings persistence
  getPersistedSetting(aSetting) {
    try {
      return JSON.parse(
        Services.prefs.getCharPref(
          "mailnews.database.global.views." + this.viewType + "." + aSetting
        )
      );
    } catch (e) {
      return this.getDefaultSetting(aSetting);
    }
  },
  setPersistedSetting(aSetting, aValue) {
    Services.prefs.setCharPref(
      "mailnews.database.global.views." + this.viewType + "." + aSetting,
      JSON.stringify(aValue)
    );
  },
  getDefaultSetting(aSetting) {
    if (aSetting == "columns") {
      return this.DEFAULT_COLUMN_STATES;
    }
    return undefined;
  },

  // --- collection listener
  onItemsAdded(aItems, aCollection) {
    if (this.searchListener) {
      this.reportResults(aItems);
    }
  },
  onItemsModified(aItems, aCollection) {},
  onItemsRemoved(aItems, aCollection) {},
  onQueryCompleted(aCollection) {
    this.completed = true;
    if (this.searchListener) {
      this.searchListener.onSearchDone(Cr.NS_OK);
    }
    if (this.completionCallback) {
      this.completionCallback();
    }
  },
};