zik 0.16.1

data/mod/hotkeys/configwidget.rb

@@ -0,0 +1,93 @@
+# encoding: UTF-8
+=begin
+Copyright 2007-2011 Vincent Carmona
+vinc4mai@gmail.com
+
+This file is part of ZiK.
+
+    ZiK is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    ZiK is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with ZiK; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+module Hotkeys
+class ConfigWidget < Gtk::Table
+	attr_reader :eprev, :estop, :eplay, :enext, :bcprev, :bsprev, :baprev, :bcstop, :bsstop, :bastop,
+		:bcplay, :bsplay, :baplay, :bcnext, :bsnext, :banext
+
+	def initialize(config)
+		@lprev=Gtk::Label.new(_("Previous:\t"))
+		@bcprev=Gtk::CheckButton.new('Ctrl')
+		@bcprev.active=config[:prev_mask]&GlobalHotKeys::Modifier::CONTROL_MASK==GlobalHotKeys::Modifier::CONTROL_MASK
+		@bsprev=Gtk::CheckButton.new('Shift')
+		@bsprev.active=config[:prev_mask]&GlobalHotKeys::Modifier::SHIFT_MASK==GlobalHotKeys::Modifier::SHIFT_MASK
+		@baprev=Gtk::CheckButton.new('Alt')
+		@baprev.active=config[:prev_mask]&GlobalHotKeys::Modifier::MOD1_MASK==GlobalHotKeys::Modifier::MOD1_MASK
+		@eprev=Gtk::Entry.new
+		@eprev.text=config[:prev_key]
+
+		@lstop=Gtk::Label.new(_("Stop:\t"))
+		@bcstop=Gtk::CheckButton.new('Ctrl')
+		@bcstop.active=config[:stop_mask]&GlobalHotKeys::Modifier::CONTROL_MASK==GlobalHotKeys::Modifier::CONTROL_MASK
+		@bsstop=Gtk::CheckButton.new('Shift')
+		@bsstop.active=config[:stop_mask]&GlobalHotKeys::Modifier::SHIFT_MASK==GlobalHotKeys::Modifier::SHIFT_MASK
+		@bastop=Gtk::CheckButton.new('Alt')
+		@bastop.active=config[:stop_mask]&GlobalHotKeys::Modifier::MOD1_MASK==GlobalHotKeys::Modifier::MOD1_MASK
+		@estop=Gtk::Entry.new
+		@estop.text=config[:stop_key]
+
+		@lplay=Gtk::Label.new(_("Play/pause:\t"))
+		@bcplay=Gtk::CheckButton.new('Ctrl')
+		@bcplay.active=config[:play_mask]&GlobalHotKeys::Modifier::CONTROL_MASK==GlobalHotKeys::Modifier::CONTROL_MASK
+		@bsplay=Gtk::CheckButton.new('Shift')
+		@bsplay.active=config[:play_mask]&GlobalHotKeys::Modifier::SHIFT_MASK==GlobalHotKeys::Modifier::SHIFT_MASK
+		@baplay=Gtk::CheckButton.new('Alt')
+		@baplay.active=config[:play_mask]&GlobalHotKeys::Modifier::MOD1_MASK==GlobalHotKeys::Modifier::MOD1_MASK
+		@eplay=Gtk::Entry.new
+		@eplay.text=config[:play_key]
+
+		@lnext=Gtk::Label.new(_("Next:\t"))
+		@bcnext=Gtk::CheckButton.new('Ctrl')
+		@bcnext.active=config[:next_mask]&GlobalHotKeys::Modifier::CONTROL_MASK==GlobalHotKeys::Modifier::CONTROL_MASK
+		@bsnext=Gtk::CheckButton.new('Shift')
+		@bsnext.active=config[:next_mask]&GlobalHotKeys::Modifier::SHIFT_MASK==GlobalHotKeys::Modifier::SHIFT_MASK
+		@banext=Gtk::CheckButton.new('Alt')
+		@banext.active=config[:next_mask]&GlobalHotKeys::Modifier::MOD1_MASK==GlobalHotKeys::Modifier::MOD1_MASK
+		@enext=Gtk::Entry.new
+		@enext.text=config[:next_key]
+
+		super(4, 5)
+		#self.column_spacings=$border
+		self.attach(@lprev, 0, 1, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+		self.attach(@bcprev, 1, 2, 0, 1)
+		self.attach(@bsprev, 2, 3, 0, 1)
+		self.attach(@baprev, 3, 4, 0, 1)
+		self.attach(@eprev, 4, 5, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+		self.attach(@lstop, 0, 1, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+		self.attach(@bcstop, 1, 2, 1, 2)
+		self.attach(@bsstop, 2, 3, 1, 2)
+		self.attach(@bastop, 3, 4, 1, 2)
+		self.attach(@estop, 4, 5, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+		self.attach(@lplay, 0, 1, 2, 3, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+		self.attach(@bcplay, 1, 2, 2, 3)
+		self.attach(@bsplay, 2, 3, 2, 3)
+		self.attach(@baplay, 3, 4, 2, 3)
+		self.attach(@eplay, 4, 5, 2, 3, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+		self.attach(@lnext, 0, 1, 3, 4, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+		self.attach(@bcnext, 1, 2, 3, 4)
+		self.attach(@bsnext, 2, 3, 3, 4)
+		self.attach(@banext, 3, 4, 3, 4)
+		self.attach(@enext, 4, 5, 3, 4, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, $border)
+	end
+end
+end

data/mod/interact.rb

@@ -0,0 +1,131 @@
+# encoding: UTF-8
+=begin
+Copyright 2007-2010 Vincent Carmona
+vinc4mai@gmail.com
+
+This file is part of ZiK.
+
+    ZiK is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    ZiK is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with ZiK; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+module Interact
+	Menu,LocalMenu=[], []
+	Arg, LocalArg=[], []
+	def self.menu_const_set(name, val, lval)
+		Menu.push(const_set(name, val))#Is it ok to push an object on a constant (not frozen) array ?
+		LocalMenu.push(const_set("LOCAL_"+name, lval))
+	end
+
+	def self.arg_const_set(name, val, lval)
+		Arg.push(const_set(name, val))
+		LocalArg.push(const_set("LOCAL_"+name, lval))
+	end
+
+	menu_const_set "MENU", "Menu", _("Menu")
+
+	arg_const_set "NONE", "None", _("None")
+	arg_const_set "PLAYLIST_FILES", "Playlit files", _("Playlit files")
+	arg_const_set "CURRENT_SONG", "Current Song", _("Current song")
+	arg_const_set "CURRENT_SONG_NAME", "Current song name", _("Current song name")
+
+	def Interact.mod
+		@m||=Mod.new('interact', "Interact", _("Add menu entries to interact with ZiK."),
+			'Vincent Carmona  <vinc4mai@gmail.com>', 'GPL-2')
+	end
+
+	Interact.mod
+	def @m.init(input)
+		@dir=input[:mod_dir]
+		require File.join(@dir, 'interact', 'interaction')
+		require File.join(@dir, 'interact', 'configwidget')
+		@interactions=Interaction.read(input[:config_dir])
+		@destroy_on_unload=[]
+	end
+
+	def @m.load
+		unless @loaded
+			@interactions.each{|interaction|
+				case interaction[:menu]
+				when MENU
+					it=Gtk::MenuItem.new(interaction[:name])
+					it.signal_connect('activate'){
+						arg=resolve_argument(interaction[:argument])
+						c=interaction[:command].split(' ')
+						t=[*c]+[*arg]
+						Thread.new{system(*t)}
+					}
+					menu_add(it.show)
+					@destroy_on_unload.push(it)
+				else
+					ModErrorError.new(self,
+						_("Cannot create interactions named #{interaction[:name]}(unknow menu type)."), true)
+				end
+			}
+			@loaded=true
+		else
+			false
+		end
+	end
+
+	def @m.unload
+		if @loaded
+			@destroy_on_unload.each{|w| w.destroy}
+			@destroy_on_unload.clear
+			menu_hide
+			@loaded=false
+			true
+		else
+			false
+		end
+	end
+
+	def @m.configwidget
+		@wconfig=ConfigWidget.new(@interactions)
+	end
+
+	def @m.saveconfig
+		old_interactions=@interactions
+		@interactions=@wconfig.interactions
+		reload if @loaded
+	end
+
+	def @m.quit
+		Interaction.write(@interactions)
+	end
+
+private
+
+	def @m.reload
+		unload
+		self.load
+	end
+
+	def @m.resolve_argument(type)
+		#escape=/[\ \'\#\[\]\(\)\&\;\|\!]/; String#gsub(escape){|s| '\\'+s}
+		case type
+		when NONE
+			""
+		when PLAYLIST_FILES
+			list=zik.playlist
+			list.songs.map{|song| song.path}
+		when CURRENT_SONG
+			list=zik.playlist
+			list.songs[list.current].path
+		when CURRENT_SONG_NAME
+			list=zik.playlist
+			list.songs[list.current].name
+		end
+	end
+end

data/mod/interact/configwidget.rb

@@ -0,0 +1,107 @@
+# encoding: UTF-8
+=begin
+Copyright 2007-2010 Vincent Carmona
+vinc4mai@gmail.com
+
+This file is part of ZiK.
+
+    ZiK is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    ZiK is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with ZiK; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+module Interact
+class InteractionWidget
+	attr_reader :menu, :name, :command, :argument, :rm
+
+	def initialize(interaction=nil)
+		@removed=false
+		if interaction
+			menu=Menu.index(interaction[:menu])
+			name=interaction[:name]
+			command=interaction[:command]
+			arg=Arg.index(interaction[:argument])
+			sensitive=true
+		end
+		menu||=-1
+		name||=""
+		command||=""
+		arg||=0
+		sensitive||=false
+
+		@menu=Gtk::ComboBox.new
+		@menu.append_text(LOCAL_MENU)
+		@menu.active=menu
+		@menu.signal_connect('changed'){
+			sensitive=@menu.active>=0
+			[@name, @command, @argument].each{|w| w.sensitive=sensitive}
+		}
+		@name=Gtk::Entry.new
+		@name.text=name
+		@command=Gtk::Entry.new
+		@command.text=command
+		@argument=Gtk::ComboBox.new
+		LocalArg.each{|c| @argument.append_text(c)}
+		@argument.active=arg
+		@rm=Gtk::Button.new
+		@rm.image=Gtk::Image.new(Gtk::Stock::REMOVE, Gtk::IconSize::BUTTON)
+		@rm.signal_connect('clicked'){
+			[@menu, @name, @command, @argument, @rm].each{|w| w.hide}
+			@removed=true
+		}
+		[@menu, @name, @command, @argument, @rm].each{|w| w.show}
+		[@name, @command, @argument].each{|w| w.sensitive=sensitive} unless sensitive
+	end
+
+	def to_h
+		if @removed||@menu.active<0
+			{}
+		else
+			{:menu=>Menu[LocalMenu.index(@menu.active_text)], :name=>@name.text,
+				:command=>@command.text, :argument=>Arg[LocalArg.index(@argument.active_text)]}
+		end
+	end
+end
+
+class ConfigWidget  < Gtk::Table
+	def initialize(interactions)
+		@iwidgets=[]; @nb=0
+		badd=Gtk::Button.new
+		badd.image=Gtk::Image.new(Gtk::Stock::ADD, Gtk::IconSize::BUTTON)
+		badd.signal_connect('clicked'){add_interaction}
+		super(interactions.length+1, 5)
+		self.attach(badd, 0, 5, 0, 1)
+		self.attach(Gtk::Label.new(_("Menu")), 0, 1, 1, 2)
+		self.attach(Gtk::Label.new(_("Name")), 1, 2, 1, 2)
+		self.attach(Gtk::Label.new(_("Command")), 2, 3, 1, 2)
+		self.attach(Gtk::Label.new(_("Argument")), 3, 4, 1, 2)
+		interactions.each_with_index{|interact, i| add_interaction(interact)}
+	end
+
+	def add_interaction(interaction=nil)
+		@iwidgets.push(iwidget=InteractionWidget.new(interaction))
+		self.attach(iwidget.menu, 0, 1, @nb+2, @nb+3)
+		self.attach(iwidget.name, 1, 2, @nb+2, @nb+3)
+		self.attach(iwidget.command, 2, 3, @nb+2, @nb+3)
+		self.attach(iwidget.argument, 3, 4, @nb+2, @nb+3)
+		self.attach(iwidget.rm, 4, 5, @nb+2, @nb+3)
+		@nb+=1
+	end
+
+	def interactions
+		tmp=@iwidgets.map{|w| w.to_h}
+		tmp.reject!{|h| h.empty?||h[:name].empty?||h[:command].empty?}
+		tmp.map{|h| Interaction.new(h)}
+	end
+end
+end

data/mod/interact/interaction.rb

@@ -0,0 +1,79 @@
+# encoding: UTF-8
+=begin
+Copyright 2007-2010 Vincent Carmona
+vinc4mai@gmail.com
+
+This file is part of ZiK.
+
+    ZiK is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    ZiK is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with ZiK; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+module Interact
+class Interaction < Hash
+	def Interaction.read(dir)
+		@file=File.join(dir,'interactionrc')
+		if File.exist?(@file)
+			begin
+				f=File.open(@file,'r')
+				interactions=f.read.split("\n\n").map!{|i| i.split("\n").reject{|a| a =~ /^#/}.reject{|a| a =~ /^\n/}}
+				interactions.map!{|i| Interaction.from_a(i)}
+				interactions.reject!{|i| i.empty?}
+			rescue
+				interactions=[]
+				ModErrorError.new(Interact.mod, "reading configuration file.")
+			ensure
+				f.close if f
+			end
+		else
+			ModErrorError.new(Interact.mod, "Configuration file not found.")
+		end
+		interactions||[]
+	end
+
+	def Interaction.write(interactions)
+		if $write_config
+			begin
+				dir=File.dirname(@file)
+				Dir.mkdir(dir) unless File.exist?(dir)
+				f=File.open(@file,'w')
+				f.puts '##Configuration file for interact module (ZiK audio player).'
+				interactions.each{|i|
+					i.each_pair{|key, value| f.puts "#{key}=#{value}"}
+					f.puts ""
+				}
+				ModErrorInfo.new(Interact.mod, "configuration saved")
+			rescue
+				ModErrorError.new(Interact.mod, "writting configuration file.")
+			ensure
+				f.close if f
+			end
+		end
+	end
+
+	def Interaction.from_a(a)
+		i=Interaction.new
+		a.each{|l|
+			k, v=l.split('=', 2)
+			i[k.to_sym]=v
+		}
+		i
+	end
+
+	def initialize(hash=nil)
+		super()
+		self.merge!(hash) if hash
+	end
+end
+end

data/mod/notify.rb

@@ -0,0 +1,128 @@
+# encoding: UTF-8
+=begin
+Copyright 2007-2011 Vincent Carmona
+vinc4mai@gmail.com
+
+This file is part of ZiK.
+
+    ZiK is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    ZiK is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with ZiK; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+module Notify
+	def Notify.mod
+		@m||=Mod.new('notify', "Notify", _("Display a notification when playing a new song."),
+		'Vincent Carmona <vinc4mai@gmail.com>', 'GPL-2')
+	end
+
+	Notify.mod
+	def @m.init(input)
+		@dir=input[:mod_dir]
+		@zik=zik
+		@pix_dir=input[:pix_dir]
+		require File.join(@dir, 'notify', 'config')
+		@config=Configuration.new(input[:config_dir])
+		require File.join(@dir, 'notify', 'configwidget')
+	end
+
+	def @m.load
+		unless @loaded
+			require File.join(@dir, 'notify', 'window')
+			begin
+				Notify.init($name) if require 'RNotify'
+				@icon=File.join(@pix_dir,'ZiK.svg')
+				@rnotify=true
+			rescue LoadError
+				@rnotify=false
+				ModErrorLoadError.new(self,
+					_("Cannot use system notification. Please install ruby-libnotify."))
+			end
+			@zik.signal_connect('play'){|widget, song|
+				if @loaded
+					if @config[:native]
+						@window||=Notify::Window.new(@config)
+						@window.label.set_markup("\n"+'<span foreground="'+@config[:fg]+'"> '+song.name.gsub('&','&amp;')+' </span>'+"\n")#GLib::Markup.escape_text is not yet implemented
+						@window.resize(1, 1)
+						size=@window.size
+						@window.move(Gdk.screen_width-size[0]-10, 30)
+						@window.show
+						GLib::Timeout.add(@config[:time]*1000){@window.hide; false}
+					else
+						if @rnotify
+							if @notification
+								@notification.update(_('Playing'), song.name, @icon)
+							else
+								@notification=Notify::Notification.new(_('Playing'), song.name, @icon, nil)
+							end
+							@notification.timeout=(@config[:time]*1000).to_i
+							@notification.show
+						else
+							ModErrorError.new(self, "RNotify is not loaded.")
+						end
+					end
+				end
+			}
+			ModErrorInfo.new(self, "module loaded.")
+			@loaded=true
+		else
+			false
+		end
+	end
+
+	def @m.unload
+		if @loaded
+			@window.destroy if @window
+			if @rnotify
+				@notification.close if @notification
+			end
+			ModErrorInfo.new(self, "module unloaded.")
+			@loaded=false
+			true
+		else
+			false
+		end
+	end
+
+	def @m.configwidget
+		@wconfig=ConfigWidget.new(@config)
+	end
+
+	def @m.saveconfig
+		if @loaded
+			@config[:time]=@wconfig.btime.value
+			@config[:native]=@wconfig.bradio1.active?
+			begin
+				color=@wconfig.bg_entry.text
+				Gdk::Color.parse(color)
+				@config[:bg]=color
+				color=@wconfig.fg_entry.text
+				Gdk::Color.parse(color)
+				@config[:fg]=color
+			rescue
+				ModErrorError.new(self, "#{color} is not a valid color. Use previous value.")
+			end
+			true
+		else
+			false
+		end
+	end
+
+	def @m.quit
+		@config.save if @config
+		if @rnotify
+			@notification.close if @notification
+			Notify.uninit
+		end
+	end
+end