darwin-xrefresh-server 0.1.5

data/VERSION

@@ -0,0 +1 @@
+0.1.5

data/bin/xrefresh-server

@@ -0,0 +1,131 @@
+#!/usr/bin/env ruby
+
+# 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 "rubygems"
+require 'set'
+require 'optparse'
+require 'ostruct'
+require "yaml"
+require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib', 'xrefresh-server.rb') # this form is important for local development
+
+module XRefreshServer
+
+    ################################################################################
+    # command-line parsing
+
+    COMMAND = File.basename($0)
+    USAGE = "Usage: #{COMMAND} [OPTIONS]"
+
+    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 XRefreshServer::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
+    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
+end

data/lib/xrefresh-server.rb

@@ -0,0 +1,65 @@
+require 'json'
+begin
+  require 'term/ansicolor'
+  include Term::ANSIColor
+rescue LoadError
+  raise 'Run "sudo gem install term-ansicolor"'
+end
+# http://kpumuk.info/ruby-on-rails/colorizing-console-ruby-script-output/
+if PLATFORM =~ /win32/ then
+  begin
+    require 'win32console'
+    include Win32::Console::ANSI
+  rescue LoadError
+    raise 'Run "sudo gem install win32console" to use terminal colors on Windows'
+  end
+end
+
+module XRefreshServer
+    VERSION = File.read(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'VERSION'))
+    AGENT = "OSX xrefresh-server"
+    CONFIG_FILE = ".xrefresh-server.yml"
+
+    def self.die(s)
+        $stderr.puts s
+        exit 1
+    end
+    
+    def self.generate_config(path)
+        puts "Generating config in #{path}"
+        File.open(path, "w") do |file|
+            file.puts <<CONFIG\
+# here specify list of paths to monitor
+paths:
+  - #{File.expand_path('~')} # by default watch user's home directory
+# - /you/may/add/here/some/other/path
+# - /you/may/add/here/some/another/path
+
+# you can various filters (ruby regexp pattern)
+# every file is split to dir and file part (for example /Users/mick/proj/coolapp and some_file.rb)
+#   both include filters must be satisfied
+#   both exclude filters must not be satisfied
+# empty value means "apply no filtering"
+dir_include:
+dir_exclude: ^#{File.expand_path('~')}/Library|/\\.(svn|framework|app|pbproj|pbxproj|xcode(proj)?|bundle)/
+file_include:
+file_exclude: ^(CVS|SCCS|vssver.?.scc|\\.(cvsignore|git|svn|DS_Store)|_svn|Thumbs\\.db)$|~$|^(\\.(?!htaccess)[^/]*|\\.(tmproj|o|pyc)|svn-commit(\\.[2-9])?\\.tmp)$ # merged TextMate and Netbeans patterns
+
+# xpert settings
+host: #{GServer::DEFAULT_HOST}
+port: 41258 # known port for clients to connect 
+max_connections: 4 # max client connections
+debug: false # run in debug mode?
+audit: false # audit server activity
+defer_time: 0.5 # aggregation time for events
+sleep_time: 0.1 # don't hung cpu in main loop
+CONFIG
+        end
+    end
+    
+end
+
+LIB_DIR = File.expand_path(File.dirname(__FILE__))
+require File.join(LIB_DIR, 'xrefresh-server/client.rb')
+require File.join(LIB_DIR, 'xrefresh-server/server.rb')
+require File.join(LIB_DIR, 'xrefresh-server/monitor.rb')

data/lib/xrefresh-server/client.rb

@@ -0,0 +1,52 @@
+require 'json'
+
+module XRefreshServer
+
+    # client representation on server side
+    class Client
+        attr_accessor :id, :dead, :type, :agent
+
+        def initialize(id, socket)
+            @id = id
+            @socket = socket
+            @dead = false
+            @type = '?'
+            @agent = '?'
+        end
+        
+        def name
+            green("#{@type}(#{@id})")
+        end
+    
+        def send(data)
+            return if @dead
+            begin
+                @socket << data.to_json
+            rescue
+                OUT.puts "Client #{name} #{red("is dead")}"
+                @dead = true
+            end
+        end
+
+        def send_about(version, agent)
+            send({
+              "command" => "AboutMe", 
+              "version" => version, 
+              "agent" => agent
+            })
+        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
+            })
+        end
+    end
+
+end

data/lib/xrefresh-server/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 #{yellow(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" => blue('*'), "deleted" => red('-'), "created" => green('+'), "renamed" => magenta('>')}
+            
+            # 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 #{yellow(root)}:"
+                        files.each do |file|
+                            OUT.puts "    #{activities[file["action"]]} #{blue(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
+
+

data/lib/xrefresh-server/server.rb

@@ -0,0 +1,62 @@
+require 'gserver'
+require 'json'
+
+module XRefreshServer
+
+    # server
+    class Server < GServer
+        attr_accessor :clients
+
+        def initialize(port, host, max_connections, *args)
+            super
+            @clients = Set.new
+            @last_client_id = 0
+            OUT.puts "#{green('Started server')} on #{blue("#{host}:#{port}")} (max #{max_connections} clients)"
+        end
+
+        def serve(socket)
+            socket.binmode
+            @last_client_id += 1
+            client = Client.new(@last_client_id, socket)
+            @clients.add(client)
+            buffer = ""
+            loop do
+                # accumulate incomming input in @buffer
+                begin
+                    buffer += socket.gets
+                rescue
+                    break
+                end
+
+                begin
+                    # try to parse buffer
+                    msg = JSON.parse buffer
+                rescue
+                    # buffer may be incomplete due to packet fragmentation ...
+                else
+                    # got whole message => process it
+                    buffer = ""
+                    process(client, msg)
+                end
+            end
+        end
+
+        def process(client, msg)
+            # see windows implementation in http://github.com/darwin/xrefresh/tree/master/src/winmonitor/Server.cs#ProcessMessage
+            case msg["command"]
+                when "Hello"
+                    client.type = msg["type"] || '?'
+                    client.agent = msg["agent"] || '?'
+                    OUT.puts "Client #{client.name} [#{magenta(client.agent)}] has connected"
+                    client.send_about(VERSION, AGENT)
+                when "Bye"
+                    @clients.delete(client)
+                    OUT.puts "Client #{client.name} has disconnected"
+                when "SetPage"
+                    url = msg["url"] || '?'
+                    OUT.puts "Client #{client.name} changed page to #{blue(url)}"
+            end
+        end
+    end
+    
+end

data/license.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009 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/readme.md

@@ -0,0 +1,5 @@
+# XRefresh Server for OSX
+
+XRefresh is refresh automation for web developers. This is OSX filesystem monitor.
+
+## Visit [xrefresh.binaryage.com](http://xrefresh.binaryage.com)

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: darwin-xrefresh-server
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Antonin Hildebrand
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-26 00:00:00 -07:00
+default_executable: xrefresh-server
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: XRefresh is browser refresh automation for web developers
+email: antonin@hildebrand.cz
+executables: 
+- xrefresh-server
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION
+- bin/xrefresh-server
+- lib/xrefresh-server.rb
+- lib/xrefresh-server/client.rb
+- lib/xrefresh-server/monitor.rb
+- lib/xrefresh-server/server.rb
+- license.txt
+- readme.md
+has_rdoc: false
+homepage: http://github.com/darwin/xrefresh-server
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: xrefresh-server
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: XRefresh filesystem monitor for OSX
+test_files: []
+