Simple ASP.NET Localization

I've seen a lot of solutions for localization in ASP.NET -- many of which use a database to store the localized content. The problem with this approach is that you have to recreate the tools that you are already using. Specifically: text editors (now you need an admin site to update the database content), source control (now you need revision history), content uploading (now you need an SSIS or custom Windows Service to deploy content). It's a bigger project than you want.

Generally, whenever HTML goes into a database (apart from a Forum), I question the need. The reason being that HTML is code and code belongs in Source Control. If Developers are the only ones updating the content (we're not talking about CMSs here) then why force them to use tools they aren't familiar with to do the same job they do all day long?

A solution that I've found that works well is to use an HTTP Module and a Localized directory of files. First, let's go over the HTTP Module.


/// 
/// Rewrites URLs to Custom Pages if they exist
/// 
public class LocalizationModule : IHttpModule
{
 public void Init(HttpApplication app)
 {
  app.BeginRequest += OnBeginRequest;
 }

 private void OnBeginRequest(object src, EventArgs e)
 {
  // Replace the below with a way to determine culture however you'd like
  string culture = SomeService.GetCulture();
  if (String.IsNullOrEmpty(culture)) return;
  
  HttpApplication app = src as HttpApplication;
  if (app == null) return;

  string fullPath = app.Request.Path;
  string possiblePath = app.Context.Server.MapPath("/" + ConfigurationManager.AppSettings["LocalizationDirectory"]) + "\\" + culture + fullPath.Replace("/", "\\");

  if (File.Exists(possiblePath.ToLower()))
  {
   string virtualPath = "/" + ConfigurationManager.AppSettings["LocalizationDirectory"] + "/" + culture + fullPath;

   app.Context.RewritePath(virtualPath);
  }
 
 }

 public void Dispose()
 {

 }
}


The "SomeService.GetCulture()" can be anything. I've made GetCulture return the culture code using Cookies (with a value of say "fr-FR"), the URL (i.e. "http://www.somesite.com/en-US/page.aspx") or even based on a drop down selection.

The content of your site can live within a specified folder, see:

Localization Module Example

The HTTP module will then serve up the corresponding page in the localization directory.

Pretty simple stuff. It's a LOT easier to manage than some database localization solutions. I highly recommend using flat files for content that is only going to be touched by developers -- after all -- we're used to it.

Comments

Post a Comment

Popular posts from this blog

Fluent NHibernate - Incorrect syntax near the keyword 'Group'

I have to share this. I spent a good amount of time searching around Fluent NHibernate for a way to escape columns in the generated SQL while still using AutoMapping. My initial configuration looked like: Fluently.Configure() .Database(MsSqlConfiguration.MsSql2005.ConnectionString( c => c.Is(ConfigurationManager.ConnectionStrings["Something"].ConnectionString))) .Mappings(x => x.AutoMappings.Add(AutoPersistenceModel.MapEntitiesFromAssemblyOf () .WithSetup(convention => { convention.FindIdentity = p => p.Name == p.DeclaringType.Name + "Id"; convention.GetComponentColumnPrefix = type => type.Name + "Id"; } ) .BuildSessionFactory() This works great, but I had a property in my class (SomeType) that is called Group. This was causing the SqlException: Incorrect syntax near the keyword 'Group' (others would be like: Incorrect syntax near the keyword 'User' or Incorrect syntax near the keyword ...
Read more

Fluent NHibernate + Encrypting Values

I recently created two CLR User Defined Functions for SQL Server 2005 (written in C#) to decrypt & encrypt a given string (based on a hard-coded key). select dbo.EncryptString('Testing') -- Returns: Fjfds243qcm43fsdj2343== select dbo.DecryptString('Fjfds243qcm43fsdj2343==') -- Returns: Testing Pretty simple stuff. This will allow the user with enough access to pull encrypted data out of the database and provide the ability to restrict decryption to other SQL users. Now to implement this in code... Because it's awesome, Fluent NHibernate has a method called FormulasIs that assists in building out values using SQL. public class User { public virtual int Id { get; set; } public virtual DateTime DateOfBirth { get; set; } } public sealed class UserMap : ClassMap { public UserMap() { WithTable("dbo.[User]"); Id(x => x.Id, "[ID]"); Map(x => x.DateOfBirth, "DOB").FormulaIs("dbo.DecryptString(DOB)"); ...
Read more

MapReduce in C# using Task Parallel Library

Back in August I starting playing with a C# implementation of Google's MapReduce algorithm. The implementation was based on something Stephan Brenner did, although I completely refactored it. Today I added a little bit of logic to split up the actual execution of Map & Reduce in this implementation using the Task Parallel Library in .NET 4.0. Check out the source code for MapReduce in C# on GitHub. Below is an excerpt from the Tests on how to implement the library. Counting Words in Files public static List<KeyValuePair<string, int>> Map(FileInfo document, string text) { var items = text.Split('\n', ' ', '.', ',','\r'); return items.Select(item => new KeyValuePair<string, int>(item, 1)).ToList(); } public static List<int> Reduce(string word, List<int> wordCounts) { if (wordCounts == null) return null; var result = new List<int> { 0 }; foreach (var value in wordC...
Read more