mcs/class/System.Web/System.Web.UI.WebControls/AdRotator.cs

   1 //
   2 // System.Web.UI.WebControls.AdRotator
   3 //
   4 // Author:
   5 //        Ben Maurer <bmaurer@novell.com>
   6 //
   7 // Copyright (C) 2005 Novell, Inc (http://www.novell.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System.Xml;
  30 using System.Collections;
  31 using System.ComponentModel;
  32 using System.Security.Permissions;
  33 using System.Web.Util;
  34
  35 namespace System.Web.UI.WebControls {
  36
  37         // CAS
  38         [AspNetHostingPermissionAttribute (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  39         [AspNetHostingPermissionAttribute (SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
  40         // attributes
  41         [DefaultEvent("AdCreated")]
  42         [DefaultProperty("AdvertisementFile")]
  43         [Designer("System.Web.UI.Design.WebControls.AdRotatorDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
  44 #if NET_2_0
  45         [ToolboxData("<{0}:AdRotator runat=\"server\"></{0}:AdRotator>")]
  46 #else
  47         [ToolboxData("<{0}:AdRotator runat=\"server\" Height=\"60px\" Width=\"468px\"></{0}:AdRotator>")]
  48 #endif
  49         public class AdRotator :
  50 #if NET_2_0
  51         DataBoundControl
  52 #else
  53         WebControl
  54 #endif
  55         {
  56 #if NET_2_0
  57                 protected internal override void OnInit (EventArgs e)
  58                 {
  59                         base.OnInit(e);
  60                 }
  61 #endif
  62
  63 #if NET_2_0
  64                 protected internal
  65 #else
  66                 protected
  67 #endif
  68                 override void OnPreRender (EventArgs eee)
  69                 {
  70                         Hashtable ht = null;
  71
  72                         if (ad_file != "" && ad_file != null) {
  73                                 ReadAdsFromFile (Page.MapPath (ad_file));
  74                                 ht = ChooseAd ();
  75                         }
  76
  77                         AdCreatedEventArgs e = new AdCreatedEventArgs (ht);
  78                         OnAdCreated (e);
  79                         createdargs = e;
  80
  81                 }
  82
  83 #if NET_2_0
  84                 [MonoTODO ("Not implemented")]
  85                 protected internal override void PerformDataBinding (IEnumerable data)
  86                 {
  87                         throw new NotImplementedException ();
  88                 }
  89
  90                 [MonoTODO ("Not implemented")]
  91                 protected override void PerformSelect ()
  92                 {
  93                         throw new NotImplementedException ();
  94                 }
  95 #endif
  96
  97                 AdCreatedEventArgs createdargs;
  98
  99 #if NET_2_0
 100                 protected internal
 101 #else
 102                 protected
 103 #endif
 104                 override void Render (HtmlTextWriter w)
 105                 {
 106                         AdCreatedEventArgs e = createdargs;
 107
 108                         base.AddAttributesToRender (w);
 109
 110                         if (e.NavigateUrl != null && e.NavigateUrl.Length > 0)
 111                                 w.AddAttribute (HtmlTextWriterAttribute.Href, ResolveAdUrl (e.NavigateUrl));
 112                         if (Target != null && Target.Length > 0)
 113                                 w.AddAttribute (HtmlTextWriterAttribute.Target, Target);
 114
 115                         w.RenderBeginTag (HtmlTextWriterTag.A);
 116
 117                         if (e.ImageUrl != null && e.ImageUrl.Length > 0)
 118                                 w.AddAttribute (HtmlTextWriterAttribute.Src, ResolveAdUrl (e.ImageUrl));
 119
 120                         w.AddAttribute (HtmlTextWriterAttribute.Alt, e.AlternateText == null ? "" : e.AlternateText);
 121                         w.AddAttribute (HtmlTextWriterAttribute.Border, "0");
 122                         w.RenderBeginTag (HtmlTextWriterTag.Img);
 123                         w.RenderEndTag (); // img
 124                         w.RenderEndTag (); // a
 125                 }
 126
 127                 string ResolveAdUrl (string url)
 128                 {
 129                         string path = url;
 130
 131                         if (AdvertisementFile != null && AdvertisementFile.Length > 0 && path [0] != '/' && path [0] != '~')
 132                                 try {
 133                                         new Uri (path);
 134                                 }
 135                                 catch {
 136                                         return UrlUtils.Combine (UrlUtils.GetDirectory (ResolveUrl (AdvertisementFile)), path);
 137                                 }
 138
 139                         return ResolveUrl (path);
 140                 }
 141
 142                 //
 143                 // We take all the ads in the ad file and add up their
 144                 // impression weight. We then take a random number [0,
 145                 // TotalImpressions). We then choose the ad that is
 146                 // that number or less impressions for the beginning
 147                 // of the file. This lets us respect the weights
 148                 // given.
 149                 //
 150                 Hashtable ChooseAd ()
 151                 {
 152                         // cache for performance
 153                         string KeywordFilter = this.KeywordFilter;
 154
 155                         int total_imp = 0;
 156                         int cur_imp = 0;
 157
 158                         foreach (Hashtable a in ads) {
 159                                 if (KeywordFilter == "" || KeywordFilter == (string) a ["Keyword"])
 160                                         total_imp += a ["Impressions"] != null ? int.Parse ((string) a ["Impressions"]) : 1;
 161                         }
 162
 163                         int r = new Random ().Next (total_imp);
 164
 165                         foreach (Hashtable a in ads) {
 166                                 if (KeywordFilter != "" && KeywordFilter != (string) a ["Keyword"])
 167                                         continue;
 168                                 cur_imp += a ["Impressions"] != null ? int.Parse ((string) a ["Impressions"]) : 1;
 169
 170                                 if (cur_imp > r)
 171                                         return a;
 172                         }
 173
 174                         if (total_imp != 0)
 175                                 throw new Exception ("I should only get here if no ads matched");
 176
 177                         return null;
 178                 }
 179
 180                 ArrayList ads = new ArrayList ();
 181
 182                 void ReadAdsFromFile (string s)
 183                 {
 184                         XmlDocument d = new XmlDocument ();
 185                         try {
 186                                 d.Load (s);
 187                         } catch (Exception e) {
 188                                 throw new HttpException ("AdRotator could not parse the xml file", e);
 189                         }
 190
 191                         ads.Clear ();
 192
 193                         foreach (XmlNode n in d.DocumentElement.ChildNodes) {
 194
 195                                 Hashtable ad = new Hashtable ();
 196
 197                                 foreach (XmlNode nn in n.ChildNodes)
 198                                         ad.Add (nn.Name, nn.InnerText);
 199
 200                                 ads.Add (ad);
 201                         }
 202                 }
 203
 204                 string ad_file = "";
 205
 206 #if NET_2_0
 207                 [UrlProperty]
 208 #endif
 209                 [Bindable(true)]
 210                 [DefaultValue("")]
 211                 [Editor("System.Web.UI.Design.XmlUrlEditor, " + Consts.AssemblySystem_Design, typeof(System.Drawing.Design.UITypeEditor))]
 212                 [WebSysDescription("")]
 213                 [WebCategory("Behavior")]
 214                 public string AdvertisementFile {
 215                         get {
 216                                 return ad_file;
 217                         }
 218                         set {
 219                                 ad_file = value;
 220                         }
 221
 222                 }
 223
 224 #if NET_2_0
 225                 [DefaultValue ("AlternateText")]
 226                 [WebSysDescriptionAttribute ("")]
 227                 [WebCategoryAttribute ("Behavior")]
 228                 [MonoTODO ("Not implemented")]
 229                 public string AlternateTextField
 230                 {
 231                         get {
 232                                 throw new NotImplementedException ();
 233                         }
 234                         set {
 235                                 throw new NotImplementedException ();
 236                         }
 237                 }
 238 #endif
 239
 240                 [Browsable(false)]
 241                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 242                 [EditorBrowsable(EditorBrowsableState.Never)]
 243                 public override FontInfo Font {
 244                         get {
 245                                 return base.Font;
 246                         }
 247                 }
 248
 249 #if NET_2_0
 250                 [DefaultValue ("ImageUrl")]
 251                 [MonoTODO ("Not implemented")]
 252                 [WebSysDescriptionAttribute ("")]
 253                 [WebCategoryAttribute ("Behavior")]
 254                 public string ImageUrlField
 255                 {
 256                         get {
 257                                 throw new NotImplementedException ();
 258                         }
 259                         set {
 260                                 throw new NotImplementedException ();
 261                         }
 262                 }
 263 #endif
 264
 265
 266                 [Bindable(true)]
 267                 [DefaultValue("")]
 268                 [WebSysDescription("")]
 269                 [WebCategory("Behavior")]
 270                 public string KeywordFilter {
 271                         get {
 272                                 return ViewState.GetString ("KeywordFilter", "");
 273                         }
 274                         set {
 275                                 ViewState ["KeywordFilter"] = value;
 276                         }
 277
 278                 }
 279
 280 #if NET_2_0
 281                 [DefaultValue ("NavigateUrl")]
 282                 [MonoTODO ("Not implemented")]
 283                 [WebSysDescriptionAttribute ("")]
 284                 [WebCategoryAttribute ("Behavior")]
 285                 public string NavigateUrlField
 286                 {
 287                         get {
 288                                 throw new NotImplementedException ();
 289                         }
 290                         set {
 291                                 throw new NotImplementedException ();
 292                         }
 293                 }
 294 #endif
 295
 296                 [Bindable(true)]
 297                 [DefaultValue("_top")]
 298                 [TypeConverter(typeof(System.Web.UI.WebControls.TargetConverter))]
 299                 [WebSysDescription("")]
 300                 [WebCategory("Behavior")]
 301                 public string Target {
 302                         get {
 303                                 return ViewState.GetString ("Target", "_top");
 304                         }
 305                         set {
 306                                 ViewState ["Target"] = value;
 307                         }
 308
 309                 }
 310
 311 #if NET_2_0
 312                 /* all these are listed in corcompare */
 313                 public override string UniqueID
 314                 {
 315                         get {
 316                                 return base.UniqueID;
 317                         }
 318                 }
 319
 320                 protected override HtmlTextWriterTag TagKey
 321                 {
 322                         get {
 323                                 return base.TagKey;
 324                         }
 325                 }
 326 #endif
 327
 328                 protected virtual void OnAdCreated (AdCreatedEventArgs e)
 329                 {
 330                         AdCreatedEventHandler h = (AdCreatedEventHandler) Events [AdCreatedEvent];
 331                         if (h != null)
 332                                 h (this, e);
 333                 }
 334
 335                 static readonly object AdCreatedEvent = new object ();
 336
 337                 [WebSysDescription("")]
 338                 [WebCategory("Action")]
 339                 public event AdCreatedEventHandler AdCreated {
 340                         add { Events.AddHandler (AdCreatedEvent, value); }
 341                         remove { Events.RemoveHandler (AdCreatedEvent, value); }
 342                 }
 343         }
 344 }