Joren/CanvasArchiver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

feat/videos-only-mode #5

Merged
Joren merged 6 commits from feat/videos-only-mode into main 2026-05-16 22:55:49 +02:00
Conversation 0 Commits 6 Files Changed 4 +105 -26
4 changed files with 105 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -21,11 +21,16 @@ go build -o canvasarchiver ./cmd/canvasarchiver
./canvasarchiver
```
Or for files-only mode:
Or for files-only mode (all files flat, no videos):
```bash
./canvasarchiver -fo
```
Or for videos-only mode (all Panopto videos flat, no files):
```bash
./canvasarchiver -vo
```
2. On first run, you'll be prompted to authenticate:
- Visit the provided OAuth URL
- Authorize the application
@@ -38,11 +43,14 @@ go build -o canvasarchiver ./cmd/canvasarchiver
- Module content (to `Modules/`)
- Panopto recordings (to `Recordings/`)
In `-vo` mode, only videos are downloaded — all into the course root directory (no subdirectories).
### Flags
| Flag | Description |
|------|-------------|
| `-fo` | Files only mode - download all files to a single directory without module structure |
| `-fo` | Files only — download all files flat into one directory; skips videos and module structure |
| `-vo` | Videos only — scan recordings and all module video items, download everything flat into one directory; skips regular files |
| `-me` | Download all enrolled courses |
| `-n` | Prefix modules with order numbers `[1]`, `[2]`, etc. |

16
cmd/canvasarchiver/main.go
View File

@@ -14,6 +14,7 @@ import (
func main() {
filesOnly := flag.Bool("fo", false, "Files only mode - download all files to a single directory without module structure")
videosOnly := flag.Bool("vo", false, "Videos only mode - download only Panopto videos to a single directory")
me := flag.Bool("me", false, "Download all enrolled courses")
moduleNumbers := flag.Bool("n", false, "Prefix modules with order numbers [1], [2], etc.")
flag.Parse()
@@ -28,7 +29,7 @@ func main() {
}
if *me {
canvasClient := canvas.NewClient(httpClient, accessToken, "", *filesOnly, *moduleNumbers)
canvasClient := canvas.NewClient(httpClient, accessToken, "", *filesOnly, *videosOnly, *moduleNumbers)
courses, err := canvasClient.GetEnrolledCourses()
if err != nil {
fmt.Printf("Error fetching courses: %v\n", err)
@@ -38,7 +39,7 @@ func main() {
fmt.Printf("[+] Found %d enrolled courses\n", len(courses))
for _, course := range courses {
fmt.Printf(" -> Downloading: %s (ID: %d)\n", course.Name, course.ID)
downloadCourse(httpClient, accessToken, fmt.Sprintf("%d", course.ID), *filesOnly, *moduleNumbers)
downloadCourse(httpClient, accessToken, fmt.Sprintf("%d", course.ID), *filesOnly, *videosOnly, *moduleNumbers)
}
return
}
@@ -47,11 +48,11 @@ func main() {
fmt.Print("Enter Course ID: ")
fmt.Scanln(&courseID)
downloadCourse(httpClient, accessToken, courseID, *filesOnly, *moduleNumbers)
downloadCourse(httpClient, accessToken, courseID, *filesOnly, *videosOnly, *moduleNumbers)
}
func downloadCourse(httpClient *http.Client, accessToken, courseID string, filesOnly, moduleNumbers bool) {
canvasClient := canvas.NewClient(httpClient, accessToken, courseID, filesOnly, moduleNumbers)
func downloadCourse(httpClient *http.Client, accessToken, courseID string, filesOnly, videosOnly, moduleNumbers bool) {
canvasClient := canvas.NewClient(httpClient, accessToken, courseID, filesOnly, videosOnly, moduleNumbers)
if err := canvasClient.GetCourseInfo(); err != nil {
fmt.Printf("Error: %v\n", err)
@@ -66,7 +67,8 @@ func downloadCourse(httpClient *http.Client, accessToken, courseID string, files
canvasClient.DownloadModules(courseRoot)
if !filesOnly {
panopto.DownloadMainRecordings(httpClient, accessToken, courseID, courseRoot)
// Run recordings: always in -vo mode; skipped in -fo mode; normal otherwise.
if videosOnly || !filesOnly {
panopto.DownloadMainRecordings(httpClient, accessToken, courseID, courseRoot, videosOnly)
}
}

25
internal/canvas/client.go
View File

@@ -22,16 +22,18 @@ type Client struct {
CourseID string
CourseName string
FilesOnly bool
VideosOnly bool
ModuleNumbers bool
downloadedFiles map[string]bool
}
func NewClient(httpClient *http.Client, accessToken, courseID string, filesOnly, moduleNumbers bool) *Client {
func NewClient(httpClient *http.Client, accessToken, courseID string, filesOnly, videosOnly, moduleNumbers bool) *Client {
return &Client{
HTTPClient: httpClient,
AccessToken: accessToken,
CourseID: courseID,
FilesOnly: filesOnly,
VideosOnly: videosOnly,
ModuleNumbers: moduleNumbers,
downloadedFiles: make(map[string]bool),
}
@@ -68,6 +70,10 @@ func (c *Client) GetEnrolledCourses() ([]models.Course, error) {
}
func (c *Client) DownloadCourseFiles(root string) {
if c.VideosOnly {
fmt.Println("\n[*] Skipping regular course files (videos only mode)")
return
}
fmt.Println("\n[*] Fetching regular course files...")
fReq, _ := http.NewRequest("GET", fmt.Sprintf("%s/api/v1/courses/%s/folders?per_page=100", config.BaseURL, c.CourseID), nil)
@@ -164,14 +170,19 @@ func (c *Client) DownloadModules(courseRoot string) {
modName = fmt.Sprintf("[%d] %s", i+1, mod.Name)
}
// In videos-only mode everything goes flat into courseRoot.
// In files-only mode everything goes flat into courseRoot.
// Otherwise use the structured Modules/<name> path.
modBaseDir := courseRoot
if !c.FilesOnly {
if !c.FilesOnly && !c.VideosOnly {
modBaseDir = filepath.Join(courseRoot, "Modules", utils.Sanitize(modName))
}
os.MkdirAll(modBaseDir, 0o755)
if !c.FilesOnly {
if !c.FilesOnly && !c.VideosOnly {
fmt.Printf("\n[Module] %s\n", modName)
} else if c.VideosOnly {
fmt.Printf("\n[Module] %s (scanning for videos)\n", modName)
}
subHeaderStack := []string{}
@@ -179,15 +190,16 @@ func (c *Client) DownloadModules(courseRoot string) {
for _, item := range mod.Items {
// In videos-only mode always download to the flat courseRoot.
targetDir := modBaseDir
if len(subHeaderStack) > 0 && !c.FilesOnly {
if len(subHeaderStack) > 0 && !c.FilesOnly && !c.VideosOnly {
targetDir = filepath.Join(modBaseDir, filepath.Join(subHeaderStack...))
}
os.MkdirAll(targetDir, 0o755)
switch item.Type {
case "SubHeader":
if c.FilesOnly {
if c.FilesOnly || c.VideosOnly {
continue
}
currentIndent := item.Indent
@@ -207,6 +219,9 @@ func (c *Client) DownloadModules(courseRoot string) {
fmt.Printf("%s--- %s ---\n", indent, item.Title)
case "File":
if c.VideosOnly {
continue
}
c.downloadModuleFile(item, targetDir)
case "ExternalTool":

70
internal/panopto/downloader.go
View File

@@ -17,6 +17,27 @@ import (
"git.directme.in/Joren/CanvasArchiver/internal/utils"
)
// normalizePanoptoURL converts the query-param form that Canvas stores
// (List.aspx?folderID=X) to the fragment form that yt-dlp's PanoptoList
// extractor understands (List.aspx#folderID="X"). Without this yt-dlp
// ignores the folder filter and downloads the entire Panopto instance.
func normalizePanoptoURL(rawURL string) string {
parsed, err := url.Parse(rawURL)
if err != nil {
return rawURL
}
if strings.Contains(parsed.Path, "List.aspx") {
folderID := parsed.Query().Get("folderID")
if folderID != "" {
// Strip query, set fragment: List.aspx#folderID="<id>"
parsed.RawQuery = ""
parsed.Fragment = fmt.Sprintf(`folderID="%s"`, folderID)
return parsed.String()
}
}
return rawURL
}
func getYoutubeDLCommand() string {
exePath, err := os.Executable()
if err == nil {
@@ -192,13 +213,35 @@ func DownloadVideo(httpClient *http.Client, accessToken, courseID, modDir, input
fmt.Printf(" [*] Downloading video: %s\n", title)
ytCmd := getYoutubeDLCommand()
cmd := exec.Command(ytCmd,
// Normalize folder URLs so yt-dlp scopes to the right folder.
normalizedURL := normalizePanoptoURL(targetURL)
// Folder/list URLs are intentional playlists; don't pass --no-playlist.
isList := strings.Contains(normalizedURL, "List.aspx")
var outputTpl string
var args []string
if isList {
outputTpl = utils.Sanitize(title) + "/%(title)s.%(ext)s"
args = []string{
"--cookies", cookieFile,
"--referer", config.BaseURL + "/",
"-P", modDir,
"-o", outputTpl,
normalizedURL,
}
} else {
outputTpl = utils.Sanitize(title) + ".%(ext)s"
args = []string{
"--no-playlist",
"--cookies", cookieFile,
"--referer", config.BaseURL + "/",
"-P", modDir,
"-o", utils.Sanitize(title)+".%(ext)s",
targetURL)
"-o", outputTpl,
normalizedURL,
}
}
cmd := exec.Command(ytCmd, args...)
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
@@ -212,7 +255,7 @@ func DownloadVideo(httpClient *http.Client, accessToken, courseID, modDir, input
}
}
func DownloadMainRecordings(httpClient *http.Client, accessToken, courseID, root string) {
func DownloadMainRecordings(httpClient *http.Client, accessToken, courseID, root string, videosOnly bool) {
fmt.Println("\n[*] Checking for main Panopto recordings...")
jar, _ := cookiejar.New(nil)
@@ -300,8 +343,18 @@ func DownloadMainRecordings(httpClient *http.Client, accessToken, courseID, root
}
os.WriteFile(cookieFile, []byte(cData), 0o644)
recordingsDir := filepath.Join(root, "Recordings")
os.MkdirAll(recordingsDir, 0o755)
var downloadDir string
var outputTemplate string
if videosOnly {
// Flat: all videos go directly into course root
downloadDir = root
outputTemplate = "%(title)s.%(ext)s"
} else {
downloadDir = filepath.Join(root, "Recordings")
os.MkdirAll(downloadDir, 0o755)
outputTemplate = "%(playlist_title)s/%(title)s.%(ext)s"
}
fmt.Println("[*] Starting yt-dlp download for main recordings...")
@@ -310,8 +363,8 @@ func DownloadMainRecordings(httpClient *http.Client, accessToken, courseID, root
cmd := exec.Command(ytCmd,
"--cookies", cookieFile,
"--referer", config.BaseURL+"/",
"-P", recordingsDir,
"-o", "%(playlist_title)s/%(title)s.%(ext)s",
"-P", downloadDir,
"-o", outputTemplate,
decodedURL,
)
cmd.Stdout = os.Stdout
@@ -323,3 +376,4 @@ func DownloadMainRecordings(httpClient *http.Client, accessToken, courseID, root
fmt.Println("[!] No main recordings available or handshake failed")
}
}