swcs/OurUmbraco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates code so that strict version dependent files are not returned to versions of umbraco that do not support them and also ensures that we deliver the correct package zip to later umbraco versions

Browse Source
This commit is contained in:
Shannon
2017-04-24 21:17:44 +10:00
parent 1bf0d66b7a
commit 0130399d7b
6 changed files with 291 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
OurUmbraco.Site/macroScripts/repository-view-project.cshtml
+39 -14
View File
@@ -1,4 +1,6 @@
@using OurUmbraco.Project
@using OurUmbraco.Repository.Services
@using Umbraco.Core
@using Umbraco.Web
@{
System.Web.Helpers.AntiForgeryConfig.SuppressXFrameOptionsHeader = true;
@@ -7,6 +9,7 @@
int projectId;
if (int.TryParse(Request.QueryString["project_id"], out projectId) == false)
{
//TODO: Exception probably !
return;
}
@@ -14,6 +17,11 @@
var callback = Request.QueryString["callback"];
var Project = ProjectsProvider.GetListing(projectId, false);
if (Project == null)
{
throw new InvalidOperationException("No project found with id " + projectId);
}
var node = new umbraco.NodeFactory.Node(projectId);
var parentId = node.Parent.Id;
var categoryName = node.Parent.Name;
@@ -30,10 +38,21 @@
descCssClass = "wrap";
}
var umbracoHelper = new UmbracoHelper(UmbracoContext.Current);
var packageRepoService = new PackageRepositoryService(umbracoHelper, umbracoHelper.MembershipHelper, ApplicationContext.Current.DatabaseContext);
//This doesn't matter what we set it to so long as it's below 7.5 since that is the version we introduce strict dependencies
var currUmbracoVersion = new Version(4, 0, 0);
var packageDetails = packageRepoService.GetDetails(Project.ProjectGuid, currUmbracoVersion);
if (packageDetails == null)
{
throw new InvalidOperationException("No package found with id " + Project.ProjectGuid);
}
int currentReleaseFile = 0;
if (int.TryParse(Project.CurrentReleaseFile, out currentReleaseFile))
{
var file = Project.PackageFile.Where(x => x.Id == currentReleaseFile).FirstOrDefault();
var file = Project.PackageFile.FirstOrDefault(x => x.Id == currentReleaseFile);
if (file != null)
{
var ct = "This project is compaitible with ";
@@ -66,27 +85,33 @@
}
}
<script type="text/javascript">
jQuery("#projectDescriptionText a").click(function(event){event.preventDefault(); });
jQuery("#projectDescriptionText a").click(function (event) { event.preventDefault(); });
</script>
<ul id="breadcrumb">
<li><a href="/repo?@qs">Repository</a> &rarr;</li>
<li><a href="/repo_category?@qs&category_id=@parentId">@categoryName</a> &rarr;</li>
<li><a href="/repo_category?@qs&category_id=@parentId">@categoryName</a> &rarr;</li>
<li>@Project.Name</li>
</ul>
<div id="project">
@if (currentReleaseFile != 0)
@if (string.IsNullOrWhiteSpace(packageDetails.ZipUrl) == false)
{
<h1 class="projectName">
<span>@Project.Name</span>
<a href="#" title="@Project.Name" rel="@Project.ProjectGuid" class="btn">Install package</a>
</h1>
}
else if (currentReleaseFile != 0)
{
<span style="color: red;">Unfortunately, this package is not compatible with the version of Umbraco you are running.</span><br />
<a href="https://our.umbraco.org/@node.NiceUrl" target="_blank">Go to the package page to learn more</a>
}
else
{
<span style="color: red;">Unfortunately, this package has no current release file to install at the moment.</span><br />
<a href="https://our.umbraco.org/@node.NiceUrl" target="_blank">Go to the package page to learn more</a>}
<a href="https://our.umbraco.org/@node.NiceUrl" target="_blank">Go to the package page to learn more</a>
}
<div class="meta">
<div class="box">
@@ -94,10 +119,10 @@
<dl class="projetProps summary">
<dt>Project owner:</dt>
@{
var umbracoHelper = new UmbracoHelper(UmbracoContext.Current);
var ownerName = umbracoHelper.MembershipHelper.GetById(Project.VendorId).Name;
}
<dd>@ownerName</dd>
<dd>@ownerName</dd>
<dt>Package downloads</dt>
<dd>@Project.Downloads</dd>
@@ -119,9 +144,9 @@
@if (Project.Stable)
{
<dt>Is Stable:</dt>
<dd>
<span class="green">Project is stable</span>
</dd>
<dd>
<span class="green">Project is stable</span>
</dd>
}
<dt>Current version</dt>
<dd>
@@ -130,9 +155,9 @@
@if (!string.IsNullOrEmpty(Project.LicenseName))
{
<dt>License</dt>
<dd>
<a target="_blank" href="@Project.LicenseUrl">@Project.LicenseName</a>
</dd>
<dd>
<a target="_blank" href="@Project.LicenseUrl">@Project.LicenseName</a>
</dd>
}
</dl>
</div>
@@ -158,7 +183,7 @@
image.Path.EndsWith("jpeg"))
{
<a href="@image.Path" class="projectscreenshot" rel="shadowbox[gallery]">
<img src="@image.Path?bgcolor=fff&width=100&height=100&format=png" style="border: 0;"/>
<img src="@image.Path?bgcolor=fff&width=100&height=100&format=png" style="border: 0;" />
</a>
}
}
OurUmbraco/Repository/Controllers/PackageRepositoryController.cs
+13 -1
View File
@@ -102,9 +102,21 @@ namespace OurUmbraco.Repository.Controllers
{
System.Version.TryParse(version, out parsed);
}
else
{
//if the version is null then the current umbraco version must be 7.5.x because this endpoint was only ever used by 7.5.x and 7.6.x and above will always
// suppy the version, therefore we can assume that this is 7.5.x, let's make it 7.5.13 which is the latest 7.5 we have right now
parsed = new System.Version(7, 5, 13);
}
//this should never be null, if it is return not found
if (parsed == null)
{
throw new HttpResponseException(Request.CreateResponse(HttpStatusCode.NotFound));
}
//return the results, but cache for 1 minute
var key = string.Format("PackageRepositoryController.GetDetails.{0}.{1}", id, parsed == null ? string.Empty : parsed.ToString(3));
var key = string.Format("PackageRepositoryController.GetDetails.{0}.{1}", id, parsed.ToString(3));
var package = ApplicationContext.ApplicationCache.RuntimeCache.GetCacheItem<PackageDetails>
(key,
() => Service.GetDetails(id, parsed),
OurUmbraco/Repository/Models/PackageDetails.cs
+2
View File
@@ -48,5 +48,7 @@ namespace OurUmbraco.Repository.Models
public string NetVersion { get; set; }
public string ZipUrl { get; set; }
public int ZipFileId { get; set; }
}
}
OurUmbraco/Repository/Projects.cs
+5 -2
View File
@@ -352,9 +352,12 @@ namespace OurUmbraco.Repository
if (xpn.MoveNext())
{
if (xpn.Current is IHasXmlNode)
var xmlNode = xpn.Current as IHasXmlNode;
if (xmlNode != null)
{
Node node = new Node(((IHasXmlNode)xpn.Current).GetNode());
//This will get the latest marked file id
Node node = new Node(xmlNode.GetNode());
string fileId = safeProperty(node, "file");
int _id;
OurUmbraco/Repository/Services/PackageRepositoryService.cs
+127 -25
View File
@@ -29,7 +29,7 @@ using Umbraco.Web.Security;
namespace OurUmbraco.Repository.Services
{
internal class PackageRepositoryService
public class PackageRepositoryService
{
private readonly DatabaseContext DatabaseContext;
private readonly MembershipHelper MembershipHelper;
@@ -154,6 +154,8 @@ namespace OurUmbraco.Repository.Services
/// <returns></returns>
public PackageDetails GetDetails(Guid id, System.Version version)
{
if (version == null) throw new ArgumentNullException(nameof(version));
// [LK:2016-06-13@CGRT16] We're using XPath as we experienced issues with query Examine for GUIDs,
// (it might worth but we were up against the clock).
// The XPath 'translate' is being used to force the 'packageGuid' to be lowercase for comparison.
@@ -188,10 +190,10 @@ namespace OurUmbraco.Repository.Services
}
private PackageDetails MapContentToPackageDetails(IPublishedContent content, System.Version currentUmbracoVersion)
{
if (content == null)
return null;
{
if (currentUmbracoVersion == null) throw new ArgumentNullException(nameof(currentUmbracoVersion));
if (content == null) return null;
var package = MapContentToPackage(content);
var wikiFiles = WikiFile.CurrentFiles(content.Id);
@@ -201,6 +203,7 @@ namespace OurUmbraco.Repository.Services
var allPackageFiles = wikiFiles.Where(x => x.FileType.InvariantEquals("package")).ToArray();
//get the strict packages in the correct desc order
var strictPackageFileVersions = GetAllStrictSupportedPackageVersions(allPackageFiles).ToArray();
var packageDetails = new PackageDetails(package)
@@ -213,35 +216,65 @@ namespace OurUmbraco.Repository.Services
Description = content.GetPropertyValue<string>("description").CleanHtmlAttributes(),
Images = GetPackageImages(wikiFiles.Where(x => x.FileType.InvariantEquals("screenshot")), 154, 281),
ExternalSources = GetExternalSources(content)
};
};
//if no version or not strict version dependencies, return the current release file
if (currentUmbracoVersion == null || strictPackageFileVersions.Length == 0)
var version75 = new System.Version(7, 5, 0);
//this is the file marked as the current/latest release
var currentReleaseFile = content.GetPropertyValue<int>("file");
if (strictPackageFileVersions.Length == 0)
{
//if there are no strict package files then return the latest package file
packageDetails.ZipUrl = string.Concat(BASE_URL, "/FileDownload?id=", currentReleaseFile);
packageDetails.ZipFileId = currentReleaseFile;
}
else if (currentUmbracoVersion < version75)
{
//if the umbraco version is < 7.5 it means that strict package formats are not supported
//TODO: Now we have to do the opposite of below and filter out any package file versions that have strict
// umbraco dependencies applied. Anything that has 7.5 (which would be the very minimum strict dependency) we can check for
// and then we must also consider that version 7.5.x will never send up a `currentUmbracoVersion` string, however,
// we will know if it is 7.5.x if it comes from PackageRepositoryController.GetDetails since that was the minimum umbraco version
// that used this endpoint!
var currentReleaseFile = content.GetPropertyValue<int>("file");
packageDetails.ZipUrl = string.Concat(BASE_URL, "/FileDownload?id=", currentReleaseFile);
//these are ordered by package version desc
var nonStrictPackageFiles = GetNonStrictSupportedPackageVersions(wikiFiles).ToArray();
if (nonStrictPackageFiles.Length == 0)
{
//Looks like there's nothing compatible
return null;
}
//there might be a case where the 'current release file' is not the latest version found, so let's check if
//the latest release file is included in the non-strict packages and if so we'll use that, otherwise we'll use the latest
var found = nonStrictPackageFiles.FirstOrDefault(x => x.PackageId == currentReleaseFile);
if (found != null)
{
//it's included in the non strict packages so use it
packageDetails.ZipUrl = string.Concat(BASE_URL, "/FileDownload?id=", currentReleaseFile);
packageDetails.ZipFileId = currentReleaseFile;
}
else
{
//use the latest available package version
packageDetails.ZipUrl = string.Concat(BASE_URL, "/FileDownload?id=", nonStrictPackageFiles[0].PackageId);
packageDetails.ZipFileId = nonStrictPackageFiles[0].PackageId;
}
}
else
{
//order from latest package version and lastest min umb version and start from the top, we want to return the most recent
//available package version for the current Umbraco version
var packageVersions = strictPackageFileVersions
.OrderByDescending(x => x.Item2)
.ThenByDescending(x => x.Item3);
//this package has some strict version dependency files, so we need to figure out which one is
// compatible with the current umbraco version passed in and also use the latest available
// package version that is compatible.
int found = -1;
foreach (var pckVersion in packageVersions)
foreach (var pckVersion in strictPackageFileVersions)
{
//if this version will work with the umbraco version, then use it
if (pckVersion.Item3 >= currentUmbracoVersion)
if (pckVersion.MinUmbracoVersion >= currentUmbracoVersion)
{
found = pckVersion.Item1;
found = pckVersion.PackageId;
break;
}
}
@@ -250,6 +283,7 @@ namespace OurUmbraco.Repository.Services
{
//got one! so use it's id for the file download
packageDetails.ZipUrl = string.Concat(BASE_URL, "/FileDownload?id=", found);
packageDetails.ZipFileId = found;
}
else
{
@@ -302,18 +336,86 @@ namespace OurUmbraco.Repository.Services
/// </summary>
/// <param name="packages"></param>
/// <returns>
/// A tuple: the file Id, the package version, the min umbraco version
/// Order from latest package version and lastest min umb version and start from the top, we want to return the most recent
/// available package version for the current Umbraco version
/// </returns>
private IEnumerable<Tuple<int, System.Version, System.Version>> GetAllStrictSupportedPackageVersions(IEnumerable<WikiFile> packages)
private IEnumerable<PackageVersionSupport> GetAllStrictSupportedPackageVersions(IEnumerable<WikiFile> packages)
{
var allVersions = packages
.Where(x => x.MinimumVersionStrict.IsNullOrWhiteSpace() == false)
.Select(x => Tuple.Create(x.Id, ConvertToVersion(x.Version.Version), ConvertToVersion(x.MinimumVersionStrict)))
.Where(x => x.Item2 != null && x.Item3 != null)
.Select(x => new PackageVersionSupport(x.Id, ConvertToVersion(x.Version.Version), ConvertToVersion(x.MinimumVersionStrict)))
.Where(x => x.PackageVersion != null && x.MinUmbracoVersion != null)
.OrderByDescending(x => x.PackageVersion)
.ThenByDescending(x => x.MinUmbracoVersion)
.ToArray();
return allVersions;
}
/// <summary>
/// Based on all of the files that this package go retrieve all non targeted Umbraco versions
/// </summary>
/// <param name="packages"></param>
/// <returns>
/// Order from latest package version and start from the top, we want to return the most recent
/// available package version for the current Umbraco version
/// </returns>
private IEnumerable<PackageVersionSupport> GetNonStrictSupportedPackageVersions(IEnumerable<WikiFile> packages)
{
var allVersions = packages
.Where(x => x.MinimumVersionStrict.IsNullOrWhiteSpace())
.Select(x => new PackageVersionSupport(x.Id, ConvertToVersion(x.Version.Version), null))
.Where(x => x.PackageVersion != null)
.OrderByDescending(x => x.PackageVersion)
.ToArray();
return allVersions;
}
private class PackageVersionSupport : IEquatable<PackageVersionSupport>
{
private readonly int _packageId;
public PackageVersionSupport(int packageId, System.Version packageVersion, System.Version minUmbracoVersion)
{
_packageId = packageId;
MinUmbracoVersion = minUmbracoVersion;
PackageVersion = packageVersion;
}
public int PackageId
{
get { return _packageId; }
}
public System.Version MinUmbracoVersion { get; private set; }
public System.Version PackageVersion { get; private set; }
public bool Equals(PackageVersionSupport other)
{
return _packageId == other._packageId;
}
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj)) return false;
return obj is PackageVersionSupport && Equals((PackageVersionSupport) obj);
}
public override int GetHashCode()
{
return _packageId;
}
public static bool operator ==(PackageVersionSupport left, PackageVersionSupport right)
{
return left.Equals(right);
}
public static bool operator !=(PackageVersionSupport left, PackageVersionSupport right)
{
return !left.Equals(right);
}
}
/// <summary>
/// Try to convert the string to a real version based on legacy version formats
/// </summary>
OurUmbraco/Repository/webservices/repository.asmx.cs
+105 -51
View File
@@ -4,8 +4,11 @@ using System.ComponentModel;
using System.IO;
using System.Web.Services;
using System.Xml.XPath;
using OurUmbraco.Repository.Services;
using OurUmbraco.Wiki.BusinessLogic;
using umbraco.cms.businesslogic.web;
using Umbraco.Core;
using Umbraco.Web;
namespace OurUmbraco.Repository.webservices
{
@@ -76,12 +79,76 @@ namespace OurUmbraco.Repository.webservices
}
}
/// <summary>
/// This will return the byte array for the package file for the package id specified
/// </summary>
/// <param name="packageGuid"></param>
/// <param name="umbracoVersion">The Version of the umbraco install requesting the package file, this is in the normaly version format such as 7.6.0</param>
/// <returns></returns>
/// <remarks>
/// This endpoint is new and is only referenced from 7.5.14 and above
/// </remarks>
[WebMethod]
public byte[] GetPackageFile(string packageGuid, string umbracoVersion)
{
var umbHelper = new UmbracoHelper(UmbracoContext.Current);
var pckRepoService = new PackageRepositoryService(umbHelper, umbHelper.MembershipHelper, ApplicationContext.Current.DatabaseContext);
System.Version currUmbracoVersion;
if (!System.Version.TryParse(umbracoVersion, out currUmbracoVersion))
throw new InvalidOperationException("Could not parse the version specified " + umbracoVersion);
var guid = new Guid(packageGuid);
var details = pckRepoService.GetDetails(guid, currUmbracoVersion);
if (details == null)
throw new InvalidOperationException("No package found with id " + packageGuid);
var wf = new WikiFile(details.ZipFileId);
if (wf == null)
throw new InvalidOperationException("Could not find wiki file by id " + details.ZipFileId);
wf.UpdateDownloadCounter(true, true);
return wf.ToByteArray();
}
/// <summary>
/// This will return the byte array for the package file for the package id specified - since this endpoint is ONLY used
/// for Umbraco installs that are less than 7.6.0 and only when legacy XML schema is enabled, we know that this is only used for old umbraco versions
/// </summary>
/// <param name="packageGuid"></param>
/// <returns></returns>
[WebMethod]
public byte[] fetchPackage(string packageGuid)
{
return OurUmbraco.Repository.Packages.PackageFileByGuid(new Guid(packageGuid)).ToByteArray();
var umbHelper = new UmbracoHelper(UmbracoContext.Current);
var pckRepoService = new PackageRepositoryService(umbHelper, umbHelper.MembershipHelper, ApplicationContext.Current.DatabaseContext);
//This doesn't matter what we set it to so long as it's below 7.5 since that is the version we introduce strict dependencies
var currUmbracoVersion = new System.Version(4, 0, 0);
var guid = new Guid(packageGuid);
var details = pckRepoService.GetDetails(guid, currUmbracoVersion);
if (details == null)
throw new InvalidOperationException("No package found with id " + packageGuid);
var wf = new WikiFile(details.ZipFileId);
if (wf == null)
throw new InvalidOperationException("Could not find wiki file by id " + details.ZipFileId);
wf.UpdateDownloadCounter(true, true);
return wf.ToByteArray();
}
/// <summary>
/// This will return the byte array for the package file for the package id specified - since this endpoint is ONLY used
/// for Umbraco installs that are less than 7.6.0 and only when legacy XML schema is enabled, we know that this is only used for old umbraco versions
/// </summary>
/// <param name="packageGuid"></param>
/// <param name="repoVersion">
/// This is a strange Umbraco version parameter - but it's not really an umbraco version, it's a special/odd version format like Version41
///
/// The repoVersion will never be null for for 7.5.x and this method will never be used by 7.6+
/// </param>
/// <returns></returns>
[WebMethod]
public byte[] fetchPackageByVersion(string packageGuid, string repoVersion)
{
@@ -112,51 +179,56 @@ namespace OurUmbraco.Repository.webservices
break;
}
WikiFile wf = OurUmbraco.Repository.Packages.PackageFileByGuid(new Guid(packageGuid));
var umbHelper = new UmbracoHelper(UmbracoContext.Current);
var pckRepoService = new PackageRepositoryService(umbHelper, umbHelper.MembershipHelper, ApplicationContext.Current.DatabaseContext);
//This doesn't matter what we set it to so long as it's below 7.5 since that is the version we introduce strict dependencies
//Side note: Umbraco 7.5.0 uses this endpoint but since 7.5.0 is already out there's nothing we can do about this, if we pass in 7.5.x then
// the logic will use strict file versions which we cannot do because this endpoint is also used for < 7.5!
// The worst that can happen in this case is that a strict package dependency has been made on 7.5 and then an umbraco 7.5 package
// requests the file, well it won't get it because this will only return non strict packages.
var currUmbracoVersion = new System.Version(4, 0, 0);
var guid = new Guid(packageGuid);
var details = pckRepoService.GetDetails(guid, currUmbracoVersion);
if (details == null)
return new byte[0];
if (wf != null)
var wf = new WikiFile(details.ZipFileId);
//WikiFile wf = OurUmbraco.Repository.Packages.PackageFileByGuid(new Guid(packageGuid));
//if the package doesn't care about the umbraco version needed...
if (wf.Version.Version == "nan")
return wf.ToByteArray();
//if v45
if (version == "v45")
{
int v = 0;
if (int.TryParse(wf.Version.Version.Replace("v", ""), out v))
if (v >= 45)
return wf.ToByteArray();
//if the package doesn't care about the umbraco version needed...
if (wf.Version.Version == "nan")
if (wf.Version.Version == "v47" || wf.Version.Version == "v45")
return wf.ToByteArray();
//if v45
if (version == "v45")
if (wf.Version.Version != version && wf.Version.Version != "nan")
{
int v = 0;
if (int.TryParse(wf.Version.Version.Replace("v", ""), out v))
if (v >= 45)
return wf.ToByteArray();
if (wf.Version.Version == "v47" || wf.Version.Version == "v45")
return wf.ToByteArray();
else if (wf.Version.Version != version && wf.Version.Version != "nan")
{
wf = WikiFile.FindPackageForUmbracoVersion(wf.NodeId, version);
return wf.ToByteArray();
}
wf = WikiFile.FindPackageForUmbracoVersion(wf.NodeId, version);
return wf.ToByteArray();
}
}
return new byte[0];
/*
if (wf.Version.Version != version && wf.Version.Version != "nan")
wf = uWiki.Businesslogic.WikiFile.FindPackageForUmbracoVersion(wf.NodeId, version);
if(wf != null)
return wf.ToByteArray();
else
return new byte[0];*/
return new byte[0];
}
/// <summary>
/// SD: Pretty sure this is no longer used/needed it should probably be removed - maybe really old versions might try to use this?
/// </summary>
/// <param name="packageGuid"></param>
/// <param name="memberKey"></param>
/// <returns></returns>
[WebMethod]
public byte[] fetchProtectedPackage(string packageGuid, string memberKey)
{
@@ -225,24 +297,6 @@ namespace OurUmbraco.Repository.webservices
return item;
}
private static umbraco.cms.businesslogic.contentitem.ContentItem repositoryContentItem(string guid)
{
umbraco.cms.businesslogic.contentitem.ContentItem item = new umbraco.cms.businesslogic.contentitem.ContentItem(1052);
XPathNodeIterator xpn = umbraco.library.GetXmlNodeByXPath("descendant::node[data [@alias = 'repositoryGuid'] = '" + guid + "']");
if (xpn.MoveNext())
{
int id = int.Parse(xpn.Current.GetAttribute("id", "")); ;
item = new umbraco.cms.businesslogic.contentitem.ContentItem(id);
}
return item;
}
private static string md5(string input)
{