Plugins: command.py

import os
import gtk
from plugins.events import EventPlugin
from qltk.entry import ValidatingEntry
from qltk import Button, Message, ErrorMessage
import util, config, widgets


info_use=_("""
<b>Command parameters:</b>
The following command parameters will be
substituted only when is launched the command
of a start/end song:
   <b>%f</b>  the path of the sound file
   <b>%d</b>  directory of the sound file
   <b>%n</b>  filename (without path)

<b>Examples:</b>
  echo starting... %f
  find %d -iname *.ogg -print
  find %d -iname *.ogg -fprint ogg_list.txt
  cp %f /data/listened/%n
  xterm
  firefox http://www.python.org
  sudo halt
""")

def iscommand(s):
        """util function modified"""

        s=s.strip()
        if s == "": return False
        else:
                s = s.split()[0]
                if os.path.sep in s:
                        return (os.path.isfile(s) and os.access(s, os.X_OK))
                for p in os.defpath.split(os.path.pathsep):
                        p2 = os.path.join(p, s)
                        if (os.path.isfile(p2) and os.access(p2, os.X_OK)):
                                return True
                else: return False

class CommEvent(EventPlugin):
        PLUGIN_ID = "Command Event"
        PLUGIN_NAME = _("Command Event")
        d=_("Execute a command when a song starts or/and ends or/and music stops.")
        PLUGIN_DESC=(d)
        PLUGIN_VERSION = "0.1"
        
        def __init__(self):
                self.first_time=True #when quodlibet starts
                
        def PluginPreferences(self, parent):
                self.parent=parent
                vb = gtk.VBox(spacing=5)
                #start of song
                text=_("When a song starts:")
                self._create_preferences(text,vb,"command_event_start")
                #end of song
                text=_("When a song ends:")
                self._create_preferences(text,vb,"command_event_end")
                #when end of music automatically
                text=_("When music stops automatically\n (not when paused):")
                self._create_preferences(text,vb,"command_event_stop_all")
                info = Button(_("Show Info"), gtk.STOCK_INFO)
                info.connect('clicked', self._show_info)
                vb.pack_start(info, expand=False)
                vb.show_all()
                return vb

        def plugin_on_song_ended(self, song, stopped):
                if stopped==False: self._command("command_event_end",song)
                return None
        
        def plugin_on_song_started(self, song):
                if self.first_time==True: 
                        self.first_time=False
                        return None
                if song==None: #when all stops
                        self._command("command_event_stop_all")
                else: #when starts a song
                        self._command("command_event_start",song)
                return None

        def _command(self,id_command,song=None):
                try: command = config.get("plugins", id_command)
                except: command=""
                if command=="": return None
                command_list=command.split()
                if song!=None:
                        p=song._song['~filename']
                        for i in range(len(command_list)):
                                item=command_list[i]
                                item=item.replace("%f",p)
                                item=item.replace("%d",os.path.dirname(p))
                                item=item.replace("%n",os.path.basename(p))
                                command_list[i]=item
                try:
                        #Execute the command:
                        util.spawn(command_list)
                        #use at your own risk:
                        #print util.spawn(command_list,stdout=True).read()
                except:
                        #When there is an error:
                        c = " ".join(command_list)
                        error_msg = _("<small>Command Event (Quod Libet message):</small>\n\
Some error with the command:\n<b><i>%s</i></b>"%util.escape(c))
                        dialog = ErrorMessage(widgets.main, error_msg,
                                _("In the Command Event Plugin dialog is:\n\
<i>%s</i>"%util.escape(command)))
                        dialog.connect('response', self._destroy_msg)
                        dialog.show()
                        #on terminal:
                        #error_msg = _("Some error with the command: \"%s\"."%c)
                        #print error_msg + " " + _("(Command Event plugin message)")
                return None
        
        def _create_preferences(self,text,vb,name_id):
                label_info = gtk.Label(text)
                label = gtk.Label(" "+_("Command:"))
                entry = ValidatingEntry(iscommand)
                try:
                        command = config.get("plugins", name_id)
                        entry.set_text(command)
                except:
                        pass
                entry.connect('changed', self._entry_changed, name_id)
                label.set_mnemonic_widget(entry)
                hb= gtk.HBox()
                hb.pack_start(label_info, expand=False)
                hb.pack_start(gtk.Label(" "))
                hb2 = gtk.HBox(spacing=3)
                hb2.pack_start(label, expand=False)
                hb2.pack_start(entry)
                vb.pack_start(hb)
                vb.pack_start(hb2)
                return None
        
        def _entry_changed(self, entry, name_id):
                self.first_time=False
                text=entry.get_text()
                if text.strip()!="": config.set("plugins", name_id, text)
                else: config.set("plugins", name_id, "")
                return None
        
        def _show_info(self, button):
                Message(gtk.MESSAGE_INFO, self.parent, _("Info Command Event"), info_use).run()
                return None

        def _destroy_msg(self, dialog, response_id):
                dialog.destroy()
                return None