itunes-controller 0.1.0

data/bin/refreshFiles.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -I../lib
+#
+# A command line util used to remove tracks to the iTunes library
+#
+# 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/application'
+require 'itunesController/sqlite_creator'
+
+class App < ItunesController::Application
+
+    # Used to display the command line useage
+    def displayUsage()
+        puts("Usage: "+@appName+" [options] files...")
+        puts("")
+        puts(genericOptionDescription())
+    end
+
+    def checkAppOptions()
+        if ARGV.length == 0
+            usageError("No files given.")
+        end
+    end
+
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+    
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        ARGV.each do | path |
+            controller.updateTrack(path)
+        end
+    end
+end
+
+app=App.new("refreshTracks.rb")
+app.exec()
+                               

data/bin/removeDeadTracks.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby -I../lib
+#
+# A command line util used to remove tracks from iTunes whoes files can't be found.
+#
+# 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/cachedcontroller'
+require 'itunesController/sqlite_creator'
+require 'itunesController/debug'
+require 'itunesController/logging'
+require 'itunesController/application'
+
+class App < ItunesController::Application
+
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+    
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        count=controller.removeDeadTracks()
+        ItunesController::ItunesControllerLogging::info("Removed #{count} dead tracks")
+    end
+end
+
+app=App.new("removeDeadTracks.rb")
+app.exec()
+

data/bin/removeFiles.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby -I../lib
+#
+# A command line util used to remove tracks to the iTunes library
+#
+# 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/cachedcontroller'
+require 'itunesController/sqlite_creator'
+require 'itunesController/application'
+
+class App < ItunesController::Application
+
+    # Used to display the command line useage
+    def displayUsage()
+        puts("Usage: "+@appName+" [options] files...")
+        puts("")
+        puts(genericOptionDescription())
+    end
+
+    def checkAppOptions()
+        if ARGV.length == 0
+            usageError("No files given.")
+        end
+    end
+
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+    
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        ARGV.each do | path |
+            controller.removeTrack(path)
+        end
+    end
+end
+
+app=App.new("removeFiles.rb")
+app.exec()

data/bin/trackInfo.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -I../lib
+#
+# A command line util used to remove tracks to the iTunes library
+#
+# 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/sqlite_creator'
+require 'itunesController/cachedcontroller'
+require 'itunesController/debug'
+require 'itunesController/logging'
+require 'itunesController/application'
+
+class App < ItunesController::Application
+
+    # Used to display the command line useage
+    def displayUsage()
+        puts("Usage: "+@appName+" [options] files...")
+        puts("")
+        puts(genericOptionDescription())
+    end
+
+    def checkAppOptions()
+        if ARGV.length == 0
+            usageError("No files given.")
+        end
+    end
+
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+    
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        ARGV.each do | path |
+            track=controller.getTrack(path)
+            if (track!=nil)
+                ItunesController::ItunesControllerDebug::printTrack(track) 
+            else
+                ItunesController::ItunesControllerLogging::error("Unable to find track")
+            end
+            ItunesController::ItunesControllerLogging::info("")
+        end
+    end
+end
+
+app=App.new("trackInfo.rb")
+app.exec()

data/itunes-controller.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'itunesController/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'itunes-controller'
+  s.version     = ItunesController::VERSION
+  s.date        = '2012-02-06'
+  s.summary     = "TCP command server that can be used to control iTunes headlessly"
+  s.description = "A application to control enable iTunes to be operated on a headless server without the GUI. It provides a TCP server which can be connected to locally or remote by other applications to control iTunes"
+  s.authors     = ["John-Paul Stanford"]
+  s.email       = 'dev@stanwood.org.uk'
+  s.homepage    = 'http://code.google.com/p/itunes-remote-control-server/'
+  s.files       = `git ls-files`.split("\n")  
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.has_rdoc     = 'yard'
+  s.rdoc_options = [ '--main', 'README' ] 
+  s.extra_rdoc_files = [ 'LICENSE', 'README' ] 
+  s.add_development_dependency('yard')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('test-unit')
+  s.add_dependency('escape')
+  s.add_dependency('sqlite3')
+end

data/jar-stuff.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+GEMS=""
+GEMS="$GEMS sqlite3"
+GEMS="$GEMS escape"
+GEMS="$GEMS itunes-controller"
+
+JRUBY_ARGS="--1.9"
+
+# Compile the gem
+jruby $JRUBY_ARGS -S rake gem
+if [ $? -ne 0 ] 
+then
+    exit 1
+fi
+
+# Create the jar
+jruby  $JRUBY_ARGS -S gem install -i ./itunes-controller $GEMS --no-rdoc --no-ri
+jar cf itunes-controller-dummy-server.jar -C itunes-controller .
+
+rm -rf ./itunes-controller
+
+# Display the results
+jruby $JRUBY_ARGS -ritunes-controller-dummy-server.jar -S gem list

data/lib/itunesController/application.rb

@@ -0,0 +1,127 @@
+#
+# 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/cachedcontroller'
+require 'itunesController/logging'
+require 'itunesController/version'
+
+require 'rubygems'
+require 'optparse'
+
+module ItunesController
+
+    class Application
+
+        def initialize(appName)
+            @appName = appName
+            @options = {}
+            @options[:logFile] = nil
+        end
+
+        def genericOptionDescription()
+            result=[]
+            result.push("Specific options:")
+            result.push("    -f, --log_file FILE              Optional paramter used to log messages to")
+            result.push("    -l, --log_config LEVEL           Optional paramter used to log level [DEBUG|INFO|WARN|ERROR]")               
+            result.push("    -v, --version                    Display version of the application")
+            result.push("    -h, --help                       Display this screen")
+            return result.join("\n")
+        end
+
+        # Used to display the command line useage
+        def displayUsage()
+            puts("Usage: "+@appName+" [options]")
+            puts("")
+            puts(genericOptionDescription())
+        end
+
+        # Used to display a error message and the command line usesage
+        # @param [String] message The error message
+        def usageError(message)
+            $stderr.puts "ERROR: "+message
+            displayUsage()
+            exit(1)
+        end
+
+        # Used to check the command line options are valid
+        def checkOptions
+            checkAppOptions
+        end
+
+        def parseOptions
+            optparse = OptionParser.new do|opts|
+                opts.banner = "Usage: "+@appName+" [options]"
+                opts.separator ""
+                opts.separator "Specific options:"
+
+                opts.on('-f','--log_file FILE','Optional paramter used to log messages to') do |value|
+                    @options[:logFile] = value
+                    ItunesController::ItunesControllerLogging::setLogFile(@options[:logFile])
+                end
+                opts.on('-l','--log_config LEVEL','Optional paramter used to log level [DEBUG|INFO|WARN|ERROR]') do |value|
+                    @options[:logConfig] = value
+                    ItunesController::ItunesControllerLogging::setLogLevelFromString(@options[:logConfig])
+                end
+                parseAppOptions(opts)
+
+                opts.on_tail( '-v', '--version', 'Display version of the application' ) do
+                    puts "itunes-remote-control-server "+ItunesController::VERSION
+                    puts "Copyright (C) 2012 John-Paul Stanford"
+                    puts "License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>."
+                    puts "This is free software: you are free to change and redistribute it."
+                    puts "There is NO WARRANTY, to the extent permitted by law."
+                    puts ""
+                    puts "Authors: John-Paul Stanford <dev@stanwood.org.uk>"
+                    puts "Website: http://code.google.com/p/itunes-remote-control-server/"
+                end
+                opts.on_tail( '-h', '--help', 'Display this screen' ) do
+                    puts opts
+                    exit
+                end
+            end
+            optparse.parse!
+            checkOptions()
+        end        
+    
+        def exec()
+            parseOptions
+            controllerCreator = createController()
+            execApp(controllerCreator)
+            #controller.close()
+        end
+
+        def getOptions()
+            return @options
+        end
+
+        def parseAppOptions(opts)
+        end
+
+        def checkAppOptions()
+        end
+
+        def execApp(controllerCreator)
+            raise "ERROR: Your trying to instantiate an abstract class"
+        end
+
+    end
+end

data/lib/itunesController/cachedcontroller.rb

@@ -0,0 +1,188 @@
+# 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/logging'
+require 'itunesController/itunescontroller'
+require 'itunesController/database/database'
+require 'itunesController/track'
+
+module ItunesController
+
+    class CachedController
+
+        def initialize(controller,databaseBackend)
+            @controller = controller           
+            @database = ItunesController::Database.new(@controller,databaseBackend)            
+            @cachedOnCreate=cacheTracks()
+        end
+
+        def getCachedTracksOnCreate()
+            return @cachedOnCreate
+        end
+
+        def removeTrack(path)
+            trackInfo=@database.getTrack(path)
+            if (trackInfo==nil)
+                ItunesController::ItunesControllerLogging::error("Unable to find track with path: "+path)
+                return nil
+            end
+            removeTrackByInfo(trackInfo)
+        end
+
+        def removeTrackByInfo(trackInfo)            
+            ItunesController::ItunesControllerLogging::debug("Removing track: '#{trackInfo}'")
+            foundTracks=@controller.searchLibrary(trackInfo.title)
+            if (foundTracks==nil || foundTracks.length==0)
+                ItunesController::ItunesControllerLogging::error("Unable to find track #{trackInfo}'")
+                return nil
+            end
+            foundTracks.each do | t |
+                if (@controller.getTrackDatabaseId(t) == trackInfo.databaseId)                  
+                   @controller.removeTracksFromLibrary([t])
+                   count=@database.getParam(ItunesController::Database::PARAM_KEY_TRACK_COUNT,0).to_i
+                   count=count-1
+                   @database.setParam(ItunesController::Database::PARAM_KEY_TRACK_COUNT,count)
+                   if (trackInfo.location!=nil)
+                       ItunesController::ItunesControllerLogging::info("Remove track '#{trackInfo.location}' from iTunes library")
+                   else
+                       ItunesController::ItunesControllerLogging::info("Remove track with databaseId '#{trackInfo.databaseId}' from iTunes library")
+                   end
+                   @database.removeTrack(trackInfo)
+                end
+            end            
+        end
+
+        def updateTrack(path)
+            trackInfo=@database.getTrack(path)
+            if (trackInfo==nil)
+                ItunesController::ItunesControllerLogging::debug("Unable to find track with path: "+path)
+                return nil
+            end
+            foundTracks=@controller.searchLibrary(trackInfo.title)
+            foundTracks.each do | t |
+                if (@controller.getTrackDatabaseId(t) == trackInfo.databaseId)
+                   @controller.refreshTracks([t])
+                   ItunesController::ItunesControllerLogging::info("Refreshed track  '#{trackInfo.location}' metadata")
+                end
+            end
+        end
+
+        def addTrack(path)
+            ItunesController::ItunesControllerLogging::debug("Adding track #{path}")
+            ids=@controller.addFilesToLibrary([path])            
+            if (ids.length==1)
+                if (@database.getTrackById(ids[0].databaseId)!=nil)
+                    ItunesController::ItunesControllerLogging::info("Track '#{path}' allready in the database with the id #{ids[0].databaseId}")
+                    return nil
+                end
+                track=ids[0]
+                @database.addTrack(track) 
+                count=@database.getParam(ItunesController::Database::PARAM_KEY_TRACK_COUNT,0).to_i
+                count=count+1
+                @database.setParam(ItunesController::Database::PARAM_KEY_TRACK_COUNT,count)
+                ItunesController::ItunesControllerLogging::info("Added track '#{path}' with id #{ids[0].databaseId}")
+                return track
+            else
+                ItunesController::ItunesControllerLogging::info("Uable to add track #{path}")
+                return nil
+            end
+        end
+
+        def getTrack(path)
+            trackInfo=@database.getTrack(path)
+            if (trackInfo==nil)
+                ItunesController::ItunesControllerLogging::debug("Unable to find track with path: "+path)
+                return nil
+            end
+            foundTracks=@controller.searchLibrary(trackInfo.title)
+            tracks=[]
+            foundTracks.each do | t |
+                if (@controller.getTrackDatabaseId(t) == trackInfo.databaseId)
+                    tracks.push(t)
+                end
+            end
+            if (tracks.length==1)
+                return tracks[0]
+            else
+                return nil
+            end
+        end
+
+        def trackInLibrary?(path)
+            trackInfo=@database.getTrack(path)
+            return (trackInfo!=nil)
+        end
+
+        def cacheTracks(force=false)
+            if (force || needsRecacheTracks())
+                ItunesController::ItunesControllerLogging::info("Caching tracks...")
+                @database.removeTracks()
+                @database.setParam(ItunesController::Database::PARAM_KEY_TRACK_COUNT,@controller.getTrackCount())
+                size=@controller.getTracks() { |t,count,size,dead|
+                    if (dead)
+                        ItunesController::ItunesControllerLogging::warn("Found dead track with databaseID #{t.databaseId}")
+                        @database.addDeadTrack(t)
+                    else
+                        @database.addTrack(t)
+                    end
+                }
+                return true
+            else
+                ItunesController::ItunesControllerLogging::debug("Tracks uptodate")
+            end
+            return false
+        end
+
+        def findDeadTracks()
+            return @database.getDeadTracks()
+        end
+
+        def removeDeadTracks()
+            count=0
+            deadTracks=findDeadTracks()
+            deadTracks.each do | track |
+                removeTrackByInfo(track)
+                count+=1
+            end
+            return count
+        end
+
+        def getItunesVersion
+            return @controller.version
+        end
+
+        def close()
+            @database.close()
+        end
+
+    private
+        def needsRecacheTracks()
+            # TODO better checks for changes between the cache and iTunes
+            count=@controller.getTrackCount()
+            cacheCount=@database.getParam(ItunesController::Database::PARAM_KEY_TRACK_COUNT,0).to_i
+            if (count!=cacheCount)
+                ItunesController::ItunesControllerLogging::debug("Need to reach tracks. iTunes has #{count} and cache has #{cacheCount}.")
+                return true
+            end
+            return false
+        end    
+    end
+
+end