# encoding: utf-8
# This file is part of CycloneDX Python Lib
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
from typing import Optional
from xml.etree import ElementTree
from ..exception.output import BomGenerationErrorException
from ..model.bom import Bom
from ..schema import SchemaVersion
from ..schema.schema import (
SCHEMA_VERSIONS,
BaseSchemaVersion,
SchemaVersion1Dot0,
SchemaVersion1Dot1,
SchemaVersion1Dot2,
SchemaVersion1Dot3,
SchemaVersion1Dot4,
)
from . import BaseOutput
[docs]
class Xml(BaseOutput, BaseSchemaVersion):
[docs]
XML_VERSION_DECLARATION: str = '<?xml version="1.0" encoding="UTF-8"?>'
def __init__(self, bom: Bom) -> None:
super().__init__(bom=bom)
self._root_bom_element: Optional[ElementTree.Element] = None
@property
[docs]
def schema_version(self) -> SchemaVersion:
return self.schema_version_enum
[docs]
def generate(self, force_regeneration: bool = False) -> None:
# New way
_view = SCHEMA_VERSIONS.get(self.get_schema_version())
if self.generated and force_regeneration:
self.get_bom().validate()
self._root_bom_element = self.get_bom().as_xml( # type: ignore
view_=_view, as_string=False, xmlns=self.get_target_namespace()
)
self.generated = True
return
elif self.generated:
return
else:
self.get_bom().validate()
self._root_bom_element = self.get_bom().as_xml( # type: ignore
view_=_view, as_string=False, xmlns=self.get_target_namespace()
)
self.generated = True
return
[docs]
def output_as_string(self) -> str:
self.generate()
if self.generated and self._root_bom_element is not None:
return str(Xml.XML_VERSION_DECLARATION + ElementTree.tostring(self._root_bom_element, encoding='unicode'))
raise BomGenerationErrorException('There was no Root XML Element after BOM generation.')
[docs]
def get_target_namespace(self) -> str:
return f'http://cyclonedx.org/schema/bom/{self.get_schema_version()}'
[docs]
class XmlV1Dot0(Xml, SchemaVersion1Dot0):
[docs]
def _create_bom_element(self) -> ElementTree.Element:
return ElementTree.Element('bom', {'xmlns': self.get_target_namespace(), 'version': '1'})
[docs]
class XmlV1Dot1(Xml, SchemaVersion1Dot1):
pass
[docs]
class XmlV1Dot2(Xml, SchemaVersion1Dot2):
pass
[docs]
class XmlV1Dot3(Xml, SchemaVersion1Dot3):
pass
[docs]
class XmlV1Dot4(Xml, SchemaVersion1Dot4):
pass