File Coverage

blib/lib/Mojolicious/Plugin/RedirectHost.pm

Criterion	Covered	Total	%
statement	26	26	100.0
branch	12	12	100.0
condition	6	8	75.0
subroutine	4	4	100.0
pod	1	1	100.0
total	49	51	96.0

package Mojolicious::Plugin::RedirectHost;

use Mojo::Base 'Mojolicious::Plugin';
use Mojo::URL;

our $VERSION = '1.06';    # VERSION

# where to look for options
my $CONFIG_KEY   = 'redirect_host';
my $DEFAULT_CODE = 301;
my $EXCEPT_PATH  = '/robots.txt';

sub register {
  my ($self, $app, $params) = @_;

  my %options;
  if (ref $params eq 'HASH' && scalar keys %$params) {
    %options = %$params;
  }
  elsif (ref $app->config($CONFIG_KEY) eq 'HASH') {
    %options = %{$app->config($CONFIG_KEY)};
  }

  unless ($options{host}) {
    my $msg = 'RedirectHost plugin: define "host" option at least!';
    $app->log->error($msg) unless $options{silent};

    return;
  }

  $app->hook(
    before_dispatch => sub {
      my $c    = shift;
      my $url  = $c->req->url->to_abs;
      my $path = $c->req->url->path;


      # don't need redirection
      return if $url->host eq $options{host};

      # except_robots?
      return if $options{er} && $path eq $EXCEPT_PATH;

      # main host
      $url->host($options{host});

      # code
      $c->res->code($options{code} || $DEFAULT_CODE);


      $c->redirect_to($url->to_string);
    }
  );

  return;
}

1;

# ABSTRACT: Redirects requests from mirrors to the main host (useful for SEO)

=head1 SYNOPSIS


Generates 301 redirect from C to C

  # Mojolicious
  $app->plugin('RedirectHost', host => 'main.host');

  # Mojolicious::Lite
  plugin RedirectHost => { host => 'main.host' };

All requests with a C header that is not equal to the C option will be redirected to the main host (and to the same port, as it was in original request)
Don't forget about the port (don't expect something great from http://google.com:3000)

	http://www.main.host:3000       => http://main.host:3000
	http://another.io:3000/foo?bar  => http://main.host:3000/foo?bar
	etc...

You can point as many domains to your App by DNS, as you want. It doesn't matter, all of them will become a mirror. An equivalent apache .htaccess file looks like

	RewriteCond %{HTTP_HOST}   !^alexbyk.com
	RewriteRule  ^(.*)		http://alexbyk.com/$1 [R=301,L]

It would be better if you'll be using per mode config files (your_app.production.conf etc). This would make possible
to redirect only in production enviropment (but do nothing while coding your app)

Look at the `examples` directory of this distribution for a full application example

=head1 OPTIONS/USAGE

=head2 C

Main domain. All requests to the mirrors will be redirected to the C (domain)
This option is required. Without it plugin do nothing

=head2 C

  $app->plugin('RedirectHost', host => 'main.host', code => 302);

Type of redirection. Default 301 (Moved Permanently)

=head2 C (except /robots.txt)

  $app->plugin('RedirectHost', host => 'main.host', er => 1);

If true, requests like /robots.txt will not be redirected but rendered. That's for Yandex search engine.
If you want to change a domain but worry about yandex TIC, it's recomended to make it possible for Yandex to read your robots.txt
with new Host directive. If so, that's exactly what you're looking for

=head2 C

If C is true, doesn't write messages to the error log even if L is missing.
Default value is C

You can configure plugin in a production config file and define C in a development config.

	# app.production.conf
	# redirect_host => {host => 'main.host'},

	# app.development.conf:
	# redirect_host => {silent => 1},


=head1 CONFIG

You can pass options to the plugin with the help of your config. Use C key.

  $app->config(redirect_host => {host => 'main.host'});

TIP: use per mode config files (yourapp.production.conf) to pass parameters to the plugin to avoid redirection during
development process

=head1 METHODS

=head2 register

Register.  L

=cut