bc6ac461f3
This allows completer servers to detect the correct directory to launch no matter what request initialises the completer server.
276 lines
9.4 KiB
Python
276 lines
9.4 KiB
Python
# Copyright (C) 2013 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/>.
|
|
|
|
from __future__ import unicode_literals
|
|
from __future__ import print_function
|
|
from __future__ import division
|
|
from __future__ import absolute_import
|
|
# Not installing aliases from python-future; it's unreliable and slow.
|
|
from builtins import * # noqa
|
|
|
|
import contextlib
|
|
import logging
|
|
import json
|
|
from future.utils import native
|
|
from base64 import b64decode, b64encode
|
|
from ycm import vimsupport
|
|
from ycmd.utils import ToBytes, urljoin, urlparse, GetCurrentDirectory
|
|
from ycmd.hmac_utils import CreateRequestHmac, CreateHmac, SecureBytesEqual
|
|
from ycmd.responses import ServerError, UnknownExtraConf
|
|
|
|
_HEADERS = {'content-type': 'application/json'}
|
|
_CONNECT_TIMEOUT_SEC = 0.01
|
|
# Setting this to None seems to screw up the Requests/urllib3 libs.
|
|
_READ_TIMEOUT_SEC = 30
|
|
_HMAC_HEADER = 'x-ycm-hmac'
|
|
_logger = logging.getLogger( __name__ )
|
|
|
|
|
|
class BaseRequest( object ):
|
|
|
|
def __init__( self ):
|
|
pass
|
|
|
|
|
|
def Start( self ):
|
|
pass
|
|
|
|
|
|
def Done( self ):
|
|
return True
|
|
|
|
|
|
def Response( self ):
|
|
return {}
|
|
|
|
# This method blocks
|
|
# |timeout| is num seconds to tolerate no response from server before giving
|
|
# up; see Requests docs for details (we just pass the param along).
|
|
@staticmethod
|
|
def GetDataFromHandler( handler, timeout = _READ_TIMEOUT_SEC ):
|
|
return JsonFromFuture( BaseRequest._TalkToHandlerAsync( '',
|
|
handler,
|
|
'GET',
|
|
timeout ) )
|
|
|
|
|
|
# This is the blocking version of the method. See below for async.
|
|
# |timeout| is num seconds to tolerate no response from server before giving
|
|
# up; see Requests docs for details (we just pass the param along).
|
|
@staticmethod
|
|
def PostDataToHandler( data, handler, timeout = _READ_TIMEOUT_SEC ):
|
|
return JsonFromFuture( BaseRequest.PostDataToHandlerAsync( data,
|
|
handler,
|
|
timeout ) )
|
|
|
|
|
|
# This returns a future! Use JsonFromFuture to get the value.
|
|
# |timeout| is num seconds to tolerate no response from server before giving
|
|
# up; see Requests docs for details (we just pass the param along).
|
|
@staticmethod
|
|
def PostDataToHandlerAsync( data, handler, timeout = _READ_TIMEOUT_SEC ):
|
|
return BaseRequest._TalkToHandlerAsync( data, handler, 'POST', timeout )
|
|
|
|
|
|
# This returns a future! Use JsonFromFuture to get the value.
|
|
# |method| is either 'POST' or 'GET'.
|
|
# |timeout| is num seconds to tolerate no response from server before giving
|
|
# up; see Requests docs for details (we just pass the param along).
|
|
@staticmethod
|
|
def _TalkToHandlerAsync( data,
|
|
handler,
|
|
method,
|
|
timeout = _READ_TIMEOUT_SEC ):
|
|
request_uri = _BuildUri( handler )
|
|
if method == 'POST':
|
|
sent_data = _ToUtf8Json( data )
|
|
return BaseRequest.Session().post(
|
|
request_uri,
|
|
data = sent_data,
|
|
headers = BaseRequest._ExtraHeaders( method,
|
|
request_uri,
|
|
sent_data ),
|
|
timeout = ( _CONNECT_TIMEOUT_SEC, timeout ) )
|
|
return BaseRequest.Session().get(
|
|
request_uri,
|
|
headers = BaseRequest._ExtraHeaders( method, request_uri ),
|
|
timeout = ( _CONNECT_TIMEOUT_SEC, timeout ) )
|
|
|
|
|
|
@staticmethod
|
|
def _ExtraHeaders( method, request_uri, request_body = None ):
|
|
if not request_body:
|
|
request_body = bytes( b'' )
|
|
headers = dict( _HEADERS )
|
|
headers[ _HMAC_HEADER ] = b64encode(
|
|
CreateRequestHmac( ToBytes( method ),
|
|
ToBytes( urlparse( request_uri ).path ),
|
|
request_body,
|
|
BaseRequest.hmac_secret ) )
|
|
return headers
|
|
|
|
|
|
# These two methods exist to avoid importing the requests module at startup;
|
|
# reducing loading time since this module is slow to import.
|
|
@classmethod
|
|
def Requests( cls ):
|
|
try:
|
|
return cls.requests
|
|
except AttributeError:
|
|
import requests
|
|
cls.requests = requests
|
|
return requests
|
|
|
|
|
|
@classmethod
|
|
def Session( cls ):
|
|
try:
|
|
return cls.session
|
|
except AttributeError:
|
|
from ycm.unsafe_thread_pool_executor import UnsafeThreadPoolExecutor
|
|
from requests_futures.sessions import FuturesSession
|
|
executor = UnsafeThreadPoolExecutor( max_workers = 30 )
|
|
cls.session = FuturesSession( executor = executor )
|
|
return cls.session
|
|
|
|
|
|
server_location = ''
|
|
hmac_secret = ''
|
|
|
|
|
|
def BuildRequestData( filepath = None ):
|
|
"""Build request for the current buffer or the buffer corresponding to
|
|
|filepath| if specified."""
|
|
current_filepath = vimsupport.GetCurrentBufferFilepath()
|
|
working_dir = GetCurrentDirectory()
|
|
|
|
if filepath and current_filepath != filepath:
|
|
# Cursor position is irrelevant when filepath is not the current buffer.
|
|
return {
|
|
'filepath': filepath,
|
|
'line_num': 1,
|
|
'column_num': 1,
|
|
'working_dir': working_dir,
|
|
'file_data': vimsupport.GetUnsavedAndSpecifiedBufferData( filepath )
|
|
}
|
|
|
|
line, column = vimsupport.CurrentLineAndColumn()
|
|
|
|
return {
|
|
'filepath': current_filepath,
|
|
'line_num': line + 1,
|
|
'column_num': column + 1,
|
|
'working_dir': working_dir,
|
|
'file_data': vimsupport.GetUnsavedAndSpecifiedBufferData( current_filepath )
|
|
}
|
|
|
|
|
|
def JsonFromFuture( future ):
|
|
response = future.result()
|
|
_ValidateResponseObject( response )
|
|
if response.status_code == BaseRequest.Requests().codes.server_error:
|
|
raise MakeServerException( response.json() )
|
|
|
|
# We let Requests handle the other status types, we only handle the 500
|
|
# error code.
|
|
response.raise_for_status()
|
|
|
|
if response.text:
|
|
return response.json()
|
|
return None
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def HandleServerException( display = True, truncate = False ):
|
|
"""Catch any exception raised through server communication. If it is raised
|
|
because of a unknown .ycm_extra_conf.py file, load the file or ignore it after
|
|
asking the user. Otherwise, log the exception and display its message to the
|
|
user on the Vim status line. Unset the |display| parameter to hide the message
|
|
from the user. Set the |truncate| parameter to avoid hit-enter prompts from
|
|
this message.
|
|
|
|
The GetDataFromHandler, PostDataToHandler, and JsonFromFuture functions should
|
|
always be wrapped by this function to avoid Python exceptions bubbling up to
|
|
the user.
|
|
|
|
Example usage:
|
|
|
|
with HandleServerException():
|
|
response = BaseRequest.PostDataToHandler( ... )
|
|
"""
|
|
try:
|
|
try:
|
|
yield
|
|
except UnknownExtraConf as e:
|
|
if vimsupport.Confirm( str( e ) ):
|
|
_LoadExtraConfFile( e.extra_conf_file )
|
|
else:
|
|
_IgnoreExtraConfFile( e.extra_conf_file )
|
|
except BaseRequest.Requests().exceptions.ConnectionError:
|
|
# We don't display this exception to the user since it is likely to happen
|
|
# for each subsequent request (typically if the server crashed) and we
|
|
# don't want to spam the user with it.
|
|
_logger.exception( 'Unable to connect to server' )
|
|
except Exception as e:
|
|
_logger.exception( 'Error while handling server response' )
|
|
if display:
|
|
DisplayServerException( e, truncate )
|
|
|
|
|
|
def _LoadExtraConfFile( filepath ):
|
|
BaseRequest.PostDataToHandler( { 'filepath': filepath },
|
|
'load_extra_conf_file' )
|
|
|
|
|
|
def _IgnoreExtraConfFile( filepath ):
|
|
BaseRequest.PostDataToHandler( { 'filepath': filepath },
|
|
'ignore_extra_conf_file' )
|
|
|
|
|
|
def DisplayServerException( exception, truncate = False ):
|
|
serialized_exception = str( exception )
|
|
|
|
# We ignore the exception about the file already being parsed since it comes
|
|
# up often and isn't something that's actionable by the user.
|
|
if 'already being parsed' in serialized_exception:
|
|
return
|
|
vimsupport.PostVimMessage( serialized_exception, truncate = truncate )
|
|
|
|
|
|
def _ToUtf8Json( data ):
|
|
return ToBytes( json.dumps( data ) if data else None )
|
|
|
|
|
|
def _ValidateResponseObject( response ):
|
|
our_hmac = CreateHmac( response.content, BaseRequest.hmac_secret )
|
|
their_hmac = ToBytes( b64decode( response.headers[ _HMAC_HEADER ] ) )
|
|
if not SecureBytesEqual( our_hmac, their_hmac ):
|
|
raise RuntimeError( 'Received invalid HMAC for response!' )
|
|
return True
|
|
|
|
|
|
def _BuildUri( handler ):
|
|
return native( ToBytes( urljoin( BaseRequest.server_location, handler ) ) )
|
|
|
|
|
|
def MakeServerException( data ):
|
|
if data[ 'exception' ][ 'TYPE' ] == UnknownExtraConf.__name__:
|
|
return UnknownExtraConf( data[ 'exception' ][ 'extra_conf_file' ] )
|
|
|
|
return ServerError( '{0}: {1}'.format( data[ 'exception' ][ 'TYPE' ],
|
|
data[ 'message' ] ) )
|