X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=commands%2Flog.py;h=d8def14303da1197ca3abf5f33a2a00c8714a310;hb=5e8de5b0250970b0332af9d6f697cd510c802092;hp=ee473e572b6422b229e728c25c128f4b849472e7;hpb=f937509b54c4d8bfdf530733f8bda4a61c773727;p=tools%2Fsat.git diff --git a/commands/log.py b/commands/log.py index ee473e5..d8def14 100644 --- a/commands/log.py +++ b/commands/log.py @@ -1,19 +1,181 @@ #!/usr/bin/env python #-*- coding:utf-8 -*- +# Copyright (C) 2010-2012 CEA/DEN +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA import os import shutil import re +import glob +import datetime +import stat + +# Compatibility python 2/3 for input function +# input stays input for python 3 and input = raw_input for python 2 +try: + input = raw_input +except NameError: + pass import src # Define all possible option for log command : sat log parser = src.options.Options() -parser.add_option('t', 'terminal', 'boolean', 'terminal', "Terminal log.") +parser.add_option('t', 'terminal', 'boolean', 'terminal', "Optional: " + "Terminal log.") +parser.add_option('l', 'last', 'boolean', 'last', "Show the log of the last " + "Optional: launched command.") +parser.add_option('', 'last_terminal', 'boolean', 'last_terminal', "Show the " + "log of the last compilations" + "Optional: launched command.") +parser.add_option('f', 'full', 'boolean', 'full', "Optional: Show the logs of " + "ALL the launched commands.") +parser.add_option('c', 'clean', 'int', 'clean', "Optional: Erase the n most " + "ancient log files.") +parser.add_option('n', 'no_browser', 'boolean', 'no_browser', "Optional: Do not" + " launch the browser at the end of the command. Only update " + "the hat file.") + +def get_last_log_file(logDir, notShownCommands): + '''Used in case of last option. Get the last log command file path. + + :param logDir str: The directory where to search the log files + :param notShownCommands list: the list of commands to ignore + :return: the path to the last log file + :rtype: str + ''' + last = (_, 0) + for fileName in os.listdir(logDir): + # YYYYMMDD_HHMMSS_namecmd.xml + sExpr = src.logger.log_macro_command_file_expression + oExpr = re.compile(sExpr) + if oExpr.search(fileName): + # get date and hour and format it + date_hour_cmd = fileName.split('_') + datehour = date_hour_cmd[0] + date_hour_cmd[1] + cmd = date_hour_cmd[2] + if cmd in notShownCommands: + continue + if int(datehour) > last[1]: + last = (fileName, int(datehour)) + return os.path.join(logDir, last[0]) + +def remove_log_file(filePath, logger): + '''if it exists, print a warning and remove the input file + + :param filePath: the path of the file to delete + :param logger Logger: the logger instance to use for the print + ''' + if os.path.exists(filePath): + logger.write(src.printcolors.printcWarning("Removing ") + + filePath + "\n", 5) + os.remove(filePath) + +def print_log_command_in_terminal(filePath, logger): + '''Print the contain of filePath. It contains a command log in xml format. + + :param filePath: The command xml file from which extract the commands + context and traces + :param logger Logger: the logging instance to use in order to print. + ''' + logger.write(_("Reading ") + src.printcolors.printcHeader(filePath) + "\n", 5) + # Instantiate the ReadXmlFile class that reads xml files + xmlRead = src.xmlManager.ReadXmlFile(filePath) + # Get the attributes containing the context (user, OS, time, etc..) + dAttrText = xmlRead.get_attrib('Site') + # format dAttrText and print the context + lAttrText = [] + for attrib in dAttrText: + lAttrText.append((attrib, dAttrText[attrib])) + logger.write("\n", 1) + src.print_info(logger, lAttrText) + # Get the traces + command_traces = xmlRead.get_node_text('Log') + # Print it if there is any + if command_traces: + logger.write(src.printcolors.printcHeader( + _("Here are the command traces :\n")), 1) + logger.write(command_traces, 1) + logger.write("\n", 1) + +def show_last_logs(logger, config, log_dirs): + """Show last compilation logs""" + log_dir = os.path.join(config.APPLICATION.workdir, 'LOGS') + # list the logs + nb = len(log_dirs) + nb_cols = 4 + col_size = (nb / nb_cols) + 1 + for index in range(0, col_size): + for i in range(0, nb_cols): + k = index + i * col_size + if k < nb: + l = log_dirs[k] + str_indice = src.printcolors.printcLabel("%2d" % (k+1)) + log_name = l + logger.write("%s: %-30s" % (str_indice, log_name), 1, False) + logger.write("\n", 1, False) + + # loop till exit + x = -1 + while (x < 0): + x = ask_value(nb) + if x > 0: + product_log_dir = os.path.join(log_dir, log_dirs[x-1]) + show_product_last_logs(logger, config, product_log_dir) +def show_product_last_logs(logger, config, product_log_dir): + """Show last compilation logs of a product""" + # sort the files chronologically + l_time_file = [] + for file_n in os.listdir(product_log_dir): + my_stat = os.stat(os.path.join(product_log_dir, file_n)) + l_time_file.append( + (datetime.datetime.fromtimestamp(my_stat[stat.ST_MTIME]), file_n)) + + # display the available logs + for i, (__, file_name) in enumerate(sorted(l_time_file)): + str_indice = src.printcolors.printcLabel("%2d" % (i+1)) + opt = [] + my_stat = os.stat(os.path.join(product_log_dir, file_name)) + opt.append(str(datetime.datetime.fromtimestamp(my_stat[stat.ST_MTIME]))) + + opt.append("(%8.2f)" % (my_stat[stat.ST_SIZE] / 1024.0)) + logger.write(" %-35s" % " ".join(opt), 1, False) + logger.write("%s: %-30s\n" % (str_indice, file_name), 1, False) + + # loop till exit + x = -1 + while (x < 0): + x = ask_value(len(l_time_file)) + if x > 0: + (__, file_name) = sorted(l_time_file)[x-1] + log_file_path = os.path.join(product_log_dir, file_name) + src.system.show_in_editor(config.USER.editor, log_file_path, logger) + def ask_value(nb): + '''Ask for an int n. 0> sat log +""") def run(args, runner, logger): + '''method that is called when salomeTools is called with log parameter. + ''' + # Parse the options (options, args) = parser.parse_args(args) - # get the log directory. If there is an application, it is in cfg.APPLICATION.out_dir, else in user directory - logDir = runner.cfg.VARS.logDir + # get the log directory. + logDir = src.get_log_path(runner.cfg) + + # Print a header + nb_files_log_dir = len(glob.glob(os.path.join(logDir, "*"))) + info = [("log directory", logDir), + ("number of log files", nb_files_log_dir)] + src.print_info(logger, info) + + # If the clean options is invoked, + # do nothing but deleting the concerned files. + if options.clean: + nbClean = options.clean + # get the list of files to remove + lLogs = src.logger.list_log_file(logDir, + src.logger.log_all_command_file_expression) + nbLogFiles = len(lLogs) + # Delete all if the invoked number is bigger than the number of log files + if nbClean > nbLogFiles: + nbClean = nbLogFiles + # Get the list to delete and do the removing + lLogsToDelete = sorted(lLogs)[:nbClean] + for filePath, __, __, __, __, __, __ in lLogsToDelete: + # remove the xml log file + remove_log_file(filePath, logger) + # remove also the corresponding txt file in OUT directory + txtFilePath = os.path.join(os.path.dirname(filePath), + 'OUT', + os.path.basename(filePath)[:-len('.xml')] + '.txt') + remove_log_file(txtFilePath, logger) + # remove also the corresponding pyconf (do not exist 2016-06) + # file in OUT directory + pyconfFilePath = os.path.join(os.path.dirname(filePath), + 'OUT', + os.path.basename(filePath)[:-len('.xml')] + '.pyconf') + remove_log_file(pyconfFilePath, logger) + + + logger.write(src.printcolors.printcSuccess("OK\n")) + logger.write("%i logs deleted.\n" % nbClean) + return 0 + + # determine the commands to show in the hat log + notShownCommands = list(runner.cfg.INTERNAL.log.not_shown_commands) + if options.full: + notShownCommands = [] + + # Find the stylesheets Directory and files + xslDir = os.path.join(runner.cfg.VARS.srcDir, 'xsl') + xslCommand = os.path.join(xslDir, "command.xsl") + xslHat = os.path.join(xslDir, "hat.xsl") + xsltest = os.path.join(xslDir, "test.xsl") + imgLogo = os.path.join(xslDir, "LOGO-SAT.png") + + # copy the stylesheets in the log directory + # OP We use copy instead of copy2 to update the creation date + # So we can clean the LOGS directories easily + shutil.copy(xslCommand, logDir) + shutil.copy(xslHat, logDir) + src.ensure_path_exists(os.path.join(logDir, "TEST")) + shutil.copy(xsltest, os.path.join(logDir, "TEST")) + shutil.copy(imgLogo, logDir) + + # If the last option is invoked, just, show the last log file + if options.last_terminal: + src.check_config_has_application(runner.cfg) + log_dirs = os.listdir(os.path.join(runner.cfg.APPLICATION.workdir, + 'LOGS')) + show_last_logs(logger, runner.cfg, log_dirs) + return 0 + # If the last option is invoked, just, show the last log file + if options.last: + lastLogFilePath = get_last_log_file(logDir, + notShownCommands + ["config"]) + if options.terminal: + # Show the log corresponding to the selected command call + print_log_command_in_terminal(lastLogFilePath, logger) + else: + # open the log xml file in the user editor + src.system.show_in_editor(runner.cfg.USER.browser, + lastLogFilePath, logger) + return 0 + + # If the user asks for a terminal display if options.terminal: - lLogs = [] - for fileName in os.listdir(logDir): - sExpr = "^[0-9]{8}_+[0-9]{6}_+.*.xml$" - oExpr = re.compile(sExpr) - if oExpr.search(fileName): - lLogs.append(fileName) - lLogs = sorted(lLogs) - nb_logs = len(lLogs) - index = 0 - for t in lLogs: - date_hour_cmd = t.split('_') - date_not_formated = date_hour_cmd[0] - date = "%s/%s/%s" % (date_not_formated[6:8], date_not_formated[4:6], date_not_formated[0:4] ) - hour_not_formated = date_hour_cmd[1] - hour = "%s:%s:%s" % (hour_not_formated[0:2], hour_not_formated[2:4], hour_not_formated[4:6]) - cmd = date_hour_cmd[2][:-len('.xml')] + # Parse the log directory in order to find + # all the files corresponding to the commands + lLogs = src.logger.list_log_file(logDir, + src.logger.log_macro_command_file_expression) + lLogsFiltered = [] + for filePath, __, date, __, hour, cmd, __ in lLogs: + showLog, cmdAppli, __ = src.logger.show_command_log(filePath, cmd, + runner.cfg.VARS.application, notShownCommands) + if showLog: + lLogsFiltered.append((filePath, date, hour, cmd, cmdAppli)) + lLogsFiltered = sorted(lLogsFiltered) + nb_logs = len(lLogsFiltered) + index = 0 + # loop on all files and print it with date, time and command name + for __, date, hour, cmd, cmdAppli in lLogsFiltered: num = src.printcolors.printcLabel("%2d" % (nb_logs - index)) - logger.write("%s: %13s %s %s\n" % (num, cmd, date, hour), 1, False) + logger.write("%s: %13s %s %s %s\n" % + (num, cmd, date, hour, cmdAppli), 1, False) index += 1 - # ask the user + # ask the user what for what command he wants to be displayed x = -1 while (x < 0): x = ask_value(nb_logs) - if x > 0: - index = len(lLogs) - int(x) - show_log_command_in_terminal(os.path.join(logDir, lLogs[index]), logger) + index = len(lLogsFiltered) - int(x) + # Show the log corresponding to the selected command call + print_log_command_in_terminal(lLogsFiltered[index][0], logger) x = 0 - return + return 0 - - # Find the stylesheets Directory and files - xslDir = os.path.join(runner.cfg.VARS.srcDir, 'xsl') - xslCommand = os.path.join(xslDir, "command.xsl") - xslHat = os.path.join(xslDir, "hat.xsl") - imgLogo = os.path.join(xslDir, "LOGO-SAT.png") - - # copy the stylesheets in the log directory - shutil.copy2(xslCommand, logDir) - shutil.copy2(xslHat, logDir) - shutil.copy2(imgLogo, logDir) - + # Create or update the hat xml that gives access to all the commands log files + logger.write(_("Generating the hat log file (can be long) ... "), 3) xmlHatFilePath = os.path.join(logDir, 'hat.xml') - if 'APPLICATION' in runner.cfg: - src.xmlManager.update_hat_xml(runner.cfg.VARS.logDir, runner.cfg.VARS.application) - else: - src.xmlManager.update_hat_xml(runner.cfg.VARS.logDir) + src.logger.update_hat_xml(logDir, + application = runner.cfg.VARS.application, + notShownCommands = notShownCommands) + logger.write(src.printcolors.printc("OK"), 3) + logger.write("\n", 3) - src.system.show_in_editor(runner.cfg.USER.browser, xmlHatFilePath) \ No newline at end of file + # open the hat xml in the user editor + if not options.no_browser: + logger.write(_("\nOpening the log file\n"), 3) + src.system.show_in_editor(runner.cfg.USER.browser, xmlHatFilePath, logger) + return 0