public override void ExecuteCmdlet()
{
base.ExecuteCmdlet();
var models = new List <SPGroupDefinitionModel>();
try
{
var qroups = this.ClientContext.Web.SiteGroups;
this.ClientContext.Load(qroups);
var groupName = qroups.GetByName(this.GroupName);
this.ClientContext.Load(groupName, gg => gg.LoginName, gg => gg.Title, gg => gg.Users);
this.ClientContext.ExecuteQuery();
var model = new SPGroupDefinitionModel()
{
Title = groupName.LoginName,
Description = groupName.Title
};
LogVerbose("Group {0} found in Site {1}", groupName.Title, this.ClientContext.Web.Url);
if (GroupMembership)
{
foreach (var user in groupName.Users)
{
var userModel = new SPUserDefinitionModel()
{
UserName = user.LoginName,
UserEmail = user.Email,
GuidId = user.Id,
PrincipalType = user.PrincipalType,
UserDisplay = user.Title,
UserId = user.UserId
};
model.Users.Add(userModel);
LogVerbose("LoginName {0}", user.LoginName);
}
}
models.Add(model);
models.ForEach(group => WriteObject(group));
}
catch (Exception ex)
{
LogError(ex, "Failed to execute QueryUserProfile in tenant {0}", this.ClientContext.Url);
}
}
/// <summary>
/// Will scan the web site groups for groups to provision and retrieve
/// </summary>
/// <param name="hostWeb">The host web to which the groups will be created</param>
/// <param name="groupDef">The collection of groups to retrieve and/or provision</param>
/// <returns></returns>
public static Microsoft.SharePoint.Client.Group GetOrCreateSiteGroups(this Web hostWeb, SPGroupDefinitionModel groupDef)
{
hostWeb.EnsureProperties(hw => hw.CurrentUser);
var context = hostWeb.Context;
// Create Group
var groupCreationInfo = new GroupCreationInformation
{
Title = groupDef.Title,
Description = groupDef.Description
};
var oGroup = hostWeb.SiteGroups.Add(groupCreationInfo);
context.Load(oGroup);
oGroup.Owner = hostWeb.CurrentUser;
oGroup.OnlyAllowMembersViewMembership = groupDef.OnlyAllowMembersViewMembership;
oGroup.AllowMembersEditMembership = groupDef.AllowMembersEditMembership;
oGroup.AllowRequestToJoinLeave = groupDef.AllowRequestToJoinLeave;
oGroup.AutoAcceptRequestToJoinLeave = groupDef.AutoAcceptRequestToJoinLeave;
oGroup.Update();
context.Load(oGroup, g => g.Id, g => g.Title);
context.ExecuteQueryRetry();
return(oGroup);
}
/// <summary>
/// Process the request
/// </summary>
public override void ExecuteCmdlet()
{
base.ExecuteCmdlet();
// File Info
var fileInfo = new System.IO.FileInfo(this.ProvisionerFilePath);
// Initialize logging instance with Powershell logger
ITraceLogger logger = new DefaultUsageLogger(LogVerbose, LogWarning, LogError);
// Skip these specific fields
var skiptypes = new FieldType[]
{
FieldType.Computed,
FieldType.ContentTypeId,
FieldType.Invalid,
FieldType.WorkflowStatus,
FieldType.WorkflowEventType,
FieldType.Threading,
FieldType.ThreadIndex,
FieldType.Recurrence,
FieldType.PageSeparator,
FieldType.OutcomeChoice,
FieldType.CrossProjectLink,
FieldType.ModStat,
FieldType.Error,
FieldType.MaxItems,
FieldType.Attachments
};
var skipcolumns = new string[]
{
"_Hidden",
"Base Columns",
"Content Feedback",
"Core Contact and Calendar Columns",
"Core Document Columns",
"Core Task and Issue Columns",
"Display Template Columns",
"Document and Record Management Columns",
"Enterprise Keywords Group",
"Extended Columns",
"JavaScript Display Template Columns",
"Page Layout Columns",
"Publishing Columns",
"Reports",
"Status Indicators",
"Translation Columns"
};
var skipcontenttypes = new string[]
{
"_Hidden",
"Business Intelligence",
"Community Content Types",
"Digital Asset Content Types",
"Display Template Content Types",
"Document Content Types",
"Document Set Content Types",
"Folder Content Types",
"Content Feedback",
"Publishing Content Types",
"Page Layout Content Types",
"Special Content Types",
"Group Work Content Types",
"List Content Types"
};
// Construct the model
var SiteComponents = new SiteProvisionerModel();
// Load the Context
var contextWeb = this.ClientContext.Web;
this.ClientContext.Load(contextWeb, ctxw => ctxw.ServerRelativeUrl, ctxw => ctxw.Id);
// Get Site/Web fields
var fields = this.ClientContext.LoadQuery(contextWeb.Fields
.Include(
fctx => fctx.Id,
fctx => fctx.FieldTypeKind,
fctx => fctx.Group,
lft => lft.AutoIndexed,
lft => lft.CanBeDeleted,
lft => lft.DefaultFormula,
lft => lft.DefaultValue,
lft => lft.Description,
lft => lft.EnforceUniqueValues,
lft => lft.Filterable,
lft => lft.FromBaseType,
lft => lft.Hidden,
lft => lft.Indexed,
lft => lft.InternalName,
lft => lft.JSLink,
lft => lft.NoCrawl,
lft => lft.ReadOnlyField,
lft => lft.Required,
lft => lft.SchemaXml,
lft => lft.Scope,
lft => lft.Title));
var groupQuery = this.ClientContext.LoadQuery(contextWeb.SiteGroups
.Include(group => group.Id,
group => group.Title,
group => group.Description,
group => group.AllowRequestToJoinLeave,
group => group.AllowMembersEditMembership,
group => group.AutoAcceptRequestToJoinLeave,
group => group.OnlyAllowMembersViewMembership,
group => group.RequestToJoinLeaveEmailSetting));
var contentTypes = this.ClientContext.LoadQuery(contextWeb.ContentTypes
.Include(
ict => ict.Id,
ict => ict.Group,
ict => ict.Description,
ict => ict.Name,
ict => ict.Hidden,
ict => ict.JSLink,
ict => ict.FieldLinks,
ict => ict.Fields));
var lists = this.ClientContext.LoadQuery(contextWeb.Lists
.Include(
linc => linc.Title,
linc => linc.Id,
linc => linc.Description,
linc => linc.RootFolder.ServerRelativeUrl,
linc => linc.Hidden,
linc => linc.OnQuickLaunch,
linc => linc.BaseTemplate,
linc => linc.ContentTypesEnabled,
linc => linc.AllowContentTypes,
linc => linc.EnableFolderCreation,
linc => linc.IsApplicationList,
linc => linc.IsCatalog,
linc => linc.IsSiteAssetsLibrary,
linc => linc.IsPrivate,
linc => linc.IsSystemList,
lctx => lctx.SchemaXml).Where(w => !w.IsSystemList && !w.IsSiteAssetsLibrary));
this.ClientContext.ExecuteQueryRetry();
var weburl = TokenHelper.EnsureTrailingSlash(contextWeb.ServerRelativeUrl);
if (groupQuery.Any())
{
SiteComponents.Groups = new List <SPGroupDefinitionModel>();
foreach (var group in groupQuery)
{
var model = new SPGroupDefinitionModel()
{
Id = group.Id,
Title = group.Title,
Description = group.Description,
AllowRequestToJoinLeave = group.AllowRequestToJoinLeave,
AllowMembersEditMembership = group.AllowMembersEditMembership,
AutoAcceptRequestToJoinLeave = group.AutoAcceptRequestToJoinLeave,
OnlyAllowMembersViewMembership = group.OnlyAllowMembersViewMembership,
RequestToJoinLeaveEmailSetting = group.RequestToJoinLeaveEmailSetting
};
SiteComponents.Groups.Add(model);
}
}
if (fields.Any())
{
var webfields = new List <SPFieldDefinitionModel>();
foreach (var field in fields)
{
if (skiptypes.Any(st => field.FieldTypeKind == st) ||
skipcolumns.Any(sg => field.Group.Equals(sg, StringComparison.CurrentCultureIgnoreCase)))
{
continue;
}
try
{
var fieldModel = ClientContext.RetrieveField(field, logger, groupQuery);
webfields.Add(fieldModel);
}
catch (Exception ex)
{
System.Diagnostics.Trace.TraceError("Failed to parse field {0} MSG:{1}", field.InternalName, ex.Message);
}
}
SiteComponents.FieldDefinitions = webfields;
}
var contentTypesFieldset = new List <dynamic>();
if (contentTypes.Any())
{
SiteComponents.ContentTypes = new List <SPContentTypeDefinition>();
foreach (ContentType contenttype in contentTypes)
{
// skip core content types
if (skipcontenttypes.Any(sg => contenttype.Group.Equals(sg, StringComparison.CurrentCultureIgnoreCase)))
{
continue;
}
contenttype.EnsureProperties(ctp => ctp.Id, ctp => ctp.Group, ctp => ctp.Hidden, ctp => ctp.Description, ctp => ctp.Name, ctp => ctp.FieldLinks);
var ctypemodel = new SPContentTypeDefinition()
{
ContentTypeId = contenttype.Id.StringValue,
ContentTypeGroup = contenttype.Group,
Hidden = contenttype.Hidden,
Description = contenttype.Description,
Name = contenttype.Name
};
if (contenttype.FieldLinks.Any())
{
ctypemodel.FieldLinks = new List <SPFieldLinkDefinitionModel>();
foreach (FieldLink fieldlink in contenttype.FieldLinks)
{
ctypemodel.FieldLinks.Add(new SPFieldLinkDefinitionModel()
{
Id = fieldlink.Id,
Name = fieldlink.Name,
Required = fieldlink.Required,
Hidden = fieldlink.Hidden
});
contentTypesFieldset.Add(new { ctypeid = contenttype.Id.StringValue, name = fieldlink.Name });
}
}
SiteComponents.ContentTypes.Add(ctypemodel);
}
}
if (lists.Any())
{
var sitelists = new List <SPListDefinition>();
foreach (List list in lists.Where(lwt =>
(!_filterLists ||
(_filterLists && SpecificLists.Any(sl => lwt.Title.Equals(sl, StringComparison.InvariantCultureIgnoreCase))))))
{
var listdefinition = ClientContext.GetListDefinition(contextWeb, list, true, logger, skiptypes, groupQuery);
sitelists.Add(listdefinition);
}
if (sitelists.Any())
{
var idx = 0;
SiteComponents.Lists = new List <SPListDefinition>();
// lets add any list with NO lookups first
var nolookups = sitelists.Where(sl => !sl.ListDependency.Any());
nolookups.ToList().ForEach(nolookup =>
{
logger.LogInformation("adding list {0}", nolookup.ListName);
nolookup.ProvisionOrder = idx++;
SiteComponents.Lists.Add(nolookup);
sitelists.Remove(nolookup);
});
// order with first in stack
var haslookups = sitelists.Where(sl => sl.ListDependency.Any()).OrderBy(ob => ob.ListDependency.Count()).ToList();
while (haslookups.Count() > 0)
{
var listPopped = haslookups.FirstOrDefault();
haslookups.Remove(listPopped);
logger.LogInformation("adding list {0}", listPopped.ListName);
if (listPopped.ListDependency.Any(listField => listPopped.ListName.Equals(listField, StringComparison.InvariantCultureIgnoreCase) ||
listPopped.InternalName.Equals(listField, StringComparison.InvariantCultureIgnoreCase)))
{
// the list has a dependency on itself
logger.LogInformation("Adding list {0} with dependency on itself", listPopped.ListName);
listPopped.ProvisionOrder = idx++;
SiteComponents.Lists.Add(listPopped);
}
else if (listPopped.ListDependency.Any(listField =>
!SiteComponents.Lists.Any(sc => sc.ListName.Equals(listField, StringComparison.InvariantCultureIgnoreCase) ||
sc.InternalName.Equals(listField, StringComparison.InvariantCultureIgnoreCase))))
{
// no list definition exists in the collection with the dependent lookup lists
logger.LogWarning("List {0} depends on {1} which do not exist current collection", listPopped.ListName, string.Join(",", listPopped.ListDependency));
foreach (var dependent in listPopped.ListDependency.Where(dlist => !haslookups.Any(hl => hl.ListName == dlist)))
{
var sitelist = contextWeb.GetListByTitle(dependent, lctx => lctx.Id, lctx => lctx.Title, lctx => lctx.RootFolder.ServerRelativeUrl);
var listDefinition = ClientContext.GetListDefinition(contextWeb, sitelist, true, logger, skiptypes, groupQuery);
haslookups.Add(listDefinition);
}
haslookups.Add(listPopped); // add back to collection
listPopped = null;
}
else
{
logger.LogInformation("Adding list {0} to collection", listPopped.ListName);
listPopped.ProvisionOrder = idx++;
SiteComponents.Lists.Add(listPopped);
}
}
}
}
// Write the JSON to disc
var jsonsettings = new JsonSerializerSettings()
{
Formatting = Formatting.Indented,
Culture = System.Globalization.CultureInfo.CurrentUICulture,
DateFormatHandling = DateFormatHandling.IsoDateFormat,
NullValueHandling = NullValueHandling.Ignore
};
var json = JsonConvert.SerializeObject(SiteComponents, jsonsettings);
System.IO.File.WriteAllText(fileInfo.FullName, json);
}
