jsonrpc: expose profile directory in Profiles.GetCurrentProfile/GetProfiles. #15509 #8196

anaconda · 2015-10-10T22:14:23Z

Bumps version to 7.13.0.

> {"jsonrpc":"2.0","id":1,"method":"Profiles.GetProfiles","params":{"properties":["thumbnail","lockmode","directory"]}}

< {"id":1,"jsonrpc":"2.0","result":{"limits":{"end":2,"start":0,"total":2},"profiles":[{"directory":"special://masterprofile/","label":"Master user","lockmode":0,"thumbnail":""},{"directory":"profiles/prova/","label":"prova","lockmode":0,"thumbnail":""}]}}

@Montellese

cc @MilhouseVH @un1versal

Edit: diff might be confusing - I've inverted the 2 for loops.

MilhouseVH · 2015-10-10T22:20:18Z

Many thanks for this.

However, assuming this is being accessed by a remote script (as it's JSON), I suspect it would be more useful if the returned directory were the real OS directory (ie. /storage/.kodi/userdata/profiles/master) rather than the internal "special://" internal Kodi path - is it possible to translate from Kodi to OS and return the latter?

Edit: The relative directory returned by the prova profile is useful, however the special://masterprofile/ format is not so useful - assuming this is also relative to userdata then it should be translated into profiles/master similar to the prova profile.

anaconda · 2015-10-10T23:28:20Z

Updated as discussed on Slack.

MilhouseVH · 2015-10-11T00:36:32Z

Works perfectly - many thanks!

xbmc/interfaces/json-rpc/ProfilesOperations.cpp

+        }
+        else if (propertyIter->asString() == "directory")
+        {
+          std::string path(CSpecialProtocol::TranslatePath("special://masterprofile"));


Montellese · 2015-10-11T08:20:00Z

Looks good apart from my comment.

anaconda · 2015-10-11T14:11:33Z

Removed the 2 hardcoded special://s.

Tolriq · 2015-10-14T07:35:59Z

Since those folders will not be accessible from remotes after but only from a local script the utility in current form is quite limited :(

Should not the API return the special paths with added things in https://github.com/Xbmc/xbmc/blob/master/xbmc/utils/FileUtils.cpp#L110 to allow remote access (Would allow remotes to finally get the advancedsettings and things like that if they are in profiles).

And eventually, to fit some special needs, a function to translate path added to JSON API?

MilhouseVH · 2015-10-14T11:19:15Z

Since those folders will not be accessible from remotes after but only from a local script the utility in current form is quite limited :(

Yes they will - you can access /storage/.kodi/userdata/advancedsettings.xml (or whatever the actual OS path is) remotely via JSON:

JSON WEB REQUEST: [{"jsonrpc": "2.0", "params": {"path": "/storage/.kodi/userdata/advancedsettings.xml"}, "method": "Files.PrepareDownload", "id": "preparedl"}]
RECEIVED DATA: {"id":"preparedl","jsonrpc":"2.0","result":{"details":{"path":"vfs/%2fstorage%2f.kodi%2fuserdata%2fadvancedsettings.xml"},"mode":"redirect","protocol":"http"}}

then download the path to access the contents of the file, so this should work for you.

Oddly I'm not able to obtain a directory listing using JSON Files.GetDirectory with special://masterprofile/:

JSON SOCKET REQUEST: [{"jsonrpc": "2.0", "params": {"directory": "special://masterprofile/", "media": "files", "properties": ["file", "lastmodified"]}, "method": "Files.GetDirectory", "id": "libDirectory"}]
BUFFER RECEIVED (len 89)
PARSING JSON DATA: {"error":{"code":-32602,"message":"Invalid params."},"id":"libDirectory","jsonrpc":"2.0"}

but /storage/.kodi/userdata is working:

JSON SOCKET REQUEST: [{"jsonrpc": "2.0", "params": {"directory": "/storage/.kodi/userdata", "media": "files", "properties": ["file", "lastmodified"]}, "method": "Files.GetDirectory", "id": "libDirectory"}]
BUFFER RECEIVED (len 2433)
PARSING JSON DATA: {"id":"libDirectory","jsonrpc":"2.0","result":{"files":[{"file":"/storage/.kodi/userdata/peripheral_data/","filetype":"directory","label":"peripheral_data","lastmodified":"2015-07-09 22:41:48","type":"unknown"},{"file":"/storage/.kodi/userdata/playlists/","filetype":"directory","label":"playlists","lastmodified":"2015-07-09 22:30:41","type":"unknown"},{"file":"/storage/.kodi/userdata/sources.xml","filetype":"file","label":"sources.xml","lastmodified":"2015-09-25 22:26:25","type":"unknown"},{"file":"/storage/.kodi/userdata/favourites.xml","filetype":"file","label":"favourites.xml","lastmodified":"2015-09-22 10:33:42","type":"unknown"},{"file":"/storage/.kodi/userdata/guisettings.xml","filetype":"file","label":"guisettings.xml","lastmodified":"2015-10-14 03:41:31","type":"unknown"},{"file":"/storage/.kodi/userdata/library/","filetype":"directory","label":"library","lastmodified":"2015-07-09 22:30:41","type":"unknown"},{"file":"/storage/.kodi/userdata/profiles/","filetype":"directory","label":"profiles","lastmodified":"2015-10-11 00:56:06","type":"unknown"},{"file":"/storage/.kodi/userdata/RssFeeds.xml","filetype":"file","label":"RssFeeds.xml","lastmodified":"2015-10-13 21:35:16","type":"unknown"},{"file":"/storage/.kodi/userdata/passwords.xml","filetype":"file","label":"passwords.xml","lastmodified":"2015-07-09 22:41:18","type":"unknown"},{"file":"/storage/.kodi/userdata/advancedsettings.xml","filetype":"file","label":"advancedsettings.xml","lastmodified":"2015-08-19 02:25:19","type":"unknown"},{"file":"/storage/.kodi/userdata/keymaps/","filetype":"directory","label":"keymaps","lastmodified":"2015-08-20 20:44:42","type":"unknown"},{"file":"/storage/.kodi/userdata/profiles.xml","filetype":"file","label":"profiles.xml","lastmodified":"2015-10-14 03:41:31","type":"unknown"},{"file":"/storage/.kodi/userdata/Thumbnails/","filetype":"directory","label":"Thumbnails","lastmodified":"2015-07-10 03:53:26","type":"unknown"},{"file":"/storage/.kodi/userdata/guisettings.xml.keep","filetype":"file","label":"guisettings.xml.keep","lastmodified":"2015-07-10 18:30:46","type":"unknown"},{"file":"/storage/.kodi/userdata/Database/","filetype":"directory","label":"Database","lastmodified":"2015-10-14 07:14:19","type":"unknown"},{"file":"/storage/.kodi/userdata/addon_data/","filetype":"directory","label":"addon_data","lastmodified":"2015-10-03 16:42:14","type":"unknown"}],"limits":{"end":16,"start":0,"total":16}}}

so in some cases there is more utility from the OS directories than there is from the special:// directories, and this should work for you as it will for me.

That said, I'd have no objection if this method returned special:// notation provided there is another field with the translated "OS" equivalent, or there is a method to translate from special:// to OS native.

Tolriq · 2015-10-14T12:35:18Z

This is more complicated as explained in the link I gave earlier ;)

The fact that PrepareDownload returns something does not mean you have access to it as security are not checked in it.

By default from JSON you have no access to files except those explicit declared at : https://github.com/Xbmc/xbmc/blob/master/xbmc/utils/FileUtils.cpp#L110

Or sources with the allowSharing at true and not locked.

This means this is normal you can not browse special://masterprofile or any profile. And should not be able to browse real profile directory too.

So either you have a source pointing to that or

 {
    std::string strPlaylistsPath = CSettings::GetInstance().GetString(CSettings::SETTING_SYSTEM_PLAYLISTSPATH);
    URIUtils::RemoveSlashAtEnd(strPlaylistsPath);
    if (StringUtils::StartsWithNoCase(realPath, strPlaylistsPath)) 
      return true;
  }

Is triggered when accessing those folders, and IMO it should not as security risk.

I added the allowSharing to sources and fixed the FileUtils too, so have a little background on how this part works.

Maybe @Montellese can comment on the CSettings::SETTING_SYSTEM_PLAYLISTSPATH part that maybe opens full access to profiles. (But what profiles : connected one, all, none ?)

MilhouseVH · 2015-10-14T13:01:37Z

And should not be able to browse real profile directory too.

Yeah, true - I had previously added /storage to my sources.xml and forgotten all about it... with this source disabled, /storage/.kodi/userdata is no longer accessible, so now behaves the same as special://masterprofile/.

If the security is relaxed to allow special:// access via JSON then I'm happy for this method to return directory paths using the special:// notation, but I'd also require a method to translate these special:// paths into OS native paths.

However if there are no plans to relax the security around special:// access then it's a moot point and this method and PR may as well stay as it currently is, returning OS native paths.

Tolriq · 2015-10-14T13:16:15Z

Well seeing how many things where not included because they are not perfect, adding something that can't be used by vast majority seems a little premature, but well I'm not in charge (But decision coherence should prevail) ;)

I have no problem about special or real path (even if real path can leads to some security concerns, but there's so many others in Kodi).

But whatever path is returned, IMO if there's no access from remotes then it should not be present.

Your use case is very very specific and potentially dangerous, accessing data from a non loaded profile that could have a settings to not enable web server for security reason should not be possible.

And think about problems accessing files like passwords.xml.

Anyway as I said not my call, just bringing some knowledge here.

MilhouseVH · 2015-10-14T13:36:23Z

All my niche case requires is the profile directory name relative to userdata, which I can determine from even the special:// notation, so if this PR can return paths using special:// notation (and not OS native paths - sorry for messing you around, @anaconda) then it should work just fine for both of us, for example special://masterprofile/ => "" and special://masterprofile/profiles/Test_123/ => profiles/Test_123/ will still work for me.

Of course the fact the special:// directories remain inaccessible via JSON is a completely different issue.

un1versal · 2015-10-27T15:39:08Z

@MilhouseVH this works here. @anaconda thx.

razzeee · 2015-11-23T19:19:09Z

Linked this to the corresponding trac ticket
http://trac.kodi.tv/ticket/15509

anaconda · 2015-11-24T21:01:01Z

Added fixup commit to return the special:// path as Milhouse seems happy with it too.
This would return something like:

> {"jsonrpc":"2.0","id":1,"method":"Profiles.GetProfiles","params":{"properties":["thumbnail","lockmode","directory"]}}
< {"id":1,"jsonrpc":"2.0","result":{"limits":{"end":2,"start":0,"total":2},"profiles":[{"directory":"special://masterprofile/","label":"Master user","lockmode":0,"thumbnail":""},{"directory":"special://masterprofile/profiles/prova/","label":"prova","lockmode":0,"thumbnail":""}]}}

anaconda · 2015-12-04T18:00:47Z

@Montellese any chance to get your final ACK before entering RC?

MartijnKaijser · 2015-12-23T20:54:11Z

@Montellese for merge approval

Fixes xbmc#15509

Rechi · 2017-09-27T10:11:44Z

@menakite any plans to revisit this?

jenkins4kodi · 2017-11-19T16:00:31Z

@anaconda this needs a rebase

MartijnKaijser · 2018-06-24T06:57:51Z

I will close this PR. If there's interest please open a new one (with required changes if needed).

anaconda force-pushed the json-profile-directory branch 2 times, most recently from a3316a0 to 784b9c4 Compare October 10, 2015 23:27

MilhouseVH mentioned this pull request Oct 11, 2015

json profiles MilhouseVH/texturecache.py#30

Closed

Montellese added the API change label Oct 11, 2015

Montellese reviewed Oct 11, 2015
View reviewed changes

xbmc/interfaces/json-rpc/ProfilesOperations.cpp

}

else if (propertyIter->asString() == "directory")

{

std::string path(CSpecialProtocol::TranslatePath("special://masterprofile"));

This comment was marked as spam.

Sign in to view

anaconda force-pushed the json-profile-directory branch from 784b9c4 to 2c035fa Compare October 11, 2015 14:09

anaconda force-pushed the json-profile-directory branch from 2c035fa to c84abcd Compare October 22, 2015 23:51

razzeee added API change: JSON-RPC Component: Profiles and removed API change labels Oct 23, 2015

anaconda force-pushed the json-profile-directory branch from c84abcd to 1dc7948 Compare October 31, 2015 18:43

anaconda force-pushed the json-profile-directory branch from 1dc7948 to 05748df Compare November 8, 2015 17:31

razzeee changed the title ~~jsonrpc: expose profile directory in Profiles.GetCurrentProfile/GetProfiles.~~ jsonrpc: expose profile directory in Profiles.GetCurrentProfile/GetProfiles. #15509 Nov 23, 2015

anaconda force-pushed the json-profile-directory branch 2 times, most recently from c677989 to b257dac Compare November 24, 2015 20:56

anaconda force-pushed the json-profile-directory branch from b257dac to 957cf43 Compare December 3, 2015 05:34

anaconda force-pushed the json-profile-directory branch from 957cf43 to ede5f6f Compare December 6, 2015 19:56

anaconda force-pushed the json-profile-directory branch 4 times, most recently from 7ce49e0 to 5c4b211 Compare December 30, 2015 18:50

anaconda force-pushed the json-profile-directory branch 3 times, most recently from bfba81b to 162921a Compare January 10, 2016 19:29

anaconda force-pushed the json-profile-directory branch 2 times, most recently from 06d1602 to 42a8318 Compare January 17, 2016 22:49

anaconda force-pushed the json-profile-directory branch from 42a8318 to cc26720 Compare January 24, 2016 18:35

anaconda force-pushed the json-profile-directory branch from cc26720 to 568b99b Compare February 3, 2016 11:55

anaconda force-pushed the json-profile-directory branch from 568b99b to ea96573 Compare February 15, 2016 21:22

anaconda force-pushed the json-profile-directory branch from ea96573 to 19b2d63 Compare April 5, 2016 19:52

jsonrpc: expose profile directory in Profiles methods.

3e534c9

Fixes xbmc#15509

anaconda force-pushed the json-profile-directory branch from 19b2d63 to 3e534c9 Compare May 7, 2016 14:56

jenkins4kodi added the Rebase needed PR that does not apply/merge cleanly to current base branch label Nov 19, 2017

MartijnKaijser added this to the Abandoned, obsolete or superseeded milestone Jun 24, 2018

MartijnKaijser closed this Jun 24, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

jsonrpc: expose profile directory in Profiles.GetCurrentProfile/GetProfiles. #15509 #8196

jsonrpc: expose profile directory in Profiles.GetCurrentProfile/GetProfiles. #15509 #8196

anaconda commented Oct 10, 2015

MilhouseVH commented Oct 10, 2015

anaconda commented Oct 10, 2015

MilhouseVH commented Oct 11, 2015

This comment was marked as spam.

Montellese commented Oct 11, 2015

anaconda commented Oct 11, 2015

Tolriq commented Oct 14, 2015

MilhouseVH commented Oct 14, 2015

Tolriq commented Oct 14, 2015

MilhouseVH commented Oct 14, 2015

Tolriq commented Oct 14, 2015

MilhouseVH commented Oct 14, 2015

un1versal commented Oct 27, 2015

razzeee commented Nov 23, 2015

anaconda commented Nov 24, 2015

anaconda commented Dec 4, 2015

MartijnKaijser commented Dec 23, 2015

Rechi commented Sep 27, 2017

jenkins4kodi commented Nov 19, 2017

MartijnKaijser commented Jun 24, 2018

jsonrpc: expose profile directory in Profiles.GetCurrentProfile/GetProfiles. #15509 #8196

jsonrpc: expose profile directory in Profiles.GetCurrentProfile/GetProfiles. #15509 #8196

Conversation

anaconda commented Oct 10, 2015

MilhouseVH commented Oct 10, 2015

anaconda commented Oct 10, 2015

MilhouseVH commented Oct 11, 2015

This comment was marked as spam.

Montellese commented Oct 11, 2015

anaconda commented Oct 11, 2015

Tolriq commented Oct 14, 2015

MilhouseVH commented Oct 14, 2015

Tolriq commented Oct 14, 2015

MilhouseVH commented Oct 14, 2015

Tolriq commented Oct 14, 2015

MilhouseVH commented Oct 14, 2015

un1versal commented Oct 27, 2015

razzeee commented Nov 23, 2015

anaconda commented Nov 24, 2015

anaconda commented Dec 4, 2015

MartijnKaijser commented Dec 23, 2015

Rechi commented Sep 27, 2017

jenkins4kodi commented Nov 19, 2017

MartijnKaijser commented Jun 24, 2018