maryjane
/
gpodder
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
gpodder/bin/gpo

758 lines
24 KiB
Python
Executable File
Raw Blame History

#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# gPodder - A media aggregator and podcast client
# Copyright (c) 2005-2012 Thomas Perl and the gPodder Team
#
# gPodder is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# gPodder is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# gpo - A better command-line interface to gPodder using the gPodder API
# by Thomas Perl <thp@gpodder.org>; 2009-05-07
"""
Usage: gpo [--verbose|-v] [COMMAND] [params...]
- Subscription management -
subscribe URL [TITLE] Subscribe to a new feed at URL (as TITLE)
search QUERY Search the gpodder.net directory for QUERY
toplist Show the gpodder.net top-subscribe podcasts
import FILENAME|URL Subscribe to all podcasts in an OPML file
export FILENAME Export all subscriptions to an OPML file
rename URL TITLE Rename feed at URL to TITLE
unsubscribe URL Unsubscribe from feed at URL
enable URL Enable feed updates for the feed at URL
disable URL Disable feed updates for the feed at URL
info URL Show information about feed at URL
list List all subscribed podcasts
update [URL] Check for new episodes (all or only at URL)
- Episode management -
download [URL] Download new episodes (all or only from URL)
pending [URL] List new episodes (all or only from URL)
episodes [URL] List episodes (all or only from URL)
- Configuration -
set [key] [value] List one (all) keys or set to a new value
- Other commands -
youtube URL Resolve the YouTube URL to a download URL
rewrite OLDURL NEWURL Change the feed URL of [OLDURL] to [NEWURL]
webui [public] Start gPodder's Web UI server
(public = listen on all network interfaces)
"""
import sys
import codecs
import collections
import os
import re
import inspect
import functools
try:
import readline
except ImportError:
readline = None
import shlex
import pydoc
import logging
try:
import termios
import fcntl
import struct
except ImportError:
termios = None
fcntl = None
struct = None
# A poor man's argparse/getopt - but it works for our use case :)
for verbose_flag in ('-v', '--verbose'):
if verbose_flag in sys.argv:
FMT = '%(created)f [%(name)s] %(levelname)s: %(message)s'
logging.basicConfig(format=FMT, level=logging.DEBUG)
sys.argv.remove(verbose_flag)
break
else:
logging.basicConfig()
# Avoid UnicodeDecodeError when output is not a terminal (less, cron, etc..)
if sys.stdout.encoding is None:
sys.stdout = codecs.getwriter('utf8')(sys.stdout)
gpodder_script = sys.argv[0]
if os.path.islink(gpodder_script):
gpodder_script = os.readlink(gpodder_script)
gpodder_dir = os.path.join(os.path.dirname(gpodder_script), '..')
prefix = os.path.abspath(os.path.normpath(gpodder_dir))
src_dir = os.path.join(prefix, 'src')
if os.path.exists(os.path.join(src_dir, 'gpodder', '__init__.py')):
# Run gPodder from local source folder (not installed)
sys.path.insert(0, src_dir)
import gpodder
_ = gpodder.gettext
N_ = gpodder.ngettext
gpodder.prefix = prefix
# This is the command-line UI variant
gpodder.ui.cli = True
# Platform detection (i.e. Maemo 5, etc..)
gpodder.detect_platform()
from gpodder import api
from gpodder import my
from gpodder import opml
from gpodder import util
from gpodder.config import config_value_to_string
have_ansi = sys.stdout.isatty() and not gpodder.win32
interactive_console = sys.stdin.isatty() and sys.stdout.isatty()
is_single_command = False
def incolor(color_id, s):
if have_ansi and cli.config.ui.cli.colors:
return '\033[9%dm%s\033[0m' % (color_id, s)
return s
# ANSI Colors: red = 1, green = 2, yellow = 3, blue = 4
inred, ingreen, inyellow, inblue = (functools.partial(incolor, x)
for x in range(1, 5))
def FirstArgumentIsPodcastURL(function):
"""Decorator for functions that take a podcast URL as first arg"""
setattr(function, '_first_arg_is_podcast', True)
return function
def get_terminal_size():
if None in (termios, fcntl, struct):
return (80, 24)
s = struct.pack('HHHH', 0, 0, 0, 0)
stdout = sys.stdout.fileno()
x = fcntl.ioctl(stdout, termios.TIOCGWINSZ, s)
rows, cols, xp, yp = struct.unpack('HHHH', x)
return rows, cols
class gPodderCli(object):
COLUMNS = 80
EXIT_COMMANDS = ('quit', 'exit', 'bye')
def __init__(self):
self.client = api.PodcastClient()
self.config = self.client._config
self._current_action = ''
self._commands = dict((name.rstrip('_'), func)
for name, func in inspect.getmembers(self)
if inspect.ismethod(func) and not name.startswith('_'))
self._prefixes, self._expansions = self._build_prefixes_expansions()
self._prefixes.update({'?': 'help'})
self._valid_commands = sorted(self._prefixes.values())
gpodder.user_extensions.on_ui_initialized(self.client.core.model,
self._extensions_podcast_update_cb,
self._extensions_episode_download_cb)
def _build_prefixes_expansions(self):
prefixes = {}
expansions = collections.defaultdict(list)
names = sorted(self._commands.keys())
names.extend(self.EXIT_COMMANDS)
# Generator for all prefixes of a given string (longest first)
# e.g. ['gpodder', 'gpodde', 'gpodd', 'gpod', 'gpo', 'gp', 'g']
mkprefixes = lambda n: (n[:x] for x in xrange(len(n), 0, -1))
# Return True if the given prefix is unique in "names"
is_unique = lambda p: len([n for n in names if n.startswith(p)]) == 1
for name in names:
is_still_unique = True
unique_expansion = None
for prefix in mkprefixes(name):
if is_unique(prefix):
unique_expansion = '[%s]%s' % (prefix, name[len(prefix):])
prefixes[prefix] = name
continue
if unique_expansion is not None:
expansions[prefix].append(unique_expansion)
continue
return prefixes, expansions
def _extensions_podcast_update_cb(self, podcast):
self._info(_('Podcast update requested by extensions.'))
self._update_podcast(podcast)
def _extensions_episode_download_cb(self, episode):
self._info(_('Episode download requested by extensions.'))
self._download_episode(episode)
def _start_action(self, msg, *args):
line = msg % args
if len(line) > self.COLUMNS-7:
line = line[:self.COLUMNS-7-3] + '...'
else:
line = line + (' '*(self.COLUMNS-7-len(line)))
self._current_action = util.sanitize_encoding(line)
sys.stdout.write(self._current_action)
sys.stdout.flush()
def _update_action(self, progress):
if have_ansi:
progress = '%3.0f%%' % (progress*100.,)
result = '['+inblue(progress)+']'
sys.stdout.write('\r' + self._current_action + result)
sys.stdout.flush()
def _finish_action(self, success=True, skip=False):
if skip:
result = '['+inyellow('SKIP')+']'
elif success:
result = '['+ingreen('DONE')+']'
else:
result = '['+inred('FAIL')+']'
if have_ansi:
print '\r' + self._current_action + result
else:
print result
self._current_action = ''
def _atexit(self):
self.client.finish()
# -------------------------------------------------------------------
def import_(self, url):
for channel in opml.Importer(url).items:
self.subscribe(channel['url'], channel.get('title'))
def export(self, filename):
podcasts = self.client._model.get_podcasts()
opml.Exporter(filename).write(podcasts)
def subscribe(self, url, title=None):
url = util.normalize_feed_url(url)
if url is None:
self._error(_('Invalid URL.'))
return True
if self.client.get_podcast(url) is not None:
self._info(_('You are already subscribed to %s.') % url)
return True
try:
if self.client.create_podcast(url, title) is None:
self._error(_('Cannot subscribe to %s.') % url)
return True
except Exception, e:
self._error(e.strerror)
return True
self.client.commit()
self._info(_('Successfully added %s.' % url))
return True
def _print_config(self, search_for):
for key in self.config.all_keys():
if search_for is None or search_for.lower() in key.lower():
value = config_value_to_string(self.config._lookup(key))
print key, '=', value
def set(self, key=None, value=None):
if value is None:
self._print_config(key)
return
try:
current_value = self.config._lookup(key)
current_type = type(current_value)
except KeyError:
self._error(_('This configuration option does not exist.'))
return
if current_type == dict:
self._error(_('Can only set leaf configuration nodes.'))
return
self.config.update_field(key, value)
self.set(key)
@FirstArgumentIsPodcastURL
def rename(self, url, title):
podcast = self.client.get_podcast(url)
if podcast is None:
self._error(_('You are not subscribed to %s.') % url)
else:
old_title = podcast.title
podcast.rename(title)
self.client.commit()
self._info(_('Renamed %(old_title)s to %(new_title)s.') % {
'old_title': old_title,
'new_title': new_title,
})
return True
@FirstArgumentIsPodcastURL
def unsubscribe(self, url):
podcast = self.client.get_podcast(url)
if podcast is None:
self._error(_('You are not subscribed to %s.') % url)
else:
podcast.delete()
self.client.commit()
self._error(_('Unsubscribed from %s.') % url)
return True
def _episodesList(self, podcast):
def status_str(episode):
if episode.is_new:
return u' * '
if episode.is_downloaded:
return u' ▉ '
if episode.is_deleted:
return u' ░ '
return u' '
episodes = (u'%3d. %s %s' % (i+1, status_str(e), e.title)
for i, e in enumerate(podcast.get_episodes()))
return episodes
@FirstArgumentIsPodcastURL
def info(self, url):
podcast = self.client.get_podcast(url)
if podcast is None:
self._error(_('You are not subscribed to %s.') % url)
else:
title, url, status = podcast.title, podcast.url, podcast.feed_update_status_msg()
episodes = self._episodesList(podcast)
episodes = u'\n '.join(episodes)
self._pager(u"""
Title: %(title)s
URL: %(url)s
Feed update is %(status)s
Episodes:
%(episodes)s
""" % locals())
return True
@FirstArgumentIsPodcastURL
def episodes(self, url=None):
output = []
for podcast in self.client.get_podcasts():
podcast_printed = False
if url is None or podcast.url == url:
episodes = self._episodesList(podcast)
episodes = u'\n '.join(episodes)
output.append(u"""
Episodes from %s:
%s
""" % (podcast.url, episodes))
self._pager(u'\n'.join(output))
return True
def list(self):
for podcast in self.client.get_podcasts():
title = util.sanitize_encoding(podcast.title)
if podcast.update_enabled():
print '#', ingreen(title)
else:
print '#', inred(title), '-', _('Updates disabled')
print podcast.url
return True
def _update_podcast(self, podcast):
self._start_action('Updating %s', podcast.title)
try:
podcast.update()
self._finish_action()
except Exception, e:
self._finish_action(False)
def _pending_message(self, count):
return N_('%(count)d new episode', '%(count)d new episodes',
count) % {'count': count}
@FirstArgumentIsPodcastURL
def update(self, url=None):
count = 0
for podcast in self.client.get_podcasts():
if url is not None and podcast.url != url:
continue
if podcast.update_enabled():
self._update_podcast(podcast)
count += sum(1 for e in podcast.get_episodes() if e.is_new)
else:
self._start_action(_('Skipping %(podcast)s') % {
'podcast': podcast.title})
self._finish_action(skip=True)
print inblue(self._pending_message(count))
return True
@FirstArgumentIsPodcastURL
def pending(self, url=None):
count = 0
for podcast in self.client.get_podcasts():
podcast_printed = False
if url is None or podcast.url == url:
for episode in podcast.get_episodes():
if episode.is_new:
if not podcast_printed:
print '#', ingreen(podcast.title)
podcast_printed = True
print ' ', episode.title
count += 1
print inblue(self._pending_message(count))
return True
def _download_episode(self, episode):
self._start_action('Downloading %s', episode.title)
episode.download(self._update_action)
self._finish_action()
@FirstArgumentIsPodcastURL
def download(self, url=None):
count = 0
for podcast in self.client.get_podcasts():
podcast_printed = False
if url is None or podcast.url == url:
for episode in podcast.get_episodes():
if episode.is_new:
if not podcast_printed:
print inblue(podcast.title)
podcast_printed = True
self._download_episode(episode)
count += 1
print count, 'episodes downloaded.'
return True
@FirstArgumentIsPodcastURL
def disable(self, url):
podcast = self.client.get_podcast(url)
if podcast is None:
self._error(_('You are not subscribed to %s.') % url)
else:
podcast.disable()
self.client.commit()
self._error(_('Disabling feed update from %s.') % url)
return True
@FirstArgumentIsPodcastURL
def enable(self, url):
podcast = self.client.get_podcast(url)
if podcast is None:
self._error(_('You are not subscribed to %s.') % url)
else:
podcast.enable()
self.client.commit()
self._error(_('Enabling feed update from %s.') % url)
return True
def youtube(self, url):
yurl = self.client.youtube_url_resolver(url)
print yurl
return True
def webui(self, public=None):
from gpodder import webui
if public == 'public':
# Warn the user that the web UI is listening on all network
# interfaces, which could lead to problems.
# Only use this on a trusted, private network!
self._warn(_('Listening on ALL network interfaces.'))
webui.main(only_localhost=False, core=self.client.core)
else:
webui.main(core=self.client.core)
def search(self, *terms):
query = ' '.join(terms)
if not query:
return
directory = my.Directory()
results = directory.search(query)
self._show_directory_results(results)
def toplist(self):
directory = my.Directory()
results = directory.toplist()
self._show_directory_results(results, True)
def _show_directory_results(self, results, multiple=False):
if not results:
self._error(_('No podcasts found.'))
return
if not interactive_console or is_single_command:
print '\n'.join(url for title, url in results)
return
def show_list():
self._pager('\n'.join(u'%3d: %s\n %s' %
(index+1, title, url if title != url else '')
for index, (title, url) in enumerate(results)))
show_list()
msg = _('Enter index to subscribe, ? for list')
while True:
index = raw_input(msg + ': ')
if not index:
return
if index == '?':
show_list()
continue
try:
index = int(index)
except ValueError:
self._error(_('Invalid value.'))
continue
if not (1 <= index <= len(results)):
self._error(_('Invalid value.'))
continue
title, url = results[index-1]
self._info(_('Adding %s...') % title)
self.subscribe(url)
if not multiple:
break
@FirstArgumentIsPodcastURL
def rewrite(self, old_url, new_url):
podcast = self.client.get_podcast(old_url)
if podcast is None:
self._error(_('You are not subscribed to %s.') % old_url)
else:
result = podcast.rewrite_url(new_url)
if result is None:
self._error(_('Invalid URL: %s') % new_url)
else:
new_url = result
self._error(_('Changed URL from %(old_url)s to %(new_url)s.') %
{
'old_url': old_url,
'new_url': new_url,
})
return True
def help(self):
sys.stderr.write(stylize(__doc__))
return True
# -------------------------------------------------------------------
def _pager(self, output):
if have_ansi:
# Need two additional rows for command prompt
rows_needed = len(output.splitlines()) + 2
rows, cols = get_terminal_size()
if rows_needed < rows:
print util.sanitize_encoding(output)
else:
pydoc.pager(util.sanitize_encoding(output))
else:
print output
def _shell(self):
print '\n'.join(x.strip() for x in ("""
gPodder %(__version__)s "%(__relname__)s" (%(__date__)s) - %(__url__)s
%(__copyright__)s
License: %(__license__)s
Entering interactive shell. Type 'help' for help.
Press Ctrl+D (EOF) or type 'quit' to quit.
""" % gpodder.__dict__).splitlines())
if readline is not None:
readline.parse_and_bind('tab: complete')
readline.set_completer(self._tab_completion)
readline.set_completer_delims(' ')
while True:
try:
line = raw_input('gpo> ')
except EOFError:
print ''
break
except KeyboardInterrupt:
print ''
continue
if self._prefixes.get(line, line) in self.EXIT_COMMANDS:
break
try:
args = shlex.split(line)
except ValueError, value_error:
self._error(_('Syntax error: %(error)s') %
{'error': value_error})
continue
try:
self._parse(args)
except KeyboardInterrupt:
self._error('Keyboard interrupt.')
except EOFError:
self._error('EOF.')
self._atexit()
def _error(self, *args):
print >>sys.stderr, inred(' '.join(args))
# Warnings look like error messages for now
_warn = _error
def _info(self, *args):
print >>sys.stdout, ' '.join(args)
def _checkargs(self, func, command_line):
args, varargs, keywords, defaults = inspect.getargspec(func)
args.pop(0) # Remove "self" from args
defaults = defaults or ()
minarg, maxarg = len(args)-len(defaults), len(args)
if len(command_line) < minarg or (len(command_line) > maxarg and \
varargs is None):
self._error('Wrong argument count for %s.' % func.__name__)
return False
return func(*command_line)
def _tab_completion_podcast(self, text, count):
"""Tab completion for podcast URLs"""
urls = [p.url for p in self.client.get_podcasts() if text in p.url]
if count < len(urls):
return urls[count]
return None
def _tab_completion(self, text, count):
"""Tab completion function for readline"""
if readline is None:
return None
current_line = readline.get_line_buffer()
if text == current_line:
for name in self._valid_commands:
if name.startswith(text):
if count == 0:
return name
else:
count -= 1
else:
args = current_line.split()
command = args.pop(0)
command_function = getattr(self, command, None)
if not command_function:
return None
if getattr(command_function, '_first_arg_is_podcast', False):
if not args or (len(args) == 1 and not current_line.endswith(' ')):
return self._tab_completion_podcast(text, count)
return None
def _parse_single(self, command_line):
try:
result = self._parse(command_line)
except KeyboardInterrupt:
self._error('Keyboard interrupt.')
result = -1
self._atexit()
return result
def _parse(self, command_line):
if not command_line:
return False
command = command_line.pop(0)
# Resolve command aliases
command = self._prefixes.get(command, command)
if command in self._commands:
func = self._commands[command]
if inspect.ismethod(func):
return self._checkargs(func, command_line)
if command in self._expansions:
print _('Ambigous command. Did you mean..')
for cmd in self._expansions[command]:
print ' ', inblue(cmd)
else:
self._error(_('The requested function is not available.'))
return False
def stylize(s):
s = re.sub(r' .{27}', lambda m: inblue(m.group(0)), s)
s = re.sub(r' - .*', lambda m: ingreen(m.group(0)), s)
return s
if __name__ == '__main__':
cli = gPodderCli()
args = sys.argv[1:]
if args:
is_single_command = True
cli._parse_single(args)
elif interactive_console:
cli._shell()
else:
sys.stdout.write(__doc__)
Reference in New Issue View Git Blame Copy Permalink