bin/virtual_salome.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
   3 #
   4 # Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   5 # CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   6 #
   7 # This library is free software; you can redistribute it and/or
   8 # modify it under the terms of the GNU Lesser General Public
   9 # License as published by the Free Software Foundation; either
  10 # version 2.1 of the License, or (at your option) any later version.
  11 #
  12 # This library is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 # Lesser General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Lesser General Public
  18 # License along with this library; if not, write to the Free Software
  19 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  20 #
  21 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  22 #
  23
  24 """Create a virtual Salome installation
  25
  26 Based on a script created by Ian Bicking.
  27
  28 Typical use::
  29
  30   python virtual_salome.py -v --prefix="." --module=/local/chris/SALOME2/RELEASES/Install/KERNEL_V3_1_0b1
  31
  32 install module KERNEL in the current directory
  33 """
  34
  35 import sys, os, optparse, shutil,glob,fnmatch
  36 py_version = 'python%s.%s' % (sys.version_info[0], sys.version_info[1])
  37
  38 verbose=0
  39
  40 # -----------------------------------------------------------------------------
  41
  42 def mkdir(path):
  43     """Create a directory and all the intermediate directories if path does not exist"""
  44     if not os.path.exists(path):
  45         if verbose:
  46             print 'Creating %s' % path
  47         os.makedirs(path)
  48     else:
  49         if verbose:
  50             print 'Directory %s already exists' % path
  51             pass
  52         pass
  53
  54 # -----------------------------------------------------------------------------
  55
  56 def symlink(src, dest):
  57     """Create a link if it does not exist"""
  58     if not os.path.exists(dest):
  59         if os.path.lexists(dest):
  60             print "Do not create symlink %s. It already exists but it's broken" % dest
  61             return
  62         if verbose:
  63             print 'Creating symlink %s' % dest
  64             pass
  65         os.symlink(src, dest)
  66     else:
  67         if verbose:
  68             print 'Symlink %s already exists' % dest
  69         pass
  70     pass
  71
  72 # -----------------------------------------------------------------------------
  73
  74 def rmtree(dir):
  75     """Remove (recursive) a directory if it exists"""
  76     if os.path.exists(dir):
  77         print 'Deleting tree %s' % dir
  78         shutil.rmtree(dir)
  79     else:
  80         if verbose:
  81             print 'Do not need to delete %s; already gone' % dir
  82             pass
  83         pass
  84     pass
  85
  86 # -----------------------------------------------------------------------------
  87
  88 __lib__dir__ = None
  89 def get_lib_dir():
  90     global __lib__dir__
  91     if __lib__dir__: return __lib__dir__
  92     import platform
  93     __lib__dir__ = "lib"
  94     return __lib__dir__
  95
  96 # -----------------------------------------------------------------------------
  97
  98 def link_module(options):
  99     global verbose
 100
 101     if not options.module:
 102         print "Option module is mandatory"
 103         return
 104
 105     module_dir=os.path.abspath(options.module)
 106     if not os.path.exists(module_dir):
 107         print "Module %s does not exist" % module_dir
 108         return
 109
 110     verbose = options.verbose
 111
 112     home_dir = os.path.expanduser(options.prefix)
 113     #try to find python version of salome application and put it in versio
 114     pys=[os.path.split(s)[1] for s in glob.glob(os.path.join(home_dir,get_lib_dir(),"python*.*"))]
 115     if not pys :
 116       versio=None
 117     else:
 118       versio=pys[0]
 119
 120     pys=[os.path.split(s)[1] for s in glob.glob(os.path.join(module_dir,get_lib_dir(),"python*.*"))]
 121     #check if the module has a python version compatible with application version
 122     if not pys :
 123       pyversio=versio or py_version
 124     elif versio is None:
 125       pyversio=pys[0]
 126     elif versio in pys:
 127       pyversio=versio
 128     else:
 129       #incompatible python versions
 130       print "incompatible python versions : application has version %s and module %s has not" % (versio,module_dir)
 131       return
 132
 133     module_bin_dir=os.path.join(module_dir,'bin','salome')
 134     module_idl_dir=os.path.join(module_dir,'idl','salome')
 135     module_lib_dir=os.path.join(module_dir,get_lib_dir(),'salome')
 136     module_pvlib_dir=os.path.join(module_dir,get_lib_dir(),'paraview')
 137     module_lib_py_dir=os.path.join(module_dir,get_lib_dir(),pyversio,'site-packages','salome')
 138     module_lib_py_shared_dir=os.path.join(module_dir,get_lib_dir(),pyversio,
 139                                           'site-packages','salome')
 140     module_share_dir=os.path.join(module_dir,'share','salome')
 141     module_doc_gui_dir=os.path.join(module_dir,'doc','salome','gui')
 142     module_doc_tui_dir=os.path.join(module_dir,'doc','salome','tui')
 143     module_doc_dir=os.path.join(module_dir,'doc','salome')
 144     module_sharedoc_dir=os.path.join(module_dir,'share','doc','salome')
 145     module_sharedoc_gui_dir=os.path.join(module_dir,'share','doc','salome','gui')
 146     module_sharedoc_tui_dir=os.path.join(module_dir,'share','doc','salome','tui')
 147     module_sharedoc_examples=os.path.join(module_dir,'share','doc','salome','examples')
 148
 149     bin_dir=os.path.join(home_dir,'bin','salome')
 150     idl_dir=os.path.join(home_dir,'idl','salome')
 151     lib_dir=os.path.join(home_dir,'lib','salome')
 152     pvlib_dir=os.path.join(home_dir,'lib','paraview')
 153     lib_py_dir=os.path.join(home_dir,'lib',pyversio,'site-packages','salome')
 154     lib_py_shared_dir=os.path.join(home_dir,'lib',pyversio,
 155                                    'site-packages','salome')
 156     share_dir=os.path.join(home_dir,'share','salome')
 157     doc_gui_dir=os.path.join(home_dir,'doc','salome','gui')
 158     doc_tui_dir=os.path.join(home_dir,'doc','salome','tui')
 159     doc_dir=os.path.join(home_dir,'doc','salome')
 160     sharedoc_dir=os.path.join(home_dir,'share','doc','salome')
 161     sharedoc_gui_dir=os.path.join(home_dir,'share','doc','salome','gui')
 162     sharedoc_tui_dir=os.path.join(home_dir,'share','doc','salome','tui')
 163     sharedoc_examples_dir=os.path.join(home_dir,'share','doc','salome','examples')
 164
 165     if options.clear:
 166         rmtree(bin_dir)
 167         rmtree(idl_dir)
 168         rmtree(lib_dir)
 169         rmtree(lib_py_dir)
 170         rmtree(share_dir)
 171         rmtree(doc_dir)
 172         rmtree(sharedoc_dir)
 173         pass
 174
 175     #directory bin/salome : create it and link content
 176     if os.path.exists(module_bin_dir):
 177         mkdir(bin_dir)
 178         for fn in os.listdir(module_bin_dir):
 179             symlink(os.path.join(module_bin_dir, fn), os.path.join(bin_dir, fn))
 180             pass
 181         pass
 182     else:
 183         if verbose:
 184             print module_bin_dir, " doesn't exist"
 185         pass
 186
 187     #directory idl/salome : create it and link content
 188     if os.path.exists(module_idl_dir):
 189         mkdir(idl_dir)
 190         for fn in os.listdir(module_idl_dir):
 191             symlink(os.path.join(module_idl_dir, fn), os.path.join(idl_dir, fn))
 192     else:
 193         if verbose:
 194             print module_idl_dir, " doesn't exist"
 195
 196     #directory lib/salome : create it and link content
 197     if os.path.exists(module_lib_dir):
 198         mkdir(lib_dir)
 199         for fn in os.listdir(module_lib_dir):
 200             symlink(os.path.join(module_lib_dir, fn), os.path.join(lib_dir, fn))
 201             pass
 202         pass
 203     else:
 204         if verbose:
 205             print module_lib_dir, " doesn't exist"
 206         pass
 207
 208     #directory lib/paraview : create it and link content
 209     if os.path.exists(module_pvlib_dir):
 210         mkdir(pvlib_dir)
 211         for fn in os.listdir(module_pvlib_dir):
 212             symlink(os.path.join(module_pvlib_dir, fn), os.path.join(pvlib_dir, fn))
 213             pass
 214         pass
 215     else:
 216         if verbose:
 217             print module_pvlib_dir, " doesn't exist"
 218         pass
 219
 220     #directory lib/pyversio/site-packages/salome : create it and link content
 221     if not os.path.exists(module_lib_py_dir):
 222         print "Python directory %s does not exist" % module_lib_py_dir
 223     else:
 224         # Specific action for the package salome
 225         module_lib_pypkg_dir=os.path.join(module_lib_py_dir,"salome")
 226         lib_pypkg_dir=os.path.join(lib_py_dir,"salome")
 227         mkdir(lib_pypkg_dir)
 228         mkdir(lib_py_shared_dir)
 229         for fn in os.listdir(module_lib_py_dir):
 230             if fn == "salome": continue
 231             symlink(os.path.join(module_lib_py_dir, fn), os.path.join(lib_py_dir, fn))
 232             pass
 233         if os.path.exists(module_lib_py_shared_dir):
 234             for fn in os.listdir(module_lib_py_shared_dir):
 235                 symlink(os.path.join(module_lib_py_shared_dir, fn), os.path.join(lib_py_shared_dir, fn))
 236                 pass
 237             pass
 238         if os.path.exists(module_lib_pypkg_dir):
 239             for fn in os.listdir(module_lib_pypkg_dir):
 240                 symlink(os.path.join(module_lib_pypkg_dir, fn), os.path.join(lib_pypkg_dir, fn))
 241                 pass
 242             pass
 243         else:
 244             if verbose:
 245                 print module_lib_py_shared_dir, " doesn't exist"
 246             pass
 247
 248     #directory share/doc/salome (KERNEL doc) : create it and link content
 249     if os.path.exists(module_sharedoc_dir):
 250         mkdir(sharedoc_dir)
 251         for fn in os.listdir(module_sharedoc_dir):
 252             if fn == 'gui':continue
 253             if fn == 'tui':continue
 254             if fn == 'examples':continue
 255             symlink(os.path.join(module_sharedoc_dir, fn), os.path.join(sharedoc_dir, fn))
 256             pass
 257         pass
 258
 259     #directory share/doc/salome/gui : create it and link content
 260     if os.path.exists(module_sharedoc_gui_dir):
 261         mkdir(sharedoc_gui_dir)
 262         for fn in os.listdir(module_sharedoc_gui_dir):
 263             symlink(os.path.join(module_sharedoc_gui_dir, fn), os.path.join(sharedoc_gui_dir, fn))
 264             pass
 265         pass
 266
 267     #directory share/doc/salome/tui : create it and link content
 268     if os.path.exists(module_sharedoc_tui_dir):
 269         mkdir(sharedoc_tui_dir)
 270         for fn in os.listdir(module_sharedoc_tui_dir):
 271             symlink(os.path.join(module_sharedoc_tui_dir, fn), os.path.join(sharedoc_tui_dir, fn))
 272             pass
 273         pass
 274
 275     #directory share/doc/salome/examples : create it and link content
 276     if os.path.exists(module_sharedoc_examples):
 277         mkdir(sharedoc_examples_dir)
 278         for fn in os.listdir(module_sharedoc_examples):
 279             symlink(os.path.join(module_sharedoc_examples, fn), os.path.join(sharedoc_examples_dir, fn))
 280             pass
 281         pass
 282
 283     #directory share/salome : create it and link content
 284     if os.path.exists(module_share_dir):
 285         mkdir(share_dir)
 286         for fn in os.listdir(module_share_dir):
 287             if fn in ["resources","plugins"] :
 288                 # Create the directory and then link the content
 289                 mkdir(os.path.join(share_dir,fn))
 290                 for ffn in os.listdir(os.path.join(module_share_dir,fn)):
 291                     symlink(os.path.join(module_share_dir, fn, ffn), os.path.join(share_dir,fn, ffn))
 292             else:
 293                 #other directories (not resources)
 294                 symlink(os.path.join(module_share_dir, fn), os.path.join(share_dir, fn))
 295     else:
 296         print "share/salome directory %s does not exist" % module_share_dir
 297         pass
 298
 299     #html files in doc/salome directory
 300     if os.path.exists(module_doc_dir):
 301         mkdir(doc_dir)
 302         for fn in os.listdir(module_doc_dir):
 303             if fn == 'gui':continue
 304             if fn == 'tui':continue
 305             symlink(os.path.join(module_doc_dir, fn), os.path.join(doc_dir, fn))
 306             pass
 307         pass
 308
 309     #directory doc/salome/gui : create it and link content
 310     if os.path.exists(module_doc_gui_dir):
 311         mkdir(doc_gui_dir)
 312         for fn in os.listdir(module_doc_gui_dir):
 313             symlink(os.path.join(module_doc_gui_dir, fn), os.path.join(doc_gui_dir, fn))
 314             pass
 315         pass
 316
 317     #directory doc/salome/tui : create it and link content
 318     if os.path.exists(module_doc_tui_dir):
 319         mkdir(doc_tui_dir)
 320         for fn in os.listdir(module_doc_tui_dir):
 321             symlink(os.path.join(module_doc_tui_dir, fn), os.path.join(doc_tui_dir, fn))
 322             pass
 323         pass
 324
 325 # -----------------------------------------------------------------------------
 326
 327 def main():
 328     usage="""usage: %prog [options]
 329 Typical use is:
 330   python virtual_salome.py -v --prefix="." --module=/local/chris/SALOME2/RELEASES/Install/KERNEL_V3_1_0b1
 331 """
 332     parser = optparse.OptionParser(usage=usage)
 333
 334     parser.add_option('-v', '--verbose', action='count', dest='verbose',
 335                       default=0, help="Increase verbosity")
 336
 337     parser.add_option('--prefix', dest="prefix", default='.',
 338                       help="The base directory to install to (default .)")
 339
 340     parser.add_option('--module', dest="module",
 341                       help="The module directory to install in (mandatory)")
 342
 343     parser.add_option('--clear', dest='clear', action='store_true',
 344         help="Clear out the install and start from scratch")
 345
 346     options, args = parser.parse_args()
 347     link_module(options)
 348     pass
 349
 350 # -----------------------------------------------------------------------------
 351
 352 if __name__ == '__main__':
 353     main()
 354     pass