summaryrefslogtreecommitdiffstats
path: root/comm/mail/modules/FolderTreeProperties.jsm
blob: 6931c2794acc37f824bd43e24708ecb971909bad (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
/* 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/. */

/**
 * Persistent storage for various properties of items on the folder tree.
 * Data is serialised to the file folderTree.json in the profile directory.
 */

const EXPORTED_SYMBOLS = ["FolderTreeProperties"];

const { JSONFile } = ChromeUtils.importESModule(
  "resource://gre/modules/JSONFile.sys.mjs"
);

var jsonFile = new JSONFile({
  path: PathUtils.join(PathUtils.profileDir, "folderTree.json"),
});
var readyPromise = jsonFile.load();

function ensureReady() {
  if (!jsonFile.dataReady) {
    throw new Error("Folder tree properties cache not ready.");
  }
}

var FolderTreeProperties = {
  get ready() {
    return readyPromise;
  },

  /**
   * Get the colour associated with a folder.
   *
   * @param {string} folderURI
   * @returns {?string}
   */
  getColor(folderURI) {
    ensureReady();
    return jsonFile.data.colors?.[folderURI];
  },

  /**
   * Set the colour associated with a folder.
   *
   * @param {string} folderURI
   * @param {string} color
   */
  setColor(folderURI, color) {
    ensureReady();
    jsonFile.data.colors = jsonFile.data.colors ?? {};
    jsonFile.data.colors[folderURI] = color;
    jsonFile.saveSoon();
  },

  resetColors() {
    ensureReady();
    delete jsonFile.data.colors;
    jsonFile.saveSoon();
  },

  getIsExpanded(folderURI, mode) {
    ensureReady();
    if (!Array.isArray(jsonFile.data.open?.[mode])) {
      return false;
    }
    return jsonFile.data.open[mode].includes(folderURI);
  },

  setIsExpanded(folderURI, mode, isExpanded) {
    ensureReady();
    jsonFile.data.open = jsonFile.data.open ?? {};
    jsonFile.data.open[mode] = jsonFile.data.open[mode] ?? [];
    let index = jsonFile.data.open[mode].indexOf(folderURI);
    if (isExpanded) {
      if (index < 0) {
        jsonFile.data.open[mode].push(folderURI);
      }
    } else if (index >= 0) {
      jsonFile.data.open[mode].splice(index, 1);
    }
    jsonFile.saveSoon();
  },
};