2 """Torrent Virtual FileSystem for Midnight Commander
4 The script requires Midnight Commander 3.1+
5 (http://www.midnight-commander.org/), Python 2.4+ (http://www.python.org/),
6 module eff_bdecode.py (http://effbot.org/zone/bencode.htm).
8 For mc 4.7+ put the script in $HOME/.mc/extfs.d.
9 For older versions put it in /usr/[local/][lib|share]/mc/extfs
10 and add a line "torrent" to the /usr/[local/][lib|share]/mc/extfs/extfs.ini.
11 Make the script executable.
13 Run this "cd" command in the Midnight Commander (in the "bindings" file the
14 command is "%cd"): cd file#torrent, where "file" is the name of your torrent
15 metafile. The VFS lists all files and directories from the torrent metafile;
16 all files appear empty, of course, but the sizes are shown. Filenames are
17 reencoded from the metafile's encoding/codepage to the current locale.
19 Along with the files/directories in the torrent metafile the VFS also presents
20 meta information - in the form of files in .META directory. The size and
21 contents of these files are taken from the corresponding fields in the torrent
22 metafile. The script doesn't check if the torrent consists of a .META file or
23 directory (quite unlikely).
25 Date/time for all files is set to midnight of the 1st January of the current
26 year. The filesystem is, naturally, read-only.
31 __author__ = "Oleg Broytman <phd@phdru.name>"
32 __copyright__ = "Copyright (C) 2010-2013 PhiloSoft Design"
35 import locale, sys, os
36 from eff_bdecode import decode
39 logger = logging.getLogger('torrent-mcextfs')
40 log_err_handler = logging.StreamHandler(sys.stderr)
41 logger.addHandler(log_err_handler)
42 logger.setLevel(logging.INFO)
46 Torrent Virtual FileSystem for Midnight Commander version %s
50 This is not a program. Put the script in /usr/[local/][lib|share]/mc/extfs.
51 For more information read the source!""",
52 __version__, __author__, __copyright__
57 locale.setlocale(locale.LC_ALL, '')
58 charset = locale.getpreferredencoding()
62 """List the entire VFS"""
64 if 'info' not in torrent:
65 torrent_error('Info absent')
67 info = torrent['info']
68 if 'name' not in info and 'name.utf-8' not in info:
69 torrent_error('Unknown name')
71 codepage = torrent.get('codepage', None)
72 encoding = torrent.get('encoding', None)
73 if not encoding and codepage:
74 encoding = str(codepage)
77 name_utf8 = info.get('name.utf-8', None)
83 if 'path' not in file and 'path.utf-8' not in file:
84 torrent_error('Unknown path')
85 if 'length' not in file:
86 torrent_error('Unknown length')
87 if 'path.utf-8' in file:
89 path = '/'.join([name_utf8] + file['path.utf-8'])
90 if charset and (charset != 'utf-8'):
91 path = path.decode('utf-8', 'replace').encode(charset, 'replace')
94 if encoding and (encoding != 'utf-8'):
95 _name_utf8 = _name_utf8.decode(encoding, 'replace').encode('utf-8', 'replace')
96 path = '/'.join([_name_utf8] + file['path.utf-8'])
97 if charset and (charset != 'utf-8'):
98 path = path.decode('utf-8', 'replace').encode(charset, 'replace')
102 if encoding and (encoding != 'utf-8'):
103 path = path.decode(encoding, 'replace').encode('utf-8', 'replace')
104 path = '/'.join([name_utf8] + path)
105 if charset and (charset != 'utf-8'):
106 path = path.decode('utf-8', 'replace').encode(charset, 'replace')
108 path = '/'.join([name] + file['path'])
109 if charset and encoding and (charset != encoding):
110 path = path.decode(encoding, 'replace').encode(charset, 'replace')
111 length = file['length']
112 paths.append((path, length))
113 else: # One-file torrent
114 if 'length' not in info:
115 torrent_error('Unknown length')
116 length = info['length']
118 if charset and (charset != 'utf-8'):
119 name = name_utf8.decode('utf-8', 'replace').encode(charset, 'replace')
120 elif charset and encoding and (charset != encoding):
121 name = name.decode(encoding, 'replace').encode(charset, 'replace')
122 paths = [(name, length)]
125 for name in 'announce', 'announce-list', 'codepage', 'comment', \
126 'created by', 'creation date', 'encoding':
128 if name == 'announce-list':
129 data = decode_list(torrent[name])
130 elif name == 'codepage':
131 data = str(torrent[name])
132 elif name == 'creation date':
133 data = decode_datetime(torrent[name])
136 meta.append(('.META/' + name, len(data)))
138 if 'private' in info:
139 meta.append(('.META/private', 1))
141 if 'piece length' in info:
142 meta.append(('.META/piece length', len(str(info['piece length']))))
144 for name, size in paths + meta:
145 print "-r--r--r-- 1 user group %d Jan 1 00:00 %s" % (size, name)
148 def mctorrent_copyout():
149 """Extract a file from the VFS"""
151 torrent_filename = sys.argv[3]
152 real_filename = sys.argv[4]
155 for name in 'announce', 'announce-list', 'codepage', 'comment', \
156 'created by', 'creation date', 'encoding':
157 if torrent_filename == '.META/' + name:
159 if name == 'announce-list':
160 data = decode_list(torrent[name])
161 elif name == 'codepage':
162 data = str(torrent[name])
163 elif name == 'creation date':
164 data = decode_datetime(torrent[name])
166 data = str(torrent[name])
168 torrent_error('Unknown ' + name)
171 if torrent_filename in ('.META/private', '.META/piece length'):
172 if 'info' not in torrent:
173 torrent_error('Info absent')
174 info = torrent['info']
175 if torrent_filename == '.META/private':
176 if 'private' not in info:
177 torrent_error('Info absent')
178 if torrent_filename == '.META/piece length':
179 if 'piece length' not in info:
180 torrent_error('Info absent')
181 data = str(info[torrent_filename[len('.META/'):]])
183 if not torrent_filename.startswith('.META/'):
187 torrent_error('Unknown file name')
189 outfile = open(real_filename, 'w')
194 def mctorrent_copyin():
195 """Put a file to the VFS"""
196 sys.exit("Torrent VFS doesn't support adding files (read-only filesystem)")
199 """Remove a file from the VFS"""
200 sys.exit("Torrent VFS doesn't support removing files/directories (read-only filesystem)")
202 mctorrent_rmdir = mctorrent_rm
204 def mctorrent_mkdir():
205 """Create a directory in the VFS"""
206 sys.exit("Torrent VFS doesn't support creating directories (read-only filesystem)")
209 def torrent_error(error_str):
210 logger.critical("Error parsing the torrent metafile: %s", error_str)
213 def decode_torrent():
215 torrent_file = open(sys.argv[2], 'r')
216 data = torrent_file.read()
219 except IOError, error_str:
220 torrent_error(error_str)
223 def decode_datetime(dt):
224 from time import localtime, asctime
226 l_now = localtime(the_time)
227 return asctime(l_now)
229 def decode_list(announce):
230 return '\n'.join(l[0] for l in announce)
233 command = sys.argv[1]
234 procname = "mctorrent_" + command
237 if not g.has_key(procname):
238 logger.critical("Unknown command %s", command)
241 torrent = decode_torrent()
248 logger.exception("Error during run")