Merge lp:~linkinpark342/exaile/352683 into lp:exaile/0.3.3

[Abhishek Mukherjee]

[Abhishek Mukherjee (linkinpark342)]

Adds queue managing functionality as a popup. This could later be extended to include Queue Manager as a pane if enough support is gathered.

[reacocard (reacocard)]

review: Approve

=== modified file 'data/glade/main.glade'
--- data/glade/main.glade	2009-03-28 20:56:12 +0000
+++ data/glade/main.glade	2009-04-13 02:38:36 +0000
@@ -151,6 +151,23 @@
 		    </widget>
 		  </child>
 
+                  <child>
+                    <widget class="GtkImageMenuItem" id="queue_manager_item">
+                      <property name="label" translatable="yes">_Queue Manager</property>
+                      <property name="visible">True</property>
+		      <property name="use_underline">True</property>
+                      <property name="use_stock">False</property>
+                      <signal name="activate" handler="on_queue_manager_item_activate"/>
+                      <child internal-child="image">
+                        <widget class="GtkImage" id="queue_manager_icon">
+                          <property name="visible">True</property>
+                          <property name="stock">gtk-add</property>
+                          <property name="icon-size">1</property>
+                        </widget>
+                      </child>
+                    </widget>
+                  </child>
+
 		  <child>
 		    <widget class="GtkImageMenuItem" id="plugins1">
 		      <property name="visible">True</property>

=== added file 'data/glade/queue_dialog.glade'
--- data/glade/queue_dialog.glade	1970-01-01 00:00:00 +0000
+++ data/glade/queue_dialog.glade	2009-04-14 17:10:16 +0000
@@ -0,0 +1,187 @@
+<?xml version="1.0"?>
+<glade-interface>
+  <!-- interface-requires gtk+ 2.16 -->
+  <!-- interface-naming-policy project-wide -->
+  <widget class="GtkWindow" id="QueueManagerDialog">
+    <property name="width_request">300</property>
+    <property name="height_request">400</property>
+    <property name="title" translatable="yes">Queue Manager - Exaile</property>
+    <child>
+      <widget class="GtkVBox" id="vbox">
+        <property name="visible">True</property>
+        <property name="orientation">vertical</property>
+        <child>
+          <widget class="GtkHBox" id="hbox1">
+            <property name="visible">True</property>
+            <child>
+              <widget class="GtkScrolledWindow" id="scrolledwindow1">
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="hscrollbar_policy">automatic</property>
+                <property name="vscrollbar_policy">automatic</property>
+                <child>
+                  <widget class="GtkTreeView" id="queue_tree">
+                    <property name="visible">True</property>
+                    <property name="can_focus">True</property>
+                  </widget>
+                </child>
+              </widget>
+              <packing>
+                <property name="padding">5</property>
+                <property name="position">0</property>
+              </packing>
+            </child>
+            <child>
+              <widget class="GtkVButtonBox" id="vbuttonbox1">
+                <property name="visible">True</property>
+                <property name="layout_style">spread</property>
+                <child>
+                  <widget class="GtkButton" id="top_button">
+                    <property name="label" translatable="yes">gtk-goto-top</property>
+                    <property name="visible">True</property>
+                    <property name="can_focus">True</property>
+                    <property name="receives_default">True</property>
+                    <property name="tooltip" translatable="yes">Move song to top in queue</property>
+                    <property name="use_stock">True</property>
+                    <signal name="clicked" handler="on_top_button_clicked"/>
+                  </widget>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">False</property>
+                    <property name="position">0</property>
+                  </packing>
+                </child>
+                <child>
+                  <widget class="GtkButton" id="up_button">
+                    <property name="label" translatable="yes">gtk-go-up</property>
+                    <property name="visible">True</property>
+                    <property name="can_focus">True</property>
+                    <property name="receives_default">True</property>
+                    <property name="tooltip" translatable="yes">Move song up in queue</property>
+                    <property name="use_stock">True</property>
+                    <signal name="clicked" handler="on_up_button_clicked"/>
+                  </widget>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">False</property>
+                    <property name="position">1</property>
+                  </packing>
+                </child>
+                <child>
+                  <widget class="GtkButton" id="remove_button">
+                    <property name="label" translatable="yes">gtk-remove</property>
+                    <property name="visible">True</property>
+                    <property name="can_focus">True</property>
+                    <property name="receives_default">True</property>
+                    <property name="tooltip" translatable="yes">Remove song from queue</property>
+                    <property name="use_stock">True</property>
+                    <signal name="clicked" handler="on_remove_button_clicked"/>
+                  </widget>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">False</property>
+                    <property name="position">2</property>
+                  </packing>
+                </child>
+                <child>
+                  <widget class="GtkButton" id="down_button">
+                    <property name="label" translatable="yes">gtk-go-down</property>
+                    <property name="visible">True</property>
+                    <property name="can_focus">True</property>
+                    <property name="receives_default">True</property>
+                    <property name="tooltip" translatable="yes">Move song down in queue</property>
+                    <property name="use_stock">True</property>
+                    <signal name="clicked" handler="on_down_button_clicked"/>
+                  </widget>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">False</property>
+                    <property name="position">3</property>
+                  </packing>
+                </child>
+                <child>
+                  <widget class="GtkButton" id="bottom_button">
+                    <property name="label" translatable="yes">gtk-goto-bottom</property>
+                    <property name="visible">True</property>
+                    <property name="can_focus">True</property>
+                    <property name="receives_default">True</property>
+                    <property name="tooltip" translatable="yes">Move song to bottom of queue</property>
+                    <property name="use_stock">True</property>
+                    <signal name="clicked" handler="on_bottom_button_clicked"/>
+                  </widget>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">False</property>
+                    <property name="position">4</property>
+                  </packing>
+                </child>
+              </widget>
+              <packing>
+                <property name="expand">False</property>
+                <property name="padding">5</property>
+                <property name="position">1</property>
+              </packing>
+            </child>
+          </widget>
+          <packing>
+            <property name="padding">5</property>
+            <property name="position">0</property>
+          </packing>
+        </child>
+        <child>
+          <widget class="GtkHSeparator" id="hseparator1">
+            <property name="visible">True</property>
+          </widget>
+          <packing>
+            <property name="expand">False</property>
+            <property name="padding">5</property>
+            <property name="position">1</property>
+          </packing>
+        </child>
+        <child>
+          <widget class="GtkHButtonBox" id="button_box">
+            <property name="visible">True</property>
+            <property name="spacing">5</property>
+            <property name="layout_style">end</property>
+            <child>
+              <widget class="GtkButton" id="ok_button">
+                <property name="label" translatable="yes">gtk-ok</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="tooltip" translatable="yes">Close this dialog</property>
+                <property name="use_stock">True</property>
+                <signal name="clicked" handler="close_dialog"/>
+              </widget>
+              <packing>
+                <property name="expand">False</property>
+                <property name="fill">False</property>
+                <property name="position">1</property>
+              </packing>
+            </child>
+            <child>
+              <widget class="GtkButton" id="remove_all_button">
+                <property name="label" translatable="yes" comments="Remove all from queue">Remove _All</property>
+                <property name="visible">True</property>
+                <property name="can_focus">True</property>
+                <property name="receives_default">True</property>
+                <property name="use_underline">True</property>
+                <signal name="clicked" handler="on_remove_all_button_clicked"/>
+              </widget>
+              <packing>
+                <property name="expand">False</property>
+                <property name="fill">False</property>
+                <property name="position">0</property>
+              </packing>
+            </child>
+          </widget>
+          <packing>
+            <property name="expand">False</property>
+            <property name="padding">5</property>
+            <property name="position">2</property>
+          </packing>
+        </child>
+      </widget>
+    </child>
+  </widget>
+</glade-interface>

=== modified file 'xlgui/__init__.py'
--- xlgui/__init__.py	2009-03-15 04:05:49 +0000
+++ xlgui/__init__.py	2009-04-13 02:38:36 +0000
@@ -18,7 +18,7 @@
 import gtk, gtk.glade, gobject, logging
 from xl import xdg, common, event, metadata
 
-from xlgui import guiutil, prefs, plugins, cover, commondialogs
+from xlgui import guiutil, prefs, plugins, cover, commondialogs, queue
 
 gtk.window_set_default_icon_from_file(xdg.get_data_path("images/icon.png"))
 logger = logging.getLogger(__name__)
@@ -84,6 +84,7 @@
             'on_about_item_activate': self.show_about_dialog,
             'on_scan_collection_item_activate': self.on_rescan_collection,
             'on_collection_manager_item_activate': self.collection_manager,
+            'on_queue_manager_item_activate': self.queue_manager,
             'on_preferences_item_activate': lambda *e: self.show_preferences(),
             'on_plugins_item_activate': self.show_plugins,
             'on_album_art_item_activate': self.show_cover_manager,
@@ -199,6 +200,10 @@
             plugin_page=plugin_page)
         dialog.run()
 
+    def queue_manager(self, *e):
+        dialog = queue.QueueManager(self.exaile.queue)
+        dialog.show()
+
     def collection_manager(self, *e):
         """
             Invokes the collection manager dialog

=== added file 'xlgui/queue.py'
--- xlgui/queue.py	1970-01-01 00:00:00 +0000
+++ xlgui/queue.py	2009-04-16 20:54:18 +0000
@@ -0,0 +1,200 @@
+"""
+    Queue manager dialog
+"""
+
+from xl import xdg
+from xl.nls import gettext as _
+from operator import itemgetter
+from copy import copy
+import xl.event
+import os
+import gtk
+import gtk.glade
+import logging
+
+LOG = logging.getLogger('exaile.xlgui.queue')
+
+class QueueManager(object):
+
+    """
+        GUI to manage a queue
+    """
+
+    def __init__(self, queue):
+        self._queue = queue
+
+        self._xml = gtk.glade.XML(
+                xdg.get_data_path(os.path.join('glade', 'queue_dialog.glade')),
+                    'QueueManagerDialog', 'exaile')
+        self._xml.get_widget('remove_all_button').set_image(
+               gtk.image_new_from_stock(gtk.STOCK_REMOVE, gtk.ICON_SIZE_BUTTON))
+
+        self._dialog = self._xml.get_widget('QueueManagerDialog')
+        self._dialog.connect('destroy', self.destroy)
+        self._xml.signal_autoconnect({
+            'close_dialog': self.destroy,
+            'on_top_button_clicked': self.selected_to_top,
+            'on_up_button_clicked': self.selected_up,
+            'on_remove_button_clicked': self.remove_selected,
+            'on_down_button_clicked': self.selected_down,
+            'on_bottom_button_clicked': self.selected_to_bottom,
+            'on_remove_all_button_clicked': self.remove_all,
+            })
+
+        self.__setup_callbacks()
+
+        self._model = gtk.ListStore(int, str, object)
+        self._queue_view = self._xml.get_widget('queue_tree')
+        self._queue_view.set_model(self._model)
+        self.__last_tracks = []
+        self.__populate_queue()
+        self.__setup_queue()
+
+    def __setup_callbacks(self):
+        for callback in self.__callbacks():
+            xl.event.add_callback(*callback)
+
+    def __teardown_callbacks(self):
+        for callback in self.__callbacks():
+            xl.event.remove_callback(*callback)
+
+    def __populate_queue_cb(self, *e):
+        self.__populate_queue()
+
+    def __callbacks(self):
+        yield (self.__populate_queue_cb, 'playback_start')
+        yield (self.__populate_queue_cb, 'tracks_added', self._queue)
+
+    def __setup_queue(self):
+        """Adds columns to _queue_view"""
+        renderer = gtk.CellRendererText()
+        col = gtk.TreeViewColumn(_('#'), renderer, text=0)
+        col.set_sizing(gtk.TREE_VIEW_COLUMN_AUTOSIZE)
+        self._queue_view.append_column(col)
+
+        renderer = gtk.CellRendererText()
+        col = gtk.TreeViewColumn(_('Title'), renderer, text=1)
+        col.set_sizing(gtk.TREE_VIEW_COLUMN_AUTOSIZE)
+        self._queue_view.append_column(col)
+
+    def __populate_queue(self):
+        """Populates the _model with tracks"""
+        tracks = self._queue.get_ordered_tracks()
+        if tracks == self.__last_tracks:
+            LOG.debug(_("Tracks did not change, no need to update"))
+            return
+        # Find the row that will be selected
+
+        if self._queue_view is not None:
+            model, iter = self._queue_view.get_selection().get_selected()
+            if iter:
+                target = model.get_value(iter, 2)
+                try:
+                    new_cursor_pos = tracks.index(target)
+                except ValueError:
+                    pass
+        if 'new_cursor_pos' not in locals():
+            new_cursor_pos = None
+        self.__last_tracks = copy(tracks)
+        self._model.clear()
+        # Add the rows
+        for i, track in zip(xrange(1, len(tracks) + 1), tracks):
+            self._model.append((i, unicode(track), track))
+        # Select new row
+        if new_cursor_pos is not None and hasattr(self, '_queue_view'):
+            self._queue_view.set_cursor((new_cursor_pos,))
+
+    def show(self):
+        """
+            Displays this window
+        """
+        self._dialog.show_all()
+
+    def destroy(self, *e):
+        """
+            Destroys this window
+        """
+        self._dialog.destroy()
+        self.__teardown_callbacks()
+
+# removing items
+    def remove_selected(self, button, *userparams):
+        model, iter = self._queue_view.get_selection().get_selected()
+        if not iter:
+            return
+        i = model.get_value(iter, 0) - 1
+        self.remove(i)
+
+    def remove_all(self, button, *userparams):
+        while len(self._queue.get_ordered_tracks()):
+            self.remove(0)
+
+    def remove(self, i):
+        """Removes the ith item from the queue, 0-indexed"""
+        cur_queue = self._queue.get_ordered_tracks()
+        if i < 0 or i >= len(cur_queue):
+            LOG.error(_("Gave an invalid number to remove"))
+            return
+        cur_queue.pop(i)
+        self.__populate_queue()
+
+# Moving callbacks
+    def selected_to_top(self, button, *userparams):
+        self.reorder(lambda x, l: 0)
+
+    def selected_up(self, button, *userparams):
+        self.reorder(lambda x, l: x - 1)
+
+    def selected_down(self, button, *userparams):
+        self.reorder(lambda x, l: x + 1)
+
+    def selected_to_bottom(self, button, *userparams):
+        self.reorder(lambda x, l: l - 1)
+
+    def reorder(self, new_loc):
+        """Reorders the tracks in the queue.
+
+        new_loc is a function that takes two variables, x and l. x will be the
+        the index of the currently selected item. l will be the size of the
+        queue. The function need not bounds check.
+
+        """
+        model, iter = self._queue_view.get_selection().get_selected()
+        if not iter:
+            return
+        
+        i = model.get_value(iter, 0) - 1
+        tracks = self._queue.get_ordered_tracks()
+        if callable(new_loc):
+            new_loc = new_loc(i, len(tracks))
+        if new_loc < 0 or new_loc >= len(tracks):
+            new_loc = i
+
+        new_order = list(zip(range(len(tracks)), tracks))
+        new_order[new_loc], new_order[i] = new_order[i], new_order[new_loc]
+
+        self._queue.set_ordered_tracks(list(map(itemgetter(1), new_order)))
+        self.__populate_queue()
+
+def main():
+    class Track(object):
+        def __init__(self, title):
+            self.tags = {'title': title}
+        def __unicode__(self):
+            return self.tags['title']
+        def __str(self):
+            return str(unicode(self))
+    class Foo(object):
+        ordered_tracks = [Track('Track Foo by bar on baz'), Track('bar')]
+        get_ordered_tracks = lambda self: self.ordered_tracks
+        def set_ordered_tracks(self, v):
+            self.ordered_tracks = v
+    dialog = QueueManager(Foo())
+    dialog.show()
+    try:
+        gtk.main()
+    except KeyboardInterrupt:
+        pass
+
+if __name__ == "__main__":
+    main()