]> git.phdru.name Git - extfs.d.git/blobdiff - torrent
Upgrade: http://phdru.name -> https://phdru.name
[extfs.d.git] / torrent
diff --git a/torrent b/torrent
index d5311d6e77201dae87b23051f6caa57ab45ac0df..7841fa7e672c950180e94414f2426a5e440891ba 100755 (executable)
--- a/torrent
+++ b/torrent
@@ -1,42 +1,77 @@
 #! /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).
 
-Make the script executable and put it in the
-/usr/[local/][lib|share]/mc/extfs/, add a line "torrent" to the
-/usr/[local/][lib|share]/mc/extfs/extfs.ini.
+For mc 4.7+ just put the script in $HOME/[.local/share/].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.
+
+For mc 4.7+ run this "cd" command in the Midnight Commander (in the "bindings"
+file the command is "%cd"): cd file/torrent://; In older versions it is
+cd file#torrent, where "file" is the name of your torrent metafile.
+
+See detailed installation instructions at
+https://phdru.name/Software/mc/torrent_INSTALL.html.
 
-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. Filenames are
-reencoded from the metafile's encoding to the current locale.
+The VFS lists all files and directories from the torrent metafile; 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 consists of .META file or
+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 to midnight of the 1st January of the current
-year. The filesystem is, naturally, read-only.
+Date/time for all directories/files is set to the value of 'creation date'
+field, if it exists; if not date/time is set to the last modification time of
+the torrent file itself.
+
+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.2.4"
+__author__ = "Oleg Broytman <phd@phdru.name>"
+__copyright__ = "Copyright (C) 2010-2018 PhiloSoft Design"
 __license__ = "GPL"
 
-import locale, sys, os
+
+from datetime import datetime
+from os.path import dirname, getmtime
+import sys
+from time import localtime, asctime
 from eff_bdecode import decode
 
+try:
+    import locale
+    use_locale = True
+except ImportError:
+    use_locale = False
+
+if use_locale:
+    # Get the default charset.
+    try:
+        lcAll = locale.getdefaultlocale()
+    except locale.Error, err:
+        print >>sys.stderr, "WARNING:", err
+        lcAll = []
+
+    if len(lcAll) == 2:
+        default_encoding = lcAll[1]
+    else:
+        try:
+            default_encoding = locale.getpreferredencoding()
+        except locale.Error, err:
+            print >>sys.stderr, "WARNING:", err
+            default_encoding = sys.getdefaultencoding()
+else:
+    default_encoding = sys.getdefaultencoding()
+
 import logging
 logger = logging.getLogger('torrent-mcextfs')
 log_err_handler = logging.StreamHandler(sys.stderr)
@@ -49,15 +84,12 @@ 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!""",
-   __version__, __author__, __copyright__
-)
+This is not a program. Put the script in $HOME/[.local/share/].mc/extfs.d or
+/usr/[local/][lib|share]/mc/extfs. For more information read the source!""",
+                    __version__, __author__, __copyright__)
     sys.exit(1)
 
-
 locale.setlocale(locale.LC_ALL, '')
-charset = locale.getpreferredencoding()
 
 
 def mctorrent_list():
@@ -67,41 +99,91 @@ 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')
 
-    name = info['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)
+
+    dt = 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 = '/'.join([name] + file['path'])
-            if charset and encoding and (charset != encoding):
-                path = path.decode(encoding, 'replace').encode(charset, 'replace')
+            if 'path.utf-8' in file:
+                if name_utf8:
+                    path = '/'.join([name_utf8] + file['path.utf-8'])
+                    if default_encoding != 'utf-8':
+                        path = path.decode('utf-8', 'replace').encode(
+                            default_encoding, '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 default_encoding != 'utf-8':
+                        path = path.decode('utf-8', 'replace').encode(
+                            default_encoding, '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 default_encoding != 'utf-8':
+                        path = path.decode('utf-8', 'replace').encode(
+                            default_encoding, 'replace')
+                else:
+                    path = '/'.join([name] + file['path'])
+                    if encoding and (default_encoding != encoding):
+                        path = path.decode(encoding, 'replace').encode(
+                            default_encoding, 'replace')
             length = file['length']
             paths.append((path, length))
-    else: # One-file torrent
+    else:  # One-file torrent
         if 'length' not in info:
             torrent_error('Unknown length')
         length = info['length']
-        if charset and encoding and (charset != encoding):
-            name = name.decode(encoding, 'replace').encode(charset, 'replace')
+        if name_utf8:
+            if default_encoding != 'utf-8':
+                name = name_utf8.decode('utf-8', 'replace').encode(
+                    default_encoding, 'replace')
+        elif encoding and (default_encoding != encoding):
+            name = name.decode(encoding, 'replace').encode(
+                default_encoding, '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':
-                data = decode_datetime(torrent[name])
-            elif name == 'announce-list':
-                data = decode_list(torrent[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(
+                default_encoding, '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':
+                dt = torrent[name]
+                data = decode_datetime_asc(dt)
+                dt = decode_datetime(dt)
+            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)))
@@ -112,8 +194,20 @@ def mctorrent_list():
     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)
+    paths += meta
+    dirs = set()
+    for name, size in paths:
+        if '/' in name:
+            dirs.add(dirname(name))
+
+    if not dt:
+        dt = decode_datetime(getmtime(sys.argv[2]))
+
+    for name in sorted(dirs):
+        print "dr-xr-xr-x 1 user group 0 %s %s" % (dt, name)
+
+    for name, size in sorted(paths):
+        print "-r--r--r-- 1 user group %d %s %s" % (size, dt, name)
 
 
 def mctorrent_copyout():
@@ -123,14 +217,24 @@ 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(
+                default_encoding, 'replace')
+        elif torrent_filename == '.META/' + name:
             if name in torrent:
-                if name == 'creation date':
-                    data = decode_datetime(torrent[name])
-                elif name == 'announce-list':
-                    data = decode_list(torrent[name])
+                if name == 'announce-list':
+                    data = decode_announce_list(torrent[name])
+                elif name == 'codepage':
+                    data = str(torrent[name])
+                elif name == 'creation date':
+                    data = decode_datetime_asc(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:
@@ -164,21 +268,27 @@ def mctorrent_copyin():
     """Put a file to the VFS"""
     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 (read-only filesystem)")
+    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 (read-only filesystem)")
+    sys.exit("Torrent VFS doesn't support creating directories "
+             "(read-only filesystem)")
 
 
 def torrent_error(error_str):
     logger.critical("Error parsing the torrent metafile: %s", error_str)
     sys.exit(1)
 
+
 def decode_torrent():
     try:
         torrent_file = open(sys.argv[2], 'r')
@@ -189,21 +299,31 @@ def decode_torrent():
         torrent_error(error_str)
 
 
+def decode_datetime_asc(dt):
+    try:
+        return asctime(localtime(float(dt)))
+    except ValueError:
+        return datetime.max.ctime()
+
+
 def decode_datetime(dt):
-    from time import localtime, asctime
-    the_time = float(dt)
-    l_now = localtime(the_time)
-    return asctime(l_now)
+    try:
+        Y, m, d, H, M = localtime(float(dt))[0:5]
+    except ValueError:
+        return datetime.max.ctime()
+    else:
+        return "%02d-%02d-%d %02d:%02d" % (m, d, Y, H, M)
+
 
-def decode_list(announce):
-    return '\n'.join(l[0] for l in announce)
+def decode_announce_list(announce):
+    return '\n'.join(l[0] for l in announce if l)
 
 
 command = sys.argv[1]
 procname = "mctorrent_" + command
 
 g = globals()
-if not g.has_key(procname):
+if procname not in g:
     logger.critical("Unknown command %s", command)
     sys.exit(1)