Skip to content

Commit ee4f0c4

Browse files
CyperghostCyperghost
authored
Refactor comment templates (#6312)
* Refactor templates, use `unsafe` and remove any unnecessary outputs with `@`. * Use `jsphrase` for language variables * Use the `time` template function instead of the deprecated `plainTime`, `date` modifier.
1 parent 6fd85cb commit ee4f0c4

11 files changed

Lines changed: 59 additions & 61 deletions

‎com.woltlab.wcf/templates/commentEditor.tpl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{capture assign='wysiwygSelector'}commentEditor{@$comment->commentID}{/capture}
1+
{capture assign='wysiwygSelector'}commentEditor{$comment->commentID}{/capture}
22
<textarea id="{$wysiwygSelector}" class="wysiwygTextarea"
33
data-disable-attachments="true"
44
data-support-mention="true"
@@ -15,7 +15,7 @@
1515

1616
<script data-relocate="true">
1717
require(['WoltLabSuite/Core/Component/Comment/Add'], ({ setCommentEditorFeatures }) => {
18-
setCommentEditorFeatures(document.getElementById('{$wysiwygSelector}'));
18+
setCommentEditorFeatures(document.getElementById('{unsafe:$wysiwygSelector|encodeJS}'));
1919
});
2020
</script>
2121

‎com.woltlab.wcf/templates/commentList.tpl‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@
88
</div>
99
{else}
1010
<div class="commentList__item jsComment{if $__wcf->getUserProfileHandler()->isIgnoredUser($comment->userID, 2)} ignoredUserContent{/if}"
11-
data-comment-id="{@$comment->commentID}"
12-
{@$__wcf->getReactionHandler()->getDataAttributes('com.woltlab.wcf.comment', $comment->commentID)}
11+
data-comment-id="{$comment->commentID}"
12+
{unsafe:$__wcf->getReactionHandler()->getDataAttributes('com.woltlab.wcf.comment', $comment->commentID)}
1313
data-can-edit="{if $comment->isEditable()}true{else}false{/if}" data-can-delete="{if $comment->isDeletable()}true{else}false{/if}"
14-
data-responses="{@$comment->responses}" data-last-response-time="{if $ignoreLastResponseTime|empty}{@$comment->getLastResponseTime()}{else}1{/if}" data-is-disabled="{@$comment->isDisabled}"
15-
data-last-response-id="{if $ignoreLastResponseTime|empty}{@$comment->getLastResponseID()}{else}0{/if}"
14+
data-responses="{$comment->responses}" data-last-response-time="{if $ignoreLastResponseTime|empty}{$comment->getLastResponseTime()}{else}1{/if}" data-is-disabled="{$comment->isDisabled}"
15+
data-last-response-id="{if $ignoreLastResponseTime|empty}{$comment->getLastResponseID()}{else}0{/if}"
1616
>
17-
<woltlab-core-comment class="comment" comment-id="{@$comment->commentID}" itemprop="comment" itemscope itemtype="http://schema.org/Comment">
17+
<woltlab-core-comment class="comment" comment-id="{$comment->commentID}" itemprop="comment" itemscope itemtype="http://schema.org/Comment">
1818
<div class="comment__header">
1919
<div class="comment__avatar">
2020
{user object=$comment->getUserProfile() type='avatar32' ariaHidden='true' tabindex='-1'}
2121
</div>
2222
<div class="comment__author" itemprop="author" itemscope itemtype="http://schema.org/Person">
2323
{if $comment->userID}
24-
<a href="{$comment->getUserProfile()->getLink()}" class="comment__author__link userLink" data-object-id="{@$comment->userID}" itemprop="url">
25-
<span itemprop="name">{@$comment->getUserProfile()->getFormattedUsername()}</span>
24+
<a href="{$comment->getUserProfile()->getLink()}" class="comment__author__link userLink" data-object-id="{$comment->userID}" itemprop="url">
25+
<span itemprop="name">{unsafe:$comment->getUserProfile()->getFormattedUsername()}</span>
2626
</a>
2727
{else}
2828
<span itemprop="name">{$comment->username}</span>
2929
{/if}
3030
</div>
3131
<div class="comment__date">
32-
<meta itemprop="datePublished" content="{@$comment->time|date:'c'}">
33-
<a href="{$comment->getLink()}" class="comment__permalink">{@$comment->time|time}</a>
32+
<meta itemprop="datePublished" content="{time type='custom' time=$comment->time format='c'}">
33+
<a href="{$comment->getLink()}" class="comment__permalink">{time time=$comment->time}</a>
3434
</div>
3535
<div class="comment__status">
3636
{if $comment->isDisabled}
@@ -44,7 +44,7 @@
4444
{event name='commentStatus'}
4545
</div>
4646
{hascontent}
47-
<div class="comment__menu dropdown" id="commentOptions{@$comment->commentID}">
47+
<div class="comment__menu dropdown" id="commentOptions{$comment->commentID}">
4848
<button type="button" class="dropdownToggle" aria-label="{lang}wcf.global.button.more{/lang}">{icon name='ellipsis-vertical'}</button>
4949

5050
<ul class="dropdownMenu">
@@ -95,7 +95,7 @@
9595
{event name='commentBeforeMessage'}
9696

9797
<div class="comment__message">
98-
<div class="htmlContent userMessage" itemprop="text">{@$comment->getFormattedMessage()}</div>
98+
<div class="htmlContent userMessage" itemprop="text">{unsafe:$comment->getFormattedMessage()}</div>
9999
</div>
100100

101101
{event name='commentAfterMessage'}
@@ -140,7 +140,7 @@
140140

141141
{if !$ignoreLastResponseTime|empty || $comment|count}
142142
<div class="comment__responses">
143-
<div class="commentResponseList" data-responses="{if $commentCanModerate}{@$comment->unfilteredResponses}{else}{@$comment->responses}{/if}">
143+
<div class="commentResponseList" data-responses="{if $commentCanModerate}{$comment->unfilteredResponses}{else}{$comment->responses}{/if}">
144144
{if $ignoreLastResponseTime|empty}{include file='commentResponseList' responseList=$comment}{/if}
145145
</div>
146146
</div>

‎com.woltlab.wcf/templates/commentResponseEditor.tpl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{capture assign='wysiwygSelector'}commentResponseEditor{@$response->responseID}{/capture}
1+
{capture assign='wysiwygSelector'}commentResponseEditor{$response->responseID}{/capture}
22
<textarea id="{$wysiwygSelector}" class="wysiwygTextarea"
33
data-disable-attachments="true"
44
data-support-mention="true"
@@ -15,7 +15,7 @@
1515

1616
<script data-relocate="true">
1717
require(['WoltLabSuite/Core/Component/Comment/Add'], ({ setCommentEditorFeatures }) => {
18-
setCommentEditorFeatures(document.getElementById('{$wysiwygSelector}'));
18+
setCommentEditorFeatures(document.getElementById('{unsafe:$wysiwygSelector|encodeJS}'));
1919
});
2020
</script>
2121

‎com.woltlab.wcf/templates/commentResponseList.tpl‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,29 @@
55
</div>
66
{else}
77
<div class="commentResponseList__item jsCommentResponse{if $__wcf->getUserProfileHandler()->isIgnoredUser($response->userID, 2)} ignoredUserContent{/if}"
8-
data-response-id="{@$response->responseID}"
9-
{@$__wcf->getReactionHandler()->getDataAttributes('com.woltlab.wcf.comment.response', $response->responseID)}
8+
data-response-id="{$response->responseID}"
9+
{unsafe:$__wcf->getReactionHandler()->getDataAttributes('com.woltlab.wcf.comment.response', $response->responseID)}
1010
data-can-edit="{if $response->isEditable()}true{else}false{/if}"
1111
data-can-delete="{if $response->isDeletable()}true{else}false{/if}"
12-
data-user-id="{@$response->userID}"
12+
data-user-id="{$response->userID}"
1313
>
14-
<woltlab-core-comment-response class="commentResponse" response-id="{@$response->responseID}" itemprop="comment" itemscope itemtype="http://schema.org/Comment">
14+
<woltlab-core-comment-response class="commentResponse" response-id="{$response->responseID}" itemprop="comment" itemscope itemtype="http://schema.org/Comment">
1515
<div class="commentResponse__header">
1616
<div class="commentResponse__avatar">
1717
{user object=$response->getUserProfile() type='avatar32' ariaHidden='true' tabindex='-1'}
1818
</div>
1919
<div class="commentResponse__author" itemprop="author" itemscope itemtype="http://schema.org/Person">
2020
{if $response->userID}
21-
<a href="{$response->getUserProfile()->getLink()}" class="commentResponse__author__link userLink" data-object-id="{@$response->userID}" itemprop="url">
22-
<span itemprop="name">{@$response->getUserProfile()->getFormattedUsername()}</span>
21+
<a href="{$response->getUserProfile()->getLink()}" class="commentResponse__author__link userLink" data-object-id="{$response->userID}" itemprop="url">
22+
<span itemprop="name">{unsafe:$response->getUserProfile()->getFormattedUsername()}</span>
2323
</a>
2424
{else}
2525
<span itemprop="name">{$response->username}</span>
2626
{/if}
2727
</div>
2828
<div class="commentResponse__date">
29-
<meta itemprop="datePublished" content="{@$response->time|date:'c'}">
30-
<a href="{$response->getLink()}" class="commentResponse__permalink">{@$response->time|time}</a>
29+
<meta itemprop="datePublished" content="{time type='custom' time=$response->time format='c'}">
30+
<a href="{$response->getLink()}" class="commentResponse__permalink">{time time=$response->time}</a>
3131
</div>
3232
<div class="commentResponse__status">
3333
{if $response->isDisabled}
@@ -42,7 +42,7 @@
4242
</div>
4343

4444
{hascontent}
45-
<div class="commentResponse__menu dropdown" id="commentResponseOptions{@$response->responseID}">
45+
<div class="commentResponse__menu dropdown" id="commentResponseOptions{$response->responseID}">
4646
<button type="button" class="dropdownToggle" aria-label="{lang}wcf.global.button.more{/lang}">{icon name='ellipsis-vertical'}</button>
4747

4848
<ul class="dropdownMenu">
@@ -93,7 +93,7 @@
9393
{event name='commentBeforeMessage'}
9494

9595
<div class="commentResponse__message">
96-
<div class="htmlContent userMessage" itemprop="text">{@$response->getFormattedMessage()}</div>
96+
<div class="htmlContent userMessage" itemprop="text">{unsafe:$response->getFormattedMessage()}</div>
9797
</div>
9898

9999
{event name='commentAfterMessage'}

‎com.woltlab.wcf/templates/comments.tpl‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
<script data-relocate="true">
2-
require(['Language', 'WoltLabSuite/Core/Component/Comment/List'], (Language, { setup }) => {
3-
Language.addObject({
4-
'wcf.comment.more': '{jslang}wcf.comment.more{/jslang}',
5-
'wcf.comment.response.more': '{jslang}wcf.comment.response.more{/jslang}',
6-
});
2+
{jsphrase name='wcf.comment.more'}
3+
{jsphrase name='wcf.comment.response.more'}
74
8-
setup('{@$commentContainerID|encodeJS}');
5+
require(['WoltLabSuite/Core/Component/Comment/List'], ({ setup }) => {
6+
setup('{unsafe:$commentContainerID|encodeJS}');
97
});
108
</script>
119

@@ -26,7 +24,7 @@
2624
<div class="commentList__item">
2725
<div class="commentAdd commentAdd--collapsed">
2826
<div class="commentAdd__avatar">
29-
{@$__wcf->getUserProfileHandler()->getAvatar()->getImageTag(32)}
27+
{unsafe:$__wcf->getUserProfileHandler()->getAvatar()->getImageTag(32)}
3028
</div>
3129

3230
<div class="commentAdd__content commentAdd__content--collapsed jsOuterEditorContainer">
@@ -69,7 +67,7 @@
6967
{capture assign=_commentResponseWysiwygSelector}{$commentContainerID}AddCommentResponse{/capture}
7068
<div class="commentResponseAdd" hidden>
7169
<div class="commentResponseAdd__avatar">
72-
{@$__wcf->getUserProfileHandler()->getAvatar()->getImageTag(32)}
70+
{unsafe:$__wcf->getUserProfileHandler()->getAvatar()->getImageTag(32)}
7371
</div>
7472

7573
<div class="commentResponseAdd__content jsOuterEditorContainer">

‎com.woltlab.wcf/templates/email_notification_comment.tpl‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{assign var='count' value=$event->getAuthors()|count}{assign var='guestTimesTriggered' value=$event->getNotification()->guestTimesTriggered}{assign var='authors' value=$event->getAuthors()|array_values}
22
{if $mimeType === 'text/plain'}
33
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.plaintext{/lang}{/capture}
4-
{lang}{@$languageVariablePrefix}.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
4+
{lang}{$languageVariablePrefix}.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
55

6-
{@$event->getUserNotificationObject()->getMailText($mimeType)}{/if} {* this line ends with a space *}
6+
{unsafe:$event->getUserNotificationObject()->getMailText($mimeType)}{/if} {* this line ends with a space *}
77
{else}
88
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.html{/lang}{/capture}
9-
{lang}{@$languageVariablePrefix}.mail.html{/lang}
9+
{lang}{$languageVariablePrefix}.mail.html{/lang}
1010
{assign var='user' value=$event->getAuthor()}
1111
{assign var='comment' value=$event->getUserNotificationObject()}
1212

@@ -15,7 +15,7 @@
1515
{capture assign='commentContent'}
1616
<table cellpadding="0" cellspacing="0" border="0">
1717
<tr>
18-
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{@$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
18+
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{unsafe:$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
1919
<td class="boxContent">
2020
<div class="containerHeadline">
2121
<h3>
@@ -25,11 +25,11 @@
2525
{$comment->username}
2626
{/if}
2727
&#xb7;
28-
<small>{$comment->time|plainTime}</small>
28+
<small>{time time=$comment->time type='plainTime'}</small>
2929
</h3>
3030
</div>
3131
<div>
32-
{@$comment->getMailText($mimeType)}
32+
{unsafe:$comment->getMailText($mimeType)}
3333
</div>
3434
</td>
3535
</tr>

‎com.woltlab.wcf/templates/email_notification_commentResponse.tpl‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{assign var='count' value=$event->getAuthors()|count}{assign var='guestTimesTriggered' value=$event->getNotification()->guestTimesTriggered}{assign var='authors' value=$event->getAuthors()|array_values}
22
{if $mimeType === 'text/plain'}
33
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.plaintext{/lang}{/capture}
4-
{lang}{@$languageVariablePrefix}.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
4+
{lang}{$languageVariablePrefix}.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
55

66
{$event->getUserNotificationObject()->message}{/if} {* this line ends with a space *}
77
{else}
88
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.html{/lang}{/capture}
9-
{lang}{@$languageVariablePrefix}.mail.html{/lang}
9+
{lang}{$languageVariablePrefix}.mail.html{/lang}
1010
{assign var='user' value=$event->getAuthor()}
1111
{assign var='comment' value=$event->getUserNotificationObject()}
1212

@@ -15,7 +15,7 @@
1515
{capture assign='commentContent'}
1616
<table cellpadding="0" cellspacing="0" border="0">
1717
<tr>
18-
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{@$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
18+
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{unsafe:$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
1919
<td class="boxContent">
2020
<div class="containerHeadline">
2121
<h3>
@@ -25,11 +25,11 @@
2525
{$comment->username}
2626
{/if}
2727
&#xb7;
28-
<small>{$comment->time|plainTime}</small>
28+
<small>{time time=$comment->time type='plainTime'}</small>
2929
</h3>
3030
</div>
3131
<div>
32-
{@$comment->getMailText($mimeType)}
32+
{unsafe:$comment->getMailText($mimeType)}
3333
</div>
3434
</td>
3535
</tr>

‎com.woltlab.wcf/templates/email_notification_commentResponseOwner.tpl‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{assign var='count' value=$event->getAuthors()|count}{assign var='guestTimesTriggered' value=$event->getNotification()->guestTimesTriggered}{assign var='authors' value=$event->getAuthors()|array_values}
22
{if $mimeType === 'text/plain'}
33
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.plaintext{/lang}{/capture}
4-
{lang}{@$languageVariablePrefix}.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
4+
{lang}{$languageVariablePrefix}.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
55

66
{$event->getUserNotificationObject()->message}{/if} {* this line ends with a space *}
77
{else}
88
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.html{/lang}{/capture}
9-
{lang}{@$languageVariablePrefix}.mail.html{/lang}
9+
{lang}{$languageVariablePrefix}.mail.html{/lang}
1010
{assign var='user' value=$event->getAuthor()}
1111
{assign var='comment' value=$event->getUserNotificationObject()}
1212

@@ -15,7 +15,7 @@
1515
{capture assign='commentContent'}
1616
<table cellpadding="0" cellspacing="0" border="0">
1717
<tr>
18-
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{@$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
18+
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{unsafe:$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
1919
<td class="boxContent">
2020
<div class="containerHeadline">
2121
<h3>
@@ -25,11 +25,11 @@
2525
{$comment->username}
2626
{/if}
2727
&#xb7;
28-
<small>{$comment->time|plainTime}</small>
28+
<small>{time time=$comment->time type='plainTime'}</small>
2929
</h3>
3030
</div>
3131
<div>
32-
{@$comment->getMailText($mimeType)}
32+
{unsafe:$comment->getMailText($mimeType)}
3333
</div>
3434
</td>
3535
</tr>

‎com.woltlab.wcf/templates/email_notification_moderationQueueComment.tpl‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.plaintext{/lang}{/capture}
44
{lang}{$notificationContent[variables][languageItemPrefix]}.comment.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
55

6-
{@$event->getUserNotificationObject()->getMailText($mimeType)}{/if} {* this line ends with a space *}
6+
{unsafe:$event->getUserNotificationObject()->getMailText($mimeType)}{/if} {* this line ends with a space *}
77
{else}
88
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.html{/lang}{/capture}
99
{lang}{$notificationContent[variables][languageItemPrefix]}.comment.mail.html{/lang}
@@ -15,7 +15,7 @@
1515
{capture assign='commentContent'}
1616
<table cellpadding="0" cellspacing="0" border="0">
1717
<tr>
18-
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{@$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
18+
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{unsafe:$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
1919
<td class="boxContent">
2020
<div class="containerHeadline">
2121
<h3>
@@ -25,11 +25,11 @@
2525
{$comment->username}
2626
{/if}
2727
&#xb7;
28-
<small>{$comment->time|plainTime}</small>
28+
<small>{time time=$comment->time type='plainTime'}</small>
2929
</h3>
3030
</div>
3131
<div>
32-
{@$comment->getMailText($mimeType)}
32+
{unsafe:$comment->getMailText($mimeType)}
3333
</div>
3434
</td>
3535
</tr>

‎com.woltlab.wcf/templates/email_notification_moderationQueueCommentResponse.tpl‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.plaintext{/lang}{/capture}
44
{lang}{$notificationContent[variables][languageItemPrefix]}.commentResponse.mail.plaintext{/lang}{if $count == 1 && !$guestTimesTriggered} {* this line ends with a space *}
55

6-
{@$event->getUserNotificationObject()->getMailText($mimeType)}{/if} {* this line ends with a space *}
6+
{unsafe:$event->getUserNotificationObject()->getMailText($mimeType)}{/if} {* this line ends with a space *}
77
{else}
88
{capture assign='authorList'}{lang}wcf.user.notification.mail.authorList.html{/lang}{/capture}
99
{lang}{$notificationContent[variables][languageItemPrefix]}.commentResponse.mail.html{/lang}
@@ -15,7 +15,7 @@
1515
{capture assign='commentContent'}
1616
<table cellpadding="0" cellspacing="0" border="0">
1717
<tr>
18-
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{@$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
18+
<td><a href="{link controller='User' object=$user isHtmlEmail=true}{/link}" title="{$comment->username}">{unsafe:$user->getAvatar()->getSafeImageTag($avatarSize)}</a></td>
1919
<td class="boxContent">
2020
<div class="containerHeadline">
2121
<h3>
@@ -25,11 +25,11 @@
2525
{$comment->username}
2626
{/if}
2727
&#xb7;
28-
<small>{$comment->time|plainTime}</small>
28+
<small>{time time=$comment->time type='plainTime'}</small>
2929
</h3>
3030
</div>
3131
<div>
32-
{@$comment->getMailText($mimeType)}
32+
{unsafe:$comment->getMailText($mimeType)}
3333
</div>
3434
</td>
3535
</tr>

0 commit comments

Comments
 (0)