bin/virtual_salome.py

   1 #  -*- coding: iso-8859-1 -*-
   2 # Copyright (C) 2007-2015  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_path:
 102         print "Option module is mandatory"
 103         return
 104
 105     module_dir=os.path.abspath(options.module_path)
 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_test_dir=os.path.join(module_dir,'bin','salome', 'test')
 135     module_idl_dir=os.path.join(module_dir,'idl','salome')
 136     module_lib_dir=os.path.join(module_dir,get_lib_dir(),'salome')
 137     module_pvlib_dir=os.path.join(module_dir,get_lib_dir(),'paraview')
 138     module_lib_py_dir=os.path.join(module_dir,get_lib_dir(),pyversio,'site-packages','salome')
 139     module_lib_py_shared_dir=os.path.join(module_dir,get_lib_dir(),pyversio,
 140                                           'site-packages','salome')
 141     module_share_dir=os.path.join(module_dir,'share','salome')
 142     module_doc_gui_dir=os.path.join(module_dir,'doc','salome','gui')
 143     module_doc_tui_dir=os.path.join(module_dir,'doc','salome','tui')
 144     module_doc_dir=os.path.join(module_dir,'doc','salome')
 145     module_sharedoc_dir=os.path.join(module_dir,'share','doc','salome')
 146     module_sharedoc_gui_dir=os.path.join(module_dir,'share','doc','salome','gui')
 147     module_sharedoc_tui_dir=os.path.join(module_dir,'share','doc','salome','tui')
 148     module_sharedoc_examples=os.path.join(module_dir,'share','doc','salome','examples')
 149     module_sharedoc_dev=os.path.join(module_dir,'share','doc','salome','dev')
 150
 151     bin_dir=os.path.join(home_dir,'bin','salome')
 152     test_dir=os.path.join(home_dir,'bin','salome', 'test')
 153     idl_dir=os.path.join(home_dir,'idl','salome')
 154     lib_dir=os.path.join(home_dir,'lib','salome')
 155     pvlib_dir=os.path.join(home_dir,'lib','paraview')
 156     lib_py_dir=os.path.join(home_dir,'lib',pyversio,'site-packages','salome')
 157     lib_py_shared_dir=os.path.join(home_dir,'lib',pyversio,
 158                                    'site-packages','salome')
 159     share_dir=os.path.join(home_dir,'share','salome')
 160     doc_gui_dir=os.path.join(home_dir,'doc','salome','gui')
 161     doc_tui_dir=os.path.join(home_dir,'doc','salome','tui')
 162     doc_dir=os.path.join(home_dir,'doc','salome')
 163     sharedoc_dir=os.path.join(home_dir,'share','doc','salome')
 164     sharedoc_gui_dir=os.path.join(home_dir,'share','doc','salome','gui')
 165     sharedoc_tui_dir=os.path.join(home_dir,'share','doc','salome','tui')
 166     sharedoc_examples_dir=os.path.join(home_dir,'share','doc','salome','examples')
 167     sharedoc_dev_dir=os.path.join(home_dir,'share','doc','salome','dev')
 168
 169     if options.clear:
 170         rmtree(bin_dir)
 171         rmtree(test_dir)
 172         rmtree(idl_dir)
 173         rmtree(lib_dir)
 174         rmtree(lib_py_dir)
 175         rmtree(share_dir)
 176         rmtree(doc_dir)
 177         rmtree(sharedoc_dir)
 178         pass
 179
 180     #directory bin/salome : create it and link content
 181     if os.path.exists(module_bin_dir):
 182         mkdir(bin_dir)
 183         mkdir(test_dir)
 184         for fn in os.listdir(module_bin_dir):
 185             if fn != "test":
 186                 symlink(os.path.join(module_bin_dir, fn), os.path.join(bin_dir, fn))
 187             pass
 188         pass
 189     else:
 190         if verbose:
 191             print module_bin_dir, " doesn't exist"
 192         pass
 193
 194     #directory bin/salome/test : create it and link content
 195     if os.path.exists(module_test_dir):
 196         # link <appli_path>/bin/salome/test/<module> to <module_path>/bin/salome/test
 197         print "link %s --> %s"%(os.path.join(test_dir, options.module_name), module_test_dir)
 198         symlink(module_test_dir, os.path.join(test_dir, options.module_name))
 199         # register module for testing in CTestTestfile.cmake
 200         with open(os.path.join(test_dir, "CTestTestfile.cmake"), "ab") as f:
 201             f.write("SUBDIRS(%s)\n"%options.module_name)
 202     else:
 203         if verbose:
 204             print module_test_dir, " doesn't exist"
 205         pass
 206
 207     #directory idl/salome : create it and link content
 208     if os.path.exists(module_idl_dir):
 209         mkdir(idl_dir)
 210         for fn in os.listdir(module_idl_dir):
 211             symlink(os.path.join(module_idl_dir, fn), os.path.join(idl_dir, fn))
 212     else:
 213         if verbose:
 214             print module_idl_dir, " doesn't exist"
 215
 216     #directory lib/salome : create it and link content
 217     if os.path.exists(module_lib_dir):
 218         mkdir(lib_dir)
 219         for fn in os.listdir(module_lib_dir):
 220             symlink(os.path.join(module_lib_dir, fn), os.path.join(lib_dir, fn))
 221             pass
 222         pass
 223     else:
 224         if verbose:
 225             print module_lib_dir, " doesn't exist"
 226         pass
 227
 228     #directory lib/paraview : create it and link content
 229     if os.path.exists(module_pvlib_dir):
 230         mkdir(pvlib_dir)
 231         for fn in os.listdir(module_pvlib_dir):
 232             symlink(os.path.join(module_pvlib_dir, fn), os.path.join(pvlib_dir, fn))
 233             pass
 234         pass
 235     else:
 236         if verbose:
 237             print module_pvlib_dir, " doesn't exist"
 238         pass
 239
 240     #directory lib/pyversio/site-packages/salome : create it and link content
 241     if not os.path.exists(module_lib_py_dir):
 242         print "Python directory %s does not exist" % module_lib_py_dir
 243     else:
 244         # Specific action for the package salome
 245         module_lib_pypkg_dir=os.path.join(module_lib_py_dir,"salome")
 246         lib_pypkg_dir=os.path.join(lib_py_dir,"salome")
 247         mkdir(lib_pypkg_dir)
 248         mkdir(lib_py_shared_dir)
 249         for fn in os.listdir(module_lib_py_dir):
 250             if fn == "salome": continue
 251             symlink(os.path.join(module_lib_py_dir, fn), os.path.join(lib_py_dir, fn))
 252             pass
 253         if os.path.exists(module_lib_py_shared_dir):
 254             for fn in os.listdir(module_lib_py_shared_dir):
 255                 symlink(os.path.join(module_lib_py_shared_dir, fn), os.path.join(lib_py_shared_dir, fn))
 256                 pass
 257             pass
 258         if os.path.exists(module_lib_pypkg_dir):
 259             for fn in os.listdir(module_lib_pypkg_dir):
 260                 symlink(os.path.join(module_lib_pypkg_dir, fn), os.path.join(lib_pypkg_dir, fn))
 261                 pass
 262             pass
 263         else:
 264             if verbose:
 265                 print module_lib_py_shared_dir, " doesn't exist"
 266             pass
 267
 268     #directory share/doc/salome (KERNEL doc) : create it and link content
 269     if os.path.exists(module_sharedoc_dir):
 270         mkdir(sharedoc_dir)
 271         for fn in os.listdir(module_sharedoc_dir):
 272             if fn == 'gui':continue
 273             if fn == 'tui':continue
 274             if fn == 'examples':continue
 275             if fn == 'dev':continue
 276             symlink(os.path.join(module_sharedoc_dir, fn), os.path.join(sharedoc_dir, fn))
 277             pass
 278         pass
 279
 280     #directory share/doc/salome/gui : create it and link content
 281     if os.path.exists(module_sharedoc_gui_dir):
 282         mkdir(sharedoc_gui_dir)
 283         for fn in os.listdir(module_sharedoc_gui_dir):
 284             symlink(os.path.join(module_sharedoc_gui_dir, fn), os.path.join(sharedoc_gui_dir, fn))
 285             pass
 286         pass
 287
 288     #directory share/doc/salome/tui : create it and link content
 289     if os.path.exists(module_sharedoc_tui_dir):
 290         mkdir(sharedoc_tui_dir)
 291         for fn in os.listdir(module_sharedoc_tui_dir):
 292             symlink(os.path.join(module_sharedoc_tui_dir, fn), os.path.join(sharedoc_tui_dir, fn))
 293             pass
 294         pass
 295
 296     #directory share/doc/salome/examples : create it and link content
 297     if os.path.exists(module_sharedoc_examples):
 298         mkdir(sharedoc_examples_dir)
 299         for fn in os.listdir(module_sharedoc_examples):
 300             symlink(os.path.join(module_sharedoc_examples, fn), os.path.join(sharedoc_examples_dir, fn))
 301             pass
 302         pass
 303
 304     #directory share/doc/salome/dev : create it and link content
 305     if os.path.exists(module_sharedoc_dev):
 306         mkdir(sharedoc_dev_dir)
 307         for fn in os.listdir(module_sharedoc_dev):
 308             symlink(os.path.join(module_sharedoc_dev, fn), os.path.join(sharedoc_dev_dir, fn))
 309             pass
 310         pass
 311
 312     #directory share/salome : create it and link content
 313     if os.path.exists(module_share_dir):
 314         mkdir(share_dir)
 315         for fn in os.listdir(module_share_dir):
 316             if fn in ["resources","plugins"] :
 317                 # Create the directory and then link the content
 318                 mkdir(os.path.join(share_dir,fn))
 319                 for ffn in os.listdir(os.path.join(module_share_dir,fn)):
 320                     symlink(os.path.join(module_share_dir, fn, ffn), os.path.join(share_dir,fn, ffn))
 321             else:
 322                 #other directories (not resources)
 323                 symlink(os.path.join(module_share_dir, fn), os.path.join(share_dir, fn))
 324     else:
 325         print "share/salome directory %s does not exist" % module_share_dir
 326         pass
 327
 328     #html files in doc/salome directory
 329     if os.path.exists(module_doc_dir):
 330         mkdir(doc_dir)
 331         for fn in os.listdir(module_doc_dir):
 332             if fn == 'gui':continue
 333             if fn == 'tui':continue
 334             symlink(os.path.join(module_doc_dir, fn), os.path.join(doc_dir, fn))
 335             pass
 336         pass
 337
 338     #directory doc/salome/gui : create it and link content
 339     if os.path.exists(module_doc_gui_dir):
 340         mkdir(doc_gui_dir)
 341         for fn in os.listdir(module_doc_gui_dir):
 342             symlink(os.path.join(module_doc_gui_dir, fn), os.path.join(doc_gui_dir, fn))
 343             pass
 344         pass
 345
 346     #directory doc/salome/tui : create it and link content
 347     if os.path.exists(module_doc_tui_dir):
 348         mkdir(doc_tui_dir)
 349         for fn in os.listdir(module_doc_tui_dir):
 350             symlink(os.path.join(module_doc_tui_dir, fn), os.path.join(doc_tui_dir, fn))
 351             pass
 352         pass
 353
 354 def link_extra_test(options):
 355     global verbose
 356
 357     if not options.extra_test_path:
 358         print "Option extra_test is mandatory"
 359         return
 360
 361     extra_test_dir=os.path.abspath(options.extra_test_path)
 362     if not os.path.exists(extra_test_dir):
 363         print "Test %s does not exist" % extra_test_dir
 364         return
 365
 366     verbose = options.verbose
 367
 368     home_dir = os.path.expanduser(options.prefix)
 369     test_dir = os.path.join(home_dir,'bin','salome', 'test')
 370
 371     if options.clear:
 372         rmtree(test_dir)
 373         pass
 374
 375     #directory bin/salome/test : create it and link content
 376     if os.path.exists(extra_test_dir):
 377         # link <appli_path>/bin/salome/test/<extra_test> to <extra_test_path>/bin/salome/test
 378         print "link %s --> %s"%(os.path.join(test_dir, options.extra_test_name), extra_test_dir)
 379         symlink(extra_test_dir, os.path.join(test_dir, options.extra_test_name))
 380         # register extra_test for testing in CTestTestfile.cmake
 381         with open(os.path.join(test_dir, "CTestTestfile.cmake"), "ab") as f:
 382             f.write("SUBDIRS(%s)\n"%options.extra_test_name)
 383     else:
 384         if verbose:
 385             print extra_test_dir, " doesn't exist"
 386         pass
 387
 388 # -----------------------------------------------------------------------------
 389
 390 def main():
 391     usage="""usage: %prog [options]
 392 Typical use is:
 393   python virtual_salome.py -v --prefix="." --module=/local/chris/SALOME2/RELEASES/Install/KERNEL_V3_1_0b1
 394 """
 395     parser = optparse.OptionParser(usage=usage)
 396
 397     parser.add_option('-v', '--verbose', action='count', dest='verbose',
 398                       default=0, help="Increase verbosity")
 399
 400     parser.add_option('--prefix', dest="prefix", default='.',
 401                       help="The base directory to install to (default .)")
 402
 403     parser.add_option('--module', dest="module",
 404                       help="The module directory to install in (mandatory)")
 405
 406     parser.add_option('--clear', dest='clear', action='store_true',
 407         help="Clear out the install and start from scratch")
 408
 409     options, args = parser.parse_args()
 410     link_module(options)
 411     pass
 412
 413 # -----------------------------------------------------------------------------
 414
 415 if __name__ == '__main__':
 416     main()
 417     pass