summaryrefslogtreecommitdiffstats
path: root/src/DotNetOpenAuth.OpenId.RelyingParty.UI/OpenId/RelyingParty/SelectorProviderButton.cs
blob: 7c71a371779f85799a09e342c44e4ff97c71091d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
//-----------------------------------------------------------------------
// <copyright file="SelectorProviderButton.cs" company="Outercurve Foundation">
//     Copyright (c) Outercurve Foundation. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace DotNetOpenAuth.OpenId.RelyingParty {
	using System;
	using System.ComponentModel;
	using System.Diagnostics.Contracts;
	using System.Drawing.Design;
	using System.Web.UI;
	using DotNetOpenAuth.ComponentModel;
	using DotNetOpenAuth.Messaging;

	/// <summary>
	/// A button that appears in the <see cref="OpenIdSelector"/> control that
	/// provides one-click access to a popular OpenID Provider.
	/// </summary>
	public class SelectorProviderButton : SelectorButton {
		/// <summary>
		/// Initializes a new instance of the <see cref="SelectorProviderButton"/> class.
		/// </summary>
		public SelectorProviderButton() {
			Reporting.RecordFeatureUse(this);
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="SelectorProviderButton"/> class.
		/// </summary>
		/// <param name="providerIdentifier">The OP Identifier.</param>
		/// <param name="imageUrl">The image to display on the button.</param>
		public SelectorProviderButton(Identifier providerIdentifier, string imageUrl)
			: this() {
			Requires.NotNull(providerIdentifier, "providerIdentifier");
			Requires.NotNullOrEmpty(imageUrl, "imageUrl");

			this.OPIdentifier = providerIdentifier;
			this.Image = imageUrl;
		}

		/// <summary>
		/// Gets or sets the path to the image to display on the button's surface.
		/// </summary>
		/// <value>The virtual path to the image.</value>
		[Editor("System.Web.UI.Design.ImageUrlEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(UITypeEditor))]
		[UrlProperty]
		public string Image { get; set; }

		/// <summary>
		/// Gets or sets the OP Identifier represented by the button.
		/// </summary>
		/// <value>
		/// The OP identifier, which may be provided in the easiest "user-supplied identifier" form,
		/// but for security should be provided with a leading https:// if possible.
		/// For example: "yahoo.com" or "https://me.yahoo.com/".
		/// </value>
		[TypeConverter(typeof(IdentifierConverter))]
		public Identifier OPIdentifier { get; set; }

		/// <summary>
		/// Gets or sets a value indicating whether this Provider doesn't handle
		/// checkid_immediate messages correctly and background authentication
		/// should not be attempted.
		/// </summary>
		public bool SkipBackgroundAuthentication { get; set; }

		/// <summary>
		/// Ensures that this button has been initialized to a valid state.
		/// </summary>
		internal override void EnsureValid() {
			Contract.Ensures(!string.IsNullOrEmpty(this.Image));
			Contract.Ensures(this.OPIdentifier != null);

			// Every button must have an image.
			ErrorUtilities.VerifyOperation(!string.IsNullOrEmpty(this.Image), OpenIdStrings.PropertyNotSet, "SelectorButton.Image");

			// Every button must have exactly one purpose.
			ErrorUtilities.VerifyOperation(this.OPIdentifier != null, OpenIdStrings.PropertyNotSet, "SelectorButton.OPIdentifier");
		}

		/// <summary>
		/// Renders the leading attributes for the LI tag.
		/// </summary>
		/// <param name="writer">The writer.</param>
		protected internal override void RenderLeadingAttributes(HtmlTextWriter writer) {
			writer.AddAttribute(HtmlTextWriterAttribute.Id, this.OPIdentifier);

			string style = "OPButton";
			if (this.SkipBackgroundAuthentication) {
				style += " NoAsyncAuth";
			}
			writer.AddAttribute(HtmlTextWriterAttribute.Class, style);
		}

		/// <summary>
		/// Renders the content of the button.
		/// </summary>
		/// <param name="writer">The writer.</param>
		/// <param name="selector">The containing selector control.</param>
		protected internal override void RenderButtonContent(HtmlTextWriter writer, OpenIdSelector selector) {
			writer.AddAttribute(HtmlTextWriterAttribute.Src, selector.Page.ResolveUrl(this.Image));
			writer.RenderBeginTag(HtmlTextWriterTag.Img);
			writer.RenderEndTag();

			writer.AddAttribute(HtmlTextWriterAttribute.Src, selector.Page.ClientScript.GetWebResourceUrl(typeof(OpenIdAjaxTextBox), OpenIdAjaxTextBox.EmbeddedLoginSuccessResourceName));
			writer.AddAttribute(HtmlTextWriterAttribute.Class, "loginSuccess");
			writer.AddAttribute(HtmlTextWriterAttribute.Title, selector.AuthenticatedAsToolTip);
			writer.RenderBeginTag(HtmlTextWriterTag.Img);
			writer.RenderEndTag();
		}
	}
}