shroom 0.0.9 → 0.0.10

data/lib/sh_database.rb

@@ -7,7 +7,7 @@ require 'sh_artist'
 module Sh
   class Database
     def initialize
-      @db = Sequel.sqlite("#{$config_dir}/songs.db")
+      @db = Sequel.sqlite(Sh::Global::PATHS[:db_file])
 
       @db.create_table :artists do
         primary_key :id
@@ -117,7 +117,7 @@ module Sh
 
         return row_song
       rescue
-        puts "Couldn's save song in database: " + song.path
+        Sh::Log.warning "Couldn't save #{song.path} to database", $!
         return
       end
     end
@@ -163,7 +163,7 @@ module Sh
       @db[:songs].each do |hash|
         path = hash[:path]
         unless File.exists? path
-          puts "Removing: #{path}"
+          Sh::Log.debug "Removing #{path} from database"
           @db[:songs].filter(:path => path).delete
         end
       end
@@ -204,4 +204,4 @@ module Sh
       return artist
     end
   end
-end
+end

data/lib/sh_global.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'yaml'
 require 'libglade2'
 require 'ping'
+require 'gtk2'
 require 'sh_plugin'
 
 module Sh
@@ -13,31 +14,44 @@ module Sh
   class Global
     SUPPORTED_EXTENSIONS = ['.mp3', '.m4a', '.ogg', '.flac', '.wma', '.wav']
     GLADE = {}
+    PATHS = {}
 
     def self.init
-      # Won't work on Windows
-      $home = ENV['HOME']
-      $config_dir = "#{$home}/.shroom"
-      FileUtils.mkdir $config_dir unless File.exists? $config_dir
-      $cover_dir = "#{$config_dir}/covers"
-      FileUtils.mkdir $cover_dir unless File.exists? $cover_dir
-      @@prefs_file = "#{$config_dir}/preferences.yml"
+    	# Setup some commonly used directories
+      PATHS[:home_dir] = home_dir = GLib.home_dir
+      PATHS[:config_dir] = config_dir = "#{home_dir}/.shroom"
+      FileUtils.mkdir config_dir unless File.exists? config_dir
+      PATHS[:cover_dir] = cover_dir = "#{config_dir}/covers"
+      FileUtils.mkdir cover_dir unless File.exists? cover_dir
+      # Store paths to relevant Shroom files
+      PATHS[:prefs_file] = "#{config_dir}/preferences.yml"
+      PATHS[:plugin_prefs_file] = "#{config_dir}/plugin_prefs.yml"
+      PATHS[:db_file] = "#{config_dir}/songs.db"
+      PATHS[:log_file] = log_file = "#{config_dir}/shroom.log"
+      PATHS[:playlists_file] = "#{config_dir}/playlists.yml"
 
+			# Set default preferences
       @@prefs = {
-        :library_dir => "#{$home}/Music",
+        :library_dir => "#{home_dir}/Music",
         :cover_art => true,
-        :lyrics => true,
-        :lastfm => false,
-        :lastfm_user => nil,
-        :lastfm_password => nil,
+        :lyrics => true
       }
+      
+      # Load saved preferences
+      load_prefs
+      
+      # Set log outputs
+      Sh::Log.add_output_stream :stdout
+      Sh::Log.add_output_stream open(log_file, "w")
 
+			# Parse Glade interface
       add_toplevel_glade('dlg_preferences')
       add_toplevel_glade('dlg_song')
       add_toplevel_glade('dlg_plugins')
       GLADE.freeze
 
-      load_prefs
+			# Initialize plugins
+      Plugin.init
       load_plugins
     end
 
@@ -49,30 +63,32 @@ module Sh
       return @@prefs
     end
 
+		# Set current preferences to those in the preferences file
     def self.load_prefs
-      if File.exists?(@@prefs_file)
-        prefs = YAML::load(File.read(@@prefs_file))
+      if File.exists?(PATHS[:prefs_file])
+        prefs = YAML::load(File.read(PATHS[:prefs_file]))
         prefs.each do |k, v|
           @@prefs[k] = v
         end
       end
     end
-
+		
+		# Store current preferences in the preferences file
     def self.save_prefs
-      File.open(@@prefs_file, 'w') do |f|
+      File.open(PATHS[:prefs_file], 'w') do |f|
         f.write @@prefs.to_yaml
       end
     end
-
+		
+		# Search for Shroom plugins and load them
     def self.load_plugins
-      plugin_dirs = ["#{self.locate("plugins")}", "#{$config_dir}/.plugins"]
+      plugin_dirs = ["#{self.locate("plugins")}", "#{PATHS[: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 $!
+          	Sh::Log.warning "Error loading plugin \"#{rb_file}\"", $!
           end
         end
       end
@@ -80,9 +96,10 @@ module Sh
 
     private
     def self.add_toplevel_glade name
+    	# Parse and store toplevel window from Glade file
       GLADE[name] = GladeXML.new(Global.locate('shroom.glade'), name)
     end
 
     init()
   end
-end
+end

data/lib/sh_log.rb

@@ -0,0 +1,78 @@
+module Sh
+	class Log
+		class Broadcaster
+			def initialize type
+				@type = type
+			end
+			
+			def write str
+				@buffer ||= ''
+				@buffer << str
+				if @buffer.end_with? "\n"
+					case @type
+					when :stderr
+						Log.error '> ' + @buffer
+					when :stdout
+						Log.info '> ' + @buffer
+					end
+					@buffer = nil
+				end
+			end
+			
+			def puts str
+				write str + "\n"
+			end
+		end
+		
+		LEVELS = [:debug, :info, :warning, :error]
+		@@output_streams = []
+		@@stdout = $stdout
+		@@stderr = $stderr
+		$stdout = Broadcaster.new :stdout
+		$stderr = Broadcaster.new :stderr
+		
+		def self.add_output_stream stream, level=:debug
+			case stream
+			when :stdout
+				stream = @@stdout
+			when :stderr
+				stream = @@stderr
+			end
+			@@output_streams << [stream, level]
+		end
+		
+		def self.debug(message, error=nil)
+			log message, :debug, error
+		end
+		
+		def self.info(message, error=nil)
+			log message, :info, error
+		end
+		
+		def self.warning(message, error=nil)
+			log message, :warning, error
+		end
+		
+		def self.error(message, error=nil)
+			log message, :error, error
+		end
+		
+		private
+		def self.log(message, type=:info, error=nil)
+			string = "[#{type.to_s.upcase}]"
+			string << " " * (10 - string.length)
+			string << message
+			if error
+				string << '> '
+				string << error
+			end
+			time = Time.now.to_a.reverse[-3..-1].collect {|e| "%.2d" % e}
+			@@output_streams.each do |stream, level|
+				if LEVELS.index(type) >= LEVELS.index(level)
+			  	stream.puts "(#{time.join ':'}) #{string}"
+			  	stream.flush
+			  end
+			end
+		end
+	end
+end

data/lib/sh_lyrics.rb

@@ -1,68 +1,15 @@
-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
       lyrics = nil
       if artist and title
-        url = "http://lyrical.heroku.com/api?format=plain"
-        url << "&artist=#{CGI.escape(artist)}"
-        url << "&song=#{CGI.escape(title)}"
-        lyrics = open(url).read
+        @lyrical_rest ||= Rest::Get.new("http://lyrical.heroku.com/api", :format => 'plain')
+        lyrics = @lyrical_rest[:artist => artist, :song => title]
         lyrics = nil if lyrics.empty?
       end
       return lyrics
     end
-
-#    class LyricsWiki
-#      def LyricsWiki.get_lyrics(artist, title)
-#        lyrics = nil
-#        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[1..-1]
-#          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
-#    end
   end
 end
 

data/lib/sh_main.rb

@@ -1,11 +1,10 @@
 #!/usr/bin/ruby
 
-# Note to self (Mercurial push URL):
-# http://dismal_denizen@bitbucket.org/dismal_denizen/shroom/
-
 require 'socket'
+require 'rubygems'
 
 require 'sh_util'
+require 'sh_log'
 require 'sh_global'
 require 'sh_song'
 require 'sh_database'
@@ -15,6 +14,8 @@ require 'sh_view'
 module Sh
   class Main
     def initialize
+    	Sh::Log.info 'Shroom started'
+
       # Load the database
       $db = Sh::Database.new
       
@@ -23,12 +24,15 @@ module Sh
         Sh::View.new.show
       end
 
-      puts 'Saving preferences...'
+      Sh::Log.debug 'Saving preferences...'
       Sh::Global.save_prefs
-      puts 'Bye!'
+      Sh::Log.debug 'Global preferences saved'
+      Plugin.save_prefs
+      Sh::Log.debug 'Plugin preferences saved'
+      Sh::Log.info 'Shroom quit'
     end
   end
 end
 
 # Get the show started if Shroom is run as a standalone application
-Sh::Main.new if $0 == __FILE__
+Sh::Main.new if $0 == __FILE__

data/lib/sh_player.rb

@@ -1,6 +1,4 @@
 require 'wx'
-require 'rubygems'
-require 'scrobbler'
 require 'sh_plugin'
 
 # I believe that a small explanation is in order. You may be wondering why Wx
@@ -127,7 +125,7 @@ module Sh
     # Load a media file into the MediaCtrl
     def load_file(path)
       unless @mc.load(path)
-        puts "Unable to load file into MediaCtrl"
+      	Sh::Log.warning "Unable to load #{path} into MediaCtrl"
         on_media_finished nil
       end
     end
@@ -169,7 +167,7 @@ module Sh
     # Start the playback
     def play
       unless @mc.play
-        puts "Unable to play media with MediaCtrl"
+        Sh::Log.warning "Unable to play song with MediaCtrl"
         on_media_finished nil
       end
     end

data/lib/sh_playlist.rb

@@ -1,23 +1,26 @@
 module Sh
   class Playlist
-    def initialize dir
-      @dir = dir
+  	attr_accessor :name
+  	
+    def initialize name
+    	@name = name
       @songs = []
     end
 
-    def Playlist.parse(path)
-      list = Playlist.new(File.dirname(path))
+    def self.parse(path)
+      list = Playlist.new path.match(/\/([^\/]*)$/).captures.last
       open(path) do |f|
         while line = f.gets
           line.strip!
           unless line[0] == ?# or line.empty?
+          	# TODO: make cross-platform
             ref = File.expand_path(line.gsub('\\', '/'), File.dirname(path))
             if File.exists? ref
               if Sh::Global::SUPPORTED_EXTENSIONS.include? File.extname(ref)
                 list << ($db.songs(:path => ref).first || Sh::Song.new(ref).read_tags!)
               end
             else
-              puts "Not found: " + ref
+              Sh::Log.info "File at #{ref} not found"
             end
           end
         end
@@ -32,5 +35,87 @@ module Sh
     def songs
       return @songs.dup
     end
+    
+    def save!
+    	path = Sh::Global::PATHS[:playlists_file]
+    	playlists = []
+    	if File.exists? path
+    		playlists = YAML.load_file path
+    	end
+    	playlists.reject! {|name, paths| name == @name}
+    	song_paths = @songs.map {|song| song.path}
+    	playlists << [@name, song_paths]
+    	open(path, 'w') {|f| f.puts playlists.to_yaml}
+    end
+  end
+  
+  class Playlists
+    def initialize view
+      @tree = TreeView.new
+      @tree.selection.mode = Gtk::SELECTION_MULTIPLE
+
+      renderer = CellRendererText.new
+      column = TreeViewColumn.new('Playlists',
+        renderer,
+        'text' => 0)
+      @tree.append_column column
+
+      @model = TreeStore.new(String, Array)
+      @tree.model = @model
+
+      @tree.signal_connect('row_activated') do |widget, path, col|
+        iter = @tree.model.get_iter(path)
+    		view.stop
+        view.queue = iter[1].dup
+        view.play
+      end
+
+      @scroll = ScrolledWindow.new(nil, nil)
+      @scroll.set_policy(POLICY_AUTOMATIC, POLICY_AUTOMATIC)
+      @scroll.add @tree
+    end
+    
+    def self.load_playlists
+    	playlists = []
+    	if File.exists? Sh::Global::PATHS[:playlists_file]
+    		arr = YAML.load_file Sh::Global::PATHS[:playlists_file]
+		  	arr.sort_by {|a| (a.first || '')}.each do |name, paths|
+		      playlist = Playlist.new name
+		      paths.each do |path|
+		      	if File.exists? path
+		          if Sh::Global::SUPPORTED_EXTENSIONS.include? File.extname(path)
+		            song = ($db.songs(:path => path).first || Sh::Song.new(path).read_tags!)
+		      			playlist << song
+		          end
+		        else
+		          Sh::Log.info "File at #{ref} not found"
+		        end
+		      end
+		      playlists << playlist
+		    end
+      end
+      return playlists
+    end
+
+    def fill_model
+    	@model.clear
+      Playlists.load_playlists.each do |playlist|
+        parent_node = @model.append nil
+        parent_node[0] = playlist.name
+        parent_node[1] = []
+        playlist.songs.each do |song|
+        	node = @model.append parent_node
+    			node[0] = song.title
+    			node[1] = [song]
+    			parent_node[1] << song
+        end
+        Kelp.process_events
+      end
+    end
+
+    def widget
+    	fill_model
+      return @scroll
+    end
   end
-end
+end