๐ข Running
+0 +#+END_SRC + +*Note:* The ~data-text~ attributes remain in the rendered HTML output. This is normal CLIP behavior - the attribute is processed and content is replaced, but the attribute itself is not removed. + +* Route Handler Changes + +** Updated Files +- ~asteroid.lisp~ - Front page, admin, player routes +- ~auth-routes.lisp~ - Login route + +** Example Change +#+BEGIN_SRC lisp +;; Before - Manual template loading in every route +(define-page front-page #@"/" () + (let ((template-path (merge-pathnames "template/front-page.chtml" + (asdf:system-source-directory :asteroid)))) + (clip:process-to-string + (plump:parse (alexandria:read-file-into-string template-path)) + :title "๐ต ASTEROID RADIO ๐ต" + :station-name "๐ต ASTEROID RADIO ๐ต"))) + +;; After - Centralized template rendering with caching +(define-page front-page #@"/" () + (render-template-with-plist "front-page" + :title "๐ต ASTEROID RADIO ๐ต" + :station-name "๐ต ASTEROID RADIO ๐ต")) +#+END_SRC + +** How It Works +1. ~render-template-with-plist~ calls ~get-template~ to load/cache the template +2. Template is loaded once and cached in ~*template-cache*~ +3. Keyword arguments are passed directly to ~clip:process-to-string~ +4. CLIP's ~data-text~ processor replaces content using ~(clip:clipboard key-name)~ + +* Benefits + +1. **Performance** - Template caching reduces file I/O +2. **Consistency** - All routes use the same rendering approach +3. **Maintainability** - Centralized template logic +4. **Standards Compliance** - Uses CLIP's intended design patterns +5. **Extensibility** - Easy to add new attribute processors +6. **Debugging** - Clear separation between template loading and rendering + +* JavaScript Updates + +JavaScript selectors remain unchanged - they continue to use ~data-text~ attributes: +#+BEGIN_SRC javascript +// JavaScript uses data-text attributes to find and update elements +document.querySelector('[data-text="now-playing-artist"]').textContent = artist; +document.querySelector('[data-text="now-playing-track"]').textContent = track; +document.querySelector('[data-text="listeners"]').textContent = listeners; +#+END_SRC + +* Testing Checklist + +To verify the refactoring works correctly: + +- [X] Build executable with ~make~ +- [X] Restart Asteroid server +- [X] Visit front page (/) - verify content displays correctly +- [X] Verify template caching is working (templates loaded once) +- [ ] Visit admin page (/admin) - verify status indicators work +- [ ] Visit player page (/player) - verify player loads +- [ ] Test login (/login) - verify error messages display +- [ ] Check browser console for JavaScript errors +- [ ] Verify "Now Playing" updates work +- [ ] Test track scanning and playback + +** Test Results +- โ Templates render correctly with ~data-text~ attributes +- โ Content is properly replaced via CLIP's clipboard system +- โ Template caching reduces file I/O operations +- โ All routes use consistent ~render-template-with-plist~ function + +* Future Enhancements + +Potential improvements to the template system: + +1. **Template Composition** - Add support for including partial templates +2. **Template Inheritance** - Implement layout/block system for shared structure +3. **Hot Reloading** - Auto-reload templates in development mode when files change +4. **Additional Processors** - Create more custom attribute processors as needed: + - ~data-if~ for conditional rendering + - ~data-loop~ for iterating over collections + - ~data-attr~ for dynamic attribute values +5. **Template Validation** - Add linting/validation tools to catch errors early + +* Related TODO Items + +This refactoring completes the following TODO.org item: +- [X] Templates: move our template hydration into the Clip machinery + +** What Was Accomplished +- โ Centralized template processing utilities +- โ Implemented template caching for performance +- โ Standardized rendering approach across all routes +- โ Properly organized CLIP attribute processors +- โ Maintained CLIP's standard patterns and conventions + +* References + +- CLIP Documentation: https://shinmera.github.io/clip/ +- Plump Documentation: https://shinmera.github.io/plump/ +- Radiance Framework: https://shirakumo.github.io/radiance/ diff --git a/stream-media.lisp b/stream-media.lisp index fac4c53..1cb4394 100644 --- a/stream-media.lisp +++ b/stream-media.lisp @@ -13,9 +13,11 @@ (cl-fad:list-directory directory :follow-symlinks nil)))) (defun scan-directory-for-music-recursively (path) - (loop for directory in (uiop:subdirectories path) - with music = (scan-directory-for-music path) - appending (scan-directory-for-music directory))) + "Recursively scan directory and all subdirectories for music files" + (let ((files-in-current-dir (scan-directory-for-music path)) + (files-in-subdirs (loop for directory in (uiop:subdirectories path) + appending (scan-directory-for-music-recursively directory)))) + (append files-in-current-dir files-in-subdirs))) (defun extract-metadata-with-taglib (file-path) "Extract metadata using taglib library" @@ -57,39 +59,56 @@ :duration 0 :bitrate 0)))) +(defun track-exists-p (file-path) + "Check if a track with the given file path already exists in the database" + (let ((existing (db:select "tracks" (db:query (:= "file-path" file-path))))) + (> (length existing) 0))) + (defun insert-track-to-database (metadata) - "Insert track metadata into database" + "Insert track metadata into database if it doesn't already exist" ;; Ensure tracks collection exists (unless (db:collection-exists-p "tracks") (error "Tracks collection does not exist in database")) - (db:insert "tracks" - (list (list "title" (getf metadata :title)) - (list "artist" (getf metadata :artist)) - (list "album" (getf metadata :album)) - (list "duration" (getf metadata :duration)) - (list "file-path" (getf metadata :file-path)) - (list "format" (getf metadata :format)) - (list "bitrate" (getf metadata :bitrate)) - (list "added-date" (local-time:timestamp-to-unix (local-time:now))) - (list "play-count" 0)))) + ;; Check if track already exists + (let ((file-path (getf metadata :file-path))) + (if (track-exists-p file-path) + (progn + (format t "Track already exists, skipping: ~a~%" file-path) + nil) + (progn + (db:insert "tracks" + (list (list "title" (getf metadata :title)) + (list "artist" (getf metadata :artist)) + (list "album" (getf metadata :album)) + (list "duration" (getf metadata :duration)) + (list "file-path" file-path) + (list "format" (getf metadata :format)) + (list "bitrate" (getf metadata :bitrate)) + (list "added-date" (local-time:timestamp-to-unix (local-time:now))) + (list "play-count" 0))) + t)))) (defun scan-music-library (&optional (directory *music-library-path*)) "Scan music library directory and add tracks to database" (format t "Scanning music library: ~a~%" directory) (let ((audio-files (scan-directory-for-music-recursively directory)) - (added-count 0)) + (added-count 0) + (skipped-count 0)) + (format t "Found ~a audio files to process~%" (length audio-files)) (dolist (file audio-files) (let ((metadata (extract-metadata-with-taglib file))) (when metadata (handler-case - (progn - (insert-track-to-database metadata) - (incf added-count) - (format t "Added: ~a~%" (getf metadata :file-path))) + (if (insert-track-to-database metadata) + (progn + (incf added-count) + (format t "Added: ~a~%" (getf metadata :file-path))) + (incf skipped-count)) (error (e) (format t "Error adding ~a: ~a~%" file e)))))) - (format t "Library scan complete. Added ~a tracks.~%" added-count) + (format t "Library scan complete. Added ~a new tracks, skipped ~a existing tracks.~%" + added-count skipped-count) added-count)) ;; Initialize music directory structure diff --git a/template-utils.lisp b/template-utils.lisp new file mode 100644 index 0000000..affbbe5 --- /dev/null +++ b/template-utils.lisp @@ -0,0 +1,44 @@ +;;;; template-utils.lisp - CLIP Template Processing Utilities +;;;; Proper CLIP-based template rendering using keyword arguments + +(in-package :asteroid) + +;; Template cache for parsed templates +(defvar *template-cache* (make-hash-table :test 'equal) + "Cache for parsed template DOMs") + +(defun get-template (template-name) + "Load and cache a template file" + (or (gethash template-name *template-cache*) + (let* ((template-path (merge-pathnames + (format nil "template/~a.chtml" template-name) + (asdf:system-source-directory :asteroid))) + (parsed (plump:parse (alexandria:read-file-into-string template-path)))) + (setf (gethash template-name *template-cache*) parsed) + parsed))) + +(defun clear-template-cache () + "Clear the template cache (useful during development)" + (clrhash *template-cache*)) + +(defun render-template-with-plist (template-name &rest plist) + "Render a template with plist-style arguments - CLIP's standard way + + CLIP's process-to-string accepts keyword arguments directly and makes them + available via (clip:clipboard key-name) in attribute processors. + + Example: + (render-template-with-plist \"admin\" + :title \"Admin Dashboard\" + :server-status \"๐ข Running\")" + (let ((template (get-template template-name))) + ;; CLIP's standard approach: pass keywords directly + (apply #'clip:process-to-string template plist))) + +;; Custom CLIP attribute processor for text replacement +;; This is the proper CLIP way - define processors for custom attributes +(clip:define-attribute-processor data-text (node value) + "Process data-text attribute - replaces node text content with clipboard value + Usage: Default Text" + (plump:clear node) + (plump:make-text-node node (clip:clipboard value))) diff --git a/template/admin.chtml b/template/admin.chtml index 597c159..9d62054 100644 --- a/template/admin.chtml +++ b/template/admin.chtml @@ -12,6 +12,7 @@ @@ -62,11 +63,11 @@Total Tracks: 0
-Library Path: /music/library/
Manage user accounts, roles, and permissions.
| Username | -Role | -Status | -Last Login | -Actions | -|
|---|---|---|---|---|---|
| ${user.username} | -${user.email} | -- - | -${user.active ? 'โ Active' : 'โ Inactive'} | -${user['last-login'] ? new Date(user['last-login'] * 1000).toLocaleString() : 'Never'} | -- ${user.active ? - `` : - `` - } - | -