JDM170/SteamAchievementManager
1
0
Fork 0
mirror of https://github.com/JDM170/SteamAchievementManager synced 2025-12-10 05:37:18 +07:00
Code Issues Packages Projects Releases Wiki Activity

Properly handle encoding of strings in Steam API. Fixes #5.

Browse Source
This commit is contained in:
gibbed
2017-11-14 14:02:25 -06:00
parent 8e48814f77
commit cbef61fc2a
7 changed files with 285 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
SAM.API/NativeStrings.cs Normal file
View File

@@ -0,0 +1,141 @@
/* Copyright (c) 2017 Rick (rick 'at' gibbed 'dot' us)
*
* This software is provided 'as-is', without any express or implied
* warranty. In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software
* in a product, an acknowledgment in the product documentation would
* be appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not
* be misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source
* distribution.
*/
using System;
using System.Runtime.InteropServices;
using System.Text;
using Microsoft.Win32.SafeHandles;
namespace SAM.API
{
internal class NativeStrings
{
public sealed class StringHandle : SafeHandleZeroOrMinusOneIsInvalid
{
internal StringHandle(IntPtr preexistingHandle, bool ownsHandle)
: base(ownsHandle)
{
this.SetHandle(preexistingHandle);
}
public IntPtr Handle
{
get { return this.handle; }
}
protected override bool ReleaseHandle()
{
if (handle != IntPtr.Zero)
{
Marshal.FreeHGlobal(handle);
handle = IntPtr.Zero;
return true;
}
return false;
}
}
public static unsafe StringHandle StringToStringHandle(string value)
{
if (value == null)
{
return new StringHandle(IntPtr.Zero, true);
}
var bytes = Encoding.UTF8.GetBytes(value);
var length = bytes.Length;
var p = Marshal.AllocHGlobal(length + 1);
Marshal.Copy(bytes, 0, p, bytes.Length);
((byte*)p)[length] = 0;
return new StringHandle(p, true);
}
public static unsafe string PointerToString(sbyte* bytes)
{
if (bytes == null)
{
return null;
}
int running = 0;
var b = bytes;
if (*b == 0)
{
return string.Empty;
}
while ((*b++) != 0)
{
running++;
}
return new string(bytes, 0, running, Encoding.UTF8);
}
public static unsafe string PointerToString(byte* bytes)
{
return PointerToString((sbyte*)bytes);
}
public static unsafe string PointerToString(IntPtr nativeData)
{
return PointerToString((sbyte*)nativeData.ToPointer());
}
public static unsafe string PointerToString(sbyte* bytes, int length)
{
if (bytes == null)
{
return null;
}
int running = 0;
var b = bytes;
if (length == 0 || *b == 0)
{
return string.Empty;
}
while ((*b++) != 0 &&
running < length)
{
running++;
}
return new string(bytes, 0, running, Encoding.UTF8);
}
public static unsafe string PointerToString(byte* bytes, int length)
{
return PointerToString((sbyte*)bytes, length);
}
public static unsafe string PointerToString(IntPtr nativeData, int length)
{
return PointerToString((sbyte*)nativeData.ToPointer(), length);
}
}
}

3
SAM.API/SAM.API.csproj
View File

@@ -39,6 +39,7 @@
<WarningLevel>4</WarningLevel>
<PlatformTarget>x86</PlatformTarget>
<CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>none</DebugType>
@@ -50,6 +51,7 @@
<PlatformTarget>x86</PlatformTarget>
<UseVSHostingProcess>false</UseVSHostingProcess>
<CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
</PropertyGroup>
<ItemGroup>
<Reference Include="System" />
@@ -69,6 +71,7 @@
<Compile Include="Callbacks\AppDataChanged.cs" />
<Compile Include="Callbacks\UserStatsReceived.cs" />
<Compile Include="ICallback.cs" />
<Compile Include="NativeStrings.cs" />
<Compile Include="Types\CallbackMessage.cs" />
<Compile Include="Wrappers\SteamUserStats007.cs" />
<Compile Include="Types\AccountType.cs" />

22
SAM.API/Wrappers/SteamApps001.cs
View File

@@ -22,7 +22,6 @@
using System;
using System.Runtime.InteropServices;
using System.Text;
using SAM.API.Interfaces;
namespace SAM.API.Wrappers
@@ -34,22 +33,27 @@ namespace SAM.API.Wrappers
private delegate int NativeGetAppData(
IntPtr self,
uint appId,
string key,
StringBuilder valueBuffer,
IntPtr key,
IntPtr value,
int valueLength);
public string GetAppData(uint appId, string key)
{
var sb = new StringBuilder();
sb.EnsureCapacity(1024);
using (var nativeHandle = NativeStrings.StringToStringHandle(key))
{
const int valueLength = 1024;
var valuePointer = Marshal.AllocHGlobal(valueLength);
int result = this.Call<int, NativeGetAppData>(
this.Functions.GetAppData,
this.ObjectAddress,
appId,
key,
sb,
sb.Capacity);
return result == 0 ? null : sb.ToString();
nativeHandle.Handle,
valuePointer,
valueLength);
var value = result == 0 ? null : NativeStrings.PointerToString(valuePointer, valueLength);
Marshal.FreeHGlobal(valuePointer);
return value;
}
}
#endregion
}

2
SAM.API/Wrappers/SteamApps003.cs
View File

@@ -48,7 +48,7 @@ namespace SAM.API.Wrappers
var languagePointer = this.Call<IntPtr, NativeGetCurrentGameLanguage>(
this.Functions.GetCurrentGameLanguage,
this.ObjectAddress);
return Marshal.PtrToStringAnsi(languagePointer);
return NativeStrings.PointerToString(languagePointer);
}
#endregion
}

32
SAM.API/Wrappers/SteamClient009.cs
View File

@@ -95,21 +95,24 @@ namespace SAM.API.Wrappers
#region GetISteamUser
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
private delegate IntPtr NativeGetISteamUser(IntPtr self, int user, int pipe, string version);
private delegate IntPtr NativeGetISteamUser(IntPtr self, int user, int pipe, IntPtr version);
private TClass GetISteamUser<TClass>(int user, int pipe, string version)
where TClass : INativeWrapper, new()
{
using (var nativeVersion = NativeStrings.StringToStringHandle(version))
{
IntPtr address = this.Call<IntPtr, NativeGetISteamUser>(
this.Functions.GetISteamUser,
this.ObjectAddress,
user,
pipe,
version);
nativeVersion.Handle);
var result = new TClass();
result.SetupFunctions(address);
return result;
}
}
#endregion
#region GetSteamUser012
@@ -121,21 +124,24 @@ namespace SAM.API.Wrappers
#region GetISteamUserStats
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
private delegate IntPtr NativeGetISteamUserStats(IntPtr self, int user, int pipe, string version);
private delegate IntPtr NativeGetISteamUserStats(IntPtr self, int user, int pipe, IntPtr version);
private TClass GetISteamUserStats<TClass>(int user, int pipe, string version)
where TClass : INativeWrapper, new()
{
using (var nativeVersion = NativeStrings.StringToStringHandle(version))
{
IntPtr address = this.Call<IntPtr, NativeGetISteamUserStats>(
this.Functions.GetISteamUserStats,
this.ObjectAddress,
user,
pipe,
version);
nativeVersion.Handle);
var result = new TClass();
result.SetupFunctions(address);
return result;
}
}
#endregion
#region GetSteamUserStats007
@@ -147,20 +153,23 @@ namespace SAM.API.Wrappers
#region GetISteamUtils
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
private delegate IntPtr NativeGetISteamUtils(IntPtr self, int pipe, string version);
private delegate IntPtr NativeGetISteamUtils(IntPtr self, int pipe, IntPtr version);
public TClass GetISteamUtils<TClass>(int pipe, string version)
where TClass : INativeWrapper, new()
{
using (var nativeVersion = NativeStrings.StringToStringHandle(version))
{
IntPtr address = this.Call<IntPtr, NativeGetISteamUtils>(
this.Functions.GetISteamUtils,
this.ObjectAddress,
pipe,
version);
nativeVersion.Handle);
var result = new TClass();
result.SetupFunctions(address);
return result;
}
}
#endregion
#region GetSteamUtils004
@@ -171,16 +180,23 @@ namespace SAM.API.Wrappers
#endregion
#region GetISteamApps
private delegate IntPtr NativeGetISteamApps(int user, int pipe, string version);
private delegate IntPtr NativeGetISteamApps(int user, int pipe, IntPtr version);
private TClass GetISteamApps<TClass>(int user, int pipe, string version)
where TClass : INativeWrapper, new()
{
IntPtr address = this.Call<IntPtr, NativeGetISteamApps>(this.Functions.GetISteamApps, user, pipe, version);
using (var nativeVersion = NativeStrings.StringToStringHandle(version))
{
IntPtr address = this.Call<IntPtr, NativeGetISteamApps>(
this.Functions.GetISteamApps,
user,
pipe,
nativeVersion.Handle);
var result = new TClass();
result.SetupFunctions(address);
return result;
}
}
#endregion
#region GetSteamApps001

72
SAM.API/Wrappers/SteamUserStats007.cs
View File

@@ -42,55 +42,67 @@ namespace SAM.API.Wrappers
#region GetStatValue (int)
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
[return: MarshalAs(UnmanagedType.I1)]
private delegate bool NativeGetStatInt(IntPtr self, string name, out int data);
private delegate bool NativeGetStatInt(IntPtr self, IntPtr name, out int data);
public bool GetStatValue(string name, out int value)
{
using (var nativeName = NativeStrings.StringToStringHandle(name))
{
var call = this.GetFunction<NativeGetStatInt>(this.Functions.GetStatInteger);
return call(this.ObjectAddress, name, out value);
return call(this.ObjectAddress, nativeName.Handle, out value);
}
}
#endregion
#region GetStatValue (float)
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
[return: MarshalAs(UnmanagedType.I1)]
private delegate bool NativeGetStatFloat(IntPtr self, string name, out float data);
private delegate bool NativeGetStatFloat(IntPtr self, IntPtr name, out float data);
public bool GetStatValue(string name, out float value)
{
using (var nativeName = NativeStrings.StringToStringHandle(name))
{
var call = this.GetFunction<NativeGetStatFloat>(this.Functions.GetStatFloat);
return call(this.ObjectAddress, name, out value);
return call(this.ObjectAddress, nativeName.Handle, out value);
}
}
#endregion
#region SetStatValue (int)
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
[return: MarshalAs(UnmanagedType.I1)]
private delegate bool NativeSetStatInt(IntPtr self, string name, int data);
private delegate bool NativeSetStatInt(IntPtr self, IntPtr name, int data);
public bool SetStatValue(string name, int value)
{
using (var nativeName = NativeStrings.StringToStringHandle(name))
{
return this.Call<bool, NativeSetStatInt>(
this.Functions.SetStatInteger,
this.ObjectAddress,
name,
nativeName.Handle,
value);
}
}
#endregion
#region SetStatValue (float)
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
[return: MarshalAs(UnmanagedType.I1)]
private delegate bool NativeSetStatFloat(IntPtr self, string name, float data);
private delegate bool NativeSetStatFloat(IntPtr self, IntPtr name, float data);
public bool SetStatValue(string name, float value)
{
using (var nativeName = NativeStrings.StringToStringHandle(name))
{
return this.Call<bool, NativeSetStatFloat>(
this.Functions.SetStatFloat,
this.ObjectAddress,
name,
nativeName.Handle,
value);
}
}
#endregion
#region GetAchievement
@@ -98,33 +110,45 @@ namespace SAM.API.Wrappers
[return: MarshalAs(UnmanagedType.I1)]
private delegate bool NativeGetAchievement(
IntPtr self,
string name,
IntPtr name,
[MarshalAs(UnmanagedType.I1)] out bool isAchieved);
public bool GetAchievementState(string name, out bool isAchieved)
{
using (var nativeName = NativeStrings.StringToStringHandle(name))
{
var call = this.GetFunction<NativeGetAchievement>(this.Functions.GetAchievement);
return call(this.ObjectAddress, name, out isAchieved);
return call(this.ObjectAddress, nativeName.Handle, out isAchieved);
}
}
#endregion
#region SetAchievementState
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
[return: MarshalAs(UnmanagedType.I1)]
private delegate bool NativeSetAchievement(IntPtr self, string name);
private delegate bool NativeSetAchievement(IntPtr self, IntPtr name);
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
[return: MarshalAs(UnmanagedType.I1)]
private delegate bool NativeClearAchievement(IntPtr self, string name);
private delegate bool NativeClearAchievement(IntPtr self, IntPtr name);
public bool SetAchievement(string name, bool state)
{
using (var nativeName = NativeStrings.StringToStringHandle(name))
{
if (state == false)
{
return this.Call<bool, NativeClearAchievement>(this.Functions.ClearAchievement, this.ObjectAddress, name);
return this.Call<bool, NativeClearAchievement>(
this.Functions.ClearAchievement,
this.ObjectAddress,
nativeName.Handle);
}
return this.Call<bool, NativeSetAchievement>(this.Functions.SetAchievement, this.ObjectAddress, name);
return this.Call<bool, NativeSetAchievement>(
this.Functions.SetAchievement,
this.ObjectAddress,
nativeName.Handle);
}
}
#endregion
@@ -141,28 +165,36 @@ namespace SAM.API.Wrappers
#region GetAchievementIcon
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
private delegate int NativeGetAchievementIcon(IntPtr self, string name);
private delegate int NativeGetAchievementIcon(IntPtr self, IntPtr name);
public int GetAchievementIcon(string name)
{
using (var nativeName = NativeStrings.StringToStringHandle(name))
{
return this.Call<int, NativeGetAchievementIcon>(
this.Functions.GetAchievementIcon,
this.ObjectAddress,
name);
nativeName.Handle);
}
}
#endregion
#region GetAchievementDisplayAttribute
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
private delegate string NativeGetAchievementDisplayAttribute(IntPtr self, string name, string key);
private delegate IntPtr NativeGetAchievementDisplayAttribute(IntPtr self, IntPtr name, IntPtr key);
public string GetAchievementDisplayAttribute(string name, string key)
{
return this.Call<string, NativeGetAchievementDisplayAttribute>(
using (var nativeName = NativeStrings.StringToStringHandle(name))
using (var nativeKey = NativeStrings.StringToStringHandle(key))
{
var result = this.Call<IntPtr, NativeGetAchievementDisplayAttribute>(
this.Functions.GetAchievementDisplayAttribute,
this.ObjectAddress,
name,
key);
nativeName.Handle,
nativeKey.Handle);
return NativeStrings.PointerToString(result);
}
}
#endregion

5
SAM.API/Wrappers/SteamUtils005.cs
View File

@@ -40,11 +40,12 @@ namespace SAM.API.Wrappers
#region GetIPCountry
[UnmanagedFunctionPointer(CallingConvention.ThisCall)]
private delegate string NativeGetIPCountry(IntPtr self);
private delegate IntPtr NativeGetIPCountry(IntPtr self);
public string GetIPCountry()
{
return this.Call<string, NativeGetIPCountry>(this.Functions.GetIPCountry, this.ObjectAddress);
var result = this.Call<IntPtr, NativeGetIPCountry>(this.Functions.GetIPCountry, this.ObjectAddress);
return NativeStrings.PointerToString(result);
}
#endregion