248 lines
7.2 KiB
Python
248 lines
7.2 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# Copyright (C) 2011, 2012 Google Inc.
|
|
#
|
|
# This file is part of YouCompleteMe.
|
|
#
|
|
# YouCompleteMe is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# YouCompleteMe is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with YouCompleteMe. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import tempfile
|
|
import os
|
|
import sys
|
|
import signal
|
|
import functools
|
|
import socket
|
|
import stat
|
|
import json
|
|
import hmac
|
|
import hashlib
|
|
from distutils.spawn import find_executable
|
|
import subprocess
|
|
import collections
|
|
|
|
WIN_PYTHON27_PATH = 'C:\python27\pythonw.exe'
|
|
WIN_PYTHON26_PATH = 'C:\python26\pythonw.exe'
|
|
|
|
|
|
def IsIdentifierChar( char ):
|
|
return char.isalnum() or char == '_'
|
|
|
|
|
|
def SanitizeQuery( query ):
|
|
return query.strip()
|
|
|
|
|
|
# Given an object, returns a str object that's utf-8 encoded.
|
|
def ToUtf8IfNeeded( value ):
|
|
if isinstance( value, unicode ):
|
|
return value.encode( 'utf8' )
|
|
if isinstance( value, str ):
|
|
return value
|
|
return str( value )
|
|
|
|
|
|
# Recurses through the object if it's a dict/iterable and converts all the
|
|
# unicode objects to utf-8 strings.
|
|
def RecursiveEncodeUnicodeToUtf8( value ):
|
|
if isinstance( value, unicode ):
|
|
return value.encode( 'utf8' )
|
|
if isinstance( value, str ):
|
|
return value
|
|
elif isinstance( value, collections.Mapping ):
|
|
return dict( map( RecursiveEncodeUnicodeToUtf8, value.iteritems() ) )
|
|
elif isinstance( value, collections.Iterable ):
|
|
return type( value )( map( RecursiveEncodeUnicodeToUtf8, value ) )
|
|
else:
|
|
return value
|
|
|
|
|
|
def ToUtf8Json( data ):
|
|
return json.dumps( RecursiveEncodeUnicodeToUtf8( data ),
|
|
ensure_ascii = False,
|
|
# This is the encoding of INPUT str data
|
|
encoding = 'utf-8' )
|
|
|
|
|
|
def PathToTempDir():
|
|
tempdir = os.path.join( tempfile.gettempdir(), 'ycm_temp' )
|
|
if not os.path.exists( tempdir ):
|
|
os.makedirs( tempdir )
|
|
# Needed to support multiple users working on the same machine;
|
|
# see issue 606.
|
|
MakeFolderAccessibleToAll( tempdir )
|
|
return tempdir
|
|
|
|
|
|
def MakeFolderAccessibleToAll( path_to_folder ):
|
|
current_stat = os.stat( path_to_folder )
|
|
# readable, writable and executable by everyone
|
|
flags = ( current_stat.st_mode | stat.S_IROTH | stat.S_IWOTH | stat.S_IXOTH
|
|
| stat.S_IRGRP | stat.S_IWGRP | stat.S_IXGRP )
|
|
os.chmod( path_to_folder, flags )
|
|
|
|
|
|
def RunningInsideVim():
|
|
try:
|
|
import vim # NOQA
|
|
return True
|
|
except ImportError:
|
|
return False
|
|
|
|
|
|
def GetUnusedLocalhostPort():
|
|
sock = socket.socket()
|
|
# This tells the OS to give us any free port in the range [1024 - 65535]
|
|
sock.bind( ( '', 0 ) )
|
|
port = sock.getsockname()[ 1 ]
|
|
sock.close()
|
|
return port
|
|
|
|
|
|
def RemoveIfExists( filename ):
|
|
try:
|
|
os.remove( filename )
|
|
except OSError:
|
|
pass
|
|
|
|
|
|
def Memoize( obj ):
|
|
cache = obj.cache = {}
|
|
|
|
@functools.wraps( obj )
|
|
def memoizer( *args, **kwargs ):
|
|
key = str( args ) + str( kwargs )
|
|
if key not in cache:
|
|
cache[ key ] = obj( *args, **kwargs )
|
|
return cache[ key ]
|
|
return memoizer
|
|
|
|
|
|
@Memoize
|
|
def PathToPythonInterpreter():
|
|
if not RunningInsideVim():
|
|
return sys.executable
|
|
|
|
import vim # NOQA
|
|
user_path_to_python = vim.eval( 'g:ycm_path_to_python_interpreter' )
|
|
if user_path_to_python:
|
|
return user_path_to_python
|
|
|
|
# We check for 'python2' before 'python' because some OS's (I'm looking at you
|
|
# Arch Linux) have made the... interesting decision to point /usr/bin/python
|
|
# to python3.
|
|
python_names = [ 'python2', 'python' ]
|
|
if OnWindows():
|
|
# On Windows, 'pythonw' doesn't pop-up a console window like running
|
|
# 'python' does.
|
|
python_names.insert( 0, 'pythonw' )
|
|
|
|
path_to_python = PathToFirstExistingExecutable( python_names )
|
|
if path_to_python:
|
|
return path_to_python
|
|
|
|
# On Windows, Python may not be on the PATH at all, so we check some common
|
|
# install locations.
|
|
if OnWindows():
|
|
if os.path.exists( WIN_PYTHON27_PATH ):
|
|
return WIN_PYTHON27_PATH
|
|
elif os.path.exists( WIN_PYTHON26_PATH ):
|
|
return WIN_PYTHON26_PATH
|
|
raise RuntimeError( 'Python 2.7/2.6 not installed!' )
|
|
|
|
|
|
def PathToFirstExistingExecutable( executable_name_list ):
|
|
for executable_name in executable_name_list:
|
|
path = find_executable( executable_name )
|
|
if path:
|
|
return path
|
|
return None
|
|
|
|
|
|
def OnWindows():
|
|
return sys.platform == 'win32'
|
|
|
|
|
|
def OnCygwin():
|
|
return sys.platform == 'cygwin'
|
|
|
|
|
|
# From here: http://stackoverflow.com/a/8536476/1672783
|
|
def TerminateProcess( pid ):
|
|
if OnWindows():
|
|
import ctypes
|
|
PROCESS_TERMINATE = 1
|
|
handle = ctypes.windll.kernel32.OpenProcess( PROCESS_TERMINATE,
|
|
False,
|
|
pid )
|
|
ctypes.windll.kernel32.TerminateProcess( handle, -1 )
|
|
ctypes.windll.kernel32.CloseHandle( handle )
|
|
else:
|
|
os.kill( pid, signal.SIGTERM )
|
|
|
|
|
|
def AddThirdPartyFoldersToSysPath():
|
|
path_to_third_party = os.path.join(
|
|
os.path.dirname( os.path.abspath( __file__ ) ),
|
|
'../../third_party' )
|
|
|
|
for folder in os.listdir( path_to_third_party ):
|
|
sys.path.insert( 0, os.path.realpath( os.path.join( path_to_third_party,
|
|
folder ) ) )
|
|
|
|
def ForceSemanticCompletion( request_data ):
|
|
return ( 'force_semantic' in request_data and
|
|
bool( request_data[ 'force_semantic' ] ) )
|
|
|
|
|
|
# A wrapper for subprocess.Popen that works around a Popen bug on Windows.
|
|
def SafePopen( *args, **kwargs ):
|
|
if kwargs.get( 'stdin' ) is None:
|
|
# We need this on Windows otherwise bad things happen. See issue #637.
|
|
kwargs[ 'stdin' ] = subprocess.PIPE if OnWindows() else None
|
|
|
|
return subprocess.Popen( *args, **kwargs )
|
|
|
|
|
|
def ContentHexHmacValid( content, hmac, hmac_secret ):
|
|
return SecureCompareStrings( CreateHexHmac( content, hmac_secret ), hmac )
|
|
|
|
|
|
def CreateHexHmac( content, hmac_secret ):
|
|
return hmac.new( hmac_secret,
|
|
msg = content,
|
|
digestmod = hashlib.sha256 ).hexdigest()
|
|
|
|
|
|
# This is the compare_digest function from python 3.4, adapted for 2.7:
|
|
# http://hg.python.org/cpython/file/460407f35aa9/Lib/hmac.py#l16
|
|
def SecureCompareStrings( a, b ):
|
|
"""Returns the equivalent of 'a == b', but avoids content based short
|
|
circuiting to reduce the vulnerability to timing attacks."""
|
|
# Consistent timing matters more here than data type flexibility
|
|
if not ( isinstance( a, str ) and isinstance( b, str ) ):
|
|
raise TypeError( "inputs must be str instances" )
|
|
|
|
# We assume the length of the expected digest is public knowledge,
|
|
# thus this early return isn't leaking anything an attacker wouldn't
|
|
# already know
|
|
if len( a ) != len( b ):
|
|
return False
|
|
|
|
# We assume that integers in the bytes range are all cached,
|
|
# thus timing shouldn't vary much due to integer object creation
|
|
result = 0
|
|
for x, y in zip( a, b ):
|
|
result |= ord( x ) ^ ord( y )
|
|
return result == 0
|