# Movable Type (r) (C) Six Apart Ltd. All Rights Reserved.
# This code cannot be redistributed without permission from www.sixapart.com.
# For more information, consult your Movable Type license.
#
# $Id$

package MT::IPBanList;

use strict;
use warnings;
use base qw( MT::Object );

__PACKAGE__->install_properties(
    {   column_defs => {
            'id'      => 'integer not null auto_increment',
            'blog_id' => 'integer not null',
            'ip'      => 'string(50) not null',
        },
        indexes => {
            blog_id => 1,
            ip      => 1,
        },
        audit       => 1,
        datasource  => 'ipbanlist',
        primary_key => 'id',
    }
);

sub class_label {
    MT->translate("IP Ban");
}

sub class_label_plural {
    MT->translate("IP Bans");
}

sub ban_ip {
    my $class = shift;
    my ( $ip, $blog_id ) = @_;
    $class->set_by_key( { ip => $ip, blog_id => $blog_id } );
}

sub list_props {
    return {
        id => {
            base    => '__virtual.id',
            order   => 100,
            display => 'optional',
        },
        ip => {
            auto    => 1,
            label   => 'IP Address',
            display => 'force',
            order   => 200,
        },
        blog_name => {
            base    => '__virtual.blog_name',
            display => 'default',
            order   => 300,
        },
        created_on => {
            base    => '__virtual.created_on',
            display => 'default',
            order   => 400,
        },
        modified_on => {
            base    => '__virtual.modified_on',
            display => 'none',
        },
    };
}

#trans('IP addresses')

1;
__END__

=head1 NAME

MT::IPBanList - Movable Type IP comment banning record

=head1 SYNOPSIS

    use MT::IPBanList;
    my $ban = MT::IPBanList->new;
    $ban->blog_id($blog->id);
    $ban->ip($ip_address);
    $ban->save
        or die $ban->errstr;

=head1 DESCRIPTION

An I<MT::IPBanList> object represents a single IP address that is banned from
commenting on one of your blogs.

=head1 USAGE

As a subclass of I<MT::Object>, I<MT::IPBanList> inherits all of the
data-management and -storage methods from that class; thus you should look
at the I<MT::Object> documentation for details about creating a new object,
loading an existing object, saving an object, etc.

=head1 METHODS

=head2 MT::IPBanList->class_label

Returns the localized descriptive name for this class.

=head2 MT::IPBanList->class_label_plural

Returns the localized, plural descriptive name for this class.

=head2 MT::IPBanList->list_props

Returns the list_properties registry of this class.

=head1 DATA ACCESS METHODS

The I<MT::BanList> object holds the following pieces of data. These fields can
be accessed and set using the standard data access methods described in the
I<MT::Object> documentation.

=over 4

=item * id

The numeric ID of the banlist record.

=item * blog_id

The numeric ID of the blog for which the IP address is banned.

=item * ip

The IP address. This can be a partial IP address--for example, a partial
address of C<10.100> will block the IP addresses C<10.100.2.1>,
C<10.100.100.3>, etc.

=back

=head2 ban_ip($ip, $blog_id)

This convenience method can be used in place of setting the I<ip> and
I<blog_id> individually.

=head1 DATA LOOKUP

In addition to numeric ID lookup, you can look up or sort records by any
combination of the following fields. See the I<load> documentation in
I<MT::Object> for more information.

=over 4

=item * blog_id

=item * ip

=back

=head1 AUTHOR & COPYRIGHT

Please see L<MT/AUTHOR & COPYRIGHT>.

=cut
