controllers/grid/submissions/SubmissionsListGridCellProvider.inc.php

<?php

import('lib.pkp.classes.controllers.grid.DataObjectGridCellProvider');

class SubmissionsListGridCellProvider extends DataObjectGridCellProvider {

   var $_authorizedRoles;

   function SubmissionsListGridCellProvider($authorizedRoles = null) {
      if ($authorizedRoles) {
         $this->_authorizedRoles = $authorizedRoles;
      }

      parent::DataObjectGridCellProvider();
   }


   //
   // Getters and setters.
   //
   function getAuthorizedRoles() {
      return $this->_authorizedRoles;
   }


   //
   // Public functions.
   //
   function getCellState(&$row, &$column) {
      return '';
   }


   function getCellActions(&$request, &$row, &$column, $position = GRID_ACTION_POSITION_DEFAULT) {
      if ( $column->getId() == 'title' ) {
         $monograph =& $row->getData();

         if (is_a($monograph, 'ReviewerSubmission')) {
            // Reviewer: Add a review link action.
            return array($this->_getCellLinkAction($request, 'reviewer', 'submission', $monograph));
         } else {
            // Get the right page and operation (authordashboard or workflow).
            list($page, $operation) = SubmissionsListGridCellProvider::getPageAndOperationByUserRoles($request, $monograph);

            // Return redirect link action.
            return array($this->_getCellLinkAction($request, $page, $operation, $monograph));
         }

         // This should be unreachable code.
         assert(false);
      }
      return parent::getCellActions($request, $row, $column, $position);
   }

   //
   // Template methods from GridCellProvider
   //
   function getTemplateVarsFromRowColumn(&$row, $column) {
      $monograph =& $row->getData();
      $columnId = $column->getId();
      assert(is_a($monograph, 'DataObject') && !empty($columnId));

      $pressId = $monograph->getPressId();
      $pressDao = DAORegistry::getDAO('PressDAO');
      $press = $pressDao->getById($pressId);

      switch ($columnId) {
         case 'title':
            return array('label' => '');
            break;
         case 'press':
            return array('label' => $press->getLocalizedName());
            break;
         case 'author':
            return array('label' => $monograph->getAuthorString(true));
            break;
         case 'dateAssigned':
            assert(is_a($monograph, 'ReviewerSubmission'));
            $dateAssigned = strftime(Config::getVar('general', 'date_format_short'), strtotime($monograph->getDateAssigned()));
            if ( empty($dateAssigned) ) $dateAssigned = '--';
            return array('label' => $dateAssigned);
            break;
         case 'dateDue':
            $dateDue = strftime(Config::getVar('general', 'date_format_short'), strtotime($monograph->getDateDue()));
            if ( empty($dateDue) ) $dateDue = '--';
            return array('label' => $dateDue);
            break;
         case 'status':
            $stageId = $monograph->getStageId();
            switch ($stageId) {
               case WORKFLOW_STAGE_ID_SUBMISSION: default:
                  $returner = array('label' => __('submission.status.submission'));
                  break;
               case WORKFLOW_STAGE_ID_INTERNAL_REVIEW:
                  $returner = array('label' => __('submission.status.review'));
                  break;
               case WORKFLOW_STAGE_ID_EXTERNAL_REVIEW:
                  $returner = array('label' => __('submission.status.review'));
                  break;
               case WORKFLOW_STAGE_ID_EDITING:
                  $returner = array('label' => __('submission.status.editorial'));
                  break;
               case WORKFLOW_STAGE_ID_PRODUCTION:
                  $returner = array('label' => __('submission.status.production'));
                  break;
            }

            // Handle special cases.
            $stageAssignmentDao =& DAORegistry::getDAO('StageAssignmentDAO');
            if ($monograph->getSubmissionProgress() > 0 && $monograph->getSubmissionProgress() <= 3) {
               // Submission process not completed.
               $returner = array('label' => __('submissions.incomplete'));
            } elseif (!$stageAssignmentDao->editorAssignedToStage($monograph->getId())) {
               // No editor assigned to any submission stages.
               $returner = array('label' => __('submission.status.unassigned'));
            }

            return $returner;
      }
   }


   //
   // Public static methods
   //
   function getPageAndOperationByUserRoles(&$request, &$monograph, $userId = null) {
      if ($userId == null) {
         $user =& $request->getUser();
      } else {
         $userDao =& DAORegistry::getDAO('UserDAO');
         $user =& $userDao->getById($userId);
         if ($user == null) { // user does not exist
            return array();
         }
      }

      // This method is used to build links in componentes that lists
      // monographs from various presses, sometimes. So we need to make sure
      // that we are getting the right monograph press (not necessarily the
      // current press in request).
      $pressId = $monograph->getPressId();

      // If user is enrolled with a press manager user group, let
      // him access the workflow pages.
      $roleDao =& DAORegistry::getDAO('RoleDAO');
      $isPressManager = $roleDao->userHasRole($pressId, $user->getId(), ROLE_ID_PRESS_MANAGER);
      if($isPressManager) {
         return array('workflow', 'access');
      }

      $monographId = $monograph->getId();

      // If user has only author role user groups stage assignments,
      // then add an author dashboard link action.
      $stageAssignmentDao =& DAORegistry::getDAO('StageAssignmentDAO');
      $userGroupDao =& DAORegistry::getDAO('UserGroupDAO');

      $authorUserGroupIds = $userGroupDao->getUserGroupIdsByRoleId(ROLE_ID_AUTHOR);
      $stageAssignmentsFactory =& $stageAssignmentDao->getBySubmissionAndStageId($monographId, null, null, $user->getId());

      $authorDashboard = false;
      while ($stageAssignment =& $stageAssignmentsFactory->next()) {
         if (!in_array($stageAssignment->getUserGroupId(), $authorUserGroupIds)) {
            $authorDashboard = false;
            break;
         }
         $authorDashboard = true;
         unset($stageAssignment);
      }
      if ($authorDashboard) {
         return array('authorDashboard', 'submission');
      } else {
         return array('workflow', 'access');
      }
   }

   //
   // Private helper methods.
   //
   function _getCellLinkAction($request, $page, $operation, &$monograph) {
      $router =& $request->getRouter();
      $dispatcher =& $router->getDispatcher();

      $title = $monograph->getLocalizedTitle();
      if ( empty($title) ) $title = __('common.untitled');

      $pressId = $monograph->getPressId();
      $pressDao = DAORegistry::getDAO('PressDAO');
      $press = $pressDao->getById($pressId);

      import('lib.pkp.classes.linkAction.request.RedirectAction');

      return new LinkAction(
         'itemWorkflow',
         new RedirectAction(
            $dispatcher->url(
               $request, ROUTE_PAGE,
               $press->getPath(),
               $page, $operation,
               $monograph->getId()
            )
         ),
         $title
      );
   }
}

?>