mirror of
https://github.com/flarum/framework.git
synced 2025-04-30 08:34:04 +08:00
eb72307a54
* Introduce user display names It is not uncommon for forums to be intergrated with sites where users don't have a unique "handle" - they might just have their first name, or a full name, which is not guaranteed to be unique. This commit introduces the concept of "display names" for users. By default display names are the same as usernames, but extensions may override this and set them to something different. The important thing is that all code should use `display_name` whenever intending to output a human-readable name - `username` is reserved for cases where you want to output a unique identifier (which may or may not be human-friendly). The new "GetDisplayName" API is probably sub-optimal, but I didn't worry too much because we can come up with something better in `next-back`. ref #557 * Apply fixes from StyleCI [ci skip] [skip ci]
113 lines
3.3 KiB
JavaScript
113 lines
3.3 KiB
JavaScript
/*global ColorThief*/
|
|
|
|
import Model from 'flarum/Model';
|
|
import stringToColor from 'flarum/utils/stringToColor';
|
|
import ItemList from 'flarum/utils/ItemList';
|
|
import computed from 'flarum/utils/computed';
|
|
import GroupBadge from 'flarum/components/GroupBadge';
|
|
|
|
export default class User extends Model {}
|
|
|
|
Object.assign(User.prototype, {
|
|
username: Model.attribute('username'),
|
|
displayName: Model.attribute('displayName'),
|
|
email: Model.attribute('email'),
|
|
isActivated: Model.attribute('isActivated'),
|
|
password: Model.attribute('password'),
|
|
|
|
avatarUrl: Model.attribute('avatarUrl'),
|
|
bio: Model.attribute('bio'),
|
|
bioHtml: computed('bio', bio => bio ? '<p>' + $('<div/>').text(bio).html().replace(/\n/g, '<br>').autoLink({rel: 'nofollow'}) + '</p>' : ''),
|
|
preferences: Model.attribute('preferences'),
|
|
groups: Model.hasMany('groups'),
|
|
|
|
joinTime: Model.attribute('joinTime', Model.transformDate),
|
|
lastSeenTime: Model.attribute('lastSeenTime', Model.transformDate),
|
|
readTime: Model.attribute('readTime', Model.transformDate),
|
|
unreadNotificationsCount: Model.attribute('unreadNotificationsCount'),
|
|
newNotificationsCount: Model.attribute('newNotificationsCount'),
|
|
|
|
discussionsCount: Model.attribute('discussionsCount'),
|
|
commentsCount: Model.attribute('commentsCount'),
|
|
|
|
canEdit: Model.attribute('canEdit'),
|
|
canDelete: Model.attribute('canDelete'),
|
|
|
|
avatarColor: null,
|
|
color: computed('username', 'avatarUrl', 'avatarColor', function(username, avatarUrl, avatarColor) {
|
|
// If we've already calculated and cached the dominant color of the user's
|
|
// avatar, then we can return that in RGB format. If we haven't, we'll want
|
|
// to calculate it. Unless the user doesn't have an avatar, in which case
|
|
// we generate a color from their username.
|
|
if (avatarColor) {
|
|
return 'rgb(' + avatarColor.join(', ') + ')';
|
|
} else if (avatarUrl) {
|
|
this.calculateAvatarColor();
|
|
return '';
|
|
}
|
|
|
|
return '#' + stringToColor(username);
|
|
}),
|
|
|
|
/**
|
|
* Check whether or not the user has been seen in the last 5 minutes.
|
|
*
|
|
* @return {Boolean}
|
|
* @public
|
|
*/
|
|
isOnline() {
|
|
return this.lastSeenTime() > moment().subtract(5, 'minutes').toDate();
|
|
},
|
|
|
|
/**
|
|
* Get the Badge components that apply to this user.
|
|
*
|
|
* @return {ItemList}
|
|
*/
|
|
badges() {
|
|
const items = new ItemList();
|
|
const groups = this.groups();
|
|
|
|
if (groups) {
|
|
groups.forEach(group => {
|
|
items.add('group' + group.id(), GroupBadge.component({group}));
|
|
});
|
|
}
|
|
|
|
return items;
|
|
},
|
|
|
|
/**
|
|
* Calculate the dominant color of the user's avatar. The dominant color will
|
|
* be set to the `avatarColor` property once it has been calculated.
|
|
*
|
|
* @protected
|
|
*/
|
|
calculateAvatarColor() {
|
|
const image = new Image();
|
|
const user = this;
|
|
|
|
image.onload = function() {
|
|
const colorThief = new ColorThief();
|
|
user.avatarColor = colorThief.getColor(this);
|
|
user.freshness = new Date();
|
|
m.redraw();
|
|
};
|
|
image.src = this.avatarUrl();
|
|
},
|
|
|
|
/**
|
|
* Update the user's preferences.
|
|
*
|
|
* @param {Object} newPreferences
|
|
* @return {Promise}
|
|
*/
|
|
savePreferences(newPreferences) {
|
|
const preferences = this.preferences();
|
|
|
|
Object.assign(preferences, newPreferences);
|
|
|
|
return this.save({preferences});
|
|
}
|
|
});
|