Compare commits
7 Commits
25729ce492
...
feat/all-c
| Author | SHA1 | Date | |
|---|---|---|---|
|
c74cbe5065
|
|||
| 4978d84196 | |||
|
07fade16d3
|
|||
|
666369714b
|
|||
| 122d00c8f9 | |||
|
ef10711b6e
|
|||
| 04e7d3e0f4 |
20
README.md
20
README.md
@@ -26,15 +26,16 @@ go build -o canvasarchiver ./cmd/canvasarchiver
|
||||
./canvasarchiver -fo
|
||||
```
|
||||
|
||||
Or for videos-only mode (all Panopto videos flat, no files):
|
||||
```bash
|
||||
./canvasarchiver -vo
|
||||
```
|
||||
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
|
||||
- Copy the authorization code back to the terminal
|
||||
2. On first run, you'll be prompted to choose an authentication method:
|
||||
- **[1] Login via browser (OAuth)**: Visit the provided URL, authorize, and paste the code
|
||||
- **[2] Use Canvas API token**: Enter a manually generated API token (e.g. `12230~...`)
|
||||
|
||||
The choice is saved and reused on subsequent runs.
|
||||
|
||||
3. Enter your Course ID when prompted (or use `-me` to download all enrolled courses)
|
||||
|
||||
@@ -54,7 +55,6 @@ go build -o canvasarchiver ./cmd/canvasarchiver
|
||||
| `-me` | Download all enrolled courses |
|
||||
| `-n` | Prefix modules with order numbers `[1]`, `[2]`, etc. |
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
The following constants can be modified in `internal/config/config.go`:
|
||||
@@ -66,7 +66,7 @@ The following constants can be modified in `internal/config/config.go`:
|
||||
|
||||
## Authentication
|
||||
|
||||
Credentials are stored in `credentials.json` after the first successful login. The refresh token is automatically used for subsequent runs.
|
||||
Credentials are stored in `credentials.json` after the first successful authentication. The chosen method is remembered for subsequent runs — OAuth refresh tokens are automatically refreshed, and API tokens are validated before saving.
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -16,20 +16,21 @@ 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")
|
||||
all := flag.Bool("a", false, "Include concluded (old) courses when used with -me")
|
||||
moduleNumbers := flag.Bool("n", false, "Prefix modules with order numbers [1], [2], etc.")
|
||||
flag.Parse()
|
||||
|
||||
httpClient := &http.Client{}
|
||||
|
||||
authenticator := auth.NewAuthenticator(httpClient)
|
||||
accessToken, err := authenticator.GetAccessToken()
|
||||
accessToken, err := authenticator.GetToken()
|
||||
if err != nil {
|
||||
fmt.Printf("Authentication failed: %v\n", err)
|
||||
return
|
||||
}
|
||||
|
||||
if *me {
|
||||
canvasClient := canvas.NewClient(httpClient, accessToken, "", *filesOnly, *videosOnly, *moduleNumbers)
|
||||
canvasClient := canvas.NewClient(httpClient, accessToken, "", *filesOnly, *videosOnly, *moduleNumbers, *all)
|
||||
courses, err := canvasClient.GetEnrolledCourses()
|
||||
if err != nil {
|
||||
fmt.Printf("Error fetching courses: %v\n", err)
|
||||
@@ -39,7 +40,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, *videosOnly, *moduleNumbers)
|
||||
downloadCourse(httpClient, accessToken, fmt.Sprintf("%d", course.ID), *filesOnly, *videosOnly, *moduleNumbers, *all)
|
||||
}
|
||||
return
|
||||
}
|
||||
@@ -48,11 +49,11 @@ func main() {
|
||||
fmt.Print("Enter Course ID: ")
|
||||
fmt.Scanln(&courseID)
|
||||
|
||||
downloadCourse(httpClient, accessToken, courseID, *filesOnly, *videosOnly, *moduleNumbers)
|
||||
downloadCourse(httpClient, accessToken, courseID, *filesOnly, *videosOnly, *moduleNumbers, *all)
|
||||
}
|
||||
|
||||
func downloadCourse(httpClient *http.Client, accessToken, courseID string, filesOnly, videosOnly, moduleNumbers bool) {
|
||||
canvasClient := canvas.NewClient(httpClient, accessToken, courseID, filesOnly, videosOnly, moduleNumbers)
|
||||
func downloadCourse(httpClient *http.Client, accessToken, courseID string, filesOnly, videosOnly, moduleNumbers, all bool) {
|
||||
canvasClient := canvas.NewClient(httpClient, accessToken, courseID, filesOnly, videosOnly, moduleNumbers, all)
|
||||
|
||||
if err := canvasClient.GetCourseInfo(); err != nil {
|
||||
fmt.Printf("Error: %v\n", err)
|
||||
|
||||
@@ -27,11 +27,39 @@ func NewAuthenticator(client *http.Client) *Authenticator {
|
||||
}
|
||||
}
|
||||
|
||||
func (a *Authenticator) GetAccessToken() (string, error) {
|
||||
func (a *Authenticator) GetToken() (string, error) {
|
||||
creds, err := LoadCredentials()
|
||||
if err == nil && creds.AuthMethod != "" {
|
||||
switch creds.AuthMethod {
|
||||
case "api":
|
||||
token := strings.TrimSpace(creds.APIToken)
|
||||
if token == "" {
|
||||
return a.promptMethod()
|
||||
}
|
||||
fmt.Print("[*] Validating saved API token... ")
|
||||
if err := a.validateAPIToken(token); err != nil {
|
||||
fmt.Println("FAILED")
|
||||
fmt.Printf("[!] %v\n", err)
|
||||
SaveCredentials(&models.Credentials{})
|
||||
return a.promptMethod()
|
||||
}
|
||||
fmt.Println("OK")
|
||||
return token, nil
|
||||
case "oauth":
|
||||
return a.refreshOrLogin()
|
||||
}
|
||||
}
|
||||
return a.promptMethod()
|
||||
}
|
||||
|
||||
func (a *Authenticator) refreshOrLogin() (string, error) {
|
||||
creds, err := LoadCredentials()
|
||||
if err != nil {
|
||||
return a.login()
|
||||
}
|
||||
if strings.TrimSpace(creds.RefreshToken) == "" {
|
||||
return a.login()
|
||||
}
|
||||
|
||||
fmt.Println("[*] Reusing saved refresh token...")
|
||||
tr, err := a.doTokenRequest(url.Values{
|
||||
@@ -49,6 +77,66 @@ func (a *Authenticator) GetAccessToken() (string, error) {
|
||||
return tr.AccessToken, nil
|
||||
}
|
||||
|
||||
func (a *Authenticator) promptMethod() (string, error) {
|
||||
fmt.Println("Select authentication method:")
|
||||
fmt.Println(" [1] Login via browser (OAuth)")
|
||||
fmt.Println(" [2] Use Canvas API token")
|
||||
fmt.Print("Choice (1/2): ")
|
||||
input, err := bufio.NewReader(os.Stdin).ReadString('\n')
|
||||
if err != nil && err != io.EOF {
|
||||
return "", err
|
||||
}
|
||||
switch strings.TrimSpace(input) {
|
||||
case "2":
|
||||
return a.setupAPIToken()
|
||||
default:
|
||||
return a.login()
|
||||
}
|
||||
}
|
||||
|
||||
func (a *Authenticator) setupAPIToken() (string, error) {
|
||||
fmt.Print("Enter Canvas API token: ")
|
||||
token, err := bufio.NewReader(os.Stdin).ReadString('\n')
|
||||
if err != nil && err != io.EOF {
|
||||
return "", err
|
||||
}
|
||||
token = strings.TrimSpace(token)
|
||||
if token == "" {
|
||||
return "", fmt.Errorf("empty API token")
|
||||
}
|
||||
|
||||
fmt.Print("[*] Validating API token... ")
|
||||
if err := a.validateAPIToken(token); err != nil {
|
||||
fmt.Println("FAILED")
|
||||
return "", err
|
||||
}
|
||||
fmt.Println("OK")
|
||||
|
||||
if err := SaveCredentials(&models.Credentials{
|
||||
AuthMethod: "api",
|
||||
APIToken: token,
|
||||
}); err != nil {
|
||||
return "", err
|
||||
}
|
||||
fmt.Println("[+] API token saved.")
|
||||
return token, nil
|
||||
}
|
||||
|
||||
func (a *Authenticator) validateAPIToken(token string) error {
|
||||
req, _ := http.NewRequest("GET", config.BaseURL+"/api/v1/users/self", nil)
|
||||
req.Header.Set("Authorization", "Bearer "+token)
|
||||
resp, err := a.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if resp.StatusCode != 200 {
|
||||
body, _ := io.ReadAll(resp.Body)
|
||||
return fmt.Errorf("invalid token: %d %s", resp.StatusCode, strings.TrimSpace(string(body)))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (a *Authenticator) login() (string, error) {
|
||||
codeVerifier, codeChallenge, err := generatePKCEPair()
|
||||
if err != nil {
|
||||
@@ -80,7 +168,9 @@ func (a *Authenticator) login() (string, error) {
|
||||
return "", err
|
||||
}
|
||||
|
||||
SaveCredentials(&models.Credentials{RefreshToken: tr.RefreshToken})
|
||||
if err := SaveRefreshToken(tr.RefreshToken); err != nil {
|
||||
return "", err
|
||||
}
|
||||
fmt.Println("[+] Login successful.")
|
||||
return tr.AccessToken, nil
|
||||
}
|
||||
@@ -162,9 +252,22 @@ func extractCode(input string) (string, error) {
|
||||
return input, nil
|
||||
}
|
||||
|
||||
func SaveCredentials(creds *models.Credentials) {
|
||||
data, _ := json.MarshalIndent(creds, "", " ")
|
||||
os.WriteFile(config.CredsFile, data, 0o644)
|
||||
func SaveCredentials(creds *models.Credentials) error {
|
||||
data, err := json.MarshalIndent(creds, "", " ")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return os.WriteFile(config.CredsFile, data, 0o644)
|
||||
}
|
||||
|
||||
func SaveRefreshToken(refreshToken string) error {
|
||||
creds, err := LoadCredentials()
|
||||
if err != nil {
|
||||
creds = &models.Credentials{}
|
||||
}
|
||||
creds.RefreshToken = refreshToken
|
||||
creds.AuthMethod = "oauth"
|
||||
return SaveCredentials(creds)
|
||||
}
|
||||
|
||||
func LoadCredentials() (*models.Credentials, error) {
|
||||
@@ -173,6 +276,8 @@ func LoadCredentials() (*models.Credentials, error) {
|
||||
return nil, err
|
||||
}
|
||||
var creds models.Credentials
|
||||
json.Unmarshal(data, &creds)
|
||||
if err := json.Unmarshal(data, &creds); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &creds, nil
|
||||
}
|
||||
|
||||
@@ -16,6 +16,13 @@ import (
|
||||
"git.directme.in/Joren/CanvasArchiver/internal/utils"
|
||||
)
|
||||
|
||||
func checkAPIResponse(resp *http.Response) error {
|
||||
if resp.StatusCode < 300 {
|
||||
return nil
|
||||
}
|
||||
return fmt.Errorf("API error: %d", resp.StatusCode)
|
||||
}
|
||||
|
||||
type Client struct {
|
||||
HTTPClient *http.Client
|
||||
AccessToken string
|
||||
@@ -24,10 +31,11 @@ type Client struct {
|
||||
FilesOnly bool
|
||||
VideosOnly bool
|
||||
ModuleNumbers bool
|
||||
All bool
|
||||
downloadedFiles map[string]bool
|
||||
}
|
||||
|
||||
func NewClient(httpClient *http.Client, accessToken, courseID string, filesOnly, videosOnly, moduleNumbers bool) *Client {
|
||||
func NewClient(httpClient *http.Client, accessToken, courseID string, filesOnly, videosOnly, moduleNumbers, all bool) *Client {
|
||||
return &Client{
|
||||
HTTPClient: httpClient,
|
||||
AccessToken: accessToken,
|
||||
@@ -35,6 +43,7 @@ func NewClient(httpClient *http.Client, accessToken, courseID string, filesOnly,
|
||||
FilesOnly: filesOnly,
|
||||
VideosOnly: videosOnly,
|
||||
ModuleNumbers: moduleNumbers,
|
||||
All: all,
|
||||
downloadedFiles: make(map[string]bool),
|
||||
}
|
||||
}
|
||||
@@ -48,6 +57,10 @@ func (c *Client) GetCourseInfo() error {
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if err := checkAPIResponse(resp); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var course models.Course
|
||||
json.NewDecoder(resp.Body).Decode(&course)
|
||||
|
||||
@@ -55,6 +68,11 @@ func (c *Client) GetCourseInfo() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
type enrollmentResponse struct {
|
||||
CourseID int `json:"course_id"`
|
||||
EnrollmentState string `json:"enrollment_state"`
|
||||
}
|
||||
|
||||
func (c *Client) GetEnrolledCourses() ([]models.Course, error) {
|
||||
req, _ := http.NewRequest("GET", fmt.Sprintf("%s/api/v1/courses?enrollment_state=active&per_page=100", config.BaseURL), nil)
|
||||
req.Header.Set("Authorization", "Bearer "+c.AccessToken)
|
||||
@@ -64,8 +82,56 @@ func (c *Client) GetEnrolledCourses() ([]models.Course, error) {
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if err := checkAPIResponse(resp); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var courses []models.Course
|
||||
json.NewDecoder(resp.Body).Decode(&courses)
|
||||
|
||||
if c.All {
|
||||
completed, err := c.getCompletedCourses()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
courses = append(courses, completed...)
|
||||
}
|
||||
|
||||
return courses, nil
|
||||
}
|
||||
|
||||
func (c *Client) getCompletedCourses() ([]models.Course, error) {
|
||||
req, _ := http.NewRequest("GET", fmt.Sprintf("%s/api/v1/users/self/enrollments?state[]=completed&per_page=100", config.BaseURL), nil)
|
||||
req.Header.Set("Authorization", "Bearer "+c.AccessToken)
|
||||
resp, err := c.HTTPClient.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if err := checkAPIResponse(resp); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var enrollments []enrollmentResponse
|
||||
json.NewDecoder(resp.Body).Decode(&enrollments)
|
||||
|
||||
var courses []models.Course
|
||||
for _, e := range enrollments {
|
||||
courseReq, _ := http.NewRequest("GET", fmt.Sprintf("%s/api/v1/courses/%d", config.BaseURL, e.CourseID), nil)
|
||||
courseReq.Header.Set("Authorization", "Bearer "+c.AccessToken)
|
||||
courseResp, err := c.HTTPClient.Do(courseReq)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
var course models.Course
|
||||
json.NewDecoder(courseResp.Body).Decode(&course)
|
||||
courseResp.Body.Close()
|
||||
if course.ID != 0 {
|
||||
courses = append(courses, course)
|
||||
}
|
||||
}
|
||||
|
||||
return courses, nil
|
||||
}
|
||||
|
||||
|
||||
@@ -1,7 +1,9 @@
|
||||
package models
|
||||
|
||||
type Credentials struct {
|
||||
RefreshToken string `json:"refresh_token"`
|
||||
AuthMethod string `json:"auth_method,omitempty"`
|
||||
RefreshToken string `json:"refresh_token,omitempty"`
|
||||
APIToken string `json:"api_token,omitempty"`
|
||||
}
|
||||
|
||||
type TokenResponse struct {
|
||||
|
||||
Reference in New Issue
Block a user