itunes-controller 0.1.0

data/lib/itunesController/itunescontroller.rb

@@ -0,0 +1,90 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+module ItunesController  
+    
+    # This is the base class of all itunes controller.    
+    # @abstract This class should be overridden to implement the class that talks to iTunes.
+    class BaseITunesController
+
+        # The constructor        
+        def initialize()
+        end     
+    
+        # Used to get the iTunes version
+        # @abstract Must be overridden
+        # @return [String] The itunes version
+        def version
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+    
+        # Used to remove tracks from the libaray
+        # @abstract Must be overridden
+        # @param [Array] tracks A list of tracks to remove from the itunes libaray
+        def removeTracksFromLibrary(tracks)
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+
+        # Used to add a list of files to the itunes library
+        # @abstract Must be overridden
+        # @param [Array[String]] A list of files to add to the itunes library
+        # @return [Array[ItunesController::Track]] List of ids of the new tracks once they are in the database
+        def addFilesToLibrary(files)
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end                                     
+           
+        # Used to tell iTunes to refresh a list of tracks data from the info stored in the files
+        # @abstract Must be overridden
+        # @param [Array] tracks A list of tracks to fresh
+        def refreshTracks(tracks)
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+        
+        # @abstract Must be overridden
+        def getTracks(&b)
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+        
+        # Used to search the itunes library
+        # @param term The search term
+        # @return [Array] a list of iTunes track that match the search term
+        # @abstract Must be overridden
+        def searchLibrary(term)
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+
+        # Used to find the number of tracks in the library
+        # @abstract Must be overridden
+        # @return [Number] The number of tracks
+        def getTrackCount()
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+
+        # Used to get the database of a itunes track
+        # @abstract Must be overridden
+        # @param track the track
+        # @return The database id
+        def getTrackDatabaseId(track)
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+    
+    end
+end

data/lib/itunesController/itunescontroller_factory.rb

@@ -0,0 +1,51 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+require 'itunesController/platform'
+if ItunesController::Platform::isWindows()
+  require 'itunesController/windows_itunescontroller.rb'
+elsif ItunesController::Platform::isMacOSX()
+  require 'itunesController/macosx_itunescontroller.rb'
+else
+  raise("Unsupported operating system #{RUBY_PLATFORM}.")
+end
+
+require 'itunesController/database/database'
+
+module ItunesController
+    
+    # This is a factory class used to create a iTunes controller for the current platform
+    class ITunesControllerFactory
+        
+        # Used to create the iTunes controller for different platforms
+        # @return [ItunesController::BaseITunesController] The itunes controller
+        # @raise If the platform is unsupported
+        def self.createController()
+            if ItunesController::Platform::isWindows()
+              return ItunesController::WindowsITunesController.new()
+            elsif ItunesController::Platform::isMacOSX()
+              return ItunesController::MacOSXITunesController.new()
+            else
+              raise("Unsupported operating system #{RUBY_PLATFORM}.")
+            end            
+        end
+    end
+end

data/lib/itunesController/kinds.rb

@@ -0,0 +1,138 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+module ItunesController
+        
+    # A enum of special kinds
+    # @attr [Number] kind The Source kind ID
+    # @attr [String] String the source display name
+    class SpecialKind
+        attr_accessor :kind, :displayName
+        def initialize(kind,displayName)
+            @kind = kind
+            @displayName = displayName
+        end
+    
+        # The Audio Book kind 
+        Audiobooks=SpecialKind.new(1800630337,"Audiobooks")
+        # The folder kind
+        Folder=SpecialKind.new(1800630342,"Folder")
+        # The movie kind
+        Movies=SpecialKind.new(1800630345,"Movies")
+        # The music kind
+        Music=SpecialKind.new(1800630362,"Music")
+        # The none kind
+        None=SpecialKind.new(1800302446,"None")
+        # The party shuffle kind
+        PartyShuffle=SpecialKind.new(1800630355,"Party Shuffle")
+        # The pod cast kind
+        Podcasts=SpecialKind.new(1800630352,"Podcasts")
+        # The purchased music kind
+        PurchasedMusic=SpecialKind.new(1800630349,"Purchased Music")        
+        # The TV show kind
+        TVShows=SpecialKind.new(1800630356,"TV Shows")
+        # The video kind
+        Videos=SpecialKind.new(1800630358,"Videos")
+        # The genius kind
+        Genius=SpecialKind.new(1800630343,"Genius")
+        # The iTunesU kind
+        ITunesU=SpecialKind.new(1800630357,"iTunes U")
+        # The library kind
+        Library=SpecialKind.new(1800630348,"Library")
+        # The unknown kind
+        Unknown=SpecialKind.new(-1,"Unknown")
+    
+        @@values=[Audiobooks,Folder,Movies,Music,
+            None,PartyShuffle,Podcasts,PurchasedMusic,
+            TVShows, Videos,Genius,ITunesU,Library,Unknown]
+    
+        # A class scoped method used to get the kind associated with the kind ID
+        # @param kind The kind ID
+        # @return [ItunesController::SourceKind] The source kind object
+        def self.fromKind(kind)
+            @@values.each { | v1 |
+                if (v1.kind==kind)
+                return v1
+                end
+            }
+            return SpecialKind.new(v1,"Unknown")
+        end
+    
+        # Used pretty print the kind to a string
+        # @return A string containing the kind display name and ID
+        def to_s
+            return "#{displayName} (#{kind})"
+        end
+    end
+    
+    # Enum of source kinds
+    # @attr [Number] kind The Source kind ID
+    # @attr [String] String the source display name 
+    class SourceKind
+        
+        attr_accessor :kind, :displayName
+
+        # The constructor
+        # @param [Number] kind The kind ID
+        # @param [String] displayName The kind display name        
+        def initialize(kind,displayName)
+            @kind = kind
+            @displayName = displayName
+        end
+            
+        # The Audio CD Source Kind
+        AudioCD=SourceKind.new(1799439172,"Audio CD")
+        # The Device Source Kind
+        Device=SourceKind.new(1799644534,"Device")
+        # The iPod Source Kind
+        IPod=SourceKind.new(1800433508,"iPod")
+        # The Library Source Kind
+        Library=SourceKind.new(1800169826,"Library")
+        # The MP3 CD Source Kind
+        MP3CD=SourceKind.new(1800225604,"MP3 CD")
+        # The Radio Tuner Source Kind
+        RadioTuner=SourceKind.new(1800697198,"Radio Tuner")
+        # The Shared Libarary Source Kind
+        SharedLibrary=SourceKind.new(1800628324,"Shared Library")
+        # The Unknown Source Kind
+        Unknown=SourceKind.new(1800760938,"Unknown")
+    
+        @@values=[AudioCD,Device,IPod,Library,MP3CD,RadioTuner,SharedLibrary,Unknown]
+    
+        # A class scoped method used to get the kind associated with the kind ID
+        # @param kind The kind ID
+        # @return [ItunesController::SourceKind] The source kind object
+        def self.fromKind(kind)
+            @@values.each { | v1 |
+                if (v1.kind==kind)
+                return v1
+                end
+            }
+            return SourceKind.new(v1,"Unknown")
+        end
+    
+        # Used pretty print the kind to a string
+        # @return A string containing the kind display name and ID
+        def to_s            
+            return "#{displayName} (#{kind})"
+        end
+    end
+end

data/lib/itunesController/logging.rb

@@ -0,0 +1,119 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+module ItunesController    
+    
+    class ItunesControllerLogging     
+        DEBUG=1   
+        INFO=2
+        WARN=3
+        ERROR=4          
+        
+        # The log file, if defined then logging opertions will be sent to this file
+        @@logFile = nil       
+        @@logLevel = INFO
+        
+        # Used to set the location of the log file
+        # @param [String] file The log file location
+        def self.setLogFile(file)
+            @@logFile = file 
+        end
+        
+        # Use to set the loggin level
+        # @param [Number] level The logging level
+        def self.setLogLevel(level)
+            @@logLevel = level
+        end
+        
+        def self.setLogLevelFromString(level)
+            if (level=="DEBUG")
+                @@logLevel = DEBUG
+            elsif (level=="INFO")
+                @@logLevel = INFO
+            elsif (level=="WARN")
+                @@logLevel = WARN
+            elsif (level=="ERROR")
+                @@logLevel = ERROR
+            else
+                error("Unkown log configuration '#{level}'")
+                exit(1)
+            end
+        end
+        
+        # Used to print logging information at info level
+        # @param [String] msg The message to print
+        def self.info(msg)
+            if @@logLevel <= INFO            
+                printMsg(msg)
+            end
+        end        
+
+        # Used to print logging information at warn level
+        # @param [String] msg The message to print
+        def self.warn(msg)
+            if @@logLevel <= WARN            
+                printMsg(msg)
+            end
+        end        
+        
+        # Used to print logging information at debug level
+        # @param [String] msg The message to print
+        def self.debug(msg)
+            if @@logLevel <= DEBUG
+                msg="DEBUG:"+msg
+                printMsg(msg)
+            end
+        end       
+        
+        # Used to print logging information at debug level
+        # @param [String] msg The message to print
+        # @param exception If not nil then this exception detials will be printed
+        def self.error(msg,exception=nil)
+            if @@logLevel <= ERROR
+                msg="ERROR:"+msg
+                printMsg(msg,true)        
+                if (exception!=nil)                
+                    printMsg("     - #{exception.message}",true)
+                    exception.backtrace.each do | line |
+                        printMsg("     * #{line}",true)
+                    end
+                end
+            end       
+        end                  
+    
+    private
+    
+        def self.printMsg(msg,error=false)
+            if (@@logFile!=nil) 
+                out_file = File.open(@@logFile,"a") do | f |
+                    f.puts(msg) 
+                end
+            else                
+                if (error)
+                    $stderr.puts(msg)
+                else
+                    $stdout.puts(msg)                                   
+                end
+                
+            end        
+        end
+    end
+end

data/lib/itunesController/macosx_itunescontroller.rb

@@ -0,0 +1,204 @@
+#
+# Copyright (C) 2011-2012  John-Paul.Stanford <dev@stanwood.org.uk>
+#
+# 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/>.
+#
+# Author:: John-Paul Stanford <dev@stanwood.org.uk>
+# Copyright:: Copyright (C) 2011  John-Paul.Stanford <dev@stanwood.org.uk>
+# License:: GNU General Public License v3 <http://www.gnu.org/licenses/>
+#
+
+# References:
+#  - http://code.google.com/p/itunes-rem-dupes/source/browse/trunk/itunes_update_library.rb?r=22
+#  - http://guides.macrumors.com/Deleting_Songs_From_iTunes
+#  - http://macscripter.net/viewtopic.php?id=22726
+
+require 'itunesController/itunescontroller'
+require 'itunesController/kinds'
+require 'itunesController/debug'
+require 'itunesController/logging'
+require 'itunesController/track'
+require 'rubygems'
+require 'escape'
+require 'open3'
+require 'osx/cocoa'
+
+include OSX
+OSX.require_framework 'ScriptingBridge'
+
+module ItunesController
+
+    # This is a iTunes controller class used to talk to itunes. This runs on macosx and makes
+    # use of the OSC ruby bindings. It also uses application "osascript" to execute apple scripts.
+    class MacOSXITunesController < ItunesController::BaseITunesController
+
+        # The constructor
+        def initialize()
+            @iTunes = SBApplication.applicationWithBundleIdentifier:'com.apple.iTunes'
+            library=getSourceLibrary()
+            @libraryPlaylists=library.libraryPlaylists
+        end
+
+        # Used to get the iTunes version
+        # @return [String] The itunes version
+        def version
+            return @iTunes.version.to_s+" (Mac OSX)"
+        end
+
+        # Used to tell iTunes to refresh a list of tracks data from the info stored in the files
+        # @param [Array] tracks A list of tracks to fresh
+        def refreshTracks(tracks)
+            ItunesController::ItunesControllerLogging::debug("refreshing tracks...")
+            tracks.reverse.each do | track |
+                track.refresh
+            end
+        end
+
+        # Used to remove tracks from the libaray
+        # @param [Array] tracks A list of tracks to remove from the itunes libaray
+        def removeTracksFromLibrary(tracks)
+            ItunesController::ItunesControllerLogging::debug("removing tracks...")
+            tracks.reverse.each do | track |
+                track.delete
+            end
+        end
+
+        # Used to add a list of files to the itunes library
+        # @param [Array[String]] A list of files to add to the itunes library
+        # @return [Array[ItunesController::Track]] List of ids of the new tracks once they are in the database
+        def addFilesToLibrary(files)
+            tracks=[]
+            files.each do | file |
+                script="tell application \"iTunes\"\n"
+                script=script+"    set theTrack to (add POSIX file \"#{file}\")\n"
+                script=script+"    return (database ID of theTrack & name of theTrack)\n"
+                script=script+"end tell\n"
+                output=executeScript(script)
+                if (output =~ /(\d+), (.*)/)
+                    track=ItunesController::Track.new(file,$1.to_i,$2)
+                    tracks.push(track)
+                else
+                    ItunesController::ItunesControllerLogging::error("Unable to add file '#{file}': " + output)
+                end
+            end
+
+            return tracks;
+        end
+
+        # Used to get the database of a itunes track
+        # @param track the track
+        # @return The database id
+        def getTrackDatabaseId(track)
+            return track.databaseID
+        end
+        
+        def getTracks(&b)
+            ItunesController::ItunesControllerLogging::debug("Retriving track information...")
+            playlist=@libraryPlaylists[0]
+            fileTracks = playlist.fileTracks
+            size = fileTracks.length()
+            count = 1
+            fileTracks.each do | track |
+                location=track.location
+                path=nil
+                dead=false
+                if (location!=nil && location.isFileURL)
+                    path=location.path
+                    if (!File.exist?(location.path))
+                        dead = true
+                    end
+                else
+                    dead = true
+                end
+
+                if (count % 1000 == 0)
+                    ItunesController::ItunesControllerLogging::debug("Found tracks #{count} of #{size}")
+                end
+                if (track.name!=nil)
+                    b.call(ItunesController::Track.new(path,track.databaseID,track.name),count,size,dead)
+                end
+                count=count+1
+            end
+            ItunesController::ItunesControllerLogging::debug("Found tracks #{count-1} of #{size}")
+            return size
+        end
+
+        # Used to find the number of tracks in the library
+        # @return [Number] The number of tracks
+        def getTrackCount()
+            playlist=@libraryPlaylists[0]
+            return playlist.fileTracks.length()
+        end
+
+        # Used to search the itunes library
+        # @param term The search term
+        # @return [Array] a list of iTunes track that match the search term
+        def searchLibrary(term)
+            tracks=[]
+            @libraryPlaylists.each do | playlist |           
+                #foundTracks = playlist.searchFor(term,'kSrS')
+                foundTracks = playlist.searchFor_only_(term,1799449708)
+                if (foundTracks!=nil)
+                    foundTracks.each do | t |
+                        tracks.push(t)
+                    end
+                end
+            end
+            return tracks
+        end
+
+    private
+
+        # Used to get the libaray iTunes source
+        # @return The iTunes source for the library
+        def getSourceLibrary()
+            @iTunes.sources.each do |source|
+                if (source.kind == SourceKind::Library.kind)
+                    return source
+                end
+            end
+            return nil
+        end
+
+        # Used to find playlists of a given media kind
+        # @param types The types
+        # @return [Array] A list of playlists
+        def findPlaylists(types)
+            playlists=[]
+            library=getSourceLibrary()
+            if (library==nil)
+                raise("Unable to find iTunes library")
+            end
+
+            library.userPlaylists.each do |pl|
+                kind=SpecialKind::fromKind(pl.specialKind)
+                types.each do |type|
+                    if (kind.kind == type.kind)
+                        playlists.push(pl)
+                    end
+                end
+            end
+
+            return playlists
+        end
+
+        # Used to execute a apple script using the system "osascript" command.
+        # @private
+        # @param script the Script contents
+        def executeScript(script)
+            stdin, stdout, stderr = Open3.popen3(Escape.shell_command(["osascript","-e",script]))
+            return stdout.readlines.join('\n').strip
+        end
+    end
+end