958354 - OS.Constants.Path should expose UAppData

Status: RESOLVED FIXED

(Toolkit Graveyard :: OS.File, defect)

Description

[Gregory Szorc [:gps]]

AFAICT OS.Constants.Path doesn't expose UAppData (XRE_USER_APP_DATA_DIR). This is preventing porting some nsIFile code to use OS.Path.

Comment 1

[David Teller [:Yoric] - still alive but not very active]

This should be pretty easy.

The file to modify is dom/system/OSFileConstants.cpp. The code will be very similar to the existing code that defines OS.Constants.Path.desktopDir from key NS_OS_DESKTOP_DIR, except we would define OS.Constants.Path.userApplicationDataDir from key XRE_USER_APP_DATA_DIR.

Comment 2

[Sumit Agrawal[:sumit4iit]]

Attachment: 958354

Is this the correct way?

Comment 3

[Sumit Agrawal[:sumit4iit]]

Attachment: 958354

Comment 4

[David Teller [:Yoric] - still alive but not very active]

Comment on attachment 8358614 [details] [diff] [review]
958354

Review of attachment 8358614 [details] [diff] [review]:
-----------------------------------------------------------------

Looks good, thanks.

::: dom/system/OSFileConstants.cpp
@@ +91,5 @@
>     * The user's desktop directory, if there is one. Otherwise this is
>     * the same as homeDir.
>     */
>    nsString desktopDir;
> +  nsString userApplicationDataDir;

Documentation would be nice.

Comment 5

[Sumit Agrawal[:sumit4iit]]

Attachment: 958354

Added documentation.

Comment 6

[David Teller [:Yoric] - still alive but not very active]

Comment on attachment 8358784 [details] [diff] [review]
958354

Review of attachment 8358784 [details] [diff] [review]:
-----------------------------------------------------------------

Looks good.
Before r+-ing, I'd like a test.
Could you add one here? http://dxr.mozilla.org/mozilla-central/source/toolkit/components/osfile/tests/xpcshell/test_path_constants.js

::: dom/system/OSFileConstants.cpp
@@ +103,5 @@
> +   *   UAppData = $HOME/.[$vendor/]$name
> +   *
> +   * Mac:
> +   *   HOME = ~
> +   *   UAppData = $HOME/Library/Application Support/$name

I suspect that it doesn't exist under Android. Is there a way you could check?

@@ +875,5 @@
>      return false;
>    }
>  
> +  if (!SetStringProperty(cx, objPath, "userApplicationDataDir", gPaths->userApplicationDataDir)) {
> +	return false;

Nit: Too many spaces before the |return false|.

Comment 7

[Sumit Agrawal[:sumit4iit]]

while going through code I realized that in
http://dxr.mozilla.org/mozilla-central/source/dom/system/OSFileConstants.cpp#221
|"XpcomLib"| is hard coded. Should I change it to | NS_XPCOM_LIBRARY_FILE | as defined in http://dxr.mozilla.org/mozilla-central/source/xpcom/io/nsDirectoryServiceDefs.h#46 ? Is it ok to do this sort of corrections, or do we need to file new bug for that?

Comment 8

[Sumit Agrawal[:sumit4iit]]

Attachment: added test

Comment 9

[David Teller [:Yoric] - still alive but not very active]

(In reply to Sumit Agrawal[:sumit4iit] from comment #7)
> while going through code I realized that in
> http://dxr.mozilla.org/mozilla-central/source/dom/system/OSFileConstants.
> cpp#221
> |"XpcomLib"| is hard coded. Should I change it to | NS_XPCOM_LIBRARY_FILE |
> as defined in
> http://dxr.mozilla.org/mozilla-central/source/xpcom/io/
> nsDirectoryServiceDefs.h#46 ? Is it ok to do this sort of corrections, or do
> we need to file new bug for that?

You can do it if you want.

Comment 10

[Sumit Agrawal[:sumit4iit]]

Attachment: 958354

Comment 11

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/fx-team/rev/119bc5f18a07

Comment 12

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/119bc5f18a07