itunes-controller 0.1.0

data/README

@@ -0,0 +1,27 @@
+Information
+-----------
+
+This is a project to create make it possible 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.
+
+The server only currently runs on Mac OSX It's written in such a way that if someone 
+knows how to script iTunes from ruby on windows, then windows support could be added.
+
+Requirments
+-----------
+
+* iTunes (latest)
+* MacOS X (tested on snow leopard)
+* Mac Ruby
+
+Installation
+------------
+
+Building
+--------
+
+If you need to rebuild gem and run all the tests, then just change to the project directory and type:
+
+rake
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'yard'
+
+task :default => :all
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+YARD::Rake::YardocTask.new do |t|
+#    t.files   = ['lib/**/*.rb','bin/**/*.rb','LICENSE','README']
+    t.files   = ['lib/**/*.rb','bin/**/*.rb']
+end
+
+task :gem do
+    sh "gem build itunes-controller.gemspec"
+end
+
+desc "Execute all the build tasks"
+task :all do
+    Rake::Task['yard'].invoke
+    Rake::Task['test'].invoke    
+    Rake::Task['gem'].invoke    
+end
+
+

data/TODO

@@ -0,0 +1,8 @@
+Add support for windows iTunes
+Speed up removing files
+	- Is their a way of finding the track associated with a file path, without search though the whole library
+Replace apple script usage with ruby script bridge
+Add server command to update files in the library with new details in the file
+	- Make sure it keeps the play counts intact
+
+Add --version command line option

data/bin/addFiles.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -I../lib
+#
+# A command line util used to add 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/application'
+require 'itunesController/sqlite_creator'
+
+class App < ItunesController::Application
+
+    def displayUsage()
+        puts("Usage: "+@appName+" [options] files...") 
+        puts("")
+        puts(genericOptionDescription())
+    end
+    
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        ARGV.each do | path |
+            controller.addTrack(path)
+        end
+    end
+end
+
+app=App.new("addFiles.rb")
+app.exec()

data/bin/dummyiTunesController.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/ruby -I../lib
+#
+# 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 'tempfile'
+
+require 'itunesController/controller_creator'
+require 'itunesController/config'
+require 'itunesController/controllserver'
+require 'itunesController/dummy_itunescontroller'
+require 'itunesController/debug'
+require 'itunesController/logging'
+require 'itunesController/cachedcontroller'
+require 'itunesController/application'
+require 'itunesController/database/sqlite3_backend'
+
+class DummyControllerCreator < ItunesController::ControllerCreator
+    
+    def initialize(controller)
+        @controller = controller
+    end
+    
+    def createController()
+        return @controller
+    end
+end
+
+class App < ItunesController::Application
+
+    DEFAULT_PORT=7000
+
+    def initialize(appName,dbPath)
+        super(appName)
+        @dbPath=dbPath
+    end
+
+    # Used to display the command line useage
+    def displayUsage()
+        puts("Usage: "+@appName+" [options]")
+        puts("")
+        puts(genericOptionDescription())
+        puts("    -p, --port PORT                  The port number to start the server on. Defaults to #{DEFAULT_PORT}")
+        puts("    -c, --config FILE                The configuration file")
+    end
+
+    def checkAppOptions()
+        if (@options[:config]==nil)
+            usageError("No config file specified. Use --config option.")
+        end
+    end
+
+    def parseAppOptions(opts)
+        opts.on('-p','--port PORT','The port number to start the server on. Defaults to 7000') do |port|
+            @options[:port] = port;
+        end
+        opts.on('-c','--config FILE','The configuration file') do |value|
+            @options[:config] = value
+        end
+    end    
+
+    def createController()
+        ItunesController::DummyITunesController::resetCommandLog()
+        ItunesController::DummyITunesController::resetTracks()
+        itunes=ItunesController::DummyITunesController.new()
+        dbBackend = ItunesController::SQLite3DatabaseBackend.new(@dbPath)      
+        return DummyControllerCreator.new(ItunesController::CachedController.new(itunes,dbBackend))
+    end
+
+    def execApp(controllerCreator)
+        port=DEFAULT_PORT
+        config=ItunesController::ServerConfig.readConfig(@options[:config])
+        if (config.port!=nil) 
+            port = config.port
+        end
+        if (@options[:port]!=nil)
+            port = @options[:port]
+        end
+        server=ItunesController::ITunesControlServer.new(config,port,controllerCreator)        
+        server.join
+    end
+end
+
+dbFile = Tempfile.new('dummyDatabase.db')
+begin    
+    ItunesController::ItunesControllerLogging::info("Started dummy itunes controller with db path #{dbFile.path}")
+    app=App.new("itunesController.rb",dbFile.path)
+    app.exec()
+ensure
+    dbFile.unlink
+end
+

data/bin/itunesController.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -I../lib
+#
+# 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/config'
+require 'itunesController/controllserver'
+require 'itunesController/debug'
+require 'itunesController/logging'
+require 'itunesController/cachedcontroller'
+require 'itunesController/application'
+require 'itunesController/sqlite_creator'
+
+class App < ItunesController::Application
+
+    DEFAULT_PORT=7000
+
+    # Used to display the command line useage
+    def displayUsage()
+        puts("Usage: "+@appName+" [options]")
+        puts("")
+        puts(genericOptionDescription())
+        puts("    -p, --port PORT                  The port number to start the server on. Defaults to #{DEFAULT_PORT}")
+        puts("    -c, --config FILE                The configuration file")
+    end
+
+    def checkAppOptions()
+        if (@options[:config]==nil)
+            usageError("No config file specified. Use --config option.")
+        end
+    end
+
+    def parseAppOptions(opts)
+        opts.on('-p','--port PORT','The port number to start the server on. Defaults to 7000') do |port|
+            @options[:port] = port;
+        end
+        opts.on('-c','--config FILE','The configuration file') do |value|
+            @options[:config] = value
+        end
+    end
+    
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+
+    def execApp(controllerCreator)        
+        port=DEFAULT_PORT
+        config=ItunesController::ServerConfig.readConfig(@options[:config])
+        if (config.port!=nil) 
+            port = config.port
+        end
+        if (@options[:port]!=nil)
+            port = @options[:port]
+        end
+        server=ItunesController::ITunesControlServer.new(config,port,controllerCreator)        
+        server.join
+    end
+end
+
+app=App.new("itunesController.rb")
+app.exec()

data/bin/listDeadTracks.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby -I../lib
+#
+# A command line util used to list tracks in the iTunes library when their 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/debug'
+require 'itunesController/logging'
+require 'itunesController/application'
+require 'itunesController/sqlite_creator'
+
+class App < ItunesController::Application
+
+    def createController
+            return ItunesController::SQLLiteControllerCreator.new
+        end
+    
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        deadTracks=controller.findDeadTracks
+        count=0
+        deadTracks.each do | deadTrack | 
+            result=[]
+            result.push("Name: "+deadTrack.title)
+            result.push("Database ID: "+deadTrack.databaseId.to_s)
+            if (deadTrack.location==nil)
+                result.push("Location: Unknown")
+            else
+                result.push("Location: "+deadTrack.location)
+            end
+            ItunesController::ItunesControllerLogging::info(result.join("\n"))
+            ItunesController::ItunesControllerLogging::info("")
+            count+=1
+        end
+        ItunesController::ItunesControllerLogging::info("Found #{count} dead tracks")
+    end
+end
+
+app=App.new("listDeadTracks.rb")
+app.exec()
+

data/bin/listNewTracks.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby -I../lib
+#
+# 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/application'
+require 'itunesController/logging'
+require 'itunesController/sqlite_creator'
+
+require 'rubygems'
+require 'fileutils'
+
+class App < ItunesController::Application
+
+    MEDIA_TYPES = [".m4v","mp3",".mp4"]
+
+    # Used to display the command line useage
+    def displayUsage()
+        puts("Usage: "+@appName+" [options] directories...")
+        puts("")
+        puts(genericOptionDescription())
+    end
+
+    def checkAppOptions()
+        if ARGV.length == 0
+            usageError("No directories given.")
+        end
+        ARGV.each do | path |
+            errors = false
+            if (!File.exists?(path) || !File.directory?(path))
+               ItunesController::ItunesControllerLogging::error("#{path} is not a directory or cannot be found") 
+               errors = true
+            end 
+            if (errors)
+                exit(1)
+            end
+        end
+    end
+
+    def processMediaFiles ( controller,dir )
+        (Dir.entries(dir)- %w[ . .. ]).each { |name|
+            file=dir+"/"+name
+            if (!File.directory?(file))
+                ext=File.extname(file)
+                name=File.basename(file)
+                if (MEDIA_TYPES.index(ext)!=nil)
+                    if (!controller.trackInLibrary?(file))
+                        ItunesController::ItunesControllerLogging::info("#{file}") 
+                    end
+                end
+            else
+                processMediaFiles(controller,file)
+            end
+        }
+    end
+
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+    
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        ARGV.each do | path |
+            ItunesController::ItunesControllerLogging::info("Checking for new files in '#{path}'") 
+            processMediaFiles(controller,path)
+        end
+    end
+end
+
+app=App.new("listNewTracks.rb")
+app.exec()

data/bin/recreateTrackCache.rb

@@ -0,0 +1,31 @@
+#!/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/debug'
+require 'itunesController/logging'
+require 'itunesController/application'
+
+class App < ItunesController::Application
+
+    def createController
+        return ItunesController::SQLLiteControllerCreator.new
+    end
+    
+    def execApp(controllerCreator)
+        controller = controllerCreator.createController()
+        if (!controller.getCachedTracksOnCreate())
+            controller.cacheTracks(true)
+        end
+    end
+end
+
+app=App.new("regenerateTrackCache.rb")
+app.exec()