home_cleaner 10.8.27

data/CHANGELOG.rdoc

@@ -0,0 +1,14 @@
+=== 10.8.27
+
+* public release as gem
+* New Features
+  * The Software is configurable, now.
+  
+=== 10.1.18
+
+* 1 major enhancement
+  * Birthday!
+
+* New Features
+  * This Software cleans /Users/* safely, so that no data of local or 
+    currently logged in users are destroyed.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Sandor Szücs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,52 @@
+= HomeCleaner
+
+== DESCRIPTION
+
+home_cleaner deletes user directories on a Mac OS X computer when they are old 
+enough and not blacklisted or not logged in. This can be useful for 
+maintaining a pc lab.
+Maybe you can achieve the same with UNIX find(1). The following could be 
+sufficient: 
+
+  find /Users/* -maxdepth 0 -mtime +7 -type d -not -name Shared | xargs -n1 rm -rf
+
+== SYNOPSIS
+
+  % home_cleaner
+  clean(user1)
+  clean(user2)
+  remove /Users/user2
+  clean(admin)
+  clean(user3)
+  remove /Users/user3
+  ...
+
+== REQUIREMENTS
+
+  Ruby.
+
+== INSTALL
+
+  gem install home_cleaner
+
+== CONFIG
+
+Have a look at config/home_cleaner.yml. 
+
+== Bug reports
+
+  Please, send me an e-mail.
+
+== DEVELOPMENT
+
+To check out the source code:
+
+  git clone http://github.com/szuecs/home_cleaner.git
+  
+== AUTHORS
+
+  Sandor Szücs, sandor.szuecs@fu-berlin.de
+  
+== LICENSE
+
+See LICENSE file.

data/bin/home_cleaner

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby -wKU
+
+require 'home_cleaner'
+
+hc = HomeCleaner.new( HomeCleaner.parse_options )
+exit(hc.run)

data/config/home_cleaner.yml

@@ -0,0 +1,14 @@
+# This is the default configuration file of the home_cleaner.
+# The options are mandatory!
+
+# Threshold is the time in seconds, when to delete an account. The default is 
+# a month (2592000). Accounts older than threshold will be deleted.
+threshold: 2592000
+# Directories that never should be deleted are blacklisted.
+blacklist: 
+- "/"
+- "/Users"
+- "/Users/"
+- "/Users/admin"
+- "/Users/lokal"
+- "/Users/Shared"

data/config/test.yml

@@ -0,0 +1,8 @@
+threshold: 0
+blacklist: 
+- "/"
+- "/Users"
+- "/Users/"
+- "/Users/admin"
+- "/Users/lokal"
+- "/Users/Shared"

data/launchd/de.fuberlin.home_cleaner.plist

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Disabled</key>
+	<false/>
+	<key>Label</key>
+	<string>de.fuberlin.home_cleaner</string>
+	<key>ProgramArguments</key>
+	<array>
+		<string>home_cleaner</string>
+	</array>
+	<key>StartCalendarInterval</key>
+	<dict>
+		<key>Day</key>
+		<integer>1</integer>
+		<key>Hour</key>
+		<integer>7</integer>
+		<key>Minute</key>
+		<integer>1</integer>
+	</dict>
+</dict>
+</plist>

data/lib/home_cleaner.rb

@@ -0,0 +1,131 @@
+require "fileutils"
+require "optparse"
+require "yaml"
+
+class HomeCleaner
+  VERSION = "10.8.27"
+  
+  def self.default_options
+    {
+      :base   => "/Users",
+      :force  => nil,
+      :config => "#{File.dirname(File.expand_path(__FILE__))}/../config/home_cleaner.yml"
+    }
+  end
+  
+  def self.parse_options
+    options = self.default_options
+    
+    opts = OptionParser.new do |opts|
+      opts.on("--test", "Testmode sets base directory to HOME_CLEANER-DIR/tmp and configuration file to HOME_CLEANER-DIR/config/test.conf") do 
+        options[:base] = "#{base}/tmp"
+        options[:config]  = "#{base}/config/test.conf"
+      end
+      opts.on("--version", "Version") do |v|
+        puts "home_cleaner version: #{VERSION}"
+        exit(1)
+      end
+      opts.on("--force", "Delete all user directories that are not blacklisted or currently logged in.") do |f|
+        options[:force] = f
+      end
+      opts.on("--config <file>", "Path to a configfile that should be used instead of the default HOME_CLEANER-DIR/config/home_cleaner.yml") do |f|
+        options[:config] = f
+      end
+      if options[:help]
+        p opts.banner
+      end
+    end
+    begin
+      opts.parse!(ARGV)
+    rescue OptionParser::InvalidOption => e
+      puts e
+      puts opts
+      exit 1
+    end
+    
+    options
+  end
+  
+  def initialize(options)
+    @base_dir = options[:base]
+    @home_users = nil
+    @local_users = nil
+    @force = options[:force]
+    usage unless File.file?(options[:config])
+    config = YAML.load(File.read(options[:config]))
+    @threshold = config["threshold"]
+    @blacklist = config["blacklist"]
+  end
+  
+  def usage
+    $stderr.puts "Try running with '-h' to get a help message"
+    exit(1)
+  end
+
+  def blacklisted?(dirname)
+    @blacklist.member?(dirname)
+  end
+  
+  def too_young?(dirname)
+    if File.exists?(dirname)
+      seconds = Time.now - File.stat(dirname).mtime 
+      seconds < @threshold
+    end 
+  end
+  
+  def clean(username)
+    puts "clean(#{username})"
+    return nil unless username
+    return nil if logged_in?(username)
+    return nil if local_user?(username)
+    
+    dir = "#{@base_dir}/#{username}"
+    return nil unless dir
+    return nil unless File.directory?(dir) 
+    return nil if blacklisted?(dir)
+    
+    unless @force
+      # This is a bit hackish!
+      # modification on each login/logout
+      if too_young?("#{dir}/Library/Preferences") 
+        return nil 
+      end
+    end
+    puts "remove #{dir}"
+    FileUtils.rm_rf(dir)
+    
+    username
+  end
+  
+  # use simple caching scheme
+  def home_users
+    @home_users ||= Dir.entries(@base_dir).select {|name| ! name.match(/^\./)}
+  end
+  
+  # use simple caching scheme
+  def local_users
+    @local_users ||= `dscl . list /users`.split
+  end
+  
+  def local_user?(username)
+    local_users.member?(username)
+  end
+
+  # Shell out using users(1)
+  def logged_in?(username)
+    `users`.split.member?(username)
+  end
+  
+  def run
+    begin
+      home_users.each do |huser|
+        clean(huser)
+      end
+      0
+    rescue Exception => e
+      $stderr.puts e
+      $stderr.puts e.backtrace
+      -1
+    end
+  end
+end

data/test/test_home_cleaner.rb

@@ -0,0 +1,58 @@
+base = "#{File.dirname(File.dirname(File.expand_path(__FILE__)))}"
+$:.unshift(base)
+
+require 'test/unit'
+require 'lib/home_cleaner'
+
+class TestHomeCleaner < Test::Unit::TestCase
+  BASEDIR = "tmp"
+  
+  def setup
+    @net_users = ["testuser1","testuser2","testuser3"]
+    @logged_in =  `users`.split
+    @local_users = `dscl . list /users`.split.shuffle.take(5)
+    @test_user =   @net_users | @logged_in |  @local_users
+    
+    @test_user.each do |username|
+      STDERR.puts "create #{BASEDIR}/#{username}"
+      FileUtils.mkdir("#{BASEDIR}/#{username}")
+    end
+  end
+  def teardown
+    if BASEDIR == "tmp"
+      STDERR.puts "remove #{BASEDIR}/"
+      FileUtils.rm_rf("#{BASEDIR}") 
+      FileUtils.mkdir("#{BASEDIR}")
+    end
+  end
+  
+  def hc_new
+    HomeCleaner.new({:base => BASEDIR, :config => "#{File.dirname(File.expand_path(__FILE__))}/../config/test.yml"})
+  end
+  
+  def test_local_user?
+    hc = hc_new
+    assert_equal true, hc.local_user?("root")
+    assert_equal true, hc.local_user?(@local_users.first)
+    assert_equal false, hc.local_user?(@net_users.first)
+  end
+  
+  def test_logged_in?
+    hc = hc_new
+    testuser = `users`.split.first
+    assert_equal true, hc.logged_in?(testuser)
+  end
+  
+  def test_clean
+    hc = hc_new
+    
+    assert_equal nil, hc.clean("user_does_not_exist")
+    assert_equal nil, hc.clean(@logged_in.first)
+    assert_equal true, File.directory?("#{BASEDIR}/#{@logged_in.first}")
+    assert_equal nil, hc.clean(@local_users.first)
+    assert_equal true, File.directory?("#{BASEDIR}/#{@local_users.first}")
+    assert_equal @net_users.first, hc.clean(@net_users.first)
+    assert_equal false, File.directory?("#{BASEDIR}/#{@net_users.first}")
+  end
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: home_cleaner
+version: !ruby/object:Gem::Version 
+  hash: 89
+  prerelease: false
+  segments: 
+  - 10
+  - 8
+  - 27
+  version: 10.8.27
+platform: ruby
+authors: 
+- Sandor Szuecs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-27 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: home_cleaner deletes user directories on a Mac OS X computer when they are old enough and not blacklisted or not logged in. This can be useful for maintaining a pc lab.
+email: sandor.szuecs@fu-berlin.de
+executables: 
+- home_cleaner
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- bin/home_cleaner
+- config/home_cleaner.yml
+- config/test.yml
+- launchd/de.fuberlin.home_cleaner.plist
+- lib/home_cleaner.rb
+- README.rdoc
+- LICENSE
+- CHANGELOG.rdoc
+- test/test_home_cleaner.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/home_cleaner
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- HomeCleaner cleans the given home directory, besides blacklisted accounts and currently logged in users of your local disk.
+- --opname
+- index.html
+- --main
+- lib/home_cleaner.rb
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 59
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: home_cleaner
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: HomeCleaner cleans the given home directory, besides blacklisted accounts and currently logged in users of your local disk.
+test_files: 
+- test/test_home_cleaner.rb