Rewrite engine

A rewrite engine is a software component that performs rewriting on Uniform Resource Locators, modifying their appearance. This modification is called URL rewriting. It is a way of implementing URL mapping or routing within a web application. The engine is typically a component of a web server or web application framework. Rewritten URLs (sometimes known as short, pretty or fancy URLs, search engine friendly - SEF URLs, or slugs) are used to provide shorter and more relevant-looking links to web pages. The technique adds a layer of abstraction between the files used to generate a web page and the URL that is presented to the outside world.

Usage

Web sites with dynamic content can use URLs that generate pages from the server using query string parameters. These are often rewritten to resemble URLs for static pages on a site with a subdirectory hierarchy. For example, the URL to a wiki page might be:

http://example.com/w/index.php?title=Page_title

but can be rewritten as:

http://example.com/wiki/Page_title

A blog might have a URL that encodes the dates of each entry:

http://www.example.com/Blog/Posts.php?Year=2006&Month=12&Day=19

It can be altered like this:

http://www.example.com/Blog/2006/12/19/

which also allows the user to change the URL to see all postings available in December, simply by removing the text encoding the day '19', as though navigating "up" a directory:

http://www.example.com/Blog/2006/12/

A site can pass specialized terms from the URL to its search engine as a search term. This would allow users to search directly from their browser. For example, the URL as entered into the browser's location bar:

http://example.com/search term

Will be urlencoded by the browser before it makes the HTTP request. The server could rewrite this to:

http://example.com/search.php?q=search%20term

Benefits and drawbacks

There are several benefits to using URL rewriting:^[1]

• The links are "cleaner" and more descriptive, improving their "friendliness" to both users and search engines.
• They prevent undesired "inline linking", which can waste bandwidth.
• The site can continue to use the same URLs even if the underlying technology used to serve them is changed (for example, switching to a new blogging engine).

There can, however be drawbacks as well; if a user wants to modify a URL to retrieve new data, URL rewriting may hinder the construction of custom queries due to the lack of named variables. For example, it may be difficult to determine the date from the following format:

http://www.example.com/Blog/06/04/02/

In this case, the original query string was more useful, since the query variables indicated month and day:

http://www.example.com/Blog/Posts.php?Year=2006&Month=04&Day=02

Web frameworks

Many web frameworks include URL rewriting, either directly or through extension modules.

• Apache HTTP Server has URL rewriting provided by the mod_rewrite module.^[2]
• URL Rewrite is available as an extension to Microsoft IIS.^[3]
• Ruby on Rails has built-in URL rewriting via Routes.^[4]
• Java, and Servlet/Java EE have extendable URL rewriting via the OCPsoft URLRewriteFilter and Tuckey UrlRewriteFilter.
• Java Server Faces, Java EE, and Servlet have simplified URL rewriting via the PrettyFaces: URLRewriteFilter.
• Django uses a regular-expressions based system. This is not strictly URL rewriting since there is no script to 'rewrite' to, nor even a directory structure; but it provides the full flexibility of URL rewriting.^[5]
• Java Stripes Framework has had integrated functionality since version 1.5.^[6]
• Many Perl frameworks, such as Mojolicious and Catalyst, have this feature.^[7]
• CodeIgniter has URL rewriting provided.
• lighttpd has a mod_rewrite module.^[8]
• nginx has a rewrite module.^[9][10] Not only can it be used to manipulate URLs in various degrees for both internal and HTTP 301/302 status code redirection, but even 200 OK HTTP response message body generation is also possible with the return directive, making it viable to create rather advanced deterministic URL shortening services not limited to direct HTTP status code redirects.^[11] As an example, a multi-link multi-variable page generation from a URI like /f101,n61,o56,d/ifconfig is possible, where multiple individual parts like f101 get expanded with the help of regular expressions into variables to signify FreeBSD 10.1-RELEASE and so forth, and the generated page has links to multiple unique external URLs all at once, all done through internal variables and multiple location, rewrite and return directives.^[12]
• Hiawatha HTTP server has a URL Toolkit which supports URL rewriting.^[13]
• Cherokee HTTP server supports regular expressions of URL rewriting and redirections.

From a software development perspective, URL rewriting can aid in code modularization and control flow,^[14] making it a useful feature of modern web frameworks.

See also

• Application Delivery Controller
• aiScaler Traffic Manager
• .htaccess
• Apache HTTP Server
• Content negotiation
• HTTP
• Internet Information Server
• Permalink
• Zeus Web Server

Notes

1. Many of these only apply to HTTP servers whose default behavior is to map URLs to filesystem entities (i.e. files and directories); certain environments, such as many HTTP application server platforms, make this irrelevant.
2. mod_rewrite documentation
3. URL Rewrite extension for Microsoft IIS
4. "Rails Routing from the Outside In". "Ruby on Rails. Retrieved 25 April 2014.
5. Django URLconf
6. clean urls in Stripes 1.5
7. Guides - Mojolicious guide to the galaxy. Mojolicious. Retrieved on 2013-09-08.
8. Docs ModRewrite - Lighttpd - lighty labs. Redmine.lighttpd.net. Retrieved on 2013-09-08.
9. "ngx_http_rewrite_module - rewrite". nginx.org. Retrieved 25 December 2014.
10. Murenin, Constantine A. (18 February 2013). "A dynamic web-site written wholly in nginx.conf? Introducing mdoc.su!". [e-mail] (Mailing list). Retrieved 24 December 2014.
11. Murenin, Constantine A. (23 February 2013). "mdoc.su — Short manual page URLs for FreeBSD, OpenBSD, NetBSD and DragonFly BSD". Retrieved 25 December 2014.
12. Murenin, Constantine A. (23 February 2013). "mdoc.su.nginx.conf". Retrieved 25 December 2014.
13. URL TOOLKIT part of Hiawatha webserver's manual
14. "Clean URL". DocForge. Retrieved 25 April 2014.

External links

• Apache mod_rewrite
• A thorough discussion of using the Apache rewrite engine to speed page-loading, running scripts, as well as the long-process effect. Contains usable code.