add 'legacy' mode, which is basically just the old deluge-console, for curmudgeons

This commit is contained in:
Nick Lanham 2011-02-27 17:12:57 +01:00
parent fab1e8412d
commit 930addb389
4 changed files with 687 additions and 7 deletions

View File

@ -0,0 +1,51 @@
#
# status.py
#
# Copyright (C) 2011 Nick Lanham <nick@afternight.org>
#
# Deluge is free software.
#
# You may 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.
#
# deluge 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 deluge. If not, write to:
# The Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor
# Boston, MA 02110-1301, USA.
#
# In addition, as a special exception, the copyright holders give
# permission to link the code of portions of this program with the OpenSSL
# library.
# You must obey the GNU General Public License in all respects for all of
# the code used other than OpenSSL. If you modify file(s) with this
# exception, you may extend this exception to your version of the file(s),
# but you are not obligated to do so. If you do not wish to do so, delete
# this exception statement from your version. If you delete this exception
# statement from all source files in the program, then also delete it here.
#
from deluge.ui.console.main import BaseCommand
import deluge.common
import deluge.component as component
from deluge.ui.console.modes.alltorrents import AllTorrents
class Command(BaseCommand):
"""Exit this mode and go into the more 'gui' like mode"""
usage = "Usage: gui"
interactive_only = True
def handle(self, *args, **options):
console = component.get("ConsoleUI")
try:
at = component.get("AllTorrentsStateUpdater").alltorrent
except KeyError:
at = AllTorrents(console.stdscr,console.encoding)
console.set_mode(at)
at.resume()

View File

@ -50,11 +50,11 @@ from deluge.ui.coreconfig import CoreConfig
from deluge.ui.sessionproxy import SessionProxy
from deluge.ui.console.statusbars import StatusBars
from deluge.ui.console.eventlog import EventLog
#import screen
import colors
from deluge.ui.ui import _UI
from deluge.ui.console import UI_PATH
log = logging.getLogger(__name__)
class Console(_UI):
@ -216,6 +216,7 @@ class ConsoleUI(component.Component):
# Set the interactive flag to indicate where we should print the output
self.interactive = True
self._commands = cmds
if args:
args = args[0]
self.interactive = False
@ -223,7 +224,6 @@ class ConsoleUI(component.Component):
print "Sorry, couldn't find any commands"
return
else:
self._commands = cmds
from commander import Commander
cmdr = Commander(cmds)
if daemon:
@ -262,6 +262,7 @@ Please use commands from the command line, eg:\n
colors.init_colors()
self.statusbars = StatusBars()
from modes.connectionmanager import ConnectionManager
self.stdscr = stdscr
self.screen = ConnectionManager(stdscr, self.encoding)
self.eventlog = EventLog()
@ -303,6 +304,8 @@ Please use commands from the command line, eg:\n
no matches are found.
"""
if isinstance(self.screen,deluge.ui.console.modes.legacy.Legacy):
return self.screen.match_torrent(string)
ret = []
for tid, name in self.torrents:
if tid.startswith(string) or name.startswith(string):
@ -323,8 +326,12 @@ Please use commands from the command line, eg:\n
def set_batch_write(self, batch):
# only kept for legacy reasons, don't actually do anything
pass
if isinstance(self.screen,deluge.ui.console.modes.legacy.Legacy):
return self.screen.set_batch_write(batch)
def tab_complete_torrent(self, line):
if isinstance(self.screen,deluge.ui.console.modes.legacy.Legacy):
return self.screen.tab_complete_torrent(line)
def set_mode(self, mode):
reactor.removeReader(self.screen)
@ -337,6 +344,9 @@ Please use commands from the command line, eg:\n
def write(self, s):
if self.interactive:
if isinstance(self.screen,deluge.ui.console.modes.legacy.Legacy):
self.screen.write(s)
else:
self.events.append(s)
else:
print colors.strip_colors(s.encode(self.encoding))

View File

@ -50,6 +50,7 @@ from torrentdetail import TorrentDetail
from preferences import Preferences
from torrent_actions import torrent_actions_popup
from eventview import EventView
from legacy import Legacy
import format_utils
@ -129,8 +130,9 @@ class FILTER:
QUEUED=7
class StateUpdater(component.Component):
def __init__(self, cb, sf,tcb):
def __init__(self, alltorrent, cb, sf,tcb):
component.Component.__init__(self, "AllTorrentsStateUpdater", 1, depend=["SessionProxy"])
self.alltorrent = alltorrent
self._status_cb = cb
self._status_fields = sf
self.status_dict = {}
@ -174,6 +176,8 @@ class AllTorrents(BaseMode):
self.coreconfig = component.get("ConsoleUI").coreconfig
self.legacy_mode = None
BaseMode.__init__(self, stdscr, encoding)
curses.curs_set(0)
self.stdscr.notimeout(0)
@ -181,7 +185,7 @@ class AllTorrents(BaseMode):
self._status_fields = ["queue","name","total_wanted","state","progress","num_seeds","total_seeds",
"num_peers","total_peers","download_payload_rate", "upload_payload_rate"]
self.updater = StateUpdater(self.set_state,self._status_fields,self._on_torrent_status)
self.updater = StateUpdater(self,self.set_state,self._status_fields,self._on_torrent_status)
self.column_names = ["#", "Name","Size","State","Progress","Seeders","Peers","Down Speed","Up Speed"]
self._update_columns()
@ -375,6 +379,15 @@ class AllTorrents(BaseMode):
ev = EventView(self,self.stdscr,self.encoding)
component.get("ConsoleUI").set_mode(ev)
def __legacy_mode(self):
component.stop(["AllTorrentsStateUpdater"])
self.stdscr.clear()
if not self.legacy_mode:
self.legacy_mode = Legacy(self.stdscr,self.encoding)
component.get("ConsoleUI").set_mode(self.legacy_mode)
self.legacy_mode.refresh()
curses.curs_set(2)
def _torrent_filter(self, idx, data):
if data==FILTER.ALL:
self.updater.status_dict = {}
@ -758,5 +771,8 @@ class AllTorrents(BaseMode):
elif chr(c) == 'e':
self.__show_events()
return
elif chr(c) == 'l':
self.__legacy_mode()
return
self.refresh(effected_lines)

View File

@ -0,0 +1,603 @@
#
# legacy.py
#
# Copyright (C) 2008-2009 Ido Abramovich <ido.deluge@gmail.com>
# Copyright (C) 2009 Andrew Resch <andrewresch@gmail.com>
#
# Deluge is free software.
#
# You may 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.
#
# deluge 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 deluge. If not, write to:
# The Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor
# Boston, MA 02110-1301, USA.
#
# In addition, as a special exception, the copyright holders give
# permission to link the code of portions of this program with the OpenSSL
# library.
# You must obey the GNU General Public License in all respects for all of
# the code used other than OpenSSL. If you modify file(s) with this
# exception, you may extend this exception to your version of the file(s),
# but you are not obligated to do so. If you do not wish to do so, delete
# this exception statement from your version. If you delete this exception
# statement from all source files in the program, then also delete it here.
#
#
try:
import curses
except ImportError:
pass
from basemode import BaseMode
import deluge.ui.console.colors as colors
from twisted.internet import defer, reactor
from deluge.ui.client import client
import deluge.component as component
import logging,os
log = logging.getLogger(__name__)
LINES_BUFFER_SIZE = 5000
INPUT_HISTORY_SIZE = 500
class Legacy(BaseMode):
def __init__(self, stdscr, encoding=None):
self.batch_write = False
self.lines = []
# A list of strings to be displayed based on the offset (scroll)
self.lines = []
# The offset to display lines
self.display_lines_offset = 0
# Holds the user input and is cleared on 'enter'
self.input = ""
self.input_incomplete = ""
# Keep track of where the cursor is
self.input_cursor = 0
# Keep a history of inputs
self.input_history = []
self.input_history_index = 0
# Keep track of double-tabs
self.tab_count = 0
# Get a handle to the main console
self.console = component.get("ConsoleUI")
# show the cursor
curses.curs_set(2)
BaseMode.__init__(self, stdscr, encoding)
# This gets fired once we have received the torrents list from the core
self.started_deferred = defer.Deferred()
# Maintain a list of (torrent_id, name) for use in tab completion
self.torrents = []
def on_session_state(result):
def on_torrents_status(torrents):
for torrent_id, status in torrents.items():
self.torrents.append((torrent_id, status["name"]))
self.started_deferred.callback(True)
client.core.get_torrents_status({"id": result}, ["name"]).addCallback(on_torrents_status)
client.core.get_session_state().addCallback(on_session_state)
# Register some event handlers to keep the torrent list up-to-date
client.register_event_handler("TorrentAddedEvent", self.on_torrent_added_event)
client.register_event_handler("TorrentRemovedEvent", self.on_torrent_removed_event)
def update(self):
pass
def _doRead(self):
# Read the character
c = self.stdscr.getch()
# We clear the input string and send it to the command parser on ENTER
if c == curses.KEY_ENTER or c == 10:
if self.input:
self.add_line(">>> " + self.input)
self.do_command(self.input.encode(self.encoding))
if len(self.input_history) == INPUT_HISTORY_SIZE:
# Remove the oldest input history if the max history size
# is reached.
del self.input_history[0]
self.input_history.append(self.input)
self.input_history_index = len(self.input_history)
self.input = ""
self.input_incomplete = ""
self.input_cursor = 0
self.stdscr.refresh()
# Run the tab completer function
elif c == 9:
# Keep track of tab hit count to know when it's double-hit
self.tab_count += 1
if self.tab_count > 1:
second_hit = True
self.tab_count = 0
else:
second_hit = False
if self.tab_completer:
# We only call the tab completer function if we're at the end of
# the input string on the cursor is on a space
if self.input_cursor == len(self.input) or self.input[self.input_cursor] == " ":
self.input, self.input_cursor = self.tab_completer(self.input, self.input_cursor, second_hit)
# We use the UP and DOWN keys to cycle through input history
elif c == curses.KEY_UP:
if self.input_history_index - 1 >= 0:
if self.input_history_index == len(self.input_history):
# We're moving from non-complete input so save it just incase
# we move back down to it.
self.input_incomplete = self.input
# Going back in the history
self.input_history_index -= 1
self.input = self.input_history[self.input_history_index]
self.input_cursor = len(self.input)
elif c == curses.KEY_DOWN:
if self.input_history_index + 1 < len(self.input_history):
# Going forward in the history
self.input_history_index += 1
self.input = self.input_history[self.input_history_index]
self.input_cursor = len(self.input)
elif self.input_history_index + 1 == len(self.input_history):
# We're moving back down to an incomplete input
self.input_history_index += 1
self.input = self.input_incomplete
self.input_cursor = len(self.input)
# Cursor movement
elif c == curses.KEY_LEFT:
if self.input_cursor:
self.input_cursor -= 1
elif c == curses.KEY_RIGHT:
if self.input_cursor < len(self.input):
self.input_cursor += 1
elif c == curses.KEY_HOME:
self.input_cursor = 0
elif c == curses.KEY_END:
self.input_cursor = len(self.input)
# Scrolling through buffer
elif c == curses.KEY_PPAGE:
self.display_lines_offset += self.rows - 3
# We substract 3 for the unavailable lines and 1 extra due to len(self.lines)
if self.display_lines_offset > (len(self.lines) - 4 - self.rows):
self.display_lines_offset = len(self.lines) - 4 - self.rows
self.refresh()
elif c == curses.KEY_NPAGE:
self.display_lines_offset -= self.rows - 3
if self.display_lines_offset < 0:
self.display_lines_offset = 0
self.refresh()
# We remove the tab count if the key wasn't a tab
if c != 9:
self.tab_count = 0
# Delete a character in the input string based on cursor position
if c == curses.KEY_BACKSPACE or c == 127:
if self.input and self.input_cursor > 0:
self.input = self.input[:self.input_cursor - 1] + self.input[self.input_cursor:]
self.input_cursor -= 1
elif c == curses.KEY_DC:
if self.input and self.input_cursor < len(self.input):
self.input = self.input[:self.input_cursor] + self.input[self.input_cursor + 1:]
# A key to add to the input string
else:
if c > 31 and c < 256:
# Emulate getwch
stroke = chr(c)
uchar = ""
while not uchar:
try:
uchar = stroke.decode(self.encoding)
except UnicodeDecodeError:
c = self.stdscr.getch()
stroke += chr(c)
if uchar:
if self.input_cursor == len(self.input):
self.input += uchar
else:
# Insert into string
self.input = self.input[:self.input_cursor] + uchar + self.input[self.input_cursor:]
# Move the cursor forward
self.input_cursor += 1
# Update the input string on the screen
self.add_string(self.rows - 1, self.input)
try:
self.stdscr.move(self.rows - 1, self.input_cursor)
except curses.error:
pass
self.stdscr.refresh()
def refresh(self):
"""
Refreshes the screen.
Updates the lines based on the`:attr:lines` based on the `:attr:display_lines_offset`
attribute and the status bars.
"""
self.stdscr.clear()
# Update the status bars
self.add_string(0, self.statusbars.topbar)
self.add_string(self.rows - 2, self.statusbars.bottombar)
# The number of rows minus the status bars and the input line
available_lines = self.rows - 3
# If the amount of lines exceeds the number of rows, we need to figure out
# which ones to display based on the offset
if len(self.lines) > available_lines:
# Get the lines to display based on the offset
offset = len(self.lines) - self.display_lines_offset
lines = self.lines[-(available_lines - offset):offset]
elif len(self.lines) == available_lines:
lines = self.lines
else:
lines = [""] * (available_lines - len(self.lines))
lines.extend(self.lines)
# Add the lines to the screen
for index, line in enumerate(lines):
self.add_string(index + 1, line)
# Add the input string
self.add_string(self.rows - 1, self.input)
# Move the cursor
try:
self.stdscr.move(self.rows - 1, self.input_cursor)
except curses.error:
pass
self.stdscr.redrawwin()
self.stdscr.refresh()
def add_line(self, text, refresh=True):
"""
Add a line to the screen. This will be showed between the two bars.
The text can be formatted with color using the following format:
"{!fg, bg, attributes, ...!}"
See: http://docs.python.org/library/curses.html#constants for attributes.
Alternatively, it can use some built-in scheme for coloring.
See colors.py for built-in schemes.
"{!scheme!}"
Examples:
"{!blue, black, bold!}My Text is {!white, black!}cool"
"{!info!}I am some info text!"
"{!error!}Uh oh!"
:param text: the text to show
:type text: string
:param refresh: if True, the screen will refresh after the line is added
:type refresh: bool
"""
def get_line_chunks(line):
"""
Returns a list of 2-tuples (color string, text)
"""
chunks = []
num_chunks = line.count("{!")
for i in range(num_chunks):
# Find the beginning and end of the color tag
beg = line.find("{!")
end = line.find("!}") + 2
color = line[beg:end]
line = line[end:]
# Check to see if this is the last chunk
if i + 1 == num_chunks:
text = line
else:
# Not the last chunk so get the text up to the next tag
# and remove the text from line
text = line[:line.find("{!")]
line = line[line.find("{!"):]
chunks.append((color, text))
return chunks
for line in text.splitlines():
# We need to check for line lengths here and split as necessary
try:
line_length = colors.get_line_length(line)
except colors.BadColorString:
log.error("Passed a bad colored string..")
line_length = len(line)
if line_length >= (self.cols - 1):
s = ""
# The length of the text without the color tags
s_len = 0
# We need to split this over multiple lines
for chunk in get_line_chunks(line):
if (len(chunk[1]) + s_len) < (self.cols - 1):
# This chunk plus the current string in 's' isn't over
# the maximum width, so just append the color tag and text
s += chunk[0] + chunk[1]
s_len += len(chunk[1])
else:
# The chunk plus the current string in 's' is too long.
# We need to take as much of the chunk and put it into 's'
# with the color tag.
remain = (self.cols - 1) - s_len
s += chunk[0] + chunk[1][:remain]
# We append the line since it's full
self.lines.append(s)
# Start a new 's' with the remainder chunk
s = chunk[0] + chunk[1][remain:]
s_len = len(chunk[1][remain:])
# Append the final string which may or may not be the full width
if s:
self.lines.append(s)
else:
self.lines.append(line)
while len(self.lines) > LINES_BUFFER_SIZE:
# Remove the oldest line if the max buffer size has been reached
del self.lines[0]
if refresh:
self.refresh()
def add_string(self, row, string):
"""
Adds a string to the desired `:param:row`.
:param row: int, the row number to write the string
"""
col = 0
try:
parsed = colors.parse_color_string(string, self.encoding)
except colors.BadColorString, e:
log.error("Cannot add bad color string %s: %s", string, e)
return
for index, (color, s) in enumerate(parsed):
if index + 1 == len(parsed):
# This is the last string so lets append some " " to it
s += " " * (self.cols - (col + len(s)) - 1)
try:
self.stdscr.addstr(row, col, s, color)
except curses.error:
pass
col += len(s)
def do_command(self, cmd):
"""
Processes a command.
:param cmd: str, the command string
"""
if not cmd:
return
cmd, _, line = cmd.partition(' ')
try:
parser = self.console._commands[cmd].create_parser()
except KeyError:
self.write("{!error!}Unknown command: %s" % cmd)
return
args = self.console._commands[cmd].split(line)
# Do a little hack here to print 'command --help' properly
parser._print_help = parser.print_help
def print_help(f=None):
parser._print_help(f)
parser.print_help = print_help
# Only these commands can be run when not connected to a daemon
not_connected_cmds = ["help", "connect", "quit"]
aliases = []
for c in not_connected_cmds:
aliases.extend(self.console._commands[c].aliases)
not_connected_cmds.extend(aliases)
if not client.connected() and cmd not in not_connected_cmds:
self.write("{!error!}Not connected to a daemon, please use the connect command first.")
return
try:
options, args = parser.parse_args(args)
except Exception, e:
self.write("{!error!}Error parsing options: %s" % e)
return
if not getattr(options, '_exit', False):
try:
ret = self.console._commands[cmd].handle(*args, **options.__dict__)
except Exception, e:
self.write("{!error!}" + str(e))
log.exception(e)
import traceback
self.write("%s" % traceback.format_exc())
return defer.succeed(True)
else:
return ret
def set_batch_write(self, batch):
"""
When this is set the screen is not refreshed after a `:meth:write` until
this is set to False.
:param batch: set True to prevent screen refreshes after a `:meth:write`
:type batch: bool
"""
self.batch_write = batch
if not batch:
self.refresh()
def write(self, line):
"""
Writes a line out
:param line: str, the line to print
"""
self.add_line(line, not self.batch_write)
def tab_completer(self, line, cursor, second_hit):
"""
Called when the user hits 'tab' and will autocomplete or show options.
If a command is already supplied in the line, this function will call the
complete method of the command.
:param line: str, the current input string
:param cursor: int, the cursor position in the line
:param second_hit: bool, if this is the second time in a row the tab key
has been pressed
:returns: 2-tuple (string, cursor position)
"""
# First check to see if there is no space, this will mean that it's a
# command that needs to be completed.
if " " not in line:
possible_matches = []
# Iterate through the commands looking for ones that startwith the
# line.
for cmd in self.console._commands:
if cmd.startswith(line):
possible_matches.append(cmd + " ")
line_prefix = ""
else:
cmd = line.split(" ")[0]
if cmd in self.console._commands:
# Call the command's complete method to get 'er done
possible_matches = self.console._commands[cmd].complete(line.split(" ")[-1])
line_prefix = " ".join(line.split(" ")[:-1]) + " "
else:
# This is a bogus command
return (line, cursor)
# No matches, so just return what we got passed
if len(possible_matches) == 0:
return (line, cursor)
# If we only have 1 possible match, then just modify the line and
# return it, else we need to print out the matches without modifying
# the line.
elif len(possible_matches) == 1:
new_line = line_prefix + possible_matches[0]
return (new_line, len(new_line))
else:
if second_hit:
# Only print these out if it's a second_hit
self.write(" ")
for match in possible_matches:
self.write(match)
else:
p = " ".join(line.split(" ")[:-1])
new_line = " ".join([p, os.path.commonprefix(possible_matches)])
if len(new_line) > len(line):
line = new_line
cursor = len(line)
return (line, cursor)
def tab_complete_torrent(self, line):
"""
Completes torrent_ids or names.
:param line: str, the string to complete
:returns: list of matches
"""
possible_matches = []
# Find all possible matches
for torrent_id, torrent_name in self.torrents:
if torrent_id.startswith(line):
possible_matches.append(torrent_id + " ")
if torrent_name.startswith(line):
possible_matches.append(torrent_name + " ")
return possible_matches
def get_torrent_name(self, torrent_id):
"""
Gets a torrent name from the torrents list.
:param torrent_id: str, the torrent_id
:returns: the name of the torrent or None
"""
for tid, name in self.torrents:
if torrent_id == tid:
return name
return None
def match_torrent(self, string):
"""
Returns a list of torrent_id matches for the string. It will search both
torrent_ids and torrent names, but will only return torrent_ids.
:param string: str, the string to match on
:returns: list of matching torrent_ids. Will return an empty list if
no matches are found.
"""
ret = []
for tid, name in self.torrents:
if tid.startswith(string) or name.startswith(string):
ret.append(tid)
return ret
def on_torrent_added_event(self, event):
def on_torrent_status(status):
self.torrents.append((event.torrent_id, status["name"]))
client.core.get_torrent_status(event.torrent_id, ["name"]).addCallback(on_torrent_status)
def on_torrent_removed_event(self, event):
for index, (tid, name) in enumerate(self.torrents):
if event.torrent_id == tid:
del self.torrents[index]