using System;
using System.Collections;
using System.Data;
using System.Text;
using CMS.CMSHelper;
using CMS.FormEngine;
using CMS.GlobalHelper;
using CMS.PortalEngine;
using CMS.SettingsProvider;
using CMS.SiteProvider;
using CMS.UIControls;
public partial class CMSPages_Dialogs_Documentation : CMSPage
{
#region "Variables"
///
/// HTML representation of menu (list of webparts in multiple mode).
///
private string menu = "";
///
/// HTML representation of content (webpart title and properties).
///
private string content = "";
///
/// 0 - documentation present
/// 1-documentation missing
/// 2-documentation present but inherited from parent webpart
///
private int documentation = 0;
///
/// If true webpart (widget) has image.
///
private bool isImagePresent = false;
///
/// Count of undocumented properties.
///
private int undocumentedProperties = 0;
///
/// Documentation title.
///
protected string documentationTitle = "Kentico CMS Web Parts";
///
/// If true information about webpart is displayed.
///
private bool development = false;
///
/// Resolver.
///
private ContextResolver resolver = null;
#endregion
#region "Methods"
protected void Page_Load(object sender, EventArgs e)
{
// Security test
if (!CMSContext.CurrentUser.UserSiteManagerAdmin)
{
RedirectToAccessDenied(GetString("attach.actiondenied"));
}
// Add link to external stylesheet
CSSHelper.RegisterCSSLink(this, "Default", "/CMSDesk.css");
// Get current resolver
resolver = CMSContext.CurrentResolver.CreateContextChild();
DataSet ds = null;
DataSet cds = null;
// Check init settings
bool allWidgets = QueryHelper.GetBoolean("allWidgets", false);
bool allWebParts = QueryHelper.GetBoolean("allWebparts", false);
// Get webpart (widget) from querystring - only if no allwidget or allwebparts set
bool isWebpartInQuery = false;
bool isWidgetInQuery = false;
String webpartQueryParam = String.Empty;
//If not show all widgets or webparts - check if any widget or webpart is present
if ((!allWidgets) && (!allWebParts))
{
webpartQueryParam = QueryHelper.GetString("webpart", "");
if (!string.IsNullOrEmpty(webpartQueryParam))
{
isWebpartInQuery = true;
}
else
{
webpartQueryParam = QueryHelper.GetString("widget", "");
if (!string.IsNullOrEmpty(webpartQueryParam))
{
isWidgetInQuery = true;
}
}
}
// Set development option if is required
if (QueryHelper.GetString("details", "0") == "1")
{
development = true;
}
// Generate all webparts
if (allWebParts)
{
// Get all webpart categories
cds = WebPartCategoryInfoProvider.GetAllCategories();
}
// Generate all widgets
else if (allWidgets)
{
// Get all widget categories
cds = WidgetCategoryInfoProvider.GetWidgetCategories(String.Empty, String.Empty, 0, String.Empty);
}
// Generate single webpart
else if (isWebpartInQuery)
{
// Split weparts
string[] webparts = webpartQueryParam.Split(';');
if (webparts.Length > 0)
{
string webpartWhere = SqlHelperClass.GetWhereCondition("WebpartName", webparts);
ds = WebPartInfoProvider.GetWebParts(webpartWhere, null);
// If any webparts found
if (!DataHelper.DataSourceIsEmpty(ds))
{
StringBuilder categoryWhere = new StringBuilder("");
foreach (DataRow dr in ds.Tables[0].Rows)
{
categoryWhere.Append(ValidationHelper.GetString(dr["WebpartCategoryID"], "NULL") + ",");
}
string ctWhere = "CategoryID IN (" + categoryWhere.ToString().TrimEnd(',') + ")";
cds = WebPartCategoryInfoProvider.GetCategories(ctWhere, null);
}
}
}
// Generate single widget
else if (isWidgetInQuery)
{
string[] widgets = webpartQueryParam.Split(';');
if (widgets.Length > 0)
{
string widgetsWhere = SqlHelperClass.GetWhereCondition("WidgetName", widgets);
ds = WidgetInfoProvider.GetWidgets(widgetsWhere, null, 0, String.Empty);
}
if (!DataHelper.DataSourceIsEmpty(ds))
{
StringBuilder categoryWhere = new StringBuilder("");
foreach (DataRow dr in ds.Tables[0].Rows)
{
categoryWhere.Append(ValidationHelper.GetString(dr["WidgetCategoryID"], "NULL") + ",");
}
string ctWhere = "WidgetCategoryID IN (" + categoryWhere.ToString().TrimEnd(',') + ")";
cds = WidgetCategoryInfoProvider.GetWidgetCategories(ctWhere, null, 0, String.Empty);
}
}
if (allWidgets || isWidgetInQuery)
{
documentationTitle = "Kentico CMS Widgets";
Page.Header.Title = "Widgets documentation";
}
if (!allWebParts && !allWidgets && !isWebpartInQuery && !isWidgetInQuery)
{
pnlContent.Visible = false;
pnlInfo.Visible = true;
}
// Check whether at least one category is present
if (!DataHelper.DataSourceIsEmpty(cds))
{
string namePrefix = ((isWidgetInQuery) || (allWidgets)) ? "Widget" : String.Empty;
// Loop through all web part categories
foreach (DataRow cdr in cds.Tables[0].Rows)
{
// Get all webpart in the categories
if (allWebParts)
{
ds = WebPartInfoProvider.GetAllWebParts(Convert.ToInt32(cdr["CategoryId"]));
}
// Get all widgets in the category
else if (allWidgets)
{
int categoryID = Convert.ToInt32(cdr["WidgetCategoryId"]);
ds = WidgetInfoProvider.GetWidgets("WidgetCategoryID = " + categoryID.ToString(), null, 0, null);
}
// Check whether current category contains at least one webpart
if (!DataHelper.DataSourceIsEmpty(ds))
{
// Generate category name code
menu += "
" + HTMLHelper.HTMLEncode(cdr[namePrefix + "CategoryDisplayName"].ToString()) + "
";
// Loop through all web web parts in categories
foreach (DataRow dr in ds.Tables[0].Rows)
{
// Init
isImagePresent = false;
undocumentedProperties = 0;
documentation = 0;
// Webpart (Widget) information
string itemDisplayName = String.Empty;
string itemDescription = String.Empty;
string itemDocumentation = String.Empty;
string itemType = String.Empty;
int itemID = 0;
WebPartInfo wpi = null;
WidgetInfo wi = null;
// Set webpart info
if ((isWebpartInQuery) || (allWebParts))
{
wpi = new WebPartInfo(dr);
if (wpi != null)
{
itemDisplayName = wpi.WebPartDisplayName;
itemDescription = wpi.WebPartDescription;
itemDocumentation = wpi.WebPartDocumentation;
itemID = wpi.WebPartID;
itemType = PortalObjectType.WEBPART;
if (wpi.WebPartCategoryID != ValidationHelper.GetInteger(cdr["CategoryId"], 0))
{
wpi = null;
}
}
}
// Set widget info
else if ((isWidgetInQuery) || (allWidgets))
{
wi = new WidgetInfo(dr);
if (wi != null)
{
itemDisplayName = wi.WidgetDisplayName;
itemDescription = wi.WidgetDescription;
itemDocumentation = wi.WidgetDocumentation;
itemType = PortalObjectType.WIDGET;
itemID = wi.WidgetID;
if (wi.WidgetCategoryID != ValidationHelper.GetInteger(cdr["WidgetCategoryId"], 0))
{
wi = null;
}
}
}
// Check whether web part (widget) exists
if ((wpi != null) || (wi != null))
{
// Link GUID
Guid mguid = Guid.NewGuid();
// Whether description is present in webpart
bool isDescription = false;
// Image url
string wimgurl = GetItemImage(itemID, itemType);
// Set description text
string descriptionText = itemDescription;
// Parent webpart info
WebPartInfo pwpi = null;
// If webpart look for parent's description and documentation
if (wpi != null)
{
// Get parent description if webpart is inherited
if (wpi.WebPartParentID > 0)
{
pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null)
{
if ((descriptionText == null || descriptionText.Trim() == ""))
{
// Set description from parent
descriptionText = pwpi.WebPartDescription;
}
// Set documentation text from parent if WebPart is inherited
if ((wpi.WebPartDocumentation == null) || (wpi.WebPartDocumentation.Trim() == ""))
{
itemDocumentation = pwpi.WebPartDocumentation;
if (!String.IsNullOrEmpty(itemDocumentation))
{
documentation = 2;
}
}
}
}
}
// Set description as present
if (descriptionText.Trim().Length > 0)
{
isDescription = true;
}
// Generate HTML for menu and content
menu += " " + HTMLHelper.HTMLEncode(itemDisplayName) + " ";
// Generate webpart header
content += "";
// Generate WebPart content
content +=
@"
![]()
|
"
+ HTMLHelper.HTMLEncode(ResHelper.LocalizeString(descriptionText)) + @"
|
";
// Properties content
content += "";
// Generate content
if (wpi != null)
{
GenerateDocContent(CreateFormInfo(wpi));
}
else if (wi != null)
{
GenerateDocContent(CreateFormInfo(wi));
}
// Close content area
content += "
";
// Generate documentation text content
content += "
" +
DataHelper.GetNotEmpty(HTMLHelper.ResolveUrls(itemDocumentation, null), "Additional documentation text is not provided.") +
"
";
// Set page break tag for print
content += "
";
// If development is required - highlight missing description, images and doc. text
if (development)
{
// Check image
if (!isImagePresent)
{
menu += "image ";
}
// Check properties
if (undocumentedProperties > 0)
{
menu += "properties(" + undocumentedProperties + ") ";
}
// Check properties
if (!isDescription)
{
menu += "description ";
}
// Check documentation text
if (String.IsNullOrEmpty(itemDocumentation))
{
documentation = 1;
}
switch (documentation)
{
// Display information about missing documentation
case 1:
menu += "documentation ";
break;
// Display information about inherited documentation
case 2:
menu += "documentation (inherited) ";
break;
}
}
menu += "
";
}
}
}
}
}
ltlContent.Text = menu + "
" + content;
}
///
/// Generate form info for widget.
///
/// Widget info
private FormInfo CreateFormInfo(WidgetInfo wi)
{
WebPartInfo wpi = WebPartInfoProvider.GetWebPartInfo(wi.WidgetWebPartID);
if (wpi != null)
{
string widgetProperties = FormHelper.MergeFormDefinitions(wpi.WebPartProperties, wi.WidgetProperties);
return PortalFormHelper.GetWidgetFormInfo(wi.WidgetName, String.Empty, widgetProperties, null, false);
}
return null;
}
///
/// Generate form info for webpart.
///
/// Web part info
private FormInfo CreateFormInfo(WebPartInfo wpi)
{
if (wpi != null)
{
// Get parent webpart if webpart is inherited
if (wpi.WebPartParentID != 0)
{
WebPartInfo pwpi = WebPartInfoProvider.GetWebPartInfo(wpi.WebPartParentID);
if (pwpi != null)
{
wpi = pwpi;
}
}
}
return PortalFormHelper.GetWebPartFormInfo(wpi.WebPartName + FormHelper.CORE, wpi.WebPartProperties, null, null, false);
}
///
/// Generate document content.
///
/// WebPart info
/// Guid
/// Category
protected void GenerateDocContent(FormInfo fi)
{
if (fi == null)
{
return;
}
// Get defintion elements
var infos = fi.GetFormElements(true, false);
bool isOpenSubTable = false;
string currentGuid = "";
// Used for filter empty categories
String categoryHeader = String.Empty;
// Check all items in object array
foreach (object contrl in infos)
{
// Generate row for form category
if (contrl is FormCategoryInfo)
{
// Load castegory info
FormCategoryInfo fci = contrl as FormCategoryInfo;
if (fci != null)
{
// Close table from last category
if (isOpenSubTable)
{
content += "| | | |
";
isOpenSubTable = false;
}
if (currentGuid == "")
{
currentGuid = Guid.NewGuid().ToString().Replace("-", "_");
}
// Generate table for current category
categoryHeader = @"
| |
" + HTMLHelper.HTMLEncode(ResHelper.GetString(fci.CategoryName)) + @" |
|
";
}
}
else
{
// Get form field info
FormFieldInfo ffi = contrl as FormFieldInfo;
if (ffi != null)
{
if (categoryHeader != String.Empty)
{
content += categoryHeader;
categoryHeader = String.Empty;
}
if (!isOpenSubTable)
{
// Generate table for properties under one category
isOpenSubTable = true;
content += "" +
"";
currentGuid = "";
}
// Add ':' to caption
string doubleDot = "";
if (!ffi.Caption.EndsWithCSafe(":"))
{
doubleDot = ":";
}
content +=
@"
| |
" + HTMLHelper.HTMLEncode(ResHelper.LocalizeString(ffi.Caption)) + doubleDot + @" |
" + HTMLHelper.HTMLEncode(resolver.ResolveMacros(DataHelper.GetNotEmpty(ffi.Description, GetString("WebPartDocumentation.DescriptionNoneAvailable")))) + @" |
|
";
if (ffi.Description == null || ffi.Description.Trim() == "")
{
undocumentedProperties++;
}
}
}
}
// Close last category (if has any properties)
if (isOpenSubTable)
{
content += "| | | |
";
}
}
///
/// Returns url of item's (webpart,widget) image.
///
/// ID of webpart (widget)
/// Type of item (webpart,widget)
private string GetItemImage(int itemID, string itemType)
{
String wimgurl = String.Empty;
DataSet mds = MetaFileInfoProvider.GetMetaFiles(itemID, itemType);
// Check whether image exists
if (!DataHelper.DataSourceIsEmpty(mds))
{
// Ge tmetafile info object
MetaFileInfo mtfi = new MetaFileInfo(mds.Tables[0].Rows[0]);
if (mtfi != null)
{
// Image found - used in development mode
isImagePresent = true;
// Get image url
return ResolveUrl("~/CMSPages/GetMetaFile.aspx?fileguid=" + mtfi.MetaFileGUID.ToString());
}
}
return GetImageUrl("CMSModules/CMS_PortalEngine/WebpartProperties/imagenotavailable.png");
}
///
/// OnLoad override.
///
protected override void OnLoad(EventArgs e)
{
// Disable caching
Response.Cache.SetNoStore();
base.OnLoad(e);
}
#endregion
}