Unanticipated User Role setting causes error

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
38/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
php

Research direction

Start in CommentingPlugin::showComments and compare views/public/comments.php with the proposed views/public/commentingHeader.php. Trace the role checks for viewing and adding comments, then verify that a role allowed to comment but not view comments still receives the label, flash message, and comment form without an error.

Written by the indexing model from the issue text.

Description

I came across an issue which gets triggered by the scenario that a certain User Role is able to make a comment, but not allowed to view them. In this case the $view variable along with $view->addHelperPath is not set since this is currently dependent on the ability to view comments. Also in this scenario the Label as well as the flash message does not get output, since they currently reside in views/public/comments.php, which gets bypassed.

To fix the issue, I updated the showComments function in CommentingPlugin to the following:

public static function showComments($args = array())
    {    
        echo "<div id='comments-container'>";

        // presume we will need the view in any case
        if(isset($args['view'])) {
            $view = $args['view'];
        } else {
            $view = get_view();
        }

        $view->addHelperPath(COMMENTING_PLUGIN_DIR . '/helpers', 'Commenting_View_Helper_');

        // output the header
        echo $view->partial('commentingHeader.php');

        if( (get_option('commenting_allow_public') == 1) 
                || (get_option('commenting_allow_public_view') == 1) 
                || is_allowed('Commenting_Comment', 'show') ) {

            $options = array('threaded'=> get_option('commenting_threaded'), 'approved'=>true);

            $comments = isset($args['comments']) ? $args['comments'] : $view->getComments($options);
            echo $view->partial('comments.php', array('comments'=>$comments, 'threaded'=>$options['threaded']));
        }

        if( (get_option('commenting_allow_public') == 1) 
                || is_allowed('Commenting_Comment', 'add') ) {
            echo "<div id='comment-main-container'>";
            echo $view->getCommentForm();
            echo "</div>";
        }    
        echo "</div>";
    }

This presumes that we need the $views set in any case.

I also created a new file views/public/commentingHeader.php which contains:

<?php $label = get_option('commenting_comments_label'); ?>
<?php if ($label == ''):?>
    <h2><?php echo __('Comments'); ?></h2>
<?php else: ?>
    <h2><?php echo $label; ?></h2>
<?php endif; ?>
<div id='comments-flash'><?php echo flash(true); ?></div>

This code has been removed from views/public/comments.php.

Dominant language
PHP
Stars
4
Forks
5
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from omeka/plugin-Commenting

All issues in omeka/plugin-Commenting

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.