mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-05 08:23:01 +02:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-65032-master' of git://github.com/peterRd/moodle

Browse Source
This commit is contained in:
Jun Pataleta 2019-04-24 16:18:06 +08:00
commit b3c8984c0e
39 changed files with 566 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
mod/forum/amd/build/lock_toggle.min.js vendored Normal file
View File

@ -0,0 +1 @@
define(["jquery","core/templates","core/notification","mod_forum/repository","mod_forum/selectors"],function(a,b,c,d,e){var f=function(b){b.on("click",e.lock.toggle,function(b){var e=a(this),f=e.data("forumid"),g=e.data("discussionid"),h=e.data("state");d.setDiscussionLockState(f,g,h).then(function(){return location.reload()})["catch"](c.exception),b.preventDefault()})};return{init:function(a){f(a)}}});

2
mod/forum/amd/build/repository.min.js vendored
View File

@ -1 +1 @@
define(["core/ajax"],function(a){var b=function(b,c,d){var e={methodname:"mod_forum_set_subscription_state",args:{forumid:b,discussionid:c,targetstate:d}};return a.call([e])[0]},c=function(b,c,d){var e={methodname:"mod_forum_add_discussion_post",args:{postid:b,message:d,subject:c}};return a.call([e])[0]};return{setDiscussionSubscriptionState:b,addDiscussionPost:c}});
define(["core/ajax"],function(a){var b=function(b,c,d){var e={methodname:"mod_forum_set_subscription_state",args:{forumid:b,discussionid:c,targetstate:d}};return a.call([e])[0]},c=function(b,c,d){var e={methodname:"mod_forum_add_discussion_post",args:{postid:b,message:d,subject:c}};return a.call([e])[0]},d=function(b,c,d){var e={methodname:"mod_forum_set_lock_state",args:{forumid:b,discussionid:c,targetstate:d}};return a.call([e])[0]};return{setDiscussionSubscriptionState:b,addDiscussionPost:c,setDiscussionLockState:d}});

2
mod/forum/amd/build/selectors.min.js vendored
View File

@ -1 +1 @@
define([],function(){return{subscription:{toggle:"[data-type='subscription-toggle'][data-action='toggle']"},pin:{toggle:".pindiscussion [data-action='toggle']"},post:{post:'[data-region="post"]',action:'[data-region="post-action"]',actionsContainer:'[data-region="post-actions-container"]',forumCoreContent:"[data-region-content='forum-post-core']",forumContent:"[data-content='forum-post']",forumSubject:"[data-region-content='forum-post-core-subject']",inpageReplyLink:"[data-action='collapsible-link']",inpageReplyContent:"[data-content='inpage-reply-content']",inpageReplyForm:"form[data-content='inpage-reply-form']",inpageSubmitBtn:"[data-action='forum-inpage-submit']",repliesContainer:"[data-region='replies-container']",modeSelect:"select[name='mode']"}}});
define([],function(){return{subscription:{toggle:"[data-type='subscription-toggle'][data-action='toggle']"},pin:{toggle:".pindiscussion [data-action='toggle']"},post:{post:'[data-region="post"]',action:'[data-region="post-action"]',actionsContainer:'[data-region="post-actions-container"]',forumCoreContent:"[data-region-content='forum-post-core']",forumContent:"[data-content='forum-post']",forumSubject:"[data-region-content='forum-post-core-subject']",inpageReplyLink:"[data-action='collapsible-link']",inpageReplyContent:"[data-content='inpage-reply-content']",inpageReplyForm:"form[data-content='inpage-reply-form']",inpageSubmitBtn:"[data-action='forum-inpage-submit']",repliesContainer:"[data-region='replies-container']",modeSelect:"select[name='mode']"},lock:{toggle:"[data-action='toggle'][data-type='lock-toggle']"}}});

65
mod/forum/amd/src/lock_toggle.js Normal file
View File

@ -0,0 +1,65 @@
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Handle the manual locking of individual discussions
*
* @module mod_forum/lock_toggle
* @package mod_forum
* @copyright 2019 Peter Dias <peter@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
define([
'jquery',
'core/templates',
'core/notification',
'mod_forum/repository',
'mod_forum/selectors',
], function(
$,
Templates,
Notification,
Repository,
Selectors
) {
/**
* Register event listeners for the subscription toggle.
*
* @param {object} root The discussion list root element
*/
var registerEventListeners = function(root) {
root.on('click', Selectors.lock.toggle, function(e) {
var toggleElement = $(this);
var forumId = toggleElement.data('forumid');
var discussionId = toggleElement.data('discussionid');
var state = toggleElement.data('state');
Repository.setDiscussionLockState(forumId, discussionId, state)
.then(function() {
return location.reload();
})
.catch(Notification.exception);
e.preventDefault();
});
};
return {
init: function(root) {
registerEventListeners(root);
}
};
});

17
mod/forum/amd/src/repository.js
View File

@ -14,7 +14,7 @@
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Forum repository class to encapsulate all of the AJAX requests that
* Forum repository class to encapsulate all of the AJAX requests that subscribe or unsubscribe
* can be sent for forum.
*
* @module mod_forum/repository
@ -56,8 +56,21 @@ define(['core/ajax'], function(Ajax) {
return Ajax.call([request])[0];
};
var setDiscussionLockState = function(forumId, discussionId, targetState) {
var request = {
methodname: 'mod_forum_set_lock_state',
args: {
forumid: forumId,
discussionid: discussionId,
targetstate: targetState
}
};
return Ajax.call([request])[0];
};
return {
setDiscussionSubscriptionState: setDiscussionSubscriptionState,
addDiscussionPost: addDiscussionPost
addDiscussionPost: addDiscussionPost,
setDiscussionLockState: setDiscussionLockState
};
});

5
mod/forum/amd/src/selectors.js
View File

@ -41,7 +41,10 @@ define([], function() {
inpageReplyForm: "form[data-content='inpage-reply-form']",
inpageSubmitBtn: "[data-action='forum-inpage-submit']",
repliesContainer: "[data-region='replies-container']",
modeSelect: "select[name='mode']",
modeSelect: "select[name='mode']"
},
lock: {
toggle: "[data-action='toggle'][data-type='lock-toggle']",
}
};
});

2
mod/forum/backup/moodle2/backup_forum_stepslib.php
View File

@ -51,7 +51,7 @@ class backup_forum_activity_structure_step extends backup_activity_structure_ste
$discussion = new backup_nested_element('discussion', array('id'), array(
'name', 'firstpost', 'userid', 'groupid',
'assessed', 'timemodified', 'usermodified', 'timestart',
'timeend', 'pinned'));
'timeend', 'pinned', 'timelocked'));
$posts = new backup_nested_element('posts');

3
mod/forum/classes/local/container.php
View File

@ -98,7 +98,8 @@ class container {
return new vault_factory(
$DB,
self::get_entity_factory(),
get_file_storage()
get_file_storage(),
self::get_legacy_data_mapper_factory()
);
}

3
mod/forum/classes/local/data_mappers/legacy/discussion.php
View File

@ -57,7 +57,8 @@ class discussion {
'usermodified' => $discussion->get_user_modified(),
'timestart' => $discussion->get_time_start(),
'timeend' => $discussion->get_time_end(),
'pinned' => $discussion->is_pinned()
'pinned' => $discussion->is_pinned(),
'timelocked' => $discussion->get_locked()
];
}, $discussions);
}

35
mod/forum/classes/local/entities/discussion.php
View File

@ -61,6 +61,8 @@ class discussion {
private $timeend;
/** @var bool $pinned Is the discussion pinned? */
private $pinned;
/** @var int $locked The timestamp of when the discussion was locked */
private $timelocked;
/**
* Constructor.
@ -78,6 +80,7 @@ class discussion {
* @param int $timestart Start time for the discussion
* @param int $timeend End time for the discussion
* @param bool $pinned Is the discussion pinned?
* @param int $locked Time this discussion was locked
*/
public function __construct(
int $id,
@ -92,7 +95,8 @@ class discussion {
int $usermodified,
int $timestart,
int $timeend,
bool $pinned
bool $pinned,
int $locked
) {
$this->id = $id;
$this->courseid = $courseid;
@ -107,6 +111,7 @@ class discussion {
$this->timestart = $timestart;
$this->timeend = $timeend;
$this->pinned = $pinned;
$this->timelocked = $locked;
}
/**
@ -228,6 +233,34 @@ class discussion {
return $this->pinned;
}
/**
* Get the locked time of this discussion.
*
* @return bool
*/
public function get_locked() : int {
return $this->timelocked;
}
/**
* Is this discussion locked based on it's locked attribute
*
* @return bool
*/
public function is_locked() : bool {
return ($this->timelocked ? true : false);
}
/**
* Set the locked timestamp
*
* @param int $timestamp The value we want to store into 'locked'
*/
public function toggle_locked_state(int $timestamp) {
// Check the current value against what we want the value to be i.e. '$timestamp'.
$this->timelocked = ($this->timelocked && $timestamp ? $this->timelocked : $timestamp);
}
/**
* Check if the given post is the first post in this discussion.
*

20
mod/forum/classes/local/entities/forum.php
View File

@ -539,12 +539,12 @@ class forum {
}
/**
* Is the discussion locked?
* Check whether the discussion is locked based on forum's time based locking criteria
*
* @param discussion_entity $discussion The discussion to check
* @param discussion_entity $discussion
* @return bool
*/
public function is_discussion_locked(discussion_entity $discussion) : bool {
public function is_discussion_time_locked(discussion_entity $discussion) : bool {
if (!$this->has_lock_discussions_after()) {
return false;
}
@ -618,4 +618,18 @@ class forum {
return false;
}
/**
* Is the discussion locked? - Takes into account both discussion settings AND forum's criteria
*
* @param discussion_entity $discussion The discussion to check
* @return bool
*/
public function is_discussion_locked(discussion_entity $discussion) : bool {
if ($discussion->is_locked()) {
return true;
}
return $this->is_discussion_time_locked($discussion);
}
}

14
mod/forum/classes/local/exporters/discussion.php
View File

@ -64,6 +64,8 @@ class discussion extends exporter {
'id' => ['type' => PARAM_INT],
'forumid' => ['type' => PARAM_INT],
'pinned' => ['type' => PARAM_BOOL],
'locked' => ['type' => PARAM_BOOL],
'istimelocked' => ['type' => PARAM_BOOL],
'name' => ['type' => PARAM_TEXT],
'group' => [
'optional' => true,
@ -88,6 +90,7 @@ class discussion extends exporter {
'modified' => ['type' => PARAM_INT],
'start' => ['type' => PARAM_INT],
'end' => ['type' => PARAM_INT],
'locked' => ['type' => PARAM_INT],
],
],
'userstate' => [
@ -100,7 +103,8 @@ class discussion extends exporter {
'subscribe' => ['type' => PARAM_BOOL],
'move' => ['type' => PARAM_BOOL],
'pin' => ['type' => PARAM_BOOL],
'post' => ['type' => PARAM_BOOL]
'post' => ['type' => PARAM_BOOL],
'manage' => ['type' => PARAM_BOOL],
]
],
'urls' => [
@ -179,6 +183,8 @@ class discussion extends exporter {
'id' => $discussion->get_id(),
'forumid' => $forum->get_id(),
'pinned' => $discussion->is_pinned(),
'locked' => $forum->is_discussion_locked($discussion),
'istimelocked' => $forum->is_discussion_time_locked($discussion),
'name' => format_string($discussion->get_name(), true, [
'context' => $this->related['context']
]),
@ -186,15 +192,17 @@ class discussion extends exporter {
'modified' => $discussion->get_time_modified(),
'start' => $discussion->get_time_start(),
'end' => $discussion->get_time_end(),
'locked' => $discussion->get_locked()
],
'userstate' => [
'subscribed' => \mod_forum\subscriptions::is_subscribed($user->id, $forumrecord, $discussion->get_id()),
'subscribed' => \mod_forum\subscriptions::is_subscribed($user->id, $forumrecord, $discussion->get_id())
],
'capabilities' => [
'subscribe' => $capabilitymanager->can_subscribe_to_discussion($user, $discussion),
'move' => $capabilitymanager->can_move_discussion($user, $discussion),
'pin' => $capabilitymanager->can_pin_discussion($user, $discussion),
'post' => $capabilitymanager->can_post_in_discussion($user, $discussion)
'post' => $capabilitymanager->can_post_in_discussion($user, $discussion),
'manage' => $capabilitymanager->can_manage_forum($user)
],
'urls' => [
'view' => $urlfactory->get_discussion_view_url_from_discussion($discussion)->out(false),

3
mod/forum/classes/local/factories/entity.php
View File

@ -126,7 +126,8 @@ class entity {
$record->usermodified,
$record->timestart,
$record->timeend,
$record->pinned
$record->pinned,
$record->timelocked
);
}

20
mod/forum/classes/local/factories/legacy_data_mapper.php
View File

@ -30,6 +30,7 @@ use mod_forum\local\data_mappers\legacy\author as author_data_mapper;
use mod_forum\local\data_mappers\legacy\discussion as discussion_data_mapper;
use mod_forum\local\data_mappers\legacy\forum as forum_data_mapper;
use mod_forum\local\data_mappers\legacy\post as post_data_mapper;
use mod_forum\local\entities\forum;
/**
* Legacy data mapper factory.
@ -76,4 +77,23 @@ class legacy_data_mapper {
public function get_author_data_mapper() : author_data_mapper {
return new author_data_mapper();
}
/**
* Get the corresponding entity based on the supplied value
*
* @param string $entity
* @return author_data_mapper|discussion_data_mapper|forum_data_mapper|post_data_mapper
*/
public function get_legacy_data_mapper_for_vault($entity) {
switch($entity) {
case 'forum':
return $this->get_forum_data_mapper();
case 'discussion':
return $this->get_discussion_data_mapper();
case 'post':
return $this->get_post_data_mapper();
case 'author':
return $this->get_author_data_mapper();
}
}
}

25
mod/forum/classes/local/factories/vault.php
View File

@ -49,6 +49,8 @@ use moodle_database;
class vault {
/** @var entity_factory $entityfactory Entity factory */
private $entityfactory;
/** @var legacy_data_mapper $legacymapper Entity factory */
private $legacymapper;
/** @var moodle_database $db A moodle database */
private $db;
/** @var file_storage $filestorage A file storage instance */
@ -60,11 +62,14 @@ class vault {
* @param moodle_database $db A moodle database
* @param entity_factory $entityfactory Entity factory
* @param file_storage $filestorage A file storage instance
* @param legacy_data_mapper $legacyfactory Datamapper
*/
public function __construct(moodle_database $db, entity_factory $entityfactory, file_storage $filestorage) {
public function __construct(moodle_database $db, entity_factory $entityfactory,
file_storage $filestorage, legacy_data_mapper $legacyfactory) {
$this->db = $db;
$this->entityfactory = $entityfactory;
$this->filestorage = $filestorage;
$this->legacymapper = $legacyfactory;
}
/**
@ -75,7 +80,8 @@ class vault {
public function get_forum_vault() : forum_vault {
return new forum_vault(
$this->db,
$this->entityfactory
$this->entityfactory,
$this->legacymapper->get_legacy_data_mapper_for_vault('forum')
);
}
@ -87,7 +93,8 @@ class vault {
public function get_discussion_vault() : discussion_vault {
return new discussion_vault(
$this->db,
$this->entityfactory
$this->entityfactory,
$this->legacymapper->get_legacy_data_mapper_for_vault('discussion')
);
}
@ -99,7 +106,8 @@ class vault {
public function get_discussions_in_forum_vault() : discussion_list_vault {
return new discussion_list_vault(
$this->db,
$this->entityfactory
$this->entityfactory,
$this->legacymapper->get_legacy_data_mapper_for_vault('discussion')
);
}
@ -111,7 +119,8 @@ class vault {
public function get_post_vault() : post_vault {
return new post_vault(
$this->db,
$this->entityfactory
$this->entityfactory,
$this->legacymapper->get_legacy_data_mapper_for_vault('post')
);
}
@ -123,7 +132,8 @@ class vault {
public function get_author_vault() : author_vault {
return new author_vault(
$this->db,
$this->entityfactory
$this->entityfactory,
$this->legacymapper->get_legacy_data_mapper_for_vault('author')
);
}
@ -135,7 +145,8 @@ class vault {
public function get_post_read_receipt_collection_vault() : post_read_receipt_collection_vault {
return new post_read_receipt_collection_vault(
$this->db,
$this->entityfactory
$this->entityfactory,
$this->legacymapper->get_legacy_data_mapper_for_vault('post')
);
}

16
mod/forum/classes/local/vaults/db_table_vault.php
View File

@ -40,19 +40,24 @@ abstract class db_table_vault {
private $db;
/** @var entity_factory $entityfactory Entity factory */
private $entityfactory;
/** @var object $legacyfactory Entity->legacy factory */
private $legacyfactory;
/**
* Constructor.
*
* @param moodle_database $db A moodle database
* @param entity_factory $entityfactory Entity factory
* @param object $legacyfactory Legacy factory
*/
public function __construct(
moodle_database $db,
entity_factory $entityfactory
entity_factory $entityfactory,
$legacyfactory
) {
$this->db = $db;
$this->entityfactory = $entityfactory;
$this->legacyfactory = $legacyfactory;
}
/**
@ -116,6 +121,15 @@ abstract class db_table_vault {
return $this->entityfactory;
}
/**
* Get the legacy factory
*
* @return object
*/
protected function get_legacy_factory() {
return $this->legacyfactory;
}
/**
* Execute the defined preprocessors on the DB record results and then convert
* them into entities.

17
mod/forum/classes/local/vaults/discussion.php
View File

@ -125,4 +125,21 @@ class discussion extends db_table_vault {
return $this->get_db()->count_records(self::TABLE, [
'forum' => $forum->get_id()]);
}
/**
* Update the discussion
*
* @param discussion_entity $discussion
* @return discussion_entity|null
*/
public function update_discussion(discussion_entity $discussion) : ?discussion_entity {
$discussionrecord = $this->get_legacy_factory()->to_legacy_object($discussion);
if ($this->get_db()->update_record('forum_discussions', $discussionrecord)) {
$records = $this->transform_db_records_to_entities([$discussionrecord]);
return count($records) ? array_shift($records) : null;
}
return null;
}
}

1
mod/forum/db/install.xml
View File

@ -56,6 +56,7 @@
<FIELD NAME="timestart" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="timeend" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="pinned" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
<FIELD NAME="timelocked" TYPE="int" LENGTH="10" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
</FIELDS>
<KEYS>
<KEY NAME="primary" TYPE="primary" FIELDS="id"/>

11
mod/forum/db/services.php
View File

@ -134,4 +134,15 @@ $functions = array(
'ajax' => true,
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
'mod_forum_set_lock_state' => array(
'classname' => 'mod_forum_external',
'methodname' => 'set_lock_state',
'classpath' => 'mod/forum/externallib.php',
'description' => 'Set the lock state for the discussion',
'type' => 'write',
'ajax' => true,
'capabilities' => 'moodle/course:manageactivities',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
);

16
mod/forum/db/upgrade.php
View File

@ -114,7 +114,6 @@ function xmldb_forum_upgrade($oldversion) {
$dbman->add_field($table, $field);
}
// Forum savepoint reached.
upgrade_mod_savepoint(true, 2019031200, 'forum');
}
@ -138,9 +137,22 @@ function xmldb_forum_upgrade($oldversion) {
$dbman->add_field($table, $field);
}
// Forum savepoint reached.
upgrade_mod_savepoint(true, 2019040400, 'forum');
}
if ($oldversion < 2019040402) {
// Define field deleted to be added to forum_posts.
$table = new xmldb_table('forum_discussions');
$field = new xmldb_field('timelocked', XMLDB_TYPE_INTEGER, '10', null, XMLDB_NOTNULL, null, '0', 'pinned');
// Conditionally launch add field deleted.
if (!$dbman->field_exists($table, $field)) {
$dbman->add_field($table, $field);
}
// Forum savepoint reached.
upgrade_mod_savepoint(true, 2019040402, 'forum');
}
return true;
}

79
mod/forum/externallib.php
View File

@ -588,6 +588,7 @@ class mod_forum_external extends external_api {
}
// The forum function returns the replies for all the discussions in a given forum.
$canseeprivatereplies = has_capability('mod/forum:readprivatereplies', $modcontext);
$canlock = has_capability('moodle/course:manageactivities', $modcontext, $USER);
$replies = forum_count_discussion_replies($forumid, $sort, -1, $page, $perpage, $canseeprivatereplies);
foreach ($alldiscussions as $discussion) {
@ -637,6 +638,7 @@ class mod_forum_external extends external_api {
}
$discussion->locked = forum_discussion_is_locked($forum, $discussion);
$discussion->canlock = $canlock;
$discussion->canreply = forum_user_can_post($forum, $discussion, $USER, $cm, $course, $modcontext);
if (forum_is_author_hidden($discussion, $forum)) {
@ -728,6 +730,7 @@ class mod_forum_external extends external_api {
'pinned' => new external_value(PARAM_BOOL, 'Is the discussion pinned'),
'locked' => new external_value(PARAM_BOOL, 'Is the discussion locked'),
'canreply' => new external_value(PARAM_BOOL, 'Can the user reply to the discussion'),
'canlock' => new external_value(PARAM_BOOL, 'Can the user lock the discussion'),
), 'post'
)
),
@ -1227,6 +1230,7 @@ class mod_forum_external extends external_api {
$discussion->name = $discussion->subject;
$discussion->timestart = 0;
$discussion->timeend = 0;
$discussion->timelocked = 0;
$discussion->attachments = $options['attachmentsid'];
if (has_capability('mod/forum:pindiscussions', $context) && $options['discussionpinned']) {
@ -1510,4 +1514,79 @@ class mod_forum_external extends external_api {
public static function set_subscription_state_returns() {
return \mod_forum\local\exporters\discussion::get_read_structure();
}
/**
* Set the lock state.
*
* @param int $forumid
* @param int $discussionid
* @param string $targetstate
* @return \stdClass
*/
public static function set_lock_state($forumid, $discussionid, $targetstate) {
global $DB, $PAGE, $USER;
$params = self::validate_parameters(self::set_lock_state_parameters(), [
'forumid' => $forumid,
'discussionid' => $discussionid,
'targetstate' => $targetstate
]);
$vaultfactory = mod_forum\local\container::get_vault_factory();
$forumvault = $vaultfactory->get_forum_vault();
$forum = $forumvault->get_from_id($params['forumid']);
$managerfactory = mod_forum\local\container::get_manager_factory();
$capabilitymanager = $managerfactory->get_capability_manager($forum);
if (!$capabilitymanager->can_manage_forum($USER)) {
throw new moodle_exception('errorcannotlock', 'forum');
}
// If the targetstate(currentstate) is not 0 then it should be set to the current time.
$lockedvalue = $targetstate ? 0 : time();
self::validate_context($forum->get_context());
$discussionvault = $vaultfactory->get_discussion_vault();
$discussion = $discussionvault->get_from_id($params['discussionid']);
// If the current state doesn't equal the desired state then update the current.
// state to the desired state.
$discussion->toggle_locked_state($lockedvalue);
$response = $discussionvault->update_discussion($discussion);
$discussion = !$response ? $response : $discussion;
$exporterfactory = mod_forum\local\container::get_exporter_factory();
$exporter = $exporterfactory->get_discussion_exporter($USER, $forum, $discussion);
return $exporter->export($PAGE->get_renderer('mod_forum'));
}
/**
* Returns description of method parameters.
*
* @return external_function_parameters
*/
public static function set_lock_state_parameters() {
return new external_function_parameters(
[
'forumid' => new external_value(PARAM_INT, 'Forum that the discussion is in'),
'discussionid' => new external_value(PARAM_INT, 'The discussion to lock / unlock'),
'targetstate' => new external_value(PARAM_INT, 'The timestamp for the lock state')
]
);
}
/**
* Returns description of method result value.
*
* @return external_description
*/
public static function set_lock_state_returns() {
return new external_single_structure([
'id' => new external_value(PARAM_INT, 'The discussion we are locking.'),
'locked' => new external_value(PARAM_BOOL, 'The locked state of the discussion.'),
'times' => new external_single_structure([
'locked' => new external_value(PARAM_INT, 'The locked time of the discussion.'),
])
]);
}
}

5
mod/forum/lang/en/forum.php
View File

@ -85,6 +85,8 @@ $string['cannotupdatepost'] = 'You can not update this post';
$string['cannotviewpostyet'] = 'You cannot read other students questions in this discussion yet because you haven\'t posted';
$string['cannotviewusersposts'] = 'There are no posts made by this user that you are able to view.';
$string['cleanreadtime'] = 'Mark old posts as read hour';
$string['clicktolockdiscussion'] = 'Click to lock this discussion';
$string['clicktounlockdiscussion'] = 'Click to unlock this discussion';
$string['clicktounsubscribe'] = 'You are subscribed to this discussion. Click to unsubscribe.';
$string['clicktosubscribe'] = 'You are not subscribed to this discussion. Click to subscribe.';
$string['completiondiscussions'] = 'Student must create discussions:';
@ -221,6 +223,7 @@ $string['erroremptymessage'] = 'Post message cannot be empty';
$string['erroremptysubject'] = 'Post subject cannot be empty.';
$string['errorenrolmentrequired'] = 'You must be enrolled in this course to access this content';
$string['errorwhiledelete'] = 'An error occurred while deleting record.';
$string['errorcannotlock'] = 'You do not have the permission to lock discussions.';
$string['eventassessableuploaded'] = 'Some content has been posted.';
$string['everyonecanchoose'] = 'Everyone can choose to be subscribed';
$string['everyonecannowchoose'] = 'Everyone can now choose to be subscribed';
@ -313,6 +316,7 @@ $string['lockdiscussionafter_help'] = 'Discussions may be automatically locked a
Users with the capability to reply to locked discussions can unlock a discussion by replying to it.';
$string['longpost'] = 'Long post';
$string['locked'] = 'Locked';
$string['mailnow'] = 'Send forum post notifications with no editing-time delay';
$string['manydiscussions'] = 'Discussions per page';
$string['managesubscriptionsoff'] = 'Finish managing subscriptions';
@ -403,6 +407,7 @@ $string['notexists'] = 'Discussion no longer exists';
$string['nothingnew'] = 'Nothing new for {$a}';
$string['notingroup'] = 'Sorry, but you need to be part of a group to see this forum.';
$string['notinstalled'] = 'The forum module is not installed';
$string['notlocked'] = 'Lock';
$string['notpartofdiscussion'] = 'This post is not part of a discussion!';
$string['notrackforum'] = 'Don\'t track unread posts';
$string['noviewdiscussionspermission'] = 'You do not have the permission to view discussions in this forum';

5
mod/forum/lib.php
View File

@ -1822,8 +1822,9 @@ function forum_get_discussions($cm, $forumsort="", $fullpost=true, $unused=-1, $
$updatedsincesql = 'AND d.timemodified > ?';
$params[] = $updatedsince;
}
$discussionfields = "d.id as discussionid, d.course, d.forum, d.name, d.firstpost, d.groupid, d.assessed," .
" d.timemodified, d.usermodified, d.timestart, d.timeend, d.pinned";
$discussionfields = "d.id as discussionid, d.course, d.forum, d.name, d.firstpost, d.userid, d.groupid, d.assessed," .
" d.timemodified, d.usermodified, d.timestart, d.timeend, d.pinned, d.timelocked";
$allnames = get_all_user_name_fields(true, 'u');
$sql = "SELECT $postdata, $discussionfields,

6
mod/forum/post.php
View File

@ -217,6 +217,11 @@ if (!empty($forum)) {
'returnurl' => '/mod/forum/view.php?f=' . $forum->id)),
get_string('youneedtoenrol'));
}
// The forum has been locked. Just redirect back to the discussion page.
if (forum_discussion_is_locked($forum, $discussion)) {
redirect(new moodle_url('/mod/forum/discuss.php', array('d' => $discussion->id)));
}
}
print_error('nopostforum', 'forum');
}
@ -950,6 +955,7 @@ if ($mformpost->is_cancelled()) {
$discussion = $fromform;
$discussion->name = $fromform->subject;
$discussion->timelocked = 0;
$newstopic = false;
if ($forum->type == 'news' && !$fromform->parent) {

6
mod/forum/styles.css
View File

@ -301,13 +301,15 @@ span.unread {
background: url([[pix:mod_forum|t/unsubscribed]]) no-repeat -9999px -9999px;
}
.path-mod-forum .discussionsubscription {
.path-mod-forum .discussionsubscription,
.path-mod-forum .discussionlock {
margin-top: -10px;
text-align: right;
margin-bottom: 10px;
}
.path-mod-forum .discussionsubscription > a > img {
.path-mod-forum .discussionsubscription > a > img,
.path-mod-forum .discussionlock > a > img {
width: 12px;
padding: 0 4px;
}

58
mod/forum/templates/discussion_lock_toggle.mustache Normal file
View File

@ -0,0 +1,58 @@
{{!
This file is part of Moodle - http://moodle.org/
Moodle is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Moodle is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
}}
{{!
@template mod_forum/discussion_lock_toggle
Template to display the discussion subscription toggle.
Classes required for JS:
* none
Data attributes required for JS:
* none
Context variables required for this template:
* none
Example context (json):
{
"id": 0,
"locked": 1
}
}}
<a
class="iconsmall"
data-type="lock-toggle"
data-action="toggle"
data-discussionid="{{id}}"
data-forumid="{{forumid}}"
data-state="{{locked}}"
href="#"
{{#locked}}
title="{{#str}}clicktounlockdiscussion, forum{{/str}}"
{{/locked}}
{{^locked}}
title="{{#str}}clicktolockdiscussion, forum{{/str}}"
{{/locked}}
>
{{#locked}}
{{#pix}}t/unlock, core, {{#str}}clicktounlockdiscussion, forum{{/str}}{{/pix}}{{#str}}locked, forum{{/str}}
{{/locked}}
{{^locked}}
{{#pix}}t/lock, core, {{#str}}clicktolockdiscussion, forum{{/str}}{{/pix}}{{#str}}notlocked, forum{{/str}}
{{/locked}}
</a>

16
mod/forum/templates/forum_discussion.mustache
View File

@ -32,7 +32,16 @@
<div id="discussion-container-{{uniqid}}" data-content="forum-discussion">
{{#html}}
{{{subscribe}}}
<div class="d-flex flex-wrap flex-row-reverse m-b-1" data-container="discussion-tools" style="text-align: right;">
{{#capabilities.manage}}
{{^timelocked}}
<div class="pl-1 discussionlock">
{{> forum/discussion_lock_toggle }}
</div>
{{/timelocked}}
{{/capabilities.manage}}
<div class="pl-1">{{{subscribe}}}</div>
</div>
{{{neighbourlinks}}}
<div class="d-flex flex-wrap mb-1">
@ -52,10 +61,11 @@
{{#html.neighbourlinks}}{{{.}}}{{/html.neighbourlinks}}
</div>
{{#js}}
require(['jquery', 'mod_forum/discussion', 'mod_forum/posts_list'], function($, Discussion, PostsList) {
require(['jquery', 'mod_forum/discussion', 'mod_forum/posts_list', 'mod_forum/lock_toggle'], function($, Discussion, PostsList, LockToggle) {
var root = $("[data-content='forum-discussion']");
Discussion.init(root);
PostsList.init(root);
var root = $('#discussion-container-{{uniqid}}');
var root = $('[data-container="discussion-tools"]');
LockToggle.init(root);
});
{{/js}}

15
mod/forum/tests/behat/behat_mod_forum.php
View File

@ -113,6 +113,21 @@ class behat_mod_forum extends behat_base {
$this->execute('behat_forms::press_button', get_string('submit', 'core'));
}
/**
* Navigates to a particular discussion page
*
* @Given /^I navigate to post "(?P<post_subject_string>(?:[^"]|\\")*)" in "(?P<forum_name_string>(?:[^"]|\\")*)" forum$/
* @param string $postsubject The subject of the post
* @param string $forumname The forum name
*/
public function i_navigate_to_post_in_forum($postsubject, $forumname) {
// Navigate to forum discussion.
$this->execute('behat_general::click_link', $this->escape($forumname));
$this->execute('behat_general::click_link', $this->escape($postsubject));
}
/**
* Returns the steps list to add a new discussion to a forum.
*

49
mod/forum/tests/behat/discussion_lock.feature Normal file
View File

@ -0,0 +1,49 @@
@mod @mod_forum @javascript
Feature: As a teacher, you can manually lock individual discussions when viewing the discussion
Background:
Given the following "users" exist:
| username | firstname | lastname | email |
| student1 | Student | 1 | student1@example.com |
And the following "courses" exist:
| fullname | shortname | category |
| Course 1 | C1 | 0 |
And the following "course enrolments" exist:
| user | course | role |
| student1 | C1 | student |
And I log in as "admin"
And I am on "Course 1" course homepage with editing mode on
And I add a "Forum" to section "1" and I fill the form with:
| Forum name | Test forum name |
| Description | Test forum description |
And I add a new discussion to "Test forum name" forum with:
| Subject | Discussion 1 |
| Message | Discussion contents 1, first message |
And I reply "Discussion 1" post from "Test forum name" forum with:
| Subject | Reply 1 to discussion 1 |
| Message | Discussion contents 1, second message |
And I add a new discussion to "Test forum name" forum with:
| Subject | Discussion 2 |
| Message | Discussion contents 2, first message |
And I reply "Discussion 2" post from "Test forum name" forum with:
| Subject | Reply 1 to discussion 2 |
| Message | Discussion contents 2, second message |
And I log out
Scenario: Lock a discussion and view
Given I log in as "admin"
And I am on "Course 1" course homepage
And I navigate to post "Discussion 1" in "Test forum name" forum
Then "Lock" "link" should be visible
And I follow "Lock"
Then "a[@title='Lock']" "css_element" should not be visible
Then "Locked" "link" should be visible
Then I should see "This discussion has been locked so you can no longer reply to it."
And I follow "Discussion 2"
Then I should not see "This discussion has been locked so you can no longer reply to it."
And I log out
And I log in as "student1"
And I am on "Course 1" course homepage
And I navigate to post "Discussion 1" in "Test forum name" forum
Then I should see "This discussion has been locked so you can no longer reply to it."
And "Reply" "link" should not be visible

3
mod/forum/tests/entities_discussion_summary_test.php
View File

@ -72,7 +72,8 @@ class mod_forum_entities_discussion_summary_testcase extends advanced_testcase {
time(),
0,
0,
false
false,
0
);
$firstpost = new post_entity(
1,

6
mod/forum/tests/entities_discussion_test.php
View File

@ -56,7 +56,8 @@ class mod_forum_entities_discussion_testcase extends advanced_testcase {
$time,
0,
0,
false
false,
0
);
$firstpost = new post_entity(
4,
@ -147,7 +148,8 @@ class mod_forum_entities_discussion_testcase extends advanced_testcase {
$basetime,
$starttime,
$endtime,
false
false,
0
);
$CFG->forum_enabletimedposts = true;

3
mod/forum/tests/entities_forum_test.php
View File

@ -58,7 +58,8 @@ class mod_forum_entities_forum_testcase extends advanced_testcase {
$time,
0,
0,
false
false,
0
);
$past = time() - 100;

3
mod/forum/tests/exporters_discussion_test.php
View File

@ -87,7 +87,8 @@ class mod_forum_exporters_discussion_testcase extends advanced_testcase {
$now,
0,
0,
false
false,
0
);
$exporter = new discussion_exporter($discussion, [

56
mod/forum/tests/externallib_test.php
View File

@ -985,6 +985,7 @@ class mod_forum_external_testcase extends externallib_advanced_testcase {
'pinned' => FORUM_DISCUSSION_UNPINNED,
'locked' => false,
'canreply' => false,
'canlock' => false,
);
// Call the external function passing forum id.
@ -1025,6 +1026,11 @@ class mod_forum_external_testcase extends externallib_advanced_testcase {
} catch (moodle_exception $e) {
$this->assertEquals('requireloginerror', $e->errorcode);
}
$this->setAdminUser();
$discussions = mod_forum_external::get_forum_discussions_paginated($forum1->id);
$discussions = external_api::clean_returnvalue(mod_forum_external::get_forum_discussions_paginated_returns(), $discussions);
$this->assertTrue($discussions['discussions'][0]['canlock']);
}
/**
@ -1422,6 +1428,56 @@ class mod_forum_external_testcase extends externallib_advanced_testcase {
}
/*
* Test set_lock_state.
*/
public function test_set_lock_state() {
global $DB;
$this->resetAfterTest(true);
// Create courses to add the modules.
$course = self::getDataGenerator()->create_course();
$user = self::getDataGenerator()->create_user();
$studentrole = $DB->get_record('role', array('shortname' => 'student'));
// First forum with tracking off.
$record = new stdClass();
$record->course = $course->id;
$record->type = 'news';
$forum = self::getDataGenerator()->create_module('forum', $record);
$record = new stdClass();
$record->course = $course->id;
$record->userid = $user->id;
$record->forum = $forum->id;
$discussion = self::getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
// User who is a student.
self::setUser($user);
$this->getDataGenerator()->enrol_user($user->id, $course->id, $studentrole->id, 'manual');
// Only a teacher should be able to lock a discussion.
try {
$result = mod_forum_external::set_lock_state($forum->id, $discussion->id, 0);
$this->fail('Exception expected due to missing capability.');
} catch (moodle_exception $e) {
$this->assertEquals('errorcannotlock', $e->errorcode);
}
// Set the lock.
self::setAdminUser();
$result = mod_forum_external::set_lock_state($forum->id, $discussion->id, 0);
$result = external_api::clean_returnvalue(mod_forum_external::set_lock_state_returns(), $result);
$this->assertTrue($result['locked']);
$this->assertNotEquals(0, $result['times']['locked']);
// Unset the lock.
$result = mod_forum_external::set_lock_state($forum->id, $discussion->id, time());
$result = external_api::clean_returnvalue(mod_forum_external::set_lock_state_returns(), $result);
$this->assertFalse($result['locked']);
$this->assertEquals('0', $result['times']['locked']);
}
/*
* Test can_add_discussion. A basic test since all the API functions are already covered by unit tests.
*/

4
mod/forum/tests/generator/lib.php
View File

@ -193,6 +193,10 @@ class mod_forum_generator extends testing_module_generator {
$record['pinned'] = FORUM_DISCUSSION_UNPINNED;
}
if (!isset($record['timelocked'])) {
$record['timelocked'] = 0;
}
if (isset($record['mailed'])) {
$mailed = $record['mailed'];
}

2
mod/forum/version.php
View File

@ -24,6 +24,6 @@
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2019040400; // The current module version (Date: YYYYMMDDXX)
$plugin->version = 2019040402; // The current module version (Date: YYYYMMDDXX)
$plugin->requires = 2018112800; // Requires this Moodle version
$plugin->component = 'mod_forum'; // Full name of the plugin (used for diagnostics)

3
theme/boost/scss/moodle/modules.scss
View File

@ -69,6 +69,7 @@ select {
thead .header th,
tbody .discussion td {
&.discussionlock,
&.discussionsubscription {
width: 16px;
padding-left: 0.5em;
@ -83,12 +84,14 @@ select {
}
.discussionsubscription,
.discussionlock,
.replies {
text-align: center;
}
.topic,
.discussionsubscription,
.discussionlock,
.topic.starter,
.replies,
.lastpost {

5
theme/boost/style/moodle.css
View File

@ -15023,7 +15023,8 @@ select {
.path-mod-forum .forumheaderlist thead .header.lastpost {
text-align: right; }
.path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
.path-mod-forum .forumheaderlist thead .header th.discussionlock, .path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
.path-mod-forum .forumheaderlist tbody .discussion td.discussionlock,
.path-mod-forum .forumheaderlist tbody .discussion td.discussionsubscription {
width: 16px;
padding-left: 0.5em;
@ -15034,11 +15035,13 @@ select {
white-space: normal; }
.path-mod-forum .forumheaderlist .discussion .discussionsubscription,
.path-mod-forum .forumheaderlist .discussion .discussionlock,
.path-mod-forum .forumheaderlist .discussion .replies {
text-align: center; }
.path-mod-forum .forumheaderlist .discussion .topic,
.path-mod-forum .forumheaderlist .discussion .discussionsubscription,
.path-mod-forum .forumheaderlist .discussion .discussionlock,
.path-mod-forum .forumheaderlist .discussion .topic.starter,
.path-mod-forum .forumheaderlist .discussion .replies,
.path-mod-forum .forumheaderlist .discussion .lastpost {

5
theme/classic/style/moodle.css
View File

@ -15280,7 +15280,8 @@ select {
.path-mod-forum .forumheaderlist thead .header.lastpost {
text-align: right; }
.path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
.path-mod-forum .forumheaderlist thead .header th.discussionlock, .path-mod-forum .forumheaderlist thead .header th.discussionsubscription,
.path-mod-forum .forumheaderlist tbody .discussion td.discussionlock,
.path-mod-forum .forumheaderlist tbody .discussion td.discussionsubscription {
width: 16px;
padding-left: 0.5em;
@ -15291,11 +15292,13 @@ select {
white-space: normal; }
.path-mod-forum .forumheaderlist .discussion .discussionsubscription,
.path-mod-forum .forumheaderlist .discussion .discussionlock,
.path-mod-forum .forumheaderlist .discussion .replies {
text-align: center; }
.path-mod-forum .forumheaderlist .discussion .topic,
.path-mod-forum .forumheaderlist .discussion .discussionsubscription,
.path-mod-forum .forumheaderlist .discussion .discussionlock,
.path-mod-forum .forumheaderlist .discussion .topic.starter,
.path-mod-forum .forumheaderlist .discussion .replies,
.path-mod-forum .forumheaderlist .discussion .lastpost {