Asp .NET Redirect To SSL HttpModule

Taswar Bhatti February 18, 2010 4 Comments

There are tones of blog post out there on how to redirect http to https. As in when a user request for http://myserver.com/Login.aspx
they will be redirected to https://myserver.com/Login.aspx

One can do it with IIS but I find that way a bit ugly since you have to create another site and set the 403 to redirect to another location. Not as elegant as apache mod rewrite.

A more elegant approach I found when using asp .net is by using an HttpModule in your code, so that the entire site is redirected. There are other solutions to redirect individual pages but for this post we will focus on redirecting all traffic to SSL.

To begin with we will code up an RedirectToSSL.cs page and place it into our App_Code folder.

using System;
using System.Web;

namespace SolutionName.App_Code
{
    public class RedirectToSSL : IHttpModule
    {
        #region IHttpModule Members

        public void Dispose()
        {
           
        }

        public void Init(HttpApplication context)
        {
            context.BeginRequest += ContextBeginRequest;
        }


        private static void ContextBeginRequest(object sender, EventArgs e)
        {

            HttpApplication application = sender as HttpApplication;

            if (application == null) 
                return;

            if (application.Request.IsSecureConnection) 
                return;
        
            // send user to SSL 

            string serverName = HttpUtility.UrlEncode(application.Request.ServerVariables["SERVER_NAME"]);

            string filePath = application.Request.FilePath;

            application.Response.Redirect("https://" + serverName + filePath);
        }

        #endregion

    }
}

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

using System;

using System.Web;

namespace SolutionName.App_Code

{

public class RedirectToSSL : IHttpModule

{

#region IHttpModule Members

public void Dispose()

{

}

public void Init(HttpApplication context)

{

context.BeginRequest += ContextBeginRequest;

}

private static void ContextBeginRequest(object sender, EventArgs e)

{

HttpApplication application = sender as HttpApplication;

if (application == null)

return;

if (application.Request.IsSecureConnection)

return;

// send user to SSL

string serverName = HttpUtility.UrlEncode(application.Request.ServerVariables["SERVER_NAME"]);

string filePath = application.Request.FilePath;

application.Response.Redirect("https://" + serverName + filePath);

}

#endregion

}

Then all we have to do is add this line in our web.config file in order to enable it.

<httpModules>
     <add name="RedirectToSSL" type="SolutionName.App_Code.RedirectToSSL"/>
</httpModules>

1

2

3

</httpModules>

Replace the solutionName with your project name and voila you now have the entire site in SSL and you don’t have to worry about talking to an admin for IIS configuration or anything like that.

.NET, ASP .NET

ASP .NET, C#, https, redirect asp .net

Url Helper Extension Method for ASP MVC in form tags when using IIS 6

Taswar Bhatti December 21, 2009 4 Comments

So I was going through some code of codebettercanvas and found it interesting of Karl Seguin using Html Helper extension for his form tags, which has its elegance.

e.g

<form id="login" action="!{Html.LinkTo<HomeController>(c => c.Login()) }" method="post">

1	<form id="login" action="!{Html.LinkTo<HomeController>(c => c.Login()) }" method="post">

Basically it calls an extension method called LinkTo with a generic controller and a lamda for calling its action, the extension method looks like

public static class HtmlExtensions
    {

private static readonly string _applicationPath = HttpContext.Current.Request.ApplicationPath == "/" ? string.Empty : HttpContext.Current.Request.ApplicationPath;

//other method removed

public static string LinkTo(this HtmlHelper html, Expression<Func<T, ActionResult>> action)
        {
            var body = action.Body as MethodCallExpression;
            if (body == null)
            {
                throw new InvalidOperationException("Expression must be a method call");
            }
            var controller = typeof(T).Name.Replace("Controller", string.Empty);
            return string.Format("{0}/{1}/{2}", _applicationPath, controller, body.Method.Name);
        }
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

public static class HtmlExtensions

{

private static readonly string _applicationPath = HttpContext.Current.Request.ApplicationPath == "/" ? string.Empty : HttpContext.Current.Request.ApplicationPath;

//other method removed

public static string LinkTo(this HtmlHelper html, Expression<Func<T, ActionResult>> action)

{

var body = action.Body as MethodCallExpression;

if (body == null)

{

throw new InvalidOperationException("Expression must be a method call");

}

var controller = typeof(T).Name.Replace("Controller", string.Empty);

return string.Format("{0}/{1}/{2}", _applicationPath, controller, body.Method.Name);

}

This would work great if you are using IIS 7 or some kind or rewrite in your URL but if you are using IIS 6, where you might need some special extension in your routes for IIS 6 to surf ASP MVC e.g {controller}.mvc/{action}/{id} pattern. (Steve Sanderson does a post on deploying it on IIS 6) Then you are out of luck to use the html helper extension method form tag. Since the application path does not know about the .mvc extension you added to the route.

But not to worry one can use the UrlHelper class to find the path. Here is an example of it.

public static class UrlHelperExtension
    {
public static string LinkTo(this UrlHelper helper, Expression<Func<T, ActionResult>> action)
        {
            var body = action.Body as MethodCallExpression;
            if (body == null)
            {
                throw new InvalidOperationException("Expression must be a method call");
            }

            var controller = typeof(T).Name.Replace("Controller", string.Empty);

            return helper.Action(body.Method.Name, controller);
        }
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

public static class UrlHelperExtension

{

public static string LinkTo(this UrlHelper helper, Expression<Func<T, ActionResult>> action)

{

var body = action.Body as MethodCallExpression;

if (body == null)

{

throw new InvalidOperationException("Expression must be a method call");

}

var controller = typeof(T).Name.Replace("Controller", string.Empty);

return helper.Action(body.Method.Name, controller);

}

Now all you have to do is use this in your form e.g

<form id="login" action="!{Url.LinkTo<HomeController>(c => c.Login()) }" method="post">

1	<form id="login" action="!{Url.LinkTo<HomeController>(c => c.Login()) }" method="post">

Please note I am using sparkviewengine for my views in my asp mvc

aspmvc, Misc

asp .net mvc, aspmvc url exteion IIS6, IIS, mvc, url

Learn to use PowerShell to extract data from RSS

Taswar Bhatti October 21, 2009 No Comments

Currently I am doing some performance testing on our application and part of it is seeing how well do we handle “insert” in our application. (Are there any problems etc, how many can it handle, etc)
I am using JMeter to test the performance and it is quite a flexible product that I will talk about later in one of the blog post on using JMeter to perf test ASP .NET application.

So back to PowerShell. Basically I needed a good source of data to (e.g real live data) that people type, so what came to my mind was, why don’t I just use some RSS data out there and try it out, it gives good and real information rather than generic data like “Hello World” that I may generate.

So I took upon to use the CBC News for Ottawa as an RSS feed, local news good data and it changes everyday and every 15 minutes or so.
Please note don’t hit the server continuously to try the script out, I don’t want CBC to be made at me 🙂

So here is a simple script.

$rssUrl = "http://rss.cbc.ca/lineup/canada-ottawa.xml"
$blog = [xml](new-object System.Net.WebClient).DownloadString($rssUrl)
$items = $blog.rss.channel.item

foreach($row in $items)
{	
	$row.title + "|" + $row.description.Replace("`n",'') + "|" + $row.link
}

1

2

3

4

5

6

7

8

$rssUrl = "http://rss.cbc.ca/lineup/canada-ottawa.xml"

$blog = [xml](new-object System.Net.WebClient).DownloadString($rssUrl)

$items = $blog.rss.channel.item

foreach($row in $items)

{

$row.title + "|" + $row.description.Replace("`n",'') + "|" + $row.link

}

So this will output data on the screen with
e.g This news is awesome|Reports have reported that this news is awesome|http://www.someurl.com

The reason I choose “|” rather than csv(comma separated) is because there could be data in there that could have comma in them.

Also in order to output it to a file one has type into PowerShell prompt
$ CBCRssPopulate.ps1 | out-file “cbcnews.txt” -encoding ascii

Please note the ascii setting at the end since by default everything in PowerShell is unicode and you might get into issues later on for parsing data.

Recommended Tool for PowerShell editing is PowerGUI http://www.powergui.org/index.jspa

Have fun 🙂

Misc

PowerShell

Safe Base64 Url in ASP .NET

Taswar Bhatti September 28, 2009 1 Comment

How to do safe base64 url encoding in ASP .NET, I came into a problem of url encoding in IIS 7 where it does not like “+”, “/” in the Url. Basically a Url that looks like of like this

http://fake.abc/TIRlcEq0umjO6uJqtqvnkUGntUzv19rK+8mcvPK5qL1bwEZtEUqTlc3iF/TomuXU746Il5IF2iN9SeYuYDqt6SQzfdrv+Ltug2KZteKlYawc=

I know you may say what is this??? Its actually some kind of encrypted data that is in base64, but since IIS 7 does not like “+” or “/” even if its url encoded.

So I made a Utility class string extension method that just simply replaces the characters with “-” and “_”

Here is the code so maybe someday it would help you out also.

public static class SafeBase64UrlEncoder
	{
		private const string Plus = "+";
		private const string Minus = "-";
		private const string Slash = "/";
		private const string Underscore = "_";
		private const string EqualSign = "=";
		private const string Pipe = "|";
		private static readonly IDictionary<string, string> _mapper;


		static SafeBase64UrlEncoder()
		{
			_mapper = new Dictionary<string, string> {{Plus, Minus}, {Slash, Underscore}, {EqualSign, Pipe}};
		}

		public static string EncodeBase64Url(this string base64Str)
		{
			if (string.IsNullOrEmpty(base64Str))
				return base64Str;

			foreach (var pair in _mapper)
			{
				base64Str = base64Str.Replace(pair.Key, pair.Value);
			}
			
			return base64Str;
		}
		
		public static string DecodeBase64Url(this string safe64Url)
		{

			if (string.IsNullOrEmpty(safe64Url))
				return safe64Url;

			foreach (var pair in _mapper)
			{
				safe64Url = safe64Url.Replace(pair.Value, pair.Key);
			}

			return safe64Url;
		}
	}

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

public static class SafeBase64UrlEncoder

{

private const string Plus = "+";

private const string Minus = "-";

private const string Slash = "/";

private const string Underscore = "_";

private const string EqualSign = "=";

private const string Pipe = "|";

private static readonly IDictionary<string, string> _mapper;

static SafeBase64UrlEncoder()

{

_mapper = new Dictionary<string, string> {{Plus, Minus}, {Slash, Underscore}, {EqualSign, Pipe}};

}

public static string EncodeBase64Url(this string base64Str)

{

if (string.IsNullOrEmpty(base64Str))

return base64Str;

foreach (var pair in _mapper)

{

base64Str = base64Str.Replace(pair.Key, pair.Value);

}

return base64Str;

}

public static string DecodeBase64Url(this string safe64Url)

{

if (string.IsNullOrEmpty(safe64Url))

return safe64Url;

foreach (var pair in _mapper)

{

safe64Url = safe64Url.Replace(pair.Value, pair.Key);

}

return safe64Url;

}

And always there should be a test for it.

[TestFixture]
	public class SafeBase64UrlTests
	{

		[Test]
		public void Encode64Url_Should_Replace_Plus_With_Minus()
		{
			var str = "+".EncodeBase64Url();

			Assert.That(str.Equals("-"),Is.True);
		}


		[Test]
		public void Encode64Url_Should_Replace_ThreePlus_With_ThreeMinus()
		{
			var str = "+++".EncodeBase64Url();

			Assert.That(str.Equals("---"), Is.True);
		}

		[Test]
		public void Decode64Url_Should_Replace_Minus_With_Plus()
		{
			var str = "-".DecodeBase64Url();

			Assert.That(str.Equals("+"), Is.True);
		}

		[Test]
		public void Decode64Url_Should_Replace_ThreeMinus_With_ThreePlus()
		{
			var str = "---".DecodeBase64Url();

			Assert.That(str.Equals("+++"), Is.True);
		}


		[Test]
		public void Encode64Url_Should_Replace_Slash_With_Underscore()
		{
			var str = "/".EncodeBase64Url();

			Assert.That(str.Equals("_"), Is.True);
		}

		[Test]
		public void Encode64Url_Should_Replace_ThreeSlash_With_ThreeUnderscore()
		{
			var str = "///".EncodeBase64Url();

			Assert.That(str.Equals("___"), Is.True);
		}

		[Test]
		public void Decode64Url_Should_Replace_Underscore_With_Slash()
		{
			var str = "_".DecodeBase64Url();

			Assert.That(str.Equals("/"), Is.True);
		}

		[Test]
		public void Decode64Url_Should_Replace_ThreeUnderscore_With_ThreeSlash()
		{
			var str = "___".DecodeBase64Url();

			Assert.That(str.Equals("///"), Is.True);
		}


		[Test]
		public void Encode64Url_Should_Replace_Equal_With_Pipe()
		{
			var str = "=".EncodeBase64Url();

			Assert.That(str.Equals("|"), Is.True);
		}

		[Test]
		public void Encode64Url_Should_Replace_ThreeEqual_With_ThreePipe()
		{
			var str = "===".EncodeBase64Url();

			Assert.That(str.Equals("|||"), Is.True);
		}


		[Test]
		public void Decode64Url_Should_Replace_Pipe_With_Equal()
		{
			var str = "|".DecodeBase64Url();

			Assert.That(str.Equals("="), Is.True);
		}

		[Test]
		public void Decode64Url_Should_Replace_ThreePipe_With_ThreeEqual()
		{
			var str = "|||".DecodeBase64Url();

			Assert.That(str.Equals("==="), Is.True);
		}


		[Test]
		public void Encode64Url_Should_Replace_EqualSlashPlus_With_MinusUnderscorePipe()
		{
			var str = "=+/".EncodeBase64Url();

			Assert.That(str.Equals("|-_"), Is.True);
		}
		

		[Test]
		public void Decode64Url_Should_Replace_MinusUnderscorePipe_With_EqualSlashPlus()
		{
			var str = "|-_".DecodeBase64Url();

			Assert.That(str.Equals("=+/"), Is.True);
		}


		[Test]
		public void Encode64Url_Should_Replace_EqualSlashPlus_With_MinusUnderscorePipe_With_Alpha_Numeric_Characters()
		{
			var str = "1A=2b+3C/4d".EncodeBase64Url();

			Assert.That(str.Equals("1A|2b-3C_4d"), Is.True);
		}


		[Test]
		public void Decode64Url_Should_Replace_MinusUnderscorePipe_With_EqualSlashPlus_With_Alpha_Numeric_Characters()
		{
			var str = "1a|2B-3c_4D".DecodeBase64Url();

			Assert.That(str.Equals("1a=2B+3c/4D"), Is.True);
		}



		[Test]
		public void Encode64Url_Should_Return_Same_String_When_Empty()
		{
			var str = string.Empty.EncodeBase64Url();

			Assert.That(string.IsNullOrEmpty(str), Is.True);
		}


		[Test]
		public void Decode64Url_Should_Return_Same_String_When_Empty()
		{
			var str = string.Empty.DecodeBase64Url();

			Assert.That(string.IsNullOrEmpty(str), Is.True);
		}


		[Test]
		public void Encode64Url_Should_Return_Same_String_When_Null()
		{
			string str = null;

			str = str.EncodeBase64Url();

			Assert.That(string.IsNullOrEmpty(str), Is.True);
		}


		[Test]
		public void Decode64Url_Should_Return_Same_String_When_Null()
		{
			string str = null;

			str = str.DecodeBase64Url();

			Assert.That(string.IsNullOrEmpty(str), Is.True);
		}

	
	}

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

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

[TestFixture]

public class SafeBase64UrlTests

{

[Test]

public void Encode64Url_Should_Replace_Plus_With_Minus()

{

var str = "+".EncodeBase64Url();

Assert.That(str.Equals("-"),Is.True);

}

[Test]

public void Encode64Url_Should_Replace_ThreePlus_With_ThreeMinus()

{

var str = "+++".EncodeBase64Url();

Assert.That(str.Equals("---"), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_Minus_With_Plus()

{

var str = "-".DecodeBase64Url();

Assert.That(str.Equals("+"), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_ThreeMinus_With_ThreePlus()

{

var str = "---".DecodeBase64Url();

Assert.That(str.Equals("+++"), Is.True);

}

[Test]

public void Encode64Url_Should_Replace_Slash_With_Underscore()

{

var str = "/".EncodeBase64Url();

Assert.That(str.Equals("_"), Is.True);

}

[Test]

public void Encode64Url_Should_Replace_ThreeSlash_With_ThreeUnderscore()

{

var str = "///".EncodeBase64Url();

Assert.That(str.Equals("___"), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_Underscore_With_Slash()

{

var str = "_".DecodeBase64Url();

Assert.That(str.Equals("/"), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_ThreeUnderscore_With_ThreeSlash()

{

var str = "___".DecodeBase64Url();

Assert.That(str.Equals("///"), Is.True);

}

[Test]

public void Encode64Url_Should_Replace_Equal_With_Pipe()

{

var str = "=".EncodeBase64Url();

Assert.That(str.Equals("|"), Is.True);

}

[Test]

public void Encode64Url_Should_Replace_ThreeEqual_With_ThreePipe()

{

var str = "===".EncodeBase64Url();

Assert.That(str.Equals("|||"), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_Pipe_With_Equal()

{

var str = "|".DecodeBase64Url();

Assert.That(str.Equals("="), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_ThreePipe_With_ThreeEqual()

{

var str = "|||".DecodeBase64Url();

Assert.That(str.Equals("==="), Is.True);

}

[Test]

public void Encode64Url_Should_Replace_EqualSlashPlus_With_MinusUnderscorePipe()

{

var str = "=+/".EncodeBase64Url();

Assert.That(str.Equals("|-_"), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_MinusUnderscorePipe_With_EqualSlashPlus()

{

var str = "|-_".DecodeBase64Url();

Assert.That(str.Equals("=+/"), Is.True);

}

[Test]

public void Encode64Url_Should_Replace_EqualSlashPlus_With_MinusUnderscorePipe_With_Alpha_Numeric_Characters()

{

var str = "1A=2b+3C/4d".EncodeBase64Url();

Assert.That(str.Equals("1A|2b-3C_4d"), Is.True);

}

[Test]

public void Decode64Url_Should_Replace_MinusUnderscorePipe_With_EqualSlashPlus_With_Alpha_Numeric_Characters()

{

var str = "1a|2B-3c_4D".DecodeBase64Url();

Assert.That(str.Equals("1a=2B+3c/4D"), Is.True);

}

[Test]

public void Encode64Url_Should_Return_Same_String_When_Empty()

{

var str = string.Empty.EncodeBase64Url();

Assert.That(string.IsNullOrEmpty(str), Is.True);

}

[Test]

public void Decode64Url_Should_Return_Same_String_When_Empty()

{

var str = string.Empty.DecodeBase64Url();

Assert.That(string.IsNullOrEmpty(str), Is.True);

}

[Test]

public void Encode64Url_Should_Return_Same_String_When_Null()

{

string str = null;

str = str.EncodeBase64Url();

Assert.That(string.IsNullOrEmpty(str), Is.True);

}

[Test]

public void Decode64Url_Should_Return_Same_String_When_Null()

{

string str = null;

str = str.DecodeBase64Url();

Assert.That(string.IsNullOrEmpty(str), Is.True);

}

There are other ways of fixing this and one can read them at
http://blogs.iis.net/thomad/archive/2007/12/17/iis7-rejecting-urls-containing.aspx
http://bentaylor.org/dasBlog-Patch-Add-Choice-Of-Dash-For-Post-Title-URL-Spaces.aspx

ASP .NET, Misc

base64, IIS7, url

Cannot find SQL Management Studio after install of SQL2005

Taswar Bhatti September 21, 2009 2 Comments

So was just in the process of installing SQL2005 on one of our VM to test some stuff. Guess what install went great with Client Tools selected, but unfortunately SQL Management Studio doesn’t get installed??? Why ohhh why?
I cannot find SQL Management Studio after install of SQL2005

So anyways, the solution is quite simple don’t use the installer again, simply go into the CD Drive: Tools\Setup Directory

and launch SqlRun_Tools.msi and remember to click on client tools and check the tree if everything is selected and then click on install. Then viola you will have SQL Server Management Studio.

Misc

sql, sql management studio

Learn The Sprout Method for adding new functionality

Taswar Bhatti August 31, 2009 3 Comments

In this Learn Series I am going to write about the Sprout Method which is in the book “Working Effectively with Legacy Code by Michael Feathers“, all I have to say is what a great book if you don’t have it, you should pick it up asap.

Sprout Method is a technique that one can use when one has to write a new feature into a system. The code will be formulated as new code, and you want to put the new code into a new method and call it where the new functionality needs to be.

The reason for Sprout method is that sometimes you cannot write unit test for the code that you want to change but you can use Test Driven Development to write unit test for the new code, so that at least the new code would be tested.

Let look at some code to see what that means.

public class FileUpdateManager
 {
       public void AppendFilesWithText(IList<string> filePath, string textToAppend)
        {
            foreach (var file in filePath)
            {
                if (File.Exists(file) && string.IsNullOrEmpty(textToAppend))
                    File.AppendAllText(file, textToAppend);
            }
            NotifyThatFilesHaveChangedByEmail(filePath);
        }
}

1

2

3

4

5

6

7

8

9

10

11

12

public class FileUpdateManager

{

public void AppendFilesWithText(IList<string> filePath, string textToAppend)

{

foreach (var file in filePath)

{

if (File.Exists(file) && string.IsNullOrEmpty(textToAppend))

File.AppendAllText(file, textToAppend);

}

NotifyThatFilesHaveChangedByEmail(filePath);

}

The code looks simple and now a change request has come in, the clients is requesting that they want to be notified of unique files names that would change. Not every file since there could be other files with same name but in different directory, and what is important is only one of them should be notified. Which make sense, since you don’t want to receive multiple emails on the same name files.

Your first instinct would be to call the method and pass in unique files, but you cannot do that since the call is being used somewhere that is out of your control or is ghetto code calling your code, code that no one wants to touch or change due to XYZ reason, so you need to think back and code into the method. Let see how we can change it.

public void AppendFilesWithText(IList<string> filePath, string textToAppend)
{
            filePath = filePath.Select(x => x).Distinct();

            foreach (var file in filePath)
            {
                if (File.Exists(file) && string.IsNullOrEmpty(textToAppend))
                    File.AppendAllText(file, textToAppend);
            }

            NotifyThatFilesHaveChanged(filePath);
}

1

2

3

4

5

6

7

8

9

10

11

12

public void AppendFilesWithText(IList<string> filePath, string textToAppend)

{

filePath = filePath.Select(x => x).Distinct();

foreach (var file in filePath)

{

if (File.Exists(file) && string.IsNullOrEmpty(textToAppend))

File.AppendAllText(file, textToAppend);

}

NotifyThatFilesHaveChanged(filePath);

}

We have added a LINQ query to find out the distinct elements but how do we know that our LINQ was correct or is doing the right thing. And we are making this method do two things, filtering and then appending.

So what we do is move that call to another method and write test against it. I have left out the test code just to make things shorter.

public void AppendFilesWithText(IList<string> filePath, string textToAppend)
{
            filePath = GetUniqueFilePath(filePath);

            foreach (var file in filePath)
            {
                if (File.Exists(file) && string.IsNullOrEmpty(textToAppend))
                    File.AppendAllText(file, textToAppend);
            }

            NotifyThatFilesHaveChanged(filePath);
        }

        public IList<string> GetUniqueFilePath(IList<string> filePath)
        {
            filePath = filePath.Select(x => x).Distinct();
            return filePath;
        }
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

public void AppendFilesWithText(IList<string> filePath, string textToAppend)

{

filePath = GetUniqueFilePath(filePath);

foreach (var file in filePath)

{

if (File.Exists(file) && string.IsNullOrEmpty(textToAppend))

File.AppendAllText(file, textToAppend);

}

NotifyThatFilesHaveChanged(filePath);

}

public IList<string> GetUniqueFilePath(IList<string> filePath)

{

filePath = filePath.Select(x => x).Distinct();

return filePath;

}

So here it is the Sprout Method and the advantages of it is you got your new code under test, the disadvantages is that you are not working on getting the entire code in test due to hard to break dependency or other reason that you may have and you might just not get it under test at all.

I would suggest the Sprout Method if you are starting TDD and would like to write little parts to get it under test and go from there at least you would get your feet wet.

All finally the methods as listed out in “Working Effectively with Legacy Code” for Sprout Method are:

Identify where you need to make your code change.
If the change can be formulated as a single sequence of statements in one place in a method, write down a call for a new method that will do the work involved and then comment it out. (I like to do this before I even write the method so that I can get a sense of what the method call will look like in context.)
Determine what local variables you need from the source method, and make them arguments to the call.
Determine whether the sprouted method will need to return values to source method. If so, change the call so that its return value is assigned to a variable.
Develop the sprout method using test-driven development.
Remove the comment in the source method to enable the call.

Design, Learn Series, unit testing

LINQ, Sprout Method, TDD, unit testing

Be mindful of the Null Pattern

Taswar Bhatti August 17, 2009 No Comments

Null Pattern

Last time I blogged about “Learn the Null Pattern“, but I forgot to mention one thing about the Null Pattern. That is you have to be mindful of it.

For example

foreach(var id in IDList)
{
        var employee = db.GetEmployee(id);
	salary = db.CalculateSalary(id);
	employee.Pay(salary);
}

1

2

3

4

5

6

foreach(var id in IDList)

{

var employee = db.GetEmployee(id);

salary = db.CalculateSalary(id);

employee.Pay(salary);

}

The code looks okay but what if the GetEmployee method actually returns a NullEmployee? Well that would still be okay, since when the Pay method is called it would just do nothing.

Now what if we did this though

var numberOfEmpolyeeWhoGotPaid = 0;
foreach(var id in IDList)
{
        var employee = db.GetEmployee(id);
	salary = db.CalculateSalary(id);
	employee.Pay(salary);
        numberOfEmpolyeeWhoGotPaid++;
}

1

2

3

4

5

6

7

8

var numberOfEmpolyeeWhoGotPaid = 0;

foreach(var id in IDList)

{

var employee = db.GetEmployee(id);

salary = db.CalculateSalary(id);

employee.Pay(salary);

numberOfEmpolyeeWhoGotPaid++;

}

Now we get into trouble since we counted even the Null Employee.
Again be mindful of Null Object Pattern when you use it, since it may cause you headache in the future of finding that nasty bug, but nevertheless the Null Object Pattern is still a very useful pattern under your belt.

.NET, Design

Design Pattern, Null Pattern

Be like Sylar my friend (A developer’s perspective)

Taswar Bhatti August 3, 2009 No Comments

So there is this character (antagonist) in this TV series “Heroes”, and his name is Sylar

People might also know him from the new Star Trek movie, where he plays the young Spock. Anyways, back to the Sylar character, in the show he plays a serial killer who kills people with ability (e.g flying, shooting fire out of hands, invisible, shape shifter etc etc) and takes on their ability/power after killing them.

That sounds awful as a character but some may say that does sound pretty cool, if you could take like Beethoven ability to play the piano or Jimi Hendrix guitar playing ability. So what does this have to do with software development you may ask?

The ability that I speak of could very well be from one of your fellow developer. S/he may have some ability/knowledge in software programming that you may not have learned yet. If you wish to take the ability try and set up some time with them so that you can learn from them. Try pair programming with them or have them show you some stuff, the next time you are near their cubicle or office. There is a lot you can learn from others, you can watch them use their IDE or Resharper short cut keys, or just their design principles they may use in their application development. Trust me most developer’s don’t mind showing off to their coworker its part of their job to act smart 🙂

I think the quote from a TED talk by John Wooden a basketball coach sums up my entry pretty well:

“Never try to be better than someone else, always learn from others, and never cease trying to be the best, since that is under your control”

Agile, Misc

Learn the Null Object

Taswar Bhatti June 2, 2009 No Comments

Today, I thought I would mention the Null Object design pattern, its an object that provides intelligent do nothing behavior, hiding the details from its collaborators.

So what does this mean??? Before I tell you what it means, lets see an example of how often you might be seeing code that is checking for null.

Let say we have a Person object, that is implementing an abstract or interface IPerson and there is a repository somewhere that finds the person for us.

//repository code
public IPerson Find(int id)
{
    if(db.UserExist(id))
       return db.GetPerson(id);

    return null;
}
//repository code end

//main code
var person = repository.Find(999);
PrintPerson(person);

public void PrintPerson(IPerson p)
{
   Console.WriteLine(person.Firstname);
   Console.WriteLine(person.Lastname);
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

//repository code

public IPerson Find(int id)

{

if(db.UserExist(id))

return db.GetPerson(id);

return null;

}

//repository code end

//main code

var person = repository.Find(999);

PrintPerson(person);

public void PrintPerson(IPerson p)

{

Console.WriteLine(person.Firstname);

Console.WriteLine(person.Lastname);

}

What happens when we don’t find the person, since the Find method above returns null, we end up with NullReferenceException thrown, because we are calling person.Firstname in the PrintPerson method.

So in order to fix the code we write if statements around it like so

if(person != null)
 PrintPerson(person);
else
   DoSomethingElse();

1

2

3

4

if(person != null)

PrintPerson(person);

else

DoSomethingElse();

And we keep writing code with the if statement over and over, every time we want to find we need to check the if(person != null). That is just too painful in my opinion.

So how do we fix it. We use the NullObject, and here is how it looks like in UML.

Null Object

Basically we create another class that implements the interface or abstract class and all its methods and properties implementations does nothing, an example below

public interface IPerson
{
	string Firstname { get; set;}
	string Lastname { get; set; }
	void DoSomething();
	int CalculateSalary();
}
	
public class NullPerson: IPerson
{
    public string Firstname { get; set; }
	
    public string Lastname { get; set; }
		
    public void DoSomething() { }
		
    public int CalculateSalary() { return 0; }
	
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

public interface IPerson

{

string Firstname { get; set;}

string Lastname { get; set; }

void DoSomething();

int CalculateSalary();

}

public class NullPerson: IPerson

{

public string Firstname { get; set; }

public string Lastname { get; set; }

public void DoSomething() { }

public int CalculateSalary() { return 0; }

}

As you can see the NullPerson has no implementation code in the DoSomething method and it returns 0 for CalculateSalary.
Back in the repository code we will have to return NullPerson rather than null when we can’t find the person.

public IPerson Find(int id)
{
    if(db.UserExist(id)
       return db.GetPerson(id);

    return new NullPerson();
}

1

2

3

4

5

6

7

public IPerson Find(int id)

{

if(db.UserExist(id)

return db.GetPerson(id);

return new NullPerson();

}

From here onwards you can eliminate most of your person != null code. Since whatever method or property you call on it, it would never fail and never return you a NullReferenceException.

You could do something like

var person = repository.Find(999);
PrintPerson(person);

person.DoSomething();
var salary = person.CalcuateSalary();
//etc etc

1

2

3

4

5

6

var person = repository.Find(999);

PrintPerson(person);

person.DoSomething();

var salary = person.CalcuateSalary();

//etc etc

Our code would not be littered, and we could start writing code that is more elegant that does not contain those nasty if (x == null) statements all over the place. Do remember we might have to implement more NullObjects for other classes that we will be using rather than mishmash of null and NullObject, which would make it ugly.

This pattern helps us realize that we sometimes don’t really want to know if the Get or Find method returns null or not we just want to do something like

var person = repository.Find(999);
person.CallWebService();
var call = person.MakeAPhoneCall();
//since MakeAPhoneCall returns a NullCall this would keep passing
call.Dial(123);
//etc etc

1

2

3

4

5

6

var person = repository.Find(999);

person.CallWebService();

var call = person.MakeAPhoneCall();

//since MakeAPhoneCall returns a NullCall this would keep passing

call.Dial(123);

//etc etc

One may also say that there might be cases where you want to an error message, then we can use this way to solve the issue

if(repository.PersonExist(999))
   //Found person
else
   //error message to screen

1

2

3

4

if(repository.PersonExist(999))

//Found person

else

//error message to screen

The NullObject is a very simple idea and once you start using it, you would truly get hooked on it and see the power of something so simple. We then start not caring about those if statements and an added benefit is that our code would be much cleaner and easier to read for others.

Design, Learn Series

Null Object Pattern

Learn the Observer Pattern with Event & Delegate

Taswar Bhatti May 11, 2009 No Comments

As promised here is the version of observer pattern with Event & Delegate. Personally I am not a big fan of this solution, although it does remove quite a bit of code and show how to use a push model with the observer pattern. Next time around I will show a more elegant solution by using Event Aggregator.

But for now lets see how I implemented Observer Pattern with Event/Delegate.

First I tackled the Subject of our class, the thing you will see different is there is an instance object called TextChanged and is an EventHandler, the second change is it Notify method. I also removed the ISubject interface just because there isn’t really a need for it in this example and to make things simple.

using System;
using System.Collections.Generic;

namespace EventDelegatePattern
{
    public class Subject
    {
        public event EventHandler<TextLangChangedEventArgs> TextChanged;

        private readonly IList<string> _stateList = new List<string>();


        public Subject()
        {
            InitState();
        }


        private void InitState()
        {
            _stateList.Add("Hello");
            _stateList.Add("World");
            _stateList.Add("Goodbye");
            _stateList.Add("Cat");
            _stateList.Add("Dog");
            _stateList.Add("Apple");
            _stateList.Add("Man");
            _stateList.Add("Women");
            _stateList.Add("Groovy");
        }


        private string CurrentTextToDisplay
        {
            get
            {
                var random = new Random();
                var i = random.Next(_stateList.Count);
                return _stateList[i];
            }
        }
        

        public void Notify()
        {
            if (TextChanged != null)
            {
                TextChanged(this, new TextLangChangedEventArgs(CurrentTextToDisplay));
            }
        }
    }
}

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

using System;

using System.Collections.Generic;

namespace EventDelegatePattern

{

public class Subject

{

public event EventHandler<TextLangChangedEventArgs> TextChanged;

private readonly IList<string> _stateList = new List<string>();

public Subject()

{

InitState();

}

private void InitState()

{

_stateList.Add("Hello");

_stateList.Add("World");

_stateList.Add("Goodbye");

_stateList.Add("Cat");

_stateList.Add("Dog");

_stateList.Add("Apple");

_stateList.Add("Man");

_stateList.Add("Women");

_stateList.Add("Groovy");

}

private string CurrentTextToDisplay

{

get

{

var random = new Random();

var i = random.Next(_stateList.Count);

return _stateList[i];

}

public void Notify()

{

if (TextChanged != null)

{

TextChanged(this, new TextLangChangedEventArgs(CurrentTextToDisplay));

}

From the above code you will see that there is an object called TextLangChangedEventArgs, that is basically our data object that would be pushed to the observer. Here is how it looks like, the important part is that it extends/inherits from EventArgs

using System;

namespace EventDelegatePattern
{
    public class TextLangChangedEventArgs: EventArgs
    {
        public TextLangChangedEventArgs(string newLang)
        {
            NewLanguage = newLang;
        }

        public string NewLanguage { get; private set; }

    }
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

using System;

namespace EventDelegatePattern

{

public class TextLangChangedEventArgs: EventArgs

{

public TextLangChangedEventArgs(string newLang)

{

NewLanguage = newLang;

}

public string NewLanguage { get; private set; }

}

Finally back to our WPFApp, we again have 2 labels the Turkish and English one, but they both don’t know anything about the Subject which is a good thing, so that it is loosely coupled. In order for the subject to hook into them they provide a signature where the event will call it.

using System.Windows.Controls;
using EventDelegatePattern;

namespace WPFApp
{
    /// <summary>
    /// Interaction logic for EnglishLableControl.xaml
    /// </summary>
    public partial class EnglishLableControl : UserControl
    {
        public EnglishLableControl()
        {
            InitializeComponent();
        }


        public void Update(object source, TextLangChangedEventArgs args)
        {
            label1.Content = args.NewLanguage;
        }
    }
}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

using System.Windows.Controls;

using EventDelegatePattern;

namespace WPFApp

{

/// <summary>

/// Interaction logic for EnglishLableControl.xaml

/// </summary>

public partial class EnglishLableControl : UserControl

{

public EnglishLableControl()

{

InitializeComponent();

}

public void Update(object source, TextLangChangedEventArgs args)

{

label1.Content = args.NewLanguage;

}

Turkish UserControl does the translation of English to Turkish

using System.Collections.Generic;
using System.Windows.Controls;
using EventDelegatePattern;

namespace WPFApp
{
    /// <summary>
    /// Interaction logic for TurkishLabelControl.xaml
    /// </summary>
    public partial class TurkishLabelControl : UserControl
    {

        private IDictionary<string, string> _dict = new Dictionary<string, string>();

        public TurkishLabelControl()
        {
            InitializeComponent();
            InitDict();
        }

        private void InitDict()
        {
            _dict.Add("Hello", "Merhaba");
            _dict.Add("World", "Dünya");
            _dict.Add("Goodbye", "Güle Güle");
            _dict.Add("Cat", "Kedi");
            _dict.Add("Dog", "Köpek");
            _dict.Add("Apple", "Elma");
            _dict.Add("Man", "Adam");
            _dict.Add("Women", "Kadin");
        }


        public void Update(object source, TextLangChangedEventArgs args)
        {            
            label1.Content = _dict.ContainsKey(args.NewLanguage) ? _dict[args.NewLanguage] : "Cannot find it in turkish";
        }
    }
}

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

using System.Collections.Generic;

using System.Windows.Controls;

using EventDelegatePattern;

namespace WPFApp

{

/// <summary>

/// Interaction logic for TurkishLabelControl.xaml

/// </summary>

public partial class TurkishLabelControl : UserControl

{

private IDictionary<string, string> _dict = new Dictionary<string, string>();

public TurkishLabelControl()

{

InitializeComponent();

InitDict();

}

private void InitDict()

{

_dict.Add("Hello", "Merhaba");

_dict.Add("World", "Dünya");

_dict.Add("Goodbye", "Güle Güle");

_dict.Add("Cat", "Kedi");

_dict.Add("Dog", "Köpek");

_dict.Add("Apple", "Elma");

_dict.Add("Man", "Adam");

_dict.Add("Women", "Kadin");

}

public void Update(object source, TextLangChangedEventArgs args)

{

label1.Content = _dict.ContainsKey(args.NewLanguage) ? _dict[args.NewLanguage] : "Cannot find it in turkish";

}

Last but not least here is the WPFApp

using System.Windows;
using EventDelegatePattern;

namespace WPFApp
{
    /// <summary>
    /// Interaction logic for Window1.xaml
    /// </summary>
    public partial class Window1 : Window
    {
        private Subject _subject = new Subject();

        public Window1()
        {
            InitializeComponent();
            _subject.TextChanged += TurkishLabel.Update;
            _subject.TextChanged += EnglishLabel.Update;
        }

        private void button1_Click(object sender, RoutedEventArgs e)
        {
            _subject.Notify();
        }       
    }
}

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

using System.Windows;

using EventDelegatePattern;

namespace WPFApp

{

/// <summary>

/// Interaction logic for Window1.xaml

/// </summary>

public partial class Window1 : Window

{

private Subject _subject = new Subject();

public Window1()

{

InitializeComponent();

_subject.TextChanged += TurkishLabel.Update;

_subject.TextChanged += EnglishLabel.Update;

}

private void button1_Click(object sender, RoutedEventArgs e)

{

_subject.Notify();

}

I have not posted the XAML code but one can download the source and solution.

For next time I would like to show a more elegant solution called Event Aggregator which is a pretty cool pattern introduced by Martin Flower that allows one to write extensible code.

Design, Learn Series

Delegates, Design Pattern, Events, observer pattern

Asp .NET Redirect To SSL HttpModule

Url Helper Extension Method for ASP MVC in form tags when using IIS 6

Learn to use PowerShell to extract data from RSS

Safe Base64 Url in ASP .NET

Cannot find SQL Management Studio after install of SQL2005

Learn The Sprout Method for adding new functionality

Be mindful of the Null Pattern

Null Pattern

Be like Sylar my friend (A developer’s perspective)

Learn the Null Object

Learn the Observer Pattern with Event & Delegate

Opinions are my own and not the views of my employer

LinkedIn

My Book

Archives