/// -----------------------------------------------------------------------------
/// <summary>
/// Adds a New Module to a Pane
/// </summary>
/// <param name="align">The alignment for the Modue</param>
/// <param name="desktopModuleId">The Id of the DesktopModule</param>
/// <param name="permissionType">The View Permission Type for the Module</param>
/// <param name="title">The Title for the resulting module</param>
/// <param name="paneName">The pane to add the module to</param>
/// <param name="position">The relative position within the pane for the module</param>
/// <history>
/// [cnurse] 01/11/2008 documented
/// </history>
/// -----------------------------------------------------------------------------
protected void AddNewModule(string title, int desktopModuleId, string paneName, int position, ViewPermissionType permissionType, string align)
{
TabPermissionCollection objTabPermissions = PortalSettings.ActiveTab.TabPermissions;
var objPermissionController = new PermissionController();
try
{
DesktopModuleInfo desktopModule;
if (!DesktopModuleController.GetDesktopModules(PortalSettings.PortalId).TryGetValue(desktopModuleId, out desktopModule))
{
throw new ArgumentException("desktopModuleId");
}
}
catch (Exception ex)
{
Exceptions.LogException(ex);
}
int UserId = -1;
if (Request.IsAuthenticated)
{
UserInfo objUserInfo = UserController.Instance.GetCurrentUserInfo();
UserId = objUserInfo.UserID;
}
foreach (ModuleDefinitionInfo objModuleDefinition in
ModuleDefinitionController.GetModuleDefinitionsByDesktopModuleID(desktopModuleId).Values)
{
var objModule = new ModuleInfo();
objModule.Initialize(PortalSettings.PortalId);
objModule.PortalID = PortalSettings.PortalId;
objModule.TabID = PortalSettings.ActiveTab.TabID;
objModule.ModuleOrder = position;
if (String.IsNullOrEmpty(title))
{
objModule.ModuleTitle = objModuleDefinition.FriendlyName;
}
else
{
objModule.ModuleTitle = title;
}
objModule.PaneName = paneName;
objModule.ModuleDefID = objModuleDefinition.ModuleDefID;
if (objModuleDefinition.DefaultCacheTime > 0)
{
objModule.CacheTime = objModuleDefinition.DefaultCacheTime;
if (PortalSettings.Current.DefaultModuleId > Null.NullInteger && PortalSettings.Current.DefaultTabId > Null.NullInteger)
{
ModuleInfo defaultModule = ModuleController.Instance.GetModule(PortalSettings.Current.DefaultModuleId, PortalSettings.Current.DefaultTabId, true);
if (defaultModule != null)
{
objModule.CacheTime = defaultModule.CacheTime;
}
}
}
switch (permissionType)
{
case ViewPermissionType.View:
objModule.InheritViewPermissions = true;
break;
case ViewPermissionType.Edit:
objModule.InheritViewPermissions = false;
break;
}
//get the default module view permissions
ArrayList arrSystemModuleViewPermissions = objPermissionController.GetPermissionByCodeAndKey("SYSTEM_MODULE_DEFINITION", "VIEW");
//get the permissions from the page
foreach (TabPermissionInfo objTabPermission in objTabPermissions)
{
if (objTabPermission.PermissionKey == "VIEW" && permissionType == ViewPermissionType.View)
{
//Don't need to explicitly add View permisisons if "Same As Page"
continue;
}
//get the system module permissions for the permissionkey
ArrayList arrSystemModulePermissions = objPermissionController.GetPermissionByCodeAndKey("SYSTEM_MODULE_DEFINITION", objTabPermission.PermissionKey);
//loop through the system module permissions
int j;
for (j = 0; j <= arrSystemModulePermissions.Count - 1; j++)
{
PermissionInfo objSystemModulePermission;
objSystemModulePermission = (PermissionInfo) arrSystemModulePermissions[j];
if (objSystemModulePermission.PermissionKey == "VIEW" && permissionType == ViewPermissionType.Edit && objTabPermission.PermissionKey != "EDIT")
{
//Only Page Editors get View permissions if "Page Editors Only"
continue;
}
ModulePermissionInfo objModulePermission = AddModulePermission(objModule,
objSystemModulePermission,
objTabPermission.RoleID,
objTabPermission.UserID,
objTabPermission.AllowAccess);
//ensure that every EDIT permission which allows access also provides VIEW permission
if (objModulePermission.PermissionKey == "EDIT" && objModulePermission.AllowAccess)
{
ModulePermissionInfo objModuleViewperm = AddModulePermission(objModule,
(PermissionInfo) arrSystemModuleViewPermissions[0],
objModulePermission.RoleID,
objModulePermission.UserID,
true);
}
}
//Get the custom Module Permissions, Assume that roles with Edit Tab Permissions
//are automatically assigned to the Custom Module Permissions
if (objTabPermission.PermissionKey == "EDIT")
{
ArrayList arrCustomModulePermissions = objPermissionController.GetPermissionsByModuleDefID(objModule.ModuleDefID);
//loop through the custom module permissions
for (j = 0; j <= arrCustomModulePermissions.Count - 1; j++)
{
//create the module permission
PermissionInfo objCustomModulePermission;
objCustomModulePermission = (PermissionInfo) arrCustomModulePermissions[j];
AddModulePermission(objModule, objCustomModulePermission, objTabPermission.RoleID, objTabPermission.UserID, objTabPermission.AllowAccess);
}
}
}
if (PortalSettings.Current.ContentLocalizationEnabled)
{
Locale defaultLocale = LocaleController.Instance.GetDefaultLocale(PortalSettings.Current.PortalId);
//set the culture of the module to that of the tab
var tabInfo = TabController.Instance.GetTab(objModule.TabID, PortalSettings.Current.PortalId, false);
objModule.CultureCode = tabInfo != null ? tabInfo.CultureCode : defaultLocale.Code;
}
else
{
objModule.CultureCode = Null.NullString;
}
objModule.AllTabs = false;
objModule.Alignment = align;
ModuleController.Instance.AddModule(objModule);
}
}
public void InitialModulePermission(ModuleInfo module, int tabId, int permissionType)
{
var tabPermissions = TabPermissionController.GetTabPermissions(tabId, module.PortalID);
var permissionController = new PermissionController();
module.InheritViewPermissions = permissionType == 0;
// get the default module view permissions
ArrayList systemModuleViewPermissions = permissionController.GetPermissionByCodeAndKey("SYSTEM_MODULE_DEFINITION", "VIEW");
// get the permissions from the page
foreach (TabPermissionInfo tabPermission in tabPermissions)
{
if (tabPermission.PermissionKey == "VIEW" && permissionType == 0)
{
//Don't need to explicitly add View permisisons if "Same As Page"
continue;
}
// get the system module permissions for the permissionkey
ArrayList systemModulePermissions = permissionController.GetPermissionByCodeAndKey("SYSTEM_MODULE_DEFINITION", tabPermission.PermissionKey);
// loop through the system module permissions
int j;
for (j = 0; j <= systemModulePermissions.Count - 1; j++)
{
// create the module permission
var systemModulePermission = (PermissionInfo) systemModulePermissions[j];
if (systemModulePermission.PermissionKey == "VIEW" && permissionType == 1 && tabPermission.PermissionKey != "EDIT")
{
//Only Page Editors get View permissions if "Page Editors Only"
continue;
}
ModulePermissionInfo modulePermission = AddModulePermission(module, systemModulePermission, tabPermission.RoleID, tabPermission.UserID, tabPermission.AllowAccess);
// ensure that every EDIT permission which allows access also provides VIEW permission
if (modulePermission.PermissionKey == "EDIT" && modulePermission.AllowAccess)
{
AddModulePermission(module, (PermissionInfo) systemModuleViewPermissions[0], modulePermission.RoleID, modulePermission.UserID, true);
}
}
//Get the custom Module Permissions, Assume that roles with Edit Tab Permissions
//are automatically assigned to the Custom Module Permissions
if (tabPermission.PermissionKey == "EDIT")
{
ArrayList customModulePermissions = permissionController.GetPermissionsByModuleDefID(module.ModuleDefID);
// loop through the custom module permissions
for (j = 0; j <= customModulePermissions.Count - 1; j++)
{
// create the module permission
var customModulePermission = (PermissionInfo)customModulePermissions[j];
AddModulePermission(module, customModulePermission, tabPermission.RoleID, tabPermission.UserID, tabPermission.AllowAccess);
}
}
}
}
protected void AddNewModule(string title, int desktopModuleId, string paneName, int position, ViewPermissionType permissionType, string align)
{
TabPermissionCollection objTabPermissions = PortalSettings.ActiveTab.TabPermissions;
PermissionController objPermissionController = new PermissionController();
ModuleController objModules = new ModuleController();
ModuleDefinitionController objModuleDefinitions = new ModuleDefinitionController();
Services.Log.EventLog.EventLogController objEventLog = new Services.Log.EventLog.EventLogController();
int intIndex;
try
{
DesktopModuleController objDesktopModules = new DesktopModuleController();
ArrayList arrDM = objDesktopModules.GetDesktopModulesByPortal(PortalSettings.PortalId);
bool isSelectable = false;
for (int intloop = 0; intloop < arrDM.Count; intloop++)
{
if (((DesktopModuleInfo)(arrDM[intloop])).DesktopModuleID == desktopModuleId)
{
isSelectable = true;
break;
}
}
if (isSelectable == false)
{
throw new Exception();
}
}
catch (Exception ex)
{
throw new Exception(ex.Message);
}
int UserId = -1;
if (Request.IsAuthenticated)
{
UserInfo objUserInfo = UserController.GetCurrentUserInfo();
UserId = objUserInfo.UserID;
}
ArrayList arrModuleDefinitions = objModuleDefinitions.GetModuleDefinitions(desktopModuleId);
for (intIndex = 0; intIndex < arrModuleDefinitions.Count; intIndex++)
{
ModuleDefinitionInfo objModuleDefinition = (ModuleDefinitionInfo)(arrModuleDefinitions[intIndex]);
ModuleInfo objModule = new ModuleInfo();
objModule.Initialize(PortalSettings.PortalId);
objModule.PortalID = PortalSettings.PortalId;
objModule.TabID = PortalSettings.ActiveTab.TabID;
objModule.ModuleOrder = position;
if (String.IsNullOrEmpty(title))
{
objModule.ModuleTitle = objModuleDefinition.FriendlyName;
}
else
{
objModule.ModuleTitle = title;
}
objModule.ModuleTitle = title;
objModule.PaneName = paneName;
objModule.ModuleDefID = objModuleDefinition.ModuleDefID;
objModule.CacheTime = objModuleDefinition.DefaultCacheTime;
// initialize module permissions
ModulePermissionCollection objModulePermissions = new ModulePermissionCollection();
objModule.ModulePermissions = objModulePermissions;
objModule.InheritViewPermissions = false;
// get the default module view permissions
ArrayList arrSystemModuleViewPermissions = objPermissionController.GetPermissionByCodeAndKey("SYSTEM_MODULE_DEFINITION", "VIEW");
// get the permissions from the page
foreach (TabPermissionInfo objTabPermission in objTabPermissions)
{
// get the system module permissions for the permissionkey
ArrayList arrSystemModulePermissions = objPermissionController.GetPermissionByCodeAndKey("SYSTEM_MODULE_DEFINITION", objTabPermission.PermissionKey);
// loop through the system module permissions
int j;
for (j = 0; j < arrSystemModulePermissions.Count; j++)
{
// create the module permission
PermissionInfo objSystemModulePermission = (PermissionInfo)(arrSystemModulePermissions[j]);
ModulePermissionInfo objModulePermission = AddModulePermission(objModule.ModuleID, objSystemModulePermission, objTabPermission.RoleID);
// add the permission to the collection
if (!(objModulePermissions.Contains(objModulePermission)) & objModulePermission.AllowAccess)
{
objModulePermissions.Add(objModulePermission);
}
// ensure that every EDIT permission which allows access also provides VIEW permission
if (objModulePermission.PermissionKey == "EDIT" & objModulePermission.AllowAccess)
{
ModulePermissionInfo objModuleViewperm = new ModulePermissionInfo();
objModuleViewperm.ModuleID = objModulePermission.ModuleID;
objModuleViewperm.PermissionID = ((PermissionInfo)(arrSystemModuleViewPermissions[0])).PermissionID;
objModuleViewperm.RoleID = objModulePermission.RoleID;
objModuleViewperm.PermissionKey = "VIEW";
objModuleViewperm.AllowAccess = true;
if (!(objModulePermissions.Contains(objModuleViewperm)))
{
objModulePermissions.Add(objModuleViewperm);
}
}
}
//Get the custom Module Permissions, Assume that roles with Edit Tab Permissions
//are automatically assigned to the Custom Module Permissions
if (objTabPermission.PermissionKey == "EDIT")
{
ArrayList arrCustomModulePermissions = objPermissionController.GetPermissionsByModuleDefID(objModule.ModuleDefID);
// loop through the custom module permissions
for (j = 0; j < arrCustomModulePermissions.Count; j++)
{
// create the module permission
PermissionInfo objCustomModulePermission = (PermissionInfo)(arrCustomModulePermissions[j]);
ModulePermissionInfo objModulePermission = AddModulePermission(objModule.ModuleID, objCustomModulePermission, objTabPermission.RoleID);
// add the permission to the collection
if (!(objModulePermissions.Contains(objModulePermission)) & objModulePermission.AllowAccess)
{
objModulePermissions.Add(objModulePermission);
}
}
}
}
switch (permissionType)
{
case ViewPermissionType.View:
objModule.InheritViewPermissions = true;
break;
case ViewPermissionType.Edit:
objModule.ModulePermissions = objModulePermissions;
break;
}
objModule.AllTabs = false;
objModule.Visibility = VisibilityState.Maximized;
objModule.Alignment = align;
objModules.AddModule(objModule);
objEventLog.AddLog(objModule, PortalSettings, UserId, "", Services.Log.EventLog.EventLogController.EventLogType.MODULE_CREATED);
}
}
/// -----------------------------------------------------------------------------
/// <summary>
/// DeleteModuleDefinition deletes a Module Definition By ID
/// </summary>
/// <param name="moduleDefinitionId">The ID of the Module Definition to delete</param>
/// <history>
/// [cnurse] 01/11/2008 Documented
/// </history>
/// -----------------------------------------------------------------------------
public void DeleteModuleDefinition(int moduleDefinitionId)
{
//Delete associated permissions
var permissionController = new PermissionController();
foreach (PermissionInfo permission in permissionController.GetPermissionsByModuleDefID(moduleDefinitionId))
{
permissionController.DeletePermission(permission.PermissionID);
}
dataProvider.DeleteModuleDefinition(moduleDefinitionId);
DataCache.ClearHostCache(true);
}
/// -----------------------------------------------------------------------------
/// <summary>
/// DeleteModuleDefinition deletes a Module Definition By ID
/// </summary>
/// <param name="moduleDefinitionId">The ID of the Module Definition to delete</param>
/// <history>
/// [cnurse] 01/11/2008 Documented
/// </history>
/// -----------------------------------------------------------------------------
public void DeleteModuleDefinition(int moduleDefinitionId)
{
//Delete associated permissions
var permissionController = new PermissionController();
foreach (PermissionInfo permission in permissionController.GetPermissionsByModuleDefID(moduleDefinitionId))
{
permissionController.DeletePermission(permission.PermissionID);
}
dataProvider.DeleteModuleDefinition(moduleDefinitionId);
DataCache.ClearHostCache(true);
// queue remove module definition from search index
var document = new SearchDocumentToDelete
{
ModuleDefId = moduleDefinitionId
};
DataProvider.Instance().AddSearchDeletedItems(document);
}
