shroom 0.0.6 → 0.0.7

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/testtask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'shroom'
-  s.version = '0.0.6'
+  s.version = '0.0.7'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README', 'LICENSE']
   s.summary = 'Shroom is a music player and organizer'

data/lib/sh_cover_art.rb

@@ -5,7 +5,7 @@ require 'cgi'
 module Sh
   class CoverArt
     def CoverArt.get_cover song
-      if $prefs[:cover_art]
+      if Global.internet?
         artist, album = song.artist.name, song.album.title
         path = "#{$cover_dir}/#{artist.to_md5}_#{album.to_md5}"
         return path if File.exists? path

data/lib/sh_global.rb

@@ -1,6 +1,8 @@
 require 'fileutils'
 require 'yaml'
 require 'libglade2'
+require 'ping'
+require 'sh_plugin'
 
 module Sh
   KEYS = {
@@ -12,7 +14,11 @@ module Sh
     SUPPORTED_EXTENSIONS = ['.mp3', '.m4a', '.ogg', '.flac', '.wma', '.wav']
     GLADE = {}
 
-    def initialize
+    def self.init
+      Thread.new do
+        recheck_internet
+      end
+
       # Won't work on Windows
       $home = ENV['HOME']
       $config_dir = "#{$home}/.shroom"
@@ -21,7 +27,7 @@ module Sh
       FileUtils.mkdir $cover_dir unless File.exists? $cover_dir
       @@prefs_file = "#{$config_dir}/preferences.yml"
 
-      $prefs = {
+      @@prefs = {
         :library_dir => "#{$home}/Music",
         :cover_art => true,
         :lyrics => true,
@@ -30,37 +36,66 @@ module Sh
         :lastfm_password => nil,
       }
 
-      Global.load_prefs
-
       add_toplevel_glade('dlg_preferences')
       add_toplevel_glade('dlg_song')
+      add_toplevel_glade('dlg_plugins')
       GLADE.freeze
+
+      load_prefs
+      load_plugins
+    end
+
+    def self.recheck_internet(timeout=5)
+      # Ping Google
+      @@internet = Ping.pingecho("64.233.187.99", timeout, 80)
+    end
+
+    def self.internet?
+      return @@internet
     end
 
-    def Global.load_prefs
+    def self.locate(file)
+      find_in_load_path("shroom-res/#{file}") || "shroom-res/#{file}"
+    end
+
+    def self.prefs
+      return @@prefs
+    end
+
+    def self.load_prefs
       if File.exists?(@@prefs_file)
         prefs = YAML::load(File.read(@@prefs_file))
         prefs.each do |k, v|
-          $prefs[k] = v
+          @@prefs[k] = v
         end
       end
     end
 
-    def Global.save_prefs
+    def self.save_prefs
       File.open(@@prefs_file, 'w') do |f|
-        f.write $prefs.to_yaml
+        f.write @@prefs.to_yaml
       end
     end
-    
-    def Global.locate(file)
-      find_in_load_path("shroom-res/#{file}") || "shroom-res/#{file}"
+
+    def self.load_plugins
+      plugin_dirs = ["#{self.locate("plugins")}", "#{$config_dir}/.plugins"]
+      plugin_dirs.each do |dir|
+        Dir["#{dir}/*.rb"].each do |rb_file|
+          begin
+            require rb_file
+          rescue Exception
+            puts "Error loading plugin: #{rb_file}"
+            puts $!
+          end
+        end
+      end
     end
 
     private
-    def add_toplevel_glade name
+    def self.add_toplevel_glade name
       GLADE[name] = GladeXML.new(Global.locate('shroom.glade'), name)
     end
-  end
-end
 
-Sh::Global.new
+    init()
+  end
+end

data/lib/sh_lyrics.rb

@@ -1,27 +1,57 @@
 require 'open-uri'
 require 'hpricot'
 require 'cgi'
+require 'ping'
 
 module Sh
   class Lyrics
     def Lyrics.get_lyrics song
       artist, title = song.artist.name, song.title
-      return "" unless artist and title
+      return nil unless artist and title
       LyricsWiki.get_lyrics(artist, title)
     end
 
     class LyricsWiki
       def LyricsWiki.get_lyrics(artist, title)
-        url = "http://lyricwiki.org/api.php?func=getSong&fmt=xml" +
-          "&artist=#{CGI.escape(artist)}" +
-          "&song=#{CGI.escape(title)}"
-        doc = Hpricot(open(url))
-        page_url = (doc/'url').inner_text
         lyrics = nil
-        unless page_url.end_with? ';action=edit'
-          doc = Hpricot(open(page_url).read.gsub(/<[\s]*br[\s]*\/?>/, "\n"))
-          #TODO: Choose most appropriate lyricbox, not just the first
-          lyrics = (doc/'.lyricbox').first.inner_text.strip
+        if Ping.pingecho("lyricwiki.org", 10)
+          url = "http://lyricwiki.org/api.php?func=getSong&fmt=xml" +
+            "&artist=#{CGI.escape(artist)}" +
+            "&song=#{CGI.escape(title)}"
+          doc = Hpricot(open(url))
+          page_url = (doc/'url').inner_text
+          page_name = page_url.match(/(:[^:]*[$])/).to_s
+          page_name = CGI.unescape(page_name)
+          page_name.freeze
+          unless page_url.end_with? ';action=edit'
+            doc = Hpricot(open(page_url).read.gsub(/<[\s]*br[\s]*\/?>/, "\n"))
+            versions = []
+            lyricboxes = doc/'div.lyricbox'
+            best_match = [0, lyricboxes.first.inner_text.strip]
+            if lyricboxes.size > 1 and StringMatcher.compare_ignore_case(page_name, title) < 0.9
+              lyricboxes.each do |box|
+                prev = box.previous
+                version = nil
+                while prev
+                  unless (prev/'.mw-headline').empty?
+                    version = prev.inner_text.strip
+                    break
+                  end
+                  prev = prev.previous
+                end
+                version.sub! /^\[edit\] /, ''
+                lyrics = box.inner_text.strip
+                versions << [version, lyrics]
+              end
+              versions.each do |version, lyrics|
+                version_title = page_name.dup
+                version_title << " (#{version})" if version
+                match = [StringMatcher.compare_ignore_case(version_title, title), lyrics]
+                best_match = match if match.first > best_match.first
+              end
+            end
+            lyrics = best_match[1]
+          end
         end
         return lyrics
       end

data/lib/sh_main.rb

@@ -15,10 +15,14 @@ require 'sh_view'
 module Sh
   class Main
     def initialize
+      # Load the database
       $db = Sh::Database.new
+      
+      # See sh_player.rb for why this Wx stuff is necessary
       Wx::App.run do
         Sh::View.new.show
       end
+
       puts 'Saving preferences...'
       Sh::Global.save_prefs
       puts 'Bye!'
@@ -26,4 +30,5 @@ module Sh
   end
 end
 
+# Get the show started if Shroom is run as a standalone application
 Sh::Main.new if $0 == __FILE__

data/lib/sh_player.rb

@@ -1,30 +1,52 @@
 require 'wx'
 require 'rubygems'
 require 'scrobbler'
+require 'sh_plugin'
+
+# I believe that a small explanation is in order. You may be wondering why Wx
+# is being used when Gtk is the GUI library for everything else? I chose to
+# use Wx for it's MediaCtrl, which provides a media playback interface. This
+# nifty widget works on multiple platforms, and doesn't actually require its
+# visibility. Unfortunately, the Wx main loop must be running for it to work,
+# and the MediaCtrl must be attatched to a Frame (as far as I can tell). As
+# a result, the Player class inherits from Wx::Frame even though it never
+# actually displays anything. It would be nice if I could get MediaCtrl
+# without all of the other Wx stuff attached!
 
 module Sh
   class Player < Wx::Frame
     @@scrobble_auth = nil
-    attr_reader :song
+    attr_reader :song, :play_time
 
     def initialize song
+      # Initialize frame, even though it will never be made visible
+      super(nil,:title=>"",:size=>[0,0])
+      self.hide
+
       @song = song
       @destroyed = false
       @play_time = 0
-      super(nil,:title=>"",:size=>[700,700])
+
+      # Load media so that it is ready to play
       @mp = MediaPanel.new(self)
-      @mp.do_load_file song.path
-      self.hide
-      trap('EXIT') do
-        self.stop
-      end
+      @mp.load_file song.path
+      
+      # Maintain a rough indication of time spent actually playing audio
       GLib::Timeout.add(1000) do
         @play_time += 1 if playing?
         !@destroyed
       end
+
+      # Cleanup before exiting (Not sure whether this is necessary, but may
+      # be useful in the future)
+      trap('EXIT') do
+        self.stop
+        self.demolish
+      end
     end
 
-    def demolish
+    # Destroys the player (should be called when it is no longer needed)
+    def demolish!
       @destroyed = true
       self.destroy
     end
@@ -51,13 +73,17 @@ module Sh
 
     def stop
       @mp.stop
-      scrobble_lastfm! if $prefs[:lastfm]
+
+      # Dispatch event notification to plugins
+      Plugin.broadcast(:on_player_stopped, self)
     end
 
+    # Get the duration (in seconds)
     def duration
       @mp.duration
     end
 
+    # Get the position (in seconds) of playback
     def position
       @mp.position
     end
@@ -70,60 +96,11 @@ module Sh
     def on_finished &block
       @mp.on_finished {block.call(self)}
     end
-
-    #TODO: move scrobble support elsewhere
-    def scrobble_lastfm!
-      @@scrobble_queue ||= []
-      play_time = @play_time
-      if play_time > 240 or (play_time > duration / 2 and duration > 30)
-        auth = @@scrobble_auth
-        if not auth or auth.status.strip.upcase != 'OK'
-          user, pass = $prefs[:lastfm_user], $prefs[:lastfm_password]
-          begin
-            auth = @@scrobble_auth = Scrobbler::SimpleAuth.new(:user => user, :password => pass)
-            auth.handshake!
-            puts "Last.fm authentication status: #{auth.status}"
-          rescue
-          end
-        end
-
-        @@scrobble_queue << {
-          :session_id => auth.session_id,
-          :submission_url => auth.submission_url,
-          :artist => song.artist.name,
-          :track => song.title,
-          :album => song.album.title,
-          :time => Time.new,
-          :length => duration,
-          :track_number => song.track_num}
-
-        # No point attempting to scrobble without authentication
-        return if auth.status.strip.upcase != 'OK'
-
-        Thread.new do
-          failed_scrobbles = []
-          until @@scrobble_queue.empty?
-            scrobble = nil
-            begin
-              scrobble = Scrobbler::Scrobble.new(@@scrobble_queue.pop)
-              scrobble.submit!
-            rescue
-              scrobble = nil
-            end
-
-            if scrobble and scrobble.status.strip.upcase == 'OK'
-              puts "Scrobble for '#{scrobble.track}' succeeded"
-            else
-              puts "Warning: Scrobble for '#{scrobble.track}' failed"
-              failed_scrobbles << scrobble
-            end
-          end
-          @@scrobble_queue.insert(0, *failed_scrobbles)
-        end
-      end
-    end
   end
 
+  # Playback is done using the WxWidgets' MediaCtrl. Note that the interface is
+  # not Wx, it is GTK. However, since MediaCtrl is tied to graphical components,
+  # unused Wx GUI stuff must be created for it to work.
   private
   class MediaPanel < Wx::Panel
     def initialize(parent)
@@ -136,39 +113,25 @@ module Sh
       evt_media_finished @mc, :on_media_finished
     end
 
-    # Update the position indicator in seconds
+    # Get the position in seconds
     def position
       offset = @mc.tell
       # Will be -1 if nothing is loaded
       if offset >= 0
         offset_secs = offset / 1000
         return offset_secs
-        #lbl_pos = "%i:%02d" % [ offset_secs / 60, offset_secs % 60 ]
       end
       return nil
     end
 
-    # Actually load a file into the mediactrl
-    def do_load_file(path)
+    # Load a media file into the MediaCtrl
+    def load_file(path)
       unless @mc.load(path)
-        Wx::message_box("Unable to load file", "ERROR",
-          Wx::ICON_ERROR|Wx::OK)
+        puts "Unable to load file into MediaCtrl"
         on_media_finished nil
       end
     end
 
-    MEDIA_FILE_WILDCARD = "Audio Files|*.mp3;*.flac;*.ogg;*.m4a"
-    # Load a media file from disk
-    def show_open_dialog
-      dlg = Wx::FileDialog.new( self,
-        :message  => "Choose a media file",
-        :wildcard => MEDIA_FILE_WILDCARD,
-        :style    => Wx::OPEN)
-      if dlg.show_modal == Wx::ID_OK
-        do_load_file(dlg.path)
-      end
-    end
-
     # Move the media to a position in the file, using the slider
     def seek(secs)
       @mc.seek((secs*1000).to_i)
@@ -177,11 +140,6 @@ module Sh
     # Set up the initial size for the move
     def on_media_loaded(evt)
       @loaded = true
-
-      # Update the length and position text indicators with the media's
-      # time length, shown as minutes and seconds
-      len_secs = duration
-      lbl_len = "%i:%02d" % [ len_secs / 60, len_secs % 60 ]
     end
 
     def on_finished &block
@@ -210,10 +168,9 @@ module Sh
 
     # Start the playback
     def play
-      if not @mc.play
-        Wx::MessageBox("unable to play media","ERROR",Wx::ICON_ERROR|Wx::OK)
+      unless @mc.play
+        puts "Unable to play media with MediaCtrl"
         on_media_finished nil
-      else
       end
     end
   end

data/lib/sh_plugin.rb

@@ -0,0 +1,44 @@
+module Sh
+  module PluginSugar
+    def def_field(*names)
+      class_eval do
+        names.each do |name|
+          define_method(name) do |*args|
+            case args.size
+            when 0
+              instance_variable_get("@#{name}")
+            else
+              instance_variable_set("@#{name}", *args)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  class Plugin
+    @registered_plugins = {}
+    class << self
+      attr_reader :registered_plugins
+      private :new
+    end
+
+    def self.define(id_name, &block)
+      p = new
+      p.instance_eval(&block)
+      Plugin.registered_plugins[id_name] = p
+    end
+
+    def self.broadcast(method_name, *args)
+      registered_plugins.each_value do |plugin|
+        if plugin.respond_to? method_name
+          Thread.new {plugin.send method_name, *args}
+        end
+      end
+    end
+
+    extend PluginSugar
+
+    def_field :name, :description, :author, :version
+  end
+end