blib/lib/DNS/ZoneEdit.pm

filter: Statementstmt 86.6% 13 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 5 / 5 Podpod n/a totaltotal 90.0% 18 / 20 CC 1 SCAR 0.6
CC
1
Cov
87%
BEGIN
1.3
BEGIN
1.0
BEGIN
1.0
CRAP 1.1
↑ Summary
1 package DNS::ZoneEdit;
2  
3 3 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 3 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 3 ▶use LWP::UserAgent;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 0 ▶use CGI::Util qw(escape);
Subroutine BEGIN: called CC=1 SCAR=2.6
8  
9 use base qw(LWP::UserAgent);
10  
11 use constant URL => 'dynamic.zoneedit.com/auth/dynamic.html';
12  
13 our $VERSION = 1.1;
14  
15 =head1 NAME
16  
17 DNS::ZoneEdit - Update your ZoneEdit dynamic DNS entries
18  
19 =head1 SYNOPSIS
20  
21 This module allows you to update your ZoneEdit ( http://www.zoneedit.com/ )
22 dynamic DNS records. This is done via an http get using the C<LWP::UserAgent>
23 module.
24  
25 use DNS::ZoneEdit;
26  
27 my $ze = DNS::ZoneEdit->new();
28 $ze->update( hostname => "cpan.org", username => "foo", password => "bar" ) || die "Failed: $@";
29  
30 =head1 METHODS
31  
32 =over 4
33  
34 =cut
35  
36 =item DNS::ZoneEdit->new();
37  
38 Create a new ZoneEdit object. This is actually an inheritted L<LWP::UserAgent>
39 object so you can use any of the methods defined in that class. For example,
40 if you are behind a proxy server:
41  
42 my $ze = DNS::ZoneEdit->new();
43 $ze->proxy('http', 'http://proxy.sn.no:8001/');
44  
45 =cut
46  
47 sub new {
48 my ($pack,@args) = @_;
49 my $obj = $pack->SUPER::new(@args);
50 $obj->agent("DNS::ZoneEdit perl module");
51 return $obj;
52 }
53  
54  
55 sub _can_do_https {
56 eval "use Crypt::SSLeay";
57  
58 return ($@ eq "");
59 }
60  
61  
62 sub _make_request_url {
63 my ($self,%args) = @_;
64  
65 my %get;
66 while (my ($k,$v) = each %args) {
67 if ( $k eq "username" ) { $self->{"username"} = $v }
68 elsif ( $k eq "password" ) { $self->{"password"} = $v }
69 elsif ( $k eq "hostname" ) { $get{host} = $v }
70 elsif ( $k eq "myip" ) { $get{dnsto} = $v }
71 elsif ( $k eq "tld" ) { $get{zones} = $v }
72 elsif ( $k eq "secure" ) { $self->{"secure"} = $v }
73 else { carp "update(): Bad argument $k" }
74 }
75  
76 if (defined $self->{secure}) {
77 if ($self->{secure} && ! _can_do_https()) {
78 croak "Can't run in secure mode - try installing Crypt::SSLeay";
79 }
80 } else {
81 $self->{secure} = _can_do_https();
82 }
83  
84 if ( !$self->{secure} ) {
85 carp "** USING INSECURE MODE - PLEASE READ THE DOCUMENTATION **\n";
86 }
87  
88 ## Make the GET request URL.
89 my $proto = $self->{"secure"} ? "https://" : "http://";
90 my $query = join('&', map { escape($_)."=".escape($get{$_}) } keys %get);
91 return $proto . URL() . "?" . $query;
92 }
93  
94 =item update(%args);
95  
96 Updates your ZoneEdit dynamic DNS records. Valid C<%args> are:
97  
98 =over 8
99  
100 C<username> - Your ZoneEdit login name. This is required.
101  
102 C<password> - The corresponding password. This is required.
103  
104 C<hostname> - The FQDN of host being updated. This is required.
105  
106 Contains a comma-delimited list of hosts that have IP addresses. This parameter
107 may be C<*.domain.com> to update a wildcard A-record.
108  
109 C<myip> - The IP address of the client to be updated. This
110 defaults to the IP address of the incoming connection (handy if you are
111 being natted).
112  
113 C<tld> - The root domain of your hostname, for example if your hostname is
114 C<example.co.uk> you can set C<tld> to C<co.uk>. This is to support an
115 undocumented "feature" of zoneedit where you sometimes need to specify it to
116 to update your zone.
117  
118 C<secure> - Values are either C<1> or C<0>. If C<1>, then SSL https is used to
119 connect to ZoneEdit. The SSL connection has the big advantage that your
120 passwords are not passed in plain-text accross the internet. Secure is on by
121 default if Crypt::SSLeay is installed. A warning will be generated if it's not
122 installed unless you set C<secure> to C<0>. If you set C<secure> to C<1> and the
123 module is unavailable, the module will C<croak>.
124  
125 =back
126  
127 Returns C<TRUE> on success. On failure it returns C<FALSE> and
128 sets C<$@>.
129  
130 =cut
131  
132 sub update {
133 my ($self,%args) = @_;
134  
135 croak "update(): Argument 'username' is required"
136 unless defined $args{"username"};
137  
138 croak "update(): Argument 'password' is required"
139 unless defined $args{"password"};
140  
141 croak "update(): Argument 'hostname' is required"
142 unless defined $args{"hostname"};
143  
144 my $update = $self->_make_request_url(%args);
145  
146 my $resp = $self->get($update);
147 if ($resp->is_success) {
148 chomp(my $content = $resp->content);
149 if ( $content =~ m/CODE="2\d+"/ ) {
150 return 1;
151 } else {
152 $@ = 'Request failed: "'.$content.'"';
153 return;
154 }
155 } else {
156 $@ = 'HTTP Request failed: "'.$resp->status_line.'"';
157 return;
158 }
159 }
160  
161 =item get_basic_credentials();
162  
163 Since a ZoneEdit object is an subclass of C<LWP::UserAgent>, it overrides
164 this UserAgent method for your convenience. It uses the credentials passed
165 in the update method. There is no real reason to call, or override this method.
166  
167 =cut
168  
169 sub get_basic_credentials { ($_[0]->{"username"}, $_[0]->{"password"}) }
170  
171 =back
172  
173 =head1 NOTES
174  
175 There are some example scripts in the C<examples> directory of the module
176 distribution. These are designed to run out of cron (or similar). You should
177 not run them too often to avoid overloading the ZoneEdit servers. Ideally
178 your code should cache the existing value for your IP, and only update
179 ZoneEdit when it changes.
180  
181 =head1 ACKNOWLEDGEMENTS
182  
183 This module is based on Gavin Brock's excellent L<DNS::EasyDNS>.
184  
185 For more information about the ZoneEdit services please visit
186 http://www.zoneedit.com/. This module is not written nor supported by
187 ZoneEdit LLC.
188  
189 =head1 COPYRIGHT
190  
191 Copyright (c) 2003-2006 Gavin Brock gbrock@cpan.org,
192 Copyright 2009-2010 Evan Giles.
193  
194 This module is free software; you can redistribute it and/or modify it
195 under the same terms as Perl itself.
196  
197 =head1 SEE ALSO
198  
199 L<LWP::UserAgent>, L<DNS::EasyDNS>
200  
201 =cut
202  
203 1; # End of DNS::ZoneEdit
↑ Summary