mirrors/LibHac
1
0
Fork 0
mirror of https://github.com/Thealexbarney/LibHac.git synced 2024-11-14 10:49:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add some docs and fix a permissions logic error

Browse source
This commit is contained in:
Alex Barney 2021-05-31 22:39:27 -07:00
parent b346280bc9
commit f4d6d6b3c8
2 changed files with 53 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
src/LibHac/Fs/Shim/SaveDataManagement.cs
View file

@ -123,6 +123,17 @@ namespace LibHac.Fs.Shim
return Result.Success;
}
/// <summary>
/// Writes the <see cref="SaveDataExtraData.Flags"/> of the provided <see cref="SaveDataExtraData"/>
/// to the save data in the specified <see cref="SaveDataSpaceId"/> with the provided save data ID.
/// </summary>
/// <param name="fs">The <see cref="FileSystemClient"/> to use.</param>
/// <param name="spaceId">The <see cref="SaveDataSpaceId"/> containing the save data to be written to.</param>
/// <param name="saveDataId">The save data ID of the save data to be written to.</param>
/// <param name="extraData">The <see cref="SaveDataExtraData"/> containing the data to write.</param>
/// <returns><see cref="Result.Success"/>: The operation was successful.<br/>
/// <see cref="ResultFs.TargetNotFound"/>: The save data was not found.<br/>
/// <see cref="ResultFs.PermissionDenied"/>: Insufficient permissions.</returns>
public static Result WriteSaveDataFileSystemExtraData(this FileSystemClientImpl fs, SaveDataSpaceId spaceId,
ulong saveDataId, in SaveDataExtraData extraData)
{
@ -134,6 +145,24 @@ namespace LibHac.Fs.Shim
return rc;
}
/// <summary>
/// Writes the provided <paramref name="extraData"/> to the save data in the specified
/// <see cref="SaveDataSpaceId"/> with the provided save data ID.
/// </summary>
/// <param name="fs">The <see cref="FileSystemClient"/> to use.</param>
/// <param name="spaceId">The <see cref="SaveDataSpaceId"/> containing the save data to be written to.</param>
/// <param name="saveDataId">The save data ID of the save data to be written to.</param>
/// <param name="extraData">The <see cref="SaveDataExtraData"/> to write to the save data.</param>
/// <param name="extraDataMask">A mask specifying which bits of <paramref name="extraData"/>
/// to write to the save's extra data. 0 = don't write, 1 = write.</param>
/// <returns><see cref="Result.Success"/>: The operation was successful.<br/>
/// <see cref="ResultFs.TargetNotFound"/>: The save data was not found.<br/>
/// <see cref="ResultFs.PermissionDenied"/>: Insufficient permissions.</returns>
/// <remarks>
/// Calling programs may have permission to write to all, some or none of the save data's extra data.
/// If any bits are set in <paramref name="extraDataMask"/> that the caller does not have the permissions
/// to write to, nothing will be written and <see cref="ResultFs.PermissionDenied"/> will be returned.
/// </remarks>
public static Result WriteSaveDataFileSystemExtraData(this FileSystemClientImpl fs, SaveDataSpaceId spaceId,
ulong saveDataId, in SaveDataExtraData extraData, in SaveDataExtraData extraDataMask)
{
@ -145,6 +174,27 @@ namespace LibHac.Fs.Shim
return rc;
}
/// <summary>
/// Writes the provided <paramref name="extraData"/> to the save data in the specified
/// <see cref="SaveDataSpaceId"/> that matches the provided <see cref="SaveDataAttribute"/> key.
/// The mask specifies which parts of the extra data will be written to the save data.
/// </summary>
/// <param name="fs">The <see cref="FileSystemClient"/> to use.</param>
/// <param name="spaceId">The <see cref="SaveDataSpaceId"/> containing the save data to be written to.</param>
/// <param name="attribute">The key for the save data.</param>
/// <param name="extraData">The <see cref="SaveDataExtraData"/> to write to the save data.</param>
/// <param name="extraDataMask">A mask specifying which bits of <paramref name="extraData"/>
/// to write to the save's extra data. 0 = don't write, 1 = write.</param>
/// <returns><see cref="Result.Success"/>: The operation was successful.<br/>
/// <see cref="ResultFs.TargetNotFound"/>: The save data was not found.<br/>
/// <see cref="ResultFs.PermissionDenied"/>: Insufficient permissions.</returns>
/// <remarks>
/// If <see cref="SaveDataAttribute.ProgramId"/> is set to <see cref="Fs.SaveData.AutoResolveCallerProgramId"/>,
/// the program ID of <paramref name="attribute"/> will be resolved to the default save data program ID of the calling program.<br/>
/// Calling programs may have permission to write to all, some or none of the save data's extra data.
/// If any bits are set in <paramref name="extraDataMask"/> that the caller does not have the permissions
/// to write to, nothing will be written and <see cref="ResultFs.PermissionDenied"/> will be returned.
/// </remarks>
public static Result WriteSaveDataFileSystemExtraData(this FileSystemClientImpl fs, SaveDataSpaceId spaceId,
in SaveDataAttribute attribute, in SaveDataExtraData extraData, in SaveDataExtraData extraDataMask)
{

4
src/LibHac/FsSrv/SaveDataFileSystemService.cs
View file

@ -214,7 +214,9 @@ namespace LibHac.FsSrv
Result rc = GetAccessibilityForSaveData(out Accessibility accessibility, programInfo, extraDataGetter);
if (rc.IsFailure()) return rc;
if (accessibility.CanRead && accessibility.CanWrite)
// Note: This is correct. Even if a program only has read accessibility to another program's save data,
// Nintendo gives it full read/write accessibility as of FS 12.0.0
if (accessibility.CanRead || accessibility.CanWrite)
return Result.Success;
// The program doesn't have permissions for this specific save data. Check if it has overall