inginious.frontend.pages package

Frontend pages (controllers)

Subpackages

• inginious.frontend.pages.api package
  • Submodules
  • inginious.frontend.pages.api.auth_methods module
    • APIAuthMethods
      • APIAuthMethods.API_GET()
      • APIAuthMethods.methods
  • inginious.frontend.pages.api.authentication module
    • APIAuthentication
      • APIAuthentication.API_GET()
      • APIAuthentication.API_POST()
      • APIAuthentication.methods
  • inginious.frontend.pages.api.courses module
    • APICourses
      • APICourses.API_GET()
      • APICourses.methods
  • inginious.frontend.pages.api.submissions module
    • APISubmissionSingle
      • APISubmissionSingle.API_GET()
      • APISubmissionSingle.methods
    • APISubmissions
      • APISubmissions.API_GET()
      • APISubmissions.API_POST()
      • APISubmissions.methods
  • inginious.frontend.pages.api.tasks module
    • APITasks
      • APITasks.API_GET()
      • APITasks.methods
• inginious.frontend.pages.course_admin package
  • Submodules
  • inginious.frontend.pages.course_admin.audience_edit module
    • CourseEditAudience
      • CourseEditAudience.GET_AUTH()
      • CourseEditAudience.POST_AUTH()
      • CourseEditAudience.display_page()
      • CourseEditAudience.get_user_lists()
      • CourseEditAudience.methods
  • inginious.frontend.pages.course_admin.danger_zone module
    • CourseDangerZonePage
      • CourseDangerZonePage.GET_AUTH()
      • CourseDangerZonePage.POST_AUTH()
      • CourseDangerZonePage.delete_course()
      • CourseDangerZonePage.dump_course()
      • CourseDangerZonePage.get_backup_list()
      • CourseDangerZonePage.methods
      • CourseDangerZonePage.page()
      • CourseDangerZonePage.restore_course()
      • CourseDangerZonePage.wipe_course()
  • inginious.frontend.pages.course_admin.settings module
    • CourseSettingsPage
      • CourseSettingsPage.GET_AUTH()
      • CourseSettingsPage.POST_AUTH()
      • CourseSettingsPage.define_tags()
      • CourseSettingsPage.methods
      • CourseSettingsPage.page()
      • CourseSettingsPage.prepare_datas()
  • inginious.frontend.pages.course_admin.student_list module
    • CourseStudentListPage
      • CourseStudentListPage.GET_AUTH()
      • CourseStudentListPage.POST_AUTH()
      • CourseStudentListPage.get_audiences_params()
      • CourseStudentListPage.get_requested_field_user_info()
      • CourseStudentListPage.get_student_list_params()
      • CourseStudentListPage.get_user_lists()
      • CourseStudentListPage.methods
      • CourseStudentListPage.page()
      • CourseStudentListPage.post_audiences()
      • CourseStudentListPage.post_groups()
      • CourseStudentListPage.post_student_list()
      • CourseStudentListPage.submission_url_generator_audience()
      • CourseStudentListPage.submission_url_generator_user()
      • CourseStudentListPage.update_audience()
      • CourseStudentListPage.update_group()
  • inginious.frontend.pages.course_admin.submission module
    • SubmissionPage
      • SubmissionPage.GET_AUTH()
      • SubmissionPage.POST_AUTH()
      • SubmissionPage.fetch_submission()
      • SubmissionPage.methods
      • SubmissionPage.page()
  • inginious.frontend.pages.course_admin.task_edit module
    • CourseEditTask
      • CourseEditTask.GET_AUTH()
      • CourseEditTask.POST_AUTH()
      • CourseEditTask.contains_is_html()
      • CourseEditTask.methods
      • CourseEditTask.parse_problem()
  • inginious.frontend.pages.course_admin.task_edit_file module
    • CourseTaskFileUpload
      • CourseTaskFileUpload.POST_AUTH()
      • CourseTaskFileUpload.methods
    • CourseTaskFiles
      • CourseTaskFiles.GET_AUTH()
      • CourseTaskFiles.POST_AUTH()
      • CourseTaskFiles.action_create()
      • CourseTaskFiles.action_delete()
      • CourseTaskFiles.action_download()
      • CourseTaskFiles.action_edit()
      • CourseTaskFiles.action_edit_save()
      • CourseTaskFiles.action_rename()
      • CourseTaskFiles.action_upload()
      • CourseTaskFiles.get_task_filelist()
      • CourseTaskFiles.methods
      • CourseTaskFiles.show_tab_file()
      • CourseTaskFiles.verify_path()
  • inginious.frontend.pages.course_admin.task_list module
    • CourseTaskListPage
      • CourseTaskListPage.GET_AUTH()
      • CourseTaskListPage.POST_AUTH()
      • CourseTaskListPage.clean_task_files()
      • CourseTaskListPage.methods
      • CourseTaskListPage.page()
      • CourseTaskListPage.submission_url_generator()
      • CourseTaskListPage.update_dispenser()
      • CourseTaskListPage.wipe_task()
  • inginious.frontend.pages.course_admin.utils module
    • CourseRedirectPage
      • CourseRedirectPage.GET_AUTH()
      • CourseRedirectPage.POST_AUTH()
      • CourseRedirectPage.methods
    • INGIniousAdminPage
      • INGIniousAdminPage.get_course_and_check_rights()
      • INGIniousAdminPage.methods
    • INGIniousSubmissionsAdminPage
      • INGIniousSubmissionsAdminPage.get_course_params()
      • INGIniousSubmissionsAdminPage.get_input_params()
      • INGIniousSubmissionsAdminPage.get_submissions_filter()
      • INGIniousSubmissionsAdminPage.get_users()
      • INGIniousSubmissionsAdminPage.methods
    • UnicodeWriter
      • UnicodeWriter.writerow()
      • UnicodeWriter.writerows()
    • get_menu()
    • make_csv()

Submodules

inginious.frontend.pages.group module

Index page

class inginious.frontend.pages.group.GroupPage

Bases: INGIniousAuthPage

Group page

GET_AUTH(courseid)

GET request

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

inginious.frontend.pages.course module

Course page

class inginious.frontend.pages.course.CoursePage

Bases: INGIniousAuthPage

Course page

GET_AUTH(courseid)

GET request

POST_AUTH(courseid)

POST request

get_course(courseid)

Return the course

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

preview_allowed(courseid)

If this function returns True, the auth check is disabled. Override this function with a custom check if needed.

show_page(course)

Prepares and shows the course page

inginious.frontend.pages.course.handle_course_unavailable(get_path, template_helper, user_manager, course)

Displays the course_unavailable page or the course registration page

inginious.frontend.pages.index module

Index page

class inginious.frontend.pages.index.IndexPage

Bases: INGIniousStaticPage

Index page

GET()

Display main course list page

POST()

Display main course list page

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

inginious.frontend.pages.maintenance module

Maintenance page

class inginious.frontend.pages.maintenance.MaintenancePage

Bases: MethodView

Maintenance page

get(path=None)

GET request

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post(path=None)

POST request

inginious.frontend.pages.tasks module

Task page

class inginious.frontend.pages.tasks.BaseTaskPage(calling_page)

Bases: object

Display a task (and allow to reload old submission/file uploaded during a submission)

GET(courseid, taskid, is_LTI)

GET request

POST(courseid, taskid, isLTI)

POST a new submission

preview_allowed(courseid, taskid)

submission_to_json(task, data, debug, reloading=False, replace=False, tags=None)

Converts a submission to json (keeps only needed fields)

class inginious.frontend.pages.tasks.TaskPage

Bases: INGIniousAuthPage

GET_AUTH(courseid, taskid)

POST_AUTH(courseid, taskid)

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

preview_allowed(courseid, taskid)

If this function returns True, the auth check is disabled. Override this function with a custom check if needed.

class inginious.frontend.pages.tasks.TaskPageStaticDownload

Bases: INGIniousPage

Allow to download files stored in the task folder

GET(courseid, taskid, path)

GET request

is_lti_page()

True if the current page allows LTI sessions. False else.

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

inginious.frontend.pages.utils module

Some utils for all the pages

class inginious.frontend.pages.utils.INGIniousAdministratorPage

Bases: INGIniousAuthPage

Augmented version of INGIniousAuthPage that checks if user is administrator (superadmin).

GET(*args, **kwargs)

Checks if user is superadmin and calls GET_AUTH or performs logout. Otherwise, returns the login template.

POST(*args, **kwargs)

Checks if user is superadmin and calls POST_AUTH. Otherwise, returns the forbidden template.

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class inginious.frontend.pages.utils.INGIniousAuthPage

Bases: INGIniousPage

Augmented version of INGIniousPage that checks if user is authenticated.

GET(*args, **kwargs)

Checks if user is authenticated and calls GET_AUTH or performs logout. Otherwise, returns the login template.

GET_AUTH(*args, **kwargs)

POST(*args, **kwargs)

Checks if user is authenticated and calls POST_AUTH or performs login and calls GET_AUTH. Otherwise, returns the login template.

POST_AUTH(*args, **kwargs)

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

preview_allowed(*args, **kwargs)

If this function returns True, the auth check is disabled. Override this function with a custom check if needed.

class inginious.frontend.pages.utils.INGIniousPage

Bases: MethodView

A base for all the pages of the INGInious webapp. Contains references to the PluginManager, the CourseFactory, and the SubmissionManager

GET(*args, **kwargs)

Handles GET requests. It should be redefined by subclasses.

POST(*args, **kwargs)

Handles POST requests. It should be redefined by subclasses.

property app

Returns the web application singleton

property backup_dir: str

Backup directory

property client: Client

Returns the INGInious client

property course_factory: CourseFactory

Returns the course factory singleton

property database: Database

Returns the database singleton

property default_allowed_file_extensions: List[str]

List of allowed file extensions

property default_max_file_size: int

Default maximum file size for upload

property environment_types: Dict[str, FrontendEnvType]

Available environment types

property environments: Dict[str, List[str]]

Available environments

get(*args, **kwargs)

Interfaces INGInious pages with Flask views for GET requests.

property gridfs: GridFS

Returns the GridFS singleton

property is_lti_page

True if the current page allows LTI sessions. False else.

property logger: Logger

Logger

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

property plugin_manager: PluginManager

Returns the plugin manager singleton

post(*args, **kwargs)

Interfaces INGInious pages with Flask views for POST requests.

property submission_manager: WebAppSubmissionManager

Returns the submission manager singleton

property task_factory: TaskFactory

Returns the task factory singleton

property template_helper: TemplateHelper

Returns the Template Helper singleton

property user_manager: UserManager

Returns the user manager singleton

property webdav_host: str

True if webdav is available

property webterm_link: str

Returns the link to the web terminal

class inginious.frontend.pages.utils.INGIniousStaticPage

Bases: INGIniousPage

GET(pageid)

Handles GET requests. It should be redefined by subclasses.

POST(pageid)

Handles POST requests. It should be redefined by subclasses.

cache = {}

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

show_page(page)

class inginious.frontend.pages.utils.LogOutPage

Bases: INGIniousAuthPage

GET_AUTH(*args, **kwargs)

POST_AUTH(*args, **kwargs)

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class inginious.frontend.pages.utils.SignInPage

Bases: INGIniousAuthPage

GET()

Checks if user is authenticated and calls GET_AUTH or performs logout. Otherwise, returns the login template.

GET_AUTH(*args, **kwargs)

POST_AUTH(*args, **kwargs)

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

inginious.frontend.pages.utils.generate_user_selection_box(user_manager, render_func, current_users, course_id, name, id, placeholder=None, single=False)

Returns the HTML for a user selection box. The user using the box must have admin/tutors rights on the course with id course_id.

The box will return, when submitted using a form, a list of usernames separated by commas, under the given name.

NB: this function is available in the templates directly as “$user_selection_box(current_users, course_id, name, id)”. You must ignore the first argument (template_helper) in the templates.

Parameters:

• user_manager (UserManager) – UserManager instance

• render_func – template generator

• current_users (List[str]) – a list of usernames currently selected

• course_id (str) – the course id

• name (str) – HTML name given to the box

• id (str) – HTML id given to the box

• single – False for multiple user selection, True for single user selection

Returns:

HTML code for the box

inginious.frontend.pages.utils.register_utils(database, user_manager, template_helper)

Registers utils in the template helper