[NuGet] Show license metadata in Manage Packages dialog

If the NuGet package source has license metadata then show this
information instead of the View License link. License metadata
can either be an license expression or a file.

If the license is a file then clicking View License will open a separate
dialog with the license read from the file.

Fixes VSTS #1005394 - Support the new "license" properties in the NuGet
package manager UI

Author: mrward

main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Gui/LicenseFileDialog.cs

@@ -0,0 +1,81 @@
+//
+// LicenseFileDialog.cs
+//
+// Author:
+//       Matt Ward <[email protected]>
+//
+// Copyright (c) 2019 Microsoft Corporation
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+using System.ComponentModel;
+using NuGet.PackageManagement.UI;
+using Xwt;
+using Xwt.Formats;
+
+namespace MonoDevelop.PackageManagement.Gui
+{
+	class LicenseFileDialog : Dialog
+	{
+		RichTextView textView;
+		LicenseFileText licenseFileText;
+
+		public LicenseFileDialog (LicenseFileText licenseFileText)
+		{
+			this.licenseFileText = licenseFileText;
+
+			Build ();
+			LoadText ();
+
+			licenseFileText.PropertyChanged += LicenseFileTextPropertyChanged;
+			licenseFileText.LoadLicenseFile ();
+		}
+
+		void Build ()
+		{
+			Height = 450;
+			Width = 450;
+			Title = licenseFileText.LicenseHeader;
+
+			textView = new RichTextView ();
+			Content = textView;
+
+			Buttons.Add (Command.Ok);
+			DefaultCommand = Command.Ok;
+		}
+
+		void LicenseFileTextPropertyChanged (object sender, PropertyChangedEventArgs e)
+		{
+			LoadText ();
+		}
+
+		void LoadText ()
+		{
+			textView.LoadText (licenseFileText.LicenseText, TextFormat.Plain);
+		}
+
+		protected override void Dispose (bool disposing)
+		{
+			base.Dispose (disposing);
+			if (disposing) {
+				licenseFileText.PropertyChanged -= LicenseFileTextPropertyChanged;
+			}
+		}
+	}
+}

main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Gui/ManagePackagesDialog.UI.cs

@@ -47,7 +47,11 @@ internal partial class ManagePackagesDialog : ExtendedTitleBarDialog
 		Label packageAuthor;
 		Label packagePublishedDate;
 		Label packageDownloads;
+		Label packageLicenseLabel;
 		LinkLabel packageLicenseLink;
+		VBox packageLicenseMetadataWarningsVBox;
+		HBox packageLicenseMetadataHBox;
+		Label packageLicenseMetadataLabel;
 		LinkLabel packageProjectPageLink;
 		Label packageDependenciesList;
 		HBox packageDependenciesHBox;
@@ -322,7 +326,7 @@ void Build ()
 			var packageLicenseHBox = new HBox ();
 			packageInfoVBox.PackStart (packageLicenseHBox);
 
-			var packageLicenseLabel = new Label ();
+			packageLicenseLabel = new Label ();
 			packageLicenseLabel.Text = GettextCatalog.GetString ("License");
 			packageLicenseLabel.Font = packageInfoBoldFont;
 			packageLicenseHBox.PackStart (packageLicenseLabel);
@@ -332,6 +336,21 @@ void Build ()
 			packageLicenseLink.Font = packageInfoSmallFont;
 			packageLicenseHBox.PackEnd (packageLicenseLink);
 
+			packageLicenseMetadataWarningsVBox = new VBox ();
+			packageLicenseMetadataWarningsVBox.Visible = false;
+			packageInfoVBox.PackStart (packageLicenseMetadataWarningsVBox);
+
+			packageLicenseMetadataHBox = new HBox ();
+			packageLicenseMetadataHBox.Visible = false;
+			packageInfoVBox.PackStart (packageLicenseMetadataHBox);
+
+			packageLicenseMetadataLabel = new Label ();
+			packageLicenseMetadataLabel.Wrap = WrapMode.Word;
+			packageLicenseMetadataLabel.MarginLeft = 5;
+			packageLicenseMetadataLabel.Font = packageInfoSmallFont;
+			packageLicenseMetadataLabel.Accessible.LabelWidget = packageLicenseLabel;
+			packageLicenseMetadataHBox.PackStart (packageLicenseMetadataLabel, true);
+
 			// Package project page.
 			var packageProjectPageHBox = new HBox ();
 			packageInfoVBox.PackStart (packageProjectPageHBox);

main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.Gui/ManagePackagesDialog.cs

@@ -27,9 +27,12 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Security;
 using MonoDevelop.Core;
 using MonoDevelop.Ide;
+using MonoDevelop.PackageManagement.Gui;
 using MonoDevelop.Projects;
+using NuGet.PackageManagement.UI;
 using NuGet.Versioning;
 using Xwt;
 using Xwt.Drawing;
@@ -97,6 +100,8 @@ public ManagePackagesDialog (
 			LoadViewModel (initialSearch);
 
 			closeButton.Clicked += CloseButtonClicked;
+			packageLicenseLink.NavigateToUrl += PackageLicenseNavigateToUrl;
+			packageLicenseMetadataLabel.LinkClicked += PackageLicenseLinkClicked;
 			this.showPrereleaseCheckBox.Clicked += ShowPrereleaseCheckBoxClicked;
 			this.packageSourceComboBox.SelectionChanged += PackageSourceChanged;
 			this.addPackagesButton.Clicked += AddPackagesButtonClicked;
@@ -115,6 +120,8 @@ public ManagePackagesDialog (
 		protected override void Dispose (bool disposing)
 		{
 			closeButton.Clicked -= CloseButtonClicked;
+			packageLicenseLink.NavigateToUrl -= PackageLicenseNavigateToUrl;
+			packageLicenseMetadataLabel.LinkClicked -= PackageLicenseLinkClicked;
 			currentPackageVersionLabel.BoundsChanged -= PackageVersionLabelBoundsChanged;
 
 			imageLoader.Loaded -= ImageLoaded;
@@ -408,6 +415,10 @@ void ShowPackageInformation (ManagePackagesSearchResultViewModel packageViewMode
 		{
 			bool consolidate = viewModel.IsConsolidatePageSelected;
 
+			foreach (Widget child in packageInfoVBox.Children) {
+				child.Visible = !consolidate;
+			}
+
 			if (consolidate) {
 				projectsListViewLabel.Text = GettextCatalog.GetString ("Select projects and a version for a consolidation.");
 			} else {
@@ -422,7 +433,7 @@ void ShowPackageInformation (ManagePackagesSearchResultViewModel packageViewMode
 				this.packageId.Visible = packageViewModel.HasNoGalleryUrl;
 				ShowUri (this.packageIdLink, packageViewModel.GalleryUrl, packageViewModel.Id);
 				ShowUri (this.packageProjectPageLink, packageViewModel.ProjectUrl);
-				ShowUri (this.packageLicenseLink, packageViewModel.LicenseUrl);
+				ShowLicense (packageViewModel);
 
 				PopulatePackageDependencies (packageViewModel);
 			}
@@ -442,10 +453,6 @@ void ShowPackageInformation (ManagePackagesSearchResultViewModel packageViewMode
 				packageVersionsHBox.Visible = true;
 			}
 
-			foreach (Widget child in packageInfoVBox.Children) {
-				child.Visible = !consolidate;
-			}
-
 			if (consolidate) {
 				PopulateProjectList ();
 			} else {
@@ -971,6 +978,7 @@ void SelectedPackageViewModelChanged (object sender, PropertyChangedEventArgs e)
 				} else {
 					if (!viewModel.IsConsolidatePageSelected) {
 						packagePublishedDate.Text = viewModel.SelectedPackage.GetLastPublishedDisplayText ();
+						ShowLicense (viewModel.SelectedPackage);
 						PopulatePackageDependencies (viewModel.SelectedPackage);
 					}
 				}
@@ -1161,5 +1169,159 @@ void ProjectCheckBoxCellViewToggled (object sender, WidgetEventArgs e)
 
 			UpdateAddPackagesButton ();
 		}
+
+		void ShowLicense (ManagePackagesSearchResultViewModel packageViewModel)
+		{
+			if (packageViewModel.HasLicenseMetadata) {
+				ShowLicenseMetadata (packageViewModel);
+			} else {
+				packageLicenseMetadataHBox.Visible = false;
+				packageLicenseMetadataWarningsVBox.Visible = false;
+				ShowUri (packageLicenseLink, packageViewModel.LicenseUrl, GettextCatalog.GetString ("View License"));
+			}
+		}
+
+		static string GetUriMarkup (Uri uri, string text)
+		{
+			return string.Format (
+				"<a href=\"{0}\">{1}</a>",
+				uri != null ? SecurityElement.Escape (uri.ToString ()) : string.Empty,
+				SecurityElement.Escape (text));
+		}
+
+		void PackageLicenseNavigateToUrl (object sender, NavigateToUrlEventArgs e)
+		{
+			if (ShowLicenseFile (e.Uri)) {
+				e.SetHandled ();
+			}
+		}
+
+		bool ShowLicenseFile (Uri uri)
+		{
+			if (!uri.IsFile)
+				return false;
+
+			if (uri.Fragment?.Length > 0) {
+				if (int.TryParse (uri.Fragment.Substring (1), out int fileNumber)) {
+					ShowLicenseFile (fileNumber);
+					return true;
+				}
+			}
+			return false;
+		}
+
+		void PackageLicenseLinkClicked (object sender, LinkEventArgs e)
+		{
+			if (ShowLicenseFile (e.Target)) {
+				e.SetHandled ();
+			}
+		}
+
+		void ShowLicenseMetadata (ManagePackagesSearchResultViewModel packageViewModel)
+		{
+			List<WarningText> warnings = null;
+			var textLinks = packageViewModel.GetLicenseLinks ();
+
+			if (textLinks.Count == 0) {
+				packageLicenseLink.Visible = false;
+				packageLicenseMetadataHBox.Visible = false;
+				packageLicenseMetadataWarningsVBox.Visible = false;
+				return;
+			}
+
+			// Single link - show this on the same line as the License label.
+			if (textLinks.Count == 1) {
+				packageLicenseLink.Visible = true;
+				packageLicenseMetadataHBox.Visible = false;
+				packageLicenseMetadataWarningsVBox.Visible = false;
+
+				IText textLink = textLinks [0];
+				if (textLink is LicenseText licenseText) {
+					packageLicenseLink.Text = licenseText.Text;
+					packageLicenseLink.Uri = licenseText.Link;
+					return;
+				} else if (textLink is LicenseFileText licenseFileText) {
+					packageLicenseLink.Text = GettextCatalog.GetString ("View License");
+					packageLicenseLink.Uri = CreateLicenseFileUri (licenseFileText, 1);
+					return;
+				} else {
+					// Warning or plain text - handled below.
+				}
+			}
+
+			// Multiple text links. We need to allow these to wrap so show these below the license label.
+			var markupBuilder = StringBuilderCache.Allocate ();
+
+			int fileLicenseCount = 0; // Should be one but handle multiple.
+			foreach (IText textLink in textLinks) {
+				if (textLink is LicenseText licenseText) {
+					markupBuilder.Append (GetUriMarkup (licenseText.Link, licenseText.Text));
+				} else if (textLink is LicenseFileText licenseFileText) {
+					fileLicenseCount++;
+					markupBuilder.Append (GetUriMarkup (CreateLicenseFileUri (licenseFileText, fileLicenseCount), licenseFileText.Text));
+				} else if (textLink is WarningText warning) {
+					warnings ??= new List<WarningText> ();
+					warnings.Add (warning);
+				} else {
+					markupBuilder.Append (textLink.Text);
+				}
+			}
+
+			packageLicenseLink.Visible = false;
+			packageLicenseMetadataHBox.Visible = true;
+			packageLicenseMetadataLabel.Markup = StringBuilderCache.ReturnAndFree (markupBuilder);
+
+			if (warnings != null) {
+				AddWarnings (warnings);
+			} else {
+				packageLicenseMetadataWarningsVBox.Visible = false;
+			}
+		}
+
+		Uri CreateLicenseFileUri (LicenseFileText licenseFileText, int licenseCount)
+		{
+			return new Uri ($"file:///{licenseFileText.Text}#{licenseCount}");
+		}
+
+		void AddWarnings (List<WarningText> warnings)
+		{
+			foreach (Widget child in packageLicenseMetadataWarningsVBox.Children.ToArray ()) {
+				packageLicenseMetadataWarningsVBox.Remove (child);
+				child.Dispose ();
+			}
+
+			foreach (WarningText warning in warnings) {
+				var hbox = new HBox ();
+				var image = new ImageView {
+					Image = ImageService.GetIcon ("md-warning", Gtk.IconSize.Menu),
+					MarginLeft = packageLicenseMetadataLabel.MarginLeft,
+					VerticalPlacement = WidgetPlacement.Start,
+				};
+				image.Accessible.RoleDescription = GettextCatalog.GetString ("Warning Icon");
+				hbox.PackStart (image);
+
+				var label = new Label {
+					Text = warning.Text,
+					Font = packageLicenseMetadataLabel.Font,
+					Wrap = WrapMode.Word
+				};
+				image.Accessible.LabelWidget = label;
+				label.Accessible.LabelWidget = packageLicenseLabel;
+				hbox.PackStart (label, true, true);
+
+				packageLicenseMetadataWarningsVBox.PackStart (hbox);
+			}
+
+			packageLicenseMetadataWarningsVBox.Visible = true;
+		}
+
+		void ShowLicenseFile (int fileNumber)
+		{
+			LicenseFileText licenseFileText = viewModel.SelectedPackage.GetLicenseFile (fileNumber);
+			if (licenseFileText != null) {
+				var dialog = new LicenseFileDialog (licenseFileText);
+				dialog.Run (this);
+			}
+		}
 	}
 }

main/src/addins/MonoDevelop.PackageManagement/MonoDevelop.PackageManagement.csproj

@@ -368,6 +368,13 @@
     <Compile Include="MonoDevelop.PackageManagement\PackageManagementCanReferenceProjectExtension.cs" />
     <Compile Include="MonoDevelop.PackageManagement\UpdateMultipleNuGetPackagesAction.cs" />
     <Compile Include="MonoDevelop.PackageManagement\ProjectReferenceMaintainerCollection.cs" />
+    <Compile Include="NuGet.PackageManagement.UI\Models\FreeText.cs" />
+    <Compile Include="NuGet.PackageManagement.UI\Models\IText.cs" />
+    <Compile Include="NuGet.PackageManagement.UI\Models\LicenseFileText.cs" />
+    <Compile Include="NuGet.PackageManagement.UI\Models\LicenseText.cs" />
+    <Compile Include="NuGet.PackageManagement.UI\Models\WarningText.cs" />
+    <Compile Include="NuGet.PackageManagement.UI\PackageLicenseUtilities.cs" />
+    <Compile Include="MonoDevelop.PackageManagement.Gui\LicenseFileDialog.cs" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="MonoDevelop.PackageManagement.addin.xml" />