xrefresh-server 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-06-18
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Antonin Hildebrand
+
+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/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/xrefresh-server
+config/hoe.rb
+config/requirements.rb
+lib/client.rb
+lib/monitor.rb
+lib/server.rb
+lib/xrefresh-server.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,6 @@
+---
+To run monitoring server launch:
+xrefresh-server
+(when first launched, you will be asked to setup config file)
+For more information see http://xrefresh-server.rubyforge.org
+---

data/README.txt

@@ -0,0 +1,48 @@
+= xrefresh-server
+
+http://xrefresh.com
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Antonin Hildebrand
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/xrefresh-server

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby -rubygems
+
+# This script watches modifications on the given directories, using the new # FSEvents API in Leopard.
+# Depends on rubycocoa!
+# Needs rubygems and json gem!
+
+# Based on code by Dave Dribin
+# http://www.dribin.org/dave/blog/archives/2008/01/04/fswatch/
+
+require 'set'
+require 'optparse'
+require 'ostruct'
+require "yaml"
+begin
+    require 'xrefresh-server'
+rescue LoadError
+    require '../lib/xrefresh-server.rb'
+end
+begin
+    require 'json'
+rescue LoadError
+    die 'You must "sudo gem install json" to get xrefresh monitor running'
+end
+
+module XRefreshServer
+
+    ################################################################################
+    # command-line parsing
+
+    $COMMAND = File.basename($0)
+    $USAGE = "Usage: #{$COMMAND} [OPTIONS]"
+    $VERSION = XRefreshServer::VERSION
+    $AGENT = "OSX xrefresh-server"
+    CONFIG_FILE = ".xrefresh-server.yml"
+
+    options = OpenStruct.new
+    options.output = "-"
+    options.config = nil
+
+    opts = OptionParser.new do |o|
+        o.banner = $USAGE
+        o.separator ""
+        o.separator "Specific options:"
+
+        o.on("-c", "--config FILE", "Config file") do |fn|
+            options.config = fn
+        end
+
+        o.on("-g", "--generate [FILE]", "Generates default config file on given path") do |fn|
+            fn = "~/#{CONFIG_FILE}" if fn.nil?
+            XRefreshServer::generate_config(File.expand_path(fn))
+            exit
+        end
+
+        o.on("-o", "--output FILE", "Write output to a file") do |fn|
+            options.output = fn
+        end
+
+        o.on_tail("-h", "--help", "Show this message") do
+            puts o
+            exit
+        end
+
+        o.on_tail("-v", "--version", "Show version") do
+            puts $VERSION
+            exit
+        end
+    end
+
+    begin
+        opts.parse!(ARGV)
+    rescue
+        die "Unable to parse options: #{$!}"
+    end
+
+    # initialize output handle
+    if options.output == "-"
+        $out = $stdout.clone
+    else
+        $out = File.open(options.output, "w")
+    end
+
+    ################################################################################
+    # load config
+    unless options.config
+        path = File.expand_path("~/#{CONFIG_FILE}")
+        options.config = path if File.exists?(path)
+        path = File.expand_path("./#{CONFIG_FILE}")
+        options.config = path if File.exists?(path)
+    end
+    unless options.config
+        puts "Config file #{CONFIG_FILE} not found in current folder or home."
+        puts "It seems you are running xrefresh-server for first time."
+        puts "Do you want to generate default config file in home directory? [Yn]"
+        s = STDIN.getc.chr
+        if s=='y' || s=='Y'
+            options.config = File.expand_path("~/#{CONFIG_FILE}")
+            generate_config(options.config)
+        else
+            die "Please launch xrefresh-server with -c option and specify path to your config"
+        end
+    end
+    begin
+        CONFIG = YAML::load_file(options.config)
+    rescue
+        die "Unable to load or parse config: #{options.config}"
+    end
+
+    # sanitize config values
+    CONFIG["dir_include"] = '.*' unless CONFIG["dir_include"] 
+    CONFIG["file_include"] = '.*' unless CONFIG["file_include"]
+    CONFIG["dir_exclude"] = '^$' unless CONFIG["dir_exclude"] 
+    CONFIG["file_exclude"] = '^$' unless CONFIG["file_exclude"] 
+    CONFIG["dir_include"] = Regexp.new(CONFIG["dir_include"])
+    CONFIG["file_include"] = Regexp.new(CONFIG["file_include"])
+    CONFIG["dir_exclude"] = Regexp.new(CONFIG["dir_exclude"])
+    CONFIG["file_exclude"] = Regexp.new(CONFIG["file_exclude"])
+    CONFIG["max_connections"] = 4 unless CONFIG["max_connections"]
+    CONFIG["host"] = GServer::DEFAULT_HOST unless CONFIG["host"]
+    CONFIG["debug"] = !!CONFIG["debug"]
+    CONFIG["audit"] = !!CONFIG["audit"]
+    CONFIG["defer_time"] = 0.5 unless CONFIG["defer_time"]
+    CONFIG["sleep_time"] = 0.1 unless CONFIG["sleep_time"]
+    CONFIG.freeze
+
+    ################################################################################
+    # run server
+    $out.puts "Starting server on #{CONFIG["host"]}:#{CONFIG["port"]} (max #{CONFIG["max_connections"]} clients)"
+    server = Server.new(CONFIG["port"], CONFIG["host"], CONFIG["max_connections"], $stderr, CONFIG["audit"], CONFIG["debug"])
+    server.start
+
+    ################################################################################
+    # run filesystem monitoring loop
+    start_id = FSEventsGetCurrentEventId()
+    start_time = Time.now.to_i # used to compare with mtime, which only has second accuracy
+    monitor = Monitor.new(server, CONFIG)
+    monitor.schedule(start_id)
+    monitor.run_loop(start_time) # blocking call
+
+    ################################################################################
+    # leave in peace
+    $out.flush
+    exit(0)
+end

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require "lib/xrefresh-server.rb"
+
+AUTHOR = 'Antonin Hildebrand'  # can also be an array of Authors
+EMAIL = "antonin@hildebrand.cz"
+DESCRIPTION = "XRefresh filesystem monitor - browser refresh automation tool for web developers"
+GEM_NAME = 'xrefresh-server' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'xrefresh-server' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['json', '>= 1.0.0']
+]    # An array of rubygem dependencies [name, version]
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = XRefreshServer::VERSION + (REV ? ".#{REV}" : "")
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "woid"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+RDOC_OPTS = ['--quiet', '--title', 'xrefresh-server documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/client.rb

@@ -0,0 +1,34 @@
+require 'json'
+
+module XRefreshServer
+
+    # client representation on server side
+    class Client
+        attr :id, :dead
+
+        def initialize(id, socket)
+            @id = id
+            @socket = socket
+            @dead = false
+        end
+    
+        def send(data)
+            return if @dead
+            begin
+                @socket << data
+            rescue
+                $out.puts "Client ##{@id} is dead"
+                @dead = true
+            end
+        end
+
+        def send_about(version, agent)
+            send({"command" => "AboutMe", "version" => version, "agent" => agent}.to_json)
+        end
+
+        def send_do_refresh(root, name, type, date, time, files)
+            send({"command" => "DoRefresh", "root" => root, "name" => name, "date" => date, "time" => time, "type" => type, "files" => files}.to_json)
+        end
+    end
+
+end

data/lib/monitor.rb

@@ -0,0 +1,172 @@
+require 'osx/foundation'
+OSX.require_framework '/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework'
+include OSX
+
+module XRefreshServer
+    
+    class Monitor
+        
+        def initialize(server, config)
+            @config = config
+            @server = server
+            @modified_dirs = Set.new
+            @paths_info = Hash.new
+            @streams = []
+        end
+        
+        def schedule(start_event_id)
+            fsevents_cb = proc do |stream, ctx, numEvents, paths, marks, eventIDs|
+                # ctx doesn't work through rubycocoa?
+                root = FSEventStreamCopyPathsBeingWatched(stream).first
+                paths.regard_as('*')
+                numEvents.times do |n|
+                    $out.puts "Event: #{paths[n]}" if @config["debug"]
+                    @modified_dirs.add({:root=>root, :dir=>paths[n]})
+                end
+            end
+
+            @config["paths"].each do |path|
+                $out.puts "  monitoring #{path}"
+                # need to create new stream for every supplied path
+                # because we want to report registered sources of the changes
+                stream = FSEventStreamCreate(
+                    KCFAllocatorDefault,
+                    fsevents_cb,
+                    nil,
+                    [path],
+                    start_event_id,
+                    @config["defer_time"],
+                    KFSEventStreamCreateFlagNone) #KFSEventStreamCreateFlagNoDefer
+                die "Failed to create the FSEventStream" unless stream
+
+                FSEventStreamScheduleWithRunLoop(
+                    stream,
+                    CFRunLoopGetCurrent(),
+                    KCFRunLoopDefaultMode)
+
+                ok = FSEventStreamStart(stream)
+                die "Failed to start the FSEventStream" unless ok
+
+                @streams << stream
+            end
+        end
+        
+        # blocking call
+        def run_loop(start_time)
+            
+            activities = {"changed" => '*', "deleted" => '-', "created" => '+', "renamed" => '>'}
+            
+            # main loop
+            $out.puts "Waiting for file system events ..."
+            not_first_time = false
+            loop do
+                if @server.stopped?
+                    $out.puts "Server stopped"
+                    break
+                end
+                @streams.each do |stream|
+                    FSEventStreamFlushSync(stream)
+                end
+                buckets = Hash.new()
+                if not_first_time # all root folders are reported during first stream flush
+                    @modified_dirs.each do |dir_info|
+                        begin
+                            dir = dir_info[:dir]
+                            root = dir_info[:root]
+                            unless dir=~@config["dir_include"]
+                                $out.puts "debug: #{dir} rejected because dir_include" if @config["debug"]
+                                next
+                            end
+                            if dir=~@config["dir_exclude"]
+                                $out.puts "debug: #{dir} rejected because dir_exclude" if @config["debug"]
+                                next
+                            end
+
+                            if File.exists?(dir)
+                                $out.puts "debug: checking dir #{dir}" if @config["debug"]
+                                Dir.foreach(dir) do |file|
+                                    unless file=~@config["file_include"]
+                                        $out.puts "debug: #{file} rejected because file_include" if @config["debug"]
+                                        next
+                                    end
+                                    if file=~@config["file_exclude"]
+                                        $out.puts "debug: #{file} rejected because file_exclude" if @config["debug"]
+                                        next
+                                    end
+
+                                    full_path = File.join(dir, file)
+                                    next if File.directory?(full_path)
+                                    begin
+                                        stat = File.stat(full_path)
+                                        $out.puts "debug: stat #{full_path}" if @config["debug"]
+                                    rescue
+                                        # file may not exist
+                                        $out.puts "debug: stat failed #{full_path}" if @config["debug"]
+                                        next # keep silence
+                                    end
+                                    current_time = stat.mtime.to_i
+                                    original_time = @paths_info[full_path] || start_time
+
+                                    if (current_time > original_time)
+                                        $out.puts "debug: reported #{full_path}" if @config["debug"]
+                                        relative_path = full_path[root.size+1..-1]
+                                        buckets[root]||=[]
+                                        buckets[root]<< {
+                                            "action" => "changed",
+                                            "path1" => relative_path,
+                                            "path2" => nil
+                                        }
+                                    end
+                                    @paths_info[full_path] = current_time
+                                end
+                            else
+                                relative_path = dir[root.size+1..-1]
+                                buckets[root]||=[]
+                                buckets[root]<< {
+                                    "action" => "deleted",
+                                    "path1" => relative_path,
+                                    "path2" => nil
+                                }
+                            end
+                        rescue
+                            $out.puts "debug: exception! #{dir}" if @config["debug"]
+                            raise if @config["debug"]
+                            next #keep silence
+                        end
+                    end
+                else
+                    not_first_time = true
+                end
+
+                if buckets.size
+                    buckets.each do |root, files|
+                        $out.puts "  activity in #{root}:"
+                        files.each do |file|
+                            $out.puts "    #{activities[file["action"]]} #{file["path1"]}"
+                        end
+                        date = nil
+                        time = nil
+                        name = root
+                        type = 'type?'
+
+                        @server.clients.each do |client|
+                            client.send_do_refresh(root, name, type, date, time, files)
+                        end
+                    end
+                    buckets.clear
+                end
+
+                @modified_dirs.clear
+                sleep @config["sleep_time"]
+            end
+
+            streams.each do |stream|
+                FSEventStreamStop(stream)
+                FSEventStreamInvalidate(stream)
+                FSEventStreamRelease(stream)
+            end
+        end
+    end
+end
+
+