lib.php 42.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?php
/**
 *
 * @package    mahara
 * @subpackage artefact-peer-assessment
 * @author     Catalyst IT Ltd
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
 *
 */

defined('INTERNAL') || die();

require_once('activity.php');
require_once('license.php');

class PluginArtefactPeerassessment extends PluginArtefact {

19 20 21 22
    public static function is_active() {
        return get_field('artefact_installed', 'active', 'name', 'peerassessment');
    }

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    public static function get_artefact_types() {
        return array(
            'peerassessment',
        );
    }

    public static function get_block_types() {
        return array();
    }

    public static function get_plugin_name() {
        return 'peerassessment';
    }

    public static function menu_items() {
        return array();
    }

    public static function get_event_subscriptions() {
        return array();
    }

    public static function get_activity_types() {
        // These events are handled by this artefact.
        return array(
            (object)array(
                'name' => 'assessmentfeedback',
                'admin' => 0,
                'delay' => 0,
                'allownonemethod' => 1,
                'defaultmethod' => 'email',
            )
        );
    }

    public static function can_be_disabled() {
        return true;
    }

    /**
     * Called post install and after every upgrade to the artefact.
     * @param string $prevversion the previously installed version of this artefact.
     */
    public static function postinst($prevversion) {
        if ($prevversion == 0) {
            // If elasticsearch is installed, update the artefacttypesmap field to include peerassessment
            $sql = "SELECT value FROM {search_config} WHERE plugin='elasticsearch' AND field='artefacttypesmap'";
            if ($result = get_field_sql($sql, array())) {
                $elasticsearchartefacttypesmap = explode("\n", $result);
                // add peerassessment field.
                $elasticsearchartefacttypesmap[] = "peerassessment|Peerassessment|Text";
                // Now save the data including the new peer assessment field.
                set_config_plugin('search', 'elasticsearch', 'artefacttypesmap', implode("\n", $elasticsearchartefacttypesmap));
            }

            // Now install the blocktype peer assessment only if Mahara was previously installed.
            // Otherwise, the Mahara installer will install everything.
            if (get_config('installed')) {
                if ($upgrade = check_upgrades('blocktype.peerassessment/peerassessment')) {
                    upgrade_plugin($upgrade);
                }
            }
        }
    }

    public static function view_export_extra_artefacts($viewids) {
        $artefacts = array();
        if (!$artefacts = get_column_sql("
            SELECT assessment
            FROM {artefact_peer_assessment}
            WHERE view IN (" . join(',', array_map('intval', $viewids)) . ')', array())) {
            return array();
        }
        if ($attachments = get_column_sql('
            SELECT attachment
            FROM {artefact_attachment}
            WHERE artefact IN (' . join(',', $artefacts). ')')) {
            $artefacts = array_merge($artefacts, $attachments);
        }
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
        if ($embeds = get_column_sql("
            SELECT afe.fileid
            FROM {artefact_file_embedded} afe
            JOIN {artefact_peer_assessment} apa ON apa.assessment = afe.resourceid
            WHERE afe.resourcetype IN (?)
            AND apa.view IN (" . join(',', array_map('intval', $viewids)) . ")
            UNION
            SELECT afe.fileid
            FROM {artefact_file_embedded} afe
            JOIN {artefact_peer_assessment} apa ON apa.block = afe.resourceid
            WHERE afe.resourcetype in(?)
            AND apa.view IN (" . join(',', array_map('intval', $viewids)) . ")"
            , array('assessment', 'peerinstruction'))) {
            $artefacts = array_merge($artefacts, $embeds);
        }

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
        return $artefacts;
    }

    public static function get_cron() {
        return array(
            (object)array(
                'callfunction' => 'clean_peerassessment_notifications',
                'minute'       => '55',
                'hour'         => '22',
            ),
        );
    }

    public static function clean_peerassessment_notifications() {
        safe_require('notification', 'internal');
        PluginNotificationInternal::clean_notifications(array('peerassessment'));
    }

    public static function progressbar_link($artefacttype) {
        switch ($artefacttype) {
            case 'peerassessment':
                return 'view/index.php';
                break;
141 142 143
            case 'verify':
                return 'view/index.php';
                break;
144 145 146 147 148 149 150 151 152
        }
    }

    public static function progressbar_additional_items() {
        return array(
            (object)array(
                'name' => 'peerassessment',
                'title' => get_string('placeassessment', 'artefact.peerassessment'),
                'plugin' => 'peerassessment',
153 154 155 156 157 158 159 160 161
                'active' => get_field('blocktype_installed', 'active', 'name', 'peerassessment', 'artefactplugin', 'peerassessment'),
                'iscountable' => true,
                'is_metaartefact' => true,
            ),
            (object)array(
                'name' => 'verify',
                'title' => get_string('verifyassessment', 'artefact.peerassessment'),
                'plugin' => 'peerassessment',
                'active' => get_field('blocktype_installed', 'active', 'name', 'signoff', 'artefactplugin', 'peerassessment'),
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
                'iscountable' => true,
                'is_metaartefact' => true,
            )
        );
    }

    public static function progressbar_metaartefact_count($name) {
        global $USER;
        $meta = new stdClass();
        $meta->artefacttype = $name;
        $meta->completed = 0;
        switch ($name) {
            case 'peerassessment':
                $sql = "SELECT COUNT(*) AS completed
                        FROM {artefact} a
177
                        JOIN {artefact_peer_assessment} ap ON ap.assessment = a.id
178 179 180 181 182
                        WHERE a.artefacttype = 'peerassessment'
                        AND a.owner <> ?
                        AND ap.usr = ?";
                $meta->completed = count_records_sql($sql, array($USER->get('id'), $USER->get('id')));
                break;
183 184 185 186 187 188 189 190
            case 'verify':
                $sql = "SELECT COUNT(*) AS completed
                        FROM {view} v
                        JOIN {view_signoff_verify} vsv ON vsv.view = v.id
                        WHERE v.owner <> ?
                        AND vsv.verifier = ?";
                $meta->completed = count_records_sql($sql, array($USER->get('id'), $USER->get('id')));
                break;
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
            default:
                return false;
        }
        return $meta;
    }
}

class ArtefactTypePeerassessment extends ArtefactType {

    protected $assessment;    // artefact id of the peer assessment artefact.
    protected $block;         // block id of the block this peer assessment is linked to.
    protected $usr;           // usr id of the user who added this peer assessment.
    protected $view;          // view id of the view this peer assessment is linked to.
    protected $view_obj;      // the view object based on the $view id.
    protected $private;       // Whether this assessment has been published by the user.
                              // 0 = can be seen by author, page owner, manager (published)
                              // 1 = can only be seen by author (draft)

    public function __construct($id = 0, $data = null) {
        parent::__construct($id, $data);

        if ($this->id && ($extra = get_record('artefact_peer_assessment', 'assessment', $this->id))) {
            foreach($extra as $name => $value) {
                if (property_exists($this, $name)) {
                    $this->{$name} = $value;
                }
            }
        }
    }

    public static function is_singular() {
        return false;
    }

    public static function get_icon($options=null) {
        global $THEME;
        return false;
    }

    public static function get_links($id) {
        $v = $this->get_view();
        return array(
            '_default' => $v->get_url(),
        );
    }

    public function get_view_url($viewid, $showcomment=true, $full=true) {
        $url = 'view/view.php?id=' . $viewid;
        if ($showcomment) {
            $url .= '&showcomment=' . $this->get('id');
        }
        if ($full) {
            $url = get_config('wwwroot') . $url;
        }
        return $url;
    }

    /**
     * @return View the view object this peer assessment block is in
     */
    public function get_view() {
        if (empty($this->view_obj)) {
            require_once('view.php');
            $this->view_obj = new View($this->get('view'));
        }
        return $this->view_obj;
    }

    public function commit() {
        if (empty($this->dirty)) {
            return;
        }

        $new = empty($this->id);

        db_begin();

        parent::commit();

        $data = (object)array(
            'assessment'    => $this->get('id'),
            'block'         => $this->get('block'),
            'usr'           => $this->get('usr'),
            'view'          => $this->get('view'),
            'private'       => ($this->get('private') ? 1 : 0),
        );

        if ($new) {
            insert_record('artefact_peer_assessment', $data);
        }
        else {
            update_record('artefact_peer_assessment', $data, 'assessment');
        }

        if ($this->get('view')) {
            set_field('view', 'mtime', db_format_timestamp(time()), 'id', $this->get('view'));
        }
        db_commit();
        $this->dirty = false;
    }

    public function delete() {
        if (empty($this->id)) {
            return;
        }
        db_begin();
        $this->detach();

        // Remove any embedded images for this peer assessment.
        require_once('embeddedimage.php');
        EmbeddedImage::remove_embedded_images('assessment', $this->id);
        delete_records('artefact_peer_assessment', 'assessment', $this->id);
        parent::delete();
        db_commit();
    }

    public static function bulk_delete($artefactids, $log=false) {
        if (empty($artefactids)) {
            return;
        }

        $idstr = join(',', array_map('intval', $artefactids));

        db_begin();
        delete_records_select('artefact_peer_assessment', 'assessment IN (' . $idstr . ')');
        delete_records_select('artefact_file_embedded', 'resourcetype = ? AND resourceid IN (' . $idstr . ')', array('assessment'));
        parent::bulk_delete($artefactids);
        db_commit();
    }

    public static function delete_view_assessments($viewid) {
        $ids = get_column('artefact_peer_assessment', 'assessment', 'view', $viewid);
        self::bulk_delete($ids);
    }

    public function can_have_attachments() {
        return true;
    }

    public static function deleted_types() {
        return array('author', 'owner', 'admin');
    }

    /**
     * Generates default data object required for displaying peer assessments on the page.
     * The is called before populating with specific data to send to get_assessments() as
     * an easy way to add variables to get passed to get_assessments.
     *
     * int $limit              The number of comments to display (set to
     *                         0 for disabling pagination and showing all comments)
     * int $offset             The offset of comments used for pagination
     * int|string $showcomment Optionally show page with particular comment
     *                         on it or the last page. $offset will be ignored.
     *                         Specify either comment_id or 'last' respectively.
     *                         Set to null to use $offset for pagination.
     * object $view            The view object
     * int $block              Optional The block id that the assessment is linked to.
     * bool   $export          Determines if comments are fetched for html export purposes
     * bool   $onview          Optional - is viewing assessment on view page so don't show edit buttons
     * string $sort            Optional - the sort order of the comments. Valid options are 'earliest' and 'latest'.
     * @return object $options Default peer assessments data object
     */
    public static function get_assessment_options() {
        $options = new stdClass();
        $options->limit = 10;
        $options->offset = 0;
        $options->showcomment = null;
        $options->view = null;
        $options->block = null;
        $options->export = false;
        $options->onview = false;
        $sortorder = get_user_institution_comment_sort_order();
        $options->sort = (!empty($sortorder)) ? $sortorder : 'earliest';
        return $options;
    }

    /**
     * Generates the data object required for displaying assessments on the page.
     *
     * @param   object  $options  Object of assessment options
     *                            - defaults can be retrieved from get_assessment_options()
     * @return  object $result    Assessment data object
     */
374
    public static function get_assessments($options, $versioning=null) {
375 376 377 378 379 380 381 382 383 384
        global $USER;
        $allowedoptions = self::get_assessment_options();
        // set the object's key/val pairs as variables

        foreach ($options as $key => $option) {
            if (array_key_exists($key, $allowedoptions));
            $$key = $option;
        }
        $userid = $USER->get('id');
        $viewid = $view->get('id');
385
        $canedit = ($USER->can_peer_assess($view) && !self::is_signed_off($view));
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
        $owner = $view->get('owner');
        $isowner = $userid && $userid == $owner;

        $result = (object) array(
            'limit'    => $limit,
            'offset'   => $offset,
            'view'     => $viewid,
            'block'    => $block,
            'canedit'  => $canedit,
            'owner'    => $owner,
            'isowner'  => $isowner,
            'export'   => $export,
            'sort'     => $sort,
            'data'     => array(),
        );

402

403 404 405
        if ($versioning) {
            $result->data = self::get_assessment_data_for_versioning($versioning, $viewid);
            $result->count = sizeof($result->data);
406 407
        }
        else {
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
            $where = 'pa.view = ? ';

            // If the signoff block is also present on the page then we restrict things differently
            $withsignoff = record_exists('block_instance', 'view', $viewid, 'blocktype', 'signoff');
            if ($withsignoff) {
                // If the view is signed off, select public assessments
                // or if viewing as page owner, select public assessments
                // or if viewing as assessment author, select assessments owned by author
                $where.= 'AND ((vsv.signoff = 1 AND pa.private = 0) ';
                $where.= '    OR (a.author = ?)';
                $where.= '    OR (pa.private = 0 AND a.owner = ?))';

                $values = array($viewid, $userid, $userid, $block);
                $joinsignoff = ' JOIN {view_signoff_verify} vsv ON vsv.view = pa.view ';
            }
            else {
                // select assessments that are published
                // or select assessments where the user is the author, published or not
                $where.= 'AND ( (pa.private = 0) ';
                $where.= '    OR (a.author = ?))';
428

429 430
                $values = array($viewid, $userid, $block);
                $joinsignoff = '';
431 432
            }

433 434 435 436 437 438
            $result->count = count_records_sql('
                SELECT COUNT(*)
                FROM
                    {artefact} a
                    JOIN {artefact_peer_assessment} pa
                        ON a.id = pa.assessment' . $joinsignoff . '
439 440 441
                    LEFT JOIN {artefact} p
                        ON a.parent = p.id
                WHERE ' . $where . '
442
                AND pa.block = ?', $values);
443

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
            if ($result->count > 0) {

                // Figure out sortorder
                $orderby = 'a.ctime ' . ($sort == 'latest' ? 'DESC' : 'ASC');

                // If pagination is in use, see if we want to get a page with particular assessment
                if ($limit) {
                    if ($showcomment == 'last') {
                        // If we have limit (pagination is used) ignore $offset and just get the last page of comments.
                        $result->forceoffset = $offset = (ceil($result->count / $limit) - 1) * $limit;
                    }
                    else if (is_numeric($showcomment)) {
                        // Ignore $offset and get the page that has the assessment
                        // with id $showcomment on it.
                        // Fetch everything and figure out which page $showcomment is in.
                        // This will get ugly if there are 1000s of assessments
                        $ids = get_column_sql('
                                SELECT a.id
                                FROM {artefact} a JOIN {artefact_peer_assessment} pa ON a.id = pa.assessment
                                ' . $joinsignoff . '
                                LEFT JOIN {artefact} p ON a.parent = p.id
                                WHERE ' . $where . '
                                AND pa.block = ?
                                ORDER BY ' . $orderby,
                                $values
                        );
                        $found = false;
                        foreach ($ids as $k => $v) {
                            if ($v == $showcomment) {
                                $found = $k;
                                break;
                            }
                        }
                        if ($found !== false) {
                            // Add 1 because array index starts from 0 and therefore key value is offset by 1.
                            $rank = $found + 1;
                            $result->forceoffset = $offset = ((ceil($rank / $limit) - 1) * $limit);
                            $result->showcomment = $showcomment;
                        }
                    }
                }

                $assessments = get_records_sql_assoc('
                    SELECT
                        a.id, a.title, a.author, a.authorname, a.ctime, a.mtime, a.description, a.group, a.path,
                        pa.private, pa.view, pa.block,
                        u.username, u.firstname, u.lastname, u.preferredname, u.email, u.staff, u.admin,
                        u.deleted, u.profileicon, u.urlid, p.id AS parent, p.author AS parentauthor
                    FROM {artefact} a
                        INNER JOIN {artefact_peer_assessment} pa ON a.id = pa.assessment
                        ' . $joinsignoff . '
                        LEFT JOIN {artefact} p
                            ON a.parent = p.id
                        LEFT JOIN {usr} u ON a.author = u.id
                    WHERE ' . $where . '
                    AND pa.block = ?
                    ORDER BY ' . $orderby, $values, $offset, $limit);
                $result->data = array_values($assessments);
            }
503 504 505
        }

        $result->position = 'blockinstance';
506
        self::build_html($result, $versioning);
507 508 509
        return $result;
    }

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
    private static function get_assessment_data_for_versioning($versioning, $viewid) {
          global $USER;
          foreach ($versioning->blocks as $blockversion) {
              //find the assessment block
              if ($blockversion->blocktype == 'peerassessment') {
                  $existing_artefacts= array();
                  if (isset($blockversion->configdata->existing_artefacts)) {
                      $existing_artefacts = $blockversion->configdata->existing_artefacts;
                  }
                  // populate the version with data to display
                  $assessmentsversion = array();
                  foreach ($existing_artefacts as &$assessment) {
                      // select assessments that are published
                      // or select assessments where the user is the author, published or not
                      if ($assessment->author == $USER->get('id') || !$assessment->private ) {
                          $assessment->view = $viewid;
                          $assessment->block = $blockversion->originalblockid;

                          $user = new User();
                          $user->find_by_id($assessment->author);
                          $assessment->username = $user->get('username');
                          $assessment->firstname = $user->get('firstname');
                          $assessment->lastname = $user->get('lastname');
                          $assessment->preferredname = $user->get('preferredname');
                          $assessment->email = $user->get('email');
                          $assessment->admin = $user->get('admin');
                          $assessment->staff = $user->get('staff');
                          $assessment->deleted = $user->get('deleted');
                          $assessment->profileicon = $user->get('profileicon');

                          $assessmentsversion[] = $assessment;
                      }
                  }
                  return $assessmentsversion;
              }
          }
          return 0;
    }

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
    public static function is_signable(View $view) {
        global $USER;

        $signable = false;
        if ($view->get('owner')) {
            $signable = ($view->get('owner') == $USER->get('id')) ? true : false;
        }
        return $signable;
    }

    public static function is_signed_off(View $view) {
        if (!$view->get('owner')) {
            return false;
        }
        return (bool)get_field_sql("SELECT signoff FROM {view_signoff_verify} WHERE view = ? LIMIT 1", array($view->get('id')));
    }

    public static function is_verifiable(View $view) {
        global $USER;

        if (!$view->get('owner')) {
            return false;
        }
        $verifiable = get_field_sql("SELECT va.usr FROM {view_access} va
                                     JOIN {usr_roles} ur ON ur.role = va.role
                                     WHERE ur.see_block_content = ?
                                     AND va.view = ? AND va.usr = ?
                                     LIMIT 1", array(1, $view->get('id'), $USER->get('id')));
        return (bool)$verifiable;
    }

    public static function is_verified(View $view) {
        if (!$view->get('owner')) {
            return false;
        }
        return (bool)get_field_sql("SELECT verified FROM {view_signoff_verify} WHERE view = ? LIMIT 1", array($view->get('id')));
    }

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
    public static function count_assessments($viewids=null) {
        if (!empty($viewids)) {
            return get_records_sql_assoc('
                SELECT pa.view, COUNT(pa.assessment) AS assessments
                FROM {artefact_peer_assessment} pa
                WHERE pa.view IN (' . join(',', array_map('intval', $viewids)) . ')
                GROUP BY pa.view',
                array()
            );
        }
    }

    public static function last_public_assessment($view=null) {
        $newest = get_records_sql_array('
            SELECT a.id, a.ctime
            FROM {artefact} a
            INNER JOIN {artefact_peer_assessment} pa ON a.id = pa.assessment
            WHERE pa.private = 0 AND pa.view = ?
            ORDER BY a.ctime DESC', array($view), 0, 1
        );
        return $newest[0];
    }

610
    public static function build_html(&$data, $versioning=null) {
611 612 613 614 615 616 617
        global $USER, $THEME;

        $candelete = $data->canedit || $USER->get('admin');
        $deletedmessage = array();
        $authors = array();
        $lastcomment = self::last_public_assessment($data->view);
        $editableafter = time() - 60 * get_config_plugin('artefact', 'comment', 'commenteditabletime');
618
        $signedoff = null;
619
        foreach ($data->data as &$item) {
620 621 622 623
            if ($signedoff === null) {
                $view = new View($item->view);
                $signedoff = self::is_signed_off($view);
            }
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
            $item->ts = strtotime($item->ctime);
            $timelapse = format_timelapse($item->ts);
            $item->date = ($timelapse) ? $timelapse : format_date($item->ts, 'strftimedatetime');
            if ($item->ts < strtotime($item->mtime)) {
                $timelapseupdated = format_timelapse(strtotime($item->mtime));
                $item->updated = ($timelapseupdated) ? $timelapseupdated : format_date(strtotime($item->mtime), 'strftimedatetime');
            }
            $item->isauthor = $item->author && $item->author == $USER->get('id');

            if ($item->private) {
                $item->pubmessage = get_string('thisassessmentisprivate', 'artefact.peerassessment');
            }

            if (isset($data->showcomment) && $data->showcomment == $item->id) {
                $item->highlight = 1;
            }
            $is_export_preview = param_integer('export', 0);

            // Peer assessment authors can edit recent assessments if they're private or if within editable timeframe.
            if ($data->canedit &&
                ($item->isauthor && !$is_export_preview &&
                 ($item->private || $item->ts > $editableafter)
                )
              ) {
                $item->canedit = 1;
            }
            else {
                $item->canedit = 0;
            }

654 655 656 657 658 659 660 661 662 663 664 665
            if (!$versioning) {
                $submittedcheck = get_record_sql('SELECT v.* FROM {view} v WHERE v.id = ?', array($data->view), ERROR_MULTIPLE);
                if (($candelete || ($item->isauthor && !$signedoff && !$is_export_preview)) && $submittedcheck->submittedstatus == View::UNSUBMITTED) {
                    $item->deleteform = pieform(self::delete_assessment_form($item->id, $item->view, $item->block));
                }
                if ($item->canedit && $submittedcheck->submittedstatus == View::UNSUBMITTED) {
                    $smarty = smarty_core();
                    $smarty->assign('id', $item->id);
                    $smarty->assign('block', $item->block);
                    $smarty->assign('title', $item->title);
                    $item->editlink = $smarty->fetch('artefact:peerassessment:editlink.tpl');
                }
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
            }

            if ($item->author) {
                if (isset($authors[$item->author])) {
                    $item->author = $authors[$item->author];
                }
                else {
                    $item->author = $authors[$item->author] = (object) array(
                        'id'            => $item->author,
                        'username'      => $item->username,
                        'firstname'     => $item->firstname,
                        'lastname'      => $item->lastname,
                        'preferredname' => $item->preferredname,
                        'email'         => $item->email,
                        'staff'         => $item->staff,
                        'admin'         => $item->admin,
                        'deleted'       => $item->deleted,
                        'profileicon'   => $item->profileicon,
                        'profileurl'    => profile_url($item->author),
                    );
                }
            }
        }

        $extradata = array('block' => $data->block);
        $data->jsonscript = 'artefact/peerassessment/peerassessment.json.php';
        $data->baseurl = get_config('wwwroot') . 'view/view.php?id=' . $data->view;

        $smarty = smarty_core();
        $smarty->assign('data', $data->data);
        $smarty->assign('canedit', $data->canedit);
        $smarty->assign('position', $data->position);
        $smarty->assign('viewid', $data->view);
        $smarty->assign('baseurl', $data->baseurl);

        $data->tablerows = $smarty->fetch('artefact:peerassessment:assessmentlist.tpl');

        $pagination = build_pagination(array(
            'id' => 'peerassessment_pagination_' . $data->block,
            'class' => 'center',
            'url' => $data->baseurl,
            'jsonscript' => $data->jsonscript,
            'datatable' => 'assessmentfeedbacktable' . $data->block,
            'count' => $data->count,
            'limit' => $data->limit,
            'offset' => $data->offset,
            'forceoffset' => isset($data->forceoffset) ? $data->forceoffset : null,
            'resultcounttextsingular' => get_string('assessment', 'artefact.peerassessment'),
            'resultcounttextplural' => get_string('assessments', 'artefact.peerassessment'),
            'extradata' => $extradata,
        ));
        $data->pagination = $pagination['html'];
        $data->pagination_js = $pagination['javascript'];
        $data->html = $data->tablerows . "\n" . $data->pagination . "\n";
        if ($data->pagination_js) {
            $data->html .= '<script type="application/javascript">' . "\n";
            $data->html .= ' jQuery(function () {' . "\n";
            $data->html .= '   assessmentpaginator' . $data->block . ' = ' . $data->pagination_js . "\n";
            $data->html .= ' });' . "\n";
            $data->html .= '</script>' . "\n";
        }
    }

    public function render_self($options) {
        return clean_html($this->get('description'));
    }

    public static function add_assessment_form($defaultprivate=false, $blockid=0, $id=0) {
        global $USER;
        $form = array(
            'name'            => 'add_assessment_form_' . $blockid,
            'method'          => 'post',
            'plugintype'      => 'artefact',
            'pluginname'      => 'peerassessment',
            'jsform'          => true,
            'autofocus'       => false,
            'elements'        => array(),
            'successcallback'   => 'add_assessment_form_submit',
            'validatecallback'  => 'add_assessment_form_validate',
            'jssuccesscallback' => 'addPeerassessmentSuccess',
            'jserrorcallback'   => 'addPeerassessmentError',
        );
        $form['elements']['message'] = array(
            'type'  => 'wysiwyg',
            'title' => get_string('Assessment', 'artefact.peerassessment'),
            'class' => 'hide-label',
            'rows'  => 5,
            'cols'  => 80,
754
            'rules' => array('maxlength' => 1000000),
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
        );
        $form['elements']['block'] = array(
            'type' => 'hidden',
            'value' => $blockid,
        );
        $form['elements']['assessment'] = array(
            'type' => 'text',
            'defaultvalue' => $id,
            'class' => 'hidden',
        );
        $form['elements']['submit'] = array(
            'type' => 'multisubmit',
            'name' => 'peerassessment',
            'options' => array('draftsubmit' => 'draft',
                               'submit' => 'publish',
                               'cancel' => 'cancel'),
            'primarychoice' => 'publish',
772 773 774
            'classes' => array('draftsubmit' => 'btn-secondary',
                               'submit' => 'btn-secondary',
                               'cancel' => 'btn-secondary submitcancel'),
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
            'value' => array('draftsubmit' => get_string('draft', 'blocktype.peerassessment/peerassessment'),
                             'submit' => get_string('publish', 'blocktype.peerassessment/peerassessment'),
                             'cancel' => get_string('cancel'))
        );
        $form['elements']['helpnotes'] = array(
            'type' => 'html',
            'value' => get_string('savepublishhelp', 'blocktype.peerassessment/peerassessment'),
        );
        return $form;
    }

    public static function delete_assessment_form($id, $viewid, $blockid) {
        global $THEME;
        return array(
            'name'     => 'delete_assessment_' . $id,
            'method' => 'post',
            'autofocus'         => false,
            'renderer'          => 'oneline',
            'plugintype'        => 'artefact',
            'pluginname'        => 'peerassessment',
            'class'             => 'form-as-button pull-left assessbtn last',
            'jsform'            => true,
            'successcallback'   => 'delete_assessment_submit',
            'jssuccesscallback' => 'modifyPeerassessmentSuccess',
            'elements' => array(
                'assessment' => array('type' => 'hidden', 'value' => $id),
                'view' => array('type' => 'hidden', 'value' => $viewid),
                'block' => array('type' => 'hidden', 'value' => $blockid),
                'submit'  => array(
                    'type'  => 'button',
                    'usebuttontag' => true,
806
                    'class' => 'btn-secondary btn-sm',
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
                    'value' => '<span class="icon icon-trash icon-lg text-danger" role="presentation" aria-hidden="true"></span> <span class="sr-only">' . get_string('delete') . '</span>',
                    'confirm' => get_string('reallydeletethisassessment', 'artefact.peerassessment'),
                    'name'  => 'delete_assessment_submit',
                ),
            ),
        );
    }

    public function exportable() {
        return true;
    }

    public static function has_config() {
        return false;
    }

}

function delete_assessment_submit(Pieform $form, $values) {
    global $SESSION, $USER;

    $assessment = new ArtefactTypePeerassessment((int) $values['assessment']);
    $view = $assessment->get_view();
    $viewid = $view->get('id');
    $blockid = $assessment->get('block');
    $url = $view->get_url(false);
    $goto = get_config('wwwroot') . $url;
    // If this page is being marked, make assessments un-deletable until released
    // unless it is the last assessment still with in the editable timeframe
    $editableafter = time() - 60 * get_config_plugin('artefact', 'comment', 'commenteditabletime');
    $lastcomment = $assessment::last_public_assessment($viewid);
    if (($lastcomment === null || $assessment->get('private') || $assessment->get('id') == $lastcomment->id) && $assessment->get('mtime') > $editableafter) {
        $candelete = 1;
    }
    else {
        $candelete = 0;
    }

    if ($view->get('submittedstatus') == View::UNSUBMITTED || $candelete) {
        db_begin();
        $author = $assessment->get('author');
        $owner = $view->get('owner');
        $sendto = array();
        if ($owner != $USER->get('id')) {
            $sendto[] = $owner;
        }
        if ($author != $USER->get('id')) {
            $sendto[] = $author;
        }
        if (!empty($sendto)) {
            // Notify author
            $title = $view->get('title');
            $title = hsc($title);
            $data = (object) array(
                'subject'   => false,
                'message'   => false,
                'strings'   => (object) array(
                    'subject' => (object) array(
                        'key'     => 'deletednotificationsubject',
                        'section' => 'artefact.peerassessment',
                        'args'    => array($title),
                    ),
                    'message' => (object) array(
870
                        'key'     => 'deletedauthornotification1',
871
                        'section' => 'artefact.peerassessment',
872
                        'args'    => array(display_name($author), $title, html2text($assessment->get('description'))),
873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
                    ),
                    'urltext' => (object) array(
                        'key'     => 'view',
                    ),
                ),
                'users'     => $sendto,
                'url'       => $url,
            );
            activity_occurred('maharamessage', $data);
        }

        $assessment->delete();
        db_commit();

        $assessmentoptions = ArtefactTypePeerassessment::get_assessment_options();
        $assessmentoptions->showcomment = $assessment->get('id');
        $assessmentoptions->view = $view;
        $assessmentoptions->block = $blockid;
        $newlist = ArtefactTypePeerassessment::get_assessments($assessmentoptions);
        $form->reply(PIEFORM_OK, array(
            'message' => get_string('assessmentremoved', 'artefact.peerassessment'),
            'goto' => $goto,
            'data' => $newlist,
        ));
    }
    else {
        $form->reply(PIEFORM_ERR, get_string('assessmentremovedfailed', 'artefact.peerassessment'));
    }
}

function add_assessment_form_validate(Pieform $form, $values) {
    global $USER, $view;
    if (empty($values['attachments']) && empty($values['message'])) {
        $form->set_error('message', get_string('messageempty', 'artefact.peerassessment'));
    }
}

function add_assessment_form_submit(Pieform $form, $values) {
    global $view, $USER;
    require_once('embeddedimage.php');

    if (empty($values['assessment'])) {
        // new one
        $data = (object) array(
            'title'       => get_string('Assessment', 'artefact.peerassessment'),
            'description' => $values['message'],
        );
        $data->view        = $view->get('id');
        $data->owner       = $view->get('owner');
        $data->group       = $view->get('group');
        $data->institution = $view->get('institution');

        $data->author = $USER->get('id');
        $data->usr = $USER->get('id');
        $data->block = $values['block'];
        $isprivate = ($values['peerassessment'] == 'draft') ? 1 : 0;
        $data->private = $isprivate;
        $assessment = new ArtefactTypePeerassessment(0, $data);
    }
    else {
        $assessment = new ArtefactTypePeerassessment($values['assessment']);
        $assessment->set('description', $values['message']);
        $isprivate = ($values['peerassessment'] == 'draft') ? 1 : 0;
        $assessment->set('private', $isprivate);
    }

    db_begin();

    $assessment->commit();

    $newdescription = EmbeddedImage::prepare_embedded_images($values['message'], 'assessment', $assessment->get('id'));

    if ($newdescription !== $values['message']) {
        $updated = new stdClass();
        $updated->id = $assessment->get('id');
        $updated->description = $newdescription;
        update_record('artefact', $updated, 'id');
    }

    $url = $assessment->get_view_url($view->get('id'), true, false);
    $goto = get_config('wwwroot') . $url;

    // If peer assessment is published we send a notification to page owner
    if (!$isprivate && $view->get('owner') != $USER->get('id')) {
        // Notify owner
        $data = (object) array(
            'assessmentid' => $assessment->get('id'),
            'viewid'    => $view->get('id'),
        );
        activity_occurred('assessmentfeedback', $data, 'artefact', 'peerassessment');
    }

    db_commit();

    $assessmentoptions = ArtefactTypePeerassessment::get_assessment_options();
    $assessmentoptions->showcomment = $assessment->get('id');
    $assessmentoptions->view = $view;
    $assessmentoptions->block = $values['block'];
    $newlist = ArtefactTypePeerassessment::get_assessments($assessmentoptions);

    $message = get_string('assessmentsubmitted', 'artefact.peerassessment');

    $form->reply(PIEFORM_OK, array(
        'message' => $message,
        'goto' => $goto,
        'data' => $newlist,
    ));
}

function add_assessment_form_cancel_submit(Pieform $form) {
    global $view;
    $form->reply(PIEFORM_CANCEL, array(
        'location' => $view->get_url(true),
    ));
}

class ActivityTypeArtefactPeerassessmentAssessmentfeedback extends ActivityTypePlugin {

    protected $viewid;
    protected $assessmentid;

    /**
     * @param array $data Parameters:
     *                    - viewid (int)
     *                    - assessmentid (int)
     */
    public function __construct($data, $cron=false) {
        parent::__construct($data, $cron);

        $assessment = new ArtefactTypePeerassessment($this->assessmentid);

        $this->overridemessagecontents = true;

        $onview = $assessment->get('view');
        if (!$viewrecord = get_record('view', 'id', $onview)) {
            throw new ViewNotFoundException(get_string('viewnotfound', 'error', $onview));
        }
        $userid = $viewrecord->owner;
        if (empty($this->url)) {
            $this->url = 'view/view.php?id=' . $onview;
        }

        // Now fetch the users that will need to get notified about this event
        $this->users = array();
        if (!empty($userid)) {
            $this->users = activity_get_users($this->get_id(), array($userid));
        }

        if (empty($this->users)) {
            // no one to notify - possibe if group 'feedbacknotify' is set to 0
            return;
        }

        $title = $viewrecord->title;
        $this->urltext = $title;
        $body = $assessment->get('description');
1029
        $posttime = strftime(get_string('strftimedaydatetime'), $assessment->get('ctime'));
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071

        // Internal
        $this->message = strip_tags(str_shorten_html($body, 200, true));
        // Seeing as things like emaildigest base the message on $this->message
        // we need to set the language for the $removedbyline here based on first user.
        $user = reset($this->users);
        $lang = (empty($user->lang) || $user->lang == 'default') ? get_config('lang') : $user->lang;

        $this->strings = (object) array(
            'subject' => (object) array(
                'key'     => 'newassessmentnotificationsubject',
                'section' => 'artefact.peerassessment',
                'args'    => array($title),
            ),
        );

        $this->url .= '&showcomment=' . $assessment->get('id');

        // Email
        $author = $assessment->get('usr');
        if ($author) {
            $this->fromuser = $author;
            // We don't need to send an email to the inbox of the author of the assessment as we send one to their outbox
            if (isset($this->users[$author])) {
                unset($this->users[$author]);
            }
        }
        foreach ($this->users as $key => $user) {
            $authorname = display_name($author, $user);
            if (empty($user->lang) || $user->lang == 'default') {
                // check to see if we need to show institution language
                $instlang = get_user_institution_language($user->id);
                $lang = (empty($instlang) || $instlang == 'default') ? get_config('lang') : $instlang;
            }
            else {
                $lang = $user->lang;
            }
            $this->users[$key]->htmlmessage = get_string_from_language(
                $lang, 'feedbacknotificationhtml', 'artefact.peerassessment',
                hsc($authorname), hsc($title), $posttime, clean_html($body), get_config('wwwroot') . $this->url
            );
            $this->users[$key]->emailmessage = get_string_from_language(
1072
                $lang, 'feedbacknotificationtext1', 'artefact.peerassessment',
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
                $authorname, $title, $posttime, trim(html2text(htmlspecialchars($body))), get_config('wwwroot') . $this->url
            );
        }
    }

    public function get_plugintype() {
        return 'artefact';
    }

    public function get_pluginname() {
        return 'peerassessment';
    }

    public function get_required_parameters() {
        return array('assessmentid', 'viewid');
    }
}