Skip to content

Commit eecfc8f

Browse files
pruizpruiz
committed
Updated to wkhtmltopdf v0.11.0rc2 and refactor of native calls to its own class, along with some marshalling improvements.
1 parent 4c91473 commit eecfc8f

11 files changed

+509
-346
lines changed

‎.nuget/packages.config

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<packages>
33
<package id="NuGet.CommandLine" version="2.1.0" />
4+
<package id="NUnit.Runners" version="2.6.3" />
45
</packages>

‎WkHtmlToXSharp.Tests/WkHtmlToXSharp.Tests.csproj

+8-8
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@
3333
<UseApplicationTrust>false</UseApplicationTrust>
3434
<BootstrapperEnabled>true</BootstrapperEnabled>
3535
<TargetFrameworkProfile />
36+
<SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\</SolutionDir>
37+
<RestorePackages>true</RestorePackages>
3638
</PropertyGroup>
3739
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
3840
<DebugSymbols>true</DebugSymbols>
@@ -52,6 +54,7 @@
5254
<ErrorReport>prompt</ErrorReport>
5355
<WarningLevel>4</WarningLevel>
5456
<CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
57+
<PlatformTarget>AnyCPU</PlatformTarget>
5558
</PropertyGroup>
5659
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Debug|x86'">
5760
<DebugSymbols>true</DebugSymbols>
@@ -89,21 +92,16 @@
8992
<Reference Include="Common.Logging">
9093
<HintPath>..\Libs\Common.Logging.dll</HintPath>
9194
</Reference>
92-
<Reference Include="nunit.core">
93-
<HintPath>..\Libs\nunit.core.dll</HintPath>
94-
</Reference>
95-
<Reference Include="nunit.framework">
96-
<HintPath>..\Libs\nunit.framework.dll</HintPath>
95+
<Reference Include="nunit.framework, Version=2.6.3.13283, Culture=neutral, PublicKeyToken=96d09a1eb7f44a77, processorArchitecture=MSIL">
96+
<SpecificVersion>False</SpecificVersion>
97+
<HintPath>..\packages\NUnit.2.6.3\lib\nunit.framework.dll</HintPath>
9798
</Reference>
9899
<Reference Include="System" />
99100
<Reference Include="System.Data" />
100101
<Reference Include="System.Xml" />
101102
<Reference Include="System.Core">
102103
<RequiredTargetFramework>3.5</RequiredTargetFramework>
103104
</Reference>
104-
<Reference Include="System.Xml.Linq">
105-
<RequiredTargetFramework>3.5</RequiredTargetFramework>
106-
</Reference>
107105
</ItemGroup>
108106
<ItemGroup>
109107
<Compile Include="Properties\AssemblyInfo.cs" />
@@ -145,9 +143,11 @@
145143
</ItemGroup>
146144
<ItemGroup>
147145
<None Include="App.config" />
146+
<None Include="packages.config" />
148147
<None Include="Resources\page.xhtml" />
149148
</ItemGroup>
150149
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
150+
<Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
151151
<!-- To modify your build process, add your task inside one of the targets below and uncomment it.
152152
Other similar extension points exist, see Microsoft.Common.targets.
153153
<Target Name="BeforeBuild">

‎WkHtmlToXSharp.Tests/packages.config

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<packages>
3+
<package id="NUnit" version="2.6.3" targetFramework="net35" />
4+
</packages>

‎WkHtmlToXSharp/Libs/Linux32/libwkhtmltox0.so.gz

235 KB
Binary file not shown.

‎WkHtmlToXSharp/Libs/Linux64/libwkhtmltox0.so.gz

241 KB
Binary file not shown.

‎WkHtmlToXSharp/Libs/Win32/wkhtmltox0.dll.gz

452 Bytes
Binary file not shown.

‎WkHtmlToXSharp/LibsHelper.cs

+16-3
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
using System.Reflection;
3131
using System.Runtime.InteropServices;
3232
using System.Collections.Generic;
33+
using System.Security.Cryptography;
3334
using System.Linq;
3435
using System.Text;
3536

@@ -113,12 +114,21 @@ private static string GetResourcePath()
113114
throw new NotSupportedException("Sorry, WkHtmlToSharp does not support this platform at this time.");
114115
}
115116

116-
private static void CopyStream(Stream input, Stream output)
117+
private static byte[] CopyStream(Stream input, Stream output)
117118
{
118-
byte[] buffer = new byte[0x1000];
119+
var hasher = HashAlgorithm.Create("MD5");
120+
var buffer = new byte[0x1000];
119121
int read;
122+
123+
hasher.Initialize();
120124
while ((read = input.Read(buffer, 0, buffer.Length)) > 0)
125+
{
126+
hasher.TransformBlock(buffer, 0, read, buffer, 0);
121127
output.Write(buffer, 0, read);
128+
}
129+
hasher.TransformFinalBlock(buffer, 0, 0);
130+
131+
return hasher.Hash;
122132
}
123133

124134
private static bool IsFileLocked(string filePath)
@@ -170,14 +180,17 @@ private static void DeployLibrary(string resource)
170180

171181
_Log.InfoFormat("Deploying embedded {0} to {1}..", Path.GetFileName(fileName), _OutputPath);
172182

183+
byte[] hash = null;
173184
var res = Assembly.GetManifestResourceStream(resource);
174185

175186
using (var input = compressed ? new GZipStream(res, CompressionMode.Decompress, false) : res)
176187
using (var output = new FileStream(fileName, FileMode.Create, FileAccess.Write, FileShare.None))
177188
{
178-
CopyStream(input, output);
189+
hash = CopyStream(input, output);
179190
}
180191

192+
_Log.InfoFormat("Deployed {0} with md5sum: {1}.", fileName, string.Concat(hash.Select(b => b.ToString("X2")).ToArray()));
193+
181194
if (Environment.OSVersion.Platform == PlatformID.Unix)
182195
{
183196
// Set as executable (only applies to mono)..

‎WkHtmlToXSharp/Marshaler.cs

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
#region Copyright
2+
//
3+
// Author: Pablo Ruiz García ([email protected])
4+
//
5+
// (C) Pablo Ruiz García 2011
6+
//
7+
// Permission is hereby granted, free of charge, to any person obtaining
8+
// a copy of this software and associated documentation files (the
9+
// "Software"), to deal in the Software without restriction, including
10+
// without limitation the rights to use, copy, modify, merge, publish,
11+
// distribute, sublicense, and/or sell copies of the Software, and to
12+
// permit persons to whom the Software is furnished to do so, subject to
13+
// the following conditions:
14+
//
15+
// The above copyright notice and this permission notice shall be
16+
// included in all copies or substantial portions of the Software.
17+
//
18+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19+
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20+
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21+
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22+
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23+
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24+
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25+
//
26+
#endregion
27+
using System;
28+
using System.Collections.Generic;
29+
using System.Runtime.InteropServices;
30+
using System.Text;
31+
32+
namespace WkHtmlToXSharp
33+
{
34+
/// <summary>
35+
/// Marshaller needed to correctly pass values between us and QT APIs.
36+
/// </summary>
37+
public class Marshaler : ICustomMarshaler
38+
{
39+
public static readonly Marshaler Instance = new Marshaler();
40+
41+
#region Helper Methods
42+
public static IntPtr StringToUtf8Ptr(string str)
43+
{
44+
return Instance.MarshalManagedToNative(str);
45+
}
46+
47+
public static void FreeUtf8Ptr(IntPtr ptr)
48+
{
49+
Instance.CleanUpNativeData(ptr);
50+
}
51+
#endregion
52+
53+
#region ICusomMarshaler
54+
public IntPtr MarshalManagedToNative(object obj)
55+
{
56+
if (obj == null)
57+
return IntPtr.Zero;
58+
59+
if (!(obj is string))
60+
throw new MarshalDirectiveException("Object must be a string.");
61+
62+
// not null terminated
63+
byte[] strbuf = Encoding.UTF8.GetBytes((string)obj);
64+
var buffer = Marshal.AllocHGlobal(strbuf.Length + 1);
65+
Marshal.Copy(strbuf, 0, buffer, strbuf.Length);
66+
67+
// append final null
68+
Marshal.WriteByte(buffer, strbuf.Length, 0);
69+
70+
return buffer;
71+
}
72+
73+
public unsafe object MarshalNativeToManaged(IntPtr ptr)
74+
{
75+
byte* walk = (byte*)ptr;
76+
77+
// find the end of the string
78+
while (*walk != 0)
79+
{
80+
walk++;
81+
}
82+
int length = (int)(walk - (byte*)ptr);
83+
84+
// should not be null terminated
85+
byte[] strbuf = new byte[length];
86+
87+
// skip the trailing null
88+
Marshal.Copy(ptr, strbuf, 0, length);
89+
return Encoding.UTF8.GetString(strbuf);
90+
}
91+
92+
public void CleanUpNativeData(IntPtr ptr)
93+
{
94+
if (ptr == IntPtr.Zero)
95+
return;
96+
97+
Marshal.FreeHGlobal(ptr);
98+
}
99+
100+
public void CleanUpManagedData(object managedObj)
101+
{
102+
}
103+
104+
public int GetNativeDataSize()
105+
{
106+
return -1;
107+
}
108+
109+
public static ICustomMarshaler GetInstance(string cookie)
110+
{
111+
return Instance;
112+
}
113+
#endregion
114+
}
115+
}

‎WkHtmlToXSharp/NativeCalls.cs

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Runtime.InteropServices;
4+
5+
namespace WkHtmlToXSharp
6+
{
7+
internal static class NativeCalls
8+
{
9+
private const string DLL_NAME = "wkhtmltox0";
10+
11+
static NativeCalls()
12+
{
13+
// Deploy native assemblies..
14+
LibsHelper.DeployLibraries();
15+
}
16+
17+
#region P/Invokes
18+
[DllImport(DLL_NAME)]
19+
public static extern IntPtr wkhtmltopdf_version();
20+
21+
[DllImport(DLL_NAME)]
22+
public static extern int wkhtmltopdf_init(int use_graphics);
23+
24+
[DllImport(DLL_NAME)]
25+
public static extern int wkhtmltopdf_deinit();
26+
27+
[DllImport(DLL_NAME)]
28+
public static extern int wkhtmltopdf_extended_qt();
29+
30+
[DllImport(DLL_NAME)]
31+
public static extern IntPtr wkhtmltopdf_create_global_settings();
32+
33+
[DllImport(DLL_NAME)]
34+
public static extern IntPtr wkhtmltopdf_create_converter(IntPtr globalSettings);
35+
36+
[DllImport(DLL_NAME)]
37+
public static extern IntPtr wkhtmltopdf_create_object_settings();
38+
39+
#if true
40+
[DllImport(DLL_NAME)]
41+
public static extern int wkhtmltopdf_set_global_setting(IntPtr globalSettings,
42+
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(Marshaler))] string name,
43+
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(Marshaler))] string value);
44+
45+
[DllImport(DLL_NAME)]
46+
public static extern int wkhtmltopdf_set_object_setting(IntPtr objectSettings,
47+
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(Marshaler))] string name,
48+
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(Marshaler))] string value);
49+
50+
[DllImport(DLL_NAME)]
51+
public static extern void wkhtmltopdf_add_object(IntPtr converter, IntPtr objectSettings,
52+
[MarshalAs(UnmanagedType.CustomMarshaler, MarshalTypeRef = typeof(Marshaler))] string htmlData);
53+
#else
54+
[DllImport(DLL_NAME)]
55+
public static extern int wkhtmltopdf_set_global_setting(IntPtr globalSettings, string name, IntPtr value);
56+
57+
[DllImport(DLL_NAME)]
58+
public static extern int wkhtmltopdf_set_object_setting(IntPtr objectSettings, string name, IntPtr value);
59+
60+
[DllImport(DLL_NAME)]
61+
public static extern void wkhtmltopdf_add_object(IntPtr converter, IntPtr objectSettings, IntPtr htmlData);
62+
#endif
63+
64+
[DllImport(DLL_NAME)]
65+
public static extern int wkhtmltopdf_convert(IntPtr converter);
66+
67+
[DllImport(DLL_NAME)]
68+
public static extern IntPtr wkhtmltopdf_get_output(IntPtr converter, out IntPtr data);
69+
70+
[DllImport(DLL_NAME)]
71+
public static extern void wkhtmltopdf_destroy_converter(IntPtr converter);
72+
73+
[DllImport(DLL_NAME)]
74+
public static extern int wkhtmltopdf_current_phase(IntPtr converter);
75+
76+
[DllImport(DLL_NAME)]
77+
public static extern int wkhtmltopdf_phase_count(IntPtr converter);
78+
79+
[DllImport(DLL_NAME)]
80+
// NOTE: Using IntPtr as return to avoid runtime from freeing returned string. (pruiz)
81+
public static extern IntPtr wkhtmltopdf_phase_description(IntPtr converter, int phase);
82+
83+
[DllImport(DLL_NAME)]
84+
// NOTE: Using IntPtr as return to avoid runtime from freeing returned string. (pruiz)
85+
public static extern IntPtr wkhtmltopdf_progress_string(IntPtr converter);
86+
87+
[DllImport(DLL_NAME)]
88+
public static extern int wkhtmltopdf_http_error_code(IntPtr converter);
89+
90+
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
91+
public delegate void wkhtmltopdf_str_callback(IntPtr converter, [MarshalAs(UnmanagedType.LPStr)] string str);
92+
//public delegate void wkhtmltopdf_str_callback(IntPtr converter, IntPtr str);
93+
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
94+
public delegate void wkhtmltopdf_int_callback(IntPtr converter, int val);
95+
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
96+
public delegate void wkhtmltopdf_bool_callback(IntPtr converter, bool val);
97+
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
98+
public delegate void wkhtmltopdf_void_callback(IntPtr converter);
99+
100+
[DllImport(DLL_NAME)]
101+
public static extern void wkhtmltopdf_set_error_callback(IntPtr converter, [MarshalAs(UnmanagedType.FunctionPtr)] wkhtmltopdf_str_callback cb);
102+
103+
[DllImport(DLL_NAME)]
104+
public static extern void wkhtmltopdf_set_warning_callback(IntPtr converter, [MarshalAs(UnmanagedType.FunctionPtr)] wkhtmltopdf_str_callback cb);
105+
106+
[DllImport(DLL_NAME)]
107+
public static extern void wkhtmltopdf_set_phase_changed_callback(IntPtr converter, [MarshalAs(UnmanagedType.FunctionPtr)] wkhtmltopdf_void_callback cb);
108+
109+
[DllImport(DLL_NAME)]
110+
public static extern void wkhtmltopdf_set_progress_changed_callback(IntPtr converter, [MarshalAs(UnmanagedType.FunctionPtr)] wkhtmltopdf_int_callback cb);
111+
112+
[DllImport(DLL_NAME)]
113+
public static extern void wkhtmltopdf_set_finished_callback(IntPtr converter, [MarshalAs(UnmanagedType.FunctionPtr)] wkhtmltopdf_bool_callback cb);
114+
#endregion
115+
116+
#region NativeCall Wrappers
117+
public static string WkHtmlToPdfVersion()
118+
{
119+
var ptr = wkhtmltopdf_version();
120+
return Marshal.PtrToStringAnsi(ptr);
121+
}
122+
#endregion
123+
}
124+
}

0 commit comments

Comments
 (0)