svn_wc_tree 0.0.2

data/bin/svn_wc_tree

@@ -0,0 +1,190 @@
+#!/usr/bin/env ruby
+
+# == Synopsis
+#
+# svn_wc_tree: install the svn_wc_tree web application.
+#
+# == Usage
+#
+# svn_wc_tree [OPTIONS]
+#
+# --help, -h:
+#    show help
+#
+# --html, -l [html_dir]:
+#    Move all web files to the directory path specified. 
+#    A directory called svn_wc_tree will be created at this path.
+#
+# --cgi, -c [cgi_dir]:
+#    Move the included CGI script to the path specified.
+#    path/directory must exist and must be able to execute CGI scripts
+#
+# --post_to_url, -u [post_to_url]:
+#    a URL that will receive AJAX requests and return the required JSON.
+#    (see the CGI script provided)
+#
+# --php, -p [php]:
+#    Run as a PHP application. (use only as last choice)
+#    (Ruby is still required; CGI not needed)
+#
+# --conf_location, -u [conf_location]:
+#    location (filesystem path) of your svn_wc.conf file (readable by 'httpd
+#    runs as' owner)
+#
+# --move_conf_from, -f [move_conf_from]:
+#    move your conf file (svn_wc_tree.conf) from filesystem path to 
+#    (move_conf_to)
+#
+# --move_conf_to, -t [move_conf_to]:
+#    move your conf file (svn_wc_tree.conf) to filesystem path from
+#    (move_conf_from)
+#
+#
+# Example: 
+#   svn_wc_tree --html /var/htdocs --cgi /var/cgi-bin \ 
+#                   --post_to_url 'http://example.com/cgi-bin/ \
+#                   --conf_location /opt/conf/svn_conf.yaml
+#
+#   sudo svn_wc_tree --html /var/htdocs --post_to_url 'cgi-bin/cgi.rb'
+#
+#   sudo svn_wc_tree --html /var/htdocs --php true \
+#                    --conf_location /opt/svn_wc_tree/svn_conf.yaml
+#
+#   sudo svn_wc_tree --html /var/www --cgi /usr/lib/cgi-bin \
+#    --post_to_url 'http://localhost/cgi-bin/' --move_conf_from \
+#    /tmp/svn_conf.yaml --move_conf_to /usr/local/svn_wc_tree
+
+
+require 'getoptlong'
+require 'rdoc/usage'
+require 'fileutils'
+
+opts = GetoptLong.new(
+  [ '--help', '-h',           GetoptLong::NO_ARGUMENT],
+  [ '--html', '-l',           GetoptLong::REQUIRED_ARGUMENT],
+  [ '--post_to_url', '-u',    GetoptLong::OPTIONAL_ARGUMENT],
+  [ '--cgi',  '-c',           GetoptLong::OPTIONAL_ARGUMENT],
+  [ '--php',  '-p',           GetoptLong::OPTIONAL_ARGUMENT],
+  [ '--conf_location', '-o',  GetoptLong::OPTIONAL_ARGUMENT],
+  [ '--move_conf_from', '-f', GetoptLong::OPTIONAL_ARGUMENT],
+  [ '--move_conf_to'  , '-t', GetoptLong::OPTIONAL_ARGUMENT]
+)
+
+html_dir       = nil
+cgi_dir        = nil
+php            = nil
+post_to_url    = 'index.php' # assume php mode
+conf_location  = nil
+move_conf_from = nil
+move_conf_to   = nil
+
+opts.each do |opt, arg|
+  case opt
+    when '--help'
+      RDoc::usage
+    when '--html'
+      if arg == '' then raise ArgumentError, 'path cannot be empty!'
+      else html_dir = arg
+      end
+    when '--cgi'
+      if arg != ''  then cgi_dir = arg end
+    when '--php'
+      if arg != '' 
+        php = true 
+      end
+    when '--post_to_url'
+      #if php then raise ArgumentError, 'post_to_url, is not used when php'
+      if arg != ''  then post_to_url = arg end
+    when '--conf_location'
+      if arg != '' then conf_location = arg end
+    when '--move_conf_from'
+      if arg != '' then move_conf_from = arg end
+    when '--move_conf_to'
+      if arg != '' then move_conf_to = arg end
+  end
+end
+
+# methods
+
+def handle_conf(move_conf_from, move_conf_to, cgi_dir=nil)
+  begin
+    FileUtils.mkdir move_conf_to
+    FileUtils.cp move_conf_from, move_conf_to
+  rescue
+    #puts "Destination conf file exists #{move_conf_to}"
+  end
+  # now edit lib to set conf_file path
+  to_path = File.dirname(move_conf_to) # moved to path
+  to_name = File.basename(move_conf_from) # name of conf file
+  conf_abs_path = File.join(to_path, to_name)
+  set_conf_file_in_cgi(cgi_dir, conf_abs_path) if cgi_dir
+end
+
+def set_conf_file_in_cgi(cgi_dir, conf_location, php=nil)
+  cgi_file = File.join(cgi_dir, 'svn_wc_broker.cgi')
+  File.open(cgi_file, 'r+') do |cf|
+    lines = cf.readlines 
+    lines.each do |el|
+      el.gsub! /CONF_FILE = nil/, 
+               "CONF_FILE = '#{conf_location}'"
+      # dont print header when run under php
+      el.gsub! /print cgi.header/, '#print cgi.header' if php 
+    end
+    cf.pos = 0
+    cf.print lines
+    cf.truncate(cf.pos)
+  end
+end
+
+def set_cgi_path_in_js(html_dir, post_to_url)
+  js_file = File.join(html_dir, 'js', 'swt.js')
+  File.open(js_file, 'r+') do |fst|
+    lines = fst.readlines 
+    lines.each do |el|
+      el.gsub! /var POST_URL = '.*;/, 
+               "var POST_URL = '#{post_to_url}';"
+    end
+    fst.pos = 0
+    fst.print lines
+    fst.truncate(fst.pos)
+  end
+end
+
+# actions
+if html_dir
+
+  swt_gem_ins_dir = File.join File.dirname(__FILE__), '..'
+
+  begin
+    # copy web app (html related) files
+    html_dest = File.join(html_dir, 'svn_wc_tree')
+    FileUtils.rm_rf html_dest
+    FileUtils.mkdir html_dest
+    FileUtils.cp_r(File.join(swt_gem_ins_dir, 'svn_wc_tree/'), html_dir)
+
+    # cgi script
+    cgi_path = html_dest if php
+    cgi_path = cgi_dir if cgi_dir # if set, will overwrite php cgi url
+    # copy web app cgi script to web app specified location
+    FileUtils.cp(File.join(swt_gem_ins_dir, 'cgi', 'svn_wc_broker.cgi'), cgi_path)
+    set_conf_file_in_cgi(cgi_path, conf_location, php) if conf_location
+
+    # edit js/swt.js file to full web accessible CGI URL
+    set_cgi_path_in_js(html_dest, post_to_url)
+
+    # conf file
+    if move_conf_from or move_conf_to
+      if not (move_conf_from and move_conf_to)
+        raise ArgumentError, \
+            'if using "move_", both move_conf_to and move_conf_from must be set'
+      end
+      handle_conf(move_conf_from, move_conf_to, cgi_dir)
+    end
+  rescue Exception => e
+    raise "Exception: #{e.message}"
+  end
+else
+  puts "Required argument missing. try --help"
+  exit 0
+end
+

data/cgi/svn_wc_broker.cgi

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby 
+# vim:encoding=UTF-8
+#
+# Copyright (c) 2010 David Wright
+#
+# You are free to modify and use this file under the terms of the GNU LGPL.
+# You should have received a copy of the LGPL along with this file.
+#
+# Alternatively, you can find the latest version of the LGPL here:
+#
+#      http://www.gnu.org/licenses/lgpl.txt
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+
+begin; require 'rubygems'; rescue LoadError; end
+require 'cgi'
+require 'json'
+require 'fileutils'
+require 'svn_wc_broker'
+
+CONF_FILE = nil
+
+cgi = CGI.new(:encoding => 'UTF-8')
+
+print cgi.header('type' => 'application/x-javascript', 'charset' => 'UTF-8')
+
+include SvnWcBroker
+
+# emergency debug only!
+#File.open('/tmp/DEBUG2', 'w') { |f| f.write(cgi.params.inspect) }
+
+# this cgi file *should* be as simple as this now
+set_conf_file(CONF_FILE)
+print handle_responses(cgi.params).to_json 
+

data/lib/svn_wc_broker.rb

@@ -0,0 +1,161 @@
+# vim:fileencoding=UTF-8
+#
+# Copyright (c) 2010 David Wright
+#
+# You are free to modify and use this file under the terms of the GNU LGPL.
+# You should have received a copy of the LGPL along with this file.
+#
+# Alternatively, you can find the latest version of the LGPL here:
+#
+#      http://www.gnu.org/licenses/lgpl.txt
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+
+require 'fileutils'
+require 'svn_wc_client'
+
+#XXX/TODO docs;tests
+#
+# Broker requests between web app (AJAX) to svn_wc_client
+#
+# (this probably totally unnecessary and can be done away with
+# is left over form an early design decision which has
+# already changed)
+# 
+# mostly what it does is populate the top level array element with :run_error
+# with any exception that occurs: #repo[0]={:run_error => "Error: #{e.message}"}
+#
+module SvnWcBroker
+
+  # any action we want to support gets added to this list
+  #--
+  # this list gets 'evaled' is why
+  #++
+  SUPPORTED_ACTIONS = %w(add commit delete info 
+                         revert list ignore diff update 
+                         status)
+
+  # set abs_path to your configuration file
+  def set_conf_file(conf) ; @conf_file = conf ; end
+
+  # makes the requests against svn_wc
+  include SvnRepoClient
+
+  # pass web requests in, handle defined actions, return results
+  # params can be a cgi request object, or a rails request object, whatever
+  # contains our web POST request
+  def handle_responses(params)
+
+      # to debug
+      #return svn_results debug_request(params['do_svn_action'])
+      #return svn_results debug_request(params.to_s.to_a)
+      if params['do_svn_action'] \
+         && (params['do_svn_action'].to_s == 'Do Svn Action')
+      
+        #return svn_results debug_request(params)
+        if params and params['svn_action'].to_s.strip.empty?
+          return svn_results 
+        else
+          return svn_results send( :do_requested_action, params )
+        end
+
+      else 
+        return svn_results
+      end
+
+  end
+
+  def debug_request(message)
+    resp_data = Array.new
+    resp_data[0] = {:run_error => "Debug: #{message}"}
+  end
+
+  def do_requested_action(params)
+    resp_data = Array.new
+
+    action = params['svn_action'].to_s.strip.downcase
+    files  = params['svn_files']
+
+    begin
+      if files and files.to_a.size > 0
+        files_striped = ret_just_files_list(
+                           process_params_to_list_of_files(files.to_s))
+        @files = files_striped.to_a.uniq
+        #@files.uniq
+        #return svn_results debug_request(@files)
+
+        # diff need status info
+        if ('diff' == action ) 
+           @files = process_params_to_list_of_files(files.to_s).to_a.uniq
+        end
+
+      end
+      eval("svn_#{action}") if SUPPORTED_ACTIONS.index(action)
+    rescue Exception => exn
+      resp_data[0] = {:run_error => "Error: #{exn.message}"}
+    end
+
+  end
+
+  # default action, always return the status list
+  def get_status_list
+    svn_status_list = Array.new
+    run_error = String.new
+  
+    begin
+      svn_status_list = svn_status
+    rescue Exception => e
+      run_error <<  e.message
+    end
+  
+    ##if svn_status_list.empty? or svn_status_list.size == 1
+    ##if svn_status_list.empty?
+    #if @entries_list[0][:entry_name].nil?
+    #  svn_status_list[0] = {:repo_status => 'upto date',
+    #                        :repo_root_local_path  => repo_root}
+    #end
+    
+    if run_error.length > 0 
+      svn_status_list[0] = {:run_error => run_error} 
+    end
+  
+    svn_status_list
+  end
+  
+  # svn_wc_broker always returns results, data if set, otherwise svn status list
+  def svn_results(data=[])
+     if data.empty? then get_status_list else data end
+  end
+  
+  # clean up POST requests
+  def process_params_to_list_of_files(passed_file_list) # :nodoc:
+      if passed_file_list and passed_file_list.match(/,/)
+        passed_file_list = passed_file_list.split(/,/).to_a
+      end
+  
+      passed_file_list_cleaned = Array.new
+      passed_file_list.each do |f_list_str|
+        # cgi params cleanup
+        # i.e. substituting the cgi with another 'http request broker'
+        #f_list_str.gsub!(/((\302\240)+|\t+|\s+)/, "\s")#&nbsp; becomes odd 2 byte char
+        f_list_str.gsub!(/((\302\240)+|\t+|\s+)/, "\s")#&nbsp; becomes odd 2 byte char
+        passed_file_list_cleaned.push f_list_str
+      end
+      passed_file_list_cleaned
+  end
+  
+  def ret_just_files_list(file_status_list) # :nodoc:
+    just_files = Array.new
+    return file_status_list unless file_status_list.class == Array
+    file_status_list.each do |f_list_str|
+      f_stat, f_name = f_list_str.split(/\s/)
+      just_files.push(f_name)
+    end
+    just_files
+  end
+  
+end
+ 

data/lib/svn_wc_client.rb

@@ -0,0 +1,266 @@
+# vim:fileencoding=UTF-8
+#
+# Copyright (c) 2010 David Wright
+#
+# You are free to modify and use this file under the terms of the GNU LGPL.
+# You should have received a copy of the LGPL along with this file.
+#
+# Alternatively, you can find the latest version of the LGPL here:
+#
+#      http://www.gnu.org/licenses/lgpl.txt
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+
+require 'svn_wc'
+
+#
+# receives method/action requests from web app (AJAX) returns data in expected format
+# is just a client of svn_wc 
+#
+# returned data is generally a array of anonymous hashes containing
+# svn entries info, or errors.
+#
+# e.g.
+#    each_details           = {}
+#    each_details[:file]    = path
+#    each_details[:status]  = status
+#    each_details[:content] = content
+#    each_details[:entries] = entries_list
+#    each_details[:error]   = error
+#    each_details[:repo_root_local_path]  = File.join(@repo_root, '/')
+#
+module SvnRepoClient
+
+  @@svn_wc = SvnWc::RepoAccess.new
+
+  # getter for repo root
+  def repo_root ; @@svn_wc.svn_repo_working_copy ; end
+
+  # if conf file exists and have a working copy of the repo, return the path
+  # to it, otherwise create it (do a checkout, not forced)
+  # returns svn_repo_working_copy abs_path
+  def get_repo
+    if File.file? @conf_file
+      @@svn_wc.set_conf @conf_file
+    else raise ArgumentError, "config file not found! #{@conf_file}" end
+
+    if not File.directory? @@svn_wc.svn_repo_working_copy
+      begin
+        @@svn_wc.do_checkout true
+      rescue SvnWc::RepoAccessError => e
+         raise e.message
+      end
+    end
+    @repo_root = @@svn_wc.svn_repo_working_copy
+  end
+
+  # basic status list of entries in repo root
+  # do checkout if not exists at local path
+  def svn_status
+      get_repo
+      st_list = Array.new
+      ent = Array.new
+      begin
+        @@svn_wc.status.each do |ef|
+            each_details = Hash.new
+            each_details[:status] = ef[:status]
+            each_details[:error] = ''
+            each_details[:entry_name]   = ef[:path]
+            each_details[:kind] = 1 # is 'file'
+            if File.directory?(File.join(@repo_root, ef[:path]))
+              each_details[:dir_name] = File.join(@repo_root, el)
+              each_details[:kind] = 2 # is dir
+            end
+            ent.push each_details
+        end
+        add_repo_as_dir = Hash.new
+        add_repo_as_dir[:dir_name] = @repo_root
+        add_repo_as_dir[:kind] = 2
+        ent.push add_repo_as_dir
+      rescue SvnWc::RepoAccessError => e
+        @error = "#{e.message} #{@@svn_wc}"
+        st_list.push info_data
+      end
+      @entries_list = ent
+      st_list.push info_data if ent.length > 0
+      st_list
+  end
+ 
+  # diff current to previous (HEAD only)
+  # returns diff content
+  def svn_diff
+     file_list_diffs = Array.new
+     @files.each { |f_list_str|
+       f_stat, f_name = f_list_str.split(/\s/)
+       begin
+         get_repo
+         @path = f_name
+         @content = @@svn_wc.diff(f_name).to_s
+         @status = f_stat
+         file_list_diffs.push info_data
+       rescue SvnWc::RepoAccessError => e
+         @error = e.message
+         file_list_diffs.push info_data
+       end
+     }
+
+     file_list_diffs
+  end
+
+  # commit, return message and revision, committed file list
+  def svn_commit
+      get_repo
+      rev = Array.new
+      begin
+        @content = "Committed. Revision: #{@@svn_wc.commit(@files)}
+                                  Files:
+                                  #{@files.join("\n")}"
+        rev.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        rev.push info_data
+      end
+      rev
+  end
+
+  # add, returns 'added' message and added file list
+  def svn_add
+      get_repo
+      rev = Array.new
+      begin
+        @content = "Added. #{@@svn_wc.add(@files).to_a.join("\n")}"
+        rev.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        rev.push info_data
+      end
+      rev
+  end
+
+  # update, returns 'updated' message, revision and update data
+  def svn_update
+      get_repo
+      remote_files = Array.new
+      begin
+        @content = "Updated: Revision #{@@svn_wc.update.to_a.join("\n")}"
+        remote_files.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        remote_files.push info_data
+      end
+      remote_files
+  end
+
+  # delete
+  def svn_delete
+      get_repo
+      rev = Array.new
+      begin
+        @content = "Deleted. #{@@svn_wc.delete(@files).to_a.join("\n")}"
+        rev.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        rev.push info_data
+      end
+      rev
+  end
+
+  # info, returns 'updated' message, revision and update data
+  def svn_info
+      get_repo
+      infos = Array.new
+      begin
+        @content = "Info: #{@@svn_wc.info(@files)[:url]}"
+        infos.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        infos.push info_data
+      end
+      infos
+  end
+
+  # revert, returns message
+  def svn_revert
+      get_repo
+      infos = Array.new
+      begin
+        @content = "Reverted: #{@@svn_wc.revert(@files)}
+                                  Files:
+                                  #{@files.join("\n")}"
+        infos.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        infos.push info_data
+      end
+      infos
+  end
+
+
+  # ignore, returns 'added' message and added file list
+  def svn_ignore
+      get_repo
+      rev = Array.new
+      begin
+        cmd = @@svn_wc.propset('ignore', @files, @repo_root)
+        #@content = "Ignoring. #{cmd} #{@files.to_a.join("\n")}"
+        @content = "Ignoring. #{cmd}"
+        rev.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        rev.push info_data
+      end
+      rev
+  end
+
+
+  # recursively list entries, provides file or dir info and access to 
+  # nice repo/file info
+  def svn_list
+      get_repo
+      repo_entries = Array.new
+      begin
+        l_svn_list = Array.new
+        @@svn_wc.list.each { |el|
+          status_info = {}
+          status_info[:entry_name] = el[:entry]
+          status_info[:kind] = 1 # is 'file'
+          #status_info[:last_changed_rev] = el[:last_changed_rev]
+          if File.directory?(File.join(@repo_root, el[:entry]))
+            status_info[:dir_name] = File.join(@repo_root, el[:entry])
+            status_info[:kind] = 2
+          end
+          l_svn_list.push status_info
+        }
+        @entries_list = l_svn_list
+        repo_entries.push info_data
+      rescue SvnWc::RepoAccessError => e
+        @error = e.message
+        repo_entries.push info_data
+      end
+      repo_entries
+  end
+
+  def info_data
+    each_details           = Hash.new
+    each_details[:file]    = @path
+    each_details[:status]  = @status
+    each_details[:content] = @content
+    #each_details[:rev]     = rev
+    # entries_list expects an array of anon hash's
+    each_details[:entries] = @entries_list
+    each_details[:error]   = @error
+    each_details[:repo_root_local_path]  = File.join(@repo_root, '/')
+
+    # high level repo details
+    each_details[:svn_repo_master] = @@svn_wc.svn_repo_master
+    each_details[:svn_user]        = @@svn_wc.svn_user
+    #each_details[:svn_pass]        = @@svn_wc.svn_pass
+    each_details[:svn_repo_config_file] = @@svn_wc.svn_repo_config_file
+
+    each_details
+  end
+
+end

data/svn_conf.yaml

@@ -0,0 +1,9 @@
+#svn_repo_master        : file:///tmp/svn/repo_test
+#svn_repo_master        : svn+ssh:///tmp/svnrepo
+svn_repo_master        : svn+ssh://svn_test_user@localhost/tmp/svnrepo
+#svn_repo_master        : svn+ssh://example.com/tmp/svnrepo
+svn_repo_working_copy  : /tmp/repo_test
+svn_user               : svn_test_user
+svn_pass               : svn_test_pass
+svn_repo_config_path   : /tmp/config
+

data/svn_wc_tree/css/swt.css

@@ -0,0 +1,4 @@
+
+.disp_no {
+  display: none
+}