classes/submission/form/comment/EditCommentForm.inc.php

   1 <?php
   2
   3 /**
   4  * @file classes/submission/form/comment/EditCommentForm.inc.php
   5  *
   6  * Copyright (c) 2003-2008 John Willinsky
   7  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
   8  *
   9  * @class EditCommentForm
  10  * @ingroup submission_form
  11  *
  12  * @brief Edit comment form.
  13  */
  14
  15 // $Id: EditCommentForm.inc.php,v 1.5 2009/06/09 23:37:14 tylerl Exp $
  16
  17
  18 import('form.Form');
  19
  20 class EditCommentForm extends Form {
  21
  22         /** @var object the monograph */
  23         var $monograph;
  24
  25         /** @var MonographComment the comment */
  26         var $comment;
  27
  28         /** @var int the role of the comment author */
  29         var $roleId;
  30
  31         /** @var User the user */
  32         var $user;
  33
  34         /**
  35          * Constructor.
  36          * @param $monograph object
  37          * @param $comment object
  38          */
  39         function EditCommentForm(&$monograph, &$comment) {
  40                 parent::Form('submission/comment/editComment.tpl');
  41                 $this->addCheck(new FormValidatorPost($this));
  42
  43                 $this->comment = $comment;
  44                 $this->roleId = $comment->getRoleId();
  45
  46                 $this->monograph = $monograph;
  47                 $this->user =& Request::getUser();
  48         }
  49
  50         /**
  51          * Initialize form data from current comment.
  52          */
  53         function initData() {
  54                 $comment =& $this->comment;
  55                 $this->_data = array(
  56                         'commentId' => $comment->getCommentId(),
  57                         'commentTitle' => $comment->getCommentTitle(),
  58                         'comments' => $comment->getComments(),
  59                         'viewable' => $comment->getViewable(),
  60                 );
  61         }
  62
  63         /**
  64          * Display the form.
  65          */
  66         function display($additionalHiddenParams = null) {
  67                 $hiddenFormParams = array(
  68                         'monographId' => $this->monograph->getMonographId(),
  69                         'commentId' => $this->comment->getCommentId()
  70                 );
  71                 if (isset($additionalHiddenParams)) {
  72                         $hiddenFormParams = array_merge ($hiddenFormParams, $additionalHiddenParams);
  73                 }
  74
  75                 $templateMgr =& TemplateManager::getManager();
  76
  77                 $isPeerReviewComment = $this->comment->getCommentType() == COMMENT_TYPE_PEER_REVIEW;
  78                 $templateMgr->assign('isPeerReviewComment', $isPeerReviewComment); // FIXME
  79                 $templateMgr->assign_by_ref('comment', $this->comment);
  80                 $templateMgr->assign_by_ref('hiddenFormParams', $hiddenFormParams);
  81
  82                 parent::display();
  83         }
  84
  85         /**
  86          * Assign form data to user-submitted data.
  87          */
  88         function readInputData() {
  89                 $this->readUserVars(
  90                         array(
  91                                 'commentTitle',
  92                                 'comments',
  93                                 'viewable'
  94                         )
  95                 );
  96         }
  97
  98         /**
  99          * Update the comment.
 100          */
 101         function execute() {
 102                 $commentDao =& DAORegistry::getDAO('MonographCommentDAO');
 103
 104                 // Update comment
 105                 $comment = $this->comment;
 106                 $comment->setCommentTitle($this->getData('commentTitle'));
 107                 $comment->setComments($this->getData('comments'));
 108                 $comment->setViewable($this->getData('viewable') ? 1 : 0);
 109                 $comment->setDateModified(Core::getCurrentDate());
 110
 111                 $commentDao->updateMonographComment($comment);
 112         }
 113
 114         /**
 115          * UGLEEE function that gets the recipients for a comment.
 116          * @return $recipients array of recipients (email address => name)
 117          */
 118         function emailHelper() {
 119                 $roleDao =& DAORegistry::getDAO('RoleDAO');
 120                 $userDao =& DAORegistry::getDAO('UserDAO');
 121                 $press =& Request::getPress();
 122
 123                 $recipients = array();
 124
 125                 // Get editors for monograph
 126                 $editAssignmentDao =& DAORegistry::getDAO('EditAssignmentDAO');
 127                 $editAssignments =& $editAssignmentDao->getByIdsByMonographId($this->monograph->getMonographId());
 128                 $editAssignments =& $editAssignments->toArray();
 129                 $editorAddresses = array();
 130                 foreach ($editAssignments as $editAssignment) {
 131                         $editorAddresses[$editAssignment->getEditorEmail()] = $editAssignment->getEditorFullName();
 132                 }
 133
 134                 // If no editors are currently assigned, send this message to
 135                 // all of the press's editors.
 136                 if (empty($editorAddresses)) {
 137                         $editors =& $roleDao->getUsersByRoleId(ROLE_ID_EDITOR, $press->getId());
 138                         while (!$editors->eof()) {
 139                                 $editor =& $editors->next();
 140                                 $editorAddresses[$editor->getEmail()] = $editor->getFullName();
 141                         }
 142                 }
 143
 144                 // Get proofreader
 145                 $proofAssignmentDao =& DAORegistry::getDAO('ProofAssignmentDAO');
 146                 $proofAssignment =& $proofAssignmentDao->getProofAssignmentByMonographId($this->monograph->getMonographId());
 147                 if ($proofAssignment != null && $proofAssignment->getProofreaderId() > 0) {
 148                         $proofreader =& $userDao->getUser($proofAssignment->getProofreaderId());
 149                 } else {
 150                         $proofreader = null;
 151                 }
 152
 153                 // Get layout editor
 154                 $layoutAssignmentDao =& DAORegistry::getDAO('LayoutAssignmentDAO');
 155                 $layoutAssignment =& $layoutAssignmentDao->getLayoutAssignmentByMonographId($this->monograph->getMonographId());
 156                 if ($layoutAssignment != null && $layoutAssignment->getEditorId() > 0) {
 157                         $layoutEditor =& $userDao->getUser($layoutAssignment->getEditorId());
 158                 } else {
 159                         $layoutEditor = null;
 160                 }
 161
 162                 // Get copyeditor
 163                 $copyAssignmentDao =& DAORegistry::getDAO('CopyAssignmentDAO');
 164                 $copyAssignment =& $copyAssignmentDao->getCopyAssignmentByMonographId($this->monograph->getMonographId());
 165                 if ($copyAssignment != null && $copyAssignment->getCopyeditorId() > 0) {
 166                         $copyeditor =& $userDao->getUser($copyAssignment->getCopyeditorId());
 167                 } else {
 168                         $copyeditor = null;
 169                 }
 170
 171                 // Get reviewer
 172                 $reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
 173                 $reviewAssignment =& $reviewAssignmentDao->getById($this->comment->getAssocId());
 174                 if ($reviewAssignment != null && $reviewAssignment->getReviewerId() != null) {
 175                         $reviewer =& $userDao->getUser($reviewAssignment->getReviewerId());
 176                 } else {
 177                         $reviewer = null;
 178                 }
 179
 180                 // Get author
 181                 $author =& $userDao->getUser($this->monograph->getUserId());
 182
 183                 switch ($this->comment->getCommentType()) {
 184                 case COMMENT_TYPE_PEER_REVIEW:
 185                         if ($this->roleId == ROLE_ID_EDITOR || $this->roleId == ROLE_ID_ACQUISITIONS_EDITOR) {
 186                                 // Then add reviewer
 187                                 if ($reviewer != null) {
 188                                         $recipients = array_merge($recipients, array($reviewer->getEmail() => $reviewer->getFullName()));
 189                                 }
 190                         }
 191                         break;
 192
 193                 case COMMENT_TYPE_EDITOR_DECISION:
 194                         if ($this->roleId == ROLE_ID_EDITOR || $this->roleId == ROLE_ID_ACQUISITIONS_EDITOR) {
 195                                 // Then add author
 196                                 if (isset($author)) $recipients = array_merge($recipients, array($author->getEmail() => $author->getFullName()));
 197                         } else {
 198                                 // Then add editors
 199                                 $recipients = array_merge($recipients, $editorAddresses);
 200                         }
 201                         break;
 202
 203                 case COMMENT_TYPE_COPYEDIT:
 204                         if ($this->roleId == ROLE_ID_EDITOR || $this->roleId == ROLE_ID_ACQUISITIONS_EDITOR) {
 205                                 // Then add copyeditor and author
 206                                 if ($copyeditor != null) {
 207                                         $recipients = array_merge($recipients, array($copyeditor->getEmail() => $copyeditor->getFullName()));
 208                                 }
 209
 210                                 $recipients = array_merge($recipients, array($author->getEmail() => $author->getFullName()));
 211
 212                         } else if ($this->roleId == ROLE_ID_COPYEDITOR) {
 213                                 // Then add editors and author
 214                                 $recipients = array_merge($recipients, $editorAddresses);
 215
 216                                 if (isset($author)) $recipients = array_merge($recipients, array($author->getEmail() => $author->getFullName()));
 217
 218                         } else {
 219                                 // Then add editors and copyeditor
 220                                 $recipients = array_merge($recipients, $editorAddresses);
 221
 222                                 if ($copyeditor != null) {
 223                                         $recipients = array_merge($recipients, array($copyeditor->getEmail() => $copyeditor->getFullName()));
 224                                 }
 225                         }
 226                         break;
 227                 case COMMENT_TYPE_LAYOUT:
 228                         if ($this->roleId == ROLE_ID_EDITOR || $this->roleId == ROLE_ID_ACQUISITIONS_EDITOR) {
 229                                 // Then add layout editor
 230
 231                                 // Check to ensure that there is a layout editor assigned to this monograph.
 232                                 if ($layoutEditor != null) {
 233                                         $recipients = array_merge($recipients, array($layoutEditor->getEmail() => $layoutEditor->getFullName()));
 234                                 }
 235                         } else {
 236                                 // Then add editors
 237                                 $recipients = array_merge($recipients, $editorAddresses);
 238                         }
 239                         break;
 240                 case COMMENT_TYPE_PROOFREAD:
 241                         if ($this->roleId == ROLE_ID_EDITOR || $this->roleId == ROLE_ID_ACQUISITIONS_EDITOR) {
 242                                 // Then add layout editor, proofreader and author
 243                                 if ($layoutEditor != null) {
 244                                         $recipients = array_merge($recipients, array($layoutEditor->getEmail() => $layoutEditor->getFullName()));
 245                                 }
 246
 247                                 if ($proofreader != null) {
 248                                         $recipients = array_merge($recipients, array($proofreader->getEmail() => $proofreader->getFullName()));
 249                                 }
 250
 251                                 if (isset($author)) $recipients = array_merge($recipients, array($author->getEmail() => $author->getFullName()));
 252
 253                         } else if ($this->roleId == ROLE_ID_LAYOUT_EDITOR) {
 254                                 // Then add editors, proofreader and author
 255                                 $recipients = array_merge($recipients, $editorAddresses);
 256
 257                                 if ($proofreader != null) {
 258                                         $recipients = array_merge($recipients, array($proofreader->getEmail() => $proofreader->getFullName()));
 259                                 }
 260
 261                                 if (isset($author)) $recipients = array_merge($recipients, array($author->getEmail() => $author->getFullName()));
 262
 263                         } else if ($this->roleId == ROLE_ID_PROOFREADER) {
 264                                 // Then add editors, layout editor, and author
 265                                 $recipients = array_merge($recipients, $editorAddresses);
 266
 267                                 if ($layoutEditor != null) {
 268                                         $recipients = array_merge($recipients, array($layoutEditor->getEmail() => $layoutEditor->getFullName()));
 269                                 }
 270
 271                                 if (isset($author)) $recipients = array_merge($recipients, array($author->getEmail() => $author->getFullName()));
 272
 273                         } else {
 274                                 // Then add editors, layout editor, and proofreader
 275                                 $recipients = array_merge($recipients, $editorAddresses);
 276
 277                                 if ($layoutEditor != null) {
 278                                         $recipients = array_merge($recipients, array($layoutEditor->getEmail() => $layoutEditor->getFullName()));
 279                                 }
 280
 281                                 if ($proofreader != null) {
 282                                         $recipients = array_merge($recipients, array($proofreader->getEmail() => $proofreader->getFullName()));
 283                                 }
 284                         }
 285                         break;
 286                 }
 287
 288                 return $recipients;
 289         }
 290
 291         /**
 292          * Email the comment.
 293          * @param $recipients array of recipients (email address => name)
 294          */
 295         function email($recipients) {
 296                 import('mail.MonographMailTemplate');
 297                 $email = new MonographMailTemplate($this->monograph, 'SUBMISSION_COMMENT');
 298                 $press =& Request::getPress();
 299                 if ($press) $email->setFrom($press->getSetting('contactEmail'), $press->getSetting('contactName'));
 300
 301                 foreach ($recipients as $emailAddress => $name) {
 302                         $email->addRecipient($emailAddress, $name);
 303                         $email->setSubject(strip_tags($this->monograph->getMonographTitle()));
 304
 305                         $paramArray = array(
 306                                 'name' => $name,
 307                                 'commentName' => $this->user->getFullName(),
 308                                 'comments' => $this->getData('comments')
 309                         );
 310                         $email->assignParams($paramArray);
 311
 312                         $email->send();
 313                         $email->clearRecipients();
 314                 }
 315         }
 316 }
 317
 318 ?>