How to make routes in Laravel case insensitive?

Question

I have a project in laravel and there are many routes in that project.

But i just discovered that the routes are all case sensitive, means /advertiser/reports is different than /advertiser/Reports .

So what i want is both the routes should redirect to same view. Currently /advertiser/Reports gives RouteNotFound Exception.

I have read about the Route::pattern() way of doing it but since there are many routes i'll have to put in a lot of efforts for that. So, what i want is a better way of doing it, if there is any.

Solution 1

In order to make routes case-insensitive you'll need to modify the way routes are matched with the URLs. In Laravel, it all happens in UriValidator object so you'll need to create your own validator.

Luckily, like most tasks in Laravel, it's not really complicated.

First, create the new validator class - the only difference between this one and the original is that you'll append the i modifier at the end of regular expression for the compiled route to switch enable case-insensitive matching.

<?php namespace Your\Namespace;

use Illuminate\Http\Request;
use Illuminate\Routing\Route;
use Illuminate\Routing\Matching\ValidatorInterface;

class CaseInsensitiveUriValidator implements ValidatorInterface
{
  public function matches(Route $route, Request $request)
  {
    $path = $request->path() == '/' ? '/' : '/'.$request->path();
    return preg_match(preg_replace('/$/','i', $route->getCompiled()->getRegex()), rawurldecode($path));
  }
}

Secondly, you need to update the list of matchers that are used to match URL to a route and replace the original UriValidator with yours.

In order to do that, add the following at the top of your routes.php file:

<?php
use Illuminate\Routing\Route as IlluminateRoute;
use Your\Namespace\CaseInsensitiveUriValidator;
use Illuminate\Routing\Matching\UriValidator;

$validators = IlluminateRoute::getValidators();
$validators[] = new CaseInsensitiveUriValidator;
IlluminateRoute::$validators = array_filter($validators, function($validator) { 
  return get_class($validator) != UriValidator::class;
});

This will remove the original validator and add yours to the list of validators.

Keep in mind that this code has not been tested by running. Let me know if there are any typos or something doesn't work as expected. I'll be more than happy to get that working for you :)

Solution 2

I know this is an old question but I came across this same problem and I just want to share my solution.

On method render(...) at Exceptions/Handler.php, catch 404 exceptions and validate the case of the URL then redirect like this:

public function render($request, Exception $exception)
{
    $url = $request->url();
    $loweredCaseUrl = strtolower($url);
    if (
        $exception instanceof \Symfony\Component\HttpKernel\Exception\NotFoundHttpException &&
        $url !== $loweredCaseUrl
    ) {
        return redirect($loweredCaseUrl);
    }

    return parent::render($request, $exception);
}

That's it.

Comments

[Nishant Srivastava]

First of all thanx for the reply. Now i used your code the below exception was thrown: Missing argument 2 for array_except()

[Nishant Srivastava]

Sir its still not working and i have no idea what to do. It is giving this exception: [Symfony\Component\Debug\Exception\FatalErrorException] Object of class Illuminate\Routing\Matching\MethodValidator could not be converted to string

[jedrzej.kurylo]

Good, we're getting there. I updated the answer - the code you need to add to routes.php

[Brynn Bateman]

Small typo, left off "$" in front of loweredCaseUrl

[Ezequiel Celona]

the code you have in the top of your routes.php file here should really be placed in an your AppServiceProvider, at the very least.