farol/farolluz: farolluz/cvrf.py annotate

author	Benoît Allard <benoit.allard@greenbone.net>
date	Tue, 23 Sep 2014 15:19:14 +0200
parents
children	d47e1164740f

rev	line source
0 e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	1 # -- coding: utf-8 --
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	2 #
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	3 # Authors:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	4 # Benoît Allard <benoit.allard@greenbone.net>
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	5 #
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	6 # Copyright:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	7 # Copyright (C) 2014 Greenbone Networks GmbH
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	8 #
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	9 # This program is free software; you can redistribute it and/or
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	10 # modify it under the terms of the GNU General Public License
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	11 # as published by the Free Software Foundation; either version 2
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	12 # of the License, or (at your option) any later version.
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	13 #
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	14 # This program is distributed in the hope that it will be useful,
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	17 # GNU General Public License for more details.
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	18 #
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	19 # You should have received a copy of the GNU General Public License
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	20 # along with this program; if not, write to the Free Software
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	21 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	22
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	23 """\
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	24 Objects related to CVRF Documents
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	25 """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	26
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	27 class ValidationError(Exception): pass
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	28
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	29 class CVRFPublisher(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	30 TYPES = ('Vendor', 'Discoverer', 'Coordinator', 'User', 'Other')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	31 def __init__(self, _type, vendorid=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	32 self._type = _type
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	33 self._vendorid = vendorid
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	34 self._contact = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	35 self._authority = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	36
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	37 def setContact(self, contact):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	38 self._contact = contact
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	39
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	40 def setAuthority(self, authority):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	41 self._authority = authority
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	42
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	43 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	44 if not self._type:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	45 raise ValidationError('Document Publisher needs to have a type')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	46 if self._type not in self.TYPES:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	47 raise ValidationError('Document Publisher Type needs to be one of %s' % ', '.join(self.TYPES))
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	48
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	49 def __str__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	50 s = 'CVRFPublisher: %s' % self._type
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	51 if self._vendorid is not None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	52 s += ' ID: %s' % self._vendorid
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	53 if self._contact is not None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	54 s += ' Contact: "%s"' % self._contact
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	55 if self._authority is not None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	56 s += ' Authority: "%s"' % self._authority
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	57 return s
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	58
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	59
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	60 class CVRFTrackingID(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	61 def __init__(self, _id):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	62 self._id = _id
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	63 self._aliases = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	64
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	65 def addAlias(self, alias):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	66 self._aliases.append(alias)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	67
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	68 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	69 if not self._id:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	70 raise ValidationError('Document ID cannot be left empty')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	71
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	72 def __str__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	73 if self._aliases:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	74 return "%s (%s)" % (self._id, ', '.join(self._aliases))
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	75 return self._id
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	76
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	77
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	78 class CVRFTracking(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	79 STATUSES = ('Draft', 'Interim', 'Final')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	80 def __init__(self, _id, status, version, initial, current):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	81 self._identification = _id
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	82 self._status = status
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	83 self._version = version
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	84 self._history = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	85 self._initialDate = initial
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	86 self._currentDate = current
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	87 self._generator = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	88
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	89 def addRevision(self, revision):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	90 self._history.append(revision)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	91
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	92 def setGenerator(self, generator):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	93 self._generator = generator
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	94
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	95 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	96 if self._identification is None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	97 raise ValidationError('Document Tracking needs to have an Identification')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	98 self._identification.validate()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	99 if not self._status:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	100 raise ValidationError('Document status must be set')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	101 if self._status not in self.STATUSES:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	102 raise ValidationError('Document Status must be one of %s' % ', '.join(self.STATUSES))
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	103 if not self._version:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	104 raise ValidationError('Document Version must be set')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	105 if len(self._version) > 4:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	106 raise ValidationError('Document Version must be comprised between `nn` and `nn.nn.nn.nn`')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	107 if not self._history:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	108 raise ValidationError('Document must have at least a revision')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	109 if not self._initialDate:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	110 raise ValidationError('Document must have an initial Release date set')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	111 prev_date = self._initialDate
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	112 if self._history[0]._date < self._initialDate:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	113 # Documents could have revisions before being released
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	114 prev_date = self._history[0]._date
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	115 prev = ()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	116 for revision in self._history:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	117 revision.validate()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	118 if revision._number <= prev:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	119 raise ValidationError('Revision numbers must always be increasing')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	120 if revision._date < prev_date:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	121 raise ValidationError('Revision dates must always be increasing')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	122 prev = revision._number
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	123 prev_date = revision._date
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	124 if not self._currentDate:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	125 raise ValidationError('Document must have a Current Release Date set')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	126 if self._currentDate != self._history[-1]._date:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	127 raise ValidationError('Current Release Date must be the same as the Date from the last Revision')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	128 if self._initialDate > self._currentDate:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	129 raise ValidationError('Initial date must not be after current Date')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	130 if self._version != self._history[-1]._number:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	131 raise ValidationError('Document version must be the same as the number of the last Revision')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	132
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	133 def __str__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	134 s = "ID: %s" % self._identification
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	135 s += " Status: %s" % self._status
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	136 s += " v%s" % '.'.join('%d' % i for i in self._version)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	137 s += " %d revisions" % len(self._history)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	138 s += " Initial release: %s" % self._initialDate.isoformat()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	139 return s
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	140
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	141
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	142 class CVRFRevision(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	143 def __init__(self, number, date, description):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	144 self._number = number
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	145 self._date = date
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	146 self._description = description
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	147
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	148 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	149 if not self._number:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	150 raise ValidationError('A Revision must have a Number')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	151 if not self._date:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	152 raise ValidationError('A Revision must have a Date')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	153 if not self._description:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	154 raise ValidationError('A Revision must have a Description')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	155
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	156 class CVRFGenerator(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	157 def __init__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	158 self._engine = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	159 self._date = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	160
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	161 def setEngine(self, engine):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	162 self._engine = engine
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	163
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	164 def setDate(self, date):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	165 self._date = date
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	166
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	167 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	168 if (not self._engine) and (not self._date):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	169 raise ValidationError('The Generator must have at least an Engine or a Date')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	170
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	171
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	172 class CVRFNote(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	173 TYPES = ('General', 'Details', 'Description', 'Summary', 'FAQ',
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	174 'Legal Disclaimer', 'Other')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	175 def __init__(self, _type, ordinal, note, title=None, audience=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	176 self._type = _type
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	177 self._ordinal = ordinal
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	178 self._note = note
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	179 self._title = title
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	180 self._audience = audience
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	181
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	182 def getTitle(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	183 """ returns something that can be used as a title """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	184 if self._title is None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	185 return "%s (#%d)" % (self._type, self._ordinal)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	186 return "%s (%s)" % (self._title, self._type)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	187
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	188 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	189 if not self._type:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	190 raise ValidationError('A Note needs to have a Type set')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	191 if self._type not in self.TYPES:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	192 raise ValidationError('A Note Type needs to be one of %s' % ', '.join(self.TYPES))
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	193 if self._ordinal < 0:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	194 raise ValidationError('A Note ordinal must be a positive integer')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	195 if not self._note:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	196 raise ValidationError('A Note must contain some text')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	197
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	198
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	199 def __str__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	200 return self._note
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	201
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	202
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	203 class CVRFReference(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	204 TYPES = ('Self', 'External')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	205 def __init__(self, url, description, _type=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	206 self._url = url
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	207 self._description = description
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	208 self._type = _type
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	209
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	210 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	211 if (self._type is not None) and (self._type not in self.TYPES):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	212 raise ValidationError('If a Reference type is set, it mist be one of %s' % ', '.join(self.TYPES))
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	213 if not self._url:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	214 raise ValidationError('A Reference must contain an URL')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	215 if not self._description:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	216 raise ValidationError('A Reference must contain a description')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	217
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	218
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	219 class CVRFAcknowledgment(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	220 def __init__(self, name=None, organization=None, description=None,
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	221 url=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	222 self._name = name
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	223 self._organization = organization
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	224 self._description = description
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	225 self._url = url
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	226
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	227 def getTitle(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	228 return "%s - %s" % (self._name, self._organization)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	229
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	230 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	231 if (not self._name) and (not self._organization) and (not self._description):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	232 raise ValidationError('An Acknowledgment must have at least a Name, an Organization or a Description')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	233
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	234
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	235 class CVRFProductTree(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	236 def __init__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	237 # All the branches, they can be order with their `parent` attribute
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	238 self._branches = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	239 self._groups = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	240 self._relationships = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	241 self._products = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	242 self._groups = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	243
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	244 def addBranch(self, branch):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	245 parent = self.getBranch(branch.getParent().getPath())
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	246 if parent is self:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	247 self._branches.append(branch)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	248 else:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	249 parent._childs.append(branch)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	250
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	251 def addProduct(self, product):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	252 if product not in self._products:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	253 self._products.append(product)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	254 if product._parent is not self:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	255 product._parent._product = product
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	256
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	257 def addRelationship(self, rel):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	258 self._relationships.append(rel)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	259
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	260 def addGroup(self, group):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	261 self._groups.append(group)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	262
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	263 def getProductForID(self, productid):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	264 for product in self._products:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	265 if product._productid == productid:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	266 return product
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	267 raise KeyError(productid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	268
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	269 def getGroupForID(self, groupid):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	270 for group in self._groups:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	271 if group._groupid == groupid:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	272 return group
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	273 raise KeyError(groupid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	274
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	275 def decomposeProduct(self, productid):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	276 """ In case of product defined as a relationship (product X installed
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	277 on OS Y), this gives us the following tuple: (OS, product). """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	278 product = self.getProductForID(productid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	279 parent = product._parent
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	280 if parent is None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	281 return (None, None)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	282 if not isinstance(parent, CVRFRelationship):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	283 return (None, None)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	284 relationtype = parent._relationtype.replace(' ', '').lower()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	285 if relationtype not in ('defaultcomponentof', 'installedon'):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	286 return (None, None)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	287 return (
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	288 self.getProductForID(parent._relatestoproductreference),
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	289 self.getProductForID(parent._productreference)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	290 )
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	291
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	292 def getBranch(self, path):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	293 if len(path) == 0:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	294 return self
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	295 branches = self._branches
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	296 node = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	297 for idx in path:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	298 node = branches[idx]
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	299 branches = node._childs
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	300 return node
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	301
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	302 def getBranches(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	303 for branch in self._branches:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	304 yield branch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	305 for sub_branch in branch.getBranches():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	306 yield sub_branch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	307
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	308 def getPath(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	309 return ()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	310
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	311 def getNameOfRelationship(self, relationship):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	312 if relationship is None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	313 return ''
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	314 return ' '.join((self.getProductForID(relationship._productreference)._name, 'as',
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	315 relationship._relationtype.lower(),
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	316 self.getProductForID(relationship._relatestoproductreference)._name))
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	317
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	318 def getOrphanedBranches(self, product=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	319 """ The branches that could accept `product` as Product Definition """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	320 white_list = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	321 if product is not None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	322 white_list = [product._parent]
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	323 for branch in self.getBranches():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	324 if (branch in white_list) or branch.isOrphaned():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	325 yield branch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	326
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	327 def getNotTerminalBranches(self, b2=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	328 """\
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	329 The branches that could accept `b2` as new sub-branches
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	330 Note that b2 and all its sub-branches cannot be listed
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	331 """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	332 black_list = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	333 if b2 is not None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	334 black_list = [b2] + list(b2.getBranches())
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	335 for branch in self.getBranches():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	336 if branch in black_list:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	337 continue
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	338 if branch._product is None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	339 yield branch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	340
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	341 def getOrphanedRelationships(self, product=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	342 """ The relationships that need a product defninition """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	343 white_list = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	344 if product is not None:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	345 white_list = [product.getCurrentRelationship()]
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	346 for i, relationship in enumerate(self._relationships):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	347 if (relationship in white_list) or relationship.isOrphaned():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	348 yield (i, relationship)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	349
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	350 def nbProducts(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	351 """ Amount of 'raw' Products """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	352 return len([p for p in self._products if p._parent is self])
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	353
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	354 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	355 for branch in self._branches:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	356 branch.validate()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	357 productids = set()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	358 for product in self._products:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	359 product.validate()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	360 if product._productid in productids:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	361 raise ValidationError('Each ProductID must be unique (%s)' % product._productid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	362 productids.add(product._productid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	363 for relationship in self._relationships:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	364 relationship.validate()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	365 for productid in (relationship._productreference,
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	366 relationship._relatestoproductreference):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	367 if productid not in productids:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	368 raise ValidationError('ProductID %s is unknown' % productid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	369 groupids = set()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	370 for group in self._groups:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	371 group.validate()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	372 if group._groupid in groupids:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	373 raise ValidationError('Duplicated GroupID: %s' % group._groupid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	374 groupids.add(group._groupid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	375 for productid in group._productids:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	376 if productid not in productids:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	377 raise ValidationError('ProductID %s is unknown' % productid)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	378 return productids, groupids
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	379
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	380 def __str__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	381 return 'Products: %s' % '\n'.join(str(p) for p in self._products)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	382
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	383
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	384 class CVRFProductBranch(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	385 TYPES = ('Vendor', 'Product Family', 'Product Name', 'Product Version',
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	386 'Patch Level', 'Service Pack', 'Architecture', 'Language',
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	387 'Legacy', 'Specification')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	388 def __init__(self, _type, name, parentbranch):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	389 self._type = _type
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	390 self._name = name
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	391 self._parentbranch = parentbranch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	392 self._childs = []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	393 self._product = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	394
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	395 def getParent(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	396 return self._parentbranch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	397
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	398 def getPath(self, string=False):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	399 """ return the path to that branch element as a tuple """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	400 if self.isRoot():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	401 for i, b in enumerate(self._parentbranch._branches):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	402 if b is self:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	403 if string:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	404 return '%d' % i
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	405 return (i, )
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	406 else:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	407 for i, b in enumerate(self._parentbranch._childs):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	408 if b is self:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	409 if string:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	410 return '/'.join([self._parentbranch.getPath(string), '%d' % i])
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	411 return self._parentbranch.getPath(string) + (i,)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	412 if string:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	413 return ''
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	414 return ()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	415
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	416 def getTree(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	417 """ this returns a list of tuples (type, name) leading to here"""
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	418 if self.isRoot():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	419 return [(self._type, self._name)]
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	420 return self._parentbranch.getTree() + [(self._type, self._name)]
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	421
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	422 def getName(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	423 return ' / '.join("%s: %s" % (type_, name) for type_, name in self.getTree())
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	424
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	425 def getParentPath(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	426 """ return as string the path to the parent """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	427 return '/'.join('%s' % p for p in self.getPath()[:-1])
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	428
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	429 def isRoot(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	430 return isinstance(self._parentbranch, CVRFProductTree)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	431
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	432 def isOrphaned(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	433 """ Has no childs and no product """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	434 return len(self._childs) == 0 and (self._product is None)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	435
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	436 def getBranches(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	437 for branch in self._childs:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	438 yield branch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	439 for sub_branch in branch.getBranches():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	440 yield sub_branch
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	441
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	442 def unlink(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	443 """ Unset our _parent, and remove us from the _parent._childs """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	444 if self.isRoot():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	445 self.getParent()._branches.remove(self)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	446 else:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	447 self.getParent()._childs.remove(self)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	448 self._parentbranch = None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	449
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	450 def validate(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	451 if not self._type:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	452 raise ValidationError('A Branch must have a Type')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	453 if self._type not in self.TYPES:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	454 raise ValidationError('A Branch Type must be one of %s' % ', '.join(self.TYPES))
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	455 if not self._name:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	456 raise ValidationError('A Branch must have a Name')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	457 for branch in self._childs:
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	458 branch.validate()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	459 if self.isOrphaned():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	460 raise ValidationError('A Branch must have at least a sub-product or sub-branches')
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	461
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	462 def __str__(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	463 return "%s: %s" % (self._type, self._name)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	464
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	465
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	466 class CVRFFullProductName(object):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	467 def __init__(self, productid, name, parent, cpe=None):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	468 self._productid = productid
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	469 self._name = name
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	470 # Can be None (directly under the tree), a ProductBranch, or a
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	471 # Relationship
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	472 self._parent = parent
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	473 self._cpe = cpe
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	474
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	475 def isRoot(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	476 return isinstance(self._parent, CVRFProductTree)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	477
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	478 def isRelationship(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	479 return isinstance(self._parent, CVRFRelationship)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	480
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	481 def getTree(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	482 if not isinstance(self._parent, CVRFProductBranch):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	483 return []
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	484 return self._parent.getTree()
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	485
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	486 def getParentPath(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	487 if self.isRoot() or self.isRelationship():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	488 return ''
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	489 return self._parent.getPath(True)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	490
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	491 def getCurrentRelationship(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	492 if self.isRelationship():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	493 return self._parent
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	494 return None
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	495
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	496 def unlink(self):
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	497 """ Unset our _parent, and remove us from the _parent._childs """
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	498 if self.isRoot():
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	499 self._parent._products.remove(self)
e18b61a73a68 Initial Release Benoît Allard <benoit.allard@greenbone.net> parents: diff changeset	500 else:

0

e18b61a73a68 Initial Release