shroom 0.0.9 → 0.0.10

data/lib/sh_plugin.rb

@@ -4,8 +4,7 @@ module Sh
       class_eval do
         names.each do |name|
           define_method(name) do |*args|
-            case args.size
-            when 0
+            if args.size == 0
               instance_variable_get("@#{name}")
             else
               instance_variable_set("@#{name}", *args)
@@ -18,27 +17,52 @@ module Sh
 
   class Plugin
     @registered_plugins = {}
+    @active_plugins = {}
+
+    def self.init
+      begin
+        @plugin_prefs = YAML.load_file(Sh::Global::PATHS[:plugin_prefs_file])
+      rescue
+        @plugin_prefs = {}
+      end
+    end
+    
     class << self
-      attr_reader :registered_plugins
+      attr_reader :registered_plugins, :active_plugins
       private :new
     end
 
     def self.define(id_name, &block)
       p = new
+      p.id_name id_name
       p.instance_eval(&block)
-      Plugin.registered_plugins[id_name] = p
+      p.init @plugin_prefs[id_name] if p.respond_to? :init
+      registered_plugins[id_name] = p
+      active_plugins[id_name] = p
     end
 
     def self.broadcast(method_name, *args)
-      registered_plugins.each_value do |plugin|
+      active_plugins.each_value do |plugin|
         if plugin.respond_to? method_name
           Thread.new {plugin.send method_name, *args}
         end
       end
     end
 
+    def self.save_prefs
+      prefs = {}
+      registered_plugins.each do |id, plugin|
+        if plugin.respond_to? :preferences
+          prefs[id] = plugin.preferences
+        end
+      end
+      open(Sh::Global::PATHS[:plugin_prefs_file], "w") do |f|
+        f.write prefs.to_yaml
+      end
+    end
+
     extend PluginSugar
 
-    def_field :name, :description, :author, :version
+    def_field :name, :description, :author, :version, :id_name
   end
-end
+end

data/lib/sh_song.rb

@@ -3,9 +3,10 @@ require 'sh_tagreader'
 require 'sh_album'
 require 'sh_artist'
 require 'cgi'
-require 'earworm'
-require 'rbrainz'
-include MusicBrainz
+try_require 'earworm'
+if try_require 'rbrainz'
+	include MusicBrainz
+end
 
 module Sh
   class Song
@@ -21,12 +22,10 @@ module Sh
     end
 
     def album
-      #@album = $db.albums(:id => @album.db_id).first if @album and @album.db_id
       return @album
     end
 
     def artist
-      #@artist = $db.artists(:id => @artist.db_id).first if @artist and @artist.db_id
       return @artist
     end
 
@@ -35,7 +34,7 @@ module Sh
     end
 
     def duration
-      @duration ||= Sh::TagReader.read(path)[:duration]
+      return (@duration ||= Sh::TagReader.read(path)[:duration])
     end
 
     def lookup!
@@ -55,10 +54,13 @@ module Sh
         album.mbid = rel.id.to_mbid.uuid
         # Determine track number
         query = Webservice::Query.new
-        filter = Webservice::TrackFilter.new(:artistid => artist.mbid, :releaseid => album.mbid)
+        filter = Webservice::TrackFilter.new(:artistid => artist.mbid, 
+        	:releaseid => album.mbid)
         tracks = query.get_tracks(filter).entities
         tracks.to_a.each_with_index do |t, i|
-          self.track_num = i + 1 if t.title == track.title and t.duration == track.duration
+        	if t.title == track.title and t.duration == track.duration
+          	self.track_num = i + 1
+          end
         end
       rescue Exception
         return false
@@ -73,7 +75,7 @@ module Sh
       ew = Earworm::Client.new(Sh::KEYS[:music_dns])
       begin
         info = ew.identify(:file => path)
-      rescue
+      rescue Exception
         printf "Couldn't generate fingerprint for %s\n> %s\n\n", path, $!
         return
       end
@@ -84,7 +86,8 @@ module Sh
       return if not title or not artist.name
       # Get more information from MusicBrainz
       query = Webservice::Query.new
-      filter = Webservice::TrackFilter.new(:artist => artist.name, :title => title, :puid => puids.first)
+      filter = Webservice::TrackFilter.new(:artist => artist.name, 
+      	:title => title, :puid => puids.first)
       tracks = query.get_tracks(filter).entities
       @matches = (tracks || [])
       return @matches

data/lib/sh_tagreader.rb

@@ -1,22 +1,42 @@
+require 'sh_util'
+require 'sh_log'
+
 module Sh
   class TagReader
-    def TagReader.read path, &block
+    def self.read path, &block
+      # Ensure that the path is absolute
       @path = File.expand_path path
-      metadata = {}
       
+      # Use shared-mime-info to determine MIME types if
+      # it is available.
       if try_require 'shared-mime-info'
-        type = MIME.check(path)
+        type = MIME.check(@path)
         @mime = type.to_s if type.media == 'audio'
+      else
+      	# Attempt to use the `file` command
+      	begin
+        	type = `file --mime-type -b #{@path}`
+        	@mime = type if type[0..5] == 'audio/'
+        rescue Exception
+        	@mime = nil
+        end
+        
+        # As a fallback, guess MIME type from file extension.
+		    if not @mime or @mime.empty?
+				  @mime = {
+				    '.mp3' => 'audio/mpeg',
+				    '.m4a' => 'audio/mp4',
+				    '.flac' => 'audio/x-flac',
+				    '.ogg' => 'audio/ogg',
+				    '.wav' => 'audio/x-wav',
+				    '.wma' => 'audio/x-ms-wma'
+				  }[File.extname @path]
+				end
       end
-      @mime ||= {
-        '.mp3' => 'audio/mpeg',
-        '.m4a' => 'audio/mp4',
-        '.flac' => 'audio/x-flac',
-        '.ogg' => 'audio/ogg',
-        '.wav' => 'audio/x-wav',
-        '.wma' => 'audio/x-ms-wma'
-      }[File.extname path]
-
+      
+      metadata = {}
+			
+			# Choose appropriate method for MIME type
       begin
         case @mime
         when 'audio/mpeg'
@@ -33,14 +53,16 @@ module Sh
           metadata = TagReader.read_wave path
         end
       rescue Exception
-        puts "Error parsing tags for " + path
+        Log.warning "Couldn't parse tags for " + path
       end
-
+			
+			# Report on our metadata findings
       yield metadata if block
       return metadata
     end
-
-    def TagReader.read_mp3 path, &block
+		
+		# Read metadata from MP3 file
+    def self.read_mp3 path, &block
       metadata = {}
       if try_require 'mp3info'
         Mp3Info.open path do |mp3|
@@ -53,13 +75,14 @@ module Sh
           metadata[:duration] = mp3.length
         end
       else
-        puts 'Please install the "mp3info" gem in order to read MP3 info'
+        Log.info 'Please install the "mp3info" gem in order to read MP3 info'
       end
       yield metadata if block
       return metadata
     end
-
-    def TagReader.read_m4a path, &block
+		
+		# Read metadata from M4A file
+    def self.read_m4a path, &block
       metadata = {}
       if try_require 'mp4info'
         mp4 = MP4Info.open path
@@ -70,13 +93,14 @@ module Sh
         metadata[:track_num] = mp4.TRKN.first.to_i
         metadata[:duration] = mp4.SECS
       else
-        puts 'Please install the "mp4info" gem in order to read M4A info'
+        Log.info 'Please install the "mp4info" gem in order to read M4A info'
       end
       yield metadata if block
       return metadata
     end
-
-    def TagReader.read_ogg path, &block
+		
+		# Read metadata from OGG Vorbis file
+    def self.read_ogg path, &block
       metadata = {}
       if try_require 'ogginfo'
         OggInfo.open path do |ogg|
@@ -89,13 +113,14 @@ module Sh
           metadata[:duration] = ogg.length
         end rescue Exception
       else
-        puts 'Please install the "ogginfo" gem in order to read OGG info'
+        Log.info 'Please install the "ogginfo" gem in order to read OGG info'
       end
       yield metadata if block
       return metadata
     end
-
-    def TagReader.read_flac path, &block
+		
+		# Read metadata from FLAC file
+    def self.read_flac path, &block
       metadata = {}
       if try_require 'flacinfo'
         flac = FlacInfo.new(path)
@@ -118,13 +143,14 @@ module Sh
           end
         end
       else
-        puts 'Please install the "flacinfo" gem in order to read FLAC info'
+        Log.info 'Please install the "flacinfo" gem in order to read FLAC info'
       end
       yield metadata if block
       return metadata
     end
-
-    def TagReader.read_wma path, &block
+		
+		# Read metadata from WMA file
+    def self.read_wma path, &block
       metadata = {}
       if try_require 'wmainfo'
         wma = WmaInfo.new(path)
@@ -146,19 +172,20 @@ module Sh
         end
         metadata[:duration] = wma.info["playtime_seconds"]
       else
-        puts 'Please install the "wmainfo" gem in order to read WMA info'
+        Log.info 'Please install the "wmainfo" gem in order to read WMA info'
       end
       yield metadata if block
       return metadata
     end
-
-    def TagReader.read_wave path, &block
+		
+		# Read metadata from Wave file
+    def self.read_wave path, &block
       metadata = {}
       if try_require 'waveinfo'
         wave = WaveInfo.new path
         metadata[:duration] = wave.duration
       else
-        puts 'Please install the "waveinfo" gem in order to read WAV info'
+        Log.info 'Please install the "waveinfo" gem in order to read WAV info'
       end
       yield metadata if block
       return metadata

data/lib/sh_util.rb

@@ -21,82 +21,47 @@ class Object
   end
 end
 
-require 'digest/md5'
-class String
-  def to_md5
-    return (Digest::MD5.new << self).to_s
-  end
-
-  def to_u
-    begin
-      raise "Binary data!" if is_binary_data?
-      utf8 = isutf8
-      if utf8
-        utf8 = utf8.to_s
-      else
-        utf8 = unpack('C*').pack('U*')
-      end
-      return utf8
-    rescue Exception
-      return nil
+require 'open-uri'
+module Rest
+  class Get
+    def initialize(url, params={})
+      @url = url.dup
+      @query = ''
+      @query = build_query params
     end
-  end
-end
-
-class File
-  def empty? path
-    return size? path
-  end
-end
-
-class StringMatcher
-  def initialize str1, str2
-    @str1, @str2 = str1, str2
-  end
-
-  def self.compare(str1, str2)
-    return StringMatcher.new(str1, str2).compare
-  end
-
-  def self.compare_ignore_case(str1, str2)
-    return StringMatcher.new(str1, str2).compare_ignore_case
-  end
 
-  def compare
-    return 1 if @str1 == @str2
-    pairs1 = word_letter_pairs @str1
-    pairs2 = word_letter_pairs @str2
-    union = pairs1.size + pairs2.size
-    intersection = 0
-    pairs1.size.times do
-      intersection += 1 if pairs2.delete pairs1.pop
+    def [](params={})
+      query = build_query params
+      open(@url + query).read
     end
-    return (2 * intersection).to_f / union
-  end
 
-  def compare_ignore_case
-    @str1 = @str1.upcase
-    @str2 = @str2.upcase
-    return compare
+    private
+    def build_query(params)
+      query = @query
+      params.each do |key, value|
+        query << (query.empty? ? '?' : '&')
+        query << CGI.escape(key.to_s)
+        query << '='
+        query << CGI.escape(value.to_s)
+      end
+      return query
+    end
   end
+end
 
-  private
-  def letter_pairs str
-    n_pairs = str.length - 1
-    pairs = []
-    n_pairs.times do |i|
-      pairs[i] = str.slice(i, 2)
-    end
-    return pairs
+require 'digest/md5'
+class String
+  def to_md5
+    return (Digest::MD5.new << self).to_s
   end
 
-  def word_letter_pairs str
-    pairs = []
-    words = str.split(/\s/)
-    words.each do |word|
-      pairs.concat letter_pairs(word)
+  def to_u
+    if is_binary_data?
+    	return isutf8 ? self : nil
+    else
+      utf8 = isutf8
+      return utf8 ? utf8.to_s : unpack('C*').pack('U*')
     end
-    return pairs
   end
 end
 
@@ -175,7 +140,7 @@ module Kelp
     end
   end
 
-  def Kelp.process_events
+  def self.process_events
     Gtk.main_iteration while Gtk.events_pending?
   end
 end

data/lib/sh_view.rb

@@ -1,23 +1,32 @@
 require 'sh_browse'
+require 'sh_cover_browse'
 require 'sh_queue'
 require 'sh_playlist'
 require 'sh_lyrics'
 require 'sh_cover_art'
 require 'sh_mmkeys'
+require 'sh_actions'
 require 'gtk2'
 require 'gtkhtml2'
 include Gtk
 
 module Sh
   class View
-    TAB_QUEUE, TAB_BROWSE, TAB_LYRICS, NUM_TABS = *(0..3).to_a
+    TAB_QUEUE, TAB_BROWSE, TAB_LYRICS, TAB_COVER_BROWSE, TAB_PLAYLISTS, NUM_TABS = (0..5).to_a
     TAB_NAMES = {
       TAB_QUEUE => 'Queue',
       TAB_BROWSE => 'Browse',
-      TAB_LYRICS => 'Lyrics'
+      TAB_LYRICS => 'Lyrics',
+      TAB_COVER_BROWSE => 'Cover Browse',
+      TAB_PLAYLISTS => 'Playlists'
     }
+    
+    @@instance = nil
 
     def initialize
+      Sh::Log.warning 'Instance of Browse already created!' if @@instance
+    	@@instance = self
+      
       # Initialize GTK
       Gtk.init
 
@@ -52,16 +61,17 @@ module Sh
         new_songs.each do |song|
           # Show path to song in the dialog
           dialog.message = song.path
-          puts "Adding: #{song.path}"
+          
           begin
             # Read metadata from song tags
             song.read_tags!
             # Save song to the database
             $db.save_song song
-            # Increment progress bar
+            Sh::Log.debug "Added #{song.path} to database"
           rescue
-            puts "Couldn't add song. Reason: #{$!}"
+            Sh::Log.info "Failed to add ${song.path} to database", $!
           end
+          # Increment progress bar
           dialog.fraction += inc
           # Make sure that the GUI is updated
           Kelp.process_events
@@ -80,6 +90,8 @@ module Sh
         # Clean up
         new_songs = dialog = nil
       end
+      
+      Sh::Log.debug 'Synchronized library dir with database'
 
       # Load small 16x16 pixel Shroom logo
       icon = Gdk::Pixbuf.new Global.locate('icon_16x16.png')
@@ -218,9 +230,14 @@ module Sh
       scr_lyrics = ScrolledWindow.new(nil, nil)
       scr_lyrics.set_policy(POLICY_AUTOMATIC, POLICY_AUTOMATIC)
       scr_lyrics.add @html_lyrics
-      # Browse area
-      browse = Sh::Browse.new self
+      box_lyrics = VBox.new false, 0
+      box_lyrics.add scr_lyrics
+      @btn_refresh_lyrics = Button.new Stock::REFRESH
+      box_lyrics.pack_start @btn_refresh_lyrics, false, false
       queue = Sh::Queue.new self
+      browse = Sh::Browse.new self
+      cover_browse = Sh::CoverBrowse.new self
+      playlists = Sh::Playlists.new self
       lst_tabs.selection.signal_connect('changed') do |selection|
         frm_content.remove frm_content.child if frm_content.child
         case selection.selected.path.indices[0]
@@ -230,11 +247,15 @@ module Sh
         when TAB_BROWSE
           frm_content.child = browse.widget
         when TAB_LYRICS
-          frm_content.child = scr_lyrics
+          frm_content.child = box_lyrics
+        when TAB_COVER_BROWSE
+          frm_content.child = cover_browse.widget
+        when TAB_PLAYLISTS
+        	frm_content.child = playlists.widget
         end
         frm_content.show_all
       end
-      # Select 'Browse' tab
+      # Select 'Browse' tab on startup
       i = 0
       lst_tabs.model.each do |row|
         lst_tabs.selection.select_path row[1] if i == TAB_BROWSE
@@ -250,13 +271,7 @@ module Sh
           next_song
         when 'Previous'
           prev_song
-        when 'Play'
-          if playing?
-            pause
-          else
-            play
-          end
-        when 'PlayPause'
+        when 'Play', 'PlayPause'
           if playing?
             pause
           else
@@ -266,10 +281,16 @@ module Sh
           pause
         end
       end
+      
+      ShroomActions.init
 
       # Show everything
       @window.show_all
     end
+    
+    def self.instance
+    	return @@instance
+    end
 
     private
     def create_menu
@@ -333,6 +354,21 @@ module Sh
       else
         sto_plugins = lst_plugins.model = ListStore.new(Object, Plugin)
         ren_enabled = CellRendererToggle.new
+        ren_enabled.activatable = true
+        ren_enabled.signal_connect('toggled') do |w, path|
+          iter = sto_plugins.get_iter(path)
+          iter[0] = !iter[0]
+          plugin = iter[1]
+          if iter[0]
+            unless Plugin.active_plugins[plugin.id_name]
+              Plugin.active_plugins[plugin.id_name] = plugin
+            end
+          else
+            if Plugin.active_plugins[plugin.id_name]
+              Plugin.active_plugins.delete plugin.id_name
+            end
+          end
+        end
         col_enabled = TreeViewColumn.new('Enabled',
           ren_enabled,
           'active' => 0)
@@ -351,19 +387,26 @@ module Sh
             lbl_name.markup = "<b>#{plugin.name}</b>"
             lbl_version.markup = "<i>#{plugin.version}</i>"
             txt_description.buffer.text = plugin.description
-            btn_preferences.sensitive = plugin.respond_to? :show_preferences
+            btn_preferences.sensitive = plugin.respond_to? :edit_preferences
+						
+						btn_preferences.signal_handler_disconnect @prefs_hnd_id if @prefs_hnd_id
+            @prefs_hnd_id = btn_preferences.signal_connect('clicked') do |*args|
+              plugin.edit_preferences
+            end 
           end
         end
       end
 
       Plugin.registered_plugins.each do |name, plugin|
         iter = sto_plugins.append
-        iter[0] = true
+        iter[0] = Plugin.active_plugins[plugin.id_name] == plugin
         iter[1] = plugin
         lst_plugins.selection.select_iter iter if lst_plugins.selection.count_selected_rows == 0
       end
 
       dlg_plugins.run
+
+      Plugin.save_prefs
     end
 
     def show_preferences
@@ -374,18 +417,9 @@ module Sh
       end
       fbtn_library = glade['fbtn_library']
       fbtn_library.current_folder = Global.prefs[:library_dir]
-      chk_lastfm = glade['chk_lastfm']
-      chk_lastfm.active = Global.prefs[:lastfm]
-      txt_lastfm_user = glade['txt_lastfm_user']
-      txt_lastfm_user.text = Global.prefs[:lastfm_user]
-      txt_lastfm_pass = glade['txt_lastfm_pass']
-      txt_lastfm_pass.text = Global.prefs[:lastfm_password]
       btn_ok = glade['btn_ok']
       ok_handle = btn_ok.signal_connect('clicked') do
         Global.prefs[:library_dir] = fbtn_library.filename
-        Global.prefs[:lastfm] = chk_lastfm.active?
-        Global.prefs[:lastfm_user] = txt_lastfm_user.text
-        Global.prefs[:lastfm_password] = txt_lastfm_pass.text
         Sh::Global.save_prefs
         dlg_prefs.hide
       end
@@ -428,6 +462,7 @@ module Sh
     def on_song_changed
       if @player
         song = @player.song
+        Sh::Log.debug "Playback started for \"#{song.title}\""
         @note.close if @note
         @note = nil
         if @rnotify
@@ -436,42 +471,8 @@ module Sh
           @note = Notify::Notification.new(song.title || 'Unknown track', msg, nil, @status_icon)
         end
         # Cover art
-        if Global.prefs[:cover_art]
-          @pixbuf = nil
-          begin
-            image_path = song.album.image_path
-            @pixbuf = Gdk::Pixbuf.new(image_path) unless File.empty? image_path
-          rescue
-            @pixbuf = nil
-          end
-
-          if @pixbuf
-            @note.pixbuf_icon = @pixbuf.scale(48, 48) if @rnotify
-            @img_cover.pixbuf = @pixbuf.scale(128, 128)
-          else
-            @img_cover.pixbuf = Gdk::Pixbuf.new(Global.locate("cover_unavailable.png")).scale(132, 132)
-            Thread.new do
-              song.album.image_path = Sh::CoverArt.get_cover(song)
-              if song.album.image_path
-                $db.save_song song
-                # Show cover unless requests have been shuffled
-                if song == @player.song
-                  @pixbuf = nil
-                  (@pixbuf = Gdk::Pixbuf.new(song.album.image_path)) rescue Exception
-                  if @pixbuf
-                    if @rnotify
-                      @note.close
-                      @note.pixbuf_icon = @pixbuf.scale(48, 48)
-                      @note.show
-                    end
-                    @img_cover.pixbuf = @pixbuf.scale(128, 128)
-                    plasmarize_background @pixbuf
-                  end
-                end
-              end
-            end
-          end
-        end
+        @pixbuf = nil
+        Thread.new {update_image song} if Global.prefs[:cover_art]
         # Lyrics
         if Global.prefs[:lyrics]
           @html_lyrics.set_html 'Loading...'
@@ -504,26 +505,54 @@ module Sh
         %{
         <h2>#{song.title}</h2>
         <pre style='font-family: sans-serif;'>#{lyrics}</pre>
-        <p></p><a href="#reload">Reload lyrics</a>
         }
       end
-      doc = @html_lyrics.document
-      if @html_signal_id and doc.signal_handler_is_connected?(@html_signal_id)
-        doc.signal_handler_disconnect(@html_signal_id)
+      if @html_signal_id and @btn_refresh_lyrics.signal_handler_is_connected?(@html_signal_id)
+        @btn_refresh_lyrics.signal_handler_disconnect(@html_signal_id)
       end
-      @html_signal_id = doc.signal_connect('link-clicked') do |doc, loc|
-        if loc == '#reload'
-          @html_lyrics.set_html 'Loading...'
-          Thread.new do
-            song.lyrics = Sh::Lyrics.get_lyrics(song)
+      @html_signal_id = @btn_refresh_lyrics.signal_connect('pressed') do |*args|
+        @html_lyrics.set_html 'Loading...'
+        Thread.new do
+          song.lyrics = Sh::Lyrics.get_lyrics(song)
+          $db.save_song song
+          show_lyrics song if @player and @player.song == song
+        end
+      end
+    end
+
+    def update_image song
+      image_path = song.album.image_path
+      # Use image path in database if valid
+      if image_path and File.size? image_path
+        (@pixbuf = Gdk::Pixbuf.new(image_path)) rescue Exception
+      end
+      # Lookup cover art on Internet if necessary
+      unless @pixbuf
+        @img_cover.pixbuf = Gdk::Pixbuf.new(Global.locate("cover_unavailable.png")).scale(132, 132)
+        image_path = Sh::CoverArt.get_cover(song)
+        if image_path
+          begin
+            @pixbuf = Gdk::Pixbuf.new(image_path)
+            song.album.image_path = image_path
             $db.save_song song
-            show_lyrics song if @player and @player.song == song
+          rescue
           end
         end
       end
+      # Show cover image unless requests have been shuffled
+      if @pixbuf and song == @player.song
+        if @rnotify
+          @note.close
+          @note.pixbuf_icon = @pixbuf.scale(48, 48)
+          @note.show
+        end
+        @img_cover.pixbuf = @pixbuf.scale(128, 128)
+        plasmarize_background @pixbuf
+      end
     end
 
     def plasmarize_background image_path
+      return unless image_path
       begin
         pixbuf = nil
         if image_path.is_a? Gdk::Pixbuf
@@ -545,14 +574,14 @@ module Sh
           if color != @plasma_color
             @plasma_color = color.dup
             require 'sh_plasma'
-            pixmap = Plasma.new(600, 600, 3).generate_pixmap(color)
+            pixmap = Plasma.new(512, 512, 3).generate_pixmap(color)
             style = @window.style.copy
             style.set_bg_pixmap(Gtk::STATE_NORMAL, pixmap)
             @window.set_style style
           end
         end
       rescue
-        puts "Plasma fail: #{$!}"
+      	Sh::Log.info "Plasma generation failed", $!
       end
     end
 
@@ -632,6 +661,7 @@ module Sh
     end
 
     def show
+    	Sh::Log.debug 'Starting GTK main loop'
       Gtk.main
     end
 
@@ -639,4 +669,4 @@ module Sh
       Gtk.main_quit
     end
   end
-end
+end