Google Git
Sign in
chromium / external / github.com / python / cpython / refs/tags/3.7 / . / Lib / uu.py
blob: 9fe252a639eace1d288c31a4993508a2e40b0427 [file] [log] [blame]
Benjamin Peterson90f5ba52010-03-11 22:53:45[diff] [blame]1#! /usr/bin/env python3
Guido van Rossum105bd981997-07-11 18:39:03[diff] [blame]2
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]3# Copyright 1994 by Lance Ellinghouse
4# Cathedral City, California Republic, United States of America.
5# All Rights Reserved
Tim Peterse1190062001-01-15 03:34:38[diff] [blame]6# Permission to use, copy, modify, and distribute this software and its
7# documentation for any purpose and without fee is hereby granted,
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]8# provided that the above copyright notice appear in all copies and that
Tim Peterse1190062001-01-15 03:34:38[diff] [blame]9# both that copyright notice and this permission notice appear in
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]10# supporting documentation, and that the name of Lance Ellinghouse
Tim Peterse1190062001-01-15 03:34:38[diff] [blame]11# not be used in advertising or publicity pertaining to distribution
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]12# of the software without specific, written prior permission.
13# LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO
14# THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
15# FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE CENTRUM BE LIABLE
16# FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
19# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Jack Jansen0a2eaac1995-08-07 14:37:38[diff] [blame]20#
21# Modified by Jack Jansen, CWI, July 1995:
22# - Use binascii module to do the actual line-by-line conversion
23# between ascii and binary. This results in a 1000-fold speedup. The C
24# version is still 5 times faster, though.
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]25# - Arguments more compliant with python standard
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]26
Guido van Rossume7b146f2000-02-04 15:28:42[diff] [blame]27"""Implementation of the UUencode and UUdecode functions.
28
Xiang Zhang13f1f422017-05-03 03:16:21[diff] [blame]29encode(in_file, out_file [,name, mode], *, backtick=False)
30decode(in_file [, out_file, mode, quiet])
Guido van Rossume7b146f2000-02-04 15:28:42[diff] [blame]31"""
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]32
Jack Jansen0a2eaac1995-08-07 14:37:38[diff] [blame]33import binascii
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]34import os
Guido van Rossumfbba3041998-10-22 16:18:25[diff] [blame]35import sys
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]36
Skip Montanaro40fc1602001-03-01 04:27:19[diff] [blame]37__all__ = ["Error", "encode", "decode"]
38
Fred Drake9b8d8012000-08-17 04:45:13[diff] [blame]39class Error(Exception):
40 pass
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]41
Xiang Zhang13f1f422017-05-03 03:16:21[diff] [blame]42def encode(in_file, out_file, name=None, mode=None, *, backtick=False):
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]43 """Uuencode file"""
44 #
45 # If in_file is a pathname open it and change defaults
46 #
Antoine Pitroubfa34702010-10-30 13:03:56[diff] [blame]47 opened_files = []
48 try:
49 if in_file == '-':
50 in_file = sys.stdin.buffer
51 elif isinstance(in_file, str):
52 if name is None:
53 name = os.path.basename(in_file)
54 if mode is None:
55 try:
56 mode = os.stat(in_file).st_mode
57 except AttributeError:
58 pass
59 in_file = open(in_file, 'rb')
60 opened_files.append(in_file)
61 #
62 # Open out_file if it is a pathname
63 #
64 if out_file == '-':
65 out_file = sys.stdout.buffer
66 elif isinstance(out_file, str):
67 out_file = open(out_file, 'wb')
68 opened_files.append(out_file)
69 #
70 # Set defaults for name and mode
71 #
Fred Drake8152d322000-12-12 23:20:45[diff] [blame]72 if name is None:
Antoine Pitroubfa34702010-10-30 13:03:56[diff] [blame]73 name = '-'
Fred Drake8152d322000-12-12 23:20:45[diff] [blame]74 if mode is None:
Antoine Pitroubfa34702010-10-30 13:03:56[diff] [blame]75 mode = 0o666
Miss Islington (bot)87f2d262019-12-02 22:43:15[diff] [blame]76
77 #
78 # Remove newline chars from name
79 #
80 name = name.replace('\n','\\n')
81 name = name.replace('\r','\\r')
82
Antoine Pitroubfa34702010-10-30 13:03:56[diff] [blame]83 #
84 # Write the data
85 #
86 out_file.write(('begin %o %s\n' % ((mode & 0o777), name)).encode("ascii"))
Walter Dörwald91043f32005-11-22 12:58:19[diff] [blame]87 data = in_file.read(45)
Antoine Pitroubfa34702010-10-30 13:03:56[diff] [blame]88 while len(data) > 0:
Xiang Zhang13f1f422017-05-03 03:16:21[diff] [blame]89 out_file.write(binascii.b2a_uu(data, backtick=backtick))
Antoine Pitroubfa34702010-10-30 13:03:56[diff] [blame]90 data = in_file.read(45)
Xiang Zhang13f1f422017-05-03 03:16:21[diff] [blame]91 if backtick:
92 out_file.write(b'`\nend\n')
93 else:
94 out_file.write(b' \nend\n')
Antoine Pitroubfa34702010-10-30 13:03:56[diff] [blame]95 finally:
96 for f in opened_files:
97 f.close()
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]98
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]99
Georg Brandlfe991052009-09-16 15:54:04[diff] [blame]100def decode(in_file, out_file=None, mode=None, quiet=False):
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]101 """Decode uuencoded file"""
102 #
103 # Open the input file, if needed.
104 #
Antoine Pitrouf5698262010-10-31 16:04:14[diff] [blame]105 opened_files = []
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]106 if in_file == '-':
Guido van Rossum34d19282007-08-09 01:03:29[diff] [blame]107 in_file = sys.stdin.buffer
Guido van Rossum3172c5d2007-10-16 18:12:55[diff] [blame]108 elif isinstance(in_file, str):
Guido van Rossum34d19282007-08-09 01:03:29[diff] [blame]109 in_file = open(in_file, 'rb')
Antoine Pitrouf5698262010-10-31 16:04:14[diff] [blame]110 opened_files.append(in_file)
111
112 try:
113 #
114 # Read until a begin is encountered or we've exhausted the file
115 #
116 while True:
117 hdr = in_file.readline()
118 if not hdr:
119 raise Error('No valid begin line found in input file')
120 if not hdr.startswith(b'begin'):
121 continue
122 hdrfields = hdr.split(b' ', 2)
123 if len(hdrfields) == 3 and hdrfields[0] == b'begin':
124 try:
125 int(hdrfields[1], 8)
126 break
127 except ValueError:
128 pass
129 if out_file is None:
130 # If the filename isn't ASCII, what's up with that?!?
131 out_file = hdrfields[2].rstrip(b' \t\r\n\f').decode("ascii")
132 if os.path.exists(out_file):
Miss Islington (bot)1ce801b2023-05-27 07:04:28[diff] [blame]133 raise Error(f'Cannot overwrite existing file: {out_file}')
134 if (out_file.startswith(os.sep) or
135 f'..{os.sep}' in out_file or (
136 os.altsep and
137 (out_file.startswith(os.altsep) or
138 f'..{os.altsep}' in out_file))
139 ):
140 raise Error(f'Refusing to write to {out_file} due to directory traversal')
Antoine Pitrouf5698262010-10-31 16:04:14[diff] [blame]141 if mode is None:
142 mode = int(hdrfields[1], 8)
143 #
144 # Open the output file
145 #
146 if out_file == '-':
147 out_file = sys.stdout.buffer
148 elif isinstance(out_file, str):
149 fp = open(out_file, 'wb')
Miss Islington (bot)a261b732019-01-17 14:32:59[diff] [blame]150 os.chmod(out_file, mode)
Antoine Pitrouf5698262010-10-31 16:04:14[diff] [blame]151 out_file = fp
152 opened_files.append(out_file)
153 #
154 # Main decoding loop
155 #
Guido van Rossum44941011999-01-05 18:02:24[diff] [blame]156 s = in_file.readline()
Antoine Pitrouf5698262010-10-31 16:04:14[diff] [blame]157 while s and s.strip(b' \t\r\n\f') != b'end':
158 try:
159 data = binascii.a2b_uu(s)
160 except binascii.Error as v:
161 # Workaround for broken uuencoders by /Fredrik Lundh
162 nbytes = (((s[0]-32) & 63) * 4 + 5) // 3
163 data = binascii.a2b_uu(s[:nbytes])
164 if not quiet:
165 sys.stderr.write("Warning: %s\n" % v)
166 out_file.write(data)
167 s = in_file.readline()
168 if not s:
169 raise Error('Truncated input file')
170 finally:
171 for f in opened_files:
172 f.close()
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]173
174def test():
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]175 """uuencode/uudecode main program"""
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]176
Walter Dörwaldd331b432005-11-22 14:12:21[diff] [blame]177 import optparse
178 parser = optparse.OptionParser(usage='usage: %prog [-d] [-t] [input [output]]')
179 parser.add_option('-d', '--decode', dest='decode', help='Decode (instead of encode)?', default=False, action='store_true')
180 parser.add_option('-t', '--text', dest='text', help='data is text, encoded format unix-compatible text?', default=False, action='store_true')
181
182 (options, args) = parser.parse_args()
183 if len(args) > 2:
Thomas Wouters49fd7fa2006-04-21 10:40:58[diff] [blame]184 parser.error('incorrect number of arguments')
Guido van Rossum45e2fbc1998-03-26 21:13:24[diff] [blame]185 sys.exit(1)
Tim Peterse1190062001-01-15 03:34:38[diff] [blame]186
Guido van Rossum34d19282007-08-09 01:03:29[diff] [blame]187 # Use the binary streams underlying stdin/stdout
188 input = sys.stdin.buffer
189 output = sys.stdout.buffer
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]190 if len(args) > 0:
Guido van Rossum45e2fbc1998-03-26 21:13:24[diff] [blame]191 input = args[0]
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]192 if len(args) > 1:
Guido van Rossum45e2fbc1998-03-26 21:13:24[diff] [blame]193 output = args[1]
Jack Jansen8b745121995-08-30 12:19:30[diff] [blame]194
Walter Dörwaldd331b432005-11-22 14:12:21[diff] [blame]195 if options.decode:
196 if options.text:
Guido van Rossum3172c5d2007-10-16 18:12:55[diff] [blame]197 if isinstance(output, str):
Guido van Rossum34d19282007-08-09 01:03:29[diff] [blame]198 output = open(output, 'wb')
Guido van Rossum45e2fbc1998-03-26 21:13:24[diff] [blame]199 else:
Guido van Rossumbe19ed72007-02-09 05:37:30[diff] [blame]200 print(sys.argv[0], ': cannot do -t to stdout')
Guido van Rossum45e2fbc1998-03-26 21:13:24[diff] [blame]201 sys.exit(1)
202 decode(input, output)
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]203 else:
Walter Dörwaldd331b432005-11-22 14:12:21[diff] [blame]204 if options.text:
Guido van Rossum3172c5d2007-10-16 18:12:55[diff] [blame]205 if isinstance(input, str):
Guido van Rossum34d19282007-08-09 01:03:29[diff] [blame]206 input = open(input, 'rb')
Guido van Rossum45e2fbc1998-03-26 21:13:24[diff] [blame]207 else:
Guido van Rossumbe19ed72007-02-09 05:37:30[diff] [blame]208 print(sys.argv[0], ': cannot do -t from stdin')
Guido van Rossum45e2fbc1998-03-26 21:13:24[diff] [blame]209 sys.exit(1)
210 encode(input, output)
Guido van Rossum85347411994-09-09 11:10:15[diff] [blame]211
212if __name__ == '__main__':
213 test()