Improve tpl_getMediaFile()

[geekitude]

Previously, if no candidate is found, the result would still always be last candidate url even if it doesn't exist (and function would trigger a Warning for trying to getimagesize() on a file that doesn't exist)

[phy25]

Thanks for the contribution! I believe several places that use tpl_getMediaFile() should be looked at as well, or they will simply inject false into HTML. Also docs on the top of the function needs to be updated as well; it will not @return string only now.

Some occurrences of tpl_getMediaFile():

https://github.com/splitbrain/dokuwiki/blob/cd7e1573e9ecf4c6d8d11dafcad2483b342be55a/feed.php#L62

https://github.com/splitbrain/dokuwiki/blob/cd7e1573e9ecf4c6d8d11dafcad2483b342be55a/inc/template.php#L1757-L1780

https://github.com/splitbrain/dokuwiki/blob/1121b972bffbf7afb0aef5dfb54f8857c73c3c56/lib/tpl/dokuwiki/tpl_header.php#L23-L30

[Klap-in]

Current usages in Dokuwiki, downloadable plugins and templates of this function:
Code search: tpl_getMediaFile

[splitbrain]

@geekitude will you update the PR with the changes requested by @phy25 ?

[geekitude]

Sorry, I was a bit overwhelmed by real life.
I'm relly not sure on what would be a good way to solve the problem.

Do you think that providing a default transparent image would be a good solution? I believe it would avoid empty/non-existing result all at once?

[phy25]

Do you think that providing a default transparent image would be a good solution? I believe it would avoid empty/non-existing result all at once?

Sound good! I would add a new parameter $fallback with the default pointing to "lib/images/blank.gif" (may need an absolute path). Functions that still wants false can pass that parameter with false.

If you don't have the time to polish this I can go ahead and make the change (and still keep your credit) 😉

[geekitude]

Thanks for your help. I'll give it a try soon and let you know if I need help 😉

[geekitude]

Followed @phy25 idea to add a $fallback parameter that points to "lib/images/blank.gif" (or any other image provided as parameter) or that will stop process if false value is provided

I don't know what to do with The Travis CI build failure :(

[phy25]

Thanks! For the build failure you may need to rebase your commits. master tests are fixed just recently.

If you need help I can rebase this for you...

[geekitude]

Thanks! For the build failure you may need to rebase your commits. master tests are fixed just recently.

If you need help I can rebase this for you...

I'm sorry but I don't know what 'rebase your commit' means, so, your help for that would be much appreciated :)

[phy25]

@geekitude I rebased your branch locally, and force-pushed it to GitHub. Tests should be passing very soon :-)

[geekitude]

@phy25 thanks again for your help, I hope the latest version with boolean $fallback works better :)

[phy25]

Looks good. How to implement $fallback (string or bool) is more of a design decision, but the current code is OK to merge.

Again, thanks for your contributions and patience!

[geekitude]

Thanks for your help and patience! ✌️