winprofile 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Miguel Armas
+
+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,17 @@
+= winprofile
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Miguel Armas. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "winprofile"
+    gem.summary = %Q{Manage Windows Profiles}
+    gem.description = %Q{This Gem allows you to manage Windows roving profiles stored on your servers}
+    gem.email = "kuko@canarytek.com"
+    gem.homepage = "http://github.com/kukoarmas/winprofile"
+    gem.authors = ["Miguel Armas"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "winprofile #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,7 @@
+Changes for next version
+========================
+
+- Test, test, test!!!
+- Detect folders that are not on the registry
+- Detect registry keys with no matching folder
+- Detect folders with usage over a given threshold

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/redirect_folders.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/ruby
+#
+# Redirect a user profile's folders
+#
+# We use the following defaults
+# Personal -> U:/Mis Documentos
+# ALL THE REST -> U:\.windows_settings\
+
+
+require 'rubygems'
+require 'winprofile'
+
+require 'optparse'
+require 'fileutils'
+
+# Samba profiles defaults
+@profiles="/home/samba/profiles"
+# User homes default
+@homes="/home"
+
+@verbose=false
+@debug=false
+
+# Command
+@cmd="show"
+
+def redirect
+  p=WinProfile.new(@user,@profiles,@homes)
+	p.debug=@debug
+	p.verbose=@verbose
+
+	puts "Redirecting Desktop"
+	p.redirect_folder('Desktop','U:\\.windows_settings\\Escritorio')
+	puts "Redirecting AppData"
+	p.redirect_folder('AppData','U:\\.windows_settings\\Datos de programa')
+	puts "Redirecting Personal"
+	p.redirect_folder('Personal','U:\\Mis documentos')
+end
+
+def move
+	puts "Creating #{@homes}/#{@user}/.windows_settings"
+	FileUtils.makedirs "#{@homes}/#{@user}/.windows_settings"
+	puts "Moving dirs"
+	puts "#{@homes}/samba/profiles/#{@user}/Mis\ documentos -> #{@homes}/#{@user}/Mis\ documentos"
+	FileUtils.mv "#{@homes}/samba/profiles/#{@user}/Mis\ documentos","#{@homes}/#{@user}/Mis\ documentos"
+
+	puts "#{@homes}/samba/profiles/#{@user}/Escritorio -> #{@homes}/#{@user}/.windows_settings/Escritorio"
+	FileUtils.mv "#{@homes}/samba/profiles/#{@user}/Escritorio","#{@homes}/#{@user}/.windows_settings/Escritorio"
+
+	puts "#{@homes}/samba/profiles/#{@user}/Datos de programa -> #{@homes}/#{@user}/.windows_settings/Datos de programa"
+	FileUtils.mv "#{@homes}/samba/profiles/#{@user}/Datos de programa","#{@homes}/#{@user}/.windows_settings/Datos de programa"
+end
+
+app = Hash.new
+
+options = OptionParser.new do |opts|
+  opts.on("--debug", "Debug. No action. (verbose=true)") do |opt|
+    @noop=true
+    @verbose=true
+    @debug=true
+  end
+  opts.on("--verbose", "Be verbose") do |opt|
+    @verbose=true
+  end
+  opts.on("--user [ARG]", "User profile to change") do |opt|
+    @user=opt
+  end
+  opts.on("--profiles [ARG]", "User profiles directory (default: /home/samba/profiles)") do |opt|
+    @profiles=opt
+  end
+  opts.on("--homes [ARG]", "User homes (default: /home)") do |opt|
+    @homes=opt
+  end
+  opts.on("--version", "Print version and exit") do |opt|
+    puts "version #{winprofile::VERSION}"
+    exit 0
+  end
+end
+options.parse!(ARGV)
+if ARGV.length != 1
+  puts "Missing command argument"
+  puts "Available commands"
+  puts "   show: show folder status"
+  puts "   redirect: redirect folders (only in registry)"
+  puts "   move: move folders"
+  exit 1
+end
+@cmd=ARGV.shift
+
+if ! @user
+  puts "ERROR: You need to specify e user with --user option"
+  exit 1
+end
+
+case @cmd
+	when "show"
+		p=WinProfile.new(@user,@profiles,@homes)
+		puts "Personal Folders for #{@user}"
+		#p.verbose=@verbose
+		p.verbose=true
+		p.debug=@debug
+		p.show_folders
+	when "redirect"
+		redirect
+	when "move"
+		move
+	else
+	   puts "Unknown command: #{@cmd}"
+end
+
+#FileUtils.cp_r "#{@profiles}/#{@user}","#{@home}/#{@user}/.windows_settings", :preserve=>true
+
+# FIXME: Move Mis Documentos
+
+#p=WinProfile.new("#{@home}/#{@user}/.windows_settings/NTUSER.DAT")
+#p.show_folders
+#p.redirect_folders('U:\\.windows_settings')
+#p.redirect_folders('U:\\.windows_settings')
+#p.redirect_folder('Personal','U:\\Mis documentos')
+

data/lib/winprofile.rb

@@ -0,0 +1,146 @@
+
+require 'rubygems'
+require 'winreg'
+
+#
+# WinProfile
+#
+class WinProfile
+  attr_accessor :file, :debug, :verbose, :homes, :profiles
+  attr_reader :folders
+
+  # Base regkey for folder redirection
+  FOLDERS_BASE='Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders'
+
+  # List of user folder redirection regkeys
+  FOLDER_DEFAULTS=[
+          {:name => "AppData", :dir => 'Datos de programa' },
+          {:name => "Desktop", :dir => 'Escritorio' },
+          {:name => "Favorites", :dir => 'Favoritos' },
+          {:name => "NetHood", :dir => 'Entorno de red' },
+          {:name => "Personal", :dir => 'Mis documentos' },
+          {:name => "PrintHood", :dir => 'Impresoras' },
+          {:name => "Programs", :dir => 'Menú Inicio\Programas' },
+          {:name => "SendTo", :dir => 'SendTo' },
+          {:name => "Start Menu", :dir => 'Menú Inicio' },
+          {:name => "Startup", :dir => 'Menú Inicio\Programas\Inicio' },
+          {:name => "Templates", :dir => 'Plantillas' },
+          {:name => "Local Settings", :dir => 'Configuración Local' },
+          {:name => "Local AppData", :dir => 'Configuración Local\Datos de programa' },
+          {:name => "Cache", :dir => 'Configuración Local\Archivos temporales de Internet' },
+          {:name => "Cookies", :dir => 'Cookies' },
+          {:name => "Recent", :dir => 'Reciente' },
+          {:name => "History", :dir => 'Configuración Local\Historial' },
+          ] 
+
+
+  def initialize(user=nil,profiles="/home/samba/profiles",homes="/home")
+    # Defaults
+    @profiles = profiles
+    @homes = homes
+    @folders = FOLDER_DEFAULTS
+
+    # If user=nil don't check existence, late initialization
+    if user != nil
+      # HKLU hive file
+      @file = "#{@profiles}/#{user}/NTUSER.DAT"
+      raise "Invalid profile: #{@file}" unless File.exists? @file
+    end
+  end
+
+  # Set the user whose profile we want to change
+  def user=(user)
+    # HKLU hive file
+    @file = "#{@profiles}/#{user}/NTUSER.DAT"
+
+    raise "Invalid profile: #{@file}" unless File.exists? @file
+  end
+
+  # Show folder redirection status for a given folder
+  def show_folder(folder)
+    @location=nil
+
+    w=WinReg.new(@file)
+    w.debug=@debug
+
+    FOLDER_DEFAULTS.each do |key|
+      if key[:name] == folder
+        @location = w.read_key(FOLDERS_BASE+'\\'+key[:name])
+        puts "#{key[:name]} -> #{@location}" if @verbose
+      end
+    end
+    @location
+  end
+
+  # Show folder redirection status for all folders
+  def show_folders
+
+    w=WinReg.new(@file)
+    w.debug=@debug
+
+    FOLDER_DEFAULTS.each do |key|
+      @location = w.read_key(FOLDERS_BASE+'\\'+key[:name])
+      puts "#{key[:name]} -> #{@location}" if @verbose
+    end
+  end
+
+  # Redirects a given user folders to a dir
+  def redirect_folder(folder,dir)
+
+    w=WinReg.new(@file)
+    w.debug=@debug
+
+    w.write_key(FOLDERS_BASE+'\\'+folder,dir)
+
+  end
+
+  # Redirects all user folders to given dir
+  def redirect_folders(dir)
+
+    w=WinReg.new(@file)
+    w.debug=@debug
+    FOLDER_DEFAULTS.each do |key|
+      w.write_key(FOLDERS_BASE+'\\'+key[:name],dir+'\\'+key[:dir])
+    end
+  end
+
+  # Initialize a roving profile directory structure in the given directory
+  def init_folders(dir)
+
+    FOLDER_DEFAULTS.each do |key|
+      @folder=dir+"/"+key[:dir]
+      @folder.gsub!('\\','/')
+      if not File.directory? @folder
+        File.makedirs @folder
+      end
+    end
+
+  end
+
+  # Move ALL profile folders to a new destination
+  def move_folders(orig,dest)
+    
+    puts "Moving #{orig} ->  #{dest}" if @verbose
+    FileUtils.mv orig,dest
+  end
+
+  # Move a given profile folder to a new destination
+  def move_folder(folder,orig,dest)
+    
+    puts "Moving #{orig}/#{key[:dir]} ->  #{dest}/#{key[:dir]}" if @verbose
+    FileUtils.mv "#{orig}/#{key[:dir]}", "#{dest}/#{key[:dir]}"
+
+  end
+
+  # Reset profile to default folders
+  def reset_default
+    
+    w=WinReg.new(@file)
+    w.debug=@debug
+    FOLDER_DEFAULTS.each do |key|
+      w.write_key(FOLDERS_BASE+'\\'+key[:name],'%USERPROFILE%\\'+key[:dir])
+    end
+  end 
+
+end
+

data/lib/winreg.rb

@@ -0,0 +1,83 @@
+
+require 'expect'
+require 'pty'
+
+$expect_verbose = false
+
+class WinReg
+  attr_accessor :file, :debug, :verbose
+
+  def initialize(file)
+    @file = file
+    # Check that file exists
+    if not File.exists? @file
+      puts "ERROR: File #{@file} does not exist"
+      return nil
+    end
+    # FIXME: Check that we have the chntpw command
+  end
+
+  def read_key(key)
+    @value = nil
+
+    PTY.spawn("chntpw -e #{@file}") do |read,write,pid|
+      $expect_verbose = @debug
+      write.sync = true
+
+      # If 30 seconds pass and the expected text is not found, the
+      # response object will be nil.
+      read.expect(/^>/, 5) do |response|
+        raise unless response
+        write.print "cat " + key + "\n" if response
+      end
+
+      read.expect(/^>/, 5) do |response|
+        raise unless response
+        write.print "q" + "\n" if response
+        # response is a string array
+        @found=false
+        response[0].split(/\r\n/).each do |line|
+          if @found
+            @value=line
+            break
+          end
+          @found = true if line =~ /^Value/
+        end
+      end
+    end
+
+    return @value
+  end
+
+  def write_key(key,value)
+
+    PTY.spawn("chntpw -e #{@file}") do |read,write,pid|
+      $expect_verbose = @debug
+      write.sync = true
+
+      # If 30 seconds pass and the expected text is not found, the
+      # response object will be nil.
+      read.expect(/^>/, 5) do |response|
+        raise unless response
+        write.print "ed " + key + "\n" if response
+      end
+
+      read.expect(/^->/, 5) do |response|
+        raise unless response
+        write.print value + "\n" if response
+      end
+
+      read.expect(/^>/, 5) do |response|
+        raise unless response
+        write.print "q" + "\n" if response
+      end
+
+      read.expect(/^Write hive files?/, 5) do |response|
+        raise unless response
+        write.print "y" + "\n" if response
+      end
+    end
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'winprofile'
+
+class Test::Unit::TestCase
+end

data/test/test_winprofile.rb

@@ -0,0 +1,110 @@
+require 'helper'
+require 'fileutils'
+
+class TestWinProfile < Test::Unit::TestCase
+
+  context "WinProfile" do
+    should 'raise exception when invalid profile given' do
+      assert_raise RuntimeError do
+        @winprofile=WinProfile.new("test")
+      end
+    end
+    should 'raise exception when invalid profile given in late initialization' do
+      assert_raise RuntimeError do
+        @winprofile=WinProfile.new()
+        @winprofile.user="NONEXISTENT"
+      end
+    end
+    should 'return WinProfile object when valid profile given' do
+      @winprofile=WinProfile.new("sample_profile","test")
+      assert_instance_of WinProfile, @winprofile
+    end
+    should "be able to set profile after object created" do
+      @winprofile=WinProfile.new()
+      @winprofile.profiles="test"
+      @winprofile.user="sample_profile"
+      assert_equal "test/sample_profile/NTUSER.DAT",@winprofile.file
+    end
+    should "return same object when both initialize methods are used with same parameters" do
+      @winprofile=WinProfile.new()
+      @winprofile.profiles="test"
+      @winprofile.user="sample_profile"
+      @winprofile2=WinProfile.new("sample_profile","test")
+      assert @winprofile2.file == @winprofile.file
+    end
+  end
+  
+  context "a WinProfile instance" do
+
+    setup do
+      File.copy "test/sample_profile/NTUSER.DAT","test/NTUSER.DAT"
+      @winprofile=WinProfile.new("sample_profile","test")
+      @winprofile.verbose=false
+    end
+
+    should "initialize folders same as FOLDER_DEFAULTS" do
+      assert_same_elements WinProfile::FOLDER_DEFAULTS,@winprofile.folders
+    end    
+
+    context "when asked for the 'Personal' folder key" do
+      should 'return "%USERPROFILE%\Mis documentos"' do
+        assert_equal '%USERPROFILE%\Mis documentos',@winprofile.show_folder('Personal')
+      end
+    end
+
+    context "when asked for a non_existent folder" do
+      should "return nil" do
+        assert_nil @winprofile.show_folder('non-existent')
+      end
+    end
+
+    context "when reset to defaults" do
+      setup do
+        @winprofile.reset_default
+      end
+      context "reading the 'Personal' folder" do
+        should 'return "%USERPROFILE%\Mis documentos"' do
+          assert_equal '%USERPROFILE%\Mis documentos',@winprofile.show_folder('Personal')
+        end
+      end
+      context "reading all folders" do
+        should "return DEFAULT_FOLDERS constant" do
+          @winprofile.show_folders
+          assert_equal WinProfile::FOLDER_DEFAULTS,@winprofile.show_folders
+        end
+      end
+    end
+
+    #context "when initializing profile folders" do
+    #  setup do
+    #    FileUtils.rm_rf("test/tmp/sample_profile")
+    #  end
+
+      #should "get correct folders" do
+      #  @winprofile.init_folders("test/tmp/sample_profile")
+      #  Dir.chdir("test/sample_profile")
+      #  @sample_profile=Dir.glob("*/")
+      #  Dir.chdir("../..")
+      #  assert_same_elements @sample_profile,Dir.entries("test/tmp/sample_profile")
+      #end
+    #end
+
+    context "when moving profile folders" do
+      setup do
+        # Remove orig
+        FileUtils.rm_rf("test/tmp/orig_profile")
+        # Remove dest
+        FileUtils.rm_rf("test/tmp/dest_profile")
+        # Copy test profile
+        FileUtils.cp_r("test/sample_profile","test/tmp/orig_profile")
+      end
+
+      should "get same directories" do
+        @before=Dir.entries("test/tmp/orig_profile")
+        @winprofile.move_folders("test/tmp/orig_profile","test/tmp/dest_profile")
+        assert_same_elements @before,Dir.entries("test/tmp/dest_profile")
+      end
+    end
+  end
+end
+

data/test/test_winreg.rb

@@ -0,0 +1,27 @@
+require 'helper'
+require 'ftools'
+
+class TestWinReg < Test::Unit::TestCase
+  FOLDERS_BASE='Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders'
+
+  context "A WinReg instance" do
+    setup do
+      File.copy "test/NTUSER.DAT.SAFE","test/NTUSER.DAT"
+      @winreg=WinReg.new("test/NTUSER.DAT")
+    end
+    
+    context "when reading the 'Personal' folder key" do
+      should 'return "%USERPROFILE%\Mis Documentos"' do
+        assert_equal '%USERPROFILE%\Mis Documentos',@winreg.read_key(FOLDERS_BASE+'\\'+'Personal')
+      end
+    end
+  
+    context 'when writing the "Personal" folder key with "SOME_DATA"' do
+      should 'return "SOME_DATA"' do
+        @winreg.write_key(FOLDERS_BASE+'\\'+'Personal','SOME_DATA')
+        assert_equal 'SOME_DATA',@winreg.read_key(FOLDERS_BASE+'\\'+'Personal')
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: winprofile
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Miguel Armas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-16 00:00:00 +01:00
+default_executable: redirect_folders.rb
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This Gem allows you to manage Windows roving profiles stored on your servers
+email: kuko@canarytek.com
+executables: 
+- redirect_folders.rb
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/redirect_folders.rb
+- lib/winprofile.rb
+- lib/winreg.rb
+- test/helper.rb
+- test/test_winprofile.rb
+- test/test_winreg.rb
+- TODO
+has_rdoc: true
+homepage: http://github.com/kukoarmas/winprofile
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Manage Windows Profiles
+test_files: 
+- test/test_winprofile.rb
+- test/test_winreg.rb
+- test/helper.rb