svn_wc_tree 0.0.2

data/ChangeLog

@@ -0,0 +1,4 @@
+version 0.0.2
+* initial release
+* run as PHP app (Ruby installation still required)
+* jQuery and JsTree bundled with app, will just be deps in the future

data/LICENSE

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Manifest

@@ -0,0 +1,57 @@
+bin/svn_wc_tree
+cgi/svn_wc_broker.cgi
+ChangeLog
+lib/svn_wc_broker.rb
+lib/svn_wc_client.rb
+LICENSE
+Manifest
+README.rdoc
+svn_conf.yaml
+svn_wc_tree/css/swt.css
+svn_wc_tree/img/swt_spinner.gif
+svn_wc_tree/index.html
+svn_wc_tree/index.php
+svn_wc_tree.conf
+svn_wc_tree/js/swt.js
+svn_wc_tree/js/jquery-1.3.2.js
+svn_wc_tree/js/jquery.blockUI-2.31.js
+svn_wc_tree/js/jquery.cookie.js
+svn_wc_tree/js/jquery.tree.checkbox.js
+svn_wc_tree/js/jquery.tree.js
+svn_wc_tree/js/source/jquery.tree.js
+svn_wc_tree/js/source/jquery.tree.min.js
+svn_wc_tree/js/source/lib/jquery.cookie.js
+svn_wc_tree/js/source/lib/jquery.hotkeys.js
+svn_wc_tree/js/source/lib/jquery.js
+svn_wc_tree/js/source/lib/jquery.metadata.js
+svn_wc_tree/js/source/lib/sarissa.js
+svn_wc_tree/js/source/plugins/_jquery.tree.rtl.js
+svn_wc_tree/js/source/plugins/jquery.tree.checkbox.js
+svn_wc_tree/js/source/plugins/jquery.tree.contextmenu.js
+svn_wc_tree/js/source/plugins/jquery.tree.cookie.js
+svn_wc_tree/js/source/plugins/jquery.tree.hotkeys.js
+svn_wc_tree/js/source/plugins/jquery.tree.metadata.js
+svn_wc_tree/js/source/plugins/jquery.tree.themeroller.js
+svn_wc_tree/js/source/plugins/jquery.tree.xml_flat.js
+svn_wc_tree/js/source/plugins/jquery.tree.xml_nested.js
+svn_wc_tree/js/source/themes/apple/bg.jpg
+svn_wc_tree/js/source/themes/apple/dot_for_ie.gif
+svn_wc_tree/js/source/themes/apple/icons.png
+svn_wc_tree/js/source/themes/apple/style.css
+svn_wc_tree/js/source/themes/apple/throbber.gif
+svn_wc_tree/js/source/themes/checkbox/dot_for_ie.gif
+svn_wc_tree/js/source/themes/checkbox/icons.png
+svn_wc_tree/js/source/themes/checkbox/style.css
+svn_wc_tree/js/source/themes/checkbox/throbber.gif
+svn_wc_tree/js/source/themes/classic/dot_for_ie.gif
+svn_wc_tree/js/source/themes/classic/icons.png
+svn_wc_tree/js/source/themes/classic/style.css
+svn_wc_tree/js/source/themes/classic/throbber.gif
+svn_wc_tree/js/source/themes/default/dot_for_ie.gif
+svn_wc_tree/js/source/themes/default/icons.png
+svn_wc_tree/js/source/themes/default/style.css
+svn_wc_tree/js/source/themes/default/throbber.gif
+svn_wc_tree/js/source/themes/themeroller/dot_for_ie.gif
+svn_wc_tree/js/source/themes/themeroller/icons.png
+svn_wc_tree/js/source/themes/themeroller/style.css
+svn_wc_tree/js/source/themes/themeroller/throbber.gif

data/README.rdoc

@@ -0,0 +1,333 @@
+= svn_wc_tree
+
+A Web application front end that operates on the working copy of an
+Subversion (SVN) repository.
+
+
+== VERSION:
+
+Version 0.0.2
+
+NOTE: THIS IS ALPHA QUALITY SOFTWARE, use at your own risk!
+
+
+== SYNOPSIS:
+
+   Install easy option 1:
+
+   PHP INSTALL:
+   $ sudo svn_wc_tree --html /var/www --php true --conf_location /opt/svn_conf.yaml
+
+   Navigate browser (javascript required) to to html docs dir specified above:
+   (i.e. DocumentRoot /var/www)
+   http://localhost/svn_wc_tree/index.html
+
+
+   Install easy option 2:
+
+   CGI INSTALL:
+   $ sudo svn_wc_tree --html /var/www  --cgi /usr/lib/cgi-bin \
+                      --post_to_url 'http://localhost/cgi-bin/svn_wc_broker.cgi' \
+                      --conf_location /opt/svn_conf.yaml
+
+   Navigate browser (javascript required) to to html docs dir specified above:
+   (i.e. DocumentRoot /var/www)
+   http://localhost/svn_wc_tree/index.html
+
+
+== DESCRIPTION:
+
+This CGI/AJAX Web Application is designed to operate on a working copy of 
+a remote Subversion repository.
+
+Currently, it provides only very basic SVN functions (see FEATURES).
+
+It does not do any sort of repository administration type operations, just 
+working directory repository management.
+
+== FEATURES:
+
+* Current supported operations
+  - open
+  - checkout/co
+  - list/ls
+  - update/up
+  - commit/ci
+  - status/stat
+  - diff
+  - info
+  - add
+  - revert
+  - delete
+  - svn+ssh is our primary connection use case, however can connect to and operate on file:/// URI as well
+
+== REQUIREMENTS:
+
+* Requires that the Subversion (SWIG) Ruby Bindings are installed. 
+* Requires that the svn_wc gem is installed. (i.e. sudo gem install svn_wc)
+* Ruby (tested with 1.8.6, 1.8.7)
+* CGI or PHP enabled
+
+== INSTALL:
+
+This library is intended to be installed as a Gem. (hosted on gemcutter.org)
+
+  $ gem install svn_wc_tree
+
+
+== OVERVIEW:
+
+This serverfault post describes what I was looking for and what I am trying to 
+satisfy with this web application:
+
+    "I want a web interface to manage a WORKING COPY of a repository (NOT the repository itself). 
+    There are lots of already made tools to manage the repository, but I also have not found a 
+    single one to manage a remote working copy.  I need a user-friendly interface to perform stuff like:
+    "svn status", "svn info", "svn commit", "svn update", "svn revert",
+    "svn add", "svn delete"  and "svn diff"... upon a WORKING COPY which resides
+    in a remote host.  (I'm not interested in the repository, I'm interested in the WORKING COPY
+    management.)
+    I don't want to do SSH login and perform these commands. I want to enable
+    not-advanced users to do some stuff in the hosted working copy, using a
+    web interface,...
+
+* {serverfault link}[http://serverfault.com/questions/52532/svn-web-interface/67788#67788]
+
+== USAGE:
+
+Javascript enabled web browser
+
+== DIAGNOSTICS
+
+* Errors:
+  An error such as: "Error: Error: can't convert nil into String" probably
+  means that you did not set CONF_FILE in the cgi file. (post install)
+ 
+  An error such as: 
+  /build/buildd/subversion-1.6.5dfsg/subversion/libsvn_ra_svn/streams.c:75:
+  Svn::Error::RaSvnConnectionClosed: 
+
+  probably means the app cannot make an ssh connection to the host. 
+  solution: set up ssh keys for the user the app is trying to connect as
+  (note, this will probably the user your web server is running as)
+
+  "status check Failed:
+  /build/buildd/subversion-1.6.5dfsg/subversion/libsvn_wc/lock.c:572:
+  Svn::Error::WcNotDirectory: '/tmp/repo' is not a working copy
+  #<SvnWc::RepoAccess:0xb73a0874>"
+  
+  I don't remember
+ 
+
+  An error such as: 
+    Repository: undefined
+    User:  undefined
+    Config File: undefined
+
+    Error: can't convert nil into String
+
+    Probably means you haven't specified a config file path.
+
+* Exceptions: 
+
+== CONFIGURATION AND ENVIRONMENT:
+
+* In order to make use of this module,...
+
+   configuration file: (is the the YAML format)
+
+   $ cat svnwc_conf.yaml 
+   # svn connection info
+   #svn_repo_master       : file:///tmp/svnrepo
+   svn_repo_master        : svn+ssh://example.com/opt/svnrepo
+   svn_repo_working_copy  : /usr/local/svn/repo_root
+   svn_user               : svn_test_user
+   svn_pass               : svn_test_pass
+   svn_repo_config_path   : /opt/config
+
+* possibly you want to integrate this seamlessly into your existing web 
+  application, an iframe may work well for this. The iframe height parameter
+  does not work as expected, this work around hack helps. 
+  (credit: http://guymal.com/mycode/100_percent_iframe/)
+  
+  <script language="javascript">
+  <!--
+    function resize_iframe(id) {
+      var height=window.innerWidth; //Firefox
+      if (document.body.clientHeight) height=document.body.clientHeight; //IE
+      document.getElementById(id).style.height=parseInt(height-document.getElementById(id).offsetTop-8)+"px"; //resize the iframe according to the size of the window
+      //document.getElementById(id).height=document.body.offsetHeight-document.getElementById(id).offsetTop-26;
+    }
+  //-->
+  </script>
+  <table style="height:100%;width:100%">
+   <tbody>
+    <tr>
+     <td style="height:100%;width:100%">
+       <iframe id='svn_frame' src="/svn_wc_tree/index.html" width="100%"
+               height="100%" marginwidth="0" marginheight="0"
+               vspace="0" hspace="0" frameborder="1"
+               onload='resize_iframe("svn_frame")'
+               style="margin:0; padding:0; height:100%;width:100%;
+              display:block;border:none;">
+         <p>Your browser does not support iframes.</p>
+       </iframe>
+     </td>
+    </tr>
+   </tbody>
+  </table>
+
+* If you want to integrate this into a rails web app. (and eliminate cgi).
+  Create a new controller such as:
+
+  begin; require 'rubygems'; rescue LoadError; end
+  require 'fileutils'
+  require 'svn_wc_broker'
+  
+  class SvnController < ApplicationController
+    #before_filter :session_required
+  
+    include SvnWcBroker
+  
+    def index
+      @conf_file = '/var/www/config/svn_conf.yaml'
+  
+      if request.get? then render :template => 'svn/index' and return false end
+  
+      if request.post?
+       set_conf_file(@conf_file)
+       render :json => handle_responses(params) and return false
+      end
+    end
+
+  end
+
+  And Create a new view (svn/index.html.erb) with the iframe content from above. 
+
+
+* NOTE/WARNING: Keep in mind, that whatever approach you take.
+                "/svn_wc_tree/index.html" is accessible to the public, 
+                which is very BAD. (see mod_rewrite rules below).
+                Please provide some protection to the web accessible 
+                SVN tree page, "/svn_wc_tree/index.html", an .htaccess or
+                cookie scheme, still depending on your set up anyone with 
+                access to your web app will have rw access to this svn page.
+
+* Here are some mod_rewrite rules you could use at a mininum. 
+  # add to  httpd.conf (or last resort .htaccess)
+
+  # add rules for svn_wc_tree
+  # disallow direct access to svn_wc_tree/index.html
+  #RewriteCond %{HTTP_REFERER} ^$ [NC]
+  # only allow this referrer to access svn_wc_tree/index.html
+  RewriteCond %{HTTP_REFERER} !^http://(.*)/cgi-bin/svn_wc_broker.cgi [NC]
+  RewriteRule ^(/svn_wc_tree/index.html)$ -  [F,L]
+  # allow other resources to pass for svn_wc_tree
+  RewriteRule ^(/svn_wc_tree/)(.*)   $1$2    [PT,L]
+
+
+* NOTE: The most efficient use of this web app is to run it as a controller in a ROR
+  application, the second most efficient way is as a CGI app, if you have no
+  choice run as a PHP app, which is the easiest (and slowest) method.
+
+* This library should work anywhere that the 'subversion-rubybindings' are installed
+
+== TESTS:
+
+  TODO: (cant figure out how to make this work on the JsTree ajax widget,
+        will look into selinium)
+  <strike>Tests, this webapp has functional tests written against the front end.
+  The tests are written in celerity, which is API compatible with Watir.
+  (more at {Celerity}[http://celerity.rubyforge.org/])
+  Celerity is written in jruby, so to run the tests, you'll need jruby 
+  and celerity installed.</strike>
+
+  basic REST interface tests in progress,...
+  
+  on Ubuntu.
+  $ sudo apt-get install jruby1.2 
+  $ sudo jruby -S gem install celerity
+  Successfully installed celerity-0.7.9
+  $ jruby tests/front_end_functional.rb 
+
+
+== DEPENDENCIES:
+
+  require 'cgi'
+  require 'yaml'
+  require 'json'
+  require 'pathname'
+  require 'fileutils'
+  require 'find'
+  require 'svn_wc_broker' (provided with svn_wc_tree)
+  require 'svn_wc'
+
+
+== INCOMPATIBILITIES:
+
+javascript disabled and non javascript enabled browsers
+
+
+== BUGS AND LIMITATIONS:
+
+This library currently provides only very basic svn operations.
+
+
+== SUPPORT:
+
+ri SvnRepoClient
+ri SvnWcBroker
+ri SvnWc::RepoAccess
+svn_wc_tree --html
+
+* {svn_wc_tree general page}[http://www.dwright.us/misc/svn_wc_tree]
+
+
+== CHANGELOG:
+
+See the ChangeLog file for details.
+
+
+== LICENSE AND COPYRIGHT:
+
+Copyright 2010 David Wright (david_v_wright@yahoo.com), all rights reserved.
+
+
+svn_wc_tree 0.0.2 is released under the LGPL license.
+
+
+== AUTHOR:
+
+Author:: {David Wright}[http://www.dwright.us/] <david_v_wright@yahoo.com>
+
+
+=== KEYWORDS:
+
+* Ruby (SWIG) SVN bindings, ruby+svn, ruby, subversion, svn, rubysvn, Subversion extensions in Ruby, Web Application, GUI 
+
+
+== ACKNOWLEDGEMENTS:
+
+thanks to the poster on serverfault for identifying what I was also looking for
+
+== ERRATA:
+
+For testing it is also possible to set the $SVN_SSH variable specifying the
+private key to use with -i so that you can try connecting as different users.
+For example:
+
+export SVN_SSH="ssh -i /home/dwright/.ssh/alt.key
+
+
+* The --post_to_url is a required argument, which set's the Javascript file
+  to point to the correct url, you shouldn't ever have to but can hand edit
+  the file:
+  vim {DocumentRoot}/svn_wc_tree/js/swt.js 
+  // change for your host if necessary
+  var POST_URL = 'http://localhost/cgi-bin/svn_wc_broker.cgi';
+
+   Edit:
+   $ sudo vim /usr/lib/cgi-bin/svn_wc_broker.cgi
+   # set conf file path to your svn repo info config file
+   CONF_FILE = 'abs_path/to/svn_conf_file.yaml'
+