v7.0.26

HISTORY.rst

@@ -3,6 +3,24 @@ History
 -------
 
 
+7.0.26 (2017-11-07)
+++++++++++++++++++
+
+- Upgrade wakatime-cli to v9.0.1.
+- Fix bug causing 401 response when hidefilenames is enabled.
+  `#wakatime/106 <https://github.com/wakatime/wakatime/issues/106>`_
+
+
+7.0.25 (2017-11-05)
+++++++++++++++++++
+
+- Ability to override python binary location in sublime-settings file.
+  `#78 <https://github.com/wakatime/sublime-wakatime/issues/78>`_
+- Upgrade wakatime-cli to v9.0.0.
+- Detect project and branch names from git submodules.
+  `wakatime/#105 <https://github.com/wakatime/wakatime/issues/105>`_
+
+
 7.0.24 (2017-10-29)
 ++++++++++++++++++
 

WakaTime.py

@@ -7,7 +7,7 @@ Website:     https://wakatime.com/
 ==========================================================="""
 
 
-__version__ = '7.0.24'
+__version__ = '7.0.26'
 
 
 import sublime
@@ -465,6 +465,7 @@ class SendHeartbeatsThread(threading.Thread):
         self.include = SETTINGS.get('include', [])
         self.hidefilenames = SETTINGS.get('hidefilenames')
         self.proxy = SETTINGS.get('proxy')
+        self.python_binary = SETTINGS.get('python_binary')
 
         self.heartbeat = heartbeat
         self.has_extra_heartbeats = False
@@ -501,11 +502,14 @@ class SendHeartbeatsThread(threading.Thread):
         return heartbeat
 
     def send_heartbeats(self):
-        if python_binary():
+        python = self.python_binary
+        if not python or not python.strip():
+            python = python_binary()
+        if python:
             heartbeat = self.build_heartbeat(**self.heartbeat)
             ua = 'sublime/%d sublime-wakatime/%s' % (ST_VERSION, __version__)
             cmd = [
-                python_binary(),
+                python,
                 API_CLIENT,
                 '--entity', heartbeat['entity'],
                 '--time', str('%f' % heartbeat['timestamp']),

WakaTime.sublime-settings

@@ -29,5 +29,8 @@
     "status_bar_message_fmt": "WakaTime {status} %I:%M %p",
 
     // Obfuscate file paths when sending to API. Your dashboard will no longer display coding activity per file.
-    "hidefilenames": false
+    "hidefilenames": false,
+
+    // Python binary location. Uses python from your PATH by default.
+    "python_binary": ""
 }

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', '1')
 __version__ = '.'.join(__version_info__)
 __author__ = 'Alan Hamlett'
 __author_email__ = 'alan@wakatime.com'

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 sensitiveKey in sensitive:
+                        if sensitiveKey in data:
+                            del data[sensitiveKey]
+
+                    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

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 = [

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

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)