internal static void Install(UmbracoServices umbracoServices)
{
// just be sure
if (!IsEnabled)
{
return;
}
_umbracoServices = umbracoServices;
// initialize mutex
// ApplicationId will look like "/LM/W3SVC/1/Root/AppName"
// name is system-wide and must be less than 260 chars
var name = HostingEnvironment.ApplicationID + "/UmbracoLiveModelsProvider";
_mutex = new Mutex(false, name);
// anything changes, and we want to re-generate models.
ContentTypeCacheRefresher.CacheUpdated += RequestModelsGeneration;
DataTypeCacheRefresher.CacheUpdated += RequestModelsGeneration;
// at the end of a request since we're restarting the pool
// NOTE - this does NOT trigger - see module below
//umbracoApplication.EndRequest += GenerateModelsIfRequested;
}
internal static void GenerateModels(UmbracoServices umbracoServices, string modelsDirectory, string bin)
{
if (!Directory.Exists(modelsDirectory))
{
Directory.CreateDirectory(modelsDirectory);
}
foreach (var file in Directory.GetFiles(modelsDirectory, "*.generated.cs"))
{
File.Delete(file);
}
var typeModels = umbracoServices.GetAllTypes();
var ourFiles = Directory.GetFiles(modelsDirectory, "*.cs").ToDictionary(x => x, File.ReadAllText);
var parseResult = new CodeParser().ParseWithReferencedAssemblies(ourFiles);
var builder = new TextBuilder(typeModels, parseResult, UmbracoConfig.For.ModelsBuilder().ModelsNamespace);
foreach (var typeModel in builder.GetModelsToGenerate())
{
var sb = new StringBuilder();
builder.Generate(sb, typeModel);
var filename = Path.Combine(modelsDirectory, typeModel.ClrName + ".generated.cs");
File.WriteAllText(filename, sb.ToString());
}
// the idea was to calculate the current hash and to add it as an extra file to the compilation,
// in order to be able to detect whether a DLL is consistent with an environment - however the
// environment *might not* contain the local partial files, and thus it could be impossible to
// calculate the hash. So... maybe that's not a good idea after all?
/*
* var currentHash = HashHelper.Hash(ourFiles, typeModels);
* ourFiles["models.hash.cs"] = $@"using Umbraco.ModelsBuilder;
* [assembly:ModelsBuilderAssembly(SourceHash = ""{currentHash}"")]
* ";
*/
if (bin != null)
{
foreach (var file in Directory.GetFiles(modelsDirectory, "*.generated.cs"))
{
ourFiles[file] = File.ReadAllText(file);
}
var compiler = new Compiler();
compiler.Compile(builder.GetModelsNamespace(), ourFiles, bin);
}
OutOfDateModelsStatus.Clear();
}
/// <summary>
/// Used to check if a template is being created based on a document type, in this case we need to
/// ensure the template markup is correct based on the model name of the document type
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void FileService_SavingTemplate(IFileService sender, Core.Events.SaveEventArgs <Core.Models.ITemplate> e)
{
// don't do anything if the factory is not enabled
// because, no factory = no models (even if generation is enabled)
if (!UmbracoConfig.For.ModelsBuilder().EnableFactory)
{
return;
}
// don't do anything if this special key is not found
if (!e.AdditionalData.ContainsKey("CreateTemplateForContentType"))
{
return;
}
// ensure we have the content type alias
if (!e.AdditionalData.ContainsKey("ContentTypeAlias"))
{
throw new InvalidOperationException("The additionalData key: ContentTypeAlias was not found");
}
foreach (var template in e.SavedEntities)
{
// if it is in fact a new entity (not been saved yet) and the "CreateTemplateForContentType" key
// is found, then it means a new template is being created based on the creation of a document type
if (!template.HasIdentity && string.IsNullOrWhiteSpace(template.Content))
{
// ensure is safe and always pascal cased, per razor standard
// + this is how we get the default model name in Umbraco.ModelsBuilder.Umbraco.Application
var alias = e.AdditionalData["ContentTypeAlias"].ToString();
var name = template.Name; // will be the name of the content type since we are creating
var className = UmbracoServices.GetClrName(name, alias);
var modelNamespace = UmbracoConfig.For.ModelsBuilder().ModelsNamespace;
// we do not support configuring this at the moment, so just let Umbraco use its default value
//var modelNamespaceAlias = ...;
var markup = ViewHelper.GetDefaultFileContent(
modelClassName: className,
modelNamespace: modelNamespace /*,
* modelNamespaceAlias: modelNamespaceAlias*/);
//set the template content to the new markup
template.Content = markup;
}
}
}
public void Initialize(UmbracoServices umbracoServices)
{
var config = UmbracoConfig.For.ModelsBuilder();
if (config.Enable)
{
FileService.SavingTemplate += FileService_SavingTemplate;
}
// fixme LiveModelsProvider should not be static
if (config.ModelsMode.IsLiveNotPure())
{
LiveModelsProvider.Install(umbracoServices);
}
// fixme OutOfDateModelsStatus should not be static
if (config.FlagOutOfDateModels)
{
OutOfDateModelsStatus.Install();
}
}
private Assembly GetModelsAssembly(bool forceRebuild)
{
var modelsDirectory = UmbracoConfig.For.ModelsBuilder().ModelsDirectory;
if (!Directory.Exists(modelsDirectory))
{
Directory.CreateDirectory(modelsDirectory);
}
// must filter out *.generated.cs because we haven't deleted them yet!
var ourFiles = Directory.Exists(modelsDirectory)
? Directory.GetFiles(modelsDirectory, "*.cs")
.Where(x => !x.EndsWith(".generated.cs"))
.ToDictionary(x => x, File.ReadAllText)
: new Dictionary <string, string>();
var typeModels = UmbracoServices.GetAllTypes();
var currentHash = HashHelper.Hash(ourFiles, typeModels);
var modelsHashFile = Path.Combine(modelsDirectory, "models.hash");
var modelsSrcFile = Path.Combine(modelsDirectory, "models.generated.cs");
var projFile = Path.Combine(modelsDirectory, "all.generated.cs");
var dllPathFile = Path.Combine(modelsDirectory, "all.dll.path");
// caching the generated models speeds up booting
// currentHash hashes both the types & the user's partials
if (!forceRebuild)
{
_logger.Logger.Debug <PureLiveModelFactory>("Looking for cached models.");
if (File.Exists(modelsHashFile) && File.Exists(projFile))
{
var cachedHash = File.ReadAllText(modelsHashFile);
if (currentHash != cachedHash)
{
_logger.Logger.Debug <PureLiveModelFactory>("Found obsolete cached models.");
forceRebuild = true;
}
}
else
{
_logger.Logger.Debug <PureLiveModelFactory>("Could not find cached models.");
forceRebuild = true;
}
}
Assembly assembly;
if (forceRebuild == false)
{
// try to load the dll directly (avoid rebuilding)
if (File.Exists(dllPathFile))
{
var dllPath = File.ReadAllText(dllPathFile);
if (File.Exists(dllPath))
{
assembly = Assembly.LoadFile(dllPath);
var attr = assembly.GetCustomAttribute <ModelsBuilderAssemblyAttribute>();
if (attr != null && attr.PureLive && attr.SourceHash == currentHash)
{
// if we were to resume at that revision, then _ver would keep increasing
// and that is probably a bad idea - so, we'll always rebuild starting at
// ver 1, but we remember we want to skip that one - so we never end up
// with the "same but different" version of the assembly in memory
_skipver = assembly.GetName().Version.Revision;
_logger.Logger.Debug <PureLiveModelFactory>("Loading cached models (dll).");
return(assembly);
}
}
}
// mmust reset the version in the file else it would keep growing
// loading cached modules only happens when the app restarts
var text = File.ReadAllText(projFile);
var match = AssemblyVersionRegex.Match(text);
if (match.Success)
{
text = text.Replace(match.Value, "AssemblyVersion(\"0.0.0." + _ver + "\")");
File.WriteAllText(projFile, text);
}
// generate a marker file that will be a dependency
// see note in RazorBuildProvider_CodeGenerationStarted
// NO: using all.generated.cs as a dependency
//File.WriteAllText(Path.Combine(modelsDirectory, "models.dep"), "VER:" + _ver);
_ver++;
assembly = BuildManager.GetCompiledAssembly(ProjVirt);
File.WriteAllText(dllPathFile, assembly.Location);
_logger.Logger.Debug <PureLiveModelFactory>("Loading cached models (source).");
return(assembly);
}
// need to rebuild
_logger.Logger.Debug <PureLiveModelFactory>("Rebuilding models.");
// generate code, save
var code = GenerateModelsCode(ourFiles, typeModels);
// add extra attributes,
// PureLiveAssembly helps identifying Assemblies that contain PureLive models
// AssemblyVersion is so that we have a different version for each rebuild
var ver = _ver == _skipver ? ++_ver : _ver;
_ver++;
code = code.Replace("//ASSATTR", $@"[assembly: PureLiveAssembly]
[assembly:ModelsBuilderAssembly(PureLive = true, SourceHash = ""{currentHash}"")]
[assembly:System.Reflection.AssemblyVersion(""0.0.0.{ver}"")]");
File.WriteAllText(modelsSrcFile, code);
// generate proj, save
ourFiles["models.generated.cs"] = code;
var proj = GenerateModelsProj(ourFiles);
File.WriteAllText(projFile, proj);
// compile and register
assembly = BuildManager.GetCompiledAssembly(ProjVirt);
File.WriteAllText(dllPathFile, assembly.Location);
// assuming we can write and it's not going to cause exceptions...
File.WriteAllText(modelsHashFile, currentHash);
_logger.Logger.Debug <PureLiveModelFactory>("Done rebuilding.");
return(assembly);
}
public ModelsBuilderBackOfficeController(UmbracoServices umbracoServices)
{
_umbracoServices = umbracoServices;
}