From 661a63030b5b487abe7fa31107c121716ebbd3ad Mon Sep 17 00:00:00 2001
From: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
Date: Mon, 12 Jan 2015 01:50:44 -0400
Subject: [PATCH] Add tool to show list of documents with empty metadata that
 is required for their type. Issue #34.

---
 .../main/static/main/icons/to_do_list.png     | Bin 0 -> 1564 bytes
 mayan/apps/metadata/__init__.py               |   5 ++-
 mayan/apps/metadata/links.py                  |   2 ++
 mayan/apps/metadata/urls.py                   |   2 ++
 mayan/apps/metadata/views.py                  |  31 +++++++++++++++++-
 5 files changed, 38 insertions(+), 2 deletions(-)
 create mode 100644 mayan/apps/main/static/main/icons/to_do_list.png

diff --git a/mayan/apps/main/static/main/icons/to_do_list.png b/mayan/apps/main/static/main/icons/to_do_list.png
new file mode 100644
index 0000000000000000000000000000000000000000..0b4ab11c035f1b4d3b5be3ff2e84c66ed3e8182d
GIT binary patch
literal 1564
zcmV+%2IKjOP)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F80000PbVXQnQ*UN;
zcVTj606}DLVr3vnZDD6+Qe|Oed2z{QJOBU%zDYzuRCwC7SA9%XWgLFax#wQIhNc-@
zKvY;@NT3cOP2}oY8<efh>C~}SQb~;RBiA1}+sb9Gx&A0DWX{r<fJX6Qb57QD(EO;t
zMUe=)z@^A%VsO1*=cC_y?mdV5rE>4=-F`be=e*~Ap5OEPc;CYT5WcUkZve-wR%96p
z!X4}j4m`&}lBCA<>(;HK2V#hcruKbjoQmYe;+^?Xbnnt$Od|ry!x#et14>m*O&zUi
z2n6rk+pPTE*r!~s=~h~I)iTy5sMLX&@9OFX*RENEp5E&u1Q(wFih|^%c{o~Kjh71x
z(cj;Xvn?&ng&Q_J=T*XVq^jEauYC;9o1Vp(-G=eI4otb;iKjm+isBgwO?IB=RWle2
zlQM0->Iq#(NADmmE)J`#D_0(`Yxs*EPd!|D%$c2)g|#ofgzElUxW`;@*qo5vPWIU&
zystORd$u6EPR6vknv~|LW{mtZiugDStgG_p{JJB~7BzJSrca-VtKHXNc`OFU#~U%L
zuM5k*ELq0B69Nf@8v@_?Q6>uOqb7_xfNLK-ffd_cMfRL|_@b%>g4>2GSFS)J(U+7L
zTWR`DGFt!vK4Jo?sq;}?TTc;>#=NsdSh4jLAfXsIzZ-9hwb*fUH+a(&eE!MD47`VI
zkX3>(QA#Y1;VZzxFg9jG&XO$E&TXHA+${`zGjL%KaP=hVY(~y#4GPOH`GHS_z?+2z
zpZNM_`TZr}ao6d_U0Foe`*UF>*(bnH(4ssJwWnh9{&PX#K{=phwTA$wGGhcZ3kA*@
zjNpvXxV$S7)~y6SyVwKXP2jwYgKbH8vm!Kj2m%K5_V!?8WJo2zc+8p=gXH97$kZi$
z6=C@Tg9#kP{PNC(0PsedA))-|*+?kd4^%vJGZeUr>31XW7#<l$etrR!(Ml}I&Y`jz
zfk7}pFbY0qgb-zh!OXyCBQMZ%MMT;8Sd@O%0mXisEj=CzJXir1e{Vv_lB{~o0>M+$
zIYyl>B_&0Do4qs_-`4$r1+Ck?;G2EG-6*?Y!KSafJnM+g`=*d^ubS3#fk{rbVdF-q
zG2sM~-9+HqyxGn?|Hu!#=x`S#yB&x&L-B@gQUutDjkTbusY&l{F|n~~+*LIwM>yjY
zw7+AaCR0S<Zv=tAc7%aDph!${^8?E`s1eP7G7V`9o>HAv)KExlo27dKr=;sScNDR!
z$@8Rlf#w|qeo{?12LAdt4BQ2_<#L!@Kk*}AAOhXpT^Jf1oKV1GL262>ny<Xkggd<#
zv1rpCh}TIahaH0ALfORx6ju_sLj)(gJ(<l#K!C-4fVR_uf&$nb4%loqTxx5>g0yt1
z5F>6}sz+K9?XWjaLK*7B@7=@r<u?o7B5+Y;6eV?6lqb``LWY2!s7e-dwg_{?NM%=5
zU4zb_D#1lf!<PIXapvqF7@58t*;~qR;rvC)c9)(jOP4Ow`$m{KfS@X1jxb(XX^-RJ
zAsIPyhjC}-daVESFl9J-O697^lDBJm`nsC1k%WK+Jw84Gr%#{uq!2B_?%BExCz`N-
z?=~!6{sP<tEV@Jjlz;%K6*ikgqy#u*WM*LDqJ?@6OXLl!g7-e$rxJ0wMQ?aQORQ#p
z7#pe|0fDssv!esIZr$=xARg)I=~RxQwmnkE^lU@{heJJvYVJfrfW^J9ug|Xv+FDzY
znVG4+({@E(?TDP7=@T0irzc`W3V7nC1XO{?mjee5s6_Je@=#GxfsBj{9h{lfYDIZ@
zx%xaeH#f2})RffJ@b$8^v{VNyDJcm$nloc_^tK&Q64FRaOvI^Er}PEby{3pB-w=xj
zJ`az8&txVuvruQhdw~Z6`W@>YKt#~x4)X{e&Y|^z1Zdgux`u{m*}L~Yl)-s^Sc&xb
zeW#JlAWJ5jiLhG8q<@`ndk>_e_ab0q|7hCZ>i;m<$;3wH4)yXs0R{jfX2dji{D2k!
O0000<MNUMnLSTY9EbuV^

literal 0
HcmV?d00001

diff --git a/mayan/apps/metadata/__init__.py b/mayan/apps/metadata/__init__.py
index 2a8845d3c8..97f1aebc90 100644
--- a/mayan/apps/metadata/__init__.py
+++ b/mayan/apps/metadata/__init__.py
@@ -14,6 +14,7 @@ from documents.signals import post_document_type_change
 from navigation.api import register_links, register_model_list_columns
 from navigation.links import link_spacer
 from project_setup.api import register_setup
+from project_tools.api import register_tool
 from rest_api.classes import APIEndPoint
 
 from .api import get_metadata_string
@@ -24,7 +25,8 @@ from .links import (metadata_add, metadata_edit, metadata_multiple_add,
                     setup_document_type_metadata,
                     setup_document_type_metadata_required,
                     setup_metadata_type_create, setup_metadata_type_delete,
-                    setup_metadata_type_edit, setup_metadata_type_list)
+                    setup_metadata_type_edit, setup_metadata_type_list,
+                    link_documents_missing_required_metadata)
 from .models import DocumentMetadata, DocumentTypeMetadataType, MetadataType
 from .permissions import (PERMISSION_METADATA_DOCUMENT_ADD,
                           PERMISSION_METADATA_DOCUMENT_EDIT,
@@ -72,6 +74,7 @@ register_links(MetadataType, [setup_metadata_type_edit, setup_metadata_type_dele
 register_links([MetadataType, 'metadata:setup_metadata_type_list', 'metadata:setup_metadata_type_create'], [setup_metadata_type_list, setup_metadata_type_create], menu_name='secondary_menu')
 
 register_setup(setup_metadata_type_list)
+register_tool(link_documents_missing_required_metadata)
 
 class_permissions(Document, [
     PERMISSION_METADATA_DOCUMENT_ADD, PERMISSION_METADATA_DOCUMENT_EDIT,
diff --git a/mayan/apps/metadata/links.py b/mayan/apps/metadata/links.py
index c1e8e27891..eb269380f0 100644
--- a/mayan/apps/metadata/links.py
+++ b/mayan/apps/metadata/links.py
@@ -29,3 +29,5 @@ setup_metadata_type_list = {'text': _(u'Metadata types'), 'view': 'metadata:setu
 setup_metadata_type_edit = {'text': _(u'Edit'), 'view': 'metadata:setup_metadata_type_edit', 'args': 'object.pk', 'famfam': 'xhtml', 'permissions': [PERMISSION_METADATA_TYPE_EDIT]}
 setup_metadata_type_delete = {'text': _(u'Delete'), 'view': 'metadata:setup_metadata_type_delete', 'args': 'object.pk', 'famfam': 'xhtml_delete', 'permissions': [PERMISSION_METADATA_TYPE_DELETE]}
 setup_metadata_type_create = {'text': _(u'Create new'), 'view': 'metadata:setup_metadata_type_create', 'famfam': 'xhtml_add', 'permissions': [PERMISSION_METADATA_TYPE_CREATE]}
+
+link_documents_missing_required_metadata = {'text': _(u'Missing metadata'), 'view': 'metadata:documents_missing_required_metadata', 'icon': 'to_do_list.png'}
diff --git a/mayan/apps/metadata/urls.py b/mayan/apps/metadata/urls.py
index accf23142f..95128dd731 100644
--- a/mayan/apps/metadata/urls.py
+++ b/mayan/apps/metadata/urls.py
@@ -22,6 +22,8 @@ urlpatterns = patterns('metadata.views',
 
     url(r'^setup/document/type/(?P<document_type_id>\d+)/metadata/edit/$', 'setup_document_type_metadata', (), 'setup_document_type_metadata'),
     url(r'^setup/document/type/(?P<document_type_id>\d+)/metadata/edit/required/$', 'setup_document_type_metadata_required', (), 'setup_document_type_metadata_required'),
+
+    url(r'^tools/missing_required_metadata/$', 'documents_missing_required_metadata', (), 'documents_missing_required_metadata'),
 )
 
 api_urls = patterns('',
diff --git a/mayan/apps/metadata/views.py b/mayan/apps/metadata/views.py
index 884b7f80c3..c0a1d7a855 100644
--- a/mayan/apps/metadata/views.py
+++ b/mayan/apps/metadata/views.py
@@ -12,7 +12,9 @@ from django.utils.translation import ugettext_lazy as _
 
 from acls.models import AccessEntry
 from documents.models import Document, DocumentType
-from documents.permissions import PERMISSION_DOCUMENT_TYPE_EDIT
+from documents.permissions import (PERMISSION_DOCUMENT_TYPE_EDIT,
+                                   PERMISSION_DOCUMENT_VIEW)
+from documents.views import document_list
 from permissions.models import Permission
 
 from common.utils import encapsulate, generate_choices_w_labels
@@ -302,6 +304,33 @@ def metadata_view(request, document_id):
     }, context_instance=RequestContext(request))
 
 
+def documents_missing_required_metadata(request):
+    pre_object_list = Document.objects.filter(document_type__metadata__required=True, metadata__value__isnull=True)
+
+    try:
+        Permission.objects.check_permissions(request.user, [PERMISSION_DOCUMENT_VIEW])
+    except PermissionDenied:
+        # If user doesn't have global permission, get a list of document
+        # for which he/she does hace access use it to filter the
+        # provided object_list
+        object_list = AccessEntry.objects.filter_objects_by_access(
+            PERMISSION_DOCUMENT_VIEW, request.user, pre_object_list)
+    else:
+        object_list = pre_object_list
+
+    context = {
+        'object_list': object_list,
+        'title': _('Documents missing required metadata'),
+        'hide_links': True,
+    }
+
+    return document_list(
+        request,
+        #object_list=
+        extra_context=context
+    )
+
+
 # Setup views
 def setup_metadata_type_list(request):
     Permission.objects.check_permissions(request.user, [PERMISSION_METADATA_TYPE_VIEW])