֦i
d Z ddlZddlZddlZddlZddlZddlZ ddlZdZddl
m Z ddlm
Z
g dZ ej ed d
Z G d d e Z G d
de Z G d de Z G d de Z G d de Z G d de ZdZdZh dZg dZ dd d Z d Z ej> d g d Z ej> d!g d" Z!d# Z d$ Z"dWd%Z#dWd&Z$dXd'Z%erd( Z& G d) d* Z'er G d+ d,e' Z(ejS d, ed-k( rddl*Z* e*jV d./ Z,e,j[ d0d1d2d34 e,j[ d5d6d7d84 e,j[ d9d:d;e.d? e,j[ d@dAdBe.dC? e,j[ dDdEdFddGH e,j_ Z0e0jb Z1e0j s e1d;k( reZ1 e'e0jd e1I Z3ne1d;k( reZ1 e(e0jd e1I Z3e3ji Z5dJe5v re3jm e3jo e0jn \ Z8Z9Z:Z;Z< e=dKe e? e.e; e0j z
dPz Z:e3j e:e; \ Z8ZBeBD ]a \ ZCZD e eDdQ j dRdP d ZF e eDdS ZG e.eDd ZH e=dTj eC e>eFdU e>eGdV eH c e3j yy# e $ r dZY w xY w)Ya An NNTP client class based on:
- RFC 977: Network News Transfer Protocol
- RFC 2980: Common NNTP Extensions
- RFC 3977: Network News Transfer Protocol (version 2)
Example:
>>> from nntplib import NNTP
>>> s = NNTP('news')
>>> resp, count, first, last, name = s.group('comp.lang.python')
>>> print('Group', name, 'has', count, 'articles, range', first, 'to', last)
Group comp.lang.python has 51 articles, range 5770 to 5821
>>> resp, subs = s.xhdr('subject', '{0}-{1}'.format(first, last))
>>> resp = s.quit()
>>>
Here 'resp' is the server response line.
Error responses are turned into exceptions.
To post an article from a file:
>>> f = open(filename, 'rb') # file containing article, including header
>>> resp = s.post(f)
>>>
For descriptions of all methods, read the comments in the code below.
Note that all arguments and return values representing article numbers
are strings, not numbers, since they are rarely used for calculations.
NTF)
decode_header)_GLOBAL_DEFAULT_TIMEOUT)NNTP NNTPErrorNNTPReplyErrorNNTPTemporaryErrorNNTPPermanentErrorNNTPProtocolError
NNTPDataErrorr )
)removei c e Zd ZdZd Zy)r z%Base class for all nntplib exceptionsc r t j | g| |d | _ y # t $ r
d| _ Y y w xY w)Nr zNo response given) Exception__init__response
IndexError)selfargss /usr/lib64/python3.12/nntplib.pyr zNNTPError.__init__e s; 4'$' 0 GDM 0 /DM 0s
# 66N)__name__
__module__ __qualname____doc__r r r r c s
/0r r c e Zd ZdZy)r zUnexpected [123]xx replyNr r r r r r r r r l s "r r c e Zd ZdZy)r z
4xx errorsNr r r r r r p r r c e Zd ZdZy)r z
5xx errorsNr r r r r r t r! r r c e Zd ZdZy)r
z"Response does not begin with [1-5]Nr r r r r
r
x s ,r r
c e Zd ZdZy)r zError in response dataNr r r r r r | s r r w i3 > 100101211215220221222224225230231282)subjectfromdatez
message-id
references:bytes:linesr6 r7 )byteslines
GroupInfo)grouplastfirstflag ArticleInfo)number
message_idr9 c g }t | D ]K \ }}t |t r%|j |j |xs d ;|j | M dj | S )zvTakes a unicode string representing a munged header value
and decodes it as a (possibly non-ASCII) readable value.ascii )_email_decode_header
isinstancer8 appenddecodejoin)
header_strpartsvencs r r r sZ
E&z23 a LL#.1 2 LLO 3
775>r c g }| D ]t }|d dk( r |dd j d \ }}}d|z }n|j d \ }}}|j }t j || }|j | v t
}t
| t
| k r t d |dt
| |k7 r t d |S )zParse a list of string representing the response to LIST OVERVIEW.FMT
and return a list of header/metadata names.
Raises NNTPDataError if the response is not compliant
(cf. RFC 3977, section 8.4).r : Nz$LIST OVERVIEW.FMT response too shortz*LIST OVERVIEW.FMT redefines default fields) partitionlower_OVERVIEW_FMT_ALTERNATIVESgetrH _DEFAULT_OVERVIEW_FMTlenr )r9 fmtlinename_suffixdefaultss r _parse_overview_fmtr^ s
C 7c> "12h 0 0 5OD!V:D #nnS 1OD!Vzz|)--dD9
4 %H
3x#h- BCC
>CMh& HII Jr c t t }g }| D ] }i }|j d ^}}t | }t | D ]| \ } }
| t | k\ r|| } | j d } | |k\ rE| sC| dz }
|
r*|
dt |
j
|
k7 r t d |
r|
t |
d nd}
|
||| < ~ |j ||f |S )zZParse the response to an OVER or XOVER command according to the
overview format `fmt`. rP z: Nz?OVER/XOVER response doesn't include names of additional headers) rW rV splitint enumerate
startswithrS r rH )r9 rX data_process_func
n_defaultsoverviewrY fieldsarticle_numbertokensitoken
field_name is_metadatahs r _parse_overviewrp s *+JH"&**T"2 ^,!&)HAuCH} QJ$//4KJ{ %U7CF^ 1 1 3q 8' )F G G*/c!fgT "F3q6N! *" 01+ , Or c |
| dd }| dd } t |dd }t |dd }t |dd }t | dd }t | dd }t | dd }|dk r|dz
}n
|d k r|d
z
}t j |||||| S ) zParse a pair of (date, time) strings, and return a datetime object.
If only the date is given, it is assumed to be date and time
concatenated together (e.g. response to the DATE command).
Ni F i d il )rb datetime)date_strtime_strhoursminutessecondsyearmonthdays r _parse_datetimer s
BC=CR= ! E(1Q- G(12, G x} D B E
hrsm
C by
T5#ugw GGr c t | t j sd}ndj | }| j }|r|dz }dj || }||fS dj || }||fS )aP Format a date or datetime object as a pair of (date, time) strings
in the format required by the NEWNEWS and NEWGROUPS commands. If a
date object is passed, the time is assumed to be midnight (00h00).
The returned representation depends on the legacy flag:
* if legacy is False (the default):
date has the YYYYMMDD format and time the HHMMSS format
* if legacy is True:
date has the YYMMDD format and time the HHMMSS format.
RFC 3977 compliant servers should understand both formats; therefore,
legacy is only needed when talking to old servers.
000000z({0.hour:02d}{0.minute:02d}{0.second:02d}rw z {0:02d}{1.month:02d}{1.day:02d}z {0:04d}{1.month:02d}{1.day:02d})rG rx formatr~ )dtlegacyrz yry s r _unparse_datetimer s| b(++ ,=DDRH
A
G4;;ArB X 5;;ArB X r c T |t j }|j | | S )zWrap a socket in SSL/TLS. Arguments:
- sock: Socket to wrap
- context: SSL context to use for the encrypted connection
Returns:
- sock: New, encrypted socket.
)server_hostname)ssl_create_stdlib_context wrap_socket)sockcontexthostnames r _encrypt_onr s- ?002G""4"BBr c e Zd ZdZdZeddddefdZd Zd Z d Z
d Z d
Z d Z
d ZeZd
Zd Zd7dZd Zd8dZd Zd8dZd8dZd Zd Zd ZdddZdddZ d8dddZ d Z d Z d Z d Z!ddd Z"d! Z#d" Z$d8d#Z%d$ Z&d% Z'd8d&Z(d8ddd'Z)d8ddd(Z*d8ddd)Z+d* Z,ddd+Z-ddd,Z.ddd-Z/d. Z0d/ Z1d0 Z2d1 Z3d2 Z4d3 Z5d9d4Z6d5 Z7e8rd8d6Z9yy):r zutf-8surrogateescapeNFc z || _ || _ | j | | _ d| _ | j j d | _ | j
| |s|r| j ||| yy# | j r| j j | j j xY w)a, Initialize an instance. Arguments:
- host: hostname to connect to
- port: port to connect to (default the standard NNTP port)
- user: username to authenticate with
- password: password to use with username
- readermode: if true, send 'mode reader' command after
connecting.
- usenetrc: allow loading username and password from ~/.netrc file
if not specified explicitly
- timeout: timeout (in seconds) used for socket connections
readermode is sometimes necessary if you are connecting to an
NNTP server on the local machine and intend to call
reader-specific commands, such as `group'. If you get
unexpected NNTPPermanentErrors, you might need to set
readermode.
Nrwb) hostport_create_socketr filemakefile
_base_initloginclose)r r r userpassword
readermodeusenetrctimeouts r r z
NNTP.__init__; s ( ''0 **51DI OOJ 'x
484 yy ! IIOO s
AA7 7AB:c d| _ | j | _ d| _ | j d| _ |rAd| j vr3| j
| j
sd| _ | j d| _ d| _ y)z~Partial initialization for the NNTP protocol.
This instance method is extracted for supporting the test code.
r NFREADER) debugging_getrespwelcome_capsgetcapabilitiesreadermode_afterauth_setreadermodetls_on
authenticated)r r s r r zNNTP._base_init^ s }}
%*! ($**4 !,, !
$$&
#r c | S Nr r s r __enter__zNNTP.__enter__ s r c fd} | r* j | r j y y y # t t f$ r Y +w xY w# | r j w w xY w)Nc t d S )Nr )hasattrr s r z NNTP.__exit__.. s wtV 4r )quitOSErrorEOFError_close)r r is_connecteds ` r __exit__z
NNTP.__exit__ sd 4 >
" >KKM "
X&
>KKM "s! 9 A A
A A A(c |
|s t d t j d| | j | j t j | j | j f| S )Nz0Non-blocking socket (timeout=0) is not supportedznntplib.connect)
ValueErrorsysauditr r socketcreate_connection)r r s r r zNNTP._create_socket sQ w OP P #T499dii@''DII(>HHr c p | j r t dt | j | j S )zGet the welcome message from the server
(this is read and squirreled away by __init__()).
If the response code is 200, posting is allowed;
if it 201, posting is not allowed.z *welcome*)r printreprr r s r
getwelcomezNNTP.getwelcome s' >>5d4<<.@A||r c n | j wd| _ d| _ | j \ }}|| _ d|v r!t t t |d | _ d|v rdj |d | _ | j S | j S # t t f$ r i | _ Y | j S w xY w)zGet the server capabilities, as read by __init__().
If the CAPABILITIES command is not supported, an empty dict is
returned.NrQ VERSIONIMPLEMENTATION )
r nntp_versionnntp_implementation capabilitiesmaxmaprb rJ r r )r respcapss r r zNNTP.getcapabilities s :: !D '+D $
P ! . . 0
d
"
$ ),CT)_,E(FD%#t+/2xx=M8N/OD,zztzz '(:;
zz
s B B43B4c || _ y)zSet the debugging level. Argument 'level' means:
0: no debugging output (default)
1: print commands and responses but not body text etc.
2: also print raw lines read and sent before stripping CR/LFN)r )r levels r set_debuglevelzNNTP.set_debuglevel s r c t j d| | |t z }| j dkD rt dt | | j j | | j j y)zfInternal: send one line to the server, appending CRLF.
The `line` must be a bytes-like object.znntplib.putlinerQ z*put*N) r r _CRLFr r r r writeflushr rY s r _putlinez
NNTP._putline sU #T40e| >>A uWd4j 9 r c | j rt dt | |j | j | j
}| j
| y)zkInternal: send one command to the server (through _putline()).
The `line` must be a unicode string.z*cmd*N)r r r encodeencodingerrorsr r s r _putcmdz NNTP._putcmd s< >>5$t*5{{4==$++6
dr c & | j j t dz }t | t kD r t d | j
dkD rt
dt | |st |r#|dd t k( r|dd }|S |dd t v r|dd }|S )zInternal: return one line from the server, stripping _CRLF.
Raise EOFError if the connection is closed.
Returns a bytes object.rQ z
line too longz*get*ru N)
r readline_MAXLINErW r r r r r r )r
strip_crlfrY s r _getlinez
NNTP._getline s yy!!(A+. t9x 0 0 >>A '4: &8^ BCyE!CRy bce#CRy r c | j }| j rt dt | |j | j
| j }|dd }|dk( r t | |dk( r t | |dvr t | |S )zInternal: get a response from the server.
Raise various errors if the response indicates an error.
Returns a unicode string.z*resp*NrQ 45123)
r r r r rI r r r r r
)r r cs r r z
NNTP._getresp s }} >>54:6{{4==$++6 !H 8$T* * 8$T* * E>#D) ) r c d} t |t t f rt |d x}}| j }|dd t
vr t
| g }|Jdt z df} | j d }||v rni|j d r|dd }|j | >d} | j }||k( rn(|j d r|dd }|j | >|r|j ||fS # |r|j w w xY w) aP Internal: get a response plus following text from the server.
Raise various errors if the response indicates an error.
Returns a (response, lines) tuple where `response` is a unicode
string and `lines` is a list of bytes objects.
If `file` is a file-like object, it must be open in binary mode.
Nwbr .s .
rQ Fs ..)
rG strr8 openr _LONGRESPr r r rd r rH r )r r
openedFiler r9 terminatorsrY
terminators r _getlongrespzNNTP._getlongresp s)
#$e -$(t$44
T==?DBQxy($T**E #e|V 4 ==/D{* u- #ABxJJt$
"
==?Dz) u- #ABxLL&
"U{ " s CC3 3Dc D | j | | j S )zWInternal: send a command and get the response.
Same return value as _getresp().)r r r s r _shortcmdzNNTP._shortcmd s
T}} r c F | j | | j | S )zoInternal: send a command and get the response plus following text.
Same return value as _getlongresp().)r r )r rY r s r _longcmdz
NNTP._longcmd! s!
T &&r c | j | | j | \ }}||D cg c]( }|j | j | j * c}fS c c}w )zInternal: send a command and get the response plus following text.
Same as _longcmd() and _getlongresp(), except that the returned `lines`
are unicode strings rather than bytes objects.
)r r rI r r )r rY r r lists r _longcmdstringzNNTP._longcmdstring' sd
T&&t,
d"&("&$ kk$--="&( ( ( (s -A c | j S # t $ r Y nw xY w | j d \ }}t | }n# t $ r t
dd }Y nw xY w|| _ |S )zqInternal: get the overview format. Queries the server if not
already done, else returns the cached value.zLIST OVERVIEW.FMTN)_cachedoverviewfmtAttributeErrorr r^ r rV )r r r9 rX s r _getoverviewfmtzNNTP._getoverviewfmt1 su ** * - --.ABKD%
&e,C " +'*C +
#&
s > AAc T |D cg c] }t |j c}S c c}w r )r; ra )r r9 rY s r
_grouplistzNNTP._grouplistB s% 5:;UT 4::<(U;;;s %c r i }| j d \ }}|D ] }|j ^}}|||< ||fS )a! Process a CAPABILITIES command. Not supported by all servers.
Return:
- resp: server response if successful
- caps: a dictionary mapping capability names to lists of tokens
(for example {'VERSION': ['2'], 'OVER': [], LIST: ['ACTIVE', 'HEADERS'] })
CAPABILITIES)r ra )r r r r9 rY rZ rj s r r zNNTP.capabilitiesF sK )).9 eD JJLMD6 DJ Tzr )r c ^ t |t j t j f s.t dj |j
j t || j dk \ }}dj || }| j || \ }}|| j | fS )zProcess a NEWGROUPS command. Arguments:
- date: a date or datetime object
Return:
- resp: server response if successful
- list: list of newsgroup names
Athe date parameter must be a date or datetime object, not '{:40}'rr zNEWGROUPS {0} {1}) rG rx r4 TypeErrorr __class__r r r r r )r r4 r ry rz cmdr r9 s r newgroupszNNTP.newgroupsT s $
>? $fT^^%<%< =?
? /tT5F5F5J K(!((8<))#t4 eT__U+++r c 4 t |t j t j f s.t dj |j
j t || j dk \ }}dj ||| }| j || S )zProcess a NEWNEWS command. Arguments:
- group: group name or '*'
- date: a date or datetime object
Return:
- resp: server response if successful
- list: list of message ids
r rr zNEWNEWS {0} {1} {2})
rG rx r4 r r r r r r r )r r< r4 r ry rz r s r newnewsz NNTP.newnewsd s $
>? $fT^^%<%< =?
? /tT5F5F5J K(#**5(HE""3--r c f |d|z }nd}| j || \ }}|| j | fS )a@ Process a LIST or LIST ACTIVE command. Arguments:
- group_pattern: a pattern indicating which groups to query
- file: Filename string or file object to store the result in
Returns:
- resp: server response if successful
- list: list of (group, last, first, flag) (strings)
z LIST ACTIVE LIST)r r )r
group_patternr commandr r9 s r r z NNTP.listt sC $$}4G G))'48 eT__U+++r c N t j d }| j d|z \ }}|j d s| j d|z \ }}i }|D ]D }|j |j }|s%|j
dd \ } }
|s|
c S |
|| < F |r||fS y)Nz ^(?P[^ ]+)[ ]+(.*)$zLIST NEWSGROUPS r) zXGTITLE rQ rr rE )recompiler rd searchstripr< ) r r
return_allline_patr r9 groupsraw_linematchrZ descs r _getdescriptionszNNTP._getdescriptions s :: >?))*<}*LM eu% --j=.HIKD% H OOHNN$45E "[[A .
d! K #t
< r c & | j |d S )a Get a description for a single group. If more than one
group matches ('group' is a pattern), return the first. If no
group matches, return an empty string.
This elides the response code from the server, since it can
only be '215' or '285' (for xgtitle) anyway. If the response
code is needed, use the 'descriptions' method.
NOTE: This neither checks for a wildcard in 'group' nor does
it check whether the group actually exists.Fr )r r< s r descriptionzNNTP.description s $$UE22r c & | j |d S )z'Get descriptions for a range of groups.Tr )r r
s r descriptionszNNTP.descriptions s $$]D99r c T | j d|z }|j d s t | |j }dx}x}}t | }|dkD r1|d }|dkD r'|d }|dkD r |d }|dkD r|d j }|t
| t
| t
| |fS )a Process a GROUP command. Argument:
- group: the group name
Returns:
- resp: server response if successful
- count: number of articles
- first: first article number
- last: last article number
- name: the group name
zGROUP r( r rQ rr r rs )r rd r ra rW rS rb )r rZ r wordscountr> r= ns r r< z
NNTP.group s ~~ho.u% & &
J q5!HE1u aq5 8D1u $Qx~~ /SZUSY<.remove_number5 s' $A$%1771a= /4 /r )r r r r ) r hdrr r r r9 rM rY rL s @r xhdrz NNTP.xhdr* s` jj-.)).*?*?S*I4P e 0 e % %Aw t9? % %_T4000r c | j | }|j d s t | t |t t
f r|j
}|D ]` }|j t s|j d t z }|j d rd|z }| j j | b | j j d | j j | j S )N3r: r s .
)r rd r rG r8 bytearray
splitlinesendswithr rstripr r r r )r r fr rY s r _postz
NNTP._postt s ~~g&s# & & a%+ , A
D=='{{7+e3t$d{ IIOOD !
! }} r c & | j d| S )zProcess a POST command. Arguments:
- data: bytes object, iterable or file containing the article
Returns:
- resp: server response if successfulPOST)re )r datas r postz NNTP.post s
zz&$''r c D | j dj | | S )a Process an IHAVE command. Arguments:
- message_id: message-id of the article
- data: file containing the article
Returns:
- resp: server response if successful
Note that if the server refuses the article an exception is raised.z IHAVE {0})re r )r rB rh s r ihavez
NNTP.ihave s zz+,,Z8$??r c | j r | j j | ` | j j y # | j j w xY wr )r r r r s r r z NNTP._close s> yy !I IIOO DIIOO s (A A!c t | j d }| j |S # | j w xY w)zdProcess a QUIT command and close the socket. Returns:
- resp: server response if successfulQUIT)r r )r r s r r z NNTP.quit s0 >>&)D KKM
KKMs % 7c l | j r t d |s
|s t d |r=|s;dd l}|j }|j | j }|r
|d }|d }|sy | j
d|z }|j d r=|s t | | j
d|z }|j d s t | d | _
| j | j r7d | j vr(| j d | _
| j y y y # t
$ r Y w xY w)
NzAlready logged in.z7At least one of `user` and `usenetrc` must be specifiedr rr zauthinfo user 381zauthinfo pass 281r )r r netrcauthenticatorsr r r rd r r r r r r )r r r r rr credentialsauthr s r r z
NNTP.login s5 12 2H IK
K
#kkm "11$))< 7D #AwH ~~ . 56 ??5 !$T**~~&6&ABu-,T22
$ $)C ! DJ " *D $% s ?D' ' D32D3c | j d | _ y # t $ r Y y t $ r.}|j j d rd| _ n Y d }~y d }~ww xY w)Nz mode reader480T)r r r r r rd r )r es r r zNNTP._setreadermode sT
>>-8DL! ! zz$$U+,0) * s AA$AAc | j r t d | j r t d | j d }|j d r| j
j
t | j || j | _ | j j d | _ d| _ d| _ | j yt d ) zzProcess a STARTTLS command. Arguments:
- context: SSL context to use for the encrypted connection
zTLS is already enabled.z+TLS cannot be started after authentication.STARTTLS382r TNzTLS failed to start.)r r r r rd r r r r r r r r r )r r r s r starttlsz
NNTP.starttls s {{ !:;;!! !NOO>>*-Du% ! ' 7DII F II . .u 5 " "
$$& 677r )Tr )NNT):r r r r r NNTP_PORTr r r r r r r r r debugr r r r r r r r r r r r r
r r r r r< r& r* r, r0 r4 r= r9 r> rB rE rH rO rS rX r4 re ri rk r r r r _have_sslr| r r r r r + sc H
F"+$ 50!F #D "I ,
E " ,\ ' ("< '+ , ,0 .
,t
, . 3:=4 1)%
) %%= 'd ' 'd ' ' ' ' &* = )- 1 *. 161" *(@ '#R 8 r r c 8 e Zd Zedddddef fd Z fdZ xZS )NNTP_SSLNFc > || _ t | ||||||| y)zThis works identically to NNTP.__init__, except for the change
in default port and the `ssl_context` argument for SSL connections.
N) ssl_contextsuperr )
r r r r r r r r r r s
r r zNNTP_SSL.__init__ s) +D G T4x %w
0r c t | | } t || j | j }|S # |j xY wr )r r r r r r )r r r r s r r zNNTP_SSL._create_socket sI 7)'2D
"4)9)9499E
s !5 A)r r r
NNTP_SSL_PORTr r r
__classcell__)r s @r r r s$ &3 $ #e 3 0 r r __main__zJ nntplib built-in demo - display the latest articles in a newsgroup)r z-gz--groupzgmane.comp.python.generalz3group to fetch messages from (default: %(default)s))defaultr& z-sz--serverz
news.gmane.ioz+NNTP server hostname (default: %(default)s)z-pz--portr zNNTP port number (default: z / ))r typer& z-nz
--nb-articles
z2number of articles to fetch (default: %(default)s)z-Sz--ssl
store_truezuse NNTP over SSL)actionr r& )r r rz Grouphaszarticles, rangetoc 8 t | |kD r | d |dz
dz } | S )Nrs z...)rW )slims r cutr 6 s& q6C<(37 e#Ar rQ r3 r= rZ r r r nb_articlesrS overviewsartnumrX ra authorr2 r9 r r r r r r s B
I > *
Xg . 0 0 Y I
O
"K " ";#E
G %k$$]%FH
2:H, 4
C K 8 K 8\
4 . NN: z
$X
$
$ 2N OF
i1L R T
j/ J L
hFOQ^ _ a
or Q S
glE 0 2 D 99D 88 2: D dkk - 2: D $++D 1 DT
%&WWTZZ%8"D%d '4'8%tL
D D , ,,q0 1EggeT*OD)! tF|,223:1= Y0DN#
%,,c&"os7B'7@ " FFHa U Is K7 7LL