1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
/* eslint-disable */
/*
* Copyright (c) 2015
*
* This file is licensed under the Affero General Public License version 3
* or later.
*
* See the COPYING-README file.
*
*/
import templateResult from './templates/result.handlebars'
import templateResultForm from './templates/result_form.handlebars'
import templateSelection from './templates/selection.handlebars'
(function(OC) {
/**
* @class OC.SystemTags.SystemTagsInputField
* @classdesc
*
* Displays a file's system tags
*
*/
var SystemTagsInputField = OC.Backbone.View.extend(
/** @lends OC.SystemTags.SystemTagsInputField.prototype */ {
_rendered: false,
_newTag: null,
_lastUsedTags: [],
className: 'systemTagsInputFieldContainer',
template: function(data) {
return '<input class="systemTagsInputField" type="hidden" name="tags" value=""/>'
},
/**
* Creates a new SystemTagsInputField
*
* @param {Object} [options]
* @param {string} [options.objectType=files] object type for which tags are assigned to
* @param {bool} [options.multiple=false] whether to allow selecting multiple tags
* @param {bool} [options.allowActions=true] whether tags can be renamed/delete within the dropdown
* @param {bool} [options.allowCreate=true] whether new tags can be created
* @param {bool} [options.isAdmin=true] whether the user is an administrator
* @param {Function} options.initSelection function to convert selection to data
*/
initialize: function(options) {
options = options || {}
this._multiple = !!options.multiple
this._allowActions = _.isUndefined(options.allowActions) || !!options.allowActions
this._allowCreate = _.isUndefined(options.allowCreate) || !!options.allowCreate
this._isAdmin = !!options.isAdmin
if (_.isFunction(options.initSelection)) {
this._initSelection = options.initSelection
}
this.collection = options.collection || OC.SystemTags.collection
var self = this
this.collection.on('change:name remove', function() {
// refresh selection
_.defer(self._refreshSelection)
})
_.defer(_.bind(this._getLastUsedTags, this))
_.bindAll(
this,
'_refreshSelection',
'_onClickRenameTag',
'_onClickDeleteTag',
'_onSelectTag',
'_onDeselectTag',
'_onSubmitRenameTag'
)
},
_getLastUsedTags: function() {
var self = this
$.ajax({
type: 'GET',
url: OC.generateUrl('/apps/systemtags/lastused'),
success: function(response) {
self._lastUsedTags = response
}
})
},
/**
* Refreshes the selection, triggering a call to
* select2's initSelection
*/
_refreshSelection: function() {
this.$tagsField.select2('val', this.$tagsField.val())
},
/**
* Event handler whenever the user clicked the "rename" action.
* This will display the rename field.
*/
_onClickRenameTag: function(ev) {
var $item = $(ev.target).closest('.systemtags-item')
var tagId = $item.attr('data-id')
var tagModel = this.collection.get(tagId)
var oldName = tagModel.get('name')
var $renameForm = $(templateResultForm({
cid: this.cid,
name: oldName,
deleteTooltip: t('core', 'Delete'),
renameLabel: t('core', 'Rename'),
isAdmin: this._isAdmin
}))
$item.find('.label').after($renameForm)
$item.find('.label, .systemtags-actions').addClass('hidden')
$item.closest('.select2-result').addClass('has-form')
$renameForm.find('[title]').tooltip({
placement: 'bottom',
container: 'body'
})
$renameForm.find('input').focus().selectRange(0, oldName.length)
return false
},
/**
* Event handler whenever the rename form has been submitted after
* the user entered a new tag name.
* This will submit the change to the server.
*
* @param {Object} ev event
*/
_onSubmitRenameTag: function(ev) {
ev.preventDefault()
var $form = $(ev.target)
var $item = $form.closest('.systemtags-item')
var tagId = $item.attr('data-id')
var tagModel = this.collection.get(tagId)
var newName = $(ev.target).find('input').val().trim()
if (newName && newName !== tagModel.get('name')) {
tagModel.save({ 'name': newName })
// TODO: spinner, and only change text after finished saving
$item.find('.label').text(newName)
}
$item.find('.label, .systemtags-actions').removeClass('hidden')
$form.remove()
$item.closest('.select2-result').removeClass('has-form')
},
/**
* Event handler whenever a tag must be deleted
*
* @param {Object} ev event
*/
_onClickDeleteTag: function(ev) {
var $item = $(ev.target).closest('.systemtags-item')
var tagId = $item.attr('data-id')
this.collection.get(tagId).destroy()
$(ev.target).tooltip('hide')
$item.closest('.select2-result').remove()
// TODO: spinner
return false
},
_addToSelect2Selection: function(selection) {
var data = this.$tagsField.select2('data')
data.push(selection)
this.$tagsField.select2('data', data)
},
/**
* Event handler whenever a tag is selected.
* Also called whenever tag creation is requested through the dummy tag object.
*
* @param {Object} e event
*/
_onSelectTag: function(e) {
var self = this
var tag
if (e.object && e.object.isNew) {
// newly created tag, check if existing
// create a new tag
tag = this.collection.create({
name: e.object.name.trim(),
userVisible: true,
userAssignable: true,
canAssign: true
}, {
success: function(model) {
self._addToSelect2Selection(model.toJSON())
self._lastUsedTags.unshift(model.id)
self.trigger('select', model)
},
error: function(model, xhr) {
if (xhr.status === 409) {
// re-fetch collection to get the missing tag
self.collection.reset()
self.collection.fetch({
success: function(collection) {
// find the tag in the collection
var model = collection.where({
name: e.object.name.trim(),
userVisible: true,
userAssignable: true
})
if (model.length) {
model = model[0]
// the tag already exists or was already assigned,
// add it to the list anyway
self._addToSelect2Selection(model.toJSON())
self.trigger('select', model)
}
}
})
}
}
})
this.$tagsField.select2('close')
e.preventDefault()
return false
} else {
tag = this.collection.get(e.object.id)
this._lastUsedTags.unshift(tag.id)
}
this._newTag = null
this.trigger('select', tag)
},
/**
* Event handler whenever a tag gets deselected.
*
* @param {Object} e event
*/
_onDeselectTag: function(e) {
this.trigger('deselect', e.choice.id)
},
/**
* Autocomplete function for dropdown results
*
* @param {Object} query select2 query object
*/
_queryTagsAutocomplete: function(query) {
var self = this
this.collection.fetch({
success: function(collection) {
var tagModels = collection.filterByName(query.term.trim())
if (!self._isAdmin) {
tagModels = _.filter(tagModels, function(tagModel) {
return tagModel.get('canAssign')
})
}
query.callback({
results: _.invoke(tagModels, 'toJSON')
})
}
})
},
_preventDefault: function(e) {
e.stopPropagation()
},
/**
* Formats a single dropdown result
*
* @param {Object} data data to format
* @returns {string} HTML markup
*/
_formatDropDownResult: function(data) {
return templateResult(_.extend({
renameTooltip: t('core', 'Rename'),
allowActions: this._allowActions,
tagMarkup: this._isAdmin ? OC.SystemTags.getDescriptiveTag(data)[0].innerHTML : null,
isAdmin: this._isAdmin
}, data))
},
/**
* Formats a single selection item
*
* @param {Object} data data to format
* @returns {string} HTML markup
*/
_formatSelection: function(data) {
return templateSelection(_.extend({
tagMarkup: this._isAdmin ? OC.SystemTags.getDescriptiveTag(data)[0].innerHTML : null,
isAdmin: this._isAdmin
}, data))
},
/**
* Create new dummy choice for select2 when the user
* types an arbitrary string
*
* @param {string} term entered term
* @returns {Object} dummy tag
*/
_createSearchChoice: function(term) {
term = term.trim()
if (this.collection.filter(function(entry) {
return entry.get('name') === term
}).length) {
return
}
if (!this._newTag) {
this._newTag = {
id: -1,
name: term,
userAssignable: true,
userVisible: true,
canAssign: true,
isNew: true
}
} else {
this._newTag.name = term
}
return this._newTag
},
_initSelection: function(element, callback) {
var self = this
var ids = $(element).val().split(',')
function modelToSelection(model) {
var data = model.toJSON()
if (!self._isAdmin && !data.canAssign) {
// lock static tags for non-admins
data.locked = true
}
return data
}
function findSelectedObjects(ids) {
var selectedModels = self.collection.filter(function(model) {
return ids.indexOf(model.id) >= 0 && (self._isAdmin || model.get('userVisible'))
})
return _.map(selectedModels, modelToSelection)
}
this.collection.fetch({
success: function() {
callback(findSelectedObjects(ids))
}
})
},
/**
* Renders this details view
*/
render: function() {
var self = this
this.$el.html(this.template())
this.$el.find('[title]').tooltip({ placement: 'bottom' })
this.$tagsField = this.$el.find('[name=tags]')
this.$tagsField.select2({
placeholder: t('core', 'Collaborative tags'),
containerCssClass: 'systemtags-select2-container',
dropdownCssClass: 'systemtags-select2-dropdown',
closeOnSelect: false,
allowClear: false,
multiple: this._multiple,
toggleSelect: this._multiple,
query: _.bind(this._queryTagsAutocomplete, this),
id: function(tag) {
return tag.id
},
initSelection: _.bind(this._initSelection, this),
formatResult: _.bind(this._formatDropDownResult, this),
formatSelection: _.bind(this._formatSelection, this),
createSearchChoice: this._allowCreate ? _.bind(this._createSearchChoice, this) : undefined,
sortResults: function(results) {
var selectedItems = _.pluck(self.$tagsField.select2('data'), 'id')
results.sort(function(a, b) {
var aSelected = selectedItems.indexOf(a.id) >= 0
var bSelected = selectedItems.indexOf(b.id) >= 0
if (aSelected === bSelected) {
var aLastUsed = self._lastUsedTags.indexOf(a.id)
var bLastUsed = self._lastUsedTags.indexOf(b.id)
if (aLastUsed !== bLastUsed) {
if (bLastUsed === -1) {
return -1
}
if (aLastUsed === -1) {
return 1
}
return aLastUsed < bLastUsed ? -1 : 1
}
// Both not found
return OC.Util.naturalSortCompare(a.name, b.name)
}
if (aSelected && !bSelected) {
return -1
}
return 1
})
return results
},
formatNoMatches: function() {
return t('core', 'No tags found')
}
})
.on('select2-selecting', this._onSelectTag)
.on('select2-removing', this._onDeselectTag)
var $dropDown = this.$tagsField.select2('dropdown')
// register events for inside the dropdown
$dropDown.on('mouseup', '.rename', this._onClickRenameTag)
$dropDown.on('mouseup', '.delete', this._onClickDeleteTag)
$dropDown.on('mouseup', '.select2-result-selectable.has-form', this._preventDefault)
$dropDown.on('submit', '.systemtags-rename-form', this._onSubmitRenameTag)
this.delegateEvents()
},
remove: function() {
if (this.$tagsField) {
this.$tagsField.select2('destroy')
}
},
getValues: function() {
this.$tagsField.select2('val')
},
setValues: function(values) {
this.$tagsField.select2('val', values)
},
setData: function(data) {
this.$tagsField.select2('data', data)
}
})
OC.SystemTags = OC.SystemTags || {}
OC.SystemTags.SystemTagsInputField = SystemTagsInputField
})(OC)
|