matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

PEP8 fixes

Browse Source
This commit is contained in:
Roberto Rosario
2011-04-06 15:04:29 -04:00
parent f66c8ec6e2
commit 2ab38522fd
4 changed files with 376 additions and 359 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
apps/documents/forms.py
View File

@@ -10,7 +10,6 @@ from django.forms.formsets import formset_factory
from staging import StagingFile
from common.wizard import BoundFormWizard
from common.utils import urlquote
from common.forms import DetailForm
from models import Document, DocumentType, DocumentTypeMetadataType, \
@@ -23,22 +22,22 @@ from documents.conf.settings import AVAILABLE_MODELS
class DocumentPageTransformationForm(forms.ModelForm):
class Meta:
model = DocumentPageTransformation
def __init__(self, *args, **kwargs):
super(DocumentPageTransformationForm, self).__init__(*args, **kwargs)
self.fields['document_page'].widget = forms.HiddenInput()
class DocumentPageImageWidget(forms.widgets.Widget):
def render(self, name, value, attrs=None):
output = []
output.append('<img src="%(img)s?page=%(page)s" />' % {
'img':reverse('document_preview_transformation', args=[value.document.id]),
'page':value.page_number,
'img': reverse('document_preview_transformation',
args=[value.document.id]),
'page': value.page_number,
})
#output.append(super(ImageWidget, self).render(name, value, attrs))
return mark_safe(u''.join(output))
return mark_safe(u''.join(output))
class DocumentPageForm(DetailForm):
class Meta:
@@ -47,7 +46,7 @@ class DocumentPageForm(DetailForm):
def __init__(self, *args, **kwargs):
super(DocumentPageForm, self).__init__(*args, **kwargs)
self.fields['page_image'].initial = self.instance
page_image = forms.CharField(widget=DocumentPageImageWidget())
@@ -56,27 +55,34 @@ class ImageWidget(forms.widgets.Widget):
output = []
page_count = value.documentpage_set.count()
if page_count > 1:
output.append('<br /><span class="famfam active famfam-page_white_copy"></span>%s<br />' % ugettext(u'Pages'))
output.append(
'<br /><span class="famfam active famfam-page_white_copy"></span>%s<br />' %
ugettext(u'Pages'))
for page_index in range(value.documentpage_set.count()):
output.append('<span>%(page)s)<a rel="gallery_1" class="fancybox-noscaling" href="%(url)s?page=%(page)s"><img src="%(img)s?page=%(page)s" /></a></span>' % {
'url':reverse('document_display', args=[value.id]),
'img':reverse('document_preview_multipage', args=[value.id]),
'page':page_index+1,
output.append(
'<span>%(page)s)<a rel="gallery_1" class="fancybox-noscaling" href="%(url)s?page=%(page)s"><img src="%(img)s?page=%(page)s" /></a></span>' % {
'url': reverse('document_display', args=[value.id]),
'img': reverse('document_preview_multipage', args=[value.id]),
'page': page_index + 1,
})
else:
output.append('<a class="fancybox-noscaling" href="%(url)s"><img width="300" src="%(img)s" /></a>' % {
'url':reverse('document_display', args=[value.id]),
'img':reverse('document_preview', args=[value.id]),
output.append(
'<a class="fancybox-noscaling" href="%(url)s"><img width="300" src="%(img)s" /></a>' % {
'url': reverse('document_display', args=[value.id]),
'img': reverse('document_preview', args=[value.id]),
})
output.append('<br /><span class="famfam active famfam-magnifier"></span>%s' % ugettext(u'Click on the image for full size view'))
output.append(
'<br /><span class="famfam active famfam-magnifier"></span>%s' %
ugettext(u'Click on the image for full size view'))
if not self.attrs.get('hide_detail_link', False):
for document_page in value.documentpage_set.all():
output.append('<br/><a href="%(url)s"><span class="famfam active famfam-page_white"></span>%(text)s</a>' % {
'url':reverse('document_page_view', args=[document_page.id]),
'text':ugettext(u'Page %s details') % document_page.page_number})
return mark_safe(u''.join(output))
output.append(
'<br/><a href="%(url)s"><span class="famfam active famfam-page_white"></span>%(text)s</a>' % {
'url': reverse('document_page_view', args=[document_page.id]),
'text': ugettext(u'Page %s details') % document_page.page_number})
return mark_safe(u''.join(output))
#TODO: Turn this into a base form and let others inherit
@@ -108,7 +114,7 @@ class DocumentPreviewForm(forms.Form):
super(DocumentPreviewForm, self).__init__(*args, **kwargs)
self.fields['preview'].initial = self.document
self.fields['preview'].widget.attrs['hide_detail_link'] = self.hide_detail_link
preview = forms.CharField(widget=ImageWidget())
@@ -118,21 +124,23 @@ class DocumentContentForm(forms.Form):
super(DocumentContentForm, self).__init__(*args, **kwargs)
page_break_template = u'\n\n\n------------------ %s ------------------\n\n\n' % _(u'page break')
self.fields['contents'].initial = page_break_template.join([page.content for page in self.document.documentpage_set.all() if page.content])
contents = forms.CharField(label=_(u'Contents'), widget=forms.widgets.Textarea(attrs={'rows':24, 'cols':80}))
contents = forms.CharField(
label=_(u'Contents'),
widget=forms.widgets.Textarea(attrs={'rows': 24, 'cols': 80}))
class DocumentForm_view(DetailForm):
class Meta:
model = Document
exclude = ('file',)
class DocumentForm_edit(DocumentForm):
class Meta:
model = Document
exclude = ('file', 'document_type')
new_filename = forms.CharField(label=_(u'New document filename'), required=False)
@@ -143,7 +151,7 @@ class StagingDocumentForm(forms.Form):
self.fields['staging_file_id'].choices = [(staging_file.id, staging_file) for staging_file in StagingFile.get_all()]
except:
pass
if 'initial' in kwargs:
if 'document_type' in kwargs['initial']:
filenames_qs = kwargs['initial']['document_type'].documenttypefilename_set.filter(enabled=True)
@@ -152,7 +160,7 @@ class StagingDocumentForm(forms.Form):
queryset=filenames_qs,
required=False,
label=_(u'Quick document rename'))
staging_file_id = forms.ChoiceField(label=_(u'Staging file'))
@@ -163,12 +171,12 @@ class DocumentTypeSelectForm(forms.Form):
class MetadataForm(forms.Form):
def __init__(self, *args, **kwargs):
super(MetadataForm, self).__init__(*args, **kwargs)
#Set form fields initial values
if 'initial' in kwargs:
self.metadata_type = kwargs['initial'].pop('metadata_type', None)
self.document_type = kwargs['initial'].pop('document_type', None)
required = self.document_type.documenttypemetadatatype_set.get(metadata_type=self.metadata_type).required
required_string = u''
if required:
@@ -177,7 +185,7 @@ class MetadataForm(forms.Form):
else:
#TODO: FIXME: not working correctly
self.fields['value'].required = False
self.fields['name'].initial = '%s%s' % ((self.metadata_type.title if self.metadata_type.title else self.metadata_type.name), required_string)
self.fields['id'].initial = self.metadata_type.id
if self.metadata_type.default:
@@ -192,31 +200,32 @@ class MetadataForm(forms.Form):
self.fields['value'] = forms.ChoiceField(label=self.fields['value'].label)
choices = zip(choices, choices)
if not required:
choices.insert(0,('', '------'))
choices.insert(0, ('', '------'))
self.fields['value'].choices = choices
self.fields['value'].required = required
except Exception, err:
self.fields['value'].initial = err
self.fields['value'].widget = forms.TextInput(attrs={'readonly':'readonly'})
self.fields['value'].widget = forms.TextInput(attrs={'readonly': 'readonly'})
id = forms.CharField(label=_(u'id'), widget=forms.HiddenInput)
name = forms.CharField(label=_(u'Name'),
required=False, widget=forms.TextInput(attrs={'readonly':'readonly'}))
required=False, widget=forms.TextInput(attrs={'readonly': 'readonly'}))
value = forms.CharField(label=_(u'Value'), required=False)
MetadataFormSet = formset_factory(MetadataForm, extra=0)
class DocumentCreateWizard(BoundFormWizard):
def _generate_metadata_initial_values(self):
initial=[]
def generate_metadata_initial_values(self):
initial = []
for item in DocumentTypeMetadataType.objects.filter(document_type=self.document_type):
initial.append({
'metadata_type':item.metadata_type,
'document_type':self.document_type,
'metadata_type': item.metadata_type,
'document_type': self.document_type,
})
return initial
def __init__(self, *args, **kwargs):
self.urldata = []
self.multiple = kwargs.pop('multiple', True)
self.step_titles = kwargs.pop('step_titles', [
_(u'step 1 of 2: Document type'),
@@ -227,29 +236,26 @@ class DocumentCreateWizard(BoundFormWizard):
super(DocumentCreateWizard, self).__init__(*args, **kwargs)
if self.document_type:
self.initial = {0:self._generate_metadata_initial_values()}
self.initial = {0: self.generate_metadata_initial_values()}
def render_template(self, request, form, previous_fields, step, context=None):
context = {'step_title':self.extra_context['step_titles'][step]}
context = {'step_title': self.extra_context['step_titles'][step]}
return super(DocumentCreateWizard, self).render_template(request, form, previous_fields, step, context)
def parse_params(self, request, *args, **kwargs):
self.extra_context = {'step_titles':self.step_titles}
self.extra_context = {'step_titles': self.step_titles}
def process_step(self, request, form, step):
#if step == 0:
if isinstance(form, DocumentTypeSelectForm):
self.document_type = form.cleaned_data['document_type']
self.initial = {1:self._generate_metadata_initial_values()}
self.initial = {1: self.generate_metadata_initial_values()}
#if step == 1:
if isinstance(form, MetadataFormSet):
self.urldata = []
for id, metadata in enumerate(form.cleaned_data):
for identifier, metadata in enumerate(form.cleaned_data):
if metadata['value']:
self.urldata.append(('metadata%s_id' % id, metadata['id']))
self.urldata.append(('metadata%s_value' % id, metadata['value']))
self.urldata.append(('metadata%s_id' % identifier, metadata['id']))
self.urldata.append(('metadata%s_value' % identifier, metadata['value']))
def get_template(self, step):
return 'generic_wizard.html'

37
apps/documents/metadata.py
View File

@@ -1,3 +1,6 @@
'''Metadata handling commonalities
'''
from urllib import unquote_plus
from django.shortcuts import get_object_or_404
@@ -7,6 +10,8 @@ from django.core.exceptions import ObjectDoesNotExist
from models import DocumentMetadata, MetadataType
def decode_metadata_from_url(url_dict):
'''Parses a URL query string to a list of metadata
'''
metadata_dict = {
'id':{},
'value':{}
@@ -19,14 +24,19 @@ def decode_metadata_from_url(url_dict):
metadata_dict[element][index] = value
#Convert the nested dictionary into a list of id+values dictionaries
for order, id in metadata_dict['id'].items():
for order, identifier in metadata_dict['id'].items():
if order in metadata_dict['value'].keys():
metadata_list.append({'id':id, 'value':metadata_dict['value'][order]})
metadata_list.append({
'id':identifier,
'value':metadata_dict['value'][order]
})
return metadata_list
def save_metadata_list(metadata_list, document):
'''Takes a list of metadata values and associates a document to it
'''
for item in metadata_list:
if item['value']:
save_metadata(item, document)
@@ -35,36 +45,49 @@ def save_metadata_list(metadata_list, document):
#completely from the document
try:
metadata_type = MetadataType.objects.get(id=item['id'])
document_metadata = DocumentMetadata.objects.get(document=document,
metadata_type=metadata_type)
document_metadata = DocumentMetadata.objects.get(
document=document,
metadata_type=metadata_type
)
document_metadata.delete()
except ObjectDoesNotExist:
pass
def save_metadata(metadata_dict, document):
'''save metadata_dict
'''
#Use matched metadata now to create document metadata
document_metadata, created = DocumentMetadata.objects.get_or_create(
document=document,
metadata_type=get_object_or_404(MetadataType, pk=metadata_dict['id']),
metadata_type=get_object_or_404(
MetadataType,
pk=metadata_dict['id']
),
)
#Handle 'plus sign as space' in the url
#unquote_plus handles utf-8?!?
#http://stackoverflow.com/questions/4382875/handling-iri-in-django
document_metadata.value = unquote_plus(metadata_dict['value'])#.decode('utf-8')
#.decode('utf-8')
document_metadata.value = unquote_plus(metadata_dict['value'])
document_metadata.save()
def metadata_repr(metadata_list):
'''Return a printable representation of a metadata list
'''
return ', '.join(metadata_repr_as_list(metadata_list))
def metadata_repr_as_list(metadata_list):
'''Turn a list of metadata into a list of printable representations
'''
output = []
for metadata_dict in metadata_list:
try:
output.append('%s - %s' % (MetadataType.objects.get(pk=metadata_dict['id']), metadata_dict.get('value', '')))
output.append('%s - %s' % (MetadataType.objects.get(
pk=metadata_dict['id']), metadata_dict.get('value', '')))
except:
pass

85
apps/documents/models.py
View File

@@ -22,6 +22,7 @@ from documents.conf.settings import STORAGE_BACKEND
from documents.conf.settings import AVAILABLE_TRANSFORMATIONS
from documents.conf.settings import DEFAULT_TRANSFORMATIONS
def get_filename_from_uuid(instance, filename):
filename, extension = os.path.splitext(filename)
instance.file_filename = filename
@@ -30,19 +31,18 @@ def get_filename_from_uuid(instance, filename):
uuid = UUID_FUNCTION()
instance.uuid = uuid
return uuid
class DocumentType(models.Model):
name = models.CharField(max_length=32, verbose_name=_(u'name'))
name = models.CharField(max_length=32, verbose_name=_(u'name'))
def __unicode__(self):
return self.name
class Document(models.Model):
""" Minimum fields for a document entry.
Inherit this model to customise document metadata, see BasicDocument for an example.
"""
''' Minimum fields for a document entry.
'''
document_type = models.ForeignKey(DocumentType, verbose_name=_(u'document type'))
file = models.FileField(upload_to=get_filename_from_uuid, storage=STORAGE_BACKEND(), verbose_name=_(u'file'))
uuid = models.CharField(max_length=48, default=UUID_FUNCTION(), blank=True, editable=False)
@@ -55,16 +55,14 @@ class Document(models.Model):
date_updated = models.DateTimeField(verbose_name=_(u'updated'), auto_now=True)
checksum = models.TextField(blank=True, null=True, verbose_name=_(u'checksum'), editable=False)
description = models.TextField(blank=True, null=True, verbose_name=_(u'description'), db_index=True)
class Meta:
verbose_name = _(u'document')
verbose_name_plural = _(u'documents')
ordering = ['-date_added']
def __unicode__(self):
return '%s.%s' % (self.file_filename, self.file_extension)
def save(self, *args, **kwargs):
new_document = not self.pk
@@ -79,11 +77,9 @@ class Document(models.Model):
self.update_page_count(save=False)
self.apply_default_transformations()
def get_fullname(self):
return os.extsep.join([self.file_filename, self.file_extension])
def update_mimetype(self, save=True):
if self.exists():
try:
@@ -102,17 +98,14 @@ class Document(models.Model):
source.close()
if save:
self.save()
def open(self):
return self.file.storage.open(self.file.path)
@models.permalink
def get_absolute_url(self):
return ('document_view_simple', [self.id])
def update_checksum(self, save=True):
if self.exists():
source = self.open()
@@ -121,15 +114,14 @@ class Document(models.Model):
if save:
self.save()
def update_page_count(self, save=True):
handle, filepath = tempfile.mkstemp()
self.save_to_file(filepath)
total_pages = get_page_count(filepath)
for page_number in range(total_pages):
DocumentPage.objects.get_or_create(
document=self, page_number=page_number+1)
document=self, page_number=page_number + 1)
os.close(handle)
try:
@@ -140,8 +132,7 @@ class Document(models.Model):
if save:
self.save()
def save_to_file(self, filepath, buffer_size=1024*1024):
def save_to_file(self, filepath, buffer_size=1024 * 1024):
input_descriptor = self.open()
output_descriptor = open(filepath, 'wb')
while True:
@@ -150,16 +141,14 @@ class Document(models.Model):
output_descriptor.write(copy_buffer)
else:
break
output_descriptor.close()
input_descriptor.close()
return filepath
return filepath
def exists(self):
return self.file.storage.exists(self.file.path)
def get_metadata_groups(self):
errors = []
metadata_groups = {}
@@ -167,7 +156,7 @@ class Document(models.Model):
metadata_dict = {}
for document_metadata in self.documentmetadata_set.all():
metadata_dict['metadata_%s' % document_metadata.metadata_type.name] = document_metadata.value
for group in MetadataGroup.objects.filter((Q(document_type=self.document_type) | Q(document_type=None)) & Q(enabled=True)):
total_query = Q()
for item in group.metadatagroupitem_set.filter(enabled=True):
@@ -194,26 +183,25 @@ class Document(models.Model):
metadata_groups[group] = Document.objects.filter(Q(id__in=document_id_list)).order_by('file_filename') or []
return metadata_groups, errors
def apply_default_transformations(self):
#Only apply default transformations on new documents
if DEFAULT_TRANSFORMATIONS and reduce(lambda x, y : x+y, [page.documentpagetransformation_set.count() for page in self.documentpage_set.all()]) == 0:
if DEFAULT_TRANSFORMATIONS and reduce(lambda x, y: x + y, [page.documentpagetransformation_set.count() for page in self.documentpage_set.all()]) == 0:
for transformation in DEFAULT_TRANSFORMATIONS:
if 'name' in transformation:
for document_page in self.documentpage_set.all():
page_transformation = DocumentPageTransformation(
document_page=document_page,
order=0,
order=0,
transformation=transformation['name'])
if 'arguments' in transformation:
page_transformation.arguments = transformation['arguments']
page_transformation.save()
available_functions_string = (_(u' Available functions: %s') % ','.join(['%s()' % name for name, function in AVAILABLE_FUNCTIONS.items()])) if AVAILABLE_FUNCTIONS else ''
available_models_string = (_(u' Available models: %s') % ','.join([name for name, model in AVAILABLE_MODELS.items()])) if AVAILABLE_MODELS else ''
class MetadataType(models.Model):
name = models.CharField(max_length=48, verbose_name=_(u'name'), help_text=_(u'Do not use python reserved words.'))
title = models.CharField(max_length=48, verbose_name=_(u'title'), blank=True, null=True)
@@ -224,10 +212,10 @@ class MetadataType(models.Model):
verbose_name=_(u'lookup'),
help_text=_(u'Enter a string to be evaluated. Example: [user.get_full_name() for user in User.objects.all()].%s') % available_models_string)
#TODO: datatype?
def __unicode__(self):
return self.title if self.title else self.name
class Meta:
verbose_name = _(u'metadata type')
verbose_name_plural = _(u'metadata types')
@@ -238,7 +226,7 @@ class DocumentTypeMetadataType(models.Model):
metadata_type = models.ForeignKey(MetadataType, verbose_name=_(u'metadata type'))
required = models.BooleanField(default=True, verbose_name=_(u'required'))
#TODO: override default for this document type
def __unicode__(self):
return unicode(self.metadata_type)
@@ -247,19 +235,19 @@ class DocumentTypeMetadataType(models.Model):
verbose_name_plural = _(u'document type metadata type connectors')
available_indexing_functions_string = (_(u' Available functions: %s') % ','.join(['%s()' % name for name, function in AVAILABLE_INDEXING_FUNCTIONS.items()])) if AVAILABLE_INDEXING_FUNCTIONS else ''
class MetadataIndex(models.Model):
document_type = models.ForeignKey(DocumentType, verbose_name=_(u'document type'))
expression = models.CharField(max_length=128,
verbose_name=_(u'indexing expression'),
help_text=_(u'Enter a python string expression to be evaluated. The slash caracter "/" acts as a directory delimiter.%s') % available_indexing_functions_string)
enabled = models.BooleanField(default=True, verbose_name=_(u'enabled'))
def __unicode__(self):
return unicode(self.expression)
class Meta:
verbose_name = _(u'metadata index')
verbose_name_plural = _(u'metadata indexes')
@@ -269,7 +257,7 @@ class DocumentMetadata(models.Model):
document = models.ForeignKey(Document, verbose_name=_(u'document'))
metadata_type = models.ForeignKey(MetadataType, verbose_name=_(u'metadata type'))
value = models.TextField(blank=True, null=True, verbose_name=_(u'metadata value'), db_index=True)
def __unicode__(self):
return unicode(self.metadata_type)
@@ -282,7 +270,7 @@ class DocumentTypeFilename(models.Model):
document_type = models.ForeignKey(DocumentType, verbose_name=_(u'document type'))
filename = models.CharField(max_length=128, verbose_name=_(u'filename'), db_index=True)
enabled = models.BooleanField(default=True, verbose_name=_(u'enabled'))
def __unicode__(self):
return self.filename
@@ -297,7 +285,7 @@ class DocumentPage(models.Model):
content = models.TextField(blank=True, null=True, verbose_name=_(u'content'), db_index=True)
page_label = models.CharField(max_length=32, blank=True, null=True, verbose_name=_(u'page label'))
page_number = models.PositiveIntegerField(default=1, editable=False, verbose_name=_(u'page number'))
def __unicode__(self):
return '%s - %d - %s' % (unicode(self.document), self.page_number, self.page_label)
@@ -312,13 +300,13 @@ class MetadataGroup(models.Model):
name = models.CharField(max_length=32, verbose_name=_(u'name'))
label = models.CharField(max_length=32, verbose_name=_(u'label'))
enabled = models.BooleanField(default=True, verbose_name=_(u'enabled'))
def __unicode__(self):
return self.label if self.label else self.name
class Meta:
verbose_name = _(u'metadata document group')
verbose_name_plural = _(u'metadata document groups')
verbose_name_plural = _(u'metadata document groups')
INCLUSION_AND = '&'
@@ -346,7 +334,8 @@ OPERATOR_CHOICES = (
('regex', _(u'is in regular expression')),
('iregex', _(u'is in regular expression (case insensitive)')),
)
class MetadataGroupItem(models.Model):
metadata_group = models.ForeignKey(MetadataGroup, verbose_name=_(u'metadata group'))
inclusion = models.CharField(default=INCLUSION_AND, max_length=16, choices=INCLUSION_CHOICES, help_text=_(u'The inclusion is ignored for the first item.'))
@@ -356,7 +345,7 @@ class MetadataGroupItem(models.Model):
verbose_name=_(u'expression'), help_text=_(u'This expression will be evaluated against the current selected document. The document metadata is available as variables of the same name but with the "metadata_" prefix added their name.'))
negated = models.BooleanField(default=False, verbose_name=_(u'negated'), help_text=_(u'Inverts the logic of the operator.'))
enabled = models.BooleanField(default=True, verbose_name=_(u'enabled'))
def __unicode__(self):
return '[%s] %s %s %s %s %s' % ('x' if self.enabled else ' ', self.get_inclusion_display(), self.metadata_type, _(u'not') if self.negated else '', self.get_operator_display(), self.expression)
@@ -367,7 +356,7 @@ class MetadataGroupItem(models.Model):
available_transformations = ([(name, data['label']) for name, data in AVAILABLE_TRANSFORMATIONS.items()]) if AVAILABLE_MODELS else []
class DocumentPageTransformation(models.Model):
document_page = models.ForeignKey(DocumentPage, verbose_name=_(u'document page'))
order = models.PositiveIntegerField(default=0, blank=True, null=True, verbose_name=_(u'order'), db_index=True)
@@ -381,7 +370,7 @@ class DocumentPageTransformation(models.Model):
ordering = ('order',)
verbose_name = _(u'document page transformation')
verbose_name_plural = _(u'document page transformations')
register(Document, _(u'document'), ['document_type__name', 'file_mimetype', 'file_filename', 'file_extension', 'documentmetadata__value', 'documentpage__content', 'description'])
#register(Document, _(u'document'), ['document_type__name', 'file_mimetype', 'file_extension', 'documentmetadata__value', 'documentpage__content', 'description', {'field_name':'file_filename', 'comparison':'iexact'}])

497
apps/documents/views.py
View File

File diff suppressed because it is too large Load Diff