Radiance Base Implementations

#|
  This file is a part of TyNETv5/Radiance
  (c) 2013 TymoonNET/NexT http://tymoon.eu (shinmera@tymoon.eu)
  Author: Nicolas Hafner <shinmera@tymoon.eu>
|#

(in-package :radiance)

(defimpl dispatcher
    "Primary dispatcher module that propagates page calls to triggers."
  (dispatch (request) "Dispatch a new webserver call.")
  (register (trigger) "Register a trigger to dispatch to."))

(defimpl user
    "Defines a very basic user class that allows tying arbitrary data to a user."
  (user-get (username) "Returns the user object of an existing user or creates a new hull instance.")
  (user-field (field &optional value) "Set or get a user data field.")
  (user-save () "Save the user to the database.")
  (user-saved-p () "Returns T if the user is not a hull instance, otherwise NIL."))

(defimpl auth
    "Handles one or more methods for authentication of a user."
  (authenticate ((user user)) "Authenticate the given user using whatever method applicable. Additional arguments may be necessary or read from the user object. Returns NIL on failure, user on success.")
  (authenticated-p ((user user)) "Returns T if the user has been authenticated successfully, otherwise NIL."))

(defimpl session
    "Session instances track whether a given user is still logged in or not."
  (session-start ((user user)) "Creates a new session object for the given user or continues an existing one if applicable..")
  (session-end () "Finalizes the session object and in effect logs the user out."))