Documented the fact that the script can be put in $HOME/.mc/extfs.d
[extfs.d.git] / torrent
diff --git a/torrent b/torrent
index 521d102..ebaa7bf 100755 (executable)
--- a/torrent
+++ b/torrent
@@ -1,40 +1,38 @@
 #! /usr/bin/env python
-
 """Torrent Virtual FileSystem for Midnight Commander
 
 The script requires Midnight Commander 3.1+
 (http://www.midnight-commander.org/), Python 2.4+ (http://www.python.org/),
 module eff_bdecode.py (http://effbot.org/zone/bencode.htm).
 
-Put the script in the /usr/[local/][lib|share]/mc/extfs/, and add a line
-"torrent" to the /usr/[local/][lib|share]/mc/extfs/extfs.ini. Make the script
-executable.
+For mc 4.7+ put the script in $HOME/.mc/extfs.d.
+For older versions put it in /usr/[local/][lib|share]/mc/extfs
+and add a line "torrent" to the /usr/[local/][lib|share]/mc/extfs/extfs.ini.
+Make the script executable.
 
 Run this "cd" command in the Midnight Commander (in the "bindings" file the
 command is "%cd"): cd file#torrent, where "file" is the name of your torrent
 metafile. The VFS lists all files and directories from the torrent metafile;
-all files appear empty, of course, but the sizes are shown.
+all files appear empty, of course, but the sizes are shown. Filenames are
+reencoded from the metafile's encoding/codepage to the current locale.
 
 Along with the files/directories in the torrent metafile the VFS also presents
 meta information - in the form of files in .META directory. The size and
 contents of these files are taken from the corresponding fields in the torrent
-metafile. The VFS doesn't check if the torrent contains .META file or directory
-(quite unlikely).
+metafile. The script doesn't check if the torrent consists of a .META file or
+directory (quite unlikely).
 
-Date/time for all files is set at midnight of the 1st January of the current
-year. The filesystem is read-only, of course.
+Date/time for all files is set to midnight of the 1st January of the current
+year. The filesystem is, naturally, read-only.
 
 """
 
-__version__ = "1.0.0"
-__revision__ = "$Id$"
-__date__ = "$Date$"
-__author__ = "Oleg Broytman <phd@phd.pp.ru>"
-__copyright__ = "Copyright (C) 2010 PhiloSoft Design"
+__version__ = "1.1.1"
+__author__ = "Oleg Broytman <phd@phdru.name>"
+__copyright__ = "Copyright (C) 2010-2013 PhiloSoft Design"
 __license__ = "GPL"
 
 import locale, sys, os
-from tempfile import _candidate_tempdir_list
 from eff_bdecode import decode
 
 import logging
@@ -49,35 +47,13 @@ Torrent Virtual FileSystem for Midnight Commander version %s
 Author: %s
 %s
 
-This is not a program. Put the script in /usr/[local/][lib|share]/mc/extfs.
-For more information read the source!""",
+This is not a program. Put the script in $HOME/.mc/extfs.d or
+/usr/[local/][lib|share]/mc/extfs. For more information read the source!""",
    __version__, __author__, __copyright__
 )
     sys.exit(1)
 
 
-tempdirlist = _candidate_tempdir_list()
-tempdirlist.insert(0, os.path.abspath(os.path.dirname(sys.argv[2])))
-
-found = False
-for tempdir in tempdirlist:
-    try:
-        logfile_name = os.path.join(tempdir, 'torrent-mcextfs.log')
-        logfile = open(logfile_name, 'w')
-    except IOError:
-        pass
-    else:
-        found = True
-        logfile.close()
-        break
-
-if not found:
-    logger.critical("Cannot initialize error log file in directories %s" % str(tempdirlist))
-    sys.exit(1)
-
-logger.removeHandler(log_err_handler)
-logger.addHandler(logging.FileHandler(logfile_name))
-
 locale.setlocale(locale.LC_ALL, '')
 charset = locale.getpreferredencoding()
 
@@ -89,35 +65,79 @@ def mctorrent_list():
         torrent_error('Info absent')
 
     info = torrent['info']
-    if 'name' not in info:
+    if 'name' not in info and 'name.utf-8' not in info:
         torrent_error('Unknown name')
 
+    codepage = torrent.get('codepage', None)
+    encoding = torrent.get('encoding', None)
+    if not encoding and codepage:
+        encoding = str(codepage)
+
     name = info['name']
+    name_utf8 = info.get('name.utf-8', None)
+
     if 'files' in info:
         files = info['files']
         paths = []
         for file in files:
-            if 'path' not in file:
+            if 'path' not in file and 'path.utf-8' not in file:
                 torrent_error('Unknown path')
             if 'length' not in file:
                 torrent_error('Unknown length')
-            path = file['path']
+            if 'path.utf-8' in file:
+                if name_utf8:
+                    path = '/'.join([name_utf8] + file['path.utf-8'])
+                    if charset and (charset != 'utf-8'):
+                        path = path.decode('utf-8', 'replace').encode(charset, 'replace')
+                else:
+                    _name_utf8 = name
+                    if encoding and (encoding != 'utf-8'):
+                        _name_utf8 = _name_utf8.decode(encoding, 'replace').encode('utf-8', 'replace')
+                    path = '/'.join([_name_utf8] + file['path.utf-8'])
+                    if charset and (charset != 'utf-8'):
+                        path = path.decode('utf-8', 'replace').encode(charset, 'replace')
+            else:
+                if name_utf8:
+                    path = file['path']
+                    if encoding and (encoding != 'utf-8'):
+                        path = path.decode(encoding, 'replace').encode('utf-8', 'replace')
+                    path = '/'.join([name_utf8] + path)
+                    if charset and (charset != 'utf-8'):
+                        path = path.decode('utf-8', 'replace').encode(charset, 'replace')
+                else:
+                    path = '/'.join([name] + file['path'])
+                    if charset and encoding and (charset != encoding):
+                        path = path.decode(encoding, 'replace').encode(charset, 'replace')
             length = file['length']
-            paths.append(('/'.join([name] + path), length))
+            paths.append((path, length))
     else: # One-file torrent
         if 'length' not in info:
             torrent_error('Unknown length')
         length = info['length']
+        if name_utf8:
+            if charset and (charset != 'utf-8'):
+                name = name_utf8.decode('utf-8', 'replace').encode(charset, 'replace')
+        elif charset and encoding and (charset != encoding):
+            name = name.decode(encoding, 'replace').encode(charset, 'replace')
         paths = [(name, length)]
 
     meta = []
-    for name in 'comment', 'encoding', 'creation date', 'announce-list', \
-            'created by', 'announce':
-        if name in torrent:
-            if name == 'creation date':
+    for name in 'announce', 'announce-list', 'codepage', 'comment', \
+                'created by', 'creation date', 'encoding', \
+                'nodes', 'publisher', 'publisher-url':
+        if name == 'comment' and 'comment.utf-8' in torrent:
+            data = torrent['comment.utf-8'].decode('utf-8').encode(charset, 'replace')
+            meta.append(('.META/' + name, len(data)))
+        elif name in torrent:
+            if name == 'announce-list':
+                data = decode_announce_list(torrent[name])
+            elif name == 'codepage':
+                data = str(torrent[name])
+            elif name == 'creation date':
                 data = decode_datetime(torrent[name])
-            elif name == 'announce-list':
-                data = decode_list(torrent[name])
+            elif name == 'nodes':
+                data = ['%s:%s' % (host, port) for host, port in torrent[name]]
+                data = '\n'.join(data)
             else:
                 data = torrent[name]
             meta.append(('.META/' + name, len(data)))
@@ -125,6 +145,9 @@ def mctorrent_list():
     if 'private' in info:
         meta.append(('.META/private', 1))
 
+    if 'piece length' in info:
+        meta.append(('.META/piece length', len(str(info['piece length']))))
+
     for name, size in paths + meta:
         print "-r--r--r-- 1 user group %d Jan 1 00:00 %s" % (size, name)
 
@@ -136,27 +159,40 @@ def mctorrent_copyout():
     real_filename = sys.argv[4]
     data = None
 
-    for name in 'comment', 'encoding', 'creation date', 'announce-list', \
-            'created by', 'announce':
-        if torrent_filename == '.META/' + name:
+    for name in 'announce', 'announce-list', 'codepage', 'comment', \
+                'created by', 'creation date', 'encoding', \
+                'nodes', 'publisher', 'publisher-url':
+        if name == 'comment' and 'comment.utf-8' in torrent:
+            data = torrent['comment.utf-8'].decode('utf-8').encode(charset, 'replace')
+            meta.append(('.META/' + name, len(data)))
+        elif torrent_filename == '.META/' + name:
             if name in torrent:
-                if name == 'creation date':
+                if name == 'announce-list':
+                    data = decode_announce_list(torrent[name])
+                elif name == 'codepage':
+                    data = str(torrent[name])
+                elif name == 'creation date':
                     data = decode_datetime(torrent[name])
-                elif name == 'announce-list':
-                    data = decode_list(torrent[name])
+                elif name == 'nodes':
+                    data = ['%s:%s' % (host, port) for host, port in torrent[name]]
+                    data = '\n'.join(data)
                 else:
                     data = str(torrent[name])
             else:
                 torrent_error('Unknown ' + name)
             break
 
-    if torrent_filename == '.META/private':
+    if torrent_filename in ('.META/private', '.META/piece length'):
         if 'info' not in torrent:
             torrent_error('Info absent')
         info = torrent['info']
-        if 'private' not in info:
-            torrent_error('Info absent')
-        data = str(info['private'])
+        if torrent_filename == '.META/private':
+            if 'private' not in info:
+                torrent_error('Info absent')
+        if torrent_filename == '.META/piece length':
+            if 'piece length' not in info:
+                torrent_error('Info absent')
+        data = str(info[torrent_filename[len('.META/'):]])
 
     if not torrent_filename.startswith('.META/'):
         data = ''
@@ -171,17 +207,17 @@ def mctorrent_copyout():
 
 def mctorrent_copyin():
     """Put a file to the VFS"""
-    sys.exit("Torrent VFS doesn't support adding files")
+    sys.exit("Torrent VFS doesn't support adding files (read-only filesystem)")
 
 def mctorrent_rm():
     """Remove a file from the VFS"""
-    sys.exit("Torrent VFS doesn't support removing files/directories")
+    sys.exit("Torrent VFS doesn't support removing files/directories (read-only filesystem)")
 
 mctorrent_rmdir = mctorrent_rm
 
 def mctorrent_mkdir():
     """Create a directory in the VFS"""
-    sys.exit("Torrent VFS doesn't support creating directories")
+    sys.exit("Torrent VFS doesn't support creating directories (read-only filesystem)")
 
 
 def torrent_error(error_str):
@@ -204,7 +240,7 @@ def decode_datetime(dt):
     l_now = localtime(the_time)
     return asctime(l_now)
 
-def decode_list(announce):
+def decode_announce_list(announce):
     return '\n'.join(l[0] for l in announce)