alex/canvasManagement
1
0
Fork 0
mirror of https://github.com/alexmickelson/canvasManagement.git synced 2026-03-25 23:28:33 -06:00
Code Issues Packages Projects Releases Wiki Activity

after removing canvas id from module

Browse Source
This commit is contained in:
Alex Mickelson
2023-11-06 07:54:17 -07:00
parent 3252e3ca9f
commit bda13f7bec
13 changed files with 357 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Management/Features/Configuration/AssignmentEditorContext.cs
View File

@@ -1,3 +1,4 @@
using CanvasModel.Modules;
using LocalModels;
using Management.Planner;
using Management.Services;
@@ -39,7 +40,7 @@ public class AssignmentEditorContext
if (planner.LocalCourse != null)
{
// run discovery on Assignment, it was the last stored version of the assignment
var currentModule = getCurrentModule(Assignment, planner.LocalCourse);
var currentModule = getCurrentLocalModule(Assignment, planner.LocalCourse);
var updatedModules = planner.LocalCourse.Modules
.Select(
@@ -146,16 +147,11 @@ public class AssignmentEditorContext
canvas: canvas
);
var currentModule = getCurrentModule(Assignment, planner.LocalCourse);
if (currentModule.CanvasId == null)
{
logger.Log("was able to add assignment to canvas, but errored while making module item. module canvasId is null");
return;
}
var canvasModule = getCurrentCanvasModule(Assignment, planner.LocalCourse);
await canvas.CreateModuleItem(
(ulong)courseCanvasId,
(ulong)currentModule.CanvasId,
canvasModule.Id,
Assignment.Name,
"Assignment",
createdAssignmentCanvasId
@@ -163,17 +159,25 @@ public class AssignmentEditorContext
await planner.LocalCourse.Modules.First().SortModuleItems(
(ulong)courseCanvasId,
(ulong)currentModule.CanvasId,
canvasModule.Id,
canvas
);
logger.Log($"finished adding assignment {Assignment.Name} to canvas");
}
private static LocalModule getCurrentModule(LocalAssignment assignment, LocalCourse course)
private static LocalModule getCurrentLocalModule(LocalAssignment assignment, LocalCourse course)
{
return course.Modules.FirstOrDefault(
m => m.Assignments.Select(a => a.Name).Contains(assignment.Name)
)
?? throw new Exception("could not find current module in assignment editor context");
}
private CanvasModule getCurrentCanvasModule(LocalAssignment assignment, LocalCourse course)
{
var localModule = getCurrentLocalModule(assignment, course);
var canvasModule = planner.CanvasModules?.FirstOrDefault(m => m.Name == localModule.Name)
?? throw new Exception($"error in assignment context, canvas module with name {localModule.Name} not found in planner");
return canvasModule;
}
}

7
Management/Features/Configuration/CoursePlanner.cs
View File

@@ -76,12 +76,12 @@ public class CoursePlanner
public IEnumerable<CanvasAssignmentGroup>? CanvasAssignmentGroups { get; internal set; }
public IEnumerable<CanvasQuiz>? CanvasQuizzes { get; internal set; }
public IEnumerable<CanvasModule>? CanvasModules { get; internal set; }
public Dictionary<ulong, IEnumerable<CanvasModuleItem>>? CanvasModulesItems { get; internal set; }
public Dictionary<CanvasModule, IEnumerable<CanvasModuleItem>>? CanvasModulesItems { get; internal set; }
public async Task<(
IEnumerable<CanvasAssignment> CanvasAssignments,
IEnumerable<CanvasModule> CanvasModules,
Dictionary<ulong, IEnumerable<CanvasModuleItem>> CanvasModulesItems,
Dictionary<CanvasModule, IEnumerable<CanvasModuleItem>> CanvasModulesItems,
IEnumerable<CanvasQuiz> canvasQuizzes,
IEnumerable<CanvasAssignmentGroup> canvasAssignmentGroups
)> LoadCanvasData()
@@ -155,12 +155,11 @@ public class CoursePlanner
};
var newModules = await LocalCourse.CreateAllModules(
await LocalCourse.CreateAllModules(
canvasId,
CanvasModules,
canvas
);
LocalCourse = LocalCourse with { Modules = newModules };
CanvasModules = await canvas.Modules.GetModules(canvasId);
await LocalCourse.SortCanvasModulesByLocalOrder(canvasId, CanvasModules, canvas);

4
Management/Features/Configuration/CoursePlannerValidationExtensions.cs
View File

@@ -87,7 +87,7 @@ public static class CoursePlannerExtensions
IEnumerable<CanvasQuiz> canvasQuizzes
)
{
var moduleIdInCanvas = canvasModules.FirstOrDefault(m => m.Id == module.CanvasId) != null;
var moduleIdInCanvas = canvasModules.FirstOrDefault(m => m.Name == module.Name) != null;
var moduleWithAssignments = module with
{
Assignments = module.Assignments
@@ -100,7 +100,7 @@ public static class CoursePlannerExtensions
Console.WriteLine(
$"no id in canvas for module, removing old canvas id: {moduleWithAssignments.Name}"
);
return moduleWithAssignments with { CanvasId = null };
return moduleWithAssignments;
}
return moduleWithAssignments;
}

24
Management/Features/Configuration/QuizEditorContext.cs
View File

@@ -1,4 +1,5 @@
using System.Reflection.Metadata.Ecma335;
using CanvasModel.Modules;
using LocalModels;
using Management.Planner;
using Management.Services;
@@ -32,7 +33,7 @@ public class QuizEditorContext
{
if (_quiz == null && value != null)
{
_module = getCurrentModule(value, planner.LocalCourse);
_module = getCurrentLocalModule(value, planner.LocalCourse);
}
_quiz = value;
StateHasChanged?.Invoke();
@@ -115,16 +116,11 @@ public class QuizEditorContext
return;
}
var currentModule = getCurrentModule(Quiz, planner.LocalCourse);
if (currentModule.CanvasId == null)
{
logger.Log("was able to add quiz to canvas, but errored while making module item. module canvasId is null");
return;
}
var canvasModule = getCurrentCanvasModule(Quiz, planner.LocalCourse);
await canvas.CreateModuleItem(
(ulong)courseCanvasId,
(ulong)currentModule.CanvasId,
canvasModule.Id,
Quiz.Name,
"Quiz",
(ulong)canvasQuizId
@@ -132,17 +128,25 @@ public class QuizEditorContext
await planner.LocalCourse.Modules.First().SortModuleItems(
(ulong)courseCanvasId,
(ulong)currentModule.CanvasId,
canvasModule.Id,
canvas
);
logger.Log($"finished adding quiz {Quiz.Name} to canvas");
}
private static LocalModule getCurrentModule(LocalQuiz quiz, LocalCourse course)
private static LocalModule getCurrentLocalModule(LocalQuiz quiz, LocalCourse course)
{
return course.Modules.FirstOrDefault(
m => m.Quizzes.Select(q => q.Name + q.Description).Contains(quiz.Name + quiz.Description)
)
?? throw new Exception("could not find current module in quiz editor context");
}
private CanvasModule getCurrentCanvasModule(LocalQuiz quiz, LocalCourse course)
{
var localModule = getCurrentLocalModule(quiz, course);
var canvasModule = planner.CanvasModules?.FirstOrDefault(m => m.Name == localModule.Name)
?? throw new Exception($"error in quiz context, canvas module with name {localModule.Name} not found in planner");
return canvasModule;
}
}

71
Management/Features/Configuration/Synchronization/ModuleSyncronizationExtensions.cs
View File

@@ -6,7 +6,7 @@ namespace Management.Planner;
public static partial class ModuleSyncronizationExtensions
{
internal static async Task<IEnumerable<LocalModule>> CreateAllModules(
internal static async Task CreateAllModules(
this LocalCourse localCourse,
ulong canvasCourseId,
IEnumerable<CanvasModule> canvasModules,
@@ -15,21 +15,18 @@ public static partial class ModuleSyncronizationExtensions
{
var moduleTasks = localCourse.Modules.Select(async module =>
{
var canvasModule = canvasModules.FirstOrDefault(cm => cm.Id == module.CanvasId);
var canvasModule = canvasModules.FirstOrDefault(cm => cm.Name == module.Name);
if (canvasModule == null)
{
var newModule = await canvas.Modules.CreateModule(canvasCourseId, module.Name);
return module with { CanvasId = newModule.Id };
}
if (canvasModule.Name != module.Name)
if (canvasModule?.Name != module.Name) // TODO: maybe check to see if we have name change here
{
await canvas.Modules.UpdateModule(canvasCourseId, canvasModule.Id, module.Name, canvasModule.Position);
}
return module;
});
var newModules = await Task.WhenAll(moduleTasks);
return newModules ?? throw new Exception("Error ensuring all modules exist in canvas");
await Task.WhenAll(moduleTasks);
}
internal static async Task SortCanvasModulesByLocalOrder(
@@ -42,13 +39,14 @@ public static partial class ModuleSyncronizationExtensions
var currentCanvasPositions = canvasModules.ToDictionary(m => m.Id, m => m.Position);
foreach (var (localModule, i) in localCourse.Modules.Select((m, i) => (m, i)))
{
uint correctPosition = (uint)(i + 1);
var moduleCanvasId =
localModule.CanvasId ?? throw new Exception("cannot sort module if no module canvas id");
var currentCanvasPosition = currentCanvasPositions[moduleCanvasId];
var canvasModule = canvasModules.FirstOrDefault(c => c.Name == localModule.Name) ?? throw new Exception($"error sorting canvas module, could not find canvas module with name {localModule.Name}"); ;
var currentCanvasPosition = currentCanvasPositions[canvasModule.Id];
if (currentCanvasPosition != correctPosition)
{
await canvas.Modules.UpdateModule(canvasId, moduleCanvasId, localModule.Name, correctPosition);
await canvas.Modules.UpdateModule(canvasId, canvasModule.Id, localModule.Name, correctPosition);
}
}
}
@@ -59,15 +57,15 @@ public static partial class ModuleSyncronizationExtensions
CanvasService canvas
)
{
var canvasModules = await canvas.Modules.GetModules(canvasId);
return localCourse with
{
Modules = localCourse.Modules.Select(m =>
{
var canvasModule = canvasModules.FirstOrDefault(cm => cm.Name == m.Name);
return canvasModule == null ? m : m with { CanvasId = canvasModule.Id };
})
};
// var canvasModules = await canvas.Modules.GetModules(canvasId);
return localCourse;
// {
// Modules = localCourse.Modules.Select(m =>
// {
// var canvasModule = canvasModules.FirstOrDefault(cm => cm.Name == m.Name);
// return canvasModule == null ? m : m with { CanvasId = canvasModule.Id };
// })
// };
}
public static async Task SortModuleItems(
@@ -112,15 +110,15 @@ public static partial class ModuleSyncronizationExtensions
internal static async Task<bool> EnsureAllModulesItemsCreated(
this LocalModule localModule,
ulong canvasId,
ulong moduleCanvasId,
Dictionary<ulong, IEnumerable<CanvasModuleItem>> canvasModulesItems,
CanvasModule canvasModule,
Dictionary<CanvasModule, IEnumerable<CanvasModuleItem>> canvasModulesItems,
CanvasService canvas
)
{
var anyUpdated = false;
foreach (var localAssignment in localModule.Assignments.Where(a => a.DueAt > DateTime.Now))
{
var canvasModuleItemContentIds = canvasModulesItems[moduleCanvasId].Select(i => i.ContentId);
var canvasModuleItemContentIds = canvasModulesItems[canvasModule].Select(i => i.ContentId);
if (!canvasModuleItemContentIds.Contains(localAssignment.CanvasId))
{
var canvasAssignmentId =
@@ -128,7 +126,7 @@ public static partial class ModuleSyncronizationExtensions
?? throw new Exception("cannot create module item if assignment does not have canvas id");
await canvas.CreateModuleItem(
canvasId,
moduleCanvasId,
canvasModule.Id,
localAssignment.Name,
"Assignment",
canvasAssignmentId
@@ -142,29 +140,34 @@ public static partial class ModuleSyncronizationExtensions
internal static async Task SyncModuleItemsWithCanvas(
this LocalCourse localCourse,
ulong canvasId,
Dictionary<ulong, IEnumerable<CanvasModuleItem>> canvasModulesItems,
ulong courseCanvasId,
Dictionary<CanvasModule, IEnumerable<CanvasModuleItem>> canvasModulesItems,
CanvasService canvas
)
{
foreach (var localModule in localCourse.Modules)
{
var moduleCanvasId =
localModule.CanvasId
?? throw new Exception("cannot sync canvas modules items if module not synced with canvas");
// var moduleCanvasId =
// localModule.CanvasId
// ?? throw new Exception("cannot sync canvas modules items if module not synced with canvas");
var canvasModule = canvasModulesItems.Keys.FirstOrDefault(k => k.Name == localModule.Name);
if(canvasModule == null)
{
throw new Exception($"cannot sync module items in canvas, could not find module with name ${localModule.Name}");
}
bool anyUpdated = await localModule.EnsureAllModulesItemsCreated(
canvasId,
moduleCanvasId,
courseCanvasId,
canvasModule,
canvasModulesItems,
canvas
);
var canvasModuleItems = anyUpdated
? await canvas.Modules.GetModuleItems(canvasId, moduleCanvasId)
: canvasModulesItems[moduleCanvasId];
? await canvas.Modules.GetModuleItems(courseCanvasId, canvasModule.Id)
: canvasModulesItems[canvasModule];
await localModule.SortModuleItems(canvasId, moduleCanvasId, canvas);
await localModule.SortModuleItems(courseCanvasId, canvasModule.Id, canvas);
}
}
}

10
Management/Models/Local/LocalCourse.cs
View File

@@ -27,6 +27,16 @@ public record LocalCourseSettings
var yaml = serializer.Serialize(this);
return yaml;
}
public static LocalCourseSettings ParseYaml(string rawText)
{
var deserializer = new DeserializerBuilder()
.IgnoreUnmatchedProperties()
.Build();
var settings = deserializer.Deserialize<LocalCourseSettings>(rawText);
return settings;
}
}
public record SimpleTimeOnly

2
Management/Models/Local/LocalModules.cs
View File

@@ -4,7 +4,7 @@ public record LocalModule
{
public string Name { get; init; } = string.Empty;
public string Id { get; init; } = DateTime.UtcNow.Ticks.ToString();
public ulong? CanvasId { get; set; } = null;
// public ulong? CanvasId { get; set; } = null;
public string Notes { get; set; } = string.Empty;
public IEnumerable<LocalAssignment> Assignments { get; init; } =
Enumerable.Empty<LocalAssignment>();

6
Management/Services/Canvas/CanvasModuleService.cs
View File

@@ -65,7 +65,7 @@ public class CanvasModuleService
return items;
}
public async Task<Dictionary<ulong, IEnumerable<CanvasModuleItem>>> GetAllModulesItems(
public async Task<Dictionary<CanvasModule, IEnumerable<CanvasModuleItem>>> GetAllModulesItems(
ulong courseId,
IEnumerable<CanvasModule> modules
)
@@ -78,7 +78,7 @@ public class CanvasModuleService
}
);
var output = new Dictionary<ulong, IEnumerable<CanvasModuleItem>>();
var output = new Dictionary<CanvasModule, IEnumerable<CanvasModuleItem>>();
var itemTasksResult = await Task.WhenAll(itemsTasks);
foreach (var (module, items) in itemTasksResult)
{
@@ -86,7 +86,7 @@ public class CanvasModuleService
throw new Exception(
"i'm not sure how we got here, but module and items are null after looking up module items"
);
output[module.Id] = items;
output[module] = items;
}
return output;
}

25
Management/Services/Canvas/CanvasQuizService.cs
View File

@@ -1,27 +1,18 @@
using System.Runtime.InteropServices;
using System.Security.Cryptography.X509Certificates;
using CanvasModel.Quizzes;
using LocalModels;
using RestSharp;
namespace Management.Services.Canvas;
public class CanvasQuizService
public class CanvasQuizService(
IWebRequestor webRequestor,
CanvasServiceUtils utils,
CanvasAssignmentService assignments
)
{
private readonly IWebRequestor webRequestor;
private readonly CanvasServiceUtils utils;
private readonly CanvasAssignmentService assignments;
public CanvasQuizService(
IWebRequestor webRequestor,
CanvasServiceUtils utils,
CanvasAssignmentService assignments
)
{
this.webRequestor = webRequestor;
this.utils = utils;
this.assignments = assignments;
}
private readonly IWebRequestor webRequestor = webRequestor;
private readonly CanvasServiceUtils utils = utils;
private readonly CanvasAssignmentService assignments = assignments;
public async Task<IEnumerable<CanvasQuiz>> GetAll(ulong courseId)
{

86
Management/Services/FileStorageManager.cs
View File

@@ -6,9 +6,12 @@ using YamlDotNet.Serialization.NamingConventions;
public class FileStorageManager
{
private readonly MyLogger<FileStorageManager> logger;
private static readonly string _basePath = "../storage";
public FileStorageManager(MyLogger<FileStorageManager> logger)
{
if (!Directory.Exists(_basePath))
throw new Exception("storage folder not found");
this.logger = logger;
}
public string CourseToYaml(LocalCourse course)
@@ -32,18 +35,18 @@ public class FileStorageManager
{
var courseString = CourseToYaml(course);
var courseDirectory = $"../storage/{course.Settings.Name}";
var courseDirectory = $"{_basePath}/{course.Settings.Name}";
if (!Directory.Exists(courseDirectory))
Directory.CreateDirectory(courseDirectory);
await saveModules(course);
await File.WriteAllTextAsync($"../storage/{course.Settings.Name}.yml", courseString);
await File.WriteAllTextAsync($"{_basePath}/{course.Settings.Name}.yml", courseString);
}
private async Task saveModules(LocalCourse course)
{
var courseDirectory = $"../storage/{course.Settings.Name}";
var courseDirectory = $"{_basePath}/{course.Settings.Name}";
await saveSettings(course, courseDirectory);
foreach (var module in course.Modules)
@@ -67,7 +70,7 @@ public class FileStorageManager
private async Task saveQuizzes(LocalCourse course, LocalModule module)
{
var quizzesDirectory = $"../storage/{course.Settings.Name}/{module.Name}/quizzes";
var quizzesDirectory = $"{_basePath}/{course.Settings.Name}/{module.Name}/quizzes";
if (!Directory.Exists(quizzesDirectory))
Directory.CreateDirectory(quizzesDirectory);
@@ -106,7 +109,7 @@ public class FileStorageManager
private async Task saveAssignments(LocalCourse course, LocalModule module)
{
var assignmentsDirectory = $"../storage/{course.Settings.Name}/{module.Name}/assignments";
var assignmentsDirectory = $"{_basePath}/{course.Settings.Name}/{module.Name}/assignments";
if (!Directory.Exists(assignmentsDirectory))
Directory.CreateDirectory(assignmentsDirectory);
@@ -139,22 +142,83 @@ public class FileStorageManager
logger.Log($"removing old assignment, it has probably been renamed {file}");
File.Delete(file);
}
}
public async Task<IEnumerable<LocalCourse>> LoadSavedCourses()
{
string path = "../storage/";
if (!Directory.Exists(path))
throw new Exception("storage folder not found");
var fileNames = Directory.GetFiles(path);
var fileNames = Directory.GetFiles(_basePath);
var courses = await Task.WhenAll(
fileNames
.Where(name => name.EndsWith(".yml"))
.Select(async n => ParseCourse(await File.ReadAllTextAsync($"../storage/{n}")))
.Select(async n => ParseCourse(await File.ReadAllTextAsync($"{_basePath}/{n}")))
);
return courses;
}
// public async Task<LocalCourse> LoadCourseByName(string courseName)
// {
// var courseDirectory = $"{_basePath}/{courseName}";
// if (!Directory.Exists(courseDirectory))
// {
// var errorMessage = $"error loading course by name, could not find folder {courseDirectory}";
// logger.Log(errorMessage);
// throw new LoadCourseFromFileException(errorMessage);
// }
// var settingsPath = $"{courseDirectory}/settings.yml";
// if (!Directory.Exists(settingsPath))
// {
// var errorMessage = $"error loading course by name, settings file {settingsPath}";
// logger.Log(errorMessage);
// throw new LoadCourseFromFileException(errorMessage);
// }
// var settingsString = await File.ReadAllTextAsync(settingsPath);
// var settings = LocalCourseSettings.ParseYaml(settingsString);
// var modulePaths = Directory.GetDirectories(courseDirectory);
// var modules = modulePaths
// .Select(LoadModuleFromPath)
// .ToArray();
// }
// public async Task<LocalModule> LoadModuleFromPath(string modulePath)
// {
// var assignmentsPath = $"{modulePath}/assignments";
// if (!Directory.Exists(assignmentsPath))
// {
// var errorMessage = $"error loading course by name, assignments folder does not exist in {modulePath}";
// logger.Log(errorMessage);
// throw new LoadCourseFromFileException(errorMessage);
// }
// var quizzesPath = $"{modulePath}/quizzes";
// if (!Directory.Exists(quizzesPath))
// {
// var errorMessage = $"error loading course by name, quizzes folder does not exist in {modulePath}";
// logger.Log(errorMessage);
// throw new LoadCourseFromFileException(errorMessage);
// }
// var assignments = LoadAssignmentsFromPath(assignmentsPath);
// var quizzes = LoadQuizzesFromPath(quizzesPath);
// }
// public async Task<IEnumerable<LocalAssignment>> LoadAssignmentsFromPath(string assignmentsFolder)
// {
// }
// public async Task<IEnumerable<LocalAssignment>> LoadQuizzesFromPath(string quizzesFolder)
// {
// }
}
public class LoadCourseFromFileException(string message) : Exception(message)
{
}