8 # Compatibility python 2/3 for input function
9 # input stays input for python 3 and input = raw_input for python 2
17 # Define all possible option for log command : sat log <options>
18 parser = src.options.Options()
19 parser.add_option('t', 'terminal', 'boolean', 'terminal', "Terminal log.")
20 parser.add_option('l', 'last', 'boolean', 'last', "Show the log of the last "
22 parser.add_option('f', 'full', 'boolean', 'full', "Show the logs of ALL "
24 parser.add_option('c', 'clean', 'int', 'clean', "Erase the n most ancient "
27 def get_last_log_file(logDir, notShownCommands):
28 '''Used in case of last option. Get the last log command file path.
30 :param logDir str: The directory where to search the log files
31 :param notShownCommands list: the list of commands to ignore
32 :return: the path to the last log file
36 for fileName in os.listdir(logDir):
37 # YYYYMMDD_HHMMSS_namecmd.xml
38 sExpr = src.logger.logCommandFileExpression
39 oExpr = re.compile(sExpr)
40 if oExpr.search(fileName):
41 # get date and hour and format it
42 date_hour_cmd = fileName.split('_')
43 datehour = date_hour_cmd[0] + date_hour_cmd[1]
44 cmd = date_hour_cmd[2][:-len('.xml')]
45 if cmd in notShownCommands:
47 if int(datehour) > last[1]:
48 last = (fileName, int(datehour))
49 return os.path.join(logDir, last[0])
51 def remove_log_file(filePath, logger):
52 if os.path.exists(filePath):
53 logger.write(src.printcolors.printcWarning("Removing ")
57 def print_log_command_in_terminal(filePath, logger):
58 '''Print the contain of filePath. It contains a command log in xml format.
60 :param filePath: The command xml file from which extract the commands
62 :param logger Logger: the logging instance to use in order to print.
64 logger.write(_("Reading ") + src.printcolors.printcHeader(filePath) + "\n", 5)
65 # Instantiate the ReadXmlFile class that reads xml files
66 xmlRead = src.xmlManager.ReadXmlFile(filePath)
67 # Get the attributes containing the context (user, OS, time, etc..)
68 dAttrText = xmlRead.get_attrib('Site')
69 # format dAttrText and print the context
71 for attrib in dAttrText:
72 lAttrText.append((attrib, dAttrText[attrib]))
74 src.print_info(logger, lAttrText)
76 command_traces = xmlRead.get_node_text('Log')
77 # Print it if there is any
79 logger.write(src.printcolors.printcHeader(
80 _("Here are the command traces :\n")), 1)
81 logger.write(command_traces, 1)
85 '''Ask for an int n. 0<n<nb
87 :param nb int: The maximum value of the value to be returned by the user.
88 :return: the value entered by the user. Return -1 if it is not as expected
93 rep = input(_("Which one (enter or 0 to quit)? "))
94 # Verify it is on the right range
107 '''method that is called when salomeTools is called with --help option.
109 :return: The text to display for the log command description.
112 return _("Gives access to the logs produced by the salomeTools commands.")
114 def run(args, runner, logger):
115 '''method that is called when salomeTools is called with log parameter.
118 (options, args) = parser.parse_args(args)
120 # get the log directory.
121 # If there is an application, it is in cfg.APPLICATION.out_dir,
122 # else in user directory
123 logDir = runner.cfg.SITE.log.logDir
125 # If the clean options is invoked,
126 # do nothing but deleting the concerned files.
128 nbClean = options.clean
129 # get the list of files to remove
130 lLogs = src.logger.list_log_file(logDir,
131 src.logger.logCommandFileExpression)
132 nbLogFiles = len(lLogs)
133 # Delete all if the invoked number is bigger than the number of log files
134 if nbClean > nbLogFiles:
136 # Get the list to delete and do the removing
137 lLogsToDelete = sorted(lLogs)[:nbClean]
138 for filePath, _, _, _, _, _ in lLogsToDelete:
139 # remove the xml log file
140 remove_log_file(filePath, logger)
141 # remove also the corresponding txt file in OUT directory
142 txtFilePath = os.path.join(os.path.dirname(filePath),
144 os.path.basename(filePath)[:-len('.xml')] + '.txt')
145 remove_log_file(txtFilePath, logger)
146 # remove also the corresponding pyconf file in OUT directory
147 pyconfFilePath = os.path.join(os.path.dirname(filePath),
149 os.path.basename(filePath)[:-len('.xml')] + '.pyconf')
150 remove_log_file(pyconfFilePath, logger)
153 logger.write(src.printcolors.printcSuccess("OK\n"))
154 logger.write("%i logs deleted.\n" % nbClean)
157 # determine the commands to show in the hat log
158 notShownCommands = runner.cfg.INTERNAL.log.notShownCommands
160 notShownCommands = []
162 # If the last option is invoked, just, show the last log file
164 lastLogFilePath = get_last_log_file(logDir, notShownCommands)
166 # Show the log corresponding to the selected command call
167 print_log_command_in_terminal(lastLogFilePath, logger)
169 # open the log xml file in the user editor
170 src.system.show_in_editor(runner.cfg.USER.browser,
171 lastLogFilePath, logger)
174 # If the user asks for a terminal display
176 # Parse the log directory in order to find
177 # all the files corresponding to the commands
178 lLogs = src.logger.list_log_file(logDir,
179 src.logger.logCommandFileExpression)
181 for filePath, _, date, _, hour, cmd in lLogs:
182 showLog, cmdAppli = src.logger.show_command_log(filePath, cmd,
183 runner.cfg.VARS.application, notShownCommands)
185 lLogsFiltered.append((filePath, date, hour, cmd, cmdAppli))
187 lLogsFiltered = sorted(lLogsFiltered)
188 nb_logs = len(lLogsFiltered)
190 # loop on all files and print it with date, time and command name
191 for _, date, hour, cmd, cmdAppli in lLogsFiltered:
192 num = src.printcolors.printcLabel("%2d" % (nb_logs - index))
193 logger.write("%s: %13s %s %s %s\n" %
194 (num, cmd, date, hour, cmdAppli), 1, False)
197 # ask the user what for what command he wants to be displayed
200 x = ask_value(nb_logs)
202 index = len(lLogsFiltered) - int(x)
203 # Show the log corresponding to the selected command call
204 print_log_command_in_terminal(lLogsFiltered[index][0], logger)
210 # Find the stylesheets Directory and files
211 xslDir = os.path.join(runner.cfg.VARS.srcDir, 'xsl')
212 xslCommand = os.path.join(xslDir, "command.xsl")
213 xslHat = os.path.join(xslDir, "hat.xsl")
214 imgLogo = os.path.join(xslDir, "LOGO-SAT.png")
216 # copy the stylesheets in the log directory
217 shutil.copy2(xslCommand, logDir)
218 shutil.copy2(xslHat, logDir)
219 shutil.copy2(imgLogo, logDir)
221 # Create or update the hat xml that gives access to all the commands log files
222 xmlHatFilePath = os.path.join(logDir, 'hat.xml')
223 src.logger.update_hat_xml(runner.cfg.SITE.log.logDir,
224 application = runner.cfg.VARS.application,
225 notShownCommands = notShownCommands)
227 # open the hat xml in the user editor
228 src.system.show_in_editor(runner.cfg.USER.browser, xmlHatFilePath, logger)