apt-repair-sources 0.0.1

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2011, Till Klampaeckel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,29 @@
+## apt-repair-sources
+
+Find broken packages in your sources.list (or sources.list.d/*). This code is [BSD licensed][bsd].
+
+[bsd]: http://www.opensource.org/licenses/bsd-license.php
+
+### Setup
+
+ 1. best install REE
+ 2. `gem install trollop`
+ 3. clone this repo
+
+### USAGE
+
+Display broken entries on your system:
+
+    ./apt-repair-sources.rb --dry-run
+
+Fix broken entries:
+
+    ./apt-repair-sources.rb --fix-it-for-me
+
+
+### TODO
+
+ * Step 1: display what's broken (**DONE**)
+ * Step 2: fix it (**DONE**)
+ * Step 3: autocorrect entries (e.g. distro moves from a mirror to archive, to old-releases)
+

data/apt-repair-sources.gemspec

@@ -0,0 +1,51 @@
+
+# -*- encoding: utf-8 -*-
+$:.push('lib')
+require "apt/repair/sources/version"
+
+Gem::Specification.new do |s|
+  s.name     = "apt-repair-sources"
+  s.version  = Apt::Repair::Sources::VERSION.dup
+  s.date     = "2011-11-23"
+  s.summary  = "A tool to clean up your sources.list"
+  s.email    = "till@php.net"
+  s.homepage = "http://github.com/lagged/apt-repair-sources"
+  s.authors  = ['Till Klampaeckel']
+  
+  s.description = <<-EOF
+A tool to clean up your sources.list:
+
+ * apt-repair-sources -d: let's you examine your current sources
+ * apt-repair-sources -f: attempts to fix them
+
+apt-repair-sources checks the following locations:
+
+ * /etc/apt/sources.list
+ * /etc/apt/sources.list.d/*.list
+
+EOF
+  
+  dependencies = [
+    [:runtime,     "trollop",  "~> 1.16.2"],
+    [:development, "test-unit", "~> 2.4.1"],
+  ]
+  
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = "1.3.6"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+  
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

data/bin/apt-repair-sources

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+#
+# Author:    Till Klampaeckel
+# License:   New BSD License, http://www.opensource.org/licenses/bsd-license.php
+# Setup:     gem install trollop
+# Copyright: 2011 Till Klampaeckel
+#
+
+require 'rubygems'
+require 'trollop'
+require 'net/http'
+
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require 'apt/repair/sources'
+
+ubuntu = `lsb_release -i|awk '{print $3}'`.gsub(/\s+/, "")
+if (ubuntu != 'Ubuntu') 
+  puts "Ubuntu-only, currently."
+  exit 1
+end
+
+work = []
+
+if File.exist?("/etc/apt/sources.list") 
+  work.push("/etc/apt/sources.list")
+end
+
+if File.directory?("/etc/apt/sources.list.d")
+  work += Dir["/etc/apt/sources.list.d/*.list"]
+end
+
+if work.length == 0
+  puts "Nothing to be done."
+  exit
+end
+
+opts = Trollop::options do
+  version "apt-repair-sources 0.1.0 (c) 2011 Till Klampaeckel"
+  banner <<-EOS
+This tool helps you clean out bad entries from apt's sources.
+
+Usage:
+
+    sudo apt-repair-sources --dry-run|--fix-it-for-me
+EOS
+  opt :dry_run, "Display bad entries, this is enabled by default (no changes)", :default => false
+  opt :fix_it_for_me, "Remove bad entries from the sources (changes will be made)", :default => false
+end
+
+if opts[:dry_run] == true && opts[:fix_it_for_me] == true
+  puts "Cannot have both."
+  exit 1
+else
+  if opts[:fix_it_for_me_given] && opts[:fix_it_for_me] == true
+    dry_run = false
+  else
+    dry_run = true
+  end
+end
+
+p = Apt::Repair::Sources::find_platform
+
+work.each do |f| 
+  File.open(f, "r") do |infile|
+    keep = []
+    err  = 0
+    while (l = infile.gets) 
+
+      if l.nil? || l.empty? 
+        next
+      end
+
+      unless l[0,3] == 'deb' || l[0,7] == 'deb-src'
+        next
+      end
+
+      helper = Apt::Repair::Sources.new(l)
+      url    = helper.get_url(nil)
+      el     = helper.get_el
+
+      has_error = false
+
+      el.each do |t|
+
+        break if has_error == true
+
+        uri  = url + t
+        uri += helper.get_end
+
+        if helper.uri_exists(uri) == true
+          next
+        end
+
+        has_error = true
+
+        err += 1
+
+        if dry_run == true
+          puts "#{f}: #{uri}"
+        end
+
+      end
+
+      if has_error == true
+        keep.push(helper.fix_line)
+      else
+        keep.push(l)
+      end
+
+    end
+
+    # save to be safe
+    if dry_run == false && err > 0
+      File.open(f, 'w') do |f|
+        f.write(keep.join("\n"))
+      end
+    end
+
+    if err == 0 && dry_run == true
+      puts "There are no errors in #{f}"
+    end
+
+  end
+end

data/lib/apt/repair/sources.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+#
+# Author:    Till Klampaeckel
+# License:   New BSD License, http://www.opensource.org/licenses/bsd-license.php
+# Copyright: 2011 Till Klampaeckel
+#
+
+module Apt
+  module Repair
+    # @author Till Klampaeckel
+    class Apt::Repair::Sources
+
+      # @param [String] line A line from a source.list file.
+      # @return [AptRepairSources]
+      def initialize(line)
+        @l = line
+        @e = line.split(" ")
+      end
+
+      # @return [String] The architecture: amd64, i686
+      def self.find_platform
+        return `dpkg --print-architecture`.gsub(/\s+/, "")
+      end
+
+      # Each 'line' in a sources.list file contains various elements, this is an array
+      # with them. type (deb, deb-src), url and distribution are stripped. 
+      # @return [Array]
+      def get_el
+        el = @l.split(" ")
+
+        el.shift
+        el.shift
+        el.shift
+
+        return el
+      end
+
+      # @return [String] For the URL test!
+      def get_end
+        if self.get_type == 'deb'
+          return "/binary-#{self.class.find_platform}/Packages.gz"
+        end
+        return "/source/Sources.gz"
+      end
+
+      # @return [String] The type: most likely deb or deb-src
+      def get_type
+        return @e[0]
+      end
+
+      # @return [String] Create the base url to test against.
+      def get_url(base = nil)
+        if base.nil?
+          url = @e[1]
+        else
+          url = base
+        end
+        if url[-1,1] != "/"
+          url += "/"
+        end
+        url += "dists/" + @e[2] + "/"
+        return url
+      end
+
+      # Tries to fix a line from a sources.list file by correcting the URL or commenting
+      # it out. When the URL is corrected, we attempt to test if the new URL exists. The
+      # the failover is always to comment it out.
+      # @return [String]
+      def fix_line
+        el = @l.split(" ")
+
+        u = URI(el[1])
+
+        disable = false
+
+        case u.host
+        when "releases.ubuntu.com"
+          c      = u.host
+          u.host = "archive.ubuntu.com"
+          if self.uri_exists(self.get_url(u.to_s)) == false
+            u.host = c
+          end
+        when "archive.ubuntu.com", "security.ubuntu.com"
+          c      = u.host
+          u.host = "old-releases.ubuntu.com"
+          if self.uri_exists(self.get_url(u.to_s)) == false
+            u.host = c
+          end
+        when "old-releases.ubuntu.com"
+          raise Exception, "You're fucked."
+        else
+          # this is tricky, e.g. is the mirror down or did it move?
+          c = u.host
+
+          if c =~ /(.*)\.releases\.ubuntu\.com/
+            u.host = "archive.ubuntu.com"
+          elsif c =~ /(.*)\.archive\.ubuntu\.com/
+            u.host = "old-releases.ubuntu.com"
+          else
+            disable = true
+          end
+
+          if disable == false
+            if self.uri_exists(u.to_s) == false
+              u.host = c
+            end
+          end
+
+        end
+
+        el[1] = u.to_s
+        line  = el.join(" ")
+
+        if disable == true
+          line = '#' + line
+        end
+
+        return line
+      end
+
+      # Check if a URL exists by issueing a HEAD request.
+      # @param [String] URL
+      # @return [Boolean]
+      def uri_exists(url)
+
+        u = URI(url)
+
+        Net::HTTP.start(u.host, u.port) do |http|
+          http.open_timeout = 1
+          http.read_timeout = 1
+          res = http.head(u.path)
+
+          if res.code == "200"
+            return true
+          end
+          return false
+        end
+      end
+
+    end
+  end
+end

data/lib/apt/repair/sources/version.rb

@@ -0,0 +1,7 @@
+module Apt
+  module Repair
+    module Sources
+      VERSION = '0.0.1'
+    end
+  end
+end

data/tests/AptRepairSourcesTest.rb

@@ -0,0 +1,58 @@
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require 'rubygems'
+require 'net/http'
+require 'apt/repair/sources'
+require 'test/unit'
+
+class AptRepairSourcesTest < Test::Unit::TestCase
+  def test_type
+    l = "deb http://archive.ubuntu.com/ubuntu/ lucid main restricted universe multiverse"
+
+    helper = Apt::Repair::Sources.new(l)
+
+    assert_equal("deb", helper.get_type)
+  end
+
+  def test_url
+    l = "deb http://archive.ubuntu.com/ubuntu/ lucid main restricted universe multiverse"
+
+    helper = Apt::Repair::Sources.new(l)
+
+    u  = helper.get_url(nil)
+    el = helper.get_el
+
+    el.each do |t|
+      c = u + t + helper.get_end
+      assert_equal(true, helper.uri_exists(c))
+    end
+
+  end
+
+  # Karmic moved from archive to old-releases.
+  def test_archive
+    l = "deb http://archive.ubuntu.com/ubuntu/ karmic main universe"
+    e = "deb http://old-releases.ubuntu.com/ubuntu/ karmic main universe"
+
+    helper = Apt::Repair::Sources.new(l)
+    assert_equal(e, helper.fix_line)
+  end
+
+  # Apt::Repair::Sources::get_url - parameter test
+  def test_get_url
+    l = "deb-src http://security.ubuntu.com/ubuntu karmic-security main universe"
+
+    helper = Apt::Repair::Sources.new(l)
+    assert_equal("http://security.ubuntu.com/ubuntu/dists/karmic-security/", helper.get_url(nil))
+
+    assert_equal("http://old-releases.ubuntu.com/ubuntu/dists/karmic-security/", helper.get_url("http://old-releases.ubuntu.com/ubuntu"))
+  end
+
+  # Assert that old entries move according to plan.
+  def test_multiverse_security
+    l = "deb-src http://security.ubuntu.com/ubuntu karmic-security main universe"
+    e = "deb-src http://old-releases.ubuntu.com/ubuntu karmic-security main universe"
+
+    helper = Apt::Repair::Sources.new(l)
+    assert_equal(e, helper.fix_line)
+  end
+end

data/tests/LearningRubyTest.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require 'net/http'
+
+class LearningRubyTest < Test::Unit::TestCase
+  def test_uri
+    u = URI('http://example.org/path?query=string')
+    u.host = 'example2.org'
+
+    assert_equal('http://example2.org/path?query=string', u.to_s)
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: apt-repair-sources
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Till Klampaeckel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-23 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 83
+        segments: 
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 2
+        - 4
+        - 1
+        version: 2.4.1
+  type: :development
+  version_requirements: *id002
+description: |+
+  A tool to clean up your sources.list:
+  
+   * apt-repair-sources -d: let's you examine your current sources
+   * apt-repair-sources -f: attempts to fix them
+  
+  apt-repair-sources checks the following locations:
+  
+   * /etc/apt/sources.list
+   * /etc/apt/sources.list.d/*.list
+  
+email: till@php.net
+executables: 
+- apt-repair-sources
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/apt-repair-sources
+- LICENSE
+- README.md
+- tests/AptRepairSourcesTest.rb
+- tests/LearningRubyTest.rb
+- apt-repair-sources.gemspec
+- lib/apt/repair/sources.rb
+- lib/apt/repair/sources/version.rb
+has_rdoc: true
+homepage: http://github.com/lagged/apt-repair-sources
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A tool to clean up your sources.list
+test_files: []
+