import shutil
import re
+# 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 <options>
parser = src.options.Options()
parser.add_option('t', 'terminal', 'boolean', 'terminal', "Terminal log.")
+parser.add_option('l', 'last', 'boolean', 'last', "Show the log of the last launched command.")
+parser.add_option('f', 'full', 'boolean', 'full', "Show the logs of ALL launched commands.")
+parser.add_option('c', 'clean', 'int', 'clean', "Erase the n most ancient log files.")
-def show_log_command_in_terminal(filePath, logger):
+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.logCommandFileExpression
+ 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][:-len('.xml')]
+ if cmd in notShownCommands:
+ continue
+ if int(datehour) > last[1]:
+ last = (fileName, int(datehour))
+ return os.path.join(logDir, last[0])
+
+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
- :logger Logger: the logging instance to use in order to print.
+ :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:
command_traces = xmlRead.get_node_text('Log')
# Print it if there is any
if command_traces:
- logger.write(_("Here are the command traces :\n"), 1)
+ logger.write(src.printcolors.printcHeader(_("Here are the command traces :\n")), 1)
logger.write(command_traces, 1)
logger.write("\n", 1)
'''
try:
# ask for a value
- rep = raw_input(_("Which one (enter or 0 to quit)? "))
+ rep = input(_("Which one (enter or 0 to quit)? "))
# Verify it is on the right range
if len(rep) == 0:
x = 0
:return: The text to display for the log command description.
:rtype: str
'''
- return _("Gives access to logs of salomeTools.")
+ return _("Gives access to the logs produced by the salomeTools commands.")
def run(args, runner, logger):
'''method that is called when salomeTools is called with log parameter.
# get the log directory. If there is an application, it is in cfg.APPLICATION.out_dir, else in user directory
logDir = runner.cfg.SITE.log.logDir
+ # 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.logCommandFileExpression)
+ 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:
+ logger.write(src.printcolors.printcWarning("Removing ") + filePath + "\n", 5)
+ os.remove(filePath)
+
+ logger.write(src.printcolors.printcSuccess("OK\n"))
+ logger.write("%i files deleted.\n" % nbClean)
+ return 0
+
+ # determine the commands to show in the hat log
+ notShownCommands = runner.cfg.INTERNAL.log.notShownCommands
+ if options.full:
+ notShownCommands = []
+
# If the user asks for a terminal display
if options.terminal:
# Parse the log directory in order to find all the files corresponding to the commands
- 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)
+ lLogs = src.logger.list_log_file(logDir, src.logger.logCommandFileExpression)
+ 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 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')]
-
+ 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 what for what command he wants to be displayed
while (x < 0):
x = ask_value(nb_logs)
if x > 0:
- index = len(lLogs) - int(x)
+ index = len(lLogsFiltered) - int(x)
# Show the log corresponding to the selected command call
- show_log_command_in_terminal(os.path.join(logDir, lLogs[index]), logger)
+ print_log_command_in_terminal(lLogsFiltered[index][0], logger)
x = 0
return 0
shutil.copy2(xslCommand, logDir)
shutil.copy2(xslHat, logDir)
shutil.copy2(imgLogo, logDir)
-
+
+ # If the last option is invoked, just, show the last log file
+ if options.last:
+ lastLogFilePath = get_last_log_file(logDir, notShownCommands)
+ # open the log xml file in the user editor
+ src.system.show_in_editor(runner.cfg.USER.browser, lastLogFilePath, logger)
+ return 0
+
# Create or update the hat xml that gives access to all the commands log files
xmlHatFilePath = os.path.join(logDir, 'hat.xml')
- src.xmlManager.update_hat_xml(runner.cfg.SITE.log.logDir, runner.cfg.VARS.application)
+ src.logger.update_hat_xml(runner.cfg.SITE.log.logDir, application = runner.cfg.VARS.application, notShownCommands = notShownCommands)
# open the hat xml in the user editor
- src.system.show_in_editor(runner.cfg.USER.browser, xmlHatFilePath, logger)
\ No newline at end of file
+ src.system.show_in_editor(runner.cfg.USER.browser, xmlHatFilePath, logger)
+ return 0
\ No newline at end of file
