441652 - Add hook for user identity in templates

Status: RESOLVED WONTFIX

(Bugzilla :: Extensions, enhancement)

Description

[Christian Höltje]

User-Agent:       Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9) Gecko/2008061004 Firefox/3.0
Build Identifier: 3.0.4

I want to be able to control how usernames are displayed.

Example:
  Turn: <a href="mailto:[e-mail]">[e-mail]</a>
  Into: <a href="mailto:[e-mail]"><img src="http://www.gravatar.com/avatar.php?gravatar_id=4896dfe0c18a330c61121677891c4325&size=16"/>user</a>

Ciao!

Reproducible: Always

Comment 1

[Guy Pyrzak]

Attachment: Patch v1

Comment 2

[Frédéric Buclin]

Comment on attachment 332087 [details] [diff] [review]
Patch v1

This won't help IMO. If someone wants to hide email addresses or want something else to be displayed (versus than having something else to be added), the hook won't be of any help AFAIK.

Comment 3

[Christian Höltje]

Yeah, that would let me add something before hand (gravatars in the example above).  But I actually want to change the username into something different as well.

This might be better:
[% PROCESS "global/user.html.tmpl" user_id=whatever_id user_email=whatever_email  user_realname=whatever_realname %]

Where only user_id is required, the rest would be used if available.

Another niceness would be "global/user.txt.tmpl" for emails.

The only bummer is that this could be really slow for things like the CC list where all the users are looked up.  I suppose there could be a function that caches all the users and if we know we're going to use them we could look it all up at once.

Alternatively, we could add a flag that says what the purpose of this is, and wouldn't lookup extra info from the DB if it's part of a list.

Ciao!

Comment 4

[Guy Pyrzak]

Ah, I thought he just wanted the gravitar thing (which this would be good enough for) I missed the part with the email. The solution that I will do is load the values into a variable and print the variable, if the hook wants to change the variable it can. Thanks for catching that Lp.

Comment 5

[Guy Pyrzak]

Attachment: Patch v2

changes to the html to makes developers can easily replace the username output with a hook.

Comment 6

[Frédéric Buclin]

Comment on attachment 333566 [details] [diff] [review]
Patch v2

>Index: template/en/default/bug/comments.html.tmpl

>           <a class="fn email" href="mailto:[% comment.author.email FILTER html %]">
>-            [% (comment.author.name || comment.author.login) FILTER html %]
>+            [% SET user_identity_output = (comment.author.name || comment.author.login) %]
>+            [% Hook.process("user_identity") %]
>+            [% user_identity_output FILTER html %]
>           </a>

This won't help. Assuming the hook wants to display the name + login, you only pass the name, so it has no change to do anything with it.



>Index: template/en/default/bug/edit.html.tmpl

>-[%# The contents of this file are subject to the Mozilla Public
>+[%# The contents of this file are subject to the Mozilla Public

Huh?


>@@ -249,6 +249,7 @@
>           %]
>+
>           <br>

Unrelated change (you are 900 lines above what you are editing). Remove that.


>-          ><span class="fn">[% user.name FILTER html %]</span
>+          >[% SET user_identity_output = user.name %]
>+          [% Hook.process("user_identity") %]
>+          <span class="fn">[%  user_identity_output FILTER html %]</span

Same problem here. What can the hook do with the user name?


>-          [% user.email FILTER html %]</a>
>+          [% SET user_identity_output = user.email %]
>+          [% Hook.process("user_identity") %][% user_identity_output FILTER html %]</a>

Same here.


Probably better is to pass user name + login to the hook, and let it do what it wants with them.

Comment 7

[Guy Pyrzak]

Actually, your comments are incorrect (other than the BR and the random other thing). The hook has access to all of the information in memory, in this case it has access to the user object, so the extension writer can do whatever they want and pass it back into the user_identity_output. All the extension writer has to do is replace the user_identity_output string with whatever information they please and it will work. So other than the miscellaneous "hu stuff" I would request that you  re-review this, perhaps try to write an extension and reconsider.

Comment 8

[Guy Pyrzak]

Comment on attachment 333566 [details] [diff] [review]
Patch v2

Please re-review taking my comment in mind. If you'd like I will write a extension to prove that the hooks do what this bug requests.

Comment 9

[Guy Pyrzak]

I'd like to have this for 3.2, if someone disagrees feel free to bump it.

Comment 10

[Frédéric Buclin]

Comment on attachment 333566 [details] [diff] [review]
Patch v2

Ah yes, sorry about that; you're right (I had INCLUDE in mind, not PROCESS). Anyway, your patch doesn't work:


>Index: template/en/default/bug/comments.html.tmpl

>+            [% Hook.process("user_identity") %]

This hook is called inside a BLOCK, so you have to pass the file name as 2nd argument. And example can be found in bug/show-multiple.html.tmpl



>Index: template/en/default/bug/edit.html.tmpl

>+          [% Hook.process("user_identity") %]

Same here.

Comment 11

[Frédéric Buclin]

Bugzilla 3.2 is restricted to security bugs only. Moreover, this bug is either assigned to nobody or got no traction for several months now. Rather than retargetting it at each new release, I'm clearing the target milestone and the bug will be retargetted to some sensible release when someone starts fixing this bug for real (Bugzilla 3.8 more likely).

Comment 12

[Gervase Markham [:gerv]]

The way to do this would be to replace template/en/default/global/user.html.tmpl with a custom template.

Gerv