Merge lp:~david4dev/dmedia/cli-update-options into lp:dmedia

[David Green]

Updates the command line interface to use general file types.

=== modified file 'dmedia'
--- dmedia	2010-11-26 17:14:03 +0000
+++ dmedia	2010-11-28 12:11:16 +0000
@@ -2,6 +2,7 @@
 
 # Authors:
 #   Jason Gerard DeRose <[e-mail]>
+#   David Green <[e-mail]>
 #
 # dmedia: distributed media library
 # Copyright (C) 2010 Jason Gerard DeRose <[e-mail]>
@@ -79,7 +80,7 @@
 You can browse through the dmedia database using a standard web-browser, like
 this:
 
-  firefox ~/.local/share/desktop-couch/couchdb.html
+  xdg-open ~/.local/share/desktop-couch/couchdb.html
 
 Note that the sha1 hash is only being used as a stop-gap.  dmedia will use the
 Skein hash after its final constant tweaks are made.  See:
@@ -94,12 +95,13 @@
 import logging
 import dmedialib
 import xdg.BaseDirectory
+from dmedialib.constants import EXT_MAP
 
 script = path.basename(sys.argv[0])
 
 parser = optparse.OptionParser(
     version=dmedialib.__version__,
-    usage='Usage: %s DIRECTORY EXTENSIONS...' % script,
+    usage='Usage: %s DIRECTORY ' % script,
     epilog='Example: %s /media/EOS_DIGITAL jpg cr2 mov' % script,
 )
 parser.add_option('--quick',
@@ -117,6 +119,16 @@
     default=[],
     help='Add specified TAG to imported files',
 )
+parser.add_option('--type',
+    action='append',
+    default=[],
+    help="Add specified TYPE to the list of file types to limit the import to. TYPE can be 'image', 'audio', 'video' or 'all'. 'all' is the default and represents 'image', 'audio' and 'video' files.",
+)
+parser.add_option('--extension',
+    action='append',
+    default=[],
+    help='Add specified EXTENSION to the list of file extensions to limit the import to. By default, all file extensions that are recognised as audio, video or image file formats will be imported.',
+)
 
 (options, args) = parser.parse_args()
 
@@ -126,14 +138,22 @@
 ))
 
 
-if len(args) < 2:
+if len(args) < 1:
     parser.print_usage()
-    sys.exit('ERROR: must provide DIRECTORY and at least one EXTENSION')
+    sys.exit('ERROR: must provide DIRECTORY')
 base = path.abspath(args[0])
 if not path.isdir(base):
     parser.print_usage()
     sys.exit('ERROR: not a directory: %r' % base)
-extensions = frozenset(a.lower() for a in args[1:])
+
+extensions = options.extension
+for t in options.type:
+    if EXT_MAP.has_key(t):
+        for ext in EXT_MAP[t]:
+            if not ext in extensions:
+                extensions.append(ext)
+if len(extensions) == 0:
+    extensions += list(EXT_MAP['all'])
 
 xdg_cache_path = xdg.BaseDirectory.xdg_cache_home
 cache = path.join(xdg_cache_path, 'dmedia')
@@ -177,4 +197,4 @@
 )
 print ''
 print 'To browse dmedia database in CouchDB, run:'
-print '  firefox file://%s' % dc
+print '  xdg-open %s' % dc

=== modified file 'dmedia.1'
--- dmedia.1	2010-11-23 23:12:49 +0000
+++ dmedia.1	2010-11-28 12:11:16 +0000
@@ -10,7 +10,7 @@
 
 .SH SYNOPSIS
 .B dmedia
-.RI DIRECTORY 
+.RI DIRECTORY
 .RI EXTENSIONS...
 .br
 
@@ -28,14 +28,28 @@
 Add imported files to specified PROJECT
 .IP\fB\ --tag=TAG\fP
 Add specified TAG to imported files
+.IP\fB\ --type=TYPE\fP
+Add specified TYPE to the list of file types to limit the import to. TYPE can be 'image', 'audio', 'video' or 'all'. 'all' is the default and represents 'image', 'audio' and 'video' files.
+.IP\fB\ --extension=EXTENSION\fP
+Add specified EXTENSION to the list of file extensions to limit the import to. By default, all file extensions that are recognised as audio, video or image file formats will be imported.
 
 
 .SH EXAMPLES
-.IP \fB\ dmedia\ /media/EOS_DIGITAL\ jpg\ cr2\fp
-This will recursively import all JPG and CR2 files from your memory card mounted at '/media/EOS_DIGITAL'.
-.PP
-.IP \fB\ dmedia\ /usr/share/backgrounds\ jpg\ png\ --tag=wallpaper\ --tag=desktop\fp
-This will add all files with the extensions 'png' and 'jpg' in the directory '/usr/share/backgrounds' and its subdirectories. The files will be tagged with 'wallpaper' and 'desktop' in the media database.
+.IP \fB\ dmedia\ /media\fp
+This will import all media files from all of your connected devices.
+.PP
+.IP \fB\ dmedia\ /media/EOS_DIGITAL\ --type=image\fp
+This will recursively import all image files from your memory card mounted at '/media/EOS_DIGITAL'.
+.PP
+.IP \fB\ dmedia\ /usr/share/backgrounds\ --type=image\ --tag=wallpaper\ --tag=desktop\fp
+This will add all image files in the directory '/usr/share/backgrounds' and its subdirectories. The files will be tagged with 'wallpaper' and 'desktop' in the media database.
+.IP \fB\ dmedia\ /usr/share/pixmaps\ --extension=svg\ --tag=desktop\fp
+This will import all icons with the 'svg' file extension from /usr/share/pixmaps.
+.PP
+.IP \fB\ dmedia\ ~/Videos\ --type=video\ --extension=webm\fp
+This will import all video files in your Videos folder, as well as any file in that folder with the 'webm' extension. Due to being a new file format your system's MIME database may not recognise this format as a video; this will allow the webm files to be imported along with the other video files.
+.PP
+
 
 
 
@@ -56,5 +70,5 @@
 The development of dmedia is managed at http://launchpad.net/dmedia, where you can find the source code, report bugs and ask questions.
 
 .SH AUTHOR
-This man page was originally written by David Green <[e-mail]> using text from the README by Jason Gerard DeRose.
+This man page was originally written by David Green <[e-mail]> using text from the README by Jason Gerard DeRose and has since been edited by the following authors: David Green <[e-mail]>.