Moved some OpenID extensions around for a better public API.

1 files changed, 67 insertions, 0 deletions

diff --git a/src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/Extensions/UI/UIRequestTools.cs b/src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/Extensions/UI/UIRequestTools.cs
new file mode 100644
index 0000000..519efd7
--- /dev/null
+++ b/src/DotNetOpenAuth.OpenId.Provider/OpenId/Provider/Extensions/UI/UIRequestTools.cs
@@ -0,0 +1,67 @@
+//-----------------------------------------------------------------------
+// <copyright file="UIRequestTools.cs" company="Andrew Arnott">
+//     Copyright (c) Andrew Arnott. All rights reserved.
+// </copyright>
+//-----------------------------------------------------------------------
+
+namespace DotNetOpenAuth.OpenId.Provider.Extensions.UI {
+	using System;
+	using System.Collections.Generic;
+	using System.Diagnostics.CodeAnalysis;
+	using System.Diagnostics.Contracts;
+	using System.Globalization;
+	using System.Linq;
+	using DotNetOpenAuth.Messaging;
+	using DotNetOpenAuth.OpenId.Messages;
+	using DotNetOpenAuth.OpenId.Provider;
+	using DotNetOpenAuth.Xrds;
+
+	/// <summary>
+	/// OpenID User Interface extension 1.0 request message.
+	/// </summary>
+	/// <remarks>
+	/// 	<para>Implements the extension described by: http://wiki.openid.net/f/openid_ui_extension_draft01.html </para>
+	/// 	<para>This extension only applies to checkid_setup requests, since checkid_immediate requests display
+	/// no UI to the user. </para>
+	/// 	<para>For rules about how the popup window should be displayed, please see the documentation of
+	/// <see cref="UIModes.Popup"/>. </para>
+	/// 	<para>An RP may determine whether an arbitrary OP supports this extension (and thereby determine
+	/// whether to use a standard full window redirect or a popup) via the
+	/// <see cref="IdentifierDiscoveryResult.IsExtensionSupported&lt;T&gt;()"/> method.</para>
+	/// </remarks>
+	public static class UIRequestTools {
+		/// <summary>
+		/// Gets the URL of the RP icon for the OP to display.
+		/// </summary>
+		/// <param name="realm">The realm of the RP where the authentication request originated.</param>
+		/// <param name="webRequestHandler">The web request handler to use for discovery.
+		/// Usually available via <see cref="Channel.WebRequestHandler">OpenIdProvider.Channel.WebRequestHandler</see>.</param>
+		/// <returns>
+		/// A sequence of the RP's icons it has available for the Provider to display, in decreasing preferred order.
+		/// </returns>
+		/// <value>The icon URL.</value>
+		/// <remarks>
+		/// This property is automatically set for the OP with the result of RP discovery.
+		/// RPs should set this value by including an entry such as this in their XRDS document.
+		/// <example>
+		/// &lt;Service xmlns="xri://$xrd*($v*2.0)"&gt;
+		/// &lt;Type&gt;http://specs.openid.net/extensions/ui/icon&lt;/Type&gt;
+		/// &lt;URI&gt;http://consumer.example.com/images/image.jpg&lt;/URI&gt;
+		/// &lt;/Service&gt;
+		/// </example>
+		/// </remarks>
+		public static IEnumerable<Uri> GetRelyingPartyIconUrls(Realm realm, IDirectWebRequestHandler webRequestHandler) {
+			Contract.Requires(realm != null);
+			Contract.Requires(webRequestHandler != null);
+			ErrorUtilities.VerifyArgumentNotNull(realm, "realm");
+			ErrorUtilities.VerifyArgumentNotNull(webRequestHandler, "webRequestHandler");
+
+			XrdsDocument xrds = realm.Discover(webRequestHandler, false);
+			if (xrds == null) {
+				return Enumerable.Empty<Uri>();
+			} else {
+				return xrds.FindRelyingPartyIcons();
+			}
+		}
+	}
+}