def __init__(self, user, reviewdocument):
self.user = user
self.reviewdocument = reviewdocument
self.ensure_reviewer()
upload_immediately = False
if self.crocodoc_uuid_recorded is False: # if we have no uuid then try to get it
upload_immediately = True
# need to ensure that we have the file locally
self.reviewdocument.ensure_file() ## ensure we have a local copy of the file
self.service = CrocoDocConnectService(document_object=self.reviewdocument.document,
app_label='attachment',
field_name='executed_file',
upload_immediately=upload_immediately, # this is handled by the ensure_local_file method
# important for sandboxing the view to the specified reviewer
reviewer=self.reviewdocument.reviewer)
self.ensure_local_reference_crocodoc_uuid() # record the uuid
class CrocodocLoaderService(object):
"""
Class to provide kwargs used to populate html template with params
also used to provide url
"""
user = None
reviewdocument = None
service = None
@property
def crocodoc_uuid_recorded(self):
return self.reviewdocument.crocodoc_uuid not in [None, '']
def __init__(self, user, reviewdocument):
self.user = user
self.reviewdocument = reviewdocument
self.ensure_reviewer()
upload_immediately = False
if self.crocodoc_uuid_recorded is False: # if we have no uuid then try to get it
upload_immediately = True
# need to ensure that we have the file locally
self.reviewdocument.ensure_file() ## ensure we have a local copy of the file
self.service = CrocoDocConnectService(document_object=self.reviewdocument.document,
app_label='attachment',
field_name='executed_file',
upload_immediately=upload_immediately, # this is handled by the ensure_local_file method
# important for sandboxing the view to the specified reviewer
reviewer=self.reviewdocument.reviewer)
self.ensure_local_reference_crocodoc_uuid() # record the uuid
def ensure_local_reference_crocodoc_uuid(self):
# make sure its a copy when necessary
self.ensure_reset_copied_reviewdocument()
# if the crocodoc has not been saved to lawpal yet, save it's uuid:
if self.service.is_new is True or self.crocodoc_uuid_recorded is False:
if self.service.obj.uuid:
#
# Save the uuid field so we can do lookups
#
self.reviewdocument.crocodoc_uuid = self.service.obj.uuid
self.reviewdocument.save(update_fields=['crocodoc_uuid'])
else:
logger.error('Crocodoc Service did not provide a uuid for the reviewdocument: %s for revision: %s on item: %s' % (self.reviewdocument, self.reviewdocument.document, self.reviewdocument.document.item.slug))
def ensure_reset_copied_reviewdocument(self):
"""
In the process of "request review" the database-entry for the base-object is copied with only one user as
reviewer.
Since the WHOLE entry including the crocodoc_uuid is copied, we need to check if the actual object has the same
uuid and possibly reset it. Otherwise we couldn't identify the review copies.
"""
if self.reviewdocument.document.primary_reviewdocument and self.reviewdocument.document.primary_reviewdocument.crocodoc_uuid == self.service.obj.uuid:
crocodoc_object = self.service.obj
crocodoc_object.crocodoc_uuid = None
def ensure_reviewer(self):
if self.reviewdocument.reviewer is None:
#
# @BUG seems that the reviewer for some reason has not been assigned
#
self.reviewdocument.save() # calling save causes the system to reevaluate the reviewers
def ensure_local_file(self):
#
# if crocodoc.is_new is True:
#
# Ensure we have a local copy of this file so it can be sent
#
if self.reviewdocument.ensure_file():
# so we have a file, now lets upload it
self.service.generate()
def process(self):
# @TODO this should ideally be set in the service on init
# and session automatically updated
# https://crocodoc.com/docs/api/ for more info
CROCODOC_PARAMS = {
"user": {
"name": self.user.get_full_name(),
"id": self.user.pk
},
"sidebar": 'auto',
"editable": self.reviewdocument.is_current, # allow comments only if the item is current
"admin": False, # noone should be able to delete other comments
"downloadable": True, # everyone should be able to download a copy
"copyprotected": False, # should not have copyprotection
"demo": False,
#
# We create a ReviewDocument object for each and every reviewer
# for the matter.participants there is 1 ReviewDocument object
# that they all can see
#
#"filter": self.get_filter_ids() # must be a comma seperated list
}
return {
'crocodoc': self.service.obj.crocodoc_service,
'crocodoc_view_url': self.service.obj.crocodoc_service.view_url(**CROCODOC_PARAMS), # this is where the view params must be sent in order to show toolbar etc
'CROCODOC_PARAMS': CROCODOC_PARAMS, # for testing the values
}
