osc-vnc 1.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbe041b5ff1e10a7d5e977d28a299a3c58ccd8d5
+  data.tar.gz: 9f2a6dc121713f6124e3d29f79d59dfca43d0ab0
+SHA512:
+  metadata.gz: 8a1d89ddb96dc57d38b0b42e1c4f5bf0bb2ef18852048c07bb7124fd8ec858e4e383e28ddbdea544447ed3f7a681c044b4e941eb24d7ec0297d8249f7a0a3c61
+  data.tar.gz: f4516b6091852f4433817a65085d96c8f37061626add5828aa792f3ee6c2e41dff999c7934d8f6a041b381fd0520d20ea1f9752e895fbe5d584f0fa008c7fca7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/
+*.lock
+*.swp
+*.output
+*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in osc-vnc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014-2016 Ohio Supercomputer Center
+
+MIT License
+
+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,169 @@
+# OSC::VNC
+
+Ruby library that provides VNC job submission to the OSC systems.
+
+## Usage
+
+Add this gem to your Gemfile:
+
+```ruby
+gem 'osc-vnc'
+```
+
+Run Bundler to update your gems:
+
+```bash
+$ bundle install
+```
+
+## Examples
+
+### Run App on Oxymoron Batch System
+
+For all cases we will need to create a new VNC session object. To create a VNC
+session object you need to supply it the required information:
+
+* a `PBS::Job` object that connects to the specified batch server
+* the PBS script that will run when the job is submitted, defined by
+  * type of script (`:vnc` or `:server`)
+    * `:vnc` launches a VNC server
+    * `:server` doesn't launch a VNC server (expects developer specified server in `xstartup`)
+  * cluster type (`:glenn`, `:oakley`, `:ruby`), not to be confused with the
+    batch server (i.e., `quick-batch` can use `:oakley` or `:ruby`)
+
+A bare bones setup would be:
+
+```ruby
+job = PBS::Job.new(conn: PBS::Conn.batch('quick'))
+script = OSC::VNC::ScriptView.new(
+    :vnc,
+    'oakley',
+    :subtype => :shared,
+    :xstartup => '/path/to/script',
+    :outdir => ENV['PWD']
+)
+
+session = OSC::VNC::Session.new(job, script)
+```
+
+In most cases we will want to supply more options for finer control of the
+session:
+
+```ruby
+# Headers are the PBS headers you see at the top of a PBS batch job.
+# They are defined similarly here accept the header argument
+# is used as a key in the PBS::ATTR hash object
+# e.g., for a PBS job name (#PBS -N MyVNCJob)
+headers = { PBS::ATTR[:N] => "MyVNCJob" }
+
+# Resources are the attributes in the PBS batch job given with `-l`.
+# e.g., for walltime (#PBS -l walltime=24:00:00)
+resources = { walltime: "24:00:00" }
+
+# Environment variables can also be passed to the script
+envvars = { DATAFILE: "/path/to/datafile" }
+```
+
+To submit the VNC session, use the `#submit` instance method on the object:
+
+```ruby
+session.submit(headers: headers, resources: resources, envvars: envvars)
+```
+
+After enough time has passed and the session is runninq in the batch system
+(i.e., not queued) there are a variety of formats to output the connection
+information. The most user-friendly being the `*.jnlp` format if the user has
+Java installed:
+
+```ruby
+conn_info = OSC::VNC::ConnView.new(session)
+conn_info.render(:jnlp)
+```
+
+**Note:** Once someone successfully authenticates with the VNC server the
+password will change if using `vncauth` form of authentication. So it is
+imperative that you run `ConnView#refresh` to update the connection
+information.
+
+### VNC Server options
+
+You can specify different options when running a vnc session. You can use the
+`default` set of VNC options to submit the job with or choose from pre-defined
+subtypes (i.e., `:shared`) found in [config/script.yml](config/script.yml).
+
+You can alter these options when creating a session by specifying them as a
+hash in the when initializing the `ScriptView` object. An example:
+
+```ruby
+# Specify your personal VNC session options to override defaults
+script = OSC::VNC::ScriptView.new(
+  :vnc,
+  'oakley',
+  :subtype => :shared,
+  :geom => '1920x1200',
+  :'otp?' => false,
+  :'vncauth?' => true,
+  :'ssh_tunnel?' => true,
+  ...
+)
+```
+
+### xstartup
+
+An `xstartup` script is treated like any other bash script that launches the
+application you want. If no environment variables are needed, it could
+theoretically be run directly on an OSC desktop session by itself.
+
+One such example would be launching Paraview:
+
+```bash
+#!/bin/bash
+
+# This loads up any Xresources the user specifies
+# as well as gives the background a nice grey color
+if [ -e $HOME/.Xresources  ]; then
+  xrdb $HOME/.Xresources
+fi
+xsetroot -solid grey
+
+# We need a window manager otherwise the windows will
+# look horrendous, for this we use FVWM (please refer to
+# FillSim for an example of the `fvwmrc` file used)
+export XSTARTUP_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
+XDIR=${XSTARTUP_DIR} /usr/bin/fvwm -f ${XSTARTUP_DIR}/fvwm/fvwmrc &
+
+# Load the required modules on Oakley
+. /etc/profile.d/lmod.sh
+module load paraview/3.14.1
+
+# If we are running this app on a node with an Xorg server running
+# i.e., there is a GPU on this node that we can utilize for OpenGL
+# graphics (which is true for the Oxymoron cluster)
+module load virtualgl/2.3
+
+# Now we start the application
+vglrun paraview
+
+# Be sure to clean up the VNC server after the user exits the above
+# running process
+vncserver -kill ${DISPLAY}
+```
+
+You may or may not need VirtualGL depending on the type of application. Be sure
+to only use it on a node with an Xorg server running. For any other node you
+should omit it and its binary `vglrun`.
+
+You can find a very generic example of an `fvwmrc` file in the
+`containerfillsim` GitHub repo under the path:
+
+```bash
+containerfillsim/jobs/vnc/paraview/fvwm/fvwmrc
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/script.yml

@@ -0,0 +1,35 @@
+vnc:
+  default: &DEFAULT_VNC
+    name: 'vnc'
+    geom: '800x600'
+    dpi: 96
+    idletimeout: 0
+    extra_args: null
+    otp?: false
+    vncauth?: true
+    pam?: false
+    ssh_tunnel?: true
+    tcp_server?: false
+    novnc?: false
+    cluster:
+      oakley:
+        fonts: '/usr/share/X11/fonts/misc,/usr/share/X11/fonts/75dpi,/usr/share/X11/fonts/100dpi,/usr/share/X11/fonts/Type1,/usr/share/fonts/default/Type1'
+        load_turbovnc: |
+          module use /nfs/gpfs/PZS0645/local-oakley/share/modulefiles
+          module load turbovnc/2.0.0
+        novnc_launcher: '/usr/local/novnc/utils/launch.sh'
+      ruby:
+        fonts: '/usr/share/X11/fonts/misc,/usr/share/X11/fonts/100dpi,/usr/share/X11/fonts/Type1,/usr/share/fonts/default/Type1'
+        load_turbovnc: |
+          module use /nfs/gpfs/PZS0645/local-ruby/share/modulefiles
+          module load turbovnc/2.0.0
+        novnc_launcher: '/usr/local/novnc/utils/launch.sh'
+  shared:
+    <<: *DEFAULT_VNC
+    idletimeout: 300
+    tcp_server?: true
+
+server:
+  default: &DEFAULT_SERVER
+    ssh_tunnel?: true
+    tcp_server?: false

data/examples/desktop/xstartup

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+/etc/X11/xinit/xinitrc
+
+vncserver -kill $DISPLAY

data/examples/paraview/fvwm/fvwmrc

@@ -0,0 +1,80 @@
+SetEnv  XPMPath $[XDIR]/fvwm/winxp/images
+
+# Makes the Maximize button look pressed-in when the window is maximized
+Style * MWMButtons
+# Allows turns off the mwm hints completely
+Style * NoFuncHint
+# Attempt to recognize & respect the mwm decoration hints that applications occasionally use
+Style * MWMDecor
+# Causes transient windows, which are normally left undecorated, to be given the usual fvwm decorations (title bar, buttons, etc.)
+Style * DecorateTransient
+Style * SmartPlacement
+
+# Tells fvwm the maximum size window with which opaque window movement should be used
+OpaqueMoveSize 100
+# Specifies the percentage of a page to scroll when the cursor hits the edge of a page
+EdgeScroll 100 100
+# The special flag Clear clears any existing flags
+ButtonStyle 2 - Clear
+TitleStyle    Active      AdjustedPixmap  $[XPMPath]/title-active.xpm     -- Flat
+TitleStyle    Inactive    AdjustedPixmap  $[XPMPath]/title-inactive.xpm   -- Flat
+ButtonStyle 2 ActiveUp    AdjustedPixmap  $[XPMPath]/close-activeup.xpm   -- UseTitleStyle  Flat
+ButtonStyle 2 ActiveDown  AdjustedPixmap  $[XPMPath]/close-activedown.xpm -- UseTitleStyle  Flat
+ButtonStyle 2 AllInactive AdjustedPixmap  $[XPMPath]/close-inactive.xpm   -- UseTitleStyle  Flat
+TitleStyle    Centered    Height          24
+BorderStyle   Active      Colorset
+BorderStyle   Inactive    Solid           Dodgerblue2 -- HiddenHandles NoInset
+BorderStyle   Active      Solid           Steelblue3  -- HiddenHandles NoInset
+
+ButtonStyle 4 - Clear
+ButtonStyle 4 ActiveUp    AdjustedPixmap  $[XPMPath]/maximize-activeup.xpm   -- UseTitleStyle  Flat
+ButtonStyle 4 ActiveDown  AdjustedPixmap  $[XPMPath]/maximize-activedown.xpm -- UseTitleStyle  Flat
+ButtonStyle 4 AllInactive AdjustedPixmap  $[XPMPath]/maximize-inactive.xpm   -- UseTitleStyle  Flat
+
+# BorderWidth - width of the border to place the window if it does not have resize-handles
+# HandleWidth - width of the border to place the window if it does have resize-handles
+Style * BorderWidth 4, HandleWidth 4
+# ForeColor - foreground color (black)
+# BackColor - background color (steelblue3)
+Style * ForeColor black, BackColor Steelblue3
+# HilightFore - window has focus foreground color (white)
+# HilightBack - window has focus background color (dodgerblue2)
+Style * HilightFore white, HilightBack Dodgerblue2
+# Font - name of the font r-regular 14-size
+Style * Font -*-helvetica-medium-r-*-*-14-*-*-*-*-*-*-*
+# Start Windows in the top left corner unless the application specifies otherwise
+Style * PositionPlacement
+#Style * PositionPlacement Center
+
+# R - root window
+# W - application window
+# D - desktop application
+# T - window title-bar
+# S - window side, top, or bottom bar
+# F - window frame (corners)
+# I - icon window
+# 2 - 0-9 title-bar buttons
+Mouse   0       RI      A       -
+Mouse   0       2       A       Close
+Mouse   1       2       A       Close
+Mouse   2       2       A       Close
+Mouse   1       RSFTI   A       -
+Mouse   2       RSFTI   A       -
+Mouse	  0	      4       A	      Maximize	100	100
+Mouse   1       T       A       Maximize-or-Move
+
+AddToFunc Maximize-or-Move
++ D Maximize
++ C Raise
++ C Focus
++ M Move
+
+DesktopSize 1x1
+
+# Added below 3 to remove root menu, F1 & all help menus
+DestroyMenu MenuFvwmRoot
+Key F1 R A -
+Silent Key Help R A -
+
+# Wine fix
+Style * Lenience

data/examples/paraview/fvwm/winxp/images/close-activedown.xpm

@@ -0,0 +1,237 @@
+/* XPM */
+static char *close-activedown[] = {
+/* columns rows colors chars-per-pixel */
+"23 23 208 2",
+"   c black",
+".  c #003DAD",
+"X  c #053FB2",
+"o  c #0036CB",
+"O  c #0040AD",
+"+  c #0041B3",
+"@  c #0049B4",
+"#  c #0048C4",
+"$  c #004ECD",
+"%  c #004CD2",
+"&  c #004EDA",
+"*  c #0056CA",
+"=  c #085ECB",
+"-  c #0052D3",
+";  c #005BDC",
+":  c #0053E1",
+">  c #015AE5",
+",  c #025FE8",
+"<  c #035CF4",
+"1  c #0860CE",
+"2  c #0864D8",
+"3  c #1A64DF",
+"4  c #0060E2",
+"5  c #0164EA",
+"6  c #096DEC",
+"7  c #0165F3",
+"8  c #0068F3",
+"9  c #0269FD",
+"0  c #486FAF",
+"q  c #4E78AE",
+"w  c #4D76B4",
+"e  c #A35642",
+"r  c #AD5E5E",
+"t  c #B2574F",
+"y  c #B35E46",
+"u  c #B5594F",
+"i  c #B05953",
+"p  c #B85C52",
+"a  c #B05F60",
+"s  c #B6614E",
+"d  c #B5615C",
+"f  c #B5695C",
+"g  c #BB6256",
+"h  c #B96359",
+"j  c #B96A5A",
+"k  c #AE6A6E",
+"l  c #B56362",
+"z  c #B96B64",
+"x  c #B2706C",
+"c  c #B87069",
+"v  c #B97A77",
+"b  c #EC6032",
+"n  c #EC6B3F",
+"m  c #F26839",
+"M  c #C0675A",
+"N  c #DC7155",
+"B  c #C36961",
+"V  c #C66C70",
+"C  c #C57075",
+"Z  c #C07079",
+"A  c #D07F65",
+"S  c #D17C76",
+"D  c #D57E7C",
+"F  c #EC6D45",
+"G  c #EC6F4A",
+"H  c #E3754E",
+"J  c #EA7242",
+"K  c #ED764D",
+"L  c #E77257",
+"P  c #E4715C",
+"I  c #E17957",
+"U  c #EB7451",
+"Y  c #EA7854",
+"T  c #ED7F5A",
+"R  c #F06C41",
+"E  c #F07348",
+"W  c #F27A4C",
+"Q  c #F8794F",
+"!  c #F07757",
+"~  c #F37A53",
+"^  c #E47F64",
+"/  c #E57F6A",
+"(  c #EC7B63",
+")  c #F57F61",
+"_  c #BE7980",
+"`  c #C2816C",
+"'  c #CE856E",
+"]  c #D4896F",
+"[  c #DD896D",
+"{  c #D38678",
+"}  c #D28D76",
+"|  c #D58E7A",
+" . c #D88D70",
+".. c #D6937C",
+"X. c #DC917C",
+"o. c #E78253",
+"O. c #E3895F",
+"+. c #EE805F",
+"@. c #EE885E",
+"#. c #F6814D",
+"$. c #F48353",
+"%. c #F3825B",
+"&. c #E38362",
+"*. c #E0846B",
+"=. c #E78965",
+"-. c #E68B6F",
+";. c #EC8160",
+":. c #E88B67",
+">. c #EF8B6D",
+",. c #E08B73",
+"<. c #EB8D71",
+"1. c #E69273",
+"2. c #E3927A",
+"3. c #ED9376",
+"4. c #ED967B",
+"5. c #EC9D7E",
+"6. c #F38463",
+"7. c #F18168",
+"8. c #F38A6B",
+"9. c #FA8E6F",
+"0. c #F4926B",
+"q. c #FD9063",
+"w. c #F39172",
+"e. c #F3947C",
+"r. c #F3997B",
+"t. c #FD9572",
+"y. c #FC957B",
+"u. c #F9997C",
+"i. c #F6A27F",
+"p. c #B08188",
+"a. c #C59A8A",
+"s. c #C09A94",
+"d. c #D48A85",
+"f. c #D48E88",
+"g. c #D79181",
+"h. c #D6938B",
+"j. c #D39D8E",
+"k. c #DB9483",
+"l. c #D9938A",
+"z. c #DB9A87",
+"x. c #DD9A8C",
+"c. c #D19A90",
+"v. c #DC9799",
+"b. c #DB9F91",
+"n. c #DD9B9F",
+"m. c #DB9FA0",
+"M. c #D5A092",
+"N. c #DDA398",
+"B. c #D8AA9D",
+"V. c #D7A5A4",
+"C. c #DDA7A4",
+"Z. c #D7B2B5",
+"A. c #E5978C",
+"S. c #E69B8A",
+"D. c #E99780",
+"F. c #EE998A",
+"G. c #E59D90",
+"H. c #F09787",
+"J. c #F39A82",
+"K. c #F99A81",
+"L. c #F89F8A",
+"P. c #E2A38C",
+"I. c #E6A090",
+"U. c #ECA59B",
+"Y. c #F1A486",
+"T. c #F3A48D",
+"R. c #F8A181",
+"E. c #FBA38E",
+"W. c #F4A494",
+"Q. c #F3AA9B",
+"!. c #FCA391",
+"~. c #F9A699",
+"^. c #FCAC9A",
+"/. c #FBB69E",
+"(. c #FBBA9E",
+"). c #E0A7A0",
+"_. c #EBAFA6",
+"`. c #E7B0A3",
+"'. c #F4B4A4",
+"]. c #F3B6AB",
+"[. c #F6BAA3",
+"{. c #F6BDAB",
+"}. c #FBB7A2",
+"|. c #FABBA4",
+" X c #FAC4AC",
+".X c #F1C4B6",
+"XX c #F1C8BC",
+"oX c #FFCFB6",
+"OX c #FFD5B9",
+"+X c #CEDEFC",
+"@X c #EBC9CA",
+"#X c #E5CFD8",
+"$X c #FFD6C0",
+"%X c #FFDDCF",
+"&X c #FFDED4",
+"*X c #E8DFF1",
+"=X c #FFEAD5",
+"-X c #FFECDC",
+";X c #EBE2F3",
+":X c #FFECE2",
+">X c #F4E0F5",
+",X c #FFF5E7",
+"<X c #FFF4EB",
+"1X c #FFF8ED",
+"2X c #FFF3F3",
+"3X c #FFF9F3",
+"4X c #FFFBFE",
+"5X c None",
+/* pixels */
+"5X6 = = = = = = = = = = = = = = = = = = 2 3 5X",
+"4 * +X4X4X4X4X4X4X4X4X4X4X4X4X4X4X4X4X4X+X; o ",
+"@ +X*Xd d d d d r d d r d d d d d d d d ;X+X; ",
+"+ 4Xd v @XC.N.j.j.j.j.h.h.k.d.| } ' ..` p.4X$ ",
+". 4Xd #X.X X|.|.Q.Q.Q.W.T.T.Y.J.J.e.<.^ x 4X$ ",
+"X 4Xd Z. XoX(.}.Q.W.!.L.R.R.R.r.r.e.>.%.c 4X% ",
+". 4Xd V.[. X[.'.'.W.L.K.0.u.5.2.D.2.=.@.f 4X% ",
+". 4Xd n./.[.{.&X<XG.T.( t.<.[ z.,X$X=.H f 4X% ",
+"X 4Xd n.^.Q.].:X3X1X..T./ ,.{ 1X1X=Xw.Y j 4X% ",
+"+ 4Xd v.~.~.G.XX:X1X,Xz.{ b.1X1X,X<.L L z 4X% ",
+"+ 4Xh l.K.!.H.G.`.1X3X4Xp.3X1X1XA N %.8.j 4X% ",
+"+ 4Xr l.y.K.J.H.S.x.3X2X4X4X3X] ^ %.~ ! j 4X% ",
+"+ 4Xd f.w.K.K.K.J.X.M.4X4X3Xa.*.U W F R g 4X& ",
+"+ 4Xd d.8.u.u.e.H.S.1X4X4X3X1X1.@.E W Q j 4X& ",
+"# 4Xd S 9.8.e.A.B.3X3X1XB.,X1X<X..o.#.R u 4X: ",
+"$ 4Xd D ) t.e._.<X3X,XS...P.1X3X1XO.J ~ p 4X: ",
+"$ 4Xd D 7.;.D.<X1X1X..T.=.1.] 1X1X=XY G u 4X> ",
+"- 4Xd V 7.8.3.&X,Xk.5.N 0.0.O.2.-XOXK F s 4X> ",
+"; 4Xr V ( ! T *.4.-.0.%.q.W $.Y @.W n m e 4X> ",
+"5 4Xh Z P U %.8.^ ( 6.%.W $.#.W J E R b v 4X5 ",
+"7 +X>Xv i B l r a l z r h g p p p p t k >X+X8 ",
+"9 7 +X4X4X4X4X4X4X4X4X4X4X4X4X4X4X4X4X4X+X8 < ",
+"5X9 7 , , , , , , , , , , , , , , , , , 7 < 5X"
+};