/var/lib/shinken/cli/shinkenio/cli.py is in shinken-common 2.0.3-4.
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 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 | # Copyright (C) 2009-2014:
# Gabes Jean, naparuba@gmail.com
# Gerhard Lausser, Gerhard.Lausser@consol.de
# Gregory Starck, g.starck@gmail.com
# Hartmut Goebel, h.goebel@goebel-consult.de
#
# This file is part of Shinken.
#
# Shinken is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Shinken 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with Shinken. If not, see <http://www.gnu.org/licenses/>.
import pycurl
import os
import sys
import stat
import json
import tempfile
import tarfile
import urllib
import shutil
from StringIO import StringIO
from shinken.log import logger, cprint
# Will be populated by the shinken CLI command
CONFIG = None
############# ******************** PUBLISH ****************###########
def read_package_json(fd):
buf = fd.read()
fd.close()
buf = buf.decode('utf8', 'ignore')
try:
package_json = json.loads(buf)
except ValueError, exp:
logger.error("Bad package.json file : %s" % exp)
sys.exit(2)
if not package_json:
logger.error("Bad package.json file")
sys.exit(2)
return package_json
def create_archive(to_pack):
# First try to look if the directory we are trying to pack is valid
to_pack = os.path.abspath(to_pack)
if not os.path.exists(to_pack):
logger.error("Error : the directory to pack is missing %s" % to_pack)
sys.exit(2)
logger.debug("Preparing to pack the directory %s" % to_pack)
package_json_p = os.path.join(to_pack, 'package.json')
if not os.path.exists(package_json_p):
logger.error("Error : Missing file %s" % package_json_p)
sys.exit(2)
package_json = read_package_json(open(package_json_p))
name = package_json.get('name', None)
if not name:
logger.error('Missing name entry in the package.json file. Cannot pack')
sys.exit(2)
# return True for files we want to exclude
def tar_exclude_filter(f):
# if the file start with .git, we bail out
# Also ending with ~ (Thanks emacs...)
if f.startswith('./.git') or f.startswith('.git'):
return True
if f.endswith('~'):
return True
return False
# Now prepare a destination file
tmp_dir = tempfile.gettempdir()
tmp_file = os.path.join(tmp_dir, name+'.tar.gz')
tar = tarfile.open(tmp_file, "w:gz")
os.chdir(to_pack)
tar.add(".",arcname='.', exclude=tar_exclude_filter)
tar.close()
logger.debug("Saved file %s" % tmp_file)
return tmp_file
def publish_archive(archive):
# Now really publish it
proxy = CONFIG['shinken.io']['proxy']
api_key = CONFIG['shinken.io']['api_key']
# Ok we will push the file with a 10s timeout
c = pycurl.Curl()
c.setopt(c.POST, 1)
c.setopt(c.CONNECTTIMEOUT, 30)
c.setopt(c.TIMEOUT, 300)
if proxy:
c.setopt(c.PROXY, proxy)
c.setopt(c.URL, "http://shinken.io/push")
c.setopt(c.HTTPPOST, [("api_key", api_key),
("data",
(c.FORM_FILE, str(archive),
c.FORM_CONTENTTYPE, "application/x-gzip"))
])
response = StringIO()
c.setopt(pycurl.WRITEFUNCTION, response.write)
c.setopt(c.VERBOSE, 1)
try:
c.perform()
except pycurl.error, exp:
logger.error("There was a critical error : %s" % exp)
return
r = c.getinfo(pycurl.HTTP_CODE)
c.close()
if r != 200:
logger.error("There was a critical error : %s" % response.getvalue())
sys.exit(2)
else:
ret = json.loads(response.getvalue().replace('\\/', '/'))
status = ret.get('status')
text = ret.get('text')
if status == 200:
logger.log(text)
else:
logger.error(text)
def do_publish(to_pack='.'):
logger.debug("WILL CALL PUBLISH.py with %s" % to_pack)
archive = create_archive(to_pack)
publish_archive(archive)
################" *********************** SEARCH *************** ##################
def search(look_at):
# Now really publish it
proxy = CONFIG['shinken.io']['proxy']
api_key = CONFIG['shinken.io']['api_key']
# Ok we will push the file with a 10s timeout
c = pycurl.Curl()
c.setopt(c.POST, 0)
c.setopt(c.CONNECTTIMEOUT, 30)
c.setopt(c.TIMEOUT, 300)
if proxy:
c.setopt(c.PROXY, proxy)
args = {'keywords':','.join(look_at)}
c.setopt(c.URL, str('shinken.io/searchcli?'+urllib.urlencode(args)))
response = StringIO()
c.setopt(pycurl.WRITEFUNCTION, response.write)
#c.setopt(c.VERBOSE, 1)
try:
c.perform()
except pycurl.error, exp:
logger.error("There was a critical error : %s" % exp)
return
r = c.getinfo(pycurl.HTTP_CODE)
c.close()
if r != 200:
logger.error("There was a critical error : %s" % response.getvalue())
sys.exit(2)
else:
ret = json.loads(response.getvalue().replace('\\/', '/'))
status = ret.get('status')
result = ret.get('result')
if status != 200:
logger.log(result)
return []
return result
def print_search_matches(matches):
if len(matches) == 0:
logger.warning("No match founded in shinken.io")
return
# We will sort and uniq results (maybe we got a all search
# so we will have both pack&modules, but some are both
ps = {}
names = [p['name'] for p in matches]
names = list(set(names))
names.sort()
for p in matches:
name = p['name']
ps[name] = p
for name in names:
p = ps[name]
user_id = p['user_id']
keywords = p['keywords']
description = p['description']
cprint('%s ' % name , 'green', end='')
cprint('(%s) [%s] : %s' % (user_id, ','.join(keywords), description))
def do_search(*look_at):
# test for generic search
if look_at == ('all',):
matches = []
look_at = ('pack',)
matches += search(look_at)
look_at = ('module',)
matches += search(look_at)
else:
logger.debug("CALL SEARCH WITH ARGS %s" % str(look_at))
matches = search(look_at)
if matches == [] : print ('you are unlucky, use "shinken search all" for a complete list ')
print_search_matches(matches)
################" *********************** INVENTORY *************** ##################
def inventor(look_at):
# Now really publish it
inventory = CONFIG['paths']['inventory']
logger.debug("dumping inventory %s" % inventory)
# get all sub-direcotries
for d in os.listdir(inventory):
if os.path.exists(os.path.join(inventory, d, 'package.json')):
if not look_at or d in look_at:
print d
# If asked, dump the content.package content
if look_at or d in look_at:
content_p = os.path.join(inventory, d, 'content.json')
if not os.path.exists(content_p):
logger.error('Missing %s file' % content_p)
continue
try:
j = json.loads(open(content_p, 'r').read())
except Exception, exp:
logger.error('Bad %s file "%s"' % (content_p, exp))
continue
for d in j:
s = ''
if d['type'] == '5': # tar direcotry
s += '(d)'
else:
s += '(f)'
s += d['name']
print s
def do_inventory(*look_at):
inventor(look_at)
#################### ***************** INSTALL ************ ###################
def _copytree(src, dst, symlinks=False, ignore=None):
for item in os.listdir(src):
s = os.path.join(src, item)
d = os.path.join(dst, item)
if os.path.isdir(s):
if not os.path.exists(d):
os.mkdir(d)
_copytree(s, d, symlinks, ignore)
else:
shutil.copy2(s, d)
# Do a chmod -R +x
def _chmodplusx(d):
for item in os.listdir(d):
p = os.path.join(d, item)
if os.path.isdir(p):
_chmodplusx(p)
else:
st = os.stat(p)
os.chmod(p, st.st_mode | stat.S_IEXEC | stat.S_IXGRP | stat.S_IXOTH)
def grab_package(pname):
cprint('Grabbing : ' , end='')
cprint('%s' % pname, 'green')
# Now really publish it
proxy = CONFIG['shinken.io']['proxy']
api_key = CONFIG['shinken.io']['api_key']
# Ok we will push the file with a 5m timeout
c = pycurl.Curl()
c.setopt(c.POST, 0)
c.setopt(c.CONNECTTIMEOUT, 30)
c.setopt(c.TIMEOUT, 300)
if proxy:
c.setopt(c.PROXY, proxy)
c.setopt(c.URL, str('shinken.io/grab/%s' % pname))
response = StringIO()
c.setopt(pycurl.WRITEFUNCTION, response.write)
#c.setopt(c.VERBOSE, 1)
try:
c.perform()
except pycurl.error, exp:
logger.error("There was a critical error : %s" % exp)
return ''
r = c.getinfo(pycurl.HTTP_CODE)
c.close()
if r != 200:
logger.error("There was a critical error : %s" % response.getvalue())
sys.exit(2)
else:
ret = response.getvalue()
logger.debug("CURL result len : %d " % len(ret))
return ret
def grab_local(d):
# First try to look if the directory we are trying to pack is valid
to_pack = os.path.abspath(d)
if not os.path.exists(to_pack):
err = "Error : the directory to install is missing %s" % to_pack
logger.error(err)
raise Exception(err)
package_json_p = os.path.join(to_pack, 'package.json')
if not os.path.exists(package_json_p):
logger.error("Error : Missing file %s" % package_json_p)
sys.exit(2)
package_json = read_package_json(open(package_json_p))
pname = package_json.get('name', None)
if not pname:
err = 'Missing name entry in the package.json file. Cannot install'
logger.error(err)
raise Exception(err)
# return True for files we want to exclude
def tar_exclude_filter(f):
# if the file start with .git, we bail out
# Also ending with ~ (Thanks emacs...)
if f.startswith('./.git'):
return True
if f.endswith('~'):
return True
return False
# Now prepare a destination file
tmp_file = tempfile.mktemp()
tar = tarfile.open(tmp_file, "w:gz")
os.chdir(to_pack)
tar.add(".",arcname='.', exclude=tar_exclude_filter)
tar.close()
fd = open(tmp_file, 'rb')
raw = fd.read()
fd.close()
return (pname, raw)
def install_package(pname, raw):
logger.debug("Installing the package %s (size:%d)" % (pname, len(raw)))
if len(raw) == 0:
logger.error('The package %s cannot be found' % pname)
return
tmpdir = os.path.join(tempfile.gettempdir(), pname)
logger.debug("Unpacking the package into %s" % tmpdir)
if os.path.exists(tmpdir):
logger.debug("Removing previous tmp dir %s" % tmpdir)
shutil.rmtree(tmpdir)
logger.debug("Creating temporary dir %s" % tmpdir)
os.mkdir(tmpdir)
package_content = []
# open a file with the content
f = StringIO(raw)
tar_file = tarfile.open(fileobj=f, mode="r")
logger.debug("Tar file contents:")
for i in tar_file.getmembers():
path = i.name
if path == '.':
continue
if path.startswith('/') or '..' in path:
logger.error("SECURITY: the path %s seems dangerous!" % path)
return
# Adding all files into the package_content list
package_content.append( {'name':i.name, 'mode':i.mode, 'type':i.type, 'size':i.size} )
logger.debug("\t%s" % path)
# Extract all in the tmpdir
tar_file.extractall(tmpdir)
tar_file.close()
# Now we look at the package.json that will give us our name and co
package_json_p = os.path.join(tmpdir, 'package.json')
if not os.path.exists(package_json_p):
logger.error("Error : bad archive : Missing file %s" % package_json_p)
return None
package_json = read_package_json(open(package_json_p))
logger.debug("Package.json content %s " % package_json)
modules_dir = CONFIG['paths']['modules']
share_dir = CONFIG['paths']['share']
packs_dir = CONFIG['paths']['packs']
etc_dir = CONFIG['paths']['etc']
doc_dir = CONFIG['paths']['doc']
inventory_dir = CONFIG['paths']['inventory']
libexec_dir = CONFIG['paths'].get('libexec', os.path.join(CONFIG['paths']['lib'], 'libexec'))
test_dir = CONFIG['paths'].get('test', '/__DONOTEXISTS__')
for d in (modules_dir, share_dir, packs_dir, doc_dir, inventory_dir):
if not os.path.exists(d):
logger.error("The installation directory %s is missing!" % d)
return
# Now install the package from $TMP$/share/* to $SHARE$/*
p_share = os.path.join(tmpdir, 'share')
logger.debug("TMPDIR:%s aahre_dir:%s pname:%s" %(tmpdir, share_dir, pname))
if os.path.exists(p_share):
logger.info("Installing the share package data")
# shutil will do the create dir
_copytree(p_share, share_dir)
logger.info("Copy done in the share directory %s" % share_dir)
logger.debug("TMPDIR:%s modules_dir:%s pname:%s" %(tmpdir, modules_dir, pname))
# Now install the package from $TMP$/module/* to $MODULES$/pname/*
p_module = os.path.join(tmpdir, 'module')
if os.path.exists(p_module):
logger.info("Installing the module package data")
mod_dest = os.path.join(modules_dir, pname)
if os.path.exists(mod_dest):
logger.info("Removing previous module install at %s" % mod_dest)
shutil.rmtree(mod_dest)
# shutil will do the create dir
shutil.copytree(p_module, mod_dest)
logger.info("Copy done in the module directory %s" % mod_dest)
p_doc = os.path.join(tmpdir, 'doc')
logger.debug("TMPDIR:%s doc_dir:%s pname:%s" %(tmpdir, doc_dir, pname))
# Now install the package from $TMP$/doc/* to $MODULES$/doc/source/89_packages/pname/*
if os.path.exists(p_doc):
logger.info("Installing the doc package data")
doc_dest = os.path.join(doc_dir, 'source', '89_packages', pname)
if os.path.exists(doc_dest):
logger.info("Removing previous doc install at %s" % doc_dest)
shutil.rmtree(doc_dest)
# shutil will do the create dir
shutil.copytree(p_doc, doc_dest)
logger.info("Copy done in the doc directory %s" % doc_dest)
# Now install the pack from $TMP$/pack/* to $PACKS$/pname/*
p_pack = os.path.join(tmpdir, 'pack')
if os.path.exists(p_pack):
logger.info("Installing the pack package data")
pack_dest = os.path.join(packs_dir, pname)
if os.path.exists(pack_dest):
logger.info("Removing previous pack install at %s" % pack_dest)
shutil.rmtree(pack_dest)
# shutil will do the create dir
shutil.copytree(p_pack, pack_dest)
logger.info("Copy done in the pack directory %s" % pack_dest)
# Now install the etc from $TMP$/etc/* to $ETC$/etc/*
p_etc = os.path.join(tmpdir, 'etc')
if os.path.exists(p_etc):
logger.info("Merging the etc package data into your etc directory")
# We don't use shutils because it NEED etc_dir to be non existant...
# Come one guys..... cp is not as terrible as this...
_copytree(p_etc, etc_dir)
logger.info("Copy done in the etc directory %s" % etc_dir)
# Now install the tests from $TMP$/tests/* to $TESTS$/tests/*
# if the last one is specified on the configuration file (optionnal)
p_tests = os.path.join(tmpdir, 'test')
if os.path.exists(p_tests) and os.path.exists(test_dir):
logger.info("Merging the test package data into your test directory")
# We don't use shutils because it NEED etc_dir to be non existant...
# Come one guys..... cp is not as terrible as this...
logger.debug("COPYING %s into %s" % (p_tests, test_dir))
_copytree(p_tests, test_dir)
logger.info("Copy done in the test directory %s" % test_dir)
# Now install the libexec things from $TMP$/libexec/* to $LIBEXEC$/*
# but also chmod a+x the plugins copied
p_libexec = os.path.join(tmpdir, 'libexec')
if os.path.exists(p_libexec) and os.path.exists(libexec_dir):
logger.info("Merging the libexec package data into your libexec directory")
logger.debug("COPYING %s into %s" % (p_libexec, libexec_dir))
# Before be sure all files in there are +x
_chmodplusx(p_libexec)
_copytree(p_libexec, libexec_dir)
logger.info("Copy done in the libexec directory %s" % libexec_dir)
# then samve the package.json into the inventory dir
p_inv = os.path.join(inventory_dir, pname)
if not os.path.exists(p_inv):
os.mkdir(p_inv)
shutil.copy2(package_json_p, os.path.join(p_inv, 'package.json'))
# and the package content
cont = open(os.path.join(p_inv, 'content.json'), 'w')
cont.write(json.dumps(package_content))
cont.close()
# We now clean (rm) the tmpdir we don't need any more
try:
shutil.rmtree(tmpdir, ignore_errors=True)
# cannot remove? not a crime
except OSError:
pass
# THE END, output all is OK :D
cprint('OK ', 'green', end='')
cprint('%s' % pname)
def do_install(pname, local, download_only):
raw = ''
if local:
pname, raw = grab_local(pname)
if not local:
raw = grab_package(pname)
if download_only:
tmpf = os.path.join(tempfile.gettempdir(), pname+'.tar.gz')
try:
f = open(tmpf, 'wb')
f.write(raw)
f.close()
cprint('Download OK: %s' % tmpf, 'green')
except Exception, exp:
logger.error("Package save fail: %s" % exp)
return
install_package(pname, raw)
exports = {
do_publish : {
'keywords': ['publish'],
'args': [
{'name' : 'to_pack', 'default':'.', 'description':'Package directory. Default to .'},
],
'description': 'Publish a package on shinken.io. Valid api key required'
},
do_search : {'keywords': ['search'], 'args': [],
'description': 'Search a package on shinken.io by looking at its keywords'
},
do_install : {
'keywords': ['install'],
'args': [
{'name' : 'pname', 'description':'Package to install'},
{'name' : '--local', 'description':'Use a local directory instead of the shinken.io version', 'type': 'bool'},
{'name' : '--download-only', 'description':'Only download the package', 'type': 'bool'},
],
'description' : 'Grab and install a package from shinken.io'
},
do_inventory : {'keywords': ['inventory'], 'args': [],
'description': 'List locally installed packages'
},
}
|