sublime-rana/packages/wakatime/base.py

491 lines
18 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
"""
2015-03-09 22:23:29 +00:00
wakatime.base
~~~~~~~~~~~~~
2015-03-09 22:23:29 +00:00
wakatime module entry point.
:copyright: (c) 2013 Alan Hamlett.
:license: BSD, see LICENSE for more details.
"""
from __future__ import print_function
import base64
import logging
import os
import platform
import re
import sys
import time
import traceback
import socket
try:
import ConfigParser as configparser
except ImportError:
import configparser
2015-03-31 22:44:48 +00:00
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
2013-09-08 02:08:48 +00:00
sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)), 'packages'))
2014-06-09 20:18:30 +00:00
2015-03-09 22:23:29 +00:00
from .__about__ import __version__
2014-12-23 11:39:07 +00:00
from .compat import u, open, is_py3
2015-04-04 18:03:55 +00:00
from .logger import setup_logging
2015-05-12 22:03:23 +00:00
from .offlinequeue import Queue
from .packages import argparse
from .packages import simplejson as json
2015-03-09 22:23:29 +00:00
from .packages.requests.exceptions import RequestException
2015-06-30 02:47:04 +00:00
from .project import get_project_info
2015-05-12 22:03:23 +00:00
from .session_cache import SessionCache
from .stats import get_file_stats
2014-06-09 20:18:30 +00:00
try:
from .packages import tzlocal
except:
2015-03-09 22:23:29 +00:00
from .packages import tzlocal3 as tzlocal
log = logging.getLogger('WakaTime')
class FileAction(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
values = os.path.realpath(values)
setattr(namespace, self.dest, values)
def upgradeConfigFile(configFile):
"""For backwards-compatibility, upgrade the existing config file
to work with configparser and rename from .wakatime.conf to .wakatime.cfg.
"""
if os.path.isfile(configFile):
# if upgraded cfg file already exists, don't overwrite it
return
oldConfig = os.path.join(os.path.expanduser('~'), '.wakatime.conf')
try:
configs = {
'ignore': [],
}
2014-09-30 16:27:35 +00:00
with open(oldConfig, 'r', encoding='utf-8') as fh:
for line in fh.readlines():
line = line.split('=', 1)
if len(line) == 2 and line[0].strip() and line[1].strip():
if line[0].strip() == 'ignore':
configs['ignore'].append(line[1].strip())
else:
configs[line[0].strip()] = line[1].strip()
2014-09-30 16:27:35 +00:00
with open(configFile, 'w', encoding='utf-8') as fh:
fh.write("[settings]\n")
for name, value in configs.items():
if isinstance(value, list):
fh.write("%s=\n" % name)
for item in value:
fh.write(" %s\n" % item)
else:
fh.write("%s = %s\n" % (name, value))
os.remove(oldConfig)
except IOError:
pass
def parseConfigFile(configFile=None):
"""Returns a configparser.SafeConfigParser instance with configs
read from the config file. Default location of the config file is
at ~/.wakatime.cfg.
"""
if not configFile:
configFile = os.path.join(os.path.expanduser('~'), '.wakatime.cfg')
upgradeConfigFile(configFile)
configs = configparser.SafeConfigParser()
try:
2014-09-30 16:27:35 +00:00
with open(configFile, 'r', encoding='utf-8') as fh:
try:
configs.readfp(fh)
except configparser.Error:
print(traceback.format_exc())
return None
except IOError:
print(u('Error: Could not read from config file {0}').format(u(configFile)))
return configs
2013-07-20 22:28:38 +00:00
def parseArguments(argv):
"""Parse command line arguments and configs from ~/.wakatime.cfg.
Command line arguments take precedence over config file settings.
Returns instances of ArgumentParser and SafeConfigParser.
"""
try:
sys.argv
except AttributeError:
sys.argv = argv
# define supported command line arguments
parser = argparse.ArgumentParser(
2014-01-14 13:11:00 +00:00
description='Common interface for the WakaTime api.')
parser.add_argument('--file', dest='targetFile', metavar='file',
action=FileAction, required=True,
2014-12-22 07:01:09 +00:00
help='absolute path to file for current heartbeat')
2015-03-09 22:23:29 +00:00
parser.add_argument('--key', dest='key',
help='your wakatime api key; uses api_key from '+
'~/.wakatime.conf by default')
parser.add_argument('--write', dest='isWrite',
action='store_true',
2015-03-09 22:23:29 +00:00
help='when set, tells api this heartbeat was triggered from '+
'writing to a file')
parser.add_argument('--plugin', dest='plugin',
help='optional text editor plugin name and version '+
2015-03-09 22:23:29 +00:00
'for User-Agent header')
parser.add_argument('--time', dest='timestamp', metavar='time',
type=float,
help='optional floating-point unix epoch timestamp; '+
'uses current time by default')
2015-05-06 22:45:34 +00:00
parser.add_argument('--lineno', dest='lineno',
help='optional line number; current line being edited')
2015-05-06 23:33:32 +00:00
parser.add_argument('--cursorpos', dest='cursorpos',
help='optional cursor position in the current file')
2015-03-09 22:23:29 +00:00
parser.add_argument('--notfile', dest='notfile', action='store_true',
help='when set, will accept any value for the file. for example, '+
'a domain name or other item you want to log time towards.')
parser.add_argument('--proxy', dest='proxy',
help='optional https proxy url; for example: '+
'https://user:pass@localhost:8080')
2015-05-15 22:33:03 +00:00
parser.add_argument('--project', dest='project',
help='optional project name')
parser.add_argument('--alternate-project', dest='alternate_project',
help='optional alternate project name; auto-discovered project takes priority')
parser.add_argument('--hostname', dest='hostname', help='hostname of current machine.')
parser.add_argument('--disableoffline', dest='offline',
action='store_false',
help='disables offline time logging instead of queuing logged time')
2014-07-25 09:32:01 +00:00
parser.add_argument('--hidefilenames', dest='hidefilenames',
action='store_true',
help='obfuscate file names; will not send file names to api')
2015-03-09 22:23:29 +00:00
parser.add_argument('--exclude', dest='exclude', action='append',
help='filename patterns to exclude from logging; POSIX regex '+
'syntax; can be used more than once')
parser.add_argument('--include', dest='include', action='append',
help='filename patterns to log; when used in combination with '+
'--exclude, files matching include will still be logged; '+
'POSIX regex syntax; can be used more than once')
parser.add_argument('--ignore', dest='ignore', action='append',
2015-03-09 22:23:29 +00:00
help=argparse.SUPPRESS)
parser.add_argument('--logfile', dest='logfile',
help='defaults to ~/.wakatime.log')
2015-04-04 18:03:55 +00:00
parser.add_argument('--apiurl', dest='api_url',
help='heartbeats api url; for debugging with a local server')
parser.add_argument('--config', dest='config',
help='defaults to ~/.wakatime.conf')
parser.add_argument('--verbose', dest='verbose', action='store_true',
help='turns on debug messages in log file')
parser.add_argument('--version', action='version', version=__version__)
# parse command line arguments
2013-07-20 22:28:38 +00:00
args = parser.parse_args(args=argv[1:])
# use current unix epoch timestamp by default
if not args.timestamp:
args.timestamp = time.time()
# parse ~/.wakatime.cfg file
configs = parseConfigFile(args.config)
if configs is None:
return args, configs
# update args from configs
if not args.key:
default_key = None
if configs.has_option('settings', 'api_key'):
default_key = configs.get('settings', 'api_key')
2015-03-09 22:23:29 +00:00
elif configs.has_option('settings', 'apikey'):
default_key = configs.get('settings', 'apikey')
if default_key:
args.key = default_key
else:
parser.error('Missing api key')
2015-03-09 22:23:29 +00:00
if not args.exclude:
args.exclude = []
if configs.has_option('settings', 'ignore'):
try:
for pattern in configs.get('settings', 'ignore').split("\n"):
if pattern.strip() != '':
2015-03-09 22:23:29 +00:00
args.exclude.append(pattern)
except TypeError:
pass
if configs.has_option('settings', 'exclude'):
try:
for pattern in configs.get('settings', 'exclude').split("\n"):
if pattern.strip() != '':
args.exclude.append(pattern)
except TypeError:
pass
if not args.include:
args.include = []
if configs.has_option('settings', 'include'):
try:
for pattern in configs.get('settings', 'include').split("\n"):
if pattern.strip() != '':
args.include.append(pattern)
except TypeError:
pass
if args.offline and configs.has_option('settings', 'offline'):
args.offline = configs.getboolean('settings', 'offline')
2014-07-25 09:32:01 +00:00
if not args.hidefilenames and configs.has_option('settings', 'hidefilenames'):
args.hidefilenames = configs.getboolean('settings', 'hidefilenames')
2015-03-09 22:23:29 +00:00
if not args.proxy and configs.has_option('settings', 'proxy'):
args.proxy = configs.get('settings', 'proxy')
if not args.verbose and configs.has_option('settings', 'verbose'):
args.verbose = configs.getboolean('settings', 'verbose')
if not args.verbose and configs.has_option('settings', 'debug'):
args.verbose = configs.getboolean('settings', 'debug')
if not args.logfile and configs.has_option('settings', 'logfile'):
args.logfile = configs.get('settings', 'logfile')
2015-04-04 18:03:55 +00:00
if not args.api_url and configs.has_option('settings', 'api_url'):
args.api_url = configs.get('settings', 'api_url')
return args, configs
2015-03-09 22:23:29 +00:00
def should_exclude(fileName, include, exclude):
if fileName is not None and fileName.strip() != '':
try:
for pattern in include:
try:
compiled = re.compile(pattern, re.IGNORECASE)
if compiled.search(fileName):
return False
except re.error as ex:
log.warning(u('Regex error ({msg}) for include pattern: {pattern}').format(
msg=u(ex),
pattern=u(pattern),
))
except TypeError:
pass
try:
for pattern in exclude:
try:
compiled = re.compile(pattern, re.IGNORECASE)
if compiled.search(fileName):
return pattern
except re.error as ex:
log.warning(u('Regex error ({msg}) for exclude pattern: {pattern}').format(
msg=u(ex),
pattern=u(pattern),
))
except TypeError:
pass
return False
def get_user_agent(plugin):
2013-07-24 03:33:30 +00:00
ver = sys.version_info
2013-07-31 00:21:27 +00:00
python_version = '%d.%d.%d.%s.%d' % (ver[0], ver[1], ver[2], ver[3], ver[4])
2014-09-30 16:27:35 +00:00
user_agent = u('wakatime/{ver} ({platform}) Python{py_ver}').format(
ver=u(__version__),
platform=u(platform.platform()),
2014-07-25 09:32:01 +00:00
py_ver=python_version,
)
if plugin:
2014-09-30 16:27:35 +00:00
user_agent = u('{user_agent} {plugin}').format(
2014-07-25 09:32:01 +00:00
user_agent=user_agent,
plugin=u(plugin),
2014-07-25 09:32:01 +00:00
)
2015-03-09 22:23:29 +00:00
else:
user_agent = u('{user_agent} Unknown/0').format(
user_agent=user_agent,
)
return user_agent
def send_heartbeat(project=None, branch=None, hostname=None, stats={}, key=None, targetFile=None,
2015-04-04 18:03:55 +00:00
timestamp=None, isWrite=None, plugin=None, offline=None, notfile=False,
hidefilenames=None, proxy=None, api_url=None, **kwargs):
"""Sends heartbeat as POST request to WakaTime api server.
"""
if not api_url:
api_url = 'https://wakatime.com/api/v1/heartbeats'
log.debug('Sending heartbeat to api at %s' % api_url)
data = {
'time': timestamp,
2015-06-21 17:35:14 +00:00
'entity': targetFile,
'type': 'file',
}
2015-03-09 22:23:29 +00:00
if hidefilenames and targetFile is not None and not notfile:
2015-06-21 17:35:14 +00:00
data['entity'] = data['entity'].rsplit('/', 1)[-1].rsplit('\\', 1)[-1]
if len(data['entity'].strip('.').split('.', 1)) > 1:
data['entity'] = u('HIDDEN.{ext}').format(ext=u(data['entity'].strip('.').rsplit('.', 1)[-1]))
2014-07-25 09:32:01 +00:00
else:
2015-06-21 17:35:14 +00:00
data['entity'] = u('HIDDEN')
2013-09-22 20:51:23 +00:00
if stats.get('lines'):
data['lines'] = stats['lines']
if stats.get('language'):
data['language'] = stats['language']
2014-12-22 07:01:09 +00:00
if stats.get('dependencies'):
data['dependencies'] = stats['dependencies']
2015-05-06 22:45:34 +00:00
if stats.get('lineno'):
data['lineno'] = stats['lineno']
2015-05-06 23:33:32 +00:00
if stats.get('cursorpos'):
data['cursorpos'] = stats['cursorpos']
if isWrite:
data['is_write'] = isWrite
if project:
data['project'] = project
if branch:
data['branch'] = branch
log.debug(data)
# setup api request
2014-09-30 16:27:35 +00:00
request_body = json.dumps(data)
2015-03-09 22:23:29 +00:00
api_key = u(base64.b64encode(str.encode(key) if is_py3 else key))
auth = u('Basic {api_key}').format(api_key=api_key)
headers = {
'User-Agent': get_user_agent(plugin),
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': auth,
}
if hostname:
headers['X-Machine-Name'] = hostname
2015-03-09 22:23:29 +00:00
proxies = {}
if proxy:
proxies['https'] = proxy
2014-12-01 06:21:46 +00:00
2013-10-01 04:57:30 +00:00
# add Olson timezone to request
try:
tz = tzlocal.get_localzone()
except:
tz = None
2013-10-01 04:57:30 +00:00
if tz:
2015-03-09 22:23:29 +00:00
headers['TimeZone'] = u(tz.zone)
2013-10-01 04:57:30 +00:00
2015-05-12 22:03:23 +00:00
session_cache = SessionCache()
session = session_cache.get()
# log time to api
2013-09-07 05:50:12 +00:00
response = None
try:
2015-05-12 22:03:23 +00:00
response = session.post(api_url, data=request_body, headers=headers,
2015-03-09 22:23:29 +00:00
proxies=proxies)
except RequestException:
exception_data = {
2014-09-30 16:27:35 +00:00
sys.exc_info()[0].__name__: u(sys.exc_info()[1]),
2013-09-07 05:50:12 +00:00
}
if log.isEnabledFor(logging.DEBUG):
exception_data['traceback'] = traceback.format_exc()
if offline:
2015-03-09 22:23:29 +00:00
queue = Queue()
queue.push(data, json.dumps(stats), plugin)
if log.isEnabledFor(logging.DEBUG):
log.warn(exception_data)
else:
log.error(exception_data)
else:
2015-03-09 22:23:29 +00:00
response_code = response.status_code if response is not None else None
response_content = response.text if response is not None else None
if response_code == 201:
log.debug({
2015-03-09 22:23:29 +00:00
'response_code': response_code,
})
2015-05-12 22:03:23 +00:00
session_cache.save(session)
return True
if offline:
2015-03-09 22:23:29 +00:00
if response_code != 400:
2014-12-22 07:01:09 +00:00
queue = Queue()
queue.push(data, json.dumps(stats), plugin)
2015-03-09 22:23:29 +00:00
if response_code == 401:
log.error({
'response_code': response_code,
'response_content': response_content,
})
elif log.isEnabledFor(logging.DEBUG):
log.warn({
'response_code': response_code,
'response_content': response_content,
})
else:
log.error({
'response_code': response_code,
'response_content': response_content,
})
else:
log.error({
'response_code': response_code,
'response_content': response_content,
})
2015-05-12 22:03:23 +00:00
session_cache.delete()
return False
2013-07-20 22:28:38 +00:00
def main(argv=None):
if not argv:
argv = sys.argv
args, configs = parseArguments(argv)
if configs is None:
return 103 # config file parsing error
setup_logging(args, __version__)
2015-03-09 22:23:29 +00:00
exclude = should_exclude(args.targetFile, args.include, args.exclude)
if exclude is not False:
log.debug(u('File not logged because matches exclude pattern: {pattern}').format(
pattern=u(exclude),
2014-07-25 09:32:01 +00:00
))
return 0
2015-03-09 22:23:29 +00:00
if os.path.isfile(args.targetFile) or args.notfile:
2015-05-06 23:33:32 +00:00
stats = get_file_stats(args.targetFile, notfile=args.notfile,
lineno=args.lineno, cursorpos=args.cursorpos)
2015-06-30 02:47:04 +00:00
project, branch = None, None
2015-03-09 22:23:29 +00:00
if not args.notfile:
2015-06-30 02:47:04 +00:00
project, branch = get_project_info(configs=configs, args=args)
2015-05-16 21:38:19 +00:00
kwargs = vars(args)
2015-06-30 02:47:04 +00:00
kwargs['project'] = project
2015-06-21 17:35:14 +00:00
kwargs['branch'] = branch
kwargs['stats'] = stats
kwargs['hostname'] = args.hostname or socket.gethostname()
2015-06-21 17:35:14 +00:00
if send_heartbeat(**kwargs):
queue = Queue()
while True:
2014-12-22 07:01:09 +00:00
heartbeat = queue.pop()
if heartbeat is None:
break
2015-04-04 18:03:55 +00:00
sent = send_heartbeat(
project=heartbeat['project'],
targetFile=heartbeat['file'],
timestamp=heartbeat['time'],
branch=heartbeat['branch'],
hostname=kwargs['hostname'],
2015-04-04 18:03:55 +00:00
stats=json.loads(heartbeat['stats']),
key=args.key,
isWrite=heartbeat['is_write'],
plugin=heartbeat['plugin'],
offline=args.offline,
hidefilenames=args.hidefilenames,
notfile=args.notfile,
proxy=args.proxy,
api_url=args.api_url,
)
2014-07-25 09:32:01 +00:00
if not sent:
break
return 0 # success
return 102 # api error
else:
2014-12-22 07:01:09 +00:00
log.debug('File does not exist; ignoring this heartbeat.')
return 0