headless_lms_server/programs/seed/seed_courses/
seed_graded.rs

1use crate::programs::seed::builder::certificate::CertificateBuilder;
2use crate::programs::seed::builder::chapter::ChapterBuilder;
3use crate::programs::seed::builder::context::SeedContext;
4use crate::programs::seed::builder::course::{CourseBuilder, CourseInstanceConfig};
5use crate::programs::seed::builder::module::{
6    CompletionBuilder, CompletionRegisteredBuilder, ModuleBuilder,
7};
8use crate::programs::seed::builder::page::PageBuilder;
9use crate::programs::seed::seed_courses::CommonCourseData;
10use crate::programs::seed::seed_helpers::paragraph;
11use anyhow::{Context, Result};
12use chrono::Utc;
13use headless_lms_models::certificate_configuration_to_requirements;
14use headless_lms_models::certificate_configurations::{
15    DatabaseCertificateConfiguration, insert as insert_certificate_configuration,
16};
17use headless_lms_models::course_instance_enrollments;
18use headless_lms_models::file_uploads;
19use headless_lms_models::roles::UserRole;
20use headless_lms_models::study_registry_registrars::get_or_create_default_registrar;
21use tracing::info;
22use uuid::Uuid;
23
24use super::super::seed_users::SeedUsersResult;
25
26pub async fn seed_graded_course(
27    course_id: Uuid,
28    course_name: &str,
29    course_slug: &str,
30    common_course_data: CommonCourseData,
31    seed_users_result: SeedUsersResult,
32) -> Result<Uuid> {
33    let CommonCourseData {
34        db_pool,
35        organization_id: org,
36        teacher_user_id,
37        student_user_id: _student,
38        langs_user_id: _langs_user_id,
39        example_normal_user_ids,
40        jwt_key: _jwt_key,
41        base_url: _base_url,
42    } = common_course_data;
43
44    let mut conn = db_pool.acquire().await?;
45    let cx = SeedContext {
46        teacher: teacher_user_id,
47        org,
48        base_course_ns: course_id,
49    };
50
51    info!("Inserting sample course {}", course_name);
52
53    // Build the graded module
54    let registrar_id = get_or_create_default_registrar(&mut conn).await?;
55
56    let mut module = ModuleBuilder::new()
57        .order(0)
58        .register_to_open_university(false)
59        .automatic_completion(Some(1), Some(1), false)
60        .default_registrar(registrar_id);
61
62    for (i, uid) in example_normal_user_ids.iter().enumerate() {
63        module = module.completion(
64            CompletionBuilder::new(*uid)
65                .grade(5)
66                .passed(true)
67                .registered(
68                    CompletionRegisteredBuilder::new().real_student_number(format!("52-{:03}", i)),
69                ),
70        );
71    }
72
73    // Build the actual course
74    let course_builder = CourseBuilder::new(course_name, course_slug)
75        .desc("A sample graded course that pre-seeds module completions for demo users.")
76        .chatbot(false)
77        .course_id(course_id)
78        .instance(CourseInstanceConfig {
79            name: None,
80            description: None,
81            support_email: None,
82            teacher_in_charge_name: "admin".to_string(),
83            teacher_in_charge_email: "admin@example.com".to_string(),
84            opening_time: None,
85            closing_time: None,
86            instance_id: Some(cx.v5(b"instance:graded")),
87        })
88        .role(seed_users_result.teacher_user_id, UserRole::Teacher)
89        .module(
90            module.chapter(
91                ChapterBuilder::new(1, "The Basics")
92                    .opens(Utc::now())
93                    .fixed_ids(cx.v5(b"chapter:1"), cx.v5(b"chapter:1:instance"))
94                    .page(
95                        PageBuilder::new("/chapter-1/page-1", "Welcome").block(paragraph(
96                            "This is the graded example course.",
97                            cx.v5(b"page:1:1"),
98                        )),
99                    ),
100            ),
101        );
102
103    // Insert course
104    let (course, default_instance, last_module) = course_builder.seed(&mut conn, &cx).await?;
105
106    // Enroll users to default instance
107    for uid in example_normal_user_ids.iter() {
108        course_instance_enrollments::insert(&mut conn, *uid, course.id, default_instance.id)
109            .await?;
110    }
111
112    let background_svg_path = "svgs/certificate-background.svg".to_string();
113
114    let background_svg_file_upload_id = file_uploads::insert(
115        &mut conn,
116        &format!("background-{}.svg", last_module.id),
117        &background_svg_path,
118        "image/svg+xml",
119        None,
120    )
121    .await?;
122
123    let configuration = DatabaseCertificateConfiguration {
124        id: Uuid::new_v5(&course_id, b"graded-course-certificate-configuration"),
125        certificate_owner_name_y_pos: None,
126        certificate_owner_name_x_pos: None,
127        certificate_owner_name_font_size: None,
128        certificate_owner_name_text_color: None,
129        certificate_owner_name_text_anchor: None,
130        certificate_validate_url_y_pos: None,
131        certificate_validate_url_x_pos: None,
132        certificate_validate_url_font_size: None,
133        certificate_validate_url_text_color: None,
134        certificate_validate_url_text_anchor: None,
135        certificate_date_y_pos: None,
136        certificate_date_x_pos: None,
137        certificate_date_font_size: None,
138        certificate_date_text_color: None,
139        certificate_date_text_anchor: None,
140        certificate_locale: None,
141        paper_size: None,
142        background_svg_path,
143        background_svg_file_upload_id,
144        overlay_svg_path: None,
145        overlay_svg_file_upload_id: None,
146        render_certificate_grade: true,
147        certificate_grade_y_pos: None,
148        certificate_grade_x_pos: None,
149        certificate_grade_font_size: None,
150        certificate_grade_text_color: None,
151        certificate_grade_text_anchor: None,
152    };
153
154    let database_configuration = insert_certificate_configuration(&mut conn, &configuration)
155        .await
156        .context("insert certificate configuration")?;
157
158    certificate_configuration_to_requirements::insert(
159        &mut conn,
160        database_configuration.id,
161        Some(last_module.id),
162    )
163    .await?;
164
165    // Now that the module has a configuration, generate certificates for the demo users
166    for uid in example_normal_user_ids.iter() {
167        CertificateBuilder::new(*uid)
168            .default_configuration_for_module(last_module.id)
169            .name_on_certificate(format!("Demo User {}", uid))
170            .seed(&mut conn)
171            .await?;
172    }
173
174    Ok(course_id)
175}