public static Boolean IsValidSharePointProvisioningTemplate(this SharePointProvisioningTemplate template)
{
if (template == null)
{
throw new ArgumentNullException("template");
}
// Serialize the template into an XML string
String xml = XMLSerializer.Serialize <SharePointProvisioningTemplate>(template);
XDocument doc = XDocument.Parse(xml);
return(doc.IsValidSharePointProvisioningTemplate());
}
public static ProvisioningTemplate ToProvisioningTemplate(this SharePointProvisioningTemplate template)
{
if (template == null)
{
throw new ArgumentNullException("template");
}
// Check the provided template against the XML schema
if (!template.IsValidSharePointProvisioningTemplate())
{
// TODO: Use resource file
throw new ApplicationException("The provided template is not valid!");
}
ProvisioningTemplate result = new ProvisioningTemplate();
// Translate basic properties
result.ID = template.ID;
result.Version = Double.Parse(!String.IsNullOrEmpty(template.Version) ? template.Version : "0", new CultureInfo("en-US"));
result.SitePolicy = template.SitePolicy;
// Translate PropertyBagEntries, if any
if (template.PropertyBagEntries != null)
{
result.PropertyBagEntries.AddRange(
from bag in template.PropertyBagEntries
select new Model.PropertyBagEntry
{
Key = bag.Key,
Value = bag.Value,
});
}
// Translate Security configuration, if any
if (template.Security != null)
{
if (template.Security.AdditionalAdministrators != null)
{
result.Security.AdditionalAdministrators.AddRange(
from user in template.Security.AdditionalAdministrators
select new Model.User
{
Name = user.Name,
});
}
if (template.Security.AdditionalOwners != null)
{
result.Security.AdditionalOwners.AddRange(
from user in template.Security.AdditionalOwners
select new Model.User
{
Name = user.Name,
});
}
if (template.Security.AdditionalMembers != null)
{
result.Security.AdditionalMembers.AddRange(
from user in template.Security.AdditionalMembers
select new Model.User
{
Name = user.Name,
});
}
if (template.Security.AdditionalVisitors != null)
{
result.Security.AdditionalVisitors.AddRange(
from user in template.Security.AdditionalVisitors
select new Model.User
{
Name = user.Name,
});
}
}
// Translate Site Columns (Fields), if any
if ((template.SiteFields != null) && (template.SiteFields.Any != null))
{
result.SiteFields.AddRange(
from field in template.SiteFields.Any
select new Field
{
SchemaXml = field.OuterXml,
});
}
// Translate ContentTypes, if any
if ((template.ContentTypes != null) && (template.ContentTypes.Any != null))
{
result.ContentTypes.AddRange(
from contentType in template.ContentTypes.Any
select new ContentType
{
SchemaXml = contentType.OuterXml,
});
}
// Translate Lists Instances, if any
if (template.Lists != null)
{
result.Lists.AddRange(
from list in template.Lists
select new Model.ListInstance(
(list.ContentTypeBindings != null ?
(from contentTypeBinding in list.ContentTypeBindings
select new Model.ContentTypeBinding
{
ContentTypeID = contentTypeBinding.ContentTypeID,
Default = contentTypeBinding.Default,
}) : null),
(list.Views != null ?
(from view in list.Views.Any
select new View
{
SchemaXml = view.OuterXml,
}) : null),
(list.Fields != null ?
(from field in list.Fields.Any
select new Field
{
SchemaXml = field.OuterXml,
}) : null),
(list.FieldRefs != null ?
(from fieldRef in list.FieldRefs
select new Model.FieldRef
{
ID = Guid.Parse(fieldRef.ID)
}) : null)
)
{
ContentTypesEnabled = list.ContentTypesEnabled,
Description = list.Description,
DocumentTemplate = list.DocumentTemplate,
EnableVersioning = list.EnableVersioning,
Hidden = list.Hidden,
MinorVersionLimit = list.MinorVersionLimit,
MaxVersionLimit = list.MaxVersionLimit,
OnQuickLaunch = list.OnQuickLaunch,
RemoveDefaultContentType = list.RemoveDefaultContentType,
TemplateType = list.TemplateType,
Title = list.Title,
Url = list.Url,
});
}
// Translate Features, if any
if (template.Features != null)
{
if (result.Features.SiteFeatures != null && template.Features.SiteFeatures != null)
{
result.Features.SiteFeatures.AddRange(
from feature in template.Features.SiteFeatures
select new Model.Feature
{
ID = new Guid(feature.ID),
Deactivate = feature.Deactivate,
});
}
if (result.Features.WebFeatures != null && template.Features.WebFeatures != null)
{
result.Features.WebFeatures.AddRange(
from feature in template.Features.WebFeatures
select new Model.Feature
{
ID = new Guid(feature.ID),
Deactivate = feature.Deactivate,
});
}
}
// Translate CustomActions, if any
if (template.CustomActions != null)
{
if (result.CustomActions.SiteCustomActions != null && template.CustomActions.SiteCustomActions != null)
{
result.CustomActions.SiteCustomActions.AddRange(
from customAction in template.CustomActions.SiteCustomActions
select new Model.CustomAction
{
Description = customAction.Description,
Enabled = customAction.Enabled,
Group = customAction.Group,
ImageUrl = customAction.ImageUrl,
Location = customAction.Location,
Name = customAction.Name,
RightsValue = customAction.RightsSpecified ? customAction.Rights : 0,
ScriptBlock = customAction.ScriptBlock,
ScriptSrc = customAction.ScriptSrc,
Sequence = customAction.SequenceSpecified ? customAction.Sequence : 100,
Title = customAction.Title,
Url = customAction.Url,
});
}
if (result.CustomActions.WebCustomActions != null && template.CustomActions.WebCustomActions != null)
{
result.CustomActions.WebCustomActions.AddRange(
from customAction in template.CustomActions.WebCustomActions
select new Model.CustomAction
{
Description = customAction.Description,
Enabled = customAction.Enabled,
Group = customAction.Group,
ImageUrl = customAction.ImageUrl,
Location = customAction.Location,
Name = customAction.Name,
RightsValue = customAction.RightsSpecified ? customAction.Rights : 0,
ScriptBlock = customAction.ScriptBlock,
ScriptSrc = customAction.ScriptSrc,
Sequence = customAction.SequenceSpecified ? customAction.Sequence : 100,
Title = customAction.Title,
Url = customAction.Url,
});
}
}
// Translate Files, if any
if (template.Files != null)
{
result.Files.AddRange(
from file in template.Files
select new Model.File
{
Overwrite = file.Overwrite,
Src = file.Src,
Folder = file.Folder,
});
}
// Translate ComposedLook, if any
if (template.ComposedLook != null)
{
result.ComposedLook.AlternateCSS = template.ComposedLook.AlternateCSS;
result.ComposedLook.BackgroundFile = template.ComposedLook.BackgroundFile;
result.ComposedLook.ColorFile = template.ComposedLook.ColorFile;
result.ComposedLook.FontFile = template.ComposedLook.FontFile;
result.ComposedLook.MasterPage = template.ComposedLook.MasterPage;
result.ComposedLook.Name = template.ComposedLook.Name;
result.ComposedLook.SiteLogo = template.ComposedLook.SiteLogo;
result.ComposedLook.Version = template.ComposedLook.Version;
}
// Translate Providers, if any
if (template.Providers != null)
{
result.Providers.AddRange(
from provider in template.Providers
select new Model.Provider
{
Assembly = provider.Assembly,
Configuration = provider.Configuration != null ? provider.Configuration.ToProviderConfiguration() : null,
Enabled = provider.Enabled,
Type = provider.Type,
});
}
return(result);
}
public static SharePointProvisioningTemplate ToXml(this ProvisioningTemplate template)
{
if (template == null)
{
throw new ArgumentNullException("template");
}
SharePointProvisioningTemplate result = new SharePointProvisioningTemplate();
// Translate basic properties
result.ID = template.ID;
result.Version = template.Version.ToString("###0.0", new CultureInfo("en-US"));
result.SitePolicy = template.SitePolicy;
// Translate PropertyBagEntries, if any
if (template.PropertyBagEntries != null && template.PropertyBagEntries.Count > 0)
{
result.PropertyBagEntries =
(from bag in template.PropertyBagEntries
select new PropertyBagEntry
{
Key = bag.Key,
Value = bag.Value,
}).ToArray();
}
else
{
result.PropertyBagEntries = null;
}
// Translate Security configuration, if any
if (template.Security != null)
{
result.Security = new SharePointProvisioningTemplateSecurity();
if (template.Security.AdditionalAdministrators != null && template.Security.AdditionalAdministrators.Count > 0)
{
result.Security.AdditionalAdministrators =
(from user in template.Security.AdditionalAdministrators
select new User
{
Name = user.Name,
}).ToArray();
}
else
{
result.Security.AdditionalAdministrators = null;
}
if (template.Security.AdditionalOwners != null && template.Security.AdditionalOwners.Count > 0)
{
result.Security.AdditionalOwners =
(from user in template.Security.AdditionalOwners
select new User
{
Name = user.Name,
}).ToArray();
}
else
{
result.Security.AdditionalOwners = null;
}
if (template.Security.AdditionalMembers != null && template.Security.AdditionalMembers.Count > 0)
{
result.Security.AdditionalMembers =
(from user in template.Security.AdditionalMembers
select new User
{
Name = user.Name,
}).ToArray();
}
else
{
result.Security.AdditionalMembers = null;
}
if (template.Security.AdditionalVisitors != null && template.Security.AdditionalVisitors.Count > 0)
{
result.Security.AdditionalVisitors =
(from user in template.Security.AdditionalVisitors
select new User
{
Name = user.Name,
}).ToArray();
}
else
{
result.Security.AdditionalVisitors = null;
}
}
// Translate Site Columns (Fields), if any
if (template.SiteFields != null && template.SiteFields.Count > 0)
{
result.SiteFields = new SharePointProvisioningTemplateSiteFields
{
Any =
(from field in template.SiteFields
select field.SchemaXml.ToXmlElement()).ToArray(),
};
}
else
{
result.SiteFields = null;
}
// Translate ContentTypes, if any
if (template.ContentTypes != null && template.ContentTypes.Count > 0)
{
result.ContentTypes = new SharePointProvisioningTemplateContentTypes
{
Any =
(from contentType in template.ContentTypes
select contentType.SchemaXml.ToXmlElement()).ToArray(),
};
}
else
{
result.ContentTypes = null;
}
// Translate Lists Instances, if any
if (template.Lists != null && template.Lists.Count > 0)
{
result.Lists =
(from list in template.Lists
select new ListInstance
{
ContentTypesEnabled = list.ContentTypesEnabled,
Description = list.Description,
DocumentTemplate = list.DocumentTemplate,
EnableVersioning = list.EnableVersioning,
Hidden = list.Hidden,
MinorVersionLimit = list.MinorVersionLimit,
MaxVersionLimit = list.MaxVersionLimit,
OnQuickLaunch = list.OnQuickLaunch,
RemoveDefaultContentType = list.RemoveDefaultContentType,
TemplateType = list.TemplateType,
Title = list.Title,
Url = list.Url,
ContentTypeBindings = list.ContentTypeBindings.Count > 0 ?
(from contentTypeBinding in list.ContentTypeBindings
select new ContentTypeBinding
{
ContentTypeID = contentTypeBinding.ContentTypeID,
Default = contentTypeBinding.Default,
}).ToArray() : null,
Views = list.Views.Count > 0 ?
new ListInstanceViews
{
Any =
(from view in list.Views
select view.SchemaXml.ToXmlElement()).ToArray(),
} : null,
Fields = list.Fields.Count > 0 ?
new ListInstanceFields
{
Any =
(from field in list.Fields
select field.SchemaXml.ToXmlElement()).ToArray(),
} : null,
FieldRefs = list.FieldRefs.Count > 0 ?
(from fieldRef in list.FieldRefs
select new FieldRef
{
ID = fieldRef.ID.ToString(),
}).ToArray() : null,
}).ToArray();
}
else
{
result.Lists = null;
}
// Translate Features, if any
if (template.Features != null)
{
result.Features = new SharePointProvisioningTemplateFeatures();
// TODO: This nullability check could be useless, because
// the SiteFeatures property is initialized in the Features
// constructor
if (template.Features.SiteFeatures != null && template.Features.SiteFeatures.Count > 0)
{
result.Features.SiteFeatures =
(from feature in template.Features.SiteFeatures
select new Feature
{
ID = feature.ID.ToString(),
Deactivate = feature.Deactivate,
}).ToArray();
}
else
{
result.Features.SiteFeatures = null;
}
// TODO: This nullability check could be useless, because
// the WebFeatures property is initialized in the Features
// constructor
if (template.Features.WebFeatures != null && template.Features.WebFeatures.Count > 0)
{
result.Features.WebFeatures =
(from feature in template.Features.WebFeatures
select new Feature
{
ID = feature.ID.ToString(),
Deactivate = feature.Deactivate,
}).ToArray();
}
else
{
result.Features.WebFeatures = null;
}
}
// Translate CustomActions, if any
if (template.CustomActions != null)
{
result.CustomActions = new SharePointProvisioningTemplateCustomActions();
if (template.CustomActions.SiteCustomActions != null && template.CustomActions.SiteCustomActions.Count > 0)
{
result.CustomActions.SiteCustomActions =
(from customAction in template.CustomActions.SiteCustomActions
select new CustomAction
{
Description = customAction.Description,
Enabled = customAction.Enabled,
Group = customAction.Group,
ImageUrl = customAction.ImageUrl,
Location = customAction.Location,
Name = customAction.Name,
Rights = customAction.RightsValue,
RightsSpecified = true,
ScriptBlock = customAction.ScriptBlock,
ScriptSrc = customAction.ScriptSrc,
Sequence = customAction.Sequence,
SequenceSpecified = true,
Title = customAction.Title,
Url = customAction.Url,
}).ToArray();
}
else
{
result.CustomActions.SiteCustomActions = null;
}
if (template.CustomActions.WebCustomActions != null && template.CustomActions.WebCustomActions.Count > 0)
{
result.CustomActions.WebCustomActions =
(from customAction in template.CustomActions.WebCustomActions
select new CustomAction
{
Description = customAction.Description,
Enabled = customAction.Enabled,
Group = customAction.Group,
ImageUrl = customAction.ImageUrl,
Location = customAction.Location,
Name = customAction.Name,
Rights = customAction.RightsValue,
RightsSpecified = true,
ScriptBlock = customAction.ScriptBlock,
ScriptSrc = customAction.ScriptSrc,
Sequence = customAction.Sequence,
SequenceSpecified = true,
Title = customAction.Title,
Url = customAction.Url,
}).ToArray();
}
else
{
result.CustomActions.WebCustomActions = null;
}
}
// Translate Files, if any
if (template.Files != null && template.Files.Count > 0)
{
result.Files =
(from file in template.Files
select new File
{
Overwrite = file.Overwrite,
Src = file.Src,
Folder = file.Folder,
}).ToArray();
}
else
{
result.Files = null;
}
// Translate ComposedLook, if any
if (template.ComposedLook != null)
{
result.ComposedLook = new ComposedLook
{
AlternateCSS = template.ComposedLook.AlternateCSS,
BackgroundFile = template.ComposedLook.BackgroundFile,
ColorFile = template.ComposedLook.ColorFile,
FontFile = template.ComposedLook.FontFile,
MasterPage = template.ComposedLook.MasterPage,
Name = template.ComposedLook.Name,
SiteLogo = template.ComposedLook.SiteLogo,
Version = template.ComposedLook.Version,
VersionSpecified = true,
};
}
// Translate Providers, if any
if (template.Providers != null && template.Providers.Count > 0)
{
result.Providers =
(from provider in template.Providers
select new Provider
{
Assembly = provider.Assembly,
Configuration = provider.Configuration != null ? provider.Configuration.ToXmlNode() : null,
Enabled = provider.Enabled,
Type = provider.Type,
}).ToArray();
}
else
{
result.Providers = null;
}
return(result);
}
