Improvements to the course directory update method. #2173

drgrice1 · 2023-08-11T22:55:39Z

This always creates a course directory if it is missing. It also attempts to fix permissions if those are not correct. It does not attempt to change ownership or the group as that will almost always fail, and will need to be done manually.

The directories that can be copied from the model course are copied if a directory is created. This is only done if the path did not exist to begin with.

This is a much improved approach to #2169 or #2170.

pstaabp

The hardcopyTheme in the course upgrades was bugging me this week on our production server. Good fix.

Alex-Jordan · 2023-08-17T21:56:20Z

This now has conflicts.

drgrice1 · 2023-08-17T22:05:22Z

The conflicts are fixed. Thanks.

Alex-Jordan · 2023-10-22T19:43:30Z

lib/WeBWorK/Utils/CourseIntegrityCheck.pm


-	#FIXME this is hardwired for the time being.
-	my %updateable_directories = (html_temp => 1, mailmerge => 1, tmpEditFileDir => 1, hardcopyThemes => 1);
+	# All $courseDirs keys should be listed here except for root.  The keys of the $courseDirs hash can not be used


Did you consider sorting the keys? This is not tested, but I mean using sort like:

@course_dirs = sort { $courseDirs{$b} =~ /^$courseDirs{$a}/ } (keys %courseDirs);

so it sorts based on if a path is a super path to another path, by assuming the super path's string is a starting substring of the sub path's string.

It would correctly sort things so that for example aa/bb would come before aa/bb/cc. It would also harmlessly sort things like aa/bb to come before aa/bbb. It would not sort things like aa//bb to come before aa/bb/cc but that seems like someone shouldn't configure that way.

I also wondered if there is an OS utility to check if some path is a subpath of some other path. And it could be sorted that way more robustly.

That is a good idea. Although I think you meant

@course_dirs = sort { $courseDirs{$a} =~ /^$courseDirs{$b}/ } keys %courseDirs;

With your code it would be a reverse lexical sort on the directories, and so aa/bb would come after aa/bb/cc.

I have tested this with the forward sort, and I will add it to this pull request (also removing the root directory).

We probably don't need to worry about things like aa//bb. Although that sort of thing is not unlikely if a path is built from another path and the first path already has a forward slash at the end and the built path adds another (this is very common with paths in webwork). However, I don't think that has happened with these paths in the course environment (with default settings at least).

This always creates a course directory if it is missing. It also attempts to fix permissions if those are not correct. It does not attempt to change ownership or the group as that will almost always fail, and will need to be done manually. The directories that can be copied from the model course are copied if a directory is created. This is only done if the path did not exist to begin with.

Alex-Jordan · 2023-10-22T19:45:19Z

lib/WeBWorK/Utils/CourseIntegrityCheck.pm


-	#FIXME this is hardwired for the time being.
-	my %updateable_directories = (html_temp => 1, mailmerge => 1, tmpEditFileDir => 1, hardcopyThemes => 1);
+	# All $courseDirs keys should be listed here except for root.  The keys of the $courseDirs hash can not be used


I also wondered if there is an OS utility to check if some path is a subpath of some other path. And it could be sorted that way more robustly.

Alex-Jordan · 2023-10-23T19:23:53Z

conf/defaults.config

@@ -339,6 +339,10 @@ $webworkURLs{AuthorHelpURL}           ='https://webwork.maa.org/wiki/Category:Au
 # Defaults for course-specific locations (directories and URLs)
 ################################################################################

+# Developer note: Make sure to keep the list of directories in the updateCourseDirectories method


Is this comment needed now with the recent change?

No its not. I removed it.

I don't know of a utility that checks if a path is a sub directory of another directly. There are utilities that split a path into parts though. So you could split the path into parts, and then sort on the parts much like sorting by last name, then first name. If a path has more parts then another, then it would be sorted later.

There is path_is_subdir in WeBWorK/Utils.pm, though unsure how efficient that would be.

@somiaj: Yeah, we just discussed that in the meeting.

@Alex-Jordan

As suggested by @Alex-Jordan, sort by paths using keys from the courseDirs hash in the course enviroment.

drgrice1 force-pushed the update-course-dirs-improved branch 3 times, most recently from 925be98 to b8156fb Compare August 11, 2023 23:04

pstaabp approved these changes Aug 15, 2023

View reviewed changes

drgrice1 mentioned this pull request Aug 15, 2023

remove references to external programs in favor of packages #2172

Merged

drgrice1 force-pushed the update-course-dirs-improved branch from b8156fb to 5a21be8 Compare August 17, 2023 11:14

drgrice1 force-pushed the update-course-dirs-improved branch 2 times, most recently from 6d9b9d6 to f487564 Compare August 17, 2023 22:01

drgrice1 force-pushed the update-course-dirs-improved branch 2 times, most recently from 595fe3c to 80d9713 Compare August 23, 2023 01:33

drgrice1 force-pushed the update-course-dirs-improved branch from 80d9713 to 7450d47 Compare September 11, 2023 21:53

drdrew42 mentioned this pull request Sep 18, 2023

Send Email Notification for Achievements #2214

Merged

drgrice1 force-pushed the update-course-dirs-improved branch from 7450d47 to 1ca9b93 Compare September 19, 2023 18:39

drgrice1 force-pushed the update-course-dirs-improved branch 4 times, most recently from 3cc6791 to 9503417 Compare October 11, 2023 21:05

Alex-Jordan reviewed Oct 22, 2023

View reviewed changes

drgrice1 force-pushed the update-course-dirs-improved branch 3 times, most recently from 1f5a535 to cdf8114 Compare October 22, 2023 20:47

Alex-Jordan reviewed Oct 23, 2023

View reviewed changes

Use courseDirs from the course environment sorted by path.

4d78d25

As suggested by @Alex-Jordan, sort by paths using keys from the courseDirs hash in the course enviroment.

drgrice1 force-pushed the update-course-dirs-improved branch from cdf8114 to 4d78d25 Compare October 23, 2023 19:34

Alex-Jordan merged commit 519a837 into openwebwork:develop Oct 23, 2023

drgrice1 deleted the update-course-dirs-improved branch October 23, 2023 21:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvements to the course directory update method. #2173

Improvements to the course directory update method. #2173

drgrice1 commented Aug 11, 2023

pstaabp left a comment •

edited

Loading

Alex-Jordan commented Aug 17, 2023

drgrice1 commented Aug 17, 2023

Alex-Jordan Oct 22, 2023

Alex-Jordan Oct 22, 2023

drgrice1 Oct 22, 2023 •

edited

Loading

Alex-Jordan Oct 22, 2023

Alex-Jordan Oct 23, 2023

drgrice1 Oct 23, 2023

drgrice1 Oct 23, 2023

somiaj Oct 23, 2023

drgrice1 Oct 23, 2023

Improvements to the course directory update method. #2173

Improvements to the course directory update method. #2173

Conversation

drgrice1 commented Aug 11, 2023

pstaabp left a comment • edited Loading

Choose a reason for hiding this comment

Alex-Jordan commented Aug 17, 2023

drgrice1 commented Aug 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

drgrice1 Oct 22, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pstaabp left a comment •

edited

Loading

drgrice1 Oct 22, 2023 •

edited

Loading