iplayer-dl 0.1.16 → 0.1.17

data/Rakefile

@@ -77,7 +77,9 @@ begin
     # s.add_dependency("some_other_gem", "~> 0.1.0")
 
     # If your tests use any gems, include them here
-    s.add_development_dependency("mocha")
+    if s.respond_to?(:add_development_dependency)
+      s.add_development_dependency("mocha")
+    end
   end
 
   # This task actually builds the gem. We also regenerate a static

data/bin/iplayer-dl

@@ -3,8 +3,8 @@
 # Download iPlayer programmes by spoofing an iPhone
 # Paul Battley - http://po-ru.com/
 #
-# Get the latest version via subversion:
-# svn co http://paulbattley.googlecode.com/svn/iplayer-dl
+# Get the latest version:
+# http://github.com/threedaymonk/iplayer-dl
 
 require 'iplayer'
 require 'optparse'
@@ -134,7 +134,7 @@ pids.each_with_index do |pid, i|
           $stderr.puts "Resuming download at #{position} bytes." if position > 0
           first_chunk = false
         end
-        
+
         percentage = "%.1f" % [((1000 * position) / max) / 10.0]
         if percentage != old_percentage
           old_percentage = percentage

data/lib/iplayer.rb

@@ -3,3 +3,4 @@ require 'iplayer/browser'
 require 'iplayer/metadata'
 require 'iplayer/subtitles'
 require 'iplayer/downloader'
+require 'iplayer/constants'

data/lib/iplayer/browser.rb

@@ -22,8 +22,8 @@ module IPlayer
 class Browser
 
   # Used by Safari Mobile
-  IPHONE_UA  = 'Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420+ '+
-               '(KHTML, like Gecko) Version/3.0 Mobile/1A543a Safari/419.3'
+  IPHONE_UA  = 'Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_1_2 like Mac OS X; en-us)'+
+               'AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7D11 Safari/528.16'
 
   # Used by Quicktime
   QT_UA      = 'Apple iPhone v1.1.4 CoreMedia v1.0.0.4A102'

data/lib/iplayer/constants.rb

@@ -0,0 +1,4 @@
+module IPlayer
+  VIDEO_FILETYPE = "mp4"
+  AUDIO_FILETYPE = "mp3"
+end

data/lib/iplayer/downloader.rb

@@ -1,11 +1,11 @@
-require 'tempfile'
+require 'cgi'
 
 module IPlayer
 class Downloader
 
   IPHONE_URL     = 'http://www.bbc.co.uk/mobile/iplayer/'
+  EPISODE_URL    = 'http://www.bbc.co.uk/mobile/iplayer/episode/%s'
   SELECTOR_URL   = 'http://www.bbc.co.uk/mediaselector/3/auth/iplayer_streaming_http_mp4/%s?%s'
-  BUG_URL        = 'http://www.bbc.co.uk/iplayer/framework/img/o.gif?%d'
   MAX_SEGMENT    = 4 * 1024 * 1024
   COPY_BUFFER    = 4 * 1024 * 1024
 
@@ -43,7 +43,7 @@ class Downloader
     options['Cookie'] = cookies if cookies
     browser.get(url, options, &blk)
   end
-  
+
   def available_versions
     metadata.versions.map{ |name, vpid| Version.new(name, vpid) }
   end
@@ -58,12 +58,12 @@ class Downloader
     else
       offset = 0
     end
-    
-    File.open(path, 'a+b') do |io|    
-      location = real_stream_location(version_pid)
+
+    File.open(path, 'a+b') do |io|
+      location = real_stream_location(@pid)
       content_length = content_length_from_initial_request(location)
       yield(offset, content_length) if block_given?
-      
+
       offset.step(content_length - 1, MAX_SEGMENT) do |first_byte|
         last_byte = [first_byte + MAX_SEGMENT - 1, content_length - 1].min
         get(location, Browser::QT_UA, 'Range'=>"bytes=#{first_byte}-#{last_byte}") do |response|
@@ -85,25 +85,23 @@ private
     self.cookies = response.cookies.join('; ')
   end
 
-  def request_image_bugs
-    get(BUG_URL % [(rand * 100000).floor], Browser::IPHONE_UA)
+  def request_episode_page(pid)
+    response = get(EPISODE_URL % pid, Browser::IPHONE_UA)
+    raise ProgrammeDoesNotExist unless response.is_a?(Net::HTTPSuccess)
+    response.body
   end
 
-  def real_stream_location(version_pid)
+  def real_stream_location(pid)
     request_iphone_page
-    request_image_bugs
-
-    # Get the auth URL
-    r = (rand * 10000000).floor
-    selector = SELECTOR_URL % [version_pid, r]
-    response = get(selector, Browser::QT_UA, 'Range'=>'bytes=0-1')
-    
-    # It redirects us to the real stream location
-    location = response.to_hash['location']
-    if location =~ /error\.shtml/
+    html = request_episode_page(pid)
+    location = html[%r{http://download\.iplayer\.bbc\.co\.uk/iplayer_streaming[^"']+}]
+
+    unless location
       raise FileUnavailable
     end
-    return location
+
+    # The Beeb appear not to believe in escaping URLs, but let's unescape them in case they have an outbreak of standards compliance:
+    CGI.unescapeHTML(location)
   end
 
   def content_length_from_initial_request(location)

data/lib/iplayer/errors.rb

@@ -1,52 +1,25 @@
+require 'iplayer/translations'
+
 module IPlayer
 module Errors
   class RecognizedError < RuntimeError
-  end
-
-  class ParsingError < RecognizedError
-    def to_str
-      "Unable to parse the programme page. Perhaps the iPlayer has changed." 
-    end
-  end
+    include Translations
+    translation_namespace :errors
 
-  class OutsideUK < RecognizedError
     def to_str
-      "The BBC's geolocation has determined that you are outside the UK.\n"+
-      "You can try using a UK proxy."
+      t(self.class.name.split("::").last, :message => message)
     end
   end
 
-  class FileUnavailable < RecognizedError
-    def to_str
-      "The programme file is not currently available.\n"+
-      "If it's new, try again later."
-    end
-  end
-  
-  class MP4Unavailable < RecognizedError
-    def to_str
-      "This programme is not currently available in an MP3 or MPEG4 version."
-    end
-  end
-
-  class MetadataError < RecognizedError
-    def to_str
-      "Unable to parse the metadata for this programme.\n"+
-      "As a workaround, you can use the -f option to specify a filename manually."
-    end
-  end
-
-  class ProgrammeDoesNotExist < RecognizedError
-    def to_str
-      "There is no page for this programme.\n"+
-      "This probably means that the programme does not exist."
-    end
-  end
-
-  class NotAPid < RecognizedError
-    def to_str
-      "This does not look like a programme ID or a recognised programme URL: "+ message
-    end
+  [ :ParsingError,
+    :OutsideUK,
+    :FileUnavailable,
+    :MP4Unavailable,
+    :MetadataError,
+    :ProgrammeDoesNotExist,
+    :NotAPid
+  ].each do |klass|
+    const_set(klass, Class.new(RecognizedError))
   end
 
 end

data/lib/iplayer/gui/app.rb

@@ -56,7 +56,7 @@ class App < Wx::App
       filetype = metadata.filetype
     rescue MetadataError
       title    = pid
-      filetype = 'mov'
+      filetype = VIDEO_FILETYPE
     end
     "#{ title }.#{ filetype }".gsub(/[^a-z0-9 \-\.]+/i, '')
   end

data/lib/iplayer/gui/frame.rb

@@ -0,0 +1,78 @@
+require 'wx'
+require 'forwardable'
+
+module IPlayer
+module GUI
+class Frame < Wx::Frame
+  include Wx
+  extend Forwardable
+  AUTO = -1
+
+  class SizerProxy
+    def initialize(frame, sizer)
+      @frame, @sizer = frame, sizer
+    end
+
+    def method_missing(method, *args, &blk)
+      default_border =
+        case method
+        when :h_sizer, :v_sizer
+          0
+        else
+          4
+        end
+      options    = args.last.is_a?(Hash) ? args.pop : {}
+      proportion = options.delete(:proportion) || 0
+      flags      = options.delete(:flags) || Wx::ALL
+      border     = options.delete(:border) || default_border
+      args << options unless options.empty?
+      control = @frame.__send__(method, *args, &blk)
+      @sizer.add(control, proportion, flags, border)
+      control
+    end
+  end
+
+  def_delegators :@status_bar, :set_status_text
+
+  def sizer(alignment, &blk)
+    s = BoxSizer.new(alignment)
+    proxy = SizerProxy.new(self, s)
+    blk.call(proxy) if block_given?
+    s
+  end
+  def v_sizer(&blk) sizer(VERTICAL, &blk); end
+  def h_sizer(&blk) sizer(HORIZONTAL, &blk); end
+
+  def label(text)
+    StaticText.new(self, -1, text)
+  end
+
+  def field(default_text="", options={})
+    width    = options[:width] || -1
+    height   = options[:height] || -1
+    tool_tip = options[:tool_tip]
+    enter    = options[:enter]
+    f = TextCtrl.new(self, -1, default_text, DEFAULT_POSITION, Size.new(width, height))
+    f.set_tool_tip(tool_tip) if tool_tip
+    f
+  end
+
+  def gauge
+    Gauge.new(self, -1, 1, DEFAULT_POSITION, DEFAULT_SIZE, GA_HORIZONTAL|GA_SMOOTH)
+  end
+
+  def button(handler, text)
+    b = Button.new(self, -1, text)
+    evt_button(b.get_id){ |e| __send__(handler, e) }
+    b
+  end
+
+  def status_bar(widths)
+    @status_bar = StatusBar.new(self, -1, 0)
+    @status_bar.set_fields_count(widths.length)
+    @status_bar.set_status_widths(widths)
+    set_status_bar(@status_bar)
+  end
+end
+end
+end

data/lib/iplayer/gui/main_frame.rb

@@ -1,34 +1,18 @@
-require 'wx'
+require 'iplayer/gui/frame'
 require 'iplayer/errors'
+require 'iplayer/translations'
 
 module IPlayer
 module GUI
-class MainFrame < Wx::Frame
-  include Wx
+class MainFrame < Frame
   include IPlayer::Errors
+  include Translations
+  translation_namespace :gui
 
   def initialize(app)
     @app = app
-
     super(nil, -1, @app.name, DEFAULT_POSITION, DEFAULT_SIZE, CAPTION|MINIMIZE_BOX|CLOSE_BOX|SYSTEM_MENU)
 
-    @pid_label = StaticText.new(self, -1, "Programme ID")
-    @pid_field = TextCtrl.new(self, -1, "", DEFAULT_POSITION, Size.new(300,-1))
-    @pid_field.set_tool_tip("Use either the short alphanumeric programme identifier or the URL of the viewing page on the iPlayer website.")
-    @download_progress = Gauge.new(self, -1, 1, DEFAULT_POSITION, DEFAULT_SIZE, GA_HORIZONTAL|GA_SMOOTH)
-    @stop_button = Button.new(self, -1, "Stop")
-    evt_button(@stop_button.get_id){ |e| stop_button_clicked(e)   }
-    @stop_button.disable
-    @download_button = Button.new(self, -1, "Download...")
-    evt_button(@download_button.get_id){ |e| download_button_clicked(e) }
-    @about_button = Button.new(self, -1, "About...")
-    evt_button(@about_button.get_id){ |e| about_button_clicked(e) }
-    @status_bar = StatusBar.new(self, -1, 0)
-    @status_bar.set_fields_count(3)
-    @status_bar.set_status_widths([-1, 60, 60])
-    set_status_bar(@status_bar)
-    @status_bar.set_status_text("Waiting", 0)
-
     set_properties
     do_layout
   end
@@ -44,34 +28,40 @@ class MainFrame < Wx::Frame
   end
 
   def do_layout
-    sizer_main = BoxSizer.new(VERTICAL)
-    sizer_buttons = BoxSizer.new(HORIZONTAL)
-    sizer_input = BoxSizer.new(HORIZONTAL)
-    sizer_input.add(@pid_label, 0, ALL|ALIGN_CENTER_VERTICAL, 4)
-    sizer_input.add(@pid_field, 0, ALL|EXPAND|ALIGN_CENTER_VERTICAL, 4)
-    sizer_main.add(sizer_input, 0, EXPAND, 0)
-    sizer_main.add(@download_progress, 0, ALL|EXPAND, 4)
-    sizer_buttons.add(@about_button, 0, ALL, 4)
-    sizer_buttons.add(@stop_button, 0, ALL, 4)
-    sizer_buttons.add(@download_button, 0, ALL, 4)
-    sizer_main.add(sizer_buttons, 0, ALIGN_RIGHT|ALIGN_CENTER_HORIZONTAL, 0)
+    sizer_main = v_sizer{ |main|
+      main.h_sizer(:flags => EXPAND){ |input|
+        input.label(t(:pid), :flags => ALL|ALIGN_CENTER_VERTICAL)
+        @pid_field = input.field("",
+                     :width    => 300,
+                     :tool_tip => t(:pid_tool_tip),
+                     :flags    => ALL|EXPAND|ALIGN_CENTER_VERTICAL)
+      }
+      @download_progress = main.gauge(:flags => ALL|EXPAND)
+      main.h_sizer(:flags => ALIGN_RIGHT|ALIGN_CENTER_HORIZONTAL){ |buttons|
+        buttons.button(:show_about, t(:about_button))
+        @stop_button = buttons.button(:abort_download, t(:stop_button))
+        @download_button = buttons.button(:begin_download, t(:download_button))
+      }
+    }
+    status_bar([AUTO, 60, 60])
     self.set_sizer(sizer_main)
     sizer_main.fit(self)
     layout
     centre
+    set_status_text(t(:status_waiting), 0)
   end
 
-  def stop_button_clicked(event)
+  def abort_download(event)
     @app.stop_download!
-    @status_bar.set_status_text("Stopped", 0)
+    set_status_text(t(:status_stopped), 0)
     @download_button.enable
     @stop_button.disable
   end
 
-  def download_button_clicked(event)
+  def begin_download(event)
     pid = @pid_field.get_value
     if pid.empty?
-      message_box('You must specify a programme ID before I can download it.')
+      message_box(t(:no_pid_given))
       return
     else
       begin
@@ -85,11 +75,11 @@ class MainFrame < Wx::Frame
     @download_button.disable
     filename = @app.get_default_filename(pid)
 
-    fd = FileDialog.new(nil, 'Save as', '', filename, 'iPlayer Programmes|*.mov;*.mp3|', FD_SAVE)
+    fd = FileDialog.new(nil, t(:save_dialog_title), '', filename, "#{t(:file_types)}|*.#{VIDEO_FILETYPE};*.#{AUDIO_FILETYPE}|", FD_SAVE)
 
     if fd.show_modal == ID_OK
       path = fd.get_path
-      @status_bar.set_status_text(File.basename(path), 0)
+      set_status_text(File.basename(path), 0)
       @download_button.disable
       @stop_button.enable
       begin
@@ -97,20 +87,20 @@ class MainFrame < Wx::Frame
           @download_progress.set_range(max)
           @download_progress.set_value(position)
           percentage = "%.1f" % [((1000.0 * position) / max).round / 10.0]
-          @status_bar.set_status_text("#{(max.to_f / 2**20).round} MiB", 1) 
-          @status_bar.set_status_text(percentage+"%", 2) 
+          set_status_text("#{(max.to_f / 2**20).round} MiB", 1)
+          set_status_text(percentage+"%", 2)
         end
       rescue RecognizedError => error
-        message_box(error.to_str, :title => 'Error')
+        message_box(error.to_str, :title => t(:error_title))
       rescue Exception => error
-        message_box("#{error.message} (#{error.class})\n#{error.backtrace.first}", :title => 'Error')
+        message_box("#{error.message} (#{error.class})\n#{error.backtrace.first}", :title => t(:error_title))
       end
       @stop_button.disable
     end
     @download_button.enable
   end
 
-  def about_button_clicked(event)
+  def show_about(event)
     @app.show_about_box
   end
 

data/lib/iplayer/metadata.rb

@@ -1,5 +1,6 @@
 require 'rexml/document'
 require 'iplayer/errors'
+require 'iplayer/constants'
 
 module IPlayer
 class Metadata
@@ -21,7 +22,7 @@ class Metadata
   end
 
   def filetype
-    radio? ? 'mp3' : 'mov'
+    radio? ? AUDIO_FILETYPE : VIDEO_FILETYPE
   end
 
   def versions

data/lib/iplayer/translations.rb

@@ -0,0 +1,60 @@
+module Translations
+  STRINGS = {
+    :gui => {
+      :pid               => "Programme ID",
+      :stop_button       => "Stop",
+      :download_button   => "Download ...",
+      :about_button      => "About ...",
+      :status_waiting    => "Waiting",
+      :pid_tool_tip      => "Use either the short alphanumeric programme identifier or "+
+                            "the URL of the viewing page on the iPlayer website.",
+      :status_waiting    => "Waiting",
+      :no_pid_given      => "You must specify a programme ID before I can download it.",
+      :save_dialog_title => "Save As",
+      :file_types        => "iPlayer programmes",
+      :error_title       => "Error",
+    },
+    :errors => {
+      :OutsideUK =>
+        "The BBC's geolocation has determined that you are outside the UK.\n"+
+        "You can try using a UK proxy.",
+      :FileUnavailable =>
+        "The programme file is not currently available.\n"+
+        "If it's new, try again later.",
+      :MP4Unavailable =>
+        "This programme is not currently available in an MP3 or MPEG4 version.",
+      :MetadataError =>
+        "Unable to parse the metadata for this programme.\n"+
+        "As a workaround, you can use the -f option to specify a filename manually.",
+      :ProgrammeDoesNotExist =>
+        "There is no page for this programme.\n"+
+        "This probably means that the programme does not exist.",
+      :NotAPid =>
+        "This does not look like a programme ID or a recognised programme URL: {{message}}",
+    }
+  }
+
+  module ClassMethods
+    def translation_namespace(ns)
+      @translation_namespace = ns
+    end
+
+    def get_translation_namespace
+      if ancestors[1].respond_to?(:get_translation_namespace)
+        ancestors[1].get_translation_namespace
+      else
+        []
+      end + [@translation_namespace]
+    end
+  end
+
+  def t(key, methods={})
+    [self.class.get_translation_namespace, key.to_s].flatten.compact.join(".").split(".").inject(STRINGS){ |hash, subkey|
+      hash[subkey.to_sym]
+    }.gsub(/\{\{([^\}]+)\}\}/){ methods[$1.to_sym] }
+  end
+
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+end

data/lib/iplayer/version.rb

@@ -1,4 +1,4 @@
 module IPlayer
-  VERSION     = '0.1.16'
-  GUI_VERSION = '1.12'
+  VERSION     = '0.1.17'
+  GUI_VERSION = '1.13'
 end

data/test/test_metadata.rb

@@ -5,7 +5,7 @@ require 'mocha'
 
 class MetadataTest < Test::Unit::TestCase
 
-  def test_should_return_mov_for_tv_filetype
+  def test_should_return_mp4_for_tv_filetype
     xml = %{
       <?xml version="1.0" encoding="UTF-8"?>
       <playlist xmlns="http://bbc.co.uk/2008/emp/playlist" revision="1">
@@ -16,7 +16,7 @@ class MetadataTest < Test::Unit::TestCase
     pid = 'abc'
     browser = stub(:get => stub(:body => xml))
     metadata = IPlayer::Metadata.new(pid, browser)
-    assert_equal 'mov', metadata.filetype
+    assert_equal 'mp4', metadata.filetype
   end
 
   def test_should_return_mp3_for_radio_filetype

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: iplayer-dl
 version: !ruby/object:Gem::Version 
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors: 
 - Paul Battley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 +01:00
+date: 2009-12-16 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,36 +35,33 @@ files:
 - README
 - setup.rb
 - Rakefile
-- lib/
-- lib/iplayer
+- lib/iplayer.rb
 - lib/iplayer/version.rb
-- lib/iplayer/browser.rb
-- lib/iplayer/downloader.rb
+- lib/iplayer/translations.rb
+- lib/iplayer/subtitles.rb
 - lib/iplayer/preferences.rb
-- lib/iplayer/gui
-- lib/iplayer/gui/app.rb
+- lib/iplayer/metadata.rb
 - lib/iplayer/gui/main_frame.rb
-- lib/iplayer/subtitles.rb
+- lib/iplayer/gui/frame.rb
+- lib/iplayer/gui/app.rb
 - lib/iplayer/errors.rb
-- lib/iplayer/metadata.rb
-- lib/iplayer.rb
-- test/
+- lib/iplayer/downloader.rb
+- lib/iplayer/constants.rb
+- lib/iplayer/browser.rb
+- test/test_subtitles.rb
 - test/test_preferences.rb
 - test/test_metadata.rb
-- test/test_subtitles.rb
-- bin/
-- bin/iplayer-dl
 - bin/iplayer-dl-gui
-- share/
-- share/pixmaps
-- share/pixmaps/iplayer-dl
-- share/pixmaps/iplayer-dl/icon128.png
+- bin/iplayer-dl
+- share/pixmaps/iplayer-dl/icon64.png
 - share/pixmaps/iplayer-dl/icon48.png
-- share/pixmaps/iplayer-dl/icon16.png
 - share/pixmaps/iplayer-dl/icon32.png
-- share/pixmaps/iplayer-dl/icon64.png
-has_rdoc: false
+- share/pixmaps/iplayer-dl/icon16.png
+- share/pixmaps/iplayer-dl/icon128.png
+has_rdoc: true
 homepage: http://po-ru.com/projects/iplayer-downloader
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -85,9 +82,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Download iPlayer content
 test_files: []