--- a/OSSEval/analysis/models.py
+++ b/OSSEval/analysis/models.py
@@ -1,24 +1,429 @@
+from django.db import models
from datetime import datetime
-
-from django.db import models
-
-from methodology.models import WeightScenario
+from random import randrange
+from pygal import Radar, Bar
+from pygal.style import NeonStyle, DarkSolarizedStyle, LightSolarizedStyle, LightStyle, CleanStyle, RedBlueStyle, DarkColorizedStyle, LightColorizedStyle, TurquoiseStyle, LightGreenStyle, DarkGreenStyle, DarkGreenBlueStyle, BlueStyle
+from entity.models import Entity
+from OSSEval.utils import xmlMinidom
+from xml.dom.minidom import Node
+
+class Methodology(models.Model):
+ name = models.CharField(max_length=200)
+ description = models.CharField(max_length=2000,null=True,blank=True)
+ documentation = models.TextField(null=True,blank=True)
+ active = models.BooleanField(default=True)
+ # The entity type the methodology helps you assess
+ entity = models.ForeignKey(Entity)
+
+ def __str__(self):
+ return self.name
+
+ def from_xml(self, xmldoc, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.name = xmlMinidom.getStringAttribute(xmldoc, 'Name')
+ self.description = xmlMinidom.getString(xmldoc, 'Description')
+ self.documentation = xmlMinidom.getString(xmldoc, 'Documentation')
+ self.active = xmlMinidom.getStringAttribute(xmldoc, 'Active')
+ e = Entity()
+ xml_entity = xmldoc.getElementsByTagName('Entity')[0]
+ e.from_xml(xml_entity, insert)
+ self.entity = e
+ # I save so I get the ID (in case insert == True)
+ self.save()
+
+ def to_xml(self):
+ str_xml = "<Description><![CDATA[" + self.description + "]]></Description>"
+ str_xml += "<Documentation><![CDATA[" + self.documentation + "]]></Documentation>"
+ str_xml += self.entity.to_xml()
+ return '<Methodology Id="' + str(self.id) + '" Name="' + self.name + '" Active="' + str(self.active) + '">' + str_xml + "</Methodology>"
+
+class HasPages(models.Model):
+ bar_chart = models.TextField(blank=True)
+ radar_chart = models.TextField(blank=True)
+ def create_graphs(self, instances):
+ # I draw the graphs for the report
+ #styles = [NeonStyle, DarkSolarizedStyle, LightSolarizedStyle, LightStyle, CleanStyle, RedBlueStyle, DarkColorizedStyle, LightColorizedStyle, TurquoiseStyle, LightGreenStyle, DarkGreenStyle, DarkGreenBlueStyle, BlueStyle]
+ #style=styles[randrange(len(styles))]
+ style=LightColorizedStyle
+ bar_chart = Bar(width=300, height=400, explicit_size=True, rounded_bars=5, disable_xml_declaration=True, style=style)
+ radar_chart = Radar(width=400, height=400, explicit_size=True, legend_at_bottom=True, disable_xml_declaration=True, style=style)
+ if self.__class__.__name__ == "Page":
+ radar_chart.title = self.name
+ else:
+ radar_chart.title = 'Summary graph'
+ radar_chart.x_labels = []
+ instance_scores = {}
+ for instance in instances:
+ instance_scores[instance.id] = []
+ for page in self.page_set.all():
+ radar_chart.x_labels.append(page.name)
+ for instance in instances:
+ try:
+ ps = PageScore.objects.get(page=page, instance=instance)
+ instance_scores[instance.id].append(ps.score)
+ except:
+ instance_scores[instance.id].append(0)
+ for instance in instances:
+ radar_chart.add(instance.name, instance_scores[instance.id])
+ bar_chart.add(instance.name, sum(instance_scores[instance.id]))
+ self.radar_chart = radar_chart.render()
+ self.bar_chart = bar_chart.render()
+ self.save()
+ class Meta:
+ abstract = True
+
+class MethodologyVersion(HasPages):
+ number = models.IntegerField()
+ created = models.DateField()
+ current = models.BooleanField(default=False)
+ methodology = models.ForeignKey(Methodology)
+
+ def __str__(self):
+ return self.methodology.name + " - " + str(self.number) + (" (Active version)" if self.current else "")
+
+ def from_xml(self, xmldoc, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.number = xmldoc.attributes["Number"].firstChild.data
+ self.created = xmlMinidom.getStringAttribute(xmldoc, 'Created')
+ self.current = xmlMinidom.getStringAttribute(xmldoc, 'Current')
+ m = Methodology()
+ xml_methodology = xmldoc.getElementsByTagName('Methodology')[0]
+ m.from_xml(xml_methodology, insert)
+ self.methodology = m
+ # I save so I get the ID (if insert == True)
+ self.save()
+ # Pages
+ for xml_child in xmldoc.childNodes:
+ # Some nodes are text nodes (e.g. u'\n ') I need to look just at ELEMENT_NODE
+ if xml_child.nodeType == Node.ELEMENT_NODE and xml_child.tagName == 'Pages':
+ xml_pages = xml_child
+ break
+ for xml_page in xml_pages.childNodes:
+ if xml_page.nodeType == Node.ELEMENT_NODE and xml_page.tagName == 'Page':
+ p = Page()
+ p.from_xml(xml_page, self, None, insert)
+ #WeightScenarios
+ xml_weight_scenarios = xmldoc.getElementsByTagName('WeightScenarios')
+ for xml_weight_scenario in xml_weight_scenarios:
+ ws = WeightScenario()
+ ws.from_xml(xml_weight_scenario, self, insert)
+
+ def to_xml(self):
+ str_xml = self.methodology.to_xml()
+ str_xml += "<Pages>"
+ for page in self.page_set.all():
+ str_xml += page.to_xml()
+ str_xml += "</Pages>"
+ str_xml += "<WeightScenarios>"
+ for weight_scenario in self.weightscenario_set.all():
+ str_xml += weight_scenario.to_xml()
+ str_xml += "</WeightScenarios>"
+
+ return '<MethodologyVersion Id="' + str(self.id) + '" Number="' + str(self.number) + '" Created="' + str(self.created) + '" Current="' + str(self.current) + '">' + str_xml + "</MethodologyVersion>"
+
+class Page(HasPages):
+ name = models.CharField(max_length=200)
+ order = models.IntegerField(null=False,blank=False)
+ parent = models.ForeignKey('self',null=True,blank=True)
+ methodology_version = models.ForeignKey(MethodologyVersion,null=True,blank=True)
+ def questions(self):
+ q = list(self.question_set.all())
+ for p in self.page_set.all():
+ q += p.questions()
+ return q
+
+ def __str__(self):
+ return self.name
+
+ def from_xml(self, xmldoc, methodology_version, parent_page, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.name = xmlMinidom.getStringAttribute(xmldoc, 'Name')
+ self.order = xmldoc.attributes["Order"].firstChild.data
+ if methodology_version is not None:
+ self.methodology_version = methodology_version
+ if parent_page is not None:
+ self.parent = parent_page
+ self.save()
+ # Pages
+ for xml_child in xmldoc.childNodes:
+ # Some nodes are text nodes (e.g. u'\n ') I need to look just at ELEMENT_NODE
+ if xml_child.nodeType == Node.ELEMENT_NODE and xml_child.tagName == 'Pages':
+ xml_pages = xml_child
+ break
+ for xml_page in xml_pages.childNodes:
+ if xml_page.nodeType == Node.ELEMENT_NODE and xml_page.tagName == 'Page':
+ p = Page()
+ p.from_xml(xml_page, None, self, insert)
+ # Questions
+ for xml_child in xmldoc.childNodes:
+ # Some nodes are text nodes (e.g. u'\n ') I need to look just at ELEMENT_NODE
+ if xml_child.nodeType == Node.ELEMENT_NODE and xml_child.tagName == 'Questions':
+ xml_questions = xml_child
+ break
+ for xml_question in xml_questions.childNodes:
+ if xml_question.nodeType == Node.ELEMENT_NODE and xml_question.tagName == 'Question':
+ q = Question()
+ q.from_xml(xml_question, self, insert)
+
+ def to_xml(self):
+ str_xml = "<Pages>"
+ for page in self.page_set.all():
+ str_xml += page.to_xml()
+ str_xml += "</Pages>"
+ str_xml += "<Questions>"
+ for question in self.question_set.all():
+ str_xml += question.to_xml()
+ str_xml += "</Questions>"
+ return '<Page Id="' + str(self.id) + '" Name="' + self.name + '" Order="' + str(self.order) + '">' + str_xml + "</Page>"
+
+ def calculate_scores(self, instance, weight_scenario, instances):
+# Let's reset the score to 0
+ try:
+ ps = PageScore.objects.get(page=self, instance=instance)
+ except:
+ ps = PageScore(page=self, instance=instance, score=0)
+ ps.score = 0
+# and calculate the score for child pages and add it to current page's score
+ for page in self.page_set.all():
+ ps.score += page.calculate_scores(instance, weight_scenario, instances)
+# Loop on questions
+ for question in self.questions():
+ weight = weight_scenario.question_weight(question.id)
+ try:
+ answer = Answer.objects.get(question=question, instance=instance)
+ answer.score = weight * (answer.value_integer-1)
+ answer.save()
+ ps.score += answer.score
+ except Exception as ex:
+ #I haven't found an answer, nothing to add
+ print ex.message
+ pass
+ ps.save()
+ self.create_graphs(instances)
+ return ps.score
+
+ class Meta:
+ ordering = ['order']
+
+class QuestionType(models.Model):
+ '''
+ For future use; at the moment a question is just a multiple choice
+ '''
+ name = models.CharField(max_length=200)
+
+ def from_xml(self, xmldoc, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.name = xmlMinidom.getStringAttribute(xmldoc, 'Name')
+
+ def to_xml(self):
+ return '<QuestionType Id="' + str(self.id) + '" Name="' + self.name + '"/>'
+
+class Question(models.Model):
+ page = models.ForeignKey(Page)
+ text = models.CharField(max_length=200)
+ order = models.IntegerField()
+ eval_description = models.TextField(null=True,blank=True)
+ eval_value = models.TextField(null=True,blank=True)
+ question_type = models.ForeignKey(QuestionType)
+
+ def __str__(self):
+ return self.page.name + " - " + self.text
+
+ def from_xml(self, xmldoc, page, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.text = xmlMinidom.getStringAttribute(xmldoc, 'Text')
+ self.order = xmlMinidom.getNaturalAttribute(xmldoc, 'Order')
+ #Do so that QuestionType default is 1
+ qt = QuestionType.objects.get(pk=1)
+ self.page = page
+ self.question_type = qt
+ self.eval_description = xmlMinidom.getString(xmldoc, 'EvalDescription')
+ self.eval_value = xmlMinidom.getString(xmldoc, 'EvalValue')
+ self.save()
+ # Queries
+ xml_queries = xmldoc.getElementsByTagName('Query')
+ for xml_query in xml_queries:
+ q = Query()
+ q.from_xml(xml_query, self, insert)
+ # Choices
+ xml_choices = xmldoc.getElementsByTagName('Choice')
+ for xml_choice in xml_choices:
+ c = Choice()
+ c.from_xml(xml_choice, self, insert)
+
+ def to_xml(self):
+ str_xml = "<EvalDescription><![CDATA[" + ("" if self.eval_description is None else self.eval_description) + "]]></EvalDescription>"
+ str_xml += "<EvalValue><![CDATA[" + ("" if self.eval_value is None else self.eval_value) + "]]></EvalValue>"
+# We do not use question_type at the moment as we have just one type
+# str_xml += self.question_type.to_xml()
+ str_xml += "<Queries>"
+ for query in self.query_set.all():
+ str_xml += query.to_xml()
+ str_xml += "</Queries>"
+ str_xml += "<Choices>"
+ for choice in self.choice_set.all():
+ str_xml += choice.to_xml()
+ str_xml += "</Choices>"
+ return '<Question Id="' + str(self.id) + '" Text="' + self.text + '" Order="' + str(self.order) + '">' + str_xml + '</Question>'
+
+ class Meta:
+ ordering = ['order']
+
+class Query(models.Model):
+ '''
+ Queries against web search engines used to automate the answer to a question and/or as a hint to the reviewer
+ '''
+ question = models.ForeignKey(Question)
+ eval_text = models.CharField(max_length=2000)
+ eval_site = models.CharField(max_length=2000)
+ eval_site_exclude = models.CharField(max_length=2000)
+
+ def from_xml(self, xmldoc, question, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.question = question
+ self.eval_text = xmlMinidom.getString(xmldoc, 'EvalText')
+ self.eval_site = xmlMinidom.getString(xmldoc, 'EvalSite')
+ self.eval_site_exclude = ""
+ self.save()
+
+ def to_xml(self):
+ str_xml = "<EvalText><![CDATA[" + self.eval_text + "]]></EvalText>"
+ str_xml += "<EvalSite><![CDATA[" + self.eval_site + "]]></EvalSite>"
+ return '<Query Id="' + str(self.id) + '">' + str_xml + '</Query>'
+
+class Choice(models.Model):
+ '''
+ '''
+ question = models.ForeignKey(Question)
+ text = models.CharField(max_length=200)
+ order = models.IntegerField()
+ todo = models.CharField(max_length=2000)
+
+ def from_xml(self, xmldoc, question, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.question = question
+ self.text = xmlMinidom.getStringAttribute(xmldoc, 'Text')
+ self.order = xmlMinidom.getNaturalAttribute(xmldoc, 'Order')
+ self.todo = xmlMinidom.getString(xmldoc, 'Todo')
+ self.save()
+
+ def to_xml(self):
+ str_xml = "<Todo>" + self.todo + "</Todo>"
+ return '<Choice Id="' + str(self.id) + '" Text="' + self.text + '" Order="' + str(self.order) + '">' + str_xml + '</Choice>'
+
+ class Meta:
+ ordering = ['order']
+
+class WeightScenario(models.Model):
+ name = models.CharField(max_length=200)
+ methodology_version = models.ForeignKey(MethodologyVersion)
+ active = models.BooleanField(blank=False)
+
+ def question_weight(self, question_id):
+ '''
+ returns the weight; default is 1
+ '''
+ weight = 1
+ for w in self.weight_set.all():
+ if w.question.id == question_id:
+ weight = w.weight
+ return weight
+ def from_xml(self, xmldoc, methodology_version, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.methodology_version = methodology_version
+ self.name = xmlMinidom.getStringAttribute(xmldoc, 'Name')
+ self.active = xmlMinidom.getStringAttribute(xmldoc, 'Active')
+ self.save()
+ #Weights
+ xml_weights = xmldoc.getElementsByTagName('Weight')
+ for xml_weight in xml_weights:
+ w = Weight()
+ w.from_xml(xml_weight, self, insert)
+
+ def to_xml(self):
+ str_xml = "<Weights>"
+ for weight in self.weight_set.all():
+ str_xml += weight.to_xml()
+ str_xml += "</Weights>"
+ return '<WeightScenario Id="' + str(self.id) + '" Name="' + self.name + '" Active="' + str(self.active) + '">' + str_xml + '</WeightScenario>'
+
+ def __str__(self):
+ return self.name
+
+class Weight(models.Model):
+ question = models.ForeignKey(Question)
+ weight = models.FloatField()
+ scenario = models.ForeignKey(WeightScenario)
+
+ def from_xml(self, xmldoc, scenario, insert = True):
+ if not insert:
+ self.id = xmlMinidom.getNaturalAttribute(xmldoc, 'Id')
+ self.scenario = scenario
+ self.weight = xmlMinidom.getStringAttribute(xmldoc, 'weight')
+ self.question = Question.objects.get(pk=xmlMinidom.getNaturalAttribute(xmldoc, 'question_id'))
+ self.save()
+
+ def to_xml(self):
+ return '<Weight Id="' + str(self.id) + '" question_id="' + str(self.question.id) + '" weight="' + str(self.weight) + '"/>'
class Analysis(models.Model):
name = models.CharField(max_length=200)
description = models.CharField(max_length=2000)
comment = models.TextField(null=True,blank=True)
created = models.DateField(default=datetime.now, blank=True)
- methodology_version = models.ForeignKey('methodology.MethodologyVersion')
+ methodology_version = models.ForeignKey(MethodologyVersion)
user_login = models.CharField(max_length=50)
visible = models.BooleanField(default=True)
weight_scenario = models.ForeignKey(WeightScenario)
protected = models.BooleanField(default=False)
+
def __str__(self):
return self.name
+
+ def calculate_scores(self):
+ '''
+ Calculates scores for each couple (instance, page) and (instance, question)
+ Stores them on the db
+ '''
+ #let's get the weight from the scenario if any; the default is 1
+ try:
+ weight_scenarios = self.methodology_version.weightscenario_set.filter(active=True)
+ if len(weight_scenarios) == 1:
+ weight_scenario = weight_scenarios[0]
+ else:
+ raise Exception("There should be exactly one WeightScenario for MethodologyVersion " + str(self.methodology_version.id))
+ except:
+ # an empty one will set all weights to 1
+ weight_scenario = WeightScenario()
+ #loop through the pages to reset scores to 0; when I calculate a question
+ #then I add its score to the corresponding page
+ #loop on top level pages and recursive calculation on child pages
+ for page in self.methodology_version.page_set.all():
+ for instance in self.instance_set.all():
+ page.calculate_scores(instance, weight_scenario, self.instance_set.all())
+ self.methodology_version.create_graphs(self.instance_set.all())
+
+# @staticmethod
+# def create_graphs(object, pages, instances):
+ '''
+ a static method because I need to create the same
+ '''
+
def from_xml(self, xmldoc, insert = True):
- #All but the MethodologyVersion so that we can independently import from xml MethodologyVersion and Analysis
+ '''
+ All but the MethodologyVersion so that we can independently import from xml
+ MethodologyVersion and Analysis
+ '''
pass
+
def to_xml(self):
str_xml = "<Description>" + self.description + "</Description>"
str_xml += "<Comment>" + self.comment + "</Comment>"
@@ -37,10 +442,13 @@
name = models.CharField(max_length=200)
name_for_search = models.CharField(max_length=200, default="")
analysis = models.ForeignKey(Analysis)
+
def __str__(self):
return self.name + " - " + self.name_for_search
+
def from_xml(self, xmldoc, insert = True):
pass
+
def to_xml(self):
str_xml = "<Answers>"
for answer in self.answer_set.all():
@@ -49,24 +457,40 @@
return '<Instance Id="' + str(self.id) + '" Name="' + self.name + '" NameForSearch="' + self.name_for_search + '">' + str_xml + "</Instance>"
+class PageScore(models.Model):
+ page = models.ForeignKey(Page)
+ instance = models.ForeignKey(Instance)
+ score = models.FloatField()
+ class Meta:
+ unique_together = ('page', 'instance',)
+
+
class Answer(models.Model):
"""
-
+ value_integer is the value of the answer
+ score is value_integer * weight
+ where weight is associated to the question in a WeightScenario
"""
instance = models.ForeignKey(Instance)
- question = models.ForeignKey('methodology.Question')
+ question = models.ForeignKey(Question)
value_integer = models.IntegerField()
+ score = models.FloatField(default=0)
notes = models.CharField(max_length=2000)
+
def from_xml(self, xmldoc, insert = True):
pass
+
def to_xml(self):
str_xml = "<Notes>" + self.notes + "</Notes>"
str_xml += '<Question Id="' + str(self.question.id) + '"></Question>'
return '<Answer ValueInteger="' + str(self.value_integer) + '">' + str_xml + "</Answer>"
+ class Meta:
+ unique_together = ('question', 'instance',)
+
class Configuration(models.Model):
- default_methodology_version = models.ForeignKey('methodology.MethodologyVersion', blank=True, null=True)
+ default_methodology_version = models.ForeignKey(MethodologyVersion, blank=True, null=True)
class UploadedFile(models.Model):