tiny_wiki 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af5c72a41a3d369a441ccc793dc7b2d3c7740859bea4d5dc3807731b4ce72441
-  data.tar.gz: a9811b3e5d374cf0108561274c2ee58e333afb5e703cbbb2c75bccd629b359d4
+  metadata.gz: 903269ded1ae9f2bb397a82fc2fbb9ffba908bbfd201c3e24f95663dd2e6f604
+  data.tar.gz: b8a0d910250d1862c1438127e9a3e19c3e0a6dbfeb255ed8486e62754d8539cd
 SHA512:
-  metadata.gz: 3c5d3f6c6d849c6790f8936c86e1a424faca750d32ec9f0dafefa29e6347b1f26b6df5b0c742c9aa51980be89496dbb2a742ea113281bc5dc592e2e5982b2c57
-  data.tar.gz: a34c9d2b61a26389a30eca5a4801f516724b311f32102df402814cae8dee85efb6479dfcb7337ccde8334c5112c34b6f7a6b67ac971d9d653c26e4574ca2c26c
+  metadata.gz: 2c7dddd80cad267b123557bde677c44d1e525f8001fb03938c89a03d8d8ee10bfda3f02182f9f29aae3aecdae06587f12b8637a64cf6a03ae129bb05b2c0df60
+  data.tar.gz: e26ccab0193a60426a29af24c1a65c06d587aae683d79f1584c481e448078518d4507e03d99d4d000cd6b6270c83eed29f045097a4f558d28e8f1497a33a2f5b

data/exe/tiny_wiki_server

@@ -17,6 +17,10 @@ OptionParser.new do |opts|
     options[:bind] = b
   end
 
+  opts.on("-d", "--debug", "Enable debug messages (verbose logging)") do |d|
+    options[:debug] = d
+  end
+
   opts.on("-h", "--help", "Prints this help") do
     puts opts
     exit
@@ -45,6 +49,9 @@ TinyWiki::App.set :wiki_root, File.expand_path(wiki_directory)
 TinyWiki::App.set :port, options[:port] if options[:port]
 TinyWiki::App.set :bind, options[:bind] if options[:bind]
 
+# Set the debug flag in the Sinatra application settings
+TinyWiki::App.set :debug, options[:debug] if options[:debug]
+
 puts "Starting TinyWiki server..."
 puts "Wiki root: #{TinyWiki::App.settings.wiki_root}"
 puts "Listening on #{TinyWiki::App.settings.bind}:#{TinyWiki::App.settings.port}"

data/lib/tiny_wiki/app.rb

@@ -19,16 +19,38 @@ module TinyWiki
     # Enable sessions for flash messages (optional, but good for feedback)
     enable :sessions
 
+    # Default debug setting
+    set :debug, false
+
+    # Helper for conditional debug logging
+    def debug_log(message)
+      puts "DEBUG: #{message}" if settings.debug
+    end
+
     # Custom Redcarpet renderer to handle wiki links (e.g., [[Page Name]])
     class WikiLinkRenderer < Redcarpet::Render::HTML
       # The postprocess method is called after all other rendering is complete.
       # We use it to find and replace our custom wiki link syntax.
       def postprocess(full_document)
         full_document.gsub(/\[\[(.*?)\]\]/) do
-          page_name = $1.strip # Get the text inside the brackets
-          # Sanitize page name for URL: replace spaces with underscores, then URI encode
-          url_safe_page_name = URI.encode_www_form_component(page_name.gsub(' ', '_'))
-          "<a href=\"/#{url_safe_page_name}\">#{page_name}</a>"
+          raw_page_path = $1.strip # e.g., "Folder/Page Name"
+
+          # Split the path into components
+          path_components = raw_page_path.split('/')
+
+          # Sanitize each component and convert spaces to underscores for the URL
+          # Then URI encode each component
+          url_safe_components = path_components.map do |comp|
+            # Replace spaces with underscores for URL segment
+            sanitized_comp = comp.gsub(' ', '_')
+            # URI encode the individual component
+            URI.encode_www_form_component(sanitized_comp)
+          end
+
+          # Rejoin with '/' to form the URL path
+          url_path = url_safe_components.join('/')
+
+          "<a href=\"/#{url_path}\">#{raw_page_path}</a>"
         end
       end
     end
@@ -36,7 +58,7 @@ module TinyWiki
     # Markdown renderer setup
     # Create a Redcarpet renderer that uses HTML with code highlighting and auto-links.
     # The `fenced_code_blocks` and `autolink` extensions are common and useful.
-    markdown_renderer = WikiLinkRenderer.new(
+    markdown_renderer = WikiLinkRenderer.new( # Use our custom renderer here
       filter_html: true,
       hard_wrap: true,
       link_attributes: { rel: "nofollow", target: "_blank" },
@@ -57,12 +79,15 @@ module TinyWiki
     )
 
     # Helper method to get the full path to a markdown file
-    # `page_name` is expected to be URL-decoded and safe for filenames.
-    def wiki_file_path(page_name)
-      # Ensure the page name doesn't contain directory traversal attempts
-      # This is a basic sanitization. For production, more robust checks are needed.
-      sanitized_page_name = page_name.gsub(/[^a-zA-Z0-9_\-]/, '') # Allow only alphanumeric, underscore, hyphen
-      File.join(settings.wiki_root, "#{sanitized_page_name}.md")
+    # `page_path` is expected to be URL-decoded and can contain slashes.
+    def wiki_file_path(page_path)
+      # Normalize path to prevent directory traversal (e.g., /foo/../bar)
+      # Split by '/' and reject empty components, '.' and '..'.
+      # Then re-join to form a safe relative path.
+      safe_components = page_path.split('/').reject { |c| c.empty? || c == '.' || c == '..' }
+
+      # Reconstruct the path. File.join handles OS-specific separators.
+      File.join(settings.wiki_root, "#{safe_components.join('/')}.md")
     end
 
     # Helper method to read the content of a wiki page
@@ -84,10 +109,14 @@ module TinyWiki
       @@markdown.render(markdown_content)
     end
 
-    # Helper to get all wiki pages (filenames without extension)
+    # Helper to get all wiki pages (filenames without extension, including paths)
     def all_wiki_pages
-      Dir.glob(File.join(settings.wiki_root, '*.md')).map do |file|
-        File.basename(file, '.md')
+      # Find all .md files recursively within the wiki_root
+      Dir.glob(File.join(settings.wiki_root, '**', '*.md')).map do |file_path|
+        # Get the path relative to wiki_root and remove the .md extension
+        # Example: /path/to/wiki_root/Folder/Page.md -> Folder/Page
+        relative_path_with_ext = file_path.sub("#{settings.wiki_root}/", '')
+        relative_path_with_ext.sub(/\.md$/, '')
       end.sort
     rescue Errno::ENOENT
       # If the wiki_root directory doesn't exist yet, return an empty array
@@ -101,46 +130,71 @@ module TinyWiki
       redirect to('/Home')
     end
 
+    # Handle favicon.ico requests directly to avoid treating them as wiki pages
+    get '/favicon.ico' do
+      # You can serve an actual favicon.ico file here if you have one.
+      # For now, we'll just return a 404 to prevent redirection.
+      status 404
+      '' # Return empty body
+    end
+
+    # Handle Chrome DevTools specific requests
+    get '/.well-known/appspecific/com.chrome.devtools.json' do
+      status 404
+      '' # Return empty body
+    end
+
     # List all wiki pages
     get '/_list' do
       @pages = all_wiki_pages
       erb :list # Render a 'list.erb' template (you'll need to create this)
     end
 
-    # Display a wiki page
-    get '/:page_name' do
-      @page_name = URI.decode_www_form_component(params[:page_name])
-      @markdown_content = read_page(@page_name)
-
-      if @markdown_content
-        @html_content = markdown_to_html(@markdown_content)
-        erb :show # Render 'show.erb'
-      else
-        # Page not found, redirect to edit page
-        session[:message] = "Page '#{@page_name}' does not exist. Create it!"
-        redirect to("/#{@page_name}/edit")
-      end
-    end
-
     # Show the edit form for a wiki page
-    get '/:page_name/edit' do
-      @page_name = URI.decode_www_form_component(params[:page_name])
+    # The splat parameter `*page_path` will match multiple path segments, including slashes.
+    get '/*page_path/edit' do
+      @page_name = URI.decode_www_form_component(params[:page_path])
       @markdown_content = read_page(@page_name) || "" # Empty string if new page
-      erb :edit # Render 'edit.erb'
+      debug_log "Rendering edit form for page: #{@page_name}" # DEBUG
+      erb :edit
     end
 
     # Save the content of a wiki page
-    post '/:page_name' do
-      @page_name = URI.decode_www_form_component(params[:page_name])
+    # The splat parameter `*page_path` will match multiple path segments, including slashes.
+    post '/*page_path' do
+      @page_name = URI.decode_www_form_component(params[:page_path])
       new_content = params[:content]
+      debug_log "POST request to save page: #{@page_name}" # DEBUG
+      debug_log "Content received: #{new_content.inspect}" # DEBUG
 
       if new_content && !new_content.strip.empty?
         write_page(@page_name, new_content)
         session[:message] = "Page '#{@page_name}' saved successfully!"
+        debug_log "Page saved, redirecting to /#{@page_name}" # DEBUG
         redirect to("/#{@page_name}")
       else
         session[:message] = "Page content cannot be empty!"
-        redirect to("/#{@page_name}/edit") # Redirect back to edit with error
+        debug_log "Empty content, redirecting to /#{@page_name}/edit" # DEBUG
+        redirect to("/#{@page_name}/edit")
+      end
+    end
+
+    # Display a wiki page
+    # The splat parameter `*page_path` will match multiple path segments, including slashes.
+    get '/*page_path' do
+      @page_name = URI.decode_www_form_component(params[:page_path])
+      @markdown_content = read_page(@page_name)
+
+      if @markdown_content
+        @html_content = markdown_to_html(@markdown_content)
+        erb :show
+      else
+        # Page not found, redirect to edit page
+        session[:message] = "Page '#{@page_name}' does not exist. Create it!"
+        # Ensure the page_name doesn't already end with '/edit' before redirecting
+        clean_page_name_for_redirect = @page_name.sub(/\/edit$/, '')
+        debug_log "Redirecting to edit for non-existent page: /#{clean_page_name_for_redirect}/edit" # DEBUG
+        redirect to("/#{clean_page_name_for_redirect}/edit")
       end
     end
 

data/lib/tiny_wiki/templates/edit.erb

@@ -1,6 +1,6 @@
 <h1>Editing <%= @page_name.empty? ? 'New Page' : @page_name %></h1>
 
-<form action="/<%= URI.encode_www_form_component(@page_name) %>" method="post">
+<form action="<%= to(@page_name) %>" method="post">
     <textarea name="content"><%= @markdown_content %></textarea><br>
     <input type="submit" value="Save Page">
 </form>

data/lib/tiny_wiki/templates/list.erb

@@ -5,7 +5,7 @@
 <% else %>
     <ul>
         <% @pages.each do |page| %>
-            <li><a href="/<%= URI.encode_www_form_component(page) %>"><%= page %></a></li>
+            <li><a href="/<%= page %>"><%= page %></a></li>
         <% end %>
     </ul>
 <% end %>

data/lib/tiny_wiki/version.rb

@@ -1,5 +1,5 @@
 # Defines the version of the gem.
 
 module TinyWiki
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny_wiki
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Erik Yuzwa