protected override IEnumerable<string> GetSearchPaths()
{
yield return BloomFileLocator.BrowserRoot;
//The versions of the files that come with the program should always win out.
//NB: This should not include any sample books.
foreach (var searchPath in _factorySearchPaths)
{
yield return searchPath;
}
//Note: the order here has major ramifications, as it's quite common to have mutliple copies of the same file around
//in several of our locations.
//For example, if do this:
// return base.GetSearchPaths().Concat(paths);
//Then we will favor the paths known to the base class over those we just compiled in the lines above.
//One particular bug that came out of that was when a custom xmatter (because of a previous bug) snuck into the
//Sample "Vaccinations" book, then *that* copy of the xmatter was always used, becuase it was found first.
// So, first we want to try the factory xmatter paths. These have precedence over factory templates.
foreach (var xMatterInfo in _xMatterPackFinder.Factory)
{
//NB: if we knew what the xmatter pack they wanted, we could limit to that. for now, we just iterate over all of
//them and rely (reasonably) on the names being unique
//this is a bit weird... we include the parent, in case they're looking for the xmatter *folder*, and the folder
//itself, in case they're looking for something inside it
yield return xMatterInfo.PathToFolder;
yield return Path.GetDirectoryName(xMatterInfo.PathToFolder);
}
// On the other hand the remaining factory stuff has precedence over non-factory XMatter.
foreach (var searchPath in _afterXMatterSearchPaths)
{
yield return searchPath;
}
foreach (var xMatterInfo in _xMatterPackFinder.NonFactory)
{
//this is a bit weird... we include the parent, in case they're looking for the xmatter *folder*, and the folder
//itself, in case they're looking for something inside it
yield return xMatterInfo.PathToFolder;
yield return Path.GetDirectoryName(xMatterInfo.PathToFolder);
}
//REVIEW: this one is just a big grab bag of all folders we find in their programdata, installed stuff. This could be insufficient.
foreach (var searchPath in _userInstalledSearchPaths)
{
yield return searchPath;
}
//Book-specific paths (added by AddPath()) are last because we want people to get the latest stylesheet,
//not just the version the had when they made the book.
//This may seem counter-intuitive. One scenario, which has played out many times, is that the
//book has been started, and the customer requests some change to the stylesheet, which we deliver just by having them
//double-click a bloompack.
//Another scenario is that a new version of Bloom comes out that expects/needs the newer stylesheet
foreach (var searchPath in _bookSpecificSearchPaths)
{
yield return searchPath;
}
if (_collectionSettings.FolderPath != null) // typically only in tests, but makes more robust anyway
yield return _collectionSettings.FolderPath;
}
