bin/virtual_salome.py

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