The Url Tracker for Umbraco
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
DataType [Bugfix] Sometimes the installer was stuck at "Installing database ta… Aug 30, 2013
Exceptions Changed some stuff for a NuGet package Dec 19, 2014
Extensions
Helpers
Models Manual Merge of #105 Sep 27, 2017
Modules Added Events (v3.15) Jan 29, 2018
Properties Added Events (v3.15) Jan 29, 2018
Providers Fixed #70 May 1, 2015
Repositories Convert 410 to 301 (#168) Sep 26, 2017
SQL Changed some stuff for a NuGet package Dec 19, 2014
UI Updating docs for version 3.12 Oct 11, 2016
build
lib Umbraco 7.6 Updates Aug 24, 2017
.gitignore Initial AppVeyor setup. Will send pre-release packages to Nuget Oct 11, 2016
LICENSE Added MIT LICENSE Aug 6, 2013
README.md Added Events (v3.15) Jan 29, 2018
UrlTracker.csproj Just use Umbraco core logging, fixes #171 Sep 26, 2017
UrlTracker.nuspec Added Events (v3.15) Jan 29, 2018
UrlTracker.sln Fixed resources, added lib assemblies Jun 13, 2013
UrlTrackerApplicationEventHandler.cs Convert 410 to 301 (#168) Sep 26, 2017
UrlTrackerPreApplicationStart.cs [Bugfix] Sometimes the installer was stuck at "Installing database ta… Aug 30, 2013
UrlTrackerResources.cs
UrlTrackerSettings.cs
appveyor.yml Re-adding tag restriction for pushing to NuGet Oct 13, 2016
readme.txt Initial AppVeyor setup. Will send pre-release packages to Nuget Oct 11, 2016
web.config Umbraco 7.6 Updates Aug 24, 2017

README.md

UrlTracker

Build status Nuget MyGet

The Url Tracker is used to manage URLs within umbraco. It automatically tracks URL changes, for instance when a node is renamed, and makes sure the old URL will redirect to the new location. This is great for SEO and great for people visiting your website via this old URL. Search engines will update the indexed URL and people won't visit the old, broken URL.
You can also create your own redirects, based on a simple URL or using a Regex pattern. You can redirect to an existing node or a manually entered URL. This is great for migrating existing indexed URLs to your new website!

Umbraco 7.3.0 - 7.3.5

Umbraco 7.3.0 - 7.3.5 have known issues with the Url Tracker. These are resolved in Umbraco 7.3.6 and 7.4, so please don't use 7.3.0 - 7.3.5 in combination with the Url Tracker.

Versioning

Version 2 has reached it's end-of-life status and won't be supported anymore. For umbraco versions 4.6 - 6.0 version 2 will remain available as well as the source of v2.
Version 3 is the current version and supports umbraco versions 6.1, 7.0, 7.1 and up if possible.

Issues / feature requests

If you'd like to report a bug or request a new feature, please use the Github issue tracker, please don't use Twitter for example, because I won't be able to deal with requests outside Github (will become a mess sooner or later).

Features

  • Keeps track of URL changes (node gets renamed, moved or the umbracoUrlName property changes)
  • Keeps track of not found (404) requests, so you can easily create redirects for them
  • Keeps track of removed content and responds with 410 Gone when one requests it
  • Redirects requests for old URLs to their new location
  • Create your own URL redirects, based on a simple URL or a Regex pattern. You can redirect to an existing node or a manually entered URL.
  • Create permanent (301) or temporary (302) redirects
  • Supports all extensions, including .php and .html
  • Supports all kinds of query string options, like matching a query string and pass through the request query string
  • Supports multiple websites in a single umbraco instance

Settings

The Url Tracker supports a few settings, which you can use in the appSettings section of your web.config. Below you'll find these settings, with the type and default value mentioned below the setting name:

urlTracker:disabled

boolean (false)

Set to true to disable the HTTP Module of the Url Tracker, so it won't redirect requests anymore.

urlTracker:enableLogging

boolean (false)

Set to true to enable logging debug information of the Url Tracker. Uses umbraco's built-in logging mechanism with LogType set to 'debug'.
umbracoDebugMode needs to be enabled too.

urlTracker:404UrlsToIgnore

comma-seperated string (empty)

The Url Tracker logs requests resulting in a 404 Not Found status. Some URLs shouldn't be logged and can be set here. One URL is always ignored by default: 'favicon.ico'.
You can also ignore logging a 404 Not Found entry for certain requests, by adding an HTTP header 'X-UrlTracker-Ignore404' with value '1'

urlTracker:trackingDisabled

boolean (false)

Set to true to disable tracking URL changes.

urlTracker:notFoundTrackingDisabled

boolean (false)

Set to true to disable tracking not found (404) requests.

urlTracker:appendPortNumber

boolean (true)

Set to false to disable appending a port number to redirect URLs

urlTracker:forcedRedirectCacheTimeoutEnabled

boolean(false)

Set to true to cache forced redirects for a period of time. Setting this to true will enable forced redirect updates and additions to propagate to all servers in a multi-server environment.

urlTracker:forcedRedirectCacheTimeoutSeconds

int (14400)

Amount of time, in seconds, that the forced redirects will be cached for. Default is 14400 seconds (4 hours). The default value will be used when the app setting is less than 1. This setting does nothing unless urlTracker:forcedRedirectCacheTimeoutEnabled is true.

Events

You can customise the HttpResponse object from the Url Tracker, should you need to change the status code or other types of output.

The following code sample will detect if we're a 410 response, and if so attempt to render the 404 template as defined in umbracoSettings. If it fails it will simply return a 404 status code. This code should be placed within the Umbraco startup events s

public void OnApplicationStarted(UmbracoApplicationBase umbracoApplication, ApplicationContext applicationContext)
{
	InfoCaster.Umbraco.UrlTracker.Modules.UrlTrackerModule.PreUrlTracker += UrlTrackerModule_PreUrlTracker;

	private void UrlTrackerModule_PreUrlTracker(object sender, HttpResponse e)
	{

		var errorPage = UmbracoConfig.For.UmbracoSettings().Content.Error404Collection.FirstOrDefault();

		if (errorPage != null && errorPage.HasContentId && errorPage.ContentId != 1)
		{
			var template = new UmbracoHelper(UmbracoContext.Current).RenderTemplate(errorPage.ContentId);
			e.Write(template);
		}
		else
		{
			if (e.StatusCode == 410)
			{
				e.StatusCode = 404;
			}
		}
	}
}

Changelog

  • 3.15 [2018/01/28]
    • [Enhancement] Added custom events (#91)
    • [Bugfix] Checked if a reserved path/URL has a value (#183)
  • 3.14.1 [2017/11/11]
    • [Bugfix] Fixed a bug where forced redirects were ignored (#176)
  • 3.14 [2017/11/06]
    • This release includes the fixes from the previous BETA builds
  • 3.14-beta2 [2017/09/27]
    • [Bugfix] Removed excessive logging (#172)
    • [Bugfix] Performance fixes for multiple domains (#105)
  • 3.14-beta [2017/09/26]
    • [Bugfix] Only subscribe to each event once. This should help with performance (#169, #167, #166)
    • [Bugfix] Convert 410 entries to 301 when a node is republished (#168)
  • 3.13 [2017/09/05]
    • Switched to Umbraco's EndRequest event to prevent MetaData Reader error (#146) (#163)
  • 3.12 [2016/10/11]
    • 404 keyword search performance improvements (#102)
    • [Bugfix] Forced regex redirect for a domain is applied to all domains (#125)
    • [Bugfix] Edit pages can save values from previously viewed redirect (#127)
    • [Bugfix] Forced redirect cache not updated in multi-server environment (#130)
    • [Bugfix] Fix Collection was modified error (#100)
  • 3.11 [2016/02/26]
    • [BugFix] Changed the force redirect event handler to PostResolveRequestCache instead of AcquireRequestState (Simple Redirect doesn't work (#117)
  • 3.10 [2016/01/04]
  • 3.9 [2015/07/09]
    • [BugFix] Not allowed root "/" in old url (#79)
    • [BugFix] AdvanceView is throwing an exception when having a single domain configured in umbraco (#86)
    • [BugFix] Fixed possible Null Reference exception while looping through the forced redirects collection
  • 3.8 [2015/05/22]
    • [BugFix] Redirects were not working in some cases, for example (Not working - it returns 404)
    • [Improvement] Performance improvement; no SQL queries will be performed anymore for valid requests :-)
  • 3.7 [2015/05/01]
    • [BugFix] Exception on install (#70)
  • 3.6 [2015/03/21]
    • [BugFix] Rootnode resolving bug fixed (#69)
  • 3.5 [2015/02/20]
    • [BugFix] Date in the changelog of v3.4 was wrong
    • [BugFix] Manual redirects not working with root set to / (#62)
    • [Improvement] 404 Not Found View CSS (#27)
  • 3.4 [2015/01/28]
    • [BugFix] "Remove at" not working properly (#49)
    • [BugFix] Error during installation: 'ASP.UmbracoHelper' does not contain a definition for 'IsVersion7OrNewer' (#52)
    • [BugFix] JavaScripts errors in backend in IE11 (#31, updated jQuery)
    • [Feature] Domain on child node with cross site/host redirects (#40)
  • 3.3 [2014/12/11]
    • [BugFix] The UrlTracker dashboard wasn't working in some cases since v3.2
  • 3.2 [2014/11/14]
    • [Feature] Added new setting for appending the port number. Useful for when the site is running on a non-standard port number thanks to Greg Fyans
    • [BugFix] Fixed paths to relative paths, so it works in root and virtual folders thanks to Sandro Mastronardi
    • [BugFix] 410 Gone response wasn't working anymore
  • 3.1 [2014/11/13]
    • [Improvement] SQL Compact Edition is now supported thanks to Ornella Geboers and Sandro Mastronardi
    • [Improvement] Versioning is now based on major.minor.build.revision (source)
  • 3.0.2 [2014/09/11]
    • [BugFix] Added exception handling if Application.SqlHelper throws an ArgumentNullException
  • 3.0.1 [2014/06/09]
    • [BugFix] Fixed an issue with the installer (table does not exist: #14)
  • 3.0.0 [2014/06/27]
    • [Upgrade] All code has been rewritten to use the new services and models of umbraco v6.1
    • [BugFix] URL changes are tracked again (#9)
    • [BugFix] 410 Gone response now gets lower priority than other response codes
    • [Improvement] Improved performance, removed hitting the DB for every single request, added caching instead
    • [Dropped] Dropped support for pre-6.1 umbraco versions
  • 2.6.2 - EOL [2014/06/23]
    • [BugFix] The 'if not exists'-check for the table index wasn't working correctly
  • 2.6.1 [2014/06/23]
    • [BugFix] Added 'if not exists'-check for table index
  • 2.6.0 [2014/06/20]
    • [BugFix] Huge performance increase
    • [BugFix] URL was being wrongly decoded when redirecting
  • 2.5.3 [2014/01/30]
    • [BugFix] Fixed a small bug with the automatic comments
    • [Feature] Added a button to the not found (404) view to clear all not found entries
    • [Feature] Added a config setting to disable tracking not found (404) requests
  • 2.5.2 [2014/01/24]
    • [BugFix] Fixed an issue with path hostnames
  • 2.5.1 [2014/01/22]
    • [BugFix] Fixed an issue with domains with only a language and no hostname attached to it (GertyEngrie)
    • [BugFix] Replacing a redirect node with a redirect URL didn't work (GertyEngrie)
  • 2.5.0 [2014/01/15]
  • 2.4.7 [2014/01/15]
    • [Bugfix] Fixed an issue with the Old URL field in the Not Found create redirect view
    • [Feature] Added the option to disable logging 404 Not Found to the UrlTracker by adding an HTTP header 'X-UrlTracker-Ignore404' with value '1' for a certain request
  • 2.4.6 [2014/01/15]
    • [Bugfix] Fixed a small issue which occurred if the umbracoDbDSN isn't set
  • 2.4.5 [2014/01/10]
  • 2.4.4 [2014/01/03]
    • [Bugfix] Fixed a silly bug which caused the 'Delete selected' button to be hidden
  • 2.4.3 [2013/12/19]
    • [Bugfix] UI handles unpublished redirect nodes again (hide)
    • [Feature] Added the option to change the pagesize of the entries and not-found tables (saved in cookie)
    • [Improvement] Decreased the general font-size of the UI to 12px to match umbraco
    • [Improvement] Performance improvements
  • 2.4.2 [2013/12/12]
    • [Bugfix] Fixed a bug when doing a clean install of the Url Tracker (2.4.1 fix wasn't complete)
    • [Bugfix] Fixed a bug which occurred when umbraco is running on a different port than 80
  • 2.4.1 [2013/12/11]
    • [Bugfix] Fixed a bug when doing a clean install of the Url Tracker
    • [Bugfix] The database columns were too small in some situations
  • 2.4.0 [2013/12/11]
    • [Bugfix] In some situations an exception would occur with umbraco v6 (Value cannot be null. Parameter name: umbracoContext)
    • [Feature] Added the option to force a redirect (will always perform a redirect, even if a page at the specified old URL exists)
    • [Improvement] Massive performance improvements compared to v2.2.8 and newer
    • [Improvement] Better 404 handling; ignores 404 entry if the URL is an arterySignalR (BrowserLink) URL (VS 2013)
  • 2.3.2 [2013/11/27]
    • [Bugfix] Fixed a hostnames issue
  • 2.3.1 [2013/11/27]
  • 2.3.0 [2013/11/26]
    • [Bugfix] The old URL shown in the UI was sometimes wrong when a domain with path was configured
    • [Bugfix] Fixed a bug which occurred when overlapping hostnames were configured, like 'domain.org' and 'domain.org/path'
  • 2.2.9 [2013/11/25]
    • [Bugfix] Some automatic entries were not recognized as automatic entry
  • 2.2.8 [2013/11/11]
    • [Bugfix] Improved the 'rootnode is 0' bugfix from 2.2.7
    • [Bugfix] An issue was introduced in version 2.2.6 for 'older' umbraco versions
    • [Improvement] UI handles unpublished nodes better
  • 2.2.7 [2013/11/08]
    • [Bugfix] Fixed a UI issue when the rootnode is 0
    • [Improvement] Better 404 handling; ignores referrer if it's value is the Url Tracker UI, ignores 404 entry if the URL is a BrowserLink URL (VS 2013)
  • 2.2.6 [2013/10/21]
    • [Bugfix] There were some issues with umbraco 6.1.x and static file extensions (like .html)
  • 2.2.5 [2013/10/16]
    • [Bugfix] There was an issue with multiple entries with the same old url, but different querystrings
    • [Bugfix] When multiple versions of log4net exist in the bin folder, the UrlTracker would crash
  • 2.2.3 [2013/08/30]
    • [Bugfix] Sometimes the installer was stuck at "Installing database table" (VirtualPathProvider issue)
  • 2.2.2 [2013/08/23]
    • [Feature] Added regex capturing groups support (use '$n', where n is the capturing group number starting from 1)
    • [Feature] Added response from HttpModule if it 'fails' in the installer (debugging purposes)
  • 2.2.0 [2013/08/22]
    • [Feature] Added filtering and searching
    • [Feature] Improved error handling
  • 2.1.6 [2013/08/16]
    • [Bugfix] Fixed two small bugs (http module)
  • 2.1.4 [2013/08/07]
    • [Bugfix] Migrating data from v1 to v2 resulted in an error when there were absolute OldUrls in the DB table
  • 2.1.3 [2013/08/05]
    • [Bugfix] Redirects from URLs with non-aspx extensions were displayed with '.aspx' appended at the end
    • [Bugfix] Redirects with querystring passthrough failed sometimes
  • 2.1.1 [2013/07/03]
    • [Bugfix] Implemented an extra check for the installation of the dashboard
  • 2.1.0 [2013/07/02]
    • [Feature] Implemented support for SQL CE
    • [Feature] Added a setting to disable url tracking (urlTracker:trackingDisabled)
  • 2.0.4-beta [2013/07/02]
    • [Feature] Added better exception handling for the installer
  • 2.0.3-beta [2013/06/21]
    • [Bugfix] Enabling logging on umbraco versions including log4net threw ysod
  • 2.0.2-beta [2013/06/20]
    • [Bugfix] Ports other than 80 didn't work with the Http Module check in the installer
    • [Bugfix] String.Format in UrlTrackerDomain.UrlWithDomain was wrongly formatted
  • 2.0.1-beta [2013/06/20]
    • [Bugfix] Multiple hostnames assigned to a node threw an exception
  • 2.0-beta [2013/06/19]
    • Initial release, completely rebuilt the package
    • Renamed 301 URL Tracker to Url Tracker
    • The package is now a single assembly

Roadmap

  • Datatype
  • Better validation (already existing etc.)
  • Support UrlRewriting if possible
  • Azure support (if it doesn't work yet, untested)

Upgrading from v1 (301 URL Tracker)

  1. Back-up the existing infocaster301 database table (schema and data)
  2. Uninstall the old package
  3. When the database table is removed, restore it by using the script from step 1
  4. Install version 2; the Url Tracker
  5. The installation wizard will be able to migrate the existing data
  6. If the migration succeeded, you can delete the old infocaster301 database

Upgrading from v2 and v3

  1. Optional: Uninstall the old package (no data will be lost, but you might want to do this just to keep the 'Installed packages' clean)
  2. Install the new version

Uninstalling

You can uninstall the Url Tracker by removing the package. The database table will not get deleted! If you'd like to remove the database table too, you should do it manually.

Tested with

  • IIS 7 and up
  • SQL Server 2008 R2
  • .NET 4 and up
  • Version 2: Umbraco versions 4.6.1, 4.7.2, 4.9.1, 4.11.9, 6.0.0, 6.1.1 (won't work with pre v4.6.0), so it should work with umbraco v4.6.0 and above (reports indicate that there are problems with v7)
  • Version 3: Umbraco versions 6.1, 7.0, 7.1 and above if possible

Credits

  • InfoCaster | Being able to combine 'work' with package development and thanks to colleagues for inspiration.
  • Richard Soeteman | Richard came up with the idea for a package which keeps track of URLs of umbraco nodes.
  • The uComponents project | For inspiring me to create a single-assembly package solution.

Donate

Please follow this link if you would like to donate: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VKGMKM3NN8MSQ
Thanks in advance!