shroom 0.0.6 → 0.0.7

data/lib/sh_song.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'sh_tagreader'
 require 'sh_album'
 require 'sh_artist'
+require 'cgi'
 require 'earworm'
 require 'rbrainz'
 include MusicBrainz
@@ -38,6 +39,9 @@ module Sh
     end
 
     def lookup!
+      # Return if there is no internet connection
+      return false unless Global.internet?
+      
       begin
         track = lookup_multiple.first
         # Don't distinguish between bands with the same name by adding to the name
@@ -114,15 +118,15 @@ module Sh
 
     def to_html
       t = title
-      t = "Unknown" if not t or t.is_binary_data?
-      t.gsub!("<", "&lt;")
+      t = "Unknown" if not t or t.strip == ""
+      t = CGI.escapeHTML t
       ar = artist.name
-      ar = "Unknown" if not ar or ar.is_binary_data?
-      ar.gsub!("<", "&lt;")
+      ar = "Unknown" if not ar or ar.strip == ""
+      ar = CGI.escapeHTML ar
       al = album.title
-      al = "Unknown" if not al or al.is_binary_data?
-      al.gsub!("<", "&lt;")
-      return "<b>#{t}</b> by <i>#{ar}</i> from <i>#{al}</i>".gsub("&", "&amp;")
+      al = "Unknown" if not al or al.strip == ""
+      al = CGI.escapeHTML al
+      return "<b>#{t}</b> by <i>#{ar}</i> from <i>#{al}</i>"
     end
   end
 end

data/lib/sh_tagreader.rb

@@ -45,9 +45,9 @@ module Sh
       if try_require 'mp3info'
         Mp3Info.open path do |mp3|
           t = mp3.tag
-          metadata[:title] = t.title unless t.title and t.title.is_binary_data?
-          metadata[:artist] = t.artist unless t.artist and t.artist.is_binary_data?
-          metadata[:album] = t.album unless t.album and t.album.is_binary_data?
+          metadata[:title] = t.title.sanitise if t.title
+          metadata[:artist] = t.artist.sanitise if t.artist
+          metadata[:album] = t.album.sanitise if t.album
           metadata[:year] = t.year.to_i
           metadata[:track_num] = t.tracknum.to_i
           metadata[:duration] = mp3.length
@@ -63,9 +63,9 @@ module Sh
       metadata = {}
       if try_require 'mp4info'
         mp4 = MP4Info.open path
-        metadata[:title] = mp4.NAM unless mp4.NAM and mp4.NAM.is_binary_data?
-        metadata[:artist] = mp4.ART unless mp4.ART and mp4.ART.is_binary_data?
-        metadata[:album] = mp4.ALB unless mp4.ALB and mp4.ALB.is_binary_data?
+        metadata[:title] = mp4.NAM.sanitise if mp4.NAM
+        metadata[:artist] = mp4.ART.sanitise if mp4.ART
+        metadata[:album] = mp4.ALB.sanitise if mp4.ALB
         metadata[:year] = mp4.DAY.to_i
         metadata[:track_num] = mp4.TRKN.first.to_i
         metadata[:duration] = mp4.SECS
@@ -81,9 +81,9 @@ module Sh
       if try_require 'ogginfo'
         OggInfo.open path do |ogg|
           t = ogg.tag
-          metadata[:title] = t.title unless t.title and t.title.is_binary_data?
-          metadata[:artist] = t.artist unless t.artist and t.artist.is_binary_data?
-          metadata[:album] = t.album unless t.album and t.album.is_binary_data?
+          metadata[:title] = t.title.sanitise if t.title
+          metadata[:artist] = t.artist.sanitise if t.artist
+          metadata[:album] = t.album.sanitise if t.album
           metadata[:year] = t.date.to_i
           metadata[:track_num] = t.tracknumber.to_i
           metadata[:duration] = ogg.length
@@ -106,11 +106,11 @@ module Sh
           value = nil if value == '' or value.is_binary_data?
           case key
           when 'title'
-            metadata[:title] = value
+            metadata[:title] = value.sanitise if value
           when 'artist'
-            metadata[:artist] = value
+            metadata[:artist] = value.sanitise if value
           when 'album'
-            metadata[:album] = value
+            metadata[:album] = value.sanitise if value
           when 'year'
             metadata[:year] = value.to_i
           when 'tracknumber'
@@ -130,13 +130,14 @@ module Sh
         wma = WmaInfo.new(path)
         wma.tags.each do |key, value|
           key = key.downcase
+          value = nil if value == '' or value.is_binary_data?
           case key
           when 'title'
-            metadata[:title] = value
+            metadata[:title] = value.sanitise if value
           when 'author'
-            metadata[:artist] = value
+            metadata[:artist] = value.sanitise if value
           when 'albumtitle'
-            metadata[:album] = value
+            metadata[:album] = value.sanitise if value
           when 'year'
             metadata[:year] = value.to_i
           when 'tracknumber'

data/lib/sh_util.rb

@@ -22,11 +22,24 @@ class Object
 end
 
 require 'digest/md5'
-
 class String
   def to_md5
     return (Digest::MD5.new << self).to_s
   end
+
+  def sanitise
+    begin
+      return unpack('C*').pack('U*')
+    rescue Exception
+      return nil
+    end
+  end
+end
+
+class File
+  def empty? path
+    return size? path
+  end
 end
 
 class StringMatcher
@@ -34,6 +47,14 @@ class StringMatcher
     @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
     pairs1 = word_letter_pairs @str1
     pairs2 = word_letter_pairs @str2

data/lib/sh_view.rb

@@ -18,77 +18,103 @@ module Sh
     }
 
     def initialize
+      # Initialize GTK
       Gtk.init
 
+      # Attempt to load RNotify
       @rnotify = try_require 'RNotify'
 
+      # Prepare notifications if RNotify is set up
       Notify.init 'Shroom' if @rnotify
 
-      if File.exists? $prefs[:library_dir]
+      # Search for songs in library directory if it exists
+      if File.exists? Global.prefs[:library_dir]
         cancelled = false
+        # Prepare progress dialog
         dialog = Kelp::ProgressDialog.new("Updating database...")
         dialog.signal_connect('response') { cancelled = true}
+        # Scan for new songs which are not in the database
         new_songs = []
-        Dir[$prefs[:library_dir]+'/**/*'].each do |path|
+        Dir[Global.prefs[:library_dir]+'/**/*'].each do |path|
           ext = File.extname path
           if Sh::Global::SUPPORTED_EXTENSIONS.include? ext
             new_songs << Song.new(path) unless $db.contains? path
           end
         end
+        # Show progress dialog if there are new songs to process
         if new_songs.length > 0
           dialog.show_all
           Kelp.process_events
         end
+        # inc = the fraction to increment the progress bar by for each song
         inc = 1 / new_songs.length.to_f
+        # Enter new songs in database
         new_songs.each do |song|
+          # Show last 30 characters of path to song in the dialog
           dialog.message = "..." + song.path[-30..-1]
           puts "Adding: #{song.path}"
+          # Read metadata from song tags
           song.read_tags!
+          # Save song to the database
           $db.save_song song
+          # Increment progress bar
           dialog.fraction += inc
+          # Make sure that the GUI is updated
           Kelp.process_events
+          # Stop adding songs if process is cancelled by the user
           break if cancelled
         end
+        
+        # Remove old entries from database
         dialog.message = "Cleaning out old entries..."
         dialog.pulse
         $db.clean
+
+        # Destroy progress dialog
         dialog.destroy
 
         # Clean up
         new_songs = dialog = nil
       end
 
+      # Load small 16x16 pixel Shroom logo
       icon = Gdk::Pixbuf.new Global.locate('icon_16x16.png')
 
+      # Create main window
       @window = Window.new "Shroom"
       @window.icon = icon
       @window.resize 800, 600
+      # Call 'quit' method when window is destroyed
       @window.signal_connect('destroy') do
         quit
       end
-      
+
+      # Create the status icon which appears in the system tray
       @status_icon = StatusIcon.new
       @status_icon.pixbuf = icon
       @status_icon.visible = true
+      # Callback for when status icon is clicked
       @status_icon.signal_connect('activate') do |widget|
+        # Toggle visibility of window
         @window.visible = !@window.visible?
       end
 
       content_pane = VBox.new(false, 0)
       @window.add content_pane
 
+      # Create and add menu bar to the window
       content_pane.pack_start(create_menu, false, true, 0)
 
       vpaned = VBox.new
       content_pane.add vpaned
 
-      # Controls
+      # === Playback Controls ===
       vbox = VBox.new false, 0
       vpaned.pack_start vbox, false, true, 8
       hbox = HBox.new
       lbl_song = Label.new
       hbox.add lbl_song
-      lbl_time = Label.new(time_to_s(0) + "/" + time_to_s(0))
+      lbl_time = Label.new(format_seconds(0) + "/" + format_seconds(0))
       hbox.pack_start lbl_time, false, false, 8
       vbox.pack_start hbox, false, false, 8
       box_controls = HBox.new
@@ -119,11 +145,11 @@ module Sh
         if @player
           pos = @player.position.to_f
           seeker.value = pos / @player.duration
-          lbl_time.text = time_to_s(pos) + "/" + time_to_s(@player.duration)
+          lbl_time.text = format_seconds(pos) + "/" + format_seconds(@player.duration)
           lbl_song.set_markup @player.song.to_html
         else
           seeker.value = 0
-          lbl_time.text = time_to_s(0) + "/" + time_to_s(0)
+          lbl_time.text = format_seconds(0) + "/" + format_seconds(0)
           lbl_song.set_markup "<b>Not playing</b>"
         end
         true
@@ -150,7 +176,7 @@ module Sh
       frm_content = Frame.new
       hpaned.add2 frm_content
 
-      # Sidebar
+      # === Sidebar ===
       sw = ScrolledWindow.new(nil, nil)
       hpaned.add1 sw
       sw.set_policy(POLICY_AUTOMATIC, POLICY_NEVER)
@@ -207,7 +233,7 @@ module Sh
         i += 1
       end
 
-      # Multimedia keys
+      # === Multimedia Keys ===
       MMKeys.new do |key|
         case key
         when 'Stop'
@@ -245,6 +271,7 @@ module Sh
         ['/File/sep1', '<Separator>', nil, nil, lambda {}],
         ['/File/Quit', '<StockItem>', '<control>Q', Stock::QUIT, lambda {Gtk.main_quit}],
         ['/_Edit'],
+        ['/Edit/Plugins...', '<StockItem>', nil, Stock::DISCONNECT, lambda {show_plugins}],
         ['/Edit/Preferences...', '<StockItem>', nil, Stock::PREFERENCES, lambda {show_preferences}],
         ['/_Help'],
         ['/Help/About', '<StockItem>', nil, Stock::ABOUT, lambda {show_about}]
@@ -272,26 +299,85 @@ module Sh
       dialog.destroy
     end
 
+    def show_plugins
+      glade = Global::GLADE['dlg_plugins']
+      dlg_plugins = glade['dlg_plugins']
+      dlg_plugins.width_request = 450
+      dlg_plugins.height_request = 300
+      dlg_plugins.signal_connect('delete-event') do
+        dlg_plugins.hide
+      end
+
+      btn_ok = glade['btn_ok']
+      btn_ok.signal_connect('clicked') do |w|
+        dlg_plugins.hide
+      end
+      
+      lbl_name = glade['lbl_name']
+      lbl_version = glade['lbl_version']
+      txt_description = glade['txt_description']
+      btn_preferences = glade['btn_preferences']
+
+      lst_plugins = glade['lst_plugins']
+      sto_plugins = lst_plugins.model
+      if sto_plugins
+        sto_plugins.clear
+      else
+        sto_plugins = lst_plugins.model = ListStore.new(Object, Plugin)
+        ren_enabled = CellRendererToggle.new
+        col_enabled = TreeViewColumn.new('Enabled',
+          ren_enabled,
+          'active' => 0)
+        lst_plugins.append_column col_enabled
+
+        ren_plugin = CellRendererText.new
+        col_plugin = TreeViewColumn.new('Plugin', ren_plugin)
+        col_plugin.set_cell_data_func(ren_plugin) do |tvc, cell, model, iter|
+          cell.text = iter[1].name
+        end
+        lst_plugins.append_column col_plugin
+
+        lst_plugins.selection.signal_connect('changed') do |selection|
+          if selection.selected
+            plugin = selection.selected[1]
+            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
+          end
+        end
+      end
+
+      Plugin.registered_plugins.each do |name, plugin|
+        iter = sto_plugins.append
+        iter[0] = true
+        iter[1] = plugin
+        lst_plugins.selection.select_iter iter if lst_plugins.selection.count_selected_rows == 0
+      end
+
+      dlg_plugins.run
+    end
+
     def show_preferences
-      glade = Sh::Global::GLADE['dlg_preferences']
+      glade = Global::GLADE['dlg_preferences']
       dlg_prefs = glade['dlg_preferences']
       dlg_prefs.signal_connect('delete-event') do
         dlg_prefs.hide
       end
       fbtn_library = glade['fbtn_library']
-      fbtn_library.current_folder = $prefs[:library_dir]
+      fbtn_library.current_folder = Global.prefs[:library_dir]
       chk_lastfm = glade['chk_lastfm']
-      chk_lastfm.active = $prefs[:lastfm]
+      chk_lastfm.active = Global.prefs[:lastfm]
       txt_lastfm_user = glade['txt_lastfm_user']
-      txt_lastfm_user.text = $prefs[:lastfm_user]
+      txt_lastfm_user.text = Global.prefs[:lastfm_user]
       txt_lastfm_pass = glade['txt_lastfm_pass']
-      txt_lastfm_pass.text = $prefs[:lastfm_password]
+      txt_lastfm_pass.text = Global.prefs[:lastfm_password]
       btn_ok = glade['btn_ok']
       ok_handle = btn_ok.signal_connect('clicked') do
-        $prefs[:library_dir] = fbtn_library.filename
-        $prefs[:lastfm] = chk_lastfm.active?
-        $prefs[:lastfm_user] = txt_lastfm_user.text
-        $prefs[:lastfm_password] = txt_lastfm_pass.text
+        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
@@ -318,7 +404,7 @@ module Sh
     end
 
     def prepare_song
-      @player.demolish if @player
+      @player.demolish! if @player
       @player = Sh::Player.new @queue[@queue_pos]
       @player.on_finished do |player|
         next_song
@@ -327,15 +413,8 @@ module Sh
     end
 
     # Format time (in seconds) as mins:secs
-    def time_to_s(time)
-      mins_float = time.to_f / 60
-      mins = mins_float.floor
-      secs = ((mins_float - mins) * 60).round
-      if secs == 60
-        mins += 1
-        secs = 0
-      end
-      "#{mins}:#{sprintf('%.2d', secs)}"
+    def format_seconds(time)
+      return "%i:%02d" % [time / 60, time % 60 ]
     end
 
     def on_song_changed
@@ -349,12 +428,11 @@ module Sh
           @note = Notify::Notification.new(song.title || 'Unknown track', msg, nil, @status_icon)
         end
         # Cover art
-        if $prefs[:cover_art]
+        if Global.prefs[:cover_art]
           @pixbuf = nil
           begin
-            if File.exists? song.album.image_path
-              @pixbuf = Gdk::Pixbuf.new(song.album.image_path)
-            end
+            image_path = song.album.image_path
+            @pixbuf = Gdk::Pixbuf.new(image_path) unless File.empty? image_path
           rescue
             @pixbuf = nil
           end
@@ -362,7 +440,7 @@ module Sh
             @note.pixbuf_icon = @pixbuf.scale(48, 48) if @rnotify
             @img_cover.pixbuf = @pixbuf.scale(132, 132)
           else
-            @img_cover.pixbuf = nil
+            @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)
               $db.save_song song
@@ -383,7 +461,7 @@ module Sh
           end
         end
         # Lyrics
-        if $prefs[:lyrics]
+        if Global.prefs[:lyrics]
           @html_lyrics.set_html 'Loading...'
           Thread.new do
             if not song.lyrics
@@ -408,6 +486,8 @@ module Sh
 
     def show_lyrics song
       lyrics = song.lyrics || "[Lyrics not found]"
+      # Stupid character encoding stuff
+      lyrics = lyrics.unpack('U*').pack('C*')
       @html_lyrics.set_html do
         %{
         <h2>#{song.title}</h2>
@@ -439,7 +519,6 @@ module Sh
     end
 
     def queue_pos=(pos)
-      puts pos
       @queue_pos = pos
       prepare_song
     end