Samples/MonoRail/WizardSample/WizardSampleSite/Controllers/SimpleWizardController.cs

   1 // Copyright 2004-2008 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace WizardSampleSite.Controllers
  16 {
  17         using System;
  18         using System.Collections;
  19
  20         using Castle.MonoRail.Framework;
  21
  22         using WizardSampleSite.Model;
  23
  24
  25         [DynamicActionProvider( typeof(WizardActionProvider) )]
  26         public class SimpleWizardController : Controller, IWizardController
  27         {
  28                 public WizardStepPage[] GetSteps(IRailsEngineContext context)
  29                 {
  30                         return new WizardStepPage[]
  31                                 {
  32                                         new IntroductionStep(),
  33                                         new MainInfoStep(),
  34                                         new SubscribeStep(),
  35                                         new ConfirmationStep(),
  36                                         new ResultStep()
  37                                 };
  38                 }
  39
  40                 public void OnWizardStart()
  41                 {
  42                 }
  43
  44                 public bool OnBeforeStep(string wizardName, string stepName, WizardStepPage step)
  45                 {
  46                         return true;
  47                 }
  48
  49                 public void OnAfterStep(string wizardName, string stepName, WizardStepPage step)
  50                 {
  51                 }
  52         }
  53
  54         // Please note that we put the steps on the same file
  55         // for brevity's sake
  56
  57         /// <summary>
  58         /// Presents a small introduction
  59         /// </summary>
  60         class IntroductionStep : WizardStepPage
  61         {
  62         }
  63
  64         class MainInfoStep : WizardStepPage
  65         {
  66                 protected override void Reset()
  67                 {
  68                         Session.Remove("account");
  69                 }
  70
  71                 public void Save([DataBind("account")] Account accountFromForm)
  72                 {
  73                         Account account = WizSessionUtil.GetAccountFromSession(Session);
  74
  75                         // Update the account on session with the data from the form
  76
  77                         account.Name = accountFromForm.Name;
  78                         account.Username = accountFromForm.Username;
  79                         account.Email = accountFromForm.Email;
  80                         account.Pwd = accountFromForm.Pwd;
  81                         account.PwdConfirmation = accountFromForm.PwdConfirmation;
  82
  83                         // Some naive validation
  84
  85                         IList errors = ValidateAccount(account);
  86
  87                         if (errors.Count != 0)
  88                         {
  89                                 // Not good
  90
  91                                 Flash["errors"] = errors;
  92
  93                                 // User can't go to the next step yet
  94
  95                                 RedirectToStep("MainInfoStep");
  96                         }
  97                         else
  98                         {
  99                                 DoNavigate();
 100                         }
 101                 }
 102
 103                 private IList ValidateAccount(Account account)
 104                 {
 105                         IList errors = new ArrayList();
 106
 107                         if (account.Name == null || account.Name.Length == 0)
 108                         {
 109                                 errors.Add("Full name field must be filled");
 110                         }
 111                         if (account.Username == null || account.Username.Length == 0)
 112                         {
 113                                 errors.Add("User name field must be filled");
 114                         }
 115                         if (account.Email == null || account.Email.Length == 0)
 116                         {
 117                                 errors.Add("E-mail field must be filled");
 118                         }
 119                         if (account.Pwd != account.PwdConfirmation)
 120                         {
 121                                 errors.Add("Password don't match with confirmation");
 122                         }
 123
 124                         return errors;
 125                 }
 126
 127                 /// <summary>
 128                 /// Note that you can override
 129                 /// this method and render a different
 130                 /// view (the default behavior is to render
 131                 /// the step name, i.e. MainInfoStep in this step)
 132                 /// </summary>
 133                 protected override void RenderWizardView()
 134                 {
 135                         PropertyBag.Add("account", WizSessionUtil.GetAccountFromSession(Session));
 136
 137                         base.RenderWizardView();
 138                 }
 139         }
 140
 141         class SubscribeStep : WizardStepPage
 142         {
 143                 /// <summary>
 144                 /// You can also use this to give the view some data.
 145                 /// Here we send the presaved (if any) selections
 146                 /// </summary>
 147                 protected override void RenderWizardView()
 148                 {
 149                         PropertyBag.Add("source", new String[] { "Sports", "Science", "Nature", "History" });
 150
 151                         PropertyBag.Add("account", WizSessionUtil.GetAccountFromSession(Session));
 152
 153                         base.RenderWizardView();
 154                 }
 155
 156                 public void Save([DataBind("account")] Account accountFromForm)
 157                 {
 158                         Account account = WizSessionUtil.GetAccountFromSession(Session);
 159
 160                         account.Interests = accountFromForm.Interests;
 161
 162                         DoNavigate();
 163                 }
 164         }
 165
 166         class ConfirmationStep : WizardStepPage
 167         {
 168                 /// <summary>
 169                 /// This is an example of a pre-condition check.
 170                 /// </summary>
 171                 protected override bool IsPreConditionSatisfied(IRailsEngineContext context)
 172                 {
 173                         Account account = WizSessionUtil.GetAccountFromSession(Session);
 174
 175                         if (account.IsEmpty)
 176                         {
 177                                 Flash.Add("error", "No account information found. Please enter the data");
 178                                 RedirectToStep("MainInfoStep");
 179                                 return false;
 180                         }
 181
 182                         return true;
 183                 }
 184
 185                 protected override void RenderWizardView()
 186                 {
 187                         PropertyBag.Add("account", WizSessionUtil.GetAccountFromSession(Session));
 188
 189                         base.RenderWizardView();
 190                 }
 191         }
 192
 193         class ResultStep : WizardStepPage
 194         {
 195                 protected override void RenderWizardView()
 196                 {
 197                         Account account = WizSessionUtil.GetAccountFromSession(Session);
 198
 199                         // Here you would take the proper actions like creating
 200                         // the account in the database.
 201
 202                         // AccountService.Create(account);
 203                         // Session.Remove("account");
 204
 205                         base.RenderWizardView();
 206                 }
 207         }
 208
 209         class WizSessionUtil
 210         {
 211                 internal static Account GetAccountFromSession(IDictionary session)
 212                 {
 213                         Account account = session["stored.account"] as Account;
 214
 215                         if (account == null)
 216                         {
 217                                 account = new Account();
 218
 219                                 session["stored.account"] = account;
 220                         }
 221
 222                         return account;
 223                 }
 224         }
 225 }