bug #15 - add dashboard/ root to the main controller, and associated template and methods in the dbapi

pboard/pboard/controllers/root.py

@@ -90,6 +90,18 @@ class RootController(BaseController):
         flash(_('We hope to see you soon!'))
         redirect(came_from)
         
+    @expose('pboard.templates.dashboard')
+    @require(predicates.in_group('user', msg=l_('Please login to access this page')))
+    def dashboard(self):
+      loCurrentUser   = pld.PODStaticController.getCurrentUser()
+      loApiController = pld.PODUserFilteredApiController(loCurrentUser.user_id)
+
+      loLastModifiedNodes = loApiController.getLastModifiedNodes(10)
+      loWhatsHotNodes     = loApiController.getNodesByStatus('hot', 5)
+      loActionToDoNodes   = loApiController.getNodesByStatus('actiontodo', 5)
+      return dict(last_modified_nodes=loLastModifiedNodes, whats_hot_nodes=loWhatsHotNodes, action_to_do_nodes = loActionToDoNodes)
+
+
     @expose('pboard.templates.document')
     @require(predicates.in_group('user', msg=l_('Please login to access this page')))
     def document(self, node=0, came_from=lurl('/')):

pboard/pboard/lib/dbapi.py

@@ -46,6 +46,7 @@ class PODUserFilteredApiController(object):
     self._iExtraUserIdList     = piExtraUserIdList
     self._iUserIdFilteringList = None
   
+
   def _getUserIdListForFiltering(self):
     if self._iUserIdFilteringList==None:
       self._iUserIdFilteringList = list()
@@ -54,6 +55,7 @@ class PODUserFilteredApiController(object):
         self._iUserIdFilteringList.append(liUserId)
     return self._iUserIdFilteringList
 
+
   def createNode(self):
     loNode          = pbmd.PBNode()
     loNode.owner_id = self._iCurrentUserId
@@ -62,12 +64,14 @@ class PODUserFilteredApiController(object):
   
     query.filter(User.name.in_(['ed', 'wendy', 'jack']))
 
+
   def createDummyNode(self):
     loNewNode = self.createNode()
     loNewNode.data_label   = 'New document'
     loNewNode.data_content = 'insert content...'
     return loNewNode
 
+
   def getNode(self, liNodeId):
     liOwnerIdList = self._getUserIdListForFiltering()
     if liNodeId==0:
@@ -75,6 +79,20 @@ class PODUserFilteredApiController(object):
     else:
       return DBSession.query(pbmd.PBNode).options(joinedload_all("_lAllChildren")).filter(pbmd.PBNode.node_id==liNodeId).filter(pbmd.PBNode.owner_id.in_(liOwnerIdList)).one()
 
+
+  def getLastModifiedNodes(self, piMaxNodeNb):
+    """
+    Returns a list of nodes order by modification time and limited to piMaxNodeNb nodes
+    """
+    liOwnerIdList = self._getUserIdListForFiltering()
+    return DBSession.query(pbmd.PBNode).options(joinedload_all("_lAllChildren")).filter(pbmd.PBNode.owner_id.in_(liOwnerIdList)).order_by(pbmd.PBNode.updated_at.desc()).limit(piMaxNodeNb).all()
+
+
+  def getNodesByStatus(self, psNodeStatus, piMaxNodeNb=5):
+    liOwnerIdList = self._getUserIdListForFiltering()
+    return DBSession.query(pbmd.PBNode).options(joinedload_all("_lAllChildren")).filter(pbmd.PBNode.owner_id.in_(liOwnerIdList)).filter(pbmd.PBNode.node_status==psNodeStatus).order_by(pbmd.PBNode.updated_at).limit(piMaxNodeNb).all()
+
+
   def buildTreeListForMenu(self):
     liOwnerIdList = self._getUserIdListForFiltering()
     

pboard/pboard/model/data.py

@@ -263,8 +263,24 @@ class PBNode(DeclarativeBase):
     else:
       return laIconClass[self.node_type]
       
-      
-  def getFormattedDateTime(self, poDateTime, psDateTimeFormat = '%d/%m/%Y @ %H:%M'):
+  def getUserFriendlyNodeType(self):
+    laNodeTypesLng = dict()
+    laNodeTypesLng['node']   = 'Document' # FIXME - D.A. - 2013-11-14 - Make text translatable
+    laNodeTypesLng['folder'] = 'Document'
+    laNodeTypesLng['data']   = 'Document'
+
+    laNodeTypesLng['file']   = 'File'
+    laNodeTypesLng['event']  = 'Event'
+    laNodeTypesLng['contact'] = 'Contact'
+    laNodeTypesLng['comment'] = 'Comment'
+
+    if self.node_type==PBNodeType.Data and self.getStaticChildNb()>0:
+      return laNodeTypesLng['folder']
+    else:
+      return laNodeTypesLng[self.node_type]
+
+    
+  def getFormattedDateTime(self, poDateTime, psDateTimeFormat = '%d/%m/%Y ~ %H:%M'):
     return poDateTime.strftime(psDateTimeFormat)
 
   def getFormattedDate(self, poDateTime, psDateTimeFormat = '%d/%m/%Y'):

pboard/pboard/templates/dashboard.mak

@@ -0,0 +1,109 @@
+<%inherit file="local:templates.master"/>
+<%namespace name="POD" file="pboard.templates.pod"/>
+
+<%def name="title()">
+pod > dashobard
+</%def>
+
+  <div class="row">
+    <div class="container-fluid">
+      <div class="row-fluid">
+        <div class="span6">
+          ## LEFT PANEL OF THE DASHBOARD
+          <div id='whats-hot-panel' class="well">
+            ## WHAT'S HOT PANEL
+            <h3><i class="fa fa-warning pod-red"></i> ${_("What's hot!")}</h3>
+            % if len(whats_hot_nodes)<=0:
+              <p>${_("No hot stuff for today.")}</p>
+            % else:
+              <ul>
+              % for node in whats_hot_nodes:
+                <li title="${node.data_label}">
+                  <i class="${node.getIconClass()}" title="${node.getUserFriendlyNodeType()}"></i> 
+                % if node.node_type=='data' or node.parent_id==None:
+                  <a href="${tg.url('/document/%i'%node.node_id)}">
+                % else:
+                  <a href="${tg.url('/document/%i#tab-%ss'%(node.parent_id, node.node_type))}">
+                % endif
+                    ${node.getTruncatedLabel(70)}
+                  </a>
+                    <span title="${_('last modification')}" class="pull-right label">
+                     ${node.getFormattedDateTime(node.updated_at)}
+                    </span>
+                </li>
+              % endfor
+              </ul>
+            % endif
+            ## WHAT'S HOT PANEL [END]
+          </div>
+
+          <div id='action-to-do-documents-panel' class="well">
+            ## DOCUMENTS REQUIRING ACTIONS PANEL
+            <h3><i class="pod-blue fa fa-gears"></i> ${_("Actions to do")}</h3>
+            % if len(action_to_do_nodes)<=0:
+              <p>${_("No document requiring action.")}</p>
+            % else:
+              <ul>
+              % for node in action_to_do_nodes:
+                <li title="${node.data_label}">
+                  <i class="${node.getIconClass()}" title="${node.getUserFriendlyNodeType()}"></i> 
+                % if node.node_type=='data' or node.parent_id==None:
+                  <a href="${tg.url('/document/%i'%node.node_id)}">
+                % else:
+                  <a href="${tg.url('/document/%i#tab-%ss'%(node.parent_id, node.node_type))}">
+                % endif
+                    ${node.getTruncatedLabel(70)}
+                  </a>
+                    <span title="${_('last modification')}" class="pull-right label">
+                     ${node.getFormattedDateTime(node.updated_at)}
+                    </span>
+                </li>
+              % endfor
+              </ul>
+            % endif
+            ## DOCUMENTS REQUIRING ACTIONS PANEL [END]
+          </div>
+
+          ## LEFT PANEL OF THE DASHBOARD [END]
+        </div>
+        <div class="span6">
+          ## RIGHT PANEL OF THE DASHBOARD
+          <div id='last-modified-documents-panel' class="well">
+            <h3><i style="color: #999;" class="fa fa-clock-o"></i> ${_("Latest operations")}</h3>
+            % if len(last_modified_nodes)<=0:
+              <p>${_("No activity found")}</p>
+            % else:
+              <table class="table table-condensed table-hover">
+              % for node in last_modified_nodes:
+                <tr title="${node.data_label}">
+                  <td>${node.getFormattedDateTime(node.updated_at)}</td>
+                  <td title="${node.getUserFriendlyNodeType()}">
+                    <i class="${node.getIconClass()}"></i> 
+                  </td>
+                  <td>
+                  % if node.node_type=='data' or node.parent_id==None:
+                    <a href="${tg.url('/document/%i'%node.node_id)}">
+                  % else:
+                    <a href="${tg.url('/document/%i#tab-%ss'%(node.parent_id, node.node_type))}">
+                  % endif
+                      ${node.getTruncatedLabel(35)}
+                    </a>
+                  </td>
+                  <td>
+                  % if node.updated_at==node.created_at:
+                    <span class="label label-success">${_("created")}</span>
+                  % else:
+                    <span class="label label-info">${_("updated")}</span>
+                  % endif
+                  </td>
+                </tr>
+              % endfor
+              </table>
+            % endif
+          </div>
+          ## RIGHT PANEL OF THE DASHBOARD [END]
+        </div>
+      </div>
+    </div>
+  </div>
+

pboard/pboard/templates/master.mak

@@ -78,14 +78,17 @@ h3:Hover div.pod-toolbar {
   visibility: visible;
 }
 
+.pod-blue {color: #3a87ad !important; }
+.pod-red {color: #F00 !important; }
+
 body { padding-top: 60px; }
 @media screen and (max-width: 768px) {
     body { padding-top: 0px; }
 }
 
-ul.nav li.dropdown:hover > ul.dropdown-menu {
-    display: block;
-}
+## ul.nav li.dropdown:hover > ul.dropdown-menu {
+##     display: block;
+## }
 
     </style>
 </head>