Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the can Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:20:18 2022 GMT+0.
Next: Systems, Previous: The can Reference Manual, Up: The can Reference Manual [Contents][Index]
Can is a role-based access right control library.
(defclass user () ()
(:metaclass mito:dao-table-class))
(defclass user-role ()
((user :col-type user
:initarg :user
:accessor user-role-user)
(role :col-type (:varchar 50)
:initarg :role
:inflate (compose #'make-keyword #'string-upcase)
:deflate #'string-downcase
:accessor user-role-role))
(:metaclass mito:dao-table-class)
(:primary-key user role)
(:auto-pk nil)
(:record-timestamps nil))
;; Retrieving roles from "user-role" table
(defmethod user-roles ((user user))
(mapcar #'user-role-role
(mito:retrieve-dao 'user-role :user user)))
(defclass entry ()
((author :col-type user
:initarg :author
:accessor entry-author))
(:metaclass mito:dao-table-class))
;; Return (:owner) if the user is an author of the entry
(defmethod user-roles-for-resource ((user user) (resource entry))
(cond
((object= user (entry-author resource))
(list :owner))
(t
nil)))
;; All users can see the entry
(defmethod resource-allowed-p ((resource entry) (action (eql :show)) role)
t)
;; Owner can edit the entry
(defmethod resource-allowed-p ((resource entry) (action (eql :edit)) (role (eql :owner)))
t)
;; Owner can delete the entry
(defmethod resource-allowed-p ((resource entry) (action (eql :delete)) (role (eql :owner)))
t)
(let* ((user (mito:find-dao 'user :id 1))
(entry (first (mito:retrieve-dao 'entry :author user))))
(can user :edit entry))
;=> T
(ql:quickload :can)
Copyright (c) 2016 Eitaro Fukamachi (e.arrows@gmail.com)
Licensed under the BSD 2-Clause License.
Next: Modules, Previous: Introduction, Up: The can Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
A role-based access right control library
Eitaro Fukamachi
BSD 2-Clause
# Can
Can is a role-based access right control library.
## Usage
“‘common-lisp
(defclass user () ()
(:metaclass mito:dao-table-class))
(defclass user-role ()
((user :col-type user
:initarg :user
:accessor user-role-user)
(role :col-type (:varchar 50)
:initarg :role
:inflate (compose #’make-keyword #’string-upcase)
:deflate #’string-downcase
:accessor user-role-role))
(:metaclass mito:dao-table-class)
(:primary-key user role)
(:auto-pk nil)
(:record-timestamps nil))
;; Retrieving roles from "user-role" table
(defmethod user-roles ((user user))
(mapcar #’user-role-role
(mito:retrieve-dao ’user-role :user user)))
(defclass entry ()
((author :col-type user
:initarg :author
:accessor entry-author))
(:metaclass mito:dao-table-class))
;; Return (:owner) if the user is an author of the entry
(defmethod user-roles-for-resource ((user user) (resource entry))
(cond
((object= user (entry-author resource))
(list :owner))
(t
nil)))
;; All users can see the entry
(defmethod resource-allowed-p ((resource entry) (action (eql :show)) role)
t)
;; Owner can edit the entry
(defmethod resource-allowed-p ((resource entry) (action (eql :edit)) (role (eql :owner)))
t)
;; Owner can delete the entry
(defmethod resource-allowed-p ((resource entry) (action (eql :delete)) (role (eql :owner)))
t)
(let* ((user (mito:find-dao ’user :id 1))
(entry (first (mito:retrieve-dao ’entry :author user))))
(can user :edit entry))
;=> T
“‘
## Installation
“‘common-lisp
(ql:quickload :can)
“‘
## Author
* Eitaro Fukamachi (e.arrows@gmail.com)
## Copyright
Copyright (c) 2016 Eitaro Fukamachi (e.arrows@gmail.com)
## License
Licensed under the BSD 2-Clause License.
0.1
src (module).
Next: Files, Previous: Systems, Up: The can Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: Packages, Previous: Modules, Up: The can Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Previous: can/can.asd, Up: Lisp [Contents][Index]
src (module).
can.
Next: Definitions, Previous: Files, Up: The can Reference Manual [Contents][Index]
Packages are listed by definition order.
common-lisp.
Next: Indexes, Previous: Packages, Up: The can Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Previous: Definitions, Up: Definitions [Contents][Index]
Next: Generic functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Previous: Definitions, Up: The can Reference Manual [Contents][Index]
| Jump to: | C F G M R U |
|---|
| Jump to: | C F G M R U |
|---|
| Jump to: | C F M P S |
|---|
| Jump to: | C F M P S |
|---|