Add a vital missing paragraph to the man page, and update the header
[sgt/utils] / nntpid / nntpid
1 #!/usr/bin/perl
2 #
3 # Script to retrieve a single article from a news server, either by
4 # message-id or by group name and article number.
5 #
6 # Usage: nntpid <messageid>
7 # or: nntpid messageid (angle brackets optional)
8 # or: nntpid news.group.name 1234 (group+number form)
9 # or: nntpid -a news.group.name (download all available articles)
10 #
11 # The name of your news server is obtained from the environment variable
12 # NNTPSERVER, or from the file /etc/nntpserver if that's not set.
13 #
14 # This script supports AUTHINFO GENERIC authentication using the
15 # environment variable NNTPAUTH. It will only attempt this if it receives
16 # a 480 response from the news server; if your news server isn't paranoid
17 # then the script will never need to look at NNTPAUTH.
18
19 # Copyright 2000,2004 Simon Tatham. All rights reserved.
20
21 require 5.002;
22 use Socket;
23 use FileHandle;
24
25 $usage =
26 "usage: nntpid [ -v ] [ -d ] <message-id>\n" .
27 " or: nntpid [ -v ] [ -d ] <newsgroup> <article-number>\n" .
28 " or: nntpid [ -v ] -a <newsgroup>\n" .
29 "where: -v verbose (print interaction with news server)\n" .
30 " -d direct output (don't consider using PAGER)\n" .
31 " -a dump all articles in group to stdout as mbox\n" .
32 " also: nntpid --version report version number\n" .
33 " nntpid --help display this help text\n" .
34 " nntpid --licence display (MIT) licence text\n";
35
36 $licence =
37 "nntpid is copyright 2000,2004 Simon Tatham.\n" .
38 "\n" .
39 "Permission is hereby granted, free of charge, to any person\n" .
40 "obtaining a copy of this software and associated documentation files\n" .
41 "(the \"Software\"), to deal in the Software without restriction,\n" .
42 "including without limitation the rights to use, copy, modify, merge,\n" .
43 "publish, distribute, sublicense, and/or sell copies of the Software,\n" .
44 "and to permit persons to whom the Software is furnished to do so,\n" .
45 "subject to the following conditions:\n" .
46 "\n" .
47 "The above copyright notice and this permission notice shall be\n" .
48 "included in all copies or substantial portions of the Software.\n" .
49 "\n" .
50 "THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\n" .
51 "EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\n" .
52 "MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\n" .
53 "NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS\n" .
54 "BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN\n" .
55 "ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\n" .
56 "CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n" .
57 "SOFTWARE.\n";
58
59 $pager = 1;
60 $verbose = 0;
61 $all = 0;
62
63 while ($ARGV[0] =~ /^-(.+)$/) {
64 shift @ARGV;
65 $verbose = 1, next if $1 eq "v";
66 $pager = 0, next if $1 eq "d";
67 $all = 1, next if $1 eq "a";
68 if ($1 eq "-help") {
69 print STDERR $usage;
70 exit 0;
71 } elsif ($1 eq "-version") {
72 if ('$Revision$' =~ /Revision:\s+(\d+)/) {
73 print "nntpid revision $1\n";
74 } else {
75 print "nntpid: unknown revision\n";
76 }
77 exit 0;
78 } elsif ($1 eq "-licence" or $1 eq "-license") {
79 print $licence;
80 exit 0;
81 }
82 }
83
84 die $usage if !defined $ARGV[0];
85
86 if ($all) {
87 $group = $ARGV[0];
88 } elsif (defined $ARGV[1]) {
89 $group = $ARGV[0];
90 $mid = $ARGV[1];
91 } else {
92 $group = "misc.misc";
93 $mid = $ARGV[0];
94 $mid =~ s/^<//;
95 $mid =~ s/>$//;
96 $mid = "<$mid>";
97 }
98
99 $ns=$ENV{'NNTPSERVER'};
100 if (!defined $ns or !length $ns) {
101 $ns = `cat /etc/nntpserver`;
102 }
103 $port = (getservbyname("nntp", "tcp"))[2];
104 $ns = inet_aton($ns);
105 $proto = getprotobyname("tcp");
106 $paddr = sockaddr_in($port, $ns);
107
108 socket(S,PF_INET,SOCK_STREAM,$proto) or die "socket: $!";
109 connect(S,$paddr) or die "connect: $!";
110
111 S->autoflush(1);
112
113 $fatal = 1; # most errors need to be fatal
114
115 &getline;
116 $code =~ /^2\d\d/ or die "no initial greeting from server\n";
117
118 &docmd("MODE READER");
119 # some servers require a GROUP before an ARTICLE command
120 $numbers = &docmd("GROUP $group");
121 if ($all) {
122 @numbers = split / /, $numbers;
123 $fatal = 0; # ignore failure to retrieve any given article
124 for ($mid = $numbers[1]; $mid <= $numbers[2]; $mid++) {
125 $art = &getart($mid);
126 $art =~ s/\n(>*From )/\n>$1/gs;
127 print "From nntpid ".(localtime)."\n".$art."\n";
128 }
129 } else {
130 $art = &getart($mid);
131 &docmd("QUIT");
132 close S;
133
134 if ($pager and -t STDOUT) {
135 $pagername = $ENV{"PAGER"};
136 $pagername = "more" unless defined $pagername;
137 open PAGER, "| $pagername";
138 print PAGER $art;
139 close PAGER;
140 } else {
141 print $art;
142 }
143 }
144
145 sub getart {
146 my ($mid) = @_;
147 $ret = &docmd("ARTICLE $mid");
148 return undef if !defined $ret;
149 $art = "";
150 while (1) {
151 &getline;
152 s/[\r\n]//g;
153 last if /^\.$/;
154 s/^\.//;
155 $art .= "$_\n";
156 }
157 return $art;
158 }
159
160 sub putline {
161 my ($line) = @_;
162 print STDERR ">>> $line\n" if $verbose;
163 print S "$line\r\n";
164 }
165
166 sub getline {
167 $_ = <S>;
168 s/[\r\n]*$//s;
169 $code = substr($_,0,3);
170 print STDERR "<<< $_\n" if $verbose;
171 return substr($_,4);
172 }
173
174 sub docmd {
175 my ($cmd) = @_;
176 while (1) {
177 &putline($cmd);
178 $line = &getline;
179 if ($code eq "480") { &auth; } else { last; }
180 }
181 if ($code !~ /^2\d\d/) {
182 die "failed on `$cmd':\n$_\n" if $fatal;
183 return undef;
184 }
185 return $line;
186 }
187
188 sub auth {
189 # Authentication.
190 if ($ENV{"NNTPAUTH"}) {
191 $auth = $ENV{"NNTPAUTH"};
192 &putline("AUTHINFO GENERIC $auth");
193 pipe AUTHSTDIN, TOAUTH or die "unable to create pipes";
194 pipe FROMAUTH, AUTHSTDOUT or die "unable to create pipes";
195 $pid = fork;
196 if (!defined $pid) {
197 die "unable to fork for authentication helper";
198 } elsif ($pid == 0) {
199 # we are child
200 $ENV{"NNTP_AUTH_FDS"} = "0.1";
201 open STDIN, "<&AUTHSTDIN";
202 open STDOUT, ">&AUTHSTDOUT";
203 close S;
204 exec $auth;
205 }
206 # we are parent
207 close AUTHSTDIN;
208 close AUTHSTDOUT;
209 autoflush TOAUTH 1;
210 &getline; print TOAUTH "$_\n";
211 while (<FROMAUTH>) {
212 s/[\r\n]*$//s;
213 &putline($_);
214 &getline;
215 print TOAUTH "$_\n";
216 }
217 die "failed authentication\n" unless $? == 0;
218 }
219 }