/// <summary>
/// Returns the form definition for the webpart zone properties.
/// </summary>
private FormInfo BuildFormInfo(WebPartZoneInstance webPartZone)
{
FormInfo fi = null;
string formDefinition = String.Empty;
// Dashboard zone properties
if ((pti != null) && (pti.PageTemplateType == PageTemplateTypeEnum.Dashboard))
{
formDefinition = File.ReadAllText(Server.MapPath("~/CMSModules/PortalEngine/Controls/WebParts/WebPartZone_Dashboard_Properties.xml"));
}
// Classic webpart/widget properties
else
{
formDefinition = File.ReadAllText(Server.MapPath("~/CMSModules/PortalEngine/Controls/WebParts/WebPartZone_Properties.xml"));
}
if (!String.IsNullOrEmpty(formDefinition))
{
// Load properties
fi = new FormInfo(formDefinition);
fi.UpdateExistingFields(fi);
DataRow dr = fi.GetDataRow();
LoadDataRowFromWebPartZone(dr, webPartZone);
}
return(fi);
}
/// <summary>
/// Gets a unique widget id. Returned widget id is unique among both document widgets (Page tab) and default widgets (Design tab).
/// </summary>
/// <param name="baseId">The base id.</param>
private string GetUniqueWidgetId(string baseId)
{
int counter = 0;
string controlId = null;
if ((CurrentPageInfo != null) &&
CurrentPageInfo.UsedPageTemplateInfo != null)
{
// Get the document widgets template instance
PageTemplateInstance documentTemplateInstance = mWebPartZoneInstance.ParentTemplateInstance;
// Get the default widgets template instance
PageTemplateInstance templateInstance = CurrentPageInfo.UsedPageTemplateInfo.TemplateInstance;
// Limit the search
while (counter < 100)
{
// Try to find the first available controlId for both templates
controlId = WebPartZoneInstance.GetUniqueWebPartId(baseId, documentTemplateInstance, counter);
if (controlId == WebPartZoneInstance.GetUniqueWebPartId(baseId, templateInstance, counter))
{
break;
}
counter++;
}
}
return(controlId);
}
/// <summary>
/// Control ID validation.
/// </summary>
private void formElem_OnItemValidation(object sender, ref string errorMessage)
{
Control ctrl = (Control)sender;
if (ctrl.ID.ToLowerCSafe() == "webpartcontrolid")
{
FormEngineUserControl ctrlTextbox = (FormEngineUserControl)ctrl;
string newId = ValidationHelper.GetString(ctrlTextbox.Value, null);
// Validate unique ID
WebPartInstance existingPart = pti.GetWebPart(newId);
if ((existingPart != null) && ((webPartInstance == null) || (existingPart.InstanceGUID != webPartInstance.InstanceGUID)))
{
// Error - duplicity IDs
errorMessage = GetString("WebPartProperties.ErrorUniqueID");
}
else
{
string uniqueId = WebPartZoneInstance.GetUniqueWebPartId(newId, pi.TemplateInstance);
if (!uniqueId.EqualsCSafe(newId, true))
{
// Check if there is already a widget with the same id in the page
existingPart = pi.TemplateInstance.GetWebPart(newId);
if ((existingPart != null) && existingPart.IsWidget)
{
// Error - the ID collide with another widget which is already in the page
errorMessage = ResHelper.GetString("WidgetProperties.ErrorUniqueID");
}
}
}
}
}
/// <summary>
/// Returns the form definition for the web part zone properties.
/// </summary>
private FormInfo BuildFormInfo(WebPartZoneInstance webPartZone)
{
FormInfo fi = null;
string formDefinition = String.Empty;
// Dashboard zone properties
if ((pti != null) && (pti.PageTemplateType == PageTemplateTypeEnum.Dashboard))
{
formDefinition = PortalFormHelper.LoadProperties("WebPartZone", "Dashboard.xml");
}
// UI page template properties
else if ((pti != null) && (pti.PageTemplateType == PageTemplateTypeEnum.UI))
{
formDefinition = PortalFormHelper.LoadProperties("WebPartZone", "UI.xml");
}
// Classic web part/widget properties
else
{
formDefinition = PortalFormHelper.LoadProperties("WebPartZone", "Standard.xml");
}
if (!String.IsNullOrEmpty(formDefinition))
{
// Load properties
fi = new FormInfo(formDefinition);
fi.UpdateExistingFields(fi);
DataRow dr = fi.GetDataRow();
LoadDataRowFromWebPartZone(dr, webPartZone);
}
return(fi);
}
/// <summary>
/// Handles the OnReloadData event of the menuZoneVariants control.
/// </summary>
protected void menuMoveToZoneVariants_OnReloadData(object sender, EventArgs e)
{
// Check permissions
if (currentUser == null)
{
return;
}
if ((DocumentContext.CurrentPageInfo != null) &&
(DocumentContext.CurrentPageInfo.TemplateInstance != null))
{
VariantModeEnum currentVariantMode = VariantModeEnum.None;
string targetZoneId = ValidationHelper.GetString(menuMoveToZoneVariants.Parameter, string.Empty);
int pageTemplateId = DocumentContext.CurrentPageInfo.UsedPageTemplateInfo.PageTemplateId;
// Get selected zone variant mode
if ((DocumentContext.CurrentPageInfo != null) &&
(DocumentContext.CurrentPageInfo.TemplateInstance != null))
{
WebPartZoneInstance targetZone = DocumentContext.CurrentPageInfo.TemplateInstance.GetZone(targetZoneId);
if (targetZone != null)
{
currentVariantMode = targetZone.VariantMode;
}
}
SetColumnNames(currentVariantMode);
// Get all zone variants of the current web part
DataTable resultTable = null;
DataSet ds = VariantHelper.GetVariants(currentVariantMode, pageTemplateId, targetZoneId, Guid.Empty, 0);
if (!DataHelper.DataSourceIsEmpty(ds))
{
DataTable table = ds.Tables[0].Copy();
table.DefaultView.Sort = columnVariantID;
// Add the original web part as the first item in the variant list
DataRow originalVariant = table.NewRow();
originalVariant[columnVariantID] = 0;
originalVariant[columnVariantDisplayName] = ResHelper.GetString("ZoneMenu.OriginalZone", UICulture);
originalVariant[columnVariantZoneID] = targetZoneId;
originalVariant[columnVariantPageTemplateID] = pageTemplateId;
originalVariant[columnVariantInstanceGUID] = Guid.Empty;
table.Rows.InsertAt(originalVariant, 0);
resultTable = table.DefaultView.ToTable();
if (DataHelper.DataSourceIsEmpty(resultTable))
{
pnlNoZoneVariants.Visible = true;
ltlNoZoneVariants.Text = ResHelper.GetString("Content.NoPermissions", UICulture);
}
}
repMoveToZoneVariants.DataSource = resultTable;
repMoveToZoneVariants.DataBind();
}
}
/// <summary>
/// Control ID validation.
/// </summary>
private void formElem_OnItemValidation(object sender, ref string errorMessage)
{
Control ctrl = (Control)sender;
if (ctrl.ID.ToLowerCSafe() == "webpartcontrolid")
{
FormEngineUserControl ctrlTextbox = (FormEngineUserControl)ctrl;
// New web part control id
string newControlId = ValidationHelper.GetString(ctrlTextbox.Value, null);
// Load the web part variants if not loaded yet
if ((PortalContext.MVTVariantsEnabled && !templateInstance.MVTVariantsLoaded) ||
(PortalContext.ContentPersonalizationEnabled && !templateInstance.ContentPersonalizationVariantsLoaded))
{
templateInstance.LoadVariants(false, VariantModeEnum.None);
}
// Check control ID validity
if (!ValidationHelper.IsIdentifier(newControlId))
{
errorMessage = GetString("webpartproperties.controlid.allowedcharacters");
}
// New or changed web part control id
bool checkIdUniqueness = IsNewWebPart || IsNewVariant || (webPartInstance == null) || (webPartInstance.ControlID != newControlId);
// Try to find a web part with the same web part control id amongst all the web parts and their variants
if (checkIdUniqueness &&
(templateInstance.GetWebPart(newControlId, true) != null))
{
// Error - duplicity IDs
errorMessage = GetString("WebPartProperties.ErrorUniqueID");
}
else
{
string uniqueId = WebPartZoneInstance.GetUniqueWebPartId(newControlId, pi.TemplateInstance);
if (!uniqueId.EqualsCSafe(newControlId, true))
{
// Check if there is already a widget with the same id in the page
WebPartInstance foundWidget = pi.TemplateInstance.GetWebPart(newControlId);
if ((foundWidget != null) && foundWidget.IsWidget)
{
// Error - the ID collide with another widget which is already in the page
errorMessage = ResHelper.GetString("WidgetProperties.ErrorUniqueID");
}
}
}
}
}
/// <summary>
/// Adds widget.
/// </summary>
private void AddWidget()
{
int widgetID = ValidationHelper.GetInteger(WidgetId, 0);
// Add web part to the currently selected zone under currently selected page
if ((widgetID > 0) && !String.IsNullOrEmpty(ZoneId))
{
if (wi != null)
{
// Ensure layout zone flag
if (QueryHelper.GetBoolean("layoutzone", false))
{
WebPartZoneInstance zone = pti.EnsureZone(ZoneId);
zone.LayoutZone = true;
zone.WidgetZoneType = zoneType;
// Ensure the layout zone flag in the original page template instance
WebPartZoneInstance zoneInstance = templateInstance.GetZone(ZoneId);
if (zoneInstance != null)
{
zoneInstance.LayoutZone = true;
zone.WidgetZoneType = zoneType;
}
}
// Add the widget
WebPartInstance newWidget = templateInstance.AddWidget(ZoneId, widgetID);
if (newWidget != null)
{
// Prepare the form info to get the default properties
FormInfo fi = new FormInfo(wi.WidgetProperties);
DataRow dr = fi.GetDataRow();
fi.LoadDefaultValues(dr);
newWidget.LoadProperties(dr);
// Add webpart to user's last recently used
CMSContext.CurrentUser.UserSettings.UpdateRecentlyUsedWidget(wi.WidgetName);
widgetInstance = newWidget;
}
}
}
}
/// <summary>
/// Loads the data row data from given web part zone instance.
/// </summary>
/// <param name="dr">DataRow to fill</param>
/// <param name="webPart">Source web part zone</param>
private void LoadDataRowFromWebPartZone(DataRow dr, WebPartZoneInstance webPartZone)
{
foreach (DataColumn column in dr.Table.Columns)
{
try
{
object value = webPartZone.GetValue(column.ColumnName);
if (column.DataType == typeof(decimal))
{
value = ValidationHelper.GetDouble(value, 0, "en-us");
}
DataHelper.SetDataRowValue(dr, column.ColumnName, value);
}
catch
{
}
}
}
/// <summary>
/// Init event handler.
/// </summary>
protected override void OnInit(EventArgs e)
{
// When displaying an existing variant of a zone, get the variant mode for its original zone
if (variantId > 0)
{
PageTemplateInfo pti = PageTemplateInfoProvider.GetPageTemplateInfo(templateId);
if ((pti != null) && ((pti.TemplateInstance != null)))
{
// Get the original zone and retrieve its variant mode
WebPartZoneInstance zoneInstance = pti.TemplateInstance.GetZone(zoneId);
if ((zoneInstance != null) && (zoneInstance.VariantMode != VariantModeEnum.None))
{
variantMode = zoneInstance.VariantMode;
}
}
}
base.OnInit(e);
}
/// <summary>
/// Init event handler.
/// </summary>
protected override void OnInit(EventArgs e)
{
// When displaying an existing variant of a zone, get the variant mode for its original zone
if (variantId > 0)
{
PageTemplateInfo pti = PageTemplateInfoProvider.GetPageTemplateInfo(templateId);
if ((pti != null) && ((pti.TemplateInstance != null)))
{
// Get the original zone and retrieve its variant mode
WebPartZoneInstance zoneInstance = pti.TemplateInstance.GetZone(zoneId);
if ((zoneInstance != null) && (zoneInstance.VariantMode != VariantModeEnum.None))
{
variantMode = zoneInstance.VariantMode;
}
}
}
if (variantMode == VariantModeEnum.MVT)
{
// Display MVT edit dialog
mvtEditElem.UIFormControl.EditedObject = BaseAbstractInfoProvider.GetInfoById(MVTVariantInfo.OBJECT_TYPE, QueryHelper.GetInteger("variantid", 0));
mvtEditElem.UIFormControl.ParentObject = BaseAbstractInfoProvider.GetInfoById(PageTemplateInfo.OBJECT_TYPE, QueryHelper.GetInteger("templateid", 0));
mvtEditElem.Visible = true;
mvtEditElem.UIFormControl.SubmitButton.Visible = false;
mvtEditElem.UIFormControl.ReloadData();
}
else if (variantMode == VariantModeEnum.ContentPersonalization)
{
// Display Content personalization edit dialog
cpEditElem.UIFormControl.EditedObject = BaseAbstractInfoProvider.GetInfoById(ContentPersonalizationVariantInfo.OBJECT_TYPE, QueryHelper.GetInteger("variantid", 0));
cpEditElem.UIFormControl.ParentObject = BaseAbstractInfoProvider.GetInfoById(PageTemplateInfo.OBJECT_TYPE, QueryHelper.GetInteger("templateid", 0));
cpEditElem.Visible = true;
cpEditElem.UIFormControl.SubmitButton.Visible = false;
cpEditElem.UIFormControl.ReloadData();
}
base.OnInit(e);
}
/// <summary>
/// Returns the form definition for the webpart zone properties.
/// </summary>
private FormInfo BuildFormInfo(WebPartZoneInstance webPartZone)
{
FormInfo fi = null;
string formDefinition = String.Empty;
// Dashboard zone properties
if ((pti != null) && (pti.PageTemplateType == PageTemplateTypeEnum.Dashboard))
{
formDefinition = File.ReadAllText(Server.MapPath("~/CMSModules/PortalEngine/Controls/WebParts/WebPartZone_Dashboard_Properties.xml"));
}
// Classic webpart/widget properties
else
{
formDefinition = File.ReadAllText(Server.MapPath("~/CMSModules/PortalEngine/Controls/WebParts/WebPartZone_Properties.xml"));
}
if (!String.IsNullOrEmpty(formDefinition))
{
// Load properties
fi = new FormInfo(formDefinition);
fi.UpdateExistingFields(fi);
DataRow dr = fi.GetDataRow();
LoadDataRowFromWebPartZone(dr, webPartZone);
}
return fi;
}
/// <summary>
/// Loads the data row data from given web part zone instance.
/// </summary>
/// <param name="dr">DataRow to fill</param>
/// <param name="webPart">Source web part zone</param>
private void LoadDataRowFromWebPartZone(DataRow dr, WebPartZoneInstance webPartZone)
{
foreach (DataColumn column in dr.Table.Columns)
{
try
{
object value = webPartZone.GetValue(column.ColumnName);
if (column.DataType == typeof(decimal))
{
value = ValidationHelper.GetDouble(value, 0, "en-us");
}
DataHelper.SetDataRowValue(dr, column.ColumnName, value);
}
catch
{
}
}
}
/// <summary>
/// OnInit event (BasicForm initialization).
/// </summary>
protected override void OnInit(EventArgs e)
{
base.OnInit(e);
string zoneId = QueryHelper.GetString("zoneid", "");
string aliasPath = QueryHelper.GetString("aliaspath", "");
int templateId = QueryHelper.GetInteger("templateid", 0);
string culture = QueryHelper.GetString("culture", LocalizationContext.PreferredCultureCode);
mZoneVariantID = QueryHelper.GetInteger("variantid", 0);
mIsNewVariant = QueryHelper.GetBoolean("isnewvariant", false);
variantMode = VariantModeFunctions.GetVariantModeEnum(QueryHelper.GetString("variantmode", string.Empty));
// When displaying an existing variant of a web part, get the variant mode for its original web part
if (ZoneVariantID > 0)
{
PageTemplateInfo pti = PageTemplateInfoProvider.GetPageTemplateInfo(templateId);
if ((pti != null) && ((pti.TemplateInstance != null)))
{
// Get the original webpart and retrieve its variant mode
WebPartZoneInstance zoneInstance = pti.TemplateInstance.GetZone(zoneId);
if ((zoneInstance != null) && (zoneInstance.VariantMode != VariantModeEnum.None))
{
variantMode = zoneInstance.VariantMode;
}
}
}
// Try to find the zone variant in the database and set its VariantID
if (IsNewVariant)
{
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (properties != null)
{
// Get the variant code name from the WindowHelper
string variantName = ValidationHelper.GetString(properties["codename"], string.Empty);
// Check if the variant exists in the database
int variantIdFromDB = VariantHelper.GetVariantID(variantMode, templateId, variantName, true);
// Set the variant id from the database
if (variantIdFromDB > 0)
{
mZoneVariantID = variantIdFromDB;
mIsNewVariant = false;
}
}
}
if (!String.IsNullOrEmpty(zoneId))
{
// Get page info
pi = CMSWebPartPropertiesPage.GetPageInfo(aliasPath, templateId, culture);
if (pi == null)
{
ShowInformation(GetString("webpartzone.notfound"));
pnlFormArea.Visible = false;
return;
}
// Get template
pti = pi.UsedPageTemplateInfo;
if (pti != null)
{
// Get web part zone
pti.TemplateInstance.EnsureZone(zoneId);
webPartZone = pti.TemplateInstance.GetZone(zoneId);
if ((ZoneVariantID > 0) && (webPartZone != null) && (webPartZone.ZoneInstanceVariants != null))
{
// Check OnlineMarketing permissions
if (CheckPermissions("Read"))
{
webPartZone = webPartZone.ZoneInstanceVariants.Find(v => v.VariantID.Equals(ZoneVariantID));
}
else
{
// Not authorized for OnlineMarketing - Manage.
RedirectToInformation(String.Format(GetString("general.permissionresource"), "Read", (variantMode == VariantModeEnum.ContentPersonalization) ? "CMS.ContentPersonalization" : "CMS.MVTest"));
}
}
if (webPartZone == null)
{
ShowInformation(GetString("webpartzone.notfound"));
pnlFormArea.Visible = false;
return;
}
FormInfo fi = BuildFormInfo(webPartZone);
// Get the DataRow and fill the data row with values
DataRow dr = fi.GetDataRow();
foreach (DataColumn column in dr.Table.Columns)
{
try
{
DataHelper.SetDataRowValue(dr, column.ColumnName, webPartZone.GetValue(column.ColumnName));
}
catch
{
}
}
// Initialize Form
formElem.DataRow = dr;
formElem.MacroTable = webPartZone.MacroTable;
formElem.SubmitButton.Visible = false;
formElem.SiteName = SiteContext.CurrentSiteName;
formElem.FormInformation = fi;
formElem.ShowPrivateFields = true;
formElem.OnAfterDataLoad += formElem_OnAfterDataLoad;
// HTML editor toolbar
if (fi.UsesHtmlArea())
{
plcToolbarPadding.Visible = true;
plcToolbar.Visible = true;
pnlFormArea.Height = 285;
}
}
}
}
/// <summary>
/// Saves webpart properties.
/// </summary>
public bool Save()
{
// Check MVT/CP security
if (VariantID > 0)
{
// Check OnlineMarketing permissions.
if (!CheckPermissions("Manage"))
{
ShowError(GetString("general.modifynotallowed"));
return(false);
}
}
// Save the data
if ((pi != null) && (pti != null) && (templateInstance != null) && SaveForm(form))
{
if (SynchronizationHelper.IsCheckedOutByOtherUser(pti))
{
string userName = null;
UserInfo ui = UserInfoProvider.GetUserInfo(pti.Generalized.IsCheckedOutByUserID);
if (ui != null)
{
userName = HTMLHelper.HTMLEncode(ui.GetFormattedUserName(IsLiveSite));
}
ShowError(string.Format(GetString("ObjectEditMenu.CheckedOutByAnotherUser"), pti.TypeInfo.ObjectType, pti.DisplayName, userName));
return(false);
}
// Add web part if new
if (IsNewWebPart)
{
int webpartId = ValidationHelper.GetInteger(WebPartID, 0);
// Ensure layout zone flag
if (QueryHelper.GetBoolean("layoutzone", false))
{
WebPartZoneInstance zone = pti.TemplateInstance.EnsureZone(ZoneID);
zone.LayoutZone = true;
}
webPartInstance = PortalHelper.AddNewWebPart(webpartId, ZoneID, false, ZoneVariantID, Position, templateInstance);
// Set default layout
if (wpi.WebPartParentID > 0)
{
WebPartLayoutInfo wpli = WebPartLayoutInfoProvider.GetDefaultLayout(wpi.WebPartID);
if (wpli != null)
{
webPartInstance.SetValue("WebPartLayout", wpli.WebPartLayoutCodeName);
}
}
}
webPartInstance.XMLVersion = 1;
if (IsNewVariant)
{
webPartInstance = webPartInstance.Clone();
webPartInstance.VariantMode = VariantModeFunctions.GetVariantModeEnum(QueryHelper.GetString("variantmode", String.Empty).ToLowerInvariant());
}
// Get basic form's data row and update web part
SaveFormToWebPart(form);
// Set new position if set
if (PositionLeft > 0)
{
webPartInstance.SetValue("PositionLeft", PositionLeft);
}
if (PositionTop > 0)
{
webPartInstance.SetValue("PositionTop", PositionTop);
}
bool isWebPartVariant = (VariantID > 0) || (ZoneVariantID > 0) || IsNewVariant;
if (!isWebPartVariant)
{
// Save the changes
CMSPortalManager.SaveTemplateChanges(pi, templateInstance, WidgetZoneTypeEnum.None, ViewModeEnum.Design, tree);
}
else
{
Hashtable varProperties = WindowHelper.GetItem("variantProperties") as Hashtable;
// Save changes to the web part variant
VariantHelper.SaveWebPartVariantChanges(webPartInstance, VariantID, ZoneVariantID, VariantMode, varProperties);
}
// Reload the form (because of macro values set only by JS)
form.ReloadData();
// Clear the cached web part
CacheHelper.TouchKey("webpartinstance|" + InstanceGUID.ToString().ToLowerInvariant());
ShowChangesSaved();
return(true);
}
if (webPartInstance?.ParentZone?.ParentTemplateInstance != null)
{
// Reload the zone/web part variants when saving of the form fails
webPartInstance.ParentZone.ParentTemplateInstance.LoadVariants(true, VariantModeEnum.None);
}
return(false);
}
/// <summary>
/// Initializes menu.
/// </summary>
protected void InitalizeMenu()
{
string zoneId = QueryHelper.GetString("zoneid", string.Empty);
string culture = QueryHelper.GetString("culture", CMSContext.PreferredCultureCode);
Guid instanceGuid = QueryHelper.GetGuid("instanceguid", Guid.Empty);
bool isNewWidget = QueryHelper.GetBoolean("isnew", false);
WidgetZoneTypeEnum zoneType = WidgetZoneTypeEnum.None;
if (!String.IsNullOrEmpty(widgetId) || !String.IsNullOrEmpty(widgetName))
{
WidgetInfo wi = null;
// get pageinfo
PageInfo pi = null;
try
{
pi = CMSWebPartPropertiesPage.GetPageInfo(aliasPath, templateId, culture);
}
catch (PageNotFoundException)
{
// Do not throw exception if page info not found (e.g. bad alias path)
}
if (pi == null)
{
Visible = false;
return;
}
// Get template instance
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
if (templateInstance != null)
{
// Get zone type
WebPartZoneInstance zoneInstance = templateInstance.GetZone(zoneId);
if (zoneInstance != null)
{
zoneType = zoneInstance.WidgetZoneType;
}
// Get web part
WebPartInstance widget = templateInstance.GetWebPart(instanceGuid, widgetId);
if ((widget != null) && widget.IsWidget)
{
// WebPartType = codename, get widget by codename
wi = WidgetInfoProvider.GetWidgetInfo(widget.WebPartType);
}
}
// New widget
if (isNewWidget)
{
int id = ValidationHelper.GetInteger(widgetId, 0);
if (id > 0)
{
wi = WidgetInfoProvider.GetWidgetInfo(id);
}
else if (!String.IsNullOrEmpty(widgetName))
{
wi = WidgetInfoProvider.GetWidgetInfo(widgetName);
}
}
// Get widget info from name if not found yet
if ((wi == null) && (!String.IsNullOrEmpty(widgetName)))
{
wi = WidgetInfoProvider.GetWidgetInfo(widgetName);
}
if (wi != null)
{
PageTitle.TitleText = GetString("Widgets.Properties.Title") + " (" + HTMLHelper.HTMLEncode(ResHelper.LocalizeString(wi.WidgetDisplayName)) + ")";
}
// If no zonetype defined or not inline dont show documentation
string documentationUrl = String.Empty;
switch (zoneType)
{
case WidgetZoneTypeEnum.Dashboard:
case WidgetZoneTypeEnum.Editor:
case WidgetZoneTypeEnum.Group:
case WidgetZoneTypeEnum.User:
documentationUrl = ResolveUrl("~/CMSModules/Widgets/LiveDialogs/WidgetDocumentation.aspx");
break;
// If no zone set dont create documentation link
default:
if (isInline)
{
documentationUrl = ResolveUrl("~/CMSModules/Widgets/Dialogs/WidgetDocumentation.aspx");
}
else
{
return;
}
break;
}
// Generate documentation link
Literal ltr = new Literal();
PageTitle.RightPlaceHolder.Controls.Add(ltr);
// Ensure correct parameters in documentation url
documentationUrl += URLHelper.GetQuery(URLHelper.CurrentURL);
if (!String.IsNullOrEmpty(widgetName))
{
documentationUrl = URLHelper.UpdateParameterInUrl(documentationUrl, "widgetname", widgetName);
}
if (!String.IsNullOrEmpty(widgetId))
{
documentationUrl = URLHelper.UpdateParameterInUrl(documentationUrl, "widgetid", widgetId);
}
string docScript = "NewWindow('" + documentationUrl + "', 'WebPartPropertiesDocumentation', 800, 800); return false;";
ltr.Text += "<a onclick=\"" + docScript + "\" href=\"#\"><img src=\"" + ResolveUrl(GetImageUrl("General/HelpLargeDark.png")) + "\" style=\"border-width: 0px;\"></a>";
}
}
/// <summary>
/// Saves widget properties.
/// </summary>
public bool Save()
{
if (VariantID > 0)
{
// Check MVT/CP security
if (!CheckPermissions("Manage"))
{
DisplayError("general.modifynotallowed");
return(false);
}
}
// Save the data
if ((CurrentPageInfo != null) && (mTemplateInstance != null) && SaveForm(formCustom))
{
ViewModeEnum viewMode = PortalContext.ViewMode;
// Check manage permission for non-livesite version
if (!viewMode.IsLiveSite() && viewMode != ViewModeEnum.DashboardWidgets && viewMode != ViewModeEnum.UserWidgets)
{
if (CurrentUser.IsAuthorizedPerDocument(CurrentPageInfo.NodeID, CurrentPageInfo.ClassName, NodePermissionsEnum.Modify) != AuthorizationResultEnum.Allowed)
{
DisplayError("general.modifynotallowed");
return(false);
}
// Check design permissions
if (PortalContext.IsDesignMode(viewMode, false) && !PortalContext.CurrentUserIsDesigner)
{
RedirectToAccessDenied("CMS.Design", "Design");
}
}
PageTemplateInfo pti = mTemplateInstance.ParentPageTemplate;
if (PortalContext.IsDesignMode(viewMode) && SynchronizationHelper.IsCheckedOutByOtherUser(pti))
{
string userName = null;
UserInfo ui = UserInfoProvider.GetUserInfo(pti.Generalized.IsCheckedOutByUserID);
if (ui != null)
{
userName = HTMLHelper.HTMLEncode(ui.GetFormattedUserName(IsLiveSite));
}
DisplayError(string.Format(GetString("ObjectEditMenu.CheckedOutByAnotherUser"), pti.TypeInfo.ObjectType, pti.DisplayName, userName));
return(false);
}
// Get the zone
mWebPartZoneInstance = mTemplateInstance.EnsureZone(ZoneId);
if (mWebPartZoneInstance != null)
{
mWebPartZoneInstance.WidgetZoneType = ZoneType;
// Add new widget
if (IsNewWidget)
{
bool isLayoutZone = (QueryHelper.GetBoolean("layoutzone", false));
int widgetID = ValidationHelper.GetInteger(WidgetId, 0);
// Create new widget instance
mWidgetInstance = PortalHelper.AddNewWidget(widgetID, ZoneId, ZoneType, isLayoutZone, mTemplateInstance);
}
// Ensure handling of the currently edited object (if not exists -> redirect)
UIContext.EditedObject = mWidgetInstance;
mWidgetInstance.XMLVersion = 1;
if (IsNewVariant)
{
mWidgetInstance = mWidgetInstance.Clone();
// Check whether the editor widgets have been already customized
if (CurrentPageInfo.DocumentTemplateInstance.WebPartZones.Count == 0)
{
// There are no customized editor widgets yet => copy the default editor widgets from the page template under the document (to enable customization)
// Save to the document as editor admin changes
TreeNode node = DocumentHelper.GetDocument(CurrentPageInfo.DocumentID, mTreeProvider);
// Extract and set the document web parts
node.SetValue("DocumentWebParts", mTemplateInstance.GetZonesXML(WidgetZoneTypeEnum.Editor));
// Save the document
DocumentHelper.UpdateDocument(node, mTreeProvider);
}
}
bool isLayoutWidget = ((mWebPartInfo != null) && ((WebPartTypeEnum)mWebPartInfo.WebPartType == WebPartTypeEnum.Layout));
// Get basicform's datarow and update widget
SaveFormToWidget(formCustom, mTemplateInstance, isLayoutWidget);
// Ensure unique id for new widget variant or layout widget
if (IsNewVariant || (isLayoutWidget && IsNewWidget))
{
string controlId = GetUniqueWidgetId(mWidgetInfo.WidgetName);
if (!string.IsNullOrEmpty(controlId))
{
mWidgetInstance.ControlID = controlId;
}
else
{
DisplayError("Unable to generate unique widget id.");
return(false);
}
}
// Allow set dashboard in design mode
if ((ZoneType == WidgetZoneTypeEnum.Dashboard) && String.IsNullOrEmpty(PortalContext.DashboardName))
{
viewMode = ViewModeEnum.Design;
PortalContext.SetViewMode(ViewModeEnum.Design);
}
bool isWidgetVariant = (VariantID > 0) || IsNewVariant;
if (!isWidgetVariant)
{
// Save the changes
if ((viewMode.IsEdit(true) || viewMode.IsEditLive()) && (ZoneType == WidgetZoneTypeEnum.Editor))
{
if (DocumentManager.AllowSave)
{
// Store the editor widgets in the temporary interlayer
PortalContext.SaveEditorWidgets(CurrentPageInfo.DocumentID, mTemplateInstance.GetZonesXML(WidgetZoneTypeEnum.Editor));
}
}
else
{
// Save the changes
CMSPortalManager.SaveTemplateChanges(CurrentPageInfo, mTemplateInstance, ZoneType, viewMode, mTreeProvider);
}
}
else if ((viewMode.IsEdit()) && (ZoneType == WidgetZoneTypeEnum.Editor))
{
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
VariantHelper.SaveWebPartVariantChanges(mWidgetInstance, VariantID, 0, VariantMode, properties);
// Log widget variant synchronization
TreeNode node = DocumentHelper.GetDocument(CurrentPageInfo.DocumentID, mTreeProvider);
DocumentSynchronizationHelper.LogDocumentChange(node, TaskTypeEnum.UpdateDocument, mTreeProvider);
}
}
// Reload the form (because of macro values set only by JS)
formCustom.ReloadData();
// Display info message
ShowChangesSaved();
// Clear the cached web part
CacheHelper.TouchKey("webpartinstance|" + InstanceGUID.ToString().ToLowerCSafe());
return(true);
}
return(false);
}
/// <summary>
/// Saves web part zone properties.
/// </summary>
public bool Save()
{
if (ZoneVariantID > 0)
{
// Check OnlineMarketing permissions
if (!CheckPermissions("Manage"))
{
lblError.Visible = true;
lblError.Text = GetString("general.modifynotallowed");
return false;
}
}
// Save the data
if (formElem.SaveData(""))
{
DataRow dr = formElem.DataRow;
// Get basicform's datarow and update the fields
if ((webPartZone != null) && (dr != null) && (pti != null))
{
// New variant
// Clone original zone
WebPartZoneInstance originalWebPartZone = webPartZone;
if (IsNewVariant)
{
webPartZone = pti.EnsureZone(webPartZone.ZoneID);
// Ensure that all the zones which are not saved in the template already will be saved now
// This is a case for new layout zones
if (!webPartZone.HasVariants)
{
TreeProvider tree = new TreeProvider(CMSContext.CurrentUser);
CMSPortalManager.SaveTemplateChanges(pi, pti, pti.TemplateInstance, WidgetZoneTypeEnum.None, ViewModeEnum.Design, tree);
}
webPartZone = webPartZone.Clone();
bool webPartIdExists = false;
int offset = 0;
string webPartControlId = string.Empty;
// Re-generate web part unique IDs
foreach (WebPartInstance wpi in webPartZone.WebParts)
{
webPartIdExists = false;
offset = 0;
// Set new web part unique ID
string baseId = Regex.Replace(wpi.ControlID, "\\d+$", "");
do
{
webPartControlId = WebPartZoneInstance.GetUniqueWebPartId(baseId, pti.TemplateInstance, offset);
// Check if the returned web part control id is already used in the new zone variant
webPartIdExists = (webPartZone.GetWebPart(webPartControlId) != null);
offset++;
} while (webPartIdExists);
wpi.ControlID = webPartControlId;
wpi.InstanceGUID = new Guid();
}
}
// If zone type changed, delete all webparts in the zone
if (ValidationHelper.GetString(webPartZone.GetValue("WidgetZoneType"), "") != ValidationHelper.GetString(dr["WidgetZoneType"], ""))
{
// Remove all variants
if (variantMode == VariantModeEnum.MVT)
{
ModuleCommands.OnlineMarketingRemoveMVTWebPartVariants(webPartZone.WebParts);
}
else if (variantMode == VariantModeEnum.ContentPersonalization)
{
ModuleCommands.OnlineMarketingRemoveContentPersonalizationWebPartVariants(webPartZone.WebParts);
}
webPartZone.WebParts.Clear();
}
foreach (DataColumn column in dr.Table.Columns)
{
webPartZone.MacroTable[column.ColumnName.ToLower()] = formElem.MacroTable[column.ColumnName.ToLower()];
webPartZone.SetValue(column.ColumnName, dr[column]);
}
// Ensure the layout zone flag
webPartZone.LayoutZone = QueryHelper.GetBoolean("layoutzone", false);
// Save standard zone
if ((ZoneVariantID == 0) && (!IsNewVariant))
{
// Update page template
PageTemplateInfoProvider.SetPageTemplateInfo(pti);
}
else
{
// Save zone variant
if ((webPartZone != null)
&& (webPartZone.ParentTemplateInstance != null)
&& (webPartZone.ParentTemplateInstance.ParentPageTemplate != null)
&& (!webPartZone.WebPartsContainVariants)) // Save only if any of the child web parts does not have variants
{
// Save the variant properties
string variantName = string.Empty;
string variantDisplayName = string.Empty;
string variantDisplayCondition = string.Empty;
string variantDescription = string.Empty;
bool variantEnabled = true;
string zoneId = webPartZone.ZoneID;
int templateId = webPartZone.ParentTemplateInstance.ParentPageTemplate.PageTemplateId;
XmlDocument doc = new XmlDocument();
XmlNode xmlWebParts = webPartZone.GetXmlNode(doc);
// Get variant description properties
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (properties != null)
{
variantName = ValidationHelper.GetString(properties["codename"], string.Empty);
variantDisplayName = ValidationHelper.GetString(properties["displayname"], string.Empty);
variantDescription = ValidationHelper.GetString(properties["description"], string.Empty);
variantEnabled = ValidationHelper.GetBoolean(properties["enabled"], true);
if (PortalContext.ContentPersonalizationEnabled)
{
variantDisplayCondition = ValidationHelper.GetString(properties["condition"], string.Empty);
}
}
if (variantMode == VariantModeEnum.MVT)
{
// Save MVT variant properties
mZoneVariantID = ModuleCommands.OnlineMarketingSaveMVTVariant(ZoneVariantID, variantName, variantDisplayName, variantDescription, variantEnabled, zoneId, Guid.Empty, templateId, 0, xmlWebParts);
}
else if (variantMode == VariantModeEnum.ContentPersonalization)
{
// Save Content personalization variant properties
mZoneVariantID = ModuleCommands.OnlineMarketingSaveContentPersonalizationVariant(ZoneVariantID, variantName, variantDisplayName, variantDescription, variantEnabled, variantDisplayCondition, zoneId, Guid.Empty, templateId, 0, xmlWebParts);
}
// The variants are cached -> Reload
if (originalWebPartZone != null)
{
originalWebPartZone.LoadVariants(true, variantMode);
}
}
}
// Reload the form (because of macro values set only by JS)
this.formElem.LoadData(dr);
return true;
}
else
{
return false;
}
}
else
{
return false;
}
}
/// <summary>
/// Handles the Load event of the Page control.
/// </summary>
protected void Page_Load(object sender, EventArgs e)
{
string widgetId = QueryHelper.GetString("widgetid", String.Empty);
string aliasPath = QueryHelper.GetString("aliasPath", String.Empty);
int templateId = QueryHelper.GetInteger("templateid", 0);
string zoneId = QueryHelper.GetString("zoneid", String.Empty);
Guid instanceGUID = QueryHelper.GetGuid("instanceguid", Guid.Empty);
bool isNewWidget = QueryHelper.GetBoolean("isnew", false);
bool inline = QueryHelper.GetBoolean("inline", false);
int variantId = QueryHelper.GetInteger("variantid", 0);
string culture = QueryHelper.GetString("culture", CMSContext.PreferredCultureCode);
// Set page title
Page.Title = GetString(isNewWidget ? "widgets.propertiespage.titlenew" : "widgets.propertiespage.title");
// Resize the header (enlarge) to make a space for the tabs header when displaying a widget variant
if (variantId > 0)
{
rowsFrameset.Attributes.Add("rows", "67, *");
}
// Ensure correct view mode
if (String.IsNullOrEmpty(aliasPath))
{
// Ensure the dashboard mode for the dialog
if (QueryHelper.Contains("dashboard"))
{
PortalContext.SetRequestViewMode(ViewModeEnum.DashboardWidgets);
PortalContext.DashboardName = QueryHelper.GetString("dashboard", String.Empty);
PortalContext.DashboardSiteName = QueryHelper.GetString("sitename", String.Empty);
}
// Ensure the design mode for the dialog
else
{
PortalContext.SetRequestViewMode(ViewModeEnum.Design);
}
}
if (widgetId != "")
{
// Get pageinfo
PageInfo pi = null;
try
{
pi = CMSWebPartPropertiesPage.GetPageInfo(aliasPath, templateId, culture);
}
catch (PageNotFoundException)
{
// Do not throw exception if page info not found (e.g. bad alias path)
}
if (pi == null)
{
return;
}
// Get template instance
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
// Get widget from instance
WidgetInfo wi = null;
if (!isNewWidget)
{
// Get the instance of widget
WebPartInstance widgetInstance = templateInstance.GetWebPart(instanceGUID, widgetId);
if (widgetInstance == null)
{
return;
}
// Get widget info by widget name(widget type)
wi = WidgetInfoProvider.GetWidgetInfo(widgetInstance.WebPartType);
}
// Widget instance hasn't created yet
else
{
wi = WidgetInfoProvider.GetWidgetInfo(ValidationHelper.GetInteger(widgetId, 0));
}
if (wi != null)
{
WebPartZoneInstance zone = templateInstance.GetZone(zoneId);
if (zone != null)
{
CurrentUserInfo currentUser = CMSContext.CurrentUser;
switch (zone.WidgetZoneType)
{
// Group zone => Only group widgets and group admin
case WidgetZoneTypeEnum.Group:
// Should always be, only group widget are allowed in group zone
if (!wi.WidgetForGroup || (!currentUser.IsGroupAdministrator(pi.NodeGroupID) && ((CMSContext.ViewMode != ViewModeEnum.Design) || ((CMSContext.ViewMode == ViewModeEnum.Design) && (!currentUser.IsAuthorizedPerResource("CMS.Design", "Design"))))))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
break;
// Widget must be allowed for editor zones
case WidgetZoneTypeEnum.Editor:
if (!wi.WidgetForEditor)
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
break;
// Widget must be allowed for user zones
case WidgetZoneTypeEnum.User:
if (!wi.WidgetForUser)
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
break;
}
if ((zone.WidgetZoneType != WidgetZoneTypeEnum.Group) && !WidgetRoleInfoProvider.IsWidgetAllowed(wi, currentUser.UserID, currentUser.IsAuthenticated()))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
}
// If all ok, set up frames
frameHeader.Attributes.Add("src", "widgetproperties_header.aspx" + URLHelper.Url.Query);
frameContent.Attributes.Add("src", "widgetproperties_properties_frameset.aspx" + URLHelper.Url.Query);
}
}
frameHeader.Attributes.Add("src", "widgetproperties_header.aspx" + URLHelper.Url.Query);
if (inline && !isNewWidget)
{
frameContent.Attributes.Add("src", ResolveUrl("~/CMSPages/Blank.htm"));
}
else
{
frameContent.Attributes.Add("src", "widgetproperties_properties_frameset.aspx" + URLHelper.Url.Query);
}
}
/// <summary>
/// Saves web part zone properties.
/// </summary>
public bool Save()
{
if (ZoneVariantID > 0)
{
// Check OnlineMarketing permissions
if (!CheckPermissions("Manage"))
{
ShowInformation(GetString("general.modifynotallowed"));
return(false);
}
}
// Save the data
if (formElem.SaveData(""))
{
DataRow dr = formElem.DataRow;
// Get basicform's datarow and update the fields
if ((webPartZone != null) && (dr != null) && (pti != null))
{
webPartZone.XMLVersion = 1;
// New variant
if (IsNewVariant)
{
webPartZone = pti.TemplateInstance.EnsureZone(webPartZone.ZoneID);
// Ensure that all the zones which are not saved in the template already will be saved now
// This is a case for new layout zones
if (!webPartZone.HasVariants)
{
TreeProvider tree = new TreeProvider(MembershipContext.AuthenticatedUser);
CMSPortalManager.SaveTemplateChanges(pi, pti.TemplateInstance, WidgetZoneTypeEnum.None, ViewModeEnum.Design, tree);
}
webPartZone = webPartZone.Clone();
string webPartControlId = string.Empty;
// Re-generate web part unique IDs
foreach (WebPartInstance wpi in webPartZone.WebParts)
{
bool webPartIdExists = false;
int offset = 0;
// Set new web part unique ID
string baseId = Regex.Replace(wpi.ControlID, "\\d+$", "");
do
{
webPartControlId = WebPartZoneInstance.GetUniqueWebPartId(baseId, pti.TemplateInstance, offset);
// Check if the returned web part control id is already used in the new zone variant
webPartIdExists = (webPartZone.GetWebPart(webPartControlId) != null);
offset++;
} while (webPartIdExists);
wpi.ControlID = webPartControlId;
wpi.InstanceGUID = new Guid();
}
}
// If zone type changed, delete all webparts in the zone
if (dr.Table.Columns.Contains("WidgetZoneType") &&
ValidationHelper.GetString(webPartZone.GetValue("WidgetZoneType"), "") != ValidationHelper.GetString(dr["WidgetZoneType"], ""))
{
webPartZone.RemoveAllWebParts();
}
foreach (DataColumn column in dr.Table.Columns)
{
webPartZone.MacroTable[column.ColumnName.ToLowerCSafe()] = formElem.MacroTable[column.ColumnName.ToLowerCSafe()];
webPartZone.SetValue(column.ColumnName, dr[column]);
}
// Ensure the layout zone flag
webPartZone.LayoutZone = QueryHelper.GetBoolean("layoutzone", false);
// Save standard zone
if ((ZoneVariantID == 0) && (!IsNewVariant))
{
// Update page template
PageTemplateInfoProvider.SetPageTemplateInfo(pti);
}
else
{
// Save zone variant
if ((webPartZone != null) &&
(webPartZone.ParentTemplateInstance != null) &&
(webPartZone.ParentTemplateInstance.ParentPageTemplate != null) &&
(!webPartZone.WebPartsContainVariants)) // Save only if any of the child web parts does not have variants
{
// Save the variant properties
VariantSettings variant = new VariantSettings()
{
ID = ZoneVariantID,
ZoneID = webPartZone.ZoneID,
PageTemplateID = webPartZone.ParentTemplateInstance.ParentPageTemplate.PageTemplateId,
};
// Get variant description properties
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (properties != null)
{
variant.Name = ValidationHelper.GetString(properties["codename"], string.Empty);
variant.DisplayName = ValidationHelper.GetString(properties["displayname"], string.Empty);
variant.Description = ValidationHelper.GetString(properties["description"], string.Empty);
variant.Enabled = ValidationHelper.GetBoolean(properties["enabled"], true);
if (PortalContext.ContentPersonalizationEnabled)
{
variant.Condition = ValidationHelper.GetString(properties["condition"], string.Empty);
}
}
mZoneVariantID = VariantHelper.SetVariant(variantMode, variant, webPartZone.GetXmlNode());
// The variants are cached -> Reload
pti.TemplateInstance.LoadVariants(true, VariantModeEnum.None);
}
}
// Reload the form (because of macro values set only by JS)
formElem.LoadData(dr);
ShowChangesSaved();
return(true);
}
else
{
return(false);
}
}
else
{
return(false);
}
}
protected void Page_Load(object sender, EventArgs e)
{
// Public user is not allowed for widgets
if (!CMSContext.CurrentUser.IsAuthenticated())
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
string widgetId = QueryHelper.GetString("widgetid", String.Empty);
string aliasPath = QueryHelper.GetString("aliasPath", String.Empty);
string zoneId = QueryHelper.GetString("zoneid", String.Empty);
Guid instanceGUID = QueryHelper.GetGuid("instanceguid", Guid.Empty);
bool isNewWidget = QueryHelper.GetBoolean("isnew", false);
bool inline = QueryHelper.GetBoolean("inline", false);
// Set page title
Page.Title = GetString(isNewWidget ? "widgets.propertiespage.titlenew" : "widgets.propertiespage.title");
if ((widgetId != string.Empty) && (aliasPath != string.Empty))
{
// Get pageinfo
PageInfo pi = null;
try
{
pi = PageInfoProvider.GetPageInfo(CMSContext.CurrentSiteName, aliasPath, CMSContext.PreferredCultureCode, null, CMSContext.CurrentSite.CombineWithDefaultCulture);
}
catch (PageNotFoundException)
{
// Do not throw exception if page info not found (e.g. bad alias path)
}
if (pi == null)
{
return;
}
// Get template instance
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
// Get widget from instance
WidgetInfo wi = null;
if (!isNewWidget)
{
// Get the instance of widget
WebPartInstance widgetInstance = templateInstance.GetWebPart(instanceGUID, widgetId);
if (widgetInstance == null)
{
return;
}
// Get widget info by widget name(widget type)
wi = WidgetInfoProvider.GetWidgetInfo(widgetInstance.WebPartType);
}
// Widget instance hasn't created yet
else
{
wi = WidgetInfoProvider.GetWidgetInfo(ValidationHelper.GetInteger(widgetId, 0));
}
if (wi != null)
{
WebPartZoneInstance zone = templateInstance.GetZone(zoneId);
if (zone != null)
{
CurrentUserInfo currentUser = CMSContext.CurrentUser;
bool checkSecurity = true;
// Check security
// It is group zone type but widget is not allowed in group
if (zone.WidgetZoneType == WidgetZoneTypeEnum.Group)
{
// Should always be, only group widget are allowed in group zone
if (wi.WidgetForGroup)
{
if (!currentUser.IsGroupAdministrator(pi.NodeGroupID))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
// All ok, don't check classic security
checkSecurity = false;
}
}
if (checkSecurity && !WidgetRoleInfoProvider.IsWidgetAllowed(wi, currentUser.UserID, currentUser.IsAuthenticated()))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
}
}
}
// If all ok, set up frames
frameHeader.Attributes.Add("src", "widgetproperties_header.aspx" + URLHelper.Url.Query);
if (inline && !isNewWidget)
{
frameContent.Attributes.Add("src", ResolveUrl("~/CMSPages/Blank.htm"));
}
else
{
frameContent.Attributes.Add("src", "widgetproperties_properties_frameset.aspx" + URLHelper.Url.Query);
}
}
/// <summary>
/// Initializes the control properties.
/// </summary>
protected void SetupControl()
{
if (StopProcessing)
{
// Do nothing
}
else
{
pi = CMSContext.CurrentPageInfo;
if (pi != null)
{
CMSPagePlaceholder parentPlaceHolder = PortalHelper.FindParentPlaceholder(this);
// Nothing to render, nothing to do
if ((!DisplayAddButton && !DisplayResetButton) || ((parentPlaceHolder != null) && (parentPlaceHolder.UsingDefaultPage)))
{
Visible = false;
return;
}
CurrentUserInfo currentUser = CMSContext.CurrentUser;
zoneType = WidgetZoneTypeCode.ToEnum(WidgetZoneType);
// Check security
if (((zoneType == WidgetZoneTypeEnum.Group) && !currentUser.IsGroupAdministrator(pi.NodeGroupID)) ||
((zoneType == WidgetZoneTypeEnum.User || zoneType == WidgetZoneTypeEnum.Dashboard) && !currentUser.IsAuthenticated()))
{
Visible = false;
resetAllowed = false;
return;
}
// Displaying - Editor zone only in edit mode, User/Group zone only in Live site/Preview mode
if (((zoneType == WidgetZoneTypeEnum.Editor) && ((CMSContext.ViewMode != ViewModeEnum.Edit) && (CMSContext.ViewMode != ViewModeEnum.EditLive))) ||
(((zoneType == WidgetZoneTypeEnum.User) || (zoneType == WidgetZoneTypeEnum.Group)) && ((CMSContext.ViewMode != ViewModeEnum.LiveSite) && (CMSContext.ViewMode != ViewModeEnum.Preview))) || ((zoneType == WidgetZoneTypeEnum.Dashboard) && ((CMSContext.ViewMode != ViewModeEnum.DashboardWidgets) || (String.IsNullOrEmpty(PortalContext.DashboardName)))))
{
Visible = false;
resetAllowed = false;
return;
}
// Get current document
TreeNode currentNode = DocumentHelper.GetDocument(pi.DocumentID, TreeProvider);
if (((zoneType == WidgetZoneTypeEnum.Editor) && (!currentUser.IsEditor || (currentUser.IsAuthorizedPerDocument(currentNode, NodePermissionsEnum.Modify) == AuthorizationResultEnum.Denied))))
{
Visible = false;
resetAllowed = false;
return;
}
// If use checkin checkout enabled, check if document is checkout by current user
if (zoneType == WidgetZoneTypeEnum.Editor)
{
if (currentNode != null)
{
WorkflowManager wm = WorkflowManager.GetInstance(TreeProvider);
// Get workflow info
WorkflowInfo wi = wm.GetNodeWorkflow(currentNode);
// Check if node is under workflow and if use checkin checkout enabled
if ((wi != null) && (wi.UseCheckInCheckOut(CMSContext.CurrentSiteName)))
{
int checkedOutBy = currentNode.DocumentCheckedOutByUserID;
// Check if document is checkout by current user
if (checkedOutBy != CMSContext.CurrentUser.UserID)
{
Visible = false;
resetAllowed = false;
return;
}
}
}
}
// Find widget zone
PageTemplateInfo pti = pi.UsedPageTemplateInfo;
// ZodeID specified directly
if (!String.IsNullOrEmpty(WidgetZoneID))
{
zoneInstance = pti.GetZone(WidgetZoneID);
}
// Zone not find or specified zone is not of correct type
if ((zoneInstance != null) && (zoneInstance.WidgetZoneType != zoneType))
{
zoneInstance = null;
}
// For delete all variants all zones are necessary
if (parentPlaceHolder != null)
{
var zones = parentPlaceHolder.WebPartZones;
if (zones != null)
{
foreach (CMSWebPartZone zone in zones)
{
if ((zone.ZoneInstance != null) && (zone.ZoneInstance.WidgetZoneType == zoneType))
{
zoneInstances.Add(zone.ZoneInstance);
if (zoneInstance == null)
{
zoneInstance = zone.ZoneInstance;
}
}
}
}
}
// No suitable zones on the page, nothing to do
if (zoneInstance == null)
{
Visible = false;
resetAllowed = false;
return;
}
// Adding is enabled
if (DisplayAddButton)
{
pnlAdd.Visible = true;
lnkAddWidget.Visible = true;
lnkAddWidget.Text = HTMLHelper.HTMLEncode(DataHelper.GetNotEmpty(AddButtonText, GetString("widgets.addwidget")));
int templateId = 0;
if (pi.UsedPageTemplateInfo != null)
{
templateId = pi.UsedPageTemplateInfo.PageTemplateId;
}
addScript = "NewWidget('" + HttpUtility.UrlEncode(zoneInstance.ZoneID) + "', '" + HttpUtility.UrlEncode(pi.NodeAliasPath) + "', '" + templateId + "'); return false;";
lnkAddWidget.Attributes.Add("onclick", addScript);
}
// Reset is enabled
if (DisplayResetButton)
{
pnlReset.Visible = true;
btnReset.Text = HTMLHelper.HTMLEncode(DataHelper.GetNotEmpty(ResetButtonText, GetString("widgets.resettodefault")));
btnReset.Click += new EventHandler(btnReset_Click);
// Add confirmation if required
if (ResetConfirmationRequired)
{
btnReset.Attributes.Add("onclick", "if (!confirm('" + GetString("widgets.resetzoneconfirmtext") + "')) return false;");
}
}
// Set the panel css clas with dependence on actions zone type
switch (zoneType)
{
// Editor
case WidgetZoneTypeEnum.Editor:
pnlWidgetActions.CssClass = "EditorWidgetActions";
break;
// User
case WidgetZoneTypeEnum.User:
pnlWidgetActions.CssClass = "UserWidgetActions";
break;
// Group
case WidgetZoneTypeEnum.Group:
pnlWidgetActions.CssClass = "GroupWidgetActions";
break;
// Dashboard
case WidgetZoneTypeEnum.Dashboard:
{
if (pnlContextHelp.Controls.Count == 0)
{
// Load help control dynamically (due to faster start compilation)
var help = this.LoadUserControl("~/CMSAdminControls/UI/PageElements/Help.ascx") as HelpControl;
help.TopicName = "dashboard";
}
}
break;
}
}
}
}
/// <summary>
/// Saves widget properties.
/// </summary>
public bool Save()
{
if (VariantID > 0)
{
// Check MVT/CP security
if (!CheckPermissions("Manage"))
{
ShowError("general.modifynotallowed");
return false;
}
}
// Save the data
if ((pi != null) && (pti != null) && (templateInstance != null) && SaveForm(formCustom))
{
// Check manage permission for non-livesite version
if ((CMSContext.ViewMode != ViewModeEnum.LiveSite) && (CMSContext.ViewMode != ViewModeEnum.DashboardWidgets))
{
if (CMSContext.CurrentUser.IsAuthorizedPerDocument(pi.NodeId, pi.ClassName, NodePermissionsEnum.Modify, CMSContext.CurrentSiteName) != AuthorizationResultEnum.Allowed)
{
return false;
}
}
// Get the zone
zone = templateInstance.EnsureZone(ZoneId);
if (zone != null)
{
zone.WidgetZoneType = zoneType;
// Add new widget
if (IsNewWidget)
{
AddWidget();
}
if (IsNewVariant)
{
widgetInstance = widgetInstance.Clone();
if (pi.DocumentTemplateInstance.WebPartZones.Count == 0)
{
// Save to the document as editor admin changes
TreeNode node = DocumentHelper.GetDocument(pi.DocumentId, tree);
// Extract and set the document web parts
node.SetValue("DocumentWebParts", templateInstance.GetZonesXML(WidgetZoneTypeEnum.Editor));
// Save the document
DocumentHelper.UpdateDocument(node, tree);
}
}
// Get basicform's datarow and update widget
SaveFormToWidget(formCustom);
if (IsNewVariant)
{
// Ensures unique id for new widget variant
widgetInstance.ControlID = WebPartZoneInstance.GetUniqueWebPartId(wi.WidgetName, zone.ParentTemplateInstance);
}
// Allow set dashboard in design mode
if ((zoneType == WidgetZoneTypeEnum.Dashboard) && String.IsNullOrEmpty(PortalContext.DashboardName))
{
PortalContext.SetViewMode(ViewModeEnum.Design);
}
bool isWidgetVariant = (VariantID > 0) || IsNewVariant;
if (!isWidgetVariant)
{
// Save the changes
CMSPortalManager.SaveTemplateChanges(pi, pti, templateInstance, zoneType, CMSContext.ViewMode, tree);
}
else if ((CMSContext.ViewMode == ViewModeEnum.Edit) && (zoneType == WidgetZoneTypeEnum.Editor))
{
// Save the variant properties
if ((widgetInstance != null)
&& (widgetInstance.ParentZone != null)
&& (widgetInstance.ParentZone.ParentTemplateInstance != null)
&& (widgetInstance.ParentZone.ParentTemplateInstance.ParentPageTemplate != null))
{
string variantName = string.Empty;
string variantDisplayName = string.Empty;
string variantDisplayCondition = string.Empty;
string variantDescription = string.Empty;
bool variantEnabled = true;
string zoneId = widgetInstance.ParentZone.ZoneID;
int templateId = widgetInstance.ParentZone.ParentTemplateInstance.ParentPageTemplate.PageTemplateId;
Guid instanceGuid = Guid.Empty;
XmlDocument doc = new XmlDocument();
XmlNode xmlWebParts = null;
xmlWebParts = widgetInstance.GetXmlNode(doc);
instanceGuid = InstanceGUID;
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (properties != null)
{
variantName = ValidationHelper.GetString(properties["codename"], string.Empty);
variantDisplayName = ValidationHelper.GetString(properties["displayname"], string.Empty);
variantDescription = ValidationHelper.GetString(properties["description"], string.Empty);
variantEnabled = ValidationHelper.GetBoolean(properties["enabled"], true);
if (VariantMode == VariantModeEnum.ContentPersonalization)
{
variantDisplayCondition = ValidationHelper.GetString(properties["condition"], string.Empty);
}
}
// Save the web part variant properties
if (VariantMode == VariantModeEnum.MVT)
{
ModuleCommands.OnlineMarketingSaveMVTVariant(VariantID, variantName, variantDisplayName, variantDescription, variantEnabled, zoneId, widgetInstance.InstanceGUID, templateId, pi.DocumentId, xmlWebParts);
}
else if (VariantMode == VariantModeEnum.ContentPersonalization)
{
ModuleCommands.OnlineMarketingSaveContentPersonalizationVariant(VariantID, variantName, variantDisplayName, variantDescription, variantEnabled, variantDisplayCondition, zoneId, widgetInstance.InstanceGUID, templateId, pi.DocumentId, xmlWebParts);
}
// Clear the document template
templateInstance.ParentPageTemplate.ParentPageInfo.DocumentTemplateInstance = null;
// Log widget variant synchronization
TreeNode node = DocumentHelper.GetDocument(pi.DocumentId, tree);
DocumentSynchronizationHelper.LogDocumentChange(node, TaskTypeEnum.UpdateDocument, tree);
}
}
}
// Reload the form (because of macro values set only by JS)
formCustom.ReloadData();
// Clear the cached web part
if (InstanceGUID != null)
{
CacheHelper.TouchKey("webpartinstance|" + InstanceGUID.ToString().ToLower());
}
return true;
}
return false;
}
/// <summary>
/// OnInit event (BasicForm initialization).
/// </summary>
protected override void OnInit(EventArgs e)
{
base.OnInit(e);
string zoneId = QueryHelper.GetString("zoneid", "");
string aliasPath = QueryHelper.GetString("aliaspath", "");
int templateId = QueryHelper.GetInteger("templateid", 0);
string culture = QueryHelper.GetString("culture", LocalizationContext.PreferredCultureCode);
mZoneVariantID = QueryHelper.GetInteger("variantid", 0);
mIsNewVariant = QueryHelper.GetBoolean("isnewvariant", false);
variantMode = VariantModeFunctions.GetVariantModeEnum(QueryHelper.GetString("variantmode", string.Empty));
// When displaying an existing variant of a web part, get the variant mode for its original web part
if (ZoneVariantID > 0)
{
PageTemplateInfo pti = PageTemplateInfoProvider.GetPageTemplateInfo(templateId);
if ((pti != null) && ((pti.TemplateInstance != null)))
{
// Get the original webpart and retrieve its variant mode
WebPartZoneInstance zoneInstance = pti.TemplateInstance.GetZone(zoneId);
if ((zoneInstance != null) && (zoneInstance.VariantMode != VariantModeEnum.None))
{
variantMode = zoneInstance.VariantMode;
}
}
}
// Try to find the zone variant in the database and set its VariantID
if (IsNewVariant)
{
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (properties != null)
{
// Get the variant code name from the WindowHelper
string variantName = ValidationHelper.GetString(properties["codename"], string.Empty);
// Check if the variant exists in the database
int variantIdFromDB = VariantHelper.GetVariantID(variantMode, templateId, variantName, true);
// Set the variant id from the database
if (variantIdFromDB > 0)
{
mZoneVariantID = variantIdFromDB;
mIsNewVariant = false;
}
}
}
if (!String.IsNullOrEmpty(zoneId))
{
// Get page info
pi = CMSWebPartPropertiesPage.GetPageInfo(aliasPath, templateId, culture);
if (pi == null)
{
ShowInformation(GetString("webpartzone.notfound"));
pnlFormArea.Visible = false;
return;
}
// Get template
pti = PageTemplateInfoProvider.GetPageTemplateInfo(templateId);
if (pti != null)
{
// Get web part zone
pti.TemplateInstance.EnsureZone(zoneId);
webPartZone = pti.TemplateInstance.GetZone(zoneId);
if ((ZoneVariantID > 0) && (webPartZone != null) && (webPartZone.ZoneInstanceVariants != null))
{
// Check OnlineMarketing permissions
if (CheckPermissions("Read"))
{
webPartZone = webPartZone.ZoneInstanceVariants.Find(v => v.VariantID.Equals(ZoneVariantID));
}
else
{
// Not authorized for OnlineMarketing - Manage.
RedirectToInformation(String.Format(GetString("general.permissionresource"), "Read", (variantMode == VariantModeEnum.ContentPersonalization) ? "CMS.ContentPersonalization" : "CMS.MVTest"));
}
}
if (webPartZone == null)
{
ShowInformation(GetString("webpartzone.notfound"));
pnlFormArea.Visible = false;
return;
}
FormInfo fi = BuildFormInfo(webPartZone);
// Get the DataRow and fill the data row with values
DataRow dr = fi.GetDataRow();
foreach (DataColumn column in dr.Table.Columns)
{
try
{
DataHelper.SetDataRowValue(dr, column.ColumnName, webPartZone.GetValue(column.ColumnName));
}
catch
{
}
}
// Initialize Form
formElem.DataRow = dr;
formElem.MacroTable = webPartZone.MacroTable;
formElem.SubmitButton.Visible = false;
formElem.SiteName = SiteContext.CurrentSiteName;
formElem.FormInformation = fi;
formElem.OnAfterDataLoad += formElem_OnAfterDataLoad;
// HTML editor toolbar
if (fi.UsesHtmlArea())
{
plcToolbarPadding.Visible = true;
plcToolbar.Visible = true;
pnlFormArea.Height = 285;
}
}
}
}
/// <summary>
/// Loads the web part form.
/// </summary>
protected void LoadForm()
{
// Load settings
if (!string.IsNullOrEmpty(Request.Form[hdnIsNewWebPart.UniqueID]))
{
IsNewWebPart = ValidationHelper.GetBoolean(Request.Form[hdnIsNewWebPart.UniqueID], false);
}
if (!string.IsNullOrEmpty(Request.Form[hdnInstanceGUID.UniqueID]))
{
InstanceGUID = ValidationHelper.GetGuid(Request.Form[hdnInstanceGUID.UniqueID], Guid.Empty);
}
// Indicates whether the new variant should be chosen when closing this dialog
selectNewVariant = IsNewVariant;
// Try to find the web part variant in the database and set its VariantID
if (IsNewVariant)
{
Hashtable varProperties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (varProperties != null)
{
// Get the variant code name from the WindowHelper
string variantName = ValidationHelper.GetString(varProperties["codename"], string.Empty);
// Check if the variant exists in the database
int variantIdFromDB = VariantHelper.GetVariantID(VariantMode, PageTemplateID, variantName, true);
// Set the variant id from the database
if (variantIdFromDB > 0)
{
VariantID = variantIdFromDB;
IsNewVariant = false;
}
}
}
if (!String.IsNullOrEmpty(WebPartID))
{
// Get the page info
pi = CMSWebPartPropertiesPage.GetPageInfo(AliasPath, PageTemplateID, CultureCode);
if (pi == null)
{
ShowError(GetString("general.pagenotfound"));
pnlExport.Visible = false;
return;
}
// Get template
pti = pi.UsedPageTemplateInfo;
// Get template instance
templateInstance = pti.TemplateInstance;
if (!IsNewWebPart)
{
// Standard zone
webPartInstance = templateInstance.GetWebPart(InstanceGUID, WebPartID);
// If the web part not found, try to find it among the MVT/CP variants
if (webPartInstance == null)
{
// MVT/CP variant
templateInstance.LoadVariants(false, VariantModeEnum.None);
webPartInstance = templateInstance.GetWebPart(InstanceGUID, -1, 0);
// Set the VariantMode according to the selected web part/zone variant
if ((webPartInstance != null) && (webPartInstance.ParentZone != null))
{
VariantMode = (webPartInstance.VariantMode != VariantModeEnum.None) ? webPartInstance.VariantMode : webPartInstance.ParentZone.VariantMode;
}
else
{
VariantMode = VariantModeEnum.None;
}
}
else
{
// Ensure that the ZoneVariantID is not set when the web part was found in a regular zone
ZoneVariantID = 0;
}
if ((VariantID > 0) && (webPartInstance != null) && (webPartInstance.PartInstanceVariants != null))
{
// Check OnlineMarketing permissions.
if (CheckPermissions("Read"))
{
webPartInstance = webPartInstance.FindVariant(VariantID);
}
else
{
// Not authorized for OnlineMarketing - Manage.
RedirectToInformation(String.Format(GetString("general.permissionresource"), "Read", (VariantMode == VariantModeEnum.ContentPersonalization) ? "CMS.ContentPersonalization" : "CMS.MVTest"));
}
}
if (webPartInstance == null)
{
UIContext.EditedObject = null;
return;
}
}
mainWebPartInstance = webPartInstance;
// Keep xml version
if (webPartInstance != null)
{
xmlVersion = webPartInstance.XMLVersion;
// If data source ID set, edit the data source
if (NestedWebPartID > 0)
{
webPartInstance = webPartInstance.NestedWebParts[NestedWebPartKey] ?? new WebPartInstance()
{
InstanceGUID = Guid.NewGuid()
};
}
}
// Get the form info
FormInfo fi = GetWebPartFormInfo();
// Get the form definition
if (fi != null)
{
fi.ContextResolver.Settings.RelatedObject = templateInstance;
form.AllowMacroEditing = true;
// Get data row with required columns
DataRow dr = fi.GetDataRow();
if (IsNewWebPart || (xmlVersion > 0))
{
fi.LoadDefaultValues(dr);
}
// Load values from existing web part
LoadDataRowFromWebPart(dr, webPartInstance, fi);
// Set a unique WebPartControlID for the new variant
if (IsNewVariant || IsNewWebPart)
{
// Set control ID
string webPartControlId = ValidationHelper.GetCodeName(wpi.WebPartDisplayName);
dr["WebPartControlID"] = WebPartZoneInstance.GetUniqueWebPartId(webPartControlId, templateInstance);
}
// Init the form
InitForm(form, dr, fi);
AddExportLink();
}
else
{
UIContext.EditedObject = null;
}
}
}
/// <summary>
/// Generate documentation page.
/// </summary>
protected override void OnInit(EventArgs e)
{
base.OnInit(e);
// Get current resolver
resolver = CMSContext.CurrentResolver.CreateContextChild();
plImg = GetImageUrl("CMSModules/CMS_PortalEngine/WebpartProperties/plus.png");
minImg = GetImageUrl("CMSModules/CMS_PortalEngine/WebpartProperties/minus.png");
webPartId = QueryHelper.GetString("webPartId", String.Empty);
if (webPartId != String.Empty)
{
wpi = WebPartInfoProvider.GetWebPartInfo(webPartId);
}
string aliasPath = QueryHelper.GetString("aliaspath", String.Empty);
// Ensure correct view mode
if (String.IsNullOrEmpty(aliasPath))
{
// Ensure the dashboard mode for the dialog
if (QueryHelper.Contains("dashboard"))
{
PortalContext.SetRequestViewMode(ViewModeEnum.DashboardWidgets);
PortalContext.DashboardName = QueryHelper.GetString("dashboard", String.Empty);
PortalContext.DashboardSiteName = QueryHelper.GetString("sitename", String.Empty);
}
// Ensure the design mode for the dialog
else
{
PortalContext.SetRequestViewMode(ViewModeEnum.Design);
}
}
// If widgetId is in query create widget documentation
widgetID = QueryHelper.GetString("widgetId", String.Empty);
if (widgetID != String.Empty)
{
// Get widget from instance
string zoneId = QueryHelper.GetString("zoneid", String.Empty);
Guid instanceGuid = QueryHelper.GetGuid("instanceGuid", Guid.Empty);
int templateID = QueryHelper.GetInteger("templateID", 0);
bool newItem = QueryHelper.GetBoolean("isNew", false);
bool isInline = QueryHelper.GetBoolean("Inline", false);
PageInfo pi = null;
try
{
// Load page info from alias path and page template
pi = CMSWebPartPropertiesPage.GetPageInfo(aliasPath, templateID);
}
catch (PageNotFoundException)
{
// Do not throw exception if page info not found (e.g. bad alias path)
}
if (pi != null)
{
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
if (templateInstance != null)
{
// Get the instance of widget
WebPartInstance widgetInstance = templateInstance.GetWebPart(instanceGuid, widgetID);
// Info for zone type
WebPartZoneInstance zone = templateInstance.GetZone(zoneId);
if (zone != null)
{
zoneType = zone.WidgetZoneType;
}
if (widgetInstance != null)
{
// Create widget from webpart instance
wi = WidgetInfoProvider.GetWidgetInfo(widgetInstance.WebPartType);
}
}
}
// If inline widget display columns as in editor zone
if (isInline)
{
zoneType = WidgetZoneTypeEnum.Editor;
}
// If no zone set (only global admins allowed to continue)
if (zoneType == WidgetZoneTypeEnum.None)
{
if (!CMSContext.CurrentUser.UserSiteManagerAdmin)
{
RedirectToAccessDenied(GetString("attach.actiondenied"));
}
}
// If wi is still null (new item f.e.)
if (wi == null)
{
// Try to get widget info directly by ID
if (!newItem)
{
wi = WidgetInfoProvider.GetWidgetInfo(widgetID);
}
else
{
wi = WidgetInfoProvider.GetWidgetInfo(ValidationHelper.GetInteger(widgetID, 0));
}
}
}
String itemDescription = String.Empty;
String itemType = String.Empty;
String itemDisplayName = String.Empty;
String itemDocumentation = String.Empty;
int itemID = 0;
// Check whether webpart was found
if (wpi != null)
{
itemDescription = wpi.WebPartDescription;
itemType = PortalObjectType.WEBPART;
itemID = wpi.WebPartID;
itemDisplayName = wpi.WebPartDisplayName;
itemDocumentation = wpi.WebPartDocumentation;
}
// Or widget was found
else if (wi != null)
{
itemDescription = wi.WidgetDescription;
itemType = PortalObjectType.WIDGET;
itemID = wi.WidgetID;
itemDisplayName = wi.WidgetDisplayName;
itemDocumentation = wi.WidgetDocumentation;
}
if ((wpi != null) || (wi != null))
{
// Get WebPart (widget) image
DataSet ds = MetaFileInfoProvider.GetMetaFiles(itemID, itemType);
// Set image url of exists
if (!DataHelper.DataSourceIsEmpty(ds))
{
MetaFileInfo mtfi = new MetaFileInfo(ds.Tables[0].Rows[0]);
if (mtfi != null)
{
if (mtfi.MetaFileImageWidth > 385)
{
imgTeaser.Width = 385;
}
imgTeaser.ImageUrl = ResolveUrl("~/CMSPages/GetMetaFile.aspx?fileguid=" + mtfi.MetaFileGUID.ToString());
}
}
else
{
// Set default image
imgTeaser.ImageUrl = GetImageUrl("CMSModules/CMS_PortalEngine/WebpartProperties/imagenotavailable.png");
}
// Additional image information
imgTeaser.ToolTip = HTMLHelper.HTMLEncode(itemDisplayName);
imgTeaser.AlternateText = HTMLHelper.HTMLEncode(itemDisplayName);
// Set description of webpart
ltlDescription.Text = HTMLHelper.HTMLEncode(itemDescription);
// Get description from parent weboart if webpart is inherited
if ((wpi != null) && ((wpi.WebPartDescription == null || wpi.WebPartDescription == "") && (wpi.WebPartParentID > 0)))
{
WebPartInfo pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null)
{
ltlDescription.Text = HTMLHelper.HTMLEncode(pwpi.WebPartDescription);
}
}
FormInfo fi = null;
// Generate properties
if (wpi != null)
{
// Get form info from parent if webpart is inherited
if (wpi.WebPartParentID != 0)
{
WebPartInfo pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null)
{
fi = GetWebPartProperties(pwpi);
}
}
else
{
fi = GetWebPartProperties(wpi);
}
}
else if (wi != null)
{
fi = GetWidgetProperties(wi);
}
// Generate properties
if (fi != null)
{
GenerateProperties(fi);
}
// Generate documentation text
if (itemDocumentation == null || itemDocumentation.Trim() == "")
{
if ((wpi != null) && (wpi.WebPartParentID != 0))
{
WebPartInfo pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null && pwpi.WebPartDocumentation.Trim() != "")
{
ltlContent.Text = HTMLHelper.ResolveUrls(pwpi.WebPartDocumentation, null);
}
else
{
ltlContent.Text = "<br /><div style=\"padding-left:5px; font-weight: bold;\">" + GetString("WebPartDocumentation.DocumentationText") + "</div><br />";
}
}
else
{
ltlContent.Text = "<br /><div style=\"padding-left:5px; font-weight: bold;\">" + GetString("WebPartDocumentation.DocumentationText") + "</div><br />";
}
}
else
{
ltlContent.Text = HTMLHelper.ResolveUrls(itemDocumentation, null);
}
}
}
/// <summary>
/// Initializes the control properties.
/// </summary>
protected void SetupControl()
{
if (StopProcessing)
{
// Do nothing
}
else
{
pi = CMSContext.CurrentPageInfo;
if (pi != null)
{
CMSPagePlaceholder parentPlaceHolder = PortalHelper.FindParentPlaceholder(this);
// Nothing to render, nothing to do
if ((!DisplayAddButton && !DisplayResetButton) || ((parentPlaceHolder != null) && (parentPlaceHolder.UsingDefaultPage)))
{
Visible = false;
return;
}
CurrentUserInfo currentUser = CMSContext.CurrentUser;
zoneType = WidgetZoneTypeCode.ToEnum(WidgetZoneType);
// Check security
if (((zoneType == WidgetZoneTypeEnum.Group) && !currentUser.IsGroupAdministrator(pi.NodeGroupID))
|| ((zoneType == WidgetZoneTypeEnum.User || zoneType == WidgetZoneTypeEnum.Dashboard) && !currentUser.IsAuthenticated()))
{
Visible = false;
resetAllowed = false;
return;
}
// Displaying - Editor zone only in edit mode, User/Group zone only in Live site/Preview mode
if (((zoneType == WidgetZoneTypeEnum.Editor) && ((CMSContext.ViewMode != ViewModeEnum.Edit)&&(CMSContext.ViewMode != ViewModeEnum.EditLive))) ||
(((zoneType == WidgetZoneTypeEnum.User) || (zoneType == WidgetZoneTypeEnum.Group)) && ((CMSContext.ViewMode != ViewModeEnum.LiveSite) && (CMSContext.ViewMode != ViewModeEnum.Preview))) || ((zoneType == WidgetZoneTypeEnum.Dashboard) && ((CMSContext.ViewMode != ViewModeEnum.DashboardWidgets) || (String.IsNullOrEmpty(PortalContext.DashboardName)))))
{
Visible = false;
resetAllowed = false;
return;
}
// Get current document
TreeNode currentNode = DocumentHelper.GetDocument(pi.DocumentID, TreeProvider);
if (((zoneType == WidgetZoneTypeEnum.Editor) && (!currentUser.IsEditor || (currentUser.IsAuthorizedPerDocument(currentNode, NodePermissionsEnum.Modify) == AuthorizationResultEnum.Denied))))
{
Visible = false;
resetAllowed = false;
return;
}
// If use checkin checkout enabled, check if document is checkout by current user
if (zoneType == WidgetZoneTypeEnum.Editor)
{
if (currentNode != null)
{
WorkflowManager wm = WorkflowManager.GetInstance(TreeProvider);
// Get workflow info
WorkflowInfo wi = wm.GetNodeWorkflow(currentNode);
// Check if node is under workflow and if use checkin checkout enabled
if ((wi != null) && (wi.UseCheckInCheckOut(CMSContext.CurrentSiteName)))
{
int checkedOutBy = currentNode.DocumentCheckedOutByUserID;
// Check if document is checkout by current user
if (checkedOutBy != CMSContext.CurrentUser.UserID)
{
Visible = false;
resetAllowed = false;
return;
}
}
}
}
// Find widget zone
PageTemplateInfo pti = pi.UsedPageTemplateInfo;
// ZodeID specified directly
if (!String.IsNullOrEmpty(WidgetZoneID))
{
zoneInstance = pti.GetZone(WidgetZoneID);
}
// Zone not find or specified zone is not of correct type
if ((zoneInstance != null) && (zoneInstance.WidgetZoneType != zoneType))
{
zoneInstance = null;
}
// For delete all variants all zones are necessary
if (parentPlaceHolder != null)
{
var zones = parentPlaceHolder.WebPartZones;
if (zones != null)
{
foreach (CMSWebPartZone zone in zones)
{
if ((zone.ZoneInstance != null) && (zone.ZoneInstance.WidgetZoneType == zoneType))
{
zoneInstances.Add(zone.ZoneInstance);
if (zoneInstance == null)
{
zoneInstance = zone.ZoneInstance;
}
}
}
}
}
// No suitable zones on the page, nothing to do
if (zoneInstance == null)
{
Visible = false;
resetAllowed = false;
return;
}
// Adding is enabled
if (DisplayAddButton)
{
pnlAdd.Visible = true;
lnkAddWidget.Visible = true;
lnkAddWidget.Text = HTMLHelper.HTMLEncode(DataHelper.GetNotEmpty(AddButtonText, GetString("widgets.addwidget")));
int templateId = 0;
if (pi.UsedPageTemplateInfo != null)
{
templateId = pi.UsedPageTemplateInfo.PageTemplateId;
}
addScript = "NewWidget('" + HttpUtility.UrlEncode(zoneInstance.ZoneID) + "', '" + HttpUtility.UrlEncode(pi.NodeAliasPath) + "', '" + templateId + "'); return false;";
lnkAddWidget.Attributes.Add("onclick", addScript);
}
// Reset is enabled
if (DisplayResetButton)
{
pnlReset.Visible = true;
btnReset.Text = HTMLHelper.HTMLEncode(DataHelper.GetNotEmpty(ResetButtonText, GetString("widgets.resettodefault")));
btnReset.Click += new EventHandler(btnReset_Click);
// Add confirmation if required
if (ResetConfirmationRequired)
{
btnReset.Attributes.Add("onclick", "if (!confirm('" + GetString("widgets.resetzoneconfirmtext") + "')) return false;");
}
}
// Set the panel css clas with dependence on actions zone type
switch (zoneType)
{
// Editor
case WidgetZoneTypeEnum.Editor:
pnlWidgetActions.CssClass = "EditorWidgetActions";
break;
// User
case WidgetZoneTypeEnum.User:
pnlWidgetActions.CssClass = "UserWidgetActions";
break;
// Group
case WidgetZoneTypeEnum.Group:
pnlWidgetActions.CssClass = "GroupWidgetActions";
break;
// Dashboard
case WidgetZoneTypeEnum.Dashboard:
{
if (pnlContextHelp.Controls.Count == 0)
{
// Load help control dynamically (due to faster start compilation)
var help = this.LoadUserControl("~/CMSAdminControls/UI/PageElements/Help.ascx") as HelpControl;
help.TopicName = "dashboard";
}
}
break;
}
}
}
}
/// <summary>
/// Handles the Load event of the Page control.
/// </summary>
protected void Page_Load(object sender, EventArgs e)
{
RegisterModalPageScripts();
// Set page title
Page.Title = GetString(isNewWidget ? "widgets.propertiespage.titlenew" : "widgets.propertiespage.title");
// Resize the header (enlarge) to make a space for the tabs header when displaying a widget variant
var headerHeight = TitleOnlyHeight;
if (variantId > 0)
{
headerHeight = TabsFrameHeight;
}
rowsFrameset.Attributes.Add("rows", string.Format("{0}, *", headerHeight));
// Ensure correct view mode
if (String.IsNullOrEmpty(aliasPath))
{
// Ensure the dashboard mode for the dialog
if (QueryHelper.Contains("dashboard"))
{
PortalContext.SetRequestViewMode(ViewModeEnum.DashboardWidgets);
PortalContext.DashboardName = QueryHelper.GetString("dashboard", String.Empty);
PortalContext.DashboardSiteName = QueryHelper.GetString("sitename", String.Empty);
}
// Ensure the design mode for the dialog
else
{
PortalContext.SetRequestViewMode(ViewModeEnum.Design);
}
}
if (widgetId != "")
{
// Get template instance
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(PageInfo);
// Get widget from instance
WidgetInfo wi;
if (!isNewWidget)
{
// Get the instance of widget
WebPartInstance widgetInstance = templateInstance.GetWebPart(instanceGuid, widgetId);
if (widgetInstance == null)
{
return;
}
// Get widget info by widget name(widget type)
wi = WidgetInfoProvider.GetWidgetInfo(widgetInstance.WebPartType);
}
// Widget instance hasn't created yet
else
{
wi = WidgetInfoProvider.GetWidgetInfo(ValidationHelper.GetInteger(widgetId, 0));
}
if (wi != null)
{
WebPartZoneInstance zone = templateInstance.GetZone(zoneId);
if (zone != null)
{
var currentUser = MembershipContext.AuthenticatedUser;
switch (zone.WidgetZoneType)
{
// Group zone => Only group widgets and group admin
case WidgetZoneTypeEnum.Group:
// Should always be, only group widget are allowed in group zone
if (!wi.WidgetForGroup || (!currentUser.IsGroupAdministrator(PageInfo.NodeGroupID) && ((PortalContext.ViewMode != ViewModeEnum.Design) || ((PortalContext.ViewMode == ViewModeEnum.Design) && (!currentUser.IsAuthorizedPerResource("CMS.Design", "Design"))))))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
break;
// Widget must be allowed for editor zones
case WidgetZoneTypeEnum.Editor:
if (!wi.WidgetForEditor)
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
break;
// Widget must be allowed for user zones
case WidgetZoneTypeEnum.User:
if (!wi.WidgetForUser)
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
break;
}
if ((zone.WidgetZoneType != WidgetZoneTypeEnum.Group) && !WidgetRoleInfoProvider.IsWidgetAllowed(wi, currentUser.UserID, AuthenticationHelper.IsAuthenticated()))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
}
// If all ok, set up frames
frameHeader.Attributes.Add("src", "widgetproperties_header.aspx" + RequestContext.CurrentQueryString);
frameContent.Attributes.Add("src", "widgetproperties_properties_frameset.aspx" + RequestContext.CurrentQueryString);
}
}
frameHeader.Attributes.Add("src", "widgetproperties_header.aspx" + RequestContext.CurrentQueryString);
if (inline && !isNewWidget)
{
frameContent.Attributes.Add("src", ResolveUrl("~/CMSPages/Blank.htm"));
}
else
{
frameContent.Attributes.Add("src", "widgetproperties_properties_frameset.aspx" + RequestContext.CurrentQueryString);
}
}
/// <summary>
/// Loads the widget form.
/// </summary>
private void LoadForm()
{
// Setup basic form on live site
formCustom.AllowMacroEditing = false;
formCustom.IsLiveSite = IsLiveSite;
// Load settings
if (!String.IsNullOrEmpty(Request.Form[hdnIsNewWebPart.UniqueID]))
{
IsNewWidget = ValidationHelper.GetBoolean(Request.Form[hdnIsNewWebPart.UniqueID], false);
}
if (!String.IsNullOrEmpty(Request.Form[hdnInstanceGUID.UniqueID]))
{
InstanceGUID = ValidationHelper.GetGuid(Request.Form[hdnInstanceGUID.UniqueID], Guid.Empty);
}
// Try to find the widget variant in the database and set its VariantID
if (IsNewVariant)
{
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (properties != null)
{
// Get the variant code name from the WindowHelper
string variantName = ValidationHelper.GetString(properties["codename"], string.Empty);
// Check if the variant exists in the database
int variantIdFromDB = VariantHelper.GetVariantID(VariantMode, PageTemplateId, variantName, false);
// Set the variant id from the database
if (variantIdFromDB > 0)
{
VariantID = variantIdFromDB;
IsNewVariant = false;
}
}
}
EnsureDashboard();
if (!String.IsNullOrEmpty(WidgetId) && !IsInline)
{
if (CurrentPageInfo == null)
{
ShowError(GetString("Widgets.Properties.aliasnotfound"));
pnlFormArea.Visible = false;
return;
}
// Get template instance
mTemplateInstance = CMSPortalManager.GetTemplateInstanceForEditing(CurrentPageInfo);
if (!IsNewWidget)
{
// Get the instance of widget
mWidgetInstance = mTemplateInstance.GetWebPart(InstanceGUID, WidgetId);
if (mWidgetInstance == null)
{
ShowError(GetString("Widgets.Properties.WidgetNotFound"));
pnlFormArea.Visible = false;
return;
}
if ((VariantID > 0) && (mWidgetInstance != null) && (mWidgetInstance.PartInstanceVariants != null))
{
// Check OnlineMarketing permissions.
if (CheckPermissions("Read"))
{
mWidgetInstance = CurrentPageInfo.DocumentTemplateInstance.GetWebPart(InstanceGUID, WidgetId);
mWidgetInstance = mWidgetInstance.PartInstanceVariants.Find(v => v.VariantID.Equals(VariantID));
// Set the widget variant mode
if (mWidgetInstance != null)
{
VariantMode = mWidgetInstance.VariantMode;
}
}
else
{
// Not authorized for OnlineMarketing - Manage.
RedirectToInformation(String.Format(GetString("general.permissionresource"), "Read", (VariantMode == VariantModeEnum.ContentPersonalization) ? "CMS.ContentPersonalization" : "CMS.MVTest"));
}
}
// Get widget info by widget name(widget type)
mWidgetInfo = WidgetInfoProvider.GetWidgetInfo(mWidgetInstance.WebPartType);
}
// Widget instance hasn't created yet
else
{
mWidgetInfo = WidgetInfoProvider.GetWidgetInfo(ValidationHelper.GetInteger(WidgetId, 0));
}
// Keep xml version
if (mWidgetInstance != null)
{
mXmlVersion = mWidgetInstance.XMLVersion;
}
UIContext.EditedObject = mWidgetInfo;
// Get the zone to which it inserts
WebPartZoneInstance zone = mTemplateInstance.GetZone(ZoneId);
if ((ZoneType == WidgetZoneTypeEnum.None) && (zone != null))
{
ZoneType = zone.WidgetZoneType;
}
// Check security
var currentUser = MembershipContext.AuthenticatedUser;
switch (ZoneType)
{
// Group zone => Only group widgets and group admin
case WidgetZoneTypeEnum.Group:
// Should always be, only group widget are allowed in group zone
if (!mWidgetInfo.WidgetForGroup || (!currentUser.IsGroupAdministrator(CurrentPageInfo.NodeGroupID) && ((PortalContext.ViewMode != ViewModeEnum.Design) || ((PortalContext.ViewMode == ViewModeEnum.Design) && (!currentUser.IsAuthorizedPerResource("CMS.Design", "Design"))))))
{
if (OnNotAllowed != null)
{
OnNotAllowed(this, null);
}
}
break;
// Widget must be allowed for editor zones
case WidgetZoneTypeEnum.Editor:
if (!mWidgetInfo.WidgetForEditor)
{
if (OnNotAllowed != null)
{
OnNotAllowed(this, null);
}
}
break;
// Widget must be allowed for user zones
case WidgetZoneTypeEnum.User:
if (!mWidgetInfo.WidgetForUser)
{
if (OnNotAllowed != null)
{
OnNotAllowed(this, null);
}
}
break;
// Widget must be allowed for dashboard zones
case WidgetZoneTypeEnum.Dashboard:
if (!mWidgetInfo.WidgetForDashboard)
{
if (OnNotAllowed != null)
{
OnNotAllowed(this, null);
}
}
break;
}
// Check security
if ((ZoneType != WidgetZoneTypeEnum.Group) && !WidgetRoleInfoProvider.IsWidgetAllowed(mWidgetInfo, currentUser.UserID, AuthenticationHelper.IsAuthenticated()))
{
if (OnNotAllowed != null)
{
OnNotAllowed(this, null);
}
}
// Get form schemas
mWebPartInfo = WebPartInfoProvider.GetWebPartInfo(mWidgetInfo.WidgetWebPartID);
string widgetProperties = FormHelper.MergeFormDefinitions(mWebPartInfo.WebPartProperties, mWidgetInfo.WidgetProperties);
FormInfo fi = PortalFormHelper.GetWidgetFormInfo(mWidgetInfo.WidgetName, ZoneType, widgetProperties, true, mWidgetInfo.WidgetDefaultValues);
if (fi != null)
{
fi.ContextResolver.Settings.RelatedObject = mTemplateInstance;
// Check if there are some editable properties
var ffi = fi.GetFields(true, false);
if ((ffi == null) || (ffi.Count == 0))
{
ShowInformation(GetString("widgets.emptyproperties"));
}
DataRow dr = fi.GetDataRow();
// Load overridden values for new widget
if (IsNewWidget || (mXmlVersion > 0))
{
fi.LoadDefaultValues(dr, FormResolveTypeEnum.WidgetVisible);
}
if (IsNewWidget)
{
// Override default value and set title as widget display name
DataHelper.SetDataRowValue(dr, "WidgetTitle", ResHelper.LocalizeString(mWidgetInfo.WidgetDisplayName));
}
// Load values from existing widget
LoadDataRowFromWidget(dr, fi);
// Init HTML toolbar if exists
InitHTMLToobar(fi);
// Init the form
InitForm(formCustom, dr, fi);
// Set the context name
formCustom.ControlContext.ContextName = CMS.Base.Web.UI.ControlContext.WIDGET_PROPERTIES;
}
}
if (IsInline)
{
// Load text definition from session
string definition = ValidationHelper.GetString(SessionHelper.GetValue("WidgetDefinition"), String.Empty);
if (String.IsNullOrEmpty(definition))
{
definition = Request.Form[hdnWidgetDefinition.UniqueID];
}
else
{
hdnWidgetDefinition.Value = definition;
}
Hashtable parameters = null;
string widgetName = String.Empty;
if (IsNewWidget)
{
// New widget - load widget info by id
if (!String.IsNullOrEmpty(WidgetId))
{
mWidgetInfo = WidgetInfoProvider.GetWidgetInfo(ValidationHelper.GetInteger(WidgetId, 0));
}
else
{
// Try to get widget from codename
widgetName = QueryHelper.GetString("WidgetName", String.Empty);
mWidgetInfo = WidgetInfoProvider.GetWidgetInfo(widgetName);
}
}
else
{
if (definition == null)
{
DisplayError("widget.failedtoload");
return;
}
// Parse definition
parameters = CMSDialogHelper.GetHashTableFromString(definition);
// Trim control name
if (parameters["name"] != null)
{
widgetName = parameters["name"].ToString();
}
mWidgetInfo = WidgetInfoProvider.GetWidgetInfo(widgetName);
}
if (mWidgetInfo == null)
{
DisplayError("widget.failedtoload");
return;
}
// If widget cant be used as inline
if (!mWidgetInfo.WidgetForInline)
{
DisplayError("widget.cantbeusedasinline");
return;
}
// Test permission for user
var currentUser = MembershipContext.AuthenticatedUser;
if (!WidgetRoleInfoProvider.IsWidgetAllowed(mWidgetInfo, currentUser.UserID, AuthenticationHelper.IsAuthenticated()))
{
mIsValidWidget = false;
OnNotAllowed(this, null);
}
// If user is editor, more properties are shown
WidgetZoneTypeEnum zoneType = WidgetZoneTypeEnum.User;
if (currentUser.CheckPrivilegeLevel(UserPrivilegeLevelEnum.Editor, SiteContext.CurrentSiteName))
{
zoneType = WidgetZoneTypeEnum.Editor;
}
WebPartInfo wpi = WebPartInfoProvider.GetWebPartInfo(mWidgetInfo.WidgetWebPartID);
string widgetProperties = FormHelper.MergeFormDefinitions(wpi.WebPartProperties, mWidgetInfo.WidgetProperties);
FormInfo fi = PortalFormHelper.GetWidgetFormInfo(mWidgetInfo.WidgetName, zoneType, widgetProperties, true, mWidgetInfo.WidgetDefaultValues);
if (fi != null)
{
// Check if there are some editable properties
mFields = fi.GetFields(true, true);
if ((mFields == null) || !mFields.Any())
{
ShowInformation(GetString("widgets.emptyproperties"));
}
// Get datarows with required columns
DataRow dr = PortalHelper.CombineWithDefaultValues(fi, mWidgetInfo);
if (IsNewWidget)
{
// Load default values for new widget
fi.LoadDefaultValues(dr, FormResolveTypeEnum.WidgetVisible);
}
else
{
foreach (string key in parameters.Keys)
{
object value = parameters[key];
// Test if given property exists
if (dr.Table.Columns.Contains(key) && (value != null))
{
try
{
dr[key] = DataHelper.ConvertValue(value, dr.Table.Columns[key].DataType);
}
catch
{
}
}
}
}
// Override default value and set title as widget display name
DataHelper.SetDataRowValue(dr, "WidgetTitle", mWidgetInfo.WidgetDisplayName);
// Init HTML toolbar if exists
InitHTMLToobar(fi);
// Init the form
InitForm(formCustom, dr, fi);
// Set the context name
formCustom.ControlContext.ContextName = CMS.Base.Web.UI.ControlContext.WIDGET_PROPERTIES;
}
}
}
/// <summary>
/// Saves widget properties.
/// </summary>
public bool Save()
{
if (VariantID > 0)
{
// Check MVT/CP security
if (!CheckPermissions("Manage"))
{
DisplayError("general.modifynotallowed");
return(false);
}
}
// Save the data
if ((pi != null) && (templateInstance != null) && SaveForm(formCustom))
{
// Check manage permission for non-livesite version
if ((CMSContext.ViewMode != ViewModeEnum.LiveSite) && (CMSContext.ViewMode != ViewModeEnum.DashboardWidgets))
{
if (CMSContext.CurrentUser.IsAuthorizedPerDocument(pi.NodeID, pi.ClassName, NodePermissionsEnum.Modify) != AuthorizationResultEnum.Allowed)
{
return(false);
}
}
PageTemplateInfo pti = templateInstance.ParentPageTemplate;
if ((CMSContext.ViewMode == ViewModeEnum.Design) && CMSObjectHelper.IsCheckedOutByOtherUser(pti))
{
string userName = null;
UserInfo ui = UserInfoProvider.GetUserInfo(pti.Generalized.IsCheckedOutByUserID);
if (ui != null)
{
userName = HTMLHelper.HTMLEncode(ui.GetFormattedUserName(IsLiveSite));
}
DisplayError(string.Format(GetString("ObjectEditMenu.CheckedOutByAnotherUser"), pti.ObjectType, pti.DisplayName, userName));
return(false);
}
// Get the zone
zone = templateInstance.EnsureZone(ZoneId);
if (zone != null)
{
zone.WidgetZoneType = zoneType;
// Add new widget
if (IsNewWidget)
{
bool isLayoutZone = (QueryHelper.GetBoolean("layoutzone", false));
int widgetID = ValidationHelper.GetInteger(WidgetId, 0);
// Create new widget instance
widgetInstance = PortalHelper.AddNewWidget(widgetID, ZoneId, ZoneType, isLayoutZone, templateInstance, null);
}
widgetInstance.XMLVersion = 1;
if (IsNewVariant)
{
widgetInstance = widgetInstance.Clone();
if (pi.DocumentTemplateInstance.WebPartZones.Count == 0)
{
// Save to the document as editor admin changes
TreeNode node = DocumentHelper.GetDocument(pi.DocumentID, tree);
// Extract and set the document web parts
node.SetValue("DocumentWebParts", templateInstance.GetZonesXML(WidgetZoneTypeEnum.Editor));
// Save the document
DocumentHelper.UpdateDocument(node, tree);
}
}
// Get basicform's datarow and update widget
SaveFormToWidget(formCustom, templateInstance);
if (IsNewVariant)
{
// Ensures unique id for new widget variant
widgetInstance.ControlID = WebPartZoneInstance.GetUniqueWebPartId(wi.WidgetName, zone.ParentTemplateInstance);
}
// Allow set dashboard in design mode
if ((zoneType == WidgetZoneTypeEnum.Dashboard) && String.IsNullOrEmpty(PortalContext.DashboardName))
{
PortalContext.SetViewMode(ViewModeEnum.Design);
}
bool isWidgetVariant = (VariantID > 0) || IsNewVariant;
if (!isWidgetVariant)
{
// Save the changes
CMSPortalManager.SaveTemplateChanges(pi, templateInstance, zoneType, CMSContext.ViewMode, tree);
}
else if ((CMSContext.ViewMode == ViewModeEnum.Edit) && (zoneType == WidgetZoneTypeEnum.Editor))
{
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
PortalHelper.SaveWebPartVariantChanges(widgetInstance, VariantID, 0, VariantMode, properties);
// Clear the document template
templateInstance.ParentPageTemplate.ParentPageInfo.DocumentTemplateInstance = null;
// Log widget variant synchronization
TreeNode node = DocumentHelper.GetDocument(pi.DocumentID, tree);
DocumentSynchronizationHelper.LogDocumentChange(node, TaskTypeEnum.UpdateDocument, tree);
}
}
// Reload the form (because of macro values set only by JS)
formCustom.ReloadData();
// Clear the cached web part
if (InstanceGUID != null)
{
CacheHelper.TouchKey("webpartinstance|" + InstanceGUID.ToString().ToLowerCSafe());
}
return(true);
}
return(false);
}
/// <summary>
/// Saves widget properties.
/// </summary>
public bool Save()
{
if (VariantID > 0)
{
// Check MVT/CP security
if (!CheckPermissions("Manage"))
{
DisplayError("general.modifynotallowed");
return false;
}
}
// Save the data
if ((CurrentPageInfo != null) && (templateInstance != null) && SaveForm(formCustom))
{
ViewModeEnum viewMode = PortalContext.ViewMode;
// Check manage permission for non-livesite version
if (!viewMode.IsLiveSite() && (viewMode != ViewModeEnum.DashboardWidgets))
{
if (CurrentUser.IsAuthorizedPerDocument(CurrentPageInfo.NodeID, CurrentPageInfo.ClassName, NodePermissionsEnum.Modify) != AuthorizationResultEnum.Allowed)
{
DisplayError("general.modifynotallowed");
return false;
}
// Check design permissions
if (PortalContext.IsDesignMode(viewMode, false) && !PortalContext.CurrentUserIsDesigner)
{
RedirectToAccessDenied("CMS.Design", "Design");
}
}
PageTemplateInfo pti = templateInstance.ParentPageTemplate;
if (PortalContext.IsDesignMode(viewMode) && SynchronizationHelper.IsCheckedOutByOtherUser(pti))
{
string userName = null;
UserInfo ui = UserInfoProvider.GetUserInfo(pti.Generalized.IsCheckedOutByUserID);
if (ui != null)
{
userName = HTMLHelper.HTMLEncode(ui.GetFormattedUserName(IsLiveSite));
}
DisplayError(string.Format(GetString("ObjectEditMenu.CheckedOutByAnotherUser"), pti.TypeInfo.ObjectType, pti.DisplayName, userName));
return false;
}
// Get the zone
zone = templateInstance.EnsureZone(ZoneId);
if (zone != null)
{
zone.WidgetZoneType = ZoneType;
// Add new widget
if (IsNewWidget)
{
bool isLayoutZone = (QueryHelper.GetBoolean("layoutzone", false));
int widgetID = ValidationHelper.GetInteger(WidgetId, 0);
// Create new widget instance
widgetInstance = PortalHelper.AddNewWidget(widgetID, ZoneId, ZoneType, isLayoutZone, templateInstance, null);
}
// Ensure handling of the currently edited object (if not exists -> redirect)
UIContext.EditedObject = widgetInstance;
widgetInstance.XMLVersion = 1;
if (IsNewVariant)
{
widgetInstance = widgetInstance.Clone();
// Check whether the editor widgets have been already customized
if (CurrentPageInfo.DocumentTemplateInstance.WebPartZones.Count == 0)
{
// There are no customized editor widgets yet => copy the default editor widgets from the page template under the document (to enable customization)
// Save to the document as editor admin changes
TreeNode node = DocumentHelper.GetDocument(CurrentPageInfo.DocumentID, tree);
// Extract and set the document web parts
node.SetValue("DocumentWebParts", templateInstance.GetZonesXML(WidgetZoneTypeEnum.Editor));
// Save the document
DocumentHelper.UpdateDocument(node, tree);
}
}
bool isLayoutWidget = ((wpi != null) && ((WebPartTypeEnum)wpi.WebPartType == WebPartTypeEnum.Layout));
// Get basicform's datarow and update widget
SaveFormToWidget(formCustom, templateInstance, isLayoutWidget);
// Ensure unique id for new widget variant or layout widget
if (IsNewVariant || (isLayoutWidget && IsNewWidget))
{
string controlId = GetUniqueWidgetId(wi.WidgetName);
if (!string.IsNullOrEmpty(controlId))
{
widgetInstance.ControlID = controlId;
}
else
{
DisplayError("Unable to generate unique widget id.");
return false;
}
}
// Allow set dashboard in design mode
if ((ZoneType == WidgetZoneTypeEnum.Dashboard) && String.IsNullOrEmpty(PortalContext.DashboardName))
{
viewMode = ViewModeEnum.Design;
PortalContext.SetViewMode(ViewModeEnum.Design);
}
bool isWidgetVariant = (VariantID > 0) || IsNewVariant;
if (!isWidgetVariant)
{
// Save the changes
if ((viewMode.IsEdit(true) || viewMode.IsEditLive()) && (ZoneType == WidgetZoneTypeEnum.Editor))
{
if (DocumentManager.AllowSave)
{
// Store the editor widgets in the temporary interlayer
PortalContext.SaveEditorWidgets(CurrentPageInfo.DocumentID, templateInstance.GetZonesXML(WidgetZoneTypeEnum.Editor));
}
}
else
{
// Save the changes
CMSPortalManager.SaveTemplateChanges(CurrentPageInfo, templateInstance, ZoneType, viewMode, tree);
}
}
else if ((viewMode.IsEdit()) && (ZoneType == WidgetZoneTypeEnum.Editor))
{
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
VariantHelper.SaveWebPartVariantChanges(widgetInstance, VariantID, 0, VariantMode, properties);
// Clear the document template
templateInstance.ParentPageTemplate.ParentPageInfo.DocumentTemplateInstance = null;
// Log widget variant synchronization
TreeNode node = DocumentHelper.GetDocument(CurrentPageInfo.DocumentID, tree);
DocumentSynchronizationHelper.LogDocumentChange(node, TaskTypeEnum.UpdateDocument, tree);
}
}
// Reload the form (because of macro values set only by JS)
formCustom.ReloadData();
// Display info message
ShowChangesSaved();
// Clear the cached web part
if (InstanceGUID != null)
{
CacheHelper.TouchKey("webpartinstance|" + InstanceGUID.ToString().ToLowerCSafe());
}
return true;
}
return false;
}
protected override void OnLoad(EventArgs e)
{
plImg = GetImageUrl("CMSModules/CMS_PortalEngine/WebpartProperties/plus.png");
minImg = GetImageUrl("CMSModules/CMS_PortalEngine/WebpartProperties/minus.png");
if (WebpartID != String.Empty)
{
wpi = WebPartInfoProvider.GetWebPartInfo(WebpartID);
}
// Ensure correct view mode
if (String.IsNullOrEmpty(AliasPath))
{
// Ensure the dashboard mode for the dialog
if (!string.IsNullOrEmpty(DashboardName))
{
PortalContext.SetRequestViewMode(ViewModeEnum.DashboardWidgets);
PortalContext.DashboardName = DashboardName;
PortalContext.DashboardSiteName = DashboardSiteName;
}
// Ensure the design mode for the dialog
else
{
PortalContext.SetRequestViewMode(ViewModeEnum.Design);
}
}
if (WidgetID != 0)
{
PageInfo pi = null;
try
{
// Load page info from alias path and page template
pi = CMSWebPartPropertiesPage.GetPageInfo(AliasPath, PageTemplateID, CultureCode);
}
catch (PageNotFoundException)
{
// Do not throw exception if page info not found (e.g. bad alias path)
}
if (pi != null)
{
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
if (templateInstance != null)
{
// Get the instance of widget
WebPartInstance widgetInstance = templateInstance.GetWebPart(InstanceGUID);
// Info for zone type
WebPartZoneInstance zone = templateInstance.GetZone(ZoneID);
if (zone != null)
{
zoneType = zone.WidgetZoneType;
}
if (widgetInstance != null)
{
// Create widget from webpart instance
wi = WidgetInfoProvider.GetWidgetInfo(widgetInstance.WebPartType);
}
}
}
// If inline widget display columns as in editor zone
if (IsInline)
{
zoneType = WidgetZoneTypeEnum.Editor;
}
// If no zone set (only global admins allowed to continue)
if (zoneType == WidgetZoneTypeEnum.None)
{
if (!MembershipContext.AuthenticatedUser.CheckPrivilegeLevel(UserPrivilegeLevelEnum.GlobalAdmin))
{
RedirectToAccessDenied(GetString("attach.actiondenied"));
}
}
// If wi is still null (new item f.e.)
if (wi == null)
{
// Try to get widget info directly by ID
wi = WidgetInfoProvider.GetWidgetInfo(WidgetID);
}
}
String itemDescription = String.Empty;
String itemType = String.Empty;
String itemDisplayName = String.Empty;
String itemDocumentation = String.Empty;
String itemIcon = String.Empty;
int itemID = 0;
// Check whether webpart was found
if (wpi != null)
{
itemDescription = wpi.WebPartDescription;
itemType = WebPartInfo.OBJECT_TYPE;
itemID = wpi.WebPartID;
itemDisplayName = wpi.WebPartDisplayName;
itemDocumentation = wpi.WebPartDocumentation;
itemIcon = PortalHelper.GetIconHtml(wpi.WebPartThumbnailGUID, wpi.WebPartIconClass ?? PortalHelper.DefaultWebPartIconClass);
}
// Or widget was found
else if (wi != null)
{
itemDescription = wi.WidgetDescription;
itemType = WidgetInfo.OBJECT_TYPE;
itemID = wi.WidgetID;
itemDisplayName = wi.WidgetDisplayName;
itemDocumentation = wi.WidgetDocumentation;
itemIcon = PortalHelper.GetIconHtml(wi.WidgetThumbnailGUID, wi.WidgetIconClass ?? PortalHelper.DefaultWidgetIconClass);
}
if ((wpi != null) || (wi != null))
{
// Get WebPart (widget) icon
ltrImage.Text = itemIcon;
// Set description of webpart
ltlDescription.Text = HTMLHelper.HTMLEncode(ResHelper.LocalizeString(itemDescription));
// Get description from parent weboart if webpart is inherited
if ((wpi != null) && (string.IsNullOrEmpty(wpi.WebPartDescription) && (wpi.WebPartParentID > 0)))
{
WebPartInfo pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null)
{
ltlDescription.Text = HTMLHelper.HTMLEncode(pwpi.WebPartDescription);
}
}
FormInfo fi = null;
// Generate properties
if (wpi != null)
{
// Get form info from parent if webpart is inherited
if (wpi.WebPartParentID != 0)
{
WebPartInfo pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null)
{
fi = GetWebPartProperties(pwpi);
}
}
else
{
fi = GetWebPartProperties(wpi);
}
}
else if (wi != null)
{
fi = GetWidgetProperties(wi);
}
// Generate properties
if (fi != null)
{
GenerateProperties(fi);
}
// Generate documentation text
if (itemDocumentation == null || itemDocumentation.Trim() == "")
{
if ((wpi != null) && (wpi.WebPartParentID != 0))
{
WebPartInfo pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null && pwpi.WebPartDocumentation.Trim() != "")
{
ltlContent.Text = HTMLHelper.ResolveUrls(pwpi.WebPartDocumentation, null);
}
else
{
ltlContent.Text = "<br /><div style=\"padding-left:5px; font-weight: bold;\">" + GetString("WebPartDocumentation.DocumentationText") + "</div><br />";
}
}
else
{
ltlContent.Text = "<br /><div style=\"padding-left:5px; font-weight: bold;\">" + GetString("WebPartDocumentation.DocumentationText") + "</div><br />";
}
}
else
{
ltlContent.Text = HTMLHelper.ResolveUrls(itemDocumentation, null);
}
}
ScriptHelper.RegisterJQuery(Page);
string script = @"
$cmsj(document.body).ready(initializeResize);
function initializeResize () {
resizeareainternal();
$cmsj(window).resize(function() { resizeareainternal(); });
}
function resizeareainternal () {
var height = document.body.clientHeight ;
var panel = document.getElementById ('" + divScrolable.ClientID + @"');
// Get parent footer to count proper height (with padding included)
var footer = $cmsj('#divFooter');
panel.style.height = (height - footer.outerHeight() - panel.offsetTop) +'px';
}";
ScriptHelper.RegisterClientScriptBlock(Page, typeof(Page), "mainScript", ScriptHelper.GetScript(script));
// Init tabs
tabControlElem.UsePostback = true;
tabControlElem.AddTab(new UITabItem()
{
Text = GetString("webparts.documentation"),
});
tabControlElem.AddTab(new UITabItem()
{
Text = GetString("general.properties"),
});
// Disable caching
Response.Cache.SetNoStore();
base.OnLoad(e);
}
/// <summary>
/// Handles the OnReloadData event of the menuZoneVariants control.
/// </summary>
protected void menuMoveToZoneVariants_OnReloadData(object sender, EventArgs e)
{
if ((CMSContext.CurrentPageInfo != null) &&
(CMSContext.CurrentPageInfo.TemplateInstance != null))
{
string targetZoneId = ValidationHelper.GetString(menuMoveToZoneVariants.Parameter, string.Empty);
int pageTemplateId = CMSContext.CurrentPageInfo.UsedPageTemplateInfo.PageTemplateId;
VariantModeEnum currentVariantMode = VariantModeEnum.None;
// Get selected zone variant mode
if ((CMSContext.CurrentPageInfo != null) &&
(CMSContext.CurrentPageInfo.TemplateInstance != null))
{
WebPartZoneInstance targetZone = CMSContext.CurrentPageInfo.TemplateInstance.GetZone(targetZoneId);
if (targetZone != null)
{
currentVariantMode = targetZone.VariantMode;
}
}
SetColumnNames(currentVariantMode);
// Get all zone variants of the current web part
DataSet ds = null;
DataTable resultTable = null;
if (currentVariantMode == VariantModeEnum.MVT)
{
if (currentUser.IsAuthorizedPerResource("CMS.MVTest", "Read"))
{
// Get all MVT zone variants of the current web part
ds = ModuleCommands.OnlineMarketingGetMVTVariants(pageTemplateId, targetZoneId, Guid.Empty, 0);
}
}
else if (currentVariantMode == VariantModeEnum.ContentPersonalization)
{
if (currentUser.IsAuthorizedPerResource("CMS.ContentPersonalization", "Read"))
{
// Content personalization variants
ds = ModuleCommands.OnlineMarketingGetContentPersonalizationVariants(pageTemplateId, targetZoneId, Guid.Empty, 0);
}
}
if (!DataHelper.DataSourceIsEmpty(ds))
{
DataTable table = ds.Tables[0].Copy();
table.DefaultView.Sort = columnVariantID;
// Add the original web part as the first item in the variant list
DataRow originalVariant = table.NewRow();
originalVariant[columnVariantID] = 0;
originalVariant[columnVariantDisplayName] = ResHelper.GetString("ZoneMenu.OriginalZone");
originalVariant[columnVariantZoneID] = targetZoneId;
originalVariant[columnVariantPageTemplateID] = pageTemplateId;
originalVariant[columnVariantInstanceGUID] = Guid.Empty;
table.Rows.InsertAt(originalVariant, 0);
resultTable = table.DefaultView.ToTable();
if (DataHelper.DataSourceIsEmpty(resultTable))
{
pnlNoZoneVariants.Visible = true;
ltlNoZoneVariants.Text = ResHelper.GetString("Content.NoPermissions");
}
}
repMoveToZoneVariants.DataSource = resultTable;
repMoveToZoneVariants.DataBind();
}
}
/// <summary>
/// Initializes the control properties.
/// </summary>
protected void SetupControl()
{
if (StopProcessing)
{
// Do nothing
}
else
{
if (CurrentPageInfo != null)
{
PageInfo pi = CurrentPageInfo;
// Make visible, visibility according to the current state will be set later (solves issue with changing visibility during postbacks)
Visible = true;
CMSPagePlaceholder parentPlaceHolder = PortalHelper.FindParentPlaceholder(this);
// Nothing to render, nothing to do
if ((!DisplayAddButton && !DisplayResetButton) ||
((parentPlaceHolder != null) && (parentPlaceHolder.UsingDefaultPage || (parentPlaceHolder.PageInfo.DocumentID != pi.DocumentID))))
{
Visible = false;
return;
}
var currentUser = MembershipContext.AuthenticatedUser;
zoneType = WidgetZoneTypeCode.ToEnum(WidgetZoneType);
// Check security
if (((zoneType == WidgetZoneTypeEnum.Group) && !currentUser.IsGroupAdministrator(pi.NodeGroupID))
|| ((zoneType == WidgetZoneTypeEnum.User || zoneType == WidgetZoneTypeEnum.Dashboard) && !AuthenticationHelper.IsAuthenticated()))
{
Visible = false;
resetAllowed = false;
return;
}
// Displaying - Editor zone only in edit mode, User/Group zone only in Live site/Preview mode
if (((zoneType == WidgetZoneTypeEnum.Editor) && !PortalManager.ViewMode.IsOneOf(ViewModeEnum.Edit, ViewModeEnum.EditDisabled, ViewModeEnum.EditLive))
|| (((zoneType == WidgetZoneTypeEnum.User) || (zoneType == WidgetZoneTypeEnum.Group)) && !PortalManager.ViewMode.IsOneOf(ViewModeEnum.LiveSite, ViewModeEnum.Preview))
|| ((zoneType == WidgetZoneTypeEnum.Dashboard) && ((PortalManager.ViewMode != ViewModeEnum.DashboardWidgets) || (String.IsNullOrEmpty(PortalContext.DashboardName)))))
{
Visible = false;
resetAllowed = false;
return;
}
// Get current document
TreeNode currentNode = DocumentHelper.GetDocument(pi.DocumentID, TreeProvider);
if (((zoneType == WidgetZoneTypeEnum.Editor) && (!currentUser.CheckPrivilegeLevel(UserPrivilegeLevelEnum.Editor, SiteContext.CurrentSiteName) || (currentUser.IsAuthorizedPerDocument(currentNode, NodePermissionsEnum.Modify) == AuthorizationResultEnum.Denied))))
{
Visible = false;
resetAllowed = false;
return;
}
// If use checkin checkout enabled, check if document is checkout by current user
if (zoneType == WidgetZoneTypeEnum.Editor)
{
if (currentNode != null)
{
WorkflowManager wm = WorkflowManager.GetInstance(TreeProvider);
// Get workflow info
WorkflowInfo wi = wm.GetNodeWorkflow(currentNode);
// Check if node is under workflow and if use checkin checkout enabled
if ((wi != null) && (wi.UseCheckInCheckOut(SiteContext.CurrentSiteName)))
{
int checkedOutBy = currentNode.DocumentCheckedOutByUserID;
// Check if document is checkout by current user
if (checkedOutBy != MembershipContext.AuthenticatedUser.UserID)
{
Visible = false;
resetAllowed = false;
return;
}
}
}
}
// Find widget zone
PageTemplateInfo pti = pi.UsedPageTemplateInfo;
// ZodeID specified directly
if (!String.IsNullOrEmpty(WidgetZoneID))
{
zoneInstance = pti.TemplateInstance.GetZone(WidgetZoneID);
}
// Zone not find or specified zone is not of correct type
if ((zoneInstance != null) && (zoneInstance.WidgetZoneType != zoneType))
{
zoneInstance = null;
}
// For delete all variants all zones are necessary
if (parentPlaceHolder != null)
{
var zones = parentPlaceHolder.WebPartZones;
if (zones != null)
{
foreach (CMSWebPartZone zone in zones)
{
if ((zone.ZoneInstance != null) && (zone.ZoneInstance.WidgetZoneType == zoneType))
{
zoneInstances.Add(zone.ZoneInstance);
if (zoneInstance == null)
{
zoneInstance = zone.ZoneInstance;
}
}
}
}
}
// No suitable zones on the page, nothing to do
if (zoneInstance == null)
{
Visible = false;
resetAllowed = false;
return;
}
// Adding is enabled
if (DisplayAddButton)
{
btnAddWidget.Visible = true;
btnAddWidget.Text = GetAddWidgetButtonText();
int templateId = 0;
if (pi.UsedPageTemplateInfo != null)
{
templateId = pi.UsedPageTemplateInfo.PageTemplateId;
}
addScript = (PortalContext.ViewMode == ViewModeEnum.EditLive ? "OEDeactivateWebPartBorder({ webPartSpanId: $cmsj('.OnSiteMenuTable').parent().attr('id').replace('OE_OE_', 'OE_')}, null );" : String.Empty) + "NewWidget(new zoneProperties('" + zoneInstance.ZoneID + "', '" + pi.NodeAliasPath + "', '" + templateId + "')); return false;";
btnAddWidget.Attributes.Add("onclick", addScript);
}
// Reset is enabled
if (DisplayResetButton)
{
btnReset.Visible = true;
btnReset.Text = GetResetButtonText();
btnReset.Click += new EventHandler(btnReset_Click);
// Add confirmation if required
if (ResetConfirmationRequired)
{
btnReset.Attributes.Add("onclick", "if (!confirm(" + ScriptHelper.GetLocalizedString("widgets.resetzoneconfirmtext") + ")) return false;");
}
}
// Set the panel css clas with dependence on actions zone type
switch (zoneType)
{
// Editor
case WidgetZoneTypeEnum.Editor:
pnlWidgetActions.CssClass = "EditorWidgetActions";
break;
// User
case WidgetZoneTypeEnum.User:
pnlWidgetActions.CssClass = "UserWidgetActions";
break;
// Group
case WidgetZoneTypeEnum.Group:
pnlWidgetActions.CssClass = "GroupWidgetActions";
break;
}
}
}
}
/// <summary>
/// Returns new unique web part ID based on the given <paramref name="controlId"/>.
/// </summary>
/// <param name="controlId">Id of target control</param>
private string GetUniqueWebPartId(string controlId)
{
return(WebPartZoneInstance.GetUniqueWebPartId(controlId, templateInstance));
}
/// <summary>
/// Initializes the control properties.
/// </summary>
protected void SetupControl()
{
if (StopProcessing)
{
// Do nothing
}
else
{
if (CurrentPageInfo != null)
{
PageInfo pi = CurrentPageInfo;
// Make visible, visibility according to the current state will be set later (solves issue with changing visibility during postbacks)
Visible = true;
CMSPagePlaceholder parentPlaceHolder = PortalHelper.FindParentPlaceholder(this);
// Nothing to render, nothing to do
if ((!DisplayAddButton && !DisplayResetButton) ||
((parentPlaceHolder != null) && (parentPlaceHolder.UsingDefaultPage || (parentPlaceHolder.PageInfo.DocumentID != pi.DocumentID))))
{
Visible = false;
return;
}
var currentUser = MembershipContext.AuthenticatedUser;
zoneType = WidgetZoneType.ToEnum <WidgetZoneTypeEnum>();
// Check security
if (((zoneType == WidgetZoneTypeEnum.Group) && !currentUser.IsGroupAdministrator(pi.NodeGroupID)) ||
((zoneType == WidgetZoneTypeEnum.User || zoneType == WidgetZoneTypeEnum.Dashboard) && !AuthenticationHelper.IsAuthenticated()))
{
Visible = false;
resetAllowed = false;
return;
}
// Displaying - Editor zone only in edit mode, User/Group zone only in Live site/Preview mode
if (((zoneType == WidgetZoneTypeEnum.Editor) && !PortalManager.ViewMode.IsOneOf(ViewModeEnum.Edit, ViewModeEnum.EditDisabled, ViewModeEnum.EditLive)) ||
(((zoneType == WidgetZoneTypeEnum.User) || (zoneType == WidgetZoneTypeEnum.Group)) && !PortalManager.ViewMode.IsOneOf(ViewModeEnum.LiveSite, ViewModeEnum.Preview)) ||
((zoneType == WidgetZoneTypeEnum.Dashboard) && ((PortalManager.ViewMode != ViewModeEnum.DashboardWidgets) || (String.IsNullOrEmpty(PortalContext.DashboardName)))))
{
Visible = false;
resetAllowed = false;
return;
}
// Get current document
TreeNode currentNode = DocumentHelper.GetDocument(pi.DocumentID, TreeProvider);
if (((zoneType == WidgetZoneTypeEnum.Editor) && (!currentUser.CheckPrivilegeLevel(UserPrivilegeLevelEnum.Editor, SiteContext.CurrentSiteName) || (currentUser.IsAuthorizedPerDocument(currentNode, NodePermissionsEnum.Modify) == AuthorizationResultEnum.Denied))))
{
Visible = false;
resetAllowed = false;
return;
}
// If use checkin checkout enabled, check if document is checkout by current user
if (zoneType == WidgetZoneTypeEnum.Editor)
{
if (currentNode != null)
{
WorkflowManager wm = WorkflowManager.GetInstance(TreeProvider);
// Get workflow info
WorkflowInfo wi = wm.GetNodeWorkflow(currentNode);
// Check if node is under workflow and if use checkin checkout enabled
if ((wi != null) && (wi.UseCheckInCheckOut(SiteContext.CurrentSiteName)))
{
int checkedOutBy = currentNode.DocumentCheckedOutByUserID;
// Check if document is checkout by current user
if (checkedOutBy != MembershipContext.AuthenticatedUser.UserID)
{
Visible = false;
resetAllowed = false;
return;
}
}
}
}
// Find widget zone
PageTemplateInfo pti = pi.UsedPageTemplateInfo;
// ZodeID specified directly
if (!String.IsNullOrEmpty(WidgetZoneID))
{
zoneInstance = pti.TemplateInstance.GetZone(WidgetZoneID);
}
// Zone not find or specified zone is not of correct type
if ((zoneInstance != null) && (zoneInstance.WidgetZoneType != zoneType))
{
zoneInstance = null;
}
// For delete all variants all zones are necessary
if (parentPlaceHolder != null)
{
var zones = parentPlaceHolder.WebPartZones;
if (zones != null)
{
foreach (CMSWebPartZone zone in zones)
{
if ((zone.ZoneInstance != null) && (zone.ZoneInstance.WidgetZoneType == zoneType))
{
zoneInstances.Add(zone.ZoneInstance);
if (zoneInstance == null)
{
zoneInstance = zone.ZoneInstance;
}
}
}
}
}
// No suitable zones on the page, nothing to do
if (zoneInstance == null)
{
Visible = false;
resetAllowed = false;
return;
}
// Adding is enabled
if (DisplayAddButton)
{
btnAddWidget.Visible = true;
btnAddWidget.Text = GetAddWidgetButtonText();
int templateId = 0;
if (pi.UsedPageTemplateInfo != null)
{
templateId = pi.UsedPageTemplateInfo.PageTemplateId;
}
addScript = (PortalContext.ViewMode == ViewModeEnum.EditLive ? "OEDeactivateWebPartBorder({ webPartSpanId: $cmsj('.OnSiteMenuTable').parent().attr('id').replace('OE_OE_', 'OE_')}, null );" : String.Empty) + "NewWidget(new zoneProperties('" + zoneInstance.ZoneID + "', '" + pi.NodeAliasPath + "', '" + templateId + "')); return false;";
btnAddWidget.Attributes.Add("onclick", addScript);
}
// Reset is enabled
if (DisplayResetButton)
{
btnReset.Visible = true;
btnReset.Text = GetResetButtonText();
btnReset.Click += new EventHandler(btnReset_Click);
// Add confirmation if required
if (ResetConfirmationRequired)
{
btnReset.Attributes.Add("onclick", "if (!confirm(" + ScriptHelper.GetString(PortalHelper.LocalizeStringForUI("widgets.resetzoneconfirmtext")) + ")) return false;");
}
}
// Set the panel css clas with dependence on actions zone type
switch (zoneType)
{
// Editor
case WidgetZoneTypeEnum.Editor:
pnlWidgetActions.CssClass = "EditorWidgetActions";
break;
// User
case WidgetZoneTypeEnum.User:
pnlWidgetActions.CssClass = "UserWidgetActions";
break;
// Group
case WidgetZoneTypeEnum.Group:
pnlWidgetActions.CssClass = "GroupWidgetActions";
break;
}
}
}
}
/// <summary>
/// Returns the form definition for the web part zone properties.
/// </summary>
private FormInfo BuildFormInfo(WebPartZoneInstance webPartZone)
{
FormInfo fi = null;
string formDefinition = String.Empty;
// Dashboard zone properties
if ((pti != null) && (pti.PageTemplateType == PageTemplateTypeEnum.Dashboard))
{
formDefinition = PortalFormHelper.LoadProperties("WebPartZone", "Dashboard.xml");
}
// UI page template properties
else if ((pti != null) && (pti.PageTemplateType == PageTemplateTypeEnum.UI))
{
formDefinition = PortalFormHelper.LoadProperties("WebPartZone", "UI.xml");
}
// Classic web part/widget properties
else
{
formDefinition = PortalFormHelper.LoadProperties("WebPartZone", "Standard.xml");
}
if (!String.IsNullOrEmpty(formDefinition))
{
// Load properties
fi = new FormInfo(formDefinition);
fi.UpdateExistingFields(fi);
DataRow dr = fi.GetDataRow();
LoadDataRowFromWebPartZone(dr, webPartZone);
}
return fi;
}
/// <summary>
/// Initializes menu.
/// </summary>
protected void InitalizeMenu()
{
if (!String.IsNullOrEmpty(widgetId) || !String.IsNullOrEmpty(widgetName))
{
WidgetInfo wi = null;
// Get page info
PageInfo pi = CMSWebPartPropertiesPage.GetPageInfo(aliasPath, templateId, culture);
if (pi == null)
{
Visible = false;
return;
}
// Get template instance
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
if (templateInstance != null)
{
// Get zone type
WebPartZoneInstance zoneInstance = templateInstance.GetZone(zoneId);
if (zoneInstance != null)
{
zoneType = zoneInstance.WidgetZoneType;
}
if (!isNewWidget)
{
// Get web part
WebPartInstance widget = templateInstance.GetWebPart(instanceGuid, widgetId);
if ((widget != null) && widget.IsWidget)
{
// WebPartType = codename, get widget by codename
wi = WidgetInfoProvider.GetWidgetInfo(widget.WebPartType);
// Set the variant mode (MVT/Content personalization)
variantMode = widget.VariantMode;
}
}
}
// New widget
if (isNewWidget)
{
int id = ValidationHelper.GetInteger(widgetId, 0);
if (id > 0)
{
wi = WidgetInfoProvider.GetWidgetInfo(id);
}
else if (!String.IsNullOrEmpty(widgetName))
{
wi = WidgetInfoProvider.GetWidgetInfo(widgetName);
}
}
// Get widget info from name if not found yet
if ((wi == null) && (!String.IsNullOrEmpty(widgetName)))
{
wi = WidgetInfoProvider.GetWidgetInfo(widgetName);
}
if (wi != null)
{
pageTitle.TitleText = GetString("Widgets.Properties.Title") + " (" + HTMLHelper.HTMLEncode(ResHelper.LocalizeString(wi.WidgetDisplayName)) + ")";
}
// Use live or non live dialogs
string documentationUrl = String.Empty;
// If no zone type defined or not inline => do not show documentation
switch (zoneType)
{
case WidgetZoneTypeEnum.Dashboard:
case WidgetZoneTypeEnum.Editor:
case WidgetZoneTypeEnum.Group:
case WidgetZoneTypeEnum.User:
documentationUrl = ResolveUrl("~/CMSModules/Widgets/Dialogs/WidgetDocumentation.aspx");
break;
// If no zone set => do not create documentation link
default:
if (inline)
{
documentationUrl = ResolveUrl("~/CMSModules/Widgets/Dialogs/WidgetDocumentation.aspx");
}
else
{
return;
}
break;
}
// Generate documentation link
Literal ltr = new Literal();
pageTitle.RightPlaceHolder.Controls.Add(ltr);
// Ensure correct parameters in documentation URL
documentationUrl += URLHelper.GetQuery(RequestContext.CurrentURL);
if (wi != null)
{
documentationUrl = URLHelper.UpdateParameterInUrl(documentationUrl, "widgetid", wi.WidgetID.ToString());
}
string docScript = "NewWindow('" + ScriptHelper.GetString(documentationUrl, encapsulate: false) + "', 'WebPartPropertiesDocumentation', 800, 800); return false;";
string tooltip = GetString("help.tooltip");
ltr.Text += String.Format
("<div class=\"action-button\"><a onclick=\"{0}\" href=\"#\"><span class=\"sr-only\">{1}</span><i class=\"icon-modal-question cms-icon-80\" title=\"{1}\" aria-hidden=\"true\"></i></a></div>",
HTMLHelper.EncodeForHtmlAttribute(docScript), tooltip);
}
}
/// <summary>
/// Saves web part zone properties.
/// </summary>
public bool Save()
{
if (ZoneVariantID > 0)
{
// Check OnlineMarketing permissions
if (!CheckPermissions("Manage"))
{
ShowInformation(GetString("general.modifynotallowed"));
return false;
}
}
// Save the data
if (formElem.SaveData(""))
{
DataRow dr = formElem.DataRow;
// Get basicform's datarow and update the fields
if ((webPartZone != null) && (dr != null) && (pti != null))
{
webPartZone.XMLVersion = 1;
// New variant
if (IsNewVariant)
{
webPartZone = pti.TemplateInstance.EnsureZone(webPartZone.ZoneID);
// Ensure that all the zones which are not saved in the template already will be saved now
// This is a case for new layout zones
if (!webPartZone.HasVariants)
{
TreeProvider tree = new TreeProvider(MembershipContext.AuthenticatedUser);
CMSPortalManager.SaveTemplateChanges(pi, pti.TemplateInstance, WidgetZoneTypeEnum.None, ViewModeEnum.Design, tree);
}
webPartZone = webPartZone.Clone();
string webPartControlId = string.Empty;
// Re-generate web part unique IDs
foreach (WebPartInstance wpi in webPartZone.WebParts)
{
bool webPartIdExists = false;
int offset = 0;
// Set new web part unique ID
string baseId = Regex.Replace(wpi.ControlID, "\\d+$", "");
do
{
webPartControlId = WebPartZoneInstance.GetUniqueWebPartId(baseId, pti.TemplateInstance, offset);
// Check if the returned web part control id is already used in the new zone variant
webPartIdExists = (webPartZone.GetWebPart(webPartControlId) != null);
offset++;
} while (webPartIdExists);
wpi.ControlID = webPartControlId;
wpi.InstanceGUID = new Guid();
}
}
// If zone type changed, delete all webparts in the zone
if (dr.Table.Columns.Contains("WidgetZoneType") &&
ValidationHelper.GetString(webPartZone.GetValue("WidgetZoneType"), "") != ValidationHelper.GetString(dr["WidgetZoneType"], ""))
{
webPartZone.RemoveAllWebParts();
}
foreach (DataColumn column in dr.Table.Columns)
{
webPartZone.MacroTable[column.ColumnName.ToLowerCSafe()] = formElem.MacroTable[column.ColumnName.ToLowerCSafe()];
webPartZone.SetValue(column.ColumnName, dr[column]);
}
// Ensure the layout zone flag
webPartZone.LayoutZone = QueryHelper.GetBoolean("layoutzone", false);
// Save standard zone
if ((ZoneVariantID == 0) && (!IsNewVariant))
{
// Update page template
PageTemplateInfoProvider.SetPageTemplateInfo(pti);
}
else
{
// Save zone variant
if ((webPartZone != null)
&& (webPartZone.ParentTemplateInstance != null)
&& (webPartZone.ParentTemplateInstance.ParentPageTemplate != null)
&& (!webPartZone.WebPartsContainVariants)) // Save only if any of the child web parts does not have variants
{
// Save the variant properties
VariantSettings variant = new VariantSettings()
{
ID = ZoneVariantID,
ZoneID = webPartZone.ZoneID,
PageTemplateID = webPartZone.ParentTemplateInstance.ParentPageTemplate.PageTemplateId,
};
// Get variant description properties
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
if (properties != null)
{
variant.Name = ValidationHelper.GetString(properties["codename"], string.Empty);
variant.DisplayName = ValidationHelper.GetString(properties["displayname"], string.Empty);
variant.Description = ValidationHelper.GetString(properties["description"], string.Empty);
variant.Enabled = ValidationHelper.GetBoolean(properties["enabled"], true);
if (PortalContext.ContentPersonalizationEnabled)
{
variant.Condition = ValidationHelper.GetString(properties["condition"], string.Empty);
}
}
mZoneVariantID = VariantHelper.SetVariant(variantMode, variant, webPartZone.GetXmlNode());
// The variants are cached -> Reload
pti.TemplateInstance.LoadVariants(true, VariantModeEnum.None);
}
}
// Reload the form (because of macro values set only by JS)
formElem.LoadData(dr);
ShowChangesSaved();
return true;
}
else
{
return false;
}
}
else
{
return false;
}
}
/// <summary>
/// Handles the Load event of the Page control.
/// </summary>
protected void Page_Load(object sender, EventArgs e)
{
// Public user is not allowed for widgets
if (!AuthenticationHelper.IsAuthenticated())
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
var viewMode = ViewModeCode.FromString(QueryHelper.GetString("viewmode", String.Empty));
var hash = QueryHelper.GetString("hash", String.Empty);
LiveSiteWidgetsParameters dialogparameters = new LiveSiteWidgetsParameters(aliasPath, viewMode)
{
ZoneId = zoneId,
ZoneType = zoneType,
InstanceGuid = instanceGuid,
TemplateId = templateId,
IsInlineWidget = inline
};
if (!dialogparameters.ValidateHash(hash))
{
return;
}
// Set page title
Page.Title = GetString(isNewWidget ? "widgets.propertiespage.titlenew" : "widgets.propertiespage.title");
if ((widgetId != string.Empty) && (aliasPath != string.Empty))
{
// Get page info
var siteName = SiteContext.CurrentSiteName;
PageInfo pi = PageInfoProvider.GetPageInfo(siteName, aliasPath, LocalizationContext.PreferredCultureCode, null, SiteInfoProvider.CombineWithDefaultCulture(siteName));
if (pi == null)
{
return;
}
// Get template instance
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
// Get widget from instance
WidgetInfo wi = null;
if (!isNewWidget)
{
// Get the instance of widget
WebPartInstance widgetInstance = templateInstance.GetWebPart(instanceGuid, widgetId);
if (widgetInstance == null)
{
return;
}
// Get widget info by widget name(widget type)
wi = WidgetInfoProvider.GetWidgetInfo(widgetInstance.WebPartType);
}
// Widget instance hasn't created yet
else
{
wi = WidgetInfoProvider.GetWidgetInfo(ValidationHelper.GetInteger(widgetId, 0));
}
if (wi != null)
{
WebPartZoneInstance zone = templateInstance.GetZone(zoneId);
if (zone != null)
{
var currentUser = MembershipContext.AuthenticatedUser;
bool checkSecurity = true;
// Check security
// It is group zone type but widget is not allowed in group
if (zone.WidgetZoneType == WidgetZoneTypeEnum.Group)
{
// Should always be, only group widget are allowed in group zone
if (wi.WidgetForGroup)
{
if (!currentUser.IsGroupAdministrator(pi.NodeGroupID))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
// All ok, don't check classic security
checkSecurity = false;
}
}
if (checkSecurity && !WidgetRoleInfoProvider.IsWidgetAllowed(wi, currentUser.UserID, AuthenticationHelper.IsAuthenticated()))
{
RedirectToAccessDenied(GetString("widgets.security.notallowed"));
}
}
}
}
// If all ok, set up frames
rowsFrameset.Attributes.Add("rows", string.Format("{0}, *", TitleOnlyHeight));
frameHeader.Attributes.Add("src", "widgetproperties_header.aspx" + RequestContext.CurrentQueryString);
if (inline && !isNewWidget)
{
frameContent.Attributes.Add("src", ResolveUrl("~/CMSPages/Blank.htm"));
}
else
{
frameContent.Attributes.Add("src", "widgetproperties_properties_frameset.aspx" + RequestContext.CurrentQueryString);
}
}
/// <summary>
/// Page load.
/// </summary>
protected void Page_Load(object sender, EventArgs e)
{
if (StopProcessing)
{
return;
}
treeElem.OnItemSelected += treeElem_OnItemSelected;
if (!RequestHelper.IsPostBack())
{
// Select root by default
ResetToDefault();
}
// Different behavior of flat selector for different group zones
if (IsInline)
{
// Inline widget
flatElem.SelectInlineWidgets = true;
treeElem.SelectInlineWidgets = true;
}
else if (IsDashboard)
{
// Dashboard zone
flatElem.SelectDashboardWidgets = true;
treeElem.SelectDashboardWidgets = true;
}
else if (!String.IsNullOrEmpty(ZoneId))
{
// Get pageinfo
PageInfo pi = null;
try
{
pi = CMSWebPartPropertiesPage.GetPageInfo(AliasPath, PageTemplateId, CultureCode);
}
catch (PageNotFoundException)
{
// Do not throw exception if page info not found (e.g. bad alias path)
}
PageTemplateInstance templateInstance = CMSPortalManager.GetTemplateInstanceForEditing(pi);
if (templateInstance != null)
{
WidgetZoneTypeEnum zoneType = ZoneType;
// Get settings of the zone if present in the template
WebPartZoneInstance zone = templateInstance.GetZone(ZoneId);
if ((zoneType == WidgetZoneTypeEnum.None) && (zone != null))
{
zoneType = zone.WidgetZoneType;
}
// Set flags to flat element by type of widget zone
if (zoneType == WidgetZoneTypeEnum.Group)
{
flatElem.SelectGroupWidgets = true;
treeElem.SelectGroupWidgets = true;
flatElem.GroupID = pi.NodeGroupID;
}
else if (zoneType == WidgetZoneTypeEnum.User)
{
flatElem.SelectUserWidgets = true;
treeElem.SelectUserWidgets = true;
}
else if (zoneType == WidgetZoneTypeEnum.Editor)
{
flatElem.SelectEditorWidgets = true;
treeElem.SelectEditorWidgets = true;
}
}
}
}
/// <summary>
/// Saves widget properties.
/// </summary>
public bool Save()
{
if (VariantID > 0)
{
// Check MVT/CP security
if (!CheckPermissions("Manage"))
{
DisplayError("general.modifynotallowed");
return false;
}
}
// Save the data
if ((pi != null) && (templateInstance != null) && SaveForm(formCustom))
{
// Check manage permission for non-livesite version
if ((CMSContext.ViewMode != ViewModeEnum.LiveSite) && (CMSContext.ViewMode != ViewModeEnum.DashboardWidgets))
{
if (CMSContext.CurrentUser.IsAuthorizedPerDocument(pi.NodeID, pi.ClassName, NodePermissionsEnum.Modify) != AuthorizationResultEnum.Allowed)
{
return false;
}
}
PageTemplateInfo pti = templateInstance.ParentPageTemplate;
if ((CMSContext.ViewMode == ViewModeEnum.Design) && CMSObjectHelper.IsCheckedOutByOtherUser(pti))
{
string userName = null;
UserInfo ui = UserInfoProvider.GetUserInfo(pti.Generalized.IsCheckedOutByUserID);
if (ui != null)
{
userName = HTMLHelper.HTMLEncode(ui.GetFormattedUserName(IsLiveSite));
}
DisplayError(string.Format(GetString("ObjectEditMenu.CheckedOutByAnotherUser"), pti.ObjectType, pti.DisplayName, userName));
return false;
}
// Get the zone
zone = templateInstance.EnsureZone(ZoneId);
if (zone != null)
{
zone.WidgetZoneType = zoneType;
// Add new widget
if (IsNewWidget)
{
bool isLayoutZone = (QueryHelper.GetBoolean("layoutzone", false));
int widgetID = ValidationHelper.GetInteger(WidgetId, 0);
// Create new widget instance
widgetInstance = PortalHelper.AddNewWidget(widgetID, ZoneId, ZoneType, isLayoutZone, templateInstance, null);
}
widgetInstance.XMLVersion = 1;
if (IsNewVariant)
{
widgetInstance = widgetInstance.Clone();
if (pi.DocumentTemplateInstance.WebPartZones.Count == 0)
{
// Save to the document as editor admin changes
TreeNode node = DocumentHelper.GetDocument(pi.DocumentID, tree);
// Extract and set the document web parts
node.SetValue("DocumentWebParts", templateInstance.GetZonesXML(WidgetZoneTypeEnum.Editor));
// Save the document
DocumentHelper.UpdateDocument(node, tree);
}
}
// Get basicform's datarow and update widget
SaveFormToWidget(formCustom, templateInstance);
if (IsNewVariant)
{
// Ensures unique id for new widget variant
widgetInstance.ControlID = WebPartZoneInstance.GetUniqueWebPartId(wi.WidgetName, zone.ParentTemplateInstance);
}
// Allow set dashboard in design mode
if ((zoneType == WidgetZoneTypeEnum.Dashboard) && String.IsNullOrEmpty(PortalContext.DashboardName))
{
PortalContext.SetViewMode(ViewModeEnum.Design);
}
bool isWidgetVariant = (VariantID > 0) || IsNewVariant;
if (!isWidgetVariant)
{
// Save the changes
CMSPortalManager.SaveTemplateChanges(pi, templateInstance, zoneType, CMSContext.ViewMode, tree);
}
else if ((CMSContext.ViewMode == ViewModeEnum.Edit) && (zoneType == WidgetZoneTypeEnum.Editor))
{
Hashtable properties = WindowHelper.GetItem("variantProperties") as Hashtable;
PortalHelper.SaveWebPartVariantChanges(widgetInstance, VariantID, 0, VariantMode, properties);
// Clear the document template
templateInstance.ParentPageTemplate.ParentPageInfo.DocumentTemplateInstance = null;
// Log widget variant synchronization
TreeNode node = DocumentHelper.GetDocument(pi.DocumentID, tree);
DocumentSynchronizationHelper.LogDocumentChange(node, TaskTypeEnum.UpdateDocument, tree);
}
}
// Reload the form (because of macro values set only by JS)
formCustom.ReloadData();
// Clear the cached web part
if (InstanceGUID != null)
{
CacheHelper.TouchKey("webpartinstance|" + InstanceGUID.ToString().ToLowerCSafe());
}
return true;
}
return false;
}
