projects / osm / NBI.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Pin black version in tox.ini to 23.12.1
[osm/NBI.git] / osm_nbi / nbi.py
1 #!/usr/bin/python3
2 # -*- coding: utf-8 -*-
3
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
7 #
8 # http://www.apache.org/licenses/LICENSE-2.0
9 #
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13 # implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 import cherrypy
18 import time
19 import json
20 import yaml
21 import osm_nbi.html_out as html
22 import logging
23 import logging.handlers
24 import getopt
25 import sys
26
27 from osm_nbi.authconn import AuthException, AuthconnException
28 from osm_nbi.auth import Authenticator
29 from osm_nbi.engine import Engine, EngineException
30 from osm_nbi.subscriptions import SubscriptionThread
31 from osm_nbi.utils import cef_event, cef_event_builder
32 from osm_nbi.validation import ValidationError
33 from osm_common.dbbase import DbException
34 from osm_common.fsbase import FsException
35 from osm_common.msgbase import MsgException
36 from http import HTTPStatus
37 from codecs import getreader
38 from os import environ, path
39 from osm_nbi import version as nbi_version, version_date as nbi_version_date
40
41 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
42
43 __version__ = "0.1.3" # file version, not NBI version
44 version_date = "Aug 2019"
45
46 database_version = "1.2"
47 auth_database_version = "1.0"
48 nbi_server = None # instance of Server class
49 subscription_thread = None # instance of SubscriptionThread class
50 cef_logger = None
51
52 """
53 North Bound Interface (O: OSM specific; 5,X: SOL005 not implemented yet; O5: SOL005 implemented)
54 URL: /osm GET POST PUT DELETE PATCH
55 /nsd/v1
56 /ns_descriptors_content O O
57 /<nsdInfoId> O O O O
58 /ns_descriptors O5 O5
59 /<nsdInfoId> O5 O5 5
60 /nsd_content O5 O5
61 /nsd O
62 /artifacts[/<artifactPath>] O
63 /pnf_descriptors 5 5
64 /<pnfdInfoId> 5 5 5
65 /pnfd_content 5 5
66 /subscriptions 5 5
67 /<subscriptionId> 5 X
68
69 /vnfpkgm/v1
70 /vnf_packages_content O O
71 /<vnfPkgId> O O
72 /vnf_packages O5 O5
73 /<vnfPkgId> O5 O5 5
74 /package_content O5 O5
75 /upload_from_uri X
76 /vnfd O5
77 /artifacts[/<artifactPath>] O5
78 /subscriptions X X
79 /<subscriptionId> X X
80
81 /nslcm/v1
82 /ns_instances_content O O
83 /<nsInstanceId> O O
84 /ns_instances 5 5
85 /<nsInstanceId> O5 O5
86 instantiate O5
87 terminate O5
88 action O
89 scale O5
90 migrate O
91 update 05
92 heal O5
93 /ns_lcm_op_occs 5 5
94 /<nsLcmOpOccId> 5 5 5
95 TO BE COMPLETED 5 5
96 /vnf_instances (also vnfrs for compatibility) O
97 /<vnfInstanceId> O
98 /subscriptions 5 5
99 /<subscriptionId> 5 X
100
101 /pdu/v1
102 /pdu_descriptors O O
103 /<id> O O O O
104
105 /admin/v1
106 /tokens O O
107 /<id> O O
108 /users O O
109 /<id> O O O O
110 /projects O O
111 /<id> O O
112 /vim_accounts (also vims for compatibility) O O
113 /<id> O O O
114 /wim_accounts O O
115 /<id> O O O
116 /sdns O O
117 /<id> O O O
118 /k8sclusters O O
119 /<id> O O O
120 /k8srepos O O
121 /<id> O O
122 /osmrepos O O
123 /<id> O O
124
125 /nst/v1 O O
126 /netslice_templates_content O O
127 /<nstInfoId> O O O O
128 /netslice_templates O O
129 /<nstInfoId> O O O
130 /nst_content O O
131 /nst O
132 /artifacts[/<artifactPath>] O
133 /subscriptions X X
134 /<subscriptionId> X X
135
136 /nsilcm/v1
137 /netslice_instances_content O O
138 /<SliceInstanceId> O O
139 /netslice_instances O O
140 /<SliceInstanceId> O O
141 instantiate O
142 terminate O
143 action O
144 /nsi_lcm_op_occs O O
145 /<nsiLcmOpOccId> O O O
146 /subscriptions X X
147 /<subscriptionId> X X
148
149 query string:
150 Follows SOL005 section 4.3.2 It contains extra METHOD to override http method, FORCE to force.
151 simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]*
152 filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]*
153 op := "eq" | "neq" (or "ne") | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont"
154 attrName := string
155 For filtering inside array, it must select the element of the array, or add ANYINDEX to apply the filtering over any
156 item of the array, that is, pass if any item of the array pass the filter.
157 It allows both ne and neq for not equal
158 TODO: 4.3.3 Attribute selectors
159 all_fields, fields=x,y,.., exclude_default, exclude_fields=x,y,...
160 (none) … same as “exclude_default”
161 all_fields … all attributes.
162 fields=<list> … all attributes except all complex attributes with minimum cardinality of zero that are not
163 conditionally mandatory, and that are not provided in <list>.
164 exclude_fields=<list> … all attributes except those complex attributes with a minimum cardinality of zero that
165 are not conditionally mandatory, and that are provided in <list>.
166 exclude_default … all attributes except those complex attributes with a minimum cardinality of zero that are not
167 conditionally mandatory, and that are part of the "default exclude set" defined in the present specification for
168 the particular resource
169 exclude_default and include=<list> … all attributes except those complex attributes with a minimum cardinality
170 of zero that are not conditionally mandatory and that are part of the "default exclude set" defined in the
171 present specification for the particular resource, but that are not part of <list>
172 Additionally it admits some administrator values:
173 FORCE: To force operations skipping dependency checkings
174 ADMIN: To act as an administrator or a different project
175 PUBLIC: To get public descriptors or set a descriptor as public
176 SET_PROJECT: To make a descriptor available for other project
177
178 Header field name Reference Example Descriptions
179 Accept IETF RFC 7231 [19] application/json Content-Types that are acceptable for the response.
180 This header field shall be present if the response is expected to have a non-empty message body.
181 Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the request.
182 This header field shall be present if the request has a non-empty message body.
183 Authorization IETF RFC 7235 [22] Bearer mF_9.B5f-4.1JqM The authorization token for the request.
184 Details are specified in clause 4.5.3.
185 Range IETF RFC 7233 [21] 1000-2000 Requested range of bytes from a file
186 Header field name Reference Example Descriptions
187 Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the response.
188 This header field shall be present if the response has a non-empty message body.
189 Location IETF RFC 7231 [19] http://www.example.com/vnflcm/v1/vnf_instances/123 Used in redirection, or when a
190 new resource has been created.
191 This header field shall be present if the response status code is 201 or 3xx.
192 In the present document this header field is also used if the response status code is 202 and a new resource was
193 created.
194 WWW-Authenticate IETF RFC 7235 [22] Bearer realm="example" Challenge if the corresponding HTTP request has not
195 provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization
196 token.
197 Accept-Ranges IETF RFC 7233 [21] bytes Used by the Server to signal whether or not it supports ranges for
198 certain resources.
199 Content-Range IETF RFC 7233 [21] bytes 21010-47021/ 47022 Signals the byte range that is contained in the
200 response, and the total length of the file.
201 Retry-After IETF RFC 7231 [19] Fri, 31 Dec 1999 23:59:59 GMT
202 """
203
204 valid_query_string = ("ADMIN", "SET_PROJECT", "FORCE", "PUBLIC")
205 # ^ Contains possible administrative query string words:
206 # ADMIN=True(by default)|Project|Project-list: See all elements, or elements of a project
207 # (not owned by my session project).
208 # PUBLIC=True(by default)|False: See/hide public elements. Set/Unset a topic to be public
209 # FORCE=True(by default)|False: Force edition/deletion operations
210 # SET_PROJECT=Project|Project-list: Add/Delete the topic to the projects portfolio
211
212 valid_url_methods = {
213 # contains allowed URL and methods, and the role_permission name
214 "admin": {
215 "v1": {
216 "tokens": {
217 "METHODS": ("GET", "POST", "DELETE"),
218 "ROLE_PERMISSION": "tokens:",
219 "<ID>": {"METHODS": ("GET", "DELETE"), "ROLE_PERMISSION": "tokens:id:"},
220 },
221 "users": {
222 "METHODS": ("GET", "POST"),
223 "ROLE_PERMISSION": "users:",
224 "<ID>": {
225 "METHODS": ("GET", "DELETE", "PATCH"),
226 "ROLE_PERMISSION": "users:id:",
227 },
228 },
229 "projects": {
230 "METHODS": ("GET", "POST"),
231 "ROLE_PERMISSION": "projects:",
232 "<ID>": {
233 "METHODS": ("GET", "DELETE", "PATCH"),
234 "ROLE_PERMISSION": "projects:id:",
235 },
236 },
237 "roles": {
238 "METHODS": ("GET", "POST"),
239 "ROLE_PERMISSION": "roles:",
240 "<ID>": {
241 "METHODS": ("GET", "DELETE", "PATCH"),
242 "ROLE_PERMISSION": "roles:id:",
243 },
244 },
245 "vims": {
246 "METHODS": ("GET", "POST"),
247 "ROLE_PERMISSION": "vims:",
248 "<ID>": {
249 "METHODS": ("GET", "DELETE", "PATCH"),
250 "ROLE_PERMISSION": "vims:id:",
251 },
252 },
253 "vim_accounts": {
254 "METHODS": ("GET", "POST"),
255 "ROLE_PERMISSION": "vim_accounts:",
256 "<ID>": {
257 "METHODS": ("GET", "DELETE", "PATCH"),
258 "ROLE_PERMISSION": "vim_accounts:id:",
259 },
260 },
261 "wim_accounts": {
262 "METHODS": ("GET", "POST"),
263 "ROLE_PERMISSION": "wim_accounts:",
264 "<ID>": {
265 "METHODS": ("GET", "DELETE", "PATCH"),
266 "ROLE_PERMISSION": "wim_accounts:id:",
267 },
268 },
269 "sdns": {
270 "METHODS": ("GET", "POST"),
271 "ROLE_PERMISSION": "sdn_controllers:",
272 "<ID>": {
273 "METHODS": ("GET", "DELETE", "PATCH"),
274 "ROLE_PERMISSION": "sdn_controllers:id:",
275 },
276 },
277 "k8sclusters": {
278 "METHODS": ("GET", "POST"),
279 "ROLE_PERMISSION": "k8sclusters:",
280 "<ID>": {
281 "METHODS": ("GET", "DELETE", "PATCH"),
282 "ROLE_PERMISSION": "k8sclusters:id:",
283 },
284 },
285 "vca": {
286 "METHODS": ("GET", "POST"),
287 "ROLE_PERMISSION": "vca:",
288 "<ID>": {
289 "METHODS": ("GET", "DELETE", "PATCH"),
290 "ROLE_PERMISSION": "vca:id:",
291 },
292 },
293 "k8srepos": {
294 "METHODS": ("GET", "POST"),
295 "ROLE_PERMISSION": "k8srepos:",
296 "<ID>": {
297 "METHODS": ("GET", "DELETE"),
298 "ROLE_PERMISSION": "k8srepos:id:",
299 },
300 },
301 "osmrepos": {
302 "METHODS": ("GET", "POST"),
303 "ROLE_PERMISSION": "osmrepos:",
304 "<ID>": {
305 "METHODS": ("GET", "DELETE", "PATCH"),
306 "ROLE_PERMISSION": "osmrepos:id:",
307 },
308 },
309 "domains": {
310 "METHODS": ("GET",),
311 "ROLE_PERMISSION": "domains:",
312 },
313 }
314 },
315 "pdu": {
316 "v1": {
317 "pdu_descriptors": {
318 "METHODS": ("GET", "POST"),
319 "ROLE_PERMISSION": "pduds:",
320 "<ID>": {
321 "METHODS": ("GET", "POST", "DELETE", "PATCH", "PUT"),
322 "ROLE_PERMISSION": "pduds:id:",
323 },
324 },
325 }
326 },
327 "nsd": {
328 "v1": {
329 "ns_descriptors_content": {
330 "METHODS": ("GET", "POST"),
331 "ROLE_PERMISSION": "nsds:",
332 "<ID>": {
333 "METHODS": ("GET", "PUT", "DELETE"),
334 "ROLE_PERMISSION": "nsds:id:",
335 },
336 },
337 "ns_descriptors": {
338 "METHODS": ("GET", "POST"),
339 "ROLE_PERMISSION": "nsds:",
340 "<ID>": {
341 "METHODS": ("GET", "DELETE", "PATCH"),
342 "ROLE_PERMISSION": "nsds:id:",
343 "nsd_content": {
344 "METHODS": ("GET", "PUT"),
345 "ROLE_PERMISSION": "nsds:id:content:",
346 },
347 "nsd": {
348 "METHODS": ("GET",), # descriptor inside package
349 "ROLE_PERMISSION": "nsds:id:content:",
350 },
351 "artifacts": {
352 "METHODS": ("GET",),
353 "ROLE_PERMISSION": "nsds:id:nsd_artifact:",
354 "*": None,
355 },
356 },
357 },
358 "pnf_descriptors": {
359 "TODO": ("GET", "POST"),
360 "<ID>": {
361 "TODO": ("GET", "DELETE", "PATCH"),
362 "pnfd_content": {"TODO": ("GET", "PUT")},
363 },
364 },
365 "subscriptions": {
366 "TODO": ("GET", "POST"),
367 "<ID>": {"TODO": ("GET", "DELETE")},
368 },
369 }
370 },
371 "vnfpkgm": {
372 "v1": {
373 "vnf_packages_content": {
374 "METHODS": ("GET", "POST"),
375 "ROLE_PERMISSION": "vnfds:",
376 "<ID>": {
377 "METHODS": ("GET", "PUT", "DELETE"),
378 "ROLE_PERMISSION": "vnfds:id:",
379 },
380 },
381 "vnf_packages": {
382 "METHODS": ("GET", "POST"),
383 "ROLE_PERMISSION": "vnfds:",
384 "<ID>": {
385 "METHODS": ("GET", "DELETE", "PATCH"), # GET: vnfPkgInfo
386 "ROLE_PERMISSION": "vnfds:id:",
387 "package_content": {
388 "METHODS": ("GET", "PUT"), # package
389 "ROLE_PERMISSION": "vnfds:id:",
390 "upload_from_uri": {
391 "METHODS": (),
392 "TODO": ("POST",),
393 "ROLE_PERMISSION": "vnfds:id:upload:",
394 },
395 },
396 "vnfd": {
397 "METHODS": ("GET",), # descriptor inside package
398 "ROLE_PERMISSION": "vnfds:id:content:",
399 },
400 "artifacts": {
401 "METHODS": ("GET",),
402 "ROLE_PERMISSION": "vnfds:id:vnfd_artifact:",
403 "*": None,
404 },
405 "action": {
406 "METHODS": ("POST",),
407 "ROLE_PERMISSION": "vnfds:id:action:",
408 },
409 },
410 },
411 "subscriptions": {
412 "TODO": ("GET", "POST"),
413 "<ID>": {"TODO": ("GET", "DELETE")},
414 },
415 "vnfpkg_op_occs": {
416 "METHODS": ("GET",),
417 "ROLE_PERMISSION": "vnfds:vnfpkgops:",
418 "<ID>": {"METHODS": ("GET",), "ROLE_PERMISSION": "vnfds:vnfpkgops:id:"},
419 },
420 }
421 },
422 "nslcm": {
423 "v1": {
424 "ns_instances_content": {
425 "METHODS": ("GET", "POST"),
426 "ROLE_PERMISSION": "ns_instances:",
427 "<ID>": {
428 "METHODS": ("GET", "DELETE"),
429 "ROLE_PERMISSION": "ns_instances:id:",
430 },
431 },
432 "ns_instances": {
433 "METHODS": ("GET", "POST"),
434 "ROLE_PERMISSION": "ns_instances:",
435 "<ID>": {
436 "METHODS": ("GET", "DELETE"),
437 "ROLE_PERMISSION": "ns_instances:id:",
438 "heal": {
439 "METHODS": ("POST",),
440 "ROLE_PERMISSION": "ns_instances:id:heal:",
441 },
442 "scale": {
443 "METHODS": ("POST",),
444 "ROLE_PERMISSION": "ns_instances:id:scale:",
445 },
446 "terminate": {
447 "METHODS": ("POST",),
448 "ROLE_PERMISSION": "ns_instances:id:terminate:",
449 },
450 "instantiate": {
451 "METHODS": ("POST",),
452 "ROLE_PERMISSION": "ns_instances:id:instantiate:",
453 },
454 "migrate": {
455 "METHODS": ("POST",),
456 "ROLE_PERMISSION": "ns_instances:id:migrate:",
457 },
458 "action": {
459 "METHODS": ("POST",),
460 "ROLE_PERMISSION": "ns_instances:id:action:",
461 },
462 "update": {
463 "METHODS": ("POST",),
464 "ROLE_PERMISSION": "ns_instances:id:update:",
465 },
466 "verticalscale": {
467 "METHODS": ("POST",),
468 "ROLE_PERMISSION": "ns_instances:id:verticalscale:",
469 },
470 },
471 },
472 "ns_lcm_op_occs": {
473 "METHODS": ("GET",),
474 "ROLE_PERMISSION": "ns_instances:opps:",
475 "<ID>": {
476 "METHODS": ("GET",),
477 "ROLE_PERMISSION": "ns_instances:opps:id:",
478 },
479 },
480 "vnfrs": {
481 "METHODS": ("GET",),
482 "ROLE_PERMISSION": "vnf_instances:",
483 "<ID>": {"METHODS": ("GET",), "ROLE_PERMISSION": "vnf_instances:id:"},
484 },
485 "vnf_instances": {
486 "METHODS": ("GET",),
487 "ROLE_PERMISSION": "vnf_instances:",
488 "<ID>": {"METHODS": ("GET",), "ROLE_PERMISSION": "vnf_instances:id:"},
489 },
490 "subscriptions": {
491 "METHODS": ("GET", "POST"),
492 "ROLE_PERMISSION": "ns_subscriptions:",
493 "<ID>": {
494 "METHODS": ("GET", "DELETE"),
495 "ROLE_PERMISSION": "ns_subscriptions:id:",
496 },
497 },
498 }
499 },
500 "vnflcm": {
501 "v1": {
502 "vnf_instances": {
503 "METHODS": ("GET", "POST"),
504 "ROLE_PERMISSION": "vnflcm_instances:",
505 "<ID>": {
506 "METHODS": ("GET", "DELETE"),
507 "ROLE_PERMISSION": "vnflcm_instances:id:",
508 "scale": {
509 "METHODS": ("POST",),
510 "ROLE_PERMISSION": "vnflcm_instances:id:scale:",
511 },
512 "terminate": {
513 "METHODS": ("POST",),
514 "ROLE_PERMISSION": "vnflcm_instances:id:terminate:",
515 },
516 "instantiate": {
517 "METHODS": ("POST",),
518 "ROLE_PERMISSION": "vnflcm_instances:id:instantiate:",
519 },
520 },
521 },
522 "vnf_lcm_op_occs": {
523 "METHODS": ("GET",),
524 "ROLE_PERMISSION": "vnf_instances:opps:",
525 "<ID>": {
526 "METHODS": ("GET",),
527 "ROLE_PERMISSION": "vnf_instances:opps:id:",
528 },
529 },
530 "subscriptions": {
531 "METHODS": ("GET", "POST"),
532 "ROLE_PERMISSION": "vnflcm_subscriptions:",
533 "<ID>": {
534 "METHODS": ("GET", "DELETE"),
535 "ROLE_PERMISSION": "vnflcm_subscriptions:id:",
536 },
537 },
538 }
539 },
540 "nst": {
541 "v1": {
542 "netslice_templates_content": {
543 "METHODS": ("GET", "POST"),
544 "ROLE_PERMISSION": "slice_templates:",
545 "<ID>": {
546 "METHODS": ("GET", "PUT", "DELETE"),
547 "ROLE_PERMISSION": "slice_templates:id:",
548 },
549 },
550 "netslice_templates": {
551 "METHODS": ("GET", "POST"),
552 "ROLE_PERMISSION": "slice_templates:",
553 "<ID>": {
554 "METHODS": ("GET", "DELETE"),
555 "TODO": ("PATCH",),
556 "ROLE_PERMISSION": "slice_templates:id:",
557 "nst_content": {
558 "METHODS": ("GET", "PUT"),
559 "ROLE_PERMISSION": "slice_templates:id:content:",
560 },
561 "nst": {
562 "METHODS": ("GET",), # descriptor inside package
563 "ROLE_PERMISSION": "slice_templates:id:content:",
564 },
565 "artifacts": {
566 "METHODS": ("GET",),
567 "ROLE_PERMISSION": "slice_templates:id:content:",
568 "*": None,
569 },
570 },
571 },
572 "subscriptions": {
573 "TODO": ("GET", "POST"),
574 "<ID>": {"TODO": ("GET", "DELETE")},
575 },
576 }
577 },
578 "nsilcm": {
579 "v1": {
580 "netslice_instances_content": {
581 "METHODS": ("GET", "POST"),
582 "ROLE_PERMISSION": "slice_instances:",
583 "<ID>": {
584 "METHODS": ("GET", "DELETE"),
585 "ROLE_PERMISSION": "slice_instances:id:",
586 },
587 },
588 "netslice_instances": {
589 "METHODS": ("GET", "POST"),
590 "ROLE_PERMISSION": "slice_instances:",
591 "<ID>": {
592 "METHODS": ("GET", "DELETE"),
593 "ROLE_PERMISSION": "slice_instances:id:",
594 "terminate": {
595 "METHODS": ("POST",),
596 "ROLE_PERMISSION": "slice_instances:id:terminate:",
597 },
598 "instantiate": {
599 "METHODS": ("POST",),
600 "ROLE_PERMISSION": "slice_instances:id:instantiate:",
601 },
602 "action": {
603 "METHODS": ("POST",),
604 "ROLE_PERMISSION": "slice_instances:id:action:",
605 },
606 },
607 },
608 "nsi_lcm_op_occs": {
609 "METHODS": ("GET",),
610 "ROLE_PERMISSION": "slice_instances:opps:",
611 "<ID>": {
612 "METHODS": ("GET",),
613 "ROLE_PERMISSION": "slice_instances:opps:id:",
614 },
615 },
616 }
617 },
618 "nspm": {
619 "v1": {
620 "pm_jobs": {
621 "<ID>": {
622 "reports": {
623 "<ID>": {
624 "METHODS": ("GET",),
625 "ROLE_PERMISSION": "reports:id:",
626 }
627 }
628 },
629 },
630 },
631 },
632 "nsfm": {
633 "v1": {
634 "alarms": {
635 "METHODS": ("GET", "PATCH"),
636 "ROLE_PERMISSION": "alarms:",
637 "<ID>": {
638 "METHODS": ("GET", "PATCH"),
639 "ROLE_PERMISSION": "alarms:id:",
640 },
641 }
642 },
643 },
644 }
645
646
647 class NbiException(Exception):
648 def __init__(self, message, http_code=HTTPStatus.METHOD_NOT_ALLOWED):
649 Exception.__init__(self, message)
650 self.http_code = http_code
651
652
653 class Server(object):
654 instance = 0
655 # to decode bytes to str
656 reader = getreader("utf-8")
657
658 def __init__(self):
659 self.instance += 1
660 self.authenticator = Authenticator(valid_url_methods, valid_query_string)
661 self.engine = Engine(self.authenticator)
662
663 def _format_in(self, kwargs):
664 error_text = "" # error_text must be initialized outside try
665 try:
666 indata = None
667 if cherrypy.request.body.length:
668 error_text = "Invalid input format "
669
670 if "Content-Type" in cherrypy.request.headers:
671 if "application/json" in cherrypy.request.headers["Content-Type"]:
672 error_text = "Invalid json format "
673 indata = json.load(self.reader(cherrypy.request.body))
674 cherrypy.request.headers.pop("Content-File-MD5", None)
675 elif "application/yaml" in cherrypy.request.headers["Content-Type"]:
676 error_text = "Invalid yaml format "
677 indata = yaml.safe_load(cherrypy.request.body)
678 cherrypy.request.headers.pop("Content-File-MD5", None)
679 elif (
680 "application/binary" in cherrypy.request.headers["Content-Type"]
681 or "application/gzip"
682 in cherrypy.request.headers["Content-Type"]
683 or "application/zip" in cherrypy.request.headers["Content-Type"]
684 or "text/plain" in cherrypy.request.headers["Content-Type"]
685 ):
686 indata = cherrypy.request.body # .read()
687 elif (
688 "multipart/form-data"
689 in cherrypy.request.headers["Content-Type"]
690 ):
691 if "descriptor_file" in kwargs:
692 filecontent = kwargs.pop("descriptor_file")
693 if not filecontent.file:
694 raise NbiException(
695 "empty file or content", HTTPStatus.BAD_REQUEST
696 )
697 indata = filecontent.file # .read()
698 if filecontent.content_type.value:
699 cherrypy.request.headers[
700 "Content-Type"
701 ] = filecontent.content_type.value
702 else:
703 # raise cherrypy.HTTPError(HTTPStatus.Not_Acceptable,
704 # "Only 'Content-Type' of type 'application/json' or
705 # 'application/yaml' for input format are available")
706 error_text = "Invalid yaml format "
707 indata = yaml.safe_load(cherrypy.request.body)
708 cherrypy.request.headers.pop("Content-File-MD5", None)
709 else:
710 error_text = "Invalid yaml format "
711 indata = yaml.safe_load(cherrypy.request.body)
712 cherrypy.request.headers.pop("Content-File-MD5", None)
713 if not indata:
714 indata = {}
715
716 format_yaml = False
717 if cherrypy.request.headers.get("Query-String-Format") == "yaml":
718 format_yaml = True
719
720 for k, v in kwargs.items():
721 if isinstance(v, str):
722 if v == "":
723 kwargs[k] = None
724 elif format_yaml:
725 try:
726 kwargs[k] = yaml.safe_load(v)
727 except Exception:
728 pass
729 elif (
730 k.endswith(".gt")
731 or k.endswith(".lt")
732 or k.endswith(".gte")
733 or k.endswith(".lte")
734 ):
735 try:
736 kwargs[k] = int(v)
737 except Exception:
738 try:
739 kwargs[k] = float(v)
740 except Exception:
741 pass
742 elif v.find(",") > 0:
743 kwargs[k] = v.split(",")
744 elif isinstance(v, (list, tuple)):
745 for index in range(0, len(v)):
746 if v[index] == "":
747 v[index] = None
748 elif format_yaml:
749 try:
750 v[index] = yaml.safe_load(v[index])
751 except Exception:
752 pass
753
754 return indata
755 except (ValueError, yaml.YAMLError) as exc:
756 raise NbiException(error_text + str(exc), HTTPStatus.BAD_REQUEST)
757 except KeyError as exc:
758 raise NbiException(
759 "Query string error: " + str(exc), HTTPStatus.BAD_REQUEST
760 )
761 except Exception as exc:
762 raise NbiException(error_text + str(exc), HTTPStatus.BAD_REQUEST)
763
764 @staticmethod
765 def _format_out(data, token_info=None, _format=None):
766 """
767 return string of dictionary data according to requested json, yaml, xml. By default json
768 :param data: response to be sent. Can be a dict, text or file
769 :param token_info: Contains among other username and project
770 :param _format: The format to be set as Content-Type if data is a file
771 :return: None
772 """
773 accept = cherrypy.request.headers.get("Accept")
774 if data is None:
775 if accept and "text/html" in accept:
776 return html.format(
777 data, cherrypy.request, cherrypy.response, token_info
778 )
779 # cherrypy.response.status = HTTPStatus.NO_CONTENT.value
780 return
781 elif hasattr(data, "read"): # file object
782 if _format:
783 cherrypy.response.headers["Content-Type"] = _format
784 elif "b" in data.mode: # binariy asssumig zip
785 cherrypy.response.headers["Content-Type"] = "application/zip"
786 else:
787 cherrypy.response.headers["Content-Type"] = "text/plain"
788 # TODO check that cherrypy close file. If not implement pending things to close per thread next
789 return data
790 if accept:
791 if "text/html" in accept:
792 return html.format(
793 data, cherrypy.request, cherrypy.response, token_info
794 )
795 elif "application/yaml" in accept or "*/*" in accept:
796 pass
797 elif "application/json" in accept or (
798 cherrypy.response.status and cherrypy.response.status >= 300
799 ):
800 cherrypy.response.headers[
801 "Content-Type"
802 ] = "application/json; charset=utf-8"
803 a = json.dumps(data, indent=4) + "\n"
804 return a.encode("utf8")
805 cherrypy.response.headers["Content-Type"] = "application/yaml"
806 return yaml.safe_dump(
807 data,
808 explicit_start=True,
809 indent=4,
810 default_flow_style=False,
811 tags=False,
812 encoding="utf-8",
813 allow_unicode=True,
814 ) # , canonical=True, default_style='"'
815
816 @cherrypy.expose
817 def index(self, *args, **kwargs):
818 token_info = None
819 try:
820 if cherrypy.request.method == "GET":
821 token_info = self.authenticator.authorize()
822 outdata = token_info # Home page
823 else:
824 raise cherrypy.HTTPError(
825 HTTPStatus.METHOD_NOT_ALLOWED.value,
826 "Method {} not allowed for tokens".format(cherrypy.request.method),
827 )
828
829 return self._format_out(outdata, token_info)
830
831 except (EngineException, AuthException) as e:
832 # cherrypy.log("index Exception {}".format(e))
833 cherrypy.response.status = e.http_code.value
834 return self._format_out("Welcome to OSM!", token_info)
835
836 @cherrypy.expose
837 def version(self, *args, **kwargs):
838 # TODO consider to remove and provide version using the static version file
839 try:
840 if cherrypy.request.method != "GET":
841 raise NbiException(
842 "Only method GET is allowed", HTTPStatus.METHOD_NOT_ALLOWED
843 )
844 elif args or kwargs:
845 raise NbiException(
846 "Invalid URL or query string for version",
847 HTTPStatus.METHOD_NOT_ALLOWED,
848 )
849 # TODO include version of other modules, pick up from some kafka admin message
850 osm_nbi_version = {"version": nbi_version, "date": nbi_version_date}
851 return self._format_out(osm_nbi_version)
852 except NbiException as e:
853 cherrypy.response.status = e.http_code.value
854 problem_details = {
855 "code": e.http_code.name,
856 "status": e.http_code.value,
857 "detail": str(e),
858 }
859 return self._format_out(problem_details, None)
860
861 def domain(self):
862 try:
863 domains = {
864 "user_domain_name": cherrypy.tree.apps["/osm"]
865 .config["authentication"]
866 .get("user_domain_name"),
867 "project_domain_name": cherrypy.tree.apps["/osm"]
868 .config["authentication"]
869 .get("project_domain_name"),
870 }
871 return self._format_out(domains)
872 except NbiException as e:
873 cherrypy.response.status = e.http_code.value
874 problem_details = {
875 "code": e.http_code.name,
876 "status": e.http_code.value,
877 "detail": str(e),
878 }
879 return self._format_out(problem_details, None)
880
881 @staticmethod
882 def _format_login(token_info):
883 """
884 Changes cherrypy.request.login to include username/project_name;session so that cherrypy access log will
885 log this information
886 :param token_info: Dictionary with token content
887 :return: None
888 """
889 cherrypy.request.login = token_info.get("username", "-")
890 if token_info.get("project_name"):
891 cherrypy.request.login += "/" + token_info["project_name"]
892 if token_info.get("id"):
893 cherrypy.request.login += ";session=" + token_info["id"][0:12]
894
895 # NS Fault Management
896 @cherrypy.expose
897 def nsfm(
898 self,
899 version=None,
900 topic=None,
901 uuid=None,
902 project_name=None,
903 ns_id=None,
904 *args,
905 **kwargs
906 ):
907 if topic == "alarms":
908 try:
909 method = cherrypy.request.method
910 role_permission = self._check_valid_url_method(
911 method, "nsfm", version, topic, None, None, *args
912 )
913 query_string_operations = self._extract_query_string_operations(
914 kwargs, method
915 )
916
917 self.authenticator.authorize(
918 role_permission, query_string_operations, None
919 )
920
921 # to handle get request
922 if cherrypy.request.method == "GET":
923 # if request is on basis of uuid
924 if uuid and uuid != "None":
925 try:
926 alarm = self.engine.db.get_one("alarms", {"uuid": uuid})
927 alarm_action = self.engine.db.get_one(
928 "alarms_action", {"uuid": uuid}
929 )
930 alarm.update(alarm_action)
931 vnf = self.engine.db.get_one(
932 "vnfrs", {"nsr-id-ref": alarm["tags"]["ns_id"]}
933 )
934 alarm["vnf-id"] = vnf["_id"]
935 return self._format_out(str(alarm))
936 except Exception:
937 return self._format_out("Please provide valid alarm uuid")
938 elif ns_id and ns_id != "None":
939 # if request is on basis of ns_id
940 try:
941 alarms = self.engine.db.get_list(
942 "alarms", {"tags.ns_id": ns_id}
943 )
944 for alarm in alarms:
945 alarm_action = self.engine.db.get_one(
946 "alarms_action", {"uuid": alarm["uuid"]}
947 )
948 alarm.update(alarm_action)
949 return self._format_out(str(alarms))
950 except Exception:
951 return self._format_out("Please provide valid ns id")
952 else:
953 # to return only alarm which are related to given project
954 project = self.engine.db.get_one(
955 "projects", {"name": project_name}
956 )
957 project_id = project.get("_id")
958 ns_list = self.engine.db.get_list(
959 "nsrs", {"_admin.projects_read": project_id}
960 )
961 ns_ids = []
962 for ns in ns_list:
963 ns_ids.append(ns.get("_id"))
964 alarms = self.engine.db.get_list("alarms")
965 alarm_list = [
966 alarm
967 for alarm in alarms
968 if alarm["tags"]["ns_id"] in ns_ids
969 ]
970 for alrm in alarm_list:
971 action = self.engine.db.get_one(
972 "alarms_action", {"uuid": alrm.get("uuid")}
973 )
974 alrm.update(action)
975 return self._format_out(str(alarm_list))
976 # to handle patch request for alarm update
977 elif cherrypy.request.method == "PATCH":
978 data = yaml.safe_load(cherrypy.request.body)
979 try:
980 # check if uuid is valid
981 self.engine.db.get_one("alarms", {"uuid": data.get("uuid")})
982 except Exception:
983 return self._format_out("Please provide valid alarm uuid.")
984 if data.get("is_enable") is not None:
985 if data.get("is_enable"):
986 alarm_status = "ok"
987 else:
988 alarm_status = "disabled"
989 self.engine.db.set_one(
990 "alarms",
991 {"uuid": data.get("uuid")},
992 {"alarm_status": alarm_status},
993 )
994 else:
995 self.engine.db.set_one(
996 "alarms",
997 {"uuid": data.get("uuid")},
998 {"threshold": data.get("threshold")},
999 )
1000 return self._format_out("Alarm updated")
1001 except Exception as e:
1002 if isinstance(
1003 e,
1004 (
1005 NbiException,
1006 EngineException,
1007 DbException,
1008 FsException,
1009 MsgException,
1010 AuthException,
1011 ValidationError,
1012 AuthconnException,
1013 ),
1014 ):
1015 http_code_value = cherrypy.response.status = e.http_code.value
1016 http_code_name = e.http_code.name
1017 cherrypy.log("Exception {}".format(e))
1018 else:
1019 http_code_value = (
1020 cherrypy.response.status
1021 ) = HTTPStatus.BAD_REQUEST.value # INTERNAL_SERVER_ERROR
1022 cherrypy.log("CRITICAL: Exception {}".format(e), traceback=True)
1023 http_code_name = HTTPStatus.BAD_REQUEST.name
1024 problem_details = {
1025 "code": http_code_name,
1026 "status": http_code_value,
1027 "detail": str(e),
1028 }
1029 return self._format_out(problem_details)
1030
1031 @cherrypy.expose
1032 def token(self, method, token_id=None, kwargs=None):
1033 token_info = None
1034 # self.engine.load_dbase(cherrypy.request.app.config)
1035 indata = self._format_in(kwargs)
1036 if not isinstance(indata, dict):
1037 raise NbiException(
1038 "Expected application/yaml or application/json Content-Type",
1039 HTTPStatus.BAD_REQUEST,
1040 )
1041
1042 if method == "GET":
1043 token_info = self.authenticator.authorize()
1044 # for logging
1045 self._format_login(token_info)
1046 if token_id:
1047 outdata = self.authenticator.get_token(token_info, token_id)
1048 else:
1049 outdata = self.authenticator.get_token_list(token_info)
1050 elif method == "POST":
1051 try:
1052 token_info = self.authenticator.authorize()
1053 except Exception:
1054 token_info = None
1055 if kwargs:
1056 indata.update(kwargs)
1057 # This is needed to log the user when authentication fails
1058 cherrypy.request.login = "{}".format(indata.get("username", "-"))
1059 outdata = token_info = self.authenticator.new_token(
1060 token_info, indata, cherrypy.request.remote
1061 )
1062 cherrypy.session["Authorization"] = outdata["_id"] # pylint: disable=E1101
1063 self._set_location_header("admin", "v1", "tokens", outdata["_id"])
1064 # for logging
1065 self._format_login(token_info)
1066 # password expiry check
1067 if self.authenticator.check_password_expiry(outdata):
1068 outdata = {
1069 "id": outdata["id"],
1070 "message": "change_password",
1071 "user_id": outdata["user_id"],
1072 }
1073 # cherrypy.response.cookie["Authorization"] = outdata["id"]
1074 # cherrypy.response.cookie["Authorization"]['expires'] = 3600
1075 cef_event(
1076 cef_logger,
1077 {
1078 "name": "User Login",
1079 "sourceUserName": token_info.get("username"),
1080 "message": "User Logged In, Project={} Outcome=Success".format(
1081 token_info.get("project_name")
1082 ),
1083 },
1084 )
1085 cherrypy.log("{}".format(cef_logger))
1086 elif method == "DELETE":
1087 if not token_id and "id" in kwargs:
1088 token_id = kwargs["id"]
1089 elif not token_id:
1090 token_info = self.authenticator.authorize()
1091 # for logging
1092 self._format_login(token_info)
1093 token_id = token_info["_id"]
1094 if current_backend != "keystone":
1095 token_details = self.engine.db.get_one("tokens", {"_id": token_id})
1096 current_user = token_details.get("username")
1097 current_project = token_details.get("project_name")
1098 else:
1099 current_user = "keystone backend"
1100 current_project = "keystone backend"
1101 outdata = self.authenticator.del_token(token_id)
1102 token_info = None
1103 cherrypy.session["Authorization"] = "logout" # pylint: disable=E1101
1104 cef_event(
1105 cef_logger,
1106 {
1107 "name": "User Logout",
1108 "sourceUserName": current_user,
1109 "message": "User Logged Out, Project={} Outcome=Success".format(
1110 current_project
1111 ),
1112 },
1113 )
1114 cherrypy.log("{}".format(cef_logger))
1115 # cherrypy.response.cookie["Authorization"] = token_id
1116 # cherrypy.response.cookie["Authorization"]['expires'] = 0
1117 else:
1118 raise NbiException(
1119 "Method {} not allowed for token".format(method),
1120 HTTPStatus.METHOD_NOT_ALLOWED,
1121 )
1122 return self._format_out(outdata, token_info)
1123
1124 @cherrypy.expose
1125 def test(self, *args, **kwargs):
1126 if not cherrypy.config.get("server.enable_test") or (
1127 isinstance(cherrypy.config["server.enable_test"], str)
1128 and cherrypy.config["server.enable_test"].lower() == "false"
1129 ):
1130 cherrypy.response.status = HTTPStatus.METHOD_NOT_ALLOWED.value
1131 return "test URL is disabled"
1132 thread_info = None
1133 if args and args[0] == "help":
1134 return (
1135 "<html><pre>\ninit\nfile/<name> download file\ndb-clear/table\nfs-clear[/folder]\nlogin\nlogin2\n"
1136 "sleep/<time>\nmessage/topic\n</pre></html>"
1137 )
1138
1139 elif args and args[0] == "init":
1140 try:
1141 # self.engine.load_dbase(cherrypy.request.app.config)
1142 pid = self.authenticator.create_admin_project()
1143 self.authenticator.create_admin_user(pid)
1144 return "Done. User 'admin', password 'admin' created"
1145 except Exception:
1146 cherrypy.response.status = HTTPStatus.FORBIDDEN.value
1147 return self._format_out("Database already initialized")
1148 elif args and args[0] == "file":
1149 return cherrypy.lib.static.serve_file(
1150 cherrypy.tree.apps["/osm"].config["storage"]["path"] + "/" + args[1],
1151 "text/plain",
1152 "attachment",
1153 )
1154 elif args and args[0] == "file2":
1155 f_path = (
1156 cherrypy.tree.apps["/osm"].config["storage"]["path"] + "/" + args[1]
1157 )
1158 f = open(f_path, "r")
1159 cherrypy.response.headers["Content-type"] = "text/plain"
1160 return f
1161
1162 elif len(args) == 2 and args[0] == "db-clear":
1163 deleted_info = self.engine.db.del_list(args[1], kwargs)
1164 return "{} {} deleted\n".format(deleted_info["deleted"], args[1])
1165 elif len(args) and args[0] == "fs-clear":
1166 if len(args) >= 2:
1167 folders = (args[1],)
1168 else:
1169 folders = self.engine.fs.dir_ls(".")
1170 for folder in folders:
1171 self.engine.fs.file_delete(folder)
1172 return ",".join(folders) + " folders deleted\n"
1173 elif args and args[0] == "login":
1174 if not cherrypy.request.headers.get("Authorization"):
1175 cherrypy.response.headers[
1176 "WWW-Authenticate"
1177 ] = 'Basic realm="Access to OSM site", charset="UTF-8"'
1178 cherrypy.response.status = HTTPStatus.UNAUTHORIZED.value
1179 elif args and args[0] == "login2":
1180 if not cherrypy.request.headers.get("Authorization"):
1181 cherrypy.response.headers[
1182 "WWW-Authenticate"
1183 ] = 'Bearer realm="Access to OSM site"'
1184 cherrypy.response.status = HTTPStatus.UNAUTHORIZED.value
1185 elif args and args[0] == "sleep":
1186 sleep_time = 5
1187 try:
1188 sleep_time = int(args[1])
1189 except Exception:
1190 cherrypy.response.status = HTTPStatus.FORBIDDEN.value
1191 return self._format_out("Database already initialized")
1192 thread_info = cherrypy.thread_data
1193 print(thread_info)
1194 time.sleep(sleep_time)
1195 # thread_info
1196 elif len(args) >= 2 and args[0] == "message":
1197 main_topic = args[1]
1198 return_text = "<html><pre>{} ->\n".format(main_topic)
1199 try:
1200 if cherrypy.request.method == "POST":
1201 to_send = yaml.safe_load(cherrypy.request.body)
1202 for k, v in to_send.items():
1203 self.engine.msg.write(main_topic, k, v)
1204 return_text += " {}: {}\n".format(k, v)
1205 elif cherrypy.request.method == "GET":
1206 for k, v in kwargs.items():
1207 v_dict = yaml.safe_load(v)
1208 self.engine.msg.write(main_topic, k, v_dict)
1209 return_text += " {}: {}\n".format(k, v_dict)
1210 except Exception as e:
1211 return_text += "Error: " + str(e)
1212 return_text += "</pre></html>\n"
1213 return return_text
1214
1215 return_text = (
1216 "<html><pre>\nheaders:\n args: {}\n".format(args)
1217 + " kwargs: {}\n".format(kwargs)
1218 + " headers: {}\n".format(cherrypy.request.headers)
1219 + " path_info: {}\n".format(cherrypy.request.path_info)
1220 + " query_string: {}\n".format(cherrypy.request.query_string)
1221 + " session: {}\n".format(cherrypy.session) # pylint: disable=E1101
1222 + " cookie: {}\n".format(cherrypy.request.cookie)
1223 + " method: {}\n".format(cherrypy.request.method)
1224 + " session: {}\n".format(
1225 cherrypy.session.get("fieldname") # pylint: disable=E1101
1226 )
1227 + " body:\n"
1228 )
1229 return_text += " length: {}\n".format(cherrypy.request.body.length)
1230 if cherrypy.request.body.length:
1231 return_text += " content: {}\n".format(
1232 str(
1233 cherrypy.request.body.read(
1234 int(cherrypy.request.headers.get("Content-Length", 0))
1235 )
1236 )
1237 )
1238 if thread_info:
1239 return_text += "thread: {}\n".format(thread_info)
1240 return_text += "</pre></html>"
1241 return return_text
1242
1243 @staticmethod
1244 def _check_valid_url_method(method, *args):
1245 if len(args) < 3:
1246 raise NbiException(
1247 "URL must contain at least 'main_topic/version/topic'",
1248 HTTPStatus.METHOD_NOT_ALLOWED,
1249 )
1250
1251 reference = valid_url_methods
1252 for arg in args:
1253 if arg is None:
1254 break
1255 if not isinstance(reference, dict):
1256 raise NbiException(
1257 "URL contains unexpected extra items '{}'".format(arg),
1258 HTTPStatus.METHOD_NOT_ALLOWED,
1259 )
1260
1261 if arg in reference:
1262 reference = reference[arg]
1263 elif "<ID>" in reference:
1264 reference = reference["<ID>"]
1265 elif "*" in reference:
1266 # if there is content
1267 if reference["*"]:
1268 reference = reference["*"]
1269 break
1270 else:
1271 raise NbiException(
1272 "Unexpected URL item {}".format(arg), HTTPStatus.METHOD_NOT_ALLOWED
1273 )
1274 if "TODO" in reference and method in reference["TODO"]:
1275 raise NbiException(
1276 "Method {} not supported yet for this URL".format(method),
1277 HTTPStatus.NOT_IMPLEMENTED,
1278 )
1279 elif "METHODS" in reference and method not in reference["METHODS"]:
1280 raise NbiException(
1281 "Method {} not supported for this URL".format(method),
1282 HTTPStatus.METHOD_NOT_ALLOWED,
1283 )
1284 return reference["ROLE_PERMISSION"] + method.lower()
1285
1286 @staticmethod
1287 def _set_location_header(main_topic, version, topic, id):
1288 """
1289 Insert response header Location with the URL of created item base on URL params
1290 :param main_topic:
1291 :param version:
1292 :param topic:
1293 :param id:
1294 :return: None
1295 """
1296 # Use cherrypy.request.base for absoluted path and make use of request.header HOST just in case behind aNAT
1297 cherrypy.response.headers["Location"] = "/osm/{}/{}/{}/{}".format(
1298 main_topic, version, topic, id
1299 )
1300 return
1301
1302 @staticmethod
1303 def _extract_query_string_operations(kwargs, method):
1304 """
1305
1306 :param kwargs:
1307 :return:
1308 """
1309 query_string_operations = []
1310 if kwargs:
1311 for qs in ("FORCE", "PUBLIC", "ADMIN", "SET_PROJECT"):
1312 if qs in kwargs and kwargs[qs].lower() != "false":
1313 query_string_operations.append(qs.lower() + ":" + method.lower())
1314 return query_string_operations
1315
1316 @staticmethod
1317 def _manage_admin_query(token_info, kwargs, method, _id):
1318 """
1319 Processes the administrator query inputs (if any) of FORCE, ADMIN, PUBLIC, SET_PROJECT
1320 Check that users has rights to use them and returs the admin_query
1321 :param token_info: token_info rights obtained by token
1322 :param kwargs: query string input.
1323 :param method: http method: GET, POSST, PUT, ...
1324 :param _id:
1325 :return: admin_query dictionary with keys:
1326 public: True, False or None
1327 force: True or False
1328 project_id: tuple with projects used for accessing an element
1329 set_project: tuple with projects that a created element will belong to
1330 method: show, list, delete, write
1331 """
1332 admin_query = {
1333 "force": False,
1334 "project_id": (token_info["project_id"],),
1335 "username": token_info["username"],
1336 "admin": token_info["admin"],
1337 "public": None,
1338 "allow_show_user_project_role": token_info["allow_show_user_project_role"],
1339 }
1340 if kwargs:
1341 # FORCE
1342 if "FORCE" in kwargs:
1343 if (
1344 kwargs["FORCE"].lower() != "false"
1345 ): # if None or True set force to True
1346 admin_query["force"] = True
1347 del kwargs["FORCE"]
1348 # PUBLIC
1349 if "PUBLIC" in kwargs:
1350 if (
1351 kwargs["PUBLIC"].lower() != "false"
1352 ): # if None or True set public to True
1353 admin_query["public"] = True
1354 else:
1355 admin_query["public"] = False
1356 del kwargs["PUBLIC"]
1357 # ADMIN
1358 if "ADMIN" in kwargs:
1359 behave_as = kwargs.pop("ADMIN")
1360 if behave_as.lower() != "false":
1361 if not token_info["admin"]:
1362 raise NbiException(
1363 "Only admin projects can use 'ADMIN' query string",
1364 HTTPStatus.UNAUTHORIZED,
1365 )
1366 if (
1367 not behave_as or behave_as.lower() == "true"
1368 ): # convert True, None to empty list
1369 admin_query["project_id"] = ()
1370 elif isinstance(behave_as, (list, tuple)):
1371 admin_query["project_id"] = behave_as
1372 else: # isinstance(behave_as, str)
1373 admin_query["project_id"] = (behave_as,)
1374 if "SET_PROJECT" in kwargs:
1375 set_project = kwargs.pop("SET_PROJECT")
1376 if not set_project:
1377 admin_query["set_project"] = list(admin_query["project_id"])
1378 else:
1379 if isinstance(set_project, str):
1380 set_project = (set_project,)
1381 if admin_query["project_id"]:
1382 for p in set_project:
1383 if p not in admin_query["project_id"]:
1384 raise NbiException(
1385 "Unauthorized for 'SET_PROJECT={p}'. Try with 'ADMIN=True' or "
1386 "'ADMIN='{p}'".format(p=p),
1387 HTTPStatus.UNAUTHORIZED,
1388 )
1389 admin_query["set_project"] = set_project
1390
1391 # PROJECT_READ
1392 # if "PROJECT_READ" in kwargs:
1393 # admin_query["project"] = kwargs.pop("project")
1394 # if admin_query["project"] == token_info["project_id"]:
1395 if method == "GET":
1396 if _id:
1397 admin_query["method"] = "show"
1398 else:
1399 admin_query["method"] = "list"
1400 elif method == "DELETE":
1401 admin_query["method"] = "delete"
1402 else:
1403 admin_query["method"] = "write"
1404 return admin_query
1405
1406 @cherrypy.expose
1407 def default(
1408 self,
1409 main_topic=None,
1410 version=None,
1411 topic=None,
1412 _id=None,
1413 item=None,
1414 *args,
1415 **kwargs
1416 ):
1417 token_info = None
1418 outdata = {}
1419 _format = None
1420 method = "DONE"
1421 engine_topic = None
1422 rollback = []
1423 engine_session = None
1424 url_id = ""
1425 log_mapping = {
1426 "POST": "Creating",
1427 "GET": "Fetching",
1428 "DELETE": "Deleting",
1429 "PUT": "Updating",
1430 "PATCH": "Updating",
1431 }
1432 try:
1433 if not main_topic or not version or not topic:
1434 raise NbiException(
1435 "URL must contain at least 'main_topic/version/topic'",
1436 HTTPStatus.METHOD_NOT_ALLOWED,
1437 )
1438 if main_topic not in (
1439 "admin",
1440 "vnfpkgm",
1441 "nsd",
1442 "nslcm",
1443 "pdu",
1444 "nst",
1445 "nsilcm",
1446 "nspm",
1447 "vnflcm",
1448 ):
1449 raise NbiException(
1450 "URL main_topic '{}' not supported".format(main_topic),
1451 HTTPStatus.METHOD_NOT_ALLOWED,
1452 )
1453 if version != "v1":
1454 raise NbiException(
1455 "URL version '{}' not supported".format(version),
1456 HTTPStatus.METHOD_NOT_ALLOWED,
1457 )
1458 if _id is not None:
1459 url_id = _id
1460
1461 if (
1462 kwargs
1463 and "METHOD" in kwargs
1464 and kwargs["METHOD"] in ("PUT", "POST", "DELETE", "GET", "PATCH")
1465 ):
1466 method = kwargs.pop("METHOD")
1467 else:
1468 method = cherrypy.request.method
1469
1470 role_permission = self._check_valid_url_method(
1471 method, main_topic, version, topic, _id, item, *args
1472 )
1473 query_string_operations = self._extract_query_string_operations(
1474 kwargs, method
1475 )
1476 if main_topic == "admin" and topic == "tokens":
1477 return self.token(method, _id, kwargs)
1478 token_info = self.authenticator.authorize(
1479 role_permission, query_string_operations, _id
1480 )
1481 if main_topic == "admin" and topic == "domains":
1482 return self.domain()
1483 engine_session = self._manage_admin_query(token_info, kwargs, method, _id)
1484 indata = self._format_in(kwargs)
1485 engine_topic = topic
1486
1487 if item and topic != "pm_jobs":
1488 engine_topic = item
1489
1490 if main_topic == "nsd":
1491 engine_topic = "nsds"
1492 elif main_topic == "vnfpkgm":
1493 engine_topic = "vnfds"
1494 if topic == "vnfpkg_op_occs":
1495 engine_topic = "vnfpkgops"
1496 if topic == "vnf_packages" and item == "action":
1497 engine_topic = "vnfpkgops"
1498 elif main_topic == "nslcm":
1499 engine_topic = "nsrs"
1500 if topic == "ns_lcm_op_occs":
1501 engine_topic = "nslcmops"
1502 if topic == "vnfrs" or topic == "vnf_instances":
1503 engine_topic = "vnfrs"
1504 elif main_topic == "vnflcm":
1505 if topic == "vnf_lcm_op_occs":
1506 engine_topic = "vnflcmops"
1507 elif main_topic == "nst":
1508 engine_topic = "nsts"
1509 elif main_topic == "nsilcm":
1510 engine_topic = "nsis"
1511 if topic == "nsi_lcm_op_occs":
1512 engine_topic = "nsilcmops"
1513 elif main_topic == "pdu":
1514 engine_topic = "pdus"
1515 if (
1516 engine_topic == "vims"
1517 ): # TODO this is for backward compatibility, it will be removed in the future
1518 engine_topic = "vim_accounts"
1519
1520 if topic == "subscriptions":
1521 engine_topic = main_topic + "_" + topic
1522
1523 if method == "GET":
1524 if item in (
1525 "nsd_content",
1526 "package_content",
1527 "artifacts",
1528 "vnfd",
1529 "nsd",
1530 "nst",
1531 "nst_content",
1532 ):
1533 if item in ("vnfd", "nsd", "nst"):
1534 path = "$DESCRIPTOR"
1535 elif args:
1536 path = args
1537 elif item == "artifacts":
1538 path = ()
1539 else:
1540 path = None
1541 file, _format = self.engine.get_file(
1542 engine_session,
1543 engine_topic,
1544 _id,
1545 path,
1546 cherrypy.request.headers.get("Accept"),
1547 )
1548 outdata = file
1549 elif not _id:
1550 outdata = self.engine.get_item_list(
1551 engine_session, engine_topic, kwargs, api_req=True
1552 )
1553 else:
1554 if item == "reports":
1555 # TODO check that project_id (_id in this context) has permissions
1556 _id = args[0]
1557 filter_q = None
1558 if "vcaStatusRefresh" in kwargs:
1559 filter_q = {"vcaStatusRefresh": kwargs["vcaStatusRefresh"]}
1560 outdata = self.engine.get_item(
1561 engine_session, engine_topic, _id, filter_q, True
1562 )
1563
1564 elif method == "POST":
1565 cherrypy.response.status = HTTPStatus.CREATED.value
1566 if topic in (
1567 "ns_descriptors_content",
1568 "vnf_packages_content",
1569 "netslice_templates_content",
1570 ):
1571 _id = cherrypy.request.headers.get("Transaction-Id")
1572 if not _id:
1573 _id, _ = self.engine.new_item(
1574 rollback,
1575 engine_session,
1576 engine_topic,
1577 {},
1578 None,
1579 cherrypy.request.headers,
1580 )
1581 completed = self.engine.upload_content(
1582 engine_session,
1583 engine_topic,
1584 _id,
1585 indata,
1586 kwargs,
1587 cherrypy.request.headers,
1588 )
1589 if completed:
1590 self._set_location_header(main_topic, version, topic, _id)
1591 else:
1592 cherrypy.response.headers["Transaction-Id"] = _id
1593 outdata = {"id": _id}
1594 elif topic == "ns_instances_content":
1595 # creates NSR
1596 _id, _ = self.engine.new_item(
1597 rollback, engine_session, engine_topic, indata, kwargs
1598 )
1599 # creates nslcmop
1600 indata["lcmOperationType"] = "instantiate"
1601 indata["nsInstanceId"] = _id
1602 nslcmop_id, _ = self.engine.new_item(
1603 rollback, engine_session, "nslcmops", indata, None
1604 )
1605 self._set_location_header(main_topic, version, topic, _id)
1606 outdata = {"id": _id, "nslcmop_id": nslcmop_id}
1607 elif topic == "ns_instances" and item:
1608 indata["lcmOperationType"] = item
1609 indata["nsInstanceId"] = _id
1610 _id, _ = self.engine.new_item(
1611 rollback, engine_session, "nslcmops", indata, kwargs
1612 )
1613 self._set_location_header(
1614 main_topic, version, "ns_lcm_op_occs", _id
1615 )
1616 outdata = {"id": _id}
1617 cherrypy.response.status = HTTPStatus.ACCEPTED.value
1618 elif topic == "netslice_instances_content":
1619 # creates NetSlice_Instance_record (NSIR)
1620 _id, _ = self.engine.new_item(
1621 rollback, engine_session, engine_topic, indata, kwargs
1622 )
1623 self._set_location_header(main_topic, version, topic, _id)
1624 indata["lcmOperationType"] = "instantiate"
1625 indata["netsliceInstanceId"] = _id
1626 nsilcmop_id, _ = self.engine.new_item(
1627 rollback, engine_session, "nsilcmops", indata, kwargs
1628 )
1629 outdata = {"id": _id, "nsilcmop_id": nsilcmop_id}
1630 elif topic == "netslice_instances" and item:
1631 indata["lcmOperationType"] = item
1632 indata["netsliceInstanceId"] = _id
1633 _id, _ = self.engine.new_item(
1634 rollback, engine_session, "nsilcmops", indata, kwargs
1635 )
1636 self._set_location_header(
1637 main_topic, version, "nsi_lcm_op_occs", _id
1638 )
1639 outdata = {"id": _id}
1640 cherrypy.response.status = HTTPStatus.ACCEPTED.value
1641 elif topic == "vnf_packages" and item == "action":
1642 indata["lcmOperationType"] = item
1643 indata["vnfPkgId"] = _id
1644 _id, _ = self.engine.new_item(
1645 rollback, engine_session, "vnfpkgops", indata, kwargs
1646 )
1647 self._set_location_header(
1648 main_topic, version, "vnfpkg_op_occs", _id
1649 )
1650 outdata = {"id": _id}
1651 cherrypy.response.status = HTTPStatus.ACCEPTED.value
1652 elif topic == "subscriptions":
1653 _id, _ = self.engine.new_item(
1654 rollback, engine_session, engine_topic, indata, kwargs
1655 )
1656 self._set_location_header(main_topic, version, topic, _id)
1657 link = {}
1658 link["self"] = cherrypy.response.headers["Location"]
1659 outdata = {
1660 "id": _id,
1661 "filter": indata["filter"],
1662 "callbackUri": indata["CallbackUri"],
1663 "_links": link,
1664 }
1665 cherrypy.response.status = HTTPStatus.CREATED.value
1666 elif topic == "vnf_instances" and item:
1667 indata["lcmOperationType"] = item
1668 indata["vnfInstanceId"] = _id
1669 _id, _ = self.engine.new_item(
1670 rollback, engine_session, "vnflcmops", indata, kwargs
1671 )
1672 self._set_location_header(
1673 main_topic, version, "vnf_lcm_op_occs", _id
1674 )
1675 outdata = {"id": _id}
1676 cherrypy.response.status = HTTPStatus.ACCEPTED.value
1677 else:
1678 _id, op_id = self.engine.new_item(
1679 rollback,
1680 engine_session,
1681 engine_topic,
1682 indata,
1683 kwargs,
1684 cherrypy.request.headers,
1685 )
1686 self._set_location_header(main_topic, version, topic, _id)
1687 outdata = {"id": _id}
1688 if op_id:
1689 outdata["op_id"] = op_id
1690 cherrypy.response.status = HTTPStatus.ACCEPTED.value
1691 # TODO form NsdInfo when topic in ("ns_descriptors", "vnf_packages")
1692
1693 elif method == "DELETE":
1694 if not _id:
1695 outdata = self.engine.del_item_list(
1696 engine_session, engine_topic, kwargs
1697 )
1698 cherrypy.response.status = HTTPStatus.OK.value
1699 else: # len(args) > 1
1700 # for NS NSI generate an operation
1701 op_id = None
1702 if topic == "ns_instances_content" and not engine_session["force"]:
1703 nslcmop_desc = {
1704 "lcmOperationType": "terminate",
1705 "nsInstanceId": _id,
1706 "autoremove": True,
1707 }
1708 op_id, _ = self.engine.new_item(
1709 rollback, engine_session, "nslcmops", nslcmop_desc, kwargs
1710 )
1711 if op_id:
1712 outdata = {"_id": op_id}
1713 elif (
1714 topic == "netslice_instances_content"
1715 and not engine_session["force"]
1716 ):
1717 nsilcmop_desc = {
1718 "lcmOperationType": "terminate",
1719 "netsliceInstanceId": _id,
1720 "autoremove": True,
1721 }
1722 op_id, _ = self.engine.new_item(
1723 rollback, engine_session, "nsilcmops", nsilcmop_desc, None
1724 )
1725 if op_id:
1726 outdata = {"_id": op_id}
1727 # if there is not any deletion in process, delete
1728 if not op_id:
1729 op_id = self.engine.del_item(engine_session, engine_topic, _id)
1730 if op_id:
1731 outdata = {"op_id": op_id}
1732 cherrypy.response.status = (
1733 HTTPStatus.ACCEPTED.value
1734 if op_id
1735 else HTTPStatus.NO_CONTENT.value
1736 )
1737
1738 elif method in ("PUT", "PATCH"):
1739 op_id = None
1740 if not indata and not kwargs and not engine_session.get("set_project"):
1741 raise NbiException(
1742 "Nothing to update. Provide payload and/or query string",
1743 HTTPStatus.BAD_REQUEST,
1744 )
1745 if (
1746 item in ("nsd_content", "package_content", "nst_content")
1747 and method == "PUT"
1748 ):
1749 completed = self.engine.upload_content(
1750 engine_session,
1751 engine_topic,
1752 _id,
1753 indata,
1754 kwargs,
1755 cherrypy.request.headers,
1756 )
1757 if not completed:
1758 cherrypy.response.headers["Transaction-Id"] = id
1759 else:
1760 op_id = self.engine.edit_item(
1761 engine_session, engine_topic, _id, indata, kwargs
1762 )
1763
1764 if op_id:
1765 cherrypy.response.status = HTTPStatus.ACCEPTED.value
1766 outdata = {"op_id": op_id}
1767 else:
1768 cherrypy.response.status = HTTPStatus.NO_CONTENT.value
1769 outdata = None
1770 else:
1771 raise NbiException(
1772 "Method {} not allowed".format(method),
1773 HTTPStatus.METHOD_NOT_ALLOWED,
1774 )
1775
1776 # if Role information changes, it is needed to reload the information of roles
1777 if topic == "roles" and method != "GET":
1778 self.authenticator.load_operation_to_allowed_roles()
1779
1780 if (
1781 topic == "projects"
1782 and method == "DELETE"
1783 or topic in ["users", "roles"]
1784 and method in ["PUT", "PATCH", "DELETE"]
1785 ):
1786 self.authenticator.remove_token_from_cache()
1787
1788 if item is not None:
1789 cef_event(
1790 cef_logger,
1791 {
1792 "name": "User Operation",
1793 "sourceUserName": token_info.get("username"),
1794 "message": "Performing {} operation on {} {}, Project={} Outcome=Success".format(
1795 item,
1796 topic,
1797 url_id,
1798 token_info.get("project_name"),
1799 ),
1800 },
1801 )
1802 cherrypy.log("{}".format(cef_logger))
1803 else:
1804 cef_event(
1805 cef_logger,
1806 {
1807 "name": "User Operation",
1808 "sourceUserName": token_info.get("username"),
1809 "message": "{} {} {}, Project={} Outcome=Success".format(
1810 log_mapping[method],
1811 topic,
1812 url_id,
1813 token_info.get("project_name"),
1814 ),
1815 },
1816 )
1817 cherrypy.log("{}".format(cef_logger))
1818 return self._format_out(outdata, token_info, _format)
1819 except Exception as e:
1820 if isinstance(
1821 e,
1822 (
1823 NbiException,
1824 EngineException,
1825 DbException,
1826 FsException,
1827 MsgException,
1828 AuthException,
1829 ValidationError,
1830 AuthconnException,
1831 ),
1832 ):
1833 http_code_value = cherrypy.response.status = e.http_code.value
1834 http_code_name = e.http_code.name
1835 cherrypy.log("Exception {}".format(e))
1836 else:
1837 http_code_value = (
1838 cherrypy.response.status
1839 ) = HTTPStatus.BAD_REQUEST.value # INTERNAL_SERVER_ERROR
1840 cherrypy.log("CRITICAL: Exception {}".format(e), traceback=True)
1841 http_code_name = HTTPStatus.BAD_REQUEST.name
1842 if hasattr(outdata, "close"): # is an open file
1843 outdata.close()
1844 error_text = str(e)
1845 rollback.reverse()
1846 for rollback_item in rollback:
1847 try:
1848 if rollback_item.get("operation") == "set":
1849 self.engine.db.set_one(
1850 rollback_item["topic"],
1851 {"_id": rollback_item["_id"]},
1852 rollback_item["content"],
1853 fail_on_empty=False,
1854 )
1855 elif rollback_item.get("operation") == "del_list":
1856 self.engine.db.del_list(
1857 rollback_item["topic"],
1858 rollback_item["filter"],
1859 )
1860 else:
1861 self.engine.db.del_one(
1862 rollback_item["topic"],
1863 {"_id": rollback_item["_id"]},
1864 fail_on_empty=False,
1865 )
1866 except Exception as e2:
1867 rollback_error_text = "Rollback Exception {}: {}".format(
1868 rollback_item, e2
1869 )
1870 cherrypy.log(rollback_error_text)
1871 error_text += ". " + rollback_error_text
1872 # if isinstance(e, MsgException):
1873 # error_text = "{} has been '{}' but other modules cannot be informed because an error on bus".format(
1874 # engine_topic[:-1], method, error_text)
1875 problem_details = {
1876 "code": http_code_name,
1877 "status": http_code_value,
1878 "detail": error_text,
1879 }
1880 if item is not None and token_info is not None:
1881 cef_event(
1882 cef_logger,
1883 {
1884 "name": "User Operation",
1885 "sourceUserName": token_info.get("username", None),
1886 "message": "Performing {} operation on {} {}, Project={} Outcome=Failure".format(
1887 item,
1888 topic,
1889 url_id,
1890 token_info.get("project_name", None),
1891 ),
1892 "severity": "2",
1893 },
1894 )
1895 cherrypy.log("{}".format(cef_logger))
1896 elif token_info is not None:
1897 cef_event(
1898 cef_logger,
1899 {
1900 "name": "User Operation",
1901 "sourceUserName": token_info.get("username", None),
1902 "message": "{} {} {}, Project={} Outcome=Failure".format(
1903 item,
1904 topic,
1905 url_id,
1906 token_info.get("project_name", None),
1907 ),
1908 "severity": "2",
1909 },
1910 )
1911 cherrypy.log("{}".format(cef_logger))
1912 return self._format_out(problem_details, token_info)
1913 # raise cherrypy.HTTPError(e.http_code.value, str(e))
1914 finally:
1915 if token_info:
1916 self._format_login(token_info)
1917 if method in ("PUT", "PATCH", "POST") and isinstance(outdata, dict):
1918 for logging_id in ("id", "op_id", "nsilcmop_id", "nslcmop_id"):
1919 if outdata.get(logging_id):
1920 cherrypy.request.login += ";{}={}".format(
1921 logging_id, outdata[logging_id][:36]
1922 )
1923
1924
1925 def _start_service():
1926 """
1927 Callback function called when cherrypy.engine starts
1928 Override configuration with env variables
1929 Set database, storage, message configuration
1930 Init database with admin/admin user password
1931 """
1932 global nbi_server
1933 global subscription_thread
1934 global cef_logger
1935 global current_backend
1936 cherrypy.log.error("Starting osm_nbi")
1937 # update general cherrypy configuration
1938 update_dict = {}
1939
1940 engine_config = cherrypy.tree.apps["/osm"].config
1941 for k, v in environ.items():
1942 if k == "OSMNBI_USER_MANAGEMENT":
1943 feature_state = eval(v.title())
1944 engine_config["authentication"]["user_management"] = feature_state
1945 if not k.startswith("OSMNBI_"):
1946 continue
1947 k1, _, k2 = k[7:].lower().partition("_")
1948 if not k2:
1949 continue
1950 try:
1951 # update static configuration
1952 if k == "OSMNBI_STATIC_DIR":
1953 engine_config["/static"]["tools.staticdir.dir"] = v
1954 engine_config["/static"]["tools.staticdir.on"] = True
1955 elif k == "OSMNBI_SOCKET_PORT" or k == "OSMNBI_SERVER_PORT":
1956 update_dict["server.socket_port"] = int(v)
1957 elif k == "OSMNBI_SOCKET_HOST" or k == "OSMNBI_SERVER_HOST":
1958 update_dict["server.socket_host"] = v
1959 elif k1 in ("server", "test", "auth", "log"):
1960 update_dict[k1 + "." + k2] = v
1961 elif k1 in ("message", "database", "storage", "authentication"):
1962 # k2 = k2.replace('_', '.')
1963 if k2 in ("port", "db_port"):
1964 engine_config[k1][k2] = int(v)
1965 else:
1966 engine_config[k1][k2] = v
1967
1968 except ValueError as e:
1969 cherrypy.log.error("Ignoring environ '{}': " + str(e))
1970 except Exception as e:
1971 cherrypy.log(
1972 "WARNING: skipping environ '{}' on exception '{}'".format(k, e)
1973 )
1974
1975 if update_dict:
1976 cherrypy.config.update(update_dict)
1977 engine_config["global"].update(update_dict)
1978
1979 # logging cherrypy
1980 log_format_simple = (
1981 "%(asctime)s %(levelname)s %(name)s %(filename)s:%(lineno)s %(message)s"
1982 )
1983 log_formatter_simple = logging.Formatter(
1984 log_format_simple, datefmt="%Y-%m-%dT%H:%M:%S"
1985 )
1986 logger_server = logging.getLogger("cherrypy.error")
1987 logger_access = logging.getLogger("cherrypy.access")
1988 logger_cherry = logging.getLogger("cherrypy")
1989 logger_nbi = logging.getLogger("nbi")
1990
1991 if "log.file" in engine_config["global"]:
1992 file_handler = logging.handlers.RotatingFileHandler(
1993 engine_config["global"]["log.file"], maxBytes=100e6, backupCount=9, delay=0
1994 )
1995 file_handler.setFormatter(log_formatter_simple)
1996 logger_cherry.addHandler(file_handler)
1997 logger_nbi.addHandler(file_handler)
1998 # log always to standard output
1999 for format_, logger in {
2000 "nbi.server %(filename)s:%(lineno)s": logger_server,
2001 "nbi.access %(filename)s:%(lineno)s": logger_access,
2002 "%(name)s %(filename)s:%(lineno)s": logger_nbi,
2003 }.items():
2004 log_format_cherry = "%(asctime)s %(levelname)s {} %(message)s".format(format_)
2005 log_formatter_cherry = logging.Formatter(
2006 log_format_cherry, datefmt="%Y-%m-%dT%H:%M:%S"
2007 )
2008 str_handler = logging.StreamHandler()
2009 str_handler.setFormatter(log_formatter_cherry)
2010 logger.addHandler(str_handler)
2011
2012 if engine_config["global"].get("log.level"):
2013 logger_cherry.setLevel(engine_config["global"]["log.level"])
2014 logger_nbi.setLevel(engine_config["global"]["log.level"])
2015
2016 # logging other modules
2017 for k1, logname in {
2018 "message": "nbi.msg",
2019 "database": "nbi.db",
2020 "storage": "nbi.fs",
2021 }.items():
2022 engine_config[k1]["logger_name"] = logname
2023 logger_module = logging.getLogger(logname)
2024 if "logfile" in engine_config[k1]:
2025 file_handler = logging.handlers.RotatingFileHandler(
2026 engine_config[k1]["logfile"], maxBytes=100e6, backupCount=9, delay=0
2027 )
2028 file_handler.setFormatter(log_formatter_simple)
2029 logger_module.addHandler(file_handler)
2030 if "loglevel" in engine_config[k1]:
2031 logger_module.setLevel(engine_config[k1]["loglevel"])
2032 # TODO add more entries, e.g.: storage
2033 cherrypy.tree.apps["/osm"].root.engine.start(engine_config)
2034 cherrypy.tree.apps["/osm"].root.authenticator.start(engine_config)
2035 cherrypy.tree.apps["/osm"].root.engine.init_db(target_version=database_version)
2036 cherrypy.tree.apps["/osm"].root.authenticator.init_db(
2037 target_version=auth_database_version
2038 )
2039
2040 cef_logger = cef_event_builder(engine_config["authentication"])
2041
2042 # start subscriptions thread:
2043 subscription_thread = SubscriptionThread(
2044 config=engine_config, engine=nbi_server.engine
2045 )
2046 subscription_thread.start()
2047 # Do not capture except SubscriptionException
2048
2049 backend = engine_config["authentication"]["backend"]
2050 current_backend = backend
2051 cherrypy.log.error(
2052 "Starting OSM NBI Version '{} {}' with '{}' authentication backend".format(
2053 nbi_version, nbi_version_date, backend
2054 )
2055 )
2056
2057
2058 def _stop_service():
2059 """
2060 Callback function called when cherrypy.engine stops
2061 TODO: Ending database connections.
2062 """
2063 global subscription_thread
2064 if subscription_thread:
2065 subscription_thread.terminate()
2066 subscription_thread = None
2067 cherrypy.tree.apps["/osm"].root.engine.stop()
2068 cherrypy.log.error("Stopping osm_nbi")
2069
2070
2071 def nbi(config_file):
2072 global nbi_server
2073 # conf = {
2074 # '/': {
2075 # #'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
2076 # 'tools.sessions.on': True,
2077 # 'tools.response_headers.on': True,
2078 # # 'tools.response_headers.headers': [('Content-Type', 'text/plain')],
2079 # }
2080 # }
2081 # cherrypy.Server.ssl_module = 'builtin'
2082 # cherrypy.Server.ssl_certificate = "http/cert.pem"
2083 # cherrypy.Server.ssl_private_key = "http/privkey.pem"
2084 # cherrypy.Server.thread_pool = 10
2085 # cherrypy.config.update({'Server.socket_port': config["port"], 'Server.socket_host': config["host"]})
2086
2087 # cherrypy.config.update({'tools.auth_basic.on': True,
2088 # 'tools.auth_basic.realm': 'localhost',
2089 # 'tools.auth_basic.checkpassword': validate_password})
2090 nbi_server = Server()
2091 cherrypy.engine.subscribe("start", _start_service)
2092 cherrypy.engine.subscribe("stop", _stop_service)
2093 cherrypy.quickstart(nbi_server, "/osm", config_file)
2094
2095
2096 def usage():
2097 print(
2098 """Usage: {} [options]
2099 -c|--config [configuration_file]: loads the configuration file (default: ./nbi.cfg)
2100 -h|--help: shows this help
2101 """.format(
2102 sys.argv[0]
2103 )
2104 )
2105 # --log-socket-host HOST: send logs to this host")
2106 # --log-socket-port PORT: send logs using this port (default: 9022)")
2107
2108
2109 if __name__ == "__main__":
2110 try:
2111 # load parameters and configuration
2112 opts, args = getopt.getopt(sys.argv[1:], "hvc:", ["config=", "help"])
2113 # TODO add "log-socket-host=", "log-socket-port=", "log-file="
2114 config_file = None
2115 for o, a in opts:
2116 if o in ("-h", "--help"):
2117 usage()
2118 sys.exit()
2119 elif o in ("-c", "--config"):
2120 config_file = a
2121 # elif o == "--log-socket-port":
2122 # log_socket_port = a
2123 # elif o == "--log-socket-host":
2124 # log_socket_host = a
2125 # elif o == "--log-file":
2126 # log_file = a
2127 else:
2128 assert False, "Unhandled option"
2129 if config_file:
2130 if not path.isfile(config_file):
2131 print(
2132 "configuration file '{}' that not exist".format(config_file),
2133 file=sys.stderr,
2134 )
2135 exit(1)
2136 else:
2137 for config_file in (
2138 __file__[: __file__.rfind(".")] + ".cfg",
2139 "./nbi.cfg",
2140 "/etc/osm/nbi.cfg",
2141 ):
2142 if path.isfile(config_file):
2143 break
2144 else:
2145 print(
2146 "No configuration file 'nbi.cfg' found neither at local folder nor at /etc/osm/",
2147 file=sys.stderr,
2148 )
2149 exit(1)
2150 nbi(config_file)
2151 except getopt.GetoptError as e:
2152 print(str(e), file=sys.stderr)
2153 # usage()
2154 exit(1)