/**
* 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/>.
*/
/**
* @module alfresco/services/SiteService
* @extends module:alfresco/services/BaseService
* @mixes module:alfresco/core/CoreXhr
* @author Dave Draper
*/
define(["dojo/_base/declare",
"alfresco/services/BaseService",
"alfresco/core/CoreXhr",
"alfresco/core/ObjectProcessingMixin",
"alfresco/core/NotificationUtils",
"alfresco/core/ObjectTypeUtils",
"alfresco/core/topics",
"alfresco/core/WidgetsOverrideMixin",
"alfresco/enums/urlTypes",
"dojo/_base/array",
"dojo/_base/lang",
"alfresco/buttons/AlfButton",
"service/constants/Default"],
function(declare, BaseService, CoreXhr, ObjectProcessingMixin, NotificationUtils, ObjectTypeUtils, topics,
WidgetsOverrideMixin, urlTypes, array, lang, AlfButton, AlfConstants) {
return declare([BaseService, CoreXhr, ObjectProcessingMixin, NotificationUtils, WidgetsOverrideMixin], {
/**
* An array of the i18n files to use with this widget.
*
* @instance
* @type {Array}
*/
i18nRequirements: [{i18nFile: "./i18n/SiteService.properties"}],
/**
* This can be configured to be an array of additional site presets that will be
* added to the default set (which will just be the "Collaboration Site"). Rather
* than configuring the [sitePresets]{@link module:alfresco/services/SiteService#sitePresets}
* it may be better to define additional presets. Each element in the array should be
* an object with "label" and "value" attributes where the value matches a preset
* configured in Share.
*
* @instance
* @type {object[]}
* @default
* @since 1.0.95
*/
additionalSitePresets: null,
/**
* In order to get a smoother initial rendering of the create site dialog a fixed height
* is configured. However when customizing the contents of the create site dialog it may
* be advisable to set an alternative height (or configure to be null and allow natural
* sizing to occur).
*
* @instance
* @type {string}
* @default
* @since 1.0.99
*/
createSiteDialogHeight: "500px",
/**
* In order to get a smoother initial rendering of the create site dialog a fixed width
* is configured. However when customizing the contents of the create site dialog it may
* be advisable to set an alternative width (or configure to be null and allow natural
* sizing to occur).
*
* @instance
* @instance
* @type {string}
* @default
* @since 1.0.99
*/
createSiteDialogWidth: "670px",
/**
* This is an optional topic that can be configured to allow the create site dialog to have a value
* set on it. This can be useful when needing to pre-fill fields based changing data within the form
* (for example a custom preset). The use case is when a custom field needs to make an XHR request
* for data to be added (i.e. something not possible through
* [autoSetConfig]{@link module:alfresco/forms/controls/BaseFormControl#autoSetConfig}).
*
* @instance
* @type {string}
* @default
* @since 1.0.97
*/
setCreateSiteDialogValueTopic: null,
/**
* This is an optional topic that can be configured to allow the edit site dialog to have a value
* set on it. This can be useful when needing to pre-fill fields based changing data within the form
* (for example a custom preset). The use case is when a custom field needs to make an XHR request
* for data to be added (i.e. something not possible through
* [autoSetConfig]{@link module:alfresco/forms/controls/BaseFormControl#autoSetConfig}).
*
* @instance
* @type {string}
* @default
* @since 1.0.97
*/
setEditSiteDialogValueTopic: null,
/**
* Indicates whether or not the Site Service is running in legacy mode. When configured in this mode
* the service will attempt to use the YUI2 based dialogs provided by Alfresch Share for creating and
* editing sites. If this is configured to be false then the
* [DialogService]{@link module:alfresco/services/DialogService} will be used to display dialogs
* for creating and editing sites.
*
* @instance
* @type {boolean}
* @default
* @since 1.0.55
*/
legacyMode: true,
/**
* This is an array of site preset options that will be displayed when creating a site (when the service
* is not configured to be in [legacyMode]{@link module:alfresco/services/SiteService#legacyMode}). The
* default configuration just contains the "Collaboration Site", but this can be overridden here. Any
* presets must have values that map to presets in the Surf configuration. Note that
* [additionalSitePresets]{@link module:alfresco/services/SiteService#additionalSitePresets} can be used
* to augment the default list rather than replacing it completely.
*
* @instance
* @type {object[]}
* @since 1.0.55
*/
sitePresets: null,
/**
* This can be configured to be a string array of the site preset values to be removed
* from both [sitePresets]{@link module:alfresco/services/SiteService#sitePresets} and
* [additionalSitePresets]{@link module:alfresco/services/SiteService#additionalSitePresets}.
* Note that unlike those attributes this is just a string array rather than an object
* array because only the site preset values (not labels) are matched.
*
* @instance
* @type {string[]}
* @default
* @since 1.0.95
*/
sitePresetsToRemove: null,
/**
* The standard home page for a user
*
* @instance
* @type {string}
* @default
* @since 1.0.39
*/
userHomePage: "/dashboard",
/**
* The prefix to apply to site locations to complete the URL for site home pages. Prior to
* version 5.1 of Share this would be "/dashboard" but from Share 5.1 onwards the site
* home page is configurable so should be configured to be the empty string.
*
* @instance
* @type {string}
* @default
* @since 1.0.95
*/
siteHomePage: "/dashboard",
/**
* Ensures that default [sitePresets]{@link module:alfresco/services/SiteService#sitePresets} are configured
* if no custom values have been provided.
*
* @instance
* @since 1.0.55
*/
initService: function alfresco_services_SiteService__initService() {
this.inherited(arguments);
if (!this.sitePresets)
{
this.sitePresets = [
{ label: "create-site.dialog.type.collaboration", value: "site-dashboard" }
];
}
if (this.additionalSitePresets &&
ObjectTypeUtils.isArray(this.additionalSitePresets) &&
this.additionalSitePresets.length)
{
this.sitePresets = this.sitePresets.concat(this.additionalSitePresets);
}
if (this.sitePresetsToRemove && this.sitePresetsToRemove.length)
{
this.sitePresets = array.filter(this.sitePresets, function(preset) {
return !array.some(this.sitePresetsToRemove, function(presetToRemove) {
return preset.value === presetToRemove;
});
}, this);
}
this.applyWidgetOverrides(this.widgetsForCreateSiteDialog, this.widgetsForCreateSiteDialogOverrides);
},
/**
* Sets up the subscriptions for the SiteService
*
* @instance
* @since 1.0.32
* @listens module:alfresco/core/topics#ADD_FAVOURITE_SITE
* @listens module:alfresco/core/topics#BECOME_SITE_MANAGER
* @listens module:alfresco/core/topics#CREATE_SITE
* @listens module:alfresco/core/topics#DELETE_SITE
* @listens module:alfresco/core/topics#EDIT_SITE
* @listens module:alfresco/core/topics#GET_FAVOURITE_SITES
* @listens module:alfresco/core/topics#GET_RECENT_SITES
* @listens module:alfresco/core/topics#GET_SITES
* @listens module:alfresco/core/topics#GET_USER_SITES
* @listens module:alfresco/core/topics#SITE_CREATION_REQUEST
* @listens module:alfresco/core/topics#VALIDATE_SITE_IDENTIFIER
*/
registerSubscriptions: function alfresco_services_SiteService__registerSubscriptions() {
this.alfSubscribe(topics.GET_SITES, lang.hitch(this, this.getSites));
this.alfSubscribe("ALF_GET_SITES_ADMIN", lang.hitch(this, this.getAdminSites));
this.alfSubscribe("ALF_GET_SITE_MEMBERSHIPS", lang.hitch(this, this.getSiteMemberships));
this.alfSubscribe("ALF_GET_SITE_DETAILS", lang.hitch(this, this.getSiteDetails));
this.alfSubscribe("ALF_UPDATE_SITE_DETAILS", lang.hitch(this, this.updateSite));
this.alfSubscribe(topics.BECOME_SITE_MANAGER, lang.hitch(this, this.becomeSiteManager));
this.alfSubscribe("ALF_JOIN_SITE", lang.hitch(this, this.joinSite));
this.alfSubscribe("ALF_REQUEST_SITE_MEMBERSHIP", lang.hitch(this, this.requestSiteMembership));
this.alfSubscribe("ALF_LEAVE_SITE", lang.hitch(this, this.leaveSiteRequest));
this.alfSubscribe("ALF_LEAVE_SITE_CONFIRMATION", lang.hitch(this, this.leaveSite));
this.alfSubscribe(topics.CREATE_SITE, lang.hitch(this, this.createSite));
this.alfSubscribe(topics.SITE_CREATION_REQUEST, lang.hitch(this, this.onCreateSiteData));
this.alfSubscribe(topics.EDIT_SITE, lang.hitch(this, this.editSite));
this.alfSubscribe(topics.SITE_EDIT_REQUEST, lang.hitch(this, this.editEditSiteData));
this.alfSubscribe(topics.DELETE_SITE, lang.hitch(this, this.onActionDeleteSite));
this.alfSubscribe(topics.ADD_FAVOURITE_SITE, lang.hitch(this, this.addSiteAsFavourite));
this.alfSubscribe("ALF_REMOVE_FAVOURITE_SITE", lang.hitch(this, this.removeSiteFromFavourites));
this.alfSubscribe(topics.GET_RECENT_SITES, lang.hitch(this, this.getRecentSites));
this.alfSubscribe(topics.GET_FAVOURITE_SITES, lang.hitch(this, this.getFavouriteSites));
this.alfSubscribe(topics.CANCEL_JOIN_SITE_REQUEST, lang.hitch(this, this.cancelJoinSiteRequest));
this.alfSubscribe(topics.GET_USER_SITES, lang.hitch(this, this.getUserSites));
this.alfSubscribe(topics.ENABLE_SITE_ACTIVITY_FEED, lang.hitch(this, this.enableSiteActivityFeed));
this.alfSubscribe(topics.DISABLE_SITE_ACTIVITY_FEED, lang.hitch(this, this.disableSiteActivityFeed));
this.alfSubscribe(topics.VALIDATE_SITE_IDENTIFIER, lang.hitch(this, this.validateSiteIdentifier));
},
/**
* Handles requests to enable the activity feed for a site (for the current user).
*
* @instance
* @param {object} payload The details of the site to enable the feed for
* @instance 1.0.87
*/
enableSiteActivityFeed: function alfresco_services_SiteService__enableSiteActivityFeed(payload) {
if (payload.siteId)
{
var config = {
url: AlfConstants.PROXY_URI + "api/activities/feed/control?s=" + payload.siteId,
method: "DELETE"
};
this.mergeTopicsIntoXhrPayload(payload, config);
this.serviceXhr(config);
}
else
{
this.alfLog("warn", "A request was made to enable the activity feed for a site, but no 'siteId' attribute was provided", payload, this);
}
},
/**
* Handles requests to disable the activity feed for a site (for the current user).
*
* @instance
* @param {object} payload The details of the site to disable the feed for
* @instance 1.0.87
*/
disableSiteActivityFeed: function alfresco_services_SiteService__disableSiteActivityFeed(payload) {
if (payload.siteId)
{
var config = {
url: AlfConstants.PROXY_URI + "api/activities/feed/control",
method: "POST",
data: {
siteId: payload.siteId
}
};
this.mergeTopicsIntoXhrPayload(payload, config);
this.serviceXhr(config);
}
else
{
this.alfLog("warn", "A request was made to disable the activity feed for a site, but no 'siteId' attribute was provided", payload, this);
}
},
/**
*
* @instance
* @param {object} payload The details of the request
*/
getSites: function alfresco_services_SiteService__getSites(payload) {
// TODO: Clean this up. Choose on or other as the Aikau standard.
var alfResponseTopic = payload.alfResponseTopic || payload.responseTopic;
var config = {
url: AlfConstants.PROXY_URI + "api/sites",
method: "GET",
alfTopic: alfResponseTopic
};
this.serviceXhr(config);
},
/**
*
* @instance
* @param {payload} payload The details of the user to retrieve sites for
* @since 1.0.87
*/
getUserSites: function alfresco_services_SiteService__getSites(payload) {
if (payload.userName)
{
var config = {
url: AlfConstants.PROXY_URI + "api/people/admin/sites",
method: "GET",
successCallback: this.onUserSitesSuccess,
failureCallback: this.onUserSitesFailure,
callbackScope: this
};
this.mergeTopicsIntoXhrPayload(payload, config);
this.serviceXhr(config);
}
else
{
this.alfLog("warn", "A request was made to get the sites for a user but no 'userName' attribute was provided", payload, this);
}
},
/**
* Handles successful requests to get users filtered by the supplied user name. Makes an additional
* XHR request to determine whether or not the user is being followed by the current user.
*
* @instance
* @param {object} response The response from the request
* @param {object} originalRequestConfig The configuration passed on the original request
* @since 1.0.86
*/
onUserSitesSuccess: function alfresco_services_SiteService__onUserSitesSuccess(response, originalRequestConfig) {
var url = AlfConstants.PROXY_URI + "api/activities/feed/controls";
var config = {
url: url,
sitesData: response,
initialRequestConfig: originalRequestConfig,
method: "GET",
successCallback: this.publishSites,
callbackScope: this
};
this.serviceXhr(config);
},
/**
* This is the success callback for [getUserSites]{@link module:alfresco/services/SiteService#getUserSites}.
*
* @instance
* @param {object} response The response from the request
* @param {object} originalRequestConfig The configuration passed on the original request
* @since 1.0.86
*/
publishSites: function alfresco_services_SiteService__publishSites(response, originalRequestConfig) {
var sites = originalRequestConfig.sitesData;
// Update the site data with the activity feed control data...
sites = array.map(sites, function(site) {
site.activityFeedEnabled = true;
if (site.shortName)
{
site.activityFeedEnabled = !array.some(response, function(feedControl) {
return feedControl.siteId === site.shortName;
});
return site;
}
}, this);
var topic = lang.getObject("initialRequestConfig.alfSuccessTopic", false, originalRequestConfig);
if (!topic)
{
topic = lang.getObject("initialRequestConfig.alfResponseTopic", false, originalRequestConfig);
}
if (topic)
{
this.alfPublish(topic, {
items: sites
});
}
},
/**
* This is the failure callback for [getUserSites]{@link module:alfresco/services/SiteService#getUserSites}.
*
* @instance
* @param {object} response The response from the request
* @param {object} originalRequestConfig The configuration passed on the original request
* @since 1.0.87
*/
onUserSitesFailure: function alfresco_services_UserService__onUserSitesFailure(response, originalRequestConfig) {
this.alfLog("error", "It was not possible to retrieve the sites for a user", response, originalRequestConfig, this);
},
/**
* Get sites list using the admin API - this returns ALL sites if the user is a member of the SITE_ADMINISTRATORS group.
*
* @instance
* @param {object} payload The details of the request
*/
getAdminSites: function alfresco_services_SiteService__getAdminSites(payload) {
// skipCount is the number of entries to skip, not pages so needs some maths:
var skipCount = (payload.page - 1) * payload.pageSize;
this.serviceXhr({
url: AlfConstants.PROXY_URI + "api/admin-sites?skipCount=" + skipCount + "&maxItems="+ payload.pageSize ,
method: "GET",
alfTopic: payload.responseTopic
});
},
/**
* This processes the results returned from the XHR request.
*
* @instance
* @param {object} response
* @param {object} originalRequestConfig
*/
getSitesSuccess: function alfresco_services_SiteService__getSitesSuccess(response, originalRequestConfig) {
if (ObjectTypeUtils.isArray(response))
{
var topic = originalRequestConfig.responseTopic || "ALF_SITES_LOADED";
var sitesData = {
items: response
};
this.alfPublish(topic, sitesData);
}
else
{
this.alfLog("error", "The request to retrieve available sites returned a response that could not be interpreted", response, originalRequestConfig, this);
}
},
/**
* This function makes a request to obtain the details of a specific site. Unlike the other functions
* in this service it requires a specific callback function and scope to be provided in the request
* as it doesn't make sense to just publish site information.
*
* @instance
* @param {object} config An object with the details of the site to retrieve the data for.
*/
getSiteDetails: function alfresco_services_SiteService__getSiteDetails(config) {
if (config && config.site && config.responseTopic)
{
var url = AlfConstants.PROXY_URI + "api/sites/" + config.site;
this.serviceXhr({url : url,
method: "GET",
site: config.site,
responseTopic: config.responseTopic,
successCallback: this.publishSiteDetails,
callbackScope: this});
}
else
{
this.alfLog("error", "A request to get the details of a site was made, but either the 'site' or 'responseTopic' attributes was not provided", config);
}
},
/**
* Publishes the details of a site on the requested topic. This is called
*
* @instance
* @param {object} response The response from the request
* @param {object} originalRequestConfig The configuration passed on the original request
*/
publishSiteDetails: function alfresco_services_SiteService__publishSiteDetails(response, originalRequestConfig) {
if (originalRequestConfig && originalRequestConfig.responseTopic)
{
this.alfLog("log", "Publishing site details", originalRequestConfig);
this.alfPublish(originalRequestConfig.responseTopic, response);
}
else
{
this.alfLog("error", "It was not possible to publish requested site details because the 'responseTopic' attribute was not set on the original request", response, originalRequestConfig);
}
},
/**
* This function handles requests to update a specific site
*
* @instance
* @param {object} payload Details of the update
*/
updateSite: function alfresco_services_SiteService__updateSite(payload) {
var shortName = lang.getObject("shortName", false, payload);
if (shortName)
{
var url = AlfConstants.PROXY_URI + "api/sites/" + shortName;
this.serviceXhr({
url: url,
method: "PUT",
data: payload,
alfTopic: payload.responseTopic
});
}
else
{
this.alfLog("warn", "A request was made to update a site but no 'shortName' attribute was provided", payload, this);
}
},
/**
* Handles requests to delete the supplied site.
*
* @instance
* @param {object} payload The details of the site to delete
*/
onActionDeleteSite: function alfresco_services_SiteService__onActionDeleteSite(payload) {
var shortName = lang.getObject("document.shortName", false, payload) || lang.getObject("shortName", false, payload);
if (shortName)
{
var responseTopic = this.generateUuid();
this._actionDeleteHandle = this.alfSubscribe(responseTopic, lang.hitch(this, "onActionDeleteSiteConfirmation"), false);
this.alfPublish("ALF_CREATE_DIALOG_REQUEST", {
dialogId: "ALF_SITE_SERVICE_DIALOG",
dialogTitle: this.message("message.delete-site-confirm-title"),
textContent: this.message("message.delete-site-prompt", { "0": shortName}),
widgetsButtons: [
{
id: "ALF_SITE_SERVICE_DIALOG_CONFIRMATION",
name: "alfresco/buttons/AlfButton",
config: {
label: this.message("button.delete-site.confirm-label"),
publishTopic: this.pubSubScope + responseTopic,
publishPayload: payload
}
},
{
id: "ALF_SITE_SERVICE_DIALOG_CANCELLATION",
name: "alfresco/buttons/AlfButton",
config: {
label: this.message("button.delete-site.cancel-label"),
publishTopic: "close"
}
}
]
});
}
else
{
this.alfLog("warn", "A request was made to delete a site but no 'shortName' attribute was provided", document, this);
}
},
/**
* This function is called when the user confirms that they wish to delete a site
*
* @instance
* @param {object} payload An object containing the details of the site to be deleted.
*/
onActionDeleteSiteConfirmation: function alfresco_services_SiteService__onActionDeleteSiteConfirmation(payload) {
this.alfUnsubscribeSaveHandles([this._actionDeleteHandle]);
var responseTopic = this.generateUuid();
var subscriptionHandle = this.alfSubscribe(responseTopic + "_SUCCESS", lang.hitch(this, this.onActionDeleteSiteSuccess), false);
var shortName = lang.getObject("document.shortName", false, payload) || lang.getObject("shortName", false, payload);
if (shortName)
{
var url = AlfConstants.PROXY_URI + "api/sites/" + shortName;
this.serviceXhr({
alfTopic: responseTopic,
subscriptionHandle: subscriptionHandle,
url: url,
data: payload,
method: "DELETE"
});
}
else
{
this.alfLog("warn", "A request was made to delete a site but no 'shortName' attribute was provided", document, this);
}
},
/**
* This action will be called when a site is successfully deleted
*
* @instance
* @param {object} payload
* @fires module:alfresco/core/topics#NAVIGATE_TO_PAGE
* @fires module:alfresco/core/topics#RELOAD_DATA_TOPIC
*/
onActionDeleteSiteSuccess: function alfresco_services_SiteService__onActionDeleteSiteSuccess(payload) {
var subscriptionHandle = lang.getObject("requestConfig.subscriptionHandle", false, payload);
if (subscriptionHandle)
{
this.alfUnsubscribe(subscriptionHandle);
}
var redirect = lang.getObject("requestConfig.data.redirect", false, payload);
if (redirect)
{
this.alfServicePublish(topics.NAVIGATE_TO_PAGE, {
url: redirect.url,
type: redirect.type,
target: redirect.target
});
}
else
{
this.reloadData();
}
},
/**
* Handles requesting that a site be made a favourite.
*
* @instance
* @param {object} payload The payload containing the details of the site to add to the favourites list
*/
addSiteAsFavourite: function alfresco_services_SiteService__addSiteAsFavourite(payload) {
if (payload.site && payload.user)
{
// Set up the favourites information...
var url = AlfConstants.PROXY_URI + "api/people/" + encodeURIComponent(payload.user) + "/preferences",
favObj = {org:{alfresco:{share:{sites:{favourites:{}}}}}};
favObj.org.alfresco.share.sites.favourites[payload.site] = true;
this.serviceXhr({url : url,
site: payload.site,
user: payload.user,
title: payload.title,
data: favObj,
method: "POST",
successCallback: this.favouriteSiteAdded,
callbackScope: this,
alfResponseScope: payload.alfResponseScope});
}
else
{
// Handle error conditions...
this.alfLog("error", "A request to make a site a favourite but either the site or user was not specified", payload);
}
},
/**
* This handles successfully completed requests to remove a site from the favourites list for a user. It publishes the
* details on "ALF_FAVOURITE_SITE_ADDED" topic.
*
* @instance
* @param {object} response The response from the request
* @param {object} originalRequestConfig The configuration passed on the original request
*/
favouriteSiteAdded: function alfresco_services_SiteService__favouriteSiteAdded(response, originalRequestConfig) {
this.alfLog("log", "Favourite Site Added Successfully", response, originalRequestConfig);
this.alfPublish("ALF_FAVOURITE_SITE_ADDED", {
site: originalRequestConfig.site,
user: originalRequestConfig.user,
title: originalRequestConfig.title
}, false, false, originalRequestConfig.alfResponseScope);
},
/**
* Handles requesting that a site be removed from favourites
*
* @instance
* @param {object} payload The payload containing the details of the site to remove from the favourites list
*/
removeSiteFromFavourites: function alfresco_services_SiteService__removeSiteFromFavourites(payload) {
if (payload.site && payload.user)
{
// Set up the favourites information...
var url = AlfConstants.PROXY_URI + "api/people/" + encodeURIComponent(payload.user) + "/preferences?pf=org.alfresco.share.sites.favourites." + payload.site;
this.serviceXhr({url : url,
site: payload.site,
user: payload.user,
title: payload.title,
method: "DELETE",
successCallback: this.favouriteSiteRemoved,
callbackScope: this,
alfResponseScope: payload.alfResponseScope});
}
else
{
// Handle error conditions...
this.alfLog("error", "A request to remove a site from the favourites list but either the site or user was not specified", payload);
}
},
/**
* This handles successfully completed requests to remove a site from the favourites list for a user. It publishes the
* details on "ALF_FAVOURITE_SITE_REMOVED" topic.
*
* @instance
* @param {object} response The response from the XHR request to remove the site.
* @param {object} originalRequestConfig The original configuration passed when the request was made.
*/
favouriteSiteRemoved: function alfresco_services_SiteService_favouriteSiteRemoved(response, originalRequestConfig) {
this.alfLog("log", "Favourite Site Removed Successfully", response, originalRequestConfig);
this.alfPublish("ALF_FAVOURITE_SITE_REMOVED", {
site: originalRequestConfig.site,
user: originalRequestConfig.user,
title: originalRequestConfig.title
}, false, false, originalRequestConfig.alfResponseScope);
},
/**
* Retrieves the site membership data for the supplied site.
*
* @instance
* @param {object} payload The details of the site to retrieve member data for
*/
getSiteMemberships: function alfresco_services_SiteService__getSiteMemberships(payload) {
if (payload && payload.site && payload.responseTopic)
{
var url = AlfConstants.PROXY_URI + "api/sites/" + payload.site + "/memberships";
this.serviceXhr({url : url,
method: "GET",
alfTopic: payload.responseTopic});
}
else
{
this.alfLog("error", "A request to get the details of a site was made, but either the 'site' or 'responseTopic' attributes was not provided", payload);
}
},
/**
* Handles XHR posting to make a user a site manager.
*
* @instance
* @param {object} data The payload containing the user status to post.
*/
becomeSiteManager: function alfresco_services_SiteService__becomeSiteManager(config) {
if (config.site)
{
this.alfLog("log", "A request has been made for a user to become the manager of a site: ", config);
var url = AlfConstants.PROXY_URI + "api/sites/" + encodeURIComponent(config.site) + "/memberships";
var data = {
role: (config.role) ? config.role : "SiteManager",
person: {
userName: (config.user) ? config.user : AlfConstants.USERNAME
}
};
this.serviceXhr({url : url,
data: data,
method: "POST",
successCallback: config.reloadPage ? this.reloadPage : this.reloadData,
callbackScope: this});
}
else
{
// Handle error conditions...
this.alfLog("error", "A request was made for a user to become the manager of a site, but no site was specified", config);
}
},
/**
* Handles requests to request membership of a moderated site
*
* @instance
* @param {object} config The configuration for the join request.
*/
requestSiteMembership: function alfresco_services_SiteService__requestSiteMembership(config) {
if (config.site && config.user)
{
// PLEASE NOTE: The default role for joining a site is "SiteConsumer", however this can be overridden
// if a role is included in the supplied configuration...
this.alfLog("log", "A request has been made for a user to join a site: ", config);
var url = AlfConstants.PROXY_URI + "api/sites/" + encodeURIComponent(config.site) + "/invitations";
var data = {
invitationType: "MODERATED",
inviteeRoleName: (config.role) ? config.role : "SiteConsumer",
inviteeUserName: config.user,
inviteeComments: (config.comments) ? config.comments : ""
};
// Make the XHR request...
this.serviceXhr({url : url,
method: "POST",
site: config.site,
siteTitle: config.siteTitle,
user: config.user,
data: data,
successCallback: this.siteMembershipRequestComplete,
failureCallback: this.siteMembershipRequestFailed,
callbackScope: this});
}
else
{
// Handle error conditions...
if (!config.site)
{
this.alfLog("error", "A request was made to join a site but no site was specified", config);
}
if (!config.user)
{
this.alfLog("error", "A request was made to join a site but no user was specified", config);
}
}
},
/**
* Cancel a pending request to join a site
*
* @instance
* @param {object} payload The publication payload
* @since 1.0.58
*/
cancelJoinSiteRequest: function alfresco_services_SiteService__cancelJoinSiteRequest(payload) {
var siteId = payload.siteId,
siteTitle = payload.siteTitle,
encodedSiteId = encodeURIComponent(siteId),
pendingInvite = encodeURIComponent(payload.pendingInvite.id),
url = AlfConstants.PROXY_URI + "api/sites/" + encodedSiteId + "/invitations/" + pendingInvite;
this.serviceXhr({
url: url,
siteTitle: siteTitle || siteId,
method: "DELETE",
successCallback: this._cancelJoinSiteRequestSuccess,
callbackScope: this
});
},
/**
* Success-handler for the request to cancel a join-site request.
*
* @instance
* @param {object} response The response object
* @param {object} originalRequestConfig The original configuration passed when the request was made
* @since 1.0.58
*/
_cancelJoinSiteRequestSuccess: function alfresco_services_SiteService___cancelJoinSiteRequestSuccess(response, originalRequestConfig) {
this.displayMessage(this.message("message.cancel-join-request-success", {
"0": originalRequestConfig.siteTitle
}), {
publishTopic: topics.RELOAD_PAGE // This is more reliable than an arbitrary timeout in ensuring the message will be displayed before reloading
});
},
/**
* Callback that occurs after a request to join a moderated site is complete.
*
* @instance
* @param {object} response The response from the XHR request to join the site.
* @param {object} originalRequestConfig The original configuration passed when the request was made.
*/
siteMembershipRequestComplete: function alfresco_services_SiteService__siteMembershipRequestComplete(response, originalRequestConfig) {
this.alfLog("log", "User has successfully requested to join a moderated site", response, originalRequestConfig);
this.alfServicePublish(topics.CREATE_DIALOG, {
dialogTitle: this.message("message.request-join-success-title"),
textContent: this.message("message.request-join-success", {"0": originalRequestConfig.user, "1": originalRequestConfig.siteTitle || originalRequestConfig.site}),
widgetsButtons: [
{
name: "alfresco/buttons/AlfButton",
config: {
label: this.message("button.leave-site.confirm-label"),
publishTopic: "ALF_NAVIGATE_TO_PAGE",
publishPayload: {
url: "user/" + encodeURIComponent(originalRequestConfig.user) + this.userHomePage.replace(/^\/*/, "/"),
type: urlTypes.PAGE_RELATIVE,
target: "CURRENT"
},
additionalCssClasses: "call-to-action"
}
}
]
});
},
/**
* Callback that occurs after a request to join a moderated site has failed.
*
* @instance
* @param {object} response The response from the XHR request to join the site.
* @param {object} originalRequestConfig The original configuration passed when the request was made.
* @since 1.0.58
*/
siteMembershipRequestFailed: function alfresco_services_SiteService__siteMembershipRequestFailed(response, originalRequestConfig) {
this.alfLog("warn", "Request to join site failed:", originalRequestConfig);
var responseMessage = lang.getObject("response.text", false, response),
requestPendingMessage = "A request to join this site is in pending", // NOTE: This is a string-literal in Share's "Site.java" file
failedBecausePending = responseMessage && responseMessage.indexOf(requestPendingMessage) !== -1,
failureMessage = failedBecausePending ? "message.request-join-site-pending-failure" : "message.request-join-site-failure";
this.displayMessage(this.message(failureMessage));
},
/**
* Performs and XHR put request to make the user a member of the site. The argument supplied must include
* the attributes "site" and "user" and can optionally include an attribute "role".
*
* @instance
* @param {object} config The configuration for the join request.
*/
joinSite: function alfresco_services_SiteService__joinSite(config) {
if (config.site && config.user)
{
// PLEASE NOTE: The default role for joining a site is "SiteConsumer", however this can be overridden
// if a role is included in the supplied configuration...
this.alfLog("log", "A request has been made for a user to join a site: ", config);
var url = AlfConstants.PROXY_URI + "api/sites/" + encodeURIComponent(config.site) + "/memberships";
var data = {
role: (config.role) ? config.role : "SiteConsumer",
person: {
userName: config.user
}
};
// Make the XHR request...
this.serviceXhr({url : url,
method: "PUT",
site: config.site,
user: config.user,
data: data,
successCallback: this.siteJoined,
callbackScope: this});
}
else
{
// Handle error conditions...
if (!config.site)
{
this.alfLog("error", "A request was made to join a site but no site was specified", config);
}
if (!config.user)
{
this.alfLog("error", "A request was made to join a site but no user was specified", config);
}
}
},
/**
* This function is called when a user successfully joins a site.
*
* @instance
* @param {object} response The response from the XHR request to join the site.
* @param {object} originalRequestConfig The original configuration passed when the request was made.
* @fires module:alfresco/core/topics#DISPLAY_NOTIFICATION
*/
siteJoined: function alfresco_services_SiteService__siteJoined(response, originalRequestConfig) {
this.alfLog("log", "User has successfully joined a site", response, originalRequestConfig);
this.alfServicePublish(topics.DISPLAY_NOTIFICATION, {
message: this.message("message.joining", {
"0": originalRequestConfig.user,
"1": originalRequestConfig.site
}),
publishTopic: "ALF_RELOAD_PAGE"
});
},
/**
* This method delegates site creation to the legacy YUI popup as found in Alfresco Share unless the
* [legacyMode]{@link module:alfresco/services/SiteService#legacyMode} is configured to be false, in which
* case a request is published to display a form dialog containing the
* [widgetsForCreateSiteDialog]{@link module:alfresco/services/SiteService#widgetsForCreateSiteDialog}.
*
* @instance
* @param {object} payload The payload published with the request to create a site
* @fires module:alfresco/core/topics#CREATE_FORM_DIALOG
*/
createSite: function alfresco_services_SiteService__createSite(config) {
this.alfLog("log", "A request has been made to create a site: ", config);
if (this.legacyMode)
{
/* global Alfresco */
if (Alfresco && Alfresco.module && typeof Alfresco.module.getCreateSiteInstance === "function")
{
Alfresco.module.getCreateSiteInstance().show();
}
else
{
this.alfLog("error", "Could not find the 'Alfresco.module.getCreateSiteInstance' function - has 'create-site.js' been included in the page?");
}
}
else
{
var dialogWidgets = lang.clone(this.widgetsForCreateSiteDialog);
this.processObject(["processInstanceTokens"], dialogWidgets);
this.alfServicePublish(topics.CREATE_FORM_DIALOG, {
pubSubScope: "ALF_CREATE_SITE_",
dialogId: "CREATE_SITE_DIALOG",
dialogTitle: "create-site.dialog.title",
dialogConfirmationButtonTitle: "create-site-dialog.name.create.label",
dialogCloseTopic: topics.SITE_CREATION_SUCCESS,
contentHeight: this.createSiteDialogHeight,
contentWidth: this.createSiteDialogWidth,
formSubmissionTopic: topics.SITE_CREATION_REQUEST,
formSubmissionGlobal: true,
showValidationErrorsImmediately: false,
customFormConfig: {
publishValueSubscriptions: [topics.ENTER_KEY_PRESSED],
setValueTopic: this.setCreateSiteDialogValueTopic
},
widgets: dialogWidgets
});
}
},
/**
* Attempts to create a new site using the data provided in the supplied payload.
*
* @instance
* @param {object} payload The payload containing the data for the site to create
* @since 1.0.55
* @fires module:alfresco/core/topics#DISPLAY_NOTIFICATION
*/
onCreateSiteData: function alfresco_services_SiteService__onCreateSiteData(payload) {
if (payload.visibility &&
payload.title &&
payload.shortName &&
payload.sitePreset)
{
this.alfServicePublish(topics.DISPLAY_NOTIFICATION, {
message: this.message("create-site.creating")
});
// Ensure that all supplied data is included in the request.
var data = this.alfCleanFrameworkAttributes(payload, false);
data.description = data.description || "";
var url = AlfConstants.URL_SERVICECONTEXT + "modules/create-site";
this.serviceXhr({
url : url,
method: "POST",
data: data,
successCallback: this.onSiteCreationSuccess,
failureCallback: this.onSiteCreationFailure,
callbackScope: this
});
}
else
{
this.alfLog("warn", "A request was made to create a site but the supplied payload was missing one or more of 'visibility', 'title', 'shortName' and 'sitePreset' attributes", payload, this);
}
},
/**
* Handles the successful creation of a new site.
*
*
* @instance
* @param {object} response The response from the request to create the site
* @param {object} originalRequestConfig The configuration for the request to create the site
* @since 1.0.55
* @fires module:alfresco/core/topics#ADD_FAVOURITE_SITE
* @fires module:alfresco/core/topics#SITE_CREATION_SUCCESS
* @fires module:alfresco/core/topics#NAVIGATE_TO_PAGE
*/
onSiteCreationSuccess: function alfresco_services_SiteService__onSiteCreationSuccess(/*jshint unused:false*/ response, originalRequestConfig) {
// See AKU-1108 - Need to ensure that favourite is added before navigating to the new page...
// Intentionally not cleaning up subscription because page will change...
this.alfSubscribe("ALF_FAVOURITE_SITE_ADDED", lang.hitch(this, function() {
this.alfServicePublish(topics.SITE_CREATION_SUCCESS);
this.alfServicePublish(topics.NAVIGATE_TO_PAGE, {
url: "site/" + originalRequestConfig.data.shortName + "/dashboard"
});
}));
// Mark the new site as a favourite...
this.alfServicePublish(topics.ADD_FAVOURITE_SITE, {
site: originalRequestConfig.data.shortName,
user: AlfConstants.USERNAME
});
},
/**
* Handles failed requests to create a site.
*
* @instance
* @param {object} response The response from the request to create the site
* @param {object} originalRequestConfig The configuration for the request to create the site
* @since 1.0.55
* @fires module:alfresco/core/topics#DISPLAY_PROMPT
*/
onSiteCreationFailure: function alfresco_services_SiteService__onSiteCreationFailure(response, /*jshint unused:false*/ originalRequestConfig) {
var responseText = JSON.parse(response.response.text);
this.alfServicePublish(topics.DISPLAY_PROMPT, {
title: "create-site.failure.dialog.title",
message: this.message(responseText.message)
});
},
/**
* This method delegates edit creation to the legacy YUI popup as found in Alfresco Share unless the
* [legacyMode]{@link module:alfresco/services/SiteService#legacyMode} is configured to be false, in which
* case a request is published to get the full site details in order to display a form dialog containing the
* [widgetsForEditSiteDialog]{@link module:alfresco/services/SiteService#widgetsForEditSiteDialog}.
*
* @instance
* @param {string} site
*/
editSite: function alfresco_services_SiteService__editSite(config) {
this.alfLog("log", "A request has been made to edit a site: ", config);
if (this.legacyMode)
{
/* global Alfresco */
if (Alfresco && Alfresco.module && typeof Alfresco.module.getEditSiteInstance === "function")
{
Alfresco.module.getEditSiteInstance().show({
shortName: config.site
});
}
else
{
// Make sure that the edit-site.js file is loaded. This is required for as it handles legacy site
// editing. At some stage this will not be needed when a new edit site dialog is provided.
var legacyEditSiteResource = AlfConstants.URL_RESCONTEXT + "modules/edit-site" + (AlfConstants.DEBUG ? ".js" : "-min.js");
require([legacyEditSiteResource], lang.hitch(this, function() {
this.alfLog("log", "Edit Site JavaScript resource loaded");
Alfresco.module.getEditSiteInstance().show({
shortName: config.site
});
}));
}
}
else
{
// Get the site data to display...
var url = AlfConstants.PROXY_URI + "api/sites/" + config.site;
this.serviceXhr({url : url,
method: "GET",
site: config.site,
successCallback: this.showEditSiteDialog,
callbackScope: this});
}
},
/**
* This is called as a result of [editSite]{@link module:alfresco/services/SiteService#editSite} being used
* when [legacyMode]{@link module:alfresco/services/SiteService#legacyMode} is configured to be false. It
* takes the site data supplied in the response and publishes a request to display a form dialog containing the
* [widgetsForEditSiteDialog]{@link module:alfresco/services/SiteService#widgetsForEditSiteDialog}.
*
* @instance
* @param {object} response The details of the site to be edited
* @param {object} originalRequestConfig The details of the request made to obtain site data
* @fires module:alfresco/core/topics#CREATE_FORM_DIALOG
*/
showEditSiteDialog: function alfresco_services_SiteService__showEditSiteDialog(response, originalRequestConfig) {
// Check that the response is the expected siteData...
if (response)
{
var shortName = lang.getObject("shortName", false, response);
var dialogWidgets = lang.clone(this.widgetsForEditSiteDialog);
this.processObject(["processInstanceTokens"], dialogWidgets);
this.alfServicePublish(topics.CREATE_FORM_DIALOG, {
pubSubScope: "ALF_EDIT_SITE_",
dialogId: "EDIT_SITE_DIALOG",
dialogTitle: "edit-site.dialog.title",
dialogConfirmationButtonTitle: "edit-site-dialog.name.save.label",
dialogCloseTopic: topics.SITE_EDIT_SUCCESS,
formSubmissionTopic: topics.SITE_EDIT_REQUEST,
formSubmissionPayloadMixin: {
shortName: shortName
},
formSubmissionGlobal: true,
formValue: response,
showValidationErrorsImmediately: false,
customFormConfig: {
publishValueSubscriptions: [topics.ENTER_KEY_PRESSED],
setValueTopic: this.setEditSiteDialogValueTopic
},
widgets: dialogWidgets
});
}
else
{
this.alfLog("warn", "It was not possible to retrieve the current site data for editing", response, originalRequestConfig, this);
}
},
/**
* Attempts to edit a site using the data supplied in the payload.
*
* @instance
* @param {object} payload The payload containing the data for the site to create
* @since 1.0.55
* @fires module:alfresco/core/topics#DISPLAY_NOTIFICATION
*/
editEditSiteData: function alfresco_services_SitesService__editEditSiteData(payload) {
if (payload.shortName &&
payload.visibility &&
payload.title)
{
this.alfServicePublish(topics.DISPLAY_NOTIFICATION, {
message: this.message("edit-site.saving")
});
// Ensure that all supplied data is included in the request.
var data = this.alfCleanFrameworkAttributes(payload, false);
data.description = data.description || "";
var url = AlfConstants.PROXY_URI + "api/sites/" + payload.shortName;
this.serviceXhr({
url : url,
method: "PUT",
data: data,
successCallback: this.onSiteEditSuccess,
failureCallback: this.onSiteEditFailure,
callbackScope: this
});
}
else
{
this.alfLog("warn", "A request was made to create a site but the supplied payload was missing one or more of 'visibility', 'title', 'shortName' and 'sitePreset' attributes", payload, this);
}
},
/**
* Handles the successful editing of site details.
*
* @instance
* @param {object} response The response from the request to edit the site
* @param {object} originalRequestConfig The configuration for the request to edit the site
* @since 1.0.55
* @fires module:alfresco/core/topics#SITE_CREATION_SUCCESS
* @fires module:alfresco/core/topics#NAVIGATE_TO_PAGE
*/
onSiteEditSuccess: function alfresco_services_SiteService__onSiteEditSuccess(/*jshint unused:false*/ response, originalRequestConfig) {
this.alfServicePublish(topics.SITE_EDIT_SUCCESS);
this.alfServicePublish(topics.NAVIGATE_TO_PAGE, {
url: "site/" + originalRequestConfig.data.shortName + this.siteHomePage
});
},
/**
* Handles failed requests to edit a site.
*
* @instance
* @param {object} response The response from the request to edit the site
* @param {object} originalRequestConfig The configuration for the request to edit the site
* @since 1.0.55
* @fires module:alfresco/core/topics#DISPLAY_PROMPT
*/
onSiteEditFailure: function alfresco_services_SiteService__onSiteEditFailure(response, /*jshint unused:false*/ originalRequestConfig) {
var responseText = JSON.parse(response.response.text);
this.alfServicePublish(topics.DISPLAY_PROMPT, {
title: "edit-site.failure.dialog.title",
message: this.message(responseText.message)
});
},
/**
* Handles a request to leave a site.
*
* @instance
* @param {object} payload
*/
leaveSiteRequest: function alfresco_services_SiteService__leaveSiteReqest(payload) {
this.alfPublish("ALF_CREATE_DIALOG_REQUEST", {
dialogId: "ALF_SITE_SERVICE_DIALOG",
dialogTitle: this.message("message.leave", { "0": payload.siteTitle}),
textContent: this.message("message.leave-site-prompt", { "0": payload.siteTitle}),
widgetsButtons: [
{
name: "alfresco/buttons/AlfButton",
config: {
label: this.message("button.leave-site.confirm-label"),
publishTopic: "ALF_LEAVE_SITE_CONFIRMATION",
publishPayload: payload,
additionalCssClasses: "call-to-action"
}
},
{
name: "alfresco/buttons/AlfButton",
config: {
label: this.message("button.leave-site.cancel-label"),
publishTopic: "ALF_LEAVE_SITE_CANCELLATION",
publishPayload: payload
}
}
]
});
},
/**
*
* @instance
* @param {string} site The name of the site to leave
* @param {string} user The name of the user to leave the site
*/
leaveSite: function alfresco_services_SiteService__leaveSite(config) {
if (config.site && config.user)
{
this.alfLog("log", "A request has been made for a user to leave a site: ", config);
var url = AlfConstants.PROXY_URI + "api/sites/" + encodeURIComponent(config.site) + "/memberships/" + encodeURIComponent(config.user);
this.serviceXhr({url : url,
method: "DELETE",
site: config.site,
siteTitle: config.siteTitle,
user: config.user,
userFullName: config.userFullName,
successCallback: this.siteLeft,
failureCallback: this.siteLeftFailure,
callbackScope: this});
}
else
{
// Handle error conditions...
if (!config.site)
{
this.alfLog("error", "A request was made to leave a site but no site was specified", config);
}
if (!config.user)
{
this.alfLog("error", "A request was made to leave a site but no user was specified", config);
}
}
},
/**
* This function is called when a user has successfully left a site.
*
* @instance
* @param {object} response The response from the XHR request to leave the site.
* @param {object} originalRequestConfig The original configuration passed when the request was made.
*/
siteLeft: function alfresco_services_SiteService__siteLeft(response, originalRequestConfig) {
this.alfLog("log", "User has successfully left a site", response, originalRequestConfig);
this.displayMessage(this.message("message.leaving", {"0": originalRequestConfig.userFullName, "1": originalRequestConfig.siteTitle}));
this.alfPublish("ALF_SITE_LEFT", { site: originalRequestConfig.site, user: originalRequestConfig.user});
this.leaveSiteSuccess(response, originalRequestConfig);
},
/**
* This function is called when a user has failued to leave a site.
*
* @instance
* @param {object} response The response from the XHR request to leave the site.
* @param {object} originalRequestConfig The original configuration passed when the request was made.
*/
siteLeftFailure: function alfresco_services_SiteService__siteLeftFailure(response, originalRequestConfig) {
this.alfLog("log", "User has failed to leave a site", response, originalRequestConfig);
this.displayMessage(this.message("message.leave-failure", {"0": originalRequestConfig.userFullName, "1": originalRequestConfig.siteTitle}));
},
/**
* This is a catch all success handler for both the join site and become site manager. It simply reloads
* the current page. It is ** INCORRECTLY ** assumed that the current user will always be on the site
* referenced in the request. This method needs to be updated accordingly.
*
* @instance
* @fires module:alfresco/core/topics#RELOAD_PAGE
*/
reloadPage: function alfresco_services_SiteService__reloadPage(response, requestConfig) {
/*jshint unused:false*/
// TODO: Check user in request is current user and that site in request is current site
this.alfPublish(topics.RELOAD_PAGE);
},
/**
* This is a method that reloads DocList data
*
* @instance
* @fires module:alfresco/core/topics#RELOAD_DATA_TOPIC
*/
reloadData: function alfresco_services_SiteService__reloadData(response, requestConfig) {
/*jshint unused:false*/
this.alfPublish(topics.RELOAD_DATA_TOPIC);
},
/**
* When a request is made for a user to leave a site we should determine whether or not the current user is the
* user removed and whether or not they are currently viewing that site. If they are then we should navigate
* them away from the site and back to their dashboard.
*
* In a future where notifications are generated based on events generated by other users, this would mean
* that a user can be immediately ejected from a site as soon as they are removed from it (e.g. A Site Manager
* removes a user from a site and if that user is viewing the site they are "ejected").
*
* @instance
*/
leaveSiteSuccess: function alfresco_services_SiteService__leaveSiteSuccess(response, requestConfig) {
this.alfServicePublish("ALF_NAVIGATE_TO_PAGE", {
url: "user/" + encodeURIComponent(requestConfig.user) + this.userHomePage.replace(/^\/*/, "/"),
type: urlTypes.PAGE_RELATIVE,
target: "CURRENT"
});
},
/**
* Handles requests to retrieve the current users list of recently visited sites.
*
* @instance
* @param {object} payload
*/
getRecentSites: function alfresco_services_SiteService__getRecentSites(payload) {
var url = AlfConstants.PROXY_URI + "api/people/" + AlfConstants.USERNAME + "/sites/recent";
if (this.currentSite)
{
url = url + "/site/" + this.currentSite;
}
var alfTopic = payload.alfResponseTopic || topics.GET_RECENT_SITES;
var config = {
alfTopic: alfTopic,
url: url,
method: "GET",
callbackScope: this
};
this.serviceXhr(config);
},
/**
* Handles requests to retrieve the current users list of favourite sites.
*
* @instance
* @param {object} payload
*/
getFavouriteSites: function alfresco_services_SiteService__getFavouriteSites(payload) {
var url = AlfConstants.PROXY_URI + "api/people/" + AlfConstants.USERNAME + "/sites/favourites";
if (this.currentSite)
{
url = url + "/site/" + this.currentSite;
}
var alfTopic = payload.alfResponseTopic || topics.GET_FAVOURITE_SITES;
var config = {
alfTopic: alfTopic,
url: url,
method: "GET",
callbackScope: this
};
this.serviceXhr(config);
},
/**
* Handles requests to validate whether or not a suggested site title or shortName has
* already been used.
*
* @instance
* @param {object} payload
* @since 1.0.89
*/
validateSiteIdentifier: function alfresco_services_SiteService__validateSiteIdentifier(payload) {
var url = AlfConstants.PROXY_URI + "slingshot/site-identifier-used?";
if (typeof payload.title === "undefined" && typeof payload.shortName === "undefined")
{
this.alfLog("warn", "A request was made to validate site identification but neither 'title' nor 'shortName' was provided", payload, this);
}
else
{
url += payload.shortName ? ("shortName=" + encodeURIComponent(payload.shortName)) : ("title=" + encodeURIComponent(payload.title));
var config = {
url: url,
method: "GET",
callbackScope: this
};
this.mergeTopicsIntoXhrPayload(payload, config);
this.serviceXhr(config);
}
},
/**
* This is the widget model displayed when creating sites.
*
* @instance
* @type {object[]}
* @since 1.0.55
*/
widgetsForCreateSiteDialog: [
{
id: "CREATE_SITE_FIELD_PRESET",
name: "alfresco/forms/controls/Select",
config: {
fieldId: "PRESET",
label: "create-site.dialog.type.label",
name: "sitePreset",
optionsConfig: {
fixed: "{sitePresets}"
}
}
},
{
id: "CREATE_SITE_FIELD_TITLE",
name: "alfresco/forms/controls/TextBox",
config: {
fieldId: "TITLE",
label: "create-site.dialog.name.label",
name: "title",
trimValue: true,
requirementConfig: {
initialValue: true
},
validationConfig: [
{
validation: "maxLength",
length: 256,
errorMessage: "create-site.dialog.name.maxLength"
},
{
scopeValidation: true,
warnOnly: true,
validation: "validationTopic",
validationTopic: topics.VALIDATE_SITE_IDENTIFIER,
validationValueProperty: "title",
negate: true,
validationResultProperty: "response.used",
errorMessage: "create-site-dialog.title.already.used"
}
]
}
},
{
id: "CREATE_SITE_FIELD_SHORTNAME",
name: "alfresco/forms/controls/MaskingTextBox",
config: {
fieldId: "SHORTNAME",
targetId: "TITLE",
replacements: [
{
regex: "[^a-z0-9-\\s]",
flags: "gi"
},
{
regex: "\\s+",
replacement: "-",
flags: "g"
}
],
trimValue: true,
label: "create-site.dialog.urlname.label",
description: "create-site.dialog.urlname.description",
name: "shortName",
requirementConfig: {
initialValue: true
},
validationConfig: [
{
validation: "maxLength",
length: 72,
errorMessage: "create-site.dialog.urlname.maxLength"
},
{
validation: "regex",
regex: "^[0-9a-zA-Z-]+$",
errorMessage: "create-site.dialog.urlname.regex"
},
{
scopeValidation: true,
validation: "validationTopic",
validationTopic: topics.VALIDATE_SITE_IDENTIFIER,
validationValueProperty: "shortName",
negate: true,
validationResultProperty: "response.used",
errorMessage: "create-site-dialog.name.already.used"
}
]
}
},
{
id: "CREATE_SITE_FIELD_DESCRIPTION",
name: "alfresco/forms/controls/TextArea",
config: {
fieldId: "DESCRIPTION",
label: "create-site.dialog.description.label",
name: "description",
validationConfig: [
{
validation: "maxLength",
length: 512,
errorMessage: "create-site.dialog.description.maxLength"
}
]
}
},
{
id: "CREATE_SITE_FIELD_VISIBILITY",
name: "alfresco/forms/controls/RadioButtons",
config: {
fieldId: "VISIBILITY",
label: "create-site.dialog.visibility.label",
name: "visibility",
optionsConfig: {
fixed: [
{
label: "create-site.dialog.visibility.public",
description: "create-site.dialog.visibility.public.description",
value: "PUBLIC"
},
{
label: "create-site.dialog.visibility.moderated",
description: "create-site.dialog.visibility.moderated.description",
value: "MODERATED"
},
{
label: "create-site.dialog.visibility.private",
description: "create-site.dialog.visibility.private.description",
value: "PRIVATE"
}
]
}
}
}
],
/**
* Overrides for the [default edit site dialog model]{@link module:alfresco/services/SiteService#widgetsForCreateSiteDialog}
* See the [applyWidgetOverrides]{@link module:alfresco/core/WidgetsOverrideMixin#applyWidgetOverrides}
* for detailed instructions on how to configure overrides to add, remove, replace and update widgets.
*
* @instance
* @type {object[]}
* @default
* @since 1.0.97
*/
widgetsForCreateSiteDialogOverrides: null,
/**
* This is the widget model displayed when editing sites.
*
* @instance
* @type {object[]}
* @since 1.0.55
*/
widgetsForEditSiteDialog: [
{
id: "EDIT_SITE_FIELD_TITLE",
name: "alfresco/forms/controls/TextBox",
config: {
fieldId: "TITLE",
label: "create-site.dialog.name.label",
name: "title",
requirementConfig: {
initialValue: true
},
validationConfig: [
{
validation: "maxLength",
length: 256,
errorMessage: "create-site.dialog.name.maxLength"
},
{
scopeValidation: true,
warnOnly: true,
validation: "validationTopic",
validationTopic: topics.VALIDATE_SITE_IDENTIFIER,
validationValueProperty: "title",
negate: true,
validateInitialValue: false,
validationResultProperty: "response.used",
errorMessage: "create-site-dialog.title.already.used"
}
]
}
},
{
id: "EDIT_SITE_FIELD_DESCRIPTION",
name: "alfresco/forms/controls/TextArea",
config: {
fieldId: "DESCRIPTION",
label: "create-site.dialog.description.label",
name: "description",
validationConfig: [
{
validation: "maxLength",
length: 512,
errorMessage: "create-site.dialog.description.maxLength"
}
]
}
},
{
id: "EDIT_SITE_FIELD_VISIBILITY",
name: "alfresco/forms/controls/RadioButtons",
config: {
fieldId: "VISIBILITY",
label: "create-site.dialog.visibility.label",
name: "visibility",
optionsConfig: {
fixed: [
{
label: "create-site.dialog.visibility.public",
description: "create-site.dialog.visibility.public.description",
value: "PUBLIC"
},
{
label: "create-site.dialog.visibility.moderated",
description: "create-site.dialog.visibility.moderated.description",
value: "MODERATED"
},
{
label: "create-site.dialog.visibility.private",
description: "create-site.dialog.visibility.private.description",
value: "PRIVATE"
}
]
}
}
}
],
/**
* Overrides for the [default edit site dialog model]{@link module:alfresco/services/SiteService#widgetsForEditSiteDialog}
* See the [applyWidgetOverrides]{@link module:alfresco/core/WidgetsOverrideMixin#applyWidgetOverrides}
* for detailed instructions on how to configure overrides to add, remove, replace and update widgets.
*
* @instance
* @type {object[]}
* @default
* @since 1.0.97
*/
widgetsForEditSiteDialogOverrides: null
});
});
Alfresco Aikau Widgets