canvaslms 5.1__py3-none-any.whl → 5.3__py3-none-any.whl

canvaslms/cli/modules.nw

@@ -501,16 +501,27 @@ def get_item_modules(course, item_type, item_id):
 
 The matching logic differs by item type.
 For assignments, Canvas stores the assignment ID in [[content_id]].
-For pages, Canvas stores the URL slug in [[page_url]].
+For pages, Canvas stores the URL slug in [[page_url]]. However, Canvas may
+redirect old URLs to new ones, so we need to resolve the URL before comparing
+(see [[<<check if page item matches by resolving url>>]]).
 <<check if item matches and add module to list>>=
 if item_type == 'Assignment':
   if hasattr(item, 'content_id') and item.content_id == item_id:
     modules.append(module.name)
     break
 elif item_type == 'Page':
-  if hasattr(item, 'page_url') and item.page_url == item_id:
-    modules.append(module.name)
-    break
+  if hasattr(item, 'page_url'):
+    if item.page_url == item_id:
+      modules.append(module.name)
+      break
+    # Check if URLs resolve to same page (handles redirects)
+    try:
+      resolved_page = course.get_page(item.page_url)
+      if resolved_page.url == item_id:
+        modules.append(module.name)
+        break
+    except Exception:
+      pass
 @
 
 \subsection{Updating module membership based on patterns}
@@ -575,6 +586,21 @@ for module in all_modules:
 @
 
 We search the module's items to find if our item is currently present.
+
+For pages, we need to handle URL redirects. Canvas may store an old URL in the
+module item that redirects to the canonical URL we're checking against. For
+example, a page might have been added to a module with URL
+\enquote{page-on-campus+zoom}, but Canvas later changed the canonical URL to
+\enquote{page-on-zoom+campus}. The module item still stores the old URL, but
+when we fetch the page using [[course.get_page()]], Canvas returns the page
+with its new canonical URL.
+
+Without handling this, the direct comparison [[item.page_url == item_id]] would
+fail, causing the page to be added to the module again (creating duplicates).
+
+To detect this, we fetch the page using the module item's [[page_url]] and
+compare its canonical [[url]] attribute with [[item_id]]. This adds an API call
+per page item, but only when the direct comparison fails.
 <<find current module item if present>>=
 current_item = None
 try:
@@ -586,13 +612,29 @@ try:
         current_item = item
         break
     elif item_type == 'Page':
-      if hasattr(item, 'page_url') and item.page_url == item_id:
-        current_item = item
-        break
+      if hasattr(item, 'page_url'):
+        <<check if page item matches by resolving url>>
 except Exception:
   pass
 @
 
+When comparing page URLs, we first try a direct match. If that fails, we fetch
+the page to get its canonical URL and compare that. This handles the case where
+Canvas has created a redirect from an old URL to a new one.
+<<check if page item matches by resolving url>>=
+if item.page_url == item_id:
+  current_item = item
+  break
+# URLs don't match directly; check if they resolve to same page
+try:
+  resolved_page = course.get_page(item.page_url)
+  if resolved_page.url == item_id:
+    current_item = item
+    break
+except Exception:
+  pass  # Page doesn't exist or can't be fetched
+@
+
 Finally, we add or remove based on comparing current vs desired state.
 When adding, we use [[create_module_item]] with the appropriate type and ID.
 When removing, we call [[delete()]] on the module item object.

canvaslms/cli/modules.py

@@ -209,9 +209,18 @@ def get_item_modules(course, item_type, item_id):
                         modules.append(module.name)
                         break
                 elif item_type == "Page":
-                    if hasattr(item, "page_url") and item.page_url == item_id:
-                        modules.append(module.name)
-                        break
+                    if hasattr(item, "page_url"):
+                        if item.page_url == item_id:
+                            modules.append(module.name)
+                            break
+                        # Check if URLs resolve to same page (handles redirects)
+                        try:
+                            resolved_page = course.get_page(item.page_url)
+                            if resolved_page.url == item_id:
+                                modules.append(module.name)
+                                break
+                        except Exception:
+                            pass
         except Exception:
             # Skip modules we can't access
             pass
@@ -254,9 +263,18 @@ def update_item_modules(course, item_type, item_id, module_regexes):
                         current_item = item
                         break
                 elif item_type == "Page":
-                    if hasattr(item, "page_url") and item.page_url == item_id:
-                        current_item = item
-                        break
+                    if hasattr(item, "page_url"):
+                        if item.page_url == item_id:
+                            current_item = item
+                            break
+                        # URLs don't match directly; check if they resolve to same page
+                        try:
+                            resolved_page = course.get_page(item.page_url)
+                            if resolved_page.url == item_id:
+                                current_item = item
+                                break
+                        except Exception:
+                            pass  # Page doesn't exist or can't be fetched
         except Exception:
             pass
         should_be_in = module.id in matching_module_ids

canvaslms/cli/pages.nw

@@ -403,8 +403,9 @@ specific page to update. This enables a Git-based workflow where the page can
 be reliably identified even if the title changes. If the URL is not found and
 [[--create]] is specified, we create a new page instead.
 
-If no [[url]] is in the YAML, we fall back to the filter-based matching using
-[[-p]] and [[-M]] options (the existing behavior).
+If no [[url]] is in the YAML, we try title-based matching first (using the
+[[title]] field from the front matter), then fall back to filter-based matching
+using [[-p]] and [[-M]] options only if no title is specified.
 <<update pages with new content>>=
 if args.html:
   html_content = body_content  # Already HTML, no conversion needed
@@ -515,18 +516,70 @@ if 'modules' in attributes:
     print(f"  Added to modules: {', '.join(added)}", file=sys.stderr)
 @
 
-\subsubsection{Filter-based page matching}
+\subsubsection{Title-based page identification}
 
-When no URL is specified in the YAML, we use the filter options ([[-p]], [[-M]])
-to find matching pages. This maintains backwards compatibility with the original
-behavior.
-<<update pages by filter matching>>=
-pages = process_page_option(canvas, args)
+When no [[url]] is specified in the YAML but a [[title]] is present, we use the
+title to find the page. This is the most common case when creating or updating
+pages from Markdown files: the user specifies a title in the front matter and
+expects the command to find or create a page with that title.
 
-for page in pages:
-  full_page = page.course.get_page(page.url)
-  full_page.course = page.course
+This behavior is critical for safety. Without it, the command would fall back to
+filter-based matching with the default [[-p '.*']] pattern, which matches
+\emph{all} pages in the course. The result would be catastrophic: every page
+would be overwritten with the content from the file.
+
+We use exact title matching (not regex) to avoid accidentally updating multiple
+pages. If exactly one page matches, we update it. If no pages match and
+[[--create]] is specified, we create a new page. If multiple pages match, we
+report an error---the user should add a [[url]] field to disambiguate.
+<<update or create page by title>>=
+title = attributes['title']
+course_list = canvaslms.cli.courses.process_course_option(canvas, args)
+if not course_list:
+  print("Error: No courses found matching criteria", file=sys.stderr)
+  return
+
+course = course_list[0]
+
+matching_pages = [p for p in course.get_pages() if p.title == title]
+
+if len(matching_pages) == 1:
+  full_page = course.get_page(matching_pages[0].url)
+  full_page.course = course
   <<update existing page>>
+elif len(matching_pages) == 0:
+  if args.create:
+    <<create new page>>
+  else:
+    print(f"Error: Page '{title}' not found. "
+          f"Use --create to create a new page.", file=sys.stderr)
+    return
+else:
+  print(f"Error: Multiple pages with title '{title}' found. "
+        f"Add 'url' field to YAML to identify specific page.", file=sys.stderr)
+  return
+@
+
+\subsubsection{Filter-based page matching}
+
+When neither [[url]] nor [[title]] is specified in the YAML, we fall back to the
+filter options ([[-p]], [[-M]]) to find matching pages. This is a rare case but
+maintains backwards compatibility. We add a safety check: if multiple pages
+match, we report an error rather than updating all of them.
+<<update pages by filter matching>>=
+if 'title' in attributes and attributes['title']:
+  <<update or create page by title>>
+else:
+  pages = process_page_option(canvas, args)
+  if len(pages) > 1:
+    print(f"Error: {len(pages)} pages match filter. "
+          f"Add 'title' or 'url' to YAML, or use -p to narrow selection.",
+          file=sys.stderr)
+    return
+  for page in pages:
+    full_page = page.course.get_page(page.url)
+    full_page.course = page.course
+    <<update existing page>>
 @
 
 We add optional attributes only if they are present in the YAML front matter.

canvaslms/cli/pages.py

@@ -296,53 +296,177 @@ def pages_edit_command(config, canvas, args):
                     )
                     return
         else:
-            pages = process_page_option(canvas, args)
+            if "title" in attributes and attributes["title"]:
+                title = attributes["title"]
+                course_list = canvaslms.cli.courses.process_course_option(canvas, args)
+                if not course_list:
+                    print("Error: No courses found matching criteria", file=sys.stderr)
+                    return
 
-            for page in pages:
-                full_page = page.course.get_page(page.url)
-                full_page.course = page.course
-                update_data = {
-                    "wiki_page": {
-                        "title": attributes.get("title", full_page.title),
-                        "body": html_content,
+                course = course_list[0]
+
+                matching_pages = [p for p in course.get_pages() if p.title == title]
+
+                if len(matching_pages) == 1:
+                    full_page = course.get_page(matching_pages[0].url)
+                    full_page.course = course
+                    update_data = {
+                        "wiki_page": {
+                            "title": attributes.get("title", full_page.title),
+                            "body": html_content,
+                        }
                     }
-                }
 
-                if "published" in attributes:
-                    update_data["wiki_page"]["published"] = attributes["published"]
-                if "front_page" in attributes:
-                    update_data["wiki_page"]["front_page"] = attributes["front_page"]
-                if "editing_roles" in attributes and attributes["editing_roles"]:
-                    update_data["wiki_page"]["editing_roles"] = attributes[
-                        "editing_roles"
-                    ]
+                    if "published" in attributes:
+                        update_data["wiki_page"]["published"] = attributes["published"]
+                    if "front_page" in attributes:
+                        update_data["wiki_page"]["front_page"] = attributes[
+                            "front_page"
+                        ]
+                    if "editing_roles" in attributes and attributes["editing_roles"]:
+                        update_data["wiki_page"]["editing_roles"] = attributes[
+                            "editing_roles"
+                        ]
 
-                try:
-                    full_page.edit(**update_data)
-                    full_page._fetched_at = datetime.now()
-                    if hasattr(full_page.course, "page_cache"):
-                        full_page.course.page_cache[full_page.url] = (full_page, {})
-                    logger.info(f"Updated page: {full_page.title}")
-                    if "modules" in attributes:
-                        module_regexes = attributes["modules"]
-                        added, removed = canvaslms.cli.modules.update_item_modules(
-                            full_page.course, "Page", full_page.url, module_regexes
-                        )
-                        if added:
-                            print(
-                                f"  Added to modules: {', '.join(added)}",
-                                file=sys.stderr,
+                    try:
+                        full_page.edit(**update_data)
+                        full_page._fetched_at = datetime.now()
+                        if hasattr(full_page.course, "page_cache"):
+                            full_page.course.page_cache[full_page.url] = (full_page, {})
+                        logger.info(f"Updated page: {full_page.title}")
+                        if "modules" in attributes:
+                            module_regexes = attributes["modules"]
+                            added, removed = canvaslms.cli.modules.update_item_modules(
+                                full_page.course, "Page", full_page.url, module_regexes
                             )
-                        if removed:
+                            if added:
+                                print(
+                                    f"  Added to modules: {', '.join(added)}",
+                                    file=sys.stderr,
+                                )
+                            if removed:
+                                print(
+                                    f"  Removed from modules: {', '.join(removed)}",
+                                    file=sys.stderr,
+                                )
+                    except Exception as e:
+                        logger.error(f"Error updating page '{full_page.title}': {e}")
+                        print(
+                            f"Error updating page '{full_page.title}': {e}",
+                            file=sys.stderr,
+                        )
+                elif len(matching_pages) == 0:
+                    if args.create:
+                        create_params = {
+                            "title": attributes.get("title", "Untitled Page"),
+                            "body": html_content,
+                        }
+                        if "published" in attributes:
+                            create_params["published"] = attributes["published"]
+                        if "front_page" in attributes:
+                            create_params["front_page"] = attributes["front_page"]
+                        if (
+                            "editing_roles" in attributes
+                            and attributes["editing_roles"]
+                        ):
+                            create_params["editing_roles"] = attributes["editing_roles"]
+
+                        try:
+                            new_page = course.create_page(wiki_page=create_params)
+                            new_page.course = course
                             print(
-                                f"  Removed from modules: {', '.join(removed)}",
+                                f"Created page: {new_page.title} (url: {new_page.url})",
                                 file=sys.stderr,
                             )
-                except Exception as e:
-                    logger.error(f"Error updating page '{full_page.title}': {e}")
+                            if "modules" in attributes:
+                                module_regexes = attributes["modules"]
+                                added, removed = (
+                                    canvaslms.cli.modules.update_item_modules(
+                                        new_page.course,
+                                        "Page",
+                                        new_page.url,
+                                        module_regexes,
+                                    )
+                                )
+                                if added:
+                                    print(
+                                        f"  Added to modules: {', '.join(added)}",
+                                        file=sys.stderr,
+                                    )
+                        except Exception as e:
+                            logger.error(f"Error creating page: {e}")
+                            print(f"Error creating page: {e}", file=sys.stderr)
+                    else:
+                        print(
+                            f"Error: Page '{title}' not found. "
+                            f"Use --create to create a new page.",
+                            file=sys.stderr,
+                        )
+                        return
+                else:
                     print(
-                        f"Error updating page '{full_page.title}': {e}", file=sys.stderr
+                        f"Error: Multiple pages with title '{title}' found. "
+                        f"Add 'url' field to YAML to identify specific page.",
+                        file=sys.stderr,
                     )
+                    return
+            else:
+                pages = process_page_option(canvas, args)
+                if len(pages) > 1:
+                    print(
+                        f"Error: {len(pages)} pages match filter. "
+                        f"Add 'title' or 'url' to YAML, or use -p to narrow selection.",
+                        file=sys.stderr,
+                    )
+                    return
+                for page in pages:
+                    full_page = page.course.get_page(page.url)
+                    full_page.course = page.course
+                    update_data = {
+                        "wiki_page": {
+                            "title": attributes.get("title", full_page.title),
+                            "body": html_content,
+                        }
+                    }
+
+                    if "published" in attributes:
+                        update_data["wiki_page"]["published"] = attributes["published"]
+                    if "front_page" in attributes:
+                        update_data["wiki_page"]["front_page"] = attributes[
+                            "front_page"
+                        ]
+                    if "editing_roles" in attributes and attributes["editing_roles"]:
+                        update_data["wiki_page"]["editing_roles"] = attributes[
+                            "editing_roles"
+                        ]
+
+                    try:
+                        full_page.edit(**update_data)
+                        full_page._fetched_at = datetime.now()
+                        if hasattr(full_page.course, "page_cache"):
+                            full_page.course.page_cache[full_page.url] = (full_page, {})
+                        logger.info(f"Updated page: {full_page.title}")
+                        if "modules" in attributes:
+                            module_regexes = attributes["modules"]
+                            added, removed = canvaslms.cli.modules.update_item_modules(
+                                full_page.course, "Page", full_page.url, module_regexes
+                            )
+                            if added:
+                                print(
+                                    f"  Added to modules: {', '.join(added)}",
+                                    file=sys.stderr,
+                                )
+                            if removed:
+                                print(
+                                    f"  Removed from modules: {', '.join(removed)}",
+                                    file=sys.stderr,
+                                )
+                    except Exception as e:
+                        logger.error(f"Error updating page '{full_page.title}': {e}")
+                        print(
+                            f"Error updating page '{full_page.title}': {e}",
+                            file=sys.stderr,
+                        )
     else:
         try:
             page_list = process_page_option(canvas, args)

{canvaslms-5.1.dist-info → canvaslms-5.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: canvaslms
-Version: 5.1
+Version: 5.3
 Summary: Command-line interface to Canvas LMS
 License-Expression: MIT
 License-File: LICENSE

{canvaslms-5.1.dist-info → canvaslms-5.3.dist-info}/RECORD

@@ -20,10 +20,10 @@ canvaslms/cli/grade.nw,sha256=ms7sBiGRPbK0CJLKxxYx_CDY9LMWgKxUuf2M3FYepMs,2197
 canvaslms/cli/grade.py,sha256=b7YkFIz64oXzcV2FcptpYJphevuCU3cdx9CilZHcG_A,662
 canvaslms/cli/login.nw,sha256=93LyHO_LXL1WdEvMg3OLhWulgkdoO8pfjYZVLwUbX4I,4419
 canvaslms/cli/login.py,sha256=GSO_wIT4TvCOwxaNW0VfUqjrkzsHvnImuSH4SdCu92M,2751
-canvaslms/cli/modules.nw,sha256=Wuh1aFwZJDEUAEzzgALnc-YVXNdRgRI819zdV7oIB_E,21864
-canvaslms/cli/modules.py,sha256=n1MfeZfjPTKyFwgluHwBqW8PKHwCGktWzYA6nuFLeL0,11483
-canvaslms/cli/pages.nw,sha256=hRYLeEmwaDhnVcUq6Sx5JkKq-uJ4BJ7dOI4dOJ6bN9E,26662
-canvaslms/cli/pages.py,sha256=NxH6vgQr-LhIb9jgESD3J6sYCOv6S_4K7EhAm4uyRlI,21396
+canvaslms/cli/modules.nw,sha256=VZkb9u9VGmXoCyJpPyByFrOanqbKSLnIRPxODSfldxo,23689
+canvaslms/cli/modules.py,sha256=7pnKU6ex6zH4OC2SxLMn4uzc0cDl3pAVFcR9WJi317c,12426
+canvaslms/cli/pages.nw,sha256=njm6oQT22ryI8Z7O62d-qivQjbMX_je5OwhgHEvtVUg,28934
+canvaslms/cli/pages.py,sha256=lW8DpMeyQQoVcu7ztSj_PdW-oUJC0HSh5mDeo8BuaRc,27713
 canvaslms/cli/quizzes.nw,sha256=nO0lAJLpE03fwPTV8wCC0Zr65p7J5x2H7J0OU8KW5CA,203138
 canvaslms/cli/quizzes.py,sha256=gx-SPm0rI2XNVUl5Qm7s4UHvsvitwFyrNh35J3Lay9Y,152014
 canvaslms/cli/results.nw,sha256=T-ry1k_cHCH_nJfvPl4d9UBbIl_SxvXjBMxyYfXgyaw,22503
@@ -57,8 +57,8 @@ canvaslms/hacks/attachment_cache.py,sha256=LcOZqaa6jPrEJWUD-JYN5GTc3bxCbv2fr_vqu
 canvaslms/hacks/canvasapi.nw,sha256=ixmIHn4tgy-ZKtQ1rqWSw97hfY2m0qtGX0de2x89lwA,136470
 canvaslms/hacks/canvasapi.py,sha256=A-r48x7gO6143_QkuZ8n6EW66i-a2AXXr7X7oeehOAU,31868
 canvaslms/hacks/test_hacks.py,sha256=JSJNvZqHu1E_s51HsPD7yr1gC-R-xVe-tuMMAKU9Gj8,66709
-canvaslms-5.1.dist-info/METADATA,sha256=pg6Y0rHkQMWRUu_y1ATILFEL164PJhTvN3GYqHVv9ms,5978
-canvaslms-5.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-canvaslms-5.1.dist-info/entry_points.txt,sha256=lyblfkLbodN5yb7q1c6-rwIoJPV-ygXrB9PYb5boHXM,48
-canvaslms-5.1.dist-info/licenses/LICENSE,sha256=N_TKsbzzD5Ax5fWJqEQk9bkwtf394MJkNeFld4HV6-E,1074
-canvaslms-5.1.dist-info/RECORD,,
+canvaslms-5.3.dist-info/METADATA,sha256=rvvX57QhCQT6AtrYaPIaBZ5JJ1KDay6O-zOSd61f2SA,5978
+canvaslms-5.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+canvaslms-5.3.dist-info/entry_points.txt,sha256=lyblfkLbodN5yb7q1c6-rwIoJPV-ygXrB9PYb5boHXM,48
+canvaslms-5.3.dist-info/licenses/LICENSE,sha256=N_TKsbzzD5Ax5fWJqEQk9bkwtf394MJkNeFld4HV6-E,1074
+canvaslms-5.3.dist-info/RECORD,,