forked from adamlaska/datatracker
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmodels.py
More file actions
260 lines (222 loc) · 10.8 KB
/
models.py
File metadata and controls
260 lines (222 loc) · 10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# Copyright The IETF Trust 2007-2020, All Rights Reserved
# -*- coding: utf-8 -*-
import datetime
from django.conf import settings
from django.db import models
from django.urls import reverse
from ietf.doc.models import DocAlias, DocEvent
from ietf.name.models import DocRelationshipName,IprDisclosureStateName,IprLicenseTypeName,IprEventTypeName
from ietf.person.models import Person
from ietf.message.models import Message
from ietf.utils.models import ForeignKey
class IprDisclosureBase(models.Model):
by = ForeignKey(Person) # who was logged in, or System if nobody was logged in
compliant = models.BooleanField("Complies to RFC3979", default=True)
docs = models.ManyToManyField(DocAlias, through='IprDocRel')
holder_legal_name = models.CharField(max_length=255)
notes = models.TextField("Additional notes", blank=True)
other_designations = models.CharField("Designations for other contributions", blank=True, max_length=255)
rel = models.ManyToManyField('self', through='RelatedIpr', symmetrical=False)
state = ForeignKey(IprDisclosureStateName)
submitter_name = models.CharField(max_length=255,blank=True)
submitter_email = models.EmailField(blank=True)
time = models.DateTimeField(auto_now_add=True)
title = models.CharField(blank=True, max_length=255)
class Meta:
ordering = ['-time', '-id']
indexes = [
models.Index(fields=['-time', '-id']),
]
def __str__(self):
return self.title
def get_absolute_url(self):
return settings.IDTRACKER_BASE_URL + reverse('ietf.ipr.views.show',kwargs={'id':self.id})
def get_child(self):
"""Returns the child instance"""
for child_class in ('genericiprdisclosure',
'holderiprdisclosure',
'nondocspecificiprdisclosure',
'thirdpartyiprdisclosure'):
try:
return getattr(self,child_class)
except IprDisclosureBase.DoesNotExist:
pass
def get_latest_event_msgout(self):
"""Returns the latest IprEvent of type msgout. For use in templates."""
return self.latest_event(type='msgout')
def get_latest_event_submitted(self):
return self.latest_event(type='submitted')
def get_latest_event_posted(self):
return self.latest_event(type='posted')
def has_legacy_event(self):
"""Returns True if there is one or more LegacyMigrationIprEvents
for this disclosure"""
if LegacyMigrationIprEvent.objects.filter(disclosure=self):
return True
else:
return False
def latest_event(self, *args, **filter_args):
"""Get latest event of optional Python type and with filter
arguments, e.g. d.latest_event(type="xyz") returns an IprEvent
while d.latest_event(WriteupDocEvent, type="xyz") returns a
WriteupDocEvent event."""
model = args[0] if args else IprEvent
e = model.objects.filter(disclosure=self).filter(**filter_args).order_by('-time', '-id')[:1]
return e[0] if e else None
def set_state(self, state):
"""This just sets the state, doesn't log the change. Takes a string"""
try:
statename = IprDisclosureStateName.objects.get(slug=state)
except IprDisclosureStateName.DoesNotExist:
return
self.state = statename
self.save()
@property
def updates(self):
"""Shortcut for disclosures this disclosure updates"""
return self.relatedipr_source_set.filter(relationship__slug='updates')
@property
def updated_by(self):
"""Shortcut for disclosures this disclosure is updated by"""
return self.relatedipr_target_set.filter(relationship__slug='updates')
@property
def update_notified_date(self):
"""Returns the date when the submitters of the IPR that this IPR updates
were notified"""
e = self.latest_event(type='update_notify')
if e:
return e.time
else:
return None
def recursively_updates(self,disc_set=None):
"""Returns the set of disclosures updated directly or transitively by this disclosure"""
if disc_set == None:
disc_set = set()
new_candidates = set([y.target.get_child() for y in self.updates])
unseen = new_candidates - disc_set
disc_set.update(unseen)
for disc in unseen:
disc_set.update(disc.recursively_updates(disc_set))
return disc_set
def is_thirdparty(self):
"""Returns True if this disclosure is a Third Party disclosure"""
ipr = self.get_child() if self.__class__ is IprDisclosureBase else self
return ipr.__class__ is ThirdPartyIprDisclosure
class HolderIprDisclosure(IprDisclosureBase):
ietfer_name = models.CharField(max_length=255, blank=True) # "Whose Personal Belief Triggered..."
ietfer_contact_email = models.EmailField(blank=True)
ietfer_contact_info = models.TextField(blank=True)
patent_info = models.TextField()
has_patent_pending = models.BooleanField(default=False)
holder_contact_email = models.EmailField()
holder_contact_name = models.CharField(max_length=255)
holder_contact_info = models.TextField(blank=True, help_text="Address, phone, etc.")
licensing = ForeignKey(IprLicenseTypeName)
licensing_comments = models.TextField(blank=True)
submitter_claims_all_terms_disclosed = models.BooleanField(default=False)
class ThirdPartyIprDisclosure(IprDisclosureBase):
ietfer_name = models.CharField(max_length=255) # "Whose Personal Belief Triggered..."
ietfer_contact_email = models.EmailField()
ietfer_contact_info = models.TextField(blank=True, help_text="Address, phone, etc.")
patent_info = models.TextField()
has_patent_pending = models.BooleanField(default=False)
class NonDocSpecificIprDisclosure(IprDisclosureBase):
'''A Generic IPR Disclosure w/ patent information'''
holder_contact_name = models.CharField(max_length=255)
holder_contact_email = models.EmailField()
holder_contact_info = models.TextField(blank=True, help_text="Address, phone, etc.")
patent_info = models.TextField()
has_patent_pending = models.BooleanField(default=False)
statement = models.TextField() # includes licensing info
class GenericIprDisclosure(IprDisclosureBase):
holder_contact_name = models.CharField(max_length=255)
holder_contact_email = models.EmailField()
holder_contact_info = models.TextField(blank=True, help_text="Address, phone, etc.")
statement = models.TextField() # includes licensing info
class IprDocRel(models.Model):
disclosure = ForeignKey(IprDisclosureBase)
document = ForeignKey(DocAlias)
sections = models.TextField(blank=True)
revisions = models.CharField(max_length=16,blank=True) # allows strings like 01-07
def doc_type(self):
name = self.document.name
if name.startswith("rfc"):
return "RFC"
if name.startswith("draft"):
return "Internet-Draft"
if name.startswith("slide"):
return "Meeting Slide"
def formatted_name(self):
name = self.document.name
if name.startswith("rfc"):
return name.upper()
#elif self.revisions:
# return "%s-%s" % (name, self.revisions)
else:
return name
def __str__(self):
if self.revisions:
return "%s which applies to %s-%s" % (self.disclosure, self.document.name, self.revisions)
else:
return "%s which applies to %s" % (self.disclosure, self.document.name)
class RelatedIpr(models.Model):
source = ForeignKey(IprDisclosureBase,related_name='relatedipr_source_set')
target = ForeignKey(IprDisclosureBase,related_name='relatedipr_target_set')
relationship = ForeignKey(DocRelationshipName) # Re-use; change to a dedicated RelName if needed
def __str__(self):
return "%s %s %s" % (self.source.title, self.relationship.name.lower(), self.target.title)
class IprEvent(models.Model):
time = models.DateTimeField(auto_now_add=True)
type = ForeignKey(IprEventTypeName)
by = ForeignKey(Person)
disclosure = ForeignKey(IprDisclosureBase)
desc = models.TextField()
message = ForeignKey(Message, null=True, blank=True,related_name='msgevents')
in_reply_to = ForeignKey(Message, null=True, blank=True,related_name='irtoevents')
response_due= models.DateTimeField(blank=True,null=True)
def __str__(self):
return "%s %s by %s at %s" % (self.disclosure.title, self.type.name.lower(), self.by.plain_name(), self.time)
def save(self, *args, **kwargs):
created = not self.pk
super(IprEvent, self).save(*args, **kwargs)
if created:
self.create_doc_events()
def response_past_due(self):
"""Returns true if it's beyond the response_due date and no response has been
received"""
qs = IprEvent.objects.filter(disclosure=self.disclosure,in_reply_to=self.message)
if not qs and datetime.datetime.now().date() > self.response_due.date():
return True
else:
return False
def create_doc_events(self):
"""Create DocEvents for documents affected by an IprEvent"""
# Map from self.type_id to DocEvent.EVENT_TYPES for types that
# should be logged as DocEvents
event_type_map = {
'posted': 'posted_related_ipr',
'removed': 'removed_related_ipr',
}
if self.type_id in event_type_map:
related_docs = set() # related docs, no duplicates
for alias in self.disclosure.docs.all():
related_docs.update(alias.docs.all())
for doc in related_docs:
DocEvent.objects.create(
type=event_type_map[self.type_id],
time=self.time,
by=self.by,
doc=doc,
rev='',
desc='%s related IPR disclosure <b>%s</b>' % (self.type.name,
self.disclosure.title),
)
class Meta:
ordering = ['-time', '-id']
indexes = [
models.Index(fields=['-time', '-id']),
]
class LegacyMigrationIprEvent(IprEvent):
"""A subclass of IprEvent specifically for capturing contents of legacy_url_0,
the text of a disclosure submitted by email"""
pass