sapis 0.1.0

data/lib/sapis/multimedia_helper.rb

@@ -0,0 +1,281 @@
+=begin
+
+<multimedia_helper.rb> - Part of Sav's APIs.
+Copyright (C) 2011 Saverio Miroddi
+
+This program 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 3 of the License, or
+(at your option) any later version.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+require_relative 'system_helper'
+require_relative 'bash_helper'
+
+module MultimediaHelper
+
+  include SystemHelper, BashHelper
+
+  RHYTHMBOX_PLAYLISTS_FILE = File.expand_path( '.local/share/rhythmbox/playlists.xml', '~' )
+  BANSHEE_DATA_FILE        = File.expand_path( '.config/banshee-1/banshee.db', '~' )
+  AUDIO_FILES_EXTENSIONS   = [ 'm4a', 'mp3' ]
+
+  def image_format( image_data )
+    if image_data.start_with?( 'GIF8' )
+      'gif'
+    elsif image_data.start_with?( "\xFF\xD8\xFF\xE0" )
+      'jpg'
+    else
+      raise "Unrecognized picture format."
+    end
+  end
+
+  def play_audio_file( filename )
+    filename = File.expand_path( filename )
+
+    if SystemHelper.mac?
+      simple_bash_execute 'afplay', filename
+    else
+      simple_bash_execute "gst-launch-1.0 playbin -q", "uri=file://#{ filename }"
+    end
+  end
+
+  def normalize_songs( *files )
+    files.flatten!
+
+    mp3_files = files.select { | file | file =~ /\.mp3$/i }
+    mp4_files = files.select { | file | file =~ /\.m4a$/i }
+
+    raise "xxx!" if mp3_files.size + mp4_files.size != files.size
+
+    if mp3_files.size != 0
+      simple_bash_execute "mp3gain -r", mp3_files
+    end
+
+    if mp4_files.size != 0
+      simple_bash_execute "aacgain -r", mp4_files
+    end
+  end
+
+  # Works on a single folder - no recursion.
+  #
+  def normalize_album( directory, extension )
+    case extension
+    when 'm4a'
+      program   = 'aacgain'
+    when 'mp3'
+      program   = 'mp3gain'
+    else
+      raise "Unsupported extension: #{ extension }"
+    end
+
+    files         = Dir.glob( File.join( directory, "*.#{ extension }" ) )
+    encoded_files = encode_bash_filenames( *files )
+
+    # The m.f. popen3 hangs when normalizing, possibly because aacgain rewrites to screen because of the counter
+    # F**K F**K
+    #
+    # Regardless, aacgain appears to be broken, as if an error happens, it still exits successfully.
+    #
+    safe_execute "#{ program } -a -k " + encoded_files + " 2> /dev/null"
+  end
+
+  def encode_alac_to_m4a( file )
+    temp_file = file + ".wav"
+
+    simple_bash_execute "ffmpeg -i", file, temp_file
+
+    File.delete( file )
+
+    simple_bash_execute "neroAacEnc -q 0.5", "-if", temp_file, "-of", file
+
+    File.delete( temp_file )
+  end
+
+  # Sorts files by name
+  #
+  def create_m3u_playlist( files_or_pattern, basedir, output )
+    case files_or_pattern
+    when Array
+      files = files_or_pattern
+      # do nothing
+    when String
+      files = Dir.glob( files_or_pattern )
+    else
+      raise "ziokann!! #{ files_or_pattern }"
+    end
+
+    buffer = "#EXTM3U" << "\n"
+
+    files.sort.each do | file |
+      duration = get_audio_file_duration( file )
+      song_name = File.basename( file ).sub( /\.\w+$/, '' )
+
+      buffer << "#EXTINF:#{ duration },#{ song_name }" << "\n"
+
+      file_relative_path = File.join( basedir, File.basename( file ) )
+
+      buffer << file_relative_path << "\n"
+    end
+
+    IO.write( output, buffer )
+  end
+
+  def get_audio_file_duration( file )
+    case file
+    when /.mp3$/
+      duration = safe_execute( "mp3info -p '%S' " + encode_bash_filenames( file ) )
+    when /.m4a$/
+     # f#!$ing faad writes only to stderr
+     #
+      raw_result = safe_execute( 'faad -i ' + encode_bash_filenames( file ) + " 2>&1" )
+
+      duration = raw_result[ /(\d+)\.\d+ secs/, 1 ] || raise( "z.k.!!" )
+    else
+      raise "ziokann!!! #{ file }"
+    end
+
+    duration.to_i
+  end
+
+  # :directories           single entry or array
+  #
+  def add_playlists_to_rhythmbox( directories, options={} )
+    require 'rexml/document'
+    require 'uri'
+
+    directories = [ directories ] if ! directories.is_a?( Array )
+
+    raw_xml  = IO.read( RHYTHMBOX_PLAYLISTS_FILE )
+    xml_doc  = REXML::Document.new( raw_xml )
+    xml_root = xml_doc.elements.first
+
+    directories.each do | directory |
+      puts "Adding #{ directory }..."
+
+      playlist_name = File.basename( directory )
+      filenames     = AUDIO_FILES_EXTENSIONS.map { | extension | Dir.glob( File.join( directory, "*.#{ extension }" ) ) }.flatten.sort
+
+      if xml_root.elements.any? { | xml_element | xml_element.attributes[ 'name' ] == playlist_name }
+        puts ">>> playlist already existent!"
+      else
+        playlist_node = xml_root.add_element( 'playlist', 'name' => playlist_name, 'type' => 'static' )
+
+        filenames.sort!
+
+        filenames.each do | filename |
+          entry_node       = playlist_node.add_element( 'location' )
+          encoded_filename = URI.encode( File.expand_path( filename ) )
+          entry_node.text  = "file://" + encoded_filename
+        end
+      end
+    end
+
+    buffer = format_xml_playlist_for_rhythmbox( xml_doc )
+
+    IO.write( RHYTHMBOX_PLAYLISTS_FILE, buffer )
+  end
+
+  # :directories           single entry or array
+  #
+  def add_playlists_to_banshee( directories, options={} )
+    require 'uri'
+
+    directories = [ directories ] if ! directories.is_a?( Array )
+
+    db_layer = SQLiteLayer.new( BANSHEE_DATA_FILE )
+
+    primary_source_id_music = 1
+
+    db_layer.transaction do
+      directories.each do | directory |
+        puts "Adding #{ directory }..."
+
+        playlist_name = File.basename( directory )
+
+        insertion_values = {
+          :PrimarySourceID => primary_source_id_music,
+          :Name            => playlist_name,
+        }
+
+        playlist_id = db_layer.insert_values( 'CorePlaylists', insertion_values )
+
+        filenames = AUDIO_FILES_EXTENSIONS.map { | extension | Dir.glob( File.join( directory, "*.#{ extension }" ) ) }.flatten.sort
+
+        filenames.each do | filename |
+          puts " - #{ filename }"
+
+          track_id = banshee_find_track_id( filename, db_layer ) || banshee_add_playlist_entry( filename, db_layer, primary_source_id_music )
+
+          insertion_values = {
+            :PlaylistID => playlist_id,
+            :TrackID    => track_id,
+          }
+
+          db_layer.insert_values( 'CorePlaylistEntries', insertion_values )
+        end
+      end
+    end
+  end
+
+  private
+
+  def banshee_find_track_id( filename, db_layer )
+    uri_filename   = "file://" + URI.encode( File.expand_path( filename ) )
+
+    db_layer.select_value( "SELECT TrackID FROM CoreTracks WHERE Uri = ?", uri_filename )
+  end
+
+  def banshee_add_playlist_entry( filename, db_layer, primary_source_id_music )
+    uri_filename   = "file://" + URI.encode( File.expand_path( filename ) )
+    title          = File.basename( filename ).sub( /\.\w+$/, '' )
+    straight_title = "'" + title.gsub( "'", "''" ) + "'"
+    timestamp      = Time.now.to_i
+
+    insertion_values = {
+      :PrimarySourceID => primary_source_id_music,
+      :ArtistID             => 1,
+      :AlbumID              => 1,
+      :TagSetID             => 0,
+
+      :Uri                  => uri_filename,
+
+      :DateAddedStamp       => timestamp,
+      :LastSyncedStamp      => timestamp,
+    }
+
+    # when the titles are inserted with placeholders, they're inserted as BLOBs, because the columns are
+    # defined as TEXT. this causes problems with banshee, and is not noticeable when querying the db via
+    # cmdline client, or via ruby driver (translation: it's a m.f. pain in the back), but only via dump.
+    #
+    straight_insert_values = {
+      :Title           => straight_title,
+      :TitleLowered    => straight_title.downcase,
+    }
+
+    db_layer.insert_values( 'CoreTracks', insertion_values, :straight_insert => straight_insert_values )
+  end
+
+  def format_xml_playlist_for_rhythmbox( xml_doc )
+    buffer        = ""
+    xml_formatter = REXML::Formatters::Pretty.new
+
+    xml_formatter.compact = true
+    xml_formatter.width   = 16384   # avoid introducing f*ing spaces inside <location> elements, which are not compatible with RhythmBox
+
+    xml_formatter.write( xml_doc, buffer )
+
+    buffer
+   end
+
+end
+

data/lib/sapis/sqlite_layer.rb

@@ -0,0 +1,166 @@
+=begin
+
+<sqlite_layer.rb> - Part of Sav's APIs.
+Copyright (C) 2011 Saverio Miroddi
+
+This program 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 3 of the License, or
+(at your option) any later version.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+require 'sqlite3'
+
+# In block form, transaction don't accept the :rollback call, so we need to use an exception.
+#
+class Rollback < StandardError; end
+
+class SQLiteLayer
+  attr_reader :db
+
+  def initialize( filename, options={} )
+    absolute_db_filename = options[ :relative ] ? File.expand_path( filename, '~' ) : filename
+
+    @db = SQLite3::Database.new( absolute_db_filename )
+
+    @db.execute( 'PRAGMA foreign_keys = ON' )
+  end
+
+  # values: Can be either an array of values, or a hash field=>value.
+  #         In order to insert BLOBs, pass a value enclosed in an array, e.g. ['mydata']
+  #
+  # Doesn't try to be clever.
+  #
+  # options:
+  #   :straight_insert        hash of values (position => value) to insert straight, without placeholders.
+  #                           values are not automatically escaped or quoted.
+  #                           this makes sense for some edge cases.
+  #
+  def insert_values( table, values, options={} )
+    straight_insert = options[ :straight_insert ] || {}
+
+    sql_fields       = []
+    sql_placeholders = []
+    sql_values       = []
+
+    case values
+    when Hash
+      values.each do | field, value |
+        sql_fields       << field.to_s
+        sql_placeholders << '?'
+        sql_values       <<  value
+      end
+    when Array
+      values.each do | value |
+        sql_placeholders << '?'
+        sql_values       <<  value
+      end
+    else
+      raise "Invalid values class: #{ values.class }"
+    end
+
+    straight_insert.each do | field, value |
+      sql_fields       << field.to_s
+      sql_placeholders << value
+    end
+
+    sql_values.each_with_index do | value, i |
+      sql_values[ i ] = SQLite3::Blob.new( value.first ) if value.is_a?( Array )
+    end
+
+    sql = "INSERT INTO #{ table }"
+    sql << "( #{ sql_fields.join(', ') } )" if sql_fields.size > 0
+    sql << " VALUES( #{ sql_placeholders.join(', ') } )"
+
+    @db.execute( sql, sql_values )
+
+    @db.last_insert_row_id
+  end
+
+  # values:   the :where key is the where condition
+  #
+  def update_values( table, values )
+    where_sql = values.delete( :where ) || 'TRUE'
+
+    set_sql, set_values = values.inject( [ "", [] ] ) do | ( current_set_sql, current_set_values ), ( column, value ) |
+      current_set_sql << ', ' if current_set_sql != ''
+      current_set_sql << "#{ column } = ?"
+      current_set_values << value
+      [ current_set_sql, current_set_values ]
+    end
+
+    @db.execute( "UPDATE #{ table } SET #{ set_sql } WHERE #{ where_sql }", set_values )
+  end
+
+  def execute( sql, *params )
+    @db.execute( sql, params )
+  end
+
+  def select( sql, *params )
+    options = params.last.is_a?( Hash ) ? params.pop : {}
+    execute( sql, *params )
+  end
+
+  # params:    the last can be :options
+  # options:
+  #   :force:  force finding a value
+  #
+  def select_value( sql, *params )
+    options = params.last.is_a?( Hash ) ? params.pop : {}
+
+    row = execute( sql, *params ).first
+
+    value = row && row.first
+
+    if value
+      value
+    elsif options[ :force ]
+      raise "Value not found!"
+    end
+  end
+
+  def select_all( sql, *params )
+    column_names, *raw_data = select_with_headers( sql, *params )
+
+    raw_data.map do | row |
+      Hash[ column_names.zip( row ) ]
+    end
+  end
+
+  # This is a :select_row with headers as first row.
+  #
+  def select_with_headers( sql, *params )
+    @db.execute2( sql, params )
+  end
+
+  # Can be nested - only the outer call with start a transaction.
+  #
+  def transaction( commit=true, &block )
+    if @db.transaction_active?
+      yield
+    else
+      begin
+        @db.transaction do
+          yield
+          raise Rollback.new if !commit
+        end
+      rescue Rollback
+        # do nothing
+      end
+    end
+  end
+
+  def close
+    @db.close
+  end
+
+end

data/lib/sapis/system_helper.rb

@@ -0,0 +1,141 @@
+=begin
+
+<system_helper.rb> - Part of Sav's APIs.
+Copyright (C) 2011 Saverio Miroddi
+
+This program 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 3 of the License, or
+(at your option) any later version.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+require File.expand_path( '../bash_helper.rb', __FILE__ )
+
+module SystemHelper
+
+  require 'shellwords'
+
+  SystemHelper::SEARCH_FILES       = 'f'
+  SystemHelper::SEARCH_DIRECTORIES = 'd'
+
+  include BashHelper
+
+  def self.mac?
+    `uname`.strip == 'Darwin'
+  end
+
+  def self.current_timezone
+    if mac?
+      `systemsetup -gettimezone`.strip.sub( 'Time Zone: ', '' )
+    else
+      IO.read( '/etc/timezone' ).chomp
+    end
+  end
+
+  def self.symlink( source, destination )
+    # Doesn't work! At least one bug in the library:
+    # - File.exists? returns false if a symlink exists, but points to a non-existent file
+    # - symlink causes an abrupt exit if the destination exists
+    #
+#    File.delete( wine_drive_link ) if File.exists?( wine_drive_link )
+#    File.symlink( entry, wine_drive_link )
+    BashHelper.simple_bash_execute "ln -sf", source, destination
+  end
+
+  # REFACTOR: decide not/self for all the following
+  #
+  # 'mountpoint' has inconsistent exit behavior, because if the path is not a mountpoint,
+  # it returns 1, but prints the message to stdout.
+  #
+  def unmount_base_mountpoint( filename )
+    while filename != '/'
+      is_mountpoint = `mountpoint #{ encode_bash_filenames( filename ) }` =~ /is a mountpoint\n$/
+
+      if is_mountpoint
+        simple_bash_execute "umount", filename
+        return
+      end
+
+      filename = File.dirname( filename )
+    end
+
+    raise "Couldn't find base mount point for file: #{ filename }"
+  end
+
+  def system_cores_number
+    if RUBY_PLATFORM =~ /darwin/i
+      raw_result = safe_execute "system_profiler SPHardwareDataType | grep 'Total Number Of Cores'"
+      raw_result[ /: (\d+)/, 1 ].to_i
+    else
+      # See https://www.ibm.com/developerworks/community/blogs/brian/entry/linux_show_the_number_of_cpu_cores_on_your_system17?lang=en
+      # Bash form:
+      #
+      #   cat /proc/cpuinfo | egrep "core id|physical id" | tr -d "\n" | sed s/physical/\\nphysical/g | grep -v ^$ | sort | uniq | wc -l
+      #
+      IO.readlines( '/proc/cpuinfo' ).grep( /core id|physical id/ ).each_slice( 2 ).to_a.uniq.size
+    end
+  end
+
+  def unrar( file, options={} )
+    delete = !! options[ :delete ]
+
+    original_dir    = Dir.pwd
+    destination_dir = File.dirname( file )
+
+    Dir.chdir( destination_dir )
+
+    simple_bash_execute "unrar x", file
+
+    File.delete( file ) if delete
+  ensure
+    Dir.chdir( original_dir )
+  end
+
+  # Opens :filename using the default executable.
+  #
+  def self.open_file( filename )
+    `xdg-open #{ filename.shellescape }`
+  end
+
+  # Case insensitive search
+  #
+  # options:
+  #   :file_type:  [nil] either SEARCH_FILES or SEARCH_DIRECTORIES, or nil for both.
+  #   :skip_paths: [nil] array of (full) paths to skip
+  #
+  def self.find_files( raw_pattern, raw_search_paths, options={} )
+    search_paths = raw_search_paths.map { | path | path.shellescape }.join( ' ' )
+    pattern      = raw_pattern.shellescape
+
+    case options[ :file_type ]
+    when SEARCH_FILES
+      file_type = '-type f'
+    when SEARCH_DIRECTORIES
+      file_type = '-type d'
+    when nil
+      # nothing
+    else
+      raise "Unrecognized :file_type option for find_files: #{ options[ :file_type ] }"
+    end
+
+    skip_paths = options[ :skip_paths ].to_a.map do | path |
+      path_with_pattern = File.join( path, '*' )
+      " -not -path " + path_with_pattern.shellescape
+    end.join( ' ' )
+
+    raw_result = `find #{ search_paths } -iname #{ pattern } #{ file_type } #{ skip_paths }`.chomp
+
+    raw_result.split( "\n" )
+  end
+
+end
+

data/lib/sapis/version.rb

@@ -0,0 +1,3 @@
+module Sapis
+  VERSION = '0.1.0'
+end

data/lib/sapis.rb

@@ -0,0 +1,33 @@
+=begin
+
+Sav's APIs - A collection of Ruby utility helpers.
+Copyright (C) 2011 Saverio Miroddi
+
+This program 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 3 of the License, or
+(at your option) any later version.
+
+This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+=end
+
+require_relative 'sapis/version'
+require_relative 'sapis/graphing_helper'
+require_relative 'sapis/configuration_helper'
+require_relative 'sapis/concurrency_helper'
+require_relative 'sapis/generic_helper'
+require_relative 'sapis/bash_helper'
+require_relative 'sapis/computations_helper'
+require_relative 'sapis/desktop_helper'
+require_relative 'sapis/interactions_helper'
+require_relative 'sapis/multimedia_helper'
+require_relative 'sapis/gnome_helper'
+require_relative 'sapis/system_helper'
+require_relative 'sapis/sqlite_layer'