static public webParts FromXml(string path)
{
webParts returnValue = null;
var serializer = new XmlSerializer(typeof(webParts));
using (var stream = File.OpenRead(path))
{
returnValue = (webParts)serializer.Deserialize(stream);
}
return(returnValue);
}
public static void GetWebPartUsage(string webPartType, string webUrl, string outPutDirectory)
{
string exceptionCommentsInfo1 = string.Empty;
ClientContext clientContext = null;
bool headerWebPart = false;
Web web = null;
bool isfound = false;
string webPartUsageFileName = outPutDirectory + "\\" + Constants.WEBPART_USAGE_ENTITY_FILENAME + timeStamp + Constants.CSVExtension;
try
{
Logger.LogInfoMessage("[GetWebPartUsage] Finding WebPartUsage details for Web Part: " + webPartType + " in Web: " + webUrl);
using (ClientContext userContext = Helper.CreateAuthenticatedUserContext(Program.AdminDomain, Program.AdminUsername, Program.AdminPassword, webUrl))
{
web = userContext.Web;
userContext.Load(web);
userContext.ExecuteQuery();
clientContext = userContext;
WebPartUsageEntity webPartUsageEntity = null;
List <WebPartUsageEntity> webPartUsage = new List <WebPartUsageEntity>();
//Prepare Exception Comments
exceptionCommentsInfo1 = "Web Url: " + clientContext.Web.Url + ", Web Part Type: " + webPartType;
if (clientContext != null)
{
List list = AddWebPart.GetPageList(ref clientContext);
if (list != null)
{
var items = list.GetItems(CamlQuery.CreateAllItemsQuery());
//make sure to include the File on each Item fetched
clientContext.Load(items,
i => i.Include(
item => item.File,
item => item["EncodedAbsUrl"]));
clientContext.ExecuteQuery();
// Iterate through all available pages in the pages list
foreach (var item in items)
{
try
{
Microsoft.SharePoint.Client.File page = item.File;
String pageUrl = page.ServerRelativeUrl;// item.FieldValues["EncodedAbsUrl"].ToString();
Logger.LogInfoMessage("[GetWebPartUsage] Checking for the Web Part on the Page: " + page.Name);
// Requires Full Control permissions on the Web
LimitedWebPartManager webPartManager = page.GetLimitedWebPartManager(PersonalizationScope.Shared);
clientContext.Load(webPartManager,
wpm => wpm.WebParts,
wpm => wpm.WebParts.Include(
wp => wp.WebPart.Hidden,
wp => wp.WebPart.IsClosed,
wp => wp.WebPart.Properties,
wp => wp.WebPart.Subtitle,
wp => wp.WebPart.Title,
wp => wp.WebPart.TitleUrl,
wp => wp.WebPart.ZoneIndex));
clientContext.ExecuteQuery();
foreach (WebPartDefinition webPartDefinition in webPartManager.WebParts)
{
Microsoft.SharePoint.Client.WebParts.WebPart webPart = webPartDefinition.WebPart;
string webPartPropertiesXml = GetWebPartPropertiesServiceCall(clientContext, webPartDefinition.Id.ToString(), pageUrl);
string WebPartTypeName = string.Empty;
if (webPartPropertiesXml.Contains("WebPart/v2"))
{
XmlDataDocument xmldoc = new XmlDataDocument();
xmldoc.LoadXml(webPartPropertiesXml);
WebPartTypeName = xmldoc.DocumentElement.GetElementsByTagName("TypeName").Item(0).FirstChild.Value;
xmldoc = null;
}
else
{
webParts webPartProp = null;
byte[] byteArray = Encoding.UTF8.GetBytes(webPartPropertiesXml);
using (MemoryStream stream = new MemoryStream(byteArray))
{
StreamReader streamReader = new StreamReader(stream);
System.Xml.XmlReader reader = new XmlTextReader(streamReader);
XmlSerializer serializer = new XmlSerializer(typeof(webParts));
webPartProp = (webParts)serializer.Deserialize(reader);
WebPartTypeName = webPartProp.webPart.metaData.type.name;
stream.Flush();
}
byteArray = null;
}
string actualWebPartType = AddWebPart.GetWebPartShortTypeName(WebPartTypeName);
// only modify if we find the old web part
if (actualWebPartType.Equals(webPartType, StringComparison.CurrentCultureIgnoreCase))
{
Logger.LogInfoMessage("[GetWebPartUsage] Found WebPart: " + webPartType + " in Page: " + page.Name);
webPartUsageEntity = new WebPartUsageEntity();
webPartUsageEntity.PageUrl = pageUrl;
webPartUsageEntity.WebPartID = webPartDefinition.Id.ToString();
webPartUsageEntity.WebURL = webUrl;
webPartUsageEntity.WebPartTitle = webPart.Title;
webPartUsageEntity.ZoneIndex = webPart.ZoneIndex.ToString();
webPartUsageEntity.WebPartType = actualWebPartType;
FileUtility.WriteCsVintoFile(webPartUsageFileName, webPartUsageEntity, ref headerWebPart);
isfound = true;
}
}
}
catch (Exception ex)
{
ExceptionCsv.WriteException(Constants.NotApplicable, Constants.NotApplicable, webUrl, "WebPartUsage", ex.Message, ex.ToString(), "GetWebPartUsage()", ex.GetType().ToString(), exceptionCommentsInfo1);
Logger.LogErrorMessage("[GetWebPartUsage] Exception Message: " + ex.Message + ", Exception Comment: " + exceptionCommentsInfo1);
System.Console.ForegroundColor = System.ConsoleColor.Red;
Logger.LogErrorMessage("[GetWebPartUsage] Exception Message: " + ex.Message);
System.Console.ResetColor();
}
}
}
}
//Default Pages
GetWebPartUsage_DefaultPages(webPartType, clientContext, outPutDirectory);
//Default Pages
if (isfound)
{
Logger.LogSuccessMessage("[GetWebPartUsage] WebPart Usage is exported to the file " + webPartUsageFileName, true);
}
}
}
catch (Exception ex)
{
ExceptionCsv.WriteException(Constants.NotApplicable, Constants.NotApplicable, webUrl, "WebPartUsage", ex.Message, ex.ToString(), "GetWebPartUsage()", ex.GetType().ToString(), exceptionCommentsInfo1);
Logger.LogErrorMessage("[GetWebPartUsage] Exception Message: " + ex.Message + ", Exception Comment: " + exceptionCommentsInfo1);
System.Console.ForegroundColor = System.ConsoleColor.Red;
Logger.LogErrorMessage("[GetWebPartUsage] Exception Message: " + ex.Message);
System.Console.ResetColor();
}
}
public static void GetWebPartUsage_DefaultPages(string webPartType, ClientContext clientContext, string outPutDirectory)
{
ExceptionCsv.WebUrl = clientContext.Web.Url;
string exceptionCommentsInfo1 = string.Empty;
string webPartUsageFileName = outPutDirectory + "\\" + Constants.WEBPART_USAGE_ENTITY_FILENAME + timeStamp + Constants.CSVExtension;
bool headerWebPart = false;
bool isfound = false;
try
{
string webUrl = clientContext.Web.Url;
Logger.LogInfoMessage("[START][GetWebPartUsage_DefaultPages]");
Logger.LogInfoMessage("[GetWebPartUsage_DefaultPages] Finding WebPartUsage details for Web Part: " + webPartType + " in Web: " + webUrl);
WebPartUsageEntity webPartUsageEntity = null;
List <WebPartUsageEntity> webPartUsage = new List <WebPartUsageEntity>();
if (clientContext != null)
{
clientContext.Load(clientContext.Web.RootFolder.Files);
clientContext.ExecuteQuery();
foreach (Microsoft.SharePoint.Client.File page in clientContext.Web.RootFolder.Files)
{
exceptionCommentsInfo1 = "Web Url: " + clientContext.Web.Url + ", Web Part Type: " + webPartType + ", PageTitle: " + page.ServerRelativeUrl;
try
{
if (Path.GetExtension(page.ServerRelativeUrl).Equals(".aspx", StringComparison.CurrentCultureIgnoreCase))
{
String pageUrl = page.ServerRelativeUrl;
Logger.LogInfoMessage("[GetWebPartUsage_DefaultPages] Checking for the Web Part on the Page: " + page.Name);
// Requires Full Control permissions on the Web
LimitedWebPartManager webPartManager = page.GetLimitedWebPartManager(PersonalizationScope.Shared);
clientContext.Load(webPartManager,
wpm => wpm.WebParts,
wpm => wpm.WebParts.Include(
wp => wp.WebPart.Hidden,
wp => wp.WebPart.IsClosed,
wp => wp.WebPart.Properties,
wp => wp.WebPart.Subtitle,
wp => wp.WebPart.Title,
wp => wp.WebPart.TitleUrl,
wp => wp.WebPart.ZoneIndex));
clientContext.ExecuteQuery();
foreach (WebPartDefinition webPartDefinition in webPartManager.WebParts)
{
Microsoft.SharePoint.Client.WebParts.WebPart webPart = webPartDefinition.WebPart;
string webPartPropertiesXml = GetWebPartPropertiesServiceCall(clientContext, webPartDefinition.Id.ToString(), pageUrl);
string WebPartTypeName = string.Empty;
if (webPartPropertiesXml.Contains("WebPart/v2"))
{
XmlDataDocument xmldoc = new XmlDataDocument();
xmldoc.LoadXml(webPartPropertiesXml);
WebPartTypeName = xmldoc.DocumentElement.GetElementsByTagName("TypeName").Item(0).FirstChild.Value;
xmldoc = null;
}
else
{
webParts webPartProp = null;
byte[] byteArray = Encoding.UTF8.GetBytes(webPartPropertiesXml);
using (MemoryStream stream = new MemoryStream(byteArray))
{
StreamReader streamReader = new StreamReader(stream);
System.Xml.XmlReader reader = new XmlTextReader(streamReader);
XmlSerializer serializer = new XmlSerializer(typeof(webParts));
webPartProp = (webParts)serializer.Deserialize(reader);
WebPartTypeName = webPartProp.webPart.metaData.type.name;
stream.Flush();
}
byteArray = null;
}
string actualWebPartType = AddWebPart.GetWebPartShortTypeName(WebPartTypeName);
// only modify if we find the old web part
if (actualWebPartType.Equals(webPartType, StringComparison.CurrentCultureIgnoreCase))
{
Logger.LogInfoMessage("[GetWebPartUsage_DefaultPages] Found WebPart: " + webPartType + " in Page: " + page.Name + ", " + page.ServerRelativeUrl);
webPartUsageEntity = new WebPartUsageEntity();
webPartUsageEntity.PageUrl = pageUrl;
webPartUsageEntity.WebPartID = webPartDefinition.Id.ToString();
webPartUsageEntity.WebURL = webUrl;
webPartUsageEntity.WebPartTitle = webPart.Title;
webPartUsageEntity.ZoneIndex = webPart.ZoneIndex.ToString();
webPartUsageEntity.WebPartType = actualWebPartType;
FileUtility.WriteCsVintoFile(webPartUsageFileName, webPartUsageEntity, ref headerWebPart);
isfound = true;
}
}
}
}
catch (Exception ex)
{
ExceptionCsv.WriteException(Constants.NotApplicable, Constants.NotApplicable, webUrl, "WebPartUsage", ex.Message, ex.ToString(), "GetWebPartUsage_DefaultPages()", ex.GetType().ToString(), exceptionCommentsInfo1);
Logger.LogErrorMessage("[GetWebPartUsage_DefaultPages] Exception Message: " + ex.Message + ", Exception Comment: " + exceptionCommentsInfo1);
System.Console.ForegroundColor = System.ConsoleColor.Red;
Logger.LogErrorMessage("[GetWebPartUsage_DefaultPages] Exception Message: " + ex.Message);
System.Console.ResetColor();
}
}
}
if (isfound)
{
Logger.LogInfoMessage("[GetWebPartUsage_DefaultPages] Default Pages WebPart Usage is exported to the file " + webPartUsageFileName);
}
Logger.LogInfoMessage("[END][GetWebPartUsage_DefaultPages]");
}
catch (Exception ex)
{
System.Console.ForegroundColor = System.ConsoleColor.Red;
Logger.LogErrorMessage("[GetWebPartUsage_DefaultPages] Exception Message: " + ex.Message);
System.Console.ResetColor();
ExceptionCsv.WriteException(Constants.NotApplicable, Constants.NotApplicable, ExceptionCsv.WebUrl, "WebPartUsage", ex.Message, ex.ToString(), "GetWebPartUsage_DefaultPages()", ex.GetType().ToString(), exceptionCommentsInfo1);
}
}
private static bool CheckWebPartOrAppPartPresenceInSite(ClientContext clientContext, string targetWebPartXmlFileName, string targetWebPartXmlFilePath)
{
bool isWebPartInSite = false;
webParts targetWebPart = null;
string webPartPropertiesXml = string.Empty;
string webPartType = string.Empty;
clientContext.Load(clientContext.Web);
clientContext.ExecuteQuery();
ExceptionCsv.WebUrl = clientContext.Web.Url;
string exceptionCommentsInfo1 = string.Empty;
try
{
//Prepare Exception Comments
exceptionCommentsInfo1 = "Web Url: " + clientContext.Web.Url + ", Target Web Part File Name: " + targetWebPartXmlFileName + " , Target WebPart Xml File Path: " + targetWebPartXmlFilePath;
using (System.IO.FileStream fs = new System.IO.FileStream(targetWebPartXmlFilePath, System.IO.FileMode.Open, System.IO.FileAccess.Read))
{
System.IO.StreamReader reader = new System.IO.StreamReader(fs);
webPartPropertiesXml = reader.ReadToEnd();
}
Logger.LogInfoMessage("[CheckWebPartOrAppPartPresenceInSite] Checking for web part schema version");
if (webPartPropertiesXml.Contains("WebPart/v2"))
{
Logger.LogInfoMessage("[CheckWebPartOrAppPartPresenceInSite] Web part schema version is V2");
XmlDataDocument xmldoc = new XmlDataDocument();
xmldoc.LoadXml(webPartPropertiesXml);
webPartType = GetWebPartShortTypeName(xmldoc.DocumentElement.GetElementsByTagName("TypeName").Item(0).FirstChild.Value);
Logger.LogInfoMessage("[CheckWebPartOrAppPartPresenceInSite] Web part Type: " + webPartType);
xmldoc = null;
}
else
{
Logger.LogInfoMessage("[CheckWebPartOrAppPartPresenceInSite] Web part schema version is V3");
using (System.IO.FileStream fs = new System.IO.FileStream(targetWebPartXmlFilePath, System.IO.FileMode.Open, System.IO.FileAccess.Read))
{
XmlReader reader = new XmlTextReader(fs);
XmlSerializer serializer = new XmlSerializer(typeof(webParts));
targetWebPart = (webParts)serializer.Deserialize(reader);
if (targetWebPart != null)
{
webPartType = GetWebPartShortTypeName(targetWebPart.webPart.metaData.type.name);
Logger.LogInfoMessage("[CheckWebPartOrAppPartPresenceInSite] Web part Type: " + webPartType);
}
}
}
if (webPartType.Equals("ClientWebPart", StringComparison.CurrentCultureIgnoreCase))
{
foreach (var item in targetWebPart.webPart.data.properties)
{
if (item.name.Equals("FeatureId", StringComparison.CurrentCultureIgnoreCase))
{
Guid featureID = new Guid(item.Value);
isWebPartInSite = IsFeatureOnWeb(featureID, clientContext);
break;
}
}
}
else
{
Web web = clientContext.Site.RootWeb;
clientContext.Load(web, w => w.Url);
clientContext.ExecuteQuery();
//List list = web.Lists.GetByTitle("Web Part Gallery");
//WebPartCatalog, Web Part gallery. Value = 113.
List list = null;
IEnumerable <List> libraries = clientContext.LoadQuery(web.Lists.Where(l => l.BaseTemplate == 113));
clientContext.ExecuteQuery();
if (libraries.Any() && libraries.Count() > 0)
{
list = libraries.First();
}
clientContext.Load(list);
clientContext.ExecuteQueryRetry();
CamlQuery camlQuery = CamlQuery.CreateAllItemsQuery(1000);
Microsoft.SharePoint.Client.ListItemCollection items = list.GetItems(camlQuery);
clientContext.Load(items);
clientContext.ExecuteQuery();
foreach (ListItem item in items)
{
if (item["FileLeafRef"].ToString().Equals(targetWebPartXmlFileName, StringComparison.CurrentCultureIgnoreCase))
{
isWebPartInSite = true;
break;
}
}
}
}
catch (Exception ex)
{
System.Console.ForegroundColor = System.ConsoleColor.Red;
Logger.LogErrorMessage("[CheckWebPartOrAppPartPresenceInSite] Exception Message: " + ex.Message + ", Exception Comment: " + exceptionCommentsInfo1);
System.Console.ResetColor();
ExceptionCsv.WriteException(Constants.NotApplicable, Constants.NotApplicable, ExceptionCsv.WebUrl, "AddWebPart", ex.Message, ex.ToString(), "CheckWebPartOrAppPartPresenceInSite()", ex.GetType().ToString(), exceptionCommentsInfo1);
return(isWebPartInSite);
}
return(isWebPartInSite);
}
