Files
mono/mcs/class/System.Web/System.Web.UI.WebControls/AdRotator.cs
T
Gonzalo Paniagua Javier b79e2220a3 2002-06-11 Gonzalo Paniagua Javier <[email protected]>
* System.Web.Caching/CacheDependency.cs: fixed a couple of typos and
	don't throw NotImplementedException in constructors.

	* System.Web.UI/Control.cs:
	(MapPathSecure): until security is implemented, return the same path
	received as argument.
	(RenderControl): call OnPreRender before rendering the control. So
	AdRotator can read its configuration file.Is there any other place
	where this should be done?

	* System.Web.UI/HtmlTextWriter.cs:
	(AddAttribute): fixed. Now it really stores attributes.
	(RenderBeginTag): fixed a couple of bugs (little ones but hard to find).

	* System.Web.UI.WebControls/AdRotator.cs: GetData does not work as it
	should, but now it returns useful data (only the first ad in the file).
	Set the NavigateUrl property in the hyperlink if available.

	* System.Web.UI.WebControls/HyperLink.cs: fixed constructor and a
	couple of stack overflows.

	* System.Web.UI.WebControls/Image.cs: added an attribute and fixed
	stack overflow.

	* System.Web.UI.WebControls/WebControl.cs:
	(RenderBeginTag): fixed.
	(TagName): don't call Enum.IsDefined twice.

svn path=/trunk/mcs/; revision=5230
2002-06-11 19:37:03 +00:00

363 lines
8.5 KiB
C#
Executable File

/**
* Namespace: System.Web.UI.WebControls
* Class: AdRotator
*
* Author: Gaurav Vaish
* Maintainer: [email protected]
* Implementation: yes
* Contact: <[email protected]>
* Status: 100%
*
* (C) Gaurav Vaish (2001)
*/
using System;
using System.IO;
using System.Collections;
using System.Collections.Specialized;
using System.Web;
using System.Web.Caching;
using System.Web.UI;
using System.Xml;
using System.Web.Utils;
using System.ComponentModel;
namespace System.Web.UI.WebControls
{
[DefaultEvent("AdCreated")]
[DefaultProperty("AdvertisementFile")]
//TODO: [Designer("??")]
[ToolboxData("<{0}:AdRotator runat=\"server\" Height=\"60px\" "
+ "Width=\"468\"></{0}:AdRotator>")]
public class AdRotator: WebControl
{
private string advertisementFile;
private static readonly object AdCreatedEvent = new object();
// Will be set values during (On)PreRender-ing
private string alternateText;
private string imageUrl;
private string navigateUrl;
private string fileDirectory;
class AdRecord
{
public IDictionary adProps;
public int hits; // or impressions or clicks
public string keyword;
public AdRecord(IDictionary adProps)
{
this.adProps = adProps;
hits = 0;
keyword = String.Empty;
}
}
/*
* Loading / Saving data from/to ad file and all the manipulations wrt to the URL...
* are incorporated by the following functions.
* GetData(string)
* LoadAdFile(string)
* IsAdMatching(AdRecord)
* ResolveAdUrl(string)
* SelectAd()
* The exact control flow will be detailed. Let me first write the functions
*/
private AdRecord[] LoadAdFile(string file)
{
Stream fStream;
ArrayList list;
XmlReader reader;
XmlDocument document;
XmlNode topNode, innerNode;
IDictionary hybridDict = null;
AdRecord[] adsArray = null;
try
{
fStream = new FileStream(file, FileMode.Open, FileAccess.Read, FileShare.Read);
} catch(Exception e)
{
throw new HttpException("AdRotator: Unable to open file");
}
try
{
list = new ArrayList();
reader = new XmlTextReader(fStream);
document = new XmlDocument();
document.Load(reader);
if(document.DocumentElement!=null)
{
if(document.DocumentElement.LocalName=="Advertisements")
{
topNode = document.DocumentElement.FirstChild;
while(topNode!=null)
{
if(topNode.LocalName=="Ad")
{
innerNode = topNode.FirstChild;
while(innerNode!=null)
{
if(innerNode.NodeType==XmlNodeType.Element)
{
if(hybridDict==null)
{
hybridDict = new HybridDictionary();
}
hybridDict.Add(innerNode.LocalName, innerNode.InnerText);
}
innerNode = innerNode.NextSibling;
}
if(hybridDict!=null)
list.Add(hybridDict);
}
topNode = topNode.NextSibling;
}
}
}
if(list.Count>0)
{
adsArray = new AdRecord[list.Count];
for(int i=0; i < list.Count; i++)
{
adsArray[i] = new AdRecord((IDictionary)list[i]);
}
}
} catch(Exception e)
{
throw new HttpException("AdRotator_Parse_Error" + file);
} finally
{
fStream.Close();
}
if(adsArray == null)
{
throw new HttpException("AdRotator_No_Advertisements_Found");
}
return adsArray;
}
[MonoTODO("CacheDependency does nothing")]
private AdRecord[] GetData(string file)
{
string physPath = MapPathSecure(file);
string AdKey = "AdRotatorCache: " + physPath;
fileDirectory = UrlUtils.GetDirectory(UrlUtils.Combine(TemplateSourceDirectory, file));
Cache cache = HttpRuntime.Cache;
AdRecord[] records = (AdRecord[])cache[AdKey];
if(records==null)
{
records = LoadAdFile(physPath);
if(records==null)
{
return null;
}
cache.Insert(AdKey, records, new CacheDependency(physPath));
}
return records;
}
private IDictionary SelectAd()
{
AdRecord[] records = GetData(AdvertisementFile);
if(records!=null && records.Length!=0)
{
int impressions = 0;
for(int i=0 ; i < records.Length; i++)
{
if(IsAdMatching(records[i]))
impressions += records[i].hits;
}
if(impressions!=0)
{
int rnd = (new Random()).Next(impressions) + 1;
int counter = 0;
int index = 0;
for(int i=0; i < records.Length; i++)
{
if(IsAdMatching(records[i]))
{
if(rnd <= (counter + records[i].hits))
{
index = i;
break;
}
counter += records[i].hits;
}
}
return records[index].adProps;
}
//FIXME: the line below added. Where should i init hits to make
//impressions not be 0?
return records [0].adProps;
}
return null;
}
private bool IsAdMatching(AdRecord currAd)
{
if (KeywordFilter != String.Empty)
return (0 == String.Compare (currAd.keyword, KeywordFilter, true));
return true;
}
private string ResolveAdUrl(string relativeUrl)
{
if(relativeUrl.Length==0 || !UrlUtils.IsRelativeUrl(relativeUrl))
return relativeUrl;
string fullUrl = String.Empty;
if(fileDirectory != null)
fullUrl = fileDirectory;
if(fullUrl.Length == 0)
fullUrl = TemplateSourceDirectory;
if(fullUrl.Length == 0)
return relativeUrl;
return (fullUrl + relativeUrl);
}
[WebCategory("Action")]
[WebSysDescription("AdRotator_OnAdCreated")]
public event AdCreatedEventHandler AdCreated
{
add
{
Events.AddHandler(AdCreatedEvent, value);
}
remove
{
Events.RemoveHandler(AdCreatedEvent, value);
}
}
public AdRotator(): base()
{
advertisementFile = string.Empty;
fileDirectory = null;
}
[Bindable(true)]
[DefaultValue("")]
//[Editor("??")]
[WebCategory("Behaviour")]
[WebSysDescription("AdRotator_AdvertisementFile")]
public string AdvertisementFile
{
get
{
return advertisementFile;
}
set
{
advertisementFile = value;
}
}
public override FontInfo Font
{
get
{
return Font;
}
}
[Bindable(true)]
[DefaultValue("")]
[WebCategory("Behaviour")]
[WebSysDescription("AdRotator_KeywordFilter")]
public string KeywordFilter
{
get
{
object o = ViewState["KeywordFilter"];
if(o!=null)
return (string)o;
return String.Empty;
}
set
{
if(value!=null)
ViewState["KeywordFilter"] = value.Trim();
}
}
[Bindable(true)]
[DefaultValue("")]
[TypeConverter(typeof(TargetConverter))]
[WebCategory("Behaviour")]
[WebSysDescription("AdRotator_Target")]
public string Target
{
get
{
object o = ViewState["Target"];
if(o!=null)
return (string)o;
return String.Empty;
}
set
{
ViewState["Target"] = value;
}
}
protected override ControlCollection CreateControlCollection()
{
return new EmptyControlCollection(this);
}
protected virtual void OnAdCreated(AdCreatedEventArgs e)
{
if(Events!=null)
{
AdCreatedEventHandler aceh = (AdCreatedEventHandler)(Events[AdCreatedEvent]);
if(aceh!=null)
aceh(this, e);
}
}
protected override void OnPreRender(EventArgs e)
{
if(AdvertisementFile!=String.Empty)
{
AdCreatedEventArgs acea = new AdCreatedEventArgs(SelectAd());
imageUrl = acea.ImageUrl;
navigateUrl = acea.NavigateUrl;
alternateText = acea.AlternateText;
}
}
protected override void Render(HtmlTextWriter writer)
{
HyperLink hLink = new HyperLink();
Image adImage = new Image();
foreach(IEnumerable current in Attributes.Keys)
{
hLink.Attributes[(string)current] = Attributes[(string)current];
}
if(ID != null && ID.Length > 0)
hLink.ID = ID;
hLink.Target = Target;
hLink.AccessKey = AccessKey;
hLink.Enabled = Enabled;
hLink.TabIndex = TabIndex;
if (navigateUrl != null && navigateUrl.Length != 0)
hLink.NavigateUrl = ResolveAdUrl (navigateUrl);
hLink.RenderBeginTag(writer);
if(ControlStyleCreated)
{
adImage.ApplyStyle(ControlStyle);
}
if(imageUrl!=null && imageUrl.Length > 0)
adImage.ImageUrl = ResolveAdUrl(imageUrl);
adImage.AlternateText = alternateText;
adImage.ToolTip = ToolTip;
adImage.RenderControl(writer);
hLink.RenderEndTag(writer);
}
}
}