macutils.rb

#!/usr/bin/env ruby
# date: 2012-01-12
# author: nate
# description: utility functions for mac administration

require 'rubygems'
require 'FileUtils'
require 'pathname'
require 'open-uri'
require 'openssl'
require 'json'

class Macutils
  
  
  # user and group tools
  
  # returns: string
  def get_current_user
    #@user = Etc.getlogin.chomp
    # Etc method may just report the user currently running the process.
    # test this.
    @user = %x(ls -l /dev/console | awk '{ print $3 }')
    if @user == "root" || nil
      @user = nil
    else
      @user.chomp
    end
  end
  
  # expects: string, user name, populated by get_ methods
  # returns: string
  def get_full_name(user)
    begin
      Etc.getpwnam("#{user}")["gecos"].chomp
      # or with dscl
      # %x(dscl /Search -read /Users/#{user} dsAttrTypeNative:cn).split.drop(1).join(" ")      
    rescue Exception => e
    end
    
  end
  
  # expects: string, user name, possibly populated by methods above
  # returns: string
  def get_homedir(user)
    begin
      Etc.getpwnam("#{user}")["dir"].chomp
      # or with dscl
      #homedir = %x(dscl . -read /users/#{user} NFSHomeDirectory).gsub(/NFSHomeDirectory: /,"")
    rescue Exception => e
    end    
  end
  
  # returns: array
  def get_admins
    `dscl . -read /groups/admin GroupMembership`.split.drop(1)
  end
  
  # returns: hash of hashes in this form {"user" => 1209765}
  def get_all_over500_users
    user_hash = {}
    `dscl . -list /users UniqueID | sort -k2 -n`.split("\n").each do |pair|
      pair.split(" ").collect! { user_hash[pair.split(" ")[0]] = pair.split(" ")[1].to_i}
    end
    user_hash.delete_if {|k,v| v.to_i < 500 }
    # can also do it like this, but it reports all directory entries, not just local
    # Etc.passwd { |d| user_hash[d.name] = d.uid if d.uid > 500 }
  end
  
  
  
  # networking
  
  # returns: array of interface names
  def get_interfaces
      @list = %x(/usr/sbin/networksetup -listallnetworkservices).split("\n").drop(1)
  end
  
  # expects: array, populated by get_interfaces method
  # returns: string
  # for now, just outputs what it would do.
  # will return maybe nothing unless error.
  def set_proxyurl(interfaces)
      if interfaces.is_a?(Array)
        interfaces.each do |nic|
            puts "/usr/sbin/networksetup -setautoproxyurl #{nic} http://llnobody/proxy.pac"
        end
      else
          puts "no interfaces passed. try again."
      end
  end
  
  # process tools
  def kill_process(process)
    # attempt to kill by name
    # should probably do this using proctable or other built-in
  end
  
  # pkg tools
  
  # expects: list or array
  # returns: feedback the apps are uninstalled
  def uninstall_app(*args)
    # remove files based on pkg info (boms)
    # or
    # just remove the app directory
    # check munki for tips on how to do this cleanly.
    # i'm inclined to skip this for now.
  end
  
  # expects: list or array of pkgids as args, ex: com.apple.iLife
  # returns: string
  # should return notification and pkgids removed
  def forget_pkgs(*args)
    args.each do |receipt|
      known_pkgs = %x(pkgutil --pkgs).split
      if known_pkgs.include?(receipt.to_s)
        puts "#{receipt} is in receipts database. removing now."
        %x(pkgutil --forget #{receipt})
      else
        puts "#{receipt} is not in receipts database. stopping."
      end
    end
  end
  
  # expects: list or array of file paths
  # returns: string, confirmation of deletion
  def remove_paths(*args)
    args.each do |item|
      if File.directory?(item)
        puts "#{item} is a path. removing it now."
        # set :noop => true to do a dry run
        FileUtils.rm_rf(item, :verbose => true)
      else
        puts "#{item} doesn't exist or isn't a directory."
      end
    end
  end
  
  # expects: string, name of receipt file, ex: com.apple.blob
  # returns: nothing
  # adds file to jamf specific dummy receipts folder
  def create_dummy_receipt(receipt)
    File.new("/Library/Application\ Support/JAMF/Receipts/#{receipt}", "w") {}
  end
  
  # misc. tools
  
  # expects: strings (file name or source path, destination path)
  # returns: string
  # notifies of copying file or files to spot under user's homedir.
  # assumes passing full path to the file to be copied.
  # needs work before using.
  # fra-gee-lay
  def stash_user_file(file,path)
      users = get_all_over500_users
      users.each_key do |u|
          puts "copying files to #{u}\'s home at #{path}."
          system "ditto -V #{file} #{get_homedir(u)}/#{path}/#{File.basename(file)}"
          FileUtils.chown_R("#{u}", nil, "#{get_homedir(u)}/#{path}/#{File.basename(file)}")
      end
  end
  
  # expects: strings for source and target paths
  # returns: nothing on success, fails otherwise
  def set_symlink(source,target)
    fail "Original path doesn't exist or isn't a directory." unless File.directory?(source)
    fail "Target already exists." unless File.directory?(target) == false
    puts "creating a symlink from #{source} => #{target}."
    FileUtils.ln_s(source,target,:verbose => true)
  end
  
  # returns: string
  def get_serial
    %x(system_profiler SPHardwareDataType | awk '/Serial/ {print $4}').upcase.chomp
  end
  
  # expects: serial number (can use get_serial to populate) and quoted proxy url (if any; see below)
  # returns: string
  # more like a bunch of text
  # cf. this is based on gary larizza's script:
  # https://github.com/glarizza/scripts/blob/master/ruby/warranty.rb
  def get_warranty(serial = "", proxy = "")
    serial = serial.upcase
    warranty_data = {}
    raw_data = open('https://selfsolve.apple.com/warrantyChecker.do?sn=' + serial.upcase + '&country=USA', :proxy => "#{proxy}")
    warranty_data = JSON.parse(raw_data.string[5..-2])

    puts "\nSerial Number:\t\t#{warranty_data['SERIAL_ID']}\n"
    puts "Product Decription:\t#{warranty_data['PROD_DESCR']}\n"
    puts "Purchase date:\t\t#{warranty_data['PURCHASE_DATE'].gsub("-",".")}"

    unless warranty_data['COV_END_DATE'].empty?
      puts "Coverage end:\t\t#{warranty_data['COV_END_DATE'].gsub("-",".")}\n"
    else
      puts "Coverage end:\t\tEXPIRED\n"
    end
  end
  
  # input: string (path) or array of strings
  # returns: string (version number, float in string form)
  # ex. get_version("/Applications/Firefox.app")
  # formatted for jss submission right now; remove results tags
  def self.get_version(apps)
      apps.each do |app|
          if File.exists?("#{app}/Contents/Info.plist")
              short = app.sub(/\/Applications\//, '')
              vers = `/usr/bin/defaults read "#{app}"/Contents/Info CFBundleShortVersionString`.chomp
              res = puts "<result>#{vers}</result>"
              $?.success? ? res : "<result>ERROR: could not get version</result>"
          else
              puts "<result>#{app} is not installed.</result>"
          end
      end
  end

  # returns: nothing
  def add_applesetupdone
    File.open("/private/var/db/.AppleSetupDone", "w") {}
  end
  
  # returns: nothing
  def add_setupregcomplete
    File.open("/Library/Receipts/.SetupRegComplete", "w") {}
  end


end

# EXAMPLES

# to use, instantiate a class object, then call the methods
# a = Macutils.new

# set proxy for all interfaces
# a.set_proxyurl(a.get_interfaces)

# remove paths passed as args
# a.remove_paths("/tmp/1", "/tmp/2")

# forget pkgs from the receipts db
# a.forget_pkgs("edu.mit.ll.ilife11", "com.done.cow")

# create a dummy receipt under jamf receipts
# a.create_dummy_receipt("Google Chrome.pkg")

# copy files to a user's homedir
# a.stash_user_file("/tmp/blorp","Library/Preferences")

# get the current machine's warranty coverage
# a.get_warranty(a.get_serial, "http://1.1.1.1:8080")