mc-limit 1.0.0-x86-mingw32

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mc-limit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    mc-limit (0.0.1-x86-mingw32)
+      sys-proctable
+      win32-api
+      wxruby-ruby19
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    sys-proctable (0.9.1-x86-mingw32)
+    win32-api (1.4.8-x86-mingw32)
+    wxruby-ruby19 (2.0.1-x86-mingw32)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  mc-limit!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tim Jensen
+
+MIT License
+
+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.md

@@ -0,0 +1,71 @@
+MC-Limit
+========
+
+Minecraft Limiter (mc-limit) launches Minecraft in offline mode
+and automatically terminates the game after it has been played for
+a pre-determined amount of time.
+
+## Requirements
+
+* Minecraft (http://minecraft.net/download)
+* Java VM (http://java.com/download)
+* Ruby 1.9.x (http://ruby-lang.org/en/downloads)
+
+## How to install it
+
+TODO
+
+## How to configure it
+
+The utility uses environment variables for its configuration.
+
+### Default time limit
+
+Set the `DEFAULT_MC_LIMIT` variable to equal the default number of
+minutes of Minecraft play to allow per day.  If the variable is not
+set, the default time limit will be 30 minutes.
+
+### Remaining time file
+
+Set the `MC_LIMIT_FILE` variable to the full pathname of the file
+that is used to store the remaining play time between runs.  If the
+variable is not set, the default file is:
+
+- Windows: `%APPDATA%\.mc-limit\remaining.yml`
+- Others: `$HOME/.mc-limit/remaining.yml`
+
+### Admin password
+
+Set the `MC_LIMIT_ADMIN_PASSWORD` variable to be the plain text
+password required in order to run the administration tool.  If this
+variable is not set, the administration tool will not run.
+
+### Game command
+
+Set the `MC_LIMIT_COMMAND` variable to the complete command line
+used to launch Minecraft.
+
+## How to run it
+
+Run "mc-limit" to launch Minecraft.  I recommend creating a desktop
+shortcut to make it easier to run.
+
+### Administration tool
+
+Run "mc-limit-admin" to launch the administration tool.  This tool
+can be used to add or subtract minutes from today's limit.
+
+## Security
+
+This utility is by no means hacker-proof.  Any curious child (or
+adult) who is literate and moderately skilled with computers is
+capable of discovering how to defeat the time limit.  I consider it
+a challenge for my kids.
+
+## To-Do List
+
+* Make it portable
+* Display a timer while Minecraft is running that shows how much play
+  time is left.
+* Improve security.
+

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new

data/bin/mc-limit

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$0 = 'mc-limit'
+
+begin
+  require 'mc-limit'
+rescue LoadError
+  require 'rubygems'
+  require 'mc-limit'
+end
+
+MCLimit.launch
+
+# vim:ts=2:sw=2:et:ft=ruby

data/bin/mc-limit-admin

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+$0 = 'mc-limit'
+
+begin
+  require 'mc-limit'
+rescue LoadError
+  require 'rubygems'
+  require 'mc-limit'
+end
+
+MCLimit.admin
+
+# vim:ts=2:sw=2:et:ft=ruby

data/lib/mc-limit.rb

@@ -0,0 +1,7 @@
+require 'mc-limit/admin'
+require 'mc-limit/core'
+require 'mc-limit/gui'
+require 'mc-limit/version'
+require 'mc-limit/winfns' if RUBY_PLATFORM =~ /mingw/
+
+# vim:ts=2:sw=2:et

data/lib/mc-limit/admin.rb

@@ -0,0 +1,59 @@
+require 'wx'
+
+module MCLimit
+  class AdminDialog < Wx::Dialog
+    def initialize(parent, value)
+      super( parent, -1, 'Minecraft Limiter Administration' )
+
+      sizer = Wx::FlexGridSizer.new( 1, 2, 0, 0 )
+      label = Wx::StaticText.new( self, -1, 'Minutes of game play remaining:' )
+      sizer.add( label, 0, Wx::ALL, 4 )
+      @expand = Wx::SpinCtrl.new( self )
+      @expand.set_range(0, 1440)
+      @expand.set_value(value)
+      @expand.set_selection(-1, -1)
+      sizer.add( @expand, 0, Wx::ALL, 4 )
+
+      topsizer = Wx::GridSizer.new( 2, 1, 0, 0 )
+      topsizer.add( sizer, 0, Wx::ALL, 4 )
+      topsizer.add( create_std_dialog_button_sizer( Wx::OK | Wx::CANCEL ), 0, Wx::ALL, 4 )
+      self.set_sizer( topsizer )
+      topsizer.set_size_hints( self )
+      topsizer.fit( self )
+      @expand.set_focus
+    end
+
+    def value
+      @expand.get_value
+    end
+  end
+
+  def self.check_admin_password( parent )
+    raise 'Administration password has not been set!' if MCLimit.admin_password.nil?
+    password = Wx::PasswordEntryDialog.new( parent, 'Enter administration password' )
+    raise 'Password required!' unless Wx::ID_OK == password.show_modal
+    raise 'Incorrect password!' unless password.get_value == MCLimit.admin_password
+  end
+
+  class AdminApp < Wx::App
+    def on_init
+      frame = Wx::Frame.new(nil, -1, 'Dialog')
+      begin
+        MCLimit.check_admin_password( frame )
+        admin = AdminDialog.new( frame, MCLimit.remaining_minutes.to_i )
+        MCLimit.update_remaining_minutes( admin.value ) if Wx::ID_OK == admin.show_modal
+      rescue => e
+        GUI.error( e.message )
+        raise if $DEBUG
+      ensure
+        frame.close
+      end
+    end
+  end
+
+  def self.admin
+    AdminApp.new.main_loop
+  end
+end
+
+# vim:ts=2:sw=2:et

data/lib/mc-limit/core.rb

@@ -0,0 +1,106 @@
+require 'date'
+require 'yaml'
+require 'fileutils'
+require 'sys/proctable'
+
+module MCLimit
+  # The default number of minutes of game play to allow per day when env not set
+  DEFAULT_MINUTES = 30
+
+  # The minimum number of remaining minutes needed to start the game
+  MINIMUM_MINUTES = 1
+
+  REMAINING_FILE = 'remaining.yml'
+
+  GAME_COMMAND = 'javaw.exe -Xms512m -Xmx1024m -cp "%APPDATA%\.minecraft\bin\*" -Djava.library.path="%APPDATA%\.minecraft\bin\natives" net.minecraft.client.Minecraft'
+
+  def self.disappoint( title, body )
+    GUI.error( body, title )
+    exit 1
+  end
+
+  def self.game_command
+    ENV['MC_LIMIT_COMMAND'] || GAME_COMMAND
+  end
+
+  def self.remaining_file
+    if ENV['MC_LIMIT_FILE'].nil?
+      if RUBY_PLATFORM =~ /mingw/
+        File.join( ENV['APPDATA'], '.mc-limit', REMAINING_FILE )
+      else
+        File.join( ENV['HOME'], '.mc-limit', REMAINING_FILE )
+      end
+    else
+      ENV['MC_LIMIT_FILE']
+    end
+  end
+
+  def self.admin_password
+    ENV['MC_LIMIT_ADMIN_PASSWORD']
+  end
+
+  def self.default_minutes
+    Float( ENV['DEFAULT_MC_LIMIT'] || DEFAULT_MINUTES )
+  end
+
+  def self.remaining_minutes( date = Date.today )
+    FileUtils.mkdir_p( File.dirname( MCLimit.remaining_file ) )
+    yaml = YAML.load_file( MCLimit.remaining_file )
+    ( yaml[:date] == date ) ? Float(yaml[:remaining]) : default_minutes
+  rescue
+    default_minutes
+  end
+
+  def self.update_remaining_minutes( minutes )
+    yaml = { :date => Date.today, :remaining => minutes }.to_yaml
+    FileUtils.mkdir_p( File.dirname( MCLimit.remaining_file ) )
+    File.open( MCLimit.remaining_file, 'wt' ) { |f| f.write yaml }
+  end
+
+  def self.stop_minecraft(pids)
+    if RUBY_PLATFORM =~ /mingw/
+      Win.close_process(pids, 'Minecraft')
+    else
+      pids.each { |pid| kill(:QUIT, pid) }
+    end
+  end
+
+  def self.timeout_pid(pid, minutes)
+    Thread.new do
+      sleep minutes * 60
+      pids = [ pid ]
+      Sys::ProcTable.ps do |process|
+        pids << process.pid if pids.include? process.ppid
+      end
+      MCLimit.stop_minecraft(pids)
+    end
+    pid
+  end
+
+  def self.validate_sufficient( time_limit )
+    return if time_limit >= MINIMUM_MINUTES
+    disappoint( 'Sorry', 'No more Minecraft allowed today!' )
+  end
+
+  def self.run( command, time_limit )
+    validate_sufficient time_limit
+    pid = timeout_pid( Process.spawn( command ), time_limit )
+  end
+
+  def self.launch
+    GUI.new.main_loop do
+      remaining = MCLimit.remaining_minutes
+      pid = MCLimit.run( MCLimit.game_command, remaining )
+
+      start = Time.now
+      Process.waitpid( pid, 0 )
+      finish = Time.now
+
+      consumed = ( finish - start ) / 60
+      remaining = [ 0, remaining - consumed ].sort.last
+      MCLimit.update_remaining_minutes( remaining )
+    end
+  end
+end
+
+# vim:ts=2:sw=2:et

data/lib/mc-limit/gui.rb

@@ -0,0 +1,23 @@
+require 'wx'
+
+module MCLimit
+  class GUI < Wx::App
+    def on_init
+      frame = Wx::Frame.new(nil, -1, 'Hidden')
+      @main.call
+    ensure
+      frame.close
+    end
+    def main_loop(&main)
+      @main = main
+      super
+    end
+
+    def self.error( message, title = 'Error' )
+      dialog = Wx::MessageDialog.new( nil, message, title, Wx::OK | Wx::ICON_ERROR )
+      dialog.show_modal
+    end
+  end
+end
+
+# vim:ts=2:sw=2:et

data/lib/mc-limit/version.rb

@@ -0,0 +1,3 @@
+module MCLimit
+  VERSION = "1.0.0"
+end

data/lib/mc-limit/winfns.rb

@@ -0,0 +1,39 @@
+require 'win32/api'
+
+module MCLimit
+  module Win
+    WM_CLOSE = 0x10
+
+    SendMessage = Win32::API.new('SendMessage', 'LLLL', 'I', 'user32')
+    EnumWindows = Win32::API.new('EnumWindows', 'KP', 'L', 'user32')
+    GetWindowText = Win32::API.new('GetWindowText', 'LPI', 'I', 'user32')
+    GetWindowThreadProcessId = Win32::API.new('GetWindowThreadProcessId', 'LP', 'L', 'user32')
+
+    def self.window_for_pid(pid, text)
+      result = nil
+      finder = Win32::API::Callback.new('LP', 'I') do |handle, param|
+        pidp = [0].pack('L')
+        GetWindowThreadProcessId.call(handle, pidp)
+        if pid == pidp.unpack('L')[0]
+          buf = "\0" * 200
+          GetWindowText.call(handle, buf, 200)
+          result = handle if buf.strip == text
+        end
+        true
+      end
+      EnumWindows.call(finder, nil)
+      result
+    end
+
+    def self.close_process(pids, text)
+      pids.each do |pid|
+        handle = window_for_pid(pid, 'Minecraft')
+        next if handle.nil?
+        SendMessage.call(handle, WM_CLOSE, 0, 0)
+        break
+      end
+    end
+  end
+end
+
+# vim:ts=2:sw=2:et

data/mc-limit.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mc-limit/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tim Jensen"]
+  gem.email         = ["tim.l.jensen@gmail.com"]
+  gem.description   = %q{Minecraft Limiter (mc-limit) launches Minecraft in offline mode and automatically terminates the game after it has been played for a pre-determined amount of time.}
+  gem.summary       = %q{Limit the amount of time Minecraft can be played per day}
+  gem.homepage      = "https://github.com/tjensen/mc-limit"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mc-limit"
+  gem.require_paths = ["lib"]
+  gem.version       = MCLimit::VERSION
+
+  gem.platform = Gem::Platform::CURRENT
+  gem.required_ruby_version = ">= 1.9.1"
+
+  gem.add_dependency('sys-proctable')
+  gem.add_dependency('win32-api')
+  gem.add_dependency('wxruby-ruby19')
+end

data/test/test_core.rb

@@ -0,0 +1,84 @@
+require 'test/unit'
+require 'fileutils'
+require 'mc-limit'
+
+class TC_Default_Minutes < Test::Unit::TestCase
+  def setup
+    ENV.delete 'DEFAULT_MC_LIMIT'
+  end
+
+  def test_return_hardcoded_default_when_env_not_set
+    assert_equal MCLimit::DEFAULT_MINUTES, MCLimit.default_minutes
+  end
+
+  def test_return_env_value_when_set
+    ENV['DEFAULT_MC_LIMIT'] = '2112'
+    assert_equal 2112, MCLimit.default_minutes
+  end
+end
+
+class TC_Remaining_Minutes < Test::Unit::TestCase
+  def setup
+    FileUtils.rm_f( MCLimit::REMAINING_FILE )
+    ENV.delete 'DEFAULT_MC_LIMIT'
+  end
+  def teardown
+    FileUtils.rm_f( MCLimit::REMAINING_FILE )
+  end
+
+  def test_return_hardcoded_default_when_file_missing_and_env_not_set
+    assert_equal MCLimit::DEFAULT_MINUTES, MCLimit.remaining_minutes
+  end
+
+  def test_return_env_default_when_file_missing
+    ENV['DEFAULT_MC_LIMIT'] = '74'
+    assert_equal 74, MCLimit.remaining_minutes
+  end
+
+  def test_return_file_defined_minutes_if_file_contains_todays_date
+    yaml = { :date => Date.new(1776, 7, 4), :remaining => 13 }.to_yaml
+    File.open(MCLimit::REMAINING_FILE, 'wt') { |f| f.write( yaml ) }
+    assert_equal 13, MCLimit.remaining_minutes( Date.new(1776, 7, 4) )
+  end
+
+  def test_return_default_minutes_if_file_contains_different_date
+    yaml = { :date => Date.new(1776, 7, 4), :remaining => 13 }.to_yaml
+    File.open(MCLimit::REMAINING_FILE, 'wt') { |f| f.write( yaml ) }
+    assert_equal MCLimit.default_minutes, MCLimit.remaining_minutes
+  end
+
+  def test_return_default_minutes_if_file_contains_garbage_date
+    yaml = { :date => 'garbage', :remaining => 13 }.to_yaml
+    File.open(MCLimit::REMAINING_FILE, 'wt') { |f| f.write( yaml ) }
+    assert_equal MCLimit.default_minutes, MCLimit.remaining_minutes
+  end
+
+  def test_return_default_minutes_if_file_contains_garbage_minutes
+    yaml = { :date => Date.new(1776, 7, 4), :remaining => 'garbage' }.to_yaml
+    File.open(MCLimit::REMAINING_FILE, 'wt') { |f| f.write( yaml ) }
+    assert_equal MCLimit.default_minutes, MCLimit.remaining_minutes( Date.new(1776, 7, 4) )
+  end
+
+  def test_return_default_minutes_if_file_contains_garbage
+    File.open(MCLimit::REMAINING_FILE, 'wt') { |f| f.write( 'garbage' ) }
+    assert_equal MCLimit.default_minutes, MCLimit.remaining_minutes
+  end
+end
+
+class TC_Update_Remaining_Minutes < Test::Unit::TestCase
+  def setup
+    FileUtils.rm_f( MCLimit::REMAINING_FILE )
+    ENV.delete 'DEFAULT_MC_LIMIT'
+  end
+  def teardown
+    FileUtils.rm_f( MCLimit::REMAINING_FILE )
+  end
+
+  def test_writes_current_date_and_given_minutes_to_file
+    MCLimit.update_remaining_minutes 42
+    assert_equal( { :date => Date.today, :remaining => 42 },
+      YAML.load_file(MCLimit::REMAINING_FILE) )
+  end
+end
+
+# vim:ts=2:sw=2:et

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: mc-limit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: x86-mingw32
+authors:
+- Tim Jensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: &20769408 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20769408
+- !ruby/object:Gem::Dependency
+  name: win32-api
+  requirement: &20769120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20769120
+- !ruby/object:Gem::Dependency
+  name: wxruby-ruby19
+  requirement: &20768832 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20768832
+description: Minecraft Limiter (mc-limit) launches Minecraft in offline mode and automatically
+  terminates the game after it has been played for a pre-determined amount of time.
+email:
+- tim.l.jensen@gmail.com
+executables:
+- mc-limit
+- mc-limit-admin
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/mc-limit
+- bin/mc-limit-admin
+- lib/mc-limit.rb
+- lib/mc-limit/admin.rb
+- lib/mc-limit/core.rb
+- lib/mc-limit/gui.rb
+- lib/mc-limit/version.rb
+- lib/mc-limit/winfns.rb
+- mc-limit.gemspec
+- test/test_core.rb
+homepage: https://github.com/tjensen/mc-limit
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Limit the amount of time Minecraft can be played per day
+test_files:
+- test/test_core.rb