add links to edit descriptions of dojos, modules, and challenges (#803)

* add links to edit descriptions of dojos, modules, and challenges

* add edit links to markdown resources

* working

* cleanup

* cleanup

* properly set the branch name

Author: zardus

dojo_plugin/pages/dojo.py

@@ -1,7 +1,9 @@
 import collections
+import subprocess
 import traceback
 import datetime
 import sys
+import re
 
 from flask import Blueprint, render_template, abort, send_file, redirect, url_for, Response, stream_with_context, request, g
 from sqlalchemy.exc import IntegrityError
@@ -21,6 +23,48 @@
 #pylint:disable=redefined-outer-name
 
 
+def find_description_edit_url(dojo, relative_paths, search_pattern=None):
+    if not (dojo.official and dojo.repository):
+        return None
+    
+    branch = "main"
+    if dojo.path.exists():
+        try:
+            result = subprocess.run(
+                ["git", "rev-parse", "--abbrev-ref", "HEAD"],
+                cwd=dojo.path,
+                capture_output=True,
+                text=True,
+                timeout=1
+            )
+            if result.returncode == 0:
+                branch = result.stdout.strip()
+        except (subprocess.TimeoutExpired, FileNotFoundError):
+            pass
+    
+    for relative_path in relative_paths:
+        full_path = dojo.path / relative_path
+        
+        if not full_path.exists():
+            continue
+            
+        line_num = 1
+        if relative_path.endswith('.yml') and search_pattern:
+            try:
+                pattern = re.compile(search_pattern)
+                with open(full_path, 'r') as f:
+                    for i, line in enumerate(f, 1):
+                        if pattern.search(line):
+                            line_num = i
+                            break
+            except (IOError, re.error):
+                pass
+        
+        return f"https://github.com/{dojo.repository}/edit/{branch}/{relative_path}#L{line_num}"
+    
+    return None
+
+
 @dojo.route("/<dojo>")
 @dojo.route("/<dojo>/")
 @dojo_route
@@ -36,6 +80,11 @@ def listing(dojo):
         if container["dojo"] == dojo.reference_id
     )
     stats["active"] = sum(module_container_counts.values())
+    
+    description_edit_url = None
+    if dojo.description and dojo.path.exists():
+        description_edit_url = find_description_edit_url(dojo, ["DESCRIPTION.md", "dojo.yml"], r"^description:")
+    
     return render_template(
         "dojo.html",
         dojo=dojo,
@@ -45,6 +94,7 @@ def listing(dojo):
         infos=infos,
         awards=awards,
         module_container_counts=module_container_counts,
+        description_edit_url=description_edit_url,
     )
 
 
@@ -285,6 +335,36 @@ def view_module(dojo, module):
         for container in get_container_stats()
         if container["module"] == module.id and container["dojo"] == dojo.reference_id
     )
+    
+    module_description_edit_url = None
+    challenge_description_edit_urls = {}
+    resource_description_edit_urls = {}
+    
+    if dojo.path.exists():
+        if module.description:
+            module_description_edit_url = find_description_edit_url(dojo, [
+                f"{module.id}/DESCRIPTION.md",
+                f"{module.id}/module.yml",
+                "dojo.yml"
+            ], r"^description:")
+        
+        for challenge in module.challenges:
+            if challenge.description:
+                # Search for "- id: challenge_name" with optional quotes
+                challenge_description_edit_urls[challenge.id] = find_description_edit_url(dojo, [
+                    f"{module.id}/{challenge.id}/DESCRIPTION.md",
+                    f"{module.id}/{challenge.id}/challenge.yml",
+                    f"{module.id}/module.yml",
+                    "dojo.yml"
+                ], rf"^\s*-?\s*id:\s*[\"']?{re.escape(challenge.id)}[\"']?")
+        
+        for resource in module.resources:
+            if resource.type == "markdown":
+                # Search for "- name: Resource Name" with optional quotes
+                resource_description_edit_urls[resource.resource_index] = find_description_edit_url(
+                    dojo, [f"{module.id}/module.yml", "dojo.yml"],
+                    rf"^\s*-?\s*name:\s*[\"']?{re.escape(resource.name)}[\"']?"
+                )
 
     return render_template(
         "module.html",
@@ -297,6 +377,9 @@ def view_module(dojo, module):
         current_dojo_challenge=current_dojo_challenge,
         assessments=assessments,
         challenge_container_counts=challenge_container_counts,
+        module_description_edit_url=module_description_edit_url,
+        challenge_description_edit_urls=challenge_description_edit_urls,
+        resource_description_edit_urls=resource_description_edit_urls,
     )
 
 

dojo_theme/static/css/custom.css

@@ -1062,3 +1062,25 @@ code {
         background-color: rgba(0, 0, 0, 0.8);
     }
 }
+
+.github-edit-link {
+    float: right;
+    padding: 2px 6px;
+    margin-left: 10px;
+    font-size: 0.7rem;
+    color: var(--brand-light-gray);
+    text-decoration: none;
+    transition: all 0.2s ease;
+    opacity: 0.6;
+}
+
+.github-edit-link:hover {
+    color: var(--brand-green);
+    text-decoration: none;
+    opacity: 1;
+}
+
+.github-edit-link i {
+    margin-right: 2px;
+    font-size: 0.65rem;
+}

dojo_theme/templates/dojo.html

@@ -11,7 +11,17 @@ <h1 class="brand-white brand-mono-bold">{{ dojo.name or dojo.id }}<span class="b
   {% include "components/errors.html" %}
 
   {% if dojo.description %}
-  <p>{{ dojo.description | markdown }}</p>
+  <div>
+    {% if description_edit_url %}
+      <a href="{{ description_edit_url }}" 
+         target="_blank" 
+         class="github-edit-link"
+         title="Edit on GitHub">
+        <i class="fas fa-edit"></i>
+      </a>
+    {% endif %}
+    {{ dojo.description | markdown }}
+  </div>
   <br>
   {% endif %}
 

dojo_theme/templates/macros/widgets.html

@@ -63,6 +63,7 @@ <h2 class="mb-0 button-wrapper">
   </div>
 {% endmacro %}
 
+
 {% set svg_add_icon %}
 <svg class="w-100 h-100">
   <circle cx="50%" cy="50%" r="30%" stroke="gray" fill="none" stroke-width="8" stroke-dasharray="8"></circle>

dojo_theme/templates/module.html

@@ -71,7 +71,17 @@ <h3 class="module-due-date" title="{{ assessment.date }}">{{ assessment.name }}
 <div class="container">
 
   {% if module.description %}
-  <p>{{ module.description | markdown }}</p>
+  <div>
+    {% if module_description_edit_url %}
+      <a href="{{ module_description_edit_url }}" 
+         target="_blank" 
+         class="github-edit-link"
+         title="Edit on GitHub">
+        <i class="fas fa-edit"></i>
+      </a>
+    {% endif %}
+    {{ module.description | markdown }}
+  </div>
   <br>
   {% endif %}
 
@@ -114,6 +124,14 @@ <h4 class="accordion-item-name">
 
             {% elif resource.type == "markdown" %}
             <div class="embed-responsive">
+              {% if resource_description_edit_urls.get(resource.resource_index) %}
+                <a href="{{ resource_description_edit_urls[resource.resource_index] }}" 
+                   target="_blank" 
+                   class="github-edit-link"
+                   title="Edit on GitHub">
+                  <i class="fas fa-edit"></i>
+                </a>
+              {% endif %}
               {{ resource.content | markdown }}
             </div>
             {% endif %}
@@ -184,6 +202,14 @@ <h4 class="accordion-item-name challenge-name {{ active }}" data-challenge-index
               {% if lock_challenge %}
                 <p><em>This challenge is locked</em></p>
               {% else %}
+                {% if challenge_description_edit_urls.get(challenge.id) %}
+                  <a href="{{ challenge_description_edit_urls[challenge.id] }}" 
+                     target="_blank" 
+                     class="github-edit-link"
+                     title="Edit on GitHub">
+                    <i class="fas fa-edit"></i>
+                  </a>
+                {% endif %}
                 {{ challenge.description | markdown }}
               {% endif %}
             </div>

test/test_edit_links.py

@@ -0,0 +1,18 @@
+from utils import DOJO_URL
+
+def test_github_edit_links_welcome_dojo(admin_session, welcome_dojo):
+    """Test that GitHub edit links appear correctly for the welcome dojo"""
+
+    response = admin_session.get(f"{DOJO_URL}/{welcome_dojo}")
+    assert response.status_code == 200, f"Failed to load welcome dojo page: {response.status_code}"
+    
+    assert "github.com/pwncollege/welcome-dojo/edit/main/" in response.text, \
+        "Dojo page should have edit link"
+    assert "fa-edit" in response.text, "Edit links should include Font Awesome edit icon"
+    assert "github-edit-link" in response.text, "Edit links should have the github-edit-link CSS class"
+
+    response = admin_session.get(f"{DOJO_URL}/{welcome_dojo}/welcome")
+    assert response.status_code == 200, f"Failed to load welcome module page: {response.status_code}"
+    
+    assert "github.com/pwncollege/welcome-dojo/edit/main/" in response.text, \
+        "Module page should have edit link"