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