/usr/lib/python2.7/dist-packages/phabricator/__init__.py is in python-phabricator 0.7.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 | """
python-phabricator
------------------
>>> api = phabricator.Phabricator()
>>> api.user.whoami().userName
'example'
For more endpoints, see https://secure.phabricator.com/conduit/
"""
try:
__version__ = __import__('pkg_resources') \
.get_distribution('phabricator').version
except:
__version__ = 'unknown'
import collections
import copy
import hashlib
import json
import os.path
import re
import socket
import time
from ._compat import (
MutableMapping, iteritems, string_types, httplib, urlparse, urlencode,
)
__all__ = ['Phabricator']
ON_WINDOWS = os.name == 'nt'
CURRENT_DIR = os.getcwd()
# Default Phabricator interfaces
INTERFACES = {}
with open(os.path.join(os.path.dirname(__file__), 'interfaces.json')) as fobj:
INTERFACES = json.load(fobj)
# Load arc config
ARC_CONFIGS = (
# System config
os.path.join(
os.environ['ProgramData'],
'Phabricator',
'Arcanist',
'config'
) if ON_WINDOWS else os.path.join('/etc', 'arcconfig'),
# User config
os.path.join(
os.environ['AppData'] if ON_WINDOWS else os.path.expanduser('~'),
'.arcrc'
),
# Project config
os.path.join(CURRENT_DIR, '.arcconfig'),
# Local project config
os.path.join(CURRENT_DIR, '.git', 'arc', 'config'),
)
ARCRC = {}
for conf in ARC_CONFIGS:
if os.path.exists(conf):
with open(conf, 'r') as fobj:
ARCRC.update(json.load(fobj))
# Map Phabricator types to Python types
PARAM_TYPE_MAP = {
# int types
'int': int,
'uint': int,
'revisionid': int,
'revision_id': int,
'diffid': int,
'diff_id': int,
'id': int,
# bool types
'bool': bool,
# dict types
'map': dict,
'dict': dict,
# list types
'list': list,
# tuple types
'pair': tuple,
# str types
'str': string_types,
'string': string_types,
'phid': string_types,
'guids': string_types,
'type': string_types,
}
TYPE_INFO_COMMENT_RE = re.compile(r'\s*\([^)]+\)\s*$')
TYPE_INFO_SPLITTER_RE = re.compile(r'(\w+(?:<.+>)?)(?:\s+|$)')
TYPE_INFO_RE = re.compile(r'<?(\w+)(<[^>]+>>?)?(?:.+|$)')
def map_param_type(param_type):
"""
Perform param type mapping
This requires a bit of logic since this isn't standardized.
If a type doesn't map, assume str
"""
main_type, sub_type = TYPE_INFO_RE.match(param_type).groups()
if main_type in ('list', 'array'):
# Handle no sub-type: "required list"
if sub_type is not None:
sub_type = sub_type.strip()
if not sub_type:
sub_type = 'str'
# Handle list of pairs: "optional list<pair<callsign, path>>"
sub_match = TYPE_INFO_RE.match(sub_type)
if sub_match:
sub_type = sub_match.group(1).lower()
return [PARAM_TYPE_MAP.setdefault(sub_type, string_types)]
return PARAM_TYPE_MAP.setdefault(main_type, string_types)
def parse_interfaces(interfaces):
"""
Parse the conduit.query json dict response
This performs the logic of parsing the non-standard params dict
and then returning a dict Resource can understand
"""
parsed_interfaces = collections.defaultdict(dict)
for m, d in iteritems(interfaces):
app, func = m.split('.', 1)
method = parsed_interfaces[app][func] = {}
# Make default assumptions since these aren't provided by Phab
method['formats'] = ['json', 'human']
method['method'] = 'POST'
method['optional'] = {}
method['required'] = {}
for name, type_info in iteritems(dict(d['params'])):
# Set the defaults
optionality = 'required'
param_type = 'string'
# Usually in the format: <optionality> <param_type>
type_info = TYPE_INFO_COMMENT_RE.sub('', type_info)
info_pieces = TYPE_INFO_SPLITTER_RE.findall(type_info)
for info_piece in info_pieces:
if info_piece in ('optional', 'required'):
optionality = info_piece
elif info_piece == 'ignored':
optionality = 'optional'
param_type = 'string'
elif info_piece == 'nonempty':
optionality = 'required'
else:
param_type = info_piece
method[optionality][name] = map_param_type(param_type)
return dict(parsed_interfaces)
class ConfigurationError(Exception):
pass
class APIError(Exception):
def __init__(self, code, message):
self.code = code
self.message = message
def __str__(self):
return '%s: %s' % (self.code, self.message)
class Result(MutableMapping):
def __init__(self, response):
self.response = response
def __getitem__(self, key):
return self.response[key]
__getattr__ = __getitem__
def __setitem__(self, key, value):
self.response[key] = value
def __delitem__(self, key):
del self.response[key]
def __iter__(self):
return iter(self.response)
def __len__(self):
return len(self.response)
def __repr__(self):
return '<%s: %s>' % (type(self).__name__, repr(self.response))
class Resource(object):
def __init__(self, api, interface=None, endpoint=None, method=None, nested=False):
self.api = api
self.interface = interface or copy.deepcopy(parse_interfaces(INTERFACES))
self.endpoint = endpoint
self.method = method
self.nested = nested
def __getattr__(self, attr):
if attr in getattr(self, '__dict__'):
return getattr(self, attr)
interface = self.interface
if self.nested:
attr = "%s.%s" % (self.endpoint, attr)
submethod_exists = False
submethod_match = attr + '.'
for key in interface.keys():
if key.startswith(submethod_match):
submethod_exists = True
break
if attr not in interface and submethod_exists:
return Resource(self.api, interface, attr, self.endpoint, nested=True)
elif attr not in interface:
interface[attr] = {}
if self.nested:
return Resource(self.api, interface[attr], attr, self.method)
return Resource(self.api, interface[attr], attr, self.endpoint)
def __call__(self, **kwargs):
return self._request(**kwargs)
def _request(self, **kwargs):
# Check for missing variables
resource = self.interface
def validate_kwarg(key, target):
# Always allow list
if isinstance(target, list):
return (
isinstance(key, (list, tuple, set)) and
all(validate_kwarg(x, target[0]) for x in key)
)
return isinstance(key, tuple(target) if isinstance(target, list) else target)
for key, val in resource.get('required', {}).items():
if key not in [x.split(':')[0] for x in kwargs.keys()]:
raise ValueError('Missing required argument: %s' % key)
if isinstance(kwargs.get(key), list) and not isinstance(val, list):
raise ValueError('Wrong argument type: %s is not a list' % key)
elif not validate_kwarg(kwargs.get(key), val):
if isinstance(val, list):
raise ValueError('Wrong argument type: %s is not a list of %ss' % (key, val[0]))
raise ValueError('Wrong argument type: %s is not a %s' % (key, val))
conduit = self.api._conduit
if conduit:
# Already authenticated, add session key to json data
kwargs['__conduit__'] = conduit
elif self.method == 'conduit' and self.endpoint == 'connect':
# Not authenticated, requesting new session key
token = str(int(time.time()))
kwargs['authToken'] = token
kwargs['authSignature'] = self.api.generate_hash(token)
else:
# Authorization is required, silently auth the user
self.api.connect()
kwargs['__conduit__'] = self.api._conduit
url = urlparse.urlparse(self.api.host)
if url.scheme == 'https':
conn = httplib.HTTPSConnection(url.netloc, timeout=self.api.timeout)
else:
conn = httplib.HTTPConnection(url.netloc, timeout=self.api.timeout)
path = url.path + '%s.%s' % (self.method, self.endpoint)
headers = {
'User-Agent': 'python-phabricator/%s' % str(self.api.clientVersion),
'Content-Type': 'application/x-www-form-urlencoded'
}
body = urlencode({
"params": json.dumps(kwargs),
"output": self.api.response_format
})
# TODO: Use HTTP "method" from interfaces.json
conn.request('POST', path, body, headers)
response = conn.getresponse()
# Make sure we got a 2xx response indicating success
if not response.status >= 200 or not response.status < 300:
raise httplib.HTTPException(
'Bad response status: {0}'.format(response.status)
)
response_data = response.read()
if isinstance(response_data, str):
response = response_data
else:
response = response_data.decode("utf-8")
data = self._parse_response(response)
return Result(data['result'])
def _parse_response(self, data):
# Process the response back to python
parsed = self.api.formats[self.api.response_format](data)
# Errors return 200, so check response content for exception
if parsed['error_code']:
raise APIError(parsed['error_code'], parsed['error_info'])
return parsed
class Phabricator(Resource):
formats = {
'json': lambda x: json.loads(x),
}
def __init__(self, username=None, certificate=None, host=None,
timeout=5, response_format='json', token=None, **kwargs):
defined_hosts = ARCRC.get('hosts', {})
try:
self.host = host if host else list(defined_hosts.keys())[0]
except IndexError:
raise ConfigurationError("No host found or provided.")
current_host_config = defined_hosts.get(self.host, {})
self.token = token if token else current_host_config.get('token')
if self.token is None:
self.username = username if username else current_host_config.get('user')
self.certificate = certificate if certificate else current_host_config.get('cert')
self.timeout = timeout
self.response_format = response_format
self.client = 'python-phabricator'
self.clientVersion = 1
self.clientDescription = socket.gethostname() + ':python-phabricator'
self._conduit = None
super(Phabricator, self).__init__(self)
def _request(self, **kwargs):
raise SyntaxError('You cannot call the Conduit API without a resource.')
def connect(self):
if self.token:
self._conduit = {
'token': self.token
}
return
auth = Resource(api=self, method='conduit', endpoint='connect')
response = auth(
user=self.username,
host=self.host,
client=self.client,
clientVersion=self.clientVersion
)
self._conduit = {
'sessionKey': response.sessionKey,
'connectionID': response.connectionID
}
def generate_hash(self, token):
source_string = (token + self.api.certificate).encode('utf-8')
return hashlib.sha1(source_string).hexdigest()
def update_interfaces(self):
query = Resource(api=self, method='conduit', endpoint='query')
interfaces = query()
self.interface = parse_interfaces(interfaces)
|