1 package FS::part_export::domreg_opensrs;
3 use vars qw(@ISA %info %options $conf $me $DEBUG);
6 use FS::Record qw(qsearchs qsearch);
8 use FS::part_export::null;
14 FS::part_export::domreg_opensrs - Register or transfer domains with Tucows OpenSRS
18 This module handles registering and transferring domains using a registration service provider (RSP) account
19 at Tucows OpenSRS, an ICANN-approved domain registrar.
21 As a part_export, this module can be designated for use with svc_domain services. When the svc_domain object
22 is inserted into the Freeside database, registration or transferring of the domain may be initiated, depending
23 on the setting of the svc_domain's action field.
27 =item N - Register the domain
29 =item M - Transfer the domain
31 =item I - Ignore the domain for registration purposes
35 This export uses Net::OpenSRS. Registration and transfer attempts will fail unless Net::OpenSRS is installed
36 and LWP::UserAgent is able to make HTTPS posts. You can turn on debugging messages and use the OpenSRS test
37 gateway when setting up this export.
41 @ISA = qw(FS::part_export::null);
42 $me = '[' . __PACKAGE__ . ']';
45 my @tldlist = qw/com net org biz info name mobi at be ca cc ch cn de dk es eu fr it mx nl tv uk us/;
47 tie %options, 'Tie::IxHash',
48 'username' => { label => 'Reseller user name at OpenSRS',
50 'privatekey' => { label => 'Private key',
52 'password' => { label => 'Password for management account',
54 'masterdomain' => { label => 'Master domain at OpenSRS',
56 'wait_for_pay' => { label => 'Do not provision until payment is received',
60 'debug_level' => { label => 'Net::OpenSRS debug level',
62 options => [ 0, 1, 2, 3 ],
64 # 'register' => { label => 'Use for registration',
67 # 'transfer' => { label => 'Use for transfer',
70 'tlds' => { label => 'Use this export for these top-level domains (TLDs)',
73 size => scalar(@tldlist),
74 options => [ @tldlist ],
75 default => 'com net org' },
79 'svc' => 'svc_domain',
80 'desc' => 'Domain registration via Tucows OpenSRS',
81 'options' => \%options,
83 Registers and transfers domains via the <a href="http://opensrs.com/">Tucows OpenSRS</a> registrar (using <a href="http://search.cpan.org/dist/Net-OpenSRS">Net::OpenSRS</a>).
84 All of the Net::OpenSRS restrictions apply:
86 <LI>You must have a reseller account with Tucows.
87 <LI>You must add the public IP address of the Freeside server to the 'Script API allow' list in the OpenSRS web interface.
88 <LI>You must generate an API access key in the OpenSRS web interface and enter it below.
89 <LI>All domains are managed using the same user name and password, but you can create sub-accounts for clients.
90 <LI>The user name must be the same as your OpenSRS reseller ID.
91 <LI>You must enter a master domain that all other domains are associated with. That domain must be registered through your OpenSRS account.
93 Some top-level domains offered by OpenSRS have additional business rules not supported by this export. These TLDs cannot be registered or transfered with this export.
94 <BR><BR>Use these buttons for some useful presets:
97 <INPUT TYPE="button" VALUE="OpenSRS Live System (rr-n1-tor.opensrs.net)" onClick='
98 document.dummy.machine.value = "rr-n1-tor.opensrs.net";
99 this.form.machine.value = "rr-n1-tor.opensrs.net";
102 <INPUT TYPE="button" VALUE="OpenSRS Test System (horizon.opensrs.net)" onClick='
103 document.dummy.machine.value = "horizon.opensrs.net";
104 this.form.machine.value = "horizon.opensrs.net";
110 install_callback FS::UID sub {
111 $conf = new FS::Conf;
120 Reformats a phone number according to registry rules. Currently Freeside stores phone numbers
121 in NANPA format and the registry prefers "+CCC.NPANPXNNNN"
128 #if ($tel =~ /^(\d{3})-(\d{3})-(\d{4})( x(\d+))?$/) {
129 if ($tel =~ /^(\d{3})-(\d{3})-(\d{4})$/) {
131 # if $tel .= "$4" if $4;
136 =item gen_contact_info
138 Generates contact data for the domain based on the customer data.
140 Currently relies on Net::OpenSRS to format the telephone number for OpenSRS.
148 my @invoicing_list = $co->invoicing_list_emailonly;
149 if ( $conf->exists('emailinvoiceautoalways')
150 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
151 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
152 push @invoicing_list, $co->all_emails;
155 my $email = ($conf->exists('business-onlinepayment-email-override'))
156 ? $conf->config('business-onlinepayment-email-override')
157 : $invoicing_list[0];
160 firstname => $co->first,
161 lastname => $co->last,
162 company => $co->company,
163 address => $co->address1,
165 state => $co->state(),
167 country => uc($co->country()),
169 #phone => format_tel($co->daytime()),
170 phone => $co->daytime() || $co->night,
175 =item validate_contact_info
177 Attempts to validate contact data for the domain based on OpenSRS rules.
179 Returns undef if the contact data is acceptable, an error message if the contact
180 data lacks one or more required fields.
184 sub validate_contact_info {
188 firstname => "first name",
189 lastname => "last name",
190 address => "street address",
193 zip => "ZIP/postal code",
194 country => "country",
195 email => "email address",
196 phone => "phone number",
199 foreach (keys %fields) {
200 if (!defined($c->{$_}) || !$c->{$_}) {
201 push @err, $fields{$_};
204 if (scalar(@err) > 0) {
205 return "Contact information needs: " . join(', ', @err);
212 Returns the Net::OpenSRS-required test mode string based on whether the export
213 is configured to use the live or the test gateway.
220 return 'live' if $self->machine eq "rr-n1-tor.opensrs.net";
221 return 'test' if $self->machine eq "horizon.opensrs.net";
228 Attempts to "export" the domain, i.e. register or transfer it if the user selected
229 that option when editing the domain.
231 Returns an error message on failure or undef on success.
233 May also return an error message if it cannot load the required Perl module Net::OpenSRS,
234 or if the domain is not registerable, or if insufficient data is provided in the customer
235 record to generate the required contact information to register or transfer the domain.
240 my( $self, $svc_domain ) = ( shift, shift );
242 return if $svc_domain->action eq 'I'; # Ignoring registration, just doing DNS
244 if ($svc_domain->action eq 'N') {
245 return $self->register( $svc_domain );
246 } elsif ($svc_domain->action eq 'M') {
247 return $self->transfer( $svc_domain );
249 return "Unknown domain action " . $svc_domain->action;
252 sub _export_insert_on_payment {
253 my( $self, $svc_domain ) = ( shift, shift );
254 warn "$me:_export_insert_on_payment called\n" if $DEBUG;
255 return '' unless $self->option('wait_for_pay');
257 my $queue = new FS::queue {
258 'svcnum' => $svc_domain->svcnum,
259 'job' => 'FS::part_export::domreg_opensrs::renew_through',
261 $queue->insert( $self, $svc_domain ); #_export_insert with 'R' action?
264 ## Domain registration exports do nothing on replace. Mainly because we haven't decided what they should do.
265 #sub _export_replace {
266 # my( $self, $new, $old ) = (shift, shift, shift);
272 ## Domain registration exports do nothing on delete. You're just removing the domain from Freeside, not the registry
273 #sub _export_delete {
274 # my( $self, $svc_domain ) = ( shift, shift );
279 =item is_supported_domain
281 Return undef if the domain name uses a TLD or SLD that is supported by this registrar.
282 Otherwise return an error message explaining what's wrong.
286 sub is_supported_domain {
288 my $svc_domain = shift;
290 # Get the TLD of the new domain
291 my @bits = split /\./, $svc_domain->domain;
293 return "Can't register subdomains: " . $svc_domain->domain if scalar(@bits) != 2;
297 # See if it's one this export supports
298 my @tlds = split /\s+/, $self->option('tlds');
299 @tlds = map { s/\.//; $_ } @tlds;
300 return "Can't register top-level domain $tld, restricted to: " . $self->option('tlds') if ! grep { $_ eq $tld } @tlds;
311 my $srs = Net::OpenSRS->new();
313 $srs->debug_level( $self->option('debug_level') ); # Output should be in the Apache error log
315 $srs->environment( $self->testmode() );
316 $srs->set_key( $self->option('privatekey') );
318 $srs->set_manage_auth( $self->option('username'), $self->option('password') );
324 Returns a reference to a hashref containing information on the domain's status. The keys
325 defined depend on the status.
327 'unregistered' means the domain is not registered.
329 Otherwise, if the domain is in an asynchronous operation such as a transfer, returns the state
332 Otherwise returns a value indicating if the domain can be managed through our reseller account.
337 my ( $self, $svc_domain ) = @_;
340 eval "use Net::OpenSRS;";
343 my $srs = $self->get_srs;
345 if ($srs->is_available( $svc_domain->domain )) {
346 $rslt->{'unregistered'} = 1;
348 $rslt = $srs->check_transfer( $svc_domain->domain );
349 if (defined($rslt->{'reason'})) {
350 my $rv = $srs->make_request(
352 action => 'belongs_to_rsp',
355 domain => $svc_domain->domain
360 $self->_set_response;
361 if ( $rv->{attributes}->{'domain_expdate'} ) {
362 $rslt->{'expdate'} = $rv->{attributes}->{'domain_expdate'};
368 return $rslt; # Success
373 Attempts to register the domain through the reseller account associated with this export.
375 Like most export functions, returns an error message on failure or undef on success.
380 my ( $self, $svc_domain, $years ) = @_;
382 $years = 1 unless $years; #default to 1 year since we don't seem to pass it
384 return "Net::OpenSRS does not support period other than 1 year" if $years != 1;
386 eval "use Net::OpenSRS;";
389 my $err = $self->is_supported_domain( $svc_domain );
392 my $cust_main = $svc_domain->cust_svc->cust_pkg->cust_main;
394 my $c = gen_contact_info($cust_main);
396 $err = validate_contact_info($c);
399 my $srs = $self->get_srs;
401 # cookie not required for registration
402 # my $cookie = $srs->get_cookie( $self->option('masterdomain') );
404 # return "Unable to get cookie at OpenSRS: " . $srs->last_response();
407 # return "Domain registration not enabled" if !$self->option('register');
408 return $srs->last_response() if !$srs->register_domain( $svc_domain->domain, $c);
410 return ''; # Should only get here if register succeeded
415 Attempts to transfer the domain into the reseller account associated with this export.
417 Like most export functions, returns an error message on failure or undef on success.
422 my ( $self, $svc_domain ) = @_;
424 eval "use Net::OpenSRS;";
427 my $err = $self->is_supported_domain( $svc_domain );
430 my $cust_main = $svc_domain->cust_svc->cust_pkg->cust_main;
432 my $c = gen_contact_info($cust_main);
434 $err = validate_contact_info($c);
437 my $srs = $self->get_srs;
439 my $cookie = $srs->get_cookie( $self->option('masterdomain') );
441 return "Unable to get cookie at OpenSRS: " . $srs->last_response();
444 # return "Domain transfer not enabled" if !$self->option('transfer');
445 return $srs->last_response() if !$srs->transfer_domain( $svc_domain->domain, $c);
447 return ''; # Should only get here if transfer succeeded
452 Attempts to renew the domain for the specified number of years.
454 Like most export functions, returns an error message on failure or undef on success.
459 my ( $self, $svc_domain, $years ) = @_;
461 eval "use Net::OpenSRS;";
464 my $err = $self->is_supported_domain( $svc_domain );
467 my $srs = $self->get_srs;
469 my $cookie = $srs->get_cookie( $self->option('masterdomain') );
471 return "Unable to get cookie at OpenSRS: " . $srs->last_response();
474 # return "Domain renewal not enabled" if !$self->option('renew');
475 return $srs->last_response() if !$srs->renew_domain( $svc_domain->domain, $years );
477 return ''; # Should only get here if renewal succeeded
480 =item renew_through [ EPOCH_DATE ]
482 Attempts to renew the domain through the specified date. If no date is
483 provided it is gleaned from the associated cust_pkg bill date
485 Like some export functions, dies on failure or returns undef on success.
486 It is always called from the queue.
491 my ( $self, $svc_domain, $date ) = @_;
493 warn "$me: renew_through called\n" if $DEBUG;
494 eval "use Net::OpenSRS;";
498 my $cust_pkg = $svc_domain->cust_svc->cust_pkg;
499 die "Can't renew: no date specified and domain is not in a package."
501 $date = $cust_pkg->bill;
504 my $err = $self->is_supported_domain( $svc_domain );
507 warn "$me: checking status\n" if $DEBUG;
508 my $rv = $self->get_status($svc_domain);
509 die "Domain ". $svc_domain->domain. " is not renewable"
510 unless $rv->{expdate};
512 die "Can't parse expiration date for ". $svc_domain->domain
513 unless $rv->{expdate} =~ /^(\d{4})-(\d{2})-(\d{2}) (\d{2}):(\d{2}):(\d{2})/;
515 my ($year,$month,$day,$hour,$minute,$second) = ($1,$2,$3,$4,$5,$6);
516 my $exp = DateTime->new( year => $year,
522 time_zone => 'America/New_York',#timezone of opensrs
525 my $bill = DateTime->
526 from_epoch( 'epoch' => $date,
527 'time_zone' => DateTime::TimeZone->new( name => 'local' ),
531 while ( DateTime->compare( $bill, $exp ) > 0 ) {
533 $exp->add( 'years' => 1 );
535 die "Can't renew ". $svc_domain->domain. " for more than 10 years."
536 if $years > 10; #no infinite loop
539 return '' unless $years;
541 warn "$me: renewing ". $svc_domain->domain. " for $years years\n" if $DEBUG;
542 my $srs = $self->get_srs;
543 $rv = $srs->make_request(
548 domain => $svc_domain->domain,
552 currentexpirationyear => $year,
556 die $rv->{response_text} unless $rv->{is_success};
558 return ''; # Should only get here if renewal succeeded
563 Attempts to revoke the domain registration. Only succeeds if invoked during the OpenSRS
564 grace period immediately after registration.
566 Like most export functions, returns an error message on failure or undef on success.
571 my ( $self, $svc_domain ) = @_;
573 eval "use Net::OpenSRS;";
576 my $err = $self->is_supported_domain( $svc_domain );
579 my $srs = $self->get_srs;
581 my $cookie = $srs->get_cookie( $self->option('masterdomain') );
583 return "Unable to get cookie at OpenSRS: " . $srs->last_response();
586 # return "Domain registration revocation not enabled" if !$self->option('revoke');
587 return $srs->last_response() if !$srs->revoke_domain( $svc_domain->domain);
589 return ''; # Should only get here if transfer succeeded
594 Should return a full-blown object representing OpenSRS, but current just returns a hashref
595 containing the registrar name.
609 L<Net::OpenSRS>, L<FS::part_export_option>, L<FS::export_svc>, L<FS::svc_domain>,
610 L<FS::Record>, schema.html from the base documentation.