bin/virtual_salome.py

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