/*
* Copyright 2015 Anyware Services
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* This class handles the access and edition of profiles
*/
Ext.define(
"Ametys.plugins.core.profiles.ProfilesDAO",
{
singleton: true,
constructor: function(config)
{
/**
* @callable
* @param member Ametys.plugins.core.profiles.ProfilesDAO
* @method addProfile
* Create a new profile
* This calls the method 'addProfile' of the server DAO 'org.ametys.plugins.core.right.profile.ProfileDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {String} parameters.name The profile's name
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.profile The profile's properties
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables({
role: "org.ametys.plugins.core.right.profile.ProfileDAO",
methodName: "addProfile",
callback: {
handler: this._addProfileCb
},
errorMessage: {
category: this.self.getName(),
msg: "{{i18n PLUGINS_CORE_PROFILES_ADD_ERROR}}"
}
});
/**
* @callable
* @param member Ametys.plugins.core.profiles.ProfilesDAO
* @method renameProfile
* Renames a profile
* This calls the method 'renameProfile' of the server DAO 'org.ametys.plugins.core.right.profile.ProfileDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {String} parameters.id The profile's id
* @param {String} parameters.name The profile's new name
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.profile The profile's properties
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables({
role: "org.ametys.plugins.core.right.profile.ProfileDAO",
methodName: "renameProfile",
callback: {
handler: this._renameProfileCb
},
errorMessage: {
category: this.self.getName(),
msg: "{{i18n PLUGINS_CORE_PROFILES_RENAME_ERROR}}"
}
});
/**
* @callable
* @param member Ametys.plugins.core.profiles.ProfilesDAO
* @method editProfileRights
* Edits profile's rights
* This calls the method 'editProfileRights' of the server DAO 'org.ametys.plugins.core.right.profile.ProfileDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {String} parameters.id The profile's id
* @param {String[]} parameters.rights The profile's rights
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.profile The profile's properties
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables({
role: "org.ametys.plugins.core.right.profile.ProfileDAO",
methodName: "editProfileRights",
callback: {
handler: this._editProfileCb
},
errorMessage: {
category: this.self.getName(),
msg: "{{i18n PLUGINS_CORE_PROFILES_SAVE_MODIFICATIONS_ERROR}}"
}
});
/**
* @callable
* @param member Ametys.plugins.core.profiles.ProfilesDAO
* @method deleteProfiles
* Delete profiles
* This calls the method 'deleteProfiles' of the server DAO 'org.ametys.plugins.core.right.profile.ProfileDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {String[]} parameters.logins The profiles' ids
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.returnedValue The value return from the server. Null on error (please note that when an error occured, the callback may not be called depending on the value of errorMessage).
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables({
role: "org.ametys.plugins.core.right.profile.ProfileDAO",
methodName: "deleteProfiles",
localParamsIndex: 2,
callback: {
handler: this._deleteProfilesCb
},
errorMessage: {
msg: "{{i18n PLUGINS_CORE_PROFILES_DELETE_ERROR}}",
category: Ext.getClassName(this)
}
});
/**
* @callable
* @param member Ametys.plugins.core.profiles.ProfilesDAO
* @method getProfile
* Get profile's properties
* This calls the method 'getProfile' of the server DAO 'org.ametys.plugins.core.right.profile.ProfileDAO'.
* @param {Object[]} parameters The parameters to transmit to the server method
* @param {String} parameters.id The profile's id
* @param {Boolean} [parameters.withRights=false] True to also get the rights of the profile
* @param {Function} callback The function to call when the java process is over. Use options.scope for the scope.
* @param {Object} callback.profile The profile's properties
* @param {Object} callback.arguments Other arguments specified in option.arguments
* @param {Object} [options] Advanced options for the call.
* @param {Boolean/String/Object} [options.errorMessage] Display an error message. See Ametys.data.ServerComm#callMethod errorMessage.
* @param {Boolean/String/Object} [options.waitMessage] Display a waiting message. See Ametys.data.ServerComm#callMethod waitMessage.
* @param {Number} [options.scope] This parameter is the scope used to call the callback. Moreover is the given class is a mixin of Ametys.data.ServerCaller, its methods Ametys.data.ServerCaller#beforeServerCall and Ametys.data.ServerCaller#afterServerCall will be used so see their documentation to look for additional options (such a refreshing on Ametys.ribbon.element.ui.ButtonController#beforeServerCall).
* @param {Number} [options.priority] The message priority. See Ametys.data.ServerComm#callMethod for more information on the priority. PRIORITY_SYNCHRONOUS cannot be used here.
* @param {String} [options.cancelCode] Cancel similar unachieved read operations. See Ametys.data.ServerComm#callMethod cancelCode.
* @param {Object} [options.arguments] Additional arguments set in the callback.arguments parameter.
* @param {Boolean} [options.ignoreCallbackOnError] If the server throws an exception, should the callback beeing called with a null parameter. See Ametys.data.ServerComm#callMethod ignoreOnError.
*/
this.addCallables({
role: "org.ametys.plugins.core.right.profile.ProfileDAO",
methodName: "getProfile",
errorMessage: {
msg: "{{i18n PLUGINS_CORE_PROFILES_INFOS_ERROR}}",
category: Ext.getClassName(this)
}
});
},
/**
* @private
* Callback function called after a profile was created
* @param {Object} profile The profile's information
* @param {Object} args The callback arguments
* @param {Object[]} params The callback parameters (server-side and client-side)
*/
_addProfileCb: function (profile, args, params)
{
if (profile && profile.id)
{
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.CREATED,
targets: {
id: Ametys.message.MessageTarget.PROFILE,
parameters: {id: profile.id}
}
});
}
},
/**
* @private
* Callback function called after a profile was renamed
* @param {Object} profile The profile's information
* @param {Object} args The callback arguments
* @param {Object[]} params The callback parameters (server-side and client-side)
*/
_renameProfileCb: function (profile, args, params)
{
if (profile && profile.id)
{
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.MODIFIED,
targets: {
id: Ametys.message.MessageTarget.PROFILE,
parameters: {id: profile.id}
}
});
}
},
/**
* @private
* Callback function called after the rights associated to a profile were edited
* @param {Object} profile The profile's information
* @param {Object} args The callback arguments
* @param {Object[]} params The callback parameters (server-side and client-side)
*/
_editProfileCb: function (profile, args, params)
{
if (profile && profile.id)
{
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.MODIFIED,
parameters: {major: true},
targets: {
id: Ametys.message.MessageTarget.PROFILE,
parameters: {id: profile.id}
}
});
}
},
/**
* @private
* Callback function called after a profile was created
* @param {Object[]} profile The profile's information
* @param {Object[]} profile.deletedProfiles ids of the deleted profiles
* @param {Object[]} profile.undeletedProfiles ids of the undeleted profiles
* @param {Object} args The callback arguments
* @param {Object[]} params The callback parameters (server-side and client-side)
* @param {String} params.id The id of deleted page
* @param {Ametys.message.MessageTarget} params.target The deleted target
*/
_deleteProfilesCb: function (profile, args, params)
{
var ids = params[0];
var targets = [];
Ext.Array.forEach(profile.deletedProfiles, function(id) {
targets.push({
id: Ametys.message.MessageTarget.PROFILE,
parameters: {id: id}
});
}, this);
Ext.create('Ametys.message.Message', {
type: Ametys.message.Message.DELETED,
targets: targets
});
if (profile.undeletedProfiles.length)
{
Ametys.notify({
type: 'error',
title: "{{i18n plugin.core-ui:PLUGINS_CORE_UI_PROFILES_DELETE_PROFILES_ERROR}}",
description: Ext.String.format("{{i18n plugin.core-ui:PLUGINS_CORE_UI_PROFILES_UNDELETED_PROFILES}}", profile.undeletedProfiles.length, profile.undeletedProfiles.join(", "))
});
}
}
});