Issue #6 - support for custom headers

[bartek4c]

Hi @cp79shark. I have done two small additions to your code to support my use case described in issue #6. First I have added a dictionary for custom headers to the settings class. Later on, in PdfConvert class, I iterate through the dictionary object to create additional options for WkHtmlToPdf tool. I have used this solution for the authorization header to pass a bearer token together with my request and it works perfectly fine. I have tested it with other headers types as well, and also tested adding multiple headers at the same time.

This is an example of using it:
settings.CustomHeaders.Add("Authorization", $"Bearer {accessToken}");

[cp79shark]

Hi @bartek4c, this was meant to be available via CustomWkHtmlPageArgs (string) on PdfConversionSettings (however, that is indeed broken for this usage). But I agree it could be better than a string. I really need to just go ahead and wrap up Page, Cover, Header, Footer, Outline, and TOC in their own configuration objects, but this was supposed to be a "simple" wrapper, heh. You're placing this collection of config options as if they are Global options, not a Page, Header, Footer, etc Option. And while that works for custom header, it might not work or have the desired effect for all usage scenarios. For example, having a custom header that is different for two pages instead of forcing that header for all pages (how you have it).

I just did a release for the day job, so please give me a couple days and I'll work up something more complete to map all the options.

[bartek4c]

Hi @cp79shark,. I think we are talking about two different things here. You mean the html args while I mean the HTTP headers which have nothing to do with html. There is a good collection of custom headers which you might wish to pass with your request, hence the dictionary object (examples here https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers). In my case I had to pass the Authorization header to pass a bearer token. Here is another example of use https://stackoverflow.com/questions/20522933/add-a-header-to-wkhtmltoimage. Hope it makes sense

[cp79shark]

Nope, we are talking about the same thing, my response is just wider in scope than custom HTTP headers.

I'm talking about all options, not just --custom-header. Don't be confused by the property name CustomWkHtmlPageArgs I referenced; it's a catch all. Again, what you submitted is fine for that narrow use case. I just need to bite the bullet and fix ALL options so that it's more flexible / clear what's being done.

Some pseudo code for what I'm talking about. Obviously there would be sensible defaults. Not entirely sure how I want to do it yet, but it should 1. Expose all options so you don't need to use magic strings and 2. Be Fluent / Builder Pattern like for ease of use.

What do you think? Again, I won't be able to get to this until the end of the week. The day job has a monopoly on my time at the moment.

var builder = PdfConfigurationBuilder
    .Title("My PDF Document")
    .AddHttpHeader("Global Header", "ABCDEFG")
    .LowQuality()
    .Dpi(92)
    .Margins(10, 10, 10, 10)
    .PageSize(PageSizes.A4).
    .OutputTo(@"C:\output\output.pdf");

PdfPage page1 = builder
    .FromUri("http://www.google.com")
    .AddHttpHeader("Authorization","Bearer XYZ123")
    .AddHttpHeader("Google API Key", "1234567890")
    .EnableForms()
    .AddCookie("MY_COOKIE", "Cookie Value");

PdfPage page2 = builder
    .FromUri("http://someurl.com")
    .SkipHttpHeaders(); // don't apply global http headers to this request

PdfPage page3 = builder
    .FromStream(someStream);

PdfCover cover = builder
    .AddCover(@"C:\Folder\File.html")
    
PdfPageHeader header = builder.AddPageHeader(@"C:\folder\header.html");

builder.Build();

// alternatively in one command

new PdfConfigurationBuilder()
    .Title("My PDF Document")
    .AddHttpHeader("Global Header", "ABCDEFG")
    .LowQuality()
    .Dpi(92)
    .Margins(10, 10, 10, 10)
    .PageSize(PageSizes.A4).
    .OutputTo(@"C:\output\output.pdf")
    // page 1
    .FromUri("http://www.google.com")
    .AddHttpHeader("Authorization","Bearer XYZ123")
    .AddHttpHeader("Google API Key", "1234567890")
    .EnableForms()
    .AddCookie("MY_COOKIE", "Cookie Value")
    // page 2
    .FromUri("http://someurl.com")
    .SkipHttpHeaders() // don't apply global http headers to this request
    // page 3
    .FromStream(someStream)
    // cover
    .AddCover(@"C:\Folder\File.html")
    // page header
    .AddPageHeader(@"C:\folder\header.html")
    .Build();

[bartek4c]

Ah ok. That probably makes more sense and makes the solution more flexible. Thanks for the feedback. My changes seem to be working for me for now, so I'm looking forward to see your implementation whenever it comes.