/**
* Copyright (C) 2005-2016 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* This widget can be used to display the last few folders that the current user uploaded to. The upload history
* is managed by the [UploadService]{@link module:alfresco/services/UploadService} and is persisted as a user
* preference. This user preference is requested when the widget loads and if provided will render each previous
* upload location using a configurable widget model.
*
* @module alfresco/upload/UploadHistory
* @extends external:dijit/_WidgetBase
* @mixes external:dojo/_TemplatedMixin
* @mixes module:alfresco/core/Core
* @mixes module:alfresco/core/CoreWidgetProcessing
* @author Dave Draper
* @since 1.0.34
*/
define(["dojo/_base/declare",
"dijit/_WidgetBase",
"dijit/_TemplatedMixin",
"dojo/text!./templates/UploadHistory.html",
"alfresco/core/CoreWidgetProcessing",
"alfresco/core/Core",
"alfresco/core/topics",
"dojo/_base/lang",
"dojo/_base/array",
"dojo/dom-construct"],
function(declare, _WidgetBase, _TemplatedMixin, template, CoreWidgetProcessing, Core, topics,
lang, array, domConstruct) {
return declare([_WidgetBase, _TemplatedMixin, CoreWidgetProcessing, Core], {
/**
* An array of the i18n files to use with this widget.
*
* @instance
* @type {object[]}
* @default [{i18nFile: "./i18n/UploadHistory.properties"}]
*/
i18nRequirements: [{i18nFile: "./i18n/UploadHistory.properties"}],
/**
* The HTML template to use for the widget.
* @instance
* @type {string}
*/
templateString: template,
/**
* The preference name to use for storing and retrieving upload location history.
* In order for this preference to be used it will also be necessary to ensure that the
* [PreferenceService]{@link module:alfresco/services/PreferenceService} is included on the page.
*
* @instance
* @type {string}
* @default
*/
preferenceName: "org.alfresco.share.upload.destination.history",
/**
* This is used to keep track of all the targets that have been previously created so that they can
* be destroyed before re-rendering new targets.
*
* @instance
* @type {object[]}
* @default
*/
currentHistoryTargets: null,
/**
* This is used to keep track of all the subscriptions that are created for each upload target. It is
* only necessary to create one subscription for each target no matter how many times that a target is
* created because it is the index that is used for the pubSubScope.
*
* @instance
* @type {object[]}
* @default
*/
reloadSubscriptions: null,
/**
* This is an extension point for handling the completion of calls to [processWidgets]{@link module:alfresco/core/Core#processWidgets}
*
* @extensionPoint
* @instance
* @param {Array} widgets An array of all the widgets that have been processed
*/
allWidgetsProcessed: function alfresco_upload_UploadHistory__allWidgetsProcessed(widgets) {
this.currentHistoryTargets = widgets;
this.alfPublish(topics.WIDGET_PROCESSING_COMPLETE);
},
/**
* Creates a single upload target for the supplied NodeRef using the configured
* [widgetsForUploadTargets]{@link module:alfresco/upload/UploadHistory#widgetsForUploadTargets}
* model.
*
* @instance
* @param {string} nodeRef The nodeRef to create the upload target for
* @param {number} index The index of the node
*/
createUploadTarget: function alfresco_upload_UploadHistory__createUploadTarget(nodeRef, index) {
this.currentItem = {
nodeRef: nodeRef,
index: index
};
// Set up a subscription for this target index (if not previously subscribed)...
if (!this.reloadSubscriptions[index])
{
var topic = "NODE_HISTORY_" + index + topics.RELOAD_DATA_TOPIC;
this.reloadSubscriptions[index] = this.alfSubscribe(topic, lang.hitch(this, this.render), true);
}
// Create the upload target...
var widgetModel = lang.clone(this.widgetsForUploadTargets);
var targetNode = domConstruct.create("div", {
className: "alfresco-upload-UploadHistory__target"
}, this.domNode);
this.processObject(["processCurrentItemTokens"], widgetModel);
this.processWidgets(widgetModel, targetNode);
},
/**
* Splits the supplied string into an array of NodeRefs (using comma as the delimiter) and then iterates
* over that array calling [createUploadTarget]{@link module:alfresco/upload/UploadHistory#createUploadTarget}
* for each NodeRef.
*
* @instance
* @param {string} value The preference value containing the nodeRefs to create upload targets for
*/
createUploadTargets: function alfresco_upload_UploadHistory__createUploadTargets(value) {
if (value)
{
this.uploadDestinationHistory = value.split(",");
array.forEach(this.uploadDestinationHistory, lang.hitch(this, this.createUploadTarget));
}
},
/**
* Calls the [render]{@link module:alfresco/upload/UploadHistory#render} function to request and
* render the user upload history and then sets up a subscription for any further uploads that complete
* in order that the display can be refreshed.
*
* @instance
*/
postCreate: function alfresco_upload_UploadHistory__postCreate() {
this.render();
this.reloadSubscriptions = [];
this.alfSubscribe(topics.RELOAD_DATA_TOPIC, lang.hitch(this, this.render));
},
/**
* Makes a request for the current users upload history from their preferences and then
* with a callback to the [createUploadTargets]{@link module:alfresco/upload/UploadHistory#createUploadTargets}
* function to render the upload history.
*
* @instance
*/
render: function alfresco_upload_UploadHistory__render() {
array.forEach(this.currentHistoryTargets, function(target) {
target.destroy();
});
domConstruct.empty(this.domNode);
this.alfServicePublish(topics.GET_PREFERENCE, {
preference: this.preferenceName,
callback: this.createUploadTargets,
callbackScope: this
});
},
/**
* This is the widget model used to render each upload target. The root widget should be an
* [UploadFolder]{@link moduke:alfresco/upload/UploadFolder} or a widget that extends it.
*
* @instance
* @type {Array}
*/
widgetsForUploadTargets: [
{
name: "alfresco/upload/UploadFolder",
config: {
pubSubScope: "NODE_HISTORY_{index}",
nodeRef: "{nodeRef}",
xhrRequired: true,
widgets: [
{
name: "alfresco/layout/HorizontalWidgets",
config: {
widgets: [
{
name: "alfresco/renderers/Thumbnail",
widthPx: 80
},
{
name: "alfresco/layout/VerticalWidgets",
config: {
widgets: [
{
name: "alfresco/renderers/Property",
config: {
propertyToRender: "node.properties.cm:name",
renderSize: "large",
renderOnNewLine: true
}
},
{
name: "alfresco/renderers/Property",
config: {
propertyToRender: "node.properties.cm:description",
renderOnNewLine: true
}
},
{
name: "alfresco/renderers/Property",
config: {
propertyToRender: "location.site.title",
label: "upload.history.site.prefix",
renderOnNewLine: true,
renderFilter: [
{
property: "location.site",
values: [null],
renderOnAbsentProperty: true,
negate: true
}
]
}
},
{
name: "alfresco/renderers/Property",
config: {
propertyToRender: "location.path",
renderOnNewLine: true,
label: "upload.history.path.prefix"
}
}
]
}
}
]
}
}
]
}
}
]
});
});
Alfresco Aikau Widgets