diff --git a/plugin/packages/wakatime/__about__.py b/plugin/packages/wakatime/__about__.py index 398a0e9..38df2f2 100644 --- a/plugin/packages/wakatime/__about__.py +++ b/plugin/packages/wakatime/__about__.py @@ -1,7 +1,7 @@ __title__ = 'wakatime' __description__ = 'Common interface to the WakaTime api.' __url__ = 'https://github.com/wakatime/wakatime' -__version_info__ = ('8', '0', '5') +__version_info__ = ('9', '0', '0') __version__ = '.'.join(__version_info__) __author__ = 'Alan Hamlett' __author_email__ = 'alan@wakatime.com' diff --git a/plugin/packages/wakatime/main.py b/plugin/packages/wakatime/main.py index d33fb76..733b199 100644 --- a/plugin/packages/wakatime/main.py +++ b/plugin/packages/wakatime/main.py @@ -80,19 +80,6 @@ def send_heartbeat(project=None, branch=None, hostname=None, stats={}, key=None, 'entity': entity, 'type': entity_type, } - if hidefilenames and entity is not None and entity_type == 'file': - for pattern in hidefilenames: - try: - compiled = re.compile(pattern, re.IGNORECASE) - if compiled.search(entity): - extension = u(os.path.splitext(data['entity'])[1]) - data['entity'] = u('HIDDEN{0}').format(extension) - break - except re.error as ex: - log.warning(u('Regex error ({msg}) for include pattern: {pattern}').format( - msg=u(ex), - pattern=u(pattern), - )) if stats.get('lines'): data['lines'] = stats['lines'] if stats.get('language'): @@ -109,6 +96,28 @@ def send_heartbeat(project=None, branch=None, hostname=None, stats={}, key=None, data['project'] = project if branch: data['branch'] = branch + + if hidefilenames and entity is not None and entity_type == 'file': + for pattern in hidefilenames: + try: + compiled = re.compile(pattern, re.IGNORECASE) + if compiled.search(entity): + extension = u(os.path.splitext(data['entity'])[1]) + data['entity'] = u('HIDDEN{0}').format(extension) + + # also delete any sensitive info when hiding file names + sensitive = ['dependencies', 'lines', 'lineno', 'cursorpos', 'branch'] + for key in sensitive: + if key in data: + del data[key] + + break + except re.error as ex: + log.warning(u('Regex error ({msg}) for include pattern: {pattern}').format( + msg=u(ex), + pattern=u(pattern), + )) + log.debug(data) # setup api request @@ -219,8 +228,6 @@ def send_heartbeat(project=None, branch=None, hostname=None, stats={}, key=None, queue = Queue() queue.push(data, json.dumps(stats), plugin) log.warn(exception_data) - session_cache.delete() - return API_ERROR else: code = response.status_code if response is not None else None diff --git a/plugin/packages/wakatime/project.py b/plugin/packages/wakatime/project.py index c008651..c03e732 100644 --- a/plugin/packages/wakatime/project.py +++ b/plugin/packages/wakatime/project.py @@ -13,9 +13,9 @@ import logging from .projects.git import Git from .projects.mercurial import Mercurial +from .projects.projectfile import ProjectFile from .projects.projectmap import ProjectMap from .projects.subversion import Subversion -from .projects.wakatime_project_file import WakaTimeProjectFile log = logging.getLogger('WakaTime') @@ -23,7 +23,7 @@ log = logging.getLogger('WakaTime') # List of plugin classes to find a project for the current file path. CONFIG_PLUGINS = [ - WakaTimeProjectFile, + ProjectFile, ProjectMap, ] REV_CONTROL_PLUGINS = [ diff --git a/plugin/packages/wakatime/projects/git.py b/plugin/packages/wakatime/projects/git.py index 7263a4c..5b59a61 100644 --- a/plugin/packages/wakatime/projects/git.py +++ b/plugin/packages/wakatime/projects/git.py @@ -11,6 +11,7 @@ import logging import os +import re import sys from .base import BaseProject @@ -21,21 +22,19 @@ log = logging.getLogger('WakaTime') class Git(BaseProject): + _submodule = None + _project_name = None + _head_file = None def process(self): - self.configFile = self._find_git_config_file(self.path) - return self.configFile is not None + return self._find_git_config_file(self.path) def name(self): - base = self._project_base() - if base: - return u(os.path.basename(base)) - return None # pragma: nocover + return u(self._project_name) if self._project_name else None def branch(self): - base = self._project_base() - if base: - head = os.path.join(self._project_base(), '.git', 'HEAD') + head = self._head_file + if head: try: with open(head, 'r', encoding='utf-8') as fh: return self._get_branch_from_head_file(fh.readline()) @@ -49,23 +48,81 @@ class Git(BaseProject): log.traceback(logging.WARNING) return u('master') - def _project_base(self): - if self.configFile: - return os.path.dirname(os.path.dirname(self.configFile)) - return None # pragma: nocover - def _find_git_config_file(self, path): path = os.path.realpath(path) if os.path.isfile(path): path = os.path.split(path)[0] if os.path.isfile(os.path.join(path, '.git', 'config')): - return os.path.join(path, '.git', 'config') + self._project_name = os.path.basename(path) + self._head_file = os.path.join(path, '.git', 'HEAD') + return True + if self._submodules_supported_for_path(path): + submodule_path = self._find_path_from_submodule(path) + if submodule_path: + self._project_name = os.path.basename(path) + self._head_file = os.path.join(submodule_path, 'HEAD') + return True split_path = os.path.split(path) if split_path[1] == '': - return None + return False return self._find_git_config_file(split_path[0]) def _get_branch_from_head_file(self, line): if u(line.strip()).startswith('ref: '): return u(line.strip().rsplit('/', 1)[-1]) return None + + def _submodules_supported_for_path(self, path): + if not self._configs: + return True + + disabled = self._configs.get('submodules_disabled') + if not disabled: + return True + + if disabled.strip().lower() == 'true': + return False + if disabled.strip().lower() == 'false': + return True + + for pattern in disabled.split("\n"): + if pattern.strip(): + try: + compiled = re.compile(pattern, re.IGNORECASE) + if compiled.search(path): + return False + except re.error as ex: + log.warning(u('Regex error ({msg}) for disable git submodules pattern: {pattern}').format( + msg=u(ex), + pattern=u(pattern), + )) + + return True + + def _find_path_from_submodule(self, path): + link = os.path.join(path, '.git') + if not os.path.isfile(link): + return None + + try: + with open(link, 'r', encoding='utf-8') as fh: + return self._get_path_from_submodule_link(path, fh.readline()) + except UnicodeDecodeError: + try: + with open(link, 'r', encoding=sys.getfilesystemencoding()) as fh: + return self._get_path_from_submodule_link(path, fh.readline()) + except: + log.traceback(logging.WARNING) + except IOError: + log.traceback(logging.WARNING) + + return None + + def _get_path_from_submodule_link(self, path, line): + if line.startswith('gitdir: '): + subpath = line[len('gitdir: '):].strip() + if os.path.isfile(os.path.join(path, subpath, 'config')) and \ + os.path.isfile(os.path.join(path, subpath, 'HEAD')): + return os.path.join(path, subpath) + + return None diff --git a/plugin/packages/wakatime/projects/wakatime_project_file.py b/plugin/packages/wakatime/projects/projectfile.py similarity index 93% rename from plugin/packages/wakatime/projects/wakatime_project_file.py rename to plugin/packages/wakatime/projects/projectfile.py index 770861c..9ca6d80 100644 --- a/plugin/packages/wakatime/projects/wakatime_project_file.py +++ b/plugin/packages/wakatime/projects/projectfile.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """ - wakatime.projects.wakatime_project_file - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + wakatime.projects.projectfile + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Information from a .wakatime-project file about the project for a given file. First line of .wakatime-project sets the project @@ -22,7 +22,7 @@ from ..compat import u, open log = logging.getLogger('WakaTime') -class WakaTimeProjectFile(BaseProject): +class ProjectFile(BaseProject): def process(self): self.config = self._find_config(self.path)