Salome HOME
[FORUM 505] prepare command fix on windows
[tools/sat.git] / src / system.py
index 73f9c18385b495dabdfc59f5fa1ee03bf5f515b6..7b8d1492bbbb3082f4c9b0eb04b5c7ef74401c0a 100644 (file)
@@ -22,9 +22,11 @@ like open a browser or an editor, or call a git command
 '''
 
 import os
-import subprocess
+import subprocess as SP
 import time
 import tarfile
+import time
 
 import debug as DBG
 import utilsSat as UTS
@@ -49,33 +51,79 @@ def show_in_editor(editor, filePath, logger):
         # launch cmd using subprocess.Popen
         cmd = editor % filePath
         logger.write('Launched command:\n' + cmd + '\n', 5)
-        p = subprocess.Popen(cmd, shell=True)
+        p = SP.Popen(cmd, shell=True)
         p.communicate()
-    except:
+    except Exception:
         logger.write(printcolors.printcError(_("Unable to edit file %s\n") 
                                              % filePath), 1)
 
+def show_in_webbrowser(editor, filePath, logger):
+    '''open filePath using web browser firefox, chromium etc...
+    if file is xml, previous http sever is done before to fix new security problems
+    
+    :param editor str: The web browser to use.
+    :param filePath str: The path to the file to open.
+    '''
+    import psutil
+    # default editor is firefox
+    if editor is None or len(editor) == 0:
+        editor = 'firefox'
+    
+    path, namefile = os.path.split(filePath)
+    basefile, ext = os.path.splitext(namefile)
+
+    # previouly http.server 8765/6/7... kill ... or not ? TODO wait and see REX
+    port = os.getenv('SAT_PORT_LOG', '8765')
+    for proc in psutil.process_iter():
+      # help(proc)
+      cmdline = " ".join(proc.cmdline())
+      if "python3 -m http.server %s" % port in cmdline:
+        print("kill previous process '%s'" % cmdline)
+        proc.kill()  # TODO may be not owner ? -> change 8766/7/8... as SAT_PORT_LOG
+        
+    cmd = """
+set -x
+cd %(path)s
+python3 -m http.server %(port)s &> /dev/null &
+%(editor)s http://localhost:%(port)s/%(namefile)s
+""" % {"path": path, "editor": editor, "namefile": namefile, 'port': port}
+
+    # print("show_in_webbrowser:\n%s" % cmd)
+    
+    try:
+        # launch cmd using subprocess.Popen
+        logger.write('Launched command:\n%s\n' % cmd, 5)
+        p = SP.Popen(cmd, shell=True, stdout=SP.PIPE, stderr=SP.STDOUT)
+        res_out, _ = p.communicate()   # _ = None as stderr=SP.STDOUT
+        # print("Launched command stdout:\n%s" % res_out)
+    except Exception as e:
+        logger.write(printcolors.printcError(_("Unable to display file %s\n%s\n") 
+                                             % (filePath, e)), 1)
+    
+
 def git_describe(repo_path):
     '''Use git describe --tags command to return tag description of the git repository"
     :param repo_path str: The git repository to describe
     '''
     git_cmd="cd %s;git describe --tags" % repo_path
-    p = subprocess.Popen(git_cmd, shell=True,
-                    stdin=subprocess.PIPE,
-                    stdout=subprocess.PIPE,
-                    stderr=subprocess.PIPE)
+    p = SP.Popen(git_cmd, shell=True, stdin=SP.PIPE, stdout=SP.PIPE, stderr=SP.PIPE)
     p.wait()
     if p.returncode != 0:
         return False
     else:
-        return p.stdout.readlines()[0].strip()
+        tag_description=p.stdout.readlines()[0].strip()
+        # with python3 this utf8 bytes should be decoded
+        if isinstance(tag_description, bytes):
+            tag_description=tag_description.decode("utf-8", "ignore")
+        return tag_description
 
 
-def git_extract(from_what, tag, where, logger, environment=None):
+def git_extract(from_what, tag, git_options, where, logger, environment=None):
   '''Extracts sources from a git repository.
-
+87
   :param from_what str: The remote git repository.
   :param tag str: The tag.
+  :param git_options str: git options
   :param where str: The path where to extract.
   :param logger Logger: The logger instance to use.
   :param environment src.environment.Environ: The environment to source when extracting.
@@ -85,39 +133,52 @@ def git_extract(from_what, tag, where, logger, environment=None):
   DBG.write("git_extract", [from_what, tag, str(where)])
   if not where.exists():
     where.make()
+  where_git = os.path.join(str(where), ".git")
   if tag == "master" or tag == "HEAD":
     if src.architecture.is_windows():
-      cmd = "git clone %(remote)s %(where)s"
+      cmd = "git clone %(git_options)s %(remote)s %(where)s"
     else:
       cmd = r"""
 set -x
-git clone %(remote)s %(where)s
+git clone %(git_options)s %(remote)s %(where)s
+res=$?
+if [ $res -eq 0 ]; then
+  touch -d "$(git --git-dir=%(where_git)s  log -1 --format=date_format)" %(where)s
+fi
+exit $res
 """
-    cmd = cmd % {'remote': from_what, 'tag': tag, 'where': str(where)}
+    cmd = cmd % {'git_options': git_options, 'remote': from_what, 'tag': tag, 'where': str(where), 'where_git': where_git}
   else:
     # NOTICE: this command only works with recent version of git
     #         because --work-tree does not work with an absolute path
-    where_git = os.path.join(str(where), ".git")
     if src.architecture.is_windows():
-      cmd = "rmdir %(where)s && git clone %(remote)s %(where)s && git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s"
+      cmd = "rmdir /S /Q %(where)s && git clone %(git_options)s %(remote)s %(where)s && git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s"
     else:
+# for sat compile --update : changes the date of directory, only for branches, not tag
       cmd = r"""
 set -x
-rmdir %(where)s
-git clone %(remote)s %(where)s && \
+rm -rf %(where)s
+git clone %(git_options)s %(remote)s %(where)s && \
 git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s
+res=$?
+git --git-dir=%(where_git)s status | grep HEAD
+if [ $res -eq 0 -a $? -ne 0 ]; then
+  touch -d "$(git --git-dir=%(where_git)s  log -1 --format=date_format)" %(where)s
+fi
+exit $res
 """
-    cmd = cmd % {'remote': from_what,
+    cmd = cmd % {'git_options': git_options,
+                 'remote': from_what,
                  'tag': tag,
                  'where': str(where),
                  'where_git': where_git}
 
 
+  cmd=cmd.replace('date_format', '"%ai"')
   logger.logTxtFile.write("\n" + cmd + "\n")
   logger.logTxtFile.flush()
 
   DBG.write("cmd", cmd)
-
   # git commands may fail sometimes for various raisons 
   # (big module, network troubles, tuleap maintenance)
   # therefore we give several tries
@@ -136,11 +197,12 @@ git --git-dir=%(where_git)s --work-tree=%(where)s checkout %(tag)s
   return rc.isOk()
 
 
-def git_extract_sub_dir(from_what, tag, where, sub_dir, logger, environment=None):
+def git_extract_sub_dir(from_what, tag, git_options, where, sub_dir, logger, environment=None):
   '''Extracts sources from a subtree sub_dir of a git repository.
 
   :param from_what str: The remote git repository.
   :param tag str: The tag.
+  :param git_options str: git options
   :param where str: The path where to extract.
   :param sub_dir str: The relative path of subtree to extract.
   :param logger Logger: The logger instance to use.
@@ -157,7 +219,8 @@ def git_extract_sub_dir(from_what, tag, where, sub_dir, logger, environment=None
   if os.path.isdir(strWhere):
     logger.error("do not override existing directory: %s" % strWhere)
     return False
-  aDict = {'remote': from_what,
+  aDict = {'git_options': git_options,
+           'remote': from_what,
            'tag': tag,
            'sub_dir': sub_dir,
            'where': strWhere,
@@ -170,7 +233,7 @@ def git_extract_sub_dir(from_what, tag, where, sub_dir, logger, environment=None
 set -x
 export tmpDir=%(tmpWhere)s && \
 rm -rf $tmpDir
-git clone %(remote)s $tmpDir && \
+git clone %(git_options)s %(remote)s $tmpDir && \
 cd $tmpDir && \
 git checkout %(tag)s && \
 mv %(sub_dir)s %(where)s && \
@@ -181,13 +244,13 @@ rm -rf $tmpDir
     cmd = r"""
 
 set tmpDir=%(tmpWhere)s && \
-rm -rf $tmpDir
-git clone %(remote)s $tmpDir && \
-cd $tmpDir && \
+rmdir /S /Q %tmpDir%
+git clone %(git_options)s %(remote)s %tmpDir% && \
+cd %tmpDir% && \
 git checkout %(tag)s && \
 mv %(sub_dir)s %(where)s && \
-git log -1 > %(where)s/README_git_log.txt && \
-rm -rf $tmpDir
+git log -1 > %(where)s\\README_git_log.txt && \
+rmdir /S /Q %tmpDir%
 """ % aDict
 
   DBG.write("cmd", cmd)
@@ -263,12 +326,11 @@ def cvs_extract(protocol, user, server, base, tag, product, where,
 
     logger.logTxtFile.write("\n" + command + "\n")
     logger.logTxtFile.flush()        
-    res = subprocess.call(command,
-                          cwd=str(where.dir()),
-                          env=environment.environ.environ,
-                          shell=True,
-                          stdout=logger.logTxtFile,
-                          stderr=subprocess.STDOUT)
+    res = SP.call(command, cwd=str(where.dir()),
+                           env=environment.environ.environ,
+                           shell=True,
+                           stdout=logger.logTxtFile,
+                           stderr=SP.STDOUT)
     return (res == 0)
 
 def svn_extract(user,
@@ -315,10 +377,103 @@ def svn_extract(user,
     logger.write(command + "\n", 5)
     logger.logTxtFile.write("\n" + command + "\n")
     logger.logTxtFile.flush()
-    res = subprocess.call(command,
-                          cwd=str(where.dir()),
-                          env=environment.environ.environ,
-                          shell=True,
-                          stdout=logger.logTxtFile,
-                          stderr=subprocess.STDOUT)
+    res = SP.call(command, cwd=str(where.dir()),
+                           env=environment.environ.environ,
+                           shell=True,
+                           stdout=logger.logTxtFile,
+                           stderr=SP.STDOUT)
     return (res == 0)
+
+def get_pkg_check_cmd(dist_name):
+    '''Build the command to use for checking if a linux package is installed or not.'''
+
+    if dist_name in ["CO","FD","MG","MD","CO","OS"]: # linux using rpm
+        linux="RH"  
+        manager_msg_err="Error : command failed because sat was not able to find apt command"
+    else:
+        linux="DB"
+        manager_msg_err="Error : command failed because sat was not able to find rpm command"
+
+    # 1- search for an installed package manager (rpm on rh, apt or dpkg-query on db)
+    cmd_which_rpm  = ["which", "rpm"]
+    cmd_which_apt  = ["which", "apt"]
+    cmd_which_dpkg = ["which", "dpkg-query"]
+    with open(os.devnull, 'w') as devnull:
+        # 1) we search for apt (debian based systems)
+        completed=SP.call(cmd_which_dpkg,stdout=devnull, stderr=SP.STDOUT)
+        if completed==0 and linux=="DB":
+            cmd_is_package_installed = ["dpkg-query", "-l"]
+        else:
+            # 2) if dpkg not found search for apt
+            completed = SP.call(cmd_which_apt, stdout=devnull, stderr=SP.STDOUT)
+            if completed == 0 and linux == "DB":
+                cmd_is_package_installed = ["apt", "list", "--installed"]
+            else:
+                # 3) if apt not found search for rpm (redhat)
+                completed=SP.call(cmd_which_rpm,stdout=devnull, stderr=SP.STDOUT) # only 3.8! ,capture_output=True)
+                if completed==0 and linux=="RH":
+                    cmd_is_package_installed=["rpm", "-q"]
+                else:
+                    # no package manager was found corresponding to dist_name
+                    raise src.SatException(manager_msg_err)
+    return cmd_is_package_installed
+
+def check_system_pkg(check_cmd,pkg):
+    '''Check if a package is installed
+    :param check_cmd list: the list of command to use system package manager
+    :param user str: the pkg name to check
+    :rtype: str
+    :return: a string with package name with status un message
+    '''
+    # build command
+    FNULL = open(os.devnull, 'w')
+    cmd_is_package_installed=[]
+    for cmd in check_cmd:
+        cmd_is_package_installed.append(cmd)
+    cmd_is_package_installed.append(pkg)
+
+
+    if check_cmd[0]=="apt":
+        # special treatment for apt
+        # apt output is too messy for being used
+        # some debian packages have version numbers in their name, we need to add a *
+        # also apt do not return status, we need to use grep
+        # and apt output is too messy for being used 
+        cmd_is_package_installed[-1]+="*" # we don't specify in pyconf the exact name because of version numbers
+        p=SP.Popen(cmd_is_package_installed, stdout=SP.PIPE, stderr=FNULL)
+        try:
+            output = SP.check_output(['grep', pkg], stdin=p.stdout)
+            msg_status=src.printcolors.printcSuccess("OK")
+        except Exception:
+            msg_status=src.printcolors.printcError("KO")
+            msg_status+=" (package is not installed!)\n"
+    elif check_cmd[0] == "dpkg-query":
+        # special treatment for dpkg-query
+        # some debian packages have version numbers in their name, we need to add a *
+        # also dpkg-query do not return status, we need to use grep
+        # and dpkg-query output is too messy for being used
+        cmd_is_package_installed[-1] = (
+            cmd_is_package_installed[-1] + "*"
+        )  # we don't specify in pyconf the exact name because of version numbers
+        p = SP.Popen(cmd_is_package_installed, stdout=SP.PIPE, stderr=FNULL)
+        try:
+            output = SP.check_output(["grep", "^ii"], stdin=p.stdout)
+            msg_status = src.printcolors.printcSuccess("OK")
+        except SP.CalledProcessError:
+            msg_status = src.printcolors.printcError("KO")
+            msg_status += " (package is not installed!)\n"
+    else:
+        p=SP.Popen(cmd_is_package_installed, stdout=SP.PIPE, stderr=FNULL)
+        output, err = p.communicate()
+        rc = p.returncode
+        if rc==0:
+            msg_status=src.printcolors.printcSuccess("OK")
+            # in python3 output is a byte and should be decoded
+            if isinstance(output, bytes):
+                output = output.decode("utf-8", "ignore")
+            msg_status+=" (" + output.replace('\n',' ') + ")\n" # remove output trailing \n
+        else:
+            msg_status=src.printcolors.printcError("KO")
+            msg_status+=" (package is not installed!)\n"
+
+    return msg_status