aboutsummaryrefslogtreecommitdiffstats
path: root/core/src/jquery/avatar.js
diff options
context:
space:
mode:
Diffstat (limited to 'core/src/jquery/avatar.js')
-rw-r--r--core/src/jquery/avatar.js146
1 files changed, 146 insertions, 0 deletions
diff --git a/core/src/jquery/avatar.js b/core/src/jquery/avatar.js
new file mode 100644
index 00000000000..3851a26ce31
--- /dev/null
+++ b/core/src/jquery/avatar.js
@@ -0,0 +1,146 @@
+/**
+ * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import { getCurrentUser } from '@nextcloud/auth'
+import { generateUrl } from '@nextcloud/router'
+import $ from 'jquery'
+
+/**
+ * This plugin inserts the right avatar for the user, depending on, whether a
+ * custom avatar is uploaded - which it uses then - or not, and display a
+ * placeholder with the first letter of the users name instead.
+ * For this it queries the core_avatar_get route, thus this plugin is fit very
+ * tightly for owncloud, and it may not work anywhere else.
+ *
+ * You may use this on any <div></div>
+ * Here I'm using <div class="avatardiv"></div> as an example.
+ *
+ * There are 5 ways to call this:
+ *
+ * 1. $('.avatardiv').avatar('jdoe', 128);
+ * This will make the div to jdoe's fitting avatar, with a size of 128px.
+ *
+ * 2. $('.avatardiv').avatar('jdoe');
+ * This will make the div to jdoe's fitting avatar. If the div already has a
+ * height, it will be used for the avatars size. Otherwise this plugin will
+ * search for 'size' DOM data, to use for avatar size. If neither are available
+ * it will default to 64px.
+ *
+ * 3. $('.avatardiv').avatar();
+ * This will search the DOM for 'user' data, to use as the username. If there
+ * is no username available it will default to a placeholder with the value of
+ * "?". The size will be determined the same way, as the second example.
+ *
+ * 4. $('.avatardiv').avatar('jdoe', 128, true);
+ * This will behave like the first example, except it will also append random
+ * hashes to the custom avatar images, to force image reloading in IE8.
+ *
+ * 5. $('.avatardiv').avatar('jdoe', 128, undefined, true);
+ * This will behave like the first example, but it will hide the avatardiv, if
+ * it will display the default placeholder. undefined is the ie8fix from
+ * example 4 and can be either true, or false/undefined, to be ignored.
+ *
+ * 6. $('.avatardiv').avatar('jdoe', 128, undefined, true, callback);
+ * This will behave like the above example, but it will call the function
+ * defined in callback after the avatar is placed into the DOM.
+ *
+ */
+
+$.fn.avatar = function(user, size, ie8fix, hidedefault, callback, displayname) {
+ const setAvatarForUnknownUser = function(target) {
+ target.imageplaceholder('?')
+ target.css('background-color', '#b9b9b9')
+ }
+
+ if (typeof (user) !== 'undefined') {
+ user = String(user)
+ }
+ if (typeof (displayname) !== 'undefined') {
+ displayname = String(displayname)
+ }
+
+ if (typeof (size) === 'undefined') {
+ if (this.height() > 0) {
+ size = this.height()
+ } else if (this.data('size') > 0) {
+ size = this.data('size')
+ } else {
+ size = 64
+ }
+ }
+
+ this.height(size)
+ this.width(size)
+
+ if (typeof (user) === 'undefined') {
+ if (typeof (this.data('user')) !== 'undefined') {
+ user = this.data('user')
+ } else {
+ setAvatarForUnknownUser(this)
+ return
+ }
+ }
+
+ // sanitize
+ user = String(user).replace(/\//g, '')
+
+ const $div = this
+ let url
+
+ // If this is our own avatar we have to use the version attribute
+ if (user === getCurrentUser()?.uid) {
+ url = generateUrl(
+ '/avatar/{user}/{size}?v={version}',
+ {
+ user,
+ size: Math.ceil(size * window.devicePixelRatio),
+ version: oc_userconfig.avatar.version,
+ })
+ } else {
+ url = generateUrl(
+ '/avatar/{user}/{size}',
+ {
+ user,
+ size: Math.ceil(size * window.devicePixelRatio),
+ })
+ }
+
+ const img = new Image()
+
+ // If the new image loads successfully set it.
+ img.onload = function() {
+ $div.clearimageplaceholder()
+ $div.append(img)
+
+ if (typeof callback === 'function') {
+ callback()
+ }
+ }
+ // Fallback when avatar loading fails:
+ // Use old placeholder when a displayname attribute is defined,
+ // otherwise show the unknown user placeholder.
+ img.onerror = function() {
+ $div.clearimageplaceholder()
+ if (typeof (displayname) !== 'undefined') {
+ $div.imageplaceholder(user, displayname)
+ } else {
+ setAvatarForUnknownUser($div)
+ }
+
+ if (typeof callback === 'function') {
+ callback()
+ }
+ }
+
+ if (size < 32) {
+ $div.addClass('icon-loading-small')
+ } else {
+ $div.addClass('icon-loading')
+ }
+ img.width = size
+ img.height = size
+ img.src = url
+ img.alt = ''
+}