1890352 - Add nsIDirectoryService system entry for the OS's Documents folder

Status: RESOLVED FIXED

(Core :: XPCOM, enhancement)

Description

[Mike Conley (:mconley) (:⚙️)]

There are certain things we'd like to offer to save in the user's Documents folder. I'd like to add an entry like this one, but for "Docs".

David Rubino dug out how we can ask the OS for this path.

On Windows, we can call SHGetKnownFolderPath(FOLDERID_Documents).
On macOS, we can call NSSearchPathForDirectoriesInDomains(NSDocumentDirectory)
On Linux, we can use the $XDG_DOCUMENTS_DIR variable in ~/.config/user-dirs.dirs, or if that doesn’t exist, use $HOME/Documents.

Comment 1

[Mike Conley (:mconley) (:⚙️)]

It looks like we actually used to have some limited support for the documents folder, at least on Windows and Linux. I'm not entirely certain if macOS ever had it implemented. Anyhow, support for this folder was removed in bug 1449686 as part of a broader initiative to cleanup unused special directories from the directory service.

I guess we're at a point now where we have a use case and can add the documents folders back.

Comment 2

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1890352 - Add OS Documents folder to nsIDirectoryService. r?#xpcom-reviewers!

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1ebb69c4b2f0
Add OS Documents folder to nsIDirectoryService. r=xpcom-reviewers,nika

Comment 4

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/1ebb69c4b2f0