Log folder's ID and Label (fixes #3724)

[zaynetro]

Purpose

This pull requests fixes issue #3724. Log entries should print folder's ID and Label.

Testing

Testing wasn't necessary for this change.

[calmh]

So there are two formatting types in use here, inconsistently, since before.

• %s which just formats a string normally, and can be surrounded by quotes to quote the string: Printf("\"%s\"", "foo") becomes "foo".
• %q which prints an escaped string, in quotes. Printf("%q", "foo") becomes "foo", same as the example above. But also, Printf("%q", "fo\"o") becomes "fo\"o" while with the %s formatting above it would print as "fo"o".

So anyway, long story short, I think we should probably use "... folder %q (%s)", label, id" to generate something like ... folder "My folder Label" (abcde-12345). No escaping needed in the format string, will quote the label which is the one most likely to include spaces and words and stuff, and generally looks reasonable to me.

[calmh]

@st-jenkins add to white list

[AudriusButkevicius]

To be honest, I think we should just print "%s" % cfg and then add a .String() on folder config returning whatever, in case we change something yet again in the future.

[calmh]

Actually that's a good idea. I was thinking that there were lots of places where the folder label and ID didn't come via a a FolderConfiguration object but that doesn't really seem to be the case, from the diff. So yeah.

Although I wouldn't use String() for it, but something else like Description() instead, or printing the actual object for testing and debugging gets annoying.

[zaynetro]

OK, now I am using "%q (%s)" format in all log entries. Folder configuration struct has now a method Description() which prints folder's label and ID.

[calmh]

Neat! Looks good to me, thanks! There is a merge conflict on the authors change (one of the reasons I prefer doing it), so I'll take care of merging this manually.

[calmh]

Merged in d3a251e, thanks for the cleanup!

[zaynetro]

Thanks for the quick replies!

[AudriusButkevicius]

I was saying (over the phone, not sure if it got delivered), that in protocol/bep_extensions.go, we could add:

func (f Folder) Description() string {
    return fmt.Sprintf("%q (%s)", f.Label, f.ID)
}

and use folder.Description() in the remaining cases, that cover the protobuf generated messages.

[calmh]

Done!