Merge 1f1b35b into ac5ab40

JulienCochuyt · web-flow · commit c3430248e3fe · 2019-08-13T07:28:23.000Z
diff --git a/source/globalCommands.py b/source/globalCommands.py
@@ -1540,6 +1540,42 @@ def script_navigatorObject_devInfo(self,gesture):
 	script_navigatorObject_devInfo.__doc__ = _("Logs information about the current navigator object which is useful to developers and activates the log viewer so the information can be examined.")
 	script_navigatorObject_devInfo.category=SCRCAT_TOOLS
 
+	@script(
+		# Translators: Input help mode message for a command to delimit then
+		# copy a fragment of the log to clipboard
+		description=_(
+			"Mark the current end of the log as the start of the fragment to be"
+			" copied to clipboard by pressing again."
+		),
+		category=SCRCAT_TOOLS,
+		gesture="kb:NVDA+control+shift+f1"
+	)
+	def script_log_markStartThenCopy(self, gesture):
+		if globalVars.appArgs.secure:
+			return
+		if log.fragmentStart is None:
+			if log.markFragmentStart():
+				# Translators: Message when marking the start of a fragment of the log file for later copy
+				# to clipboard
+				ui.message(_("Log fragment start position marked, press again to copy to clipboard"))
+			else:
+				# Translators: Message when failed to mark the start of a
+				# fragment of the log file for later copy to clipboard
+				ui.message(_("Unable to mark log position"))
+			return
+		text = log.getFragment()
+		if not text:
+			# Translators: Message when attempting to copy an empty fragment of the log file
+			ui.message(_("No new log entry to copy"))
+			return
+		if api.copyToClip(text):
+			# Translators: Message when a fragment of the log file has been
+			# copied to clipboard
+			ui.message(_("Log fragment copied to clipboard"))
+		else:
+			# Translators: Presented when unable to copy to the clipboard because of an error.
+			ui.message(_("Unable to copy"))
+
 	def script_toggleProgressBarOutput(self,gesture):
 		outputMode=config.conf["presentation"]["progressBarUpdates"]["progressBarOutputMode"]
 		if outputMode=="both":
diff --git a/source/logHandler.py b/source/logHandler.py
@@ -113,6 +113,11 @@ class Logger(logging.Logger):
 	DEBUGWARNING = 15
 	OFF = 100
 
+	#: The start position of a fragment of the log file as marked with
+	#: L{markFragmentStart} for later retrieval using L{getFragment}.
+	#: @type: C{long}
+	fragmentStart = None
+
 	def _log(self, level, msg, args, exc_info=None, extra=None, codepath=None, activateLogViewer=False, stack_info=None):
 		if not extra:
 			extra={}
@@ -189,6 +194,65 @@ def exception(self, msg="", exc_info=True, **kwargs):
 			return
 		self._log(level, msg, (), exc_info=exc_info, **kwargs)
 
+	def markFragmentStart(self):
+		"""Mark the current end of the log file as the start position of a
+		fragment to be later retrieved by L{getFragment}.
+		@returns: Whether a log file is in use and a position could be marked
+		@rtype: bool
+		"""
+		if (
+			not globalVars.appArgs
+			or not globalVars.appArgs.logFileName
+			or not self.handlers
+			or not isinstance(self.handlers[0], FileHandler)
+		):
+			return False
+		import codecs
+		try:
+			f = codecs.open(globalVars.appArgs.logFileName, "r", encoding="UTF-8")
+			# io.IOBase.seek: whence=2 -- end of stream
+			f.seek(0, whence=2)
+			self.fragmentStart = f.tell()
+			return True
+		except:  # IOError is the most expected. Catch-all anyway.
+			self.exception()
+			return False
+		finally:
+			try:
+				f.close()
+			except:
+				pass
+
+	def getFragment(self):
+		"""Retrieve a fragment of the log starting from the position marked using
+		L{markFragmentStart}.
+		If L{fragmentStart} does not point to the current end of the log file, it
+		is reset to C{None} after reading the fragment.
+		@returns: The text of the fragment, or C{None} if L{fragmentStart} is None.
+		@rtype: str
+		"""
+		if (
+			not globalVars.appArgs
+			or globalVars.appArgs.secure
+			or self.fragmentStart is None
+		):
+			return None
+		import codecs
+		try:
+			f = codecs.open(globalVars.appArgs.logFileName, "r", encoding="UTF-8")
+			f.seek(self.fragmentStart)
+			fragment = f.read()
+			if fragment:
+				self.fragmentStart = None
+			return fragment
+		except:  # IOError is the most expected. Catch-all anyway.
+			self.exception()
+		finally:
+			try:
+				f.close()
+			except:
+				pass
+
 class RemoteHandler(logging.Handler):
 
 	def __init__(self):
