The reblocks Reference Manual

Methods

Method: attributize-name ((name null)) ¶

Method: attributize-name ((name string)) ¶

Method: attributize-name ((name symbol)) ¶

Method: attributize-name ((name integer)) ¶

Generic Function: body-classes (app) ¶

Should return a string of CSS classes for the body HTML element or NIL.

Package

Source

Methods

Method: body-classes (app) ¶

Generic Reader: cache-in-memory-p (object) ¶

Package

Methods

Reader Method: cache-in-memory-p ((local-dependency local-dependency)) ¶

When true, then on creation dependency will read file’s data into the memory.
This is useful for applications, deployed as a single executable file. Create such dependencies in compile time and store in a global variable.

Source: file-type.lisp.
Target Slot: cache-in-memory.

Generic Function: create-widget-from (object) ¶

Methods of this generic should return an instance of subclass of reblocks/widget:widget
The most obvious cases are transformation of strings and functions into the widget, but these methods are already supplied by Reblocks.

If REBLOCKS/PAGE:INIT-PAGE returns an object, then CREATE-WIDGET-FROM will be called on it to create the root widget.

Package

Source

Methods

Method: create-widget-from ((object function)) ¶

Source: file-type.lisp.

Method: create-widget-from ((object string)) ¶

Source: file-type.lisp.

Method: create-widget-from ((object widget)) ¶: If input is already a widget, then it is returned as is.

Method: create-widget-from ((object symbol)) ¶: If input is a symbol named a widget class, then we’ll MAKE-INSTANCE of this class.

Method: create-widget-from (object) ¶: If this method is called, that means that object is not of a proper type. Say it with an explicit error message.

Generic Function: dependency-equal (left right) ¶

Should return T if two dependencies are considered equal. By default compares their URLs.

Package

Source

Methods

Method: dependency-equal (left right) ¶

Generic Function: dom-id (obj) ¶

Provides a consistent interface to identifying widgets
by their DOM id. Returns a string or nil if the object is to have no id.

Package

Source

Methods

Method: dom-id ((obj dom-object-mixin)) ¶

Method: dom-id ((obj symbol)) ¶

Method: dom-id ((obj function)) ¶

Method: dom-id ((obj string)) ¶

Generic Function: (setf dom-id) (obj) ¶

Package

Source

Methods

Method: (setf dom-id) ((obj dom-object-mixin)) ¶

Generic Reader: escape-p (object) ¶

Generic Writer: (setf escape-p) (object) ¶

Package

Methods

Reader Method: escape-p ((string-widget string-widget)) ¶

Writer Method: (setf escape-p) ((string-widget string-widget)) ¶

Whether to escape the output for HTML.

Source: file-type.lisp.
Target Slot: escape-p.

Generic Function: eval-action (app action-name arguments) ¶

Evaluates the action that came with the request.

First it resolves action by trying to find ACTION-NAME inside session
or current app’s actions.
If actions wasn’t found, then EVAL-ACTION calls ON-MISSING-ACTION generic-function. Otherwise it applies arguments to the action callback.

Package

reblocks/actions.

Source

Methods

Method: eval-action (app action-name arguments) ¶

Generic Function: extend-page-expiration-by (app page) ¶

Returns NIL or a number of seconds after which page should be removed from the memory.

Default method returns current value of *EXTEND-PAGE-EXPIRATION-BY* variable or *PAGES-EXPIRE-IN* variable.

Package

Source

Methods

Method: extend-page-expiration-by (app page) ¶

Generic Reader: get-content (object) ¶

Package

Methods

Reader Method: get-content ((string-widget string-widget)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: content.

Generic Writer: (setf get-content) (object) ¶

Package

Methods

Writer Method: (setf get-content) ((string-widget string-widget)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: content.

Generic Reader: get-crossorigin (object) ¶

Package

Methods

Reader Method: get-crossorigin ((remote-dependency remote-dependency)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: crossorigin.

Generic Function: get-css-classes (widget) ¶

Returns a list of classes for the widget.
Classes may be a strings or a keywords.
By default, :widget and keyworded class name are returned. Use ‘(list* :new-class (call-next-method))‘
to add new classes.

Package

Source

Methods

Method: get-css-classes (widget) ¶

Generic Function: get-dependencies (object) ¶

Returns a list of object’s dependencies.

Object could be an application or a widget.
Reblocks will call this method for application and every widget on a page to gather necessary dependencies and to inject them into resulting HTML.

Package

Source

Methods

Method: get-dependencies ((self app)) ¶

Source: file-type.lisp.

Method: get-dependencies ((self jquery-backend)) ¶

Source: file-type.lisp.

Method: get-dependencies (object) ¶: By default, there are no dependencies for an object.

Generic Function: get-html-tag (widget) ¶

This method determines the enclosing tag of the widget.

The return value should either be a keyword like ‘:div‘,
which will be the enclosing tag, or a list of the form ‘(:tag . attributes)‘,
where ‘:tag‘ is the enclosing tag (like ‘:div‘) and attributes is a property list.

The attributes property list has keywords for keys, corresponding to
the attribute name and the values are the values of the attribute.

For example:

- ‘:div‘ - generates ‘<div ...> widget content </div>‘;
- ‘(:div :display "flex")‘ - generates ‘(<div ... :display "flex">widget content</div>‘.

Note on attributes: in the attribute list the following attributes can
not be specified, they will be ignored:

- ‘:class‘ - Use the GET-CSS-CLASSES generic-function to specify these;
- ‘:id‘ - This is the value of the dom-id slot of the widget,
normally automatically managed by reblocks.

The default implementation returns
- ‘:td‘ - inside a table row;
- ‘:tr‘ - inside a table;
- ‘:div‘ - by default.

Package

Source

Methods

Method: get-html-tag (widget) ¶

Generic Reader: get-integrity (object) ¶

Package

Methods

Reader Method: get-integrity ((remote-dependency remote-dependency)) ¶

A hash, used by modern browsers for subresource integrity checking.

See more information at: <https://www.w3.org/TR/SRI/>

Source: file-type.lisp.
Target Slot: integrity.

Generic Function: get-path (dependency) ¶

Returns a path on local disk to serve dependency from.

This could be a real source file or a cached version of remote dependency.

Package

Source

Methods

Method: get-path ((dependency remote-dependency)) ¶: Returns a path to cached file.

Reader Method: get-path ((local-dependency local-dependency)) ¶

automatically generated reader method

Target Slot: path.

Generic Reader: get-prefix (object) ¶

Package

Methods

Reader Method: get-prefix ((app app)) ¶

The subtree of the URI space at this site that belongs to the webapp.

Source: file-type.lisp.
Target Slot: prefix.

Generic Function: (setf get-prefix) (app) ¶

Package

Methods

Method: (setf get-prefix) ((app app)) ¶

Set the prefix of the webapp. Ensures normalization by removing trailing slash.

Source: file-type.lisp.

Generic Reader: get-response (obj) ¶

Extracts response from the object. Usually, obj will be an [IMMEDIATE-RESPONSE][condition] condition.

Package

reblocks/response.

Source

Methods

Reader Method: get-response ((condition immediate-response)) ¶

Target Slot: response.

Generic Function: get-route (dependency) ¶

This method should return a routes:route object if dependency should ber served from local server.

Package

Source

Methods

Reader Method: get-route ((local-dependency local-dependency)) ¶

automatically generated reader method

Target Slot: route.

Method: get-route (dependency) ¶: By default dependencies aren’t served by Lisp.

Generic Reader: get-type (object) ¶

Package

Methods

Reader Method: get-type ((dependency dependency)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: type.

Generic Function: get-url (dependency) ¶

Returns URL of the dependency.

If dependency should be served by the server, second value is :local. Otherwise it is :external. Also, in first case dependency’s URL should have only path part, like /local/css/bootstrap.css.

Package

Source

Methods

Method: get-url ((dependency cached-remote-dependency)) ¶

Method: get-url ((dependency remote-dependency)) ¶

Method: get-url ((dependency local-dependency)) ¶

Returns dependency’s url and it’s type.

URL type is returned as second value and can be :local or :remote. For local-dependency it is :local.

Generic Function: handle-ajax-request (app) ¶

This generic function is called when Reblocks processes an action called from Javascript.

Package

Source

Methods

Method: handle-ajax-request ((app app)) ¶

Generic Function: handle-request (app) ¶

This method handles each request as it comes in from the
server. It is a hunchentoot handler and has access to all hunchentoot dynamic variables. The default implementation executes a user
action (if any) and renders the root widget wrapped in HTML
provided by ’render-page’. If the request is an AJAX request, only the dirty widgets are rendered into a JSON data structure. It also invokes user supplied ’reblocks/session:init’ method on the first request that has no session setup.

’handle-request’ immediately returns ’+http-not-found+’ if it
sees a mime type on the script name (it doesn’t handle what could be files because these mess with callback functions and break some
widgets that depend on them).

Additionally, on the first request a session is created and a client
is forced to redirect. At this point if the cookie is sent, session information is removed from the URL, otherwise the URL is left in
tact. This is done so that session information appears on the URL for clients that don’t support cookies (this way AJAX requests followed by
a refresh will work).

This function also manages lists of callback functions and calls them
at different points before and after request. See ’request-hook’.

Override this method (along with :before and :after specifiers) to customize behavior.

Package

Source

Methods

Method: handle-request ((app app)) ¶

Method: handle-request :around (app) ¶: This wrapper sets a timeout on the request and reports response timings.

Method: handle-request :around ((app app)) ¶: This wrapper sets current application and suppresses error output from Hunchentoot.

Generic Function: humanize-name (name) ¶

Convert objects to a human-readable string suitable
for presentation. Default implementations beautify strings and symbols.

Ex:
(humanize-name ’hello-world) => "Hello World" (humanize-name "HELLO-WORLD") => "Hello World"

Package

reblocks/utils/string.

Source

Methods

Method: humanize-name ((name string)) ¶

Method: humanize-name ((name symbol)) ¶

Generic Function: infer-type-from (path-or-url) ¶

Returns a keyword meaning content type of the dependency by infering it from URL or a path

Package

Source

Methods

Method: infer-type-from ((url string)) ¶

Method: infer-type-from ((path pathname)) ¶

Generic Function: init (app) ¶

A method for this generic function should be defined to initialize application for a new user session.

It should return a widget which become a root widget.

Package

reblocks/session.

Source

Methods

Method: init (app) ¶

Source: file-type.lisp.

Generic Function: init-page (app url-path expire-at) ¶

A method for this generic function should be defined to initialize a new page object.

It should return a widget which become a root widget of the page or it might return the
page with initialized root widget in case if you want to use your own subclass of the PAGE class.

Package

Source

Methods

Method: init-page ((app preview) path expire-at) ¶

Source: file-type.lisp.

Method: init-page ((app welcome-screen-app) url-path expire-at) ¶

Source: file-type.lisp.

Method: init-page :around (app (path string) expire-at) ¶

If init function returned not object inherited from widget, it calls create-widget-from method, to transform value into the widget.

Source: file-type.lisp.

Method: init-page (app (path string) expire-at) ¶

Source: file-type.lisp.

Generic Function: init-session (app) ¶

A method for this generic function should be defined to initialize application for a new user session.

On the moment it get called session has-map already exists and you can use GET-VALUE function to set some values.

Package

reblocks/session.

Source

Methods

Method: init-session :before (app) ¶

Source: file-type.lisp.

Method: init-session (app) ¶

Generic Function: initialize-webapp (app) ¶

A protocol for performing any special initialization on the creation of a webapp object.

Package

Source

Methods

Method: initialize-webapp (app) ¶

Generic Function: make-js-backend (name) ¶

Creates a js backend instance of a given name.

Name should be a keyword like a :jquery or a :prototype.

Package

reblocks/js/base.

Source

Methods

Method: make-js-backend ((name (eql :jquery))) ¶

Source: file-type.lisp.

Generic Function: make-middlewares (server &key samesite-policy) ¶

Returns an alist where keys are keywords and values are Lack middlewares or apps.

Default primary method returns alist with two keys :SESSION and :APP, where
:SESSION is a middleware and :APP is the main application.

To modify middlewares list, define method for a server subclass
and use INSERT-MIDDLEWARE function on the results of CALL-NEXT-METHOD.

SAMESITE-POLICY argument if given, should be a keyword. It’s semantic
is described at [Mozilla docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite). It’s default value is taken from *DEFAULT-SAMESITE-POLICY* variable.

Here is an example, how this generic-function can be used to run
a HTTP API on URLs with path starting from /api/:

“‘
(defmethod reblocks/server:make-middlewares ((server ultralisp-server) &rest rest)
(declare (ignore rest))

(flet ((test-app (env)
(declare (ignore env))
’(200
(:content-type "text/plain")
("Hello, World"))))
(reblocks/server:insert-middleware
(call-next-method)
(cons
:some-api
(lambda (app)
(funcall (lack.util:find-middleware :mount)
app
"/api/"
#’test-app)))
:before :app)))
“‘

Package

Source

Methods

Method: make-middlewares ((server server) &key samesite-policy) ¶

Generic Function: max-pages-per-session (app) ¶

Returns NIL or a maximum number of pages to keep in the session.
Older pages will be expired and free memory.

Default method returns current value of *MAX-PAGES-PER-SESSION* variable.

Package

Source

Methods

Method: max-pages-per-session (app) ¶

Generic Function: object-class-name (obj) ¶

Returns an object’s class name (i.e. "Employee"). This method is be used to present the name of an entity to the user. Override this method to change the name for particular objects.

Package

reblocks/utils/clos.

Source

reblocks/error-handler.

Methods

Method: object-class-name (obj) ¶

Generic Function: on-error (app condition &key backtrace) ¶

This method is called when some unhandled error was raised by application.
It should call reblocks/response:immediate-response like this:

(reblocks/response:immediate-response
"Unhandled condition"
:code 500)

Package

Source

Methods

Method: on-error (app condition &key backtrace) ¶: Default implementation returns a plain text page and 500 status code.

Generic Function: on-missing-action (app action-name) ¶

Must be overridden by application to prevent default behaviour - redirect to a root of the application. The new method should determine the behavior in this situation (e.g. redirect, signal an error, etc.).

Package

reblocks/actions.

Source

Methods

Method: on-missing-action (app action-name) ¶

Generic Function: on-page-load (page) ¶

This generic function gets called when user loads a page in the browser.
It is called for all non Ajax requests.

When user reloads page multiple times, the page object can be reused.
Thus this function may be used to reset some page attributes.

Default method resets a list of loaded dependencies to ensure that all of them will be sent to the browser again.

Package

Source

Methods

Method: on-page-load ((page page)) ¶

Source: file-type.lisp.

Generic Function: on-page-redirect (from-page to-url) ¶

This generic function gets called when user get’s a redirect to another page.

Default method does nothing.

Package

Source

Methods

Method: on-page-redirect (from-page to-url) ¶

Generic Function: on-page-refresh (page) ¶

This generic function gets called when user refreshes page in the browser.

Default method does nothing.

Package

Source

Methods

Method: on-page-refresh (page) ¶

Generic Reader: page-app (object) ¶

Package

Methods

Reader Method: page-app ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: app.

Generic Writer: (setf page-app) (object) ¶

Package

Methods

Writer Method: (setf page-app) ((page page)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: app.

Generic Function: page-expire-in (app page-path) ¶

Returns NIL or a number of seconds after which page should be removed from the memory.

Default method returns current value of *PAGES-EXPIRE-IN* variable.

Package

Source

Methods

Method: page-expire-in (app page-path) ¶

Generic Reader: page-id (object) ¶

Package

Methods

Reader Method: page-id ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: id.

Generic Function: page-not-found-handler (app) ¶

This function is called when the current widget
heirarchy fails to parse a URL. The default behavior simply sets the 404 return code

Package

Source

Methods

Method: page-not-found-handler (app) ¶

Generic Reader: page-root-widget (object) ¶

Package

Methods

Reader Method: page-root-widget ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: root-widget.

Generic Writer: (setf page-root-widget) (object) ¶

Package

Methods

Writer Method: (setf page-root-widget) ((page page)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: root-widget.

Generic Function: render (widget) ¶

Define this method to render widget’s content.

Use REBLOCKS/HTML:WITH-HTML macro to render HTML.
You can use any other templating engine, just ensure
it writes output to REBLOCKS/HTML:*STREAM*

Outer DIV wrapper will be added automaticall, see GET-HTML-TAG generic-function. It will have CSS tags returned by GET-CSS-CLASSES generic-function.

Package

Source

Methods

Method: render :around (widget) ¶

This function is intended for internal usage only.
It renders widget with surrounding HTML tag and attributes.

Source: file-type.lisp.

Method: render (widget) ¶

By default, widget rendered with a text, suggesting to define a rendering method.

Source: file-type.lisp.

Method: render ((widget preview-widget)) ¶

Source: file-type.lisp.

Method: render ((widget welcome-screen-widget)) ¶

Source: file-type.lisp.

Method: render ((widget funcall-widget)) ¶

Source: file-type.lisp.

Method: render ((widget string-widget)) ¶

Source: file-type.lisp.

Generic Function: render (app inner-html &key dependencies) ¶

Renders HTML page for the current application.

By default, it renders:

* HTML <head> where calls
RENDER-HEADERS generic-function and RENDER-DEPENDENCIES generic-function.
* HTML <body> where RENDER-BODY generic-function is called with APP and INNER-HTML arguments.

Package

Source

Methods

Method: render ((app app) inner-html &key dependencies) ¶: Default page rendering template and protocol.

Generic Function: render-body (app body-html-string) ¶

By default, it just renders BODY-HTML-STRING as is, without escaping.

BODY-HTML-STRING argument contains a rendered widget tree, generated by REBLOCKS/WIDGET:RENDER generic-function call on the root widget.

Package

Source

Methods

Method: render-body ((app app) body-html-string) ¶: Default page-body rendering method

Generic Function: render-dependencies (app dependencies) ¶

Renders links to CSS and JS dependencies.

DEPENDENCIES argument contains a list of
objects inherited from REBLOCKS/DEPENDENCIES:DEPENDENCY class.

Package

Source

Methods

Method: render-dependencies ((app app) dependencies) ¶

Generic Function: render-headers (app) ¶

By default, adds <meta> entries with Content-Type, description and keywords to the app’s page.

Package

Source

Methods

Method: render-headers ((app app)) ¶

Generic Function: render-in-ajax-response (dependency) ¶

Returns a JS code to dynamically include a CSS or JS dependency
into a webpage on AJAX response.

This makes possible to load new styles and code for widgets which can appear on a page as a response to some action.

Package

Source

Methods

Method: render-in-ajax-response ((dependency dependency)) ¶

Source: file-type.lisp.

Method: render-in-ajax-response (dependency) ¶

Generic Function: render-in-head (dependency) ¶

Renders a piece of html.

Package

Source

Methods

Method: render-in-head ((dependency remote-dependency)) ¶

Method: render-in-head ((dependency dependency)) ¶

Method: render-in-head (dependency) ¶

Generic Function: serve (dependency) ¶

Returns two values - content and content-type.

Example output::

(values "body {background: light-green;}" "text/css")

Package

Source

Methods

Method: serve ((dependency cached-remote-dependency)) ¶: Serves remote dependency from local cache.

Method: serve ((dependency local-dependency)) ¶: Serves local dependency from the disk.

Generic Function: serve (route env) ¶

Methods should return a list like that:

“‘lisp
(list 200 ;; status-code (list :content-type content-type) ;; headers content) ;; content “‘

Package

Source

Methods

Method: serve :around (route env) ¶

This method handles unhandled exceptions, because this code is common for all routes.

Source: file-type.lisp.

Method: serve ((route static-route-from-file) env) ¶

Returns a file’s content

Source: file-type.lisp.

Method: serve ((route dependency-route) env) ¶

Source: file-type.lisp.

Method: serve ((route route) env) ¶

Generic Function: serve-static-file (uri object &key content-type) ¶

Adds a route to serve given object by static URI.

Package

Source

Methods

Method: serve-static-file (uri (path pathname) &key content-type) ¶

Generic Function: update (w &key inserted-after inserted-before removed) ¶

This method should be called to update widget on a client.

Usually this required as a result of an action execution.

In the original Weblocks there was a mark-dirty method. This one replaces it.
To make everything easier, the new protocol excludes "propagation". If you
need to update other widgets, please define an "update" method for your widget.
You can use :before or :after modifiers, to keep the current behavior and to add propagation code.

There are a few optional arguments to control the way how does widget should be updated. They can be useful to not update the whole parent widget.

- If one of INSERTED-AFTER or INSERTED-BEFORE is given, it should be a widget
object to be used as an anchor. This can be useful to not rerender all children
of some "list" widget when you adding a new element.
- When REMOVED argument is T the widget will be removed from the DOM tree.

Package

Source

Methods

Method: update ((w widget) &key inserted-after inserted-before removed) ¶

Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]

5.1.5 Standalone methods

Method: compute-effective-slot-definition ((class widget-class) slot-name dslotds) ¶

Package: sb-mop.
Source: file-type.lisp.

Method: direct-slot-definition-class ((class widget-class) &rest initargs) ¶

Package: sb-mop.
Source: file-type.lisp.

Method: effective-slot-definition-class ((class widget-class) &rest initargs) ¶

Package: sb-mop.
Source: file-type.lisp.

Method: initialize-instance :after ((class widget-class) &key &allow-other-keys) ¶

Source: file-type.lisp.

Method: initialize-instance :after ((self app) &rest initargs) ¶

Add some defaults to the slots.

Source: file-type.lisp.

Method: initialize-instance :after ((dependency remote-dependency) &rest initargs) ¶

Creating a route for the dependency if it is "local".

This way it will be possible to serve requests for this dependency from a browser.

Source: file-type.lisp.

Method: initialize-instance :after ((dependency local-dependency) &rest initargs) ¶

Creating a route for the dependency if it is "local".

This way it will be possible to serve requests for this dependency from a browser.

Source: file-type.lisp.

Method: print-object ((server server) stream) ¶

Source: file-type.lisp.

Method: print-object ((object remote-dependency) stream) ¶

Source: file-type.lisp.

Method: print-object ((object local-dependency) stream) ¶

Source: file-type.lisp.

Method: print-object ((obj page) stream) ¶

Source: file-type.lisp.

Method: shared-initialize :after ((self app-class) slots &key autostart &allow-other-keys) ¶

Source: file-type.lisp.

Method: validate-superclass ((self app-class) (super standard-class)) ¶

Package: sb-mop.
Source: file-type.lisp.

Method: validate-superclass ((class widget-class) (superclass standard-class)) ¶

Package: sb-mop.
Source: file-type.lisp.

Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.6 Conditions

Condition: immediate-response ¶

Package

reblocks/response.

Source

Direct superclasses

condition.

Direct subclasses

redirect.

Direct methods

get-response.

Direct slots

Slot: response ¶

Initargs: :response
Readers: get-response.
Writers: This slot is read-only.

Condition: redirect ¶

Package: reblocks/response.
Source: file-type.lisp.
Direct superclasses: immediate-response.

Previous: Conditions, Up: Public Interface [Contents][Index]

5.1.7 Classes

Class: app ¶

A class that encapsulates a unique web application and all relevant rnesources. A webapp is a unique set of dependencies and information that can be enabled or disabled independently of others. Multiple webapps can be active concurrently and incoming connections are dispatched to the root of the webapp according to a prefix parameter that defines the URLs parsed by that webapp. The webapp does not see the prefix parameter in URLs that are provided to it. You can, for instance, have different sites (e.g. mobile vs. desktop) with vastly different layout and dependencies running on the same server.

Package

Source

Direct subclasses

preview.
welcome-screen-app.

Direct methods

Direct slots

Slot: name ¶

Type: (or symbol string)
Initargs: :name
Readers: reblocks-webapp-name.
Writers: (setf reblocks-webapp-name).

Slot: description ¶

The name of the application. This slot will be used
by ’application-page-title’ to generate the default title for each page.

Type: (or null string)
Initargs: :description
Readers: reblocks-webapp-description.
Writers: (setf reblocks-webapp-description).

Slot: js-backend ¶

Specify a javascript backend for framework (default is :jquery)

Initform: :jquery
Initargs: :js-backend
Readers: get-js-backend.
Writers: (setf get-js-backend).

Slot: hostnames ¶

The hostnames (a list of strings) reserved for this webapp.
See section 14.32 of RFC 2616.

Example: ’("foo.com" "www.foo.com" "shoo.bar.org")
Wildcard patterns are also allowed. Example: ’("foo.*.com")
If NIL (the default), don’t care about the hostname at all.
TODO: support regex matching here.

Type: list
Initargs: :hostnames
Readers: reblocks-webapp-hostnames.
Writers: This slot is read-only.

Slot: prefix ¶

The subtree of the URI space at this site that belongs to the webapp.

Type: string
Initargs: :prefix
Readers: get-prefix.
Writers: This slot is read-only.

Slot: session-key ¶

Type: symbol
Initargs: :session-key
Readers: reblocks-webapp-session-key.
Writers: (setf reblocks-webapp-session-key).

Slot: debug ¶

Responsible for debug mode, use WEBAPP-DEBUG function for getting slot value

Package: common-lisp.
Initargs: :debug
Readers: reblocks-webapp-debug.
Writers: (setf reblocks-webapp-debug).

Class: dependency ¶

This class represents a web-dependency. It could be CSS, JS or an image.

All dependencies are divided into REMOTE-DEPENDENCY or LOCAL-DEPENDENCY.

Package

Source

Direct subclasses

local-dependency.
remote-dependency.

Direct methods

defer.
get-type.
render-in-ajax-response.
render-in-head.

Direct slots

Slot: type ¶

Package: common-lisp.
Type: (member :css :js :png :jpg :gif)
Initform: (error ":type argument is required.")
Initargs: :type
Readers: get-type.
Writers: This slot is read-only.

Slot: defer ¶

Type: boolean
Initargs: :defer
Readers: defer.
Writers: This slot is read-only.

Class: dom-object-mixin ¶

Represents attributes and functionality common to all DOM-renderable objects.

Package

Source

Direct subclasses

widget.

Direct methods

(setf dom-id).
dom-id.
ensure-dom-id.

Direct slots

Slot: dom-id ¶

The DOM id of an object. Can be a symbol, a
string or nil. When accessed through the ’dom-id’ accessor, will always become a string. Use ensure-dom-id or widget-name (for widgets) to access its underlying implementation.

Initargs: :dom-id

Class: js-backend ¶

Package: reblocks/js/base.
Source: file-type.lisp.
Direct subclasses: jquery-backend.

Class: local-dependency ¶

Local dependencies are served by the same webserver which renders reblocks widgets.

Each local dependency should provide a route, which will be added to the server routing table. Also, it might define a path to the file on the local file-system.

Package

Source

cached-remote-dependency.

Direct superclasses

dependency.

Direct subclasses

Direct methods

cache-in-memory-p.
get-path.
get-route.
get-url.
initialize-instance.
is-binary.
print-object.
serve.

Direct slots

Slot: route ¶

Initargs: :route
Readers: get-route.
Writers: This slot is read-only.

Slot: path ¶

Type: (or pathname null)
Initargs: :path
Readers: get-path.
Writers: This slot is read-only.

Slot: binary ¶

Type: (or null t)
Initargs: :binary
Readers: is-binary.
Writers: This slot is read-only.

Slot: cache-in-memory ¶

Type: (or null t)
Initargs: :cache-in-memory
Readers: cache-in-memory-p.
Writers: This slot is read-only.

Slot: cached-data ¶

Type: (or null simple-array)

Class: page ¶

Package

Source

Direct methods

(setf %metadata-lock).
%metadata-lock.
%page-metadata.
id-to-widget.
on-page-load.
page-actions.
(setf page-app).
page-app.
page-created-at.
(setf page-expire-at).
page-expire-at.
page-id.
page-path.
(setf page-root-widget).
page-root-widget.
print-object.

Direct slots

Slot: id ¶

Type: uuid:uuid
Initform: (uuid:make-v4-uuid)
Readers: page-id.
Writers: This slot is read-only.

Slot: path ¶

Type: string
Initargs: :path
Readers: page-path.
Writers: This slot is read-only.

Slot: created-at ¶

Type: local-time:timestamp
Initform: (local-time:now)
Readers: page-created-at.
Writers: This slot is read-only.

Slot: expire-at ¶

Type: (or null local-time:timestamp)
Initargs: :expire-at
Readers: page-expire-at.
Writers: (setf page-expire-at).

Slot: code-to-action ¶

Initform: (make-hash-table :test (quote equal))
Readers: page-actions.
Writers: This slot is read-only.

Slot: root-widget ¶

Initargs: :root-widget
Readers: page-root-widget.
Writers: (setf page-root-widget).

Slot: id-to-widget ¶

Initform: (serapeum:dict)
Readers: id-to-widget.
Writers: This slot is read-only.

Slot: app ¶

Package: reblocks/app.
Initform: reblocks/variables:*current-app*
Initargs: :app
Readers: page-app.
Writers: (setf page-app).

Slot: metadata-lock ¶

Initform: (bordeaux-threads:make-recursive-lock "page metadata")
Readers: %metadata-lock.
Writers: (setf %metadata-lock).

Slot: metadata ¶

Initform: (make-hash-table :test (quote equal))
Readers: %page-metadata.
Writers: This slot is read-only.

Class: preview ¶

Package

reblocks/preview.

Source

Direct superclasses

app.

Direct methods

init-page.

Direct Default Initargs

Initarg	Value
`:prefix`	`/`

Class: remote-dependency ¶

Remote dependencies refer some URLs. Usually these dependencies are served from a CDN.

Package

Source

cached-remote-dependency.

Direct superclasses

dependency.

Direct subclasses

Direct methods

get-crossorigin.
get-integrity.
get-path.
get-remote-url.
get-url.
initialize-instance.
print-object.
render-in-head.

Direct slots

Slot: remote-url ¶

Type: string
Initargs: :remote-url
Readers: get-remote-url.
Writers: This slot is read-only.

Slot: integrity ¶

A hash, used by modern browsers for subresource integrity checking.

See more information at: <https://www.w3.org/TR/SRI/>

Type: (or string null)
Initargs: :integrity
Readers: get-integrity.
Writers: This slot is read-only.

Slot: crossorigin ¶

Type: (or string null)
Initform: "anonymous"
Initargs: :crossorigin
Readers: get-crossorigin.
Writers: This slot is read-only.

Class: route ¶

Inherit from this class to add a custom routes.

Package

Source

static-route-from-file.

Direct superclasses

route.

Direct subclasses

Direct methods

get-content-type.
get-handler.
serve.

Direct slots

Slot: handler ¶

Initargs: :handler
Readers: get-handler.
Writers: This slot is read-only.

Slot: content-type ¶

Initform: "application/json"
Initargs: :content-type
Readers: get-content-type.
Writers: This slot is read-only.

Class: server ¶

Base class for all Reblocks servers. Redefine it if you want to add additional HTTP midlewares, etc.

Package

Source

Direct methods

(setf apps).
apps.
(setf get-handler).
get-handler.
get-interface.
get-port.
get-server-type.
handle-http-request.
handle-http-request.
make-middlewares.
print-object.
(setf routes).
routes.

Direct slots

Slot: port ¶

Type: integer
Initargs: :port
Readers: get-port.
Writers: This slot is read-only.

Slot: interface ¶

Type: string
Initargs: :interface
Readers: get-interface.
Writers: This slot is read-only.

Slot: server-type ¶

Initargs: :server-type
Readers: get-server-type.
Writers: This slot is read-only.

Slot: handler ¶

Readers: get-handler.
Writers: (setf get-handler).

Slot: routes ¶

Initform: (reblocks/routes::make-routes)
Readers: routes.
Writers: (setf routes).

Slot: apps ¶

Readers: apps.
Writers: (setf apps).

Class: string-widget ¶

Package

Source

Direct superclasses

widget.

Direct methods

(setf escape-p).
escape-p.
(setf get-content).
get-content.
render.

Direct slots

Slot: content ¶

Type: string
Initargs: :content
Readers: get-content.
Writers: (setf get-content).

Slot: escape-p ¶

Whether to escape the output for HTML.

Type: boolean
Initform: t
Initargs: :escape-p
Readers: escape-p.
Writers: (setf escape-p).

Class: widget ¶

Base class for all widget objects.

Package

Source

Direct superclasses

dom-object-mixin.

Direct subclasses

funcall-widget.
preview-widget.
string-widget.
welcome-screen-widget.

Direct methods

create-widget-from.
update.
(setf widget-continuation).
widget-continuation.
(setf widget-propagate-dirty).
widget-propagate-dirty.

Direct slots

Slot: propagate-dirty ¶

A list of widgets which will be made
dirty when this widget is made dirty via a POST request. This slot allows setting up dependencies between widgets that will make multiple widgets update automatically during AJAX requests.

Initargs: :propagate-dirty
Readers: widget-propagate-dirty.
Writers: (setf widget-propagate-dirty).

Slot: continuation ¶

Stores the continuation object for
widgets that were invoked via one of the do-* functions (’do-page’, etc.). When ’answer’ is called on a widget, this value is used to resume the computation.

Readers: widget-continuation.
Writers: (setf widget-continuation).

Class: widget-class ¶

A metaclass used for all widget classes. A custom metaclass is necessary to specialize ’slot-value-using-class’.

Package

Source

Direct superclasses

standard-class.

Direct methods

compute-effective-slot-definition.
direct-slot-definition-class.
effective-slot-definition-class.
initialize-instance.
validate-superclass.

Previous: Public Interface, Up: Definitions [Contents][Index]

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: !get-number-of-anonymous-sessions ¶

This variable will contain a function after the session middleware will be created.

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: !get-number-of-sessions ¶

This variable will contain a function after the session middleware will be created.

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: !map-sessions ¶

This variable will contain a function after the session middleware will be created.

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: *allowed-samesite-policies* ¶

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: *application-hooks* ¶

A request hook object used in the application scope.

Package: reblocks/hooks.
Source: file-type.lisp.

Special Variable: *apps-actions* ¶

This hash maps app classes to hashes which store application’s actions.

Package: reblocks/app-actions.
Source: file-type.lisp.

Special Variable: *asdf-system-cache* ¶

Package: reblocks/utils/misc.
Source: file-type.lisp.

Special Variable: *autostarting-apps* ¶

A list of webapps to start when start-reblocks is called

Package: reblocks/app-mop.
Source: file-type.lisp.

Special Variable: *clack-output* ¶

Here we’ll store all output from the Clack, because we don’t want it to mix with reblocks own output.

Package: reblocks/server.
Source: file-type.lisp.

Special Variable: *commands* ¶

A list of commands to execute on a client as a result of action call.

These commands are collected during action processing and rendered to resulting JSON as some sort of JSON-rpc calls to be esecuted on a client-side.

Package: reblocks/commands.
Source: file-type.lisp.

Special Variable: *config* ¶

Stores options of last call to (on) or nil if it newer called.

The value of this variable is returned by (status) call as a second value.

Package: reblocks/debug.
Source: file-type.lisp.

Special Variable: *current-page* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *default-language* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *description* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *env* ¶

Stores current lack environment to configure session’s behaviour.

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: *jquery-dependencies* ¶

Package: reblocks/js/jquery.
Source: file-type.lisp.

Special Variable: *js-default-action* ¶

Package: reblocks/actions.
Source: file-type.lisp.

Special Variable: *js-default-form-action* ¶

Package: reblocks/actions.
Source: file-type.lisp.

Special Variable: *js-dependencies-cache* ¶

Package: reblocks/js/jquery.
Source: file-type.lisp.

Special Variable: *keywords* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *language* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *on* ¶

When true, then Reblocks will be saving addional information useful for debugging.

Package: reblocks/debug.
Source: file-type.lisp.

Special Variable: *page-dependencies* ¶

A list which contains all page dependencies.

Reblocks fills this list during page rendering.

Package: reblocks/page-dependencies.
Source: file-type.lisp.

Special Variable: *pages-cleaner-thread* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *pages-cleaner-thread-lock* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *port* ¶

A port where preview server is listening.

Package: reblocks/preview.
Source: file-type.lisp.

Special Variable: *registered-apps* ¶

A list of applications that the system knows about

Package: reblocks/app-mop.
Source: file-type.lisp.

Special Variable: *request* ¶

Holds current request from a browser.

Package: reblocks/request.
Source: file-type.lisp.

Special Variable: *request-hooks* ¶

A request hooks object used in the request scope.

Package: reblocks/hooks.
Source: file-type.lisp.

Special Variable: *response* ¶

Current response object. It’s status code and headers can be changed when processing a request.

Package: reblocks/response.
Source: file-type.lisp.

Special Variable: *routes* ¶

This variable will be bound to the server’s routes during request processing.
Most functions in the REBLOCKS/ROUTES package will work only when this variable is bound.

Package: reblocks/routes.
Source: file-type.lisp.

Special Variable: *server* ¶

Will be bound to a server currently processing the request.

Package: reblocks/server.
Source: file-type.lisp.

Special Variable: *servers* ¶

Package: reblocks/server.
Source: file-type.lisp.

Special Variable: *session* ¶

Stores current requests’s session

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: *session-hooks* ¶

A session hooks object is stored in user’s session and should be bound to this variable by ‘prepare-hooks’ macro.

Package: reblocks/hooks.
Source: file-type.lisp.

Special Variable: *session-lock-table-lock* ¶

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: *session-locks* ¶

Per-session locks to avoid having unrelated threads waiting.

Package: reblocks/session.
Source: file-type.lisp.

Special Variable: *timing-level* ¶

Package: reblocks/utils/timing.
Source: file-type.lisp.

Special Variable: *title* ¶

Package: reblocks/page.
Source: file-type.lisp.

Special Variable: *widget* ¶

Package: reblocks/preview.
Source: file-type.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Macros

Macro: add-application-hook (hook-name callback-name (&rest args) &body body) ¶

Package: reblocks/hooks.
Source: file-type.lisp.

Macro: add-request-hook (hook-name callback-name (&rest args) &body body) ¶

Package: reblocks/hooks.
Source: file-type.lisp.

Macro: add-session-hook (hook-name callback-name (&rest args) &body body) ¶

Registers a new session hook like that:

(add-session-hook :request update-dialog () (do-some-useful job))

Package: reblocks/hooks.
Source: file-type.lisp.

Macro: def-get-set (variable) ¶

Generates a function get-<variable> and a corresponding setf part.

Package: reblocks/page.
Source: file-type.lisp.

Macro: prepare-hooks (&body body) ¶

Prepares internal special variables for request processing.

It takes hooks from user session and creates an empty hooks list bound to a current request.

Package: reblocks/hooks.
Source: file-type.lisp.

Macro: with-handled-errors (&body body) ¶

Package: reblocks/error-handler.
Source: file-type.lisp.

Macro: with-hook ((name &rest args) &rest body) ¶

Performs nested calls of all the hooks of name, the innermost call is a closure over the body expression. All hooks take at least one argument, which is a list of inner hooks. After doing their job, they apply the first element of the list to the rest, but this machanics is hidden by add-(application|session|request)-hook macroses:

(add-session-hook :action
log-action (action)
(log:info "Before calling" action)
(call-next-hook)
(log:info "After calling" action))

Next, somewhere in the code, where action is called:

(with-hook (:action action-object)
;; any custom code here
(process action-object))

Streamlined code execution will looks like:

(defun action-handler (action-object)
(log:info "Before calling" action-object)
(process action-object)
(log:info "After calling" action-object))

Package: reblocks/hooks.
Source: file-type.lisp.

Macro: with-page-defaults (&body body) ¶

Package: reblocks/page.
Source: file-type.lisp.

Macro: with-response (() &body body) ¶

Package: reblocks/response.
Source: file-type.lisp.

Macro: with-session-lock ((&optional session) &body body) ¶

Package: reblocks/session.
Source: file-type.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

5.2.3 Ordinary functions

Function: %check-boundaries (list index) ¶

Package: reblocks/utils/list.
Source: file-type.lisp.

Function: %common-init (app) ¶

Package: reblocks/default-init.
Source: file-type.lisp.

Function: %insert-after-without-boundaries-check (newelt list index) ¶

Destructively inserts ’newelt’ into ’list’ after ’index’.

Package: reblocks/utils/list.
Source: file-type.lisp.

Function: %js (source &rest args) ¶

Helper function for WITH-JAVASCRIPT macros.

Package: reblocks/js/base.
Source: file-type.lisp.

Function: add-hook (hooks hook-name callback-name callback) ¶

Adds a callback to the callbacks list with name ‘hook-name’.

Package: reblocks/hooks.
Source: file-type.lisp.

Function: add-hook-helper (hook-storage hook-name callback-name args body error-message-on-empty-storage) ¶

Package: reblocks/hooks.
Source: file-type.lisp.

Function: add-route (route &key routes) ¶

Inserts a new route into the routing table.

Package: reblocks/routes.
Source: file-type.lisp.

Function: add-routes (app &key routes) ¶

Inserts all routes bound to the app into the routing table.

Package: reblocks/routes.
Source: file-type.lisp.

Function: allowed-samesite-policy-p (value) ¶

Package: reblocks/session.
Source: file-type.lisp.

Function: app-serves-hostname-p (app hostname) ¶

Does APP serve requests for HOSTNAME?

Package: reblocks/app.
Source: file-type.lisp.

Function: call-in-webapp (app proc) ¶

Helper for ‘in-webapp’.

Package: reblocks/app.
Source: file-type.lisp.

Function: call-with-handled-errors (body-func) ¶

Package: reblocks/error-handler.
Source: file-type.lisp.

Function: call-with-page-defaults (body-func) ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: call-with-response (thunk) ¶

Package: reblocks/response.
Source: file-type.lisp.

Function: call-with-session (lack-env func) ¶

Package: reblocks/session.
Source: file-type.lisp.

Function: call-with-session-lock (session thunk) ¶

Package: reblocks/session.
Source: file-type.lisp.

Function: check-if-valid-class-name (name) ¶

Ensure that the we have a valid webapp class

Package: reblocks/app.
Source: file-type.lisp.

Function: cl-symbol-to-js-symbol (symbol) ¶

A little helper to transform symbols like :foo-baz-bar into keywords :|fooBazBar|.

Package: reblocks/commands.
Source: file-type.lisp.

Function: congruent-lambda-expression (lambda-list function) ¶

Answer a lambda expression with LAMBDA-LIST that passes all args (assuming the call is allowed by LAMBDA-LIST) to FUNCTION, answering its result.

Package: reblocks/utils/misc.
Source: file-type.lisp.

Function: create-command (name &rest args) ¶

Prepares command for rendering into JSON-rpc style dict.

Package: reblocks/commands.
Source: file-type.lisp.

Function: ensure-pages-cleaner-is-running () ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: ensure-starts-with-slash (s) ¶

Package: reblocks/utils/string.
Source: file-type.lisp.

Function: escape-script-tags (source &key delimiter) ¶

Escape script blocks inside scripts.

Package: reblocks/js/base.
Source: file-type.lisp.

Function: eval-hook-callbacks (hooks name args) ¶

Internal function to eval hooks from all three hook storages.

Package: reblocks/hooks.
Source: file-type.lisp.

Function: eval-next-hooks (next-hooks &rest args) ¶

Helper function that makes it easier to write dynamic hooks.

It whould be called somewhere inside a hook, to evaluate inner hooks. But you don’t need to call it manually, just use one of add-xxxx-hook and a (call-next-hook) inside of it.

Package: reblocks/hooks.
Source: file-type.lisp.

Function: expire-pages () ¶

Removes from memory expired pages. This function is called periodically
from a separate thread.

Returns a multiple values with counters:

- processed-sessions
- processed-pages
- expired-sessions-count
- sessions-without-restart-count (non-expired but should be expired, if reblocks works correctly you should see 0 here) - expired-pages-count

Package: reblocks/page.
Source: file-type.lisp.

Function: extend-expiration-time-impl (app page) ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: find-app-by-name (active-apps name &key signal-error) ¶

Get a running web application

Package: reblocks/app.
Source: file-type.lisp.

Function: find-page-by-path (session-pages path) ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: find-server (interface port) ¶

Package: reblocks/server.
Source: file-type.lisp.

Function: generate-action-code () ¶

Generates unique, hard to guess action codes.

Package: reblocks/actions.
Source: file-type.lisp.

Function: get-action-name-from-request () ¶

Returns called action name if any action was called

Package: reblocks/request.
Source: file-type.lisp.

Function: get-callback-name (callback) ¶

Package: reblocks/hooks.
Source: file-type.lisp.

Function: get-callback-value (callback) ¶

Package: reblocks/hooks.
Source: file-type.lisp.

Function: get-callbacks (hooks name) ¶

Internal function to get callbacks list from a hooks storage.

Package: reblocks/hooks.
Source: file-type.lisp.

Function: get-callbacks-names (hooks name) ¶

Internal function to get a list of callbacks names from a hooks storage.

Package: reblocks/hooks.
Source: file-type.lisp.

Function: get-css-classes-as-string (widget) ¶

Package: reblocks/widget.
Source: file-type.lisp.

Function: get-default-content-type-for-response () ¶

Package: reblocks/response.
Source: file-type.lisp.

Function: get-lock (&optional session) ¶

Package: reblocks/session.
Source: file-type.lisp.

Function: get-or-create-session-hooks () ¶

A request hook object used in the session scope.

Package: reblocks/hooks.
Source: file-type.lisp.

Function: get-rendered-chunk () ¶

Returns a string containing HTML redered since last call to with-html, with-html-string or get-rendered-chunk.

Call to this function clears internal stream, used for rendering!

Package: reblocks/html.
Source: file-type.lisp.

Function: get-request-action (app action-name) ¶

Gets an action from the request. If the request contains
a parameter with name equal to *ACTION-STRING* variable, the action
is looked up in the session and appropriate function is returned.
If no action is in the parameter, returns NIL. If the action
isn’t in the session (somehow invalid), raises an assertion.

Returns two values: an action and the optional page where it was instantiated.

Package: reblocks/actions.
Source: file-type.lisp.

Function: get-session-action (action-name) ¶

Returns an action bound to the current session.

Package: reblocks/actions.
Source: file-type.lisp.

Function: handle-action-if-needed (app) ¶

Package: reblocks/request-handler.
Source: file-type.lisp.

Function: hostname-match-p (pattern hostname) ¶

Package: reblocks/app.
Source: file-type.lisp.

Function: initialize-session-pages () ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: internal-make-action (action-fn &optional action-code) ¶

Converts a function into an action that can be rendered into HTML. A unique, hard to guess string is generated for the function, and a function is added to the session hashtable under this string. The
string is then returned. When later requests come in, ’get-request-action’ machinery determines if the action string that
came with the request is stored in the hashtable, and if so, invokes
the stored function.

ACTION-FN - A function that will be called if the user initiates appropriate control (link, form, etc.) GET and POST parameters will be passed to this function as keyword arguments by the framework.

ACTION-CODE - The code to use for an action (if not specified INTERNAL-MAKE-ACTION generates a unique value for each action). Note, if you don’t provide a hard to guess code (’generate-action-code’ is used by default), the user will be vulnerable to an attack where a malicious attacker can attempt to guess a dangerour action id and send the user
a link to it. Only use guessable action codes for GET actions.

Package: reblocks/actions.
Source: file-type.lisp.

Function: log-hooks (name) ¶

A helper function to log all known hooks with given name.

Package: reblocks/hooks.
Source: file-type.lisp.

Function: make-response-for-clack (response) ¶

Package: reblocks/server.
Source: file-type.lisp.

Function: make-route (uri dependency) ¶

Makes a route for dependency.

Automatically adds a prefix depending on current webapp and widget.

Package: reblocks/dependencies.
Source: file-type.lisp.

Function: make-routes () ¶

Package: reblocks/routes.
Source: file-type.lisp.

Function: make-server (&key port interface server-type server-class) ¶

Makes a webserver instance.
Make instance, then start it with “start“ method.

Package: reblocks/server.
Source: file-type.lisp.

Function: map-sessions (thunk &rest keys) ¶

Package: reblocks/session.
Source: file-type.lisp.

Function: maybe-add-trailing-slash (s) ¶

Supply a trailing slash if needed.

Package: reblocks/utils/string.
Source: file-type.lisp.

Function: merge-files (file-list saved-path &key element-type linkage-element-fn) ¶

Package: reblocks/utils/misc.
Source: file-type.lisp.

Function: normalize (action-name) ¶

Package: reblocks/app-actions.
Source: file-type.lisp.

Function: page-expired-p (page) ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: pages-cleaner-loop () ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: parse-location-hash () ¶

Package: reblocks/request.
Source: file-type.lisp.

Function: register-app-routes (server app) ¶

Make sure the app with the "" prefix is always the last one and that there is only one!

Package: reblocks/server.
Source: file-type.lisp.

Function: register-dependencies (dependencies) ¶

Adds dependencies to the router to make HTTP server handle them.

Package: reblocks/dependencies.
Source: file-type.lisp.

Function: register-widget (widget) ¶

Package: reblocks/page.
Source: file-type.lisp.

Function: remove-action-from-uri (uri) ¶

Removes the action info from a URI.

Package: reblocks/actions.
Source: file-type.lisp.

Function: remove-url-query-string (str) ¶

Package: reblocks/utils/uri.
Source: file-type.lisp.

Function: report-timing (name real cpu) ¶

Package: reblocks/utils/timing.
Source: file-type.lisp.

Function: reset-session (session) ¶

Internal function for session reset.

Package: reblocks/session-reset.
Source: file-type.lisp.

Function: reset-session-hooks () ¶

Package: reblocks/hooks.
Source: file-type.lisp.

Function: search-app-for-request-handling (path-info hostname) ¶

Package: reblocks/server.
Source: file-type.lisp.

Function: sort-webapps (webapps) ¶

Package: reblocks/app.
Source: file-type.lisp.

Function: start-app (server app-class &rest app-args) ¶

Package: reblocks/server.
Source: file-type.lisp.

Function: start-server (server &key debug samesite-policy) ¶

Starts a Clack webserver, returns this server as result.

If server is already started, then logs a warning and does nothing.

Package: reblocks/server.
Source: file-type.lisp.

Function: stop-server (server) ¶

Stops a Clack server, but does not deactivates active applications, use ‘stop’ function for that.

Package: reblocks/server.
Source: file-type.lisp.

Function: strip-trailing-slashes (str) ¶

Relentlessly strip all trailing slashes from STR.
A string solely consisting of slashes is no special case.

Returns the number of stripped slashes as second value.

Package: reblocks/utils/string.
Source: file-type.lisp.

Function: unattributized-name (name &optional type-marker) ¶

Call ‘attributize-name’ with NAME and modify the result to be a variant that is still usable in all cases where ‘attributize-name’ results can be used, but is extremely unlikely to ever be returned by ‘attributize-name’.

TYPE-MARKER is just a label for human discernment of the different users of this function.

Package: reblocks/utils/string.
Source: file-type.lisp.

Function: webapp-debug (&optional app) ¶

Whether APP is in debug mode.

Package: reblocks/app.
Source: file-type.lisp.

Function: webapp-description (&optional app) ¶

Returns the description of the web application. Please note, this description will be used for the composition of the page title displayed to the user. See ’application-page-title’ for details.

Package: reblocks/app.
Source: file-type.lisp.

Function: webapp-hostnames (&optional app) ¶

Returns the hostnames this application will serve requests for.

Package: reblocks/app.
Source: file-type.lisp.

Function: webapp-name (&optional app) ¶

Returns the name of the web application (also see ’defwebapp’). Please note, this name will be used for the composition of the page title displayed to the user. See ’application-page-title’ for details.

Package: reblocks/app.
Source: file-type.lisp.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.4 Generic functions

Generic Reader: %metadata-lock (object) ¶

Package

Methods

Reader Method: %metadata-lock ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: metadata-lock.

Generic Writer: (setf %metadata-lock) (object) ¶

Package

Methods

Writer Method: (setf %metadata-lock) ((page page)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: metadata-lock.

Generic Reader: %page-metadata (object) ¶

Package

Methods

Reader Method: %page-metadata ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: metadata.

Generic Reader: apps (object) ¶

Package

Methods

Reader Method: apps ((server server)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: apps.

Generic Writer: (setf apps) (object) ¶

Package

Methods

Writer Method: (setf apps) ((server server)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: apps.

Generic Reader: defer (object) ¶

Package

Methods

Reader Method: defer ((dependency dependency)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: defer.

Generic Function: ensure-dom-id (obj) ¶

Ensure that the object has a ’dom-id’ and return
it. ’dom-id’ is lazily generated on first read, because its creation requires a session to be present. Returns a string, symbol, or nil.

Package

Source

Methods

Method: ensure-dom-id ((obj dom-object-mixin)) ¶

Generic Function: finalize-webapp (app) ¶

Called when the app has been pulled off the running list to perform any webapp specific cleanup

Package

Source

Methods

Method: finalize-webapp (app) ¶

Generic Reader: get-content-type (object) ¶

Package

Methods

Reader Method: get-content-type ((static-route-from-file static-route-from-file)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: content-type.

Generic Reader: get-content-type (object) ¶

Package

Methods

Reader Method: get-content-type ((route route)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: content-type.

Generic Reader: get-dependency (object) ¶

Package

reblocks/widgets/funcall-widget.

Methods

Reader Method: get-dependency ((dependency-route dependency-route)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: dependency.

Generic Reader: get-function (object) ¶

Package

Methods

Reader Method: get-function ((funcall-widget funcall-widget)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: function.

Generic Writer: (setf get-function) (object) ¶

Package

reblocks/widgets/funcall-widget.

Methods

Writer Method: (setf get-function) ((funcall-widget funcall-widget)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: function.

Generic Reader: get-handler (object) ¶

Package

Methods

Reader Method: get-handler ((server server)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: handler.

Generic Writer: (setf get-handler) (object) ¶

Package

Methods

Writer Method: (setf get-handler) ((server server)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: handler.

Generic Reader: get-handler (object) ¶

Package

Methods

Reader Method: get-handler ((route route)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: handler.

Generic Reader: get-interface (object) ¶

Package

Methods

Reader Method: get-interface ((server server)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: interface.

Generic Reader: get-js-backend (object) ¶

Generic Writer: (setf get-js-backend) (object) ¶

Package

Methods

Reader Method: get-js-backend ((app app)) ¶

Writer Method: (setf get-js-backend) ((app app)) ¶

Specify a javascript backend for framework (default is :jquery)

Source: file-type.lisp.
Target Slot: js-backend.

Generic Reader: get-path (object) ¶

Package

Methods

Reader Method: get-path ((static-route-from-file static-route-from-file)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: path.

Generic Reader: get-port (object) ¶

Package

Methods

Reader Method: get-port ((server server)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: port.

Generic Reader: get-remote-url (object) ¶

Package

Methods

Reader Method: get-remote-url ((remote-dependency remote-dependency)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: remote-url.

Generic Reader: get-server-type (object) ¶

Package

Methods

Reader Method: get-server-type ((server server)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: server-type.

Generic Function: handle-http-request (server env) ¶

Handles HTTP request, passed by Clack

Package

Source

Methods

Method: handle-http-request ((server server) env) ¶: Reblocks HTTP dispatcher.
This function serves all started applications and their static files.

Method: handle-http-request :around ((server server) env) ¶

Generic Function: handle-normal-request (app) ¶

Package

Methods

Method: handle-normal-request ((app app)) ¶

Source: file-type.lisp.

Generic Reader: id-to-widget (object) ¶

Package

Methods

Reader Method: id-to-widget ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: id-to-widget.

Generic Reader: is-binary (object) ¶

Package

Methods

Reader Method: is-binary ((local-dependency local-dependency)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: binary.

Generic Function: on-timing-end (level name) ¶

Package

reblocks/utils/timing.

Methods

Method: on-timing-end (level name) ¶

Source: file-type.lisp.

Generic Function: on-timing-start (level name) ¶

Package

reblocks/utils/timing.

Methods

Method: on-timing-start (level name) ¶

Source: file-type.lisp.

Generic Reader: page-actions (object) ¶

Package

Methods

Reader Method: page-actions ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: code-to-action.

Generic Reader: page-created-at (object) ¶

Package

Methods

Reader Method: page-created-at ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: created-at.

Generic Reader: page-expire-at (object) ¶

Package

Methods

Reader Method: page-expire-at ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: expire-at.

Generic Writer: (setf page-expire-at) (object) ¶

Package

Methods

Writer Method: (setf page-expire-at) ((page page)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: expire-at.

Generic Reader: page-path (object) ¶

Package

Methods

Reader Method: page-path ((page page)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: path.

Generic Reader: reblocks-webapp-debug (object) ¶

Generic Writer: (setf reblocks-webapp-debug) (object) ¶

Package

Methods

Reader Method: reblocks-webapp-debug ((app app)) ¶

Writer Method: (setf reblocks-webapp-debug) ((app app)) ¶

Responsible for debug mode, use WEBAPP-DEBUG function for getting slot value

Source: file-type.lisp.
Target Slot: debug.

Generic Reader: reblocks-webapp-description (object) ¶

Generic Writer: (setf reblocks-webapp-description) (object) ¶

Package

Methods

Reader Method: reblocks-webapp-description ((app app)) ¶

Writer Method: (setf reblocks-webapp-description) ((app app)) ¶

The name of the application. This slot will be used
by ’application-page-title’ to generate the default title for each page.

Source: file-type.lisp.
Target Slot: description.

Generic Reader: reblocks-webapp-hostnames (object) ¶

Package

Methods

Reader Method: reblocks-webapp-hostnames ((app app)) ¶

Source: file-type.lisp.
Target Slot: hostnames.

Generic Reader: reblocks-webapp-name (object) ¶

Package

Methods

Reader Method: reblocks-webapp-name ((app app)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: name.

Generic Writer: (setf reblocks-webapp-name) (object) ¶

Package

Methods

Writer Method: (setf reblocks-webapp-name) ((app app)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: name.

Generic Reader: reblocks-webapp-session-key (object) ¶

Package

Methods

Reader Method: reblocks-webapp-session-key ((app app)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: session-key.

Generic Writer: (setf reblocks-webapp-session-key) (object) ¶

Package

Methods

Writer Method: (setf reblocks-webapp-session-key) ((app app)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: session-key.

Generic Function: render-page-with-widgets (app) ¶

Renders a full HTML by collecting header elements, dependencies and inner HTML and inserting them into the ‘render’ method.

This function will be called inside WITH-PAGE-DEFAULTS block,
where such variables as *TITLE* are bound to their default values. These variables can be changed by user during widgets or page rendering.

Package

Source

Methods

Method: render-page-with-widgets ((app app)) ¶

Source: file-type.lisp.

Generic Reader: routes (object) ¶

Package

Methods

Reader Method: routes ((server server)) ¶

automatically generated reader method

Source: file-type.lisp.
Target Slot: routes.

Generic Writer: (setf routes) (object) ¶

Package

Methods

Writer Method: (setf routes) ((server server)) ¶

automatically generated writer method

Source: file-type.lisp.
Target Slot: routes.

Generic Reader: webapp-class-home-package (object) ¶

Generic Writer: (setf webapp-class-home-package) (object) ¶

Package

reblocks/app-mop.

Methods

Reader Method: webapp-class-home-package ((app-class app-class)) ¶

Writer Method: (setf webapp-class-home-package) ((app-class app-class)) ¶

The current package when I was defined.

Source: file-type.lisp.
Target Slot: home-package.

Generic Reader: widget-continuation (object) ¶

Generic Writer: (setf widget-continuation) (object) ¶

Package

Methods

Reader Method: widget-continuation ((widget widget)) ¶

Writer Method: (setf widget-continuation) ((widget widget)) ¶

Source: file-type.lisp.
Target Slot: continuation.

Generic Reader: widget-propagate-dirty (object) ¶

Generic Writer: (setf widget-propagate-dirty) (object) ¶

Package

Methods

Reader Method: widget-propagate-dirty ((widget widget)) ¶

Writer Method: (setf widget-propagate-dirty) ((widget widget)) ¶

Source: file-type.lisp.
Target Slot: propagate-dirty.

Generic Reader: widget-slot-affects-dirty-status-p (object) ¶

Generic Writer: (setf widget-slot-affects-dirty-status-p) (object) ¶

Package

Methods

Reader Method: widget-slot-affects-dirty-status-p ((widget-slot-definition-mixin widget-slot-definition-mixin)) ¶

Writer Method: (setf widget-slot-affects-dirty-status-p) ((widget-slot-definition-mixin widget-slot-definition-mixin)) ¶

When set to true (the
default is NIL), the widget will be made dirty when this slot is modified.

Source: file-type.lisp.
Target Slot: affects-dirty-status-p.

Generic Reader: widget-slot-parameter-name (object) ¶

Generic Writer: (setf widget-slot-parameter-name) (object) ¶

Package

Methods

Reader Method: widget-slot-parameter-name ((widget-slot-definition-mixin widget-slot-definition-mixin)) ¶

Writer Method: (setf widget-slot-parameter-name) ((widget-slot-definition-mixin widget-slot-definition-mixin)) ¶

When supplied, provides a string or
symbol which will be used to extract values from a URI GET parameter

Source: file-type.lisp.
Target Slot: parameter-name.

Next: Types, Previous: Generic functions, Up: Internals [Contents][Index]

5.2.5 Classes

Class: app-class ¶

The class of all webapp classes.

Package

reblocks/app-mop.

Source

Direct superclasses

standard-class.

Direct methods

shared-initialize.
validate-superclass.
(setf webapp-class-home-package).
webapp-class-home-package.

Direct slots

Slot: home-package ¶

The current package when I was defined.

Initform: *package*
Readers: webapp-class-home-package.
Writers: (setf webapp-class-home-package).

Class: cached-remote-dependency ¶

This is subclass of remote dependency which is
downloaded and stored in the local cache and served by lisp image.

You don’t’ need to create it manually, just set *cache-remote-dependencies-in* variable to a path where to store data before all (make-dependency...) will be made, and they will create cached-remote-dependency instead of remote-dependency objects automatically.

Package

Source

Direct superclasses

local-dependency.
remote-dependency.

Direct methods

get-url.
serve.

Class: dependency-route ¶

Package

Source

reblocks/widgets/funcall-widget.

Direct superclasses

route.

Direct methods

get-dependency.
serve.

Direct slots

Slot: dependency ¶

Initargs: :dependency
Readers: get-dependency.
Writers: This slot is read-only.

Class: funcall-widget ¶

Package

Source

Direct superclasses

widget.

Direct methods

(setf get-function).
get-function.
render.

Direct slots

Slot: function ¶

Package: common-lisp.
Type: (or symbol function)
Initargs: :function
Readers: get-function.
Writers: (setf get-function).

Class: hooks ¶

A data structure that maintains appropriate
callback functions used to hook into request evaluation.

Package

reblocks/hooks.

Source

Direct slots

Slot: hooks ¶

Initform: (make-hash-table)

Class: jquery-backend ¶

Package: reblocks/js/jquery.
Source: file-type.lisp.
Direct superclasses: js-backend.
Direct methods: get-dependencies.

Class: preview-widget ¶

Package: reblocks/preview.
Source: file-type.lisp.
Direct superclasses: widget.
Direct methods: render.

Class: static-route-from-file ¶

Package

Source

Direct superclasses

route.

Direct methods

get-content-type.
get-path.
serve.

Direct slots

Slot: path ¶

Initargs: :path
Readers: get-path.
Writers: This slot is read-only.

Slot: content-type ¶

Initargs: :content-type
Readers: get-content-type.
Writers: This slot is read-only.

Class: welcome-screen-app ¶

Idea of this app is to have some default application will be served on "/" prefix when there is no other app for "/" prefix is defined.

Package

reblocks/welcome/app.

Source

Direct superclasses

app.

Direct methods

init-page.

Direct Default Initargs

Initarg	Value
`:prefix`	`/`

Class: welcome-screen-widget ¶

Package: reblocks/welcome/widget.
Source: file-type.lisp.
Direct superclasses: widget.
Direct methods: render.

Class: widget-direct-slot-definition ¶

Allows specifying custom widget properties.

Package

Source

Direct superclasses

standard-direct-slot-definition.
widget-slot-definition-mixin.

Class: widget-effective-slot-definition ¶

Allows specifying custom widget properties.

Package

Source

Direct superclasses

standard-effective-slot-definition.
widget-slot-definition-mixin.

Class: widget-slot-definition-mixin ¶

A mixin class used in
’widget-direct-slot-definition’ and ’widget-effective-slot-definition’ to allow specifying custom widget properties.

Package

Source