winprofile 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,6 +1,8 @@
 = winprofile
 
-Description goes here.
+WinProfile allows you to manage Windows user profiles from your server
+
+WARNING: It's not even considered pre-alfa quality code. Don't use it, or you WILL hate me
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/bin/redirect_folders.rb

@@ -30,11 +30,12 @@ def redirect
 	p.verbose=@verbose
 
 	puts "Redirecting Desktop"
-	p.redirect_folder('Desktop','U:\\.windows_settings\\Escritorio')
+	p.change_folder('Desktop','U:\\.windows_settings')
 	puts "Redirecting AppData"
-	p.redirect_folder('AppData','U:\\.windows_settings\\Datos de programa')
+	p.change_folder('AppData','U:\\.windows_settings')
 	puts "Redirecting Personal"
-	p.redirect_folder('Personal','U:\\Mis documentos')
+	p.change_folder('Personal','U:')
+  p.commit
 end
 
 def move

data/lib/winprofile.rb

@@ -12,6 +12,9 @@ class WinProfile
   # Base regkey for folder redirection
   FOLDERS_BASE='Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders'
 
+  # Default base for profile folders (its a Windows default)
+  PROFILE_BASE='%USERPROFILE%'
+
   # List of user folder redirection regkeys
   FOLDER_DEFAULTS=[
           {:name => "AppData", :dir => 'Datos de programa' },
@@ -38,7 +41,7 @@ class WinProfile
     # Defaults
     @profiles = profiles
     @homes = homes
-    @folders = FOLDER_DEFAULTS
+    @folders = Array.new()
 
     # If user=nil don't check existence, late initialization
     if user != nil
@@ -56,6 +59,42 @@ class WinProfile
     raise "Invalid profile: #{@file}" unless File.exists? @file
   end
 
+  # Stage a folder to be changed to the given base. The changes will be written on commit method
+  def change_folder(folder=nil, base=nil, dir=nil)
+ 
+    # Set defaults if parameters not given
+    base=PROFILE_BASE unless base
+
+    FOLDER_DEFAULTS.each do |key|
+      if key[:name] == folder
+        puts "Found key: #{key[:name]}" if @debug
+        # Ok key found
+        dir=key[:dir] unless dir
+        # Add it to stage
+        @folders.push({ :name => folder, :value => base+'\\'+dir })
+      end
+    end
+    @folders
+  end
+
+  # Show if a folder is staged for change. Returns the staged value
+  def show_changed_folder(folder)
+    @location=nil
+
+    @folders.each do |key|
+      if key[:name] == folder
+        @location = key[:value]
+        puts "#{key[:name]} -> #{@location}" if @verbose
+      end
+    end
+    @location
+  end
+
+  # Show all folders staged for change. Returns @folders
+  def show_changed_folders
+    @folders
+  end
+
   # Show folder redirection status for a given folder
   def show_folder(folder)
     @location=nil
@@ -138,8 +177,20 @@ class WinProfile
     w=WinReg.new(@file)
     w.debug=@debug
     FOLDER_DEFAULTS.each do |key|
-      w.write_key(FOLDERS_BASE+'\\'+key[:name],'%USERPROFILE%\\'+key[:dir])
+      w.write_key(FOLDERS_BASE+'\\'+key[:name],PROFILE_BASE+'\\'+key[:dir])
+    end
+  end 
+
+  # Commit (write) changes to hive file. 
+  # NOTE: You should ALWAYS commit, or you will lose the changes
+  def commit
+    # Compose changes array
+    @changes=Array.new
+    @folders.each do |key|
+      @changes.push({ :name => FOLDERS_BASE+'\\'+key[:name], :value => key[:value] })
     end
+    w=WinReg.new(@file,@debug)
+    w.write_keys(@changes)
   end 
 
 end

data/lib/winreg.rb

@@ -7,16 +7,17 @@ $expect_verbose = false
 class WinReg
   attr_accessor :file, :debug, :verbose
 
-  def initialize(file)
+  def initialize(file,debug=false)
     @file = file
+    @debug = debug
     # Check that file exists
     if not File.exists? @file
-      puts "ERROR: File #{@file} does not exist"
-      return nil
+      raise "ERROR: File #{@file} does not exist"
     end
     # FIXME: Check that we have the chntpw command
   end
 
+  # Read a key from hive
   def read_key(key)
     @value = nil
 
@@ -49,6 +50,7 @@ class WinReg
     return @value
   end
 
+  # Write a key, value pair to hive
   def write_key(key,value)
 
     PTY.spawn("chntpw -e #{@file}") do |read,write,pid|
@@ -79,5 +81,39 @@ class WinReg
     end
   end
 
+  # Write an array of key,value pairs to hive
+  def write_keys(pairs)
+
+    PTY.spawn("chntpw -e #{@file}") do |read,write,pid|
+      $expect_verbose = @debug
+      write.sync = true
+
+      pairs.each do |key|
+        # 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[:name] + "\n" if response
+        end
+
+        read.expect(/^->/, 5) do |response|
+          raise unless response
+          write.print key[:value] + "\n" if response
+        end
+      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/test_winprofile.rb

@@ -37,13 +37,13 @@ class TestWinProfile < Test::Unit::TestCase
   context "a WinProfile instance" do
 
     setup do
-      File.copy "test/sample_profile/NTUSER.DAT","test/NTUSER.DAT"
-      @winprofile=WinProfile.new("sample_profile","test")
+      File.copy "test/sample_profile/NTUSER.DAT","test/tmp/NTUSER.DAT"
+      @winprofile=WinProfile.new("tmp","test")
       @winprofile.verbose=false
     end
 
-    should "initialize folders same as FOLDER_DEFAULTS" do
-      assert_same_elements WinProfile::FOLDER_DEFAULTS,@winprofile.folders
+    should "initialize folders as empty array" do
+      assert_same_elements [],@winprofile.folders
     end    
 
     context "when asked for the 'Personal' folder key" do
@@ -89,6 +89,48 @@ class TestWinProfile < Test::Unit::TestCase
       #end
     #end
 
+    context 'when staging multiple key changes' do
+      setup do
+        File.copy "test/sample_profile/NTUSER.DAT","test/tmp/NTUSER.DAT"
+        @winprofile=WinProfile.new("tmp","test")
+      end
+
+      should "assume correct base when not given" do
+        @winprofile.change_folder('Personal',nil,'Mis documentos')
+        assert_equal WinProfile::PROFILE_BASE+'\\'+'Mis documentos', @winprofile.show_changed_folder('Personal')
+      end
+      should "assume correct dir when not given" do
+        @winprofile.change_folder('Personal',WinProfile::PROFILE_BASE,nil)
+        assert_equal WinProfile::PROFILE_BASE+'\\'+'Mis documentos', @winprofile.show_changed_folder('Personal')
+      end
+      should "assume correct base and dir when none given" do
+        @winprofile.change_folder('Personal')
+        assert_equal WinProfile::PROFILE_BASE+'\\'+'Mis documentos', @winprofile.show_changed_folder('Personal')
+      end
+      should "add valid folders to @folders" do
+        @winprofile.change_folder('Personal','U:')
+        @winprofile.change_folder('AppData','U:\\.windows_settings')
+        assert_equal 'U:\\Mis documentos', @winprofile.show_changed_folder('Personal')
+        assert_equal 'U:\\.windows_settings\Datos de programa', @winprofile.show_changed_folder('AppData')
+      end
+      should "not add nonexistent folders" do
+        @winprofile.change_folder('NONEXISTENT','U:')
+        assert_same_elements [], @winprofile.folders
+      end
+      should "read the same info from hive if we have not commited" do
+        @before=@winprofile.show_folder('AppData')
+        @winprofile.change_folder('AppData','NONE')
+        assert_equal @before, @winprofile.show_folder('AppData')
+      end
+      should "read written info when we commit" do
+        @winprofile.change_folder('Personal','U:')
+        @winprofile.change_folder('AppData','U:\\.windows_settings')
+        @winprofile.commit
+        assert_equal 'U:\\Mis documentos', @winprofile.show_folder('Personal')
+        assert_equal 'U:\\.windows_settings\Datos de programa', @winprofile.show_folder('AppData')
+      end
+    end
+
     context "when moving profile folders" do
       setup do
         # Remove orig

data/test/test_winreg.rb

@@ -4,6 +4,17 @@ require 'ftools'
 class TestWinReg < Test::Unit::TestCase
   FOLDERS_BASE='Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders'
 
+  should "raise exception when nonexistent file given" do
+    assert_raise RuntimeError do
+      @winreg=WinReg.new("NONEXISTENT")
+    end
+  end
+
+  should 'return WinReg object when existent file given' do
+    @winprofile=WinReg.new("test/NTUSER.DAT.SAFE")
+    assert_instance_of WinReg, @winprofile
+  end
+
   context "A WinReg instance" do
     setup do
       File.copy "test/NTUSER.DAT.SAFE","test/NTUSER.DAT"
@@ -23,5 +34,18 @@ class TestWinReg < Test::Unit::TestCase
       end
     end
 
+    context 'when writing multiple keys at once' do
+      setup do
+        @data = [ { :name => FOLDERS_BASE+'\\'+'Personal', :value => 'SOME_DATA' }, 
+                  { :name => FOLDERS_BASE+'\\'+'AppData', :value => 'SOME_MORE_DATA' } 
+                ]
+      end
+      should 'return the written keys' do
+        @winreg.write_keys(@data)
+        assert_equal 'SOME_DATA',@winreg.read_key(FOLDERS_BASE+'\\'+'Personal')
+        assert_equal 'SOME_MORE_DATA',@winreg.read_key(FOLDERS_BASE+'\\'+'AppData')
+      end
+    end
+
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: winprofile
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Miguel Armas