This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document hashref_locked() and hashref_unlocked(). Add tests for them, include debugg...
[perl5.git] / ext / Sys-Hostname / Hostname.pm
1 package Sys::Hostname;
2
3 use strict;
4
5 use Carp;
6
7 require Exporter;
8
9 our @ISA     = qw/ Exporter /;
10 our @EXPORT  = qw/ hostname /;
11
12 our $VERSION;
13
14 our $host;
15
16 BEGIN {
17     $VERSION = '1.16';
18     {
19         local $SIG{__DIE__};
20         eval {
21             require XSLoader;
22             XSLoader::load();
23         };
24         warn $@ if $@;
25     }
26 }
27
28
29 sub hostname {
30
31   # method 1 - we already know it
32   return $host if defined $host;
33
34   # method 1' - try to ask the system
35   $host = ghname() if defined &ghname;
36   return $host if defined $host;
37
38   if ($^O eq 'VMS') {
39
40     # method 2 - no sockets ==> return DECnet node name
41     eval { local $SIG{__DIE__}; $host = (gethostbyname('me'))[0] };
42     if ($@) { return $host = $ENV{'SYS$NODE'}; }
43
44     # method 3 - has someone else done the job already?  It's common for the
45     #    TCP/IP stack to advertise the hostname via a logical name.  (Are
46     #    there any other logicals which TCP/IP stacks use for the host name?)
47     $host = $ENV{'ARPANET_HOST_NAME'}  || $ENV{'INTERNET_HOST_NAME'} ||
48             $ENV{'MULTINET_HOST_NAME'} || $ENV{'UCX$INET_HOST'}      ||
49             $ENV{'TCPWARE_DOMAINNAME'} || $ENV{'NEWS_ADDRESS'};
50     return $host if $host;
51
52     # method 4 - does hostname happen to work?
53     my($rslt) = `hostname`;
54     if ($rslt !~ /IVVERB/) { ($host) = $rslt =~ /^(\S+)/; }
55     return $host if $host;
56
57     # rats!
58     $host = '';
59     croak "Cannot get host name of local machine";  
60
61   }
62   elsif ($^O eq 'MSWin32') {
63     ($host) = gethostbyname('localhost');
64     chomp($host = `hostname 2> NUL`) unless defined $host;
65     return $host;
66   }
67   elsif ($^O eq 'epoc') {
68     $host = 'localhost';
69     return $host;
70   }
71   else {  # Unix
72     # is anyone going to make it here?
73
74     local $ENV{PATH} = '/usr/bin:/bin:/usr/sbin:/sbin'; # Paranoia.
75
76     # method 2 - syscall is preferred since it avoids tainting problems
77     # XXX: is it such a good idea to return hostname untainted?
78     eval {
79         local $SIG{__DIE__};
80         require "syscall.ph";
81         $host = "\0" x 65; ## preload scalar
82         syscall(&SYS_gethostname, $host, 65) == 0;
83     }
84
85     # method 2a - syscall using systeminfo instead of gethostname
86     #           -- needed on systems like Solaris
87     || eval {
88         local $SIG{__DIE__};
89         require "sys/syscall.ph";
90         require "sys/systeminfo.ph";
91         $host = "\0" x 65; ## preload scalar
92         syscall(&SYS_systeminfo, &SI_HOSTNAME, $host, 65) != -1;
93     }
94
95     # method 3 - trusty old hostname command
96     || eval {
97         local $SIG{__DIE__};
98         local $SIG{CHLD};
99         $host = `(hostname) 2>/dev/null`; # bsdish
100     }
101
102     # method 4 - use POSIX::uname(), which strictly can't be expected to be
103     # correct
104     || eval {
105         local $SIG{__DIE__};
106         require POSIX;
107         $host = (POSIX::uname())[1];
108     }
109
110     # method 5 - sysV uname command (may truncate)
111     || eval {
112         local $SIG{__DIE__};
113         $host = `uname -n 2>/dev/null`; ## sysVish
114     }
115
116     # bummer
117     || croak "Cannot get host name of local machine";  
118
119     # remove garbage 
120     $host =~ tr/\0\r\n//d;
121     $host;
122   }
123 }
124
125 1;
126
127 __END__
128
129 =head1 NAME
130
131 Sys::Hostname - Try every conceivable way to get hostname
132
133 =head1 SYNOPSIS
134
135     use Sys::Hostname;
136     $host = hostname;
137
138 =head1 DESCRIPTION
139
140 Attempts several methods of getting the system hostname and
141 then caches the result.  It tries the first available of the C
142 library's gethostname(), C<`$Config{aphostname}`>, uname(2),
143 C<syscall(SYS_gethostname)>, C<`hostname`>, C<`uname -n`>,
144 and the file F</com/host>.  If all that fails it C<croak>s.
145
146 All NULs, returns, and newlines are removed from the result.
147
148 =head1 AUTHOR
149
150 David Sundstrom E<lt>F<sunds@asictest.sc.ti.com>E<gt>
151
152 Texas Instruments
153
154 XS code added by Greg Bacon E<lt>F<gbacon@cs.uah.edu>E<gt>
155
156 =cut
157