PostController::comment PHP Method

comment() public method

Create or update a comment.
Since: 2.0.0
public comment ( integer $DiscussionID = '' )
$DiscussionID integer Unique ID to add the comment to. If blank, this method will throw an error.
    public function comment($DiscussionID = '')
    {
        // Get $DiscussionID from RequestArgs if valid
        if ($DiscussionID == '' && count($this->RequestArgs)) {
            if (is_numeric($this->RequestArgs[0])) {
                $DiscussionID = $this->RequestArgs[0];
            }
        }
        // If invalid $DiscussionID, get from form.
        $this->Form->setModel($this->CommentModel);
        $DiscussionID = is_numeric($DiscussionID) ? $DiscussionID : $this->Form->getFormValue('DiscussionID', 0);
        // Set discussion data
        $this->DiscussionID = $DiscussionID;
        $this->Discussion = $Discussion = $this->DiscussionModel->getID($DiscussionID);
        // Is this an embedded comment being posted to a discussion that doesn't exist yet?
        $vanilla_type = $this->Form->getFormValue('vanilla_type', '');
        $vanilla_url = $this->Form->getFormValue('vanilla_url', '');
        $vanilla_category_id = $this->Form->getFormValue('vanilla_category_id', '');
        $Attributes = array('ForeignUrl' => $vanilla_url);
        $vanilla_identifier = $this->Form->getFormValue('vanilla_identifier', '');
        $isEmbeddedComments = $vanilla_url != '' && $vanilla_identifier != '';
        // Only allow vanilla identifiers of 32 chars or less - md5 if larger
        if (strlen($vanilla_identifier) > 32) {
            $Attributes['vanilla_identifier'] = $vanilla_identifier;
            $vanilla_identifier = md5($vanilla_identifier);
        }
        if (!$Discussion && $isEmbeddedComments) {
            $Discussion = $Discussion = $this->DiscussionModel->getForeignID($vanilla_identifier, $vanilla_type);
            if ($Discussion) {
                $this->DiscussionID = $DiscussionID = $Discussion->DiscussionID;
                $this->Form->setValue('DiscussionID', $DiscussionID);
            }
        }
        // If so, create it!
        if (!$Discussion && $isEmbeddedComments) {
            // Add these values back to the form if they exist!
            $this->Form->addHidden('vanilla_identifier', $vanilla_identifier);
            $this->Form->addHidden('vanilla_type', $vanilla_type);
            $this->Form->addHidden('vanilla_url', $vanilla_url);
            $this->Form->addHidden('vanilla_category_id', $vanilla_category_id);
            $PageInfo = fetchPageInfo($vanilla_url);
            if (!($Title = $this->Form->getFormValue('Name'))) {
                $Title = val('Title', $PageInfo, '');
                if ($Title == '') {
                    $Title = t('Undefined discussion subject.');
                    if (!empty($PageInfo['Exception']) && $PageInfo['Exception'] === "Couldn't connect to host.") {
                        $Title .= ' ' . t('Page timed out.');
                    }
                }
            }
            $Description = val('Description', $PageInfo, '');
            $Images = val('Images', $PageInfo, array());
            $LinkText = t('EmbededDiscussionLinkText', 'Read the full story here');
            if (!$Description && count($Images) == 0) {
                $Body = formatString('<p><a href="{Url}">{LinkText}</a></p>', array('Url' => $vanilla_url, 'LinkText' => $LinkText));
            } else {
                $Body = formatString('
            <div class="EmbeddedContent">{Image}<strong>{Title}</strong>
               <p>{Excerpt}</p>
               <p><a href="{Url}">{LinkText}</a></p>
               <div class="ClearFix"></div>
            </div>', array('Title' => $Title, 'Excerpt' => $Description, 'Image' => count($Images) > 0 ? img(val(0, $Images), array('class' => 'LeftAlign')) : '', 'Url' => $vanilla_url, 'LinkText' => $LinkText));
            }
            if ($Body == '') {
                $Body = $vanilla_url;
            }
            if ($Body == '') {
                $Body = t('Undefined discussion body.');
            }
            // Validate the CategoryID for inserting.
            $Category = CategoryModel::categories($vanilla_category_id);
            if (!$Category) {
                $vanilla_category_id = c('Vanilla.Embed.DefaultCategoryID', 0);
                if ($vanilla_category_id <= 0) {
                    // No default category defined, so grab the first non-root category and use that.
                    $vanilla_category_id = $this->DiscussionModel->SQL->select('CategoryID')->from('Category')->where('CategoryID >', 0)->get()->firstRow()->CategoryID;
                    // No categories in the db? default to 0
                    if (!$vanilla_category_id) {
                        $vanilla_category_id = 0;
                    }
                }
            } else {
                $vanilla_category_id = $Category['CategoryID'];
            }
            $EmbedUserID = c('Garden.Embed.UserID');
            if ($EmbedUserID) {
                $EmbedUser = Gdn::userModel()->getID($EmbedUserID);
            }
            if (!$EmbedUserID || !$EmbedUser) {
                $EmbedUserID = Gdn::userModel()->getSystemUserID();
            }
            $EmbeddedDiscussionData = array('InsertUserID' => $EmbedUserID, 'DateInserted' => Gdn_Format::toDateTime(), 'DateUpdated' => Gdn_Format::toDateTime(), 'CategoryID' => $vanilla_category_id, 'ForeignID' => $vanilla_identifier, 'Type' => $vanilla_type, 'Name' => $Title, 'Body' => $Body, 'Format' => 'Html', 'Attributes' => dbencode($Attributes));
            $this->EventArguments['Discussion'] =& $EmbeddedDiscussionData;
            $this->fireEvent('BeforeEmbedDiscussion');
            $DiscussionID = $this->DiscussionModel->SQL->insert('Discussion', $EmbeddedDiscussionData);
            $ValidationResults = $this->DiscussionModel->validationResults();
            if (count($ValidationResults) == 0 && $DiscussionID > 0) {
                $this->Form->addHidden('DiscussionID', $DiscussionID);
                // Put this in the form so reposts won't cause new discussions.
                $this->Form->setFormValue('DiscussionID', $DiscussionID);
                // Put this in the form values so it is used when saving comments.
                $this->setJson('DiscussionID', $DiscussionID);
                $this->Discussion = $Discussion = $this->DiscussionModel->getID($DiscussionID, DATASET_TYPE_OBJECT, array('Slave' => false));
                // Update the category discussion count
                if ($vanilla_category_id > 0) {
                    $this->DiscussionModel->updateDiscussionCount($vanilla_category_id, $DiscussionID);
                }
            }
        }
        // If no discussion was found, error out
        if (!$Discussion) {
            $this->Form->addError(t('Failed to find discussion for commenting.'));
        }
        /**
         * Special care is taken for embedded comments.  Since we don't currently use an advanced editor for these
         * comments, we may need to apply certain filters and fixes to the data to maintain its intended display
         * with the input format (e.g. maintaining newlines).
         */
        if ($isEmbeddedComments) {
            $inputFormatter = $this->Form->getFormValue('Format', c('Garden.InputFormatter'));
            switch ($inputFormatter) {
                case 'Wysiwyg':
                    $this->Form->setFormValue('Body', nl2br($this->Form->getFormValue('Body')));
                    break;
            }
        }
        $PermissionCategoryID = val('PermissionCategoryID', $Discussion);
        // Setup head
        $this->addJsFile('jquery.autosize.min.js');
        $this->addJsFile('autosave.js');
        $this->addJsFile('post.js');
        // Setup comment model, $CommentID, $DraftID
        $Session = Gdn::session();
        $CommentID = isset($this->Comment) && property_exists($this->Comment, 'CommentID') ? $this->Comment->CommentID : '';
        $DraftID = isset($this->Comment) && property_exists($this->Comment, 'DraftID') ? $this->Comment->DraftID : '';
        $this->EventArguments['CommentID'] = $CommentID;
        $this->EventArguments['DraftID'] = $DraftID;
        // Determine whether we are editing
        $Editing = $CommentID > 0 || $DraftID > 0;
        $this->EventArguments['Editing'] = $Editing;
        // If closed, cancel & go to discussion
        if ($Discussion && $Discussion->Closed == 1 && !$Editing && !$Session->checkPermission('Vanilla.Discussions.Close', true, 'Category', $PermissionCategoryID)) {
            redirect(DiscussionUrl($Discussion));
        }
        // Add hidden IDs to form
        $this->Form->addHidden('DiscussionID', $DiscussionID);
        $this->Form->addHidden('CommentID', $CommentID);
        $this->Form->addHidden('DraftID', $DraftID, true);
        // Check permissions
        if ($Discussion && $Editing) {
            // Permission to edit
            if ($this->Comment->InsertUserID != $Session->UserID) {
                $this->permission('Vanilla.Comments.Edit', true, 'Category', $Discussion->PermissionCategoryID);
            }
            // Make sure that content can (still) be edited.
            $EditContentTimeout = c('Garden.EditContentTimeout', -1);
            $CanEdit = $EditContentTimeout == -1 || strtotime($this->Comment->DateInserted) + $EditContentTimeout > time();
            if (!$CanEdit) {
                $this->permission('Vanilla.Comments.Edit', true, 'Category', $Discussion->PermissionCategoryID);
            }
            // Make sure only moderators can edit closed things
            if ($Discussion->Closed) {
                $this->permission('Vanilla.Comments.Edit', true, 'Category', $Discussion->PermissionCategoryID);
            }
            $this->Form->setFormValue('CommentID', $CommentID);
        } elseif ($Discussion) {
            // Permission to add
            $this->permission('Vanilla.Comments.Add', true, 'Category', $Discussion->PermissionCategoryID);
        }
        if ($this->Form->authenticatedPostBack()) {
            // Save as a draft?
            $FormValues = $this->Form->formValues();
            $FormValues = $this->CommentModel->filterForm($FormValues);
            if (!$Editing) {
                unset($FormValues['CommentID']);
            }
            if ($DraftID == 0) {
                $DraftID = $this->Form->getFormValue('DraftID', 0);
            }
            $Type = GetIncomingValue('Type');
            $Draft = $Type == 'Draft';
            $this->EventArguments['Draft'] = $Draft;
            $Preview = $Type == 'Preview';
            if ($Draft) {
                $DraftID = $this->DraftModel->save($FormValues);
                $this->Form->addHidden('DraftID', $DraftID, true);
                $this->Form->setValidationResults($this->DraftModel->validationResults());
            } elseif (!$Preview) {
                // Fix an undefined title if we can.
                if ($this->Form->getFormValue('Name') && val('Name', $Discussion) == t('Undefined discussion subject.')) {
                    $Set = array('Name' => $this->Form->getFormValue('Name'));
                    if (isset($vanilla_url) && $vanilla_url && strpos(val('Body', $Discussion), t('Undefined discussion subject.')) !== false) {
                        $LinkText = t('EmbededDiscussionLinkText', 'Read the full story here');
                        $Set['Body'] = formatString('<p><a href="{Url}">{LinkText}</a></p>', array('Url' => $vanilla_url, 'LinkText' => $LinkText));
                    }
                    $this->DiscussionModel->setField(val('DiscussionID', $Discussion), $Set);
                }
                $Inserted = !$CommentID;
                $CommentID = $this->CommentModel->save($FormValues);
                // The comment is now half-saved.
                if (is_numeric($CommentID) && $CommentID > 0) {
                    if (in_array($this->deliveryType(), array(DELIVERY_TYPE_ALL, DELIVERY_TYPE_DATA))) {
                        $this->CommentModel->save2($CommentID, $Inserted, true, true);
                    } else {
                        $this->jsonTarget('', url("/post/comment2.json?commentid={$CommentID}&inserted={$Inserted}"), 'Ajax');
                    }
                    // $Discussion = $this->DiscussionModel->getID($DiscussionID);
                    $Comment = $this->CommentModel->getID($CommentID, DATASET_TYPE_OBJECT, array('Slave' => false));
                    $this->EventArguments['Discussion'] = $Discussion;
                    $this->EventArguments['Comment'] = $Comment;
                    $this->fireEvent('AfterCommentSave');
                } elseif ($CommentID === SPAM || $CommentID === UNAPPROVED) {
                    $this->StatusMessage = t('CommentRequiresApprovalStatus', 'Your comment will appear after it is approved.');
                }
                $this->Form->setValidationResults($this->CommentModel->validationResults());
                if ($CommentID > 0 && $DraftID > 0) {
                    $this->DraftModel->delete($DraftID);
                }
            }
            // Handle non-ajax requests first:
            if ($this->_DeliveryType == DELIVERY_TYPE_ALL) {
                if ($this->Form->errorCount() == 0) {
                    // Make sure that this form knows what comment we are editing.
                    if ($CommentID > 0) {
                        $this->Form->addHidden('CommentID', $CommentID);
                    }
                    // If the comment was not a draft
                    if (!$Draft) {
                        // Redirect to the new comment.
                        if ($CommentID > 0) {
                            redirect("discussion/comment/{$CommentID}/#Comment_{$CommentID}");
                        } elseif ($CommentID == SPAM) {
                            $this->setData('DiscussionUrl', DiscussionUrl($Discussion));
                            $this->View = 'Spam';
                        }
                    } elseif ($Preview) {
                        // If this was a preview click, create a comment shell with the values for this comment
                        $this->Comment = new stdClass();
                        $this->Comment->InsertUserID = $Session->User->UserID;
                        $this->Comment->InsertName = $Session->User->Name;
                        $this->Comment->InsertPhoto = $Session->User->Photo;
                        $this->Comment->DateInserted = Gdn_Format::date();
                        $this->Comment->Body = val('Body', $FormValues, '');
                        $this->Comment->Format = val('Format', $FormValues, c('Garden.InputFormatter'));
                        $this->addAsset('Content', $this->fetchView('preview'));
                    } else {
                        // If this was a draft save, notify the user about the save
                        $this->informMessage(sprintf(t('Draft saved at %s'), Gdn_Format::date()));
                    }
                }
            } else {
                // Handle ajax-based requests
                if ($this->Form->errorCount() > 0) {
                    // Return the form errors
                    $this->errorMessage($this->Form->errors());
                } else {
                    // Make sure that the ajax request form knows about the newly created comment or draft id
                    $this->setJson('CommentID', $CommentID);
                    $this->setJson('DraftID', $DraftID);
                    if ($Preview) {
                        // If this was a preview click, create a comment shell with the values for this comment
                        $this->Comment = new stdClass();
                        $this->Comment->InsertUserID = $Session->User->UserID;
                        $this->Comment->InsertName = $Session->User->Name;
                        $this->Comment->InsertPhoto = $Session->User->Photo;
                        $this->Comment->DateInserted = Gdn_Format::date();
                        $this->Comment->Body = val('Body', $FormValues, '');
                        $this->Comment->Format = val('Format', $FormValues, c('Garden.InputFormatter'));
                        $this->View = 'preview';
                    } elseif (!$Draft) {
                        // If the comment was not a draft
                        // If Editing a comment
                        if ($Editing) {
                            // Just reload the comment in question
                            $this->Offset = 1;
                            $Comments = $this->CommentModel->getIDData($CommentID, array('Slave' => false));
                            $this->setData('Comments', $Comments);
                            $this->setData('Discussion', $Discussion);
                            // Load the discussion
                            $this->ControllerName = 'discussion';
                            $this->View = 'comments';
                            // Also define the discussion url in case this request came from the post screen and needs to be redirected to the discussion
                            $this->setJson('DiscussionUrl', DiscussionUrl($this->Discussion) . '#Comment_' . $CommentID);
                        } else {
                            // If the comment model isn't sorted by DateInserted or CommentID then we can't do any fancy loading of comments.
                            $OrderBy = valr('0.0', $this->CommentModel->orderBy());
                            //                     $Redirect = !in_array($OrderBy, array('c.DateInserted', 'c.CommentID'));
                            //							$DisplayNewCommentOnly = $this->Form->getFormValue('DisplayNewCommentOnly');
                            //                     if (!$Redirect) {
                            //                        // Otherwise load all new comments that the user hasn't seen yet
                            //                        $LastCommentID = $this->Form->getFormValue('LastCommentID');
                            //                        if (!is_numeric($LastCommentID))
                            //                           $LastCommentID = $CommentID - 1; // Failsafe back to this new comment if the lastcommentid was not defined properly
                            //
                            //                        // Don't reload the first comment if this new comment is the first one.
                            //                        $this->Offset = $LastCommentID == 0 ? 1 : $this->CommentModel->GetOffset($LastCommentID);
                            //                        // Do not load more than a single page of data...
                            //                        $Limit = c('Vanilla.Comments.PerPage', 30);
                            //
                            //                        // Redirect if the new new comment isn't on the same page.
                            //                        $Redirect |= !$DisplayNewCommentOnly && PageNumber($this->Offset, $Limit) != PageNumber($Discussion->CountComments - 1, $Limit);
                            //                     }
                            //                     if ($Redirect) {
                            //                        // The user posted a comment on a page other than the last one, so just redirect to the last page.
                            //                        $this->RedirectUrl = Gdn::request()->Url("discussion/comment/$CommentID/#Comment_$CommentID", true);
                            //                     } else {
                            //                        // Make sure to load all new comments since the page was last loaded by this user
                            //								if ($DisplayNewCommentOnly)
                            $this->Offset = $this->CommentModel->GetOffset($CommentID);
                            $Comments = $this->CommentModel->GetIDData($CommentID, array('Slave' => false));
                            $this->setData('Comments', $Comments);
                            $this->setData('NewComments', true);
                            $this->ClassName = 'DiscussionController';
                            $this->ControllerName = 'discussion';
                            $this->View = 'comments';
                            //                     }
                            // Make sure to set the user's discussion watch records
                            $CountComments = $this->CommentModel->getCount($DiscussionID);
                            $Limit = is_object($this->data('Comments')) ? $this->data('Comments')->numRows() : $Discussion->CountComments;
                            $Offset = $CountComments - $Limit;
                            $this->CommentModel->SetWatch($this->Discussion, $Limit, $Offset, $CountComments);
                        }
                    } else {
                        // If this was a draft save, notify the user about the save
                        $this->informMessage(sprintf(t('Draft saved at %s'), Gdn_Format::date()));
                    }
                    // And update the draft count
                    $UserModel = Gdn::userModel();
                    $CountDrafts = $UserModel->getAttribute($Session->UserID, 'CountDrafts', 0);
                    $this->setJson('MyDrafts', t('My Drafts'));
                    $this->setJson('CountDrafts', $CountDrafts);
                }
            }
        } elseif ($this->Request->isPostBack()) {
            throw new Gdn_UserException(t('Invalid CSRF token.', 'Invalid CSRF token. Please try again.'), 401);
        } else {
            // Load form
            if (isset($this->Comment)) {
                $this->Form->setData((array) $this->Comment);
            }
        }
        // Include data for FireEvent
        if (property_exists($this, 'Discussion')) {
            $this->EventArguments['Discussion'] = $this->Discussion;
        }
        if (property_exists($this, 'Comment')) {
            $this->EventArguments['Comment'] = $this->Comment;
        }
        $this->fireEvent('BeforeCommentRender');
        if ($this->deliveryType() == DELIVERY_TYPE_DATA) {
            if ($this->data('Comments') instanceof Gdn_DataSet) {
                $Comment = $this->data('Comments')->firstRow(DATASET_TYPE_ARRAY);
                if ($Comment) {
                    $Photo = $Comment['InsertPhoto'];
                    if (strpos($Photo, '//') === false) {
                        $Photo = Gdn_Upload::url(changeBasename($Photo, 'n%s'));
                    }
                    $Comment['InsertPhoto'] = $Photo;
                }
                $this->Data = array('Comment' => $Comment);
            }
            $this->RenderData($this->Data);
        } else {
            require_once $this->fetchViewLocation('helper_functions', 'Discussion');
            // Render default view.
            $this->render();
        }
    }