mamemose 0.3.0 → 0.4.0

data/README.md

@@ -50,7 +50,7 @@ $ gem install mamemose
 パスを通す必要があるかも。
 
 ```bash
-$ mamemose &> /dev/null &
+$ nohup mamemose &> /dev/null &
 ```
 
 するとローカルで HTTP サーバが立ち上がります。その後ブラウザから
@@ -69,6 +69,23 @@ http://localhost:PORT/
 - 文字コードは UTF-8 で書くようにしてください。
 - コマンドラインオプションは `mamemose help` で出ます。一応。
 
+
+### 自動更新
+
+WebSocket を使って自動更新できます。
+mamemose サーバを立てた後アクセスされたファイルを監視しておき、
+更新があればそのファイルを開いているブラウザのページを自動的にリロードします。
+
+現在のところ、 WebSocket 用のサーバを別に立てておくという設計になっています。
+以下のマンドを叩いて mamemose WebSocket サーバを起動しておいてください。
+
+```bash
+$ nohup mamemose_websocket &> /dev/null &
+```
+
+mamemose WebSocket サーバを立てなくても利用できます。
+その場合は手動で更新してください。
+
 ### 一時ファイル閲覧
 
 一時的に `DOCUMENT_ROOT` で指定したディレクトリ以外にあるファイルを

data/bin/mamemose

@@ -13,7 +13,7 @@ class Mamemose::CLI < Thor
   def server(filename=nil, port=nil)
     mamemose = Mamemose::Server.new(port)
     if !filename && !port
-      mamemose.start
+      mamemose.server
     elsif filename && port
       mamemose.file(filename)
     else

data/bin/mamemose_websocket

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+load 'mamemose/websocket.rb'
+
+require 'rubygems'
+require 'thor'
+
+class Mamemose::WebSocket::CLI < Thor
+  desc "server", "run the mamemose websocket server"
+  def server
+    ws = Mamemose::WebSocket::Server.new
+    ws.start
+  end
+
+  desc "s", "alias of server"
+  alias :s :server
+
+  desc "version", "print version"
+  def version
+    puts Mamemose::WebSocket::VERSION
+  end
+end
+
+args = ARGV == [] ? ["s"] : ARGV
+Mamemose::WebSocket::CLI.start(args)

data/lib/mamemose/env.rb

@@ -0,0 +1,19 @@
+conf = File.expand_path("~" + File::SEPARATOR + ".mamemose.rb")
+load conf if File.exists?(conf)
+
+DOCUMENT_ROOT = "~/Dropbox/memo" if !defined?(DOCUMENT_ROOT)
+PORT = 20000 if !defined?(PORT)
+WS_PORT = 30000 if !defined?(WS_PORT)
+RECENT_NUM = 10 if !defined?(RECENT_NUM)
+RECENT_PATTERN = /.*/ if !defined?(RECENT_PATTERN)
+IGNORE_FILES = ['.DS_Store','.AppleDouble','.LSOverride','Icon',/^\./,/~$/,
+                '.Spotlight-V100','.Trashes','Thumbs.db','ehthumbs.db',
+                'Desktop.ini','$RECYCLE.BIN',/^#/,'MathJax','syntaxhighlighter'] if !defined?(IGNORE_FILES)
+MARKDOWN_PATTERN = /\.(md|markdown)$/ if !defined?(MARKDOWN_PATTERN)
+INDEX_PATTERN = /^README/i if !defined?(INDEX_PATTERN)
+CUSTOM_HEADER = '' if !defined?(CUSTOM_HEADER)
+CUSTOM_BODY = '' if !defined?(CUSTOM_BODY)
+CUSTOM_FOOTER = '' if !defined?(CUSTOM_FOOTER)
+
+CONTENT_TYPE = "text/html; charset=utf-8"
+DIR = File::expand_path(DOCUMENT_ROOT, '/')

data/lib/mamemose/path.rb

@@ -0,0 +1,32 @@
+module Mamemose::Path
+  # returns escaped characters so that the markdown parser doesn't interpret it has special meaning.
+  def escape(text)
+    return text.gsub(/[\`*_{}\[\]()#+\-.!]/, "\\\\\\0")
+  end
+
+  # returns /-rooted path. eg. /path/to/my_document.md
+  def uri(path)
+    s = File::expand_path(path).gsub(DIR, "").gsub(File::SEPARATOR, '/')
+    return s == '' ? '/' : s
+  end
+
+  # returns fullpath. eg. /home/daimatz/Dropbox/memo/path/to/my_document.md
+  def fullpath(uri)
+    return File.join(DIR, uri.gsub(DIR, '').gsub('/', File::SEPARATOR))
+  end
+
+  # returns DOCUMENT_ROOT-rooted path. eg. ~/Dropbox/memo/path/to/my_document.md
+  def docpath(uri)
+    return File.join(DOCUMENT_ROOT, uri.gsub('/', File::SEPARATOR)).gsub(/#{File::SEPARATOR}$/, "")
+  end
+
+  # returns DOCUMENT_ROOT-rooted path, but escaped.  eg. ~/Dropbox/memo/path/to/my\_document.md
+  # used in user-viewable (HTML) context.
+  def showpath(uri)
+    return escape(docpath(uri))
+  end
+
+  def escaped_basename(filename)
+    return escape(File::basename(filename))
+  end
+end

data/lib/mamemose/util.rb

@@ -0,0 +1,5 @@
+module Mamemose::Util
+  def debug(tag, msg)
+    STDERR.puts "#{tag}: #{msg}"
+  end
+end

data/lib/mamemose/version.rb

@@ -1,3 +1,7 @@
 module Mamemose
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
+
+  module WebSocket
+    VERSION = "0.1.0"
+  end
 end

data/lib/mamemose/websocket.rb

@@ -0,0 +1,108 @@
+require 'em-websocket'
+require 'thread'
+
+require 'mamemose/version'
+
+require 'mamemose/path'
+require 'mamemose/util'
+
+require 'mamemose/env'
+
+class Mamemose::WebSocket::Server
+  include Mamemose::Util
+
+  @@update_send_message = "updated"
+
+  def initialize
+    @connections = []
+    @mutex = Mutex::new
+    @tag = "WebSocket"
+  end
+
+  def start
+    Thread.new do
+      debug(@tag, "start watcher...")
+      watcher
+    end
+
+    EventMachine::WebSocket.start(:host => '0.0.0.0', :port => WS_PORT) do |ws|
+      ws.onopen {
+        debug(@tag, "connected.")
+        ws.send("connected.")
+      }
+
+      ws.onmessage { |fullpath|
+        # receive url from client
+        debug(@tag, "receive: #{fullpath}")
+        if File.exists?(fullpath)
+          # connections are managed as tuple of (socket, url, mtime_cache)
+          con = {:ws => ws, :fullpath => fullpath, :mtime_cache => get_mtime(fullpath)}
+          @mutex.synchronize do
+            @connections.push(con) unless @connections.index(con)
+            debug(@tag, "added path to watch: #{fullpath}. now watch #{fullpaths.to_s}")
+          end
+        end
+      }
+
+      ws.onclose {
+        debug(@tag, "closed.")
+        # when a connection is closed, delete it from @connections
+        @mutex.synchronize do
+          @connections.delete_if { |con| con[:ws] == ws }
+          debug(@tag, "closed and removed path. now watch #{fullpaths.to_s}")
+        end
+      }
+    end
+  end
+
+  def watcher
+    loop do
+      # gather paths to watch using mutex
+      watch_fullpaths = []
+      @mutex.synchronize do
+        watch_fullpaths = fullpaths
+      end
+
+      # gather mtimes of watch_fullpaths
+      mtimes = {}
+      watch_fullpaths.uniq.each do |fullpath|
+        if File.exists?(fullpath)
+          # get mtime
+          mtimes[fullpath] = get_mtime(fullpath)
+        else
+          # file no longer exists. remove the entry
+          @mutex.synchronize do
+            @connections.delete_if { |con| con[:fullpath] == fullpath }
+            debug(@tag, "detected deletion: #{fullpath} and updated the list. now watch #{fullpaths.to_s}")
+          end
+        end
+      end
+
+      # push notification if watching file is updated
+      to_notify = []
+      @mutex.synchronize do
+        @connections.each do |con|
+          fullpath = con[:fullpath]
+          if mtimes[fullpath] && con[:mtime_cache] < mtimes[fullpath]
+            debug(@tag, "detected update: #{fullpath}. pushing...")
+            con[:mtime_cache] = mtimes[fullpath]
+            to_notify << con
+          end
+        end
+      end
+      to_notify.each do |con|
+        con[:ws].send(@@update_send_message)
+      end
+
+      sleep 1
+    end
+  end
+
+  def fullpaths
+    @connections.map{ |con| con[:fullpath] }
+  end
+
+  def get_mtime(fullpath)
+    File.mtime(fullpath) if File.exists?(fullpath)
+  end
+end

data/lib/mamemose.rb

@@ -5,26 +5,11 @@ require 'uri'
 require 'redcarpet'
 require 'htmlentities'
 
-require "mamemose/version"
-
-conf = File.expand_path("~" + File::SEPARATOR + ".mamemose.rb")
-load conf if File.exists?(conf)
-
-DOCUMENT_ROOT = "~/Dropbox/memo" if !defined?(DOCUMENT_ROOT)
-PORT = 20000 if !defined?(PORT)
-RECENT_NUM = 10 if !defined?(RECENT_NUM)
-RECENT_PATTERN = /.*/ if !defined?(RECENT_PATTERN)
-IGNORE_FILES = ['.DS_Store','.AppleDouble','.LSOverride','Icon',/^\./,/~$/,
-                '.Spotlight-V100','.Trashes','Thumbs.db','ehthumbs.db',
-                'Desktop.ini','$RECYCLE.BIN',/^#/,'MathJax','syntaxhighlighter'] if !defined?(IGNORE_FILES)
-MARKDOWN_PATTERN = /\.(md|markdown)$/ if !defined?(MARKDOWN_PATTERN)
-INDEX_PATTERN = /^README/i if !defined?(INDEX_PATTERN)
-CUSTOM_HEADER = '' if !defined?(CUSTOM_HEADER)
-CUSTOM_BODY = '' if !defined?(CUSTOM_BODY)
-CUSTOM_FOOTER = '' if !defined?(CUSTOM_FOOTER)
-
-CONTENT_TYPE = "text/html; charset=utf-8"
-DIR = File::expand_path(DOCUMENT_ROOT, '/')
+require 'mamemose/version'
+
+require 'mamemose/path'
+
+require 'mamemose/env'
 
 class HTMLwithSyntaxHighlighter < Redcarpet::Render::XHTML
   def block_code(code, lang)
@@ -35,21 +20,28 @@ class HTMLwithSyntaxHighlighter < Redcarpet::Render::XHTML
 end
 
 class Mamemose::Server
+  include Mamemose::Path
+
   def initialize(port)
-    @server = WEBrick::HTTPServer.new({ :Port => port ? port.to_i : PORT })
-    trap(:INT){@server.shutdown}
-    trap(:TERM){@server.shutdown}
+    @mamemose = WEBrick::HTTPServer.new({ :Port => port ? port.to_i : PORT })
+    trap(:INT){finalize}
+    trap(:TERM){finalize}
   end
 
   def start
-    @server.mount_proc('/') do |req, res|
+    @mamemose.start
+  end
+
+  def server
+    @mamemose.mount_proc('/') do |req, res|
       res['Cache-Control'] = 'no-cache, no-store, must-revalidate'
       res['Pragma'] = 'no-cache'
       res['Expires'] = '0'
 
+      p fullpath(req.path)
       if req.path =~ /^\/search/
         res = req_search(req, res)
-      elsif File.directory?(fullpath(req.path)) then
+      elsif File.directory?(fullpath(req.path))
         res = req_index(req, res)
       elsif File.exists?(fullpath(req.path))
         res = req_file(fullpath(req.path), res, false)
@@ -57,25 +49,28 @@ class Mamemose::Server
         res.status = WEBrick::HTTPStatus::RC_NOT_FOUND
       end
     end
-
-    @server.start
+    start
   end
 
   def file(filename)
-    @server.mount_proc('/') do |req, res|
+    @mamemose.mount_proc('/') do |req, res|
       res['Cache-Control'] = 'no-cache, no-store, must-revalidate'
       res['Pragma'] = 'no-cache'
       res['Expires'] = '0'
       res = req_file(File.absolute_path(filename), res, true)
       res.content_type = CONTENT_TYPE
     end
-
-    @server.start
+    start
   end
 
 private
 
-  def header_html(title, path)
+  def finalize
+    Thread::list.each {|t| Thread::kill(t) if t != Thread::current}
+    @mamemose.shutdown
+  end
+
+  def header_html(title, fullpath)
     html = <<HTML
 <!DOCTYPE HTML>
 <html>
@@ -221,6 +216,23 @@ function copy(text) {
   prompt("Copy filepath below:", text);
 }
 </script>
+<script>
+(function(){
+  var fullpath = "#{fullpath}";
+  ws = new WebSocket("ws://localhost:#{WS_PORT}");
+  ws.onopen = function() {
+    console.log("WebSocket (port=#{WS_PORT}) connected: " + fullpath);
+    ws.send(fullpath);
+  };
+  ws.onmessage = function(evt) {
+    console.log("received: " + evt.data);
+    if (evt.data == "updated") {
+      console.log("update detected. reloading...");
+      location.reload();
+    }
+  };
+})();
+</script>
 #{CUSTOM_HEADER}
 </head>
 <body>
@@ -288,7 +300,7 @@ HTML
       value.each {|v| body += link_list(v[0], v[1])}
     end
 
-    res.body = header_html(title, uri(path))\
+    res.body = header_html(title, path)\
              + search_form(uri(path), q)\
              + markdown(body)\
              + footer_html
@@ -321,7 +333,7 @@ HTML
       body += File.read(index)
     end
 
-    res.body = header_html(title, req.path)\
+    res.body = header_html(title, directory)\
              + search_form(uri(req.path))\
              + markdown(body)\
              + footer_html(index)
@@ -407,37 +419,6 @@ HTML
     return {:dirs=>dirs, :markdowns=>markdowns, :others=>others}
   end
 
-  # returns escaped characters so that the markdown parser doesn't interpret it has special meaning.
-  def escape(text)
-    return text.gsub(/[\`*_{}\[\]()#+\-.!]/, "\\\\\\0")
-  end
-
-  # returns /-rooted path. eg. /path/to/my_document.md
-  def uri(path)
-    s = File::expand_path(path).gsub(DIR, "").gsub(File::SEPARATOR, '/')
-    return s == '' ? '/' : s
-  end
-
-  # returns fullpath. eg. /home/daimatz/Dropbox/memo/path/to/my_document.md
-  def fullpath(uri)
-    return File.join(DIR, uri.gsub('/', File::SEPARATOR))
-  end
-
-  # returns DOCUMENT_ROOT-rooted path. eg. ~/Dropbox/memo/path/to/my_document.md
-  def docpath(uri)
-    return File.join(DOCUMENT_ROOT, uri.gsub('/', File::SEPARATOR)).gsub(/#{File::SEPARATOR}$/, "")
-  end
-
-  # returns DOCUMENT_ROOT-rooted path, but escaped.  eg. ~/Dropbox/memo/path/to/my\_document.md
-  # used in user-viewable (HTML) context.
-  def showpath(uri)
-    return escape(docpath(uri))
-  end
-
-  def escaped_basename(filename)
-    return escape(File::basename(filename))
-  end
-
   def link_list(title, link)
     file = fullpath(link)
     str = filesize(file)

data/mamemose.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "redcarpet", ">= 2.2.0"
   gem.add_dependency "htmlentities", ">= 4.3.0"
-  gem.add_dependency "thor"
+  gem.add_dependency "thor", ">= 0.17.0"
+  gem.add_dependency "em-websocket", ">= 0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mamemose
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,12 +58,29 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: Markdown memo server
 email:
 - dai@daimatz.net
 executables:
 - mamemose
+- mamemose_websocket
 extensions: []
 extra_rdoc_files: []
 files:
@@ -73,9 +90,14 @@ files:
 - README.md
 - Rakefile
 - bin/mamemose
+- bin/mamemose_websocket
 - index.png
 - lib/mamemose.rb
+- lib/mamemose/env.rb
+- lib/mamemose/path.rb
+- lib/mamemose/util.rb
 - lib/mamemose/version.rb
+- lib/mamemose/websocket.rb
 - mamemose.gemspec
 - sample.png
 homepage: https://github.com/daimatz/mamemose