Skip to content

feat: Crude first impl of module model (lpp-40) #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RiedleroD merged 9 commits into from
Jan 21, 2025
Merged

feat: Crude first impl of module model (lpp-40) #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
954d4e9
feat: crude first impl of module model
RiedleroD Jan 20, 2025
8208219
fix: wrote docblock for modules_helper::get_module_status
RiedleroD Jan 20, 2025
f0384dd
fix: made code checker happy
RiedleroD Jan 20, 2025
ddcdd29
fix: filled in some incomplete docblocks
RiedleroD Jan 20, 2025
0fd066b
fix: make code checker happy
RiedleroD Jan 20, 2025
150b325
fix: incorrect drop-down selection ID readout at module type
RiedleroD Jan 20, 2025
1da2464
fix: return module fullname instead of shortname
RiedleroD Jan 21, 2025
8b89024
fix: timezone bullshittery
RiedleroD Jan 21, 2025
50dcde9
fix: made codechecker happy
RiedleroD Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 54 additions & 145 deletions lbplanner/classes/helpers/modules_helper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@
namespace local_lbplanner\helpers;

use core_customfield\category_controller;
use core_external\{external_single_structure, external_value};
use moodle_url;
use DateTimeImmutable;
use DateTimeZone;
use local_lbplanner\enums\{MODULE_STATUS, MODULE_GRADE, MODULE_TYPE};
use local_modcustomfields\customfield\mod_handler;
use local_lbplanner\model\module;

/**
* Contains helper functions for working with modules.
Expand Down Expand Up @@ -71,218 +71,127 @@ class modules_helper {
*/
const SUBMISSION_STATUS_SUBMITTED = 'submitted';

/**
* The return structure of a module.
*
* @return external_single_structure The structure of a module.
*/
public static function structure(): external_single_structure {
return new external_single_structure(
[
'moduleid' => new external_value(PARAM_INT, 'Module ID'),
'name' => new external_value(PARAM_TEXT, 'Shortened module name (max. 5 chars)'),
'courseid' => new external_value(PARAM_INT, 'Course ID'),
'status' => new external_value(PARAM_INT, 'Module status '.MODULE_STATUS::format()),
'type' => new external_value(PARAM_INT, 'Module type '.MODULE_TYPE::format()),
'url' => new external_value(PARAM_TEXT, 'URL to moodle page for module'),
'grade' => new external_value(PARAM_INT, 'The grade of the module '.MODULE_GRADE::format()),
'deadline' => new external_value(PARAM_INT, 'The deadline of the module set by the teacher'),
]
);
}

/**
* Determins the enum value for a grade.
* TODO: this is bullshit.
*
* @param int $grade The grade of the module.
* @param int $maxgrade The max. grade of the module.
* @param int $mingrade The min. grade of the module.
* @param int $gradepass The grade to pass the module.
* @return integer The enum value for the grade.
*/
public static function determin_uinified_grade(int $grade, int $maxgrade, int $mingrade, int $gradepass): int {
if ($grade < $gradepass) {
return MODULE_GRADE::RIP;
}

$maxgrade = $maxgrade - $mingrade;

$p = $grade / $maxgrade;
public static function determine_uinified_grade(int $grade, int $maxgrade, int $gradepass): int {
$p = ($grade - $gradepass) / ($maxgrade - $gradepass);

if ($p >= 0.9) {
if ($p >= 0.75) {
return MODULE_GRADE::EKV;
} else if ($p >= 0.8) {
} else if ($p >= 0.50) {
return MODULE_GRADE::EK;
} else if ($p >= 0.7) {
} else if ($p >= 0.25) {
return MODULE_GRADE::GKV;
} else if ($p >= 0.4) {
} else if ($p >= 0) {
return MODULE_GRADE::GK;
} else {
return MODULE_GRADE::RIP;
}
}

/**
* Maps the given info to a module status.
*
* @param bool $submitted Whether the module is submitted.
* @param bool $done Whether the module is completed.
* @param bool $late Whether the module is late.
* @return integer The enum value for the module status.
*/
public static function map_status(bool $submitted, bool $done, bool $late): int {
if ($done) {
return MODULE_STATUS::DONE;
} else if ($submitted) {
return MODULE_STATUS::UPLOADED;
} else if ($late) {
return MODULE_STATUS::LATE;
} else {
return MODULE_STATUS::PENDING;
}
}

/**
* Checks what type the module is.
*
* @param int $moduleid The ID of the module.
* @param int $cmid The course module ID associated with the module.
* @return int The enum value for the module type.
* @throws \moodle_exception
*/
public static function determine_type(int $moduleid): int {
public static function determine_type(int $cmid): int {
$catid = config_helper::get_category_id();
if ($catid === -1) {
throw new \moodle_exception('couldn\'t find custom fields category ID');
}
$categorycontroller = category_controller::create($catid);
$instancedata = $categorycontroller->get_handler()->get_instance_data($moduleid);
$instancedata = $categorycontroller->get_handler()->get_instance_data($cmid);
if (count($instancedata) === 0) {
throw new \moodle_exception("couldn't find any instance data for module ID {$moduleid} in category ID {$catid}");
throw new \moodle_exception("couldn't find any instance data for module ID {$cmid} in category ID {$catid}");
} else if (count($instancedata) > 1) {
throw new \moodle_exception("found multiple data for module ID {$cmid} in category ID {$catid}");
}
$type = intval($instancedata[1]->get('value')); // NOTE: why the hell is this on index one?
$type = intval($instancedata[1]->get_value()) - 1; // NOTE: why the hell is this on index one?
MODULE_TYPE::name_from($type); // Basically asserting that this value exists as a module type.
return $type;
}

/**
* Returns the url of the module.
*
* @param int $moduleid The id of the module.
* @param int $courseid The id of the course.
* @return string The url of the module.
* Returns status of a module
* @param module $module the module to query for
* @param int $userid the userid to see this in context of
* @param ?int $planid the planid of the user or null (param exists purely to deduplicate DB calls)
* @return int the module status
* @see \local_lbplanner\enums\MODULE_STATUS
*/
public static function get_module_url(int $moduleid, int $courseid): string {
public static function get_module_status(module $module, int $userid, ?int $planid = null): int {
global $DB;

$view = $DB->get_record(
self::COURSE_MODULES_TABLE,
['course' => $courseid, 'instance' => $moduleid, 'module' => 1]
);

return strval(new moodle_url('/mod/assign/view.php?id='.$view->id));
}

/**
* Retrieves a module of the given id for the given user.
*
* @param int $moduleid The id of the module.
* @param int $userid The id of the user.
* @return array The module.
*/
public static function get_module(int $moduleid, int $userid): array {
global $DB;
date_default_timezone_set('UTC');

// Get module data.
$module = $DB->get_record(self::ASSIGN_TABLE, ['id' => $moduleid]);
if ($planid === null) {
$planid = plan_helper::get_plan_id($userid);
}

// Determine module type.
$type = self::determine_type($moduleid);
// Getting some necessary data.
$assignid = $module->get_assignid();

// Check if there are any submissions or feedbacks for this module.

$submitted = false;

if ($DB->record_exists(self::SUBMISSIONS_TABLE, ['assignment' => $moduleid, 'userid' => $userid])) {
if ($DB->record_exists(self::SUBMISSIONS_TABLE, ['assignment' => $assignid, 'userid' => $userid])) {
$submission = $DB->get_record(
self::SUBMISSIONS_TABLE,
['assignment' => $moduleid, 'userid' => $userid]
['assignment' => $assignid, 'userid' => $userid]
);

$submitted = strval($submission->status) == self::SUBMISSION_STATUS_SUBMITTED;
if (strval($submission->status) === self::SUBMISSION_STATUS_SUBMITTED) {
return MODULE_STATUS::UPLOADED;
}
}

$done = false;
$grade = null;

if ($DB->record_exists(self::GRADES_TABLE, ['assignment' => $moduleid, 'userid' => $userid])) {
$moduleboundaries = $DB->get_record(self::GRADE_ITEMS_TABLE, ['iteminstance' => $moduleid]);
$grade = $module->get_grade($userid);

$mdlgrades = $DB->get_records(
self::GRADES_TABLE,
['assignment' => $moduleid, 'userid' => $userid]
);

$mdlgrade = end($mdlgrades);

if ($mdlgrade->grade > 0) {
$done = true;

$grade = self::determin_uinified_grade(
$mdlgrade->grade, $moduleboundaries->grademax,
$moduleboundaries->grademin,
$moduleboundaries->gradepass
);

$done = $grade != MODULE_GRADE::RIP;
}
if ($grade !== null && $grade !== MODULE_GRADE::RIP) {
return MODULE_STATUS::DONE;
}
// Check if the module is late.

$late = false;
$planid = plan_helper::get_plan_id($userid);
$deadline = $module->get_deadline($planid);

if ($DB->record_exists(plan_helper::DEADLINES_TABLE, ['planid' => $planid, 'moduleid' => $moduleid])) {
$deadline = $DB->get_record(plan_helper::DEADLINES_TABLE, ['planid' => $planid, 'moduleid' => $moduleid]);
$late = intval(date("Ymd", $deadline->deadlineend)) < intval(date("Ymd")) && !$done;
if ($deadline !== null) {
$utctz = new DateTimeZone('UTC');
$now = (new DateTimeImmutable('yesterday', $utctz));
// Take timestamp and remove time from it.
$deadlineend = $now->setTimestamp(intval($deadline->deadlineend))->setTime(0, 0, 0, 0);
if ($now->diff($deadlineend)->invert === 1) {
return MODULE_STATUS::LATE;
}
}

$status = self::map_status($submitted, $done, $late);

// Return the appropriate data.

return [
'moduleid' => $moduleid,
'name' => $module->name,
'courseid' => $module->course,
'status' => $status,
'type' => $type,
'url' => self::get_module_url($moduleid, $module->course),
'grade' => $grade,
'deadline' => $module->duedate > 0 ? $module->duedate : null,
];
return MODULE_STATUS::PENDING;
}

/**
* Reteruns all modules for the given course id.
* Returns all modules for the given course id.
*
* @param int $courseid The id of the course.
* @param int $userid The id of the user.
* @param bool $ekenabled Whether EK modules should be included.
* @return array The modules.
* @return module[] The modules.
*/
public static function get_all_course_modules(int $courseid, int $userid, bool $ekenabled): array {
public static function get_all_modules_by_course(int $courseid, bool $ekenabled): array {
global $DB;

$mdlmodules = $DB->get_records(self::ASSIGN_TABLE, ['course' => $courseid]);
$assignments = $DB->get_records(self::ASSIGN_TABLE, ['course' => $courseid]);

$modules = [];

foreach ($mdlmodules as $mdlmodule) {
if (!$ekenabled && self::determine_type($mdlmodule->id) == MODULE_TYPE::EK) {
foreach ($assignments as $assign) {
$module = module::from_assignobj($assign);
if (!$ekenabled && self::determine_type($module->get_assignid()) == MODULE_TYPE::EK) {
continue;
}
$module = self::get_module($mdlmodule->id, $userid);
if ($module != null) {
$modules[] = $module;
}
Expand Down
28 changes: 28 additions & 0 deletions lbplanner/classes/helpers/plan_helper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
namespace local_lbplanner\helpers;

use core_external\{external_value, external_single_structure, external_multiple_structure};
use DateTimeImmutable;
use DateTimeZone;
use local_lbplanner\enums\PLAN_ACCESS_TYPE;

/**
Expand Down Expand Up @@ -315,5 +317,31 @@ public static function get_invites_received(int $userid): array {
$invites = $DB->get_records(self::INVITES_TABLE, ['inviteeid' => $userid]);
return $invites;
}

/**
* normalizes timestamp from UTC to server's localtime
* @param int $utcts UNIX timestamp in UTC+0
* @return int UNIX timestamp in localtime
*/
public static function timestamp_utc_to_localtime(int $utcts) {
return (new DateTimeImmutable())
->setTimezone(new DateTimeZone('UTC+0'))
->setTimestamp($utcts)
->setTimezone(new DateTimeZone(date_default_timezone_get()))
->getTimestamp();
}

/**
* normalizes timestamp from server's localtime to UTC
* @param int $localts UNIX timestamp in localtime
* @return int UNIX timestamp in UTC+0
*/
public static function timestamp_localtime_to_utc(int $localts) {
return (new DateTimeImmutable())
->setTimezone(new DateTimeZone(date_default_timezone_get()))
->setTimestamp($localts)
->setTimezone(new DateTimeZone('UTC+0'))
->getTimestamp();
}
}

Loading
Loading